package tracev1

Import Path
	internal/trace/internal/tracev1 (on go.dev)

Dependency Relation
	imports 10 packages, and imported by one package

Involved Source Files

	    order.go
	  d parser.go
		Package tracev1 implements a parser for Go execution traces from versions
		1.11–1.21.
		
		The package started as a copy of Go 1.19's internal/trace, but has been
		optimized to be faster while using less memory and fewer allocations. It has
		been further modified for the specific purpose of converting traces to the
		new 1.22+ format.
Package-Level Type Names (total 7)

	/* sort by: alphabet | popularity */
	 type Event (struct)
		Event describes one event in the trace.

		Fields (total 6)
			Args [4]uint64
				// event-type-specific arguments

			G uint64
				// G on which the event happened

			P int32
				// P on which the event happened (can be a real P or one of TimerP, NetpollP, SyscallP)

			StkID uint32
				// unique stack ID

			Ts Timestamp
				// timestamp in nanoseconds

			Type EventType
				// one of Ev*

		Methods (only one)
			(*Event) String() string
		Implements (at least 2)
			*Event : expvar.Var
			*Event : fmt.Stringer
		As Outputs Of (at least 3)
			func (*Events).Peek() (*Event, bool)
			func (*Events).Pop() (*Event, bool)
			func (*Events).Ptr(i int) *Event

	 type Events (struct)

		Methods (total 7)
			(*Events) All() func(yield func(ev *Event) bool)
			(*Events) Len() int
			(*Events) Less(i, j int) bool
			(*Events) Peek() (*Event, bool)
			(*Events) Pop() (*Event, bool)
			(*Events) Ptr(i int) *Event
			(*Events) Swap(i, j int)
		Implements (at least one exported)
			*Events : sort.Interface

	 type EventType uint8 (basic type)

		As Types Of (total 51)
			const EvBatch
			const EvCount
			const EvCPUSample
			const EvFrequency
			const EvFutileWakeup
			const EvGCDone
			const EvGCMarkAssistDone
			const EvGCMarkAssistStart
			const EvGCStart
			const EvGCSweepDone
			const EvGCSweepStart
			const EvGoBlock
			const EvGoBlockCond
			const EvGoBlockGC
			const EvGoBlockNet
			const EvGoBlockRecv
			const EvGoBlockSelect
			const EvGoBlockSend
			const EvGoBlockSync
			const EvGoCreate
			const EvGoEnd
			const EvGoInSyscall
			const EvGomaxprocs
			const EvGoPreempt
			const EvGoSched
			const EvGoSleep
			const EvGoStart
			const EvGoStartLabel
			const EvGoStartLocal
			const EvGoStop
			const EvGoSysBlock
			const EvGoSysCall
			const EvGoSysExit
			const EvGoSysExitLocal
			const EvGoUnblock
			const EvGoUnblockLocal
			const EvGoWaiting
			const EvHeapAlloc
			const EvHeapGoal
			const EvNone
			const EvProcStart
			const EvProcStop
			const EvStack
			const EvString
			const EvSTWDone
			const EvSTWStart
			const EvTimerGoroutine
			const EvUserLog
			const EvUserRegion
			const EvUserTaskCreate
			const EvUserTaskEnd

	 type Frame (struct)
		Frame is a frame in stack traces.

		Fields (total 4)
			File uint64
				string ID of the file name

			Fn uint64
				string ID of the function name

			Line int
			PC uint64

	 type STWReason int (basic type)

		As Outputs Of (at least one exported)
			func (*Trace).STWReason(kindID uint64) STWReason
		As Types Of (total 17)
			const STWAllGoroutinesStackTrace
			const STWAllThreadsSyscall
			const STWCountPagesInUse
			const STWGCMarkTermination
			const STWGCSweepTermination
			const STWGOMAXPROCS
			const STWGoroutineProfile
			const STWGoroutineProfileCleanup
			const STWPageCachePagesLeaked
			const STWReadMemStats
			const STWReadMemStatsSlow
			const STWReadMetricsSlow
			const STWResetDebugLog
			const STWStartTrace
			const STWStopTrace
			const STWUnknown
			const STWWriteHeapDump

	 type Timestamp int64 (basic type)
		Timestamp represents a count of nanoseconds since the beginning of the trace.
		They can only be meaningfully compared with other timestamps from the same
		trace.

	 type Trace (struct)
		Trace is the result of Parse.

		Fields (total 6)
			Events Events
				Events is the sorted list of Events in the trace.

			InlineStrings []string
			PCs map[uint64]Frame
			Stacks map[uint32][]uint64
				Stacks is the stack traces (stored as slices of PCs), keyed by stack IDs
				from the trace.

			Strings map[uint64]string
			Version version.Version
		Methods (only one)
			(*Trace) STWReason(kindID uint64) STWReason
		As Outputs Of (at least one exported)
			func Parse(r io.Reader, vers version.Version) (Trace, error)


Package-Level Functions (only one)

	 func Parse(r io.Reader, vers version.Version) (Trace, error)
		Parse parses Go execution traces from versions 1.11–1.21. The provided reader
		will be read to completion and the entire trace will be materialized in
		memory. That is, this function does not allow incremental parsing.
		
		The reader has to be positioned just after the trace header and vers needs to
		be the version of the trace. This can be achieved by using
		version.ReadHeader.


Package-Level Variables (total 2)

	  var ErrTimeOrder error
		ErrTimeOrder is returned by Parse when the trace contains
		time stamps that do not respect actual event ordering.

	  var EventDescriptions [256]struct{Name string; minVersion version.Version; Stack bool; Args []string; SArgs []string}
Package-Level Constants (total 75)

	const EvBatch EventType = 1 // start of per-P batch of events [pid, timestamp]
		Event types in the trace.
		Verbatim copy from src/runtime/trace.go with the "trace" prefix removed.

	const EvCount EventType = 50
		Event types in the trace.
		Verbatim copy from src/runtime/trace.go with the "trace" prefix removed.

	const EvCPUSample EventType = 49 // CPU profiling sample [timestamp, stack, real timestamp, real P id (-1 when absent), goroutine id]
		Event types in the trace.
		Verbatim copy from src/runtime/trace.go with the "trace" prefix removed.

	const EvFrequency EventType = 2 // contains tracer timer frequency [frequency (ticks per second)]
		Event types in the trace.
		Verbatim copy from src/runtime/trace.go with the "trace" prefix removed.

	const EvFutileWakeup EventType = 36 // denotes that the previous wakeup of this goroutine was futile [timestamp]
		Event types in the trace.
		Verbatim copy from src/runtime/trace.go with the "trace" prefix removed.

	const EvGCDone EventType = 8 // GC done [timestamp]
		Event types in the trace.
		Verbatim copy from src/runtime/trace.go with the "trace" prefix removed.

	const EvGCMarkAssistDone EventType = 44 // GC mark assist done [timestamp]
		Event types in the trace.
		Verbatim copy from src/runtime/trace.go with the "trace" prefix removed.

	const EvGCMarkAssistStart EventType = 43 // GC mark assist start [timestamp, stack]
		Event types in the trace.
		Verbatim copy from src/runtime/trace.go with the "trace" prefix removed.

	const EvGCStart EventType = 7 // GC start [timestamp, seq, stack id]
		Event types in the trace.
		Verbatim copy from src/runtime/trace.go with the "trace" prefix removed.

	const EvGCSweepDone EventType = 12 // GC sweep done [timestamp, swept, reclaimed]
		Event types in the trace.
		Verbatim copy from src/runtime/trace.go with the "trace" prefix removed.

	const EvGCSweepStart EventType = 11 // GC sweep start [timestamp, stack id]
		Event types in the trace.
		Verbatim copy from src/runtime/trace.go with the "trace" prefix removed.

	const EvGoBlock EventType = 20 // goroutine blocks [timestamp, stack]
		Event types in the trace.
		Verbatim copy from src/runtime/trace.go with the "trace" prefix removed.

	const EvGoBlockCond EventType = 26 // goroutine blocks on Cond [timestamp, stack]
		Event types in the trace.
		Verbatim copy from src/runtime/trace.go with the "trace" prefix removed.

	const EvGoBlockGC EventType = 42 // goroutine blocks on GC assist [timestamp, stack]
		Event types in the trace.
		Verbatim copy from src/runtime/trace.go with the "trace" prefix removed.

	const EvGoBlockNet EventType = 27 // goroutine blocks on network [timestamp, stack]
		Event types in the trace.
		Verbatim copy from src/runtime/trace.go with the "trace" prefix removed.

	const EvGoBlockRecv EventType = 23 // goroutine blocks on chan recv [timestamp, stack]
		Event types in the trace.
		Verbatim copy from src/runtime/trace.go with the "trace" prefix removed.

	const EvGoBlockSelect EventType = 24 // goroutine blocks on select [timestamp, stack]
		Event types in the trace.
		Verbatim copy from src/runtime/trace.go with the "trace" prefix removed.

	const EvGoBlockSend EventType = 22 // goroutine blocks on chan send [timestamp, stack]
		Event types in the trace.
		Verbatim copy from src/runtime/trace.go with the "trace" prefix removed.

	const EvGoBlockSync EventType = 25 // goroutine blocks on Mutex/RWMutex [timestamp, stack]
		Event types in the trace.
		Verbatim copy from src/runtime/trace.go with the "trace" prefix removed.

	const EvGoCreate EventType = 13 // goroutine creation [timestamp, new goroutine id, new stack id, stack id]
		Event types in the trace.
		Verbatim copy from src/runtime/trace.go with the "trace" prefix removed.

	const EvGoEnd EventType = 15 // goroutine ends [timestamp]
		Event types in the trace.
		Verbatim copy from src/runtime/trace.go with the "trace" prefix removed.

	const EvGoInSyscall EventType = 32 // denotes that goroutine is in syscall when tracing starts [timestamp, goroutine id]
		Event types in the trace.
		Verbatim copy from src/runtime/trace.go with the "trace" prefix removed.

	const EvGomaxprocs EventType = 4 // current value of GOMAXPROCS [timestamp, GOMAXPROCS, stack id]
		Event types in the trace.
		Verbatim copy from src/runtime/trace.go with the "trace" prefix removed.

	const EvGoPreempt EventType = 18 // goroutine is preempted [timestamp, stack]
		Event types in the trace.
		Verbatim copy from src/runtime/trace.go with the "trace" prefix removed.

	const EvGoSched EventType = 17 // goroutine calls Gosched [timestamp, stack]
		Event types in the trace.
		Verbatim copy from src/runtime/trace.go with the "trace" prefix removed.

	const EvGoSleep EventType = 19 // goroutine calls Sleep [timestamp, stack]
		Event types in the trace.
		Verbatim copy from src/runtime/trace.go with the "trace" prefix removed.

	const EvGoStart EventType = 14 // goroutine starts running [timestamp, goroutine id, seq]
		Event types in the trace.
		Verbatim copy from src/runtime/trace.go with the "trace" prefix removed.

	const EvGoStartLabel EventType = 41 // goroutine starts running with label [timestamp, goroutine id, seq, label string id]
		Event types in the trace.
		Verbatim copy from src/runtime/trace.go with the "trace" prefix removed.

	const EvGoStartLocal EventType = 38 // goroutine starts running on the same P as the last event [timestamp, goroutine id]
		Event types in the trace.
		Verbatim copy from src/runtime/trace.go with the "trace" prefix removed.

	const EvGoStop EventType = 16 // goroutine stops (like in select{}) [timestamp, stack]
		Event types in the trace.
		Verbatim copy from src/runtime/trace.go with the "trace" prefix removed.

	const EvGoSysBlock EventType = 30 // syscall blocks [timestamp]
		Event types in the trace.
		Verbatim copy from src/runtime/trace.go with the "trace" prefix removed.

	const EvGoSysCall EventType = 28 // syscall enter [timestamp, stack]
		Event types in the trace.
		Verbatim copy from src/runtime/trace.go with the "trace" prefix removed.

	const EvGoSysExit EventType = 29 // syscall exit [timestamp, goroutine id, seq, real timestamp]
		Event types in the trace.
		Verbatim copy from src/runtime/trace.go with the "trace" prefix removed.

	const EvGoSysExitLocal EventType = 40 // syscall exit on the same P as the last event [timestamp, goroutine id, real timestamp]
		Event types in the trace.
		Verbatim copy from src/runtime/trace.go with the "trace" prefix removed.

	const EvGoUnblock EventType = 21 // goroutine is unblocked [timestamp, goroutine id, seq, stack]
		Event types in the trace.
		Verbatim copy from src/runtime/trace.go with the "trace" prefix removed.

	const EvGoUnblockLocal EventType = 39 // goroutine is unblocked on the same P as the last event [timestamp, goroutine id, stack]
		Event types in the trace.
		Verbatim copy from src/runtime/trace.go with the "trace" prefix removed.

	const EvGoWaiting EventType = 31 // denotes that goroutine is blocked when tracing starts [timestamp, goroutine id]
		Event types in the trace.
		Verbatim copy from src/runtime/trace.go with the "trace" prefix removed.

	const EvHeapAlloc EventType = 33 // gcController.heapLive change [timestamp, heap live bytes]
		Event types in the trace.
		Verbatim copy from src/runtime/trace.go with the "trace" prefix removed.

	const EvHeapGoal EventType = 34 // gcController.heapGoal change [timestamp, heap goal bytes]
		Event types in the trace.
		Verbatim copy from src/runtime/trace.go with the "trace" prefix removed.

	const EvNone EventType = 0 // unused
		Event types in the trace.
		Verbatim copy from src/runtime/trace.go with the "trace" prefix removed.

	const EvProcStart EventType = 5 // start of P [timestamp, thread id]
		Event types in the trace.
		Verbatim copy from src/runtime/trace.go with the "trace" prefix removed.

	const EvProcStop EventType = 6 // stop of P [timestamp]
		Event types in the trace.
		Verbatim copy from src/runtime/trace.go with the "trace" prefix removed.

	const EvStack EventType = 3 // stack [stack id, number of PCs, array of {PC, func string ID, file string ID, line}]
		Event types in the trace.
		Verbatim copy from src/runtime/trace.go with the "trace" prefix removed.

	const EvString EventType = 37 // string dictionary entry [ID, length, string]
		Event types in the trace.
		Verbatim copy from src/runtime/trace.go with the "trace" prefix removed.

	const EvSTWDone EventType = 10 // GC mark termination done [timestamp]
		Event types in the trace.
		Verbatim copy from src/runtime/trace.go with the "trace" prefix removed.

	const EvSTWStart EventType = 9 // GC mark termination start [timestamp, kind]
		Event types in the trace.
		Verbatim copy from src/runtime/trace.go with the "trace" prefix removed.

	const EvTimerGoroutine EventType = 35 // denotes timer goroutine [timer goroutine id]
		Event types in the trace.
		Verbatim copy from src/runtime/trace.go with the "trace" prefix removed.

	const EvUserLog EventType = 48 // trace.Log [timestamp, internal id, key string id, stack, value string]
		Event types in the trace.
		Verbatim copy from src/runtime/trace.go with the "trace" prefix removed.

	const EvUserRegion EventType = 47 // trace.WithRegion [timestamp, internal task id, mode(0:start, 1:end), name string]
		Event types in the trace.
		Verbatim copy from src/runtime/trace.go with the "trace" prefix removed.

	const EvUserTaskCreate EventType = 45 // trace.NewTask [timestamp, internal task id, internal parent id, stack, name string]
		Event types in the trace.
		Verbatim copy from src/runtime/trace.go with the "trace" prefix removed.

	const EvUserTaskEnd EventType = 46 // end of task [timestamp, internal task id, stack]
		Event types in the trace.
		Verbatim copy from src/runtime/trace.go with the "trace" prefix removed.

	const FakeP = 1000000
		Special P identifiers:

	const GCP = 1000004 // contains GC state
	const NetpollP = 1000002 // contains network unblocks
	const NumSTWReasons = 17
	const ProfileP = 1000005 // contains recording of CPU profile samples
	const STWAllGoroutinesStackTrace STWReason = 6
	const STWAllThreadsSyscall STWReason = 8
	const STWCountPagesInUse STWReason = 12
	const STWGCMarkTermination STWReason = 1
	const STWGCSweepTermination STWReason = 2
	const STWGOMAXPROCS STWReason = 9
	const STWGoroutineProfile STWReason = 4
	const STWGoroutineProfileCleanup STWReason = 5
	const STWPageCachePagesLeaked STWReason = 15
	const STWReadMemStats STWReason = 7
	const STWReadMemStatsSlow STWReason = 14
	const STWReadMetricsSlow STWReason = 13
	const STWResetDebugLog STWReason = 16
	const STWStartTrace STWReason = 10
	const STWStopTrace STWReason = 11
	const STWUnknown STWReason = 0
	const STWWriteHeapDump STWReason = 3
	const SyscallP = 1000003 // contains returns from syscalls
	const TimerP = 1000001 // contains timer unblocks

The pages are generated with Golds v0.8.3-preview. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @zigo_101 (reachable from the left QR code) to get the latest news of Golds.