capture

Documentation

Overview

Package capture contains all the core GAPIS functionality for dealing with loaded captures.

Index

• Constants
• func Captures() []*path.Capture
• func Export(ctx context.Context, p *path.Capture, w io.Writer) error
• func Get(ctx context.Context) *path.Capture
• func Import(ctx context.Context, name string, src Source) (*path.Capture, error)
• func New(ctx context.Context, a arena.Arena, name string, header *Header, ...) (*path.Capture, error)
• func NewState(ctx context.Context) (*api.GlobalState, error)
• func Put(ctx context.Context, c *path.Capture) context.Context
• type Capture
  • func Resolve(ctx context.Context) (*Capture, error)
  • func ResolveFromID(ctx context.Context, id id.ID) (*Capture, error)
  • func ResolveFromPath(ctx context.Context, p *path.Capture) (*Capture, error)
  • func (c *Capture) CloneInitialState(a arena.Arena) *InitialState
  • func (c *Capture) Export(ctx context.Context, w io.Writer) error
  • func (c *Capture) NewState(ctx context.Context) *api.GlobalState
  • func (c *Capture) NewUninitializedState(ctx context.Context) *api.GlobalState
  • func (c *Capture) Service(ctx context.Context, p *path.Capture) *service.Capture
• type ErrUnsupportedVersion
  • func (e ErrUnsupportedVersion) Error() string
• type InitialState
• type Source

Constants

const (
	// CurrentCaptureVersion is incremented on breaking changes to the capture format.
	// NB: Also update equally named field in spy_base.cpp
	CurrentCaptureVersion int32 = 3
)

Functions

func Captures

func Captures() []*path.Capture

Captures returns all the captures stored by the database by identifier.

func Export

func Export(ctx context.Context, p *path.Capture, w io.Writer) error

Export encodes the given capture and associated resources and writes it to the supplied io.Writer in the pack file format, producing output suitable for use with Import or opening in the trace editor.

func Get

func Get(ctx context.Context) *path.Capture

Get retrieves the capture path from a context previously annotated by Put.

func Import

func Import(ctx context.Context, name string, src Source) (*path.Capture, error)

Import imports the capture by name and data, and stores it in the database.

func New

func New(ctx context.Context, a arena.Arena, name string, header *Header, initialState *InitialState, cmds []api.Cmd) (*path.Capture, error)

New returns a path to a new capture with the given name, header and commands, using the arena a for allocations. The new capture is stored in the database.

func NewState

func NewState(ctx context.Context) (*api.GlobalState, error)

NewState returns a new, default-initialized State object built for the capture held by the context.

func Put

func Put(ctx context.Context, c *path.Capture) context.Context

Put attaches a capture path to a Context.

Types

type Capture

type Capture struct {
	Name         string
	Header       *Header
	Commands     []api.Cmd
	APIs         []api.API
	Observed     interval.U64RangeList
	InitialState *InitialState
	Arena        arena.Arena
	Messages     []*TraceMessage
}

func Resolve

func Resolve(ctx context.Context) (*Capture, error)

Resolve resolves the capture from a context previously annotated by Put.

func ResolveFromID

func ResolveFromID(ctx context.Context, id id.ID) (*Capture, error)

ResolveFromID resolves a single capture with the ID id.

func ResolveFromPath

func ResolveFromPath(ctx context.Context, p *path.Capture) (*Capture, error)

ResolveFromPath resolves a single capture with the path p.

func (*Capture) CloneInitialState

func (c *Capture) CloneInitialState(a arena.Arena) *InitialState

CloneInitialState clones this capture's initial state and returns it.

func (*Capture) Export

func (c *Capture) Export(ctx context.Context, w io.Writer) error

Export encodes the given capture and associated resources and writes it to the supplied io.Writer in the .gfxtrace format.

func (*Capture) NewState

func (c *Capture) NewState(ctx context.Context) *api.GlobalState

NewState returns a new, initialized GlobalState object built for the capture c. If the capture contains a mid-execution state, then this will be copied into the returned state.

func (*Capture) NewUninitializedState

func (c *Capture) NewUninitializedState(ctx context.Context) *api.GlobalState

NewUninitializedState returns a new, uninitialized GlobalState built for the capture c. The returned state does not contain the capture's mid-execution state.

func (*Capture) Service

func (c *Capture) Service(ctx context.Context, p *path.Capture) *service.Capture

Service returns the service.Capture description for this capture.

type ErrUnsupportedVersion

type ErrUnsupportedVersion struct{ Version int32 }

func (ErrUnsupportedVersion) Error

func (e ErrUnsupportedVersion) Error() string

type InitialState

type InitialState struct {
	Memory []api.CmdObservation
	APIs   map[api.API]api.State
}

type Source

type Source interface {
	// ReadCloser returns an io.ReadCloser instance, from which capture data
	// can be read and closed after reading.
	ReadCloser() (io.ReadCloser, error)
	Size() (uint64, error)
}

Source represents the source of capture data.