]> git.lizzy.rs Git - rust.git/blob - src/librustc_mir/transform/qualify_min_const_fn.rs
83bde5ed34eaeca6f080407088b17b28bd70de8d
[rust.git] / 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(_) => Ok(()),
253     }
254 }
255
256 fn check_place(
257     tcx: TyCtxt<'tcx>,
258     place: &Place<'tcx>,
259     span: Span,
260     def_id: DefId,
261     body: &Body<'tcx>
262 ) -> McfResult {
263     let mut cursor = place.projection.as_ref();
264     while let &[ref proj_base @ .., elem] = cursor {
265         cursor = proj_base;
266         match elem {
267             ProjectionElem::Downcast(..) => {
268                 return Err((span, "`match` or `if let` in `const fn` is unstable".into()));
269             }
270             ProjectionElem::Field(..) => {
271                 let base_ty = Place::ty_from(&place.base, &proj_base, body, tcx).ty;
272                 if let Some(def) = base_ty.ty_adt_def() {
273                     // No union field accesses in `const fn`
274                     if def.is_union() {
275                         if !feature_allowed(tcx, def_id, sym::const_fn_union) {
276                             return Err((span, "accessing union fields is unstable".into()));
277                         }
278                     }
279                 }
280             }
281             ProjectionElem::ConstantIndex { .. }
282             | ProjectionElem::Subslice { .. }
283             | ProjectionElem::Deref
284             | ProjectionElem::Index(_) => {}
285         }
286     }
287
288     match place.base {
289         PlaceBase::Static(box Static { kind: StaticKind::Static, .. }) => {
290             Err((span, "cannot access `static` items in const fn".into()))
291         }
292         PlaceBase::Local(_)
293         | PlaceBase::Static(box Static { kind: StaticKind::Promoted(_, _), .. }) => Ok(()),
294     }
295 }
296
297 /// Returns whether `allow_internal_unstable(..., <feature_gate>, ...)` is present.
298 fn feature_allowed(
299     tcx: TyCtxt<'tcx>,
300     def_id: DefId,
301     feature_gate: Symbol,
302 ) -> bool {
303     attr::allow_internal_unstable(&tcx.get_attrs(def_id), &tcx.sess.diagnostic())
304         .map_or(false, |mut features| features.any(|name| name == feature_gate))
305 }
306
307 fn check_terminator(
308     tcx: TyCtxt<'tcx>,
309     body: &'a Body<'tcx>,
310     def_id: DefId,
311     terminator: &Terminator<'tcx>,
312 ) -> McfResult {
313     let span = terminator.source_info.span;
314     match &terminator.kind {
315         | TerminatorKind::Goto { .. }
316         | TerminatorKind::Return
317         | TerminatorKind::Resume => Ok(()),
318
319         TerminatorKind::Drop { location, .. } => {
320             check_place(tcx, location, span, def_id, body)
321         }
322         TerminatorKind::DropAndReplace { location, value, .. } => {
323             check_place(tcx, location, span, def_id, body)?;
324             check_operand(tcx, value, span, def_id, body)
325         },
326
327         TerminatorKind::FalseEdges { .. } | TerminatorKind::SwitchInt { .. } => Err((
328             span,
329             "loops and conditional expressions are not stable in const fn".into(),
330         )),
331         | TerminatorKind::Abort | TerminatorKind::Unreachable => {
332             Err((span, "const fn with unreachable code is not stable".into()))
333         }
334         | TerminatorKind::GeneratorDrop | TerminatorKind::Yield { .. } => {
335             Err((span, "const fn generators are unstable".into()))
336         }
337
338         TerminatorKind::Call {
339             func,
340             args,
341             from_hir_call: _,
342             destination: _,
343             cleanup: _,
344         } => {
345             let fn_ty = func.ty(body, tcx);
346             if let ty::FnDef(def_id, _) = fn_ty.kind {
347
348                 // some intrinsics are waved through if called inside the
349                 // standard library. Users never need to call them directly
350                 match tcx.fn_sig(def_id).abi() {
351                     abi::Abi::RustIntrinsic => if !is_intrinsic_whitelisted(tcx, def_id) {
352                         return Err((
353                             span,
354                             "can only call a curated list of intrinsics in `min_const_fn`".into(),
355                         ))
356                     },
357                     abi::Abi::Rust if tcx.is_min_const_fn(def_id) => {},
358                     abi::Abi::Rust => return Err((
359                         span,
360                         format!(
361                             "can only call other `const fn` within a `const fn`, \
362                              but `{:?}` is not stable as `const fn`",
363                             func,
364                         )
365                         .into(),
366                     )),
367                     abi => return Err((
368                         span,
369                         format!(
370                             "cannot call functions with `{}` abi in `min_const_fn`",
371                             abi,
372                         ).into(),
373                     )),
374                 }
375
376                 check_operand(tcx, func, span, def_id, body)?;
377
378                 for arg in args {
379                     check_operand(tcx, arg, span, def_id, body)?;
380                 }
381                 Ok(())
382             } else {
383                 Err((span, "can only call other const fns within const fn".into()))
384             }
385         }
386
387         TerminatorKind::Assert {
388             cond,
389             expected: _,
390             msg: _,
391             target: _,
392             cleanup: _,
393         } => check_operand(tcx, cond, span, def_id, body),
394
395         TerminatorKind::FalseUnwind { .. } => {
396             Err((span, "loops are not allowed in const fn".into()))
397         },
398     }
399 }
400
401 /// Returns `true` if the `def_id` refers to an intrisic which we've whitelisted
402 /// for being called from stable `const fn`s (`min_const_fn`).
403 ///
404 /// Adding more intrinsics requires sign-off from @rust-lang/lang.
405 fn is_intrinsic_whitelisted(tcx: TyCtxt<'tcx>, def_id: DefId) -> bool {
406     match &*tcx.item_name(def_id).as_str() {
407         | "size_of"
408         | "min_align_of"
409         | "needs_drop"
410         // Arithmetic:
411         | "add_with_overflow" // ~> .overflowing_add
412         | "sub_with_overflow" // ~> .overflowing_sub
413         | "mul_with_overflow" // ~> .overflowing_mul
414         | "wrapping_add" // ~> .wrapping_add
415         | "wrapping_sub" // ~> .wrapping_sub
416         | "wrapping_mul" // ~> .wrapping_mul
417         | "saturating_add" // ~> .saturating_add
418         | "saturating_sub" // ~> .saturating_sub
419         | "unchecked_shl" // ~> .wrapping_shl
420         | "unchecked_shr" // ~> .wrapping_shr
421         | "rotate_left" // ~> .rotate_left
422         | "rotate_right" // ~> .rotate_right
423         | "ctpop" // ~> .count_ones
424         | "ctlz" // ~> .leading_zeros
425         | "cttz" // ~> .trailing_zeros
426         | "bswap" // ~> .swap_bytes
427         | "bitreverse" // ~> .reverse_bits
428         => true,
429         _ => false,
430     }
431 }