compiler/rustc_codegen_cranelift/src/common.rs

   1 use cranelift_codegen::isa::TargetFrontendConfig;
   2 use rustc_index::vec::IndexVec;
   3 use rustc_middle::ty::layout::{
   4     FnAbiError, FnAbiOfHelpers, FnAbiRequest, LayoutError, LayoutOfHelpers,
   5 };
   6 use rustc_middle::ty::SymbolName;
   7 use rustc_target::abi::call::FnAbi;
   8 use rustc_target::abi::{Integer, Primitive};
   9 use rustc_target::spec::{HasTargetSpec, Target};
  10
  11 use crate::constant::ConstantCx;
  12 use crate::prelude::*;
  13
  14 pub(crate) fn pointer_ty(tcx: TyCtxt<'_>) -> types::Type {
  15     match tcx.data_layout.pointer_size.bits() {
  16         16 => types::I16,
  17         32 => types::I32,
  18         64 => types::I64,
  19         bits => bug!("ptr_sized_integer: unknown pointer bit size {}", bits),
  20     }
  21 }
  22
  23 pub(crate) fn scalar_to_clif_type(tcx: TyCtxt<'_>, scalar: Scalar) -> Type {
  24     match scalar.primitive() {
  25         Primitive::Int(int, _sign) => match int {
  26             Integer::I8 => types::I8,
  27             Integer::I16 => types::I16,
  28             Integer::I32 => types::I32,
  29             Integer::I64 => types::I64,
  30             Integer::I128 => types::I128,
  31         },
  32         Primitive::F32 => types::F32,
  33         Primitive::F64 => types::F64,
  34         Primitive::Pointer => pointer_ty(tcx),
  35     }
  36 }
  37
  38 fn clif_type_from_ty<'tcx>(tcx: TyCtxt<'tcx>, ty: Ty<'tcx>) -> Option<types::Type> {
  39     Some(match ty.kind() {
  40         ty::Bool => types::I8,
  41         ty::Uint(size) => match size {
  42             UintTy::U8 => types::I8,
  43             UintTy::U16 => types::I16,
  44             UintTy::U32 => types::I32,
  45             UintTy::U64 => types::I64,
  46             UintTy::U128 => types::I128,
  47             UintTy::Usize => pointer_ty(tcx),
  48         },
  49         ty::Int(size) => match size {
  50             IntTy::I8 => types::I8,
  51             IntTy::I16 => types::I16,
  52             IntTy::I32 => types::I32,
  53             IntTy::I64 => types::I64,
  54             IntTy::I128 => types::I128,
  55             IntTy::Isize => pointer_ty(tcx),
  56         },
  57         ty::Char => types::I32,
  58         ty::Float(size) => match size {
  59             FloatTy::F32 => types::F32,
  60             FloatTy::F64 => types::F64,
  61         },
  62         ty::FnPtr(_) => pointer_ty(tcx),
  63         ty::RawPtr(TypeAndMut { ty: pointee_ty, mutbl: _ }) | ty::Ref(_, pointee_ty, _) => {
  64             if has_ptr_meta(tcx, *pointee_ty) {
  65                 return None;
  66             } else {
  67                 pointer_ty(tcx)
  68             }
  69         }
  70         ty::Adt(adt_def, _) if adt_def.repr().simd() => {
  71             let (element, count) = match &tcx.layout_of(ParamEnv::reveal_all().and(ty)).unwrap().abi
  72             {
  73                 Abi::Vector { element, count } => (element.clone(), *count),
  74                 _ => unreachable!(),
  75             };
  76
  77             match scalar_to_clif_type(tcx, element).by(u16::try_from(count).unwrap()) {
  78                 // Cranelift currently only implements icmp for 128bit vectors.
  79                 Some(vector_ty) if vector_ty.bits() == 128 => vector_ty,
  80                 _ => return None,
  81             }
  82         }
  83         ty::Param(_) => bug!("ty param {:?}", ty),
  84         _ => return None,
  85     })
  86 }
  87
  88 fn clif_pair_type_from_ty<'tcx>(
  89     tcx: TyCtxt<'tcx>,
  90     ty: Ty<'tcx>,
  91 ) -> Option<(types::Type, types::Type)> {
  92     Some(match ty.kind() {
  93         ty::Tuple(types) if types.len() == 2 => {
  94             let a = clif_type_from_ty(tcx, types[0])?;
  95             let b = clif_type_from_ty(tcx, types[1])?;
  96             if a.is_vector() || b.is_vector() {
  97                 return None;
  98             }
  99             (a, b)
 100         }
 101         ty::RawPtr(TypeAndMut { ty: pointee_ty, mutbl: _ }) | ty::Ref(_, pointee_ty, _) => {
 102             if has_ptr_meta(tcx, *pointee_ty) {
 103                 (pointer_ty(tcx), pointer_ty(tcx))
 104             } else {
 105                 return None;
 106             }
 107         }
 108         _ => return None,
 109     })
 110 }
 111
 112 /// Is a pointer to this type a fat ptr?
 113 pub(crate) fn has_ptr_meta<'tcx>(tcx: TyCtxt<'tcx>, ty: Ty<'tcx>) -> bool {
 114     let ptr_ty = tcx.mk_ptr(TypeAndMut { ty, mutbl: rustc_hir::Mutability::Not });
 115     match &tcx.layout_of(ParamEnv::reveal_all().and(ptr_ty)).unwrap().abi {
 116         Abi::Scalar(_) => false,
 117         Abi::ScalarPair(_, _) => true,
 118         abi => unreachable!("Abi of ptr to {:?} is {:?}???", ty, abi),
 119     }
 120 }
 121
 122 pub(crate) fn codegen_icmp_imm(
 123     fx: &mut FunctionCx<'_, '_, '_>,
 124     intcc: IntCC,
 125     lhs: Value,
 126     rhs: i128,
 127 ) -> Value {
 128     let lhs_ty = fx.bcx.func.dfg.value_type(lhs);
 129     if lhs_ty == types::I128 {
 130         // FIXME legalize `icmp_imm.i128` in Cranelift
 131
 132         let (lhs_lsb, lhs_msb) = fx.bcx.ins().isplit(lhs);
 133         let (rhs_lsb, rhs_msb) = (rhs as u128 as u64 as i64, (rhs as u128 >> 64) as u64 as i64);
 134
 135         match intcc {
 136             IntCC::Equal => {
 137                 let lsb_eq = fx.bcx.ins().icmp_imm(IntCC::Equal, lhs_lsb, rhs_lsb);
 138                 let msb_eq = fx.bcx.ins().icmp_imm(IntCC::Equal, lhs_msb, rhs_msb);
 139                 fx.bcx.ins().band(lsb_eq, msb_eq)
 140             }
 141             IntCC::NotEqual => {
 142                 let lsb_ne = fx.bcx.ins().icmp_imm(IntCC::NotEqual, lhs_lsb, rhs_lsb);
 143                 let msb_ne = fx.bcx.ins().icmp_imm(IntCC::NotEqual, lhs_msb, rhs_msb);
 144                 fx.bcx.ins().bor(lsb_ne, msb_ne)
 145             }
 146             _ => {
 147                 // if msb_eq {
 148                 //     lsb_cc
 149                 // } else {
 150                 //     msb_cc
 151                 // }
 152
 153                 let msb_eq = fx.bcx.ins().icmp_imm(IntCC::Equal, lhs_msb, rhs_msb);
 154                 let lsb_cc = fx.bcx.ins().icmp_imm(intcc, lhs_lsb, rhs_lsb);
 155                 let msb_cc = fx.bcx.ins().icmp_imm(intcc, lhs_msb, rhs_msb);
 156
 157                 fx.bcx.ins().select(msb_eq, lsb_cc, msb_cc)
 158             }
 159         }
 160     } else {
 161         let rhs = i64::try_from(rhs).expect("codegen_icmp_imm rhs out of range for <128bit int");
 162         fx.bcx.ins().icmp_imm(intcc, lhs, rhs)
 163     }
 164 }
 165
 166 pub(crate) fn type_min_max_value(
 167     bcx: &mut FunctionBuilder<'_>,
 168     ty: Type,
 169     signed: bool,
 170 ) -> (Value, Value) {
 171     assert!(ty.is_int());
 172
 173     if ty == types::I128 {
 174         if signed {
 175             let min = i128::MIN as u128;
 176             let min_lsb = bcx.ins().iconst(types::I64, min as u64 as i64);
 177             let min_msb = bcx.ins().iconst(types::I64, (min >> 64) as u64 as i64);
 178             let min = bcx.ins().iconcat(min_lsb, min_msb);
 179
 180             let max = i128::MAX as u128;
 181             let max_lsb = bcx.ins().iconst(types::I64, max as u64 as i64);
 182             let max_msb = bcx.ins().iconst(types::I64, (max >> 64) as u64 as i64);
 183             let max = bcx.ins().iconcat(max_lsb, max_msb);
 184
 185             return (min, max);
 186         } else {
 187             let min_half = bcx.ins().iconst(types::I64, 0);
 188             let min = bcx.ins().iconcat(min_half, min_half);
 189
 190             let max_half = bcx.ins().iconst(types::I64, u64::MAX as i64);
 191             let max = bcx.ins().iconcat(max_half, max_half);
 192
 193             return (min, max);
 194         }
 195     }
 196
 197     let min = match (ty, signed) {
 198         (types::I8, false) | (types::I16, false) | (types::I32, false) | (types::I64, false) => {
 199             0i64
 200         }
 201         (types::I8, true) => i64::from(i8::MIN),
 202         (types::I16, true) => i64::from(i16::MIN),
 203         (types::I32, true) => i64::from(i32::MIN),
 204         (types::I64, true) => i64::MIN,
 205         _ => unreachable!(),
 206     };
 207
 208     let max = match (ty, signed) {
 209         (types::I8, false) => i64::from(u8::MAX),
 210         (types::I16, false) => i64::from(u16::MAX),
 211         (types::I32, false) => i64::from(u32::MAX),
 212         (types::I64, false) => u64::MAX as i64,
 213         (types::I8, true) => i64::from(i8::MAX),
 214         (types::I16, true) => i64::from(i16::MAX),
 215         (types::I32, true) => i64::from(i32::MAX),
 216         (types::I64, true) => i64::MAX,
 217         _ => unreachable!(),
 218     };
 219
 220     let (min, max) = (bcx.ins().iconst(ty, min), bcx.ins().iconst(ty, max));
 221
 222     (min, max)
 223 }
 224
 225 pub(crate) fn type_sign(ty: Ty<'_>) -> bool {
 226     match ty.kind() {
 227         ty::Ref(..) | ty::RawPtr(..) | ty::FnPtr(..) | ty::Char | ty::Uint(..) | ty::Bool => false,
 228         ty::Int(..) => true,
 229         ty::Float(..) => false, // `signed` is unused for floats
 230         _ => panic!("{}", ty),
 231     }
 232 }
 233
 234 pub(crate) struct FunctionCx<'m, 'clif, 'tcx: 'm> {
 235     pub(crate) cx: &'clif mut crate::CodegenCx<'tcx>,
 236     pub(crate) module: &'m mut dyn Module,
 237     pub(crate) tcx: TyCtxt<'tcx>,
 238     pub(crate) target_config: TargetFrontendConfig, // Cached from module
 239     pub(crate) pointer_type: Type,                  // Cached from module
 240     pub(crate) constants_cx: ConstantCx,
 241
 242     pub(crate) instance: Instance<'tcx>,
 243     pub(crate) symbol_name: SymbolName<'tcx>,
 244     pub(crate) mir: &'tcx Body<'tcx>,
 245     pub(crate) fn_abi: Option<&'tcx FnAbi<'tcx, Ty<'tcx>>>,
 246
 247     pub(crate) bcx: FunctionBuilder<'clif>,
 248     pub(crate) block_map: IndexVec<BasicBlock, Block>,
 249     pub(crate) local_map: IndexVec<Local, CPlace<'tcx>>,
 250
 251     /// When `#[track_caller]` is used, the implicit caller location is stored in this variable.
 252     pub(crate) caller_location: Option<CValue<'tcx>>,
 253
 254     pub(crate) clif_comments: crate::pretty_clif::CommentWriter,
 255     pub(crate) source_info_set: indexmap::IndexSet<SourceInfo>,
 256
 257     /// This should only be accessed by `CPlace::new_var`.
 258     pub(crate) next_ssa_var: u32,
 259 }
 260
 261 impl<'tcx> LayoutOfHelpers<'tcx> for FunctionCx<'_, '_, 'tcx> {
 262     type LayoutOfResult = TyAndLayout<'tcx>;
 263
 264     #[inline]
 265     fn handle_layout_err(&self, err: LayoutError<'tcx>, span: Span, ty: Ty<'tcx>) -> ! {
 266         RevealAllLayoutCx(self.tcx).handle_layout_err(err, span, ty)
 267     }
 268 }
 269
 270 impl<'tcx> FnAbiOfHelpers<'tcx> for FunctionCx<'_, '_, 'tcx> {
 271     type FnAbiOfResult = &'tcx FnAbi<'tcx, Ty<'tcx>>;
 272
 273     #[inline]
 274     fn handle_fn_abi_err(
 275         &self,
 276         err: FnAbiError<'tcx>,
 277         span: Span,
 278         fn_abi_request: FnAbiRequest<'tcx>,
 279     ) -> ! {
 280         RevealAllLayoutCx(self.tcx).handle_fn_abi_err(err, span, fn_abi_request)
 281     }
 282 }
 283
 284 impl<'tcx> layout::HasTyCtxt<'tcx> for FunctionCx<'_, '_, 'tcx> {
 285     fn tcx<'b>(&'b self) -> TyCtxt<'tcx> {
 286         self.tcx
 287     }
 288 }
 289
 290 impl<'tcx> rustc_target::abi::HasDataLayout for FunctionCx<'_, '_, 'tcx> {
 291     fn data_layout(&self) -> &rustc_target::abi::TargetDataLayout {
 292         &self.tcx.data_layout
 293     }
 294 }
 295
 296 impl<'tcx> layout::HasParamEnv<'tcx> for FunctionCx<'_, '_, 'tcx> {
 297     fn param_env(&self) -> ParamEnv<'tcx> {
 298         ParamEnv::reveal_all()
 299     }
 300 }
 301
 302 impl<'tcx> HasTargetSpec for FunctionCx<'_, '_, 'tcx> {
 303     fn target_spec(&self) -> &Target {
 304         &self.tcx.sess.target
 305     }
 306 }
 307
 308 impl<'tcx> FunctionCx<'_, '_, 'tcx> {
 309     pub(crate) fn monomorphize<T>(&self, value: T) -> T
 310     where
 311         T: TypeFoldable<'tcx> + Copy,
 312     {
 313         self.instance.subst_mir_and_normalize_erasing_regions(
 314             self.tcx,
 315             ty::ParamEnv::reveal_all(),
 316             value,
 317         )
 318     }
 319
 320     pub(crate) fn clif_type(&self, ty: Ty<'tcx>) -> Option<Type> {
 321         clif_type_from_ty(self.tcx, ty)
 322     }
 323
 324     pub(crate) fn clif_pair_type(&self, ty: Ty<'tcx>) -> Option<(Type, Type)> {
 325         clif_pair_type_from_ty(self.tcx, ty)
 326     }
 327
 328     pub(crate) fn get_block(&self, bb: BasicBlock) -> Block {
 329         *self.block_map.get(bb).unwrap()
 330     }
 331
 332     pub(crate) fn get_local_place(&mut self, local: Local) -> CPlace<'tcx> {
 333         *self.local_map.get(local).unwrap_or_else(|| {
 334             panic!("Local {:?} doesn't exist", local);
 335         })
 336     }
 337
 338     pub(crate) fn set_debug_loc(&mut self, source_info: mir::SourceInfo) {
 339         let (index, _) = self.source_info_set.insert_full(source_info);
 340         self.bcx.set_srcloc(SourceLoc::new(index as u32));
 341     }
 342
 343     pub(crate) fn get_caller_location(&mut self, span: Span) -> CValue<'tcx> {
 344         if let Some(loc) = self.caller_location {
 345             // `#[track_caller]` is used; return caller location instead of current location.
 346             return loc;
 347         }
 348
 349         let topmost = span.ctxt().outer_expn().expansion_cause().unwrap_or(span);
 350         let caller = self.tcx.sess.source_map().lookup_char_pos(topmost.lo());
 351         let const_loc = self.tcx.const_caller_location((
 352             rustc_span::symbol::Symbol::intern(
 353                 &caller.file.name.prefer_remapped().to_string_lossy(),
 354             ),
 355             caller.line as u32,
 356             caller.col_display as u32 + 1,
 357         ));
 358         crate::constant::codegen_const_value(self, const_loc, self.tcx.caller_location_ty())
 359     }
 360
 361     pub(crate) fn anonymous_str(&mut self, msg: &str) -> Value {
 362         let mut data_ctx = DataContext::new();
 363         data_ctx.define(msg.as_bytes().to_vec().into_boxed_slice());
 364         let msg_id = self.module.declare_anonymous_data(false, false).unwrap();
 365
 366         // Ignore DuplicateDefinition error, as the data will be the same
 367         let _ = self.module.define_data(msg_id, &data_ctx);
 368
 369         let local_msg_id = self.module.declare_data_in_func(msg_id, self.bcx.func);
 370         if self.clif_comments.enabled() {
 371             self.add_comment(local_msg_id, msg);
 372         }
 373         self.bcx.ins().global_value(self.pointer_type, local_msg_id)
 374     }
 375 }
 376
 377 pub(crate) struct RevealAllLayoutCx<'tcx>(pub(crate) TyCtxt<'tcx>);
 378
 379 impl<'tcx> LayoutOfHelpers<'tcx> for RevealAllLayoutCx<'tcx> {
 380     type LayoutOfResult = TyAndLayout<'tcx>;
 381
 382     #[inline]
 383     fn handle_layout_err(&self, err: LayoutError<'tcx>, span: Span, ty: Ty<'tcx>) -> ! {
 384         if let layout::LayoutError::SizeOverflow(_) = err {
 385             self.0.sess.span_fatal(span, &err.to_string())
 386         } else {
 387             span_bug!(span, "failed to get layout for `{}`: {}", ty, err)
 388         }
 389     }
 390 }
 391
 392 impl<'tcx> FnAbiOfHelpers<'tcx> for RevealAllLayoutCx<'tcx> {
 393     type FnAbiOfResult = &'tcx FnAbi<'tcx, Ty<'tcx>>;
 394
 395     #[inline]
 396     fn handle_fn_abi_err(
 397         &self,
 398         err: FnAbiError<'tcx>,
 399         span: Span,
 400         fn_abi_request: FnAbiRequest<'tcx>,
 401     ) -> ! {
 402         if let FnAbiError::Layout(LayoutError::SizeOverflow(_)) = err {
 403             self.0.sess.span_fatal(span, &err.to_string())
 404         } else {
 405             match fn_abi_request {
 406                 FnAbiRequest::OfFnPtr { sig, extra_args } => {
 407                     span_bug!(
 408                         span,
 409                         "`fn_abi_of_fn_ptr({}, {:?})` failed: {}",
 410                         sig,
 411                         extra_args,
 412                         err
 413                     );
 414                 }
 415                 FnAbiRequest::OfInstance { instance, extra_args } => {
 416                     span_bug!(
 417                         span,
 418                         "`fn_abi_of_instance({}, {:?})` failed: {}",
 419                         instance,
 420                         extra_args,
 421                         err
 422                     );
 423                 }
 424             }
 425         }
 426     }
 427 }
 428
 429 impl<'tcx> layout::HasTyCtxt<'tcx> for RevealAllLayoutCx<'tcx> {
 430     fn tcx<'b>(&'b self) -> TyCtxt<'tcx> {
 431         self.0
 432     }
 433 }
 434
 435 impl<'tcx> rustc_target::abi::HasDataLayout for RevealAllLayoutCx<'tcx> {
 436     fn data_layout(&self) -> &rustc_target::abi::TargetDataLayout {
 437         &self.0.data_layout
 438     }
 439 }
 440
 441 impl<'tcx> layout::HasParamEnv<'tcx> for RevealAllLayoutCx<'tcx> {
 442     fn param_env(&self) -> ParamEnv<'tcx> {
 443         ParamEnv::reveal_all()
 444     }
 445 }
 446
 447 impl<'tcx> HasTargetSpec for RevealAllLayoutCx<'tcx> {
 448     fn target_spec(&self) -> &Target {
 449         &self.0.sess.target
 450     }
 451 }