memflow 0.2.4

core components of the memflow physical memory introspection framework
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
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

use std::mem::MaybeUninit;
use std::path::PathBuf;

use crate::cglue::result::into_int_out_result;
use crate::error::Error;

use super::{
    plugin_analyzer::{PluginArchitecture, PluginFileType},
    LibArc, PluginLogger,
};
use super::{ErrorKind, ErrorOrigin};

/// Returns the plugin extension appropriate for the current os
pub fn plugin_extension() -> &'static str {
    #[cfg(target_os = "windows")]
    return "dll";
    #[cfg(target_os = "linux")]
    return "so";
    #[cfg(target_os = "macos")]
    return "dylib";
}

/// Returns the plugin file_type appropriate for the current os
pub fn plugin_file_type() -> PluginFileType {
    #[cfg(target_os = "windows")]
    return PluginFileType::Pe;
    #[cfg(target_os = "linux")]
    return PluginFileType::Elf;
    #[cfg(target_os = "macos")]
    return PluginFileType::Mach;
}

/// Returns the plugin architecture appropriate for the current os
pub fn plugin_architecture() -> PluginArchitecture {
    #[cfg(target_arch = "x86_64")]
    return PluginArchitecture::X86_64;
    #[cfg(target_arch = "x86")]
    return PluginArchitecture::X86;
    #[cfg(target_arch = "aarch64")]
    return PluginArchitecture::Arm64;
    #[cfg(target_arch = "arm")]
    return PluginArchitecture::Arm;
}

/// Returns the path in which memflow plugins are stored.
///
/// On unix this is returns ~/.local/lib/memflow
/// On windows this returns C:\Users\[Username]\Documents\memflow
pub fn plugins_path() -> crate::error::Result<PathBuf> {
    let path = if cfg!(unix) {
        dirs::home_dir()
            .unwrap()
            .join(".local")
            .join("lib")
            .join("memflow")
    } else {
        dirs::document_dir().unwrap().join("memflow")
    };

    // ensure plugins path exists
    if !path.exists() {
        std::fs::create_dir_all(&path).map_err(|_| {
            Error(ErrorOrigin::Inventory, ErrorKind::UnableToCreateDirectory)
                .log_error("unable to create plugins directory")
        })?;
    }

    Ok(path)
}

/// Wrapper for instantiating object.
///
/// This function will initialize the [`PluginLogger`],
/// parse args into `Args`, and call the create_fn
///
/// This function is used by the connector proc macro
pub fn wrap<A: Default, T>(
    args: Option<&A>,
    lib: LibArc,
    logger: Option<&'static PluginLogger>,
    out: &mut MaybeUninit<T>,
    create_fn: impl FnOnce(&A, LibArc) -> Result<T, Error>,
) -> i32 {
    if let Some(logger) = logger {
        logger.init().ok();
    }

    let default: A = Default::default();
    let args = args.unwrap_or(&default);

    into_int_out_result(create_fn(args, lib), out)
}

/// Wrapper for instantiating object with all needed parameters
///
/// This function will initialize the [`PluginLogger`],
/// parse args into `Args` and call the create_fn with `input` forwarded.
///
/// This function is used by the connector proc macro
pub fn wrap_with_input<A: Default, T, I>(
    args: Option<&A>,
    input: I,
    lib: LibArc,
    logger: Option<&'static PluginLogger>,
    out: &mut MaybeUninit<T>,
    create_fn: impl FnOnce(&A, I, LibArc) -> Result<T, Error>,
) -> i32 {
    if let Some(logger) = logger {
        logger.init().ok();
    }

    let default: A = Default::default();
    let args = args.unwrap_or(&default);

    into_int_out_result(
        create_fn(args, input, lib).inspect_err(|e| {
            ::log::error!("{}", e);
        }),
        out,
    )
}