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 #ifndef QUOTABLOCK_BITS
64 #define QUOTABLOCK_BITS 10
67 #ifndef QUOTABLOCK_SIZE
68 #define QUOTABLOCK_SIZE (1 << QUOTABLOCK_BITS)
72 #define toqb(x) (((x) + QUOTABLOCK_SIZE - 1) >> QUOTABLOCK_BITS)
75 #ifdef HAVE_QUOTA_SUPPORT
78 #define MAX_IQ_TIME 604800 /* (7*24*60*60) 1 week */
82 #define MAX_DQ_TIME 604800 /* (7*24*60*60) 1 week */
89 LQUOTA_FIRST_STAT = 0,
90 /* these four are for measuring quota requests, for both of
91 * quota master and quota slaves */
92 LQUOTA_SYNC_ACQ = LQUOTA_FIRST_STAT,
96 /* these four measure how much time I/O threads spend on dealing
97 * with quota before and after writing data or creating files,
98 * only for quota slaves(lquota_chkquota and lquota_pending_commit) */
99 LQUOTA_WAIT_FOR_CHK_BLK,
100 LQUOTA_WAIT_FOR_CHK_INO,
101 LQUOTA_WAIT_FOR_COMMIT_BLK,
102 LQUOTA_WAIT_FOR_COMMIT_INO,
103 /* these two are for measuring time waiting return of quota reqs
104 * (qctxt_wait_pending_dqacq), only for quota salves */
105 LQUOTA_WAIT_PENDING_BLK_QUOTA,
106 LQUOTA_WAIT_PENDING_INO_QUOTA,
107 /* these two are for those when they are calling
108 * qctxt_wait_pending_dqacq, the quota req has returned already,
109 * only for quota salves */
110 LQUOTA_NOWAIT_PENDING_BLK_QUOTA,
111 LQUOTA_NOWAIT_PENDING_INO_QUOTA,
112 /* these are for quota ctl */
114 /* these are for adjust quota qunit, for both of
115 * quota master and quota slaves */
121 /* structures to access admin quotafile */
122 struct lustre_mem_dqinfo {
123 unsigned int dqi_bgrace;
124 unsigned int dqi_igrace;
125 unsigned long dqi_flags;
126 unsigned int dqi_blocks;
127 unsigned int dqi_free_blk;
128 unsigned int dqi_free_entry;
131 struct lustre_quota_info {
132 struct file *qi_files[MAXQUOTAS];
133 struct lustre_mem_dqinfo qi_info[MAXQUOTAS];
134 lustre_quota_version_t qi_version;
137 #define DQ_STATUS_AVAIL 0x0 /* Available dquot */
138 #define DQ_STATUS_SET 0x01 /* Sombody is setting dquot */
139 #define DQ_STATUS_RECOVERY 0x02 /* dquot is in recovery */
141 struct lustre_mem_dqblk {
142 __u64 dqb_bhardlimit; /* absolute limit on disk blks alloc */
143 __u64 dqb_bsoftlimit; /* preferred limit on disk blks */
144 __u64 dqb_curspace; /* current used space */
145 __u64 dqb_ihardlimit; /* absolute limit on allocated inodes */
146 __u64 dqb_isoftlimit; /* preferred inode limit */
147 __u64 dqb_curinodes; /* current # allocated inodes */
148 time_t dqb_btime; /* time limit for excessive disk use */
149 time_t dqb_itime; /* time limit for excessive inode use */
152 struct lustre_dquot {
153 /* Hash list in memory, protect by dquot_hash_lock */
154 struct list_head dq_hash;
155 /* Protect the data in lustre_dquot */
156 struct semaphore dq_sem;
159 /* Pointer of quota info it belongs to */
160 struct lustre_quota_info *dq_info;
162 loff_t dq_off; /* Offset of dquot on disk */
163 unsigned int dq_id; /* ID this applies to (uid, gid) */
164 int dq_type; /* Type fo quota (USRQUOTA, GRPQUOUTA) */
165 unsigned short dq_status; /* See DQ_STATUS_ */
166 unsigned long dq_flags; /* See DQ_ in quota.h */
167 struct lustre_mem_dqblk dq_dqb; /* Diskquota usage */
171 struct list_head di_link;
175 /* set inode quota limitation on a quota uid/gid */
176 #define QI_SET (1 << 30)
177 /* set block quota limitation on a quota uid/gid */
178 #define QB_SET (1 << 31)
181 #define QFILE_RD_INFO 2
182 #define QFILE_WR_INFO 3
183 #define QFILE_INIT_INFO 4
184 #define QFILE_RD_DQUOT 5
185 #define QFILE_WR_DQUOT 6
186 #define QFILE_CONVERT 7
188 /* admin quotafile operations */
189 int lustre_check_quota_file(struct lustre_quota_info *lqi, int type);
190 int lustre_read_quota_info(struct lustre_quota_info *lqi, int type);
191 int lustre_write_quota_info(struct lustre_quota_info *lqi, int type);
192 int lustre_read_dquot(struct lustre_dquot *dquot);
193 int lustre_commit_dquot(struct lustre_dquot *dquot);
194 int lustre_init_quota_info(struct lustre_quota_info *lqi, int type);
195 int lustre_get_qids(struct file *file, struct inode *inode, int type,
196 struct list_head *list);
197 int lustre_quota_convert(struct lustre_quota_info *lqi, int type);
199 #ifdef HAVE_VFS_DQ_OFF
200 #define LL_DQUOT_OFF(sb, remount) vfs_dq_off(sb, remount)
202 #define LL_DQUOT_OFF(sb, remount) DQUOT_OFF(sb)
205 typedef int (*dqacq_handler_t) (struct obd_device * obd, struct qunit_data * qd,
208 /* user quota is turned on on filter */
209 #define LQC_USRQUOTA_FLAG (1 << 0)
210 /* group quota is turned on on filter */
211 #define LQC_GRPQUOTA_FLAG (1 << 1)
213 #define UGQUOTA2LQC(id) ((Q_TYPEMATCH(id, USRQUOTA) ? LQC_USRQUOTA_FLAG : 0) | \
214 (Q_TYPEMATCH(id, GRPQUOTA) ? LQC_GRPQUOTA_FLAG : 0))
216 struct lustre_quota_ctxt {
217 struct super_block *lqc_sb; /* superblock this applies to */
218 struct obd_import *lqc_import; /* import used to send dqacq/dqrel RPC */
219 dqacq_handler_t lqc_handler; /* dqacq/dqrel RPC handler, only for quota master */
220 unsigned long lqc_flags; /* quota flags */
221 unsigned long lqc_recovery:1, /* Doing recovery */
222 lqc_switch_qs:1, /* the function of change qunit size
224 lqc_valid:1, /* this qctxt is valid or not */
225 lqc_setup:1; /* tell whether of not quota_type has
226 * been processed, so that the master
227 * knows when it can start processing
228 * incoming acq/rel quota requests */
229 unsigned long lqc_iunit_sz; /* original unit size of file quota and
230 * upper limitation for adjust file
232 unsigned long lqc_itune_sz; /* Trigger dqacq when available file
233 * quota less than this value, trigger
234 * dqrel when available file quota
235 * more than this value + 1 iunit */
236 unsigned long lqc_bunit_sz; /* original unit size of block quota and
237 * upper limitation for adjust block
239 unsigned long lqc_btune_sz; /* See comment of lqc_itune_sz */
240 struct lustre_hash *lqc_lqs_hash; /* all lustre_qunit_size structures */
242 /* the values below are relative to how master change its qunit sizes */
243 unsigned long lqc_cqs_boundary_factor; /* this affects the boundary of
244 * shrinking and enlarging qunit
246 unsigned long lqc_cqs_least_bunit; /* the least value of block qunit */
247 unsigned long lqc_cqs_least_iunit; /* the least value of inode qunit */
248 unsigned long lqc_cqs_qs_factor; /* when enlarging, qunit size will
249 * mutilple it; when shrinking,
250 * qunit size will divide it */
251 int lqc_switch_seconds; /* avoid ping-pong effect of
252 * adjusting qunit size. How many
253 * seconds must be waited between
254 * enlarging and shinking qunit */
255 int lqc_sync_blk; /* when blk qunit reaches this value,
256 * later write reqs from client
257 * should be sync b=16642 */
258 spinlock_t lqc_lock; /* guard lqc_imp_valid now */
259 cfs_waitq_t lqc_wait_for_qmaster; /* when mds isn't connected, threads
260 * on osts who send the quota reqs
261 * with wait==1 will be put here
263 struct proc_dir_entry *lqc_proc_dir;
264 struct lprocfs_stats *lqc_stats; /* lquota statistics */
266 atomic_t lqc_lqs; /* the number of used hashed lqs */
267 cfs_waitq_t lqc_lqs_waitq; /* no lqs are in use */
270 #define QUOTA_MASTER_READY(qctxt) (qctxt)->lqc_setup = 1
271 #define QUOTA_MASTER_UNREADY(qctxt) (qctxt)->lqc_setup = 0
273 struct lustre_qunit_size {
274 struct hlist_node lqs_hash; /* the hash entry */
275 unsigned int lqs_id; /* id of user/group */
276 unsigned long lqs_flags; /* 31st bit is QB_SET, 30th bit is QI_SET
277 * other bits are same as LQUOTA_FLAGS_* */
278 unsigned long lqs_iunit_sz; /* Unit size of file quota currently */
279 unsigned long lqs_itune_sz; /* Trigger dqacq when available file quota
280 * less than this value, trigger dqrel
281 * when more than this value + 1 iunit */
282 unsigned long lqs_bunit_sz; /* Unit size of block quota currently */
283 unsigned long lqs_btune_sz; /* See comment of lqs itune sz */
284 unsigned long lqs_bwrite_pending; /* the blocks reached ost and don't
286 unsigned long lqs_iwrite_pending; /* the inodes reached mds and don't
288 long long lqs_ino_rec; /* when inodes are allocated/released,
289 * this value will record it */
290 long long lqs_blk_rec; /* when blocks are allocated/released,
291 * this value will record it */
292 atomic_t lqs_refcount;
293 cfs_time_t lqs_last_bshrink; /* time of last block shrink */
294 cfs_time_t lqs_last_ishrink; /* time of last inode shrink */
296 unsigned long long lqs_key; /* hash key */
297 struct lustre_quota_ctxt *lqs_ctxt; /* quota ctxt */
300 #define LQS_IS_GRP(lqs) ((lqs)->lqs_flags & LQUOTA_FLAGS_GRP)
301 #define LQS_IS_ADJBLK(lqs) ((lqs)->lqs_flags & LQUOTA_FLAGS_ADJBLK)
302 #define LQS_IS_ADJINO(lqs) ((lqs)->lqs_flags & LQUOTA_FLAGS_ADJINO)
304 #define LQS_SET_GRP(lqs) ((lqs)->lqs_flags |= LQUOTA_FLAGS_GRP)
305 #define LQS_SET_ADJBLK(lqs) ((lqs)->lqs_flags |= LQUOTA_FLAGS_ADJBLK)
306 #define LQS_SET_ADJINO(lqs) ((lqs)->lqs_flags |= LQUOTA_FLAGS_ADJINO)
308 /* In the hash for lustre_qunit_size, the key is decided by
309 * grp_or_usr and uid/gid, in here, I combine these two values,
310 * which will make comparing easier and more efficient */
311 #define LQS_KEY(is_grp, id) ((is_grp ? 1ULL << 32: 0) + id)
312 #define LQS_KEY_ID(key) (key & 0xffffffff)
313 #define LQS_KEY_GRP(key) (key >> 32)
315 static inline void lqs_getref(struct lustre_qunit_size *lqs)
317 if (atomic_inc_return(&lqs->lqs_refcount) == 2) /* quota_create_lqs */
318 atomic_inc(&lqs->lqs_ctxt->lqc_lqs);
320 CDEBUG(D_QUOTA, "lqs=%p refcount %d\n",
321 lqs, atomic_read(&lqs->lqs_refcount));
324 static inline void lqs_putref(struct lustre_qunit_size *lqs)
326 LASSERT(atomic_read(&lqs->lqs_refcount) > 0);
328 /* killing last ref, let's let hash table kill it */
329 if (atomic_read(&lqs->lqs_refcount) == 1) {
330 lustre_hash_del(lqs->lqs_ctxt->lqc_lqs_hash,
331 &lqs->lqs_key, &lqs->lqs_hash);
334 if (atomic_dec_return(&lqs->lqs_refcount) == 1)
335 if (atomic_dec_and_test(&lqs->lqs_ctxt->lqc_lqs))
336 cfs_waitq_signal(&lqs->lqs_ctxt->lqc_lqs_waitq);
337 CDEBUG(D_QUOTA, "lqs=%p refcount %d\n",
338 lqs, atomic_read(&lqs->lqs_refcount));
343 static inline void lqs_initref(struct lustre_qunit_size *lqs)
345 atomic_set(&lqs->lqs_refcount, 0);
350 struct lustre_quota_info {
353 struct lustre_quota_ctxt {
356 #endif /* !__KERNEL__ */
360 #define LL_DQUOT_OFF(sb, remount) do {} while(0)
362 struct lustre_quota_info {
365 struct lustre_quota_ctxt {
368 #define QUOTA_MASTER_READY(qctxt)
369 #define QUOTA_MASTER_UNREADY(qctxt)
371 #endif /* !HAVE_QUOTA_SUPPORT */
373 /* If the (quota limit < qunit * slave count), the slave which can't
374 * acquire qunit should set it's local limit as MIN_QLIMIT */
377 struct quotacheck_thread_args {
378 struct obd_export *qta_exp; /* obd export */
379 struct obd_quotactl qta_oqctl; /* obd_quotactl args */
380 struct super_block *qta_sb; /* obd super block */
381 atomic_t *qta_sem; /* obt_quotachecking */
384 struct obd_trans_info;
385 typedef int (*quota_acquire)(struct obd_device *obd, unsigned int uid,
386 unsigned int gid, struct obd_trans_info *oti);
389 int (*quota_init) (void);
390 int (*quota_exit) (void);
391 int (*quota_setup) (struct obd_device *);
392 int (*quota_cleanup) (struct obd_device *);
393 /* For quota master, close admin quota files */
394 int (*quota_fs_cleanup) (struct obd_device *);
395 int (*quota_ctl) (struct obd_export *, struct obd_quotactl *);
396 int (*quota_check) (struct obd_export *, struct obd_quotactl *);
397 int (*quota_recovery) (struct obd_device *);
399 /* For quota master/slave, adjust quota limit after fs operation */
400 int (*quota_adjust) (struct obd_device *, unsigned int[],
401 unsigned int[], int, int);
403 /* For quota slave, set import, trigger quota recovery */
404 int (*quota_setinfo) (struct obd_export *, struct obd_device *);
406 /* For quota slave, clear import when relative import is invalid */
407 int (*quota_clearinfo) (struct obd_export *, struct obd_device *);
409 /* For quota slave, set proper thread resoure capability */
410 int (*quota_enforce) (struct obd_device *, unsigned int);
412 /* For quota slave, check whether specified uid/gid is over quota */
413 int (*quota_getflag) (struct obd_device *, struct obdo *);
415 /* For quota slave, acquire/release quota from master if needed */
416 int (*quota_acquire) (struct obd_device *, unsigned int, unsigned int,
417 struct obd_trans_info *);
419 /* For quota slave, check whether specified uid/gid's remaining quota
420 * can finish a block_write or inode_create rpc. It updates the pending
421 * record of block and inode, acquires quota if necessary */
422 int (*quota_chkquota) (struct obd_device *, unsigned int, unsigned int,
423 int, int [], quota_acquire,
424 struct obd_trans_info *, struct inode *, int);
426 /* For quota client, the actions after the pending write is committed */
427 int (*quota_pending_commit) (struct obd_device *, unsigned int,
428 unsigned int, int []);
430 /* For quota client, poll if the quota check done */
431 int (*quota_poll_check) (struct obd_export *, struct if_quotacheck *);
433 /* For quota client, check whether specified uid/gid is over quota */
434 int (*quota_chkdq) (struct client_obd *, unsigned int, unsigned int);
436 /* For quota client, set over quota flag for specifed uid/gid */
437 int (*quota_setdq) (struct client_obd *, unsigned int, unsigned int,
440 /* For adjusting qunit size b=10600 */
441 int (*quota_adjust_qunit) (struct obd_export *exp,
442 struct quota_adjust_qunit *oqaq,
443 struct lustre_quota_ctxt *qctxt);
447 #define Q_COPY(out, in, member) (out)->member = (in)->member
449 #define QUOTA_OP(interface, op) interface->quota_ ## op
451 #define QUOTA_CHECK_OP(interface, op) \
455 if (!QUOTA_OP(interface, op)) { \
456 CERROR("no quota operation: " #op "\n"); \
457 RETURN(-EOPNOTSUPP); \
461 static inline int lquota_init(quota_interface_t *interface)
466 QUOTA_CHECK_OP(interface, init);
467 rc = QUOTA_OP(interface, init)();
471 static inline int lquota_exit(quota_interface_t *interface)
476 QUOTA_CHECK_OP(interface, exit);
477 rc = QUOTA_OP(interface, exit)();
481 static inline int lquota_setup(quota_interface_t *interface,
482 struct obd_device *obd)
487 QUOTA_CHECK_OP(interface, setup);
488 rc = QUOTA_OP(interface, setup)(obd);
492 static inline int lquota_cleanup(quota_interface_t *interface,
493 struct obd_device *obd)
498 QUOTA_CHECK_OP(interface, cleanup);
499 rc = QUOTA_OP(interface, cleanup)(obd);
503 static inline int lquota_fs_cleanup(quota_interface_t *interface,
504 struct obd_device *obd)
509 QUOTA_CHECK_OP(interface, fs_cleanup);
510 rc = QUOTA_OP(interface, fs_cleanup)(obd);
514 static inline int lquota_recovery(quota_interface_t *interface,
515 struct obd_device *obd)
520 QUOTA_CHECK_OP(interface, recovery);
521 rc = QUOTA_OP(interface, recovery)(obd);
525 static inline int lquota_adjust(quota_interface_t *interface,
526 struct obd_device *obd,
527 unsigned int qcids[],
528 unsigned int qpids[],
534 QUOTA_CHECK_OP(interface, adjust);
535 ret = QUOTA_OP(interface, adjust)(obd, qcids, qpids, rc, opc);
539 static inline int lquota_chkdq(quota_interface_t *interface,
540 struct client_obd *cli,
541 unsigned int uid, unsigned int gid)
546 QUOTA_CHECK_OP(interface, chkdq);
547 rc = QUOTA_OP(interface, chkdq)(cli, uid, gid);
551 static inline int lquota_setdq(quota_interface_t *interface,
552 struct client_obd *cli,
553 unsigned int uid, unsigned int gid,
554 obd_flag valid, obd_flag flags)
559 QUOTA_CHECK_OP(interface, setdq);
560 rc = QUOTA_OP(interface, setdq)(cli, uid, gid, valid, flags);
564 static inline int lquota_poll_check(quota_interface_t *interface,
565 struct obd_export *exp,
566 struct if_quotacheck *qchk)
571 QUOTA_CHECK_OP(interface, poll_check);
572 rc = QUOTA_OP(interface, poll_check)(exp, qchk);
576 static inline int lquota_setinfo(quota_interface_t *interface,
577 struct obd_export *exp,
578 struct obd_device *obd)
583 QUOTA_CHECK_OP(interface, setinfo);
584 rc = QUOTA_OP(interface, setinfo)(exp, obd);
588 static inline int lquota_clearinfo(quota_interface_t *interface,
589 struct obd_export *exp,
590 struct obd_device *obd)
595 QUOTA_CHECK_OP(interface, clearinfo);
596 rc = QUOTA_OP(interface, clearinfo)(exp, obd);
600 static inline int lquota_enforce(quota_interface_t *interface,
601 struct obd_device *obd,
607 QUOTA_CHECK_OP(interface, enforce);
608 rc = QUOTA_OP(interface, enforce)(obd, ignore);
612 static inline int lquota_getflag(quota_interface_t *interface,
613 struct obd_device *obd, struct obdo *oa)
618 QUOTA_CHECK_OP(interface, getflag);
619 rc = QUOTA_OP(interface, getflag)(obd, oa);
624 static inline int lquota_acquire(quota_interface_t *interface,
625 struct obd_device *obd,
626 unsigned int uid, unsigned int gid,
627 struct obd_trans_info *oti)
632 QUOTA_CHECK_OP(interface, acquire);
633 rc = QUOTA_OP(interface, acquire)(obd, uid, gid, oti);
637 static inline int lquota_chkquota(quota_interface_t *interface,
638 struct obd_device *obd,
639 unsigned int uid, unsigned int gid, int count,
640 int pending[2], struct obd_trans_info *oti,
641 struct inode *inode, int frags)
646 QUOTA_CHECK_OP(interface, chkquota);
647 QUOTA_CHECK_OP(interface, acquire);
648 rc = QUOTA_OP(interface, chkquota)(obd, uid, gid, count, pending,
649 QUOTA_OP(interface, acquire), oti,
654 static inline int lquota_pending_commit(quota_interface_t *interface,
655 struct obd_device *obd,
656 unsigned int uid, unsigned int gid,
662 QUOTA_CHECK_OP(interface, pending_commit);
663 rc = QUOTA_OP(interface, pending_commit)(obd, uid, gid, pending);
669 extern quota_interface_t osc_quota_interface;
670 extern quota_interface_t mdc_quota_interface;
671 extern quota_interface_t lov_quota_interface;
687 #define LUSTRE_ADMIN_QUOTAFILES_V1 {\
688 "admin_quotafile.usr", /* user admin quotafile */\
689 "admin_quotafile.grp" /* group admin quotafile */\
692 #define LUSTRE_ADMIN_QUOTAFILES_V2 {\
693 "admin_quotafile_v2.usr", /* user admin quotafile */\
694 "admin_quotafile_v2.grp" /* group admin quotafile */\
697 #endif /* _LUSTRE_QUOTA_H */