src/librustc/middle/stability.rs

   1 // Copyright 2014 The Rust Project Developers. See the COPYRIGHT
   2 // file at the top-level directory of this distribution and at
   3 // http://rust-lang.org/COPYRIGHT.
   4 //
   5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
   6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
   7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
   8 // option. This file may not be copied, modified, or distributed
   9 // except according to those terms.
  10
  11 //! A pass that annotates every item and method with its stability level,
  12 //! propagating default levels lexically from parent to children ast nodes.
  13
  14 pub use self::StabilityLevel::*;
  15
  16 use lint;
  17 use hir::def::Def;
  18 use hir::def_id::{CrateNum, CRATE_DEF_INDEX, DefId, LOCAL_CRATE};
  19 use ty::{self, TyCtxt};
  20 use middle::privacy::AccessLevels;
  21 use session::{DiagnosticMessageId, Session};
  22 use syntax::symbol::Symbol;
  23 use syntax_pos::{Span, MultiSpan};
  24 use syntax::ast;
  25 use syntax::ast::{NodeId, Attribute};
  26 use syntax::feature_gate::{GateIssue, emit_feature_err};
  27 use syntax::attr::{self, Stability, Deprecation};
  28 use util::nodemap::{FxHashSet, FxHashMap};
  29
  30 use hir;
  31 use hir::{Item, Generics, StructField, Variant, HirId};
  32 use hir::intravisit::{self, Visitor, NestedVisitorMap};
  33
  34 use std::mem::replace;
  35 use std::cmp::Ordering;
  36
  37 #[derive(RustcEncodable, RustcDecodable, PartialEq, PartialOrd, Clone, Copy, Debug, Eq, Hash)]
  38 pub enum StabilityLevel {
  39     Unstable,
  40     Stable,
  41 }
  42
  43 impl StabilityLevel {
  44     pub fn from_attr_level(level: &attr::StabilityLevel) -> Self {
  45         if level.is_stable() { Stable } else { Unstable }
  46     }
  47 }
  48
  49 #[derive(PartialEq)]
  50 enum AnnotationKind {
  51     // Annotation is required if not inherited from unstable parents
  52     Required,
  53     // Annotation is useless, reject it
  54     Prohibited,
  55     // Annotation itself is useless, but it can be propagated to children
  56     Container,
  57 }
  58
  59 /// An entry in the `depr_map`.
  60 #[derive(Clone)]
  61 pub struct DeprecationEntry {
  62     /// The metadata of the attribute associated with this entry.
  63     pub attr: Deprecation,
  64     /// The def id where the attr was originally attached. `None` for non-local
  65     /// `DefId`'s.
  66     origin: Option<HirId>,
  67 }
  68
  69 impl_stable_hash_for!(struct self::DeprecationEntry {
  70     attr,
  71     origin
  72 });
  73
  74 impl DeprecationEntry {
  75     fn local(attr: Deprecation, id: HirId) -> DeprecationEntry {
  76         DeprecationEntry {
  77             attr,
  78             origin: Some(id),
  79         }
  80     }
  81
  82     pub fn external(attr: Deprecation) -> DeprecationEntry {
  83         DeprecationEntry {
  84             attr,
  85             origin: None,
  86         }
  87     }
  88
  89     pub fn same_origin(&self, other: &DeprecationEntry) -> bool {
  90         match (self.origin, other.origin) {
  91             (Some(o1), Some(o2)) => o1 == o2,
  92             _ => false
  93         }
  94     }
  95 }
  96
  97 /// A stability index, giving the stability level for items and methods.
  98 pub struct Index<'tcx> {
  99     /// This is mostly a cache, except the stabilities of local items
 100     /// are filled by the annotator.
 101     stab_map: FxHashMap<HirId, &'tcx Stability>,
 102     depr_map: FxHashMap<HirId, DeprecationEntry>,
 103
 104     /// Maps for each crate whether it is part of the staged API.
 105     staged_api: FxHashMap<CrateNum, bool>,
 106
 107     /// Features enabled for this crate.
 108     active_features: FxHashSet<Symbol>,
 109 }
 110
 111 impl_stable_hash_for!(struct self::Index<'tcx> {
 112     stab_map,
 113     depr_map,
 114     staged_api,
 115     active_features
 116 });
 117
 118 // A private tree-walker for producing an Index.
 119 struct Annotator<'a, 'tcx: 'a> {
 120     tcx: TyCtxt<'a, 'tcx, 'tcx>,
 121     index: &'a mut Index<'tcx>,
 122     parent_stab: Option<&'tcx Stability>,
 123     parent_depr: Option<DeprecationEntry>,
 124     in_trait_impl: bool,
 125 }
 126
 127 impl<'a, 'tcx: 'a> Annotator<'a, 'tcx> {
 128     // Determine the stability for a node based on its attributes and inherited
 129     // stability. The stability is recorded in the index and used as the parent.
 130     fn annotate<F>(&mut self, id: NodeId, attrs: &[Attribute],
 131                    item_sp: Span, kind: AnnotationKind, visit_children: F)
 132         where F: FnOnce(&mut Self)
 133     {
 134         if self.tcx.features().staged_api {
 135             // This crate explicitly wants staged API.
 136             debug!("annotate(id = {:?}, attrs = {:?})", id, attrs);
 137             if let Some(..) = attr::find_deprecation(self.tcx.sess.diagnostic(), attrs, item_sp) {
 138                 self.tcx.sess.span_err(item_sp, "`#[deprecated]` cannot be used in staged api, \
 139                                                  use `#[rustc_deprecated]` instead");
 140             }
 141             if let Some(mut stab) = attr::find_stability(self.tcx.sess.diagnostic(),
 142                                                          attrs, item_sp) {
 143                 // Error if prohibited, or can't inherit anything from a container
 144                 if kind == AnnotationKind::Prohibited ||
 145                    (kind == AnnotationKind::Container &&
 146                     stab.level.is_stable() &&
 147                     stab.rustc_depr.is_none()) {
 148                     self.tcx.sess.span_err(item_sp, "This stability annotation is useless");
 149                 }
 150
 151                 debug!("annotate: found {:?}", stab);
 152                 // If parent is deprecated and we're not, inherit this by merging
 153                 // deprecated_since and its reason.
 154                 if let Some(parent_stab) = self.parent_stab {
 155                     if parent_stab.rustc_depr.is_some() && stab.rustc_depr.is_none() {
 156                         stab.rustc_depr = parent_stab.rustc_depr.clone()
 157                     }
 158                 }
 159
 160                 let stab = self.tcx.intern_stability(stab);
 161
 162                 // Check if deprecated_since < stable_since. If it is,
 163                 // this is *almost surely* an accident.
 164                 if let (&Some(attr::RustcDeprecation {since: dep_since, ..}),
 165                         &attr::Stable {since: stab_since}) = (&stab.rustc_depr, &stab.level) {
 166                     // Explicit version of iter::order::lt to handle parse errors properly
 167                     for (dep_v, stab_v) in
 168                             dep_since.as_str().split('.').zip(stab_since.as_str().split('.')) {
 169                         if let (Ok(dep_v), Ok(stab_v)) = (dep_v.parse::<u64>(), stab_v.parse()) {
 170                             match dep_v.cmp(&stab_v) {
 171                                 Ordering::Less => {
 172                                     self.tcx.sess.span_err(item_sp, "An API can't be stabilized \
 173                                                                      after it is deprecated");
 174                                     break
 175                                 }
 176                                 Ordering::Equal => continue,
 177                                 Ordering::Greater => break,
 178                             }
 179                         } else {
 180                             // Act like it isn't less because the question is now nonsensical,
 181                             // and this makes us not do anything else interesting.
 182                             self.tcx.sess.span_err(item_sp, "Invalid stability or deprecation \
 183                                                              version found");
 184                             break
 185                         }
 186                     }
 187                 }
 188
 189                 let hir_id = self.tcx.hir.node_to_hir_id(id);
 190                 self.index.stab_map.insert(hir_id, stab);
 191
 192                 let orig_parent_stab = replace(&mut self.parent_stab, Some(stab));
 193                 visit_children(self);
 194                 self.parent_stab = orig_parent_stab;
 195             } else {
 196                 debug!("annotate: not found, parent = {:?}", self.parent_stab);
 197                 if let Some(stab) = self.parent_stab {
 198                     if stab.level.is_unstable() {
 199                         let hir_id = self.tcx.hir.node_to_hir_id(id);
 200                         self.index.stab_map.insert(hir_id, stab);
 201                     }
 202                 }
 203                 visit_children(self);
 204             }
 205         } else {
 206             // Emit errors for non-staged-api crates.
 207             for attr in attrs {
 208                 let tag = attr.name();
 209                 if tag == "unstable" || tag == "stable" || tag == "rustc_deprecated" {
 210                     attr::mark_used(attr);
 211                     self.tcx.sess.span_err(attr.span(), "stability attributes may not be used \
 212                                                          outside of the standard library");
 213                 }
 214             }
 215
 216             // Propagate unstability.  This can happen even for non-staged-api crates in case
 217             // -Zforce-unstable-if-unmarked is set.
 218             if let Some(stab) = self.parent_stab {
 219                 if stab.level.is_unstable() {
 220                     let hir_id = self.tcx.hir.node_to_hir_id(id);
 221                     self.index.stab_map.insert(hir_id, stab);
 222                 }
 223             }
 224
 225             if let Some(depr) = attr::find_deprecation(self.tcx.sess.diagnostic(), attrs, item_sp) {
 226                 if kind == AnnotationKind::Prohibited {
 227                     self.tcx.sess.span_err(item_sp, "This deprecation annotation is useless");
 228                 }
 229
 230                 // `Deprecation` is just two pointers, no need to intern it
 231                 let hir_id = self.tcx.hir.node_to_hir_id(id);
 232                 let depr_entry = DeprecationEntry::local(depr, hir_id);
 233                 self.index.depr_map.insert(hir_id, depr_entry.clone());
 234
 235                 let orig_parent_depr = replace(&mut self.parent_depr,
 236                                                Some(depr_entry));
 237                 visit_children(self);
 238                 self.parent_depr = orig_parent_depr;
 239             } else if let Some(parent_depr) = self.parent_depr.clone() {
 240                 let hir_id = self.tcx.hir.node_to_hir_id(id);
 241                 self.index.depr_map.insert(hir_id, parent_depr);
 242                 visit_children(self);
 243             } else {
 244                 visit_children(self);
 245             }
 246         }
 247     }
 248 }
 249
 250 impl<'a, 'tcx> Visitor<'tcx> for Annotator<'a, 'tcx> {
 251     /// Because stability levels are scoped lexically, we want to walk
 252     /// nested items in the context of the outer item, so enable
 253     /// deep-walking.
 254     fn nested_visit_map<'this>(&'this mut self) -> NestedVisitorMap<'this, 'tcx> {
 255         NestedVisitorMap::All(&self.tcx.hir)
 256     }
 257
 258     fn visit_item(&mut self, i: &'tcx Item) {
 259         let orig_in_trait_impl = self.in_trait_impl;
 260         let mut kind = AnnotationKind::Required;
 261         match i.node {
 262             // Inherent impls and foreign modules serve only as containers for other items,
 263             // they don't have their own stability. They still can be annotated as unstable
 264             // and propagate this unstability to children, but this annotation is completely
 265             // optional. They inherit stability from their parents when unannotated.
 266             hir::ItemKind::Impl(.., None, _, _) | hir::ItemKind::ForeignMod(..) => {
 267                 self.in_trait_impl = false;
 268                 kind = AnnotationKind::Container;
 269             }
 270             hir::ItemKind::Impl(.., Some(_), _, _) => {
 271                 self.in_trait_impl = true;
 272             }
 273             hir::ItemKind::Struct(ref sd, _) => {
 274                 if !sd.is_struct() {
 275                     self.annotate(sd.id(), &i.attrs, i.span, AnnotationKind::Required, |_| {})
 276                 }
 277             }
 278             _ => {}
 279         }
 280
 281         self.annotate(i.id, &i.attrs, i.span, kind, |v| {
 282             intravisit::walk_item(v, i)
 283         });
 284         self.in_trait_impl = orig_in_trait_impl;
 285     }
 286
 287     fn visit_trait_item(&mut self, ti: &'tcx hir::TraitItem) {
 288         self.annotate(ti.id, &ti.attrs, ti.span, AnnotationKind::Required, |v| {
 289             intravisit::walk_trait_item(v, ti);
 290         });
 291     }
 292
 293     fn visit_impl_item(&mut self, ii: &'tcx hir::ImplItem) {
 294         let kind = if self.in_trait_impl {
 295             AnnotationKind::Prohibited
 296         } else {
 297             AnnotationKind::Required
 298         };
 299         self.annotate(ii.id, &ii.attrs, ii.span, kind, |v| {
 300             intravisit::walk_impl_item(v, ii);
 301         });
 302     }
 303
 304     fn visit_variant(&mut self, var: &'tcx Variant, g: &'tcx Generics, item_id: NodeId) {
 305         self.annotate(var.node.data.id(), &var.node.attrs, var.span, AnnotationKind::Required, |v| {
 306             intravisit::walk_variant(v, var, g, item_id);
 307         })
 308     }
 309
 310     fn visit_struct_field(&mut self, s: &'tcx StructField) {
 311         self.annotate(s.id, &s.attrs, s.span, AnnotationKind::Required, |v| {
 312             intravisit::walk_struct_field(v, s);
 313         });
 314     }
 315
 316     fn visit_foreign_item(&mut self, i: &'tcx hir::ForeignItem) {
 317         self.annotate(i.id, &i.attrs, i.span, AnnotationKind::Required, |v| {
 318             intravisit::walk_foreign_item(v, i);
 319         });
 320     }
 321
 322     fn visit_macro_def(&mut self, md: &'tcx hir::MacroDef) {
 323         self.annotate(md.id, &md.attrs, md.span, AnnotationKind::Required, |_| {});
 324     }
 325 }
 326
 327 struct MissingStabilityAnnotations<'a, 'tcx: 'a> {
 328     tcx: TyCtxt<'a, 'tcx, 'tcx>,
 329     access_levels: &'a AccessLevels,
 330 }
 331
 332 impl<'a, 'tcx: 'a> MissingStabilityAnnotations<'a, 'tcx> {
 333     fn check_missing_stability(&self, id: NodeId, span: Span) {
 334         let hir_id = self.tcx.hir.node_to_hir_id(id);
 335         let stab = self.tcx.stability().local_stability(hir_id);
 336         let is_error = !self.tcx.sess.opts.test &&
 337                         stab.is_none() &&
 338                         self.access_levels.is_reachable(id);
 339         if is_error {
 340             self.tcx.sess.span_err(span, "This node does not have a stability attribute");
 341         }
 342     }
 343 }
 344
 345 impl<'a, 'tcx> Visitor<'tcx> for MissingStabilityAnnotations<'a, 'tcx> {
 346     fn nested_visit_map<'this>(&'this mut self) -> NestedVisitorMap<'this, 'tcx> {
 347         NestedVisitorMap::OnlyBodies(&self.tcx.hir)
 348     }
 349
 350     fn visit_item(&mut self, i: &'tcx Item) {
 351         match i.node {
 352             // Inherent impls and foreign modules serve only as containers for other items,
 353             // they don't have their own stability. They still can be annotated as unstable
 354             // and propagate this unstability to children, but this annotation is completely
 355             // optional. They inherit stability from their parents when unannotated.
 356             hir::ItemKind::Impl(.., None, _, _) | hir::ItemKind::ForeignMod(..) => {}
 357
 358             _ => self.check_missing_stability(i.id, i.span)
 359         }
 360
 361         intravisit::walk_item(self, i)
 362     }
 363
 364     fn visit_trait_item(&mut self, ti: &'tcx hir::TraitItem) {
 365         self.check_missing_stability(ti.id, ti.span);
 366         intravisit::walk_trait_item(self, ti);
 367     }
 368
 369     fn visit_impl_item(&mut self, ii: &'tcx hir::ImplItem) {
 370         let impl_def_id = self.tcx.hir.local_def_id(self.tcx.hir.get_parent(ii.id));
 371         if self.tcx.impl_trait_ref(impl_def_id).is_none() {
 372             self.check_missing_stability(ii.id, ii.span);
 373         }
 374         intravisit::walk_impl_item(self, ii);
 375     }
 376
 377     fn visit_variant(&mut self, var: &'tcx Variant, g: &'tcx Generics, item_id: NodeId) {
 378         self.check_missing_stability(var.node.data.id(), var.span);
 379         intravisit::walk_variant(self, var, g, item_id);
 380     }
 381
 382     fn visit_struct_field(&mut self, s: &'tcx StructField) {
 383         self.check_missing_stability(s.id, s.span);
 384         intravisit::walk_struct_field(self, s);
 385     }
 386
 387     fn visit_foreign_item(&mut self, i: &'tcx hir::ForeignItem) {
 388         self.check_missing_stability(i.id, i.span);
 389         intravisit::walk_foreign_item(self, i);
 390     }
 391
 392     fn visit_macro_def(&mut self, md: &'tcx hir::MacroDef) {
 393         self.check_missing_stability(md.id, md.span);
 394     }
 395 }
 396
 397 impl<'a, 'tcx> Index<'tcx> {
 398     pub fn new(tcx: TyCtxt<'a, 'tcx, 'tcx>) -> Index<'tcx> {
 399         let is_staged_api =
 400             tcx.sess.opts.debugging_opts.force_unstable_if_unmarked ||
 401             tcx.features().staged_api;
 402         let mut staged_api = FxHashMap();
 403         staged_api.insert(LOCAL_CRATE, is_staged_api);
 404         let mut index = Index {
 405             staged_api,
 406             stab_map: FxHashMap(),
 407             depr_map: FxHashMap(),
 408             active_features: FxHashSet(),
 409         };
 410
 411         let ref active_lib_features = tcx.features().declared_lib_features;
 412
 413         // Put the active features into a map for quick lookup
 414         index.active_features = active_lib_features.iter().map(|&(ref s, _)| s.clone()).collect();
 415
 416         {
 417             let krate = tcx.hir.krate();
 418             let mut annotator = Annotator {
 419                 tcx,
 420                 index: &mut index,
 421                 parent_stab: None,
 422                 parent_depr: None,
 423                 in_trait_impl: false,
 424             };
 425
 426             // If the `-Z force-unstable-if-unmarked` flag is passed then we provide
 427             // a parent stability annotation which indicates that this is private
 428             // with the `rustc_private` feature. This is intended for use when
 429             // compiling librustc crates themselves so we can leverage crates.io
 430             // while maintaining the invariant that all sysroot crates are unstable
 431             // by default and are unable to be used.
 432             if tcx.sess.opts.debugging_opts.force_unstable_if_unmarked {
 433                 let reason = "this crate is being loaded from the sysroot, an \
 434                               unstable location; did you mean to load this crate \
 435                               from crates.io via `Cargo.toml` instead?";
 436                 let stability = tcx.intern_stability(Stability {
 437                     level: attr::StabilityLevel::Unstable {
 438                         reason: Some(Symbol::intern(reason)),
 439                         issue: 27812,
 440                     },
 441                     feature: Symbol::intern("rustc_private"),
 442                     rustc_depr: None,
 443                     const_stability: None,
 444                     promotable: false,
 445                 });
 446                 annotator.parent_stab = Some(stability);
 447             }
 448
 449             annotator.annotate(ast::CRATE_NODE_ID,
 450                                &krate.attrs,
 451                                krate.span,
 452                                AnnotationKind::Required,
 453                                |v| intravisit::walk_crate(v, krate));
 454         }
 455         return index
 456     }
 457
 458     pub fn local_stability(&self, id: HirId) -> Option<&'tcx Stability> {
 459         self.stab_map.get(&id).cloned()
 460     }
 461
 462     pub fn local_deprecation_entry(&self, id: HirId) -> Option<DeprecationEntry> {
 463         self.depr_map.get(&id).cloned()
 464     }
 465 }
 466
 467 /// Cross-references the feature names of unstable APIs with enabled
 468 /// features and possibly prints errors.
 469 pub fn check_unstable_api_usage<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>) {
 470     let mut checker = Checker { tcx: tcx };
 471     tcx.hir.krate().visit_all_item_likes(&mut checker.as_deep_visitor());
 472 }
 473
 474 /// Check whether an item marked with `deprecated(since="X")` is currently
 475 /// deprecated (i.e. whether X is not greater than the current rustc version).
 476 pub fn deprecation_in_effect(since: &str) -> bool {
 477     fn parse_version(ver: &str) -> Vec<u32> {
 478         // We ignore non-integer components of the version (e.g. "nightly").
 479         ver.split(|c| c == '.' || c == '-').flat_map(|s| s.parse()).collect()
 480     }
 481
 482     if let Some(rustc) = option_env!("CFG_RELEASE") {
 483         let since: Vec<u32> = parse_version(since);
 484         let rustc: Vec<u32> = parse_version(rustc);
 485         // We simply treat invalid `since` attributes as relating to a previous
 486         // Rust version, thus always displaying the warning.
 487         if since.len() != 3 {
 488             return true;
 489         }
 490         since <= rustc
 491     } else {
 492         // By default, a deprecation warning applies to
 493         // the current version of the compiler.
 494         true
 495     }
 496 }
 497
 498 struct Checker<'a, 'tcx: 'a> {
 499     tcx: TyCtxt<'a, 'tcx, 'tcx>,
 500 }
 501
 502 /// Result of `TyCtxt::eval_stability`.
 503 pub enum EvalResult {
 504     /// We can use the item because it is stable or we provided the
 505     /// corresponding feature gate.
 506     Allow,
 507     /// We cannot use the item because it is unstable and we did not provide the
 508     /// corresponding feature gate.
 509     Deny {
 510         feature: Symbol,
 511         reason: Option<Symbol>,
 512         issue: u32,
 513     },
 514     /// The item does not have the `#[stable]` or `#[unstable]` marker assigned.
 515     Unmarked,
 516 }
 517
 518 impl<'a, 'gcx, 'tcx> TyCtxt<'a, 'gcx, 'tcx> {
 519     // (See issue #38412)
 520     fn skip_stability_check_due_to_privacy(self, mut def_id: DefId) -> bool {
 521         // Check if `def_id` is a trait method.
 522         match self.describe_def(def_id) {
 523             Some(Def::Method(_)) |
 524             Some(Def::AssociatedTy(_)) |
 525             Some(Def::AssociatedConst(_)) => {
 526                 match self.associated_item(def_id).container {
 527                     ty::TraitContainer(trait_def_id) => {
 528                         // Trait methods do not declare visibility (even
 529                         // for visibility info in cstore). Use containing
 530                         // trait instead, so methods of pub traits are
 531                         // themselves considered pub.
 532                         def_id = trait_def_id;
 533                     }
 534                     _ => {}
 535                 }
 536             }
 537             _ => {}
 538         }
 539
 540         let visibility = self.visibility(def_id);
 541
 542         match visibility {
 543             // must check stability for pub items.
 544             ty::Visibility::Public => false,
 545
 546             // these are not visible outside crate; therefore
 547             // stability markers are irrelevant, if even present.
 548             ty::Visibility::Restricted(..) |
 549             ty::Visibility::Invisible => true,
 550         }
 551     }
 552
 553     /// Evaluates the stability of an item.
 554     ///
 555     /// Returns `EvalResult::Allow` if the item is stable, or unstable but the corresponding
 556     /// `#![feature]` has been provided. Returns `EvalResult::Deny` which describes the offending
 557     /// unstable feature otherwise.
 558     ///
 559     /// If `id` is `Some(_)`, this function will also check if the item at `def_id` has been
 560     /// deprecated. If the item is indeed deprecated, we will emit a deprecation lint attached to
 561     /// `id`.
 562     pub fn eval_stability(self, def_id: DefId, id: Option<NodeId>, span: Span) -> EvalResult {
 563         if span.allows_unstable() {
 564             debug!("stability: \
 565                     skipping span={:?} since it is internal", span);
 566             return EvalResult::Allow;
 567         }
 568
 569         let lint_deprecated = |def_id: DefId, id: NodeId, note: Option<Symbol>| {
 570             let path = self.item_path_str(def_id);
 571
 572             let msg = if let Some(note) = note {
 573                 format!("use of deprecated item '{}': {}", path, note)
 574             } else {
 575                 format!("use of deprecated item '{}'", path)
 576             };
 577
 578             self.lint_node(lint::builtin::DEPRECATED, id, span, &msg);
 579             if id == ast::DUMMY_NODE_ID {
 580                 span_bug!(span, "emitted a deprecated lint with dummy node id: {:?}", def_id);
 581             }
 582         };
 583
 584         // Deprecated attributes apply in-crate and cross-crate.
 585         if let Some(id) = id {
 586             if let Some(depr_entry) = self.lookup_deprecation_entry(def_id) {
 587                 // If the deprecation is scheduled for a future Rust
 588                 // version, then we should display no warning message.
 589                 let deprecated_in_future_version = if let Some(sym) = depr_entry.attr.since {
 590                     let since = sym.as_str();
 591                     !deprecation_in_effect(&since)
 592                 } else {
 593                     false
 594                 };
 595
 596                 let parent_def_id = self.hir.local_def_id(self.hir.get_parent(id));
 597                 let skip = deprecated_in_future_version ||
 598                            self.lookup_deprecation_entry(parent_def_id)
 599                                .map_or(false, |parent_depr| parent_depr.same_origin(&depr_entry));
 600                 if !skip {
 601                     lint_deprecated(def_id, id, depr_entry.attr.note);
 602                 }
 603             };
 604         }
 605
 606         let is_staged_api = self.lookup_stability(DefId {
 607             index: CRATE_DEF_INDEX,
 608             ..def_id
 609         }).is_some();
 610         if !is_staged_api {
 611             return EvalResult::Allow;
 612         }
 613
 614         let stability = self.lookup_stability(def_id);
 615         debug!("stability: \
 616                 inspecting def_id={:?} span={:?} of stability={:?}", def_id, span, stability);
 617
 618         if let Some(&Stability{rustc_depr: Some(attr::RustcDeprecation { reason, since }), ..})
 619                 = stability {
 620             if let Some(id) = id {
 621                 if deprecation_in_effect(&since.as_str()) {
 622                     lint_deprecated(def_id, id, Some(reason));
 623                 }
 624             }
 625         }
 626
 627         // Only the cross-crate scenario matters when checking unstable APIs
 628         let cross_crate = !def_id.is_local();
 629         if !cross_crate {
 630             return EvalResult::Allow;
 631         }
 632
 633         // Issue 38412: private items lack stability markers.
 634         if self.skip_stability_check_due_to_privacy(def_id) {
 635             return EvalResult::Allow;
 636         }
 637
 638         match stability {
 639             Some(&Stability { level: attr::Unstable { reason, issue }, feature, .. }) => {
 640                 if self.stability().active_features.contains(&feature) {
 641                     return EvalResult::Allow;
 642                 }
 643
 644                 // When we're compiling the compiler itself we may pull in
 645                 // crates from crates.io, but those crates may depend on other
 646                 // crates also pulled in from crates.io. We want to ideally be
 647                 // able to compile everything without requiring upstream
 648                 // modifications, so in the case that this looks like a
 649                 // rustc_private crate (e.g. a compiler crate) and we also have
 650                 // the `-Z force-unstable-if-unmarked` flag present (we're
 651                 // compiling a compiler crate), then let this missing feature
 652                 // annotation slide.
 653                 if feature == "rustc_private" && issue == 27812 {
 654                     if self.sess.opts.debugging_opts.force_unstable_if_unmarked {
 655                         return EvalResult::Allow;
 656                     }
 657                 }
 658
 659                 EvalResult::Deny { feature, reason, issue }
 660             }
 661             Some(_) => {
 662                 // Stable APIs are always ok to call and deprecated APIs are
 663                 // handled by the lint emitting logic above.
 664                 EvalResult::Allow
 665             }
 666             None => {
 667                 EvalResult::Unmarked
 668             }
 669         }
 670     }
 671
 672     /// Checks if an item is stable or error out.
 673     ///
 674     /// If the item defined by `def_id` is unstable and the corresponding `#![feature]` does not
 675     /// exist, emits an error.
 676     ///
 677     /// Additionally, this function will also check if the item is deprecated. If so, and `id` is
 678     /// not `None`, a deprecated lint attached to `id` will be emitted.
 679     pub fn check_stability(self, def_id: DefId, id: Option<NodeId>, span: Span) {
 680         match self.eval_stability(def_id, id, span) {
 681             EvalResult::Allow => {}
 682             EvalResult::Deny { feature, reason, issue } => {
 683                 let msg = match reason {
 684                     Some(r) => format!("use of unstable library feature '{}': {}", feature, r),
 685                     None => format!("use of unstable library feature '{}'", &feature)
 686                 };
 687
 688                 let msp: MultiSpan = span.into();
 689                 let cm = &self.sess.parse_sess.source_map();
 690                 let span_key = msp.primary_span().and_then(|sp: Span|
 691                     if !sp.is_dummy() {
 692                         let file = cm.lookup_char_pos(sp.lo()).file;
 693                         if file.name.is_macros() {
 694                             None
 695                         } else {
 696                             Some(span)
 697                         }
 698                     } else {
 699                         None
 700                     }
 701                 );
 702
 703                 let error_id = (DiagnosticMessageId::StabilityId(issue), span_key, msg.clone());
 704                 let fresh = self.sess.one_time_diagnostics.borrow_mut().insert(error_id);
 705                 if fresh {
 706                     emit_feature_err(&self.sess.parse_sess, &feature.as_str(), span,
 707                                      GateIssue::Library(Some(issue)), &msg);
 708                 }
 709             }
 710             EvalResult::Unmarked => {
 711                 span_bug!(span, "encountered unmarked API: {:?}", def_id);
 712             }
 713         }
 714     }
 715 }
 716
 717 impl<'a, 'tcx> Visitor<'tcx> for Checker<'a, 'tcx> {
 718     /// Because stability levels are scoped lexically, we want to walk
 719     /// nested items in the context of the outer item, so enable
 720     /// deep-walking.
 721     fn nested_visit_map<'this>(&'this mut self) -> NestedVisitorMap<'this, 'tcx> {
 722         NestedVisitorMap::OnlyBodies(&self.tcx.hir)
 723     }
 724
 725     fn visit_item(&mut self, item: &'tcx hir::Item) {
 726         match item.node {
 727             hir::ItemKind::ExternCrate(_) => {
 728                 // compiler-generated `extern crate` items have a dummy span.
 729                 if item.span.is_dummy() { return }
 730
 731                 let def_id = self.tcx.hir.local_def_id(item.id);
 732                 let cnum = match self.tcx.extern_mod_stmt_cnum(def_id) {
 733                     Some(cnum) => cnum,
 734                     None => return,
 735                 };
 736                 let def_id = DefId { krate: cnum, index: CRATE_DEF_INDEX };
 737                 self.tcx.check_stability(def_id, Some(item.id), item.span);
 738             }
 739
 740             // For implementations of traits, check the stability of each item
 741             // individually as it's possible to have a stable trait with unstable
 742             // items.
 743             hir::ItemKind::Impl(.., Some(ref t), _, ref impl_item_refs) => {
 744                 if let Def::Trait(trait_did) = t.path.def {
 745                     for impl_item_ref in impl_item_refs {
 746                         let impl_item = self.tcx.hir.impl_item(impl_item_ref.id);
 747                         let trait_item_def_id = self.tcx.associated_items(trait_did)
 748                             .find(|item| item.ident.name == impl_item.ident.name)
 749                             .map(|item| item.def_id);
 750                         if let Some(def_id) = trait_item_def_id {
 751                             // Pass `None` to skip deprecation warnings.
 752                             self.tcx.check_stability(def_id, None, impl_item.span);
 753                         }
 754                     }
 755                 }
 756             }
 757
 758             // There's no good place to insert stability check for non-Copy unions,
 759             // so semi-randomly perform it here in stability.rs
 760             hir::ItemKind::Union(..) if !self.tcx.features().untagged_unions => {
 761                 let def_id = self.tcx.hir.local_def_id(item.id);
 762                 let adt_def = self.tcx.adt_def(def_id);
 763                 let ty = self.tcx.type_of(def_id);
 764
 765                 if adt_def.has_dtor(self.tcx) {
 766                     emit_feature_err(&self.tcx.sess.parse_sess,
 767                                      "untagged_unions", item.span, GateIssue::Language,
 768                                      "unions with `Drop` implementations are unstable");
 769                 } else {
 770                     let param_env = self.tcx.param_env(def_id);
 771                     if !param_env.can_type_implement_copy(self.tcx, ty).is_ok() {
 772                         emit_feature_err(&self.tcx.sess.parse_sess,
 773                                         "untagged_unions", item.span, GateIssue::Language,
 774                                         "unions with non-`Copy` fields are unstable");
 775                     }
 776                 }
 777             }
 778
 779             _ => (/* pass */)
 780         }
 781         intravisit::walk_item(self, item);
 782     }
 783
 784     fn visit_path(&mut self, path: &'tcx hir::Path, id: hir::HirId) {
 785         let id = self.tcx.hir.hir_to_node_id(id);
 786         match path.def {
 787             Def::Local(..) | Def::Upvar(..) | Def::SelfCtor(..) |
 788             Def::PrimTy(..) | Def::SelfTy(..) | Def::Err => {}
 789             _ => self.tcx.check_stability(path.def.def_id(), Some(id), path.span)
 790         }
 791         intravisit::walk_path(self, path)
 792     }
 793 }
 794
 795 impl<'a, 'gcx, 'tcx> TyCtxt<'a, 'gcx, 'tcx> {
 796     pub fn lookup_deprecation(self, id: DefId) -> Option<Deprecation> {
 797         self.lookup_deprecation_entry(id).map(|depr| depr.attr)
 798     }
 799 }
 800
 801 /// Given the list of enabled features that were not language features (i.e. that
 802 /// were expected to be library features), and the list of features used from
 803 /// libraries, identify activated features that don't exist and error about them.
 804 pub fn check_unused_or_stable_features<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>) {
 805     let access_levels = &tcx.privacy_access_levels(LOCAL_CRATE);
 806
 807     if tcx.stability().staged_api[&LOCAL_CRATE] {
 808         let krate = tcx.hir.krate();
 809         let mut missing = MissingStabilityAnnotations {
 810             tcx,
 811             access_levels,
 812         };
 813         missing.check_missing_stability(ast::CRATE_NODE_ID, krate.span);
 814         intravisit::walk_crate(&mut missing, krate);
 815         krate.visit_all_item_likes(&mut missing.as_deep_visitor());
 816     }
 817
 818     let declared_lang_features = &tcx.features().declared_lang_features;
 819     let mut lang_features = FxHashSet();
 820     for &(feature, span, since) in declared_lang_features {
 821         if let Some(since) = since {
 822             // Warn if the user has enabled an already-stable lang feature.
 823             unnecessary_stable_feature_lint(tcx, span, feature, since);
 824         }
 825         if lang_features.contains(&feature) {
 826             // Warn if the user enables a lang feature multiple times.
 827             duplicate_feature_err(tcx.sess, span, feature);
 828         }
 829         lang_features.insert(feature);
 830     }
 831
 832     let declared_lib_features = &tcx.features().declared_lib_features;
 833     let mut remaining_lib_features = FxHashMap();
 834     for (feature, span) in declared_lib_features {
 835         if remaining_lib_features.contains_key(&feature) {
 836             // Warn if the user enables a lib feature multiple times.
 837             duplicate_feature_err(tcx.sess, *span, *feature);
 838         }
 839         remaining_lib_features.insert(feature, span.clone());
 840     }
 841     // `stdbuild` has special handling for `libc`, so we need to
 842     // recognise the feature when building std.
 843     // Likewise, libtest is handled specially, so `test` isn't
 844     // available as we'd like it to be.
 845     // FIXME: only remove `libc` when `stdbuild` is active.
 846     // FIXME: remove special casing for `test`.
 847     remaining_lib_features.remove(&Symbol::intern("libc"));
 848     remaining_lib_features.remove(&Symbol::intern("test"));
 849
 850     let check_features =
 851         |remaining_lib_features: &mut FxHashMap<_, _>, defined_features: &Vec<_>| {
 852             for &(feature, since) in defined_features {
 853                 if let Some(since) = since {
 854                     if let Some(span) = remaining_lib_features.get(&feature) {
 855                         // Warn if the user has enabled an already-stable lib feature.
 856                         unnecessary_stable_feature_lint(tcx, *span, feature, since);
 857                     }
 858                 }
 859                 remaining_lib_features.remove(&feature);
 860                 if remaining_lib_features.is_empty() {
 861                     break;
 862                 }
 863             }
 864         };
 865
 866     // We always collect the lib features declared in the current crate, even if there are
 867     // no unknown features, because the collection also does feature attribute validation.
 868     let local_defined_features = tcx.lib_features().to_vec();
 869     if !remaining_lib_features.is_empty() {
 870         check_features(&mut remaining_lib_features, &local_defined_features);
 871
 872         for &cnum in &*tcx.crates() {
 873             if remaining_lib_features.is_empty() {
 874                 break;
 875             }
 876             check_features(&mut remaining_lib_features, &tcx.defined_lib_features(cnum));
 877         }
 878     }
 879
 880     for (feature, span) in remaining_lib_features {
 881         struct_span_err!(tcx.sess, span, E0635, "unknown feature `{}`", feature).emit();
 882     }
 883
 884     // FIXME(#44232): the `used_features` table no longer exists, so we
 885     // don't lint about unused features. We should reenable this one day!
 886 }
 887
 888 fn unnecessary_stable_feature_lint<'a, 'tcx>(
 889     tcx: TyCtxt<'a, 'tcx, 'tcx>,
 890     span: Span,
 891     feature: Symbol,
 892     since: Symbol
 893 ) {
 894     tcx.lint_node(lint::builtin::STABLE_FEATURES,
 895         ast::CRATE_NODE_ID,
 896         span,
 897         &format!("the feature `{}` has been stable since {} and no longer requires \
 898                   an attribute to enable", feature, since));
 899 }
 900
 901 fn duplicate_feature_err(sess: &Session, span: Span, feature: Symbol) {
 902     struct_span_err!(sess, span, E0636, "the feature `{}` has already been declared", feature)
 903         .emit();
 904 }