4 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License version 2 only,
8 * as published by the Free Software Foundation.
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * General Public License version 2 for more details (a copy is included
14 * in the LICENSE file that accompanied this code).
16 * You should have received a copy of the GNU General Public License
17 * version 2 along with this program; if not, write to the
18 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
19 * Boston, MA 021110-1307, USA
24 * Copyright (c) 2012, 2017, Intel Corporation.
25 * Use is subject to license terms.
29 #include <lustre_quota.h>
31 #ifndef _LQUOTA_INTERNAL_H
32 #define _LQUOTA_INTERNAL_H
34 #define RES_NAME(res) ((res) == LQUOTA_RES_MD ? "md" : "dt")
36 #define QIF_IFLAGS (QIF_INODES | QIF_ITIME | QIF_ILIMITS)
37 #define QIF_BFLAGS (QIF_SPACE | QIF_BTIME | QIF_BLIMITS)
39 /* The biggest filename are the one used for slave index which are in the form
40 * of 0x%x-%s,glb_fid.f_oid,slv_uuid, that's to say:
41 * 2(0x) + 8(f_oid) + 1(-) + 40(UUID_MAX) which means 51 chars + '\0' */
42 #define LQUOTA_NAME_MAX 52
44 /* reserved OID in FID_SEQ_QUOTA for local objects */
45 enum lquota_local_oid {
46 LQUOTA_USR_OID = 1UL, /* slave index copy for user quota */
47 LQUOTA_GRP_OID = 2UL, /* slave index copy for group quota */
48 LQUOTA_PRJ_OID = 3UL, /* slave index copy for project quota */
49 /* all OIDs after this are allocated dynamically by the QMT */
50 LQUOTA_GENERATED_OID = 4096UL,
53 static inline __u32 qtype2slv_oid(int qtype)
57 return LQUOTA_USR_OID;
59 return LQUOTA_GRP_OID;
61 return LQUOTA_PRJ_OID;
64 /* should not come here, just make compile happy */
65 return LQUOTA_USR_OID;
69 * lquota_entry support
72 /* Common operations supported by a lquota_entry */
73 struct lquota_entry_operations {
74 /* Initialize specific fields of a lquota entry */
75 void (*lqe_init)(struct lquota_entry *, void *arg);
77 /* Read quota settings from disk and update lquota entry */
78 int (*lqe_read)(const struct lu_env *, struct lquota_entry *,
79 void *arg, bool find);
81 /* Print debug information about a given lquota entry */
82 void (*lqe_debug)(struct lquota_entry *, void *,
83 struct libcfs_debug_msg_data *,
84 struct va_format *vaf);
87 /* Per-ID information specific to the quota master target */
88 struct lquota_mst_entry {
89 /* global hard limit, in inodes or kbytes */
92 /* global quota soft limit, in inodes or kbytes */
95 /* grace time, in seconds */
98 /* last time we glimpsed */
99 time64_t lme_revoke_time;
101 /* r/w semaphore used to protect concurrent access to the quota
102 * parameters which are stored on disk */
103 struct rw_semaphore lme_sem;
105 /* quota space that may be released after glimpse */
109 /* Per-ID information specific to the quota slave */
110 struct lquota_slv_entry {
111 /* [ib]tune size, inodes or kbytes */
114 /* per-ID lock handle */
115 struct lustre_handle lse_lockh;
117 /* pending write which were granted quota space but haven't completed
118 * yet, in inodes or kbytes. */
119 __u64 lse_pending_write;
121 /* writes waiting for quota space, in inodes or kbytes. */
122 __u64 lse_waiting_write;
124 /* pending release, in inodes or kbytes */
125 __u64 lse_pending_rel;
127 /* pending dqacq/dqrel requests. */
128 unsigned int lse_pending_req;
130 /* rw spinlock protecting in-memory counters (i.e. lse_pending*) */
133 /* waiter for pending request done */
134 wait_queue_head_t lse_waiters;
136 /* hint on current on-disk usage, in inodes or kbytes */
139 /* time to trigger quota adjust */
140 time64_t lse_adjust_time;
142 /* return code of latest acquire RPC */
145 /* when latest acquire RPC completed */
146 time64_t lse_acq_time;
148 /* when latest edquot set */
149 time64_t lse_edquot_time;
152 /* In-memory entry for each enforced quota id
153 * A lquota_entry structure belong to a single lquota_site */
154 struct lquota_entry {
155 /* link to site hash table */
156 struct hlist_node lqe_hash;
158 /* quota identifier associated with this entry */
159 union lquota_id lqe_id;
161 /* site this quota entry belongs to */
162 struct lquota_site *lqe_site;
164 /* reference counter */
167 /* linked to list of lqes which:
168 * - need quota space adjustment on slave
169 * - need glimpse to be sent on master */
170 struct list_head lqe_link;
172 /* current quota settings/usage of this ID */
173 __u64 lqe_granted; /* granted limit, inodes or kbytes */
174 /* used in quota pool recalc process (only on QMT) */
175 __u64 lqe_recalc_granted;
176 __u64 lqe_qunit; /* [ib]unit size, inodes or kbytes */
178 struct lquota_mst_entry me; /* params specific to QMT */
179 struct lquota_slv_entry se; /* params specific to QSD */
182 /* flags describing the state of the lquota_entry */
183 unsigned long lqe_enforced:1, /* quota enforced or not */
184 lqe_uptodate:1, /* successfully read from disk */
185 lqe_edquot:1, /* id out of quota space on QMT */
186 lqe_gl:1, /* glimpse is in progress */
187 lqe_nopreacq:1, /* pre-acquire disabled */
188 lqe_is_default:1, /* the default quota is used */
189 lqe_is_global:1, /* lqe belongs to global pool "0x0"*/
190 lqe_is_deleted:1; /* lqe will be deleted soon */
192 /* the lock to protect lqe_glbl_data */
193 struct mutex lqe_glbl_data_lock;
194 struct lqe_glbl_data *lqe_glbl_data;
197 #define lqe_qtype(lqe) (lqe->lqe_site->lqs_qtype)
198 #define lqe_rtype(lqe) (lqe2qpi(lqe)->qpi_rtype)
200 struct lqe_glbl_entry {
202 unsigned long lge_edquot:1,
203 /* true when minimum qunit is set */
205 /* qunit or edquot is changed - need
206 * to send glimpse to appropriate slave */
211 struct lqe_glbl_data {
212 struct lqe_glbl_entry *lqeg_arr;
213 /* number of initialised entries */
215 /* number of allocated entries */
219 /* Compartment within which lquota_entry are unique.
220 * lquota_entry structures are kept in a hash table and read from disk if not
223 /* Hash table storing lquota_entry structures */
224 struct cfs_hash *lqs_hash;
226 /* Quota type, either user or group. */
229 /* Record whether this site is for a QMT or a slave */
232 /* Vector of operations which can be done on lquota entry belonging to
234 const struct lquota_entry_operations *lqs_ops;
236 /* Backpointer to parent structure, either QMT pool info for master or
241 #define lqe_hardlimit u.me.lme_hardlimit
242 #define lqe_softlimit u.me.lme_softlimit
243 #define lqe_gracetime u.me.lme_gracetime
244 #define lqe_revoke_time u.me.lme_revoke_time
245 #define lqe_sem u.me.lme_sem
246 #define lqe_may_rel u.me.lme_may_rel
248 #define lqe_qtune u.se.lse_qtune
249 #define lqe_pending_write u.se.lse_pending_write
250 #define lqe_waiting_write u.se.lse_waiting_write
251 #define lqe_pending_rel u.se.lse_pending_rel
252 #define lqe_pending_req u.se.lse_pending_req
253 #define lqe_waiters u.se.lse_waiters
254 #define lqe_lock u.se.lse_lock
255 #define lqe_usage u.se.lse_usage
256 #define lqe_adjust_time u.se.lse_adjust_time
257 #define lqe_lockh u.se.lse_lockh
258 #define lqe_acq_rc u.se.lse_acq_rc
259 #define lqe_acq_time u.se.lse_acq_time
260 #define lqe_edquot_time u.se.lse_edquot_time
262 #define LQUOTA_BUMP_VER 0x1
263 #define LQUOTA_SET_VER 0x2
265 extern struct kmem_cache *lqe_kmem;
267 /* helper routine to get/put reference on lquota_entry */
268 static inline void lqe_getref(struct lquota_entry *lqe)
270 LASSERT(lqe != NULL);
271 atomic_inc(&lqe->lqe_ref);
274 static inline void lqe_putref(struct lquota_entry *lqe)
276 LASSERT(lqe != NULL);
277 LASSERT(atomic_read(&lqe->lqe_ref) > 0);
278 if (atomic_dec_and_test(&lqe->lqe_ref))
279 OBD_SLAB_FREE_PTR(lqe, lqe_kmem);
282 static inline int lqe_is_master(struct lquota_entry *lqe)
284 return lqe->lqe_site->lqs_is_mst;
287 /* lqe locking helpers */
288 static inline void lqe_write_lock(struct lquota_entry *lqe)
290 if (lqe_is_master(lqe))
291 down_write(&lqe->lqe_sem);
293 write_lock(&lqe->lqe_lock);
296 static inline void lqe_write_unlock(struct lquota_entry *lqe)
298 if (lqe_is_master(lqe))
299 up_write(&lqe->lqe_sem);
301 write_unlock(&lqe->lqe_lock);
304 static inline void lqe_read_lock(struct lquota_entry *lqe)
306 if (lqe_is_master(lqe))
307 down_read(&lqe->lqe_sem);
309 read_lock(&lqe->lqe_lock);
312 static inline void lqe_read_unlock(struct lquota_entry *lqe)
314 if (lqe_is_master(lqe))
315 up_read(&lqe->lqe_sem);
317 read_unlock(&lqe->lqe_lock);
321 * Helper functions & prototypes
324 /* minimum qunit size, 1K inode for metadata pool and 1MB for data pool */
325 #define LQUOTA_LEAST_QUNIT(type) \
326 (type == LQUOTA_RES_MD ? (1 << 10) : toqb(OFD_MAX_BRW_SIZE))
328 static inline enum osd_quota_local_flags lquota_over_fl(int qtype)
332 return QUOTA_FL_OVER_USRQUOTA;
334 return QUOTA_FL_OVER_GRPQUOTA;
336 return QUOTA_FL_OVER_PRJQUOTA;
339 /* should not come here, just make compile happy */
340 return QUOTA_FL_OVER_USRQUOTA;
343 /* Common data shared by quota-level handlers. This is allocated per-thread to
344 * reduce stack consumption */
345 struct lquota_thread_info {
346 union lquota_rec qti_rec;
347 struct lu_buf qti_lb;
348 struct lu_attr qti_attr;
349 struct dt_object_format qti_dof;
350 struct lu_fid qti_fid;
351 char qti_buf[LQUOTA_NAME_MAX];
354 #define qti_glb_rec qti_rec.lqr_glb_rec
355 #define qti_acct_rec qti_rec.lqr_acct_rec
356 #define qti_slv_rec qti_rec.lqr_slv_rec
358 #define LQUOTA_BUMP_VER 0x1
359 #define LQUOTA_SET_VER 0x2
361 extern struct lu_context_key lquota_thread_key;
363 /* extract lquota_threa_info context from environment */
365 struct lquota_thread_info *lquota_info(const struct lu_env *env)
367 return lu_env_info(env, &lquota_thread_key);
370 #define req_is_acq(flags) ((flags & QUOTA_DQACQ_FL_ACQ) != 0)
371 #define req_is_preacq(flags) ((flags & QUOTA_DQACQ_FL_PREACQ) != 0)
372 #define req_is_rel(flags) ((flags & QUOTA_DQACQ_FL_REL) != 0)
373 #define req_has_rep(flags) ((flags & QUOTA_DQACQ_FL_REPORT) != 0)
375 /* debugging macros */
377 #define lquota_lqe_debug(msgdata, mask, cdls, lqe, fmt, a...) do { \
378 CFS_CHECK_STACK(msgdata, mask, cdls); \
380 if (((mask) & D_CANTMASK) != 0 || \
381 ((libcfs_debug & (mask)) != 0 && \
382 (libcfs_subsystem_debug & DEBUG_SUBSYSTEM) != 0)) \
383 lquota_lqe_debug0(lqe, msgdata, fmt, ##a); \
386 void lquota_lqe_debug0(struct lquota_entry *lqe,
387 struct libcfs_debug_msg_data *data, const char *fmt, ...)
388 __attribute__ ((format (printf, 3, 4)));
390 #define LQUOTA_DEBUG_LIMIT(mask, lqe, fmt, a...) do { \
391 static struct cfs_debug_limit_state _lquota_cdls; \
392 LIBCFS_DEBUG_MSG_DATA_DECL(msgdata, mask, &_lquota_cdls); \
393 lquota_lqe_debug(&msgdata, mask, &_lquota_cdls, lqe, "$$$ "fmt" ", \
397 #define LQUOTA_ERROR(lqe, fmt, a...) LQUOTA_DEBUG_LIMIT(D_ERROR, lqe, fmt, ## a)
398 #define LQUOTA_WARN(lqe, fmt, a...) \
399 LQUOTA_DEBUG_LIMIT(D_WARNING, lqe, fmt, ## a)
400 #define LQUOTA_CONSOLE(lqe, fmt, a...) \
401 LQUOTA_DEBUG_LIMIT(D_CONSOLE, lqe, fmt, ## a)
403 #define LQUOTA_ELEVEL_LQES(level, env, fmt, a...) do { \
405 for (i = 0; i < qti_lqes_cnt(env); i++) { \
406 LQUOTA_##level(qti_lqes(env)[i], fmt, ##a); \
409 #define LQUOTA_WARN_LQES(lqe, fmt, a...) \
410 LQUOTA_ELEVEL_LQES(WARN, env, fmt, ##a)
411 #define LQUOTA_CONSOLE_LQES(lqe, fmt, a...) \
412 LQUOTA_ELEVEL_LQES(CONSOLE, env, fmt, ##a)
413 #define LQUOTA_ERROR_LQES(lqe, fmt, a...) \
414 LQUOTA_ELEVEL_LQES(ERROR, env, fmt, ##a)
416 #define LQUOTA_DEBUG(lqe, fmt, a...) do { \
417 LIBCFS_DEBUG_MSG_DATA_DECL(msgdata, D_QUOTA, NULL); \
418 lquota_lqe_debug(&msgdata, D_QUOTA, NULL, lqe, "$$$ "fmt" ", ##a); \
421 #define LQUOTA_DEBUG_LQES(env, fmt, a...) do { \
423 for (i = 0; i < qti_lqes_cnt(env); i++) { \
424 LQUOTA_DEBUG(qti_lqes(env)[i], fmt, ##a); \
429 #else /* !LIBCFS_DEBUG */
430 # define LQUOTA_DEBUG_LQES(lqe, fmt, a...) ((void)0)
431 # define LQUOTA_ERROR_LQES(lqe, fmt, a...) ((void)0)
432 # define LQUOTA_WARN_LQES(lqe, fmt, a...) ((void)0)
433 # define LQUOTA_CONSOLE_LQES(lqe, fmt, a...) ((void)0)
434 # define LQUOTA_DEBUG(lqe, fmt, a...) ((void)0)
435 # define LQUOTA_ERROR(lqe, fmt, a...) ((void)0)
436 # define LQUOTA_WARN(lqe, fmt, a...) ((void)0)
437 # define LQUOTA_CONSOLE(lqe, fmt, a...) ((void)0)
438 # define lquota_lqe_debug(cdls, level, lqe, file, func, line, fmt, a...) \
443 struct dt_object *acct_obj_lookup(const struct lu_env *, struct dt_device *,
445 void lquota_generate_fid(struct lu_fid *, int, int);
446 int lquota_extract_fid(const struct lu_fid *, int *, int *);
447 const struct dt_index_features *glb_idx_feature(struct lu_fid *);
450 /* site create/destroy */
451 struct lquota_site *lquota_site_alloc(const struct lu_env *env, void *parent,
452 bool master, short qtype,
453 const struct lquota_entry_operations *op);
454 void lquota_site_free(const struct lu_env *, struct lquota_site *);
455 /* quota entry operations */
456 #define lqe_locate(env, site, id) lqe_locate_find(env, site, id, false)
457 #define lqe_find(env, site, id) lqe_locate_find(env, site, id, true)
458 struct lquota_entry *lqe_locate_find(const struct lu_env *,
459 struct lquota_site *,
460 union lquota_id *, bool);
462 static inline void lqe_set_deleted(struct lquota_entry *lqe)
464 lqe->lqe_enforced = 0;
466 lqe->lqe_is_default = 0;
467 lqe->lqe_hardlimit = 0;
468 lqe->lqe_softlimit = 0;
469 lqe->lqe_gracetime = 0;
471 lqe->lqe_is_deleted = 1;
475 struct dt_object *lquota_disk_dir_find_create(const struct lu_env *,
477 struct dt_object *, const char *);
478 struct dt_object *lquota_disk_glb_find_create(const struct lu_env *,
481 struct lu_fid *, bool);
482 struct dt_object *lquota_disk_slv_find_create(const struct lu_env *,
486 struct obd_uuid *, bool);
487 typedef int (*lquota_disk_slv_cb_t) (const struct lu_env *, struct lu_fid *,
488 char *, struct lu_fid *, void *);
489 int lquota_disk_for_each_slv(const struct lu_env *, struct dt_object *,
490 struct lu_fid *, lquota_disk_slv_cb_t, void *);
491 struct dt_object *lquota_disk_slv_find(const struct lu_env *,
492 struct dt_device *, struct dt_object *,
493 const struct lu_fid *,
495 int lquota_disk_read(const struct lu_env *, struct dt_object *,
496 union lquota_id *, struct dt_rec *);
497 int lquota_disk_declare_write(const struct lu_env *, struct thandle *,
498 struct dt_object *, union lquota_id *);
499 int lquota_disk_write(const struct lu_env *, struct thandle *,
500 struct dt_object *, union lquota_id *, struct dt_rec *,
502 int lquota_disk_delete(const struct lu_env *env, struct thandle *th,
503 struct dt_object *obj, __u64 qid, __u64 *ver);
504 int lquota_disk_update_ver(const struct lu_env *, struct dt_device *,
505 struct dt_object *, __u64);
506 int lquota_disk_write_glb(const struct lu_env *, struct dt_object *, __u64,
507 struct lquota_glb_rec *);
510 int qmt_glb_init(void);
511 void qmt_glb_fini(void);
514 extern const struct proc_ops lprocfs_quota_seq_fops;
517 int qsd_glb_init(void);
518 void qsd_glb_fini(void);
519 #endif /* _LQUOTA_INTERNAL_H */