summaryrefslogtreecommitdiff
path: root/src/sys/statvfs.rs
blob: e45863f868053387c2a8ff6cb616442bf2072712 (plain)
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
//! FFI for statvfs functions
//!
//! See the `vfs::Statvfs` struct for some rusty wrappers

use {Errno, Result, NixPath};
use std::os::unix::io::AsRawFd;

pub mod vfs {
    //! Structs related to the `statvfs` and `fstatvfs` functions
    //!
    //! The `Statvfs` struct has some wrappers methods around the `statvfs` and
    //! `fstatvfs` calls.

    use libc::{c_ulong,c_int};
    use std::os::unix::io::AsRawFd;
    use {Result, NixPath};

    use super::{statvfs, fstatvfs};

    bitflags!(
        /// Mount Flags
        #[repr(C)]
        #[derive(Default)]
        pub struct FsFlags: c_ulong {
            /// Read Only
            const RDONLY = 1;
            /// Do not allow the set-uid bits to have an effect
            const NOSUID = 2;
            /// Do not interpret character or block-special devices
            const NODEV  = 4;
            /// Do not allow execution of binaries on the filesystem
            const NOEXEC = 8;
            /// All IO should be done synchronously
            const SYNCHRONOUS  = 16;
            /// Allow mandatory locks on the filesystem
            const MANDLOCK = 64;
            const WRITE = 128;
            const APPEND = 256;
            const IMMUTABLE = 512;
            /// Do not update access times on files
            const NOATIME = 1024;
            /// Do not update access times on files
            const NODIRATIME = 2048;
            /// Update access time relative to modify/change time
            const RELATIME = 4096;
        }
    );

    /// The posix statvfs struct
    ///
    /// http://linux.die.net/man/2/statvfs
    #[repr(C)]
    #[derive(Debug,Copy,Clone)]
    pub struct Statvfs {
        /// Filesystem block size. This is the value that will lead to
        /// most efficient use of the filesystem
        pub f_bsize: c_ulong,
        /// Fragment Size -- actual minimum unit of allocation on this
        /// filesystem
        pub f_frsize: c_ulong,
        /// Total number of blocks on the filesystem
        pub f_blocks: u64,
        /// Number of unused blocks on the filesystem, including those
        /// reserved for root
        pub f_bfree: u64,
        /// Number of blocks available to non-root users
        pub f_bavail: u64,
        /// Total number of inodes available on the filesystem
        pub f_files: u64,
        /// Number of inodes available on the filesystem
        pub f_ffree: u64,
        /// Number of inodes available to non-root users
        pub f_favail: u64,
        /// File System ID
        pub f_fsid: c_ulong,
        /// Mount Flags
        pub f_flag: FsFlags,
        /// Maximum filename length
        pub f_namemax: c_ulong,
        /// Reserved extra space, OS-dependent
        f_spare: [c_int; 6],
    }

    impl Statvfs {
        /// Create a new `Statvfs` object and fill it with information about
        /// the mount that contains `path`
        pub fn for_path<P: ?Sized + NixPath>(path: &P) -> Result<Statvfs> {
            let mut stat = Statvfs::default();
            let res = statvfs(path, &mut stat);
            res.map(|_| stat)
        }

        /// Replace information in this struct with information about `path`
        pub fn update_with_path<P: ?Sized + NixPath>(&mut self, path: &P) -> Result<()> {
            statvfs(path, self)
        }

        /// Create a new `Statvfs` object and fill it with information from fd
        pub fn for_fd<T: AsRawFd>(fd: &T) -> Result<Statvfs> {
            let mut stat = Statvfs::default();
            let res = fstatvfs(fd, &mut stat);
            res.map(|_| stat)
        }

        /// Replace information in this struct with information about `fd`
        pub fn update_with_fd<T: AsRawFd>(&mut self, fd: &T) -> Result<()> {
            fstatvfs(fd, self)
        }
    }

    impl Default for Statvfs {
        /// Create a statvfs object initialized to all zeros
        fn default() -> Self {
            Statvfs {
                f_bsize: 0,
                f_frsize: 0,
                f_blocks: 0,
                f_bfree: 0,
                f_bavail: 0,
                f_files: 0,
                f_ffree: 0,
                f_favail: 0,
                f_fsid: 0,
                f_flag: FsFlags::default(),
                f_namemax: 0,
                f_spare: [0, 0, 0, 0, 0, 0],
            }
        }
    }
}

mod ffi {
    use libc::{c_char, c_int};
    use sys::statvfs::vfs;

    extern {
        pub fn statvfs(path: * const c_char, buf: *mut vfs::Statvfs) -> c_int;
        pub fn fstatvfs(fd: c_int, buf: *mut vfs::Statvfs) -> c_int;
    }
}

/// Fill an existing `Statvfs` object with information about the `path`
pub fn statvfs<P: ?Sized + NixPath>(path: &P, stat: &mut vfs::Statvfs) -> Result<()> {
    unsafe {
        Errno::clear();
        let res = try!(
            path.with_nix_path(|path| ffi::statvfs(path.as_ptr(), stat))
        );

        Errno::result(res).map(drop)
    }
}

/// Fill an existing `Statvfs` object with information about `fd`
pub fn fstatvfs<T: AsRawFd>(fd: &T, stat: &mut vfs::Statvfs) -> Result<()> {
    unsafe {
        Errno::clear();
        Errno::result(ffi::fstatvfs(fd.as_raw_fd(), stat)).map(drop)
    }
}

#[cfg(test)]
mod test {
    use std::fs::File;
    use sys::statvfs::*;

    #[test]
    fn statvfs_call() {
        let mut stat = vfs::Statvfs::default();
        statvfs("/".as_bytes(), &mut stat).unwrap()
    }

    #[test]
    fn fstatvfs_call() {
        let mut stat = vfs::Statvfs::default();
        let root = File::open("/").unwrap();
        fstatvfs(&root, &mut stat).unwrap()
    }
}