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, 2013, Intel Corporation.
25 * Use is subject to license terms.
27 * Author: Johann Lombardi <johann.lombardi@intel.com>
28 * Author: Niu Yawei <yawei.niu@intel.com>
32 # define EXPORT_SYMTAB
35 #define DEBUG_SUBSYSTEM S_LQUOTA
37 #include <lustre_dlm.h>
38 #include <obd_class.h>
40 #include "qsd_internal.h"
42 typedef int (enqi_bl_cb_t)(struct ldlm_lock *lock,
43 struct ldlm_lock_desc *desc, void *data,
45 static enqi_bl_cb_t qsd_glb_blocking_ast, qsd_id_blocking_ast;
47 typedef int (enqi_gl_cb_t)(struct ldlm_lock *lock, void *data);
48 static enqi_gl_cb_t qsd_glb_glimpse_ast, qsd_id_glimpse_ast;
50 struct ldlm_enqueue_info qsd_glb_einfo = {
51 .ei_type = LDLM_PLAIN,
53 .ei_cb_bl = qsd_glb_blocking_ast,
54 .ei_cb_cp = ldlm_completion_ast,
55 .ei_cb_gl = qsd_glb_glimpse_ast,
58 struct ldlm_enqueue_info qsd_id_einfo = {
59 .ei_type = LDLM_PLAIN,
61 .ei_cb_bl = qsd_id_blocking_ast,
62 .ei_cb_cp = ldlm_completion_ast,
63 .ei_cb_gl = qsd_id_glimpse_ast,
67 * Return qsd_qtype_info structure associated with a global lock
69 * \param lock - is the global lock from which we should extract the qqi
70 * \param reset - whether lock->l_ast_data should be cleared
72 static struct qsd_qtype_info *qsd_glb_ast_data_get(struct ldlm_lock *lock,
74 struct qsd_qtype_info *qqi;
77 lock_res_and_lock(lock);
78 qqi = lock->l_ast_data;
82 lock->l_ast_data = NULL;
84 unlock_res_and_lock(lock);
87 /* it is not safe to call lu_ref_add() under spinlock */
88 lu_ref_add(&qqi->qqi_reference, "ast_data_get", lock);
90 if (reset && qqi != NULL) {
91 /* release qqi reference hold for the lock */
92 lu_ref_del(&qqi->qqi_reference, "glb_lock", lock);
99 * Return lquota entry structure associated with a per-ID lock
101 * \param lock - is the per-ID lock from which we should extract the lquota
103 * \param reset - whether lock->l_ast_data should be cleared
105 static struct lquota_entry *qsd_id_ast_data_get(struct ldlm_lock *lock,
107 struct lquota_entry *lqe;
110 lock_res_and_lock(lock);
111 lqe = lock->l_ast_data;
115 lock->l_ast_data = NULL;
117 unlock_res_and_lock(lock);
119 if (reset && lqe != NULL)
120 /* release lqe reference hold for the lock */
126 * Glimpse callback handler for all quota locks. This function extracts
127 * information from the glimpse request.
129 * \param lock - is the lock targeted by the glimpse
130 * \param data - is a pointer to the glimpse ptlrpc request
131 * \param req - is the glimpse request
132 * \param desc - is the glimpse descriptor describing the purpose of the glimpse
134 * \param lvb - is the pointer to the lvb in the reply buffer
136 * \retval 0 on success and \desc, \lvb & \arg point to a valid structures,
137 * appropriate error on failure
139 static int qsd_common_glimpse_ast(struct ptlrpc_request *req,
140 struct ldlm_gl_lquota_desc **desc, void **lvb)
145 LASSERT(lustre_msg_get_opc(req->rq_reqmsg) == LDLM_GL_CALLBACK);
147 /* glimpse on quota locks always packs a glimpse descriptor */
148 req_capsule_extend(&req->rq_pill, &RQF_LDLM_GL_DESC_CALLBACK);
150 /* extract glimpse descriptor */
151 *desc = req_capsule_client_get(&req->rq_pill, &RMF_DLM_GL_DESC);
156 req_capsule_set_size(&req->rq_pill, &RMF_DLM_LVB, RCL_SERVER,
157 sizeof(struct lquota_lvb));
158 rc = req_capsule_server_pack(&req->rq_pill);
160 CERROR("Can't pack response, rc %d\n", rc);
165 *lvb = req_capsule_server_get(&req->rq_pill, &RMF_DLM_LVB);
171 * Blocking callback handler for global index lock
173 * \param lock - is the lock for which ast occurred.
174 * \param desc - is the description of a conflicting lock in case of blocking
176 * \param data - is the value of lock->l_ast_data
177 * \param flag - LDLM_CB_BLOCKING or LDLM_CB_CANCELING. Used to distinguish
178 * cancellation and blocking ast's.
180 static int qsd_glb_blocking_ast(struct ldlm_lock *lock,
181 struct ldlm_lock_desc *desc, void *data,
188 case LDLM_CB_BLOCKING: {
189 struct lustre_handle lockh;
191 LDLM_DEBUG(lock, "blocking AST on global quota lock");
192 ldlm_lock2handle(lock, &lockh);
193 rc = ldlm_cli_cancel(&lockh, LCF_ASYNC);
196 case LDLM_CB_CANCELING: {
197 struct qsd_qtype_info *qqi;
199 LDLM_DEBUG(lock, "canceling global quota lock");
201 qqi = qsd_glb_ast_data_get(lock, true);
205 /* we are losing the global index lock, so let's mark the
206 * global & slave indexes as not up-to-date any more */
207 write_lock(&qqi->qqi_qsd->qsd_lock);
208 qqi->qqi_glb_uptodate = false;
209 qqi->qqi_slv_uptodate = false;
210 if (lock->l_handle.h_cookie == qqi->qqi_lockh.cookie)
211 memset(&qqi->qqi_lockh, 0, sizeof(qqi->qqi_lockh));
212 write_unlock(&qqi->qqi_qsd->qsd_lock);
214 CDEBUG(D_QUOTA, "%s: losing global index lock for %s type\n",
215 qqi->qqi_qsd->qsd_svname, QTYPE_NAME((qqi->qqi_qtype)));
217 /* kick off reintegration thread if not running already, if
218 * it's just local cancel (for stack clean up or eviction),
219 * don't re-trigger the reintegration. */
220 if ((lock->l_flags & LDLM_FL_LOCAL_ONLY) == 0)
221 qsd_start_reint_thread(qqi);
223 lu_ref_del(&qqi->qqi_reference, "ast_data_get", lock);
228 LASSERTF(0, "invalid flags for blocking ast %d", flag);
235 * Glimpse callback handler for global quota lock.
237 * \param lock - is the lock targeted by the glimpse
238 * \param data - is a pointer to the glimpse ptlrpc request
240 static int qsd_glb_glimpse_ast(struct ldlm_lock *lock, void *data)
242 struct ptlrpc_request *req = data;
243 struct qsd_qtype_info *qqi;
244 struct ldlm_gl_lquota_desc *desc;
245 struct lquota_lvb *lvb;
246 struct lquota_glb_rec rec;
250 rc = qsd_common_glimpse_ast(req, &desc, (void **)&lvb);
254 qqi = qsd_glb_ast_data_get(lock, false);
257 GOTO(out, rc = -ELDLM_NO_LOCK_DATA);
259 CDEBUG(D_QUOTA, "%s: glimpse on glb quota locks, id:"LPU64" ver:"LPU64
260 " hard:" LPU64" soft:"LPU64"\n", qqi->qqi_qsd->qsd_svname,
261 desc->gl_id.qid_uid, desc->gl_ver, desc->gl_hardlimit,
264 if (desc->gl_ver == 0) {
265 CERROR("%s: invalid global index version "LPU64"\n",
266 qqi->qqi_qsd->qsd_svname, desc->gl_ver);
267 GOTO(out_qqi, rc = -EINVAL);
270 /* extract new hard & soft limits from the glimpse descriptor */
271 rec.qbr_hardlimit = desc->gl_hardlimit;
272 rec.qbr_softlimit = desc->gl_softlimit;
273 rec.qbr_time = desc->gl_time;
276 /* We can't afford disk io in the context of glimpse callback handling
277 * thread, so the on-disk global limits update has to be deferred. */
278 qsd_upd_schedule(qqi, NULL, &desc->gl_id, (union lquota_rec *)&rec,
282 lu_ref_del(&qqi->qqi_reference, "ast_data_get", lock);
290 * Blocking callback handler for per-ID lock
292 * \param lock - is the lock for which ast occurred.
293 * \param desc - is the description of a conflicting lock in case of blocking
295 * \param data - is the value of lock->l_ast_data
296 * \param flag - LDLM_CB_BLOCKING or LDLM_CB_CANCELING. Used to distinguish
297 * cancellation and blocking ast's.
299 static int qsd_id_blocking_ast(struct ldlm_lock *lock, struct ldlm_lock_desc *desc,
300 void *data, int flag)
302 struct lustre_handle lockh;
307 case LDLM_CB_BLOCKING: {
309 LDLM_DEBUG(lock, "blocking AST on ID quota lock");
310 ldlm_lock2handle(lock, &lockh);
311 rc = ldlm_cli_cancel(&lockh, LCF_ASYNC);
314 case LDLM_CB_CANCELING: {
316 struct lquota_entry *lqe;
319 LDLM_DEBUG(lock, "canceling global quota lock");
320 lqe = qsd_id_ast_data_get(lock, true);
324 LQUOTA_DEBUG(lqe, "losing ID lock");
326 /* just local cancel (for stack clean up or eviction), don't
327 * release quota space in this case */
328 if ((lock->l_flags & LDLM_FL_LOCAL_ONLY) != 0) {
333 /* allocate environment */
341 /* initialize environment */
342 rc = lu_env_init(env, LCT_DT_THREAD);
349 ldlm_lock2handle(lock, &lockh);
351 if (lustre_handle_equal(&lockh, &lqe->lqe_lockh)) {
352 /* Clear lqe_lockh & reset qunit to 0 */
353 qsd_set_qunit(lqe, 0);
354 memset(&lqe->lqe_lockh, 0, sizeof(lqe->lqe_lockh));
355 lqe->lqe_edquot = false;
358 lqe_write_unlock(lqe);
360 /* If there is qqacq inflight, the release will be skipped
361 * at this time, and triggered on dqacq completion later,
362 * which means there could be a short window that slave is
363 * holding spare grant wihtout per-ID lock. */
365 rc = qsd_adjust(env, lqe);
367 /* release lqe reference grabbed by qsd_id_ast_data_get() */
374 LASSERTF(0, "invalid flags for blocking ast %d", flag);
381 * Glimpse callback handler for per-ID quota locks.
383 * \param lock - is the lock targeted by the glimpse
384 * \param data - is a pointer to the glimpse ptlrpc request
386 static int qsd_id_glimpse_ast(struct ldlm_lock *lock, void *data)
388 struct ptlrpc_request *req = data;
389 struct lquota_entry *lqe;
390 struct qsd_instance *qsd;
391 struct ldlm_gl_lquota_desc *desc;
392 struct lquota_lvb *lvb;
397 rc = qsd_common_glimpse_ast(req, &desc, (void **)&lvb);
401 lqe = qsd_id_ast_data_get(lock, false);
404 GOTO(out, rc = -ELDLM_NO_LOCK_DATA);
406 LQUOTA_DEBUG(lqe, "glimpse on quota locks, new qunit:"LPU64,
409 qsd = lqe2qqi(lqe)->qqi_qsd;
413 if (desc->gl_qunit != 0 && desc->gl_qunit != lqe->lqe_qunit) {
416 /* extract new qunit from glimpse request */
417 qsd_set_qunit(lqe, desc->gl_qunit);
419 space = lqe->lqe_granted - lqe->lqe_pending_rel;
420 space -= lqe->lqe_usage;
421 space -= lqe->lqe_pending_write + lqe->lqe_waiting_write;
422 space -= lqe->lqe_qunit;
425 if (lqe->lqe_pending_req > 0) {
426 LQUOTA_DEBUG(lqe, "request in flight, postpone "
427 "release of "LPD64, space);
428 lvb->lvb_id_may_rel = space;
430 lqe->lqe_pending_req++;
432 /* release quota space in glimpse reply */
433 LQUOTA_DEBUG(lqe, "releasing "LPD64, space);
434 lqe->lqe_granted -= space;
435 lvb->lvb_id_rel = space;
437 lqe_write_unlock(lqe);
438 /* change the lqe_granted */
439 qsd_upd_schedule(lqe2qqi(lqe), lqe, &lqe->lqe_id,
440 (union lquota_rec *)&lqe->lqe_granted,
444 lqe->lqe_pending_req--;
450 lqe->lqe_edquot = !!(desc->gl_flags & LQUOTA_FL_EDQUOT);
451 lqe_write_unlock(lqe);
454 cfs_waitq_broadcast(&lqe->lqe_waiters);
462 * Check whether a slave already own a ldlm lock for the quota identifier \qid.
464 * \param lockh - is the local lock handle from lquota entry.
465 * \param rlockh - is the remote lock handle of the matched lock, if any.
467 * \retval 0 : on successful look up and \lockh contains the lock handle.
468 * \retval -ENOENT: no lock found
470 int qsd_id_lock_match(struct lustre_handle *lockh, struct lustre_handle *rlockh)
472 struct ldlm_lock *lock;
478 if (!lustre_handle_is_used(lockh))
481 rc = ldlm_lock_addref_try(lockh, qsd_id_einfo.ei_mode);
485 LASSERT(lustre_handle_is_used(lockh));
486 ldlm_lock_dump_handle(D_QUOTA, lockh);
489 /* caller not interested in remote handle */
492 /* look up lock associated with local handle and extract remote handle
493 * to be packed in quota request */
494 lock = ldlm_handle2lock(lockh);
495 LASSERT(lock != NULL);
496 lustre_handle_copy(rlockh, &lock->l_remote_handle);
502 int qsd_id_lock_cancel(const struct lu_env *env, struct lquota_entry *lqe)
504 struct qsd_thread_info *qti = qsd_info(env);
509 if (lqe->lqe_pending_write || lqe->lqe_waiting_write ||
510 lqe->lqe_usage || lqe->lqe_granted) {
511 lqe_write_unlock(lqe);
515 lustre_handle_copy(&qti->qti_lockh, &lqe->lqe_lockh);
516 if (lustre_handle_is_used(&qti->qti_lockh)) {
517 memset(&lqe->lqe_lockh, 0, sizeof(lqe->lqe_lockh));
518 qsd_set_qunit(lqe, 0);
519 lqe->lqe_edquot = false;
521 lqe_write_unlock(lqe);
523 rc = qsd_id_lock_match(&qti->qti_lockh, NULL);
527 ldlm_lock_decref_and_cancel(&qti->qti_lockh, qsd_id_einfo.ei_mode);