1 //! The JIT driver uses [`cranelift_simplejit`] to JIT execute programs without writing any object
4 use std::cell::RefCell;
6 use std::os::raw::{c_char, c_int};
8 use rustc_codegen_ssa::CrateInfo;
9 use rustc_middle::mir::mono::MonoItem;
11 use cranelift_jit::{JITBuilder, JITModule};
13 use crate::prelude::*;
14 use crate::{CodegenCx, CodegenMode};
17 pub static CURRENT_MODULE: RefCell<Option<JITModule>> = RefCell::new(None);
20 pub(super) fn run_jit(tcx: TyCtxt<'_>, codegen_mode: CodegenMode) -> ! {
21 if !tcx.sess.opts.output_types.should_codegen() {
22 tcx.sess.fatal("JIT mode doesn't work with `cargo check`.");
27 // When not using our custom driver rustc will open us without the RTLD_GLOBAL flag, so
28 // __cg_clif_global_atomic_mutex will not be exported. We fix this by opening ourself again
30 // FIXME remove once atomic_shim is gone
32 let mut dl_info: libc::Dl_info = std::mem::zeroed();
34 libc::dladdr(run_jit as *const libc::c_void, &mut dl_info),
38 libc::dlopen(dl_info.dli_fname, libc::RTLD_NOW | libc::RTLD_GLOBAL),
43 let imported_symbols = load_imported_symbols_for_jit(tcx);
45 let mut jit_builder = JITBuilder::with_isa(
46 crate::build_isa(tcx.sess),
47 cranelift_module::default_libcall_names(),
49 jit_builder.hotswap(matches!(codegen_mode, CodegenMode::JitLazy));
50 jit_builder.symbols(imported_symbols);
51 let mut jit_module = JITModule::new(jit_builder);
52 assert_eq!(pointer_ty(tcx), jit_module.target_config().pointer_type());
56 AbiParam::new(jit_module.target_config().pointer_type()),
57 AbiParam::new(jit_module.target_config().pointer_type()),
59 returns: vec![AbiParam::new(
60 jit_module.target_config().pointer_type(), /*isize*/
62 call_conv: CallConv::triple_default(&crate::target_triple(tcx.sess)),
64 let main_func_id = jit_module
65 .declare_function("main", Linkage::Import, &sig)
68 let (_, cgus) = tcx.collect_and_partition_mono_items(LOCAL_CRATE);
71 .map(|cgu| cgu.items_in_deterministic_order(tcx).into_iter())
73 .collect::<FxHashMap<_, (_, _)>>()
75 .collect::<Vec<(_, (_, _))>>();
77 let mut cx = crate::CodegenCx::new(tcx, jit_module, false, false);
79 super::time(tcx, "codegen mono items", || {
80 super::predefine_mono_items(&mut cx, &mono_items);
81 for (mono_item, (linkage, visibility)) in mono_items {
82 let linkage = crate::linkage::get_clif_linkage(mono_item, linkage, visibility);
84 MonoItem::Fn(inst) => match codegen_mode {
85 CodegenMode::Aot => unreachable!(),
87 cx.tcx.sess.time("codegen fn", || {
88 crate::base::codegen_fn(&mut cx, inst, linkage)
91 CodegenMode::JitLazy => codegen_shim(&mut cx, inst),
93 MonoItem::Static(def_id) => {
94 crate::constant::codegen_static(&mut cx.constants_cx, def_id);
96 MonoItem::GlobalAsm(item_id) => {
97 let item = cx.tcx.hir().item(item_id);
98 tcx.sess.span_fatal(item.span, "Global asm is not supported in JIT mode");
104 let (mut jit_module, global_asm, _debug, mut unwind_context) =
105 tcx.sess.time("finalize CodegenCx", || cx.finalize());
106 jit_module.finalize_definitions();
108 if !global_asm.is_empty() {
109 tcx.sess.fatal("Inline asm is not supported in JIT mode");
112 crate::main_shim::maybe_create_entry_wrapper(tcx, &mut jit_module, &mut unwind_context, true);
113 crate::allocator::codegen(tcx, &mut jit_module, &mut unwind_context);
115 tcx.sess.abort_if_errors();
117 jit_module.finalize_definitions();
119 let _unwind_register_guard = unsafe { unwind_context.register_jit(&jit_module) };
121 let finalized_main: *const u8 = jit_module.get_finalized_function(main_func_id);
123 println!("Rustc codegen cranelift will JIT run the executable, because -Cllvm-args=mode=jit was passed");
125 let f: extern "C" fn(c_int, *const *const c_char) -> c_int =
126 unsafe { ::std::mem::transmute(finalized_main) };
128 let args = ::std::env::var("CG_CLIF_JIT_ARGS").unwrap_or_else(|_| String::new());
129 let args = std::iter::once(&*tcx.crate_name(LOCAL_CRATE).as_str().to_string())
130 .chain(args.split(' '))
131 .map(|arg| CString::new(arg).unwrap())
132 .collect::<Vec<_>>();
133 let mut argv = args.iter().map(|arg| arg.as_ptr()).collect::<Vec<_>>();
135 // Push a null pointer as a terminating argument. This is required by POSIX and
136 // useful as some dynamic linkers use it as a marker to jump over.
137 argv.push(std::ptr::null());
140 .with(|current_module| assert!(current_module.borrow_mut().replace(jit_module).is_none()));
142 let ret = f(args.len() as c_int, argv.as_ptr());
144 std::process::exit(ret);
148 extern "C" fn __clif_jit_fn(instance_ptr: *const Instance<'static>) -> *const u8 {
149 rustc_middle::ty::tls::with(|tcx| {
150 // lift is used to ensure the correct lifetime for instance.
151 let instance = tcx.lift(unsafe { *instance_ptr }).unwrap();
153 CURRENT_MODULE.with(|jit_module| {
154 let mut jit_module = jit_module.borrow_mut();
155 let jit_module = jit_module.as_mut().unwrap();
156 let mut cx = crate::CodegenCx::new(tcx, jit_module, false, false);
158 let name = tcx.symbol_name(instance).name.to_string();
159 let sig = crate::abi::get_function_sig(tcx, cx.module.isa().triple(), instance);
162 .declare_function(&name, Linkage::Export, &sig)
164 cx.module.prepare_for_function_redefine(func_id).unwrap();
166 tcx.sess.time("codegen fn", || {
167 crate::base::codegen_fn(&mut cx, instance, Linkage::Export)
170 let (jit_module, global_asm, _debug_context, unwind_context) = cx.finalize();
171 assert!(global_asm.is_empty());
172 jit_module.finalize_definitions();
173 std::mem::forget(unsafe { unwind_context.register_jit(&jit_module) });
174 jit_module.get_finalized_function(func_id)
179 fn load_imported_symbols_for_jit(tcx: TyCtxt<'_>) -> Vec<(String, *const u8)> {
180 use rustc_middle::middle::dependency_format::Linkage;
182 let mut dylib_paths = Vec::new();
184 let crate_info = CrateInfo::new(tcx);
185 let formats = tcx.dependency_formats(LOCAL_CRATE);
188 .find(|(crate_type, _data)| *crate_type == rustc_session::config::CrateType::Executable)
191 for &(cnum, _) in &crate_info.used_crates_dynamic {
192 let src = &crate_info.used_crate_source[&cnum];
193 match data[cnum.as_usize() - 1] {
194 Linkage::NotLinked | Linkage::IncludedFromDylib => {}
196 let name = tcx.crate_name(cnum);
199 .struct_err(&format!("Can't load static lib {}", name.as_str()));
200 err.note("rustc_codegen_cranelift can only load dylibs in JIT mode.");
203 Linkage::Dynamic => {
204 dylib_paths.push(src.dylib.as_ref().unwrap().0.clone());
209 let mut imported_symbols = Vec::new();
210 for path in dylib_paths {
211 use object::{Object, ObjectSymbol};
212 let lib = libloading::Library::new(&path).unwrap();
213 let obj = std::fs::read(path).unwrap();
214 let obj = object::File::parse(&obj).unwrap();
215 imported_symbols.extend(obj.dynamic_symbols().filter_map(|symbol| {
216 let name = symbol.name().unwrap().to_string();
217 if name.is_empty() || !symbol.is_global() || symbol.is_undefined() {
220 let dlsym_name = if cfg!(target_os = "macos") {
221 // On macOS `dlsym` expects the name without leading `_`.
222 assert!(name.starts_with('_'), "{:?}", name);
227 let symbol: libloading::Symbol<'_, *const u8> =
228 unsafe { lib.get(dlsym_name.as_bytes()) }.unwrap();
229 Some((name, *symbol))
231 std::mem::forget(lib)
234 tcx.sess.abort_if_errors();
239 pub(super) fn codegen_shim<'tcx>(cx: &mut CodegenCx<'tcx, impl Module>, inst: Instance<'tcx>) {
242 let pointer_type = cx.module.target_config().pointer_type();
244 let name = tcx.symbol_name(inst).name.to_string();
245 let sig = crate::abi::get_function_sig(tcx, cx.module.isa().triple(), inst);
248 .declare_function(&name, Linkage::Export, &sig)
251 let instance_ptr = Box::into_raw(Box::new(inst));
259 call_conv: cx.module.target_config().default_call_conv,
260 params: vec![AbiParam::new(pointer_type)],
261 returns: vec![AbiParam::new(pointer_type)],
266 let mut trampoline = Function::with_name_signature(ExternalName::default(), sig.clone());
267 let mut builder_ctx = FunctionBuilderContext::new();
268 let mut trampoline_builder = FunctionBuilder::new(&mut trampoline, &mut builder_ctx);
272 .declare_func_in_func(jit_fn, trampoline_builder.func);
273 let sig_ref = trampoline_builder.func.import_signature(sig);
275 let entry_block = trampoline_builder.create_block();
276 trampoline_builder.append_block_params_for_function_params(entry_block);
277 let fn_args = trampoline_builder
280 .block_params(entry_block)
283 trampoline_builder.switch_to_block(entry_block);
284 let instance_ptr = trampoline_builder
286 .iconst(pointer_type, instance_ptr as u64 as i64);
287 let jitted_fn = trampoline_builder.ins().call(jit_fn, &[instance_ptr]);
288 let jitted_fn = trampoline_builder.func.dfg.inst_results(jitted_fn)[0];
289 let call_inst = trampoline_builder
291 .call_indirect(sig_ref, jitted_fn, &fn_args);
292 let ret_vals = trampoline_builder.func.dfg.inst_results(call_inst).to_vec();
293 trampoline_builder.ins().return_(&ret_vals);
298 &mut Context::for_function(trampoline),
299 &mut cranelift_codegen::binemit::NullTrapSink {},