Arbitrary self types v2: pointers feature gate.

The main `arbitrary_self_types` feature gate will shortly be reused for
a new version of arbitrary self types which we are amending per [this
RFC](https://github.com/rust-lang/rfcs/blob/master/text/3519-arbitrary-self-types-v2.md).
The main amendments are:

* _do_ support `self` types which can't safely implement `Deref`
* do _not_ support generic `self` types
* do _not_ support raw pointers as `self` types.

This PR relates to the last of those bullet points: this strips pointer
support from the current `arbitrary_self_types` feature.
We expect this to cause some amount of breakage for crates using this
unstable feature to allow raw pointer self types. If that's the case, we
want to know about it, and we want crate authors to know of the upcoming
changes.

For now, this can be resolved by adding the new
`arbitrary_self_types_pointers` feature to such crates. If we determine
that use of raw pointers as self types is common, then we may maintain
that as an unstable feature even if we come to stabilize the rest of the
`arbitrary_self_types` support in future. If we don't hear that this PR
is causing breakage, then perhaps we don't need it at all, even behind
an unstable feature gate.

[Tracking issue](https://github.com/rust-lang/rust/issues/44874)

This is [step 4 of the plan outlined here](https://github.com/rust-lang/rust/issues/44874#issuecomment-2122179688)
This commit is contained in:
Adrian Taylor 2024-03-30 19:25:22 +00:00
parent ae9f5019f9
commit e77eb042ce
14 changed files with 134 additions and 34 deletions

View File

@ -348,8 +348,10 @@ pub fn internal(&self, feature: Symbol) -> bool {
(unstable, adt_const_params, "1.56.0", Some(95174)), (unstable, adt_const_params, "1.56.0", Some(95174)),
/// Allows defining an `#[alloc_error_handler]`. /// Allows defining an `#[alloc_error_handler]`.
(unstable, alloc_error_handler, "1.29.0", Some(51540)), (unstable, alloc_error_handler, "1.29.0", Some(51540)),
/// Allows trait methods with arbitrary self types. /// Allows inherent and trait methods with arbitrary self types.
(unstable, arbitrary_self_types, "1.23.0", Some(44874)), (unstable, arbitrary_self_types, "1.23.0", Some(44874)),
/// Allows inherent and trait methods with arbitrary self types that are raw pointers.
(unstable, arbitrary_self_types_pointers, "CURRENT_RUSTC_VERSION", Some(44874)),
/// Enables experimental inline assembly support for additional architectures. /// Enables experimental inline assembly support for additional architectures.
(unstable, asm_experimental_arch, "1.58.0", Some(93335)), (unstable, asm_experimental_arch, "1.58.0", Some(93335)),
/// Allows using `label` operands in inline assembly. /// Allows using `label` operands in inline assembly.

View File

@ -1651,6 +1651,14 @@ fn check_fn_or_method<'tcx>(
} }
} }
/// The `arbitrary_self_types_pointers` feature implies `arbitrary_self_types`.
#[derive(Clone, Copy)]
enum ArbitrarySelfTypesLevel {
None, // neither arbitrary_self_types nor arbitrary_self_types_pointers
ArbitrarySelfTypes, // just arbitrary_self_types
ArbitrarySelfTypesPointers, // both arbitrary_self_types and arbitrary_self_types_pointers
}
#[instrument(level = "debug", skip(wfcx))] #[instrument(level = "debug", skip(wfcx))]
fn check_method_receiver<'tcx>( fn check_method_receiver<'tcx>(
wfcx: &WfCheckingCtxt<'_, 'tcx>, wfcx: &WfCheckingCtxt<'_, 'tcx>,
@ -1683,14 +1691,28 @@ fn check_method_receiver<'tcx>(
return Ok(()); return Ok(());
} }
if tcx.features().arbitrary_self_types { let arbitrary_self_types_level = if tcx.features().arbitrary_self_types_pointers {
if !receiver_is_valid(wfcx, span, receiver_ty, self_ty, true) { ArbitrarySelfTypesLevel::ArbitrarySelfTypesPointers
// Report error; `arbitrary_self_types` was enabled. } else if tcx.features().arbitrary_self_types {
return Err(tcx.dcx().emit_err(errors::InvalidReceiverTy { span, receiver_ty })); ArbitrarySelfTypesLevel::ArbitrarySelfTypes
}
} else { } else {
if !receiver_is_valid(wfcx, span, receiver_ty, self_ty, false) { ArbitrarySelfTypesLevel::None
return Err(if receiver_is_valid(wfcx, span, receiver_ty, self_ty, true) { };
if !receiver_is_valid(wfcx, span, receiver_ty, self_ty, arbitrary_self_types_level) {
return Err(match arbitrary_self_types_level {
// Wherever possible, emit a message advising folks that the features
// `arbitrary_self_types` or `arbitrary_self_types_pointers` might
// have helped.
ArbitrarySelfTypesLevel::None
if receiver_is_valid(
wfcx,
span,
receiver_ty,
self_ty,
ArbitrarySelfTypesLevel::ArbitrarySelfTypes,
) =>
{
// Report error; would have worked with `arbitrary_self_types`. // Report error; would have worked with `arbitrary_self_types`.
feature_err( feature_err(
&tcx.sess, &tcx.sess,
@ -1703,20 +1725,44 @@ fn check_method_receiver<'tcx>(
) )
.with_help(fluent::hir_analysis_invalid_receiver_ty_help) .with_help(fluent::hir_analysis_invalid_receiver_ty_help)
.emit() .emit()
} else {
// Report error; would not have worked with `arbitrary_self_types`.
tcx.dcx().emit_err(errors::InvalidReceiverTy { span, receiver_ty })
});
} }
ArbitrarySelfTypesLevel::ArbitrarySelfTypes | ArbitrarySelfTypesLevel::None
if receiver_is_valid(
wfcx,
span,
receiver_ty,
self_ty,
ArbitrarySelfTypesLevel::ArbitrarySelfTypesPointers,
) =>
{
// Report error; would have worked with `arbitrary_self_types_pointers`.
feature_err(
&tcx.sess,
sym::arbitrary_self_types_pointers,
span,
format!(
"`{receiver_ty}` cannot be used as the type of `self` without \
the `arbitrary_self_types_pointers` feature",
),
)
.with_help(fluent::hir_analysis_invalid_receiver_ty_help)
.emit()
}
_ =>
// Report error; would not have worked with `arbitrary_self_types[_pointers]`.
{
tcx.dcx().emit_err(errors::InvalidReceiverTy { span, receiver_ty })
}
});
} }
Ok(()) Ok(())
} }
/// Returns whether `receiver_ty` would be considered a valid receiver type for `self_ty`. If /// Returns whether `receiver_ty` would be considered a valid receiver type for `self_ty`. If
/// `arbitrary_self_types` is enabled, `receiver_ty` must transitively deref to `self_ty`, possibly /// `arbitrary_self_types` is enabled, `receiver_ty` must transitively deref to `self_ty`, possibly
/// through a `*const/mut T` raw pointer. If the feature is not enabled, the requirements are more /// through a `*const/mut T` raw pointer if `arbitrary_self_types_pointers` is also enabled.
/// strict: `receiver_ty` must implement `Receiver` and directly implement /// If neither feature is enabled, the requirements are more strict: `receiver_ty` must implement
/// `Deref<Target = self_ty>`. /// `Receiver` and directly implement `Deref<Target = self_ty>`.
/// ///
/// N.B., there are cases this function returns `true` but causes an error to be emitted, /// N.B., there are cases this function returns `true` but causes an error to be emitted,
/// particularly when `receiver_ty` derefs to a type that is the same as `self_ty` but has the /// particularly when `receiver_ty` derefs to a type that is the same as `self_ty` but has the
@ -1726,7 +1772,7 @@ fn receiver_is_valid<'tcx>(
span: Span, span: Span,
receiver_ty: Ty<'tcx>, receiver_ty: Ty<'tcx>,
self_ty: Ty<'tcx>, self_ty: Ty<'tcx>,
arbitrary_self_types_enabled: bool, arbitrary_self_types_enabled: ArbitrarySelfTypesLevel,
) -> bool { ) -> bool {
let infcx = wfcx.infcx; let infcx = wfcx.infcx;
let tcx = wfcx.tcx(); let tcx = wfcx.tcx();
@ -1744,8 +1790,8 @@ fn receiver_is_valid<'tcx>(
let mut autoderef = Autoderef::new(infcx, wfcx.param_env, wfcx.body_def_id, span, receiver_ty); let mut autoderef = Autoderef::new(infcx, wfcx.param_env, wfcx.body_def_id, span, receiver_ty);
// The `arbitrary_self_types` feature allows raw pointer receivers like `self: *const Self`. // The `arbitrary_self_types_pointers` feature allows raw pointer receivers like `self: *const Self`.
if arbitrary_self_types_enabled { if matches!(arbitrary_self_types_enabled, ArbitrarySelfTypesLevel::ArbitrarySelfTypesPointers) {
autoderef = autoderef.include_raw_pointers(); autoderef = autoderef.include_raw_pointers();
} }
@ -1771,7 +1817,7 @@ fn receiver_is_valid<'tcx>(
// Without `feature(arbitrary_self_types)`, we require that each step in the // Without `feature(arbitrary_self_types)`, we require that each step in the
// deref chain implement `receiver`. // deref chain implement `receiver`.
if !arbitrary_self_types_enabled { if matches!(arbitrary_self_types_enabled, ArbitrarySelfTypesLevel::None) {
if !receiver_is_implemented( if !receiver_is_implemented(
wfcx, wfcx,
receiver_trait_def_id, receiver_trait_def_id,

View File

@ -402,7 +402,7 @@ pub(crate) fn probe_op<OP, R>(
mode, mode,
})); }));
} else if bad_ty.reached_raw_pointer } else if bad_ty.reached_raw_pointer
&& !self.tcx.features().arbitrary_self_types && !self.tcx.features().arbitrary_self_types_pointers
&& !self.tcx.sess.at_least_rust_2018() && !self.tcx.sess.at_least_rust_2018()
{ {
// this case used to be allowed by the compiler, // this case used to be allowed by the compiler,

View File

@ -406,6 +406,7 @@
append_const_msg, append_const_msg,
arbitrary_enum_discriminant, arbitrary_enum_discriminant,
arbitrary_self_types, arbitrary_self_types,
arbitrary_self_types_pointers,
args, args,
arith_offset, arith_offset,
arm, arm,

View File

@ -1,6 +1,6 @@
//@revisions: stack tree //@revisions: stack tree
//@[tree]compile-flags: -Zmiri-tree-borrows //@[tree]compile-flags: -Zmiri-tree-borrows
#![feature(arbitrary_self_types, unsize, coerce_unsized, dispatch_from_dyn)] #![feature(arbitrary_self_types_pointers, unsize, coerce_unsized, dispatch_from_dyn)]
#![feature(rustc_attrs)] #![feature(rustc_attrs)]
fn pin_box_dyn() { fn pin_box_dyn() {

View File

@ -1,7 +1,7 @@
// skip-filecheck // skip-filecheck
// EMIT_MIR receiver_ptr_mutability.main.built.after.mir // EMIT_MIR receiver_ptr_mutability.main.built.after.mir
#![feature(arbitrary_self_types)] #![feature(arbitrary_self_types_pointers)]
struct Test {} struct Test {}

View File

@ -2,7 +2,7 @@
// //
// issue: <https://github.com/rust-lang/rust/issues/120217> // issue: <https://github.com/rust-lang/rust/issues/120217>
#![feature(arbitrary_self_types)] #![feature(arbitrary_self_types_pointers)]
trait Static<'a> { trait Static<'a> {
fn proof(self: *const Self, s: &'a str) -> &'static str; fn proof(self: *const Self, s: &'a str) -> &'static str;

View File

@ -0,0 +1,15 @@
trait Foo {
fn foo(self: *const Self); //~ ERROR `*const Self` cannot be used as the type of `self`
}
struct Bar;
impl Foo for Bar {
fn foo(self: *const Self) {} //~ ERROR `*const Bar` cannot be used as the type of `self`
}
impl Bar {
fn bar(self: *mut Self) {} //~ ERROR `*mut Bar` cannot be used as the type of `self`
}
fn main() {}

View File

@ -0,0 +1,36 @@
error[E0658]: `*const Bar` cannot be used as the type of `self` without the `arbitrary_self_types_pointers` feature
--> $DIR/feature-gate-arbitrary-self-types-pointers.rs:8:18
|
LL | fn foo(self: *const Self) {}
| ^^^^^^^^^^^
|
= note: see issue #44874 <https://github.com/rust-lang/rust/issues/44874> for more information
= help: add `#![feature(arbitrary_self_types_pointers)]` to the crate attributes to enable
= note: this compiler was built on YYYY-MM-DD; consider upgrading it if it is out of date
= help: consider changing to `self`, `&self`, `&mut self`, `self: Box<Self>`, `self: Rc<Self>`, `self: Arc<Self>`, or `self: Pin<P>` (where P is one of the previous types except `Self`)
error[E0658]: `*mut Bar` cannot be used as the type of `self` without the `arbitrary_self_types_pointers` feature
--> $DIR/feature-gate-arbitrary-self-types-pointers.rs:12:18
|
LL | fn bar(self: *mut Self) {}
| ^^^^^^^^^
|
= note: see issue #44874 <https://github.com/rust-lang/rust/issues/44874> for more information
= help: add `#![feature(arbitrary_self_types_pointers)]` to the crate attributes to enable
= note: this compiler was built on YYYY-MM-DD; consider upgrading it if it is out of date
= help: consider changing to `self`, `&self`, `&mut self`, `self: Box<Self>`, `self: Rc<Self>`, `self: Arc<Self>`, or `self: Pin<P>` (where P is one of the previous types except `Self`)
error[E0658]: `*const Self` cannot be used as the type of `self` without the `arbitrary_self_types_pointers` feature
--> $DIR/feature-gate-arbitrary-self-types-pointers.rs:2:18
|
LL | fn foo(self: *const Self);
| ^^^^^^^^^^^
|
= note: see issue #44874 <https://github.com/rust-lang/rust/issues/44874> for more information
= help: add `#![feature(arbitrary_self_types_pointers)]` to the crate attributes to enable
= note: this compiler was built on YYYY-MM-DD; consider upgrading it if it is out of date
= help: consider changing to `self`, `&self`, `&mut self`, `self: Box<Self>`, `self: Rc<Self>`, `self: Arc<Self>`, or `self: Pin<P>` (where P is one of the previous types except `Self`)
error: aborting due to 3 previous errors
For more information about this error, try `rustc --explain E0658`.

View File

@ -1,33 +1,33 @@
error[E0658]: `*const Foo` cannot be used as the type of `self` without the `arbitrary_self_types` feature error[E0658]: `*const Foo` cannot be used as the type of `self` without the `arbitrary_self_types_pointers` feature
--> $DIR/feature-gate-arbitrary_self_types-raw-pointer.rs:4:18 --> $DIR/feature-gate-arbitrary_self_types-raw-pointer.rs:4:18
| |
LL | fn foo(self: *const Self) {} LL | fn foo(self: *const Self) {}
| ^^^^^^^^^^^ | ^^^^^^^^^^^
| |
= note: see issue #44874 <https://github.com/rust-lang/rust/issues/44874> for more information = note: see issue #44874 <https://github.com/rust-lang/rust/issues/44874> for more information
= help: add `#![feature(arbitrary_self_types)]` to the crate attributes to enable = help: add `#![feature(arbitrary_self_types_pointers)]` to the crate attributes to enable
= note: this compiler was built on YYYY-MM-DD; consider upgrading it if it is out of date = note: this compiler was built on YYYY-MM-DD; consider upgrading it if it is out of date
= help: consider changing to `self`, `&self`, `&mut self`, `self: Box<Self>`, `self: Rc<Self>`, `self: Arc<Self>`, or `self: Pin<P>` (where P is one of the previous types except `Self`) = help: consider changing to `self`, `&self`, `&mut self`, `self: Box<Self>`, `self: Rc<Self>`, `self: Arc<Self>`, or `self: Pin<P>` (where P is one of the previous types except `Self`)
error[E0658]: `*const ()` cannot be used as the type of `self` without the `arbitrary_self_types` feature error[E0658]: `*const ()` cannot be used as the type of `self` without the `arbitrary_self_types_pointers` feature
--> $DIR/feature-gate-arbitrary_self_types-raw-pointer.rs:14:18 --> $DIR/feature-gate-arbitrary_self_types-raw-pointer.rs:14:18
| |
LL | fn bar(self: *const Self) {} LL | fn bar(self: *const Self) {}
| ^^^^^^^^^^^ | ^^^^^^^^^^^
| |
= note: see issue #44874 <https://github.com/rust-lang/rust/issues/44874> for more information = note: see issue #44874 <https://github.com/rust-lang/rust/issues/44874> for more information
= help: add `#![feature(arbitrary_self_types)]` to the crate attributes to enable = help: add `#![feature(arbitrary_self_types_pointers)]` to the crate attributes to enable
= note: this compiler was built on YYYY-MM-DD; consider upgrading it if it is out of date = note: this compiler was built on YYYY-MM-DD; consider upgrading it if it is out of date
= help: consider changing to `self`, `&self`, `&mut self`, `self: Box<Self>`, `self: Rc<Self>`, `self: Arc<Self>`, or `self: Pin<P>` (where P is one of the previous types except `Self`) = help: consider changing to `self`, `&self`, `&mut self`, `self: Box<Self>`, `self: Rc<Self>`, `self: Arc<Self>`, or `self: Pin<P>` (where P is one of the previous types except `Self`)
error[E0658]: `*const Self` cannot be used as the type of `self` without the `arbitrary_self_types` feature error[E0658]: `*const Self` cannot be used as the type of `self` without the `arbitrary_self_types_pointers` feature
--> $DIR/feature-gate-arbitrary_self_types-raw-pointer.rs:9:18 --> $DIR/feature-gate-arbitrary_self_types-raw-pointer.rs:9:18
| |
LL | fn bar(self: *const Self); LL | fn bar(self: *const Self);
| ^^^^^^^^^^^ | ^^^^^^^^^^^
| |
= note: see issue #44874 <https://github.com/rust-lang/rust/issues/44874> for more information = note: see issue #44874 <https://github.com/rust-lang/rust/issues/44874> for more information
= help: add `#![feature(arbitrary_self_types)]` to the crate attributes to enable = help: add `#![feature(arbitrary_self_types_pointers)]` to the crate attributes to enable
= note: this compiler was built on YYYY-MM-DD; consider upgrading it if it is out of date = note: this compiler was built on YYYY-MM-DD; consider upgrading it if it is out of date
= help: consider changing to `self`, `&self`, `&mut self`, `self: Box<Self>`, `self: Rc<Self>`, `self: Arc<Self>`, or `self: Pin<P>` (where P is one of the previous types except `Self`) = help: consider changing to `self`, `&self`, `&mut self`, `self: Box<Self>`, `self: Rc<Self>`, `self: Arc<Self>`, or `self: Pin<P>` (where P is one of the previous types except `Self`)

View File

@ -1,5 +1,5 @@
#![feature(staged_api)] #![feature(staged_api)]
#![feature(arbitrary_self_types)] #![feature(arbitrary_self_types_pointers)]
#![stable(feature = "ipu_iterator", since = "1.0.0")] #![stable(feature = "ipu_iterator", since = "1.0.0")]

View File

@ -1,4 +1,4 @@
#![feature(arbitrary_self_types)] #![feature(arbitrary_self_types_pointers)]
pub trait IpuItertools { pub trait IpuItertools {
fn ipu_flatten(&self) -> u32 { fn ipu_flatten(&self) -> u32 {

View File

@ -1,5 +1,5 @@
//@ run-pass //@ run-pass
#![feature(arbitrary_self_types)] #![feature(arbitrary_self_types_pointers)]
use std::rc::Rc; use std::rc::Rc;

View File

@ -1,5 +1,5 @@
//@ run-pass //@ run-pass
#![feature(arbitrary_self_types)] #![feature(arbitrary_self_types_pointers)]
use std::ptr; use std::ptr;