Whamcloud - gitweb
LU-12678 lnet: Fix some out-of-date comments.
[fs/lustre-release.git] / lustre / quota / qmt_lock.c
1 /*
2  * GPL HEADER START
3  *
4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
5  *
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.
9  *
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).
15  *
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
20  *
21  * GPL HEADER END
22  */
23 /*
24  * Copyright (c) 2012, 2017, Intel Corporation.
25  * Use is subject to license terms.
26  *
27  * Author: Johann Lombardi <johann.lombardi@intel.com>
28  * Author: Niu    Yawei    <yawei.niu@intel.com>
29  */
30
31 #define DEBUG_SUBSYSTEM S_LQUOTA
32
33 #include <linux/kthread.h>
34
35 #include <lustre_dlm.h>
36 #include <lustre_swab.h>
37 #include <obd_class.h>
38
39 #include "qmt_internal.h"
40
41 /* intent policy function called from mdt_intent_opc() when the intent is of
42  * quota type */
43 int qmt_intent_policy(const struct lu_env *env, struct lu_device *ld,
44                       struct ptlrpc_request *req, struct ldlm_lock **lockp,
45                       int flags)
46 {
47         struct qmt_device       *qmt = lu2qmt_dev(ld);
48         struct ldlm_intent      *it;
49         struct quota_body       *reqbody;
50         struct quota_body       *repbody;
51         struct obd_uuid         *uuid;
52         struct lquota_lvb       *lvb;
53         struct ldlm_resource    *res = (*lockp)->l_resource;
54         struct ldlm_reply       *ldlm_rep;
55         int                      rc, lvb_len;
56         ENTRY;
57
58         req_capsule_extend(&req->rq_pill, &RQF_LDLM_INTENT_QUOTA);
59         req_capsule_set_size(&req->rq_pill, &RMF_DLM_LVB, RCL_SERVER,
60                              ldlm_lvbo_size(*lockp));
61
62         /* extract quota body and intent opc */
63         it = req_capsule_client_get(&req->rq_pill, &RMF_LDLM_INTENT);
64         if (it == NULL)
65                 RETURN(err_serious(-EFAULT));
66
67         reqbody = req_capsule_client_get(&req->rq_pill, &RMF_QUOTA_BODY);
68         if (reqbody == NULL)
69                 RETURN(err_serious(-EFAULT));
70
71         /* prepare reply */
72         rc = req_capsule_server_pack(&req->rq_pill);
73         if (rc != 0) {
74                 CERROR("Can't pack response, rc %d\n", rc);
75                 RETURN(err_serious(rc));
76         }
77
78         repbody = req_capsule_server_get(&req->rq_pill, &RMF_QUOTA_BODY);
79         if (repbody == NULL)
80                 RETURN(err_serious(-EFAULT));
81
82         ldlm_rep = req_capsule_server_get(&req->rq_pill, &RMF_DLM_REP);
83         if (ldlm_rep == NULL)
84                 RETURN(err_serious(-EFAULT));
85
86         uuid = &(*lockp)->l_export->exp_client_uuid;
87         switch (it->opc) {
88
89         case IT_QUOTA_DQACQ: {
90                 struct lquota_entry     *lqe;
91                 struct ldlm_lock        *lock;
92                 int idx;
93
94                 if (res->lr_name.name[LUSTRE_RES_ID_QUOTA_SEQ_OFF] == 0)
95                         /* acquire on global lock? something is wrong ... */
96                         GOTO(out, rc = -EPROTO);
97
98                 /* verify global lock isn't stale */
99                 if (!lustre_handle_is_used(&reqbody->qb_glb_lockh))
100                         GOTO(out, rc = -ENOLCK);
101
102                 lock = ldlm_handle2lock(&reqbody->qb_glb_lockh);
103                 if (lock == NULL)
104                         GOTO(out, rc = -ENOLCK);
105                 LDLM_LOCK_PUT(lock);
106
107                 rc = qmt_uuid2idx(uuid, &idx);
108                 if (rc < 0)
109                         GOTO(out, rc = -EINVAL);
110
111                 /* TODO: it seems we don't need to get lqe from
112                  * lq_lvb_data anymore ... And do extra get
113                  * and put on it */
114                 lqe = res->lr_lvb_data;
115                 LASSERT(lqe != NULL);
116                 lqe_getref(lqe);
117
118                 rc = qmt_pool_lqes_lookup(env, qmt, lqe_rtype(lqe), rc,
119                                           lqe_qtype(lqe), &reqbody->qb_id,
120                                           NULL, idx);
121                 if (rc) {
122                         lqe_putref(lqe);
123                         GOTO(out, rc);
124                 }
125
126                 /* acquire quota space */
127                 rc = qmt_dqacq0(env, qmt, uuid,
128                                 reqbody->qb_flags, reqbody->qb_count,
129                                 reqbody->qb_usage, repbody);
130                 lqe_putref(lqe);
131                 qti_lqes_fini(env);
132                 if (rc)
133                         GOTO(out, rc);
134                 break;
135         }
136
137         case IT_QUOTA_CONN:
138                 /* new connection from slave */
139
140                 if (res->lr_name.name[LUSTRE_RES_ID_QUOTA_SEQ_OFF] != 0)
141                         /* connection on per-ID lock? something is wrong ... */
142                         GOTO(out, rc = -EPROTO);
143
144                 rc = qmt_pool_new_conn(env, qmt, &reqbody->qb_fid,
145                                        &repbody->qb_slv_fid,
146                                        &repbody->qb_slv_ver, uuid);
147                 if (rc)
148                         GOTO(out, rc);
149                 break;
150
151         default:
152                 CERROR("%s: invalid intent opcode: %llu\n", qmt->qmt_svname,
153                        it->opc);
154                 GOTO(out, rc = -EINVAL);
155         }
156
157         /* on success, pack lvb in reply */
158         lvb = req_capsule_server_get(&req->rq_pill, &RMF_DLM_LVB);
159         lvb_len = ldlm_lvbo_size(*lockp);
160         lvb_len = ldlm_lvbo_fill(*lockp, lvb, &lvb_len);
161         if (lvb_len < 0)
162                 GOTO(out, rc = lvb_len);
163
164         req_capsule_shrink(&req->rq_pill, &RMF_DLM_LVB, lvb_len, RCL_SERVER);
165 out:
166         ldlm_rep->lock_policy_res2 = clear_serious(rc);
167         EXIT;
168         return ELDLM_OK;
169 }
170
171 /*
172  * Initialize quota LVB associated with quota indexes.
173  * Called with res->lr_lvb_sem held
174  */
175 int qmt_lvbo_init(struct lu_device *ld, struct ldlm_resource *res)
176 {
177         struct lu_env           *env;
178         struct qmt_thread_info  *qti;
179         struct qmt_device       *qmt = lu2qmt_dev(ld);
180         int                      pool_type, qtype;
181         int                      rc;
182         ENTRY;
183
184         LASSERT(res != NULL);
185
186         if (res->lr_type != LDLM_PLAIN)
187                 RETURN(-ENOTSUPP);
188
189         if (res->lr_lvb_data ||
190             res->lr_name.name[LUSTRE_RES_ID_SEQ_OFF] != FID_SEQ_QUOTA_GLB)
191                 RETURN(0);
192
193         env = lu_env_find();
194         LASSERT(env);
195         qti = qmt_info(env);
196
197         /* extract global index FID and quota identifier */
198         fid_extract_from_quota_res(&qti->qti_fid, &qti->qti_id, &res->lr_name);
199
200         /* sanity check the global index FID */
201         rc = lquota_extract_fid(&qti->qti_fid, &pool_type, &qtype);
202         if (rc) {
203                 CERROR("can't extract glb index information from FID "DFID"\n",
204                        PFID(&qti->qti_fid));
205                 GOTO(out, rc);
206         }
207
208         if (res->lr_name.name[LUSTRE_RES_ID_QUOTA_SEQ_OFF] != 0) {
209                 /* no ID quota lock associated with UID/GID 0 or with a seq 0,
210                  * we are thus dealing with an ID lock. */
211                 struct qmt_pool_info    *pool;
212                 struct lquota_entry     *lqe;
213                 struct lqe_glbl_data    *lgd;
214
215                 pool = qmt_pool_lookup_glb(env, qmt, pool_type);
216                 if (IS_ERR(pool))
217                         GOTO(out, rc = -ENOMEM);
218
219                 /* Find the quota entry associated with the quota id */
220                 lqe = qmt_pool_lqe_lookup(env, qmt, pool_type, qtype,
221                                           &qti->qti_id, NULL);
222                 if (IS_ERR(lqe)) {
223                         qpi_putref(env, pool);
224                         GOTO(out, rc = PTR_ERR(lqe));
225                 }
226
227                 /* TODO: need something like qmt_extend_lqe_gd that has
228                  * to be calledeach time when qpi_slv_nr is incremented */
229                 lgd = qmt_alloc_lqe_gd(pool, qtype);
230                 if (!lgd) {
231                         lqe_putref(lqe);
232                         qpi_putref(env, pool);
233                         GOTO(out, rc = -ENOMEM);
234                 }
235
236                 qmt_setup_lqe_gd(env, qmt, lqe, lgd, pool_type);
237
238                 /* store reference to lqe in lr_lvb_data */
239                 res->lr_lvb_data = lqe;
240                 qpi_putref(env, pool);
241                 LQUOTA_DEBUG(lqe, "initialized res lvb");
242         } else {
243                 struct dt_object        *obj;
244
245                 /* lookup global index */
246                 obj = dt_locate(env, qmt->qmt_child, &qti->qti_fid);
247                 if (IS_ERR(obj))
248                         GOTO(out, rc = PTR_ERR(obj));
249                 if (!dt_object_exists(obj)) {
250                         dt_object_put(env, obj);
251                         GOTO(out, rc = -ENOENT);
252                 }
253
254                 /* store reference to global index object in lr_lvb_data */
255                 res->lr_lvb_data = obj;
256                 CDEBUG(D_QUOTA, DFID" initialized lvb\n", PFID(&qti->qti_fid));
257         }
258
259         res->lr_lvb_len = sizeof(struct lquota_lvb);
260         EXIT;
261 out:
262         return rc;
263 }
264
265 /* clear lge_qunit/edquot_nu flags -
266  * slave recieved new qunit and edquot.
267  *
268  * \retval      true if revoke is needed - qunit
269  *              for this slave reaches least_qunit
270  */
271 static bool qmt_clear_lgeg_arr_nu(struct lquota_entry *lqe, int stype, int idx)
272 {
273         unsigned long least_qunit = lqe2qpi(lqe)->qpi_least_qunit;
274         struct lqe_glbl_data *lgd = lqe->lqe_glbl_data;
275
276         /* There is no array to store lge for the case of DOM.
277          * Ignore it until MDT pools will be ready. */
278         if (!(lqe_rtype(lqe) == LQUOTA_RES_DT && stype == QMT_STYPE_MDT)) {
279                 lqe->lqe_glbl_data->lqeg_arr[idx].lge_qunit_nu = 0;
280                 lqe->lqe_glbl_data->lqeg_arr[idx].lge_edquot_nu = 0;
281
282                 /* We shouldn't call revoke for DOM case, it will be updated
283                  * at qmt_id_lock_glimpse. */
284                 return (lgd->lqeg_arr[idx].lge_qunit == least_qunit);
285         }
286
287         return false;
288 }
289
290 static void qmt_set_revoke(struct lu_env *env, struct lquota_entry *lqe,
291                           int stype, int idx)
292 {
293         unsigned long least_qunit = lqe2qpi(lqe)->qpi_least_qunit;
294         struct lqe_glbl_data *lgd = lqe->lqe_glbl_data;
295
296         if (lgd->lqeg_arr[idx].lge_qunit == least_qunit) {
297                 int i;
298
299                 qti_lqes_write_lock(env);
300                 for (i = 0; i < qti_lqes_cnt(env); i++) {
301                         LQUOTA_DEBUG(qti_lqes(env)[i],
302                                      "idx %d lge_qunit %llu least_qunit %lu\n",
303                                      idx, lgd->lqeg_arr[idx].lge_qunit,
304                                      least_qunit);
305                         if (qti_lqes(env)[i]->lqe_qunit == least_qunit) {
306                                 qti_lqes(env)[i]->lqe_revoke_time =
307                                                         ktime_get_seconds();
308                                 qmt_adjust_edquot(qti_lqes(env)[i],
309                                                   ktime_get_real_seconds());
310                         }
311                 }
312                 qti_lqes_write_unlock(env);
313         }
314 }
315
316 /*
317  * Update LVB associated with the global quota index.
318  * This function is called from the DLM itself after a glimpse callback, in this
319  * case valid ptlrpc request is passed.
320  */
321 int qmt_lvbo_update(struct lu_device *ld, struct ldlm_resource *res,
322                     struct ptlrpc_request *req, int increase_only)
323 {
324         struct lu_env           *env;
325         struct qmt_thread_info  *qti;
326         struct qmt_device       *qmt = lu2qmt_dev(ld);
327         struct lquota_entry     *lqe;
328         struct lquota_lvb       *lvb;
329         struct ldlm_lock        *lock;
330         struct obd_export       *exp;
331         bool                     need_revoke;
332         int                      rc = 0, idx;
333         ENTRY;
334
335         LASSERT(res != NULL);
336
337         if (req == NULL)
338                 RETURN(0);
339
340         if (res->lr_name.name[LUSTRE_RES_ID_QUOTA_SEQ_OFF] == 0)
341                 /* no need to update lvb for global quota locks */
342                 RETURN(0);
343
344         lvb = req_capsule_server_swab_get(&req->rq_pill, &RMF_DLM_LVB,
345                                           lustre_swab_lquota_lvb);
346         if (lvb == NULL) {
347                 CERROR("%s: failed to extract lvb from request\n",
348                        qmt->qmt_svname);
349                 RETURN(-EFAULT);
350         }
351
352         lqe = res->lr_lvb_data;
353         LASSERT(lqe != NULL);
354         lqe_getref(lqe);
355
356         /* allocate environement */
357         env = lu_env_find();
358         LASSERT(env);
359         qti = qmt_info(env);
360
361         /* The request is a glimpse callback which was sent via the
362          * reverse import to the slave. What we care about here is the
363          * export associated with the slave and req->rq_export is
364          * definitely not what we are looking for (it is actually set to
365          * NULL here).
366          * Therefore we extract the lock from the request argument
367          * and use lock->l_export. */
368         lock = ldlm_request_lock(req);
369         if (IS_ERR(lock)) {
370                 CERROR("%s: failed to get lock from request!\n",
371                        qmt->qmt_svname);
372                 GOTO(out, rc = PTR_ERR(lock));
373         }
374
375         exp = class_export_get(lock->l_export);
376         if (exp == NULL) {
377                 CERROR("%s: failed to get export from lock!\n",
378                        qmt->qmt_svname);
379                 GOTO(out, rc = -EFAULT);
380         }
381
382         rc = qmt_uuid2idx(&exp->exp_client_uuid, &idx);
383         if (rc < 0)
384                 GOTO(out_exp, rc);
385
386         need_revoke = qmt_clear_lgeg_arr_nu(lqe, rc, idx);
387         if (lvb->lvb_id_rel == 0) {
388                 /* nothing to release */
389                 if (lvb->lvb_id_may_rel != 0)
390                         /* but might still release later ... */
391                         lqe->lqe_may_rel += lvb->lvb_id_may_rel;
392         }
393
394         if (!need_revoke && lvb->lvb_id_rel == 0)
395                 GOTO(out_exp, rc = 0);
396
397         rc = qmt_pool_lqes_lookup(env, qmt, lqe_rtype(lqe), rc, lqe_qtype(lqe),
398                                   &lqe->lqe_id, NULL, idx);
399         if (rc)
400                 GOTO(out_exp, rc);
401
402         if (need_revoke)
403                 qmt_set_revoke(env, lqe, rc, idx);
404
405         if (lvb->lvb_id_rel) {
406                 LQUOTA_DEBUG(lqe, "releasing:%llu may release:%llu",
407                              lvb->lvb_id_rel, lvb->lvb_id_may_rel);
408
409                 /* release quota space */
410                 rc = qmt_dqacq0(env, qmt, &exp->exp_client_uuid,
411                                 QUOTA_DQACQ_FL_REL, lvb->lvb_id_rel,
412                                 0, &qti->qti_body);
413                 if (rc || qti->qti_body.qb_count != lvb->lvb_id_rel)
414                         LQUOTA_ERROR(lqe,
415                                      "failed to release quota space on glimpse %llu!=%llu : rc = %d\n",
416                                      qti->qti_body.qb_count,
417                                      lvb->lvb_id_rel, rc);
418         }
419         qti_lqes_fini(env);
420         if (rc)
421                 GOTO(out_exp, rc);
422         EXIT;
423 out_exp:
424         class_export_put(exp);
425 out:
426         lqe_putref(lqe);
427         return rc;
428 }
429
430 /*
431  * Report size of lvb to ldlm layer in order to allocate lvb buffer
432  * As far as quota locks are concerned, the size is static and is the same
433  * for both global and per-ID locks which shares the same lvb format.
434  */
435 int qmt_lvbo_size(struct lu_device *ld, struct ldlm_lock *lock)
436 {
437         return sizeof(struct lquota_lvb);
438 }
439
440 /*
441  * Fill request buffer with quota lvb
442  */
443 int qmt_lvbo_fill(struct lu_device *ld, struct ldlm_lock *lock, void *lvb,
444                   int lvblen)
445 {
446         struct ldlm_resource *res = lock->l_resource;
447         struct lquota_lvb *qlvb = lvb;
448         struct lu_env *env;
449         int rc;
450         ENTRY;
451
452         LASSERT(res != NULL);
453         rc = 0;
454
455         if (res->lr_type != LDLM_PLAIN || res->lr_lvb_data == NULL ||
456             res->lr_name.name[LUSTRE_RES_ID_SEQ_OFF] != FID_SEQ_QUOTA_GLB)
457                 RETURN(-EINVAL);
458
459         env = lu_env_find();
460         LASSERT(env);
461
462         if (res->lr_name.name[LUSTRE_RES_ID_QUOTA_SEQ_OFF] != 0) {
463                 /* no ID quota lock associated with UID/GID 0 or with a seq 0,
464                  * we are thus dealing with an ID lock. */
465                 struct lquota_entry *lqe = res->lr_lvb_data;
466                 struct qmt_device *qmt;
467                 struct obd_uuid *uuid;
468                 int idx;
469
470                 uuid = &(lock)->l_export->exp_client_uuid;
471                 rc = qmt_uuid2idx(uuid, &idx);
472                 if (rc < 0)
473                         RETURN(rc);
474                 qmt = lu2qmt_dev(ld);
475                 /* return current qunit value & edquot flags in lvb */
476                 lqe_getref(lqe);
477                 rc = qmt_pool_lqes_lookup(env, qmt, lqe_rtype(lqe), rc,
478                                           lqe_qtype(lqe), &lqe->lqe_id,
479                                           NULL, idx);
480                 if (!rc) {
481                         qlvb->lvb_id_qunit = qti_lqes_min_qunit(env);
482                         qlvb->lvb_flags = 0;
483                         if (qti_lqes_edquot(env))
484                                 qlvb->lvb_flags = LQUOTA_FL_EDQUOT;
485                         qti_lqes_fini(env);
486                 }
487                 CDEBUG(D_QUOTA, "uuid %s lqe_id %lu, edquot %llu qunit %llu\n",
488                        (char *)uuid, (unsigned long)lqe->lqe_id.qid_uid,
489                        qlvb->lvb_flags, qlvb->lvb_id_qunit);
490                 lqe_putref(lqe);
491         } else {
492                 /* global quota lock */
493                 struct dt_object        *obj = res->lr_lvb_data;
494
495                 /* return current version of global index */
496                 qlvb->lvb_glb_ver = dt_version_get(env, obj);
497         }
498
499         RETURN(rc = rc ?: sizeof(struct lquota_lvb));
500 }
501
502 /*
503  * Free lvb associated with a given ldlm resource
504  * we don't really allocate a lvb, lr_lvb_data just points to
505  * the appropriate backend structures.
506  */
507 int qmt_lvbo_free(struct lu_device *ld, struct ldlm_resource *res)
508 {
509         ENTRY;
510
511         if (res->lr_lvb_data == NULL)
512                 RETURN(0);
513
514         if (res->lr_name.name[LUSTRE_RES_ID_QUOTA_SEQ_OFF] != 0) {
515                 struct lquota_entry *lqe = res->lr_lvb_data;
516                 struct lqe_glbl_data *lgd = lqe->lqe_glbl_data;
517
518                 /* release lqe reference */
519                 lqe->lqe_glbl_data = NULL;
520                 lqe_putref(lqe);
521                 qmt_free_lqe_gd(lgd);
522         } else {
523                 struct dt_object *obj = res->lr_lvb_data;
524                 /* release object reference */
525                 dt_object_put(lu_env_find(), obj);
526         }
527
528         res->lr_lvb_data = NULL;
529         res->lr_lvb_len  = 0;
530
531         RETURN(0);
532 }
533
534 typedef int (*qmt_glimpse_cb_t)(struct ldlm_lock *, struct lquota_entry *);
535
536 struct qmt_gl_lock_array {
537         unsigned long             q_max;
538         unsigned long             q_cnt;
539         struct ldlm_lock        **q_locks;
540 };
541
542 static void qmt_free_lock_array(struct qmt_gl_lock_array *array)
543 {
544         int i;
545
546         if (array->q_max == 0) {
547                 LASSERT(array->q_locks == NULL);
548                 return;
549         }
550
551         for (i = 0; i < array->q_cnt; i++) {
552                 LASSERT(array->q_locks[i]);
553                 LDLM_LOCK_RELEASE(array->q_locks[i]);
554                 array->q_locks[i] = NULL;
555         }
556         array->q_cnt = 0;
557         OBD_FREE_PTR_ARRAY(array->q_locks, array->q_max);
558         array->q_locks = NULL;
559         array->q_max = 0;
560 }
561
562 static int qmt_alloc_lock_array(struct ldlm_resource *res,
563                                 struct qmt_gl_lock_array *array,
564                                 qmt_glimpse_cb_t cb, void *arg)
565 {
566         struct list_head *pos;
567         unsigned long count = 0;
568         int fail_cnt = 0;
569         ENTRY;
570
571         LASSERT(!array->q_max && !array->q_cnt && !array->q_locks);
572 again:
573         lock_res(res);
574         /* scan list of granted locks */
575         list_for_each(pos, &res->lr_granted) {
576                 struct ldlm_lock *lock;
577                 int rc;
578
579                 lock = list_entry(pos, struct ldlm_lock, l_res_link);
580                 LASSERT(lock->l_export);
581
582                 if (cb != NULL) {
583                         rc = cb(lock, arg);
584                         /* slave should not be notified */
585                         if (rc == 0)
586                                 continue;
587                 }
588
589                 count++;
590                 if (array->q_max != 0 && array->q_cnt < array->q_max) {
591                         array->q_locks[array->q_cnt] = LDLM_LOCK_GET(lock);
592                         array->q_cnt++;
593                 }
594         }
595         unlock_res(res);
596
597         if (count > array->q_max) {
598                 qmt_free_lock_array(array);
599                 if (++fail_cnt > 5)
600                         RETURN(-EAGAIN);
601                 /*
602                  * allocate more slots in case of more qualified locks are
603                  * found during next loop
604                  */
605                 array->q_max = count + count / 2 + 10;
606                 count = 0;
607                 LASSERT(array->q_locks == NULL && array->q_cnt == 0);
608                 OBD_ALLOC_PTR_ARRAY(array->q_locks, array->q_max);
609                 if (array->q_locks == NULL) {
610                         array->q_max = 0;
611                         RETURN(-ENOMEM);
612                 }
613
614                 goto again;
615         }
616         RETURN(0);
617 }
618
619 void qmt_setup_id_desc(struct ldlm_lock *lock, union ldlm_gl_desc *desc,
620                        struct lquota_entry *lqe)
621 {
622         struct obd_uuid *uuid = &(lock)->l_export->exp_client_uuid;
623         struct lqe_glbl_data *lgd = lqe->lqe_glbl_data;
624         int idx, stype;
625         __u64 qunit;
626         bool edquot;
627
628         stype = qmt_uuid2idx(uuid, &idx);
629         LASSERT(stype >= 0);
630
631         /* DOM case - set global lqe settings */
632         if (lqe_rtype(lqe) == LQUOTA_RES_DT && stype == QMT_STYPE_MDT) {
633                 edquot = lqe->lqe_edquot;
634                 qunit = lqe->lqe_qunit;
635         } else {
636                 edquot = lgd->lqeg_arr[idx].lge_edquot;
637                 qunit = lgd->lqeg_arr[idx].lge_qunit;
638         }
639
640         /* fill glimpse descriptor with lqe settings */
641         desc->lquota_desc.gl_flags = edquot ? LQUOTA_FL_EDQUOT : 0;
642         desc->lquota_desc.gl_qunit = qunit;
643         CDEBUG(D_QUOTA, "setup desc: stype %d idx %d, edquot %llu qunit %llu\n",
644                          stype, idx, desc->lquota_desc.gl_flags,
645                          desc->lquota_desc.gl_qunit);
646 }
647
648 /*
649  * Send glimpse callback to slaves holding a lock on resource \res.
650  * This is used to notify slaves of new quota settings or to claim quota space
651  * back.
652  *
653  * \param env  - is the environment passed by the caller
654  * \param qmt  - is the quota master target
655  * \param res  - is the dlm resource associated with the quota object
656  * \param desc - is the glimpse descriptor to pack in glimpse callback
657  * \param cb   - is the callback function called on every lock and determine
658  *               whether a glimpse should be issued
659  * \param arg  - is an opaq parameter passed to the callback function
660  */
661 static int qmt_glimpse_lock(const struct lu_env *env, struct qmt_device *qmt,
662                             struct ldlm_resource *res, union ldlm_gl_desc *desc,
663                             qmt_glimpse_cb_t cb, struct lquota_entry *lqe)
664 {
665         union ldlm_gl_desc *descs = NULL;
666         struct lqe_glbl_data *gld;
667         struct list_head *tmp, *pos;
668         LIST_HEAD(gl_list);
669         struct qmt_gl_lock_array locks;
670         unsigned long i, locks_count;
671         int rc = 0;
672         ENTRY;
673
674         gld = lqe ? lqe->lqe_glbl_data : NULL;
675         memset(&locks, 0, sizeof(locks));
676         rc = qmt_alloc_lock_array(res, &locks, cb, lqe);
677         if (rc) {
678                 CERROR("%s: failed to allocate glimpse lock array (%d)\n",
679                        qmt->qmt_svname, rc);
680                 RETURN(rc);
681         }
682         if (!locks.q_cnt) {
683                 CDEBUG(D_QUOTA, "%s: no granted locks to send glimpse\n",
684                        qmt->qmt_svname);
685                 RETURN(0);
686         }
687         CDEBUG(D_QUOTA, "found granted locks %lu\n", locks.q_cnt);
688         locks_count = locks.q_cnt;
689
690         /* Use one desc for all works, when called from qmt_glb_lock_notify */
691         if (gld && locks.q_cnt > 1) {
692                 /* TODO: think about to store this preallocated descs
693                  * in lqe_global in lqeg_arr as a part of lqe_glbl_entry.
694                  * The benefit is that we don't need to allocate/free
695                  * and setup this descs each time. But the drawback is
696                  * memory use (sizeof ldlm_gl_desc * OST_COUNT * user_number).
697                  * for examfple it could be 88 * 256 * 10 000 about 225 MB. */
698                 OBD_ALLOC(descs,
699                           sizeof(struct ldlm_gl_lquota_desc) * locks.q_cnt);
700                 if (!descs) {
701                         CERROR("%s: alloc glimpse lock array failed: rc = %d\n",
702                                qmt->qmt_svname, rc);
703                         qmt_free_lock_array(&locks);
704                         RETURN(-ENOMEM);
705                 }
706         }
707
708         for (i = locks.q_cnt; i > 0; i--) {
709                 struct ldlm_glimpse_work *work;
710
711                 OBD_ALLOC_PTR(work);
712                 if (work == NULL) {
713                         CERROR("%s: failed to notify a lock.\n",
714                                qmt->qmt_svname);
715                         continue;
716                 }
717
718                 if (gld) {
719                         if (descs)
720                                 desc = &descs[i - 1];
721                         qmt_setup_id_desc(locks.q_locks[i - 1], desc, lqe);
722                         work->gl_interpret_data = lqe;
723                 }
724
725                 list_add_tail(&work->gl_list, &gl_list);
726                 work->gl_lock  = locks.q_locks[i - 1];
727                 work->gl_flags = 0;
728                 work->gl_desc  = desc;
729
730                 locks.q_locks[i - 1] = NULL;
731                 locks.q_cnt--;
732         }
733
734         qmt_free_lock_array(&locks);
735
736         if (list_empty(&gl_list)) {
737                 CDEBUG(D_QUOTA, "%s: nobody to notify\n", qmt->qmt_svname);
738                 GOTO(out, rc = 0);
739         }
740
741         /* issue glimpse callbacks to all connected slaves */
742         rc = ldlm_glimpse_locks(res, &gl_list);
743
744         list_for_each_safe(pos, tmp, &gl_list) {
745                 struct ldlm_glimpse_work *work;
746
747                 work = list_entry(pos, struct ldlm_glimpse_work, gl_list);
748
749                 list_del(&work->gl_list);
750                 CERROR("%s: failed to notify %s of new quota settings\n",
751                        qmt->qmt_svname,
752                        obd_uuid2str(&work->gl_lock->l_export->exp_client_uuid));
753                 LDLM_LOCK_RELEASE(work->gl_lock);
754                 OBD_FREE_PTR(work);
755         }
756 out:
757         if (descs)
758                 OBD_FREE(descs,
759                          sizeof(struct ldlm_gl_lquota_desc) * locks_count);
760
761         RETURN(rc);
762 }
763
764 /*
765  * Send glimpse request to all global quota locks to push new quota setting to
766  * slaves.
767  *
768  * \param env - is the environment passed by the caller
769  * \param lqe - is the lquota entry which has new settings
770  * \param ver - is the version associated with the setting change
771  */
772 void qmt_glb_lock_notify(const struct lu_env *env, struct lquota_entry *lqe,
773                          __u64 ver)
774 {
775         struct qmt_thread_info  *qti = qmt_info(env);
776         struct qmt_pool_info    *pool = lqe2qpi(lqe);
777         struct ldlm_resource    *res = NULL;
778         ENTRY;
779
780         lquota_generate_fid(&qti->qti_fid, pool->qpi_rtype, lqe_qtype(lqe));
781
782         /* send glimpse callback to notify slaves of new quota settings */
783         qti->qti_gl_desc.lquota_desc.gl_id        = lqe->lqe_id;
784         qti->qti_gl_desc.lquota_desc.gl_flags     = 0;
785         if (lqe->lqe_is_default) {
786                 qti->qti_gl_desc.lquota_desc.gl_hardlimit = 0;
787                 qti->qti_gl_desc.lquota_desc.gl_softlimit = 0;
788                 qti->qti_gl_desc.lquota_desc.gl_time = LQUOTA_GRACE_FLAG(0,
789                                                         LQUOTA_FLAG_DEFAULT);
790
791         } else {
792                 qti->qti_gl_desc.lquota_desc.gl_hardlimit = lqe->lqe_hardlimit;
793                 qti->qti_gl_desc.lquota_desc.gl_softlimit = lqe->lqe_softlimit;
794                 qti->qti_gl_desc.lquota_desc.gl_time = lqe->lqe_gracetime;
795         }
796         qti->qti_gl_desc.lquota_desc.gl_ver       = ver;
797
798         /* look up ldlm resource associated with global index */
799         fid_build_reg_res_name(&qti->qti_fid, &qti->qti_resid);
800         res = ldlm_resource_get(pool->qpi_qmt->qmt_ns, NULL, &qti->qti_resid,
801                                 LDLM_PLAIN, 0);
802         if (IS_ERR(res)) {
803                 /* this might happen if no slaves have enqueued global quota
804                  * locks yet */
805                 LQUOTA_DEBUG(lqe, "failed to lookup ldlm resource associated "
806                              "with "DFID, PFID(&qti->qti_fid));
807                 RETURN_EXIT;
808         }
809
810         qmt_glimpse_lock(env, pool->qpi_qmt, res, &qti->qti_gl_desc,
811                          NULL, NULL);
812         ldlm_resource_putref(res);
813         EXIT;
814 }
815
816 /* Callback function used to select locks that should be glimpsed when
817  * broadcasting the new qunit value */
818 static int qmt_id_lock_cb(struct ldlm_lock *lock, struct lquota_entry *lqe)
819 {
820         struct obd_uuid *uuid = &(lock)->l_export->exp_client_uuid;
821         struct lqe_glbl_data *lgd = lqe->lqe_glbl_data;
822         int idx;
823         int stype = qmt_uuid2idx(uuid, &idx);
824
825         LASSERT(stype == QMT_STYPE_OST || stype == QMT_STYPE_MDT);
826
827         /* Quota pools support only OSTs, despite MDTs also could be registered
828          * as LQUOTA_RES_DT devices(DOM). */
829         if (lqe_rtype(lqe) == LQUOTA_RES_DT && stype == QMT_STYPE_MDT)
830                 return 1;
831         else
832                 return lgd->lqeg_arr[idx].lge_edquot_nu ||
833                        lgd->lqeg_arr[idx].lge_qunit_nu;
834 }
835
836
837 /*
838  * Send glimpse request on per-ID lock to push new qunit value to slave.
839  *
840  * \param env  - is the environment passed by the caller
841  * \param qmt  - is the quota master target device
842  * \param lqe  - is the lquota entry with the new qunit value
843  * \param uuid - is the uuid of the slave acquiring space, if any
844  */
845 static void qmt_id_lock_glimpse(const struct lu_env *env,
846                                 struct qmt_device *qmt,
847                                 struct lquota_entry *lqe, struct obd_uuid *uuid)
848 {
849         struct qmt_thread_info  *qti = qmt_info(env);
850         struct qmt_pool_info    *pool = lqe2qpi(lqe);
851         struct ldlm_resource    *res = NULL;
852         ENTRY;
853
854         if (!lqe->lqe_enforced)
855                 RETURN_EXIT;
856
857         lquota_generate_fid(&qti->qti_fid, pool->qpi_rtype, lqe_qtype(lqe));
858         fid_build_quota_res_name(&qti->qti_fid, &lqe->lqe_id, &qti->qti_resid);
859         res = ldlm_resource_get(qmt->qmt_ns, NULL, &qti->qti_resid, LDLM_PLAIN,
860                                 0);
861         if (IS_ERR(res)) {
862                 /* this might legitimately happens if slaves haven't had the
863                  * opportunity to enqueue quota lock yet. */
864                 LQUOTA_DEBUG(lqe, "failed to lookup ldlm resource for per-ID "
865                              "lock "DFID, PFID(&qti->qti_fid));
866                 lqe_write_lock(lqe);
867                 if (lqe->lqe_revoke_time == 0 &&
868                     lqe->lqe_qunit == pool->qpi_least_qunit)
869                         lqe->lqe_revoke_time = ktime_get_seconds();
870                 lqe_write_unlock(lqe);
871                 RETURN_EXIT;
872         }
873
874         lqe_write_lock(lqe);
875         /* The purpose of glimpse callback on per-ID lock is twofold:
876          * - notify slaves of new qunit value and hope they will release some
877          *   spare quota space in return
878          * - notify slaves that master ran out of quota space and there is no
879          *   need to send acquire request any more until further notice */
880
881         /* TODO: it is not clear how to implement below case for all lqes
882          * from where slaves will be notified in qmt_glimpse_lock. Because
883          * here we have just global lqe with an array of OSTs that should
884          * be notified. Theoretically we can find all lqes that includes
885          * these OSTs, but it is not trivial. So I would propose to move
886          * this case to another place ... */
887         if (lqe->lqe_revoke_time == 0 &&
888             lqe->lqe_qunit == pool->qpi_least_qunit)
889                 /* reset lqe_may_rel, it will be updated on glimpse callback
890                  * replies if needed */
891                 lqe->lqe_may_rel = 0;
892
893         /* The rebalance thread is the only thread which can issue glimpses */
894         LASSERT(!lqe->lqe_gl);
895         lqe->lqe_gl = true;
896         lqe_write_unlock(lqe);
897
898         /* issue glimpse callback to slaves */
899         qmt_glimpse_lock(env, qmt, res, &qti->qti_gl_desc,
900                          qmt_id_lock_cb, lqe);
901
902         lqe_write_lock(lqe);
903         if (lqe->lqe_revoke_time == 0 &&
904             lqe->lqe_qunit == pool->qpi_least_qunit) {
905                 lqe->lqe_revoke_time = ktime_get_seconds();
906                 qmt_adjust_edquot(lqe, ktime_get_real_seconds());
907         }
908         LASSERT(lqe->lqe_gl);
909         lqe->lqe_gl = false;
910         lqe_write_unlock(lqe);
911
912         ldlm_resource_putref(res);
913         EXIT;
914 }
915
916 /*
917  * Schedule a glimpse request on per-ID locks to push new qunit value or
918  * edquot flag to quota slaves.
919  *
920  * \param qmt  - is the quota master target device
921  * \param lqe  - is the lquota entry with the new qunit value
922  */
923 void qmt_id_lock_notify(struct qmt_device *qmt, struct lquota_entry *lqe)
924 {
925         bool    added = false;
926         ENTRY;
927
928         LASSERT(lqe->lqe_is_global);
929         lqe_getref(lqe);
930         spin_lock(&qmt->qmt_reba_lock);
931         if (!qmt->qmt_stopping && list_empty(&lqe->lqe_link)) {
932                 list_add_tail(&lqe->lqe_link, &qmt->qmt_reba_list);
933                 added = true;
934                 if (qmt->qmt_reba_task)
935                         wake_up_process(qmt->qmt_reba_task);
936         }
937         spin_unlock(&qmt->qmt_reba_lock);
938
939         if (!added)
940                 lqe_putref(lqe);
941         EXIT;
942 }
943
944 struct qmt_reba_args {
945         struct qmt_device       *qra_dev;
946         struct lu_env            qra_env;
947         struct completion       *qra_started;
948 };
949
950 #ifndef TASK_IDLE
951 #define TASK_IDLE TASK_INTERRUPTIBLE
952 #endif
953
954 /*
955  * The rebalance thread is in charge of sending glimpse callbacks on per-ID
956  * quota locks owned by slaves in order to notify them of:
957  * - a qunit shrink in which case slaves might release quota space back in
958  *   glimpse reply.
959  * - set/clear edquot flag used to cache the "quota exhausted" state of the
960  *   master. When the flag is set, slaves know that there is no need to
961  *   try to acquire quota from the master since this latter has already
962  *   distributed all the space.
963  */
964 static int qmt_reba_thread(void *_args)
965 {
966         struct qmt_reba_args    *args = _args;
967         struct qmt_device       *qmt = args->qra_dev;
968         struct lu_env           *env = &args->qra_env;
969         struct lquota_entry     *lqe, *tmp;
970         ENTRY;
971
972         complete(args->qra_started);
973         while (({set_current_state(TASK_IDLE);
974                  !kthread_should_stop(); })) {
975
976                 spin_lock(&qmt->qmt_reba_lock);
977                 list_for_each_entry_safe(lqe, tmp, &qmt->qmt_reba_list,
978                                          lqe_link) {
979                         __set_current_state(TASK_RUNNING);
980                         list_del_init(&lqe->lqe_link);
981                         spin_unlock(&qmt->qmt_reba_lock);
982
983                         if (!kthread_should_stop())
984                                 qmt_id_lock_glimpse(env, qmt, lqe, NULL);
985
986                         lqe_putref(lqe);
987                         spin_lock(&qmt->qmt_reba_lock);
988                 }
989                 spin_unlock(&qmt->qmt_reba_lock);
990                 schedule();
991         }
992         __set_current_state(TASK_RUNNING);
993
994         lu_env_remove(env);
995         lu_env_fini(env);
996         OBD_FREE_PTR(args);
997         RETURN(0);
998 }
999
1000 /*
1001  * Start rebalance thread. Called when the QMT is being setup
1002  */
1003 int qmt_start_reba_thread(struct qmt_device *qmt)
1004 {
1005         struct task_struct *task;
1006         struct qmt_reba_args *args;
1007         DECLARE_COMPLETION_ONSTACK(started);
1008         int rc;
1009         ENTRY;
1010
1011         OBD_ALLOC_PTR(args);
1012         if (args == NULL)
1013                 RETURN(-ENOMEM);
1014         args->qra_dev = qmt;
1015         args->qra_started = &started;
1016
1017         rc = lu_env_init(&args->qra_env, LCT_MD_THREAD);
1018         if (rc) {
1019                 CERROR("%s: failed to init env.", qmt->qmt_svname);
1020                 GOTO(out_env, rc);
1021         }
1022
1023         task = kthread_create(qmt_reba_thread, args,
1024                               "qmt_reba_%s", qmt->qmt_svname);
1025         if (IS_ERR(task)) {
1026                 CERROR("%s: failed to start rebalance thread (%ld)\n",
1027                        qmt->qmt_svname, PTR_ERR(task));
1028                 GOTO(out_env_fini, rc = PTR_ERR(task));
1029         }
1030
1031         rc = lu_env_add_task(&args->qra_env, task);
1032         if (rc) {
1033                 kthread_stop(task);
1034                 GOTO(out_env_fini, rc);
1035         }
1036         qmt->qmt_reba_task = task;
1037         wake_up_process(task);
1038         wait_for_completion(&started);
1039
1040         RETURN(0);
1041 out_env_fini:
1042         lu_env_fini(&args->qra_env);
1043 out_env:
1044         OBD_FREE_PTR(args);
1045         RETURN(rc);
1046 }
1047
1048 /*
1049  * Stop rebalance thread. Called when the QMT is about to shutdown.
1050  */
1051 void qmt_stop_reba_thread(struct qmt_device *qmt)
1052 {
1053         struct task_struct *task;
1054
1055         spin_lock(&qmt->qmt_reba_lock);
1056         task = qmt->qmt_reba_task;
1057         qmt->qmt_reba_task = NULL;
1058         spin_unlock(&qmt->qmt_reba_lock);
1059
1060         if (task)
1061                 kthread_stop(task);
1062
1063         LASSERT(list_empty(&qmt->qmt_reba_list));
1064 }