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"*/
191 struct lqe_glbl_data *lqe_glbl_data;
194 #define lqe_qtype(lqe) (lqe->lqe_site->lqs_qtype)
195 #define lqe_rtype(lqe) (lqe2qpi(lqe)->qpi_rtype)
197 struct lqe_glbl_entry {
199 unsigned long lge_edquot:1,
200 /* true when minimum qunit is set */
202 /* qunit or edquot is changed - need
203 * to send glimpse to appropriate slave */
208 struct lqe_glbl_data {
209 struct lqe_glbl_entry *lqeg_arr;
210 /* number of initialised entries */
212 /* number of allocated entries */
216 /* Compartment within which lquota_entry are unique.
217 * lquota_entry structures are kept in a hash table and read from disk if not
220 /* Hash table storing lquota_entry structures */
221 struct cfs_hash *lqs_hash;
223 /* Quota type, either user or group. */
226 /* Record whether this site is for a QMT or a slave */
229 /* Vector of operations which can be done on lquota entry belonging to
231 const struct lquota_entry_operations *lqs_ops;
233 /* Backpointer to parent structure, either QMT pool info for master or
238 #define lqe_hardlimit u.me.lme_hardlimit
239 #define lqe_softlimit u.me.lme_softlimit
240 #define lqe_gracetime u.me.lme_gracetime
241 #define lqe_revoke_time u.me.lme_revoke_time
242 #define lqe_sem u.me.lme_sem
243 #define lqe_may_rel u.me.lme_may_rel
245 #define lqe_qtune u.se.lse_qtune
246 #define lqe_pending_write u.se.lse_pending_write
247 #define lqe_waiting_write u.se.lse_waiting_write
248 #define lqe_pending_rel u.se.lse_pending_rel
249 #define lqe_pending_req u.se.lse_pending_req
250 #define lqe_waiters u.se.lse_waiters
251 #define lqe_lock u.se.lse_lock
252 #define lqe_usage u.se.lse_usage
253 #define lqe_adjust_time u.se.lse_adjust_time
254 #define lqe_lockh u.se.lse_lockh
255 #define lqe_acq_rc u.se.lse_acq_rc
256 #define lqe_acq_time u.se.lse_acq_time
257 #define lqe_edquot_time u.se.lse_edquot_time
259 #define LQUOTA_BUMP_VER 0x1
260 #define LQUOTA_SET_VER 0x2
262 extern struct kmem_cache *lqe_kmem;
264 /* helper routine to get/put reference on lquota_entry */
265 static inline void lqe_getref(struct lquota_entry *lqe)
267 LASSERT(lqe != NULL);
268 atomic_inc(&lqe->lqe_ref);
271 static inline void lqe_putref(struct lquota_entry *lqe)
273 LASSERT(lqe != NULL);
274 LASSERT(atomic_read(&lqe->lqe_ref) > 0);
275 if (atomic_dec_and_test(&lqe->lqe_ref))
276 OBD_SLAB_FREE_PTR(lqe, lqe_kmem);
279 static inline int lqe_is_master(struct lquota_entry *lqe)
281 return lqe->lqe_site->lqs_is_mst;
284 /* lqe locking helpers */
285 static inline void lqe_write_lock(struct lquota_entry *lqe)
287 if (lqe_is_master(lqe))
288 down_write(&lqe->lqe_sem);
290 write_lock(&lqe->lqe_lock);
293 static inline void lqe_write_unlock(struct lquota_entry *lqe)
295 if (lqe_is_master(lqe))
296 up_write(&lqe->lqe_sem);
298 write_unlock(&lqe->lqe_lock);
301 static inline void lqe_read_lock(struct lquota_entry *lqe)
303 if (lqe_is_master(lqe))
304 down_read(&lqe->lqe_sem);
306 read_lock(&lqe->lqe_lock);
309 static inline void lqe_read_unlock(struct lquota_entry *lqe)
311 if (lqe_is_master(lqe))
312 up_read(&lqe->lqe_sem);
314 read_unlock(&lqe->lqe_lock);
318 * Helper functions & prototypes
321 /* minimum qunit size, 1K inode for metadata pool and 1MB for data pool */
322 #define LQUOTA_LEAST_QUNIT(type) \
323 (type == LQUOTA_RES_MD ? (1 << 10) : toqb(OFD_MAX_BRW_SIZE))
325 static inline enum osd_quota_local_flags lquota_over_fl(int qtype)
329 return QUOTA_FL_OVER_USRQUOTA;
331 return QUOTA_FL_OVER_GRPQUOTA;
333 return QUOTA_FL_OVER_PRJQUOTA;
336 /* should not come here, just make compile happy */
337 return QUOTA_FL_OVER_USRQUOTA;
340 /* Common data shared by quota-level handlers. This is allocated per-thread to
341 * reduce stack consumption */
342 struct lquota_thread_info {
343 union lquota_rec qti_rec;
344 struct lu_buf qti_lb;
345 struct lu_attr qti_attr;
346 struct dt_object_format qti_dof;
347 struct lu_fid qti_fid;
348 char qti_buf[LQUOTA_NAME_MAX];
351 #define qti_glb_rec qti_rec.lqr_glb_rec
352 #define qti_acct_rec qti_rec.lqr_acct_rec
353 #define qti_slv_rec qti_rec.lqr_slv_rec
355 #define LQUOTA_BUMP_VER 0x1
356 #define LQUOTA_SET_VER 0x2
358 extern struct lu_context_key lquota_thread_key;
360 /* extract lquota_threa_info context from environment */
362 struct lquota_thread_info *lquota_info(const struct lu_env *env)
364 return lu_env_info(env, &lquota_thread_key);
367 #define req_is_acq(flags) ((flags & QUOTA_DQACQ_FL_ACQ) != 0)
368 #define req_is_preacq(flags) ((flags & QUOTA_DQACQ_FL_PREACQ) != 0)
369 #define req_is_rel(flags) ((flags & QUOTA_DQACQ_FL_REL) != 0)
370 #define req_has_rep(flags) ((flags & QUOTA_DQACQ_FL_REPORT) != 0)
372 /* debugging macros */
374 #define lquota_lqe_debug(msgdata, mask, cdls, lqe, fmt, a...) do { \
375 CFS_CHECK_STACK(msgdata, mask, cdls); \
377 if (((mask) & D_CANTMASK) != 0 || \
378 ((libcfs_debug & (mask)) != 0 && \
379 (libcfs_subsystem_debug & DEBUG_SUBSYSTEM) != 0)) \
380 lquota_lqe_debug0(lqe, msgdata, fmt, ##a); \
383 void lquota_lqe_debug0(struct lquota_entry *lqe,
384 struct libcfs_debug_msg_data *data, const char *fmt, ...)
385 __attribute__ ((format (printf, 3, 4)));
387 #define LQUOTA_DEBUG_LIMIT(mask, lqe, fmt, a...) do { \
388 static struct cfs_debug_limit_state _lquota_cdls; \
389 LIBCFS_DEBUG_MSG_DATA_DECL(msgdata, mask, &_lquota_cdls); \
390 lquota_lqe_debug(&msgdata, mask, &_lquota_cdls, lqe, "$$$ "fmt" ", \
394 #define LQUOTA_ERROR(lqe, fmt, a...) LQUOTA_DEBUG_LIMIT(D_ERROR, lqe, fmt, ## a)
395 #define LQUOTA_WARN(lqe, fmt, a...) \
396 LQUOTA_DEBUG_LIMIT(D_WARNING, lqe, fmt, ## a)
397 #define LQUOTA_CONSOLE(lqe, fmt, a...) \
398 LQUOTA_DEBUG_LIMIT(D_CONSOLE, lqe, fmt, ## a)
400 #define LQUOTA_ELEVEL_LQES(level, env, fmt, a...) do { \
402 for (i = 0; i < qti_lqes_cnt(env); i++) { \
403 LQUOTA_##level(qti_lqes(env)[i], fmt, ##a); \
406 #define LQUOTA_WARN_LQES(lqe, fmt, a...) \
407 LQUOTA_ELEVEL_LQES(WARN, env, fmt, ##a)
408 #define LQUOTA_CONSOLE_LQES(lqe, fmt, a...) \
409 LQUOTA_ELEVEL_LQES(CONSOLE, env, fmt, ##a)
410 #define LQUOTA_ERROR_LQES(lqe, fmt, a...) \
411 LQUOTA_ELEVEL_LQES(ERROR, env, fmt, ##a)
413 #define LQUOTA_DEBUG(lqe, fmt, a...) do { \
414 LIBCFS_DEBUG_MSG_DATA_DECL(msgdata, D_QUOTA, NULL); \
415 lquota_lqe_debug(&msgdata, D_QUOTA, NULL, lqe, "$$$ "fmt" ", ##a); \
418 #define LQUOTA_DEBUG_LQES(env, fmt, a...) do { \
420 for (i = 0; i < qti_lqes_cnt(env); i++) { \
421 LQUOTA_DEBUG(qti_lqes(env)[i], fmt, ##a); \
426 #else /* !LIBCFS_DEBUG */
427 # define LQUOTA_DEBUG_LQES(lqe, fmt, a...) ((void)0)
428 # define LQUOTA_ERROR_LQES(lqe, fmt, a...) ((void)0)
429 # define LQUOTA_WARN_LQES(lqe, fmt, a...) ((void)0)
430 # define LQUOTA_CONSOLE_LQES(lqe, fmt, a...) ((void)0)
431 # define LQUOTA_DEBUG(lqe, fmt, a...) ((void)0)
432 # define LQUOTA_ERROR(lqe, fmt, a...) ((void)0)
433 # define LQUOTA_WARN(lqe, fmt, a...) ((void)0)
434 # define LQUOTA_CONSOLE(lqe, fmt, a...) ((void)0)
435 # define lquota_lqe_debug(cdls, level, lqe, file, func, line, fmt, a...) \
440 struct dt_object *acct_obj_lookup(const struct lu_env *, struct dt_device *,
442 void lquota_generate_fid(struct lu_fid *, int, int);
443 int lquota_extract_fid(const struct lu_fid *, int *, int *);
444 const struct dt_index_features *glb_idx_feature(struct lu_fid *);
447 /* site create/destroy */
448 struct lquota_site *lquota_site_alloc(const struct lu_env *env, void *parent,
449 bool master, short qtype,
450 const struct lquota_entry_operations *op);
451 void lquota_site_free(const struct lu_env *, struct lquota_site *);
452 /* quota entry operations */
453 #define lqe_locate(env, site, id) lqe_locate_find(env, site, id, false)
454 #define lqe_find(env, site, id) lqe_locate_find(env, site, id, true)
455 struct lquota_entry *lqe_locate_find(const struct lu_env *,
456 struct lquota_site *,
457 union lquota_id *, bool);
460 struct dt_object *lquota_disk_dir_find_create(const struct lu_env *,
462 struct dt_object *, const char *);
463 struct dt_object *lquota_disk_glb_find_create(const struct lu_env *,
466 struct lu_fid *, bool);
467 struct dt_object *lquota_disk_slv_find_create(const struct lu_env *,
471 struct obd_uuid *, bool);
472 typedef int (*lquota_disk_slv_cb_t) (const struct lu_env *, struct lu_fid *,
473 char *, struct lu_fid *, void *);
474 int lquota_disk_for_each_slv(const struct lu_env *, struct dt_object *,
475 struct lu_fid *, lquota_disk_slv_cb_t, void *);
476 struct dt_object *lquota_disk_slv_find(const struct lu_env *,
477 struct dt_device *, struct dt_object *,
478 const struct lu_fid *,
480 int lquota_disk_read(const struct lu_env *, struct dt_object *,
481 union lquota_id *, struct dt_rec *);
482 int lquota_disk_declare_write(const struct lu_env *, struct thandle *,
483 struct dt_object *, union lquota_id *);
484 int lquota_disk_write(const struct lu_env *, struct thandle *,
485 struct dt_object *, union lquota_id *, struct dt_rec *,
487 int lquota_disk_update_ver(const struct lu_env *, struct dt_device *,
488 struct dt_object *, __u64);
489 int lquota_disk_write_glb(const struct lu_env *, struct dt_object *, __u64,
490 struct lquota_glb_rec *);
493 int qmt_glb_init(void);
494 void qmt_glb_fini(void);
497 extern const struct proc_ops lprocfs_quota_seq_fops;
500 int qsd_glb_init(void);
501 void qsd_glb_fini(void);
502 #endif /* _LQUOTA_INTERNAL_H */