1  /* SPDX-License-Identifier: LGPL-2.1+ WITH Linux-syscall-note */
2  /*
3   * Copyright (c) 1995-2001,2004 Silicon Graphics, Inc.  All Rights Reserved.
4   *
5   * This program is free software; you can redistribute it and/or
6   * modify it under the terms of the GNU Lesser General Public License
7   * as published by the Free Software Foundation.
8   *
9   * This program is distributed in the hope that it will be useful,
10   * but WITHOUT ANY WARRANTY; without even the implied warranty of
11   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12   * GNU Lesser General Public License for more details.
13   *
14   * You should have received a copy of the GNU Lesset General Public License
15   * along with this program; if not, write to the Free Software Foundation,
16   * Inc.,  51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
17   */
18  #ifndef _LINUX_DQBLK_XFS_H
19  #define _LINUX_DQBLK_XFS_H
20  
21  #include <linux/types.h>
22  
23  /*
24   * Disk quota - quotactl(2) commands for the XFS Quota Manager (XQM).
25   */
26  
27  #define XQM_CMD(x)	(('X'<<8)+(x))	/* note: forms first QCMD argument */
28  #define XQM_COMMAND(x)	(((x) & (0xff<<8)) == ('X'<<8))	/* test if for XFS */
29  
30  #define XQM_USRQUOTA	0	/* system call user quota type */
31  #define XQM_GRPQUOTA	1	/* system call group quota type */
32  #define XQM_PRJQUOTA	2	/* system call project quota type */
33  #define XQM_MAXQUOTAS	3
34  
35  #define Q_XQUOTAON	XQM_CMD(1)	/* enable accounting/enforcement */
36  #define Q_XQUOTAOFF	XQM_CMD(2)	/* disable accounting/enforcement */
37  #define Q_XGETQUOTA	XQM_CMD(3)	/* get disk limits and usage */
38  #define Q_XSETQLIM	XQM_CMD(4)	/* set disk limits */
39  #define Q_XGETQSTAT	XQM_CMD(5)	/* get quota subsystem status */
40  #define Q_XQUOTARM	XQM_CMD(6)	/* free disk space used by dquots */
41  #define Q_XQUOTASYNC	XQM_CMD(7)	/* delalloc flush, updates dquots */
42  #define Q_XGETQSTATV	XQM_CMD(8)	/* newer version of get quota */
43  #define Q_XGETNEXTQUOTA	XQM_CMD(9)	/* get disk limits and usage >= ID */
44  
45  /*
46   * fs_disk_quota structure:
47   *
48   * This contains the current quota information regarding a user/proj/group.
49   * It is 64-bit aligned, and all the blk units are in BBs (Basic Blocks) of
50   * 512 bytes.
51   */
52  #define FS_DQUOT_VERSION	1	/* fs_disk_quota.d_version */
53  typedef struct fs_disk_quota {
54  	__s8		d_version;	/* version of this structure */
55  	__s8		d_flags;	/* FS_{USER,PROJ,GROUP}_QUOTA */
56  	__u16		d_fieldmask;	/* field specifier */
57  	__u32		d_id;		/* user, project, or group ID */
58  	__u64		d_blk_hardlimit;/* absolute limit on disk blks */
59  	__u64		d_blk_softlimit;/* preferred limit on disk blks */
60  	__u64		d_ino_hardlimit;/* maximum # allocated inodes */
61  	__u64		d_ino_softlimit;/* preferred inode limit */
62  	__u64		d_bcount;	/* # disk blocks owned by the user */
63  	__u64		d_icount;	/* # inodes owned by the user */
64  	__s32		d_itimer;	/* Zero if within inode limits. If
65  					 * not, we refuse service at this time
66  					 * (in seconds since Unix epoch) */
67  	__s32		d_btimer;	/* similar to above; for disk blocks */
68  	__u16	  	d_iwarns;       /* # warnings issued wrt num inodes */
69  	__u16	  	d_bwarns;       /* # warnings issued wrt disk blocks */
70  	__s8		d_itimer_hi;	/* upper 8 bits of timer values */
71  	__s8		d_btimer_hi;
72  	__s8		d_rtbtimer_hi;
73  	__s8		d_padding2;	/* padding2 - for future use */
74  	__u64		d_rtb_hardlimit;/* absolute limit on realtime blks */
75  	__u64		d_rtb_softlimit;/* preferred limit on RT disk blks */
76  	__u64		d_rtbcount;	/* # realtime blocks owned */
77  	__s32		d_rtbtimer;	/* similar to above; for RT disk blks */
78  	__u16	  	d_rtbwarns;     /* # warnings issued wrt RT disk blks */
79  	__s16		d_padding3;	/* padding3 - for future use */
80  	char		d_padding4[8];	/* yet more padding */
81  } fs_disk_quota_t;
82  
83  /*
84   * These fields are sent to Q_XSETQLIM to specify fields that need to change.
85   */
86  #define FS_DQ_ISOFT	(1<<0)
87  #define FS_DQ_IHARD	(1<<1)
88  #define FS_DQ_BSOFT	(1<<2)
89  #define FS_DQ_BHARD 	(1<<3)
90  #define FS_DQ_RTBSOFT	(1<<4)
91  #define FS_DQ_RTBHARD	(1<<5)
92  #define FS_DQ_LIMIT_MASK	(FS_DQ_ISOFT | FS_DQ_IHARD | FS_DQ_BSOFT | \
93  				 FS_DQ_BHARD | FS_DQ_RTBSOFT | FS_DQ_RTBHARD)
94  /*
95   * These timers can only be set in super user's dquot. For others, timers are
96   * automatically started and stopped. Superusers timer values set the limits
97   * for the rest.  In case these values are zero, the DQ_{F,B}TIMELIMIT values
98   * defined below are used.
99   * These values also apply only to the d_fieldmask field for Q_XSETQLIM.
100   */
101  #define FS_DQ_BTIMER	(1<<6)
102  #define FS_DQ_ITIMER	(1<<7)
103  #define FS_DQ_RTBTIMER 	(1<<8)
104  #define FS_DQ_TIMER_MASK	(FS_DQ_BTIMER | FS_DQ_ITIMER | FS_DQ_RTBTIMER)
105  
106  /*
107   * Warning counts are set in both super user's dquot and others. For others,
108   * warnings are set/cleared by the administrators (or automatically by going
109   * below the soft limit).  Superusers warning values set the warning limits
110   * for the rest.  In case these values are zero, the DQ_{F,B}WARNLIMIT values
111   * defined below are used.
112   * These values also apply only to the d_fieldmask field for Q_XSETQLIM.
113   */
114  #define FS_DQ_BWARNS	(1<<9)
115  #define FS_DQ_IWARNS	(1<<10)
116  #define FS_DQ_RTBWARNS	(1<<11)
117  #define FS_DQ_WARNS_MASK	(FS_DQ_BWARNS | FS_DQ_IWARNS | FS_DQ_RTBWARNS)
118  
119  /*
120   * Accounting values.  These can only be set for filesystem with
121   * non-transactional quotas that require quotacheck(8) in userspace.
122   */
123  #define FS_DQ_BCOUNT		(1<<12)
124  #define FS_DQ_ICOUNT		(1<<13)
125  #define FS_DQ_RTBCOUNT		(1<<14)
126  #define FS_DQ_ACCT_MASK		(FS_DQ_BCOUNT | FS_DQ_ICOUNT | FS_DQ_RTBCOUNT)
127  
128  /*
129   * Quota expiration timestamps are 40-bit signed integers, with the upper 8
130   * bits encoded in the _hi fields.
131   */
132  #define FS_DQ_BIGTIME		(1<<15)
133  
134  /*
135   * Various flags related to quotactl(2).
136   */
137  #define FS_QUOTA_UDQ_ACCT	(1<<0)  /* user quota accounting */
138  #define FS_QUOTA_UDQ_ENFD	(1<<1)  /* user quota limits enforcement */
139  #define FS_QUOTA_GDQ_ACCT	(1<<2)  /* group quota accounting */
140  #define FS_QUOTA_GDQ_ENFD	(1<<3)  /* group quota limits enforcement */
141  #define FS_QUOTA_PDQ_ACCT	(1<<4)  /* project quota accounting */
142  #define FS_QUOTA_PDQ_ENFD	(1<<5)  /* project quota limits enforcement */
143  
144  #define FS_USER_QUOTA		(1<<0)	/* user quota type */
145  #define FS_PROJ_QUOTA		(1<<1)	/* project quota type */
146  #define FS_GROUP_QUOTA		(1<<2)	/* group quota type */
147  
148  /*
149   * fs_quota_stat is the struct returned in Q_XGETQSTAT for a given file system.
150   * Provides a centralized way to get meta information about the quota subsystem.
151   * eg. space taken up for user and group quotas, number of dquots currently
152   * incore.
153   */
154  #define FS_QSTAT_VERSION	1	/* fs_quota_stat.qs_version */
155  
156  /*
157   * Some basic information about 'quota files'.
158   */
159  typedef struct fs_qfilestat {
160  	__u64		qfs_ino;	/* inode number */
161  	__u64		qfs_nblks;	/* number of BBs 512-byte-blks */
162  	__u32		qfs_nextents;	/* number of extents */
163  } fs_qfilestat_t;
164  
165  typedef struct fs_quota_stat {
166  	__s8		qs_version;	/* version number for future changes */
167  	__u16		qs_flags;	/* FS_QUOTA_{U,P,G}DQ_{ACCT,ENFD} */
168  	__s8		qs_pad;		/* unused */
169  	fs_qfilestat_t	qs_uquota;	/* user quota storage information */
170  	fs_qfilestat_t	qs_gquota;	/* group quota storage information */
171  	__u32		qs_incoredqs;	/* number of dquots incore */
172  	__s32		qs_btimelimit;  /* limit for blks timer */
173  	__s32		qs_itimelimit;  /* limit for inodes timer */
174  	__s32		qs_rtbtimelimit;/* limit for rt blks timer */
175  	__u16		qs_bwarnlimit;	/* limit for num warnings */
176  	__u16		qs_iwarnlimit;	/* limit for num warnings */
177  } fs_quota_stat_t;
178  
179  /*
180   * fs_quota_statv is used by Q_XGETQSTATV for a given file system. It provides
181   * a centralized way to get meta information about the quota subsystem. eg.
182   * space taken up for user, group, and project quotas, number of dquots
183   * currently incore.
184   *
185   * This version has proper versioning support with appropriate padding for
186   * future expansions, and ability to expand for future without creating any
187   * backward compatibility issues.
188   *
189   * Q_XGETQSTATV uses the passed in value of the requested version via
190   * fs_quota_statv.qs_version to determine the return data layout of
191   * fs_quota_statv.  The kernel will fill the data fields relevant to that
192   * version.
193   *
194   * If kernel does not support user space caller specified version, EINVAL will
195   * be returned. User space caller can then reduce the version number and retry
196   * the same command.
197   */
198  #define FS_QSTATV_VERSION1	1	/* fs_quota_statv.qs_version */
199  /*
200   * Some basic information about 'quota files' for Q_XGETQSTATV command
201   */
202  struct fs_qfilestatv {
203  	__u64		qfs_ino;	/* inode number */
204  	__u64		qfs_nblks;	/* number of BBs 512-byte-blks */
205  	__u32		qfs_nextents;	/* number of extents */
206  	__u32		qfs_pad;	/* pad for 8-byte alignment */
207  };
208  
209  struct fs_quota_statv {
210  	__s8			qs_version;	/* version for future changes */
211  	__u8			qs_pad1;	/* pad for 16bit alignment */
212  	__u16			qs_flags;	/* FS_QUOTA_.* flags */
213  	__u32			qs_incoredqs;	/* number of dquots incore */
214  	struct fs_qfilestatv	qs_uquota;	/* user quota information */
215  	struct fs_qfilestatv	qs_gquota;	/* group quota information */
216  	struct fs_qfilestatv	qs_pquota;	/* project quota information */
217  	__s32			qs_btimelimit;  /* limit for blks timer */
218  	__s32			qs_itimelimit;  /* limit for inodes timer */
219  	__s32			qs_rtbtimelimit;/* limit for rt blks timer */
220  	__u16			qs_bwarnlimit;	/* limit for num warnings */
221  	__u16			qs_iwarnlimit;	/* limit for num warnings */
222  	__u16			qs_rtbwarnlimit;/* limit for rt blks warnings */
223  	__u16			qs_pad3;
224  	__u32			qs_pad4;
225  	__u64			qs_pad2[7];	/* for future proofing */
226  };
227  
228  #endif	/* _LINUX_DQBLK_XFS_H */
229