bundle

type Bundle struct {
	Meta Meta
	// HeapDumpPath is the heap dump extracted to a temp file (removed
	// by Close).
	HeapDumpPath string
	// Segments serves the saved read-only segments as an
	// addrspace.Reader; nil when the bundle carries no rodata snapshot.
	Segments *SegmentsReader
	// Warnings to append to analysis diagnostics: the bundle's own
	// warnings plus the standard literal-label phrasing when the rodata
	// snapshot is absent or partial.
	Warnings []string
}

type CaptureOptions struct {
	// GCBeforeHeapDump triggers runtime.GC() before the dump so the
	// bundle reflects live memory rather than floating garbage.
	GCBeforeHeapDump bool
	// DisableRodata skips the read-only segment snapshot; literal pprof
	// label strings then surface as string_missing during analysis.
	DisableRodata bool
	// MaxRodataBytes caps total embedded segment bytes; 0 means
	// DefaultMaxRodataBytes. Segments that do not fit are dropped and
	// the rodata status becomes "truncated".
	MaxRodataBytes int64
	// Producer is recorded in meta.json (e.g. "bubblepprof/v0.2.0").
	Producer string
}

type HandlerOptions struct {
	Capture CaptureOptions

	// Semaphore is the single-flight gate (capacity-1 channel). When nil
	// the handler creates a private one. Supplying the same channel used
	// by the /debug/memusage handler serializes the two endpoints, since
	// each triggers a stop-the-world WriteHeapDump.
	Semaphore chan struct{}
}

type HexUint64 uint64

type Meta struct {
	FormatVersion int    `json:"format_version"`
	CreatedAt     string `json:"created_at"` // RFC 3339, UTC
	Producer      string `json:"producer"`

	GoVersion string `json:"go_version"`
	GOARCH    string `json:"goarch"`
	PtrSize   int    `json:"ptr_size"`
	BigEndian bool   `json:"big_endian"`

	Rodata   RodataMeta `json:"rodata"`
	Warnings []string   `json:"warnings"`
}

type RodataMeta struct {
	// Status is one of the Rodata* constants.
	Status string `json:"status"`
	// Reason is human-readable context when Status is not "ok".
	Reason string `json:"reason,omitempty"`
	// Segments is the number of rodata/NNNNN.bin members.
	Segments int `json:"segments"`
	// TotalBytes is the sum of segment sizes.
	TotalBytes uint64 `json:"total_bytes"`
}

type Segment struct {
	Addr  uint64
	Size  uint64
	Perms string
	Path  string
	R     io.Reader
}

type SegmentInfo struct {
	// Member is the tar member holding the segment bytes.
	Member string `json:"member"`
	// Addr is the runtime virtual address of the first byte.
	Addr HexUint64 `json:"addr"`
	// Size is the segment length in bytes (always < 2^53, safe as a
	// plain JSON number).
	Size uint64 `json:"size"`
	// Perms is the mapping permission string, e.g. "r--" or "r-x".
	Perms string `json:"perms"`
	// Path is the backing file of the mapping, when known.
	Path string `json:"path,omitempty"`
}

type SegmentsReader struct {
	// contains filtered or unexported fields
}

type WriteInput struct {
	Meta         Meta
	Segments     []Segment
	HeapDump     io.Reader
	HeapDumpSize int64
}