rustc_middle/query/
erase.rs

1use std::ffi::OsStr;
2use std::intrinsics::transmute_unchecked;
3use std::mem::MaybeUninit;
4
5use rustc_span::ErrorGuaranteed;
6use rustc_span::source_map::Spanned;
7
8use crate::mir::interpret::EvalToValTreeResult;
9use crate::mir::mono::{MonoItem, NormalizationErrorInMono};
10use crate::query::CyclePlaceholder;
11use crate::traits::solve;
12use crate::ty::adjustment::CoerceUnsizedInfo;
13use crate::ty::{self, Ty, TyCtxt};
14use crate::{mir, traits};
15
16#[derive(Copy, Clone)]
17pub struct Erased<T: Copy> {
18    // We use `MaybeUninit` here so we can store any value
19    // in `data` since we aren't actually storing a `T`.
20    data: MaybeUninit<T>,
21}
22
23pub trait EraseType: Copy {
24    type Result: Copy;
25}
26
27// Allow `type_alias_bounds` since compilation will fail without `EraseType`.
28#[allow(type_alias_bounds)]
29pub type Erase<T: EraseType> = Erased<impl Copy>;
30
31#[inline(always)]
32#[define_opaque(Erase)]
33pub fn erase<T: EraseType>(src: T) -> Erase<T> {
34    // Ensure the sizes match
35    const {
36        if size_of::<T>() != size_of::<T::Result>() {
37            panic!("size of T must match erased type T::Result")
38        }
39    };
40
41    Erased::<<T as EraseType>::Result> {
42        // `transmute_unchecked` is needed here because it does not have `transmute`'s size check
43        // (and thus allows to transmute between `T` and `MaybeUninit<T::Result>`) (we do the size
44        // check ourselves in the `const` block above).
45        //
46        // `transmute_copy` is also commonly used for this (and it would work here since
47        // `EraseType: Copy`), but `transmute_unchecked` better explains the intent.
48        //
49        // SAFETY: It is safe to transmute to MaybeUninit for types with the same sizes.
50        data: unsafe { transmute_unchecked::<T, MaybeUninit<T::Result>>(src) },
51    }
52}
53
54/// Restores an erased value.
55#[inline(always)]
56#[define_opaque(Erase)]
57pub fn restore<T: EraseType>(value: Erase<T>) -> T {
58    let value: Erased<<T as EraseType>::Result> = value;
59    // See comment in `erase` for why we use `transmute_unchecked`.
60    //
61    // SAFETY: Due to the use of impl Trait in `Erase` the only way to safely create an instance
62    // of `Erase` is to call `erase`, so we know that `value.data` is a valid instance of `T` of
63    // the right size.
64    unsafe { transmute_unchecked::<MaybeUninit<T::Result>, T>(value.data) }
65}
66
67impl<T> EraseType for &'_ T {
68    type Result = [u8; size_of::<&'static ()>()];
69}
70
71impl<T> EraseType for &'_ [T] {
72    type Result = [u8; size_of::<&'static [()]>()];
73}
74
75impl EraseType for &'_ OsStr {
76    type Result = [u8; size_of::<&'static OsStr>()];
77}
78
79impl<T> EraseType for &'_ ty::List<T> {
80    type Result = [u8; size_of::<&'static ty::List<()>>()];
81}
82
83impl<T> EraseType for &'_ ty::ListWithCachedTypeInfo<T> {
84    type Result = [u8; size_of::<&'static ty::ListWithCachedTypeInfo<()>>()];
85}
86
87impl<I: rustc_index::Idx, T> EraseType for &'_ rustc_index::IndexSlice<I, T> {
88    type Result = [u8; size_of::<&'static rustc_index::IndexSlice<u32, ()>>()];
89}
90
91impl<T> EraseType for Result<&'_ T, traits::query::NoSolution> {
92    type Result = [u8; size_of::<Result<&'static (), traits::query::NoSolution>>()];
93}
94
95impl<T> EraseType for Result<&'_ [T], traits::query::NoSolution> {
96    type Result = [u8; size_of::<Result<&'static [()], traits::query::NoSolution>>()];
97}
98
99impl<T> EraseType for Result<&'_ T, rustc_errors::ErrorGuaranteed> {
100    type Result = [u8; size_of::<Result<&'static (), rustc_errors::ErrorGuaranteed>>()];
101}
102
103impl<T> EraseType for Result<&'_ [T], rustc_errors::ErrorGuaranteed> {
104    type Result = [u8; size_of::<Result<&'static [()], rustc_errors::ErrorGuaranteed>>()];
105}
106
107impl<T> EraseType for Result<&'_ T, traits::CodegenObligationError> {
108    type Result = [u8; size_of::<Result<&'static (), traits::CodegenObligationError>>()];
109}
110
111impl<T> EraseType for Result<&'_ T, &'_ ty::layout::FnAbiError<'_>> {
112    type Result = [u8; size_of::<Result<&'static (), &'static ty::layout::FnAbiError<'static>>>()];
113}
114
115impl<T> EraseType for Result<(&'_ T, crate::thir::ExprId), rustc_errors::ErrorGuaranteed> {
116    type Result = [u8; size_of::<
117        Result<(&'static (), crate::thir::ExprId), rustc_errors::ErrorGuaranteed>,
118    >()];
119}
120
121impl EraseType for Result<Option<ty::Instance<'_>>, rustc_errors::ErrorGuaranteed> {
122    type Result =
123        [u8; size_of::<Result<Option<ty::Instance<'static>>, rustc_errors::ErrorGuaranteed>>()];
124}
125
126impl EraseType for Result<CoerceUnsizedInfo, rustc_errors::ErrorGuaranteed> {
127    type Result = [u8; size_of::<Result<CoerceUnsizedInfo, rustc_errors::ErrorGuaranteed>>()];
128}
129
130impl EraseType
131    for Result<Option<ty::EarlyBinder<'_, ty::Const<'_>>>, rustc_errors::ErrorGuaranteed>
132{
133    type Result = [u8; size_of::<
134        Result<Option<ty::EarlyBinder<'static, ty::Const<'static>>>, rustc_errors::ErrorGuaranteed>,
135    >()];
136}
137
138impl EraseType for Result<ty::GenericArg<'_>, traits::query::NoSolution> {
139    type Result = [u8; size_of::<Result<ty::GenericArg<'static>, traits::query::NoSolution>>()];
140}
141
142impl EraseType for Result<bool, &ty::layout::LayoutError<'_>> {
143    type Result = [u8; size_of::<Result<bool, &'static ty::layout::LayoutError<'static>>>()];
144}
145
146impl EraseType for Result<rustc_abi::TyAndLayout<'_, Ty<'_>>, &ty::layout::LayoutError<'_>> {
147    type Result = [u8; size_of::<
148        Result<
149            rustc_abi::TyAndLayout<'static, Ty<'static>>,
150            &'static ty::layout::LayoutError<'static>,
151        >,
152    >()];
153}
154
155impl EraseType for Result<mir::ConstAlloc<'_>, mir::interpret::ErrorHandled> {
156    type Result = [u8; size_of::<Result<mir::ConstAlloc<'static>, mir::interpret::ErrorHandled>>()];
157}
158
159impl EraseType for Result<mir::ConstValue, mir::interpret::ErrorHandled> {
160    type Result = [u8; size_of::<Result<mir::ConstValue, mir::interpret::ErrorHandled>>()];
161}
162
163impl EraseType for EvalToValTreeResult<'_> {
164    type Result = [u8; size_of::<EvalToValTreeResult<'static>>()];
165}
166
167impl EraseType for Result<&'_ ty::List<Ty<'_>>, ty::util::AlwaysRequiresDrop> {
168    type Result =
169        [u8; size_of::<Result<&'static ty::List<Ty<'static>>, ty::util::AlwaysRequiresDrop>>()];
170}
171
172impl EraseType for Result<ty::EarlyBinder<'_, Ty<'_>>, CyclePlaceholder> {
173    type Result = [u8; size_of::<Result<ty::EarlyBinder<'static, Ty<'_>>, CyclePlaceholder>>()];
174}
175
176impl EraseType
177    for Result<(&'_ [Spanned<MonoItem<'_>>], &'_ [Spanned<MonoItem<'_>>]), NormalizationErrorInMono>
178{
179    type Result = [u8; size_of::<
180        Result<
181            (&'static [Spanned<MonoItem<'static>>], &'static [Spanned<MonoItem<'static>>]),
182            NormalizationErrorInMono,
183        >,
184    >()];
185}
186
187impl<T> EraseType for Option<&'_ T> {
188    type Result = [u8; size_of::<Option<&'static ()>>()];
189}
190
191impl<T> EraseType for Option<&'_ [T]> {
192    type Result = [u8; size_of::<Option<&'static [()]>>()];
193}
194
195impl EraseType for Option<&'_ OsStr> {
196    type Result = [u8; size_of::<Option<&'static OsStr>>()];
197}
198
199impl EraseType for Option<mir::DestructuredConstant<'_>> {
200    type Result = [u8; size_of::<Option<mir::DestructuredConstant<'static>>>()];
201}
202
203impl EraseType for ty::ImplTraitHeader<'_> {
204    type Result = [u8; size_of::<ty::ImplTraitHeader<'static>>()];
205}
206
207impl EraseType for Option<ty::EarlyBinder<'_, Ty<'_>>> {
208    type Result = [u8; size_of::<Option<ty::EarlyBinder<'static, Ty<'static>>>>()];
209}
210
211impl EraseType for rustc_hir::MaybeOwner<'_> {
212    type Result = [u8; size_of::<rustc_hir::MaybeOwner<'static>>()];
213}
214
215impl<T: EraseType> EraseType for ty::EarlyBinder<'_, T> {
216    type Result = T::Result;
217}
218
219impl EraseType for ty::Binder<'_, ty::FnSig<'_>> {
220    type Result = [u8; size_of::<ty::Binder<'static, ty::FnSig<'static>>>()];
221}
222
223impl EraseType for ty::Binder<'_, ty::CoroutineWitnessTypes<TyCtxt<'_>>> {
224    type Result =
225        [u8; size_of::<ty::Binder<'static, ty::CoroutineWitnessTypes<TyCtxt<'static>>>>()];
226}
227
228impl EraseType for ty::Binder<'_, &'_ ty::List<Ty<'_>>> {
229    type Result = [u8; size_of::<ty::Binder<'static, &'static ty::List<Ty<'static>>>>()];
230}
231
232impl<T0, T1> EraseType for (&'_ T0, &'_ T1) {
233    type Result = [u8; size_of::<(&'static (), &'static ())>()];
234}
235
236impl<T0> EraseType for (solve::QueryResult<'_>, &'_ T0) {
237    type Result = [u8; size_of::<(solve::QueryResult<'static>, &'static ())>()];
238}
239
240impl<T0, T1> EraseType for (&'_ T0, &'_ [T1]) {
241    type Result = [u8; size_of::<(&'static (), &'static [()])>()];
242}
243
244impl<T0, T1> EraseType for (&'_ [T0], &'_ [T1]) {
245    type Result = [u8; size_of::<(&'static [()], &'static [()])>()];
246}
247
248impl<T0> EraseType for (&'_ T0, Result<(), ErrorGuaranteed>) {
249    type Result = [u8; size_of::<(&'static (), Result<(), ErrorGuaranteed>)>()];
250}
251
252macro_rules! trivial {
253    ($($ty:ty),+ $(,)?) => {
254        $(
255            impl EraseType for $ty {
256                type Result = [u8; size_of::<$ty>()];
257            }
258        )*
259    }
260}
261
262trivial! {
263    (),
264    bool,
265    Option<(rustc_span::def_id::DefId, rustc_session::config::EntryFnType)>,
266    Option<rustc_ast::expand::allocator::AllocatorKind>,
267    Option<rustc_hir::ConstStability>,
268    Option<rustc_hir::DefaultBodyStability>,
269    Option<rustc_hir::Stability>,
270    Option<rustc_data_structures::svh::Svh>,
271    Option<rustc_hir::def::DefKind>,
272    Option<rustc_hir::CoroutineKind>,
273    Option<rustc_hir::HirId>,
274    Option<rustc_middle::middle::stability::DeprecationEntry>,
275    Option<rustc_middle::ty::AsyncDestructor>,
276    Option<rustc_middle::ty::Destructor>,
277    Option<rustc_middle::ty::ImplTraitInTraitData>,
278    Option<rustc_middle::ty::ScalarInt>,
279    Option<rustc_span::def_id::CrateNum>,
280    Option<rustc_span::def_id::DefId>,
281    Option<rustc_span::def_id::LocalDefId>,
282    Option<rustc_span::Span>,
283    Option<rustc_abi::FieldIdx>,
284    Option<rustc_target::spec::PanicStrategy>,
285    Option<usize>,
286    Option<rustc_middle::ty::IntrinsicDef>,
287    Option<rustc_abi::Align>,
288    Result<(), rustc_errors::ErrorGuaranteed>,
289    Result<(), rustc_middle::traits::query::NoSolution>,
290    Result<rustc_middle::traits::EvaluationResult, rustc_middle::traits::OverflowError>,
291    rustc_abi::ReprOptions,
292    rustc_ast::expand::allocator::AllocatorKind,
293    rustc_hir::DefaultBodyStability,
294    rustc_hir::attrs::Deprecation,
295    rustc_data_structures::svh::Svh,
296    rustc_errors::ErrorGuaranteed,
297    rustc_hir::Constness,
298    rustc_hir::ConstStability,
299    rustc_hir::def_id::DefId,
300    rustc_hir::def_id::DefIndex,
301    rustc_hir::def_id::LocalDefId,
302    rustc_hir::def_id::LocalModDefId,
303    rustc_hir::def::DefKind,
304    rustc_hir::Defaultness,
305    rustc_hir::definitions::DefKey,
306    rustc_hir::CoroutineKind,
307    rustc_hir::HirId,
308    rustc_hir::IsAsync,
309    rustc_hir::ItemLocalId,
310    rustc_hir::LangItem,
311    rustc_hir::OpaqueTyOrigin<rustc_hir::def_id::DefId>,
312    rustc_hir::OwnerId,
313    rustc_hir::Stability,
314    rustc_hir::Upvar,
315    rustc_index::bit_set::FiniteBitSet<u32>,
316    rustc_middle::middle::deduced_param_attrs::DeducedParamAttrs,
317    rustc_middle::middle::dependency_format::Linkage,
318    rustc_middle::middle::exported_symbols::SymbolExportInfo,
319    rustc_middle::middle::resolve_bound_vars::ObjectLifetimeDefault,
320    rustc_middle::middle::resolve_bound_vars::ResolvedArg,
321    rustc_middle::middle::stability::DeprecationEntry,
322    rustc_middle::mir::ConstQualifs,
323    rustc_middle::mir::ConstValue,
324    rustc_middle::mir::interpret::AllocId,
325    rustc_middle::mir::interpret::CtfeProvenance,
326    rustc_middle::mir::interpret::ErrorHandled,
327    rustc_middle::thir::ExprId,
328    rustc_middle::traits::CodegenObligationError,
329    rustc_middle::traits::EvaluationResult,
330    rustc_middle::traits::OverflowError,
331    rustc_middle::traits::query::NoSolution,
332    rustc_middle::traits::WellFormedLoc,
333    rustc_middle::ty::adjustment::CoerceUnsizedInfo,
334    rustc_middle::ty::AssocItem,
335    rustc_middle::ty::AssocContainer,
336    rustc_middle::ty::Asyncness,
337    rustc_middle::ty::AsyncDestructor,
338    rustc_middle::ty::BoundVariableKind,
339    rustc_middle::ty::AnonConstKind,
340    rustc_middle::ty::Destructor,
341    rustc_middle::ty::fast_reject::SimplifiedType,
342    rustc_middle::ty::ImplPolarity,
343    rustc_middle::ty::Representability,
344    rustc_middle::ty::UnusedGenericParams,
345    rustc_middle::ty::util::AlwaysRequiresDrop,
346    rustc_middle::ty::Visibility<rustc_span::def_id::DefId>,
347    rustc_session::config::CrateType,
348    rustc_session::config::EntryFnType,
349    rustc_session::config::OptLevel,
350    rustc_session::config::SymbolManglingVersion,
351    rustc_session::cstore::CrateDepKind,
352    rustc_session::cstore::ExternCrate,
353    rustc_session::cstore::LinkagePreference,
354    rustc_session::Limits,
355    rustc_session::lint::LintExpectationId,
356    rustc_span::def_id::CrateNum,
357    rustc_span::def_id::DefPathHash,
358    rustc_span::ExpnHash,
359    rustc_span::ExpnId,
360    rustc_span::Span,
361    rustc_span::Symbol,
362    rustc_span::Ident,
363    rustc_target::spec::PanicStrategy,
364    rustc_target::spec::SanitizerSet,
365    rustc_type_ir::Variance,
366    u32,
367    usize,
368}
369
370macro_rules! tcx_lifetime {
371    ($($($fake_path:ident)::+),+ $(,)?) => {
372        $(
373            impl<'tcx> EraseType for $($fake_path)::+<'tcx> {
374                type Result = [u8; size_of::<$($fake_path)::+<'static>>()];
375            }
376        )*
377    }
378}
379
380tcx_lifetime! {
381    rustc_middle::middle::exported_symbols::ExportedSymbol,
382    rustc_middle::mir::Const,
383    rustc_middle::mir::DestructuredConstant,
384    rustc_middle::mir::ConstAlloc,
385    rustc_middle::mir::interpret::GlobalId,
386    rustc_middle::mir::interpret::LitToConstInput,
387    rustc_middle::mir::interpret::EvalStaticInitializerRawResult,
388    rustc_middle::mir::mono::MonoItemPartitions,
389    rustc_middle::traits::query::MethodAutoderefStepsResult,
390    rustc_middle::traits::query::type_op::AscribeUserType,
391    rustc_middle::traits::query::type_op::Eq,
392    rustc_middle::traits::query::type_op::ProvePredicate,
393    rustc_middle::traits::query::type_op::Subtype,
394    rustc_middle::ty::AdtDef,
395    rustc_middle::ty::AliasTy,
396    rustc_middle::ty::ClauseKind,
397    rustc_middle::ty::ClosureTypeInfo,
398    rustc_middle::ty::Const,
399    rustc_middle::ty::DestructuredConst,
400    rustc_middle::ty::ExistentialTraitRef,
401    rustc_middle::ty::FnSig,
402    rustc_middle::ty::GenericArg,
403    rustc_middle::ty::GenericPredicates,
404    rustc_middle::ty::ConstConditions,
405    rustc_middle::ty::inhabitedness::InhabitedPredicate,
406    rustc_middle::ty::Instance,
407    rustc_middle::ty::InstanceKind,
408    rustc_middle::ty::layout::FnAbiError,
409    rustc_middle::ty::layout::LayoutError,
410    rustc_middle::ty::ParamEnv,
411    rustc_middle::ty::TypingEnv,
412    rustc_middle::ty::Predicate,
413    rustc_middle::ty::SymbolName,
414    rustc_middle::ty::TraitRef,
415    rustc_middle::ty::Ty,
416    rustc_middle::ty::UnevaluatedConst,
417    rustc_middle::ty::ValTree,
418    rustc_middle::ty::VtblEntry,
419}
rustc_middle/query/erase.rs

rustc_middle/query/
erase.rs
