      1
      2
      3
      4
      5
      6
      7
      8
      9
     10
     11
     12
     13
     14
     15
     16
     17
     18
     19
     20
     21
     22
     23
     24
     25
     26
     27
     28
     29
     30
     31
     32
     33
     34
     35
     36
     37
     38
     39
     40
     41
     42
     43
     44
     45
     46
     47
     48
     49
     50
     51
     52
     53
     54
     55
     56
     57
     58
     59
     60
     61
     62
     63
     64
     65
     66
     67
     68
     69
     70
     71
     72
     73
     74
     75
     76
     77
     78
     79
     80
     81
     82
     83
     84
     85
     86
     87
     88
     89
     90
     91
     92
     93
     94
     95
     96
     97
     98
     99
    100
    101
    102
    103
    104
    105
    106
    107
    108
    109
    110
    111
    112
    113
    114
    115
    116
    117
    118
    119
    120
    121
    122
    123
    124
    125
    126
    127
    128
    129
    130
    131
    132
    133
    134
    135
    136
    137
    138
    139
    140
    141
    142
    143
    144
    145
    146
    147
    148
    149
    150
    151
    152
    153
    154
    155
    156
    157
    158
    159
    160
    161
    162
    163
    164
    165
    166
    167
    168
    169
    170
    171
    172
    173
    174
    175
    176
    177
    178
    179
    180
    181
    182
    183
    184
    185
    186
    187
    188
    189
    190
    191
    192
    193
    194
    195
    196
    197
    198
    199
    200
    201
    202
    203
    204
    205
    206
    207
    208
    209
    210
    211
    212
    213
    214
    215
    216
    217
    218
    219
    220
    221
    222
    223
    224
    225
    226
    227
    228
    229
    230
    231
    232
    233
    234
    235
    236
    237
    238
    239
    240
    241
    242
    243
    244
    245
    246
    247
    248
    249
    250
    251
    252
    253
    254
    255
    256
    257
    258
    259
    260
    261
    262
    263
    264
    265
    266
    267
    268
    269
    270
    271
    272
    273
    274
    275
    276
    277
    278
    279
    280
    281
    282
    283
    284
    285
    286
    287
    288
    289
    290
    291
    292
    293
    294
    295
    296
    297
    298
    299
    300
    301
    302
    303
    304
    305
    306
    307
    308
    309
    310
    311
    312
    313
    314
    315
    316
    317
    318
    319
    320
    321
    322
    323
    324
    325
    326
    327
    328
    329
    330
    331
    332
    333
    334
    335
    336
    337
    338
    339
    340
    341
    342
    343
    344
    345
    346
    347
    348
    349
    350
    351
    352
    353
    354
    355
    356
    357
    358
    359
    360
    361
    362
    363
    364
    365
    366
    367
    368
    369
    370
    371
    372
    373
    374
    375
    376
    377
    378
    379
    380
    381
    382
    383
    384
    385
    386
    387
    388
    389
    390
    391
    392
    393
    394
    395
    396
    397
    398
    399
    400
    401
    402
    403
    404
    405
    406
    407
    408
    409
    410
    411
    412
    413
    414
    415
    416
    417
    418
    419
    420
    421
    422
    423
    424
    425
    426
    427
    428
    429
    430
    431
    432
    433
    434
    435
    436
    437
    438
    439
    440
    441
    442
    443
    444
    445
    446
    447
    448
    449
    450
    451
    452
    453
    454
    455
    456
    457
    458
    459
    460
    461
    462
    463
    464
    465
    466
    467
    468
    469
    470
    471
    472
    473
    474
    475
    476
    477
    478
    479
    480
    481
    482
    483
    484
    485
    486
    487
    488
    489
    490
    491
    492
    493
    494
    495
    496
    497
    498
    499
    500
    501
    502
    503
    504
    505
    506
    507
    508
    509
    510
    511
    512

    // Copyright 2015 The Rust Project Developers. See the COPYRIGHT
    // file at the top-level directory of this distribution and at
    // http://rust-lang.org/COPYRIGHT.
    //
    // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
    // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
    // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
    // option. This file may not be copied, modified, or distributed
    // except according to those terms.

    //! Implementation of `std::os` functionality for unix systems

    #![allow(unused_imports)] // lots of cfg code here

    use os::unix::prelude::*;

    use error::Error as StdError;
    use ffi::{CString, CStr, OsString, OsStr};
    use fmt;
    use io;
    use iter;
    use libc::{self, c_int, c_char, c_void};
    use marker::PhantomData;
    use mem;
    use memchr;
    use path::{self, PathBuf};
    use ptr;
    use slice;
    use str;
    use sys_common::mutex::Mutex;
    use sys::cvt;
    use sys::fd;
    use vec;

    const TMPBUF_SZ: usize = 128;
    static ENV_LOCK: Mutex = Mutex::new();

    extern {
        #[cfg(not(target_os = "dragonfly"))]
        #[cfg_attr(any(target_os = "linux", target_os = "emscripten", target_os = "fuchsia"),
                   link_name = "__errno_location")]
        #[cfg_attr(any(target_os = "bitrig",
                       target_os = "netbsd",
                       target_os = "openbsd",
                       target_os = "android",
                       target_env = "newlib"),
                   link_name = "__errno")]
        #[cfg_attr(target_os = "solaris", link_name = "___errno")]
        #[cfg_attr(any(target_os = "macos",
                       target_os = "ios",
                       target_os = "freebsd"),
                   link_name = "__error")]
        #[cfg_attr(target_os = "haiku", link_name = "_errnop")]
        fn errno_location() -> *mut c_int;
    }

    /// Returns the platform-specific value of errno
    #[cfg(not(target_os = "dragonfly"))]
    pub fn errno() -> i32 {
        unsafe {
            (*errno_location()) as i32
        }
    }

    /// Sets the platform-specific value of errno
    #[cfg(any(target_os = "solaris", target_os = "fuchsia"))] // only needed for readdir so far
    pub fn set_errno(e: i32) {
        unsafe {
            *errno_location() = e as c_int
        }
    }

    #[cfg(target_os = "dragonfly")]
    pub fn errno() -> i32 {
        extern {
            #[thread_local]
            static errno: c_int;
        }

        unsafe { errno as i32 }
    }

    /// Gets a detailed string description for the given error number.
    pub fn error_string(errno: i32) -> String {
        extern {
            #[cfg_attr(any(target_os = "linux", target_env = "newlib"),
                       link_name = "__xpg_strerror_r")]
            fn strerror_r(errnum: c_int, buf: *mut c_char,
                          buflen: libc::size_t) -> c_int;
        }

        let mut buf = [0 as c_char; TMPBUF_SZ];

        let p = buf.as_mut_ptr();
        unsafe {
            if strerror_r(errno as c_int, p, buf.len()) < 0 {
                panic!("strerror_r failure");
            }

            let p = p as *const _;
            str::from_utf8(CStr::from_ptr(p).to_bytes()).unwrap().to_owned()
        }
    }

    pub fn getcwd() -> io::Result<PathBuf> {
        let mut buf = Vec::with_capacity(512);
        loop {
            unsafe {
                let ptr = buf.as_mut_ptr() as *mut libc::c_char;
                if !libc::getcwd(ptr, buf.capacity()).is_null() {
                    let len = CStr::from_ptr(buf.as_ptr() as *const libc::c_char).to_bytes().len();
                    buf.set_len(len);
                    buf.shrink_to_fit();
                    return Ok(PathBuf::from(OsString::from_vec(buf)));
                } else {
                    let error = io::Error::last_os_error();
                    if error.raw_os_error() != Some(libc::ERANGE) {
                        return Err(error);
                    }
                }

                // Trigger the internal buffer resizing logic of `Vec` by requiring
                // more space than the current capacity.
                let cap = buf.capacity();
                buf.set_len(cap);
                buf.reserve(1);
            }
        }
    }

    pub fn chdir(p: &path::Path) -> io::Result<()> {
        let p: &OsStr = p.as_ref();
        let p = CString::new(p.as_bytes())?;
        unsafe {
            match libc::chdir(p.as_ptr()) == (0 as c_int) {
                true => Ok(()),
                false => Err(io::Error::last_os_error()),
            }
        }
    }

    pub struct SplitPaths<'a> {
        iter: iter::Map<slice::Split<'a, u8, fn(&u8) -> bool>,
                        fn(&'a [u8]) -> PathBuf>,
    }

    pub fn split_paths(unparsed: &OsStr) -> SplitPaths {
        fn bytes_to_path(b: &[u8]) -> PathBuf {
            PathBuf::from(<OsStr as OsStrExt>::from_bytes(b))
        }
        fn is_colon(b: &u8) -> bool { *b == b':' }
        let unparsed = unparsed.as_bytes();
        SplitPaths {
            iter: unparsed.split(is_colon as fn(&u8) -> bool)
                          .map(bytes_to_path as fn(&[u8]) -> PathBuf)
        }
    }

    impl<'a> Iterator for SplitPaths<'a> {
        type Item = PathBuf;
        fn next(&mut self) -> Option<PathBuf> { self.iter.next() }
        fn size_hint(&self) -> (usize, Option<usize>) { self.iter.size_hint() }
    }

    #[derive(Debug)]
    pub struct JoinPathsError;

    pub fn join_paths<I, T>(paths: I) -> Result<OsString, JoinPathsError>
        where I: Iterator<Item=T>, T: AsRef<OsStr>
    {
        let mut joined = Vec::new();
        let sep = b':';

        for (i, path) in paths.enumerate() {
            let path = path.as_ref().as_bytes();
            if i > 0 { joined.push(sep) }
            if path.contains(&sep) {
                return Err(JoinPathsError)
            }
            joined.extend_from_slice(path);
        }
        Ok(OsStringExt::from_vec(joined))
    }

    impl fmt::Display for JoinPathsError {
        fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
            "path segment contains separator `:`".fmt(f)
        }
    }

    impl StdError for JoinPathsError {
        fn description(&self) -> &str { "failed to join paths" }
    }

    #[cfg(any(target_os = "freebsd", target_os = "dragonfly"))]
    pub fn current_exe() -> io::Result<PathBuf> {
        unsafe {
            let mut mib = [libc::CTL_KERN as c_int,
                           libc::KERN_PROC as c_int,
                           libc::KERN_PROC_PATHNAME as c_int,
                           -1 as c_int];
            let mut sz = 0;
            cvt(libc::sysctl(mib.as_mut_ptr(), mib.len() as ::libc::c_uint,
                             ptr::null_mut(), &mut sz, ptr::null_mut(), 0))?;
            if sz == 0 {
                return Err(io::Error::last_os_error())
            }
            let mut v: Vec<u8> = Vec::with_capacity(sz);
            cvt(libc::sysctl(mib.as_mut_ptr(), mib.len() as ::libc::c_uint,
                             v.as_mut_ptr() as *mut libc::c_void, &mut sz,
                             ptr::null_mut(), 0))?;
            if sz == 0 {
                return Err(io::Error::last_os_error());
            }
            v.set_len(sz - 1); // chop off trailing NUL
            Ok(PathBuf::from(OsString::from_vec(v)))
        }
    }

    #[cfg(target_os = "netbsd")]
    pub fn current_exe() -> io::Result<PathBuf> {
        ::fs::read_link("/proc/curproc/exe")
    }

    #[cfg(any(target_os = "bitrig", target_os = "openbsd"))]
    pub fn current_exe() -> io::Result<PathBuf> {
        unsafe {
            let mut mib = [libc::CTL_KERN,
                           libc::KERN_PROC_ARGS,
                           libc::getpid(),
                           libc::KERN_PROC_ARGV];
            let mib = mib.as_mut_ptr();
            let mut argv_len = 0;
            cvt(libc::sysctl(mib, 4, ptr::null_mut(), &mut argv_len,
                             ptr::null_mut(), 0))?;
            let mut argv = Vec::<*const libc::c_char>::with_capacity(argv_len as usize);
            cvt(libc::sysctl(mib, 4, argv.as_mut_ptr() as *mut _,
                             &mut argv_len, ptr::null_mut(), 0))?;
            argv.set_len(argv_len as usize);
            if argv[0].is_null() {
                return Err(io::Error::new(io::ErrorKind::Other,
                                          "no current exe available"))
            }
            let argv0 = CStr::from_ptr(argv[0]).to_bytes();
            if argv0[0] == b'.' || argv0.iter().any(|b| *b == b'/') {
                ::fs::canonicalize(OsStr::from_bytes(argv0))
            } else {
                Ok(PathBuf::from(OsStr::from_bytes(argv0)))
            }
        }
    }

    #[cfg(any(target_os = "linux", target_os = "android", target_os = "emscripten"))]
    pub fn current_exe() -> io::Result<PathBuf> {
        let selfexe = PathBuf::from("/proc/self/exe");
        if selfexe.exists() {
            ::fs::read_link(selfexe)
        } else {
            Err(io::Error::new(io::ErrorKind::Other, "no /proc/self/exe available. Is /proc mounted?"))
        }
    }

    #[cfg(any(target_os = "macos", target_os = "ios"))]
    pub fn current_exe() -> io::Result<PathBuf> {
        extern {
            fn _NSGetExecutablePath(buf: *mut libc::c_char,
                                    bufsize: *mut u32) -> libc::c_int;
        }
        unsafe {
            let mut sz: u32 = 0;
            _NSGetExecutablePath(ptr::null_mut(), &mut sz);
            if sz == 0 { return Err(io::Error::last_os_error()); }
            let mut v: Vec<u8> = Vec::with_capacity(sz as usize);
            let err = _NSGetExecutablePath(v.as_mut_ptr() as *mut i8, &mut sz);
            if err != 0 { return Err(io::Error::last_os_error()); }
            v.set_len(sz as usize - 1); // chop off trailing NUL
            Ok(PathBuf::from(OsString::from_vec(v)))
        }
    }

    #[cfg(any(target_os = "solaris"))]
    pub fn current_exe() -> io::Result<PathBuf> {
        extern {
            fn getexecname() -> *const c_char;
        }
        unsafe {
            let path = getexecname();
            if path.is_null() {
                Err(io::Error::last_os_error())
            } else {
                let filename = CStr::from_ptr(path).to_bytes();
                let path = PathBuf::from(<OsStr as OsStrExt>::from_bytes(filename));

                // Prepend a current working directory to the path if
                // it doesn't contain an absolute pathname.
                if filename[0] == b'/' {
                    Ok(path)
                } else {
                    getcwd().map(|cwd| cwd.join(path))
                }
            }
        }
    }

    #[cfg(target_os = "haiku")]
    pub fn current_exe() -> io::Result<PathBuf> {
        // Use Haiku's image info functions
        #[repr(C)]
        struct image_info {
            id: i32,
            type_: i32,
            sequence: i32,
            init_order: i32,
            init_routine: *mut libc::c_void,    // function pointer
            term_routine: *mut libc::c_void,    // function pointer
            device: libc::dev_t,
            node: libc::ino_t,
            name: [libc::c_char; 1024],         // MAXPATHLEN
            text: *mut libc::c_void,
            data: *mut libc::c_void,
            text_size: i32,
            data_size: i32,
            api_version: i32,
            abi: i32,
        }

        unsafe {
            extern {
                fn _get_next_image_info(team_id: i32, cookie: *mut i32,
                    info: *mut image_info, size: i32) -> i32;
            }

            let mut info: image_info = mem::zeroed();
            let mut cookie: i32 = 0;
            // the executable can be found at team id 0
            let result = _get_next_image_info(0, &mut cookie, &mut info,
                mem::size_of::<image_info>() as i32);
            if result != 0 {
                use io::ErrorKind;
                Err(io::Error::new(ErrorKind::Other, "Error getting executable path"))
            } else {
                let name = CStr::from_ptr(info.name.as_ptr()).to_bytes();
                Ok(PathBuf::from(OsStr::from_bytes(name)))
            }
        }
    }

    #[cfg(target_os = "fuchsia")]
    pub fn current_exe() -> io::Result<PathBuf> {
        use io::ErrorKind;
        Err(io::Error::new(ErrorKind::Other, "Not yet implemented on fuchsia"))
    }

    pub struct Env {
        iter: vec::IntoIter<(OsString, OsString)>,
        _dont_send_or_sync_me: PhantomData<*mut ()>,
    }

    impl Iterator for Env {
        type Item = (OsString, OsString);
        fn next(&mut self) -> Option<(OsString, OsString)> { self.iter.next() }
        fn size_hint(&self) -> (usize, Option<usize>) { self.iter.size_hint() }
    }

    #[cfg(target_os = "macos")]
    pub unsafe fn environ() -> *mut *const *const c_char {
        extern { fn _NSGetEnviron() -> *mut *const *const c_char; }
        _NSGetEnviron()
    }

    #[cfg(not(target_os = "macos"))]
    pub unsafe fn environ() -> *mut *const *const c_char {
        extern { static mut environ: *const *const c_char; }
        &mut environ
    }

    /// Returns a vector of (variable, value) byte-vector pairs for all the
    /// environment variables of the current process.
    pub fn env() -> Env {
        unsafe {
            ENV_LOCK.lock();
            let mut environ = *environ();
            if environ == ptr::null() {
                ENV_LOCK.unlock();
                panic!("os::env() failure getting env string from OS: {}",
                       io::Error::last_os_error());
            }
            let mut result = Vec::new();
            while *environ != ptr::null() {
                if let Some(key_value) = parse(CStr::from_ptr(*environ).to_bytes()) {
                    result.push(key_value);
                }
                environ = environ.offset(1);
            }
            let ret = Env {
                iter: result.into_iter(),
                _dont_send_or_sync_me: PhantomData,
            };
            ENV_LOCK.unlock();
            return ret
        }

        fn parse(input: &[u8]) -> Option<(OsString, OsString)> {
            // Strategy (copied from glibc): Variable name and value are separated
            // by an ASCII equals sign '='. Since a variable name must not be
            // empty, allow variable names starting with an equals sign. Skip all
            // malformed lines.
            if input.is_empty() {
                return None;
            }
            let pos = memchr::memchr(b'=', &input[1..]).map(|p| p + 1);
            pos.map(|p| (
                OsStringExt::from_vec(input[..p].to_vec()),
                OsStringExt::from_vec(input[p+1..].to_vec()),
            ))
        }
    }

    pub fn getenv(k: &OsStr) -> io::Result<Option<OsString>> {
        // environment variables with a nul byte can't be set, so their value is
        // always None as well
        let k = CString::new(k.as_bytes())?;
        unsafe {
            ENV_LOCK.lock();
            let s = libc::getenv(k.as_ptr()) as *const _;
            let ret = if s.is_null() {
                None
            } else {
                Some(OsStringExt::from_vec(CStr::from_ptr(s).to_bytes().to_vec()))
            };
            ENV_LOCK.unlock();
            return Ok(ret)
        }
    }

    pub fn setenv(k: &OsStr, v: &OsStr) -> io::Result<()> {
        let k = CString::new(k.as_bytes())?;
        let v = CString::new(v.as_bytes())?;

        unsafe {
            ENV_LOCK.lock();
            let ret = cvt(libc::setenv(k.as_ptr(), v.as_ptr(), 1)).map(|_| ());
            ENV_LOCK.unlock();
            return ret
        }
    }

    pub fn unsetenv(n: &OsStr) -> io::Result<()> {
        let nbuf = CString::new(n.as_bytes())?;

        unsafe {
            ENV_LOCK.lock();
            let ret = cvt(libc::unsetenv(nbuf.as_ptr())).map(|_| ());
            ENV_LOCK.unlock();
            return ret
        }
    }

    pub fn page_size() -> usize {
        unsafe {
            libc::sysconf(libc::_SC_PAGESIZE) as usize
        }
    }

    pub fn temp_dir() -> PathBuf {
        ::env::var_os("TMPDIR").map(PathBuf::from).unwrap_or_else(|| {
            if cfg!(target_os = "android") {
                PathBuf::from("/data/local/tmp")
            } else {
                PathBuf::from("/tmp")
            }
        })
    }

    pub fn home_dir() -> Option<PathBuf> {
        return ::env::var_os("HOME").or_else(|| unsafe {
            fallback()
        }).map(PathBuf::from);

        #[cfg(any(target_os = "android",
                  target_os = "ios",
                  target_os = "nacl",
                  target_os = "emscripten"))]
        unsafe fn fallback() -> Option<OsString> { None }
        #[cfg(not(any(target_os = "android",
                      target_os = "ios",
                      target_os = "nacl",
                      target_os = "emscripten")))]
        unsafe fn fallback() -> Option<OsString> {
            let amt = match libc::sysconf(libc::_SC_GETPW_R_SIZE_MAX) {
                n if n < 0 => 512 as usize,
                n => n as usize,
            };
            let mut buf = Vec::with_capacity(amt);
            let mut passwd: libc::passwd = mem::zeroed();
            let mut result = ptr::null_mut();
            match libc::getpwuid_r(libc::getuid(), &mut passwd, buf.as_mut_ptr(),
                                   buf.capacity(), &mut result) {
                0 if !result.is_null() => {
                    let ptr = passwd.pw_dir as *const _;
                    let bytes = CStr::from_ptr(ptr).to_bytes().to_vec();
                    Some(OsStringExt::from_vec(bytes))
                },
                _ => None,
            }
        }
    }

    pub fn exit(code: i32) -> ! {
        unsafe { libc::exit(code as c_int) }
    }

# Help

## Keyboard Shortcuts

?
  Show this help dialog
S
  Focus the search field
⇤
  Move up in search results
⇥
  Move down in search results
⏎
  Go to active search result
+
  Collapse/expand all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g. `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g. `vec -> usize` or `* -> vec`)