abi

Documentation

Overview

Package abi describes the interface between a kernel and userspace. Most of this is from gvisor but I've reordered it a bit as some things are common to OSX. I've also followed Go practice for these mostly never-viewed files and put them into a small number of largish files.

Index

• Constants
• Variables
• type BitFlag
  • func (f *BitFlag) Mask() uint64
  • func (f *BitFlag) Match(val uint64) bool
  • func (f *BitFlag) String(_ uint64) string
• type ClockT
• type ControlMessageCredentials
• type ControlMessageHeader
• type ControlMessageRights
• type Field
  • func (f *Field) Mask() uint64
  • func (f *Field) Match(val uint64) bool
  • func (f *Field) String(val uint64) string
• type Flag
• type FlagSet
  • func (s FlagSet) Parse(val uint64) Flags
• type Flags
  • func Futex(op uint64) Flags
  • func Open(val uint64) Flags
  • func SockFlags(flags int32) Flags
  • func SockProtocol(family, protocol int32) Flags
  • func SockType(stype int32) Flags
  • func (f *Flags) Add(flag ...string)
  • func (f *Flags) AddFlags(flags Flags)
  • func (f Flags) MarshalJSON() ([]byte, error)
• type MessageHeader64
• type OS
  • func (o OS) String() string
• type SockAddrInet
• type SockAddrInet6
• type SockAddrUnix
• type TCPInfo
• type TimeT
• type TimerID
• type Tms
• type Value
  • func (e *Value) Mask() uint64
  • func (e *Value) Match(val uint64) bool
  • func (e *Value) String(_ uint64) string

Constants

const (
	FUTEX_WAIT            = 0
	FUTEX_WAKE            = 1
	FUTEX_FD              = 2
	FUTEX_REQUEUE         = 3
	FUTEX_CMP_REQUEUE     = 4
	FUTEX_WAKE_OP         = 5
	FUTEX_LOCK_PI         = 6
	FUTEX_UNLOCK_PI       = 7
	FUTEX_TRYLOCK_PI      = 8
	FUTEX_WAIT_BITSET     = 9
	FUTEX_WAKE_BITSET     = 10
	FUTEX_WAIT_REQUEUE_PI = 11
	FUTEX_CMP_REQUEUE_PI  = 12

	FUTEX_PRIVATE_FLAG   = 128
	FUTEX_CLOCK_REALTIME = 256
)

From <linux/futex.h> and <sys/time.h>. Flags are used in syscall futex(2).

const (
	FUTEX_OP_SET         = 0
	FUTEX_OP_ADD         = 1
	FUTEX_OP_OR          = 2
	FUTEX_OP_ANDN        = 3
	FUTEX_OP_XOR         = 4
	FUTEX_OP_OPARG_SHIFT = 8
	FUTEX_OP_CMP_EQ      = 0
	FUTEX_OP_CMP_NE      = 1
	FUTEX_OP_CMP_LT      = 2
	FUTEX_OP_CMP_LE      = 3
	FUTEX_OP_CMP_GT      = 4
	FUTEX_OP_CMP_GE      = 5
)

These are flags are from <linux/futex.h> and are used in FUTEX_WAKE_OP to define the operations.

const (
	PTRACE_TRACEME              = 0
	PTRACE_PEEKTEXT             = 1
	PTRACE_PEEKDATA             = 2
	PTRACE_PEEKUSR              = 3
	PTRACE_POKETEXT             = 4
	PTRACE_POKEDATA             = 5
	PTRACE_POKEUSR              = 6
	PTRACE_CONT                 = 7
	PTRACE_KILL                 = 8
	PTRACE_SINGLESTEP           = 9
	PTRACE_ATTACH               = 16
	PTRACE_DETACH               = 17
	PTRACE_SYSCALL              = 24
	PTRACE_SETOPTIONS           = 0x4200
	PTRACE_GETEVENTMSG          = 0x4201
	PTRACE_GETSIGINFO           = 0x4202
	PTRACE_SETSIGINFO           = 0x4203
	PTRACE_GETREGSET            = 0x4204
	PTRACE_SETREGSET            = 0x4205
	PTRACE_SEIZE                = 0x4206
	PTRACE_INTERRUPT            = 0x4207
	PTRACE_LISTEN               = 0x4208
	PTRACE_PEEKSIGINFO          = 0x4209
	PTRACE_GETSIGMASK           = 0x420a
	PTRACE_SETSIGMASK           = 0x420b
	PTRACE_SECCOMP_GET_FILTER   = 0x420c
	PTRACE_SECCOMP_GET_METADATA = 0x420d
)

ptrace commands from include/uapi/linux/ptrace.h.

const (
	PTRACE_GETREGS           = 12
	PTRACE_SETREGS           = 13
	PTRACE_GETFPREGS         = 14
	PTRACE_SETFPREGS         = 15
	PTRACE_GETFPXREGS        = 18
	PTRACE_SETFPXREGS        = 19
	PTRACE_OLDSETOPTIONS     = 21
	PTRACE_GET_THREAD_AREA   = 25
	PTRACE_SET_THREAD_AREA   = 26
	PTRACE_ARCH_PRCTL        = 30
	PTRACE_SYSEMU            = 31
	PTRACE_SYSEMU_SINGLESTEP = 32
	PTRACE_SINGLEBLOCK       = 33
)

ptrace commands from arch/x86/include/uapi/asm/ptrace-abi.h.

const (
	PTRACE_EVENT_FORK       = 1
	PTRACE_EVENT_VFORK      = 2
	PTRACE_EVENT_CLONE      = 3
	PTRACE_EVENT_EXEC       = 4
	PTRACE_EVENT_VFORK_DONE = 5
	PTRACE_EVENT_EXIT       = 6
	PTRACE_EVENT_SECCOMP    = 7
	PTRACE_EVENT_STOP       = 128
)

ptrace event codes from include/uapi/linux/ptrace.h.

const (
	PTRACE_O_TRACESYSGOOD    = 1
	PTRACE_O_TRACEFORK       = 1 << PTRACE_EVENT_FORK
	PTRACE_O_TRACEVFORK      = 1 << PTRACE_EVENT_VFORK
	PTRACE_O_TRACECLONE      = 1 << PTRACE_EVENT_CLONE
	PTRACE_O_TRACEEXEC       = 1 << PTRACE_EVENT_EXEC
	PTRACE_O_TRACEVFORKDONE  = 1 << PTRACE_EVENT_VFORK_DONE
	PTRACE_O_TRACEEXIT       = 1 << PTRACE_EVENT_EXIT
	PTRACE_O_TRACESECCOMP    = 1 << PTRACE_EVENT_SECCOMP
	PTRACE_O_EXITKILL        = 1 << 20
	PTRACE_O_SUSPEND_SECCOMP = 1 << 21
)

PTRACE_SETOPTIONS options from include/uapi/linux/ptrace.h.

const (
	// TFD_CLOEXEC is a timerfd_create flag.
	TFD_CLOEXEC = unix.O_CLOEXEC

	// TFD_NONBLOCK is a timerfd_create flag.
	TFD_NONBLOCK = unix.O_NONBLOCK

	// TFD_TIMER_ABSTIME is a timerfd_settime flag.
	TFD_TIMER_ABSTIME = 1
)

Flags for timerfd syscalls (timerfd_create(2), timerfd_settime(2)).

const (
	AF_UNSPEC     = 0
	AF_UNIX       = 1
	AF_INET       = 2
	AF_AX25       = 3
	AF_IPX        = 4
	AF_APPLETALK  = 5
	AF_NETROM     = 6
	AF_BRIDGE     = 7
	AF_ATMPVC     = 8
	AF_X25        = 9
	AF_INET6      = 10
	AF_ROSE       = 11
	AF_DECnet     = 12
	AF_NETBEUI    = 13
	AF_SECURITY   = 14
	AF_KEY        = 15
	AF_NETLINK    = 16
	AF_PACKET     = 17
	AF_ASH        = 18
	AF_ECONET     = 19
	AF_ATMSVC     = 20
	AF_RDS        = 21
	AF_SNA        = 22
	AF_IRDA       = 23
	AF_PPPOX      = 24
	AF_WANPIPE    = 25
	AF_LLC        = 26
	AF_IB         = 27
	AF_MPLS       = 28
	AF_CAN        = 29
	AF_TIPC       = 30
	AF_BLUETOOTH  = 31
	AF_IUCV       = 32
	AF_RXRPC      = 33
	AF_ISDN       = 34
	AF_PHONET     = 35
	AF_IEEE802154 = 36
	AF_CAIF       = 37
	AF_ALG        = 38
	AF_NFC        = 39
	AF_VSOCK      = 40
)

Socket defines. Some of these might move to abi_unix.go Address families, from linux/socket.h.

const (
	MSG_OOB              = 0x1
	MSG_PEEK             = 0x2
	MSG_DONTROUTE        = 0x4
	MSG_TRYHARD          = 0x4
	MSG_CTRUNC           = 0x8
	MSG_PROBE            = 0x10
	MSG_TRUNC            = 0x20
	MSG_DONTWAIT         = 0x40
	MSG_EOR              = 0x80
	MSG_WAITALL          = 0x100
	MSG_FIN              = 0x200
	MSG_EOF              = MSG_FIN
	MSG_SYN              = 0x400
	MSG_CONFIRM          = 0x800
	MSG_RST              = 0x1000
	MSG_ERRQUEUE         = 0x2000
	MSG_NOSIGNAL         = 0x4000
	MSG_MORE             = 0x8000
	MSG_WAITFORONE       = 0x10000
	MSG_SENDPAGE_NOTLAST = 0x20000
	MSG_REINJECT         = 0x8000000
	MSG_ZEROCOPY         = 0x4000000
	MSG_FASTOPEN         = 0x20000000
	MSG_CMSG_CLOEXEC     = 0x40000000
)

sendmsg(2)/recvmsg(2) flags, from linux/socket.h.

const (
	SOCK_STREAM    = 1
	SOCK_DGRAM     = 2
	SOCK_RAW       = 3
	SOCK_RDM       = 4
	SOCK_SEQPACKET = 5
	SOCK_DCCP      = 6
	SOCK_PACKET    = 10
)

Socket types, from linux/net.h.

const (
	SOCK_CLOEXEC  = unix.O_CLOEXEC
	SOCK_NONBLOCK = unix.O_NONBLOCK
)

socket(2)/socketpair(2)/accept4(2) flags, from linux/net.h.

const (
	SHUT_RD   = 0
	SHUT_WR   = 1
	SHUT_RDWR = 2
)

shutdown(2) how commands, from <linux/net.h>.

const (
	SO_ERROR       = 4
	SO_KEEPALIVE   = 9
	SO_LINGER      = 13
	SO_MARK        = 36
	SO_PASSCRED    = 16
	SO_PEERCRED    = 17
	SO_PEERNAME    = 28
	SO_PROTOCOL    = 38
	SO_RCVBUF      = 8
	SO_RCVTIMEO    = 20
	SO_REUSEADDR   = 2
	SO_SNDBUF      = 7
	SO_SNDTIMEO    = 21
	SO_TIMESTAMP   = 29
	SO_TIMESTAMPNS = 35
	SO_TYPE        = 3
)

Socket options from socket.h.

const (
	SCM_CREDENTIALS = 0x2
	SCM_RIGHTS      = 0x1
)

Control message types, from linux/socket.h.

const (
	ITIMER_REAL    = 0
	ITIMER_VIRTUAL = 1
	ITIMER_PROF    = 2
)

itimer types for getitimer(2) and setitimer(2), from include/uapi/linux/time.h.

const FUTEX_TID_MASK = 0x3fffffff

FUTEX_TID_MASK is the TID portion of a PI futex word.

const SCM_MAX_FD = 253

SCM_MAX_FD is the maximum number of FDs accepted in a single sendmsg call. From net/scm.h.

const SOCK_TYPE_MASK = 0xf

SOCK_TYPE_MASK covers all of the above socket types. The remaining bits are flags. From linux/net.h.

const SOL_SOCKET = 1

SOL_SOCKET is from socket.h

const SizeOfControlMessageRight = 4

SizeOfControlMessageRight is the size of a single element in ControlMessageRights.

const SizeOfTimeval = 16

SizeOfTimeval is the size of a Timeval struct in bytes.

const SockAddrMax = 128

SockAddrMax is the maximum size of a struct sockaddr, from uapi/linux/socket.h.

const (
	TIMER_ABSTIME = 1
)

from gvisor time.go Flags for clock_nanosleep(2).

const UnixPathMax = 108

UnixPathMax is the maximum length of the path in an AF_UNIX socket.

From uapi/linux/un.h.

Variables

var CloneFlagSet = FlagSet{
	&BitFlag{
		Value: syscall.CLONE_VM,
		Name:  "CLONE_VM",
	},
	&BitFlag{
		Value: syscall.CLONE_FS,
		Name:  "CLONE_FS",
	},
	&BitFlag{
		Value: syscall.CLONE_FILES,
		Name:  "CLONE_FILES",
	},
	&BitFlag{
		Value: syscall.CLONE_SIGHAND,
		Name:  "CLONE_SIGHAND",
	},
	&BitFlag{
		Value: syscall.CLONE_PTRACE,
		Name:  "CLONE_PTRACE",
	},
	&BitFlag{
		Value: syscall.CLONE_VFORK,
		Name:  "CLONE_VFORK",
	},
	&BitFlag{
		Value: syscall.CLONE_PARENT,
		Name:  "CLONE_PARENT",
	},
	&BitFlag{
		Value: syscall.CLONE_THREAD,
		Name:  "CLONE_THREAD",
	},
	&BitFlag{
		Value: syscall.CLONE_NEWNS,
		Name:  "CLONE_NEWNS",
	},
	&BitFlag{
		Value: syscall.CLONE_SYSVSEM,
		Name:  "CLONE_SYSVSEM",
	},
	&BitFlag{
		Value: syscall.CLONE_SETTLS,
		Name:  "CLONE_SETTLS",
	},
	&BitFlag{
		Value: syscall.CLONE_PARENT_SETTID,
		Name:  "CLONE_PARENT_SETTID",
	},
	&BitFlag{
		Value: syscall.CLONE_CHILD_CLEARTID,
		Name:  "CLONE_CHILD_CLEARTID",
	},
	&BitFlag{
		Value: syscall.CLONE_DETACHED,
		Name:  "CLONE_DETACHED",
	},
	&BitFlag{
		Value: syscall.CLONE_UNTRACED,
		Name:  "CLONE_UNTRACED",
	},
	&BitFlag{
		Value: syscall.CLONE_CHILD_SETTID,
		Name:  "CLONE_CHILD_SETTID",
	},
	&BitFlag{
		Value: syscall.CLONE_NEWUTS,
		Name:  "CLONE_NEWUTS",
	},
	&BitFlag{
		Value: syscall.CLONE_NEWIPC,
		Name:  "CLONE_NEWIPC",
	},
	&BitFlag{
		Value: syscall.CLONE_NEWUSER,
		Name:  "CLONE_NEWUSER",
	},
	&BitFlag{
		Value: syscall.CLONE_NEWPID,
		Name:  "CLONE_NEWPID",
	},
	&BitFlag{
		Value: syscall.CLONE_NEWNET,
		Name:  "CLONE_NEWNET",
	},
	&BitFlag{
		Value: syscall.CLONE_IO,
		Name:  "CLONE_IO",
	},
}

CloneFlagSet is the set of clone(2) flags.

var ControlMessageType = map[int32]string{
	unix.SCM_RIGHTS:      "SCM_RIGHTS",
	unix.SCM_CREDENTIALS: "SCM_CREDENTIALS",
	unix.SO_TIMESTAMP:    "SO_TIMESTAMP",
}

var FutexCmd = FlagSet{
	&Value{Value: FUTEX_WAIT, Name: "FUTEX_WAIT"},
	&Value{Value: FUTEX_WAKE, Name: "FUTEX_WAKE"},
	&Value{Value: FUTEX_FD, Name: "FUTEX_FD"},
	&Value{Value: FUTEX_REQUEUE, Name: "FUTEX_REQUEUE"},
	&Value{Value: FUTEX_CMP_REQUEUE, Name: "FUTEX_CMP_REQUEUE"},
	&Value{Value: FUTEX_WAKE_OP, Name: "FUTEX_WAKE_OP"},
	&Value{Value: FUTEX_LOCK_PI, Name: "FUTEX_LOCK_PI"},
	&Value{Value: FUTEX_UNLOCK_PI, Name: "FUTEX_UNLOCK_PI"},
	&Value{Value: FUTEX_TRYLOCK_PI, Name: "FUTEX_TRYLOCK_PI"},
	&Value{Value: FUTEX_WAIT_BITSET, Name: "FUTEX_WAIT_BITSET"},
	&Value{Value: FUTEX_WAKE_BITSET, Name: "FUTEX_WAKE_BITSET"},
	&Value{Value: FUTEX_WAIT_REQUEUE_PI, Name: "FUTEX_WAIT_REQUEUE_PI"},
	&Value{Value: FUTEX_CMP_REQUEUE_PI, Name: "FUTEX_CMP_REQUEUE_PI"},
}

FutexCmd are the possible futex(2) commands.

from gvisor futex.go

var ItimerTypes = FlagSet{
	&Value{Value: ITIMER_REAL, Name: "ITIMER_REAL"},
	&Value{Value: ITIMER_VIRTUAL, Name: "ITIMER_VIRTUAL"},
	&Value{Value: ITIMER_PROF, Name: "ITIMER_PROF"},
}

ItimerTypes are the possible itimer types.

var MadviseFlagSet = FlagSet{
	&BitFlag{Value: syscall.MADV_DOFORK, Name: "MADV_DOFORK"},
	&BitFlag{Value: syscall.MADV_DONTFORK, Name: "MADV_DONTFORK"},
	&BitFlag{Value: syscall.MADV_DONTNEED, Name: "MADV_DONTNEED"},
	&BitFlag{Value: syscall.MADV_HUGEPAGE, Name: "MADV_HUGEPAGE"},
	&BitFlag{Value: syscall.MADV_HWPOISON, Name: "MADV_HWPOISON"},
	&BitFlag{Value: syscall.MADV_MERGEABLE, Name: "MADV_MERGEABLE"},
	&BitFlag{Value: syscall.MADV_NOHUGEPAGE, Name: "MADV_NOHUGEPAGE"},
	&Value{Value: syscall.MADV_NORMAL, Name: "MADV_NORMAL"},
	&BitFlag{Value: syscall.MADV_RANDOM, Name: "MADV_RANDOM"},
	&BitFlag{Value: syscall.MADV_REMOVE, Name: "MADV_REMOVE"},
	&BitFlag{Value: syscall.MADV_SEQUENTIAL, Name: "MADV_SEQUENTIAL"},
	&BitFlag{Value: syscall.MADV_UNMERGEABLE, Name: "MADV_UNMERGEABLE"},
	&BitFlag{Value: syscall.MADV_WILLNEED, Name: "MADV_WILLNEED"},
}

MadviseFlagSet are madvise(2) posible flags.

var MmapFlagSet = FlagSet{
	&BitFlag{Value: syscall.MAP_32BIT, Name: "MAP_32BIT"},
	&BitFlag{Value: syscall.MAP_ANON, Name: "MAP_ANON"},
	&BitFlag{Value: syscall.MAP_ANONYMOUS, Name: "MAP_ANONYMOUS"},
	&BitFlag{Value: syscall.MAP_DENYWRITE, Name: "MAP_DENYWRITE"},
	&BitFlag{Value: syscall.MAP_EXECUTABLE, Name: "MAP_EXECUTABLE"},
	&Value{Value: syscall.MAP_FILE, Name: "MAP_FILE"},
	&BitFlag{Value: syscall.MAP_FIXED, Name: "MAP_FIXED"},
	&BitFlag{Value: syscall.MAP_GROWSDOWN, Name: "MAP_GROWSDOWN"},
	&BitFlag{Value: syscall.MAP_HUGETLB, Name: "MAP_HUGETLB"},
	&BitFlag{Value: syscall.MAP_LOCKED, Name: "MAP_LOCKED"},
	&BitFlag{Value: syscall.MAP_NONBLOCK, Name: "MAP_NONBLOCK"},
	&BitFlag{Value: syscall.MAP_NORESERVE, Name: "MAP_NORESERVE"},
	&BitFlag{Value: syscall.MAP_POPULATE, Name: "MAP_POPULATE"},
	&BitFlag{Value: syscall.MAP_PRIVATE, Name: "MAP_PRIVATE"},
	&BitFlag{Value: syscall.MAP_SHARED, Name: "MAP_SHARED"},
	&BitFlag{Value: syscall.MAP_STACK, Name: "MAP_STACK"},
	&BitFlag{Value: syscall.MAP_TYPE, Name: "MAP_TYPE"},
}

MmapFlagSet is the set of mmap(2) flags.

var MmapProt = FlagSet{
	&Value{Value: syscall.PROT_NONE, Name: "PROT_NONE"},
	&BitFlag{Value: syscall.PROT_EXEC, Name: "PROT_EXEC"},
	&BitFlag{Value: syscall.PROT_GROWSDOWN, Name: "PROT_GROWSDOWN"},
	&BitFlag{Value: syscall.PROT_GROWSUP, Name: "PROT_GROWSUP"},
	&BitFlag{Value: syscall.PROT_READ, Name: "PROT_READ"},
	&BitFlag{Value: syscall.PROT_WRITE, Name: "PROT_WRITE"},
}

MmapProt are mmap(2) memory protection modes.

var OpenFlagSet = FlagSet{
	&BitFlag{
		Value: syscall.O_APPEND,
		Name:  "O_APPEND",
	},
	&BitFlag{
		Value: syscall.O_ASYNC,
		Name:  "O_ASYNC",
	},
	&BitFlag{
		Value: syscall.O_CLOEXEC,
		Name:  "O_CLOEXEC",
	},
	&BitFlag{
		Value: syscall.O_CREAT,
		Name:  "O_CREAT",
	},
	&BitFlag{
		Value: syscall.O_DIRECT,
		Name:  "O_DIRECT",
	},
	&BitFlag{
		Value: syscall.O_DIRECTORY,
		Name:  "O_DIRECTORY",
	},
	&BitFlag{
		Value: syscall.O_EXCL,
		Name:  "O_EXCL",
	},
	&BitFlag{
		Value: syscall.O_NOATIME,
		Name:  "O_NOATIME",
	},
	&BitFlag{
		Value: syscall.O_NOCTTY,
		Name:  "O_NOCTTY",
	},
	&BitFlag{
		Value: syscall.O_NOFOLLOW,
		Name:  "O_NOFOLLOW",
	},
	&BitFlag{
		Value: syscall.O_NONBLOCK,
		Name:  "O_NONBLOCK",
	},
	&BitFlag{
		Value: 0x200000,
		Name:  "O_PATH",
	},
	&BitFlag{
		Value: syscall.O_SYNC,
		Name:  "O_SYNC",
	},
	&BitFlag{
		Value: syscall.O_TRUNC,
		Name:  "O_TRUNC",
	},
}

OpenFlagSet is the set of open(2) flags.

var OpenMode = FlagSet{
	&Value{
		Value: syscall.O_RDWR,
		Name:  "O_RDWR",
	},
	&Value{
		Value: syscall.O_WRONLY,
		Name:  "O_WRONLY",
	},
	&Value{
		Value: syscall.O_RDONLY,
		Name:  "O_RDONLY",
	},
}

OpenMode represents the mode to open(2) a file.

var PtraceRequestSet = FlagSet{
	&Value{
		Value: PTRACE_TRACEME,
		Name:  "PTRACE_TRACEME",
	},
	&Value{
		Value: PTRACE_PEEKTEXT,
		Name:  "PTRACE_PEEKTEXT",
	},
	&Value{
		Value: PTRACE_PEEKDATA,
		Name:  "PTRACE_PEEKDATA",
	},
	&Value{
		Value: PTRACE_PEEKUSR,
		Name:  "PTRACE_PEEKUSR",
	},
	&Value{
		Value: PTRACE_POKETEXT,
		Name:  "PTRACE_POKETEXT",
	},
	&Value{
		Value: PTRACE_POKEDATA,
		Name:  "PTRACE_POKEDATA",
	},
	&Value{
		Value: PTRACE_POKEUSR,
		Name:  "PTRACE_POKEUSR",
	},
	&Value{
		Value: PTRACE_CONT,
		Name:  "PTRACE_CONT",
	},
	&Value{
		Value: PTRACE_KILL,
		Name:  "PTRACE_KILL",
	},
	&Value{
		Value: PTRACE_SINGLESTEP,
		Name:  "PTRACE_SINGLESTEP",
	},
	&Value{
		Value: PTRACE_ATTACH,
		Name:  "PTRACE_ATTACH",
	},
	&Value{
		Value: PTRACE_DETACH,
		Name:  "PTRACE_DETACH",
	},
	&Value{
		Value: PTRACE_SYSCALL,
		Name:  "PTRACE_SYSCALL",
	},
	&Value{
		Value: PTRACE_SETOPTIONS,
		Name:  "PTRACE_SETOPTIONS",
	},
	&Value{
		Value: PTRACE_GETEVENTMSG,
		Name:  "PTRACE_GETEVENTMSG",
	},
	&Value{
		Value: PTRACE_GETSIGINFO,
		Name:  "PTRACE_GETSIGINFO",
	},
	&Value{
		Value: PTRACE_SETSIGINFO,
		Name:  "PTRACE_SETSIGINFO",
	},
	&Value{
		Value: PTRACE_GETREGSET,
		Name:  "PTRACE_GETREGSET",
	},
	&Value{
		Value: PTRACE_SETREGSET,
		Name:  "PTRACE_SETREGSET",
	},
	&Value{
		Value: PTRACE_SEIZE,
		Name:  "PTRACE_SEIZE",
	},
	&Value{
		Value: PTRACE_INTERRUPT,
		Name:  "PTRACE_INTERRUPT",
	},
	&Value{
		Value: PTRACE_LISTEN,
		Name:  "PTRACE_LISTEN",
	},
	&Value{
		Value: PTRACE_PEEKSIGINFO,
		Name:  "PTRACE_PEEKSIGINFO",
	},
	&Value{
		Value: PTRACE_GETSIGMASK,
		Name:  "PTRACE_GETSIGMASK",
	},
	&Value{
		Value: PTRACE_SETSIGMASK,
		Name:  "PTRACE_SETSIGMASK",
	},
	&Value{
		Value: PTRACE_GETREGS,
		Name:  "PTRACE_GETREGS",
	},
	&Value{
		Value: PTRACE_SETREGS,
		Name:  "PTRACE_SETREGS",
	},
	&Value{
		Value: PTRACE_GETFPREGS,
		Name:  "PTRACE_GETFPREGS",
	},
	&Value{
		Value: PTRACE_SETFPREGS,
		Name:  "PTRACE_SETFPREGS",
	},
	&Value{
		Value: PTRACE_GETFPXREGS,
		Name:  "PTRACE_GETFPXREGS",
	},
	&Value{
		Value: PTRACE_SETFPXREGS,
		Name:  "PTRACE_SETFPXREGS",
	},
	&Value{
		Value: PTRACE_OLDSETOPTIONS,
		Name:  "PTRACE_OLDSETOPTIONS",
	},
	&Value{
		Value: PTRACE_GET_THREAD_AREA,
		Name:  "PTRACE_GET_THREAD_AREA",
	},
	&Value{
		Value: PTRACE_SET_THREAD_AREA,
		Name:  "PTRACE_SET_THREAD_AREA",
	},
	&Value{
		Value: PTRACE_ARCH_PRCTL,
		Name:  "PTRACE_ARCH_PRCTL",
	},
	&Value{
		Value: PTRACE_SYSEMU,
		Name:  "PTRACE_SYSEMU",
	},
	&Value{
		Value: PTRACE_SYSEMU_SINGLESTEP,
		Name:  "PTRACE_SYSEMU_SINGLESTEP",
	},
	&Value{
		Value: PTRACE_SINGLEBLOCK,
		Name:  "PTRACE_SINGLEBLOCK",
	},
}

PtraceRequestSet are the possible ptrace(2) requests.

var SizeOfControlMessageCredentials = int(binary.Size(ControlMessageCredentials{}))

SizeOfControlMessageCredentials is the binary size of a ControlMessageCredentials struct.

var SizeOfControlMessageHeader = int(binary.Size(ControlMessageHeader{}))

SizeOfControlMessageHeader is the binary size of a ControlMessageHeader struct.

var SizeOfTCPInfo = binary.Size(TCPInfo{})

SizeOfTCPInfo is the binary size of a TCPInfo struct (104 bytes).

var SocketFamily = FlagSet{
	&Value{Value: unix.AF_UNSPEC, Name: "AF_UNSPEC"},
	&Value{Value: unix.AF_UNIX, Name: "AF_UNIX"},
	&Value{Value: unix.AF_INET, Name: "AF_INET"},
	&Value{Value: unix.AF_AX25, Name: "AF_AX25"},
	&Value{Value: unix.AF_IPX, Name: "AF_IPX"},
	&Value{Value: unix.AF_APPLETALK, Name: "AF_APPLETALK"},
	&Value{Value: unix.AF_NETROM, Name: "AF_NETROM"},
	&Value{Value: unix.AF_BRIDGE, Name: "AF_BRIDGE"},
	&Value{Value: unix.AF_ATMPVC, Name: "AF_ATMPVC"},
	&Value{Value: unix.AF_X25, Name: "AF_X25"},
	&Value{Value: unix.AF_INET6, Name: "AF_INET6"},
	&Value{Value: unix.AF_ROSE, Name: "AF_ROSE"},
	&Value{Value: unix.AF_DECnet, Name: "AF_DECnet"},
	&Value{Value: unix.AF_NETBEUI, Name: "AF_NETBEUI"},
	&Value{Value: unix.AF_SECURITY, Name: "AF_SECURITY"},
	&Value{Value: unix.AF_KEY, Name: "AF_KEY"},
	&Value{Value: unix.AF_NETLINK, Name: "AF_NETLINK"},
	&Value{Value: unix.AF_PACKET, Name: "AF_PACKET"},
	&Value{Value: unix.AF_ASH, Name: "AF_ASH"},
	&Value{Value: unix.AF_ECONET, Name: "AF_ECONET"},
	&Value{Value: unix.AF_ATMSVC, Name: "AF_ATMSVC"},
	&Value{Value: unix.AF_RDS, Name: "AF_RDS"},
	&Value{Value: unix.AF_SNA, Name: "AF_SNA"},
	&Value{Value: unix.AF_IRDA, Name: "AF_IRDA"},
	&Value{Value: unix.AF_PPPOX, Name: "AF_PPPOX"},
	&Value{Value: unix.AF_WANPIPE, Name: "AF_WANPIPE"},
	&Value{Value: unix.AF_LLC, Name: "AF_LLC"},
	&Value{Value: unix.AF_IB, Name: "AF_IB"},
	&Value{Value: unix.AF_MPLS, Name: "AF_MPLS"},
	&Value{Value: unix.AF_CAN, Name: "AF_CAN"},
	&Value{Value: unix.AF_TIPC, Name: "AF_TIPC"},
	&Value{Value: unix.AF_BLUETOOTH, Name: "AF_BLUETOOTH"},
	&Value{Value: unix.AF_IUCV, Name: "AF_IUCV"},
	&Value{Value: unix.AF_RXRPC, Name: "AF_RXRPC"},
	&Value{Value: unix.AF_ISDN, Name: "AF_ISDN"},
	&Value{Value: unix.AF_PHONET, Name: "AF_PHONET"},
	&Value{Value: unix.AF_IEEE802154, Name: "AF_IEEE802154"},
	&Value{Value: unix.AF_CAIF, Name: "AF_CAIF"},
	&Value{Value: unix.AF_ALG, Name: "AF_ALG"},
	&Value{Value: unix.AF_NFC, Name: "AF_NFC"},
	&Value{Value: unix.AF_VSOCK, Name: "AF_VSOCK"},
}

SocketFamily are the possible socket(2) families.

var SocketFlagSet = FlagSet{
	&BitFlag{Value: unix.SOCK_CLOEXEC, Name: "SOCK_CLOEXEC"},
	&BitFlag{Value: unix.SOCK_NONBLOCK, Name: "SOCK_NONBLOCK"},
}

SocketFlagSet are the possible socket(2) flags.

var SocketProtocol = map[int32]FlagSet{
	unix.AF_INET:  ipProtocol,
	unix.AF_INET6: ipProtocol,
	unix.AF_NETLINK: {
		&Value{Value: unix.NETLINK_ROUTE, Name: "NETLINK_ROUTE"},
		&Value{Value: unix.NETLINK_UNUSED, Name: "NETLINK_UNUSED"},
		&Value{Value: unix.NETLINK_USERSOCK, Name: "NETLINK_USERSOCK"},
		&Value{Value: unix.NETLINK_FIREWALL, Name: "NETLINK_FIREWALL"},
		&Value{Value: unix.NETLINK_SOCK_DIAG, Name: "NETLINK_SOCK_DIAG"},
		&Value{Value: unix.NETLINK_NFLOG, Name: "NETLINK_NFLOG"},
		&Value{Value: unix.NETLINK_XFRM, Name: "NETLINK_XFRM"},
		&Value{Value: unix.NETLINK_SELINUX, Name: "NETLINK_SELINUX"},
		&Value{Value: unix.NETLINK_ISCSI, Name: "NETLINK_ISCSI"},
		&Value{Value: unix.NETLINK_AUDIT, Name: "NETLINK_AUDIT"},
		&Value{Value: unix.NETLINK_FIB_LOOKUP, Name: "NETLINK_FIB_LOOKUP"},
		&Value{Value: unix.NETLINK_CONNECTOR, Name: "NETLINK_CONNECTOR"},
		&Value{Value: unix.NETLINK_NETFILTER, Name: "NETLINK_NETFILTER"},
		&Value{Value: unix.NETLINK_IP6_FW, Name: "NETLINK_IP6_FW"},
		&Value{Value: unix.NETLINK_DNRTMSG, Name: "NETLINK_DNRTMSG"},
		&Value{Value: unix.NETLINK_KOBJECT_UEVENT, Name: "NETLINK_KOBJECT_UEVENT"},
		&Value{Value: unix.NETLINK_GENERIC, Name: "NETLINK_GENERIC"},
		&Value{Value: unix.NETLINK_SCSITRANSPORT, Name: "NETLINK_SCSITRANSPORT"},
		&Value{Value: unix.NETLINK_ECRYPTFS, Name: "NETLINK_ECRYPTFS"},
		&Value{Value: unix.NETLINK_RDMA, Name: "NETLINK_RDMA"},
		&Value{Value: unix.NETLINK_CRYPTO, Name: "NETLINK_CRYPTO"},
	},
}

SocketProtocol are the possible socket(2) protocols for each protocol family.

var SocketType = FlagSet{
	&Value{Value: unix.SOCK_STREAM, Name: "SOCK_STREAM"},
	&Value{Value: unix.SOCK_DGRAM, Name: "SOCK_DGRAM"},
	&Value{Value: unix.SOCK_RAW, Name: "SOCK_RAW"},
	&Value{Value: unix.SOCK_RDM, Name: "SOCK_RDM"},
	&Value{Value: unix.SOCK_SEQPACKET, Name: "SOCK_SEQPACKET"},
	&Value{Value: unix.SOCK_DCCP, Name: "SOCK_DCCP"},
	&Value{Value: unix.SOCK_PACKET, Name: "SOCK_PACKET"},
}

SocketType are the possible socket(2) types.

Types

type BitFlag

type BitFlag struct {
	Name  string
	Value uint64
}

A BitFlag is one or more bits and a name. The name is printed if all bits are matched (i.e. enabled) in a value. Typically, the Value is only one bit.

func (*BitFlag) Mask

func (f *BitFlag) Mask() uint64

Mask returns a mask for the BitFlag, namely, the value.

func (*BitFlag) Match

func (f *BitFlag) Match(val uint64) bool

Match returns true if the val and the BitFlag Value are the same, i.e. the flag is set.

func (*BitFlag) String

func (f *BitFlag) String(_ uint64) string

String returns the string value of the BitFlag. The parameter is ignored.

type ClockT

type ClockT int64

ClockT represents type clock_t.

type ControlMessageCredentials

type ControlMessageCredentials struct {
	PID int32
	UID uint32
	GID uint32
}

A ControlMessageCredentials is an SCM_CREDENTIALS socket control message.

ControlMessageCredentials represents struct ucred from linux/socket.h.

type ControlMessageHeader

type ControlMessageHeader struct {
	Length uint64
	Level  int32
	Type   int32
}

A ControlMessageHeader is the header for a socket control message.

ControlMessageHeader represents struct cmsghdr from linux/socket.h.

type ControlMessageRights

type ControlMessageRights []int32

A ControlMessageRights is an SCM_RIGHTS socket control message.

type Field

type Field struct {
	Name    string
	BitMask uint64
	Shift   uint64
}

Field is used to extract named fields, e.g. the Tries field in the ChromeOS GPT. The value is masked and shifted right. We may at some point want a format string.

func (*Field) Mask

func (f *Field) Mask() uint64

Mask returns the bits covered by the Field.

func (*Field) Match

func (f *Field) Match(val uint64) bool

Match always matches in a Field, regardless of value.

func (*Field) String

func (f *Field) String(val uint64) string

String returns the part or the val covered by this Field. The bits are extracted, shifted, and printed as hex.

type Flag

type Flag interface {
	Match(uint64) bool
	Mask() uint64
	String(uint64) string
}

The Flag interface has three functions: Match, to see if a given value is covered by the Flag. Mask, to return which bits in the flag are covered. String, to print a string determined by the flag and possibly the value.

type FlagSet

type FlagSet []Flag

A FlagSet is a slice of Flags

func (FlagSet) Parse

func (s FlagSet) Parse(val uint64) Flags

Parse returns a pretty version of a FlagSet, using the flag names for known flags. Unknown flags are printed as numeric if the Flagset did not cover all the bits in the argument.

type Flags

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

func Futex

func Futex(op uint64) Flags

func Open

func Open(val uint64) Flags

func SockFlags

func SockFlags(flags int32) Flags

func SockProtocol

func SockProtocol(family, protocol int32) Flags

func SockType

func SockType(stype int32) Flags

func (*Flags) Add

func (f *Flags) Add(flag ...string)

func (*Flags) AddFlags

func (f *Flags) AddFlags(flags Flags)

func (Flags) MarshalJSON

func (f Flags) MarshalJSON() ([]byte, error)

type MessageHeader64

type MessageHeader64 struct {
	// Name is the optional pointer to a network address buffer.
	Name uint64

	// NameLen is the length of the buffer pointed to by Name.
	NameLen uint32

	// Iov is a pointer to an array of io vectors that describe the memory
	// locations involved in the io operation.
	Iov uint64

	// IovLen is the length of the array pointed to by Iov.
	IovLen uint64

	// Control is the optional pointer to ancillary control data.
	Control uint64

	// ControlLen is the length of the data pointed to by Control.
	ControlLen uint64

	// Flags on the sent/received message.
	Flags int32
	// contains filtered or unexported fields
}

MessageHeader64 is the 64-bit representation of the msghdr struct used in the recvmsg and sendmsg syscalls.

type OS

type OS int

OS describes the target operating system for an ABI.

Note that OS is architecture-independent. The details of the OS ABI will vary between architectures.

const (
	// Linux is the Linux ABI.
	Linux OS = iota
)

func (OS) String

func (o OS) String() string

String implements fmt.Stringer.

type SockAddrInet

type SockAddrInet struct {
	Family uint16
	Port   uint16
	Addr   [4]byte
	Zero   [8]uint8 // pad to sizeof(struct sockaddr).
}

SockAddrInt is struct sockaddr_in, from uapi/linux/in.h.

type SockAddrInet6

type SockAddrInet6 struct {
	Family   uint16
	Port     uint16
	Flowinfo uint32
	Addr     [16]byte
	Scope_id uint32
}

SockAddrInt6 is struct sockaddr_in6, from uapi/linux/in6.h.

type SockAddrUnix

type SockAddrUnix struct {
	Family uint16
	Path   [UnixPathMax]int8
}

SockAddrUnix is struct sockaddr_un, from uapi/linux/un.h.

type TCPInfo

type TCPInfo struct {
	State       uint8
	CaState     uint8
	Retransmits uint8
	Probes      uint8
	Backoff     uint8
	Options     uint8
	// WindowScale is the combination of snd_wscale (first 4 bits) and rcv_wscale (second 4 bits)
	WindowScale uint8
	// DeliveryRateAppLimited is a boolean and only the first bit is meaningful.
	DeliveryRateAppLimited uint8

	RTO    uint32
	ATO    uint32
	SndMss uint32
	RcvMss uint32

	Unacked uint32
	Sacked  uint32
	Lost    uint32
	Retrans uint32
	Fackets uint32

	// Times.
	LastDataSent uint32
	LastAckSent  uint32
	LastDataRecv uint32
	LastAckRecv  uint32

	// Metrics.
	PMTU        uint32
	RcvSsthresh uint32
	RTT         uint32
	RTTVar      uint32
	SndSsthresh uint32
	SndCwnd     uint32
	Advmss      uint32
	Reordering  uint32

	RcvRTT   uint32
	RcvSpace uint32

	TotalRetrans uint32

	PacingRate    uint64
	MaxPacingRate uint64
	// BytesAcked is RFC4898 tcpEStatsAppHCThruOctetsAcked.
	BytesAcked uint64
	// BytesReceived is RFC4898 tcpEStatsAppHCThruOctetsReceived.
	BytesReceived uint64
	// SegsOut is RFC4898 tcpEStatsPerfSegsOut.
	SegsOut uint32
	// SegsIn is RFC4898 tcpEStatsPerfSegsIn.
	SegsIn uint32

	NotSentBytes uint32
	MinRTT       uint32
	// DataSegsIn is RFC4898 tcpEStatsDataSegsIn.
	DataSegsIn uint32
	// DataSegsOut is RFC4898 tcpEStatsDataSegsOut.
	DataSegsOut uint32

	DeliveryRate uint64

	// BusyTime is the time in microseconds busy sending data.
	BusyTime uint64
	// RwndLimited is the time in microseconds limited by receive window.
	RwndLimited uint64
	// SndBufLimited is the time in microseconds limited by send buffer.
	SndBufLimited uint64
}

TCPInfo is a collection of TCP statistics.

From uapi/linux/tcp.h.

type TimeT

type TimeT int64

TimeT represents time_t in <time.h>. It represents time in seconds.

type TimerID

type TimerID int32

TimerID represents type timer_t, which identifies a POSIX per-process interval timer.

type Tms

type Tms struct {
	UTime  ClockT
	STime  ClockT
	CUTime ClockT
	CSTime ClockT
}

Tms represents struct tms, used by times(2).

type Value

type Value struct {
	Name  string
	Value uint64
}

Value is the simplest implementation for Flags. If an entire uint64 matches the Value, then Match will be true. Note that Value could be implemented by a Field with a Mask of MaxUint64, but Value is more convenient to use.

func (*Value) Mask

func (e *Value) Mask() uint64

Mask returns the bits covered by a Value, in this case MaxUint64.

func (*Value) Match

func (e *Value) Match(val uint64) bool

Match determines if a Value matches the argument, meaning the Value and the arg are the same.

func (*Value) String

func (e *Value) String(_ uint64) string

String returns the name of the value associated with `val`.