1 // Copyright 2014-2015 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 use check::regionck::{self, Rcx};
13 use middle::def_id::DefId;
14 use middle::free_region::FreeRegionMap;
17 use middle::subst::{self, Subst};
19 use middle::ty::{self, Ty};
20 use util::nodemap::FnvHashSet;
23 use syntax::codemap::{self, Span};
25 /// check_drop_impl confirms that the Drop implementation identfied by
26 /// `drop_impl_did` is not any more specialized than the type it is
27 /// attached to (Issue #8142).
31 /// 1. The self type must be nominal (this is already checked during
34 /// 2. The generic region/type parameters of the impl's self-type must
35 /// all be parameters of the Drop impl itself (i.e. no
36 /// specialization like `impl Drop for Foo<i32>`), and,
38 /// 3. Any bounds on the generic parameters must be reflected in the
39 /// struct/enum definition for the nominal type itself (i.e.
40 /// cannot do `struct S<T>; impl<T:Clone> Drop for S<T> { ... }`).
42 pub fn check_drop_impl(tcx: &ty::ctxt, drop_impl_did: DefId) -> Result<(), ()> {
43 let ty::TypeScheme { generics: ref dtor_generics,
44 ty: dtor_self_type } = tcx.lookup_item_type(drop_impl_did);
45 let dtor_predicates = tcx.lookup_predicates(drop_impl_did);
46 match dtor_self_type.sty {
47 ty::TyEnum(adt_def, self_to_impl_substs) |
48 ty::TyStruct(adt_def, self_to_impl_substs) => {
49 try!(ensure_drop_params_and_item_params_correspond(tcx,
55 ensure_drop_predicates_are_implied_by_item_defn(tcx,
62 // Destructors only work on nominal types. This was
63 // already checked by coherence, so we can panic here.
64 let span = tcx.map.def_id_span(drop_impl_did, codemap::DUMMY_SP);
66 span, &format!("should have been rejected by coherence check: {}",
72 fn ensure_drop_params_and_item_params_correspond<'tcx>(
75 drop_impl_generics: &ty::Generics<'tcx>,
76 drop_impl_ty: &ty::Ty<'tcx>,
77 self_type_did: DefId) -> Result<(), ()>
79 let drop_impl_node_id = tcx.map.as_local_node_id(drop_impl_did).unwrap();
80 let self_type_node_id = tcx.map.as_local_node_id(self_type_did).unwrap();
82 // check that the impl type can be made to match the trait type.
84 let impl_param_env = ty::ParameterEnvironment::for_item(tcx, self_type_node_id);
85 let infcx = infer::new_infer_ctxt(tcx, &tcx.tables, Some(impl_param_env));
86 let mut fulfillment_cx = traits::FulfillmentContext::new();
88 let named_type = tcx.lookup_item_type(self_type_did).ty;
89 let named_type = named_type.subst(tcx, &infcx.parameter_environment.free_substs);
91 let drop_impl_span = tcx.map.def_id_span(drop_impl_did, codemap::DUMMY_SP);
92 let fresh_impl_substs =
93 infcx.fresh_substs_for_generics(drop_impl_span, drop_impl_generics);
94 let fresh_impl_self_ty = drop_impl_ty.subst(tcx, &fresh_impl_substs);
96 if let Err(_) = infer::mk_eqty(&infcx, true, infer::TypeOrigin::Misc(drop_impl_span),
97 named_type, fresh_impl_self_ty) {
98 let item_span = tcx.map.span(self_type_node_id);
99 struct_span_err!(tcx.sess, drop_impl_span, E0366,
100 "Implementations of Drop cannot be specialized")
101 .span_note(item_span,
102 "Use same sequence of generic type and region \
103 parameters that is on the struct/enum definition")
108 if let Err(ref errors) = fulfillment_cx.select_all_or_error(&infcx) {
109 // this could be reached when we get lazy normalization
110 traits::report_fulfillment_errors(&infcx, errors);
114 let free_regions = FreeRegionMap::new();
115 infcx.resolve_regions_and_report_errors(&free_regions, drop_impl_node_id);
119 /// Confirms that every predicate imposed by dtor_predicates is
120 /// implied by assuming the predicates attached to self_type_did.
121 fn ensure_drop_predicates_are_implied_by_item_defn<'tcx>(
122 tcx: &ty::ctxt<'tcx>,
123 drop_impl_did: DefId,
124 dtor_predicates: &ty::GenericPredicates<'tcx>,
125 self_type_did: DefId,
126 self_to_impl_substs: &subst::Substs<'tcx>) -> Result<(), ()> {
128 // Here is an example, analogous to that from
129 // `compare_impl_method`.
131 // Consider a struct type:
133 // struct Type<'c, 'b:'c, 'a> {
134 // x: &'a Contents // (contents are irrelevant;
135 // y: &'c Cell<&'b Contents>, // only the bounds matter for our purposes.)
140 // impl<'z, 'y:'z, 'x:'y> Drop for P<'z, 'y, 'x> {
141 // fn drop(&mut self) { self.y.set(self.x); } // (only legal if 'x: 'y)
144 // We start out with self_to_impl_substs, that maps the generic
145 // parameters of Type to that of the Drop impl.
147 // self_to_impl_substs = {'c => 'z, 'b => 'y, 'a => 'x}
149 // Applying this to the predicates (i.e. assumptions) provided by the item
150 // definition yields the instantiated assumptions:
154 // We then check all of the predicates of the Drop impl:
158 // and ensure each is in the list of instantiated
159 // assumptions. Here, `'y:'z` is present, but `'x:'y` is
160 // absent. So we report an error that the Drop impl injected a
161 // predicate that is not present on the struct definition.
163 let self_type_node_id = tcx.map.as_local_node_id(self_type_did).unwrap();
165 let drop_impl_span = tcx.map.def_id_span(drop_impl_did, codemap::DUMMY_SP);
167 // We can assume the predicates attached to struct/enum definition
169 let generic_assumptions = tcx.lookup_predicates(self_type_did);
171 let assumptions_in_impl_context = generic_assumptions.instantiate(tcx, &self_to_impl_substs);
172 assert!(assumptions_in_impl_context.predicates.is_empty_in(subst::SelfSpace));
173 assert!(assumptions_in_impl_context.predicates.is_empty_in(subst::FnSpace));
174 let assumptions_in_impl_context =
175 assumptions_in_impl_context.predicates.get_slice(subst::TypeSpace);
177 // An earlier version of this code attempted to do this checking
178 // via the traits::fulfill machinery. However, it ran into trouble
179 // since the fulfill machinery merely turns outlives-predicates
180 // 'a:'b and T:'b into region inference constraints. It is simpler
181 // just to look for all the predicates directly.
183 assert!(dtor_predicates.predicates.is_empty_in(subst::SelfSpace));
184 assert!(dtor_predicates.predicates.is_empty_in(subst::FnSpace));
185 let predicates = dtor_predicates.predicates.get_slice(subst::TypeSpace);
186 for predicate in predicates {
187 // (We do not need to worry about deep analysis of type
188 // expressions etc because the Drop impls are already forced
189 // to take on a structure that is roughly an alpha-renaming of
190 // the generic parameters of the item definition.)
192 // This path now just checks *all* predicates via the direct
193 // lookup, rather than using fulfill machinery.
195 // However, it may be more efficient in the future to batch
196 // the analysis together via the fulfill , rather than the
197 // repeated `contains` calls.
199 if !assumptions_in_impl_context.contains(&predicate) {
200 let item_span = tcx.map.span(self_type_node_id);
201 struct_span_err!(tcx.sess, drop_impl_span, E0367,
202 "The requirement `{}` is added only by the Drop impl.", predicate)
203 .span_note(item_span,
204 "The same requirement must be part of \
205 the struct/enum definition")
210 if tcx.sess.has_errors() {
216 /// check_safety_of_destructor_if_necessary confirms that the type
217 /// expression `typ` conforms to the "Drop Check Rule" from the Sound
218 /// Generic Drop (RFC 769).
222 /// The simplified (*) Drop Check Rule is the following:
224 /// Let `v` be some value (either temporary or named) and 'a be some
225 /// lifetime (scope). If the type of `v` owns data of type `D`, where
227 /// * (1.) `D` has a lifetime- or type-parametric Drop implementation,
228 /// (where that `Drop` implementation does not opt-out of
229 /// this check via the `unsafe_destructor_blind_to_params`
231 /// * (2.) the structure of `D` can reach a reference of type `&'a _`,
233 /// then 'a must strictly outlive the scope of v.
237 /// This function is meant to by applied to the type for every
238 /// expression in the program.
242 /// (*) The qualifier "simplified" is attached to the above
243 /// definition of the Drop Check Rule, because it is a simplification
244 /// of the original Drop Check rule, which attempted to prove that
245 /// some `Drop` implementations could not possibly access data even if
246 /// it was technically reachable, due to parametricity.
248 /// However, (1.) parametricity on its own turned out to be a
249 /// necessary but insufficient condition, and (2.) future changes to
250 /// the language are expected to make it impossible to ensure that a
251 /// `Drop` implementation is actually parametric with respect to any
252 /// particular type parameter. (In particular, impl specialization is
253 /// expected to break the needed parametricity property beyond
256 /// Therefore we have scaled back Drop-Check to a more conservative
257 /// rule that does not attempt to deduce whether a `Drop`
258 /// implementation could not possible access data of a given lifetime;
259 /// instead Drop-Check now simply assumes that if a destructor has
260 /// access (direct or indirect) to a lifetime parameter, then that
261 /// lifetime must be forced to outlive that destructor's dynamic
262 /// extent. We then provide the `unsafe_destructor_blind_to_params`
263 /// attribute as a way for destructor implementations to opt-out of
264 /// this conservative assumption (and thus assume the obligation of
265 /// ensuring that they do not access data nor invoke methods of
266 /// values that have been previously dropped).
268 pub fn check_safety_of_destructor_if_necessary<'a, 'tcx>(rcx: &mut Rcx<'a, 'tcx>,
271 scope: region::CodeExtent) {
272 debug!("check_safety_of_destructor_if_necessary typ: {:?} scope: {:?}",
275 let parent_scope = rcx.tcx().region_maps.opt_encl_scope(scope).unwrap_or_else(|| {
276 rcx.tcx().sess.span_bug(
277 span, &format!("no enclosing scope found for scope: {:?}", scope))
280 let result = iterate_over_potentially_unsafe_regions_in_type(
284 parent_scope: parent_scope,
285 breadcrumbs: FnvHashSet()
292 Err(Error::Overflow(ref ctxt, ref detected_on_typ)) => {
294 let mut err = struct_span_err!(tcx.sess, span, E0320,
295 "overflow while adding drop-check rules for {}", typ);
297 TypeContext::Root => {
298 // no need for an additional note if the overflow
299 // was somehow on the root.
301 TypeContext::ADT { def_id, variant, field } => {
302 let adt = tcx.lookup_adt_def(def_id);
303 let variant_name = match adt.adt_kind() {
304 ty::AdtKind::Enum => format!("enum {} variant {}",
305 tcx.item_path_str(def_id),
307 ty::AdtKind::Struct => format!("struct {}",
308 tcx.item_path_str(def_id))
313 "overflowed on {} field {} type: {}",
325 Overflow(TypeContext, ty::Ty<'tcx>),
328 #[derive(Copy, Clone)]
338 struct DropckContext<'a, 'b: 'a, 'tcx: 'b> {
339 rcx: &'a mut Rcx<'b, 'tcx>,
340 /// types that have already been traversed
341 breadcrumbs: FnvHashSet<Ty<'tcx>>,
342 /// span for error reporting
344 /// the scope reachable dtorck types must outlive
345 parent_scope: region::CodeExtent
348 // `context` is used for reporting overflow errors
349 fn iterate_over_potentially_unsafe_regions_in_type<'a, 'b, 'tcx>(
350 cx: &mut DropckContext<'a, 'b, 'tcx>,
351 context: TypeContext,
353 depth: usize) -> Result<(), Error<'tcx>>
355 let tcx = cx.rcx.tcx();
356 // Issue #22443: Watch out for overflow. While we are careful to
357 // handle regular types properly, non-regular ones cause problems.
358 let recursion_limit = tcx.sess.recursion_limit.get();
359 if depth / 4 >= recursion_limit {
360 // This can get into rather deep recursion, especially in the
361 // presence of things like Vec<T> -> Unique<T> -> PhantomData<T> -> T.
362 // use a higher recursion limit to avoid errors.
363 return Err(Error::Overflow(context, ty))
366 // canoncialize the regions in `ty` before inserting - infinitely many
367 // region variables can refer to the same region.
368 let ty = cx.rcx.infcx().resolve_type_and_region_vars_if_possible(&ty);
370 if !cx.breadcrumbs.insert(ty) {
371 debug!("iterate_over_potentially_unsafe_regions_in_type \
372 {}ty: {} scope: {:?} - cached",
373 (0..depth).map(|_| ' ').collect::<String>(),
374 ty, cx.parent_scope);
375 return Ok(()); // we already visited this type
377 debug!("iterate_over_potentially_unsafe_regions_in_type \
378 {}ty: {} scope: {:?}",
379 (0..depth).map(|_| ' ').collect::<String>(),
380 ty, cx.parent_scope);
382 // If `typ` has a destructor, then we must ensure that all
383 // borrowed data reachable via `typ` must outlive the parent
384 // of `scope`. This is handled below.
386 // However, there is an important special case: for any Drop
387 // impl that is tagged as "blind" to their parameters,
388 // we assume that data borrowed via such type parameters
389 // remains unreachable via that Drop impl.
391 // For example, consider:
394 // #[unsafe_destructor_blind_to_params]
395 // impl<T> Drop for Vec<T> { ... }
398 // which does have to be able to drop instances of `T`, but
399 // otherwise cannot read data from `T`.
401 // Of course, for the type expression passed in for any such
402 // unbounded type parameter `T`, we must resume the recursive
403 // analysis on `T` (since it would be ignored by
404 // type_must_outlive).
405 if has_dtor_of_interest(tcx, ty) {
406 debug!("iterate_over_potentially_unsafe_regions_in_type \
407 {}ty: {} - is a dtorck type!",
408 (0..depth).map(|_| ' ').collect::<String>(),
411 regionck::type_must_outlive(cx.rcx,
412 infer::SubregionOrigin::SafeDestructor(cx.span),
414 ty::ReScope(cx.parent_scope));
419 debug!("iterate_over_potentially_unsafe_regions_in_type \
420 {}ty: {} scope: {:?} - checking interior",
421 (0..depth).map(|_| ' ').collect::<String>(),
422 ty, cx.parent_scope);
424 // We still need to ensure all referenced data is safe.
426 ty::TyBool | ty::TyChar | ty::TyInt(_) | ty::TyUint(_) |
427 ty::TyFloat(_) | ty::TyStr => {
428 // primitive - definitely safe
432 ty::TyBox(ity) | ty::TyArray(ity, _) | ty::TySlice(ity) => {
433 // single-element containers, behave like their element
434 iterate_over_potentially_unsafe_regions_in_type(
435 cx, context, ity, depth+1)
438 ty::TyStruct(def, substs) if def.is_phantom_data() => {
439 // PhantomData<T> - behaves identically to T
440 let ity = *substs.types.get(subst::TypeSpace, 0);
441 iterate_over_potentially_unsafe_regions_in_type(
442 cx, context, ity, depth+1)
445 ty::TyStruct(def, substs) | ty::TyEnum(def, substs) => {
447 for variant in &def.variants {
448 for field in variant.fields.iter() {
449 let fty = field.ty(tcx, substs);
450 let fty = cx.rcx.fcx.resolve_type_vars_if_possible(
451 cx.rcx.fcx.normalize_associated_types_in(cx.span, &fty));
452 try!(iterate_over_potentially_unsafe_regions_in_type(
457 variant: variant.name,
466 ty::TyTuple(ref tys) |
467 ty::TyClosure(_, box ty::ClosureSubsts { upvar_tys: ref tys, .. }) => {
469 try!(iterate_over_potentially_unsafe_regions_in_type(
470 cx, context, ty, depth+1))
475 ty::TyRawPtr(..) | ty::TyRef(..) | ty::TyParam(..) => {
476 // these always come with a witness of liveness (references
477 // explicitly, pointers implicitly, parameters by the
482 ty::TyBareFn(..) => {
483 // FIXME(#26656): this type is always destruction-safe, but
484 // it implicitly witnesses Self: Fn, which can be false.
488 ty::TyInfer(..) | ty::TyError => {
489 tcx.sess.delay_span_bug(cx.span, "unresolved type in regionck");
493 // these are always dtorck
494 ty::TyTrait(..) | ty::TyProjection(_) => unreachable!(),
498 fn has_dtor_of_interest<'tcx>(tcx: &ty::ctxt<'tcx>,
499 ty: ty::Ty<'tcx>) -> bool {
501 ty::TyEnum(def, _) | ty::TyStruct(def, _) => {
504 ty::TyTrait(..) | ty::TyProjection(..) => {
505 debug!("ty: {:?} isn't known, and therefore is a dropck type", ty);