src/libcore/ptr.rs

   1 // Copyright 2012-2014 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 // FIXME: talk about offset, copy_memory, copy_nonoverlapping_memory
  12
  13 //! Operations on unsafe pointers, `*const T`, and `*mut T`.
  14 //!
  15 //! Working with unsafe pointers in Rust is uncommon,
  16 //! typically limited to a few patterns.
  17 //!
  18 //! Use the [`null` function](fn.null.html) to create null pointers,
  19 //! the [`is_null`](trait.PtrExt.html#tymethod.is_null)
  20 //! methods of the [`PtrExt` trait](trait.PtrExt.html) to check for null.
  21 //! The `PtrExt` trait is imported by the prelude, so `is_null` etc.
  22 //! work everywhere. The `PtrExt` also defines the `offset` method,
  23 //! for pointer math.
  24 //!
  25 //! # Common ways to create unsafe pointers
  26 //!
  27 //! ## 1. Coerce a reference (`&T`) or mutable reference (`&mut T`).
  28 //!
  29 //! ```
  30 //! let my_num: int = 10;
  31 //! let my_num_ptr: *const int = &my_num;
  32 //! let mut my_speed: int = 88;
  33 //! let my_speed_ptr: *mut int = &mut my_speed;
  34 //! ```
  35 //!
  36 //! This does not take ownership of the original allocation
  37 //! and requires no resource management later,
  38 //! but you must not use the pointer after its lifetime.
  39 //!
  40 //! ## 2. Transmute an owned box (`Box<T>`).
  41 //!
  42 //! The `transmute` function takes, by value, whatever it's given
  43 //! and returns it as whatever type is requested, as long as the
  44 //! types are the same size. Because `Box<T>` and `*mut T` have the same
  45 //! representation they can be trivially,
  46 //! though unsafely, transformed from one type to the other.
  47 //!
  48 //! ```
  49 //! use std::mem;
  50 //!
  51 //! unsafe {
  52 //!     let my_num: Box<int> = box 10;
  53 //!     let my_num: *const int = mem::transmute(my_num);
  54 //!     let my_speed: Box<int> = box 88;
  55 //!     let my_speed: *mut int = mem::transmute(my_speed);
  56 //!
  57 //!     // By taking ownership of the original `Box<T>` though
  58 //!     // we are obligated to transmute it back later to be destroyed.
  59 //!     drop(mem::transmute::<_, Box<int>>(my_speed));
  60 //!     drop(mem::transmute::<_, Box<int>>(my_num));
  61 //! }
  62 //! ```
  63 //!
  64 //! Note that here the call to `drop` is for clarity - it indicates
  65 //! that we are done with the given value and it should be destroyed.
  66 //!
  67 //! ## 3. Get it from C.
  68 //!
  69 //! ```
  70 //! extern crate libc;
  71 //!
  72 //! use std::mem;
  73 //!
  74 //! fn main() {
  75 //!     unsafe {
  76 //!         let my_num: *mut int = libc::malloc(mem::size_of::<int>() as libc::size_t) as *mut int;
  77 //!         if my_num.is_null() {
  78 //!             panic!("failed to allocate memory");
  79 //!         }
  80 //!         libc::free(my_num as *mut libc::c_void);
  81 //!     }
  82 //! }
  83 //! ```
  84 //!
  85 //! Usually you wouldn't literally use `malloc` and `free` from Rust,
  86 //! but C APIs hand out a lot of pointers generally, so are a common source
  87 //! of unsafe pointers in Rust.
  88
  89 #![stable]
  90
  91 use mem;
  92 use clone::Clone;
  93 use intrinsics;
  94 use option::Option::{self, Some, None};
  95 use kinds::{Send, Sized, Sync};
  96
  97 use cmp::{PartialEq, Eq, Ord, PartialOrd};
  98 use cmp::Ordering::{self, Less, Equal, Greater};
  99
 100 // FIXME #19649: instrinsic docs don't render, so these have no docs :(
 101
 102 #[unstable]
 103 pub use intrinsics::copy_nonoverlapping_memory;
 104
 105 #[unstable]
 106 pub use intrinsics::copy_memory;
 107
 108 #[experimental = "uncertain about naming and semantics"]
 109 pub use intrinsics::set_memory;
 110
 111
 112 /// Creates a null raw pointer.
 113 ///
 114 /// # Examples
 115 ///
 116 /// ```
 117 /// use std::ptr;
 118 ///
 119 /// let p: *const int = ptr::null();
 120 /// assert!(p.is_null());
 121 /// ```
 122 #[inline]
 123 #[stable]
 124 pub fn null<T>() -> *const T { 0 as *const T }
 125
 126 /// Creates a null mutable raw pointer.
 127 ///
 128 /// # Examples
 129 ///
 130 /// ```
 131 /// use std::ptr;
 132 ///
 133 /// let p: *mut int = ptr::null_mut();
 134 /// assert!(p.is_null());
 135 /// ```
 136 #[inline]
 137 #[stable]
 138 pub fn null_mut<T>() -> *mut T { 0 as *mut T }
 139
 140 /// Zeroes out `count * size_of::<T>` bytes of memory at `dst`. `count` may be
 141 /// `0`.
 142 ///
 143 /// # Safety
 144 ///
 145 /// Beyond accepting a raw pointer, this is unsafe because it will not drop the
 146 /// contents of `dst`, and may be used to create invalid instances of `T`.
 147 #[inline]
 148 #[unstable = "may play a larger role in std::ptr future extensions"]
 149 pub unsafe fn zero_memory<T>(dst: *mut T, count: uint) {
 150     set_memory(dst, 0, count);
 151 }
 152
 153 /// Swaps the values at two mutable locations of the same type, without
 154 /// deinitialising either. They may overlap, unlike `mem::swap` which is
 155 /// otherwise equivalent.
 156 ///
 157 /// # Safety
 158 ///
 159 /// This is only unsafe because it accepts a raw pointer.
 160 #[inline]
 161 #[stable]
 162 pub unsafe fn swap<T>(x: *mut T, y: *mut T) {
 163     // Give ourselves some scratch space to work with
 164     let mut tmp: T = mem::uninitialized();
 165     let t: *mut T = &mut tmp;
 166
 167     // Perform the swap
 168     copy_nonoverlapping_memory(t, &*x, 1);
 169     copy_memory(x, &*y, 1); // `x` and `y` may overlap
 170     copy_nonoverlapping_memory(y, &*t, 1);
 171
 172     // y and t now point to the same thing, but we need to completely forget `tmp`
 173     // because it's no longer relevant.
 174     mem::forget(tmp);
 175 }
 176
 177 /// Replaces the value at `dest` with `src`, returning the old
 178 /// value, without dropping either.
 179 ///
 180 /// # Safety
 181 ///
 182 /// This is only unsafe because it accepts a raw pointer.
 183 /// Otherwise, this operation is identical to `mem::replace`.
 184 #[inline]
 185 #[stable]
 186 pub unsafe fn replace<T>(dest: *mut T, mut src: T) -> T {
 187     mem::swap(mem::transmute(dest), &mut src); // cannot overlap
 188     src
 189 }
 190
 191 /// Reads the value from `src` without dropping it. This leaves the
 192 /// memory in `src` unchanged.
 193 ///
 194 /// # Safety
 195 ///
 196 /// Beyond accepting a raw pointer, this is unsafe because it semantically
 197 /// moves the value out of `src` without preventing further usage of `src`.
 198 /// If `T` is not `Copy`, then care must be taken to ensure that the value at
 199 /// `src` is not used before the data is overwritten again (e.g. with `write`,
 200 /// `zero_memory`, or `copy_memory`). Note that `*src = foo` counts as a use
 201 /// because it will attempt to drop the value previously at `*src`.
 202 #[inline(always)]
 203 #[stable]
 204 pub unsafe fn read<T>(src: *const T) -> T {
 205     let mut tmp: T = mem::uninitialized();
 206     copy_nonoverlapping_memory(&mut tmp, src, 1);
 207     tmp
 208 }
 209
 210 /// Reads the value from `src` and nulls it out without dropping it.
 211 ///
 212 /// # Safety
 213 ///
 214 /// This is unsafe for the same reasons that `read` is unsafe.
 215 #[inline(always)]
 216 #[unstable = "may play a larger role in std::ptr future extensions"]
 217 pub unsafe fn read_and_zero<T>(dest: *mut T) -> T {
 218     // Copy the data out from `dest`:
 219     let tmp = read(&*dest);
 220
 221     // Now zero out `dest`:
 222     zero_memory(dest, 1);
 223
 224     tmp
 225 }
 226
 227 /// Overwrites a memory location with the given value without reading or
 228 /// dropping the old value.
 229 ///
 230 /// # Safety
 231 ///
 232 /// Beyond accepting a raw pointer, this operation is unsafe because it does
 233 /// not drop the contents of `dst`. This could leak allocations or resources,
 234 /// so care must be taken not to overwrite an object that should be dropped.
 235 ///
 236 /// This is appropriate for initializing uninitialized memory, or overwritting
 237 /// memory that has previously been `read` from.
 238 #[inline]
 239 #[stable]
 240 pub unsafe fn write<T>(dst: *mut T, src: T) {
 241     intrinsics::move_val_init(&mut *dst, src)
 242 }
 243
 244 /// Methods on raw pointers
 245 #[stable]
 246 pub trait PtrExt: Sized {
 247     type Target;
 248
 249     /// Returns true if the pointer is null.
 250     #[stable]
 251     fn is_null(self) -> bool;
 252
 253     /// Returns `None` if the pointer is null, or else returns a reference to
 254     /// the value wrapped in `Some`.
 255     ///
 256     /// # Safety
 257     ///
 258     /// While this method and its mutable counterpart are useful for
 259     /// null-safety, it is important to note that this is still an unsafe
 260     /// operation because the returned value could be pointing to invalid
 261     /// memory.
 262     #[unstable = "Option is not clearly the right return type, and we may want \
 263                   to tie the return lifetime to a borrow of the raw pointer"]
 264     unsafe fn as_ref<'a>(&self) -> Option<&'a Self::Target>;
 265
 266     /// Calculates the offset from a pointer. `count` is in units of T; e.g. a
 267     /// `count` of 3 represents a pointer offset of `3 * sizeof::<T>()` bytes.
 268     ///
 269     /// # Safety
 270     ///
 271     /// The offset must be in-bounds of the object, or one-byte-past-the-end.
 272     /// Otherwise `offset` invokes Undefined Behaviour, regardless of whether
 273     /// the pointer is used.
 274     #[stable]
 275     unsafe fn offset(self, count: int) -> Self;
 276 }
 277
 278 /// Methods on mutable raw pointers
 279 #[stable]
 280 pub trait MutPtrExt {
 281     type Target;
 282
 283     /// Returns `None` if the pointer is null, or else returns a mutable
 284     /// reference to the value wrapped in `Some`.
 285     ///
 286     /// # Safety
 287     ///
 288     /// As with `as_ref`, this is unsafe because it cannot verify the validity
 289     /// of the returned pointer.
 290     #[unstable = "Option is not clearly the right return type, and we may want \
 291                   to tie the return lifetime to a borrow of the raw pointer"]
 292     unsafe fn as_mut<'a>(&self) -> Option<&'a mut Self::Target>;
 293 }
 294
 295 #[stable]
 296 impl<T> PtrExt for *const T {
 297     type Target = T;
 298
 299     #[inline]
 300     #[stable]
 301     fn is_null(self) -> bool { self as uint == 0 }
 302
 303     #[inline]
 304     #[stable]
 305     unsafe fn offset(self, count: int) -> *const T {
 306         intrinsics::offset(self, count)
 307     }
 308
 309     #[inline]
 310     #[unstable = "return value does not necessarily convey all possible \
 311                   information"]
 312     unsafe fn as_ref<'a>(&self) -> Option<&'a T> {
 313         if self.is_null() {
 314             None
 315         } else {
 316             Some(&**self)
 317         }
 318     }
 319 }
 320
 321 #[stable]
 322 impl<T> PtrExt for *mut T {
 323     type Target = T;
 324
 325     #[inline]
 326     #[stable]
 327     fn is_null(self) -> bool { self as uint == 0 }
 328
 329     #[inline]
 330     #[stable]
 331     unsafe fn offset(self, count: int) -> *mut T {
 332         intrinsics::offset(self as *const T, count) as *mut T
 333     }
 334
 335     #[inline]
 336     #[unstable = "return value does not necessarily convey all possible \
 337                   information"]
 338     unsafe fn as_ref<'a>(&self) -> Option<&'a T> {
 339         if self.is_null() {
 340             None
 341         } else {
 342             Some(&**self)
 343         }
 344     }
 345 }
 346
 347 #[stable]
 348 impl<T> MutPtrExt for *mut T {
 349     type Target = T;
 350
 351     #[inline]
 352     #[unstable = "return value does not necessarily convey all possible \
 353                   information"]
 354     unsafe fn as_mut<'a>(&self) -> Option<&'a mut T> {
 355         if self.is_null() {
 356             None
 357         } else {
 358             Some(&mut **self)
 359         }
 360     }
 361 }
 362
 363 // Equality for pointers
 364 #[stable]
 365 impl<T> PartialEq for *const T {
 366     #[inline]
 367     fn eq(&self, other: &*const T) -> bool {
 368         *self == *other
 369     }
 370     #[inline]
 371     fn ne(&self, other: &*const T) -> bool { !self.eq(other) }
 372 }
 373
 374 #[stable]
 375 impl<T> Eq for *const T {}
 376
 377 #[stable]
 378 impl<T> PartialEq for *mut T {
 379     #[inline]
 380     fn eq(&self, other: &*mut T) -> bool {
 381         *self == *other
 382     }
 383     #[inline]
 384     fn ne(&self, other: &*mut T) -> bool { !self.eq(other) }
 385 }
 386
 387 #[stable]
 388 impl<T> Eq for *mut T {}
 389
 390 #[stable]
 391 impl<T> Clone for *const T {
 392     #[inline]
 393     fn clone(&self) -> *const T {
 394         *self
 395     }
 396 }
 397
 398 #[stable]
 399 impl<T> Clone for *mut T {
 400     #[inline]
 401     fn clone(&self) -> *mut T {
 402         *self
 403     }
 404 }
 405
 406 // Equality for extern "C" fn pointers
 407 mod externfnpointers {
 408     use mem;
 409     use cmp::PartialEq;
 410
 411     #[stable]
 412     impl<_R> PartialEq for extern "C" fn() -> _R {
 413         #[inline]
 414         fn eq(&self, other: &extern "C" fn() -> _R) -> bool {
 415             let self_: *const () = unsafe { mem::transmute(*self) };
 416             let other_: *const () = unsafe { mem::transmute(*other) };
 417             self_ == other_
 418         }
 419     }
 420     macro_rules! fnptreq {
 421         ($($p:ident),*) => {
 422             #[stable]
 423             impl<_R,$($p),*> PartialEq for extern "C" fn($($p),*) -> _R {
 424                 #[inline]
 425                 fn eq(&self, other: &extern "C" fn($($p),*) -> _R) -> bool {
 426                     let self_: *const () = unsafe { mem::transmute(*self) };
 427
 428                     let other_: *const () = unsafe { mem::transmute(*other) };
 429                     self_ == other_
 430                 }
 431             }
 432         }
 433     }
 434     fnptreq! { A }
 435     fnptreq! { A,B }
 436     fnptreq! { A,B,C }
 437     fnptreq! { A,B,C,D }
 438     fnptreq! { A,B,C,D,E }
 439 }
 440
 441 // Comparison for pointers
 442 #[stable]
 443 impl<T> Ord for *const T {
 444     #[inline]
 445     fn cmp(&self, other: &*const T) -> Ordering {
 446         if self < other {
 447             Less
 448         } else if self == other {
 449             Equal
 450         } else {
 451             Greater
 452         }
 453     }
 454 }
 455
 456 #[stable]
 457 impl<T> PartialOrd for *const T {
 458     #[inline]
 459     fn partial_cmp(&self, other: &*const T) -> Option<Ordering> {
 460         Some(self.cmp(other))
 461     }
 462
 463     #[inline]
 464     fn lt(&self, other: &*const T) -> bool { *self < *other }
 465
 466     #[inline]
 467     fn le(&self, other: &*const T) -> bool { *self <= *other }
 468
 469     #[inline]
 470     fn gt(&self, other: &*const T) -> bool { *self > *other }
 471
 472     #[inline]
 473     fn ge(&self, other: &*const T) -> bool { *self >= *other }
 474 }
 475
 476 #[stable]
 477 impl<T> Ord for *mut T {
 478     #[inline]
 479     fn cmp(&self, other: &*mut T) -> Ordering {
 480         if self < other {
 481             Less
 482         } else if self == other {
 483             Equal
 484         } else {
 485             Greater
 486         }
 487     }
 488 }
 489
 490 #[stable]
 491 impl<T> PartialOrd for *mut T {
 492     #[inline]
 493     fn partial_cmp(&self, other: &*mut T) -> Option<Ordering> {
 494         Some(self.cmp(other))
 495     }
 496
 497     #[inline]
 498     fn lt(&self, other: &*mut T) -> bool { *self < *other }
 499
 500     #[inline]
 501     fn le(&self, other: &*mut T) -> bool { *self <= *other }
 502
 503     #[inline]
 504     fn gt(&self, other: &*mut T) -> bool { *self > *other }
 505
 506     #[inline]
 507     fn ge(&self, other: &*mut T) -> bool { *self >= *other }
 508 }
 509
 510 /// A wrapper around a raw `*mut T` that indicates that the possessor
 511 /// of this wrapper owns the referent. This in turn implies that the
 512 /// `Unique<T>` is `Send`/`Sync` if `T` is `Send`/`Sync`, unlike a
 513 /// raw `*mut T` (which conveys no particular ownership semantics).
 514 /// Useful for building abstractions like `Vec<T>` or `Box<T>`, which
 515 /// internally use raw pointers to manage the memory that they own.
 516 #[unstable = "recently added to this module"]
 517 pub struct Unique<T>(pub *mut T);
 518
 519 /// `Unique` pointers are `Send` if `T` is `Send` because the data they
 520 /// reference is unaliased. Note that this aliasing invariant is
 521 /// unenforced by the type system; the abstraction using the
 522 /// `Unique` must enforce it.
 523 #[unstable = "recently added to this module"]
 524 unsafe impl<T:Send> Send for Unique<T> { }
 525
 526 /// `Unique` pointers are `Sync` if `T` is `Sync` because the data they
 527 /// reference is unaliased. Note that this aliasing invariant is
 528 /// unenforced by the type system; the abstraction using the
 529 /// `Unique` must enforce it.
 530 #[unstable = "recently added to this module"]
 531 unsafe impl<T:Sync> Sync for Unique<T> { }
 532
 533 impl<T> Unique<T> {
 534     /// Returns a null Unique.
 535     #[unstable = "recently added to this module"]
 536     pub fn null() -> Unique<T> {
 537         Unique(null_mut())
 538     }
 539
 540     /// Return an (unsafe) pointer into the memory owned by `self`.
 541     #[unstable = "recently added to this module"]
 542     pub unsafe fn offset(self, offset: int) -> *mut T {
 543         self.0.offset(offset)
 544     }
 545 }