compiler/rustc_save_analysis/src/lib.rs

   1 #![doc(html_root_url = "https://doc.rust-lang.org/nightly/nightly-rustc/")]
   2 #![feature(if_let_guard)]
   3 #![recursion_limit = "256"]
   4 #![allow(rustc::potential_query_instability)]
   5 #![feature(never_type)]
   6 #![deny(rustc::untranslatable_diagnostic)]
   7 #![deny(rustc::diagnostic_outside_of_impl)]
   8
   9 #[macro_use]
  10 extern crate tracing;
  11
  12 mod dump_visitor;
  13 mod dumper;
  14 #[macro_use]
  15 mod span_utils;
  16 mod errors;
  17 mod sig;
  18
  19 use rustc_ast as ast;
  20 use rustc_ast::util::comments::beautify_doc_string;
  21 use rustc_ast_pretty::pprust::attribute_to_string;
  22 use rustc_hir as hir;
  23 use rustc_hir::def::{DefKind as HirDefKind, Res};
  24 use rustc_hir::def_id::{DefId, LOCAL_CRATE};
  25 use rustc_hir::intravisit::{self, Visitor};
  26 use rustc_hir::Node;
  27 use rustc_hir_pretty::{enum_def_to_string, fn_to_string, ty_to_string};
  28 use rustc_middle::hir::nested_filter;
  29 use rustc_middle::middle::privacy::EffectiveVisibilities;
  30 use rustc_middle::ty::{self, print::with_no_trimmed_paths, DefIdTree, TyCtxt};
  31 use rustc_middle::{bug, span_bug};
  32 use rustc_session::config::{CrateType, Input, OutputType};
  33 use rustc_session::cstore::ExternCrate;
  34 use rustc_session::output::{filename_for_metadata, out_filename};
  35 use rustc_span::symbol::Ident;
  36 use rustc_span::*;
  37
  38 use std::cell::Cell;
  39 use std::default::Default;
  40 use std::env;
  41 use std::fs::File;
  42 use std::io::BufWriter;
  43 use std::path::{Path, PathBuf};
  44
  45 use dump_visitor::DumpVisitor;
  46 use span_utils::SpanUtils;
  47
  48 use rls_data::config::Config;
  49 use rls_data::{
  50     Analysis, Def, DefKind, ExternalCrateData, GlobalCrateId, Impl, ImplKind, MacroRef, Ref,
  51     RefKind, Relation, RelationKind, SpanData,
  52 };
  53
  54 pub struct SaveContext<'tcx> {
  55     tcx: TyCtxt<'tcx>,
  56     maybe_typeck_results: Option<&'tcx ty::TypeckResults<'tcx>>,
  57     effective_visibilities: &'tcx EffectiveVisibilities,
  58     span_utils: SpanUtils<'tcx>,
  59     config: Config,
  60     impl_counter: Cell<u32>,
  61 }
  62
  63 #[derive(Debug)]
  64 pub enum Data {
  65     RefData(Ref),
  66     DefData(Def),
  67     RelationData(Relation, Impl),
  68 }
  69
  70 impl<'tcx> SaveContext<'tcx> {
  71     /// Gets the type-checking results for the current body.
  72     /// As this will ICE if called outside bodies, only call when working with
  73     /// `Expr` or `Pat` nodes (they are guaranteed to be found only in bodies).
  74     #[track_caller]
  75     fn typeck_results(&self) -> &'tcx ty::TypeckResults<'tcx> {
  76         self.maybe_typeck_results.expect("`SaveContext::typeck_results` called outside of body")
  77     }
  78
  79     fn span_from_span(&self, span: Span) -> SpanData {
  80         use rls_span::{Column, Row};
  81
  82         let sm = self.tcx.sess.source_map();
  83         let start = sm.lookup_char_pos(span.lo());
  84         let end = sm.lookup_char_pos(span.hi());
  85
  86         SpanData {
  87             file_name: start.file.name.prefer_remapped().to_string().into(),
  88             byte_start: span.lo().0,
  89             byte_end: span.hi().0,
  90             line_start: Row::new_one_indexed(start.line as u32),
  91             line_end: Row::new_one_indexed(end.line as u32),
  92             column_start: Column::new_one_indexed(start.col.0 as u32 + 1),
  93             column_end: Column::new_one_indexed(end.col.0 as u32 + 1),
  94         }
  95     }
  96
  97     // Returns path to the compilation output (e.g., libfoo-12345678.rmeta)
  98     pub fn compilation_output(&self, crate_name: &str) -> PathBuf {
  99         let sess = &self.tcx.sess;
 100         // Save-analysis is emitted per whole session, not per each crate type
 101         let crate_type = sess.crate_types()[0];
 102         let outputs = &*self.tcx.output_filenames(());
 103
 104         if outputs.outputs.contains_key(&OutputType::Metadata) {
 105             filename_for_metadata(sess, crate_name, outputs)
 106         } else if outputs.outputs.should_codegen() {
 107             out_filename(sess, crate_type, outputs, crate_name)
 108         } else {
 109             // Otherwise it's only a DepInfo, in which case we return early and
 110             // not even reach the analysis stage.
 111             unreachable!()
 112         }
 113     }
 114
 115     // List external crates used by the current crate.
 116     pub fn get_external_crates(&self) -> Vec<ExternalCrateData> {
 117         let mut result = Vec::with_capacity(self.tcx.crates(()).len());
 118
 119         for &n in self.tcx.crates(()).iter() {
 120             let Some(&ExternCrate { span, .. }) = self.tcx.extern_crate(n.as_def_id()) else {
 121                 debug!("skipping crate {}, no data", n);
 122                 continue;
 123             };
 124             let lo_loc = self.span_utils.sess.source_map().lookup_char_pos(span.lo());
 125             result.push(ExternalCrateData {
 126                 // FIXME: change file_name field to PathBuf in rls-data
 127                 // https://github.com/nrc/rls-data/issues/7
 128                 file_name: self.span_utils.make_filename_string(&lo_loc.file),
 129                 num: n.as_u32(),
 130                 id: GlobalCrateId {
 131                     name: self.tcx.crate_name(n).to_string(),
 132                     disambiguator: (
 133                         self.tcx.def_path_hash(n.as_def_id()).stable_crate_id().to_u64(),
 134                         0,
 135                     ),
 136                 },
 137             });
 138         }
 139
 140         result
 141     }
 142
 143     pub fn get_extern_item_data(&self, item: &hir::ForeignItem<'_>) -> Option<Data> {
 144         let def_id = item.owner_id.to_def_id();
 145         let qualname = format!("::{}", self.tcx.def_path_str(def_id));
 146         let attrs = self.tcx.hir().attrs(item.hir_id());
 147         match item.kind {
 148             hir::ForeignItemKind::Fn(ref decl, arg_names, ref generics) => {
 149                 filter!(self.span_utils, item.ident.span);
 150
 151                 Some(Data::DefData(Def {
 152                     kind: DefKind::ForeignFunction,
 153                     id: id_from_def_id(def_id),
 154                     span: self.span_from_span(item.ident.span),
 155                     name: item.ident.to_string(),
 156                     qualname,
 157                     value: fn_to_string(
 158                         decl,
 159                         hir::FnHeader {
 160                             // functions in extern block are implicitly unsafe
 161                             unsafety: hir::Unsafety::Unsafe,
 162                             // functions in extern block cannot be const
 163                             constness: hir::Constness::NotConst,
 164                             abi: self.tcx.hir().get_foreign_abi(item.hir_id()),
 165                             // functions in extern block cannot be async
 166                             asyncness: hir::IsAsync::NotAsync,
 167                         },
 168                         Some(item.ident.name),
 169                         generics,
 170                         arg_names,
 171                         None,
 172                     ),
 173                     parent: None,
 174                     children: vec![],
 175                     decl_id: None,
 176                     docs: self.docs_for_attrs(attrs),
 177                     sig: sig::foreign_item_signature(item, self),
 178                     attributes: lower_attributes(attrs.to_vec(), self),
 179                 }))
 180             }
 181             hir::ForeignItemKind::Static(ref ty, _) => {
 182                 filter!(self.span_utils, item.ident.span);
 183
 184                 let id = id_from_def_id(def_id);
 185                 let span = self.span_from_span(item.ident.span);
 186
 187                 Some(Data::DefData(Def {
 188                     kind: DefKind::ForeignStatic,
 189                     id,
 190                     span,
 191                     name: item.ident.to_string(),
 192                     qualname,
 193                     value: ty_to_string(ty),
 194                     parent: None,
 195                     children: vec![],
 196                     decl_id: None,
 197                     docs: self.docs_for_attrs(attrs),
 198                     sig: sig::foreign_item_signature(item, self),
 199                     attributes: lower_attributes(attrs.to_vec(), self),
 200                 }))
 201             }
 202             // FIXME(plietar): needs a new DefKind in rls-data
 203             hir::ForeignItemKind::Type => None,
 204         }
 205     }
 206
 207     pub fn get_item_data(&self, item: &hir::Item<'_>) -> Option<Data> {
 208         let def_id = item.owner_id.to_def_id();
 209         let attrs = self.tcx.hir().attrs(item.hir_id());
 210         match item.kind {
 211             hir::ItemKind::Fn(ref sig, ref generics, _) => {
 212                 let qualname = format!("::{}", self.tcx.def_path_str(def_id));
 213                 filter!(self.span_utils, item.ident.span);
 214                 Some(Data::DefData(Def {
 215                     kind: DefKind::Function,
 216                     id: id_from_def_id(def_id),
 217                     span: self.span_from_span(item.ident.span),
 218                     name: item.ident.to_string(),
 219                     qualname,
 220                     value: fn_to_string(
 221                         sig.decl,
 222                         sig.header,
 223                         Some(item.ident.name),
 224                         generics,
 225                         &[],
 226                         None,
 227                     ),
 228                     parent: None,
 229                     children: vec![],
 230                     decl_id: None,
 231                     docs: self.docs_for_attrs(attrs),
 232                     sig: sig::item_signature(item, self),
 233                     attributes: lower_attributes(attrs.to_vec(), self),
 234                 }))
 235             }
 236             hir::ItemKind::Static(ref typ, ..) => {
 237                 let qualname = format!("::{}", self.tcx.def_path_str(def_id));
 238
 239                 filter!(self.span_utils, item.ident.span);
 240
 241                 let id = id_from_def_id(def_id);
 242                 let span = self.span_from_span(item.ident.span);
 243
 244                 Some(Data::DefData(Def {
 245                     kind: DefKind::Static,
 246                     id,
 247                     span,
 248                     name: item.ident.to_string(),
 249                     qualname,
 250                     value: ty_to_string(&typ),
 251                     parent: None,
 252                     children: vec![],
 253                     decl_id: None,
 254                     docs: self.docs_for_attrs(attrs),
 255                     sig: sig::item_signature(item, self),
 256                     attributes: lower_attributes(attrs.to_vec(), self),
 257                 }))
 258             }
 259             hir::ItemKind::Const(ref typ, _) => {
 260                 let qualname = format!("::{}", self.tcx.def_path_str(def_id));
 261                 filter!(self.span_utils, item.ident.span);
 262
 263                 let id = id_from_def_id(def_id);
 264                 let span = self.span_from_span(item.ident.span);
 265
 266                 Some(Data::DefData(Def {
 267                     kind: DefKind::Const,
 268                     id,
 269                     span,
 270                     name: item.ident.to_string(),
 271                     qualname,
 272                     value: ty_to_string(typ),
 273                     parent: None,
 274                     children: vec![],
 275                     decl_id: None,
 276                     docs: self.docs_for_attrs(attrs),
 277                     sig: sig::item_signature(item, self),
 278                     attributes: lower_attributes(attrs.to_vec(), self),
 279                 }))
 280             }
 281             hir::ItemKind::Mod(ref m) => {
 282                 let qualname = format!("::{}", self.tcx.def_path_str(def_id));
 283
 284                 let sm = self.tcx.sess.source_map();
 285                 let filename = sm.span_to_filename(m.spans.inner_span);
 286
 287                 filter!(self.span_utils, item.ident.span);
 288
 289                 Some(Data::DefData(Def {
 290                     kind: DefKind::Mod,
 291                     id: id_from_def_id(def_id),
 292                     name: item.ident.to_string(),
 293                     qualname,
 294                     span: self.span_from_span(item.ident.span),
 295                     value: filename.prefer_remapped().to_string(),
 296                     parent: None,
 297                     children: m
 298                         .item_ids
 299                         .iter()
 300                         .map(|i| id_from_def_id(i.owner_id.to_def_id()))
 301                         .collect(),
 302                     decl_id: None,
 303                     docs: self.docs_for_attrs(attrs),
 304                     sig: sig::item_signature(item, self),
 305                     attributes: lower_attributes(attrs.to_vec(), self),
 306                 }))
 307             }
 308             hir::ItemKind::Enum(ref def, ref generics) => {
 309                 let name = item.ident.to_string();
 310                 let qualname = format!("::{}", self.tcx.def_path_str(def_id));
 311                 filter!(self.span_utils, item.ident.span);
 312                 let value =
 313                     enum_def_to_string(def, generics, item.ident.name, item.span);
 314                 Some(Data::DefData(Def {
 315                     kind: DefKind::Enum,
 316                     id: id_from_def_id(def_id),
 317                     span: self.span_from_span(item.ident.span),
 318                     name,
 319                     qualname,
 320                     value,
 321                     parent: None,
 322                     children: def.variants.iter().map(|v| id_from_hir_id(v.hir_id, self)).collect(),
 323                     decl_id: None,
 324                     docs: self.docs_for_attrs(attrs),
 325                     sig: sig::item_signature(item, self),
 326                     attributes: lower_attributes(attrs.to_vec(), self),
 327                 }))
 328             }
 329             hir::ItemKind::Impl(hir::Impl { ref of_trait, ref self_ty, ref items, .. })
 330                 if let hir::TyKind::Path(hir::QPath::Resolved(_, ref path)) = self_ty.kind =>
 331             {
 332                 // Common case impl for a struct or something basic.
 333                 if generated_code(path.span) {
 334                     return None;
 335                 }
 336                 let sub_span = path.segments.last().unwrap().ident.span;
 337                 filter!(self.span_utils, sub_span);
 338
 339                 let impl_id = self.next_impl_id();
 340                 let span = self.span_from_span(sub_span);
 341
 342                 let type_data = self.lookup_def_id(self_ty.hir_id);
 343                 type_data.map(|type_data| {
 344                     Data::RelationData(
 345                         Relation {
 346                             kind: RelationKind::Impl { id: impl_id },
 347                             span: span.clone(),
 348                             from: id_from_def_id(type_data),
 349                             to: of_trait
 350                                 .as_ref()
 351                                 .and_then(|t| self.lookup_def_id(t.hir_ref_id))
 352                                 .map(id_from_def_id)
 353                                 .unwrap_or_else(null_id),
 354                         },
 355                         Impl {
 356                             id: impl_id,
 357                             kind: match *of_trait {
 358                                 Some(_) => ImplKind::Direct,
 359                                 None => ImplKind::Inherent,
 360                             },
 361                             span,
 362                             value: String::new(),
 363                             parent: None,
 364                             children: items
 365                                 .iter()
 366                                 .map(|i| id_from_def_id(i.id.owner_id.to_def_id()))
 367                                 .collect(),
 368                             docs: String::new(),
 369                             sig: None,
 370                             attributes: vec![],
 371                         },
 372                     )
 373                 })
 374             }
 375             hir::ItemKind::Impl(_) => None,
 376             _ => {
 377                 // FIXME
 378                 bug!();
 379             }
 380         }
 381     }
 382
 383     pub fn get_field_data(&self, field: &hir::FieldDef<'_>, scope: hir::HirId) -> Option<Def> {
 384         let name = field.ident.to_string();
 385         let scope_def_id = self.tcx.hir().local_def_id(scope).to_def_id();
 386         let qualname = format!("::{}::{}", self.tcx.def_path_str(scope_def_id), field.ident);
 387         filter!(self.span_utils, field.ident.span);
 388         let field_def_id = self.tcx.hir().local_def_id(field.hir_id).to_def_id();
 389         let typ = self.tcx.type_of(field_def_id).to_string();
 390
 391         let id = id_from_def_id(field_def_id);
 392         let span = self.span_from_span(field.ident.span);
 393         let attrs = self.tcx.hir().attrs(field.hir_id);
 394
 395         Some(Def {
 396             kind: DefKind::Field,
 397             id,
 398             span,
 399             name,
 400             qualname,
 401             value: typ,
 402             parent: Some(id_from_def_id(scope_def_id)),
 403             children: vec![],
 404             decl_id: None,
 405             docs: self.docs_for_attrs(attrs),
 406             sig: sig::field_signature(field, self),
 407             attributes: lower_attributes(attrs.to_vec(), self),
 408         })
 409     }
 410
 411     // FIXME would be nice to take a MethodItem here, but the ast provides both
 412     // trait and impl flavours, so the caller must do the disassembly.
 413     pub fn get_method_data(&self, hir_id: hir::HirId, ident: Ident, span: Span) -> Option<Def> {
 414         // The qualname for a method is the trait name or name of the struct in an impl in
 415         // which the method is declared in, followed by the method's name.
 416         let def_id = self.tcx.hir().local_def_id(hir_id).to_def_id();
 417         let (qualname, parent_scope, decl_id, docs, attributes) =
 418             match self.tcx.impl_of_method(def_id) {
 419                 Some(impl_id) => match self.tcx.hir().get_if_local(impl_id) {
 420                     Some(Node::Item(item)) => match item.kind {
 421                         hir::ItemKind::Impl(hir::Impl { ref self_ty, .. }) => {
 422                             let hir = self.tcx.hir();
 423
 424                             let mut qualname = String::from("<");
 425                             qualname
 426                                 .push_str(&rustc_hir_pretty::id_to_string(&hir, self_ty.hir_id));
 427
 428                             let trait_id = self.tcx.trait_id_of_impl(impl_id);
 429                             let mut docs = String::new();
 430                             let mut attrs = vec![];
 431                             if let Some(Node::ImplItem(_)) = hir.find(hir_id) {
 432                                 attrs = self.tcx.hir().attrs(hir_id).to_vec();
 433                                 docs = self.docs_for_attrs(&attrs);
 434                             }
 435
 436                             let mut decl_id = None;
 437                             if let Some(def_id) = trait_id {
 438                                 // A method in a trait impl.
 439                                 qualname.push_str(" as ");
 440                                 qualname.push_str(&self.tcx.def_path_str(def_id));
 441
 442                                 decl_id = self
 443                                     .tcx
 444                                     .associated_items(def_id)
 445                                     .filter_by_name_unhygienic(ident.name)
 446                                     .next()
 447                                     .map(|item| item.def_id);
 448                             }
 449                             qualname.push('>');
 450
 451                             (qualname, trait_id, decl_id, docs, attrs)
 452                         }
 453                         _ => {
 454                             span_bug!(
 455                                 span,
 456                                 "Container {:?} for method {} not an impl?",
 457                                 impl_id,
 458                                 hir_id
 459                             );
 460                         }
 461                     },
 462                     r => {
 463                         span_bug!(
 464                             span,
 465                             "Container {:?} for method {} is not a node item {:?}",
 466                             impl_id,
 467                             hir_id,
 468                             r
 469                         );
 470                     }
 471                 },
 472                 None => match self.tcx.trait_of_item(def_id) {
 473                     Some(def_id) => {
 474                         let mut docs = String::new();
 475                         let mut attrs = vec![];
 476
 477                         if let Some(Node::TraitItem(_)) = self.tcx.hir().find(hir_id) {
 478                             attrs = self.tcx.hir().attrs(hir_id).to_vec();
 479                             docs = self.docs_for_attrs(&attrs);
 480                         }
 481
 482                         (
 483                             format!("::{}", self.tcx.def_path_str(def_id)),
 484                             Some(def_id),
 485                             None,
 486                             docs,
 487                             attrs,
 488                         )
 489                     }
 490                     None => {
 491                         debug!("could not find container for method {} at {:?}", hir_id, span);
 492                         // This is not necessarily a bug, if there was a compilation error,
 493                         // the typeck results we need might not exist.
 494                         return None;
 495                     }
 496                 },
 497             };
 498
 499         let qualname = format!("{}::{}", qualname, ident.name);
 500
 501         filter!(self.span_utils, ident.span);
 502
 503         Some(Def {
 504             kind: DefKind::Method,
 505             id: id_from_def_id(def_id),
 506             span: self.span_from_span(ident.span),
 507             name: ident.name.to_string(),
 508             qualname,
 509             // FIXME you get better data here by using the visitor.
 510             value: String::new(),
 511             parent: parent_scope.map(id_from_def_id),
 512             children: vec![],
 513             decl_id: decl_id.map(id_from_def_id),
 514             docs,
 515             sig: None,
 516             attributes: lower_attributes(attributes, self),
 517         })
 518     }
 519
 520     pub fn get_expr_data(&self, expr: &hir::Expr<'_>) -> Option<Data> {
 521         let ty = self.typeck_results().expr_ty_adjusted_opt(expr)?;
 522         if matches!(ty.kind(), ty::Error(_)) {
 523             return None;
 524         }
 525         match expr.kind {
 526             hir::ExprKind::Field(ref sub_ex, ident) => {
 527                 match self.typeck_results().expr_ty_adjusted(&sub_ex).kind() {
 528                     ty::Adt(def, _) if !def.is_enum() => {
 529                         let variant = &def.non_enum_variant();
 530                         filter!(self.span_utils, ident.span);
 531                         let span = self.span_from_span(ident.span);
 532                         Some(Data::RefData(Ref {
 533                             kind: RefKind::Variable,
 534                             span,
 535                             ref_id: self
 536                                 .tcx
 537                                 .find_field_index(ident, variant)
 538                                 .map(|index| id_from_def_id(variant.fields[index].did))
 539                                 .unwrap_or_else(null_id),
 540                         }))
 541                     }
 542                     ty::Tuple(..) => None,
 543                     _ => {
 544                         debug!("expected struct or union type, found {:?}", ty);
 545                         None
 546                     }
 547                 }
 548             }
 549             hir::ExprKind::Struct(qpath, ..) => match ty.kind() {
 550                 ty::Adt(def, _) => {
 551                     let sub_span = qpath.last_segment_span();
 552                     filter!(self.span_utils, sub_span);
 553                     let span = self.span_from_span(sub_span);
 554                     Some(Data::RefData(Ref {
 555                         kind: RefKind::Type,
 556                         span,
 557                         ref_id: id_from_def_id(def.did()),
 558                     }))
 559                 }
 560                 _ => {
 561                     debug!("expected adt, found {:?}", ty);
 562                     None
 563                 }
 564             },
 565             hir::ExprKind::MethodCall(ref seg, ..) => {
 566                 let Some(method_id) = self.typeck_results().type_dependent_def_id(expr.hir_id) else {
 567                     debug!("could not resolve method id for {:?}", expr);
 568                     return None;
 569                 };
 570                 let (def_id, decl_id) = match self.tcx.associated_item(method_id).container {
 571                     ty::ImplContainer => (Some(method_id), None),
 572                     ty::TraitContainer => (None, Some(method_id)),
 573                 };
 574                 let sub_span = seg.ident.span;
 575                 filter!(self.span_utils, sub_span);
 576                 let span = self.span_from_span(sub_span);
 577                 Some(Data::RefData(Ref {
 578                     kind: RefKind::Function,
 579                     span,
 580                     ref_id: def_id.or(decl_id).map(id_from_def_id).unwrap_or_else(null_id),
 581                 }))
 582             }
 583             hir::ExprKind::Path(ref path) => {
 584                 self.get_path_data(expr.hir_id, path).map(Data::RefData)
 585             }
 586             _ => {
 587                 // FIXME
 588                 bug!("invalid expression: {:?}", expr);
 589             }
 590         }
 591     }
 592
 593     pub fn get_path_res(&self, hir_id: hir::HirId) -> Res {
 594         match self.tcx.hir().get(hir_id) {
 595             Node::TraitRef(tr) => tr.path.res,
 596
 597             Node::Item(&hir::Item { kind: hir::ItemKind::Use(path, _), .. }) => path.res,
 598             Node::PathSegment(seg) => {
 599                 if seg.res != Res::Err {
 600                     seg.res
 601                 } else {
 602                     let parent_node = self.tcx.hir().get_parent_node(hir_id);
 603                     self.get_path_res(parent_node)
 604                 }
 605             }
 606
 607             Node::Expr(&hir::Expr { kind: hir::ExprKind::Struct(ref qpath, ..), .. }) => {
 608                 self.typeck_results().qpath_res(qpath, hir_id)
 609             }
 610
 611             Node::Expr(&hir::Expr { kind: hir::ExprKind::Path(ref qpath), .. })
 612             | Node::Pat(&hir::Pat {
 613                 kind:
 614                     hir::PatKind::Path(ref qpath)
 615                     | hir::PatKind::Struct(ref qpath, ..)
 616                     | hir::PatKind::TupleStruct(ref qpath, ..),
 617                 ..
 618             })
 619             | Node::Ty(&hir::Ty { kind: hir::TyKind::Path(ref qpath), .. }) => match qpath {
 620                 hir::QPath::Resolved(_, path) => path.res,
 621                 hir::QPath::TypeRelative(..) | hir::QPath::LangItem(..) => {
 622                     // #75962: `self.typeck_results` may be different from the `hir_id`'s result.
 623                     if self.tcx.has_typeck_results(hir_id.owner.to_def_id()) {
 624                         self.tcx.typeck(hir_id.owner.def_id).qpath_res(qpath, hir_id)
 625                     } else {
 626                         Res::Err
 627                     }
 628                 }
 629             },
 630
 631             Node::Pat(&hir::Pat { kind: hir::PatKind::Binding(_, canonical_id, ..), .. }) => {
 632                 Res::Local(canonical_id)
 633             }
 634
 635             _ => Res::Err,
 636         }
 637     }
 638
 639     pub fn get_path_data(&self, id: hir::HirId, path: &hir::QPath<'_>) -> Option<Ref> {
 640         let segment = match path {
 641             hir::QPath::Resolved(_, path) => path.segments.last(),
 642             hir::QPath::TypeRelative(_, segment) => Some(*segment),
 643             hir::QPath::LangItem(..) => None,
 644         };
 645         segment.and_then(|seg| {
 646             self.get_path_segment_data(seg).or_else(|| self.get_path_segment_data_with_id(seg, id))
 647         })
 648     }
 649
 650     pub fn get_path_segment_data(&self, path_seg: &hir::PathSegment<'_>) -> Option<Ref> {
 651         self.get_path_segment_data_with_id(path_seg, path_seg.hir_id)
 652     }
 653
 654     pub fn get_path_segment_data_with_id(
 655         &self,
 656         path_seg: &hir::PathSegment<'_>,
 657         id: hir::HirId,
 658     ) -> Option<Ref> {
 659         // Returns true if the path is function type sugar, e.g., `Fn(A) -> B`.
 660         fn fn_type(seg: &hir::PathSegment<'_>) -> bool {
 661             seg.args.map_or(false, |args| args.parenthesized)
 662         }
 663
 664         let res = self.get_path_res(id);
 665         let span = path_seg.ident.span;
 666         filter!(self.span_utils, span);
 667         let span = self.span_from_span(span);
 668
 669         match res {
 670             Res::Local(id) => {
 671                 Some(Ref { kind: RefKind::Variable, span, ref_id: id_from_hir_id(id, self) })
 672             }
 673             Res::Def(HirDefKind::Trait, def_id) if fn_type(path_seg) => {
 674                 Some(Ref { kind: RefKind::Type, span, ref_id: id_from_def_id(def_id) })
 675             }
 676             Res::Def(
 677                 HirDefKind::Struct
 678                 | HirDefKind::Variant
 679                 | HirDefKind::Union
 680                 | HirDefKind::Enum
 681                 | HirDefKind::TyAlias
 682                 | HirDefKind::ForeignTy
 683                 | HirDefKind::TraitAlias
 684                 | HirDefKind::AssocTy
 685                 | HirDefKind::Trait
 686                 | HirDefKind::OpaqueTy
 687                 | HirDefKind::ImplTraitPlaceholder
 688                 | HirDefKind::TyParam,
 689                 def_id,
 690             ) => Some(Ref { kind: RefKind::Type, span, ref_id: id_from_def_id(def_id) }),
 691             Res::Def(HirDefKind::ConstParam, def_id) => {
 692                 Some(Ref { kind: RefKind::Variable, span, ref_id: id_from_def_id(def_id) })
 693             }
 694             Res::Def(HirDefKind::Ctor(..), def_id) => {
 695                 // This is a reference to a tuple struct or an enum variant where the def_id points
 696                 // to an invisible constructor function. That is not a very useful
 697                 // def, so adjust to point to the tuple struct or enum variant itself.
 698                 let parent_def_id = self.tcx.parent(def_id);
 699                 Some(Ref { kind: RefKind::Type, span, ref_id: id_from_def_id(parent_def_id) })
 700             }
 701             Res::Def(HirDefKind::Static(_) | HirDefKind::Const | HirDefKind::AssocConst, _) => {
 702                 Some(Ref { kind: RefKind::Variable, span, ref_id: id_from_def_id(res.def_id()) })
 703             }
 704             Res::Def(HirDefKind::AssocFn, decl_id) => {
 705                 let def_id = if decl_id.is_local() {
 706                     if self.tcx.impl_defaultness(decl_id).has_value() {
 707                         Some(decl_id)
 708                     } else {
 709                         None
 710                     }
 711                 } else {
 712                     None
 713                 };
 714                 Some(Ref {
 715                     kind: RefKind::Function,
 716                     span,
 717                     ref_id: id_from_def_id(def_id.unwrap_or(decl_id)),
 718                 })
 719             }
 720             Res::Def(HirDefKind::Fn, def_id) => {
 721                 Some(Ref { kind: RefKind::Function, span, ref_id: id_from_def_id(def_id) })
 722             }
 723             Res::Def(HirDefKind::Mod, def_id) => {
 724                 Some(Ref { kind: RefKind::Mod, span, ref_id: id_from_def_id(def_id) })
 725             }
 726
 727             Res::Def(
 728                 HirDefKind::Macro(..)
 729                 | HirDefKind::ExternCrate
 730                 | HirDefKind::ForeignMod
 731                 | HirDefKind::LifetimeParam
 732                 | HirDefKind::AnonConst
 733                 | HirDefKind::InlineConst
 734                 | HirDefKind::Use
 735                 | HirDefKind::Field
 736                 | HirDefKind::GlobalAsm
 737                 | HirDefKind::Impl
 738                 | HirDefKind::Closure
 739                 | HirDefKind::Generator,
 740                 _,
 741             )
 742             | Res::PrimTy(..)
 743             | Res::SelfTyParam { .. }
 744             | Res::SelfTyAlias { .. }
 745             | Res::ToolMod
 746             | Res::NonMacroAttr(..)
 747             | Res::SelfCtor(..)
 748             | Res::Err => None,
 749         }
 750     }
 751
 752     pub fn get_field_ref_data(
 753         &self,
 754         field_ref: &hir::ExprField<'_>,
 755         variant: &ty::VariantDef,
 756     ) -> Option<Ref> {
 757         filter!(self.span_utils, field_ref.ident.span);
 758         self.tcx.find_field_index(field_ref.ident, variant).map(|index| {
 759             let span = self.span_from_span(field_ref.ident.span);
 760             Ref { kind: RefKind::Variable, span, ref_id: id_from_def_id(variant.fields[index].did) }
 761         })
 762     }
 763
 764     /// Attempt to return MacroRef for any AST node.
 765     ///
 766     /// For a given piece of AST defined by the supplied Span and NodeId,
 767     /// returns `None` if the node is not macro-generated or the span is malformed,
 768     /// else uses the expansion callsite and callee to return some MacroRef.
 769     ///
 770     /// FIXME: [`DumpVisitor::process_macro_use`] should actually dump this data
 771     #[allow(dead_code)]
 772     fn get_macro_use_data(&self, span: Span) -> Option<MacroRef> {
 773         if !generated_code(span) {
 774             return None;
 775         }
 776         // Note we take care to use the source callsite/callee, to handle
 777         // nested expansions and ensure we only generate data for source-visible
 778         // macro uses.
 779         let callsite = span.source_callsite();
 780         let callsite_span = self.span_from_span(callsite);
 781         let callee = span.source_callee()?;
 782
 783         let mac_name = match callee.kind {
 784             ExpnKind::Macro(kind, name) => match kind {
 785                 MacroKind::Bang => name,
 786
 787                 // Ignore attribute macros, their spans are usually mangled
 788                 // FIXME(eddyb) is this really the case anymore?
 789                 MacroKind::Attr | MacroKind::Derive => return None,
 790             },
 791
 792             // These are not macros.
 793             // FIXME(eddyb) maybe there is a way to handle them usefully?
 794             ExpnKind::Inlined | ExpnKind::Root | ExpnKind::AstPass(_) | ExpnKind::Desugaring(_) => {
 795                 return None;
 796             }
 797         };
 798
 799         let callee_span = self.span_from_span(callee.def_site);
 800         Some(MacroRef {
 801             span: callsite_span,
 802             qualname: mac_name.to_string(), // FIXME: generate the real qualname
 803             callee_span,
 804         })
 805     }
 806
 807     fn lookup_def_id(&self, ref_id: hir::HirId) -> Option<DefId> {
 808         match self.get_path_res(ref_id) {
 809             Res::PrimTy(_) | Res::SelfTyParam { .. } | Res::SelfTyAlias { .. } | Res::Err => None,
 810             def => def.opt_def_id(),
 811         }
 812     }
 813
 814     fn docs_for_attrs(&self, attrs: &[ast::Attribute]) -> String {
 815         let mut result = String::new();
 816
 817         for attr in attrs {
 818             if let Some((val, kind)) = attr.doc_str_and_comment_kind() {
 819                 // FIXME: Should save-analysis beautify doc strings itself or leave it to users?
 820                 result.push_str(beautify_doc_string(val, kind).as_str());
 821                 result.push('\n');
 822             }
 823         }
 824
 825         if !self.config.full_docs {
 826             if let Some(index) = result.find("\n\n") {
 827                 result.truncate(index);
 828             }
 829         }
 830
 831         result
 832     }
 833
 834     fn next_impl_id(&self) -> u32 {
 835         let next = self.impl_counter.get();
 836         self.impl_counter.set(next + 1);
 837         next
 838     }
 839 }
 840
 841 // An AST visitor for collecting paths (e.g., the names of structs) and formal
 842 // variables (idents) from patterns.
 843 struct PathCollector<'l> {
 844     tcx: TyCtxt<'l>,
 845     collected_paths: Vec<(hir::HirId, &'l hir::QPath<'l>)>,
 846     collected_idents: Vec<(hir::HirId, Ident, hir::Mutability)>,
 847 }
 848
 849 impl<'l> PathCollector<'l> {
 850     fn new(tcx: TyCtxt<'l>) -> PathCollector<'l> {
 851         PathCollector { tcx, collected_paths: vec![], collected_idents: vec![] }
 852     }
 853 }
 854
 855 impl<'l> Visitor<'l> for PathCollector<'l> {
 856     type NestedFilter = nested_filter::All;
 857
 858     fn nested_visit_map(&mut self) -> Self::Map {
 859         self.tcx.hir()
 860     }
 861
 862     fn visit_pat(&mut self, p: &'l hir::Pat<'l>) {
 863         match p.kind {
 864             hir::PatKind::Struct(ref path, ..) => {
 865                 self.collected_paths.push((p.hir_id, path));
 866             }
 867             hir::PatKind::TupleStruct(ref path, ..) | hir::PatKind::Path(ref path) => {
 868                 self.collected_paths.push((p.hir_id, path));
 869             }
 870             hir::PatKind::Binding(hir::BindingAnnotation(_, mutbl), _, ident, _) => {
 871                 debug!(
 872                     "PathCollector, visit ident in pat {}: {:?} {:?}",
 873                     ident, p.span, ident.span
 874                 );
 875                 self.collected_idents.push((p.hir_id, ident, mutbl));
 876             }
 877             _ => {}
 878         }
 879         intravisit::walk_pat(self, p);
 880     }
 881 }
 882
 883 /// Defines what to do with the results of saving the analysis.
 884 pub trait SaveHandler {
 885     fn save(&mut self, save_ctxt: &SaveContext<'_>, analysis: &Analysis);
 886 }
 887
 888 /// Dump the save-analysis results to a file.
 889 pub struct DumpHandler<'a> {
 890     odir: Option<&'a Path>,
 891     cratename: String,
 892 }
 893
 894 impl<'a> DumpHandler<'a> {
 895     pub fn new(odir: Option<&'a Path>, cratename: &str) -> DumpHandler<'a> {
 896         DumpHandler { odir, cratename: cratename.to_owned() }
 897     }
 898
 899     fn output_file(&self, ctx: &SaveContext<'_>) -> (BufWriter<File>, PathBuf) {
 900         let sess = &ctx.tcx.sess;
 901         let file_name = match ctx.config.output_file {
 902             Some(ref s) => PathBuf::from(s),
 903             None => {
 904                 let mut root_path = match self.odir {
 905                     Some(val) => val.join("save-analysis"),
 906                     None => PathBuf::from("save-analysis-temp"),
 907                 };
 908
 909                 if let Err(e) = std::fs::create_dir_all(&root_path) {
 910                     error!("Could not create directory {}: {}", root_path.display(), e);
 911                 }
 912
 913                 let executable = sess.crate_types().iter().any(|ct| *ct == CrateType::Executable);
 914                 let mut out_name = if executable { String::new() } else { "lib".to_owned() };
 915                 out_name.push_str(&self.cratename);
 916                 out_name.push_str(&sess.opts.cg.extra_filename);
 917                 out_name.push_str(".json");
 918                 root_path.push(&out_name);
 919
 920                 root_path
 921             }
 922         };
 923
 924         info!("Writing output to {}", file_name.display());
 925
 926         let output_file = BufWriter::new(File::create(&file_name).unwrap_or_else(|e| {
 927             sess.emit_fatal(errors::CouldNotOpen { file_name: file_name.as_path(), err: e })
 928         }));
 929
 930         (output_file, file_name)
 931     }
 932 }
 933
 934 impl SaveHandler for DumpHandler<'_> {
 935     fn save(&mut self, save_ctxt: &SaveContext<'_>, analysis: &Analysis) {
 936         let sess = &save_ctxt.tcx.sess;
 937         let (output, file_name) = self.output_file(&save_ctxt);
 938         if let Err(e) = serde_json::to_writer(output, &analysis) {
 939             error!("Can't serialize save-analysis: {:?}", e);
 940         }
 941
 942         if sess.opts.json_artifact_notifications {
 943             sess.parse_sess.span_diagnostic.emit_artifact_notification(&file_name, "save-analysis");
 944         }
 945     }
 946 }
 947
 948 /// Call a callback with the results of save-analysis.
 949 pub struct CallbackHandler<'b> {
 950     pub callback: &'b mut dyn FnMut(&rls_data::Analysis),
 951 }
 952
 953 impl SaveHandler for CallbackHandler<'_> {
 954     fn save(&mut self, _: &SaveContext<'_>, analysis: &Analysis) {
 955         (self.callback)(analysis)
 956     }
 957 }
 958
 959 pub fn process_crate<'l, 'tcx, H: SaveHandler>(
 960     tcx: TyCtxt<'tcx>,
 961     cratename: &str,
 962     input: &'l Input,
 963     config: Option<Config>,
 964     mut handler: H,
 965 ) {
 966     with_no_trimmed_paths!({
 967         tcx.dep_graph.with_ignore(|| {
 968             info!("Dumping crate {}", cratename);
 969
 970             // Privacy checking must be done outside of type inference; use a
 971             // fallback in case effective visibilities couldn't have been correctly computed.
 972             let effective_visibilities = match tcx.sess.compile_status() {
 973                 Ok(..) => tcx.effective_visibilities(()),
 974                 Err(..) => tcx.arena.alloc(EffectiveVisibilities::default()),
 975             };
 976
 977             let save_ctxt = SaveContext {
 978                 tcx,
 979                 maybe_typeck_results: None,
 980                 effective_visibilities: &effective_visibilities,
 981                 span_utils: SpanUtils::new(&tcx.sess),
 982                 config: find_config(config),
 983                 impl_counter: Cell::new(0),
 984             };
 985
 986             let mut visitor = DumpVisitor::new(save_ctxt);
 987
 988             visitor.dump_crate_info(cratename);
 989             visitor.dump_compilation_options(input, cratename);
 990             visitor.process_crate();
 991
 992             handler.save(&visitor.save_ctxt, &visitor.analysis())
 993         })
 994     })
 995 }
 996
 997 fn find_config(supplied: Option<Config>) -> Config {
 998     if let Some(config) = supplied {
 999         return config;
1000     }
1001
1002     match env::var_os("RUST_SAVE_ANALYSIS_CONFIG") {
1003         None => Config::default(),
1004         Some(config) => config
1005             .to_str()
1006             .ok_or(())
1007             .map_err(|_| error!("`RUST_SAVE_ANALYSIS_CONFIG` isn't UTF-8"))
1008             .and_then(|cfg| {
1009                 serde_json::from_str(cfg)
1010                     .map_err(|_| error!("Could not deserialize save-analysis config"))
1011             })
1012             .unwrap_or_default(),
1013     }
1014 }
1015
1016 // Utility functions for the module.
1017
1018 // Helper function to escape quotes in a string
1019 fn escape(s: String) -> String {
1020     s.replace('\"', "\"\"")
1021 }
1022
1023 // Helper function to determine if a span came from a
1024 // macro expansion or syntax extension.
1025 fn generated_code(span: Span) -> bool {
1026     span.from_expansion() || span.is_dummy()
1027 }
1028
1029 // DefId::index is a newtype and so the JSON serialisation is ugly. Therefore
1030 // we use our own Id which is the same, but without the newtype.
1031 fn id_from_def_id(id: DefId) -> rls_data::Id {
1032     rls_data::Id { krate: id.krate.as_u32(), index: id.index.as_u32() }
1033 }
1034
1035 fn id_from_hir_id(id: hir::HirId, scx: &SaveContext<'_>) -> rls_data::Id {
1036     let def_id = scx.tcx.hir().opt_local_def_id(id);
1037     def_id.map(|id| id_from_def_id(id.to_def_id())).unwrap_or_else(|| {
1038         // Create a *fake* `DefId` out of a `HirId` by combining the owner
1039         // `local_def_index` and the `local_id`.
1040         // This will work unless you have *billions* of definitions in a single
1041         // crate (very unlikely to actually happen).
1042         rls_data::Id {
1043             krate: LOCAL_CRATE.as_u32(),
1044             index: id.owner.def_id.local_def_index.as_u32() | id.local_id.as_u32().reverse_bits(),
1045         }
1046     })
1047 }
1048
1049 fn null_id() -> rls_data::Id {
1050     rls_data::Id { krate: u32::MAX, index: u32::MAX }
1051 }
1052
1053 fn lower_attributes(attrs: Vec<ast::Attribute>, scx: &SaveContext<'_>) -> Vec<rls_data::Attribute> {
1054     attrs
1055         .into_iter()
1056         // Only retain real attributes. Doc comments are lowered separately.
1057         .filter(|attr| !attr.has_name(sym::doc))
1058         .map(|mut attr| {
1059             // Remove the surrounding '#[..]' or '#![..]' of the pretty printed
1060             // attribute. First normalize all inner attribute (#![..]) to outer
1061             // ones (#[..]), then remove the two leading and the one trailing character.
1062             attr.style = ast::AttrStyle::Outer;
1063             let value = attribute_to_string(&attr);
1064             // This str slicing works correctly, because the leading and trailing characters
1065             // are in the ASCII range and thus exactly one byte each.
1066             let value = value[2..value.len() - 1].to_string();
1067
1068             rls_data::Attribute { value, span: scx.span_from_span(attr.span) }
1069         })
1070         .collect()
1071 }