1 #![doc(html_root_url = "https://doc.rust-lang.org/nightly/")]
3 #![deny(rust_2018_idioms)]
7 #![feature(rustc_diagnostic_macros)]
9 #![recursion_limit="256"]
11 #[macro_use] extern crate syntax;
14 use rustc::hir::{self, Node, PatKind, AssociatedItemKind};
15 use rustc::hir::def::{Res, DefKind};
16 use rustc::hir::def_id::{CRATE_DEF_INDEX, LOCAL_CRATE, CrateNum, DefId};
17 use rustc::hir::intravisit::{self, Visitor, NestedVisitorMap};
18 use rustc::hir::itemlikevisit::DeepVisitor;
20 use rustc::middle::privacy::{AccessLevel, AccessLevels};
21 use rustc::ty::{self, TyCtxt, Ty, TraitRef, TypeFoldable, GenericParamDefKind};
22 use rustc::ty::fold::TypeVisitor;
23 use rustc::ty::query::Providers;
24 use rustc::ty::subst::InternalSubsts;
25 use rustc::util::nodemap::HirIdSet;
26 use rustc_data_structures::fx::FxHashSet;
27 use syntax::ast::Ident;
29 use syntax::symbol::{kw, sym};
32 use std::{cmp, fmt, mem};
33 use std::marker::PhantomData;
37 ////////////////////////////////////////////////////////////////////////////////
38 /// Generic infrastructure used to implement specific visitors below.
39 ////////////////////////////////////////////////////////////////////////////////
41 /// Implemented to visit all `DefId`s in a type.
42 /// Visiting `DefId`s is useful because visibilities and reachabilities are attached to them.
43 /// The idea is to visit "all components of a type", as documented in
44 /// https://github.com/rust-lang/rfcs/blob/master/text/2145-type-privacy.md#how-to-determine-visibility-of-a-type.
45 /// The default type visitor (`TypeVisitor`) does most of the job, but it has some shortcomings.
46 /// First, it doesn't have overridable `fn visit_trait_ref`, so we have to catch trait `DefId`s
47 /// manually. Second, it doesn't visit some type components like signatures of fn types, or traits
48 /// in `impl Trait`, see individual comments in `DefIdVisitorSkeleton::visit_ty`.
49 trait DefIdVisitor<'a, 'tcx: 'a> {
50 fn tcx(&self) -> TyCtxt<'a, 'tcx, 'tcx>;
51 fn shallow(&self) -> bool { false }
52 fn skip_assoc_tys(&self) -> bool { false }
53 fn visit_def_id(&mut self, def_id: DefId, kind: &str, descr: &dyn fmt::Display) -> bool;
55 /// Not overridden, but used to actually visit types and traits.
56 fn skeleton(&mut self) -> DefIdVisitorSkeleton<'_, 'a, 'tcx, Self> {
57 DefIdVisitorSkeleton {
59 visited_opaque_tys: Default::default(),
60 dummy: Default::default(),
63 fn visit(&mut self, ty_fragment: impl TypeFoldable<'tcx>) -> bool {
64 ty_fragment.visit_with(&mut self.skeleton())
66 fn visit_trait(&mut self, trait_ref: TraitRef<'tcx>) -> bool {
67 self.skeleton().visit_trait(trait_ref)
69 fn visit_predicates(&mut self, predicates: &ty::GenericPredicates<'tcx>) -> bool {
70 self.skeleton().visit_predicates(predicates)
74 struct DefIdVisitorSkeleton<'v, 'a, 'tcx, V>
75 where V: DefIdVisitor<'a, 'tcx> + ?Sized
77 def_id_visitor: &'v mut V,
78 visited_opaque_tys: FxHashSet<DefId>,
79 dummy: PhantomData<TyCtxt<'a, 'tcx, 'tcx>>,
82 impl<'a, 'tcx, V> DefIdVisitorSkeleton<'_, 'a, 'tcx, V>
83 where V: DefIdVisitor<'a, 'tcx> + ?Sized
85 fn visit_trait(&mut self, trait_ref: TraitRef<'tcx>) -> bool {
86 let TraitRef { def_id, substs } = trait_ref;
87 self.def_id_visitor.visit_def_id(def_id, "trait", &trait_ref) ||
88 (!self.def_id_visitor.shallow() && substs.visit_with(self))
91 fn visit_predicates(&mut self, predicates: &ty::GenericPredicates<'tcx>) -> bool {
92 let ty::GenericPredicates { parent: _, predicates } = predicates;
93 for (predicate, _span) in predicates {
95 ty::Predicate::Trait(poly_predicate) => {
96 let ty::TraitPredicate { trait_ref } = *poly_predicate.skip_binder();
97 if self.visit_trait(trait_ref) {
101 ty::Predicate::Projection(poly_predicate) => {
102 let ty::ProjectionPredicate { projection_ty, ty } =
103 *poly_predicate.skip_binder();
104 if ty.visit_with(self) {
107 if self.visit_trait(projection_ty.trait_ref(self.def_id_visitor.tcx())) {
111 ty::Predicate::TypeOutlives(poly_predicate) => {
112 let ty::OutlivesPredicate(ty, _region) = *poly_predicate.skip_binder();
113 if ty.visit_with(self) {
117 ty::Predicate::RegionOutlives(..) => {},
118 _ => bug!("unexpected predicate: {:?}", predicate),
125 impl<'a, 'tcx, V> TypeVisitor<'tcx> for DefIdVisitorSkeleton<'_, 'a, 'tcx, V>
126 where V: DefIdVisitor<'a, 'tcx> + ?Sized
128 fn visit_ty(&mut self, ty: Ty<'tcx>) -> bool {
129 let tcx = self.def_id_visitor.tcx();
130 // InternalSubsts are not visited here because they are visited below in `super_visit_with`.
132 ty::Adt(&ty::AdtDef { did: def_id, .. }, ..) |
133 ty::Foreign(def_id) |
134 ty::FnDef(def_id, ..) |
135 ty::Closure(def_id, ..) |
136 ty::Generator(def_id, ..) => {
137 if self.def_id_visitor.visit_def_id(def_id, "type", &ty) {
140 if self.def_id_visitor.shallow() {
143 // Default type visitor doesn't visit signatures of fn types.
144 // Something like `fn() -> Priv {my_func}` is considered a private type even if
145 // `my_func` is public, so we need to visit signatures.
146 if let ty::FnDef(..) = ty.sty {
147 if tcx.fn_sig(def_id).visit_with(self) {
151 // Inherent static methods don't have self type in substs.
152 // Something like `fn() {my_method}` type of the method
153 // `impl Pub<Priv> { pub fn my_method() {} }` is considered a private type,
154 // so we need to visit the self type additionally.
155 if let Some(assoc_item) = tcx.opt_associated_item(def_id) {
156 if let ty::ImplContainer(impl_def_id) = assoc_item.container {
157 if tcx.type_of(impl_def_id).visit_with(self) {
163 ty::Projection(proj) | ty::UnnormalizedProjection(proj) => {
164 if self.def_id_visitor.skip_assoc_tys() {
165 // Visitors searching for minimal visibility/reachability want to
166 // conservatively approximate associated types like `<Type as Trait>::Alias`
167 // as visible/reachable even if both `Type` and `Trait` are private.
168 // Ideally, associated types should be substituted in the same way as
169 // free type aliases, but this isn't done yet.
172 // This will also visit substs if necessary, so we don't need to recurse.
173 return self.visit_trait(proj.trait_ref(tcx));
175 ty::Dynamic(predicates, ..) => {
176 // All traits in the list are considered the "primary" part of the type
177 // and are visited by shallow visitors.
178 for predicate in *predicates.skip_binder() {
179 let trait_ref = match *predicate {
180 ty::ExistentialPredicate::Trait(trait_ref) => trait_ref,
181 ty::ExistentialPredicate::Projection(proj) => proj.trait_ref(tcx),
182 ty::ExistentialPredicate::AutoTrait(def_id) =>
183 ty::ExistentialTraitRef { def_id, substs: InternalSubsts::empty() },
185 let ty::ExistentialTraitRef { def_id, substs: _ } = trait_ref;
186 if self.def_id_visitor.visit_def_id(def_id, "trait", &trait_ref) {
191 ty::Opaque(def_id, ..) => {
192 // Skip repeated `Opaque`s to avoid infinite recursion.
193 if self.visited_opaque_tys.insert(def_id) {
194 // The intent is to treat `impl Trait1 + Trait2` identically to
195 // `dyn Trait1 + Trait2`. Therefore we ignore def-id of the opaque type itself
196 // (it either has no visibility, or its visibility is insignificant, like
197 // visibilities of type aliases) and recurse into predicates instead to go
198 // through the trait list (default type visitor doesn't visit those traits).
199 // All traits in the list are considered the "primary" part of the type
200 // and are visited by shallow visitors.
201 if self.visit_predicates(tcx.predicates_of(def_id)) {
206 // These types don't have their own def-ids (but may have subcomponents
207 // with def-ids that should be visited recursively).
208 ty::Bool | ty::Char | ty::Int(..) | ty::Uint(..) |
209 ty::Float(..) | ty::Str | ty::Never |
210 ty::Array(..) | ty::Slice(..) | ty::Tuple(..) |
211 ty::RawPtr(..) | ty::Ref(..) | ty::FnPtr(..) |
212 ty::Param(..) | ty::Error | ty::GeneratorWitness(..) => {}
213 ty::Bound(..) | ty::Placeholder(..) | ty::Infer(..) =>
214 bug!("unexpected type: {:?}", ty),
217 !self.def_id_visitor.shallow() && ty.super_visit_with(self)
221 fn def_id_visibility<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>, def_id: DefId)
222 -> (ty::Visibility, Span, &'static str) {
223 match tcx.hir().as_local_hir_id(def_id) {
225 let vis = match tcx.hir().get_by_hir_id(hir_id) {
226 Node::Item(item) => &item.vis,
227 Node::ForeignItem(foreign_item) => &foreign_item.vis,
228 Node::TraitItem(..) | Node::Variant(..) => {
229 return def_id_visibility(tcx, tcx.hir().get_parent_did_by_hir_id(hir_id));
231 Node::ImplItem(impl_item) => {
232 match tcx.hir().get_by_hir_id(tcx.hir().get_parent_item(hir_id)) {
233 Node::Item(item) => match &item.node {
234 hir::ItemKind::Impl(.., None, _, _) => &impl_item.vis,
235 hir::ItemKind::Impl(.., Some(trait_ref), _, _)
236 => return def_id_visibility(tcx, trait_ref.path.res.def_id()),
237 kind => bug!("unexpected item kind: {:?}", kind),
239 node => bug!("unexpected node kind: {:?}", node),
242 Node::Ctor(vdata) => {
243 let parent_hir_id = tcx.hir().get_parent_node_by_hir_id(hir_id);
244 match tcx.hir().get_by_hir_id(parent_hir_id) {
245 Node::Variant(..) => {
246 let parent_did = tcx.hir().local_def_id_from_hir_id(parent_hir_id);
247 let (mut ctor_vis, mut span, mut descr) = def_id_visibility(
251 let adt_def = tcx.adt_def(tcx.hir().get_parent_did_by_hir_id(hir_id));
252 let ctor_did = tcx.hir().local_def_id_from_hir_id(
253 vdata.ctor_hir_id().unwrap());
254 let variant = adt_def.variant_with_ctor_id(ctor_did);
256 if variant.is_field_list_non_exhaustive() &&
257 ctor_vis == ty::Visibility::Public
259 ctor_vis = ty::Visibility::Restricted(
260 DefId::local(CRATE_DEF_INDEX));
261 let attrs = tcx.get_attrs(variant.def_id);
262 span = attr::find_by_name(&attrs, sym::non_exhaustive)
264 descr = "crate-visible";
267 return (ctor_vis, span, descr);
270 let item = match tcx.hir().get_by_hir_id(parent_hir_id) {
271 Node::Item(item) => item,
272 node => bug!("unexpected node kind: {:?}", node),
274 let (mut ctor_vis, mut span, mut descr) =
275 (ty::Visibility::from_hir(&item.vis, parent_hir_id, tcx),
276 item.vis.span, item.vis.node.descr());
277 for field in vdata.fields() {
278 let field_vis = ty::Visibility::from_hir(&field.vis, hir_id, tcx);
279 if ctor_vis.is_at_least(field_vis, tcx) {
280 ctor_vis = field_vis;
281 span = field.vis.span;
282 descr = field.vis.node.descr();
286 // If the structure is marked as non_exhaustive then lower the
287 // visibility to within the crate.
288 if ctor_vis == ty::Visibility::Public {
290 tcx.adt_def(tcx.hir().get_parent_did_by_hir_id(hir_id));
291 if adt_def.non_enum_variant().is_field_list_non_exhaustive() {
293 ty::Visibility::Restricted(DefId::local(CRATE_DEF_INDEX));
294 span = attr::find_by_name(&item.attrs, sym::non_exhaustive)
296 descr = "crate-visible";
300 return (ctor_vis, span, descr);
302 node => bug!("unexpected node kind: {:?}", node),
305 Node::Expr(expr) => {
306 return (ty::Visibility::Restricted(
307 tcx.hir().get_module_parent_by_hir_id(expr.hir_id)),
308 expr.span, "private")
310 node => bug!("unexpected node kind: {:?}", node)
312 (ty::Visibility::from_hir(vis, hir_id, tcx), vis.span, vis.node.descr())
315 let vis = tcx.visibility(def_id);
316 let descr = if vis == ty::Visibility::Public { "public" } else { "private" };
317 (vis, tcx.def_span(def_id), descr)
322 // Set the correct `TypeckTables` for the given `item_id` (or an empty table if
323 // there is no `TypeckTables` for the item).
324 fn item_tables<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>,
326 empty_tables: &'a ty::TypeckTables<'tcx>)
327 -> &'a ty::TypeckTables<'tcx> {
328 let def_id = tcx.hir().local_def_id_from_hir_id(hir_id);
329 if tcx.has_typeck_tables(def_id) { tcx.typeck_tables_of(def_id) } else { empty_tables }
332 fn min<'a, 'tcx>(vis1: ty::Visibility, vis2: ty::Visibility, tcx: TyCtxt<'a, 'tcx, 'tcx>)
334 if vis1.is_at_least(vis2, tcx) { vis2 } else { vis1 }
337 ////////////////////////////////////////////////////////////////////////////////
338 /// Visitor used to determine if pub(restricted) is used anywhere in the crate.
340 /// This is done so that `private_in_public` warnings can be turned into hard errors
341 /// in crates that have been updated to use pub(restricted).
342 ////////////////////////////////////////////////////////////////////////////////
343 struct PubRestrictedVisitor<'a, 'tcx: 'a> {
344 tcx: TyCtxt<'a, 'tcx, 'tcx>,
345 has_pub_restricted: bool,
348 impl<'a, 'tcx> Visitor<'tcx> for PubRestrictedVisitor<'a, 'tcx> {
349 fn nested_visit_map<'this>(&'this mut self) -> NestedVisitorMap<'this, 'tcx> {
350 NestedVisitorMap::All(&self.tcx.hir())
352 fn visit_vis(&mut self, vis: &'tcx hir::Visibility) {
353 self.has_pub_restricted = self.has_pub_restricted || vis.node.is_pub_restricted();
357 ////////////////////////////////////////////////////////////////////////////////
358 /// Visitor used to determine impl visibility and reachability.
359 ////////////////////////////////////////////////////////////////////////////////
361 struct FindMin<'a, 'tcx, VL: VisibilityLike> {
362 tcx: TyCtxt<'a, 'tcx, 'tcx>,
363 access_levels: &'a AccessLevels,
367 impl<'a, 'tcx, VL: VisibilityLike> DefIdVisitor<'a, 'tcx> for FindMin<'a, 'tcx, VL> {
368 fn tcx(&self) -> TyCtxt<'a, 'tcx, 'tcx> { self.tcx }
369 fn shallow(&self) -> bool { VL::SHALLOW }
370 fn skip_assoc_tys(&self) -> bool { true }
371 fn visit_def_id(&mut self, def_id: DefId, _kind: &str, _descr: &dyn fmt::Display) -> bool {
372 self.min = VL::new_min(self, def_id);
377 trait VisibilityLike: Sized {
379 const SHALLOW: bool = false;
380 fn new_min<'a, 'tcx>(find: &FindMin<'a, 'tcx, Self>, def_id: DefId) -> Self;
382 // Returns an over-approximation (`skip_assoc_tys` = true) of visibility due to
383 // associated types for which we can't determine visibility precisely.
384 fn of_impl<'a, 'tcx>(hir_id: hir::HirId, tcx: TyCtxt<'a, 'tcx, 'tcx>,
385 access_levels: &'a AccessLevels) -> Self {
386 let mut find = FindMin { tcx, access_levels, min: Self::MAX };
387 let def_id = tcx.hir().local_def_id_from_hir_id(hir_id);
388 find.visit(tcx.type_of(def_id));
389 if let Some(trait_ref) = tcx.impl_trait_ref(def_id) {
390 find.visit_trait(trait_ref);
395 impl VisibilityLike for ty::Visibility {
396 const MAX: Self = ty::Visibility::Public;
397 fn new_min<'a, 'tcx>(find: &FindMin<'a, 'tcx, Self>, def_id: DefId) -> Self {
398 min(def_id_visibility(find.tcx, def_id).0, find.min, find.tcx)
401 impl VisibilityLike for Option<AccessLevel> {
402 const MAX: Self = Some(AccessLevel::Public);
403 // Type inference is very smart sometimes.
404 // It can make an impl reachable even some components of its type or trait are unreachable.
405 // E.g. methods of `impl ReachableTrait<UnreachableTy> for ReachableTy<UnreachableTy> { ... }`
406 // can be usable from other crates (#57264). So we skip substs when calculating reachability
407 // and consider an impl reachable if its "shallow" type and trait are reachable.
409 // The assumption we make here is that type-inference won't let you use an impl without knowing
410 // both "shallow" version of its self type and "shallow" version of its trait if it exists
411 // (which require reaching the `DefId`s in them).
412 const SHALLOW: bool = true;
413 fn new_min<'a, 'tcx>(find: &FindMin<'a, 'tcx, Self>, def_id: DefId) -> Self {
414 cmp::min(if let Some(hir_id) = find.tcx.hir().as_local_hir_id(def_id) {
415 find.access_levels.map.get(&hir_id).cloned()
422 ////////////////////////////////////////////////////////////////////////////////
423 /// The embargo visitor, used to determine the exports of the AST.
424 ////////////////////////////////////////////////////////////////////////////////
426 struct EmbargoVisitor<'a, 'tcx: 'a> {
427 tcx: TyCtxt<'a, 'tcx, 'tcx>,
429 // Accessibility levels for reachable nodes.
430 access_levels: AccessLevels,
431 // Previous accessibility level; `None` means unreachable.
432 prev_level: Option<AccessLevel>,
433 // Has something changed in the level map?
437 struct ReachEverythingInTheInterfaceVisitor<'b, 'a: 'b, 'tcx: 'a> {
438 access_level: Option<AccessLevel>,
440 ev: &'b mut EmbargoVisitor<'a, 'tcx>,
443 impl<'a, 'tcx> EmbargoVisitor<'a, 'tcx> {
444 fn get(&self, id: hir::HirId) -> Option<AccessLevel> {
445 self.access_levels.map.get(&id).cloned()
448 // Updates node level and returns the updated level.
449 fn update(&mut self, id: hir::HirId, level: Option<AccessLevel>) -> Option<AccessLevel> {
450 let old_level = self.get(id);
451 // Accessibility levels can only grow.
452 if level > old_level {
453 self.access_levels.map.insert(id, level.unwrap());
461 fn reach(&mut self, item_id: hir::HirId, access_level: Option<AccessLevel>)
462 -> ReachEverythingInTheInterfaceVisitor<'_, 'a, 'tcx> {
463 ReachEverythingInTheInterfaceVisitor {
464 access_level: cmp::min(access_level, Some(AccessLevel::Reachable)),
465 item_def_id: self.tcx.hir().local_def_id_from_hir_id(item_id),
471 /// Given the path segments of a `ItemKind::Use`, then we need
472 /// to update the visibility of the intermediate use so that it isn't linted
473 /// by `unreachable_pub`.
475 /// This isn't trivial as `path.res` has the `DefId` of the eventual target
476 /// of the use statement not of the next intermediate use statement.
478 /// To do this, consider the last two segments of the path to our intermediate
479 /// use statement. We expect the penultimate segment to be a module and the
480 /// last segment to be the name of the item we are exporting. We can then
481 /// look at the items contained in the module for the use statement with that
482 /// name and update that item's visibility.
484 /// FIXME: This solution won't work with glob imports and doesn't respect
485 /// namespaces. See <https://github.com/rust-lang/rust/pull/57922#discussion_r251234202>.
486 fn update_visibility_of_intermediate_use_statements(&mut self, segments: &[hir::PathSegment]) {
487 if let Some([module, segment]) = segments.rchunks_exact(2).next() {
488 if let Some(item) = module.res
489 .and_then(|res| res.mod_def_id())
490 .and_then(|def_id| self.tcx.hir().as_local_hir_id(def_id))
491 .map(|module_hir_id| self.tcx.hir().expect_item_by_hir_id(module_hir_id))
493 if let hir::ItemKind::Mod(m) = &item.node {
494 for item_id in m.item_ids.as_ref() {
495 let item = self.tcx.hir().expect_item_by_hir_id(item_id.id);
496 let def_id = self.tcx.hir().local_def_id_from_hir_id(item_id.id);
497 if !self.tcx.hygienic_eq(segment.ident, item.ident, def_id) { continue; }
498 if let hir::ItemKind::Use(..) = item.node {
499 self.update(item.hir_id, Some(AccessLevel::Exported));
508 impl<'a, 'tcx> Visitor<'tcx> for EmbargoVisitor<'a, 'tcx> {
509 /// We want to visit items in the context of their containing
510 /// module and so forth, so supply a crate for doing a deep walk.
511 fn nested_visit_map<'this>(&'this mut self) -> NestedVisitorMap<'this, 'tcx> {
512 NestedVisitorMap::All(&self.tcx.hir())
515 fn visit_item(&mut self, item: &'tcx hir::Item) {
516 let inherited_item_level = match item.node {
517 hir::ItemKind::Impl(..) =>
518 Option::<AccessLevel>::of_impl(item.hir_id, self.tcx, &self.access_levels),
519 // Foreign modules inherit level from parents.
520 hir::ItemKind::ForeignMod(..) => self.prev_level,
521 // Other `pub` items inherit levels from parents.
522 hir::ItemKind::Const(..) | hir::ItemKind::Enum(..) | hir::ItemKind::ExternCrate(..) |
523 hir::ItemKind::GlobalAsm(..) | hir::ItemKind::Fn(..) | hir::ItemKind::Mod(..) |
524 hir::ItemKind::Static(..) | hir::ItemKind::Struct(..) |
525 hir::ItemKind::Trait(..) | hir::ItemKind::TraitAlias(..) |
526 hir::ItemKind::Existential(..) |
527 hir::ItemKind::Ty(..) | hir::ItemKind::Union(..) | hir::ItemKind::Use(..) => {
528 if item.vis.node.is_pub() { self.prev_level } else { None }
532 // Update level of the item itself.
533 let item_level = self.update(item.hir_id, inherited_item_level);
535 // Update levels of nested things.
537 hir::ItemKind::Enum(ref def, _) => {
538 for variant in &def.variants {
539 let variant_level = self.update(variant.node.id, item_level);
540 if let Some(ctor_hir_id) = variant.node.data.ctor_hir_id() {
541 self.update(ctor_hir_id, item_level);
543 for field in variant.node.data.fields() {
544 self.update(field.hir_id, variant_level);
548 hir::ItemKind::Impl(.., ref trait_ref, _, ref impl_item_refs) => {
549 for impl_item_ref in impl_item_refs {
550 if trait_ref.is_some() || impl_item_ref.vis.node.is_pub() {
551 self.update(impl_item_ref.id.hir_id, item_level);
555 hir::ItemKind::Trait(.., ref trait_item_refs) => {
556 for trait_item_ref in trait_item_refs {
557 self.update(trait_item_ref.id.hir_id, item_level);
560 hir::ItemKind::Struct(ref def, _) | hir::ItemKind::Union(ref def, _) => {
561 if let Some(ctor_hir_id) = def.ctor_hir_id() {
562 self.update(ctor_hir_id, item_level);
564 for field in def.fields() {
565 if field.vis.node.is_pub() {
566 self.update(field.hir_id, item_level);
570 hir::ItemKind::ForeignMod(ref foreign_mod) => {
571 for foreign_item in &foreign_mod.items {
572 if foreign_item.vis.node.is_pub() {
573 self.update(foreign_item.hir_id, item_level);
577 hir::ItemKind::Existential(..) |
578 hir::ItemKind::Use(..) |
579 hir::ItemKind::Static(..) |
580 hir::ItemKind::Const(..) |
581 hir::ItemKind::GlobalAsm(..) |
582 hir::ItemKind::Ty(..) |
583 hir::ItemKind::Mod(..) |
584 hir::ItemKind::TraitAlias(..) |
585 hir::ItemKind::Fn(..) |
586 hir::ItemKind::ExternCrate(..) => {}
589 // Mark all items in interfaces of reachable items as reachable.
591 // The interface is empty.
592 hir::ItemKind::ExternCrate(..) => {}
593 // All nested items are checked by `visit_item`.
594 hir::ItemKind::Mod(..) => {}
595 // Re-exports are handled in `visit_mod`. However, in order to avoid looping over
596 // all of the items of a mod in `visit_mod` looking for use statements, we handle
597 // making sure that intermediate use statements have their visibilities updated here.
598 hir::ItemKind::Use(ref path, _) => {
599 if item_level.is_some() {
600 self.update_visibility_of_intermediate_use_statements(path.segments.as_ref());
603 // The interface is empty.
604 hir::ItemKind::GlobalAsm(..) => {}
605 hir::ItemKind::Existential(..) => {
606 // FIXME: This is some serious pessimization intended to workaround deficiencies
607 // in the reachability pass (`middle/reachable.rs`). Types are marked as link-time
608 // reachable if they are returned via `impl Trait`, even from private functions.
609 let exist_level = cmp::max(item_level, Some(AccessLevel::ReachableFromImplTrait));
610 self.reach(item.hir_id, exist_level).generics().predicates().ty();
613 hir::ItemKind::Const(..) | hir::ItemKind::Static(..) |
614 hir::ItemKind::Fn(..) | hir::ItemKind::Ty(..) => {
615 if item_level.is_some() {
616 self.reach(item.hir_id, item_level).generics().predicates().ty();
619 hir::ItemKind::Trait(.., ref trait_item_refs) => {
620 if item_level.is_some() {
621 self.reach(item.hir_id, item_level).generics().predicates();
623 for trait_item_ref in trait_item_refs {
624 let mut reach = self.reach(trait_item_ref.id.hir_id, item_level);
625 reach.generics().predicates();
627 if trait_item_ref.kind == AssociatedItemKind::Type &&
628 !trait_item_ref.defaultness.has_value() {
636 hir::ItemKind::TraitAlias(..) => {
637 if item_level.is_some() {
638 self.reach(item.hir_id, item_level).generics().predicates();
641 // Visit everything except for private impl items.
642 hir::ItemKind::Impl(.., ref impl_item_refs) => {
643 if item_level.is_some() {
644 self.reach(item.hir_id, item_level).generics().predicates().ty().trait_ref();
646 for impl_item_ref in impl_item_refs {
647 let impl_item_level = self.get(impl_item_ref.id.hir_id);
648 if impl_item_level.is_some() {
649 self.reach(impl_item_ref.id.hir_id, impl_item_level)
650 .generics().predicates().ty();
656 // Visit everything, but enum variants have their own levels.
657 hir::ItemKind::Enum(ref def, _) => {
658 if item_level.is_some() {
659 self.reach(item.hir_id, item_level).generics().predicates();
661 for variant in &def.variants {
662 let variant_level = self.get(variant.node.id);
663 if variant_level.is_some() {
664 for field in variant.node.data.fields() {
665 self.reach(field.hir_id, variant_level).ty();
667 // Corner case: if the variant is reachable, but its
668 // enum is not, make the enum reachable as well.
669 self.update(item.hir_id, variant_level);
673 // Visit everything, but foreign items have their own levels.
674 hir::ItemKind::ForeignMod(ref foreign_mod) => {
675 for foreign_item in &foreign_mod.items {
676 let foreign_item_level = self.get(foreign_item.hir_id);
677 if foreign_item_level.is_some() {
678 self.reach(foreign_item.hir_id, foreign_item_level)
679 .generics().predicates().ty();
683 // Visit everything except for private fields.
684 hir::ItemKind::Struct(ref struct_def, _) |
685 hir::ItemKind::Union(ref struct_def, _) => {
686 if item_level.is_some() {
687 self.reach(item.hir_id, item_level).generics().predicates();
688 for field in struct_def.fields() {
689 let field_level = self.get(field.hir_id);
690 if field_level.is_some() {
691 self.reach(field.hir_id, field_level).ty();
698 let orig_level = mem::replace(&mut self.prev_level, item_level);
699 intravisit::walk_item(self, item);
700 self.prev_level = orig_level;
703 fn visit_block(&mut self, b: &'tcx hir::Block) {
704 // Blocks can have public items, for example impls, but they always
705 // start as completely private regardless of publicity of a function,
706 // constant, type, field, etc., in which this block resides.
707 let orig_level = mem::replace(&mut self.prev_level, None);
708 intravisit::walk_block(self, b);
709 self.prev_level = orig_level;
712 fn visit_mod(&mut self, m: &'tcx hir::Mod, _sp: Span, id: hir::HirId) {
713 // This code is here instead of in visit_item so that the
714 // crate module gets processed as well.
715 if self.prev_level.is_some() {
716 let def_id = self.tcx.hir().local_def_id_from_hir_id(id);
717 if let Some(exports) = self.tcx.module_exports(def_id) {
718 for export in exports.iter() {
719 if export.vis == ty::Visibility::Public {
720 if let Some(def_id) = export.res.opt_def_id() {
721 if let Some(hir_id) = self.tcx.hir().as_local_hir_id(def_id) {
722 self.update(hir_id, Some(AccessLevel::Exported));
730 intravisit::walk_mod(self, m, id);
733 fn visit_macro_def(&mut self, md: &'tcx hir::MacroDef) {
735 self.update(md.hir_id, Some(AccessLevel::Public));
739 let module_did = ty::DefIdTree::parent(
741 self.tcx.hir().local_def_id_from_hir_id(md.hir_id)
743 let mut module_id = self.tcx.hir().as_local_hir_id(module_did).unwrap();
744 let level = if md.vis.node.is_pub() { self.get(module_id) } else { None };
745 let level = self.update(md.hir_id, level);
751 let module = if module_id == hir::CRATE_HIR_ID {
752 &self.tcx.hir().krate().module
753 } else if let hir::ItemKind::Mod(ref module) =
754 self.tcx.hir().expect_item_by_hir_id(module_id).node {
759 for id in &module.item_ids {
760 self.update(id.id, level);
762 let def_id = self.tcx.hir().local_def_id_from_hir_id(module_id);
763 if let Some(exports) = self.tcx.module_exports(def_id) {
764 for export in exports.iter() {
765 if let Some(hir_id) = self.tcx.hir().as_local_hir_id(export.res.def_id()) {
766 self.update(hir_id, level);
771 if module_id == hir::CRATE_HIR_ID {
774 module_id = self.tcx.hir().get_parent_node_by_hir_id(module_id);
779 impl<'a, 'tcx> ReachEverythingInTheInterfaceVisitor<'_, 'a, 'tcx> {
780 fn generics(&mut self) -> &mut Self {
781 for param in &self.ev.tcx.generics_of(self.item_def_id).params {
783 GenericParamDefKind::Lifetime => {}
784 GenericParamDefKind::Type { has_default, .. } => {
786 self.visit(self.ev.tcx.type_of(param.def_id));
789 GenericParamDefKind::Const => {
790 self.visit(self.ev.tcx.type_of(param.def_id));
797 fn predicates(&mut self) -> &mut Self {
798 self.visit_predicates(self.ev.tcx.predicates_of(self.item_def_id));
802 fn ty(&mut self) -> &mut Self {
803 self.visit(self.ev.tcx.type_of(self.item_def_id));
807 fn trait_ref(&mut self) -> &mut Self {
808 if let Some(trait_ref) = self.ev.tcx.impl_trait_ref(self.item_def_id) {
809 self.visit_trait(trait_ref);
815 impl<'a, 'tcx> DefIdVisitor<'a, 'tcx> for ReachEverythingInTheInterfaceVisitor<'_, 'a, 'tcx> {
816 fn tcx(&self) -> TyCtxt<'a, 'tcx, 'tcx> { self.ev.tcx }
817 fn visit_def_id(&mut self, def_id: DefId, _kind: &str, _descr: &dyn fmt::Display) -> bool {
818 if let Some(hir_id) = self.ev.tcx.hir().as_local_hir_id(def_id) {
819 self.ev.update(hir_id, self.access_level);
825 //////////////////////////////////////////////////////////////////////////////////////
826 /// Name privacy visitor, checks privacy and reports violations.
827 /// Most of name privacy checks are performed during the main resolution phase,
828 /// or later in type checking when field accesses and associated items are resolved.
829 /// This pass performs remaining checks for fields in struct expressions and patterns.
830 //////////////////////////////////////////////////////////////////////////////////////
832 struct NamePrivacyVisitor<'a, 'tcx: 'a> {
833 tcx: TyCtxt<'a, 'tcx, 'tcx>,
834 tables: &'a ty::TypeckTables<'tcx>,
835 current_item: hir::HirId,
836 empty_tables: &'a ty::TypeckTables<'tcx>,
839 impl<'a, 'tcx> NamePrivacyVisitor<'a, 'tcx> {
840 // Checks that a field in a struct constructor (expression or pattern) is accessible.
841 fn check_field(&mut self,
842 use_ctxt: Span, // syntax context of the field name at the use site
843 span: Span, // span of the field pattern, e.g., `x: 0`
844 def: &'tcx ty::AdtDef, // definition of the struct or enum
845 field: &'tcx ty::FieldDef) { // definition of the field
846 let ident = Ident::new(kw::Invalid, use_ctxt);
847 let current_hir = self.current_item;
848 let def_id = self.tcx.adjust_ident(ident, def.did, current_hir).1;
849 if !def.is_enum() && !field.vis.is_accessible_from(def_id, self.tcx) {
850 struct_span_err!(self.tcx.sess, span, E0451, "field `{}` of {} `{}` is private",
851 field.ident, def.variant_descr(), self.tcx.def_path_str(def.did))
852 .span_label(span, format!("field `{}` is private", field.ident))
858 impl<'a, 'tcx> Visitor<'tcx> for NamePrivacyVisitor<'a, 'tcx> {
859 /// We want to visit items in the context of their containing
860 /// module and so forth, so supply a crate for doing a deep walk.
861 fn nested_visit_map<'this>(&'this mut self) -> NestedVisitorMap<'this, 'tcx> {
862 NestedVisitorMap::All(&self.tcx.hir())
865 fn visit_mod(&mut self, _m: &'tcx hir::Mod, _s: Span, _n: hir::HirId) {
866 // Don't visit nested modules, since we run a separate visitor walk
867 // for each module in `privacy_access_levels`
870 fn visit_nested_body(&mut self, body: hir::BodyId) {
871 let orig_tables = mem::replace(&mut self.tables, self.tcx.body_tables(body));
872 let body = self.tcx.hir().body(body);
873 self.visit_body(body);
874 self.tables = orig_tables;
877 fn visit_item(&mut self, item: &'tcx hir::Item) {
878 let orig_current_item = mem::replace(&mut self.current_item, item.hir_id);
880 mem::replace(&mut self.tables, item_tables(self.tcx, item.hir_id, self.empty_tables));
881 intravisit::walk_item(self, item);
882 self.current_item = orig_current_item;
883 self.tables = orig_tables;
886 fn visit_trait_item(&mut self, ti: &'tcx hir::TraitItem) {
888 mem::replace(&mut self.tables, item_tables(self.tcx, ti.hir_id, self.empty_tables));
889 intravisit::walk_trait_item(self, ti);
890 self.tables = orig_tables;
893 fn visit_impl_item(&mut self, ii: &'tcx hir::ImplItem) {
895 mem::replace(&mut self.tables, item_tables(self.tcx, ii.hir_id, self.empty_tables));
896 intravisit::walk_impl_item(self, ii);
897 self.tables = orig_tables;
900 fn visit_expr(&mut self, expr: &'tcx hir::Expr) {
902 hir::ExprKind::Struct(ref qpath, ref fields, ref base) => {
903 let res = self.tables.qpath_res(qpath, expr.hir_id);
904 let adt = self.tables.expr_ty(expr).ty_adt_def().unwrap();
905 let variant = adt.variant_of_res(res);
906 if let Some(ref base) = *base {
907 // If the expression uses FRU we need to make sure all the unmentioned fields
908 // are checked for privacy (RFC 736). Rather than computing the set of
909 // unmentioned fields, just check them all.
910 for (vf_index, variant_field) in variant.fields.iter().enumerate() {
911 let field = fields.iter().find(|f| {
912 self.tcx.field_index(f.hir_id, self.tables) == vf_index
914 let (use_ctxt, span) = match field {
915 Some(field) => (field.ident.span, field.span),
916 None => (base.span, base.span),
918 self.check_field(use_ctxt, span, adt, variant_field);
921 for field in fields {
922 let use_ctxt = field.ident.span;
923 let index = self.tcx.field_index(field.hir_id, self.tables);
924 self.check_field(use_ctxt, field.span, adt, &variant.fields[index]);
931 intravisit::walk_expr(self, expr);
934 fn visit_pat(&mut self, pat: &'tcx hir::Pat) {
936 PatKind::Struct(ref qpath, ref fields, _) => {
937 let res = self.tables.qpath_res(qpath, pat.hir_id);
938 let adt = self.tables.pat_ty(pat).ty_adt_def().unwrap();
939 let variant = adt.variant_of_res(res);
940 for field in fields {
941 let use_ctxt = field.node.ident.span;
942 let index = self.tcx.field_index(field.node.hir_id, self.tables);
943 self.check_field(use_ctxt, field.span, adt, &variant.fields[index]);
949 intravisit::walk_pat(self, pat);
952 fn visit_argument_source(&mut self, s: &'tcx hir::ArgSource) {
954 // Don't visit the pattern in `ArgSource::AsyncFn`, it contains a pattern which has
955 // a `NodeId` w/out a type, as it is only used for getting the name of the original
956 // pattern for diagnostics where only an `hir::Arg` is present.
957 hir::ArgSource::AsyncFn(..) => {},
958 _ => intravisit::walk_argument_source(self, s),
963 ////////////////////////////////////////////////////////////////////////////////////////////
964 /// Type privacy visitor, checks types for privacy and reports violations.
965 /// Both explicitly written types and inferred types of expressions and patters are checked.
966 /// Checks are performed on "semantic" types regardless of names and their hygiene.
967 ////////////////////////////////////////////////////////////////////////////////////////////
969 struct TypePrivacyVisitor<'a, 'tcx: 'a> {
970 tcx: TyCtxt<'a, 'tcx, 'tcx>,
971 tables: &'a ty::TypeckTables<'tcx>,
975 empty_tables: &'a ty::TypeckTables<'tcx>,
978 impl<'a, 'tcx> TypePrivacyVisitor<'a, 'tcx> {
979 fn item_is_accessible(&self, did: DefId) -> bool {
980 def_id_visibility(self.tcx, did).0.is_accessible_from(self.current_item, self.tcx)
983 // Take node-id of an expression or pattern and check its type for privacy.
984 fn check_expr_pat_type(&mut self, id: hir::HirId, span: Span) -> bool {
986 if self.visit(self.tables.node_type(id)) || self.visit(self.tables.node_substs(id)) {
989 if let Some(adjustments) = self.tables.adjustments().get(id) {
990 for adjustment in adjustments {
991 if self.visit(adjustment.target) {
999 fn check_def_id(&mut self, def_id: DefId, kind: &str, descr: &dyn fmt::Display) -> bool {
1000 let is_error = !self.item_is_accessible(def_id);
1002 self.tcx.sess.span_err(self.span, &format!("{} `{}` is private", kind, descr));
1008 impl<'a, 'tcx> Visitor<'tcx> for TypePrivacyVisitor<'a, 'tcx> {
1009 /// We want to visit items in the context of their containing
1010 /// module and so forth, so supply a crate for doing a deep walk.
1011 fn nested_visit_map<'this>(&'this mut self) -> NestedVisitorMap<'this, 'tcx> {
1012 NestedVisitorMap::All(&self.tcx.hir())
1015 fn visit_mod(&mut self, _m: &'tcx hir::Mod, _s: Span, _n: hir::HirId) {
1016 // Don't visit nested modules, since we run a separate visitor walk
1017 // for each module in `privacy_access_levels`
1020 fn visit_nested_body(&mut self, body: hir::BodyId) {
1021 let orig_tables = mem::replace(&mut self.tables, self.tcx.body_tables(body));
1022 let orig_in_body = mem::replace(&mut self.in_body, true);
1023 let body = self.tcx.hir().body(body);
1024 self.visit_body(body);
1025 self.tables = orig_tables;
1026 self.in_body = orig_in_body;
1029 fn visit_ty(&mut self, hir_ty: &'tcx hir::Ty) {
1030 self.span = hir_ty.span;
1033 if self.visit(self.tables.node_type(hir_ty.hir_id)) {
1037 // Types in signatures.
1038 // FIXME: This is very ineffective. Ideally each HIR type should be converted
1039 // into a semantic type only once and the result should be cached somehow.
1040 if self.visit(rustc_typeck::hir_ty_to_ty(self.tcx, hir_ty)) {
1045 intravisit::walk_ty(self, hir_ty);
1048 fn visit_trait_ref(&mut self, trait_ref: &'tcx hir::TraitRef) {
1049 self.span = trait_ref.path.span;
1051 // Avoid calling `hir_trait_to_predicates` in bodies, it will ICE.
1052 // The traits' privacy in bodies is already checked as a part of trait object types.
1053 let (principal, projections) =
1054 rustc_typeck::hir_trait_to_predicates(self.tcx, trait_ref);
1055 if self.visit_trait(*principal.skip_binder()) {
1058 for (poly_predicate, _) in projections {
1060 if self.visit(poly_predicate.skip_binder().ty) ||
1061 self.visit_trait(poly_predicate.skip_binder().projection_ty.trait_ref(tcx)) {
1067 intravisit::walk_trait_ref(self, trait_ref);
1070 // Check types of expressions
1071 fn visit_expr(&mut self, expr: &'tcx hir::Expr) {
1072 if self.check_expr_pat_type(expr.hir_id, expr.span) {
1073 // Do not check nested expressions if the error already happened.
1077 hir::ExprKind::Assign(.., ref rhs) | hir::ExprKind::Match(ref rhs, ..) => {
1078 // Do not report duplicate errors for `x = y` and `match x { ... }`.
1079 if self.check_expr_pat_type(rhs.hir_id, rhs.span) {
1083 hir::ExprKind::MethodCall(_, span, _) => {
1084 // Method calls have to be checked specially.
1086 if let Some(def_id) = self.tables.type_dependent_def_id(expr.hir_id) {
1087 if self.visit(self.tcx.type_of(def_id)) {
1091 self.tcx.sess.delay_span_bug(expr.span,
1092 "no type-dependent def for method call");
1098 intravisit::walk_expr(self, expr);
1101 // Prohibit access to associated items with insufficient nominal visibility.
1103 // Additionally, until better reachability analysis for macros 2.0 is available,
1104 // we prohibit access to private statics from other crates, this allows to give
1105 // more code internal visibility at link time. (Access to private functions
1106 // is already prohibited by type privacy for function types.)
1107 fn visit_qpath(&mut self, qpath: &'tcx hir::QPath, id: hir::HirId, span: Span) {
1108 let def = match self.tables.qpath_res(qpath, id) {
1109 Res::Def(kind, def_id) => Some((kind, def_id)),
1112 let def = def.filter(|(kind, _)| {
1115 | DefKind::AssociatedConst
1116 | DefKind::AssociatedTy
1117 | DefKind::AssociatedExistential
1118 | DefKind::Static => true,
1122 if let Some((kind, def_id)) = def {
1123 let is_local_static = if let DefKind::Static = kind {
1126 if !self.item_is_accessible(def_id) && !is_local_static {
1127 let name = match *qpath {
1128 hir::QPath::Resolved(_, ref path) => path.to_string(),
1129 hir::QPath::TypeRelative(_, ref segment) => segment.ident.to_string(),
1131 let msg = format!("{} `{}` is private", kind.descr(), name);
1132 self.tcx.sess.span_err(span, &msg);
1137 intravisit::walk_qpath(self, qpath, id, span);
1140 // Check types of patterns.
1141 fn visit_pat(&mut self, pattern: &'tcx hir::Pat) {
1142 if self.check_expr_pat_type(pattern.hir_id, pattern.span) {
1143 // Do not check nested patterns if the error already happened.
1147 intravisit::walk_pat(self, pattern);
1150 fn visit_argument_source(&mut self, s: &'tcx hir::ArgSource) {
1152 // Don't visit the pattern in `ArgSource::AsyncFn`, it contains a pattern which has
1153 // a `NodeId` w/out a type, as it is only used for getting the name of the original
1154 // pattern for diagnostics where only an `hir::Arg` is present.
1155 hir::ArgSource::AsyncFn(..) => {},
1156 _ => intravisit::walk_argument_source(self, s),
1160 fn visit_local(&mut self, local: &'tcx hir::Local) {
1161 if let Some(ref init) = local.init {
1162 if self.check_expr_pat_type(init.hir_id, init.span) {
1163 // Do not report duplicate errors for `let x = y`.
1168 intravisit::walk_local(self, local);
1171 // Check types in item interfaces.
1172 fn visit_item(&mut self, item: &'tcx hir::Item) {
1173 let orig_current_item = mem::replace(&mut self.current_item,
1174 self.tcx.hir().local_def_id_from_hir_id(item.hir_id));
1175 let orig_in_body = mem::replace(&mut self.in_body, false);
1177 mem::replace(&mut self.tables, item_tables(self.tcx, item.hir_id, self.empty_tables));
1178 intravisit::walk_item(self, item);
1179 self.tables = orig_tables;
1180 self.in_body = orig_in_body;
1181 self.current_item = orig_current_item;
1184 fn visit_trait_item(&mut self, ti: &'tcx hir::TraitItem) {
1186 mem::replace(&mut self.tables, item_tables(self.tcx, ti.hir_id, self.empty_tables));
1187 intravisit::walk_trait_item(self, ti);
1188 self.tables = orig_tables;
1191 fn visit_impl_item(&mut self, ii: &'tcx hir::ImplItem) {
1193 mem::replace(&mut self.tables, item_tables(self.tcx, ii.hir_id, self.empty_tables));
1194 intravisit::walk_impl_item(self, ii);
1195 self.tables = orig_tables;
1199 impl<'a, 'tcx> DefIdVisitor<'a, 'tcx> for TypePrivacyVisitor<'a, 'tcx> {
1200 fn tcx(&self) -> TyCtxt<'a, 'tcx, 'tcx> { self.tcx }
1201 fn visit_def_id(&mut self, def_id: DefId, kind: &str, descr: &dyn fmt::Display) -> bool {
1202 self.check_def_id(def_id, kind, descr)
1206 ///////////////////////////////////////////////////////////////////////////////
1207 /// Obsolete visitors for checking for private items in public interfaces.
1208 /// These visitors are supposed to be kept in frozen state and produce an
1209 /// "old error node set". For backward compatibility the new visitor reports
1210 /// warnings instead of hard errors when the erroneous node is not in this old set.
1211 ///////////////////////////////////////////////////////////////////////////////
1213 struct ObsoleteVisiblePrivateTypesVisitor<'a, 'tcx: 'a> {
1214 tcx: TyCtxt<'a, 'tcx, 'tcx>,
1215 access_levels: &'a AccessLevels,
1217 // Set of errors produced by this obsolete visitor.
1218 old_error_set: HirIdSet,
1221 struct ObsoleteCheckTypeForPrivatenessVisitor<'a, 'b: 'a, 'tcx: 'b> {
1222 inner: &'a ObsoleteVisiblePrivateTypesVisitor<'b, 'tcx>,
1223 /// Whether the type refers to private types.
1224 contains_private: bool,
1225 /// Whether we've recurred at all (i.e., if we're pointing at the
1226 /// first type on which `visit_ty` was called).
1227 at_outer_type: bool,
1228 /// Whether that first type is a public path.
1229 outer_type_is_public_path: bool,
1232 impl<'a, 'tcx> ObsoleteVisiblePrivateTypesVisitor<'a, 'tcx> {
1233 fn path_is_private_type(&self, path: &hir::Path) -> bool {
1234 let did = match path.res {
1235 Res::PrimTy(..) | Res::SelfTy(..) | Res::Err => return false,
1236 res => res.def_id(),
1239 // A path can only be private if:
1240 // it's in this crate...
1241 if let Some(hir_id) = self.tcx.hir().as_local_hir_id(did) {
1242 // .. and it corresponds to a private type in the AST (this returns
1243 // `None` for type parameters).
1244 match self.tcx.hir().find_by_hir_id(hir_id) {
1245 Some(Node::Item(ref item)) => !item.vis.node.is_pub(),
1246 Some(_) | None => false,
1253 fn trait_is_public(&self, trait_id: hir::HirId) -> bool {
1254 // FIXME: this would preferably be using `exported_items`, but all
1255 // traits are exported currently (see `EmbargoVisitor.exported_trait`).
1256 self.access_levels.is_public(trait_id)
1259 fn check_generic_bound(&mut self, bound: &hir::GenericBound) {
1260 if let hir::GenericBound::Trait(ref trait_ref, _) = *bound {
1261 if self.path_is_private_type(&trait_ref.trait_ref.path) {
1262 self.old_error_set.insert(trait_ref.trait_ref.hir_ref_id);
1267 fn item_is_public(&self, id: &hir::HirId, vis: &hir::Visibility) -> bool {
1268 self.access_levels.is_reachable(*id) || vis.node.is_pub()
1272 impl<'a, 'b, 'tcx, 'v> Visitor<'v> for ObsoleteCheckTypeForPrivatenessVisitor<'a, 'b, 'tcx> {
1273 fn nested_visit_map<'this>(&'this mut self) -> NestedVisitorMap<'this, 'v> {
1274 NestedVisitorMap::None
1277 fn visit_ty(&mut self, ty: &hir::Ty) {
1278 if let hir::TyKind::Path(hir::QPath::Resolved(_, ref path)) = ty.node {
1279 if self.inner.path_is_private_type(path) {
1280 self.contains_private = true;
1281 // Found what we're looking for, so let's stop working.
1285 if let hir::TyKind::Path(_) = ty.node {
1286 if self.at_outer_type {
1287 self.outer_type_is_public_path = true;
1290 self.at_outer_type = false;
1291 intravisit::walk_ty(self, ty)
1294 // Don't want to recurse into `[, .. expr]`.
1295 fn visit_expr(&mut self, _: &hir::Expr) {}
1298 impl<'a, 'tcx> Visitor<'tcx> for ObsoleteVisiblePrivateTypesVisitor<'a, 'tcx> {
1299 /// We want to visit items in the context of their containing
1300 /// module and so forth, so supply a crate for doing a deep walk.
1301 fn nested_visit_map<'this>(&'this mut self) -> NestedVisitorMap<'this, 'tcx> {
1302 NestedVisitorMap::All(&self.tcx.hir())
1305 fn visit_item(&mut self, item: &'tcx hir::Item) {
1307 // Contents of a private mod can be re-exported, so we need
1308 // to check internals.
1309 hir::ItemKind::Mod(_) => {}
1311 // An `extern {}` doesn't introduce a new privacy
1312 // namespace (the contents have their own privacies).
1313 hir::ItemKind::ForeignMod(_) => {}
1315 hir::ItemKind::Trait(.., ref bounds, _) => {
1316 if !self.trait_is_public(item.hir_id) {
1320 for bound in bounds.iter() {
1321 self.check_generic_bound(bound)
1325 // Impls need some special handling to try to offer useful
1326 // error messages without (too many) false positives
1327 // (i.e., we could just return here to not check them at
1328 // all, or some worse estimation of whether an impl is
1329 // publicly visible).
1330 hir::ItemKind::Impl(.., ref g, ref trait_ref, ref self_, ref impl_item_refs) => {
1331 // `impl [... for] Private` is never visible.
1332 let self_contains_private;
1333 // `impl [... for] Public<...>`, but not `impl [... for]
1334 // Vec<Public>` or `(Public,)`, etc.
1335 let self_is_public_path;
1337 // Check the properties of the `Self` type:
1339 let mut visitor = ObsoleteCheckTypeForPrivatenessVisitor {
1341 contains_private: false,
1342 at_outer_type: true,
1343 outer_type_is_public_path: false,
1345 visitor.visit_ty(&self_);
1346 self_contains_private = visitor.contains_private;
1347 self_is_public_path = visitor.outer_type_is_public_path;
1350 // Miscellaneous info about the impl:
1352 // `true` iff this is `impl Private for ...`.
1353 let not_private_trait =
1354 trait_ref.as_ref().map_or(true, // no trait counts as public trait
1356 let did = tr.path.res.def_id();
1358 if let Some(hir_id) = self.tcx.hir().as_local_hir_id(did) {
1359 self.trait_is_public(hir_id)
1361 true // external traits must be public
1365 // `true` iff this is a trait impl or at least one method is public.
1367 // `impl Public { $( fn ...() {} )* }` is not visible.
1369 // This is required over just using the methods' privacy
1370 // directly because we might have `impl<T: Foo<Private>> ...`,
1371 // and we shouldn't warn about the generics if all the methods
1372 // are private (because `T` won't be visible externally).
1373 let trait_or_some_public_method =
1374 trait_ref.is_some() ||
1375 impl_item_refs.iter()
1376 .any(|impl_item_ref| {
1377 let impl_item = self.tcx.hir().impl_item(impl_item_ref.id);
1378 match impl_item.node {
1379 hir::ImplItemKind::Const(..) |
1380 hir::ImplItemKind::Method(..) => {
1381 self.access_levels.is_reachable(
1382 impl_item_ref.id.hir_id)
1384 hir::ImplItemKind::Existential(..) |
1385 hir::ImplItemKind::Type(_) => false,
1389 if !self_contains_private &&
1390 not_private_trait &&
1391 trait_or_some_public_method {
1393 intravisit::walk_generics(self, g);
1397 for impl_item_ref in impl_item_refs {
1398 // This is where we choose whether to walk down
1399 // further into the impl to check its items. We
1400 // should only walk into public items so that we
1401 // don't erroneously report errors for private
1402 // types in private items.
1403 let impl_item = self.tcx.hir().impl_item(impl_item_ref.id);
1404 match impl_item.node {
1405 hir::ImplItemKind::Const(..) |
1406 hir::ImplItemKind::Method(..)
1407 if self.item_is_public(&impl_item.hir_id, &impl_item.vis) =>
1409 intravisit::walk_impl_item(self, impl_item)
1411 hir::ImplItemKind::Type(..) => {
1412 intravisit::walk_impl_item(self, impl_item)
1419 // Any private types in a trait impl fall into three
1421 // 1. mentioned in the trait definition
1422 // 2. mentioned in the type params/generics
1423 // 3. mentioned in the associated types of the impl
1425 // Those in 1. can only occur if the trait is in
1426 // this crate and will've been warned about on the
1427 // trait definition (there's no need to warn twice
1428 // so we don't check the methods).
1430 // Those in 2. are warned via walk_generics and this
1432 intravisit::walk_path(self, &tr.path);
1434 // Those in 3. are warned with this call.
1435 for impl_item_ref in impl_item_refs {
1436 let impl_item = self.tcx.hir().impl_item(impl_item_ref.id);
1437 if let hir::ImplItemKind::Type(ref ty) = impl_item.node {
1443 } else if trait_ref.is_none() && self_is_public_path {
1444 // `impl Public<Private> { ... }`. Any public static
1445 // methods will be visible as `Public::foo`.
1446 let mut found_pub_static = false;
1447 for impl_item_ref in impl_item_refs {
1448 if self.item_is_public(&impl_item_ref.id.hir_id, &impl_item_ref.vis) {
1449 let impl_item = self.tcx.hir().impl_item(impl_item_ref.id);
1450 match impl_item_ref.kind {
1451 AssociatedItemKind::Const => {
1452 found_pub_static = true;
1453 intravisit::walk_impl_item(self, impl_item);
1455 AssociatedItemKind::Method { has_self: false } => {
1456 found_pub_static = true;
1457 intravisit::walk_impl_item(self, impl_item);
1463 if found_pub_static {
1464 intravisit::walk_generics(self, g)
1470 // `type ... = ...;` can contain private types, because
1471 // we're introducing a new name.
1472 hir::ItemKind::Ty(..) => return,
1474 // Not at all public, so we don't care.
1475 _ if !self.item_is_public(&item.hir_id, &item.vis) => {
1482 // We've carefully constructed it so that if we're here, then
1483 // any `visit_ty`'s will be called on things that are in
1484 // public signatures, i.e., things that we're interested in for
1486 intravisit::walk_item(self, item);
1489 fn visit_generics(&mut self, generics: &'tcx hir::Generics) {
1490 for param in &generics.params {
1491 for bound in ¶m.bounds {
1492 self.check_generic_bound(bound);
1495 for predicate in &generics.where_clause.predicates {
1497 hir::WherePredicate::BoundPredicate(bound_pred) => {
1498 for bound in bound_pred.bounds.iter() {
1499 self.check_generic_bound(bound)
1502 hir::WherePredicate::RegionPredicate(_) => {}
1503 hir::WherePredicate::EqPredicate(eq_pred) => {
1504 self.visit_ty(&eq_pred.rhs_ty);
1510 fn visit_foreign_item(&mut self, item: &'tcx hir::ForeignItem) {
1511 if self.access_levels.is_reachable(item.hir_id) {
1512 intravisit::walk_foreign_item(self, item)
1516 fn visit_ty(&mut self, t: &'tcx hir::Ty) {
1517 if let hir::TyKind::Path(hir::QPath::Resolved(_, ref path)) = t.node {
1518 if self.path_is_private_type(path) {
1519 self.old_error_set.insert(t.hir_id);
1522 intravisit::walk_ty(self, t)
1525 fn visit_variant(&mut self,
1526 v: &'tcx hir::Variant,
1527 g: &'tcx hir::Generics,
1528 item_id: hir::HirId) {
1529 if self.access_levels.is_reachable(v.node.id) {
1530 self.in_variant = true;
1531 intravisit::walk_variant(self, v, g, item_id);
1532 self.in_variant = false;
1536 fn visit_struct_field(&mut self, s: &'tcx hir::StructField) {
1537 if s.vis.node.is_pub() || self.in_variant {
1538 intravisit::walk_struct_field(self, s);
1542 // We don't need to introspect into these at all: an
1543 // expression/block context can't possibly contain exported things.
1544 // (Making them no-ops stops us from traversing the whole AST without
1545 // having to be super careful about our `walk_...` calls above.)
1546 fn visit_block(&mut self, _: &'tcx hir::Block) {}
1547 fn visit_expr(&mut self, _: &'tcx hir::Expr) {}
1550 ///////////////////////////////////////////////////////////////////////////////
1551 /// SearchInterfaceForPrivateItemsVisitor traverses an item's interface and
1552 /// finds any private components in it.
1553 /// PrivateItemsInPublicInterfacesVisitor ensures there are no private types
1554 /// and traits in public interfaces.
1555 ///////////////////////////////////////////////////////////////////////////////
1557 struct SearchInterfaceForPrivateItemsVisitor<'a, 'tcx: 'a> {
1558 tcx: TyCtxt<'a, 'tcx, 'tcx>,
1559 item_id: hir::HirId,
1562 /// The visitor checks that each component type is at least this visible.
1563 required_visibility: ty::Visibility,
1564 has_pub_restricted: bool,
1565 has_old_errors: bool,
1569 impl<'a, 'tcx: 'a> SearchInterfaceForPrivateItemsVisitor<'a, 'tcx> {
1570 fn generics(&mut self) -> &mut Self {
1571 for param in &self.tcx.generics_of(self.item_def_id).params {
1573 GenericParamDefKind::Lifetime => {}
1574 GenericParamDefKind::Type { has_default, .. } => {
1576 self.visit(self.tcx.type_of(param.def_id));
1579 GenericParamDefKind::Const => {
1580 self.visit(self.tcx.type_of(param.def_id));
1587 fn predicates(&mut self) -> &mut Self {
1588 // N.B., we use `explicit_predicates_of` and not `predicates_of`
1589 // because we don't want to report privacy errors due to where
1590 // clauses that the compiler inferred. We only want to
1591 // consider the ones that the user wrote. This is important
1592 // for the inferred outlives rules; see
1593 // `src/test/ui/rfc-2093-infer-outlives/privacy.rs`.
1594 self.visit_predicates(self.tcx.explicit_predicates_of(self.item_def_id));
1598 fn ty(&mut self) -> &mut Self {
1599 self.visit(self.tcx.type_of(self.item_def_id));
1603 fn check_def_id(&mut self, def_id: DefId, kind: &str, descr: &dyn fmt::Display) -> bool {
1604 if self.leaks_private_dep(def_id) {
1605 self.tcx.lint_hir(lint::builtin::EXPORTED_PRIVATE_DEPENDENCIES,
1608 &format!("{} `{}` from private dependency '{}' in public \
1609 interface", kind, descr,
1610 self.tcx.crate_name(def_id.krate)));
1614 let hir_id = match self.tcx.hir().as_local_hir_id(def_id) {
1615 Some(hir_id) => hir_id,
1616 None => return false,
1619 let (vis, vis_span, vis_descr) = def_id_visibility(self.tcx, def_id);
1620 if !vis.is_at_least(self.required_visibility, self.tcx) {
1621 let msg = format!("{} {} `{}` in public interface", vis_descr, kind, descr);
1622 if self.has_pub_restricted || self.has_old_errors || self.in_assoc_ty {
1623 let mut err = if kind == "trait" {
1624 struct_span_err!(self.tcx.sess, self.span, E0445, "{}", msg)
1626 struct_span_err!(self.tcx.sess, self.span, E0446, "{}", msg)
1628 err.span_label(self.span, format!("can't leak {} {}", vis_descr, kind));
1629 err.span_label(vis_span, format!("`{}` declared as {}", descr, vis_descr));
1632 let err_code = if kind == "trait" { "E0445" } else { "E0446" };
1633 self.tcx.lint_hir(lint::builtin::PRIVATE_IN_PUBLIC, hir_id, self.span,
1634 &format!("{} (error {})", msg, err_code));
1642 /// An item is 'leaked' from a private dependency if all
1643 /// of the following are true:
1644 /// 1. It's contained within a public type
1645 /// 2. It comes from a private crate
1646 fn leaks_private_dep(&self, item_id: DefId) -> bool {
1647 let ret = self.required_visibility == ty::Visibility::Public &&
1648 self.tcx.is_private_dep(item_id.krate);
1650 log::debug!("leaks_private_dep(item_id={:?})={}", item_id, ret);
1655 impl<'a, 'tcx> DefIdVisitor<'a, 'tcx> for SearchInterfaceForPrivateItemsVisitor<'a, 'tcx> {
1656 fn tcx(&self) -> TyCtxt<'a, 'tcx, 'tcx> { self.tcx }
1657 fn visit_def_id(&mut self, def_id: DefId, kind: &str, descr: &dyn fmt::Display) -> bool {
1658 self.check_def_id(def_id, kind, descr)
1662 struct PrivateItemsInPublicInterfacesVisitor<'a, 'tcx: 'a> {
1663 tcx: TyCtxt<'a, 'tcx, 'tcx>,
1664 has_pub_restricted: bool,
1665 old_error_set: &'a HirIdSet,
1668 impl<'a, 'tcx> PrivateItemsInPublicInterfacesVisitor<'a, 'tcx> {
1669 fn check(&self, item_id: hir::HirId, required_visibility: ty::Visibility)
1670 -> SearchInterfaceForPrivateItemsVisitor<'a, 'tcx> {
1671 let mut has_old_errors = false;
1673 // Slow path taken only if there any errors in the crate.
1674 for &id in self.old_error_set {
1675 // Walk up the nodes until we find `item_id` (or we hit a root).
1679 has_old_errors = true;
1682 let parent = self.tcx.hir().get_parent_node_by_hir_id(id);
1694 SearchInterfaceForPrivateItemsVisitor {
1697 item_def_id: self.tcx.hir().local_def_id_from_hir_id(item_id),
1698 span: self.tcx.hir().span_by_hir_id(item_id),
1699 required_visibility,
1700 has_pub_restricted: self.has_pub_restricted,
1706 fn check_trait_or_impl_item(&self, hir_id: hir::HirId, assoc_item_kind: AssociatedItemKind,
1707 defaultness: hir::Defaultness, vis: ty::Visibility) {
1708 let mut check = self.check(hir_id, vis);
1710 let (check_ty, is_assoc_ty) = match assoc_item_kind {
1711 AssociatedItemKind::Const | AssociatedItemKind::Method { .. } => (true, false),
1712 AssociatedItemKind::Type => (defaultness.has_value(), true),
1713 // `ty()` for existential types is the underlying type,
1714 // it's not a part of interface, so we skip it.
1715 AssociatedItemKind::Existential => (false, true),
1717 check.in_assoc_ty = is_assoc_ty;
1718 check.generics().predicates();
1725 impl<'a, 'tcx> Visitor<'tcx> for PrivateItemsInPublicInterfacesVisitor<'a, 'tcx> {
1726 fn nested_visit_map<'this>(&'this mut self) -> NestedVisitorMap<'this, 'tcx> {
1727 NestedVisitorMap::OnlyBodies(&self.tcx.hir())
1730 fn visit_item(&mut self, item: &'tcx hir::Item) {
1732 let item_visibility = ty::Visibility::from_hir(&item.vis, item.hir_id, tcx);
1735 // Crates are always public.
1736 hir::ItemKind::ExternCrate(..) => {}
1737 // All nested items are checked by `visit_item`.
1738 hir::ItemKind::Mod(..) => {}
1739 // Checked in resolve.
1740 hir::ItemKind::Use(..) => {}
1742 hir::ItemKind::GlobalAsm(..) => {}
1743 // Subitems of these items have inherited publicity.
1744 hir::ItemKind::Const(..) | hir::ItemKind::Static(..) |
1745 hir::ItemKind::Fn(..) | hir::ItemKind::Ty(..) => {
1746 self.check(item.hir_id, item_visibility).generics().predicates().ty();
1748 hir::ItemKind::Existential(..) => {
1749 // `ty()` for existential types is the underlying type,
1750 // it's not a part of interface, so we skip it.
1751 self.check(item.hir_id, item_visibility).generics().predicates();
1753 hir::ItemKind::Trait(.., ref trait_item_refs) => {
1754 self.check(item.hir_id, item_visibility).generics().predicates();
1756 for trait_item_ref in trait_item_refs {
1757 self.check_trait_or_impl_item(trait_item_ref.id.hir_id, trait_item_ref.kind,
1758 trait_item_ref.defaultness, item_visibility);
1761 hir::ItemKind::TraitAlias(..) => {
1762 self.check(item.hir_id, item_visibility).generics().predicates();
1764 hir::ItemKind::Enum(ref def, _) => {
1765 self.check(item.hir_id, item_visibility).generics().predicates();
1767 for variant in &def.variants {
1768 for field in variant.node.data.fields() {
1769 self.check(field.hir_id, item_visibility).ty();
1773 // Subitems of foreign modules have their own publicity.
1774 hir::ItemKind::ForeignMod(ref foreign_mod) => {
1775 for foreign_item in &foreign_mod.items {
1776 let vis = ty::Visibility::from_hir(&foreign_item.vis, item.hir_id, tcx);
1777 self.check(foreign_item.hir_id, vis).generics().predicates().ty();
1780 // Subitems of structs and unions have their own publicity.
1781 hir::ItemKind::Struct(ref struct_def, _) |
1782 hir::ItemKind::Union(ref struct_def, _) => {
1783 self.check(item.hir_id, item_visibility).generics().predicates();
1785 for field in struct_def.fields() {
1786 let field_visibility = ty::Visibility::from_hir(&field.vis, item.hir_id, tcx);
1787 self.check(field.hir_id, min(item_visibility, field_visibility, tcx)).ty();
1790 // An inherent impl is public when its type is public
1791 // Subitems of inherent impls have their own publicity.
1792 // A trait impl is public when both its type and its trait are public
1793 // Subitems of trait impls have inherited publicity.
1794 hir::ItemKind::Impl(.., ref trait_ref, _, ref impl_item_refs) => {
1795 let impl_vis = ty::Visibility::of_impl(item.hir_id, tcx, &Default::default());
1796 self.check(item.hir_id, impl_vis).generics().predicates();
1797 for impl_item_ref in impl_item_refs {
1798 let impl_item = tcx.hir().impl_item(impl_item_ref.id);
1799 let impl_item_vis = if trait_ref.is_none() {
1800 min(ty::Visibility::from_hir(&impl_item.vis, item.hir_id, tcx),
1806 self.check_trait_or_impl_item(impl_item_ref.id.hir_id, impl_item_ref.kind,
1807 impl_item_ref.defaultness, impl_item_vis);
1814 pub fn provide(providers: &mut Providers<'_>) {
1815 *providers = Providers {
1816 privacy_access_levels,
1817 check_private_in_public,
1823 fn check_mod_privacy<'tcx>(tcx: TyCtxt<'_, 'tcx, 'tcx>, module_def_id: DefId) {
1824 let empty_tables = ty::TypeckTables::empty(None);
1826 // Check privacy of names not checked in previous compilation stages.
1827 let mut visitor = NamePrivacyVisitor {
1829 tables: &empty_tables,
1830 current_item: hir::DUMMY_HIR_ID,
1831 empty_tables: &empty_tables,
1833 let (module, span, hir_id) = tcx.hir().get_module(module_def_id);
1835 intravisit::walk_mod(&mut visitor, module, hir_id);
1837 // Check privacy of explicitly written types and traits as well as
1838 // inferred types of expressions and patterns.
1839 let mut visitor = TypePrivacyVisitor {
1841 tables: &empty_tables,
1842 current_item: module_def_id,
1845 empty_tables: &empty_tables,
1847 intravisit::walk_mod(&mut visitor, module, hir_id);
1850 fn privacy_access_levels<'tcx>(
1851 tcx: TyCtxt<'_, 'tcx, 'tcx>,
1853 ) -> &'tcx AccessLevels {
1854 assert_eq!(krate, LOCAL_CRATE);
1856 // Build up a set of all exported items in the AST. This is a set of all
1857 // items which are reachable from external crates based on visibility.
1858 let mut visitor = EmbargoVisitor {
1860 access_levels: Default::default(),
1861 prev_level: Some(AccessLevel::Public),
1865 intravisit::walk_crate(&mut visitor, tcx.hir().krate());
1866 if visitor.changed {
1867 visitor.changed = false;
1872 visitor.update(hir::CRATE_HIR_ID, Some(AccessLevel::Public));
1874 tcx.arena.alloc(visitor.access_levels)
1877 fn check_private_in_public<'tcx>(tcx: TyCtxt<'_, 'tcx, 'tcx>, krate: CrateNum) {
1878 assert_eq!(krate, LOCAL_CRATE);
1880 let access_levels = tcx.privacy_access_levels(LOCAL_CRATE);
1882 let krate = tcx.hir().krate();
1884 let mut visitor = ObsoleteVisiblePrivateTypesVisitor {
1886 access_levels: &access_levels,
1888 old_error_set: Default::default(),
1890 intravisit::walk_crate(&mut visitor, krate);
1892 let has_pub_restricted = {
1893 let mut pub_restricted_visitor = PubRestrictedVisitor {
1895 has_pub_restricted: false
1897 intravisit::walk_crate(&mut pub_restricted_visitor, krate);
1898 pub_restricted_visitor.has_pub_restricted
1901 // Check for private types and traits in public interfaces.
1902 let mut visitor = PrivateItemsInPublicInterfacesVisitor {
1905 old_error_set: &visitor.old_error_set,
1907 krate.visit_all_item_likes(&mut DeepVisitor::new(&mut visitor));
1910 __build_diagnostic_array! { librustc_privacy, DIAGNOSTICS }