The code used to make system calls from the runtime is a mess and a big pain point when making OS-level changes in the runtime.

Quick summary of some of the pain points:

  • Completely independent implementation from package syscall.
  • System call stubs exist in a variety of OS- and arch-specific sys* files (57, to be precise, mostly assembly), totaling ~23k lines of code [1], which is 100% hand-written. Adding a new syscall stub often requires adding new assembly to 10+ files.
  • There is no generic Syscall function that can be used to make an arbitrary system call. You must add a new stub to make a new call.

Some things we could do to improve the situation:

  • Add generic Syscall functions, used by other stubs. And/or use code generation to generate stubs rather than doing so manually.
  • Move syscall code to a new package (like runtime/internal/syscall or perhaps runtime/internal/linux?) to avoid littering the runtime package itself with so many files.
  • Make package syscall depend on the runtime's Syscall stub so we only have a single implementation.

[1] Some of this code is things other than syscall stubs, like thread entrypoints.

cc @aclements @mknyszek @cherrymui

Comment From: aclements

And/or use code generation to generate stubs rather than doing so manually.

All or most of the information we would need to generate the stubs is already in the syscall package. The needs of the syscall package are of course a bit different, but the metadata should be effectively the same.

Orthogonal to code generation, given a generic runtime Syscall function (or a few of them for different numbers of arguments), would there even be any overhead to having the stubs be in Go rather than assembly? In addition to significantly reducing the amount of assembly, I think this would encourage us to do better error handling.

Comment From: cherrymui

Just to add another pain point: the stubs handle errors differently. Some returns errno (negated or not?), some just crash hard (writing to an invalid address), which is difficult to debug sometimes.

Comment From: gopherbot

Change https://go.dev/cl/383999 mentions this issue: runtime/internal/syscall: new package for linux

Comment From: ii64

Seems this introduce build error, i got: gofrontend commit 45fd14ab8baf5e86012a808426f8ef52c1d77943 Golang runtime: clean up system call code

Comment From: cherrymui

@ii64 this issue is about a plan for the future, not what has happened. Your comment is unrelated to this issue.

Looks like you are using gollvm. What version of gollvm are you using? Try updating to the latest. If that still fail, please file a new issue. Thanks.

Comment From: gopherbot

Change https://go.dev/cl/388094 mentions this issue: test: rename live_syscall.go to live_uintptrkeepalive.go

Comment From: gopherbot

Change https://go.dev/cl/388477 mentions this issue: syscall: define Syscall in terms of RawSyscall

Comment From: gopherbot

Change https://go.dev/cl/388475 mentions this issue: runtime/internal/syscall, syscall: replace RawSyscall6 with runtime implementation

Comment From: gopherbot

Change https://go.dev/cl/388478 mentions this issue: syscall: define Syscall6 in terms of RawSyscall6

Comment From: gopherbot

Change https://go.dev/cl/388095 mentions this issue: cmd/compile: add //go:uintptrkeepalive

Comment From: gopherbot

Change https://go.dev/cl/388476 mentions this issue: syscall: define RawSyscall in terms of RawSyscall6

Comment From: gopherbot

Change https://go.dev/cl/388479 mentions this issue: syscall: implement rawSyscallNoError in terms of RawSyscall

Comment From: gopherbot

Change https://go.dev/cl/388474 mentions this issue: syscall: move Syscall declarations to OS files

Comment From: gopherbot

Change https://go.dev/cl/401096 mentions this issue: runtime/internal/syscall: use ABIInternal for Syscall6 on amd64

Comment From: gopherbot

Change https://go.dev/cl/401337 mentions this issue: DO NOT SUBMIT: WIP: support inlining with //go:uintptrkeepalive

Comment From: gopherbot

Change https://go.dev/cl/401636 mentions this issue: Revert "syscall: define Syscall in terms of RawSyscall on linux"

Comment From: gopherbot

Change https://go.dev/cl/401634 mentions this issue: Revert "runtime/internal/syscall: use ABIInternal for Syscall6 on amd64"

Comment From: gopherbot

Change https://go.dev/cl/401635 mentions this issue: Revert "syscall: define Syscall6 in terms of RawSyscall6 on linux"

Comment From: gopherbot

Change https://go.dev/cl/401654 mentions this issue: syscall: define Syscall in terms of RawSyscall on linux

Comment From: gopherbot

Change https://go.dev/cl/401656 mentions this issue: runtime/internal/syscall: use ABIInternal for Syscall6 on amd64

Comment From: gopherbot

Change https://go.dev/cl/401655 mentions this issue: syscall: define Syscall6 in terms of RawSyscall6 on linux

Comment From: prattmic

Everything I expect to get into 1.19 is in. Moving future work to 1.20.

Comment From: gopherbot

Change https://go.dev/cl/402914 mentions this issue: syscall: add //go:norace to RawSyscall

Comment From: gopherbot

Change https://go.dev/cl/421994 mentions this issue: runtime: move epoll syscalls to runtime/internal/syscall

Comment From: gopherbot

Change https://go.dev/cl/437295 mentions this issue: Revert "runtime: move epoll syscalls to runtime/internal/syscall"

Comment From: gopherbot

Change https://go.dev/cl/440115 mentions this issue: runtime: move epoll syscalls to runtime/internal/syscall

Comment From: gopherbot

Change https://go.dev/cl/612715 mentions this issue: runtime: use getrandom(2) for readRandom on Linux

Comment From: gopherbot

Change https://go.dev/cl/689155 mentions this issue: internal/runtime/syscall: rename to internal/runtime/syscall/linux

Comment From: gopherbot

Change https://go.dev/cl/689156 mentions this issue: internal/runtime/syscall/windows: factor out code from runtime

Comment From: gopherbot

Change https://go.dev/cl/698098 mentions this issue: runtime: move Windows types and consts to internal/runtime/syscall/windows