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::{mod, Some, None};
  95 use kinds::{Send, Sync};
  96
  97 use cmp::{PartialEq, Eq, Ord, PartialOrd, Equiv};
  98 use cmp::Ordering::{mod, 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<T> {
 247     /// Returns the null pointer.
 248     #[deprecated = "call ptr::null instead"]
 249     fn null() -> Self;
 250
 251     /// Returns true if the pointer is null.
 252     #[stable]
 253     fn is_null(self) -> bool;
 254
 255     /// Returns true if the pointer is not equal to the null pointer.
 256     #[deprecated = "use !p.is_null() instead"]
 257     fn is_not_null(self) -> bool { !self.is_null() }
 258
 259     /// Returns true if the pointer is not null.
 260     #[deprecated = "use `as uint` instead"]
 261     fn to_uint(self) -> uint;
 262
 263     /// Returns `None` if the pointer is null, or else returns a reference to
 264     /// the value wrapped in `Some`.
 265     ///
 266     /// # Safety
 267     ///
 268     /// While this method and its mutable counterpart are useful for
 269     /// null-safety, it is important to note that this is still an unsafe
 270     /// operation because the returned value could be pointing to invalid
 271     /// memory.
 272     #[unstable = "Option is not clearly the right return type, and we may want \
 273                   to tie the return lifetime to a borrow of the raw pointer"]
 274     unsafe fn as_ref<'a>(&self) -> Option<&'a T>;
 275
 276     /// Calculates the offset from a pointer. `count` is in units of T; e.g. a
 277     /// `count` of 3 represents a pointer offset of `3 * sizeof::<T>()` bytes.
 278     ///
 279     /// # Safety
 280     ///
 281     /// The offset must be in-bounds of the object, or one-byte-past-the-end.
 282     /// Otherwise `offset` invokes Undefined Behaviour, regardless of whether
 283     /// the pointer is used.
 284     #[stable]
 285     unsafe fn offset(self, count: int) -> Self;
 286 }
 287
 288 /// Methods on mutable raw pointers
 289 #[stable]
 290 pub trait MutPtrExt<T>{
 291     /// Returns `None` if the pointer is null, or else returns a mutable
 292     /// reference to the value wrapped in `Some`.
 293     ///
 294     /// # Safety
 295     ///
 296     /// As with `as_ref`, this is unsafe because it cannot verify the validity
 297     /// of the returned pointer.
 298     #[unstable = "Option is not clearly the right return type, and we may want \
 299                   to tie the return lifetime to a borrow of the raw pointer"]
 300     unsafe fn as_mut<'a>(&self) -> Option<&'a mut T>;
 301 }
 302
 303 #[stable]
 304 impl<T> PtrExt<T> for *const T {
 305     #[inline]
 306     #[deprecated = "call ptr::null instead"]
 307     fn null() -> *const T { null() }
 308
 309     #[inline]
 310     #[stable]
 311     fn is_null(self) -> bool { self as uint == 0 }
 312
 313     #[inline]
 314     #[deprecated = "use `as uint` instead"]
 315     fn to_uint(self) -> uint { self as uint }
 316
 317     #[inline]
 318     #[stable]
 319     unsafe fn offset(self, count: int) -> *const T {
 320         intrinsics::offset(self, count)
 321     }
 322
 323     #[inline]
 324     #[unstable = "return value does not necessarily convey all possible \
 325                   information"]
 326     unsafe fn as_ref<'a>(&self) -> Option<&'a T> {
 327         if self.is_null() {
 328             None
 329         } else {
 330             Some(&**self)
 331         }
 332     }
 333 }
 334
 335 #[stable]
 336 impl<T> PtrExt<T> for *mut T {
 337     #[inline]
 338     #[deprecated = "call ptr::null instead"]
 339     fn null() -> *mut T { null_mut() }
 340
 341     #[inline]
 342     #[stable]
 343     fn is_null(self) -> bool { self as uint == 0 }
 344
 345     #[inline]
 346     #[deprecated = "use `as uint` instead"]
 347     fn to_uint(self) -> uint { self as uint }
 348
 349     #[inline]
 350     #[stable]
 351     unsafe fn offset(self, count: int) -> *mut T {
 352         intrinsics::offset(self as *const T, count) as *mut T
 353     }
 354
 355     #[inline]
 356     #[unstable = "return value does not necessarily convey all possible \
 357                   information"]
 358     unsafe fn as_ref<'a>(&self) -> Option<&'a T> {
 359         if self.is_null() {
 360             None
 361         } else {
 362             Some(&**self)
 363         }
 364     }
 365 }
 366
 367 #[stable]
 368 impl<T> MutPtrExt<T> for *mut T {
 369     #[inline]
 370     #[unstable = "return value does not necessarily convey all possible \
 371                   information"]
 372     unsafe fn as_mut<'a>(&self) -> Option<&'a mut T> {
 373         if self.is_null() {
 374             None
 375         } else {
 376             Some(&mut **self)
 377         }
 378     }
 379 }
 380
 381 // Equality for pointers
 382 #[stable]
 383 impl<T> PartialEq for *const T {
 384     #[inline]
 385     fn eq(&self, other: &*const T) -> bool {
 386         *self == *other
 387     }
 388     #[inline]
 389     fn ne(&self, other: &*const T) -> bool { !self.eq(other) }
 390 }
 391
 392 #[stable]
 393 impl<T> Eq for *const T {}
 394
 395 #[stable]
 396 impl<T> PartialEq for *mut T {
 397     #[inline]
 398     fn eq(&self, other: &*mut T) -> bool {
 399         *self == *other
 400     }
 401     #[inline]
 402     fn ne(&self, other: &*mut T) -> bool { !self.eq(other) }
 403 }
 404
 405 #[stable]
 406 impl<T> Eq for *mut T {}
 407
 408 // Equivalence for pointers
 409 #[allow(deprecated)]
 410 #[deprecated = "Use overloaded `core::cmp::PartialEq`"]
 411 impl<T> Equiv<*mut T> for *const T {
 412     fn equiv(&self, other: &*mut T) -> bool {
 413         self.to_uint() == other.to_uint()
 414     }
 415 }
 416
 417 #[allow(deprecated)]
 418 #[deprecated = "Use overloaded `core::cmp::PartialEq`"]
 419 impl<T> Equiv<*const T> for *mut T {
 420     fn equiv(&self, other: &*const T) -> bool {
 421         self.to_uint() == other.to_uint()
 422     }
 423 }
 424
 425 #[stable]
 426 impl<T> Clone for *const T {
 427     #[inline]
 428     fn clone(&self) -> *const T {
 429         *self
 430     }
 431 }
 432
 433 #[stable]
 434 impl<T> Clone for *mut T {
 435     #[inline]
 436     fn clone(&self) -> *mut T {
 437         *self
 438     }
 439 }
 440
 441 // Equality for extern "C" fn pointers
 442 mod externfnpointers {
 443     use mem;
 444     use cmp::PartialEq;
 445
 446     #[stable]
 447     impl<_R> PartialEq for extern "C" fn() -> _R {
 448         #[inline]
 449         fn eq(&self, other: &extern "C" fn() -> _R) -> bool {
 450             let self_: *const () = unsafe { mem::transmute(*self) };
 451             let other_: *const () = unsafe { mem::transmute(*other) };
 452             self_ == other_
 453         }
 454     }
 455     macro_rules! fnptreq {
 456         ($($p:ident),*) => {
 457             #[stable]
 458             impl<_R,$($p),*> PartialEq for extern "C" fn($($p),*) -> _R {
 459                 #[inline]
 460                 fn eq(&self, other: &extern "C" fn($($p),*) -> _R) -> bool {
 461                     let self_: *const () = unsafe { mem::transmute(*self) };
 462
 463                     let other_: *const () = unsafe { mem::transmute(*other) };
 464                     self_ == other_
 465                 }
 466             }
 467         }
 468     }
 469     fnptreq! { A }
 470     fnptreq! { A,B }
 471     fnptreq! { A,B,C }
 472     fnptreq! { A,B,C,D }
 473     fnptreq! { A,B,C,D,E }
 474 }
 475
 476 // Comparison for pointers
 477 #[stable]
 478 impl<T> Ord for *const T {
 479     #[inline]
 480     fn cmp(&self, other: &*const T) -> Ordering {
 481         if self < other {
 482             Less
 483         } else if self == other {
 484             Equal
 485         } else {
 486             Greater
 487         }
 488     }
 489 }
 490
 491 #[stable]
 492 impl<T> PartialOrd for *const T {
 493     #[inline]
 494     fn partial_cmp(&self, other: &*const T) -> Option<Ordering> {
 495         Some(self.cmp(other))
 496     }
 497
 498     #[inline]
 499     fn lt(&self, other: &*const T) -> bool { *self < *other }
 500
 501     #[inline]
 502     fn le(&self, other: &*const T) -> bool { *self <= *other }
 503
 504     #[inline]
 505     fn gt(&self, other: &*const T) -> bool { *self > *other }
 506
 507     #[inline]
 508     fn ge(&self, other: &*const T) -> bool { *self >= *other }
 509 }
 510
 511 #[stable]
 512 impl<T> Ord for *mut T {
 513     #[inline]
 514     fn cmp(&self, other: &*mut T) -> Ordering {
 515         if self < other {
 516             Less
 517         } else if self == other {
 518             Equal
 519         } else {
 520             Greater
 521         }
 522     }
 523 }
 524
 525 #[stable]
 526 impl<T> PartialOrd for *mut T {
 527     #[inline]
 528     fn partial_cmp(&self, other: &*mut T) -> Option<Ordering> {
 529         Some(self.cmp(other))
 530     }
 531
 532     #[inline]
 533     fn lt(&self, other: &*mut T) -> bool { *self < *other }
 534
 535     #[inline]
 536     fn le(&self, other: &*mut T) -> bool { *self <= *other }
 537
 538     #[inline]
 539     fn gt(&self, other: &*mut T) -> bool { *self > *other }
 540
 541     #[inline]
 542     fn ge(&self, other: &*mut T) -> bool { *self >= *other }
 543 }
 544
 545 /// A wrapper around a raw `*mut T` that indicates that the possessor
 546 /// of this wrapper owns the referent. This in turn implies that the
 547 /// `Unique<T>` is `Send`/`Sync` if `T` is `Send`/`Sync`, unlike a
 548 /// raw `*mut T` (which conveys no particular ownership semantics).
 549 /// Useful for building abstractions like `Vec<T>` or `Box<T>`, which
 550 /// internally use raw pointers to manage the memory that they own.
 551 #[unstable = "recently added to this module"]
 552 pub struct Unique<T>(pub *mut T);
 553
 554 /// `Unique` pointers are `Send` if `T` is `Send` because the data they
 555 /// reference is unaliased. Note that this aliasing invariant is
 556 /// unenforced by the type system; the abstraction using the
 557 /// `Unique` must enforce it.
 558 #[unstable = "recently added to this module"]
 559 unsafe impl<T:Send> Send for Unique<T> { }
 560
 561 /// `Unique` pointers are `Sync` if `T` is `Sync` because the data they
 562 /// reference is unaliased. Note that this aliasing invariant is
 563 /// unenforced by the type system; the abstraction using the
 564 /// `Unique` must enforce it.
 565 #[unstable = "recently added to this module"]
 566 unsafe impl<T:Sync> Sync for Unique<T> { }
 567
 568 impl<T> Unique<T> {
 569     /// Returns a null Unique.
 570     #[unstable = "recently added to this module"]
 571     pub fn null() -> Unique<T> {
 572         Unique(null_mut())
 573     }
 574
 575     /// Return an (unsafe) pointer into the memory owned by `self`.
 576     #[unstable = "recently added to this module"]
 577     pub unsafe fn offset(self, offset: int) -> *mut T {
 578         self.0.offset(offset)
 579     }
 580 }