1 // Copyright 2016 The Rust Project Developers. See the COPYRIGHT
2 // file at the top-level directory of this distribution and at
3 // http://rust-lang.org/COPYRIGHT.
5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
8 // option. This file may not be copied, modified, or distributed
9 // except according to those terms.
11 //! Walks the crate looking for items/impl-items/trait-items that have
12 //! either a `rustc_symbol_name` or `rustc_item_path` attribute and
13 //! generates an error giving, respectively, the symbol name or
14 //! item-path. This is used for unit testing the code that generates
15 //! paths etc in all kinds of annoying scenarios.
20 use context::{CrateContext, SharedCrateContext};
23 use glue::DropGlueKind;
25 use monomorphize::Instance;
26 use rustc::dep_graph::DepNode;
28 use rustc::hir::def_id::DefId;
29 use rustc::hir::map::definitions::DefPathData;
30 use rustc::ty::{self, Ty, TyCtxt, TypeFoldable};
31 use rustc::ty::subst::Substs;
32 use rustc_const_eval::fatal_const_eval_err;
33 use syntax::ast::{self, NodeId};
37 use abi::{Abi, FnType};
38 use back::symbol_names;
42 #[derive(PartialEq, Eq, Clone, Copy, Debug, Hash)]
43 pub enum TransItem<'tcx> {
44 DropGlue(DropGlueKind<'tcx>),
49 /// Describes how a translation item will be instantiated in object files.
50 #[derive(PartialEq, Eq, Clone, Copy, Debug, Hash)]
51 pub enum InstantiationMode {
52 /// There will be exactly one instance of the given TransItem. It will have
53 /// external linkage so that it can be linked to from other codegen units.
56 /// Each codegen unit containing a reference to the given TransItem will
57 /// have its own private copy of the function (with internal linkage).
61 impl<'a, 'tcx> TransItem<'tcx> {
63 pub fn define(&self, ccx: &CrateContext<'a, 'tcx>) {
64 debug!("BEGIN IMPLEMENTING '{} ({})' in cgu {}",
65 self.to_string(ccx.tcx()),
67 ccx.codegen_unit().name());
69 // (*) This code executes in the context of a dep-node for the
70 // entire CGU. In some cases, we introduce dep-nodes for
71 // particular items that we are translating (these nodes will
72 // have read edges coming into the CGU node). These smaller
73 // nodes are not needed for correctness -- we always
74 // invalidate an entire CGU at a time -- but they enable
75 // finer-grained testing, since you can write tests that check
76 // that the incoming edges to a particular fn are from a
80 TransItem::Static(node_id) => {
81 let def_id = ccx.tcx().hir.local_def_id(node_id);
82 let _task = ccx.tcx().dep_graph.in_task(DepNode::TransCrateItem(def_id)); // (*)
83 let item = ccx.tcx().hir.expect_item(node_id);
84 if let hir::ItemStatic(_, m, _) = item.node {
85 match consts::trans_static(&ccx, m, item.id, &item.attrs) {
86 Ok(_) => { /* Cool, everything's alright. */ },
88 // FIXME: shouldn't this be a `span_err`?
90 ccx.tcx(), &err, item.span, "static");
94 span_bug!(item.span, "Mismatch between hir::Item type and TransItem type")
97 TransItem::Fn(instance) => {
98 let _task = ccx.tcx().dep_graph.in_task(
99 DepNode::TransCrateItem(instance.def_id())); // (*)
101 base::trans_instance(&ccx, instance);
103 TransItem::DropGlue(dg) => {
104 glue::implement_drop_glue(&ccx, dg);
108 debug!("END IMPLEMENTING '{} ({})' in cgu {}",
109 self.to_string(ccx.tcx()),
110 self.to_raw_string(),
111 ccx.codegen_unit().name());
114 pub fn predefine(&self,
115 ccx: &CrateContext<'a, 'tcx>,
116 linkage: llvm::Linkage) {
117 debug!("BEGIN PREDEFINING '{} ({})' in cgu {}",
118 self.to_string(ccx.tcx()),
119 self.to_raw_string(),
120 ccx.codegen_unit().name());
122 let symbol_name = ccx.symbol_map()
123 .get_or_compute(ccx.shared(), *self);
125 debug!("symbol {}", &symbol_name);
128 TransItem::Static(node_id) => {
129 TransItem::predefine_static(ccx, node_id, linkage, &symbol_name);
131 TransItem::Fn(instance) => {
132 TransItem::predefine_fn(ccx, instance, linkage, &symbol_name);
134 TransItem::DropGlue(dg) => {
135 TransItem::predefine_drop_glue(ccx, dg, linkage, &symbol_name);
139 debug!("END PREDEFINING '{} ({})' in cgu {}",
140 self.to_string(ccx.tcx()),
141 self.to_raw_string(),
142 ccx.codegen_unit().name());
145 fn predefine_static(ccx: &CrateContext<'a, 'tcx>,
146 node_id: ast::NodeId,
147 linkage: llvm::Linkage,
149 let def_id = ccx.tcx().hir.local_def_id(node_id);
150 let instance = Instance::mono(ccx.tcx(), def_id);
151 let ty = common::instance_ty(ccx.shared(), &instance);
152 let llty = type_of::type_of(ccx, ty);
154 let g = declare::define_global(ccx, symbol_name, llty).unwrap_or_else(|| {
155 ccx.sess().span_fatal(ccx.tcx().hir.span(node_id),
156 &format!("symbol `{}` is already defined", symbol_name))
159 unsafe { llvm::LLVMRustSetLinkage(g, linkage) };
161 ccx.instances().borrow_mut().insert(instance, g);
162 ccx.statics().borrow_mut().insert(g, def_id);
165 fn predefine_fn(ccx: &CrateContext<'a, 'tcx>,
166 instance: Instance<'tcx>,
167 linkage: llvm::Linkage,
169 assert!(!instance.substs.needs_infer() &&
170 !instance.substs.has_param_types());
172 let mono_ty = common::instance_ty(ccx.shared(), &instance);
173 let attrs = instance.def.attrs(ccx.tcx());
174 let lldecl = declare::declare_fn(ccx, symbol_name, mono_ty);
175 unsafe { llvm::LLVMRustSetLinkage(lldecl, linkage) };
176 base::set_link_section(ccx, lldecl, &attrs);
177 if linkage == llvm::Linkage::LinkOnceODRLinkage ||
178 linkage == llvm::Linkage::WeakODRLinkage {
179 llvm::SetUniqueComdat(ccx.llmod(), lldecl);
182 debug!("predefine_fn: mono_ty = {:?} instance = {:?}", mono_ty, instance);
183 match ccx.tcx().def_key(instance.def_id()).disambiguated_data.data {
184 DefPathData::StructCtor |
185 DefPathData::EnumVariant(..) |
186 DefPathData::ClosureExpr => {
187 attributes::inline(lldecl, attributes::InlineAttr::Hint);
192 attributes::from_fn_attrs(ccx, &attrs, lldecl);
194 ccx.instances().borrow_mut().insert(instance, lldecl);
197 fn predefine_drop_glue(ccx: &CrateContext<'a, 'tcx>,
198 dg: glue::DropGlueKind<'tcx>,
199 linkage: llvm::Linkage,
202 assert_eq!(dg.ty(), glue::get_drop_glue_type(ccx.shared(), dg.ty()));
205 let sig = tcx.mk_fn_sig(
206 iter::once(tcx.mk_mut_ptr(t)),
209 hir::Unsafety::Normal,
213 debug!("predefine_drop_glue: sig={}", sig);
215 let fn_ty = FnType::new(ccx, sig, &[]);
216 let llfnty = fn_ty.llvm_type(ccx);
218 assert!(declare::get_defined_value(ccx, symbol_name).is_none());
219 let llfn = declare::declare_cfn(ccx, symbol_name, llfnty);
220 unsafe { llvm::LLVMRustSetLinkage(llfn, linkage) };
221 if linkage == llvm::Linkage::LinkOnceODRLinkage ||
222 linkage == llvm::Linkage::WeakODRLinkage {
223 llvm::SetUniqueComdat(ccx.llmod(), llfn);
225 attributes::set_frame_pointer_elimination(ccx, llfn);
226 ccx.drop_glues().borrow_mut().insert(dg, (llfn, fn_ty));
229 pub fn compute_symbol_name(&self,
230 scx: &SharedCrateContext<'a, 'tcx>) -> String {
232 TransItem::Fn(instance) => symbol_names::symbol_name(instance, scx),
233 TransItem::Static(node_id) => {
234 let def_id = scx.tcx().hir.local_def_id(node_id);
235 symbol_names::symbol_name(Instance::mono(scx.tcx(), def_id), scx)
237 TransItem::DropGlue(dg) => {
238 let prefix = match dg {
239 DropGlueKind::Ty(_) => "drop",
240 DropGlueKind::TyContents(_) => "drop_contents",
242 symbol_names::exported_name_from_type_and_prefix(scx, dg.ty(), prefix)
247 pub fn instantiation_mode(&self,
248 tcx: TyCtxt<'a, 'tcx, 'tcx>)
249 -> InstantiationMode {
251 TransItem::Fn(ref instance) => {
252 if self.explicit_linkage(tcx).is_none() &&
253 common::requests_inline(tcx, instance)
255 InstantiationMode::LocalCopy
257 InstantiationMode::GloballyShared
260 TransItem::DropGlue(..) => InstantiationMode::LocalCopy,
261 TransItem::Static(..) => InstantiationMode::GloballyShared,
265 pub fn is_generic_fn(&self) -> bool {
267 TransItem::Fn(ref instance) => {
268 instance.substs.types().next().is_some()
270 TransItem::DropGlue(..) |
271 TransItem::Static(..) => false,
275 pub fn explicit_linkage(&self, tcx: TyCtxt<'a, 'tcx, 'tcx>) -> Option<llvm::Linkage> {
276 let def_id = match *self {
277 TransItem::Fn(ref instance) => instance.def_id(),
278 TransItem::Static(node_id) => tcx.hir.local_def_id(node_id),
279 TransItem::DropGlue(..) => return None,
282 let attributes = tcx.get_attrs(def_id);
283 if let Some(name) = attr::first_attr_value_str_by_name(&attributes, "linkage") {
284 if let Some(linkage) = base::llvm_linkage_by_name(&name.as_str()) {
287 let span = tcx.hir.span_if_local(def_id);
288 if let Some(span) = span {
289 tcx.sess.span_fatal(span, "invalid linkage specified")
291 tcx.sess.fatal(&format!("invalid linkage specified: {}", name))
299 pub fn to_string(&self, tcx: TyCtxt<'a, 'tcx, 'tcx>) -> String {
300 let hir_map = &tcx.hir;
303 TransItem::DropGlue(dg) => {
304 let mut s = String::with_capacity(32);
306 DropGlueKind::Ty(_) => s.push_str("drop-glue "),
307 DropGlueKind::TyContents(_) => s.push_str("drop-glue-contents "),
309 let printer = DefPathBasedNames::new(tcx, false, false);
310 printer.push_type_name(dg.ty(), &mut s);
313 TransItem::Fn(instance) => {
314 to_string_internal(tcx, "fn ", instance)
316 TransItem::Static(node_id) => {
317 let def_id = hir_map.local_def_id(node_id);
318 let instance = Instance::new(def_id, tcx.intern_substs(&[]));
319 to_string_internal(tcx, "static ", instance)
323 fn to_string_internal<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>,
325 instance: Instance<'tcx>)
327 let mut result = String::with_capacity(32);
328 result.push_str(prefix);
329 let printer = DefPathBasedNames::new(tcx, false, false);
330 printer.push_instance_as_string(instance, &mut result);
335 pub fn to_raw_string(&self) -> String {
337 TransItem::DropGlue(dg) => {
338 let prefix = match dg {
339 DropGlueKind::Ty(_) => "Ty",
340 DropGlueKind::TyContents(_) => "TyContents",
342 format!("DropGlue({}: {})", prefix, dg.ty() as *const _ as usize)
344 TransItem::Fn(instance) => {
345 format!("Fn({:?}, {})",
347 instance.substs.as_ptr() as usize)
349 TransItem::Static(id) => {
350 format!("Static({:?})", id)
357 //=-----------------------------------------------------------------------------
358 // TransItem String Keys
359 //=-----------------------------------------------------------------------------
361 // The code below allows for producing a unique string key for a trans item.
362 // These keys are used by the handwritten auto-tests, so they need to be
363 // predictable and human-readable.
365 // Note: A lot of this could looks very similar to what's already in the
366 // ppaux module. It would be good to refactor things so we only have one
367 // parameterizable implementation for printing types.
369 /// Same as `unique_type_name()` but with the result pushed onto the given
370 /// `output` parameter.
371 pub struct DefPathBasedNames<'a, 'tcx: 'a> {
372 tcx: TyCtxt<'a, 'tcx, 'tcx>,
373 omit_disambiguators: bool,
374 omit_local_crate_name: bool,
377 impl<'a, 'tcx> DefPathBasedNames<'a, 'tcx> {
378 pub fn new(tcx: TyCtxt<'a, 'tcx, 'tcx>,
379 omit_disambiguators: bool,
380 omit_local_crate_name: bool)
384 omit_disambiguators: omit_disambiguators,
385 omit_local_crate_name: omit_local_crate_name,
389 pub fn push_type_name(&self, t: Ty<'tcx>, output: &mut String) {
391 ty::TyBool => output.push_str("bool"),
392 ty::TyChar => output.push_str("char"),
393 ty::TyStr => output.push_str("str"),
394 ty::TyNever => output.push_str("!"),
395 ty::TyInt(ast::IntTy::Is) => output.push_str("isize"),
396 ty::TyInt(ast::IntTy::I8) => output.push_str("i8"),
397 ty::TyInt(ast::IntTy::I16) => output.push_str("i16"),
398 ty::TyInt(ast::IntTy::I32) => output.push_str("i32"),
399 ty::TyInt(ast::IntTy::I64) => output.push_str("i64"),
400 ty::TyInt(ast::IntTy::I128) => output.push_str("i128"),
401 ty::TyUint(ast::UintTy::Us) => output.push_str("usize"),
402 ty::TyUint(ast::UintTy::U8) => output.push_str("u8"),
403 ty::TyUint(ast::UintTy::U16) => output.push_str("u16"),
404 ty::TyUint(ast::UintTy::U32) => output.push_str("u32"),
405 ty::TyUint(ast::UintTy::U64) => output.push_str("u64"),
406 ty::TyUint(ast::UintTy::U128) => output.push_str("u128"),
407 ty::TyFloat(ast::FloatTy::F32) => output.push_str("f32"),
408 ty::TyFloat(ast::FloatTy::F64) => output.push_str("f64"),
409 ty::TyAdt(adt_def, substs) => {
410 self.push_def_path(adt_def.did, output);
411 self.push_type_params(substs, iter::empty(), output);
413 ty::TyTuple(component_types, _) => {
415 for &component_type in component_types {
416 self.push_type_name(component_type, output);
417 output.push_str(", ");
419 if !component_types.is_empty() {
425 ty::TyRawPtr(ty::TypeAndMut { ty: inner_type, mutbl } ) => {
428 hir::MutImmutable => output.push_str("const "),
429 hir::MutMutable => output.push_str("mut "),
432 self.push_type_name(inner_type, output);
434 ty::TyRef(_, ty::TypeAndMut { ty: inner_type, mutbl }) => {
436 if mutbl == hir::MutMutable {
437 output.push_str("mut ");
440 self.push_type_name(inner_type, output);
442 ty::TyArray(inner_type, len) => {
444 self.push_type_name(inner_type, output);
445 write!(output, "; {}", len).unwrap();
448 ty::TySlice(inner_type) => {
450 self.push_type_name(inner_type, output);
453 ty::TyDynamic(ref trait_data, ..) => {
454 if let Some(principal) = trait_data.principal() {
455 self.push_def_path(principal.def_id(), output);
456 self.push_type_params(principal.skip_binder().substs,
457 trait_data.projection_bounds(),
461 ty::TyFnDef(.., sig) |
462 ty::TyFnPtr(sig) => {
463 if sig.unsafety() == hir::Unsafety::Unsafe {
464 output.push_str("unsafe ");
468 if abi != ::abi::Abi::Rust {
469 output.push_str("extern \"");
470 output.push_str(abi.name());
471 output.push_str("\" ");
474 output.push_str("fn(");
476 let sig = self.tcx.erase_late_bound_regions_and_normalize(&sig);
478 if !sig.inputs().is_empty() {
479 for ¶meter_type in sig.inputs() {
480 self.push_type_name(parameter_type, output);
481 output.push_str(", ");
488 if !sig.inputs().is_empty() {
489 output.push_str(", ...");
491 output.push_str("...");
497 if !sig.output().is_nil() {
498 output.push_str(" -> ");
499 self.push_type_name(sig.output(), output);
502 ty::TyClosure(def_id, ref closure_substs) => {
503 self.push_def_path(def_id, output);
504 let generics = self.tcx.item_generics(self.tcx.closure_base_def_id(def_id));
505 let substs = closure_substs.substs.truncate_to(self.tcx, generics);
506 self.push_type_params(substs, iter::empty(), output);
510 ty::TyProjection(..) |
513 bug!("DefPathBasedNames: Trying to create type name for \
514 unexpected type: {:?}", t);
519 pub fn push_def_path(&self,
521 output: &mut String) {
522 let def_path = self.tcx.def_path(def_id);
525 if !(self.omit_local_crate_name && def_id.is_local()) {
526 output.push_str(&self.tcx.crate_name(def_path.krate).as_str());
527 output.push_str("::");
530 // foo::bar::ItemName::
531 for part in self.tcx.def_path(def_id).data {
532 if self.omit_disambiguators {
533 write!(output, "{}::", part.data.as_interned_str()).unwrap();
535 write!(output, "{}[{}]::",
536 part.data.as_interned_str(),
537 part.disambiguator).unwrap();
546 fn push_type_params<I>(&self,
547 substs: &Substs<'tcx>,
550 where I: Iterator<Item=ty::PolyExistentialProjection<'tcx>>
552 let mut projections = projections.peekable();
553 if substs.types().next().is_none() && projections.peek().is_none() {
559 for type_parameter in substs.types() {
560 self.push_type_name(type_parameter, output);
561 output.push_str(", ");
564 for projection in projections {
565 let projection = projection.skip_binder();
566 let name = &projection.item_name.as_str();
567 output.push_str(name);
568 output.push_str("=");
569 self.push_type_name(projection.ty, output);
570 output.push_str(", ");
579 pub fn push_instance_as_string(&self,
580 instance: Instance<'tcx>,
581 output: &mut String) {
582 self.push_def_path(instance.def_id(), output);
583 self.push_type_params(instance.substs, iter::empty(), output);