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 buf = [0 as libc::c_char, ..BUF_BYTES];
78 if(0 as *libc::c_char == libc::getcwd(
80 BUF_BYTES as libc::size_t)) {
83 Path(str::raw::from_c_str(&buf[0]))
87 // FIXME: move these to str perhaps? #2620
89 pub fn fill_charp_buf(f: &fn(*mut c_char, size_t) -> bool) -> Option<~str> {
90 let mut buf = [0 as c_char, .. TMPBUF_SZ];
91 do buf.as_mut_buf |b, sz| {
92 if f(b, sz as size_t) {
94 Some(str::raw::from_buf(b as *u8))
107 use option::{None, Option};
110 use libc::types::os::arch::extra::DWORD;
112 pub fn fill_utf16_buf_and_decode(f: &fn(*mut u16, DWORD) -> DWORD)
115 let mut n = TMPBUF_SZ as DWORD;
117 let mut done = false;
119 let mut k: DWORD = 0;
120 let mut buf = vec::from_elem(n as uint, 0u16);
121 do buf.as_mut_buf |b, _sz| {
122 k = f(b, TMPBUF_SZ as DWORD);
123 if k == (0 as DWORD) {
126 libc::GetLastError() ==
127 libc::ERROR_INSUFFICIENT_BUFFER as DWORD) {
134 let sub = buf.slice(0, k as uint);
135 res = option::Some(str::from_utf16(sub));
142 pub fn as_utf16_p<T>(s: &str, f: &fn(*u16) -> T) -> T {
143 let mut t = s.to_utf16();
144 // Null terminate before passing on.
146 t.as_imm_buf(|buf, _len| f(buf))
151 Accessing environment variables is not generally threadsafe.
152 Serialize access through a global lock.
154 fn with_env_lock<T>(f: &fn() -> T) -> T {
155 use unstable::finally::Finally;
159 rust_take_env_lock();
162 rust_drop_env_lock();
168 fn rust_take_env_lock();
170 fn rust_drop_env_lock();
174 /// Returns a vector of (variable, value) pairs for all the environment
175 /// variables of the current process.
176 pub fn env() -> ~[(~str,~str)] {
179 unsafe fn get_env_pairs() -> ~[~str] {
180 use libc::funcs::extra::kernel32::{
181 GetEnvironmentStringsA,
182 FreeEnvironmentStringsA
184 let ch = GetEnvironmentStringsA();
185 if (ch as uint == 0) {
186 fail!("os::env() failure getting env string from OS: %s", os::last_os_error());
188 let mut curr_ptr: uint = ch as uint;
189 let mut result = ~[];
190 while(*(curr_ptr as *libc::c_char) != 0 as libc::c_char) {
191 let env_pair = str::raw::from_c_str(
192 curr_ptr as *libc::c_char);
193 result.push(env_pair);
195 libc::strlen(curr_ptr as *libc::c_char) as uint
198 FreeEnvironmentStringsA(ch);
202 unsafe fn get_env_pairs() -> ~[~str] {
204 fn rust_env_pairs() -> **libc::c_char;
206 let environ = rust_env_pairs();
207 if (environ as uint == 0) {
208 fail!("os::env() failure getting env string from OS: %s", os::last_os_error());
210 let mut result = ~[];
211 ptr::array_each(environ, |e| {
212 let env_pair = str::raw::from_c_str(e);
213 debug!("get_env_pairs: %s",
215 result.push(env_pair);
220 fn env_convert(input: ~[~str]) -> ~[(~str, ~str)] {
222 for p in input.iter() {
223 let vs: ~[&str] = p.splitn_iter('=', 1).collect();
224 debug!("splitting: len: %u",
226 assert_eq!(vs.len(), 2);
227 pairs.push((vs[0].to_owned(), vs[1].to_owned()));
232 let unparsed_environ = get_env_pairs();
233 env_convert(unparsed_environ)
239 /// Fetches the environment variable `n` from the current process, returning
240 /// None if the variable isn't set.
241 pub fn getenv(n: &str) -> Option<~str> {
244 let s = n.as_c_str(|s| libc::getenv(s as *libc::c_char));
245 if ptr::null::<u8>() == cast::transmute(s) {
248 Some(str::raw::from_buf(cast::transmute(s)))
255 /// Fetches the environment variable `n` from the current process, returning
256 /// None if the variable isn't set.
257 pub fn getenv(n: &str) -> Option<~str> {
260 use os::win32::{as_utf16_p, fill_utf16_buf_and_decode};
261 do as_utf16_p(n) |u| {
262 do fill_utf16_buf_and_decode() |buf, sz| {
263 libc::GetEnvironmentVariableW(u, buf, sz)
272 /// Sets the environment variable `n` to the value `v` for the currently running
274 pub fn setenv(n: &str, v: &str) {
277 do n.to_str().as_c_str |nbuf| {
278 do v.to_str().as_c_str |vbuf| {
279 libc::funcs::posix01::unistd::setenv(nbuf, vbuf, 1);
288 /// Sets the environment variable `n` to the value `v` for the currently running
290 pub fn setenv(n: &str, v: &str) {
293 use os::win32::as_utf16_p;
294 do as_utf16_p(n) |nbuf| {
295 do as_utf16_p(v) |vbuf| {
296 libc::SetEnvironmentVariableW(nbuf, vbuf);
303 /// Remove a variable from the environment entirely
304 pub fn unsetenv(n: &str) {
306 fn _unsetenv(n: &str) {
309 do n.to_str().as_c_str |nbuf| {
310 libc::funcs::posix01::unistd::unsetenv(nbuf);
316 fn _unsetenv(n: &str) {
319 use os::win32::as_utf16_p;
320 do as_utf16_p(n) |nbuf| {
321 libc::SetEnvironmentVariableW(nbuf, ptr::null());
330 pub fn fdopen(fd: c_int) -> *FILE {
331 do "r".as_c_str |modebuf| {
333 libc::fdopen(fd, modebuf)
342 pub fn fsync_fd(fd: c_int, _level: io::fsync::Level) -> c_int {
344 use libc::funcs::extra::msvcrt::*;
349 #[cfg(target_os = "linux")]
350 #[cfg(target_os = "android")]
351 pub fn fsync_fd(fd: c_int, level: io::fsync::Level) -> c_int {
353 use libc::funcs::posix01::unistd::*;
356 | io::fsync::FullFSync => return fsync(fd),
357 io::fsync::FDataSync => return fdatasync(fd)
362 #[cfg(target_os = "macos")]
363 pub fn fsync_fd(fd: c_int, level: io::fsync::Level) -> c_int {
365 use libc::consts::os::extra::*;
366 use libc::funcs::posix88::fcntl::*;
367 use libc::funcs::posix01::unistd::*;
369 io::fsync::FSync => return fsync(fd),
371 // According to man fnctl, the ok retval is only specified to be
373 if (fcntl(F_FULLFSYNC as c_int, fd) == -1 as c_int)
374 { return -1 as c_int; }
376 { return 0 as c_int; }
382 #[cfg(target_os = "freebsd")]
383 pub fn fsync_fd(fd: c_int, _l: io::fsync::Level) -> c_int {
385 use libc::funcs::posix01::unistd::*;
396 pub fn pipe() -> Pipe {
398 let mut fds = Pipe {input: 0 as c_int,
400 assert_eq!(libc::pipe(&mut fds.input), (0 as c_int));
401 return Pipe {input: fds.input, out: fds.out};
408 pub fn pipe() -> Pipe {
410 // Windows pipes work subtly differently than unix pipes, and their
411 // inheritance has to be handled in a different way that I do not
412 // fully understand. Here we explicitly make the pipe non-inheritable,
413 // which means to pass it to a subprocess they need to be duplicated
414 // first, as in core::run.
415 let mut fds = Pipe {input: 0 as c_int,
417 let res = libc::pipe(&mut fds.input, 1024 as ::libc::c_uint,
418 (libc::O_BINARY | libc::O_NOINHERIT) as c_int);
419 assert_eq!(res, 0 as c_int);
420 assert!((fds.input != -1 as c_int && fds.input != 0 as c_int));
421 assert!((fds.out != -1 as c_int && fds.input != 0 as c_int));
422 return Pipe {input: fds.input, out: fds.out};
426 fn dup2(src: c_int, dst: c_int) -> c_int {
432 /// Returns the proper dll filename for the given basename of a file.
433 pub fn dll_filename(base: &str) -> ~str {
434 fmt!("%s%s%s", DLL_PREFIX, base, DLL_SUFFIX)
437 /// Optionally returns the filesystem path to the current executable which is
438 /// running. If any failure occurs, None is returned.
439 pub fn self_exe_path() -> Option<Path> {
441 #[cfg(target_os = "freebsd")]
442 fn load_self() -> Option<~str> {
444 use libc::funcs::bsd44::*;
445 use libc::consts::os::extra::*;
446 do fill_charp_buf() |buf, sz| {
447 let mib = ~[CTL_KERN as c_int,
449 KERN_PROC_PATHNAME as c_int, -1 as c_int];
451 sysctl(vec::raw::to_ptr(mib), mib.len() as ::libc::c_uint,
452 buf as *mut c_void, &mut sz, ptr::null(),
453 0u as size_t) == (0 as c_int)
458 #[cfg(target_os = "linux")]
459 #[cfg(target_os = "android")]
460 fn load_self() -> Option<~str> {
462 use libc::funcs::posix01::unistd::readlink;
464 let mut path_str = str::with_capacity(TMPBUF_SZ);
465 let len = do path_str.as_c_str |buf| {
466 let buf = buf as *mut c_char;
467 do "/proc/self/exe".as_c_str |proc_self_buf| {
468 readlink(proc_self_buf, buf, TMPBUF_SZ as size_t)
474 str::raw::set_len(&mut path_str, len as uint);
480 #[cfg(target_os = "macos")]
481 fn load_self() -> Option<~str> {
483 do fill_charp_buf() |buf, sz| {
484 let mut sz = sz as u32;
485 libc::funcs::extra::_NSGetExecutablePath(
486 buf, &mut sz) == (0 as c_int)
492 fn load_self() -> Option<~str> {
494 use os::win32::fill_utf16_buf_and_decode;
495 do fill_utf16_buf_and_decode() |buf, sz| {
496 libc::GetModuleFileNameW(0u as libc::DWORD, buf, sz)
501 load_self().map_move(|path| Path(path).dir_path())
506 * Returns the path to the user's home directory, if known.
508 * On Unix, returns the value of the 'HOME' environment variable if it is set
509 * and not equal to the empty string.
511 * On Windows, returns the value of the 'HOME' environment variable if it is
512 * set and not equal to the empty string. Otherwise, returns the value of the
513 * 'USERPROFILE' environment variable if it is set and not equal to the empty
516 * Otherwise, homedir returns option::none.
518 pub fn homedir() -> Option<Path> {
519 return match getenv("HOME") {
520 Some(ref p) => if !p.is_empty() {
529 fn secondary() -> Option<Path> {
534 fn secondary() -> Option<Path> {
535 do getenv("USERPROFILE").chain |p| {
546 * Returns the path to a temporary directory.
548 * On Unix, returns the value of the 'TMPDIR' environment variable if it is
549 * set and non-empty and '/tmp' otherwise.
551 * On Windows, returns the value of, in order, the 'TMP', 'TEMP',
552 * 'USERPROFILE' environment variable if any are set and not the empty
553 * string. Otherwise, tmpdir returns the path to the Windows directory.
555 pub fn tmpdir() -> Path {
558 fn getenv_nonempty(v: &str) -> Option<Path> {
571 fn lookup() -> Path {
572 getenv_nonempty("TMPDIR").unwrap_or_default(Path("/tmp"))
576 fn lookup() -> Path {
577 getenv_nonempty("TMP").or(
578 getenv_nonempty("TEMP").or(
579 getenv_nonempty("USERPROFILE").or(
580 getenv_nonempty("WINDIR")))).unwrap_or_default(Path("C:\\Windows"))
584 /// Recursively walk a directory structure
585 pub fn walk_dir(p: &Path, f: &fn(&Path) -> bool) -> bool {
587 r.iter().advance(|q| {
588 let path = &p.push(*q);
589 f(path) && (!path_is_dir(path) || walk_dir(path, |p| f(p)))
593 /// Indicates whether a path represents a directory
594 pub fn path_is_dir(p: &Path) -> bool {
596 do p.to_str().as_c_str |buf| {
597 rustrt::rust_path_is_dir(buf) != 0 as c_int
602 /// Indicates whether a path exists
603 pub fn path_exists(p: &Path) -> bool {
605 do p.to_str().as_c_str |buf| {
606 rustrt::rust_path_exists(buf) != 0 as c_int
612 * Convert a relative path to an absolute path
614 * If the given path is relative, return it prepended with the current working
615 * directory. If the given path is already an absolute path, return it
618 // NB: this is here rather than in path because it is a form of environment
619 // querying; what it does depends on the process working directory, not just
621 pub fn make_absolute(p: &Path) -> Path {
625 getcwd().push_many(p.components)
630 /// Creates a directory at the specified path
631 pub fn make_dir(p: &Path, mode: c_int) -> bool {
632 return mkdir(p, mode);
635 fn mkdir(p: &Path, _mode: c_int) -> bool {
637 use os::win32::as_utf16_p;
638 // FIXME: turn mode into something useful? #2623
639 do as_utf16_p(p.to_str()) |buf| {
640 libc::CreateDirectoryW(buf, cast::transmute(0))
647 fn mkdir(p: &Path, mode: c_int) -> bool {
648 do p.to_str().as_c_str |buf| {
650 libc::mkdir(buf, mode as libc::mode_t) == (0 as c_int)
656 /// Creates a directory with a given mode.
657 /// Returns true iff creation
658 /// succeeded. Also creates all intermediate subdirectories
659 /// if they don't already exist, giving all of them the same mode.
661 // tjc: if directory exists but with different permissions,
662 // should we return false?
663 pub fn mkdir_recursive(p: &Path, mode: c_int) -> bool {
667 else if p.components.is_empty() {
670 else if p.components.len() == 1 {
671 // No parent directories to create
672 path_is_dir(p) || make_dir(p, mode)
675 mkdir_recursive(&p.pop(), mode) && make_dir(p, mode)
679 /// Lists the contents of a directory
680 pub fn list_dir(p: &Path) -> ~[~str] {
681 if p.components.is_empty() && !p.is_absolute() {
682 // Not sure what the right behavior is here, but this
683 // prevents a bounds check failure later
687 #[cfg(target_os = "linux")]
688 #[cfg(target_os = "android")]
689 #[cfg(target_os = "freebsd")]
690 #[cfg(target_os = "macos")]
691 unsafe fn get_list(p: &Path) -> ~[~str] {
692 use libc::{dirent_t};
693 use libc::{opendir, readdir, closedir};
695 fn rust_list_dir_val(ptr: *dirent_t) -> *libc::c_char;
697 let input = p.to_str();
698 let mut strings = ~[];
699 let input_ptr = ::cast::transmute(&input[0]);
700 debug!("os::list_dir -- BEFORE OPENDIR");
701 let dir_ptr = opendir(input_ptr);
702 if (dir_ptr as uint != 0) {
703 debug!("os::list_dir -- opendir() SUCCESS");
704 let mut entry_ptr = readdir(dir_ptr);
705 while (entry_ptr as uint != 0) {
706 strings.push(str::raw::from_c_str(rust_list_dir_val(
708 entry_ptr = readdir(dir_ptr);
713 debug!("os::list_dir -- opendir() FAILURE");
716 "os::list_dir -- AFTER -- #: %?",
721 unsafe fn get_list(p: &Path) -> ~[~str] {
722 use libc::consts::os::extra::INVALID_HANDLE_VALUE;
723 use libc::{wcslen, free};
724 use libc::funcs::extra::kernel32::{
732 use rt::global_heap::malloc_raw;
736 fn rust_list_dir_wfd_size() -> libc::size_t;
737 fn rust_list_dir_wfd_fp_buf(wfd: *libc::c_void) -> *u16;
739 fn star(p: &Path) -> Path { p.push("*") }
740 do as_utf16_p(star(p).to_str()) |path_ptr| {
741 let mut strings = ~[];
742 let wfd_ptr = malloc_raw(rust_list_dir_wfd_size() as uint);
746 ::cast::transmute(wfd_ptr));
747 if find_handle as libc::c_int != INVALID_HANDLE_VALUE {
748 let mut more_files = 1 as libc::c_int;
749 while more_files != 0 {
750 let fp_buf = rust_list_dir_wfd_fp_buf(wfd_ptr);
751 if fp_buf as uint == 0 {
752 fail!("os::list_dir() failure: got null ptr from wfd");
755 let fp_vec = vec::from_buf(
756 fp_buf, wcslen(fp_buf) as uint);
757 let fp_str = str::from_utf16(fp_vec);
758 strings.push(fp_str);
760 more_files = FindNextFileW(
762 ::cast::transmute(wfd_ptr));
764 FindClose(find_handle);
770 do get_list(p).consume_iter().filter |filename| {
771 "." != *filename && ".." != *filename
777 * Lists the contents of a directory
779 * This version prepends each entry with the directory.
781 pub fn list_dir_path(p: &Path) -> ~[Path] {
782 list_dir(p).map(|f| p.push(*f))
785 /// Removes a directory at the specified path, after removing
786 /// all its contents. Use carefully!
787 pub fn remove_dir_recursive(p: &Path) -> bool {
788 let mut error_happened = false;
789 do walk_dir(p) |inner| {
791 if path_is_dir(inner) {
792 if !remove_dir_recursive(inner) {
793 error_happened = true;
797 if !remove_file(inner) {
798 error_happened = true;
804 // Directory should now be empty
805 !error_happened && remove_dir(p)
808 /// Removes a directory at the specified path
809 pub fn remove_dir(p: &Path) -> bool {
813 fn rmdir(p: &Path) -> bool {
815 use os::win32::as_utf16_p;
816 return do as_utf16_p(p.to_str()) |buf| {
817 libc::RemoveDirectoryW(buf) != (0 as libc::BOOL)
823 fn rmdir(p: &Path) -> bool {
824 do p.to_str().as_c_str |buf| {
826 libc::rmdir(buf) == (0 as c_int)
832 /// Changes the current working directory to the specified path, returning
833 /// whether the change was completed successfully or not.
834 pub fn change_dir(p: &Path) -> bool {
838 fn chdir(p: &Path) -> bool {
840 use os::win32::as_utf16_p;
841 return do as_utf16_p(p.to_str()) |buf| {
842 libc::SetCurrentDirectoryW(buf) != (0 as libc::BOOL)
848 fn chdir(p: &Path) -> bool {
849 do p.to_str().as_c_str |buf| {
851 libc::chdir(buf) == (0 as c_int)
857 /// Copies a file from one location to another
858 pub fn copy_file(from: &Path, to: &Path) -> bool {
859 return do_copy_file(from, to);
862 fn do_copy_file(from: &Path, to: &Path) -> bool {
864 use os::win32::as_utf16_p;
865 return do as_utf16_p(from.to_str()) |fromp| {
866 do as_utf16_p(to.to_str()) |top| {
867 libc::CopyFileW(fromp, top, (0 as libc::BOOL)) !=
875 fn do_copy_file(from: &Path, to: &Path) -> bool {
877 let istream = do from.to_str().as_c_str |fromp| {
878 do "rb".as_c_str |modebuf| {
879 libc::fopen(fromp, modebuf)
882 if istream as uint == 0u {
885 // Preserve permissions
886 let from_mode = from.get_mode().expect("copy_file: couldn't get permissions \
889 let ostream = do to.to_str().as_c_str |top| {
890 do "w+b".as_c_str |modebuf| {
891 libc::fopen(top, modebuf)
894 if ostream as uint == 0u {
899 let mut buf = vec::with_capacity::<u8>(bufsize);
900 let mut done = false;
903 do buf.as_mut_buf |b, _sz| {
904 let nread = libc::fread(b as *mut c_void, 1u as size_t,
907 if nread > 0 as size_t {
908 if libc::fwrite(b as *c_void, 1u as size_t, nread,
921 // Give the new file the old file's permissions
922 if do to.to_str().as_c_str |to_buf| {
923 libc::chmod(to_buf, from_mode as libc::mode_t)
925 return false; // should be a condition...
932 /// Deletes an existing file
933 pub fn remove_file(p: &Path) -> bool {
937 fn unlink(p: &Path) -> bool {
939 use os::win32::as_utf16_p;
940 return do as_utf16_p(p.to_str()) |buf| {
941 libc::DeleteFileW(buf) != (0 as libc::BOOL)
947 fn unlink(p: &Path) -> bool {
949 do p.to_str().as_c_str |buf| {
950 libc::unlink(buf) == (0 as c_int)
957 /// Returns the platform-specific value of errno
958 pub fn errno() -> int {
959 #[cfg(target_os = "macos")]
960 #[cfg(target_os = "freebsd")]
961 fn errno_location() -> *c_int {
964 fn __error() -> *c_int;
971 #[cfg(target_os = "linux")]
972 #[cfg(target_os = "android")]
973 fn errno_location() -> *c_int {
976 fn __errno_location() -> *c_int;
984 (*errno_location()) as int
989 /// Returns the platform-specific value of errno
990 pub fn errno() -> uint {
991 use libc::types::os::arch::extra::DWORD;
993 #[link_name = "kernel32"]
996 fn GetLastError() -> DWORD;
1000 GetLastError() as uint
1004 /// Get a string representing the platform-dependent last error
1005 pub fn last_os_error() -> ~str {
1007 fn strerror() -> ~str {
1008 #[cfg(target_os = "macos")]
1009 #[cfg(target_os = "android")]
1010 #[cfg(target_os = "freebsd")]
1011 fn strerror_r(errnum: c_int, buf: *mut c_char, buflen: size_t)
1015 fn strerror_r(errnum: c_int, buf: *mut c_char, buflen: size_t)
1019 strerror_r(errnum, buf, buflen)
1023 // GNU libc provides a non-compliant version of strerror_r by default
1024 // and requires macros to instead use the POSIX compliant variant.
1025 // So we just use __xpg_strerror_r which is always POSIX compliant
1026 #[cfg(target_os = "linux")]
1027 fn strerror_r(errnum: c_int, buf: *mut c_char, buflen: size_t) -> c_int {
1030 fn __xpg_strerror_r(errnum: c_int,
1036 __xpg_strerror_r(errnum, buf, buflen)
1040 let mut buf = [0 as c_char, ..TMPBUF_SZ];
1042 let err = strerror_r(errno() as c_int, &mut buf[0],
1043 TMPBUF_SZ as size_t);
1045 fail!("strerror_r failure");
1048 str::raw::from_c_str(&buf[0])
1053 fn strerror() -> ~str {
1054 use libc::types::os::arch::extra::DWORD;
1055 use libc::types::os::arch::extra::LPSTR;
1056 use libc::types::os::arch::extra::LPVOID;
1058 #[link_name = "kernel32"]
1061 fn FormatMessageA(flags: DWORD,
1071 static FORMAT_MESSAGE_FROM_SYSTEM: DWORD = 0x00001000;
1072 static FORMAT_MESSAGE_IGNORE_INSERTS: DWORD = 0x00000200;
1074 let mut buf = [0 as c_char, ..TMPBUF_SZ];
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 res = FormatMessageA(FORMAT_MESSAGE_FROM_SYSTEM |
1082 FORMAT_MESSAGE_IGNORE_INSERTS,
1083 ptr::mut_null(), err, langId,
1084 &mut buf[0], TMPBUF_SZ as DWORD,
1087 fail!("[%?] FormatMessage failure", errno());
1090 str::raw::from_c_str(&buf[0])
1098 * Sets the process exit code
1100 * Sets the exit code returned by the process if all supervised tasks
1101 * terminate successfully (without failing). If the current root task fails
1102 * and is supervised by the scheduler then any user-specified exit status is
1103 * ignored and the process exits with the default failure status
1105 pub fn set_exit_status(code: int) {
1107 use rt::OldTaskContext;
1109 if rt::context() == OldTaskContext {
1111 rustrt::rust_set_exit_status(code as libc::intptr_t);
1114 rt::util::set_exit_status(code);
1118 unsafe fn load_argc_and_argv(argc: c_int, argv: **c_char) -> ~[~str] {
1120 for i in range(0u, argc as uint) {
1121 args.push(str::raw::from_c_str(*argv.offset(i as int)));
1127 * Returns the command line arguments
1129 * Returns a list of the command line arguments.
1131 #[cfg(target_os = "macos")]
1132 pub fn real_args() -> ~[~str] {
1134 let (argc, argv) = (*_NSGetArgc() as c_int,
1135 *_NSGetArgv() as **c_char);
1136 load_argc_and_argv(argc, argv)
1140 #[cfg(target_os = "linux")]
1141 #[cfg(target_os = "android")]
1142 #[cfg(target_os = "freebsd")]
1143 pub fn real_args() -> ~[~str] {
1145 use rt::TaskContext;
1147 if rt::context() == TaskContext {
1148 match rt::args::clone() {
1150 None => fail!("process arguments not initialized")
1154 let argc = rustrt::rust_get_argc();
1155 let argv = rustrt::rust_get_argv();
1156 load_argc_and_argv(argc, argv)
1162 pub fn real_args() -> ~[~str] {
1163 let mut nArgs: c_int = 0;
1164 let lpArgCount: *mut c_int = &mut nArgs;
1165 let lpCmdLine = unsafe { GetCommandLineW() };
1166 let szArgList = unsafe { CommandLineToArgvW(lpCmdLine, lpArgCount) };
1169 for i in range(0u, nArgs as uint) {
1171 // Determine the length of this argument.
1172 let ptr = *szArgList.offset(i as int);
1174 while *ptr.offset(len as int) != 0 { len += 1; }
1176 // Push it onto the list.
1177 args.push(vec::raw::buf_as_slice(ptr, len,
1183 LocalFree(cast::transmute(szArgList));
1189 type LPCWSTR = *u16;
1192 #[link_name="kernel32"]
1195 fn GetCommandLineW() -> LPCWSTR;
1196 fn LocalFree(ptr: *c_void);
1200 #[link_name="shell32"]
1203 fn CommandLineToArgvW(lpCmdLine: LPCWSTR, pNumArgs: *mut c_int) -> **u16;
1206 struct OverriddenArgs {
1210 static overridden_arg_key: local_data::Key<@OverriddenArgs> = &local_data::Key;
1212 /// Returns the arguments which this program was started with (normally passed
1213 /// via the command line).
1215 /// The return value of the function can be changed by invoking the
1216 /// `os::set_args` function.
1217 pub fn args() -> ~[~str] {
1218 match local_data::get(overridden_arg_key, |k| k.map(|&k| *k)) {
1219 None => real_args(),
1220 Some(args) => args.val.clone()
1224 /// For the current task, overrides the task-local cache of the arguments this
1225 /// program had when it started. These new arguments are only available to the
1226 /// current task via the `os::args` method.
1227 pub fn set_args(new_args: ~[~str]) {
1228 let overridden_args = @OverriddenArgs {
1229 val: new_args.clone()
1231 local_data::set(overridden_arg_key, overridden_args);
1234 // FIXME #6100 we should really use an internal implementation of this - using
1235 // the POSIX glob functions isn't portable to windows, probably has slight
1236 // inconsistencies even where it is implemented, and makes extending
1237 // functionality a lot more difficult
1238 // FIXME #6101 also provide a non-allocating version - each_glob or so?
1239 /// Returns a vector of Path objects that match the given glob pattern
1240 #[cfg(target_os = "linux")]
1241 #[cfg(target_os = "android")]
1242 #[cfg(target_os = "freebsd")]
1243 #[cfg(target_os = "macos")]
1244 pub fn glob(pattern: &str) -> ~[Path] {
1245 #[cfg(target_os = "linux")]
1246 #[cfg(target_os = "android")]
1247 fn default_glob_t () -> libc::glob_t {
1250 gl_pathv: ptr::null(),
1252 __unused1: ptr::null(),
1253 __unused2: ptr::null(),
1254 __unused3: ptr::null(),
1255 __unused4: ptr::null(),
1256 __unused5: ptr::null(),
1260 #[cfg(target_os = "freebsd")]
1261 fn default_glob_t () -> libc::glob_t {
1267 gl_pathv: ptr::null(),
1268 __unused3: ptr::null(),
1269 __unused4: ptr::null(),
1270 __unused5: ptr::null(),
1271 __unused6: ptr::null(),
1272 __unused7: ptr::null(),
1273 __unused8: ptr::null(),
1277 #[cfg(target_os = "macos")]
1278 fn default_glob_t () -> libc::glob_t {
1284 gl_pathv: ptr::null(),
1285 __unused3: ptr::null(),
1286 __unused4: ptr::null(),
1287 __unused5: ptr::null(),
1288 __unused6: ptr::null(),
1289 __unused7: ptr::null(),
1290 __unused8: ptr::null(),
1294 let mut g = default_glob_t();
1295 do pattern.as_c_str |c_pattern| {
1296 unsafe { libc::glob(c_pattern, 0, ptr::null(), &mut g) }
1299 let paths = unsafe {
1300 vec::raw::from_buf_raw(g.gl_pathv, g.gl_pathc as uint)
1302 do paths.map |&c_str| {
1303 Path(unsafe { str::raw::from_c_str(c_str) })
1306 unsafe { libc::globfree(&mut g) };
1310 /// Returns a vector of Path objects that match the given glob pattern
1311 #[cfg(target_os = "win32")]
1312 pub fn glob(_pattern: &str) -> ~[Path] {
1313 fail!("glob() is unimplemented on Windows")
1316 #[cfg(target_os = "macos")]
1318 // These functions are in crt_externs.h.
1319 pub fn _NSGetArgc() -> *c_int;
1320 pub fn _NSGetArgv() -> ***c_char;
1323 // Round up `from` to be divisible by `to`
1324 fn round_up(from: uint, to: uint) -> uint {
1325 let r = if from % to == 0 {
1328 from + to - (from % to)
1338 pub fn page_size() -> uint {
1340 libc::sysconf(libc::_SC_PAGESIZE) as uint
1345 pub fn page_size() -> uint {
1347 let mut info = libc::SYSTEM_INFO::new();
1348 libc::GetSystemInfo(&mut info);
1350 return info.dwPageSize as uint;
1354 pub struct MemoryMap {
1360 pub enum MemoryMapKind {
1365 pub enum MapOption {
1375 // Linux-specific errors
1381 ErrUnknown(libc::c_int),
1383 // Windows-specific errors
1388 ErrVirtualAlloc(uint),
1389 ErrCreateFileMappingW(uint),
1390 ErrMapViewOfFile(uint)
1393 impl to_str::ToStr for MapError {
1394 fn to_str(&self) -> ~str {
1396 ErrFdNotAvail => ~"fd not available for reading or writing",
1397 ErrInvalidFd => ~"Invalid fd",
1398 ErrUnaligned => ~"Unaligned address, invalid flags, \
1399 negative length or unaligned offset",
1400 ErrNoMapSupport=> ~"File doesn't support mapping",
1401 ErrNoMem => ~"Invalid address, or not enough available memory",
1402 ErrUnknown(code) => fmt!("Unknown error=%?", code),
1403 ErrUnsupProt => ~"Protection mode unsupported",
1404 ErrUnsupOffset => ~"Offset in virtual memory mode is unsupported",
1405 ErrNeedRW => ~"File mapping should be at least readable/writable",
1406 ErrAlreadyExists => ~"File mapping for specified file already exists",
1407 ErrVirtualAlloc(code) => fmt!("VirtualAlloc failure=%?", code),
1408 ErrCreateFileMappingW(code) => fmt!("CreateFileMappingW failure=%?", code),
1409 ErrMapViewOfFile(code) => fmt!("MapViewOfFile failure=%?", code)
1416 pub fn new(min_len: uint, options: ~[MapOption]) -> Result<~MemoryMap, MapError> {
1419 let mut addr: *c_void = ptr::null();
1420 let mut prot: c_int = 0;
1421 let mut flags: c_int = libc::MAP_PRIVATE;
1422 let mut fd: c_int = -1;
1423 let mut offset: off_t = 0;
1424 let len = round_up(min_len, page_size()) as size_t;
1426 for &o in options.iter() {
1428 MapReadable => { prot |= libc::PROT_READ; },
1429 MapWritable => { prot |= libc::PROT_WRITE; },
1430 MapExecutable => { prot |= libc::PROT_EXEC; },
1432 flags |= libc::MAP_FIXED;
1436 flags |= libc::MAP_FILE;
1439 MapOffset(offset_) => { offset = offset_ as off_t; }
1442 if fd == -1 { flags |= libc::MAP_ANON; }
1445 libc::mmap(addr, len, prot, flags, fd, offset)
1447 if r == libc::MAP_FAILED {
1448 Err(match errno() as c_int {
1449 libc::EACCES => ErrFdNotAvail,
1450 libc::EBADF => ErrInvalidFd,
1451 libc::EINVAL => ErrUnaligned,
1452 libc::ENODEV => ErrNoMapSupport,
1453 libc::ENOMEM => ErrNoMem,
1454 code => ErrUnknown(code)
1463 MapFile(ptr::null())
1471 impl Drop for MemoryMap {
1474 match libc::munmap(self.data as *c_void, self.len) {
1476 -1 => error!(match errno() as c_int {
1477 libc::EINVAL => ~"invalid addr or len",
1478 e => fmt!("unknown errno=%?", e)
1480 r => error!(fmt!("Unexpected result %?", r))
1488 pub fn new(min_len: uint, options: ~[MapOption]) -> Result<~MemoryMap, MapError> {
1489 use libc::types::os::arch::extra::{LPVOID, DWORD, SIZE_T, HANDLE};
1491 let mut lpAddress: LPVOID = ptr::mut_null();
1492 let mut readable = false;
1493 let mut writable = false;
1494 let mut executable = false;
1495 let mut fd: c_int = -1;
1496 let mut offset: uint = 0;
1497 let len = round_up(min_len, page_size()) as SIZE_T;
1499 for &o in options.iter() {
1501 MapReadable => { readable = true; },
1502 MapWritable => { writable = true; },
1503 MapExecutable => { executable = true; }
1504 MapAddr(addr_) => { lpAddress = addr_ as LPVOID; },
1505 MapFd(fd_) => { fd = fd_; },
1506 MapOffset(offset_) => { offset = offset_; }
1510 let flProtect = match (executable, readable, writable) {
1511 (false, false, false) if fd == -1 => libc::PAGE_NOACCESS,
1512 (false, true, false) => libc::PAGE_READONLY,
1513 (false, true, true) => libc::PAGE_READWRITE,
1514 (true, false, false) if fd == -1 => libc::PAGE_EXECUTE,
1515 (true, true, false) => libc::PAGE_EXECUTE_READ,
1516 (true, true, true) => libc::PAGE_EXECUTE_READWRITE,
1517 _ => return Err(ErrUnsupProt)
1522 return Err(ErrUnsupOffset);
1525 libc::VirtualAlloc(lpAddress,
1527 libc::MEM_COMMIT | libc::MEM_RESERVE,
1531 0 => Err(ErrVirtualAlloc(errno())),
1532 _ => Ok(~MemoryMap {
1539 let dwDesiredAccess = match (readable, writable) {
1540 (true, true) => libc::FILE_MAP_ALL_ACCESS,
1541 (true, false) => libc::FILE_MAP_READ,
1542 (false, true) => libc::FILE_MAP_WRITE,
1544 return Err(ErrNeedRW);
1548 let hFile = libc::get_osfhandle(fd) as HANDLE;
1549 let mapping = libc::CreateFileMappingW(hFile,
1552 (len >> 32) as DWORD,
1553 (len & 0xffff_ffff) as DWORD,
1555 if mapping == ptr::mut_null() {
1556 return Err(ErrCreateFileMappingW(errno()));
1558 if errno() as c_int == libc::ERROR_ALREADY_EXISTS {
1559 return Err(ErrAlreadyExists);
1561 let r = libc::MapViewOfFile(mapping,
1563 (offset >> 32) as DWORD,
1564 (offset & 0xffff_ffff) as DWORD,
1567 0 => Err(ErrMapViewOfFile(errno())),
1568 _ => Ok(~MemoryMap {
1571 kind: MapFile(mapping as *c_void)
1580 impl Drop for MemoryMap {
1582 use libc::types::os::arch::extra::{LPCVOID, HANDLE};
1586 MapVirtual => match libc::VirtualFree(self.data as *mut c_void,
1588 libc::MEM_RELEASE) {
1589 0 => error!(fmt!("VirtualFree failed: %?", errno())),
1592 MapFile(mapping) => {
1593 if libc::UnmapViewOfFile(self.data as LPCVOID) != 0 {
1594 error!(fmt!("UnmapViewOfFile failed: %?", errno()));
1596 if libc::CloseHandle(mapping as HANDLE) != 0 {
1597 error!(fmt!("CloseHandle failed: %?", errno()));
1608 pub use os::consts::unix::*;
1611 pub use os::consts::windows::*;
1613 #[cfg(target_os = "macos")]
1614 pub use os::consts::macos::*;
1616 #[cfg(target_os = "freebsd")]
1617 pub use os::consts::freebsd::*;
1619 #[cfg(target_os = "linux")]
1620 pub use os::consts::linux::*;
1622 #[cfg(target_os = "android")]
1623 pub use os::consts::android::*;
1625 #[cfg(target_os = "win32")]
1626 pub use os::consts::win32::*;
1628 #[cfg(target_arch = "x86")]
1629 pub use os::consts::x86::*;
1631 #[cfg(target_arch = "x86_64")]
1632 pub use os::consts::x86_64::*;
1634 #[cfg(target_arch = "arm")]
1635 pub use os::consts::arm::*;
1637 #[cfg(target_arch = "mips")]
1638 use os::consts::mips::*;
1641 pub static FAMILY: &'static str = "unix";
1645 pub static FAMILY: &'static str = "windows";
1649 pub static SYSNAME: &'static str = "macos";
1650 pub static DLL_PREFIX: &'static str = "lib";
1651 pub static DLL_SUFFIX: &'static str = ".dylib";
1652 pub static EXE_SUFFIX: &'static str = "";
1656 pub static SYSNAME: &'static str = "freebsd";
1657 pub static DLL_PREFIX: &'static str = "lib";
1658 pub static DLL_SUFFIX: &'static str = ".so";
1659 pub static EXE_SUFFIX: &'static str = "";
1663 pub static SYSNAME: &'static str = "linux";
1664 pub static DLL_PREFIX: &'static str = "lib";
1665 pub static DLL_SUFFIX: &'static str = ".so";
1666 pub static EXE_SUFFIX: &'static str = "";
1670 pub static SYSNAME: &'static str = "android";
1671 pub static DLL_PREFIX: &'static str = "lib";
1672 pub static DLL_SUFFIX: &'static str = ".so";
1673 pub static EXE_SUFFIX: &'static str = "";
1677 pub static SYSNAME: &'static str = "win32";
1678 pub static DLL_PREFIX: &'static str = "";
1679 pub static DLL_SUFFIX: &'static str = ".dll";
1680 pub static EXE_SUFFIX: &'static str = ".exe";
1685 pub static ARCH: &'static str = "x86";
1688 pub static ARCH: &'static str = "x86_64";
1691 pub static ARCH: &'static str = "arm";
1694 pub static ARCH: &'static str = "mips";
1700 use libc::{c_int, c_void, size_t};
1704 use os::{env, getcwd, getenv, make_absolute, real_args};
1705 use os::{remove_file, setenv, unsetenv};
1712 use vec::CopyableVector;
1713 use libc::consts::os::posix88::{S_IRUSR, S_IWUSR, S_IXUSR};
1717 pub fn last_os_error() {
1718 debug!(os::last_os_error());
1722 pub fn test_args() {
1723 let a = real_args();
1724 assert!(a.len() >= 1);
1727 fn make_rand_name() -> ~str {
1728 let mut rng = rand::rng();
1729 let n = ~"TEST" + rng.gen_str(10u);
1730 assert!(getenv(n).is_none());
1736 let n = make_rand_name();
1738 assert_eq!(getenv(n), option::Some(~"VALUE"));
1742 fn test_unsetenv() {
1743 let n = make_rand_name();
1746 assert_eq!(getenv(n), option::None);
1750 #[ignore(cfg(windows))]
1752 fn test_setenv_overwrite() {
1753 let n = make_rand_name();
1756 assert_eq!(getenv(n), option::Some(~"2"));
1758 assert_eq!(getenv(n), option::Some(~""));
1761 // Windows GetEnvironmentVariable requires some extra work to make sure
1762 // the buffer the variable is copied into is the right size
1764 #[ignore(cfg(windows))]
1766 fn test_getenv_big() {
1770 s = s + "aaaaaaaaaa";
1773 let n = make_rand_name();
1776 assert_eq!(getenv(n), option::Some(s));
1780 fn test_self_exe_path() {
1781 let path = os::self_exe_path();
1782 assert!(path.is_some());
1783 let path = path.unwrap();
1784 debug!(path.clone());
1786 // Hard to test this function
1787 assert!(path.is_absolute);
1792 fn test_env_getenv() {
1794 assert!(e.len() > 0u);
1796 let (n, v) = (*p).clone();
1799 // MingW seems to set some funky environment variables like
1800 // "=C:=C:\MinGW\msys\1.0\bin" and "!::=::\" that are returned
1801 // from env() but not visible from getenv().
1802 assert!(v2.is_none() || v2 == option::Some(v));
1807 fn test_env_setenv() {
1808 let n = make_rand_name();
1812 assert!(!e.contains(&(n.clone(), ~"VALUE")));
1815 assert!(e.contains(&(n, ~"VALUE")));
1820 assert!((!Path("test-path").is_absolute));
1822 debug!("Current working directory: %s", getcwd().to_str());
1824 debug!(make_absolute(&Path("test-path")));
1825 debug!(make_absolute(&Path("/usr/bin")));
1831 let oldhome = getenv("HOME");
1833 setenv("HOME", "/home/MountainView");
1834 assert_eq!(os::homedir(), Some(Path("/home/MountainView")));
1837 assert!(os::homedir().is_none());
1839 for s in oldhome.iter() { setenv("HOME", *s) }
1846 let oldhome = getenv("HOME");
1847 let olduserprofile = getenv("USERPROFILE");
1850 setenv("USERPROFILE", "");
1852 assert!(os::homedir().is_none());
1854 setenv("HOME", "/home/MountainView");
1855 assert_eq!(os::homedir(), Some(Path("/home/MountainView")));
1859 setenv("USERPROFILE", "/home/MountainView");
1860 assert_eq!(os::homedir(), Some(Path("/home/MountainView")));
1862 setenv("HOME", "/home/MountainView");
1863 setenv("USERPROFILE", "/home/PaloAlto");
1864 assert_eq!(os::homedir(), Some(Path("/home/MountainView")));
1866 oldhome.iter().advance(|s| { setenv("HOME", *s); true });
1867 olduserprofile.iter().advance(|s| { setenv("USERPROFILE", *s); true });
1872 assert!(!os::tmpdir().to_str().is_empty());
1877 fn test_list_dir_no_invalid_memory_access() {
1878 os::list_dir(&Path("."));
1883 let dirs = os::list_dir(&Path("."));
1884 // Just assuming that we've got some contents in the current directory
1885 assert!(dirs.len() > 0u);
1887 for dir in dirs.iter() {
1888 debug!((*dir).clone());
1893 fn list_dir_empty_path() {
1894 let dirs = os::list_dir(&Path(""));
1895 assert!(dirs.is_empty());
1899 #[cfg(not(windows))]
1900 fn list_dir_root() {
1901 let dirs = os::list_dir(&Path("/"));
1902 assert!(dirs.len() > 1);
1906 fn list_dir_root() {
1907 let dirs = os::list_dir(&Path("C:\\"));
1908 assert!(dirs.len() > 1);
1914 assert!((os::path_is_dir(&Path("."))));
1915 assert!((!os::path_is_dir(&Path("test/stdtest/fs.rs"))));
1920 assert!((os::path_exists(&Path("."))));
1921 assert!((!os::path_exists(&Path(
1922 "test/nonexistent-bogus-path"))));
1926 fn copy_file_does_not_exist() {
1927 assert!(!os::copy_file(&Path("test/nonexistent-bogus-path"),
1928 &Path("test/other-bogus-path")));
1929 assert!(!os::path_exists(&Path("test/other-bogus-path")));
1935 let tempdir = getcwd(); // would like to use $TMPDIR,
1936 // doesn't seem to work on Linux
1937 assert!((tempdir.to_str().len() > 0u));
1938 let input = tempdir.push("in.txt");
1939 let out = tempdir.push("out.txt");
1941 /* Write the temp input file */
1942 let ostream = do input.to_str().as_c_str |fromp| {
1943 do "w+b".as_c_str |modebuf| {
1944 libc::fopen(fromp, modebuf)
1947 assert!((ostream as uint != 0u));
1949 let mut buf = s.as_bytes_with_null().to_owned();
1950 let len = buf.len();
1951 do buf.as_mut_buf |b, _len| {
1952 assert_eq!(libc::fwrite(b as *c_void, 1u as size_t,
1953 (s.len() + 1u) as size_t, ostream),
1956 assert_eq!(libc::fclose(ostream), (0u as c_int));
1957 let in_mode = input.get_mode();
1958 let rs = os::copy_file(&input, &out);
1959 if (!os::path_exists(&input)) {
1960 fail!("%s doesn't exist", input.to_str());
1963 let rslt = run::process_status("diff", [input.to_str(), out.to_str()]);
1964 assert_eq!(rslt, 0);
1965 assert_eq!(out.get_mode(), in_mode);
1966 assert!((remove_file(&input)));
1967 assert!((remove_file(&out)));
1972 fn recursive_mkdir_slash() {
1973 let path = Path("/");
1974 assert!(os::mkdir_recursive(&path, (S_IRUSR | S_IWUSR | S_IXUSR) as i32));
1978 fn recursive_mkdir_empty() {
1979 let path = Path("");
1980 assert!(!os::mkdir_recursive(&path, (S_IRUSR | S_IWUSR | S_IXUSR) as i32));
1984 fn memory_map_rw() {
1985 use result::{Ok, Err};
1987 let chunk = match os::MemoryMap::new(16, ~[
1992 Err(msg) => fail!(msg.to_str())
1994 assert!(chunk.len >= 16);
1998 assert!(*chunk.data == 0xBE);
2003 fn memory_map_file() {
2004 use result::{Ok, Err};
2009 fn lseek_(fd: c_int, size: uint) {
2011 assert!(lseek(fd, size as off_t, SEEK_SET) == size as off_t);
2015 fn lseek_(fd: c_int, size: uint) {
2017 assert!(lseek(fd, size as c_long, SEEK_SET) == size as c_long);
2021 let path = tmpdir().push("mmap_file.tmp");
2022 let size = page_size() * 2;
2026 let fd = do path.to_str().as_c_str |path| {
2027 open(path, O_CREAT | O_RDWR | O_TRUNC, S_IRUSR | S_IWUSR)
2030 do "x".as_c_str |x| {
2031 assert!(write(fd, x as *c_void, 1) == 1);
2035 let chunk = match MemoryMap::new(size / 2, ~[
2042 Err(msg) => fail!(msg.to_str())
2044 assert!(chunk.len > 0);
2048 assert!(*chunk.data == 0xbe);
2053 // More recursive_mkdir tests are in extra::tempfile