firehazard 0.0.0-2022-09-10

Unopinionated low level API bindings focused on soundness, safety, and stronger types over raw FFI.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83

use crate::*;
use winapi::shared::ntdef;
use winapi::um::winnt::{self, JobObjectGroupInformation, JobObjectGroupInformationEx};



/// \[[docs.microsoft.com](https://docs.microsoft.com/en-us/windows/win32/api/jobapi2/nf-jobapi2-setinformationjobobject)\]
/// ~ WORD / USHORT referencing a processor group
///
/// get/set via `JobObjectGroupInformationEx`
#[derive(Clone, Copy, Default, Debug, PartialEq, Eq, PartialOrd, Ord, Hash)]
#[repr(transparent)] pub struct Group(u16);

/// \[[docs.microsoft.com](https://docs.microsoft.com/en-us/windows/win32/api/winnt/ns-winnt-group_affinity)\]
/// GROUP_AFFINITY referencing a processor group and processor/core mask
///
/// get/set via `JobObjectGroupInformationEx`
#[derive(Clone, Copy, Default, Debug, PartialEq, Eq, PartialOrd, Ord, Hash)]
#[repr(C)] pub struct GroupAffinity {
    pub mask:   usize,
    pub group:  u16,
    #[doc(hidden)] pub _reserved: [u16; 3],
}

structure!(@assert layout GroupAffinity => ntdef::GROUP_AFFINITY {
    mask        == Mask,
    group       == Group,
    _reserved   == Reserved,
});

structure!(@assert layout GroupAffinity => winnt::GROUP_AFFINITY {
    mask        == Mask,
    group       == Group,
    _reserved   == Reserved,
});

#[cfg(std)] impl job::QueryInformationJobObject for std::vec::Vec<Group>                   { fn query_from(job: &job::OwnedHandle) -> Result<Self, Error> { unsafe { job::query_vec(job, JobObjectGroupInformation  ) } } }
#[cfg(std)] impl job::QueryInformationJobObject for std::vec::Vec<GroupAffinity>           { fn query_from(job: &job::OwnedHandle) -> Result<Self, Error> { unsafe { job::query_vec(job, JobObjectGroupInformationEx) } } }
#[cfg(std)] impl job::QueryInformationJobObject for std::vec::Vec<ntdef::GROUP_AFFINITY>   { fn query_from(job: &job::OwnedHandle) -> Result<Self, Error> { unsafe { job::query_vec(job, JobObjectGroupInformationEx) } } }
#[cfg(std)] impl job::QueryInformationJobObject for std::vec::Vec<winnt::GROUP_AFFINITY>   { fn query_from(job: &job::OwnedHandle) -> Result<Self, Error> { unsafe { job::query_vec(job, JobObjectGroupInformationEx) } } }

//impl job::SetInformationJobObject for &'_ [u16]                      { fn set_on(self, job: &job::OwnedHandle) -> Result<(), Error> { unsafe { job::set(job, JobObjectGroupInformation, self) } } }
impl job::SetInformationJobObject for &'_ [Group]                    { fn set_on(self, job: &job::OwnedHandle) -> Result<(), Error> { unsafe { job::set(job, JobObjectGroupInformation, self) } } }
impl job::SetInformationJobObject for &'_ [GroupAffinity]            { fn set_on(self, job: &job::OwnedHandle) -> Result<(), Error> { unsafe { job::set(job, JobObjectGroupInformationEx, self) } } }
impl job::SetInformationJobObject for &'_ [ntdef::GROUP_AFFINITY]    { fn set_on(self, job: &job::OwnedHandle) -> Result<(), Error> { unsafe { job::set(job, JobObjectGroupInformationEx, self) } } }
impl job::SetInformationJobObject for &'_ [winnt::GROUP_AFFINITY]    { fn set_on(self, job: &job::OwnedHandle) -> Result<(), Error> { unsafe { job::set(job, JobObjectGroupInformationEx, self) } } }

#[test] fn group_invalid() {
    use winapi::shared::winerror::ERROR_INVALID_PARAMETER;

    let job = create_job_object_a(None, ()).unwrap();
    let err = set_information_job_object(&job, &[Group(0xFFFF)][..]).unwrap_err();
    assert_eq!(ERROR_INVALID_PARAMETER, err);
}

#[cfg(std)] #[test] fn group_0() {
    let job = create_job_object_a(None, ()).unwrap();
    set_information_job_object(&job, &[Group(0)][..]).unwrap();

    let groups : std::vec::Vec<Group> = query_information_job_object(&job).unwrap();
    assert_eq!(1, groups.len());
    assert_eq!(groups[0].0, 0);
}

#[cfg(std)] #[test] fn group_0_affinity() {
    let job = create_job_object_a(None, ()).unwrap();
    set_information_job_object(&job, &[GroupAffinity { group: 0, mask: 0b1, ..Default::default() }][..]).unwrap();

    let groups : std::vec::Vec<GroupAffinity> = query_information_job_object(&job).unwrap();
    assert_eq!(1, groups.len());
    assert!(groups[0].mask == 0b1);
}

#[cfg(std)] #[test] fn default_job_groups() {
    let job = create_job_object_a(None, ()).unwrap();

    let groups : std::vec::Vec<Group> = query_information_job_object(&job).unwrap();
    assert_eq!(0, groups.len());

    let groups : std::vec::Vec<GroupAffinity> = query_information_job_object(&job).unwrap();
    assert!(!groups.is_empty());
    assert!(groups[0].mask != 0);
}