executorch-sys 0.1.0-rc.1

Unsafe Rust bindings for ExecuTorch - On-device AI across mobile, embedded and edge for PyTorch
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
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234

use std::collections::HashMap;
use std::path::{Path, PathBuf};
use std::process::{Command, Stdio};

const EXECUTORCH_VERSION: &str = "0.2.1";

fn main() {
    // TODO: verify on runtime we use the correct version of executorch
    println!(
        "cargo:rustc-env=EXECUTORCH_RS_EXECUTORCH_VERSION={}",
        EXECUTORCH_VERSION
    );

    let dev_executorch = Path::new(&env!("CARGO_MANIFEST_DIR"))
        .join("cpp")
        .join("executorch");
    let executorch_headers = if dev_executorch.exists() {
        dev_executorch
    } else {
        download_executorch()
    };
    build_c_extension(&executorch_headers);
    generate_bindings(&executorch_headers);
    link_executorch();
}

fn download_executorch() -> PathBuf {
    let cpp_dir = PathBuf::from(std::env::var("OUT_DIR").unwrap()).join("cpp");
    let executorch_dir = cpp_dir.join("executorch");
    if !executorch_dir.exists() {
        std::fs::create_dir_all(&cpp_dir).unwrap();
        exe_cmd(
            &[
                "git",
                "clone",
                "--depth",
                "1",
                "--branch",
                format!("v{}", EXECUTORCH_VERSION).as_str(),
                "https://github.com/pytorch/executorch.git",
            ],
            &cpp_dir,
            "Failed to clone executorch",
        );
    }
    executorch_dir
}

fn build_c_extension(executorch_headers: &Path) {
    let c_ext_dir = cpp_ext_dir();
    let mut builder = cc::Build::new();
    builder
        .cpp(true)
        .std("c++17")
        .files([c_ext_dir.join("api_utils.cpp")])
        .include(c_ext_dir.parent().unwrap())
        .include(executorch_headers.parent().unwrap());
    for define in cpp_defines() {
        builder.define(define, None);
    }
    builder.compile("executorch_rs_ext");

    println!("cargo::rerun-if-changed={}", c_ext_dir.to_str().unwrap());
}

fn generate_bindings(executorch_headers: &Path) {
    let c_ext_dir = cpp_ext_dir();

    let bindings_h = Path::new(&env!("CARGO_MANIFEST_DIR"))
        .join("cpp")
        .join("bindings.hpp");
    let bindings_defines_h = c_ext_dir.parent().unwrap().join("executorch_rs_defines.h");
    let mut bindings_defines = String::new();
    for define in cpp_defines() {
        bindings_defines.push_str(&format!("#define {}\n", define));
    }

    println!("cargo::rerun-if-changed={}", bindings_h.to_str().unwrap());
    let bindings = bindgen::Builder::default()
        .clang_arg(format!(
            "-I{}",
            executorch_headers.parent().unwrap().to_str().unwrap()
        ))
        .clang_arg(format!(
            "-I{}",
            c_ext_dir.parent().unwrap().to_str().unwrap()
        ))
        .clang_arg("-std=c++17")
        .enable_cxx_namespaces()
        .emit_builtins()
        .enable_function_attribute_detection()
        .generate_cstr(true)
        .header_contents(bindings_defines_h.to_str().unwrap(), &bindings_defines)
        .header(bindings_h.as_os_str().to_str().unwrap())
        .allowlist_file(format!(
            "{}/[a-zA-Z0-9_/]+.hpp",
            c_ext_dir.to_str().unwrap(),
        ))
        .allowlist_item("et_pal_init")
        .allowlist_item("torch::executor::Result")
        .allowlist_item("torch::executor::EValue")
        .allowlist_item("torch::executor::Program")
        .allowlist_item("torch::executor::DataLoader")
        .allowlist_item("torch::executor::MemoryManager")
        .allowlist_item("torch::executor::MethodMeta")
        .allowlist_item("torch::executor::util::MallocMemoryAllocator")
        // feature data-loader
        .allowlist_item("torch::executor::util::FileDataLoader")
        .allowlist_item("torch::executor::util::MmapDataLoader")
        .allowlist_item("torch::executor::util::BufferDataLoader")
        // feature module
        .allowlist_item("torch::executor::Module")
        .blocklist_item("std::.*")
        .blocklist_item("torch::executor::Method_StepState")
        .blocklist_item("torch::executor::Method_InitializationState")
        .blocklist_item("torch::executor::Program_kMinHeadBytes")
        .blocklist_item("torch::executor::EventTracerEntry")
        // feature module
        .blocklist_item("torch::executor::Module_MethodHolder")
        .blocklist_item("torch::executor::Module_load_method")
        .blocklist_item("torch::executor::Module_is_method_loaded")
        .blocklist_item("torch::executor::Module_method_meta")
        .blocklist_item("torch::executor::Module_execute")
        .blocklist_item("torch::executor::Module_Module")
        .opaque_type("std::.*")
        .opaque_type("torch::executor::Program")
        .opaque_type("torch::executor::EventTracer")
        .opaque_type("torch::executor::FreeableBuffer")
        .opaque_type("torch::executor::Method")
        .opaque_type("torch::executor::MethodMeta")
        .opaque_type("torch::executor::TensorImpl")
        .opaque_type("torch::executor::DataLoader")
        .opaque_type("torch::executor::util::MallocMemoryAllocator")
        .opaque_type("torch::executor::Half")
        .opaque_type("torch::executor::MemoryAllocator")
        .opaque_type("torch::executor::HierarchicalAllocator")
        .opaque_type("torch::executor::TensorInfo")
        // feature data-loader
        .opaque_type("torch::executor::util::FileDataLoader")
        .opaque_type("torch::executor::util::MmapDataLoader")
        .opaque_type("torch::executor::util::BufferDataLoader")
        // feature module
        .opaque_type("torch::executor::Module")
        .rustified_enum("torch::executor::Error")
        .rustified_enum("torch::executor::ScalarType")
        .rustified_enum("torch::executor::Tag")
        .rustified_enum("torch::executor::Program_Verification")
        .rustified_enum("torch::executor::Program_HeaderStatus")
        .rustified_enum("torch::executor::TensorShapeDynamism")
        // feature data-loader
        .rustified_enum("torch::executor::util::MmapDataLoader_MlockConfig")
        // feature module
        .rustified_enum("torch::executor::Module_MlockConfig")
        .no_copy(".*") // TODO: specific some exact types, regex act weird
        .manually_drop_union(".*")
        .parse_callbacks(Box::new(bindgen::CargoCallbacks::new()))
        .generate()
        .expect("Unable to generate bindings");

    let out_path = PathBuf::from(std::env::var("OUT_DIR").unwrap());
    bindings
        .write_to_file(out_path.join("executorch_bindings.rs"))
        .expect("Couldn't write bindings!");
}

fn link_executorch() {
    if std::env::var("DOCS_RS").is_ok() {
        // Skip linking to the static library when building documentation
        return;
    }

    let libs_dir = std::env::var("EXECUTORCH_RS_EXECUTORCH_LIB_DIR")
        .expect("EXECUTORCH_RS_EXECUTORCH_LIB_DIR is not set, can't locate executorch static libs");
    let libs_dir = envsubst::substitute(
        libs_dir,
        &HashMap::from([(
            String::from("EXECUTORCH_RS_SYS_TOP"),
            PathBuf::from(env!("CARGO_MANIFEST_DIR"))
                .to_str()
                .unwrap()
                .to_string(),
        )]),
    )
    .unwrap();

    println!("cargo::rustc-link-lib=c++");

    println!("cargo::rustc-link-search={}", libs_dir);
    println!("cargo::rustc-link-lib=static=executorch");
    println!("cargo::rustc-link-lib=static=executorch_no_prim_ops");

    if cfg!(feature = "data-loader") {
        println!(
            "cargo::rustc-link-search={}/extension/data_loader/",
            libs_dir
        );
        println!("cargo::rustc-link-lib=static=extension_data_loader");
    }

    if cfg!(feature = "module") {
        println!("cargo::rustc-link-search={}/extension/module/", libs_dir);
        // TODO: extension_module or extension_module_static ?
        println!("cargo::rustc-link-lib=static=extension_module_static");
    }
}

fn cpp_ext_dir() -> PathBuf {
    Path::new(&env!("CARGO_MANIFEST_DIR"))
        .join("cpp")
        .join("executorch_rs_ext")
}

fn cpp_defines() -> Vec<&'static str> {
    let mut defines = vec![];
    if cfg!(feature = "data-loader") {
        defines.push("EXECUTORCH_RS_EXTENSION_DATA_LOADER");
    }
    if cfg!(feature = "module") {
        defines.push("EXECUTORCH_RS_EXTENSION_MODULE");
    }
    defines
}

#[track_caller]
fn exe_cmd(args: &[&str], current_dir: &Path, err_msg: &str) {
    let status = Command::new(args[0])
        .args(&args[1..])
        .current_dir(current_dir)
        .stderr(Stdio::inherit())
        .stdout(Stdio::inherit())
        .status()
        .expect(err_msg);
    assert!(status.success(), "{}", err_msg);
}