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