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};
16 use crate::path::{self, PathBuf};
22 use crate::sys::memchr;
23 use crate::sys_common::rwlock::{StaticRWLock, StaticRWLockReadGuard};
26 #[cfg(all(target_env = "gnu", not(target_os = "vxworks")))]
27 use crate::sys::weak::weak;
29 use libc::{c_char, c_int, c_void};
31 const TMPBUF_SZ: usize = 128;
34 if #[cfg(target_os = "redox")] {
35 const PATH_SEPARATOR: u8 = b';';
37 const PATH_SEPARATOR: u8 = b':';
42 #[cfg(not(any(target_os = "dragonfly", target_os = "vxworks")))]
46 target_os = "emscripten",
47 target_os = "fuchsia",
50 link_name = "__errno_location"
55 target_os = "openbsd",
56 target_os = "android",
62 #[cfg_attr(any(target_os = "solaris", target_os = "illumos"), link_name = "___errno")]
64 any(target_os = "macos", target_os = "ios", target_os = "freebsd"),
67 #[cfg_attr(target_os = "haiku", link_name = "_errnop")]
68 fn errno_location() -> *mut c_int;
71 /// Returns the platform-specific value of errno
72 #[cfg(not(any(target_os = "dragonfly", target_os = "vxworks")))]
73 pub fn errno() -> i32 {
74 unsafe { (*errno_location()) as i32 }
77 /// Sets the platform-specific value of errno
78 #[cfg(all(not(target_os = "linux"), not(target_os = "dragonfly"), not(target_os = "vxworks")))] // needed for readdir and syscall!
79 #[allow(dead_code)] // but not all target cfgs actually end up using it
80 pub fn set_errno(e: i32) {
81 unsafe { *errno_location() = e as c_int }
84 #[cfg(target_os = "vxworks")]
85 pub fn errno() -> i32 {
86 unsafe { libc::errnoGet() }
89 #[cfg(target_os = "dragonfly")]
90 pub fn errno() -> i32 {
96 unsafe { errno as i32 }
99 #[cfg(target_os = "dragonfly")]
100 pub fn set_errno(e: i32) {
103 static mut errno: c_int;
111 /// Gets a detailed string description for the given error number.
112 pub fn error_string(errno: i32) -> String {
114 #[cfg_attr(any(target_os = "linux", target_env = "newlib"), link_name = "__xpg_strerror_r")]
115 fn strerror_r(errnum: c_int, buf: *mut c_char, buflen: libc::size_t) -> c_int;
118 let mut buf = [0 as c_char; TMPBUF_SZ];
120 let p = buf.as_mut_ptr();
122 if strerror_r(errno as c_int, p, buf.len()) < 0 {
123 panic!("strerror_r failure");
126 let p = p as *const _;
127 str::from_utf8(CStr::from_ptr(p).to_bytes()).unwrap().to_owned()
131 #[cfg(target_os = "espidf")]
132 pub fn getcwd() -> io::Result<PathBuf> {
133 Ok(PathBuf::from("/"))
136 #[cfg(not(target_os = "espidf"))]
137 pub fn getcwd() -> io::Result<PathBuf> {
138 let mut buf = Vec::with_capacity(512);
141 let ptr = buf.as_mut_ptr() as *mut libc::c_char;
142 if !libc::getcwd(ptr, buf.capacity()).is_null() {
143 let len = CStr::from_ptr(buf.as_ptr() as *const libc::c_char).to_bytes().len();
146 return Ok(PathBuf::from(OsString::from_vec(buf)));
148 let error = io::Error::last_os_error();
149 if error.raw_os_error() != Some(libc::ERANGE) {
154 // Trigger the internal buffer resizing logic of `Vec` by requiring
155 // more space than the current capacity.
156 let cap = buf.capacity();
163 #[cfg(target_os = "espidf")]
164 pub fn chdir(p: &path::Path) -> io::Result<()> {
165 super::unsupported::unsupported()
168 #[cfg(not(target_os = "espidf"))]
169 pub fn chdir(p: &path::Path) -> io::Result<()> {
170 let p: &OsStr = p.as_ref();
171 let p = CString::new(p.as_bytes())?;
172 if unsafe { libc::chdir(p.as_ptr()) } != 0 {
173 return Err(io::Error::last_os_error());
178 pub struct SplitPaths<'a> {
179 iter: iter::Map<slice::Split<'a, u8, fn(&u8) -> bool>, fn(&'a [u8]) -> PathBuf>,
182 pub fn split_paths(unparsed: &OsStr) -> SplitPaths<'_> {
183 fn bytes_to_path(b: &[u8]) -> PathBuf {
184 PathBuf::from(<OsStr as OsStrExt>::from_bytes(b))
186 fn is_separator(b: &u8) -> bool {
189 let unparsed = unparsed.as_bytes();
192 .split(is_separator as fn(&u8) -> bool)
193 .map(bytes_to_path as fn(&[u8]) -> PathBuf),
197 impl<'a> Iterator for SplitPaths<'a> {
199 fn next(&mut self) -> Option<PathBuf> {
202 fn size_hint(&self) -> (usize, Option<usize>) {
203 self.iter.size_hint()
208 pub struct JoinPathsError;
210 pub fn join_paths<I, T>(paths: I) -> Result<OsString, JoinPathsError>
212 I: Iterator<Item = T>,
215 let mut joined = Vec::new();
217 for (i, path) in paths.enumerate() {
218 let path = path.as_ref().as_bytes();
220 joined.push(PATH_SEPARATOR)
222 if path.contains(&PATH_SEPARATOR) {
223 return Err(JoinPathsError);
225 joined.extend_from_slice(path);
227 Ok(OsStringExt::from_vec(joined))
230 impl fmt::Display for JoinPathsError {
231 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
232 write!(f, "path segment contains separator `{}`", char::from(PATH_SEPARATOR))
236 impl StdError for JoinPathsError {
238 fn description(&self) -> &str {
239 "failed to join paths"
243 #[cfg(any(target_os = "freebsd", target_os = "dragonfly"))]
244 pub fn current_exe() -> io::Result<PathBuf> {
247 libc::CTL_KERN as c_int,
248 libc::KERN_PROC as c_int,
249 libc::KERN_PROC_PATHNAME as c_int,
255 mib.len() as libc::c_uint,
262 return Err(io::Error::last_os_error());
264 let mut v: Vec<u8> = Vec::with_capacity(sz);
267 mib.len() as libc::c_uint,
268 v.as_mut_ptr() as *mut libc::c_void,
274 return Err(io::Error::last_os_error());
276 v.set_len(sz - 1); // chop off trailing NUL
277 Ok(PathBuf::from(OsString::from_vec(v)))
281 #[cfg(target_os = "netbsd")]
282 pub fn current_exe() -> io::Result<PathBuf> {
283 fn sysctl() -> io::Result<PathBuf> {
285 let mib = [libc::CTL_KERN, libc::KERN_PROC_ARGS, -1, libc::KERN_PROC_PATHNAME];
286 let mut path_len: usize = 0;
289 mib.len() as libc::c_uint,
296 return Err(io::Error::new_const(
297 io::ErrorKind::Uncategorized,
298 &"KERN_PROC_PATHNAME sysctl returned zero-length string",
301 let mut path: Vec<u8> = Vec::with_capacity(path_len);
304 mib.len() as libc::c_uint,
305 path.as_ptr() as *mut libc::c_void,
310 path.set_len(path_len - 1); // chop off NUL
311 Ok(PathBuf::from(OsString::from_vec(path)))
314 fn procfs() -> io::Result<PathBuf> {
315 let curproc_exe = path::Path::new("/proc/curproc/exe");
316 if curproc_exe.is_file() {
317 return crate::fs::read_link(curproc_exe);
319 Err(io::Error::new_const(
320 io::ErrorKind::Uncategorized,
321 &"/proc/curproc/exe doesn't point to regular file.",
324 sysctl().or_else(|_| procfs())
327 #[cfg(target_os = "openbsd")]
328 pub fn current_exe() -> io::Result<PathBuf> {
330 let mut mib = [libc::CTL_KERN, libc::KERN_PROC_ARGS, libc::getpid(), libc::KERN_PROC_ARGV];
331 let mib = mib.as_mut_ptr();
332 let mut argv_len = 0;
333 cvt(libc::sysctl(mib, 4, ptr::null_mut(), &mut argv_len, ptr::null_mut(), 0))?;
334 let mut argv = Vec::<*const libc::c_char>::with_capacity(argv_len as usize);
335 cvt(libc::sysctl(mib, 4, argv.as_mut_ptr() as *mut _, &mut argv_len, ptr::null_mut(), 0))?;
336 argv.set_len(argv_len as usize);
337 if argv[0].is_null() {
338 return Err(io::Error::new_const(
339 io::ErrorKind::Uncategorized,
340 &"no current exe available",
343 let argv0 = CStr::from_ptr(argv[0]).to_bytes();
344 if argv0[0] == b'.' || argv0.iter().any(|b| *b == b'/') {
345 crate::fs::canonicalize(OsStr::from_bytes(argv0))
347 Ok(PathBuf::from(OsStr::from_bytes(argv0)))
352 #[cfg(any(target_os = "linux", target_os = "android", target_os = "emscripten"))]
353 pub fn current_exe() -> io::Result<PathBuf> {
354 match crate::fs::read_link("/proc/self/exe") {
355 Err(ref e) if e.kind() == io::ErrorKind::NotFound => Err(io::Error::new_const(
356 io::ErrorKind::Uncategorized,
357 &"no /proc/self/exe available. Is /proc mounted?",
363 #[cfg(any(target_os = "macos", target_os = "ios"))]
364 pub fn current_exe() -> io::Result<PathBuf> {
367 libc::_NSGetExecutablePath(ptr::null_mut(), &mut sz);
369 return Err(io::Error::last_os_error());
371 let mut v: Vec<u8> = Vec::with_capacity(sz as usize);
372 let err = libc::_NSGetExecutablePath(v.as_mut_ptr() as *mut i8, &mut sz);
374 return Err(io::Error::last_os_error());
376 v.set_len(sz as usize - 1); // chop off trailing NUL
377 Ok(PathBuf::from(OsString::from_vec(v)))
381 #[cfg(any(target_os = "solaris", target_os = "illumos"))]
382 pub fn current_exe() -> io::Result<PathBuf> {
383 if let Ok(path) = crate::fs::read_link("/proc/self/path/a.out") {
387 fn getexecname() -> *const c_char;
390 let path = getexecname();
392 Err(io::Error::last_os_error())
394 let filename = CStr::from_ptr(path).to_bytes();
395 let path = PathBuf::from(<OsStr as OsStrExt>::from_bytes(filename));
397 // Prepend a current working directory to the path if
398 // it doesn't contain an absolute pathname.
399 if filename[0] == b'/' { Ok(path) } else { getcwd().map(|cwd| cwd.join(path)) }
405 #[cfg(target_os = "haiku")]
406 pub fn current_exe() -> io::Result<PathBuf> {
408 let mut info: mem::MaybeUninit<libc::image_info> = mem::MaybeUninit::uninit();
409 let mut cookie: i32 = 0;
410 // the executable can be found at team id 0
411 let result = libc::_get_next_image_info(
415 mem::size_of::<libc::image_info>(),
418 use crate::io::ErrorKind;
419 Err(io::Error::new_const(ErrorKind::Uncategorized, &"Error getting executable path"))
421 let name = CStr::from_ptr((*info.as_ptr()).name.as_ptr()).to_bytes();
422 Ok(PathBuf::from(OsStr::from_bytes(name)))
427 #[cfg(target_os = "redox")]
428 pub fn current_exe() -> io::Result<PathBuf> {
429 crate::fs::read_to_string("sys:exe").map(PathBuf::from)
432 #[cfg(any(target_os = "fuchsia", target_os = "l4re"))]
433 pub fn current_exe() -> io::Result<PathBuf> {
434 use crate::io::ErrorKind;
435 Err(io::Error::new_const(ErrorKind::Unsupported, &"Not yet implemented!"))
438 #[cfg(target_os = "vxworks")]
439 pub fn current_exe() -> io::Result<PathBuf> {
446 let exe_path = env::args().next().unwrap();
447 let path = path::Path::new(&exe_path);
451 #[cfg(target_os = "espidf")]
452 pub fn current_exe() -> io::Result<PathBuf> {
453 super::unsupported::unsupported()
457 iter: vec::IntoIter<(OsString, OsString)>,
460 impl !Send for Env {}
461 impl !Sync for Env {}
463 impl Iterator for Env {
464 type Item = (OsString, OsString);
465 fn next(&mut self) -> Option<(OsString, OsString)> {
468 fn size_hint(&self) -> (usize, Option<usize>) {
469 self.iter.size_hint()
473 #[cfg(target_os = "macos")]
474 pub unsafe fn environ() -> *mut *const *const c_char {
476 fn _NSGetEnviron() -> *mut *const *const c_char;
481 #[cfg(not(target_os = "macos"))]
482 pub unsafe fn environ() -> *mut *const *const c_char {
484 static mut environ: *const *const c_char;
486 ptr::addr_of_mut!(environ)
489 static ENV_LOCK: StaticRWLock = StaticRWLock::new();
491 pub fn env_read_lock() -> StaticRWLockReadGuard {
495 /// Returns a vector of (variable, value) byte-vector pairs for all the
496 /// environment variables of the current process.
497 pub fn env() -> Env {
499 let _guard = env_read_lock();
500 let mut environ = *environ();
501 let mut result = Vec::new();
502 if !environ.is_null() {
503 while !(*environ).is_null() {
504 if let Some(key_value) = parse(CStr::from_ptr(*environ).to_bytes()) {
505 result.push(key_value);
507 environ = environ.add(1);
510 return Env { iter: result.into_iter() };
513 fn parse(input: &[u8]) -> Option<(OsString, OsString)> {
514 // Strategy (copied from glibc): Variable name and value are separated
515 // by an ASCII equals sign '='. Since a variable name must not be
516 // empty, allow variable names starting with an equals sign. Skip all
518 if input.is_empty() {
521 let pos = memchr::memchr(b'=', &input[1..]).map(|p| p + 1);
524 OsStringExt::from_vec(input[..p].to_vec()),
525 OsStringExt::from_vec(input[p + 1..].to_vec()),
531 pub fn getenv(k: &OsStr) -> Option<OsString> {
532 // environment variables with a nul byte can't be set, so their value is
533 // always None as well
534 let k = CString::new(k.as_bytes()).ok()?;
536 let _guard = env_read_lock();
537 let s = libc::getenv(k.as_ptr()) as *const libc::c_char;
541 Some(OsStringExt::from_vec(CStr::from_ptr(s).to_bytes().to_vec()))
546 pub fn setenv(k: &OsStr, v: &OsStr) -> io::Result<()> {
547 let k = CString::new(k.as_bytes())?;
548 let v = CString::new(v.as_bytes())?;
551 let _guard = ENV_LOCK.write();
552 cvt(libc::setenv(k.as_ptr(), v.as_ptr(), 1)).map(drop)
556 pub fn unsetenv(n: &OsStr) -> io::Result<()> {
557 let nbuf = CString::new(n.as_bytes())?;
560 let _guard = ENV_LOCK.write();
561 cvt(libc::unsetenv(nbuf.as_ptr())).map(drop)
565 #[cfg(not(target_os = "espidf"))]
566 pub fn page_size() -> usize {
567 unsafe { libc::sysconf(libc::_SC_PAGESIZE) as usize }
570 pub fn temp_dir() -> PathBuf {
571 crate::env::var_os("TMPDIR").map(PathBuf::from).unwrap_or_else(|| {
572 if cfg!(target_os = "android") {
573 PathBuf::from("/data/local/tmp")
575 PathBuf::from("/tmp")
580 pub fn home_dir() -> Option<PathBuf> {
581 return crate::env::var_os("HOME").or_else(|| unsafe { fallback() }).map(PathBuf::from);
584 target_os = "android",
586 target_os = "emscripten",
588 target_os = "vxworks",
591 unsafe fn fallback() -> Option<OsString> {
595 target_os = "android",
597 target_os = "emscripten",
599 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)),