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