src/librustc_mir/transform/qualify_min_const_fn.rs

   1 use rustc::hir::def_id::DefId;
   2 use rustc::hir;
   3 use rustc::mir::*;
   4 use rustc::ty::{self, Predicate, Ty, TyCtxt, adjustment::{PointerCast}};
   5 use rustc_target::spec::abi;
   6 use std::borrow::Cow;
   7 use syntax_pos::Span;
   8 use syntax::symbol::{sym, Symbol};
   9 use syntax::attr;
  10
  11 type McfResult = Result<(), (Span, Cow<'static, str>)>;
  12
  13 pub fn is_min_const_fn(tcx: TyCtxt<'tcx>, def_id: DefId, body: &'a Body<'tcx>) -> McfResult {
  14     let mut current = def_id;
  15     loop {
  16         let predicates = tcx.predicates_of(current);
  17         for (predicate, _) in predicates.predicates {
  18             match predicate {
  19                 | Predicate::RegionOutlives(_)
  20                 | Predicate::TypeOutlives(_)
  21                 | Predicate::WellFormed(_)
  22                 | Predicate::Projection(_)
  23                 | Predicate::ConstEvaluatable(..) => continue,
  24                 | Predicate::ObjectSafe(_) => {
  25                     bug!("object safe predicate on function: {:#?}", predicate)
  26                 }
  27                 Predicate::ClosureKind(..) => {
  28                     bug!("closure kind predicate on function: {:#?}", predicate)
  29                 }
  30                 Predicate::Subtype(_) => bug!("subtype predicate on function: {:#?}", predicate),
  31                 Predicate::Trait(pred) => {
  32                     if Some(pred.def_id()) == tcx.lang_items().sized_trait() {
  33                         continue;
  34                     }
  35                     match pred.skip_binder().self_ty().kind {
  36                         ty::Param(ref p) => {
  37                             let generics = tcx.generics_of(current);
  38                             let def = generics.type_param(p, tcx);
  39                             let span = tcx.def_span(def.def_id);
  40                             return Err((
  41                                 span,
  42                                 "trait bounds other than `Sized` \
  43                                  on const fn parameters are unstable"
  44                                     .into(),
  45                             ));
  46                         }
  47                         // other kinds of bounds are either tautologies
  48                         // or cause errors in other passes
  49                         _ => continue,
  50                     }
  51                 }
  52             }
  53         }
  54         match predicates.parent {
  55             Some(parent) => current = parent,
  56             None => break,
  57         }
  58     }
  59
  60     for local in &body.local_decls {
  61         check_ty(tcx, local.ty, local.source_info.span, def_id)?;
  62     }
  63     // impl trait is gone in MIR, so check the return type manually
  64     check_ty(
  65         tcx,
  66         tcx.fn_sig(def_id).output().skip_binder(),
  67         body.local_decls.iter().next().unwrap().source_info.span,
  68         def_id,
  69     )?;
  70
  71     for bb in body.basic_blocks() {
  72         check_terminator(tcx, body, def_id, bb.terminator())?;
  73         for stmt in &bb.statements {
  74             check_statement(tcx, body, def_id, stmt)?;
  75         }
  76     }
  77     Ok(())
  78 }
  79
  80 fn check_ty(tcx: TyCtxt<'tcx>, ty: Ty<'tcx>, span: Span, fn_def_id: DefId) -> McfResult {
  81     for ty in ty.walk() {
  82         match ty.kind {
  83             ty::Ref(_, _, hir::Mutability::Mutable) => return Err((
  84                 span,
  85                 "mutable references in const fn are unstable".into(),
  86             )),
  87             ty::Opaque(..) => return Err((span, "`impl Trait` in const fn is unstable".into())),
  88             ty::FnPtr(..) => {
  89                 if !tcx.const_fn_is_allowed_fn_ptr(fn_def_id) {
  90                     return Err((span, "function pointers in const fn are unstable".into()))
  91                 }
  92             }
  93             ty::Dynamic(preds, _) => {
  94                 for pred in preds.iter() {
  95                     match pred.skip_binder() {
  96                         | ty::ExistentialPredicate::AutoTrait(_)
  97                         | ty::ExistentialPredicate::Projection(_) => {
  98                             return Err((
  99                                 span,
 100                                 "trait bounds other than `Sized` \
 101                                  on const fn parameters are unstable"
 102                                     .into(),
 103                             ))
 104                         }
 105                         ty::ExistentialPredicate::Trait(trait_ref) => {
 106                             if Some(trait_ref.def_id) != tcx.lang_items().sized_trait() {
 107                                 return Err((
 108                                     span,
 109                                     "trait bounds other than `Sized` \
 110                                      on const fn parameters are unstable"
 111                                         .into(),
 112                                 ));
 113                             }
 114                         }
 115                     }
 116                 }
 117             }
 118             _ => {}
 119         }
 120     }
 121     Ok(())
 122 }
 123
 124 fn check_rvalue(
 125     tcx: TyCtxt<'tcx>,
 126     body: &Body<'tcx>,
 127     def_id: DefId,
 128     rvalue: &Rvalue<'tcx>,
 129     span: Span,
 130 ) -> McfResult {
 131     match rvalue {
 132         Rvalue::Repeat(operand, _) | Rvalue::Use(operand) => {
 133             check_operand(tcx, operand, span, def_id, body)
 134         }
 135         Rvalue::Len(place) | Rvalue::Discriminant(place) | Rvalue::Ref(_, _, place) => {
 136             check_place(tcx, place, span, def_id, body)
 137         }
 138         Rvalue::Cast(CastKind::Misc, operand, cast_ty) => {
 139             use rustc::ty::cast::CastTy;
 140             let cast_in = CastTy::from_ty(operand.ty(body, tcx)).expect("bad input type for cast");
 141             let cast_out = CastTy::from_ty(cast_ty).expect("bad output type for cast");
 142             match (cast_in, cast_out) {
 143                 (CastTy::Ptr(_), CastTy::Int(_)) | (CastTy::FnPtr, CastTy::Int(_)) => Err((
 144                     span,
 145                     "casting pointers to ints is unstable in const fn".into(),
 146                 )),
 147                 (CastTy::RPtr(_), CastTy::Float) => bug!(),
 148                 (CastTy::RPtr(_), CastTy::Int(_)) => bug!(),
 149                 (CastTy::Ptr(_), CastTy::RPtr(_)) => bug!(),
 150                 _ => check_operand(tcx, operand, span, def_id, body),
 151             }
 152         }
 153         Rvalue::Cast(CastKind::Pointer(PointerCast::MutToConstPointer), operand, _)
 154         | Rvalue::Cast(CastKind::Pointer(PointerCast::ArrayToPointer), operand, _) => {
 155             check_operand(tcx, operand, span, def_id, body)
 156         }
 157         Rvalue::Cast(CastKind::Pointer(PointerCast::UnsafeFnPointer), _, _) |
 158         Rvalue::Cast(CastKind::Pointer(PointerCast::ClosureFnPointer(_)), _, _) |
 159         Rvalue::Cast(CastKind::Pointer(PointerCast::ReifyFnPointer), _, _) => Err((
 160             span,
 161             "function pointer casts are not allowed in const fn".into(),
 162         )),
 163         Rvalue::Cast(CastKind::Pointer(PointerCast::Unsize), _, _) => Err((
 164             span,
 165             "unsizing casts are not allowed in const fn".into(),
 166         )),
 167         // binops are fine on integers
 168         Rvalue::BinaryOp(_, lhs, rhs) | Rvalue::CheckedBinaryOp(_, lhs, rhs) => {
 169             check_operand(tcx, lhs, span, def_id, body)?;
 170             check_operand(tcx, rhs, span, def_id, body)?;
 171             let ty = lhs.ty(body, tcx);
 172             if ty.is_integral() || ty.is_bool() || ty.is_char() {
 173                 Ok(())
 174             } else {
 175                 Err((
 176                     span,
 177                     "only int, `bool` and `char` operations are stable in const fn".into(),
 178                 ))
 179             }
 180         }
 181         Rvalue::NullaryOp(NullOp::SizeOf, _) => Ok(()),
 182         Rvalue::NullaryOp(NullOp::Box, _) => Err((
 183             span,
 184             "heap allocations are not allowed in const fn".into(),
 185         )),
 186         Rvalue::UnaryOp(_, operand) => {
 187             let ty = operand.ty(body, tcx);
 188             if ty.is_integral() || ty.is_bool() {
 189                 check_operand(tcx, operand, span, def_id, body)
 190             } else {
 191                 Err((
 192                     span,
 193                     "only int and `bool` operations are stable in const fn".into(),
 194                 ))
 195             }
 196         }
 197         Rvalue::Aggregate(_, operands) => {
 198             for operand in operands {
 199                 check_operand(tcx, operand, span, def_id, body)?;
 200             }
 201             Ok(())
 202         }
 203     }
 204 }
 205
 206 fn check_statement(
 207     tcx: TyCtxt<'tcx>,
 208     body: &Body<'tcx>,
 209     def_id: DefId,
 210     statement: &Statement<'tcx>,
 211 ) -> McfResult {
 212     let span = statement.source_info.span;
 213     match &statement.kind {
 214         StatementKind::Assign(box(place, rval)) => {
 215             check_place(tcx, place, span, def_id, body)?;
 216             check_rvalue(tcx, body, def_id, rval, span)
 217         }
 218
 219         StatementKind::FakeRead(FakeReadCause::ForMatchedPlace, _) => {
 220             Err((span, "loops and conditional expressions are not stable in const fn".into()))
 221         }
 222
 223         StatementKind::FakeRead(_, place) => check_place(tcx, place, span, def_id, body),
 224
 225         // just an assignment
 226         StatementKind::SetDiscriminant { .. } => Ok(()),
 227
 228         | StatementKind::InlineAsm { .. } => {
 229             Err((span, "cannot use inline assembly in const fn".into()))
 230         }
 231
 232         // These are all NOPs
 233         | StatementKind::StorageLive(_)
 234         | StatementKind::StorageDead(_)
 235         | StatementKind::Retag { .. }
 236         | StatementKind::AscribeUserType(..)
 237         | StatementKind::Nop => Ok(()),
 238     }
 239 }
 240
 241 fn check_operand(
 242     tcx: TyCtxt<'tcx>,
 243     operand: &Operand<'tcx>,
 244     span: Span,
 245     def_id: DefId,
 246     body: &Body<'tcx>
 247 ) -> McfResult {
 248     match operand {
 249         Operand::Move(place) | Operand::Copy(place) => {
 250             check_place(tcx, place, span, def_id, body)
 251         }
 252         Operand::Constant(c) => match c.check_static_ptr(tcx) {
 253             Some(_) => Err((span, "cannot access `static` items in const fn".into())),
 254             None => Ok(()),
 255         },
 256     }
 257 }
 258
 259 fn check_place(
 260     tcx: TyCtxt<'tcx>,
 261     place: &Place<'tcx>,
 262     span: Span,
 263     def_id: DefId,
 264     body: &Body<'tcx>
 265 ) -> McfResult {
 266     let mut cursor = place.projection.as_ref();
 267     while let &[ref proj_base @ .., elem] = cursor {
 268         cursor = proj_base;
 269         match elem {
 270             ProjectionElem::Downcast(..) => {
 271                 return Err((span, "`match` or `if let` in `const fn` is unstable".into()));
 272             }
 273             ProjectionElem::Field(..) => {
 274                 let base_ty = Place::ty_from(&place.base, &proj_base, body, tcx).ty;
 275                 if let Some(def) = base_ty.ty_adt_def() {
 276                     // No union field accesses in `const fn`
 277                     if def.is_union() {
 278                         if !feature_allowed(tcx, def_id, sym::const_fn_union) {
 279                             return Err((span, "accessing union fields is unstable".into()));
 280                         }
 281                     }
 282                 }
 283             }
 284             ProjectionElem::ConstantIndex { .. }
 285             | ProjectionElem::Subslice { .. }
 286             | ProjectionElem::Deref
 287             | ProjectionElem::Index(_) => {}
 288         }
 289     }
 290
 291     Ok(())
 292 }
 293
 294 /// Returns whether `allow_internal_unstable(..., <feature_gate>, ...)` is present.
 295 fn feature_allowed(
 296     tcx: TyCtxt<'tcx>,
 297     def_id: DefId,
 298     feature_gate: Symbol,
 299 ) -> bool {
 300     attr::allow_internal_unstable(&tcx.get_attrs(def_id), &tcx.sess.diagnostic())
 301         .map_or(false, |mut features| features.any(|name| name == feature_gate))
 302 }
 303
 304 fn check_terminator(
 305     tcx: TyCtxt<'tcx>,
 306     body: &'a Body<'tcx>,
 307     def_id: DefId,
 308     terminator: &Terminator<'tcx>,
 309 ) -> McfResult {
 310     let span = terminator.source_info.span;
 311     match &terminator.kind {
 312         | TerminatorKind::Goto { .. }
 313         | TerminatorKind::Return
 314         | TerminatorKind::Resume => Ok(()),
 315
 316         TerminatorKind::Drop { location, .. } => {
 317             check_place(tcx, location, span, def_id, body)
 318         }
 319         TerminatorKind::DropAndReplace { location, value, .. } => {
 320             check_place(tcx, location, span, def_id, body)?;
 321             check_operand(tcx, value, span, def_id, body)
 322         },
 323
 324         TerminatorKind::FalseEdges { .. } | TerminatorKind::SwitchInt { .. } => Err((
 325             span,
 326             "loops and conditional expressions are not stable in const fn".into(),
 327         )),
 328         | TerminatorKind::Abort | TerminatorKind::Unreachable => {
 329             Err((span, "const fn with unreachable code is not stable".into()))
 330         }
 331         | TerminatorKind::GeneratorDrop | TerminatorKind::Yield { .. } => {
 332             Err((span, "const fn generators are unstable".into()))
 333         }
 334
 335         TerminatorKind::Call {
 336             func,
 337             args,
 338             from_hir_call: _,
 339             destination: _,
 340             cleanup: _,
 341         } => {
 342             let fn_ty = func.ty(body, tcx);
 343             if let ty::FnDef(def_id, _) = fn_ty.kind {
 344
 345                 // some intrinsics are waved through if called inside the
 346                 // standard library. Users never need to call them directly
 347                 match tcx.fn_sig(def_id).abi() {
 348                     abi::Abi::RustIntrinsic => if !is_intrinsic_whitelisted(tcx, def_id) {
 349                         return Err((
 350                             span,
 351                             "can only call a curated list of intrinsics in `min_const_fn`".into(),
 352                         ))
 353                     },
 354                     abi::Abi::Rust if tcx.is_min_const_fn(def_id) => {},
 355                     abi::Abi::Rust => return Err((
 356                         span,
 357                         format!(
 358                             "can only call other `const fn` within a `const fn`, \
 359                              but `{:?}` is not stable as `const fn`",
 360                             func,
 361                         )
 362                         .into(),
 363                     )),
 364                     abi => return Err((
 365                         span,
 366                         format!(
 367                             "cannot call functions with `{}` abi in `min_const_fn`",
 368                             abi,
 369                         ).into(),
 370                     )),
 371                 }
 372
 373                 check_operand(tcx, func, span, def_id, body)?;
 374
 375                 for arg in args {
 376                     check_operand(tcx, arg, span, def_id, body)?;
 377                 }
 378                 Ok(())
 379             } else {
 380                 Err((span, "can only call other const fns within const fn".into()))
 381             }
 382         }
 383
 384         TerminatorKind::Assert {
 385             cond,
 386             expected: _,
 387             msg: _,
 388             target: _,
 389             cleanup: _,
 390         } => check_operand(tcx, cond, span, def_id, body),
 391
 392         TerminatorKind::FalseUnwind { .. } => {
 393             Err((span, "loops are not allowed in const fn".into()))
 394         },
 395     }
 396 }
 397
 398 /// Returns `true` if the `def_id` refers to an intrisic which we've whitelisted
 399 /// for being called from stable `const fn`s (`min_const_fn`).
 400 ///
 401 /// Adding more intrinsics requires sign-off from @rust-lang/lang.
 402 fn is_intrinsic_whitelisted(tcx: TyCtxt<'tcx>, def_id: DefId) -> bool {
 403     match &*tcx.item_name(def_id).as_str() {
 404         | "size_of"
 405         | "min_align_of"
 406         | "needs_drop"
 407         // Arithmetic:
 408         | "add_with_overflow" // ~> .overflowing_add
 409         | "sub_with_overflow" // ~> .overflowing_sub
 410         | "mul_with_overflow" // ~> .overflowing_mul
 411         | "wrapping_add" // ~> .wrapping_add
 412         | "wrapping_sub" // ~> .wrapping_sub
 413         | "wrapping_mul" // ~> .wrapping_mul
 414         | "saturating_add" // ~> .saturating_add
 415         | "saturating_sub" // ~> .saturating_sub
 416         | "unchecked_shl" // ~> .wrapping_shl
 417         | "unchecked_shr" // ~> .wrapping_shr
 418         | "rotate_left" // ~> .rotate_left
 419         | "rotate_right" // ~> .rotate_right
 420         | "ctpop" // ~> .count_ones
 421         | "ctlz" // ~> .leading_zeros
 422         | "cttz" // ~> .trailing_zeros
 423         | "bswap" // ~> .swap_bytes
 424         | "bitreverse" // ~> .reverse_bits
 425         => true,
 426         _ => false,
 427     }
 428 }