3 use std::convert::TryFrom;
18 use rustc_apfloat::{ieee, Float, Round, Status};
19 use rustc_codegen_ssa::MemFlags;
20 use rustc_codegen_ssa::common::{
21 AtomicOrdering, AtomicRmwBinOp, IntPredicate, RealPredicate, SynchronizationScope, TypeKind,
23 use rustc_codegen_ssa::mir::operand::{OperandRef, OperandValue};
24 use rustc_codegen_ssa::mir::place::PlaceRef;
25 use rustc_codegen_ssa::traits::{
36 use rustc_data_structures::fx::FxHashSet;
37 use rustc_middle::bug;
38 use rustc_middle::ty::{ParamEnv, Ty, TyCtxt};
39 use rustc_middle::ty::layout::{FnAbiError, FnAbiOfHelpers, FnAbiRequest, HasParamEnv, HasTyCtxt, LayoutError, LayoutOfHelpers, TyAndLayout};
41 use rustc_span::def_id::DefId;
42 use rustc_target::abi::{
51 use rustc_target::spec::{HasTargetSpec, Target};
53 use crate::common::{SignType, TypeReflection, type_is_pointer};
54 use crate::context::CodegenCx;
55 use crate::intrinsic::llvm;
56 use crate::type_of::LayoutGccExt;
61 // TODO(antoyo): remove this variable.
62 static mut RETURN_VALUE_COUNT: usize = 0;
64 enum ExtremumOperation {
69 pub struct Builder<'a: 'gcc, 'gcc, 'tcx> {
70 pub cx: &'a CodegenCx<'gcc, 'tcx>,
71 pub block: Block<'gcc>,
72 stack_var_count: Cell<usize>,
75 impl<'a, 'gcc, 'tcx> Builder<'a, 'gcc, 'tcx> {
76 fn with_cx(cx: &'a CodegenCx<'gcc, 'tcx>, block: Block<'gcc>) -> Self {
80 stack_var_count: Cell::new(0),
84 fn atomic_extremum(&mut self, operation: ExtremumOperation, dst: RValue<'gcc>, src: RValue<'gcc>, order: AtomicOrdering) -> RValue<'gcc> {
85 let size = src.get_type().get_size();
87 let func = self.current_func();
91 // TODO(antoyo): does this make sense?
92 AtomicOrdering::AcquireRelease | AtomicOrdering::Release => AtomicOrdering::Acquire,
95 let previous_value = self.atomic_load(dst.get_type(), dst, load_ordering, Size::from_bytes(size));
96 let previous_var = func.new_local(None, previous_value.get_type(), "previous_value");
97 let return_value = func.new_local(None, previous_value.get_type(), "return_value");
98 self.llbb().add_assignment(None, previous_var, previous_value);
99 self.llbb().add_assignment(None, return_value, previous_var.to_rvalue());
101 let while_block = func.new_block("while");
102 let after_block = func.new_block("after_while");
103 self.llbb().end_with_jump(None, while_block);
105 // NOTE: since jumps were added and compare_exchange doesn't expect this, the current block in the
106 // state need to be updated.
107 self.switch_to_block(while_block);
109 let comparison_operator =
111 ExtremumOperation::Max => ComparisonOp::LessThan,
112 ExtremumOperation::Min => ComparisonOp::GreaterThan,
115 let cond1 = self.context.new_comparison(None, comparison_operator, previous_var.to_rvalue(), self.context.new_cast(None, src, previous_value.get_type()));
116 let compare_exchange = self.compare_exchange(dst, previous_var, src, order, load_ordering, false);
117 let cond2 = self.cx.context.new_unary_op(None, UnaryOp::LogicalNegate, compare_exchange.get_type(), compare_exchange);
118 let cond = self.cx.context.new_binary_op(None, BinaryOp::LogicalAnd, self.cx.bool_type, cond1, cond2);
120 while_block.end_with_conditional(None, cond, while_block, after_block);
122 // NOTE: since jumps were added in a place rustc does not expect, the current block in the
123 // state need to be updated.
124 self.switch_to_block(after_block);
126 return_value.to_rvalue()
129 fn compare_exchange(&self, dst: RValue<'gcc>, cmp: LValue<'gcc>, src: RValue<'gcc>, order: AtomicOrdering, failure_order: AtomicOrdering, weak: bool) -> RValue<'gcc> {
130 let size = src.get_type().get_size();
131 let compare_exchange = self.context.get_builtin_function(&format!("__atomic_compare_exchange_{}", size));
132 let order = self.context.new_rvalue_from_int(self.i32_type, order.to_gcc());
133 let failure_order = self.context.new_rvalue_from_int(self.i32_type, failure_order.to_gcc());
134 let weak = self.context.new_rvalue_from_int(self.bool_type, weak as i32);
136 let void_ptr_type = self.context.new_type::<*mut ()>();
137 let volatile_void_ptr_type = void_ptr_type.make_volatile();
138 let dst = self.context.new_cast(None, dst, volatile_void_ptr_type);
139 let expected = self.context.new_cast(None, cmp.get_address(None), void_ptr_type);
141 // NOTE: not sure why, but we have the wrong type here.
142 let int_type = compare_exchange.get_param(2).to_rvalue().get_type();
143 let src = self.context.new_cast(None, src, int_type);
144 self.context.new_call(None, compare_exchange, &[dst, expected, src, weak, order, failure_order])
147 pub fn assign(&self, lvalue: LValue<'gcc>, value: RValue<'gcc>) {
148 self.llbb().add_assignment(None, lvalue, value);
151 fn check_call<'b>(&mut self, _typ: &str, func: Function<'gcc>, args: &'b [RValue<'gcc>]) -> Cow<'b, [RValue<'gcc>]> {
152 let mut all_args_match = true;
153 let mut param_types = vec![];
154 let param_count = func.get_param_count();
155 for (index, arg) in args.iter().enumerate().take(param_count) {
156 let param = func.get_param(index as i32);
157 let param = param.to_rvalue().get_type();
158 if param != arg.get_type() {
159 all_args_match = false;
161 param_types.push(param);
165 return Cow::Borrowed(args);
168 let casted_args: Vec<_> = param_types
172 .map(|(_i, (expected_ty, &actual_val))| {
173 let actual_ty = actual_val.get_type();
174 if expected_ty != actual_ty {
175 self.bitcast(actual_val, expected_ty)
183 Cow::Owned(casted_args)
186 fn check_ptr_call<'b>(&mut self, _typ: &str, func_ptr: RValue<'gcc>, args: &'b [RValue<'gcc>]) -> Cow<'b, [RValue<'gcc>]> {
187 let mut all_args_match = true;
188 let mut param_types = vec![];
189 let gcc_func = func_ptr.get_type().dyncast_function_ptr_type().expect("function ptr");
190 for (index, arg) in args.iter().enumerate().take(gcc_func.get_param_count()) {
191 let param = gcc_func.get_param_type(index);
192 if param != arg.get_type() {
193 all_args_match = false;
195 param_types.push(param);
198 let mut on_stack_param_indices = FxHashSet::default();
199 if let Some(indices) = self.on_stack_params.borrow().get(&gcc_func) {
200 on_stack_param_indices = indices.clone();
204 return Cow::Borrowed(args);
207 let func_name = format!("{:?}", func_ptr);
209 let casted_args: Vec<_> = param_types
213 .map(|(index, (expected_ty, &actual_val))| {
214 if llvm::ignore_arg_cast(&func_name, index, args.len()) {
218 let actual_ty = actual_val.get_type();
219 if expected_ty != actual_ty {
220 if !actual_ty.is_vector() && !expected_ty.is_vector() && actual_ty.is_integral() && expected_ty.is_integral() && actual_ty.get_size() != expected_ty.get_size() {
221 self.context.new_cast(None, actual_val, expected_ty)
223 else if on_stack_param_indices.contains(&index) {
224 actual_val.dereference(None).to_rvalue()
227 assert!(!((actual_ty.is_vector() && !expected_ty.is_vector()) || (!actual_ty.is_vector() && expected_ty.is_vector())), "{:?} ({}) -> {:?} ({}), index: {:?}[{}]", actual_ty, actual_ty.is_vector(), expected_ty, expected_ty.is_vector(), func_ptr, index);
228 // TODO(antoyo): perhaps use __builtin_convertvector for vector casting.
229 self.bitcast(actual_val, expected_ty)
238 Cow::Owned(casted_args)
241 fn check_store(&mut self, val: RValue<'gcc>, ptr: RValue<'gcc>) -> RValue<'gcc> {
242 let dest_ptr_ty = self.cx.val_ty(ptr).make_pointer(); // TODO(antoyo): make sure make_pointer() is okay here.
243 let stored_ty = self.cx.val_ty(val);
244 let stored_ptr_ty = self.cx.type_ptr_to(stored_ty);
246 if dest_ptr_ty == stored_ptr_ty {
250 self.bitcast(ptr, stored_ptr_ty)
254 pub fn current_func(&self) -> Function<'gcc> {
255 self.block.get_function()
258 fn function_call(&mut self, func: RValue<'gcc>, args: &[RValue<'gcc>], _funclet: Option<&Funclet>) -> RValue<'gcc> {
259 // TODO(antoyo): remove when the API supports a different type for functions.
260 let func: Function<'gcc> = self.cx.rvalue_as_function(func);
261 let args = self.check_call("call", func, args);
263 // gccjit requires to use the result of functions, even when it's not used.
264 // That's why we assign the result to a local or call add_eval().
265 let return_type = func.get_return_type();
266 let void_type = self.context.new_type::<()>();
267 let current_func = self.block.get_function();
268 if return_type != void_type {
269 unsafe { RETURN_VALUE_COUNT += 1 };
270 let result = current_func.new_local(None, return_type, &format!("returnValue{}", unsafe { RETURN_VALUE_COUNT }));
271 self.block.add_assignment(None, result, self.cx.context.new_call(None, func, &args));
275 self.block.add_eval(None, self.cx.context.new_call(None, func, &args));
276 // Return dummy value when not having return value.
277 self.context.new_rvalue_from_long(self.isize_type, 0)
281 fn function_ptr_call(&mut self, func_ptr: RValue<'gcc>, args: &[RValue<'gcc>], _funclet: Option<&Funclet>) -> RValue<'gcc> {
282 let args = self.check_ptr_call("call", func_ptr, args);
284 // gccjit requires to use the result of functions, even when it's not used.
285 // That's why we assign the result to a local or call add_eval().
286 let gcc_func = func_ptr.get_type().dyncast_function_ptr_type().expect("function ptr");
287 let return_type = gcc_func.get_return_type();
288 let void_type = self.context.new_type::<()>();
289 let current_func = self.block.get_function();
291 if return_type != void_type {
292 unsafe { RETURN_VALUE_COUNT += 1 };
293 let result = current_func.new_local(None, return_type, &format!("ptrReturnValue{}", unsafe { RETURN_VALUE_COUNT }));
294 let func_name = format!("{:?}", func_ptr);
295 let args = llvm::adjust_intrinsic_arguments(&self, gcc_func, args, &func_name);
296 self.block.add_assignment(None, result, self.cx.context.new_call_through_ptr(None, func_ptr, &args));
300 #[cfg(not(feature="master"))]
301 if gcc_func.get_param_count() == 0 {
302 // FIXME(antoyo): As a temporary workaround for unsupported LLVM intrinsics.
303 self.block.add_eval(None, self.cx.context.new_call_through_ptr(None, func_ptr, &[]));
306 self.block.add_eval(None, self.cx.context.new_call_through_ptr(None, func_ptr, &args));
308 #[cfg(feature="master")]
309 self.block.add_eval(None, self.cx.context.new_call_through_ptr(None, func_ptr, &args));
310 // Return dummy value when not having return value.
311 let result = current_func.new_local(None, self.isize_type, "dummyValueThatShouldNeverBeUsed");
312 self.block.add_assignment(None, result, self.context.new_rvalue_from_long(self.isize_type, 0));
317 pub fn overflow_call(&self, func: Function<'gcc>, args: &[RValue<'gcc>], _funclet: Option<&Funclet>) -> RValue<'gcc> {
318 // gccjit requires to use the result of functions, even when it's not used.
319 // That's why we assign the result to a local.
320 let return_type = self.context.new_type::<bool>();
321 let current_func = self.block.get_function();
322 // TODO(antoyo): return the new_call() directly? Since the overflow function has no side-effects.
323 unsafe { RETURN_VALUE_COUNT += 1 };
324 let result = current_func.new_local(None, return_type, &format!("overflowReturnValue{}", unsafe { RETURN_VALUE_COUNT }));
325 self.block.add_assignment(None, result, self.cx.context.new_call(None, func, &args));
330 impl<'gcc, 'tcx> HasCodegen<'tcx> for Builder<'_, 'gcc, 'tcx> {
331 type CodegenCx = CodegenCx<'gcc, 'tcx>;
334 impl<'tcx> HasTyCtxt<'tcx> for Builder<'_, '_, 'tcx> {
335 fn tcx(&self) -> TyCtxt<'tcx> {
340 impl HasDataLayout for Builder<'_, '_, '_> {
341 fn data_layout(&self) -> &TargetDataLayout {
342 self.cx.data_layout()
346 impl<'tcx> LayoutOfHelpers<'tcx> for Builder<'_, '_, 'tcx> {
347 type LayoutOfResult = TyAndLayout<'tcx>;
350 fn handle_layout_err(&self, err: LayoutError<'tcx>, span: Span, ty: Ty<'tcx>) -> ! {
351 self.cx.handle_layout_err(err, span, ty)
355 impl<'tcx> FnAbiOfHelpers<'tcx> for Builder<'_, '_, 'tcx> {
356 type FnAbiOfResult = &'tcx FnAbi<'tcx, Ty<'tcx>>;
359 fn handle_fn_abi_err(
361 err: FnAbiError<'tcx>,
363 fn_abi_request: FnAbiRequest<'tcx>,
365 self.cx.handle_fn_abi_err(err, span, fn_abi_request)
369 impl<'gcc, 'tcx> Deref for Builder<'_, 'gcc, 'tcx> {
370 type Target = CodegenCx<'gcc, 'tcx>;
372 fn deref(&self) -> &Self::Target {
377 impl<'gcc, 'tcx> BackendTypes for Builder<'_, 'gcc, 'tcx> {
378 type Value = <CodegenCx<'gcc, 'tcx> as BackendTypes>::Value;
379 type Function = <CodegenCx<'gcc, 'tcx> as BackendTypes>::Function;
380 type BasicBlock = <CodegenCx<'gcc, 'tcx> as BackendTypes>::BasicBlock;
381 type Type = <CodegenCx<'gcc, 'tcx> as BackendTypes>::Type;
382 type Funclet = <CodegenCx<'gcc, 'tcx> as BackendTypes>::Funclet;
384 type DIScope = <CodegenCx<'gcc, 'tcx> as BackendTypes>::DIScope;
385 type DILocation = <CodegenCx<'gcc, 'tcx> as BackendTypes>::DILocation;
386 type DIVariable = <CodegenCx<'gcc, 'tcx> as BackendTypes>::DIVariable;
389 impl<'a, 'gcc, 'tcx> BuilderMethods<'a, 'tcx> for Builder<'a, 'gcc, 'tcx> {
390 fn build(cx: &'a CodegenCx<'gcc, 'tcx>, block: Block<'gcc>) -> Self {
391 Builder::with_cx(cx, block)
394 fn llbb(&self) -> Block<'gcc> {
398 fn append_block(cx: &'a CodegenCx<'gcc, 'tcx>, func: RValue<'gcc>, name: &str) -> Block<'gcc> {
399 let func = cx.rvalue_as_function(func);
403 fn append_sibling_block(&mut self, name: &str) -> Block<'gcc> {
404 let func = self.current_func();
408 fn switch_to_block(&mut self, block: Self::BasicBlock) {
412 fn ret_void(&mut self) {
413 self.llbb().end_with_void_return(None)
416 fn ret(&mut self, value: RValue<'gcc>) {
418 if self.structs_as_pointer.borrow().contains(&value) {
419 // NOTE: hack to workaround a limitation of the rustc API: see comment on
420 // CodegenCx.structs_as_pointer
421 value.dereference(None).to_rvalue()
426 self.llbb().end_with_return(None, value);
429 fn br(&mut self, dest: Block<'gcc>) {
430 self.llbb().end_with_jump(None, dest)
433 fn cond_br(&mut self, cond: RValue<'gcc>, then_block: Block<'gcc>, else_block: Block<'gcc>) {
434 self.llbb().end_with_conditional(None, cond, then_block, else_block)
437 fn switch(&mut self, value: RValue<'gcc>, default_block: Block<'gcc>, cases: impl ExactSizeIterator<Item = (u128, Block<'gcc>)>) {
438 let mut gcc_cases = vec![];
439 let typ = self.val_ty(value);
440 for (on_val, dest) in cases {
441 let on_val = self.const_uint_big(typ, on_val);
442 gcc_cases.push(self.context.new_case(on_val, on_val, dest));
444 self.block.end_with_switch(None, value, default_block, &gcc_cases);
450 fn_abi: Option<&FnAbi<'tcx, Ty<'tcx>>>,
452 args: &[RValue<'gcc>],
455 _funclet: Option<&Funclet>,
457 // TODO(bjorn3): Properly implement unwinding.
458 let call_site = self.call(typ, None, func, args, None);
459 let condition = self.context.new_rvalue_from_int(self.bool_type, 1);
460 self.llbb().end_with_conditional(None, condition, then, catch);
461 if let Some(_fn_abi) = fn_abi {
462 // TODO(bjorn3): Apply function attributes
467 fn unreachable(&mut self) {
468 let func = self.context.get_builtin_function("__builtin_unreachable");
469 self.block.add_eval(None, self.context.new_call(None, func, &[]));
470 let return_type = self.block.get_function().get_return_type();
471 let void_type = self.context.new_type::<()>();
472 if return_type == void_type {
473 self.block.end_with_void_return(None)
476 let return_value = self.current_func()
477 .new_local(None, return_type, "unreachableReturn");
478 self.block.end_with_return(None, return_value)
482 fn add(&mut self, a: RValue<'gcc>, b: RValue<'gcc>) -> RValue<'gcc> {
486 fn fadd(&mut self, a: RValue<'gcc>, b: RValue<'gcc>) -> RValue<'gcc> {
490 fn sub(&mut self, a: RValue<'gcc>, b: RValue<'gcc>) -> RValue<'gcc> {
494 fn fsub(&mut self, a: RValue<'gcc>, b: RValue<'gcc>) -> RValue<'gcc> {
498 fn mul(&mut self, a: RValue<'gcc>, b: RValue<'gcc>) -> RValue<'gcc> {
502 fn fmul(&mut self, a: RValue<'gcc>, b: RValue<'gcc>) -> RValue<'gcc> {
506 fn udiv(&mut self, a: RValue<'gcc>, b: RValue<'gcc>) -> RValue<'gcc> {
510 fn exactudiv(&mut self, a: RValue<'gcc>, b: RValue<'gcc>) -> RValue<'gcc> {
511 // TODO(antoyo): poison if not exact.
512 let a_type = a.get_type().to_unsigned(self);
513 let a = self.gcc_int_cast(a, a_type);
514 let b_type = b.get_type().to_unsigned(self);
515 let b = self.gcc_int_cast(b, b_type);
519 fn sdiv(&mut self, a: RValue<'gcc>, b: RValue<'gcc>) -> RValue<'gcc> {
523 fn exactsdiv(&mut self, a: RValue<'gcc>, b: RValue<'gcc>) -> RValue<'gcc> {
524 // TODO(antoyo): poison if not exact.
525 // FIXME(antoyo): rustc_codegen_ssa::mir::intrinsic uses different types for a and b but they
526 // should be the same.
527 let typ = a.get_type().to_signed(self);
528 let b = self.context.new_cast(None, b, typ);
532 fn fdiv(&mut self, a: RValue<'gcc>, b: RValue<'gcc>) -> RValue<'gcc> {
536 fn urem(&mut self, a: RValue<'gcc>, b: RValue<'gcc>) -> RValue<'gcc> {
540 fn srem(&mut self, a: RValue<'gcc>, b: RValue<'gcc>) -> RValue<'gcc> {
544 fn frem(&mut self, a: RValue<'gcc>, b: RValue<'gcc>) -> RValue<'gcc> {
545 if a.get_type().is_compatible_with(self.cx.float_type) {
546 let fmodf = self.context.get_builtin_function("fmodf");
547 // FIXME(antoyo): this seems to produce the wrong result.
548 return self.context.new_call(None, fmodf, &[a, b]);
550 assert_eq!(a.get_type().unqualified(), self.cx.double_type);
552 let fmod = self.context.get_builtin_function("fmod");
553 return self.context.new_call(None, fmod, &[a, b]);
556 fn shl(&mut self, a: RValue<'gcc>, b: RValue<'gcc>) -> RValue<'gcc> {
560 fn lshr(&mut self, a: RValue<'gcc>, b: RValue<'gcc>) -> RValue<'gcc> {
564 fn ashr(&mut self, a: RValue<'gcc>, b: RValue<'gcc>) -> RValue<'gcc> {
565 // TODO(antoyo): check whether behavior is an arithmetic shift for >> .
566 // It seems to be if the value is signed.
570 fn and(&mut self, a: RValue<'gcc>, b: RValue<'gcc>) -> RValue<'gcc> {
574 fn or(&mut self, a: RValue<'gcc>, b: RValue<'gcc>) -> RValue<'gcc> {
578 fn xor(&mut self, a: RValue<'gcc>, b: RValue<'gcc>) -> RValue<'gcc> {
582 fn neg(&mut self, a: RValue<'gcc>) -> RValue<'gcc> {
586 fn fneg(&mut self, a: RValue<'gcc>) -> RValue<'gcc> {
587 self.cx.context.new_unary_op(None, UnaryOp::Minus, a.get_type(), a)
590 fn not(&mut self, a: RValue<'gcc>) -> RValue<'gcc> {
594 fn unchecked_sadd(&mut self, a: RValue<'gcc>, b: RValue<'gcc>) -> RValue<'gcc> {
598 fn unchecked_uadd(&mut self, a: RValue<'gcc>, b: RValue<'gcc>) -> RValue<'gcc> {
602 fn unchecked_ssub(&mut self, a: RValue<'gcc>, b: RValue<'gcc>) -> RValue<'gcc> {
606 fn unchecked_usub(&mut self, a: RValue<'gcc>, b: RValue<'gcc>) -> RValue<'gcc> {
607 // TODO(antoyo): should generate poison value?
611 fn unchecked_smul(&mut self, a: RValue<'gcc>, b: RValue<'gcc>) -> RValue<'gcc> {
615 fn unchecked_umul(&mut self, a: RValue<'gcc>, b: RValue<'gcc>) -> RValue<'gcc> {
619 fn fadd_fast(&mut self, _lhs: RValue<'gcc>, _rhs: RValue<'gcc>) -> RValue<'gcc> {
623 fn fsub_fast(&mut self, _lhs: RValue<'gcc>, _rhs: RValue<'gcc>) -> RValue<'gcc> {
627 fn fmul_fast(&mut self, _lhs: RValue<'gcc>, _rhs: RValue<'gcc>) -> RValue<'gcc> {
631 fn fdiv_fast(&mut self, _lhs: RValue<'gcc>, _rhs: RValue<'gcc>) -> RValue<'gcc> {
635 fn frem_fast(&mut self, _lhs: RValue<'gcc>, _rhs: RValue<'gcc>) -> RValue<'gcc> {
639 fn checked_binop(&mut self, oop: OverflowOp, typ: Ty<'_>, lhs: Self::Value, rhs: Self::Value) -> (Self::Value, Self::Value) {
640 self.gcc_checked_binop(oop, typ, lhs, rhs)
643 fn alloca(&mut self, ty: Type<'gcc>, align: Align) -> RValue<'gcc> {
644 // FIXME(antoyo): this check that we don't call get_aligned() a second time on a type.
645 // Ideally, we shouldn't need to do this check.
647 if ty == self.cx.u128_type || ty == self.cx.i128_type {
651 ty.get_aligned(align.bytes())
653 // TODO(antoyo): It might be better to return a LValue, but fixing the rustc API is non-trivial.
654 self.stack_var_count.set(self.stack_var_count.get() + 1);
655 self.current_func().new_local(None, aligned_type, &format!("stack_var_{}", self.stack_var_count.get())).get_address(None)
658 fn byte_array_alloca(&mut self, _len: RValue<'gcc>, _align: Align) -> RValue<'gcc> {
662 fn load(&mut self, pointee_ty: Type<'gcc>, ptr: RValue<'gcc>, _align: Align) -> RValue<'gcc> {
663 let block = self.llbb();
664 let function = block.get_function();
665 // NOTE: instead of returning the dereference here, we have to assign it to a variable in
666 // the current basic block. Otherwise, it could be used in another basic block, causing a
667 // dereference after a drop, for instance.
668 // TODO(antoyo): handle align of the load instruction.
669 let ptr = self.context.new_cast(None, ptr, pointee_ty.make_pointer());
670 let deref = ptr.dereference(None).to_rvalue();
671 unsafe { RETURN_VALUE_COUNT += 1 };
672 let loaded_value = function.new_local(None, pointee_ty, &format!("loadedValue{}", unsafe { RETURN_VALUE_COUNT }));
673 block.add_assignment(None, loaded_value, deref);
674 loaded_value.to_rvalue()
677 fn volatile_load(&mut self, _ty: Type<'gcc>, ptr: RValue<'gcc>) -> RValue<'gcc> {
678 // TODO(antoyo): use ty.
679 let ptr = self.context.new_cast(None, ptr, ptr.get_type().make_volatile());
680 ptr.dereference(None).to_rvalue()
683 fn atomic_load(&mut self, _ty: Type<'gcc>, ptr: RValue<'gcc>, order: AtomicOrdering, size: Size) -> RValue<'gcc> {
684 // TODO(antoyo): use ty.
685 // TODO(antoyo): handle alignment.
686 let atomic_load = self.context.get_builtin_function(&format!("__atomic_load_{}", size.bytes()));
687 let ordering = self.context.new_rvalue_from_int(self.i32_type, order.to_gcc());
689 let volatile_const_void_ptr_type = self.context.new_type::<()>()
693 let ptr = self.context.new_cast(None, ptr, volatile_const_void_ptr_type);
694 self.context.new_call(None, atomic_load, &[ptr, ordering])
697 fn load_operand(&mut self, place: PlaceRef<'tcx, RValue<'gcc>>) -> OperandRef<'tcx, RValue<'gcc>> {
698 assert_eq!(place.llextra.is_some(), place.layout.is_unsized());
700 if place.layout.is_zst() {
701 return OperandRef::new_zst(self, place.layout);
704 fn scalar_load_metadata<'a, 'gcc, 'tcx>(bx: &mut Builder<'a, 'gcc, 'tcx>, load: RValue<'gcc>, scalar: &abi::Scalar) {
705 let vr = scalar.valid_range(bx);
706 match scalar.primitive() {
708 if !scalar.is_always_valid(bx) {
709 bx.range_metadata(load, vr);
712 abi::Pointer if vr.start < vr.end && !vr.contains(0) => {
713 bx.nonnull_metadata(load);
720 if let Some(llextra) = place.llextra {
721 OperandValue::Ref(place.llval, Some(llextra), place.align)
723 else if place.layout.is_gcc_immediate() {
724 let load = self.load(
725 place.layout.gcc_type(self, false),
729 if let abi::Abi::Scalar(ref scalar) = place.layout.abi {
730 scalar_load_metadata(self, load, scalar);
732 OperandValue::Immediate(self.to_immediate(load, place.layout))
734 else if let abi::Abi::ScalarPair(ref a, ref b) = place.layout.abi {
735 let b_offset = a.size(self).align_to(b.align(self).abi);
736 let pair_type = place.layout.gcc_type(self, false);
738 let mut load = |i, scalar: &abi::Scalar, align| {
739 let llptr = self.struct_gep(pair_type, place.llval, i as u64);
740 let llty = place.layout.scalar_pair_element_gcc_type(self, i, false);
741 let load = self.load(llty, llptr, align);
742 scalar_load_metadata(self, load, scalar);
743 if scalar.is_bool() { self.trunc(load, self.type_i1()) } else { load }
747 load(0, a, place.align),
748 load(1, b, place.align.restrict_for_offset(b_offset)),
752 OperandValue::Ref(place.llval, None, place.align)
755 OperandRef { val, layout: place.layout }
758 fn write_operand_repeatedly(&mut self, cg_elem: OperandRef<'tcx, RValue<'gcc>>, count: u64, dest: PlaceRef<'tcx, RValue<'gcc>>) {
759 let zero = self.const_usize(0);
760 let count = self.const_usize(count);
761 let start = dest.project_index(self, zero).llval;
762 let end = dest.project_index(self, count).llval;
764 let header_bb = self.append_sibling_block("repeat_loop_header");
765 let body_bb = self.append_sibling_block("repeat_loop_body");
766 let next_bb = self.append_sibling_block("repeat_loop_next");
768 let ptr_type = start.get_type();
769 let current = self.llbb().get_function().new_local(None, ptr_type, "loop_var");
770 let current_val = current.to_rvalue();
771 self.assign(current, start);
775 self.switch_to_block(header_bb);
776 let keep_going = self.icmp(IntPredicate::IntNE, current_val, end);
777 self.cond_br(keep_going, body_bb, next_bb);
779 self.switch_to_block(body_bb);
780 let align = dest.align.restrict_for_offset(dest.layout.field(self.cx(), 0).size);
781 cg_elem.val.store(self, PlaceRef::new_sized_aligned(current_val, cg_elem.layout, align));
783 let next = self.inbounds_gep(self.backend_type(cg_elem.layout), current.to_rvalue(), &[self.const_usize(1)]);
784 self.llbb().add_assignment(None, current, next);
787 self.switch_to_block(next_bb);
790 fn range_metadata(&mut self, _load: RValue<'gcc>, _range: WrappingRange) {
794 fn nonnull_metadata(&mut self, _load: RValue<'gcc>) {
798 fn store(&mut self, val: RValue<'gcc>, ptr: RValue<'gcc>, align: Align) -> RValue<'gcc> {
799 self.store_with_flags(val, ptr, align, MemFlags::empty())
802 fn store_with_flags(&mut self, val: RValue<'gcc>, ptr: RValue<'gcc>, align: Align, _flags: MemFlags) -> RValue<'gcc> {
803 let ptr = self.check_store(val, ptr);
804 let destination = ptr.dereference(None);
805 // NOTE: libgccjit does not support specifying the alignment on the assignment, so we cast
806 // to type so it gets the proper alignment.
807 let destination_type = destination.to_rvalue().get_type().unqualified();
808 let aligned_type = destination_type.get_aligned(align.bytes()).make_pointer();
809 let aligned_destination = self.cx.context.new_bitcast(None, ptr, aligned_type);
810 let aligned_destination = aligned_destination.dereference(None);
811 self.llbb().add_assignment(None, aligned_destination, val);
812 // TODO(antoyo): handle align and flags.
813 // NOTE: dummy value here since it's never used. FIXME(antoyo): API should not return a value here?
814 self.cx.context.new_rvalue_zero(self.type_i32())
817 fn atomic_store(&mut self, value: RValue<'gcc>, ptr: RValue<'gcc>, order: AtomicOrdering, size: Size) {
818 // TODO(antoyo): handle alignment.
819 let atomic_store = self.context.get_builtin_function(&format!("__atomic_store_{}", size.bytes()));
820 let ordering = self.context.new_rvalue_from_int(self.i32_type, order.to_gcc());
821 let volatile_const_void_ptr_type = self.context.new_type::<()>()
824 let ptr = self.context.new_cast(None, ptr, volatile_const_void_ptr_type);
826 // FIXME(antoyo): fix libgccjit to allow comparing an integer type with an aligned integer type because
827 // the following cast is required to avoid this error:
828 // gcc_jit_context_new_call: mismatching types for argument 2 of function "__atomic_store_4": assignment to param arg1 (type: int) from loadedValue3577 (type: unsigned int __attribute__((aligned(4))))
829 let int_type = atomic_store.get_param(1).to_rvalue().get_type();
830 let value = self.context.new_cast(None, value, int_type);
832 .add_eval(None, self.context.new_call(None, atomic_store, &[ptr, value, ordering]));
835 fn gep(&mut self, _typ: Type<'gcc>, ptr: RValue<'gcc>, indices: &[RValue<'gcc>]) -> RValue<'gcc> {
836 let mut result = ptr;
837 for index in indices {
838 result = self.context.new_array_access(None, result, *index).get_address(None).to_rvalue();
843 fn inbounds_gep(&mut self, _typ: Type<'gcc>, ptr: RValue<'gcc>, indices: &[RValue<'gcc>]) -> RValue<'gcc> {
844 // FIXME(antoyo): would be safer if doing the same thing (loop) as gep.
845 // TODO(antoyo): specify inbounds somehow.
846 match indices.len() {
848 self.context.new_array_access(None, ptr, indices[0]).get_address(None)
851 let array = ptr.dereference(None); // TODO(antoyo): assert that first index is 0?
852 self.context.new_array_access(None, array, indices[1]).get_address(None)
854 _ => unimplemented!(),
858 fn struct_gep(&mut self, value_type: Type<'gcc>, ptr: RValue<'gcc>, idx: u64) -> RValue<'gcc> {
859 // FIXME(antoyo): it would be better if the API only called this on struct, not on arrays.
860 assert_eq!(idx as usize as u64, idx);
861 let value = ptr.dereference(None).to_rvalue();
863 if value_type.dyncast_array().is_some() {
864 let index = self.context.new_rvalue_from_long(self.u64_type, i64::try_from(idx).expect("i64::try_from"));
865 let element = self.context.new_array_access(None, value, index);
866 element.get_address(None)
868 else if let Some(vector_type) = value_type.dyncast_vector() {
869 let array_type = vector_type.get_element_type().make_pointer();
870 let array = self.bitcast(ptr, array_type);
871 let index = self.context.new_rvalue_from_long(self.u64_type, i64::try_from(idx).expect("i64::try_from"));
872 let element = self.context.new_array_access(None, array, index);
873 element.get_address(None)
875 else if let Some(struct_type) = value_type.is_struct() {
876 ptr.dereference_field(None, struct_type.get_field(idx as i32)).get_address(None)
879 panic!("Unexpected type {:?}", value_type);
884 fn trunc(&mut self, value: RValue<'gcc>, dest_ty: Type<'gcc>) -> RValue<'gcc> {
885 // TODO(antoyo): check that it indeed truncate the value.
886 self.gcc_int_cast(value, dest_ty)
889 fn sext(&mut self, value: RValue<'gcc>, dest_ty: Type<'gcc>) -> RValue<'gcc> {
890 // TODO(antoyo): check that it indeed sign extend the value.
891 if dest_ty.dyncast_vector().is_some() {
892 // TODO(antoyo): nothing to do as it is only for LLVM?
895 self.context.new_cast(None, value, dest_ty)
898 fn fptoui(&mut self, value: RValue<'gcc>, dest_ty: Type<'gcc>) -> RValue<'gcc> {
899 self.gcc_float_to_uint_cast(value, dest_ty)
902 fn fptosi(&mut self, value: RValue<'gcc>, dest_ty: Type<'gcc>) -> RValue<'gcc> {
903 self.gcc_float_to_int_cast(value, dest_ty)
906 fn uitofp(&mut self, value: RValue<'gcc>, dest_ty: Type<'gcc>) -> RValue<'gcc> {
907 self.gcc_uint_to_float_cast(value, dest_ty)
910 fn sitofp(&mut self, value: RValue<'gcc>, dest_ty: Type<'gcc>) -> RValue<'gcc> {
911 self.gcc_int_to_float_cast(value, dest_ty)
914 fn fptrunc(&mut self, value: RValue<'gcc>, dest_ty: Type<'gcc>) -> RValue<'gcc> {
915 // TODO(antoyo): make sure it truncates.
916 self.context.new_cast(None, value, dest_ty)
919 fn fpext(&mut self, value: RValue<'gcc>, dest_ty: Type<'gcc>) -> RValue<'gcc> {
920 self.context.new_cast(None, value, dest_ty)
923 fn ptrtoint(&mut self, value: RValue<'gcc>, dest_ty: Type<'gcc>) -> RValue<'gcc> {
924 let usize_value = self.cx.const_bitcast(value, self.cx.type_isize());
925 self.intcast(usize_value, dest_ty, false)
928 fn inttoptr(&mut self, value: RValue<'gcc>, dest_ty: Type<'gcc>) -> RValue<'gcc> {
929 let usize_value = self.intcast(value, self.cx.type_isize(), false);
930 self.cx.const_bitcast(usize_value, dest_ty)
933 fn bitcast(&mut self, value: RValue<'gcc>, dest_ty: Type<'gcc>) -> RValue<'gcc> {
934 self.cx.const_bitcast(value, dest_ty)
937 fn intcast(&mut self, value: RValue<'gcc>, dest_typ: Type<'gcc>, _is_signed: bool) -> RValue<'gcc> {
938 // NOTE: is_signed is for value, not dest_typ.
939 self.gcc_int_cast(value, dest_typ)
942 fn pointercast(&mut self, value: RValue<'gcc>, dest_ty: Type<'gcc>) -> RValue<'gcc> {
943 let val_type = value.get_type();
944 match (type_is_pointer(val_type), type_is_pointer(dest_ty)) {
946 // NOTE: Projecting a field of a pointer type will attempt a cast from a signed char to
947 // a pointer, which is not supported by gccjit.
948 return self.cx.context.new_cast(None, self.inttoptr(value, val_type.make_pointer()), dest_ty);
951 // When they are not pointers, we want a transmute (or reinterpret_cast).
952 self.bitcast(value, dest_ty)
954 (true, true) => self.cx.context.new_cast(None, value, dest_ty),
955 (true, false) => unimplemented!(),
960 fn icmp(&mut self, op: IntPredicate, lhs: RValue<'gcc>, rhs: RValue<'gcc>) -> RValue<'gcc> {
961 self.gcc_icmp(op, lhs, rhs)
964 fn fcmp(&mut self, op: RealPredicate, lhs: RValue<'gcc>, rhs: RValue<'gcc>) -> RValue<'gcc> {
965 self.context.new_comparison(None, op.to_gcc_comparison(), lhs, rhs)
968 /* Miscellaneous instructions */
969 fn memcpy(&mut self, dst: RValue<'gcc>, _dst_align: Align, src: RValue<'gcc>, _src_align: Align, size: RValue<'gcc>, flags: MemFlags) {
970 assert!(!flags.contains(MemFlags::NONTEMPORAL), "non-temporal memcpy not supported");
971 let size = self.intcast(size, self.type_size_t(), false);
972 let _is_volatile = flags.contains(MemFlags::VOLATILE);
973 let dst = self.pointercast(dst, self.type_i8p());
974 let src = self.pointercast(src, self.type_ptr_to(self.type_void()));
975 let memcpy = self.context.get_builtin_function("memcpy");
976 // TODO(antoyo): handle aligns and is_volatile.
977 self.block.add_eval(None, self.context.new_call(None, memcpy, &[dst, src, size]));
980 fn memmove(&mut self, dst: RValue<'gcc>, dst_align: Align, src: RValue<'gcc>, src_align: Align, size: RValue<'gcc>, flags: MemFlags) {
981 if flags.contains(MemFlags::NONTEMPORAL) {
982 // HACK(nox): This is inefficient but there is no nontemporal memmove.
983 let val = self.load(src.get_type().get_pointee().expect("get_pointee"), src, src_align);
984 let ptr = self.pointercast(dst, self.type_ptr_to(self.val_ty(val)));
985 self.store_with_flags(val, ptr, dst_align, flags);
988 let size = self.intcast(size, self.type_size_t(), false);
989 let _is_volatile = flags.contains(MemFlags::VOLATILE);
990 let dst = self.pointercast(dst, self.type_i8p());
991 let src = self.pointercast(src, self.type_ptr_to(self.type_void()));
993 let memmove = self.context.get_builtin_function("memmove");
994 // TODO(antoyo): handle is_volatile.
995 self.block.add_eval(None, self.context.new_call(None, memmove, &[dst, src, size]));
998 fn memset(&mut self, ptr: RValue<'gcc>, fill_byte: RValue<'gcc>, size: RValue<'gcc>, _align: Align, flags: MemFlags) {
999 let _is_volatile = flags.contains(MemFlags::VOLATILE);
1000 let ptr = self.pointercast(ptr, self.type_i8p());
1001 let memset = self.context.get_builtin_function("memset");
1002 // TODO(antoyo): handle align and is_volatile.
1003 let fill_byte = self.context.new_cast(None, fill_byte, self.i32_type);
1004 let size = self.intcast(size, self.type_size_t(), false);
1005 self.block.add_eval(None, self.context.new_call(None, memset, &[ptr, fill_byte, size]));
1008 fn select(&mut self, cond: RValue<'gcc>, then_val: RValue<'gcc>, mut else_val: RValue<'gcc>) -> RValue<'gcc> {
1009 let func = self.current_func();
1010 let variable = func.new_local(None, then_val.get_type(), "selectVar");
1011 let then_block = func.new_block("then");
1012 let else_block = func.new_block("else");
1013 let after_block = func.new_block("after");
1014 self.llbb().end_with_conditional(None, cond, then_block, else_block);
1016 then_block.add_assignment(None, variable, then_val);
1017 then_block.end_with_jump(None, after_block);
1019 if !then_val.get_type().is_compatible_with(else_val.get_type()) {
1020 else_val = self.context.new_cast(None, else_val, then_val.get_type());
1022 else_block.add_assignment(None, variable, else_val);
1023 else_block.end_with_jump(None, after_block);
1025 // NOTE: since jumps were added in a place rustc does not expect, the current block in the
1026 // state need to be updated.
1027 self.switch_to_block(after_block);
1029 variable.to_rvalue()
1033 fn va_arg(&mut self, _list: RValue<'gcc>, _ty: Type<'gcc>) -> RValue<'gcc> {
1037 fn extract_element(&mut self, _vec: RValue<'gcc>, _idx: RValue<'gcc>) -> RValue<'gcc> {
1041 fn vector_splat(&mut self, _num_elts: usize, _elt: RValue<'gcc>) -> RValue<'gcc> {
1045 fn extract_value(&mut self, aggregate_value: RValue<'gcc>, idx: u64) -> RValue<'gcc> {
1046 // FIXME(antoyo): it would be better if the API only called this on struct, not on arrays.
1047 assert_eq!(idx as usize as u64, idx);
1048 let value_type = aggregate_value.get_type();
1050 if value_type.dyncast_array().is_some() {
1051 let index = self.context.new_rvalue_from_long(self.u64_type, i64::try_from(idx).expect("i64::try_from"));
1052 let element = self.context.new_array_access(None, aggregate_value, index);
1053 element.get_address(None)
1055 else if value_type.dyncast_vector().is_some() {
1058 else if let Some(pointer_type) = value_type.get_pointee() {
1059 if let Some(struct_type) = pointer_type.is_struct() {
1060 // NOTE: hack to workaround a limitation of the rustc API: see comment on
1061 // CodegenCx.structs_as_pointer
1062 aggregate_value.dereference_field(None, struct_type.get_field(idx as i32)).to_rvalue()
1065 panic!("Unexpected type {:?}", value_type);
1068 else if let Some(struct_type) = value_type.is_struct() {
1069 aggregate_value.access_field(None, struct_type.get_field(idx as i32)).to_rvalue()
1072 panic!("Unexpected type {:?}", value_type);
1076 fn insert_value(&mut self, aggregate_value: RValue<'gcc>, value: RValue<'gcc>, idx: u64) -> RValue<'gcc> {
1077 // FIXME(antoyo): it would be better if the API only called this on struct, not on arrays.
1078 assert_eq!(idx as usize as u64, idx);
1079 let value_type = aggregate_value.get_type();
1082 if value_type.dyncast_array().is_some() {
1083 let index = self.context.new_rvalue_from_long(self.u64_type, i64::try_from(idx).expect("i64::try_from"));
1084 self.context.new_array_access(None, aggregate_value, index)
1086 else if value_type.dyncast_vector().is_some() {
1089 else if let Some(pointer_type) = value_type.get_pointee() {
1090 if let Some(struct_type) = pointer_type.is_struct() {
1091 // NOTE: hack to workaround a limitation of the rustc API: see comment on
1092 // CodegenCx.structs_as_pointer
1093 aggregate_value.dereference_field(None, struct_type.get_field(idx as i32))
1096 panic!("Unexpected type {:?}", value_type);
1100 panic!("Unexpected type {:?}", value_type);
1103 let lvalue_type = lvalue.to_rvalue().get_type();
1105 // NOTE: sometimes, rustc will create a value with the wrong type.
1106 if lvalue_type != value.get_type() {
1107 self.context.new_cast(None, value, lvalue_type)
1113 self.llbb().add_assignment(None, lvalue, value);
1118 fn set_personality_fn(&mut self, _personality: RValue<'gcc>) {
1122 fn cleanup_landing_pad(&mut self, _ty: Type<'gcc>, _pers_fn: RValue<'gcc>) -> RValue<'gcc> {
1123 let field1 = self.context.new_field(None, self.u8_type.make_pointer(), "landing_pad_field_1");
1124 let field2 = self.context.new_field(None, self.i32_type, "landing_pad_field_1");
1125 let struct_type = self.context.new_struct_type(None, "landing_pad", &[field1, field2]);
1126 self.current_func().new_local(None, struct_type.as_type(), "landing_pad")
1128 // TODO(antoyo): Properly implement unwinding.
1129 // the above is just to make the compilation work as it seems
1130 // rustc_codegen_ssa now calls the unwinding builder methods even on panic=abort.
1133 fn resume(&mut self, _exn: RValue<'gcc>) {
1134 // TODO(bjorn3): Properly implement unwinding.
1138 fn cleanup_pad(&mut self, _parent: Option<RValue<'gcc>>, _args: &[RValue<'gcc>]) -> Funclet {
1142 fn cleanup_ret(&mut self, _funclet: &Funclet, _unwind: Option<Block<'gcc>>) {
1146 fn catch_pad(&mut self, _parent: RValue<'gcc>, _args: &[RValue<'gcc>]) -> Funclet {
1152 _parent: Option<RValue<'gcc>>,
1153 _unwind: Option<Block<'gcc>>,
1154 _handlers: &[Block<'gcc>],
1159 // Atomic Operations
1160 fn atomic_cmpxchg(&mut self, dst: RValue<'gcc>, cmp: RValue<'gcc>, src: RValue<'gcc>, order: AtomicOrdering, failure_order: AtomicOrdering, weak: bool) -> RValue<'gcc> {
1161 let expected = self.current_func().new_local(None, cmp.get_type(), "expected");
1162 self.llbb().add_assignment(None, expected, cmp);
1163 let success = self.compare_exchange(dst, expected, src, order, failure_order, weak);
1165 let pair_type = self.cx.type_struct(&[src.get_type(), self.bool_type], false);
1166 let result = self.current_func().new_local(None, pair_type, "atomic_cmpxchg_result");
1167 let align = Align::from_bits(64).expect("align"); // TODO(antoyo): use good align.
1169 let value_type = result.to_rvalue().get_type();
1170 if let Some(struct_type) = value_type.is_struct() {
1171 self.store(success, result.access_field(None, struct_type.get_field(1)).get_address(None), align);
1172 // NOTE: since success contains the call to the intrinsic, it must be stored before
1173 // expected so that we store expected after the call.
1174 self.store(expected.to_rvalue(), result.access_field(None, struct_type.get_field(0)).get_address(None), align);
1176 // TODO(antoyo): handle when value is not a struct.
1181 fn atomic_rmw(&mut self, op: AtomicRmwBinOp, dst: RValue<'gcc>, src: RValue<'gcc>, order: AtomicOrdering) -> RValue<'gcc> {
1182 let size = src.get_type().get_size();
1185 AtomicRmwBinOp::AtomicXchg => format!("__atomic_exchange_{}", size),
1186 AtomicRmwBinOp::AtomicAdd => format!("__atomic_fetch_add_{}", size),
1187 AtomicRmwBinOp::AtomicSub => format!("__atomic_fetch_sub_{}", size),
1188 AtomicRmwBinOp::AtomicAnd => format!("__atomic_fetch_and_{}", size),
1189 AtomicRmwBinOp::AtomicNand => format!("__atomic_fetch_nand_{}", size),
1190 AtomicRmwBinOp::AtomicOr => format!("__atomic_fetch_or_{}", size),
1191 AtomicRmwBinOp::AtomicXor => format!("__atomic_fetch_xor_{}", size),
1192 AtomicRmwBinOp::AtomicMax => return self.atomic_extremum(ExtremumOperation::Max, dst, src, order),
1193 AtomicRmwBinOp::AtomicMin => return self.atomic_extremum(ExtremumOperation::Min, dst, src, order),
1194 AtomicRmwBinOp::AtomicUMax => return self.atomic_extremum(ExtremumOperation::Max, dst, src, order),
1195 AtomicRmwBinOp::AtomicUMin => return self.atomic_extremum(ExtremumOperation::Min, dst, src, order),
1199 let atomic_function = self.context.get_builtin_function(name);
1200 let order = self.context.new_rvalue_from_int(self.i32_type, order.to_gcc());
1202 let void_ptr_type = self.context.new_type::<*mut ()>();
1203 let volatile_void_ptr_type = void_ptr_type.make_volatile();
1204 let dst = self.context.new_cast(None, dst, volatile_void_ptr_type);
1205 // FIXME(antoyo): not sure why, but we have the wrong type here.
1206 let new_src_type = atomic_function.get_param(1).to_rvalue().get_type();
1207 let src = self.context.new_cast(None, src, new_src_type);
1208 let res = self.context.new_call(None, atomic_function, &[dst, src, order]);
1209 self.context.new_cast(None, res, src.get_type())
1212 fn atomic_fence(&mut self, order: AtomicOrdering, scope: SynchronizationScope) {
1215 SynchronizationScope::SingleThread => "__atomic_signal_fence",
1216 SynchronizationScope::CrossThread => "__atomic_thread_fence",
1218 let thread_fence = self.context.get_builtin_function(name);
1219 let order = self.context.new_rvalue_from_int(self.i32_type, order.to_gcc());
1220 self.llbb().add_eval(None, self.context.new_call(None, thread_fence, &[order]));
1223 fn set_invariant_load(&mut self, load: RValue<'gcc>) {
1224 // NOTE: Hack to consider vtable function pointer as non-global-variable function pointer.
1225 self.normal_function_addresses.borrow_mut().insert(load);
1229 fn lifetime_start(&mut self, _ptr: RValue<'gcc>, _size: Size) {
1233 fn lifetime_end(&mut self, _ptr: RValue<'gcc>, _size: Size) {
1240 fn_abi: Option<&FnAbi<'tcx, Ty<'tcx>>>,
1242 args: &[RValue<'gcc>],
1243 funclet: Option<&Funclet>,
1245 // FIXME(antoyo): remove when having a proper API.
1246 let gcc_func = unsafe { std::mem::transmute(func) };
1247 let call = if self.functions.borrow().values().find(|value| **value == gcc_func).is_some() {
1248 self.function_call(func, args, funclet)
1251 // If it's a not function that was defined, it's a function pointer.
1252 self.function_ptr_call(func, args, funclet)
1254 if let Some(_fn_abi) = fn_abi {
1255 // TODO(bjorn3): Apply function attributes
1260 fn zext(&mut self, value: RValue<'gcc>, dest_typ: Type<'gcc>) -> RValue<'gcc> {
1261 // FIXME(antoyo): this does not zero-extend.
1262 if value.get_type().is_bool() && dest_typ.is_i8(&self.cx) {
1263 // FIXME(antoyo): hack because base::from_immediate converts i1 to i8.
1264 // Fix the code in codegen_ssa::base::from_immediate.
1267 self.gcc_int_cast(value, dest_typ)
1270 fn cx(&self) -> &CodegenCx<'gcc, 'tcx> {
1274 fn do_not_inline(&mut self, _llret: RValue<'gcc>) {
1275 // FIXME(bjorn3): implement
1278 fn set_span(&mut self, _span: Span) {}
1280 fn from_immediate(&mut self, val: Self::Value) -> Self::Value {
1281 if self.cx().val_ty(val) == self.cx().type_i1() {
1282 self.zext(val, self.cx().type_i8())
1289 fn to_immediate_scalar(&mut self, val: Self::Value, scalar: abi::Scalar) -> Self::Value {
1290 if scalar.is_bool() {
1291 return self.trunc(val, self.cx().type_i1());
1296 fn fptoui_sat(&mut self, val: RValue<'gcc>, dest_ty: Type<'gcc>) -> RValue<'gcc> {
1297 self.fptoint_sat(false, val, dest_ty)
1300 fn fptosi_sat(&mut self, val: RValue<'gcc>, dest_ty: Type<'gcc>) -> RValue<'gcc> {
1301 self.fptoint_sat(true, val, dest_ty)
1304 fn instrprof_increment(&mut self, _fn_name: RValue<'gcc>, _hash: RValue<'gcc>, _num_counters: RValue<'gcc>, _index: RValue<'gcc>) {
1309 impl<'a, 'gcc, 'tcx> Builder<'a, 'gcc, 'tcx> {
1310 fn fptoint_sat(&mut self, signed: bool, val: RValue<'gcc>, dest_ty: Type<'gcc>) -> RValue<'gcc> {
1311 let src_ty = self.cx.val_ty(val);
1312 let (float_ty, int_ty) = if self.cx.type_kind(src_ty) == TypeKind::Vector {
1313 assert_eq!(self.cx.vector_length(src_ty), self.cx.vector_length(dest_ty));
1314 (self.cx.element_type(src_ty), self.cx.element_type(dest_ty))
1319 // FIXME(jistone): the following was originally the fallback SSA implementation, before LLVM 13
1320 // added native `fptosi.sat` and `fptoui.sat` conversions, but it was used by GCC as well.
1321 // Now that LLVM always relies on its own, the code has been moved to GCC, but the comments are
1322 // still LLVM-specific. This should be updated, and use better GCC specifics if possible.
1324 let int_width = self.cx.int_width(int_ty);
1325 let float_width = self.cx.float_width(float_ty);
1326 // LLVM's fpto[su]i returns undef when the input val is infinite, NaN, or does not fit into the
1327 // destination integer type after rounding towards zero. This `undef` value can cause UB in
1328 // safe code (see issue #10184), so we implement a saturating conversion on top of it:
1329 // Semantically, the mathematical value of the input is rounded towards zero to the next
1330 // mathematical integer, and then the result is clamped into the range of the destination
1331 // integer type. Positive and negative infinity are mapped to the maximum and minimum value of
1332 // the destination integer type. NaN is mapped to 0.
1334 // Define f_min and f_max as the largest and smallest (finite) floats that are exactly equal to
1335 // a value representable in int_ty.
1336 // They are exactly equal to int_ty::{MIN,MAX} if float_ty has enough significand bits.
1337 // Otherwise, int_ty::MAX must be rounded towards zero, as it is one less than a power of two.
1338 // int_ty::MIN, however, is either zero or a negative power of two and is thus exactly
1339 // representable. Note that this only works if float_ty's exponent range is sufficiently large.
1340 // f16 or 256 bit integers would break this property. Right now the smallest float type is f32
1341 // with exponents ranging up to 127, which is barely enough for i128::MIN = -2^127.
1342 // On the other hand, f_max works even if int_ty::MAX is greater than float_ty::MAX. Because
1343 // we're rounding towards zero, we just get float_ty::MAX (which is always an integer).
1344 // This already happens today with u128::MAX = 2^128 - 1 > f32::MAX.
1345 let int_max = |signed: bool, int_width: u64| -> u128 {
1346 let shift_amount = 128 - int_width;
1347 if signed { i128::MAX as u128 >> shift_amount } else { u128::MAX >> shift_amount }
1349 let int_min = |signed: bool, int_width: u64| -> i128 {
1350 if signed { i128::MIN >> (128 - int_width) } else { 0 }
1353 let compute_clamp_bounds_single = |signed: bool, int_width: u64| -> (u128, u128) {
1355 ieee::Single::from_i128_r(int_min(signed, int_width), Round::TowardZero);
1356 assert_eq!(rounded_min.status, Status::OK);
1358 ieee::Single::from_u128_r(int_max(signed, int_width), Round::TowardZero);
1359 assert!(rounded_max.value.is_finite());
1360 (rounded_min.value.to_bits(), rounded_max.value.to_bits())
1362 let compute_clamp_bounds_double = |signed: bool, int_width: u64| -> (u128, u128) {
1364 ieee::Double::from_i128_r(int_min(signed, int_width), Round::TowardZero);
1365 assert_eq!(rounded_min.status, Status::OK);
1367 ieee::Double::from_u128_r(int_max(signed, int_width), Round::TowardZero);
1368 assert!(rounded_max.value.is_finite());
1369 (rounded_min.value.to_bits(), rounded_max.value.to_bits())
1371 // To implement saturation, we perform the following steps:
1373 // 1. Cast val to an integer with fpto[su]i. This may result in undef.
1374 // 2. Compare val to f_min and f_max, and use the comparison results to select:
1375 // a) int_ty::MIN if val < f_min or val is NaN
1376 // b) int_ty::MAX if val > f_max
1377 // c) the result of fpto[su]i otherwise
1378 // 3. If val is NaN, return 0.0, otherwise return the result of step 2.
1380 // This avoids resulting undef because values in range [f_min, f_max] by definition fit into the
1381 // destination type. It creates an undef temporary, but *producing* undef is not UB. Our use of
1382 // undef does not introduce any non-determinism either.
1383 // More importantly, the above procedure correctly implements saturating conversion.
1385 // If val is NaN, 0 is returned by definition.
1386 // Otherwise, val is finite or infinite and thus can be compared with f_min and f_max.
1387 // This yields three cases to consider:
1388 // (1) if val in [f_min, f_max], the result of fpto[su]i is returned, which agrees with
1389 // saturating conversion for inputs in that range.
1390 // (2) if val > f_max, then val is larger than int_ty::MAX. This holds even if f_max is rounded
1391 // (i.e., if f_max < int_ty::MAX) because in those cases, nextUp(f_max) is already larger
1392 // than int_ty::MAX. Because val is larger than int_ty::MAX, the return value of int_ty::MAX
1394 // (3) if val < f_min, then val is smaller than int_ty::MIN. As shown earlier, f_min exactly equals
1395 // int_ty::MIN and therefore the return value of int_ty::MIN is correct.
1398 let float_bits_to_llval = |bx: &mut Self, bits| {
1399 let bits_llval = match float_width {
1400 32 => bx.cx().const_u32(bits as u32),
1401 64 => bx.cx().const_u64(bits as u64),
1402 n => bug!("unsupported float width {}", n),
1404 bx.bitcast(bits_llval, float_ty)
1406 let (f_min, f_max) = match float_width {
1407 32 => compute_clamp_bounds_single(signed, int_width),
1408 64 => compute_clamp_bounds_double(signed, int_width),
1409 n => bug!("unsupported float width {}", n),
1411 let f_min = float_bits_to_llval(self, f_min);
1412 let f_max = float_bits_to_llval(self, f_max);
1413 let int_max = self.cx.const_uint_big(int_ty, int_max(signed, int_width));
1414 let int_min = self.cx.const_uint_big(int_ty, int_min(signed, int_width) as u128);
1415 let zero = self.cx.const_uint(int_ty, 0);
1417 // If we're working with vectors, constants must be "splatted": the constant is duplicated
1418 // into each lane of the vector. The algorithm stays the same, we are just using the
1419 // same constant across all lanes.
1420 let maybe_splat = |bx: &mut Self, val| {
1421 if bx.cx().type_kind(dest_ty) == TypeKind::Vector {
1422 bx.vector_splat(bx.vector_length(dest_ty), val)
1427 let f_min = maybe_splat(self, f_min);
1428 let f_max = maybe_splat(self, f_max);
1429 let int_max = maybe_splat(self, int_max);
1430 let int_min = maybe_splat(self, int_min);
1431 let zero = maybe_splat(self, zero);
1434 let fptosui_result = if signed { self.fptosi(val, dest_ty) } else { self.fptoui(val, dest_ty) };
1435 let less_or_nan = self.fcmp(RealPredicate::RealULT, val, f_min);
1436 let greater = self.fcmp(RealPredicate::RealOGT, val, f_max);
1438 // Step 2: We use two comparisons and two selects, with %s1 being the
1440 // %less_or_nan = fcmp ult %val, %f_min
1441 // %greater = fcmp olt %val, %f_max
1442 // %s0 = select %less_or_nan, int_ty::MIN, %fptosi_result
1443 // %s1 = select %greater, int_ty::MAX, %s0
1444 // Note that %less_or_nan uses an *unordered* comparison. This
1445 // comparison is true if the operands are not comparable (i.e., if val is
1446 // NaN). The unordered comparison ensures that s1 becomes int_ty::MIN if
1449 // Performance note: Unordered comparison can be lowered to a "flipped"
1450 // comparison and a negation, and the negation can be merged into the
1451 // select. Therefore, it not necessarily any more expensive than an
1452 // ordered ("normal") comparison. Whether these optimizations will be
1453 // performed is ultimately up to the backend, but at least x86 does
1455 let s0 = self.select(less_or_nan, int_min, fptosui_result);
1456 let s1 = self.select(greater, int_max, s0);
1458 // Step 3: NaN replacement.
1459 // For unsigned types, the above step already yielded int_ty::MIN == 0 if val is NaN.
1460 // Therefore we only need to execute this step for signed integer types.
1462 // LLVM has no isNaN predicate, so we use (val == val) instead
1463 let cmp = self.fcmp(RealPredicate::RealOEQ, val, val);
1464 self.select(cmp, s1, zero)
1470 #[cfg(feature="master")]
1471 pub fn shuffle_vector(&mut self, v1: RValue<'gcc>, v2: RValue<'gcc>, mask: RValue<'gcc>) -> RValue<'gcc> {
1472 let struct_type = mask.get_type().is_struct().expect("mask of struct type");
1474 // TODO(antoyo): use a recursive unqualified() here.
1475 let vector_type = v1.get_type().unqualified().dyncast_vector().expect("vector type");
1476 let element_type = vector_type.get_element_type();
1477 let vec_num_units = vector_type.get_num_units();
1479 let mask_num_units = struct_type.get_field_count();
1480 let mut vector_elements = vec![];
1481 let mask_element_type =
1482 if element_type.is_integral() {
1486 #[cfg(feature="master")]
1488 self.cx.type_ix(element_type.get_size() as u64 * 8)
1490 #[cfg(not(feature="master"))]
1493 for i in 0..mask_num_units {
1494 let field = struct_type.get_field(i as i32);
1495 vector_elements.push(self.context.new_cast(None, mask.access_field(None, field).to_rvalue(), mask_element_type));
1498 // NOTE: the mask needs to be the same length as the input vectors, so add the missing
1499 // elements in the mask if needed.
1500 for _ in mask_num_units..vec_num_units {
1501 vector_elements.push(self.context.new_rvalue_zero(mask_element_type));
1504 let array_type = self.context.new_array_type(None, element_type, vec_num_units as i32);
1505 let result_type = self.context.new_vector_type(element_type, mask_num_units as u64);
1507 if vec_num_units < mask_num_units {
1508 // NOTE: the mask needs to be the same length as the input vectors, so join the 2
1509 // vectors and create a dummy second vector.
1510 // TODO(antoyo): switch to using new_vector_access.
1511 let array = self.context.new_bitcast(None, v1, array_type);
1512 let mut elements = vec![];
1513 for i in 0..vec_num_units {
1514 elements.push(self.context.new_array_access(None, array, self.context.new_rvalue_from_int(self.int_type, i as i32)).to_rvalue());
1516 // TODO(antoyo): switch to using new_vector_access.
1517 let array = self.context.new_bitcast(None, v2, array_type);
1518 for i in 0..(mask_num_units - vec_num_units) {
1519 elements.push(self.context.new_array_access(None, array, self.context.new_rvalue_from_int(self.int_type, i as i32)).to_rvalue());
1521 let v1 = self.context.new_rvalue_from_vector(None, result_type, &elements);
1522 let zero = self.context.new_rvalue_zero(element_type);
1523 let v2 = self.context.new_rvalue_from_vector(None, result_type, &vec![zero; mask_num_units]);
1530 let new_mask_num_units = std::cmp::max(mask_num_units, vec_num_units);
1531 let mask_type = self.context.new_vector_type(mask_element_type, new_mask_num_units as u64);
1532 let mask = self.context.new_rvalue_from_vector(None, mask_type, &vector_elements);
1533 let result = self.context.new_rvalue_vector_perm(None, v1, v2, mask);
1535 if vec_num_units != mask_num_units {
1536 // NOTE: if padding was added, only select the number of elements of the masks to
1537 // remove that padding in the result.
1538 let mut elements = vec![];
1539 // TODO(antoyo): switch to using new_vector_access.
1540 let array = self.context.new_bitcast(None, result, array_type);
1541 for i in 0..mask_num_units {
1542 elements.push(self.context.new_array_access(None, array, self.context.new_rvalue_from_int(self.int_type, i as i32)).to_rvalue());
1544 self.context.new_rvalue_from_vector(None, result_type, &elements)
1551 #[cfg(not(feature="master"))]
1552 pub fn shuffle_vector(&mut self, _v1: RValue<'gcc>, _v2: RValue<'gcc>, _mask: RValue<'gcc>) -> RValue<'gcc> {
1556 #[cfg(feature="master")]
1557 pub fn vector_reduce<F>(&mut self, src: RValue<'gcc>, op: F) -> RValue<'gcc>
1558 where F: Fn(RValue<'gcc>, RValue<'gcc>, &'gcc Context<'gcc>) -> RValue<'gcc>
1560 let vector_type = src.get_type().unqualified().dyncast_vector().expect("vector type");
1561 let element_count = vector_type.get_num_units();
1562 let mut vector_elements = vec![];
1563 for i in 0..element_count {
1564 vector_elements.push(i);
1566 let mask_type = self.context.new_vector_type(self.int_type, element_count as u64);
1569 while shift < element_count {
1570 let vector_elements: Vec<_> =
1571 vector_elements.iter()
1572 .map(|i| self.context.new_rvalue_from_int(self.int_type, ((i + shift) % element_count) as i32))
1574 let mask = self.context.new_rvalue_from_vector(None, mask_type, &vector_elements);
1575 let shifted = self.context.new_rvalue_vector_perm(None, res, res, mask);
1577 res = op(res, shifted, &self.context);
1579 self.context.new_vector_access(None, res, self.context.new_rvalue_zero(self.int_type))
1583 #[cfg(not(feature="master"))]
1584 pub fn vector_reduce<F>(&mut self, src: RValue<'gcc>, op: F) -> RValue<'gcc>
1585 where F: Fn(RValue<'gcc>, RValue<'gcc>, &'gcc Context<'gcc>) -> RValue<'gcc>
1590 pub fn vector_reduce_op(&mut self, src: RValue<'gcc>, op: BinaryOp) -> RValue<'gcc> {
1591 self.vector_reduce(src, |a, b, context| context.new_binary_op(None, op, a.get_type(), a, b))
1594 pub fn vector_reduce_fadd_fast(&mut self, _acc: RValue<'gcc>, _src: RValue<'gcc>) -> RValue<'gcc> {
1598 pub fn vector_reduce_fmul_fast(&mut self, _acc: RValue<'gcc>, _src: RValue<'gcc>) -> RValue<'gcc> {
1602 // Inspired by Hacker's Delight min implementation.
1603 pub fn vector_reduce_min(&mut self, src: RValue<'gcc>) -> RValue<'gcc> {
1604 self.vector_reduce(src, |a, b, context| {
1605 let differences_or_zeros = difference_or_zero(a, b, context);
1606 context.new_binary_op(None, BinaryOp::Minus, a.get_type(), a, differences_or_zeros)
1610 // Inspired by Hacker's Delight max implementation.
1611 pub fn vector_reduce_max(&mut self, src: RValue<'gcc>) -> RValue<'gcc> {
1612 self.vector_reduce(src, |a, b, context| {
1613 let differences_or_zeros = difference_or_zero(a, b, context);
1614 context.new_binary_op(None, BinaryOp::Plus, b.get_type(), b, differences_or_zeros)
1618 pub fn vector_select(&mut self, cond: RValue<'gcc>, then_val: RValue<'gcc>, else_val: RValue<'gcc>) -> RValue<'gcc> {
1619 // cond is a vector of integers, not of bools.
1620 let cond_type = cond.get_type();
1621 let vector_type = cond_type.unqualified().dyncast_vector().expect("vector type");
1622 let num_units = vector_type.get_num_units();
1623 let element_type = vector_type.get_element_type();
1624 let zeros = vec![self.context.new_rvalue_zero(element_type); num_units];
1625 let zeros = self.context.new_rvalue_from_vector(None, cond_type, &zeros);
1627 let masks = self.context.new_comparison(None, ComparisonOp::NotEquals, cond, zeros);
1628 let then_vals = masks & then_val;
1630 let ones = vec![self.context.new_rvalue_one(element_type); num_units];
1631 let ones = self.context.new_rvalue_from_vector(None, cond_type, &ones);
1632 let inverted_masks = masks + ones;
1633 // NOTE: sometimes, the type of else_val can be different than the type of then_val in
1634 // libgccjit (vector of int vs vector of int32_t), but they should be the same for the AND
1635 // operation to work.
1636 let else_val = self.context.new_bitcast(None, else_val, then_val.get_type());
1637 let else_vals = inverted_masks & else_val;
1639 then_vals | else_vals
1643 fn difference_or_zero<'gcc>(a: RValue<'gcc>, b: RValue<'gcc>, context: &'gcc Context<'gcc>) -> RValue<'gcc> {
1644 let difference = a - b;
1645 let masks = context.new_comparison(None, ComparisonOp::GreaterThanEquals, b, a);
1649 impl<'a, 'gcc, 'tcx> StaticBuilderMethods for Builder<'a, 'gcc, 'tcx> {
1650 fn get_static(&mut self, def_id: DefId) -> RValue<'gcc> {
1651 // Forward to the `get_static` method of `CodegenCx`
1652 self.cx().get_static(def_id).get_address(None)
1656 impl<'tcx> HasParamEnv<'tcx> for Builder<'_, '_, 'tcx> {
1657 fn param_env(&self) -> ParamEnv<'tcx> {
1662 impl<'tcx> HasTargetSpec for Builder<'_, '_, 'tcx> {
1663 fn target_spec(&self) -> &Target {
1664 &self.cx.target_spec()
1668 pub trait ToGccComp {
1669 fn to_gcc_comparison(&self) -> ComparisonOp;
1672 impl ToGccComp for IntPredicate {
1673 fn to_gcc_comparison(&self) -> ComparisonOp {
1675 IntPredicate::IntEQ => ComparisonOp::Equals,
1676 IntPredicate::IntNE => ComparisonOp::NotEquals,
1677 IntPredicate::IntUGT => ComparisonOp::GreaterThan,
1678 IntPredicate::IntUGE => ComparisonOp::GreaterThanEquals,
1679 IntPredicate::IntULT => ComparisonOp::LessThan,
1680 IntPredicate::IntULE => ComparisonOp::LessThanEquals,
1681 IntPredicate::IntSGT => ComparisonOp::GreaterThan,
1682 IntPredicate::IntSGE => ComparisonOp::GreaterThanEquals,
1683 IntPredicate::IntSLT => ComparisonOp::LessThan,
1684 IntPredicate::IntSLE => ComparisonOp::LessThanEquals,
1689 impl ToGccComp for RealPredicate {
1690 fn to_gcc_comparison(&self) -> ComparisonOp {
1691 // TODO(antoyo): check that ordered vs non-ordered is respected.
1693 RealPredicate::RealPredicateFalse => unreachable!(),
1694 RealPredicate::RealOEQ => ComparisonOp::Equals,
1695 RealPredicate::RealOGT => ComparisonOp::GreaterThan,
1696 RealPredicate::RealOGE => ComparisonOp::GreaterThanEquals,
1697 RealPredicate::RealOLT => ComparisonOp::LessThan,
1698 RealPredicate::RealOLE => ComparisonOp::LessThanEquals,
1699 RealPredicate::RealONE => ComparisonOp::NotEquals,
1700 RealPredicate::RealORD => unreachable!(),
1701 RealPredicate::RealUNO => unreachable!(),
1702 RealPredicate::RealUEQ => ComparisonOp::Equals,
1703 RealPredicate::RealUGT => ComparisonOp::GreaterThan,
1704 RealPredicate::RealUGE => ComparisonOp::GreaterThan,
1705 RealPredicate::RealULT => ComparisonOp::LessThan,
1706 RealPredicate::RealULE => ComparisonOp::LessThan,
1707 RealPredicate::RealUNE => ComparisonOp::NotEquals,
1708 RealPredicate::RealPredicateTrue => unreachable!(),
1714 #[allow(non_camel_case_types)]
1724 trait ToGccOrdering {
1725 fn to_gcc(self) -> i32;
1728 impl ToGccOrdering for AtomicOrdering {
1729 fn to_gcc(self) -> i32 {
1734 AtomicOrdering::Unordered => __ATOMIC_RELAXED,
1735 AtomicOrdering::Relaxed => __ATOMIC_RELAXED, // TODO(antoyo): check if that's the same.
1736 AtomicOrdering::Acquire => __ATOMIC_ACQUIRE,
1737 AtomicOrdering::Release => __ATOMIC_RELEASE,
1738 AtomicOrdering::AcquireRelease => __ATOMIC_ACQ_REL,
1739 AtomicOrdering::SequentiallyConsistent => __ATOMIC_SEQ_CST,