zx_types/
lib.rs

1// Copyright 2024 The Fuchsia Authors. All rights reserved.
2// Use of this source code is governed by a BSD-style license that can be
3// found in the LICENSE file.
4
5#![allow(non_camel_case_types)]
6
7use std::fmt::{self, Debug};
8use std::hash::{Hash, Hasher};
9use std::sync::atomic::AtomicI32;
10#[cfg(feature = "zerocopy")]
11use zerocopy::{FromBytes, FromZeros, Immutable, IntoBytes, KnownLayout};
12
13pub type zx_addr_t = usize;
14pub type zx_stream_seek_origin_t = u32;
15pub type zx_clock_t = u32;
16pub type zx_duration_t = i64;
17pub type zx_duration_mono_t = i64;
18pub type zx_duration_mono_ticks_t = i64;
19pub type zx_duration_boot_t = i64;
20pub type zx_duration_boot_ticks_t = i64;
21pub type zx_futex_t = AtomicI32;
22pub type zx_gpaddr_t = usize;
23pub type zx_guest_option_t = u32;
24pub type zx_vcpu_option_t = u32;
25pub type zx_guest_trap_t = u32;
26pub type zx_handle_t = u32;
27pub type zx_handle_op_t = u32;
28pub type zx_koid_t = u64;
29pub type zx_obj_type_t = u32;
30pub type zx_object_info_topic_t = u32;
31pub type zx_info_maps_type_t = u32;
32pub type zx_instant_boot_t = i64;
33pub type zx_instant_boot_ticks_t = i64;
34pub type zx_instant_mono_t = i64;
35pub type zx_instant_mono_ticks_t = i64;
36pub type zx_iob_access_t = u32;
37pub type zx_iob_allocate_id_options_t = u32;
38pub type zx_iob_discipline_type_t = u64;
39pub type zx_iob_region_type_t = u32;
40pub type zx_iob_write_options_t = u64;
41pub type zx_off_t = u64;
42pub type zx_paddr_t = usize;
43pub type zx_rights_t = u32;
44pub type zx_rsrc_flags_t = u32;
45pub type zx_rsrc_kind_t = u32;
46pub type zx_signals_t = u32;
47pub type zx_ssize_t = isize;
48pub type zx_status_t = i32;
49pub type zx_rsrc_system_base_t = u64;
50pub type zx_ticks_t = i64;
51pub type zx_time_t = i64;
52pub type zx_txid_t = u32;
53pub type zx_vaddr_t = usize;
54pub type zx_vm_option_t = u32;
55pub type zx_thread_state_topic_t = u32;
56pub type zx_vcpu_state_topic_t = u32;
57pub type zx_restricted_reason_t = u64;
58pub type zx_processor_power_level_options_t = u64;
59pub type zx_processor_power_control_t = u64;
60pub type zx_system_memory_stall_type_t = u32;
61
62macro_rules! const_assert {
63    ($e:expr $(,)?) => {
64        const _: [(); 1 - { const ASSERT: bool = $e; ASSERT as usize }] = [];
65    };
66}
67macro_rules! const_assert_eq {
68    ($lhs:expr, $rhs:expr $(,)?) => {
69        const_assert!($lhs == $rhs);
70    };
71}
72
73// TODO: magically coerce this to &`static str somehow?
74#[repr(C)]
75#[derive(Debug, Copy, Clone, Eq, PartialEq)]
76pub struct zx_string_view_t {
77    pub c_str: *const u8, // Guaranteed NUL-terminated valid UTF-8.
78    pub length: usize,
79}
80
81pub const ZX_MAX_NAME_LEN: usize = 32;
82
83// TODO: combine these macros with the bitflags and assoc consts macros below
84// so that we only have to do one macro invocation.
85// The result would look something like:
86// multiconst!(bitflags, zx_rights_t, Rights, [RIGHT_NONE => ZX_RIGHT_NONE = 0; ...]);
87// multiconst!(assoc_consts, zx_status_t, Status, [OK => ZX_OK = 0; ...]);
88// Note that the actual name of the inner macro (e.g. `bitflags`) can't be a variable.
89// It'll just have to be matched on manually
90macro_rules! multiconst {
91    ($typename:ident, [$($(#[$attr:meta])* $rawname:ident = $value:expr;)*]) => {
92        $(
93            $(#[$attr])*
94            pub const $rawname: $typename = $value;
95        )*
96    }
97}
98
99multiconst!(zx_handle_t, [
100    ZX_HANDLE_INVALID = 0;
101]);
102
103multiconst!(zx_handle_op_t, [
104    ZX_HANDLE_OP_MOVE = 0;
105    ZX_HANDLE_OP_DUPLICATE = 1;
106]);
107
108multiconst!(zx_koid_t, [
109    ZX_KOID_INVALID = 0;
110    ZX_KOID_KERNEL = 1;
111    ZX_KOID_FIRST = 1024;
112]);
113
114multiconst!(zx_time_t, [
115    ZX_TIME_INFINITE = i64::MAX;
116    ZX_TIME_INFINITE_PAST = ::std::i64::MIN;
117]);
118
119multiconst!(zx_rights_t, [
120    ZX_RIGHT_NONE           = 0;
121    ZX_RIGHT_DUPLICATE      = 1 << 0;
122    ZX_RIGHT_TRANSFER       = 1 << 1;
123    ZX_RIGHT_READ           = 1 << 2;
124    ZX_RIGHT_WRITE          = 1 << 3;
125    ZX_RIGHT_EXECUTE        = 1 << 4;
126    ZX_RIGHT_MAP            = 1 << 5;
127    ZX_RIGHT_GET_PROPERTY   = 1 << 6;
128    ZX_RIGHT_SET_PROPERTY   = 1 << 7;
129    ZX_RIGHT_ENUMERATE      = 1 << 8;
130    ZX_RIGHT_DESTROY        = 1 << 9;
131    ZX_RIGHT_SET_POLICY     = 1 << 10;
132    ZX_RIGHT_GET_POLICY     = 1 << 11;
133    ZX_RIGHT_SIGNAL         = 1 << 12;
134    ZX_RIGHT_SIGNAL_PEER    = 1 << 13;
135    ZX_RIGHT_WAIT           = 1 << 14;
136    ZX_RIGHT_INSPECT        = 1 << 15;
137    ZX_RIGHT_MANAGE_JOB     = 1 << 16;
138    ZX_RIGHT_MANAGE_PROCESS = 1 << 17;
139    ZX_RIGHT_MANAGE_THREAD  = 1 << 18;
140    ZX_RIGHT_APPLY_PROFILE  = 1 << 19;
141    ZX_RIGHT_MANAGE_SOCKET  = 1 << 20;
142    ZX_RIGHT_OP_CHILDREN    = 1 << 21;
143    ZX_RIGHT_RESIZE         = 1 << 22;
144    ZX_RIGHT_ATTACH_VMO     = 1 << 23;
145    ZX_RIGHT_MANAGE_VMO     = 1 << 24;
146    ZX_RIGHT_SAME_RIGHTS    = 1 << 31;
147]);
148
149multiconst!(u32, [
150    ZX_VMO_RESIZABLE = 1 << 1;
151    ZX_VMO_DISCARDABLE = 1 << 2;
152    ZX_VMO_TRAP_DIRTY = 1 << 3;
153    ZX_VMO_UNBOUNDED = 1 << 4;
154]);
155
156multiconst!(u64, [
157    ZX_VMO_DIRTY_RANGE_IS_ZERO = 1;
158]);
159
160multiconst!(u32, [
161    ZX_INFO_VMO_TYPE_PAGED = 1 << 0;
162    ZX_INFO_VMO_RESIZABLE = 1 << 1;
163    ZX_INFO_VMO_IS_COW_CLONE = 1 << 2;
164    ZX_INFO_VMO_VIA_HANDLE = 1 << 3;
165    ZX_INFO_VMO_VIA_MAPPING = 1 << 4;
166    ZX_INFO_VMO_PAGER_BACKED = 1 << 5;
167    ZX_INFO_VMO_CONTIGUOUS = 1 << 6;
168    ZX_INFO_VMO_DISCARDABLE = 1 << 7;
169    ZX_INFO_VMO_IMMUTABLE = 1 << 8;
170    ZX_INFO_VMO_VIA_IOB_HANDLE = 1 << 9;
171]);
172
173multiconst!(u32, [
174    ZX_VMO_OP_COMMIT = 1;
175    ZX_VMO_OP_DECOMMIT = 2;
176    ZX_VMO_OP_LOCK = 3;
177    ZX_VMO_OP_UNLOCK = 4;
178    ZX_VMO_OP_CACHE_SYNC = 6;
179    ZX_VMO_OP_CACHE_INVALIDATE = 7;
180    ZX_VMO_OP_CACHE_CLEAN = 8;
181    ZX_VMO_OP_CACHE_CLEAN_INVALIDATE = 9;
182    ZX_VMO_OP_ZERO = 10;
183    ZX_VMO_OP_TRY_LOCK = 11;
184    ZX_VMO_OP_DONT_NEED = 12;
185    ZX_VMO_OP_ALWAYS_NEED = 13;
186    ZX_VMO_OP_PREFETCH = 14;
187]);
188
189multiconst!(u32, [
190    ZX_VMAR_OP_COMMIT = 1;
191    ZX_VMAR_OP_DECOMMIT = 2;
192    ZX_VMAR_OP_MAP_RANGE = 3;
193    ZX_VMAR_OP_DONT_NEED = 12;
194    ZX_VMAR_OP_ALWAYS_NEED = 13;
195    ZX_VMAR_OP_PREFETCH = 14;
196]);
197
198multiconst!(zx_vm_option_t, [
199    ZX_VM_PERM_READ                    = 1 << 0;
200    ZX_VM_PERM_WRITE                   = 1 << 1;
201    ZX_VM_PERM_EXECUTE                 = 1 << 2;
202    ZX_VM_COMPACT                      = 1 << 3;
203    ZX_VM_SPECIFIC                     = 1 << 4;
204    ZX_VM_SPECIFIC_OVERWRITE           = 1 << 5;
205    ZX_VM_CAN_MAP_SPECIFIC             = 1 << 6;
206    ZX_VM_CAN_MAP_READ                 = 1 << 7;
207    ZX_VM_CAN_MAP_WRITE                = 1 << 8;
208    ZX_VM_CAN_MAP_EXECUTE              = 1 << 9;
209    ZX_VM_MAP_RANGE                    = 1 << 10;
210    ZX_VM_REQUIRE_NON_RESIZABLE        = 1 << 11;
211    ZX_VM_ALLOW_FAULTS                 = 1 << 12;
212    ZX_VM_OFFSET_IS_UPPER_LIMIT        = 1 << 13;
213    ZX_VM_PERM_READ_IF_XOM_UNSUPPORTED = 1 << 14;
214    ZX_VM_FAULT_BEYOND_STREAM_SIZE     = 1 << 15;
215
216    // VM alignment options
217    ZX_VM_ALIGN_BASE                   = 24;
218    ZX_VM_ALIGN_1KB                    = 10 << ZX_VM_ALIGN_BASE;
219    ZX_VM_ALIGN_2KB                    = 11 << ZX_VM_ALIGN_BASE;
220    ZX_VM_ALIGN_4KB                    = 12 << ZX_VM_ALIGN_BASE;
221    ZX_VM_ALIGN_8KB                    = 13 << ZX_VM_ALIGN_BASE;
222    ZX_VM_ALIGN_16KB                   = 14 << ZX_VM_ALIGN_BASE;
223    ZX_VM_ALIGN_32KB                   = 15 << ZX_VM_ALIGN_BASE;
224    ZX_VM_ALIGN_64KB                   = 16 << ZX_VM_ALIGN_BASE;
225    ZX_VM_ALIGN_128KB                  = 17 << ZX_VM_ALIGN_BASE;
226    ZX_VM_ALIGN_256KB                  = 18 << ZX_VM_ALIGN_BASE;
227    ZX_VM_ALIGN_512KB                  = 19 << ZX_VM_ALIGN_BASE;
228    ZX_VM_ALIGN_1MB                    = 20 << ZX_VM_ALIGN_BASE;
229    ZX_VM_ALIGN_2MB                    = 21 << ZX_VM_ALIGN_BASE;
230    ZX_VM_ALIGN_4MB                    = 22 << ZX_VM_ALIGN_BASE;
231    ZX_VM_ALIGN_8MB                    = 23 << ZX_VM_ALIGN_BASE;
232    ZX_VM_ALIGN_16MB                   = 24 << ZX_VM_ALIGN_BASE;
233    ZX_VM_ALIGN_32MB                   = 25 << ZX_VM_ALIGN_BASE;
234    ZX_VM_ALIGN_64MB                   = 26 << ZX_VM_ALIGN_BASE;
235    ZX_VM_ALIGN_128MB                  = 27 << ZX_VM_ALIGN_BASE;
236    ZX_VM_ALIGN_256MB                  = 28 << ZX_VM_ALIGN_BASE;
237    ZX_VM_ALIGN_512MB                  = 29 << ZX_VM_ALIGN_BASE;
238    ZX_VM_ALIGN_1GB                    = 30 << ZX_VM_ALIGN_BASE;
239    ZX_VM_ALIGN_2GB                    = 31 << ZX_VM_ALIGN_BASE;
240    ZX_VM_ALIGN_4GB                    = 32 << ZX_VM_ALIGN_BASE;
241]);
242
243multiconst!(u32, [
244    ZX_PROCESS_SHARED = 1 << 0;
245]);
246
247// matches ///zircon/system/public/zircon/errors.h
248multiconst!(zx_status_t, [
249    ZX_OK                         = 0;
250    ZX_ERR_INTERNAL               = -1;
251    ZX_ERR_NOT_SUPPORTED          = -2;
252    ZX_ERR_NO_RESOURCES           = -3;
253    ZX_ERR_NO_MEMORY              = -4;
254    ZX_ERR_INTERRUPTED_RETRY      = -6;
255    ZX_ERR_INVALID_ARGS           = -10;
256    ZX_ERR_BAD_HANDLE             = -11;
257    ZX_ERR_WRONG_TYPE             = -12;
258    ZX_ERR_BAD_SYSCALL            = -13;
259    ZX_ERR_OUT_OF_RANGE           = -14;
260    ZX_ERR_BUFFER_TOO_SMALL       = -15;
261    ZX_ERR_BAD_STATE              = -20;
262    ZX_ERR_TIMED_OUT              = -21;
263    ZX_ERR_SHOULD_WAIT            = -22;
264    ZX_ERR_CANCELED               = -23;
265    ZX_ERR_PEER_CLOSED            = -24;
266    ZX_ERR_NOT_FOUND              = -25;
267    ZX_ERR_ALREADY_EXISTS         = -26;
268    ZX_ERR_ALREADY_BOUND          = -27;
269    ZX_ERR_UNAVAILABLE            = -28;
270    ZX_ERR_ACCESS_DENIED          = -30;
271    ZX_ERR_IO                     = -40;
272    ZX_ERR_IO_REFUSED             = -41;
273    ZX_ERR_IO_DATA_INTEGRITY      = -42;
274    ZX_ERR_IO_DATA_LOSS           = -43;
275    ZX_ERR_IO_NOT_PRESENT         = -44;
276    ZX_ERR_IO_OVERRUN             = -45;
277    ZX_ERR_IO_MISSED_DEADLINE     = -46;
278    ZX_ERR_IO_INVALID             = -47;
279    ZX_ERR_BAD_PATH               = -50;
280    ZX_ERR_NOT_DIR                = -51;
281    ZX_ERR_NOT_FILE               = -52;
282    ZX_ERR_FILE_BIG               = -53;
283    ZX_ERR_NO_SPACE               = -54;
284    ZX_ERR_NOT_EMPTY              = -55;
285    ZX_ERR_STOP                   = -60;
286    ZX_ERR_NEXT                   = -61;
287    ZX_ERR_ASYNC                  = -62;
288    ZX_ERR_PROTOCOL_NOT_SUPPORTED = -70;
289    ZX_ERR_ADDRESS_UNREACHABLE    = -71;
290    ZX_ERR_ADDRESS_IN_USE         = -72;
291    ZX_ERR_NOT_CONNECTED          = -73;
292    ZX_ERR_CONNECTION_REFUSED     = -74;
293    ZX_ERR_CONNECTION_RESET       = -75;
294    ZX_ERR_CONNECTION_ABORTED     = -76;
295]);
296
297multiconst!(zx_signals_t, [
298    ZX_SIGNAL_NONE              = 0;
299    ZX_OBJECT_SIGNAL_ALL        = 0x00ffffff;
300    ZX_USER_SIGNAL_ALL          = 0xff000000;
301    ZX_OBJECT_SIGNAL_0          = 1 << 0;
302    ZX_OBJECT_SIGNAL_1          = 1 << 1;
303    ZX_OBJECT_SIGNAL_2          = 1 << 2;
304    ZX_OBJECT_SIGNAL_3          = 1 << 3;
305    ZX_OBJECT_SIGNAL_4          = 1 << 4;
306    ZX_OBJECT_SIGNAL_5          = 1 << 5;
307    ZX_OBJECT_SIGNAL_6          = 1 << 6;
308    ZX_OBJECT_SIGNAL_7          = 1 << 7;
309    ZX_OBJECT_SIGNAL_8          = 1 << 8;
310    ZX_OBJECT_SIGNAL_9          = 1 << 9;
311    ZX_OBJECT_SIGNAL_10         = 1 << 10;
312    ZX_OBJECT_SIGNAL_11         = 1 << 11;
313    ZX_OBJECT_SIGNAL_12         = 1 << 12;
314    ZX_OBJECT_SIGNAL_13         = 1 << 13;
315    ZX_OBJECT_SIGNAL_14         = 1 << 14;
316    ZX_OBJECT_SIGNAL_15         = 1 << 15;
317    ZX_OBJECT_SIGNAL_16         = 1 << 16;
318    ZX_OBJECT_SIGNAL_17         = 1 << 17;
319    ZX_OBJECT_SIGNAL_18         = 1 << 18;
320    ZX_OBJECT_SIGNAL_19         = 1 << 19;
321    ZX_OBJECT_SIGNAL_20         = 1 << 20;
322    ZX_OBJECT_SIGNAL_21         = 1 << 21;
323    ZX_OBJECT_SIGNAL_22         = 1 << 22;
324    ZX_OBJECT_HANDLE_CLOSED     = 1 << 23;
325    ZX_USER_SIGNAL_0            = 1 << 24;
326    ZX_USER_SIGNAL_1            = 1 << 25;
327    ZX_USER_SIGNAL_2            = 1 << 26;
328    ZX_USER_SIGNAL_3            = 1 << 27;
329    ZX_USER_SIGNAL_4            = 1 << 28;
330    ZX_USER_SIGNAL_5            = 1 << 29;
331    ZX_USER_SIGNAL_6            = 1 << 30;
332    ZX_USER_SIGNAL_7            = 1 << 31;
333
334    ZX_OBJECT_READABLE          = ZX_OBJECT_SIGNAL_0;
335    ZX_OBJECT_WRITABLE          = ZX_OBJECT_SIGNAL_1;
336    ZX_OBJECT_PEER_CLOSED       = ZX_OBJECT_SIGNAL_2;
337
338    // Cancelation (handle was closed while waiting with it)
339    ZX_SIGNAL_HANDLE_CLOSED     = ZX_OBJECT_HANDLE_CLOSED;
340
341    // Event
342    ZX_EVENT_SIGNALED           = ZX_OBJECT_SIGNAL_3;
343
344    // EventPair
345    ZX_EVENTPAIR_SIGNALED       = ZX_OBJECT_SIGNAL_3;
346    ZX_EVENTPAIR_PEER_CLOSED    = ZX_OBJECT_SIGNAL_2;
347
348    // Task signals (process, thread, job)
349    ZX_TASK_TERMINATED          = ZX_OBJECT_SIGNAL_3;
350
351    // Channel
352    ZX_CHANNEL_READABLE         = ZX_OBJECT_SIGNAL_0;
353    ZX_CHANNEL_WRITABLE         = ZX_OBJECT_SIGNAL_1;
354    ZX_CHANNEL_PEER_CLOSED      = ZX_OBJECT_SIGNAL_2;
355
356    // Clock
357    ZX_CLOCK_STARTED            = ZX_OBJECT_SIGNAL_4;
358    ZX_CLOCK_UPDATED            = ZX_OBJECT_SIGNAL_5;
359
360    // Socket
361    ZX_SOCKET_READABLE            = ZX_OBJECT_READABLE;
362    ZX_SOCKET_WRITABLE            = ZX_OBJECT_WRITABLE;
363    ZX_SOCKET_PEER_CLOSED         = ZX_OBJECT_PEER_CLOSED;
364    ZX_SOCKET_PEER_WRITE_DISABLED = ZX_OBJECT_SIGNAL_4;
365    ZX_SOCKET_WRITE_DISABLED      = ZX_OBJECT_SIGNAL_5;
366    ZX_SOCKET_READ_THRESHOLD      = ZX_OBJECT_SIGNAL_10;
367    ZX_SOCKET_WRITE_THRESHOLD     = ZX_OBJECT_SIGNAL_11;
368
369    // Resource
370    ZX_RESOURCE_DESTROYED       = ZX_OBJECT_SIGNAL_3;
371    ZX_RESOURCE_READABLE        = ZX_OBJECT_READABLE;
372    ZX_RESOURCE_WRITABLE        = ZX_OBJECT_WRITABLE;
373    ZX_RESOURCE_CHILD_ADDED     = ZX_OBJECT_SIGNAL_4;
374
375    // Fifo
376    ZX_FIFO_READABLE            = ZX_OBJECT_READABLE;
377    ZX_FIFO_WRITABLE            = ZX_OBJECT_WRITABLE;
378    ZX_FIFO_PEER_CLOSED         = ZX_OBJECT_PEER_CLOSED;
379
380    // Iob
381    ZX_IOB_PEER_CLOSED           = ZX_OBJECT_PEER_CLOSED;
382    ZX_IOB_SHARED_REGION_UPDATED = ZX_OBJECT_SIGNAL_3;
383
384    // Job
385    ZX_JOB_TERMINATED           = ZX_OBJECT_SIGNAL_3;
386    ZX_JOB_NO_JOBS              = ZX_OBJECT_SIGNAL_4;
387    ZX_JOB_NO_PROCESSES         = ZX_OBJECT_SIGNAL_5;
388
389    // Process
390    ZX_PROCESS_TERMINATED       = ZX_OBJECT_SIGNAL_3;
391
392    // Thread
393    ZX_THREAD_TERMINATED        = ZX_OBJECT_SIGNAL_3;
394    ZX_THREAD_RUNNING           = ZX_OBJECT_SIGNAL_4;
395    ZX_THREAD_SUSPENDED         = ZX_OBJECT_SIGNAL_5;
396
397    // Log
398    ZX_LOG_READABLE             = ZX_OBJECT_READABLE;
399    ZX_LOG_WRITABLE             = ZX_OBJECT_WRITABLE;
400
401    // Timer
402    ZX_TIMER_SIGNALED           = ZX_OBJECT_SIGNAL_3;
403
404    // Vmo
405    ZX_VMO_ZERO_CHILDREN        = ZX_OBJECT_SIGNAL_3;
406
407    // Counter
408    ZX_COUNTER_SIGNALED          = ZX_OBJECT_SIGNAL_3;
409    ZX_COUNTER_POSITIVE          = ZX_OBJECT_SIGNAL_4;
410    ZX_COUNTER_NON_POSITIVE      = ZX_OBJECT_SIGNAL_5;
411]);
412
413multiconst!(zx_obj_type_t, [
414    ZX_OBJ_TYPE_NONE                = 0;
415    ZX_OBJ_TYPE_PROCESS             = 1;
416    ZX_OBJ_TYPE_THREAD              = 2;
417    ZX_OBJ_TYPE_VMO                 = 3;
418    ZX_OBJ_TYPE_CHANNEL             = 4;
419    ZX_OBJ_TYPE_EVENT               = 5;
420    ZX_OBJ_TYPE_PORT                = 6;
421    ZX_OBJ_TYPE_INTERRUPT           = 9;
422    ZX_OBJ_TYPE_PCI_DEVICE          = 11;
423    ZX_OBJ_TYPE_DEBUGLOG            = 12;
424    ZX_OBJ_TYPE_SOCKET              = 14;
425    ZX_OBJ_TYPE_RESOURCE            = 15;
426    ZX_OBJ_TYPE_EVENTPAIR           = 16;
427    ZX_OBJ_TYPE_JOB                 = 17;
428    ZX_OBJ_TYPE_VMAR                = 18;
429    ZX_OBJ_TYPE_FIFO                = 19;
430    ZX_OBJ_TYPE_GUEST               = 20;
431    ZX_OBJ_TYPE_VCPU                = 21;
432    ZX_OBJ_TYPE_TIMER               = 22;
433    ZX_OBJ_TYPE_IOMMU               = 23;
434    ZX_OBJ_TYPE_BTI                 = 24;
435    ZX_OBJ_TYPE_PROFILE             = 25;
436    ZX_OBJ_TYPE_PMT                 = 26;
437    ZX_OBJ_TYPE_SUSPEND_TOKEN       = 27;
438    ZX_OBJ_TYPE_PAGER               = 28;
439    ZX_OBJ_TYPE_EXCEPTION           = 29;
440    ZX_OBJ_TYPE_CLOCK               = 30;
441    ZX_OBJ_TYPE_STREAM              = 31;
442    ZX_OBJ_TYPE_MSI                 = 32;
443    ZX_OBJ_TYPE_IOB                 = 33;
444    ZX_OBJ_TYPE_COUNTER             = 34;
445]);
446
447// System ABI commits to having no more than 64 object types.
448//
449// See zx_info_process_handle_stats_t for an example of a binary interface that
450// depends on having an upper bound for the number of object types.
451pub const ZX_OBJ_TYPE_UPPER_BOUND: usize = 64;
452
453// TODO: add an alias for this type in the C headers.
454multiconst!(u32, [
455    // Argument is a char[ZX_MAX_NAME_LEN].
456    ZX_PROP_NAME                      = 3;
457
458    // Argument is a uintptr_t.
459    #[cfg(target_arch = "x86_64")]
460    ZX_PROP_REGISTER_GS               = 2;
461    #[cfg(target_arch = "x86_64")]
462    ZX_PROP_REGISTER_FS               = 4;
463
464    // Argument is the value of ld.so's _dl_debug_addr, a uintptr_t.
465    ZX_PROP_PROCESS_DEBUG_ADDR        = 5;
466
467    // Argument is the base address of the vDSO mapping (or zero), a uintptr_t.
468    ZX_PROP_PROCESS_VDSO_BASE_ADDRESS = 6;
469
470    // Whether the dynamic loader should issue a debug trap when loading a shared
471    // library, either initially or when running (e.g. dlopen).
472    ZX_PROP_PROCESS_BREAK_ON_LOAD = 7;
473
474    // Argument is a size_t.
475    ZX_PROP_SOCKET_RX_THRESHOLD       = 12;
476    ZX_PROP_SOCKET_TX_THRESHOLD       = 13;
477
478    // Argument is a size_t, describing the number of packets a channel
479    // endpoint can have pending in its tx direction.
480    ZX_PROP_CHANNEL_TX_MSG_MAX        = 14;
481
482    // Terminate this job if the system is low on memory.
483    ZX_PROP_JOB_KILL_ON_OOM           = 15;
484
485    // Exception close behavior.
486    ZX_PROP_EXCEPTION_STATE           = 16;
487
488    // The size of the content in a VMO, in bytes.
489    ZX_PROP_VMO_CONTENT_SIZE          = 17;
490
491    // How an exception should be handled.
492    ZX_PROP_EXCEPTION_STRATEGY        = 18;
493
494    // Whether the stream is in append mode or not.
495    ZX_PROP_STREAM_MODE_APPEND        = 19;
496]);
497
498// Value for ZX_THREAD_STATE_SINGLE_STEP. The value can be 0 (not single-stepping), or 1
499// (single-stepping). Other values will give ZX_ERR_INVALID_ARGS.
500pub type zx_thread_state_single_step_t = u32;
501
502// Possible values for "kind" in zx_thread_read_state and zx_thread_write_state.
503multiconst!(zx_thread_state_topic_t, [
504    ZX_THREAD_STATE_GENERAL_REGS       = 0;
505    ZX_THREAD_STATE_FP_REGS            = 1;
506    ZX_THREAD_STATE_VECTOR_REGS        = 2;
507    // No 3 at the moment.
508    ZX_THREAD_STATE_DEBUG_REGS         = 4;
509    ZX_THREAD_STATE_SINGLE_STEP        = 5;
510]);
511
512// Possible values for "kind" in zx_vcpu_read_state and zx_vcpu_write_state.
513multiconst!(zx_vcpu_state_topic_t, [
514    ZX_VCPU_STATE   = 0;
515    ZX_VCPU_IO      = 1;
516]);
517
518// From //zircon/system/public/zircon/features.h
519multiconst!(u32, [
520    ZX_FEATURE_KIND_CPU                        = 0;
521    ZX_FEATURE_KIND_HW_BREAKPOINT_COUNT        = 1;
522    ZX_FEATURE_KIND_HW_WATCHPOINT_COUNT        = 2;
523    ZX_FEATURE_KIND_ADDRESS_TAGGING            = 3;
524    ZX_FEATURE_KIND_VM                         = 4;
525]);
526
527// From //zircon/system/public/zircon/features.h
528multiconst!(u32, [
529    ZX_HAS_CPU_FEATURES                   = 1 << 0;
530
531    ZX_VM_FEATURE_CAN_MAP_XOM             = 1 << 0;
532
533    ZX_ARM64_FEATURE_ISA_FP               = 1 << 1;
534    ZX_ARM64_FEATURE_ISA_ASIMD            = 1 << 2;
535    ZX_ARM64_FEATURE_ISA_AES              = 1 << 3;
536    ZX_ARM64_FEATURE_ISA_PMULL            = 1 << 4;
537    ZX_ARM64_FEATURE_ISA_SHA1             = 1 << 5;
538    ZX_ARM64_FEATURE_ISA_SHA256           = 1 << 6;
539    ZX_ARM64_FEATURE_ISA_CRC32            = 1 << 7;
540    ZX_ARM64_FEATURE_ISA_ATOMICS          = 1 << 8;
541    ZX_ARM64_FEATURE_ISA_RDM              = 1 << 9;
542    ZX_ARM64_FEATURE_ISA_SHA3             = 1 << 10;
543    ZX_ARM64_FEATURE_ISA_SM3              = 1 << 11;
544    ZX_ARM64_FEATURE_ISA_SM4              = 1 << 12;
545    ZX_ARM64_FEATURE_ISA_DP               = 1 << 13;
546    ZX_ARM64_FEATURE_ISA_DPB              = 1 << 14;
547    ZX_ARM64_FEATURE_ISA_FHM              = 1 << 15;
548    ZX_ARM64_FEATURE_ISA_TS               = 1 << 16;
549    ZX_ARM64_FEATURE_ISA_RNDR             = 1 << 17;
550    ZX_ARM64_FEATURE_ISA_SHA512           = 1 << 18;
551    ZX_ARM64_FEATURE_ISA_I8MM             = 1 << 19;
552    ZX_ARM64_FEATURE_ISA_SVE              = 1 << 20;
553    ZX_ARM64_FEATURE_ISA_ARM32            = 1 << 21;
554    ZX_ARM64_FEATURE_ISA_SHA2             = 1 << 6;
555    ZX_ARM64_FEATURE_ADDRESS_TAGGING_TBI  = 1 << 0;
556]);
557
558// From //zircon/system/public/zircon/syscalls/resource.h
559multiconst!(zx_rsrc_kind_t, [
560    ZX_RSRC_KIND_MMIO       = 0;
561    ZX_RSRC_KIND_IRQ        = 1;
562    ZX_RSRC_KIND_IOPORT     = 2;
563    ZX_RSRC_KIND_ROOT       = 3;
564    ZX_RSRC_KIND_SMC        = 4;
565    ZX_RSRC_KIND_SYSTEM     = 5;
566]);
567
568// From //zircon/system/public/zircon/syscalls/resource.h
569multiconst!(zx_rsrc_system_base_t, [
570    ZX_RSRC_SYSTEM_HYPERVISOR_BASE  = 0;
571    ZX_RSRC_SYSTEM_VMEX_BASE        = 1;
572    ZX_RSRC_SYSTEM_DEBUG_BASE       = 2;
573    ZX_RSRC_SYSTEM_INFO_BASE        = 3;
574    ZX_RSRC_SYSTEM_CPU_BASE         = 4;
575    ZX_RSRC_SYSTEM_POWER_BASE       = 5;
576    ZX_RSRC_SYSTEM_MEXEC_BASE       = 6;
577    ZX_RSRC_SYSTEM_ENERGY_INFO_BASE = 7;
578    ZX_RSRC_SYSTEM_IOMMU_BASE       = 8;
579    ZX_RSRC_SYSTEM_FRAMEBUFFER_BASE = 9;
580    ZX_RSRC_SYSTEM_PROFILE_BASE     = 10;
581    ZX_RSRC_SYSTEM_MSI_BASE         = 11;
582    ZX_RSRC_SYSTEM_DEBUGLOG_BASE    = 12;
583    ZX_RSRC_SYSTEM_STALL_BASE       = 13;
584    ZX_RSRC_SYSTEM_TRACING_BASE     = 14;
585]);
586
587// clock ids
588multiconst!(zx_clock_t, [
589    ZX_CLOCK_MONOTONIC = 0;
590    ZX_CLOCK_BOOT      = 1;
591]);
592
593// from //zircon/system/public/zircon/syscalls/clock.h
594multiconst!(u64, [
595    ZX_CLOCK_OPT_MONOTONIC = 1 << 0;
596    ZX_CLOCK_OPT_CONTINUOUS = 1 << 1;
597    ZX_CLOCK_OPT_AUTO_START = 1 << 2;
598    ZX_CLOCK_OPT_BOOT = 1 << 3;
599    ZX_CLOCK_OPT_MAPPABLE = 1 << 4;
600
601    // v1 clock update flags
602    ZX_CLOCK_UPDATE_OPTION_VALUE_VALID = 1 << 0;
603    ZX_CLOCK_UPDATE_OPTION_RATE_ADJUST_VALID = 1 << 1;
604    ZX_CLOCK_UPDATE_OPTION_ERROR_BOUND_VALID = 1 << 2;
605
606    // Additional v2 clock update flags
607    ZX_CLOCK_UPDATE_OPTION_REFERENCE_VALUE_VALID = 1 << 3;
608    ZX_CLOCK_UPDATE_OPTION_SYNTHETIC_VALUE_VALID = ZX_CLOCK_UPDATE_OPTION_VALUE_VALID;
609
610    ZX_CLOCK_ARGS_VERSION_1 = 1 << 58;
611    ZX_CLOCK_ARGS_VERSION_2 = 2 << 58;
612]);
613
614// from //zircon/system/public/zircon/syscalls/exception.h
615multiconst!(u32, [
616    ZX_EXCEPTION_CHANNEL_DEBUGGER = 1 << 0;
617    ZX_EXCEPTION_TARGET_JOB_DEBUGGER = 1 << 0;
618
619    // Returned when probing a thread for its blocked state.
620    ZX_EXCEPTION_CHANNEL_TYPE_NONE = 0;
621    ZX_EXCEPTION_CHANNEL_TYPE_DEBUGGER = 1;
622    ZX_EXCEPTION_CHANNEL_TYPE_THREAD = 2;
623    ZX_EXCEPTION_CHANNEL_TYPE_PROCESS = 3;
624    ZX_EXCEPTION_CHANNEL_TYPE_JOB = 4;
625    ZX_EXCEPTION_CHANNEL_TYPE_JOB_DEBUGGER = 5;
626]);
627
628/// A byte used only to control memory alignment. All padding bytes are considered equal
629/// regardless of their content.
630///
631/// Note that the kernel C/C++ struct definitions use explicit padding fields to ensure no implicit
632/// padding is added. This is important for security since implicit padding bytes are not always
633/// safely initialized. These explicit padding fields are mirrored in the Rust struct definitions
634/// to minimize the opportunities for mistakes and inconsistencies.
635#[repr(transparent)]
636#[derive(Copy, Clone, Eq, Default)]
637#[cfg_attr(feature = "zerocopy", derive(FromBytes, Immutable, IntoBytes))]
638pub struct PadByte(u8);
639
640impl PartialEq for PadByte {
641    fn eq(&self, _other: &Self) -> bool {
642        true
643    }
644}
645
646impl Hash for PadByte {
647    fn hash<H: Hasher>(&self, state: &mut H) {
648        state.write_u8(0);
649    }
650}
651
652impl Debug for PadByte {
653    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
654        f.write_str("-")
655    }
656}
657
658#[repr(C)]
659#[derive(Debug, Clone, Eq, PartialEq)]
660pub struct zx_clock_create_args_v1_t {
661    pub backstop_time: zx_time_t,
662}
663
664#[repr(C)]
665#[derive(Debug, Default, Clone, Eq, PartialEq)]
666pub struct zx_clock_rate_t {
667    pub synthetic_ticks: u32,
668    pub reference_ticks: u32,
669}
670
671#[repr(C)]
672#[derive(Debug, Default, Clone, Eq, PartialEq)]
673pub struct zx_clock_transformation_t {
674    pub reference_offset: i64,
675    pub synthetic_offset: i64,
676    pub rate: zx_clock_rate_t,
677}
678
679#[repr(C)]
680#[derive(Debug, Default, Clone, Eq, PartialEq)]
681pub struct zx_clock_details_v1_t {
682    pub options: u64,
683    pub backstop_time: zx_time_t,
684    pub reference_ticks_to_synthetic: zx_clock_transformation_t,
685    pub reference_to_synthetic: zx_clock_transformation_t,
686    pub error_bound: u64,
687    pub query_ticks: zx_ticks_t,
688    pub last_value_update_ticks: zx_ticks_t,
689    pub last_rate_adjust_update_ticks: zx_ticks_t,
690    pub last_error_bounds_update_ticks: zx_ticks_t,
691    pub generation_counter: u32,
692    padding1: [PadByte; 4],
693}
694
695#[repr(C)]
696#[derive(Debug, Clone, Eq, PartialEq)]
697pub struct zx_clock_update_args_v1_t {
698    pub rate_adjust: i32,
699    padding1: [PadByte; 4],
700    pub value: i64,
701    pub error_bound: u64,
702}
703
704#[repr(C)]
705#[derive(Debug, Default, Clone, Eq, PartialEq)]
706pub struct zx_clock_update_args_v2_t {
707    pub rate_adjust: i32,
708    padding1: [PadByte; 4],
709    pub synthetic_value: i64,
710    pub reference_value: i64,
711    pub error_bound: u64,
712}
713
714multiconst!(zx_stream_seek_origin_t, [
715    ZX_STREAM_SEEK_ORIGIN_START        = 0;
716    ZX_STREAM_SEEK_ORIGIN_CURRENT      = 1;
717    ZX_STREAM_SEEK_ORIGIN_END          = 2;
718]);
719
720// Stream constants
721pub const ZX_STREAM_MODE_READ: u32 = 1 << 0;
722pub const ZX_STREAM_MODE_WRITE: u32 = 1 << 1;
723pub const ZX_STREAM_MODE_APPEND: u32 = 1 << 2;
724
725pub const ZX_STREAM_APPEND: u32 = 1 << 0;
726
727pub const ZX_CPRNG_ADD_ENTROPY_MAX_LEN: usize = 256;
728
729// Socket flags and limits.
730pub const ZX_SOCKET_STREAM: u32 = 0;
731pub const ZX_SOCKET_DATAGRAM: u32 = 1 << 0;
732pub const ZX_SOCKET_DISPOSITION_WRITE_DISABLED: u32 = 1 << 0;
733pub const ZX_SOCKET_DISPOSITION_WRITE_ENABLED: u32 = 1 << 1;
734
735// VM Object clone flags
736pub const ZX_VMO_CHILD_SNAPSHOT: u32 = 1 << 0;
737pub const ZX_VMO_CHILD_SNAPSHOT_AT_LEAST_ON_WRITE: u32 = 1 << 4;
738pub const ZX_VMO_CHILD_RESIZABLE: u32 = 1 << 2;
739pub const ZX_VMO_CHILD_SLICE: u32 = 1 << 3;
740pub const ZX_VMO_CHILD_NO_WRITE: u32 = 1 << 5;
741pub const ZX_VMO_CHILD_REFERENCE: u32 = 1 << 6;
742pub const ZX_VMO_CHILD_SNAPSHOT_MODIFIED: u32 = 1 << 7;
743
744// channel write size constants
745pub const ZX_CHANNEL_MAX_MSG_HANDLES: u32 = 64;
746pub const ZX_CHANNEL_MAX_MSG_BYTES: u32 = 65536;
747pub const ZX_CHANNEL_MAX_MSG_IOVEC: u32 = 8192;
748
749// fifo write size constants
750pub const ZX_FIFO_MAX_SIZE_BYTES: u32 = 4096;
751
752// Min/max page size constants
753#[cfg(target_arch = "x86_64")]
754pub const ZX_MIN_PAGE_SHIFT: u32 = 12;
755#[cfg(target_arch = "x86_64")]
756pub const ZX_MAX_PAGE_SHIFT: u32 = 21;
757
758#[cfg(target_arch = "aarch64")]
759pub const ZX_MIN_PAGE_SHIFT: u32 = 12;
760#[cfg(target_arch = "aarch64")]
761pub const ZX_MAX_PAGE_SHIFT: u32 = 16;
762
763#[cfg(target_arch = "riscv64")]
764pub const ZX_MIN_PAGE_SHIFT: u32 = 12;
765#[cfg(target_arch = "riscv64")]
766pub const ZX_MAX_PAGE_SHIFT: u32 = 21;
767
768// Task response codes if a process is externally killed
769pub const ZX_TASK_RETCODE_SYSCALL_KILL: i64 = -1024;
770pub const ZX_TASK_RETCODE_OOM_KILL: i64 = -1025;
771pub const ZX_TASK_RETCODE_POLICY_KILL: i64 = -1026;
772pub const ZX_TASK_RETCODE_VDSO_KILL: i64 = -1027;
773pub const ZX_TASK_RETCODE_EXCEPTION_KILL: i64 = -1028;
774
775// Resource flags.
776pub const ZX_RSRC_FLAG_EXCLUSIVE: zx_rsrc_flags_t = 0x00010000;
777
778// Topics for CPU performance info syscalls
779pub const ZX_CPU_PERF_SCALE: u32 = 1;
780pub const ZX_CPU_DEFAULT_PERF_SCALE: u32 = 2;
781pub const ZX_CPU_POWER_LIMIT: u32 = 3;
782
783// Cache policy flags.
784pub const ZX_CACHE_POLICY_CACHED: u32 = 0;
785pub const ZX_CACHE_POLICY_UNCACHED: u32 = 1;
786pub const ZX_CACHE_POLICY_UNCACHED_DEVICE: u32 = 2;
787pub const ZX_CACHE_POLICY_WRITE_COMBINING: u32 = 3;
788
789// Flag bits for zx_cache_flush.
790multiconst!(u32, [
791    ZX_CACHE_FLUSH_INSN         = 1 << 0;
792    ZX_CACHE_FLUSH_DATA         = 1 << 1;
793    ZX_CACHE_FLUSH_INVALIDATE   = 1 << 2;
794]);
795
796#[repr(C)]
797#[derive(Debug, Copy, Clone, Eq, PartialEq)]
798pub struct zx_wait_item_t {
799    pub handle: zx_handle_t,
800    pub waitfor: zx_signals_t,
801    pub pending: zx_signals_t,
802}
803
804#[repr(C)]
805#[derive(Debug, Copy, Clone, Eq, PartialEq)]
806pub struct zx_waitset_result_t {
807    pub cookie: u64,
808    pub status: zx_status_t,
809    pub observed: zx_signals_t,
810}
811
812#[repr(C)]
813#[derive(Debug, Copy, Clone, Eq, PartialEq)]
814pub struct zx_handle_info_t {
815    pub handle: zx_handle_t,
816    pub ty: zx_obj_type_t,
817    pub rights: zx_rights_t,
818    pub unused: u32,
819}
820
821pub const ZX_CHANNEL_READ_MAY_DISCARD: u32 = 1;
822pub const ZX_CHANNEL_WRITE_USE_IOVEC: u32 = 2;
823
824#[repr(C)]
825#[derive(Debug, Copy, Clone, Eq, PartialEq)]
826pub struct zx_channel_call_args_t {
827    pub wr_bytes: *const u8,
828    pub wr_handles: *const zx_handle_t,
829    pub rd_bytes: *mut u8,
830    pub rd_handles: *mut zx_handle_t,
831    pub wr_num_bytes: u32,
832    pub wr_num_handles: u32,
833    pub rd_num_bytes: u32,
834    pub rd_num_handles: u32,
835}
836
837#[repr(C)]
838#[derive(Debug, Copy, Clone, Eq, PartialEq)]
839pub struct zx_channel_call_etc_args_t {
840    pub wr_bytes: *const u8,
841    pub wr_handles: *mut zx_handle_disposition_t,
842    pub rd_bytes: *mut u8,
843    pub rd_handles: *mut zx_handle_info_t,
844    pub wr_num_bytes: u32,
845    pub wr_num_handles: u32,
846    pub rd_num_bytes: u32,
847    pub rd_num_handles: u32,
848}
849
850#[repr(C)]
851#[derive(Debug, Copy, Clone, Eq, PartialEq)]
852pub struct zx_channel_iovec_t {
853    pub buffer: *const u8,
854    pub capacity: u32,
855    padding1: [PadByte; 4],
856}
857
858impl Default for zx_channel_iovec_t {
859    fn default() -> Self {
860        Self {
861            buffer: std::ptr::null(),
862            capacity: Default::default(),
863            padding1: Default::default(),
864        }
865    }
866}
867
868#[repr(C)]
869#[derive(Debug, Copy, Clone, Eq, PartialEq)]
870pub struct zx_handle_disposition_t {
871    pub operation: zx_handle_op_t,
872    pub handle: zx_handle_t,
873    pub type_: zx_obj_type_t,
874    pub rights: zx_rights_t,
875    pub result: zx_status_t,
876}
877
878#[repr(C)]
879#[derive(Debug, Copy, Clone)]
880pub struct zx_iovec_t {
881    pub buffer: *const u8,
882    pub capacity: usize,
883}
884
885pub type zx_pci_irq_swizzle_lut_t = [[[u32; 4]; 8]; 32];
886
887#[repr(C)]
888#[derive(Debug, Copy, Clone, Eq, PartialEq)]
889pub struct zx_pci_init_arg_t {
890    pub dev_pin_to_global_irq: zx_pci_irq_swizzle_lut_t,
891    pub num_irqs: u32,
892    pub irqs: [zx_irq_t; 32],
893    pub ecam_window_count: u32,
894    // Note: the ecam_windows field is actually a variable size array.
895    // We use a fixed size array to match the C repr.
896    pub ecam_windows: [zx_ecam_window_t; 1],
897}
898
899#[repr(C)]
900#[derive(Debug, Copy, Clone, Eq, PartialEq)]
901pub struct zx_irq_t {
902    pub global_irq: u32,
903    pub level_triggered: bool,
904    pub active_high: bool,
905}
906
907#[repr(C)]
908#[derive(Debug, Copy, Clone, Eq, PartialEq)]
909pub struct zx_ecam_window_t {
910    pub base: u64,
911    pub size: usize,
912    pub bus_start: u8,
913    pub bus_end: u8,
914}
915
916#[repr(C)]
917#[derive(Debug, Copy, Clone, Eq, PartialEq)]
918pub struct zx_pcie_device_info_t {
919    pub vendor_id: u16,
920    pub device_id: u16,
921    pub base_class: u8,
922    pub sub_class: u8,
923    pub program_interface: u8,
924    pub revision_id: u8,
925    pub bus_id: u8,
926    pub dev_id: u8,
927    pub func_id: u8,
928}
929
930#[repr(C)]
931#[derive(Debug, Copy, Clone, Eq, PartialEq)]
932pub struct zx_pci_resource_t {
933    pub type_: u32,
934    pub size: usize,
935    // TODO: Actually a union
936    pub pio_addr: usize,
937}
938
939// TODO: Actually a union
940pub type zx_rrec_t = [u8; 64];
941
942// Ports V2
943#[repr(u32)]
944#[derive(Debug, Copy, Clone, Eq, PartialEq)]
945pub enum zx_packet_type_t {
946    ZX_PKT_TYPE_USER = 0,
947    ZX_PKT_TYPE_SIGNAL_ONE = 1,
948    ZX_PKT_TYPE_GUEST_BELL = 3,
949    ZX_PKT_TYPE_GUEST_MEM = 4,
950    ZX_PKT_TYPE_GUEST_IO = 5,
951    ZX_PKT_TYPE_GUEST_VCPU = 6,
952    ZX_PKT_TYPE_INTERRUPT = 7,
953    ZX_PKT_TYPE_PAGE_REQUEST = 9,
954    ZX_PKT_TYPE_PROCESSOR_POWER_LEVEL_TRANSITION_REQUEST = 10,
955    #[doc(hidden)]
956    __Nonexhaustive,
957}
958
959impl Default for zx_packet_type_t {
960    fn default() -> Self {
961        zx_packet_type_t::ZX_PKT_TYPE_USER
962    }
963}
964
965#[repr(u32)]
966#[derive(Debug, Copy, Clone, Default, Eq, PartialEq)]
967pub enum zx_packet_guest_vcpu_type_t {
968    #[default]
969    ZX_PKT_GUEST_VCPU_INTERRUPT = 0,
970    ZX_PKT_GUEST_VCPU_STARTUP = 1,
971    ZX_PKT_GUEST_VCPU_EXIT = 2,
972    #[doc(hidden)]
973    __Nonexhaustive,
974}
975
976#[repr(C)]
977#[derive(Debug, Copy, Clone, Eq, PartialEq)]
978pub struct zx_packet_signal_t {
979    pub trigger: zx_signals_t,
980    pub observed: zx_signals_t,
981    pub count: u64,
982    pub timestamp: zx_time_t,
983}
984
985pub const ZX_WAIT_ASYNC_TIMESTAMP: u32 = 1;
986pub const ZX_WAIT_ASYNC_EDGE: u32 = 2;
987pub const ZX_WAIT_ASYNC_BOOT_TIMESTAMP: u32 = 4;
988
989// Actually a union of different integer types, but this should be good enough.
990pub type zx_packet_user_t = [u8; 32];
991
992#[repr(C)]
993#[derive(Debug, Default, Copy, Clone, Eq, PartialEq)]
994pub struct zx_port_packet_t {
995    pub key: u64,
996    pub packet_type: zx_packet_type_t,
997    pub status: i32,
998    pub union: [u8; 32],
999}
1000
1001#[repr(C)]
1002#[derive(Debug, Copy, Clone, Eq, PartialEq)]
1003pub struct zx_packet_guest_bell_t {
1004    pub addr: zx_gpaddr_t,
1005}
1006
1007#[repr(C)]
1008#[derive(Debug, Copy, Clone, Eq, PartialEq)]
1009pub struct zx_packet_guest_io_t {
1010    pub port: u16,
1011    pub access_size: u8,
1012    pub input: bool,
1013    pub data: [u8; 4],
1014}
1015
1016#[repr(C)]
1017#[derive(Debug, Default, Copy, Clone, Eq, PartialEq)]
1018#[cfg_attr(feature = "zerocopy", derive(FromBytes, Immutable))]
1019pub struct zx_packet_guest_vcpu_interrupt_t {
1020    pub mask: u64,
1021    pub vector: u8,
1022    padding1: [PadByte; 7],
1023}
1024
1025#[repr(C)]
1026#[derive(Debug, Copy, Clone, Eq, PartialEq)]
1027#[cfg_attr(feature = "zerocopy", derive(FromBytes, Immutable))]
1028pub struct zx_packet_guest_vcpu_startup_t {
1029    pub id: u64,
1030    pub entry: zx_gpaddr_t,
1031}
1032
1033#[repr(C)]
1034#[derive(Debug, Copy, Clone, Default, Eq, PartialEq)]
1035#[cfg_attr(feature = "zerocopy", derive(FromBytes, Immutable))]
1036pub struct zx_packet_guest_vcpu_exit_t {
1037    pub retcode: i64,
1038    padding1: [PadByte; 8],
1039}
1040
1041#[repr(C)]
1042#[derive(Copy, Clone)]
1043#[cfg_attr(feature = "zerocopy", derive(FromBytes, Immutable))]
1044pub union zx_packet_guest_vcpu_union_t {
1045    pub interrupt: zx_packet_guest_vcpu_interrupt_t,
1046    pub startup: zx_packet_guest_vcpu_startup_t,
1047    pub exit: zx_packet_guest_vcpu_exit_t,
1048}
1049
1050#[cfg(feature = "zerocopy")]
1051impl Default for zx_packet_guest_vcpu_union_t {
1052    fn default() -> Self {
1053        Self::new_zeroed()
1054    }
1055}
1056
1057#[repr(C)]
1058#[derive(Copy, Clone, Default)]
1059pub struct zx_packet_guest_vcpu_t {
1060    pub r#type: zx_packet_guest_vcpu_type_t,
1061    padding1: [PadByte; 4],
1062    pub union: zx_packet_guest_vcpu_union_t,
1063    padding2: [PadByte; 8],
1064}
1065
1066impl PartialEq for zx_packet_guest_vcpu_t {
1067    fn eq(&self, other: &Self) -> bool {
1068        if self.r#type != other.r#type {
1069            return false;
1070        }
1071        match self.r#type {
1072            zx_packet_guest_vcpu_type_t::ZX_PKT_GUEST_VCPU_INTERRUPT => unsafe {
1073                self.union.interrupt == other.union.interrupt
1074            },
1075            zx_packet_guest_vcpu_type_t::ZX_PKT_GUEST_VCPU_STARTUP => unsafe {
1076                self.union.startup == other.union.startup
1077            },
1078            zx_packet_guest_vcpu_type_t::ZX_PKT_GUEST_VCPU_EXIT => unsafe {
1079                self.union.exit == other.union.exit
1080            },
1081            // No equality relationship is defined for invalid types.
1082            _ => false,
1083        }
1084    }
1085}
1086
1087impl Eq for zx_packet_guest_vcpu_t {}
1088
1089impl Debug for zx_packet_guest_vcpu_t {
1090    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1091        match self.r#type {
1092            zx_packet_guest_vcpu_type_t::ZX_PKT_GUEST_VCPU_INTERRUPT => {
1093                write!(f, "type: {:?} union: {:?}", self.r#type, unsafe { self.union.interrupt })
1094            }
1095            zx_packet_guest_vcpu_type_t::ZX_PKT_GUEST_VCPU_STARTUP => {
1096                write!(f, "type: {:?} union: {:?}", self.r#type, unsafe { self.union.startup })
1097            }
1098            zx_packet_guest_vcpu_type_t::ZX_PKT_GUEST_VCPU_EXIT => {
1099                write!(f, "type: {:?} union: {:?}", self.r#type, unsafe { self.union.exit })
1100            }
1101            _ => panic!("unexpected VCPU packet type"),
1102        }
1103    }
1104}
1105
1106#[repr(C)]
1107#[derive(Debug, Copy, Clone, Default, Eq, PartialEq)]
1108pub struct zx_packet_page_request_t {
1109    pub command: zx_page_request_command_t,
1110    pub flags: u16,
1111    padding1: [PadByte; 4],
1112    pub offset: u64,
1113    pub length: u64,
1114    padding2: [PadByte; 8],
1115}
1116
1117#[repr(u16)]
1118#[derive(Debug, Copy, Clone, Default, Eq, PartialEq)]
1119pub enum zx_page_request_command_t {
1120    #[default]
1121    ZX_PAGER_VMO_READ = 0x0000,
1122    ZX_PAGER_VMO_COMPLETE = 0x0001,
1123    ZX_PAGER_VMO_DIRTY = 0x0002,
1124    #[doc(hidden)]
1125    __Nonexhaustive,
1126}
1127
1128multiconst!(u32, [
1129    ZX_PAGER_OP_FAIL = 1;
1130    ZX_PAGER_OP_DIRTY = 2;
1131    ZX_PAGER_OP_WRITEBACK_BEGIN = 3;
1132    ZX_PAGER_OP_WRITEBACK_END = 4;
1133]);
1134
1135pub type zx_excp_type_t = u32;
1136
1137multiconst!(zx_excp_type_t, [
1138    ZX_EXCP_GENERAL               = 0x008;
1139    ZX_EXCP_FATAL_PAGE_FAULT      = 0x108;
1140    ZX_EXCP_UNDEFINED_INSTRUCTION = 0x208;
1141    ZX_EXCP_SW_BREAKPOINT         = 0x308;
1142    ZX_EXCP_HW_BREAKPOINT         = 0x408;
1143    ZX_EXCP_UNALIGNED_ACCESS      = 0x508;
1144
1145    ZX_EXCP_SYNTH                 = 0x8000;
1146
1147    ZX_EXCP_THREAD_STARTING       = 0x008 | ZX_EXCP_SYNTH;
1148    ZX_EXCP_THREAD_EXITING        = 0x108 | ZX_EXCP_SYNTH;
1149    ZX_EXCP_POLICY_ERROR          = 0x208 | ZX_EXCP_SYNTH;
1150    ZX_EXCP_PROCESS_STARTING      = 0x308 | ZX_EXCP_SYNTH;
1151    ZX_EXCP_USER                  = 0x309 | ZX_EXCP_SYNTH;
1152]);
1153
1154multiconst!(u32, [
1155    ZX_EXCP_USER_CODE_PROCESS_NAME_CHANGED = 0x0001;
1156
1157    ZX_EXCP_USER_CODE_USER0                = 0xF000;
1158    ZX_EXCP_USER_CODE_USER1                = 0xF001;
1159    ZX_EXCP_USER_CODE_USER2                = 0xF002;
1160]);
1161
1162#[repr(C)]
1163#[derive(Debug, Copy, Clone, Eq, PartialEq)]
1164#[cfg_attr(feature = "zerocopy", derive(FromBytes, Immutable, IntoBytes))]
1165pub struct zx_exception_info_t {
1166    pub pid: zx_koid_t,
1167    pub tid: zx_koid_t,
1168    pub type_: zx_excp_type_t,
1169    padding1: [PadByte; 4],
1170}
1171
1172#[repr(C)]
1173#[derive(Debug, Default, Copy, Clone, Eq, PartialEq, KnownLayout, FromBytes, Immutable)]
1174pub struct zx_x86_64_exc_data_t {
1175    pub vector: u64,
1176    pub err_code: u64,
1177    pub cr2: u64,
1178}
1179
1180#[repr(C)]
1181#[derive(Debug, Default, Copy, Clone, Eq, PartialEq, FromBytes, Immutable)]
1182pub struct zx_arm64_exc_data_t {
1183    pub esr: u32,
1184    padding1: [PadByte; 4],
1185    pub far: u64,
1186    padding2: [PadByte; 8],
1187}
1188
1189#[repr(C)]
1190#[derive(Debug, Default, Copy, Clone, Eq, PartialEq, FromBytes, Immutable)]
1191pub struct zx_riscv64_exc_data_t {
1192    pub cause: u64,
1193    pub tval: u64,
1194    padding1: [PadByte; 8],
1195}
1196
1197#[repr(C)]
1198#[derive(Copy, Clone, KnownLayout, FromBytes, Immutable)]
1199pub union zx_exception_header_arch_t {
1200    pub x86_64: zx_x86_64_exc_data_t,
1201    pub arm_64: zx_arm64_exc_data_t,
1202    pub riscv_64: zx_riscv64_exc_data_t,
1203}
1204
1205impl Debug for zx_exception_header_arch_t {
1206    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1207        write!(f, "zx_exception_header_arch_t")
1208    }
1209}
1210
1211#[repr(C)]
1212#[derive(Debug, Copy, Clone, Eq, PartialEq, KnownLayout, FromBytes, Immutable)]
1213pub struct zx_exception_header_t {
1214    pub size: u32,
1215    pub type_: zx_excp_type_t,
1216}
1217
1218pub type zx_excp_policy_code_t = u32;
1219
1220multiconst!(zx_excp_policy_code_t, [
1221    ZX_EXCP_POLICY_CODE_BAD_HANDLE              = 0;
1222    ZX_EXCP_POLICY_CODE_WRONG_OBJECT            = 1;
1223    ZX_EXCP_POLICY_CODE_VMAR_WX                 = 2;
1224    ZX_EXCP_POLICY_CODE_NEW_ANY                 = 3;
1225    ZX_EXCP_POLICY_CODE_NEW_VMO                 = 4;
1226    ZX_EXCP_POLICY_CODE_NEW_CHANNEL             = 5;
1227    ZX_EXCP_POLICY_CODE_NEW_EVENT               = 6;
1228    ZX_EXCP_POLICY_CODE_NEW_EVENTPAIR           = 7;
1229    ZX_EXCP_POLICY_CODE_NEW_PORT                = 8;
1230    ZX_EXCP_POLICY_CODE_NEW_SOCKET              = 9;
1231    ZX_EXCP_POLICY_CODE_NEW_FIFO                = 10;
1232    ZX_EXCP_POLICY_CODE_NEW_TIMER               = 11;
1233    ZX_EXCP_POLICY_CODE_NEW_PROCESS             = 12;
1234    ZX_EXCP_POLICY_CODE_NEW_PROFILE             = 13;
1235    ZX_EXCP_POLICY_CODE_NEW_PAGER               = 14;
1236    ZX_EXCP_POLICY_CODE_AMBIENT_MARK_VMO_EXEC   = 15;
1237    ZX_EXCP_POLICY_CODE_CHANNEL_FULL_WRITE      = 16;
1238    ZX_EXCP_POLICY_CODE_PORT_TOO_MANY_PACKETS   = 17;
1239    ZX_EXCP_POLICY_CODE_BAD_SYSCALL             = 18;
1240    ZX_EXCP_POLICY_CODE_PORT_TOO_MANY_OBSERVERS = 19;
1241    ZX_EXCP_POLICY_CODE_HANDLE_LEAK             = 20;
1242    ZX_EXCP_POLICY_CODE_NEW_IOB                 = 21;
1243]);
1244
1245#[repr(C)]
1246#[derive(Debug, Copy, Clone, KnownLayout, FromBytes, Immutable)]
1247pub struct zx_exception_context_t {
1248    pub arch: zx_exception_header_arch_t,
1249    pub synth_code: zx_excp_policy_code_t,
1250    pub synth_data: u32,
1251}
1252
1253#[repr(C)]
1254#[derive(Debug, Copy, Clone, KnownLayout, FromBytes, Immutable)]
1255pub struct zx_exception_report_t {
1256    pub header: zx_exception_header_t,
1257    pub context: zx_exception_context_t,
1258}
1259
1260pub type zx_exception_state_t = u32;
1261
1262multiconst!(zx_exception_state_t, [
1263    ZX_EXCEPTION_STATE_TRY_NEXT    = 0;
1264    ZX_EXCEPTION_STATE_HANDLED     = 1;
1265    ZX_EXCEPTION_STATE_THREAD_EXIT = 2;
1266]);
1267
1268pub type zx_exception_strategy_t = u32;
1269
1270multiconst!(zx_exception_state_t, [
1271    ZX_EXCEPTION_STRATEGY_FIRST_CHANCE   = 0;
1272    ZX_EXCEPTION_STRATEGY_SECOND_CHANCE  = 1;
1273]);
1274
1275#[cfg(target_arch = "x86_64")]
1276#[repr(C)]
1277#[derive(Default, Copy, Clone, Eq, PartialEq, KnownLayout, FromBytes, Immutable)]
1278pub struct zx_thread_state_general_regs_t {
1279    pub rax: u64,
1280    pub rbx: u64,
1281    pub rcx: u64,
1282    pub rdx: u64,
1283    pub rsi: u64,
1284    pub rdi: u64,
1285    pub rbp: u64,
1286    pub rsp: u64,
1287    pub r8: u64,
1288    pub r9: u64,
1289    pub r10: u64,
1290    pub r11: u64,
1291    pub r12: u64,
1292    pub r13: u64,
1293    pub r14: u64,
1294    pub r15: u64,
1295    pub rip: u64,
1296    pub rflags: u64,
1297    pub fs_base: u64,
1298    pub gs_base: u64,
1299}
1300
1301#[cfg(target_arch = "x86_64")]
1302impl std::fmt::Debug for zx_thread_state_general_regs_t {
1303    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1304        f.debug_struct(std::any::type_name::<Self>())
1305            .field("rax", &format_args!("{:#x}", self.rax))
1306            .field("rbx", &format_args!("{:#x}", self.rbx))
1307            .field("rcx", &format_args!("{:#x}", self.rcx))
1308            .field("rdx", &format_args!("{:#x}", self.rdx))
1309            .field("rsi", &format_args!("{:#x}", self.rsi))
1310            .field("rdi", &format_args!("{:#x}", self.rdi))
1311            .field("rbp", &format_args!("{:#x}", self.rbp))
1312            .field("rsp", &format_args!("{:#x}", self.rsp))
1313            .field("r8", &format_args!("{:#x}", self.r8))
1314            .field("r9", &format_args!("{:#x}", self.r9))
1315            .field("r10", &format_args!("{:#x}", self.r10))
1316            .field("r11", &format_args!("{:#x}", self.r11))
1317            .field("r12", &format_args!("{:#x}", self.r12))
1318            .field("r13", &format_args!("{:#x}", self.r13))
1319            .field("r14", &format_args!("{:#x}", self.r14))
1320            .field("r15", &format_args!("{:#x}", self.r15))
1321            .field("rip", &format_args!("{:#x}", self.rip))
1322            .field("rflags", &format_args!("{:#x}", self.rflags))
1323            .field("fs_base", &format_args!("{:#x}", self.fs_base))
1324            .field("gs_base", &format_args!("{:#x}", self.gs_base))
1325            .finish()
1326    }
1327}
1328
1329#[cfg(target_arch = "x86_64")]
1330impl From<&zx_restricted_state_t> for zx_thread_state_general_regs_t {
1331    fn from(state: &zx_restricted_state_t) -> Self {
1332        Self {
1333            rdi: state.rdi,
1334            rsi: state.rsi,
1335            rbp: state.rbp,
1336            rbx: state.rbx,
1337            rdx: state.rdx,
1338            rcx: state.rcx,
1339            rax: state.rax,
1340            rsp: state.rsp,
1341            r8: state.r8,
1342            r9: state.r9,
1343            r10: state.r10,
1344            r11: state.r11,
1345            r12: state.r12,
1346            r13: state.r13,
1347            r14: state.r14,
1348            r15: state.r15,
1349            rip: state.ip,
1350            rflags: state.flags,
1351            fs_base: state.fs_base,
1352            gs_base: state.gs_base,
1353        }
1354    }
1355}
1356
1357#[cfg(target_arch = "aarch64")]
1358multiconst!(u64, [
1359    ZX_REG_CPSR_ARCH_32_MASK = 0x10;
1360    ZX_REG_CPSR_THUMB_MASK = 0x20;
1361]);
1362
1363#[cfg(target_arch = "aarch64")]
1364#[repr(C)]
1365#[derive(Default, Copy, Clone, Eq, PartialEq)]
1366pub struct zx_thread_state_general_regs_t {
1367    pub r: [u64; 30],
1368    pub lr: u64,
1369    pub sp: u64,
1370    pub pc: u64,
1371    pub cpsr: u64,
1372    pub tpidr: u64,
1373}
1374
1375#[cfg(target_arch = "aarch64")]
1376impl std::fmt::Debug for zx_thread_state_general_regs_t {
1377    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1378        struct RegisterAsHex(u64);
1379        impl std::fmt::Debug for RegisterAsHex {
1380            fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
1381                write!(f, "{:#x}", self.0)
1382            }
1383        }
1384
1385        f.debug_struct(std::any::type_name::<Self>())
1386            .field("r", &self.r.map(RegisterAsHex))
1387            .field("lr", &format_args!("{:#x}", self.lr))
1388            .field("sp", &format_args!("{:#x}", self.sp))
1389            .field("pc", &format_args!("{:#x}", self.pc))
1390            .field("cpsr", &format_args!("{:#x}", self.cpsr))
1391            .field("tpidr", &format_args!("{:#x}", self.tpidr))
1392            .finish()
1393    }
1394}
1395
1396#[cfg(target_arch = "aarch64")]
1397impl From<&zx_restricted_state_t> for zx_thread_state_general_regs_t {
1398    fn from(state: &zx_restricted_state_t) -> Self {
1399        if state.cpsr as u64 & ZX_REG_CPSR_ARCH_32_MASK == ZX_REG_CPSR_ARCH_32_MASK {
1400            // aarch32
1401            Self {
1402                r: [
1403                    state.r[0],
1404                    state.r[1],
1405                    state.r[2],
1406                    state.r[3],
1407                    state.r[4],
1408                    state.r[5],
1409                    state.r[6],
1410                    state.r[7],
1411                    state.r[8],
1412                    state.r[9],
1413                    state.r[10],
1414                    state.r[11],
1415                    state.r[12],
1416                    state.r[13],
1417                    state.r[14],
1418                    state.pc, // ELR overwrites this.
1419                    state.r[16],
1420                    state.r[17],
1421                    state.r[18],
1422                    state.r[19],
1423                    state.r[20],
1424                    state.r[21],
1425                    state.r[22],
1426                    state.r[23],
1427                    state.r[24],
1428                    state.r[25],
1429                    state.r[26],
1430                    state.r[27],
1431                    state.r[28],
1432                    state.r[29],
1433                ],
1434                lr: state.r[14], // R[14] for aarch32
1435                sp: state.r[13], // R[13] for aarch32
1436                // TODO(https://fxbug.dev/379669623) Should it be checked for thumb and make
1437                // sure it isn't over incrementing?
1438                pc: state.pc, // Zircon populated this from elr.
1439                cpsr: state.cpsr as u64,
1440                tpidr: state.tpidr_el0,
1441            }
1442        } else {
1443            Self {
1444                r: [
1445                    state.r[0],
1446                    state.r[1],
1447                    state.r[2],
1448                    state.r[3],
1449                    state.r[4],
1450                    state.r[5],
1451                    state.r[6],
1452                    state.r[7],
1453                    state.r[8],
1454                    state.r[9],
1455                    state.r[10],
1456                    state.r[11],
1457                    state.r[12],
1458                    state.r[13],
1459                    state.r[14],
1460                    state.r[15],
1461                    state.r[16],
1462                    state.r[17],
1463                    state.r[18],
1464                    state.r[19],
1465                    state.r[20],
1466                    state.r[21],
1467                    state.r[22],
1468                    state.r[23],
1469                    state.r[24],
1470                    state.r[25],
1471                    state.r[26],
1472                    state.r[27],
1473                    state.r[28],
1474                    state.r[29],
1475                ],
1476                lr: state.r[30],
1477                sp: state.sp,
1478                pc: state.pc,
1479                cpsr: state.cpsr as u64,
1480                tpidr: state.tpidr_el0,
1481            }
1482        }
1483    }
1484}
1485
1486#[cfg(target_arch = "riscv64")]
1487#[repr(C)]
1488#[derive(Default, Copy, Clone, Eq, PartialEq)]
1489pub struct zx_thread_state_general_regs_t {
1490    pub pc: u64,
1491    pub ra: u64,  // x1
1492    pub sp: u64,  // x2
1493    pub gp: u64,  // x3
1494    pub tp: u64,  // x4
1495    pub t0: u64,  // x5
1496    pub t1: u64,  // x6
1497    pub t2: u64,  // x7
1498    pub s0: u64,  // x8
1499    pub s1: u64,  // x9
1500    pub a0: u64,  // x10
1501    pub a1: u64,  // x11
1502    pub a2: u64,  // x12
1503    pub a3: u64,  // x13
1504    pub a4: u64,  // x14
1505    pub a5: u64,  // x15
1506    pub a6: u64,  // x16
1507    pub a7: u64,  // x17
1508    pub s2: u64,  // x18
1509    pub s3: u64,  // x19
1510    pub s4: u64,  // x20
1511    pub s5: u64,  // x21
1512    pub s6: u64,  // x22
1513    pub s7: u64,  // x23
1514    pub s8: u64,  // x24
1515    pub s9: u64,  // x25
1516    pub s10: u64, // x26
1517    pub s11: u64, // x27
1518    pub t3: u64,  // x28
1519    pub t4: u64,  // x29
1520    pub t5: u64,  // x30
1521    pub t6: u64,  // x31
1522}
1523
1524#[cfg(target_arch = "riscv64")]
1525impl std::fmt::Debug for zx_thread_state_general_regs_t {
1526    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1527        f.debug_struct(std::any::type_name::<Self>())
1528            .field("pc", &format_args!("{:#x}", self.pc))
1529            .field("ra", &format_args!("{:#x}", self.ra)) // x1
1530            .field("sp", &format_args!("{:#x}", self.sp)) // x2
1531            .field("gp", &format_args!("{:#x}", self.gp)) // x3
1532            .field("tp", &format_args!("{:#x}", self.tp)) // x4
1533            .field("t0", &format_args!("{:#x}", self.t0)) // x5
1534            .field("t1", &format_args!("{:#x}", self.t1)) // x6
1535            .field("t2", &format_args!("{:#x}", self.t2)) // x7
1536            .field("s0", &format_args!("{:#x}", self.s0)) // x8
1537            .field("s1", &format_args!("{:#x}", self.s1)) // x9
1538            .field("a0", &format_args!("{:#x}", self.a0)) // x10
1539            .field("a1", &format_args!("{:#x}", self.a1)) // x11
1540            .field("a2", &format_args!("{:#x}", self.a2)) // x12
1541            .field("a3", &format_args!("{:#x}", self.a3)) // x13
1542            .field("a4", &format_args!("{:#x}", self.a4)) // x14
1543            .field("a5", &format_args!("{:#x}", self.a5)) // x15
1544            .field("a6", &format_args!("{:#x}", self.a6)) // x16
1545            .field("a7", &format_args!("{:#x}", self.a7)) // x17
1546            .field("s2", &format_args!("{:#x}", self.s2)) // x18
1547            .field("s3", &format_args!("{:#x}", self.s3)) // x19
1548            .field("s4", &format_args!("{:#x}", self.s4)) // x20
1549            .field("s5", &format_args!("{:#x}", self.s5)) // x21
1550            .field("s6", &format_args!("{:#x}", self.s6)) // x22
1551            .field("s7", &format_args!("{:#x}", self.s7)) // x23
1552            .field("s8", &format_args!("{:#x}", self.s8)) // x24
1553            .field("s9", &format_args!("{:#x}", self.s9)) // x25
1554            .field("s10", &format_args!("{:#x}", self.s10)) // x26
1555            .field("s11", &format_args!("{:#x}", self.s11)) // x27
1556            .field("t3", &format_args!("{:#x}", self.t3)) // x28
1557            .field("t4", &format_args!("{:#x}", self.t4)) // x29
1558            .field("t5", &format_args!("{:#x}", self.t5)) // x30
1559            .field("t6", &format_args!("{:#x}", self.t6)) // x31
1560            .finish()
1561    }
1562}
1563
1564multiconst!(zx_restricted_reason_t, [
1565    ZX_RESTRICTED_REASON_SYSCALL = 0;
1566    ZX_RESTRICTED_REASON_EXCEPTION = 1;
1567    ZX_RESTRICTED_REASON_KICK = 2;
1568]);
1569
1570#[cfg(target_arch = "x86_64")]
1571#[repr(C)]
1572#[derive(Debug, Default, Copy, Clone, Eq, PartialEq)]
1573pub struct zx_restricted_state_t {
1574    pub rdi: u64,
1575    pub rsi: u64,
1576    pub rbp: u64,
1577    pub rbx: u64,
1578    pub rdx: u64,
1579    pub rcx: u64,
1580    pub rax: u64,
1581    pub rsp: u64,
1582    pub r8: u64,
1583    pub r9: u64,
1584    pub r10: u64,
1585    pub r11: u64,
1586    pub r12: u64,
1587    pub r13: u64,
1588    pub r14: u64,
1589    pub r15: u64,
1590    pub ip: u64,
1591    pub flags: u64,
1592    pub fs_base: u64,
1593    pub gs_base: u64,
1594}
1595
1596#[cfg(target_arch = "x86_64")]
1597impl From<&zx_thread_state_general_regs_t> for zx_restricted_state_t {
1598    fn from(registers: &zx_thread_state_general_regs_t) -> Self {
1599        Self {
1600            rdi: registers.rdi,
1601            rsi: registers.rsi,
1602            rbp: registers.rbp,
1603            rbx: registers.rbx,
1604            rdx: registers.rdx,
1605            rcx: registers.rcx,
1606            rax: registers.rax,
1607            rsp: registers.rsp,
1608            r8: registers.r8,
1609            r9: registers.r9,
1610            r10: registers.r10,
1611            r11: registers.r11,
1612            r12: registers.r12,
1613            r13: registers.r13,
1614            r14: registers.r14,
1615            r15: registers.r15,
1616            ip: registers.rip,
1617            flags: registers.rflags,
1618            fs_base: registers.fs_base,
1619            gs_base: registers.gs_base,
1620        }
1621    }
1622}
1623
1624#[cfg(target_arch = "aarch64")]
1625#[repr(C)]
1626#[derive(Debug, Default, Copy, Clone, Eq, PartialEq)]
1627pub struct zx_restricted_state_t {
1628    pub r: [u64; 31], // Note: r[30] is `lr` which is separated out in the general regs.
1629    pub sp: u64,
1630    pub pc: u64,
1631    pub tpidr_el0: u64,
1632    // Contains only the user-controllable upper 4-bits (NZCV).
1633    pub cpsr: u32,
1634    padding1: [PadByte; 4],
1635}
1636
1637#[cfg(target_arch = "aarch64")]
1638impl From<&zx_thread_state_general_regs_t> for zx_restricted_state_t {
1639    fn from(registers: &zx_thread_state_general_regs_t) -> Self {
1640        Self {
1641            r: [
1642                registers.r[0],
1643                registers.r[1],
1644                registers.r[2],
1645                registers.r[3],
1646                registers.r[4],
1647                registers.r[5],
1648                registers.r[6],
1649                registers.r[7],
1650                registers.r[8],
1651                registers.r[9],
1652                registers.r[10],
1653                registers.r[11],
1654                registers.r[12],
1655                registers.r[13],
1656                registers.r[14],
1657                registers.r[15],
1658                registers.r[16],
1659                registers.r[17],
1660                registers.r[18],
1661                registers.r[19],
1662                registers.r[20],
1663                registers.r[21],
1664                registers.r[22],
1665                registers.r[23],
1666                registers.r[24],
1667                registers.r[25],
1668                registers.r[26],
1669                registers.r[27],
1670                registers.r[28],
1671                registers.r[29],
1672                registers.lr, // for compat this works nicely with zircon.
1673            ],
1674            pc: registers.pc,
1675            tpidr_el0: registers.tpidr,
1676            sp: registers.sp,
1677            cpsr: registers.cpsr as u32,
1678            padding1: Default::default(),
1679        }
1680    }
1681}
1682
1683#[cfg(target_arch = "riscv64")]
1684pub type zx_restricted_state_t = zx_thread_state_general_regs_t;
1685
1686#[cfg(target_arch = "riscv64")]
1687impl From<&zx_thread_state_general_regs_t> for zx_restricted_state_t {
1688    fn from(registers: &zx_thread_state_general_regs_t) -> Self {
1689        *registers
1690    }
1691}
1692
1693#[repr(C)]
1694#[derive(Debug, Default, Copy, Clone, Eq, PartialEq)]
1695#[cfg(any(target_arch = "aarch64", target_arch = "x86_64", target_arch = "riscv64"))]
1696pub struct zx_restricted_syscall_t {
1697    pub state: zx_restricted_state_t,
1698}
1699
1700#[repr(C)]
1701#[derive(Copy, Clone)]
1702#[cfg(any(target_arch = "aarch64", target_arch = "x86_64", target_arch = "riscv64"))]
1703pub struct zx_restricted_exception_t {
1704    pub state: zx_restricted_state_t,
1705    pub exception: zx_exception_report_t,
1706}
1707
1708#[cfg(target_arch = "x86_64")]
1709#[repr(C)]
1710#[derive(Debug, Default, Copy, Clone, Eq, PartialEq)]
1711pub struct zx_vcpu_state_t {
1712    pub rax: u64,
1713    pub rcx: u64,
1714    pub rdx: u64,
1715    pub rbx: u64,
1716    pub rsp: u64,
1717    pub rbp: u64,
1718    pub rsi: u64,
1719    pub rdi: u64,
1720    pub r8: u64,
1721    pub r9: u64,
1722    pub r10: u64,
1723    pub r11: u64,
1724    pub r12: u64,
1725    pub r13: u64,
1726    pub r14: u64,
1727    pub r15: u64,
1728    // Contains only the user-controllable lower 32-bits.
1729    pub rflags: u64,
1730}
1731
1732#[cfg(target_arch = "aarch64")]
1733#[repr(C)]
1734#[derive(Debug, Default, Copy, Clone, Eq, PartialEq)]
1735pub struct zx_vcpu_state_t {
1736    pub x: [u64; 31],
1737    pub sp: u64,
1738    // Contains only the user-controllable upper 4-bits (NZCV).
1739    pub cpsr: u32,
1740    padding1: [PadByte; 4],
1741}
1742
1743#[cfg(target_arch = "riscv64")]
1744#[repr(C)]
1745#[derive(Debug, Default, Copy, Clone, Eq, PartialEq)]
1746pub struct zx_vcpu_state_t {
1747    pub empty: u32,
1748}
1749
1750#[repr(C)]
1751#[derive(Debug, Default, Copy, Clone, Eq, PartialEq)]
1752pub struct zx_vcpu_io_t {
1753    pub access_size: u8,
1754    padding1: [PadByte; 3],
1755    pub data: [u8; 4],
1756}
1757
1758#[cfg(target_arch = "aarch64")]
1759#[repr(C)]
1760#[derive(Debug, Default, Copy, Clone, Eq, PartialEq)]
1761pub struct zx_packet_guest_mem_t {
1762    pub addr: zx_gpaddr_t,
1763    pub access_size: u8,
1764    pub sign_extend: bool,
1765    pub xt: u8,
1766    pub read: bool,
1767    pub data: u64,
1768}
1769
1770#[cfg(target_arch = "riscv64")]
1771#[repr(C)]
1772#[derive(Debug, Default, Copy, Clone, Eq, PartialEq)]
1773pub struct zx_packet_guest_mem_t {
1774    pub addr: zx_gpaddr_t,
1775    padding1: [PadByte; 24],
1776}
1777
1778pub const X86_MAX_INST_LEN: usize = 15;
1779
1780#[cfg(target_arch = "x86_64")]
1781#[repr(C)]
1782#[derive(Debug, Copy, Clone, Eq, PartialEq)]
1783pub struct zx_packet_guest_mem_t {
1784    pub addr: zx_gpaddr_t,
1785    pub cr3: zx_gpaddr_t,
1786    pub rip: zx_vaddr_t,
1787    pub instruction_size: u8,
1788    pub default_operand_size: u8,
1789}
1790
1791#[repr(C)]
1792#[derive(Debug, Default, Copy, Clone, Eq, PartialEq)]
1793pub struct zx_packet_interrupt_t {
1794    pub timestamp: zx_time_t,
1795    padding1: [PadByte; 24],
1796}
1797
1798// Helper for constructing topics that have been versioned.
1799const fn info_topic(topic: u32, version: u32) -> u32 {
1800    (version << 28) | topic
1801}
1802
1803multiconst!(zx_object_info_topic_t, [
1804    ZX_INFO_NONE                       = 0;
1805    ZX_INFO_HANDLE_VALID               = 1;
1806    ZX_INFO_HANDLE_BASIC               = 2;  // zx_info_handle_basic_t[1]
1807    ZX_INFO_PROCESS                    = info_topic(3, 1);  // zx_info_process_t[1]
1808    ZX_INFO_PROCESS_THREADS            = 4;  // zx_koid_t[n]
1809    ZX_INFO_VMAR                       = 7;  // zx_info_vmar_t[1]
1810    ZX_INFO_JOB_CHILDREN               = 8;  // zx_koid_t[n]
1811    ZX_INFO_JOB_PROCESSES              = 9;  // zx_koid_t[n]
1812    ZX_INFO_THREAD                     = 10; // zx_info_thread_t[1]
1813    ZX_INFO_THREAD_EXCEPTION_REPORT    = info_topic(11, 1); // zx_exception_report_t[1]
1814    ZX_INFO_TASK_STATS                 = info_topic(12, 1); // zx_info_task_stats_t[1]
1815    ZX_INFO_PROCESS_MAPS               = info_topic(13, 2); // zx_info_maps_t[n]
1816    ZX_INFO_PROCESS_VMOS               = info_topic(14, 3); // zx_info_vmo_t[n]
1817    ZX_INFO_THREAD_STATS               = 15; // zx_info_thread_stats_t[1]
1818    ZX_INFO_CPU_STATS                  = 16; // zx_info_cpu_stats_t[n]
1819    ZX_INFO_KMEM_STATS                 = info_topic(17, 1); // zx_info_kmem_stats_t[1]
1820    ZX_INFO_RESOURCE                   = 18; // zx_info_resource_t[1]
1821    ZX_INFO_HANDLE_COUNT               = 19; // zx_info_handle_count_t[1]
1822    ZX_INFO_BTI                        = 20; // zx_info_bti_t[1]
1823    ZX_INFO_PROCESS_HANDLE_STATS       = 21; // zx_info_process_handle_stats_t[1]
1824    ZX_INFO_SOCKET                     = 22; // zx_info_socket_t[1]
1825    ZX_INFO_VMO                        = info_topic(23, 3); // zx_info_vmo_t[1]
1826    ZX_INFO_JOB                        = 24; // zx_info_job_t[1]
1827    ZX_INFO_TIMER                      = 25; // zx_info_timer_t[1]
1828    ZX_INFO_STREAM                     = 26; // zx_info_stream_t[1]
1829    ZX_INFO_HANDLE_TABLE               = 27; // zx_info_handle_extended_t[n]
1830    ZX_INFO_MSI                        = 28; // zx_info_msi_t[1]
1831    ZX_INFO_GUEST_STATS                = 29; // zx_info_guest_stats_t[1]
1832    ZX_INFO_TASK_RUNTIME               = info_topic(30, 1); // zx_info_task_runtime_t[1]
1833    ZX_INFO_KMEM_STATS_EXTENDED        = 31; // zx_info_kmem_stats_extended_t[1]
1834    ZX_INFO_VCPU                       = 32; // zx_info_vcpu_t[1]
1835    ZX_INFO_KMEM_STATS_COMPRESSION     = 33; // zx_info_kmem_stats_compression_t[1]
1836    ZX_INFO_IOB                        = 34; // zx_info_iob_t[1]
1837    ZX_INFO_IOB_REGIONS                = 35; // zx_iob_region_info_t[n]
1838    ZX_INFO_VMAR_MAPS                  = 36; // zx_info_maps_t[n]
1839    ZX_INFO_POWER_DOMAINS              = 37; // zx_info_power_domain_info_t[n]
1840    ZX_INFO_MEMORY_STALL               = 38; // zx_info_memory_stall_t[1]
1841    ZX_INFO_CLOCK_MAPPED_SIZE          = 40; // usize[1]
1842]);
1843
1844multiconst!(zx_system_memory_stall_type_t, [
1845    ZX_SYSTEM_MEMORY_STALL_SOME        = 0;
1846    ZX_SYSTEM_MEMORY_STALL_FULL        = 1;
1847]);
1848
1849// This macro takes struct-like syntax and creates another macro that can be used to create
1850// different instances of the struct with different names. This is used to keep struct definitions
1851// from drifting between this crate and the fuchsia-zircon crate where they are identical other
1852// than in name and location.
1853macro_rules! struct_decl_macro {
1854    ( $(#[$attrs:meta])* $vis:vis struct <$macro_name:ident> $($any:tt)* ) => {
1855        #[macro_export]
1856        macro_rules! $macro_name {
1857            ($name:ident) => {
1858                $(#[$attrs])* $vis struct $name $($any)*
1859            }
1860        }
1861    }
1862}
1863
1864// Don't need struct_decl_macro for this, the wrapper is different.
1865#[repr(C)]
1866#[derive(Default, Debug, Copy, Clone, Eq, FromBytes, Immutable, PartialEq)]
1867pub struct zx_info_handle_basic_t {
1868    pub koid: zx_koid_t,
1869    pub rights: zx_rights_t,
1870    pub type_: zx_obj_type_t,
1871    pub related_koid: zx_koid_t,
1872    padding1: [PadByte; 4],
1873}
1874
1875struct_decl_macro! {
1876    #[repr(C)]
1877    #[derive(Default, Debug, Copy, Clone, Eq, PartialEq)]
1878    #[derive(zerocopy::FromBytes, zerocopy::Immutable)]
1879    pub struct <zx_info_handle_count_t> {
1880        pub handle_count: u32,
1881    }
1882}
1883
1884zx_info_handle_count_t!(zx_info_handle_count_t);
1885
1886// Don't need struct_decl_macro for this, the wrapper is different.
1887#[repr(C)]
1888#[derive(Default, Debug, Copy, Clone, Eq, PartialEq, KnownLayout, FromBytes, Immutable)]
1889pub struct zx_info_socket_t {
1890    pub options: u32,
1891    pub rx_buf_max: usize,
1892    pub rx_buf_size: usize,
1893    pub rx_buf_available: usize,
1894    pub tx_buf_max: usize,
1895    pub tx_buf_size: usize,
1896}
1897
1898multiconst!(u32, [
1899    ZX_INFO_PROCESS_FLAG_STARTED = 1 << 0;
1900    ZX_INFO_PROCESS_FLAG_EXITED = 1 << 1;
1901    ZX_INFO_PROCESS_FLAG_DEBUGGER_ATTACHED = 1 << 2;
1902]);
1903
1904struct_decl_macro! {
1905    #[repr(C)]
1906    #[derive(Default, Debug, Copy, Clone, Eq, PartialEq)]
1907    #[derive(zerocopy::FromBytes, zerocopy::Immutable)]
1908    pub struct <zx_info_process_t> {
1909        pub return_code: i64,
1910        pub start_time: zx_time_t,
1911        pub flags: u32,
1912    }
1913}
1914
1915zx_info_process_t!(zx_info_process_t);
1916
1917struct_decl_macro! {
1918    #[repr(C)]
1919    #[derive(Default, Debug, Copy, Clone, Eq, PartialEq)]
1920    #[derive(zerocopy::FromBytes, zerocopy::Immutable)]
1921    pub struct <zx_info_job_t> {
1922        pub return_code: i64,
1923        pub exited: u8,
1924        pub kill_on_oom: u8,
1925        pub debugger_attached: u8,
1926    }
1927}
1928
1929zx_info_job_t!(zx_info_job_t);
1930
1931struct_decl_macro! {
1932    #[repr(C)]
1933    #[derive(Default, Debug, Copy, Clone, Eq, PartialEq)]
1934    #[derive(zerocopy::FromBytes, zerocopy::IntoBytes, zerocopy::Immutable)]
1935    pub struct <zx_info_timer_t> {
1936        pub options: u32,
1937        pub clock_id: zx_clock_t,
1938        pub deadline: zx_time_t,
1939        pub slack: zx_duration_t,
1940    }
1941}
1942
1943zx_info_timer_t!(zx_info_timer_t);
1944
1945#[repr(C)]
1946#[derive(Debug, Copy, Clone, Eq, PartialEq)]
1947pub struct zx_policy_basic {
1948    pub condition: u32,
1949    pub policy: u32,
1950}
1951
1952#[repr(C)]
1953#[derive(Debug, Copy, Clone, Eq, PartialEq)]
1954pub struct zx_policy_timer_slack {
1955    pub min_slack: zx_duration_t,
1956    pub default_mode: u32,
1957}
1958
1959multiconst!(u32, [
1960    // policy options
1961    ZX_JOB_POL_RELATIVE = 0;
1962    ZX_JOB_POL_ABSOLUTE = 1;
1963
1964    // policy topic
1965    ZX_JOB_POL_BASIC = 0;
1966    ZX_JOB_POL_TIMER_SLACK = 1;
1967
1968    // policy conditions
1969    ZX_POL_BAD_HANDLE            = 0;
1970    ZX_POL_WRONG_OBJECT          = 1;
1971    ZX_POL_VMAR_WX               = 2;
1972    ZX_POL_NEW_ANY               = 3;
1973    ZX_POL_NEW_VMO               = 4;
1974    ZX_POL_NEW_CHANNEL           = 5;
1975    ZX_POL_NEW_EVENT             = 6;
1976    ZX_POL_NEW_EVENTPAIR         = 7;
1977    ZX_POL_NEW_PORT              = 8;
1978    ZX_POL_NEW_SOCKET            = 9;
1979    ZX_POL_NEW_FIFO              = 10;
1980    ZX_POL_NEW_TIMER             = 11;
1981    ZX_POL_NEW_PROCESS           = 12;
1982    ZX_POL_NEW_PROFILE           = 13;
1983    ZX_POL_NEW_PAGER             = 14;
1984    ZX_POL_AMBIENT_MARK_VMO_EXEC = 15;
1985
1986    // policy actions
1987    ZX_POL_ACTION_ALLOW           = 0;
1988    ZX_POL_ACTION_DENY            = 1;
1989    ZX_POL_ACTION_ALLOW_EXCEPTION = 2;
1990    ZX_POL_ACTION_DENY_EXCEPTION  = 3;
1991    ZX_POL_ACTION_KILL            = 4;
1992
1993    // timer slack default modes
1994    ZX_TIMER_SLACK_CENTER = 0;
1995    ZX_TIMER_SLACK_EARLY  = 1;
1996    ZX_TIMER_SLACK_LATE   = 2;
1997]);
1998
1999multiconst!(u32, [
2000    // critical options
2001    ZX_JOB_CRITICAL_PROCESS_RETCODE_NONZERO = 1 << 0;
2002]);
2003
2004// Don't use struct_decl_macro, wrapper is different.
2005#[repr(C)]
2006#[derive(
2007    Default, Debug, Copy, Clone, Eq, PartialEq, KnownLayout, FromBytes, Immutable, IntoBytes,
2008)]
2009pub struct zx_info_vmo_t {
2010    pub koid: zx_koid_t,
2011    pub name: [u8; ZX_MAX_NAME_LEN],
2012    pub size_bytes: u64,
2013    pub parent_koid: zx_koid_t,
2014    pub num_children: usize,
2015    pub num_mappings: usize,
2016    pub share_count: usize,
2017    pub flags: u32,
2018    padding1: [PadByte; 4],
2019    pub committed_bytes: u64,
2020    pub handle_rights: zx_rights_t,
2021    pub cache_policy: u32,
2022    pub metadata_bytes: u64,
2023    pub committed_change_events: u64,
2024    pub populated_bytes: u64,
2025    pub committed_private_bytes: u64,
2026    pub populated_private_bytes: u64,
2027    pub committed_scaled_bytes: u64,
2028    pub populated_scaled_bytes: u64,
2029    pub committed_fractional_scaled_bytes: u64,
2030    pub populated_fractional_scaled_bytes: u64,
2031}
2032
2033struct_decl_macro! {
2034    #[repr(C)]
2035    #[derive(Default, Debug, Copy, Clone, Eq, PartialEq)]
2036    #[derive(zerocopy::FromBytes, zerocopy::Immutable)]
2037    pub struct <zx_info_cpu_stats_t> {
2038        pub cpu_number: u32,
2039        pub flags: u32,
2040        pub idle_time: zx_duration_t,
2041        pub reschedules: u64,
2042        pub context_switches: u64,
2043        pub irq_preempts: u64,
2044        pub preempts: u64,
2045        pub yields: u64,
2046        pub ints: u64,
2047        pub timer_ints: u64,
2048        pub timers: u64,
2049        pub page_faults: u64,
2050        pub exceptions: u64,
2051        pub syscalls: u64,
2052        pub reschedule_ipis: u64,
2053        pub generic_ipis: u64,
2054    }
2055}
2056
2057zx_info_cpu_stats_t!(zx_info_cpu_stats_t);
2058
2059struct_decl_macro! {
2060    #[repr(C)]
2061    #[derive(Default, Debug, Copy, Clone, Eq, PartialEq)]
2062    #[derive(zerocopy::FromBytes, zerocopy::Immutable)]
2063    pub struct <zx_info_kmem_stats_t> {
2064        pub total_bytes: u64,
2065        pub free_bytes: u64,
2066        pub free_loaned_bytes: u64,
2067        pub wired_bytes: u64,
2068        pub total_heap_bytes: u64,
2069        pub free_heap_bytes: u64,
2070        pub vmo_bytes: u64,
2071        pub mmu_overhead_bytes: u64,
2072        pub ipc_bytes: u64,
2073        pub cache_bytes: u64,
2074        pub slab_bytes: u64,
2075        pub zram_bytes: u64,
2076        pub other_bytes: u64,
2077        pub vmo_reclaim_total_bytes: u64,
2078        pub vmo_reclaim_newest_bytes: u64,
2079        pub vmo_reclaim_oldest_bytes: u64,
2080        pub vmo_reclaim_disabled_bytes: u64,
2081        pub vmo_discardable_locked_bytes: u64,
2082        pub vmo_discardable_unlocked_bytes: u64,
2083    }
2084}
2085
2086zx_info_kmem_stats_t!(zx_info_kmem_stats_t);
2087
2088struct_decl_macro! {
2089    #[repr(C)]
2090    #[derive(Default, Debug, Copy, Clone, Eq, PartialEq)]
2091    #[derive(zerocopy::FromBytes, zerocopy::Immutable)]
2092    pub struct <zx_info_kmem_stats_extended_t> {
2093        pub total_bytes: u64,
2094        pub free_bytes: u64,
2095        pub wired_bytes: u64,
2096        pub total_heap_bytes: u64,
2097        pub free_heap_bytes: u64,
2098        pub vmo_bytes: u64,
2099        pub vmo_pager_total_bytes: u64,
2100        pub vmo_pager_newest_bytes: u64,
2101        pub vmo_pager_oldest_bytes: u64,
2102        pub vmo_discardable_locked_bytes: u64,
2103        pub vmo_discardable_unlocked_bytes: u64,
2104        pub mmu_overhead_bytes: u64,
2105        pub ipc_bytes: u64,
2106        pub other_bytes: u64,
2107        pub vmo_reclaim_disable_bytes: u64,
2108    }
2109}
2110
2111zx_info_kmem_stats_extended_t!(zx_info_kmem_stats_extended_t);
2112
2113struct_decl_macro! {
2114    #[repr(C)]
2115    #[derive(Default, Debug, Copy, Clone, Eq, PartialEq)]
2116    #[derive(zerocopy::FromBytes, zerocopy::Immutable)]
2117    pub struct <zx_info_kmem_stats_compression_t> {
2118        pub uncompressed_storage_bytes: u64,
2119        pub compressed_storage_bytes: u64,
2120        pub compressed_fragmentation_bytes: u64,
2121        pub compression_time: zx_duration_t,
2122        pub decompression_time: zx_duration_t,
2123        pub total_page_compression_attempts: u64,
2124        pub failed_page_compression_attempts: u64,
2125        pub total_page_decompressions: u64,
2126        pub compressed_page_evictions: u64,
2127        pub eager_page_compressions: u64,
2128        pub memory_pressure_page_compressions: u64,
2129        pub critical_memory_page_compressions: u64,
2130        pub pages_decompressed_unit_ns: u64,
2131        pub pages_decompressed_within_log_time: [u64; 8],
2132    }
2133}
2134
2135zx_info_kmem_stats_compression_t!(zx_info_kmem_stats_compression_t);
2136
2137struct_decl_macro! {
2138    #[repr(C)]
2139    #[derive(Default, Debug, Copy, Clone, Eq, PartialEq)]
2140    #[derive(zerocopy::FromBytes, zerocopy::Immutable)]
2141    pub struct <zx_info_resource_t> {
2142        pub kind: u32,
2143        pub flags: u32,
2144        pub base: u64,
2145        pub size: usize,
2146        pub name: [u8; ZX_MAX_NAME_LEN],
2147    }
2148}
2149
2150pub type zx_thread_state_t = u32;
2151
2152multiconst!(zx_thread_state_t, [
2153    ZX_THREAD_STATE_NEW = 0x0000;
2154    ZX_THREAD_STATE_RUNNING = 0x0001;
2155    ZX_THREAD_STATE_SUSPENDED = 0x0002;
2156    ZX_THREAD_STATE_BLOCKED = 0x0003;
2157    ZX_THREAD_STATE_DYING = 0x0004;
2158    ZX_THREAD_STATE_DEAD = 0x0005;
2159    ZX_THREAD_STATE_BLOCKED_EXCEPTION = 0x0103;
2160    ZX_THREAD_STATE_BLOCKED_SLEEPING = 0x0203;
2161    ZX_THREAD_STATE_BLOCKED_FUTEX = 0x0303;
2162    ZX_THREAD_STATE_BLOCKED_PORT = 0x0403;
2163    ZX_THREAD_STATE_BLOCKED_CHANNEL = 0x0503;
2164    ZX_THREAD_STATE_BLOCKED_WAIT_ONE = 0x0603;
2165    ZX_THREAD_STATE_BLOCKED_WAIT_MANY = 0x0703;
2166    ZX_THREAD_STATE_BLOCKED_INTERRUPT = 0x0803;
2167    ZX_THREAD_STATE_BLOCKED_PAGER = 0x0903;
2168]);
2169
2170#[repr(C)]
2171#[derive(Default, Debug, Copy, Clone, Eq, PartialEq, zerocopy::FromBytes, zerocopy::Immutable)]
2172pub struct zx_info_thread_t {
2173    pub state: zx_thread_state_t,
2174    pub wait_exception_channel_type: u32,
2175    pub cpu_affinity_mask: zx_cpu_set_t,
2176}
2177
2178struct_decl_macro! {
2179    #[repr(C)]
2180    #[derive(Default, Debug, Copy, Clone, Eq, PartialEq)]
2181    #[derive(zerocopy::FromBytes, zerocopy::Immutable)]
2182    pub struct <zx_info_thread_stats_t> {
2183        pub total_runtime: zx_duration_t,
2184        pub last_scheduled_cpu: u32,
2185    }
2186}
2187
2188zx_info_thread_stats_t!(zx_info_thread_stats_t);
2189
2190zx_info_resource_t!(zx_info_resource_t);
2191
2192struct_decl_macro! {
2193    #[repr(C)]
2194    #[derive(Default, Debug, Copy, Clone, Eq, PartialEq)]
2195    #[derive(zerocopy::FromBytes, zerocopy::Immutable)]
2196    pub struct <zx_info_vmar_t> {
2197        pub base: usize,
2198        pub len: usize,
2199    }
2200}
2201
2202zx_info_vmar_t!(zx_info_vmar_t);
2203
2204struct_decl_macro! {
2205    #[repr(C)]
2206    #[derive(Default, Debug, Copy, Clone, Eq, PartialEq)]
2207    #[derive(zerocopy::FromBytes, zerocopy::Immutable)]
2208    pub struct <zx_info_task_stats_t> {
2209        pub mem_mapped_bytes: usize,
2210        pub mem_private_bytes: usize,
2211        pub mem_shared_bytes: usize,
2212        pub mem_scaled_shared_bytes: usize,
2213        pub mem_fractional_scaled_shared_bytes: u64,
2214    }
2215}
2216
2217zx_info_task_stats_t!(zx_info_task_stats_t);
2218
2219struct_decl_macro! {
2220    #[repr(C)]
2221    #[derive(Default, Debug, Copy, Clone, Eq, PartialEq)]
2222    #[derive(zerocopy::FromBytes, zerocopy::Immutable)]
2223    pub struct <zx_info_task_runtime_t> {
2224        pub cpu_time: zx_duration_t,
2225        pub queue_time: zx_duration_t,
2226        pub page_fault_time: zx_duration_t,
2227        pub lock_contention_time: zx_duration_t,
2228    }
2229}
2230
2231zx_info_task_runtime_t!(zx_info_task_runtime_t);
2232
2233multiconst!(zx_info_maps_type_t, [
2234    ZX_INFO_MAPS_TYPE_NONE    = 0;
2235    ZX_INFO_MAPS_TYPE_ASPACE  = 1;
2236    ZX_INFO_MAPS_TYPE_VMAR    = 2;
2237    ZX_INFO_MAPS_TYPE_MAPPING = 3;
2238]);
2239
2240struct_decl_macro! {
2241    #[repr(C)]
2242    #[derive(Default, Debug, Copy, Clone, Eq, PartialEq)]
2243    #[derive(zerocopy::FromBytes, zerocopy::Immutable, IntoBytes)]
2244    pub struct <zx_info_maps_mapping_t> {
2245        pub mmu_flags: zx_vm_option_t,
2246        padding1: [PadByte; 4],
2247        pub vmo_koid: zx_koid_t,
2248        pub vmo_offset: u64,
2249        pub committed_bytes: usize,
2250        pub populated_bytes: usize,
2251        pub committed_private_bytes: usize,
2252        pub populated_private_bytes: usize,
2253        pub committed_scaled_bytes: usize,
2254        pub populated_scaled_bytes: usize,
2255        pub committed_fractional_scaled_bytes: u64,
2256        pub populated_fractional_scaled_bytes: u64,
2257    }
2258}
2259
2260zx_info_maps_mapping_t!(zx_info_maps_mapping_t);
2261
2262#[repr(C)]
2263#[derive(Copy, Clone, KnownLayout, FromBytes, Immutable)]
2264pub union InfoMapsTypeUnion {
2265    pub mapping: zx_info_maps_mapping_t,
2266}
2267
2268struct_decl_macro! {
2269    #[repr(C)]
2270    #[derive(Copy, Clone)]
2271    #[derive(zerocopy::FromBytes, zerocopy::Immutable)]
2272    pub struct <zx_info_maps_t> {
2273        pub name: [u8; ZX_MAX_NAME_LEN],
2274        pub base: zx_vaddr_t,
2275        pub size: usize,
2276        pub depth: usize,
2277        pub r#type: zx_info_maps_type_t,
2278        pub u: InfoMapsTypeUnion,
2279    }
2280}
2281
2282zx_info_maps_t!(zx_info_maps_t);
2283
2284struct_decl_macro! {
2285    #[repr(C)]
2286    #[derive(Debug, Copy, Clone, Eq, PartialEq)]
2287    #[derive(zerocopy::FromBytes, zerocopy::Immutable)]
2288    pub struct <zx_info_process_handle_stats_t> {
2289        pub handle_count: [u32; ZX_OBJ_TYPE_UPPER_BOUND],
2290    }
2291}
2292
2293impl Default for zx_info_process_handle_stats_t {
2294    fn default() -> Self {
2295        Self { handle_count: [0; ZX_OBJ_TYPE_UPPER_BOUND] }
2296    }
2297}
2298
2299zx_info_process_handle_stats_t!(zx_info_process_handle_stats_t);
2300
2301struct_decl_macro! {
2302    #[repr(C)]
2303    #[derive(Default, Debug, Copy, Clone, Eq, PartialEq)]
2304    #[derive(zerocopy::FromBytes, zerocopy::Immutable, zerocopy::IntoBytes)]
2305    pub struct <zx_info_memory_stall_t> {
2306        pub stall_time_some: zx_duration_mono_t,
2307        pub stall_time_full: zx_duration_mono_t,
2308    }
2309}
2310
2311zx_info_memory_stall_t!(zx_info_memory_stall_t);
2312
2313// from //zircon/system/public/zircon/syscalls/hypervisor.h
2314multiconst!(zx_guest_option_t, [
2315    ZX_GUEST_OPT_NORMAL = 0;
2316]);
2317
2318multiconst!(zx_guest_trap_t, [
2319    ZX_GUEST_TRAP_BELL = 0;
2320    ZX_GUEST_TRAP_MEM  = 1;
2321    ZX_GUEST_TRAP_IO   = 2;
2322]);
2323
2324pub const ZX_LOG_RECORD_MAX: usize = 256;
2325pub const ZX_LOG_RECORD_DATA_MAX: usize = 216;
2326
2327pub const DEBUGLOG_TRACE: u8 = 0x10;
2328pub const DEBUGLOG_DEBUG: u8 = 0x20;
2329pub const DEBUGLOG_INFO: u8 = 0x30;
2330pub const DEBUGLOG_WARNING: u8 = 0x40;
2331pub const DEBUGLOG_ERROR: u8 = 0x50;
2332pub const DEBUGLOG_FATAL: u8 = 0x60;
2333
2334struct_decl_macro! {
2335    #[repr(C)]
2336    #[derive(Debug, Copy, Clone, Eq, PartialEq)]
2337    #[derive(zerocopy::FromBytes, zerocopy::Immutable)]
2338    pub struct <zx_log_record_t> {
2339        pub sequence: u64,
2340        padding1: [PadByte; 4],
2341        pub datalen: u16,
2342        pub severity: u8,
2343        pub flags: u8,
2344        pub timestamp: zx_instant_boot_t,
2345        pub pid: u64,
2346        pub tid: u64,
2347        pub data: [u8; ZX_LOG_RECORD_DATA_MAX],
2348    }
2349}
2350const_assert_eq!(std::mem::size_of::<zx_log_record_t>(), ZX_LOG_RECORD_MAX);
2351
2352zx_log_record_t!(zx_log_record_t);
2353
2354impl Default for zx_log_record_t {
2355    fn default() -> zx_log_record_t {
2356        zx_log_record_t {
2357            sequence: 0,
2358            padding1: Default::default(),
2359            datalen: 0,
2360            severity: 0,
2361            flags: 0,
2362            timestamp: 0,
2363            pid: 0,
2364            tid: 0,
2365            data: [0; ZX_LOG_RECORD_DATA_MAX],
2366        }
2367    }
2368}
2369
2370multiconst!(u32, [
2371    ZX_LOG_FLAG_READABLE = 0x40000000;
2372]);
2373
2374// For C, the below types are currently forward declared for syscalls.h.
2375// We might want to investigate a better solution for Rust or removing those
2376// forward declarations.
2377//
2378// These are hand typed translations from C types into Rust structures using a C
2379// layout
2380
2381// source: zircon/system/public/zircon/syscalls/system.h
2382#[repr(C)]
2383pub struct zx_system_powerctl_arg_t {
2384    // rust can't express anonymous unions at this time
2385    // https://github.com/rust-lang/rust/issues/49804
2386    pub powerctl_internal: zx_powerctl_union,
2387}
2388
2389#[repr(C)]
2390#[derive(Copy, Clone)]
2391pub union zx_powerctl_union {
2392    acpi_transition_s_state: acpi_transition_s_state,
2393    x86_power_limit: x86_power_limit,
2394}
2395
2396#[repr(C)]
2397#[derive(Default, Debug, PartialEq, Copy, Clone)]
2398pub struct acpi_transition_s_state {
2399    target_s_state: u8, // Value between 1 and 5 indicating which S-state
2400    sleep_type_a: u8,   // Value from ACPI VM (SLP_TYPa)
2401    sleep_type_b: u8,   // Value from ACPI VM (SLP_TYPb)
2402    padding1: [PadByte; 9],
2403}
2404
2405#[repr(C)]
2406#[derive(Default, Debug, PartialEq, Copy, Clone)]
2407pub struct x86_power_limit {
2408    power_limit: u32, // PL1 value in milliwatts
2409    time_window: u32, // PL1 time window in microseconds
2410    clamp: u8,        // PL1 clamping enable
2411    enable: u8,       // PL1 enable
2412    padding1: [PadByte; 2],
2413}
2414
2415// source: zircon/system/public/zircon/syscalls/pci.h
2416pub type zx_pci_bar_types_t = u32;
2417
2418multiconst!(zx_pci_bar_types_t, [
2419            ZX_PCI_BAR_TYPE_UNUSED = 0;
2420            ZX_PCI_BAR_TYPE_MMIO = 1;
2421            ZX_PCI_BAR_TYPE_PIO = 2;
2422]);
2423
2424#[repr(C)]
2425pub struct zx_pci_bar_t {
2426    pub id: u32,
2427    pub ty: u32,
2428    pub size: usize,
2429    // rust can't express anonymous unions at this time
2430    // https://github.com/rust-lang/rust/issues/49804
2431    pub zx_pci_bar_union: zx_pci_bar_union,
2432}
2433
2434#[repr(C)]
2435#[derive(Copy, Clone)]
2436pub union zx_pci_bar_union {
2437    addr: usize,
2438    zx_pci_bar_union_struct: zx_pci_bar_union_struct,
2439}
2440
2441#[repr(C)]
2442#[derive(Default, Debug, PartialEq, Copy, Clone)]
2443pub struct zx_pci_bar_union_struct {
2444    handle: zx_handle_t,
2445    padding1: [PadByte; 4],
2446}
2447
2448// source: zircon/system/public/zircon/syscalls/smc.h
2449#[repr(C)]
2450#[derive(Debug, Copy, Clone, Default, Eq, PartialEq)]
2451pub struct zx_smc_parameters_t {
2452    pub func_id: u32,
2453    padding1: [PadByte; 4],
2454    pub arg1: u64,
2455    pub arg2: u64,
2456    pub arg3: u64,
2457    pub arg4: u64,
2458    pub arg5: u64,
2459    pub arg6: u64,
2460    pub client_id: u16,
2461    pub secure_os_id: u16,
2462    padding2: [PadByte; 4],
2463}
2464
2465#[repr(C)]
2466#[derive(Debug, Copy, Clone, Eq, PartialEq)]
2467pub struct zx_smc_result_t {
2468    pub arg0: u64,
2469    pub arg1: u64,
2470    pub arg2: u64,
2471    pub arg3: u64,
2472    pub arg6: u64,
2473}
2474
2475pub const ZX_CPU_SET_MAX_CPUS: usize = 512;
2476pub const ZX_CPU_SET_BITS_PER_WORD: usize = 64;
2477
2478#[repr(C)]
2479#[derive(Debug, Default, Copy, Clone, Eq, PartialEq, zerocopy::FromBytes, zerocopy::Immutable)]
2480pub struct zx_cpu_set_t {
2481    pub mask: [u64; ZX_CPU_SET_MAX_CPUS / ZX_CPU_SET_BITS_PER_WORD],
2482}
2483
2484// source: zircon/system/public/zircon/syscalls/scheduler.h
2485#[repr(C)]
2486#[derive(Copy, Clone)]
2487pub struct zx_profile_info_t {
2488    pub flags: u32,
2489    padding1: [PadByte; 4],
2490    pub zx_profile_info_union: zx_profile_info_union,
2491    pub cpu_affinity_mask: zx_cpu_set_t,
2492}
2493
2494#[cfg(feature = "zerocopy")]
2495impl Default for zx_profile_info_t {
2496    fn default() -> Self {
2497        Self {
2498            flags: Default::default(),
2499            padding1: Default::default(),
2500            zx_profile_info_union: FromZeros::new_zeroed(),
2501            cpu_affinity_mask: Default::default(),
2502        }
2503    }
2504}
2505
2506#[repr(C)]
2507#[derive(Copy, Clone)]
2508#[cfg_attr(feature = "zerocopy", derive(FromBytes, Immutable))]
2509pub struct priority_params {
2510    pub priority: i32,
2511    padding1: [PadByte; 20],
2512}
2513
2514#[repr(C)]
2515#[derive(Copy, Clone)]
2516#[cfg_attr(feature = "zerocopy", derive(FromBytes, Immutable))]
2517pub union zx_profile_info_union {
2518    pub priority_params: priority_params,
2519    pub deadline_params: zx_sched_deadline_params_t,
2520}
2521
2522#[repr(C)]
2523#[derive(Debug, Copy, Clone, Eq, PartialEq)]
2524#[cfg_attr(feature = "zerocopy", derive(FromBytes, Immutable, KnownLayout))]
2525pub struct zx_sched_deadline_params_t {
2526    pub capacity: zx_duration_t,
2527    pub relative_deadline: zx_duration_t,
2528    pub period: zx_duration_t,
2529}
2530
2531#[repr(C)]
2532#[derive(Debug, Default, Copy, Clone, Eq, PartialEq)]
2533pub struct zx_cpu_performance_scale_t {
2534    pub integer_part: u32,
2535    pub fractional_part: u32,
2536}
2537
2538#[repr(C)]
2539#[derive(Debug, Default, Copy, Clone, Eq, PartialEq)]
2540pub struct zx_cpu_performance_info_t {
2541    pub logical_cpu_number: u32,
2542    pub performance_scale: zx_cpu_performance_scale_t,
2543}
2544
2545#[repr(C)]
2546#[derive(Debug, Default, Copy, Clone, Eq, PartialEq)]
2547pub struct zx_cpu_power_limit_t {
2548    pub logical_cpu_number: u32,
2549    padding1: [PadByte; 4],
2550    pub max_power_nw: u64,
2551}
2552
2553#[repr(C)]
2554#[derive(Debug, Default, Copy, Clone, Eq, PartialEq)]
2555pub struct zx_iommu_desc_dummy_t {
2556    padding1: PadByte,
2557}
2558
2559multiconst!(u32, [
2560    ZX_IOMMU_TYPE_DUMMY = 0;
2561    ZX_IOMMU_TYPE_INTEL = 1;
2562]);
2563
2564#[repr(C)]
2565#[derive(Debug, Copy, Clone)]
2566pub struct zx_sampler_config_t {
2567    pub period: zx_duration_t,
2568    pub buffer_size: usize,
2569    pub iobuffer_discipline: u64,
2570}
2571
2572multiconst!(zx_processor_power_level_options_t, [
2573    ZX_PROCESSOR_POWER_LEVEL_OPTIONS_DOMAIN_INDEPENDENT = 1 << 0;
2574]);
2575
2576multiconst!(zx_processor_power_control_t, [
2577    ZX_PROCESSOR_POWER_CONTROL_CPU_DRIVER = 0;
2578    ZX_PROCESSOR_POWER_CONTROL_ARM_PSCI = 1;
2579    ZX_PROCESSOR_POWER_CONTROL_ARM_WFI = 2;
2580    ZX_PROCESSOR_POWER_CONTROL_RISCV_SBI = 3;
2581    ZX_PROCESSOR_POWER_CONTROL_RISCV_WFI = 4;
2582]);
2583
2584#[repr(C)]
2585#[derive(Debug, Default, Copy, Clone, Eq, PartialEq)]
2586pub struct zx_processor_power_level_t {
2587    pub options: zx_processor_power_level_options_t,
2588    pub processing_rate: u64,
2589    pub power_coefficient_nw: u64,
2590    pub control_interface: zx_processor_power_control_t,
2591    pub control_argument: u64,
2592    pub diagnostic_name: [u8; ZX_MAX_NAME_LEN],
2593    padding1: [PadByte; 32],
2594}
2595
2596#[repr(C)]
2597#[derive(Debug, Default, Copy, Clone, Eq, PartialEq)]
2598pub struct zx_processor_power_level_transition_t {
2599    pub latency: zx_duration_t,
2600    pub energy: u64,
2601    pub from: u8,
2602    pub to: u8,
2603    padding1: [PadByte; 6],
2604}
2605
2606#[repr(C)]
2607#[derive(Debug, Copy, Clone, Default, Eq, PartialEq)]
2608pub struct zx_packet_processor_power_level_transition_request_t {
2609    pub domain_id: u32,
2610    pub options: u32,
2611    pub control_interface: u64,
2612    pub control_argument: u64,
2613    padding1: [PadByte; 8],
2614}
2615
2616#[repr(C)]
2617#[derive(Debug, Copy, Clone, Eq, PartialEq)]
2618pub struct zx_processor_power_state_t {
2619    pub domain_id: u32,
2620    pub options: u32,
2621    pub control_interface: u64,
2622    pub control_argument: u64,
2623}
2624
2625#[repr(C)]
2626#[derive(Debug, Copy, Clone, Default, Eq, PartialEq)]
2627pub struct zx_processor_power_domain_t {
2628    pub cpus: zx_cpu_set_t,
2629    pub domain_id: u32,
2630    padding1: [PadByte; 4],
2631}
2632
2633#[repr(C)]
2634#[derive(Debug, Copy, Clone, Eq, PartialEq)]
2635pub struct zx_power_domain_info_t {
2636    pub cpus: zx_cpu_set_t,
2637    pub domain_id: u32,
2638    pub idle_power_levels: u8,
2639    pub active_power_levels: u8,
2640    padding1: [PadByte; 2],
2641}
2642
2643multiconst!(u32, [
2644    ZX_BTI_PERM_READ = 1 << 0;
2645    ZX_BTI_PERM_WRITE = 1 << 1;
2646    ZX_BTI_PERM_EXECUTE = 1 << 2;
2647    ZX_BTI_COMPRESS = 1 << 3;
2648    ZX_BTI_CONTIGUOUS = 1 << 4;
2649]);
2650
2651// Options for zx_port_create
2652multiconst!(u32, [
2653    ZX_PORT_BIND_TO_INTERRUPT = 1 << 0;
2654]);
2655
2656// Options for zx_interrupt_bind
2657multiconst!(u32, [
2658    ZX_INTERRUPT_BIND = 0;
2659    ZX_INTERRUPT_UNBIND = 1;
2660]);
2661
2662#[repr(C)]
2663pub struct zx_iob_region_t {
2664    pub r#type: zx_iob_region_type_t,
2665    pub access: zx_iob_access_t,
2666    pub size: u64,
2667    pub discipline: zx_iob_discipline_t,
2668    pub extension: zx_iob_region_extension_t,
2669}
2670
2671multiconst!(zx_iob_region_type_t, [
2672    ZX_IOB_REGION_TYPE_PRIVATE = 0;
2673    ZX_IOB_REGION_TYPE_SHARED = 1;
2674]);
2675
2676multiconst!(zx_iob_access_t, [
2677    ZX_IOB_ACCESS_EP0_CAN_MAP_READ = 1 << 0;
2678    ZX_IOB_ACCESS_EP0_CAN_MAP_WRITE = 1 << 1;
2679    ZX_IOB_ACCESS_EP0_CAN_MEDIATED_READ = 1 << 2;
2680    ZX_IOB_ACCESS_EP0_CAN_MEDIATED_WRITE = 1 << 3;
2681    ZX_IOB_ACCESS_EP1_CAN_MAP_READ = 1 << 4;
2682    ZX_IOB_ACCESS_EP1_CAN_MAP_WRITE = 1 << 5;
2683    ZX_IOB_ACCESS_EP1_CAN_MEDIATED_READ = 1 << 6;
2684    ZX_IOB_ACCESS_EP1_CAN_MEDIATED_WRITE = 1 << 7;
2685]);
2686
2687#[repr(C)]
2688#[derive(Copy, Clone)]
2689pub struct zx_iob_discipline_t {
2690    pub r#type: zx_iob_discipline_type_t,
2691    pub extension: zx_iob_discipline_extension_t,
2692}
2693
2694#[repr(C)]
2695#[derive(Copy, Clone)]
2696pub union zx_iob_discipline_extension_t {
2697    // This is in vdso-next.
2698    pub ring_buffer: zx_iob_discipline_mediated_write_ring_buffer_t,
2699    pub reserved: [PadByte; 64],
2700}
2701
2702#[repr(C)]
2703#[derive(Debug, Copy, Clone)]
2704pub struct zx_iob_discipline_mediated_write_ring_buffer_t {
2705    pub tag: u64,
2706    pub padding: [PadByte; 56],
2707}
2708
2709multiconst!(zx_iob_discipline_type_t, [
2710    ZX_IOB_DISCIPLINE_TYPE_NONE = 0;
2711    ZX_IOB_DISCIPLINE_TYPE_MEDIATED_WRITE_RING_BUFFER = 2;
2712]);
2713
2714#[repr(C)]
2715#[derive(Clone, Copy, Default)]
2716pub struct zx_iob_region_private_t {
2717    options: u32,
2718    padding: [PadByte; 28],
2719}
2720
2721#[repr(C)]
2722#[derive(Clone, Copy)]
2723pub struct zx_iob_region_shared_t {
2724    pub options: u32,
2725    pub shared_region: zx_handle_t,
2726    pub padding: [PadByte; 24],
2727}
2728
2729#[repr(C)]
2730pub union zx_iob_region_extension_t {
2731    pub private_region: zx_iob_region_private_t,
2732    pub shared_region: zx_iob_region_shared_t,
2733    pub max_extension: [u8; 32],
2734}
2735
2736#[cfg(test)]
2737mod test {
2738    use super::*;
2739
2740    #[test]
2741    fn padded_struct_equality() {
2742        let test_struct = zx_clock_update_args_v1_t {
2743            rate_adjust: 222,
2744            padding1: Default::default(),
2745            value: 333,
2746            error_bound: 444,
2747        };
2748
2749        let different_data = zx_clock_update_args_v1_t { rate_adjust: 999, ..test_struct.clone() };
2750
2751        let different_padding = zx_clock_update_args_v1_t {
2752            padding1: [PadByte(0), PadByte(1), PadByte(2), PadByte(3)],
2753            ..test_struct.clone()
2754        };
2755
2756        // Structures with different data should not be equal.
2757        assert_ne!(test_struct, different_data);
2758        // Structures with only different padding should not be equal.
2759        assert_eq!(test_struct, different_padding);
2760    }
2761
2762    #[test]
2763    fn padded_struct_debug() {
2764        let test_struct = zx_clock_update_args_v1_t {
2765            rate_adjust: 222,
2766            padding1: Default::default(),
2767            value: 333,
2768            error_bound: 444,
2769        };
2770        let expectation = "zx_clock_update_args_v1_t { \
2771            rate_adjust: 222, \
2772            padding1: [-, -, -, -], \
2773            value: 333, \
2774            error_bound: 444 }";
2775        assert_eq!(format!("{:?}", test_struct), expectation);
2776    }
2777}