ipcutil

Documentation

Index

• func CleanUp(ipc IPC) error
• func EncodeIPCLabel(ipc IPC) (string, error)
• func GenerateIPCOpts(ctx context.Context, ipc IPC, client *containerd.Client) ([]oci.SpecOpts, error)
• type IPC
  • func DecodeIPCLabel(ipcLabel string) (IPC, error)
  • func DetectFlags(ctx context.Context, client *containerd.Client, stateDir string, ipc string, ...) (IPC, error)
• type IPCMode

Functions

func CleanUp

func CleanUp(ipc IPC) error

func EncodeIPCLabel

func EncodeIPCLabel(ipc IPC) (string, error)

EncodeIPCLabel encodes IPC spec into a label.

func GenerateIPCOpts

func GenerateIPCOpts(ctx context.Context, ipc IPC, client *containerd.Client) ([]oci.SpecOpts, error)

GenerateIPCOpts generates IPC spec opts from the given IPC.

Types

type IPC

type IPC struct {
	Mode IPCMode `json:"mode,omitempty"`
	// VictimContainer is only used when mode is container
	VictimContainerID *string `json:"victimContainerId,omitempty"`

	// HostShmPath is only used when mode is shareable
	HostShmPath *string `json:"hostShmPath,omitempty"`

	// ShmSize is only used when mode is private or shareable
	// Devshm size in bytes
	ShmSize string `json:"shmSize,omitempty"`
}

func DecodeIPCLabel

func DecodeIPCLabel(ipcLabel string) (IPC, error)

DecodeIPCLabel decodes IPC spec from a label. For backward compatibility, if ipcLabel is empty, it returns IPC{Mode: Private}.

func DetectFlags

func DetectFlags(ctx context.Context, client *containerd.Client, stateDir string, ipc string, shmSize string) (IPC, error)

DetectFlags detects IPC mode from the given ipc string and shmSize string. If ipc is empty, it returns IPC{Mode: Private}.

type IPCMode

type IPCMode string

const (
	Private   IPCMode = "private"
	Host      IPCMode = "host"
	Shareable IPCMode = "shareable"
	Container IPCMode = "container"
)