1 // Copyright 2014 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 //! Translation Item Collection
12 //! ===========================
14 //! This module is responsible for discovering all items that will contribute to
15 //! to code generation of the crate. The important part here is that it not only
16 //! needs to find syntax-level items (functions, structs, etc) but also all
17 //! their monomorphized instantiations. Every non-generic, non-const function
18 //! maps to one LLVM artifact. Every generic function can produce
19 //! from zero to N artifacts, depending on the sets of type arguments it
20 //! is instantiated with.
21 //! This also applies to generic items from other crates: A generic definition
22 //! in crate X might produce monomorphizations that are compiled into crate Y.
23 //! We also have to collect these here.
25 //! The following kinds of "translation items" are handled here:
33 //! The following things also result in LLVM artifacts, but are not collected
34 //! here, since we instantiate them locally on demand when needed in a given
44 //! Let's define some terms first:
46 //! - A "translation item" is something that results in a function or global in
47 //! the LLVM IR of a codegen unit. Translation items do not stand on their
48 //! own, they can reference other translation items. For example, if function
49 //! `foo()` calls function `bar()` then the translation item for `foo()`
50 //! references the translation item for function `bar()`. In general, the
51 //! definition for translation item A referencing a translation item B is that
52 //! the LLVM artifact produced for A references the LLVM artifact produced
55 //! - Translation items and the references between them form a directed graph,
56 //! where the translation items are the nodes and references form the edges.
57 //! Let's call this graph the "translation item graph".
59 //! - The translation item graph for a program contains all translation items
60 //! that are needed in order to produce the complete LLVM IR of the program.
62 //! The purpose of the algorithm implemented in this module is to build the
63 //! translation item graph for the current crate. It runs in two phases:
65 //! 1. Discover the roots of the graph by traversing the HIR of the crate.
66 //! 2. Starting from the roots, find neighboring nodes by inspecting the MIR
67 //! representation of the item corresponding to a given node, until no more
68 //! new nodes are found.
70 //! ### Discovering roots
72 //! The roots of the translation item graph correspond to the non-generic
73 //! syntactic items in the source code. We find them by walking the HIR of the
74 //! crate, and whenever we hit upon a function, method, or static item, we
75 //! create a translation item consisting of the items DefId and, since we only
76 //! consider non-generic items, an empty type-substitution set.
78 //! ### Finding neighbor nodes
79 //! Given a translation item node, we can discover neighbors by inspecting its
80 //! MIR. We walk the MIR and any time we hit upon something that signifies a
81 //! reference to another translation item, we have found a neighbor. Since the
82 //! translation item we are currently at is always monomorphic, we also know the
83 //! concrete type arguments of its neighbors, and so all neighbors again will be
84 //! monomorphic. The specific forms a reference to a neighboring node can take
85 //! in MIR are quite diverse. Here is an overview:
87 //! #### Calling Functions/Methods
88 //! The most obvious form of one translation item referencing another is a
89 //! function or method call (represented by a CALL terminator in MIR). But
90 //! calls are not the only thing that might introduce a reference between two
91 //! function translation items, and as we will see below, they are just a
92 //! specialized of the form described next, and consequently will don't get any
93 //! special treatment in the algorithm.
95 //! #### Taking a reference to a function or method
96 //! A function does not need to actually be called in order to be a neighbor of
97 //! another function. It suffices to just take a reference in order to introduce
98 //! an edge. Consider the following example:
101 //! fn print_val<T: Display>(x: T) {
102 //! println!("{}", x);
105 //! fn call_fn(f: &Fn(i32), x: i32) {
110 //! let print_i32 = print_val::<i32>;
111 //! call_fn(&print_i32, 0);
114 //! The MIR of none of these functions will contain an explicit call to
115 //! `print_val::<i32>`. Nonetheless, in order to translate this program, we need
116 //! an instance of this function. Thus, whenever we encounter a function or
117 //! method in operand position, we treat it as a neighbor of the current
118 //! translation item. Calls are just a special case of that.
121 //! In a way, closures are a simple case. Since every closure object needs to be
122 //! constructed somewhere, we can reliably discover them by observing
123 //! `RValue::Aggregate` expressions with `AggregateKind::Closure`. This is also
124 //! true for closures inlined from other crates.
127 //! Drop glue translation items are introduced by MIR drop-statements. The
128 //! generated translation item will again have drop-glue item neighbors if the
129 //! type to be dropped contains nested values that also need to be dropped. It
130 //! might also have a function item neighbor for the explicit `Drop::drop`
131 //! implementation of its type.
133 //! #### Unsizing Casts
134 //! A subtle way of introducing neighbor edges is by casting to a trait object.
135 //! Since the resulting fat-pointer contains a reference to a vtable, we need to
136 //! instantiate all object-save methods of the trait, as we need to store
137 //! pointers to these functions even if they never get called anywhere. This can
138 //! be seen as a special case of taking a function reference.
141 //! Since `Box` expression have special compiler support, no explicit calls to
142 //! `exchange_malloc()` and `exchange_free()` may show up in MIR, even if the
143 //! compiler will generate them. We have to observe `Rvalue::Box` expressions
144 //! and Box-typed drop-statements for that purpose.
147 //! Interaction with Cross-Crate Inlining
148 //! -------------------------------------
149 //! The binary of a crate will not only contain machine code for the items
150 //! defined in the source code of that crate. It will also contain monomorphic
151 //! instantiations of any extern generic functions and of functions marked with
153 //! The collection algorithm handles this more or less transparently. If it is
154 //! about to create a translation item for something with an external `DefId`,
155 //! it will take a look if the MIR for that item is available, and if so just
156 //! proceed normally. If the MIR is not available, it assumes that the item is
157 //! just linked to and no node is created; which is exactly what we want, since
158 //! no machine code should be generated in the current crate for such an item.
160 //! Eager and Lazy Collection Mode
161 //! ------------------------------
162 //! Translation item collection can be performed in one of two modes:
164 //! - Lazy mode means that items will only be instantiated when actually
165 //! referenced. The goal is to produce the least amount of machine code
168 //! - Eager mode is meant to be used in conjunction with incremental compilation
169 //! where a stable set of translation items is more important than a minimal
170 //! one. Thus, eager mode will instantiate drop-glue for every drop-able type
171 //! in the crate, even of no drop call for that type exists (yet). It will
172 //! also instantiate default implementations of trait methods, something that
173 //! otherwise is only done on demand.
178 //! Some things are not yet fully implemented in the current version of this
181 //! ### Initializers of Constants and Statics
182 //! Since no MIR is constructed yet for initializer expressions of constants and
183 //! statics we cannot inspect these properly.
186 //! Ideally, no translation item should be generated for const fns unless there
187 //! is a call to them that cannot be evaluated at compile time. At the moment
188 //! this is not implemented however: a translation item will be produced
189 //! regardless of whether it is actually needed or not.
192 use rustc::hir::itemlikevisit::ItemLikeVisitor;
194 use rustc::hir::map as hir_map;
195 use rustc::hir::def_id::DefId;
196 use rustc::middle::lang_items::{ExchangeMallocFnLangItem};
198 use rustc::ty::subst::Substs;
199 use rustc::ty::{self, TypeFoldable, TyCtxt};
200 use rustc::ty::adjustment::CustomCoerceUnsized;
201 use rustc::mir::{self, Location};
202 use rustc::mir::visit::Visitor as MirVisitor;
204 use context::SharedCrateContext;
205 use common::{def_ty, instance_ty};
206 use monomorphize::{self, Instance};
207 use rustc::util::nodemap::{FxHashSet, FxHashMap, DefIdMap};
209 use trans_item::{TransItem, DefPathBasedNames, InstantiationMode};
211 use rustc_data_structures::bitvec::BitVector;
212 use back::symbol_export::ExportedSymbols;
214 #[derive(PartialEq, Eq, Hash, Clone, Copy, Debug)]
215 pub enum TransItemCollectionMode {
220 /// Maps every translation item to all translation items it references in its
222 pub struct InliningMap<'tcx> {
223 // Maps a source translation item to the range of translation items
225 // The two numbers in the tuple are the start (inclusive) and
226 // end index (exclusive) within the `targets` vecs.
227 index: FxHashMap<TransItem<'tcx>, (usize, usize)>,
228 targets: Vec<TransItem<'tcx>>,
230 // Contains one bit per translation item in the `targets` field. That bit
231 // is true if that translation item needs to be inlined into every CGU.
235 impl<'tcx> InliningMap<'tcx> {
237 fn new() -> InliningMap<'tcx> {
241 inlines: BitVector::new(1024),
245 fn record_accesses<I>(&mut self,
246 source: TransItem<'tcx>,
248 where I: Iterator<Item=(TransItem<'tcx>, bool)> + ExactSizeIterator
250 assert!(!self.index.contains_key(&source));
252 let start_index = self.targets.len();
253 let new_items_count = new_targets.len();
254 let new_items_count_total = new_items_count + self.targets.len();
256 self.targets.reserve(new_items_count);
257 self.inlines.grow(new_items_count_total);
259 for (i, (target, inline)) in new_targets.enumerate() {
260 self.targets.push(target);
262 self.inlines.insert(i + start_index);
266 let end_index = self.targets.len();
267 self.index.insert(source, (start_index, end_index));
270 // Internally iterate over all items referenced by `source` which will be
271 // made available for inlining.
272 pub fn with_inlining_candidates<F>(&self, source: TransItem<'tcx>, mut f: F)
273 where F: FnMut(TransItem<'tcx>)
275 if let Some(&(start_index, end_index)) = self.index.get(&source) {
276 for (i, candidate) in self.targets[start_index .. end_index]
279 if self.inlines.contains(start_index + i) {
286 // Internally iterate over all items and the things each accesses.
287 pub fn iter_accesses<F>(&self, mut f: F)
288 where F: FnMut(TransItem<'tcx>, &[TransItem<'tcx>])
290 for (&accessor, &(start_index, end_index)) in &self.index {
291 f(accessor, &self.targets[start_index .. end_index])
296 pub fn collect_crate_translation_items<'a, 'tcx>(scx: &SharedCrateContext<'a, 'tcx>,
297 exported_symbols: &ExportedSymbols,
298 mode: TransItemCollectionMode)
299 -> (FxHashSet<TransItem<'tcx>>,
301 // We are not tracking dependencies of this pass as it has to be re-executed
302 // every time no matter what.
303 scx.tcx().dep_graph.with_ignore(|| {
304 let roots = collect_roots(scx, exported_symbols, mode);
306 debug!("Building translation item graph, beginning at roots");
307 let mut visited = FxHashSet();
308 let mut recursion_depths = DefIdMap();
309 let mut inlining_map = InliningMap::new();
312 collect_items_rec(scx,
315 &mut recursion_depths,
319 (visited, inlining_map)
323 // Find all non-generic items by walking the HIR. These items serve as roots to
324 // start monomorphizing from.
325 fn collect_roots<'a, 'tcx>(scx: &SharedCrateContext<'a, 'tcx>,
326 exported_symbols: &ExportedSymbols,
327 mode: TransItemCollectionMode)
328 -> Vec<TransItem<'tcx>> {
329 debug!("Collecting roots");
330 let mut roots = Vec::new();
333 let mut visitor = RootCollector {
340 scx.tcx().hir.krate().visit_all_item_likes(&mut visitor);
343 // We can only translate items that are instantiable - items all of
344 // whose predicates hold. Luckily, items that aren't instantiable
345 // can't actually be used, so we can just skip translating them.
346 roots.retain(|root| root.is_instantiable(scx.tcx()));
351 // Collect all monomorphized translation items reachable from `starting_point`
352 fn collect_items_rec<'a, 'tcx: 'a>(scx: &SharedCrateContext<'a, 'tcx>,
353 starting_point: TransItem<'tcx>,
354 visited: &mut FxHashSet<TransItem<'tcx>>,
355 recursion_depths: &mut DefIdMap<usize>,
356 inlining_map: &mut InliningMap<'tcx>) {
357 if !visited.insert(starting_point.clone()) {
358 // We've been here already, no need to search again.
361 debug!("BEGIN collect_items_rec({})", starting_point.to_string(scx.tcx()));
363 let mut neighbors = Vec::new();
364 let recursion_depth_reset;
366 match starting_point {
367 TransItem::Static(node_id) => {
368 let def_id = scx.tcx().hir.local_def_id(node_id);
369 let instance = Instance::mono(scx.tcx(), def_id);
371 // Sanity check whether this ended up being collected accidentally
372 debug_assert!(should_trans_locally(scx.tcx(), &instance));
374 let ty = instance_ty(scx, &instance);
375 visit_drop_use(scx, ty, true, &mut neighbors);
377 recursion_depth_reset = None;
379 collect_neighbours(scx, instance, true, &mut neighbors);
381 TransItem::Fn(instance) => {
382 // Sanity check whether this ended up being collected accidentally
383 debug_assert!(should_trans_locally(scx.tcx(), &instance));
385 // Keep track of the monomorphization recursion depth
386 recursion_depth_reset = Some(check_recursion_limit(scx.tcx(),
389 check_type_length_limit(scx.tcx(), instance);
391 collect_neighbours(scx, instance, false, &mut neighbors);
393 TransItem::GlobalAsm(..) => {
394 recursion_depth_reset = None;
398 record_accesses(scx.tcx(), starting_point, &neighbors[..], inlining_map);
400 for neighbour in neighbors {
401 collect_items_rec(scx, neighbour, visited, recursion_depths, inlining_map);
404 if let Some((def_id, depth)) = recursion_depth_reset {
405 recursion_depths.insert(def_id, depth);
408 debug!("END collect_items_rec({})", starting_point.to_string(scx.tcx()));
411 fn record_accesses<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>,
412 caller: TransItem<'tcx>,
413 callees: &[TransItem<'tcx>],
414 inlining_map: &mut InliningMap<'tcx>) {
415 let is_inlining_candidate = |trans_item: &TransItem<'tcx>| {
416 trans_item.instantiation_mode(tcx) == InstantiationMode::LocalCopy
419 let accesses = callees.into_iter()
421 (*trans_item, is_inlining_candidate(trans_item))
424 inlining_map.record_accesses(caller, accesses);
427 fn check_recursion_limit<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>,
428 instance: Instance<'tcx>,
429 recursion_depths: &mut DefIdMap<usize>)
431 let def_id = instance.def_id();
432 let recursion_depth = recursion_depths.get(&def_id).cloned().unwrap_or(0);
433 debug!(" => recursion depth={}", recursion_depth);
435 let recursion_depth = if Some(def_id) == tcx.lang_items().drop_in_place_fn() {
436 // HACK: drop_in_place creates tight monomorphization loops. Give
443 // Code that needs to instantiate the same function recursively
444 // more than the recursion limit is assumed to be causing an
445 // infinite expansion.
446 if recursion_depth > tcx.sess.recursion_limit.get() {
447 let error = format!("reached the recursion limit while instantiating `{}`",
449 if let Some(node_id) = tcx.hir.as_local_node_id(def_id) {
450 tcx.sess.span_fatal(tcx.hir.span(node_id), &error);
452 tcx.sess.fatal(&error);
456 recursion_depths.insert(def_id, recursion_depth + 1);
458 (def_id, recursion_depth)
461 fn check_type_length_limit<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>,
462 instance: Instance<'tcx>)
464 let type_length = instance.substs.types().flat_map(|ty| ty.walk()).count();
465 debug!(" => type length={}", type_length);
467 // Rust code can easily create exponentially-long types using only a
468 // polynomial recursion depth. Even with the default recursion
469 // depth, you can easily get cases that take >2^60 steps to run,
470 // which means that rustc basically hangs.
472 // Bail out in these cases to avoid that bad user experience.
473 let type_length_limit = tcx.sess.type_length_limit.get();
474 if type_length > type_length_limit {
475 // The instance name is already known to be too long for rustc. Use
476 // `{:.64}` to avoid blasting the user's terminal with thousands of
477 // lines of type-name.
478 let instance_name = instance.to_string();
479 let msg = format!("reached the type-length limit while instantiating `{:.64}...`",
481 let mut diag = if let Some(node_id) = tcx.hir.as_local_node_id(instance.def_id()) {
482 tcx.sess.struct_span_fatal(tcx.hir.span(node_id), &msg)
484 tcx.sess.struct_fatal(&msg)
488 "consider adding a `#![type_length_limit=\"{}\"]` attribute to your crate",
489 type_length_limit*2));
491 tcx.sess.abort_if_errors();
495 struct MirNeighborCollector<'a, 'tcx: 'a> {
496 scx: &'a SharedCrateContext<'a, 'tcx>,
497 mir: &'a mir::Mir<'tcx>,
498 output: &'a mut Vec<TransItem<'tcx>>,
499 param_substs: &'tcx Substs<'tcx>,
503 impl<'a, 'tcx> MirVisitor<'tcx> for MirNeighborCollector<'a, 'tcx> {
505 fn visit_rvalue(&mut self, rvalue: &mir::Rvalue<'tcx>, location: Location) {
506 debug!("visiting rvalue {:?}", *rvalue);
509 // When doing an cast from a regular pointer to a fat pointer, we
510 // have to instantiate all methods of the trait being cast to, so we
511 // can build the appropriate vtable.
512 mir::Rvalue::Cast(mir::CastKind::Unsize, ref operand, target_ty) => {
513 let target_ty = self.scx.tcx().trans_apply_param_substs(self.param_substs,
515 let source_ty = operand.ty(self.mir, self.scx.tcx());
516 let source_ty = self.scx.tcx().trans_apply_param_substs(self.param_substs,
518 let (source_ty, target_ty) = find_vtable_types_for_unsizing(self.scx,
521 // This could also be a different Unsize instruction, like
522 // from a fixed sized array to a slice. But we are only
523 // interested in things that produce a vtable.
524 if target_ty.is_trait() && !source_ty.is_trait() {
525 create_trans_items_for_vtable_methods(self.scx,
531 mir::Rvalue::Cast(mir::CastKind::ReifyFnPointer, ref operand, _) => {
532 let fn_ty = operand.ty(self.mir, self.scx.tcx());
533 let fn_ty = self.scx.tcx().trans_apply_param_substs(self.param_substs,
535 visit_fn_use(self.scx, fn_ty, false, &mut self.output);
537 mir::Rvalue::Cast(mir::CastKind::ClosureFnPointer, ref operand, _) => {
538 let source_ty = operand.ty(self.mir, self.scx.tcx());
539 let source_ty = self.scx.tcx().trans_apply_param_substs(self.param_substs,
541 match source_ty.sty {
542 ty::TyClosure(def_id, substs) => {
543 let instance = monomorphize::resolve_closure(
544 self.scx, def_id, substs, ty::ClosureKind::FnOnce);
545 self.output.push(create_fn_trans_item(instance));
550 mir::Rvalue::NullaryOp(mir::NullOp::Box, _) => {
551 let tcx = self.scx.tcx();
552 let exchange_malloc_fn_def_id = tcx
554 .require(ExchangeMallocFnLangItem)
555 .unwrap_or_else(|e| self.scx.sess().fatal(&e));
556 let instance = Instance::mono(tcx, exchange_malloc_fn_def_id);
557 if should_trans_locally(tcx, &instance) {
558 self.output.push(create_fn_trans_item(instance));
561 _ => { /* not interesting */ }
564 self.super_rvalue(rvalue, location);
567 fn visit_constant(&mut self, constant: &mir::Constant<'tcx>, location: Location) {
568 debug!("visiting constant {:?} @ {:?}", *constant, location);
570 if let ty::TyFnDef(..) = constant.ty.sty {
571 // function definitions are zero-sized, and only generate
572 // IR when they are called/reified.
573 self.super_constant(constant, location);
577 if let mir::Literal::Item { def_id, substs } = constant.literal {
578 let substs = self.scx.tcx().trans_apply_param_substs(self.param_substs,
580 let instance = monomorphize::resolve(self.scx, def_id, substs);
581 collect_neighbours(self.scx, instance, true, self.output);
584 self.super_constant(constant, location);
587 fn visit_terminator_kind(&mut self,
588 block: mir::BasicBlock,
589 kind: &mir::TerminatorKind<'tcx>,
590 location: Location) {
591 debug!("visiting terminator {:?} @ {:?}", kind, location);
593 let tcx = self.scx.tcx();
595 mir::TerminatorKind::Call { ref func, .. } => {
596 let callee_ty = func.ty(self.mir, tcx);
597 let callee_ty = tcx.trans_apply_param_substs(self.param_substs, &callee_ty);
599 let constness = match (self.const_context, &callee_ty.sty) {
600 (true, &ty::TyFnDef(def_id, substs)) if self.scx.tcx().is_const_fn(def_id) => {
601 let instance = monomorphize::resolve(self.scx, def_id, substs);
607 if let Some(const_fn_instance) = constness {
608 // If this is a const fn, called from a const context, we
609 // have to visit its body in order to find any fn reifications
611 collect_neighbours(self.scx,
616 visit_fn_use(self.scx, callee_ty, true, &mut self.output);
619 mir::TerminatorKind::Drop { ref location, .. } |
620 mir::TerminatorKind::DropAndReplace { ref location, .. } => {
621 let ty = location.ty(self.mir, self.scx.tcx())
622 .to_ty(self.scx.tcx());
623 let ty = tcx.trans_apply_param_substs(self.param_substs, &ty);
624 visit_drop_use(self.scx, ty, true, self.output);
626 mir::TerminatorKind::Goto { .. } |
627 mir::TerminatorKind::SwitchInt { .. } |
628 mir::TerminatorKind::Resume |
629 mir::TerminatorKind::Return |
630 mir::TerminatorKind::Unreachable |
631 mir::TerminatorKind::Assert { .. } => {}
632 mir::TerminatorKind::GeneratorDrop |
633 mir::TerminatorKind::Yield { .. } => bug!(),
636 self.super_terminator_kind(block, kind, location);
639 fn visit_static(&mut self,
640 static_: &mir::Static<'tcx>,
641 context: mir::visit::LvalueContext<'tcx>,
642 location: Location) {
643 debug!("visiting static {:?} @ {:?}", static_.def_id, location);
645 let tcx = self.scx.tcx();
646 let instance = Instance::mono(tcx, static_.def_id);
647 if should_trans_locally(tcx, &instance) {
648 let node_id = tcx.hir.as_local_node_id(static_.def_id).unwrap();
649 self.output.push(TransItem::Static(node_id));
652 self.super_static(static_, context, location);
656 fn visit_drop_use<'a, 'tcx>(scx: &SharedCrateContext<'a, 'tcx>,
658 is_direct_call: bool,
659 output: &mut Vec<TransItem<'tcx>>)
661 let instance = monomorphize::resolve_drop_in_place(scx, ty);
662 visit_instance_use(scx, instance, is_direct_call, output);
665 fn visit_fn_use<'a, 'tcx>(scx: &SharedCrateContext<'a, 'tcx>,
667 is_direct_call: bool,
668 output: &mut Vec<TransItem<'tcx>>)
670 if let ty::TyFnDef(def_id, substs) = ty.sty {
671 let instance = monomorphize::resolve(scx, def_id, substs);
672 visit_instance_use(scx, instance, is_direct_call, output);
676 fn visit_instance_use<'a, 'tcx>(scx: &SharedCrateContext<'a, 'tcx>,
677 instance: ty::Instance<'tcx>,
678 is_direct_call: bool,
679 output: &mut Vec<TransItem<'tcx>>)
681 debug!("visit_item_use({:?}, is_direct_call={:?})", instance, is_direct_call);
682 if !should_trans_locally(scx.tcx(), &instance) {
687 ty::InstanceDef::Intrinsic(def_id) => {
689 bug!("intrinsic {:?} being reified", def_id);
692 ty::InstanceDef::Virtual(..) |
693 ty::InstanceDef::DropGlue(_, None) => {
694 // don't need to emit shim if we are calling directly.
696 output.push(create_fn_trans_item(instance));
699 ty::InstanceDef::DropGlue(_, Some(_)) => {
700 output.push(create_fn_trans_item(instance));
702 ty::InstanceDef::ClosureOnceShim { .. } |
703 ty::InstanceDef::Item(..) |
704 ty::InstanceDef::FnPtrShim(..) |
705 ty::InstanceDef::CloneShim(..) => {
706 output.push(create_fn_trans_item(instance));
711 // Returns true if we should translate an instance in the local crate.
712 // Returns false if we can just link to the upstream crate and therefore don't
713 // need a translation item.
714 fn should_trans_locally<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>, instance: &Instance<'tcx>)
716 let def_id = match instance.def {
717 ty::InstanceDef::Item(def_id) => def_id,
718 ty::InstanceDef::ClosureOnceShim { .. } |
719 ty::InstanceDef::Virtual(..) |
720 ty::InstanceDef::FnPtrShim(..) |
721 ty::InstanceDef::DropGlue(..) |
722 ty::InstanceDef::Intrinsic(_) |
723 ty::InstanceDef::CloneShim(..) => return true
725 match tcx.hir.get_if_local(def_id) {
726 Some(hir_map::NodeForeignItem(..)) => {
727 false // foreign items are linked against, not translated.
731 if tcx.is_exported_symbol(def_id) ||
732 tcx.is_foreign_item(def_id)
734 // We can link to the item in question, no instance needed
738 if !tcx.is_mir_available(def_id) {
739 bug!("Cannot create local trans-item for {:?}", def_id)
747 /// For given pair of source and target type that occur in an unsizing coercion,
748 /// this function finds the pair of types that determines the vtable linking
751 /// For example, the source type might be `&SomeStruct` and the target type\
752 /// might be `&SomeTrait` in a cast like:
754 /// let src: &SomeStruct = ...;
755 /// let target = src as &SomeTrait;
757 /// Then the output of this function would be (SomeStruct, SomeTrait) since for
758 /// constructing the `target` fat-pointer we need the vtable for that pair.
760 /// Things can get more complicated though because there's also the case where
761 /// the unsized type occurs as a field:
764 /// struct ComplexStruct<T: ?Sized> {
771 /// In this case, if `T` is sized, `&ComplexStruct<T>` is a thin pointer. If `T`
772 /// is unsized, `&SomeStruct` is a fat pointer, and the vtable it points to is
773 /// for the pair of `T` (which is a trait) and the concrete type that `T` was
774 /// originally coerced from:
776 /// let src: &ComplexStruct<SomeStruct> = ...;
777 /// let target = src as &ComplexStruct<SomeTrait>;
779 /// Again, we want this `find_vtable_types_for_unsizing()` to provide the pair
780 /// `(SomeStruct, SomeTrait)`.
782 /// Finally, there is also the case of custom unsizing coercions, e.g. for
783 /// smart pointers such as `Rc` and `Arc`.
784 fn find_vtable_types_for_unsizing<'a, 'tcx>(scx: &SharedCrateContext<'a, 'tcx>,
785 source_ty: ty::Ty<'tcx>,
786 target_ty: ty::Ty<'tcx>)
787 -> (ty::Ty<'tcx>, ty::Ty<'tcx>) {
788 let ptr_vtable = |inner_source: ty::Ty<'tcx>, inner_target: ty::Ty<'tcx>| {
789 if !scx.type_is_sized(inner_source) {
790 (inner_source, inner_target)
792 scx.tcx().struct_lockstep_tails(inner_source, inner_target)
795 match (&source_ty.sty, &target_ty.sty) {
796 (&ty::TyRef(_, ty::TypeAndMut { ty: a, .. }),
797 &ty::TyRef(_, ty::TypeAndMut { ty: b, .. })) |
798 (&ty::TyRef(_, ty::TypeAndMut { ty: a, .. }),
799 &ty::TyRawPtr(ty::TypeAndMut { ty: b, .. })) |
800 (&ty::TyRawPtr(ty::TypeAndMut { ty: a, .. }),
801 &ty::TyRawPtr(ty::TypeAndMut { ty: b, .. })) => {
804 (&ty::TyAdt(def_a, _), &ty::TyAdt(def_b, _)) if def_a.is_box() && def_b.is_box() => {
805 ptr_vtable(source_ty.boxed_ty(), target_ty.boxed_ty())
808 (&ty::TyAdt(source_adt_def, source_substs),
809 &ty::TyAdt(target_adt_def, target_substs)) => {
810 assert_eq!(source_adt_def, target_adt_def);
813 monomorphize::custom_coerce_unsize_info(scx, source_ty, target_ty);
815 let coerce_index = match kind {
816 CustomCoerceUnsized::Struct(i) => i
819 let source_fields = &source_adt_def.struct_variant().fields;
820 let target_fields = &target_adt_def.struct_variant().fields;
822 assert!(coerce_index < source_fields.len() &&
823 source_fields.len() == target_fields.len());
825 find_vtable_types_for_unsizing(scx,
826 source_fields[coerce_index].ty(scx.tcx(),
828 target_fields[coerce_index].ty(scx.tcx(),
831 _ => bug!("find_vtable_types_for_unsizing: invalid coercion {:?} -> {:?}",
837 fn create_fn_trans_item<'a, 'tcx>(instance: Instance<'tcx>) -> TransItem<'tcx> {
838 debug!("create_fn_trans_item(instance={})", instance);
839 TransItem::Fn(instance)
842 /// Creates a `TransItem` for each method that is referenced by the vtable for
843 /// the given trait/impl pair.
844 fn create_trans_items_for_vtable_methods<'a, 'tcx>(scx: &SharedCrateContext<'a, 'tcx>,
845 trait_ty: ty::Ty<'tcx>,
846 impl_ty: ty::Ty<'tcx>,
847 output: &mut Vec<TransItem<'tcx>>) {
848 assert!(!trait_ty.needs_subst() && !trait_ty.has_escaping_regions() &&
849 !impl_ty.needs_subst() && !impl_ty.has_escaping_regions());
851 if let ty::TyDynamic(ref trait_ty, ..) = trait_ty.sty {
852 if let Some(principal) = trait_ty.principal() {
853 let poly_trait_ref = principal.with_self_ty(scx.tcx(), impl_ty);
854 assert!(!poly_trait_ref.has_escaping_regions());
856 // Walk all methods of the trait, including those of its supertraits
857 let methods = traits::get_vtable_methods(scx.tcx(), poly_trait_ref);
858 let methods = methods.filter_map(|method| method)
859 .map(|(def_id, substs)| monomorphize::resolve(scx, def_id, substs))
860 .filter(|&instance| should_trans_locally(scx.tcx(), &instance))
861 .map(|instance| create_fn_trans_item(instance));
862 output.extend(methods);
864 // Also add the destructor
865 visit_drop_use(scx, impl_ty, false, output);
869 //=-----------------------------------------------------------------------------
871 //=-----------------------------------------------------------------------------
873 struct RootCollector<'b, 'a: 'b, 'tcx: 'a + 'b> {
874 scx: &'b SharedCrateContext<'a, 'tcx>,
875 exported_symbols: &'b ExportedSymbols,
876 mode: TransItemCollectionMode,
877 output: &'b mut Vec<TransItem<'tcx>>,
880 impl<'b, 'a, 'v> ItemLikeVisitor<'v> for RootCollector<'b, 'a, 'v> {
881 fn visit_item(&mut self, item: &'v hir::Item) {
883 hir::ItemExternCrate(..) |
885 hir::ItemForeignMod(..) |
887 hir::ItemDefaultImpl(..) |
889 hir::ItemMod(..) => {
890 // Nothing to do, just keep recursing...
893 hir::ItemImpl(..) => {
894 if self.mode == TransItemCollectionMode::Eager {
895 create_trans_items_for_default_impls(self.scx,
901 hir::ItemEnum(_, ref generics) |
902 hir::ItemStruct(_, ref generics) |
903 hir::ItemUnion(_, ref generics) => {
904 if !generics.is_parameterized() {
905 if self.mode == TransItemCollectionMode::Eager {
906 let def_id = self.scx.tcx().hir.local_def_id(item.id);
907 debug!("RootCollector: ADT drop-glue for {}",
908 def_id_to_string(self.scx.tcx(), def_id));
910 let ty = def_ty(self.scx, def_id, Substs::empty());
911 visit_drop_use(self.scx, ty, true, self.output);
915 hir::ItemGlobalAsm(..) => {
916 debug!("RootCollector: ItemGlobalAsm({})",
917 def_id_to_string(self.scx.tcx(),
918 self.scx.tcx().hir.local_def_id(item.id)));
919 self.output.push(TransItem::GlobalAsm(item.id));
921 hir::ItemStatic(..) => {
922 debug!("RootCollector: ItemStatic({})",
923 def_id_to_string(self.scx.tcx(),
924 self.scx.tcx().hir.local_def_id(item.id)));
925 self.output.push(TransItem::Static(item.id));
927 hir::ItemConst(..) => {
928 // const items only generate translation items if they are
929 // actually used somewhere. Just declaring them is insufficient.
932 let tcx = self.scx.tcx();
933 let def_id = tcx.hir.local_def_id(item.id);
935 if (self.mode == TransItemCollectionMode::Eager ||
936 !tcx.is_const_fn(def_id) ||
937 self.exported_symbols.local_exports().contains(&item.id)) &&
938 !item_has_type_parameters(tcx, def_id) {
940 debug!("RootCollector: ItemFn({})",
941 def_id_to_string(tcx, def_id));
943 let instance = Instance::mono(tcx, def_id);
944 self.output.push(TransItem::Fn(instance));
950 fn visit_trait_item(&mut self, _: &'v hir::TraitItem) {
951 // Even if there's a default body with no explicit generics,
952 // it's still generic over some `Self: Trait`, so not a root.
955 fn visit_impl_item(&mut self, ii: &'v hir::ImplItem) {
957 hir::ImplItemKind::Method(hir::MethodSig { .. }, _) => {
958 let tcx = self.scx.tcx();
959 let def_id = tcx.hir.local_def_id(ii.id);
961 if (self.mode == TransItemCollectionMode::Eager ||
962 !tcx.is_const_fn(def_id) ||
963 self.exported_symbols.local_exports().contains(&ii.id)) &&
964 !item_has_type_parameters(tcx, def_id) {
965 debug!("RootCollector: MethodImplItem({})",
966 def_id_to_string(tcx, def_id));
968 let instance = Instance::mono(tcx, def_id);
969 self.output.push(TransItem::Fn(instance));
972 _ => { /* Nothing to do here */ }
977 fn item_has_type_parameters<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>, def_id: DefId) -> bool {
978 let generics = tcx.generics_of(def_id);
979 generics.parent_types as usize + generics.types.len() > 0
982 fn create_trans_items_for_default_impls<'a, 'tcx>(scx: &SharedCrateContext<'a, 'tcx>,
983 item: &'tcx hir::Item,
984 output: &mut Vec<TransItem<'tcx>>) {
992 ref impl_item_refs) => {
993 if generics.is_type_parameterized() {
997 let impl_def_id = tcx.hir.local_def_id(item.id);
999 debug!("create_trans_items_for_default_impls(item={})",
1000 def_id_to_string(tcx, impl_def_id));
1002 if let Some(trait_ref) = tcx.impl_trait_ref(impl_def_id) {
1003 let callee_substs = tcx.erase_regions(&trait_ref.substs);
1004 let overridden_methods: FxHashSet<_> =
1005 impl_item_refs.iter()
1006 .map(|iiref| iiref.name)
1008 for method in tcx.provided_trait_methods(trait_ref.def_id) {
1009 if overridden_methods.contains(&method.name) {
1013 if !tcx.generics_of(method.def_id).types.is_empty() {
1018 monomorphize::resolve(scx, method.def_id, callee_substs);
1020 let trans_item = create_fn_trans_item(instance);
1021 if trans_item.is_instantiable(tcx) && should_trans_locally(tcx, &instance) {
1022 output.push(trans_item);
1033 /// Scan the MIR in order to find function calls, closures, and drop-glue
1034 fn collect_neighbours<'a, 'tcx>(scx: &SharedCrateContext<'a, 'tcx>,
1035 instance: Instance<'tcx>,
1036 const_context: bool,
1037 output: &mut Vec<TransItem<'tcx>>)
1039 let mir = scx.tcx().instance_mir(instance.def);
1041 let mut visitor = MirNeighborCollector {
1045 param_substs: instance.substs,
1049 visitor.visit_mir(&mir);
1050 for promoted in &mir.promoted {
1051 visitor.mir = promoted;
1052 visitor.visit_mir(promoted);
1056 fn def_id_to_string<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>,
1059 let mut output = String::new();
1060 let printer = DefPathBasedNames::new(tcx, false, false);
1061 printer.push_def_path(def_id, &mut output);