Directories ¶
Path | Synopsis |
---|---|
Package abi describes the interface between a kernel and userspace.
|
Package abi describes the interface between a kernel and userspace. |
linux
Package linux contains the constants and types needed to inferface with a Linux kernel.
|
Package linux contains the constants and types needed to inferface with a Linux kernel. |
Package amutex provides the implementation of an abortable mutex.
|
Package amutex provides the implementation of an abortable mutex. |
Package atomicbitops provides basic bitwise operations in an atomic way.
|
Package atomicbitops provides basic bitwise operations in an atomic way. |
Package binary translates between select fixed-sized types and a binary representation.
|
Package binary translates between select fixed-sized types and a binary representation. |
Package bits includes all bit related types and operations.
|
Package bits includes all bit related types and operations. |
Package bpf provides tools for working with Berkeley Packet Filter (BPF) programs.
|
Package bpf provides tools for working with Berkeley Packet Filter (BPF) programs. |
Package compressio provides parallel compression and decompression.
|
Package compressio provides parallel compression and decompression. |
control
|
|
client
Package client provides a basic control client interface.
|
Package client provides a basic control client interface. |
server
Package server provides a basic control server interface.
|
Package server provides a basic control server interface. |
Package cpuid provides basic functionality for creating and adjusting CPU feature sets.
|
Package cpuid provides basic functionality for creating and adjusting CPU feature sets. |
Package dhcp implements a DHCP client and server as described in RFC 2131.
|
Package dhcp implements a DHCP client and server as described in RFC 2131. |
Package eventchannel contains functionality for sending any protobuf message on a socketpair.
|
Package eventchannel contains functionality for sending any protobuf message on a socketpair. |
Package fd provides types for working with file descriptors.
|
Package fd provides types for working with file descriptors. |
Package gate provides a usage Gate synchronization primitive.
|
Package gate provides a usage Gate synchronization primitive. |
Package hashio provides hash-verified I/O streams.
|
Package hashio provides hash-verified I/O streams. |
Package ilist provides the implementation of intrusive linked lists.
|
Package ilist provides the implementation of intrusive linked lists. |
Package linewriter provides an io.Writer which calls an emitter on each line.
|
Package linewriter provides an io.Writer which calls an emitter on each line. |
Package log implements a library for logging.
|
Package log implements a library for logging. |
Package metric provides primitives for collecting metrics.
|
Package metric provides primitives for collecting metrics. |
Package p9 is a 9P2000.L implementation.
|
Package p9 is a 9P2000.L implementation. |
local_server
Binary local_server provides a local 9P2000.L server for the p9 package.
|
Binary local_server provides a local 9P2000.L server for the p9 package. |
Package refs defines an interface for reference counted objects.
|
Package refs defines an interface for reference counted objects. |
Package secio provides support for sectioned I/O.
|
Package secio provides support for sectioned I/O. |
Package segment provides tools for working with collections of segments.
|
Package segment provides tools for working with collections of segments. |
sentry
|
|
arch
Package arch provides abstractions around architecture-dependent details, such as syscall calling conventions, native types, etc.
|
Package arch provides abstractions around architecture-dependent details, such as syscall calling conventions, native types, etc. |
context
Package context defines the sentry's Context type.
|
Package context defines the sentry's Context type. |
context/contexttest
Package contexttest builds a test context.Context.
|
Package contexttest builds a test context.Context. |
control
Package control contains types that expose control server methods, and can be used to configure and interact with a running sandbox process.
|
Package control contains types that expose control server methods, and can be used to configure and interact with a running sandbox process. |
device
Package device defines reserved virtual kernel devices and structures for managing them.
|
Package device defines reserved virtual kernel devices and structures for managing them. |
fs
Package fs implements a virtual filesystem layer.
|
Package fs implements a virtual filesystem layer. |
fs/anon
Package anon implements an anonymous inode, useful for implementing inodes for pseudo filesystems.
|
Package anon implements an anonymous inode, useful for implementing inodes for pseudo filesystems. |
fs/ashmem
Package ashmem implements Android ashmem module (Anonymus Shared Memory).
|
Package ashmem implements Android ashmem module (Anonymus Shared Memory). |
fs/binder
Package binder implements Android Binder IPC module.
|
Package binder implements Android Binder IPC module. |
fs/dev
Package dev provides a filesystem with simple devices.
|
Package dev provides a filesystem with simple devices. |
fs/fdpipe
Package fdpipe implements common namedpipe opening and accessing logic.
|
Package fdpipe implements common namedpipe opening and accessing logic. |
fs/filetest
Package filetest provides a test implementation of an fs.File.
|
Package filetest provides a test implementation of an fs.File. |
fs/fsutil
Package fsutil provides utilities for implementing fs.InodeOperations and fs.FileOperations:
|
Package fsutil provides utilities for implementing fs.InodeOperations and fs.FileOperations: |
fs/gofer
Package gofer implements a remote 9p filesystem.
|
Package gofer implements a remote 9p filesystem. |
fs/host
Package host implements an fs.Filesystem for files backed by host file descriptors.
|
Package host implements an fs.Filesystem for files backed by host file descriptors. |
fs/lock
Package lock is the API for POSIX-style advisory regional file locks and BSD-style full file locks.
|
Package lock is the API for POSIX-style advisory regional file locks and BSD-style full file locks. |
fs/proc
Package proc implements a partial in-memory file system for profs.
|
Package proc implements a partial in-memory file system for profs. |
fs/proc/device
Package device contains the proc device to avoid dependency loops.
|
Package device contains the proc device to avoid dependency loops. |
fs/ramfs
Package ramfs implements an in-memory file system that can be associated with any device.
|
Package ramfs implements an in-memory file system that can be associated with any device. |
fs/ramfs/test
Package test provides a simple ramfs-based filesystem for use in testing.
|
Package test provides a simple ramfs-based filesystem for use in testing. |
fs/sys
Package sys implements a sysfs filesystem.
|
Package sys implements a sysfs filesystem. |
fs/timerfd
Package timerfd implements the semantics of Linux timerfd objects as described by timerfd_create(2).
|
Package timerfd implements the semantics of Linux timerfd objects as described by timerfd_create(2). |
fs/tmpfs
Package tmpfs is a filesystem implementation backed by memory.
|
Package tmpfs is a filesystem implementation backed by memory. |
fs/tty
Package tty provide pseudoterminals via a devpts filesystem.
|
Package tty provide pseudoterminals via a devpts filesystem. |
hostcpu
Package hostcpu provides utilities for working with CPU information provided by a host Linux kernel.
|
Package hostcpu provides utilities for working with CPU information provided by a host Linux kernel. |
inet
Package inet defines semantics for IP stacks.
|
Package inet defines semantics for IP stacks. |
kernel
Package kernel provides an emulation of the Linux kernel.
|
Package kernel provides an emulation of the Linux kernel. |
kernel/auth
Package auth implements an access control model that is a subset of Linux's.
|
Package auth implements an access control model that is a subset of Linux's. |
kernel/epoll
Package epoll provides an implementation of Linux's IO event notification facility.
|
Package epoll provides an implementation of Linux's IO event notification facility. |
kernel/eventfd
Package eventfd provides an implementation of Linux's file-based event notification.
|
Package eventfd provides an implementation of Linux's file-based event notification. |
kernel/futex
Package futex provides an implementation of the futex interface as found in the Linux kernel.
|
Package futex provides an implementation of the futex interface as found in the Linux kernel. |
kernel/kdefs
Package kdefs defines common kernel definitions.
|
Package kdefs defines common kernel definitions. |
kernel/memevent
Package memevent implements the memory usage events controller, which periodically emits events via the eventchannel.
|
Package memevent implements the memory usage events controller, which periodically emits events via the eventchannel. |
kernel/pipe
Package pipe provides an in-memory implementation of a unidirectional pipe.
|
Package pipe provides an in-memory implementation of a unidirectional pipe. |
kernel/sched
Package sched implements scheduler related features.
|
Package sched implements scheduler related features. |
kernel/semaphore
Package semaphore implements System V semaphores.
|
Package semaphore implements System V semaphores. |
kernel/time
Package time defines the Timer type, which provides a periodic timer that works by sampling a user-provided clock.
|
Package time defines the Timer type, which provides a periodic timer that works by sampling a user-provided clock. |
limits
Package limits provides resource limits.
|
Package limits provides resource limits. |
loader
Package loader loads a binary into a MemoryManager.
|
Package loader loads a binary into a MemoryManager. |
memmap
Package memmap defines semantics for memory mappings.
|
Package memmap defines semantics for memory mappings. |
memutil
Package memutil contains the utility functions for memory operations.
|
Package memutil contains the utility functions for memory operations. |
mm
Package mm provides a memory management subsystem.
|
Package mm provides a memory management subsystem. |
platform
Package platform provides a Platform abstraction.
|
Package platform provides a Platform abstraction. |
platform/filemem
Package filemem provides a reusable implementation of platform.Memory.
|
Package filemem provides a reusable implementation of platform.Memory. |
platform/interrupt
Package interrupt provides an interrupt helper.
|
Package interrupt provides an interrupt helper. |
platform/kvm
Package kvm provides a kvm-based implementation of the platform interface.
|
Package kvm provides a kvm-based implementation of the platform interface. |
platform/kvm/testutil
Package testutil provides common assembly stubs for testing.
|
Package testutil provides common assembly stubs for testing. |
platform/procid
Package procid provides a way to get the current system thread identifier.
|
Package procid provides a way to get the current system thread identifier. |
platform/ptrace
Package ptrace provides a ptrace-based implementation of the platform interface.
|
Package ptrace provides a ptrace-based implementation of the platform interface. |
platform/ring0
Package ring0 provides basic operating system-level stubs.
|
Package ring0 provides basic operating system-level stubs. |
platform/ring0/gen_offsets
Binary gen_offsets is a helper for generating offset headers.
|
Binary gen_offsets is a helper for generating offset headers. |
platform/ring0/pagetables
Package pagetables provides a generic implementation of pagetables.
|
Package pagetables provides a generic implementation of pagetables. |
platform/safecopy
Package safecopy provides an efficient implementation of functions to access memory that may result in SIGSEGV or SIGBUS being sent to the accessor.
|
Package safecopy provides an efficient implementation of functions to access memory that may result in SIGSEGV or SIGBUS being sent to the accessor. |
safemem
Package safemem provides the Block and BlockSeq types.
|
Package safemem provides the Block and BlockSeq types. |
sighandling
Package sighandling contains helpers for handling signals to applications.
|
Package sighandling contains helpers for handling signals to applications. |
socket
Package socket provides the interfaces that need to be provided by socket implementations and providers, as well as per family demultiplexing of socket creation.
|
Package socket provides the interfaces that need to be provided by socket implementations and providers, as well as per family demultiplexing of socket creation. |
socket/control
Package control provides internal representations of socket control messages.
|
Package control provides internal representations of socket control messages. |
socket/epsocket
Package epsocket provides an implementation of the socket.Socket interface that is backed by a tcpip.Endpoint.
|
Package epsocket provides an implementation of the socket.Socket interface that is backed by a tcpip.Endpoint. |
socket/hostinet
Package hostinet implements AF_INET and AF_INET6 sockets using the host's network stack.
|
Package hostinet implements AF_INET and AF_INET6 sockets using the host's network stack. |
socket/netlink
Package netlink provides core functionality for netlink sockets.
|
Package netlink provides core functionality for netlink sockets. |
socket/netlink/port
Package port provides port ID allocation for netlink sockets.
|
Package port provides port ID allocation for netlink sockets. |
socket/netlink/route
Package route provides a NETLINK_ROUTE socket protocol.
|
Package route provides a NETLINK_ROUTE socket protocol. |
socket/rpcinet
Package rpcinet implements sockets using an RPC for each syscall.
|
Package rpcinet implements sockets using an RPC for each syscall. |
socket/rpcinet/conn
Package conn is an RPC connection to a syscall RPC server.
|
Package conn is an RPC connection to a syscall RPC server. |
socket/rpcinet/notifier
Package notifier implements an FD notifier implementation over RPC.
|
Package notifier implements an FD notifier implementation over RPC. |
socket/unix
Package unix provides an implementation of the socket.Socket interface for the AF_UNIX protocol family.
|
Package unix provides an implementation of the socket.Socket interface for the AF_UNIX protocol family. |
state
Package state provides high-level state wrappers.
|
Package state provides high-level state wrappers. |
strace
Package strace implements the logic to print out the input and the return value of each traced syscall.
|
Package strace implements the logic to print out the input and the return value of each traced syscall. |
syscalls
Package syscalls is the interface from the application to the kernel.
|
Package syscalls is the interface from the application to the kernel. |
syscalls/linux
Package linux provides syscall tables for amd64 Linux.
|
Package linux provides syscall tables for amd64 Linux. |
time
Package time provides a calibrated clock synchronized to a system reference clock.
|
Package time provides a calibrated clock synchronized to a system reference clock. |
uniqueid
Package uniqueid defines context.Context keys for obtaining system-wide unique identifiers.
|
Package uniqueid defines context.Context keys for obtaining system-wide unique identifiers. |
usage
Package usage provides representations of resource usage.
|
Package usage provides representations of resource usage. |
usermem
Package usermem governs access to user memory.
|
Package usermem governs access to user memory. |
watchdog
Package watchdog is responsible for monitoring the sentry for tasks that may potentially be stuck or looping inderterminally causing hard to debug hungs in the untrusted app.
|
Package watchdog is responsible for monitoring the sentry for tasks that may potentially be stuck or looping inderterminally causing hard to debug hungs in the untrusted app. |
Package sleep allows goroutines to efficiently sleep on multiple sources of notifications (wakers).
|
Package sleep allows goroutines to efficiently sleep on multiple sources of notifications (wakers). |
Package state provides functionality related to saving and loading object graphs.
|
Package state provides functionality related to saving and loading object graphs. |
statefile
Package statefile defines the state file data stream.
|
Package statefile defines the state file data stream. |
Package syserr contains sandbox-internal errors.
|
Package syserr contains sandbox-internal errors. |
Package syserror contains syscall error codes exported as error interface instead of Errno.
|
Package syserror contains syscall error codes exported as error interface instead of Errno. |
Package tcpip provides the interfaces and related types that users of the tcpip stack will use in order to create endpoints used to send and receive data over the network stack.
|
Package tcpip provides the interfaces and related types that users of the tcpip stack will use in order to create endpoints used to send and receive data over the network stack. |
adapters/gonet
Package gonet provides a Go net package compatible wrapper for a tcpip stack.
|
Package gonet provides a Go net package compatible wrapper for a tcpip stack. |
buffer
Package buffer provides the implementation of a buffer view.
|
Package buffer provides the implementation of a buffer view. |
checker
Package checker provides helper functions to check networking packets for validity.
|
Package checker provides helper functions to check networking packets for validity. |
header
Package header provides the implementation of the encoding and decoding of network protocol headers.
|
Package header provides the implementation of the encoding and decoding of network protocol headers. |
link/channel
Package channel provides the implemention of channel-based data-link layer endpoints.
|
Package channel provides the implemention of channel-based data-link layer endpoints. |
link/fdbased
Package fdbased provides the implemention of data-link layer endpoints backed by boundary-preserving file descriptors (e.g., TUN devices, seqpacket/datagram sockets).
|
Package fdbased provides the implemention of data-link layer endpoints backed by boundary-preserving file descriptors (e.g., TUN devices, seqpacket/datagram sockets). |
link/loopback
Package loopback provides the implemention of loopback data-link layer endpoints.
|
Package loopback provides the implemention of loopback data-link layer endpoints. |
link/rawfile
Package rawfile contains utilities for using the netstack with raw host files on Linux hosts.
|
Package rawfile contains utilities for using the netstack with raw host files on Linux hosts. |
link/sharedmem
Package sharedmem provides the implemention of data-link layer endpoints backed by shared memory.
|
Package sharedmem provides the implemention of data-link layer endpoints backed by shared memory. |
link/sharedmem/pipe
Package pipe implements a shared memory ring buffer on which a single reader and a single writer can operate (read/write) concurrently.
|
Package pipe implements a shared memory ring buffer on which a single reader and a single writer can operate (read/write) concurrently. |
link/sharedmem/queue
Package queue provides the implementation of transmit and receive queues based on shared memory ring buffers.
|
Package queue provides the implementation of transmit and receive queues based on shared memory ring buffers. |
link/sniffer
Package sniffer provides the implementation of data-link layer endpoints that wrap another endpoint and logs inbound and outbound packets.
|
Package sniffer provides the implementation of data-link layer endpoints that wrap another endpoint and logs inbound and outbound packets. |
link/tun
Package tun contains methods to open TAP and TUN devices.
|
Package tun contains methods to open TAP and TUN devices. |
link/waitable
Package waitable provides the implementation of data-link layer endpoints that wrap other endpoints, and can wait for inflight calls to WritePacket or DeliverNetworkPacket to finish (and new ones to be prevented).
|
Package waitable provides the implementation of data-link layer endpoints that wrap other endpoints, and can wait for inflight calls to WritePacket or DeliverNetworkPacket to finish (and new ones to be prevented). |
network/arp
Package arp implements the ARP network protocol.
|
Package arp implements the ARP network protocol. |
network/fragmentation
Package fragmentation contains the implementation of IP fragmentation.
|
Package fragmentation contains the implementation of IP fragmentation. |
network/hash
Package hash contains utility functions for hashing.
|
Package hash contains utility functions for hashing. |
network/ipv4
Package ipv4 contains the implementation of the ipv4 network protocol.
|
Package ipv4 contains the implementation of the ipv4 network protocol. |
network/ipv6
Package ipv6 contains the implementation of the ipv6 network protocol.
|
Package ipv6 contains the implementation of the ipv6 network protocol. |
ports
Package ports provides PortManager that manages allocating, reserving and releasing ports.
|
Package ports provides PortManager that manages allocating, reserving and releasing ports. |
sample/tun_tcp_connect
This sample creates a stack with TCP and IPv4 protocols on top of a TUN device, and connects to a peer.
|
This sample creates a stack with TCP and IPv4 protocols on top of a TUN device, and connects to a peer. |
sample/tun_tcp_echo
This sample creates a stack with TCP and IPv4 protocols on top of a TUN device, and listens on a port.
|
This sample creates a stack with TCP and IPv4 protocols on top of a TUN device, and listens on a port. |
seqnum
Package seqnum defines the types and methods for TCP sequence numbers such that they fit in 32-bit words and work properly when overflows occur.
|
Package seqnum defines the types and methods for TCP sequence numbers such that they fit in 32-bit words and work properly when overflows occur. |
stack
Package stack provides the glue between networking protocols and the consumers of the networking stack.
|
Package stack provides the glue between networking protocols and the consumers of the networking stack. |
transport/ping
Package ping contains the implementation of the ICMP and IPv6-ICMP transport protocols for use in ping.
|
Package ping contains the implementation of the ICMP and IPv6-ICMP transport protocols for use in ping. |
transport/queue
Package queue provides the implementation of buffer queue and interface of queue entry with Length method.
|
Package queue provides the implementation of buffer queue and interface of queue entry with Length method. |
transport/tcp
Package tcp contains the implementation of the TCP transport protocol.
|
Package tcp contains the implementation of the TCP transport protocol. |
transport/tcp/testing/context
Package context provides a test context for use in tcp tests.
|
Package context provides a test context for use in tcp tests. |
transport/tcpconntrack
Package tcpconntrack implements a TCP connection tracking object.
|
Package tcpconntrack implements a TCP connection tracking object. |
transport/udp
Package udp contains the implementation of the UDP transport protocol.
|
Package udp contains the implementation of the UDP transport protocol. |
transport/unix
Package unix contains the implementation of Unix endpoints.
|
Package unix contains the implementation of Unix endpoints. |
Package tmutex provides the implementation of a mutex that implements an efficient TryLock function in addition to Lock and Unlock.
|
Package tmutex provides the implementation of a mutex that implements an efficient TryLock function in addition to Lock and Unlock. |
Package unet provides a minimal net package based on Unix Domain Sockets.
|
Package unet provides a minimal net package based on Unix Domain Sockets. |
Package urpc provides a minimal RPC package based on unet.
|
Package urpc provides a minimal RPC package based on unet. |
Package waiter provides the implementation of a wait queue, where waiters can be enqueued to be notified when an event of interest happens.
|
Package waiter provides the implementation of a wait queue, where waiters can be enqueued to be notified when an event of interest happens. |
fdnotifier
Package fdnotifier contains an adapter that translates IO events (e.g., a file became readable/writable) from native FDs to the notifications in the waiter package.
|
Package fdnotifier contains an adapter that translates IO events (e.g., a file became readable/writable) from native FDs to the notifications in the waiter package. |
Click to show internal directories.
Click to hide internal directories.