sys

Documentation

Index

• Variables
• func AssertContainsPaths(tb testing.TB, actual, expected []string) bool
• func Ldd(ctx context.Context, path string) ([]string, error)
• func MustAbsPath(tb testing.TB, path string) string
• type Arch
  • func ReadELFArch(fileName string) (Arch, error)
  • func (a *Arch) IsNative() bool
  • func (a *Arch) KVMAvailable() bool
  • func (a *Arch) Set(s string) error
  • func (a *Arch) String() string
• type LibCollection
  • func CollectLibsFor(ctx context.Context, files ...string) (LibCollection, error)
  • func (c *LibCollection) Libs() iter.Seq[string]
  • func (c *LibCollection) SearchPaths() iter.Seq[string]

Variables

var (
	// ErrNoInterpreter is returned if no interpreter is found in an ELF file.
	ErrNoInterpreter = errors.New("no interpreter in ELF file")

	// ErrNotELFFile is returned if the file does not have an ELF magic number.
	ErrNotELFFile = errors.New("is not an ELF file")

	// ErrOSABINotSupported is returned if the OS ABI of an ELF file is not
	// supported.
	ErrOSABINotSupported = errors.New("OSABI not supported")

	// ErrMachineNotSupported is returned if the machine type of an ELF file
	// is not supported.
	ErrMachineNotSupported = errors.New("machine type not supported")
)

var ErrArchNotSupported = errors.New("architecture not supported")

Functions

func AssertContainsPaths

func AssertContainsPaths(tb testing.TB, actual, expected []string) bool

func Ldd

func Ldd(ctx context.Context, path string) ([]string, error)

Ldd gathers the required shared objects of the ELF file with the given path. The path must point to an ELF file. ErrNotELFFile is returned if it is not an ELF file. ErrNoInterpreter is returned if no interpreter path is found in the ELF file. This is the case if the binary was statically linked.

The objects are searched for in the usual search paths of the file's interpreter. Note that the dynamic linker consumes the environment variable LD_LIBRARY_PATH, so it can be used to add additional search paths.

Since this implementation executes the ELF interpreter of the given file, it should be run only for trusted binaries!

Until version 2.27 the glibc provided ldd worked like this implementation and executed the binaries ELF interpreter directly. Since this has some security implications and may lead to unintended execution of arbitrary code it was changed with version 2.27. With newer versions, ldd tries a set of fixed known ELF interpreters. Since they are specific to the glibc build, thus Linux distribution specific, it is not feasible for this implementation. Because of this the former procedure is used, so use with great care!

func MustAbsPath

func MustAbsPath(tb testing.TB, path string) string

Types

type Arch

type Arch string

const (
	AMD64   Arch = "amd64"
	ARM64   Arch = "arm64"
	RISCV64 Arch = "riscv64"
	Native  Arch = Arch(runtime.GOARCH)
)

func ReadELFArch

func ReadELFArch(fileName string) (Arch, error)

ReadELFArch returns the sys.Arch of the given ELF file.

It returns an error if the ELF file is not for Linux or is for an unsupported architecture.

func (*Arch) IsNative

func (a *Arch) IsNative() bool

func (*Arch) KVMAvailable

func (a *Arch) KVMAvailable() bool

KVMAvailable checks if KVM support is available for the given architecture.

func (*Arch) Set

func (a *Arch) Set(s string) error

func (*Arch) String

func (a *Arch) String() string

type LibCollection

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

LibCollection is a deduplicated collection of dynamically linked libraries and paths they are found at.

func CollectLibsFor

func CollectLibsFor(
	ctx context.Context,
	files ...string,
) (LibCollection, error)

CollectLibsFor recursively resolves the dynamically linked shared objects of all given ELF files.

The dynamic linker consumed LD_LIBRARY_PATH from the environment.

func (*LibCollection) Libs

func (c *LibCollection) Libs() iter.Seq[string]

func (*LibCollection) SearchPaths

func (c *LibCollection) SearchPaths() iter.Seq[string]