fuchsia.starnix.runner

Added: HEAD

PROTOCOLS

Manager

Defined in fuchsia.starnix.runner/manager.fidl

ProxyWakeChannel

Creates a pass-through proxy that forwards messages between the container_channel and the remote_channel.

If any messages arrive on remote_channel while the container is suspended via SuspendContainer, the container will be resumed and resume_event will be signaled with ZX_EVENT_SIGNALED. Any suspend call that is made while that signal is present on resume_event will wake immediately. The container is responsible for clearing ZX_EVENT_SIGNALED.

Request

NameType
payload ManagerProxyWakeChannelRequest

RegisterWakeWatcher

Registers an eventpair that will be signaled when the container is suspended or resumed. The signals are ASLEEP(USER_1) and AWAKE(USER_0).

The kernel returns AWAKE upon initial registration of the eventpair.

Request

NameType
payload ManagerRegisterWakeWatcherRequest

Response

NameType
payload Manager_RegisterWakeWatcher_Result

Resume

Resumes all suspended Starnix kernels.

Request

NameType
payload ManagerResumeRequest

Suspend

Suspends all the running Starnix kernels. Returns after all processes have been suspended.

Request

NameType
payload ManagerSuspendRequest

Response

NameType
payload Manager_Suspend_Result

SuspendContainer

Suspends the container running in job.

The call will return successfully when wake_event has been signaled. Returns an error if wake_locks is signaled at the end of suspension, or an error is encountered when suspending the container's processes.

Request

NameType
payload ManagerSuspendContainerRequest

Response

NameType
payload Manager_SuspendContainer_Result

STRUCTS

Manager_RegisterWakeWatcher_Response

Defined in fuchsia.starnix.runner/manager.fidl

<EMPTY>

Manager_Suspend_Response

Defined in fuchsia.starnix.runner/manager.fidl

<EMPTY>

ENUMS

SuspendError flexible

Type: uint32

Defined in fuchsia.starnix.runner/manager.fidl

NameValueDescription
1
2

TABLES

ManagerProxyWakeChannelRequest resource

Defined in fuchsia.starnix.runner/manager.fidl

OrdinalFieldTypeDescription
container_job handle<job>

The job of the container that holds the other end of container_channel.

container_channel handle<channel>

The channel endpoint that is connected to the container.

remote_channel handle<channel>

The channel endpoint that is connected to a component outside the container.

resume_event handle<eventpair>

The event that will be signaled when a message appears on container_channel while the container is suspended.

name string:1024

The name of the proxy, used for debugging purposes.

ManagerRegisterWakeWatcherRequest resource

Defined in fuchsia.starnix.runner/manager.fidl

OrdinalFieldTypeDescription
watcher handle<eventpair>

The event that will be signaled when the container's wake status changes.

ManagerResumeRequest

Defined in fuchsia.starnix.runner/manager.fidl

OrdinalFieldTypeDescription

ManagerSuspendContainerRequest resource

Defined in fuchsia.starnix.runner/manager.fidl

OrdinalFieldTypeDescription
container_job handle<job>

The job of the container to suspend.

wake_locks handle<eventpair>

The event that is used to signal whether or not there are any active wake locks in the container.

ManagerSuspendRequest

Defined in fuchsia.starnix.runner/manager.fidl

OrdinalFieldTypeDescription

Manager_SuspendContainer_Response

Defined in fuchsia.starnix.runner/manager.fidl

OrdinalFieldTypeDescription
suspend_time zx/Duration

The amount of time spent in the suspend state.

It is used for tracking suspend stats in the Starnix kernel.

UNIONS

Manager_RegisterWakeWatcher_Result strict

Defined in fuchsia.starnix.runner/manager.fidl

OrdinalVariantTypeDescription
response Manager_RegisterWakeWatcher_Response
framework_err internal

Manager_SuspendContainer_Result strict

Defined in fuchsia.starnix.runner/manager.fidl

OrdinalVariantTypeDescription
response Manager_SuspendContainer_Response
err SuspendError
framework_err internal

Manager_Suspend_Result strict

Defined in fuchsia.starnix.runner/manager.fidl

OrdinalVariantTypeDescription
response Manager_Suspend_Response
framework_err internal

CONSTANTS

NameValueTypeDescription
PROXY_NAME_LEN 1024 uint32