1 // Copyright 2012-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.
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.
11 // Do not remove on snapshot creation. Needed for bootstrap. (Issue #22364)
12 #![cfg_attr(stage0, feature(custom_attribute))]
13 #![crate_name = "rustc_privacy"]
14 #![unstable(feature = "rustc_private", issue = "27812")]
16 #![crate_type = "dylib"]
17 #![crate_type = "rlib"]
18 #![doc(html_logo_url = "https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png",
19 html_favicon_url = "https://doc.rust-lang.org/favicon.ico",
20 html_root_url = "https://doc.rust-lang.org/nightly/")]
22 #![feature(rustc_diagnostic_macros)]
23 #![feature(rustc_private)]
24 #![feature(staged_api)]
26 #[macro_use] extern crate log;
27 #[macro_use] extern crate syntax;
30 extern crate rustc_front;
32 use self::PrivacyResult::*;
33 use self::FieldName::*;
35 use std::mem::replace;
38 use rustc_front::visit::{self, Visitor};
40 use rustc::middle::def;
41 use rustc::middle::def_id::DefId;
42 use rustc::middle::privacy::ImportUse::*;
43 use rustc::middle::privacy::LastPrivate::*;
44 use rustc::middle::privacy::PrivateDep::*;
45 use rustc::middle::privacy::{ExternalExports, ExportedItems, PublicItems};
46 use rustc::middle::ty::{self, Ty};
47 use rustc::util::nodemap::{NodeMap, NodeSet};
48 use rustc::front::map as ast_map;
51 use syntax::codemap::Span;
55 type Context<'a, 'tcx> = (&'a ty::MethodMap<'tcx>, &'a def::ExportMap);
57 /// Result of a checking operation - None => no errors were found. Some => an
58 /// error and contains the span and message for reporting that error and
59 /// optionally the same for a note about the error.
60 type CheckResult = Option<(Span, String, Option<(Span, String)>)>;
62 ////////////////////////////////////////////////////////////////////////////////
63 /// The parent visitor, used to determine what's the parent of what (node-wise)
64 ////////////////////////////////////////////////////////////////////////////////
66 struct ParentVisitor {
67 parents: NodeMap<ast::NodeId>,
68 curparent: ast::NodeId,
71 impl<'v> Visitor<'v> for ParentVisitor {
72 fn visit_item(&mut self, item: &hir::Item) {
73 self.parents.insert(item.id, self.curparent);
75 let prev = self.curparent;
77 hir::ItemMod(..) => { self.curparent = item.id; }
78 // Enum variants are parented to the enum definition itself because
79 // they inherit privacy
80 hir::ItemEnum(ref def, _) => {
81 for variant in &def.variants {
82 // The parent is considered the enclosing enum because the
83 // enum will dictate the privacy visibility of this variant
85 self.parents.insert(variant.node.id, item.id);
89 // Trait methods are always considered "public", but if the trait is
90 // private then we need some private item in the chain from the
91 // method to the root. In this case, if the trait is private, then
92 // parent all the methods to the trait to indicate that they're
94 hir::ItemTrait(_, _, _, ref trait_items) if item.vis != hir::Public => {
95 for trait_item in trait_items {
96 self.parents.insert(trait_item.id, item.id);
102 visit::walk_item(self, item);
103 self.curparent = prev;
106 fn visit_foreign_item(&mut self, a: &hir::ForeignItem) {
107 self.parents.insert(a.id, self.curparent);
108 visit::walk_foreign_item(self, a);
111 fn visit_fn(&mut self, a: visit::FnKind<'v>, b: &'v hir::FnDecl,
112 c: &'v hir::Block, d: Span, id: ast::NodeId) {
113 // We already took care of some trait methods above, otherwise things
114 // like impl methods and pub trait methods are parented to the
115 // containing module, not the containing trait.
116 if !self.parents.contains_key(&id) {
117 self.parents.insert(id, self.curparent);
119 visit::walk_fn(self, a, b, c, d);
122 fn visit_impl_item(&mut self, ii: &'v hir::ImplItem) {
123 // visit_fn handles methods, but associated consts have to be handled
125 if !self.parents.contains_key(&ii.id) {
126 self.parents.insert(ii.id, self.curparent);
128 visit::walk_impl_item(self, ii);
131 fn visit_struct_def(&mut self, s: &hir::StructDef, _: ast::Ident,
132 _: &'v hir::Generics, n: ast::NodeId) {
133 // Struct constructors are parented to their struct definitions because
134 // they essentially are the struct definitions.
136 Some(id) => { self.parents.insert(id, n); }
140 // While we have the id of the struct definition, go ahead and parent
142 for field in &s.fields {
143 self.parents.insert(field.node.id, self.curparent);
145 visit::walk_struct_def(self, s)
149 ////////////////////////////////////////////////////////////////////////////////
150 /// The embargo visitor, used to determine the exports of the ast
151 ////////////////////////////////////////////////////////////////////////////////
153 struct EmbargoVisitor<'a, 'tcx: 'a> {
154 tcx: &'a ty::ctxt<'tcx>,
155 export_map: &'a def::ExportMap,
157 // This flag is an indicator of whether the previous item in the
158 // hierarchical chain was exported or not. This is the indicator of whether
159 // children should be exported as well. Note that this can flip from false
160 // to true if a reexported module is entered (or an action similar).
163 // This is a list of all exported items in the AST. An exported item is any
164 // function/method/item which is usable by external crates. This essentially
165 // means that the result is "public all the way down", but the "path down"
166 // may jump across private boundaries through reexport statements.
167 exported_items: ExportedItems,
169 // This sets contains all the destination nodes which are publicly
170 // re-exported. This is *not* a set of all reexported nodes, only a set of
171 // all nodes which are reexported *and* reachable from external crates. This
172 // means that the destination of the reexport is exported, and hence the
173 // destination must also be exported.
176 // These two fields are closely related to one another in that they are only
177 // used for generation of the 'PublicItems' set, not for privacy checking at
179 public_items: PublicItems,
183 impl<'a, 'tcx> EmbargoVisitor<'a, 'tcx> {
184 // There are checks inside of privacy which depend on knowing whether a
185 // trait should be exported or not. The two current consumers of this are:
187 // 1. Should default methods of a trait be exported?
188 // 2. Should the methods of an implementation of a trait be exported?
190 // The answer to both of these questions partly rely on whether the trait
191 // itself is exported or not. If the trait is somehow exported, then the
192 // answers to both questions must be yes. Right now this question involves
193 // more analysis than is currently done in rustc, so we conservatively
194 // answer "yes" so that all traits need to be exported.
195 fn exported_trait(&self, _id: ast::NodeId) -> bool {
200 impl<'a, 'tcx, 'v> Visitor<'v> for EmbargoVisitor<'a, 'tcx> {
201 fn visit_item(&mut self, item: &hir::Item) {
202 let orig_all_pub = self.prev_public;
203 self.prev_public = orig_all_pub && item.vis == hir::Public;
204 if self.prev_public {
205 self.public_items.insert(item.id);
208 let orig_all_exported = self.prev_exported;
210 // impls/extern blocks do not break the "public chain" because they
211 // cannot have visibility qualifiers on them anyway
212 hir::ItemImpl(..) | hir::ItemDefaultImpl(..) | hir::ItemForeignMod(..) => {}
214 // Traits are a little special in that even if they themselves are
215 // not public they may still be exported.
216 hir::ItemTrait(..) => {
217 self.prev_exported = self.exported_trait(item.id);
220 // Private by default, hence we only retain the "public chain" if
221 // `pub` is explicitly listed.
224 (orig_all_exported && item.vis == hir::Public) ||
225 self.reexports.contains(&item.id);
229 let public_first = self.prev_exported &&
230 self.exported_items.insert(item.id);
233 // Enum variants inherit from their parent, so if the enum is
234 // public all variants are public unless they're explicitly priv
235 hir::ItemEnum(ref def, _) if public_first => {
236 for variant in &def.variants {
237 self.exported_items.insert(variant.node.id);
238 self.public_items.insert(variant.node.id);
242 // Implementations are a little tricky to determine what's exported
243 // out of them. Here's a few cases which are currently defined:
245 // * Impls for private types do not need to export their methods
246 // (either public or private methods)
248 // * Impls for public types only have public methods exported
250 // * Public trait impls for public types must have all methods
253 // * Private trait impls for public types can be ignored
255 // * Public trait impls for private types have their methods
256 // exported. I'm not entirely certain that this is the correct
257 // thing to do, but I have seen use cases of where this will cause
258 // undefined symbols at linkage time if this case is not handled.
260 // * Private trait impls for private types can be completely ignored
261 hir::ItemImpl(_, _, _, _, ref ty, ref impl_items) => {
262 let public_ty = match ty.node {
264 match self.tcx.def_map.borrow().get(&ty.id).unwrap().full_def() {
265 def::DefPrimTy(..) => true,
267 let did = def.def_id();
269 self.exported_items.contains(&did.node)
275 let tr = self.tcx.impl_trait_ref(DefId::local(item.id));
276 let public_trait = tr.clone().map_or(false, |tr| {
277 !tr.def_id.is_local() ||
278 self.exported_items.contains(&tr.def_id.node)
281 if public_ty || public_trait {
282 for impl_item in impl_items {
283 match impl_item.node {
284 hir::ConstImplItem(..) => {
285 if (public_ty && impl_item.vis == hir::Public)
287 self.exported_items.insert(impl_item.id);
290 hir::MethodImplItem(ref sig, _) => {
291 let meth_public = match sig.explicit_self.node {
292 hir::SelfStatic => public_ty,
294 } && impl_item.vis == hir::Public;
295 if meth_public || tr.is_some() {
296 self.exported_items.insert(impl_item.id);
299 hir::TypeImplItem(_) => {}
305 // Default methods on traits are all public so long as the trait
307 hir::ItemTrait(_, _, _, ref trait_items) if public_first => {
308 for trait_item in trait_items {
309 debug!("trait item {}", trait_item.id);
310 self.exported_items.insert(trait_item.id);
314 // Struct constructors are public if the struct is all public.
315 hir::ItemStruct(ref def, _) if public_first => {
317 Some(id) => { self.exported_items.insert(id); }
320 // fields can be public or private, so lets check
321 for field in &def.fields {
322 let vis = match field.node.kind {
323 hir::NamedField(_, vis) | hir::UnnamedField(vis) => vis
325 if vis == hir::Public {
326 self.public_items.insert(field.node.id);
331 hir::ItemTy(ref ty, _) if public_first => {
332 if let hir::TyPath(..) = ty.node {
333 match self.tcx.def_map.borrow().get(&ty.id).unwrap().full_def() {
334 def::DefPrimTy(..) | def::DefTyParam(..) => {},
336 let did = def.def_id();
338 self.exported_items.insert(did.node);
348 visit::walk_item(self, item);
350 self.prev_exported = orig_all_exported;
351 self.prev_public = orig_all_pub;
354 fn visit_foreign_item(&mut self, a: &hir::ForeignItem) {
355 if (self.prev_exported && a.vis == hir::Public) || self.reexports.contains(&a.id) {
356 self.exported_items.insert(a.id);
360 fn visit_mod(&mut self, m: &hir::Mod, _sp: Span, id: ast::NodeId) {
361 // This code is here instead of in visit_item so that the
362 // crate module gets processed as well.
363 if self.prev_exported {
364 assert!(self.export_map.contains_key(&id), "wut {}", id);
365 for export in self.export_map.get(&id).unwrap() {
366 if export.def_id.is_local() {
367 self.reexports.insert(export.def_id.node);
371 visit::walk_mod(self, m)
375 ////////////////////////////////////////////////////////////////////////////////
376 /// The privacy visitor, where privacy checks take place (violations reported)
377 ////////////////////////////////////////////////////////////////////////////////
379 struct PrivacyVisitor<'a, 'tcx: 'a> {
380 tcx: &'a ty::ctxt<'tcx>,
381 curitem: ast::NodeId,
383 parents: NodeMap<ast::NodeId>,
384 external_exports: ExternalExports,
390 DisallowedBy(ast::NodeId),
394 UnnamedField(usize), // index
395 // (Name, not Ident, because struct fields are not macro-hygienic)
396 NamedField(ast::Name),
399 impl<'a, 'tcx> PrivacyVisitor<'a, 'tcx> {
400 // used when debugging
401 fn nodestr(&self, id: ast::NodeId) -> String {
402 self.tcx.map.node_to_string(id).to_string()
405 // Determines whether the given definition is public from the point of view
406 // of the current item.
407 fn def_privacy(&self, did: DefId) -> PrivacyResult {
409 if self.external_exports.contains(&did) {
410 debug!("privacy - {:?} was externally exported", did);
413 debug!("privacy - is {:?} a public method", did);
415 return match self.tcx.impl_or_trait_items.borrow().get(&did) {
416 Some(&ty::ConstTraitItem(ref ac)) => {
417 debug!("privacy - it's a const: {:?}", *ac);
419 ty::TraitContainer(id) => {
420 debug!("privacy - recursing on trait {:?}", id);
423 ty::ImplContainer(id) => {
424 match self.tcx.impl_trait_ref(id) {
426 debug!("privacy - impl of trait {:?}", id);
427 self.def_privacy(t.def_id)
430 debug!("privacy - found inherent \
431 associated constant {:?}",
433 if ac.vis == hir::Public {
443 Some(&ty::MethodTraitItem(ref meth)) => {
444 debug!("privacy - well at least it's a method: {:?}",
446 match meth.container {
447 ty::TraitContainer(id) => {
448 debug!("privacy - recursing on trait {:?}", id);
451 ty::ImplContainer(id) => {
452 match self.tcx.impl_trait_ref(id) {
454 debug!("privacy - impl of trait {:?}", id);
455 self.def_privacy(t.def_id)
458 debug!("privacy - found a method {:?}",
460 if meth.vis == hir::Public {
470 Some(&ty::TypeTraitItem(ref typedef)) => {
471 match typedef.container {
472 ty::TraitContainer(id) => {
473 debug!("privacy - recursing on trait {:?}", id);
476 ty::ImplContainer(id) => {
477 match self.tcx.impl_trait_ref(id) {
479 debug!("privacy - impl of trait {:?}", id);
480 self.def_privacy(t.def_id)
483 debug!("privacy - found a typedef {:?}",
485 if typedef.vis == hir::Public {
496 debug!("privacy - nope, not even a method");
502 debug!("privacy - local {} not public all the way down",
503 self.tcx.map.node_to_string(did.node));
504 // return quickly for things in the same module
505 if self.parents.get(&did.node) == self.parents.get(&self.curitem) {
506 debug!("privacy - same parent, we're done here");
510 // We now know that there is at least one private member between the
511 // destination and the root.
512 let mut closest_private_id = did.node;
514 debug!("privacy - examining {}", self.nodestr(closest_private_id));
515 let vis = match self.tcx.map.find(closest_private_id) {
516 // If this item is a method, then we know for sure that it's an
517 // actual method and not a static method. The reason for this is
518 // that these cases are only hit in the ExprMethodCall
519 // expression, and ExprCall will have its path checked later
520 // (the path of the trait/impl) if it's a static method.
522 // With this information, then we can completely ignore all
523 // trait methods. The privacy violation would be if the trait
524 // couldn't get imported, not if the method couldn't be used
525 // (all trait methods are public).
527 // However, if this is an impl method, then we dictate this
528 // decision solely based on the privacy of the method
530 // FIXME(#10573) is this the right behavior? Why not consider
531 // where the method was defined?
532 Some(ast_map::NodeImplItem(ii)) => {
534 hir::ConstImplItem(..) |
535 hir::MethodImplItem(..) => {
536 let imp = self.tcx.map
537 .get_parent_did(closest_private_id);
538 match self.tcx.impl_trait_ref(imp) {
539 Some(..) => return Allowable,
540 _ if ii.vis == hir::Public => {
546 hir::TypeImplItem(_) => return Allowable,
549 Some(ast_map::NodeTraitItem(_)) => {
553 // This is not a method call, extract the visibility as one
554 // would normally look at it
555 Some(ast_map::NodeItem(it)) => it.vis,
556 Some(ast_map::NodeForeignItem(_)) => {
557 self.tcx.map.get_foreign_vis(closest_private_id)
559 Some(ast_map::NodeVariant(..)) => {
560 hir::Public // need to move up a level (to the enum)
564 if vis != hir::Public { break }
565 // if we've reached the root, then everything was allowable and this
567 if closest_private_id == ast::CRATE_NODE_ID { return Allowable }
568 closest_private_id = *self.parents.get(&closest_private_id).unwrap();
570 // If we reached the top, then we were public all the way down and
571 // we can allow this access.
572 if closest_private_id == ast::DUMMY_NODE_ID { return Allowable }
574 debug!("privacy - closest priv {}", self.nodestr(closest_private_id));
575 if self.private_accessible(closest_private_id) {
578 DisallowedBy(closest_private_id)
582 /// For a local private node in the AST, this function will determine
583 /// whether the node is accessible by the current module that iteration is
585 fn private_accessible(&self, id: ast::NodeId) -> bool {
586 let parent = *self.parents.get(&id).unwrap();
587 debug!("privacy - accessible parent {}", self.nodestr(parent));
589 // After finding `did`'s closest private member, we roll ourselves back
590 // to see if this private member's parent is anywhere in our ancestry.
591 // By the privacy rules, we can access all of our ancestor's private
592 // members, so that's why we test the parent, and not the did itself.
593 let mut cur = self.curitem;
595 debug!("privacy - questioning {}, {}", self.nodestr(cur), cur);
597 // If the relevant parent is in our history, then we're allowed
598 // to look inside any of our ancestor's immediate private items,
599 // so this access is valid.
600 x if x == parent => return true,
602 // If we've reached the root, then we couldn't access this item
603 // in the first place
604 ast::DUMMY_NODE_ID => return false,
610 cur = *self.parents.get(&cur).unwrap();
614 fn report_error(&self, result: CheckResult) -> bool {
617 Some((span, msg, note)) => {
618 self.tcx.sess.span_err(span, &msg[..]);
620 Some((span, msg)) => {
621 self.tcx.sess.span_note(span, &msg[..])
630 /// Guarantee that a particular definition is public. Returns a CheckResult
631 /// which contains any errors found. These can be reported using `report_error`.
632 /// If the result is `None`, no errors were found.
633 fn ensure_public(&self, span: Span, to_check: DefId,
634 source_did: Option<DefId>, msg: &str) -> CheckResult {
635 let id = match self.def_privacy(to_check) {
636 ExternallyDenied => {
637 return Some((span, format!("{} is private", msg), None))
639 Allowable => return None,
640 DisallowedBy(id) => id,
643 // If we're disallowed by a particular id, then we attempt to give a
644 // nice error message to say why it was disallowed. It was either
645 // because the item itself is private or because its parent is private
646 // and its parent isn't in our ancestry.
647 let (err_span, err_msg) = if id == source_did.unwrap_or(to_check).node {
648 return Some((span, format!("{} is private", msg), None));
650 (span, format!("{} is inaccessible", msg))
652 let item = match self.tcx.map.find(id) {
653 Some(ast_map::NodeItem(item)) => {
655 // If an impl disallowed this item, then this is resolve's
656 // way of saying that a struct/enum's static method was
657 // invoked, and the struct/enum itself is private. Crawl
658 // back up the chains to find the relevant struct/enum that
660 hir::ItemImpl(_, _, _, _, ref ty, _) => {
662 hir::TyPath(..) => {}
663 _ => return Some((err_span, err_msg, None)),
665 let def = self.tcx.def_map.borrow().get(&ty.id).unwrap().full_def();
666 let did = def.def_id();
667 assert!(did.is_local());
668 match self.tcx.map.get(did.node) {
669 ast_map::NodeItem(item) => item,
670 _ => self.tcx.sess.span_bug(item.span,
671 "path is not an item")
677 Some(..) | None => return Some((err_span, err_msg, None)),
679 let desc = match item.node {
680 hir::ItemMod(..) => "module",
681 hir::ItemTrait(..) => "trait",
682 hir::ItemStruct(..) => "struct",
683 hir::ItemEnum(..) => "enum",
684 _ => return Some((err_span, err_msg, None))
686 let msg = format!("{} `{}` is private", desc, item.ident);
687 Some((err_span, err_msg, Some((span, msg))))
690 // Checks that a field is in scope.
691 fn check_field(&mut self,
693 def: ty::AdtDef<'tcx>,
694 v: ty::VariantDef<'tcx>,
696 let field = match name {
697 NamedField(f_name) => {
698 debug!("privacy - check named field {} in struct {:?}", f_name, def);
699 v.field_named(f_name)
701 UnnamedField(idx) => &v.fields[idx]
703 if field.vis == hir::Public ||
704 (field.did.is_local() && self.private_accessible(field.did.node)) {
708 let struct_desc = match def.adt_kind() {
709 ty::AdtKind::Struct =>
710 format!("struct `{}`", self.tcx.item_path_str(def.did)),
711 // struct variant fields have inherited visibility
712 ty::AdtKind::Enum => return
714 let msg = match name {
715 NamedField(name) => format!("field `{}` of {} is private",
717 UnnamedField(idx) => format!("field #{} of {} is private",
718 idx + 1, struct_desc),
720 span_err!(self.tcx.sess, span, E0451,
724 // Given the ID of a method, checks to ensure it's in scope.
725 fn check_static_method(&mut self,
729 // If the method is a default method, we need to use the def_id of
730 // the default implementation.
731 let method_id = match self.tcx.impl_or_trait_item(method_id) {
732 ty::MethodTraitItem(method_type) => {
733 method_type.provided_source.unwrap_or(method_id)
738 "got non-method item in check_static_method")
742 self.report_error(self.ensure_public(span,
745 &format!("method `{}`",
749 // Checks that a path is in scope.
750 fn check_path(&mut self, span: Span, path_id: ast::NodeId, last: ast::Name) {
751 debug!("privacy - path {}", self.nodestr(path_id));
752 let path_res = *self.tcx.def_map.borrow().get(&path_id).unwrap();
753 let ck = |tyname: &str| {
754 let ck_public = |def: DefId| {
755 debug!("privacy - ck_public {:?}", def);
756 let origdid = path_res.def_id();
757 self.ensure_public(span,
760 &format!("{} `{}`", tyname, last))
763 match path_res.last_private {
764 LastMod(AllPublic) => {},
765 LastMod(DependsOn(def)) => {
766 self.report_error(ck_public(def));
768 LastImport { value_priv,
769 value_used: check_value,
771 type_used: check_type } => {
772 // This dance with found_error is because we don't want to
773 // report a privacy error twice for the same directive.
774 let found_error = match (type_priv, check_type) {
775 (Some(DependsOn(def)), Used) => {
776 !self.report_error(ck_public(def))
781 match (value_priv, check_value) {
782 (Some(DependsOn(def)), Used) => {
783 self.report_error(ck_public(def));
788 // If an import is not used in either namespace, we still
789 // want to check that it could be legal. Therefore we check
790 // in both namespaces and only report an error if both would
791 // be illegal. We only report one error, even if it is
792 // illegal to import from both namespaces.
793 match (value_priv, check_value, type_priv, check_type) {
794 (Some(p), Unused, None, _) |
795 (None, _, Some(p), Unused) => {
798 DependsOn(def) => ck_public(def),
801 self.report_error(p);
804 (Some(v), Unused, Some(t), Unused) => {
807 DependsOn(def) => ck_public(def),
811 DependsOn(def) => ck_public(def),
813 if let (Some(_), Some(t)) = (v, t) {
814 self.report_error(Some(t));
822 // FIXME(#12334) Imports can refer to definitions in both the type and
823 // value namespaces. The privacy information is aware of this, but the
824 // def map is not. Therefore the names we work out below will not always
825 // be accurate and we can get slightly wonky error messages (but type
826 // checking is always correct).
827 match path_res.full_def() {
828 def::DefFn(..) => ck("function"),
829 def::DefStatic(..) => ck("static"),
830 def::DefConst(..) => ck("const"),
831 def::DefAssociatedConst(..) => ck("associated const"),
832 def::DefVariant(..) => ck("variant"),
833 def::DefTy(_, false) => ck("type"),
834 def::DefTy(_, true) => ck("enum"),
835 def::DefTrait(..) => ck("trait"),
836 def::DefStruct(..) => ck("struct"),
837 def::DefMethod(..) => ck("method"),
838 def::DefMod(..) => ck("module"),
843 // Checks that a method is in scope.
844 fn check_method(&mut self, span: Span, method_def_id: DefId,
846 match self.tcx.impl_or_trait_item(method_def_id).container() {
847 ty::ImplContainer(_) => {
848 self.check_static_method(span, method_def_id, name)
850 // Trait methods are always all public. The only controlling factor
851 // is whether the trait itself is accessible or not.
852 ty::TraitContainer(trait_def_id) => {
853 self.report_error(self.ensure_public(span, trait_def_id,
854 None, "source trait"));
860 impl<'a, 'tcx, 'v> Visitor<'v> for PrivacyVisitor<'a, 'tcx> {
861 fn visit_item(&mut self, item: &hir::Item) {
862 if let hir::ItemUse(ref vpath) = item.node {
863 if let hir::ViewPathList(ref prefix, ref list) = vpath.node {
866 hir::PathListIdent { id, name, .. } => {
867 debug!("privacy - ident item {}", id);
868 self.check_path(pid.span, id, name.name);
870 hir::PathListMod { id, .. } => {
871 debug!("privacy - mod item {}", id);
872 let name = prefix.segments.last().unwrap().identifier.name;
873 self.check_path(pid.span, id, name);
879 let orig_curitem = replace(&mut self.curitem, item.id);
880 visit::walk_item(self, item);
881 self.curitem = orig_curitem;
884 fn visit_expr(&mut self, expr: &hir::Expr) {
886 hir::ExprField(ref base, ident) => {
887 if let ty::TyStruct(def, _) = self.tcx.expr_ty_adjusted(&**base).sty {
888 self.check_field(expr.span,
890 def.struct_variant(),
891 NamedField(ident.node.name));
894 hir::ExprTupField(ref base, idx) => {
895 if let ty::TyStruct(def, _) = self.tcx.expr_ty_adjusted(&**base).sty {
896 self.check_field(expr.span,
898 def.struct_variant(),
899 UnnamedField(idx.node));
902 hir::ExprMethodCall(ident, _, _) => {
903 let method_call = ty::MethodCall::expr(expr.id);
904 let method = self.tcx.tables.borrow().method_map[&method_call];
905 debug!("(privacy checking) checking impl method");
906 self.check_method(expr.span, method.def_id, ident.node.name);
908 hir::ExprStruct(..) => {
909 let adt = self.tcx.expr_ty(expr).ty_adt_def().unwrap();
910 let variant = adt.variant_of_def(self.tcx.resolve_expr(expr));
911 // RFC 736: ensure all unmentioned fields are visible.
912 // Rather than computing the set of unmentioned fields
913 // (i.e. `all_fields - fields`), just check them all.
914 for field in &variant.fields {
915 self.check_field(expr.span, adt, variant, NamedField(field.name));
918 hir::ExprPath(..) => {
920 if let def::DefStruct(_) = self.tcx.resolve_expr(expr) {
921 let expr_ty = self.tcx.expr_ty(expr);
922 let def = match expr_ty.sty {
923 ty::TyBareFn(_, &ty::BareFnTy { sig: ty::Binder(ty::FnSig {
924 output: ty::FnConverging(ty), ..
927 }.ty_adt_def().unwrap();
928 let any_priv = def.struct_variant().fields.iter().any(|f| {
929 f.vis != hir::Public && (
931 !self.private_accessible(f.did.node))
935 span_err!(self.tcx.sess, expr.span, E0450,
936 "cannot invoke tuple struct constructor with private \
944 visit::walk_expr(self, expr);
947 fn visit_pat(&mut self, pattern: &hir::Pat) {
948 // Foreign functions do not have their patterns mapped in the def_map,
949 // and there's nothing really relevant there anyway, so don't bother
950 // checking privacy. If you can name the type then you can pass it to an
951 // external C function anyway.
952 if self.in_foreign { return }
955 hir::PatStruct(_, ref fields, _) => {
956 let adt = self.tcx.pat_ty(pattern).ty_adt_def().unwrap();
957 let def = self.tcx.def_map.borrow().get(&pattern.id).unwrap().full_def();
958 let variant = adt.variant_of_def(def);
959 for field in fields {
960 self.check_field(pattern.span, adt, variant,
961 NamedField(field.node.ident.name));
965 // Patterns which bind no fields are allowable (the path is check
967 hir::PatEnum(_, Some(ref fields)) => {
968 match self.tcx.pat_ty(pattern).sty {
969 ty::TyStruct(def, _) => {
970 for (i, field) in fields.iter().enumerate() {
971 if let hir::PatWild(..) = field.node {
974 self.check_field(field.span,
976 def.struct_variant(),
981 // enum fields have no privacy at this time
990 visit::walk_pat(self, pattern);
993 fn visit_foreign_item(&mut self, fi: &hir::ForeignItem) {
994 self.in_foreign = true;
995 visit::walk_foreign_item(self, fi);
996 self.in_foreign = false;
999 fn visit_path(&mut self, path: &hir::Path, id: ast::NodeId) {
1000 self.check_path(path.span, id, path.segments.last().unwrap().identifier.name);
1001 visit::walk_path(self, path);
1005 ////////////////////////////////////////////////////////////////////////////////
1006 /// The privacy sanity check visitor, ensures unnecessary visibility isn't here
1007 ////////////////////////////////////////////////////////////////////////////////
1009 struct SanePrivacyVisitor<'a, 'tcx: 'a> {
1010 tcx: &'a ty::ctxt<'tcx>,
1014 impl<'a, 'tcx, 'v> Visitor<'v> for SanePrivacyVisitor<'a, 'tcx> {
1015 fn visit_item(&mut self, item: &hir::Item) {
1017 self.check_all_inherited(item);
1019 self.check_sane_privacy(item);
1022 let in_fn = self.in_fn;
1023 let orig_in_fn = replace(&mut self.in_fn, match item.node {
1024 hir::ItemMod(..) => false, // modules turn privacy back on
1025 _ => in_fn, // otherwise we inherit
1027 visit::walk_item(self, item);
1028 self.in_fn = orig_in_fn;
1031 fn visit_fn(&mut self, fk: visit::FnKind<'v>, fd: &'v hir::FnDecl,
1032 b: &'v hir::Block, s: Span, _: ast::NodeId) {
1033 // This catches both functions and methods
1034 let orig_in_fn = replace(&mut self.in_fn, true);
1035 visit::walk_fn(self, fk, fd, b, s);
1036 self.in_fn = orig_in_fn;
1040 impl<'a, 'tcx> SanePrivacyVisitor<'a, 'tcx> {
1041 /// Validates all of the visibility qualifiers placed on the item given. This
1042 /// ensures that there are no extraneous qualifiers that don't actually do
1043 /// anything. In theory these qualifiers wouldn't parse, but that may happen
1044 /// later on down the road...
1045 fn check_sane_privacy(&self, item: &hir::Item) {
1047 let check_inherited = |sp: Span, vis: hir::Visibility, note: &str| {
1048 if vis != hir::Inherited {
1049 span_err!(tcx.sess, sp, E0449,
1050 "unnecessary visibility qualifier");
1051 if !note.is_empty() {
1052 tcx.sess.span_note(sp, note);
1057 // implementations of traits don't need visibility qualifiers because
1058 // that's controlled by having the trait in scope.
1059 hir::ItemImpl(_, _, _, Some(..), _, ref impl_items) => {
1060 check_inherited(item.span, item.vis,
1061 "visibility qualifiers have no effect on trait \
1063 for impl_item in impl_items {
1064 check_inherited(impl_item.span, impl_item.vis, "");
1068 hir::ItemImpl(..) => {
1069 check_inherited(item.span, item.vis,
1070 "place qualifiers on individual methods instead");
1072 hir::ItemForeignMod(..) => {
1073 check_inherited(item.span, item.vis,
1074 "place qualifiers on individual functions \
1079 hir::ItemTrait(..) | hir::ItemDefaultImpl(..) |
1080 hir::ItemConst(..) | hir::ItemStatic(..) | hir::ItemStruct(..) |
1081 hir::ItemFn(..) | hir::ItemMod(..) | hir::ItemTy(..) |
1082 hir::ItemExternCrate(_) | hir::ItemUse(_) => {}
1086 /// When inside of something like a function or a method, visibility has no
1087 /// control over anything so this forbids any mention of any visibility
1088 fn check_all_inherited(&self, item: &hir::Item) {
1090 fn check_inherited(tcx: &ty::ctxt, sp: Span, vis: hir::Visibility) {
1091 if vis != hir::Inherited {
1092 span_err!(tcx.sess, sp, E0447,
1093 "visibility has no effect inside functions");
1096 let check_struct = |def: &hir::StructDef| {
1097 for f in &def.fields {
1099 hir::NamedField(_, p) => check_inherited(tcx, f.span, p),
1100 hir::UnnamedField(..) => {}
1104 check_inherited(tcx, item.span, item.vis);
1106 hir::ItemImpl(_, _, _, _, _, ref impl_items) => {
1107 for impl_item in impl_items {
1108 match impl_item.node {
1109 hir::MethodImplItem(..) => {
1110 check_inherited(tcx, impl_item.span, impl_item.vis);
1116 hir::ItemForeignMod(ref fm) => {
1117 for i in &fm.items {
1118 check_inherited(tcx, i.span, i.vis);
1122 hir::ItemStruct(ref def, _) => check_struct(&**def),
1125 hir::ItemExternCrate(_) | hir::ItemUse(_) |
1126 hir::ItemTrait(..) | hir::ItemDefaultImpl(..) |
1127 hir::ItemStatic(..) | hir::ItemConst(..) |
1128 hir::ItemFn(..) | hir::ItemMod(..) | hir::ItemTy(..) => {}
1133 struct VisiblePrivateTypesVisitor<'a, 'tcx: 'a> {
1134 tcx: &'a ty::ctxt<'tcx>,
1135 exported_items: &'a ExportedItems,
1136 public_items: &'a PublicItems,
1140 struct CheckTypeForPrivatenessVisitor<'a, 'b: 'a, 'tcx: 'b> {
1141 inner: &'a VisiblePrivateTypesVisitor<'b, 'tcx>,
1142 /// whether the type refers to private types.
1143 contains_private: bool,
1144 /// whether we've recurred at all (i.e. if we're pointing at the
1145 /// first type on which visit_ty was called).
1146 at_outer_type: bool,
1147 // whether that first type is a public path.
1148 outer_type_is_public_path: bool,
1151 impl<'a, 'tcx> VisiblePrivateTypesVisitor<'a, 'tcx> {
1152 fn path_is_private_type(&self, path_id: ast::NodeId) -> bool {
1153 let did = match self.tcx.def_map.borrow().get(&path_id).map(|d| d.full_def()) {
1154 // `int` etc. (None doesn't seem to occur.)
1155 None | Some(def::DefPrimTy(..)) => return false,
1156 Some(def) => def.def_id(),
1158 // A path can only be private if:
1159 // it's in this crate...
1160 if !did.is_local() {
1164 // .. and it corresponds to a private type in the AST (this returns
1165 // None for type parameters)
1166 match self.tcx.map.find(did.node) {
1167 Some(ast_map::NodeItem(ref item)) => item.vis != hir::Public,
1168 Some(_) | None => false,
1172 fn trait_is_public(&self, trait_id: ast::NodeId) -> bool {
1173 // FIXME: this would preferably be using `exported_items`, but all
1174 // traits are exported currently (see `EmbargoVisitor.exported_trait`)
1175 self.public_items.contains(&trait_id)
1178 fn check_ty_param_bound(&self,
1179 ty_param_bound: &hir::TyParamBound) {
1180 if let hir::TraitTyParamBound(ref trait_ref, _) = *ty_param_bound {
1181 if !self.tcx.sess.features.borrow().visible_private_types &&
1182 self.path_is_private_type(trait_ref.trait_ref.ref_id) {
1183 let span = trait_ref.trait_ref.path.span;
1184 span_err!(self.tcx.sess, span, E0445,
1185 "private trait in exported type parameter bound");
1190 fn item_is_public(&self, id: &ast::NodeId, vis: hir::Visibility) -> bool {
1191 self.exported_items.contains(id) || vis == hir::Public
1195 impl<'a, 'b, 'tcx, 'v> Visitor<'v> for CheckTypeForPrivatenessVisitor<'a, 'b, 'tcx> {
1196 fn visit_ty(&mut self, ty: &hir::Ty) {
1197 if let hir::TyPath(..) = ty.node {
1198 if self.inner.path_is_private_type(ty.id) {
1199 self.contains_private = true;
1200 // found what we're looking for so let's stop
1203 } else if self.at_outer_type {
1204 self.outer_type_is_public_path = true;
1207 self.at_outer_type = false;
1208 visit::walk_ty(self, ty)
1211 // don't want to recurse into [, .. expr]
1212 fn visit_expr(&mut self, _: &hir::Expr) {}
1215 impl<'a, 'tcx, 'v> Visitor<'v> for VisiblePrivateTypesVisitor<'a, 'tcx> {
1216 fn visit_item(&mut self, item: &hir::Item) {
1218 // contents of a private mod can be reexported, so we need
1219 // to check internals.
1220 hir::ItemMod(_) => {}
1222 // An `extern {}` doesn't introduce a new privacy
1223 // namespace (the contents have their own privacies).
1224 hir::ItemForeignMod(_) => {}
1226 hir::ItemTrait(_, _, ref bounds, _) => {
1227 if !self.trait_is_public(item.id) {
1231 for bound in bounds.iter() {
1232 self.check_ty_param_bound(bound)
1236 // impls need some special handling to try to offer useful
1237 // error messages without (too many) false positives
1238 // (i.e. we could just return here to not check them at
1239 // all, or some worse estimation of whether an impl is
1240 // publicly visible).
1241 hir::ItemImpl(_, _, ref g, ref trait_ref, ref self_, ref impl_items) => {
1242 // `impl [... for] Private` is never visible.
1243 let self_contains_private;
1244 // impl [... for] Public<...>, but not `impl [... for]
1245 // Vec<Public>` or `(Public,)` etc.
1246 let self_is_public_path;
1248 // check the properties of the Self type:
1250 let mut visitor = CheckTypeForPrivatenessVisitor {
1252 contains_private: false,
1253 at_outer_type: true,
1254 outer_type_is_public_path: false,
1256 visitor.visit_ty(&**self_);
1257 self_contains_private = visitor.contains_private;
1258 self_is_public_path = visitor.outer_type_is_public_path;
1261 // miscellaneous info about the impl
1263 // `true` iff this is `impl Private for ...`.
1264 let not_private_trait =
1265 trait_ref.as_ref().map_or(true, // no trait counts as public trait
1267 let did = self.tcx.trait_ref_to_def_id(tr);
1269 !did.is_local() || self.trait_is_public(did.node)
1272 // `true` iff this is a trait impl or at least one method is public.
1274 // `impl Public { $( fn ...() {} )* }` is not visible.
1276 // This is required over just using the methods' privacy
1277 // directly because we might have `impl<T: Foo<Private>> ...`,
1278 // and we shouldn't warn about the generics if all the methods
1279 // are private (because `T` won't be visible externally).
1280 let trait_or_some_public_method =
1281 trait_ref.is_some() ||
1284 match impl_item.node {
1285 hir::ConstImplItem(..) |
1286 hir::MethodImplItem(..) => {
1287 self.exported_items.contains(&impl_item.id)
1289 hir::TypeImplItem(_) => false,
1293 if !self_contains_private &&
1294 not_private_trait &&
1295 trait_or_some_public_method {
1297 visit::walk_generics(self, g);
1301 for impl_item in impl_items {
1302 // This is where we choose whether to walk down
1303 // further into the impl to check its items. We
1304 // should only walk into public items so that we
1305 // don't erroneously report errors for private
1306 // types in private items.
1307 match impl_item.node {
1308 hir::ConstImplItem(..) |
1309 hir::MethodImplItem(..)
1310 if self.item_is_public(&impl_item.id, impl_item.vis) =>
1312 visit::walk_impl_item(self, impl_item)
1314 hir::TypeImplItem(..) => {
1315 visit::walk_impl_item(self, impl_item)
1322 // Any private types in a trait impl fall into three
1324 // 1. mentioned in the trait definition
1325 // 2. mentioned in the type params/generics
1326 // 3. mentioned in the associated types of the impl
1328 // Those in 1. can only occur if the trait is in
1329 // this crate and will've been warned about on the
1330 // trait definition (there's no need to warn twice
1331 // so we don't check the methods).
1333 // Those in 2. are warned via walk_generics and this
1335 visit::walk_path(self, &tr.path);
1337 // Those in 3. are warned with this call.
1338 for impl_item in impl_items {
1339 if let hir::TypeImplItem(ref ty) = impl_item.node {
1345 } else if trait_ref.is_none() && self_is_public_path {
1346 // impl Public<Private> { ... }. Any public static
1347 // methods will be visible as `Public::foo`.
1348 let mut found_pub_static = false;
1349 for impl_item in impl_items {
1350 match impl_item.node {
1351 hir::ConstImplItem(..) => {
1352 if self.item_is_public(&impl_item.id, impl_item.vis) {
1353 found_pub_static = true;
1354 visit::walk_impl_item(self, impl_item);
1357 hir::MethodImplItem(ref sig, _) => {
1358 if sig.explicit_self.node == hir::SelfStatic &&
1359 self.item_is_public(&impl_item.id, impl_item.vis) {
1360 found_pub_static = true;
1361 visit::walk_impl_item(self, impl_item);
1367 if found_pub_static {
1368 visit::walk_generics(self, g)
1374 // `type ... = ...;` can contain private types, because
1375 // we're introducing a new name.
1376 hir::ItemTy(..) => return,
1378 // not at all public, so we don't care
1379 _ if !self.item_is_public(&item.id, item.vis) => {
1386 // We've carefully constructed it so that if we're here, then
1387 // any `visit_ty`'s will be called on things that are in
1388 // public signatures, i.e. things that we're interested in for
1390 debug!("VisiblePrivateTypesVisitor entering item {:?}", item);
1391 visit::walk_item(self, item);
1394 fn visit_generics(&mut self, generics: &hir::Generics) {
1395 for ty_param in generics.ty_params.iter() {
1396 for bound in ty_param.bounds.iter() {
1397 self.check_ty_param_bound(bound)
1400 for predicate in &generics.where_clause.predicates {
1402 &hir::WherePredicate::BoundPredicate(ref bound_pred) => {
1403 for bound in bound_pred.bounds.iter() {
1404 self.check_ty_param_bound(bound)
1407 &hir::WherePredicate::RegionPredicate(_) => {}
1408 &hir::WherePredicate::EqPredicate(ref eq_pred) => {
1409 self.visit_ty(&*eq_pred.ty);
1415 fn visit_foreign_item(&mut self, item: &hir::ForeignItem) {
1416 if self.exported_items.contains(&item.id) {
1417 visit::walk_foreign_item(self, item)
1421 fn visit_ty(&mut self, t: &hir::Ty) {
1422 debug!("VisiblePrivateTypesVisitor checking ty {:?}", t);
1423 if let hir::TyPath(_, ref p) = t.node {
1424 if !self.tcx.sess.features.borrow().visible_private_types &&
1425 self.path_is_private_type(t.id) {
1426 span_err!(self.tcx.sess, p.span, E0446,
1427 "private type in exported type signature");
1430 visit::walk_ty(self, t)
1433 fn visit_variant(&mut self, v: &hir::Variant, g: &hir::Generics) {
1434 if self.exported_items.contains(&v.node.id) {
1435 self.in_variant = true;
1436 visit::walk_variant(self, v, g);
1437 self.in_variant = false;
1441 fn visit_struct_field(&mut self, s: &hir::StructField) {
1443 hir::NamedField(_, vis) if vis == hir::Public || self.in_variant => {
1444 visit::walk_struct_field(self, s);
1451 // we don't need to introspect into these at all: an
1452 // expression/block context can't possibly contain exported things.
1453 // (Making them no-ops stops us from traversing the whole AST without
1454 // having to be super careful about our `walk_...` calls above.)
1455 fn visit_block(&mut self, _: &hir::Block) {}
1456 fn visit_expr(&mut self, _: &hir::Expr) {}
1459 pub fn check_crate(tcx: &ty::ctxt,
1460 export_map: &def::ExportMap,
1461 external_exports: ExternalExports)
1462 -> (ExportedItems, PublicItems) {
1463 let krate = tcx.map.krate();
1465 // Figure out who everyone's parent is
1466 let mut visitor = ParentVisitor {
1468 curparent: ast::DUMMY_NODE_ID,
1470 visit::walk_crate(&mut visitor, krate);
1472 // Use the parent map to check the privacy of everything
1473 let mut visitor = PrivacyVisitor {
1474 curitem: ast::DUMMY_NODE_ID,
1477 parents: visitor.parents,
1478 external_exports: external_exports,
1480 visit::walk_crate(&mut visitor, krate);
1482 // Sanity check to make sure that all privacy usage and controls are
1484 let mut visitor = SanePrivacyVisitor {
1488 visit::walk_crate(&mut visitor, krate);
1490 tcx.sess.abort_if_errors();
1492 // Build up a set of all exported items in the AST. This is a set of all
1493 // items which are reachable from external crates based on visibility.
1494 let mut visitor = EmbargoVisitor {
1496 exported_items: NodeSet(),
1497 public_items: NodeSet(),
1498 reexports: NodeSet(),
1499 export_map: export_map,
1500 prev_exported: true,
1504 let before = visitor.exported_items.len();
1505 visit::walk_crate(&mut visitor, krate);
1506 if before == visitor.exported_items.len() {
1511 let EmbargoVisitor { exported_items, public_items, .. } = visitor;
1514 let mut visitor = VisiblePrivateTypesVisitor {
1516 exported_items: &exported_items,
1517 public_items: &public_items,
1520 visit::walk_crate(&mut visitor, krate);
1522 return (exported_items, public_items);