Crate sidecar_defs 

Definitions for the sidecar kernel.

Structs

CommandError

A string error.

CommandPage

The sidecar command page, containing command requests and responses.

ControlPage

The per-node control page, which is used to communicate between the sidecar kernel and the main kernel sidecar kernel driver.

CpuContextX64

The CPU context for x86-64.

CpuStatus

The CPU status.

GetSetVpRegisterRequest

A request and response for SidecarCommand::GET_VP_REGISTERS or SidecarCommand::SET_VP_REGISTERS.

PerCpuState

Starting state for each CPU, supplied by openhcl_boot. For various reasons, openhcl_boot may have decided to instruct the linux kernel to start additional CPUs (notably, in the event that we know we’re about to spawn tasks on those CPUs right away to handle device interrupts).

RunVpResponse

A response for SidecarCommand::RUN_VP.

SidecarCommand

The sidecar command.

SidecarNodeOutput

The per-node output of the sidecar kernel boot process.

SidecarNodeParams

Node-specific input parameters.

SidecarOutput

The output of the sidecar kernel boot process.

SidecarParams

Sidecar start input parameters.

TranslateGvaRequest

A request for SidecarCommand::TRANSLATE_GVA.

TranslateGvaResponse

A response for SidecarCommand::TRANSLATE_GVA.

Constants

MAX_GET_SET_VP_REGISTERS

The maximum number of registers that can be requested in a single SidecarCommand::GET_VP_REGISTERS or SidecarCommand::SET_VP_REGISTERS.

MAX_NODES

The maximum number of supported sidecar nodes.

NUM_CPUS_SUPPORTED_FOR_PER_CPU_STATE

The maximum number of supported sidecar CPUs. Keep small to leave space on the SidecarParams page for future fields. VMs with more CPUs fall back to disabling sidecar on restore.

PAGE_SIZE

The page size for all sidecar objects.

PER_VP_PAGES

The number of reserved pages required for each VP.

PER_VP_SHMEM_PAGES

The number of per-VP shared-memory pages.

STACK_PAGES

The number of pages in the per-VP stack.

Functions

required_memory

The required memory (in bytes) for a node.