Documentation
¶
Index ¶
- Constants
- Variables
- func Annotations(labels []string) (bundle string, userAnnotations map[string]string)
- func CloseExecFrom(minFd int) error
- func ExitStatus(status unix.WaitStatus) int
- func NewSockPair(name string) (parent, child *os.File, err error)
- func Openat(dir *os.File, path string, flags int, mode uint32) (*os.File, error)
- func RecvFile(socket *os.File) (_ *os.File, Err error)
- func SearchLabels(labels []string, key string) (string, bool)
- func SendFile(socket *os.File, file *os.File) error
- func SendRawFd(socket *os.File, msg string, fd uintptr) error
- func UnsafeCloseFrom(minFd int) error
- func WithProcfd(root, unsafePath string, fn func(procfd string) error) errordeprecated
- func WithProcfdFile(file *os.File, fn func(procfd string) error) error
- func WriteJSON(w io.Writer, v any) error
- type ProcThreadSelfCloser
Constants ¶
const MaxNameLen = 4096
MaxNameLen is the maximum length of the name of a file descriptor being sent using SendFile. The name of the file handle returned by RecvFile will never be larger than this value.
Variables ¶
var CleanPath = pathrs.LexicallyCleanPath
CleanPath makes a path safe for use with filepath.Join. This is done by not only cleaning the path, but also (if the path is relative) adding a leading '/' and cleaning it (then removing the leading '/'). This ensures that a path resulting from prepending another path will always resolve to lexically be a subdirectory of the prefixed path. This is all done lexically, so paths that include symlinks won't be safe as a result of using CleanPath.
Deprecated: This function has been moved to internal/pathrs and this wrapper will be removed in runc 1.5.
var StripRoot = pathrs.LexicallyStripRoot
StripRoot returns the passed path, stripping the root path if it was (lexicially) inside it. Note that both passed paths will always be treated as absolute, and the returned path will also always be absolute. In addition, the paths are cleaned before stripping the root.
Deprecated: This function has been moved to internal/pathrs and this wrapper will be removed in runc 1.5.
Functions ¶
func Annotations ¶ added in v1.0.0
Annotations returns the bundle path and user defined annotations from the libcontainer state. We need to remove the bundle because that is a label added by libcontainer.
func CloseExecFrom ¶
CloseExecFrom sets the O_CLOEXEC flag on all file descriptors greater or equal to minFd in the current process.
func ExitStatus ¶
func ExitStatus(status unix.WaitStatus) int
ExitStatus returns the correct exit status for a process based on if it was signaled or exited cleanly
func NewSockPair ¶ added in v1.0.0
NewSockPair returns a new SOCK_STREAM unix socket pair.
func RecvFile ¶ added in v1.2.0
RecvFile waits for a file descriptor to be sent over the given AF_UNIX socket. The file name of the remote file descriptor will be recreated locally (it is sent as non-auxiliary data in the same payload).
func SearchLabels ¶ added in v0.1.0
SearchLabels searches through a list of key=value pairs for a given key, returning its value, and the binary flag telling whether the key exist.
func SendFile ¶ added in v1.2.0
SendFile sends a file over the given AF_UNIX socket. file.Name() is also included so that if the other end uses RecvFile, the file will have the same name information.
func SendRawFd ¶ added in v1.2.0
SendRawFd sends a specific file descriptor over the given AF_UNIX socket.
func UnsafeCloseFrom ¶ added in v1.1.12
UnsafeCloseFrom closes all file descriptors greater or equal to minFd in the current process, except for those critical to Go's runtime (such as the netpoll management descriptors).
NOTE: That this function is incredibly dangerous to use in most Go code, as closing file descriptors from underneath *os.File handles can lead to very bad behaviour (the closed file descriptor can be reused and then any *os.File operations would apply to the wrong file). This function is only intended to be called from the last stage of runc init.
func WithProcfd
deprecated
added in
v1.0.0
WithProcfd runs the passed closure with a procfd path (/proc/self/fd/...) corresponding to the unsafePath resolved within the root. Before passing the fd, this path is verified to have been inside the root -- so operating on it through the passed fdpath should be safe. Do not access this path through the original path strings, and do not attempt to use the pathname outside of the passed closure (the file handle will be freed once the closure returns).
Deprecated: This function is an internal implementation detail of runc and is no longer used. It will be removed in runc 1.5.
func WithProcfdFile ¶ added in v1.2.8
WithProcfdFile is a very minimal wrapper around ProcThreadSelfFd. The caller is responsible for making sure that the provided file handle is actually safe to operate on.
NOTE: THIS FUNCTION IS INTERNAL TO RUNC, DO NOT USE IT.
TODO: Migrate the mount logic towards a more move_mount(2)-friendly design where this is kind of /proc/self/... tomfoolery is only done in a fallback path for old kernels.
func WriteJSON ¶ added in v0.0.7
WriteJSON writes the provided struct v to w using standard json marshaling without a trailing newline. This is used instead of json.Encoder because there might be a problem in json decoder in some cases, see: https://github.com/docker/docker/issues/14203#issuecomment-174177790
Types ¶
type ProcThreadSelfCloser ¶ added in v1.2.0
type ProcThreadSelfCloser func()
func ProcThreadSelf ¶ added in v1.2.0
func ProcThreadSelf(subpath string) (string, ProcThreadSelfCloser)
ProcThreadSelf returns a string that is equivalent to /proc/thread-self/<subpath>, with a graceful fallback on older kernels where /proc/thread-self doesn't exist. This method DOES NOT use SecureJoin, meaning that the passed string needs to be trusted. The caller _must_ call the returned procThreadSelfCloser function (which is runtime.UnlockOSThread) *only once* after it has finished using the returned path string.
func ProcThreadSelfFd ¶ added in v1.2.0
func ProcThreadSelfFd(fd uintptr) (string, ProcThreadSelfCloser)
ProcThreadSelfFd is small wrapper around ProcThreadSelf to make it easier to create a /proc/thread-self handle for given file descriptor.
It is basically equivalent to ProcThreadSelf(fmt.Sprintf("fd/%d", fd)), but without using fmt.Sprintf to avoid unneeded overhead.
Source Files