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 Intel, Inc.
25 * Use is subject to license terms.
28 #include "lquota_internal.h"
30 #ifndef _QMT_INTERNAL_H
31 #define _QMT_INTERNAL_H
34 * The Quota Master Target Device.
35 * The qmt is responsible for:
36 * - all interactions with MDT0 (provide request handlers, share ldlm namespace,
37 * manage ldlm lvbo, ...)
38 * - all quota lock management (i.e. global quota locks as well as per-ID locks)
39 * - manage the quota pool configuration
41 * That's the structure MDT0 connects to in mdt_quota_init().
44 /* Super-class. dt_device/lu_device for this master target */
45 struct dt_device qmt_dt_dev;
47 /* service name of this qmt */
48 char qmt_svname[MAX_OBD_NAME];
50 /* Reference to the next device in the side stack
51 * The child device is actually the OSD device where we store the quota
53 struct obd_export *qmt_child_exp;
54 struct dt_device *qmt_child;
56 /* pointer to ldlm namespace to be used for quota locks */
57 struct ldlm_namespace *qmt_ns;
59 /* Hash table containing a qmt_pool_info structure for each pool
60 * this quota master is in charge of. We only have 2 pools in this
61 * hash for the time being:
62 * - one for quota management on the default metadata pool
63 * - one for quota managment on the default data pool
65 * Once we support quota on non-default pools, then more pools will
66 * be added to this hash table and pool master setup would have to be
67 * handled via configuration logs */
68 cfs_hash_t *qmt_pool_hash;
70 /* List of pools managed by this master target */
71 cfs_list_t qmt_pool_list;
73 /* procfs root directory for this qmt */
74 cfs_proc_dir_entry_t *qmt_proc;
76 /* dedicated thread in charge of space rebalancing */
77 struct ptlrpc_thread qmt_reba_thread;
79 /* list of lqe entry which need space rebalancing */
80 cfs_list_t qmt_reba_list;
82 /* lock protecting rebalancing list */
83 spinlock_t qmt_reba_lock;
85 unsigned long qmt_stopping:1; /* qmt is stopping */
90 * Per-pool quota information.
91 * The qmt creates one such structure for each pool
92 * with quota enforced. All the structures are kept in a hash which is used to
93 * determine whether or not quota is enforced for a given pool.
94 * We currently only support the default data pool and default metadata pool
97 struct qmt_pool_info {
98 /* link to qmt's pool hash */
99 cfs_hlist_node_t qpi_hash;
101 /* chained list of all pools managed by the same qmt */
102 cfs_list_t qpi_linkage;
104 /* Pool key composed of pool_id | (pool_type << 16)
105 * Only pool ID 0 is supported for now and the pool type is either
106 * QUOTA_RES_MD or QUOTA_RES_DT.
107 * immutable after creation. */
110 /* track users of this pool instance */
111 cfs_atomic_t qpi_ref;
113 /* back pointer to master target
114 * immutable after creation. */
115 struct qmt_device *qpi_qmt;
117 /* pointer to dt object associated with global indexes for both user
119 struct dt_object *qpi_glb_obj[MAXQUOTAS];
121 /* A pool supports two different quota types: user and group quota.
122 * Each quota type has its own global index and lquota_entry hash table.
124 struct lquota_site *qpi_site[MAXQUOTAS];
126 /* number of slaves registered for each quota types */
127 int qpi_slv_nr[MAXQUOTAS];
129 /* reference on lqe (ID 0) storing grace time. */
130 struct lquota_entry *qpi_grace_lqe[MAXQUOTAS];
132 /* procfs root directory for this pool */
133 cfs_proc_dir_entry_t *qpi_proc;
135 /* pool directory where all indexes related to this pool instance are
137 struct dt_object *qpi_root;
139 /* Global quota parameters which apply to all quota type */
140 /* the least value of qunit */
141 unsigned long qpi_least_qunit;
145 * Helper routines and prototypes
148 /* helper routine to find qmt_pool_info associated a lquota_entry */
149 static inline struct qmt_pool_info *lqe2qpi(struct lquota_entry *lqe)
151 LASSERT(lqe_is_master(lqe));
152 return (struct qmt_pool_info *)lqe->lqe_site->lqs_parent;
155 /* return true if someone holds either a read or write lock on the lqe */
156 static inline bool lqe_is_locked(struct lquota_entry *lqe)
158 LASSERT(lqe_is_master(lqe));
159 if (down_write_trylock(&lqe->lqe_sem) == 0)
161 lqe_write_unlock(lqe);
165 /* value to be restored if someone wrong happens during lqe writeback */
166 struct qmt_lqe_restore {
174 /* Common data shared by qmt handlers */
175 struct qmt_thread_info {
176 union lquota_rec qti_rec;
177 union lquota_id qti_id;
178 char qti_buf[MTI_NAME_MAXLEN];
179 struct lu_fid qti_fid;
180 struct ldlm_res_id qti_resid;
181 union ldlm_gl_desc qti_gl_desc;
182 struct quota_body qti_body;
183 struct qmt_lqe_restore qti_restore;
186 extern struct lu_context_key qmt_thread_key;
188 /* helper function to extract qmt_thread_info from current environment */
190 struct qmt_thread_info *qmt_info(const struct lu_env *env)
192 struct qmt_thread_info *info;
194 info = lu_context_key_get(&env->le_ctx, &qmt_thread_key);
196 lu_env_refill((struct lu_env *)env);
197 info = lu_context_key_get(&env->le_ctx, &qmt_thread_key);
203 /* helper routine to convert a lu_device into a qmt_device */
204 static inline struct qmt_device *lu2qmt_dev(struct lu_device *ld)
206 return container_of0(lu2dt_dev(ld), struct qmt_device, qmt_dt_dev);
209 /* helper routine to convert a qmt_device into lu_device */
210 static inline struct lu_device *qmt2lu_dev(struct qmt_device *qmt)
212 return &qmt->qmt_dt_dev.dd_lu_dev;
215 #define LQE_ROOT(lqe) (lqe2qpi(lqe)->qpi_root)
216 #define LQE_GLB_OBJ(lqe) (lqe2qpi(lqe)->qpi_glb_obj[lqe->lqe_site->lqs_qtype])
218 /* helper function returning grace time to use for a given lquota entry */
219 static inline __u64 qmt_lqe_grace(struct lquota_entry *lqe)
221 struct qmt_pool_info *pool = lqe2qpi(lqe);
222 struct lquota_entry *grace_lqe;
224 grace_lqe = pool->qpi_grace_lqe[lqe->lqe_site->lqs_qtype];
225 LASSERT(grace_lqe != NULL);
227 return grace_lqe->lqe_gracetime;
230 static inline void qmt_restore(struct lquota_entry *lqe,
231 struct qmt_lqe_restore *restore)
233 lqe->lqe_hardlimit = restore->qlr_hardlimit;
234 lqe->lqe_softlimit = restore->qlr_softlimit;
235 lqe->lqe_gracetime = restore->qlr_gracetime;
236 lqe->lqe_granted = restore->qlr_granted;
237 lqe->lqe_qunit = restore->qlr_qunit;
240 #define QMT_GRANT(lqe, slv, cnt) \
242 (lqe)->lqe_granted += (cnt); \
245 #define QMT_REL(lqe, slv, cnt) \
247 (lqe)->lqe_granted -= (cnt); \
251 /* helper routine returning true when the id has run out of quota space, which
252 * means that it has either:
253 * - reached hardlimit
255 * - reached softlimit and grace time expired already */
256 static inline bool qmt_space_exhausted(struct lquota_entry *lqe, __u64 now)
258 if (lqe->lqe_hardlimit != 0 && lqe->lqe_granted >= lqe->lqe_hardlimit)
260 if (lqe->lqe_softlimit != 0 && lqe->lqe_granted > lqe->lqe_softlimit &&
261 lqe->lqe_gracetime != 0 && now >= lqe->lqe_gracetime)
266 /* number of seconds to wait for slaves to release quota space after
268 #define QMT_REBA_TIMEOUT 2
271 void qmt_pool_fini(const struct lu_env *, struct qmt_device *);
272 int qmt_pool_init(const struct lu_env *, struct qmt_device *);
273 int qmt_pool_prepare(const struct lu_env *, struct qmt_device *,
275 int qmt_pool_new_conn(const struct lu_env *, struct qmt_device *,
276 struct lu_fid *, struct lu_fid *, __u64 *,
278 struct lquota_entry *qmt_pool_lqe_lookup(const struct lu_env *,
279 struct qmt_device *, int, int, int,
282 extern struct lquota_entry_operations qmt_lqe_ops;
283 struct thandle *qmt_trans_start_with_slv(const struct lu_env *,
284 struct lquota_entry *,
286 struct qmt_lqe_restore *);
287 struct thandle *qmt_trans_start(const struct lu_env *, struct lquota_entry *,
288 struct qmt_lqe_restore *);
289 int qmt_glb_write(const struct lu_env *, struct thandle *,
290 struct lquota_entry *, __u32, __u64 *);
291 int qmt_slv_write(const struct lu_env *, struct thandle *,
292 struct lquota_entry *, struct dt_object *, __u32, __u64 *,
294 int qmt_slv_read(const struct lu_env *, struct lquota_entry *,
295 struct dt_object *, __u64 *);
296 int qmt_validate_limits(struct lquota_entry *, __u64, __u64);
297 void qmt_adjust_qunit(const struct lu_env *, struct lquota_entry *);
298 void qmt_adjust_edquot(struct lquota_entry *, __u64);
299 void qmt_revalidate(const struct lu_env *, struct lquota_entry *);
300 __u64 qmt_alloc_expand(struct lquota_entry *, __u64, __u64);
303 int qmt_dqacq0(const struct lu_env *, struct lquota_entry *,
304 struct qmt_device *, struct obd_uuid *, __u32, __u64, __u64,
305 struct quota_body *);
308 int qmt_intent_policy(const struct lu_env *, struct lu_device *,
309 struct ptlrpc_request *, struct ldlm_lock **, int);
310 int qmt_lvbo_init(struct lu_device *, struct ldlm_resource *);
311 int qmt_lvbo_update(struct lu_device *, struct ldlm_resource *,
312 struct ptlrpc_request *, int);
313 int qmt_lvbo_size(struct lu_device *, struct ldlm_lock *);
314 int qmt_lvbo_fill(struct lu_device *, struct ldlm_lock *, void *, int);
315 int qmt_lvbo_free(struct lu_device *, struct ldlm_resource *);
316 int qmt_start_reba_thread(struct qmt_device *);
317 void qmt_stop_reba_thread(struct qmt_device *);
318 void qmt_glb_lock_notify(const struct lu_env *, struct lquota_entry *, __u64);
319 void qmt_id_lock_notify(struct qmt_device *, struct lquota_entry *);
320 #endif /* _QMT_INTERNAL_H */