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.
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.
12 * Higher-level interfaces to libc::* functions and operating system services.
14 * In general these take and return rust types, use rust idioms (enums,
15 * closures, vectors) rather than C idioms, and do more extensive safety
18 * This module is not meant to only contain 1:1 mappings to libc entries; any
19 * os-interface code that is reasonably useful and broadly applicable can go
20 * here. Including utility routines that merely build on other os code.
22 * We assume the general case is that users do not care, and do not want to
23 * be made to care, which operating system they are on. While they may want
24 * to special case various special cases -- and so we will not _hide_ the
25 * facts of which OS the user is on -- they should be given the opportunity
26 * to write OS-ignorant code by default.
31 #![allow(missing_doc)]
32 #![allow(non_snake_case)]
35 use collections::{Collection, MutableSeq};
37 use io::{IoResult, IoError};
39 use libc::{c_void, c_int};
42 use option::{Some, None, Option};
44 use path::{Path, GenericPath, BytesContainer};
47 use result::{Err, Ok, Result};
48 use slice::{Slice, ImmutableSlice, MutableSlice, ImmutablePartialEqSlice};
49 use slice::CloneableVector;
50 use str::{Str, StrSlice, StrAllocating};
52 use sync::atomic::{AtomicInt, INIT_ATOMIC_INT, SeqCst};
55 #[cfg(unix)] use c_str::ToCStr;
56 #[cfg(unix)] use libc::c_char;
58 /// Get the number of cores available
59 pub fn num_cpus() -> uint {
61 return rust_get_num_cpus() as uint;
65 fn rust_get_num_cpus() -> libc::uintptr_t;
69 pub static TMPBUF_SZ : uint = 1000u;
70 static BUF_BYTES : uint = 2048u;
72 /// Returns the current working directory as a Path.
76 /// Fails if the current working directory value is invalid:
79 /// * Current directory does not exist.
80 /// * There are insufficient permissions to access the current directory.
87 /// // We assume that we are in a valid directory like "/home".
88 /// let current_working_directory = os::getcwd();
89 /// println!("The current directory is {}", current_working_directory.display());
93 pub fn getcwd() -> Path {
96 let mut buf = [0 as c_char, ..BUF_BYTES];
98 if libc::getcwd(buf.as_mut_ptr(), buf.len() as libc::size_t).is_null() {
101 Path::new(CString::new(buf.as_ptr(), false))
105 /// Returns the current working directory as a Path.
109 /// Fails if the current working directory value is invalid.
112 /// * Current directory does not exist.
113 /// * There are insufficient permissions to access the current directory.
120 /// // We assume that we are in a valid directory like "C:\\Windows".
121 /// let current_working_directory = os::getcwd();
122 /// println!("The current directory is {}", current_working_directory.display());
126 pub fn getcwd() -> Path {
128 use libc::GetCurrentDirectoryW;
130 let mut buf = [0 as u16, ..BUF_BYTES];
132 if libc::GetCurrentDirectoryW(buf.len() as DWORD, buf.as_mut_ptr()) == 0 as DWORD {
136 Path::new(String::from_utf16(::str::truncate_utf16_at_nul(buf))
137 .expect("GetCurrentDirectoryW returned invalid UTF-16"))
142 use libc::types::os::arch::extra::DWORD;
144 use option::{None, Option};
147 use slice::{MutableSlice, ImmutableSlice};
152 pub fn fill_utf16_buf_and_decode(f: |*mut u16, DWORD| -> DWORD)
156 let mut n = TMPBUF_SZ as DWORD;
158 let mut done = false;
160 let mut buf = Vec::from_elem(n as uint, 0u16);
161 let k = f(buf.as_mut_ptr(), n);
162 if k == (0 as DWORD) {
165 libc::GetLastError() ==
166 libc::ERROR_INSUFFICIENT_BUFFER as DWORD {
174 let sub = buf.slice(0, k as uint);
175 // We want to explicitly catch the case when the
176 // closure returned invalid UTF-16, rather than
177 // set `res` to None and continue.
178 let s = String::from_utf16(sub)
179 .expect("fill_utf16_buf_and_decode: closure created invalid UTF-16");
180 res = option::Some(s)
189 Accessing environment variables is not generally threadsafe.
190 Serialize access through a global lock.
192 fn with_env_lock<T>(f: || -> T) -> T {
193 use rt::mutex::{StaticNativeMutex, NATIVE_MUTEX_INIT};
195 static mut lock: StaticNativeMutex = NATIVE_MUTEX_INIT;
198 let _guard = lock.lock();
203 /// Returns a vector of (variable, value) pairs, for all the environment
204 /// variables of the current process.
206 /// Invalid UTF-8 bytes are replaced with \uFFFD. See `String::from_utf8_lossy()`
214 /// // We will iterate through the references to the element returned by os::env();
215 /// for &(ref key, ref value) in os::env().iter() {
216 /// println!("'{}': '{}'", key, value );
219 pub fn env() -> Vec<(String,String)> {
220 env_as_bytes().into_iter().map(|(k,v)| {
221 let k = String::from_utf8_lossy(k.as_slice()).into_string();
222 let v = String::from_utf8_lossy(v.as_slice()).into_string();
227 /// Returns a vector of (variable, value) byte-vector pairs for all the
228 /// environment variables of the current process.
229 pub fn env_as_bytes() -> Vec<(Vec<u8>,Vec<u8>)> {
232 unsafe fn get_env_pairs() -> Vec<Vec<u8>> {
235 use libc::funcs::extra::kernel32::{
236 GetEnvironmentStringsW,
237 FreeEnvironmentStringsW
239 let ch = GetEnvironmentStringsW();
241 fail!("os::env() failure getting env string from OS: {}",
242 os::last_os_error());
244 // Here, we lossily decode the string as UTF16.
246 // The docs suggest that the result should be in Unicode, but
247 // Windows doesn't guarantee it's actually UTF16 -- it doesn't
248 // validate the environment string passed to CreateProcess nor
249 // SetEnvironmentVariable. Yet, it's unlikely that returning a
250 // raw u16 buffer would be of practical use since the result would
251 // be inherently platform-dependent and introduce additional
252 // complexity to this code.
254 // Using the non-Unicode version of GetEnvironmentStrings is even
255 // worse since the result is in an OEM code page. Characters that
256 // can't be encoded in the code page would be turned into question
258 let mut result = Vec::new();
260 while *ch.offset(i) != 0 {
261 let p = &*ch.offset(i);
263 while *(p as *const _).offset(len) != 0 {
266 raw::buf_as_slice(p, len as uint, |s| {
267 result.push(String::from_utf16_lossy(s).into_bytes());
271 FreeEnvironmentStringsW(ch);
275 unsafe fn get_env_pairs() -> Vec<Vec<u8>> {
279 fn rust_env_pairs() -> *const *const c_char;
281 let mut environ = rust_env_pairs();
282 if environ as uint == 0 {
283 fail!("os::env() failure getting env string from OS: {}",
284 os::last_os_error());
286 let mut result = Vec::new();
287 while *environ != 0 as *const _ {
289 CString::new(*environ, false).as_bytes_no_nul().to_vec();
290 result.push(env_pair);
291 environ = environ.offset(1);
296 fn env_convert(input: Vec<Vec<u8>>) -> Vec<(Vec<u8>, Vec<u8>)> {
297 let mut pairs = Vec::new();
298 for p in input.iter() {
299 let mut it = p.as_slice().splitn(1, |b| *b == b'=');
300 let key = it.next().unwrap().to_vec();
301 let default: &[u8] = &[];
302 let val = it.next().unwrap_or(default).to_vec();
303 pairs.push((key, val));
308 let unparsed_environ = get_env_pairs();
309 env_convert(unparsed_environ)
315 /// Fetches the environment variable `n` from the current process, returning
316 /// None if the variable isn't set.
318 /// Any invalid UTF-8 bytes in the value are replaced by \uFFFD. See
319 /// `String::from_utf8_lossy()` for details.
323 /// Fails if `n` has any interior NULs.
330 /// let key = "HOME";
331 /// match os::getenv(key) {
332 /// Some(val) => println!("{}: {}", key, val),
333 /// None => println!("{} is not defined in the environment.", key)
336 pub fn getenv(n: &str) -> Option<String> {
337 getenv_as_bytes(n).map(|v| String::from_utf8_lossy(v.as_slice()).into_string())
341 /// Fetches the environment variable `n` byte vector from the current process,
342 /// returning None if the variable isn't set.
346 /// Fails if `n` has any interior NULs.
347 pub fn getenv_as_bytes(n: &str) -> Option<Vec<u8>> {
352 let s = n.with_c_str(|buf| libc::getenv(buf));
356 Some(CString::new(s as *const i8, false).as_bytes_no_nul().to_vec())
363 /// Fetches the environment variable `n` from the current process, returning
364 /// None if the variable isn't set.
365 pub fn getenv(n: &str) -> Option<String> {
368 use os::windows::{fill_utf16_buf_and_decode};
369 let mut n: Vec<u16> = n.utf16_units().collect();
371 fill_utf16_buf_and_decode(|buf, sz| {
372 libc::GetEnvironmentVariableW(n.as_ptr(), buf, sz)
379 /// Fetches the environment variable `n` byte vector from the current process,
380 /// returning None if the variable isn't set.
381 pub fn getenv_as_bytes(n: &str) -> Option<Vec<u8>> {
382 getenv(n).map(|s| s.into_bytes())
385 /// Sets the environment variable `n` to the value `v` for the currently running
394 /// os::setenv(key, "VALUE");
395 /// match os::getenv(key) {
396 /// Some(ref val) => println!("{}: {}", key, val),
397 /// None => println!("{} is not defined in the environment.", key)
400 pub fn setenv<T: BytesContainer>(n: &str, v: T) {
402 fn _setenv(n: &str, v: &[u8]) {
405 n.with_c_str(|nbuf| {
406 v.with_c_str(|vbuf| {
407 libc::funcs::posix01::unistd::setenv(nbuf, vbuf, 1);
415 fn _setenv(n: &str, v: &[u8]) {
416 let mut n: Vec<u16> = n.utf16_units().collect();
418 let mut v: Vec<u16> = ::str::from_utf8(v).unwrap().utf16_units().collect();
423 libc::SetEnvironmentVariableW(n.as_ptr(), v.as_ptr());
428 _setenv(n, v.container_as_bytes())
431 /// Remove a variable from the environment entirely.
432 pub fn unsetenv(n: &str) {
434 fn _unsetenv(n: &str) {
437 n.with_c_str(|nbuf| {
438 libc::funcs::posix01::unistd::unsetenv(nbuf);
445 fn _unsetenv(n: &str) {
446 let mut n: Vec<u16> = n.utf16_units().collect();
450 libc::SetEnvironmentVariableW(n.as_ptr(), ptr::null());
457 /// Parses input according to platform conventions for the `PATH`
458 /// environment variable.
464 /// let key = "PATH";
465 /// match os::getenv_as_bytes(key) {
467 /// for path in os::split_paths(paths).iter() {
468 /// println!("'{}'", path.display());
471 /// None => println!("{} is not defined in the environment.", key)
474 pub fn split_paths<T: BytesContainer>(unparsed: T) -> Vec<Path> {
476 fn _split_paths<T: BytesContainer>(unparsed: T) -> Vec<Path> {
477 unparsed.container_as_bytes()
478 .split(|b| *b == b':')
484 fn _split_paths<T: BytesContainer>(unparsed: T) -> Vec<Path> {
485 // On Windows, the PATH environment variable is semicolon separated. Double
486 // quotes are used as a way of introducing literal semicolons (since
487 // c:\some;dir is a valid Windows path). Double quotes are not themselves
488 // permitted in path names, so there is no way to escape a double quote.
489 // Quoted regions can appear in arbitrary locations, so
491 // c:\foo;c:\som"e;di"r;c:\bar
493 // Should parse as [c:\foo, c:\some;dir, c:\bar].
495 // (The above is based on testing; there is no clear reference available
498 let mut parsed = Vec::new();
499 let mut in_progress = Vec::new();
500 let mut in_quote = false;
502 for b in unparsed.container_as_bytes().iter() {
504 b';' if !in_quote => {
505 parsed.push(Path::new(in_progress.as_slice()));
506 in_progress.truncate(0)
509 in_quote = !in_quote;
512 in_progress.push(*b);
516 parsed.push(Path::new(in_progress));
520 _split_paths(unparsed)
523 /// Joins a collection of `Path`s appropriately for the `PATH`
524 /// environment variable.
526 /// Returns a `Vec<u8>` on success, since `Path`s are not utf-8
527 /// encoded on all platforms.
529 /// Returns an `Err` (containing an error message) if one of the input
530 /// `Path`s contains an invalid character for constructing the `PATH`
531 /// variable (a double quote on Windows or a colon on Unix).
537 /// use std::path::Path;
539 /// let key = "PATH";
540 /// let mut paths = os::getenv_as_bytes(key).map_or(Vec::new(), os::split_paths);
541 /// paths.push(Path::new("/home/xyz/bin"));
542 /// os::setenv(key, os::join_paths(paths.as_slice()).unwrap());
544 pub fn join_paths<T: BytesContainer>(paths: &[T]) -> Result<Vec<u8>, &'static str> {
546 fn _join_paths<T: BytesContainer>(paths: &[T]) -> Result<Vec<u8>, &'static str> {
547 let mut joined = Vec::new();
550 for (i, path) in paths.iter().map(|p| p.container_as_bytes()).enumerate() {
551 if i > 0 { joined.push(sep) }
552 if path.contains(&b'"') {
553 return Err("path segment contains `\"`");
554 } else if path.contains(&sep) {
556 joined.push_all(path);
559 joined.push_all(path);
567 fn _join_paths<T: BytesContainer>(paths: &[T]) -> Result<Vec<u8>, &'static str> {
568 let mut joined = Vec::new();
571 for (i, path) in paths.iter().map(|p| p.container_as_bytes()).enumerate() {
572 if i > 0 { joined.push(sep) }
573 if path.contains(&sep) { return Err("path segment contains separator `:`") }
574 joined.push_all(path);
583 /// A low-level OS in-memory pipe.
585 /// A file descriptor representing the reading end of the pipe. Data written
586 /// on the `out` file descriptor can be read from this file descriptor.
588 /// A file descriptor representing the write end of the pipe. Data written
589 /// to this file descriptor can be read from the `input` file descriptor.
593 /// Creates a new low-level OS in-memory pipe.
595 /// This function can fail to succeed if there are no more resources available
596 /// to allocate a pipe.
598 /// This function is also unsafe as there is no destructor associated with the
599 /// `Pipe` structure will return. If it is not arranged for the returned file
600 /// descriptors to be closed, the file descriptors will leak. For safe handling
601 /// of this scenario, use `std::io::PipeStream` instead.
602 pub unsafe fn pipe() -> IoResult<Pipe> {
606 unsafe fn _pipe() -> IoResult<Pipe> {
607 let mut fds = [0, ..2];
608 match libc::pipe(fds.as_mut_ptr()) {
609 0 => Ok(Pipe { reader: fds[0], writer: fds[1] }),
610 _ => Err(IoError::last_error()),
615 unsafe fn _pipe() -> IoResult<Pipe> {
616 // Windows pipes work subtly differently than unix pipes, and their
617 // inheritance has to be handled in a different way that I do not
618 // fully understand. Here we explicitly make the pipe non-inheritable,
619 // which means to pass it to a subprocess they need to be duplicated
620 // first, as in std::run.
621 let mut fds = [0, ..2];
622 match libc::pipe(fds.as_mut_ptr(), 1024 as ::libc::c_uint,
623 (libc::O_BINARY | libc::O_NOINHERIT) as c_int) {
625 assert!(fds[0] != -1 && fds[0] != 0);
626 assert!(fds[1] != -1 && fds[1] != 0);
627 Ok(Pipe { reader: fds[0], writer: fds[1] })
629 _ => Err(IoError::last_error()),
634 /// Returns the proper dll filename for the given basename of a file
636 #[cfg(not(target_os="ios"))]
637 pub fn dll_filename(base: &str) -> String {
638 format!("{}{}{}", consts::DLL_PREFIX, base, consts::DLL_SUFFIX)
641 /// Optionally returns the filesystem path to the current executable which is
642 /// running but with the executable name.
649 /// match os::self_exe_name() {
650 /// Some(exe_path) => println!("Path of this executable is: {}", exe_path.display()),
651 /// None => println!("Unable to get the path of this executable!")
654 pub fn self_exe_name() -> Option<Path> {
656 #[cfg(any(target_os = "freebsd", target_os = "dragonfly"))]
657 fn load_self() -> Option<Vec<u8>> {
659 use libc::funcs::bsd44::*;
660 use libc::consts::os::extra::*;
661 let mut mib = vec![CTL_KERN as c_int,
663 KERN_PROC_PATHNAME as c_int,
665 let mut sz: libc::size_t = 0;
666 let err = sysctl(mib.as_mut_ptr(), mib.len() as ::libc::c_uint,
667 ptr::null_mut(), &mut sz, ptr::null_mut(),
669 if err != 0 { return None; }
670 if sz == 0 { return None; }
671 let mut v: Vec<u8> = Vec::with_capacity(sz as uint);
672 let err = sysctl(mib.as_mut_ptr(), mib.len() as ::libc::c_uint,
673 v.as_mut_ptr() as *mut c_void, &mut sz,
674 ptr::null_mut(), 0u as libc::size_t);
675 if err != 0 { return None; }
676 if sz == 0 { return None; }
677 v.set_len(sz as uint - 1); // chop off trailing NUL
682 #[cfg(any(target_os = "linux", target_os = "android"))]
683 fn load_self() -> Option<Vec<u8>> {
686 match io::fs::readlink(&Path::new("/proc/self/exe")) {
687 Ok(path) => Some(path.into_vec()),
692 #[cfg(any(target_os = "macos", target_os = "ios"))]
693 fn load_self() -> Option<Vec<u8>> {
695 use libc::funcs::extra::_NSGetExecutablePath;
697 _NSGetExecutablePath(ptr::null_mut(), &mut sz);
698 if sz == 0 { return None; }
699 let mut v: Vec<u8> = Vec::with_capacity(sz as uint);
700 let err = _NSGetExecutablePath(v.as_mut_ptr() as *mut i8, &mut sz);
701 if err != 0 { return None; }
702 v.set_len(sz as uint - 1); // chop off trailing NUL
708 fn load_self() -> Option<Vec<u8>> {
710 use os::windows::fill_utf16_buf_and_decode;
711 fill_utf16_buf_and_decode(|buf, sz| {
712 libc::GetModuleFileNameW(0u as libc::DWORD, buf, sz)
713 }).map(|s| s.into_string().into_bytes())
717 load_self().and_then(Path::new_opt)
720 /// Optionally returns the filesystem path to the current executable which is
723 /// Like self_exe_name() but without the binary's name.
730 /// match os::self_exe_path() {
731 /// Some(exe_path) => println!("Executable's Path is: {}", exe_path.display()),
732 /// None => println!("Impossible to fetch the path of this executable.")
735 pub fn self_exe_path() -> Option<Path> {
736 self_exe_name().map(|mut p| { p.pop(); p })
739 /// Optionally returns the path to the current user's home directory if known.
743 /// Returns the value of the 'HOME' environment variable if it is set
744 /// and not equal to the empty string.
748 /// Returns the value of the 'HOME' environment variable if it is
749 /// set and not equal to the empty string. Otherwise, returns the value of the
750 /// 'USERPROFILE' environment variable if it is set and not equal to the empty
758 /// match os::homedir() {
759 /// Some(ref p) => println!("{}", p.display()),
760 /// None => println!("Impossible to get your home dir!")
763 pub fn homedir() -> Option<Path> {
766 fn _homedir() -> Option<Path> {
772 fn _homedir() -> Option<Path> {
773 aux_homedir("HOME").or(aux_homedir("USERPROFILE"))
777 fn aux_homedir(home_name: &str) -> Option<Path> {
778 match getenv_as_bytes(home_name) {
780 if p.is_empty() { None } else { Path::new_opt(p) }
789 * Returns the path to a temporary directory.
791 * On Unix, returns the value of the 'TMPDIR' environment variable if it is
792 * set, otherwise for non-Android it returns '/tmp'. If Android, since there
793 * is no global temporary folder (it is usually allocated per-app), we return
796 * On Windows, returns the value of, in order, the 'TMP', 'TEMP',
797 * 'USERPROFILE' environment variable if any are set and not the empty
798 * string. Otherwise, tmpdir returns the path to the Windows directory.
800 pub fn tmpdir() -> Path {
803 fn getenv_nonempty(v: &str) -> Option<Path> {
816 fn lookup() -> Path {
817 let default = if cfg!(target_os = "android") {
818 Path::new("/data/local/tmp")
823 getenv_nonempty("TMPDIR").unwrap_or(default)
827 fn lookup() -> Path {
828 getenv_nonempty("TMP").or(
829 getenv_nonempty("TEMP").or(
830 getenv_nonempty("USERPROFILE").or(
831 getenv_nonempty("WINDIR")))).unwrap_or(Path::new("C:\\Windows"))
836 /// Convert a relative path to an absolute path
838 /// If the given path is relative, return it prepended with the current working
839 /// directory. If the given path is already an absolute path, return it
845 /// use std::path::Path;
847 /// // Assume we're in a path like /home/someuser
848 /// let rel_path = Path::new("..");
849 /// let abs_path = os::make_absolute(&rel_path);
850 /// println!("The absolute path is {}", abs_path.display());
851 /// // Prints "The absolute path is /home"
853 // NB: this is here rather than in path because it is a form of environment
854 // querying; what it does depends on the process working directory, not just
856 pub fn make_absolute(p: &Path) -> Path {
860 let mut ret = getcwd();
866 /// Changes the current working directory to the specified path, returning
867 /// whether the change was completed successfully or not.
872 /// use std::path::Path;
874 /// let root = Path::new("/");
875 /// assert!(os::change_dir(&root));
876 /// println!("Successfully changed working directory to {}!", root.display());
878 pub fn change_dir(p: &Path) -> bool {
882 fn chdir(p: &Path) -> bool {
883 let p = match p.as_str() {
885 let mut p = s.utf16_units().collect::<Vec<u16>>();
889 None => return false,
892 libc::SetCurrentDirectoryW(p.as_ptr()) != (0 as libc::BOOL)
897 fn chdir(p: &Path) -> bool {
900 libc::chdir(buf) == (0 as c_int)
907 /// Returns the platform-specific value of errno
908 pub fn errno() -> int {
909 #[cfg(any(target_os = "macos",
911 target_os = "freebsd"))]
912 fn errno_location() -> *const c_int {
914 fn __error() -> *const c_int;
921 #[cfg(target_os = "dragonfly")]
922 fn errno_location() -> *const c_int {
924 fn __dfly_error() -> *const c_int;
931 #[cfg(any(target_os = "linux", target_os = "android"))]
932 fn errno_location() -> *const c_int {
934 fn __errno_location() -> *const c_int;
942 (*errno_location()) as int
947 /// Returns the platform-specific value of errno
948 pub fn errno() -> uint {
949 use libc::types::os::arch::extra::DWORD;
951 #[link_name = "kernel32"]
953 fn GetLastError() -> DWORD;
957 GetLastError() as uint
961 /// Return the string corresponding to an `errno()` value of `errnum`.
966 /// // Same as println!("{}", last_os_error());
967 /// println!("{}", os::error_string(os::errno() as uint));
969 pub fn error_string(errnum: uint) -> String {
970 return strerror(errnum);
973 fn strerror(errnum: uint) -> String {
974 #[cfg(any(target_os = "macos",
976 target_os = "android",
977 target_os = "freebsd",
978 target_os = "dragonfly"))]
979 fn strerror_r(errnum: c_int, buf: *mut c_char, buflen: libc::size_t)
982 fn strerror_r(errnum: c_int, buf: *mut c_char,
983 buflen: libc::size_t) -> c_int;
986 strerror_r(errnum, buf, buflen)
990 // GNU libc provides a non-compliant version of strerror_r by default
991 // and requires macros to instead use the POSIX compliant variant.
992 // So we just use __xpg_strerror_r which is always POSIX compliant
993 #[cfg(target_os = "linux")]
994 fn strerror_r(errnum: c_int, buf: *mut c_char,
995 buflen: libc::size_t) -> c_int {
997 fn __xpg_strerror_r(errnum: c_int,
999 buflen: libc::size_t)
1003 __xpg_strerror_r(errnum, buf, buflen)
1007 let mut buf = [0 as c_char, ..TMPBUF_SZ];
1009 let p = buf.as_mut_ptr();
1011 if strerror_r(errnum as c_int, p, buf.len() as libc::size_t) < 0 {
1012 fail!("strerror_r failure");
1015 ::string::raw::from_buf(p as *const u8)
1020 fn strerror(errnum: uint) -> String {
1021 use libc::types::os::arch::extra::DWORD;
1022 use libc::types::os::arch::extra::LPWSTR;
1023 use libc::types::os::arch::extra::LPVOID;
1024 use libc::types::os::arch::extra::WCHAR;
1026 #[link_name = "kernel32"]
1028 fn FormatMessageW(flags: DWORD,
1034 args: *const c_void)
1038 static FORMAT_MESSAGE_FROM_SYSTEM: DWORD = 0x00001000;
1039 static FORMAT_MESSAGE_IGNORE_INSERTS: DWORD = 0x00000200;
1041 // This value is calculated from the macro
1042 // MAKELANGID(LANG_SYSTEM_DEFAULT, SUBLANG_SYS_DEFAULT)
1043 let langId = 0x0800 as DWORD;
1045 let mut buf = [0 as WCHAR, ..TMPBUF_SZ];
1048 let res = FormatMessageW(FORMAT_MESSAGE_FROM_SYSTEM |
1049 FORMAT_MESSAGE_IGNORE_INSERTS,
1057 // Sometimes FormatMessageW can fail e.g. system doesn't like langId,
1058 let fm_err = errno();
1059 return format!("OS Error {} (FormatMessageW() returned error {})", errnum, fm_err);
1062 let msg = String::from_utf16(::str::truncate_utf16_at_nul(buf));
1064 Some(msg) => format!("OS Error {}: {}", errnum, msg),
1065 None => format!("OS Error {} (FormatMessageW() returned invalid UTF-16)", errnum),
1071 /// Get a string representing the platform-dependent last error
1072 pub fn last_os_error() -> String {
1073 error_string(errno() as uint)
1076 static mut EXIT_STATUS: AtomicInt = INIT_ATOMIC_INT;
1079 * Sets the process exit code
1081 * Sets the exit code returned by the process if all supervised tasks
1082 * terminate successfully (without failing). If the current root task fails
1083 * and is supervised by the scheduler then any user-specified exit status is
1084 * ignored and the process exits with the default failure status.
1086 * Note that this is not synchronized against modifications of other threads.
1088 pub fn set_exit_status(code: int) {
1089 unsafe { EXIT_STATUS.store(code, SeqCst) }
1092 /// Fetches the process's current exit code. This defaults to 0 and can change
1093 /// by calling `set_exit_status`.
1094 pub fn get_exit_status() -> int {
1095 unsafe { EXIT_STATUS.load(SeqCst) }
1098 #[cfg(target_os = "macos")]
1099 unsafe fn load_argc_and_argv(argc: int,
1100 argv: *const *const c_char) -> Vec<Vec<u8>> {
1103 Vec::from_fn(argc as uint, |i| {
1104 CString::new(*argv.offset(i as int), false).as_bytes_no_nul().to_vec()
1109 * Returns the command line arguments
1111 * Returns a list of the command line arguments.
1113 #[cfg(target_os = "macos")]
1114 fn real_args_as_bytes() -> Vec<Vec<u8>> {
1116 let (argc, argv) = (*_NSGetArgc() as int,
1117 *_NSGetArgv() as *const *const c_char);
1118 load_argc_and_argv(argc, argv)
1122 // As _NSGetArgc and _NSGetArgv aren't mentioned in iOS docs
1123 // and use underscores in their names - they're most probably
1124 // are considered private and therefore should be avoided
1125 // Here is another way to get arguments using Objective C
1128 // In general it looks like:
1130 // let args = [[NSProcessInfo processInfo] arguments]
1131 // for i in range(0, [args count])
1132 // res.push([args objectAtIndex:i])
1134 #[cfg(target_os = "ios")]
1135 fn real_args_as_bytes() -> Vec<Vec<u8>> {
1140 #[link(name = "objc")]
1142 fn sel_registerName(name: *const libc::c_uchar) -> Sel;
1143 fn objc_msgSend(obj: NsId, sel: Sel, ...) -> NsId;
1144 fn objc_getClass(class_name: *const libc::c_uchar) -> NsId;
1147 #[link(name = "Foundation", kind = "framework")]
1150 type Sel = *const libc::c_void;
1151 type NsId = *const libc::c_void;
1153 let mut res = Vec::new();
1156 let processInfoSel = sel_registerName("processInfo\0".as_ptr());
1157 let argumentsSel = sel_registerName("arguments\0".as_ptr());
1158 let utf8Sel = sel_registerName("UTF8String\0".as_ptr());
1159 let countSel = sel_registerName("count\0".as_ptr());
1160 let objectAtSel = sel_registerName("objectAtIndex:\0".as_ptr());
1162 let klass = objc_getClass("NSProcessInfo\0".as_ptr());
1163 let info = objc_msgSend(klass, processInfoSel);
1164 let args = objc_msgSend(info, argumentsSel);
1166 let cnt: int = mem::transmute(objc_msgSend(args, countSel));
1167 for i in range(0, cnt) {
1168 let tmp = objc_msgSend(args, objectAtSel, i);
1169 let utf_c_str: *const libc::c_char =
1170 mem::transmute(objc_msgSend(tmp, utf8Sel));
1171 let s = CString::new(utf_c_str, false);
1172 res.push(s.as_bytes_no_nul().to_vec())
1179 #[cfg(any(target_os = "linux",
1180 target_os = "android",
1181 target_os = "freebsd",
1182 target_os = "dragonfly"))]
1183 fn real_args_as_bytes() -> Vec<Vec<u8>> {
1186 match rt::args::clone() {
1188 None => fail!("process arguments not initialized")
1192 #[cfg(not(windows))]
1193 fn real_args() -> Vec<String> {
1194 real_args_as_bytes().into_iter()
1196 String::from_utf8_lossy(v.as_slice()).into_string()
1201 fn real_args() -> Vec<String> {
1204 let mut nArgs: c_int = 0;
1205 let lpArgCount: *mut c_int = &mut nArgs;
1206 let lpCmdLine = unsafe { GetCommandLineW() };
1207 let szArgList = unsafe { CommandLineToArgvW(lpCmdLine, lpArgCount) };
1209 let args = Vec::from_fn(nArgs as uint, |i| unsafe {
1210 // Determine the length of this argument.
1211 let ptr = *szArgList.offset(i as int);
1213 while *ptr.offset(len as int) != 0 { len += 1; }
1215 // Push it onto the list.
1216 let opt_s = slice::raw::buf_as_slice(ptr as *const _, len, |buf| {
1217 String::from_utf16(::str::truncate_utf16_at_nul(buf))
1219 opt_s.expect("CommandLineToArgvW returned invalid UTF-16")
1223 LocalFree(szArgList as *mut c_void);
1230 fn real_args_as_bytes() -> Vec<Vec<u8>> {
1231 real_args().into_iter().map(|s| s.into_bytes()).collect()
1234 type LPCWSTR = *const u16;
1237 #[link_name="kernel32"]
1239 fn GetCommandLineW() -> LPCWSTR;
1240 fn LocalFree(ptr: *mut c_void);
1244 #[link_name="shell32"]
1246 fn CommandLineToArgvW(lpCmdLine: LPCWSTR,
1247 pNumArgs: *mut c_int) -> *mut *mut u16;
1250 /// Returns the arguments which this program was started with (normally passed
1251 /// via the command line).
1253 /// The arguments are interpreted as utf-8, with invalid bytes replaced with \uFFFD.
1254 /// See `String::from_utf8_lossy` for details.
1260 /// // Prints each argument on a separate line
1261 /// for argument in os::args().iter() {
1262 /// println!("{}", argument);
1265 pub fn args() -> Vec<String> {
1269 /// Returns the arguments which this program was started with (normally passed
1270 /// via the command line) as byte vectors.
1271 pub fn args_as_bytes() -> Vec<Vec<u8>> {
1272 real_args_as_bytes()
1275 #[cfg(target_os = "macos")]
1277 // These functions are in crt_externs.h.
1278 pub fn _NSGetArgc() -> *mut c_int;
1279 pub fn _NSGetArgv() -> *mut *mut *mut c_char;
1282 // Round up `from` to be divisible by `to`
1283 fn round_up(from: uint, to: uint) -> uint {
1284 let r = if from % to == 0 {
1287 from + to - (from % to)
1296 /// Returns the page size of the current architecture in bytes.
1298 pub fn page_size() -> uint {
1300 libc::sysconf(libc::_SC_PAGESIZE) as uint
1304 /// Returns the page size of the current architecture in bytes.
1306 pub fn page_size() -> uint {
1309 let mut info = mem::zeroed();
1310 libc::GetSystemInfo(&mut info);
1312 return info.dwPageSize as uint;
1316 /// A memory mapped file or chunk of memory. This is a very system-specific
1317 /// interface to the OS's memory mapping facilities (`mmap` on POSIX,
1318 /// `VirtualAlloc`/`CreateFileMapping` on Windows). It makes no attempt at
1319 /// abstracting platform differences, besides in error values returned. Consider
1320 /// yourself warned.
1322 /// The memory map is released (unmapped) when the destructor is run, so don't
1323 /// let it leave scope by accident if you want it to stick around.
1324 pub struct MemoryMap {
1327 kind: MemoryMapKind,
1330 /// Type of memory map
1331 pub enum MemoryMapKind {
1332 /// Virtual memory map. Usually used to change the permissions of a given
1333 /// chunk of memory. Corresponds to `VirtualAlloc` on Windows.
1335 /// Virtual memory map. Usually used to change the permissions of a given
1336 /// chunk of memory, or for allocation. Corresponds to `VirtualAlloc` on
1341 /// Options the memory map is created with
1342 pub enum MapOption {
1343 /// The memory should be readable
1345 /// The memory should be writable
1347 /// The memory should be executable
1349 /// Create a map for a specific address range. Corresponds to `MAP_FIXED` on
1352 /// Create a memory mapping for a file with a given fd.
1354 /// When using `MapFd`, the start of the map is `uint` bytes from the start
1357 /// On POSIX, this can be used to specify the default flags passed to
1358 /// `mmap`. By default it uses `MAP_PRIVATE` and, if not using `MapFd`,
1359 /// `MAP_ANON`. This will override both of those. This is platform-specific
1360 /// (the exact values used) and ignored on Windows.
1361 MapNonStandardFlags(c_int),
1364 /// Possible errors when creating a map.
1366 /// ## The following are POSIX-specific
1368 /// fd was not open for reading or, if using `MapWritable`, was not open for
1371 /// fd was not valid
1373 /// Either the address given by `MapAddr` or offset given by `MapOffset` was
1374 /// not a multiple of `MemoryMap::granularity` (unaligned to page size).
1376 /// With `MapFd`, the fd does not support mapping.
1378 /// If using `MapAddr`, the address + `min_len` was outside of the process's
1379 /// address space. If using `MapFd`, the target of the fd didn't have enough
1380 /// resources to fulfill the request.
1382 /// A zero-length map was requested. This is invalid according to
1383 /// [POSIX](http://pubs.opengroup.org/onlinepubs/9699919799/functions/mmap.html).
1384 /// Not all platforms obey this, but this wrapper does.
1386 /// Unrecognized error. The inner value is the unrecognized errno.
1388 /// ## The following are Windows-specific
1390 /// Unsupported combination of protection flags
1391 /// (`MapReadable`/`MapWritable`/`MapExecutable`).
1393 /// When using `MapFd`, `MapOffset` was given (Windows does not support this
1396 /// When using `MapFd`, there was already a mapping to the file.
1398 /// Unrecognized error from `VirtualAlloc`. The inner value is the return
1399 /// value of GetLastError.
1400 ErrVirtualAlloc(uint),
1401 /// Unrecognized error from `CreateFileMapping`. The inner value is the
1402 /// return value of `GetLastError`.
1403 ErrCreateFileMappingW(uint),
1404 /// Unrecognized error from `MapViewOfFile`. The inner value is the return
1405 /// value of `GetLastError`.
1406 ErrMapViewOfFile(uint)
1409 impl fmt::Show for MapError {
1410 fn fmt(&self, out: &mut fmt::Formatter) -> fmt::Result {
1411 let str = match *self {
1412 ErrFdNotAvail => "fd not available for reading or writing",
1413 ErrInvalidFd => "Invalid fd",
1415 "Unaligned address, invalid flags, negative length or \
1418 ErrNoMapSupport=> "File doesn't support mapping",
1419 ErrNoMem => "Invalid address, or not enough available memory",
1420 ErrUnsupProt => "Protection mode unsupported",
1421 ErrUnsupOffset => "Offset in virtual memory mode is unsupported",
1422 ErrAlreadyExists => "File mapping for specified file already exists",
1423 ErrZeroLength => "Zero-length mapping not allowed",
1424 ErrUnknown(code) => {
1425 return write!(out, "Unknown error = {}", code)
1427 ErrVirtualAlloc(code) => {
1428 return write!(out, "VirtualAlloc failure = {}", code)
1430 ErrCreateFileMappingW(code) => {
1431 return write!(out, "CreateFileMappingW failure = {}", code)
1433 ErrMapViewOfFile(code) => {
1434 return write!(out, "MapViewOfFile failure = {}", code)
1437 write!(out, "{}", str)
1443 /// Create a new mapping with the given `options`, at least `min_len` bytes
1444 /// long. `min_len` must be greater than zero; see the note on
1445 /// `ErrZeroLength`.
1446 pub fn new(min_len: uint, options: &[MapOption]) -> Result<MemoryMap, MapError> {
1450 return Err(ErrZeroLength)
1452 let mut addr: *const u8 = ptr::null();
1454 let mut flags = libc::MAP_PRIVATE;
1457 let mut custom_flags = false;
1458 let len = round_up(min_len, page_size());
1460 for &o in options.iter() {
1462 MapReadable => { prot |= libc::PROT_READ; },
1463 MapWritable => { prot |= libc::PROT_WRITE; },
1464 MapExecutable => { prot |= libc::PROT_EXEC; },
1466 flags |= libc::MAP_FIXED;
1470 flags |= libc::MAP_FILE;
1473 MapOffset(offset_) => { offset = offset_ as off_t; },
1474 MapNonStandardFlags(f) => { custom_flags = true; flags = f },
1477 if fd == -1 && !custom_flags { flags |= libc::MAP_ANON; }
1480 libc::mmap(addr as *mut c_void, len as libc::size_t, prot, flags,
1483 if r == libc::MAP_FAILED {
1484 Err(match errno() as c_int {
1485 libc::EACCES => ErrFdNotAvail,
1486 libc::EBADF => ErrInvalidFd,
1487 libc::EINVAL => ErrUnaligned,
1488 libc::ENODEV => ErrNoMapSupport,
1489 libc::ENOMEM => ErrNoMem,
1490 code => ErrUnknown(code as int)
1499 MapFile(ptr::null())
1505 /// Granularity that the offset or address must be for `MapOffset` and
1506 /// `MapAddr` respectively.
1507 pub fn granularity() -> uint {
1513 impl Drop for MemoryMap {
1514 /// Unmap the mapping. Fails the task if `munmap` fails.
1515 fn drop(&mut self) {
1516 if self.len == 0 { /* workaround for dummy_stack */ return; }
1519 // `munmap` only fails due to logic errors
1520 libc::munmap(self.data as *mut c_void, self.len as libc::size_t);
1527 /// Create a new mapping with the given `options`, at least `min_len` bytes long.
1528 pub fn new(min_len: uint, options: &[MapOption]) -> Result<MemoryMap, MapError> {
1529 use libc::types::os::arch::extra::{LPVOID, DWORD, SIZE_T, HANDLE};
1531 let mut lpAddress: LPVOID = ptr::null_mut();
1532 let mut readable = false;
1533 let mut writable = false;
1534 let mut executable = false;
1535 let mut fd: c_int = -1;
1536 let mut offset: uint = 0;
1537 let len = round_up(min_len, page_size());
1539 for &o in options.iter() {
1541 MapReadable => { readable = true; },
1542 MapWritable => { writable = true; },
1543 MapExecutable => { executable = true; }
1544 MapAddr(addr_) => { lpAddress = addr_ as LPVOID; },
1545 MapFd(fd_) => { fd = fd_; },
1546 MapOffset(offset_) => { offset = offset_; },
1547 MapNonStandardFlags(..) => {}
1551 let flProtect = match (executable, readable, writable) {
1552 (false, false, false) if fd == -1 => libc::PAGE_NOACCESS,
1553 (false, true, false) => libc::PAGE_READONLY,
1554 (false, true, true) => libc::PAGE_READWRITE,
1555 (true, false, false) if fd == -1 => libc::PAGE_EXECUTE,
1556 (true, true, false) => libc::PAGE_EXECUTE_READ,
1557 (true, true, true) => libc::PAGE_EXECUTE_READWRITE,
1558 _ => return Err(ErrUnsupProt)
1563 return Err(ErrUnsupOffset);
1566 libc::VirtualAlloc(lpAddress,
1568 libc::MEM_COMMIT | libc::MEM_RESERVE,
1572 0 => Err(ErrVirtualAlloc(errno())),
1580 let dwDesiredAccess = match (executable, readable, writable) {
1581 (false, true, false) => libc::FILE_MAP_READ,
1582 (false, true, true) => libc::FILE_MAP_WRITE,
1583 (true, true, false) => libc::FILE_MAP_READ | libc::FILE_MAP_EXECUTE,
1584 (true, true, true) => libc::FILE_MAP_WRITE | libc::FILE_MAP_EXECUTE,
1585 _ => return Err(ErrUnsupProt) // Actually, because of the check above,
1586 // we should never get here.
1589 let hFile = libc::get_osfhandle(fd) as HANDLE;
1590 let mapping = libc::CreateFileMappingW(hFile,
1596 if mapping == ptr::null_mut() {
1597 return Err(ErrCreateFileMappingW(errno()));
1599 if errno() as c_int == libc::ERROR_ALREADY_EXISTS {
1600 return Err(ErrAlreadyExists);
1602 let r = libc::MapViewOfFile(mapping,
1604 ((len as u64) >> 32) as DWORD,
1605 (offset & 0xffff_ffff) as DWORD,
1608 0 => Err(ErrMapViewOfFile(errno())),
1612 kind: MapFile(mapping as *const u8)
1619 /// Granularity of MapAddr() and MapOffset() parameter values.
1620 /// This may be greater than the value returned by page_size().
1621 pub fn granularity() -> uint {
1624 let mut info = mem::zeroed();
1625 libc::GetSystemInfo(&mut info);
1627 return info.dwAllocationGranularity as uint;
1633 impl Drop for MemoryMap {
1634 /// Unmap the mapping. Fails the task if any of `VirtualFree`,
1635 /// `UnmapViewOfFile`, or `CloseHandle` fail.
1636 fn drop(&mut self) {
1637 use libc::types::os::arch::extra::{LPCVOID, HANDLE};
1638 use libc::consts::os::extra::FALSE;
1639 if self.len == 0 { return }
1644 if libc::VirtualFree(self.data as *mut c_void, 0,
1645 libc::MEM_RELEASE) == 0 {
1646 println!("VirtualFree failed: {}", errno());
1649 MapFile(mapping) => {
1650 if libc::UnmapViewOfFile(self.data as LPCVOID) == FALSE {
1651 println!("UnmapViewOfFile failed: {}", errno());
1653 if libc::CloseHandle(mapping as HANDLE) == FALSE {
1654 println!("CloseHandle failed: {}", errno());
1663 /// Returns the pointer to the memory created or modified by this map.
1664 pub fn data(&self) -> *mut u8 { self.data }
1665 /// Returns the number of bytes this map applies to.
1666 pub fn len(&self) -> uint { self.len }
1667 /// Returns the type of mapping this represents.
1668 pub fn kind(&self) -> MemoryMapKind { self.kind }
1671 #[cfg(target_os = "linux")]
1673 pub use os::arch_consts::ARCH;
1675 pub static FAMILY: &'static str = "unix";
1677 /// A string describing the specific operating system in use: in this
1679 pub static SYSNAME: &'static str = "linux";
1681 /// Specifies the filename prefix used for shared libraries on this
1682 /// platform: in this case, `lib`.
1683 pub static DLL_PREFIX: &'static str = "lib";
1685 /// Specifies the filename suffix used for shared libraries on this
1686 /// platform: in this case, `.so`.
1687 pub static DLL_SUFFIX: &'static str = ".so";
1689 /// Specifies the file extension used for shared libraries on this
1690 /// platform that goes after the dot: in this case, `so`.
1691 pub static DLL_EXTENSION: &'static str = "so";
1693 /// Specifies the filename suffix used for executable binaries on this
1694 /// platform: in this case, the empty string.
1695 pub static EXE_SUFFIX: &'static str = "";
1697 /// Specifies the file extension, if any, used for executable binaries
1698 /// on this platform: in this case, the empty string.
1699 pub static EXE_EXTENSION: &'static str = "";
1702 #[cfg(target_os = "macos")]
1704 pub use os::arch_consts::ARCH;
1706 pub static FAMILY: &'static str = "unix";
1708 /// A string describing the specific operating system in use: in this
1710 pub static SYSNAME: &'static str = "macos";
1712 /// Specifies the filename prefix used for shared libraries on this
1713 /// platform: in this case, `lib`.
1714 pub static DLL_PREFIX: &'static str = "lib";
1716 /// Specifies the filename suffix used for shared libraries on this
1717 /// platform: in this case, `.dylib`.
1718 pub static DLL_SUFFIX: &'static str = ".dylib";
1720 /// Specifies the file extension used for shared libraries on this
1721 /// platform that goes after the dot: in this case, `dylib`.
1722 pub static DLL_EXTENSION: &'static str = "dylib";
1724 /// Specifies the filename suffix used for executable binaries on this
1725 /// platform: in this case, the empty string.
1726 pub static EXE_SUFFIX: &'static str = "";
1728 /// Specifies the file extension, if any, used for executable binaries
1729 /// on this platform: in this case, the empty string.
1730 pub static EXE_EXTENSION: &'static str = "";
1733 #[cfg(target_os = "ios")]
1735 pub use os::arch_consts::ARCH;
1737 pub static FAMILY: &'static str = "unix";
1739 /// A string describing the specific operating system in use: in this
1741 pub static SYSNAME: &'static str = "ios";
1743 /// Specifies the filename suffix used for executable binaries on this
1744 /// platform: in this case, the empty string.
1745 pub static EXE_SUFFIX: &'static str = "";
1747 /// Specifies the file extension, if any, used for executable binaries
1748 /// on this platform: in this case, the empty string.
1749 pub static EXE_EXTENSION: &'static str = "";
1752 #[cfg(target_os = "freebsd")]
1754 pub use os::arch_consts::ARCH;
1756 pub static FAMILY: &'static str = "unix";
1758 /// A string describing the specific operating system in use: in this
1759 /// case, `freebsd`.
1760 pub static SYSNAME: &'static str = "freebsd";
1762 /// Specifies the filename prefix used for shared libraries on this
1763 /// platform: in this case, `lib`.
1764 pub static DLL_PREFIX: &'static str = "lib";
1766 /// Specifies the filename suffix used for shared libraries on this
1767 /// platform: in this case, `.so`.
1768 pub static DLL_SUFFIX: &'static str = ".so";
1770 /// Specifies the file extension used for shared libraries on this
1771 /// platform that goes after the dot: in this case, `so`.
1772 pub static DLL_EXTENSION: &'static str = "so";
1774 /// Specifies the filename suffix used for executable binaries on this
1775 /// platform: in this case, the empty string.
1776 pub static EXE_SUFFIX: &'static str = "";
1778 /// Specifies the file extension, if any, used for executable binaries
1779 /// on this platform: in this case, the empty string.
1780 pub static EXE_EXTENSION: &'static str = "";
1783 #[cfg(target_os = "dragonfly")]
1785 pub use os::arch_consts::ARCH;
1787 pub static FAMILY: &'static str = "unix";
1789 /// A string describing the specific operating system in use: in this
1790 /// case, `dragonfly`.
1791 pub static SYSNAME: &'static str = "dragonfly";
1793 /// Specifies the filename prefix used for shared libraries on this
1794 /// platform: in this case, `lib`.
1795 pub static DLL_PREFIX: &'static str = "lib";
1797 /// Specifies the filename suffix used for shared libraries on this
1798 /// platform: in this case, `.so`.
1799 pub static DLL_SUFFIX: &'static str = ".so";
1801 /// Specifies the file extension used for shared libraries on this
1802 /// platform that goes after the dot: in this case, `so`.
1803 pub static DLL_EXTENSION: &'static str = "so";
1805 /// Specifies the filename suffix used for executable binaries on this
1806 /// platform: in this case, the empty string.
1807 pub static EXE_SUFFIX: &'static str = "";
1809 /// Specifies the file extension, if any, used for executable binaries
1810 /// on this platform: in this case, the empty string.
1811 pub static EXE_EXTENSION: &'static str = "";
1814 #[cfg(target_os = "android")]
1816 pub use os::arch_consts::ARCH;
1818 pub static FAMILY: &'static str = "unix";
1820 /// A string describing the specific operating system in use: in this
1821 /// case, `android`.
1822 pub static SYSNAME: &'static str = "android";
1824 /// Specifies the filename prefix used for shared libraries on this
1825 /// platform: in this case, `lib`.
1826 pub static DLL_PREFIX: &'static str = "lib";
1828 /// Specifies the filename suffix used for shared libraries on this
1829 /// platform: in this case, `.so`.
1830 pub static DLL_SUFFIX: &'static str = ".so";
1832 /// Specifies the file extension used for shared libraries on this
1833 /// platform that goes after the dot: in this case, `so`.
1834 pub static DLL_EXTENSION: &'static str = "so";
1836 /// Specifies the filename suffix used for executable binaries on this
1837 /// platform: in this case, the empty string.
1838 pub static EXE_SUFFIX: &'static str = "";
1840 /// Specifies the file extension, if any, used for executable binaries
1841 /// on this platform: in this case, the empty string.
1842 pub static EXE_EXTENSION: &'static str = "";
1845 #[cfg(target_os = "windows")]
1847 pub use os::arch_consts::ARCH;
1849 pub static FAMILY: &'static str = "windows";
1851 /// A string describing the specific operating system in use: in this
1852 /// case, `windows`.
1853 pub static SYSNAME: &'static str = "windows";
1855 /// Specifies the filename prefix used for shared libraries on this
1856 /// platform: in this case, the empty string.
1857 pub static DLL_PREFIX: &'static str = "";
1859 /// Specifies the filename suffix used for shared libraries on this
1860 /// platform: in this case, `.dll`.
1861 pub static DLL_SUFFIX: &'static str = ".dll";
1863 /// Specifies the file extension used for shared libraries on this
1864 /// platform that goes after the dot: in this case, `dll`.
1865 pub static DLL_EXTENSION: &'static str = "dll";
1867 /// Specifies the filename suffix used for executable binaries on this
1868 /// platform: in this case, `.exe`.
1869 pub static EXE_SUFFIX: &'static str = ".exe";
1871 /// Specifies the file extension, if any, used for executable binaries
1872 /// on this platform: in this case, `exe`.
1873 pub static EXE_EXTENSION: &'static str = "exe";
1876 #[cfg(target_arch = "x86")]
1878 pub static ARCH: &'static str = "x86";
1881 #[cfg(target_arch = "x86_64")]
1883 pub static ARCH: &'static str = "x86_64";
1886 #[cfg(target_arch = "arm")]
1888 pub static ARCH: &'static str = "arm";
1891 #[cfg(target_arch = "mips")]
1893 pub static ARCH: &'static str = "mips";
1896 #[cfg(target_arch = "mipsel")]
1898 pub static ARCH: &'static str = "mipsel";
1906 use os::{env, getcwd, getenv, make_absolute};
1907 use os::{split_paths, join_paths, setenv, unsetenv};
1913 pub fn last_os_error() {
1914 debug!("{}", os::last_os_error());
1917 fn make_rand_name() -> String {
1918 let mut rng = rand::task_rng();
1919 let n = format!("TEST{}", rng.gen_ascii_chars().take(10u)
1920 .collect::<String>());
1921 assert!(getenv(n.as_slice()).is_none());
1926 fn test_num_cpus() {
1927 assert!(os::num_cpus() > 0);
1932 let n = make_rand_name();
1933 setenv(n.as_slice(), "VALUE");
1934 assert_eq!(getenv(n.as_slice()), option::Some("VALUE".to_string()));
1938 fn test_unsetenv() {
1939 let n = make_rand_name();
1940 setenv(n.as_slice(), "VALUE");
1941 unsetenv(n.as_slice());
1942 assert_eq!(getenv(n.as_slice()), option::None);
1947 fn test_setenv_overwrite() {
1948 let n = make_rand_name();
1949 setenv(n.as_slice(), "1");
1950 setenv(n.as_slice(), "2");
1951 assert_eq!(getenv(n.as_slice()), option::Some("2".to_string()));
1952 setenv(n.as_slice(), "");
1953 assert_eq!(getenv(n.as_slice()), option::Some("".to_string()));
1956 // Windows GetEnvironmentVariable requires some extra work to make sure
1957 // the buffer the variable is copied into is the right size
1960 fn test_getenv_big() {
1961 let mut s = "".to_string();
1964 s.push_str("aaaaaaaaaa");
1967 let n = make_rand_name();
1968 setenv(n.as_slice(), s.as_slice());
1969 debug!("{}", s.clone());
1970 assert_eq!(getenv(n.as_slice()), option::Some(s));
1974 fn test_self_exe_name() {
1975 let path = os::self_exe_name();
1976 assert!(path.is_some());
1977 let path = path.unwrap();
1978 debug!("{:?}", path.clone());
1980 // Hard to test this function
1981 assert!(path.is_absolute());
1985 fn test_self_exe_path() {
1986 let path = os::self_exe_path();
1987 assert!(path.is_some());
1988 let path = path.unwrap();
1989 debug!("{:?}", path.clone());
1991 // Hard to test this function
1992 assert!(path.is_absolute());
1997 fn test_env_getenv() {
1999 assert!(e.len() > 0u);
2001 let (n, v) = (*p).clone();
2002 debug!("{:?}", n.clone());
2003 let v2 = getenv(n.as_slice());
2004 // MingW seems to set some funky environment variables like
2005 // "=C:=C:\MinGW\msys\1.0\bin" and "!::=::\" that are returned
2006 // from env() but not visible from getenv().
2007 assert!(v2.is_none() || v2 == option::Some(v));
2012 fn test_env_set_get_huge() {
2013 let n = make_rand_name();
2014 let s = "x".repeat(10000).to_string();
2015 setenv(n.as_slice(), s.as_slice());
2016 assert_eq!(getenv(n.as_slice()), Some(s));
2017 unsetenv(n.as_slice());
2018 assert_eq!(getenv(n.as_slice()), None);
2022 fn test_env_setenv() {
2023 let n = make_rand_name();
2026 setenv(n.as_slice(), "VALUE");
2027 assert!(!e.contains(&(n.clone(), "VALUE".to_string())));
2030 assert!(e.contains(&(n, "VALUE".to_string())));
2035 assert!((!Path::new("test-path").is_absolute()));
2038 debug!("Current working directory: {}", cwd.display());
2040 debug!("{:?}", make_absolute(&Path::new("test-path")));
2041 debug!("{:?}", make_absolute(&Path::new("/usr/bin")));
2047 let oldhome = getenv("HOME");
2049 setenv("HOME", "/home/MountainView");
2050 assert!(os::homedir() == Some(Path::new("/home/MountainView")));
2053 assert!(os::homedir().is_none());
2055 for s in oldhome.iter() {
2056 setenv("HOME", s.as_slice());
2064 let oldhome = getenv("HOME");
2065 let olduserprofile = getenv("USERPROFILE");
2068 setenv("USERPROFILE", "");
2070 assert!(os::homedir().is_none());
2072 setenv("HOME", "/home/MountainView");
2073 assert!(os::homedir() == Some(Path::new("/home/MountainView")));
2077 setenv("USERPROFILE", "/home/MountainView");
2078 assert!(os::homedir() == Some(Path::new("/home/MountainView")));
2080 setenv("HOME", "/home/MountainView");
2081 setenv("USERPROFILE", "/home/PaloAlto");
2082 assert!(os::homedir() == Some(Path::new("/home/MountainView")));
2084 for s in oldhome.iter() {
2085 setenv("HOME", s.as_slice());
2087 for s in olduserprofile.iter() {
2088 setenv("USERPROFILE", s.as_slice());
2093 fn memory_map_rw() {
2094 use result::{Ok, Err};
2096 let chunk = match os::MemoryMap::new(16, [
2101 Err(msg) => fail!("{}", msg)
2103 assert!(chunk.len >= 16);
2107 assert!(*chunk.data == 0xBE);
2112 fn memory_map_file() {
2113 use result::{Ok, Err};
2119 fn lseek_(fd: c_int, size: uint) {
2121 assert!(lseek(fd, size as off_t, SEEK_SET) == size as off_t);
2125 fn lseek_(fd: c_int, size: uint) {
2127 assert!(lseek(fd, size as c_long, SEEK_SET) == size as c_long);
2131 let mut path = tmpdir();
2132 path.push("mmap_file.tmp");
2133 let size = MemoryMap::granularity() * 2;
2136 let fd = path.with_c_str(|path| {
2137 open(path, O_CREAT | O_RDWR | O_TRUNC, S_IRUSR | S_IWUSR)
2140 "x".with_c_str(|x| assert!(write(fd, x as *const c_void, 1) == 1));
2143 let chunk = match MemoryMap::new(size / 2, [
2150 Err(msg) => fail!("{}", msg)
2152 assert!(chunk.len > 0);
2156 assert!(*chunk.data == 0xbe);
2161 fs::unlink(&path).unwrap();
2166 fn split_paths_windows() {
2167 fn check_parse(unparsed: &str, parsed: &[&str]) -> bool {
2168 split_paths(unparsed) ==
2169 parsed.iter().map(|s| Path::new(*s)).collect()
2172 assert!(check_parse("", [""]));
2173 assert!(check_parse(r#""""#, [""]));
2174 assert!(check_parse(";;", ["", "", ""]));
2175 assert!(check_parse(r"c:\", [r"c:\"]));
2176 assert!(check_parse(r"c:\;", [r"c:\", ""]));
2177 assert!(check_parse(r"c:\;c:\Program Files\",
2178 [r"c:\", r"c:\Program Files\"]));
2179 assert!(check_parse(r#"c:\;c:\"foo"\"#, [r"c:\", r"c:\foo\"]));
2180 assert!(check_parse(r#"c:\;c:\"foo;bar"\;c:\baz"#,
2181 [r"c:\", r"c:\foo;bar\", r"c:\baz"]));
2186 fn split_paths_unix() {
2187 fn check_parse(unparsed: &str, parsed: &[&str]) -> bool {
2188 split_paths(unparsed) ==
2189 parsed.iter().map(|s| Path::new(*s)).collect()
2192 assert!(check_parse("", [""]));
2193 assert!(check_parse("::", ["", "", ""]));
2194 assert!(check_parse("/", ["/"]));
2195 assert!(check_parse("/:", ["/", ""]));
2196 assert!(check_parse("/:/usr/local", ["/", "/usr/local"]));
2201 fn join_paths_unix() {
2202 fn test_eq(input: &[&str], output: &str) -> bool {
2203 join_paths(input).unwrap().as_slice() == output.as_bytes()
2206 assert!(test_eq([], ""));
2207 assert!(test_eq(["/bin", "/usr/bin", "/usr/local/bin"],
2208 "/bin:/usr/bin:/usr/local/bin"));
2209 assert!(test_eq(["", "/bin", "", "", "/usr/bin", ""],
2210 ":/bin:::/usr/bin:"));
2211 assert!(join_paths(["/te:st"]).is_err());
2216 fn join_paths_windows() {
2217 fn test_eq(input: &[&str], output: &str) -> bool {
2218 join_paths(input).unwrap().as_slice() == output.as_bytes()
2221 assert!(test_eq([], ""));
2222 assert!(test_eq([r"c:\windows", r"c:\"],
2223 r"c:\windows;c:\"));
2224 assert!(test_eq(["", r"c:\windows", "", "", r"c:\", ""],
2225 r";c:\windows;;;c:\;"));
2226 assert!(test_eq([r"c:\te;st", r"c:\"],
2227 r#""c:\te;st";c:\"#));
2228 assert!(join_paths([r#"c:\te"st"#]).is_err());
2231 // More recursive_mkdir tests are in extra::tempfile