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