src/librustc_codegen_ssa/traits/builder.rs

   1 use super::abi::AbiBuilderMethods;
   2 use super::asm::AsmBuilderMethods;
   3 use super::debuginfo::DebugInfoBuilderMethods;
   4 use super::intrinsic::IntrinsicCallMethods;
   5 use super::type_::ArgTypeMethods;
   6 use super::{HasCodegen, StaticBuilderMethods};
   7 use crate::common::{AtomicOrdering, AtomicRmwBinOp, IntPredicate, RealPredicate,
   8     SynchronizationScope};
   9 use crate::mir::operand::OperandRef;
  10 use crate::mir::place::PlaceRef;
  11 use crate::MemFlags;
  12 use rustc::ty::Ty;
  13 use rustc::ty::layout::{Align, Size, HasParamEnv};
  14 use rustc_target::spec::{HasTargetSpec};
  15 use std::ops::Range;
  16 use std::iter::TrustedLen;
  17
  18 #[derive(Copy, Clone)]
  19 pub enum OverflowOp {
  20     Add,
  21     Sub,
  22     Mul,
  23 }
  24
  25 pub trait BuilderMethods<'a, 'tcx>:
  26     HasCodegen<'tcx>
  27     + DebugInfoBuilderMethods<'tcx>
  28     + ArgTypeMethods<'tcx>
  29     + AbiBuilderMethods<'tcx>
  30     + IntrinsicCallMethods<'tcx>
  31     + AsmBuilderMethods<'tcx>
  32     + StaticBuilderMethods
  33     + HasParamEnv<'tcx>
  34     + HasTargetSpec
  35
  36 {
  37     fn new_block<'b>(cx: &'a Self::CodegenCx, llfn: Self::Value, name: &'b str) -> Self;
  38     fn with_cx(cx: &'a Self::CodegenCx) -> Self;
  39     fn build_sibling_block<'b>(&self, name: &'b str) -> Self;
  40     fn cx(&self) -> &Self::CodegenCx;
  41     fn llbb(&self) -> Self::BasicBlock;
  42
  43     fn position_at_end(&mut self, llbb: Self::BasicBlock);
  44     fn ret_void(&mut self);
  45     fn ret(&mut self, v: Self::Value);
  46     fn br(&mut self, dest: Self::BasicBlock);
  47     fn cond_br(
  48         &mut self,
  49         cond: Self::Value,
  50         then_llbb: Self::BasicBlock,
  51         else_llbb: Self::BasicBlock,
  52     );
  53     fn switch(
  54         &mut self,
  55         v: Self::Value,
  56         else_llbb: Self::BasicBlock,
  57         cases: impl ExactSizeIterator<Item = (u128, Self::BasicBlock)> + TrustedLen,
  58     );
  59     fn invoke(
  60         &mut self,
  61         llfn: Self::Value,
  62         args: &[Self::Value],
  63         then: Self::BasicBlock,
  64         catch: Self::BasicBlock,
  65         funclet: Option<&Self::Funclet>,
  66     ) -> Self::Value;
  67     fn unreachable(&mut self);
  68
  69     fn add(&mut self, lhs: Self::Value, rhs: Self::Value) -> Self::Value;
  70     fn fadd(&mut self, lhs: Self::Value, rhs: Self::Value) -> Self::Value;
  71     fn fadd_fast(&mut self, lhs: Self::Value, rhs: Self::Value) -> Self::Value;
  72     fn sub(&mut self, lhs: Self::Value, rhs: Self::Value) -> Self::Value;
  73     fn fsub(&mut self, lhs: Self::Value, rhs: Self::Value) -> Self::Value;
  74     fn fsub_fast(&mut self, lhs: Self::Value, rhs: Self::Value) -> Self::Value;
  75     fn mul(&mut self, lhs: Self::Value, rhs: Self::Value) -> Self::Value;
  76     fn fmul(&mut self, lhs: Self::Value, rhs: Self::Value) -> Self::Value;
  77     fn fmul_fast(&mut self, lhs: Self::Value, rhs: Self::Value) -> Self::Value;
  78     fn udiv(&mut self, lhs: Self::Value, rhs: Self::Value) -> Self::Value;
  79     fn exactudiv(&mut self, lhs: Self::Value, rhs: Self::Value) -> Self::Value;
  80     fn sdiv(&mut self, lhs: Self::Value, rhs: Self::Value) -> Self::Value;
  81     fn exactsdiv(&mut self, lhs: Self::Value, rhs: Self::Value) -> Self::Value;
  82     fn fdiv(&mut self, lhs: Self::Value, rhs: Self::Value) -> Self::Value;
  83     fn fdiv_fast(&mut self, lhs: Self::Value, rhs: Self::Value) -> Self::Value;
  84     fn urem(&mut self, lhs: Self::Value, rhs: Self::Value) -> Self::Value;
  85     fn srem(&mut self, lhs: Self::Value, rhs: Self::Value) -> Self::Value;
  86     fn frem(&mut self, lhs: Self::Value, rhs: Self::Value) -> Self::Value;
  87     fn frem_fast(&mut self, lhs: Self::Value, rhs: Self::Value) -> Self::Value;
  88     fn shl(&mut self, lhs: Self::Value, rhs: Self::Value) -> Self::Value;
  89     fn lshr(&mut self, lhs: Self::Value, rhs: Self::Value) -> Self::Value;
  90     fn ashr(&mut self, lhs: Self::Value, rhs: Self::Value) -> Self::Value;
  91     fn unchecked_sadd(&mut self, lhs: Self::Value, rhs: Self::Value) -> Self::Value;
  92     fn unchecked_uadd(&mut self, lhs: Self::Value, rhs: Self::Value) -> Self::Value;
  93     fn unchecked_ssub(&mut self, lhs: Self::Value, rhs: Self::Value) -> Self::Value;
  94     fn unchecked_usub(&mut self, lhs: Self::Value, rhs: Self::Value) -> Self::Value;
  95     fn unchecked_smul(&mut self, lhs: Self::Value, rhs: Self::Value) -> Self::Value;
  96     fn unchecked_umul(&mut self, lhs: Self::Value, rhs: Self::Value) -> Self::Value;
  97     fn and(&mut self, lhs: Self::Value, rhs: Self::Value) -> Self::Value;
  98     fn or(&mut self, lhs: Self::Value, rhs: Self::Value) -> Self::Value;
  99     fn xor(&mut self, lhs: Self::Value, rhs: Self::Value) -> Self::Value;
 100     fn neg(&mut self, v: Self::Value) -> Self::Value;
 101     fn fneg(&mut self, v: Self::Value) -> Self::Value;
 102     fn not(&mut self, v: Self::Value) -> Self::Value;
 103
 104     fn checked_binop(
 105         &mut self,
 106         oop: OverflowOp,
 107         ty: Ty<'_>,
 108         lhs: Self::Value,
 109         rhs: Self::Value,
 110     ) -> (Self::Value, Self::Value);
 111
 112     fn alloca(&mut self, ty: Self::Type, name: &str, align: Align) -> Self::Value;
 113     fn dynamic_alloca(&mut self, ty: Self::Type, name: &str, align: Align) -> Self::Value;
 114     fn array_alloca(
 115         &mut self,
 116         ty: Self::Type,
 117         len: Self::Value,
 118         name: &str,
 119         align: Align,
 120     ) -> Self::Value;
 121
 122     fn load(&mut self, ptr: Self::Value, align: Align) -> Self::Value;
 123     fn volatile_load(&mut self, ptr: Self::Value) -> Self::Value;
 124     fn atomic_load(&mut self, ptr: Self::Value, order: AtomicOrdering, size: Size) -> Self::Value;
 125     fn load_operand(&mut self, place: PlaceRef<'tcx, Self::Value>)
 126         -> OperandRef<'tcx, Self::Value>;
 127
 128         /// Called for Rvalue::Repeat when the elem is neither a ZST nor optimizable using memset.
 129     fn write_operand_repeatedly(
 130         self,
 131         elem: OperandRef<'tcx, Self::Value>,
 132         count: u64,
 133         dest: PlaceRef<'tcx, Self::Value>,
 134     ) -> Self;
 135
 136     fn range_metadata(&mut self, load: Self::Value, range: Range<u128>);
 137     fn nonnull_metadata(&mut self, load: Self::Value);
 138
 139     fn store(&mut self, val: Self::Value, ptr: Self::Value, align: Align) -> Self::Value;
 140     fn store_with_flags(
 141         &mut self,
 142         val: Self::Value,
 143         ptr: Self::Value,
 144         align: Align,
 145         flags: MemFlags,
 146     ) -> Self::Value;
 147     fn atomic_store(
 148         &mut self,
 149         val: Self::Value,
 150         ptr: Self::Value,
 151         order: AtomicOrdering,
 152         size: Size,
 153     );
 154
 155     fn gep(&mut self, ptr: Self::Value, indices: &[Self::Value]) -> Self::Value;
 156     fn inbounds_gep(&mut self, ptr: Self::Value, indices: &[Self::Value]) -> Self::Value;
 157     fn struct_gep(&mut self, ptr: Self::Value, idx: u64) -> Self::Value;
 158
 159     fn trunc(&mut self, val: Self::Value, dest_ty: Self::Type) -> Self::Value;
 160     fn sext(&mut self, val: Self::Value, dest_ty: Self::Type) -> Self::Value;
 161     fn fptoui(&mut self, val: Self::Value, dest_ty: Self::Type) -> Self::Value;
 162     fn fptosi(&mut self, val: Self::Value, dest_ty: Self::Type) -> Self::Value;
 163     fn uitofp(&mut self, val: Self::Value, dest_ty: Self::Type) -> Self::Value;
 164     fn sitofp(&mut self, val: Self::Value, dest_ty: Self::Type) -> Self::Value;
 165     fn fptrunc(&mut self, val: Self::Value, dest_ty: Self::Type) -> Self::Value;
 166     fn fpext(&mut self, val: Self::Value, dest_ty: Self::Type) -> Self::Value;
 167     fn ptrtoint(&mut self, val: Self::Value, dest_ty: Self::Type) -> Self::Value;
 168     fn inttoptr(&mut self, val: Self::Value, dest_ty: Self::Type) -> Self::Value;
 169     fn bitcast(&mut self, val: Self::Value, dest_ty: Self::Type) -> Self::Value;
 170     fn intcast(&mut self, val: Self::Value, dest_ty: Self::Type, is_signed: bool) -> Self::Value;
 171     fn pointercast(&mut self, val: Self::Value, dest_ty: Self::Type) -> Self::Value;
 172
 173     fn icmp(&mut self, op: IntPredicate, lhs: Self::Value, rhs: Self::Value) -> Self::Value;
 174     fn fcmp(&mut self, op: RealPredicate, lhs: Self::Value, rhs: Self::Value) -> Self::Value;
 175
 176     fn memcpy(
 177         &mut self,
 178         dst: Self::Value,
 179         dst_align: Align,
 180         src: Self::Value,
 181         src_align: Align,
 182         size: Self::Value,
 183         flags: MemFlags,
 184     );
 185     fn memmove(
 186         &mut self,
 187         dst: Self::Value,
 188         dst_align: Align,
 189         src: Self::Value,
 190         src_align: Align,
 191         size: Self::Value,
 192         flags: MemFlags,
 193     );
 194     fn memset(
 195         &mut self,
 196         ptr: Self::Value,
 197         fill_byte: Self::Value,
 198         size: Self::Value,
 199         align: Align,
 200         flags: MemFlags,
 201     );
 202
 203     fn select(
 204         &mut self,
 205         cond: Self::Value,
 206         then_val: Self::Value,
 207         else_val: Self::Value,
 208     ) -> Self::Value;
 209
 210     fn va_arg(&mut self, list: Self::Value, ty: Self::Type) -> Self::Value;
 211     fn extract_element(&mut self, vec: Self::Value, idx: Self::Value) -> Self::Value;
 212     fn vector_splat(&mut self, num_elts: usize, elt: Self::Value) -> Self::Value;
 213     fn extract_value(&mut self, agg_val: Self::Value, idx: u64) -> Self::Value;
 214     fn insert_value(&mut self, agg_val: Self::Value, elt: Self::Value, idx: u64) -> Self::Value;
 215
 216     fn landing_pad(
 217         &mut self,
 218         ty: Self::Type,
 219         pers_fn: Self::Value,
 220         num_clauses: usize,
 221     ) -> Self::Value;
 222     fn set_cleanup(&mut self, landing_pad: Self::Value);
 223     fn resume(&mut self, exn: Self::Value) -> Self::Value;
 224     fn cleanup_pad(&mut self, parent: Option<Self::Value>, args: &[Self::Value]) -> Self::Funclet;
 225     fn cleanup_ret(
 226         &mut self,
 227         funclet: &Self::Funclet,
 228         unwind: Option<Self::BasicBlock>,
 229     ) -> Self::Value;
 230     fn catch_pad(&mut self, parent: Self::Value, args: &[Self::Value]) -> Self::Funclet;
 231     fn catch_switch(
 232         &mut self,
 233         parent: Option<Self::Value>,
 234         unwind: Option<Self::BasicBlock>,
 235         num_handlers: usize,
 236     ) -> Self::Value;
 237     fn add_handler(&mut self, catch_switch: Self::Value, handler: Self::BasicBlock);
 238     fn set_personality_fn(&mut self, personality: Self::Value);
 239
 240     fn atomic_cmpxchg(
 241         &mut self,
 242         dst: Self::Value,
 243         cmp: Self::Value,
 244         src: Self::Value,
 245         order: AtomicOrdering,
 246         failure_order: AtomicOrdering,
 247         weak: bool,
 248     ) -> Self::Value;
 249     fn atomic_rmw(
 250         &mut self,
 251         op: AtomicRmwBinOp,
 252         dst: Self::Value,
 253         src: Self::Value,
 254         order: AtomicOrdering,
 255     ) -> Self::Value;
 256     fn atomic_fence(&mut self, order: AtomicOrdering, scope: SynchronizationScope);
 257     fn set_invariant_load(&mut self, load: Self::Value);
 258
 259     /// Called for `StorageLive`
 260     fn lifetime_start(&mut self, ptr: Self::Value, size: Size);
 261
 262     /// Called for `StorageDead`
 263     fn lifetime_end(&mut self, ptr: Self::Value, size: Size);
 264
 265     fn call(
 266         &mut self,
 267         llfn: Self::Value,
 268         args: &[Self::Value],
 269         funclet: Option<&Self::Funclet>,
 270     ) -> Self::Value;
 271     fn zext(&mut self, val: Self::Value, dest_ty: Self::Type) -> Self::Value;
 272
 273     unsafe fn delete_basic_block(&mut self, bb: Self::BasicBlock);
 274     fn do_not_inline(&mut self, llret: Self::Value);
 275 }