manpage
[sysadmin-cn.git] / quotaio_xfs.h
1 /*
2  * Copyright (c) 2000 Silicon Graphics, Inc.  All Rights Reserved.
3  *
4  * This program is free software; you can redistribute it and/or modify it
5  * under the terms of version 2 of the GNU General Public License as
6  * published by the Free Software Foundation.
7  *
8  * This program is distributed in the hope that it would be useful, but
9  * WITHOUT ANY WARRANTY; without even the implied warranty of
10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
11  *
12  * Further, this software is distributed without any warranty that it is
13  * free of the rightful claim of any third person regarding infringement
14  * or the like.  Any license provided herein, whether implied or
15  * otherwise, applies only to this software file.  Patent licenses, if
16  * any, provided herein do not apply to combinations of this program with
17  * other software, or any other product whatsoever.
18  *
19  * You should have received a copy of the GNU General Public License along
20  * with this program; if not, write the Free Software Foundation, Inc., 59
21  * Temple Place - Suite 330, Boston MA 02111-1307, USA.
22  *
23  * Contact information: Silicon Graphics, Inc., 1600 Amphitheatre Pkwy,
24  * Mountain View, CA  94043, or:
25  *
26  * http://www.sgi.com
27  *
28  * For further information regarding this notice, see:
29  *
30  * http://oss.sgi.com/projects/GenInfo/SGIGPLNoticeExplan/
31  */
32 #ifndef _QUOTAIO_XFS_H
33 #define _QUOTAIO_XFS_H
34
35 #include <asm/types.h>
36
37 #define XQM_CMD(cmd)    ( ('X'<<8)+(cmd) )
38 #define IS_XQM_CMD(cmd) ( ((int)(cmd)>>8) == 'X' )
39
40 /*
41  * Disk quota - quotactl(2) commands for XFS Quota Manager (XQM).
42  */
43 #define Q_XQUOTAON   XQM_CMD(0x1)       /* enable quota accounting/enforcement */
44 #define Q_XQUOTAOFF  XQM_CMD(0x2)       /* disable quota accounting/enforcement */
45 #define Q_XGETQUOTA  XQM_CMD(0x3)       /* get disk limits & usage */
46 #define Q_XSETQLIM   XQM_CMD(0x4)       /* set disk limits only */
47 #define Q_XGETQSTAT  XQM_CMD(0x5)       /* returns fs_quota_stat_t struct */
48 #define Q_XQUOTARM   XQM_CMD(0x6)       /* free quota files' space */
49
50 /*
51  * fs_disk_quota structure:
52  *
53  * This contains the current quota information regarding a user/proj/group.
54  * It is 64-bit aligned, and all the blk units are in BBs (Basic Blocks) of
55  * 512 bytes.
56  */
57 #define FS_DQUOT_VERSION        1       /* fs_disk_quota.d_version */
58 typedef struct fs_disk_quota {
59         __s8 d_version;         /* version of this structure */
60         __s8 d_flags;           /* XFS_{USER,PROJ,GROUP}_QUOTA */
61         __u16 d_fieldmask;      /* field specifier */
62         __u32 d_id;             /* user, project, or group ID */
63         __u64 d_blk_hardlimit;  /* absolute limit on disk blks */
64         __u64 d_blk_softlimit;  /* preferred limit on disk blks */
65         __u64 d_ino_hardlimit;  /* maximum # allocated inodes */
66         __u64 d_ino_softlimit;  /* preferred inode limit */
67         __u64 d_bcount;         /* # disk blocks owned by the user */
68         __u64 d_icount;         /* # inodes owned by the user */
69         __s32 d_itimer;         /* zero if within inode limits */
70         /* if not, we refuse service */
71         __s32 d_btimer;         /* similar to above; for disk blocks */
72         __u16 d_iwarns;         /* # warnings issued wrt num inodes */
73         __u16 d_bwarns;         /* # warnings issued wrt disk blocks */
74         __s32 d_padding2;       /* padding2 - for future use */
75         __u64 d_rtb_hardlimit;  /* absolute limit on realtime blks */
76         __u64 d_rtb_softlimit;  /* preferred limit on RT disk blks */
77         __u64 d_rtbcount;       /* # realtime blocks owned */
78         __s32 d_rtbtimer;       /* similar to above; for RT disk blks */
79         __u16 d_rtbwarns;       /* # warnings issued wrt RT disk blks */
80         __s16 d_padding3;       /* padding3 - for future use */
81         char d_padding4[8];     /* yet more padding */
82 } fs_disk_quota_t;
83
84 /*
85  * These fields are sent to Q_XSETQLIM to specify fields that need to change.
86  */
87 #define FS_DQ_ISOFT     (1<<0)
88 #define FS_DQ_IHARD     (1<<1)
89 #define FS_DQ_BSOFT     (1<<2)
90 #define FS_DQ_BHARD     (1<<3)
91 #define FS_DQ_RTBSOFT   (1<<4)
92 #define FS_DQ_RTBHARD   (1<<5)
93 #define FS_DQ_LIMIT_MASK        (FS_DQ_ISOFT | FS_DQ_IHARD | FS_DQ_BSOFT | \
94                                  FS_DQ_BHARD | FS_DQ_RTBSOFT | FS_DQ_RTBHARD)
95 /*
96  * These timers can only be set in super user's dquot. For others, timers are
97  * automatically started and stopped. Superusers timer values set the limits
98  * for the rest.  In case these values are zero, the DQ_{F,B}TIMELIMIT values
99  * defined below are used. 
100  * These values also apply only to the d_fieldmask field for Q_XSETQLIM.
101  */
102 #define FS_DQ_BTIMER    (1<<6)
103 #define FS_DQ_ITIMER    (1<<7)
104 #define FS_DQ_RTBTIMER  (1<<8)
105 #define FS_DQ_TIMER_MASK        (FS_DQ_BTIMER | FS_DQ_ITIMER | FS_DQ_RTBTIMER)
106
107 /*
108  * Various flags related to quotactl(2).  Only relevant to XFS filesystems.
109  */
110 #define XFS_QUOTA_UDQ_ACCT      (1<<0)  /* user quota accounting */
111 #define XFS_QUOTA_UDQ_ENFD      (1<<1)  /* user quota limits enforcement */
112 #define XFS_QUOTA_GDQ_ACCT      (1<<2)  /* group quota accounting */
113 #define XFS_QUOTA_GDQ_ENFD      (1<<3)  /* group quota limits enforcement */
114
115 #define XFS_USER_QUOTA          (1<<0)  /* user quota type */
116 #define XFS_PROJ_QUOTA          (1<<1)  /* (IRIX) project quota type */
117 #define XFS_GROUP_QUOTA         (1<<2)  /* group quota type */
118
119 /*
120  * fs_quota_stat is the struct returned in Q_XGETQSTAT for a given file system.
121  * Provides a centralized way to get meta infomation about the quota subsystem.
122  * eg. space taken up for user and group quotas, number of dquots currently
123  * incore.
124  */
125 #define FS_QSTAT_VERSION        1       /* fs_quota_stat.qs_version */
126
127 /*
128  * Some basic infomation about 'quota files'.
129  */
130 typedef struct fs_qfilestat {
131         __u64 qfs_ino;          /* inode number */
132         __u64 qfs_nblks;        /* number of BBs 512-byte-blks */
133         __u32 qfs_nextents;     /* number of extents */
134 } fs_qfilestat_t;
135
136 typedef struct fs_quota_stat {
137         __s8 qs_version;        /* version number for future changes */
138         __u16 qs_flags;         /* XFS_QUOTA_{U,P,G}DQ_{ACCT,ENFD} */
139         __s8 qs_pad;            /* unused */
140         fs_qfilestat_t qs_uquota;       /* user quota storage information */
141         fs_qfilestat_t qs_gquota;       /* group quota storage information */
142         __u32 qs_incoredqs;     /* number of dquots incore */
143         __s32 qs_btimelimit;    /* limit for blks timer */
144         __s32 qs_itimelimit;    /* limit for inodes timer */
145         __s32 qs_rtbtimelimit;  /* limit for rt blks timer */
146         __u16 qs_bwarnlimit;    /* limit for num warnings */
147         __u16 qs_iwarnlimit;    /* limit for num warnings */
148 } fs_quota_stat_t;
149
150 #endif /* _QUOTAIO_XFS_H */