1 //! Implementation of `std::os` functionality for unix systems
3 #![allow(unused_imports)] // lots of cfg code here
5 #[cfg(all(test, target_env = "gnu"))]
8 use crate::os::unix::prelude::*;
10 use crate::error::Error as StdError;
11 use crate::ffi::{CStr, CString, OsStr, OsString};
17 use crate::path::{self, PathBuf};
23 use crate::sys::rwlock::{RWLockReadGuard, StaticRWLock};
24 use crate::sys_common::mutex::{StaticMutex, StaticMutexGuard};
27 use libc::{c_char, c_int, c_void};
29 const TMPBUF_SZ: usize = 128;
32 if #[cfg(target_os = "redox")] {
33 const PATH_SEPARATOR: u8 = b';';
35 const PATH_SEPARATOR: u8 = b':';
40 #[cfg(not(any(target_os = "dragonfly", target_os = "vxworks")))]
44 target_os = "emscripten",
45 target_os = "fuchsia",
48 link_name = "__errno_location"
53 target_os = "openbsd",
54 target_os = "android",
60 #[cfg_attr(any(target_os = "solaris", target_os = "illumos"), link_name = "___errno")]
62 any(target_os = "macos", target_os = "ios", target_os = "freebsd"),
65 #[cfg_attr(target_os = "haiku", link_name = "_errnop")]
66 fn errno_location() -> *mut c_int;
69 /// Returns the platform-specific value of errno
70 #[cfg(not(any(target_os = "dragonfly", target_os = "vxworks")))]
71 pub fn errno() -> i32 {
72 unsafe { (*errno_location()) as i32 }
75 /// Sets the platform-specific value of errno
76 #[cfg(all(not(target_os = "linux"), not(target_os = "dragonfly"), not(target_os = "vxworks")))] // needed for readdir and syscall!
77 #[allow(dead_code)] // but not all target cfgs actually end up using it
78 pub fn set_errno(e: i32) {
79 unsafe { *errno_location() = e as c_int }
82 #[cfg(target_os = "vxworks")]
83 pub fn errno() -> i32 {
84 unsafe { libc::errnoGet() }
87 #[cfg(target_os = "dragonfly")]
88 pub fn errno() -> i32 {
94 unsafe { errno as i32 }
97 #[cfg(target_os = "dragonfly")]
98 pub fn set_errno(e: i32) {
101 static mut errno: c_int;
109 /// Gets a detailed string description for the given error number.
110 pub fn error_string(errno: i32) -> String {
112 #[cfg_attr(any(target_os = "linux", target_env = "newlib"), link_name = "__xpg_strerror_r")]
113 fn strerror_r(errnum: c_int, buf: *mut c_char, buflen: libc::size_t) -> c_int;
116 let mut buf = [0 as c_char; TMPBUF_SZ];
118 let p = buf.as_mut_ptr();
120 if strerror_r(errno as c_int, p, buf.len()) < 0 {
121 panic!("strerror_r failure");
124 let p = p as *const _;
125 str::from_utf8(CStr::from_ptr(p).to_bytes()).unwrap().to_owned()
129 pub fn getcwd() -> io::Result<PathBuf> {
130 let mut buf = Vec::with_capacity(512);
133 let ptr = buf.as_mut_ptr() as *mut libc::c_char;
134 if !libc::getcwd(ptr, buf.capacity()).is_null() {
135 let len = CStr::from_ptr(buf.as_ptr() as *const libc::c_char).to_bytes().len();
138 return Ok(PathBuf::from(OsString::from_vec(buf)));
140 let error = io::Error::last_os_error();
141 if error.raw_os_error() != Some(libc::ERANGE) {
146 // Trigger the internal buffer resizing logic of `Vec` by requiring
147 // more space than the current capacity.
148 let cap = buf.capacity();
155 pub fn chdir(p: &path::Path) -> io::Result<()> {
156 let p: &OsStr = p.as_ref();
157 let p = CString::new(p.as_bytes())?;
158 if unsafe { libc::chdir(p.as_ptr()) } != 0 {
159 return Err(io::Error::last_os_error());
164 pub struct SplitPaths<'a> {
165 iter: iter::Map<slice::Split<'a, u8, fn(&u8) -> bool>, fn(&'a [u8]) -> PathBuf>,
168 pub fn split_paths(unparsed: &OsStr) -> SplitPaths<'_> {
169 fn bytes_to_path(b: &[u8]) -> PathBuf {
170 PathBuf::from(<OsStr as OsStrExt>::from_bytes(b))
172 fn is_separator(b: &u8) -> bool {
175 let unparsed = unparsed.as_bytes();
178 .split(is_separator as fn(&u8) -> bool)
179 .map(bytes_to_path as fn(&[u8]) -> PathBuf),
183 impl<'a> Iterator for SplitPaths<'a> {
185 fn next(&mut self) -> Option<PathBuf> {
188 fn size_hint(&self) -> (usize, Option<usize>) {
189 self.iter.size_hint()
194 pub struct JoinPathsError;
196 pub fn join_paths<I, T>(paths: I) -> Result<OsString, JoinPathsError>
198 I: Iterator<Item = T>,
201 let mut joined = Vec::new();
203 for (i, path) in paths.enumerate() {
204 let path = path.as_ref().as_bytes();
206 joined.push(PATH_SEPARATOR)
208 if path.contains(&PATH_SEPARATOR) {
209 return Err(JoinPathsError);
211 joined.extend_from_slice(path);
213 Ok(OsStringExt::from_vec(joined))
216 impl fmt::Display for JoinPathsError {
217 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
218 write!(f, "path segment contains separator `{}`", char::from(PATH_SEPARATOR))
222 impl StdError for JoinPathsError {
224 fn description(&self) -> &str {
225 "failed to join paths"
229 #[cfg(any(target_os = "freebsd", target_os = "dragonfly"))]
230 pub fn current_exe() -> io::Result<PathBuf> {
233 libc::CTL_KERN as c_int,
234 libc::KERN_PROC as c_int,
235 libc::KERN_PROC_PATHNAME as c_int,
241 mib.len() as libc::c_uint,
248 return Err(io::Error::last_os_error());
250 let mut v: Vec<u8> = Vec::with_capacity(sz);
253 mib.len() as libc::c_uint,
254 v.as_mut_ptr() as *mut libc::c_void,
260 return Err(io::Error::last_os_error());
262 v.set_len(sz - 1); // chop off trailing NUL
263 Ok(PathBuf::from(OsString::from_vec(v)))
267 #[cfg(target_os = "netbsd")]
268 pub fn current_exe() -> io::Result<PathBuf> {
269 fn sysctl() -> io::Result<PathBuf> {
271 let mib = [libc::CTL_KERN, libc::KERN_PROC_ARGS, -1, libc::KERN_PROC_PATHNAME];
272 let mut path_len: usize = 0;
275 mib.len() as libc::c_uint,
282 return Err(io::Error::new_const(
283 io::ErrorKind::Other,
284 &"KERN_PROC_PATHNAME sysctl returned zero-length string",
287 let mut path: Vec<u8> = Vec::with_capacity(path_len);
290 mib.len() as libc::c_uint,
291 path.as_ptr() as *mut libc::c_void,
296 path.set_len(path_len - 1); // chop off NUL
297 Ok(PathBuf::from(OsString::from_vec(path)))
300 fn procfs() -> io::Result<PathBuf> {
301 let curproc_exe = path::Path::new("/proc/curproc/exe");
302 if curproc_exe.is_file() {
303 return crate::fs::read_link(curproc_exe);
305 Err(io::Error::new_const(
306 io::ErrorKind::Other,
307 &"/proc/curproc/exe doesn't point to regular file.",
310 sysctl().or_else(|_| procfs())
313 #[cfg(target_os = "openbsd")]
314 pub fn current_exe() -> io::Result<PathBuf> {
316 let mut mib = [libc::CTL_KERN, libc::KERN_PROC_ARGS, libc::getpid(), libc::KERN_PROC_ARGV];
317 let mib = mib.as_mut_ptr();
318 let mut argv_len = 0;
319 cvt(libc::sysctl(mib, 4, ptr::null_mut(), &mut argv_len, ptr::null_mut(), 0))?;
320 let mut argv = Vec::<*const libc::c_char>::with_capacity(argv_len as usize);
321 cvt(libc::sysctl(mib, 4, argv.as_mut_ptr() as *mut _, &mut argv_len, ptr::null_mut(), 0))?;
322 argv.set_len(argv_len as usize);
323 if argv[0].is_null() {
324 return Err(io::Error::new_const(io::ErrorKind::Other, &"no current exe available"));
326 let argv0 = CStr::from_ptr(argv[0]).to_bytes();
327 if argv0[0] == b'.' || argv0.iter().any(|b| *b == b'/') {
328 crate::fs::canonicalize(OsStr::from_bytes(argv0))
330 Ok(PathBuf::from(OsStr::from_bytes(argv0)))
335 #[cfg(any(target_os = "linux", target_os = "android", target_os = "emscripten"))]
336 pub fn current_exe() -> io::Result<PathBuf> {
337 match crate::fs::read_link("/proc/self/exe") {
338 Err(ref e) if e.kind() == io::ErrorKind::NotFound => Err(io::Error::new_const(
339 io::ErrorKind::Other,
340 &"no /proc/self/exe available. Is /proc mounted?",
346 #[cfg(any(target_os = "macos", target_os = "ios"))]
347 pub fn current_exe() -> io::Result<PathBuf> {
349 fn _NSGetExecutablePath(buf: *mut libc::c_char, bufsize: *mut u32) -> libc::c_int;
353 _NSGetExecutablePath(ptr::null_mut(), &mut sz);
355 return Err(io::Error::last_os_error());
357 let mut v: Vec<u8> = Vec::with_capacity(sz as usize);
358 let err = _NSGetExecutablePath(v.as_mut_ptr() as *mut i8, &mut sz);
360 return Err(io::Error::last_os_error());
362 v.set_len(sz as usize - 1); // chop off trailing NUL
363 Ok(PathBuf::from(OsString::from_vec(v)))
367 #[cfg(any(target_os = "solaris", target_os = "illumos"))]
368 pub fn current_exe() -> io::Result<PathBuf> {
370 fn getexecname() -> *const c_char;
373 let path = getexecname();
375 Err(io::Error::last_os_error())
377 let filename = CStr::from_ptr(path).to_bytes();
378 let path = PathBuf::from(<OsStr as OsStrExt>::from_bytes(filename));
380 // Prepend a current working directory to the path if
381 // it doesn't contain an absolute pathname.
382 if filename[0] == b'/' { Ok(path) } else { getcwd().map(|cwd| cwd.join(path)) }
387 #[cfg(target_os = "haiku")]
388 pub fn current_exe() -> io::Result<PathBuf> {
389 // Use Haiku's image info functions
396 init_routine: *mut libc::c_void, // function pointer
397 term_routine: *mut libc::c_void, // function pointer
400 name: [libc::c_char; 1024], // MAXPATHLEN
401 text: *mut libc::c_void,
402 data: *mut libc::c_void,
411 fn _get_next_image_info(
414 info: *mut image_info,
419 let mut info: image_info = mem::zeroed();
420 let mut cookie: i32 = 0;
421 // the executable can be found at team id 0
423 _get_next_image_info(0, &mut cookie, &mut info, mem::size_of::<image_info>() as i32);
425 use crate::io::ErrorKind;
426 Err(io::Error::new_const(ErrorKind::Other, &"Error getting executable path"))
428 let name = CStr::from_ptr(info.name.as_ptr()).to_bytes();
429 Ok(PathBuf::from(OsStr::from_bytes(name)))
434 #[cfg(target_os = "redox")]
435 pub fn current_exe() -> io::Result<PathBuf> {
436 crate::fs::read_to_string("sys:exe").map(PathBuf::from)
439 #[cfg(any(target_os = "fuchsia", target_os = "l4re"))]
440 pub fn current_exe() -> io::Result<PathBuf> {
441 use crate::io::ErrorKind;
442 Err(io::Error::new_const(ErrorKind::Unsupported, &"Not yet implemented!"))
445 #[cfg(target_os = "vxworks")]
446 pub fn current_exe() -> io::Result<PathBuf> {
453 let exe_path = env::args().next().unwrap();
454 let path = path::Path::new(&exe_path);
459 iter: vec::IntoIter<(OsString, OsString)>,
462 impl !Send for Env {}
463 impl !Sync for Env {}
465 impl Iterator for Env {
466 type Item = (OsString, OsString);
467 fn next(&mut self) -> Option<(OsString, OsString)> {
470 fn size_hint(&self) -> (usize, Option<usize>) {
471 self.iter.size_hint()
475 #[cfg(target_os = "macos")]
476 pub unsafe fn environ() -> *mut *const *const c_char {
478 fn _NSGetEnviron() -> *mut *const *const c_char;
483 #[cfg(not(target_os = "macos"))]
484 pub unsafe fn environ() -> *mut *const *const c_char {
486 static mut environ: *const *const c_char;
488 ptr::addr_of_mut!(environ)
491 static ENV_LOCK: StaticRWLock = StaticRWLock::new();
493 pub fn env_read_lock() -> RWLockReadGuard {
494 ENV_LOCK.read_with_guard()
497 /// Returns a vector of (variable, value) byte-vector pairs for all the
498 /// environment variables of the current process.
499 pub fn env() -> Env {
501 let _guard = env_read_lock();
502 let mut environ = *environ();
503 let mut result = Vec::new();
504 if !environ.is_null() {
505 while !(*environ).is_null() {
506 if let Some(key_value) = parse(CStr::from_ptr(*environ).to_bytes()) {
507 result.push(key_value);
509 environ = environ.add(1);
512 return Env { iter: result.into_iter() };
515 fn parse(input: &[u8]) -> Option<(OsString, OsString)> {
516 // Strategy (copied from glibc): Variable name and value are separated
517 // by an ASCII equals sign '='. Since a variable name must not be
518 // empty, allow variable names starting with an equals sign. Skip all
520 if input.is_empty() {
523 let pos = memchr::memchr(b'=', &input[1..]).map(|p| p + 1);
526 OsStringExt::from_vec(input[..p].to_vec()),
527 OsStringExt::from_vec(input[p + 1..].to_vec()),
533 pub fn getenv(k: &OsStr) -> io::Result<Option<OsString>> {
534 // environment variables with a nul byte can't be set, so their value is
535 // always None as well
536 let k = CString::new(k.as_bytes())?;
538 let _guard = env_read_lock();
539 let s = libc::getenv(k.as_ptr()) as *const libc::c_char;
540 let ret = if s.is_null() {
543 Some(OsStringExt::from_vec(CStr::from_ptr(s).to_bytes().to_vec()))
549 pub fn setenv(k: &OsStr, v: &OsStr) -> io::Result<()> {
550 let k = CString::new(k.as_bytes())?;
551 let v = CString::new(v.as_bytes())?;
554 let _guard = ENV_LOCK.write_with_guard();
555 cvt(libc::setenv(k.as_ptr(), v.as_ptr(), 1)).map(drop)
559 pub fn unsetenv(n: &OsStr) -> io::Result<()> {
560 let nbuf = CString::new(n.as_bytes())?;
563 let _guard = ENV_LOCK.write_with_guard();
564 cvt(libc::unsetenv(nbuf.as_ptr())).map(drop)
568 pub fn page_size() -> usize {
569 unsafe { libc::sysconf(libc::_SC_PAGESIZE) as usize }
572 pub fn temp_dir() -> PathBuf {
573 crate::env::var_os("TMPDIR").map(PathBuf::from).unwrap_or_else(|| {
574 if cfg!(target_os = "android") {
575 PathBuf::from("/data/local/tmp")
577 PathBuf::from("/tmp")
582 pub fn home_dir() -> Option<PathBuf> {
583 return crate::env::var_os("HOME").or_else(|| unsafe { fallback() }).map(PathBuf::from);
586 target_os = "android",
588 target_os = "emscripten",
590 target_os = "vxworks"
592 unsafe fn fallback() -> Option<OsString> {
596 target_os = "android",
598 target_os = "emscripten",
600 target_os = "vxworks"
602 unsafe fn fallback() -> Option<OsString> {
603 let amt = match libc::sysconf(libc::_SC_GETPW_R_SIZE_MAX) {
604 n if n < 0 => 512 as usize,
607 let mut buf = Vec::with_capacity(amt);
608 let mut passwd: libc::passwd = mem::zeroed();
609 let mut result = ptr::null_mut();
610 match libc::getpwuid_r(
617 0 if !result.is_null() => {
618 let ptr = passwd.pw_dir as *const _;
619 let bytes = CStr::from_ptr(ptr).to_bytes().to_vec();
620 Some(OsStringExt::from_vec(bytes))
627 pub fn exit(code: i32) -> ! {
628 unsafe { libc::exit(code as c_int) }
631 pub fn getpid() -> u32 {
632 unsafe { libc::getpid() as u32 }
635 pub fn getppid() -> u32 {
636 unsafe { libc::getppid() as u32 }
639 #[cfg(all(target_env = "gnu", not(target_os = "vxworks")))]
640 pub fn glibc_version() -> Option<(usize, usize)> {
641 if let Some(Ok(version_str)) = glibc_version_cstr().map(CStr::to_str) {
642 parse_glibc_version(version_str)
648 #[cfg(all(target_env = "gnu", not(target_os = "vxworks")))]
649 fn glibc_version_cstr() -> Option<&'static CStr> {
651 fn gnu_get_libc_version() -> *const libc::c_char
653 if let Some(f) = gnu_get_libc_version.get() {
654 unsafe { Some(CStr::from_ptr(f())) }
660 // Returns Some((major, minor)) if the string is a valid "x.y" version,
661 // ignoring any extra dot-separated parts. Otherwise return None.
662 #[cfg(all(target_env = "gnu", not(target_os = "vxworks")))]
663 fn parse_glibc_version(version: &str) -> Option<(usize, usize)> {
664 let mut parsed_ints = version.split('.').map(str::parse::<usize>).fuse();
665 match (parsed_ints.next(), parsed_ints.next()) {
666 (Some(Ok(major)), Some(Ok(minor))) => Some((major, minor)),