[XFS] Update XFS quota header license to match the SGI boilerplate.
[deliverable/linux.git] / include / linux / dqblk_xfs.h
1 /*
2 * Copyright (c) 1995-2001,2004 Silicon Graphics, Inc. All Rights Reserved.
3 *
4 * This program is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Lesser General Public License
6 * as published by the Free Software Foundation.
7 *
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU Lesser General Public License for more details.
12 *
13 * You should have received a copy of the GNU Lesset General Public License
14 * along with this program; if not, write to the Free Software Foundation,
15 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
16 */
17 #ifndef _LINUX_DQBLK_XFS_H
18 #define _LINUX_DQBLK_XFS_H
19
20 #include <linux/types.h>
21
22 /*
23 * Disk quota - quotactl(2) commands for the XFS Quota Manager (XQM).
24 */
25
26 #define XQM_CMD(x) (('X'<<8)+(x)) /* note: forms first QCMD argument */
27 #define XQM_COMMAND(x) (((x) & (0xff<<8)) == ('X'<<8)) /* test if for XFS */
28
29 #define XQM_USRQUOTA 0 /* system call user quota type */
30 #define XQM_GRPQUOTA 1 /* system call group quota type */
31 #define XQM_MAXQUOTAS 2
32
33 #define Q_XQUOTAON XQM_CMD(1) /* enable accounting/enforcement */
34 #define Q_XQUOTAOFF XQM_CMD(2) /* disable accounting/enforcement */
35 #define Q_XGETQUOTA XQM_CMD(3) /* get disk limits and usage */
36 #define Q_XSETQLIM XQM_CMD(4) /* set disk limits */
37 #define Q_XGETQSTAT XQM_CMD(5) /* get quota subsystem status */
38 #define Q_XQUOTARM XQM_CMD(6) /* free disk space used by dquots */
39
40 /*
41 * fs_disk_quota structure:
42 *
43 * This contains the current quota information regarding a user/proj/group.
44 * It is 64-bit aligned, and all the blk units are in BBs (Basic Blocks) of
45 * 512 bytes.
46 */
47 #define FS_DQUOT_VERSION 1 /* fs_disk_quota.d_version */
48 typedef struct fs_disk_quota {
49 __s8 d_version; /* version of this structure */
50 __s8 d_flags; /* XFS_{USER,PROJ,GROUP}_QUOTA */
51 __u16 d_fieldmask; /* field specifier */
52 __u32 d_id; /* user, project, or group ID */
53 __u64 d_blk_hardlimit;/* absolute limit on disk blks */
54 __u64 d_blk_softlimit;/* preferred limit on disk blks */
55 __u64 d_ino_hardlimit;/* maximum # allocated inodes */
56 __u64 d_ino_softlimit;/* preferred inode limit */
57 __u64 d_bcount; /* # disk blocks owned by the user */
58 __u64 d_icount; /* # inodes owned by the user */
59 __s32 d_itimer; /* zero if within inode limits */
60 /* if not, we refuse service */
61 __s32 d_btimer; /* similar to above; for disk blocks */
62 __u16 d_iwarns; /* # warnings issued wrt num inodes */
63 __u16 d_bwarns; /* # warnings issued wrt disk blocks */
64 __s32 d_padding2; /* padding2 - for future use */
65 __u64 d_rtb_hardlimit;/* absolute limit on realtime blks */
66 __u64 d_rtb_softlimit;/* preferred limit on RT disk blks */
67 __u64 d_rtbcount; /* # realtime blocks owned */
68 __s32 d_rtbtimer; /* similar to above; for RT disk blks */
69 __u16 d_rtbwarns; /* # warnings issued wrt RT disk blks */
70 __s16 d_padding3; /* padding3 - for future use */
71 char d_padding4[8]; /* yet more padding */
72 } fs_disk_quota_t;
73
74 /*
75 * These fields are sent to Q_XSETQLIM to specify fields that need to change.
76 */
77 #define FS_DQ_ISOFT (1<<0)
78 #define FS_DQ_IHARD (1<<1)
79 #define FS_DQ_BSOFT (1<<2)
80 #define FS_DQ_BHARD (1<<3)
81 #define FS_DQ_RTBSOFT (1<<4)
82 #define FS_DQ_RTBHARD (1<<5)
83 #define FS_DQ_LIMIT_MASK (FS_DQ_ISOFT | FS_DQ_IHARD | FS_DQ_BSOFT | \
84 FS_DQ_BHARD | FS_DQ_RTBSOFT | FS_DQ_RTBHARD)
85 /*
86 * These timers can only be set in super user's dquot. For others, timers are
87 * automatically started and stopped. Superusers timer values set the limits
88 * for the rest. In case these values are zero, the DQ_{F,B}TIMELIMIT values
89 * defined below are used.
90 * These values also apply only to the d_fieldmask field for Q_XSETQLIM.
91 */
92 #define FS_DQ_BTIMER (1<<6)
93 #define FS_DQ_ITIMER (1<<7)
94 #define FS_DQ_RTBTIMER (1<<8)
95 #define FS_DQ_TIMER_MASK (FS_DQ_BTIMER | FS_DQ_ITIMER | FS_DQ_RTBTIMER)
96
97 /*
98 * Warning counts are set in both super user's dquot and others. For others,
99 * warnings are set/cleared by the administrators (or automatically by going
100 * below the soft limit). Superusers warning values set the warning limits
101 * for the rest. In case these values are zero, the DQ_{F,B}WARNLIMIT values
102 * defined below are used.
103 * These values also apply only to the d_fieldmask field for Q_XSETQLIM.
104 */
105 #define FS_DQ_BWARNS (1<<9)
106 #define FS_DQ_IWARNS (1<<10)
107 #define FS_DQ_RTBWARNS (1<<11)
108 #define FS_DQ_WARNS_MASK (FS_DQ_BWARNS | FS_DQ_IWARNS | FS_DQ_RTBWARNS)
109
110 /*
111 * Various flags related to quotactl(2). Only relevant to XFS filesystems.
112 */
113 #define XFS_QUOTA_UDQ_ACCT (1<<0) /* user quota accounting */
114 #define XFS_QUOTA_UDQ_ENFD (1<<1) /* user quota limits enforcement */
115 #define XFS_QUOTA_GDQ_ACCT (1<<2) /* group quota accounting */
116 #define XFS_QUOTA_GDQ_ENFD (1<<3) /* group quota limits enforcement */
117 #define XFS_QUOTA_PDQ_ACCT (1<<4) /* project quota accounting */
118 #define XFS_QUOTA_PDQ_ENFD (1<<5) /* project quota limits enforcement */
119
120 #define XFS_USER_QUOTA (1<<0) /* user quota type */
121 #define XFS_PROJ_QUOTA (1<<1) /* project quota type */
122 #define XFS_GROUP_QUOTA (1<<2) /* group quota type */
123
124 /*
125 * fs_quota_stat is the struct returned in Q_XGETQSTAT for a given file system.
126 * Provides a centralized way to get meta infomation about the quota subsystem.
127 * eg. space taken up for user and group quotas, number of dquots currently
128 * incore.
129 */
130 #define FS_QSTAT_VERSION 1 /* fs_quota_stat.qs_version */
131
132 /*
133 * Some basic infomation about 'quota files'.
134 */
135 typedef struct fs_qfilestat {
136 __u64 qfs_ino; /* inode number */
137 __u64 qfs_nblks; /* number of BBs 512-byte-blks */
138 __u32 qfs_nextents; /* number of extents */
139 } fs_qfilestat_t;
140
141 typedef struct fs_quota_stat {
142 __s8 qs_version; /* version number for future changes */
143 __u16 qs_flags; /* XFS_QUOTA_{U,P,G}DQ_{ACCT,ENFD} */
144 __s8 qs_pad; /* unused */
145 fs_qfilestat_t qs_uquota; /* user quota storage information */
146 fs_qfilestat_t qs_gquota; /* group quota storage information */
147 __u32 qs_incoredqs; /* number of dquots incore */
148 __s32 qs_btimelimit; /* limit for blks timer */
149 __s32 qs_itimelimit; /* limit for inodes timer */
150 __s32 qs_rtbtimelimit;/* limit for rt blks timer */
151 __u16 qs_bwarnlimit; /* limit for num warnings */
152 __u16 qs_iwarnlimit; /* limit for num warnings */
153 } fs_quota_stat_t;
154
155 #endif /* _LINUX_DQBLK_XFS_H */
This page took 0.066745 seconds and 6 git commands to generate.