src/lib.rs

   1 #![feature(rustc_private, decl_macro, type_alias_impl_trait, associated_type_bounds, never_type)]
   2 #![allow(intra_doc_link_resolution_failure)]
   3 #![warn(rust_2018_idioms)]
   4 #![warn(unused_lifetimes)]
   5
   6 extern crate flate2;
   7 #[cfg(feature = "jit")]
   8 extern crate libc;
   9 extern crate rustc_middle;
  10 extern crate rustc_codegen_ssa;
  11 extern crate rustc_data_structures;
  12 extern crate rustc_errors;
  13 extern crate rustc_fs_util;
  14 extern crate rustc_hir;
  15 extern crate rustc_incremental;
  16 extern crate rustc_index;
  17 extern crate rustc_mir;
  18 extern crate rustc_session;
  19 extern crate rustc_span;
  20 extern crate rustc_symbol_mangling;
  21 extern crate rustc_target;
  22 extern crate rustc_ast;
  23
  24 // This prevents duplicating functions and statics that are already part of the host rustc process.
  25 #[allow(unused_extern_crates)]
  26 extern crate rustc_driver;
  27
  28 use std::any::Any;
  29
  30 use rustc_errors::ErrorReported;
  31 use rustc_middle::dep_graph::{DepGraph, WorkProduct, WorkProductId};
  32 use rustc_middle::middle::cstore::{EncodedMetadata, MetadataLoader};
  33 use rustc_session::Session;
  34 use rustc_session::config::OutputFilenames;
  35 use rustc_middle::ty::query::Providers;
  36 use rustc_codegen_ssa::CodegenResults;
  37 use rustc_codegen_ssa::traits::CodegenBackend;
  38
  39 use cranelift_codegen::settings::{self, Configurable};
  40
  41 use crate::constant::ConstantCx;
  42 use crate::prelude::*;
  43
  44 mod abi;
  45 mod allocator;
  46 mod analyze;
  47 mod archive;
  48 mod atomic_shim;
  49 mod base;
  50 mod backend;
  51 mod cast;
  52 mod codegen_i128;
  53 mod common;
  54 mod constant;
  55 mod debuginfo;
  56 mod discriminant;
  57 mod driver;
  58 mod intrinsics;
  59 mod linkage;
  60 mod main_shim;
  61 mod metadata;
  62 mod num;
  63 mod optimize;
  64 mod pointer;
  65 mod pretty_clif;
  66 mod target_features_whitelist;
  67 mod toolchain;
  68 mod trap;
  69 mod unsize;
  70 mod value_and_place;
  71 mod vtable;
  72
  73 mod prelude {
  74     pub(crate) use std::convert::{TryFrom, TryInto};
  75
  76     pub(crate) use rustc_ast::ast::{FloatTy, IntTy, UintTy};
  77     pub(crate) use rustc_span::Span;
  78
  79     pub(crate) use rustc_middle::bug;
  80     pub(crate) use rustc_hir::def_id::{DefId, LOCAL_CRATE};
  81     pub(crate) use rustc_middle::mir::{self, *};
  82     pub(crate) use rustc_middle::ty::layout::{self, TyAndLayout};
  83     pub(crate) use rustc_target::abi::{Abi, LayoutOf, Scalar, Size, VariantIdx};
  84     pub(crate) use rustc_middle::ty::{
  85         self, FnSig, Instance, InstanceDef, ParamEnv, Ty, TyCtxt, TypeAndMut, TypeFoldable,
  86     };
  87
  88     pub(crate) use rustc_data_structures::fx::FxHashMap;
  89
  90     pub(crate) use rustc_index::vec::Idx;
  91
  92     pub(crate) use cranelift_codegen::Context;
  93     pub(crate) use cranelift_codegen::entity::EntitySet;
  94     pub(crate) use cranelift_codegen::ir::{AbiParam, Block, ExternalName, FuncRef, Inst, InstBuilder, MemFlags, Signature, SourceLoc, StackSlot, StackSlotData, StackSlotKind, TrapCode, Type, Value};
  95     pub(crate) use cranelift_codegen::ir::condcodes::{FloatCC, IntCC};
  96     pub(crate) use cranelift_codegen::ir::function::Function;
  97     pub(crate) use cranelift_codegen::ir::types;
  98     pub(crate) use cranelift_codegen::isa::{self, CallConv};
  99     pub(crate) use cranelift_frontend::{FunctionBuilder, FunctionBuilderContext, Variable};
 100     pub(crate) use cranelift_module::{
 101         self, Backend, DataContext, DataId, FuncId, Linkage, Module,
 102     };
 103
 104     pub(crate) use crate::abi::*;
 105     pub(crate) use crate::base::{trans_operand, trans_place};
 106     pub(crate) use crate::cast::*;
 107     pub(crate) use crate::common::*;
 108     pub(crate) use crate::debuginfo::{DebugContext, UnwindContext};
 109     pub(crate) use crate::pointer::Pointer;
 110     pub(crate) use crate::trap::*;
 111     pub(crate) use crate::value_and_place::{CPlace, CPlaceInner, CValue};
 112 }
 113
 114 struct PrintOnPanic<F: Fn() -> String>(F);
 115 impl<F: Fn() -> String> Drop for PrintOnPanic<F> {
 116     fn drop(&mut self) {
 117         if ::std::thread::panicking() {
 118             println!("{}", (self.0)());
 119         }
 120     }
 121 }
 122
 123 struct CodegenCx<'tcx, B: Backend + 'static> {
 124     tcx: TyCtxt<'tcx>,
 125     module: Module<B>,
 126     constants_cx: ConstantCx,
 127     cached_context: Context,
 128     vtables: FxHashMap<(Ty<'tcx>, Option<ty::PolyExistentialTraitRef<'tcx>>), DataId>,
 129     debug_context: Option<DebugContext<'tcx>>,
 130     unwind_context: UnwindContext<'tcx>,
 131 }
 132
 133 impl<'tcx, B: Backend + 'static> CodegenCx<'tcx, B> {
 134     fn new(
 135         tcx: TyCtxt<'tcx>,
 136         module: Module<B>,
 137         debug_info: bool,
 138     ) -> Self {
 139         let unwind_context = UnwindContext::new(tcx, module.isa());
 140         let debug_context = if debug_info {
 141             Some(DebugContext::new(
 142                 tcx,
 143                 module.isa(),
 144             ))
 145         } else {
 146             None
 147         };
 148         CodegenCx {
 149             tcx,
 150             module,
 151             constants_cx: ConstantCx::default(),
 152             cached_context: Context::new(),
 153             vtables: FxHashMap::default(),
 154             debug_context,
 155             unwind_context,
 156         }
 157     }
 158
 159     fn finalize(mut self) -> (Module<B>, Option<DebugContext<'tcx>>, UnwindContext<'tcx>) {
 160         self.constants_cx.finalize(self.tcx, &mut self.module);
 161         (self.module, self.debug_context, self.unwind_context)
 162     }
 163 }
 164
 165 struct CraneliftCodegenBackend;
 166
 167 impl CodegenBackend for CraneliftCodegenBackend {
 168     fn init(&self, sess: &Session) {
 169         if sess.lto() != rustc_session::config::Lto::No && sess.opts.cg.embed_bitcode {
 170             sess.warn("LTO is not supported. You may get a linker error.");
 171         }
 172     }
 173
 174     fn metadata_loader(&self) -> Box<dyn MetadataLoader + Sync> {
 175         Box::new(crate::metadata::CraneliftMetadataLoader)
 176     }
 177
 178     fn provide(&self, providers: &mut Providers<'_>) {
 179         providers.target_features_whitelist = |tcx, cnum| {
 180             assert_eq!(cnum, LOCAL_CRATE);
 181             if tcx.sess.opts.actually_rustdoc {
 182                 // rustdoc needs to be able to document functions that use all the features, so
 183                 // whitelist them all
 184                 target_features_whitelist::all_known_features()
 185                     .chain(Some(("cg_clif", None)))
 186                     .map(|(a, b)| (a.to_string(), b))
 187                     .collect()
 188             } else {
 189                 target_features_whitelist::target_feature_whitelist(tcx.sess)
 190                     .iter()
 191                     .chain(&Some(("cg_clif", None)))
 192                     .map(|&(a, b)| (a.to_string(), b))
 193                     .collect()
 194             }
 195         };
 196     }
 197     fn provide_extern(&self, _providers: &mut Providers<'_>) {}
 198
 199     fn target_features(&self, _sess: &Session) -> Vec<rustc_span::Symbol> {
 200         vec![rustc_span::Symbol::intern("cg_clif")]
 201     }
 202
 203     fn codegen_crate<'tcx>(
 204         &self,
 205         tcx: TyCtxt<'tcx>,
 206         metadata: EncodedMetadata,
 207         need_metadata_module: bool,
 208     ) -> Box<dyn Any> {
 209         let res = driver::codegen_crate(tcx, metadata, need_metadata_module);
 210
 211         rustc_symbol_mangling::test::report_symbol_names(tcx);
 212
 213         res
 214     }
 215
 216     fn join_codegen(
 217         &self,
 218         ongoing_codegen: Box<dyn Any>,
 219         sess: &Session,
 220         dep_graph: &DepGraph,
 221     ) -> Result<Box<dyn Any>, ErrorReported> {
 222         let (codegen_results, work_products) = *ongoing_codegen.downcast::<(CodegenResults, FxHashMap<WorkProductId, WorkProduct>)>().unwrap();
 223
 224         sess.time("serialize_work_products", move || {
 225             rustc_incremental::save_work_product_index(sess, &dep_graph, work_products)
 226         });
 227
 228         Ok(Box::new(codegen_results))
 229     }
 230
 231     fn link(
 232         &self,
 233         sess: &Session,
 234         res: Box<dyn Any>,
 235         outputs: &OutputFilenames,
 236     ) -> Result<(), ErrorReported> {
 237         use rustc_codegen_ssa::back::link::link_binary;
 238
 239         sess.abort_if_errors();
 240
 241         let codegen_results = *res
 242             .downcast::<CodegenResults>()
 243             .expect("Expected CraneliftCodegenBackend's CodegenResult, found Box<Any>");
 244
 245         let _timer = sess.prof.generic_activity("link_crate");
 246
 247         sess.time("linking", || {
 248             let target_cpu = crate::target_triple(sess).to_string();
 249             link_binary::<crate::archive::ArArchiveBuilder<'_>>(
 250                 sess,
 251                 &codegen_results,
 252                 outputs,
 253                 &codegen_results.crate_name.as_str(),
 254                 &target_cpu,
 255             );
 256         });
 257
 258         rustc_incremental::finalize_session_directory(sess, codegen_results.crate_hash);
 259
 260         Ok(())
 261     }
 262 }
 263
 264 fn target_triple(sess: &Session) -> target_lexicon::Triple {
 265     sess.target.target.llvm_target.parse().unwrap()
 266 }
 267
 268 fn build_isa(sess: &Session, enable_pic: bool) -> Box<dyn isa::TargetIsa + 'static> {
 269     use target_lexicon::BinaryFormat;
 270
 271     let target_triple = crate::target_triple(sess);
 272
 273     let mut flags_builder = settings::builder();
 274     if enable_pic {
 275         flags_builder.enable("is_pic").unwrap();
 276     } else {
 277         flags_builder.set("is_pic", "false").unwrap();
 278     }
 279     flags_builder.set("enable_probestack", "false").unwrap(); // __cranelift_probestack is not provided
 280     flags_builder
 281         .set(
 282             "enable_verifier",
 283             if cfg!(debug_assertions) {
 284                 "true"
 285             } else {
 286                 "false"
 287             },
 288         )
 289         .unwrap();
 290
 291     let tls_model = match target_triple.binary_format {
 292         BinaryFormat::Elf => "elf_gd",
 293         BinaryFormat::Macho => "macho",
 294         BinaryFormat::Coff => "coff",
 295         _ => "none",
 296     };
 297     flags_builder.set("tls_model", tls_model).unwrap();
 298
 299     // FIXME(CraneStation/cranelift#732) fix LICM in presence of jump tables
 300     /*
 301     use rustc_session::config::OptLevel;
 302     match sess.opts.optimize {
 303         OptLevel::No => {
 304             flags_builder.set("opt_level", "none").unwrap();
 305         }
 306         OptLevel::Less | OptLevel::Default => {}
 307         OptLevel::Aggressive => {
 308             flags_builder.set("opt_level", "speed_and_size").unwrap();
 309         }
 310         OptLevel::Size | OptLevel::SizeMin => {
 311             sess.warn("Optimizing for size is not supported. Just ignoring the request");
 312         }
 313     }*/
 314
 315     let flags = settings::Flags::new(flags_builder);
 316     cranelift_codegen::isa::lookup(target_triple)
 317         .unwrap()
 318         .finish(flags)
 319 }
 320
 321 /// This is the entrypoint for a hot plugged rustc_codegen_cranelift
 322 #[no_mangle]
 323 pub fn __rustc_codegen_backend() -> Box<dyn CodegenBackend> {
 324     Box::new(CraneliftCodegenBackend)
 325 }