]> git.lizzy.rs Git - rust.git/blob - compiler/rustc_codegen_llvm/src/intrinsic.rs
Auto merge of #84226 - Aaron1011:track-link-dead-code, r=Mark-Simulacrum
[rust.git] / compiler / rustc_codegen_llvm / src / intrinsic.rs
1 use crate::abi::{Abi, FnAbi, LlvmType, PassMode};
2 use crate::builder::Builder;
3 use crate::context::CodegenCx;
4 use crate::llvm;
5 use crate::type_::Type;
6 use crate::type_of::LayoutLlvmExt;
7 use crate::va_arg::emit_va_arg;
8 use crate::value::Value;
9
10 use rustc_codegen_ssa::base::{compare_simd_types, wants_msvc_seh};
11 use rustc_codegen_ssa::common::span_invalid_monomorphization_error;
12 use rustc_codegen_ssa::common::{IntPredicate, TypeKind};
13 use rustc_codegen_ssa::mir::operand::OperandRef;
14 use rustc_codegen_ssa::mir::place::PlaceRef;
15 use rustc_codegen_ssa::traits::*;
16 use rustc_hir as hir;
17 use rustc_middle::ty::layout::{FnAbiExt, HasTyCtxt};
18 use rustc_middle::ty::{self, Ty};
19 use rustc_middle::{bug, span_bug};
20 use rustc_span::{sym, symbol::kw, Span, Symbol};
21 use rustc_target::abi::{self, HasDataLayout, LayoutOf, Primitive};
22 use rustc_target::spec::PanicStrategy;
23
24 use std::cmp::Ordering;
25 use std::iter;
26
27 fn get_simple_intrinsic(cx: &CodegenCx<'ll, '_>, name: Symbol) -> Option<&'ll Value> {
28     let llvm_name = match name {
29         sym::sqrtf32 => "llvm.sqrt.f32",
30         sym::sqrtf64 => "llvm.sqrt.f64",
31         sym::powif32 => "llvm.powi.f32",
32         sym::powif64 => "llvm.powi.f64",
33         sym::sinf32 => "llvm.sin.f32",
34         sym::sinf64 => "llvm.sin.f64",
35         sym::cosf32 => "llvm.cos.f32",
36         sym::cosf64 => "llvm.cos.f64",
37         sym::powf32 => "llvm.pow.f32",
38         sym::powf64 => "llvm.pow.f64",
39         sym::expf32 => "llvm.exp.f32",
40         sym::expf64 => "llvm.exp.f64",
41         sym::exp2f32 => "llvm.exp2.f32",
42         sym::exp2f64 => "llvm.exp2.f64",
43         sym::logf32 => "llvm.log.f32",
44         sym::logf64 => "llvm.log.f64",
45         sym::log10f32 => "llvm.log10.f32",
46         sym::log10f64 => "llvm.log10.f64",
47         sym::log2f32 => "llvm.log2.f32",
48         sym::log2f64 => "llvm.log2.f64",
49         sym::fmaf32 => "llvm.fma.f32",
50         sym::fmaf64 => "llvm.fma.f64",
51         sym::fabsf32 => "llvm.fabs.f32",
52         sym::fabsf64 => "llvm.fabs.f64",
53         sym::minnumf32 => "llvm.minnum.f32",
54         sym::minnumf64 => "llvm.minnum.f64",
55         sym::maxnumf32 => "llvm.maxnum.f32",
56         sym::maxnumf64 => "llvm.maxnum.f64",
57         sym::copysignf32 => "llvm.copysign.f32",
58         sym::copysignf64 => "llvm.copysign.f64",
59         sym::floorf32 => "llvm.floor.f32",
60         sym::floorf64 => "llvm.floor.f64",
61         sym::ceilf32 => "llvm.ceil.f32",
62         sym::ceilf64 => "llvm.ceil.f64",
63         sym::truncf32 => "llvm.trunc.f32",
64         sym::truncf64 => "llvm.trunc.f64",
65         sym::rintf32 => "llvm.rint.f32",
66         sym::rintf64 => "llvm.rint.f64",
67         sym::nearbyintf32 => "llvm.nearbyint.f32",
68         sym::nearbyintf64 => "llvm.nearbyint.f64",
69         sym::roundf32 => "llvm.round.f32",
70         sym::roundf64 => "llvm.round.f64",
71         _ => return None,
72     };
73     Some(cx.get_intrinsic(&llvm_name))
74 }
75
76 impl IntrinsicCallMethods<'tcx> for Builder<'a, 'll, 'tcx> {
77     fn codegen_intrinsic_call(
78         &mut self,
79         instance: ty::Instance<'tcx>,
80         fn_abi: &FnAbi<'tcx, Ty<'tcx>>,
81         args: &[OperandRef<'tcx, &'ll Value>],
82         llresult: &'ll Value,
83         span: Span,
84     ) {
85         let tcx = self.tcx;
86         let callee_ty = instance.ty(tcx, ty::ParamEnv::reveal_all());
87
88         let (def_id, substs) = match *callee_ty.kind() {
89             ty::FnDef(def_id, substs) => (def_id, substs),
90             _ => bug!("expected fn item type, found {}", callee_ty),
91         };
92
93         let sig = callee_ty.fn_sig(tcx);
94         let sig = tcx.normalize_erasing_late_bound_regions(ty::ParamEnv::reveal_all(), sig);
95         let arg_tys = sig.inputs();
96         let ret_ty = sig.output();
97         let name = tcx.item_name(def_id);
98         let name_str = &*name.as_str();
99
100         let llret_ty = self.layout_of(ret_ty).llvm_type(self);
101         let result = PlaceRef::new_sized(llresult, fn_abi.ret.layout);
102
103         let simple = get_simple_intrinsic(self, name);
104         let llval = match name {
105             _ if simple.is_some() => self.call(
106                 simple.unwrap(),
107                 &args.iter().map(|arg| arg.immediate()).collect::<Vec<_>>(),
108                 None,
109             ),
110             sym::likely => {
111                 let expect = self.get_intrinsic(&("llvm.expect.i1"));
112                 self.call(expect, &[args[0].immediate(), self.const_bool(true)], None)
113             }
114             sym::unlikely => {
115                 let expect = self.get_intrinsic(&("llvm.expect.i1"));
116                 self.call(expect, &[args[0].immediate(), self.const_bool(false)], None)
117             }
118             kw::Try => {
119                 try_intrinsic(
120                     self,
121                     args[0].immediate(),
122                     args[1].immediate(),
123                     args[2].immediate(),
124                     llresult,
125                 );
126                 return;
127             }
128             sym::breakpoint => {
129                 let llfn = self.get_intrinsic(&("llvm.debugtrap"));
130                 self.call(llfn, &[], None)
131             }
132             sym::va_copy => {
133                 let intrinsic = self.cx().get_intrinsic(&("llvm.va_copy"));
134                 self.call(intrinsic, &[args[0].immediate(), args[1].immediate()], None)
135             }
136             sym::va_arg => {
137                 match fn_abi.ret.layout.abi {
138                     abi::Abi::Scalar(ref scalar) => {
139                         match scalar.value {
140                             Primitive::Int(..) => {
141                                 if self.cx().size_of(ret_ty).bytes() < 4 {
142                                     // `va_arg` should not be called on a integer type
143                                     // less than 4 bytes in length. If it is, promote
144                                     // the integer to a `i32` and truncate the result
145                                     // back to the smaller type.
146                                     let promoted_result = emit_va_arg(self, args[0], tcx.types.i32);
147                                     self.trunc(promoted_result, llret_ty)
148                                 } else {
149                                     emit_va_arg(self, args[0], ret_ty)
150                                 }
151                             }
152                             Primitive::F64 | Primitive::Pointer => {
153                                 emit_va_arg(self, args[0], ret_ty)
154                             }
155                             // `va_arg` should never be used with the return type f32.
156                             Primitive::F32 => bug!("the va_arg intrinsic does not work with `f32`"),
157                         }
158                     }
159                     _ => bug!("the va_arg intrinsic does not work with non-scalar types"),
160                 }
161             }
162
163             sym::volatile_load | sym::unaligned_volatile_load => {
164                 let tp_ty = substs.type_at(0);
165                 let mut ptr = args[0].immediate();
166                 if let PassMode::Cast(ty) = fn_abi.ret.mode {
167                     ptr = self.pointercast(ptr, self.type_ptr_to(ty.llvm_type(self)));
168                 }
169                 let load = self.volatile_load(ptr);
170                 let align = if name == sym::unaligned_volatile_load {
171                     1
172                 } else {
173                     self.align_of(tp_ty).bytes() as u32
174                 };
175                 unsafe {
176                     llvm::LLVMSetAlignment(load, align);
177                 }
178                 self.to_immediate(load, self.layout_of(tp_ty))
179             }
180             sym::volatile_store => {
181                 let dst = args[0].deref(self.cx());
182                 args[1].val.volatile_store(self, dst);
183                 return;
184             }
185             sym::unaligned_volatile_store => {
186                 let dst = args[0].deref(self.cx());
187                 args[1].val.unaligned_volatile_store(self, dst);
188                 return;
189             }
190             sym::prefetch_read_data
191             | sym::prefetch_write_data
192             | sym::prefetch_read_instruction
193             | sym::prefetch_write_instruction => {
194                 let expect = self.get_intrinsic(&("llvm.prefetch"));
195                 let (rw, cache_type) = match name {
196                     sym::prefetch_read_data => (0, 1),
197                     sym::prefetch_write_data => (1, 1),
198                     sym::prefetch_read_instruction => (0, 0),
199                     sym::prefetch_write_instruction => (1, 0),
200                     _ => bug!(),
201                 };
202                 self.call(
203                     expect,
204                     &[
205                         args[0].immediate(),
206                         self.const_i32(rw),
207                         args[1].immediate(),
208                         self.const_i32(cache_type),
209                     ],
210                     None,
211                 )
212             }
213             sym::ctlz
214             | sym::ctlz_nonzero
215             | sym::cttz
216             | sym::cttz_nonzero
217             | sym::ctpop
218             | sym::bswap
219             | sym::bitreverse
220             | sym::rotate_left
221             | sym::rotate_right
222             | sym::saturating_add
223             | sym::saturating_sub => {
224                 let ty = arg_tys[0];
225                 match int_type_width_signed(ty, self) {
226                     Some((width, signed)) => match name {
227                         sym::ctlz | sym::cttz => {
228                             let y = self.const_bool(false);
229                             let llfn = self.get_intrinsic(&format!("llvm.{}.i{}", name, width));
230                             self.call(llfn, &[args[0].immediate(), y], None)
231                         }
232                         sym::ctlz_nonzero | sym::cttz_nonzero => {
233                             let y = self.const_bool(true);
234                             let llvm_name = &format!("llvm.{}.i{}", &name_str[..4], width);
235                             let llfn = self.get_intrinsic(llvm_name);
236                             self.call(llfn, &[args[0].immediate(), y], None)
237                         }
238                         sym::ctpop => self.call(
239                             self.get_intrinsic(&format!("llvm.ctpop.i{}", width)),
240                             &[args[0].immediate()],
241                             None,
242                         ),
243                         sym::bswap => {
244                             if width == 8 {
245                                 args[0].immediate() // byte swap a u8/i8 is just a no-op
246                             } else {
247                                 self.call(
248                                     self.get_intrinsic(&format!("llvm.bswap.i{}", width)),
249                                     &[args[0].immediate()],
250                                     None,
251                                 )
252                             }
253                         }
254                         sym::bitreverse => self.call(
255                             self.get_intrinsic(&format!("llvm.bitreverse.i{}", width)),
256                             &[args[0].immediate()],
257                             None,
258                         ),
259                         sym::rotate_left | sym::rotate_right => {
260                             let is_left = name == sym::rotate_left;
261                             let val = args[0].immediate();
262                             let raw_shift = args[1].immediate();
263                             // rotate = funnel shift with first two args the same
264                             let llvm_name =
265                                 &format!("llvm.fsh{}.i{}", if is_left { 'l' } else { 'r' }, width);
266                             let llfn = self.get_intrinsic(llvm_name);
267                             self.call(llfn, &[val, val, raw_shift], None)
268                         }
269                         sym::saturating_add | sym::saturating_sub => {
270                             let is_add = name == sym::saturating_add;
271                             let lhs = args[0].immediate();
272                             let rhs = args[1].immediate();
273                             let llvm_name = &format!(
274                                 "llvm.{}{}.sat.i{}",
275                                 if signed { 's' } else { 'u' },
276                                 if is_add { "add" } else { "sub" },
277                                 width
278                             );
279                             let llfn = self.get_intrinsic(llvm_name);
280                             self.call(llfn, &[lhs, rhs], None)
281                         }
282                         _ => bug!(),
283                     },
284                     None => {
285                         span_invalid_monomorphization_error(
286                             tcx.sess,
287                             span,
288                             &format!(
289                                 "invalid monomorphization of `{}` intrinsic: \
290                                       expected basic integer type, found `{}`",
291                                 name, ty
292                             ),
293                         );
294                         return;
295                     }
296                 }
297             }
298
299             _ if name_str.starts_with("simd_") => {
300                 match generic_simd_intrinsic(self, name, callee_ty, args, ret_ty, llret_ty, span) {
301                     Ok(llval) => llval,
302                     Err(()) => return,
303                 }
304             }
305
306             _ => bug!("unknown intrinsic '{}'", name),
307         };
308
309         if !fn_abi.ret.is_ignore() {
310             if let PassMode::Cast(ty) = fn_abi.ret.mode {
311                 let ptr_llty = self.type_ptr_to(ty.llvm_type(self));
312                 let ptr = self.pointercast(result.llval, ptr_llty);
313                 self.store(llval, ptr, result.align);
314             } else {
315                 OperandRef::from_immediate_or_packed_pair(self, llval, result.layout)
316                     .val
317                     .store(self, result);
318             }
319         }
320     }
321
322     fn abort(&mut self) {
323         let fnname = self.get_intrinsic(&("llvm.trap"));
324         self.call(fnname, &[], None);
325     }
326
327     fn assume(&mut self, val: Self::Value) {
328         let assume_intrinsic = self.get_intrinsic("llvm.assume");
329         self.call(assume_intrinsic, &[val], None);
330     }
331
332     fn expect(&mut self, cond: Self::Value, expected: bool) -> Self::Value {
333         let expect = self.get_intrinsic(&"llvm.expect.i1");
334         self.call(expect, &[cond, self.const_bool(expected)], None)
335     }
336
337     fn sideeffect(&mut self) {
338         // This kind of check would make a ton of sense in the caller, but currently the only
339         // caller of this function is in `rustc_codegen_ssa`, which is agnostic to whether LLVM
340         // codegen backend being used, and so is unable to check the LLVM version.
341         if unsafe { llvm::LLVMRustVersionMajor() } < 12 {
342             let fnname = self.get_intrinsic(&("llvm.sideeffect"));
343             self.call(fnname, &[], None);
344         }
345     }
346
347     fn va_start(&mut self, va_list: &'ll Value) -> &'ll Value {
348         let intrinsic = self.cx().get_intrinsic("llvm.va_start");
349         self.call(intrinsic, &[va_list], None)
350     }
351
352     fn va_end(&mut self, va_list: &'ll Value) -> &'ll Value {
353         let intrinsic = self.cx().get_intrinsic("llvm.va_end");
354         self.call(intrinsic, &[va_list], None)
355     }
356 }
357
358 fn try_intrinsic(
359     bx: &mut Builder<'a, 'll, 'tcx>,
360     try_func: &'ll Value,
361     data: &'ll Value,
362     catch_func: &'ll Value,
363     dest: &'ll Value,
364 ) {
365     if bx.sess().panic_strategy() == PanicStrategy::Abort {
366         bx.call(try_func, &[data], None);
367         // Return 0 unconditionally from the intrinsic call;
368         // we can never unwind.
369         let ret_align = bx.tcx().data_layout.i32_align.abi;
370         bx.store(bx.const_i32(0), dest, ret_align);
371     } else if wants_msvc_seh(bx.sess()) {
372         codegen_msvc_try(bx, try_func, data, catch_func, dest);
373     } else if bx.sess().target.is_like_emscripten {
374         codegen_emcc_try(bx, try_func, data, catch_func, dest);
375     } else {
376         codegen_gnu_try(bx, try_func, data, catch_func, dest);
377     }
378 }
379
380 // MSVC's definition of the `rust_try` function.
381 //
382 // This implementation uses the new exception handling instructions in LLVM
383 // which have support in LLVM for SEH on MSVC targets. Although these
384 // instructions are meant to work for all targets, as of the time of this
385 // writing, however, LLVM does not recommend the usage of these new instructions
386 // as the old ones are still more optimized.
387 fn codegen_msvc_try(
388     bx: &mut Builder<'a, 'll, 'tcx>,
389     try_func: &'ll Value,
390     data: &'ll Value,
391     catch_func: &'ll Value,
392     dest: &'ll Value,
393 ) {
394     let llfn = get_rust_try_fn(bx, &mut |mut bx| {
395         bx.set_personality_fn(bx.eh_personality());
396
397         let mut normal = bx.build_sibling_block("normal");
398         let mut catchswitch = bx.build_sibling_block("catchswitch");
399         let mut catchpad_rust = bx.build_sibling_block("catchpad_rust");
400         let mut catchpad_foreign = bx.build_sibling_block("catchpad_foreign");
401         let mut caught = bx.build_sibling_block("caught");
402
403         let try_func = llvm::get_param(bx.llfn(), 0);
404         let data = llvm::get_param(bx.llfn(), 1);
405         let catch_func = llvm::get_param(bx.llfn(), 2);
406
407         // We're generating an IR snippet that looks like:
408         //
409         //   declare i32 @rust_try(%try_func, %data, %catch_func) {
410         //      %slot = alloca i8*
411         //      invoke %try_func(%data) to label %normal unwind label %catchswitch
412         //
413         //   normal:
414         //      ret i32 0
415         //
416         //   catchswitch:
417         //      %cs = catchswitch within none [%catchpad_rust, %catchpad_foreign] unwind to caller
418         //
419         //   catchpad_rust:
420         //      %tok = catchpad within %cs [%type_descriptor, 8, %slot]
421         //      %ptr = load %slot
422         //      call %catch_func(%data, %ptr)
423         //      catchret from %tok to label %caught
424         //
425         //   catchpad_foreign:
426         //      %tok = catchpad within %cs [null, 64, null]
427         //      call %catch_func(%data, null)
428         //      catchret from %tok to label %caught
429         //
430         //   caught:
431         //      ret i32 1
432         //   }
433         //
434         // This structure follows the basic usage of throw/try/catch in LLVM.
435         // For example, compile this C++ snippet to see what LLVM generates:
436         //
437         //      struct rust_panic {
438         //          rust_panic(const rust_panic&);
439         //          ~rust_panic();
440         //
441         //          void* x[2];
442         //      };
443         //
444         //      int __rust_try(
445         //          void (*try_func)(void*),
446         //          void *data,
447         //          void (*catch_func)(void*, void*) noexcept
448         //      ) {
449         //          try {
450         //              try_func(data);
451         //              return 0;
452         //          } catch(rust_panic& a) {
453         //              catch_func(data, &a);
454         //              return 1;
455         //          } catch(...) {
456         //              catch_func(data, NULL);
457         //              return 1;
458         //          }
459         //      }
460         //
461         // More information can be found in libstd's seh.rs implementation.
462         let ptr_align = bx.tcx().data_layout.pointer_align.abi;
463         let slot = bx.alloca(bx.type_i8p(), ptr_align);
464         bx.invoke(try_func, &[data], normal.llbb(), catchswitch.llbb(), None);
465
466         normal.ret(bx.const_i32(0));
467
468         let cs = catchswitch.catch_switch(None, None, 2);
469         catchswitch.add_handler(cs, catchpad_rust.llbb());
470         catchswitch.add_handler(cs, catchpad_foreign.llbb());
471
472         // We can't use the TypeDescriptor defined in libpanic_unwind because it
473         // might be in another DLL and the SEH encoding only supports specifying
474         // a TypeDescriptor from the current module.
475         //
476         // However this isn't an issue since the MSVC runtime uses string
477         // comparison on the type name to match TypeDescriptors rather than
478         // pointer equality.
479         //
480         // So instead we generate a new TypeDescriptor in each module that uses
481         // `try` and let the linker merge duplicate definitions in the same
482         // module.
483         //
484         // When modifying, make sure that the type_name string exactly matches
485         // the one used in src/libpanic_unwind/seh.rs.
486         let type_info_vtable = bx.declare_global("??_7type_info@@6B@", bx.type_i8p());
487         let type_name = bx.const_bytes(b"rust_panic\0");
488         let type_info =
489             bx.const_struct(&[type_info_vtable, bx.const_null(bx.type_i8p()), type_name], false);
490         let tydesc = bx.declare_global("__rust_panic_type_info", bx.val_ty(type_info));
491         unsafe {
492             llvm::LLVMRustSetLinkage(tydesc, llvm::Linkage::LinkOnceODRLinkage);
493             llvm::SetUniqueComdat(bx.llmod, tydesc);
494             llvm::LLVMSetInitializer(tydesc, type_info);
495         }
496
497         // The flag value of 8 indicates that we are catching the exception by
498         // reference instead of by value. We can't use catch by value because
499         // that requires copying the exception object, which we don't support
500         // since our exception object effectively contains a Box.
501         //
502         // Source: MicrosoftCXXABI::getAddrOfCXXCatchHandlerType in clang
503         let flags = bx.const_i32(8);
504         let funclet = catchpad_rust.catch_pad(cs, &[tydesc, flags, slot]);
505         let ptr = catchpad_rust.load(slot, ptr_align);
506         catchpad_rust.call(catch_func, &[data, ptr], Some(&funclet));
507         catchpad_rust.catch_ret(&funclet, caught.llbb());
508
509         // The flag value of 64 indicates a "catch-all".
510         let flags = bx.const_i32(64);
511         let null = bx.const_null(bx.type_i8p());
512         let funclet = catchpad_foreign.catch_pad(cs, &[null, flags, null]);
513         catchpad_foreign.call(catch_func, &[data, null], Some(&funclet));
514         catchpad_foreign.catch_ret(&funclet, caught.llbb());
515
516         caught.ret(bx.const_i32(1));
517     });
518
519     // Note that no invoke is used here because by definition this function
520     // can't panic (that's what it's catching).
521     let ret = bx.call(llfn, &[try_func, data, catch_func], None);
522     let i32_align = bx.tcx().data_layout.i32_align.abi;
523     bx.store(ret, dest, i32_align);
524 }
525
526 // Definition of the standard `try` function for Rust using the GNU-like model
527 // of exceptions (e.g., the normal semantics of LLVM's `landingpad` and `invoke`
528 // instructions).
529 //
530 // This codegen is a little surprising because we always call a shim
531 // function instead of inlining the call to `invoke` manually here. This is done
532 // because in LLVM we're only allowed to have one personality per function
533 // definition. The call to the `try` intrinsic is being inlined into the
534 // function calling it, and that function may already have other personality
535 // functions in play. By calling a shim we're guaranteed that our shim will have
536 // the right personality function.
537 fn codegen_gnu_try(
538     bx: &mut Builder<'a, 'll, 'tcx>,
539     try_func: &'ll Value,
540     data: &'ll Value,
541     catch_func: &'ll Value,
542     dest: &'ll Value,
543 ) {
544     let llfn = get_rust_try_fn(bx, &mut |mut bx| {
545         // Codegens the shims described above:
546         //
547         //   bx:
548         //      invoke %try_func(%data) normal %normal unwind %catch
549         //
550         //   normal:
551         //      ret 0
552         //
553         //   catch:
554         //      (%ptr, _) = landingpad
555         //      call %catch_func(%data, %ptr)
556         //      ret 1
557         let mut then = bx.build_sibling_block("then");
558         let mut catch = bx.build_sibling_block("catch");
559
560         let try_func = llvm::get_param(bx.llfn(), 0);
561         let data = llvm::get_param(bx.llfn(), 1);
562         let catch_func = llvm::get_param(bx.llfn(), 2);
563         bx.invoke(try_func, &[data], then.llbb(), catch.llbb(), None);
564         then.ret(bx.const_i32(0));
565
566         // Type indicator for the exception being thrown.
567         //
568         // The first value in this tuple is a pointer to the exception object
569         // being thrown.  The second value is a "selector" indicating which of
570         // the landing pad clauses the exception's type had been matched to.
571         // rust_try ignores the selector.
572         let lpad_ty = bx.type_struct(&[bx.type_i8p(), bx.type_i32()], false);
573         let vals = catch.landing_pad(lpad_ty, bx.eh_personality(), 1);
574         let tydesc = bx.const_null(bx.type_i8p());
575         catch.add_clause(vals, tydesc);
576         let ptr = catch.extract_value(vals, 0);
577         catch.call(catch_func, &[data, ptr], None);
578         catch.ret(bx.const_i32(1));
579     });
580
581     // Note that no invoke is used here because by definition this function
582     // can't panic (that's what it's catching).
583     let ret = bx.call(llfn, &[try_func, data, catch_func], None);
584     let i32_align = bx.tcx().data_layout.i32_align.abi;
585     bx.store(ret, dest, i32_align);
586 }
587
588 // Variant of codegen_gnu_try used for emscripten where Rust panics are
589 // implemented using C++ exceptions. Here we use exceptions of a specific type
590 // (`struct rust_panic`) to represent Rust panics.
591 fn codegen_emcc_try(
592     bx: &mut Builder<'a, 'll, 'tcx>,
593     try_func: &'ll Value,
594     data: &'ll Value,
595     catch_func: &'ll Value,
596     dest: &'ll Value,
597 ) {
598     let llfn = get_rust_try_fn(bx, &mut |mut bx| {
599         // Codegens the shims described above:
600         //
601         //   bx:
602         //      invoke %try_func(%data) normal %normal unwind %catch
603         //
604         //   normal:
605         //      ret 0
606         //
607         //   catch:
608         //      (%ptr, %selector) = landingpad
609         //      %rust_typeid = @llvm.eh.typeid.for(@_ZTI10rust_panic)
610         //      %is_rust_panic = %selector == %rust_typeid
611         //      %catch_data = alloca { i8*, i8 }
612         //      %catch_data[0] = %ptr
613         //      %catch_data[1] = %is_rust_panic
614         //      call %catch_func(%data, %catch_data)
615         //      ret 1
616         let mut then = bx.build_sibling_block("then");
617         let mut catch = bx.build_sibling_block("catch");
618
619         let try_func = llvm::get_param(bx.llfn(), 0);
620         let data = llvm::get_param(bx.llfn(), 1);
621         let catch_func = llvm::get_param(bx.llfn(), 2);
622         bx.invoke(try_func, &[data], then.llbb(), catch.llbb(), None);
623         then.ret(bx.const_i32(0));
624
625         // Type indicator for the exception being thrown.
626         //
627         // The first value in this tuple is a pointer to the exception object
628         // being thrown.  The second value is a "selector" indicating which of
629         // the landing pad clauses the exception's type had been matched to.
630         let tydesc = bx.eh_catch_typeinfo();
631         let lpad_ty = bx.type_struct(&[bx.type_i8p(), bx.type_i32()], false);
632         let vals = catch.landing_pad(lpad_ty, bx.eh_personality(), 2);
633         catch.add_clause(vals, tydesc);
634         catch.add_clause(vals, bx.const_null(bx.type_i8p()));
635         let ptr = catch.extract_value(vals, 0);
636         let selector = catch.extract_value(vals, 1);
637
638         // Check if the typeid we got is the one for a Rust panic.
639         let llvm_eh_typeid_for = bx.get_intrinsic("llvm.eh.typeid.for");
640         let rust_typeid = catch.call(llvm_eh_typeid_for, &[tydesc], None);
641         let is_rust_panic = catch.icmp(IntPredicate::IntEQ, selector, rust_typeid);
642         let is_rust_panic = catch.zext(is_rust_panic, bx.type_bool());
643
644         // We need to pass two values to catch_func (ptr and is_rust_panic), so
645         // create an alloca and pass a pointer to that.
646         let ptr_align = bx.tcx().data_layout.pointer_align.abi;
647         let i8_align = bx.tcx().data_layout.i8_align.abi;
648         let catch_data =
649             catch.alloca(bx.type_struct(&[bx.type_i8p(), bx.type_bool()], false), ptr_align);
650         let catch_data_0 = catch.inbounds_gep(catch_data, &[bx.const_usize(0), bx.const_usize(0)]);
651         catch.store(ptr, catch_data_0, ptr_align);
652         let catch_data_1 = catch.inbounds_gep(catch_data, &[bx.const_usize(0), bx.const_usize(1)]);
653         catch.store(is_rust_panic, catch_data_1, i8_align);
654         let catch_data = catch.bitcast(catch_data, bx.type_i8p());
655
656         catch.call(catch_func, &[data, catch_data], None);
657         catch.ret(bx.const_i32(1));
658     });
659
660     // Note that no invoke is used here because by definition this function
661     // can't panic (that's what it's catching).
662     let ret = bx.call(llfn, &[try_func, data, catch_func], None);
663     let i32_align = bx.tcx().data_layout.i32_align.abi;
664     bx.store(ret, dest, i32_align);
665 }
666
667 // Helper function to give a Block to a closure to codegen a shim function.
668 // This is currently primarily used for the `try` intrinsic functions above.
669 fn gen_fn<'ll, 'tcx>(
670     cx: &CodegenCx<'ll, 'tcx>,
671     name: &str,
672     rust_fn_sig: ty::PolyFnSig<'tcx>,
673     codegen: &mut dyn FnMut(Builder<'_, 'll, 'tcx>),
674 ) -> &'ll Value {
675     let fn_abi = FnAbi::of_fn_ptr(cx, rust_fn_sig, &[]);
676     let llfn = cx.declare_fn(name, &fn_abi);
677     cx.set_frame_pointer_elimination(llfn);
678     cx.apply_target_cpu_attr(llfn);
679     // FIXME(eddyb) find a nicer way to do this.
680     unsafe { llvm::LLVMRustSetLinkage(llfn, llvm::Linkage::InternalLinkage) };
681     let bx = Builder::new_block(cx, llfn, "entry-block");
682     codegen(bx);
683     llfn
684 }
685
686 // Helper function used to get a handle to the `__rust_try` function used to
687 // catch exceptions.
688 //
689 // This function is only generated once and is then cached.
690 fn get_rust_try_fn<'ll, 'tcx>(
691     cx: &CodegenCx<'ll, 'tcx>,
692     codegen: &mut dyn FnMut(Builder<'_, 'll, 'tcx>),
693 ) -> &'ll Value {
694     if let Some(llfn) = cx.rust_try_fn.get() {
695         return llfn;
696     }
697
698     // Define the type up front for the signature of the rust_try function.
699     let tcx = cx.tcx;
700     let i8p = tcx.mk_mut_ptr(tcx.types.i8);
701     // `unsafe fn(*mut i8) -> ()`
702     let try_fn_ty = tcx.mk_fn_ptr(ty::Binder::dummy(tcx.mk_fn_sig(
703         iter::once(i8p),
704         tcx.mk_unit(),
705         false,
706         hir::Unsafety::Unsafe,
707         Abi::Rust,
708     )));
709     // `unsafe fn(*mut i8, *mut i8) -> ()`
710     let catch_fn_ty = tcx.mk_fn_ptr(ty::Binder::dummy(tcx.mk_fn_sig(
711         [i8p, i8p].iter().cloned(),
712         tcx.mk_unit(),
713         false,
714         hir::Unsafety::Unsafe,
715         Abi::Rust,
716     )));
717     // `unsafe fn(unsafe fn(*mut i8) -> (), *mut i8, unsafe fn(*mut i8, *mut i8) -> ()) -> i32`
718     let rust_fn_sig = ty::Binder::dummy(cx.tcx.mk_fn_sig(
719         vec![try_fn_ty, i8p, catch_fn_ty].into_iter(),
720         tcx.types.i32,
721         false,
722         hir::Unsafety::Unsafe,
723         Abi::Rust,
724     ));
725     let rust_try = gen_fn(cx, "__rust_try", rust_fn_sig, codegen);
726     cx.rust_try_fn.set(Some(rust_try));
727     rust_try
728 }
729
730 fn generic_simd_intrinsic(
731     bx: &mut Builder<'a, 'll, 'tcx>,
732     name: Symbol,
733     callee_ty: Ty<'tcx>,
734     args: &[OperandRef<'tcx, &'ll Value>],
735     ret_ty: Ty<'tcx>,
736     llret_ty: &'ll Type,
737     span: Span,
738 ) -> Result<&'ll Value, ()> {
739     // macros for error handling:
740     macro_rules! emit_error {
741         ($msg: tt) => {
742             emit_error!($msg, )
743         };
744         ($msg: tt, $($fmt: tt)*) => {
745             span_invalid_monomorphization_error(
746                 bx.sess(), span,
747                 &format!(concat!("invalid monomorphization of `{}` intrinsic: ", $msg),
748                          name, $($fmt)*));
749         }
750     }
751
752     macro_rules! return_error {
753         ($($fmt: tt)*) => {
754             {
755                 emit_error!($($fmt)*);
756                 return Err(());
757             }
758         }
759     }
760
761     macro_rules! require {
762         ($cond: expr, $($fmt: tt)*) => {
763             if !$cond {
764                 return_error!($($fmt)*);
765             }
766         };
767     }
768
769     macro_rules! require_simd {
770         ($ty: expr, $position: expr) => {
771             require!($ty.is_simd(), "expected SIMD {} type, found non-SIMD `{}`", $position, $ty)
772         };
773     }
774
775     let tcx = bx.tcx();
776     let sig =
777         tcx.normalize_erasing_late_bound_regions(ty::ParamEnv::reveal_all(), callee_ty.fn_sig(tcx));
778     let arg_tys = sig.inputs();
779     let name_str = &*name.as_str();
780
781     if name == sym::simd_select_bitmask {
782         let in_ty = arg_tys[0];
783         let m_len = match in_ty.kind() {
784             // Note that this `.unwrap()` crashes for isize/usize, that's sort
785             // of intentional as there's not currently a use case for that.
786             ty::Int(i) => i.bit_width().unwrap(),
787             ty::Uint(i) => i.bit_width().unwrap(),
788             _ => return_error!("`{}` is not an integral type", in_ty),
789         };
790         require_simd!(arg_tys[1], "argument");
791         let (v_len, _) = arg_tys[1].simd_size_and_type(bx.tcx());
792         require!(
793             // Allow masks for vectors with fewer than 8 elements to be
794             // represented with a u8 or i8.
795             m_len == v_len || (m_len == 8 && v_len < 8),
796             "mismatched lengths: mask length `{}` != other vector length `{}`",
797             m_len,
798             v_len
799         );
800         let i1 = bx.type_i1();
801         let im = bx.type_ix(v_len);
802         let i1xn = bx.type_vector(i1, v_len);
803         let m_im = bx.trunc(args[0].immediate(), im);
804         let m_i1s = bx.bitcast(m_im, i1xn);
805         return Ok(bx.select(m_i1s, args[1].immediate(), args[2].immediate()));
806     }
807
808     // every intrinsic below takes a SIMD vector as its first argument
809     require_simd!(arg_tys[0], "input");
810     let in_ty = arg_tys[0];
811
812     let comparison = match name {
813         sym::simd_eq => Some(hir::BinOpKind::Eq),
814         sym::simd_ne => Some(hir::BinOpKind::Ne),
815         sym::simd_lt => Some(hir::BinOpKind::Lt),
816         sym::simd_le => Some(hir::BinOpKind::Le),
817         sym::simd_gt => Some(hir::BinOpKind::Gt),
818         sym::simd_ge => Some(hir::BinOpKind::Ge),
819         _ => None,
820     };
821
822     let (in_len, in_elem) = arg_tys[0].simd_size_and_type(bx.tcx());
823     if let Some(cmp_op) = comparison {
824         require_simd!(ret_ty, "return");
825
826         let (out_len, out_ty) = ret_ty.simd_size_and_type(bx.tcx());
827         require!(
828             in_len == out_len,
829             "expected return type with length {} (same as input type `{}`), \
830              found `{}` with length {}",
831             in_len,
832             in_ty,
833             ret_ty,
834             out_len
835         );
836         require!(
837             bx.type_kind(bx.element_type(llret_ty)) == TypeKind::Integer,
838             "expected return type with integer elements, found `{}` with non-integer `{}`",
839             ret_ty,
840             out_ty
841         );
842
843         return Ok(compare_simd_types(
844             bx,
845             args[0].immediate(),
846             args[1].immediate(),
847             in_elem,
848             llret_ty,
849             cmp_op,
850         ));
851     }
852
853     if let Some(stripped) = name_str.strip_prefix("simd_shuffle") {
854         let n: u64 = stripped.parse().unwrap_or_else(|_| {
855             span_bug!(span, "bad `simd_shuffle` instruction only caught in codegen?")
856         });
857
858         require_simd!(ret_ty, "return");
859
860         let (out_len, out_ty) = ret_ty.simd_size_and_type(bx.tcx());
861         require!(
862             out_len == n,
863             "expected return type of length {}, found `{}` with length {}",
864             n,
865             ret_ty,
866             out_len
867         );
868         require!(
869             in_elem == out_ty,
870             "expected return element type `{}` (element of input `{}`), \
871              found `{}` with element type `{}`",
872             in_elem,
873             in_ty,
874             ret_ty,
875             out_ty
876         );
877
878         let total_len = u128::from(in_len) * 2;
879
880         let vector = args[2].immediate();
881
882         let indices: Option<Vec<_>> = (0..n)
883             .map(|i| {
884                 let arg_idx = i;
885                 let val = bx.const_get_elt(vector, i as u64);
886                 match bx.const_to_opt_u128(val, true) {
887                     None => {
888                         emit_error!("shuffle index #{} is not a constant", arg_idx);
889                         None
890                     }
891                     Some(idx) if idx >= total_len => {
892                         emit_error!(
893                             "shuffle index #{} is out of bounds (limit {})",
894                             arg_idx,
895                             total_len
896                         );
897                         None
898                     }
899                     Some(idx) => Some(bx.const_i32(idx as i32)),
900                 }
901             })
902             .collect();
903         let indices = match indices {
904             Some(i) => i,
905             None => return Ok(bx.const_null(llret_ty)),
906         };
907
908         return Ok(bx.shuffle_vector(
909             args[0].immediate(),
910             args[1].immediate(),
911             bx.const_vector(&indices),
912         ));
913     }
914
915     if name == sym::simd_insert {
916         require!(
917             in_elem == arg_tys[2],
918             "expected inserted type `{}` (element of input `{}`), found `{}`",
919             in_elem,
920             in_ty,
921             arg_tys[2]
922         );
923         return Ok(bx.insert_element(
924             args[0].immediate(),
925             args[2].immediate(),
926             args[1].immediate(),
927         ));
928     }
929     if name == sym::simd_extract {
930         require!(
931             ret_ty == in_elem,
932             "expected return type `{}` (element of input `{}`), found `{}`",
933             in_elem,
934             in_ty,
935             ret_ty
936         );
937         return Ok(bx.extract_element(args[0].immediate(), args[1].immediate()));
938     }
939
940     if name == sym::simd_select {
941         let m_elem_ty = in_elem;
942         let m_len = in_len;
943         require_simd!(arg_tys[1], "argument");
944         let (v_len, _) = arg_tys[1].simd_size_and_type(bx.tcx());
945         require!(
946             m_len == v_len,
947             "mismatched lengths: mask length `{}` != other vector length `{}`",
948             m_len,
949             v_len
950         );
951         match m_elem_ty.kind() {
952             ty::Int(_) => {}
953             _ => return_error!("mask element type is `{}`, expected `i_`", m_elem_ty),
954         }
955         // truncate the mask to a vector of i1s
956         let i1 = bx.type_i1();
957         let i1xn = bx.type_vector(i1, m_len as u64);
958         let m_i1s = bx.trunc(args[0].immediate(), i1xn);
959         return Ok(bx.select(m_i1s, args[1].immediate(), args[2].immediate()));
960     }
961
962     if name == sym::simd_bitmask {
963         // The `fn simd_bitmask(vector) -> unsigned integer` intrinsic takes a
964         // vector mask and returns an unsigned integer containing the most
965         // significant bit (MSB) of each lane.
966
967         // If the vector has less than 8 lanes, an u8 is returned with zeroed
968         // trailing bits.
969         let expected_int_bits = in_len.max(8);
970         match ret_ty.kind() {
971             ty::Uint(i) if i.bit_width() == Some(expected_int_bits) => (),
972             _ => return_error!("bitmask `{}`, expected `u{}`", ret_ty, expected_int_bits),
973         }
974
975         // Integer vector <i{in_bitwidth} x in_len>:
976         let (i_xn, in_elem_bitwidth) = match in_elem.kind() {
977             ty::Int(i) => (
978                 args[0].immediate(),
979                 i.bit_width().unwrap_or_else(|| bx.data_layout().pointer_size.bits()),
980             ),
981             ty::Uint(i) => (
982                 args[0].immediate(),
983                 i.bit_width().unwrap_or_else(|| bx.data_layout().pointer_size.bits()),
984             ),
985             _ => return_error!(
986                 "vector argument `{}`'s element type `{}`, expected integer element type",
987                 in_ty,
988                 in_elem
989             ),
990         };
991
992         // Shift the MSB to the right by "in_elem_bitwidth - 1" into the first bit position.
993         let shift_indices =
994             vec![
995                 bx.cx.const_int(bx.type_ix(in_elem_bitwidth), (in_elem_bitwidth - 1) as _);
996                 in_len as _
997             ];
998         let i_xn_msb = bx.lshr(i_xn, bx.const_vector(shift_indices.as_slice()));
999         // Truncate vector to an <i1 x N>
1000         let i1xn = bx.trunc(i_xn_msb, bx.type_vector(bx.type_i1(), in_len));
1001         // Bitcast <i1 x N> to iN:
1002         let i_ = bx.bitcast(i1xn, bx.type_ix(in_len));
1003         // Zero-extend iN to the bitmask type:
1004         return Ok(bx.zext(i_, bx.type_ix(expected_int_bits)));
1005     }
1006
1007     fn simd_simple_float_intrinsic(
1008         name: Symbol,
1009         in_elem: &::rustc_middle::ty::TyS<'_>,
1010         in_ty: &::rustc_middle::ty::TyS<'_>,
1011         in_len: u64,
1012         bx: &mut Builder<'a, 'll, 'tcx>,
1013         span: Span,
1014         args: &[OperandRef<'tcx, &'ll Value>],
1015     ) -> Result<&'ll Value, ()> {
1016         macro_rules! emit_error {
1017             ($msg: tt) => {
1018                 emit_error!($msg, )
1019             };
1020             ($msg: tt, $($fmt: tt)*) => {
1021                 span_invalid_monomorphization_error(
1022                     bx.sess(), span,
1023                     &format!(concat!("invalid monomorphization of `{}` intrinsic: ", $msg),
1024                              name, $($fmt)*));
1025             }
1026         }
1027         macro_rules! return_error {
1028             ($($fmt: tt)*) => {
1029                 {
1030                     emit_error!($($fmt)*);
1031                     return Err(());
1032                 }
1033             }
1034         }
1035
1036         let (elem_ty_str, elem_ty) = if let ty::Float(f) = in_elem.kind() {
1037             let elem_ty = bx.cx.type_float_from_ty(*f);
1038             match f.bit_width() {
1039                 32 => ("f32", elem_ty),
1040                 64 => ("f64", elem_ty),
1041                 _ => {
1042                     return_error!(
1043                         "unsupported element type `{}` of floating-point vector `{}`",
1044                         f.name_str(),
1045                         in_ty
1046                     );
1047                 }
1048             }
1049         } else {
1050             return_error!("`{}` is not a floating-point type", in_ty);
1051         };
1052
1053         let vec_ty = bx.type_vector(elem_ty, in_len);
1054
1055         let (intr_name, fn_ty) = match name {
1056             sym::simd_fsqrt => ("sqrt", bx.type_func(&[vec_ty], vec_ty)),
1057             sym::simd_fsin => ("sin", bx.type_func(&[vec_ty], vec_ty)),
1058             sym::simd_fcos => ("cos", bx.type_func(&[vec_ty], vec_ty)),
1059             sym::simd_fabs => ("fabs", bx.type_func(&[vec_ty], vec_ty)),
1060             sym::simd_ceil => ("ceil", bx.type_func(&[vec_ty], vec_ty)),
1061             sym::simd_floor => ("floor", bx.type_func(&[vec_ty], vec_ty)),
1062             sym::simd_round => ("round", bx.type_func(&[vec_ty], vec_ty)),
1063             sym::simd_trunc => ("trunc", bx.type_func(&[vec_ty], vec_ty)),
1064             sym::simd_fexp => ("exp", bx.type_func(&[vec_ty], vec_ty)),
1065             sym::simd_fexp2 => ("exp2", bx.type_func(&[vec_ty], vec_ty)),
1066             sym::simd_flog10 => ("log10", bx.type_func(&[vec_ty], vec_ty)),
1067             sym::simd_flog2 => ("log2", bx.type_func(&[vec_ty], vec_ty)),
1068             sym::simd_flog => ("log", bx.type_func(&[vec_ty], vec_ty)),
1069             sym::simd_fpowi => ("powi", bx.type_func(&[vec_ty, bx.type_i32()], vec_ty)),
1070             sym::simd_fpow => ("pow", bx.type_func(&[vec_ty, vec_ty], vec_ty)),
1071             sym::simd_fma => ("fma", bx.type_func(&[vec_ty, vec_ty, vec_ty], vec_ty)),
1072             _ => return_error!("unrecognized intrinsic `{}`", name),
1073         };
1074
1075         let llvm_name = &format!("llvm.{0}.v{1}{2}", intr_name, in_len, elem_ty_str);
1076         let f = bx.declare_cfn(&llvm_name, llvm::UnnamedAddr::No, fn_ty);
1077         let c = bx.call(f, &args.iter().map(|arg| arg.immediate()).collect::<Vec<_>>(), None);
1078         unsafe { llvm::LLVMRustSetHasUnsafeAlgebra(c) };
1079         Ok(c)
1080     }
1081
1082     if std::matches!(
1083         name,
1084         sym::simd_fsqrt
1085             | sym::simd_fsin
1086             | sym::simd_fcos
1087             | sym::simd_fabs
1088             | sym::simd_ceil
1089             | sym::simd_floor
1090             | sym::simd_round
1091             | sym::simd_trunc
1092             | sym::simd_fexp
1093             | sym::simd_fexp2
1094             | sym::simd_flog10
1095             | sym::simd_flog2
1096             | sym::simd_flog
1097             | sym::simd_fpowi
1098             | sym::simd_fpow
1099             | sym::simd_fma
1100     ) {
1101         return simd_simple_float_intrinsic(name, in_elem, in_ty, in_len, bx, span, args);
1102     }
1103
1104     // FIXME: use:
1105     //  https://github.com/llvm-mirror/llvm/blob/master/include/llvm/IR/Function.h#L182
1106     //  https://github.com/llvm-mirror/llvm/blob/master/include/llvm/IR/Intrinsics.h#L81
1107     fn llvm_vector_str(elem_ty: Ty<'_>, vec_len: u64, no_pointers: usize) -> String {
1108         let p0s: String = "p0".repeat(no_pointers);
1109         match *elem_ty.kind() {
1110             ty::Int(v) => format!("v{}{}i{}", vec_len, p0s, v.bit_width().unwrap()),
1111             ty::Uint(v) => format!("v{}{}i{}", vec_len, p0s, v.bit_width().unwrap()),
1112             ty::Float(v) => format!("v{}{}f{}", vec_len, p0s, v.bit_width()),
1113             _ => unreachable!(),
1114         }
1115     }
1116
1117     fn llvm_vector_ty(
1118         cx: &CodegenCx<'ll, '_>,
1119         elem_ty: Ty<'_>,
1120         vec_len: u64,
1121         mut no_pointers: usize,
1122     ) -> &'ll Type {
1123         // FIXME: use cx.layout_of(ty).llvm_type() ?
1124         let mut elem_ty = match *elem_ty.kind() {
1125             ty::Int(v) => cx.type_int_from_ty(v),
1126             ty::Uint(v) => cx.type_uint_from_ty(v),
1127             ty::Float(v) => cx.type_float_from_ty(v),
1128             _ => unreachable!(),
1129         };
1130         while no_pointers > 0 {
1131             elem_ty = cx.type_ptr_to(elem_ty);
1132             no_pointers -= 1;
1133         }
1134         cx.type_vector(elem_ty, vec_len)
1135     }
1136
1137     if name == sym::simd_gather {
1138         // simd_gather(values: <N x T>, pointers: <N x *_ T>,
1139         //             mask: <N x i{M}>) -> <N x T>
1140         // * N: number of elements in the input vectors
1141         // * T: type of the element to load
1142         // * M: any integer width is supported, will be truncated to i1
1143
1144         // All types must be simd vector types
1145         require_simd!(in_ty, "first");
1146         require_simd!(arg_tys[1], "second");
1147         require_simd!(arg_tys[2], "third");
1148         require_simd!(ret_ty, "return");
1149
1150         // Of the same length:
1151         let (out_len, _) = arg_tys[1].simd_size_and_type(bx.tcx());
1152         let (out_len2, _) = arg_tys[2].simd_size_and_type(bx.tcx());
1153         require!(
1154             in_len == out_len,
1155             "expected {} argument with length {} (same as input type `{}`), \
1156              found `{}` with length {}",
1157             "second",
1158             in_len,
1159             in_ty,
1160             arg_tys[1],
1161             out_len
1162         );
1163         require!(
1164             in_len == out_len2,
1165             "expected {} argument with length {} (same as input type `{}`), \
1166              found `{}` with length {}",
1167             "third",
1168             in_len,
1169             in_ty,
1170             arg_tys[2],
1171             out_len2
1172         );
1173
1174         // The return type must match the first argument type
1175         require!(ret_ty == in_ty, "expected return type `{}`, found `{}`", in_ty, ret_ty);
1176
1177         // This counts how many pointers
1178         fn ptr_count(t: Ty<'_>) -> usize {
1179             match t.kind() {
1180                 ty::RawPtr(p) => 1 + ptr_count(p.ty),
1181                 _ => 0,
1182             }
1183         }
1184
1185         // Non-ptr type
1186         fn non_ptr(t: Ty<'_>) -> Ty<'_> {
1187             match t.kind() {
1188                 ty::RawPtr(p) => non_ptr(p.ty),
1189                 _ => t,
1190             }
1191         }
1192
1193         // The second argument must be a simd vector with an element type that's a pointer
1194         // to the element type of the first argument
1195         let (_, element_ty0) = arg_tys[0].simd_size_and_type(bx.tcx());
1196         let (_, element_ty1) = arg_tys[1].simd_size_and_type(bx.tcx());
1197         let (pointer_count, underlying_ty) = match element_ty1.kind() {
1198             ty::RawPtr(p) if p.ty == in_elem => (ptr_count(element_ty1), non_ptr(element_ty1)),
1199             _ => {
1200                 require!(
1201                     false,
1202                     "expected element type `{}` of second argument `{}` \
1203                         to be a pointer to the element type `{}` of the first \
1204                         argument `{}`, found `{}` != `*_ {}`",
1205                     element_ty1,
1206                     arg_tys[1],
1207                     in_elem,
1208                     in_ty,
1209                     element_ty1,
1210                     in_elem
1211                 );
1212                 unreachable!();
1213             }
1214         };
1215         assert!(pointer_count > 0);
1216         assert_eq!(pointer_count - 1, ptr_count(element_ty0));
1217         assert_eq!(underlying_ty, non_ptr(element_ty0));
1218
1219         // The element type of the third argument must be a signed integer type of any width:
1220         let (_, element_ty2) = arg_tys[2].simd_size_and_type(bx.tcx());
1221         match element_ty2.kind() {
1222             ty::Int(_) => (),
1223             _ => {
1224                 require!(
1225                     false,
1226                     "expected element type `{}` of third argument `{}` \
1227                                  to be a signed integer type",
1228                     element_ty2,
1229                     arg_tys[2]
1230                 );
1231             }
1232         }
1233
1234         // Alignment of T, must be a constant integer value:
1235         let alignment_ty = bx.type_i32();
1236         let alignment = bx.const_i32(bx.align_of(in_elem).bytes() as i32);
1237
1238         // Truncate the mask vector to a vector of i1s:
1239         let (mask, mask_ty) = {
1240             let i1 = bx.type_i1();
1241             let i1xn = bx.type_vector(i1, in_len);
1242             (bx.trunc(args[2].immediate(), i1xn), i1xn)
1243         };
1244
1245         // Type of the vector of pointers:
1246         let llvm_pointer_vec_ty = llvm_vector_ty(bx, underlying_ty, in_len, pointer_count);
1247         let llvm_pointer_vec_str = llvm_vector_str(underlying_ty, in_len, pointer_count);
1248
1249         // Type of the vector of elements:
1250         let llvm_elem_vec_ty = llvm_vector_ty(bx, underlying_ty, in_len, pointer_count - 1);
1251         let llvm_elem_vec_str = llvm_vector_str(underlying_ty, in_len, pointer_count - 1);
1252
1253         let llvm_intrinsic =
1254             format!("llvm.masked.gather.{}.{}", llvm_elem_vec_str, llvm_pointer_vec_str);
1255         let f = bx.declare_cfn(
1256             &llvm_intrinsic,
1257             llvm::UnnamedAddr::No,
1258             bx.type_func(
1259                 &[llvm_pointer_vec_ty, alignment_ty, mask_ty, llvm_elem_vec_ty],
1260                 llvm_elem_vec_ty,
1261             ),
1262         );
1263         let v = bx.call(f, &[args[1].immediate(), alignment, mask, args[0].immediate()], None);
1264         return Ok(v);
1265     }
1266
1267     if name == sym::simd_scatter {
1268         // simd_scatter(values: <N x T>, pointers: <N x *mut T>,
1269         //             mask: <N x i{M}>) -> ()
1270         // * N: number of elements in the input vectors
1271         // * T: type of the element to load
1272         // * M: any integer width is supported, will be truncated to i1
1273
1274         // All types must be simd vector types
1275         require_simd!(in_ty, "first");
1276         require_simd!(arg_tys[1], "second");
1277         require_simd!(arg_tys[2], "third");
1278
1279         // Of the same length:
1280         let (element_len1, _) = arg_tys[1].simd_size_and_type(bx.tcx());
1281         let (element_len2, _) = arg_tys[2].simd_size_and_type(bx.tcx());
1282         require!(
1283             in_len == element_len1,
1284             "expected {} argument with length {} (same as input type `{}`), \
1285             found `{}` with length {}",
1286             "second",
1287             in_len,
1288             in_ty,
1289             arg_tys[1],
1290             element_len1
1291         );
1292         require!(
1293             in_len == element_len2,
1294             "expected {} argument with length {} (same as input type `{}`), \
1295             found `{}` with length {}",
1296             "third",
1297             in_len,
1298             in_ty,
1299             arg_tys[2],
1300             element_len2
1301         );
1302
1303         // This counts how many pointers
1304         fn ptr_count(t: Ty<'_>) -> usize {
1305             match t.kind() {
1306                 ty::RawPtr(p) => 1 + ptr_count(p.ty),
1307                 _ => 0,
1308             }
1309         }
1310
1311         // Non-ptr type
1312         fn non_ptr(t: Ty<'_>) -> Ty<'_> {
1313             match t.kind() {
1314                 ty::RawPtr(p) => non_ptr(p.ty),
1315                 _ => t,
1316             }
1317         }
1318
1319         // The second argument must be a simd vector with an element type that's a pointer
1320         // to the element type of the first argument
1321         let (_, element_ty0) = arg_tys[0].simd_size_and_type(bx.tcx());
1322         let (_, element_ty1) = arg_tys[1].simd_size_and_type(bx.tcx());
1323         let (_, element_ty2) = arg_tys[2].simd_size_and_type(bx.tcx());
1324         let (pointer_count, underlying_ty) = match element_ty1.kind() {
1325             ty::RawPtr(p) if p.ty == in_elem && p.mutbl == hir::Mutability::Mut => {
1326                 (ptr_count(element_ty1), non_ptr(element_ty1))
1327             }
1328             _ => {
1329                 require!(
1330                     false,
1331                     "expected element type `{}` of second argument `{}` \
1332                         to be a pointer to the element type `{}` of the first \
1333                         argument `{}`, found `{}` != `*mut {}`",
1334                     element_ty1,
1335                     arg_tys[1],
1336                     in_elem,
1337                     in_ty,
1338                     element_ty1,
1339                     in_elem
1340                 );
1341                 unreachable!();
1342             }
1343         };
1344         assert!(pointer_count > 0);
1345         assert_eq!(pointer_count - 1, ptr_count(element_ty0));
1346         assert_eq!(underlying_ty, non_ptr(element_ty0));
1347
1348         // The element type of the third argument must be a signed integer type of any width:
1349         match element_ty2.kind() {
1350             ty::Int(_) => (),
1351             _ => {
1352                 require!(
1353                     false,
1354                     "expected element type `{}` of third argument `{}` \
1355                          be a signed integer type",
1356                     element_ty2,
1357                     arg_tys[2]
1358                 );
1359             }
1360         }
1361
1362         // Alignment of T, must be a constant integer value:
1363         let alignment_ty = bx.type_i32();
1364         let alignment = bx.const_i32(bx.align_of(in_elem).bytes() as i32);
1365
1366         // Truncate the mask vector to a vector of i1s:
1367         let (mask, mask_ty) = {
1368             let i1 = bx.type_i1();
1369             let i1xn = bx.type_vector(i1, in_len);
1370             (bx.trunc(args[2].immediate(), i1xn), i1xn)
1371         };
1372
1373         let ret_t = bx.type_void();
1374
1375         // Type of the vector of pointers:
1376         let llvm_pointer_vec_ty = llvm_vector_ty(bx, underlying_ty, in_len, pointer_count);
1377         let llvm_pointer_vec_str = llvm_vector_str(underlying_ty, in_len, pointer_count);
1378
1379         // Type of the vector of elements:
1380         let llvm_elem_vec_ty = llvm_vector_ty(bx, underlying_ty, in_len, pointer_count - 1);
1381         let llvm_elem_vec_str = llvm_vector_str(underlying_ty, in_len, pointer_count - 1);
1382
1383         let llvm_intrinsic =
1384             format!("llvm.masked.scatter.{}.{}", llvm_elem_vec_str, llvm_pointer_vec_str);
1385         let f = bx.declare_cfn(
1386             &llvm_intrinsic,
1387             llvm::UnnamedAddr::No,
1388             bx.type_func(&[llvm_elem_vec_ty, llvm_pointer_vec_ty, alignment_ty, mask_ty], ret_t),
1389         );
1390         let v = bx.call(f, &[args[0].immediate(), args[1].immediate(), alignment, mask], None);
1391         return Ok(v);
1392     }
1393
1394     macro_rules! arith_red {
1395         ($name:ident : $integer_reduce:ident, $float_reduce:ident, $ordered:expr, $op:ident,
1396          $identity:expr) => {
1397             if name == sym::$name {
1398                 require!(
1399                     ret_ty == in_elem,
1400                     "expected return type `{}` (element of input `{}`), found `{}`",
1401                     in_elem,
1402                     in_ty,
1403                     ret_ty
1404                 );
1405                 return match in_elem.kind() {
1406                     ty::Int(_) | ty::Uint(_) => {
1407                         let r = bx.$integer_reduce(args[0].immediate());
1408                         if $ordered {
1409                             // if overflow occurs, the result is the
1410                             // mathematical result modulo 2^n:
1411                             Ok(bx.$op(args[1].immediate(), r))
1412                         } else {
1413                             Ok(bx.$integer_reduce(args[0].immediate()))
1414                         }
1415                     }
1416                     ty::Float(f) => {
1417                         let acc = if $ordered {
1418                             // ordered arithmetic reductions take an accumulator
1419                             args[1].immediate()
1420                         } else {
1421                             // unordered arithmetic reductions use the identity accumulator
1422                             match f.bit_width() {
1423                                 32 => bx.const_real(bx.type_f32(), $identity),
1424                                 64 => bx.const_real(bx.type_f64(), $identity),
1425                                 v => return_error!(
1426                                     r#"
1427 unsupported {} from `{}` with element `{}` of size `{}` to `{}`"#,
1428                                     sym::$name,
1429                                     in_ty,
1430                                     in_elem,
1431                                     v,
1432                                     ret_ty
1433                                 ),
1434                             }
1435                         };
1436                         Ok(bx.$float_reduce(acc, args[0].immediate()))
1437                     }
1438                     _ => return_error!(
1439                         "unsupported {} from `{}` with element `{}` to `{}`",
1440                         sym::$name,
1441                         in_ty,
1442                         in_elem,
1443                         ret_ty
1444                     ),
1445                 };
1446             }
1447         };
1448     }
1449
1450     arith_red!(simd_reduce_add_ordered: vector_reduce_add, vector_reduce_fadd, true, add, 0.0);
1451     arith_red!(simd_reduce_mul_ordered: vector_reduce_mul, vector_reduce_fmul, true, mul, 1.0);
1452     arith_red!(
1453         simd_reduce_add_unordered: vector_reduce_add,
1454         vector_reduce_fadd_fast,
1455         false,
1456         add,
1457         0.0
1458     );
1459     arith_red!(
1460         simd_reduce_mul_unordered: vector_reduce_mul,
1461         vector_reduce_fmul_fast,
1462         false,
1463         mul,
1464         1.0
1465     );
1466
1467     macro_rules! minmax_red {
1468         ($name:ident: $int_red:ident, $float_red:ident) => {
1469             if name == sym::$name {
1470                 require!(
1471                     ret_ty == in_elem,
1472                     "expected return type `{}` (element of input `{}`), found `{}`",
1473                     in_elem,
1474                     in_ty,
1475                     ret_ty
1476                 );
1477                 return match in_elem.kind() {
1478                     ty::Int(_i) => Ok(bx.$int_red(args[0].immediate(), true)),
1479                     ty::Uint(_u) => Ok(bx.$int_red(args[0].immediate(), false)),
1480                     ty::Float(_f) => Ok(bx.$float_red(args[0].immediate())),
1481                     _ => return_error!(
1482                         "unsupported {} from `{}` with element `{}` to `{}`",
1483                         sym::$name,
1484                         in_ty,
1485                         in_elem,
1486                         ret_ty
1487                     ),
1488                 };
1489             }
1490         };
1491     }
1492
1493     minmax_red!(simd_reduce_min: vector_reduce_min, vector_reduce_fmin);
1494     minmax_red!(simd_reduce_max: vector_reduce_max, vector_reduce_fmax);
1495
1496     minmax_red!(simd_reduce_min_nanless: vector_reduce_min, vector_reduce_fmin_fast);
1497     minmax_red!(simd_reduce_max_nanless: vector_reduce_max, vector_reduce_fmax_fast);
1498
1499     macro_rules! bitwise_red {
1500         ($name:ident : $red:ident, $boolean:expr) => {
1501             if name == sym::$name {
1502                 let input = if !$boolean {
1503                     require!(
1504                         ret_ty == in_elem,
1505                         "expected return type `{}` (element of input `{}`), found `{}`",
1506                         in_elem,
1507                         in_ty,
1508                         ret_ty
1509                     );
1510                     args[0].immediate()
1511                 } else {
1512                     match in_elem.kind() {
1513                         ty::Int(_) | ty::Uint(_) => {}
1514                         _ => return_error!(
1515                             "unsupported {} from `{}` with element `{}` to `{}`",
1516                             sym::$name,
1517                             in_ty,
1518                             in_elem,
1519                             ret_ty
1520                         ),
1521                     }
1522
1523                     // boolean reductions operate on vectors of i1s:
1524                     let i1 = bx.type_i1();
1525                     let i1xn = bx.type_vector(i1, in_len as u64);
1526                     bx.trunc(args[0].immediate(), i1xn)
1527                 };
1528                 return match in_elem.kind() {
1529                     ty::Int(_) | ty::Uint(_) => {
1530                         let r = bx.$red(input);
1531                         Ok(if !$boolean { r } else { bx.zext(r, bx.type_bool()) })
1532                     }
1533                     _ => return_error!(
1534                         "unsupported {} from `{}` with element `{}` to `{}`",
1535                         sym::$name,
1536                         in_ty,
1537                         in_elem,
1538                         ret_ty
1539                     ),
1540                 };
1541             }
1542         };
1543     }
1544
1545     bitwise_red!(simd_reduce_and: vector_reduce_and, false);
1546     bitwise_red!(simd_reduce_or: vector_reduce_or, false);
1547     bitwise_red!(simd_reduce_xor: vector_reduce_xor, false);
1548     bitwise_red!(simd_reduce_all: vector_reduce_and, true);
1549     bitwise_red!(simd_reduce_any: vector_reduce_or, true);
1550
1551     if name == sym::simd_cast {
1552         require_simd!(ret_ty, "return");
1553         let (out_len, out_elem) = ret_ty.simd_size_and_type(bx.tcx());
1554         require!(
1555             in_len == out_len,
1556             "expected return type with length {} (same as input type `{}`), \
1557                   found `{}` with length {}",
1558             in_len,
1559             in_ty,
1560             ret_ty,
1561             out_len
1562         );
1563         // casting cares about nominal type, not just structural type
1564         if in_elem == out_elem {
1565             return Ok(args[0].immediate());
1566         }
1567
1568         enum Style {
1569             Float,
1570             Int(/* is signed? */ bool),
1571             Unsupported,
1572         }
1573
1574         let (in_style, in_width) = match in_elem.kind() {
1575             // vectors of pointer-sized integers should've been
1576             // disallowed before here, so this unwrap is safe.
1577             ty::Int(i) => (Style::Int(true), i.bit_width().unwrap()),
1578             ty::Uint(u) => (Style::Int(false), u.bit_width().unwrap()),
1579             ty::Float(f) => (Style::Float, f.bit_width()),
1580             _ => (Style::Unsupported, 0),
1581         };
1582         let (out_style, out_width) = match out_elem.kind() {
1583             ty::Int(i) => (Style::Int(true), i.bit_width().unwrap()),
1584             ty::Uint(u) => (Style::Int(false), u.bit_width().unwrap()),
1585             ty::Float(f) => (Style::Float, f.bit_width()),
1586             _ => (Style::Unsupported, 0),
1587         };
1588
1589         match (in_style, out_style) {
1590             (Style::Int(in_is_signed), Style::Int(_)) => {
1591                 return Ok(match in_width.cmp(&out_width) {
1592                     Ordering::Greater => bx.trunc(args[0].immediate(), llret_ty),
1593                     Ordering::Equal => args[0].immediate(),
1594                     Ordering::Less => {
1595                         if in_is_signed {
1596                             bx.sext(args[0].immediate(), llret_ty)
1597                         } else {
1598                             bx.zext(args[0].immediate(), llret_ty)
1599                         }
1600                     }
1601                 });
1602             }
1603             (Style::Int(in_is_signed), Style::Float) => {
1604                 return Ok(if in_is_signed {
1605                     bx.sitofp(args[0].immediate(), llret_ty)
1606                 } else {
1607                     bx.uitofp(args[0].immediate(), llret_ty)
1608                 });
1609             }
1610             (Style::Float, Style::Int(out_is_signed)) => {
1611                 return Ok(if out_is_signed {
1612                     bx.fptosi(args[0].immediate(), llret_ty)
1613                 } else {
1614                     bx.fptoui(args[0].immediate(), llret_ty)
1615                 });
1616             }
1617             (Style::Float, Style::Float) => {
1618                 return Ok(match in_width.cmp(&out_width) {
1619                     Ordering::Greater => bx.fptrunc(args[0].immediate(), llret_ty),
1620                     Ordering::Equal => args[0].immediate(),
1621                     Ordering::Less => bx.fpext(args[0].immediate(), llret_ty),
1622                 });
1623             }
1624             _ => { /* Unsupported. Fallthrough. */ }
1625         }
1626         require!(
1627             false,
1628             "unsupported cast from `{}` with element `{}` to `{}` with element `{}`",
1629             in_ty,
1630             in_elem,
1631             ret_ty,
1632             out_elem
1633         );
1634     }
1635     macro_rules! arith_binary {
1636         ($($name: ident: $($($p: ident),* => $call: ident),*;)*) => {
1637             $(if name == sym::$name {
1638                 match in_elem.kind() {
1639                     $($(ty::$p(_))|* => {
1640                         return Ok(bx.$call(args[0].immediate(), args[1].immediate()))
1641                     })*
1642                     _ => {},
1643                 }
1644                 require!(false,
1645                          "unsupported operation on `{}` with element `{}`",
1646                          in_ty,
1647                          in_elem)
1648             })*
1649         }
1650     }
1651     arith_binary! {
1652         simd_add: Uint, Int => add, Float => fadd;
1653         simd_sub: Uint, Int => sub, Float => fsub;
1654         simd_mul: Uint, Int => mul, Float => fmul;
1655         simd_div: Uint => udiv, Int => sdiv, Float => fdiv;
1656         simd_rem: Uint => urem, Int => srem, Float => frem;
1657         simd_shl: Uint, Int => shl;
1658         simd_shr: Uint => lshr, Int => ashr;
1659         simd_and: Uint, Int => and;
1660         simd_or: Uint, Int => or;
1661         simd_xor: Uint, Int => xor;
1662         simd_fmax: Float => maxnum;
1663         simd_fmin: Float => minnum;
1664
1665     }
1666     macro_rules! arith_unary {
1667         ($($name: ident: $($($p: ident),* => $call: ident),*;)*) => {
1668             $(if name == sym::$name {
1669                 match in_elem.kind() {
1670                     $($(ty::$p(_))|* => {
1671                         return Ok(bx.$call(args[0].immediate()))
1672                     })*
1673                     _ => {},
1674                 }
1675                 require!(false,
1676                          "unsupported operation on `{}` with element `{}`",
1677                          in_ty,
1678                          in_elem)
1679             })*
1680         }
1681     }
1682     arith_unary! {
1683         simd_neg: Int => neg, Float => fneg;
1684     }
1685
1686     if name == sym::simd_saturating_add || name == sym::simd_saturating_sub {
1687         let lhs = args[0].immediate();
1688         let rhs = args[1].immediate();
1689         let is_add = name == sym::simd_saturating_add;
1690         let ptr_bits = bx.tcx().data_layout.pointer_size.bits() as _;
1691         let (signed, elem_width, elem_ty) = match *in_elem.kind() {
1692             ty::Int(i) => (true, i.bit_width().unwrap_or(ptr_bits), bx.cx.type_int_from_ty(i)),
1693             ty::Uint(i) => (false, i.bit_width().unwrap_or(ptr_bits), bx.cx.type_uint_from_ty(i)),
1694             _ => {
1695                 return_error!(
1696                     "expected element type `{}` of vector type `{}` \
1697                      to be a signed or unsigned integer type",
1698                     arg_tys[0].simd_size_and_type(bx.tcx()).1,
1699                     arg_tys[0]
1700                 );
1701             }
1702         };
1703         let llvm_intrinsic = &format!(
1704             "llvm.{}{}.sat.v{}i{}",
1705             if signed { 's' } else { 'u' },
1706             if is_add { "add" } else { "sub" },
1707             in_len,
1708             elem_width
1709         );
1710         let vec_ty = bx.cx.type_vector(elem_ty, in_len as u64);
1711
1712         let f = bx.declare_cfn(
1713             &llvm_intrinsic,
1714             llvm::UnnamedAddr::No,
1715             bx.type_func(&[vec_ty, vec_ty], vec_ty),
1716         );
1717         let v = bx.call(f, &[lhs, rhs], None);
1718         return Ok(v);
1719     }
1720
1721     span_bug!(span, "unknown SIMD intrinsic");
1722 }
1723
1724 // Returns the width of an int Ty, and if it's signed or not
1725 // Returns None if the type is not an integer
1726 // FIXME: there’s multiple of this functions, investigate using some of the already existing
1727 // stuffs.
1728 fn int_type_width_signed(ty: Ty<'_>, cx: &CodegenCx<'_, '_>) -> Option<(u64, bool)> {
1729     match ty.kind() {
1730         ty::Int(t) => {
1731             Some((t.bit_width().unwrap_or(u64::from(cx.tcx.sess.target.pointer_width)), true))
1732         }
1733         ty::Uint(t) => {
1734             Some((t.bit_width().unwrap_or(u64::from(cx.tcx.sess.target.pointer_width)), false))
1735         }
1736         _ => None,
1737     }
1738 }