xref: /netbsd/sys/ufs/ufs/quota.h (revision 6550d01e)
1 /*	$NetBSD: quota.h,v 1.25 2007/07/10 09:50:08 hannken Exp $	*/
2 
3 /*
4  * Copyright (c) 1982, 1986, 1993
5  *	The Regents of the University of California.  All rights reserved.
6  *
7  * This code is derived from software contributed to Berkeley by
8  * Robert Elz at The University of Melbourne.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in the
17  *    documentation and/or other materials provided with the distribution.
18  * 3. Neither the name of the University nor the names of its contributors
19  *    may be used to endorse or promote products derived from this software
20  *    without specific prior written permission.
21  *
22  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32  * SUCH DAMAGE.
33  *
34  *	@(#)quota.h	8.3 (Berkeley) 8/19/94
35  */
36 
37 #ifndef	_UFS_UFS_QUOTA_H_
38 #define	_UFS_UFS_QUOTA_H_
39 
40 /*
41  * Definitions for disk quotas imposed on the average user
42  * (big brother finally hits UNIX).
43  *
44  * The following constants define the amount of time given a user before the
45  * soft limits are treated as hard limits (usually resulting in an allocation
46  * failure). The timer is started when the user crosses their soft limit, it
47  * is reset when they go below their soft limit.
48  */
49 #define	MAX_IQ_TIME	(7*24*60*60)	/* seconds in 1 week */
50 #define	MAX_DQ_TIME	(7*24*60*60)	/* seconds in 1 week */
51 
52 /*
53  * The following constants define the usage of the quota file array in the
54  * ufsmount structure and dquot array in the inode structure.  The semantics
55  * of the elements of these arrays are defined in the routine getinoquota;
56  * the remainder of the quota code treats them generically and need not be
57  * inspected when changing the size of the array.
58  */
59 #define	MAXQUOTAS	2
60 #define	USRQUOTA	0	/* element used for user quotas */
61 #define	GRPQUOTA	1	/* element used for group quotas */
62 
63 /*
64  * Definitions for the default names of the quotas files.
65  */
66 #define INITQFNAMES { \
67 	"user",		/* USRQUOTA */ \
68 	"group",	/* GRPQUOTA */ \
69 	"undefined", \
70 }
71 #define	QUOTAFILENAME	"quota"
72 #define	QUOTAGROUP	"operator"
73 
74 /*
75  * Command definitions for the 'quotactl' system call.  The commands are
76  * broken into a main command defined below and a subcommand that is used
77  * to convey the type of quota that is being manipulated (see above).
78  */
79 #define SUBCMDMASK	0x00ff
80 #define SUBCMDSHIFT	8
81 #define	QCMD(cmd, type)	(((cmd) << SUBCMDSHIFT) | ((type) & SUBCMDMASK))
82 
83 #define	Q_QUOTAON	0x0100	/* enable quotas */
84 #define	Q_QUOTAOFF	0x0200	/* disable quotas */
85 #define	Q_GETQUOTA	0x0300	/* get limits and usage */
86 #define	Q_SETQUOTA	0x0400	/* set limits and usage */
87 #define	Q_SETUSE	0x0500	/* set usage */
88 #define	Q_SYNC		0x0600	/* sync disk copy of a filesystems quotas */
89 
90 /*
91  * The following structure defines the format of the disk quota file
92  * (as it appears on disk) - the file is an array of these structures
93  * indexed by user or group number.  The setquota system call establishes
94  * the vnode for each quota file (a pointer is retained in the ufsmount
95  * structure).
96  */
97 struct dqblk {
98 	u_int32_t dqb_bhardlimit;	/* absolute limit on disk blks alloc */
99 	u_int32_t dqb_bsoftlimit;	/* preferred limit on disk blks */
100 	u_int32_t dqb_curblocks;	/* current block count */
101 	u_int32_t dqb_ihardlimit;	/* maximum # allocated inodes + 1 */
102 	u_int32_t dqb_isoftlimit;	/* preferred inode limit */
103 	u_int32_t dqb_curinodes;	/* current # allocated inodes */
104 	int32_t	  dqb_btime;		/* time limit for excessive disk use */
105 	int32_t	  dqb_itime;		/* time limit for excessive files */
106 };
107 
108 #ifdef _KERNEL
109 
110 #include <sys/cdefs.h>
111 
112 __BEGIN_DECLS
113 void	dqinit(void);
114 void	dqreinit(void);
115 void	dqdone(void);
116 __END_DECLS
117 #else
118 __BEGIN_DECLS
119 int quotactl(const char *, int , int, void *);
120 __END_DECLS
121 #endif /* _KERNEL */
122 
123 #endif /* !_UFS_UFS_QUOTA_H_ */
124