1 // Copyright 2012-2013 The Rust Project Developers. See the COPYRIGHT
2 // file at the top-level directory of this distribution and at
3 // http://rust-lang.org/COPYRIGHT.
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.
29 #[allow(missing_doc)];
33 use container::Container;
35 use iterator::{IteratorUtil, range};
37 use libc::{c_char, c_void, c_int, size_t};
40 use option::{Some, None};
46 use unstable::finally::Finally;
50 pub use os::consts::*;
52 /// Delegates to the libc close() function, returning the same return value.
53 pub fn close(fd: c_int) -> c_int {
60 use libc::{c_char, c_int};
64 pub fn rust_get_argc() -> c_int;
65 pub fn rust_get_argv() -> **c_char;
66 pub fn rust_path_is_dir(path: *libc::c_char) -> c_int;
67 pub fn rust_path_exists(path: *libc::c_char) -> c_int;
68 pub fn rust_set_exit_status(code: libc::intptr_t);
72 pub static TMPBUF_SZ : uint = 1000u;
73 static BUF_BYTES : uint = 2048u;
75 pub fn getcwd() -> Path {
76 let mut buf = [0 as libc::c_char, ..BUF_BYTES];
77 do buf.as_mut_buf |buf, len| {
79 if libc::getcwd(buf, len as size_t).is_null() {
83 Path(str::raw::from_c_str(buf as *c_char))
88 // FIXME: move these to str perhaps? #2620
90 pub fn fill_charp_buf(f: &fn(*mut c_char, size_t) -> bool) -> Option<~str> {
91 let mut buf = [0 as c_char, .. TMPBUF_SZ];
92 do buf.as_mut_buf |b, sz| {
93 if f(b, sz as size_t) {
95 Some(str::raw::from_c_str(b as *c_char))
108 use option::{None, Option};
111 use libc::types::os::arch::extra::DWORD;
113 pub fn fill_utf16_buf_and_decode(f: &fn(*mut u16, DWORD) -> DWORD)
116 let mut n = TMPBUF_SZ as DWORD;
118 let mut done = false;
120 let mut k: DWORD = 0;
121 let mut buf = vec::from_elem(n as uint, 0u16);
122 do buf.as_mut_buf |b, _sz| {
123 k = f(b, TMPBUF_SZ as DWORD);
124 if k == (0 as DWORD) {
127 libc::GetLastError() ==
128 libc::ERROR_INSUFFICIENT_BUFFER as DWORD) {
135 let sub = buf.slice(0, k as uint);
136 res = option::Some(str::from_utf16(sub));
143 pub fn as_utf16_p<T>(s: &str, f: &fn(*u16) -> T) -> T {
144 let mut t = s.to_utf16();
145 // Null terminate before passing on.
147 t.as_imm_buf(|buf, _len| f(buf))
152 Accessing environment variables is not generally threadsafe.
153 Serialize access through a global lock.
155 fn with_env_lock<T>(f: &fn() -> T) -> T {
156 use unstable::finally::Finally;
160 rust_take_env_lock();
163 rust_drop_env_lock();
169 fn rust_take_env_lock();
171 fn rust_drop_env_lock();
175 /// Returns a vector of (variable, value) pairs for all the environment
176 /// variables of the current process.
177 pub fn env() -> ~[(~str,~str)] {
180 unsafe fn get_env_pairs() -> ~[~str] {
181 use libc::funcs::extra::kernel32::{
182 GetEnvironmentStringsA,
183 FreeEnvironmentStringsA
185 let ch = GetEnvironmentStringsA();
186 if (ch as uint == 0) {
187 fail!("os::env() failure getting env string from OS: %s", os::last_os_error());
189 let mut curr_ptr: uint = ch as uint;
190 let mut result = ~[];
191 while(*(curr_ptr as *libc::c_char) != 0 as libc::c_char) {
192 let env_pair = str::raw::from_c_str(
193 curr_ptr as *libc::c_char);
194 result.push(env_pair);
196 libc::strlen(curr_ptr as *libc::c_char) as uint
199 FreeEnvironmentStringsA(ch);
203 unsafe fn get_env_pairs() -> ~[~str] {
205 fn rust_env_pairs() -> **libc::c_char;
207 let environ = rust_env_pairs();
208 if (environ as uint == 0) {
209 fail!("os::env() failure getting env string from OS: %s", os::last_os_error());
211 let mut result = ~[];
212 ptr::array_each(environ, |e| {
213 let env_pair = str::raw::from_c_str(e);
214 debug!("get_env_pairs: %s",
216 result.push(env_pair);
221 fn env_convert(input: ~[~str]) -> ~[(~str, ~str)] {
223 for p in input.iter() {
224 let vs: ~[&str] = p.splitn_iter('=', 1).collect();
225 debug!("splitting: len: %u",
227 assert_eq!(vs.len(), 2);
228 pairs.push((vs[0].to_owned(), vs[1].to_owned()));
233 let unparsed_environ = get_env_pairs();
234 env_convert(unparsed_environ)
240 /// Fetches the environment variable `n` from the current process, returning
241 /// None if the variable isn't set.
242 pub fn getenv(n: &str) -> Option<~str> {
245 let s = do n.to_c_str().with_ref |buf| {
251 Some(str::raw::from_c_str(s))
258 /// Fetches the environment variable `n` from the current process, returning
259 /// None if the variable isn't set.
260 pub fn getenv(n: &str) -> Option<~str> {
263 use os::win32::{as_utf16_p, fill_utf16_buf_and_decode};
264 do as_utf16_p(n) |u| {
265 do fill_utf16_buf_and_decode() |buf, sz| {
266 libc::GetEnvironmentVariableW(u, buf, sz)
275 /// Sets the environment variable `n` to the value `v` for the currently running
277 pub fn setenv(n: &str, v: &str) {
280 do n.to_c_str().with_ref |nbuf| {
281 do v.to_c_str().with_ref |vbuf| {
282 libc::funcs::posix01::unistd::setenv(nbuf, vbuf, 1);
291 /// Sets the environment variable `n` to the value `v` for the currently running
293 pub fn setenv(n: &str, v: &str) {
296 use os::win32::as_utf16_p;
297 do as_utf16_p(n) |nbuf| {
298 do as_utf16_p(v) |vbuf| {
299 libc::SetEnvironmentVariableW(nbuf, vbuf);
306 /// Remove a variable from the environment entirely
307 pub fn unsetenv(n: &str) {
309 fn _unsetenv(n: &str) {
312 do n.to_c_str().with_ref |nbuf| {
313 libc::funcs::posix01::unistd::unsetenv(nbuf);
319 fn _unsetenv(n: &str) {
322 use os::win32::as_utf16_p;
323 do as_utf16_p(n) |nbuf| {
324 libc::SetEnvironmentVariableW(nbuf, ptr::null());
333 pub fn fdopen(fd: c_int) -> *FILE {
334 do "r".to_c_str().with_ref |modebuf| {
336 libc::fdopen(fd, modebuf)
345 pub fn fsync_fd(fd: c_int, _level: io::fsync::Level) -> c_int {
347 use libc::funcs::extra::msvcrt::*;
352 #[cfg(target_os = "linux")]
353 #[cfg(target_os = "android")]
354 pub fn fsync_fd(fd: c_int, level: io::fsync::Level) -> c_int {
356 use libc::funcs::posix01::unistd::*;
359 | io::fsync::FullFSync => return fsync(fd),
360 io::fsync::FDataSync => return fdatasync(fd)
365 #[cfg(target_os = "macos")]
366 pub fn fsync_fd(fd: c_int, level: io::fsync::Level) -> c_int {
368 use libc::consts::os::extra::*;
369 use libc::funcs::posix88::fcntl::*;
370 use libc::funcs::posix01::unistd::*;
372 io::fsync::FSync => return fsync(fd),
374 // According to man fnctl, the ok retval is only specified to be
376 if (fcntl(F_FULLFSYNC as c_int, fd) == -1 as c_int)
377 { return -1 as c_int; }
379 { return 0 as c_int; }
385 #[cfg(target_os = "freebsd")]
386 pub fn fsync_fd(fd: c_int, _l: io::fsync::Level) -> c_int {
388 use libc::funcs::posix01::unistd::*;
399 pub fn pipe() -> Pipe {
401 let mut fds = Pipe {input: 0 as c_int,
403 assert_eq!(libc::pipe(&mut fds.input), (0 as c_int));
404 return Pipe {input: fds.input, out: fds.out};
411 pub fn pipe() -> Pipe {
413 // Windows pipes work subtly differently than unix pipes, and their
414 // inheritance has to be handled in a different way that I do not
415 // fully understand. Here we explicitly make the pipe non-inheritable,
416 // which means to pass it to a subprocess they need to be duplicated
417 // first, as in core::run.
418 let mut fds = Pipe {input: 0 as c_int,
420 let res = libc::pipe(&mut fds.input, 1024 as ::libc::c_uint,
421 (libc::O_BINARY | libc::O_NOINHERIT) as c_int);
422 assert_eq!(res, 0 as c_int);
423 assert!((fds.input != -1 as c_int && fds.input != 0 as c_int));
424 assert!((fds.out != -1 as c_int && fds.input != 0 as c_int));
425 return Pipe {input: fds.input, out: fds.out};
429 fn dup2(src: c_int, dst: c_int) -> c_int {
435 /// Returns the proper dll filename for the given basename of a file.
436 pub fn dll_filename(base: &str) -> ~str {
437 fmt!("%s%s%s", DLL_PREFIX, base, DLL_SUFFIX)
440 /// Optionally returns the filesystem path to the current executable which is
441 /// running. If any failure occurs, None is returned.
442 pub fn self_exe_path() -> Option<Path> {
444 #[cfg(target_os = "freebsd")]
445 fn load_self() -> Option<~str> {
447 use libc::funcs::bsd44::*;
448 use libc::consts::os::extra::*;
449 do fill_charp_buf() |buf, sz| {
450 let mib = ~[CTL_KERN as c_int,
452 KERN_PROC_PATHNAME as c_int, -1 as c_int];
454 sysctl(vec::raw::to_ptr(mib), mib.len() as ::libc::c_uint,
455 buf as *mut c_void, &mut sz, ptr::null(),
456 0u as size_t) == (0 as c_int)
461 #[cfg(target_os = "linux")]
462 #[cfg(target_os = "android")]
463 fn load_self() -> Option<~str> {
465 use libc::funcs::posix01::unistd::readlink;
467 let mut path = [0 as c_char, .. TMPBUF_SZ];
469 do path.as_mut_buf |buf, len| {
470 let len = do "/proc/self/exe".to_c_str.with_ref |proc_self_buf| {
471 readlink(proc_self_buf, buf, len as size_t) as uint
477 Some(str::raw::from_buf_len(buf as *u8, len))
483 #[cfg(target_os = "macos")]
484 fn load_self() -> Option<~str> {
486 do fill_charp_buf() |buf, sz| {
487 let mut sz = sz as u32;
488 libc::funcs::extra::_NSGetExecutablePath(
489 buf, &mut sz) == (0 as c_int)
495 fn load_self() -> Option<~str> {
497 use os::win32::fill_utf16_buf_and_decode;
498 do fill_utf16_buf_and_decode() |buf, sz| {
499 libc::GetModuleFileNameW(0u as libc::DWORD, buf, sz)
504 do load_self().map |pth| {
505 Path(*pth).dir_path()
511 * Returns the path to the user's home directory, if known.
513 * On Unix, returns the value of the 'HOME' environment variable if it is set
514 * and not equal to the empty string.
516 * On Windows, returns the value of the 'HOME' environment variable if it is
517 * set and not equal to the empty string. Otherwise, returns the value of the
518 * 'USERPROFILE' environment variable if it is set and not equal to the empty
521 * Otherwise, homedir returns option::none.
523 pub fn homedir() -> Option<Path> {
524 return match getenv("HOME") {
525 Some(ref p) => if !p.is_empty() {
534 fn secondary() -> Option<Path> {
539 fn secondary() -> Option<Path> {
540 do getenv("USERPROFILE").chain |p| {
551 * Returns the path to a temporary directory.
553 * On Unix, returns the value of the 'TMPDIR' environment variable if it is
554 * set and non-empty and '/tmp' otherwise.
556 * On Windows, returns the value of, in order, the 'TMP', 'TEMP',
557 * 'USERPROFILE' environment variable if any are set and not the empty
558 * string. Otherwise, tmpdir returns the path to the Windows directory.
560 pub fn tmpdir() -> Path {
563 fn getenv_nonempty(v: &str) -> Option<Path> {
576 fn lookup() -> Path {
577 getenv_nonempty("TMPDIR").get_or_default(Path("/tmp"))
581 fn lookup() -> Path {
582 getenv_nonempty("TMP").or(
583 getenv_nonempty("TEMP").or(
584 getenv_nonempty("USERPROFILE").or(
585 getenv_nonempty("WINDIR")))).get_or_default(Path("C:\\Windows"))
589 /// Recursively walk a directory structure
590 pub fn walk_dir(p: &Path, f: &fn(&Path) -> bool) -> bool {
592 r.iter().advance(|q| {
593 let path = &p.push(*q);
594 f(path) && (!path_is_dir(path) || walk_dir(path, |p| f(p)))
598 /// Indicates whether a path represents a directory
599 pub fn path_is_dir(p: &Path) -> bool {
601 do p.to_c_str().with_ref |buf| {
602 rustrt::rust_path_is_dir(buf) != 0 as c_int
607 /// Indicates whether a path exists
608 pub fn path_exists(p: &Path) -> bool {
610 do p.to_c_str().with_ref |buf| {
611 rustrt::rust_path_exists(buf) != 0 as c_int
617 * Convert a relative path to an absolute path
619 * If the given path is relative, return it prepended with the current working
620 * directory. If the given path is already an absolute path, return it
623 // NB: this is here rather than in path because it is a form of environment
624 // querying; what it does depends on the process working directory, not just
626 pub fn make_absolute(p: &Path) -> Path {
630 getcwd().push_many(p.components)
635 /// Creates a directory at the specified path
636 pub fn make_dir(p: &Path, mode: c_int) -> bool {
637 return mkdir(p, mode);
640 fn mkdir(p: &Path, _mode: c_int) -> bool {
642 use os::win32::as_utf16_p;
643 // FIXME: turn mode into something useful? #2623
644 do as_utf16_p(p.to_str()) |buf| {
645 libc::CreateDirectoryW(buf, ptr::null()) != (0 as libc::BOOL)
651 fn mkdir(p: &Path, mode: c_int) -> bool {
652 do p.to_c_str().with_ref |buf| {
654 libc::mkdir(buf, mode as libc::mode_t) == (0 as c_int)
660 /// Creates a directory with a given mode.
661 /// Returns true iff creation
662 /// succeeded. Also creates all intermediate subdirectories
663 /// if they don't already exist, giving all of them the same mode.
665 // tjc: if directory exists but with different permissions,
666 // should we return false?
667 pub fn mkdir_recursive(p: &Path, mode: c_int) -> bool {
671 else if p.components.is_empty() {
674 else if p.components.len() == 1 {
675 // No parent directories to create
676 path_is_dir(p) || make_dir(p, mode)
679 mkdir_recursive(&p.pop(), mode) && make_dir(p, mode)
683 /// Lists the contents of a directory
684 pub fn list_dir(p: &Path) -> ~[~str] {
685 if p.components.is_empty() && !p.is_absolute() {
686 // Not sure what the right behavior is here, but this
687 // prevents a bounds check failure later
691 #[cfg(target_os = "linux")]
692 #[cfg(target_os = "android")]
693 #[cfg(target_os = "freebsd")]
694 #[cfg(target_os = "macos")]
695 unsafe fn get_list(p: &Path) -> ~[~str] {
696 use libc::{dirent_t};
697 use libc::{opendir, readdir, closedir};
699 fn rust_list_dir_val(ptr: *dirent_t) -> *libc::c_char;
701 let mut strings = ~[];
702 debug!("os::list_dir -- BEFORE OPENDIR");
704 let dir_ptr = do p.to_c_str().with_ref |buf| {
708 if (dir_ptr as uint != 0) {
709 debug!("os::list_dir -- opendir() SUCCESS");
710 let mut entry_ptr = readdir(dir_ptr);
711 while (entry_ptr as uint != 0) {
712 strings.push(str::raw::from_c_str(rust_list_dir_val(
714 entry_ptr = readdir(dir_ptr);
719 debug!("os::list_dir -- opendir() FAILURE");
722 "os::list_dir -- AFTER -- #: %?",
727 unsafe fn get_list(p: &Path) -> ~[~str] {
728 use libc::consts::os::extra::INVALID_HANDLE_VALUE;
729 use libc::{wcslen, free};
730 use libc::funcs::extra::kernel32::{
738 use rt::global_heap::malloc_raw;
742 fn rust_list_dir_wfd_size() -> libc::size_t;
743 fn rust_list_dir_wfd_fp_buf(wfd: *libc::c_void) -> *u16;
745 fn star(p: &Path) -> Path { p.push("*") }
746 do as_utf16_p(star(p).to_str()) |path_ptr| {
747 let mut strings = ~[];
748 let wfd_ptr = malloc_raw(rust_list_dir_wfd_size() as uint);
749 let find_handle = FindFirstFileW(path_ptr, wfd_ptr as HANDLE);
750 if find_handle as libc::c_int != INVALID_HANDLE_VALUE {
751 let mut more_files = 1 as libc::c_int;
752 while more_files != 0 {
753 let fp_buf = rust_list_dir_wfd_fp_buf(wfd_ptr);
754 if fp_buf as uint == 0 {
755 fail!("os::list_dir() failure: got null ptr from wfd");
758 let fp_vec = vec::from_buf(
759 fp_buf, wcslen(fp_buf) as uint);
760 let fp_str = str::from_utf16(fp_vec);
761 strings.push(fp_str);
763 more_files = FindNextFileW(find_handle, wfd_ptr as HANDLE);
765 FindClose(find_handle);
771 do get_list(p).consume_iter().filter |filename| {
772 "." != *filename && ".." != *filename
778 * Lists the contents of a directory
780 * This version prepends each entry with the directory.
782 pub fn list_dir_path(p: &Path) -> ~[Path] {
783 list_dir(p).map(|f| p.push(*f))
786 /// Removes a directory at the specified path, after removing
787 /// all its contents. Use carefully!
788 pub fn remove_dir_recursive(p: &Path) -> bool {
789 let mut error_happened = false;
790 do walk_dir(p) |inner| {
792 if path_is_dir(inner) {
793 if !remove_dir_recursive(inner) {
794 error_happened = true;
798 if !remove_file(inner) {
799 error_happened = true;
805 // Directory should now be empty
806 !error_happened && remove_dir(p)
809 /// Removes a directory at the specified path
810 pub fn remove_dir(p: &Path) -> bool {
814 fn rmdir(p: &Path) -> bool {
816 use os::win32::as_utf16_p;
817 return do as_utf16_p(p.to_str()) |buf| {
818 libc::RemoveDirectoryW(buf) != (0 as libc::BOOL)
824 fn rmdir(p: &Path) -> bool {
825 do p.to_c_str().with_ref |buf| {
827 libc::rmdir(buf) == (0 as c_int)
833 /// Changes the current working directory to the specified path, returning
834 /// whether the change was completed successfully or not.
835 pub fn change_dir(p: &Path) -> bool {
839 fn chdir(p: &Path) -> bool {
841 use os::win32::as_utf16_p;
842 return do as_utf16_p(p.to_str()) |buf| {
843 libc::SetCurrentDirectoryW(buf) != (0 as libc::BOOL)
849 fn chdir(p: &Path) -> bool {
850 do p.to_c_str().with_ref |buf| {
852 libc::chdir(buf) == (0 as c_int)
858 /// Copies a file from one location to another
859 pub fn copy_file(from: &Path, to: &Path) -> bool {
860 return do_copy_file(from, to);
863 fn do_copy_file(from: &Path, to: &Path) -> bool {
865 use os::win32::as_utf16_p;
866 return do as_utf16_p(from.to_str()) |fromp| {
867 do as_utf16_p(to.to_str()) |top| {
868 libc::CopyFileW(fromp, top, (0 as libc::BOOL)) !=
876 fn do_copy_file(from: &Path, to: &Path) -> bool {
878 let istream = do from.to_c_str().with_ref |fromp| {
879 do "rb".to_c_str().with_ref |modebuf| {
880 libc::fopen(fromp, modebuf)
883 if istream as uint == 0u {
886 // Preserve permissions
887 let from_mode = from.get_mode().expect("copy_file: couldn't get permissions \
890 let ostream = do to.to_c_str().with_ref |top| {
891 do "w+b".to_c_str().with_ref |modebuf| {
892 libc::fopen(top, modebuf)
895 if ostream as uint == 0u {
900 let mut buf = vec::with_capacity::<u8>(bufsize);
901 let mut done = false;
904 do buf.as_mut_buf |b, _sz| {
905 let nread = libc::fread(b as *mut c_void, 1u as size_t,
908 if nread > 0 as size_t {
909 if libc::fwrite(b as *c_void, 1u as size_t, nread,
922 // Give the new file the old file's permissions
923 if do to.to_c_str().with_ref |to_buf| {
924 libc::chmod(to_buf, from_mode as libc::mode_t)
926 return false; // should be a condition...
933 /// Deletes an existing file
934 pub fn remove_file(p: &Path) -> bool {
938 fn unlink(p: &Path) -> bool {
940 use os::win32::as_utf16_p;
941 return do as_utf16_p(p.to_str()) |buf| {
942 libc::DeleteFileW(buf) != (0 as libc::BOOL)
948 fn unlink(p: &Path) -> bool {
950 do p.to_c_str().with_ref |buf| {
951 libc::unlink(buf) == (0 as c_int)
958 /// Returns the platform-specific value of errno
959 pub fn errno() -> int {
960 #[cfg(target_os = "macos")]
961 #[cfg(target_os = "freebsd")]
962 fn errno_location() -> *c_int {
965 fn __error() -> *c_int;
972 #[cfg(target_os = "linux")]
973 #[cfg(target_os = "android")]
974 fn errno_location() -> *c_int {
977 fn __errno_location() -> *c_int;
985 (*errno_location()) as int
990 /// Returns the platform-specific value of errno
991 pub fn errno() -> uint {
992 use libc::types::os::arch::extra::DWORD;
994 #[link_name = "kernel32"]
997 fn GetLastError() -> DWORD;
1001 GetLastError() as uint
1005 /// Get a string representing the platform-dependent last error
1006 pub fn last_os_error() -> ~str {
1008 fn strerror() -> ~str {
1009 #[cfg(target_os = "macos")]
1010 #[cfg(target_os = "android")]
1011 #[cfg(target_os = "freebsd")]
1012 fn strerror_r(errnum: c_int, buf: *mut c_char, buflen: size_t)
1016 fn strerror_r(errnum: c_int, buf: *mut c_char, buflen: size_t)
1020 strerror_r(errnum, buf, buflen)
1024 // GNU libc provides a non-compliant version of strerror_r by default
1025 // and requires macros to instead use the POSIX compliant variant.
1026 // So we just use __xpg_strerror_r which is always POSIX compliant
1027 #[cfg(target_os = "linux")]
1028 fn strerror_r(errnum: c_int, buf: *mut c_char, buflen: size_t) -> c_int {
1031 fn __xpg_strerror_r(errnum: c_int,
1037 __xpg_strerror_r(errnum, buf, buflen)
1041 let mut buf = [0 as c_char, ..TMPBUF_SZ];
1043 do buf.as_mut_buf |buf, len| {
1045 if strerror_r(errno() as c_int, buf, len as size_t) < 0 {
1046 fail!("strerror_r failure");
1049 str::raw::from_c_str(buf as *c_char)
1055 fn strerror() -> ~str {
1056 use libc::types::os::arch::extra::DWORD;
1057 use libc::types::os::arch::extra::LPSTR;
1058 use libc::types::os::arch::extra::LPVOID;
1060 #[link_name = "kernel32"]
1063 fn FormatMessageA(flags: DWORD,
1073 static FORMAT_MESSAGE_FROM_SYSTEM: DWORD = 0x00001000;
1074 static FORMAT_MESSAGE_IGNORE_INSERTS: DWORD = 0x00000200;
1076 // This value is calculated from the macro
1077 // MAKELANGID(LANG_SYSTEM_DEFAULT, SUBLANG_SYS_DEFAULT)
1078 let langId = 0x0800 as DWORD;
1079 let err = errno() as DWORD;
1081 let mut buf = [0 as c_char, ..TMPBUF_SZ];
1083 do buf.as_imm_buf |buf, len| {
1085 let res = FormatMessageA(FORMAT_MESSAGE_FROM_SYSTEM |
1086 FORMAT_MESSAGE_IGNORE_INSERTS,
1094 fail!("[%?] FormatMessage failure", errno());
1097 str::raw::from_c_str(buf)
1106 * Sets the process exit code
1108 * Sets the exit code returned by the process if all supervised tasks
1109 * terminate successfully (without failing). If the current root task fails
1110 * and is supervised by the scheduler then any user-specified exit status is
1111 * ignored and the process exits with the default failure status
1113 pub fn set_exit_status(code: int) {
1115 use rt::OldTaskContext;
1117 if rt::context() == OldTaskContext {
1119 rustrt::rust_set_exit_status(code as libc::intptr_t);
1122 rt::util::set_exit_status(code);
1126 unsafe fn load_argc_and_argv(argc: c_int, argv: **c_char) -> ~[~str] {
1128 for i in range(0u, argc as uint) {
1129 args.push(str::raw::from_c_str(*argv.offset(i as int)));
1135 * Returns the command line arguments
1137 * Returns a list of the command line arguments.
1139 #[cfg(target_os = "macos")]
1140 pub fn real_args() -> ~[~str] {
1142 let (argc, argv) = (*_NSGetArgc() as c_int,
1143 *_NSGetArgv() as **c_char);
1144 load_argc_and_argv(argc, argv)
1148 #[cfg(target_os = "linux")]
1149 #[cfg(target_os = "android")]
1150 #[cfg(target_os = "freebsd")]
1151 pub fn real_args() -> ~[~str] {
1153 use rt::TaskContext;
1155 if rt::context() == TaskContext {
1156 match rt::args::clone() {
1158 None => fail!("process arguments not initialized")
1162 let argc = rustrt::rust_get_argc();
1163 let argv = rustrt::rust_get_argv();
1164 load_argc_and_argv(argc, argv)
1170 pub fn real_args() -> ~[~str] {
1171 let mut nArgs: c_int = 0;
1172 let lpArgCount: *mut c_int = &mut nArgs;
1173 let lpCmdLine = unsafe { GetCommandLineW() };
1174 let szArgList = unsafe { CommandLineToArgvW(lpCmdLine, lpArgCount) };
1177 for i in range(0u, nArgs as uint) {
1179 // Determine the length of this argument.
1180 let ptr = *szArgList.offset(i as int);
1182 while *ptr.offset(len as int) != 0 { len += 1; }
1184 // Push it onto the list.
1185 args.push(vec::raw::buf_as_slice(ptr, len,
1191 LocalFree(szArgList as *c_void);
1197 type LPCWSTR = *u16;
1200 #[link_name="kernel32"]
1203 fn GetCommandLineW() -> LPCWSTR;
1204 fn LocalFree(ptr: *c_void);
1208 #[link_name="shell32"]
1211 fn CommandLineToArgvW(lpCmdLine: LPCWSTR, pNumArgs: *mut c_int) -> **u16;
1214 struct OverriddenArgs {
1218 static overridden_arg_key: local_data::Key<@OverriddenArgs> = &local_data::Key;
1220 /// Returns the arguments which this program was started with (normally passed
1221 /// via the command line).
1223 /// The return value of the function can be changed by invoking the
1224 /// `os::set_args` function.
1225 pub fn args() -> ~[~str] {
1226 match local_data::get(overridden_arg_key, |k| k.map(|&k| *k)) {
1227 None => real_args(),
1228 Some(args) => args.val.clone()
1232 /// For the current task, overrides the task-local cache of the arguments this
1233 /// program had when it started. These new arguments are only available to the
1234 /// current task via the `os::args` method.
1235 pub fn set_args(new_args: ~[~str]) {
1236 let overridden_args = @OverriddenArgs {
1237 val: new_args.clone()
1239 local_data::set(overridden_arg_key, overridden_args);
1242 // FIXME #6100 we should really use an internal implementation of this - using
1243 // the POSIX glob functions isn't portable to windows, probably has slight
1244 // inconsistencies even where it is implemented, and makes extending
1245 // functionality a lot more difficult
1246 // FIXME #6101 also provide a non-allocating version - each_glob or so?
1247 /// Returns a vector of Path objects that match the given glob pattern
1248 #[cfg(target_os = "linux")]
1249 #[cfg(target_os = "android")]
1250 #[cfg(target_os = "freebsd")]
1251 #[cfg(target_os = "macos")]
1252 pub fn glob(pattern: &str) -> ~[Path] {
1253 #[cfg(target_os = "linux")]
1254 #[cfg(target_os = "android")]
1255 fn default_glob_t () -> libc::glob_t {
1258 gl_pathv: ptr::null(),
1260 __unused1: ptr::null(),
1261 __unused2: ptr::null(),
1262 __unused3: ptr::null(),
1263 __unused4: ptr::null(),
1264 __unused5: ptr::null(),
1268 #[cfg(target_os = "freebsd")]
1269 fn default_glob_t () -> libc::glob_t {
1275 gl_pathv: ptr::null(),
1276 __unused3: ptr::null(),
1277 __unused4: ptr::null(),
1278 __unused5: ptr::null(),
1279 __unused6: ptr::null(),
1280 __unused7: ptr::null(),
1281 __unused8: ptr::null(),
1285 #[cfg(target_os = "macos")]
1286 fn default_glob_t () -> libc::glob_t {
1292 gl_pathv: ptr::null(),
1293 __unused3: ptr::null(),
1294 __unused4: ptr::null(),
1295 __unused5: ptr::null(),
1296 __unused6: ptr::null(),
1297 __unused7: ptr::null(),
1298 __unused8: ptr::null(),
1302 let mut g = default_glob_t();
1303 do pattern.to_c_str().with_ref |c_pattern| {
1304 unsafe { libc::glob(c_pattern, 0, ptr::null(), &mut g) }
1307 let paths = unsafe {
1308 vec::raw::from_buf_raw(g.gl_pathv, g.gl_pathc as uint)
1310 do paths.map |&c_str| {
1311 Path(unsafe { str::raw::from_c_str(c_str) })
1314 unsafe { libc::globfree(&mut g) };
1318 /// Returns a vector of Path objects that match the given glob pattern
1319 #[cfg(target_os = "win32")]
1320 pub fn glob(_pattern: &str) -> ~[Path] {
1321 fail!("glob() is unimplemented on Windows")
1324 #[cfg(target_os = "macos")]
1326 // These functions are in crt_externs.h.
1327 pub fn _NSGetArgc() -> *c_int;
1328 pub fn _NSGetArgv() -> ***c_char;
1331 // Round up `from` to be divisible by `to`
1332 fn round_up(from: uint, to: uint) -> uint {
1333 let r = if from % to == 0 {
1336 from + to - (from % to)
1346 pub fn page_size() -> uint {
1348 libc::sysconf(libc::_SC_PAGESIZE) as uint
1353 pub fn page_size() -> uint {
1355 let mut info = libc::SYSTEM_INFO::new();
1356 libc::GetSystemInfo(&mut info);
1358 return info.dwPageSize as uint;
1362 pub struct MemoryMap {
1368 pub enum MemoryMapKind {
1373 pub enum MapOption {
1383 // Linux-specific errors
1389 ErrUnknown(libc::c_int),
1391 // Windows-specific errors
1396 ErrVirtualAlloc(uint),
1397 ErrCreateFileMappingW(uint),
1398 ErrMapViewOfFile(uint)
1401 impl to_str::ToStr for MapError {
1402 fn to_str(&self) -> ~str {
1404 ErrFdNotAvail => ~"fd not available for reading or writing",
1405 ErrInvalidFd => ~"Invalid fd",
1406 ErrUnaligned => ~"Unaligned address, invalid flags, \
1407 negative length or unaligned offset",
1408 ErrNoMapSupport=> ~"File doesn't support mapping",
1409 ErrNoMem => ~"Invalid address, or not enough available memory",
1410 ErrUnknown(code) => fmt!("Unknown error=%?", code),
1411 ErrUnsupProt => ~"Protection mode unsupported",
1412 ErrUnsupOffset => ~"Offset in virtual memory mode is unsupported",
1413 ErrNeedRW => ~"File mapping should be at least readable/writable",
1414 ErrAlreadyExists => ~"File mapping for specified file already exists",
1415 ErrVirtualAlloc(code) => fmt!("VirtualAlloc failure=%?", code),
1416 ErrCreateFileMappingW(code) => fmt!("CreateFileMappingW failure=%?", code),
1417 ErrMapViewOfFile(code) => fmt!("MapViewOfFile failure=%?", code)
1424 pub fn new(min_len: uint, options: ~[MapOption]) -> Result<~MemoryMap, MapError> {
1427 let mut addr: *c_void = ptr::null();
1428 let mut prot: c_int = 0;
1429 let mut flags: c_int = libc::MAP_PRIVATE;
1430 let mut fd: c_int = -1;
1431 let mut offset: off_t = 0;
1432 let len = round_up(min_len, page_size()) as size_t;
1434 for &o in options.iter() {
1436 MapReadable => { prot |= libc::PROT_READ; },
1437 MapWritable => { prot |= libc::PROT_WRITE; },
1438 MapExecutable => { prot |= libc::PROT_EXEC; },
1440 flags |= libc::MAP_FIXED;
1444 flags |= libc::MAP_FILE;
1447 MapOffset(offset_) => { offset = offset_ as off_t; }
1450 if fd == -1 { flags |= libc::MAP_ANON; }
1453 libc::mmap(addr, len, prot, flags, fd, offset)
1455 if r == libc::MAP_FAILED {
1456 Err(match errno() as c_int {
1457 libc::EACCES => ErrFdNotAvail,
1458 libc::EBADF => ErrInvalidFd,
1459 libc::EINVAL => ErrUnaligned,
1460 libc::ENODEV => ErrNoMapSupport,
1461 libc::ENOMEM => ErrNoMem,
1462 code => ErrUnknown(code)
1471 MapFile(ptr::null())
1479 impl Drop for MemoryMap {
1482 match libc::munmap(self.data as *c_void, self.len) {
1484 -1 => error!(match errno() as c_int {
1485 libc::EINVAL => ~"invalid addr or len",
1486 e => fmt!("unknown errno=%?", e)
1488 r => error!(fmt!("Unexpected result %?", r))
1496 pub fn new(min_len: uint, options: ~[MapOption]) -> Result<~MemoryMap, MapError> {
1497 use libc::types::os::arch::extra::{LPVOID, DWORD, SIZE_T, HANDLE};
1499 let mut lpAddress: LPVOID = ptr::mut_null();
1500 let mut readable = false;
1501 let mut writable = false;
1502 let mut executable = false;
1503 let mut fd: c_int = -1;
1504 let mut offset: uint = 0;
1505 let len = round_up(min_len, page_size()) as SIZE_T;
1507 for &o in options.iter() {
1509 MapReadable => { readable = true; },
1510 MapWritable => { writable = true; },
1511 MapExecutable => { executable = true; }
1512 MapAddr(addr_) => { lpAddress = addr_ as LPVOID; },
1513 MapFd(fd_) => { fd = fd_; },
1514 MapOffset(offset_) => { offset = offset_; }
1518 let flProtect = match (executable, readable, writable) {
1519 (false, false, false) if fd == -1 => libc::PAGE_NOACCESS,
1520 (false, true, false) => libc::PAGE_READONLY,
1521 (false, true, true) => libc::PAGE_READWRITE,
1522 (true, false, false) if fd == -1 => libc::PAGE_EXECUTE,
1523 (true, true, false) => libc::PAGE_EXECUTE_READ,
1524 (true, true, true) => libc::PAGE_EXECUTE_READWRITE,
1525 _ => return Err(ErrUnsupProt)
1530 return Err(ErrUnsupOffset);
1533 libc::VirtualAlloc(lpAddress,
1535 libc::MEM_COMMIT | libc::MEM_RESERVE,
1539 0 => Err(ErrVirtualAlloc(errno())),
1540 _ => Ok(~MemoryMap {
1547 let dwDesiredAccess = match (readable, writable) {
1548 (true, true) => libc::FILE_MAP_ALL_ACCESS,
1549 (true, false) => libc::FILE_MAP_READ,
1550 (false, true) => libc::FILE_MAP_WRITE,
1552 return Err(ErrNeedRW);
1556 let hFile = libc::get_osfhandle(fd) as HANDLE;
1557 let mapping = libc::CreateFileMappingW(hFile,
1560 (len >> 32) as DWORD,
1561 (len & 0xffff_ffff) as DWORD,
1563 if mapping == ptr::mut_null() {
1564 return Err(ErrCreateFileMappingW(errno()));
1566 if errno() as c_int == libc::ERROR_ALREADY_EXISTS {
1567 return Err(ErrAlreadyExists);
1569 let r = libc::MapViewOfFile(mapping,
1571 (offset >> 32) as DWORD,
1572 (offset & 0xffff_ffff) as DWORD,
1575 0 => Err(ErrMapViewOfFile(errno())),
1576 _ => Ok(~MemoryMap {
1579 kind: MapFile(mapping as *c_void)
1588 impl Drop for MemoryMap {
1590 use libc::types::os::arch::extra::{LPCVOID, HANDLE};
1594 MapVirtual => match libc::VirtualFree(self.data as *mut c_void,
1596 libc::MEM_RELEASE) {
1597 0 => error!(fmt!("VirtualFree failed: %?", errno())),
1600 MapFile(mapping) => {
1601 if libc::UnmapViewOfFile(self.data as LPCVOID) != 0 {
1602 error!(fmt!("UnmapViewOfFile failed: %?", errno()));
1604 if libc::CloseHandle(mapping as HANDLE) != 0 {
1605 error!(fmt!("CloseHandle failed: %?", errno()));
1616 pub use os::consts::unix::*;
1619 pub use os::consts::windows::*;
1621 #[cfg(target_os = "macos")]
1622 pub use os::consts::macos::*;
1624 #[cfg(target_os = "freebsd")]
1625 pub use os::consts::freebsd::*;
1627 #[cfg(target_os = "linux")]
1628 pub use os::consts::linux::*;
1630 #[cfg(target_os = "android")]
1631 pub use os::consts::android::*;
1633 #[cfg(target_os = "win32")]
1634 pub use os::consts::win32::*;
1636 #[cfg(target_arch = "x86")]
1637 pub use os::consts::x86::*;
1639 #[cfg(target_arch = "x86_64")]
1640 pub use os::consts::x86_64::*;
1642 #[cfg(target_arch = "arm")]
1643 pub use os::consts::arm::*;
1645 #[cfg(target_arch = "mips")]
1646 use os::consts::mips::*;
1649 pub static FAMILY: &'static str = "unix";
1653 pub static FAMILY: &'static str = "windows";
1657 pub static SYSNAME: &'static str = "macos";
1658 pub static DLL_PREFIX: &'static str = "lib";
1659 pub static DLL_SUFFIX: &'static str = ".dylib";
1660 pub static EXE_SUFFIX: &'static str = "";
1664 pub static SYSNAME: &'static str = "freebsd";
1665 pub static DLL_PREFIX: &'static str = "lib";
1666 pub static DLL_SUFFIX: &'static str = ".so";
1667 pub static EXE_SUFFIX: &'static str = "";
1671 pub static SYSNAME: &'static str = "linux";
1672 pub static DLL_PREFIX: &'static str = "lib";
1673 pub static DLL_SUFFIX: &'static str = ".so";
1674 pub static EXE_SUFFIX: &'static str = "";
1678 pub static SYSNAME: &'static str = "android";
1679 pub static DLL_PREFIX: &'static str = "lib";
1680 pub static DLL_SUFFIX: &'static str = ".so";
1681 pub static EXE_SUFFIX: &'static str = "";
1685 pub static SYSNAME: &'static str = "win32";
1686 pub static DLL_PREFIX: &'static str = "";
1687 pub static DLL_SUFFIX: &'static str = ".dll";
1688 pub static EXE_SUFFIX: &'static str = ".exe";
1693 pub static ARCH: &'static str = "x86";
1696 pub static ARCH: &'static str = "x86_64";
1699 pub static ARCH: &'static str = "arm";
1702 pub static ARCH: &'static str = "mips";
1709 use libc::{c_int, c_void, size_t};
1713 use os::{env, getcwd, getenv, make_absolute, real_args};
1714 use os::{remove_file, setenv, unsetenv};
1721 use libc::consts::os::posix88::{S_IRUSR, S_IWUSR, S_IXUSR};
1725 pub fn last_os_error() {
1726 debug!(os::last_os_error());
1730 pub fn test_args() {
1731 let a = real_args();
1732 assert!(a.len() >= 1);
1735 fn make_rand_name() -> ~str {
1736 let mut rng = rand::rng();
1737 let n = ~"TEST" + rng.gen_str(10u);
1738 assert!(getenv(n).is_none());
1744 let n = make_rand_name();
1746 assert_eq!(getenv(n), option::Some(~"VALUE"));
1750 fn test_unsetenv() {
1751 let n = make_rand_name();
1754 assert_eq!(getenv(n), option::None);
1758 #[ignore(cfg(windows))]
1760 fn test_setenv_overwrite() {
1761 let n = make_rand_name();
1764 assert_eq!(getenv(n), option::Some(~"2"));
1766 assert_eq!(getenv(n), option::Some(~""));
1769 // Windows GetEnvironmentVariable requires some extra work to make sure
1770 // the buffer the variable is copied into is the right size
1772 #[ignore(cfg(windows))]
1774 fn test_getenv_big() {
1778 s = s + "aaaaaaaaaa";
1781 let n = make_rand_name();
1784 assert_eq!(getenv(n), option::Some(s));
1788 fn test_self_exe_path() {
1789 let path = os::self_exe_path();
1790 assert!(path.is_some());
1791 let path = path.get();
1792 debug!(path.clone());
1794 // Hard to test this function
1795 assert!(path.is_absolute);
1800 fn test_env_getenv() {
1802 assert!(e.len() > 0u);
1804 let (n, v) = (*p).clone();
1807 // MingW seems to set some funky environment variables like
1808 // "=C:=C:\MinGW\msys\1.0\bin" and "!::=::\" that are returned
1809 // from env() but not visible from getenv().
1810 assert!(v2.is_none() || v2 == option::Some(v));
1815 fn test_env_setenv() {
1816 let n = make_rand_name();
1820 assert!(!e.contains(&(n.clone(), ~"VALUE")));
1823 assert!(e.contains(&(n, ~"VALUE")));
1828 assert!((!Path("test-path").is_absolute));
1830 debug!("Current working directory: %s", getcwd().to_str());
1832 debug!(make_absolute(&Path("test-path")));
1833 debug!(make_absolute(&Path("/usr/bin")));
1839 let oldhome = getenv("HOME");
1841 setenv("HOME", "/home/MountainView");
1842 assert_eq!(os::homedir(), Some(Path("/home/MountainView")));
1845 assert!(os::homedir().is_none());
1847 for s in oldhome.iter() { setenv("HOME", *s) }
1854 let oldhome = getenv("HOME");
1855 let olduserprofile = getenv("USERPROFILE");
1858 setenv("USERPROFILE", "");
1860 assert!(os::homedir().is_none());
1862 setenv("HOME", "/home/MountainView");
1863 assert_eq!(os::homedir(), Some(Path("/home/MountainView")));
1867 setenv("USERPROFILE", "/home/MountainView");
1868 assert_eq!(os::homedir(), Some(Path("/home/MountainView")));
1870 setenv("HOME", "/home/MountainView");
1871 setenv("USERPROFILE", "/home/PaloAlto");
1872 assert_eq!(os::homedir(), Some(Path("/home/MountainView")));
1874 oldhome.iter().advance(|s| { setenv("HOME", *s); true });
1875 olduserprofile.iter().advance(|s| { setenv("USERPROFILE", *s); true });
1880 assert!(!os::tmpdir().to_str().is_empty());
1885 fn test_list_dir_no_invalid_memory_access() {
1886 os::list_dir(&Path("."));
1891 let dirs = os::list_dir(&Path("."));
1892 // Just assuming that we've got some contents in the current directory
1893 assert!(dirs.len() > 0u);
1895 for dir in dirs.iter() {
1896 debug!((*dir).clone());
1901 fn list_dir_empty_path() {
1902 let dirs = os::list_dir(&Path(""));
1903 assert!(dirs.is_empty());
1907 #[cfg(not(windows))]
1908 fn list_dir_root() {
1909 let dirs = os::list_dir(&Path("/"));
1910 assert!(dirs.len() > 1);
1914 fn list_dir_root() {
1915 let dirs = os::list_dir(&Path("C:\\"));
1916 assert!(dirs.len() > 1);
1922 assert!((os::path_is_dir(&Path("."))));
1923 assert!((!os::path_is_dir(&Path("test/stdtest/fs.rs"))));
1928 assert!((os::path_exists(&Path("."))));
1929 assert!((!os::path_exists(&Path(
1930 "test/nonexistent-bogus-path"))));
1934 fn copy_file_does_not_exist() {
1935 assert!(!os::copy_file(&Path("test/nonexistent-bogus-path"),
1936 &Path("test/other-bogus-path")));
1937 assert!(!os::path_exists(&Path("test/other-bogus-path")));
1943 let tempdir = getcwd(); // would like to use $TMPDIR,
1944 // doesn't seem to work on Linux
1945 assert!((tempdir.to_str().len() > 0u));
1946 let input = tempdir.push("in.txt");
1947 let out = tempdir.push("out.txt");
1949 /* Write the temp input file */
1950 let ostream = do input.to_c_str().with_ref |fromp| {
1951 do "w+b".to_c_str().with_ref |modebuf| {
1952 libc::fopen(fromp, modebuf)
1955 assert!((ostream as uint != 0u));
1957 do "hello".to_c_str().with_ref |buf| {
1958 let write_len = libc::fwrite(buf as *c_void,
1960 (s.len() + 1u) as size_t,
1962 assert_eq!(write_len, (s.len() + 1) as size_t)
1964 assert_eq!(libc::fclose(ostream), (0u as c_int));
1965 let in_mode = input.get_mode();
1966 let rs = os::copy_file(&input, &out);
1967 if (!os::path_exists(&input)) {
1968 fail!("%s doesn't exist", input.to_str());
1971 let rslt = run::process_status("diff", [input.to_str(), out.to_str()]);
1972 assert_eq!(rslt, 0);
1973 assert_eq!(out.get_mode(), in_mode);
1974 assert!((remove_file(&input)));
1975 assert!((remove_file(&out)));
1980 fn recursive_mkdir_slash() {
1981 let path = Path("/");
1982 assert!(os::mkdir_recursive(&path, (S_IRUSR | S_IWUSR | S_IXUSR) as i32));
1986 fn recursive_mkdir_empty() {
1987 let path = Path("");
1988 assert!(!os::mkdir_recursive(&path, (S_IRUSR | S_IWUSR | S_IXUSR) as i32));
1992 fn memory_map_rw() {
1993 use result::{Ok, Err};
1995 let chunk = match os::MemoryMap::new(16, ~[
2000 Err(msg) => fail!(msg.to_str())
2002 assert!(chunk.len >= 16);
2006 assert!(*chunk.data == 0xBE);
2011 fn memory_map_file() {
2012 use result::{Ok, Err};
2017 fn lseek_(fd: c_int, size: uint) {
2019 assert!(lseek(fd, size as off_t, SEEK_SET) == size as off_t);
2023 fn lseek_(fd: c_int, size: uint) {
2025 assert!(lseek(fd, size as c_long, SEEK_SET) == size as c_long);
2029 let path = tmpdir().push("mmap_file.tmp");
2030 let size = page_size() * 2;
2034 let fd = do path.to_c_str().with_ref |path| {
2035 open(path, O_CREAT | O_RDWR | O_TRUNC, S_IRUSR | S_IWUSR)
2038 do "x".to_c_str().with_ref |x| {
2039 assert!(write(fd, x as *c_void, 1) == 1);
2043 let chunk = match MemoryMap::new(size / 2, ~[
2050 Err(msg) => fail!(msg.to_str())
2052 assert!(chunk.len > 0);
2056 assert!(*chunk.data == 0xbe);
2061 // More recursive_mkdir tests are in extra::tempfile