compiler/rustc_codegen_cranelift/src/driver/jit.rs

   1 //! The JIT driver uses [`cranelift_jit`] to JIT execute programs without writing any object
   2 //! files.
   3
   4 use std::cell::RefCell;
   5 use std::ffi::CString;
   6 use std::os::raw::{c_char, c_int};
   7
   8 use cranelift_codegen::binemit::{NullStackMapSink, NullTrapSink};
   9 use rustc_codegen_ssa::CrateInfo;
  10 use rustc_middle::mir::mono::MonoItem;
  11
  12 use cranelift_jit::{JITBuilder, JITModule};
  13
  14 use crate::{prelude::*, BackendConfig};
  15 use crate::{CodegenCx, CodegenMode};
  16
  17 struct JitState {
  18     backend_config: BackendConfig,
  19     jit_module: JITModule,
  20 }
  21
  22 thread_local! {
  23     static LAZY_JIT_STATE: RefCell<Option<JitState>> = RefCell::new(None);
  24 }
  25
  26 fn create_jit_module<'tcx>(
  27     tcx: TyCtxt<'tcx>,
  28     backend_config: &BackendConfig,
  29     hotswap: bool,
  30 ) -> (JITModule, CodegenCx<'tcx>) {
  31     let imported_symbols = load_imported_symbols_for_jit(tcx);
  32
  33     let isa = crate::build_isa(tcx.sess, backend_config);
  34     let mut jit_builder = JITBuilder::with_isa(isa, cranelift_module::default_libcall_names());
  35     jit_builder.hotswap(hotswap);
  36     crate::compiler_builtins::register_functions_for_jit(&mut jit_builder);
  37     jit_builder.symbols(imported_symbols);
  38     let mut jit_module = JITModule::new(jit_builder);
  39
  40     let mut cx = crate::CodegenCx::new(tcx, backend_config.clone(), jit_module.isa(), false);
  41
  42     crate::allocator::codegen(tcx, &mut jit_module, &mut cx.unwind_context);
  43     crate::main_shim::maybe_create_entry_wrapper(
  44         tcx,
  45         &mut jit_module,
  46         &mut cx.unwind_context,
  47         true,
  48     );
  49
  50     (jit_module, cx)
  51 }
  52
  53 pub(crate) fn run_jit(tcx: TyCtxt<'_>, backend_config: BackendConfig) -> ! {
  54     if !tcx.sess.opts.output_types.should_codegen() {
  55         tcx.sess.fatal("JIT mode doesn't work with `cargo check`");
  56     }
  57
  58     if !tcx.sess.crate_types().contains(&rustc_session::config::CrateType::Executable) {
  59         tcx.sess.fatal("can't jit non-executable crate");
  60     }
  61
  62     let (mut jit_module, mut cx) = create_jit_module(
  63         tcx,
  64         &backend_config,
  65         matches!(backend_config.codegen_mode, CodegenMode::JitLazy),
  66     );
  67
  68     let (_, cgus) = tcx.collect_and_partition_mono_items(());
  69     let mono_items = cgus
  70         .iter()
  71         .map(|cgu| cgu.items_in_deterministic_order(tcx).into_iter())
  72         .flatten()
  73         .collect::<FxHashMap<_, (_, _)>>()
  74         .into_iter()
  75         .collect::<Vec<(_, (_, _))>>();
  76
  77     super::time(tcx, backend_config.display_cg_time, "codegen mono items", || {
  78         super::predefine_mono_items(tcx, &mut jit_module, &mono_items);
  79         for (mono_item, _) in mono_items {
  80             match mono_item {
  81                 MonoItem::Fn(inst) => match backend_config.codegen_mode {
  82                     CodegenMode::Aot => unreachable!(),
  83                     CodegenMode::Jit => {
  84                         cx.tcx.sess.time("codegen fn", || {
  85                             crate::base::codegen_fn(&mut cx, &mut jit_module, inst)
  86                         });
  87                     }
  88                     CodegenMode::JitLazy => codegen_shim(&mut cx, &mut jit_module, inst),
  89                 },
  90                 MonoItem::Static(def_id) => {
  91                     crate::constant::codegen_static(tcx, &mut jit_module, def_id);
  92                 }
  93                 MonoItem::GlobalAsm(item_id) => {
  94                     let item = tcx.hir().item(item_id);
  95                     tcx.sess.span_fatal(item.span, "Global asm is not supported in JIT mode");
  96                 }
  97             }
  98         }
  99     });
 100
 101     if !cx.global_asm.is_empty() {
 102         tcx.sess.fatal("Inline asm is not supported in JIT mode");
 103     }
 104
 105     tcx.sess.abort_if_errors();
 106
 107     jit_module.finalize_definitions();
 108     unsafe { cx.unwind_context.register_jit(&jit_module) };
 109
 110     println!(
 111         "Rustc codegen cranelift will JIT run the executable, because -Cllvm-args=mode=jit was passed"
 112     );
 113
 114     let args = std::iter::once(&*tcx.crate_name(LOCAL_CRATE).as_str().to_string())
 115         .chain(backend_config.jit_args.iter().map(|arg| &**arg))
 116         .map(|arg| CString::new(arg).unwrap())
 117         .collect::<Vec<_>>();
 118     let mut argv = args.iter().map(|arg| arg.as_ptr()).collect::<Vec<_>>();
 119
 120     // Push a null pointer as a terminating argument. This is required by POSIX and
 121     // useful as some dynamic linkers use it as a marker to jump over.
 122     argv.push(std::ptr::null());
 123
 124     let start_sig = Signature {
 125         params: vec![
 126             AbiParam::new(jit_module.target_config().pointer_type()),
 127             AbiParam::new(jit_module.target_config().pointer_type()),
 128         ],
 129         returns: vec![AbiParam::new(jit_module.target_config().pointer_type() /*isize*/)],
 130         call_conv: CallConv::triple_default(&crate::target_triple(tcx.sess)),
 131     };
 132     let start_func_id = jit_module.declare_function("main", Linkage::Import, &start_sig).unwrap();
 133     let finalized_start: *const u8 = jit_module.get_finalized_function(start_func_id);
 134
 135     LAZY_JIT_STATE.with(|lazy_jit_state| {
 136         let mut lazy_jit_state = lazy_jit_state.borrow_mut();
 137         assert!(lazy_jit_state.is_none());
 138         *lazy_jit_state = Some(JitState { backend_config, jit_module });
 139     });
 140
 141     let f: extern "C" fn(c_int, *const *const c_char) -> c_int =
 142         unsafe { ::std::mem::transmute(finalized_start) };
 143     let ret = f(args.len() as c_int, argv.as_ptr());
 144     std::process::exit(ret);
 145 }
 146
 147 #[no_mangle]
 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();
 152
 153         LAZY_JIT_STATE.with(|lazy_jit_state| {
 154             let mut lazy_jit_state = lazy_jit_state.borrow_mut();
 155             let lazy_jit_state = lazy_jit_state.as_mut().unwrap();
 156             let jit_module = &mut lazy_jit_state.jit_module;
 157             let backend_config = lazy_jit_state.backend_config.clone();
 158
 159             let name = tcx.symbol_name(instance).name;
 160             let sig = crate::abi::get_function_sig(tcx, jit_module.isa().triple(), instance);
 161             let func_id = jit_module.declare_function(name, Linkage::Export, &sig).unwrap();
 162             jit_module.prepare_for_function_redefine(func_id).unwrap();
 163
 164             let mut cx = crate::CodegenCx::new(tcx, backend_config, jit_module.isa(), false);
 165             tcx.sess.time("codegen fn", || crate::base::codegen_fn(&mut cx, jit_module, instance));
 166
 167             assert!(cx.global_asm.is_empty());
 168             jit_module.finalize_definitions();
 169             unsafe { cx.unwind_context.register_jit(&jit_module) };
 170             jit_module.get_finalized_function(func_id)
 171         })
 172     })
 173 }
 174
 175 fn load_imported_symbols_for_jit(tcx: TyCtxt<'_>) -> Vec<(String, *const u8)> {
 176     use rustc_middle::middle::dependency_format::Linkage;
 177
 178     let mut dylib_paths = Vec::new();
 179
 180     let crate_info = CrateInfo::new(tcx);
 181     let formats = tcx.dependency_formats(());
 182     let data = &formats
 183         .iter()
 184         .find(|(crate_type, _data)| *crate_type == rustc_session::config::CrateType::Executable)
 185         .unwrap()
 186         .1;
 187     for &(cnum, _) in &crate_info.used_crates_dynamic {
 188         let src = &crate_info.used_crate_source[&cnum];
 189         match data[cnum.as_usize() - 1] {
 190             Linkage::NotLinked | Linkage::IncludedFromDylib => {}
 191             Linkage::Static => {
 192                 let name = tcx.crate_name(cnum);
 193                 let mut err =
 194                     tcx.sess.struct_err(&format!("Can't load static lib {}", name.as_str()));
 195                 err.note("rustc_codegen_cranelift can only load dylibs in JIT mode.");
 196                 err.emit();
 197             }
 198             Linkage::Dynamic => {
 199                 dylib_paths.push(src.dylib.as_ref().unwrap().0.clone());
 200             }
 201         }
 202     }
 203
 204     let mut imported_symbols = Vec::new();
 205     for path in dylib_paths {
 206         use object::{Object, ObjectSymbol};
 207         let lib = libloading::Library::new(&path).unwrap();
 208         let obj = std::fs::read(path).unwrap();
 209         let obj = object::File::parse(&obj).unwrap();
 210         imported_symbols.extend(obj.dynamic_symbols().filter_map(|symbol| {
 211             let name = symbol.name().unwrap().to_string();
 212             if name.is_empty() || !symbol.is_global() || symbol.is_undefined() {
 213                 return None;
 214             }
 215             if name.starts_with("rust_metadata_") {
 216                 // The metadata is part of a section that is not loaded by the dynamic linker in
 217                 // case of cg_llvm.
 218                 return None;
 219             }
 220             let dlsym_name = if cfg!(target_os = "macos") {
 221                 // On macOS `dlsym` expects the name without leading `_`.
 222                 assert!(name.starts_with('_'), "{:?}", name);
 223                 &name[1..]
 224             } else {
 225                 &name
 226             };
 227             let symbol: libloading::Symbol<'_, *const u8> =
 228                 unsafe { lib.get(dlsym_name.as_bytes()) }.unwrap();
 229             Some((name, *symbol))
 230         }));
 231         std::mem::forget(lib)
 232     }
 233
 234     tcx.sess.abort_if_errors();
 235
 236     imported_symbols
 237 }
 238
 239 fn codegen_shim<'tcx>(cx: &mut CodegenCx<'tcx>, module: &mut JITModule, inst: Instance<'tcx>) {
 240     let tcx = cx.tcx;
 241
 242     let pointer_type = module.target_config().pointer_type();
 243
 244     let name = tcx.symbol_name(inst).name;
 245     let sig = crate::abi::get_function_sig(tcx, module.isa().triple(), inst);
 246     let func_id = module.declare_function(name, Linkage::Export, &sig).unwrap();
 247
 248     let instance_ptr = Box::into_raw(Box::new(inst));
 249
 250     let jit_fn = module
 251         .declare_function(
 252             "__clif_jit_fn",
 253             Linkage::Import,
 254             &Signature {
 255                 call_conv: module.target_config().default_call_conv,
 256                 params: vec![AbiParam::new(pointer_type)],
 257                 returns: vec![AbiParam::new(pointer_type)],
 258             },
 259         )
 260         .unwrap();
 261
 262     cx.cached_context.clear();
 263     let trampoline = &mut cx.cached_context.func;
 264     trampoline.signature = sig.clone();
 265
 266     let mut builder_ctx = FunctionBuilderContext::new();
 267     let mut trampoline_builder = FunctionBuilder::new(trampoline, &mut builder_ctx);
 268
 269     let jit_fn = module.declare_func_in_func(jit_fn, trampoline_builder.func);
 270     let sig_ref = trampoline_builder.func.import_signature(sig);
 271
 272     let entry_block = trampoline_builder.create_block();
 273     trampoline_builder.append_block_params_for_function_params(entry_block);
 274     let fn_args = trampoline_builder.func.dfg.block_params(entry_block).to_vec();
 275
 276     trampoline_builder.switch_to_block(entry_block);
 277     let instance_ptr = trampoline_builder.ins().iconst(pointer_type, instance_ptr as u64 as i64);
 278     let jitted_fn = trampoline_builder.ins().call(jit_fn, &[instance_ptr]);
 279     let jitted_fn = trampoline_builder.func.dfg.inst_results(jitted_fn)[0];
 280     let call_inst = trampoline_builder.ins().call_indirect(sig_ref, jitted_fn, &fn_args);
 281     let ret_vals = trampoline_builder.func.dfg.inst_results(call_inst).to_vec();
 282     trampoline_builder.ins().return_(&ret_vals);
 283
 284     module
 285         .define_function(
 286             func_id,
 287             &mut cx.cached_context,
 288             &mut NullTrapSink {},
 289             &mut NullStackMapSink {},
 290         )
 291         .unwrap();
 292 }