src/librustc_passes/entry.rs

   1 use rustc_ast::entry::EntryPointType;
   2 use rustc_errors::struct_span_err;
   3 use rustc_hir::def_id::{CrateNum, LocalDefId, CRATE_DEF_INDEX, LOCAL_CRATE};
   4 use rustc_hir::itemlikevisit::ItemLikeVisitor;
   5 use rustc_hir::{HirId, ImplItem, Item, ItemKind, TraitItem};
   6 use rustc_middle::hir::map::Map;
   7 use rustc_middle::ty::query::Providers;
   8 use rustc_middle::ty::TyCtxt;
   9 use rustc_session::config::{CrateType, EntryFnType};
  10 use rustc_session::Session;
  11 use rustc_span::symbol::sym;
  12 use rustc_span::{Span, DUMMY_SP};
  13
  14 struct EntryContext<'a, 'tcx> {
  15     session: &'a Session,
  16
  17     map: Map<'tcx>,
  18
  19     /// The top-level function called `main`.
  20     main_fn: Option<(HirId, Span)>,
  21
  22     /// The function that has attribute named `main`.
  23     attr_main_fn: Option<(HirId, Span)>,
  24
  25     /// The function that has the attribute 'start' on it.
  26     start_fn: Option<(HirId, Span)>,
  27
  28     /// The functions that one might think are `main` but aren't, e.g.
  29     /// main functions not defined at the top level. For diagnostics.
  30     non_main_fns: Vec<(HirId, Span)>,
  31 }
  32
  33 impl<'a, 'tcx> ItemLikeVisitor<'tcx> for EntryContext<'a, 'tcx> {
  34     fn visit_item(&mut self, item: &'tcx Item<'tcx>) {
  35         let def_id = self.map.local_def_id(item.hir_id);
  36         let def_key = self.map.def_key(def_id);
  37         let at_root = def_key.parent == Some(CRATE_DEF_INDEX);
  38         find_item(item, self, at_root);
  39     }
  40
  41     fn visit_trait_item(&mut self, _trait_item: &'tcx TraitItem<'tcx>) {
  42         // Entry fn is never a trait item.
  43     }
  44
  45     fn visit_impl_item(&mut self, _impl_item: &'tcx ImplItem<'tcx>) {
  46         // Entry fn is never a trait item.
  47     }
  48 }
  49
  50 fn entry_fn(tcx: TyCtxt<'_>, cnum: CrateNum) -> Option<(LocalDefId, EntryFnType)> {
  51     assert_eq!(cnum, LOCAL_CRATE);
  52
  53     let any_exe = tcx.sess.crate_types().iter().any(|ty| *ty == CrateType::Executable);
  54     if !any_exe {
  55         // No need to find a main function.
  56         return None;
  57     }
  58
  59     // If the user wants no main function at all, then stop here.
  60     if tcx.sess.contains_name(&tcx.hir().krate().item.attrs, sym::no_main) {
  61         return None;
  62     }
  63
  64     let mut ctxt = EntryContext {
  65         session: tcx.sess,
  66         map: tcx.hir(),
  67         main_fn: None,
  68         attr_main_fn: None,
  69         start_fn: None,
  70         non_main_fns: Vec::new(),
  71     };
  72
  73     tcx.hir().krate().visit_all_item_likes(&mut ctxt);
  74
  75     configure_main(tcx, &ctxt)
  76 }
  77
  78 // Beware, this is duplicated in `librustc_builtin_macros/test_harness.rs`
  79 // (with `ast::Item`), so make sure to keep them in sync.
  80 fn entry_point_type(sess: &Session, item: &Item<'_>, at_root: bool) -> EntryPointType {
  81     match item.kind {
  82         ItemKind::Fn(..) => {
  83             if sess.contains_name(&item.attrs, sym::start) {
  84                 EntryPointType::Start
  85             } else if sess.contains_name(&item.attrs, sym::main) {
  86                 EntryPointType::MainAttr
  87             } else if item.ident.name == sym::main {
  88                 if at_root {
  89                     // This is a top-level function so can be `main`.
  90                     EntryPointType::MainNamed
  91                 } else {
  92                     EntryPointType::OtherMain
  93                 }
  94             } else {
  95                 EntryPointType::None
  96             }
  97         }
  98         _ => EntryPointType::None,
  99     }
 100 }
 101
 102 fn find_item(item: &Item<'_>, ctxt: &mut EntryContext<'_, '_>, at_root: bool) {
 103     match entry_point_type(&ctxt.session, item, at_root) {
 104         EntryPointType::MainNamed => {
 105             if ctxt.main_fn.is_none() {
 106                 ctxt.main_fn = Some((item.hir_id, item.span));
 107             } else {
 108                 struct_span_err!(ctxt.session, item.span, E0136, "multiple `main` functions")
 109                     .emit();
 110             }
 111         }
 112         EntryPointType::OtherMain => {
 113             ctxt.non_main_fns.push((item.hir_id, item.span));
 114         }
 115         EntryPointType::MainAttr => {
 116             if ctxt.attr_main_fn.is_none() {
 117                 ctxt.attr_main_fn = Some((item.hir_id, item.span));
 118             } else {
 119                 struct_span_err!(
 120                     ctxt.session,
 121                     item.span,
 122                     E0137,
 123                     "multiple functions with a `#[main]` attribute"
 124                 )
 125                 .span_label(item.span, "additional `#[main]` function")
 126                 .span_label(ctxt.attr_main_fn.unwrap().1, "first `#[main]` function")
 127                 .emit();
 128             }
 129         }
 130         EntryPointType::Start => {
 131             if ctxt.start_fn.is_none() {
 132                 ctxt.start_fn = Some((item.hir_id, item.span));
 133             } else {
 134                 struct_span_err!(ctxt.session, item.span, E0138, "multiple `start` functions")
 135                     .span_label(ctxt.start_fn.unwrap().1, "previous `#[start]` function here")
 136                     .span_label(item.span, "multiple `start` functions")
 137                     .emit();
 138             }
 139         }
 140         EntryPointType::None => (),
 141     }
 142 }
 143
 144 fn configure_main(
 145     tcx: TyCtxt<'_>,
 146     visitor: &EntryContext<'_, '_>,
 147 ) -> Option<(LocalDefId, EntryFnType)> {
 148     if let Some((hir_id, _)) = visitor.start_fn {
 149         Some((tcx.hir().local_def_id(hir_id), EntryFnType::Start))
 150     } else if let Some((hir_id, _)) = visitor.attr_main_fn {
 151         Some((tcx.hir().local_def_id(hir_id), EntryFnType::Main))
 152     } else if let Some((hir_id, _)) = visitor.main_fn {
 153         Some((tcx.hir().local_def_id(hir_id), EntryFnType::Main))
 154     } else {
 155         no_main_err(tcx, visitor);
 156         None
 157     }
 158 }
 159
 160 fn no_main_err(tcx: TyCtxt<'_>, visitor: &EntryContext<'_, '_>) {
 161     let sp = tcx.hir().krate().item.span;
 162     if *tcx.sess.parse_sess.reached_eof.borrow() {
 163         // There's an unclosed brace that made the parser reach `Eof`, we shouldn't complain about
 164         // the missing `fn main()` then as it might have been hidden inside an unclosed block.
 165         tcx.sess.delay_span_bug(sp, "`main` not found, but expected unclosed brace error");
 166         return;
 167     }
 168
 169     // There is no main function.
 170     let mut err = struct_span_err!(
 171         tcx.sess,
 172         DUMMY_SP,
 173         E0601,
 174         "`main` function not found in crate `{}`",
 175         tcx.crate_name(LOCAL_CRATE)
 176     );
 177     let filename = &tcx.sess.local_crate_source_file;
 178     let note = if !visitor.non_main_fns.is_empty() {
 179         for &(_, span) in &visitor.non_main_fns {
 180             err.span_note(span, "here is a function named `main`");
 181         }
 182         err.note("you have one or more functions named `main` not defined at the crate level");
 183         err.help(
 184             "either move the `main` function definitions or attach the `#[main]` attribute \
 185                   to one of them",
 186         );
 187         // There were some functions named `main` though. Try to give the user a hint.
 188         format!(
 189             "the main function must be defined at the crate level{}",
 190             filename.as_ref().map(|f| format!(" (in `{}`)", f.display())).unwrap_or_default()
 191         )
 192     } else if let Some(filename) = filename {
 193         format!("consider adding a `main` function to `{}`", filename.display())
 194     } else {
 195         String::from("consider adding a `main` function at the crate level")
 196     };
 197     // The file may be empty, which leads to the diagnostic machinery not emitting this
 198     // note. This is a relatively simple way to detect that case and emit a span-less
 199     // note instead.
 200     if tcx.sess.source_map().lookup_line(sp.lo()).is_ok() {
 201         err.set_span(sp);
 202         err.span_label(sp, &note);
 203     } else {
 204         err.note(&note);
 205     }
 206     if tcx.sess.teach(&err.get_code().unwrap()) {
 207         err.note(
 208             "If you don't know the basics of Rust, you can go look to the Rust Book \
 209                   to get started: https://doc.rust-lang.org/book/",
 210         );
 211     }
 212     err.emit();
 213 }
 214
 215 pub fn find_entry_point(tcx: TyCtxt<'_>) -> Option<(LocalDefId, EntryFnType)> {
 216     tcx.entry_fn(LOCAL_CRATE)
 217 }
 218
 219 pub fn provide(providers: &mut Providers) {
 220     *providers = Providers { entry_fn, ..*providers };
 221 }