MCPcopy
hub / github.com/google/gvisor

github.com/google/gvisor @release-20260622.0 sqlite

repository ↗ · DeepWiki ↗ · release release-20260622.0 ↗
28,653 symbols 145,046 edges 2,284 files 21,239 documented · 74%
README

gVisor

Build status Issue reviver CodeQL gVisor chat code search

What is gVisor?

gVisor provides a strong layer of isolation between running applications and the host operating system. It is an application kernel that implements a Linux-like interface. Unlike Linux, it is written in a memory-safe language (Go) and runs in userspace.

gVisor includes an Open Container Initiative (OCI) runtime called runsc that makes it easy to work with existing container tooling. The runsc runtime integrates with Docker and Kubernetes, making it simple to run sandboxed containers.

What isn't gVisor?

  • gVisor is not a syscall filter (e.g. seccomp-bpf), nor a wrapper over Linux isolation primitives (e.g. firejail, AppArmor, etc.).
  • gVisor is also not a VM in the everyday sense of the term (e.g. VirtualBox, QEMU).

gVisor takes a distinct third approach, providing many security benefits of VMs while maintaining the lower resource footprint, fast startup, and flexibility of regular userspace applications.

Why does gVisor exist?

Containers are not a sandbox. While containers have revolutionized how we develop, package, and deploy applications, using them to run untrusted or potentially malicious code without additional isolation is not a good idea. While using a single, shared kernel allows for efficiency and performance gains, it also means that container escape is possible with a single vulnerability.

gVisor is an application kernel for containers. It limits the host kernel surface accessible to the application while still giving the application access to all the features it expects. Unlike most kernels, gVisor does not assume or require a fixed set of physical resources; instead, it leverages existing host kernel functionality and runs as a normal process. In other words, gVisor implements Linux by way of Linux.

gVisor should not be confused with technologies and tools to harden containers against external threats, provide additional integrity checks, or limit the scope of access for a service. One should always be careful about what data is made available to a container.

Documentation

User documentation and technical architecture, including quick start guides, can be found at gvisor.dev.

Installing from source

gVisor builds on x86_64 and ARM64. Other architectures may become available in the future.

For the purposes of these instructions, bazel and other build dependencies are wrapped in a build container. It is possible to use bazel directly, or type make help for standard targets.

Requirements

Make sure the following dependencies are installed:

Building

Build and install the runsc binary:

mkdir -p bin
make copy TARGETS=runsc DESTINATION=bin/
sudo cp ./bin/runsc /usr/local/bin

To build specific libraries or binaries, you can specify the target:

make build TARGETS="//pkg/tcpip:tcpip"

Building directly with Bazel (without Docker)

Using Bazel directly isn't recommended due to the extra overhead, but in order to get started:

  • Look at the build dockerfile for the canonical list of needed dependencies.
  • Install and use bazelisk. Otherwise, make sure your bazel version matches the one listed in the .bazelversion file.

After setting up dependencies, using Bazel is similar to the Makefile:

bazel build //runsc:runsc

Testing

To run standard test suites, you can use:

make unit-tests
make tests

To run specific tests, you can specify the target:

# Makefile
make test TARGETS="//runsc:version_test"
# Bazel
bazel test //runsc:version_test

Mac OS

Some packages support running tests directly on macOS. At the time of this writing, gVisor requires bazel 8, which you can install via homebrew:

brew install bazel@8

# You can then run the tests, e.g.:
$(brew --prefix bazel@8)/bin/bazel test --macos_sdk_version=$(xcrun --show-sdk-version) -- //tools/nogo/... //tools/check{aligned,const,escape,linkname,locks,unsafe}/...

Using go get

This project uses bazel to build and manage dependencies. A synthetic go branch is maintained that is compatible with standard go tooling for convenience.

For example, to build and install runsc directly from this branch:

echo "module runsc" > go.mod
GO111MODULE=on go get gvisor.dev/gvisor/runsc@go
CGO_ENABLED=0 GO111MODULE=on sudo -E go build -o /usr/local/bin/runsc gvisor.dev/gvisor/runsc

Subsequently, you can build and install the shim binary for containerd:

GO111MODULE=on sudo -E go build -o /usr/local/bin/containerd-shim-runsc-v1 gvisor.dev/gvisor/shim

Note that this branch is supported in a best effort capacity, and direct development on this branch is not supported. Development should occur on the master branch, which is then reflected into the go branch.

Community & Governance

See GOVERNANCE.md for project governance information.

The gvisor-users mailing list and gvisor-dev mailing list are good starting points for questions and discussion.

Security Policy

See SECURITY.md.

Contributing

See Contributing.md.

Extension points exported contracts — how you extend this code

InodeWithXattrs (Interface)
InodeWithXattrs should be implemented by kernfs Inodes that support xattrs. [12 implementers]
pkg/sentry/fsimpl/kernfs/kernfs.go
MMIOController (Interface)
MMIOController controls eventfd memory-mapped I/O. [8 implementers]
pkg/eventfd/eventfd.go
Functions (Interface)
Functions is a required type parameter that must be a struct implementing the methods defined by Functions. [20 implementers]
pkg/segment/set.go
Waitable (Interface)
Waitable contains the methods that need to be implemented by waitable objects. [36 implementers]
pkg/waiter/waiter.go
SaverLoader (Interface)
SaverLoader must be implemented by struct types. [9 implementers]
pkg/state/state.go
Emitter (Interface)
Emitter is the final destination for logs. [6 implementers]
pkg/log/log.go
HasStatus (Interface)
HasStatus is an interface for parameter structs that have a Status field. [58 implementers]
pkg/abi/nvgpu/nvgpu.go
Stopper (Interface)
Stopper is an optional interface, that when implemented, allows an object to have a callback executed when the server is [19 …
pkg/urpc/urpc.go

Core symbols most depended-on inside this repo

Errorf
called by 3508
test/secfuzz/secfuzz.go
Fatalf
called by 3360
pkg/compressio/compressio_test.go
Errorf
called by 2724
pkg/compressio/compressio_test.go
Fatalf
called by 2674
test/secfuzz/secfuzz.go
Unlock
called by 2456
pkg/sentry/kernel/ipc/object.go
Lock
called by 2219
pkg/sentry/kernel/ipc/object.go
Errorf
called by 1415
pkg/sentry/platform/kvm/kvm_test.go
Add
called by 971
pkg/aio/aio.go

Shape

Method 15,579
Function 8,513
Struct 3,583
TypeAlias 568
Interface 351
FuncType 57
Class 2

Languages

Go100%
Python1%
TypeScript1%

Modules by API surface

pkg/tcpip/tcpip.go299 symbols
pkg/lisafs/message.go238 symbols
pkg/tcpip/stack/registration.go218 symbols
pkg/tcpip/errors.go183 symbols
pkg/tcpip/transport/tcp/test/e2e/tcp_test.go158 symbols
pkg/tcpip/stack/stack.go158 symbols
pkg/tcpip/stack/stack_test.go141 symbols
pkg/sentry/socket/unix/transport/unix.go136 symbols
test/iptables/filter_input.go133 symbols
test/nftables/filter_input_iptables.go132 symbols
test/packetimpact/testbench/layers.go130 symbols
pkg/tcpip/transport/tcp/endpoint.go127 symbols

Dependencies from manifests, versioned

cel.dev/exprv0.25.1 · 1×
cloud.google.com/gov0.123.0 · 1×
cloud.google.com/go/authv0.20.0 · 1×
cloud.google.com/go/auth/oauth2adaptv0.2.8 · 1×
cloud.google.com/go/compute/metadatav0.9.0 · 1×
cloud.google.com/go/monitoringv1.24.3 · 1×
cloud.google.com/go/storagev1.62.1 · 1×
github.com/BurntSushi/tomlv1.4.1-0.20240526193 · 1×
github.com/GoogleCloudPlatform/opentelemetry-operations-go/detectors/gcpv1.31.0 · 1×
github.com/GoogleCloudPlatform/opentelemetry-operations-go/exporter/metricv0.55.0 · 1×
github.com/GoogleCloudPlatform/opentelemetry-operations-go/internal/resourcemappingv0.55.0 · 1×

Datastores touched

(mysql)Database · 1 repos

For agents

$ claude mcp add gvisor \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact