1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
2 * vim:expandtab:shiftwidth=8:tabstop=8:
6 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License version 2 only,
10 * as published by the Free Software Foundation.
12 * This program is distributed in the hope that it will be useful, but
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * General Public License version 2 for more details (a copy is included
16 * in the LICENSE file that accompanied this code).
18 * You should have received a copy of the GNU General Public License
19 * version 2 along with this program; If not, see
20 * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
22 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
23 * CA 95054 USA or visit www.sun.com if you need additional information or
29 * Copyright 2008 Sun Microsystems, Inc. All rights reserved
30 * Use is subject to license terms.
33 * This file is part of Lustre, http://www.lustre.org/
34 * Lustre is a trademark of Sun Microsystems, Inc.
37 #ifndef _LUSTRE_QUOTA_H
38 #define _LUSTRE_QUOTA_H
40 #if defined(__linux__)
41 #include <linux/lustre_quota.h>
42 #elif defined(__APPLE__)
43 #include <darwin/lustre_quota.h>
44 #elif defined(__WINNT__)
45 #include <winnt/lustre_quota.h>
47 #error Unsupported operating system.
50 #include <lustre_net.h>
51 #include <lustre/lustre_idl.h>
53 #include <obd_support.h>
54 #include <class_hash.h>
63 #ifdef HAVE_QUOTA_SUPPORT
69 LQUOTA_FIRST_STAT = 0,
70 /* these four are for measuring quota requests, for both of
71 * quota master and quota slaves */
72 LQUOTA_SYNC_ACQ = LQUOTA_FIRST_STAT,
76 /* these four measure how much time I/O threads spend on dealing
77 * with quota before and after writing data or creating files,
78 * only for quota slaves(lquota_chkquota and lquota_pending_commit) */
79 LQUOTA_WAIT_FOR_CHK_BLK,
80 LQUOTA_WAIT_FOR_CHK_INO,
81 LQUOTA_WAIT_FOR_COMMIT_BLK,
82 LQUOTA_WAIT_FOR_COMMIT_INO,
83 /* these two are for measuring time waiting return of quota reqs
84 * (qctxt_wait_pending_dqacq), only for quota salves */
85 LQUOTA_WAIT_PENDING_BLK_QUOTA,
86 LQUOTA_WAIT_PENDING_INO_QUOTA,
87 /* these two are for those when they are calling
88 * qctxt_wait_pending_dqacq, the quota req has returned already,
89 * only for quota salves */
90 LQUOTA_NOWAIT_PENDING_BLK_QUOTA,
91 LQUOTA_NOWAIT_PENDING_INO_QUOTA,
92 /* these are for quota ctl */
94 /* these are for adjust quota qunit, for both of
95 * quota master and quota slaves */
101 /* structures to access admin quotafile */
102 struct lustre_mem_dqinfo {
103 unsigned int dqi_bgrace;
104 unsigned int dqi_igrace;
105 unsigned long dqi_flags;
106 unsigned int dqi_blocks;
107 unsigned int dqi_free_blk;
108 unsigned int dqi_free_entry;
111 struct lustre_quota_info {
112 struct file *qi_files[MAXQUOTAS];
113 struct lustre_mem_dqinfo qi_info[MAXQUOTAS];
114 lustre_quota_version_t qi_version;
117 #define DQ_STATUS_AVAIL 0x0 /* Available dquot */
118 #define DQ_STATUS_SET 0x01 /* Sombody is setting dquot */
119 #define DQ_STATUS_RECOVERY 0x02 /* dquot is in recovery */
121 struct lustre_mem_dqblk {
122 __u64 dqb_bhardlimit; /* absolute limit on disk blks alloc */
123 __u64 dqb_bsoftlimit; /* preferred limit on disk blks */
124 __u64 dqb_curspace; /* current used space */
125 __u64 dqb_ihardlimit; /* absolute limit on allocated inodes */
126 __u64 dqb_isoftlimit; /* preferred inode limit */
127 __u64 dqb_curinodes; /* current # allocated inodes */
128 time_t dqb_btime; /* time limit for excessive disk use */
129 time_t dqb_itime; /* time limit for excessive inode use */
132 struct lustre_dquot {
133 /* Hash list in memory, protect by dquot_hash_lock */
134 struct list_head dq_hash;
135 /* Protect the data in lustre_dquot */
136 struct semaphore dq_sem;
139 /* Pointer of quota info it belongs to */
140 struct lustre_quota_info *dq_info;
142 loff_t dq_off; /* Offset of dquot on disk */
143 unsigned int dq_id; /* ID this applies to (uid, gid) */
144 int dq_type; /* Type fo quota (USRQUOTA, GRPQUOUTA) */
145 unsigned short dq_status; /* See DQ_STATUS_ */
146 unsigned long dq_flags; /* See DQ_ in quota.h */
147 struct lustre_mem_dqblk dq_dqb; /* Diskquota usage */
151 struct list_head di_link;
156 #define QFILE_RD_INFO 2
157 #define QFILE_WR_INFO 3
158 #define QFILE_INIT_INFO 4
159 #define QFILE_RD_DQUOT 5
160 #define QFILE_WR_DQUOT 6
161 #define QFILE_CONVERT 7
163 /* admin quotafile operations */
164 int lustre_check_quota_file(struct lustre_quota_info *lqi, int type);
165 int lustre_read_quota_info(struct lustre_quota_info *lqi, int type);
166 int lustre_write_quota_info(struct lustre_quota_info *lqi, int type);
167 int lustre_read_dquot(struct lustre_dquot *dquot);
168 int lustre_commit_dquot(struct lustre_dquot *dquot);
169 int lustre_init_quota_info(struct lustre_quota_info *lqi, int type);
170 int lustre_get_qids(struct file *file, struct inode *inode, int type,
171 struct list_head *list);
172 int lustre_quota_convert(struct lustre_quota_info *lqi, int type);
174 #define LL_DQUOT_OFF(sb) DQUOT_OFF(sb)
176 typedef int (*dqacq_handler_t) (struct obd_device * obd, struct qunit_data * qd,
179 /* user quota is turned on on filter */
180 #define LQC_USRQUOTA_FLAG (1 << 0)
181 /* group quota is turned on on filter */
182 #define LQC_GRPQUOTA_FLAG (1 << 1)
184 #define UGQUOTA2LQC(id) ((Q_TYPEMATCH(id, USRQUOTA) ? LQC_USRQUOTA_FLAG : 0) | \
185 (Q_TYPEMATCH(id, GRPQUOTA) ? LQC_GRPQUOTA_FLAG : 0))
187 struct lustre_quota_ctxt {
188 struct super_block *lqc_sb; /* superblock this applies to */
189 struct obd_import *lqc_import; /* import used to send dqacq/dqrel RPC */
190 dqacq_handler_t lqc_handler; /* dqacq/dqrel RPC handler, only for quota master */
191 unsigned long lqc_flags; /* quota flags */
192 unsigned long lqc_recovery:1, /* Doing recovery */
193 lqc_switch_qs:1, /* the function of change qunit size
195 lqc_valid:1, /* this qctxt is valid or not */
196 lqc_setup:1; /* tell whether of not quota_type has
197 * been processed, so that the master
198 * knows when it can start processing
199 * incoming acq/rel quota requests */
200 unsigned long lqc_iunit_sz; /* original unit size of file quota and
201 * upper limitation for adjust file
203 unsigned long lqc_itune_sz; /* Trigger dqacq when available file
204 * quota less than this value, trigger
205 * dqrel when available file quota
206 * more than this value + 1 iunit */
207 unsigned long lqc_bunit_sz; /* original unit size of block quota and
208 * upper limitation for adjust block
210 unsigned long lqc_btune_sz; /* See comment of lqc_itune_sz */
211 struct lustre_hash *lqc_lqs_hash; /* all lustre_qunit_size structures */
213 /* the values below are relative to how master change its qunit sizes */
214 unsigned long lqc_cqs_boundary_factor; /* this affects the boundary of
215 * shrinking and enlarging qunit
217 unsigned long lqc_cqs_least_bunit; /* the least value of block qunit */
218 unsigned long lqc_cqs_least_iunit; /* the least value of inode qunit */
219 unsigned long lqc_cqs_qs_factor; /* when enlarging, qunit size will
220 * mutilple it; when shrinking,
221 * qunit size will divide it */
222 int lqc_switch_seconds; /* avoid ping-pong effect of
223 * adjusting qunit size. How many
224 * seconds must be waited between
225 * enlarging and shinking qunit */
226 int lqc_sync_blk; /* when blk qunit reaches this value,
227 * later write reqs from client
228 * should be sync b=16642 */
229 spinlock_t lqc_lock; /* guard lqc_imp_valid now */
230 cfs_waitq_t lqc_wait_for_qmaster; /* when mds isn't connected, threads
231 * on osts who send the quota reqs
232 * with wait==1 will be put here
234 struct proc_dir_entry *lqc_proc_dir;
235 struct lprocfs_stats *lqc_stats; /* lquota statistics */
237 atomic_t lqc_lqs; /* the number of used hashed lqs */
238 cfs_waitq_t lqc_lqs_waitq; /* no lqs are in use */
241 #define QUOTA_MASTER_READY(qctxt) (qctxt)->lqc_setup = 1
242 #define QUOTA_MASTER_UNREADY(qctxt) (qctxt)->lqc_setup = 0
244 struct lustre_qunit_size {
245 struct hlist_node lqs_hash; /* the hash entry */
246 unsigned int lqs_id; /* id of user/group */
247 unsigned long lqs_flags; /* is user/group; FULLBUF or LESSBUF */
248 unsigned long lqs_iunit_sz; /* Unit size of file quota currently */
249 unsigned long lqs_itune_sz; /* Trigger dqacq when available file quota
250 * less than this value, trigger dqrel
251 * when more than this value + 1 iunit */
252 unsigned long lqs_bunit_sz; /* Unit size of block quota currently */
253 unsigned long lqs_btune_sz; /* See comment of lqs itune sz */
254 unsigned long lqs_bwrite_pending; /* the blocks reached ost and don't
256 unsigned long lqs_iwrite_pending; /* the inodes reached mds and don't
258 long long lqs_ino_rec; /* when inodes are allocated/released,
259 * this value will record it */
260 long long lqs_blk_rec; /* when blocks are allocated/released,
261 * this value will record it */
262 atomic_t lqs_refcount;
263 cfs_time_t lqs_last_bshrink; /* time of last block shrink */
264 cfs_time_t lqs_last_ishrink; /* time of last inode shrink */
266 struct quota_adjust_qunit lqs_key; /* hash key */
267 struct lustre_quota_ctxt *lqs_ctxt; /* quota ctxt */
270 #define LQS_IS_GRP(lqs) ((lqs)->lqs_flags & LQUOTA_FLAGS_GRP)
271 #define LQS_IS_ADJBLK(lqs) ((lqs)->lqs_flags & LQUOTA_FLAGS_ADJBLK)
272 #define LQS_IS_ADJINO(lqs) ((lqs)->lqs_flags & LQUOTA_FLAGS_ADJINO)
274 #define LQS_SET_GRP(lqs) ((lqs)->lqs_flags |= LQUOTA_FLAGS_GRP)
275 #define LQS_SET_ADJBLK(lqs) ((lqs)->lqs_flags |= LQUOTA_FLAGS_ADJBLK)
276 #define LQS_SET_ADJINO(lqs) ((lqs)->lqs_flags |= LQUOTA_FLAGS_ADJINO)
278 static inline void lqs_getref(struct lustre_qunit_size *lqs)
280 if (atomic_inc_return(&lqs->lqs_refcount) == 2) /* quota_create_lqs */
281 atomic_inc(&lqs->lqs_ctxt->lqc_lqs);
283 CDEBUG(D_QUOTA, "lqs=%p refcount %d\n",
284 lqs, atomic_read(&lqs->lqs_refcount));
287 static inline void lqs_putref(struct lustre_qunit_size *lqs)
289 LASSERT(atomic_read(&lqs->lqs_refcount) > 0);
291 /* killing last ref, let's let hash table kill it */
292 if (atomic_read(&lqs->lqs_refcount) == 1) {
293 lustre_hash_del(lqs->lqs_ctxt->lqc_lqs_hash,
294 &lqs->lqs_key, &lqs->lqs_hash);
297 if (atomic_dec_return(&lqs->lqs_refcount) == 1)
298 if (atomic_dec_and_test(&lqs->lqs_ctxt->lqc_lqs))
299 cfs_waitq_signal(&lqs->lqs_ctxt->lqc_lqs_waitq);
300 CDEBUG(D_QUOTA, "lqs=%p refcount %d\n",
301 lqs, atomic_read(&lqs->lqs_refcount));
306 static inline void lqs_initref(struct lustre_qunit_size *lqs)
308 atomic_set(&lqs->lqs_refcount, 0);
313 struct lustre_quota_info {
316 struct lustre_quota_ctxt {
319 #endif /* !__KERNEL__ */
323 #define LL_DQUOT_OFF(sb) do {} while(0)
325 struct lustre_quota_info {
328 struct lustre_quota_ctxt {
331 #define QUOTA_MASTER_READY(qctxt)
332 #define QUOTA_MASTER_UNREADY(qctxt)
334 #endif /* !HAVE_QUOTA_SUPPORT */
336 /* If the (quota limit < qunit * slave count), the slave which can't
337 * acquire qunit should set it's local limit as MIN_QLIMIT */
340 struct quotacheck_thread_args {
341 struct obd_export *qta_exp; /* obd export */
342 struct obd_quotactl qta_oqctl; /* obd_quotactl args */
343 struct super_block *qta_sb; /* obd super block */
344 atomic_t *qta_sem; /* obt_quotachecking */
347 struct obd_trans_info;
348 typedef int (*quota_acquire)(struct obd_device *obd, unsigned int uid,
349 unsigned int gid, struct obd_trans_info *oti);
352 int (*quota_init) (void);
353 int (*quota_exit) (void);
354 int (*quota_setup) (struct obd_device *);
355 int (*quota_cleanup) (struct obd_device *);
356 /* For quota master, close admin quota files */
357 int (*quota_fs_cleanup) (struct obd_device *);
358 int (*quota_ctl) (struct obd_export *, struct obd_quotactl *);
359 int (*quota_check) (struct obd_export *, struct obd_quotactl *);
360 int (*quota_recovery) (struct obd_device *);
362 /* For quota master/slave, adjust quota limit after fs operation */
363 int (*quota_adjust) (struct obd_device *, unsigned int[],
364 unsigned int[], int, int);
366 /* For quota slave, set import, trigger quota recovery */
367 int (*quota_setinfo) (struct obd_export *, struct obd_device *);
369 /* For quota slave, clear import when relative import is invalid */
370 int (*quota_clearinfo) (struct obd_export *, struct obd_device *);
372 /* For quota slave, set proper thread resoure capability */
373 int (*quota_enforce) (struct obd_device *, unsigned int);
375 /* For quota slave, check whether specified uid/gid is over quota */
376 int (*quota_getflag) (struct obd_device *, struct obdo *);
378 /* For quota slave, acquire/release quota from master if needed */
379 int (*quota_acquire) (struct obd_device *, unsigned int, unsigned int,
380 struct obd_trans_info *);
382 /* For quota slave, check whether specified uid/gid's remaining quota
383 * can finish a block_write or inode_create rpc. It updates the pending
384 * record of block and inode, acquires quota if necessary */
385 int (*quota_chkquota) (struct obd_device *, unsigned int, unsigned int,
386 int, int *, quota_acquire,
387 struct obd_trans_info *, struct inode *, int);
389 /* For quota client, the actions after the pending write is committed */
390 int (*quota_pending_commit) (struct obd_device *, unsigned int,
393 /* For quota client, poll if the quota check done */
394 int (*quota_poll_check) (struct obd_export *, struct if_quotacheck *);
396 /* For quota client, check whether specified uid/gid is over quota */
397 int (*quota_chkdq) (struct client_obd *, unsigned int, unsigned int);
399 /* For quota client, set over quota flag for specifed uid/gid */
400 int (*quota_setdq) (struct client_obd *, unsigned int, unsigned int,
403 /* For adjusting qunit size b=10600 */
404 int (*quota_adjust_qunit) (struct obd_export *exp,
405 struct quota_adjust_qunit *oqaq,
406 struct lustre_quota_ctxt *qctxt);
410 #define Q_COPY(out, in, member) (out)->member = (in)->member
412 #define QUOTA_OP(interface, op) interface->quota_ ## op
414 #define QUOTA_CHECK_OP(interface, op) \
418 if (!QUOTA_OP(interface, op)) { \
419 CERROR("no quota operation: " #op "\n"); \
420 RETURN(-EOPNOTSUPP); \
424 static inline int lquota_init(quota_interface_t *interface)
429 QUOTA_CHECK_OP(interface, init);
430 rc = QUOTA_OP(interface, init)();
434 static inline int lquota_exit(quota_interface_t *interface)
439 QUOTA_CHECK_OP(interface, exit);
440 rc = QUOTA_OP(interface, exit)();
444 static inline int lquota_setup(quota_interface_t *interface,
445 struct obd_device *obd)
450 QUOTA_CHECK_OP(interface, setup);
451 rc = QUOTA_OP(interface, setup)(obd);
455 static inline int lquota_cleanup(quota_interface_t *interface,
456 struct obd_device *obd)
461 QUOTA_CHECK_OP(interface, cleanup);
462 rc = QUOTA_OP(interface, cleanup)(obd);
466 static inline int lquota_fs_cleanup(quota_interface_t *interface,
467 struct obd_device *obd)
472 QUOTA_CHECK_OP(interface, fs_cleanup);
473 rc = QUOTA_OP(interface, fs_cleanup)(obd);
477 static inline int lquota_recovery(quota_interface_t *interface,
478 struct obd_device *obd)
483 QUOTA_CHECK_OP(interface, recovery);
484 rc = QUOTA_OP(interface, recovery)(obd);
488 static inline int lquota_adjust(quota_interface_t *interface,
489 struct obd_device *obd,
490 unsigned int qcids[],
491 unsigned int qpids[],
497 QUOTA_CHECK_OP(interface, adjust);
498 ret = QUOTA_OP(interface, adjust)(obd, qcids, qpids, rc, opc);
502 static inline int lquota_chkdq(quota_interface_t *interface,
503 struct client_obd *cli,
504 unsigned int uid, unsigned int gid)
509 QUOTA_CHECK_OP(interface, chkdq);
510 rc = QUOTA_OP(interface, chkdq)(cli, uid, gid);
514 static inline int lquota_setdq(quota_interface_t *interface,
515 struct client_obd *cli,
516 unsigned int uid, unsigned int gid,
517 obd_flag valid, obd_flag flags)
522 QUOTA_CHECK_OP(interface, setdq);
523 rc = QUOTA_OP(interface, setdq)(cli, uid, gid, valid, flags);
527 static inline int lquota_poll_check(quota_interface_t *interface,
528 struct obd_export *exp,
529 struct if_quotacheck *qchk)
534 QUOTA_CHECK_OP(interface, poll_check);
535 rc = QUOTA_OP(interface, poll_check)(exp, qchk);
539 static inline int lquota_setinfo(quota_interface_t *interface,
540 struct obd_export *exp,
541 struct obd_device *obd)
546 QUOTA_CHECK_OP(interface, setinfo);
547 rc = QUOTA_OP(interface, setinfo)(exp, obd);
551 static inline int lquota_clearinfo(quota_interface_t *interface,
552 struct obd_export *exp,
553 struct obd_device *obd)
558 QUOTA_CHECK_OP(interface, clearinfo);
559 rc = QUOTA_OP(interface, clearinfo)(exp, obd);
563 static inline int lquota_enforce(quota_interface_t *interface,
564 struct obd_device *obd,
570 QUOTA_CHECK_OP(interface, enforce);
571 rc = QUOTA_OP(interface, enforce)(obd, ignore);
575 static inline int lquota_getflag(quota_interface_t *interface,
576 struct obd_device *obd, struct obdo *oa)
581 QUOTA_CHECK_OP(interface, getflag);
582 rc = QUOTA_OP(interface, getflag)(obd, oa);
587 static inline int lquota_acquire(quota_interface_t *interface,
588 struct obd_device *obd,
589 unsigned int uid, unsigned int gid,
590 struct obd_trans_info *oti)
595 QUOTA_CHECK_OP(interface, acquire);
596 rc = QUOTA_OP(interface, acquire)(obd, uid, gid, oti);
600 static inline int lquota_chkquota(quota_interface_t *interface,
601 struct obd_device *obd,
602 unsigned int uid, unsigned int gid, int count,
603 int *flag, struct obd_trans_info *oti,
604 struct inode *inode, int frags)
609 QUOTA_CHECK_OP(interface, chkquota);
610 QUOTA_CHECK_OP(interface, acquire);
611 rc = QUOTA_OP(interface, chkquota)(obd, uid, gid, count, flag,
612 QUOTA_OP(interface, acquire), oti,
617 static inline int lquota_pending_commit(quota_interface_t *interface,
618 struct obd_device *obd,
619 unsigned int uid, unsigned int gid,
625 QUOTA_CHECK_OP(interface, pending_commit);
626 rc = QUOTA_OP(interface, pending_commit)(obd, uid, gid, pending);
632 extern quota_interface_t osc_quota_interface;
633 extern quota_interface_t mdc_quota_interface;
634 extern quota_interface_t lov_quota_interface;
650 #define LUSTRE_ADMIN_QUOTAFILES_V1 {\
651 "admin_quotafile.usr", /* user admin quotafile */\
652 "admin_quotafile.grp" /* group admin quotafile */\
655 #define LUSTRE_ADMIN_QUOTAFILES_V2 {\
656 "admin_quotafile_v2.usr", /* user admin quotafile */\
657 "admin_quotafile_v2.grp" /* group admin quotafile */\
660 #endif /* _LUSTRE_QUOTA_H */