compiler/rustc_save_analysis/src/lib.rs

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