src/librustc/traits/auto_trait.rs

   1 // Copyright 2018 The Rust Project Developers. See the COPYRIGHT
   2 // file at the top-level directory of this distribution and at
   3 // http://rust-lang.org/COPYRIGHT.
   4 //
   5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
   6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
   7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
   8 // option. This file may not be copied, modified, or distributed
   9 // except according to those terms.
  10
  11 //! Support code for rustdoc and external tools . You really don't
  12 //! want to be using this unless you need to.
  13
  14 use super::*;
  15
  16 use std::collections::hash_map::Entry;
  17 use std::collections::VecDeque;
  18
  19 use infer::region_constraints::{Constraint, RegionConstraintData};
  20 use infer::InferCtxt;
  21 use rustc_data_structures::fx::{FxHashMap, FxHashSet};
  22
  23 use ty::fold::TypeFolder;
  24 use ty::{Region, RegionVid};
  25
  26 // FIXME(twk): this is obviously not nice to duplicate like that
  27 #[derive(Eq, PartialEq, Hash, Copy, Clone, Debug)]
  28 pub enum RegionTarget<'tcx> {
  29     Region(Region<'tcx>),
  30     RegionVid(RegionVid),
  31 }
  32
  33 #[derive(Default, Debug, Clone)]
  34 pub struct RegionDeps<'tcx> {
  35     larger: FxHashSet<RegionTarget<'tcx>>,
  36     smaller: FxHashSet<RegionTarget<'tcx>>,
  37 }
  38
  39 pub enum AutoTraitResult<A> {
  40     ExplicitImpl,
  41     PositiveImpl(A),
  42     NegativeImpl,
  43 }
  44
  45 impl<A> AutoTraitResult<A> {
  46     fn is_auto(&self) -> bool {
  47         match *self {
  48             AutoTraitResult::PositiveImpl(_) | AutoTraitResult::NegativeImpl => true,
  49             _ => false,
  50         }
  51     }
  52 }
  53
  54 pub struct AutoTraitInfo<'cx> {
  55     pub full_user_env: ty::ParamEnv<'cx>,
  56     pub region_data: RegionConstraintData<'cx>,
  57     pub names_map: FxHashSet<String>,
  58     pub vid_to_region: FxHashMap<ty::RegionVid, ty::Region<'cx>>,
  59 }
  60
  61 pub struct AutoTraitFinder<'a, 'tcx: 'a> {
  62     tcx: &'a TyCtxt<'a, 'tcx, 'tcx>,
  63 }
  64
  65 impl<'a, 'tcx> AutoTraitFinder<'a, 'tcx> {
  66     pub fn new(tcx: &'a TyCtxt<'a, 'tcx, 'tcx>) -> Self {
  67         AutoTraitFinder { tcx }
  68     }
  69
  70     /// Make a best effort to determine whether and under which conditions an auto trait is
  71     /// implemented for a type. For example, if you have
  72     ///
  73     /// ```
  74     /// struct Foo<T> { data: Box<T> }
  75     /// ```
  76     ///
  77     /// then this might return that Foo<T>: Send if T: Send (encoded in the AutoTraitResult type).
  78     /// The analysis attempts to account for custom impls as well as other complex cases. This
  79     /// result is intended for use by rustdoc and other such consumers.
  80     ///
  81     /// (Note that due to the coinductive nature of Send, the full and correct result is actually
  82     /// quite simple to generate. That is, when a type has no custom impl, it is Send iff its field
  83     /// types are all Send. So, in our example, we might have that Foo<T>: Send if Box<T>: Send.
  84     /// But this is often not the best way to present to the user.)
  85     ///
  86     /// Warning: The API should be considered highly unstable, and it may be refactored or removed
  87     /// in the future.
  88     pub fn find_auto_trait_generics<A>(
  89         &self,
  90         did: DefId,
  91         trait_did: DefId,
  92         generics: &ty::Generics,
  93         auto_trait_callback: impl for<'i> Fn(&InferCtxt<'_, 'tcx, 'i>, AutoTraitInfo<'i>) -> A,
  94     ) -> AutoTraitResult<A> {
  95         let tcx = self.tcx;
  96         let ty = self.tcx.type_of(did);
  97
  98         let orig_params = tcx.param_env(did);
  99
 100         let trait_ref = ty::TraitRef {
 101             def_id: trait_did,
 102             substs: tcx.mk_substs_trait(ty, &[]),
 103         };
 104
 105         let trait_pred = ty::Binder::bind(trait_ref);
 106
 107         let bail_out = tcx.infer_ctxt().enter(|infcx| {
 108             let mut selcx = SelectionContext::with_negative(&infcx, true);
 109             let result = selcx.select(&Obligation::new(
 110                 ObligationCause::dummy(),
 111                 orig_params,
 112                 trait_pred.to_poly_trait_predicate(),
 113             ));
 114
 115             match result {
 116                 Ok(Some(Vtable::VtableImpl(_))) => {
 117                     debug!(
 118                         "find_auto_trait_generics(did={:?}, trait_did={:?}, generics={:?}): \
 119                          manual impl found, bailing out",
 120                         did, trait_did, generics
 121                     );
 122                     true
 123                 }
 124                 _ => false
 125             }
 126         });
 127
 128         // If an explicit impl exists, it always takes priority over an auto impl
 129         if bail_out {
 130             return AutoTraitResult::ExplicitImpl;
 131         }
 132
 133         return tcx.infer_ctxt().enter(|mut infcx| {
 134             let mut fresh_preds = FxHashSet::default();
 135
 136             // Due to the way projections are handled by SelectionContext, we need to run
 137             // evaluate_predicates twice: once on the original param env, and once on the result of
 138             // the first evaluate_predicates call.
 139             //
 140             // The problem is this: most of rustc, including SelectionContext and traits::project,
 141             // are designed to work with a concrete usage of a type (e.g. Vec<u8>
 142             // fn<T>() { Vec<T> }. This information will generally never change - given
 143             // the 'T' in fn<T>() { ... }, we'll never know anything else about 'T'.
 144             // If we're unable to prove that 'T' implements a particular trait, we're done -
 145             // there's nothing left to do but error out.
 146             //
 147             // However, synthesizing an auto trait impl works differently. Here, we start out with
 148             // a set of initial conditions - the ParamEnv of the struct/enum/union we're dealing
 149             // with - and progressively discover the conditions we need to fulfill for it to
 150             // implement a certain auto trait. This ends up breaking two assumptions made by trait
 151             // selection and projection:
 152             //
 153             // * We can always cache the result of a particular trait selection for the lifetime of
 154             // an InfCtxt
 155             // * Given a projection bound such as '<T as SomeTrait>::SomeItem = K', if 'T:
 156             // SomeTrait' doesn't hold, then we don't need to care about the 'SomeItem = K'
 157             //
 158             // We fix the first assumption by manually clearing out all of the InferCtxt's caches
 159             // in between calls to SelectionContext.select. This allows us to keep all of the
 160             // intermediate types we create bound to the 'tcx lifetime, rather than needing to lift
 161             // them between calls.
 162             //
 163             // We fix the second assumption by reprocessing the result of our first call to
 164             // evaluate_predicates. Using the example of '<T as SomeTrait>::SomeItem = K', our first
 165             // pass will pick up 'T: SomeTrait', but not 'SomeItem = K'. On our second pass,
 166             // traits::project will see that 'T: SomeTrait' is in our ParamEnv, allowing
 167             // SelectionContext to return it back to us.
 168
 169             let (new_env, user_env) = match self.evaluate_predicates(
 170                 &mut infcx,
 171                 did,
 172                 trait_did,
 173                 ty,
 174                 orig_params.clone(),
 175                 orig_params,
 176                 &mut fresh_preds,
 177                 false,
 178             ) {
 179                 Some(e) => e,
 180                 None => return AutoTraitResult::NegativeImpl,
 181             };
 182
 183             let (full_env, full_user_env) = self.evaluate_predicates(
 184                 &mut infcx,
 185                 did,
 186                 trait_did,
 187                 ty,
 188                 new_env.clone(),
 189                 user_env,
 190                 &mut fresh_preds,
 191                 true,
 192             ).unwrap_or_else(|| {
 193                 panic!(
 194                     "Failed to fully process: {:?} {:?} {:?}",
 195                     ty, trait_did, orig_params
 196                 )
 197             });
 198
 199             debug!(
 200                 "find_auto_trait_generics(did={:?}, trait_did={:?}, generics={:?}): fulfilling \
 201                  with {:?}",
 202                 did, trait_did, generics, full_env
 203             );
 204             infcx.clear_caches();
 205
 206             // At this point, we already have all of the bounds we need. FulfillmentContext is used
 207             // to store all of the necessary region/lifetime bounds in the InferContext, as well as
 208             // an additional sanity check.
 209             let mut fulfill = FulfillmentContext::new();
 210             fulfill.register_bound(
 211                 &infcx,
 212                 full_env,
 213                 ty,
 214                 trait_did,
 215                 ObligationCause::misc(DUMMY_SP, ast::DUMMY_NODE_ID),
 216             );
 217             fulfill.select_all_or_error(&infcx).unwrap_or_else(|e| {
 218                 panic!(
 219                     "Unable to fulfill trait {:?} for '{:?}': {:?}",
 220                     trait_did, ty, e
 221                 )
 222             });
 223
 224             let names_map: FxHashSet<String> = generics
 225                 .params
 226                 .iter()
 227                 .filter_map(|param| match param.kind {
 228                     ty::GenericParamDefKind::Lifetime => Some(param.name.to_string()),
 229                     _ => None,
 230                 })
 231                 .collect();
 232
 233             let body_id_map: FxHashMap<_, _> = infcx
 234                 .region_obligations
 235                 .borrow()
 236                 .iter()
 237                 .map(|&(id, _)| (id, vec![]))
 238                 .collect();
 239
 240             infcx.process_registered_region_obligations(&body_id_map, None, full_env.clone());
 241
 242             let region_data = infcx
 243                 .borrow_region_constraints()
 244                 .region_constraint_data()
 245                 .clone();
 246
 247             let vid_to_region = self.map_vid_to_region(&region_data);
 248
 249             let info = AutoTraitInfo {
 250                 full_user_env,
 251                 region_data,
 252                 names_map,
 253                 vid_to_region,
 254             };
 255
 256             return AutoTraitResult::PositiveImpl(auto_trait_callback(&infcx, info));
 257         });
 258     }
 259 }
 260
 261 impl<'a, 'tcx> AutoTraitFinder<'a, 'tcx> {
 262     // The core logic responsible for computing the bounds for our synthesized impl.
 263     //
 264     // To calculate the bounds, we call SelectionContext.select in a loop. Like FulfillmentContext,
 265     // we recursively select the nested obligations of predicates we encounter. However, whenever we
 266     // encounter an UnimplementedError involving a type parameter, we add it to our ParamEnv. Since
 267     // our goal is to determine when a particular type implements an auto trait, Unimplemented
 268     // errors tell us what conditions need to be met.
 269     //
 270     // This method ends up working somewhat similarly to FulfillmentContext, but with a few key
 271     // differences. FulfillmentContext works under the assumption that it's dealing with concrete
 272     // user code. According, it considers all possible ways that a Predicate could be met - which
 273     // isn't always what we want for a synthesized impl. For example, given the predicate 'T:
 274     // Iterator', FulfillmentContext can end up reporting an Unimplemented error for T:
 275     // IntoIterator - since there's an implementation of Iteratpr where T: IntoIterator,
 276     // FulfillmentContext will drive SelectionContext to consider that impl before giving up. If we
 277     // were to rely on FulfillmentContext's decision, we might end up synthesizing an impl like
 278     // this:
 279     // 'impl<T> Send for Foo<T> where T: IntoIterator'
 280     //
 281     // While it might be technically true that Foo implements Send where T: IntoIterator,
 282     // the bound is overly restrictive - it's really only necessary that T: Iterator.
 283     //
 284     // For this reason, evaluate_predicates handles predicates with type variables specially. When
 285     // we encounter an Unimplemented error for a bound such as 'T: Iterator', we immediately add it
 286     // to our ParamEnv, and add it to our stack for recursive evaluation. When we later select it,
 287     // we'll pick up any nested bounds, without ever inferring that 'T: IntoIterator' needs to
 288     // hold.
 289     //
 290     // One additional consideration is supertrait bounds. Normally, a ParamEnv is only ever
 291     // constructed once for a given type. As part of the construction process, the ParamEnv will
 292     // have any supertrait bounds normalized - e.g. if we have a type 'struct Foo<T: Copy>', the
 293     // ParamEnv will contain 'T: Copy' and 'T: Clone', since 'Copy: Clone'. When we construct our
 294     // own ParamEnv, we need to do this ourselves, through traits::elaborate_predicates, or else
 295     // SelectionContext will choke on the missing predicates. However, this should never show up in
 296     // the final synthesized generics: we don't want our generated docs page to contain something
 297     // like 'T: Copy + Clone', as that's redundant. Therefore, we keep track of a separate
 298     // 'user_env', which only holds the predicates that will actually be displayed to the user.
 299     pub fn evaluate_predicates<'b, 'gcx, 'c>(
 300         &self,
 301         infcx: &InferCtxt<'b, 'tcx, 'c>,
 302         ty_did: DefId,
 303         trait_did: DefId,
 304         ty: ty::Ty<'c>,
 305         param_env: ty::ParamEnv<'c>,
 306         user_env: ty::ParamEnv<'c>,
 307         fresh_preds: &mut FxHashSet<ty::Predicate<'c>>,
 308         only_projections: bool,
 309     ) -> Option<(ty::ParamEnv<'c>, ty::ParamEnv<'c>)> {
 310         let tcx = infcx.tcx;
 311
 312         let mut select = SelectionContext::with_negative(&infcx, true);
 313
 314         let mut already_visited = FxHashSet::default();
 315         let mut predicates = VecDeque::new();
 316         predicates.push_back(ty::Binder::bind(ty::TraitPredicate {
 317             trait_ref: ty::TraitRef {
 318                 def_id: trait_did,
 319                 substs: infcx.tcx.mk_substs_trait(ty, &[]),
 320             },
 321         }));
 322
 323         let mut computed_preds: FxHashSet<_> = param_env.caller_bounds.iter().cloned().collect();
 324         let mut user_computed_preds: FxHashSet<_> =
 325             user_env.caller_bounds.iter().cloned().collect();
 326
 327         let mut new_env = param_env.clone();
 328         let dummy_cause = ObligationCause::misc(DUMMY_SP, ast::DUMMY_NODE_ID);
 329
 330         while let Some(pred) = predicates.pop_front() {
 331             infcx.clear_caches();
 332
 333             if !already_visited.insert(pred.clone()) {
 334                 continue;
 335             }
 336
 337             let result = select.select(&Obligation::new(dummy_cause.clone(), new_env, pred));
 338
 339             match &result {
 340                 &Ok(Some(ref vtable)) => {
 341                     // If we see an explicit negative impl (e.g. 'impl !Send for MyStruct'),
 342                     // we immediately bail out, since it's impossible for us to continue.
 343                     match vtable {
 344                         Vtable::VtableImpl(VtableImplData { impl_def_id, .. }) => {
 345                             // Blame tidy for the weird bracket placement
 346                             if infcx.tcx.impl_polarity(*impl_def_id) == hir::ImplPolarity::Negative
 347                             {
 348                                 debug!("evaluate_nested_obligations: Found explicit negative impl\
 349                                         {:?}, bailing out", impl_def_id);
 350                                 return None;
 351                             }
 352                         },
 353                         _ => {}
 354                     }
 355
 356                     let obligations = vtable.clone().nested_obligations().into_iter();
 357
 358                     if !self.evaluate_nested_obligations(
 359                         ty,
 360                         obligations,
 361                         &mut user_computed_preds,
 362                         fresh_preds,
 363                         &mut predicates,
 364                         &mut select,
 365                         only_projections,
 366                     ) {
 367                         return None;
 368                     }
 369                 }
 370                 &Ok(None) => {}
 371                 &Err(SelectionError::Unimplemented) => {
 372                     if self.is_of_param(pred.skip_binder().trait_ref.substs) {
 373                         already_visited.remove(&pred);
 374                         self.add_user_pred(
 375                             &mut user_computed_preds,
 376                             ty::Predicate::Trait(pred.clone()),
 377                         );
 378                         predicates.push_back(pred);
 379                     } else {
 380                         debug!(
 381                             "evaluate_nested_obligations: Unimplemented found, bailing: \
 382                              {:?} {:?} {:?}",
 383                             ty,
 384                             pred,
 385                             pred.skip_binder().trait_ref.substs
 386                         );
 387                         return None;
 388                     }
 389                 }
 390                 _ => panic!("Unexpected error for '{:?}': {:?}", ty, result),
 391             };
 392
 393             computed_preds.extend(user_computed_preds.iter().cloned());
 394             let normalized_preds =
 395                 elaborate_predicates(tcx, computed_preds.clone().into_iter().collect());
 396             new_env = ty::ParamEnv::new(tcx.mk_predicates(normalized_preds), param_env.reveal);
 397         }
 398
 399         let final_user_env = ty::ParamEnv::new(
 400             tcx.mk_predicates(user_computed_preds.into_iter()),
 401             user_env.reveal,
 402         );
 403         debug!(
 404             "evaluate_nested_obligations(ty_did={:?}, trait_did={:?}): succeeded with '{:?}' \
 405              '{:?}'",
 406             ty_did, trait_did, new_env, final_user_env
 407         );
 408
 409         return Some((new_env, final_user_env));
 410     }
 411
 412     // This method is designed to work around the following issue:
 413     // When we compute auto trait bounds, we repeatedly call SelectionContext.select,
 414     // progressively building a ParamEnv based on the results we get.
 415     // However, our usage of SelectionContext differs from its normal use within the compiler,
 416     // in that we capture and re-reprocess predicates from Unimplemented errors.
 417     //
 418     // This can lead to a corner case when dealing with region parameters.
 419     // During our selection loop in evaluate_predicates, we might end up with
 420     // two trait predicates that differ only in their region parameters:
 421     // one containing a HRTB lifetime parameter, and one containing a 'normal'
 422     // lifetime parameter. For example:
 423     //
 424     // T as MyTrait<'a>
 425     // T as MyTrait<'static>
 426     //
 427     // If we put both of these predicates in our computed ParamEnv, we'll
 428     // confuse SelectionContext, since it will (correctly) view both as being applicable.
 429     //
 430     // To solve this, we pick the 'more strict' lifetime bound - i.e. the HRTB
 431     // Our end goal is to generate a user-visible description of the conditions
 432     // under which a type implements an auto trait. A trait predicate involving
 433     // a HRTB means that the type needs to work with any choice of lifetime,
 434     // not just one specific lifetime (e.g. 'static).
 435     fn add_user_pred<'c>(
 436         &self,
 437         user_computed_preds: &mut FxHashSet<ty::Predicate<'c>>,
 438         new_pred: ty::Predicate<'c>,
 439     ) {
 440         let mut should_add_new = true;
 441         user_computed_preds.retain(|&old_pred| {
 442             match (&new_pred, old_pred) {
 443                 (&ty::Predicate::Trait(new_trait), ty::Predicate::Trait(old_trait)) => {
 444                     if new_trait.def_id() == old_trait.def_id() {
 445                         let new_substs = new_trait.skip_binder().trait_ref.substs;
 446                         let old_substs = old_trait.skip_binder().trait_ref.substs;
 447
 448                         if !new_substs.types().eq(old_substs.types()) {
 449                             // We can't compare lifetimes if the types are different,
 450                             // so skip checking old_pred
 451                             return true;
 452                         }
 453
 454                         for (new_region, old_region) in
 455                             new_substs.regions().zip(old_substs.regions())
 456                         {
 457                             match (new_region, old_region) {
 458                                 // If both predicates have an 'ReLateBound' (a HRTB) in the
 459                                 // same spot, we do nothing
 460                                 (
 461                                     ty::RegionKind::ReLateBound(_, _),
 462                                     ty::RegionKind::ReLateBound(_, _),
 463                                 ) => {}
 464
 465                                 (ty::RegionKind::ReLateBound(_, _), _) |
 466                                 (_, ty::RegionKind::ReVar(_)) => {
 467                                     // One of these is true:
 468                                     // The new predicate has a HRTB in a spot where the old
 469                                     // predicate does not (if they both had a HRTB, the previous
 470                                     // match arm would have executed). A HRBT is a 'stricter'
 471                                     // bound than anything else, so we want to keep the newer
 472                                     // predicate (with the HRBT) in place of the old predicate.
 473                                     //
 474                                     // OR
 475                                     //
 476                                     // The old predicate has a region variable where the new
 477                                     // predicate has some other kind of region. An region
 478                                     // variable isn't something we can actually display to a user,
 479                                     // so we choose ther new predicate (which doesn't have a region
 480                                     // varaible).
 481                                     //
 482                                     // In both cases, we want to remove the old predicate,
 483                                     // from user_computed_preds, and replace it with the new
 484                                     // one. Having both the old and the new
 485                                     // predicate in a ParamEnv would confuse SelectionContext
 486                                     //
 487                                     // We're currently in the predicate passed to 'retain',
 488                                     // so we return 'false' to remove the old predicate from
 489                                     // user_computed_preds
 490                                     return false;
 491                                 }
 492                                 (_, ty::RegionKind::ReLateBound(_, _)) |
 493                                 (ty::RegionKind::ReVar(_), _) => {
 494                                     // This is the opposite situation as the previous arm.
 495                                     // One of these is true:
 496                                     //
 497                                     // The old predicate has a HRTB lifetime in a place where the
 498                                     // new predicate does not.
 499                                     //
 500                                     // OR
 501                                     //
 502                                     // The new predicate has a region variable where the old
 503                                     // predicate has some other type of region.
 504                                     //
 505                                     // We want to leave the old
 506                                     // predicate in user_computed_preds, and skip adding
 507                                     // new_pred to user_computed_params.
 508                                     should_add_new = false
 509                                 },
 510                                 _ => {}
 511                             }
 512                         }
 513                     }
 514                 }
 515                 _ => {}
 516             }
 517             return true;
 518         });
 519
 520         if should_add_new {
 521             user_computed_preds.insert(new_pred);
 522         }
 523     }
 524
 525     pub fn region_name(&self, region: Region<'_>) -> Option<String> {
 526         match region {
 527             &ty::ReEarlyBound(r) => Some(r.name.to_string()),
 528             _ => None,
 529         }
 530     }
 531
 532     pub fn get_lifetime(&self, region: Region<'_>,
 533                         names_map: &FxHashMap<String, String>) -> String {
 534         self.region_name(region)
 535             .map(|name|
 536                 names_map.get(&name).unwrap_or_else(||
 537                     panic!("Missing lifetime with name {:?} for {:?}", name, region)
 538                 )
 539             )
 540             .cloned()
 541             .unwrap_or_else(|| "'static".to_owned())
 542     }
 543
 544     // This is very similar to handle_lifetimes. However, instead of matching ty::Region's
 545     // to each other, we match ty::RegionVid's to ty::Region's
 546     pub fn map_vid_to_region<'cx>(
 547         &self,
 548         regions: &RegionConstraintData<'cx>,
 549     ) -> FxHashMap<ty::RegionVid, ty::Region<'cx>> {
 550         let mut vid_map: FxHashMap<RegionTarget<'cx>, RegionDeps<'cx>> = FxHashMap::default();
 551         let mut finished_map = FxHashMap::default();
 552
 553         for constraint in regions.constraints.keys() {
 554             match constraint {
 555                 &Constraint::VarSubVar(r1, r2) => {
 556                     {
 557                         let deps1 = vid_map.entry(RegionTarget::RegionVid(r1)).or_default();
 558                         deps1.larger.insert(RegionTarget::RegionVid(r2));
 559                     }
 560
 561                     let deps2 = vid_map.entry(RegionTarget::RegionVid(r2)).or_default();
 562                     deps2.smaller.insert(RegionTarget::RegionVid(r1));
 563                 }
 564                 &Constraint::RegSubVar(region, vid) => {
 565                     {
 566                         let deps1 = vid_map.entry(RegionTarget::Region(region)).or_default();
 567                         deps1.larger.insert(RegionTarget::RegionVid(vid));
 568                     }
 569
 570                     let deps2 = vid_map.entry(RegionTarget::RegionVid(vid)).or_default();
 571                     deps2.smaller.insert(RegionTarget::Region(region));
 572                 }
 573                 &Constraint::VarSubReg(vid, region) => {
 574                     finished_map.insert(vid, region);
 575                 }
 576                 &Constraint::RegSubReg(r1, r2) => {
 577                     {
 578                         let deps1 = vid_map.entry(RegionTarget::Region(r1)).or_default();
 579                         deps1.larger.insert(RegionTarget::Region(r2));
 580                     }
 581
 582                     let deps2 = vid_map.entry(RegionTarget::Region(r2)).or_default();
 583                     deps2.smaller.insert(RegionTarget::Region(r1));
 584                 }
 585             }
 586         }
 587
 588         while !vid_map.is_empty() {
 589             let target = vid_map.keys().next().expect("Keys somehow empty").clone();
 590             let deps = vid_map.remove(&target).expect("Entry somehow missing");
 591
 592             for smaller in deps.smaller.iter() {
 593                 for larger in deps.larger.iter() {
 594                     match (smaller, larger) {
 595                         (&RegionTarget::Region(_), &RegionTarget::Region(_)) => {
 596                             if let Entry::Occupied(v) = vid_map.entry(*smaller) {
 597                                 let smaller_deps = v.into_mut();
 598                                 smaller_deps.larger.insert(*larger);
 599                                 smaller_deps.larger.remove(&target);
 600                             }
 601
 602                             if let Entry::Occupied(v) = vid_map.entry(*larger) {
 603                                 let larger_deps = v.into_mut();
 604                                 larger_deps.smaller.insert(*smaller);
 605                                 larger_deps.smaller.remove(&target);
 606                             }
 607                         }
 608                         (&RegionTarget::RegionVid(v1), &RegionTarget::Region(r1)) => {
 609                             finished_map.insert(v1, r1);
 610                         }
 611                         (&RegionTarget::Region(_), &RegionTarget::RegionVid(_)) => {
 612                             // Do nothing - we don't care about regions that are smaller than vids
 613                         }
 614                         (&RegionTarget::RegionVid(_), &RegionTarget::RegionVid(_)) => {
 615                             if let Entry::Occupied(v) = vid_map.entry(*smaller) {
 616                                 let smaller_deps = v.into_mut();
 617                                 smaller_deps.larger.insert(*larger);
 618                                 smaller_deps.larger.remove(&target);
 619                             }
 620
 621                             if let Entry::Occupied(v) = vid_map.entry(*larger) {
 622                                 let larger_deps = v.into_mut();
 623                                 larger_deps.smaller.insert(*smaller);
 624                                 larger_deps.smaller.remove(&target);
 625                             }
 626                         }
 627                     }
 628                 }
 629             }
 630         }
 631         finished_map
 632     }
 633
 634     pub fn is_of_param(&self, substs: &Substs<'_>) -> bool {
 635         if substs.is_noop() {
 636             return false;
 637         }
 638
 639         return match substs.type_at(0).sty {
 640             ty::Param(_) => true,
 641             ty::Projection(p) => self.is_of_param(p.substs),
 642             _ => false,
 643         };
 644     }
 645
 646     pub fn evaluate_nested_obligations<
 647         'b,
 648         'c,
 649         'd,
 650         'cx,
 651         T: Iterator<Item = Obligation<'cx, ty::Predicate<'cx>>>,
 652     >(
 653         &self,
 654         ty: ty::Ty<'_>,
 655         nested: T,
 656         computed_preds: &'b mut FxHashSet<ty::Predicate<'cx>>,
 657         fresh_preds: &'b mut FxHashSet<ty::Predicate<'cx>>,
 658         predicates: &'b mut VecDeque<ty::PolyTraitPredicate<'cx>>,
 659         select: &mut SelectionContext<'c, 'd, 'cx>,
 660         only_projections: bool,
 661     ) -> bool {
 662         let dummy_cause = ObligationCause::misc(DUMMY_SP, ast::DUMMY_NODE_ID);
 663
 664         for (obligation, predicate) in nested
 665             .filter(|o| o.recursion_depth == 1)
 666             .map(|o| (o.clone(), o.predicate.clone()))
 667         {
 668             let is_new_pred =
 669                 fresh_preds.insert(self.clean_pred(select.infcx(), predicate.clone()));
 670
 671             match &predicate {
 672                 &ty::Predicate::Trait(ref p) => {
 673                     let substs = &p.skip_binder().trait_ref.substs;
 674
 675                     if self.is_of_param(substs) && !only_projections && is_new_pred {
 676                         self.add_user_pred(computed_preds, predicate);
 677                     }
 678                     predicates.push_back(p.clone());
 679                 }
 680                 &ty::Predicate::Projection(p) => {
 681                     // If the projection isn't all type vars, then
 682                     // we don't want to add it as a bound
 683                     if self.is_of_param(p.skip_binder().projection_ty.substs) && is_new_pred {
 684                         self.add_user_pred(computed_preds, predicate);
 685                     } else {
 686                         match poly_project_and_unify_type(select, &obligation.with(p.clone())) {
 687                             Err(e) => {
 688                                 debug!(
 689                                     "evaluate_nested_obligations: Unable to unify predicate \
 690                                      '{:?}' '{:?}', bailing out",
 691                                     ty, e
 692                                 );
 693                                 return false;
 694                             }
 695                             Ok(Some(v)) => {
 696                                 if !self.evaluate_nested_obligations(
 697                                     ty,
 698                                     v.clone().iter().cloned(),
 699                                     computed_preds,
 700                                     fresh_preds,
 701                                     predicates,
 702                                     select,
 703                                     only_projections,
 704                                 ) {
 705                                     return false;
 706                                 }
 707                             }
 708                             Ok(None) => {
 709                                 panic!("Unexpected result when selecting {:?} {:?}", ty, obligation)
 710                             }
 711                         }
 712                     }
 713                 }
 714                 &ty::Predicate::RegionOutlives(ref binder) => {
 715                     if select
 716                         .infcx()
 717                         .region_outlives_predicate(&dummy_cause, binder)
 718                         .is_err()
 719                     {
 720                         return false;
 721                     }
 722                 }
 723                 &ty::Predicate::TypeOutlives(ref binder) => {
 724                     match (
 725                         binder.no_bound_vars(),
 726                         binder.map_bound_ref(|pred| pred.0).no_bound_vars(),
 727                     ) {
 728                         (None, Some(t_a)) => {
 729                             select.infcx().register_region_obligation_with_cause(
 730                                 t_a,
 731                                 select.infcx().tcx.types.re_static,
 732                                 &dummy_cause,
 733                             );
 734                         }
 735                         (Some(ty::OutlivesPredicate(t_a, r_b)), _) => {
 736                             select.infcx().register_region_obligation_with_cause(
 737                                 t_a,
 738                                 r_b,
 739                                 &dummy_cause,
 740                             );
 741                         }
 742                         _ => {}
 743                     };
 744                 }
 745                 _ => panic!("Unexpected predicate {:?} {:?}", ty, predicate),
 746             };
 747         }
 748         return true;
 749     }
 750
 751     pub fn clean_pred<'c, 'd, 'cx>(
 752         &self,
 753         infcx: &InferCtxt<'c, 'd, 'cx>,
 754         p: ty::Predicate<'cx>,
 755     ) -> ty::Predicate<'cx> {
 756         infcx.freshen(p)
 757     }
 758 }
 759
 760 // Replaces all ReVars in a type with ty::Region's, using the provided map
 761 pub struct RegionReplacer<'a, 'gcx: 'a + 'tcx, 'tcx: 'a> {
 762     vid_to_region: &'a FxHashMap<ty::RegionVid, ty::Region<'tcx>>,
 763     tcx: TyCtxt<'a, 'gcx, 'tcx>,
 764 }
 765
 766 impl<'a, 'gcx, 'tcx> TypeFolder<'gcx, 'tcx> for RegionReplacer<'a, 'gcx, 'tcx> {
 767     fn tcx<'b>(&'b self) -> TyCtxt<'b, 'gcx, 'tcx> {
 768         self.tcx
 769     }
 770
 771     fn fold_region(&mut self, r: ty::Region<'tcx>) -> ty::Region<'tcx> {
 772         (match r {
 773             &ty::ReVar(vid) => self.vid_to_region.get(&vid).cloned(),
 774             _ => None,
 775         }).unwrap_or_else(|| r.super_fold_with(self))
 776     }
 777 }