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::{self, TyCtxt};
14 use rustc_span::symbol::{kw, sym, Symbol};
15 use rustc_target::spec::abi::Abi;
19 fn equate_intrinsic_type<'tcx>(
21 it: &hir::ForeignItem<'_>,
24 sig: ty::PolyFnSig<'tcx>,
26 let (own_counts, span) = match &it.kind {
27 hir::ForeignItemKind::Fn(.., generics) => {
28 let own_counts = tcx.generics_of(it.def_id.to_def_id()).own_counts();
29 (own_counts, generics.span)
32 struct_span_err!(tcx.sess, it.span, E0622, "intrinsic must be a function")
33 .span_label(it.span, "expected a function")
39 let gen_count_ok = |found: usize, expected: usize, descr: &str| -> bool {
40 if found != expected {
41 tcx.sess.emit_err(WrongNumberOfGenericArgumentsToIntrinsic {
53 if gen_count_ok(own_counts.lifetimes, n_lts, "lifetime")
54 && gen_count_ok(own_counts.types, n_tps, "type")
55 && gen_count_ok(own_counts.consts, 0, "const")
57 let fty = tcx.mk_fn_ptr(sig);
58 let cause = ObligationCause::new(it.span, it.hir_id(), ObligationCauseCode::IntrinsicType);
59 require_same_types(tcx, &cause, tcx.mk_fn_ptr(tcx.fn_sig(it.def_id)), fty);
63 /// Returns the unsafety of the given intrinsic.
64 pub fn intrinsic_operation_unsafety(intrinsic: Symbol) -> hir::Unsafety {
66 // When adding a new intrinsic to this list,
67 // it's usually worth updating that intrinsic's documentation
68 // to note that it's safe to call, since
69 // safe extern fns are otherwise unprecedented.
71 | sym::assert_inhabited
72 | sym::assert_zero_valid
73 | sym::assert_uninit_valid
77 | sym::caller_location
78 | sym::add_with_overflow
79 | sym::sub_with_overflow
80 | sym::mul_with_overflow
93 | sym::discriminant_value
97 | sym::ptr_guaranteed_cmp
107 | sym::ptr_mask => hir::Unsafety::Normal,
108 _ => hir::Unsafety::Unsafe,
112 /// Remember to add all intrinsics here, in `compiler/rustc_codegen_llvm/src/intrinsic.rs`,
113 /// and in `library/core/src/intrinsics.rs`.
114 pub fn check_intrinsic_type(tcx: TyCtxt<'_>, it: &hir::ForeignItem<'_>) {
115 let param = |n| tcx.mk_ty_param(n, Symbol::intern(&format!("P{}", n)));
116 let intrinsic_name = tcx.item_name(it.def_id.to_def_id());
117 let name_str = intrinsic_name.as_str();
119 let bound_vars = tcx.mk_bound_variable_kinds(
120 [ty::BoundVariableKind::Region(ty::BrAnon(0)), ty::BoundVariableKind::Region(ty::BrEnv)]
124 let mk_va_list_ty = |mutbl| {
125 tcx.lang_items().va_list().map(|did| {
126 let region = tcx.mk_region(ty::ReLateBound(
128 ty::BoundRegion { var: ty::BoundVar::from_u32(0), kind: ty::BrAnon(0) },
130 let env_region = tcx.mk_region(ty::ReLateBound(
132 ty::BoundRegion { var: ty::BoundVar::from_u32(1), kind: ty::BrEnv },
134 let va_list_ty = tcx.bound_type_of(did).subst(tcx, &[region.into()]);
135 (tcx.mk_ref(env_region, ty::TypeAndMut { ty: va_list_ty, mutbl }), va_list_ty)
139 let (n_tps, n_lts, inputs, output, unsafety) = if name_str.starts_with("atomic_") {
140 let split: Vec<&str> = name_str.split('_').collect();
141 assert!(split.len() >= 2, "Atomic intrinsic in an incorrect format");
143 //We only care about the operation here
144 let (n_tps, inputs, output) = match split[1] {
145 "cxchg" | "cxchgweak" => (
147 vec![tcx.mk_mut_ptr(param(0)), param(0), param(0)],
148 tcx.intern_tup(&[param(0), tcx.types.bool]),
150 "load" => (1, vec![tcx.mk_imm_ptr(param(0))], param(0)),
151 "store" => (1, vec![tcx.mk_mut_ptr(param(0)), param(0)], tcx.mk_unit()),
153 "xchg" | "xadd" | "xsub" | "and" | "nand" | "or" | "xor" | "max" | "min" | "umax"
154 | "umin" => (1, vec![tcx.mk_mut_ptr(param(0)), param(0)], param(0)),
155 "fence" | "singlethreadfence" => (0, Vec::new(), tcx.mk_unit()),
157 tcx.sess.emit_err(UnrecognizedAtomicOperation { span: it.span, op });
161 (n_tps, 0, inputs, output, hir::Unsafety::Unsafe)
163 let unsafety = intrinsic_operation_unsafety(intrinsic_name);
164 let (n_tps, inputs, output) = match intrinsic_name {
165 sym::abort => (0, Vec::new(), tcx.types.never),
166 sym::unreachable => (0, Vec::new(), tcx.types.never),
167 sym::breakpoint => (0, Vec::new(), tcx.mk_unit()),
168 sym::size_of | sym::pref_align_of | sym::min_align_of | sym::variant_count => {
169 (1, Vec::new(), tcx.types.usize)
171 sym::size_of_val | sym::min_align_of_val => {
172 (1, vec![tcx.mk_imm_ptr(param(0))], tcx.types.usize)
174 sym::rustc_peek => (1, vec![param(0)], param(0)),
175 sym::caller_location => (0, vec![], tcx.caller_location_ty()),
176 sym::assert_inhabited | sym::assert_zero_valid | sym::assert_uninit_valid => {
177 (1, Vec::new(), tcx.mk_unit())
179 sym::forget => (1, vec![param(0)], tcx.mk_unit()),
180 sym::transmute => (2, vec![param(0)], param(1)),
181 sym::prefetch_read_data
182 | sym::prefetch_write_data
183 | sym::prefetch_read_instruction
184 | sym::prefetch_write_instruction => (
187 tcx.mk_ptr(ty::TypeAndMut { ty: param(0), mutbl: hir::Mutability::Not }),
192 sym::drop_in_place => (1, vec![tcx.mk_mut_ptr(param(0))], tcx.mk_unit()),
193 sym::needs_drop => (1, Vec::new(), tcx.types.bool),
195 sym::type_name => (1, Vec::new(), tcx.mk_static_str()),
196 sym::type_id => (1, Vec::new(), tcx.types.u64),
197 sym::offset | sym::arith_offset => (
200 tcx.mk_ptr(ty::TypeAndMut { ty: param(0), mutbl: hir::Mutability::Not }),
203 tcx.mk_ptr(ty::TypeAndMut { ty: param(0), mutbl: hir::Mutability::Not }),
208 tcx.mk_ptr(ty::TypeAndMut { ty: param(0), mutbl: hir::Mutability::Not }),
211 tcx.mk_ptr(ty::TypeAndMut { ty: param(0), mutbl: hir::Mutability::Not }),
214 sym::copy | sym::copy_nonoverlapping => (
217 tcx.mk_ptr(ty::TypeAndMut { ty: param(0), mutbl: hir::Mutability::Not }),
218 tcx.mk_ptr(ty::TypeAndMut { ty: param(0), mutbl: hir::Mutability::Mut }),
223 sym::volatile_copy_memory | sym::volatile_copy_nonoverlapping_memory => (
226 tcx.mk_ptr(ty::TypeAndMut { ty: param(0), mutbl: hir::Mutability::Mut }),
227 tcx.mk_ptr(ty::TypeAndMut { ty: param(0), mutbl: hir::Mutability::Not }),
232 sym::write_bytes | sym::volatile_set_memory => (
235 tcx.mk_ptr(ty::TypeAndMut { ty: param(0), mutbl: hir::Mutability::Mut }),
241 sym::sqrtf32 => (0, vec![tcx.types.f32], tcx.types.f32),
242 sym::sqrtf64 => (0, vec![tcx.types.f64], tcx.types.f64),
243 sym::powif32 => (0, vec![tcx.types.f32, tcx.types.i32], tcx.types.f32),
244 sym::powif64 => (0, vec![tcx.types.f64, tcx.types.i32], tcx.types.f64),
245 sym::sinf32 => (0, vec![tcx.types.f32], tcx.types.f32),
246 sym::sinf64 => (0, vec![tcx.types.f64], tcx.types.f64),
247 sym::cosf32 => (0, vec![tcx.types.f32], tcx.types.f32),
248 sym::cosf64 => (0, vec![tcx.types.f64], tcx.types.f64),
249 sym::powf32 => (0, vec![tcx.types.f32, tcx.types.f32], tcx.types.f32),
250 sym::powf64 => (0, vec![tcx.types.f64, tcx.types.f64], tcx.types.f64),
251 sym::expf32 => (0, vec![tcx.types.f32], tcx.types.f32),
252 sym::expf64 => (0, vec![tcx.types.f64], tcx.types.f64),
253 sym::exp2f32 => (0, vec![tcx.types.f32], tcx.types.f32),
254 sym::exp2f64 => (0, vec![tcx.types.f64], tcx.types.f64),
255 sym::logf32 => (0, vec![tcx.types.f32], tcx.types.f32),
256 sym::logf64 => (0, vec![tcx.types.f64], tcx.types.f64),
257 sym::log10f32 => (0, vec![tcx.types.f32], tcx.types.f32),
258 sym::log10f64 => (0, vec![tcx.types.f64], tcx.types.f64),
259 sym::log2f32 => (0, vec![tcx.types.f32], tcx.types.f32),
260 sym::log2f64 => (0, vec![tcx.types.f64], tcx.types.f64),
261 sym::fmaf32 => (0, vec![tcx.types.f32, tcx.types.f32, tcx.types.f32], tcx.types.f32),
262 sym::fmaf64 => (0, vec![tcx.types.f64, tcx.types.f64, tcx.types.f64], tcx.types.f64),
263 sym::fabsf32 => (0, vec![tcx.types.f32], tcx.types.f32),
264 sym::fabsf64 => (0, vec![tcx.types.f64], tcx.types.f64),
265 sym::minnumf32 => (0, vec![tcx.types.f32, tcx.types.f32], tcx.types.f32),
266 sym::minnumf64 => (0, vec![tcx.types.f64, tcx.types.f64], tcx.types.f64),
267 sym::maxnumf32 => (0, vec![tcx.types.f32, tcx.types.f32], tcx.types.f32),
268 sym::maxnumf64 => (0, vec![tcx.types.f64, tcx.types.f64], tcx.types.f64),
269 sym::copysignf32 => (0, vec![tcx.types.f32, tcx.types.f32], tcx.types.f32),
270 sym::copysignf64 => (0, vec![tcx.types.f64, tcx.types.f64], tcx.types.f64),
271 sym::floorf32 => (0, vec![tcx.types.f32], tcx.types.f32),
272 sym::floorf64 => (0, vec![tcx.types.f64], tcx.types.f64),
273 sym::ceilf32 => (0, vec![tcx.types.f32], tcx.types.f32),
274 sym::ceilf64 => (0, vec![tcx.types.f64], tcx.types.f64),
275 sym::truncf32 => (0, vec![tcx.types.f32], tcx.types.f32),
276 sym::truncf64 => (0, vec![tcx.types.f64], tcx.types.f64),
277 sym::rintf32 => (0, vec![tcx.types.f32], tcx.types.f32),
278 sym::rintf64 => (0, vec![tcx.types.f64], tcx.types.f64),
279 sym::nearbyintf32 => (0, vec![tcx.types.f32], tcx.types.f32),
280 sym::nearbyintf64 => (0, vec![tcx.types.f64], tcx.types.f64),
281 sym::roundf32 => (0, vec![tcx.types.f32], tcx.types.f32),
282 sym::roundf64 => (0, vec![tcx.types.f64], tcx.types.f64),
284 sym::volatile_load | sym::unaligned_volatile_load => {
285 (1, vec![tcx.mk_imm_ptr(param(0))], param(0))
287 sym::volatile_store | sym::unaligned_volatile_store => {
288 (1, vec![tcx.mk_mut_ptr(param(0)), param(0)], tcx.mk_unit())
297 | sym::bitreverse => (1, vec![param(0)], param(0)),
299 sym::add_with_overflow | sym::sub_with_overflow | sym::mul_with_overflow => {
300 (1, vec![param(0), param(0)], tcx.intern_tup(&[param(0), tcx.types.bool]))
303 sym::ptr_guaranteed_cmp => {
304 (1, vec![tcx.mk_imm_ptr(param(0)), tcx.mk_imm_ptr(param(0))], tcx.types.u8)
307 sym::const_allocate => {
308 (0, vec![tcx.types.usize, tcx.types.usize], tcx.mk_mut_ptr(tcx.types.u8))
310 sym::const_deallocate => (
312 vec![tcx.mk_mut_ptr(tcx.types.u8), tcx.types.usize, tcx.types.usize],
316 sym::ptr_offset_from => {
317 (1, vec![tcx.mk_imm_ptr(param(0)), tcx.mk_imm_ptr(param(0))], tcx.types.isize)
319 sym::ptr_offset_from_unsigned => {
320 (1, vec![tcx.mk_imm_ptr(param(0)), tcx.mk_imm_ptr(param(0))], tcx.types.usize)
322 sym::unchecked_div | sym::unchecked_rem | sym::exact_div => {
323 (1, vec![param(0), param(0)], param(0))
325 sym::unchecked_shl | sym::unchecked_shr | sym::rotate_left | sym::rotate_right => {
326 (1, vec![param(0), param(0)], param(0))
328 sym::unchecked_add | sym::unchecked_sub | sym::unchecked_mul => {
329 (1, vec![param(0), param(0)], param(0))
331 sym::wrapping_add | sym::wrapping_sub | sym::wrapping_mul => {
332 (1, vec![param(0), param(0)], param(0))
334 sym::saturating_add | sym::saturating_sub => (1, vec![param(0), param(0)], param(0)),
335 sym::fadd_fast | sym::fsub_fast | sym::fmul_fast | sym::fdiv_fast | sym::frem_fast => {
336 (1, vec![param(0), param(0)], param(0))
338 sym::float_to_int_unchecked => (2, vec![param(0)], param(1)),
340 sym::assume => (0, vec![tcx.types.bool], tcx.mk_unit()),
341 sym::likely => (0, vec![tcx.types.bool], tcx.types.bool),
342 sym::unlikely => (0, vec![tcx.types.bool], tcx.types.bool),
344 sym::discriminant_value => {
345 let assoc_items = tcx.associated_item_def_ids(
346 tcx.require_lang_item(hir::LangItem::DiscriminantKind, None),
348 let discriminant_def_id = assoc_items[0];
350 let br = ty::BoundRegion { var: ty::BoundVar::from_u32(0), kind: ty::BrAnon(0) };
354 tcx.mk_imm_ref(tcx.mk_region(ty::ReLateBound(ty::INNERMOST, br)), param(0)),
356 tcx.mk_projection(discriminant_def_id, tcx.mk_substs([param(0).into()].iter())),
361 let mut_u8 = tcx.mk_mut_ptr(tcx.types.u8);
362 let try_fn_ty = ty::Binder::dummy(tcx.mk_fn_sig(
366 hir::Unsafety::Normal,
369 let catch_fn_ty = ty::Binder::dummy(tcx.mk_fn_sig(
370 [mut_u8, mut_u8].iter().cloned(),
373 hir::Unsafety::Normal,
378 vec![tcx.mk_fn_ptr(try_fn_ty), mut_u8, tcx.mk_fn_ptr(catch_fn_ty)],
383 sym::va_start | sym::va_end => match mk_va_list_ty(hir::Mutability::Mut) {
384 Some((va_list_ref_ty, _)) => (0, vec![va_list_ref_ty], tcx.mk_unit()),
385 None => bug!("`va_list` language item needed for C-variadic intrinsics"),
388 sym::va_copy => match mk_va_list_ty(hir::Mutability::Not) {
389 Some((va_list_ref_ty, va_list_ty)) => {
390 let va_list_ptr_ty = tcx.mk_mut_ptr(va_list_ty);
391 (0, vec![va_list_ptr_ty, va_list_ref_ty], tcx.mk_unit())
393 None => bug!("`va_list` language item needed for C-variadic intrinsics"),
396 sym::va_arg => match mk_va_list_ty(hir::Mutability::Mut) {
397 Some((va_list_ref_ty, _)) => (1, vec![va_list_ref_ty], param(0)),
398 None => bug!("`va_list` language item needed for C-variadic intrinsics"),
401 sym::nontemporal_store => (1, vec![tcx.mk_mut_ptr(param(0)), param(0)], tcx.mk_unit()),
404 let br = ty::BoundRegion { var: ty::BoundVar::from_u32(0), kind: ty::BrAnon(0) };
406 tcx.mk_imm_ref(tcx.mk_region(ty::ReLateBound(ty::INNERMOST, br)), param(0));
407 (1, vec![param_ty; 2], tcx.types.bool)
410 sym::black_box => (1, vec![param(0)], param(0)),
412 sym::const_eval_select => (4, vec![param(0), param(1), param(2)], param(3)),
414 sym::vtable_size | sym::vtable_align => {
415 (0, vec![tcx.mk_imm_ptr(tcx.mk_unit())], tcx.types.usize)
419 tcx.sess.emit_err(UnrecognizedIntrinsicFunction { span: it.span, name: other });
423 (n_tps, 0, inputs, output, unsafety)
425 let sig = tcx.mk_fn_sig(inputs.into_iter(), output, false, unsafety, Abi::RustIntrinsic);
426 let sig = ty::Binder::bind_with_vars(sig, bound_vars);
427 equate_intrinsic_type(tcx, it, n_tps, n_lts, sig)
430 /// Type-check `extern "platform-intrinsic" { ... }` functions.
431 pub fn check_platform_intrinsic_type(tcx: TyCtxt<'_>, it: &hir::ForeignItem<'_>) {
433 let name = Symbol::intern(&format!("P{}", n));
434 tcx.mk_ty_param(n, name)
437 let name = it.ident.name;
439 let (n_tps, inputs, output) = match name {
440 sym::simd_eq | sym::simd_ne | sym::simd_lt | sym::simd_le | sym::simd_gt | sym::simd_ge => {
441 (2, vec![param(0), param(0)], param(1))
456 | sym::simd_saturating_add
457 | sym::simd_saturating_sub => (1, vec![param(0), param(0)], param(0)),
458 sym::simd_arith_offset => (2, vec![param(0), param(1)], param(0)),
472 | sym::simd_trunc => (1, vec![param(0)], param(0)),
473 sym::simd_fpowi => (1, vec![param(0), tcx.types.i32], param(0)),
474 sym::simd_fma => (1, vec![param(0), param(0), param(0)], param(0)),
475 sym::simd_gather => (3, vec![param(0), param(1), param(2)], param(0)),
476 sym::simd_scatter => (3, vec![param(0), param(1), param(2)], tcx.mk_unit()),
477 sym::simd_insert => (2, vec![param(0), tcx.types.u32, param(1)], param(0)),
478 sym::simd_extract => (2, vec![param(0), tcx.types.u32], param(1)),
482 | sym::simd_expose_addr
483 | sym::simd_from_exposed_addr => (2, vec![param(0)], param(1)),
484 sym::simd_bitmask => (2, vec![param(0)], param(1)),
485 sym::simd_select | sym::simd_select_bitmask => {
486 (2, vec![param(0), param(1), param(1)], param(1))
488 sym::simd_reduce_all | sym::simd_reduce_any => (1, vec![param(0)], tcx.types.bool),
489 sym::simd_reduce_add_ordered | sym::simd_reduce_mul_ordered => {
490 (2, vec![param(0), param(1)], param(1))
492 sym::simd_reduce_add_unordered
493 | sym::simd_reduce_mul_unordered
494 | sym::simd_reduce_and
495 | sym::simd_reduce_or
496 | sym::simd_reduce_xor
497 | sym::simd_reduce_min
498 | sym::simd_reduce_max
499 | sym::simd_reduce_min_nanless
500 | sym::simd_reduce_max_nanless => (2, vec![param(0)], param(1)),
501 sym::simd_shuffle => (3, vec![param(0), param(0), param(1)], param(2)),
502 name if name.as_str().starts_with("simd_shuffle") => {
503 match name.as_str()["simd_shuffle".len()..].parse() {
505 let params = vec![param(0), param(0), tcx.mk_array(tcx.types.u32, n)];
506 (2, params, param(1))
510 format!("unrecognized platform-specific intrinsic function: `{name}`");
511 tcx.sess.struct_span_err(it.span, &msg).emit();
517 let msg = format!("unrecognized platform-specific intrinsic function: `{name}`");
518 tcx.sess.struct_span_err(it.span, &msg).emit();
523 let sig = tcx.mk_fn_sig(
527 hir::Unsafety::Unsafe,
528 Abi::PlatformIntrinsic,
530 let sig = ty::Binder::dummy(sig);
531 equate_intrinsic_type(tcx, it, n_tps, 0, sig)