Documentation
Everything about building Linux kernel modules in Go with gokm.
gokm builds Linux kernel modules (x86-64) from plain Go code, using TinyGo.
A project is just Go files: filesystems, character devices, /proc files and
network devices are written against Go packages, and gokm supplies all the
kernel-side code. Goroutines, channels, sync, fmt, maps, defer/recover
and floating point all work, and Go code runs on all CPUs in parallel.
gokm is experimental. Don’t use it in production: the modules it builds run inside the kernel, where a bug in the generated code or the Go runtime can crash the machine or corrupt data, and the API may change without notice.
Start here#
- Installation: requirements and installing the
gokmcommand. - Tutorial: a “hello world” module in ten minutes.
Guides#
- Command line:
gokm initandgokm build. - Packages: filesystems, devices,
/procfiles, network interfaces, block devices, module parameters and kernel bindings. - Memory: the Go heap inside the kernel.
- Concurrency: parallel Go, goroutines and atomic context.
- Examples: complete modules to learn from.
- C in csrc/: the escape hatch.
Reference#
- API reference: every exported identifier of the Go packages.
- How it works: the build pipeline and the runtime.
- Limitations: what isn’t supported.
- Development: building gokm itself and running its tests.
License#
gokm is released under the MIT License,
except the C code it compiles into every module (its runtime, the framework
glue and the C files it generates) and examples/gobrd, a port of Linux’s
brd driver: those are under the
GPL-2.0, as their
SPDX-License-Identifier headers say. That C code uses GPL-only kernel
symbols, so modules built with gokm need a GPL-compatible MODULE_LICENSE.