zx/
process.rs

1// Copyright 2017 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//! Type-safe bindings for Zircon processes.
6
7use crate::sys::{self as sys, zx_handle_t, zx_time_t, ZX_OBJ_TYPE_UPPER_BOUND};
8use crate::{
9    object_get_info, object_get_info_single, object_get_info_vec, object_get_property,
10    object_set_property, ok, AsHandleRef, Handle, HandleBased, HandleRef, Job, Koid, MapInfo, Name,
11    ObjectQuery, Property, PropertyQuery, Rights, Status, Task, Thread, Topic, Vmar, VmoInfo,
12};
13use bitflags::bitflags;
14use std::mem::MaybeUninit;
15
16bitflags! {
17    /// Options that may be used when creating a `Process`.
18    #[repr(transparent)]
19    #[derive(Clone, Copy, Debug, PartialEq, Eq, PartialOrd, Ord, Hash)]
20    pub struct ProcessOptions: u32 {
21        const SHARED = sys::ZX_PROCESS_SHARED;
22    }
23}
24
25impl Default for ProcessOptions {
26    fn default() -> Self {
27        ProcessOptions::empty()
28    }
29}
30
31bitflags! {
32    #[repr(transparent)]
33    #[derive(Clone, Copy, Debug, PartialEq, Eq, PartialOrd, Ord, Hash)]
34    pub struct ProcessInfoFlags: u32 {
35        const STARTED = sys::ZX_INFO_PROCESS_FLAG_STARTED;
36        const EXITED = sys::ZX_INFO_PROCESS_FLAG_EXITED;
37        const DEBUGGER_ATTACHED = sys::ZX_INFO_PROCESS_FLAG_DEBUGGER_ATTACHED;
38    }
39}
40
41/// An object representing a Zircon process.
42///
43/// As essentially a subtype of `Handle`, it can be freely interconverted.
44#[derive(Debug, Eq, PartialEq, Ord, PartialOrd, Hash)]
45#[repr(transparent)]
46pub struct Process(Handle);
47impl_handle_based!(Process);
48unsafe_handle_properties!(object: Process,
49    props: [
50        {query_ty: PROCESS_DEBUG_ADDR, tag: ProcessDebugAddrTag, prop_ty: u64, get:get_debug_addr, set:set_debug_addr},
51        {query_ty: PROCESS_BREAK_ON_LOAD, tag: ProcessBreakOnLoadTag, prop_ty: u64, get:get_break_on_load, set:set_break_on_load},
52    ]
53);
54
55sys::zx_info_process_t!(ProcessInfo);
56
57impl From<sys::zx_info_process_t> for ProcessInfo {
58    fn from(info: sys::zx_info_process_t) -> ProcessInfo {
59        let sys::zx_info_process_t { return_code, start_time, flags } = info;
60        ProcessInfo { return_code, start_time, flags }
61    }
62}
63
64// ProcessInfo is able to be safely replaced with a byte representation and is a PoD type.
65unsafe impl ObjectQuery for ProcessInfo {
66    const TOPIC: Topic = Topic::PROCESS;
67    type InfoTy = ProcessInfo;
68}
69
70struct ProcessThreadsInfo;
71
72// ProcessThreadsInfo is able to be safely replaced with a byte representation and is a PoD type.
73unsafe impl ObjectQuery for ProcessThreadsInfo {
74    const TOPIC: Topic = Topic::PROCESS_THREADS;
75    type InfoTy = Koid;
76}
77
78sys::zx_info_task_stats_t!(TaskStatsInfo);
79
80impl From<sys::zx_info_task_stats_t> for TaskStatsInfo {
81    fn from(
82        sys::zx_info_task_stats_t {
83            mem_mapped_bytes,
84            mem_private_bytes,
85            mem_shared_bytes,
86            mem_scaled_shared_bytes,
87            mem_fractional_scaled_shared_bytes,
88        }: sys::zx_info_task_stats_t,
89    ) -> TaskStatsInfo {
90        TaskStatsInfo {
91            mem_mapped_bytes,
92            mem_private_bytes,
93            mem_shared_bytes,
94            mem_scaled_shared_bytes,
95            mem_fractional_scaled_shared_bytes,
96        }
97    }
98}
99
100// TaskStatsInfo is able to be safely replaced with a byte representation and is a PoD type.
101unsafe impl ObjectQuery for TaskStatsInfo {
102    const TOPIC: Topic = Topic::TASK_STATS;
103    type InfoTy = TaskStatsInfo;
104}
105
106struct ProcessMapsInfo;
107unsafe impl ObjectQuery for ProcessMapsInfo {
108    const TOPIC: Topic = Topic::PROCESS_MAPS;
109    type InfoTy = MapInfo;
110}
111
112struct ProcessVmoInfo;
113unsafe impl ObjectQuery for ProcessVmoInfo {
114    const TOPIC: Topic = Topic::PROCESS_VMOS;
115    type InfoTy = VmoInfo;
116}
117
118sys::zx_info_process_handle_stats_t!(ProcessHandleStats);
119
120impl Default for ProcessHandleStats {
121    fn default() -> Self {
122        Self { handle_count: [0; ZX_OBJ_TYPE_UPPER_BOUND] }
123    }
124}
125
126unsafe impl ObjectQuery for ProcessHandleStats {
127    const TOPIC: Topic = Topic::PROCESS_HANDLE_STATS;
128    type InfoTy = ProcessHandleStats;
129}
130
131impl Process {
132    /// Create a new process and its address space.
133    ///
134    /// Wraps the
135    /// [zx_process_create](https://fuchsia.dev/fuchsia-src/reference/syscalls/process_create.md)
136    /// syscall.
137    pub fn create(job: &Job, name: Name, options: ProcessOptions) -> Result<(Self, Vmar), Status> {
138        let mut this = 0;
139        let mut vmar = 0;
140
141        // SAFETY: `job` is a valid handle, `name` is valid to read from for `name.len()` bytes, and
142        // `this` and `vmar` are valid to write to.
143        ok(unsafe {
144            crate::sys::zx_process_create(
145                job.raw_handle(),
146                name.as_raw(),
147                name.len(),
148                options.bits(),
149                &mut this,
150                &mut vmar,
151            )
152        })?;
153
154        // SAFETY: the above call succeeded so `this` is a valid handle.
155        let this = Self(unsafe { Handle::from_raw(this) });
156
157        // SAFETY: the above call succeeded so `vmar` is a valid handle.
158        let vmar = Vmar::from(unsafe { Handle::from_raw(vmar) });
159
160        Ok((this, vmar))
161    }
162
163    /// Similar to `Thread::start`, but is used to start the first thread in a process.
164    ///
165    /// Wraps the
166    /// [zx_process_start](https://fuchsia.dev/fuchsia-src/reference/syscalls/process_start.md)
167    /// syscall.
168    pub fn start(
169        &self,
170        thread: &Thread,
171        entry: usize,
172        stack: usize,
173        arg1: Handle,
174        arg2: usize,
175    ) -> Result<(), Status> {
176        let process_raw = self.raw_handle();
177        let thread_raw = thread.raw_handle();
178        let arg1 = arg1.into_raw();
179        ok(unsafe { sys::zx_process_start(process_raw, thread_raw, entry, stack, arg1, arg2) })
180    }
181
182    /// Create a thread inside a process.
183    ///
184    /// Wraps the
185    /// [zx_thread_create](https://fuchsia.dev/fuchsia-src/reference/syscalls/thread_create.md)
186    /// syscall.
187    pub fn create_thread(&self, name: &[u8]) -> Result<Thread, Status> {
188        let process_raw = self.raw_handle();
189        let name_ptr = name.as_ptr();
190        let name_len = name.len();
191        let options = 0;
192        let mut thread_out = 0;
193        let status = unsafe {
194            sys::zx_thread_create(process_raw, name_ptr, name_len, options, &mut thread_out)
195        };
196        ok(status)?;
197        unsafe { Ok(Thread::from(Handle::from_raw(thread_out))) }
198    }
199
200    /// Write memory inside a process.
201    ///
202    /// Wraps the
203    /// [zx_process_write_memory](https://fuchsia.dev/fuchsia-src/reference/syscalls/process_write_memory.md)
204    /// syscall.
205    pub fn write_memory(&self, vaddr: sys::zx_vaddr_t, bytes: &[u8]) -> Result<usize, Status> {
206        let mut actual = 0;
207        let status = unsafe {
208            sys::zx_process_write_memory(
209                self.raw_handle(),
210                vaddr,
211                bytes.as_ptr(),
212                bytes.len(),
213                &mut actual,
214            )
215        };
216        ok(status).map(|()| actual)
217    }
218
219    /// Read memory from inside a process.
220    ///
221    /// Wraps the
222    /// [zx_process_read_memory](https://fuchsia.dev/fuchsia-src/reference/syscalls/process_read_memory.md)
223    /// syscall.
224    pub fn read_memory(&self, vaddr: sys::zx_vaddr_t, bytes: &mut [u8]) -> Result<usize, Status> {
225        // SAFETY: It's OK to interpret &mut [u8] as &mut [MaybeUninit<u8>] as long as we don't
226        // expose the MaybeUninit reference to code that would write uninitialized values to
227        // elements of the slice. Every valid state for a u8 is also a valid state for
228        // MaybeUninit<u8>, although the reverse is not true.
229        let (actually_read, _) = self.read_memory_uninit(vaddr, unsafe {
230            std::slice::from_raw_parts_mut(
231                bytes.as_mut_ptr().cast::<MaybeUninit<u8>>(),
232                bytes.len(),
233            )
234        })?;
235        Ok(actually_read.len())
236    }
237
238    /// Read memory from inside a process without requiring the output buffer to be initialized.
239    ///
240    /// Wraps the
241    /// [zx_process_read_memory](https://fuchsia.dev/fuchsia-src/reference/syscalls/process_read_memory.md)
242    /// syscall.
243    pub fn read_memory_uninit<'a>(
244        &self,
245        vaddr: sys::zx_vaddr_t,
246        buffer: &'a mut [MaybeUninit<u8>],
247    ) -> Result<(&'a mut [u8], &'a mut [MaybeUninit<u8>]), Status> {
248        let mut actually_read = 0;
249        // SAFETY: This is a system call that requires the pointers passed are valid to write to.
250        // We get the pointers from a valid mutable slice so we know it's safe to ask the kernel to
251        // write to them. Casting the *mut MaybeUninit<u8> to a *mut u8 is safe because all valid
252        // values for u8 are a subset of the valid values for MaybeUninit<u8> and we know the
253        // kernel won't write uninitialized values to the slice.
254        let status = unsafe {
255            sys::zx_process_read_memory(
256                self.raw_handle(),
257                vaddr,
258                // TODO(https://fxbug.dev/42079723) use MaybeUninit::slice_as_mut_ptr when stable
259                buffer.as_mut_ptr().cast::<u8>(),
260                buffer.len(),
261                &mut actually_read,
262            )
263        };
264        ok(status)?;
265        let (initialized, uninitialized) = buffer.split_at_mut(actually_read);
266        Ok((
267            // TODO(https://fxbug.dev/42079723) use MaybeUninit::slice_assume_init_mut when stable
268            // SAFETY: We're converting &mut [MaybeUninit<u8>] back to &mut [u8], which is only
269            // valid to do if all elements of `initialized` have actually been initialized. Here we
270            // have to trust that the kernel didn't lie when it said it wrote to the entire buffer,
271            // but as long as that assumption is valid them it's safe to assume this slice is init.
272            unsafe {
273                std::slice::from_raw_parts_mut(
274                    initialized.as_mut_ptr().cast::<u8>(),
275                    initialized.len(),
276                )
277            },
278            uninitialized,
279        ))
280    }
281
282    /// Wraps the
283    /// [zx_object_get_info](https://fuchsia.dev/fuchsia-src/reference/syscalls/object_get_info.md)
284    /// syscall for the ZX_INFO_PROCESS topic.
285    pub fn info(&self) -> Result<ProcessInfo, Status> {
286        object_get_info_single::<ProcessInfo>(self.as_handle_ref())
287    }
288
289    /// Wraps the
290    /// [zx_object_get_info](https://fuchsia.dev/fuchsia-src/reference/syscalls/object_get_info.md)
291    /// syscall for the ZX_INFO_PROCESS_THREADS topic.
292    pub fn threads(&self) -> Result<Vec<Koid>, Status> {
293        object_get_info_vec::<ProcessThreadsInfo>(self.as_handle_ref())
294    }
295
296    /// Wraps the
297    /// [zx_object_get_info](https://fuchsia.dev/fuchsia-src/reference/syscalls/object_get_info.md)
298    /// syscall for the ZX_INFO_TASK_STATS topic.
299    pub fn task_stats(&self) -> Result<TaskStatsInfo, Status> {
300        object_get_info_single::<TaskStatsInfo>(self.as_handle_ref())
301    }
302
303    /// Wraps the
304    /// [zx_object_get_info](https://fuchsia.dev/fuchsia-src/reference/syscalls/object_get_info.md)
305    /// syscall for the ZX_INFO_PROCESS_MAPS topic.
306    pub fn info_maps_vec(&self) -> Result<Vec<MapInfo>, Status> {
307        object_get_info_vec::<ProcessMapsInfo>(self.as_handle_ref())
308    }
309
310    /// Exit the current process with the given return code.
311    ///
312    /// Wraps the
313    /// [zx_process_exit](https://fuchsia.dev/fuchsia-src/reference/syscalls/process_exit.md)
314    /// syscall.
315    pub fn exit(retcode: i64) -> ! {
316        unsafe {
317            sys::zx_process_exit(retcode);
318            // zither generates the syscall returning a unit value. We know it will not proceed
319            // past this point however.
320            std::hint::unreachable_unchecked()
321        }
322    }
323
324    /// Wraps the
325    /// [zx_object_get_info](https://fuchsia.dev/fuchsia-src/reference/syscalls/object_get_info.md)
326    /// syscall for the ZX_INFO_PROCESS_HANDLE_STATS topic.
327    pub fn handle_stats(&self) -> Result<ProcessHandleStats, Status> {
328        object_get_info_single::<ProcessHandleStats>(self.as_handle_ref())
329    }
330
331    /// Wraps the
332    /// [zx_object_get_child](https://fuchsia.dev/fuchsia-src/reference/syscalls/object_get_child.md)
333    /// syscall.
334    pub fn get_child(&self, koid: &Koid, rights: Rights) -> Result<Thread, Status> {
335        let mut handle: zx_handle_t = Default::default();
336        let status = unsafe {
337            sys::zx_object_get_child(self.raw_handle(), koid.raw_koid(), rights.bits(), &mut handle)
338        };
339        ok(status)?;
340        Ok(Thread::from(unsafe { Handle::from_raw(handle) }))
341    }
342
343    /// Wraps the
344    /// [zx_object_get_info](https://fuchsia.dev/fuchsia-src/reference/syscalls/object_get_info.md)
345    /// syscall for the ZX_INFO_PROCESS_VMO topic.
346    pub fn info_vmos_vec(&self) -> Result<Vec<VmoInfo>, Status> {
347        let raw_info = object_get_info_vec::<ProcessVmoInfo>(self.as_handle_ref())?;
348        Ok(raw_info)
349    }
350
351    /// Wraps the
352    /// [zx_object_get_info](https://fuchsia.dev/fuchsia-src/reference/syscalls/object_get_info.md)
353    /// syscall for the ZX_INFO_PROCESS_MAPS topic. Contrarily to [Process::info_vmos_vec], this
354    /// method ensures that no intermediate copy of the data is made, at the price of a less
355    /// convenient interface.
356    pub fn info_maps<'a>(
357        &self,
358        info_out: &'a mut [std::mem::MaybeUninit<MapInfo>],
359    ) -> Result<(&'a mut [MapInfo], &'a mut [std::mem::MaybeUninit<MapInfo>], usize), Status> {
360        object_get_info::<ProcessMapsInfo>(self.as_handle_ref(), info_out)
361    }
362
363    /// Wraps the
364    /// [zx_object_get_info](https://fuchsia.dev/fuchsia-src/reference/syscalls/object_get_info.md)
365    /// syscall for the ZX_INFO_PROCESS_VMO topic. Contrarily to [Process::info_vmos_vec], this
366    /// method ensures that no intermediate copy of the data is made, at the price of a less
367    /// convenient interface.
368    pub fn info_vmos<'a>(
369        &self,
370        info_out: &'a mut [std::mem::MaybeUninit<VmoInfo>],
371    ) -> Result<(&'a mut [VmoInfo], &'a mut [std::mem::MaybeUninit<VmoInfo>], usize), Status> {
372        object_get_info::<ProcessVmoInfo>(self.as_handle_ref(), info_out)
373    }
374}
375
376impl Task for Process {}
377
378#[cfg(test)]
379mod tests {
380    use crate::cprng_draw;
381    // The unit tests are built with a different crate name, but fdio and fuchsia_runtime return a
382    // "real" zx::Process that we need to use.
383    use assert_matches::assert_matches;
384    use std::ffi::CString;
385    use std::mem::MaybeUninit;
386    use zx::{
387        sys, system_get_page_size, AsHandleRef, Instant, MapDetails, ProcessInfo, ProcessInfoFlags,
388        Signals, Task, TaskStatsInfo, VmarFlags, Vmo,
389    };
390
391    #[test]
392    fn info_self() {
393        let process = fuchsia_runtime::process_self();
394        let info = process.info().unwrap();
395        const STARTED: u32 = ProcessInfoFlags::STARTED.bits();
396        assert_matches!(
397            info,
398            ProcessInfo {
399                return_code: 0,
400                start_time,
401                flags: STARTED,
402            } if start_time > 0
403        );
404    }
405
406    #[test]
407    fn stats_self() {
408        let process = fuchsia_runtime::process_self();
409        let task_stats = process.task_stats().unwrap();
410
411        // Values greater than zero should be reported back for all memory usage
412        // types.
413        assert!(matches!(task_stats,
414            TaskStatsInfo {
415                mem_mapped_bytes,
416                mem_private_bytes,
417                mem_shared_bytes,
418                mem_scaled_shared_bytes,
419                mem_fractional_scaled_shared_bytes: _
420            }
421            if mem_mapped_bytes > 0
422                && mem_private_bytes > 0
423                && mem_shared_bytes > 0
424                && mem_scaled_shared_bytes > 0));
425    }
426
427    #[test]
428    fn exit_and_info() {
429        let mut randbuf = [0; 8];
430        cprng_draw(&mut randbuf);
431        let expected_code = i64::from_le_bytes(randbuf);
432        let arg = CString::new(format!("{}", expected_code)).unwrap();
433
434        // This test utility will exercise zx::Process::exit, using the provided argument as the
435        // return code.
436        let binpath = CString::new("/pkg/bin/exit_with_code_util").unwrap();
437        let process = fdio::spawn(
438            &fuchsia_runtime::job_default(),
439            fdio::SpawnOptions::DEFAULT_LOADER,
440            &binpath,
441            &[&arg],
442        )
443        .expect("Failed to spawn process");
444
445        process
446            .wait_handle(Signals::PROCESS_TERMINATED, Instant::INFINITE)
447            .expect("Wait for process termination failed");
448        let info = process.info().unwrap();
449        const STARTED_AND_EXITED: u32 =
450            ProcessInfoFlags::STARTED.bits() | ProcessInfoFlags::EXITED.bits();
451        assert_matches!(
452            info,
453            ProcessInfo {
454                return_code,
455                start_time,
456                flags: STARTED_AND_EXITED,
457            } if return_code == expected_code && start_time > 0
458        );
459    }
460
461    #[test]
462    fn kill_and_info() {
463        // This test utility will sleep "forever" without exiting, so that we can kill it..
464        let binpath = CString::new("/pkg/bin/sleep_forever_util").unwrap();
465        let process = fdio::spawn(
466            &fuchsia_runtime::job_default(),
467            // Careful not to clone stdio here, or the test runner can hang.
468            fdio::SpawnOptions::DEFAULT_LOADER,
469            &binpath,
470            &[&binpath],
471        )
472        .expect("Failed to spawn process");
473
474        let info = process.info().unwrap();
475        const STARTED: u32 = ProcessInfoFlags::STARTED.bits();
476        assert_matches!(
477            info,
478            ProcessInfo {
479                return_code: 0,
480                start_time,
481                flags: STARTED,
482             } if start_time > 0
483        );
484
485        process.kill().expect("Failed to kill process");
486        process
487            .wait_handle(Signals::PROCESS_TERMINATED, Instant::INFINITE)
488            .expect("Wait for process termination failed");
489
490        let info = process.info().unwrap();
491        const STARTED_AND_EXITED: u32 =
492            ProcessInfoFlags::STARTED.bits() | ProcessInfoFlags::EXITED.bits();
493        assert_matches!(
494            info,
495            ProcessInfo {
496                return_code: sys::ZX_TASK_RETCODE_SYSCALL_KILL,
497                start_time,
498                flags: STARTED_AND_EXITED,
499            } if start_time > 0
500        );
501    }
502
503    #[test]
504    fn maps_info() {
505        let root_vmar = fuchsia_runtime::vmar_root_self();
506        let process = fuchsia_runtime::process_self();
507
508        // Create two mappings so we know what to expect from our test calls.
509        let vmo = Vmo::create(system_get_page_size() as u64).unwrap();
510        let vmo_koid = vmo.get_koid().unwrap();
511
512        let map1 = root_vmar
513            .map(0, &vmo, 0, system_get_page_size() as usize, VmarFlags::PERM_READ)
514            .unwrap();
515        let map2 = root_vmar
516            .map(0, &vmo, 0, system_get_page_size() as usize, VmarFlags::PERM_READ)
517            .unwrap();
518
519        // Querying a single info. As we know there are at least two mappings this is guaranteed to
520        // not return all of them.
521        let mut data = vec![MaybeUninit::uninit(); 1];
522        let (returned, _, available) = process.info_maps(&mut data).unwrap();
523        assert_eq!(returned.len(), 1);
524        assert!(available > 0);
525
526        // Add some slack to the total to account for mappings created as a result of the heap
527        // allocation in Vec.
528        let total = available + 10;
529
530        // Allocate and retrieve all of the mappings.
531        let mut data = vec![MaybeUninit::uninit(); total];
532
533        let (info, _, available) = process.info_maps(&mut data).unwrap();
534
535        // Ensure we fail if some mappings are missing.
536        assert_eq!(info.len(), available);
537
538        // We should find our two mappings in the info.
539        let count = info
540            .iter()
541            .filter(|info| match info.details() {
542                MapDetails::Mapping(d) => d.vmo_koid == vmo_koid,
543                _ => false,
544            })
545            .count();
546        assert_eq!(count, 2);
547
548        // We created these mappings and are not letting any references to them escape so unmapping
549        // is safe to do.
550        unsafe {
551            root_vmar.unmap(map1, system_get_page_size() as usize).unwrap();
552            root_vmar.unmap(map2, system_get_page_size() as usize).unwrap();
553        }
554    }
555
556    #[test]
557    fn info_maps_vec() {
558        let root_vmar = fuchsia_runtime::vmar_root_self();
559        let process = fuchsia_runtime::process_self();
560
561        // Create two mappings so we know what to expect from our test calls.
562        let vmo = Vmo::create(system_get_page_size() as u64).unwrap();
563        let vmo_koid = vmo.get_koid().unwrap();
564
565        let map1 = root_vmar
566            .map(0, &vmo, 0, system_get_page_size() as usize, VmarFlags::PERM_READ)
567            .unwrap();
568        let map2 = root_vmar
569            .map(0, &vmo, 0, system_get_page_size() as usize, VmarFlags::PERM_READ)
570            .unwrap();
571
572        let info = process.info_maps_vec().unwrap();
573
574        // We should find our two mappings in the info.
575        let count = info
576            .iter()
577            .filter(|info| match info.details() {
578                MapDetails::Mapping(d) => d.vmo_koid == vmo_koid,
579                _ => false,
580            })
581            .count();
582        assert_eq!(count, 2);
583
584        // We created these mappings and are not letting any references to them escape so unmapping
585        // is safe to do.
586        unsafe {
587            root_vmar.unmap(map1, system_get_page_size() as usize).unwrap();
588            root_vmar.unmap(map2, system_get_page_size() as usize).unwrap();
589        }
590    }
591
592    #[test]
593    fn info_vmos() {
594        let process = fuchsia_runtime::process_self();
595
596        // Create two mappings so we know what to expect from our test calls.
597        let vmo = Vmo::create(system_get_page_size() as u64).unwrap();
598        let vmo_koid = vmo.get_koid().unwrap();
599
600        let mut data = vec![MaybeUninit::uninit(); 2048];
601        let (info, _, available) = process.info_vmos(&mut data).unwrap();
602
603        // Ensure we fail if some vmos are missing, so we can adjust the buffer size.
604        assert_eq!(info.len(), available);
605
606        // We should find our two mappings in the info.
607        let count = info.iter().filter(|map| map.koid == vmo_koid).count();
608        assert_eq!(count, 1);
609    }
610
611    #[test]
612    fn info_vmos_vec() {
613        let process = fuchsia_runtime::process_self();
614
615        // Create two mappings so we know what to expect from our test calls.
616        let vmo = Vmo::create(system_get_page_size() as u64).unwrap();
617        let vmo_koid = vmo.get_koid().unwrap();
618
619        let info = process.info_vmos_vec().unwrap();
620
621        // We should find our two mappings in the info.
622        let count = info.iter().filter(|map| map.koid == vmo_koid).count();
623        assert_eq!(count, 1);
624    }
625
626    #[test]
627    fn handle_stats() {
628        let process = fuchsia_runtime::process_self();
629        let handle_stats = process.handle_stats().unwrap();
630
631        // We don't have an opinion about how many handles a typical process has, or what types
632        // they will be (the function returns counts for up to 64 different types),
633        // but a reasonable total should be between 1 and a million.
634        let sum: u32 = handle_stats.handle_count.iter().sum();
635
636        assert!(sum > 0);
637        assert!(sum < 1_000_000);
638    }
639
640    #[test]
641    fn threads_contain_self() {
642        let current_thread_koid = fuchsia_runtime::thread_self().get_koid().unwrap();
643        let threads_koids = fuchsia_runtime::process_self().threads().unwrap();
644        assert!(threads_koids.contains(&current_thread_koid));
645        let thread_handle = fuchsia_runtime::process_self()
646            .get_child(&current_thread_koid, zx::Rights::NONE)
647            .unwrap();
648        assert_eq!(thread_handle.get_koid().unwrap(), current_thread_koid);
649    }
650
651    // The vdso_next tests don't have permission to create raw processes.
652    #[cfg(not(feature = "vdso_next"))]
653    #[test]
654    fn new_process_no_threads() {
655        let job = fuchsia_runtime::job_default().create_child_job().unwrap();
656        let (process, _) =
657            job.create_child_process(zx::ProcessOptions::empty(), b"test-process").unwrap();
658        assert!(process.threads().unwrap().is_empty());
659    }
660
661    // The vdso_next tests don't have permission to create raw processes.
662    #[cfg(not(feature = "vdso_next"))]
663    #[test]
664    fn non_started_threads_dont_show_up() {
665        let job = fuchsia_runtime::job_default().create_child_job().unwrap();
666        let (process, _) =
667            job.create_child_process(zx::ProcessOptions::empty(), b"test-process").unwrap();
668
669        let thread = process.create_thread(b"test-thread").unwrap();
670        let thread_koid = thread.get_koid().unwrap();
671
672        assert!(process.threads().unwrap().is_empty());
673        assert!(process.get_child(&thread_koid, zx::Rights::NONE).is_err());
674    }
675
676    // The vdso_next tests don't have permission to create raw processes.
677    #[cfg(not(feature = "vdso_next"))]
678    #[test]
679    fn started_threads_show_up() {
680        let job = fuchsia_runtime::job_default().create_child_job().unwrap();
681        let (process, root_vmar) =
682            job.create_child_process(zx::ProcessOptions::empty(), b"test-process").unwrap();
683
684        let valid_addr = root_vmar.info().unwrap().base;
685
686        let thread1 = process.create_thread(b"test-thread-1").unwrap();
687        let thread2 = process.create_thread(b"test-thread-2").unwrap();
688
689        // start with the thread suspended, so we don't care about executing invalid code.
690        let thread1_suspended = thread1.suspend().unwrap();
691        process.start(&thread1, valid_addr, valid_addr, zx::Handle::invalid(), 0).unwrap();
692
693        let threads_koids = process.threads().unwrap();
694        assert_eq!(threads_koids.len(), 1);
695        assert_eq!(threads_koids[0], thread1.get_koid().unwrap());
696        assert_eq!(
697            process.get_child(&threads_koids[0], zx::Rights::NONE).unwrap().get_koid().unwrap(),
698            threads_koids[0]
699        );
700
701        // Add another thread.
702        let thread2_suspended = thread2.suspend().unwrap();
703        thread2.start(valid_addr, valid_addr, 0, 0).unwrap();
704
705        let threads_koids = process.threads().unwrap();
706        assert_eq!(threads_koids.len(), 2);
707        assert!(threads_koids.contains(&thread1.get_koid().unwrap()));
708        assert!(threads_koids.contains(&thread2.get_koid().unwrap()));
709        assert_eq!(
710            process.get_child(&threads_koids[0], zx::Rights::NONE).unwrap().get_koid().unwrap(),
711            threads_koids[0]
712        );
713        assert_eq!(
714            process.get_child(&threads_koids[1], zx::Rights::NONE).unwrap().get_koid().unwrap(),
715            threads_koids[1]
716        );
717
718        process.kill().unwrap();
719        process.wait_handle(Signals::TASK_TERMINATED, Instant::INFINITE).unwrap();
720
721        drop(thread1_suspended);
722        drop(thread2_suspended);
723
724        assert!(process.threads().unwrap().is_empty());
725    }
726}
zx/process.rs

zx/
process.rs
