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

rustc_hir_analysis/check/
intrinsic.rs
