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.
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.
11 //! Higher-level interfaces to libc::* functions and operating system services.
13 //! In general these take and return rust types, use rust idioms (enums, closures, vectors) rather
14 //! than C idioms, and do more extensive safety checks.
16 //! This module is not meant to only contain 1:1 mappings to libc entries; any os-interface code
17 //! that is reasonably useful and broadly applicable can go here. Including utility routines that
18 //! merely build on other os code.
20 //! We assume the general case is that users do not care, and do not want to be made to care, which
21 //! operating system they are on. While they may want to special case various special cases -- and
22 //! so we will not _hide_ the facts of which OS the user is on -- they should be given the
23 //! opportunity to write OS-ignorant code by default.
27 #![allow(missing_docs)]
28 #![allow(non_snake_case)]
29 #![allow(unused_imports)]
31 use self::MemoryMapKind::*;
32 use self::MapOption::*;
33 use self::MapError::*;
36 use error::{FromError, Error};
38 use io::{IoResult, IoError};
39 use iter::{Iterator, IteratorExt};
41 use libc::{c_void, c_int, c_char};
44 use ops::{Drop, FnOnce};
46 use option::Option::{Some, None};
47 use path::{Path, GenericPath, BytesContainer};
49 use sys::os as os_imp;
53 use result::Result::{Err, Ok};
54 use slice::{AsSlice, SliceExt};
55 use str::{Str, StrExt};
56 use string::{String, ToString};
57 use sync::atomic::{AtomicInt, ATOMIC_INT_INIT, Ordering};
60 #[cfg(unix)] use c_str::ToCStr;
63 pub use sys::ext as unix;
65 pub use sys::ext as windows;
67 /// Get the number of cores available
68 pub fn num_cpus() -> uint {
70 return rust_get_num_cpus() as uint;
74 fn rust_get_num_cpus() -> libc::uintptr_t;
78 pub const TMPBUF_SZ : uint = 1000u;
80 /// Returns the current working directory as a `Path`.
84 /// Returns an `Err` if the current working directory value is invalid.
87 /// * Current directory does not exist.
88 /// * There are insufficient permissions to access the current directory.
89 /// * The internal buffer is not large enough to hold the path.
96 /// // We assume that we are in a valid directory.
97 /// let current_working_directory = os::getcwd().unwrap();
98 /// println!("The current directory is {}", current_working_directory.display());
100 pub fn getcwd() -> IoResult<Path> {
105 Accessing environment variables is not generally threadsafe.
106 Serialize access through a global lock.
108 fn with_env_lock<T, F>(f: F) -> T where
111 use sync::{StaticMutex, MUTEX_INIT};
113 static LOCK: StaticMutex = MUTEX_INIT;
115 let _guard = LOCK.lock();
119 /// Returns a vector of (variable, value) pairs, for all the environment
120 /// variables of the current process.
122 /// Invalid UTF-8 bytes are replaced with \uFFFD. See `String::from_utf8_lossy()`
130 /// // We will iterate through the references to the element returned by os::env();
131 /// for &(ref key, ref value) in os::env().iter() {
132 /// println!("'{}': '{}'", key, value );
135 pub fn env() -> Vec<(String,String)> {
136 env_as_bytes().into_iter().map(|(k,v)| {
137 let k = String::from_utf8_lossy(k.as_slice()).into_owned();
138 let v = String::from_utf8_lossy(v.as_slice()).into_owned();
143 /// Returns a vector of (variable, value) byte-vector pairs for all the
144 /// environment variables of the current process.
145 pub fn env_as_bytes() -> Vec<(Vec<u8>,Vec<u8>)> {
147 fn env_convert(input: Vec<Vec<u8>>) -> Vec<(Vec<u8>, Vec<u8>)> {
148 let mut pairs = Vec::new();
149 for p in input.iter() {
150 let mut it = p.splitn(1, |b| *b == b'=');
151 let key = it.next().unwrap().to_vec();
152 let default: &[u8] = &[];
153 let val = it.next().unwrap_or(default).to_vec();
154 pairs.push((key, val));
159 let unparsed_environ = sys::os::get_env_pairs();
160 env_convert(unparsed_environ)
166 /// Fetches the environment variable `n` from the current process, returning
167 /// None if the variable isn't set.
169 /// Any invalid UTF-8 bytes in the value are replaced by \uFFFD. See
170 /// `String::from_utf8_lossy()` for details.
174 /// Panics if `n` has any interior NULs.
181 /// let key = "HOME";
182 /// match os::getenv(key) {
183 /// Some(val) => println!("{}: {}", key, val),
184 /// None => println!("{} is not defined in the environment.", key)
187 pub fn getenv(n: &str) -> Option<String> {
188 getenv_as_bytes(n).map(|v| String::from_utf8_lossy(v.as_slice()).into_owned())
192 /// Fetches the environment variable `n` byte vector from the current process,
193 /// returning None if the variable isn't set.
197 /// Panics if `n` has any interior NULs.
198 pub fn getenv_as_bytes(n: &str) -> Option<Vec<u8>> {
203 let s = n.with_c_str(|buf| libc::getenv(buf));
207 Some(CString::new(s as *const libc::c_char, false).as_bytes_no_nul().to_vec())
214 /// Fetches the environment variable `n` from the current process, returning
215 /// None if the variable isn't set.
216 pub fn getenv(n: &str) -> Option<String> {
219 use sys::os::fill_utf16_buf_and_decode;
220 let mut n: Vec<u16> = n.utf16_units().collect();
222 fill_utf16_buf_and_decode(|buf, sz| {
223 libc::GetEnvironmentVariableW(n.as_ptr(), buf, sz)
230 /// Fetches the environment variable `n` byte vector from the current process,
231 /// returning None if the variable isn't set.
232 pub fn getenv_as_bytes(n: &str) -> Option<Vec<u8>> {
233 getenv(n).map(|s| s.into_bytes())
236 /// Sets the environment variable `n` to the value `v` for the currently running
245 /// os::setenv(key, "VALUE");
246 /// match os::getenv(key) {
247 /// Some(ref val) => println!("{}: {}", key, val),
248 /// None => println!("{} is not defined in the environment.", key)
251 pub fn setenv<T: BytesContainer>(n: &str, v: T) {
253 fn _setenv(n: &str, v: &[u8]) {
256 n.with_c_str(|nbuf| {
257 v.with_c_str(|vbuf| {
258 if libc::funcs::posix01::unistd::setenv(nbuf, vbuf, 1) != 0 {
259 panic!(IoError::last_error());
268 fn _setenv(n: &str, v: &[u8]) {
269 let mut n: Vec<u16> = n.utf16_units().collect();
271 let mut v: Vec<u16> = ::str::from_utf8(v).unwrap().utf16_units().collect();
276 if libc::SetEnvironmentVariableW(n.as_ptr(), v.as_ptr()) == 0 {
277 panic!(IoError::last_error());
283 _setenv(n, v.container_as_bytes())
286 /// Remove a variable from the environment entirely.
287 pub fn unsetenv(n: &str) {
289 fn _unsetenv(n: &str) {
292 n.with_c_str(|nbuf| {
293 if libc::funcs::posix01::unistd::unsetenv(nbuf) != 0 {
294 panic!(IoError::last_error());
302 fn _unsetenv(n: &str) {
303 let mut n: Vec<u16> = n.utf16_units().collect();
307 if libc::SetEnvironmentVariableW(n.as_ptr(), ptr::null()) == 0 {
308 panic!(IoError::last_error());
317 /// Parses input according to platform conventions for the `PATH`
318 /// environment variable.
324 /// let key = "PATH";
325 /// match os::getenv_as_bytes(key) {
327 /// for path in os::split_paths(paths).iter() {
328 /// println!("'{}'", path.display());
331 /// None => println!("{} is not defined in the environment.", key)
334 pub fn split_paths<T: BytesContainer>(unparsed: T) -> Vec<Path> {
335 sys::os::split_paths(unparsed.container_as_bytes())
338 /// Joins a collection of `Path`s appropriately for the `PATH`
339 /// environment variable.
341 /// Returns a `Vec<u8>` on success, since `Path`s are not utf-8
342 /// encoded on all platforms.
344 /// Returns an `Err` (containing an error message) if one of the input
345 /// `Path`s contains an invalid character for constructing the `PATH`
346 /// variable (a double quote on Windows or a colon on Unix).
352 /// use std::path::Path;
354 /// let key = "PATH";
355 /// let mut paths = os::getenv_as_bytes(key).map_or(Vec::new(), os::split_paths);
356 /// paths.push(Path::new("/home/xyz/bin"));
357 /// os::setenv(key, os::join_paths(paths.as_slice()).unwrap());
359 pub fn join_paths<T: BytesContainer>(paths: &[T]) -> Result<Vec<u8>, &'static str> {
360 sys::os::join_paths(paths)
363 /// A low-level OS in-memory pipe.
366 /// A file descriptor representing the reading end of the pipe. Data written
367 /// on the `out` file descriptor can be read from this file descriptor.
369 /// A file descriptor representing the write end of the pipe. Data written
370 /// to this file descriptor can be read from the `input` file descriptor.
374 /// Creates a new low-level OS in-memory pipe.
376 /// This function can fail to succeed if there are no more resources available
377 /// to allocate a pipe.
379 /// This function is also unsafe as there is no destructor associated with the
380 /// `Pipe` structure will return. If it is not arranged for the returned file
381 /// descriptors to be closed, the file descriptors will leak. For safe handling
382 /// of this scenario, use `std::io::PipeStream` instead.
383 pub unsafe fn pipe() -> IoResult<Pipe> {
384 let (reader, writer) = try!(sys::os::pipe());
386 reader: reader.unwrap(),
387 writer: writer.unwrap(),
391 /// Returns the proper dll filename for the given basename of a file
393 #[cfg(not(target_os="ios"))]
394 pub fn dll_filename(base: &str) -> String {
395 format!("{}{}{}", consts::DLL_PREFIX, base, consts::DLL_SUFFIX)
398 /// Optionally returns the filesystem path to the current executable which is
399 /// running but with the executable name.
406 /// match os::self_exe_name() {
407 /// Some(exe_path) => println!("Path of this executable is: {}", exe_path.display()),
408 /// None => println!("Unable to get the path of this executable!")
411 pub fn self_exe_name() -> Option<Path> {
412 sys::os::load_self().and_then(Path::new_opt)
415 /// Optionally returns the filesystem path to the current executable which is
418 /// Like self_exe_name() but without the binary's name.
425 /// match os::self_exe_path() {
426 /// Some(exe_path) => println!("Executable's Path is: {}", exe_path.display()),
427 /// None => println!("Impossible to fetch the path of this executable.")
430 pub fn self_exe_path() -> Option<Path> {
431 self_exe_name().map(|mut p| { p.pop(); p })
434 /// Optionally returns the path to the current user's home directory if known.
438 /// Returns the value of the 'HOME' environment variable if it is set
439 /// and not equal to the empty string.
443 /// Returns the value of the 'HOME' environment variable if it is
444 /// set and not equal to the empty string. Otherwise, returns the value of the
445 /// 'USERPROFILE' environment variable if it is set and not equal to the empty
453 /// match os::homedir() {
454 /// Some(ref p) => println!("{}", p.display()),
455 /// None => println!("Impossible to get your home dir!")
458 pub fn homedir() -> Option<Path> {
461 fn _homedir() -> Option<Path> {
467 fn _homedir() -> Option<Path> {
468 aux_homedir("HOME").or(aux_homedir("USERPROFILE"))
472 fn aux_homedir(home_name: &str) -> Option<Path> {
473 match getenv_as_bytes(home_name) {
475 if p.is_empty() { None } else { Path::new_opt(p) }
483 /// Returns the path to a temporary directory.
485 /// On Unix, returns the value of the 'TMPDIR' environment variable if it is
486 /// set, otherwise for non-Android it returns '/tmp'. If Android, since there
487 /// is no global temporary folder (it is usually allocated per-app), we return
488 /// '/data/local/tmp'.
490 /// On Windows, returns the value of, in order, the 'TMP', 'TEMP',
491 /// 'USERPROFILE' environment variable if any are set and not the empty
492 /// string. Otherwise, tmpdir returns the path to the Windows directory.
493 pub fn tmpdir() -> Path {
496 fn getenv_nonempty(v: &str) -> Option<Path> {
509 fn lookup() -> Path {
510 let default = if cfg!(target_os = "android") {
511 Path::new("/data/local/tmp")
516 getenv_nonempty("TMPDIR").unwrap_or(default)
520 fn lookup() -> Path {
521 getenv_nonempty("TMP").or(
522 getenv_nonempty("TEMP").or(
523 getenv_nonempty("USERPROFILE").or(
524 getenv_nonempty("WINDIR")))).unwrap_or(Path::new("C:\\Windows"))
528 /// Convert a relative path to an absolute path
530 /// If the given path is relative, return it prepended with the current working
531 /// directory. If the given path is already an absolute path, return it
537 /// use std::path::Path;
539 /// // Assume we're in a path like /home/someuser
540 /// let rel_path = Path::new("..");
541 /// let abs_path = os::make_absolute(&rel_path).unwrap();
542 /// println!("The absolute path is {}", abs_path.display());
543 /// // Prints "The absolute path is /home"
545 // NB: this is here rather than in path because it is a form of environment
546 // querying; what it does depends on the process working directory, not just
548 pub fn make_absolute(p: &Path) -> IoResult<Path> {
552 getcwd().map(|mut cwd| {
559 /// Changes the current working directory to the specified path, returning
560 /// whether the change was completed successfully or not.
565 /// use std::path::Path;
567 /// let root = Path::new("/");
568 /// assert!(os::change_dir(&root).is_ok());
569 /// println!("Successfully changed working directory to {}!", root.display());
571 pub fn change_dir(p: &Path) -> IoResult<()> {
572 return sys::os::chdir(p);
575 /// Returns the platform-specific value of errno
576 pub fn errno() -> uint {
577 sys::os::errno() as uint
580 /// Return the string corresponding to an `errno()` value of `errnum`.
586 /// // Same as println!("{}", last_os_error());
587 /// println!("{}", os::error_string(os::errno() as uint));
589 pub fn error_string(errnum: uint) -> String {
590 return sys::os::error_string(errnum as i32);
593 /// Get a string representing the platform-dependent last error
594 pub fn last_os_error() -> String {
595 error_string(errno() as uint)
598 static EXIT_STATUS: AtomicInt = ATOMIC_INT_INIT;
600 /// Sets the process exit code
602 /// Sets the exit code returned by the process if all supervised tasks
603 /// terminate successfully (without panicking). If the current root task panics
604 /// and is supervised by the scheduler then any user-specified exit status is
605 /// ignored and the process exits with the default panic status.
607 /// Note that this is not synchronized against modifications of other threads.
608 pub fn set_exit_status(code: int) {
609 EXIT_STATUS.store(code, Ordering::SeqCst)
612 /// Fetches the process's current exit code. This defaults to 0 and can change
613 /// by calling `set_exit_status`.
614 pub fn get_exit_status() -> int {
615 EXIT_STATUS.load(Ordering::SeqCst)
618 #[cfg(target_os = "macos")]
619 unsafe fn load_argc_and_argv(argc: int,
620 argv: *const *const c_char) -> Vec<Vec<u8>> {
624 range(0, argc as uint).map(|i| {
625 CString::new(*argv.offset(i as int), false).as_bytes_no_nul().to_vec()
629 /// Returns the command line arguments
631 /// Returns a list of the command line arguments.
632 #[cfg(target_os = "macos")]
633 fn real_args_as_bytes() -> Vec<Vec<u8>> {
635 let (argc, argv) = (*_NSGetArgc() as int,
636 *_NSGetArgv() as *const *const c_char);
637 load_argc_and_argv(argc, argv)
641 // As _NSGetArgc and _NSGetArgv aren't mentioned in iOS docs
642 // and use underscores in their names - they're most probably
643 // are considered private and therefore should be avoided
644 // Here is another way to get arguments using Objective C
647 // In general it looks like:
649 // let args = [[NSProcessInfo processInfo] arguments]
650 // for i in range(0, [args count])
651 // res.push([args objectAtIndex:i])
653 #[cfg(target_os = "ios")]
654 fn real_args_as_bytes() -> Vec<Vec<u8>> {
659 #[link(name = "objc")]
661 fn sel_registerName(name: *const libc::c_uchar) -> Sel;
662 fn objc_msgSend(obj: NsId, sel: Sel, ...) -> NsId;
663 fn objc_getClass(class_name: *const libc::c_uchar) -> NsId;
666 #[link(name = "Foundation", kind = "framework")]
669 type Sel = *const libc::c_void;
670 type NsId = *const libc::c_void;
672 let mut res = Vec::new();
675 let processInfoSel = sel_registerName("processInfo\0".as_ptr());
676 let argumentsSel = sel_registerName("arguments\0".as_ptr());
677 let utf8Sel = sel_registerName("UTF8String\0".as_ptr());
678 let countSel = sel_registerName("count\0".as_ptr());
679 let objectAtSel = sel_registerName("objectAtIndex:\0".as_ptr());
681 let klass = objc_getClass("NSProcessInfo\0".as_ptr());
682 let info = objc_msgSend(klass, processInfoSel);
683 let args = objc_msgSend(info, argumentsSel);
685 let cnt: int = mem::transmute(objc_msgSend(args, countSel));
686 for i in range(0, cnt) {
687 let tmp = objc_msgSend(args, objectAtSel, i);
688 let utf_c_str: *const libc::c_char =
689 mem::transmute(objc_msgSend(tmp, utf8Sel));
690 let s = CString::new(utf_c_str, false);
691 res.push(s.as_bytes_no_nul().to_vec())
698 #[cfg(any(target_os = "linux",
699 target_os = "android",
700 target_os = "freebsd",
701 target_os = "dragonfly"))]
702 fn real_args_as_bytes() -> Vec<Vec<u8>> {
704 rt::args::clone().unwrap_or_else(|| vec![])
708 fn real_args() -> Vec<String> {
709 real_args_as_bytes().into_iter()
711 String::from_utf8_lossy(v.as_slice()).into_owned()
716 fn real_args() -> Vec<String> {
720 let mut nArgs: c_int = 0;
721 let lpArgCount: *mut c_int = &mut nArgs;
722 let lpCmdLine = unsafe { GetCommandLineW() };
723 let szArgList = unsafe { CommandLineToArgvW(lpCmdLine, lpArgCount) };
725 let args: Vec<_> = range(0, nArgs as uint).map(|i| unsafe {
726 // Determine the length of this argument.
727 let ptr = *szArgList.offset(i as int);
729 while *ptr.offset(len as int) != 0 { len += 1; }
731 // Push it onto the list.
732 let ptr = ptr as *const u16;
733 let buf = slice::from_raw_buf(&ptr, len);
734 let opt_s = String::from_utf16(sys::os::truncate_utf16_at_nul(buf));
735 opt_s.ok().expect("CommandLineToArgvW returned invalid UTF-16")
739 LocalFree(szArgList as *mut c_void);
746 fn real_args_as_bytes() -> Vec<Vec<u8>> {
747 real_args().into_iter().map(|s| s.into_bytes()).collect()
750 type LPCWSTR = *const u16;
753 #[link_name="kernel32"]
755 fn GetCommandLineW() -> LPCWSTR;
756 fn LocalFree(ptr: *mut c_void);
760 #[link_name="shell32"]
762 fn CommandLineToArgvW(lpCmdLine: LPCWSTR,
763 pNumArgs: *mut c_int) -> *mut *mut u16;
766 /// Returns the arguments which this program was started with (normally passed
767 /// via the command line).
769 /// The first element is traditionally the path to the executable, but it can be
770 /// set to arbitrary text, and it may not even exist, so this property should not
771 /// be relied upon for security purposes.
773 /// The arguments are interpreted as utf-8, with invalid bytes replaced with \uFFFD.
774 /// See `String::from_utf8_lossy` for details.
780 /// // Prints each argument on a separate line
781 /// for argument in os::args().iter() {
782 /// println!("{}", argument);
785 pub fn args() -> Vec<String> {
789 /// Returns the arguments which this program was started with (normally passed
790 /// via the command line) as byte vectors.
791 pub fn args_as_bytes() -> Vec<Vec<u8>> {
795 #[cfg(target_os = "macos")]
797 // These functions are in crt_externs.h.
798 pub fn _NSGetArgc() -> *mut c_int;
799 pub fn _NSGetArgv() -> *mut *mut *mut c_char;
802 /// Returns the page size of the current architecture in bytes.
803 pub fn page_size() -> uint {
807 /// A memory mapped file or chunk of memory. This is a very system-specific
808 /// interface to the OS's memory mapping facilities (`mmap` on POSIX,
809 /// `VirtualAlloc`/`CreateFileMapping` on Windows). It makes no attempt at
810 /// abstracting platform differences, besides in error values returned. Consider
813 /// The memory map is released (unmapped) when the destructor is run, so don't
814 /// let it leave scope by accident if you want it to stick around.
815 #[allow(missing_copy_implementations)]
816 pub struct MemoryMap {
822 /// Type of memory map
823 pub enum MemoryMapKind {
824 /// Virtual memory map. Usually used to change the permissions of a given
825 /// chunk of memory. Corresponds to `VirtualAlloc` on Windows.
827 /// Virtual memory map. Usually used to change the permissions of a given
828 /// chunk of memory, or for allocation. Corresponds to `VirtualAlloc` on
833 impl Copy for MemoryMapKind {}
835 /// Options the memory map is created with
837 /// The memory should be readable
839 /// The memory should be writable
841 /// The memory should be executable
843 /// Create a map for a specific address range. Corresponds to `MAP_FIXED` on
846 /// Create a memory mapping for a file with a given HANDLE.
849 /// Create a memory mapping for a file with a given fd.
852 /// When using `MapFd`, the start of the map is `uint` bytes from the start
855 /// On POSIX, this can be used to specify the default flags passed to
856 /// `mmap`. By default it uses `MAP_PRIVATE` and, if not using `MapFd`,
857 /// `MAP_ANON`. This will override both of those. This is platform-specific
858 /// (the exact values used) and ignored on Windows.
859 MapNonStandardFlags(c_int),
862 impl Copy for MapOption {}
864 /// Possible errors when creating a map.
867 /// # The following are POSIX-specific
869 /// fd was not open for reading or, if using `MapWritable`, was not open for
874 /// Either the address given by `MapAddr` or offset given by `MapOffset` was
875 /// not a multiple of `MemoryMap::granularity` (unaligned to page size).
877 /// With `MapFd`, the fd does not support mapping.
879 /// If using `MapAddr`, the address + `min_len` was outside of the process's
880 /// address space. If using `MapFd`, the target of the fd didn't have enough
881 /// resources to fulfill the request.
883 /// A zero-length map was requested. This is invalid according to
884 /// [POSIX](http://pubs.opengroup.org/onlinepubs/9699919799/functions/mmap.html).
885 /// Not all platforms obey this, but this wrapper does.
887 /// Unrecognized error. The inner value is the unrecognized errno.
889 /// # The following are Windows-specific
891 /// Unsupported combination of protection flags
892 /// (`MapReadable`/`MapWritable`/`MapExecutable`).
894 /// When using `MapFd`, `MapOffset` was given (Windows does not support this
897 /// When using `MapFd`, there was already a mapping to the file.
899 /// Unrecognized error from `VirtualAlloc`. The inner value is the return
900 /// value of GetLastError.
901 ErrVirtualAlloc(uint),
902 /// Unrecognized error from `CreateFileMapping`. The inner value is the
903 /// return value of `GetLastError`.
904 ErrCreateFileMappingW(uint),
905 /// Unrecognized error from `MapViewOfFile`. The inner value is the return
906 /// value of `GetLastError`.
907 ErrMapViewOfFile(uint)
910 impl fmt::Show for MapError {
911 fn fmt(&self, out: &mut fmt::Formatter) -> fmt::Result {
912 let str = match *self {
913 ErrFdNotAvail => "fd not available for reading or writing",
914 ErrInvalidFd => "Invalid fd",
916 "Unaligned address, invalid flags, negative length or \
919 ErrNoMapSupport=> "File doesn't support mapping",
920 ErrNoMem => "Invalid address, or not enough available memory",
921 ErrUnsupProt => "Protection mode unsupported",
922 ErrUnsupOffset => "Offset in virtual memory mode is unsupported",
923 ErrAlreadyExists => "File mapping for specified file already exists",
924 ErrZeroLength => "Zero-length mapping not allowed",
925 ErrUnknown(code) => {
926 return write!(out, "Unknown error = {}", code)
928 ErrVirtualAlloc(code) => {
929 return write!(out, "VirtualAlloc failure = {}", code)
931 ErrCreateFileMappingW(code) => {
932 return write!(out, "CreateFileMappingW failure = {}", code)
934 ErrMapViewOfFile(code) => {
935 return write!(out, "MapViewOfFile failure = {}", code)
938 write!(out, "{}", str)
942 impl Error for MapError {
943 fn description(&self) -> &str { "memory map error" }
944 fn detail(&self) -> Option<String> { Some(self.to_string()) }
947 impl FromError<MapError> for Box<Error> {
948 fn from_error(err: MapError) -> Box<Error> {
953 // Round up `from` to be divisible by `to`
954 fn round_up(from: uint, to: uint) -> uint {
955 let r = if from % to == 0 {
958 from + to - (from % to)
969 /// Create a new mapping with the given `options`, at least `min_len` bytes
970 /// long. `min_len` must be greater than zero; see the note on
972 pub fn new(min_len: uint, options: &[MapOption]) -> Result<MemoryMap, MapError> {
976 return Err(ErrZeroLength)
978 let mut addr: *const u8 = ptr::null();
980 let mut flags = libc::MAP_PRIVATE;
983 let mut custom_flags = false;
984 let len = round_up(min_len, page_size());
986 for &o in options.iter() {
988 MapReadable => { prot |= libc::PROT_READ; },
989 MapWritable => { prot |= libc::PROT_WRITE; },
990 MapExecutable => { prot |= libc::PROT_EXEC; },
992 flags |= libc::MAP_FIXED;
996 flags |= libc::MAP_FILE;
999 MapOffset(offset_) => { offset = offset_ as off_t; },
1000 MapNonStandardFlags(f) => { custom_flags = true; flags = f },
1003 if fd == -1 && !custom_flags { flags |= libc::MAP_ANON; }
1006 libc::mmap(addr as *mut c_void, len as libc::size_t, prot, flags,
1009 if r == libc::MAP_FAILED {
1010 Err(match errno() as c_int {
1011 libc::EACCES => ErrFdNotAvail,
1012 libc::EBADF => ErrInvalidFd,
1013 libc::EINVAL => ErrUnaligned,
1014 libc::ENODEV => ErrNoMapSupport,
1015 libc::ENOMEM => ErrNoMem,
1016 code => ErrUnknown(code as int)
1025 MapFile(ptr::null())
1031 /// Granularity that the offset or address must be for `MapOffset` and
1032 /// `MapAddr` respectively.
1033 pub fn granularity() -> uint {
1039 impl Drop for MemoryMap {
1040 /// Unmap the mapping. Panics the task if `munmap` panics.
1041 fn drop(&mut self) {
1042 if self.len == 0 { /* workaround for dummy_stack */ return; }
1045 // `munmap` only panics due to logic errors
1046 libc::munmap(self.data as *mut c_void, self.len as libc::size_t);
1053 /// Create a new mapping with the given `options`, at least `min_len` bytes long.
1054 pub fn new(min_len: uint, options: &[MapOption]) -> Result<MemoryMap, MapError> {
1055 use libc::types::os::arch::extra::{LPVOID, DWORD, SIZE_T, HANDLE};
1057 let mut lpAddress: LPVOID = ptr::null_mut();
1058 let mut readable = false;
1059 let mut writable = false;
1060 let mut executable = false;
1061 let mut handle: HANDLE = libc::INVALID_HANDLE_VALUE;
1062 let mut offset: uint = 0;
1063 let len = round_up(min_len, page_size());
1065 for &o in options.iter() {
1067 MapReadable => { readable = true; },
1068 MapWritable => { writable = true; },
1069 MapExecutable => { executable = true; }
1070 MapAddr(addr_) => { lpAddress = addr_ as LPVOID; },
1071 MapFd(handle_) => { handle = handle_; },
1072 MapOffset(offset_) => { offset = offset_; },
1073 MapNonStandardFlags(..) => {}
1077 let flProtect = match (executable, readable, writable) {
1078 (false, false, false) if handle == libc::INVALID_HANDLE_VALUE => libc::PAGE_NOACCESS,
1079 (false, true, false) => libc::PAGE_READONLY,
1080 (false, true, true) => libc::PAGE_READWRITE,
1081 (true, false, false) if handle == libc::INVALID_HANDLE_VALUE => libc::PAGE_EXECUTE,
1082 (true, true, false) => libc::PAGE_EXECUTE_READ,
1083 (true, true, true) => libc::PAGE_EXECUTE_READWRITE,
1084 _ => return Err(ErrUnsupProt)
1087 if handle == libc::INVALID_HANDLE_VALUE {
1089 return Err(ErrUnsupOffset);
1092 libc::VirtualAlloc(lpAddress,
1094 libc::MEM_COMMIT | libc::MEM_RESERVE,
1098 0 => Err(ErrVirtualAlloc(errno())),
1106 let dwDesiredAccess = match (executable, readable, writable) {
1107 (false, true, false) => libc::FILE_MAP_READ,
1108 (false, true, true) => libc::FILE_MAP_WRITE,
1109 (true, true, false) => libc::FILE_MAP_READ | libc::FILE_MAP_EXECUTE,
1110 (true, true, true) => libc::FILE_MAP_WRITE | libc::FILE_MAP_EXECUTE,
1111 _ => return Err(ErrUnsupProt) // Actually, because of the check above,
1112 // we should never get here.
1116 let mapping = libc::CreateFileMappingW(hFile,
1122 if mapping == ptr::null_mut() {
1123 return Err(ErrCreateFileMappingW(errno()));
1125 if errno() as c_int == libc::ERROR_ALREADY_EXISTS {
1126 return Err(ErrAlreadyExists);
1128 let r = libc::MapViewOfFile(mapping,
1130 ((len as u64) >> 32) as DWORD,
1131 (offset & 0xffff_ffff) as DWORD,
1134 0 => Err(ErrMapViewOfFile(errno())),
1138 kind: MapFile(mapping as *const u8)
1145 /// Granularity of MapAddr() and MapOffset() parameter values.
1146 /// This may be greater than the value returned by page_size().
1147 pub fn granularity() -> uint {
1150 let mut info = mem::zeroed();
1151 libc::GetSystemInfo(&mut info);
1153 return info.dwAllocationGranularity as uint;
1159 impl Drop for MemoryMap {
1160 /// Unmap the mapping. Panics the task if any of `VirtualFree`,
1161 /// `UnmapViewOfFile`, or `CloseHandle` fail.
1162 fn drop(&mut self) {
1163 use libc::types::os::arch::extra::{LPCVOID, HANDLE};
1164 use libc::consts::os::extra::FALSE;
1165 if self.len == 0 { return }
1170 if libc::VirtualFree(self.data as *mut c_void, 0,
1171 libc::MEM_RELEASE) == 0 {
1172 println!("VirtualFree failed: {}", errno());
1175 MapFile(mapping) => {
1176 if libc::UnmapViewOfFile(self.data as LPCVOID) == FALSE {
1177 println!("UnmapViewOfFile failed: {}", errno());
1179 if libc::CloseHandle(mapping as HANDLE) == FALSE {
1180 println!("CloseHandle failed: {}", errno());
1189 /// Returns the pointer to the memory created or modified by this map.
1190 pub fn data(&self) -> *mut u8 { self.data }
1191 /// Returns the number of bytes this map applies to.
1192 pub fn len(&self) -> uint { self.len }
1193 /// Returns the type of mapping this represents.
1194 pub fn kind(&self) -> MemoryMapKind { self.kind }
1197 #[cfg(target_os = "linux")]
1199 pub use os::arch_consts::ARCH;
1201 pub const FAMILY: &'static str = "unix";
1203 /// A string describing the specific operating system in use: in this
1205 pub const SYSNAME: &'static str = "linux";
1207 /// Specifies the filename prefix used for shared libraries on this
1208 /// platform: in this case, `lib`.
1209 pub const DLL_PREFIX: &'static str = "lib";
1211 /// Specifies the filename suffix used for shared libraries on this
1212 /// platform: in this case, `.so`.
1213 pub const DLL_SUFFIX: &'static str = ".so";
1215 /// Specifies the file extension used for shared libraries on this
1216 /// platform that goes after the dot: in this case, `so`.
1217 pub const DLL_EXTENSION: &'static str = "so";
1219 /// Specifies the filename suffix used for executable binaries on this
1220 /// platform: in this case, the empty string.
1221 pub const EXE_SUFFIX: &'static str = "";
1223 /// Specifies the file extension, if any, used for executable binaries
1224 /// on this platform: in this case, the empty string.
1225 pub const EXE_EXTENSION: &'static str = "";
1228 #[cfg(target_os = "macos")]
1230 pub use os::arch_consts::ARCH;
1232 pub const FAMILY: &'static str = "unix";
1234 /// A string describing the specific operating system in use: in this
1236 pub const SYSNAME: &'static str = "macos";
1238 /// Specifies the filename prefix used for shared libraries on this
1239 /// platform: in this case, `lib`.
1240 pub const DLL_PREFIX: &'static str = "lib";
1242 /// Specifies the filename suffix used for shared libraries on this
1243 /// platform: in this case, `.dylib`.
1244 pub const DLL_SUFFIX: &'static str = ".dylib";
1246 /// Specifies the file extension used for shared libraries on this
1247 /// platform that goes after the dot: in this case, `dylib`.
1248 pub const DLL_EXTENSION: &'static str = "dylib";
1250 /// Specifies the filename suffix used for executable binaries on this
1251 /// platform: in this case, the empty string.
1252 pub const EXE_SUFFIX: &'static str = "";
1254 /// Specifies the file extension, if any, used for executable binaries
1255 /// on this platform: in this case, the empty string.
1256 pub const EXE_EXTENSION: &'static str = "";
1259 #[cfg(target_os = "ios")]
1261 pub use os::arch_consts::ARCH;
1263 pub const FAMILY: &'static str = "unix";
1265 /// A string describing the specific operating system in use: in this
1267 pub const SYSNAME: &'static str = "ios";
1269 /// Specifies the filename suffix used for executable binaries on this
1270 /// platform: in this case, the empty string.
1271 pub const EXE_SUFFIX: &'static str = "";
1273 /// Specifies the file extension, if any, used for executable binaries
1274 /// on this platform: in this case, the empty string.
1275 pub const EXE_EXTENSION: &'static str = "";
1278 #[cfg(target_os = "freebsd")]
1280 pub use os::arch_consts::ARCH;
1282 pub const FAMILY: &'static str = "unix";
1284 /// A string describing the specific operating system in use: in this
1285 /// case, `freebsd`.
1286 pub const SYSNAME: &'static str = "freebsd";
1288 /// Specifies the filename prefix used for shared libraries on this
1289 /// platform: in this case, `lib`.
1290 pub const DLL_PREFIX: &'static str = "lib";
1292 /// Specifies the filename suffix used for shared libraries on this
1293 /// platform: in this case, `.so`.
1294 pub const DLL_SUFFIX: &'static str = ".so";
1296 /// Specifies the file extension used for shared libraries on this
1297 /// platform that goes after the dot: in this case, `so`.
1298 pub const DLL_EXTENSION: &'static str = "so";
1300 /// Specifies the filename suffix used for executable binaries on this
1301 /// platform: in this case, the empty string.
1302 pub const EXE_SUFFIX: &'static str = "";
1304 /// Specifies the file extension, if any, used for executable binaries
1305 /// on this platform: in this case, the empty string.
1306 pub const EXE_EXTENSION: &'static str = "";
1309 #[cfg(target_os = "dragonfly")]
1311 pub use os::arch_consts::ARCH;
1313 pub const FAMILY: &'static str = "unix";
1315 /// A string describing the specific operating system in use: in this
1316 /// case, `dragonfly`.
1317 pub const SYSNAME: &'static str = "dragonfly";
1319 /// Specifies the filename prefix used for shared libraries on this
1320 /// platform: in this case, `lib`.
1321 pub const DLL_PREFIX: &'static str = "lib";
1323 /// Specifies the filename suffix used for shared libraries on this
1324 /// platform: in this case, `.so`.
1325 pub const DLL_SUFFIX: &'static str = ".so";
1327 /// Specifies the file extension used for shared libraries on this
1328 /// platform that goes after the dot: in this case, `so`.
1329 pub const DLL_EXTENSION: &'static str = "so";
1331 /// Specifies the filename suffix used for executable binaries on this
1332 /// platform: in this case, the empty string.
1333 pub const EXE_SUFFIX: &'static str = "";
1335 /// Specifies the file extension, if any, used for executable binaries
1336 /// on this platform: in this case, the empty string.
1337 pub const EXE_EXTENSION: &'static str = "";
1340 #[cfg(target_os = "android")]
1342 pub use os::arch_consts::ARCH;
1344 pub const FAMILY: &'static str = "unix";
1346 /// A string describing the specific operating system in use: in this
1347 /// case, `android`.
1348 pub const SYSNAME: &'static str = "android";
1350 /// Specifies the filename prefix used for shared libraries on this
1351 /// platform: in this case, `lib`.
1352 pub const DLL_PREFIX: &'static str = "lib";
1354 /// Specifies the filename suffix used for shared libraries on this
1355 /// platform: in this case, `.so`.
1356 pub const DLL_SUFFIX: &'static str = ".so";
1358 /// Specifies the file extension used for shared libraries on this
1359 /// platform that goes after the dot: in this case, `so`.
1360 pub const DLL_EXTENSION: &'static str = "so";
1362 /// Specifies the filename suffix used for executable binaries on this
1363 /// platform: in this case, the empty string.
1364 pub const EXE_SUFFIX: &'static str = "";
1366 /// Specifies the file extension, if any, used for executable binaries
1367 /// on this platform: in this case, the empty string.
1368 pub const EXE_EXTENSION: &'static str = "";
1371 #[cfg(target_os = "windows")]
1373 pub use os::arch_consts::ARCH;
1375 pub const FAMILY: &'static str = "windows";
1377 /// A string describing the specific operating system in use: in this
1378 /// case, `windows`.
1379 pub const SYSNAME: &'static str = "windows";
1381 /// Specifies the filename prefix used for shared libraries on this
1382 /// platform: in this case, the empty string.
1383 pub const DLL_PREFIX: &'static str = "";
1385 /// Specifies the filename suffix used for shared libraries on this
1386 /// platform: in this case, `.dll`.
1387 pub const DLL_SUFFIX: &'static str = ".dll";
1389 /// Specifies the file extension used for shared libraries on this
1390 /// platform that goes after the dot: in this case, `dll`.
1391 pub const DLL_EXTENSION: &'static str = "dll";
1393 /// Specifies the filename suffix used for executable binaries on this
1394 /// platform: in this case, `.exe`.
1395 pub const EXE_SUFFIX: &'static str = ".exe";
1397 /// Specifies the file extension, if any, used for executable binaries
1398 /// on this platform: in this case, `exe`.
1399 pub const EXE_EXTENSION: &'static str = "exe";
1402 #[cfg(target_arch = "x86")]
1404 pub const ARCH: &'static str = "x86";
1407 #[cfg(target_arch = "x86_64")]
1409 pub const ARCH: &'static str = "x86_64";
1412 #[cfg(target_arch = "arm")]
1414 pub const ARCH: &'static str = "arm";
1417 #[cfg(target_arch = "aarch64")]
1419 pub const ARCH: &'static str = "aarch64";
1422 #[cfg(target_arch = "mips")]
1424 pub const ARCH: &'static str = "mips";
1427 #[cfg(target_arch = "mipsel")]
1429 pub const ARCH: &'static str = "mipsel";
1437 use os::{env, getcwd, getenv, make_absolute};
1438 use os::{split_paths, join_paths, setenv, unsetenv};
1444 pub fn last_os_error() {
1445 debug!("{}", os::last_os_error());
1448 fn make_rand_name() -> String {
1449 let mut rng = rand::thread_rng();
1450 let n = format!("TEST{}", rng.gen_ascii_chars().take(10u)
1451 .collect::<String>());
1452 assert!(getenv(n.as_slice()).is_none());
1457 fn test_num_cpus() {
1458 assert!(os::num_cpus() > 0);
1463 let n = make_rand_name();
1464 setenv(n.as_slice(), "VALUE");
1465 assert_eq!(getenv(n.as_slice()), Some("VALUE".to_string()));
1469 fn test_unsetenv() {
1470 let n = make_rand_name();
1471 setenv(n.as_slice(), "VALUE");
1472 unsetenv(n.as_slice());
1473 assert_eq!(getenv(n.as_slice()), None);
1478 fn test_setenv_overwrite() {
1479 let n = make_rand_name();
1480 setenv(n.as_slice(), "1");
1481 setenv(n.as_slice(), "2");
1482 assert_eq!(getenv(n.as_slice()), Some("2".to_string()));
1483 setenv(n.as_slice(), "");
1484 assert_eq!(getenv(n.as_slice()), Some("".to_string()));
1487 // Windows GetEnvironmentVariable requires some extra work to make sure
1488 // the buffer the variable is copied into is the right size
1491 fn test_getenv_big() {
1492 let mut s = "".to_string();
1495 s.push_str("aaaaaaaaaa");
1498 let n = make_rand_name();
1499 setenv(n.as_slice(), s.as_slice());
1500 debug!("{}", s.clone());
1501 assert_eq!(getenv(n.as_slice()), Some(s));
1505 fn test_self_exe_name() {
1506 let path = os::self_exe_name();
1507 assert!(path.is_some());
1508 let path = path.unwrap();
1509 debug!("{}", path.display());
1511 // Hard to test this function
1512 assert!(path.is_absolute());
1516 fn test_self_exe_path() {
1517 let path = os::self_exe_path();
1518 assert!(path.is_some());
1519 let path = path.unwrap();
1520 debug!("{}", path.display());
1522 // Hard to test this function
1523 assert!(path.is_absolute());
1528 fn test_env_getenv() {
1530 assert!(e.len() > 0u);
1532 let (n, v) = (*p).clone();
1534 let v2 = getenv(n.as_slice());
1535 // MingW seems to set some funky environment variables like
1536 // "=C:=C:\MinGW\msys\1.0\bin" and "!::=::\" that are returned
1537 // from env() but not visible from getenv().
1538 assert!(v2.is_none() || v2 == Some(v));
1543 fn test_env_set_get_huge() {
1544 let n = make_rand_name();
1545 let s = repeat("x").take(10000).collect::<String>();
1546 setenv(n.as_slice(), s.as_slice());
1547 assert_eq!(getenv(n.as_slice()), Some(s));
1548 unsetenv(n.as_slice());
1549 assert_eq!(getenv(n.as_slice()), None);
1553 fn test_env_setenv() {
1554 let n = make_rand_name();
1557 setenv(n.as_slice(), "VALUE");
1558 assert!(!e.contains(&(n.clone(), "VALUE".to_string())));
1561 assert!(e.contains(&(n, "VALUE".to_string())));
1566 assert!((!Path::new("test-path").is_absolute()));
1568 let cwd = getcwd().unwrap();
1569 debug!("Current working directory: {}", cwd.display());
1571 debug!("{}", make_absolute(&Path::new("test-path")).unwrap().display());
1572 debug!("{}", make_absolute(&Path::new("/usr/bin")).unwrap().display());
1578 let oldhome = getenv("HOME");
1580 setenv("HOME", "/home/MountainView");
1581 assert!(os::homedir() == Some(Path::new("/home/MountainView")));
1584 assert!(os::homedir().is_none());
1586 for s in oldhome.iter() {
1587 setenv("HOME", s.as_slice());
1595 let oldhome = getenv("HOME");
1596 let olduserprofile = getenv("USERPROFILE");
1599 setenv("USERPROFILE", "");
1601 assert!(os::homedir().is_none());
1603 setenv("HOME", "/home/MountainView");
1604 assert!(os::homedir() == Some(Path::new("/home/MountainView")));
1608 setenv("USERPROFILE", "/home/MountainView");
1609 assert!(os::homedir() == Some(Path::new("/home/MountainView")));
1611 setenv("HOME", "/home/MountainView");
1612 setenv("USERPROFILE", "/home/PaloAlto");
1613 assert!(os::homedir() == Some(Path::new("/home/MountainView")));
1615 for s in oldhome.iter() {
1616 setenv("HOME", s.as_slice());
1618 for s in olduserprofile.iter() {
1619 setenv("USERPROFILE", s.as_slice());
1624 fn memory_map_rw() {
1625 use result::Result::{Ok, Err};
1627 let chunk = match os::MemoryMap::new(16, &[
1628 os::MapOption::MapReadable,
1629 os::MapOption::MapWritable
1632 Err(msg) => panic!("{}", msg)
1634 assert!(chunk.len >= 16);
1638 assert!(*chunk.data == 0xBE);
1643 fn memory_map_file() {
1646 use io::fs::{File, unlink};
1647 use io::SeekStyle::SeekSet;
1648 use io::FileMode::Open;
1649 use io::FileAccess::ReadWrite;
1651 #[cfg(not(windows))]
1652 fn get_fd(file: &File) -> libc::c_int {
1653 use os::unix::AsRawFd;
1658 fn get_fd(file: &File) -> libc::HANDLE {
1659 use os::windows::AsRawHandle;
1660 file.as_raw_handle()
1663 let mut path = tmpdir();
1664 path.push("mmap_file.tmp");
1665 let size = MemoryMap::granularity() * 2;
1666 let mut file = File::open_mode(&path, Open, ReadWrite).unwrap();
1667 file.seek(size as i64, SeekSet).unwrap();
1668 file.write_u8(0).unwrap();
1670 let chunk = MemoryMap::new(size / 2, &[
1671 MapOption::MapReadable,
1672 MapOption::MapWritable,
1673 MapOption::MapFd(get_fd(&file)),
1674 MapOption::MapOffset(size / 2)
1676 assert!(chunk.len > 0);
1680 assert!(*chunk.data == 0xbe);
1684 unlink(&path).unwrap();
1689 fn split_paths_windows() {
1690 fn check_parse(unparsed: &str, parsed: &[&str]) -> bool {
1691 split_paths(unparsed) ==
1692 parsed.iter().map(|s| Path::new(*s)).collect::<Vec<_>>()
1695 assert!(check_parse("", &mut [""]));
1696 assert!(check_parse(r#""""#, &mut [""]));
1697 assert!(check_parse(";;", &mut ["", "", ""]));
1698 assert!(check_parse(r"c:\", &mut [r"c:\"]));
1699 assert!(check_parse(r"c:\;", &mut [r"c:\", ""]));
1700 assert!(check_parse(r"c:\;c:\Program Files\",
1701 &mut [r"c:\", r"c:\Program Files\"]));
1702 assert!(check_parse(r#"c:\;c:\"foo"\"#, &mut [r"c:\", r"c:\foo\"]));
1703 assert!(check_parse(r#"c:\;c:\"foo;bar"\;c:\baz"#,
1704 &mut [r"c:\", r"c:\foo;bar\", r"c:\baz"]));
1709 fn split_paths_unix() {
1710 fn check_parse(unparsed: &str, parsed: &[&str]) -> bool {
1711 split_paths(unparsed) ==
1712 parsed.iter().map(|s| Path::new(*s)).collect::<Vec<_>>()
1715 assert!(check_parse("", &mut [""]));
1716 assert!(check_parse("::", &mut ["", "", ""]));
1717 assert!(check_parse("/", &mut ["/"]));
1718 assert!(check_parse("/:", &mut ["/", ""]));
1719 assert!(check_parse("/:/usr/local", &mut ["/", "/usr/local"]));
1724 fn join_paths_unix() {
1725 fn test_eq(input: &[&str], output: &str) -> bool {
1726 join_paths(input).unwrap() == output.as_bytes()
1729 assert!(test_eq(&[], ""));
1730 assert!(test_eq(&["/bin", "/usr/bin", "/usr/local/bin"],
1731 "/bin:/usr/bin:/usr/local/bin"));
1732 assert!(test_eq(&["", "/bin", "", "", "/usr/bin", ""],
1733 ":/bin:::/usr/bin:"));
1734 assert!(join_paths(&["/te:st"]).is_err());
1739 fn join_paths_windows() {
1740 fn test_eq(input: &[&str], output: &str) -> bool {
1741 join_paths(input).unwrap() == output.as_bytes()
1744 assert!(test_eq(&[], ""));
1745 assert!(test_eq(&[r"c:\windows", r"c:\"],
1746 r"c:\windows;c:\"));
1747 assert!(test_eq(&["", r"c:\windows", "", "", r"c:\", ""],
1748 r";c:\windows;;;c:\;"));
1749 assert!(test_eq(&[r"c:\te;st", r"c:\"],
1750 r#""c:\te;st";c:\"#));
1751 assert!(join_paths(&[r#"c:\te"st"#]).is_err());
1754 // More recursive_mkdir tests are in extra::tempfile