src/libstd/ptr.rs

   1 // Copyright 2012-2013 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 //! Unsafe pointer utility functions
  12
  13 use cast;
  14 use clone::Clone;
  15 #[cfg(not(test))]
  16 use cmp::Equiv;
  17 use iter::{range, Iterator};
  18 use mem;
  19 use option::{Option, Some, None};
  20 use intrinsics;
  21
  22 #[cfg(not(test))] use cmp::{Eq, Ord};
  23
  24 /// Return the offset of the first null pointer in `buf`.
  25 #[inline]
  26 pub unsafe fn buf_len<T>(buf: **T) -> uint {
  27     position(buf, |i| *i == null())
  28 }
  29
  30 impl<T> Clone for *T {
  31     #[inline]
  32     fn clone(&self) -> *T {
  33         *self
  34     }
  35 }
  36
  37 impl<T> Clone for *mut T {
  38     #[inline]
  39     fn clone(&self) -> *mut T {
  40         *self
  41     }
  42 }
  43
  44 /// Return the first offset `i` such that `f(buf[i]) == true`.
  45 #[inline]
  46 pub unsafe fn position<T>(buf: *T, f: |&T| -> bool) -> uint {
  47     let mut i = 0;
  48     loop {
  49         if f(&(*buf.offset(i as int))) { return i; }
  50         else { i += 1; }
  51     }
  52 }
  53
  54 /// Create an unsafe null pointer
  55 #[inline]
  56 pub fn null<T>() -> *T { 0 as *T }
  57
  58 /// Create an unsafe mutable null pointer
  59 #[inline]
  60 pub fn mut_null<T>() -> *mut T { 0 as *mut T }
  61
  62 /**
  63  * Copies data from one location to another.
  64  *
  65  * Copies `count` elements (not bytes) from `src` to `dst`. The source
  66  * and destination may overlap.
  67  */
  68 #[inline]
  69 pub unsafe fn copy_memory<T>(dst: *mut T, src: *T, count: uint) {
  70     intrinsics::copy_memory(dst, src, count)
  71 }
  72
  73 /**
  74  * Copies data from one location to another.
  75  *
  76  * Copies `count` elements (not bytes) from `src` to `dst`. The source
  77  * and destination may *not* overlap.
  78  */
  79 #[inline]
  80 pub unsafe fn copy_nonoverlapping_memory<T>(dst: *mut T,
  81                                             src: *T,
  82                                             count: uint) {
  83     intrinsics::copy_nonoverlapping_memory(dst, src, count)
  84 }
  85
  86 /**
  87  * Invokes memset on the specified pointer, setting `count * size_of::<T>()`
  88  * bytes of memory starting at `dst` to `c`.
  89  */
  90 #[inline]
  91 pub unsafe fn set_memory<T>(dst: *mut T, c: u8, count: uint) {
  92     intrinsics::set_memory(dst, c, count)
  93 }
  94
  95 /**
  96  * Zeroes out `count * size_of::<T>` bytes of memory at `dst`
  97  */
  98 #[inline]
  99 pub unsafe fn zero_memory<T>(dst: *mut T, count: uint) {
 100     set_memory(dst, 0, count);
 101 }
 102
 103 /**
 104  * Swap the values at two mutable locations of the same type, without
 105  * deinitialising either. They may overlap.
 106  */
 107 #[inline]
 108 pub unsafe fn swap<T>(x: *mut T, y: *mut T) {
 109     // Give ourselves some scratch space to work with
 110     let mut tmp: T = mem::uninit();
 111     let t: *mut T = &mut tmp;
 112
 113     // Perform the swap
 114     copy_nonoverlapping_memory(t, &*x, 1);
 115     copy_memory(x, &*y, 1); // `x` and `y` may overlap
 116     copy_nonoverlapping_memory(y, &*t, 1);
 117
 118     // y and t now point to the same thing, but we need to completely forget `tmp`
 119     // because it's no longer relevant.
 120     cast::forget(tmp);
 121 }
 122
 123 /**
 124  * Replace the value at a mutable location with a new one, returning the old
 125  * value, without deinitialising either.
 126  */
 127 #[inline]
 128 pub unsafe fn replace<T>(dest: *mut T, mut src: T) -> T {
 129     mem::swap(cast::transmute(dest), &mut src); // cannot overlap
 130     src
 131 }
 132
 133 /**
 134  * Reads the value from `*src` and returns it.
 135  */
 136 #[inline(always)]
 137 pub unsafe fn read<T>(src: *T) -> T {
 138     let mut tmp: T = mem::uninit();
 139     copy_nonoverlapping_memory(&mut tmp, src, 1);
 140     tmp
 141 }
 142
 143 /**
 144  * Reads the value from `*src` and nulls it out.
 145  * This currently prevents destructors from executing.
 146  */
 147 #[inline(always)]
 148 pub unsafe fn read_and_zero<T>(dest: *mut T) -> T {
 149     // Copy the data out from `dest`:
 150     let tmp = read(&*dest);
 151
 152     // Now zero out `dest`:
 153     zero_memory(dest, 1);
 154
 155     tmp
 156 }
 157
 158 /**
 159   Given a **T (pointer to an array of pointers),
 160   iterate through each *T, up to the provided `len`,
 161   passing to the provided callback function
 162
 163   SAFETY NOTE: Pointer-arithmetic. Dragons be here.
 164 */
 165 pub unsafe fn array_each_with_len<T>(arr: **T, len: uint, cb: |*T|) {
 166     if arr.is_null() {
 167         fail!("ptr::array_each_with_len failure: arr input is null pointer");
 168     }
 169     //let start_ptr = *arr;
 170     for e in range(0, len) {
 171         let n = arr.offset(e as int);
 172         cb(*n);
 173     }
 174 }
 175
 176 /**
 177   Given a null-pointer-terminated **T (pointer to
 178   an array of pointers), iterate through each *T,
 179   passing to the provided callback function
 180
 181   SAFETY NOTE: This will only work with a null-terminated
 182   pointer array. Barely less-dodgy Pointer Arithmetic.
 183   Dragons be here.
 184 */
 185 pub unsafe fn array_each<T>(arr: **T, cb: |*T|) {
 186     if arr.is_null()  {
 187         fail!("ptr::array_each_with_len failure: arr input is null pointer");
 188     }
 189     let len = buf_len(arr);
 190     array_each_with_len(arr, len, cb);
 191 }
 192
 193 /// Extension methods for raw pointers.
 194 pub trait RawPtr<T> {
 195     /// Returns the null pointer.
 196     fn null() -> Self;
 197     /// Returns true if the pointer is equal to the null pointer.
 198     fn is_null(&self) -> bool;
 199     /// Returns true if the pointer is not equal to the null pointer.
 200     fn is_not_null(&self) -> bool { !self.is_null() }
 201     /// Returns the value of this pointer (ie, the address it points to)
 202     fn to_uint(&self) -> uint;
 203     /// Returns `None` if the pointer is null, or else returns the value wrapped
 204     /// in `Some`.
 205     ///
 206     /// # Safety Notes
 207     ///
 208     /// While this method is useful for null-safety, it is important to note
 209     /// that this is still an unsafe operation because the returned value could
 210     /// be pointing to invalid memory.
 211     unsafe fn to_option(&self) -> Option<&T>;
 212     /// Calculates the offset from a pointer. The offset *must* be in-bounds of
 213     /// the object, or one-byte-past-the-end.  `count` is in units of T; e.g. a
 214     /// `count` of 3 represents a pointer offset of `3 * sizeof::<T>()` bytes.
 215     unsafe fn offset(self, count: int) -> Self;
 216 }
 217
 218 impl<T> RawPtr<T> for *T {
 219     #[inline]
 220     fn null() -> *T { null() }
 221
 222     #[inline]
 223     fn is_null(&self) -> bool { *self == RawPtr::null() }
 224
 225     #[inline]
 226     fn to_uint(&self) -> uint { *self as uint }
 227
 228     #[inline]
 229     unsafe fn offset(self, count: int) -> *T { intrinsics::offset(self, count) }
 230
 231     #[inline]
 232     unsafe fn to_option(&self) -> Option<&T> {
 233         if self.is_null() {
 234             None
 235         } else {
 236             Some(cast::transmute(*self))
 237         }
 238     }
 239 }
 240
 241 impl<T> RawPtr<T> for *mut T {
 242     #[inline]
 243     fn null() -> *mut T { mut_null() }
 244
 245     #[inline]
 246     fn is_null(&self) -> bool { *self == RawPtr::null() }
 247
 248     #[inline]
 249     fn to_uint(&self) -> uint { *self as uint }
 250
 251     #[inline]
 252     unsafe fn offset(self, count: int) -> *mut T { intrinsics::offset(self as *T, count) as *mut T }
 253
 254     #[inline]
 255     unsafe fn to_option(&self) -> Option<&T> {
 256         if self.is_null() {
 257             None
 258         } else {
 259             Some(cast::transmute(*self))
 260         }
 261     }
 262 }
 263
 264 // Equality for pointers
 265 #[cfg(not(test))]
 266 impl<T> Eq for *T {
 267     #[inline]
 268     fn eq(&self, other: &*T) -> bool {
 269         *self == *other
 270     }
 271     #[inline]
 272     fn ne(&self, other: &*T) -> bool { !self.eq(other) }
 273 }
 274
 275 #[cfg(not(test))]
 276 impl<T> Eq for *mut T {
 277     #[inline]
 278     fn eq(&self, other: &*mut T) -> bool {
 279         *self == *other
 280     }
 281     #[inline]
 282     fn ne(&self, other: &*mut T) -> bool { !self.eq(other) }
 283 }
 284
 285 // Equivalence for pointers
 286 #[cfg(not(test))]
 287 impl<T> Equiv<*mut T> for *T {
 288     fn equiv(&self, other: &*mut T) -> bool {
 289         self.to_uint() == other.to_uint()
 290     }
 291 }
 292
 293 #[cfg(not(test))]
 294 impl<T> Equiv<*T> for *mut T {
 295     fn equiv(&self, other: &*T) -> bool {
 296         self.to_uint() == other.to_uint()
 297     }
 298 }
 299
 300 // Equality for extern "C" fn pointers
 301 #[cfg(not(test))]
 302 mod externfnpointers {
 303     use cast;
 304     use cmp::Eq;
 305
 306     impl<_R> Eq for extern "C" fn() -> _R {
 307         #[inline]
 308         fn eq(&self, other: &extern "C" fn() -> _R) -> bool {
 309             let self_: *() = unsafe { cast::transmute(*self) };
 310             let other_: *() = unsafe { cast::transmute(*other) };
 311             self_ == other_
 312         }
 313         #[inline]
 314         fn ne(&self, other: &extern "C" fn() -> _R) -> bool {
 315             !self.eq(other)
 316         }
 317     }
 318     macro_rules! fnptreq(
 319         ($($p:ident),*) => {
 320             impl<_R,$($p),*> Eq for extern "C" fn($($p),*) -> _R {
 321                 #[inline]
 322                 fn eq(&self, other: &extern "C" fn($($p),*) -> _R) -> bool {
 323                     let self_: *() = unsafe { cast::transmute(*self) };
 324                     let other_: *() = unsafe { cast::transmute(*other) };
 325                     self_ == other_
 326                 }
 327                 #[inline]
 328                 fn ne(&self, other: &extern "C" fn($($p),*) -> _R) -> bool {
 329                     !self.eq(other)
 330                 }
 331             }
 332         }
 333     )
 334     fnptreq!(A)
 335     fnptreq!(A,B)
 336     fnptreq!(A,B,C)
 337     fnptreq!(A,B,C,D)
 338     fnptreq!(A,B,C,D,E)
 339 }
 340
 341 // Comparison for pointers
 342 #[cfg(not(test))]
 343 impl<T> Ord for *T {
 344     #[inline]
 345     fn lt(&self, other: &*T) -> bool {
 346         *self < *other
 347     }
 348     #[inline]
 349     fn le(&self, other: &*T) -> bool {
 350         *self <= *other
 351     }
 352     #[inline]
 353     fn ge(&self, other: &*T) -> bool {
 354         *self >= *other
 355     }
 356     #[inline]
 357     fn gt(&self, other: &*T) -> bool {
 358         *self > *other
 359     }
 360 }
 361
 362 #[cfg(not(test))]
 363 impl<T> Ord for *mut T {
 364     #[inline]
 365     fn lt(&self, other: &*mut T) -> bool {
 366         *self < *other
 367     }
 368     #[inline]
 369     fn le(&self, other: &*mut T) -> bool {
 370         *self <= *other
 371     }
 372     #[inline]
 373     fn ge(&self, other: &*mut T) -> bool {
 374         *self >= *other
 375     }
 376     #[inline]
 377     fn gt(&self, other: &*mut T) -> bool {
 378         *self > *other
 379     }
 380 }
 381
 382 #[cfg(test)]
 383 pub mod ptr_tests {
 384     use super::*;
 385     use prelude::*;
 386
 387     use c_str::ToCStr;
 388     use cast;
 389     use libc;
 390     use str;
 391     use slice::{ImmutableVector, MutableVector};
 392
 393     #[test]
 394     fn test() {
 395         unsafe {
 396             struct Pair {
 397                 fst: int,
 398                 snd: int
 399             };
 400             let mut p = Pair {fst: 10, snd: 20};
 401             let pptr: *mut Pair = &mut p;
 402             let iptr: *mut int = cast::transmute(pptr);
 403             assert_eq!(*iptr, 10);
 404             *iptr = 30;
 405             assert_eq!(*iptr, 30);
 406             assert_eq!(p.fst, 30);
 407
 408             *pptr = Pair {fst: 50, snd: 60};
 409             assert_eq!(*iptr, 50);
 410             assert_eq!(p.fst, 50);
 411             assert_eq!(p.snd, 60);
 412
 413             let v0 = ~[32000u16, 32001u16, 32002u16];
 414             let mut v1 = ~[0u16, 0u16, 0u16];
 415
 416             copy_memory(v1.as_mut_ptr().offset(1),
 417                         v0.as_ptr().offset(1), 1);
 418             assert!((v1[0] == 0u16 && v1[1] == 32001u16 && v1[2] == 0u16));
 419             copy_memory(v1.as_mut_ptr(),
 420                         v0.as_ptr().offset(2), 1);
 421             assert!((v1[0] == 32002u16 && v1[1] == 32001u16 &&
 422                      v1[2] == 0u16));
 423             copy_memory(v1.as_mut_ptr().offset(2),
 424                         v0.as_ptr(), 1u);
 425             assert!((v1[0] == 32002u16 && v1[1] == 32001u16 &&
 426                      v1[2] == 32000u16));
 427         }
 428     }
 429
 430     #[test]
 431     fn test_position() {
 432         use libc::c_char;
 433
 434         "hello".with_c_str(|p| {
 435             unsafe {
 436                 assert!(2u == position(p, |c| *c == 'l' as c_char));
 437                 assert!(4u == position(p, |c| *c == 'o' as c_char));
 438                 assert!(5u == position(p, |c| *c == 0 as c_char));
 439             }
 440         })
 441     }
 442
 443     #[test]
 444     fn test_buf_len() {
 445         "hello".with_c_str(|p0| {
 446             "there".with_c_str(|p1| {
 447                 "thing".with_c_str(|p2| {
 448                     let v = ~[p0, p1, p2, null()];
 449                     unsafe {
 450                         assert_eq!(buf_len(v.as_ptr()), 3u);
 451                     }
 452                 })
 453             })
 454         })
 455     }
 456
 457     #[test]
 458     fn test_is_null() {
 459         let p: *int = null();
 460         assert!(p.is_null());
 461         assert!(!p.is_not_null());
 462
 463         let q = unsafe { p.offset(1) };
 464         assert!(!q.is_null());
 465         assert!(q.is_not_null());
 466
 467         let mp: *mut int = mut_null();
 468         assert!(mp.is_null());
 469         assert!(!mp.is_not_null());
 470
 471         let mq = unsafe { mp.offset(1) };
 472         assert!(!mq.is_null());
 473         assert!(mq.is_not_null());
 474     }
 475
 476     #[test]
 477     fn test_to_option() {
 478         unsafe {
 479             let p: *int = null();
 480             assert_eq!(p.to_option(), None);
 481
 482             let q: *int = &2;
 483             assert_eq!(q.to_option().unwrap(), &2);
 484
 485             let p: *mut int = mut_null();
 486             assert_eq!(p.to_option(), None);
 487
 488             let q: *mut int = &mut 2;
 489             assert_eq!(q.to_option().unwrap(), &2);
 490         }
 491     }
 492
 493     #[test]
 494     fn test_ptr_addition() {
 495         unsafe {
 496             let xs = ~[5, ..16];
 497             let mut ptr = xs.as_ptr();
 498             let end = ptr.offset(16);
 499
 500             while ptr < end {
 501                 assert_eq!(*ptr, 5);
 502                 ptr = ptr.offset(1);
 503             }
 504
 505             let mut xs_mut = xs.clone();
 506             let mut m_ptr = xs_mut.as_mut_ptr();
 507             let m_end = m_ptr.offset(16);
 508
 509             while m_ptr < m_end {
 510                 *m_ptr += 5;
 511                 m_ptr = m_ptr.offset(1);
 512             }
 513
 514             assert_eq!(xs_mut, ~[10, ..16]);
 515         }
 516     }
 517
 518     #[test]
 519     fn test_ptr_subtraction() {
 520         unsafe {
 521             let xs = ~[0,1,2,3,4,5,6,7,8,9];
 522             let mut idx = 9i8;
 523             let ptr = xs.as_ptr();
 524
 525             while idx >= 0i8 {
 526                 assert_eq!(*(ptr.offset(idx as int)), idx as int);
 527                 idx = idx - 1i8;
 528             }
 529
 530             let mut xs_mut = xs.clone();
 531             let m_start = xs_mut.as_mut_ptr();
 532             let mut m_ptr = m_start.offset(9);
 533
 534             while m_ptr >= m_start {
 535                 *m_ptr += *m_ptr;
 536                 m_ptr = m_ptr.offset(-1);
 537             }
 538
 539             assert_eq!(xs_mut, ~[0,2,4,6,8,10,12,14,16,18]);
 540         }
 541     }
 542
 543     #[test]
 544     fn test_ptr_array_each_with_len() {
 545         unsafe {
 546             let one = "oneOne".to_c_str();
 547             let two = "twoTwo".to_c_str();
 548             let three = "threeThree".to_c_str();
 549             let arr = ~[
 550                 one.with_ref(|buf| buf),
 551                 two.with_ref(|buf| buf),
 552                 three.with_ref(|buf| buf),
 553             ];
 554             let expected_arr = [
 555                 one, two, three
 556             ];
 557
 558             let mut ctr = 0;
 559             let mut iteration_count = 0;
 560             array_each_with_len(arr.as_ptr(), arr.len(), |e| {
 561                     let actual = str::raw::from_c_str(e);
 562                     let expected = expected_arr[ctr].with_ref(|buf| {
 563                             str::raw::from_c_str(buf)
 564                         });
 565                     debug!(
 566                         "test_ptr_array_each_with_len e: {}, a: {}",
 567                         expected, actual);
 568                     assert_eq!(actual, expected);
 569                     ctr += 1;
 570                     iteration_count += 1;
 571                 });
 572             assert_eq!(iteration_count, 3u);
 573         }
 574     }
 575
 576     #[test]
 577     fn test_ptr_array_each() {
 578         unsafe {
 579             let one = "oneOne".to_c_str();
 580             let two = "twoTwo".to_c_str();
 581             let three = "threeThree".to_c_str();
 582             let arr = ~[
 583                 one.with_ref(|buf| buf),
 584                 two.with_ref(|buf| buf),
 585                 three.with_ref(|buf| buf),
 586                 // fake a null terminator
 587                 null(),
 588             ];
 589             let expected_arr = [
 590                 one, two, three
 591             ];
 592
 593             let arr_ptr = arr.as_ptr();
 594             let mut ctr = 0;
 595             let mut iteration_count = 0;
 596             array_each(arr_ptr, |e| {
 597                     let actual = str::raw::from_c_str(e);
 598                     let expected = expected_arr[ctr].with_ref(|buf| {
 599                         str::raw::from_c_str(buf)
 600                     });
 601                     debug!(
 602                         "test_ptr_array_each e: {}, a: {}",
 603                         expected, actual);
 604                     assert_eq!(actual, expected);
 605                     ctr += 1;
 606                     iteration_count += 1;
 607                 });
 608             assert_eq!(iteration_count, 3);
 609         }
 610     }
 611
 612     #[test]
 613     #[should_fail]
 614     fn test_ptr_array_each_with_len_null_ptr() {
 615         unsafe {
 616             array_each_with_len(0 as **libc::c_char, 1, |e| {
 617                 str::raw::from_c_str(e);
 618             });
 619         }
 620     }
 621     #[test]
 622     #[should_fail]
 623     fn test_ptr_array_each_null_ptr() {
 624         unsafe {
 625             array_each(0 as **libc::c_char, |e| {
 626                 str::raw::from_c_str(e);
 627             });
 628         }
 629     }
 630
 631     #[test]
 632     fn test_set_memory() {
 633         let mut xs = [0u8, ..20];
 634         let ptr = xs.as_mut_ptr();
 635         unsafe { set_memory(ptr, 5u8, xs.len()); }
 636         assert!(xs == [5u8, ..20]);
 637     }
 638 }