vm

type Dir ¶

type Dir string

Dir represents the root of a firecracker-containerd VM directory, which holds various files, sockets and FIFOs used during VM runtime.

func ShimDir(shimBaseDir, namespace, vmID string) (Dir, error)

func (d Dir) AddrFilePath() string

func (d Dir) BundleLink(containerID string) (bundle.Dir, error)

func (d Dir) CreateAddressLink(containerID string) error

func (d Dir) CreateBundleLink(containerID string, bundleDir bundle.Dir) error

func (d Dir) CreateShimLogFifoLink(containerID string) error

func (d Dir) FirecrackerLogFifoPath() string

func (d Dir) FirecrackerMetricsFifoPath() string

func (d Dir) FirecrackerSockPath() string

func (d Dir) FirecrackerSockRelPath() (string, error)

func (d Dir) FirecrackerVSockPath() string

func (d Dir) FirecrackerVSockRelPath() (string, error)

func (d Dir) LogFifoPath() string

func (d Dir) Mkdir() error

func (d Dir) OpenLogFifo(requestCtx context.Context) (io.ReadWriteCloser, error)

func (d Dir) RootPath() string

func (d Dir) WriteAddress(shimSocketAddress string) error

type IOConnector ¶

type IOConnector func(procCtx context.Context, logger *logrus.Entry) <-chan IOConnectorResult

IOConnector is function that begins initializing an IO connection (i.e. vsock, FIFO, etc.). It returns a channel that should be published to with an IOConnectorResult object once initialization is complete or an error occurs.

The return of a channel instead of plain values gives the implementation the freedom to do synchronous setup, asynchronous setup or a mix of both.

The provided context is canceled if the process fails to create/exec or when the process exits after a successful create/exec.

func FIFOConnector(path string) IOConnector

func VSockAcceptConnector(port uint32) IOConnector

func VSockDialConnector(udsPath string, port uint32) IOConnector

type IOConnectorPair ¶

type IOConnectorPair struct {
	ReadConnector  IOConnector
	WriteConnector IOConnector
}

IOConnectorPair holds the read and write side of IOConnectors whose IO should be proxied.

type IOConnectorResult ¶

type IOConnectorResult struct {
	io.ReadWriteCloser
	Err error
}

IOConnectorResult represents the result of attempting to establish an IO connection. If successful, the ReadWriteCloser should be non-nil and Err should be nil. If unsuccessful, ReadWriteCloser should be nil and Err should be non-nil.

type IOProxy ¶

type IOProxy interface {
	// contains filtered or unexported methods
}

IOProxy is an interface to a particular implementation for initializing and copying the stdio of a process running in a VM. All its methods are unexported as they are used only internally. The interface exists just to give outside callers a choice of implementation when setting up a process.

func NewIOConnectorProxy(stdin, stdout, stderr *IOConnectorPair) IOProxy

func NewNullIOProxy() IOProxy

type TaskManager ¶

type TaskManager interface {
	// CreateTask adds a task to be managed. It creates the task using the
	// provided request/TaskService and sets up IO streams using the provided
	// IOConnectorSet.
	// If the TaskManager was shutdown by a previous call to ShutdownIfEmpty, an
	// error will be returned.
	CreateTask(context.Context, *taskAPI.CreateTaskRequest, taskAPI.TaskService, IOProxy) (*taskAPI.CreateTaskResponse, error)

	// DeleteProcess removes a task or exec being managed from the TaskManager.
	// It deletes the process from the provided TaskService using the provided
	// request. It also blocks until all IO for the task has been flushed or a
	// hardcoded timeout is hit.
	DeleteProcess(context.Context, *taskAPI.DeleteRequest, taskAPI.TaskService) (*taskAPI.DeleteResponse, error)

	// ExecProcess adds an exec process to be managed. It must be an exec for a
	// Task already managed by the TaskManager.
	// If the TaskManager was shutdown by a previous call to ShutdownIfEmpty, an
	// error will be returned.
	ExecProcess(context.Context, *taskAPI.ExecProcessRequest, taskAPI.TaskService, IOProxy) (*types.Empty, error)

	// ShutdownIfEmpty will atomically check if there are no tasks left being managed and, if so,
	// prevent any new tasks from being added going forward (future attempts will return an error).
	// If any tasks are still in the TaskManager's map, no change will be made.
	// It returns a bool indicating whether TaskManager shut down as a result of the call.
	ShutdownIfEmpty() bool
}

TaskManager manages a set of tasks, ensuring that creation, deletion and io stream handling of the task happen in a synchronized manner. It's intended to contain logic common to both the host runtime shim and VM agent (which would otherwise be duped between the two).

func NewTaskManager(shimCtx context.Context, logger *logrus.Entry) TaskManager