1 //! Code for type-checking cast expressions.
3 //! A cast `e as U` is valid if one of the following holds:
4 //! * `e` has type `T` and `T` coerces to `U`; *coercion-cast*
5 //! * `e` has type `*T`, `U` is `*U_0`, and either `U_0: Sized` or
6 //! pointer_kind(`T`) = pointer_kind(`U_0`); *ptr-ptr-cast*
7 //! * `e` has type `*T` and `U` is a numeric type, while `T: Sized`; *ptr-addr-cast*
8 //! * `e` is an integer and `U` is `*U_0`, while `U_0: Sized`; *addr-ptr-cast*
9 //! * `e` has type `T` and `T` and `U` are any numeric types; *numeric-cast*
10 //! * `e` is a C-like enum and `U` is an integer type; *enum-cast*
11 //! * `e` has type `bool` or `char` and `U` is an integer; *prim-int-cast*
12 //! * `e` has type `u8` and `U` is `char`; *u8-char-cast*
13 //! * `e` has type `&[T; n]` and `U` is `*const T`; *array-ptr-cast*
14 //! * `e` is a function pointer type and `U` has type `*T`,
15 //! while `T: Sized`; *fptr-ptr-cast*
16 //! * `e` is a function pointer type and `U` is an integer; *fptr-addr-cast*
18 //! where `&.T` and `*T` are references of either mutability,
19 //! and where pointer_kind(`T`) is the kind of the unsize info
20 //! in `T` - the vtable for a trait definition (e.g., `fmt::Display` or
21 //! `Iterator`, not `Iterator<Item=u8>`) or a length (or `()` if `T: Sized`).
23 //! Note that lengths are not adjusted when casting raw slices -
24 //! `T: *const [u16] as *const [u8]` creates a slice that only includes
25 //! half of the original memory.
27 //! Casting is not transitive, that is, even if `e as U1 as U2` is a valid
28 //! expression, `e as U2` is not necessarily so (in fact it will only be valid if
29 //! `U1` coerces to `U2`).
33 use crate::hir::def_id::DefId;
34 use crate::type_error_struct;
36 use rustc_errors::{struct_span_err, Applicability, DiagnosticBuilder, ErrorReported};
38 use rustc_hir::lang_items;
39 use rustc_middle::ty::adjustment::AllowTwoPhase;
40 use rustc_middle::ty::cast::{CastKind, CastTy};
41 use rustc_middle::ty::error::TypeError;
42 use rustc_middle::ty::subst::SubstsRef;
43 use rustc_middle::ty::{self, Ty, TypeAndMut, TypeFoldable};
44 use rustc_session::lint;
45 use rustc_session::Session;
46 use rustc_span::symbol::sym;
48 use rustc_trait_selection::traits;
49 use rustc_trait_selection::traits::error_reporting::report_object_safety_error;
51 /// Reifies a cast check to be checked once we have full type information for
52 /// a function context.
53 pub struct CastCheck<'tcx> {
54 expr: &'tcx hir::Expr<'tcx>,
61 /// The kind of pointer and associated metadata (thin, length or vtable) - we
62 /// only allow casts between fat pointers if their metadata have the same
64 #[derive(Copy, Clone, PartialEq, Eq)]
65 enum PointerKind<'tcx> {
66 /// No metadata attached, ie pointer to sized type or foreign type
69 Vtable(Option<DefId>),
72 /// The unsize info of this projection
73 OfProjection(&'tcx ty::ProjectionTy<'tcx>),
74 /// The unsize info of this opaque ty
75 OfOpaque(DefId, SubstsRef<'tcx>),
76 /// The unsize info of this parameter
77 OfParam(&'tcx ty::ParamTy),
80 impl<'a, 'tcx> FnCtxt<'a, 'tcx> {
81 /// Returns the kind of unsize information of t, or None
87 ) -> Result<Option<PointerKind<'tcx>>, ErrorReported> {
88 debug!("pointer_kind({:?}, {:?})", t, span);
90 let t = self.resolve_vars_if_possible(&t);
92 if t.references_error() {
93 return Err(ErrorReported);
96 if self.type_is_known_to_be_sized_modulo_regions(t, span) {
97 return Ok(Some(PointerKind::Thin));
101 ty::Slice(_) | ty::Str => Some(PointerKind::Length),
102 ty::Dynamic(ref tty, ..) => Some(PointerKind::Vtable(tty.principal_def_id())),
103 ty::Adt(def, substs) if def.is_struct() => match def.non_enum_variant().fields.last() {
104 None => Some(PointerKind::Thin),
106 let field_ty = self.field_ty(span, f, substs);
107 self.pointer_kind(field_ty, span)?
110 ty::Tuple(fields) => match fields.last() {
111 None => Some(PointerKind::Thin),
112 Some(f) => self.pointer_kind(f.expect_ty(), span)?,
115 // Pointers to foreign types are thin, despite being unsized
116 ty::Foreign(..) => Some(PointerKind::Thin),
117 // We should really try to normalize here.
118 ty::Projection(ref pi) => Some(PointerKind::OfProjection(pi)),
119 ty::Opaque(def_id, substs) => Some(PointerKind::OfOpaque(def_id, substs)),
120 ty::Param(ref p) => Some(PointerKind::OfParam(p)),
121 // Insufficient type information.
122 ty::Placeholder(..) | ty::Bound(..) | ty::Infer(_) => None,
130 | ty::GeneratorWitness(..)
142 .delay_span_bug(span, &format!("`{:?}` should be sized but is not?", t));
143 return Err(ErrorReported);
149 #[derive(Copy, Clone)]
156 /// Cast of thin to fat raw ptr (e.g., `*const () as *const [u8]`).
168 impl From<ErrorReported> for CastError {
169 fn from(ErrorReported: ErrorReported) -> Self {
170 CastError::ErrorReported
174 fn make_invalid_casting_error<'a, 'tcx>(
179 fcx: &FnCtxt<'a, 'tcx>,
180 ) -> DiagnosticBuilder<'a> {
186 "casting `{}` as `{}` is invalid",
187 fcx.ty_to_string(expr_ty),
188 fcx.ty_to_string(cast_ty)
192 impl<'a, 'tcx> CastCheck<'tcx> {
194 fcx: &FnCtxt<'a, 'tcx>,
195 expr: &'tcx hir::Expr<'tcx>,
200 ) -> Result<CastCheck<'tcx>, ErrorReported> {
201 let check = CastCheck { expr, expr_ty, cast_ty, cast_span, span };
203 // For better error messages, check for some obviously unsized
204 // cases now. We do a more thorough check at the end, once
205 // inference is more completely known.
207 ty::Dynamic(..) | ty::Slice(..) => {
208 check.report_cast_to_unsized_type(fcx);
215 fn report_cast_error(&self, fcx: &FnCtxt<'a, 'tcx>, e: CastError) {
217 CastError::ErrorReported => {
218 // an error has already been reported
220 CastError::NeedDeref => {
221 let error_span = self.span;
222 let mut err = make_invalid_casting_error(
229 let cast_ty = fcx.ty_to_string(self.cast_ty);
232 format!("cannot cast `{}` as `{}`", fcx.ty_to_string(self.expr_ty), cast_ty),
234 if let Ok(snippet) = fcx.sess().source_map().span_to_snippet(self.expr.span) {
237 "dereference the expression",
238 format!("*{}", snippet),
239 Applicability::MaybeIncorrect,
242 err.span_help(self.expr.span, "dereference the expression with `*`");
246 CastError::NeedViaThinPtr | CastError::NeedViaPtr => {
247 let mut err = make_invalid_casting_error(
254 if self.cast_ty.is_integral() {
256 "cast through {} first",
258 CastError::NeedViaPtr => "a raw pointer",
259 CastError::NeedViaThinPtr => "a thin pointer",
266 CastError::NeedViaInt => {
267 make_invalid_casting_error(
275 "cast through {} first",
277 CastError::NeedViaInt => "an integer",
283 CastError::IllegalCast => {
284 make_invalid_casting_error(
293 CastError::DifferingKinds => {
294 make_invalid_casting_error(
301 .note("vtable kinds may not match")
304 CastError::CastToBool => {
306 struct_span_err!(fcx.tcx.sess, self.span, E0054, "cannot cast as `bool`");
308 if self.expr_ty.is_numeric() {
309 match fcx.tcx.sess.source_map().span_to_snippet(self.expr.span) {
313 "compare with zero instead",
314 format!("{} != 0", snippet),
315 Applicability::MachineApplicable,
319 err.span_help(self.span, "compare with zero instead");
323 err.span_label(self.span, "unsupported cast");
328 CastError::CastToChar => {
334 "only `u8` can be cast as `char`, not `{}`",
337 .span_label(self.span, "invalid cast")
340 CastError::NonScalar => {
341 let mut err = type_error_struct!(
346 "non-primitive cast: `{}` as `{}`",
348 fcx.ty_to_string(self.cast_ty)
351 if let ty::Ref(reg, _, mutbl) = self.cast_ty.kind {
355 fcx.tcx.mk_ref(reg, TypeAndMut { ty: self.expr_ty, mutbl }),
361 sugg = Some(format!("&{}", mutbl.prefix_str()));
364 if let Some(sugg) = sugg {
365 err.span_label(self.span, "invalid cast");
366 err.span_suggestion_verbose(
367 self.expr.span.shrink_to_lo(),
368 "borrow the value for the cast to be valid",
370 Applicability::MachineApplicable,
374 ty::FnDef(..) | ty::FnPtr(..) | ty::Closure(..)
376 let mut label = true;
377 // Check `impl From<self.expr_ty> for self.cast_ty {}` for accurate suggestion:
378 if let Ok(snippet) = fcx.tcx.sess.source_map().span_to_snippet(self.expr.span) {
379 if let Some(from_trait) = fcx.tcx.get_diagnostic_item(sym::from_trait) {
380 let ty = fcx.resolve_vars_if_possible(&self.cast_ty);
381 // Erase regions to avoid panic in `prove_value` when calling
382 // `type_implements_trait`.
383 let ty = fcx.tcx.erase_regions(&ty);
384 let expr_ty = fcx.resolve_vars_if_possible(&self.expr_ty);
385 let expr_ty = fcx.tcx.erase_regions(&expr_ty);
386 let ty_params = fcx.tcx.mk_substs_trait(expr_ty, &[]);
387 // Check for infer types because cases like `Option<{integer}>` would
389 if !expr_ty.has_infer_types()
390 && fcx.tcx.type_implements_trait((
400 "consider using the `From` trait instead",
401 format!("{}::from({})", self.cast_ty, snippet),
402 Applicability::MaybeIncorrect,
407 let msg = "an `as` expression can only be used to convert between primitive \
408 types or to coerce to a specific trait object";
410 err.span_label(self.span, msg);
415 err.span_label(self.span, "invalid cast");
419 CastError::SizedUnsizedCast => {
420 use crate::structured_errors::{SizedUnsizedCastError, StructuredDiagnostic};
421 SizedUnsizedCastError::new(
425 fcx.ty_to_string(self.cast_ty),
430 CastError::UnknownCastPtrKind | CastError::UnknownExprPtrKind => {
431 let unknown_cast_to = match e {
432 CastError::UnknownCastPtrKind => true,
433 CastError::UnknownExprPtrKind => false,
436 let mut err = struct_span_err!(
438 if unknown_cast_to { self.cast_span } else { self.span },
440 "cannot cast {} a pointer of an unknown kind",
441 if unknown_cast_to { "to" } else { "from" }
444 err.span_label(self.cast_span, "needs more type information");
446 "the type information given here is insufficient to check whether \
447 the pointer cast is valid",
452 "the type information given here is insufficient to check whether \
453 the pointer cast is valid",
461 fn report_cast_to_unsized_type(&self, fcx: &FnCtxt<'a, 'tcx>) {
462 if self.cast_ty.references_error() || self.expr_ty.references_error() {
466 let tstr = fcx.ty_to_string(self.cast_ty);
467 let mut err = type_error_struct!(
472 "cast to unsized type: `{}` as `{}`",
473 fcx.resolve_vars_if_possible(&self.expr_ty),
476 match self.expr_ty.kind {
477 ty::Ref(_, _, mt) => {
478 let mtstr = mt.prefix_str();
479 if self.cast_ty.is_trait() {
480 match fcx.tcx.sess.source_map().span_to_snippet(self.cast_span) {
484 "try casting to a reference instead",
485 format!("&{}{}", mtstr, s),
486 Applicability::MachineApplicable,
490 let msg = &format!("did you mean `&{}{}`?", mtstr, tstr);
491 err.span_help(self.cast_span, msg);
496 "consider using an implicit coercion to `&{}{}` instead",
499 err.span_help(self.span, msg);
502 ty::Adt(def, ..) if def.is_box() => {
503 match fcx.tcx.sess.source_map().span_to_snippet(self.cast_span) {
507 "you can cast to a `Box` instead",
508 format!("Box<{}>", s),
509 Applicability::MachineApplicable,
515 &format!("you might have meant `Box<{}>`", tstr),
521 err.span_help(self.expr.span, "consider using a box or reference as appropriate");
527 fn trivial_cast_lint(&self, fcx: &FnCtxt<'a, 'tcx>) {
528 let t_cast = self.cast_ty;
529 let t_expr = self.expr_ty;
531 if fcx.tcx.features().type_ascription { "type ascription or " } else { "" };
532 let (adjective, lint) = if t_cast.is_numeric() && t_expr.is_numeric() {
533 ("numeric ", lint::builtin::TRIVIAL_NUMERIC_CASTS)
535 ("", lint::builtin::TRIVIAL_CASTS)
537 fcx.tcx.struct_span_lint_hir(lint, self.expr.hir_id, self.span, |err| {
539 "trivial {}cast: `{}` as `{}`",
541 fcx.ty_to_string(t_expr),
542 fcx.ty_to_string(t_cast)
545 "cast can be replaced by coercion; this might \
546 require {}a temporary variable",
553 pub fn check(mut self, fcx: &FnCtxt<'a, 'tcx>) {
554 self.expr_ty = fcx.structurally_resolved_type(self.span, self.expr_ty);
555 self.cast_ty = fcx.structurally_resolved_type(self.span, self.cast_ty);
557 debug!("check_cast({}, {:?} as {:?})", self.expr.hir_id, self.expr_ty, self.cast_ty);
559 if !fcx.type_is_known_to_be_sized_modulo_regions(self.cast_ty, self.span) {
560 self.report_cast_to_unsized_type(fcx);
561 } else if self.expr_ty.references_error() || self.cast_ty.references_error() {
562 // No sense in giving duplicate error messages
564 match self.try_coercion_cast(fcx) {
566 self.trivial_cast_lint(fcx);
567 debug!(" -> CoercionCast");
568 fcx.tables.borrow_mut().set_coercion_cast(self.expr.hir_id.local_id);
570 Err(ty::error::TypeError::ObjectUnsafeCoercion(did)) => {
571 self.report_object_unsafe_cast(&fcx, did);
574 match self.do_check(fcx) {
576 debug!(" -> {:?}", k);
578 Err(e) => self.report_cast_error(fcx, e),
585 fn report_object_unsafe_cast(&self, fcx: &FnCtxt<'a, 'tcx>, did: DefId) {
586 let violations = fcx.tcx.object_safety_violations(did);
587 let mut err = report_object_safety_error(fcx.tcx, self.cast_span, did, violations);
588 err.note(&format!("required by cast to type '{}'", fcx.ty_to_string(self.cast_ty)));
592 /// Checks a cast, and report an error if one exists. In some cases, this
593 /// can return Ok and create type errors in the fcx rather than returning
594 /// directly. coercion-cast is handled in check instead of here.
595 fn do_check(&self, fcx: &FnCtxt<'a, 'tcx>) -> Result<CastKind, CastError> {
596 use rustc_middle::ty::cast::CastTy::*;
597 use rustc_middle::ty::cast::IntTy::*;
599 let (t_from, t_cast) = match (CastTy::from_ty(self.expr_ty), CastTy::from_ty(self.cast_ty))
601 (Some(t_from), Some(t_cast)) => (t_from, t_cast),
602 // Function item types may need to be reified before casts.
603 (None, Some(t_cast)) => {
604 match self.expr_ty.kind {
606 // Attempt a coercion to a fn pointer type.
607 let f = fcx.normalize_associated_types_in(
609 &self.expr_ty.fn_sig(fcx.tcx),
611 let res = fcx.try_coerce(
614 fcx.tcx.mk_fn_ptr(f),
617 if let Err(TypeError::IntrinsicCast) = res {
618 return Err(CastError::IllegalCast);
621 return Err(CastError::NonScalar);
625 // Special case some errors for references, and check for
626 // array-ptr-casts. `Ref` is not a CastTy because the cast
627 // is split into a coercion to a pointer type, followed by
629 ty::Ref(_, inner_ty, mutbl) => {
630 return match t_cast {
631 Int(_) | Float => match inner_ty.kind {
635 | ty::Infer(ty::InferTy::IntVar(_) | ty::InferTy::FloatVar(_)) => {
636 Err(CastError::NeedDeref)
638 _ => Err(CastError::NeedViaPtr),
642 self.check_ref_cast(fcx, TypeAndMut { mutbl, ty: inner_ty }, mt)
644 _ => Err(CastError::NonScalar),
647 _ => return Err(CastError::NonScalar),
650 _ => return Err(CastError::NonScalar),
653 match (t_from, t_cast) {
654 // These types have invariants! can't cast into them.
655 (_, Int(CEnum) | FnPtr) => Err(CastError::NonScalar),
658 (_, Int(Bool)) => Err(CastError::CastToBool),
661 (Int(U(ast::UintTy::U8)), Int(Char)) => Ok(CastKind::U8CharCast), // u8-char-cast
662 (_, Int(Char)) => Err(CastError::CastToChar),
665 (Int(Bool) | Int(CEnum) | Int(Char), Float) => Err(CastError::NeedViaInt),
667 (Int(Bool) | Int(CEnum) | Int(Char) | Float, Ptr(_)) | (Ptr(_) | FnPtr, Float) => {
668 Err(CastError::IllegalCast)
672 (Ptr(m_e), Ptr(m_c)) => self.check_ptr_ptr_cast(fcx, m_e, m_c), // ptr-ptr-cast
673 (Ptr(m_expr), Int(_)) => self.check_ptr_addr_cast(fcx, m_expr), // ptr-addr-cast
674 (FnPtr, Int(_)) => Ok(CastKind::FnPtrAddrCast),
677 (Int(_), Ptr(mt)) => self.check_addr_ptr_cast(fcx, mt), // addr-ptr-cast
678 (FnPtr, Ptr(mt)) => self.check_fptr_ptr_cast(fcx, mt),
681 (Int(CEnum), Int(_)) => {
682 self.cenum_impl_drop_lint(fcx);
683 Ok(CastKind::EnumCast)
685 (Int(Char) | Int(Bool), Int(_)) => Ok(CastKind::PrimIntCast),
687 (Int(_) | Float, Int(_) | Float) => Ok(CastKind::NumericCast),
691 fn check_ptr_ptr_cast(
693 fcx: &FnCtxt<'a, 'tcx>,
694 m_expr: ty::TypeAndMut<'tcx>,
695 m_cast: ty::TypeAndMut<'tcx>,
696 ) -> Result<CastKind, CastError> {
697 debug!("check_ptr_ptr_cast m_expr={:?} m_cast={:?}", m_expr, m_cast);
698 // ptr-ptr cast. vtables must match.
700 let expr_kind = fcx.pointer_kind(m_expr.ty, self.span)?;
701 let cast_kind = fcx.pointer_kind(m_cast.ty, self.span)?;
703 let cast_kind = match cast_kind {
704 // We can't cast if target pointer kind is unknown
705 None => return Err(CastError::UnknownCastPtrKind),
706 Some(cast_kind) => cast_kind,
709 // Cast to thin pointer is OK
710 if cast_kind == PointerKind::Thin {
711 return Ok(CastKind::PtrPtrCast);
714 let expr_kind = match expr_kind {
715 // We can't cast to fat pointer if source pointer kind is unknown
716 None => return Err(CastError::UnknownExprPtrKind),
717 Some(expr_kind) => expr_kind,
720 // thin -> fat? report invalid cast (don't complain about vtable kinds)
721 if expr_kind == PointerKind::Thin {
722 return Err(CastError::SizedUnsizedCast);
725 // vtable kinds must match
726 if cast_kind == expr_kind {
727 Ok(CastKind::PtrPtrCast)
729 Err(CastError::DifferingKinds)
733 fn check_fptr_ptr_cast(
735 fcx: &FnCtxt<'a, 'tcx>,
736 m_cast: ty::TypeAndMut<'tcx>,
737 ) -> Result<CastKind, CastError> {
738 // fptr-ptr cast. must be to thin ptr
740 match fcx.pointer_kind(m_cast.ty, self.span)? {
741 None => Err(CastError::UnknownCastPtrKind),
742 Some(PointerKind::Thin) => Ok(CastKind::FnPtrPtrCast),
743 _ => Err(CastError::IllegalCast),
747 fn check_ptr_addr_cast(
749 fcx: &FnCtxt<'a, 'tcx>,
750 m_expr: ty::TypeAndMut<'tcx>,
751 ) -> Result<CastKind, CastError> {
752 // ptr-addr cast. must be from thin ptr
754 match fcx.pointer_kind(m_expr.ty, self.span)? {
755 None => Err(CastError::UnknownExprPtrKind),
756 Some(PointerKind::Thin) => Ok(CastKind::PtrAddrCast),
757 _ => Err(CastError::NeedViaThinPtr),
763 fcx: &FnCtxt<'a, 'tcx>,
764 m_expr: ty::TypeAndMut<'tcx>,
765 m_cast: ty::TypeAndMut<'tcx>,
766 ) -> Result<CastKind, CastError> {
769 if m_expr.mutbl == hir::Mutability::Not && m_cast.mutbl == hir::Mutability::Not {
770 if let ty::Array(ety, _) = m_expr.ty.kind {
771 // Due to the limitations of LLVM global constants,
772 // region pointers end up pointing at copies of
773 // vector elements instead of the original values.
774 // To allow raw pointers to work correctly, we
775 // need to special-case obtaining a raw pointer
776 // from a region pointer to a vector.
778 // Coerce to a raw pointer so that we generate AddressOf in MIR.
779 let array_ptr_type = fcx.tcx.mk_ptr(m_expr);
780 fcx.try_coerce(self.expr, self.expr_ty, array_ptr_type, AllowTwoPhase::No)
781 .unwrap_or_else(|_| {
783 "could not cast from reference to array to pointer to array ({:?} to {:?})",
789 // this will report a type mismatch if needed
790 fcx.demand_eqtype(self.span, ety, m_cast.ty);
791 return Ok(CastKind::ArrayPtrCast);
795 Err(CastError::IllegalCast)
798 fn check_addr_ptr_cast(
800 fcx: &FnCtxt<'a, 'tcx>,
801 m_cast: TypeAndMut<'tcx>,
802 ) -> Result<CastKind, CastError> {
803 // ptr-addr cast. pointer must be thin.
804 match fcx.pointer_kind(m_cast.ty, self.span)? {
805 None => Err(CastError::UnknownCastPtrKind),
806 Some(PointerKind::Thin) => Ok(CastKind::AddrPtrCast),
807 _ => Err(CastError::IllegalCast),
811 fn try_coercion_cast(&self, fcx: &FnCtxt<'a, 'tcx>) -> Result<(), ty::error::TypeError<'_>> {
812 match fcx.try_coerce(self.expr, self.expr_ty, self.cast_ty, AllowTwoPhase::No) {
814 Err(err) => Err(err),
818 fn cenum_impl_drop_lint(&self, fcx: &FnCtxt<'a, 'tcx>) {
819 if let ty::Adt(d, _) = self.expr_ty.kind {
820 if d.has_dtor(fcx.tcx) {
821 fcx.tcx.struct_span_lint_hir(
822 lint::builtin::CENUM_IMPL_DROP_CAST,
827 "cannot cast enum `{}` into integer `{}` because it implements `Drop`",
828 self.expr_ty, self.cast_ty
838 impl<'a, 'tcx> FnCtxt<'a, 'tcx> {
839 fn type_is_known_to_be_sized_modulo_regions(&self, ty: Ty<'tcx>, span: Span) -> bool {
840 let lang_item = self.tcx.require_lang_item(lang_items::SizedTraitLangItem, None);
841 traits::type_known_to_meet_bound_modulo_regions(self, self.param_env, ty, lang_item, span)