Skip to content

Commit 34bfcea

Browse files
committed
Add #[rustc_pass_indirectly_in_non_rustic_abis]
1 parent 0c4fa26 commit 34bfcea

29 files changed

+627
-21
lines changed

compiler/rustc_abi/src/layout/ty.rs

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -172,6 +172,8 @@ pub trait TyAbiInterface<'a, C>: Sized + std::fmt::Debug {
172172
fn is_tuple(this: TyAndLayout<'a, Self>) -> bool;
173173
fn is_unit(this: TyAndLayout<'a, Self>) -> bool;
174174
fn is_transparent(this: TyAndLayout<'a, Self>) -> bool;
175+
/// See [`TyAndLayout::pass_indirectly_in_non_rustic_abis`] for details.
176+
fn is_pass_indirectly_in_non_rustic_abis_flag_set(this: TyAndLayout<'a, Self>) -> bool;
175177
}
176178

177179
impl<'a, Ty> TyAndLayout<'a, Ty> {
@@ -269,6 +271,30 @@ impl<'a, Ty> TyAndLayout<'a, Ty> {
269271
Ty::is_transparent(self)
270272
}
271273

274+
/// If this method returns `true`, then this type should always have a `PassMode` of
275+
/// `Indirect { on_stack: false, .. }` when being used as the argument type of a function with a
276+
/// non-Rustic ABI (this is true for structs annotated with the
277+
/// `#[rustc_pass_indirectly_in_non_rustic_abis]` attribute). Currently this is only used by
278+
/// `VaList`, so this only needs to be handled on architectures where `VaList` requires it:
279+
/// specifically there is a `support_architectures` array in the
280+
/// `check_pass_indirectly_in_non_rustic_abis` function in
281+
/// `compiler/rustc_passes/src/check_attr.rs` which lists all the architectures this needs to be
282+
/// handled on. See the comment near the top of `library/core/src/ffi/va_list.rs` for more
283+
/// details.
284+
///
285+
/// This function handles transparent types automatically.
286+
pub fn pass_indirectly_in_non_rustic_abis<C>(mut self, cx: &C) -> bool
287+
where
288+
Ty: TyAbiInterface<'a, C> + Copy,
289+
{
290+
while self.is_transparent()
291+
&& let Some((_, field)) = self.non_1zst_field(cx)
292+
{
293+
self = field;
294+
}
295+
Ty::is_pass_indirectly_in_non_rustic_abis_flag_set(self)
296+
}
297+
272298
/// Finds the one field that is not a 1-ZST.
273299
/// Returns `None` if there are multiple non-1-ZST fields or only 1-ZST-fields.
274300
pub fn non_1zst_field<C>(&self, cx: &C) -> Option<(FieldIdx, Self)>

compiler/rustc_abi/src/lib.rs

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -86,14 +86,17 @@ bitflags! {
8686
const IS_C = 1 << 0;
8787
const IS_SIMD = 1 << 1;
8888
const IS_TRANSPARENT = 1 << 2;
89-
// Internal only for now. If true, don't reorder fields.
90-
// On its own it does not prevent ABI optimizations.
89+
/// Internal only for now. If true, don't reorder fields.
90+
/// On its own it does not prevent ABI optimizations.
9191
const IS_LINEAR = 1 << 3;
92-
// If true, the type's crate has opted into layout randomization.
93-
// Other flags can still inhibit reordering and thus randomization.
94-
// The seed stored in `ReprOptions.field_shuffle_seed`.
92+
/// If true, the type's crate has opted into layout randomization.
93+
/// Other flags can still inhibit reordering and thus randomization.
94+
/// The seed stored in `ReprOptions.field_shuffle_seed`.
9595
const RANDOMIZE_LAYOUT = 1 << 4;
96-
// Any of these flags being set prevent field reordering optimisation.
96+
/// If true, the type is always passed indirectly by non-Rustic ABIs.
97+
/// See [`TyAndLayout::pass_indirectly_in_non_rustic_abis`] for details.
98+
const PASS_INDIRECTLY_IN_NON_RUSTIC_ABIS = 1 << 5;
99+
/// Any of these flags being set prevent field reordering optimisation.
97100
const FIELD_ORDER_UNOPTIMIZABLE = ReprFlags::IS_C.bits()
98101
| ReprFlags::IS_SIMD.bits()
99102
| ReprFlags::IS_LINEAR.bits();

compiler/rustc_attr_data_structures/src/attributes.rs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -305,6 +305,9 @@ pub enum AttributeKind {
305305
/// Represents `#[rustc_object_lifetime_default]`.
306306
RustcObjectLifetimeDefault,
307307

308+
/// Represents `#[rustc_pass_indirectly_in_non_rustic_abis]`
309+
RustcPassIndirectlyInNonRusticAbis(Span),
310+
308311
/// Represents `#[rustc_skip_during_method_dispatch]`.
309312
SkipDuringMethodDispatch { array: bool, boxed_slice: bool, span: Span },
310313

compiler/rustc_attr_data_structures/src/encode_cross_crate.rs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,7 @@ impl AttributeKind {
4343
RustcLayoutScalarValidRangeEnd(..) => Yes,
4444
RustcLayoutScalarValidRangeStart(..) => Yes,
4545
RustcObjectLifetimeDefault => No,
46+
RustcPassIndirectlyInNonRusticAbis(..) => No,
4647
SkipDuringMethodDispatch { .. } => No,
4748
Stability { .. } => Yes,
4849
TargetFeature(..) => No,

compiler/rustc_attr_parsing/src/attributes/codegen_attrs.rs

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -330,3 +330,10 @@ impl<S: Stage> CombineAttributeParser<S> for TargetFeatureParser {
330330
features
331331
}
332332
}
333+
334+
pub(crate) struct RustcPassIndirectlyInNonRusticAbisParser;
335+
impl<S: Stage> NoArgsAttributeParser<S> for RustcPassIndirectlyInNonRusticAbisParser {
336+
const PATH: &[Symbol] = &[sym::rustc_pass_indirectly_in_non_rustic_abis];
337+
const ON_DUPLICATE: OnDuplicate<S> = OnDuplicate::Error;
338+
const CREATE: fn(Span) -> AttributeKind = AttributeKind::RustcPassIndirectlyInNonRusticAbis;
339+
}

compiler/rustc_attr_parsing/src/context.rs

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,8 @@ use rustc_span::{DUMMY_SP, ErrorGuaranteed, Span, Symbol, sym};
1616

1717
use crate::attributes::allow_unstable::{AllowConstFnUnstableParser, AllowInternalUnstableParser};
1818
use crate::attributes::codegen_attrs::{
19-
ColdParser, ExportNameParser, NakedParser, NoMangleParser, OptimizeParser, TargetFeatureParser,
20-
TrackCallerParser, UsedParser,
19+
ColdParser, ExportNameParser, NakedParser, NoMangleParser, OptimizeParser,
20+
RustcPassIndirectlyInNonRusticAbisParser, TargetFeatureParser, TrackCallerParser, UsedParser,
2121
};
2222
use crate::attributes::confusables::ConfusablesParser;
2323
use crate::attributes::deprecation::DeprecationParser;
@@ -146,6 +146,7 @@ attribute_parsers!(
146146
Single<WithoutArgs<NoMangleParser>>,
147147
Single<WithoutArgs<PassByValueParser>>,
148148
Single<WithoutArgs<PubTransparentParser>>,
149+
Single<WithoutArgs<RustcPassIndirectlyInNonRusticAbisParser>>,
149150
Single<WithoutArgs<TrackCallerParser>>,
150151
// tidy-alphabetical-end
151152
];

compiler/rustc_feature/src/builtin_attrs.rs

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -497,6 +497,12 @@ pub static BUILTIN_ATTRIBUTES: &[BuiltinAttribute] = &[
497497
ungated!(used, Normal, template!(Word, List: "compiler|linker"), WarnFollowing, EncodeCrossCrate::No),
498498
ungated!(link_ordinal, Normal, template!(List: "ordinal"), ErrorPreceding, EncodeCrossCrate::Yes),
499499
ungated!(unsafe naked, Normal, template!(Word), WarnFollowing, EncodeCrossCrate::No),
500+
// See `TyAndLayout::pass_indirectly_in_non_rustic_abis` for details.
501+
rustc_attr!(
502+
rustc_pass_indirectly_in_non_rustic_abis, Normal, template!(Word), ErrorFollowing,
503+
EncodeCrossCrate::No,
504+
"types marked with `#[rustc_pass_indirectly_in_non_rustic_abis]` are always passed indirectly by non-Rustic abis."
505+
),
500506

501507
// Limits:
502508
ungated!(

compiler/rustc_middle/src/ty/layout.rs

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ use std::{cmp, fmt};
33

44
use rustc_abi::{
55
AddressSpace, Align, ExternAbi, FieldIdx, FieldsShape, HasDataLayout, LayoutData, PointeeInfo,
6-
PointerKind, Primitive, ReprOptions, Scalar, Size, TagEncoding, TargetDataLayout,
6+
PointerKind, Primitive, ReprFlags, ReprOptions, Scalar, Size, TagEncoding, TargetDataLayout,
77
TyAbiInterface, VariantIdx, Variants,
88
};
99
use rustc_error_messages::DiagMessage;
@@ -1138,6 +1138,11 @@ where
11381138
fn is_transparent(this: TyAndLayout<'tcx>) -> bool {
11391139
matches!(this.ty.kind(), ty::Adt(def, _) if def.repr().transparent())
11401140
}
1141+
1142+
/// See [`TyAndLayout::pass_indirectly_in_non_rustic_abis`] for details.
1143+
fn is_pass_indirectly_in_non_rustic_abis_flag_set(this: TyAndLayout<'tcx>) -> bool {
1144+
matches!(this.ty.kind(), ty::Adt(def, _) if def.repr().flags.contains(ReprFlags::PASS_INDIRECTLY_IN_NON_RUSTIC_ABIS))
1145+
}
11411146
}
11421147

11431148
/// Calculates whether a function's ABI can unwind or not.

compiler/rustc_middle/src/ty/mod.rs

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1589,6 +1589,14 @@ impl<'tcx> TyCtxt<'tcx> {
15891589
flags.insert(ReprFlags::IS_LINEAR);
15901590
}
15911591

1592+
// See `TyAndLayout::pass_indirectly_in_non_rustic_abis` for details.
1593+
if attr::find_attr!(
1594+
self.get_all_attrs(did),
1595+
AttributeKind::RustcPassIndirectlyInNonRusticAbis(..)
1596+
) {
1597+
flags.insert(ReprFlags::PASS_INDIRECTLY_IN_NON_RUSTIC_ABIS);
1598+
}
1599+
15921600
ReprOptions { int: size, align: max_align, pack: min_pack, flags, field_shuffle_seed }
15931601
}
15941602

compiler/rustc_passes/messages.ftl

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -579,6 +579,14 @@ passes_pass_by_value =
579579
`pass_by_value` attribute should be applied to a struct, enum or type alias
580580
.label = is not a struct, enum or type alias
581581
582+
passes_pass_indirectly_not_a_struct =
583+
`#[rustc_pass_indirectly_in_non_rustic_abis]` can only be applied to `struct`s
584+
.label = is not a `struct`
585+
586+
passes_pass_indirectly_unsupported_arch =
587+
support for `#[rustc_pass_indirectly_in_non_rustic_abis]` on `{$arch}` has not yet been implemented
588+
.help = see the comment near the top of `library/core/src/ffi/va_list.rs` for details
589+
582590
passes_proc_macro_bad_sig = {$kind} has incorrect signature
583591
584592
passes_remove_fields =

0 commit comments

Comments
 (0)