platform

Documentation

Overview

Package platform includes runtime-specific code needed for the compiler or otherwise.

Note: This is a dependency-free alternative to depending on parts of Go's x/sys. See /RATIONALE.md for more context.

Index

• Constants
• Variables
• func CompilerSupported() bool
• func MmapCodeSegment(size int) ([]byte, error)
• func MprotectRX(b []byte) (err error)
• func MunmapCodeSegment(code []byte) error
• func Nanosleep(ns int64)
• func Nanotime() int64
• func NewFakeNanotime() sys.Nanotime
• func NewFakeRandSource() io.Reader
• func NewFakeWalltime() sys.Walltime
• func RemapCodeSegment(code []byte, size int) ([]byte, error)
• func ToPosixPath(in string) string
• func UnwrapOSError(err error) syscall.Errno
• func Walltime() (sec int64, nsec int32)
• type CpuFeatureFlags
• type FdSet
  • func (f *FdSet) Clear(fd int)
  • func (f *FdSet) IsSet(fd int) bool
  • func (f *FdSet) Set(fd int)
  • func (f *FdSet) Zero()

Constants

const (
	// CpuFeatureSSE3 is the flag to query CpuFeatureFlags.Has for SSEv3 capabilities
	CpuFeatureSSE3 = uint64(1)
	// CpuFeatureSSE4_1 is the flag to query CpuFeatureFlags.Has for SSEv4.1 capabilities
	CpuFeatureSSE4_1 = uint64(1) << 19
	// CpuFeatureSSE4_2 is the flag to query CpuFeatureFlags.Has for SSEv4.2 capabilities
	CpuFeatureSSE4_2 = uint64(1) << 20
)

const (
	// CpuExtraFeatureABM is the flag to query CpuFeatureFlags.HasExtra for Advanced Bit Manipulation capabilities (e.g. LZCNT)
	CpuExtraFeatureABM = uint64(1) << 5
)

const (

	// FakeEpochNanos is midnight UTC 2022-01-01 and exposed for testing
	FakeEpochNanos = 1640995200000 * ms
)

Variables

var FakeNanosleep = sys.Nanosleep(func(int64) {})

FakeNanosleep implements sys.Nanosleep by returning without sleeping.

var FakeOsyield = sys.Osyield(func() {})

FakeOsyield implements sys.Osyield by returning without yielding.

var IsAtLeastGo120 = isAtLeastGo120(runtime.Version())

IsAtLeastGo120 checks features added in 1.20. We can remove this when Go 1.22 is out.

Functions

func CompilerSupported

func CompilerSupported() bool

CompilerSupported is exported for tests and includes constraints here and also the assembler.

func MmapCodeSegment

func MmapCodeSegment(size int) ([]byte, error)

MmapCodeSegment copies the code into the executable region and returns the byte slice of the region.

See https://man7.org/linux/man-pages/man2/mmap.2.html for mmap API and flags.

func MprotectRX

func MprotectRX(b []byte) (err error)

MprotectRX is like syscall.Mprotect with RX permission, defined locally so that freebsd compiles.

func MunmapCodeSegment

func MunmapCodeSegment(code []byte) error

MunmapCodeSegment unmaps the given memory region.

func Nanosleep

func Nanosleep(ns int64)

Nanosleep implements sys.Nanosleep with time.Sleep.

func Nanotime

func Nanotime() int64

Nanotime implements sys.Nanotime with runtime.nanotime() if CGO is available and time.Since if not.

func NewFakeNanotime

func NewFakeNanotime() sys.Nanotime

NewFakeNanotime implements sys.Nanotime that increases by 1ms each reading. See /RATIONALE.md

func NewFakeRandSource

func NewFakeRandSource() io.Reader

NewFakeRandSource returns a deterministic source of random values.

func NewFakeWalltime

func NewFakeWalltime() sys.Walltime

NewFakeWalltime implements sys.Walltime with FakeEpochNanos that increases by 1ms each reading. See /RATIONALE.md

func RemapCodeSegment

func RemapCodeSegment(code []byte, size int) ([]byte, error)

RemapCodeSegment reallocates the memory mapping of an existing code segment to increase its size. The previous code mapping is unmapped and must not be reused after the function returns.

This is similar to mremap(2) on linux, and emulated on platforms which do not have this syscall.

See https://man7.org/linux/man-pages/man2/mremap.2.html

func ToPosixPath

func ToPosixPath(in string) string

ToPosixPath returns the input, as only windows might return backslashes.

func UnwrapOSError

func UnwrapOSError(err error) syscall.Errno

UnwrapOSError returns a syscall.Errno or zero if the input is nil.

func Walltime

func Walltime() (sec int64, nsec int32)

Walltime implements sys.Walltime with time.Now.

Note: This is only notably less efficient than it could be is reading runtime.walltime(). time.Now defensively reads nanotime also, just in case time.Since is used. This doubles the performance impact. However, wall time is likely to be read less frequently than Nanotime. Also, doubling the cost matters less on fast platforms that can return both in <=100ns.

Types

type CpuFeatureFlags

type CpuFeatureFlags interface {
	// Has returns true when the specified flag (represented as uint64) is supported
	Has(cpuFeature uint64) bool
	// HasExtra returns true when the specified extraFlag (represented as uint64) is supported
	HasExtra(cpuFeature uint64) bool
}

CpuFeatureFlags exposes methods for querying CPU capabilities

var CpuFeatures CpuFeatureFlags = loadCpuFeatureFlags()

CpuFeatures exposes the capabilities for this CPU, queried via the Has, HasExtra methods

type FdSet

type FdSet syscall.FdSet

FdSet re-exports syscall.FdSet with utility methods.

func (*FdSet) Clear

func (f *FdSet) Clear(fd int)

Clear removes the given fd from the set.

func (*FdSet) IsSet

func (f *FdSet) IsSet(fd int) bool

IsSet returns true when fd is in the set.

func (*FdSet) Set

func (f *FdSet) Set(fd int)

Set adds the given fd to the set.

func (*FdSet) Zero

func (f *FdSet) Zero()

Zero clears the set.