Skip to content

Add ManuallyDrop lang item for precise control of destructors #19822

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions src/libcore/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,7 @@ pub mod prelude;
/* Core modules for ownership management */

pub mod intrinsics;
pub mod manually_drop;
pub mod mem;
pub mod ptr;

Expand Down
57 changes: 57 additions & 0 deletions src/libcore/manually_drop.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
// Copyright 2012-2014 The Rust Project Developers. See the COPYRIGHT
// file at the top-level directory of this distribution and at
// http://rust-lang.org/COPYRIGHT.
//
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
// option. This file may not be copied, modified, or distributed
// except according to those terms.

//! Exposes the `ManuallyDrop` lang item for controlling the exactly what gets dropped within a
//! structure.

/// A wrapper type that stores data inline without running its destructor when dropped.
#[lang="manually_drop"]
#[experimental]
pub struct ManuallyDrop<T> {
/// Wrapped value
///
/// This field should not be accessed directly, it is made public for static
/// initializers.
#[unstable]
pub value: T,
}

impl<T> ManuallyDrop<T> {
/// Construct a new instance of `ManuallyDrop` which will wrap the specified
/// value.
///
/// All access to the inner value through methods is `unsafe`, and it is
/// highly discouraged to access the fields directly.
///
/// This function is unsafe for the same reason as `forget`, namely that it
/// prevents the value's destructors from running.
#[experimental]
pub unsafe fn new(value: T) -> ManuallyDrop<T> {
ManuallyDrop { value: value }
}

/// Gets a mutable pointer to the wrapped value.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Presumably this should be on get_mut, which actually doesn't seem to be implemented?

///
/// This function is unsafe as the pointer returned is an unsafe pointer and
/// no guarantees are made about the aliasing of the pointers being handed
/// out in this or other tasks.
#[experimental]
pub unsafe fn get(&self) -> *const T {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The RFC also has this marked safe, fwiw.

&self.value as *const T
}

/// Unwraps the value
///
/// This function is unsafe because there is no guarantee that this or other
/// tasks are currently inspecting the inner value. Additionally, the destructor
/// for the inner value is suddenly rescheduled to run.
#[experimental]
pub unsafe fn into_inner(self) -> T { self.value }
}
4 changes: 3 additions & 1 deletion src/librustc/middle/lang_items.rs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright 2012 The Rust Project Developers. See the COPYRIGHT
// Copyright 2012-2014 The Rust Project Developers. See the COPYRIGHT
// file at the top-level directory of this distribution and at
// http://rust-lang.org/COPYRIGHT.
//
Expand Down Expand Up @@ -256,6 +256,8 @@ lets_do_this! {

UnsafeTypeLangItem, "unsafe", unsafe_type;

ManuallyDropLangItem, "manually_drop", manually_drop;

DerefTraitLangItem, "deref", deref_trait;
DerefMutTraitLangItem, "deref_mut", deref_mut_trait;

Expand Down
2 changes: 2 additions & 0 deletions src/librustc/middle/ty.rs
Original file line number Diff line number Diff line change
Expand Up @@ -3106,6 +3106,8 @@ pub fn type_contents<'tcx>(cx: &ctxt<'tcx>, ty: Ty<'tcx>) -> TypeContents {
tc | TC::Managed
} else if Some(did) == cx.lang_items.unsafe_type() {
tc | TC::InteriorUnsafe
} else if Some(did) == cx.lang_items.manually_drop() {
tc - TC::OwnsDtor
} else {
tc
}
Expand Down
37 changes: 37 additions & 0 deletions src/test/run-pass/manually_drop.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
// Copyright 2014 The Rust Project Developers. See the COPYRIGHT
// file at the top-level directory of this distribution and at
// http://rust-lang.org/COPYRIGHT.
//
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
// option. This file may not be copied, modified, or distributed
// except according to those terms.
extern crate core;

static mut value: uint = 0;

struct Canary;

impl Drop for Canary {
fn drop(&mut self) {
unsafe {
value += 1;
}
}
}

fn main() {
unsafe {
assert_eq!(value, 0);

{ Canary; }
assert_eq!(value, 1);

{ core::manually_drop::ManuallyDrop::new(Canary); }
assert_eq!(value, 1);

{ core::manually_drop::ManuallyDrop::new(Canary).into_inner(); }
assert_eq!(value, 2);
}
}