platform

Documentation

Overview

Package platform is the one place beekeeper reaches into the machine it runs on: memory, pressure, processes and OOM kills (Machine), detached units of work (Launcher), memory-capped runs (Capper), claude:// links (Opener), the person's input (Input), desktop notifications (Notifier), and the standby service and memory guard beekeeper install puts in place (Setup). The build selects one implementation: linux_systemd on Linux (systemd user units, cgroup v2, /proc, D-Bus), a stub on other systems and on Linux built with the nosystemd tag, whose parts return a NotAvailableError; the stub installs the standby service as a launch agent on darwin.

Index

• Variables
• func Detach(cmd *exec.Cmd)
• func Missing(err error) bool
• func Name() string
• func Unavailable(section string) string
• type Binary
  • func ProcessBinary(pid int) *Binary
  • func RunningBinary() *Binary
  • func (b *Binary) Exec(env ...string) error
  • func (b *Binary) Replaced() bool
• type Cap
• type Capper
• type File
• type Input
• type Launcher
• type Machine
• type NotAvailableError
  • func (e *NotAvailableError) Error() string
  • func (e *NotAvailableError) Is(target error) bool
• type Notifier
• type Opener
• type Options
• type Platform
  • func Current(o Options) Platform
  • func Stub() Platform
• type Setup
• type SetupSpec
• type Unit

Variables

var ErrNotAvailable = errors.New("not available on this platform")

ErrNotAvailable is what every NotAvailableError is.

Functions

func Detach

func Detach(cmd *exec.Cmd)

Detach runs cmd in a session of its own: the end of its caller's session (SIGHUP, a signal to the process group) does not reach it.

func Missing

func Missing(err error) bool

Missing reports whether err is a platform part this build does not have.

func Name

func Name() string

Name is the platform this build runs on.

func Unavailable

func Unavailable(section string) string

Unavailable is the one line a section prints in place of what it reads through a part this build does not have: "<section>: not available on <platform>".

Types

type Binary

type Binary struct {
	Path string
	// contains filtered or unexported fields
}

Binary is the executable a gate call runs. beekeeper self-update renames a new binary over its path; a waiting call notices the other file there and re-executes it, so a fix reaches the calls that already wait.

func ProcessBinary

func ProcessBinary(pid int) *Binary

ProcessBinary is the executable process pid runs, nil when /proc cannot say: its path, and the file it runs, which stays reachable at /proc/<pid>/exe after the path names another.

func RunningBinary

func RunningBinary() *Binary

RunningBinary is this process's executable, nil when /proc cannot say.

func (*Binary) Exec

func (b *Binary) Exec(env ...string) error

Exec replaces this process with the file at the path: the same pid, argument vector, stdio and environment plus env. It returns only when the new binary does not start; the call then stays on the running one until another file replaces it.

func (*Binary) Replaced

func (b *Binary) Replaced() bool

Replaced says whether the path now names another executable file than the running one.

type Cap

type Cap struct {
	// Max is the memory limit, Swap the swap limit ("12G", "0").
	Max, Swap string
}

Cap bounds a capped run.

type Capper

type Capper interface {
	// Available reports whether capped runs can be started here.
	Available() bool
	// Capped reports whether this process runs under a cap already.
	Capped() bool
	// Command is argv to run capped in the scope name; the caller starts
	// and waits for it.
	Command(name string, c Cap, argv []string) (*exec.Cmd, error)
}

Capper runs commands under a memory cap.

type File

type File struct {
	Path    string
	Content []byte
	// Service marks a file that defines a unit install enables and starts:
	// the standby service, the Teleport keeper's timer.
	Service bool
}

File is one file beekeeper install writes.

type Input

type Input interface {
	// Watch watches the keyboards and pointers until ctx ends and returns
	// when input last arrived: the start of the watch until the first.
	Watch(ctx context.Context) (last func() time.Time, err error)
}

Input tells when the person last typed or pointed.

type Launcher

type Launcher interface {
	// Available reports whether units can be started here.
	Available() bool
	Start(u Unit) error
	// Freeze suspends every process of the unit, Thaw resumes them.
	Freeze(ctx context.Context, name string) error
	Thaw(ctx context.Context, name string) error
	// Stop stops the unit and every process in it.
	Stop(ctx context.Context, name string) error
	// State is the unit's state ("active", "inactive", "failed", ...);
	// empty when unreadable.
	State(ctx context.Context, name string) string
	// Running lists the units matching the patterns that are active or
	// starting, and with stopping those running their stop too.
	Running(ctx context.Context, stopping bool, patterns ...string) []string
}

Launcher starts and inspects units.

type Machine

type Machine interface {
	Mem() (machine.Mem, error)
	// Load is the 1, 5 and 15 minute load average.
	Load() ([3]float64, error)
	// Forks is the machine's fork counter since boot.
	Forks() (uint64, error)
	// MemoryPressure is the share of the last minute every task stalled on
	// memory (PSI memory full avg60).
	MemoryPressure() (float64, error)
	// CPUPressure is the share of the last 10 seconds some task waited for
	// a CPU (PSI cpu some avg10).
	CPUPressure() (float64, error)
	Processes() (*proc.Table, error)
	// Started is when process pid started.
	Started(pid int) (time.Time, error)
	// DesktopScope is the largest Claude Desktop scope, nil when none runs;
	// an error when this build cannot read scopes.
	DesktopScope() (*machine.Scope, error)
	// MemcapScope is the capped run's scope unit, nil when it has ended.
	MemcapScope(unit string) *machine.Scope
	// ScopePIDs lists the processes of the scope at path (a Scope's Path).
	ScopePIDs(path string) []int
	// CgroupPIDs lists the processes of cgroup cg as a process's cgroup
	// names it.
	CgroupPIDs(cg string) []int
	// OOMPolicy is unit's OOM policy, "?" when unreadable.
	OOMPolicy(unit string) string
	// OOMDSwapLimit is the swap share in percent past which the userspace
	// OOM killer acts.
	OOMDSwapLimit() int
	// SwapoffRuns reports whether a swapoff is running.
	SwapoffRuns() bool
	// OOMKills are the kernel's OOM kills since the given time, oldest first.
	OOMKills(ctx context.Context, since time.Time) ([]machine.OOMKill, error)
	// OomdKills are the userspace OOM killer's kill lines since the given time.
	OomdKills(ctx context.Context, since time.Time) ([]string, error)
	// ServiceLog is the last day of the system service unit's log, the lines
	// matching the regular expression grep.
	ServiceLog(ctx context.Context, unit, grep string) ([]byte, error)
}

Machine reads the machine: memory, pressure, processes, the scopes the desktop app and the capped runs sit in, and the OOM kills.

type NotAvailableError

type NotAvailableError struct {
	// Part names what is missing, "Launcher.Start" for instance.
	Part string
}

NotAvailableError is a platform part this build does not have.

func (*NotAvailableError) Error

func (e *NotAvailableError) Error() string

func (*NotAvailableError) Is

func (e *NotAvailableError) Is(target error) bool

Is makes errors.Is(err, ErrNotAvailable) true.

type Notifier

type Notifier interface {
	notify.Sender
	Close() error
}

Notifier shows desktop notifications.

type Opener

type Opener interface {
	// Running is when the desktop app's main process started, zero when it
	// does not run.
	Running(t *proc.Table) time.Time
	// Open hands url to the running app, or starts the app on it.
	Open(ctx context.Context, url string, running bool) error
}

Opener hands claude:// links to the desktop app.

type Options

type Options struct {
	// DesktopApp is the Claude desktop app's executable (claude.desktopApp):
	// it starts the app, or hands a claude:// link to the running one.
	DesktopApp string
}

Options are the configured parts of a platform.

type Platform

type Platform struct {
	Machine  Machine
	Launcher Launcher
	Capper   Capper
	Opener   Opener
	Input    Input
	Setup    Setup
	// NewNotifier opens a notifier; the caller closes it.
	NewNotifier func() Notifier
}

Platform is one build's implementation of every part.

func Current

func Current(o Options) Platform

Current is the platform this build runs on.

func Stub

func Stub() Platform

Stub is the platform with every part not available: the build's own on other systems and with the nosystemd tag, and in every build the one the degrade paths are tested against.

type Setup

type Setup interface {
	// Available reports whether this platform runs the standby service.
	Available() bool
	// Files are the standby service's, the memory guard's and the keeper's
	// files for spec, and a line for each part this machine gets none of.
	Files(spec SetupSpec) (files []File, skipped []string)
	// Started reports whether the unit defined by the file at path is
	// enabled and running.
	Started(ctx context.Context, path string) bool
	// Reload makes the service manager read changed files, nil when it
	// needs no command for that.
	Reload() []string
	// Start enables and starts the unit defined by the file at path;
	// Stop stops and disables it.
	Start(path string) []string
	Stop(path string) []string
}

Setup is what beekeeper install puts in place for this platform beside the hooks and the config: the standby service (beekeeper watch --notify --standby), the memory guard and the Teleport login's keeper, as files and the service manager's commands. A command is an argument vector.

type SetupSpec

type SetupSpec struct {
	// Home is the user's home, ConfigDir their configuration directory
	// ($XDG_CONFIG_HOME, else ~/.config).
	Home, ConfigDir string
	// Exe is the absolute path of the binary the standby service runs.
	Exe string
	// RAMMiB and SwapMiB size the memory guard; zero RAM writes none.
	RAMMiB, SwapMiB int
	// DesktopScope is the unit name of the running Claude Desktop scope,
	// empty when none runs.
	DesktopScope string
	// TeleportEvery is how often the Teleport login's keeper reads the
	// expiry (teleport.every); zero writes no keeper.
	TeleportEvery time.Duration
}

SetupSpec is the machine beekeeper install sets up.

type Unit

type Unit struct {
	Name string
	// Dir is the working directory, empty for the launcher's own.
	Dir string
	// Env are KEY=VALUE pairs set for Argv.
	Env  []string
	Argv []string
	// KeepChildren leaves what Argv started running when Argv ends, as a
	// terminal would; otherwise a stop ends them too.
	KeepChildren bool
	// TermIsSuccess counts an end by SIGTERM as success: a stop as asked.
	TermIsSuccess bool
	// StopPost runs once Argv has ended, for up to StopTimeout.
	StopPost    []string
	StopTimeout time.Duration
}

Unit is a detached, named unit of work: it outlives its starter.