]> git.lizzy.rs Git - rust.git/blob - library/std/src/sys/unix/os.rs
Merge commit '4236289b75ee55c78538c749512cdbeea5e1c332' into update-rustfmt
[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::path::{self, PathBuf};
17 use crate::ptr;
18 use crate::slice;
19 use crate::str;
20 use crate::sys::cvt;
21 use crate::sys::fd;
22 use crate::sys::memchr;
23 use crate::sys_common::rwlock::{StaticRWLock, StaticRWLockReadGuard};
24 use crate::vec;
25
26 #[cfg(all(target_env = "gnu", not(target_os = "vxworks")))]
27 use crate::sys::weak::weak;
28
29 use libc::{c_char, c_int, c_void};
30
31 const TMPBUF_SZ: usize = 128;
32
33 cfg_if::cfg_if! {
34     if #[cfg(target_os = "redox")] {
35         const PATH_SEPARATOR: u8 = b';';
36     } else {
37         const PATH_SEPARATOR: u8 = b':';
38     }
39 }
40
41 extern "C" {
42     #[cfg(not(any(target_os = "dragonfly", target_os = "vxworks")))]
43     #[cfg_attr(
44         any(
45             target_os = "linux",
46             target_os = "emscripten",
47             target_os = "fuchsia",
48             target_os = "l4re"
49         ),
50         link_name = "__errno_location"
51     )]
52     #[cfg_attr(
53         any(
54             target_os = "netbsd",
55             target_os = "openbsd",
56             target_os = "android",
57             target_os = "redox",
58             target_env = "newlib"
59         ),
60         link_name = "__errno"
61     )]
62     #[cfg_attr(any(target_os = "solaris", target_os = "illumos"), link_name = "___errno")]
63     #[cfg_attr(
64         any(target_os = "macos", target_os = "ios", target_os = "freebsd"),
65         link_name = "__error"
66     )]
67     #[cfg_attr(target_os = "haiku", link_name = "_errnop")]
68     fn errno_location() -> *mut c_int;
69 }
70
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 }
75 }
76
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 }
82 }
83
84 #[cfg(target_os = "vxworks")]
85 pub fn errno() -> i32 {
86     unsafe { libc::errnoGet() }
87 }
88
89 #[cfg(target_os = "dragonfly")]
90 pub fn errno() -> i32 {
91     extern "C" {
92         #[thread_local]
93         static errno: c_int;
94     }
95
96     unsafe { errno as i32 }
97 }
98
99 #[cfg(target_os = "dragonfly")]
100 pub fn set_errno(e: i32) {
101     extern "C" {
102         #[thread_local]
103         static mut errno: c_int;
104     }
105
106     unsafe {
107         errno = e;
108     }
109 }
110
111 /// Gets a detailed string description for the given error number.
112 pub fn error_string(errno: i32) -> String {
113     extern "C" {
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;
116     }
117
118     let mut buf = [0 as c_char; TMPBUF_SZ];
119
120     let p = buf.as_mut_ptr();
121     unsafe {
122         if strerror_r(errno as c_int, p, buf.len()) < 0 {
123             panic!("strerror_r failure");
124         }
125
126         let p = p as *const _;
127         str::from_utf8(CStr::from_ptr(p).to_bytes()).unwrap().to_owned()
128     }
129 }
130
131 pub fn getcwd() -> io::Result<PathBuf> {
132     let mut buf = Vec::with_capacity(512);
133     loop {
134         unsafe {
135             let ptr = buf.as_mut_ptr() as *mut libc::c_char;
136             if !libc::getcwd(ptr, buf.capacity()).is_null() {
137                 let len = CStr::from_ptr(buf.as_ptr() as *const libc::c_char).to_bytes().len();
138                 buf.set_len(len);
139                 buf.shrink_to_fit();
140                 return Ok(PathBuf::from(OsString::from_vec(buf)));
141             } else {
142                 let error = io::Error::last_os_error();
143                 if error.raw_os_error() != Some(libc::ERANGE) {
144                     return Err(error);
145                 }
146             }
147
148             // Trigger the internal buffer resizing logic of `Vec` by requiring
149             // more space than the current capacity.
150             let cap = buf.capacity();
151             buf.set_len(cap);
152             buf.reserve(1);
153         }
154     }
155 }
156
157 pub fn chdir(p: &path::Path) -> io::Result<()> {
158     let p: &OsStr = p.as_ref();
159     let p = CString::new(p.as_bytes())?;
160     if unsafe { libc::chdir(p.as_ptr()) } != 0 {
161         return Err(io::Error::last_os_error());
162     }
163     Ok(())
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::Uncategorized,
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::Uncategorized,
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(
327                 io::ErrorKind::Uncategorized,
328                 &"no current exe available",
329             ));
330         }
331         let argv0 = CStr::from_ptr(argv[0]).to_bytes();
332         if argv0[0] == b'.' || argv0.iter().any(|b| *b == b'/') {
333             crate::fs::canonicalize(OsStr::from_bytes(argv0))
334         } else {
335             Ok(PathBuf::from(OsStr::from_bytes(argv0)))
336         }
337     }
338 }
339
340 #[cfg(any(target_os = "linux", target_os = "android", target_os = "emscripten"))]
341 pub fn current_exe() -> io::Result<PathBuf> {
342     match crate::fs::read_link("/proc/self/exe") {
343         Err(ref e) if e.kind() == io::ErrorKind::NotFound => Err(io::Error::new_const(
344             io::ErrorKind::Uncategorized,
345             &"no /proc/self/exe available. Is /proc mounted?",
346         )),
347         other => other,
348     }
349 }
350
351 #[cfg(any(target_os = "macos", target_os = "ios"))]
352 pub fn current_exe() -> io::Result<PathBuf> {
353     extern "C" {
354         fn _NSGetExecutablePath(buf: *mut libc::c_char, bufsize: *mut u32) -> libc::c_int;
355     }
356     unsafe {
357         let mut sz: u32 = 0;
358         _NSGetExecutablePath(ptr::null_mut(), &mut sz);
359         if sz == 0 {
360             return Err(io::Error::last_os_error());
361         }
362         let mut v: Vec<u8> = Vec::with_capacity(sz as usize);
363         let err = _NSGetExecutablePath(v.as_mut_ptr() as *mut i8, &mut sz);
364         if err != 0 {
365             return Err(io::Error::last_os_error());
366         }
367         v.set_len(sz as usize - 1); // chop off trailing NUL
368         Ok(PathBuf::from(OsString::from_vec(v)))
369     }
370 }
371
372 #[cfg(any(target_os = "solaris", target_os = "illumos"))]
373 pub fn current_exe() -> io::Result<PathBuf> {
374     extern "C" {
375         fn getexecname() -> *const c_char;
376     }
377     unsafe {
378         let path = getexecname();
379         if path.is_null() {
380             Err(io::Error::last_os_error())
381         } else {
382             let filename = CStr::from_ptr(path).to_bytes();
383             let path = PathBuf::from(<OsStr as OsStrExt>::from_bytes(filename));
384
385             // Prepend a current working directory to the path if
386             // it doesn't contain an absolute pathname.
387             if filename[0] == b'/' { Ok(path) } else { getcwd().map(|cwd| cwd.join(path)) }
388         }
389     }
390 }
391
392 #[cfg(target_os = "haiku")]
393 pub fn current_exe() -> io::Result<PathBuf> {
394     // Use Haiku's image info functions
395     #[repr(C)]
396     struct image_info {
397         id: i32,
398         type_: i32,
399         sequence: i32,
400         init_order: i32,
401         init_routine: *mut libc::c_void, // function pointer
402         term_routine: *mut libc::c_void, // function pointer
403         device: libc::dev_t,
404         node: libc::ino_t,
405         name: [libc::c_char; 1024], // MAXPATHLEN
406         text: *mut libc::c_void,
407         data: *mut libc::c_void,
408         text_size: i32,
409         data_size: i32,
410         api_version: i32,
411         abi: i32,
412     }
413
414     unsafe {
415         extern "C" {
416             fn _get_next_image_info(
417                 team_id: i32,
418                 cookie: *mut i32,
419                 info: *mut image_info,
420                 size: i32,
421             ) -> i32;
422         }
423
424         let mut info: image_info = mem::zeroed();
425         let mut cookie: i32 = 0;
426         // the executable can be found at team id 0
427         let result =
428             _get_next_image_info(0, &mut cookie, &mut info, mem::size_of::<image_info>() as i32);
429         if result != 0 {
430             use crate::io::ErrorKind;
431             Err(io::Error::new_const(ErrorKind::Uncategorized, &"Error getting executable path"))
432         } else {
433             let name = CStr::from_ptr(info.name.as_ptr()).to_bytes();
434             Ok(PathBuf::from(OsStr::from_bytes(name)))
435         }
436     }
437 }
438
439 #[cfg(target_os = "redox")]
440 pub fn current_exe() -> io::Result<PathBuf> {
441     crate::fs::read_to_string("sys:exe").map(PathBuf::from)
442 }
443
444 #[cfg(any(target_os = "fuchsia", target_os = "l4re"))]
445 pub fn current_exe() -> io::Result<PathBuf> {
446     use crate::io::ErrorKind;
447     Err(io::Error::new_const(ErrorKind::Unsupported, &"Not yet implemented!"))
448 }
449
450 #[cfg(target_os = "vxworks")]
451 pub fn current_exe() -> io::Result<PathBuf> {
452     #[cfg(test)]
453     use realstd::env;
454
455     #[cfg(not(test))]
456     use crate::env;
457
458     let exe_path = env::args().next().unwrap();
459     let path = path::Path::new(&exe_path);
460     path.canonicalize()
461 }
462
463 pub struct Env {
464     iter: vec::IntoIter<(OsString, OsString)>,
465 }
466
467 impl !Send for Env {}
468 impl !Sync for Env {}
469
470 impl Iterator for Env {
471     type Item = (OsString, OsString);
472     fn next(&mut self) -> Option<(OsString, OsString)> {
473         self.iter.next()
474     }
475     fn size_hint(&self) -> (usize, Option<usize>) {
476         self.iter.size_hint()
477     }
478 }
479
480 #[cfg(target_os = "macos")]
481 pub unsafe fn environ() -> *mut *const *const c_char {
482     extern "C" {
483         fn _NSGetEnviron() -> *mut *const *const c_char;
484     }
485     _NSGetEnviron()
486 }
487
488 #[cfg(not(target_os = "macos"))]
489 pub unsafe fn environ() -> *mut *const *const c_char {
490     extern "C" {
491         static mut environ: *const *const c_char;
492     }
493     ptr::addr_of_mut!(environ)
494 }
495
496 static ENV_LOCK: StaticRWLock = StaticRWLock::new();
497
498 pub fn env_read_lock() -> StaticRWLockReadGuard {
499     ENV_LOCK.read()
500 }
501
502 /// Returns a vector of (variable, value) byte-vector pairs for all the
503 /// environment variables of the current process.
504 pub fn env() -> Env {
505     unsafe {
506         let _guard = env_read_lock();
507         let mut environ = *environ();
508         let mut result = Vec::new();
509         if !environ.is_null() {
510             while !(*environ).is_null() {
511                 if let Some(key_value) = parse(CStr::from_ptr(*environ).to_bytes()) {
512                     result.push(key_value);
513                 }
514                 environ = environ.add(1);
515             }
516         }
517         return Env { iter: result.into_iter() };
518     }
519
520     fn parse(input: &[u8]) -> Option<(OsString, OsString)> {
521         // Strategy (copied from glibc): Variable name and value are separated
522         // by an ASCII equals sign '='. Since a variable name must not be
523         // empty, allow variable names starting with an equals sign. Skip all
524         // malformed lines.
525         if input.is_empty() {
526             return None;
527         }
528         let pos = memchr::memchr(b'=', &input[1..]).map(|p| p + 1);
529         pos.map(|p| {
530             (
531                 OsStringExt::from_vec(input[..p].to_vec()),
532                 OsStringExt::from_vec(input[p + 1..].to_vec()),
533             )
534         })
535     }
536 }
537
538 pub fn getenv(k: &OsStr) -> io::Result<Option<OsString>> {
539     // environment variables with a nul byte can't be set, so their value is
540     // always None as well
541     let k = CString::new(k.as_bytes())?;
542     unsafe {
543         let _guard = env_read_lock();
544         let s = libc::getenv(k.as_ptr()) as *const libc::c_char;
545         let ret = if s.is_null() {
546             None
547         } else {
548             Some(OsStringExt::from_vec(CStr::from_ptr(s).to_bytes().to_vec()))
549         };
550         Ok(ret)
551     }
552 }
553
554 pub fn setenv(k: &OsStr, v: &OsStr) -> io::Result<()> {
555     let k = CString::new(k.as_bytes())?;
556     let v = CString::new(v.as_bytes())?;
557
558     unsafe {
559         let _guard = ENV_LOCK.write();
560         cvt(libc::setenv(k.as_ptr(), v.as_ptr(), 1)).map(drop)
561     }
562 }
563
564 pub fn unsetenv(n: &OsStr) -> io::Result<()> {
565     let nbuf = CString::new(n.as_bytes())?;
566
567     unsafe {
568         let _guard = ENV_LOCK.write();
569         cvt(libc::unsetenv(nbuf.as_ptr())).map(drop)
570     }
571 }
572
573 pub fn page_size() -> usize {
574     unsafe { libc::sysconf(libc::_SC_PAGESIZE) as usize }
575 }
576
577 pub fn temp_dir() -> PathBuf {
578     crate::env::var_os("TMPDIR").map(PathBuf::from).unwrap_or_else(|| {
579         if cfg!(target_os = "android") {
580             PathBuf::from("/data/local/tmp")
581         } else {
582             PathBuf::from("/tmp")
583         }
584     })
585 }
586
587 pub fn home_dir() -> Option<PathBuf> {
588     return crate::env::var_os("HOME").or_else(|| unsafe { fallback() }).map(PathBuf::from);
589
590     #[cfg(any(
591         target_os = "android",
592         target_os = "ios",
593         target_os = "emscripten",
594         target_os = "redox",
595         target_os = "vxworks"
596     ))]
597     unsafe fn fallback() -> Option<OsString> {
598         None
599     }
600     #[cfg(not(any(
601         target_os = "android",
602         target_os = "ios",
603         target_os = "emscripten",
604         target_os = "redox",
605         target_os = "vxworks"
606     )))]
607     unsafe fn fallback() -> Option<OsString> {
608         let amt = match libc::sysconf(libc::_SC_GETPW_R_SIZE_MAX) {
609             n if n < 0 => 512 as usize,
610             n => n as usize,
611         };
612         let mut buf = Vec::with_capacity(amt);
613         let mut passwd: libc::passwd = mem::zeroed();
614         let mut result = ptr::null_mut();
615         match libc::getpwuid_r(
616             libc::getuid(),
617             &mut passwd,
618             buf.as_mut_ptr(),
619             buf.capacity(),
620             &mut result,
621         ) {
622             0 if !result.is_null() => {
623                 let ptr = passwd.pw_dir as *const _;
624                 let bytes = CStr::from_ptr(ptr).to_bytes().to_vec();
625                 Some(OsStringExt::from_vec(bytes))
626             }
627             _ => None,
628         }
629     }
630 }
631
632 pub fn exit(code: i32) -> ! {
633     unsafe { libc::exit(code as c_int) }
634 }
635
636 pub fn getpid() -> u32 {
637     unsafe { libc::getpid() as u32 }
638 }
639
640 pub fn getppid() -> u32 {
641     unsafe { libc::getppid() as u32 }
642 }
643
644 #[cfg(all(target_env = "gnu", not(target_os = "vxworks")))]
645 pub fn glibc_version() -> Option<(usize, usize)> {
646     if let Some(Ok(version_str)) = glibc_version_cstr().map(CStr::to_str) {
647         parse_glibc_version(version_str)
648     } else {
649         None
650     }
651 }
652
653 #[cfg(all(target_env = "gnu", not(target_os = "vxworks")))]
654 fn glibc_version_cstr() -> Option<&'static CStr> {
655     weak! {
656         fn gnu_get_libc_version() -> *const libc::c_char
657     }
658     if let Some(f) = gnu_get_libc_version.get() {
659         unsafe { Some(CStr::from_ptr(f())) }
660     } else {
661         None
662     }
663 }
664
665 // Returns Some((major, minor)) if the string is a valid "x.y" version,
666 // ignoring any extra dot-separated parts. Otherwise return None.
667 #[cfg(all(target_env = "gnu", not(target_os = "vxworks")))]
668 fn parse_glibc_version(version: &str) -> Option<(usize, usize)> {
669     let mut parsed_ints = version.split('.').map(str::parse::<usize>).fuse();
670     match (parsed_ints.next(), parsed_ints.next()) {
671         (Some(Ok(major)), Some(Ok(minor))) => Some((major, minor)),
672         _ => None,
673     }
674 }