xref: /openbmc/linux/include/uapi/linux/quota.h (revision eafc474e)
1 /*
2  * Copyright (c) 1982, 1986 Regents of the University of California.
3  * All rights reserved.
4  *
5  * This code is derived from software contributed to Berkeley by
6  * Robert Elz at The University of Melbourne.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  * 3. Neither the name of the University nor the names of its contributors
17  *    may be used to endorse or promote products derived from this software
18  *    without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30  * SUCH DAMAGE.
31  */
32 
33 #ifndef _UAPI_LINUX_QUOTA_
34 #define _UAPI_LINUX_QUOTA_
35 
36 #include <linux/types.h>
37 
38 #define __DQUOT_VERSION__	"dquot_6.6.0"
39 
40 #define MAXQUOTAS 3
41 #define USRQUOTA  0		/* element used for user quotas */
42 #define GRPQUOTA  1		/* element used for group quotas */
43 #define PRJQUOTA  2		/* element used for project quotas */
44 
45 /*
46  * Definitions for the default names of the quotas files.
47  */
48 #define INITQFNAMES { \
49 	"user",    /* USRQUOTA */ \
50 	"group",   /* GRPQUOTA */ \
51 	"project", /* PRJQUOTA */ \
52 	"undefined", \
53 };
54 
55 /*
56  * Command definitions for the 'quotactl' system call.
57  * The commands are broken into a main command defined below
58  * and a subcommand that is used to convey the type of
59  * quota that is being manipulated (see above).
60  */
61 #define SUBCMDMASK  0x00ff
62 #define SUBCMDSHIFT 8
63 #define QCMD(cmd, type)  (((cmd) << SUBCMDSHIFT) | ((type) & SUBCMDMASK))
64 
65 #define Q_SYNC     0x800001	/* sync disk copy of a filesystems quotas */
66 #define Q_QUOTAON  0x800002	/* turn quotas on */
67 #define Q_QUOTAOFF 0x800003	/* turn quotas off */
68 #define Q_GETFMT   0x800004	/* get quota format used on given filesystem */
69 #define Q_GETINFO  0x800005	/* get information about quota files */
70 #define Q_SETINFO  0x800006	/* set information about quota files */
71 #define Q_GETQUOTA 0x800007	/* get user quota structure */
72 #define Q_SETQUOTA 0x800008	/* set user quota structure */
73 #define Q_GETNEXTQUOTA 0x800009	/* get disk limits and usage >= ID */
74 
75 /* Quota format type IDs */
76 #define	QFMT_VFS_OLD 1
77 #define	QFMT_VFS_V0 2
78 #define QFMT_OCFS2 3
79 #define	QFMT_VFS_V1 4
80 #define	QFMT_SHMEM 5
81 
82 /* Size of block in which space limits are passed through the quota
83  * interface */
84 #define QIF_DQBLKSIZE_BITS 10
85 #define QIF_DQBLKSIZE (1 << QIF_DQBLKSIZE_BITS)
86 
87 /*
88  * Quota structure used for communication with userspace via quotactl
89  * Following flags are used to specify which fields are valid
90  */
91 enum {
92 	QIF_BLIMITS_B = 0,
93 	QIF_SPACE_B,
94 	QIF_ILIMITS_B,
95 	QIF_INODES_B,
96 	QIF_BTIME_B,
97 	QIF_ITIME_B,
98 };
99 
100 #define QIF_BLIMITS	(1 << QIF_BLIMITS_B)
101 #define QIF_SPACE	(1 << QIF_SPACE_B)
102 #define QIF_ILIMITS	(1 << QIF_ILIMITS_B)
103 #define QIF_INODES	(1 << QIF_INODES_B)
104 #define QIF_BTIME	(1 << QIF_BTIME_B)
105 #define QIF_ITIME	(1 << QIF_ITIME_B)
106 #define QIF_LIMITS	(QIF_BLIMITS | QIF_ILIMITS)
107 #define QIF_USAGE	(QIF_SPACE | QIF_INODES)
108 #define QIF_TIMES	(QIF_BTIME | QIF_ITIME)
109 #define QIF_ALL		(QIF_LIMITS | QIF_USAGE | QIF_TIMES)
110 
111 struct if_dqblk {
112 	__u64 dqb_bhardlimit;
113 	__u64 dqb_bsoftlimit;
114 	__u64 dqb_curspace;
115 	__u64 dqb_ihardlimit;
116 	__u64 dqb_isoftlimit;
117 	__u64 dqb_curinodes;
118 	__u64 dqb_btime;
119 	__u64 dqb_itime;
120 	__u32 dqb_valid;
121 };
122 
123 struct if_nextdqblk {
124 	__u64 dqb_bhardlimit;
125 	__u64 dqb_bsoftlimit;
126 	__u64 dqb_curspace;
127 	__u64 dqb_ihardlimit;
128 	__u64 dqb_isoftlimit;
129 	__u64 dqb_curinodes;
130 	__u64 dqb_btime;
131 	__u64 dqb_itime;
132 	__u32 dqb_valid;
133 	__u32 dqb_id;
134 };
135 
136 /*
137  * Structure used for setting quota information about file via quotactl
138  * Following flags are used to specify which fields are valid
139  */
140 #define IIF_BGRACE	1
141 #define IIF_IGRACE	2
142 #define IIF_FLAGS	4
143 #define IIF_ALL		(IIF_BGRACE | IIF_IGRACE | IIF_FLAGS)
144 
145 enum {
146 	DQF_ROOT_SQUASH_B = 0,
147 	DQF_SYS_FILE_B = 16,
148 	/* Kernel internal flags invisible to userspace */
149 	DQF_PRIVATE
150 };
151 
152 /* Root squash enabled (for v1 quota format) */
153 #define DQF_ROOT_SQUASH	(1 << DQF_ROOT_SQUASH_B)
154 /* Quota stored in a system file */
155 #define DQF_SYS_FILE	(1 << DQF_SYS_FILE_B)
156 
157 struct if_dqinfo {
158 	__u64 dqi_bgrace;
159 	__u64 dqi_igrace;
160 	__u32 dqi_flags;	/* DFQ_* */
161 	__u32 dqi_valid;
162 };
163 
164 /*
165  * Definitions for quota netlink interface
166  */
167 #define QUOTA_NL_NOWARN 0
168 #define QUOTA_NL_IHARDWARN 1		/* Inode hardlimit reached */
169 #define QUOTA_NL_ISOFTLONGWARN 2 	/* Inode grace time expired */
170 #define QUOTA_NL_ISOFTWARN 3		/* Inode softlimit reached */
171 #define QUOTA_NL_BHARDWARN 4		/* Block hardlimit reached */
172 #define QUOTA_NL_BSOFTLONGWARN 5	/* Block grace time expired */
173 #define QUOTA_NL_BSOFTWARN 6		/* Block softlimit reached */
174 #define QUOTA_NL_IHARDBELOW 7		/* Usage got below inode hardlimit */
175 #define QUOTA_NL_ISOFTBELOW 8		/* Usage got below inode softlimit */
176 #define QUOTA_NL_BHARDBELOW 9		/* Usage got below block hardlimit */
177 #define QUOTA_NL_BSOFTBELOW 10		/* Usage got below block softlimit */
178 
179 enum {
180 	QUOTA_NL_C_UNSPEC,
181 	QUOTA_NL_C_WARNING,
182 	__QUOTA_NL_C_MAX,
183 };
184 #define QUOTA_NL_C_MAX (__QUOTA_NL_C_MAX - 1)
185 
186 enum {
187 	QUOTA_NL_A_UNSPEC,
188 	QUOTA_NL_A_QTYPE,
189 	QUOTA_NL_A_EXCESS_ID,
190 	QUOTA_NL_A_WARNING,
191 	QUOTA_NL_A_DEV_MAJOR,
192 	QUOTA_NL_A_DEV_MINOR,
193 	QUOTA_NL_A_CAUSED_ID,
194 	QUOTA_NL_A_PAD,
195 	__QUOTA_NL_A_MAX,
196 };
197 #define QUOTA_NL_A_MAX (__QUOTA_NL_A_MAX - 1)
198 
199 
200 #endif /* _UAPI_LINUX_QUOTA_ */
201