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
//! lightning-sys aims provides safe (as safe as a jit can be) rust bindings to GNU Lightning //! //! ## Examples: //! ### a function that increments a number by one //! ``` //! use lightning_sys::{Jit, Reg, JitPointer, JitWord}; //! //! let mut jit = Jit::new(); //! let mut js = jit.new_state(); //! //! js.prolog(); //! let inarg = js.arg(); //! js.getarg(Reg::R(0), &inarg); //! js.addi(Reg::R(0), Reg::R(0), 1); //! js.retr(Reg::R(0)); //! //! let incr = unsafe { js.emit::<extern fn(JitWord) -> JitWord>() }; //! js.clear(); //! //! assert_eq!(incr(5), 6); //! assert_eq!(incr(6), 7); //! //! ``` //! //! ### A simple function call to `printf` //! ``` //! extern crate libc; //! //! use std::ffi::CString; //! use lightning_sys::{Jit, JitWord, Reg, JitPointer}; //! use std::convert::TryInto; //! //! fn main() { //! let mut jit = Jit::new(); //! let mut js = jit.new_state(); //! //! // make sure this outlives any calls //! let cs = CString::new("generated %d bytes\n").unwrap(); //! //! let start = js.note(Some(file!()), line!()); //! js.prolog(); //! let inarg = js.arg(); //! js.getarg(Reg::R(1), &inarg); //! js.prepare(); //! js.pushargi(cs.as_ptr() as JitWord); //! js.ellipsis(); //! js.pushargr(Reg::R(1)); //! js.finishi(libc::printf as JitPointer); //! js.ret(); //! js.epilog(); //! let end = js.note(Some(file!()), line!()); //! //! let my_function = unsafe{ js.emit::<extern fn(JitWord)>() }; //! /* call the generated code, passing its size as argument */ //! my_function((js.address(&end) as u64 - js.address(&start) as u64).try_into().unwrap()); //! js.clear(); //! //! // TODO: dissasembly has not been implemented yet //! // js.dissasemble(); //! } //! //! ``` //! //! ### Fibonacci numbers //! ``` //! use lightning_sys::{Jit, JitWord, Reg, JitPointer, NULL}; //! //! fn main() { //! let mut jit = Jit::new(); //! let mut js = jit.new_state(); //! //! let label = js.label(); //! js.prolog(); //! let inarg = js.arg(); //! js.getarg(Reg::R(0), &inarg); //! let zero = js.beqi(Reg::R(0), 0); //! js.movr(Reg::V(0), Reg::R(0)); //! js.movi(Reg::R(0), 1); //! let refr = js.blei(Reg::V(0), 2); //! js.subi(Reg::V(1), Reg::V(0), 1); //! js.subi(Reg::V(2), Reg::V(0), 2); //! js.prepare(); //! js.pushargr(Reg::V(1)); //! let call = js.finishi(NULL); //! js.patch_at(&call, &label); //! js.retval(Reg::V(1)); //! js.prepare(); //! js.pushargr(Reg::V(2)); //! let call2 = js.finishi(NULL); //! js.patch_at(&call2, &label); //! js.retval(Reg::R(0)); //! js.addr(Reg::R(0), Reg::R(0), Reg::V(1)); //! //! js.patch(&refr); //! js.patch(&zero); //! js.retr(Reg::R(0)); //! js.epilog(); //! //! let fib = unsafe{ js.emit::<extern fn(JitWord) -> JitWord>() }; //! js.clear(); //! //! println!("fib({})={}", 32, fib(32)); //! assert_eq!(0, fib(0)); //! assert_eq!(1, fib(1)); //! assert_eq!(1, fib(2)); //! assert_eq!(2178309, fib(32)); //! } //! ``` //! //! ### Tail Call Optimized factorial //! ``` //! use lightning_sys::{Jit, JitWord, Reg, NULL}; //! //! fn main() { //! let mut jit = Jit::new(); //! let mut js = jit.new_state(); //! //! let fact = js.forward(); //! //! js.prolog(); //! let inarg = js.arg(); //! js.getarg(Reg::R(0), &inarg); //! js.prepare(); //! js.pushargi(1); //! js.pushargr(Reg::R(0)); //! let call = js.finishi(NULL); //! js.patch_at(&call, &fact); //! //! js.retval(Reg::R(0)); //! js.retr(Reg::R(0)); //! js.epilog(); //! //! js.link(&fact); //! js.prolog(); //! js.frame(16); //! let f_ent = js.label(); // TCO entry point //! let ac = js.arg(); //! let ina = js.arg(); //! js.getarg(Reg::R(0), &ac); //! js.getarg(Reg::R(1), &ina); //! let f_out = js.blei(Reg::R(1), 1); //! js.mulr(Reg::R(0), Reg::R(0), Reg::R(1)); //! js.putargr(Reg::R(0), &ac); //! js.subi(Reg::R(1), Reg::R(1), 1); //! js.putargr(Reg::R(1), &ina); //! let jump = js.jmpi(); // tail call optimiation //! js.patch_at(&jump, &f_ent); //! js.patch(&f_out); //! js.retr(Reg::R(0)); //! //! let factorial = unsafe{ js.emit::<extern fn(JitWord) -> JitWord>() }; //! js.clear(); //! //! println!("factorial({}) = {}", 5, factorial(5)); //! assert_eq!(1, factorial(1)); //! assert_eq!(2, factorial(2)); //! assert_eq!(6, factorial(3)); //! assert_eq!(24, factorial(4)); //! assert_eq!(120, factorial(5)); //! } //! ``` // Enforce some lints for the whole crate. #![deny(clippy::needless_lifetimes)] #![deny(clippy::transmute_ptr_to_ptr)] #![allow(clippy::needless_doctest_main)] // remain faithful to original examples // Suppress some lints for bindings specifically. #[allow(non_upper_case_globals)] #[allow(non_camel_case_types)] #[allow(dead_code)] #[allow(clippy::unreadable_literal)] #[allow(clippy::trivially_copy_pass_by_ref)] #[allow(clippy::useless_transmute)] #[allow(clippy::too_many_arguments)] mod bindings; #[macro_use] extern crate lazy_static; // The `raw` module comes first so that it can provide macros during parsing of // other modules. It is not yet part of the crate's public API, but in the // spirit of *-sys modules exposing lowest-level bindings, it may someday be so. #[macro_use] pub(crate) mod raw; pub mod jit; pub use jit::Jit; pub mod jitstate; pub use jitstate::JitState; pub mod types; pub use types::NULL; pub use types::Reg; pub use types::JitNode; pub use types::{JitWord, JitUword, JitPointer}; pub(crate) use types::ToFFI;