xref: /freebsd/sys/sys/statvfs.h (revision a0ee8cc6)
1 /*-
2  * Copyright 2002 Massachusetts Institute of Technology
3  *
4  * Permission to use, copy, modify, and distribute this software and
5  * its documentation for any purpose and without fee is hereby
6  * granted, provided that both the above copyright notice and this
7  * permission notice appear in all copies, that both the above
8  * copyright notice and this permission notice appear in all
9  * supporting documentation, and that the name of M.I.T. not be used
10  * in advertising or publicity pertaining to distribution of the
11  * software without specific, written prior permission.  M.I.T. makes
12  * no representations about the suitability of this software for any
13  * purpose.  It is provided "as is" without express or implied
14  * warranty.
15  *
16  * THIS SOFTWARE IS PROVIDED BY M.I.T. ``AS IS''.  M.I.T. DISCLAIMS
17  * ALL EXPRESS OR IMPLIED WARRANTIES WITH REGARD TO THIS SOFTWARE,
18  * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
19  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. IN NO EVENT
20  * SHALL M.I.T. BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
21  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
22  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
23  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
24  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
25  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
26  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27  * SUCH DAMAGE.
28  *
29  * $FreeBSD$
30  */
31 
32 #ifndef _SYS_STATVFS_H_
33 #define	_SYS_STATVFS_H_
34 
35 #include <sys/cdefs.h>
36 #include <sys/_types.h>
37 
38 /*
39  * POSIX says we must define the fsblkcnt_t and fsfilcnt_t types here.
40  * Note that these must be unsigned integer types, so we have to be
41  * careful in converting the signed statfs members to the unsigned
42  * statvfs members.  (Well, actually, we don't -- see below -- but
43  * a quality implementation should.)
44  */
45 #ifndef _FSBLKCNT_T_DECLARED		/* always declared together */
46 typedef	__fsblkcnt_t	fsblkcnt_t;
47 typedef	__fsfilcnt_t	fsfilcnt_t;
48 #define _FSBLKCNT_T_DECLARED
49 #endif
50 
51 /*
52  * The difference between `avail' and `free' is that `avail' represents
53  * space available to unprivileged processes, whereas `free' includes all
54  * unallocated space, including that reserved for privileged processes.
55  * Or at least, that's the most useful interpretation.  (According to
56  * the letter of the standard, this entire interface is completely
57  * unspecified!)
58  */
59 struct statvfs {
60 	fsblkcnt_t	f_bavail;	/* Number of blocks */
61 	fsblkcnt_t	f_bfree;
62 	fsblkcnt_t	f_blocks;
63 	fsfilcnt_t	f_favail;	/* Number of files (e.g., inodes) */
64 	fsfilcnt_t	f_ffree;
65 	fsfilcnt_t	f_files;
66 	unsigned long	f_bsize;	/* Size of blocks counted above */
67 	unsigned long	f_flag;
68 	unsigned long	f_frsize;	/* Size of fragments */
69 	unsigned long	f_fsid;		/* Not meaningful */
70 	unsigned long	f_namemax;	/* Same as pathconf(_PC_NAME_MAX) */
71 };
72 
73 /* flag bits for f_flag: */
74 #define	ST_RDONLY	0x1
75 #define	ST_NOSUID	0x2
76 
77 __BEGIN_DECLS
78 int	fstatvfs(int, struct statvfs *);
79 int	statvfs(const char *__restrict, struct statvfs *__restrict);
80 __END_DECLS
81 #endif /* _SYS_STATVFS_H_ */
82