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