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