src/driver/aot.rs

   1 //! The AOT driver uses [`cranelift_object`] to write object files suitable for linking into a
   2 //! standalone executable.
   3
   4 use std::path::PathBuf;
   5
   6 use rustc_ast::{InlineAsmOptions, InlineAsmTemplatePiece};
   7 use rustc_codegen_ssa::back::linker::LinkerInfo;
   8 use rustc_codegen_ssa::{CodegenResults, CompiledModule, CrateInfo, ModuleKind};
   9 use rustc_data_structures::stable_hasher::{HashStable, StableHasher};
  10 use rustc_middle::dep_graph::{WorkProduct, WorkProductId};
  11 use rustc_middle::middle::cstore::EncodedMetadata;
  12 use rustc_middle::mir::mono::{CodegenUnit, MonoItem};
  13 use rustc_session::cgu_reuse_tracker::CguReuse;
  14 use rustc_session::config::{DebugInfo, OutputType};
  15
  16 use cranelift_object::ObjectModule;
  17
  18 use crate::{prelude::*, BackendConfig};
  19
  20 struct ModuleCodegenResult(CompiledModule, Option<(WorkProductId, WorkProduct)>);
  21
  22 impl<HCX> HashStable<HCX> for ModuleCodegenResult {
  23     fn hash_stable(&self, _: &mut HCX, _: &mut StableHasher) {
  24         // do nothing
  25     }
  26 }
  27
  28 fn emit_module(
  29     tcx: TyCtxt<'_>,
  30     backend_config: &BackendConfig,
  31     name: String,
  32     kind: ModuleKind,
  33     module: ObjectModule,
  34     debug: Option<DebugContext<'_>>,
  35     unwind_context: UnwindContext,
  36 ) -> ModuleCodegenResult {
  37     let mut product = module.finish();
  38
  39     if let Some(mut debug) = debug {
  40         debug.emit(&mut product);
  41     }
  42
  43     unwind_context.emit(&mut product);
  44
  45     let tmp_file = tcx.output_filenames(()).temp_path(OutputType::Object, Some(&name));
  46     let obj = product.object.write().unwrap();
  47     if let Err(err) = std::fs::write(&tmp_file, obj) {
  48         tcx.sess.fatal(&format!("error writing object file: {}", err));
  49     }
  50
  51     let work_product = if backend_config.disable_incr_cache {
  52         None
  53     } else {
  54         rustc_incremental::copy_cgu_workproduct_to_incr_comp_cache_dir(
  55             tcx.sess,
  56             &name,
  57             &Some(tmp_file.clone()),
  58         )
  59     };
  60
  61     ModuleCodegenResult(
  62         CompiledModule { name, kind, object: Some(tmp_file), dwarf_object: None, bytecode: None },
  63         work_product,
  64     )
  65 }
  66
  67 fn reuse_workproduct_for_cgu(
  68     tcx: TyCtxt<'_>,
  69     cgu: &CodegenUnit<'_>,
  70     work_products: &mut FxHashMap<WorkProductId, WorkProduct>,
  71 ) -> CompiledModule {
  72     let incr_comp_session_dir = tcx.sess.incr_comp_session_dir();
  73     let mut object = None;
  74     let work_product = cgu.work_product(tcx);
  75     if let Some(saved_file) = &work_product.saved_file {
  76         let obj_out = tcx
  77             .output_filenames(())
  78             .temp_path(OutputType::Object, Some(&cgu.name().as_str()));
  79         object = Some(obj_out.clone());
  80         let source_file = rustc_incremental::in_incr_comp_dir(&incr_comp_session_dir, &saved_file);
  81         if let Err(err) = rustc_fs_util::link_or_copy(&source_file, &obj_out) {
  82             tcx.sess.err(&format!(
  83                 "unable to copy {} to {}: {}",
  84                 source_file.display(),
  85                 obj_out.display(),
  86                 err
  87             ));
  88         }
  89     }
  90
  91     work_products.insert(cgu.work_product_id(), work_product);
  92
  93     CompiledModule {
  94         name: cgu.name().to_string(),
  95         kind: ModuleKind::Regular,
  96         object,
  97         dwarf_object: None,
  98         bytecode: None,
  99     }
 100 }
 101
 102 fn module_codegen(
 103     tcx: TyCtxt<'_>,
 104     (backend_config, cgu_name): (BackendConfig, rustc_span::Symbol),
 105 ) -> ModuleCodegenResult {
 106     let cgu = tcx.codegen_unit(cgu_name);
 107     let mono_items = cgu.items_in_deterministic_order(tcx);
 108
 109     let isa = crate::build_isa(tcx.sess, &backend_config);
 110     let mut module = crate::backend::make_module(tcx.sess, isa, cgu_name.as_str().to_string());
 111
 112     let mut cx = crate::CodegenCx::new(
 113         tcx,
 114         backend_config.clone(),
 115         module.isa(),
 116         tcx.sess.opts.debuginfo != DebugInfo::None,
 117     );
 118     super::predefine_mono_items(tcx, &mut module, &mono_items);
 119     for (mono_item, _) in mono_items {
 120         match mono_item {
 121             MonoItem::Fn(inst) => {
 122                 cx.tcx
 123                     .sess
 124                     .time("codegen fn", || crate::base::codegen_fn(&mut cx, &mut module, inst));
 125             }
 126             MonoItem::Static(def_id) => crate::constant::codegen_static(tcx, &mut module, def_id),
 127             MonoItem::GlobalAsm(item_id) => {
 128                 let item = cx.tcx.hir().item(item_id);
 129                 if let rustc_hir::ItemKind::GlobalAsm(asm) = item.kind {
 130                     if !asm.options.contains(InlineAsmOptions::ATT_SYNTAX) {
 131                         cx.global_asm.push_str("\n.intel_syntax noprefix\n");
 132                     } else {
 133                         cx.global_asm.push_str("\n.att_syntax\n");
 134                     }
 135                     for piece in asm.template {
 136                         match *piece {
 137                             InlineAsmTemplatePiece::String(ref s) => cx.global_asm.push_str(s),
 138                             InlineAsmTemplatePiece::Placeholder { .. } => todo!(),
 139                         }
 140                     }
 141                     cx.global_asm.push_str("\n.att_syntax\n\n");
 142                 } else {
 143                     bug!("Expected GlobalAsm found {:?}", item);
 144                 }
 145             }
 146         }
 147     }
 148     crate::main_shim::maybe_create_entry_wrapper(
 149         tcx,
 150         &mut module,
 151         &mut cx.unwind_context,
 152         false,
 153         cgu.is_primary(),
 154     );
 155
 156     let debug_context = cx.debug_context;
 157     let unwind_context = cx.unwind_context;
 158     let codegen_result = tcx.sess.time("write object file", || {
 159         emit_module(
 160             tcx,
 161             &backend_config,
 162             cgu.name().as_str().to_string(),
 163             ModuleKind::Regular,
 164             module,
 165             debug_context,
 166             unwind_context,
 167         )
 168     });
 169
 170     codegen_global_asm(tcx, &cgu.name().as_str(), &cx.global_asm);
 171
 172     codegen_result
 173 }
 174
 175 pub(crate) fn run_aot(
 176     tcx: TyCtxt<'_>,
 177     backend_config: BackendConfig,
 178     metadata: EncodedMetadata,
 179     need_metadata_module: bool,
 180 ) -> Box<(CodegenResults, FxHashMap<WorkProductId, WorkProduct>)> {
 181     use rustc_span::symbol::sym;
 182
 183     let crate_attrs = tcx.hir().attrs(rustc_hir::CRATE_HIR_ID);
 184     let subsystem = tcx.sess.first_attr_value_str_by_name(crate_attrs, sym::windows_subsystem);
 185     let windows_subsystem = subsystem.map(|subsystem| {
 186         if subsystem != sym::windows && subsystem != sym::console {
 187             tcx.sess.fatal(&format!(
 188                 "invalid windows subsystem `{}`, only \
 189                                     `windows` and `console` are allowed",
 190                 subsystem
 191             ));
 192         }
 193         subsystem.to_string()
 194     });
 195
 196     let mut work_products = FxHashMap::default();
 197
 198     let cgus = if tcx.sess.opts.output_types.should_codegen() {
 199         tcx.collect_and_partition_mono_items(()).1
 200     } else {
 201         // If only `--emit metadata` is used, we shouldn't perform any codegen.
 202         // Also `tcx.collect_and_partition_mono_items` may panic in that case.
 203         &[]
 204     };
 205
 206     if tcx.dep_graph.is_fully_enabled() {
 207         for cgu in &*cgus {
 208             tcx.ensure().codegen_unit(cgu.name());
 209         }
 210     }
 211
 212     let modules = super::time(tcx, backend_config.display_cg_time, "codegen mono items", || {
 213         cgus.iter()
 214             .map(|cgu| {
 215                 let cgu_reuse = determine_cgu_reuse(tcx, cgu);
 216                 tcx.sess.cgu_reuse_tracker.set_actual_reuse(&cgu.name().as_str(), cgu_reuse);
 217
 218                 match cgu_reuse {
 219                     _ if backend_config.disable_incr_cache => {}
 220                     CguReuse::No => {}
 221                     CguReuse::PreLto => {
 222                         return reuse_workproduct_for_cgu(tcx, &*cgu, &mut work_products);
 223                     }
 224                     CguReuse::PostLto => unreachable!(),
 225                 }
 226
 227                 let dep_node = cgu.codegen_dep_node(tcx);
 228                 let (ModuleCodegenResult(module, work_product), _) = tcx.dep_graph.with_task(
 229                     dep_node,
 230                     tcx,
 231                     (backend_config.clone(), cgu.name()),
 232                     module_codegen,
 233                     rustc_middle::dep_graph::hash_result,
 234                 );
 235
 236                 if let Some((id, product)) = work_product {
 237                     work_products.insert(id, product);
 238                 }
 239
 240                 module
 241             })
 242             .collect::<Vec<_>>()
 243     });
 244
 245     tcx.sess.abort_if_errors();
 246
 247     let isa = crate::build_isa(tcx.sess, &backend_config);
 248     let mut allocator_module =
 249         crate::backend::make_module(tcx.sess, isa, "allocator_shim".to_string());
 250     assert_eq!(pointer_ty(tcx), allocator_module.target_config().pointer_type());
 251     let mut allocator_unwind_context = UnwindContext::new(tcx, allocator_module.isa(), true);
 252     let created_alloc_shim =
 253         crate::allocator::codegen(tcx, &mut allocator_module, &mut allocator_unwind_context);
 254
 255     let allocator_module = if created_alloc_shim {
 256         let ModuleCodegenResult(module, work_product) = emit_module(
 257             tcx,
 258             &backend_config,
 259             "allocator_shim".to_string(),
 260             ModuleKind::Allocator,
 261             allocator_module,
 262             None,
 263             allocator_unwind_context,
 264         );
 265         if let Some((id, product)) = work_product {
 266             work_products.insert(id, product);
 267         }
 268         Some(module)
 269     } else {
 270         None
 271     };
 272
 273     let metadata_module = if need_metadata_module {
 274         let _timer = tcx.prof.generic_activity("codegen crate metadata");
 275         let (metadata_cgu_name, tmp_file) = tcx.sess.time("write compressed metadata", || {
 276             use rustc_middle::mir::mono::CodegenUnitNameBuilder;
 277
 278             let cgu_name_builder = &mut CodegenUnitNameBuilder::new(tcx);
 279             let metadata_cgu_name = cgu_name_builder
 280                 .build_cgu_name(LOCAL_CRATE, &["crate"], Some("metadata"))
 281                 .as_str()
 282                 .to_string();
 283
 284             let tmp_file = tcx
 285                 .output_filenames(())
 286                 .temp_path(OutputType::Metadata, Some(&metadata_cgu_name));
 287
 288             let obj = crate::backend::with_object(tcx.sess, &metadata_cgu_name, |object| {
 289                 crate::metadata::write_metadata(tcx, object);
 290             });
 291
 292             if let Err(err) = std::fs::write(&tmp_file, obj) {
 293                 tcx.sess.fatal(&format!("error writing metadata object file: {}", err));
 294             }
 295
 296             (metadata_cgu_name, tmp_file)
 297         });
 298
 299         Some(CompiledModule {
 300             name: metadata_cgu_name,
 301             kind: ModuleKind::Metadata,
 302             object: Some(tmp_file),
 303             dwarf_object: None,
 304             bytecode: None,
 305         })
 306     } else {
 307         None
 308     };
 309
 310     Box::new((
 311         CodegenResults {
 312             crate_name: tcx.crate_name(LOCAL_CRATE),
 313             modules,
 314             allocator_module,
 315             metadata_module,
 316             metadata,
 317             windows_subsystem,
 318             linker_info: LinkerInfo::new(tcx, crate::target_triple(tcx.sess).to_string()),
 319             crate_info: CrateInfo::new(tcx),
 320         },
 321         work_products,
 322     ))
 323 }
 324
 325 fn codegen_global_asm(tcx: TyCtxt<'_>, cgu_name: &str, global_asm: &str) {
 326     use std::io::Write;
 327     use std::process::{Command, Stdio};
 328
 329     if global_asm.is_empty() {
 330         return;
 331     }
 332
 333     if cfg!(not(feature = "inline_asm"))
 334         || tcx.sess.target.is_like_osx
 335         || tcx.sess.target.is_like_windows
 336     {
 337         if global_asm.contains("__rust_probestack") {
 338             return;
 339         }
 340
 341         // FIXME fix linker error on macOS
 342         if cfg!(not(feature = "inline_asm")) {
 343             tcx.sess.fatal(
 344                 "asm! and global_asm! support is disabled while compiling rustc_codegen_cranelift",
 345             );
 346         } else {
 347             tcx.sess.fatal("asm! and global_asm! are not yet supported on macOS and Windows");
 348         }
 349     }
 350
 351     let assembler = crate::toolchain::get_toolchain_binary(tcx.sess, "as");
 352     let linker = crate::toolchain::get_toolchain_binary(tcx.sess, "ld");
 353
 354     // Remove all LLVM style comments
 355     let global_asm = global_asm
 356         .lines()
 357         .map(|line| if let Some(index) = line.find("//") { &line[0..index] } else { line })
 358         .collect::<Vec<_>>()
 359         .join("\n");
 360
 361     let output_object_file =
 362         tcx.output_filenames(()).temp_path(OutputType::Object, Some(cgu_name));
 363
 364     // Assemble `global_asm`
 365     let global_asm_object_file = add_file_stem_postfix(output_object_file.clone(), ".asm");
 366     let mut child = Command::new(assembler)
 367         .arg("-o")
 368         .arg(&global_asm_object_file)
 369         .stdin(Stdio::piped())
 370         .spawn()
 371         .expect("Failed to spawn `as`.");
 372     child.stdin.take().unwrap().write_all(global_asm.as_bytes()).unwrap();
 373     let status = child.wait().expect("Failed to wait for `as`.");
 374     if !status.success() {
 375         tcx.sess.fatal(&format!("Failed to assemble `{}`", global_asm));
 376     }
 377
 378     // Link the global asm and main object file together
 379     let main_object_file = add_file_stem_postfix(output_object_file.clone(), ".main");
 380     std::fs::rename(&output_object_file, &main_object_file).unwrap();
 381     let status = Command::new(linker)
 382         .arg("-r") // Create a new object file
 383         .arg("-o")
 384         .arg(output_object_file)
 385         .arg(&main_object_file)
 386         .arg(&global_asm_object_file)
 387         .status()
 388         .unwrap();
 389     if !status.success() {
 390         tcx.sess.fatal(&format!(
 391             "Failed to link `{}` and `{}` together",
 392             main_object_file.display(),
 393             global_asm_object_file.display(),
 394         ));
 395     }
 396
 397     std::fs::remove_file(global_asm_object_file).unwrap();
 398     std::fs::remove_file(main_object_file).unwrap();
 399 }
 400
 401 fn add_file_stem_postfix(mut path: PathBuf, postfix: &str) -> PathBuf {
 402     let mut new_filename = path.file_stem().unwrap().to_owned();
 403     new_filename.push(postfix);
 404     if let Some(extension) = path.extension() {
 405         new_filename.push(".");
 406         new_filename.push(extension);
 407     }
 408     path.set_file_name(new_filename);
 409     path
 410 }
 411
 412 // Adapted from https://github.com/rust-lang/rust/blob/303d8aff6092709edd4dbd35b1c88e9aa40bf6d8/src/librustc_codegen_ssa/base.rs#L922-L953
 413 fn determine_cgu_reuse<'tcx>(tcx: TyCtxt<'tcx>, cgu: &CodegenUnit<'tcx>) -> CguReuse {
 414     if !tcx.dep_graph.is_fully_enabled() {
 415         return CguReuse::No;
 416     }
 417
 418     let work_product_id = &cgu.work_product_id();
 419     if tcx.dep_graph.previous_work_product(work_product_id).is_none() {
 420         // We don't have anything cached for this CGU. This can happen
 421         // if the CGU did not exist in the previous session.
 422         return CguReuse::No;
 423     }
 424
 425     // Try to mark the CGU as green. If it we can do so, it means that nothing
 426     // affecting the LLVM module has changed and we can re-use a cached version.
 427     // If we compile with any kind of LTO, this means we can re-use the bitcode
 428     // of the Pre-LTO stage (possibly also the Post-LTO version but we'll only
 429     // know that later). If we are not doing LTO, there is only one optimized
 430     // version of each module, so we re-use that.
 431     let dep_node = cgu.codegen_dep_node(tcx);
 432     assert!(
 433         !tcx.dep_graph.dep_node_exists(&dep_node),
 434         "CompileCodegenUnit dep-node for CGU `{}` already exists before marking.",
 435         cgu.name()
 436     );
 437
 438     if tcx.try_mark_green(&dep_node) { CguReuse::PreLto } else { CguReuse::No }
 439 }