rustc_hir_analysis/check/
intrinsic.rs

1//! Type-checking for the `#[rustc_intrinsic]` intrinsics that the compiler exposes.
2
3use rustc_abi::ExternAbi;
4use rustc_errors::DiagMessage;
5use rustc_hir::{self as hir, LangItem};
6use rustc_middle::traits::{ObligationCause, ObligationCauseCode};
7use rustc_middle::ty::{self, Ty, TyCtxt};
8use rustc_span::def_id::LocalDefId;
9use rustc_span::{Span, Symbol, sym};
10
11use crate::check::check_function_signature;
12use crate::errors::{UnrecognizedIntrinsicFunction, WrongNumberOfGenericArgumentsToIntrinsic};
13
14fn equate_intrinsic_type<'tcx>(
15    tcx: TyCtxt<'tcx>,
16    span: Span,
17    def_id: LocalDefId,
18    n_tps: usize,
19    n_lts: usize,
20    n_cts: usize,
21    sig: ty::PolyFnSig<'tcx>,
22) {
23    let (generics, span) = match tcx.hir_node_by_def_id(def_id) {
24        hir::Node::Item(hir::Item { kind: hir::ItemKind::Fn { generics, .. }, .. }) => {
25            (tcx.generics_of(def_id), generics.span)
26        }
27        _ => tcx.dcx().span_bug(span, "intrinsic must be a function"),
28    };
29    let own_counts = generics.own_counts();
30
31    let gen_count_ok = |found: usize, expected: usize, descr: &str| -> bool {
32        if found != expected {
33            tcx.dcx().emit_err(WrongNumberOfGenericArgumentsToIntrinsic {
34                span,
35                found,
36                expected,
37                descr,
38            });
39            false
40        } else {
41            true
42        }
43    };
44
45    // the host effect param should be invisible as it shouldn't matter
46    // whether effects is enabled for the intrinsic provider crate.
47    if gen_count_ok(own_counts.lifetimes, n_lts, "lifetime")
48        && gen_count_ok(own_counts.types, n_tps, "type")
49        && gen_count_ok(own_counts.consts, n_cts, "const")
50    {
51        let _ = check_function_signature(
52            tcx,
53            ObligationCause::new(span, def_id, ObligationCauseCode::IntrinsicType),
54            def_id.into(),
55            sig,
56        );
57    }
58}
59
60/// Returns the unsafety of the given intrinsic.
61fn intrinsic_operation_unsafety(tcx: TyCtxt<'_>, intrinsic_id: LocalDefId) -> hir::Safety {
62    let is_in_list = match tcx.item_name(intrinsic_id) {
63        // When adding a new intrinsic to this list,
64        // it's usually worth updating that intrinsic's documentation
65        // to note that it's safe to call, since
66        // safe extern fns are otherwise unprecedented.
67
68        // tidy-alphabetical-start
69        | sym::abort
70        | sym::add_with_overflow
71        | sym::aggregate_raw_ptr
72        | sym::align_of
73        | sym::assert_inhabited
74        | sym::assert_mem_uninitialized_valid
75        | sym::assert_zero_valid
76        | sym::autodiff
77        | sym::bitreverse
78        | sym::black_box
79        | sym::box_new
80        | sym::breakpoint
81        | sym::bswap
82        | sym::caller_location
83        | sym::carrying_mul_add
84        | sym::ceilf16
85        | sym::ceilf32
86        | sym::ceilf64
87        | sym::ceilf128
88        | sym::cold_path
89        | sym::const_eval_select
90        | sym::contract_check_ensures
91        | sym::contract_check_requires
92        | sym::contract_checks
93        | sym::copysignf16
94        | sym::copysignf32
95        | sym::copysignf64
96        | sym::copysignf128
97        | sym::cosf16
98        | sym::cosf32
99        | sym::cosf64
100        | sym::cosf128
101        | sym::ctlz
102        | sym::ctpop
103        | sym::cttz
104        | sym::discriminant_value
105        | sym::exp2f16
106        | sym::exp2f32
107        | sym::exp2f64
108        | sym::exp2f128
109        | sym::expf16
110        | sym::expf32
111        | sym::expf64
112        | sym::expf128
113        | sym::fabsf16
114        | sym::fabsf32
115        | sym::fabsf64
116        | sym::fabsf128
117        | sym::fadd_algebraic
118        | sym::fdiv_algebraic
119        | sym::floorf16
120        | sym::floorf32
121        | sym::floorf64
122        | sym::floorf128
123        | sym::fmaf16
124        | sym::fmaf32
125        | sym::fmaf64
126        | sym::fmaf128
127        | sym::fmul_algebraic
128        | sym::fmuladdf16
129        | sym::fmuladdf32
130        | sym::fmuladdf64
131        | sym::fmuladdf128
132        | sym::forget
133        | sym::frem_algebraic
134        | sym::fsub_algebraic
135        | sym::is_val_statically_known
136        | sym::log2f16
137        | sym::log2f32
138        | sym::log2f64
139        | sym::log2f128
140        | sym::log10f16
141        | sym::log10f32
142        | sym::log10f64
143        | sym::log10f128
144        | sym::logf16
145        | sym::logf32
146        | sym::logf64
147        | sym::logf128
148        | sym::maximumf16
149        | sym::maximumf32
150        | sym::maximumf64
151        | sym::maximumf128
152        | sym::maxnumf16
153        | sym::maxnumf32
154        | sym::maxnumf64
155        | sym::maxnumf128
156        | sym::minimumf16
157        | sym::minimumf32
158        | sym::minimumf64
159        | sym::minimumf128
160        | sym::minnumf16
161        | sym::minnumf32
162        | sym::minnumf64
163        | sym::minnumf128
164        | sym::mul_with_overflow
165        | sym::needs_drop
166        | sym::offload
167        | sym::offset_of
168        | sym::overflow_checks
169        | sym::powf16
170        | sym::powf32
171        | sym::powf64
172        | sym::powf128
173        | sym::powif16
174        | sym::powif32
175        | sym::powif64
176        | sym::powif128
177        | sym::prefetch_read_data
178        | sym::prefetch_read_instruction
179        | sym::prefetch_write_data
180        | sym::prefetch_write_instruction
181        | sym::ptr_guaranteed_cmp
182        | sym::ptr_mask
183        | sym::ptr_metadata
184        | sym::rotate_left
185        | sym::rotate_right
186        | sym::round_ties_even_f16
187        | sym::round_ties_even_f32
188        | sym::round_ties_even_f64
189        | sym::round_ties_even_f128
190        | sym::roundf16
191        | sym::roundf32
192        | sym::roundf64
193        | sym::roundf128
194        | sym::rustc_peek
195        | sym::saturating_add
196        | sym::saturating_sub
197        | sym::select_unpredictable
198        | sym::sinf16
199        | sym::sinf32
200        | sym::sinf64
201        | sym::sinf128
202        | sym::size_of
203        | sym::sqrtf16
204        | sym::sqrtf32
205        | sym::sqrtf64
206        | sym::sqrtf128
207        | sym::sub_with_overflow
208        | sym::three_way_compare
209        | sym::truncf16
210        | sym::truncf32
211        | sym::truncf64
212        | sym::truncf128
213        | sym::type_id
214        | sym::type_id_eq
215        | sym::type_name
216        | sym::ub_checks
217        | sym::variant_count
218        | sym::vtable_for
219        | sym::wrapping_add
220        | sym::wrapping_mul
221        | sym::wrapping_sub
222        // tidy-alphabetical-end
223        => hir::Safety::Safe,
224        _ => hir::Safety::Unsafe,
225    };
226
227    if tcx.fn_sig(intrinsic_id).skip_binder().safety() != is_in_list {
228        tcx.dcx().struct_span_err(
229            tcx.def_span(intrinsic_id),
230            DiagMessage::from(format!(
231                "intrinsic safety mismatch between list of intrinsics within the compiler and core library intrinsics for intrinsic `{}`",
232                tcx.item_name(intrinsic_id)
233            )
234        )).emit();
235    }
236
237    is_in_list
238}
239
240/// Remember to add all intrinsics here, in `compiler/rustc_codegen_llvm/src/intrinsic.rs`,
241/// and in `library/core/src/intrinsics.rs`.
242pub(crate) fn check_intrinsic_type(
243    tcx: TyCtxt<'_>,
244    intrinsic_id: LocalDefId,
245    span: Span,
246    intrinsic_name: Symbol,
247) {
248    let generics = tcx.generics_of(intrinsic_id);
249    let param = |n| {
250        if let &ty::GenericParamDef { name, kind: ty::GenericParamDefKind::Type { .. }, .. } =
251            generics.param_at(n as usize, tcx)
252        {
253            Ty::new_param(tcx, n, name)
254        } else {
255            Ty::new_error_with_message(tcx, span, "expected param")
256        }
257    };
258
259    let bound_vars = tcx.mk_bound_variable_kinds(&[
260        ty::BoundVariableKind::Region(ty::BoundRegionKind::Anon),
261        ty::BoundVariableKind::Region(ty::BoundRegionKind::Anon),
262        ty::BoundVariableKind::Region(ty::BoundRegionKind::ClosureEnv),
263    ]);
264    let mk_va_list_ty = |mutbl| {
265        let did = tcx.require_lang_item(LangItem::VaList, span);
266        let region = ty::Region::new_bound(
267            tcx,
268            ty::INNERMOST,
269            ty::BoundRegion { var: ty::BoundVar::ZERO, kind: ty::BoundRegionKind::Anon },
270        );
271        let env_region = ty::Region::new_bound(
272            tcx,
273            ty::INNERMOST,
274            ty::BoundRegion {
275                var: ty::BoundVar::from_u32(2),
276                kind: ty::BoundRegionKind::ClosureEnv,
277            },
278        );
279        let va_list_ty = tcx.type_of(did).instantiate(tcx, &[region.into()]);
280        (Ty::new_ref(tcx, env_region, va_list_ty, mutbl), va_list_ty)
281    };
282
283    let safety = intrinsic_operation_unsafety(tcx, intrinsic_id);
284    let n_lts = 0;
285    let (n_tps, n_cts, inputs, output) = match intrinsic_name {
286        sym::autodiff => (4, 0, vec![param(0), param(1), param(2)], param(3)),
287        sym::abort => (0, 0, vec![], tcx.types.never),
288        sym::unreachable => (0, 0, vec![], tcx.types.never),
289        sym::breakpoint => (0, 0, vec![], tcx.types.unit),
290        sym::size_of | sym::align_of | sym::variant_count => (1, 0, vec![], tcx.types.usize),
291        sym::size_of_val | sym::align_of_val => {
292            (1, 0, vec![Ty::new_imm_ptr(tcx, param(0))], tcx.types.usize)
293        }
294        sym::offset_of => (1, 0, vec![tcx.types.u32, tcx.types.u32], tcx.types.usize),
295        sym::rustc_peek => (1, 0, vec![param(0)], param(0)),
296        sym::caller_location => (0, 0, vec![], tcx.caller_location_ty()),
297        sym::assert_inhabited | sym::assert_zero_valid | sym::assert_mem_uninitialized_valid => {
298            (1, 0, vec![], tcx.types.unit)
299        }
300        sym::forget => (1, 0, vec![param(0)], tcx.types.unit),
301        sym::transmute | sym::transmute_unchecked => (2, 0, vec![param(0)], param(1)),
302        sym::prefetch_read_data
303        | sym::prefetch_write_data
304        | sym::prefetch_read_instruction
305        | sym::prefetch_write_instruction => {
306            (1, 1, vec![Ty::new_imm_ptr(tcx, param(0))], tcx.types.unit)
307        }
308        sym::needs_drop => (1, 0, vec![], tcx.types.bool),
309
310        sym::type_name => (1, 0, vec![], Ty::new_static_str(tcx)),
311        sym::type_id => {
312            (1, 0, vec![], tcx.type_of(tcx.lang_items().type_id().unwrap()).instantiate_identity())
313        }
314        sym::type_id_eq => {
315            let type_id = tcx.type_of(tcx.lang_items().type_id().unwrap()).instantiate_identity();
316            (0, 0, vec![type_id, type_id], tcx.types.bool)
317        }
318        sym::offload => (3, 0, vec![param(0), param(1)], param(2)),
319        sym::offset => (2, 0, vec![param(0), param(1)], param(0)),
320        sym::arith_offset => (
321            1,
322            0,
323            vec![Ty::new_imm_ptr(tcx, param(0)), tcx.types.isize],
324            Ty::new_imm_ptr(tcx, param(0)),
325        ),
326        sym::slice_get_unchecked => (3, 0, vec![param(1), tcx.types.usize], param(0)),
327        sym::ptr_mask => (
328            1,
329            0,
330            vec![Ty::new_imm_ptr(tcx, param(0)), tcx.types.usize],
331            Ty::new_imm_ptr(tcx, param(0)),
332        ),
333
334        sym::copy | sym::copy_nonoverlapping => (
335            1,
336            0,
337            vec![Ty::new_imm_ptr(tcx, param(0)), Ty::new_mut_ptr(tcx, param(0)), tcx.types.usize],
338            tcx.types.unit,
339        ),
340        sym::volatile_copy_memory | sym::volatile_copy_nonoverlapping_memory => (
341            1,
342            0,
343            vec![Ty::new_mut_ptr(tcx, param(0)), Ty::new_imm_ptr(tcx, param(0)), tcx.types.usize],
344            tcx.types.unit,
345        ),
346        sym::compare_bytes => {
347            let byte_ptr = Ty::new_imm_ptr(tcx, tcx.types.u8);
348            (0, 0, vec![byte_ptr, byte_ptr, tcx.types.usize], tcx.types.i32)
349        }
350        sym::write_bytes | sym::volatile_set_memory => (
351            1,
352            0,
353            vec![Ty::new_mut_ptr(tcx, param(0)), tcx.types.u8, tcx.types.usize],
354            tcx.types.unit,
355        ),
356
357        sym::sqrtf16 => (0, 0, vec![tcx.types.f16], tcx.types.f16),
358        sym::sqrtf32 => (0, 0, vec![tcx.types.f32], tcx.types.f32),
359        sym::sqrtf64 => (0, 0, vec![tcx.types.f64], tcx.types.f64),
360        sym::sqrtf128 => (0, 0, vec![tcx.types.f128], tcx.types.f128),
361
362        sym::powif16 => (0, 0, vec![tcx.types.f16, tcx.types.i32], tcx.types.f16),
363        sym::powif32 => (0, 0, vec![tcx.types.f32, tcx.types.i32], tcx.types.f32),
364        sym::powif64 => (0, 0, vec![tcx.types.f64, tcx.types.i32], tcx.types.f64),
365        sym::powif128 => (0, 0, vec![tcx.types.f128, tcx.types.i32], tcx.types.f128),
366
367        sym::sinf16 => (0, 0, vec![tcx.types.f16], tcx.types.f16),
368        sym::sinf32 => (0, 0, vec![tcx.types.f32], tcx.types.f32),
369        sym::sinf64 => (0, 0, vec![tcx.types.f64], tcx.types.f64),
370        sym::sinf128 => (0, 0, vec![tcx.types.f128], tcx.types.f128),
371
372        sym::cosf16 => (0, 0, vec![tcx.types.f16], tcx.types.f16),
373        sym::cosf32 => (0, 0, vec![tcx.types.f32], tcx.types.f32),
374        sym::cosf64 => (0, 0, vec![tcx.types.f64], tcx.types.f64),
375        sym::cosf128 => (0, 0, vec![tcx.types.f128], tcx.types.f128),
376
377        sym::powf16 => (0, 0, vec![tcx.types.f16, tcx.types.f16], tcx.types.f16),
378        sym::powf32 => (0, 0, vec![tcx.types.f32, tcx.types.f32], tcx.types.f32),
379        sym::powf64 => (0, 0, vec![tcx.types.f64, tcx.types.f64], tcx.types.f64),
380        sym::powf128 => (0, 0, vec![tcx.types.f128, tcx.types.f128], tcx.types.f128),
381
382        sym::expf16 => (0, 0, vec![tcx.types.f16], tcx.types.f16),
383        sym::expf32 => (0, 0, vec![tcx.types.f32], tcx.types.f32),
384        sym::expf64 => (0, 0, vec![tcx.types.f64], tcx.types.f64),
385        sym::expf128 => (0, 0, vec![tcx.types.f128], tcx.types.f128),
386
387        sym::exp2f16 => (0, 0, vec![tcx.types.f16], tcx.types.f16),
388        sym::exp2f32 => (0, 0, vec![tcx.types.f32], tcx.types.f32),
389        sym::exp2f64 => (0, 0, vec![tcx.types.f64], tcx.types.f64),
390        sym::exp2f128 => (0, 0, vec![tcx.types.f128], tcx.types.f128),
391
392        sym::logf16 => (0, 0, vec![tcx.types.f16], tcx.types.f16),
393        sym::logf32 => (0, 0, vec![tcx.types.f32], tcx.types.f32),
394        sym::logf64 => (0, 0, vec![tcx.types.f64], tcx.types.f64),
395        sym::logf128 => (0, 0, vec![tcx.types.f128], tcx.types.f128),
396
397        sym::log10f16 => (0, 0, vec![tcx.types.f16], tcx.types.f16),
398        sym::log10f32 => (0, 0, vec![tcx.types.f32], tcx.types.f32),
399        sym::log10f64 => (0, 0, vec![tcx.types.f64], tcx.types.f64),
400        sym::log10f128 => (0, 0, vec![tcx.types.f128], tcx.types.f128),
401
402        sym::log2f16 => (0, 0, vec![tcx.types.f16], tcx.types.f16),
403        sym::log2f32 => (0, 0, vec![tcx.types.f32], tcx.types.f32),
404        sym::log2f64 => (0, 0, vec![tcx.types.f64], tcx.types.f64),
405        sym::log2f128 => (0, 0, vec![tcx.types.f128], tcx.types.f128),
406
407        sym::fmaf16 => (0, 0, vec![tcx.types.f16, tcx.types.f16, tcx.types.f16], tcx.types.f16),
408        sym::fmaf32 => (0, 0, vec![tcx.types.f32, tcx.types.f32, tcx.types.f32], tcx.types.f32),
409        sym::fmaf64 => (0, 0, vec![tcx.types.f64, tcx.types.f64, tcx.types.f64], tcx.types.f64),
410        sym::fmaf128 => {
411            (0, 0, vec![tcx.types.f128, tcx.types.f128, tcx.types.f128], tcx.types.f128)
412        }
413
414        sym::fmuladdf16 => (0, 0, vec![tcx.types.f16, tcx.types.f16, tcx.types.f16], tcx.types.f16),
415        sym::fmuladdf32 => (0, 0, vec![tcx.types.f32, tcx.types.f32, tcx.types.f32], tcx.types.f32),
416        sym::fmuladdf64 => (0, 0, vec![tcx.types.f64, tcx.types.f64, tcx.types.f64], tcx.types.f64),
417        sym::fmuladdf128 => {
418            (0, 0, vec![tcx.types.f128, tcx.types.f128, tcx.types.f128], tcx.types.f128)
419        }
420
421        sym::fabsf16 => (0, 0, vec![tcx.types.f16], tcx.types.f16),
422        sym::fabsf32 => (0, 0, vec![tcx.types.f32], tcx.types.f32),
423        sym::fabsf64 => (0, 0, vec![tcx.types.f64], tcx.types.f64),
424        sym::fabsf128 => (0, 0, vec![tcx.types.f128], tcx.types.f128),
425
426        sym::minnumf16 => (0, 0, vec![tcx.types.f16, tcx.types.f16], tcx.types.f16),
427        sym::minnumf32 => (0, 0, vec![tcx.types.f32, tcx.types.f32], tcx.types.f32),
428        sym::minnumf64 => (0, 0, vec![tcx.types.f64, tcx.types.f64], tcx.types.f64),
429        sym::minnumf128 => (0, 0, vec![tcx.types.f128, tcx.types.f128], tcx.types.f128),
430
431        sym::minimumf16 => (0, 0, vec![tcx.types.f16, tcx.types.f16], tcx.types.f16),
432        sym::minimumf32 => (0, 0, vec![tcx.types.f32, tcx.types.f32], tcx.types.f32),
433        sym::minimumf64 => (0, 0, vec![tcx.types.f64, tcx.types.f64], tcx.types.f64),
434        sym::minimumf128 => (0, 0, vec![tcx.types.f128, tcx.types.f128], tcx.types.f128),
435
436        sym::maxnumf16 => (0, 0, vec![tcx.types.f16, tcx.types.f16], tcx.types.f16),
437        sym::maxnumf32 => (0, 0, vec![tcx.types.f32, tcx.types.f32], tcx.types.f32),
438        sym::maxnumf64 => (0, 0, vec![tcx.types.f64, tcx.types.f64], tcx.types.f64),
439        sym::maxnumf128 => (0, 0, vec![tcx.types.f128, tcx.types.f128], tcx.types.f128),
440
441        sym::maximumf16 => (0, 0, vec![tcx.types.f16, tcx.types.f16], tcx.types.f16),
442        sym::maximumf32 => (0, 0, vec![tcx.types.f32, tcx.types.f32], tcx.types.f32),
443        sym::maximumf64 => (0, 0, vec![tcx.types.f64, tcx.types.f64], tcx.types.f64),
444        sym::maximumf128 => (0, 0, vec![tcx.types.f128, tcx.types.f128], tcx.types.f128),
445
446        sym::copysignf16 => (0, 0, vec![tcx.types.f16, tcx.types.f16], tcx.types.f16),
447        sym::copysignf32 => (0, 0, vec![tcx.types.f32, tcx.types.f32], tcx.types.f32),
448        sym::copysignf64 => (0, 0, vec![tcx.types.f64, tcx.types.f64], tcx.types.f64),
449        sym::copysignf128 => (0, 0, vec![tcx.types.f128, tcx.types.f128], tcx.types.f128),
450
451        sym::floorf16 => (0, 0, vec![tcx.types.f16], tcx.types.f16),
452        sym::floorf32 => (0, 0, vec![tcx.types.f32], tcx.types.f32),
453        sym::floorf64 => (0, 0, vec![tcx.types.f64], tcx.types.f64),
454        sym::floorf128 => (0, 0, vec![tcx.types.f128], tcx.types.f128),
455
456        sym::ceilf16 => (0, 0, vec![tcx.types.f16], tcx.types.f16),
457        sym::ceilf32 => (0, 0, vec![tcx.types.f32], tcx.types.f32),
458        sym::ceilf64 => (0, 0, vec![tcx.types.f64], tcx.types.f64),
459        sym::ceilf128 => (0, 0, vec![tcx.types.f128], tcx.types.f128),
460
461        sym::truncf16 => (0, 0, vec![tcx.types.f16], tcx.types.f16),
462        sym::truncf32 => (0, 0, vec![tcx.types.f32], tcx.types.f32),
463        sym::truncf64 => (0, 0, vec![tcx.types.f64], tcx.types.f64),
464        sym::truncf128 => (0, 0, vec![tcx.types.f128], tcx.types.f128),
465
466        sym::round_ties_even_f16 => (0, 0, vec![tcx.types.f16], tcx.types.f16),
467        sym::round_ties_even_f32 => (0, 0, vec![tcx.types.f32], tcx.types.f32),
468        sym::round_ties_even_f64 => (0, 0, vec![tcx.types.f64], tcx.types.f64),
469        sym::round_ties_even_f128 => (0, 0, vec![tcx.types.f128], tcx.types.f128),
470
471        sym::roundf16 => (0, 0, vec![tcx.types.f16], tcx.types.f16),
472        sym::roundf32 => (0, 0, vec![tcx.types.f32], tcx.types.f32),
473        sym::roundf64 => (0, 0, vec![tcx.types.f64], tcx.types.f64),
474        sym::roundf128 => (0, 0, vec![tcx.types.f128], tcx.types.f128),
475
476        sym::volatile_load | sym::unaligned_volatile_load => {
477            (1, 0, vec![Ty::new_imm_ptr(tcx, param(0))], param(0))
478        }
479        sym::volatile_store | sym::unaligned_volatile_store => {
480            (1, 0, vec![Ty::new_mut_ptr(tcx, param(0)), param(0)], tcx.types.unit)
481        }
482
483        sym::ctpop | sym::ctlz | sym::ctlz_nonzero | sym::cttz | sym::cttz_nonzero => {
484            (1, 0, vec![param(0)], tcx.types.u32)
485        }
486
487        sym::bswap | sym::bitreverse => (1, 0, vec![param(0)], param(0)),
488
489        sym::three_way_compare => (1, 0, vec![param(0), param(0)], tcx.ty_ordering_enum(span)),
490
491        sym::add_with_overflow | sym::sub_with_overflow | sym::mul_with_overflow => {
492            (1, 0, vec![param(0), param(0)], Ty::new_tup(tcx, &[param(0), tcx.types.bool]))
493        }
494
495        sym::carrying_mul_add => (2, 0, vec![param(0); 4], Ty::new_tup(tcx, &[param(1), param(0)])),
496
497        sym::ptr_guaranteed_cmp => (
498            1,
499            0,
500            vec![Ty::new_imm_ptr(tcx, param(0)), Ty::new_imm_ptr(tcx, param(0))],
501            tcx.types.u8,
502        ),
503
504        sym::const_allocate => {
505            (0, 0, vec![tcx.types.usize, tcx.types.usize], Ty::new_mut_ptr(tcx, tcx.types.u8))
506        }
507        sym::const_deallocate => (
508            0,
509            0,
510            vec![Ty::new_mut_ptr(tcx, tcx.types.u8), tcx.types.usize, tcx.types.usize],
511            tcx.types.unit,
512        ),
513        sym::const_make_global => {
514            (0, 0, vec![Ty::new_mut_ptr(tcx, tcx.types.u8)], Ty::new_imm_ptr(tcx, tcx.types.u8))
515        }
516
517        sym::ptr_offset_from => (
518            1,
519            0,
520            vec![Ty::new_imm_ptr(tcx, param(0)), Ty::new_imm_ptr(tcx, param(0))],
521            tcx.types.isize,
522        ),
523        sym::ptr_offset_from_unsigned => (
524            1,
525            0,
526            vec![Ty::new_imm_ptr(tcx, param(0)), Ty::new_imm_ptr(tcx, param(0))],
527            tcx.types.usize,
528        ),
529        sym::unchecked_div | sym::unchecked_rem | sym::exact_div | sym::disjoint_bitor => {
530            (1, 0, vec![param(0), param(0)], param(0))
531        }
532        sym::unchecked_shl | sym::unchecked_shr => (2, 0, vec![param(0), param(1)], param(0)),
533        sym::rotate_left | sym::rotate_right => (1, 0, vec![param(0), tcx.types.u32], param(0)),
534        sym::unchecked_funnel_shl | sym::unchecked_funnel_shr => {
535            (1, 0, vec![param(0), param(0), tcx.types.u32], param(0))
536        }
537        sym::unchecked_add | sym::unchecked_sub | sym::unchecked_mul => {
538            (1, 0, vec![param(0), param(0)], param(0))
539        }
540        sym::wrapping_add | sym::wrapping_sub | sym::wrapping_mul => {
541            (1, 0, vec![param(0), param(0)], param(0))
542        }
543        sym::saturating_add | sym::saturating_sub => (1, 0, vec![param(0), param(0)], param(0)),
544        sym::fadd_fast | sym::fsub_fast | sym::fmul_fast | sym::fdiv_fast | sym::frem_fast => {
545            (1, 0, vec![param(0), param(0)], param(0))
546        }
547        sym::fadd_algebraic
548        | sym::fsub_algebraic
549        | sym::fmul_algebraic
550        | sym::fdiv_algebraic
551        | sym::frem_algebraic => (1, 0, vec![param(0), param(0)], param(0)),
552        sym::float_to_int_unchecked => (2, 0, vec![param(0)], param(1)),
553
554        sym::assume => (0, 0, vec![tcx.types.bool], tcx.types.unit),
555        sym::select_unpredictable => (1, 0, vec![tcx.types.bool, param(0), param(0)], param(0)),
556        sym::cold_path => (0, 0, vec![], tcx.types.unit),
557
558        sym::read_via_copy => (1, 0, vec![Ty::new_imm_ptr(tcx, param(0))], param(0)),
559        sym::write_via_move => {
560            (1, 0, vec![Ty::new_mut_ptr(tcx, param(0)), param(0)], tcx.types.unit)
561        }
562
563        sym::typed_swap_nonoverlapping => {
564            (1, 0, vec![Ty::new_mut_ptr(tcx, param(0)); 2], tcx.types.unit)
565        }
566
567        sym::discriminant_value => {
568            let assoc_items = tcx.associated_item_def_ids(
569                tcx.require_lang_item(hir::LangItem::DiscriminantKind, span),
570            );
571            let discriminant_def_id = assoc_items[0];
572
573            let br = ty::BoundRegion { var: ty::BoundVar::ZERO, kind: ty::BoundRegionKind::Anon };
574            (
575                1,
576                0,
577                vec![Ty::new_imm_ref(tcx, ty::Region::new_bound(tcx, ty::INNERMOST, br), param(0))],
578                Ty::new_projection_from_args(
579                    tcx,
580                    discriminant_def_id,
581                    tcx.mk_args(&[param(0).into()]),
582                ),
583            )
584        }
585
586        sym::catch_unwind => {
587            let mut_u8 = Ty::new_mut_ptr(tcx, tcx.types.u8);
588            let try_fn_ty = ty::Binder::dummy(tcx.mk_fn_sig(
589                [mut_u8],
590                tcx.types.unit,
591                false,
592                hir::Safety::Safe,
593                ExternAbi::Rust,
594            ));
595            let catch_fn_ty = ty::Binder::dummy(tcx.mk_fn_sig(
596                [mut_u8, mut_u8],
597                tcx.types.unit,
598                false,
599                hir::Safety::Safe,
600                ExternAbi::Rust,
601            ));
602            (
603                0,
604                0,
605                vec![Ty::new_fn_ptr(tcx, try_fn_ty), mut_u8, Ty::new_fn_ptr(tcx, catch_fn_ty)],
606                tcx.types.i32,
607            )
608        }
609
610        sym::va_start | sym::va_end => {
611            (0, 0, vec![mk_va_list_ty(hir::Mutability::Mut).0], tcx.types.unit)
612        }
613
614        sym::va_copy => {
615            let (va_list_ref_ty, va_list_ty) = mk_va_list_ty(hir::Mutability::Not);
616            let va_list_ptr_ty = Ty::new_mut_ptr(tcx, va_list_ty);
617            (0, 0, vec![va_list_ptr_ty, va_list_ref_ty], tcx.types.unit)
618        }
619
620        sym::va_arg => (1, 0, vec![mk_va_list_ty(hir::Mutability::Mut).0], param(0)),
621
622        sym::nontemporal_store => {
623            (1, 0, vec![Ty::new_mut_ptr(tcx, param(0)), param(0)], tcx.types.unit)
624        }
625
626        sym::raw_eq => {
627            let br = ty::BoundRegion { var: ty::BoundVar::ZERO, kind: ty::BoundRegionKind::Anon };
628            let param_ty_lhs =
629                Ty::new_imm_ref(tcx, ty::Region::new_bound(tcx, ty::INNERMOST, br), param(0));
630            let br =
631                ty::BoundRegion { var: ty::BoundVar::from_u32(1), kind: ty::BoundRegionKind::Anon };
632            let param_ty_rhs =
633                Ty::new_imm_ref(tcx, ty::Region::new_bound(tcx, ty::INNERMOST, br), param(0));
634            (1, 0, vec![param_ty_lhs, param_ty_rhs], tcx.types.bool)
635        }
636
637        sym::black_box => (1, 0, vec![param(0)], param(0)),
638
639        sym::is_val_statically_known => (1, 0, vec![param(0)], tcx.types.bool),
640
641        sym::const_eval_select => (4, 0, vec![param(0), param(1), param(2)], param(3)),
642
643        sym::vtable_size | sym::vtable_align => {
644            (0, 0, vec![Ty::new_imm_ptr(tcx, tcx.types.unit)], tcx.types.usize)
645        }
646
647        sym::vtable_for => {
648            let dyn_metadata = tcx.require_lang_item(LangItem::DynMetadata, span);
649            let dyn_metadata_adt_ref = tcx.adt_def(dyn_metadata);
650            let dyn_metadata_args = tcx.mk_args(&[param(1).into()]);
651            let dyn_ty = Ty::new_adt(tcx, dyn_metadata_adt_ref, dyn_metadata_args);
652
653            let option_did = tcx.require_lang_item(LangItem::Option, span);
654            let option_adt_ref = tcx.adt_def(option_did);
655            let option_args = tcx.mk_args(&[dyn_ty.into()]);
656            let ret_ty = Ty::new_adt(tcx, option_adt_ref, option_args);
657
658            (2, 0, vec![], ret_ty)
659        }
660
661        // This type check is not particularly useful, but the `where` bounds
662        // on the definition in `core` do the heavy lifting for checking it.
663        sym::aggregate_raw_ptr => (3, 0, vec![param(1), param(2)], param(0)),
664        sym::ptr_metadata => (2, 0, vec![Ty::new_imm_ptr(tcx, param(0))], param(1)),
665
666        sym::ub_checks | sym::overflow_checks => (0, 0, Vec::new(), tcx.types.bool),
667
668        sym::box_new => (1, 0, vec![param(0)], Ty::new_box(tcx, param(0))),
669
670        // contract_check_requires::<C>(C) -> bool, where C: impl Fn() -> bool
671        sym::contract_check_requires => (1, 0, vec![param(0)], tcx.types.unit),
672        sym::contract_check_ensures => {
673            (2, 0, vec![Ty::new_option(tcx, param(0)), param(1)], param(1))
674        }
675
676        sym::simd_eq | sym::simd_ne | sym::simd_lt | sym::simd_le | sym::simd_gt | sym::simd_ge => {
677            (2, 0, vec![param(0), param(0)], param(1))
678        }
679        sym::simd_add
680        | sym::simd_sub
681        | sym::simd_mul
682        | sym::simd_rem
683        | sym::simd_div
684        | sym::simd_shl
685        | sym::simd_shr
686        | sym::simd_and
687        | sym::simd_or
688        | sym::simd_xor
689        | sym::simd_fmin
690        | sym::simd_fmax
691        | sym::simd_saturating_add
692        | sym::simd_saturating_sub => (1, 0, vec![param(0), param(0)], param(0)),
693        sym::simd_arith_offset => (2, 0, vec![param(0), param(1)], param(0)),
694        sym::simd_neg
695        | sym::simd_bswap
696        | sym::simd_bitreverse
697        | sym::simd_ctlz
698        | sym::simd_cttz
699        | sym::simd_ctpop
700        | sym::simd_fsqrt
701        | sym::simd_fsin
702        | sym::simd_fcos
703        | sym::simd_fexp
704        | sym::simd_fexp2
705        | sym::simd_flog2
706        | sym::simd_flog10
707        | sym::simd_flog
708        | sym::simd_fabs
709        | sym::simd_ceil
710        | sym::simd_floor
711        | sym::simd_round
712        | sym::simd_round_ties_even
713        | sym::simd_trunc => (1, 0, vec![param(0)], param(0)),
714        sym::simd_fma | sym::simd_relaxed_fma | sym::simd_funnel_shl | sym::simd_funnel_shr => {
715            (1, 0, vec![param(0), param(0), param(0)], param(0))
716        }
717        sym::simd_gather => (3, 0, vec![param(0), param(1), param(2)], param(0)),
718        sym::simd_masked_load => (3, 1, vec![param(0), param(1), param(2)], param(2)),
719        sym::simd_masked_store => (3, 1, vec![param(0), param(1), param(2)], tcx.types.unit),
720        sym::simd_scatter => (3, 0, vec![param(0), param(1), param(2)], tcx.types.unit),
721        sym::simd_insert | sym::simd_insert_dyn => {
722            (2, 0, vec![param(0), tcx.types.u32, param(1)], param(0))
723        }
724        sym::simd_extract | sym::simd_extract_dyn => {
725            (2, 0, vec![param(0), tcx.types.u32], param(1))
726        }
727        sym::simd_cast
728        | sym::simd_as
729        | sym::simd_cast_ptr
730        | sym::simd_expose_provenance
731        | sym::simd_with_exposed_provenance => (2, 0, vec![param(0)], param(1)),
732        sym::simd_bitmask => (2, 0, vec![param(0)], param(1)),
733        sym::simd_select | sym::simd_select_bitmask => {
734            (2, 0, vec![param(0), param(1), param(1)], param(1))
735        }
736        sym::simd_reduce_all | sym::simd_reduce_any => (1, 0, vec![param(0)], tcx.types.bool),
737        sym::simd_reduce_add_ordered | sym::simd_reduce_mul_ordered => {
738            (2, 0, vec![param(0), param(1)], param(1))
739        }
740        sym::simd_reduce_add_unordered
741        | sym::simd_reduce_mul_unordered
742        | sym::simd_reduce_and
743        | sym::simd_reduce_or
744        | sym::simd_reduce_xor
745        | sym::simd_reduce_min
746        | sym::simd_reduce_max => (2, 0, vec![param(0)], param(1)),
747        sym::simd_shuffle => (3, 0, vec![param(0), param(0), param(1)], param(2)),
748        sym::simd_shuffle_const_generic => (2, 1, vec![param(0), param(0)], param(1)),
749
750        sym::atomic_cxchg | sym::atomic_cxchgweak => (
751            1,
752            2,
753            vec![Ty::new_mut_ptr(tcx, param(0)), param(0), param(0)],
754            Ty::new_tup(tcx, &[param(0), tcx.types.bool]),
755        ),
756        sym::atomic_load => (1, 1, vec![Ty::new_imm_ptr(tcx, param(0))], param(0)),
757        sym::atomic_store => (1, 1, vec![Ty::new_mut_ptr(tcx, param(0)), param(0)], tcx.types.unit),
758
759        sym::atomic_xchg
760        | sym::atomic_max
761        | sym::atomic_min
762        | sym::atomic_umax
763        | sym::atomic_umin => (1, 1, vec![Ty::new_mut_ptr(tcx, param(0)), param(0)], param(0)),
764        sym::atomic_xadd
765        | sym::atomic_xsub
766        | sym::atomic_and
767        | sym::atomic_nand
768        | sym::atomic_or
769        | sym::atomic_xor => (2, 1, vec![Ty::new_mut_ptr(tcx, param(0)), param(1)], param(0)),
770        sym::atomic_fence | sym::atomic_singlethreadfence => (0, 1, Vec::new(), tcx.types.unit),
771
772        other => {
773            tcx.dcx().emit_err(UnrecognizedIntrinsicFunction { span, name: other });
774            return;
775        }
776    };
777    let sig = tcx.mk_fn_sig(inputs, output, false, safety, ExternAbi::Rust);
778    let sig = ty::Binder::bind_with_vars(sig, bound_vars);
779    equate_intrinsic_type(tcx, span, intrinsic_id, n_tps, n_lts, n_cts, sig)
780}
rustc_hir_analysis/check/intrinsic.rs

rustc_hir_analysis/check/
intrinsic.rs
