runtime

type Exit struct {
	Cause  ExitCause
	Code   int
	Signal int
}

type ExitCause string

type Instance struct {
	ID        InstanceID
	Namespace v1alpha1.NamespaceName
	Name      v1alpha1.ObjectName
	OwnerKind v1alpha1.Kind       // as created (ADR-0152)
	Revision  v1alpha1.ObjectName // as created (ADR-0143)
	Replica   int
	PID       int
	State     State
	IP        string // worker endpoint host: netns IP (containerd) or 127.0.0.1 (process driver, ADR-0030)
	Port      int    // worker HTTP port: the shim's listening port (ADR-0030); 0 until resolved
	CreatedAt time.Time
	StartedAt time.Time // the last successful Start; zero before the first (ADR-0183)
	Listened  bool      // wrote its port to FUNCD_PORTFILE since its last Start; stays true after it ends (ADR-0160)
	Exit      Exit
}

type InstanceID string

type Limits struct {
	MemoryBytes int64
	CPUs        float64
}

type LogCaptureFunc func(spec WorkerSpec, r io.ReadCloser)

type LogCapturer interface {
	// SetLogCapture installs (or clears, with nil) the per-instance log-channel hook.
	SetLogCapture(LogCaptureFunc)
}

type Mount struct {
	Source   string // host path
	Target   string // container path
	ReadOnly bool
}

type OutputCaptureFunc func(spec WorkerSpec, out *workerpipe.Output)

type OutputCapturer interface {
	SetOutputCapture(OutputCaptureFunc)
}

type Runtime interface {
	// Create makes a worker from spec without starting it. An empty spec.OwnerKind is fault.Invalid; an ID held by an
	// instance of another OwnerKind, even when that instance has exited, or on containerd by a leftover container
	// labelled with another kind, is fault.Conflict (ADR-0152).
	Create(ctx context.Context, spec WorkerSpec) (Instance, error)
	// Start runs the worker's process.
	Start(ctx context.Context, id InstanceID) error
	// Stop terminates the process (SIGTERM, then SIGKILL); it is idempotent.
	Stop(ctx context.Context, id InstanceID) error
	// Status returns the observed instance; fault.NotFound if unknown.
	Status(ctx context.Context, id InstanceID) (Instance, error)
	// Logs returns the current or last run's tail of stdout and stderr (ADR-0168), empty before the first Start, with an
	// ended run's last line: stdout's lines, then stderr's.
	Logs(ctx context.Context, id InstanceID) (io.ReadCloser, error)
	// Exec runs a command in the instance's context (best-effort in V1).
	Exec(ctx context.Context, id InstanceID, cmd []string) error
	// List returns the instances in a namespace.
	List(ctx context.Context, ns v1alpha1.NamespaceName) ([]Instance, error)
	// Remove forgets an instance after Stop has released it, with its per-instance files: Status then reports
	// fault.NotFound and List omits it. An instance Stop has not released — running, created, or exited on its own —
	// is fault.Conflict; an unknown one is a no-op (ADR-0143).
	Remove(ctx context.Context, id InstanceID) error
	// Close releases the driver's resources.
	Close() error
}

type State string

type WorkerSpec struct {
	Namespace v1alpha1.NamespaceName
	Name      v1alpha1.ObjectName
	OwnerKind v1alpha1.Kind       // the kind whose reconciler created the worker; required (ADR-0152)
	Revision  v1alpha1.ObjectName // the Revision this worker runs (ADR-0143); "" outside the Function lifecycle
	Replica   int
	Members   int               // the members a pool worker hosts (ADR-0046); 0 for a solo worker
	Image     string            // runtime image (containerd driver)
	Command   []string          // launch command / container args
	Env       map[string]string // typed-flat; no any
	Mounts    []Mount           // host→container bind mounts (container drivers; ADR-0032)
	Limits    Limits
}