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 hir::def_id::DefId;
11 use rustc_errors::{struct_span_err, DiagnosticMessage};
13 use rustc_middle::traits::{ObligationCause, ObligationCauseCode};
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.owner_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.owner_id)), fty);
64 /// Returns the unsafety of the given intrinsic.
65 pub fn intrinsic_operation_unsafety(tcx: TyCtxt<'_>, intrinsic_id: DefId) -> hir::Unsafety {
66 let has_safe_attr = match tcx.has_attr(intrinsic_id, sym::rustc_safe_intrinsic) {
67 true => hir::Unsafety::Normal,
68 false => hir::Unsafety::Unsafe,
70 let is_in_list = match tcx.item_name(intrinsic_id) {
71 // When adding a new intrinsic to this list,
72 // it's usually worth updating that intrinsic's documentation
73 // to note that it's safe to call, since
74 // safe extern fns are otherwise unprecedented.
76 | sym::assert_inhabited
77 | sym::assert_zero_valid
78 | sym::assert_mem_uninitialized_valid
82 | sym::caller_location
83 | sym::add_with_overflow
84 | sym::sub_with_overflow
85 | sym::mul_with_overflow
98 | sym::discriminant_value
102 | sym::ptr_guaranteed_cmp
112 | sym::ptr_mask => hir::Unsafety::Normal,
113 _ => hir::Unsafety::Unsafe,
116 if has_safe_attr != is_in_list {
117 tcx.sess.struct_span_err(
118 tcx.def_span(intrinsic_id),
119 DiagnosticMessage::Str(format!(
120 "intrinsic safety mismatch between list of intrinsics within the compiler and core library intrinsics for intrinsic `{}`",
121 tcx.item_name(intrinsic_id)
128 /// Remember to add all intrinsics here, in `compiler/rustc_codegen_llvm/src/intrinsic.rs`,
129 /// and in `library/core/src/intrinsics.rs`.
130 pub fn check_intrinsic_type(tcx: TyCtxt<'_>, it: &hir::ForeignItem<'_>) {
131 let param = |n| tcx.mk_ty_param(n, Symbol::intern(&format!("P{}", n)));
132 let intrinsic_id = it.owner_id.to_def_id();
133 let intrinsic_name = tcx.item_name(intrinsic_id);
134 let name_str = intrinsic_name.as_str();
136 let bound_vars = tcx.mk_bound_variable_kinds(
138 ty::BoundVariableKind::Region(ty::BrAnon(0, None)),
139 ty::BoundVariableKind::Region(ty::BrEnv),
144 let mk_va_list_ty = |mutbl| {
145 tcx.lang_items().va_list().map(|did| {
146 let region = tcx.mk_region(ty::ReLateBound(
148 ty::BoundRegion { var: ty::BoundVar::from_u32(0), kind: ty::BrAnon(0, None) },
150 let env_region = tcx.mk_region(ty::ReLateBound(
152 ty::BoundRegion { var: ty::BoundVar::from_u32(1), kind: ty::BrEnv },
154 let va_list_ty = tcx.bound_type_of(did).subst(tcx, &[region.into()]);
155 (tcx.mk_ref(env_region, ty::TypeAndMut { ty: va_list_ty, mutbl }), va_list_ty)
159 let (n_tps, n_lts, inputs, output, unsafety) = if name_str.starts_with("atomic_") {
160 let split: Vec<&str> = name_str.split('_').collect();
161 assert!(split.len() >= 2, "Atomic intrinsic in an incorrect format");
163 //We only care about the operation here
164 let (n_tps, inputs, output) = match split[1] {
165 "cxchg" | "cxchgweak" => (
167 vec![tcx.mk_mut_ptr(param(0)), param(0), param(0)],
168 tcx.intern_tup(&[param(0), tcx.types.bool]),
170 "load" => (1, vec![tcx.mk_imm_ptr(param(0))], param(0)),
171 "store" => (1, vec![tcx.mk_mut_ptr(param(0)), param(0)], tcx.mk_unit()),
173 "xchg" | "xadd" | "xsub" | "and" | "nand" | "or" | "xor" | "max" | "min" | "umax"
174 | "umin" => (1, vec![tcx.mk_mut_ptr(param(0)), param(0)], param(0)),
175 "fence" | "singlethreadfence" => (0, Vec::new(), tcx.mk_unit()),
177 tcx.sess.emit_err(UnrecognizedAtomicOperation { span: it.span, op });
181 (n_tps, 0, inputs, output, hir::Unsafety::Unsafe)
183 let unsafety = intrinsic_operation_unsafety(tcx, intrinsic_id);
184 let (n_tps, inputs, output) = match intrinsic_name {
185 sym::abort => (0, Vec::new(), tcx.types.never),
186 sym::unreachable => (0, Vec::new(), tcx.types.never),
187 sym::breakpoint => (0, Vec::new(), tcx.mk_unit()),
188 sym::size_of | sym::pref_align_of | sym::min_align_of | sym::variant_count => {
189 (1, Vec::new(), tcx.types.usize)
191 sym::size_of_val | sym::min_align_of_val => {
192 (1, vec![tcx.mk_imm_ptr(param(0))], tcx.types.usize)
194 sym::rustc_peek => (1, vec![param(0)], param(0)),
195 sym::caller_location => (0, vec![], tcx.caller_location_ty()),
196 sym::assert_inhabited
197 | sym::assert_zero_valid
198 | sym::assert_mem_uninitialized_valid => (1, Vec::new(), tcx.mk_unit()),
199 sym::forget => (1, vec![param(0)], tcx.mk_unit()),
200 sym::transmute => (2, vec![param(0)], param(1)),
201 sym::prefetch_read_data
202 | sym::prefetch_write_data
203 | sym::prefetch_read_instruction
204 | sym::prefetch_write_instruction => (
207 tcx.mk_ptr(ty::TypeAndMut { ty: param(0), mutbl: hir::Mutability::Not }),
212 sym::drop_in_place => (1, vec![tcx.mk_mut_ptr(param(0))], tcx.mk_unit()),
213 sym::needs_drop => (1, Vec::new(), tcx.types.bool),
215 sym::type_name => (1, Vec::new(), tcx.mk_static_str()),
216 sym::type_id => (1, Vec::new(), tcx.types.u64),
217 sym::offset | sym::arith_offset => (
220 tcx.mk_ptr(ty::TypeAndMut { ty: param(0), mutbl: hir::Mutability::Not }),
223 tcx.mk_ptr(ty::TypeAndMut { ty: param(0), mutbl: hir::Mutability::Not }),
228 tcx.mk_ptr(ty::TypeAndMut { ty: param(0), mutbl: hir::Mutability::Not }),
231 tcx.mk_ptr(ty::TypeAndMut { ty: param(0), mutbl: hir::Mutability::Not }),
234 sym::copy | sym::copy_nonoverlapping => (
237 tcx.mk_ptr(ty::TypeAndMut { ty: param(0), mutbl: hir::Mutability::Not }),
238 tcx.mk_ptr(ty::TypeAndMut { ty: param(0), mutbl: hir::Mutability::Mut }),
243 sym::volatile_copy_memory | sym::volatile_copy_nonoverlapping_memory => (
246 tcx.mk_ptr(ty::TypeAndMut { ty: param(0), mutbl: hir::Mutability::Mut }),
247 tcx.mk_ptr(ty::TypeAndMut { ty: param(0), mutbl: hir::Mutability::Not }),
252 sym::write_bytes | sym::volatile_set_memory => (
255 tcx.mk_ptr(ty::TypeAndMut { ty: param(0), mutbl: hir::Mutability::Mut }),
261 sym::sqrtf32 => (0, vec![tcx.types.f32], tcx.types.f32),
262 sym::sqrtf64 => (0, vec![tcx.types.f64], tcx.types.f64),
263 sym::powif32 => (0, vec![tcx.types.f32, tcx.types.i32], tcx.types.f32),
264 sym::powif64 => (0, vec![tcx.types.f64, tcx.types.i32], tcx.types.f64),
265 sym::sinf32 => (0, vec![tcx.types.f32], tcx.types.f32),
266 sym::sinf64 => (0, vec![tcx.types.f64], tcx.types.f64),
267 sym::cosf32 => (0, vec![tcx.types.f32], tcx.types.f32),
268 sym::cosf64 => (0, vec![tcx.types.f64], tcx.types.f64),
269 sym::powf32 => (0, vec![tcx.types.f32, tcx.types.f32], tcx.types.f32),
270 sym::powf64 => (0, vec![tcx.types.f64, tcx.types.f64], tcx.types.f64),
271 sym::expf32 => (0, vec![tcx.types.f32], tcx.types.f32),
272 sym::expf64 => (0, vec![tcx.types.f64], tcx.types.f64),
273 sym::exp2f32 => (0, vec![tcx.types.f32], tcx.types.f32),
274 sym::exp2f64 => (0, vec![tcx.types.f64], tcx.types.f64),
275 sym::logf32 => (0, vec![tcx.types.f32], tcx.types.f32),
276 sym::logf64 => (0, vec![tcx.types.f64], tcx.types.f64),
277 sym::log10f32 => (0, vec![tcx.types.f32], tcx.types.f32),
278 sym::log10f64 => (0, vec![tcx.types.f64], tcx.types.f64),
279 sym::log2f32 => (0, vec![tcx.types.f32], tcx.types.f32),
280 sym::log2f64 => (0, vec![tcx.types.f64], tcx.types.f64),
281 sym::fmaf32 => (0, vec![tcx.types.f32, tcx.types.f32, tcx.types.f32], tcx.types.f32),
282 sym::fmaf64 => (0, vec![tcx.types.f64, tcx.types.f64, tcx.types.f64], tcx.types.f64),
283 sym::fabsf32 => (0, vec![tcx.types.f32], tcx.types.f32),
284 sym::fabsf64 => (0, vec![tcx.types.f64], tcx.types.f64),
285 sym::minnumf32 => (0, vec![tcx.types.f32, tcx.types.f32], tcx.types.f32),
286 sym::minnumf64 => (0, vec![tcx.types.f64, tcx.types.f64], tcx.types.f64),
287 sym::maxnumf32 => (0, vec![tcx.types.f32, tcx.types.f32], tcx.types.f32),
288 sym::maxnumf64 => (0, vec![tcx.types.f64, tcx.types.f64], tcx.types.f64),
289 sym::copysignf32 => (0, vec![tcx.types.f32, tcx.types.f32], tcx.types.f32),
290 sym::copysignf64 => (0, vec![tcx.types.f64, tcx.types.f64], tcx.types.f64),
291 sym::floorf32 => (0, vec![tcx.types.f32], tcx.types.f32),
292 sym::floorf64 => (0, vec![tcx.types.f64], tcx.types.f64),
293 sym::ceilf32 => (0, vec![tcx.types.f32], tcx.types.f32),
294 sym::ceilf64 => (0, vec![tcx.types.f64], tcx.types.f64),
295 sym::truncf32 => (0, vec![tcx.types.f32], tcx.types.f32),
296 sym::truncf64 => (0, vec![tcx.types.f64], tcx.types.f64),
297 sym::rintf32 => (0, vec![tcx.types.f32], tcx.types.f32),
298 sym::rintf64 => (0, vec![tcx.types.f64], tcx.types.f64),
299 sym::nearbyintf32 => (0, vec![tcx.types.f32], tcx.types.f32),
300 sym::nearbyintf64 => (0, vec![tcx.types.f64], tcx.types.f64),
301 sym::roundf32 => (0, vec![tcx.types.f32], tcx.types.f32),
302 sym::roundf64 => (0, vec![tcx.types.f64], tcx.types.f64),
304 sym::volatile_load | sym::unaligned_volatile_load => {
305 (1, vec![tcx.mk_imm_ptr(param(0))], param(0))
307 sym::volatile_store | sym::unaligned_volatile_store => {
308 (1, vec![tcx.mk_mut_ptr(param(0)), param(0)], tcx.mk_unit())
317 | sym::bitreverse => (1, vec![param(0)], param(0)),
319 sym::add_with_overflow | sym::sub_with_overflow | sym::mul_with_overflow => {
320 (1, vec![param(0), param(0)], tcx.intern_tup(&[param(0), tcx.types.bool]))
323 sym::ptr_guaranteed_cmp => {
324 (1, vec![tcx.mk_imm_ptr(param(0)), tcx.mk_imm_ptr(param(0))], tcx.types.u8)
327 sym::const_allocate => {
328 (0, vec![tcx.types.usize, tcx.types.usize], tcx.mk_mut_ptr(tcx.types.u8))
330 sym::const_deallocate => (
332 vec![tcx.mk_mut_ptr(tcx.types.u8), tcx.types.usize, tcx.types.usize],
336 sym::ptr_offset_from => {
337 (1, vec![tcx.mk_imm_ptr(param(0)), tcx.mk_imm_ptr(param(0))], tcx.types.isize)
339 sym::ptr_offset_from_unsigned => {
340 (1, vec![tcx.mk_imm_ptr(param(0)), tcx.mk_imm_ptr(param(0))], tcx.types.usize)
342 sym::unchecked_div | sym::unchecked_rem | sym::exact_div => {
343 (1, vec![param(0), param(0)], param(0))
345 sym::unchecked_shl | sym::unchecked_shr | sym::rotate_left | sym::rotate_right => {
346 (1, vec![param(0), param(0)], param(0))
348 sym::unchecked_add | sym::unchecked_sub | sym::unchecked_mul => {
349 (1, vec![param(0), param(0)], param(0))
351 sym::wrapping_add | sym::wrapping_sub | sym::wrapping_mul => {
352 (1, vec![param(0), param(0)], param(0))
354 sym::saturating_add | sym::saturating_sub => (1, vec![param(0), param(0)], param(0)),
355 sym::fadd_fast | sym::fsub_fast | sym::fmul_fast | sym::fdiv_fast | sym::frem_fast => {
356 (1, vec![param(0), param(0)], param(0))
358 sym::float_to_int_unchecked => (2, vec![param(0)], param(1)),
360 sym::assume => (0, vec![tcx.types.bool], tcx.mk_unit()),
361 sym::likely => (0, vec![tcx.types.bool], tcx.types.bool),
362 sym::unlikely => (0, vec![tcx.types.bool], tcx.types.bool),
364 sym::discriminant_value => {
365 let assoc_items = tcx.associated_item_def_ids(
366 tcx.require_lang_item(hir::LangItem::DiscriminantKind, None),
368 let discriminant_def_id = assoc_items[0];
371 ty::BoundRegion { var: ty::BoundVar::from_u32(0), kind: ty::BrAnon(0, None) };
375 tcx.mk_imm_ref(tcx.mk_region(ty::ReLateBound(ty::INNERMOST, br)), param(0)),
377 tcx.mk_projection(discriminant_def_id, tcx.mk_substs([param(0).into()].iter())),
382 let mut_u8 = tcx.mk_mut_ptr(tcx.types.u8);
383 let try_fn_ty = ty::Binder::dummy(tcx.mk_fn_sig(
387 hir::Unsafety::Normal,
390 let catch_fn_ty = ty::Binder::dummy(tcx.mk_fn_sig(
391 [mut_u8, mut_u8].iter().cloned(),
394 hir::Unsafety::Normal,
399 vec![tcx.mk_fn_ptr(try_fn_ty), mut_u8, tcx.mk_fn_ptr(catch_fn_ty)],
404 sym::va_start | sym::va_end => match mk_va_list_ty(hir::Mutability::Mut) {
405 Some((va_list_ref_ty, _)) => (0, vec![va_list_ref_ty], tcx.mk_unit()),
406 None => bug!("`va_list` language item needed for C-variadic intrinsics"),
409 sym::va_copy => match mk_va_list_ty(hir::Mutability::Not) {
410 Some((va_list_ref_ty, va_list_ty)) => {
411 let va_list_ptr_ty = tcx.mk_mut_ptr(va_list_ty);
412 (0, vec![va_list_ptr_ty, va_list_ref_ty], tcx.mk_unit())
414 None => bug!("`va_list` language item needed for C-variadic intrinsics"),
417 sym::va_arg => match mk_va_list_ty(hir::Mutability::Mut) {
418 Some((va_list_ref_ty, _)) => (1, vec![va_list_ref_ty], param(0)),
419 None => bug!("`va_list` language item needed for C-variadic intrinsics"),
422 sym::nontemporal_store => (1, vec![tcx.mk_mut_ptr(param(0)), param(0)], tcx.mk_unit()),
426 ty::BoundRegion { var: ty::BoundVar::from_u32(0), kind: ty::BrAnon(0, None) };
428 tcx.mk_imm_ref(tcx.mk_region(ty::ReLateBound(ty::INNERMOST, br)), param(0));
429 (1, vec![param_ty; 2], tcx.types.bool)
432 sym::black_box => (1, vec![param(0)], param(0)),
434 sym::const_eval_select => (4, vec![param(0), param(1), param(2)], param(3)),
436 sym::vtable_size | sym::vtable_align => {
437 (0, vec![tcx.mk_imm_ptr(tcx.mk_unit())], tcx.types.usize)
441 tcx.sess.emit_err(UnrecognizedIntrinsicFunction { span: it.span, name: other });
445 (n_tps, 0, inputs, output, unsafety)
447 let sig = tcx.mk_fn_sig(inputs.into_iter(), output, false, unsafety, Abi::RustIntrinsic);
448 let sig = ty::Binder::bind_with_vars(sig, bound_vars);
449 equate_intrinsic_type(tcx, it, n_tps, n_lts, sig)
452 /// Type-check `extern "platform-intrinsic" { ... }` functions.
453 pub fn check_platform_intrinsic_type(tcx: TyCtxt<'_>, it: &hir::ForeignItem<'_>) {
455 let name = Symbol::intern(&format!("P{}", n));
456 tcx.mk_ty_param(n, name)
459 let name = it.ident.name;
461 let (n_tps, inputs, output) = match name {
462 sym::simd_eq | sym::simd_ne | sym::simd_lt | sym::simd_le | sym::simd_gt | sym::simd_ge => {
463 (2, vec![param(0), param(0)], param(1))
478 | sym::simd_saturating_add
479 | sym::simd_saturating_sub => (1, vec![param(0), param(0)], param(0)),
480 sym::simd_arith_offset => (2, vec![param(0), param(1)], param(0)),
494 | sym::simd_trunc => (1, vec![param(0)], param(0)),
495 sym::simd_fpowi => (1, vec![param(0), tcx.types.i32], param(0)),
496 sym::simd_fma => (1, vec![param(0), param(0), param(0)], param(0)),
497 sym::simd_gather => (3, vec![param(0), param(1), param(2)], param(0)),
498 sym::simd_scatter => (3, vec![param(0), param(1), param(2)], tcx.mk_unit()),
499 sym::simd_insert => (2, vec![param(0), tcx.types.u32, param(1)], param(0)),
500 sym::simd_extract => (2, vec![param(0), tcx.types.u32], param(1)),
504 | sym::simd_expose_addr
505 | sym::simd_from_exposed_addr => (2, vec![param(0)], param(1)),
506 sym::simd_bitmask => (2, vec![param(0)], param(1)),
507 sym::simd_select | sym::simd_select_bitmask => {
508 (2, vec![param(0), param(1), param(1)], param(1))
510 sym::simd_reduce_all | sym::simd_reduce_any => (1, vec![param(0)], tcx.types.bool),
511 sym::simd_reduce_add_ordered | sym::simd_reduce_mul_ordered => {
512 (2, vec![param(0), param(1)], param(1))
514 sym::simd_reduce_add_unordered
515 | sym::simd_reduce_mul_unordered
516 | sym::simd_reduce_and
517 | sym::simd_reduce_or
518 | sym::simd_reduce_xor
519 | sym::simd_reduce_min
520 | sym::simd_reduce_max
521 | sym::simd_reduce_min_nanless
522 | sym::simd_reduce_max_nanless => (2, vec![param(0)], param(1)),
523 sym::simd_shuffle => (3, vec![param(0), param(0), param(1)], param(2)),
524 name if name.as_str().starts_with("simd_shuffle") => {
525 match name.as_str()["simd_shuffle".len()..].parse() {
527 let params = vec![param(0), param(0), tcx.mk_array(tcx.types.u32, n)];
528 (2, params, param(1))
532 format!("unrecognized platform-specific intrinsic function: `{name}`");
533 tcx.sess.struct_span_err(it.span, &msg).emit();
539 let msg = format!("unrecognized platform-specific intrinsic function: `{name}`");
540 tcx.sess.struct_span_err(it.span, &msg).emit();
545 let sig = tcx.mk_fn_sig(
549 hir::Unsafety::Unsafe,
550 Abi::PlatformIntrinsic,
552 let sig = ty::Binder::dummy(sig);
553 equate_intrinsic_type(tcx, it, n_tps, 0, sig)