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(target_os = "freebsd")]
657 #[cfg(target_os = "dragonfly")]
658 fn load_self() -> Option<Vec<u8>> {
660 use libc::funcs::bsd44::*;
661 use libc::consts::os::extra::*;
662 let mut mib = vec![CTL_KERN as c_int,
664 KERN_PROC_PATHNAME as c_int,
666 let mut sz: libc::size_t = 0;
667 let err = sysctl(mib.as_mut_ptr(), mib.len() as ::libc::c_uint,
668 ptr::null_mut(), &mut sz, ptr::null_mut(),
670 if err != 0 { return None; }
671 if sz == 0 { return None; }
672 let mut v: Vec<u8> = Vec::with_capacity(sz as uint);
673 let err = sysctl(mib.as_mut_ptr(), mib.len() as ::libc::c_uint,
674 v.as_mut_ptr() as *mut c_void, &mut sz,
675 ptr::null_mut(), 0u as libc::size_t);
676 if err != 0 { return None; }
677 if sz == 0 { return None; }
678 v.set_len(sz as uint - 1); // chop off trailing NUL
683 #[cfg(target_os = "linux")]
684 #[cfg(target_os = "android")]
685 fn load_self() -> Option<Vec<u8>> {
688 match io::fs::readlink(&Path::new("/proc/self/exe")) {
689 Ok(path) => Some(path.into_vec()),
694 #[cfg(target_os = "macos")]
695 #[cfg(target_os = "ios")]
696 fn load_self() -> Option<Vec<u8>> {
698 use libc::funcs::extra::_NSGetExecutablePath;
700 _NSGetExecutablePath(ptr::null_mut(), &mut sz);
701 if sz == 0 { return None; }
702 let mut v: Vec<u8> = Vec::with_capacity(sz as uint);
703 let err = _NSGetExecutablePath(v.as_mut_ptr() as *mut i8, &mut sz);
704 if err != 0 { return None; }
705 v.set_len(sz as uint - 1); // chop off trailing NUL
711 fn load_self() -> Option<Vec<u8>> {
713 use os::windows::fill_utf16_buf_and_decode;
714 fill_utf16_buf_and_decode(|buf, sz| {
715 libc::GetModuleFileNameW(0u as libc::DWORD, buf, sz)
716 }).map(|s| s.into_string().into_bytes())
720 load_self().and_then(Path::new_opt)
723 /// Optionally returns the filesystem path to the current executable which is
726 /// Like self_exe_name() but without the binary's name.
733 /// match os::self_exe_path() {
734 /// Some(exe_path) => println!("Executable's Path is: {}", exe_path.display()),
735 /// None => println!("Impossible to fetch the path of this executable.")
738 pub fn self_exe_path() -> Option<Path> {
739 self_exe_name().map(|mut p| { p.pop(); p })
742 /// Optionally returns the path to the current user's home directory if known.
746 /// Returns the value of the 'HOME' environment variable if it is set
747 /// and not equal to the empty string.
751 /// Returns the value of the 'HOME' environment variable if it is
752 /// set and not equal to the empty string. Otherwise, returns the value of the
753 /// 'USERPROFILE' environment variable if it is set and not equal to the empty
761 /// match os::homedir() {
762 /// Some(ref p) => println!("{}", p.display()),
763 /// None => println!("Impossible to get your home dir!")
766 pub fn homedir() -> Option<Path> {
769 fn _homedir() -> Option<Path> {
775 fn _homedir() -> Option<Path> {
776 aux_homedir("HOME").or(aux_homedir("USERPROFILE"))
780 fn aux_homedir(home_name: &str) -> Option<Path> {
781 match getenv_as_bytes(home_name) {
783 if p.is_empty() { None } else { Path::new_opt(p) }
792 * Returns the path to a temporary directory.
794 * On Unix, returns the value of the 'TMPDIR' environment variable if it is
795 * set, otherwise for non-Android it returns '/tmp'. If Android, since there
796 * is no global temporary folder (it is usually allocated per-app), we return
799 * On Windows, returns the value of, in order, the 'TMP', 'TEMP',
800 * 'USERPROFILE' environment variable if any are set and not the empty
801 * string. Otherwise, tmpdir returns the path to the Windows directory.
803 pub fn tmpdir() -> Path {
806 fn getenv_nonempty(v: &str) -> Option<Path> {
819 fn lookup() -> Path {
820 let default = if cfg!(target_os = "android") {
821 Path::new("/data/local/tmp")
826 getenv_nonempty("TMPDIR").unwrap_or(default)
830 fn lookup() -> Path {
831 getenv_nonempty("TMP").or(
832 getenv_nonempty("TEMP").or(
833 getenv_nonempty("USERPROFILE").or(
834 getenv_nonempty("WINDIR")))).unwrap_or(Path::new("C:\\Windows"))
839 /// Convert a relative path to an absolute path
841 /// If the given path is relative, return it prepended with the current working
842 /// directory. If the given path is already an absolute path, return it
848 /// use std::path::Path;
850 /// // Assume we're in a path like /home/someuser
851 /// let rel_path = Path::new("..");
852 /// let abs_path = os::make_absolute(&rel_path);
853 /// println!("The absolute path is {}", abs_path.display());
854 /// // Prints "The absolute path is /home"
856 // NB: this is here rather than in path because it is a form of environment
857 // querying; what it does depends on the process working directory, not just
859 pub fn make_absolute(p: &Path) -> Path {
863 let mut ret = getcwd();
869 /// Changes the current working directory to the specified path, returning
870 /// whether the change was completed successfully or not.
875 /// use std::path::Path;
877 /// let root = Path::new("/");
878 /// assert!(os::change_dir(&root));
879 /// println!("Successfully changed working directory to {}!", root.display());
881 pub fn change_dir(p: &Path) -> bool {
885 fn chdir(p: &Path) -> bool {
886 let p = match p.as_str() {
888 let mut p = s.utf16_units().collect::<Vec<u16>>();
892 None => return false,
895 libc::SetCurrentDirectoryW(p.as_ptr()) != (0 as libc::BOOL)
900 fn chdir(p: &Path) -> bool {
903 libc::chdir(buf) == (0 as c_int)
910 /// Returns the platform-specific value of errno
911 pub fn errno() -> int {
912 #[cfg(target_os = "macos")]
913 #[cfg(target_os = "ios")]
914 #[cfg(target_os = "freebsd")]
915 fn errno_location() -> *const c_int {
917 fn __error() -> *const c_int;
924 #[cfg(target_os = "dragonfly")]
925 fn errno_location() -> *const c_int {
927 fn __dfly_error() -> *const c_int;
934 #[cfg(target_os = "linux")]
935 #[cfg(target_os = "android")]
936 fn errno_location() -> *const c_int {
938 fn __errno_location() -> *const c_int;
946 (*errno_location()) as int
951 /// Returns the platform-specific value of errno
952 pub fn errno() -> uint {
953 use libc::types::os::arch::extra::DWORD;
955 #[link_name = "kernel32"]
957 fn GetLastError() -> DWORD;
961 GetLastError() as uint
965 /// Return the string corresponding to an `errno()` value of `errnum`.
970 /// // Same as println!("{}", last_os_error());
971 /// println!("{}", os::error_string(os::errno() as uint));
973 pub fn error_string(errnum: uint) -> String {
974 return strerror(errnum);
977 fn strerror(errnum: uint) -> String {
978 #[cfg(target_os = "macos")]
979 #[cfg(target_os = "ios")]
980 #[cfg(target_os = "android")]
981 #[cfg(target_os = "freebsd")]
982 #[cfg(target_os = "dragonfly")]
983 fn strerror_r(errnum: c_int, buf: *mut c_char, buflen: libc::size_t)
986 fn strerror_r(errnum: c_int, buf: *mut c_char,
987 buflen: libc::size_t) -> c_int;
990 strerror_r(errnum, buf, buflen)
994 // GNU libc provides a non-compliant version of strerror_r by default
995 // and requires macros to instead use the POSIX compliant variant.
996 // So we just use __xpg_strerror_r which is always POSIX compliant
997 #[cfg(target_os = "linux")]
998 fn strerror_r(errnum: c_int, buf: *mut c_char,
999 buflen: libc::size_t) -> c_int {
1001 fn __xpg_strerror_r(errnum: c_int,
1003 buflen: libc::size_t)
1007 __xpg_strerror_r(errnum, buf, buflen)
1011 let mut buf = [0 as c_char, ..TMPBUF_SZ];
1013 let p = buf.as_mut_ptr();
1015 if strerror_r(errnum as c_int, p, buf.len() as libc::size_t) < 0 {
1016 fail!("strerror_r failure");
1019 ::string::raw::from_buf(p as *const u8)
1024 fn strerror(errnum: uint) -> String {
1025 use libc::types::os::arch::extra::DWORD;
1026 use libc::types::os::arch::extra::LPWSTR;
1027 use libc::types::os::arch::extra::LPVOID;
1028 use libc::types::os::arch::extra::WCHAR;
1030 #[link_name = "kernel32"]
1032 fn FormatMessageW(flags: DWORD,
1038 args: *const c_void)
1042 static FORMAT_MESSAGE_FROM_SYSTEM: DWORD = 0x00001000;
1043 static FORMAT_MESSAGE_IGNORE_INSERTS: DWORD = 0x00000200;
1045 // This value is calculated from the macro
1046 // MAKELANGID(LANG_SYSTEM_DEFAULT, SUBLANG_SYS_DEFAULT)
1047 let langId = 0x0800 as DWORD;
1049 let mut buf = [0 as WCHAR, ..TMPBUF_SZ];
1052 let res = FormatMessageW(FORMAT_MESSAGE_FROM_SYSTEM |
1053 FORMAT_MESSAGE_IGNORE_INSERTS,
1061 // Sometimes FormatMessageW can fail e.g. system doesn't like langId,
1062 let fm_err = errno();
1063 return format!("OS Error {} (FormatMessageW() returned error {})", errnum, fm_err);
1066 let msg = String::from_utf16(::str::truncate_utf16_at_nul(buf));
1068 Some(msg) => format!("OS Error {}: {}", errnum, msg),
1069 None => format!("OS Error {} (FormatMessageW() returned invalid UTF-16)", errnum),
1075 /// Get a string representing the platform-dependent last error
1076 pub fn last_os_error() -> String {
1077 error_string(errno() as uint)
1080 static mut EXIT_STATUS: AtomicInt = INIT_ATOMIC_INT;
1083 * Sets the process exit code
1085 * Sets the exit code returned by the process if all supervised tasks
1086 * terminate successfully (without failing). If the current root task fails
1087 * and is supervised by the scheduler then any user-specified exit status is
1088 * ignored and the process exits with the default failure status.
1090 * Note that this is not synchronized against modifications of other threads.
1092 pub fn set_exit_status(code: int) {
1093 unsafe { EXIT_STATUS.store(code, SeqCst) }
1096 /// Fetches the process's current exit code. This defaults to 0 and can change
1097 /// by calling `set_exit_status`.
1098 pub fn get_exit_status() -> int {
1099 unsafe { EXIT_STATUS.load(SeqCst) }
1102 #[cfg(target_os = "macos")]
1103 unsafe fn load_argc_and_argv(argc: int,
1104 argv: *const *const c_char) -> Vec<Vec<u8>> {
1107 Vec::from_fn(argc as uint, |i| {
1108 CString::new(*argv.offset(i as int), false).as_bytes_no_nul().to_vec()
1113 * Returns the command line arguments
1115 * Returns a list of the command line arguments.
1117 #[cfg(target_os = "macos")]
1118 fn real_args_as_bytes() -> Vec<Vec<u8>> {
1120 let (argc, argv) = (*_NSGetArgc() as int,
1121 *_NSGetArgv() as *const *const c_char);
1122 load_argc_and_argv(argc, argv)
1126 // As _NSGetArgc and _NSGetArgv aren't mentioned in iOS docs
1127 // and use underscores in their names - they're most probably
1128 // are considered private and therefore should be avoided
1129 // Here is another way to get arguments using Objective C
1132 // In general it looks like:
1134 // let args = [[NSProcessInfo processInfo] arguments]
1135 // for i in range(0, [args count])
1136 // res.push([args objectAtIndex:i])
1138 #[cfg(target_os = "ios")]
1139 fn real_args_as_bytes() -> Vec<Vec<u8>> {
1144 #[link(name = "objc")]
1146 fn sel_registerName(name: *const libc::c_uchar) -> Sel;
1147 fn objc_msgSend(obj: NsId, sel: Sel, ...) -> NsId;
1148 fn objc_getClass(class_name: *const libc::c_uchar) -> NsId;
1151 #[link(name = "Foundation", kind = "framework")]
1154 type Sel = *const libc::c_void;
1155 type NsId = *const libc::c_void;
1157 let mut res = Vec::new();
1160 let processInfoSel = sel_registerName("processInfo\0".as_ptr());
1161 let argumentsSel = sel_registerName("arguments\0".as_ptr());
1162 let utf8Sel = sel_registerName("UTF8String\0".as_ptr());
1163 let countSel = sel_registerName("count\0".as_ptr());
1164 let objectAtSel = sel_registerName("objectAtIndex:\0".as_ptr());
1166 let klass = objc_getClass("NSProcessInfo\0".as_ptr());
1167 let info = objc_msgSend(klass, processInfoSel);
1168 let args = objc_msgSend(info, argumentsSel);
1170 let cnt: int = mem::transmute(objc_msgSend(args, countSel));
1171 for i in range(0, cnt) {
1172 let tmp = objc_msgSend(args, objectAtSel, i);
1173 let utf_c_str: *const libc::c_char =
1174 mem::transmute(objc_msgSend(tmp, utf8Sel));
1175 let s = CString::new(utf_c_str, false);
1176 res.push(s.as_bytes_no_nul().to_vec())
1183 #[cfg(target_os = "linux")]
1184 #[cfg(target_os = "android")]
1185 #[cfg(target_os = "freebsd")]
1186 #[cfg(target_os = "dragonfly")]
1187 fn real_args_as_bytes() -> Vec<Vec<u8>> {
1190 match rt::args::clone() {
1192 None => fail!("process arguments not initialized")
1196 #[cfg(not(windows))]
1197 fn real_args() -> Vec<String> {
1198 real_args_as_bytes().into_iter()
1200 String::from_utf8_lossy(v.as_slice()).into_string()
1205 fn real_args() -> Vec<String> {
1208 let mut nArgs: c_int = 0;
1209 let lpArgCount: *mut c_int = &mut nArgs;
1210 let lpCmdLine = unsafe { GetCommandLineW() };
1211 let szArgList = unsafe { CommandLineToArgvW(lpCmdLine, lpArgCount) };
1213 let args = Vec::from_fn(nArgs as uint, |i| unsafe {
1214 // Determine the length of this argument.
1215 let ptr = *szArgList.offset(i as int);
1217 while *ptr.offset(len as int) != 0 { len += 1; }
1219 // Push it onto the list.
1220 let opt_s = slice::raw::buf_as_slice(ptr as *const _, len, |buf| {
1221 String::from_utf16(::str::truncate_utf16_at_nul(buf))
1223 opt_s.expect("CommandLineToArgvW returned invalid UTF-16")
1227 LocalFree(szArgList as *mut c_void);
1234 fn real_args_as_bytes() -> Vec<Vec<u8>> {
1235 real_args().into_iter().map(|s| s.into_bytes()).collect()
1238 type LPCWSTR = *const u16;
1241 #[link_name="kernel32"]
1243 fn GetCommandLineW() -> LPCWSTR;
1244 fn LocalFree(ptr: *mut c_void);
1248 #[link_name="shell32"]
1250 fn CommandLineToArgvW(lpCmdLine: LPCWSTR,
1251 pNumArgs: *mut c_int) -> *mut *mut u16;
1254 /// Returns the arguments which this program was started with (normally passed
1255 /// via the command line).
1257 /// The arguments are interpreted as utf-8, with invalid bytes replaced with \uFFFD.
1258 /// See `String::from_utf8_lossy` for details.
1264 /// // Prints each argument on a separate line
1265 /// for argument in os::args().iter() {
1266 /// println!("{}", argument);
1269 pub fn args() -> Vec<String> {
1273 /// Returns the arguments which this program was started with (normally passed
1274 /// via the command line) as byte vectors.
1275 pub fn args_as_bytes() -> Vec<Vec<u8>> {
1276 real_args_as_bytes()
1279 #[cfg(target_os = "macos")]
1281 // These functions are in crt_externs.h.
1282 pub fn _NSGetArgc() -> *mut c_int;
1283 pub fn _NSGetArgv() -> *mut *mut *mut c_char;
1286 // Round up `from` to be divisible by `to`
1287 fn round_up(from: uint, to: uint) -> uint {
1288 let r = if from % to == 0 {
1291 from + to - (from % to)
1300 /// Returns the page size of the current architecture in bytes.
1302 pub fn page_size() -> uint {
1304 libc::sysconf(libc::_SC_PAGESIZE) as uint
1308 /// Returns the page size of the current architecture in bytes.
1310 pub fn page_size() -> uint {
1313 let mut info = mem::zeroed();
1314 libc::GetSystemInfo(&mut info);
1316 return info.dwPageSize as uint;
1320 /// A memory mapped file or chunk of memory. This is a very system-specific
1321 /// interface to the OS's memory mapping facilities (`mmap` on POSIX,
1322 /// `VirtualAlloc`/`CreateFileMapping` on Windows). It makes no attempt at
1323 /// abstracting platform differences, besides in error values returned. Consider
1324 /// yourself warned.
1326 /// The memory map is released (unmapped) when the destructor is run, so don't
1327 /// let it leave scope by accident if you want it to stick around.
1328 pub struct MemoryMap {
1331 kind: MemoryMapKind,
1334 /// Type of memory map
1335 pub enum MemoryMapKind {
1336 /// Virtual memory map. Usually used to change the permissions of a given
1337 /// chunk of memory. Corresponds to `VirtualAlloc` on Windows.
1339 /// Virtual memory map. Usually used to change the permissions of a given
1340 /// chunk of memory, or for allocation. Corresponds to `VirtualAlloc` on
1345 /// Options the memory map is created with
1346 pub enum MapOption {
1347 /// The memory should be readable
1349 /// The memory should be writable
1351 /// The memory should be executable
1353 /// Create a map for a specific address range. Corresponds to `MAP_FIXED` on
1356 /// Create a memory mapping for a file with a given fd.
1358 /// When using `MapFd`, the start of the map is `uint` bytes from the start
1361 /// On POSIX, this can be used to specify the default flags passed to
1362 /// `mmap`. By default it uses `MAP_PRIVATE` and, if not using `MapFd`,
1363 /// `MAP_ANON`. This will override both of those. This is platform-specific
1364 /// (the exact values used) and ignored on Windows.
1365 MapNonStandardFlags(c_int),
1368 /// Possible errors when creating a map.
1370 /// ## The following are POSIX-specific
1372 /// fd was not open for reading or, if using `MapWritable`, was not open for
1375 /// fd was not valid
1377 /// Either the address given by `MapAddr` or offset given by `MapOffset` was
1378 /// not a multiple of `MemoryMap::granularity` (unaligned to page size).
1380 /// With `MapFd`, the fd does not support mapping.
1382 /// If using `MapAddr`, the address + `min_len` was outside of the process's
1383 /// address space. If using `MapFd`, the target of the fd didn't have enough
1384 /// resources to fulfill the request.
1386 /// A zero-length map was requested. This is invalid according to
1387 /// [POSIX](http://pubs.opengroup.org/onlinepubs/9699919799/functions/mmap.html).
1388 /// Not all platforms obey this, but this wrapper does.
1390 /// Unrecognized error. The inner value is the unrecognized errno.
1392 /// ## The following are Windows-specific
1394 /// Unsupported combination of protection flags
1395 /// (`MapReadable`/`MapWritable`/`MapExecutable`).
1397 /// When using `MapFd`, `MapOffset` was given (Windows does not support this
1400 /// When using `MapFd`, there was already a mapping to the file.
1402 /// Unrecognized error from `VirtualAlloc`. The inner value is the return
1403 /// value of GetLastError.
1404 ErrVirtualAlloc(uint),
1405 /// Unrecognized error from `CreateFileMapping`. The inner value is the
1406 /// return value of `GetLastError`.
1407 ErrCreateFileMappingW(uint),
1408 /// Unrecognized error from `MapViewOfFile`. The inner value is the return
1409 /// value of `GetLastError`.
1410 ErrMapViewOfFile(uint)
1413 impl fmt::Show for MapError {
1414 fn fmt(&self, out: &mut fmt::Formatter) -> fmt::Result {
1415 let str = match *self {
1416 ErrFdNotAvail => "fd not available for reading or writing",
1417 ErrInvalidFd => "Invalid fd",
1419 "Unaligned address, invalid flags, negative length or \
1422 ErrNoMapSupport=> "File doesn't support mapping",
1423 ErrNoMem => "Invalid address, or not enough available memory",
1424 ErrUnsupProt => "Protection mode unsupported",
1425 ErrUnsupOffset => "Offset in virtual memory mode is unsupported",
1426 ErrAlreadyExists => "File mapping for specified file already exists",
1427 ErrZeroLength => "Zero-length mapping not allowed",
1428 ErrUnknown(code) => {
1429 return write!(out, "Unknown error = {}", code)
1431 ErrVirtualAlloc(code) => {
1432 return write!(out, "VirtualAlloc failure = {}", code)
1434 ErrCreateFileMappingW(code) => {
1435 return write!(out, "CreateFileMappingW failure = {}", code)
1437 ErrMapViewOfFile(code) => {
1438 return write!(out, "MapViewOfFile failure = {}", code)
1441 write!(out, "{}", str)
1447 /// Create a new mapping with the given `options`, at least `min_len` bytes
1448 /// long. `min_len` must be greater than zero; see the note on
1449 /// `ErrZeroLength`.
1450 pub fn new(min_len: uint, options: &[MapOption]) -> Result<MemoryMap, MapError> {
1454 return Err(ErrZeroLength)
1456 let mut addr: *const u8 = ptr::null();
1458 let mut flags = libc::MAP_PRIVATE;
1461 let mut custom_flags = false;
1462 let len = round_up(min_len, page_size());
1464 for &o in options.iter() {
1466 MapReadable => { prot |= libc::PROT_READ; },
1467 MapWritable => { prot |= libc::PROT_WRITE; },
1468 MapExecutable => { prot |= libc::PROT_EXEC; },
1470 flags |= libc::MAP_FIXED;
1474 flags |= libc::MAP_FILE;
1477 MapOffset(offset_) => { offset = offset_ as off_t; },
1478 MapNonStandardFlags(f) => { custom_flags = true; flags = f },
1481 if fd == -1 && !custom_flags { flags |= libc::MAP_ANON; }
1484 libc::mmap(addr as *mut c_void, len as libc::size_t, prot, flags,
1487 if r == libc::MAP_FAILED {
1488 Err(match errno() as c_int {
1489 libc::EACCES => ErrFdNotAvail,
1490 libc::EBADF => ErrInvalidFd,
1491 libc::EINVAL => ErrUnaligned,
1492 libc::ENODEV => ErrNoMapSupport,
1493 libc::ENOMEM => ErrNoMem,
1494 code => ErrUnknown(code as int)
1503 MapFile(ptr::null())
1509 /// Granularity that the offset or address must be for `MapOffset` and
1510 /// `MapAddr` respectively.
1511 pub fn granularity() -> uint {
1517 impl Drop for MemoryMap {
1518 /// Unmap the mapping. Fails the task if `munmap` fails.
1519 fn drop(&mut self) {
1520 if self.len == 0 { /* workaround for dummy_stack */ return; }
1523 // `munmap` only fails due to logic errors
1524 libc::munmap(self.data as *mut c_void, self.len as libc::size_t);
1531 /// Create a new mapping with the given `options`, at least `min_len` bytes long.
1532 pub fn new(min_len: uint, options: &[MapOption]) -> Result<MemoryMap, MapError> {
1533 use libc::types::os::arch::extra::{LPVOID, DWORD, SIZE_T, HANDLE};
1535 let mut lpAddress: LPVOID = ptr::null_mut();
1536 let mut readable = false;
1537 let mut writable = false;
1538 let mut executable = false;
1539 let mut fd: c_int = -1;
1540 let mut offset: uint = 0;
1541 let len = round_up(min_len, page_size());
1543 for &o in options.iter() {
1545 MapReadable => { readable = true; },
1546 MapWritable => { writable = true; },
1547 MapExecutable => { executable = true; }
1548 MapAddr(addr_) => { lpAddress = addr_ as LPVOID; },
1549 MapFd(fd_) => { fd = fd_; },
1550 MapOffset(offset_) => { offset = offset_; },
1551 MapNonStandardFlags(..) => {}
1555 let flProtect = match (executable, readable, writable) {
1556 (false, false, false) if fd == -1 => libc::PAGE_NOACCESS,
1557 (false, true, false) => libc::PAGE_READONLY,
1558 (false, true, true) => libc::PAGE_READWRITE,
1559 (true, false, false) if fd == -1 => libc::PAGE_EXECUTE,
1560 (true, true, false) => libc::PAGE_EXECUTE_READ,
1561 (true, true, true) => libc::PAGE_EXECUTE_READWRITE,
1562 _ => return Err(ErrUnsupProt)
1567 return Err(ErrUnsupOffset);
1570 libc::VirtualAlloc(lpAddress,
1572 libc::MEM_COMMIT | libc::MEM_RESERVE,
1576 0 => Err(ErrVirtualAlloc(errno())),
1584 let dwDesiredAccess = match (executable, readable, writable) {
1585 (false, true, false) => libc::FILE_MAP_READ,
1586 (false, true, true) => libc::FILE_MAP_WRITE,
1587 (true, true, false) => libc::FILE_MAP_READ | libc::FILE_MAP_EXECUTE,
1588 (true, true, true) => libc::FILE_MAP_WRITE | libc::FILE_MAP_EXECUTE,
1589 _ => return Err(ErrUnsupProt) // Actually, because of the check above,
1590 // we should never get here.
1593 let hFile = libc::get_osfhandle(fd) as HANDLE;
1594 let mapping = libc::CreateFileMappingW(hFile,
1600 if mapping == ptr::null_mut() {
1601 return Err(ErrCreateFileMappingW(errno()));
1603 if errno() as c_int == libc::ERROR_ALREADY_EXISTS {
1604 return Err(ErrAlreadyExists);
1606 let r = libc::MapViewOfFile(mapping,
1608 ((len as u64) >> 32) as DWORD,
1609 (offset & 0xffff_ffff) as DWORD,
1612 0 => Err(ErrMapViewOfFile(errno())),
1616 kind: MapFile(mapping as *const u8)
1623 /// Granularity of MapAddr() and MapOffset() parameter values.
1624 /// This may be greater than the value returned by page_size().
1625 pub fn granularity() -> uint {
1628 let mut info = mem::zeroed();
1629 libc::GetSystemInfo(&mut info);
1631 return info.dwAllocationGranularity as uint;
1637 impl Drop for MemoryMap {
1638 /// Unmap the mapping. Fails the task if any of `VirtualFree`,
1639 /// `UnmapViewOfFile`, or `CloseHandle` fail.
1640 fn drop(&mut self) {
1641 use libc::types::os::arch::extra::{LPCVOID, HANDLE};
1642 use libc::consts::os::extra::FALSE;
1643 if self.len == 0 { return }
1648 if libc::VirtualFree(self.data as *mut c_void, 0,
1649 libc::MEM_RELEASE) == 0 {
1650 println!("VirtualFree failed: {}", errno());
1653 MapFile(mapping) => {
1654 if libc::UnmapViewOfFile(self.data as LPCVOID) == FALSE {
1655 println!("UnmapViewOfFile failed: {}", errno());
1657 if libc::CloseHandle(mapping as HANDLE) == FALSE {
1658 println!("CloseHandle failed: {}", errno());
1667 /// Returns the pointer to the memory created or modified by this map.
1668 pub fn data(&self) -> *mut u8 { self.data }
1669 /// Returns the number of bytes this map applies to.
1670 pub fn len(&self) -> uint { self.len }
1671 /// Returns the type of mapping this represents.
1672 pub fn kind(&self) -> MemoryMapKind { self.kind }
1675 #[cfg(target_os = "linux")]
1677 pub use os::arch_consts::ARCH;
1679 pub static FAMILY: &'static str = "unix";
1681 /// A string describing the specific operating system in use: in this
1683 pub static SYSNAME: &'static str = "linux";
1685 /// Specifies the filename prefix used for shared libraries on this
1686 /// platform: in this case, `lib`.
1687 pub static DLL_PREFIX: &'static str = "lib";
1689 /// Specifies the filename suffix used for shared libraries on this
1690 /// platform: in this case, `.so`.
1691 pub static DLL_SUFFIX: &'static str = ".so";
1693 /// Specifies the file extension used for shared libraries on this
1694 /// platform that goes after the dot: in this case, `so`.
1695 pub static DLL_EXTENSION: &'static str = "so";
1697 /// Specifies the filename suffix used for executable binaries on this
1698 /// platform: in this case, the empty string.
1699 pub static EXE_SUFFIX: &'static str = "";
1701 /// Specifies the file extension, if any, used for executable binaries
1702 /// on this platform: in this case, the empty string.
1703 pub static EXE_EXTENSION: &'static str = "";
1706 #[cfg(target_os = "macos")]
1708 pub use os::arch_consts::ARCH;
1710 pub static FAMILY: &'static str = "unix";
1712 /// A string describing the specific operating system in use: in this
1714 pub static SYSNAME: &'static str = "macos";
1716 /// Specifies the filename prefix used for shared libraries on this
1717 /// platform: in this case, `lib`.
1718 pub static DLL_PREFIX: &'static str = "lib";
1720 /// Specifies the filename suffix used for shared libraries on this
1721 /// platform: in this case, `.dylib`.
1722 pub static DLL_SUFFIX: &'static str = ".dylib";
1724 /// Specifies the file extension used for shared libraries on this
1725 /// platform that goes after the dot: in this case, `dylib`.
1726 pub static DLL_EXTENSION: &'static str = "dylib";
1728 /// Specifies the filename suffix used for executable binaries on this
1729 /// platform: in this case, the empty string.
1730 pub static EXE_SUFFIX: &'static str = "";
1732 /// Specifies the file extension, if any, used for executable binaries
1733 /// on this platform: in this case, the empty string.
1734 pub static EXE_EXTENSION: &'static str = "";
1737 #[cfg(target_os = "ios")]
1739 pub use os::arch_consts::ARCH;
1741 pub static FAMILY: &'static str = "unix";
1743 /// A string describing the specific operating system in use: in this
1745 pub static SYSNAME: &'static str = "ios";
1747 /// Specifies the filename suffix used for executable binaries on this
1748 /// platform: in this case, the empty string.
1749 pub static EXE_SUFFIX: &'static str = "";
1751 /// Specifies the file extension, if any, used for executable binaries
1752 /// on this platform: in this case, the empty string.
1753 pub static EXE_EXTENSION: &'static str = "";
1756 #[cfg(target_os = "freebsd")]
1758 pub use os::arch_consts::ARCH;
1760 pub static FAMILY: &'static str = "unix";
1762 /// A string describing the specific operating system in use: in this
1763 /// case, `freebsd`.
1764 pub static SYSNAME: &'static str = "freebsd";
1766 /// Specifies the filename prefix used for shared libraries on this
1767 /// platform: in this case, `lib`.
1768 pub static DLL_PREFIX: &'static str = "lib";
1770 /// Specifies the filename suffix used for shared libraries on this
1771 /// platform: in this case, `.so`.
1772 pub static DLL_SUFFIX: &'static str = ".so";
1774 /// Specifies the file extension used for shared libraries on this
1775 /// platform that goes after the dot: in this case, `so`.
1776 pub static DLL_EXTENSION: &'static str = "so";
1778 /// Specifies the filename suffix used for executable binaries on this
1779 /// platform: in this case, the empty string.
1780 pub static EXE_SUFFIX: &'static str = "";
1782 /// Specifies the file extension, if any, used for executable binaries
1783 /// on this platform: in this case, the empty string.
1784 pub static EXE_EXTENSION: &'static str = "";
1787 #[cfg(target_os = "dragonfly")]
1789 pub use os::arch_consts::ARCH;
1791 pub static FAMILY: &'static str = "unix";
1793 /// A string describing the specific operating system in use: in this
1794 /// case, `dragonfly`.
1795 pub static SYSNAME: &'static str = "dragonfly";
1797 /// Specifies the filename prefix used for shared libraries on this
1798 /// platform: in this case, `lib`.
1799 pub static DLL_PREFIX: &'static str = "lib";
1801 /// Specifies the filename suffix used for shared libraries on this
1802 /// platform: in this case, `.so`.
1803 pub static DLL_SUFFIX: &'static str = ".so";
1805 /// Specifies the file extension used for shared libraries on this
1806 /// platform that goes after the dot: in this case, `so`.
1807 pub static DLL_EXTENSION: &'static str = "so";
1809 /// Specifies the filename suffix used for executable binaries on this
1810 /// platform: in this case, the empty string.
1811 pub static EXE_SUFFIX: &'static str = "";
1813 /// Specifies the file extension, if any, used for executable binaries
1814 /// on this platform: in this case, the empty string.
1815 pub static EXE_EXTENSION: &'static str = "";
1818 #[cfg(target_os = "android")]
1820 pub use os::arch_consts::ARCH;
1822 pub static FAMILY: &'static str = "unix";
1824 /// A string describing the specific operating system in use: in this
1825 /// case, `android`.
1826 pub static SYSNAME: &'static str = "android";
1828 /// Specifies the filename prefix used for shared libraries on this
1829 /// platform: in this case, `lib`.
1830 pub static DLL_PREFIX: &'static str = "lib";
1832 /// Specifies the filename suffix used for shared libraries on this
1833 /// platform: in this case, `.so`.
1834 pub static DLL_SUFFIX: &'static str = ".so";
1836 /// Specifies the file extension used for shared libraries on this
1837 /// platform that goes after the dot: in this case, `so`.
1838 pub static DLL_EXTENSION: &'static str = "so";
1840 /// Specifies the filename suffix used for executable binaries on this
1841 /// platform: in this case, the empty string.
1842 pub static EXE_SUFFIX: &'static str = "";
1844 /// Specifies the file extension, if any, used for executable binaries
1845 /// on this platform: in this case, the empty string.
1846 pub static EXE_EXTENSION: &'static str = "";
1849 #[cfg(target_os = "windows")]
1851 pub use os::arch_consts::ARCH;
1853 pub static FAMILY: &'static str = "windows";
1855 /// A string describing the specific operating system in use: in this
1856 /// case, `windows`.
1857 pub static SYSNAME: &'static str = "windows";
1859 /// Specifies the filename prefix used for shared libraries on this
1860 /// platform: in this case, the empty string.
1861 pub static DLL_PREFIX: &'static str = "";
1863 /// Specifies the filename suffix used for shared libraries on this
1864 /// platform: in this case, `.dll`.
1865 pub static DLL_SUFFIX: &'static str = ".dll";
1867 /// Specifies the file extension used for shared libraries on this
1868 /// platform that goes after the dot: in this case, `dll`.
1869 pub static DLL_EXTENSION: &'static str = "dll";
1871 /// Specifies the filename suffix used for executable binaries on this
1872 /// platform: in this case, `.exe`.
1873 pub static EXE_SUFFIX: &'static str = ".exe";
1875 /// Specifies the file extension, if any, used for executable binaries
1876 /// on this platform: in this case, `exe`.
1877 pub static EXE_EXTENSION: &'static str = "exe";
1880 #[cfg(target_arch = "x86")]
1882 pub static ARCH: &'static str = "x86";
1885 #[cfg(target_arch = "x86_64")]
1887 pub static ARCH: &'static str = "x86_64";
1890 #[cfg(target_arch = "arm")]
1892 pub static ARCH: &'static str = "arm";
1895 #[cfg(target_arch = "mips")]
1897 pub static ARCH: &'static str = "mips";
1900 #[cfg(target_arch = "mipsel")]
1902 pub static ARCH: &'static str = "mipsel";
1910 use os::{env, getcwd, getenv, make_absolute};
1911 use os::{split_paths, join_paths, setenv, unsetenv};
1917 pub fn last_os_error() {
1918 debug!("{}", os::last_os_error());
1921 fn make_rand_name() -> String {
1922 let mut rng = rand::task_rng();
1923 let n = format!("TEST{}", rng.gen_ascii_chars().take(10u)
1924 .collect::<String>());
1925 assert!(getenv(n.as_slice()).is_none());
1930 fn test_num_cpus() {
1931 assert!(os::num_cpus() > 0);
1936 let n = make_rand_name();
1937 setenv(n.as_slice(), "VALUE");
1938 assert_eq!(getenv(n.as_slice()), option::Some("VALUE".to_string()));
1942 fn test_unsetenv() {
1943 let n = make_rand_name();
1944 setenv(n.as_slice(), "VALUE");
1945 unsetenv(n.as_slice());
1946 assert_eq!(getenv(n.as_slice()), option::None);
1951 fn test_setenv_overwrite() {
1952 let n = make_rand_name();
1953 setenv(n.as_slice(), "1");
1954 setenv(n.as_slice(), "2");
1955 assert_eq!(getenv(n.as_slice()), option::Some("2".to_string()));
1956 setenv(n.as_slice(), "");
1957 assert_eq!(getenv(n.as_slice()), option::Some("".to_string()));
1960 // Windows GetEnvironmentVariable requires some extra work to make sure
1961 // the buffer the variable is copied into is the right size
1964 fn test_getenv_big() {
1965 let mut s = "".to_string();
1968 s.push_str("aaaaaaaaaa");
1971 let n = make_rand_name();
1972 setenv(n.as_slice(), s.as_slice());
1973 debug!("{}", s.clone());
1974 assert_eq!(getenv(n.as_slice()), option::Some(s));
1978 fn test_self_exe_name() {
1979 let path = os::self_exe_name();
1980 assert!(path.is_some());
1981 let path = path.unwrap();
1982 debug!("{:?}", path.clone());
1984 // Hard to test this function
1985 assert!(path.is_absolute());
1989 fn test_self_exe_path() {
1990 let path = os::self_exe_path();
1991 assert!(path.is_some());
1992 let path = path.unwrap();
1993 debug!("{:?}", path.clone());
1995 // Hard to test this function
1996 assert!(path.is_absolute());
2001 fn test_env_getenv() {
2003 assert!(e.len() > 0u);
2005 let (n, v) = (*p).clone();
2006 debug!("{:?}", n.clone());
2007 let v2 = getenv(n.as_slice());
2008 // MingW seems to set some funky environment variables like
2009 // "=C:=C:\MinGW\msys\1.0\bin" and "!::=::\" that are returned
2010 // from env() but not visible from getenv().
2011 assert!(v2.is_none() || v2 == option::Some(v));
2016 fn test_env_set_get_huge() {
2017 let n = make_rand_name();
2018 let s = "x".repeat(10000).to_string();
2019 setenv(n.as_slice(), s.as_slice());
2020 assert_eq!(getenv(n.as_slice()), Some(s));
2021 unsetenv(n.as_slice());
2022 assert_eq!(getenv(n.as_slice()), None);
2026 fn test_env_setenv() {
2027 let n = make_rand_name();
2030 setenv(n.as_slice(), "VALUE");
2031 assert!(!e.contains(&(n.clone(), "VALUE".to_string())));
2034 assert!(e.contains(&(n, "VALUE".to_string())));
2039 assert!((!Path::new("test-path").is_absolute()));
2042 debug!("Current working directory: {}", cwd.display());
2044 debug!("{:?}", make_absolute(&Path::new("test-path")));
2045 debug!("{:?}", make_absolute(&Path::new("/usr/bin")));
2051 let oldhome = getenv("HOME");
2053 setenv("HOME", "/home/MountainView");
2054 assert!(os::homedir() == Some(Path::new("/home/MountainView")));
2057 assert!(os::homedir().is_none());
2059 for s in oldhome.iter() {
2060 setenv("HOME", s.as_slice());
2068 let oldhome = getenv("HOME");
2069 let olduserprofile = getenv("USERPROFILE");
2072 setenv("USERPROFILE", "");
2074 assert!(os::homedir().is_none());
2076 setenv("HOME", "/home/MountainView");
2077 assert!(os::homedir() == Some(Path::new("/home/MountainView")));
2081 setenv("USERPROFILE", "/home/MountainView");
2082 assert!(os::homedir() == Some(Path::new("/home/MountainView")));
2084 setenv("HOME", "/home/MountainView");
2085 setenv("USERPROFILE", "/home/PaloAlto");
2086 assert!(os::homedir() == Some(Path::new("/home/MountainView")));
2088 for s in oldhome.iter() {
2089 setenv("HOME", s.as_slice());
2091 for s in olduserprofile.iter() {
2092 setenv("USERPROFILE", s.as_slice());
2097 fn memory_map_rw() {
2098 use result::{Ok, Err};
2100 let chunk = match os::MemoryMap::new(16, [
2105 Err(msg) => fail!("{}", msg)
2107 assert!(chunk.len >= 16);
2111 assert!(*chunk.data == 0xBE);
2116 fn memory_map_file() {
2117 use result::{Ok, Err};
2123 fn lseek_(fd: c_int, size: uint) {
2125 assert!(lseek(fd, size as off_t, SEEK_SET) == size as off_t);
2129 fn lseek_(fd: c_int, size: uint) {
2131 assert!(lseek(fd, size as c_long, SEEK_SET) == size as c_long);
2135 let mut path = tmpdir();
2136 path.push("mmap_file.tmp");
2137 let size = MemoryMap::granularity() * 2;
2140 let fd = path.with_c_str(|path| {
2141 open(path, O_CREAT | O_RDWR | O_TRUNC, S_IRUSR | S_IWUSR)
2144 "x".with_c_str(|x| assert!(write(fd, x as *const c_void, 1) == 1));
2147 let chunk = match MemoryMap::new(size / 2, [
2154 Err(msg) => fail!("{}", msg)
2156 assert!(chunk.len > 0);
2160 assert!(*chunk.data == 0xbe);
2165 fs::unlink(&path).unwrap();
2170 fn split_paths_windows() {
2171 fn check_parse(unparsed: &str, parsed: &[&str]) -> bool {
2172 split_paths(unparsed) ==
2173 parsed.iter().map(|s| Path::new(*s)).collect()
2176 assert!(check_parse("", [""]));
2177 assert!(check_parse(r#""""#, [""]));
2178 assert!(check_parse(";;", ["", "", ""]));
2179 assert!(check_parse(r"c:\", [r"c:\"]));
2180 assert!(check_parse(r"c:\;", [r"c:\", ""]));
2181 assert!(check_parse(r"c:\;c:\Program Files\",
2182 [r"c:\", r"c:\Program Files\"]));
2183 assert!(check_parse(r#"c:\;c:\"foo"\"#, [r"c:\", r"c:\foo\"]));
2184 assert!(check_parse(r#"c:\;c:\"foo;bar"\;c:\baz"#,
2185 [r"c:\", r"c:\foo;bar\", r"c:\baz"]));
2190 fn split_paths_unix() {
2191 fn check_parse(unparsed: &str, parsed: &[&str]) -> bool {
2192 split_paths(unparsed) ==
2193 parsed.iter().map(|s| Path::new(*s)).collect()
2196 assert!(check_parse("", [""]));
2197 assert!(check_parse("::", ["", "", ""]));
2198 assert!(check_parse("/", ["/"]));
2199 assert!(check_parse("/:", ["/", ""]));
2200 assert!(check_parse("/:/usr/local", ["/", "/usr/local"]));
2205 fn join_paths_unix() {
2206 fn test_eq(input: &[&str], output: &str) -> bool {
2207 join_paths(input).unwrap().as_slice() == output.as_bytes()
2210 assert!(test_eq([], ""));
2211 assert!(test_eq(["/bin", "/usr/bin", "/usr/local/bin"],
2212 "/bin:/usr/bin:/usr/local/bin"));
2213 assert!(test_eq(["", "/bin", "", "", "/usr/bin", ""],
2214 ":/bin:::/usr/bin:"));
2215 assert!(join_paths(["/te:st"]).is_err());
2220 fn join_paths_windows() {
2221 fn test_eq(input: &[&str], output: &str) -> bool {
2222 join_paths(input).unwrap().as_slice() == output.as_bytes()
2225 assert!(test_eq([], ""));
2226 assert!(test_eq([r"c:\windows", r"c:\"],
2227 r"c:\windows;c:\"));
2228 assert!(test_eq(["", r"c:\windows", "", "", r"c:\", ""],
2229 r";c:\windows;;;c:\;"));
2230 assert!(test_eq([r"c:\te;st", r"c:\"],
2231 r#""c:\te;st";c:\"#));
2232 assert!(join_paths([r#"c:\te"st"#]).is_err());
2235 // More recursive_mkdir tests are in extra::tempfile