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 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329
#[cfg(windows)] use unreachable::UncheckedOptionExt; // unchecked unwrap used in generated Windows code pub use std::os::raw::{c_char, c_double, c_int, c_long, c_uchar, c_uint, c_ulong, c_void}; use std::os; #[allow(non_camel_case_types)] pub type size_t = usize; use std::option::Option; //use std::mem::size_of; #[allow(non_camel_case_types)] pub type ERL_NIF_UINT = size_t; #[allow(non_camel_case_types)] pub type ERL_NIF_TERM = ERL_NIF_UINT; //#[derive(Debug, Copy, Clone)] //#[repr(C)] //pub struct ERL_NIF_TERM(ERL_NIF_UINT); // Don't do this, 32 bit calling convention is different for structs and ints. /// See [ErlNifEnv](http://www.erlang.org/doc/man/erl_nif.html#ErlNifEnv) in the Erlang docs. #[derive(Debug)] #[allow(missing_copy_implementations)] #[repr(C)] pub struct ErlNifEnv { dummy: *mut c_void, // block automatic Send and Sync traits. Ref https://doc.rust-lang.org/beta/nomicon/send-and-sync.html } // Ownership of an env may be safely transfers between threads, therefore ErlNifEnv is Send. // This is the common use case for process independent environments created with enif_alloc_env(). // ErlNifEnv is NOT Sync because it is thread unsafe. unsafe impl Send for ErlNifEnv {} /// See [ErlNifFunc](http://www.erlang.org/doc/man/erl_nif.html#ErlNifFunc) in the Erlang docs. // #[allow(missing_copy_implementations)] #[repr(C)] pub struct ErlNifFunc { pub name: *const u8, pub arity: c_uint, pub function: unsafe extern "C" fn( env: *mut ErlNifEnv, argc: c_int, argv: *const ERL_NIF_TERM, ) -> ERL_NIF_TERM, pub flags: c_uint, } // #[allow(missing_copy_implementations)] #[doc(hidden)] #[derive(Debug)] #[repr(C)] #[allow(non_snake_case)] pub struct ErlNifEntry { pub major: c_int, pub minor: c_int, pub name: *const u8, pub num_of_funcs: c_int, pub funcs: *const ErlNifFunc, pub load: Option< unsafe extern "C" fn( env: *mut ErlNifEnv, priv_data: *mut *mut c_void, load_info: ERL_NIF_TERM, ) -> c_int, >, pub reload: Option< unsafe extern "C" fn( env: *mut ErlNifEnv, priv_data: *mut *mut c_void, load_info: ERL_NIF_TERM, ) -> c_int, >, pub upgrade: Option< unsafe extern "C" fn( env: *mut ErlNifEnv, priv_data: *mut *mut c_void, old_priv_data: *mut *mut c_void, load_info: ERL_NIF_TERM, ) -> c_int, >, pub unload: Option<unsafe extern "C" fn(env: *mut ErlNifEnv, priv_data: *mut c_void) -> ()>, pub vm_variant: *const u8, pub options: c_uint, // added in 2.7 pub sizeof_ErlNifResourceTypeInit: usize, // added in 2.12 } pub const ERL_NIF_DIRTY_NIF_OPTION: c_uint = 1; /// See [ErlNifBinary](http://www.erlang.org/doc/man/erl_nif.html#ErlNifBinary) in the Erlang docs. #[allow(missing_copy_implementations)] #[derive(Debug, Copy, Clone)] #[repr(C)] pub struct ErlNifBinary { pub size: size_t, pub data: *mut u8, ref_bin: *mut c_void, _spare: [*mut c_void; 2], } #[cfg(windows)] pub type ErlNifEvent = os::windows::raw::HANDLE; #[cfg(unix)] pub type ErlNifEvent = os::unix::io::RawFd; /// See [ErlNifResourceType](http://www.erlang.org/doc/man/erl_nif.html#ErlNifResourceType) in the Erlang docs. #[allow(missing_copy_implementations)] #[repr(C)] pub struct ErlNifResourceType { dummy: c_int, } /// See [ErlNifResourceDtor](http://www.erlang.org/doc/man/erl_nif.html#ErlNifResourceDtor) in the Erlang docs. #[allow(missing_copy_implementations)] pub type ErlNifResourceDtor = unsafe extern "C" fn(env: *mut ErlNifEnv, obj: *mut c_void) -> (); /// See [ErlNifResourceStop](http://www.erlang.org/doc/man/erl_nif.html#ErlNifResourceStop) in the Erlang docs. #[allow(missing_copy_implementations)] pub type ErlNifResourceStop = unsafe extern "C" fn( env: *mut ErlNifEnv, obj: *mut c_void, event: ErlNifEvent, is_direct_call: c_int, ) -> (); /// See [ErlNifResourceDown](http://www.erlang.org/doc/man/erl_nif.html#ErlNifResourceDown) in the Erlang docs. #[allow(missing_copy_implementations)] pub type ErlNifResourceDown = unsafe extern "C" fn( env: *mut ErlNifEnv, obj: *mut c_void, pid: *const ErlNifPid, mon: *const ErlNifMonitor, ) -> (); /// See [ErlNifResourceTypeInit](http://www.erlang.org/doc/man/erl_nif.html#ErlNifResourceTypeInit) in the Erlang docs. #[derive(Debug, Copy, Clone)] #[repr(C)] pub struct ErlNifResourceTypeInit { dtor: *const ErlNifResourceDtor, stop: *const ErlNifResourceStop, // at ERL_NIF_SELECT_STOP event down: *const ErlNifResourceDown, // enif_monitor_process } /// See [ErlNifSelectFlags](http://erlang.org/doc/man/erl_nif.html#ErlNifSelectFlags) in the Erlang docs. pub type ErlNifSelectFlags = c_int; #[allow(clippy::identity_op)] pub const ERL_NIF_SELECT_READ: ErlNifSelectFlags = (1 << 0); pub const ERL_NIF_SELECT_WRITE: ErlNifSelectFlags = (1 << 1); pub const ERL_NIF_SELECT_STOP: ErlNifSelectFlags = (1 << 2); pub const ERL_NIF_SELECT_FAILED: ErlNifSelectFlags = (1 << 3); pub const ERL_NIF_SELECT_READ_CANCELLED: ErlNifSelectFlags = (1 << 4); pub const ERL_NIF_SELECT_WRITE_CANCELLED: ErlNifSelectFlags = (1 << 5); /// See [ErlNifMonitor](http://www.erlang.org/doc/man/erl_nif.html#ErlNifMonitor) in the Erlang docs. #[derive(Debug, Copy, Clone)] #[repr(C)] pub struct ErlNifMonitor { // from https://github.com/erlang/otp/blob/83e20c62057ebc1d8064bf57b01be560cd244e1d/erts/emulator/beam/erl_drv_nif.h#L64 // data: [c_uchar; size_of::<*const c_void>()*4], size_of is non-const data: [usize; 4], } /// See [ErlNifResourceFlags](http://www.erlang.org/doc/man/erl_nif.html#ErlNifResourceFlags) in the Erlang docs. #[derive(Debug, Copy, Clone)] #[repr(C)] pub enum ErlNifResourceFlags { ERL_NIF_RT_CREATE = 1, ERL_NIF_RT_TAKEOVER = 2, } /// See [ErlNifCharEncoding](http://www.erlang.org/doc/man/erl_nif.html#ErlNifCharEncoding) in the Erlang docs. #[derive(Debug, Copy, Clone)] #[repr(C)] pub enum ErlNifCharEncoding { ERL_NIF_LATIN1 = 1, DUMMY = 999, // prevents "univariant enum" compile error } /// See [ErlNifPid](http://www.erlang.org/doc/man/erl_nif.html#ErlNifPid) in the Erlang docs. #[derive(Debug, Copy, Clone)] #[repr(C)] pub struct ErlNifPid { pid: ERL_NIF_TERM, } /// See [enif_make_pid](http://erlang.org/doc/man/erl_nif.html#enif_make_pid) in the Erlang docs pub unsafe fn enif_make_pid(_env: *mut ErlNifEnv, pid: ErlNifPid) -> ERL_NIF_TERM { pid.pid } /// See [ErlNifSysInfo](http://www.erlang.org/doc/man/erl_nif.html#ErlNifSysInfo) in the Erlang docs. #[allow(missing_copy_implementations)] #[repr(C)] pub struct ErlNifSysInfo { pub driver_major_version: c_int, pub driver_minor_version: c_int, pub erts_version: *mut c_char, pub otp_release: *mut c_char, pub thread_support: c_int, pub smp_support: c_int, pub async_threads: c_int, pub scheduler_threads: c_int, pub nif_major_version: c_int, pub nif_minor_version: c_int, pub dirty_scheduler_support: c_int, } // /// See [ErlNifFunc](http://www.erlang.org/doc/man/erl_nif.html#ErlNifFunc) in the Erlang docs. // #[derive(Copy, Clone)] // #[repr(C)] // pub enum ErlNifDirtyTaskFlags { // ERL_NIF_DIRTY_JOB_CPU_BOUND = 1, // ERL_NIF_DIRTY_JOB_IO_BOUND = 2, // } pub type ErlNifDirtyTaskFlags = c_uint; pub const ERL_NIF_DIRTY_JOB_CPU_BOUND: ErlNifDirtyTaskFlags = 1; pub const ERL_NIF_DIRTY_JOB_IO_BOUND: ErlNifDirtyTaskFlags = 2; /// See [ErlNifMapIterator](http://www.erlang.org/doc/man/erl_nif.html#ErlNifMapIterator) in the Erlang docs. #[allow(missing_copy_implementations)] #[repr(C)] pub struct ErlNifMapIterator { map: ERL_NIF_TERM, t_limit: ERL_NIF_UINT, idx: ERL_NIF_UINT, ks: *mut ERL_NIF_TERM, vs: *mut ERL_NIF_TERM, __spare__: [*mut c_void; 2], } /// See [ErlNifMapIteratorEntry](http://www.erlang.org/doc/man/erl_nif.html#ErlNifMapIteratorEntry) in the Erlang docs. #[derive(Copy, Clone)] #[repr(C)] pub enum ErlNifMapIteratorEntry { ERL_NIF_MAP_ITERATOR_HEAD = 1, ERL_NIF_MAP_ITERATOR_TAIL = 2, } /// See [ErlNifTime](http://www.erlang.org/doc/man/erl_nif.html#ErlNifTime) in the Erlang docs. pub type ErlNifTime = i64; /// Error return value for `enif_monotonic_time()`, `enif_time_offset()`, and `enif_convert_time_unit()`. pub const ERL_NIF_TIME_ERROR: i64 = -9_223_372_036_854_775_808; //const ERL_NIF_TIME_ERROR:i64 = i64::min_value(); "error: const fn's not yet stable" /// See [ErlNifTimeUnit](http://www.erlang.org/doc/man/erl_nif.html#ErlNifTimeUnit) in the Erlang docs. #[derive(Copy, Clone)] #[repr(C)] pub enum ErlNifTimeUnit { // values yanked from https://github.com/erlang/otp/blob/7cb403e4aa044fd2cc7702dbe8e2d0eea68e81f3/erts/emulator/beam/erl_drv_nif.h#L132 ERL_NIF_SEC = 0, ERL_NIF_MSEC = 1, ERL_NIF_USEC = 2, ERL_NIF_NSEC = 3, } /// See [ErlNifUniqueInteger](http://erlang.org/doc/man/erl_nif.html#ErlNifUniqueInteger) in the Erlang docs. pub type ErlNifUniqueInteger = c_int; #[allow(clippy::identity_op)] pub const ERL_NIF_UNIQUE_POSITIVE: ErlNifUniqueInteger = (1 << 0); #[allow(clippy::identity_op)] pub const ERL_NIF_UNIQUE_MONOTONIC: ErlNifUniqueInteger = (1 << 1); // ref https://github.com/erlang/otp/blob/maint/erts/emulator/beam/erl_nif.h#L203 // FIXME: Should actually be C enum, but repr(C) enums in Rust can't be used as bitfields. // Fix if the right abstraction ever lands in Rust. /// See [ErlNifPort](http://erlang.org/doc/man/erl_nif.html#ErlNifPort) in the Erlang docs. #[derive(Copy, Clone)] #[repr(C)] pub struct ErlNifPort { port_id: ERL_NIF_TERM, // internal, may change } // ref https://github.com/erlang/otp/blob/maint/erts/emulator/beam/erl_nif.h#L155 /// See [ErlNifBinaryToTerm](http://erlang.org/doc/man/erl_nif.html#ErlNifBinaryToTerm) in the Erlang docs. pub type ErlNifBinaryToTerm = c_int; pub const ERL_NIF_BIN2TERM_SAFE: ErlNifBinaryToTerm = 0x20_000_000; pub const ERL_NIF_THR_UNDEFINED: c_int = 0; pub const ERL_NIF_THR_NORMAL_SCHEDULER: c_int = 1; pub const ERL_NIF_THR_DIRTY_CPU_SCHEDULER: c_int = 2; pub const ERL_NIF_THR_DIRTY_IO_SCHEDULER: c_int = 3; /// See [ErlNifHash](http://www.erlang.org/doc/man/erl_nif.html#ErlNifHash) in the Erlang docs. #[derive(Copy, Clone)] #[repr(C)] pub enum ErlNifHash { // from https://github.com/erlang/otp/blob/83e20c62057ebc1d8064bf57b01be560cd244e1d/erts/emulator/beam/erl_nif.h#L242 ERL_NIF_INTERNAL_HASH = 1, ERL_NIF_PHASH2 = 2, } /// See [ErlNifTermType](http://www.erlang.org/doc/man/erl_nif.html#ErlNifTermType) in the Erlang docs. #[derive(Copy, Clone)] #[repr(C)] pub enum ErlNifTermType { // from https://github.com/erlang/otp/blob/6618ce7b6a621e92db72ea4f01f7d38553c8818c/erts/emulator/beam/erl_nif.h#L291 ERL_NIF_TERM_TYPE_ATOM = 1, ERL_NIF_TERM_TYPE_BITSTRING = 2, ERL_NIF_TERM_TYPE_FLOAT = 3, ERL_NIF_TERM_TYPE_FUN = 4, ERL_NIF_TERM_TYPE_INTEGER = 5, ERL_NIF_TERM_TYPE_LIST = 6, ERL_NIF_TERM_TYPE_MAP = 7, ERL_NIF_TERM_TYPE_PID = 8, ERL_NIF_TERM_TYPE_PORT = 9, ERL_NIF_TERM_TYPE_REFERENCE = 10, ERL_NIF_TERM_TYPE_TUPLE = 11, /* This is a dummy value intended to coax the compiler into warning about * unhandled values in a switch even if all the above values have been * handled. We can add new entries at any time so the user must always * have a default case. */ ERL_NIF_TERM_TYPE__MISSING_DEFAULT_CASE__READ_THE_MANUAL = -1, } include!(concat!(env!("OUT_DIR"), "/nif_api.snippet")); // example of included content: // extern "C" { // pub fn enif_priv_data(arg1: *mut ErlNifEnv) -> *mut c_void; // pub fn enif_alloc(size: size_t) -> *mut c_void; // pub fn enif_free(ptr: *mut c_void); // pub fn enif_is_atom(arg1: *mut ErlNifEnv, term: ERL_NIF_TERM) -> c_int; // pub fn enif_is_binary(arg1: *mut ErlNifEnv, term: ERL_NIF_TERM) -> c_int; // ...