compiler/rustc_codegen_ssa/src/common.rs

   1 #![allow(non_camel_case_types)]
   2
   3 use rustc_errors::struct_span_err;
   4 use rustc_hir::LangItem;
   5 use rustc_middle::mir::interpret::ConstValue;
   6 use rustc_middle::ty::{self, layout::TyAndLayout, Ty, TyCtxt};
   7 use rustc_session::Session;
   8 use rustc_span::Span;
   9
  10 use crate::base;
  11 use crate::traits::*;
  12
  13 #[derive(Copy, Clone)]
  14 pub enum IntPredicate {
  15     IntEQ,
  16     IntNE,
  17     IntUGT,
  18     IntUGE,
  19     IntULT,
  20     IntULE,
  21     IntSGT,
  22     IntSGE,
  23     IntSLT,
  24     IntSLE,
  25 }
  26
  27 #[derive(Copy, Clone)]
  28 pub enum RealPredicate {
  29     RealPredicateFalse,
  30     RealOEQ,
  31     RealOGT,
  32     RealOGE,
  33     RealOLT,
  34     RealOLE,
  35     RealONE,
  36     RealORD,
  37     RealUNO,
  38     RealUEQ,
  39     RealUGT,
  40     RealUGE,
  41     RealULT,
  42     RealULE,
  43     RealUNE,
  44     RealPredicateTrue,
  45 }
  46
  47 #[derive(Copy, Clone)]
  48 pub enum AtomicRmwBinOp {
  49     AtomicXchg,
  50     AtomicAdd,
  51     AtomicSub,
  52     AtomicAnd,
  53     AtomicNand,
  54     AtomicOr,
  55     AtomicXor,
  56     AtomicMax,
  57     AtomicMin,
  58     AtomicUMax,
  59     AtomicUMin,
  60 }
  61
  62 #[derive(Copy, Clone)]
  63 pub enum AtomicOrdering {
  64     Unordered,
  65     Relaxed,
  66     Acquire,
  67     Release,
  68     AcquireRelease,
  69     SequentiallyConsistent,
  70 }
  71
  72 #[derive(Copy, Clone)]
  73 pub enum SynchronizationScope {
  74     SingleThread,
  75     CrossThread,
  76 }
  77
  78 #[derive(Copy, Clone, PartialEq, Debug)]
  79 pub enum TypeKind {
  80     Void,
  81     Half,
  82     Float,
  83     Double,
  84     X86_FP80,
  85     FP128,
  86     PPC_FP128,
  87     Label,
  88     Integer,
  89     Function,
  90     Struct,
  91     Array,
  92     Pointer,
  93     Vector,
  94     Metadata,
  95     X86_MMX,
  96     Token,
  97     ScalableVector,
  98     BFloat,
  99     X86_AMX,
 100 }
 101
 102 // FIXME(mw): Anything that is produced via DepGraph::with_task() must implement
 103 //            the HashStable trait. Normally DepGraph::with_task() calls are
 104 //            hidden behind queries, but CGU creation is a special case in two
 105 //            ways: (1) it's not a query and (2) CGU are output nodes, so their
 106 //            Fingerprints are not actually needed. It remains to be clarified
 107 //            how exactly this case will be handled in the red/green system but
 108 //            for now we content ourselves with providing a no-op HashStable
 109 //            implementation for CGUs.
 110 mod temp_stable_hash_impls {
 111     use crate::ModuleCodegen;
 112     use rustc_data_structures::stable_hasher::{HashStable, StableHasher};
 113
 114     impl<HCX, M> HashStable<HCX> for ModuleCodegen<M> {
 115         fn hash_stable(&self, _: &mut HCX, _: &mut StableHasher) {
 116             // do nothing
 117         }
 118     }
 119 }
 120
 121 pub fn build_langcall<'a, 'tcx, Bx: BuilderMethods<'a, 'tcx>>(
 122     bx: &Bx,
 123     span: Option<Span>,
 124     li: LangItem,
 125 ) -> (Bx::FnAbiOfResult, Bx::Value) {
 126     let tcx = bx.tcx();
 127     let def_id = tcx.require_lang_item(li, span);
 128     let instance = ty::Instance::mono(tcx, def_id);
 129     (bx.fn_abi_of_instance(instance, ty::List::empty()), bx.get_fn_addr(instance))
 130 }
 131
 132 // To avoid UB from LLVM, these two functions mask RHS with an
 133 // appropriate mask unconditionally (i.e., the fallback behavior for
 134 // all shifts). For 32- and 64-bit types, this matches the semantics
 135 // of Java. (See related discussion on #1877 and #10183.)
 136
 137 pub fn build_unchecked_lshift<'a, 'tcx, Bx: BuilderMethods<'a, 'tcx>>(
 138     bx: &mut Bx,
 139     lhs: Bx::Value,
 140     rhs: Bx::Value,
 141 ) -> Bx::Value {
 142     let rhs = base::cast_shift_expr_rhs(bx, lhs, rhs);
 143     // #1877, #10183: Ensure that input is always valid
 144     let rhs = shift_mask_rhs(bx, rhs);
 145     bx.shl(lhs, rhs)
 146 }
 147
 148 pub fn build_unchecked_rshift<'a, 'tcx, Bx: BuilderMethods<'a, 'tcx>>(
 149     bx: &mut Bx,
 150     lhs_t: Ty<'tcx>,
 151     lhs: Bx::Value,
 152     rhs: Bx::Value,
 153 ) -> Bx::Value {
 154     let rhs = base::cast_shift_expr_rhs(bx, lhs, rhs);
 155     // #1877, #10183: Ensure that input is always valid
 156     let rhs = shift_mask_rhs(bx, rhs);
 157     let is_signed = lhs_t.is_signed();
 158     if is_signed { bx.ashr(lhs, rhs) } else { bx.lshr(lhs, rhs) }
 159 }
 160
 161 fn shift_mask_rhs<'a, 'tcx, Bx: BuilderMethods<'a, 'tcx>>(
 162     bx: &mut Bx,
 163     rhs: Bx::Value,
 164 ) -> Bx::Value {
 165     let rhs_llty = bx.val_ty(rhs);
 166     let shift_val = shift_mask_val(bx, rhs_llty, rhs_llty, false);
 167     bx.and(rhs, shift_val)
 168 }
 169
 170 pub fn shift_mask_val<'a, 'tcx, Bx: BuilderMethods<'a, 'tcx>>(
 171     bx: &mut Bx,
 172     llty: Bx::Type,
 173     mask_llty: Bx::Type,
 174     invert: bool,
 175 ) -> Bx::Value {
 176     let kind = bx.type_kind(llty);
 177     match kind {
 178         TypeKind::Integer => {
 179             // i8/u8 can shift by at most 7, i16/u16 by at most 15, etc.
 180             let val = bx.int_width(llty) - 1;
 181             if invert {
 182                 bx.const_int(mask_llty, !val as i64)
 183             } else {
 184                 bx.const_uint(mask_llty, val)
 185             }
 186         }
 187         TypeKind::Vector => {
 188             let mask =
 189                 shift_mask_val(bx, bx.element_type(llty), bx.element_type(mask_llty), invert);
 190             bx.vector_splat(bx.vector_length(mask_llty), mask)
 191         }
 192         _ => bug!("shift_mask_val: expected Integer or Vector, found {:?}", kind),
 193     }
 194 }
 195
 196 pub fn span_invalid_monomorphization_error(a: &Session, b: Span, c: &str) {
 197     struct_span_err!(a, b, E0511, "{}", c).emit();
 198 }
 199
 200 pub fn asm_const_to_str<'tcx>(
 201     tcx: TyCtxt<'tcx>,
 202     sp: Span,
 203     const_value: ConstValue<'tcx>,
 204     ty_and_layout: TyAndLayout<'tcx>,
 205 ) -> String {
 206     let ConstValue::Scalar(scalar) = const_value else {
 207         span_bug!(sp, "expected Scalar for promoted asm const, but got {:#?}", const_value)
 208     };
 209     let value = scalar.assert_bits(ty_and_layout.size);
 210     match ty_and_layout.ty.kind() {
 211         ty::Uint(_) => value.to_string(),
 212         ty::Int(int_ty) => match int_ty.normalize(tcx.sess.target.pointer_width) {
 213             ty::IntTy::I8 => (value as i8).to_string(),
 214             ty::IntTy::I16 => (value as i16).to_string(),
 215             ty::IntTy::I32 => (value as i32).to_string(),
 216             ty::IntTy::I64 => (value as i64).to_string(),
 217             ty::IntTy::I128 => (value as i128).to_string(),
 218             ty::IntTy::Isize => unreachable!(),
 219         },
 220         _ => span_bug!(sp, "asm const has bad type {}", ty_and_layout.ty),
 221     }
 222 }