summaryrefslogtreecommitdiff
path: root/crates/windows-kernel-rs/examples/io_controls/src/lib.rs
blob: da572ca31a9923a04ee32da8b6b8d5d35dedee58 (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
#![no_std]
#![feature(lang_items, const_extern_fn)]
#![deny(
  warnings,
  nonstandard_style,
  unused,
  future_incompatible,
  rust_2018_idioms
)]
#![deny(clippy::all, clippy::nursery, clippy::pedantic)]

use windows_kernel_rs::{
  device::{
    Completion,
    Device,
    DeviceDoFlags,
    DeviceFlags,
    DeviceOperations,
    DeviceType,
    RequestError,
  },
  kernel_module,
  println,
  request::IoControlRequest,
  Access,
  Driver,
  Error,
  KernelModule,
  RequiredAccess,
  SymbolicLink,
};

struct MyDevice {
  value: u32,
}

const IOCTL_PRINT_VALUE: u32 = 0x800;
const IOCTL_READ_VALUE: u32 = 0x801;
const IOCTL_WRITE_VALUE: u32 = 0x802;

impl MyDevice {
  fn print_value(&mut self, _request: &IoControlRequest) -> Result<u32, Error> {
    println!("value: {}", self.value);

    Ok(0)
  }

  fn read_value(&mut self, request: &IoControlRequest) -> Result<u32, Error> {
    let mut user_ptr = request.user_ptr();

    user_ptr.write(&self.value)?;

    Ok(core::mem::size_of::<u32>() as u32)
  }

  fn write_value(&mut self, request: &IoControlRequest) -> Result<u32, Error> {
    let user_ptr = request.user_ptr();

    self.value = user_ptr.read()?;

    Ok(0)
  }
}

impl DeviceOperations for MyDevice {
  fn ioctl(
    &mut self,
    _device: &Device,
    request: IoControlRequest,
  ) -> Result<Completion, RequestError> {
    let result = match request.function() {
      (_, IOCTL_PRINT_VALUE) => self.print_value(&request),
      (RequiredAccess::READ_DATA, IOCTL_READ_VALUE) => self.read_value(&request),
      (RequiredAccess::WRITE_DATA, IOCTL_WRITE_VALUE) => self.write_value(&request),
      _ => Err(Error::INVALID_PARAMETER),
    };

    match result {
      Ok(size) => Ok(Completion::Complete(size, request.into())),
      Err(e) => Err(RequestError(e, request.into())),
    }
  }
}

struct Module {
  _device:        Device,
  _symbolic_link: SymbolicLink,
}

impl KernelModule for Module {
  fn init(mut driver: Driver, _: &str) -> Result<Self, Error> {
    let device = driver.create_device(
      "\\Device\\Example",
      DeviceType::Unknown,
      DeviceFlags::SECURE_OPEN,
      DeviceDoFlags::DO_BUFFERED_IO,
      Access::NonExclusive,
      MyDevice {
        value: 0
      },
    )?;
    let symbolic_link = SymbolicLink::new("\\??\\Example", "\\Device\\Example")?;

    Ok(Module {
      _device:        device,
      _symbolic_link: symbolic_link,
    })
  }

  fn cleanup(&mut self, _driver: Driver) {}
}

kernel_module!(Module);