novuskinc 0.1.0

Most of novuskinc from Novusk, used for making userspace applications
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

/// The module_init! macro is used for defining the start function of a kernel module
///
/// Example:
/// ```rust
/// fn my_module_start() {
///     printk!("My Module started!\n");
/// }
///
/// module_init!(my_module_init, my_module_start);
/// ```
///
#[macro_export]
macro_rules! module_init {
    ($km_name_init:ident, $km_name_start:ident) => {
        #[no_mangle]
        pub extern "C" fn $km_name_init() {
            $km_name_start();
        }
    };
}

/// The module_end! macro is used for defining the end function of a kernel module, this function
/// should be used to check if the init function was successful.
///
/// Example:
/// ```rust
/// fn my_module_finish() {
///     printk!("My module end!\n");
/// }
///
/// module_end!(my_module_end, my_module_finish)
/// ```
///
#[macro_export]
macro_rules! module_end {
   ($km_name_end:ident, $km_name_finish:ident) => {
        #[no_mangle]
        pub extern "C" fn $km_name_end() {
            $km_name_finish();
        }
    };
}

/// The start_module! macro is used for starting a kernel module, make sure your module is linked to
/// your project.
///
/// Example:
/// ```rust
/// start_module!(km_module_init, my_module_end);
///
#[macro_export]
macro_rules! start_module {
    ($($km_name_init:ident)*, $($km_name_end:ident)*) => {
        extern "C" {
            fn $($km_name_init)*();
            fn $($km_name_end)*();
        }

        $($km_name_init)*();
        $($km_name_end)*();
    };
}