1 //! Mono Item Collection
2 //! ====================
4 //! This module is responsible for discovering all items that will contribute
5 //! to code generation of the crate. The important part here is that it not only
6 //! needs to find syntax-level items (functions, structs, etc) but also all
7 //! their monomorphized instantiations. Every non-generic, non-const function
8 //! maps to one LLVM artifact. Every generic function can produce
9 //! from zero to N artifacts, depending on the sets of type arguments it
10 //! is instantiated with.
11 //! This also applies to generic items from other crates: A generic definition
12 //! in crate X might produce monomorphizations that are compiled into crate Y.
13 //! We also have to collect these here.
15 //! The following kinds of "mono items" are handled here:
23 //! The following things also result in LLVM artifacts, but are not collected
24 //! here, since we instantiate them locally on demand when needed in a given
34 //! Let's define some terms first:
36 //! - A "mono item" is something that results in a function or global in
37 //! the LLVM IR of a codegen unit. Mono items do not stand on their
38 //! own, they can reference other mono items. For example, if function
39 //! `foo()` calls function `bar()` then the mono item for `foo()`
40 //! references the mono item for function `bar()`. In general, the
41 //! definition for mono item A referencing a mono item B is that
42 //! the LLVM artifact produced for A references the LLVM artifact produced
45 //! - Mono items and the references between them form a directed graph,
46 //! where the mono items are the nodes and references form the edges.
47 //! Let's call this graph the "mono item graph".
49 //! - The mono item graph for a program contains all mono items
50 //! that are needed in order to produce the complete LLVM IR of the program.
52 //! The purpose of the algorithm implemented in this module is to build the
53 //! mono item graph for the current crate. It runs in two phases:
55 //! 1. Discover the roots of the graph by traversing the HIR of the crate.
56 //! 2. Starting from the roots, find neighboring nodes by inspecting the MIR
57 //! representation of the item corresponding to a given node, until no more
58 //! new nodes are found.
60 //! ### Discovering roots
62 //! The roots of the mono item graph correspond to the public non-generic
63 //! syntactic items in the source code. We find them by walking the HIR of the
64 //! crate, and whenever we hit upon a public function, method, or static item,
65 //! we create a mono item consisting of the items DefId and, since we only
66 //! consider non-generic items, an empty type-substitution set. (In eager
67 //! collection mode, during incremental compilation, all non-generic functions
68 //! are considered as roots, as well as when the `-Clink-dead-code` option is
69 //! specified. Functions marked `#[no_mangle]` and functions called by inlinable
70 //! functions also always act as roots.)
72 //! ### Finding neighbor nodes
73 //! Given a mono item node, we can discover neighbors by inspecting its
74 //! MIR. We walk the MIR and any time we hit upon something that signifies a
75 //! reference to another mono item, we have found a neighbor. Since the
76 //! mono item we are currently at is always monomorphic, we also know the
77 //! concrete type arguments of its neighbors, and so all neighbors again will be
78 //! monomorphic. The specific forms a reference to a neighboring node can take
79 //! in MIR are quite diverse. Here is an overview:
81 //! #### Calling Functions/Methods
82 //! The most obvious form of one mono item referencing another is a
83 //! function or method call (represented by a CALL terminator in MIR). But
84 //! calls are not the only thing that might introduce a reference between two
85 //! function mono items, and as we will see below, they are just a
86 //! specialization of the form described next, and consequently will not get any
87 //! special treatment in the algorithm.
89 //! #### Taking a reference to a function or method
90 //! A function does not need to actually be called in order to be a neighbor of
91 //! another function. It suffices to just take a reference in order to introduce
92 //! an edge. Consider the following example:
95 //! fn print_val<T: Display>(x: T) {
96 //! println!("{}", x);
99 //! fn call_fn(f: &Fn(i32), x: i32) {
104 //! let print_i32 = print_val::<i32>;
105 //! call_fn(&print_i32, 0);
108 //! The MIR of none of these functions will contain an explicit call to
109 //! `print_val::<i32>`. Nonetheless, in order to mono this program, we need
110 //! an instance of this function. Thus, whenever we encounter a function or
111 //! method in operand position, we treat it as a neighbor of the current
112 //! mono item. Calls are just a special case of that.
115 //! In a way, closures are a simple case. Since every closure object needs to be
116 //! constructed somewhere, we can reliably discover them by observing
117 //! `RValue::Aggregate` expressions with `AggregateKind::Closure`. This is also
118 //! true for closures inlined from other crates.
121 //! Drop glue mono items are introduced by MIR drop-statements. The
122 //! generated mono item will again have drop-glue item neighbors if the
123 //! type to be dropped contains nested values that also need to be dropped. It
124 //! might also have a function item neighbor for the explicit `Drop::drop`
125 //! implementation of its type.
127 //! #### Unsizing Casts
128 //! A subtle way of introducing neighbor edges is by casting to a trait object.
129 //! Since the resulting fat-pointer contains a reference to a vtable, we need to
130 //! instantiate all object-save methods of the trait, as we need to store
131 //! pointers to these functions even if they never get called anywhere. This can
132 //! be seen as a special case of taking a function reference.
135 //! Since `Box` expression have special compiler support, no explicit calls to
136 //! `exchange_malloc()` and `box_free()` may show up in MIR, even if the
137 //! compiler will generate them. We have to observe `Rvalue::Box` expressions
138 //! and Box-typed drop-statements for that purpose.
141 //! Interaction with Cross-Crate Inlining
142 //! -------------------------------------
143 //! The binary of a crate will not only contain machine code for the items
144 //! defined in the source code of that crate. It will also contain monomorphic
145 //! instantiations of any extern generic functions and of functions marked with
147 //! The collection algorithm handles this more or less mono. If it is
148 //! about to create a mono item for something with an external `DefId`,
149 //! it will take a look if the MIR for that item is available, and if so just
150 //! proceed normally. If the MIR is not available, it assumes that the item is
151 //! just linked to and no node is created; which is exactly what we want, since
152 //! no machine code should be generated in the current crate for such an item.
154 //! Eager and Lazy Collection Mode
155 //! ------------------------------
156 //! Mono item collection can be performed in one of two modes:
158 //! - Lazy mode means that items will only be instantiated when actually
159 //! referenced. The goal is to produce the least amount of machine code
162 //! - Eager mode is meant to be used in conjunction with incremental compilation
163 //! where a stable set of mono items is more important than a minimal
164 //! one. Thus, eager mode will instantiate drop-glue for every drop-able type
165 //! in the crate, even if no drop call for that type exists (yet). It will
166 //! also instantiate default implementations of trait methods, something that
167 //! otherwise is only done on demand.
172 //! Some things are not yet fully implemented in the current version of this
176 //! Ideally, no mono item should be generated for const fns unless there
177 //! is a call to them that cannot be evaluated at compile time. At the moment
178 //! this is not implemented however: a mono item will be produced
179 //! regardless of whether it is actually needed or not.
181 use crate::monomorphize;
183 use rustc_data_structures::fx::{FxHashMap, FxHashSet};
184 use rustc_data_structures::sync::{par_iter, MTLock, MTRef, ParallelIterator};
185 use rustc_errors::{ErrorReported, FatalError};
186 use rustc_hir as hir;
187 use rustc_hir::def_id::{DefId, DefIdMap, LocalDefId, LOCAL_CRATE};
188 use rustc_hir::itemlikevisit::ItemLikeVisitor;
189 use rustc_hir::lang_items::LangItem;
190 use rustc_index::bit_set::GrowableBitSet;
191 use rustc_middle::mir::interpret::{AllocId, ConstValue};
192 use rustc_middle::mir::interpret::{ErrorHandled, GlobalAlloc, Scalar};
193 use rustc_middle::mir::mono::{InstantiationMode, MonoItem};
194 use rustc_middle::mir::visit::Visitor as MirVisitor;
195 use rustc_middle::mir::{self, Local, Location};
196 use rustc_middle::ty::adjustment::{CustomCoerceUnsized, PointerCast};
197 use rustc_middle::ty::subst::{GenericArgKind, InternalSubsts};
198 use rustc_middle::ty::{self, GenericParamDefKind, Instance, Ty, TyCtxt, TypeFoldable};
199 use rustc_middle::{middle::codegen_fn_attrs::CodegenFnAttrFlags, mir::visit::TyContext};
200 use rustc_session::config::EntryFnType;
201 use rustc_span::source_map::{dummy_spanned, respan, Span, Spanned, DUMMY_SP};
202 use smallvec::SmallVec;
205 use std::path::PathBuf;
208 pub enum MonoItemCollectionMode {
213 /// Maps every mono item to all mono items it references in its
215 pub struct InliningMap<'tcx> {
216 // Maps a source mono item to the range of mono items
218 // The range selects elements within the `targets` vecs.
219 index: FxHashMap<MonoItem<'tcx>, Range<usize>>,
220 targets: Vec<MonoItem<'tcx>>,
222 // Contains one bit per mono item in the `targets` field. That bit
223 // is true if that mono item needs to be inlined into every CGU.
224 inlines: GrowableBitSet<usize>,
227 impl<'tcx> InliningMap<'tcx> {
228 fn new() -> InliningMap<'tcx> {
230 index: FxHashMap::default(),
232 inlines: GrowableBitSet::with_capacity(1024),
236 fn record_accesses(&mut self, source: MonoItem<'tcx>, new_targets: &[(MonoItem<'tcx>, bool)]) {
237 let start_index = self.targets.len();
238 let new_items_count = new_targets.len();
239 let new_items_count_total = new_items_count + self.targets.len();
241 self.targets.reserve(new_items_count);
242 self.inlines.ensure(new_items_count_total);
244 for (i, (target, inline)) in new_targets.iter().enumerate() {
245 self.targets.push(*target);
247 self.inlines.insert(i + start_index);
251 let end_index = self.targets.len();
252 assert!(self.index.insert(source, start_index..end_index).is_none());
255 // Internally iterate over all items referenced by `source` which will be
256 // made available for inlining.
257 pub fn with_inlining_candidates<F>(&self, source: MonoItem<'tcx>, mut f: F)
259 F: FnMut(MonoItem<'tcx>),
261 if let Some(range) = self.index.get(&source) {
262 for (i, candidate) in self.targets[range.clone()].iter().enumerate() {
263 if self.inlines.contains(range.start + i) {
270 // Internally iterate over all items and the things each accesses.
271 pub fn iter_accesses<F>(&self, mut f: F)
273 F: FnMut(MonoItem<'tcx>, &[MonoItem<'tcx>]),
275 for (&accessor, range) in &self.index {
276 f(accessor, &self.targets[range.clone()])
281 pub fn collect_crate_mono_items(
283 mode: MonoItemCollectionMode,
284 ) -> (FxHashSet<MonoItem<'_>>, InliningMap<'_>) {
285 let _prof_timer = tcx.prof.generic_activity("monomorphization_collector");
288 tcx.sess.time("monomorphization_collector_root_collections", || collect_roots(tcx, mode));
290 debug!("building mono item graph, beginning at roots");
292 let mut visited = MTLock::new(FxHashSet::default());
293 let mut inlining_map = MTLock::new(InliningMap::new());
296 let visited: MTRef<'_, _> = &mut visited;
297 let inlining_map: MTRef<'_, _> = &mut inlining_map;
299 tcx.sess.time("monomorphization_collector_graph_walk", || {
300 par_iter(roots).for_each(|root| {
301 let mut recursion_depths = DefIdMap::default();
306 &mut recursion_depths,
313 (visited.into_inner(), inlining_map.into_inner())
316 // Find all non-generic items by walking the HIR. These items serve as roots to
317 // start monomorphizing from.
318 fn collect_roots(tcx: TyCtxt<'_>, mode: MonoItemCollectionMode) -> Vec<MonoItem<'_>> {
319 debug!("collecting roots");
320 let mut roots = Vec::new();
323 let entry_fn = tcx.entry_fn(LOCAL_CRATE);
325 debug!("collect_roots: entry_fn = {:?}", entry_fn);
327 let mut visitor = RootCollector { tcx, mode, entry_fn, output: &mut roots };
329 tcx.hir().krate().visit_all_item_likes(&mut visitor);
331 visitor.push_extra_entry_roots();
334 // We can only codegen items that are instantiable - items all of
335 // whose predicates hold. Luckily, items that aren't instantiable
336 // can't actually be used, so we can just skip codegenning them.
339 .filter_map(|root| root.node.is_instantiable(tcx).then_some(root.node))
343 // Collect all monomorphized items reachable from `starting_point`
344 fn collect_items_rec<'tcx>(
346 starting_point: Spanned<MonoItem<'tcx>>,
347 visited: MTRef<'_, MTLock<FxHashSet<MonoItem<'tcx>>>>,
348 recursion_depths: &mut DefIdMap<usize>,
349 inlining_map: MTRef<'_, MTLock<InliningMap<'tcx>>>,
351 if !visited.lock_mut().insert(starting_point.node) {
352 // We've been here already, no need to search again.
355 debug!("BEGIN collect_items_rec({})", starting_point.node);
357 let mut neighbors = Vec::new();
358 let recursion_depth_reset;
360 match starting_point.node {
361 MonoItem::Static(def_id) => {
362 let instance = Instance::mono(tcx, def_id);
364 // Sanity check whether this ended up being collected accidentally
365 debug_assert!(should_codegen_locally(tcx, &instance));
367 let ty = instance.ty(tcx, ty::ParamEnv::reveal_all());
368 visit_drop_use(tcx, ty, true, starting_point.span, &mut neighbors);
370 recursion_depth_reset = None;
372 if let Ok(alloc) = tcx.eval_static_initializer(def_id) {
373 for &((), id) in alloc.relocations().values() {
374 collect_miri(tcx, id, &mut neighbors);
378 MonoItem::Fn(instance) => {
379 // Sanity check whether this ended up being collected accidentally
380 debug_assert!(should_codegen_locally(tcx, &instance));
382 // Keep track of the monomorphization recursion depth
383 recursion_depth_reset =
384 Some(check_recursion_limit(tcx, instance, starting_point.span, recursion_depths));
385 check_type_length_limit(tcx, instance);
387 rustc_data_structures::stack::ensure_sufficient_stack(|| {
388 collect_neighbours(tcx, instance, &mut neighbors);
391 MonoItem::GlobalAsm(..) => {
392 recursion_depth_reset = None;
396 record_accesses(tcx, starting_point.node, neighbors.iter().map(|i| &i.node), inlining_map);
398 for neighbour in neighbors {
399 collect_items_rec(tcx, neighbour, visited, recursion_depths, inlining_map);
402 if let Some((def_id, depth)) = recursion_depth_reset {
403 recursion_depths.insert(def_id, depth);
406 debug!("END collect_items_rec({})", starting_point.node);
409 fn record_accesses<'a, 'tcx: 'a>(
411 caller: MonoItem<'tcx>,
412 callees: impl Iterator<Item = &'a MonoItem<'tcx>>,
413 inlining_map: MTRef<'_, MTLock<InliningMap<'tcx>>>,
415 let is_inlining_candidate = |mono_item: &MonoItem<'tcx>| {
416 mono_item.instantiation_mode(tcx) == InstantiationMode::LocalCopy
419 // We collect this into a `SmallVec` to avoid calling `is_inlining_candidate` in the lock.
420 // FIXME: Call `is_inlining_candidate` when pushing to `neighbors` in `collect_items_rec`
421 // instead to avoid creating this `SmallVec`.
422 let accesses: SmallVec<[_; 128]> =
423 callees.map(|mono_item| (*mono_item, is_inlining_candidate(mono_item))).collect();
425 inlining_map.lock_mut().record_accesses(caller, &accesses);
428 /// Format instance name that is already known to be too long for rustc.
429 /// Show only the first and last 32 characters to avoid blasting
430 /// the user's terminal with thousands of lines of type-name.
432 /// If the type name is longer than before+after, it will be written to a file.
433 fn shrunk_instance_name(
435 instance: &Instance<'tcx>,
438 ) -> (String, Option<PathBuf>) {
439 let s = instance.to_string();
441 // Only use the shrunk version if it's really shorter.
442 // This also avoids the case where before and after slices overlap.
443 if s.chars().nth(before + after + 1).is_some() {
444 // An iterator of all byte positions including the end of the string.
445 let positions = || s.char_indices().map(|(i, _)| i).chain(iter::once(s.len()));
447 let shrunk = format!(
448 "{before}...{after}",
449 before = &s[..positions().nth(before).unwrap_or(s.len())],
450 after = &s[positions().rev().nth(after).unwrap_or(0)..],
453 let path = tcx.output_filenames(LOCAL_CRATE).temp_path_ext("long-type.txt", None);
454 let written_to_path = std::fs::write(&path, s).ok().map(|_| path);
456 (shrunk, written_to_path)
462 fn check_recursion_limit<'tcx>(
464 instance: Instance<'tcx>,
466 recursion_depths: &mut DefIdMap<usize>,
467 ) -> (DefId, usize) {
468 let def_id = instance.def_id();
469 let recursion_depth = recursion_depths.get(&def_id).cloned().unwrap_or(0);
470 debug!(" => recursion depth={}", recursion_depth);
472 let adjusted_recursion_depth = if Some(def_id) == tcx.lang_items().drop_in_place_fn() {
473 // HACK: drop_in_place creates tight monomorphization loops. Give
480 // Code that needs to instantiate the same function recursively
481 // more than the recursion limit is assumed to be causing an
482 // infinite expansion.
483 if !tcx.sess.recursion_limit().value_within_limit(adjusted_recursion_depth) {
484 let (shrunk, written_to_path) = shrunk_instance_name(tcx, &instance, 32, 32);
485 let error = format!("reached the recursion limit while instantiating `{}`", shrunk);
486 let mut err = tcx.sess.struct_span_fatal(span, &error);
488 tcx.def_span(def_id),
489 &format!("`{}` defined here", tcx.def_path_str(def_id)),
491 if let Some(path) = written_to_path {
492 err.note(&format!("the full type name has been written to '{}'", path.display()));
498 recursion_depths.insert(def_id, recursion_depth + 1);
500 (def_id, recursion_depth)
503 fn check_type_length_limit<'tcx>(tcx: TyCtxt<'tcx>, instance: Instance<'tcx>) {
504 let type_length = instance
507 .flat_map(|arg| arg.walk())
508 .filter(|arg| match arg.unpack() {
509 GenericArgKind::Type(_) | GenericArgKind::Const(_) => true,
510 GenericArgKind::Lifetime(_) => false,
513 debug!(" => type length={}", type_length);
515 // Rust code can easily create exponentially-long types using only a
516 // polynomial recursion depth. Even with the default recursion
517 // depth, you can easily get cases that take >2^60 steps to run,
518 // which means that rustc basically hangs.
520 // Bail out in these cases to avoid that bad user experience.
521 if !tcx.sess.type_length_limit().value_within_limit(type_length) {
522 let (shrunk, written_to_path) = shrunk_instance_name(tcx, &instance, 32, 32);
523 let msg = format!("reached the type-length limit while instantiating `{}`", shrunk);
524 let mut diag = tcx.sess.struct_span_fatal(tcx.def_span(instance.def_id()), &msg);
525 if let Some(path) = written_to_path {
526 diag.note(&format!("the full type name has been written to '{}'", path.display()));
529 "consider adding a `#![type_length_limit=\"{}\"]` attribute to your crate",
533 tcx.sess.abort_if_errors();
537 struct MirNeighborCollector<'a, 'tcx> {
539 body: &'a mir::Body<'tcx>,
540 output: &'a mut Vec<Spanned<MonoItem<'tcx>>>,
541 instance: Instance<'tcx>,
544 impl<'a, 'tcx> MirNeighborCollector<'a, 'tcx> {
545 pub fn monomorphize<T>(&self, value: T) -> T
547 T: TypeFoldable<'tcx>,
549 debug!("monomorphize: self.instance={:?}", self.instance);
550 self.instance.subst_mir_and_normalize_erasing_regions(
552 ty::ParamEnv::reveal_all(),
558 impl<'a, 'tcx> MirVisitor<'tcx> for MirNeighborCollector<'a, 'tcx> {
559 fn visit_rvalue(&mut self, rvalue: &mir::Rvalue<'tcx>, location: Location) {
560 debug!("visiting rvalue {:?}", *rvalue);
562 let span = self.body.source_info(location).span;
565 // When doing an cast from a regular pointer to a fat pointer, we
566 // have to instantiate all methods of the trait being cast to, so we
567 // can build the appropriate vtable.
569 mir::CastKind::Pointer(PointerCast::Unsize),
573 let target_ty = self.monomorphize(target_ty);
574 let source_ty = operand.ty(self.body, self.tcx);
575 let source_ty = self.monomorphize(source_ty);
576 let (source_ty, target_ty) =
577 find_vtable_types_for_unsizing(self.tcx, source_ty, target_ty);
578 // This could also be a different Unsize instruction, like
579 // from a fixed sized array to a slice. But we are only
580 // interested in things that produce a vtable.
581 if target_ty.is_trait() && !source_ty.is_trait() {
582 create_mono_items_for_vtable_methods(
592 mir::CastKind::Pointer(PointerCast::ReifyFnPointer),
596 let fn_ty = operand.ty(self.body, self.tcx);
597 let fn_ty = self.monomorphize(fn_ty);
598 visit_fn_use(self.tcx, fn_ty, false, span, &mut self.output);
601 mir::CastKind::Pointer(PointerCast::ClosureFnPointer(_)),
605 let source_ty = operand.ty(self.body, self.tcx);
606 let source_ty = self.monomorphize(source_ty);
607 match *source_ty.kind() {
608 ty::Closure(def_id, substs) => {
609 let instance = Instance::resolve_closure(
613 ty::ClosureKind::FnOnce,
615 if should_codegen_locally(self.tcx, &instance) {
616 self.output.push(create_fn_mono_item(self.tcx, instance, span));
622 mir::Rvalue::NullaryOp(mir::NullOp::Box, _) => {
624 let exchange_malloc_fn_def_id =
625 tcx.require_lang_item(LangItem::ExchangeMalloc, None);
626 let instance = Instance::mono(tcx, exchange_malloc_fn_def_id);
627 if should_codegen_locally(tcx, &instance) {
628 self.output.push(create_fn_mono_item(self.tcx, instance, span));
631 mir::Rvalue::ThreadLocalRef(def_id) => {
632 assert!(self.tcx.is_thread_local_static(def_id));
633 let instance = Instance::mono(self.tcx, def_id);
634 if should_codegen_locally(self.tcx, &instance) {
635 trace!("collecting thread-local static {:?}", def_id);
636 self.output.push(respan(span, MonoItem::Static(def_id)));
639 _ => { /* not interesting */ }
642 self.super_rvalue(rvalue, location);
645 /// This does not walk the constant, as it has been handled entirely here and trying
646 /// to walk it would attempt to evaluate the `ty::Const` inside, which doesn't necessarily
647 /// work, as some constants cannot be represented in the type system.
648 fn visit_constant(&mut self, constant: &mir::Constant<'tcx>, location: Location) {
649 let literal = self.monomorphize(constant.literal);
650 let val = match literal {
651 mir::ConstantKind::Val(val, _) => val,
652 mir::ConstantKind::Ty(ct) => match ct.val {
653 ty::ConstKind::Value(val) => val,
654 ty::ConstKind::Unevaluated(ct) => {
655 let param_env = ty::ParamEnv::reveal_all();
656 match self.tcx.const_eval_resolve(param_env, ct, None) {
657 // The `monomorphize` call should have evaluated that constant already.
659 Err(ErrorHandled::Reported(ErrorReported) | ErrorHandled::Linted) => return,
660 Err(ErrorHandled::TooGeneric) => span_bug!(
661 self.body.source_info(location).span,
662 "collection encountered polymorphic constant: {:?}",
670 collect_const_value(self.tcx, val, self.output);
671 self.visit_ty(literal.ty(), TyContext::Location(location));
674 fn visit_const(&mut self, constant: &&'tcx ty::Const<'tcx>, location: Location) {
675 debug!("visiting const {:?} @ {:?}", *constant, location);
677 let substituted_constant = self.monomorphize(*constant);
678 let param_env = ty::ParamEnv::reveal_all();
680 match substituted_constant.val {
681 ty::ConstKind::Value(val) => collect_const_value(self.tcx, val, self.output),
682 ty::ConstKind::Unevaluated(unevaluated) => {
683 match self.tcx.const_eval_resolve(param_env, unevaluated, None) {
684 // The `monomorphize` call should have evaluated that constant already.
685 Ok(val) => span_bug!(
686 self.body.source_info(location).span,
687 "collection encountered the unevaluated constant {} which evaluated to {:?}",
688 substituted_constant,
691 Err(ErrorHandled::Reported(ErrorReported) | ErrorHandled::Linted) => {}
692 Err(ErrorHandled::TooGeneric) => span_bug!(
693 self.body.source_info(location).span,
694 "collection encountered polymorphic constant: {}",
702 self.super_const(constant);
705 fn visit_terminator(&mut self, terminator: &mir::Terminator<'tcx>, location: Location) {
706 debug!("visiting terminator {:?} @ {:?}", terminator, location);
707 let source = self.body.source_info(location).span;
710 match terminator.kind {
711 mir::TerminatorKind::Call { ref func, .. } => {
712 let callee_ty = func.ty(self.body, tcx);
713 let callee_ty = self.monomorphize(callee_ty);
714 visit_fn_use(self.tcx, callee_ty, true, source, &mut self.output);
716 mir::TerminatorKind::Drop { ref place, .. }
717 | mir::TerminatorKind::DropAndReplace { ref place, .. } => {
718 let ty = place.ty(self.body, self.tcx).ty;
719 let ty = self.monomorphize(ty);
720 visit_drop_use(self.tcx, ty, true, source, self.output);
722 mir::TerminatorKind::InlineAsm { ref operands, .. } => {
725 mir::InlineAsmOperand::SymFn { ref value } => {
726 let fn_ty = self.monomorphize(value.literal.ty());
727 visit_fn_use(self.tcx, fn_ty, false, source, &mut self.output);
729 mir::InlineAsmOperand::SymStatic { def_id } => {
730 let instance = Instance::mono(self.tcx, def_id);
731 if should_codegen_locally(self.tcx, &instance) {
732 trace!("collecting asm sym static {:?}", def_id);
733 self.output.push(respan(source, MonoItem::Static(def_id)));
740 mir::TerminatorKind::Goto { .. }
741 | mir::TerminatorKind::SwitchInt { .. }
742 | mir::TerminatorKind::Resume
743 | mir::TerminatorKind::Abort
744 | mir::TerminatorKind::Return
745 | mir::TerminatorKind::Unreachable
746 | mir::TerminatorKind::Assert { .. } => {}
747 mir::TerminatorKind::GeneratorDrop
748 | mir::TerminatorKind::Yield { .. }
749 | mir::TerminatorKind::FalseEdge { .. }
750 | mir::TerminatorKind::FalseUnwind { .. } => bug!(),
753 self.super_terminator(terminator, location);
758 _place_local: &Local,
759 _context: mir::visit::PlaceContext,
765 fn visit_drop_use<'tcx>(
768 is_direct_call: bool,
770 output: &mut Vec<Spanned<MonoItem<'tcx>>>,
772 let instance = Instance::resolve_drop_in_place(tcx, ty);
773 visit_instance_use(tcx, instance, is_direct_call, source, output);
776 fn visit_fn_use<'tcx>(
779 is_direct_call: bool,
781 output: &mut Vec<Spanned<MonoItem<'tcx>>>,
783 if let ty::FnDef(def_id, substs) = *ty.kind() {
784 let instance = if is_direct_call {
785 ty::Instance::resolve(tcx, ty::ParamEnv::reveal_all(), def_id, substs).unwrap().unwrap()
787 ty::Instance::resolve_for_fn_ptr(tcx, ty::ParamEnv::reveal_all(), def_id, substs)
790 visit_instance_use(tcx, instance, is_direct_call, source, output);
794 fn visit_instance_use<'tcx>(
796 instance: ty::Instance<'tcx>,
797 is_direct_call: bool,
799 output: &mut Vec<Spanned<MonoItem<'tcx>>>,
801 debug!("visit_item_use({:?}, is_direct_call={:?})", instance, is_direct_call);
802 if !should_codegen_locally(tcx, &instance) {
807 ty::InstanceDef::Virtual(..) | ty::InstanceDef::Intrinsic(_) => {
809 bug!("{:?} being reified", instance);
812 ty::InstanceDef::DropGlue(_, None) => {
813 // Don't need to emit noop drop glue if we are calling directly.
815 output.push(create_fn_mono_item(tcx, instance, source));
818 ty::InstanceDef::DropGlue(_, Some(_))
819 | ty::InstanceDef::VtableShim(..)
820 | ty::InstanceDef::ReifyShim(..)
821 | ty::InstanceDef::ClosureOnceShim { .. }
822 | ty::InstanceDef::Item(..)
823 | ty::InstanceDef::FnPtrShim(..)
824 | ty::InstanceDef::CloneShim(..) => {
825 output.push(create_fn_mono_item(tcx, instance, source));
830 // Returns `true` if we should codegen an instance in the local crate.
831 // Returns `false` if we can just link to the upstream crate and therefore don't
833 fn should_codegen_locally<'tcx>(tcx: TyCtxt<'tcx>, instance: &Instance<'tcx>) -> bool {
834 let def_id = match instance.def {
835 ty::InstanceDef::Item(def) => def.did,
836 ty::InstanceDef::DropGlue(def_id, Some(_)) => def_id,
837 ty::InstanceDef::VtableShim(..)
838 | ty::InstanceDef::ReifyShim(..)
839 | ty::InstanceDef::ClosureOnceShim { .. }
840 | ty::InstanceDef::Virtual(..)
841 | ty::InstanceDef::FnPtrShim(..)
842 | ty::InstanceDef::DropGlue(..)
843 | ty::InstanceDef::Intrinsic(_)
844 | ty::InstanceDef::CloneShim(..) => return true,
847 if tcx.is_foreign_item(def_id) {
848 // Foreign items are always linked against, there's no way of instantiating them.
852 if def_id.is_local() {
853 // Local items cannot be referred to locally without monomorphizing them locally.
857 if tcx.is_reachable_non_generic(def_id)
858 || instance.polymorphize(tcx).upstream_monomorphization(tcx).is_some()
860 // We can link to the item in question, no instance needed in this crate.
864 if !tcx.is_mir_available(def_id) {
865 bug!("no MIR available for {:?}", def_id);
871 /// For a given pair of source and target type that occur in an unsizing coercion,
872 /// this function finds the pair of types that determines the vtable linking
875 /// For example, the source type might be `&SomeStruct` and the target type\
876 /// might be `&SomeTrait` in a cast like:
878 /// let src: &SomeStruct = ...;
879 /// let target = src as &SomeTrait;
881 /// Then the output of this function would be (SomeStruct, SomeTrait) since for
882 /// constructing the `target` fat-pointer we need the vtable for that pair.
884 /// Things can get more complicated though because there's also the case where
885 /// the unsized type occurs as a field:
888 /// struct ComplexStruct<T: ?Sized> {
895 /// In this case, if `T` is sized, `&ComplexStruct<T>` is a thin pointer. If `T`
896 /// is unsized, `&SomeStruct` is a fat pointer, and the vtable it points to is
897 /// for the pair of `T` (which is a trait) and the concrete type that `T` was
898 /// originally coerced from:
900 /// let src: &ComplexStruct<SomeStruct> = ...;
901 /// let target = src as &ComplexStruct<SomeTrait>;
903 /// Again, we want this `find_vtable_types_for_unsizing()` to provide the pair
904 /// `(SomeStruct, SomeTrait)`.
906 /// Finally, there is also the case of custom unsizing coercions, e.g., for
907 /// smart pointers such as `Rc` and `Arc`.
908 fn find_vtable_types_for_unsizing<'tcx>(
912 ) -> (Ty<'tcx>, Ty<'tcx>) {
913 let ptr_vtable = |inner_source: Ty<'tcx>, inner_target: Ty<'tcx>| {
914 let param_env = ty::ParamEnv::reveal_all();
915 let type_has_metadata = |ty: Ty<'tcx>| -> bool {
916 if ty.is_sized(tcx.at(DUMMY_SP), param_env) {
919 let tail = tcx.struct_tail_erasing_lifetimes(ty, param_env);
921 ty::Foreign(..) => false,
922 ty::Str | ty::Slice(..) | ty::Dynamic(..) => true,
923 _ => bug!("unexpected unsized tail: {:?}", tail),
926 if type_has_metadata(inner_source) {
927 (inner_source, inner_target)
929 tcx.struct_lockstep_tails_erasing_lifetimes(inner_source, inner_target, param_env)
933 match (&source_ty.kind(), &target_ty.kind()) {
934 (&ty::Ref(_, a, _), &ty::Ref(_, b, _) | &ty::RawPtr(ty::TypeAndMut { ty: b, .. }))
935 | (&ty::RawPtr(ty::TypeAndMut { ty: a, .. }), &ty::RawPtr(ty::TypeAndMut { ty: b, .. })) => {
938 (&ty::Adt(def_a, _), &ty::Adt(def_b, _)) if def_a.is_box() && def_b.is_box() => {
939 ptr_vtable(source_ty.boxed_ty(), target_ty.boxed_ty())
942 (&ty::Adt(source_adt_def, source_substs), &ty::Adt(target_adt_def, target_substs)) => {
943 assert_eq!(source_adt_def, target_adt_def);
945 let CustomCoerceUnsized::Struct(coerce_index) =
946 monomorphize::custom_coerce_unsize_info(tcx, source_ty, target_ty);
948 let source_fields = &source_adt_def.non_enum_variant().fields;
949 let target_fields = &target_adt_def.non_enum_variant().fields;
952 coerce_index < source_fields.len() && source_fields.len() == target_fields.len()
955 find_vtable_types_for_unsizing(
957 source_fields[coerce_index].ty(tcx, source_substs),
958 target_fields[coerce_index].ty(tcx, target_substs),
962 "find_vtable_types_for_unsizing: invalid coercion {:?} -> {:?}",
969 fn create_fn_mono_item<'tcx>(
971 instance: Instance<'tcx>,
973 ) -> Spanned<MonoItem<'tcx>> {
974 debug!("create_fn_mono_item(instance={})", instance);
975 respan(source, MonoItem::Fn(instance.polymorphize(tcx)))
978 /// Creates a `MonoItem` for each method that is referenced by the vtable for
979 /// the given trait/impl pair.
980 fn create_mono_items_for_vtable_methods<'tcx>(
985 output: &mut Vec<Spanned<MonoItem<'tcx>>>,
987 assert!(!trait_ty.has_escaping_bound_vars() && !impl_ty.has_escaping_bound_vars());
989 if let ty::Dynamic(ref trait_ty, ..) = trait_ty.kind() {
990 if let Some(principal) = trait_ty.principal() {
991 let poly_trait_ref = principal.with_self_ty(tcx, impl_ty);
992 assert!(!poly_trait_ref.has_escaping_bound_vars());
994 // Walk all methods of the trait, including those of its supertraits
995 let methods = tcx.vtable_methods(poly_trait_ref);
996 let methods = methods
999 .filter_map(|method| method)
1000 .map(|(def_id, substs)| {
1001 ty::Instance::resolve_for_vtable(
1003 ty::ParamEnv::reveal_all(),
1009 .filter(|&instance| should_codegen_locally(tcx, &instance))
1010 .map(|item| create_fn_mono_item(tcx, item, source));
1011 output.extend(methods);
1014 // Also add the destructor.
1015 visit_drop_use(tcx, impl_ty, false, source, output);
1019 //=-----------------------------------------------------------------------------
1021 //=-----------------------------------------------------------------------------
1023 struct RootCollector<'a, 'tcx> {
1025 mode: MonoItemCollectionMode,
1026 output: &'a mut Vec<Spanned<MonoItem<'tcx>>>,
1027 entry_fn: Option<(LocalDefId, EntryFnType)>,
1030 impl ItemLikeVisitor<'v> for RootCollector<'_, 'v> {
1031 fn visit_item(&mut self, item: &'v hir::Item<'v>) {
1033 hir::ItemKind::ExternCrate(..)
1034 | hir::ItemKind::Use(..)
1035 | hir::ItemKind::ForeignMod { .. }
1036 | hir::ItemKind::TyAlias(..)
1037 | hir::ItemKind::Trait(..)
1038 | hir::ItemKind::TraitAlias(..)
1039 | hir::ItemKind::OpaqueTy(..)
1040 | hir::ItemKind::Mod(..) => {
1041 // Nothing to do, just keep recursing.
1044 hir::ItemKind::Impl { .. } => {
1045 if self.mode == MonoItemCollectionMode::Eager {
1046 create_mono_items_for_default_impls(self.tcx, item, self.output);
1050 hir::ItemKind::Enum(_, ref generics)
1051 | hir::ItemKind::Struct(_, ref generics)
1052 | hir::ItemKind::Union(_, ref generics) => {
1053 if generics.params.is_empty() {
1054 if self.mode == MonoItemCollectionMode::Eager {
1056 "RootCollector: ADT drop-glue for {}",
1057 self.tcx.def_path_str(item.def_id.to_def_id())
1060 let ty = Instance::new(item.def_id.to_def_id(), InternalSubsts::empty())
1061 .ty(self.tcx, ty::ParamEnv::reveal_all());
1062 visit_drop_use(self.tcx, ty, true, DUMMY_SP, self.output);
1066 hir::ItemKind::GlobalAsm(..) => {
1068 "RootCollector: ItemKind::GlobalAsm({})",
1069 self.tcx.def_path_str(item.def_id.to_def_id())
1071 self.output.push(dummy_spanned(MonoItem::GlobalAsm(item.item_id())));
1073 hir::ItemKind::Static(..) => {
1075 "RootCollector: ItemKind::Static({})",
1076 self.tcx.def_path_str(item.def_id.to_def_id())
1078 self.output.push(dummy_spanned(MonoItem::Static(item.def_id.to_def_id())));
1080 hir::ItemKind::Const(..) => {
1081 // const items only generate mono items if they are
1082 // actually used somewhere. Just declaring them is insufficient.
1084 // but even just declaring them must collect the items they refer to
1085 if let Ok(val) = self.tcx.const_eval_poly(item.def_id.to_def_id()) {
1086 collect_const_value(self.tcx, val, &mut self.output);
1089 hir::ItemKind::Fn(..) => {
1090 self.push_if_root(item.def_id);
1095 fn visit_trait_item(&mut self, _: &'v hir::TraitItem<'v>) {
1096 // Even if there's a default body with no explicit generics,
1097 // it's still generic over some `Self: Trait`, so not a root.
1100 fn visit_impl_item(&mut self, ii: &'v hir::ImplItem<'v>) {
1101 if let hir::ImplItemKind::Fn(hir::FnSig { .. }, _) = ii.kind {
1102 self.push_if_root(ii.def_id);
1106 fn visit_foreign_item(&mut self, _foreign_item: &'v hir::ForeignItem<'v>) {}
1109 impl RootCollector<'_, 'v> {
1110 fn is_root(&self, def_id: LocalDefId) -> bool {
1111 !item_requires_monomorphization(self.tcx, def_id)
1112 && match self.mode {
1113 MonoItemCollectionMode::Eager => true,
1114 MonoItemCollectionMode::Lazy => {
1115 self.entry_fn.map(|(id, _)| id) == Some(def_id)
1116 || self.tcx.is_reachable_non_generic(def_id)
1119 .codegen_fn_attrs(def_id)
1121 .contains(CodegenFnAttrFlags::RUSTC_STD_INTERNAL_SYMBOL)
1126 /// If `def_id` represents a root, pushes it onto the list of
1127 /// outputs. (Note that all roots must be monomorphic.)
1128 fn push_if_root(&mut self, def_id: LocalDefId) {
1129 if self.is_root(def_id) {
1130 debug!("RootCollector::push_if_root: found root def_id={:?}", def_id);
1132 let instance = Instance::mono(self.tcx, def_id.to_def_id());
1133 self.output.push(create_fn_mono_item(self.tcx, instance, DUMMY_SP));
1137 /// As a special case, when/if we encounter the
1138 /// `main()` function, we also have to generate a
1139 /// monomorphized copy of the start lang item based on
1140 /// the return type of `main`. This is not needed when
1141 /// the user writes their own `start` manually.
1142 fn push_extra_entry_roots(&mut self) {
1143 let main_def_id = match self.entry_fn {
1144 Some((def_id, EntryFnType::Main)) => def_id,
1148 let start_def_id = match self.tcx.lang_items().require(LangItem::Start) {
1150 Err(err) => self.tcx.sess.fatal(&err),
1152 let main_ret_ty = self.tcx.fn_sig(main_def_id).output();
1154 // Given that `main()` has no arguments,
1155 // then its return type cannot have
1156 // late-bound regions, since late-bound
1157 // regions must appear in the argument
1159 let main_ret_ty = self.tcx.erase_regions(main_ret_ty.no_bound_vars().unwrap());
1161 let start_instance = Instance::resolve(
1163 ty::ParamEnv::reveal_all(),
1165 self.tcx.intern_substs(&[main_ret_ty.into()]),
1170 self.output.push(create_fn_mono_item(self.tcx, start_instance, DUMMY_SP));
1174 fn item_requires_monomorphization(tcx: TyCtxt<'_>, def_id: LocalDefId) -> bool {
1175 let generics = tcx.generics_of(def_id);
1176 generics.requires_monomorphization(tcx)
1179 fn create_mono_items_for_default_impls<'tcx>(
1181 item: &'tcx hir::Item<'tcx>,
1182 output: &mut Vec<Spanned<MonoItem<'tcx>>>,
1185 hir::ItemKind::Impl(ref impl_) => {
1186 for param in impl_.generics.params {
1188 hir::GenericParamKind::Lifetime { .. } => {}
1189 hir::GenericParamKind::Type { .. } | hir::GenericParamKind::Const { .. } => {
1196 "create_mono_items_for_default_impls(item={})",
1197 tcx.def_path_str(item.def_id.to_def_id())
1200 if let Some(trait_ref) = tcx.impl_trait_ref(item.def_id) {
1201 let param_env = ty::ParamEnv::reveal_all();
1202 let trait_ref = tcx.normalize_erasing_regions(param_env, trait_ref);
1203 let overridden_methods: FxHashSet<_> =
1204 impl_.items.iter().map(|iiref| iiref.ident.normalize_to_macros_2_0()).collect();
1205 for method in tcx.provided_trait_methods(trait_ref.def_id) {
1206 if overridden_methods.contains(&method.ident.normalize_to_macros_2_0()) {
1210 if tcx.generics_of(method.def_id).own_requires_monomorphization() {
1215 InternalSubsts::for_item(tcx, method.def_id, |param, _| match param.kind {
1216 GenericParamDefKind::Lifetime => tcx.lifetimes.re_erased.into(),
1217 GenericParamDefKind::Type { .. }
1218 | GenericParamDefKind::Const { .. } => {
1219 trait_ref.substs[param.index as usize]
1222 let instance = ty::Instance::resolve(tcx, param_env, method.def_id, substs)
1226 let mono_item = create_fn_mono_item(tcx, instance, DUMMY_SP);
1227 if mono_item.node.is_instantiable(tcx) && should_codegen_locally(tcx, &instance)
1229 output.push(mono_item);
1238 /// Scans the miri alloc in order to find function calls, closures, and drop-glue.
1239 fn collect_miri<'tcx>(
1242 output: &mut Vec<Spanned<MonoItem<'tcx>>>,
1244 match tcx.global_alloc(alloc_id) {
1245 GlobalAlloc::Static(def_id) => {
1246 assert!(!tcx.is_thread_local_static(def_id));
1247 let instance = Instance::mono(tcx, def_id);
1248 if should_codegen_locally(tcx, &instance) {
1249 trace!("collecting static {:?}", def_id);
1250 output.push(dummy_spanned(MonoItem::Static(def_id)));
1253 GlobalAlloc::Memory(alloc) => {
1254 trace!("collecting {:?} with {:#?}", alloc_id, alloc);
1255 for &((), inner) in alloc.relocations().values() {
1256 rustc_data_structures::stack::ensure_sufficient_stack(|| {
1257 collect_miri(tcx, inner, output);
1261 GlobalAlloc::Function(fn_instance) => {
1262 if should_codegen_locally(tcx, &fn_instance) {
1263 trace!("collecting {:?} with {:#?}", alloc_id, fn_instance);
1264 output.push(create_fn_mono_item(tcx, fn_instance, DUMMY_SP));
1270 /// Scans the MIR in order to find function calls, closures, and drop-glue.
1271 fn collect_neighbours<'tcx>(
1273 instance: Instance<'tcx>,
1274 output: &mut Vec<Spanned<MonoItem<'tcx>>>,
1276 debug!("collect_neighbours: {:?}", instance.def_id());
1277 let body = tcx.instance_mir(instance.def);
1279 MirNeighborCollector { tcx, body: &body, output, instance }.visit_body(&body);
1282 fn collect_const_value<'tcx>(
1284 value: ConstValue<'tcx>,
1285 output: &mut Vec<Spanned<MonoItem<'tcx>>>,
1288 ConstValue::Scalar(Scalar::Ptr(ptr)) => collect_miri(tcx, ptr.alloc_id, output),
1289 ConstValue::Slice { data: alloc, start: _, end: _ } | ConstValue::ByRef { alloc, .. } => {
1290 for &((), id) in alloc.relocations().values() {
1291 collect_miri(tcx, id, output);