src/liballoc/boxed.rs

   1 // Copyright 2012-2015 The Rust Project Developers. See the COPYRIGHT
   2 // file at the top-level directory of this distribution and at
   3 // http://rust-lang.org/COPYRIGHT.
   4 //
   5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
   6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
   7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
   8 // option. This file may not be copied, modified, or distributed
   9 // except according to those terms.
  10
  11 //! A pointer type for heap allocation.
  12 //!
  13 //! `Box<T>`, casually referred to as a 'box', provides the simplest form of
  14 //! heap allocation in Rust. Boxes provide ownership for this allocation, and
  15 //! drop their contents when they go out of scope.
  16 //!
  17 //! # Examples
  18 //!
  19 //! Creating a box:
  20 //!
  21 //! ```
  22 //! let x = Box::new(5);
  23 //! ```
  24 //!
  25 //! Creating a recursive data structure:
  26 //!
  27 //! ```
  28 //! #[derive(Debug)]
  29 //! enum List<T> {
  30 //!     Cons(T, Box<List<T>>),
  31 //!     Nil,
  32 //! }
  33 //!
  34 //! fn main() {
  35 //!     let list: List<i32> = List::Cons(1, Box::new(List::Cons(2, Box::new(List::Nil))));
  36 //!     println!("{:?}", list);
  37 //! }
  38 //! ```
  39 //!
  40 //! This will print `Cons(1, Cons(2, Nil))`.
  41 //!
  42 //! Recursive structures must be boxed, because if the definition of `Cons`
  43 //! looked like this:
  44 //!
  45 //! ```rust,ignore
  46 //! Cons(T, List<T>),
  47 //! ```
  48 //!
  49 //! It wouldn't work. This is because the size of a `List` depends on how many
  50 //! elements are in the list, and so we don't know how much memory to allocate
  51 //! for a `Cons`. By introducing a `Box`, which has a defined size, we know how
  52 //! big `Cons` needs to be.
  53
  54 #![stable(feature = "rust1", since = "1.0.0")]
  55
  56 use heap;
  57 use raw_vec::RawVec;
  58
  59 use core::any::Any;
  60 use core::cmp::Ordering;
  61 use core::fmt;
  62 use core::hash::{self, Hash};
  63 use core::marker::{self, Unsize};
  64 use core::mem;
  65 use core::ops::{CoerceUnsized, Deref, DerefMut};
  66 use core::ops::{Placer, Boxed, Place, InPlace, BoxPlace};
  67 use core::ptr::{self, Unique};
  68 use core::raw::{TraitObject};
  69
  70 /// A value that represents the heap. This is the default place that the `box`
  71 /// keyword allocates into when no place is supplied.
  72 ///
  73 /// The following two examples are equivalent:
  74 ///
  75 /// ```
  76 /// #![feature(box_heap)]
  77 ///
  78 /// #![feature(box_syntax, placement_in_syntax)]
  79 /// use std::boxed::HEAP;
  80 ///
  81 /// fn main() {
  82 ///     let foo = box(HEAP) 5;
  83 ///     let foo = box 5;
  84 /// }
  85 /// ```
  86 #[lang = "exchange_heap"]
  87 #[unstable(feature = "box_heap",
  88            reason = "may be renamed; uncertain about custom allocator design",
  89            issue = "27779")]
  90 pub const HEAP: ExchangeHeapSingleton =
  91     ExchangeHeapSingleton { _force_singleton: () };
  92
  93 /// This the singleton type used solely for `boxed::HEAP`.
  94 #[unstable(feature = "box_heap",
  95            reason = "may be renamed; uncertain about custom allocator design",
  96            issue = "27779")]
  97 #[derive(Copy, Clone)]
  98 pub struct ExchangeHeapSingleton { _force_singleton: () }
  99
 100 /// A pointer type for heap allocation.
 101 ///
 102 /// See the [module-level documentation](../../std/boxed/index.html) for more.
 103 #[lang = "owned_box"]
 104 #[stable(feature = "rust1", since = "1.0.0")]
 105 #[fundamental]
 106 pub struct Box<T: ?Sized>(Unique<T>);
 107
 108 /// `IntermediateBox` represents uninitialized backing storage for `Box`.
 109 ///
 110 /// FIXME (pnkfelix): Ideally we would just reuse `Box<T>` instead of
 111 /// introducing a separate `IntermediateBox<T>`; but then you hit
 112 /// issues when you e.g. attempt to destructure an instance of `Box`,
 113 /// since it is a lang item and so it gets special handling by the
 114 /// compiler.  Easier just to make this parallel type for now.
 115 ///
 116 /// FIXME (pnkfelix): Currently the `box` protocol only supports
 117 /// creating instances of sized types. This IntermediateBox is
 118 /// designed to be forward-compatible with a future protocol that
 119 /// supports creating instances of unsized types; that is why the type
 120 /// parameter has the `?Sized` generalization marker, and is also why
 121 /// this carries an explicit size. However, it probably does not need
 122 /// to carry the explicit alignment; that is just a work-around for
 123 /// the fact that the `align_of` intrinsic currently requires the
 124 /// input type to be Sized (which I do not think is strictly
 125 /// necessary).
 126 #[unstable(feature = "placement_in",
 127            reason = "placement box design is still being worked out.",
 128            issue = "27779")]
 129 pub struct IntermediateBox<T: ?Sized>{
 130     ptr: *mut u8,
 131     size: usize,
 132     align: usize,
 133     marker: marker::PhantomData<*mut T>,
 134 }
 135
 136 impl<T> Place<T> for IntermediateBox<T> {
 137     fn pointer(&mut self) -> *mut T {
 138         unsafe { ::core::mem::transmute(self.ptr) }
 139     }
 140 }
 141
 142 unsafe fn finalize<T>(b: IntermediateBox<T>) -> Box<T> {
 143     let p = b.ptr as *mut T;
 144     mem::forget(b);
 145     mem::transmute(p)
 146 }
 147
 148 fn make_place<T>() -> IntermediateBox<T> {
 149     let size = mem::size_of::<T>();
 150     let align = mem::align_of::<T>();
 151
 152     let p = if size == 0 {
 153         heap::EMPTY as *mut u8
 154     } else {
 155         let p = unsafe {
 156             heap::allocate(size, align)
 157         };
 158         if p.is_null() {
 159             panic!("Box make_place allocation failure.");
 160         }
 161         p
 162     };
 163
 164     IntermediateBox { ptr: p, size: size, align: align, marker: marker::PhantomData }
 165 }
 166
 167 impl<T> BoxPlace<T> for IntermediateBox<T> {
 168     fn make_place() -> IntermediateBox<T> { make_place() }
 169 }
 170
 171 impl<T> InPlace<T> for IntermediateBox<T> {
 172     type Owner = Box<T>;
 173     unsafe fn finalize(self) -> Box<T> { finalize(self) }
 174 }
 175
 176 impl<T> Boxed for Box<T> {
 177     type Data = T;
 178     type Place = IntermediateBox<T>;
 179     unsafe fn finalize(b: IntermediateBox<T>) -> Box<T> { finalize(b) }
 180 }
 181
 182 impl<T> Placer<T> for ExchangeHeapSingleton {
 183     type Place = IntermediateBox<T>;
 184
 185     fn make_place(self) -> IntermediateBox<T> {
 186         make_place()
 187     }
 188 }
 189
 190 impl<T: ?Sized> Drop for IntermediateBox<T> {
 191     fn drop(&mut self) {
 192         if self.size > 0 {
 193             unsafe {
 194                 heap::deallocate(self.ptr, self.size, self.align)
 195             }
 196         }
 197     }
 198 }
 199
 200 impl<T> Box<T> {
 201     /// Allocates memory on the heap and then moves `x` into it.
 202     ///
 203     /// # Examples
 204     ///
 205     /// ```
 206     /// let x = Box::new(5);
 207     /// ```
 208     #[stable(feature = "rust1", since = "1.0.0")]
 209     #[inline(always)]
 210     pub fn new(x: T) -> Box<T> {
 211         box x
 212     }
 213 }
 214
 215 impl<T : ?Sized> Box<T> {
 216     /// Constructs a box from the raw pointer.
 217     ///
 218     /// After this function call, pointer is owned by resulting box.
 219     /// In particular, it means that `Box` destructor calls destructor
 220     /// of `T` and releases memory. Since the way `Box` allocates and
 221     /// releases memory is unspecified, the only valid pointer to pass
 222     /// to this function is the one taken from another `Box` with
 223     /// `Box::into_raw` function.
 224     ///
 225     /// Function is unsafe, because improper use of this function may
 226     /// lead to memory problems like double-free, for example if the
 227     /// function is called twice on the same raw pointer.
 228     #[unstable(feature = "box_raw",
 229                reason = "may be renamed or moved out of Box scope",
 230                issue = "27768")]
 231     #[inline]
 232     // NB: may want to be called from_ptr, see comments on CStr::from_ptr
 233     pub unsafe fn from_raw(raw: *mut T) -> Self {
 234         mem::transmute(raw)
 235     }
 236
 237     /// Consumes the `Box`, returning the wrapped raw pointer.
 238     ///
 239     /// After call to this function, caller is responsible for the memory
 240     /// previously managed by `Box`, in particular caller should properly
 241     /// destroy `T` and release memory. The proper way to do it is to
 242     /// convert pointer back to `Box` with `Box::from_raw` function, because
 243     /// `Box` does not specify, how memory is allocated.
 244     ///
 245     /// # Examples
 246     /// ```
 247     /// #![feature(box_raw)]
 248     ///
 249     /// let seventeen = Box::new(17u32);
 250     /// let raw = Box::into_raw(seventeen);
 251     /// let boxed_again = unsafe { Box::from_raw(raw) };
 252     /// ```
 253     #[unstable(feature = "box_raw", reason = "may be renamed",
 254                issue = "27768")]
 255     #[inline]
 256     // NB: may want to be called into_ptr, see comments on CStr::from_ptr
 257     pub fn into_raw(b: Box<T>) -> *mut T {
 258         unsafe { mem::transmute(b) }
 259     }
 260 }
 261
 262 #[stable(feature = "rust1", since = "1.0.0")]
 263 impl<T: Default> Default for Box<T> {
 264     #[stable(feature = "rust1", since = "1.0.0")]
 265     fn default() -> Box<T> { box Default::default() }
 266 }
 267
 268 #[stable(feature = "rust1", since = "1.0.0")]
 269 impl<T> Default for Box<[T]> {
 270     #[stable(feature = "rust1", since = "1.0.0")]
 271     fn default() -> Box<[T]> { Box::<[T; 0]>::new([]) }
 272 }
 273
 274 #[stable(feature = "rust1", since = "1.0.0")]
 275 impl<T: Clone> Clone for Box<T> {
 276     /// Returns a new box with a `clone()` of this box's contents.
 277     ///
 278     /// # Examples
 279     ///
 280     /// ```
 281     /// let x = Box::new(5);
 282     /// let y = x.clone();
 283     /// ```
 284     #[inline]
 285     fn clone(&self) -> Box<T> { box {(**self).clone()} }
 286     /// Copies `source`'s contents into `self` without creating a new allocation.
 287     ///
 288     /// # Examples
 289     ///
 290     /// ```
 291     /// #![feature(box_raw)]
 292     ///
 293     /// let x = Box::new(5);
 294     /// let mut y = Box::new(10);
 295     ///
 296     /// y.clone_from(&x);
 297     ///
 298     /// assert_eq!(*y, 5);
 299     /// ```
 300     #[inline]
 301     fn clone_from(&mut self, source: &Box<T>) {
 302         (**self).clone_from(&(**source));
 303     }
 304 }
 305
 306
 307 #[stable(feature = "box_slice_clone", since = "1.3.0")]
 308 impl Clone for Box<str> {
 309     fn clone(&self) -> Self {
 310         let len = self.len();
 311         let buf = RawVec::with_capacity(len);
 312         unsafe {
 313             ptr::copy_nonoverlapping(self.as_ptr(), buf.ptr(), len);
 314             mem::transmute(buf.into_box()) // bytes to str ~magic
 315         }
 316     }
 317 }
 318
 319 #[stable(feature = "rust1", since = "1.0.0")]
 320 impl<T: ?Sized + PartialEq> PartialEq for Box<T> {
 321     #[inline]
 322     fn eq(&self, other: &Box<T>) -> bool { PartialEq::eq(&**self, &**other) }
 323     #[inline]
 324     fn ne(&self, other: &Box<T>) -> bool { PartialEq::ne(&**self, &**other) }
 325 }
 326 #[stable(feature = "rust1", since = "1.0.0")]
 327 impl<T: ?Sized + PartialOrd> PartialOrd for Box<T> {
 328     #[inline]
 329     fn partial_cmp(&self, other: &Box<T>) -> Option<Ordering> {
 330         PartialOrd::partial_cmp(&**self, &**other)
 331     }
 332     #[inline]
 333     fn lt(&self, other: &Box<T>) -> bool { PartialOrd::lt(&**self, &**other) }
 334     #[inline]
 335     fn le(&self, other: &Box<T>) -> bool { PartialOrd::le(&**self, &**other) }
 336     #[inline]
 337     fn ge(&self, other: &Box<T>) -> bool { PartialOrd::ge(&**self, &**other) }
 338     #[inline]
 339     fn gt(&self, other: &Box<T>) -> bool { PartialOrd::gt(&**self, &**other) }
 340 }
 341 #[stable(feature = "rust1", since = "1.0.0")]
 342 impl<T: ?Sized + Ord> Ord for Box<T> {
 343     #[inline]
 344     fn cmp(&self, other: &Box<T>) -> Ordering {
 345         Ord::cmp(&**self, &**other)
 346     }
 347 }
 348 #[stable(feature = "rust1", since = "1.0.0")]
 349 impl<T: ?Sized + Eq> Eq for Box<T> {}
 350
 351 #[stable(feature = "rust1", since = "1.0.0")]
 352 impl<T: ?Sized + Hash> Hash for Box<T> {
 353     fn hash<H: hash::Hasher>(&self, state: &mut H) {
 354         (**self).hash(state);
 355     }
 356 }
 357
 358 impl Box<Any> {
 359     #[inline]
 360     #[stable(feature = "rust1", since = "1.0.0")]
 361     /// Attempt to downcast the box to a concrete type.
 362     pub fn downcast<T: Any>(self) -> Result<Box<T>, Box<Any>> {
 363         if self.is::<T>() {
 364             unsafe {
 365                 // Get the raw representation of the trait object
 366                 let raw = Box::into_raw(self);
 367                 let to: TraitObject =
 368                     mem::transmute::<*mut Any, TraitObject>(raw);
 369
 370                 // Extract the data pointer
 371                 Ok(Box::from_raw(to.data as *mut T))
 372             }
 373         } else {
 374             Err(self)
 375         }
 376     }
 377 }
 378
 379 impl Box<Any + Send> {
 380     #[inline]
 381     #[stable(feature = "rust1", since = "1.0.0")]
 382     /// Attempt to downcast the box to a concrete type.
 383     pub fn downcast<T: Any>(self) -> Result<Box<T>, Box<Any + Send>> {
 384         <Box<Any>>::downcast(self).map_err(|s| unsafe {
 385             // reapply the Send marker
 386             mem::transmute::<Box<Any>, Box<Any + Send>>(s)
 387         })
 388     }
 389 }
 390
 391 #[stable(feature = "rust1", since = "1.0.0")]
 392 impl<T: fmt::Display + ?Sized> fmt::Display for Box<T> {
 393     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
 394         fmt::Display::fmt(&**self, f)
 395     }
 396 }
 397
 398 #[stable(feature = "rust1", since = "1.0.0")]
 399 impl<T: fmt::Debug + ?Sized> fmt::Debug for Box<T> {
 400     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
 401         fmt::Debug::fmt(&**self, f)
 402     }
 403 }
 404
 405 #[stable(feature = "rust1", since = "1.0.0")]
 406 impl<T> fmt::Pointer for Box<T> {
 407     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
 408         // It's not possible to extract the inner Uniq directly from the Box,
 409         // instead we cast it to a *const which aliases the Unique
 410         let ptr: *const T = &**self;
 411         fmt::Pointer::fmt(&ptr, f)
 412     }
 413 }
 414
 415 #[stable(feature = "rust1", since = "1.0.0")]
 416 impl<T: ?Sized> Deref for Box<T> {
 417     type Target = T;
 418
 419     fn deref(&self) -> &T { &**self }
 420 }
 421
 422 #[stable(feature = "rust1", since = "1.0.0")]
 423 impl<T: ?Sized> DerefMut for Box<T> {
 424     fn deref_mut(&mut self) -> &mut T { &mut **self }
 425 }
 426
 427 #[stable(feature = "rust1", since = "1.0.0")]
 428 impl<I: Iterator + ?Sized> Iterator for Box<I> {
 429     type Item = I::Item;
 430     fn next(&mut self) -> Option<I::Item> { (**self).next() }
 431     fn size_hint(&self) -> (usize, Option<usize>) { (**self).size_hint() }
 432 }
 433 #[stable(feature = "rust1", since = "1.0.0")]
 434 impl<I: DoubleEndedIterator + ?Sized> DoubleEndedIterator for Box<I> {
 435     fn next_back(&mut self) -> Option<I::Item> { (**self).next_back() }
 436 }
 437 #[stable(feature = "rust1", since = "1.0.0")]
 438 impl<I: ExactSizeIterator + ?Sized> ExactSizeIterator for Box<I> {}
 439
 440
 441 /// `FnBox` is a version of the `FnOnce` intended for use with boxed
 442 /// closure objects. The idea is that where one would normally store a
 443 /// `Box<FnOnce()>` in a data structure, you should use
 444 /// `Box<FnBox()>`. The two traits behave essentially the same, except
 445 /// that a `FnBox` closure can only be called if it is boxed. (Note
 446 /// that `FnBox` may be deprecated in the future if `Box<FnOnce()>`
 447 /// closures become directly usable.)
 448 ///
 449 /// ### Example
 450 ///
 451 /// Here is a snippet of code which creates a hashmap full of boxed
 452 /// once closures and then removes them one by one, calling each
 453 /// closure as it is removed. Note that the type of the closures
 454 /// stored in the map is `Box<FnBox() -> i32>` and not `Box<FnOnce()
 455 /// -> i32>`.
 456 ///
 457 /// ```
 458 /// #![feature(fnbox)]
 459 ///
 460 /// use std::boxed::FnBox;
 461 /// use std::collections::HashMap;
 462 ///
 463 /// fn make_map() -> HashMap<i32, Box<FnBox() -> i32>> {
 464 ///     let mut map: HashMap<i32, Box<FnBox() -> i32>> = HashMap::new();
 465 ///     map.insert(1, Box::new(|| 22));
 466 ///     map.insert(2, Box::new(|| 44));
 467 ///     map
 468 /// }
 469 ///
 470 /// fn main() {
 471 ///     let mut map = make_map();
 472 ///     for i in &[1, 2] {
 473 ///         let f = map.remove(&i).unwrap();
 474 ///         assert_eq!(f(), i * 22);
 475 ///     }
 476 /// }
 477 /// ```
 478 #[rustc_paren_sugar]
 479 #[unstable(feature = "fnbox", reason = "Newly introduced", issue = "0")]
 480 pub trait FnBox<A> {
 481     type Output;
 482
 483     fn call_box(self: Box<Self>, args: A) -> Self::Output;
 484 }
 485
 486 impl<A,F> FnBox<A> for F
 487     where F: FnOnce<A>
 488 {
 489     type Output = F::Output;
 490
 491     fn call_box(self: Box<F>, args: A) -> F::Output {
 492         self.call_once(args)
 493     }
 494 }
 495
 496 impl<'a,A,R> FnOnce<A> for Box<FnBox<A,Output=R>+'a> {
 497     type Output = R;
 498
 499     extern "rust-call" fn call_once(self, args: A) -> R {
 500         self.call_box(args)
 501     }
 502 }
 503
 504 impl<'a,A,R> FnOnce<A> for Box<FnBox<A,Output=R>+Send+'a> {
 505     type Output = R;
 506
 507     extern "rust-call" fn call_once(self, args: A) -> R {
 508         self.call_box(args)
 509     }
 510 }
 511
 512 impl<T: ?Sized+Unsize<U>, U: ?Sized> CoerceUnsized<Box<U>> for Box<T> {}
 513
 514 #[stable(feature = "box_slice_clone", since = "1.3.0")]
 515 impl<T: Clone> Clone for Box<[T]> {
 516     fn clone(&self) -> Self {
 517         let mut new = BoxBuilder {
 518             data: RawVec::with_capacity(self.len()),
 519             len: 0
 520         };
 521
 522         let mut target = new.data.ptr();
 523
 524         for item in self.iter() {
 525             unsafe {
 526                 ptr::write(target, item.clone());
 527                 target = target.offset(1);
 528             };
 529
 530             new.len += 1;
 531         }
 532
 533         return unsafe { new.into_box() };
 534
 535         // Helper type for responding to panics correctly.
 536         struct BoxBuilder<T> {
 537             data: RawVec<T>,
 538             len: usize,
 539         }
 540
 541         impl<T> BoxBuilder<T> {
 542             unsafe fn into_box(self) -> Box<[T]> {
 543                 let raw = ptr::read(&self.data);
 544                 mem::forget(self);
 545                 raw.into_box()
 546             }
 547         }
 548
 549         impl<T> Drop for BoxBuilder<T> {
 550             fn drop(&mut self) {
 551                 let mut data = self.data.ptr();
 552                 let max = unsafe { data.offset(self.len as isize) };
 553
 554                 while data != max {
 555                     unsafe {
 556                         ptr::read(data);
 557                         data = data.offset(1);
 558                     }
 559                 }
 560             }
 561         }
 562     }
 563 }
 564