package event

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

Dependency Relation
	imports 0 packages, and imported by 6 packages

Involved Source Files

	    event.go
	    requirements.go
Package-Level Type Names (total 5)

	/* sort by: alphabet | popularity */
	 type Constraint uint8 (basic type)
		Constraint represents a various presence requirements.

		As Types Of (total 3)
			const MayHave
			const MustHave
			const MustNotHave

	 type Experiment uint (basic type)
		Experiment is an experiment ID that events may be associated with.

		As Types Of (total 2)
			const NoExperiment
			const internal/trace/event/go122.AllocFree

	 type SchedReqs (struct)
		SchedReqs is a set of constraints on what the scheduling
		context must look like.

		Fields (total 3)
			Goroutine Constraint
			Proc Constraint
			Thread Constraint
		As Types Of (only one)
			  var UserGoReqs

	 type Spec (struct)
		Spec is a specification for a trace event. It contains sufficient information
		to perform basic parsing of any trace event for any version of Go.

		Fields (total 9)
			Args []string
				Args contains the names of each trace event's argument.
				Its length determines the number of arguments an event has.
				
				Argument names follow a certain structure and this structure
				is relied on by the testing framework to type-check arguments.
				The structure is is:
				
				    (?P<name>[A-Za-z]+_)?(?P<type>[A-Za-z]+)
				
				In sum, it's an optional name followed by a type. If the name
				is present, it is separated from the type with an underscore.
				The valid argument types and the Go types they map to are listed
				in the ArgTypes variable.

			Experiment Experiment
				Experiment indicates the ID of an experiment this event is associated
				with. If Experiment is not NoExperiment, then the event is experimental
				and will be exposed as an EventExperiment.

			HasData bool
				HasData is true if the event has trailer consisting of a
				varint length followed by unencoded bytes of some data.
				
				An event may not be both a timed event and have data.

			IsStack bool
				IsStack indicates that the event represents a complete
				stack trace. Specifically, it means that after the arguments
				there's a varint length, followed by 4*length varints. Each
				group of 4 represents the PC, file ID, func ID, and line number
				in that order.

			IsTimedEvent bool
				IsTimedEvent indicates whether this is an event that both
				appears in the main event stream and is surfaced to the
				trace reader.
				
				Events that are not "timed" are considered "structural"
				since they either need significant reinterpretation or
				otherwise aren't actually surfaced by the trace reader.

			Name string
				Name is the human-readable name of the trace event.

			StackIDs []int
				StackIDs indicates which of the arguments are stack IDs.
				
				The list is not sorted. The first index always refers to
				the main stack for the current execution context of the event.

			StartEv Type
				StartEv indicates the event type of the corresponding "start"
				event, if this event is an "end," for a pair of events that
				represent a time range.

			StringIDs []int
				StringIDs indicates which of the arguments are string IDs.

		As Outputs Of (at least 2)
			func internal/trace/event/go122.Specs() []Spec
			func internal/trace/version.Version.Specs() []Spec
		As Inputs Of (at least one exported)
			func Names(specs []Spec) map[string]Type

	 type Type uint8 (basic type)
		Type is the common in-memory representation of the low-leve

		As Outputs Of (at least one exported)
			func Names(specs []Spec) map[string]Type
		As Inputs Of (at least 3)
			func internal/trace/event/go122.EventString(typ Type) string
			func internal/trace/internal/testgen/go122.(*Batch).RawEvent(typ Type, data []byte, args ...uint64)
			func internal/trace/internal/testgen/go122.(*Trace).RawEvent(typ Type, data []byte, args ...uint64)
		As Types Of (total 110)
			const internal/trace/event/go122.EvCPUSample
			const internal/trace/event/go122.EvCPUSamples
			const internal/trace/event/go122.EvEventBatch
			const internal/trace/event/go122.EvExperimentalBatch
			const internal/trace/event/go122.EvFrequency
			const internal/trace/event/go122.EvGCActive
			const internal/trace/event/go122.EvGCBegin
			const internal/trace/event/go122.EvGCEnd
			const internal/trace/event/go122.EvGCMarkAssistActive
			const internal/trace/event/go122.EvGCMarkAssistBegin
			const internal/trace/event/go122.EvGCMarkAssistEnd
			const internal/trace/event/go122.EvGCSweepActive
			const internal/trace/event/go122.EvGCSweepBegin
			const internal/trace/event/go122.EvGCSweepEnd
			const internal/trace/event/go122.EvGoBlock
			const internal/trace/event/go122.EvGoCreate
			const internal/trace/event/go122.EvGoCreateBlocked
			const internal/trace/event/go122.EvGoCreateSyscall
			const internal/trace/event/go122.EvGoDestroy
			const internal/trace/event/go122.EvGoDestroySyscall
			const internal/trace/event/go122.EvGoLabel
			const internal/trace/event/go122.EvGoroutineStack
			const internal/trace/event/go122.EvGoroutineStackAlloc
			const internal/trace/event/go122.EvGoroutineStackFree
			const internal/trace/event/go122.EvGoStart
			const internal/trace/event/go122.EvGoStatus
			const internal/trace/event/go122.EvGoStatusStack
			const internal/trace/event/go122.EvGoStop
			const internal/trace/event/go122.EvGoSwitch
			const internal/trace/event/go122.EvGoSwitchDestroy
			const internal/trace/event/go122.EvGoSyscallBegin
			const internal/trace/event/go122.EvGoSyscallEnd
			const internal/trace/event/go122.EvGoSyscallEndBlocked
			const internal/trace/event/go122.EvGoUnblock
			const internal/trace/event/go122.EvHeapAlloc
			const internal/trace/event/go122.EvHeapGoal
			const internal/trace/event/go122.EvHeapObject
			const internal/trace/event/go122.EvHeapObjectAlloc
			const internal/trace/event/go122.EvHeapObjectFree
			const internal/trace/event/go122.EvNone
			const internal/trace/event/go122.EvProcsChange
			const internal/trace/event/go122.EvProcStart
			const internal/trace/event/go122.EvProcStatus
			const internal/trace/event/go122.EvProcSteal
			const internal/trace/event/go122.EvProcStop
			const internal/trace/event/go122.EvSpan
			const internal/trace/event/go122.EvSpanAlloc
			const internal/trace/event/go122.EvSpanFree
			const internal/trace/event/go122.EvStack
			const internal/trace/event/go122.EvStacks
			const internal/trace/event/go122.EvString
			const internal/trace/event/go122.EvStrings
			const internal/trace/event/go122.EvSTWBegin
			const internal/trace/event/go122.EvSTWEnd
			const internal/trace/event/go122.EvUserLog
			const internal/trace/event/go122.EvUserRegionBegin
			const internal/trace/event/go122.EvUserRegionEnd
			const internal/trace/event/go122.EvUserTaskBegin
			const internal/trace/event/go122.EvUserTaskEnd
			const internal/trace/internal/oldtrace.EvBatch
			const internal/trace/internal/oldtrace.EvCount
			const internal/trace/internal/oldtrace.EvCPUSample
			const internal/trace/internal/oldtrace.EvFrequency
			const internal/trace/internal/oldtrace.EvFutileWakeup
			const internal/trace/internal/oldtrace.EvGCDone
			const internal/trace/internal/oldtrace.EvGCMarkAssistDone
			const internal/trace/internal/oldtrace.EvGCMarkAssistStart
			const internal/trace/internal/oldtrace.EvGCStart
			const internal/trace/internal/oldtrace.EvGCSweepDone
			const internal/trace/internal/oldtrace.EvGCSweepStart
			const internal/trace/internal/oldtrace.EvGoBlock
			const internal/trace/internal/oldtrace.EvGoBlockCond
			const internal/trace/internal/oldtrace.EvGoBlockGC
			const internal/trace/internal/oldtrace.EvGoBlockNet
			const internal/trace/internal/oldtrace.EvGoBlockRecv
			const internal/trace/internal/oldtrace.EvGoBlockSelect
			const internal/trace/internal/oldtrace.EvGoBlockSend
			const internal/trace/internal/oldtrace.EvGoBlockSync
			const internal/trace/internal/oldtrace.EvGoCreate
			const internal/trace/internal/oldtrace.EvGoEnd
			const internal/trace/internal/oldtrace.EvGoInSyscall
			const internal/trace/internal/oldtrace.EvGomaxprocs
			const internal/trace/internal/oldtrace.EvGoPreempt
			const internal/trace/internal/oldtrace.EvGoSched
			const internal/trace/internal/oldtrace.EvGoSleep
			const internal/trace/internal/oldtrace.EvGoStart
			const internal/trace/internal/oldtrace.EvGoStartLabel
			const internal/trace/internal/oldtrace.EvGoStartLocal
			const internal/trace/internal/oldtrace.EvGoStop
			const internal/trace/internal/oldtrace.EvGoSysBlock
			const internal/trace/internal/oldtrace.EvGoSysCall
			const internal/trace/internal/oldtrace.EvGoSysExit
			const internal/trace/internal/oldtrace.EvGoSysExitLocal
			const internal/trace/internal/oldtrace.EvGoUnblock
			const internal/trace/internal/oldtrace.EvGoUnblockLocal
			const internal/trace/internal/oldtrace.EvGoWaiting
			const internal/trace/internal/oldtrace.EvHeapAlloc
			const internal/trace/internal/oldtrace.EvHeapGoal
			const internal/trace/internal/oldtrace.EvNone
			const internal/trace/internal/oldtrace.EvProcStart
			const internal/trace/internal/oldtrace.EvProcStop
			const internal/trace/internal/oldtrace.EvStack
			const internal/trace/internal/oldtrace.EvString
			const internal/trace/internal/oldtrace.EvSTWDone
			const internal/trace/internal/oldtrace.EvSTWStart
			const internal/trace/internal/oldtrace.EvTimerGoroutine
			const internal/trace/internal/oldtrace.EvUserLog
			const internal/trace/internal/oldtrace.EvUserRegion
			const internal/trace/internal/oldtrace.EvUserTaskCreate
			const internal/trace/internal/oldtrace.EvUserTaskEnd


Package-Level Functions (only one)

	 func Names(specs []Spec) map[string]Type
		Names is a helper that produces a mapping of event names to event types.


Package-Level Variables (total 2)

	  var ArgTypes [10]string
		ArgTypes is a list of valid argument types for use in Args.
		
		See the documentation of Args for more details.

	  var UserGoReqs SchedReqs
		UserGoReqs is a common requirement among events that are running
		or are close to running user code.


Package-Level Constants (total 4)

	const MayHave Constraint = 1
	const MustHave Constraint = 2
	const MustNotHave Constraint = 0
	const NoExperiment Experiment = 0
		NoExperiment is the reserved ID 0 indicating no experiment.

The pages are generated with Golds v0.6.9-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 @Go100and1 (reachable from the left QR code) to get the latest news of Golds.