perf

Documentation

Index

• Variables
• type Count
  • func (c Count) Value() (float64, string)
• type Counter
  • func OpenCounter(target Target, evs ...events.Event) (*Counter, error)
  • func (c *Counter) Close()
  • func (c *Counter) ReadGroup(cs []Count) error
  • func (c *Counter) ReadOne() (Count, error)
  • func (c *Counter) Start()
  • func (c *Counter) Stop()
• type Target

Variables

var (
	// TargetThisGoroutine monitors the calling goroutine. This will call
	// [runtime.LockOSThread] on Open and [runtime.UnlockOSThread] on Close.
	TargetThisGoroutine = targetThisGoroutine{}
)

Types

type Count

type Count struct {
	RawValue uint64 // The number of events while this counter was running.

	TimeEnabled uint64 // Total time the Counter was started.
	TimeRunning uint64 // Total time the Counter was actually counting.
	// contains filtered or unexported fields
}

Count is the value of a Counter.

func (Count) Value

func (c Count) Value() (float64, string)

Value returns the measured value of Count, scaled to account for time the counter was scheduled, and to account for any conversion factors in the underlying event.

type Counter

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

A Counter reports the number of times a events.Event or group of Events occurred.

func OpenCounter

func OpenCounter(target Target, evs ...events.Event) (*Counter, error)

OpenCounter returns a new Counter that reads values for the given events.Event or group of Events on the given Target. Callers are expected to call Counter.Close when done with this Counter.

If multiple events are given, they are opened as a group, which means they will all be scheduled onto the hardware at the same time.

The counter is initially not running. Call Counter.Start to start it.

func (*Counter) Close

func (c *Counter) Close()

Close closes this counter and unlocks the goroutine from the OS thread.

func (*Counter) ReadGroup

func (c *Counter) ReadGroup(cs []Count) error

ReadGroup returns the current value of all events in c.

func (*Counter) ReadOne

func (c *Counter) ReadOne() (Count, error)

ReadOne returns the current value of the first event in c. For counters that only have a single Event, this is faster and more ergonomic than Counter.ReadGroup.

func (*Counter) Start

func (c *Counter) Start()

Start the counter.

func (*Counter) Stop

func (c *Counter) Stop()

Stop the counter.

type Target

type Target interface {
	// contains filtered or unexported methods
}

Target specifies what goroutine, thread, or CPU a Counter should monitor.