objectfile

Documentation

Index

• Variables
• type Cache
• type ObjectFile
  • func (o *ObjectFile) ELF() (*elf.File, error)
  • func (o *ObjectFile) Reader() (*io.SectionReader, error)
• type Pool
  • func NewPool(logger log.Logger, reg prometheus.Registerer, evictionPolicy string, ...) *Pool
  • func (p *Pool) Close() error
  • func (p *Pool) NewFile(f *os.File, buildIDOverride string) (_ *ObjectFile, err error)
  • func (p *Pool) Open(path string) (*ObjectFile, error)

Variables

var (
	ErrNotInitialized = errors.New("file is not initialized")
	ErrAlreadyClosed  = errors.New("file is already closed")
)

Types

type Cache

type Cache[K comparable, V any] interface {
	Add(key K, value V)
	Get(key K) (V, bool)
	Peek(key K) (V, bool)
	Remove(key K)
	Purge()
}

type ObjectFile

type ObjectFile struct {
	BuildID string

	Path    string
	Size    int64
	Modtime time.Time

	// If exists, will be released when the parent ObjectFile is released.
	// Go GC with a finalizer works correctly even with cyclic references.
	DebugFile *ObjectFile
	// contains filtered or unexported fields
}

ObjectFile represents an executable or library file. It handles the lifetime of the underlying file descriptor.

func (*ObjectFile) ELF

func (o *ObjectFile) ELF() (*elf.File, error)

ELF returns the ELF file for the object file. Parallel reads are allowed.

func (*ObjectFile) Reader

func (o *ObjectFile) Reader() (*io.SectionReader, error)

Reader returns a reader for the file. Parallel reads are NOT allowed. The caller must call the returned function when done with the reader.

type Pool

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

func NewPool

func NewPool(logger log.Logger, reg prometheus.Registerer, evictionPolicy string, poolSize int, profilingDuration time.Duration) *Pool

func (*Pool) Close

func (p *Pool) Close() error

Close closes the pool and all the files in it.

func (*Pool) NewFile

func (p *Pool) NewFile(f *os.File, buildIDOverride string) (_ *ObjectFile, err error)

NewFile creates a new ObjectFile reference from an existing file. The returned reference should be released after use. The file will be closed when the reference is released.

Optionally takes a parameter for the buildID that the new object file should have. To compute the build ID, pass the empty string.

func (*Pool) Open

func (p *Pool) Open(path string) (*ObjectFile, error)

Open opens the specified executable or library file from the given path. And creates a new ObjectFile reference. The returned reference should be released after use. The file will be closed when the reference is released.