onnxruntime-ep-mlx 0.31.1

MLX-native ONNX Runtime execution provider (plugin EP) for Apple Silicon — binds mlx-c directly, no mlx-rs.
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

//! ORT Plugin EP ABI and lifecycle shell.
//!
//! This module is deliberately small: it owns the `OrtEp` vtable, performs the
//! minimal ABI casts and FFI panic guards, and delegates capability policy,
//! compilation state, and execution to their focused modules. `MlxEp` owns the
//! streams for the EP lifetime; individual fused plans never retain ORT pointers.

use std::ffi::{CStr, CString, c_char};
use std::ptr;

use crate::factory::ORT_API_VERSION;
use crate::mlx::Stream;
use crate::sys::ort;

#[repr(C)]
pub struct MlxEp {
    base: ort::OrtEp,
    ort_api: *const ort::OrtApi,
    ep_api: *const ort::OrtEpApi,
    name: CString,
    stream: Stream,
    /// MLX has no Metal float64 path, so fp64 partitions use this shared CPU
    /// stream for their complete lifetime.
    cpu_stream: Stream,
    enable_compile: bool,
    memory_info: *mut ort::OrtMemoryInfo,
}

impl MlxEp {
    pub fn new(
        ort_api: *const ort::OrtApi,
        ep_api: *const ort::OrtEpApi,
        name: &CStr,
        _logger: *const ort::OrtLogger,
        enable_compile: bool,
        memory_info: *mut ort::OrtMemoryInfo,
    ) -> Box<Self> {
        let mut base: ort::OrtEp = unsafe { std::mem::zeroed() };
        base.ort_version_supported = ORT_API_VERSION;
        base.GetName = Some(get_name);
        base.GetCapability = Some(get_capability);
        base.Compile = Some(compile);
        base.ReleaseNodeComputeInfos = Some(release_node_compute_infos);
        base.GetDefaultMemoryDevice = Some(get_default_memory_device);
        Box::new(Self {
            base,
            ort_api,
            ep_api,
            name: name.to_owned(),
            stream: Stream::new_default_gpu(),
            cpu_stream: Stream::new_default_cpu(),
            enable_compile,
            memory_info,
        })
    }

    pub fn as_ptr(self: Box<Self>) -> *mut ort::OrtEp {
        Box::into_raw(self).cast()
    }
}

// The streams are RAII-owned by MlxEp and are dropped exactly once from
// factory::release_ep. Trace export is process-cumulative and is finalized on EP teardown.
impl Drop for MlxEp {
    fn drop(&mut self) {
        let tracer = crate::trace::tracer();
        tracer.log_slowest_ops();
        tracer.log_summary();
        tracer.export();
        if !self.memory_info.is_null() {
            unsafe { ((*self.ort_api).ReleaseMemoryInfo.unwrap())(self.memory_info) };
        }
    }
}

#[inline]
unsafe fn this(ep: *const ort::OrtEp) -> *const MlxEp {
    ep.cast()
}

unsafe extern "C" fn get_name(ep: *const ort::OrtEp) -> *const c_char {
    unsafe { (*this(ep)).name.as_ptr() }
}

unsafe extern "C" fn get_default_memory_device(
    ep: *const ort::OrtEp,
    device: *mut *const ort::OrtMemoryDevice,
) -> *mut ort::OrtStatus {
    unsafe {
        let ep = &*this(ep);
        *device = if ep.memory_info.is_null() {
            ptr::null()
        } else {
            ((*ep.ep_api).MemoryInfo_GetMemoryDevice.unwrap())(ep.memory_info)
        };
        ptr::null_mut()
    }
}

unsafe extern "C" fn get_capability(
    ep: *mut ort::OrtEp,
    graph: *const ort::OrtGraph,
    support: *mut ort::OrtEpGraphSupportInfo,
) -> *mut ort::OrtStatus {
    let ep = unsafe { &*this(ep) };
    unsafe {
        crate::guard_ffi_status(ep.ort_api, "get_capability", || {
            crate::capability::get_capability(
                ep.ort_api,
                ep.ep_api,
                graph,
                support,
                ep.enable_compile,
            )
        })
    }
}

unsafe extern "C" fn compile(
    ep: *mut ort::OrtEp,
    graphs: *mut *const ort::OrtGraph,
    fused_nodes: *mut *const ort::OrtNode,
    count: usize,
    node_compute_infos: *mut *mut ort::OrtNodeComputeInfo,
    _ep_context_nodes: *mut *mut ort::OrtNode,
) -> *mut ort::OrtStatus {
    let ep = unsafe { &*this(ep) };
    unsafe {
        crate::guard_ffi_status(ep.ort_api, "compile", || {
            crate::runtime::compile(
                ep.ort_api,
                crate::runtime::CompileOptions {
                    gpu_stream: ep.stream.as_raw(),
                    cpu_stream: ep.cpu_stream.as_raw(),
                    enable_compile: ep.enable_compile,
                },
                graphs,
                fused_nodes,
                count,
                node_compute_infos,
            )
        })
    }
}

unsafe extern "C" fn release_node_compute_infos(
    _ep: *mut ort::OrtEp,
    infos: *mut *mut ort::OrtNodeComputeInfo,
    count: usize,
) {
    unsafe { crate::runtime::release_node_compute_infos(infos, count) }
}