Whamcloud - gitweb
a943ec61f58ec1f7cef66765a205a3a90e50062f
[tools/e2fsprogs.git] / lib / quota / quota.h
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 _LINUX_QUOTA_
34 #define _LINUX_QUOTA_
35
36 #include <errno.h>
37 #include <sys/types.h>
38 #include <ext2fs/ext2_types.h>
39
40 #define __DQUOT_VERSION__       "dquot_6.5.2"
41
42 typedef u_int32_t qid_t;        /* Type in which we store ids in memory */
43 typedef int64_t qsize_t;        /* Type in which we store size limitations */
44
45 #define MAXQUOTAS 2
46 #define USRQUOTA  0             /* element used for user quotas */
47 #define GRPQUOTA  1             /* element used for group quotas */
48
49 /*
50  * Definitions for the default names of the quotas files.
51  */
52 #define INITQFNAMES { \
53         "user",    /* USRQUOTA */ \
54         "group",   /* GRPQUOTA */ \
55         "undefined", \
56 };
57
58 /*
59  * Definitions of magics and versions of current quota files
60  */
61 #define INITQMAGICS {\
62         0xd9c01f11,     /* USRQUOTA */\
63         0xd9c01927      /* GRPQUOTA */\
64 }
65
66 /* Size of blocks in which are counted size limits in generic utility parts */
67 #define QUOTABLOCK_BITS 10
68 #define QUOTABLOCK_SIZE (1 << QUOTABLOCK_BITS)
69
70 /* Conversion routines from and to quota blocks */
71 #define qb2kb(x) ((x) << (QUOTABLOCK_BITS-10))
72 #define kb2qb(x) ((x) >> (QUOTABLOCK_BITS-10))
73 #define toqb(x) (((x) + QUOTABLOCK_SIZE - 1) >> QUOTABLOCK_BITS)
74
75 /*
76  * Command definitions for the 'quotactl' system call.
77  * The commands are broken into a main command defined below
78  * and a subcommand that is used to convey the type of
79  * quota that is being manipulated (see above).
80  */
81 #define SUBCMDMASK  0x00ff
82 #define SUBCMDSHIFT 8
83 #define QCMD(cmd, type)  (((cmd) << SUBCMDSHIFT) | ((type) & SUBCMDMASK))
84
85 #define Q_SYNC     0x800001     /* sync disk copy of a filesystems quotas */
86 #define Q_QUOTAON  0x800002     /* turn quotas on */
87 #define Q_QUOTAOFF 0x800003     /* turn quotas off */
88 #define Q_GETFMT   0x800004     /* get quota format used on given filesystem */
89 #define Q_GETINFO  0x800005     /* get information about quota files */
90 #define Q_SETINFO  0x800006     /* set information about quota files */
91 #define Q_GETQUOTA 0x800007     /* get user quota structure */
92 #define Q_SETQUOTA 0x800008     /* set user quota structure */
93
94 /* Quota format type IDs */
95 #define QFMT_VFS_OLD 1
96 #define QFMT_VFS_V0 2
97 #define QFMT_OCFS2 3
98 #define QFMT_VFS_V1 4
99
100 /* Size of block in which space limits are passed through the quota
101  * interface */
102 #define QIF_DQBLKSIZE_BITS 10
103 #define QIF_DQBLKSIZE (1 << QIF_DQBLKSIZE_BITS)
104
105 /*
106  * Structure used for setting quota information about file via quotactl
107  * Following flags are used to specify which fields are valid
108  */
109 #define IIF_BGRACE      1
110 #define IIF_IGRACE      2
111 #define IIF_FLAGS       4
112 #define IIF_ALL         (IIF_BGRACE | IIF_IGRACE | IIF_FLAGS)
113
114 struct if_dqinfo {
115         __u64 dqi_bgrace;
116         __u64 dqi_igrace;
117         __u32 dqi_flags;
118         __u32 dqi_valid;
119 };
120
121 /*
122  * Definitions for quota netlink interface
123  */
124 #define QUOTA_NL_NOWARN 0
125 #define QUOTA_NL_IHARDWARN 1            /* Inode hardlimit reached */
126 #define QUOTA_NL_ISOFTLONGWARN 2        /* Inode grace time expired */
127 #define QUOTA_NL_ISOFTWARN 3            /* Inode softlimit reached */
128 #define QUOTA_NL_BHARDWARN 4            /* Block hardlimit reached */
129 #define QUOTA_NL_BSOFTLONGWARN 5        /* Block grace time expired */
130 #define QUOTA_NL_BSOFTWARN 6            /* Block softlimit reached */
131 #define QUOTA_NL_IHARDBELOW 7           /* Usage got below inode hardlimit */
132 #define QUOTA_NL_ISOFTBELOW 8           /* Usage got below inode softlimit */
133 #define QUOTA_NL_BHARDBELOW 9           /* Usage got below block hardlimit */
134 #define QUOTA_NL_BSOFTBELOW 10          /* Usage got below block softlimit */
135
136 enum {
137         QUOTA_NL_C_UNSPEC,
138         QUOTA_NL_C_WARNING,
139         __QUOTA_NL_C_MAX,
140 };
141 #define QUOTA_NL_C_MAX (__QUOTA_NL_C_MAX - 1)
142
143 enum {
144         QUOTA_NL_A_UNSPEC,
145         QUOTA_NL_A_QTYPE,
146         QUOTA_NL_A_EXCESS_ID,
147         QUOTA_NL_A_WARNING,
148         QUOTA_NL_A_DEV_MAJOR,
149         QUOTA_NL_A_DEV_MINOR,
150         QUOTA_NL_A_CAUSED_ID,
151         __QUOTA_NL_A_MAX,
152 };
153 #define QUOTA_NL_A_MAX (__QUOTA_NL_A_MAX - 1)
154
155 #endif /* _QUOTA_ */