fuchsia.sys2

PROTOCOLS

ConfigOverride

Defined in fuchsia.sys2/realm.fidl

Manages structured configuration override values for components.

SetStructuredConfig

Sets structured configuration fields with override values for the component instance identified by moniker.

Request

Name	Type
moniker	string:4096
fields	vector<fuchsia.component.decl/ConfigOverride>

Response

Name	Type
payload	ConfigOverride_SetStructuredConfig_Result

UnsetStructuredConfig

Unsets structured configuration overrides for the component instance identified by moniker. If an empty moniker is supplied, then all structured configuration overrides will be cleared.

Request

Name	Type
moniker	string:4096

Response

Name	Type
payload	ConfigOverride_UnsetStructuredConfig_Result

CrashIntrospect

Defined in fuchsia.sys2/crash_introspect.fidl

When a thread from a component using the ELF runner crashes, the thread koid along with other information is stored. This protocol can be used to retrieve that stored information.

FindComponentByThreadKoid

Given a thread koid, returns the information that was stored when the ELF runner observed a crash from that thread.

The information for a crash is deleted when it is accessed or when 10 minutes have passed, whichever comes first.

If there is no information available on the given thread koid, zx::Status::NOT_FOUND is returned.

Request

Name	Type
thread_koid	zx/Koid

Response

Name	Type
payload	CrashIntrospect_FindComponentByThreadKoid_Result

InstanceIterator

Defined in fuchsia.sys2/realm.fidl

An iterator over all instances in the realm

Next

Request

<EMPTY>

Response

Name	Type
infos	vector<Instance>

LifecycleController

Defined in fuchsia.sys2/lifecycle_controller.fidl

Mutates the component instance state in a realm.

CreateInstance

Creates a new child instance identified by the given moniker. Relative monikers must start with "./".

The function returns once the child instance has been added to the topology.

Request

Name	Type
parent_moniker	string:4096
collection	fuchsia.component.decl/CollectionRef
decl	fuchsia.component.decl/Child
args	fuchsia.component/CreateChildArgs

Response

Name	Type
payload	LifecycleController_CreateInstance_Result

DestroyInstance

Destroys the instance identified by the given moniker. Relative monikers must start with "./".

The function returns once the child instance no longer exists in the topology.

Request

Name	Type
parent_moniker	string:4096
child	fuchsia.component.decl/ChildRef

Response

Name	Type
payload	LifecycleController_DestroyInstance_Result

ResolveInstance

Resolves the instance identified by the given moniker. Relative monikers must start with "./".

The function returns once the instance has been resolved.

Request

Name	Type
moniker	string:4096

Response

Name	Type
payload	LifecycleController_ResolveInstance_Result

StartInstance

Starts the instance identified by the given moniker. Relative monikers must start with "./".

The client can pass in the server end of a channel for the fuchsia.component.Binder protocol. This protocol will notify the client when the instance has stopped.

The function returns once the instance has been started. Calling StartInstance() when the instance is already running is a no-op, but it will connect the Binder channel if a valid handle is provided.

Request

Name	Type
moniker	string:4096
binder	server_end:fuchsia.component/Binder

Response

Name	Type
payload	LifecycleController_StartInstance_Result

StartInstanceWithArgs

Request

Name	Type
moniker	string:4096
binder	server_end:fuchsia.component/Binder
args	fuchsia.component/StartChildArgs

Response

Name	Type
payload	LifecycleController_StartInstanceWithArgs_Result

StopInstance

Stops the instance identified by the given moniker. Relative monikers must start with "./".

The function returns once the instance has been stopped.

Request

Name	Type
moniker	string:4096

Response

Name	Type
payload	LifecycleController_StopInstance_Result

UnresolveInstance

Unresolves the component designated by the provided moniker. Relative monikers must start with "./".

The function returns once the instance has been unresolved.

Request

Name	Type
moniker	string:4096

Response

Name	Type
payload	LifecycleController_UnresolveInstance_Result

ManifestBytesIterator

Defined in fuchsia.sys2/realm.fidl

An iterator over the bytes of an instance's manifest

Next

Request

<EMPTY>

Response

Name	Type
infos	vector<uint8>

RealmExplorer

Defined in fuchsia.sys2/realm.fidl

Offers basic introspection into component instances under a realm.

RealmQuery

Defined in fuchsia.sys2/realm.fidl

Offers detailed introspection into component instances under a realm.

ConnectToStorageAdmin

Connects to the StorageAdmin protocol of a storage declared by an instance.

Request

Name	Type
moniker	string:4096
storage_name	fuchsia.component.decl/name
server_end	server_end:StorageAdmin

Response

Name	Type
payload	RealmQuery_ConnectToStorageAdmin_Result

ConstructNamespace

Constructs the namespace of an instance as determined by its use declarations. This is usually identical to what would be given to the component's runner on component start time, unless extended by fuchsia.component/StartChildArgs.namespace_entries.

Request

Name	Type
moniker	string:4096

Response

Name	Type
payload	RealmQuery_ConstructNamespace_Result

DeprecatedOpen

[DEPRECATED - Use OpenDirectory instead.]

Makes an fuchsia.io.Directory/Open call on a directory in an instance.

Request

Name	Type
moniker	string:4096
dir_type	OpenDirType
flags	fuchsia.io/OpenFlags
mode	fuchsia.io/ModeType
path	string:4095
object	server_end:fuchsia.io/Node

Response

Name	Type
payload	RealmQuery_DeprecatedOpen_Result

GetAllInstances

Returns an iterator over all component instances in this realm and instances within resolved children, recursively. Unresolved child components will be included in this list, but children of unresolved children will not be.

Request

<EMPTY>

Response

Name	Type
payload	RealmQuery_GetAllInstances_Result

GetInstance

Gets an instance identified by its moniker.

Request

Name	Type
moniker	string:4096

Response

Name	Type
payload	RealmQuery_GetInstance_Result

GetManifest

Prefer GetResolvedDeclaration if available for your target API level.

Request

Name	Type
moniker	string:4096

Response

Name	Type
payload	RealmQuery_GetManifest_Result

GetResolvedDeclaration

Gets the manifest of an instance identified by its moniker.

The manifest is encoded in its standalone persistable format per RFC-0120 and is sent across using an iterator. Some manifests are too large to send over a Zircon channel and we can't use a VMO because we need an approach that is compatible with overnet.

Request

Name	Type
moniker	string:4096

Response

Name	Type
payload	RealmQuery_GetResolvedDeclaration_Result

GetStructuredConfig

Gets the structured config of an instance identified by its moniker.

Request

Name	Type
moniker	string:4096

Response

Name	Type
payload	RealmQuery_GetStructuredConfig_Result

OpenDirectory

Opens the specified directory in an instance.

Request

Name	Type
moniker	string:4096
dir_type	OpenDirType
object	server_end:fuchsia.io/Directory

Response

Name	Type
payload	RealmQuery_OpenDirectory_Result

ResolveDeclaration

Gets the manifest of a component URL as if it were a child of the specified parent without actually creating or starting that component.

The manifest is encoded in its standalone persistable format per RFC-0120 and is sent across using an iterator. Some manifests are too large to send over a Zircon channel and we can't use a VMO because we need an approach that is compatible with overnet.

Request

Name	Type
parent	string:4096
child_location	ChildLocation
url	fuchsia.url/Url

Response

Name	Type
payload	RealmQuery_ResolveDeclaration_Result

RouteValidator

Defined in fuchsia.sys2/route_validator.fidl

Route

Routes a component's used or exposed capabilities, and returns information about them.

If targets is empty, returns results for all the component's used and exposed capabilities. Otherwise, returns only results for capabilities specified in targets.

This method only supports routing namespace capabilities (protocols, directories, services, and storage).

Errors:

• INVALID_ARGUMENTS: The given moniker or name is not valid, or name is not a namespace capability.
• INSTANCE_NOT_FOUND: No instance was found matching the given moniker.
• RESOURCE_NOT_FOUND: No capability was found matching one of the given names.

Request

Name	Type
moniker	string:4096
targets	vector<RouteTarget>

Response

Name	Type
payload	RouteValidator_Route_Result

Validate

Routes all incoming and exposed capabilities of a component identified by the given moniker. If the routing failed, an error is returned in the response. This function may cause components to be resolved.

Errors:

• INVALID_ARGUMENTS: The given moniker is not valid.
• INSTANCE_NOT_FOUND: No instance was found matching the given moniker.

Request

Name	Type
moniker	string:4096

Response

Name	Type
payload	RouteValidator_Validate_Result

StorageAdmin

Defined in fuchsia.sys2/storage_admin.fidl

DeleteAllStorageContents

Deletes the contents of all the storage. Storage directories are retained so any components using storage will be able to continue using it to create new files and directories. Returns fuchsia.component.Error::INTERNAL only if no storage at all could be cleared. Returns successfully even if some errors happen during the deletion progress.

Request

<EMPTY>

Response

Name	Type
payload	StorageAdmin_DeleteAllStorageContents_Result

DeleteComponentStorage

Deletes the contents of the storage for this component. The moniker can be a regular moniker (ie, "foo/bar") or a moniker with internal instance IDs (unusual, ie, "foo:0/bar:0"). Preserves the component's subdirectory itself within the storage backing directory.

Request

Name	Type
relative_moniker	string:4096

Response

Name	Type
payload	StorageAdmin_DeleteComponentStorage_Result

DeprecatedOpenComponentStorage

[DEPRECATED - Use OpenStorage instead.]

Opens the isolated directory for the given component. The open request will provision the storage if it hasn't been already.

Request

Name	Type
relative_moniker	string:4096
flags	fuchsia.io/OpenFlags
mode	fuchsia.io/ModeType
object	server_end:fuchsia.io/Node

GetStatus

Get the current status of the storage.

Request

<EMPTY>

Response

Name	Type
payload	StorageAdmin_GetStatus_Result

ListStorageInRealm

Lists the descendant components under the specified realm that use the storage capability. Returns INSTANCE_NOT_FOUND if the realm does not exist, and INVALID_ARGS if |relative_moniker| is malformed.

Request

Name	Type
relative_moniker	string:4096
iterator	server_end:StorageIterator

Response

Name	Type
payload	StorageAdmin_ListStorageInRealm_Result

OpenComponentStorageById

Opens the isolated directory for the given storage ID. The open request will provision the storage if it hasn't been already.

Request

Name	Type
id	string:64
object	server_end:fuchsia.io/Node

Response

Name	Type
payload	StorageAdmin_OpenComponentStorageById_Result

OpenStorage

Opens the isolated directory for the given component. The open request will provision the storage if it hasn't been already.

Request

Name	Type
relative_moniker	string:4096
object	server_end:fuchsia.io/Node

Response

Name	Type
payload	StorageAdmin_OpenStorage_Result

StorageIterator

Defined in fuchsia.sys2/storage_admin.fidl

An iterator protocol for returning a set of components using a storage capability. See |StorageAdmin.ListStorageInRealm| for more information.

Next

Retrieve the next set of components using the storage capability. The returned monikers are relative to the component that declares the storage capability. Returns an empty vector after all components have been returned.

Request

<EMPTY>

Response

Name	Type
relative_monikers	vector<string:4096>

SystemController

Defined in fuchsia.sys2/system_controller.fidl

An interface implemented by ComponentManager that requests the ComponentManager stop all components and exit.

Shutdown

Stop all components, return an empty result, close this protocol's channel, and exit ComponentManager. If this is the root ComponentManager is exited we expect the system will reboot.

Request

<EMPTY>

Response

<EMPTY>

STRUCTS

ConfigOverride_SetStructuredConfig_Response

Defined in fuchsia.sys2/realm.fidl

<EMPTY>

ConfigOverride_UnsetStructuredConfig_Response

Defined in fuchsia.sys2/realm.fidl

<EMPTY>

CrashIntrospect_FindComponentByThreadKoid_Response

Defined in fuchsia.sys2/crash_introspect.fidl

Field	Type	Description	Default
info	ComponentCrashInfo		No default

LifecycleController_CreateInstance_Response

Defined in fuchsia.sys2/lifecycle_controller.fidl

<EMPTY>

LifecycleController_DestroyInstance_Response

Defined in fuchsia.sys2/lifecycle_controller.fidl

<EMPTY>

LifecycleController_ResolveInstance_Response

Defined in fuchsia.sys2/lifecycle_controller.fidl

<EMPTY>

LifecycleController_StartInstanceWithArgs_Response

Defined in fuchsia.sys2/lifecycle_controller.fidl

<EMPTY>

LifecycleController_StartInstance_Response

Defined in fuchsia.sys2/lifecycle_controller.fidl

<EMPTY>

LifecycleController_StopInstance_Response

Defined in fuchsia.sys2/lifecycle_controller.fidl

<EMPTY>

LifecycleController_UnresolveInstance_Response

Defined in fuchsia.sys2/lifecycle_controller.fidl

<EMPTY>

RealmQuery_ConnectToStorageAdmin_Response

Defined in fuchsia.sys2/realm.fidl

<EMPTY>

RealmQuery_ConstructNamespace_Response resource

Defined in fuchsia.sys2/realm.fidl

Field	Type	Description	Default
namespace	vector<fuchsia.component.runner/ComponentNamespaceEntry>	The directory handles + paths that constitute the component's namespace.	No default

RealmQuery_DeprecatedOpen_Response

Defined in fuchsia.sys2/realm.fidl

<EMPTY>

RealmQuery_GetAllInstances_Response resource

Defined in fuchsia.sys2/realm.fidl

Field	Type	Description	Default
iterator	client_end:InstanceIterator		No default

RealmQuery_GetInstance_Response

Defined in fuchsia.sys2/realm.fidl

Field	Type	Description	Default
instance	Instance		No default

RealmQuery_GetManifest_Response resource

Defined in fuchsia.sys2/realm.fidl

Field	Type	Description	Default
iterator	client_end:ManifestBytesIterator		No default

RealmQuery_GetResolvedDeclaration_Response resource

Defined in fuchsia.sys2/realm.fidl

Field	Type	Description	Default
iterator	client_end:ManifestBytesIterator		No default

RealmQuery_GetStructuredConfig_Response

Defined in fuchsia.sys2/realm.fidl

Field	Type	Description	Default
config	fuchsia.component.decl/ResolvedConfig		No default

RealmQuery_OpenDirectory_Response

Defined in fuchsia.sys2/realm.fidl

<EMPTY>

RealmQuery_ResolveDeclaration_Response resource

Defined in fuchsia.sys2/realm.fidl

Field	Type	Description	Default
iterator	client_end:ManifestBytesIterator		No default

RouteTarget

Defined in fuchsia.sys2/route_validator.fidl

A capability in a target component to route to the source.

Field	Type	Description	Default
name	fuchsia.component/name	The capability name to match (this is not the path). Supports fuzzy matching by substring.	No default
decl_type	DeclType	Whether the capability is a used by the component or exposed from it.	No default

RouteValidator_Route_Response

Defined in fuchsia.sys2/route_validator.fidl

Field	Type	Description	Default
reports	vector<RouteReport>		No default

RouteValidator_Validate_Response

Defined in fuchsia.sys2/route_validator.fidl

Field	Type	Description	Default
reports	vector<RouteReport>		No default

StorageAdmin_DeleteAllStorageContents_Response

Defined in fuchsia.sys2/storage_admin.fidl

<EMPTY>

StorageAdmin_DeleteComponentStorage_Response

Defined in fuchsia.sys2/storage_admin.fidl

<EMPTY>

StorageAdmin_ListStorageInRealm_Response

Defined in fuchsia.sys2/storage_admin.fidl

<EMPTY>

StorageAdmin_OpenComponentStorageById_Response

Defined in fuchsia.sys2/storage_admin.fidl

<EMPTY>

StorageAdmin_OpenStorage_Response

Defined in fuchsia.sys2/storage_admin.fidl

<EMPTY>

ENUMS

ConfigOverrideError flexible

Type: uint32

Defined in fuchsia.sys2/realm.fidl

Errors that can be returned by the ConfigOverride protocol.

Name	Value	Description
INSTANCE_NOT_FOUND	1	Could not find an instance matching the given moniker.
BAD_MONIKER	2	The given moniker could not be parsed.
INSTANCE_NOT_RESOLVED	3	The given moniker matches an instance, but the instance is not resolved.
NO_CONFIG	4	There is no structured configuration associated with this instance.
KEY_NOT_FOUND	5	Could not find a structured configuration field with the given key.

ConnectToStorageAdminError flexible

Type: uint32

Defined in fuchsia.sys2/realm.fidl

Errors that can be returned by the ConnectToStorageAdmin call.

Name	Value	Description
INSTANCE_NOT_FOUND	1	Could not find an instance matching the given moniker.
BAD_MONIKER	2	The given moniker could not be parsed.
STORAGE_NOT_FOUND	3	The instance does not define a storage capability with the given name.
INSTANCE_NOT_RESOLVED	4	This operation requires the instance to be resolved.
BAD_CAPABILITY	5	The given storage capability could not be parsed.

ConstructNamespaceError flexible

Type: uint32

Defined in fuchsia.sys2/realm.fidl

Errors that can be returned by the ConstructNamespace call.

Name	Value	Description
INSTANCE_NOT_FOUND	1	Could not find an instance matching the given moniker.
BAD_MONIKER	2	The given moniker could not be parsed.
INSTANCE_NOT_RESOLVED	3	Namespace construction requires the instance to be resolved.

CreateError flexible

Type: uint32

Defined in fuchsia.sys2/lifecycle_controller.fidl

Name	Value	Description
INTERNAL	1
INSTANCE_NOT_FOUND	2
INSTANCE_ALREADY_EXISTS	3
BAD_MONIKER	4
BAD_CHILD_DECL	5
COLLECTION_NOT_FOUND	6
BAD_DYNAMIC_OFFER	7
DYNAMIC_OFFERS_FORBIDDEN	8
EAGER_STARTUP_FORBIDDEN	9	Removed: 19
NUMBERED_HANDLES_FORBIDDEN	10

DeclType flexible

Type: uint32

Defined in fuchsia.sys2/route_validator.fidl

Name	Value	Description
USE	1	The capability comes from a use declaration in the component's manifest. It will be available in the namespace of the component instance.
EXPOSE	2	The capability comes from an expose declaration in the component's manifest.
ANY	3	A capability that could be either a use or expose declaration. Used in inputs only, for fuzzy matching.

DeletionError strict

Type: uint32

Defined in fuchsia.sys2/storage_admin.fidl

Name	Value	Description
CONNECTION	1	There was an error sending a request to the storage provider.
PROTOCOL	2	The storage provider returned an error in response to a protocol request.
NONE_AVAILABLE	3	There was no storage available for deletion.
UNSUPPORTED	4	This call is not supported.

DestroyError flexible

Type: uint32

Defined in fuchsia.sys2/lifecycle_controller.fidl

Name	Value	Description
INTERNAL	1
INSTANCE_NOT_FOUND	2
BAD_MONIKER	3
BAD_CHILD_REF	4
INSTANCE_NOT_RESOLVED	5	Added: 20

GetAllInstancesError flexible

Type: uint32

Defined in fuchsia.sys2/realm.fidl

Errors that can be returned by the GetAllInstances call.

Name	Value	Description
INSTANCE_NOT_FOUND	1	Could not find the scope root instance.

GetDeclarationError flexible

Type: uint32

Defined in fuchsia.sys2/realm.fidl

Errors that can be returned by the GetManifest call.

Name	Value	Description
INSTANCE_NOT_FOUND	1	Could not find an instance matching the given moniker.
BAD_MONIKER	2	The given moniker could not be parsed.
INSTANCE_NOT_RESOLVED	3	The component manifest is only available when the instance is resolved.
ENCODE_FAILED	4	The component manifest could not be encoded into its persistable format.
BAD_CHILD_LOCATION	5	The specified collection was not found in the specified component. Added: 12
BAD_URL	6	The specified URL could not be parsed. Added: 12

GetInstanceError flexible

Type: uint32

Defined in fuchsia.sys2/realm.fidl

Errors that can be returned by the GetInstance call.

Name	Value	Description
INSTANCE_NOT_FOUND	1	Could not find an instance matching the given moniker.
BAD_MONIKER	2	The given moniker could not be parsed.

GetStructuredConfigError flexible

Type: uint32

Defined in fuchsia.sys2/realm.fidl

Errors that can be returned by the GetStructuredConfig call.

Name	Value	Description
INSTANCE_NOT_FOUND	1	Could not find an instance matching the given moniker.
BAD_MONIKER	2	The given moniker could not be parsed.
INSTANCE_NOT_RESOLVED	3	The component manifest is only available when the instance is resolved.
NO_CONFIG	4	There is no structured configuration associated with this instance.

OpenDirType flexible

Type: uint32

Defined in fuchsia.sys2/realm.fidl

The directories of an instance that can be opened by component manager.

Name	Value	Description
OUTGOING_DIR	1	Served by the component's program. Rights unknown.
RUNTIME_DIR	2	Served by the component's runner. Rights unknown.
PACKAGE_DIR	3	Served by the component's resolver. Rights unknown.
EXPOSED_DIR	4	Served by component manager. Directory has RW rights.
NAMESPACE_DIR	5	Served by component manager. Directory has RW rights.

OpenError flexible

Type: uint32

Defined in fuchsia.sys2/realm.fidl

Errors that can be returned by the OpenDirectory call.

Name	Value	Description
INSTANCE_NOT_FOUND	1	Could not find an instance matching the given moniker.
BAD_MONIKER	2	The given moniker could not be parsed.
INSTANCE_NOT_RESOLVED	3	The requested directory is available when the instance is resolved.
INSTANCE_NOT_RUNNING	4	The requested directory is available when the instance is running. Deprecation: the platform will stop emitting this error from version 19. The component will always be started if not already. Deprecated: 19
FIDL_ERROR	5	Component manager's open request on the directory returned a FIDL error.
NO_SUCH_DIR	6	The instance does not have a directory of this type.
BAD_DIR_TYPE	7	The given directory type could not be parsed.
BAD_PATH	8	The given path could not be parsed by component manager. Removed: 25
INSTANCE_FAILED_TO_START	9	Serving the requested directory requires starting the instance, but the instance failed to start. Removed: 25 Added: 19
INSTANCE_DESTROYED	10	Instance matching moniker was destroyed. Added: 25

RealmQueryError flexible

Type: uint32

Defined in fuchsia.sys2/realm.fidl

Errors that can be returned by the RealmQuery API.

Name	Value	Description
INSTANCE_NOT_FOUND	1	Could not find an instance matching the given moniker.
BAD_MONIKER	2	The given moniker could not be parsed.

ResolveError flexible

Type: uint32

Defined in fuchsia.sys2/lifecycle_controller.fidl

Name	Value	Description
INTERNAL	1
INSTANCE_NOT_FOUND	2
BAD_MONIKER	3
PACKAGE_NOT_FOUND	4
MANIFEST_NOT_FOUND	5
POLICY_ERROR	6	Added: 19

RouteOutcome flexible

Type: uint32

Defined in fuchsia.sys2/route_validator.fidl

Name	Value	Description
SUCCESS	1	Routing succeeded and returned a capability. Added: 24
VOID	2	Routing terminated in a void source. This is a form of success but it's exposed as its own state so tooling can report it. Added: 24
FAILED	3	Routing failed. This will be the state iff RouteReport.error is set. Added: 24

RouteValidatorError flexible

Type: uint32

Defined in fuchsia.sys2/route_validator.fidl

Errors for RouteValidator

Name	Value	Description
INTERNAL	1	An unexpected error occurred.
INVALID_ARGUMENTS	2	At least one argument had an invalid format.
INSTANCE_NOT_FOUND	3	The component instance was not found.
INSTANCE_NOT_RESOLVED	4	The component instance was not resolved.

StartError flexible

Type: uint32

Defined in fuchsia.sys2/lifecycle_controller.fidl

Name	Value	Description
INTERNAL	1
INSTANCE_NOT_FOUND	2
BAD_MONIKER	3
PACKAGE_NOT_FOUND	4
MANIFEST_NOT_FOUND	5
POLICY_ERROR	6	Added: 19
INVALID_ARGUMENTS	7	Added: HEAD

StatusError strict

Type: uint32

Defined in fuchsia.sys2/storage_admin.fidl

Name	Value	Description
PROVIDER	1	The storage provider returned an error to a request or the connection to the provider unexpectedly closed.
RESPONSE_INVALID	2	Information returned by the storage provider appears to be invalid.
STATUS_UNKNOWN	3	A call to the storage provider succeeded, but it returned unexpectedly empty data.
UNSUPPORTED	4	This call is not supported.

StopError flexible

Type: uint32

Defined in fuchsia.sys2/lifecycle_controller.fidl

Name	Value	Description
INTERNAL	1
INSTANCE_NOT_FOUND	2
BAD_MONIKER	3

UnresolveError flexible

Type: uint32

Defined in fuchsia.sys2/lifecycle_controller.fidl

Name	Value	Description
INTERNAL	1
INSTANCE_NOT_FOUND	2
BAD_MONIKER	3

TABLES

ComponentCrashInfo

Defined in fuchsia.sys2/crash_introspect.fidl

Information stored when a thread crashes.

Ordinal	Field	Type	Description
1	url	string:4096
2	moniker	string:4096

ExecutionInfo

Defined in fuchsia.sys2/realm.fidl

Information about the execution state of a component instance.

Ordinal	Field	Type	Description
1	start_reason	string:5000	The human-readable explanation for why this instance was started.

Instance

Defined in fuchsia.sys2/realm.fidl

Describes a component instance under a realm.

Note: This structure is expected to fit in a single Zircon channel message. Do not add fields that have the potential to violate that constraint. Prefer to create dedicated methods and iterators instead.

Ordinal	Field	Type	Description
1	moniker	string:4096	The path to this instance relative to the scope root.
2	url	fuchsia.url/Url	The URL of the component manifest for this instance.
3	instance_id	string:64	The stable identifier for this instance, if one exists.
4	resolved_info	ResolvedInfo	Information about the resolved state of a component instance. If the component is not resolved, this field is not set.
5	environment	string:4096	The component's environment name as defined by its parent.

ResolvedInfo

Defined in fuchsia.sys2/realm.fidl

Information about the resolved state of a component instance.

Ordinal	Field	Type	Description
1	resolved_url	fuchsia.url/Url	The resolved URL of this instance.
2	execution_info	ExecutionInfo	Information about the execution state of a component instance. If the component is not running, this field is not set.

RouteError

Defined in fuchsia.sys2/route_validator.fidl

Routing error for a particular capability.

Ordinal	Field	Type	Description
1	summary	string	A human-readable explanation of the routing error.

RouteReport

Defined in fuchsia.sys2/route_validator.fidl

Routing result for a particular capability.

Ordinal	Field	Type	Description
1	capability	string	The capability whose routing was attempted.
2	decl_type	DeclType	Type of capability declaration
3	error	RouteError	Describes the error that occurred from routing this capability. This field is not present if routing succeeded.
4	source_moniker	string	The moniker of the source component. Added: 12
5	service_instances	vector<ServiceInstance>	Metadata about the instances in a service. Populated only for aggregated services. Added: 12
6	availability	fuchsia.component.decl/Availability	The requested level of availability of the capability. Added: HEAD
7	outcome	RouteOutcome	The overall outcome of routing. Added: 24

ServiceInstance

Defined in fuchsia.sys2/route_validator.fidl

Metadata about a service instance.

Ordinal	Field	Type	Description
1	instance_name	string	The name of the service instance in this service directory.
2	child_name	string	The name of the component that serves the service instance, including the collection name if the component is a child.
3	child_instance_name	string	The name of the service instance as exposed by the child.

StorageStatus

Defined in fuchsia.sys2/storage_admin.fidl

Metadata about status of the storage

Ordinal	Field	Type	Description
1	total_size	uint64
2	used_size	uint64

UNIONS

ChildLocation flexible

Defined in fuchsia.sys2/realm.fidl

Locations from which a child could be resolved under a given parent.

Ordinal	Variant	Type	Description
1	collection	string:255

ConfigOverride_SetStructuredConfig_Result strict

Defined in fuchsia.sys2/realm.fidl

Ordinal	Variant	Type	Description
1	response	ConfigOverride_SetStructuredConfig_Response
2	err	ConfigOverrideError
3	framework_err	internal

ConfigOverride_UnsetStructuredConfig_Result strict

Defined in fuchsia.sys2/realm.fidl

Ordinal	Variant	Type	Description
1	response	ConfigOverride_UnsetStructuredConfig_Response
2	err	ConfigOverrideError
3	framework_err	internal

CrashIntrospect_FindComponentByThreadKoid_Result strict

Defined in fuchsia.sys2/crash_introspect.fidl

Ordinal	Variant	Type	Description
1	response	CrashIntrospect_FindComponentByThreadKoid_Response
2	err	fuchsia.component/Error

LifecycleController_CreateInstance_Result strict

Defined in fuchsia.sys2/lifecycle_controller.fidl

Ordinal	Variant	Type	Description
1	response	LifecycleController_CreateInstance_Response
2	err	CreateError

LifecycleController_DestroyInstance_Result strict

Defined in fuchsia.sys2/lifecycle_controller.fidl

Ordinal	Variant	Type	Description
1	response	LifecycleController_DestroyInstance_Response
2	err	DestroyError

LifecycleController_ResolveInstance_Result strict

Defined in fuchsia.sys2/lifecycle_controller.fidl

Ordinal	Variant	Type	Description
1	response	LifecycleController_ResolveInstance_Response
2	err	ResolveError

LifecycleController_StartInstanceWithArgs_Result strict

Defined in fuchsia.sys2/lifecycle_controller.fidl

Ordinal	Variant	Type	Description
1	response	LifecycleController_StartInstanceWithArgs_Response
2	err	StartError

LifecycleController_StartInstance_Result strict

Defined in fuchsia.sys2/lifecycle_controller.fidl

Ordinal	Variant	Type	Description
1	response	LifecycleController_StartInstance_Response
2	err	StartError

LifecycleController_StopInstance_Result strict

Defined in fuchsia.sys2/lifecycle_controller.fidl

Ordinal	Variant	Type	Description
1	response	LifecycleController_StopInstance_Response
2	err	StopError

LifecycleController_UnresolveInstance_Result strict

Defined in fuchsia.sys2/lifecycle_controller.fidl

Ordinal	Variant	Type	Description
1	response	LifecycleController_UnresolveInstance_Response
2	err	UnresolveError

RealmQuery_ConnectToStorageAdmin_Result strict

Defined in fuchsia.sys2/realm.fidl

Ordinal	Variant	Type	Description
1	response	RealmQuery_ConnectToStorageAdmin_Response
2	err	ConnectToStorageAdminError

RealmQuery_ConstructNamespace_Result strict resource

Defined in fuchsia.sys2/realm.fidl

Ordinal	Variant	Type	Description
1	response	RealmQuery_ConstructNamespace_Response
2	err	ConstructNamespaceError

RealmQuery_DeprecatedOpen_Result strict

Defined in fuchsia.sys2/realm.fidl

Ordinal	Variant	Type	Description
1	response	RealmQuery_DeprecatedOpen_Response
2	err	OpenError

RealmQuery_GetAllInstances_Result strict resource

Defined in fuchsia.sys2/realm.fidl

Ordinal	Variant	Type	Description
1	response	RealmQuery_GetAllInstances_Response
2	err	GetAllInstancesError

RealmQuery_GetInstance_Result strict

Defined in fuchsia.sys2/realm.fidl

Ordinal	Variant	Type	Description
1	response	RealmQuery_GetInstance_Response
2	err	GetInstanceError

RealmQuery_GetManifest_Result strict resource

Defined in fuchsia.sys2/realm.fidl

Ordinal	Variant	Type	Description
1	response	RealmQuery_GetManifest_Response
2	err	GetDeclarationError

RealmQuery_GetResolvedDeclaration_Result strict resource

Defined in fuchsia.sys2/realm.fidl

Ordinal	Variant	Type	Description
1	response	RealmQuery_GetResolvedDeclaration_Response
2	err	GetDeclarationError

RealmQuery_GetStructuredConfig_Result strict

Defined in fuchsia.sys2/realm.fidl

Ordinal	Variant	Type	Description
1	response	RealmQuery_GetStructuredConfig_Response
2	err	GetStructuredConfigError

RealmQuery_OpenDirectory_Result strict

Defined in fuchsia.sys2/realm.fidl

Ordinal	Variant	Type	Description
1	response	RealmQuery_OpenDirectory_Response
2	err	OpenError

RealmQuery_ResolveDeclaration_Result strict resource

Defined in fuchsia.sys2/realm.fidl

Ordinal	Variant	Type	Description
1	response	RealmQuery_ResolveDeclaration_Response
2	err	GetDeclarationError

RouteValidator_Route_Result strict

Defined in fuchsia.sys2/route_validator.fidl

Ordinal	Variant	Type	Description
1	response	RouteValidator_Route_Response
2	err	RouteValidatorError

RouteValidator_Validate_Result strict

Defined in fuchsia.sys2/route_validator.fidl

Ordinal	Variant	Type	Description
1	response	RouteValidator_Validate_Response
2	err	fuchsia.component/Error

StorageAdmin_DeleteAllStorageContents_Result strict

Defined in fuchsia.sys2/storage_admin.fidl

Ordinal	Variant	Type	Description
1	response	StorageAdmin_DeleteAllStorageContents_Response
2	err	DeletionError

StorageAdmin_DeleteComponentStorage_Result strict

Defined in fuchsia.sys2/storage_admin.fidl

Ordinal	Variant	Type	Description
1	response	StorageAdmin_DeleteComponentStorage_Response
2	err	fuchsia.component/Error

StorageAdmin_GetStatus_Result strict

Defined in fuchsia.sys2/storage_admin.fidl

Ordinal	Variant	Type	Description
1	response	StorageStatus
2	err	StatusError

StorageAdmin_ListStorageInRealm_Result strict

Defined in fuchsia.sys2/storage_admin.fidl

Ordinal	Variant	Type	Description
1	response	StorageAdmin_ListStorageInRealm_Response
2	err	fuchsia.component/Error

StorageAdmin_OpenComponentStorageById_Result strict

Defined in fuchsia.sys2/storage_admin.fidl

Ordinal	Variant	Type	Description
1	response	StorageAdmin_OpenComponentStorageById_Response
2	err	fuchsia.component/Error

StorageAdmin_OpenStorage_Result strict

Defined in fuchsia.sys2/storage_admin.fidl

Ordinal	Variant	Type	Description
1	response	StorageAdmin_OpenStorage_Response
2	err	fuchsia.component/Error

CONSTANTS

Name	Value	Type	Description
MAX_INSTANCE_ID_LENGTH	64	uint32	The maximum length of an instance ID. An instance ID is a 256-bit identifier, which when encoded in hex notation is 64 characters long.
MAX_START_REASON	5000	uint32	The maximum length of the human-readable start reason. This accounts for StartReason::AccessCapability which can have a length of MAX_MONIKER_LENGTH + MAX_NAME_LENGTH + 26 (4222 characters).
MAX_STORAGE_ID_LENGTH	64	uint32	The maximum length of a storage instance ID. A storage instance ID is a 256-bit UUID, which when encoded in hex notation is 64 characters long.