class Node

class Node

Defined at line 191 of file ../../src/devices/bin/driver_manager/node.h

Public Methods

bool HasDriverComponent ()

NodeShutdownBridge

Exposed for testing.

Defined at line 222 of file ../../src/devices/bin/driver_manager/node.h

bool HasDriverComponentController ()

Defined at line 235 of file ../../src/devices/bin/driver_manager/node.h

bool is_bound ()

Defined at line 237 of file ../../src/devices/bin/driver_manager/node.h

void set_bound_for_testing (bool bound)

Exposed for testing.

Defined at line 245 of file ../../src/devices/bin/driver_manager/node.h

bool IsComposite ()

Defined at line 304 of file ../../src/devices/bin/driver_manager/node.h

void Node (std::string_view name, std::weak_ptr<Node> parent, NodeManager * node_manager, async_dispatcher_t * dispatcher)

Defined at line 312 of file ../../src/devices/bin/driver_manager/node.cc

void Node (std::string_view name, std::vector<std::weak_ptr<Node>> parents, std::vector<std::string> parents_names, NodeManager * node_manager, async_dispatcher_t * dispatcher, uint32_t primary_index)

Defined at line 329 of file ../../src/devices/bin/driver_manager/node.cc

zx::event DuplicatePowerToken ()

Returns a duplicate of the node's power element token, if available.

If the node has no power token, this will return an invalid zx::event.

Defined at line 333 of file ../../src/devices/bin/driver_manager/node.h

std::optional<zx::eventpair> TakeStartupLease ()

Defined at line 343 of file ../../src/devices/bin/driver_manager/node.h

void set_startup_lease_for_testing (std::optional<zx::eventpair> lease)

Exposed for testing.

Defined at line 346 of file ../../src/devices/bin/driver_manager/node.h

Node * GetPrimaryParent ()

Exposed for testing.

Defined at line 351 of file ../../src/devices/bin/driver_manager/node.h

void SetupDevfsForRootNode (std::shared_ptr<Devfs> & devfs)

This should be used on the root node. Install the root node at the top of the devfs filesystem.

Defined at line 363 of file ../../src/devices/bin/driver_manager/node.h

void AddToDevfsForTesting (Devnode & parent)

This is exposed for testing. Setup this node's devfs nodes.

Defined at line 368 of file ../../src/devices/bin/driver_manager/node.h

NodeState GetNodeState ()

Defined at line 380 of file ../../src/devices/bin/driver_manager/node.h

const std::string & name ()

Defined at line 382 of file ../../src/devices/bin/driver_manager/node.h

NodeType type ()

Defined at line 384 of file ../../src/devices/bin/driver_manager/node.h

const DriverHost * driver_host ()

Defined at line 388 of file ../../src/devices/bin/driver_manager/node.h

DriverHost * driver_host ()

Defined at line 396 of file ../../src/devices/bin/driver_manager/node.h

bool quarantined ()

Defined at line 406 of file ../../src/devices/bin/driver_manager/node.h

std::span<const std::weak_ptr<Node>> parents ()

Defined at line 408 of file ../../src/devices/bin/driver_manager/node.h

const std::list<std::shared_ptr<Node>> & children ()

Defined at line 418 of file ../../src/devices/bin/driver_manager/node.h

const std::vector<NodeOffer> & offers ()

Defined at line 420 of file ../../src/devices/bin/driver_manager/node.h

const std::vector<fuchsia_driver_framework::NodeSymbol> & symbols ()

Defined at line 422 of file ../../src/devices/bin/driver_manager/node.h

size_t properties_size ()

Returns the node properties of the node and its parents if the node is a composite node.

See `properties_` property for more info.

Defined at line 426 of file ../../src/devices/bin/driver_manager/node.h

void SetSubtreeDictionaryRef (std::optional<fuchsia_component_sandbox::CapabilityId> subtree_dictionary_ref)

Defined at line 439 of file ../../src/devices/bin/driver_manager/node.h

void ~Node ()

Defined at line 440 of file ../../src/devices/bin/driver_manager/node.cc

zx::result<std::shared_ptr<Node>> CreateCompositeNode (std::string_view node_name, std::vector<std::weak_ptr<Node>> parents, std::vector<std::string> parents_names, const std::vector<fuchsia_driver_framework::NodePropertyEntry2> & parent_properties, NodeManager * driver_binder, async_dispatcher_t * dispatcher, std::string_view driver_host_name_for_colocation, uint32_t primary_index)

Defined at line 351 of file ../../src/devices/bin/driver_manager/node.cc

void SetPowerDependencyOverrides (std::optional<std::vector<fuchsia_power_broker::LevelDependency>> power_dependency_overrides)

Sets the power dependency overrides for this node. These overrides will be

used instead of the default power dependencies when the driver is started.

This is primarily intended for use in tests via the driver restart flow,

allowing tests to provide isolated or custom dependencies.

Defined at line 451 of file ../../src/devices/bin/driver_manager/node.h

void MarkAsCompositeParent ()

Defined at line 456 of file ../../src/devices/bin/driver_manager/node.h

void UnmarkAsCompositeParent ()

Defined at line 458 of file ../../src/devices/bin/driver_manager/node.h

bool HasSubtreeDictionaryRef ()

Defined at line 460 of file ../../src/devices/bin/driver_manager/node.h

bool SkipInjectedOffers ()

Defined at line 462 of file ../../src/devices/bin/driver_manager/node.h

std::optional<fuchsia_component_sandbox::DictionaryRef> TakeDictionary ()

Defined at line 464 of file ../../src/devices/bin/driver_manager/node.h

void SetCpuTokenOverride (std::optional<zx::event> token)

Sets the CPU token override for this node. This token will be used to

create a dependency on the CPU power element when the driver is started.

Like SetPowerDependencyOverrides, this is primarily meant for test scenarios.

Defined at line 473 of file ../../src/devices/bin/driver_manager/node.h

const Collection & collection ()

Defined at line 477 of file ../../src/devices/bin/driver_manager/node.h

const fuchsia_driver_framework::DriverPackageType & driver_package_type ()

Defined at line 479 of file ../../src/devices/bin/driver_manager/node.h

DevfsDevice & devfs_device ()

Defined at line 483 of file ../../src/devices/bin/driver_manager/node.h

bool can_multibind_composites ()

Defined at line 485 of file ../../src/devices/bin/driver_manager/node.h

bool IsHermeticPowerTest ()

Defined at line 487 of file ../../src/devices/bin/driver_manager/node.h

void set_collection (Collection collection)

Defined at line 492 of file ../../src/devices/bin/driver_manager/node.h

void set_driver_package_type (fuchsia_driver_framework::DriverPackageType driver_package_type)

Defined at line 494 of file ../../src/devices/bin/driver_manager/node.h

void set_symbols (std::vector<fuchsia_driver_framework::NodeSymbol> symbols)

Defined at line 498 of file ../../src/devices/bin/driver_manager/node.h

void set_can_multibind_composites (bool can_multibind_composites)

Defined at line 502 of file ../../src/devices/bin/driver_manager/node.h

void set_driver_host_name_for_colocation (std::string_view name)

Defined at line 506 of file ../../src/devices/bin/driver_manager/node.h

std::optional<zx_koid_t> token_koid ()

Defined at line 510 of file ../../src/devices/bin/driver_manager/node.h

ShutdownIntent shutdown_intent ()

Defined at line 517 of file ../../src/devices/bin/driver_manager/node.h

void OnNodeServerUnbound (fidl::UnbindInfo info)

This is called when |node_ref_| is unbound from the dispatcher.

Defined at line 1403 of file ../../src/devices/bin/driver_manager/node.cc

void OnBind ()

Defined at line 546 of file ../../src/devices/bin/driver_manager/node.cc

void OnMatchError (zx_status_t status)

Defined at line 615 of file ../../src/devices/bin/driver_manager/node.cc

void OnStartError (zx_status_t status)

Defined at line 619 of file ../../src/devices/bin/driver_manager/node.cc

void SearchNamespaceSvcDirForEntry (fidl::ClientEnd<fuchsia_io::Directory> svc_dir, std::string_view entry_name, fit::callback<void (zx::result<fidl::ClientEnd<fuchsia_io::Directory>>)> cb)

Manually scans the directory entries in a namespace to find a specific protocol.

We do this manual scan rather than just attempting to `Open` the protocol directly

because `Open` is asynchronous and may not fail immediately if the protocol is

missing. By verifying its existence first, we avoid relying on a silent failure

or hanging behavior when a custom power topology isn't provided.

Defined at line 1642 of file ../../src/devices/bin/driver_manager/node.cc

void Remove (RemovalSet removal_set, NodeRemovalTracker * removal_tracker)

Begin the removal process for a Node. This function ensures that a Node is

only removed after all of its children are removed. It also ensures that

a Node is only removed after the driver that is bound to it has been stopped.

This is safe to call multiple times.

There are multiple reasons a Node's removal will be started:

- The system is being stopped.

- The Node had an unexpected error or disconnect

During a system stop, Remove is expected to be called twice:

once with |removal_set| == kPackage, and once with |removal_set| == kAll.

Errors and disconnects that are unrecoverable should call Remove(kAll, nullptr).

Defined at line 845 of file ../../src/devices/bin/driver_manager/node.cc

void AddChild (fuchsia_driver_framework::NodeAddArgs args, fidl::ServerEnd<fuchsia_driver_framework::NodeController> controller, fidl::ServerEnd<fuchsia_driver_framework::Node> node, AddNodeResultCallback callback)

`callback` is invoked once the node has finished being added or an error

has occurred.

Defined at line 1358 of file ../../src/devices/bin/driver_manager/node.cc

void AddToParents ()

Add this Node to its parents. This should be called when the node is created. Exposed for

testing.

Defined at line 679 of file ../../src/devices/bin/driver_manager/node.cc

void RestartNode ()

Begins the process of restarting the node. Restarting a node includes stopping and removing

all children nodes, stopping the driver that is bound to the node, and asking the NodeManager

to bind the node again. The restart operation is very similar to the Remove operation, the

difference being once the children are removed, and the driver stopped, we don't remove the

node from the topology but instead bind the node again.

Defined at line 849 of file ../../src/devices/bin/driver_manager/node.cc

void QuarantineNode ()

Begins the process of quarantining the node. This is basically performing a Remove,

but instead of removing the node from the topology, we keep it in a stopped state so that it

can be orphaned if its driver is ever disabled. That way new drivers can be bound to the node.

Defined at line 854 of file ../../src/devices/bin/driver_manager/node.cc

void RemoveCompositeNodeForRebind (fit::callback<void (zx::result<>)> completer)

TODO(https://fxbug.dev/42082343): Handle the case in which this function is called during node

removal.

Defined at line 887 of file ../../src/devices/bin/driver_manager/node.cc

void RestartNodeWithRematch (std::optional<std::string> restart_driver_url_suffix, fit::callback<void (zx::result<>)> completer)

Restarting a node WithRematch, means that instead of re-using the currently bound driver,

another MatchDriver call will be made into the driver index to find a new driver to bind.

Defined at line 869 of file ../../src/devices/bin/driver_manager/node.cc

void RestartNodeWithRematch ()

Defined at line 881 of file ../../src/devices/bin/driver_manager/node.cc

void StartDriver (fuchsia_component_runner::wire::ComponentStartInfo start_info, fidl::ServerEnd<fuchsia_component_runner::ComponentController> component_controller, fit::callback<void (zx::result<>)> cb)

Defined at line 1721 of file ../../src/devices/bin/driver_manager/node.cc

void SetController (fidl::ClientEnd<fuchsia_component::Controller> component_controller)

ComponentOwner

Defined at line 537 of file ../../src/devices/bin/driver_manager/node.cc

void OnComponentStarted (const std::weak_ptr<BootupTracker> & bootup_tracker, const std::string & moniker, zx::result<StartedComponent> component)

Defined at line 2226 of file ../../src/devices/bin/driver_manager/node.cc

void RequestStartComponent (fuchsia_process::wire::HandleInfo startup_handle, const std::string & moniker, const std::weak_ptr<BootupTracker> & bootup_tracker)

Defined at line 2254 of file ../../src/devices/bin/driver_manager/node.cc

void SetNonCompositeProperties (std::span<const fuchsia_driver_framework::NodeProperty2> properties)

Exposed for testing.

Set properties to non-composite node properties containing a clone of `properties`.

Defined at line 1008 of file ../../src/devices/bin/driver_manager/node.cc

bool EvaluateRematchFlags (fuchsia_driver_development::RestartRematchFlags rematch_flags, std::string_view requested_url)

Evaluates the given rematch_flags against the node. Returns true if rematch should take place,

false otherwise. Rematching is done based on the node type and url both matching:

For node type, if the node is a composite, the rematch flags must contain the flag

for the composite variant that the node is. No validation for non-composites.

For the url, rematch takes place if either:

- the url matches the requested_url and the 'requested' flag is available.

- the url does not match and the 'non_requested' flag is available.

Defined at line 2562 of file ../../src/devices/bin/driver_manager/node.cc

std::string MakeTopologicalPath (bool deduplicate)

Creates the node's topological path by combining each primary parent's name together,

separated by '/'.

E.g: dev/sys/topo/path

Defined at line 498 of file ../../src/devices/bin/driver_manager/node.cc

std::string MakeComponentMoniker ()

Make the node's component moniker by making the topological path and then replacing

characters not allowed by the component framework.

E.g: dev.sys.topo.path

Defined at line 511 of file ../../src/devices/bin/driver_manager/node.cc

void SetShouldDestroy ()

Defined at line 542 of file ../../src/devices/bin/driver_manager/node.cc

void CompleteBind (zx::result<> result)

Invoked when a bind sequence has been completed. It allows us to reply to outstanding bind

requests that may have originated from the node.

Defined at line 640 of file ../../src/devices/bin/driver_manager/node.cc

NodeShutdownCoordinator & GetNodeShutdownCoordinator ()

Defined at line 690 of file ../../src/devices/bin/driver_manager/node.cc

const std::string & driver_url ()

Defined at line 474 of file ../../src/devices/bin/driver_manager/node.cc

std::optional<std::vector<fuchsia_driver_framework::NodeProperty2>> GetNodeProperties (std::string_view parent_name)

Returns the node properties of the node or the node's parent if the node is a composite node.

Returns std::nullopt if the node is a non-composite and `parent_name` is not "default".

Returns std::nullopt if the parent node cannot be found.

See `properties_` property for more info.

Defined at line 2748 of file ../../src/devices/bin/driver_manager/node.cc

fuchsia_driver_framework::NodePropertyDictionary2 GetNodePropertyDict ()

Defined at line 2758 of file ../../src/devices/bin/driver_manager/node.cc

void PrepareDictionary (fit::callback<void (zx::result<>)> callback)

Defined at line 2380 of file ../../src/devices/bin/driver_manager/node.cc

std::vector<fuchsia_driver_framework::BusInfo> GetBusTopology ()

Defined at line 1038 of file ../../src/devices/bin/driver_manager/node.cc

Friends

class ComponentControllerConnection
class DriverHostConnection