1 //! Type-checking for the rust-intrinsic and platform-intrinsic
2 //! intrinsics that the compiler exposes.
5 UnrecognizedAtomicOperation, UnrecognizedIntrinsicFunction,
6 WrongNumberOfGenericArgumentsToIntrinsic,
8 use crate::require_same_types;
10 use rustc_errors::struct_span_err;
12 use rustc_middle::traits::{ObligationCause, ObligationCauseCode};
13 use rustc_middle::ty::subst::Subst;
14 use rustc_middle::ty::{self, TyCtxt};
15 use rustc_span::symbol::{kw, sym, Symbol};
16 use rustc_target::spec::abi::Abi;
20 fn equate_intrinsic_type<'tcx>(
22 it: &hir::ForeignItem<'_>,
25 sig: ty::PolyFnSig<'tcx>,
27 let (own_counts, span) = match &it.kind {
28 hir::ForeignItemKind::Fn(.., generics) => {
29 let own_counts = tcx.generics_of(it.def_id.to_def_id()).own_counts();
30 (own_counts, generics.span)
33 struct_span_err!(tcx.sess, it.span, E0622, "intrinsic must be a function")
34 .span_label(it.span, "expected a function")
40 let gen_count_ok = |found: usize, expected: usize, descr: &str| -> bool {
41 if found != expected {
42 tcx.sess.emit_err(WrongNumberOfGenericArgumentsToIntrinsic {
54 if gen_count_ok(own_counts.lifetimes, n_lts, "lifetime")
55 && gen_count_ok(own_counts.types, n_tps, "type")
56 && gen_count_ok(own_counts.consts, 0, "const")
58 let fty = tcx.mk_fn_ptr(sig);
59 let cause = ObligationCause::new(it.span, it.hir_id(), ObligationCauseCode::IntrinsicType);
60 require_same_types(tcx, &cause, tcx.mk_fn_ptr(tcx.fn_sig(it.def_id)), fty);
64 /// Returns the unsafety of the given intrinsic.
65 pub fn intrinsic_operation_unsafety(intrinsic: Symbol) -> hir::Unsafety {
67 // When adding a new intrinsic to this list,
68 // it's usually worth updating that intrinsic's documentation
69 // to note that it's safe to call, since
70 // safe extern fns are otherwise unprecedented.
75 | sym::caller_location
76 | sym::add_with_overflow
77 | sym::sub_with_overflow
78 | sym::mul_with_overflow
91 | sym::discriminant_value
95 | sym::ptr_guaranteed_eq
96 | sym::ptr_guaranteed_ne
105 | sym::variant_count => hir::Unsafety::Normal,
106 _ => hir::Unsafety::Unsafe,
110 /// Remember to add all intrinsics here, in `compiler/rustc_codegen_llvm/src/intrinsic.rs`,
111 /// and in `library/core/src/intrinsics.rs`.
112 pub fn check_intrinsic_type(tcx: TyCtxt<'_>, it: &hir::ForeignItem<'_>) {
113 let param = |n| tcx.mk_ty_param(n, Symbol::intern(&format!("P{}", n)));
114 let intrinsic_name = tcx.item_name(it.def_id.to_def_id());
115 let name_str = intrinsic_name.as_str();
117 let bound_vars = tcx.mk_bound_variable_kinds(
118 [ty::BoundVariableKind::Region(ty::BrAnon(0)), ty::BoundVariableKind::Region(ty::BrEnv)]
122 let mk_va_list_ty = |mutbl| {
123 tcx.lang_items().va_list().map(|did| {
124 let region = tcx.mk_region(ty::ReLateBound(
126 ty::BoundRegion { var: ty::BoundVar::from_u32(0), kind: ty::BrAnon(0) },
128 let env_region = tcx.mk_region(ty::ReLateBound(
130 ty::BoundRegion { var: ty::BoundVar::from_u32(1), kind: ty::BrEnv },
132 let va_list_ty = tcx.type_of(did).subst(tcx, &[region.into()]);
133 (tcx.mk_ref(env_region, ty::TypeAndMut { ty: va_list_ty, mutbl }), va_list_ty)
137 let (n_tps, n_lts, inputs, output, unsafety) = if name_str.starts_with("atomic_") {
138 let split: Vec<&str> = name_str.split('_').collect();
139 assert!(split.len() >= 2, "Atomic intrinsic in an incorrect format");
141 //We only care about the operation here
142 let (n_tps, inputs, output) = match split[1] {
143 "cxchg" | "cxchgweak" => (
145 vec![tcx.mk_mut_ptr(param(0)), param(0), param(0)],
146 tcx.intern_tup(&[param(0), tcx.types.bool]),
148 "load" => (1, vec![tcx.mk_imm_ptr(param(0))], param(0)),
149 "store" => (1, vec![tcx.mk_mut_ptr(param(0)), param(0)], tcx.mk_unit()),
151 "xchg" | "xadd" | "xsub" | "and" | "nand" | "or" | "xor" | "max" | "min" | "umax"
152 | "umin" => (1, vec![tcx.mk_mut_ptr(param(0)), param(0)], param(0)),
153 "fence" | "singlethreadfence" => (0, Vec::new(), tcx.mk_unit()),
155 tcx.sess.emit_err(UnrecognizedAtomicOperation { span: it.span, op });
159 (n_tps, 0, inputs, output, hir::Unsafety::Unsafe)
161 let unsafety = intrinsic_operation_unsafety(intrinsic_name);
162 let (n_tps, inputs, output) = match intrinsic_name {
163 sym::abort => (0, Vec::new(), tcx.types.never),
164 sym::unreachable => (0, Vec::new(), tcx.types.never),
165 sym::breakpoint => (0, Vec::new(), tcx.mk_unit()),
166 sym::size_of | sym::pref_align_of | sym::min_align_of | sym::variant_count => {
167 (1, Vec::new(), tcx.types.usize)
169 sym::size_of_val | sym::min_align_of_val => {
170 (1, vec![tcx.mk_imm_ptr(param(0))], tcx.types.usize)
172 sym::rustc_peek => (1, vec![param(0)], param(0)),
173 sym::caller_location => (0, vec![], tcx.caller_location_ty()),
174 sym::assert_inhabited | sym::assert_zero_valid | sym::assert_uninit_valid => {
175 (1, Vec::new(), tcx.mk_unit())
177 sym::forget => (1, vec![param(0)], tcx.mk_unit()),
178 sym::transmute => (2, vec![param(0)], param(1)),
179 sym::prefetch_read_data
180 | sym::prefetch_write_data
181 | sym::prefetch_read_instruction
182 | sym::prefetch_write_instruction => (
185 tcx.mk_ptr(ty::TypeAndMut { ty: param(0), mutbl: hir::Mutability::Not }),
190 sym::drop_in_place => (1, vec![tcx.mk_mut_ptr(param(0))], tcx.mk_unit()),
191 sym::needs_drop => (1, Vec::new(), tcx.types.bool),
193 sym::type_name => (1, Vec::new(), tcx.mk_static_str()),
194 sym::type_id => (1, Vec::new(), tcx.types.u64),
195 sym::offset | sym::arith_offset => (
198 tcx.mk_ptr(ty::TypeAndMut { ty: param(0), mutbl: hir::Mutability::Not }),
201 tcx.mk_ptr(ty::TypeAndMut { ty: param(0), mutbl: hir::Mutability::Not }),
203 sym::copy | sym::copy_nonoverlapping => (
206 tcx.mk_ptr(ty::TypeAndMut { ty: param(0), mutbl: hir::Mutability::Not }),
207 tcx.mk_ptr(ty::TypeAndMut { ty: param(0), mutbl: hir::Mutability::Mut }),
212 sym::volatile_copy_memory | sym::volatile_copy_nonoverlapping_memory => (
215 tcx.mk_ptr(ty::TypeAndMut { ty: param(0), mutbl: hir::Mutability::Mut }),
216 tcx.mk_ptr(ty::TypeAndMut { ty: param(0), mutbl: hir::Mutability::Not }),
221 sym::write_bytes | sym::volatile_set_memory => (
224 tcx.mk_ptr(ty::TypeAndMut { ty: param(0), mutbl: hir::Mutability::Mut }),
230 sym::sqrtf32 => (0, vec![tcx.types.f32], tcx.types.f32),
231 sym::sqrtf64 => (0, vec![tcx.types.f64], tcx.types.f64),
232 sym::powif32 => (0, vec![tcx.types.f32, tcx.types.i32], tcx.types.f32),
233 sym::powif64 => (0, vec![tcx.types.f64, tcx.types.i32], tcx.types.f64),
234 sym::sinf32 => (0, vec![tcx.types.f32], tcx.types.f32),
235 sym::sinf64 => (0, vec![tcx.types.f64], tcx.types.f64),
236 sym::cosf32 => (0, vec![tcx.types.f32], tcx.types.f32),
237 sym::cosf64 => (0, vec![tcx.types.f64], tcx.types.f64),
238 sym::powf32 => (0, vec![tcx.types.f32, tcx.types.f32], tcx.types.f32),
239 sym::powf64 => (0, vec![tcx.types.f64, tcx.types.f64], tcx.types.f64),
240 sym::expf32 => (0, vec![tcx.types.f32], tcx.types.f32),
241 sym::expf64 => (0, vec![tcx.types.f64], tcx.types.f64),
242 sym::exp2f32 => (0, vec![tcx.types.f32], tcx.types.f32),
243 sym::exp2f64 => (0, vec![tcx.types.f64], tcx.types.f64),
244 sym::logf32 => (0, vec![tcx.types.f32], tcx.types.f32),
245 sym::logf64 => (0, vec![tcx.types.f64], tcx.types.f64),
246 sym::log10f32 => (0, vec![tcx.types.f32], tcx.types.f32),
247 sym::log10f64 => (0, vec![tcx.types.f64], tcx.types.f64),
248 sym::log2f32 => (0, vec![tcx.types.f32], tcx.types.f32),
249 sym::log2f64 => (0, vec![tcx.types.f64], tcx.types.f64),
250 sym::fmaf32 => (0, vec![tcx.types.f32, tcx.types.f32, tcx.types.f32], tcx.types.f32),
251 sym::fmaf64 => (0, vec![tcx.types.f64, tcx.types.f64, tcx.types.f64], tcx.types.f64),
252 sym::fabsf32 => (0, vec![tcx.types.f32], tcx.types.f32),
253 sym::fabsf64 => (0, vec![tcx.types.f64], tcx.types.f64),
254 sym::minnumf32 => (0, vec![tcx.types.f32, tcx.types.f32], tcx.types.f32),
255 sym::minnumf64 => (0, vec![tcx.types.f64, tcx.types.f64], tcx.types.f64),
256 sym::maxnumf32 => (0, vec![tcx.types.f32, tcx.types.f32], tcx.types.f32),
257 sym::maxnumf64 => (0, vec![tcx.types.f64, tcx.types.f64], tcx.types.f64),
258 sym::copysignf32 => (0, vec![tcx.types.f32, tcx.types.f32], tcx.types.f32),
259 sym::copysignf64 => (0, vec![tcx.types.f64, tcx.types.f64], tcx.types.f64),
260 sym::floorf32 => (0, vec![tcx.types.f32], tcx.types.f32),
261 sym::floorf64 => (0, vec![tcx.types.f64], tcx.types.f64),
262 sym::ceilf32 => (0, vec![tcx.types.f32], tcx.types.f32),
263 sym::ceilf64 => (0, vec![tcx.types.f64], tcx.types.f64),
264 sym::truncf32 => (0, vec![tcx.types.f32], tcx.types.f32),
265 sym::truncf64 => (0, vec![tcx.types.f64], tcx.types.f64),
266 sym::rintf32 => (0, vec![tcx.types.f32], tcx.types.f32),
267 sym::rintf64 => (0, vec![tcx.types.f64], tcx.types.f64),
268 sym::nearbyintf32 => (0, vec![tcx.types.f32], tcx.types.f32),
269 sym::nearbyintf64 => (0, vec![tcx.types.f64], tcx.types.f64),
270 sym::roundf32 => (0, vec![tcx.types.f32], tcx.types.f32),
271 sym::roundf64 => (0, vec![tcx.types.f64], tcx.types.f64),
273 sym::volatile_load | sym::unaligned_volatile_load => {
274 (1, vec![tcx.mk_imm_ptr(param(0))], param(0))
276 sym::volatile_store | sym::unaligned_volatile_store => {
277 (1, vec![tcx.mk_mut_ptr(param(0)), param(0)], tcx.mk_unit())
286 | sym::bitreverse => (1, vec![param(0)], param(0)),
288 sym::add_with_overflow | sym::sub_with_overflow | sym::mul_with_overflow => {
289 (1, vec![param(0), param(0)], tcx.intern_tup(&[param(0), tcx.types.bool]))
292 sym::ptr_guaranteed_eq | sym::ptr_guaranteed_ne => {
293 (1, vec![tcx.mk_imm_ptr(param(0)), tcx.mk_imm_ptr(param(0))], tcx.types.bool)
296 sym::const_allocate => {
297 (0, vec![tcx.types.usize, tcx.types.usize], tcx.mk_mut_ptr(tcx.types.u8))
299 sym::const_deallocate => (
301 vec![tcx.mk_mut_ptr(tcx.types.u8), tcx.types.usize, tcx.types.usize],
305 sym::ptr_offset_from => {
306 (1, vec![tcx.mk_imm_ptr(param(0)), tcx.mk_imm_ptr(param(0))], tcx.types.isize)
308 sym::unchecked_div | sym::unchecked_rem | sym::exact_div => {
309 (1, vec![param(0), param(0)], param(0))
311 sym::unchecked_shl | sym::unchecked_shr | sym::rotate_left | sym::rotate_right => {
312 (1, vec![param(0), param(0)], param(0))
314 sym::unchecked_add | sym::unchecked_sub | sym::unchecked_mul => {
315 (1, vec![param(0), param(0)], param(0))
317 sym::wrapping_add | sym::wrapping_sub | sym::wrapping_mul => {
318 (1, vec![param(0), param(0)], param(0))
320 sym::saturating_add | sym::saturating_sub => (1, vec![param(0), param(0)], param(0)),
321 sym::fadd_fast | sym::fsub_fast | sym::fmul_fast | sym::fdiv_fast | sym::frem_fast => {
322 (1, vec![param(0), param(0)], param(0))
324 sym::float_to_int_unchecked => (2, vec![param(0)], param(1)),
326 sym::assume => (0, vec![tcx.types.bool], tcx.mk_unit()),
327 sym::likely => (0, vec![tcx.types.bool], tcx.types.bool),
328 sym::unlikely => (0, vec![tcx.types.bool], tcx.types.bool),
330 sym::discriminant_value => {
331 let assoc_items = tcx.associated_item_def_ids(
332 tcx.require_lang_item(hir::LangItem::DiscriminantKind, None),
334 let discriminant_def_id = assoc_items[0];
336 let br = ty::BoundRegion { var: ty::BoundVar::from_u32(0), kind: ty::BrAnon(0) };
340 tcx.mk_imm_ref(tcx.mk_region(ty::ReLateBound(ty::INNERMOST, br)), param(0)),
342 tcx.mk_projection(discriminant_def_id, tcx.mk_substs([param(0).into()].iter())),
347 let mut_u8 = tcx.mk_mut_ptr(tcx.types.u8);
348 let try_fn_ty = ty::Binder::dummy(tcx.mk_fn_sig(
352 hir::Unsafety::Normal,
355 let catch_fn_ty = ty::Binder::dummy(tcx.mk_fn_sig(
356 [mut_u8, mut_u8].iter().cloned(),
359 hir::Unsafety::Normal,
364 vec![tcx.mk_fn_ptr(try_fn_ty), mut_u8, tcx.mk_fn_ptr(catch_fn_ty)],
369 sym::va_start | sym::va_end => match mk_va_list_ty(hir::Mutability::Mut) {
370 Some((va_list_ref_ty, _)) => (0, vec![va_list_ref_ty], tcx.mk_unit()),
371 None => bug!("`va_list` language item needed for C-variadic intrinsics"),
374 sym::va_copy => match mk_va_list_ty(hir::Mutability::Not) {
375 Some((va_list_ref_ty, va_list_ty)) => {
376 let va_list_ptr_ty = tcx.mk_mut_ptr(va_list_ty);
377 (0, vec![va_list_ptr_ty, va_list_ref_ty], tcx.mk_unit())
379 None => bug!("`va_list` language item needed for C-variadic intrinsics"),
382 sym::va_arg => match mk_va_list_ty(hir::Mutability::Mut) {
383 Some((va_list_ref_ty, _)) => (1, vec![va_list_ref_ty], param(0)),
384 None => bug!("`va_list` language item needed for C-variadic intrinsics"),
387 sym::nontemporal_store => (1, vec![tcx.mk_mut_ptr(param(0)), param(0)], tcx.mk_unit()),
390 let br = ty::BoundRegion { var: ty::BoundVar::from_u32(0), kind: ty::BrAnon(0) };
392 tcx.mk_imm_ref(tcx.mk_region(ty::ReLateBound(ty::INNERMOST, br)), param(0));
393 (1, vec![param_ty; 2], tcx.types.bool)
396 sym::black_box => (1, vec![param(0)], param(0)),
398 sym::const_eval_select => (4, vec![param(0), param(1), param(2)], param(3)),
401 tcx.sess.emit_err(UnrecognizedIntrinsicFunction { span: it.span, name: other });
405 (n_tps, 0, inputs, output, unsafety)
407 let sig = tcx.mk_fn_sig(inputs.into_iter(), output, false, unsafety, Abi::RustIntrinsic);
408 let sig = ty::Binder::bind_with_vars(sig, bound_vars);
409 equate_intrinsic_type(tcx, it, n_tps, n_lts, sig)
412 /// Type-check `extern "platform-intrinsic" { ... }` functions.
413 pub fn check_platform_intrinsic_type(tcx: TyCtxt<'_>, it: &hir::ForeignItem<'_>) {
415 let name = Symbol::intern(&format!("P{}", n));
416 tcx.mk_ty_param(n, name)
419 let name = it.ident.name;
421 let (n_tps, inputs, output) = match name {
422 sym::simd_eq | sym::simd_ne | sym::simd_lt | sym::simd_le | sym::simd_gt | sym::simd_ge => {
423 (2, vec![param(0), param(0)], param(1))
438 | sym::simd_saturating_add
439 | sym::simd_saturating_sub => (1, vec![param(0), param(0)], param(0)),
440 sym::simd_arith_offset => (2, vec![param(0), param(1)], param(0)),
454 | sym::simd_trunc => (1, vec![param(0)], param(0)),
455 sym::simd_fpowi => (1, vec![param(0), tcx.types.i32], param(0)),
456 sym::simd_fma => (1, vec![param(0), param(0), param(0)], param(0)),
457 sym::simd_gather => (3, vec![param(0), param(1), param(2)], param(0)),
458 sym::simd_scatter => (3, vec![param(0), param(1), param(2)], tcx.mk_unit()),
459 sym::simd_insert => (2, vec![param(0), tcx.types.u32, param(1)], param(0)),
460 sym::simd_extract => (2, vec![param(0), tcx.types.u32], param(1)),
461 sym::simd_cast | sym::simd_as => (2, vec![param(0)], param(1)),
462 sym::simd_bitmask => (2, vec![param(0)], param(1)),
463 sym::simd_select | sym::simd_select_bitmask => {
464 (2, vec![param(0), param(1), param(1)], param(1))
466 sym::simd_reduce_all | sym::simd_reduce_any => (1, vec![param(0)], tcx.types.bool),
467 sym::simd_reduce_add_ordered | sym::simd_reduce_mul_ordered => {
468 (2, vec![param(0), param(1)], param(1))
470 sym::simd_reduce_add_unordered
471 | sym::simd_reduce_mul_unordered
472 | sym::simd_reduce_and
473 | sym::simd_reduce_or
474 | sym::simd_reduce_xor
475 | sym::simd_reduce_min
476 | sym::simd_reduce_max
477 | sym::simd_reduce_min_nanless
478 | sym::simd_reduce_max_nanless => (2, vec![param(0)], param(1)),
479 sym::simd_shuffle => (3, vec![param(0), param(0), param(1)], param(2)),
480 name if name.as_str().starts_with("simd_shuffle") => {
481 match name.as_str()["simd_shuffle".len()..].parse() {
483 let params = vec![param(0), param(0), tcx.mk_array(tcx.types.u32, n)];
484 (2, params, param(1))
488 format!("unrecognized platform-specific intrinsic function: `{name}`");
489 tcx.sess.struct_span_err(it.span, &msg).emit();
495 let msg = format!("unrecognized platform-specific intrinsic function: `{name}`");
496 tcx.sess.struct_span_err(it.span, &msg).emit();
501 let sig = tcx.mk_fn_sig(
505 hir::Unsafety::Unsafe,
506 Abi::PlatformIntrinsic,
508 let sig = ty::Binder::dummy(sig);
509 equate_intrinsic_type(tcx, it, n_tps, 0, sig)