1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186
// WARNING: This file is machine generated by fidlgen.
// fidl_experiment = transitional_allow_list
#![warn(clippy::all)]
#![allow(unused_parens, unused_mut, unused_imports, nonstandard_style)]
use {
bitflags::bitflags,
fidl::{
client::QueryResponseFut,
endpoints::{ControlHandle as _, Responder as _},
},
fuchsia_zircon_status as zx_status,
futures::future::{self, MaybeDone, TryFutureExt},
};
#[cfg(target_os = "fuchsia")]
use fuchsia_zircon as zx;
/// Indicates the memory pressure level.
#[derive(Copy, Clone, Debug, Eq, PartialEq, Ord, PartialOrd, Hash)]
#[repr(u32)]
pub enum Level {
/// The memory pressure level is healthy.
///
/// Registered clients are free to hold on to caches and allocate memory
/// unrestricted.
///
/// However, clients should take care to not proactively re-create caches on a
/// transition back to the NORMAL level, causing a memory spike that immediately
/// pushes the level over to WARNING again.
Normal = 1,
/// The memory pressure level is somewhat constrained, and might cross over to
/// the critical pressure range if left unchecked.
///
/// Registered clients are expected to optimize their operation to limit memory
/// usage, rather than for best performance, for example, by reducing cache sizes
/// and non-essential memory allocations.
///
/// Clients must take care to regulate the amount of work they undertake in
/// order to reclaim memory, and ensure that it does not cause visible
/// performance degradation. There exists some memory pressure, but not enough
/// to justify trading off user responsiveness to reclaim memory.
Warning = 2,
/// The memory pressure level is very constrained.
///
/// Registered clients are expected to drop all non-essential memory, and refrain
/// from allocating more memory. Failing to do so might result in the job
/// getting terminated, or the system being rebooted in the case of global
/// memory pressure.
///
/// Clients may undertake expensive work to reclaim memory if required, since
/// failing to do so might result in termination. The client might decide that a
/// performance hit is a fair tradeoff in this case.
Critical = 3,
}
impl Level {
#[inline]
pub fn from_primitive(prim: u32) -> Option<Self> {
match prim {
1 => Some(Self::Normal),
2 => Some(Self::Warning),
3 => Some(Self::Critical),
_ => None,
}
}
#[inline]
pub const fn into_primitive(self) -> u32 {
self as u32
}
#[deprecated = "Strict enums should not use `is_unknown`"]
#[inline]
pub fn is_unknown(&self) -> bool {
false
}
}
#[derive(Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
pub struct ProviderRegisterWatcherRequest {
pub watcher: fidl::endpoints::ClientEnd<WatcherMarker>,
}
impl fidl::Standalone for ProviderRegisterWatcherRequest {}
#[derive(Clone, Copy, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
pub struct WatcherOnLevelChangedRequest {
pub level: Level,
}
impl fidl::Persistable for WatcherOnLevelChangedRequest {}
#[derive(Debug, Copy, Clone, Eq, PartialEq, Ord, PartialOrd, Hash)]
pub struct ProviderMarker;
impl fidl::endpoints::ProtocolMarker for ProviderMarker {
type Proxy = ProviderProxy;
type RequestStream = ProviderRequestStream;
#[cfg(target_os = "fuchsia")]
type SynchronousProxy = ProviderSynchronousProxy;
const DEBUG_NAME: &'static str = "fuchsia.memorypressure.Provider";
}
impl fidl::endpoints::DiscoverableProtocolMarker for ProviderMarker {}
pub trait ProviderProxyInterface: Send + Sync {
fn r#register_watcher(
&self,
watcher: fidl::endpoints::ClientEnd<WatcherMarker>,
) -> Result<(), fidl::Error>;
}
#[derive(Debug)]
#[cfg(target_os = "fuchsia")]
pub struct ProviderSynchronousProxy {
client: fidl::client::sync::Client,
}
#[cfg(target_os = "fuchsia")]
impl fidl::endpoints::SynchronousProxy for ProviderSynchronousProxy {
type Proxy = ProviderProxy;
type Protocol = ProviderMarker;
fn from_channel(inner: fidl::Channel) -> Self {
Self::new(inner)
}
fn into_channel(self) -> fidl::Channel {
self.client.into_channel()
}
fn as_channel(&self) -> &fidl::Channel {
self.client.as_channel()
}
}
#[cfg(target_os = "fuchsia")]
impl ProviderSynchronousProxy {
pub fn new(channel: fidl::Channel) -> Self {
let protocol_name = <ProviderMarker as fidl::endpoints::ProtocolMarker>::DEBUG_NAME;
Self { client: fidl::client::sync::Client::new(channel, protocol_name) }
}
pub fn into_channel(self) -> fidl::Channel {
self.client.into_channel()
}
/// Waits until an event arrives and returns it. It is safe for other
/// threads to make concurrent requests while waiting for an event.
pub fn wait_for_event(&self, deadline: zx::Time) -> Result<ProviderEvent, fidl::Error> {
ProviderEvent::decode(self.client.wait_for_event(deadline)?)
}
/// Used to register for memory pressure level changes.
/// `watcher`: memory pressure `Watcher` channel that the `Provider` will use to send
/// level change messages to the client.
///
/// The current memory pressure level is immediately sent to the watcher
/// when this method is called.
///
/// It is recommended that the root job in a component tree register for changes,
/// rather than having individual jobs further down the tree register individually.
/// A low client count will help minimize system churn due to a large number of
/// memory pressure messages in transit at the same time.
/// Also, the more context a job has, the better equipped it will be to react to
/// memory pressure by controlling the behavior of children jobs in its tree.
pub fn r#register_watcher(
&self,
mut watcher: fidl::endpoints::ClientEnd<WatcherMarker>,
) -> Result<(), fidl::Error> {
self.client.send::<ProviderRegisterWatcherRequest>(
(watcher,),
0x91e65af25aae4a9,
fidl::encoding::DynamicFlags::empty(),
)
}
}
#[derive(Debug, Clone)]
pub struct ProviderProxy {
client: fidl::client::Client,
}
impl fidl::endpoints::Proxy for ProviderProxy {
type Protocol = ProviderMarker;
fn from_channel(inner: fidl::AsyncChannel) -> Self {
Self::new(inner)
}
fn into_channel(self) -> Result<::fidl::AsyncChannel, Self> {
self.client.into_channel().map_err(|client| Self { client })
}
fn as_channel(&self) -> &::fidl::AsyncChannel {
self.client.as_channel()
}
}
impl ProviderProxy {
/// Create a new Proxy for fuchsia.memorypressure/Provider.
pub fn new(channel: fidl::AsyncChannel) -> Self {
let protocol_name = <ProviderMarker as fidl::endpoints::ProtocolMarker>::DEBUG_NAME;
Self { client: fidl::client::Client::new(channel, protocol_name) }
}
/// Get a Stream of events from the remote end of the protocol.
///
/// # Panics
///
/// Panics if the event stream was already taken.
pub fn take_event_stream(&self) -> ProviderEventStream {
ProviderEventStream { event_receiver: self.client.take_event_receiver() }
}
/// Used to register for memory pressure level changes.
/// `watcher`: memory pressure `Watcher` channel that the `Provider` will use to send
/// level change messages to the client.
///
/// The current memory pressure level is immediately sent to the watcher
/// when this method is called.
///
/// It is recommended that the root job in a component tree register for changes,
/// rather than having individual jobs further down the tree register individually.
/// A low client count will help minimize system churn due to a large number of
/// memory pressure messages in transit at the same time.
/// Also, the more context a job has, the better equipped it will be to react to
/// memory pressure by controlling the behavior of children jobs in its tree.
pub fn r#register_watcher(
&self,
mut watcher: fidl::endpoints::ClientEnd<WatcherMarker>,
) -> Result<(), fidl::Error> {
ProviderProxyInterface::r#register_watcher(self, watcher)
}
}
impl ProviderProxyInterface for ProviderProxy {
fn r#register_watcher(
&self,
mut watcher: fidl::endpoints::ClientEnd<WatcherMarker>,
) -> Result<(), fidl::Error> {
self.client.send::<ProviderRegisterWatcherRequest>(
(watcher,),
0x91e65af25aae4a9,
fidl::encoding::DynamicFlags::empty(),
)
}
}
pub struct ProviderEventStream {
event_receiver: fidl::client::EventReceiver,
}
impl std::marker::Unpin for ProviderEventStream {}
impl futures::stream::FusedStream for ProviderEventStream {
fn is_terminated(&self) -> bool {
self.event_receiver.is_terminated()
}
}
impl futures::Stream for ProviderEventStream {
type Item = Result<ProviderEvent, fidl::Error>;
fn poll_next(
mut self: std::pin::Pin<&mut Self>,
cx: &mut std::task::Context<'_>,
) -> std::task::Poll<Option<Self::Item>> {
match futures::ready!(futures::stream::StreamExt::poll_next_unpin(
&mut self.event_receiver,
cx
)?) {
Some(buf) => std::task::Poll::Ready(Some(ProviderEvent::decode(buf))),
None => std::task::Poll::Ready(None),
}
}
}
#[derive(Debug)]
pub enum ProviderEvent {}
impl ProviderEvent {
/// Decodes a message buffer as a [`ProviderEvent`].
fn decode(mut buf: fidl::MessageBufEtc) -> Result<ProviderEvent, fidl::Error> {
let (bytes, _handles) = buf.split_mut();
let (tx_header, _body_bytes) = fidl::encoding::decode_transaction_header(bytes)?;
debug_assert_eq!(tx_header.tx_id, 0);
match tx_header.ordinal {
_ => Err(fidl::Error::UnknownOrdinal {
ordinal: tx_header.ordinal,
protocol_name: <ProviderMarker as fidl::endpoints::ProtocolMarker>::DEBUG_NAME,
}),
}
}
}
/// A Stream of incoming requests for fuchsia.memorypressure/Provider.
pub struct ProviderRequestStream {
inner: std::sync::Arc<fidl::ServeInner>,
is_terminated: bool,
}
impl std::marker::Unpin for ProviderRequestStream {}
impl futures::stream::FusedStream for ProviderRequestStream {
fn is_terminated(&self) -> bool {
self.is_terminated
}
}
impl fidl::endpoints::RequestStream for ProviderRequestStream {
type Protocol = ProviderMarker;
type ControlHandle = ProviderControlHandle;
fn from_channel(channel: fidl::AsyncChannel) -> Self {
Self { inner: std::sync::Arc::new(fidl::ServeInner::new(channel)), is_terminated: false }
}
fn control_handle(&self) -> Self::ControlHandle {
ProviderControlHandle { inner: self.inner.clone() }
}
fn into_inner(self) -> (::std::sync::Arc<fidl::ServeInner>, bool) {
(self.inner, self.is_terminated)
}
fn from_inner(inner: std::sync::Arc<fidl::ServeInner>, is_terminated: bool) -> Self {
Self { inner, is_terminated }
}
}
impl futures::Stream for ProviderRequestStream {
type Item = Result<ProviderRequest, fidl::Error>;
fn poll_next(
mut self: std::pin::Pin<&mut Self>,
cx: &mut std::task::Context<'_>,
) -> std::task::Poll<Option<Self::Item>> {
let this = &mut *self;
if this.inner.check_shutdown(cx) {
this.is_terminated = true;
return std::task::Poll::Ready(None);
}
if this.is_terminated {
panic!("polled ProviderRequestStream after completion");
}
fidl::encoding::with_tls_decode_buf(|bytes, handles| {
match this.inner.channel().read_etc(cx, bytes, handles) {
std::task::Poll::Ready(Ok(())) => {}
std::task::Poll::Pending => return std::task::Poll::Pending,
std::task::Poll::Ready(Err(zx_status::Status::PEER_CLOSED)) => {
this.is_terminated = true;
return std::task::Poll::Ready(None);
}
std::task::Poll::Ready(Err(e)) => {
return std::task::Poll::Ready(Some(Err(fidl::Error::ServerRequestRead(e))))
}
}
// A message has been received from the channel
let (header, _body_bytes) = fidl::encoding::decode_transaction_header(bytes)?;
std::task::Poll::Ready(Some(match header.ordinal {
0x91e65af25aae4a9 => {
header.validate_request_tx_id(fidl::MethodType::OneWay)?;
let mut req = fidl::new_empty!(ProviderRegisterWatcherRequest);
fidl::encoding::Decoder::decode_into::<ProviderRegisterWatcherRequest>(
&header,
_body_bytes,
handles,
&mut req,
)?;
let control_handle = ProviderControlHandle { inner: this.inner.clone() };
Ok(ProviderRequest::RegisterWatcher { watcher: req.watcher, control_handle })
}
_ => Err(fidl::Error::UnknownOrdinal {
ordinal: header.ordinal,
protocol_name: <ProviderMarker as fidl::endpoints::ProtocolMarker>::DEBUG_NAME,
}),
}))
})
}
}
/// Registration protocol
#[derive(Debug)]
pub enum ProviderRequest {
/// Used to register for memory pressure level changes.
/// `watcher`: memory pressure `Watcher` channel that the `Provider` will use to send
/// level change messages to the client.
///
/// The current memory pressure level is immediately sent to the watcher
/// when this method is called.
///
/// It is recommended that the root job in a component tree register for changes,
/// rather than having individual jobs further down the tree register individually.
/// A low client count will help minimize system churn due to a large number of
/// memory pressure messages in transit at the same time.
/// Also, the more context a job has, the better equipped it will be to react to
/// memory pressure by controlling the behavior of children jobs in its tree.
RegisterWatcher {
watcher: fidl::endpoints::ClientEnd<WatcherMarker>,
control_handle: ProviderControlHandle,
},
}
impl ProviderRequest {
#[allow(irrefutable_let_patterns)]
pub fn into_register_watcher(
self,
) -> Option<(fidl::endpoints::ClientEnd<WatcherMarker>, ProviderControlHandle)> {
if let ProviderRequest::RegisterWatcher { watcher, control_handle } = self {
Some((watcher, control_handle))
} else {
None
}
}
/// Name of the method defined in FIDL
pub fn method_name(&self) -> &'static str {
match *self {
ProviderRequest::RegisterWatcher { .. } => "register_watcher",
}
}
}
#[derive(Debug, Clone)]
pub struct ProviderControlHandle {
inner: std::sync::Arc<fidl::ServeInner>,
}
impl fidl::endpoints::ControlHandle for ProviderControlHandle {
fn shutdown(&self) {
self.inner.shutdown()
}
fn shutdown_with_epitaph(&self, status: zx_status::Status) {
self.inner.shutdown_with_epitaph(status)
}
fn is_closed(&self) -> bool {
self.inner.channel().is_closed()
}
fn on_closed<'a>(&'a self) -> fidl::OnSignals<'a> {
self.inner.channel().on_closed()
}
}
impl ProviderControlHandle {}
#[derive(Debug, Copy, Clone, Eq, PartialEq, Ord, PartialOrd, Hash)]
pub struct WatcherMarker;
impl fidl::endpoints::ProtocolMarker for WatcherMarker {
type Proxy = WatcherProxy;
type RequestStream = WatcherRequestStream;
#[cfg(target_os = "fuchsia")]
type SynchronousProxy = WatcherSynchronousProxy;
const DEBUG_NAME: &'static str = "(anonymous) Watcher";
}
pub trait WatcherProxyInterface: Send + Sync {
type OnLevelChangedResponseFut: std::future::Future<Output = Result<(), fidl::Error>> + Send;
fn r#on_level_changed(&self, level: Level) -> Self::OnLevelChangedResponseFut;
}
#[derive(Debug)]
#[cfg(target_os = "fuchsia")]
pub struct WatcherSynchronousProxy {
client: fidl::client::sync::Client,
}
#[cfg(target_os = "fuchsia")]
impl fidl::endpoints::SynchronousProxy for WatcherSynchronousProxy {
type Proxy = WatcherProxy;
type Protocol = WatcherMarker;
fn from_channel(inner: fidl::Channel) -> Self {
Self::new(inner)
}
fn into_channel(self) -> fidl::Channel {
self.client.into_channel()
}
fn as_channel(&self) -> &fidl::Channel {
self.client.as_channel()
}
}
#[cfg(target_os = "fuchsia")]
impl WatcherSynchronousProxy {
pub fn new(channel: fidl::Channel) -> Self {
let protocol_name = <WatcherMarker as fidl::endpoints::ProtocolMarker>::DEBUG_NAME;
Self { client: fidl::client::sync::Client::new(channel, protocol_name) }
}
pub fn into_channel(self) -> fidl::Channel {
self.client.into_channel()
}
/// Waits until an event arrives and returns it. It is safe for other
/// threads to make concurrent requests while waiting for an event.
pub fn wait_for_event(&self, deadline: zx::Time) -> Result<WatcherEvent, fidl::Error> {
WatcherEvent::decode(self.client.wait_for_event(deadline)?)
}
/// Sent to the registered client when the memory pressure level changes.
/// `level`: indicates the current memory pressure level.
///
/// Will also be invoked on initial connection via `RegisterWatcher`, so that a newly
/// registered client can discover the current memory pressure level.
///
/// The watcher must immediately reply with a message to acknowledge that it has
/// received the level change notification, and has initiated required actions as a
/// result. It may then continue to reclaim memory asynchronously after sending
/// the acknowledgement.
///
/// Some helpful guidelines for clients:
/// 1. The watcher will be notified of new pressure level changes only after a reply
/// corresponding to the previous message has been received by the provider.
/// If multiple level transitions occur during that time, the watcher will be
/// notified of the latest pressure level.
///
/// 2. The level changes are edge-triggered, and clients are expected to maintain
/// local state to track the current pressure level, if required. For example,
/// a job might be notified of a CRITICAL level and drop all its caches as a result.
/// Some time after this, it might want to trigger an activity that causes a
/// fair amount of memory to be allocated. At this point, the job is expected to
/// remember that the last pressure level it saw was CRITICAL, and refrain from
/// triggering the memory-intensive activity.
///
/// 3. As a performance optimization, the provider may decide to skip sending
/// messages for some pressure level changes. For example, when oscillating across
/// the NORMAL / WARNING boundary, it might not be worth notifying clients of every
/// single transition. The provider might rate-limit messages in this case.
/// On a similar note, the provider may decide to send repeated messages at the
/// same pressure level, particularly CRITICAL, to indicate that further action
/// needs to be taken.
pub fn r#on_level_changed(
&self,
mut level: Level,
___deadline: zx::Time,
) -> Result<(), fidl::Error> {
let _response =
self.client.send_query::<WatcherOnLevelChangedRequest, fidl::encoding::EmptyPayload>(
(level,),
0x55d559533407fed9,
fidl::encoding::DynamicFlags::empty(),
___deadline,
)?;
Ok(_response)
}
}
#[derive(Debug, Clone)]
pub struct WatcherProxy {
client: fidl::client::Client,
}
impl fidl::endpoints::Proxy for WatcherProxy {
type Protocol = WatcherMarker;
fn from_channel(inner: fidl::AsyncChannel) -> Self {
Self::new(inner)
}
fn into_channel(self) -> Result<::fidl::AsyncChannel, Self> {
self.client.into_channel().map_err(|client| Self { client })
}
fn as_channel(&self) -> &::fidl::AsyncChannel {
self.client.as_channel()
}
}
impl WatcherProxy {
/// Create a new Proxy for fuchsia.memorypressure/Watcher.
pub fn new(channel: fidl::AsyncChannel) -> Self {
let protocol_name = <WatcherMarker as fidl::endpoints::ProtocolMarker>::DEBUG_NAME;
Self { client: fidl::client::Client::new(channel, protocol_name) }
}
/// Get a Stream of events from the remote end of the protocol.
///
/// # Panics
///
/// Panics if the event stream was already taken.
pub fn take_event_stream(&self) -> WatcherEventStream {
WatcherEventStream { event_receiver: self.client.take_event_receiver() }
}
/// Sent to the registered client when the memory pressure level changes.
/// `level`: indicates the current memory pressure level.
///
/// Will also be invoked on initial connection via `RegisterWatcher`, so that a newly
/// registered client can discover the current memory pressure level.
///
/// The watcher must immediately reply with a message to acknowledge that it has
/// received the level change notification, and has initiated required actions as a
/// result. It may then continue to reclaim memory asynchronously after sending
/// the acknowledgement.
///
/// Some helpful guidelines for clients:
/// 1. The watcher will be notified of new pressure level changes only after a reply
/// corresponding to the previous message has been received by the provider.
/// If multiple level transitions occur during that time, the watcher will be
/// notified of the latest pressure level.
///
/// 2. The level changes are edge-triggered, and clients are expected to maintain
/// local state to track the current pressure level, if required. For example,
/// a job might be notified of a CRITICAL level and drop all its caches as a result.
/// Some time after this, it might want to trigger an activity that causes a
/// fair amount of memory to be allocated. At this point, the job is expected to
/// remember that the last pressure level it saw was CRITICAL, and refrain from
/// triggering the memory-intensive activity.
///
/// 3. As a performance optimization, the provider may decide to skip sending
/// messages for some pressure level changes. For example, when oscillating across
/// the NORMAL / WARNING boundary, it might not be worth notifying clients of every
/// single transition. The provider might rate-limit messages in this case.
/// On a similar note, the provider may decide to send repeated messages at the
/// same pressure level, particularly CRITICAL, to indicate that further action
/// needs to be taken.
pub fn r#on_level_changed(&self, mut level: Level) -> fidl::client::QueryResponseFut<()> {
WatcherProxyInterface::r#on_level_changed(self, level)
}
}
impl WatcherProxyInterface for WatcherProxy {
type OnLevelChangedResponseFut = fidl::client::QueryResponseFut<()>;
fn r#on_level_changed(&self, mut level: Level) -> Self::OnLevelChangedResponseFut {
fn _decode(mut _buf: Result<fidl::MessageBufEtc, fidl::Error>) -> Result<(), fidl::Error> {
let _response = fidl::client::decode_transaction_body::<
fidl::encoding::EmptyPayload,
0x55d559533407fed9,
>(_buf?)?;
Ok(_response)
}
self.client.send_query_and_decode::<WatcherOnLevelChangedRequest, ()>(
(level,),
0x55d559533407fed9,
fidl::encoding::DynamicFlags::empty(),
_decode,
)
}
}
pub struct WatcherEventStream {
event_receiver: fidl::client::EventReceiver,
}
impl std::marker::Unpin for WatcherEventStream {}
impl futures::stream::FusedStream for WatcherEventStream {
fn is_terminated(&self) -> bool {
self.event_receiver.is_terminated()
}
}
impl futures::Stream for WatcherEventStream {
type Item = Result<WatcherEvent, fidl::Error>;
fn poll_next(
mut self: std::pin::Pin<&mut Self>,
cx: &mut std::task::Context<'_>,
) -> std::task::Poll<Option<Self::Item>> {
match futures::ready!(futures::stream::StreamExt::poll_next_unpin(
&mut self.event_receiver,
cx
)?) {
Some(buf) => std::task::Poll::Ready(Some(WatcherEvent::decode(buf))),
None => std::task::Poll::Ready(None),
}
}
}
#[derive(Debug)]
pub enum WatcherEvent {}
impl WatcherEvent {
/// Decodes a message buffer as a [`WatcherEvent`].
fn decode(mut buf: fidl::MessageBufEtc) -> Result<WatcherEvent, fidl::Error> {
let (bytes, _handles) = buf.split_mut();
let (tx_header, _body_bytes) = fidl::encoding::decode_transaction_header(bytes)?;
debug_assert_eq!(tx_header.tx_id, 0);
match tx_header.ordinal {
_ => Err(fidl::Error::UnknownOrdinal {
ordinal: tx_header.ordinal,
protocol_name: <WatcherMarker as fidl::endpoints::ProtocolMarker>::DEBUG_NAME,
}),
}
}
}
/// A Stream of incoming requests for fuchsia.memorypressure/Watcher.
pub struct WatcherRequestStream {
inner: std::sync::Arc<fidl::ServeInner>,
is_terminated: bool,
}
impl std::marker::Unpin for WatcherRequestStream {}
impl futures::stream::FusedStream for WatcherRequestStream {
fn is_terminated(&self) -> bool {
self.is_terminated
}
}
impl fidl::endpoints::RequestStream for WatcherRequestStream {
type Protocol = WatcherMarker;
type ControlHandle = WatcherControlHandle;
fn from_channel(channel: fidl::AsyncChannel) -> Self {
Self { inner: std::sync::Arc::new(fidl::ServeInner::new(channel)), is_terminated: false }
}
fn control_handle(&self) -> Self::ControlHandle {
WatcherControlHandle { inner: self.inner.clone() }
}
fn into_inner(self) -> (::std::sync::Arc<fidl::ServeInner>, bool) {
(self.inner, self.is_terminated)
}
fn from_inner(inner: std::sync::Arc<fidl::ServeInner>, is_terminated: bool) -> Self {
Self { inner, is_terminated }
}
}
impl futures::Stream for WatcherRequestStream {
type Item = Result<WatcherRequest, fidl::Error>;
fn poll_next(
mut self: std::pin::Pin<&mut Self>,
cx: &mut std::task::Context<'_>,
) -> std::task::Poll<Option<Self::Item>> {
let this = &mut *self;
if this.inner.check_shutdown(cx) {
this.is_terminated = true;
return std::task::Poll::Ready(None);
}
if this.is_terminated {
panic!("polled WatcherRequestStream after completion");
}
fidl::encoding::with_tls_decode_buf(|bytes, handles| {
match this.inner.channel().read_etc(cx, bytes, handles) {
std::task::Poll::Ready(Ok(())) => {}
std::task::Poll::Pending => return std::task::Poll::Pending,
std::task::Poll::Ready(Err(zx_status::Status::PEER_CLOSED)) => {
this.is_terminated = true;
return std::task::Poll::Ready(None);
}
std::task::Poll::Ready(Err(e)) => {
return std::task::Poll::Ready(Some(Err(fidl::Error::ServerRequestRead(e))))
}
}
// A message has been received from the channel
let (header, _body_bytes) = fidl::encoding::decode_transaction_header(bytes)?;
std::task::Poll::Ready(Some(match header.ordinal {
0x55d559533407fed9 => {
header.validate_request_tx_id(fidl::MethodType::TwoWay)?;
let mut req = fidl::new_empty!(WatcherOnLevelChangedRequest);
fidl::encoding::Decoder::decode_into::<WatcherOnLevelChangedRequest>(
&header,
_body_bytes,
handles,
&mut req,
)?;
let control_handle = WatcherControlHandle { inner: this.inner.clone() };
Ok(WatcherRequest::OnLevelChanged {
level: req.level,
responder: WatcherOnLevelChangedResponder {
control_handle: std::mem::ManuallyDrop::new(control_handle),
tx_id: header.tx_id,
},
})
}
_ => Err(fidl::Error::UnknownOrdinal {
ordinal: header.ordinal,
protocol_name: <WatcherMarker as fidl::endpoints::ProtocolMarker>::DEBUG_NAME,
}),
}))
})
}
}
/// Watcher protocol
/// To be implemented by clients who wish to be notified on memory pressure level changes.
#[derive(Debug)]
pub enum WatcherRequest {
/// Sent to the registered client when the memory pressure level changes.
/// `level`: indicates the current memory pressure level.
///
/// Will also be invoked on initial connection via `RegisterWatcher`, so that a newly
/// registered client can discover the current memory pressure level.
///
/// The watcher must immediately reply with a message to acknowledge that it has
/// received the level change notification, and has initiated required actions as a
/// result. It may then continue to reclaim memory asynchronously after sending
/// the acknowledgement.
///
/// Some helpful guidelines for clients:
/// 1. The watcher will be notified of new pressure level changes only after a reply
/// corresponding to the previous message has been received by the provider.
/// If multiple level transitions occur during that time, the watcher will be
/// notified of the latest pressure level.
///
/// 2. The level changes are edge-triggered, and clients are expected to maintain
/// local state to track the current pressure level, if required. For example,
/// a job might be notified of a CRITICAL level and drop all its caches as a result.
/// Some time after this, it might want to trigger an activity that causes a
/// fair amount of memory to be allocated. At this point, the job is expected to
/// remember that the last pressure level it saw was CRITICAL, and refrain from
/// triggering the memory-intensive activity.
///
/// 3. As a performance optimization, the provider may decide to skip sending
/// messages for some pressure level changes. For example, when oscillating across
/// the NORMAL / WARNING boundary, it might not be worth notifying clients of every
/// single transition. The provider might rate-limit messages in this case.
/// On a similar note, the provider may decide to send repeated messages at the
/// same pressure level, particularly CRITICAL, to indicate that further action
/// needs to be taken.
OnLevelChanged { level: Level, responder: WatcherOnLevelChangedResponder },
}
impl WatcherRequest {
#[allow(irrefutable_let_patterns)]
pub fn into_on_level_changed(self) -> Option<(Level, WatcherOnLevelChangedResponder)> {
if let WatcherRequest::OnLevelChanged { level, responder } = self {
Some((level, responder))
} else {
None
}
}
/// Name of the method defined in FIDL
pub fn method_name(&self) -> &'static str {
match *self {
WatcherRequest::OnLevelChanged { .. } => "on_level_changed",
}
}
}
#[derive(Debug, Clone)]
pub struct WatcherControlHandle {
inner: std::sync::Arc<fidl::ServeInner>,
}
impl fidl::endpoints::ControlHandle for WatcherControlHandle {
fn shutdown(&self) {
self.inner.shutdown()
}
fn shutdown_with_epitaph(&self, status: zx_status::Status) {
self.inner.shutdown_with_epitaph(status)
}
fn is_closed(&self) -> bool {
self.inner.channel().is_closed()
}
fn on_closed<'a>(&'a self) -> fidl::OnSignals<'a> {
self.inner.channel().on_closed()
}
}
impl WatcherControlHandle {}
#[must_use = "FIDL methods require a response to be sent"]
#[derive(Debug)]
pub struct WatcherOnLevelChangedResponder {
control_handle: std::mem::ManuallyDrop<WatcherControlHandle>,
tx_id: u32,
}
/// Set the the channel to be shutdown (see [`WatcherControlHandle::shutdown`])
/// if the responder is dropped without sending a response, so that the client
/// doesn't hang. To prevent this behavior, call `drop_without_shutdown`.
impl std::ops::Drop for WatcherOnLevelChangedResponder {
fn drop(&mut self) {
self.control_handle.shutdown();
// Safety: drops once, never accessed again
unsafe { std::mem::ManuallyDrop::drop(&mut self.control_handle) };
}
}
impl fidl::endpoints::Responder for WatcherOnLevelChangedResponder {
type ControlHandle = WatcherControlHandle;
fn control_handle(&self) -> &WatcherControlHandle {
&self.control_handle
}
fn drop_without_shutdown(mut self) {
// Safety: drops once, never accessed again due to mem::forget
unsafe { std::mem::ManuallyDrop::drop(&mut self.control_handle) };
// Prevent Drop from running (which would shut down the channel)
std::mem::forget(self);
}
}
impl WatcherOnLevelChangedResponder {
/// Sends a response to the FIDL transaction.
///
/// Sets the channel to shutdown if an error occurs.
pub fn send(self) -> Result<(), fidl::Error> {
let _result = self.send_raw();
if _result.is_err() {
self.control_handle.shutdown();
}
self.drop_without_shutdown();
_result
}
/// Similar to "send" but does not shutdown the channel if an error occurs.
pub fn send_no_shutdown_on_err(self) -> Result<(), fidl::Error> {
let _result = self.send_raw();
self.drop_without_shutdown();
_result
}
fn send_raw(&self) -> Result<(), fidl::Error> {
self.control_handle.inner.send::<fidl::encoding::EmptyPayload>(
(),
self.tx_id,
0x55d559533407fed9,
fidl::encoding::DynamicFlags::empty(),
)
}
}
mod internal {
use super::*;
unsafe impl fidl::encoding::TypeMarker for Level {
type Owned = Self;
#[inline(always)]
fn inline_align(_context: fidl::encoding::Context) -> usize {
std::mem::align_of::<u32>()
}
#[inline(always)]
fn inline_size(_context: fidl::encoding::Context) -> usize {
std::mem::size_of::<u32>()
}
#[inline(always)]
fn encode_is_copy() -> bool {
true
}
#[inline(always)]
fn decode_is_copy() -> bool {
false
}
}
impl fidl::encoding::ValueTypeMarker for Level {
type Borrowed<'a> = Self;
#[inline(always)]
fn borrow<'a>(
value: &'a <Self as fidl::encoding::TypeMarker>::Owned,
) -> Self::Borrowed<'a> {
*value
}
}
unsafe impl fidl::encoding::Encode<Self> for Level {
#[inline]
unsafe fn encode(
self,
encoder: &mut fidl::encoding::Encoder<'_>,
offset: usize,
_depth: fidl::encoding::Depth,
) -> fidl::Result<()> {
encoder.debug_check_bounds::<Self>(offset);
encoder.write_num(self.into_primitive(), offset);
Ok(())
}
}
impl fidl::encoding::Decode<Self> for Level {
#[inline(always)]
fn new_empty() -> Self {
Self::Normal
}
#[inline]
unsafe fn decode(
&mut self,
decoder: &mut fidl::encoding::Decoder<'_>,
offset: usize,
_depth: fidl::encoding::Depth,
) -> fidl::Result<()> {
decoder.debug_check_bounds::<Self>(offset);
let prim = decoder.read_num::<u32>(offset);
*self = Self::from_primitive(prim).ok_or(fidl::Error::InvalidEnumValue)?;
Ok(())
}
}
unsafe impl fidl::encoding::TypeMarker for ProviderRegisterWatcherRequest {
type Owned = Self;
#[inline(always)]
fn inline_align(_context: fidl::encoding::Context) -> usize {
4
}
#[inline(always)]
fn inline_size(_context: fidl::encoding::Context) -> usize {
4
}
}
impl fidl::encoding::ResourceTypeMarker for ProviderRegisterWatcherRequest {
type Borrowed<'a> = &'a mut Self;
fn take_or_borrow<'a>(
value: &'a mut <Self as fidl::encoding::TypeMarker>::Owned,
) -> Self::Borrowed<'a> {
value
}
}
unsafe impl fidl::encoding::Encode<ProviderRegisterWatcherRequest>
for &mut ProviderRegisterWatcherRequest
{
#[inline]
unsafe fn encode(
self,
encoder: &mut fidl::encoding::Encoder<'_>,
offset: usize,
_depth: fidl::encoding::Depth,
) -> fidl::Result<()> {
encoder.debug_check_bounds::<ProviderRegisterWatcherRequest>(offset);
// Delegate to tuple encoding.
fidl::encoding::Encode::<ProviderRegisterWatcherRequest>::encode(
(
<fidl::encoding::Endpoint<fidl::endpoints::ClientEnd<WatcherMarker>> as fidl::encoding::ResourceTypeMarker>::take_or_borrow(&mut self.watcher),
),
encoder, offset, _depth
)
}
}
unsafe impl<
T0: fidl::encoding::Encode<
fidl::encoding::Endpoint<fidl::endpoints::ClientEnd<WatcherMarker>>,
>,
> fidl::encoding::Encode<ProviderRegisterWatcherRequest> for (T0,)
{
#[inline]
unsafe fn encode(
self,
encoder: &mut fidl::encoding::Encoder<'_>,
offset: usize,
depth: fidl::encoding::Depth,
) -> fidl::Result<()> {
encoder.debug_check_bounds::<ProviderRegisterWatcherRequest>(offset);
// Zero out padding regions. There's no need to apply masks
// because the unmasked parts will be overwritten by fields.
// Write the fields.
self.0.encode(encoder, offset + 0, depth)?;
Ok(())
}
}
impl fidl::encoding::Decode<Self> for ProviderRegisterWatcherRequest {
#[inline(always)]
fn new_empty() -> Self {
Self {
watcher: fidl::new_empty!(
fidl::encoding::Endpoint<fidl::endpoints::ClientEnd<WatcherMarker>>
),
}
}
#[inline]
unsafe fn decode(
&mut self,
decoder: &mut fidl::encoding::Decoder<'_>,
offset: usize,
_depth: fidl::encoding::Depth,
) -> fidl::Result<()> {
decoder.debug_check_bounds::<Self>(offset);
// Verify that padding bytes are zero.
fidl::decode!(
fidl::encoding::Endpoint<fidl::endpoints::ClientEnd<WatcherMarker>>,
&mut self.watcher,
decoder,
offset + 0,
_depth
)?;
Ok(())
}
}
unsafe impl fidl::encoding::TypeMarker for WatcherOnLevelChangedRequest {
type Owned = Self;
#[inline(always)]
fn inline_align(_context: fidl::encoding::Context) -> usize {
4
}
#[inline(always)]
fn inline_size(_context: fidl::encoding::Context) -> usize {
4
}
}
impl fidl::encoding::ValueTypeMarker for WatcherOnLevelChangedRequest {
type Borrowed<'a> = &'a Self;
fn borrow<'a>(
value: &'a <Self as fidl::encoding::TypeMarker>::Owned,
) -> Self::Borrowed<'a> {
value
}
}
unsafe impl fidl::encoding::Encode<WatcherOnLevelChangedRequest> for &WatcherOnLevelChangedRequest {
#[inline]
unsafe fn encode(
self,
encoder: &mut fidl::encoding::Encoder<'_>,
offset: usize,
_depth: fidl::encoding::Depth,
) -> fidl::Result<()> {
encoder.debug_check_bounds::<WatcherOnLevelChangedRequest>(offset);
// Delegate to tuple encoding.
fidl::encoding::Encode::<WatcherOnLevelChangedRequest>::encode(
(<Level as fidl::encoding::ValueTypeMarker>::borrow(&self.level),),
encoder,
offset,
_depth,
)
}
}
unsafe impl<T0: fidl::encoding::Encode<Level>>
fidl::encoding::Encode<WatcherOnLevelChangedRequest> for (T0,)
{
#[inline]
unsafe fn encode(
self,
encoder: &mut fidl::encoding::Encoder<'_>,
offset: usize,
depth: fidl::encoding::Depth,
) -> fidl::Result<()> {
encoder.debug_check_bounds::<WatcherOnLevelChangedRequest>(offset);
// Zero out padding regions. There's no need to apply masks
// because the unmasked parts will be overwritten by fields.
// Write the fields.
self.0.encode(encoder, offset + 0, depth)?;
Ok(())
}
}
impl fidl::encoding::Decode<Self> for WatcherOnLevelChangedRequest {
#[inline(always)]
fn new_empty() -> Self {
Self { level: fidl::new_empty!(Level) }
}
#[inline]
unsafe fn decode(
&mut self,
decoder: &mut fidl::encoding::Decoder<'_>,
offset: usize,
_depth: fidl::encoding::Depth,
) -> fidl::Result<()> {
decoder.debug_check_bounds::<Self>(offset);
// Verify that padding bytes are zero.
fidl::decode!(Level, &mut self.level, decoder, offset + 0, _depth)?;
Ok(())
}
}
}