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 Whamcloud, Inc.
25 * Use is subject to license terms.
29 #include <lustre_quota.h>
31 #ifndef _LQUOTA_INTERNAL_H
32 #define _LQUOTA_INTERNAL_H
34 #define QTYPE_NAME(qtype) ((qtype) == USRQUOTA ? "usr" : "grp")
35 #define RES_NAME(res) ((res) == LQUOTA_RES_MD ? "md" : "dt")
37 #define QIF_IFLAGS (QIF_INODES | QIF_ITIME | QIF_ILIMITS)
38 #define QIF_BFLAGS (QIF_SPACE | QIF_BTIME | QIF_BLIMITS)
40 /* The biggest filename are the one used for slave index which are in the form
41 * of 0x%x-%s,glb_fid.f_oid,slv_uuid, that's to say:
42 * 2(0x) + 8(f_oid) + 1(-) + 40(UUID_MAX) which means 51 chars + '\0' */
43 #define LQUOTA_NAME_MAX 52
45 /* reserved OID in FID_SEQ_QUOTA for local objects */
46 enum lquota_local_oid {
47 LQUOTA_USR_OID = 1UL, /* slave index copy for user quota */
48 LQUOTA_GRP_OID = 2UL, /* slave index copy for group quota */
49 /* all OIDs after this are allocated dynamically by the QMT */
50 LQUOTA_GENERATED_OID = 4096UL,
54 * lquota_entry support
57 /* Common operations supported by a lquota_entry */
58 struct lquota_entry_operations {
59 /* Initialize specific fields of a lquota entry */
60 void (*lqe_init)(struct lquota_entry *, void *arg);
62 /* Read quota settings from disk and update lquota entry */
63 int (*lqe_read)(const struct lu_env *, struct lquota_entry *,
66 /* Print debug information about a given lquota entry */
67 void (*lqe_debug)(struct lquota_entry *, void *,
68 struct libcfs_debug_msg_data *, const char *,
72 /* Per-ID information specific to the quota master target */
73 struct lquota_mst_entry {
74 /* global hard limit, in inodes or kbytes */
77 /* global quota soft limit, in inodes or kbytes */
80 /* grace time, in seconds */
83 /* last time we glimpsed */
84 __u64 lme_revoke_time;
86 /* r/w semaphore used to protect concurrent access to the quota
87 * parameters which are stored on disk */
88 struct rw_semaphore lme_sem;
90 /* quota space that may be released after glimpse */
94 /* Per-ID information specific to the quota slave */
95 struct lquota_slv_entry {
96 /* [ib]tune size, inodes or kbytes */
99 /* per-ID lock handle */
100 struct lustre_handle lse_lockh;
102 /* pending write which were granted quota space but haven't completed
103 * yet, in inodes or kbytes. */
104 __u64 lse_pending_write;
106 /* writes waiting for quota space, in inodes or kbytes. */
107 __u64 lse_waiting_write;
109 /* pending release, in inodes or kbytes */
110 __u64 lse_pending_rel;
112 /* pending dqacq/dqrel requests. */
113 unsigned int lse_pending_req;
115 /* rw spinlock protecting in-memory counters (i.e. lse_pending*) */
118 /* waiter for pending request done */
119 cfs_waitq_t lse_waiters;
121 /* hint on current on-disk usage, in inodes or kbytes */
124 /* time to trigger quota adjust */
125 __u64 lse_adjust_time;
127 /* return code of latest acquire RPC */
130 /* when latest acquire RPC completed */
134 /* In-memory entry for each enforced quota id
135 * A lquota_entry structure belong to a single lquota_site */
136 struct lquota_entry {
137 /* link to site hash table */
138 cfs_hlist_node_t lqe_hash;
140 /* quota identifier associated with this entry */
141 union lquota_id lqe_id;
143 /* site this quota entry belongs to */
144 struct lquota_site *lqe_site;
146 /* reference counter */
147 cfs_atomic_t lqe_ref;
149 /* linked to list of lqes which:
150 * - need quota space adjustment on slave
151 * - need glimpse to be sent on master */
154 /* current quota settings/usage of this ID */
155 __u64 lqe_granted; /* granted limit, inodes or kbytes */
156 __u64 lqe_qunit; /* [ib]unit size, inodes or kbytes */
158 struct lquota_mst_entry me; /* params specific to QMT */
159 struct lquota_slv_entry se; /* params specific to QSD */
162 /* flags describing the state of the lquota_entry */
163 unsigned long lqe_enforced:1,/* quota enforced or not */
164 lqe_uptodate:1,/* successfully read from disk */
165 lqe_edquot:1, /* id out of quota space on QMT */
166 lqe_gl:1, /* glimpse is in progress */
167 lqe_nopreacq:1;/* pre-acquire disabled */
170 /* Compartment within which lquota_entry are unique.
171 * lquota_entry structures are kept in a hash table and read from disk if not
174 /* Hash table storing lquota_entry structures */
175 cfs_hash_t *lqs_hash;
177 /* Quota type, either user or group. */
180 /* Record whether this site is for a QMT or a slave */
183 /* Vector of operations which can be done on lquota entry belonging to
185 struct lquota_entry_operations *lqs_ops;
187 /* Backpointer to parent structure, either QMT pool info for master or
192 #define lqe_hardlimit u.me.lme_hardlimit
193 #define lqe_softlimit u.me.lme_softlimit
194 #define lqe_gracetime u.me.lme_gracetime
195 #define lqe_revoke_time u.me.lme_revoke_time
196 #define lqe_sem u.me.lme_sem
197 #define lqe_may_rel u.me.lme_may_rel
199 #define lqe_qtune u.se.lse_qtune
200 #define lqe_pending_write u.se.lse_pending_write
201 #define lqe_waiting_write u.se.lse_waiting_write
202 #define lqe_pending_rel u.se.lse_pending_rel
203 #define lqe_pending_req u.se.lse_pending_req
204 #define lqe_waiters u.se.lse_waiters
205 #define lqe_lock u.se.lse_lock
206 #define lqe_usage u.se.lse_usage
207 #define lqe_adjust_time u.se.lse_adjust_time
208 #define lqe_lockh u.se.lse_lockh
209 #define lqe_acq_rc u.se.lse_acq_rc
210 #define lqe_acq_time u.se.lse_acq_time
212 #define LQUOTA_BUMP_VER 0x1
213 #define LQUOTA_SET_VER 0x2
215 /* helper routine to get/put reference on lquota_entry */
216 static inline void lqe_getref(struct lquota_entry *lqe)
218 LASSERT(lqe != NULL);
219 cfs_atomic_inc(&lqe->lqe_ref);
222 static inline void lqe_putref(struct lquota_entry *lqe)
224 LASSERT(lqe != NULL);
225 LASSERT(atomic_read(&lqe->lqe_ref) > 0);
226 if (atomic_dec_and_test(&lqe->lqe_ref))
230 static inline int lqe_is_master(struct lquota_entry *lqe)
232 return lqe->lqe_site->lqs_is_mst;
235 /* lqe locking helpers */
236 static inline void lqe_write_lock(struct lquota_entry *lqe)
238 if (lqe_is_master(lqe))
239 down_write(&lqe->lqe_sem);
241 write_lock(&lqe->lqe_lock);
244 static inline void lqe_write_unlock(struct lquota_entry *lqe)
246 if (lqe_is_master(lqe))
247 up_write(&lqe->lqe_sem);
249 write_unlock(&lqe->lqe_lock);
252 static inline void lqe_read_lock(struct lquota_entry *lqe)
254 if (lqe_is_master(lqe))
255 down_read(&lqe->lqe_sem);
257 read_lock(&lqe->lqe_lock);
260 static inline void lqe_read_unlock(struct lquota_entry *lqe)
262 if (lqe_is_master(lqe))
263 up_read(&lqe->lqe_sem);
265 read_unlock(&lqe->lqe_lock);
269 * Helper functions & prototypes
272 /* minimum qunit size, 1K inode for metadata pool and 1MB for data pool */
273 #define LQUOTA_LEAST_QUNIT(type) \
274 (type == LQUOTA_RES_MD ? (1 << 10) : toqb(PTLRPC_MAX_BRW_SIZE))
276 #define LQUOTA_OVER_FL(type) \
277 (type == USRQUOTA ? QUOTA_FL_OVER_USRQUOTA : QUOTA_FL_OVER_GRPQUOTA)
279 /* Common data shared by quota-level handlers. This is allocated per-thread to
280 * reduce stack consumption */
281 struct lquota_thread_info {
282 union lquota_rec qti_rec;
283 struct lu_buf qti_lb;
284 struct lu_attr qti_attr;
285 struct dt_object_format qti_dof;
286 struct lustre_mdt_attrs qti_lma;
287 struct lu_fid qti_fid;
288 char qti_buf[LQUOTA_NAME_MAX];
291 #define qti_glb_rec qti_rec.lqr_glb_rec
292 #define qti_acct_rec qti_rec.lqr_acct_rec
293 #define qti_slv_rec qti_rec.lqr_slv_rec
295 #define LQUOTA_BUMP_VER 0x1
296 #define LQUOTA_SET_VER 0x2
298 extern struct lu_context_key lquota_thread_key;
300 /* extract lquota_threa_info context from environment */
302 struct lquota_thread_info *lquota_info(const struct lu_env *env)
304 struct lquota_thread_info *info;
306 info = lu_context_key_get(&env->le_ctx, &lquota_thread_key);
308 lu_env_refill((struct lu_env *)env);
309 info = lu_context_key_get(&env->le_ctx, &lquota_thread_key);
315 #define req_is_acq(flags) ((flags & QUOTA_DQACQ_FL_ACQ) != 0)
316 #define req_is_preacq(flags) ((flags & QUOTA_DQACQ_FL_PREACQ) != 0)
317 #define req_is_rel(flags) ((flags & QUOTA_DQACQ_FL_REL) != 0)
318 #define req_has_rep(flags) ((flags & QUOTA_DQACQ_FL_REPORT) != 0)
320 /* debugging macros */
322 #define lquota_lqe_debug(msgdata, mask, cdls, lqe, fmt, a...) do { \
323 CFS_CHECK_STACK(msgdata, mask, cdls); \
325 if (((mask) & D_CANTMASK) != 0 || \
326 ((libcfs_debug & (mask)) != 0 && \
327 (libcfs_subsystem_debug & DEBUG_SUBSYSTEM) != 0)) \
328 lquota_lqe_debug0(lqe, msgdata, fmt, ##a); \
331 void lquota_lqe_debug0(struct lquota_entry *lqe,
332 struct libcfs_debug_msg_data *data, const char *fmt, ...)
333 __attribute__ ((format (printf, 3, 4)));
335 #define LQUOTA_DEBUG_LIMIT(mask, lqe, fmt, a...) do { \
336 static cfs_debug_limit_state_t _lquota_cdls; \
337 LIBCFS_DEBUG_MSG_DATA_DECL(msgdata, mask, &_lquota_cdls); \
338 lquota_lqe_debug(&msgdata, mask, &_lquota_cdls, lqe, "$$$ "fmt" ", \
342 #define LQUOTA_ERROR(lqe, fmt, a...) LQUOTA_DEBUG_LIMIT(D_ERROR, lqe, fmt, ## a)
343 #define LQUOTA_WARN(lqe, fmt, a...) \
344 LQUOTA_DEBUG_LIMIT(D_WARNING, lqe, fmt, ## a)
345 #define LQUOTA_CONSOLE(lqe, fmt, a...) \
346 LQUOTA_DEBUG_LIMIT(D_CONSOLE, lqe, fmt, ## a)
348 #define LQUOTA_DEBUG(lock, fmt, a...) do { \
349 LIBCFS_DEBUG_MSG_DATA_DECL(msgdata, D_QUOTA, NULL); \
350 lquota_lqe_debug(&msgdata, D_QUOTA, NULL, lqe, "$$$ "fmt" ", ##a); \
352 #else /* !LIBCFS_DEBUG */
353 # define LQUOTA_DEBUG(lqe, fmt, a...) ((void)0)
354 # define LQUOTA_ERROR(lqe, fmt, a...) ((void)0)
355 # define LQUOTA_WARN(lqe, fmt, a...) ((void)0)
356 # define LQUOTA_CONSOLE(lqe, fmt, a...) ((void)0)
357 # define lquota_lqe_debug(cdls, level, lqe, file, func, line, fmt, a...) \
362 struct dt_object *acct_obj_lookup(const struct lu_env *, struct dt_device *,
364 void lquota_generate_fid(struct lu_fid *, int, int, int);
365 int lquota_extract_fid(const struct lu_fid *, int *, int *, int *);
366 const struct dt_index_features *glb_idx_feature(struct lu_fid *);
367 extern cfs_mem_cache_t *lqe_kmem;
370 /* site create/destroy */
371 struct lquota_site *lquota_site_alloc(const struct lu_env *, void *, bool,
372 short, struct lquota_entry_operations *);
373 void lquota_site_free(const struct lu_env *, struct lquota_site *);
374 /* quota entry operations */
375 struct lquota_entry *lqe_locate(const struct lu_env *, struct lquota_site *,
379 struct dt_object *lquota_disk_dir_find_create(const struct lu_env *,
381 struct dt_object *, const char *);
382 struct dt_object *lquota_disk_glb_find_create(const struct lu_env *,
385 struct lu_fid *, bool);
386 struct dt_object *lquota_disk_slv_find_create(const struct lu_env *,
390 struct obd_uuid *, bool);
391 typedef int (*lquota_disk_slv_cb_t) (const struct lu_env *, struct lu_fid *,
392 char *, struct lu_fid *, void *);
393 int lquota_disk_for_each_slv(const struct lu_env *, struct dt_object *,
394 struct lu_fid *, lquota_disk_slv_cb_t, void *);
395 struct dt_object *lquota_disk_slv_find(const struct lu_env *,
396 struct dt_device *, struct dt_object *,
397 const struct lu_fid *,
399 int lquota_disk_read(const struct lu_env *, struct dt_object *,
400 union lquota_id *, struct dt_rec *);
401 int lquota_disk_declare_write(const struct lu_env *, struct thandle *,
402 struct dt_object *, union lquota_id *);
403 int lquota_disk_write(const struct lu_env *, struct thandle *,
404 struct dt_object *, union lquota_id *, struct dt_rec *,
406 int lquota_disk_update_ver(const struct lu_env *, struct dt_device *,
407 struct dt_object *, __u64);
410 int qmt_glb_init(void);
411 void qmt_glb_fini(void);
414 extern struct file_operations lprocfs_quota_seq_fops;
417 int qsd_glb_init(void);
418 void qsd_glb_fini(void);
419 #endif /* _LQUOTA_INTERNAL_H */