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,
92 * these four are for measuring quota requests, for both of
93 * quota master and quota slaves
95 LQUOTA_SYNC_ACQ = LQUOTA_FIRST_STAT,
102 * these four measure how much time I/O threads spend on dealing
103 * with quota before and after writing data or creating files,
104 * only for quota slaves(lquota_chkquota and lquota_pending_commit)
106 LQUOTA_WAIT_FOR_CHK_BLK,
107 LQUOTA_WAIT_FOR_CHK_INO,
108 LQUOTA_WAIT_FOR_COMMIT_BLK,
109 LQUOTA_WAIT_FOR_COMMIT_INO,
113 * these two are for measuring time waiting return of quota reqs
114 * (qctxt_wait_pending_dqacq), only for quota salves
116 LQUOTA_WAIT_PENDING_BLK_QUOTA,
117 LQUOTA_WAIT_PENDING_INO_QUOTA,
121 * these two are for those when they are calling
122 * qctxt_wait_pending_dqacq, the quota req has returned already,
123 * only for quota salves
125 LQUOTA_NOWAIT_PENDING_BLK_QUOTA,
126 LQUOTA_NOWAIT_PENDING_INO_QUOTA,
130 * these are for quota ctl
136 * these are for adjust quota qunit, for both of
137 * quota master and quota slaves
145 /* structures to access admin quotafile */
146 struct lustre_mem_dqinfo {
147 unsigned int dqi_bgrace;
148 unsigned int dqi_igrace;
149 unsigned long dqi_flags;
150 unsigned int dqi_blocks;
151 unsigned int dqi_free_blk;
152 unsigned int dqi_free_entry;
155 struct lustre_quota_info {
156 struct file *qi_files[MAXQUOTAS];
157 struct lustre_mem_dqinfo qi_info[MAXQUOTAS];
158 lustre_quota_version_t qi_version;
161 #define DQ_STATUS_AVAIL 0x0 /* Available dquot */
162 #define DQ_STATUS_SET 0x01 /* Sombody is setting dquot */
163 #define DQ_STATUS_RECOVERY 0x02 /* dquot is in recovery */
165 struct lustre_mem_dqblk {
166 __u64 dqb_bhardlimit; /**< absolute limit on disk blks alloc */
167 __u64 dqb_bsoftlimit; /**< preferred limit on disk blks */
168 __u64 dqb_curspace; /**< current used space */
169 __u64 dqb_ihardlimit; /**< absolute limit on allocated inodes */
170 __u64 dqb_isoftlimit; /**< preferred inode limit */
171 __u64 dqb_curinodes; /**< current # allocated inodes */
172 time_t dqb_btime; /**< time limit for excessive disk use */
173 time_t dqb_itime; /**< time limit for excessive inode use */
176 struct lustre_dquot {
177 /** Hash list in memory, protect by dquot_hash_lock */
178 struct list_head dq_hash;
179 /** Protect the data in lustre_dquot */
180 struct semaphore dq_sem;
183 /** Pointer of quota info it belongs to */
184 struct lustre_quota_info *dq_info;
185 /** Offset of dquot on disk */
187 /** ID this applies to (uid, gid) */
189 /** Type fo quota (USRQUOTA, GRPQUOUTA) */
191 /** See DQ_STATUS_ */
192 unsigned short dq_status;
193 /** See DQ_ in quota.h */
194 unsigned long dq_flags;
195 /** Diskquota usage */
196 struct lustre_mem_dqblk dq_dqb;
200 struct list_head di_link;
204 /* set inode quota limitation on a quota uid/gid */
205 #define QI_SET (1 << 30)
206 /* set block quota limitation on a quota uid/gid */
207 #define QB_SET (1 << 31)
210 #define QFILE_RD_INFO 2
211 #define QFILE_WR_INFO 3
212 #define QFILE_INIT_INFO 4
213 #define QFILE_RD_DQUOT 5
214 #define QFILE_WR_DQUOT 6
215 #define QFILE_CONVERT 7
217 /* admin quotafile operations */
218 int lustre_check_quota_file(struct lustre_quota_info *lqi, int type);
219 int lustre_read_quota_info(struct lustre_quota_info *lqi, int type);
220 int lustre_write_quota_info(struct lustre_quota_info *lqi, int type);
221 int lustre_read_dquot(struct lustre_dquot *dquot);
222 int lustre_commit_dquot(struct lustre_dquot *dquot);
223 int lustre_init_quota_info(struct lustre_quota_info *lqi, int type);
224 int lustre_get_qids(struct file *file, struct inode *inode, int type,
225 struct list_head *list);
226 int lustre_quota_convert(struct lustre_quota_info *lqi, int type);
228 typedef int (*dqacq_handler_t) (struct obd_device * obd, struct qunit_data * qd,
232 #ifdef HAVE_VFS_DQ_OFF
233 #define LL_DQUOT_OFF(sb, remount) vfs_dq_off(sb, remount)
235 #define LL_DQUOT_OFF(sb, remount) DQUOT_OFF(sb)
239 #define LL_DQUOT_OFF(sb) DQUOT_OFF(sb)
242 /* user quota is turned on on filter */
243 #define LQC_USRQUOTA_FLAG (1 << 0)
244 /* group quota is turned on on filter */
245 #define LQC_GRPQUOTA_FLAG (1 << 1)
247 #define UGQUOTA2LQC(id) ((Q_TYPEMATCH(id, USRQUOTA) ? LQC_USRQUOTA_FLAG : 0) | \
248 (Q_TYPEMATCH(id, GRPQUOTA) ? LQC_GRPQUOTA_FLAG : 0))
250 struct lustre_quota_ctxt {
251 /** superblock this applies to */
252 struct super_block *lqc_sb;
253 /** obd_device_target for obt_rwsem */
254 struct obd_device_target *lqc_obt;
255 /** import used to send dqacq/dqrel RPC */
256 struct obd_import *lqc_import;
257 /** dqacq/dqrel RPC handler, only for quota master */
258 dqacq_handler_t lqc_handler;
260 unsigned long lqc_flags;
262 unsigned long lqc_recovery:1, /** Doing recovery */
264 * the function of change qunit size
267 lqc_valid:1, /** this qctxt is valid or not */
269 * tell whether of not quota_type has
270 * been processed, so that the master
271 * knows when it can start processing
272 * incoming acq/rel quota requests
275 * cannot be turned on/off on-fly;
276 * temporary used by SOM.
280 * original unit size of file quota and
281 * upper limitation for adjust file qunit
283 unsigned long lqc_iunit_sz;
285 * Trigger dqacq when available file
286 * quota less than this value, trigger
287 * dqrel when available file quota
288 * more than this value + 1 iunit
290 unsigned long lqc_itune_sz;
292 * original unit size of block quota and
293 * upper limitation for adjust block qunit
295 unsigned long lqc_bunit_sz;
296 /** See comment of lqc_itune_sz */
297 unsigned long lqc_btune_sz;
298 /** all lustre_qunit_size structures */
299 struct lustre_hash *lqc_lqs_hash;
303 * the values below are relative to how master change its qunit sizes
306 * this affects the boundary of
307 * shrinking and enlarging qunit size. default=4
309 unsigned long lqc_cqs_boundary_factor;
310 /** the least value of block qunit */
311 unsigned long lqc_cqs_least_bunit;
312 /** the least value of inode qunit */
313 unsigned long lqc_cqs_least_iunit;
315 * when enlarging, qunit size will
316 * mutilple it; when shrinking,
317 * qunit size will divide it
319 unsigned long lqc_cqs_qs_factor;
321 * avoid ping-pong effect of
322 * adjusting qunit size. How many
323 * seconds must be waited between
324 * enlarging and shinking qunit
327 int lqc_switch_seconds;
329 * when blk qunit reaches this value,
330 * later write reqs from client should be sync b=16642
333 /** guard lqc_imp_valid now */
336 * when mds isn't connected, threads
337 * on osts who send the quota reqs
338 * with wait==1 will be put here b=14840
340 cfs_waitq_t lqc_wait_for_qmaster;
341 struct proc_dir_entry *lqc_proc_dir;
342 /** lquota statistics */
343 struct lprocfs_stats *lqc_stats;
344 /** the number of used hashed lqs */
346 /** no lqs are in use */
347 cfs_waitq_t lqc_lqs_waitq;
350 #define QUOTA_MASTER_READY(qctxt) (qctxt)->lqc_setup = 1
351 #define QUOTA_MASTER_UNREADY(qctxt) (qctxt)->lqc_setup = 0
353 struct lustre_qunit_size {
354 struct hlist_node lqs_hash; /** the hash entry */
355 unsigned int lqs_id; /** id of user/group */
356 unsigned long lqs_flags; /** 31st bit is QB_SET, 30th bit is QI_SET
357 * other bits are same as LQUOTA_FLAGS_*
359 unsigned long lqs_iunit_sz; /** Unit size of file quota currently */
361 * Trigger dqacq when available file quota
362 * less than this value, trigger dqrel
363 * when more than this value + 1 iunit
365 unsigned long lqs_itune_sz;
366 unsigned long lqs_bunit_sz; /** Unit size of block quota currently */
367 unsigned long lqs_btune_sz; /** See comment of lqs itune sz */
368 /** the blocks reached ost and don't finish */
369 unsigned long lqs_bwrite_pending;
370 /** the inodes reached mds and don't finish */
371 unsigned long lqs_iwrite_pending;
372 /** when inodes are allocated/released, this value will record it */
373 long long lqs_ino_rec;
374 /** when blocks are allocated/released, this value will record it */
375 long long lqs_blk_rec;
376 atomic_t lqs_refcount;
377 cfs_time_t lqs_last_bshrink; /** time of last block shrink */
378 cfs_time_t lqs_last_ishrink; /** time of last inode shrink */
380 unsigned long long lqs_key; /** hash key */
381 struct lustre_quota_ctxt *lqs_ctxt; /** quota ctxt */
384 #define LQS_IS_GRP(lqs) ((lqs)->lqs_flags & LQUOTA_FLAGS_GRP)
385 #define LQS_IS_ADJBLK(lqs) ((lqs)->lqs_flags & LQUOTA_FLAGS_ADJBLK)
386 #define LQS_IS_ADJINO(lqs) ((lqs)->lqs_flags & LQUOTA_FLAGS_ADJINO)
388 #define LQS_SET_GRP(lqs) ((lqs)->lqs_flags |= LQUOTA_FLAGS_GRP)
389 #define LQS_SET_ADJBLK(lqs) ((lqs)->lqs_flags |= LQUOTA_FLAGS_ADJBLK)
390 #define LQS_SET_ADJINO(lqs) ((lqs)->lqs_flags |= LQUOTA_FLAGS_ADJINO)
392 /* In the hash for lustre_qunit_size, the key is decided by
393 * grp_or_usr and uid/gid, in here, I combine these two values,
394 * which will make comparing easier and more efficient */
395 #define LQS_KEY(is_grp, id) ((is_grp ? 1ULL << 32: 0) + id)
396 #define LQS_KEY_ID(key) (key & 0xffffffff)
397 #define LQS_KEY_GRP(key) (key >> 32)
399 static inline void __lqs_getref(struct lustre_qunit_size *lqs)
401 int count = atomic_inc_return(&lqs->lqs_refcount);
403 if (count == 2) /* quota_create_lqs */
404 atomic_inc(&lqs->lqs_ctxt->lqc_lqs);
405 CDEBUG(D_QUOTA, "lqs=%p refcount %d\n", lqs, count);
408 static inline void lqs_getref(struct lustre_qunit_size *lqs)
413 static inline void __lqs_putref(struct lustre_qunit_size *lqs)
415 LASSERT(atomic_read(&lqs->lqs_refcount) > 0);
417 if (atomic_dec_return(&lqs->lqs_refcount) == 1)
418 if (atomic_dec_and_test(&lqs->lqs_ctxt->lqc_lqs))
419 cfs_waitq_signal(&lqs->lqs_ctxt->lqc_lqs_waitq);
420 CDEBUG(D_QUOTA, "lqs=%p refcount %d\n",
421 lqs, atomic_read(&lqs->lqs_refcount));
424 static inline void lqs_putref(struct lustre_qunit_size *lqs)
429 static inline void lqs_initref(struct lustre_qunit_size *lqs)
431 atomic_set(&lqs->lqs_refcount, 0);
436 struct lustre_quota_info {
439 struct lustre_quota_ctxt {
442 #define QUOTA_MASTER_READY(qctxt)
443 #define QUOTA_MASTER_UNREADY(qctxt)
445 #endif /* !__KERNEL__ */
449 #define LL_DQUOT_OFF(sb, remount) do {} while(0)
451 struct lustre_quota_info {
454 struct lustre_quota_ctxt {
457 #endif /* !HAVE_QUOTA_SUPPORT */
459 /* If the (quota limit < qunit * slave count), the slave which can't
460 * acquire qunit should set it's local limit as MIN_QLIMIT */
463 struct quotacheck_thread_args {
464 struct obd_export *qta_exp; /** obd export */
465 struct obd_device *qta_obd; /** obd device */
466 struct obd_quotactl qta_oqctl; /** obd_quotactl args */
467 struct super_block *qta_sb; /** obd super block */
468 struct semaphore *qta_sem; /** obt_quotachecking */
471 struct obd_trans_info;
472 typedef int (*quota_acquire)(struct obd_device *obd, const unsigned int id[],
473 struct obd_trans_info *oti, int isblk);
476 int (*quota_init) (void);
477 int (*quota_exit) (void);
478 int (*quota_setup) (struct obd_device *);
479 int (*quota_cleanup) (struct obd_device *);
481 * For quota master, close admin quota files
483 int (*quota_fs_cleanup) (struct obd_device *);
484 int (*quota_ctl) (struct obd_device *, struct obd_export *,
485 struct obd_quotactl *);
486 int (*quota_check) (struct obd_device *, struct obd_export *,
487 struct obd_quotactl *);
488 int (*quota_recovery) (struct obd_device *);
491 * For quota master/slave, adjust quota limit after fs operation
493 int (*quota_adjust) (struct obd_device *, const unsigned int[],
494 const unsigned int[], int, int);
497 * For quota slave, set import, trigger quota recovery,
498 * For quota master, set lqc_setup
500 int (*quota_setinfo) (struct obd_device *, void *);
503 * For quota slave, clear import when relative import is invalid
505 int (*quota_clearinfo) (struct obd_export *, struct obd_device *);
508 * For quota slave, set proper thread resoure capability
510 int (*quota_enforce) (struct obd_device *, unsigned int);
513 * For quota slave, check whether specified uid/gid is over quota
515 int (*quota_getflag) (struct obd_device *, struct obdo *);
519 * For quota slave, acquire/release quota from master if needed
521 int (*quota_acquire) (struct obd_device *, const unsigned int [],
522 struct obd_trans_info *, int);
525 * For quota slave, check whether specified uid/gid's remaining quota
526 * can finish a block_write or inode_create rpc. It updates the pending
527 * record of block and inode, acquires quota if necessary
529 int (*quota_chkquota) (struct obd_device *, struct obd_export *,
530 const unsigned int [], int [],
531 int, quota_acquire, struct obd_trans_info *,
532 int, struct inode *, int);
535 * For quota client, the actions after the pending write is committed
537 int (*quota_pending_commit) (struct obd_device *, const unsigned int [],
542 * For quota client, poll if the quota check done
544 int (*quota_poll_check) (struct obd_export *, struct if_quotacheck *);
547 * For quota client, check whether specified uid/gid is over quota
549 int (*quota_chkdq) (struct client_obd *, const unsigned int []);
552 * For quota client, set over quota flag for specifed uid/gid
554 int (*quota_setdq) (struct client_obd *, const unsigned int [],
558 * For adjusting qunit size b=10600
560 int (*quota_adjust_qunit) (struct obd_export *exp,
561 struct quota_adjust_qunit *oqaq,
562 struct lustre_quota_ctxt *qctxt);
566 #define Q_COPY(out, in, member) (out)->member = (in)->member
568 #define QUOTA_OP(interface, op) interface->quota_ ## op
570 #define QUOTA_CHECK_OP(interface, op) \
574 if (!QUOTA_OP(interface, op)) { \
575 CERROR("no quota operation: " #op "\n"); \
576 RETURN(-EOPNOTSUPP); \
580 static inline int lquota_init(quota_interface_t *interface)
585 QUOTA_CHECK_OP(interface, init);
586 rc = QUOTA_OP(interface, init)();
590 static inline int lquota_exit(quota_interface_t *interface)
595 QUOTA_CHECK_OP(interface, exit);
596 rc = QUOTA_OP(interface, exit)();
600 static inline int lquota_setup(quota_interface_t *interface,
601 struct obd_device *obd)
606 QUOTA_CHECK_OP(interface, setup);
607 rc = QUOTA_OP(interface, setup)(obd);
611 static inline int lquota_cleanup(quota_interface_t *interface,
612 struct obd_device *obd)
617 QUOTA_CHECK_OP(interface, cleanup);
618 rc = QUOTA_OP(interface, cleanup)(obd);
622 static inline int lquota_fs_cleanup(quota_interface_t *interface,
623 struct obd_device *obd)
628 QUOTA_CHECK_OP(interface, fs_cleanup);
629 rc = QUOTA_OP(interface, fs_cleanup)(obd);
633 static inline int lquota_recovery(quota_interface_t *interface,
634 struct obd_device *obd)
639 QUOTA_CHECK_OP(interface, recovery);
640 rc = QUOTA_OP(interface, recovery)(obd);
644 static inline int lquota_check(quota_interface_t *interface,
645 struct obd_device *obd,
646 struct obd_export *exp,
647 struct obd_quotactl *oqctl)
652 QUOTA_CHECK_OP(interface, check);
653 rc = QUOTA_OP(interface, check)(obd, exp, oqctl);
657 static inline int lquota_ctl(quota_interface_t *interface,
658 struct obd_device *obd,
659 struct obd_quotactl *oqctl)
664 QUOTA_CHECK_OP(interface, ctl);
665 rc = QUOTA_OP(interface, ctl)(obd, NULL, oqctl);
669 static inline int lquota_adjust(quota_interface_t *interface,
670 struct obd_device *obd,
671 const unsigned int qcids[],
672 const unsigned int qpids[],
678 QUOTA_CHECK_OP(interface, adjust);
679 ret = QUOTA_OP(interface, adjust)(obd, qcids, qpids, rc, opc);
683 static inline int lquota_chkdq(quota_interface_t *interface,
684 struct client_obd *cli, const unsigned int qid[])
689 QUOTA_CHECK_OP(interface, chkdq);
690 rc = QUOTA_OP(interface, chkdq)(cli, qid);
694 static inline int lquota_setdq(quota_interface_t *interface,
695 struct client_obd *cli, const unsigned int qid[],
696 obd_flag valid, obd_flag flags)
701 QUOTA_CHECK_OP(interface, setdq);
702 rc = QUOTA_OP(interface, setdq)(cli, qid, valid, flags);
706 static inline int lquota_poll_check(quota_interface_t *interface,
707 struct obd_export *exp,
708 struct if_quotacheck *qchk)
713 QUOTA_CHECK_OP(interface, poll_check);
714 rc = QUOTA_OP(interface, poll_check)(exp, qchk);
718 static inline int lquota_setinfo(quota_interface_t *interface,
719 struct obd_device *obd,
725 QUOTA_CHECK_OP(interface, setinfo);
726 rc = QUOTA_OP(interface, setinfo)(obd, data);
730 static inline int lquota_clearinfo(quota_interface_t *interface,
731 struct obd_export *exp,
732 struct obd_device *obd)
737 QUOTA_CHECK_OP(interface, clearinfo);
738 rc = QUOTA_OP(interface, clearinfo)(exp, obd);
742 static inline int lquota_enforce(quota_interface_t *interface,
743 struct obd_device *obd,
749 QUOTA_CHECK_OP(interface, enforce);
750 rc = QUOTA_OP(interface, enforce)(obd, ignore);
754 static inline int lquota_getflag(quota_interface_t *interface,
755 struct obd_device *obd, struct obdo *oa)
760 QUOTA_CHECK_OP(interface, getflag);
761 rc = QUOTA_OP(interface, getflag)(obd, oa);
766 static inline int lquota_chkquota(quota_interface_t *interface,
767 struct obd_device *obd,
768 struct obd_export *exp,
769 const unsigned int id[], int pending[],
770 int count, struct obd_trans_info *oti,
771 int isblk, void *data, int frags)
776 QUOTA_CHECK_OP(interface, chkquota);
777 QUOTA_CHECK_OP(interface, acquire);
778 rc = QUOTA_OP(interface, chkquota)(obd, exp, id, pending, count,
779 QUOTA_OP(interface, acquire), oti,
780 isblk, (struct inode *)data, frags);
784 static inline int lquota_pending_commit(quota_interface_t *interface,
785 struct obd_device *obd,
786 const unsigned int id[],
787 int pending[], int isblk)
792 QUOTA_CHECK_OP(interface, pending_commit);
793 rc = QUOTA_OP(interface, pending_commit)(obd, id, pending, isblk);
799 extern quota_interface_t osc_quota_interface;
800 extern quota_interface_t lov_quota_interface;
801 extern quota_interface_t mdc_quota_interface;
802 extern quota_interface_t lmv_quota_interface;
818 #define LUSTRE_ADMIN_QUOTAFILES_V2 {\
819 "admin_quotafile_v2.usr", /** user admin quotafile */\
820 "admin_quotafile_v2.grp" /** group admin quotafile */\
823 #endif /* _LUSTRE_QUOTA_H */