blob: d676147b38a8165697e286247205af2f83aa1408 [file]
// Copyright 2024 The Fuchsia Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
use crate::{HealthAlertLatch, HealthAlertReporter, Incoming, Node, ParentProperty, PropertyValue};
use fuchsia_async::ScopeHandle;
use fuchsia_component::server::{ServiceFs, ServiceObjTrait};
use fuchsia_component_config::Config;
use fuchsia_inspect::Inspector;
use inspect_runtime::PublishOptions;
use log::error;
use namespace::Namespace;
use zx::Status;
use fdf::AsyncDispatcher;
use fidl_next_fuchsia_driver_framework::{DriverStartArgs, HealthAlert};
pub use fuchsia_inspect_contrib::content_publisher as inspect_publisher;
/// The context arguments passed to the driver in its start arguments.
#[non_exhaustive]
pub struct DriverContext {
/// A reference to the root [`fdf::Dispatcher`] for this driver.
pub root_dispatcher: AsyncDispatcher,
/// The original [`DriverStartArgs`] passed in as start arguments, minus any parts that were
/// used to construct other elements of [`Self`].
pub start_args: DriverStartArgs,
/// The incoming namespace constructed from [`DriverStartArgs::incoming`]. Since producing this
/// consumes the incoming namespace from [`Self::start_args`], that will always be [`None`].
pub incoming: Incoming,
health_alert_reporter: HealthAlertReporter,
// Lazily initialized and type-erased so drivers that do not call `health_alert_latch()` do not
// pull `HealthAlertLatch` or `HealthCheckInspect` drop glue into bootfs binaries.
health_alert_latch: std::sync::OnceLock<std::sync::Arc<dyn std::any::Any + Send + Sync>>,
}
impl DriverContext {
/// Returns a reporter through which the driver can proactively emit
/// `fuchsia.driver.framework/Driver.OnHealthAlert` events after [`crate::Driver::start`] has
/// consumed this context. The reporter is cheap to clone and may be used from any thread.
///
/// For self-reported faults (`HealthAlert::SelfFault`), prefer [`Self::health_alert_latch`] so
/// active conditions are deduplicated and merged across the driver and any SDK wrappers (such
/// as `fdf_power::Suspendable`). Use `health_alert_reporter` directly for upstream or
/// downstream neighbor fault alerts.
pub fn health_alert_reporter(&self) -> HealthAlertReporter {
self.health_alert_reporter.clone()
}
/// Returns the shared [`HealthAlertLatch`] for this driver instance.
///
/// Every clone returned by `health_alert_latch` shares the same active self-fault condition
/// set, allowing the driver and wrapper libraries to raise and clear independent `reason_code`
/// conditions without overwriting each other's `OnHealthAlert` reports.
pub fn health_alert_latch(&self) -> HealthAlertLatch {
let erased = self.health_alert_latch.get_or_init(|| {
std::sync::Arc::new(HealthAlertLatch::new(self.health_alert_reporter.clone()))
as std::sync::Arc<dyn std::any::Any + Send + Sync>
});
erased
.downcast_ref::<HealthAlertLatch>()
.expect("DriverContext health_alert_latch holds HealthAlertLatch")
.clone()
}
/// Reports `alert` to the driver framework. Equivalent to
/// `self.health_alert_reporter().report_health_alert(alert)`; see
/// [`HealthAlertReporter::report_health_alert`].
pub fn report_health_alert(&self, alert: HealthAlert) {
self.health_alert_reporter.report_health_alert(alert);
}
/// Binds the node proxy client end from the start args into a [`NodeProxy`] that can be used
/// to add child nodes. Dropping this proxy will result in the node being removed and the
/// driver starting shutdown, so it should be bound and stored in your driver object in its
/// [`crate::Driver::start`] method.
///
/// After calling this, [`DriverStartArgs::node`] in [`Self::start_args`] will be `None`.
///
/// Returns [`Status::INVALID_ARGS`] if the node client end is not present in the start
/// arguments.
pub fn take_node(&mut self) -> Result<Node, Status> {
let node_client = self.start_args.node.take().ok_or(Status::INVALID_ARGS)?;
let node_client =
fidl::endpoints::ClientEnd::<fidl_fuchsia_driver_framework::NodeMarker>::new(
node_client.into_untyped(),
);
Ok(Node::from(node_client.into_proxy()))
}
/// Returns the component config.
///
/// After calling this, [`DriverStartArgs::config`] in [`Self::start_args`] will be `None`.
///
/// Returns [`Status::INVALID_ARGS`] if the config is not present in the start arguments.
pub fn take_config<C: Config>(&mut self) -> Result<C, Status> {
let vmo = self.start_args.config.take().ok_or(Status::INVALID_ARGS)?;
Ok(Config::from_vmo(&vmo).expect("Config VMO handle must be valid."))
}
/// Serves the given [`ServiceFs`] on the node's outgoing directory. This can only be called
/// once, and after this the [`DriverStartArgs::outgoing_dir`] member will be [`None`].
///
/// Logs an error and returns [`Status::INVALID_ARGS`] if the outgoing directory server end is
/// not present in the start arguments, or [`Status::INTERNAL`] if serving the connection
/// failed.
pub fn serve_outgoing<O: ServiceObjTrait>(
&mut self,
outgoing_fs: &mut ServiceFs<O>,
) -> Result<(), Status> {
let Some(outgoing_dir) = self.start_args.outgoing_dir.take() else {
error!("Tried to serve on outgoing directory but it wasn't available");
return Err(Status::INVALID_ARGS);
};
let outgoing_dir = into_legacy_server_end(outgoing_dir);
outgoing_fs.serve_connection(outgoing_dir).map_err(|err| {
error!("Failed to serve outgoing directory: {err}");
Status::INTERNAL
})?;
Ok(())
}
/// Spawns a server handling `fuchsia.inspect.Tree` requests and a handle
/// to the `fuchsia.inspect.Tree` is published using `fuchsia.inspect.InspectSink`.
///
/// Whenever the client wishes to stop publishing Inspect, the Controller may be dropped.
pub fn publish_inspect(&self, inspector: &Inspector, scope: ScopeHandle) -> Result<(), Status> {
let client = self.incoming.connect_protocol().map_err(|err| {
error!("Error connecting to inspect : {err}");
Status::INTERNAL
})?;
let task = inspect_runtime::publish(
inspector,
PublishOptions::default().on_inspect_sink_client(client),
)
.ok_or(Status::INTERNAL)?;
scope.spawn_local(task);
Ok(())
}
/// Returns an inspect content publisher that acts as a stream for requests for inspect data.
pub fn inspect_content_publisher(&self) -> Result<inspect_publisher::ContentPublisher, Status> {
let inspect_sink_client = self.incoming.connect_protocol().map_err(|err| {
error!("Error connecting to inspect : {err}");
Status::INTERNAL
})?;
let options = inspect_publisher::PublishOptions { inspect_sink_client };
inspect_publisher::content_publisher(options).map_err(|err| {
error!("Error creating inspect content publisher: {err}");
Status::INTERNAL
})
}
/// Returns the name of the node that the driver is bound to, if present in the start
/// arguments.
pub fn node_name(&self) -> Option<&str> {
self.start_args.node_name.as_deref()
}
/// Takes the node token from the start arguments, if the driver host provided one. The token
/// identifies the driver's node to other framework services, such as the power framework.
///
/// After calling this, [`DriverStartArgs::node_token`] in [`Self::start_args`] will be `None`.
pub fn take_node_token(&mut self) -> Option<zx::Event> {
self.start_args.node_token.take()
}
/// Takes the power element dependency token from the start arguments. The driver host
/// provides it when the driver's manifest opts in to a framework-managed power element.
///
/// After calling this, the `token` of [`DriverStartArgs::power_element_args`] in
/// [`Self::start_args`] will be `None`.
pub fn take_power_element_token(&mut self) -> Option<zx::Event> {
self.start_args.power_element_args.as_mut()?.token.take()
}
/// Returns the properties of the driver's parent node(s) from the start arguments, in the
/// order the driver host provided them. See [`ParentProperty::parent`] for how the properties
/// are grouped.
pub fn node_properties(&self) -> impl Iterator<Item = ParentProperty<'_>> + '_ {
self.start_args.node_properties_2.iter().flatten().flat_map(|entry| {
entry.properties.iter().map(move |property| ParentProperty {
parent: &entry.name,
key: &property.key,
value: PropertyValue::from(&property.value),
})
})
}
/// Returns the VMAR which the driver can use to map memory.
///
/// If the driver was not provided with an explicit VMAR in its start arguments, the root VMAR
/// is returned.
pub fn vmar(&self) -> zx::Unowned<'_, zx::Vmar> {
// NB: We can't use `map_or_else` here, because the compiler gets confused about lifetimes
// when attempting to unify the types of the two function arguments.
if let Some(vmar) = self.start_args.vmar.as_ref().map(zx::Unowned::new) {
vmar
} else {
fuchsia_runtime::vmar_root_self()
}
}
pub(crate) fn new(
root_dispatcher: AsyncDispatcher,
mut start_args: DriverStartArgs,
health_alert_reporter: HealthAlertReporter,
) -> Result<Self, Status> {
let mut incoming_namespace = Namespace::new();
for entry in start_args.incoming.take().unwrap_or_default() {
let path = entry
.path
.ok_or(Status::INVALID_ARGS)?
.parse()
.map_err(|_| Status::INVALID_ARGS)?;
let directory = into_legacy_client_end(entry.directory.ok_or(Status::INVALID_ARGS)?);
incoming_namespace.add(&path, directory).map_err(|_| Status::INVALID_ARGS)?;
}
let incoming = Incoming::from(incoming_namespace);
Ok(DriverContext {
root_dispatcher,
start_args,
incoming,
health_alert_reporter,
health_alert_latch: std::sync::OnceLock::new(),
})
}
pub(crate) fn start_logging(&self, driver_name: &str) -> Result<(), Status> {
let log_client = match self.incoming.connect_protocol() {
Ok(log_client) => log_client,
Err(err) => {
eprintln!(
"Error connecting to log sink proxy at driver startup: {err}. Continuing without logging."
);
return Ok(());
}
};
if let Err(e) = driver_diagnostics_log::initialize(
driver_diagnostics_log::PublishOptions::default()
.use_log_sink(log_client)
.tags(&["driver", driver_name]),
) {
eprintln!("Error initializing logging at driver startup: {e}");
}
Ok(())
}
}
/// Converts a `fidl_next::ClientEnd` into a legacy `fidl::endpoints::ClientEnd` over a Zircon
/// channel for APIs like `namespace::Namespace` that still accept `fidl_fuchsia_io` endpoints.
fn into_legacy_client_end<P, M: fidl::endpoints::ProtocolMarker>(
client_end: fidl_next::ClientEnd<P, zx::Channel>,
) -> fidl::endpoints::ClientEnd<M> {
fidl::endpoints::ClientEnd::new(client_end.into_untyped())
}
/// Converts a `fidl_next::ServerEnd` into a legacy `fidl::endpoints::ServerEnd` over a Zircon
/// channel for APIs like `fuchsia_component::server::ServiceFs` that still accept
/// `fidl_fuchsia_io` endpoints.
fn into_legacy_server_end<P, M: fidl::endpoints::ProtocolMarker>(
server_end: fidl_next::ServerEnd<P, zx::Channel>,
) -> fidl::endpoints::ServerEnd<M> {
fidl::endpoints::ServerEnd::new(server_end.into_untyped())
}