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

rustc_hir_analysis/check/
intrinsic.rs
