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

rustc_hir_analysis/check/
intrinsic.rs
