]> git.lizzy.rs Git - rust.git/blob - compiler/rustc_mir/src/monomorphize/collector.rs
Rollup merge of #85649 - ChrisDenton:update-cc, r=matthewjasper
[rust.git] / compiler / rustc_mir / src / monomorphize / collector.rs
1 //! Mono Item Collection
2 //! ====================
3 //!
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.
14 //!
15 //! The following kinds of "mono items" are handled here:
16 //!
17 //! - Functions
18 //! - Methods
19 //! - Closures
20 //! - Statics
21 //! - Drop glue
22 //!
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
25 //! codegen unit:
26 //!
27 //! - Constants
28 //! - Vtables
29 //! - Object Shims
30 //!
31 //!
32 //! General Algorithm
33 //! -----------------
34 //! Let's define some terms first:
35 //!
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
43 //!   for B.
44 //!
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".
48 //!
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.
51 //!
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:
54 //!
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.
59 //!
60 //! ### Discovering roots
61 //!
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.)
71 //!
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:
80 //!
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.
88 //!
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:
93 //!
94 //! ```rust
95 //! fn print_val<T: Display>(x: T) {
96 //!     println!("{}", x);
97 //! }
98 //!
99 //! fn call_fn(f: &Fn(i32), x: i32) {
100 //!     f(x);
101 //! }
102 //!
103 //! fn main() {
104 //!     let print_i32 = print_val::<i32>;
105 //!     call_fn(&print_i32, 0);
106 //! }
107 //! ```
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.
113 //!
114 //! #### Closures
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.
119 //!
120 //! #### Drop glue
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.
126 //!
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.
133 //!
134 //! #### Boxes
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.
139 //!
140 //!
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
146 //! `#[inline]`.
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.
153 //!
154 //! Eager and Lazy Collection Mode
155 //! ------------------------------
156 //! Mono item collection can be performed in one of two modes:
157 //!
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
160 //!   possible.
161 //!
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.
168 //!
169 //!
170 //! Open Issues
171 //! -----------
172 //! Some things are not yet fully implemented in the current version of this
173 //! module.
174 //!
175 //! ### Const Fns
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.
180
181 use crate::monomorphize;
182
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_session::lint::builtin::LARGE_ASSIGNMENTS;
202 use rustc_span::source_map::{dummy_spanned, respan, Span, Spanned, DUMMY_SP};
203 use rustc_target::abi::Size;
204 use smallvec::SmallVec;
205 use std::iter;
206 use std::ops::Range;
207 use std::path::PathBuf;
208
209 #[derive(PartialEq)]
210 pub enum MonoItemCollectionMode {
211     Eager,
212     Lazy,
213 }
214
215 /// Maps every mono item to all mono items it references in its
216 /// body.
217 pub struct InliningMap<'tcx> {
218     // Maps a source mono item to the range of mono items
219     // accessed by it.
220     // The range selects elements within the `targets` vecs.
221     index: FxHashMap<MonoItem<'tcx>, Range<usize>>,
222     targets: Vec<MonoItem<'tcx>>,
223
224     // Contains one bit per mono item in the `targets` field. That bit
225     // is true if that mono item needs to be inlined into every CGU.
226     inlines: GrowableBitSet<usize>,
227 }
228
229 impl<'tcx> InliningMap<'tcx> {
230     fn new() -> InliningMap<'tcx> {
231         InliningMap {
232             index: FxHashMap::default(),
233             targets: Vec::new(),
234             inlines: GrowableBitSet::with_capacity(1024),
235         }
236     }
237
238     fn record_accesses(&mut self, source: MonoItem<'tcx>, new_targets: &[(MonoItem<'tcx>, bool)]) {
239         let start_index = self.targets.len();
240         let new_items_count = new_targets.len();
241         let new_items_count_total = new_items_count + self.targets.len();
242
243         self.targets.reserve(new_items_count);
244         self.inlines.ensure(new_items_count_total);
245
246         for (i, (target, inline)) in new_targets.iter().enumerate() {
247             self.targets.push(*target);
248             if *inline {
249                 self.inlines.insert(i + start_index);
250             }
251         }
252
253         let end_index = self.targets.len();
254         assert!(self.index.insert(source, start_index..end_index).is_none());
255     }
256
257     // Internally iterate over all items referenced by `source` which will be
258     // made available for inlining.
259     pub fn with_inlining_candidates<F>(&self, source: MonoItem<'tcx>, mut f: F)
260     where
261         F: FnMut(MonoItem<'tcx>),
262     {
263         if let Some(range) = self.index.get(&source) {
264             for (i, candidate) in self.targets[range.clone()].iter().enumerate() {
265                 if self.inlines.contains(range.start + i) {
266                     f(*candidate);
267                 }
268             }
269         }
270     }
271
272     // Internally iterate over all items and the things each accesses.
273     pub fn iter_accesses<F>(&self, mut f: F)
274     where
275         F: FnMut(MonoItem<'tcx>, &[MonoItem<'tcx>]),
276     {
277         for (&accessor, range) in &self.index {
278             f(accessor, &self.targets[range.clone()])
279         }
280     }
281 }
282
283 pub fn collect_crate_mono_items(
284     tcx: TyCtxt<'_>,
285     mode: MonoItemCollectionMode,
286 ) -> (FxHashSet<MonoItem<'_>>, InliningMap<'_>) {
287     let _prof_timer = tcx.prof.generic_activity("monomorphization_collector");
288
289     let roots =
290         tcx.sess.time("monomorphization_collector_root_collections", || collect_roots(tcx, mode));
291
292     debug!("building mono item graph, beginning at roots");
293
294     let mut visited = MTLock::new(FxHashSet::default());
295     let mut inlining_map = MTLock::new(InliningMap::new());
296
297     {
298         let visited: MTRef<'_, _> = &mut visited;
299         let inlining_map: MTRef<'_, _> = &mut inlining_map;
300
301         tcx.sess.time("monomorphization_collector_graph_walk", || {
302             par_iter(roots).for_each(|root| {
303                 let mut recursion_depths = DefIdMap::default();
304                 collect_items_rec(
305                     tcx,
306                     dummy_spanned(root),
307                     visited,
308                     &mut recursion_depths,
309                     inlining_map,
310                 );
311             });
312         });
313     }
314
315     (visited.into_inner(), inlining_map.into_inner())
316 }
317
318 // Find all non-generic items by walking the HIR. These items serve as roots to
319 // start monomorphizing from.
320 fn collect_roots(tcx: TyCtxt<'_>, mode: MonoItemCollectionMode) -> Vec<MonoItem<'_>> {
321     debug!("collecting roots");
322     let mut roots = Vec::new();
323
324     {
325         let entry_fn = tcx.entry_fn(());
326
327         debug!("collect_roots: entry_fn = {:?}", entry_fn);
328
329         let mut visitor = RootCollector { tcx, mode, entry_fn, output: &mut roots };
330
331         tcx.hir().krate().visit_all_item_likes(&mut visitor);
332
333         visitor.push_extra_entry_roots();
334     }
335
336     // We can only codegen items that are instantiable - items all of
337     // whose predicates hold. Luckily, items that aren't instantiable
338     // can't actually be used, so we can just skip codegenning them.
339     roots
340         .into_iter()
341         .filter_map(|root| root.node.is_instantiable(tcx).then_some(root.node))
342         .collect()
343 }
344
345 /// Collect all monomorphized items reachable from `starting_point`, and emit a note diagnostic if a
346 /// post-monorphization error is encountered during a collection step.
347 fn collect_items_rec<'tcx>(
348     tcx: TyCtxt<'tcx>,
349     starting_point: Spanned<MonoItem<'tcx>>,
350     visited: MTRef<'_, MTLock<FxHashSet<MonoItem<'tcx>>>>,
351     recursion_depths: &mut DefIdMap<usize>,
352     inlining_map: MTRef<'_, MTLock<InliningMap<'tcx>>>,
353 ) {
354     if !visited.lock_mut().insert(starting_point.node) {
355         // We've been here already, no need to search again.
356         return;
357     }
358     debug!("BEGIN collect_items_rec({})", starting_point.node);
359
360     let mut neighbors = Vec::new();
361     let recursion_depth_reset;
362
363     //
364     // Post-monomorphization errors MVP
365     //
366     // We can encounter errors while monomorphizing an item, but we don't have a good way of
367     // showing a complete stack of spans ultimately leading to collecting the erroneous one yet.
368     // (It's also currently unclear exactly which diagnostics and information would be interesting
369     // to report in such cases)
370     //
371     // This leads to suboptimal error reporting: a post-monomorphization error (PME) will be
372     // shown with just a spanned piece of code causing the error, without information on where
373     // it was called from. This is especially obscure if the erroneous mono item is in a
374     // dependency. See for example issue #85155, where, before minimization, a PME happened two
375     // crates downstream from libcore's stdarch, without a way to know which dependency was the
376     // cause.
377     //
378     // If such an error occurs in the current crate, its span will be enough to locate the
379     // source. If the cause is in another crate, the goal here is to quickly locate which mono
380     // item in the current crate is ultimately responsible for causing the error.
381     //
382     // To give at least _some_ context to the user: while collecting mono items, we check the
383     // error count. If it has changed, a PME occurred, and we trigger some diagnostics about the
384     // current step of mono items collection.
385     //
386     let error_count = tcx.sess.diagnostic().err_count();
387
388     match starting_point.node {
389         MonoItem::Static(def_id) => {
390             let instance = Instance::mono(tcx, def_id);
391
392             // Sanity check whether this ended up being collected accidentally
393             debug_assert!(should_codegen_locally(tcx, &instance));
394
395             let ty = instance.ty(tcx, ty::ParamEnv::reveal_all());
396             visit_drop_use(tcx, ty, true, starting_point.span, &mut neighbors);
397
398             recursion_depth_reset = None;
399
400             if let Ok(alloc) = tcx.eval_static_initializer(def_id) {
401                 for &((), id) in alloc.relocations().values() {
402                     collect_miri(tcx, id, &mut neighbors);
403                 }
404             }
405         }
406         MonoItem::Fn(instance) => {
407             // Sanity check whether this ended up being collected accidentally
408             debug_assert!(should_codegen_locally(tcx, &instance));
409
410             // Keep track of the monomorphization recursion depth
411             recursion_depth_reset =
412                 Some(check_recursion_limit(tcx, instance, starting_point.span, recursion_depths));
413             check_type_length_limit(tcx, instance);
414
415             rustc_data_structures::stack::ensure_sufficient_stack(|| {
416                 collect_neighbours(tcx, instance, &mut neighbors);
417             });
418         }
419         MonoItem::GlobalAsm(item_id) => {
420             recursion_depth_reset = None;
421
422             let item = tcx.hir().item(item_id);
423             if let hir::ItemKind::GlobalAsm(asm) = item.kind {
424                 for (op, op_sp) in asm.operands {
425                     match op {
426                         hir::InlineAsmOperand::Const { .. } => {
427                             // Only constants which resolve to a plain integer
428                             // are supported. Therefore the value should not
429                             // depend on any other items.
430                         }
431                         _ => span_bug!(*op_sp, "invalid operand type for global_asm!"),
432                     }
433                 }
434             } else {
435                 span_bug!(item.span, "Mismatch between hir::Item type and MonoItem type")
436             }
437         }
438     }
439
440     // Check for PMEs and emit a diagnostic if one happened. To try to show relevant edges of the
441     // mono item graph where the PME diagnostics are currently the most problematic (e.g. ones
442     // involving a dependency, and the lack of context is confusing) in this MVP, we focus on
443     // diagnostics on edges crossing a crate boundary: the collected mono items which are not
444     // defined in the local crate.
445     if tcx.sess.diagnostic().err_count() > error_count && starting_point.node.krate() != LOCAL_CRATE
446     {
447         tcx.sess.span_note_without_error(
448             starting_point.span,
449             &format!(
450                 "the above error was encountered while instantiating `{}`",
451                 starting_point.node
452             ),
453         );
454     }
455
456     record_accesses(tcx, starting_point.node, neighbors.iter().map(|i| &i.node), inlining_map);
457
458     for neighbour in neighbors {
459         collect_items_rec(tcx, neighbour, visited, recursion_depths, inlining_map);
460     }
461
462     if let Some((def_id, depth)) = recursion_depth_reset {
463         recursion_depths.insert(def_id, depth);
464     }
465
466     debug!("END collect_items_rec({})", starting_point.node);
467 }
468
469 fn record_accesses<'a, 'tcx: 'a>(
470     tcx: TyCtxt<'tcx>,
471     caller: MonoItem<'tcx>,
472     callees: impl Iterator<Item = &'a MonoItem<'tcx>>,
473     inlining_map: MTRef<'_, MTLock<InliningMap<'tcx>>>,
474 ) {
475     let is_inlining_candidate = |mono_item: &MonoItem<'tcx>| {
476         mono_item.instantiation_mode(tcx) == InstantiationMode::LocalCopy
477     };
478
479     // We collect this into a `SmallVec` to avoid calling `is_inlining_candidate` in the lock.
480     // FIXME: Call `is_inlining_candidate` when pushing to `neighbors` in `collect_items_rec`
481     // instead to avoid creating this `SmallVec`.
482     let accesses: SmallVec<[_; 128]> =
483         callees.map(|mono_item| (*mono_item, is_inlining_candidate(mono_item))).collect();
484
485     inlining_map.lock_mut().record_accesses(caller, &accesses);
486 }
487
488 /// Format instance name that is already known to be too long for rustc.
489 /// Show only the first and last 32 characters to avoid blasting
490 /// the user's terminal with thousands of lines of type-name.
491 ///
492 /// If the type name is longer than before+after, it will be written to a file.
493 fn shrunk_instance_name(
494     tcx: TyCtxt<'tcx>,
495     instance: &Instance<'tcx>,
496     before: usize,
497     after: usize,
498 ) -> (String, Option<PathBuf>) {
499     let s = instance.to_string();
500
501     // Only use the shrunk version if it's really shorter.
502     // This also avoids the case where before and after slices overlap.
503     if s.chars().nth(before + after + 1).is_some() {
504         // An iterator of all byte positions including the end of the string.
505         let positions = || s.char_indices().map(|(i, _)| i).chain(iter::once(s.len()));
506
507         let shrunk = format!(
508             "{before}...{after}",
509             before = &s[..positions().nth(before).unwrap_or(s.len())],
510             after = &s[positions().rev().nth(after).unwrap_or(0)..],
511         );
512
513         let path = tcx.output_filenames(()).temp_path_ext("long-type.txt", None);
514         let written_to_path = std::fs::write(&path, s).ok().map(|_| path);
515
516         (shrunk, written_to_path)
517     } else {
518         (s, None)
519     }
520 }
521
522 fn check_recursion_limit<'tcx>(
523     tcx: TyCtxt<'tcx>,
524     instance: Instance<'tcx>,
525     span: Span,
526     recursion_depths: &mut DefIdMap<usize>,
527 ) -> (DefId, usize) {
528     let def_id = instance.def_id();
529     let recursion_depth = recursion_depths.get(&def_id).cloned().unwrap_or(0);
530     debug!(" => recursion depth={}", recursion_depth);
531
532     let adjusted_recursion_depth = if Some(def_id) == tcx.lang_items().drop_in_place_fn() {
533         // HACK: drop_in_place creates tight monomorphization loops. Give
534         // it more margin.
535         recursion_depth / 4
536     } else {
537         recursion_depth
538     };
539
540     // Code that needs to instantiate the same function recursively
541     // more than the recursion limit is assumed to be causing an
542     // infinite expansion.
543     if !tcx.sess.recursion_limit().value_within_limit(adjusted_recursion_depth) {
544         let (shrunk, written_to_path) = shrunk_instance_name(tcx, &instance, 32, 32);
545         let error = format!("reached the recursion limit while instantiating `{}`", shrunk);
546         let mut err = tcx.sess.struct_span_fatal(span, &error);
547         err.span_note(
548             tcx.def_span(def_id),
549             &format!("`{}` defined here", tcx.def_path_str(def_id)),
550         );
551         if let Some(path) = written_to_path {
552             err.note(&format!("the full type name has been written to '{}'", path.display()));
553         }
554         err.emit();
555         FatalError.raise();
556     }
557
558     recursion_depths.insert(def_id, recursion_depth + 1);
559
560     (def_id, recursion_depth)
561 }
562
563 fn check_type_length_limit<'tcx>(tcx: TyCtxt<'tcx>, instance: Instance<'tcx>) {
564     let type_length = instance
565         .substs
566         .iter()
567         .flat_map(|arg| arg.walk())
568         .filter(|arg| match arg.unpack() {
569             GenericArgKind::Type(_) | GenericArgKind::Const(_) => true,
570             GenericArgKind::Lifetime(_) => false,
571         })
572         .count();
573     debug!(" => type length={}", type_length);
574
575     // Rust code can easily create exponentially-long types using only a
576     // polynomial recursion depth. Even with the default recursion
577     // depth, you can easily get cases that take >2^60 steps to run,
578     // which means that rustc basically hangs.
579     //
580     // Bail out in these cases to avoid that bad user experience.
581     if !tcx.sess.type_length_limit().value_within_limit(type_length) {
582         let (shrunk, written_to_path) = shrunk_instance_name(tcx, &instance, 32, 32);
583         let msg = format!("reached the type-length limit while instantiating `{}`", shrunk);
584         let mut diag = tcx.sess.struct_span_fatal(tcx.def_span(instance.def_id()), &msg);
585         if let Some(path) = written_to_path {
586             diag.note(&format!("the full type name has been written to '{}'", path.display()));
587         }
588         diag.help(&format!(
589             "consider adding a `#![type_length_limit=\"{}\"]` attribute to your crate",
590             type_length
591         ));
592         diag.emit();
593         tcx.sess.abort_if_errors();
594     }
595 }
596
597 struct MirNeighborCollector<'a, 'tcx> {
598     tcx: TyCtxt<'tcx>,
599     body: &'a mir::Body<'tcx>,
600     output: &'a mut Vec<Spanned<MonoItem<'tcx>>>,
601     instance: Instance<'tcx>,
602 }
603
604 impl<'a, 'tcx> MirNeighborCollector<'a, 'tcx> {
605     pub fn monomorphize<T>(&self, value: T) -> T
606     where
607         T: TypeFoldable<'tcx>,
608     {
609         debug!("monomorphize: self.instance={:?}", self.instance);
610         self.instance.subst_mir_and_normalize_erasing_regions(
611             self.tcx,
612             ty::ParamEnv::reveal_all(),
613             value,
614         )
615     }
616 }
617
618 impl<'a, 'tcx> MirVisitor<'tcx> for MirNeighborCollector<'a, 'tcx> {
619     fn visit_rvalue(&mut self, rvalue: &mir::Rvalue<'tcx>, location: Location) {
620         debug!("visiting rvalue {:?}", *rvalue);
621
622         let span = self.body.source_info(location).span;
623
624         match *rvalue {
625             // When doing an cast from a regular pointer to a fat pointer, we
626             // have to instantiate all methods of the trait being cast to, so we
627             // can build the appropriate vtable.
628             mir::Rvalue::Cast(
629                 mir::CastKind::Pointer(PointerCast::Unsize),
630                 ref operand,
631                 target_ty,
632             ) => {
633                 let target_ty = self.monomorphize(target_ty);
634                 let source_ty = operand.ty(self.body, self.tcx);
635                 let source_ty = self.monomorphize(source_ty);
636                 let (source_ty, target_ty) =
637                     find_vtable_types_for_unsizing(self.tcx, source_ty, target_ty);
638                 // This could also be a different Unsize instruction, like
639                 // from a fixed sized array to a slice. But we are only
640                 // interested in things that produce a vtable.
641                 if target_ty.is_trait() && !source_ty.is_trait() {
642                     create_mono_items_for_vtable_methods(
643                         self.tcx,
644                         target_ty,
645                         source_ty,
646                         span,
647                         self.output,
648                     );
649                 }
650             }
651             mir::Rvalue::Cast(
652                 mir::CastKind::Pointer(PointerCast::ReifyFnPointer),
653                 ref operand,
654                 _,
655             ) => {
656                 let fn_ty = operand.ty(self.body, self.tcx);
657                 let fn_ty = self.monomorphize(fn_ty);
658                 visit_fn_use(self.tcx, fn_ty, false, span, &mut self.output);
659             }
660             mir::Rvalue::Cast(
661                 mir::CastKind::Pointer(PointerCast::ClosureFnPointer(_)),
662                 ref operand,
663                 _,
664             ) => {
665                 let source_ty = operand.ty(self.body, self.tcx);
666                 let source_ty = self.monomorphize(source_ty);
667                 match *source_ty.kind() {
668                     ty::Closure(def_id, substs) => {
669                         let instance = Instance::resolve_closure(
670                             self.tcx,
671                             def_id,
672                             substs,
673                             ty::ClosureKind::FnOnce,
674                         );
675                         if should_codegen_locally(self.tcx, &instance) {
676                             self.output.push(create_fn_mono_item(self.tcx, instance, span));
677                         }
678                     }
679                     _ => bug!(),
680                 }
681             }
682             mir::Rvalue::NullaryOp(mir::NullOp::Box, _) => {
683                 let tcx = self.tcx;
684                 let exchange_malloc_fn_def_id =
685                     tcx.require_lang_item(LangItem::ExchangeMalloc, None);
686                 let instance = Instance::mono(tcx, exchange_malloc_fn_def_id);
687                 if should_codegen_locally(tcx, &instance) {
688                     self.output.push(create_fn_mono_item(self.tcx, instance, span));
689                 }
690             }
691             mir::Rvalue::ThreadLocalRef(def_id) => {
692                 assert!(self.tcx.is_thread_local_static(def_id));
693                 let instance = Instance::mono(self.tcx, def_id);
694                 if should_codegen_locally(self.tcx, &instance) {
695                     trace!("collecting thread-local static {:?}", def_id);
696                     self.output.push(respan(span, MonoItem::Static(def_id)));
697                 }
698             }
699             _ => { /* not interesting */ }
700         }
701
702         self.super_rvalue(rvalue, location);
703     }
704
705     /// This does not walk the constant, as it has been handled entirely here and trying
706     /// to walk it would attempt to evaluate the `ty::Const` inside, which doesn't necessarily
707     /// work, as some constants cannot be represented in the type system.
708     fn visit_constant(&mut self, constant: &mir::Constant<'tcx>, location: Location) {
709         let literal = self.monomorphize(constant.literal);
710         let val = match literal {
711             mir::ConstantKind::Val(val, _) => val,
712             mir::ConstantKind::Ty(ct) => match ct.val {
713                 ty::ConstKind::Value(val) => val,
714                 ty::ConstKind::Unevaluated(ct) => {
715                     let param_env = ty::ParamEnv::reveal_all();
716                     match self.tcx.const_eval_resolve(param_env, ct, None) {
717                         // The `monomorphize` call should have evaluated that constant already.
718                         Ok(val) => val,
719                         Err(ErrorHandled::Reported(ErrorReported) | ErrorHandled::Linted) => return,
720                         Err(ErrorHandled::TooGeneric) => span_bug!(
721                             self.body.source_info(location).span,
722                             "collection encountered polymorphic constant: {:?}",
723                             literal
724                         ),
725                     }
726                 }
727                 _ => return,
728             },
729         };
730         collect_const_value(self.tcx, val, self.output);
731         self.visit_ty(literal.ty(), TyContext::Location(location));
732     }
733
734     fn visit_const(&mut self, constant: &&'tcx ty::Const<'tcx>, location: Location) {
735         debug!("visiting const {:?} @ {:?}", *constant, location);
736
737         let substituted_constant = self.monomorphize(*constant);
738         let param_env = ty::ParamEnv::reveal_all();
739
740         match substituted_constant.val {
741             ty::ConstKind::Value(val) => collect_const_value(self.tcx, val, self.output),
742             ty::ConstKind::Unevaluated(unevaluated) => {
743                 match self.tcx.const_eval_resolve(param_env, unevaluated, None) {
744                     // The `monomorphize` call should have evaluated that constant already.
745                     Ok(val) => span_bug!(
746                         self.body.source_info(location).span,
747                         "collection encountered the unevaluated constant {} which evaluated to {:?}",
748                         substituted_constant,
749                         val
750                     ),
751                     Err(ErrorHandled::Reported(ErrorReported) | ErrorHandled::Linted) => {}
752                     Err(ErrorHandled::TooGeneric) => span_bug!(
753                         self.body.source_info(location).span,
754                         "collection encountered polymorphic constant: {}",
755                         substituted_constant
756                     ),
757                 }
758             }
759             _ => {}
760         }
761
762         self.super_const(constant);
763     }
764
765     fn visit_terminator(&mut self, terminator: &mir::Terminator<'tcx>, location: Location) {
766         debug!("visiting terminator {:?} @ {:?}", terminator, location);
767         let source = self.body.source_info(location).span;
768
769         let tcx = self.tcx;
770         match terminator.kind {
771             mir::TerminatorKind::Call { ref func, .. } => {
772                 let callee_ty = func.ty(self.body, tcx);
773                 let callee_ty = self.monomorphize(callee_ty);
774                 visit_fn_use(self.tcx, callee_ty, true, source, &mut self.output);
775             }
776             mir::TerminatorKind::Drop { ref place, .. }
777             | mir::TerminatorKind::DropAndReplace { ref place, .. } => {
778                 let ty = place.ty(self.body, self.tcx).ty;
779                 let ty = self.monomorphize(ty);
780                 visit_drop_use(self.tcx, ty, true, source, self.output);
781             }
782             mir::TerminatorKind::InlineAsm { ref operands, .. } => {
783                 for op in operands {
784                     match *op {
785                         mir::InlineAsmOperand::SymFn { ref value } => {
786                             let fn_ty = self.monomorphize(value.literal.ty());
787                             visit_fn_use(self.tcx, fn_ty, false, source, &mut self.output);
788                         }
789                         mir::InlineAsmOperand::SymStatic { def_id } => {
790                             let instance = Instance::mono(self.tcx, def_id);
791                             if should_codegen_locally(self.tcx, &instance) {
792                                 trace!("collecting asm sym static {:?}", def_id);
793                                 self.output.push(respan(source, MonoItem::Static(def_id)));
794                             }
795                         }
796                         _ => {}
797                     }
798                 }
799             }
800             mir::TerminatorKind::Goto { .. }
801             | mir::TerminatorKind::SwitchInt { .. }
802             | mir::TerminatorKind::Resume
803             | mir::TerminatorKind::Abort
804             | mir::TerminatorKind::Return
805             | mir::TerminatorKind::Unreachable
806             | mir::TerminatorKind::Assert { .. } => {}
807             mir::TerminatorKind::GeneratorDrop
808             | mir::TerminatorKind::Yield { .. }
809             | mir::TerminatorKind::FalseEdge { .. }
810             | mir::TerminatorKind::FalseUnwind { .. } => bug!(),
811         }
812
813         self.super_terminator(terminator, location);
814     }
815
816     fn visit_operand(&mut self, operand: &mir::Operand<'tcx>, location: Location) {
817         self.super_operand(operand, location);
818         let limit = self.tcx.sess.move_size_limit();
819         if limit == 0 {
820             return;
821         }
822         let limit = Size::from_bytes(limit);
823         let ty = operand.ty(self.body, self.tcx);
824         let ty = self.monomorphize(ty);
825         let layout = self.tcx.layout_of(ty::ParamEnv::reveal_all().and(ty));
826         if let Ok(layout) = layout {
827             if layout.size > limit {
828                 debug!(?layout);
829                 let source_info = self.body.source_info(location);
830                 debug!(?source_info);
831                 let lint_root = source_info.scope.lint_root(&self.body.source_scopes);
832                 debug!(?lint_root);
833                 let lint_root = match lint_root {
834                     Some(lint_root) => lint_root,
835                     // This happens when the issue is in a function from a foreign crate that
836                     // we monomorphized in the current crate. We can't get a `HirId` for things
837                     // in other crates.
838                     // FIXME: Find out where to report the lint on. Maybe simply crate-level lint root
839                     // but correct span? This would make the lint at least accept crate-level lint attributes.
840                     None => return,
841                 };
842                 self.tcx.struct_span_lint_hir(
843                     LARGE_ASSIGNMENTS,
844                     lint_root,
845                     source_info.span,
846                     |lint| {
847                         let mut err = lint.build(&format!("moving {} bytes", layout.size.bytes()));
848                         err.span_label(source_info.span, "value moved from here");
849                         err.emit()
850                     },
851                 );
852             }
853         }
854     }
855
856     fn visit_local(
857         &mut self,
858         _place_local: &Local,
859         _context: mir::visit::PlaceContext,
860         _location: Location,
861     ) {
862     }
863 }
864
865 fn visit_drop_use<'tcx>(
866     tcx: TyCtxt<'tcx>,
867     ty: Ty<'tcx>,
868     is_direct_call: bool,
869     source: Span,
870     output: &mut Vec<Spanned<MonoItem<'tcx>>>,
871 ) {
872     let instance = Instance::resolve_drop_in_place(tcx, ty);
873     visit_instance_use(tcx, instance, is_direct_call, source, output);
874 }
875
876 fn visit_fn_use<'tcx>(
877     tcx: TyCtxt<'tcx>,
878     ty: Ty<'tcx>,
879     is_direct_call: bool,
880     source: Span,
881     output: &mut Vec<Spanned<MonoItem<'tcx>>>,
882 ) {
883     if let ty::FnDef(def_id, substs) = *ty.kind() {
884         let instance = if is_direct_call {
885             ty::Instance::resolve(tcx, ty::ParamEnv::reveal_all(), def_id, substs).unwrap().unwrap()
886         } else {
887             ty::Instance::resolve_for_fn_ptr(tcx, ty::ParamEnv::reveal_all(), def_id, substs)
888                 .unwrap()
889         };
890         visit_instance_use(tcx, instance, is_direct_call, source, output);
891     }
892 }
893
894 fn visit_instance_use<'tcx>(
895     tcx: TyCtxt<'tcx>,
896     instance: ty::Instance<'tcx>,
897     is_direct_call: bool,
898     source: Span,
899     output: &mut Vec<Spanned<MonoItem<'tcx>>>,
900 ) {
901     debug!("visit_item_use({:?}, is_direct_call={:?})", instance, is_direct_call);
902     if !should_codegen_locally(tcx, &instance) {
903         return;
904     }
905
906     match instance.def {
907         ty::InstanceDef::Virtual(..) | ty::InstanceDef::Intrinsic(_) => {
908             if !is_direct_call {
909                 bug!("{:?} being reified", instance);
910             }
911         }
912         ty::InstanceDef::DropGlue(_, None) => {
913             // Don't need to emit noop drop glue if we are calling directly.
914             if !is_direct_call {
915                 output.push(create_fn_mono_item(tcx, instance, source));
916             }
917         }
918         ty::InstanceDef::DropGlue(_, Some(_))
919         | ty::InstanceDef::VtableShim(..)
920         | ty::InstanceDef::ReifyShim(..)
921         | ty::InstanceDef::ClosureOnceShim { .. }
922         | ty::InstanceDef::Item(..)
923         | ty::InstanceDef::FnPtrShim(..)
924         | ty::InstanceDef::CloneShim(..) => {
925             output.push(create_fn_mono_item(tcx, instance, source));
926         }
927     }
928 }
929
930 // Returns `true` if we should codegen an instance in the local crate.
931 // Returns `false` if we can just link to the upstream crate and therefore don't
932 // need a mono item.
933 fn should_codegen_locally<'tcx>(tcx: TyCtxt<'tcx>, instance: &Instance<'tcx>) -> bool {
934     let def_id = match instance.def {
935         ty::InstanceDef::Item(def) => def.did,
936         ty::InstanceDef::DropGlue(def_id, Some(_)) => def_id,
937         ty::InstanceDef::VtableShim(..)
938         | ty::InstanceDef::ReifyShim(..)
939         | ty::InstanceDef::ClosureOnceShim { .. }
940         | ty::InstanceDef::Virtual(..)
941         | ty::InstanceDef::FnPtrShim(..)
942         | ty::InstanceDef::DropGlue(..)
943         | ty::InstanceDef::Intrinsic(_)
944         | ty::InstanceDef::CloneShim(..) => return true,
945     };
946
947     if tcx.is_foreign_item(def_id) {
948         // Foreign items are always linked against, there's no way of instantiating them.
949         return false;
950     }
951
952     if def_id.is_local() {
953         // Local items cannot be referred to locally without monomorphizing them locally.
954         return true;
955     }
956
957     if tcx.is_reachable_non_generic(def_id)
958         || instance.polymorphize(tcx).upstream_monomorphization(tcx).is_some()
959     {
960         // We can link to the item in question, no instance needed in this crate.
961         return false;
962     }
963
964     if !tcx.is_mir_available(def_id) {
965         bug!("no MIR available for {:?}", def_id);
966     }
967
968     true
969 }
970
971 /// For a given pair of source and target type that occur in an unsizing coercion,
972 /// this function finds the pair of types that determines the vtable linking
973 /// them.
974 ///
975 /// For example, the source type might be `&SomeStruct` and the target type\
976 /// might be `&SomeTrait` in a cast like:
977 ///
978 /// let src: &SomeStruct = ...;
979 /// let target = src as &SomeTrait;
980 ///
981 /// Then the output of this function would be (SomeStruct, SomeTrait) since for
982 /// constructing the `target` fat-pointer we need the vtable for that pair.
983 ///
984 /// Things can get more complicated though because there's also the case where
985 /// the unsized type occurs as a field:
986 ///
987 /// ```rust
988 /// struct ComplexStruct<T: ?Sized> {
989 ///    a: u32,
990 ///    b: f64,
991 ///    c: T
992 /// }
993 /// ```
994 ///
995 /// In this case, if `T` is sized, `&ComplexStruct<T>` is a thin pointer. If `T`
996 /// is unsized, `&SomeStruct` is a fat pointer, and the vtable it points to is
997 /// for the pair of `T` (which is a trait) and the concrete type that `T` was
998 /// originally coerced from:
999 ///
1000 /// let src: &ComplexStruct<SomeStruct> = ...;
1001 /// let target = src as &ComplexStruct<SomeTrait>;
1002 ///
1003 /// Again, we want this `find_vtable_types_for_unsizing()` to provide the pair
1004 /// `(SomeStruct, SomeTrait)`.
1005 ///
1006 /// Finally, there is also the case of custom unsizing coercions, e.g., for
1007 /// smart pointers such as `Rc` and `Arc`.
1008 fn find_vtable_types_for_unsizing<'tcx>(
1009     tcx: TyCtxt<'tcx>,
1010     source_ty: Ty<'tcx>,
1011     target_ty: Ty<'tcx>,
1012 ) -> (Ty<'tcx>, Ty<'tcx>) {
1013     let ptr_vtable = |inner_source: Ty<'tcx>, inner_target: Ty<'tcx>| {
1014         let param_env = ty::ParamEnv::reveal_all();
1015         let type_has_metadata = |ty: Ty<'tcx>| -> bool {
1016             if ty.is_sized(tcx.at(DUMMY_SP), param_env) {
1017                 return false;
1018             }
1019             let tail = tcx.struct_tail_erasing_lifetimes(ty, param_env);
1020             match tail.kind() {
1021                 ty::Foreign(..) => false,
1022                 ty::Str | ty::Slice(..) | ty::Dynamic(..) => true,
1023                 _ => bug!("unexpected unsized tail: {:?}", tail),
1024             }
1025         };
1026         if type_has_metadata(inner_source) {
1027             (inner_source, inner_target)
1028         } else {
1029             tcx.struct_lockstep_tails_erasing_lifetimes(inner_source, inner_target, param_env)
1030         }
1031     };
1032
1033     match (&source_ty.kind(), &target_ty.kind()) {
1034         (&ty::Ref(_, a, _), &ty::Ref(_, b, _) | &ty::RawPtr(ty::TypeAndMut { ty: b, .. }))
1035         | (&ty::RawPtr(ty::TypeAndMut { ty: a, .. }), &ty::RawPtr(ty::TypeAndMut { ty: b, .. })) => {
1036             ptr_vtable(a, b)
1037         }
1038         (&ty::Adt(def_a, _), &ty::Adt(def_b, _)) if def_a.is_box() && def_b.is_box() => {
1039             ptr_vtable(source_ty.boxed_ty(), target_ty.boxed_ty())
1040         }
1041
1042         (&ty::Adt(source_adt_def, source_substs), &ty::Adt(target_adt_def, target_substs)) => {
1043             assert_eq!(source_adt_def, target_adt_def);
1044
1045             let CustomCoerceUnsized::Struct(coerce_index) =
1046                 monomorphize::custom_coerce_unsize_info(tcx, source_ty, target_ty);
1047
1048             let source_fields = &source_adt_def.non_enum_variant().fields;
1049             let target_fields = &target_adt_def.non_enum_variant().fields;
1050
1051             assert!(
1052                 coerce_index < source_fields.len() && source_fields.len() == target_fields.len()
1053             );
1054
1055             find_vtable_types_for_unsizing(
1056                 tcx,
1057                 source_fields[coerce_index].ty(tcx, source_substs),
1058                 target_fields[coerce_index].ty(tcx, target_substs),
1059             )
1060         }
1061         _ => bug!(
1062             "find_vtable_types_for_unsizing: invalid coercion {:?} -> {:?}",
1063             source_ty,
1064             target_ty
1065         ),
1066     }
1067 }
1068
1069 fn create_fn_mono_item<'tcx>(
1070     tcx: TyCtxt<'tcx>,
1071     instance: Instance<'tcx>,
1072     source: Span,
1073 ) -> Spanned<MonoItem<'tcx>> {
1074     debug!("create_fn_mono_item(instance={})", instance);
1075     respan(source, MonoItem::Fn(instance.polymorphize(tcx)))
1076 }
1077
1078 /// Creates a `MonoItem` for each method that is referenced by the vtable for
1079 /// the given trait/impl pair.
1080 fn create_mono_items_for_vtable_methods<'tcx>(
1081     tcx: TyCtxt<'tcx>,
1082     trait_ty: Ty<'tcx>,
1083     impl_ty: Ty<'tcx>,
1084     source: Span,
1085     output: &mut Vec<Spanned<MonoItem<'tcx>>>,
1086 ) {
1087     assert!(!trait_ty.has_escaping_bound_vars() && !impl_ty.has_escaping_bound_vars());
1088
1089     if let ty::Dynamic(ref trait_ty, ..) = trait_ty.kind() {
1090         if let Some(principal) = trait_ty.principal() {
1091             let poly_trait_ref = principal.with_self_ty(tcx, impl_ty);
1092             assert!(!poly_trait_ref.has_escaping_bound_vars());
1093
1094             // Walk all methods of the trait, including those of its supertraits
1095             let methods = tcx.vtable_methods(poly_trait_ref);
1096             let methods = methods
1097                 .iter()
1098                 .cloned()
1099                 .filter_map(|method| method)
1100                 .map(|(def_id, substs)| {
1101                     ty::Instance::resolve_for_vtable(
1102                         tcx,
1103                         ty::ParamEnv::reveal_all(),
1104                         def_id,
1105                         substs,
1106                     )
1107                     .unwrap()
1108                 })
1109                 .filter(|&instance| should_codegen_locally(tcx, &instance))
1110                 .map(|item| create_fn_mono_item(tcx, item, source));
1111             output.extend(methods);
1112         }
1113
1114         // Also add the destructor.
1115         visit_drop_use(tcx, impl_ty, false, source, output);
1116     }
1117 }
1118
1119 //=-----------------------------------------------------------------------------
1120 // Root Collection
1121 //=-----------------------------------------------------------------------------
1122
1123 struct RootCollector<'a, 'tcx> {
1124     tcx: TyCtxt<'tcx>,
1125     mode: MonoItemCollectionMode,
1126     output: &'a mut Vec<Spanned<MonoItem<'tcx>>>,
1127     entry_fn: Option<(DefId, EntryFnType)>,
1128 }
1129
1130 impl ItemLikeVisitor<'v> for RootCollector<'_, 'v> {
1131     fn visit_item(&mut self, item: &'v hir::Item<'v>) {
1132         match item.kind {
1133             hir::ItemKind::ExternCrate(..)
1134             | hir::ItemKind::Use(..)
1135             | hir::ItemKind::ForeignMod { .. }
1136             | hir::ItemKind::TyAlias(..)
1137             | hir::ItemKind::Trait(..)
1138             | hir::ItemKind::TraitAlias(..)
1139             | hir::ItemKind::OpaqueTy(..)
1140             | hir::ItemKind::Mod(..) => {
1141                 // Nothing to do, just keep recursing.
1142             }
1143
1144             hir::ItemKind::Impl { .. } => {
1145                 if self.mode == MonoItemCollectionMode::Eager {
1146                     create_mono_items_for_default_impls(self.tcx, item, self.output);
1147                 }
1148             }
1149
1150             hir::ItemKind::Enum(_, ref generics)
1151             | hir::ItemKind::Struct(_, ref generics)
1152             | hir::ItemKind::Union(_, ref generics) => {
1153                 if generics.params.is_empty() {
1154                     if self.mode == MonoItemCollectionMode::Eager {
1155                         debug!(
1156                             "RootCollector: ADT drop-glue for {}",
1157                             self.tcx.def_path_str(item.def_id.to_def_id())
1158                         );
1159
1160                         let ty = Instance::new(item.def_id.to_def_id(), InternalSubsts::empty())
1161                             .ty(self.tcx, ty::ParamEnv::reveal_all());
1162                         visit_drop_use(self.tcx, ty, true, DUMMY_SP, self.output);
1163                     }
1164                 }
1165             }
1166             hir::ItemKind::GlobalAsm(..) => {
1167                 debug!(
1168                     "RootCollector: ItemKind::GlobalAsm({})",
1169                     self.tcx.def_path_str(item.def_id.to_def_id())
1170                 );
1171                 self.output.push(dummy_spanned(MonoItem::GlobalAsm(item.item_id())));
1172             }
1173             hir::ItemKind::Static(..) => {
1174                 debug!(
1175                     "RootCollector: ItemKind::Static({})",
1176                     self.tcx.def_path_str(item.def_id.to_def_id())
1177                 );
1178                 self.output.push(dummy_spanned(MonoItem::Static(item.def_id.to_def_id())));
1179             }
1180             hir::ItemKind::Const(..) => {
1181                 // const items only generate mono items if they are
1182                 // actually used somewhere. Just declaring them is insufficient.
1183
1184                 // but even just declaring them must collect the items they refer to
1185                 if let Ok(val) = self.tcx.const_eval_poly(item.def_id.to_def_id()) {
1186                     collect_const_value(self.tcx, val, &mut self.output);
1187                 }
1188             }
1189             hir::ItemKind::Fn(..) => {
1190                 self.push_if_root(item.def_id);
1191             }
1192         }
1193     }
1194
1195     fn visit_trait_item(&mut self, _: &'v hir::TraitItem<'v>) {
1196         // Even if there's a default body with no explicit generics,
1197         // it's still generic over some `Self: Trait`, so not a root.
1198     }
1199
1200     fn visit_impl_item(&mut self, ii: &'v hir::ImplItem<'v>) {
1201         if let hir::ImplItemKind::Fn(hir::FnSig { .. }, _) = ii.kind {
1202             self.push_if_root(ii.def_id);
1203         }
1204     }
1205
1206     fn visit_foreign_item(&mut self, _foreign_item: &'v hir::ForeignItem<'v>) {}
1207 }
1208
1209 impl RootCollector<'_, 'v> {
1210     fn is_root(&self, def_id: LocalDefId) -> bool {
1211         !item_requires_monomorphization(self.tcx, def_id)
1212             && match self.mode {
1213                 MonoItemCollectionMode::Eager => true,
1214                 MonoItemCollectionMode::Lazy => {
1215                     self.entry_fn.and_then(|(id, _)| id.as_local()) == Some(def_id)
1216                         || self.tcx.is_reachable_non_generic(def_id)
1217                         || self
1218                             .tcx
1219                             .codegen_fn_attrs(def_id)
1220                             .flags
1221                             .contains(CodegenFnAttrFlags::RUSTC_STD_INTERNAL_SYMBOL)
1222                 }
1223             }
1224     }
1225
1226     /// If `def_id` represents a root, pushes it onto the list of
1227     /// outputs. (Note that all roots must be monomorphic.)
1228     fn push_if_root(&mut self, def_id: LocalDefId) {
1229         if self.is_root(def_id) {
1230             debug!("RootCollector::push_if_root: found root def_id={:?}", def_id);
1231
1232             let instance = Instance::mono(self.tcx, def_id.to_def_id());
1233             self.output.push(create_fn_mono_item(self.tcx, instance, DUMMY_SP));
1234         }
1235     }
1236
1237     /// As a special case, when/if we encounter the
1238     /// `main()` function, we also have to generate a
1239     /// monomorphized copy of the start lang item based on
1240     /// the return type of `main`. This is not needed when
1241     /// the user writes their own `start` manually.
1242     fn push_extra_entry_roots(&mut self) {
1243         let main_def_id = match self.entry_fn {
1244             Some((def_id, EntryFnType::Main)) => def_id,
1245             _ => return,
1246         };
1247
1248         let start_def_id = match self.tcx.lang_items().require(LangItem::Start) {
1249             Ok(s) => s,
1250             Err(err) => self.tcx.sess.fatal(&err),
1251         };
1252         let main_ret_ty = self.tcx.fn_sig(main_def_id).output();
1253
1254         // Given that `main()` has no arguments,
1255         // then its return type cannot have
1256         // late-bound regions, since late-bound
1257         // regions must appear in the argument
1258         // listing.
1259         let main_ret_ty = self.tcx.erase_regions(main_ret_ty.no_bound_vars().unwrap());
1260
1261         let start_instance = Instance::resolve(
1262             self.tcx,
1263             ty::ParamEnv::reveal_all(),
1264             start_def_id,
1265             self.tcx.intern_substs(&[main_ret_ty.into()]),
1266         )
1267         .unwrap()
1268         .unwrap();
1269
1270         self.output.push(create_fn_mono_item(self.tcx, start_instance, DUMMY_SP));
1271     }
1272 }
1273
1274 fn item_requires_monomorphization(tcx: TyCtxt<'_>, def_id: LocalDefId) -> bool {
1275     let generics = tcx.generics_of(def_id);
1276     generics.requires_monomorphization(tcx)
1277 }
1278
1279 fn create_mono_items_for_default_impls<'tcx>(
1280     tcx: TyCtxt<'tcx>,
1281     item: &'tcx hir::Item<'tcx>,
1282     output: &mut Vec<Spanned<MonoItem<'tcx>>>,
1283 ) {
1284     match item.kind {
1285         hir::ItemKind::Impl(ref impl_) => {
1286             for param in impl_.generics.params {
1287                 match param.kind {
1288                     hir::GenericParamKind::Lifetime { .. } => {}
1289                     hir::GenericParamKind::Type { .. } | hir::GenericParamKind::Const { .. } => {
1290                         return;
1291                     }
1292                 }
1293             }
1294
1295             debug!(
1296                 "create_mono_items_for_default_impls(item={})",
1297                 tcx.def_path_str(item.def_id.to_def_id())
1298             );
1299
1300             if let Some(trait_ref) = tcx.impl_trait_ref(item.def_id) {
1301                 let param_env = ty::ParamEnv::reveal_all();
1302                 let trait_ref = tcx.normalize_erasing_regions(param_env, trait_ref);
1303                 let overridden_methods: FxHashSet<_> =
1304                     impl_.items.iter().map(|iiref| iiref.ident.normalize_to_macros_2_0()).collect();
1305                 for method in tcx.provided_trait_methods(trait_ref.def_id) {
1306                     if overridden_methods.contains(&method.ident.normalize_to_macros_2_0()) {
1307                         continue;
1308                     }
1309
1310                     if tcx.generics_of(method.def_id).own_requires_monomorphization() {
1311                         continue;
1312                     }
1313
1314                     let substs =
1315                         InternalSubsts::for_item(tcx, method.def_id, |param, _| match param.kind {
1316                             GenericParamDefKind::Lifetime => tcx.lifetimes.re_erased.into(),
1317                             GenericParamDefKind::Type { .. }
1318                             | GenericParamDefKind::Const { .. } => {
1319                                 trait_ref.substs[param.index as usize]
1320                             }
1321                         });
1322                     let instance = ty::Instance::resolve(tcx, param_env, method.def_id, substs)
1323                         .unwrap()
1324                         .unwrap();
1325
1326                     let mono_item = create_fn_mono_item(tcx, instance, DUMMY_SP);
1327                     if mono_item.node.is_instantiable(tcx) && should_codegen_locally(tcx, &instance)
1328                     {
1329                         output.push(mono_item);
1330                     }
1331                 }
1332             }
1333         }
1334         _ => bug!(),
1335     }
1336 }
1337
1338 /// Scans the miri alloc in order to find function calls, closures, and drop-glue.
1339 fn collect_miri<'tcx>(
1340     tcx: TyCtxt<'tcx>,
1341     alloc_id: AllocId,
1342     output: &mut Vec<Spanned<MonoItem<'tcx>>>,
1343 ) {
1344     match tcx.global_alloc(alloc_id) {
1345         GlobalAlloc::Static(def_id) => {
1346             assert!(!tcx.is_thread_local_static(def_id));
1347             let instance = Instance::mono(tcx, def_id);
1348             if should_codegen_locally(tcx, &instance) {
1349                 trace!("collecting static {:?}", def_id);
1350                 output.push(dummy_spanned(MonoItem::Static(def_id)));
1351             }
1352         }
1353         GlobalAlloc::Memory(alloc) => {
1354             trace!("collecting {:?} with {:#?}", alloc_id, alloc);
1355             for &((), inner) in alloc.relocations().values() {
1356                 rustc_data_structures::stack::ensure_sufficient_stack(|| {
1357                     collect_miri(tcx, inner, output);
1358                 });
1359             }
1360         }
1361         GlobalAlloc::Function(fn_instance) => {
1362             if should_codegen_locally(tcx, &fn_instance) {
1363                 trace!("collecting {:?} with {:#?}", alloc_id, fn_instance);
1364                 output.push(create_fn_mono_item(tcx, fn_instance, DUMMY_SP));
1365             }
1366         }
1367     }
1368 }
1369
1370 /// Scans the MIR in order to find function calls, closures, and drop-glue.
1371 fn collect_neighbours<'tcx>(
1372     tcx: TyCtxt<'tcx>,
1373     instance: Instance<'tcx>,
1374     output: &mut Vec<Spanned<MonoItem<'tcx>>>,
1375 ) {
1376     debug!("collect_neighbours: {:?}", instance.def_id());
1377     let body = tcx.instance_mir(instance.def);
1378
1379     MirNeighborCollector { tcx, body: &body, output, instance }.visit_body(&body);
1380 }
1381
1382 fn collect_const_value<'tcx>(
1383     tcx: TyCtxt<'tcx>,
1384     value: ConstValue<'tcx>,
1385     output: &mut Vec<Spanned<MonoItem<'tcx>>>,
1386 ) {
1387     match value {
1388         ConstValue::Scalar(Scalar::Ptr(ptr)) => collect_miri(tcx, ptr.alloc_id, output),
1389         ConstValue::Slice { data: alloc, start: _, end: _ } | ConstValue::ByRef { alloc, .. } => {
1390             for &((), id) in alloc.relocations().values() {
1391                 collect_miri(tcx, id, output);
1392             }
1393         }
1394         _ => {}
1395     }
1396 }