summaryrefslogtreecommitdiff
path: root/crates/windows-kernel-rs/src/user_ptr.rs
blob: 223cee6cc79422ec0d9919b3fffa9bf91a35aa87 (plain) (blame)
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
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
use crate::error::Error;

pub enum UserPtr {
  Buffered {
    ptr:        *mut cty::c_void,
    read_size:  usize,
    write_size: usize,
  },
  Direct {
    read_ptr:   *const cty::c_void,
    write_ptr:  *mut cty::c_void,
    read_size:  usize,
    write_size: usize,
  },
  Neither,
}

impl UserPtr {
  /// # Safety
  /// `unsafe`
  pub unsafe fn new_buffered(ptr: *mut cty::c_void, read_size: usize, write_size: usize) -> Self {
    Self::Buffered {
      ptr,
      read_size,
      write_size,
    }
  }

  /// # Safety
  /// `unsafe`
  pub unsafe fn new_direct(
    read_ptr: *const cty::c_void,
    write_ptr: *mut cty::c_void,
    read_size: usize,
    write_size: usize,
  ) -> Self {
    Self::Direct {
      read_ptr,
      write_ptr,
      read_size,
      write_size,
    }
  }

  /// # Safety
  /// `unsafe`
  pub unsafe fn new_neither() -> Self { Self::Neither }

  pub fn read_size(&self) -> usize {
    match self {
      Self::Buffered {
        read_size, ..
      } => *read_size,
      Self::Direct {
        read_size, ..
      } => *read_size,
      Self::Neither => 0,
    }
  }

  pub fn write_size(&self) -> usize {
    match self {
      Self::Buffered {
        write_size, ..
      } => *write_size,
      Self::Direct {
        write_size, ..
      } => *write_size,
      Self::Neither => 0,
    }
  }

  pub fn as_slice(&self) -> &[u8] {
    let (ptr, size) = match self {
      Self::Buffered {
        ptr,
        read_size,
        ..
      } => (*ptr as _, *read_size),
      Self::Direct {
        read_ptr,
        read_size,
        ..
      } => (*read_ptr, *read_size),
      Self::Neither => (core::ptr::null(), 0),
    };

    if ptr.is_null() || size == 0 {
      &[]
    } else {
      unsafe { core::slice::from_raw_parts(ptr as *const u8, size) }
    }
  }

  pub fn as_mut_slice(&mut self) -> &mut [u8] {
    let (ptr, size) = match self {
      Self::Buffered {
        ptr,
        write_size,
        ..
      } => (*ptr, *write_size),
      Self::Direct {
        write_ptr,
        write_size,
        ..
      } => (*write_ptr, *write_size),
      Self::Neither => (core::ptr::null_mut(), 0),
    };

    if ptr.is_null() || size == 0 {
      &mut []
    } else {
      unsafe { core::slice::from_raw_parts_mut(ptr as *mut u8, size) }
    }
  }

  pub fn read<T: Copy + Default>(&self) -> Result<T, Error> {
    let (ptr, size) = match self {
      Self::Buffered {
        ptr,
        read_size,
        ..
      } => (*ptr as _, *read_size),
      Self::Direct {
        read_ptr,
        read_size,
        ..
      } => (*read_ptr, *read_size),
      Self::Neither => (core::ptr::null(), 0),
    };

    if ptr.is_null() || size == 0 {
      return Err(Error::INVALID_PARAMETER);
    }

    if core::mem::size_of::<T>() > size {
      return Err(Error::INVALID_USER_BUFFER);
    }

    let mut obj = T::default();

    unsafe {
      core::ptr::copy_nonoverlapping(ptr as _, &mut obj, 1);
    }

    Ok(obj)
  }

  pub fn write<T: Copy>(&mut self, obj: &T) -> Result<(), Error> {
    let (ptr, size) = match self {
      Self::Buffered {
        ptr,
        write_size,
        ..
      } => (*ptr, *write_size),
      Self::Direct {
        write_ptr,
        write_size,
        ..
      } => (*write_ptr, *write_size),
      Self::Neither => (core::ptr::null_mut(), 0),
    };

    if ptr.is_null() || size == 0 {
      return Err(Error::INVALID_PARAMETER);
    }

    if core::mem::size_of::<T>() > size {
      return Err(Error::INVALID_USER_BUFFER);
    }

    unsafe {
      core::ptr::copy_nonoverlapping(obj, ptr as _, 1);
    }

    Ok(())
  }
}