fidl_fuchsia_power_observability__common/

fidl_fuchsia_power_observability__common.rs

// WARNING: This file is machine generated by fidlgen.

#![warn(clippy::all)]
#![allow(unused_parens, unused_mut, unused_imports, nonstandard_style)]

use bitflags::bitflags;
use fidl::encoding::{MessageBufFor, ProxyChannelBox, ResourceDialect};
use futures::future::{self, MaybeDone, TryFutureExt};
use zx_status;

/// The name of current active epolls, recorded when epolls
/// become active and if we attempted to suspend, but failed because
/// there were active epolls.
pub const ACTIVE_EPOLLS: &str = "active_epolls";

/// The name of current active wake locks, recorded when wake locks
/// become active and if we attempted to suspend, but failed because
/// there were active wake locks.
pub const ACTIVE_WAKE_LOCK_NAMES: &str = "active_wake_lock_names";

/// The delta between the boot and monotonic clocks after resuming from
/// suspend, in nanoseconds.
/// Formula: mono_time_ns = boot_time_ns - boot_monotonic_difference_ns
pub const BOOT_MONO_DIFF: &str = "boot_monotonic_difference_ns";

/// The boot time captured after resuming from suspend, in nanoseconds.
pub const BOOT_TIME: &str = "boot_time_ns";

/// Label of an inspect node tracking boot vs monotonic timestamps.
pub const BOOT_TO_MONO_NODE: &str = "boot_to_monotonic_timeline";

/// The name of current inactive epolls, recorded when epolls
/// become inactive and if we attempted to suspend, but failed
/// because there were active epolls.
pub const INACTIVE_EPOLLS: &str = "inactive_epolls";

/// The name of current inactive wake locks, recorded when wake locks
/// become inactive and if we attempted to suspend, but failed
/// because there were active wake locks.
pub const INACTIVE_WAKE_LOCK_NAMES: &str = "inactive_wake_lock_names";

/// Timestamp in nanos, for the end of resume callback processing.
/// Resume is not gated on phase completion.
/// Event is recorded in SUSPEND_EVENTS_NODE.
pub const RESUME_CALLBACK_PHASE_END_AT: &str = "resume_callbacks_ended_at_ns";

/// Timestamp in nanos, for the start of resume callback processing.
/// Resume is not gated on phase completion.
/// Event is recorded in SUSPEND_EVENTS_NODE.
pub const RESUME_CALLBACK_PHASE_START_AT: &str = "resume_callbacks_started_at_ns";

/// Timestamp in nanos at which suspend was attempted.
pub const SUSPEND_ATTEMPTED_AT: &str = "attempted_at_ns";

/// Timestamp in nanos for when a suspend attempt was blocked internally.
/// Suspend may be repeatedly blocked until all suspend locks and suspend
/// blockers have been dropped.
pub const SUSPEND_ATTEMPT_BLOCKED_AT: &str = "attempt_blocked_at_ns";

/// Timestamp in nanos for when at least one suspend blocker is acquired.
/// This occurs when an internal procedure needs to prevent suspension.
/// For example, when servicing a wake lease request, system-activity-governor
/// will acquire a suspend blocker for the lifetime of the wake lease token.
/// This prevents suspension even while the underlying power broker lease is
/// pending.
pub const SUSPEND_BLOCKER_ACQUIRED_AT: &str = "suspend_blocker_acquired_at_ns";

/// Timestamp in nanos for when the last suspend blocker is dropped.
pub const SUSPEND_BLOCKER_DROPPED_AT: &str = "suspend_blocker_dropped_at_ns";

/// Timestamp in nanos, for the end of suspend callback processing.
/// Suspend is gated on phase completion.
/// Event is recorded in SUSPEND_EVENTS_NODE.
pub const SUSPEND_CALLBACK_PHASE_END_AT: &str = "suspend_callbacks_ended_at_ns";

/// Timestamp in nanos, for the start of suspend callback processing.
/// Suspend is gated on phase completion.
/// Event is recorded in SUSPEND_EVENTS_NODE.
pub const SUSPEND_CALLBACK_PHASE_START_AT: &str = "suspend_callbacks_started_at_ns";

/// The total cumulative duration of time spent in suspend since boot.
pub const SUSPEND_CUMULATIVE_DURATION: &str = "total_time_in_suspend_ns";

/// Label of an inspect node tallying suspend events.
pub const SUSPEND_EVENTS_NODE: &str = "suspend_events";

/// Timestamp in nanos for resume, after an unsuccessful suspend.
pub const SUSPEND_FAILED_AT: &str = "failed_at_ns";

/// The number of failed suspends.
pub const SUSPEND_FAIL_COUNT: &str = "fail_count";

/// The duration of time last spent in operations leading to suspend,
/// excluding the time actually spent suspended.
///
/// TODO: b/354239403 - make this string also end with `_ns` to be consistent
/// with the conventions above.
pub const SUSPEND_LAST_DURATION: &str = "last_time_in_suspend_operations";

/// The error code related to the last suspend operation.
pub const SUSPEND_LAST_FAILED_ERROR: &str = "last_failed_error";

/// The duration of time last spent in suspend.
pub const SUSPEND_LAST_TIMESTAMP: &str = "last_time_in_suspend_ns";

/// Timestamp in nanos for when suspend requests will be blocked because a
/// suspend lock is acquired. This event occurs right before a request to the
/// suspend HAL is made.
pub const SUSPEND_LOCK_ACQUIRED_AT: &str = "suspend_lock_acquired_at_ns";

/// Timestamp in nanos for when a suspend lock is dropped. This event occurs
/// after a response from the suspend HAL is received and handled by SAG.
pub const SUSPEND_LOCK_DROPPED_AT: &str = "suspend_lock_dropped_at_ns";

/// The requested future system state.
pub const SUSPEND_REQUESTED_STATE: &str = "requested_power_state";

/// Timestamp in nanos for resume, after a successful suspend.
pub const SUSPEND_RESUMED_AT: &str = "resumed_at_ns";

/// Resume reason after a successful suspend.
pub const SUSPEND_RESUME_REASON: &str = "resume_reason";

/// Label of an inspect node keeping suspend statistics.
pub const SUSPEND_STATS_NODE: &str = "suspend_stats";

/// The number of successful suspends.
pub const SUSPEND_SUCCESS_COUNT: &str = "success_count";

/// The current state of wake leases, as tracked by SAG.
/// The wake lease event history is tracked separately in SUSPEND_EVENTS_NODE.
pub const WAKE_LEASES_NODE: &str = "wake_leases";

/// Timestamp in nanos for when a wake lease was created.
pub const WAKE_LEASE_CREATED_AT: &str = "wake_lease_created_at_ns";

/// Timestamp in nanos for a wake lease is dropped.
pub const WAKE_LEASE_DROPPED_AT: &str = "wake_lease_dropped_at_ns";

/// The kernel object ID of the token vended to the client.
pub const WAKE_LEASE_ITEM_CLIENT_TOKEN_KOID: &str = "wake_lease_client_token_koid";

/// The error message. For example, if the underlying power broker lease failed
/// to be satisfied.
pub const WAKE_LEASE_ITEM_ERROR: &str = "error";

/// The name of the wake lease as requested by the client.
pub const WAKE_LEASE_ITEM_NAME: &str = "wake_lease_name";

/// The time since boot when the wake lease was created in nanoseconds.
pub const WAKE_LEASE_ITEM_NODE_CREATED_AT: &str = "wake_lease_created_at";

/// The status of the wake lease.
pub const WAKE_LEASE_ITEM_STATUS: &str = "wake_lease_status";

/// Lease requested in power broker is awaiting satisfaction in the power
/// topology.
pub const WAKE_LEASE_ITEM_STATUS_AWAITING_SATISFACTION: &str = "pending";

/// Lease requested in power broker failed to be satisfied.
pub const WAKE_LEASE_ITEM_STATUS_FAILED_SATISFACTION: &str = "failed";

/// Lease requested in power broker is satisfied by the current state of the
/// power topology.
pub const WAKE_LEASE_ITEM_STATUS_SATISFIED: &str = "satisfied";

/// The type of wake lease.
pub const WAKE_LEASE_ITEM_TYPE: &str = "wake_lease_type";

/// Lease that blocks the system from dropping below the Application Activity
/// 'Active' state.
pub const WAKE_LEASE_ITEM_TYPE_APPLICATION_ACTIVITY: &str = "application_activity";

/// Lease that blocks suspension of the hardware platform.
pub const WAKE_LEASE_ITEM_TYPE_WAKE: &str = "wake";

/// Timestamp in nanos for when a wake lease failed to be satisfied by power broker.
pub const WAKE_LEASE_SATISFACTION_FAILED_AT: &str = "wake_lease_satisfaction_failed_at_ns";

/// Timestamp in nanos for when a wake lease is satisfaction with power broker.
pub const WAKE_LEASE_SATISFIED_AT: &str = "wake_lease_satisfied_at_ns";

/// The key for the timestamp when the wake reason was reported at.
pub const WAKE_REASONS_REPORTED_AT: &str = "wake_reason_reported_at_ns";

/// A key prefix for a wake reason.
pub const WAKE_REASONS_WAKE_VECTOR_PREFIX: &str = "wake_reason";

/// The boot timestamp in nanoseconds at which the wake reason report was
/// generated.
pub const WAKE_REASON_REPORT_TIME: &str = "wake_reason_last_report_time_ns";

/// The last reported number of potential wake sources for the last successful
/// wake.
pub const WAKE_REASON_WAKE_SOURCES_COUNT: &str = "wake_reason_last_wake_sources_count";

/// The last number of UNreported potential wake sources for the last successful
/// wake.
pub const WAKE_REASON_WAKE_SOURCES_UNREPORTED_COUNT: &str =
    "wake_reason_last_wake_sources_unreported_count";

mod internal {
    use super::*;
}