]> git.lizzy.rs Git - rust.git/blob - library/std/src/sys/unix/os.rs
Auto merge of #84725 - sebpop:arm64-isb, r=joshtriplett
[rust.git] / library / std / src / sys / unix / os.rs
1 //! Implementation of `std::os` functionality for unix systems
2
3 #![allow(unused_imports)] // lots of cfg code here
4
5 #[cfg(all(test, target_env = "gnu"))]
6 mod tests;
7
8 use crate::os::unix::prelude::*;
9
10 use crate::error::Error as StdError;
11 use crate::ffi::{CStr, CString, OsStr, OsString};
12 use crate::fmt;
13 use crate::io;
14 use crate::iter;
15 use crate::mem;
16 use crate::memchr;
17 use crate::path::{self, PathBuf};
18 use crate::ptr;
19 use crate::slice;
20 use crate::str;
21 use crate::sys::cvt;
22 use crate::sys::fd;
23 use crate::sys::rwlock::{RWLockReadGuard, StaticRWLock};
24 use crate::sys_common::mutex::{StaticMutex, StaticMutexGuard};
25 use crate::vec;
26
27 use libc::{c_char, c_int, c_void};
28
29 const TMPBUF_SZ: usize = 128;
30
31 cfg_if::cfg_if! {
32     if #[cfg(target_os = "redox")] {
33         const PATH_SEPARATOR: u8 = b';';
34     } else {
35         const PATH_SEPARATOR: u8 = b':';
36     }
37 }
38
39 extern "C" {
40     #[cfg(not(any(target_os = "dragonfly", target_os = "vxworks")))]
41     #[cfg_attr(
42         any(
43             target_os = "linux",
44             target_os = "emscripten",
45             target_os = "fuchsia",
46             target_os = "l4re"
47         ),
48         link_name = "__errno_location"
49     )]
50     #[cfg_attr(
51         any(
52             target_os = "netbsd",
53             target_os = "openbsd",
54             target_os = "android",
55             target_os = "redox",
56             target_env = "newlib"
57         ),
58         link_name = "__errno"
59     )]
60     #[cfg_attr(any(target_os = "solaris", target_os = "illumos"), link_name = "___errno")]
61     #[cfg_attr(
62         any(target_os = "macos", target_os = "ios", target_os = "freebsd"),
63         link_name = "__error"
64     )]
65     #[cfg_attr(target_os = "haiku", link_name = "_errnop")]
66     fn errno_location() -> *mut c_int;
67 }
68
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 }
73 }
74
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 }
80 }
81
82 #[cfg(target_os = "vxworks")]
83 pub fn errno() -> i32 {
84     unsafe { libc::errnoGet() }
85 }
86
87 #[cfg(target_os = "dragonfly")]
88 pub fn errno() -> i32 {
89     extern "C" {
90         #[thread_local]
91         static errno: c_int;
92     }
93
94     unsafe { errno as i32 }
95 }
96
97 #[cfg(target_os = "dragonfly")]
98 pub fn set_errno(e: i32) {
99     extern "C" {
100         #[thread_local]
101         static mut errno: c_int;
102     }
103
104     unsafe {
105         errno = e;
106     }
107 }
108
109 /// Gets a detailed string description for the given error number.
110 pub fn error_string(errno: i32) -> String {
111     extern "C" {
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;
114     }
115
116     let mut buf = [0 as c_char; TMPBUF_SZ];
117
118     let p = buf.as_mut_ptr();
119     unsafe {
120         if strerror_r(errno as c_int, p, buf.len()) < 0 {
121             panic!("strerror_r failure");
122         }
123
124         let p = p as *const _;
125         str::from_utf8(CStr::from_ptr(p).to_bytes()).unwrap().to_owned()
126     }
127 }
128
129 pub fn getcwd() -> io::Result<PathBuf> {
130     let mut buf = Vec::with_capacity(512);
131     loop {
132         unsafe {
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();
136                 buf.set_len(len);
137                 buf.shrink_to_fit();
138                 return Ok(PathBuf::from(OsString::from_vec(buf)));
139             } else {
140                 let error = io::Error::last_os_error();
141                 if error.raw_os_error() != Some(libc::ERANGE) {
142                     return Err(error);
143                 }
144             }
145
146             // Trigger the internal buffer resizing logic of `Vec` by requiring
147             // more space than the current capacity.
148             let cap = buf.capacity();
149             buf.set_len(cap);
150             buf.reserve(1);
151         }
152     }
153 }
154
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     unsafe {
159         match libc::chdir(p.as_ptr()) == (0 as c_int) {
160             true => Ok(()),
161             false => Err(io::Error::last_os_error()),
162         }
163     }
164 }
165
166 pub struct SplitPaths<'a> {
167     iter: iter::Map<slice::Split<'a, u8, fn(&u8) -> bool>, fn(&'a [u8]) -> PathBuf>,
168 }
169
170 pub fn split_paths(unparsed: &OsStr) -> SplitPaths<'_> {
171     fn bytes_to_path(b: &[u8]) -> PathBuf {
172         PathBuf::from(<OsStr as OsStrExt>::from_bytes(b))
173     }
174     fn is_separator(b: &u8) -> bool {
175         *b == PATH_SEPARATOR
176     }
177     let unparsed = unparsed.as_bytes();
178     SplitPaths {
179         iter: unparsed
180             .split(is_separator as fn(&u8) -> bool)
181             .map(bytes_to_path as fn(&[u8]) -> PathBuf),
182     }
183 }
184
185 impl<'a> Iterator for SplitPaths<'a> {
186     type Item = PathBuf;
187     fn next(&mut self) -> Option<PathBuf> {
188         self.iter.next()
189     }
190     fn size_hint(&self) -> (usize, Option<usize>) {
191         self.iter.size_hint()
192     }
193 }
194
195 #[derive(Debug)]
196 pub struct JoinPathsError;
197
198 pub fn join_paths<I, T>(paths: I) -> Result<OsString, JoinPathsError>
199 where
200     I: Iterator<Item = T>,
201     T: AsRef<OsStr>,
202 {
203     let mut joined = Vec::new();
204
205     for (i, path) in paths.enumerate() {
206         let path = path.as_ref().as_bytes();
207         if i > 0 {
208             joined.push(PATH_SEPARATOR)
209         }
210         if path.contains(&PATH_SEPARATOR) {
211             return Err(JoinPathsError);
212         }
213         joined.extend_from_slice(path);
214     }
215     Ok(OsStringExt::from_vec(joined))
216 }
217
218 impl fmt::Display for JoinPathsError {
219     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
220         write!(f, "path segment contains separator `{}`", char::from(PATH_SEPARATOR))
221     }
222 }
223
224 impl StdError for JoinPathsError {
225     #[allow(deprecated)]
226     fn description(&self) -> &str {
227         "failed to join paths"
228     }
229 }
230
231 #[cfg(any(target_os = "freebsd", target_os = "dragonfly"))]
232 pub fn current_exe() -> io::Result<PathBuf> {
233     unsafe {
234         let mut mib = [
235             libc::CTL_KERN as c_int,
236             libc::KERN_PROC as c_int,
237             libc::KERN_PROC_PATHNAME as c_int,
238             -1 as c_int,
239         ];
240         let mut sz = 0;
241         cvt(libc::sysctl(
242             mib.as_mut_ptr(),
243             mib.len() as libc::c_uint,
244             ptr::null_mut(),
245             &mut sz,
246             ptr::null_mut(),
247             0,
248         ))?;
249         if sz == 0 {
250             return Err(io::Error::last_os_error());
251         }
252         let mut v: Vec<u8> = Vec::with_capacity(sz);
253         cvt(libc::sysctl(
254             mib.as_mut_ptr(),
255             mib.len() as libc::c_uint,
256             v.as_mut_ptr() as *mut libc::c_void,
257             &mut sz,
258             ptr::null_mut(),
259             0,
260         ))?;
261         if sz == 0 {
262             return Err(io::Error::last_os_error());
263         }
264         v.set_len(sz - 1); // chop off trailing NUL
265         Ok(PathBuf::from(OsString::from_vec(v)))
266     }
267 }
268
269 #[cfg(target_os = "netbsd")]
270 pub fn current_exe() -> io::Result<PathBuf> {
271     fn sysctl() -> io::Result<PathBuf> {
272         unsafe {
273             let mib = [libc::CTL_KERN, libc::KERN_PROC_ARGS, -1, libc::KERN_PROC_PATHNAME];
274             let mut path_len: usize = 0;
275             cvt(libc::sysctl(
276                 mib.as_ptr(),
277                 mib.len() as libc::c_uint,
278                 ptr::null_mut(),
279                 &mut path_len,
280                 ptr::null(),
281                 0,
282             ))?;
283             if path_len <= 1 {
284                 return Err(io::Error::new_const(
285                     io::ErrorKind::Other,
286                     &"KERN_PROC_PATHNAME sysctl returned zero-length string",
287                 ));
288             }
289             let mut path: Vec<u8> = Vec::with_capacity(path_len);
290             cvt(libc::sysctl(
291                 mib.as_ptr(),
292                 mib.len() as libc::c_uint,
293                 path.as_ptr() as *mut libc::c_void,
294                 &mut path_len,
295                 ptr::null(),
296                 0,
297             ))?;
298             path.set_len(path_len - 1); // chop off NUL
299             Ok(PathBuf::from(OsString::from_vec(path)))
300         }
301     }
302     fn procfs() -> io::Result<PathBuf> {
303         let curproc_exe = path::Path::new("/proc/curproc/exe");
304         if curproc_exe.is_file() {
305             return crate::fs::read_link(curproc_exe);
306         }
307         Err(io::Error::new_const(
308             io::ErrorKind::Other,
309             &"/proc/curproc/exe doesn't point to regular file.",
310         ))
311     }
312     sysctl().or_else(|_| procfs())
313 }
314
315 #[cfg(target_os = "openbsd")]
316 pub fn current_exe() -> io::Result<PathBuf> {
317     unsafe {
318         let mut mib = [libc::CTL_KERN, libc::KERN_PROC_ARGS, libc::getpid(), libc::KERN_PROC_ARGV];
319         let mib = mib.as_mut_ptr();
320         let mut argv_len = 0;
321         cvt(libc::sysctl(mib, 4, ptr::null_mut(), &mut argv_len, ptr::null_mut(), 0))?;
322         let mut argv = Vec::<*const libc::c_char>::with_capacity(argv_len as usize);
323         cvt(libc::sysctl(mib, 4, argv.as_mut_ptr() as *mut _, &mut argv_len, ptr::null_mut(), 0))?;
324         argv.set_len(argv_len as usize);
325         if argv[0].is_null() {
326             return Err(io::Error::new_const(io::ErrorKind::Other, &"no current exe available"));
327         }
328         let argv0 = CStr::from_ptr(argv[0]).to_bytes();
329         if argv0[0] == b'.' || argv0.iter().any(|b| *b == b'/') {
330             crate::fs::canonicalize(OsStr::from_bytes(argv0))
331         } else {
332             Ok(PathBuf::from(OsStr::from_bytes(argv0)))
333         }
334     }
335 }
336
337 #[cfg(any(target_os = "linux", target_os = "android", target_os = "emscripten"))]
338 pub fn current_exe() -> io::Result<PathBuf> {
339     match crate::fs::read_link("/proc/self/exe") {
340         Err(ref e) if e.kind() == io::ErrorKind::NotFound => Err(io::Error::new_const(
341             io::ErrorKind::Other,
342             &"no /proc/self/exe available. Is /proc mounted?",
343         )),
344         other => other,
345     }
346 }
347
348 #[cfg(any(target_os = "macos", target_os = "ios"))]
349 pub fn current_exe() -> io::Result<PathBuf> {
350     extern "C" {
351         fn _NSGetExecutablePath(buf: *mut libc::c_char, bufsize: *mut u32) -> libc::c_int;
352     }
353     unsafe {
354         let mut sz: u32 = 0;
355         _NSGetExecutablePath(ptr::null_mut(), &mut sz);
356         if sz == 0 {
357             return Err(io::Error::last_os_error());
358         }
359         let mut v: Vec<u8> = Vec::with_capacity(sz as usize);
360         let err = _NSGetExecutablePath(v.as_mut_ptr() as *mut i8, &mut sz);
361         if err != 0 {
362             return Err(io::Error::last_os_error());
363         }
364         v.set_len(sz as usize - 1); // chop off trailing NUL
365         Ok(PathBuf::from(OsString::from_vec(v)))
366     }
367 }
368
369 #[cfg(any(target_os = "solaris", target_os = "illumos"))]
370 pub fn current_exe() -> io::Result<PathBuf> {
371     extern "C" {
372         fn getexecname() -> *const c_char;
373     }
374     unsafe {
375         let path = getexecname();
376         if path.is_null() {
377             Err(io::Error::last_os_error())
378         } else {
379             let filename = CStr::from_ptr(path).to_bytes();
380             let path = PathBuf::from(<OsStr as OsStrExt>::from_bytes(filename));
381
382             // Prepend a current working directory to the path if
383             // it doesn't contain an absolute pathname.
384             if filename[0] == b'/' { Ok(path) } else { getcwd().map(|cwd| cwd.join(path)) }
385         }
386     }
387 }
388
389 #[cfg(target_os = "haiku")]
390 pub fn current_exe() -> io::Result<PathBuf> {
391     // Use Haiku's image info functions
392     #[repr(C)]
393     struct image_info {
394         id: i32,
395         type_: i32,
396         sequence: i32,
397         init_order: i32,
398         init_routine: *mut libc::c_void, // function pointer
399         term_routine: *mut libc::c_void, // function pointer
400         device: libc::dev_t,
401         node: libc::ino_t,
402         name: [libc::c_char; 1024], // MAXPATHLEN
403         text: *mut libc::c_void,
404         data: *mut libc::c_void,
405         text_size: i32,
406         data_size: i32,
407         api_version: i32,
408         abi: i32,
409     }
410
411     unsafe {
412         extern "C" {
413             fn _get_next_image_info(
414                 team_id: i32,
415                 cookie: *mut i32,
416                 info: *mut image_info,
417                 size: i32,
418             ) -> i32;
419         }
420
421         let mut info: image_info = mem::zeroed();
422         let mut cookie: i32 = 0;
423         // the executable can be found at team id 0
424         let result =
425             _get_next_image_info(0, &mut cookie, &mut info, mem::size_of::<image_info>() as i32);
426         if result != 0 {
427             use crate::io::ErrorKind;
428             Err(io::Error::new_const(ErrorKind::Other, &"Error getting executable path"))
429         } else {
430             let name = CStr::from_ptr(info.name.as_ptr()).to_bytes();
431             Ok(PathBuf::from(OsStr::from_bytes(name)))
432         }
433     }
434 }
435
436 #[cfg(target_os = "redox")]
437 pub fn current_exe() -> io::Result<PathBuf> {
438     crate::fs::read_to_string("sys:exe").map(PathBuf::from)
439 }
440
441 #[cfg(any(target_os = "fuchsia", target_os = "l4re"))]
442 pub fn current_exe() -> io::Result<PathBuf> {
443     use crate::io::ErrorKind;
444     Err(io::Error::new_const(ErrorKind::Unsupported, &"Not yet implemented!"))
445 }
446
447 #[cfg(target_os = "vxworks")]
448 pub fn current_exe() -> io::Result<PathBuf> {
449     #[cfg(test)]
450     use realstd::env;
451
452     #[cfg(not(test))]
453     use crate::env;
454
455     let exe_path = env::args().next().unwrap();
456     let path = path::Path::new(&exe_path);
457     path.canonicalize()
458 }
459
460 pub struct Env {
461     iter: vec::IntoIter<(OsString, OsString)>,
462 }
463
464 impl !Send for Env {}
465 impl !Sync for Env {}
466
467 impl Iterator for Env {
468     type Item = (OsString, OsString);
469     fn next(&mut self) -> Option<(OsString, OsString)> {
470         self.iter.next()
471     }
472     fn size_hint(&self) -> (usize, Option<usize>) {
473         self.iter.size_hint()
474     }
475 }
476
477 #[cfg(target_os = "macos")]
478 pub unsafe fn environ() -> *mut *const *const c_char {
479     extern "C" {
480         fn _NSGetEnviron() -> *mut *const *const c_char;
481     }
482     _NSGetEnviron()
483 }
484
485 #[cfg(not(target_os = "macos"))]
486 pub unsafe fn environ() -> *mut *const *const c_char {
487     extern "C" {
488         static mut environ: *const *const c_char;
489     }
490     ptr::addr_of_mut!(environ)
491 }
492
493 static ENV_LOCK: StaticRWLock = StaticRWLock::new();
494
495 pub fn env_read_lock() -> RWLockReadGuard {
496     ENV_LOCK.read_with_guard()
497 }
498
499 /// Returns a vector of (variable, value) byte-vector pairs for all the
500 /// environment variables of the current process.
501 pub fn env() -> Env {
502     unsafe {
503         let _guard = env_read_lock();
504         let mut environ = *environ();
505         let mut result = Vec::new();
506         if !environ.is_null() {
507             while !(*environ).is_null() {
508                 if let Some(key_value) = parse(CStr::from_ptr(*environ).to_bytes()) {
509                     result.push(key_value);
510                 }
511                 environ = environ.add(1);
512             }
513         }
514         return Env { iter: result.into_iter() };
515     }
516
517     fn parse(input: &[u8]) -> Option<(OsString, OsString)> {
518         // Strategy (copied from glibc): Variable name and value are separated
519         // by an ASCII equals sign '='. Since a variable name must not be
520         // empty, allow variable names starting with an equals sign. Skip all
521         // malformed lines.
522         if input.is_empty() {
523             return None;
524         }
525         let pos = memchr::memchr(b'=', &input[1..]).map(|p| p + 1);
526         pos.map(|p| {
527             (
528                 OsStringExt::from_vec(input[..p].to_vec()),
529                 OsStringExt::from_vec(input[p + 1..].to_vec()),
530             )
531         })
532     }
533 }
534
535 pub fn getenv(k: &OsStr) -> io::Result<Option<OsString>> {
536     // environment variables with a nul byte can't be set, so their value is
537     // always None as well
538     let k = CString::new(k.as_bytes())?;
539     unsafe {
540         let _guard = env_read_lock();
541         let s = libc::getenv(k.as_ptr()) as *const libc::c_char;
542         let ret = if s.is_null() {
543             None
544         } else {
545             Some(OsStringExt::from_vec(CStr::from_ptr(s).to_bytes().to_vec()))
546         };
547         Ok(ret)
548     }
549 }
550
551 pub fn setenv(k: &OsStr, v: &OsStr) -> io::Result<()> {
552     let k = CString::new(k.as_bytes())?;
553     let v = CString::new(v.as_bytes())?;
554
555     unsafe {
556         let _guard = ENV_LOCK.write_with_guard();
557         cvt(libc::setenv(k.as_ptr(), v.as_ptr(), 1)).map(drop)
558     }
559 }
560
561 pub fn unsetenv(n: &OsStr) -> io::Result<()> {
562     let nbuf = CString::new(n.as_bytes())?;
563
564     unsafe {
565         let _guard = ENV_LOCK.write_with_guard();
566         cvt(libc::unsetenv(nbuf.as_ptr())).map(drop)
567     }
568 }
569
570 pub fn page_size() -> usize {
571     unsafe { libc::sysconf(libc::_SC_PAGESIZE) as usize }
572 }
573
574 pub fn temp_dir() -> PathBuf {
575     crate::env::var_os("TMPDIR").map(PathBuf::from).unwrap_or_else(|| {
576         if cfg!(target_os = "android") {
577             PathBuf::from("/data/local/tmp")
578         } else {
579             PathBuf::from("/tmp")
580         }
581     })
582 }
583
584 pub fn home_dir() -> Option<PathBuf> {
585     return crate::env::var_os("HOME").or_else(|| unsafe { fallback() }).map(PathBuf::from);
586
587     #[cfg(any(
588         target_os = "android",
589         target_os = "ios",
590         target_os = "emscripten",
591         target_os = "redox",
592         target_os = "vxworks"
593     ))]
594     unsafe fn fallback() -> Option<OsString> {
595         None
596     }
597     #[cfg(not(any(
598         target_os = "android",
599         target_os = "ios",
600         target_os = "emscripten",
601         target_os = "redox",
602         target_os = "vxworks"
603     )))]
604     unsafe fn fallback() -> Option<OsString> {
605         let amt = match libc::sysconf(libc::_SC_GETPW_R_SIZE_MAX) {
606             n if n < 0 => 512 as usize,
607             n => n as usize,
608         };
609         let mut buf = Vec::with_capacity(amt);
610         let mut passwd: libc::passwd = mem::zeroed();
611         let mut result = ptr::null_mut();
612         match libc::getpwuid_r(
613             libc::getuid(),
614             &mut passwd,
615             buf.as_mut_ptr(),
616             buf.capacity(),
617             &mut result,
618         ) {
619             0 if !result.is_null() => {
620                 let ptr = passwd.pw_dir as *const _;
621                 let bytes = CStr::from_ptr(ptr).to_bytes().to_vec();
622                 Some(OsStringExt::from_vec(bytes))
623             }
624             _ => None,
625         }
626     }
627 }
628
629 pub fn exit(code: i32) -> ! {
630     unsafe { libc::exit(code as c_int) }
631 }
632
633 pub fn getpid() -> u32 {
634     unsafe { libc::getpid() as u32 }
635 }
636
637 pub fn getppid() -> u32 {
638     unsafe { libc::getppid() as u32 }
639 }
640
641 #[cfg(all(target_env = "gnu", not(target_os = "vxworks")))]
642 pub fn glibc_version() -> Option<(usize, usize)> {
643     if let Some(Ok(version_str)) = glibc_version_cstr().map(CStr::to_str) {
644         parse_glibc_version(version_str)
645     } else {
646         None
647     }
648 }
649
650 #[cfg(all(target_env = "gnu", not(target_os = "vxworks")))]
651 fn glibc_version_cstr() -> Option<&'static CStr> {
652     weak! {
653         fn gnu_get_libc_version() -> *const libc::c_char
654     }
655     if let Some(f) = gnu_get_libc_version.get() {
656         unsafe { Some(CStr::from_ptr(f())) }
657     } else {
658         None
659     }
660 }
661
662 // Returns Some((major, minor)) if the string is a valid "x.y" version,
663 // ignoring any extra dot-separated parts. Otherwise return None.
664 #[cfg(all(target_env = "gnu", not(target_os = "vxworks")))]
665 fn parse_glibc_version(version: &str) -> Option<(usize, usize)> {
666     let mut parsed_ints = version.split('.').map(str::parse::<usize>).fuse();
667     match (parsed_ints.next(), parsed_ints.next()) {
668         (Some(Ok(major)), Some(Ok(minor))) => Some((major, minor)),
669         _ => None,
670     }
671 }