Default package

Get desktop application:
View/edit binary Protocol Buffers messages

Used in: ControllerToDaemon

• optional string iface_name = 1

• optional bool persistent = 2

Used in: DaemonToController

• required string name = 1

  user configurable, non unique

• required string guest_os = 2

  name of GuestOS, e.g. android

• optional uint64 guestos_version = 3

  (minimal) version of GuestOS; will be updated if container is started with a more recent GuestOS version.

• repeated ContainerImageSize image_sizes = 4

  complete image sizes from GuestOS for user partitions

• optional uint32 ram_limit = 5

  unit = MBytes

• required fixed32 color = 6

• required ContainerType type = 7

  type of container, e.g. KVM or CONTAINER

• optional bool allow_autostart = 17

  Flags indicating the allows for containers:

  TODO: add further features as necessary

• repeated string feature_enabled = 20

  a list of strings wich contain the features image prefix name without .img

• optional string dns_server = 21

• optional bool netns = 22

• repeated string net_ifaces = 23

  a list of network interfaces assigned to this container

• repeated string allow_dev = 25

  a list of devices explicitely allowed for this container

• repeated string assign_dev = 26

  a list of devices exclusively assigned to this container

• repeated ContainerVnetConfig vnet_configs = 27

  list of virtual network interface configuration

* Must be kept in sync with definition in container.h!

• OFFLINE = 1

• MOBILE_ONLY = 2

• WIFI_ONLY = 3

• MOBILE_AND_WIFI = 4

Used in: ContainerConfig

• required string image_name = 1

  virtual name of the image file in guestos

• required uint64 image_size = 2

  size (bytes) of the image file

• optional string image_file = 3

  name of alternat image file which overwrites image_name of guestos config

Used in: ControllerToDaemon

• optional string key = 1

  Note: This message may change in the future!

• optional bool no_switch = 2

• optional bool setup = 3

* The various states that a container can be in. TODO must be kept in sync with definition in container.h!

Used in: ContainerStatus

• STOPPED = 1

• STARTING = 2

• BOOTING = 3

• RUNNING = 4

• FREEZING = 5

• FROZEN = 6

• ZOMBIE = 7

• SHUTDOWN = 8

• SETUP = 9

* Represents the status of a single container.

Used in: DaemonToController

• required string uuid = 1

• required string name = 2

• required ContainerType type = 3

• required ContainerState state = 4

• required uint64 uptime = 5

• required uint64 created = 6

  TBD more state values

* Type of container KVM|CONTAINER

Used in: ContainerConfig, ContainerStatus

• CONTAINER = 1

• KVM = 2

Used in: ContainerConfig

• required string if_name = 1

  name of virtual veth endpoint in container

• required bool configure = 2

  should cmld configure the interface or leav it unconfigured

* Control message sent to and processed by the cml-daemon on the device.

• required ControllerToDaemon.Command command = 1

• repeated string container_uuids = 10

  Container

  container UUID(s) for GET_CONTAINER_* and CONTAINER_*

• optional ContainerStartParams container_start_params = 11

  start parameters for CONTAINER_START

• optional AssignInterfaceParams assign_iface_params = 12

  parameter for CONTAINER_ASSIGNIFACE / CONTAINER_UNASSIGNIFACE

• optional bytes container_config_file = 13

  new container config for CREATE_CNTAINER

• optional bytes guestos_config_file = 20

  Daemon

  new/updated GuestOS config for PUSH_GUESTOS_CONFIG

• optional bytes guestos_config_signature = 21

  signature of the GuestOS config file

• optional bytes guestos_config_certificate = 22

  sw signing certificate to verify the signature on the config file

//////////////////////////////////////////// Commands (global) that query information // ////////////////////////////////////////////

Used in: ControllerToDaemon

• LIST_GUESTOS_CONFIGS = 1

  Responds with [guestos_configs] which includes a list of all GuestOS configs installed on the device.

  -> [guestos_configs]

• LIST_CONTAINERS = 2

  Responds with [container_uuid] with the UUIDs of all containers available on the device.

  -> [container_uuid]

• GET_CONTAINER_STATUS = 3

  Responds [container_status] with the ContainerStatus for each specified container in [container_uuid], or for all containers if [container_uuid] is empty.

  [container_uuid] -> [container_status]

• GET_CONTAINER_CONFIG = 4

  Responds [container_config] with the ContainerStatus for each specified container in [container_uuid], or for all containers if [container_uuid] is empty. Also fills [container_uuids] with the corresponding container UUIDs.

  [container_uuid] -> [container_config]

• GET_LAST_LOG = 5

  Returns /proc/last_kmsg and /dev/log/main (line by line). This is a debugging feature!

• GET_CONTAINER_PID = 6

  Returns a namespace PID for the given container UUID

• OBSERVE_STATUS_START = 10

  Starts or stops observing the status. TODO not implemented yet

• OBSERVE_STATUS_STOP = 11

• OBSERVE_LOG_START = 14

  Starts or stops observing log messages.

• OBSERVE_LOG_STOP = 15

• PUSH_GUESTOS_CONFIG = 20

  Push new GuestOS config. Needs [guestos_config_*]. Images will be updated later.

• RELOAD_CONTAINERS = 21

  Reloads containers from config files, e.g. if a new container should be created

• CREATE_CONTAINER = 22

  Creates a container, answers with CONTAINER_CONFIGS

• REMOVE_CONTAINER = 23

  Removes container config and destroys created container image files

• WIPE_DEVICE = 30

  Wipes the entire device (i.e. all containers) TODO: Only wipes containers, not e.g. GuestOSes and device.conf.

• CONTAINER_START = 101

  Starts a container. Also needs [start_params].

• CONTAINER_STOP = 102

  Stops a container.

• CONTAINER_SWITCH = 103

  Switches to a container.

• CONTAINER_FREEZE = 104

  Freezes a container.

• CONTAINER_UNFREEZE = 105

  Unfreezes a container.

• CONTAINER_WIPE = 106

  Wipes a container.

• CONTAINER_SNAPSHOT = 107

  TODO

• CONTAINER_ALLOWAUDIO = 108

• CONTAINER_DENYAUDIO = 109

• CONTAINER_ASSIGNIFACE = 110

  Assigns a network interface to a container. Also needs [assign_iface_params]

• CONTAINER_UNASSIGNIFACE = 111

  Unassigns a network interface from a container. Also needs [assign_iface_params]

• CONTAINER_LIST_IFACES = 112

  List network interfaces assigned to a container

* Control message sent from the cml-daemon on the device to the backend/cmdline tool/etc. TODO: Maybe (but only maybe) use separate messages for the different endpoints.

• required DaemonToController.Code code = 1

• repeated GuestOSConfig guestos_configs = 5

  GuestOS configs for LIST_GUESTOS_CONFIGS

• repeated string container_uuids = 6

  UUIDs for LIST_CONTAINERS

• repeated ContainerStatus container_status = 7

  ContainerStatus(es) for GET_CONTAINER_STATUS

• repeated ContainerConfig container_configs = 8

  ContainerConfig(s) for GET_CONTAINER_CONFIG

• repeated string container_ifaces = 9

  Container network interface(s) for CONTAINER_LIST_IFACES

• optional uint32 container_pid = 10

  PID of the container's namespace

• optional LogMessage log_message = 12

  log message received because of OBSERVE_LOG_START

• optional DaemonToController.Response response = 13

• optional string device_uuid = 200

  Device UUID for LOGON_DEVICE and LOG_MESSAGE

• optional string logon_hardware_name = 201

  Hardware name (e.g. "i9505", "hammerhead", ...) for LOGON_DEVICE

• optional string logon_hardware_serial = 202

  Hardware serial number for LOGON_DEVICE

• optional string logon_imei = 203

  IMEI for LOGON_DEVICE

• optional string logon_mac_address = 204

  MAC address for LOGON_DEVICE

• optional string logon_phone_number = 205

  Phone number for LOGON_DEVICE

Push info to other endpoint:

Used in: DaemonToController

• GUESTOS_CONFIGS_LIST = 1

  -> [guestos_config]

• CONTAINERS_LIST = 2

  -> [container_uuid]

• CONTAINER_STATUS = 3

  -> [container_status]

• CONTAINER_CONFIG = 4

  -> [container_config], [container_uuids]

• CONTAINER_IFACES = 5

  -> [container_ifaces]

• CONTAINER_PID = 6

  -> [container_pid]

• STATUS_CHANGED = 10

  -> [log_message]

• NOTIFICATION = 11

  -> [log_message]

• LOG_MESSAGE = 12

  -> [log_message]

• RESPONSE = 13

  -> [response]

• LOGON_DEVICE = 200

  Log-on the device onto the backend (not applicable for cmdline tool).

  [device_uuid] ->

Used in: DaemonToController

• CONTAINER_START_OK = 1

• CONTAINER_START_LOCK_FAILED = 2

• CONTAINER_START_UNLOCK_FAILED = 3

• CONTAINER_START_PASSWD_WRONG = 4

• CONTAINER_START_LOCKED_TILL_REBOOT = 5

• CONTAINER_START_EEXIST = 6

Used in: DaemonToController

• required string name = 1

  The following three fields together should UNIQUELY identify the actual guestos image files and config:

  unique name of the operating system

• required string hardware = 2

  target hardware; must match hardware_get_name(), e.g. "i9505", etc.

• required uint64 version = 3

  TODO version string OR major.minor-suffix? ("RC1", "beta", etc.)

  version string for the guest OS

• repeated GuestOSMount mounts = 5

  list of mounts inside the container

• optional string init_path = 6

  path to the init binary, e.g. "/init"

• repeated string init_param = 7

  parameters (argv) for init

• repeated string init_env = 8

  environment variables

• repeated GuestOSMount mounts_setup = 9

  list of mounts for setup mode of a container

• optional bool feature_phone = 20

  Flags indicating the features supported by the OS:

• optional bool feature_bluetooth = 21

• optional bool feature_wifi = 22

• optional bool feature_mobile_data = 23

• optional bool feature_sensors = 24

• optional bool feature_camera = 25

• optional bool feature_audio = 26

• optional bool feature_bg_booting = 27

• optional bool feature_vpn = 28

• optional bool feature_devtmpfs = 29

  TODO: add further features as necessary

• optional uint32 min_ram_limit = 30

  TODO: Determine RAM limit policy...

  required minimum RAM size (MBytes)

• optional uint32 def_ram_limit = 32

  default RAM size (MBytes)

• required I18NString description = 10

  Descriptive information (for GUI):

  description/full name

• optional I18NString description_long = 11

  help text

• optional string upstream_version = 12

  upstream version

• optional bytes icon = 13

  name of icon file

• optional string build_date = 14

  build date

Represents a single mount point/image provided by the GuestOS

Used in: GuestOSConfig

• required string image_file = 1

  Path for the image files is derived from guestos_path/guestos_name.

  name of the image file, e.g. system

• required string mount_point = 2

  mountpoint inside the container

• required string fs_type = 3

  file system type, e.g. "ext4"

• required GuestOSMount.Type mount_type = 4

  type of the image file

• optional uint32 min_size = 6

  The following three fields are only used for EMPTY mount types:

  required minimum size (MBytes) for EMPTY partition

• optional uint32 max_size = 7

  allowed maximum size (MBytes) for EMPTY partition

• optional uint32 def_size = 8

  default size (MBytes) for EMPTY partition

• optional uint64 image_size = 10

  The following two fields are only used when an actual image file is provided:

  size (bytes) of the image

• optional string image_sha1 = 11

  hash(es) of image file

• optional string image_sha2_256 = 12

  TODO add further hashes as necessary

• optional string mount_data = 13

  mount_data used for mount syscall, e.g. "context=" for selinux

Used in: GuestOSMount

• SHARED = 1

  image shared by all containers of same OS type

• DEVICE = 2

  image file is copied from a device partition

• DEVICE_RW = 3

  image file is copied from a device partition

• EMPTY = 4

  empty, created when a corresponding container is first instantiated

• COPY = 5

  deprecated

• FLASH = 6

  image to be flashed to a partition (e.g. boot.img; base system updates only for now)

• SHARED_DATA = 7

  image shared between different containers and OSs

• OVERLAY_RO = 8

  read only overlay images e.g. for system features

• SHARED_RW = 9

  image shared by all containers of same OS type (writable tmpfs as overlay)

• OVERLAY_RW = 10

  similar to EMPTY image, however overlayed on given mount_point (writable persitent fs as overlay)

(English) string with optional translations in other languages

Used in: GuestOSConfig

• required string en = 1

• optional string de = 2

• optional string fr = 3

  TODO: add other languages as necessary...

Used in: DaemonToController

• required LogPriority prio = 1

• required string msg = 2

Used in: LogMessage

• TRACE = 1

• DEBUG = 2

• INFO = 3

• WARN = 4

• ERROR = 5

• FATAL = 6

• SILENT = 7