Whamcloud - gitweb
7d3b7ce252127820c29ad6aa36871a269dd63d09
[fs/lustre-release.git] / lustre / quota / qmt_internal.h
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
28 #ifndef _QMT_INTERNAL_H
29 #define _QMT_INTERNAL_H
30
31 #include "lquota_internal.h"
32
33 /*
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
40  *
41  * That's the structure MDT0 connects to in mdt_quota_init().
42  */
43 struct qmt_device {
44         /* Super-class. dt_device/lu_device for this master target */
45         struct dt_device        qmt_dt_dev;
46
47         /* service name of this qmt */
48         char                    qmt_svname[MAX_OBD_NAME];
49         /* root directory for this qmt */
50         struct dt_object        *qmt_root;
51
52         /* Reference to the next device in the side stack
53          * The child device is actually the OSD device where we store the quota
54          * index files */
55         struct obd_export       *qmt_child_exp;
56         struct dt_device        *qmt_child;
57
58         /* pointer to ldlm namespace to be used for quota locks */
59         struct ldlm_namespace   *qmt_ns;
60
61         /* List of pools managed by this master target */
62         struct list_head         qmt_pool_list;
63         /* rw semaphore to protect pool list */
64         struct rw_semaphore      qmt_pool_lock;
65
66         /* procfs root directory for this qmt */
67         struct proc_dir_entry   *qmt_proc;
68
69         /* dedicated thread in charge of space rebalancing */
70         struct task_struct      *qmt_reba_task;
71
72         /* list of lqe entry which need space rebalancing */
73         struct list_head         qmt_reba_list;
74
75         /* lock protecting rebalancing list */
76         spinlock_t               qmt_reba_lock;
77
78         unsigned long            qmt_stopping:1; /* qmt is stopping */
79
80 };
81
82 struct qmt_pool_info;
83 #define QPI_MAXNAME     (LOV_MAXPOOLNAME + 1)
84 #define qmt_pool_global(qpi) \
85         (!strncmp(qpi->qpi_name, GLB_POOL_NAME, \
86                   strlen(GLB_POOL_NAME) + 1) ? true : false)
87 /* Draft for mdt pools */
88 union qmt_sarray {
89         struct lu_tgt_pool      osts;
90 };
91
92 /* Since DOM support, data resources can exist
93  * on both MDT and OST targets. */
94 enum {
95         QMT_STYPE_MDT,
96         QMT_STYPE_OST,
97         QMT_STYPE_CNT
98 };
99
100 enum {
101         /* set while recalc_thread is working */
102         QPI_FLAG_RECALC_OFFSET,
103 };
104
105 /*
106  * Per-pool quota information.
107  * The qmt creates one such structure for each pool
108  * with quota enforced. All the structures are kept in a list.
109  * We currently only support the default data pool and default metadata pool.
110  */
111 struct qmt_pool_info {
112         /* chained list of all pools managed by the same qmt */
113         struct list_head         qpi_linkage;
114
115         /* Could be  LQUOTA_RES_MD or LQUOTA_RES_DT */
116         int                      qpi_rtype;
117         char                     qpi_name[QPI_MAXNAME];
118
119         union qmt_sarray         qpi_sarr;
120         /* recalculation thread pointer */
121         struct task_struct      *qpi_recalc_task;
122         /* rw semaphore to avoid acquire/release during
123          * pool recalculation. */
124         struct rw_semaphore      qpi_recalc_sem;
125         unsigned long            qpi_flags;
126
127         /* track users of this pool instance */
128         atomic_t                 qpi_ref;
129
130         /* back pointer to master target
131          * immutable after creation. */
132         struct qmt_device       *qpi_qmt;
133
134         /* pointer to dt object associated with global indexes for both user
135          * and group quota */
136         struct dt_object        *qpi_glb_obj[LL_MAXQUOTAS];
137
138         /* A pool supports two different quota types: user and group quota.
139          * Each quota type has its own global index and lquota_entry hash table.
140          */
141         struct lquota_site      *qpi_site[LL_MAXQUOTAS];
142
143         /* number of slaves registered for each quota types */
144         int                      qpi_slv_nr[QMT_STYPE_CNT][LL_MAXQUOTAS];
145
146         /* reference on lqe (ID 0) storing grace time. */
147         struct lquota_entry     *qpi_grace_lqe[LL_MAXQUOTAS];
148
149         /* procfs root directory for this pool */
150         struct proc_dir_entry   *qpi_proc;
151
152         /* pool directory where all indexes related to this pool instance are
153          * stored */
154         struct dt_object        *qpi_root;
155
156         /* Global quota parameters which apply to all quota type */
157         /* the least value of qunit */
158         unsigned long            qpi_least_qunit;
159
160         /* Least value of qunit when soft limit is exceeded.
161          *
162          * When soft limit is exceeded, qunit will be shrinked to least_qunit
163          * (1M for block limit), that results in significant write performance
164          * drop since the client will turn to sync write from now on.
165          *
166          * To retain the write performance in an acceptable level, we choose
167          * to sacrifice grace time accuracy a bit and use a larger least_qunit
168          * when soft limit is exceeded. It's (qpi_least_qunit * 4) by default,
169          * and user may enlarge it via procfs to get even better performance
170          * (with the cost of losing more grace time accuracy).
171          *
172          * See qmt_calc_softlimit().
173          */
174         unsigned long            qpi_soft_least_qunit;
175 };
176
177 static inline int qpi_slv_nr(struct qmt_pool_info *pool, int qtype)
178 {
179         int i, sum = 0;
180
181         for (i = 0; i < QMT_STYPE_CNT; i++)
182                 sum += pool->qpi_slv_nr[i][qtype];
183
184         return sum;
185 }
186
187 static inline int qpi_slv_nr_by_rtype(struct qmt_pool_info *pool, int qtype)
188 {
189         if (pool->qpi_rtype == LQUOTA_RES_DT)
190                 /* Here should be qpi_slv_nr() if MDTs will be added
191                  * to quota pools */
192                 return pool->qpi_slv_nr[QMT_STYPE_OST][qtype];
193         else
194                 return pool->qpi_slv_nr[QMT_STYPE_MDT][qtype];
195 }
196 /*
197  * Helper routines and prototypes
198  */
199
200 /* helper routine to find qmt_pool_info associated a lquota_entry */
201 static inline struct qmt_pool_info *lqe2qpi(struct lquota_entry *lqe)
202 {
203         LASSERT(lqe_is_master(lqe));
204         return (struct qmt_pool_info *)lqe->lqe_site->lqs_parent;
205 }
206
207 /* return true if someone holds either a read or write lock on the lqe */
208 static inline bool lqe_is_locked(struct lquota_entry *lqe)
209 {
210         LASSERT(lqe_is_master(lqe));
211         if (down_write_trylock(&lqe->lqe_sem) == 0)
212                 return true;
213         lqe_write_unlock(lqe);
214         return false;
215 }
216
217 /* value to be restored if someone wrong happens during lqe writeback */
218 struct qmt_lqe_restore {
219         __u64   qlr_hardlimit;
220         __u64   qlr_softlimit;
221         __u64   qlr_gracetime;
222         __u64   qlr_granted;
223         __u64   qlr_qunit;
224 };
225
226 #define QMT_MAX_POOL_NUM        16
227 /* Common data shared by qmt handlers */
228 struct qmt_thread_info {
229         union lquota_rec         qti_rec;
230         union lquota_id          qti_id;
231         char                     qti_buf[MTI_NAME_MAXLEN];
232         struct lu_fid            qti_fid;
233         struct ldlm_res_id       qti_resid;
234         union ldlm_gl_desc       qti_gl_desc;
235         struct quota_body        qti_body;
236         union {
237                 struct qmt_lqe_restore  qti_lqes_rstr_small[QMT_MAX_POOL_NUM];
238                 struct qmt_lqe_restore  *qti_lqes_rstr;
239         };
240         union {
241                 struct qmt_pool_info    *qti_pools_small[QMT_MAX_POOL_NUM];
242                 /* Pointer to an array of qpis in case when
243                  * qti_pools_cnt > QMT_MAX_POOL_NUM. */
244                 struct qmt_pool_info    **qti_pools;
245         };
246         /* The number of pools in qti_pools */
247         int                      qti_pools_cnt;
248         /* Maximum number of elements in qti_pools array.
249          * By default it is QMT_MAX_POOL_NUM. */
250         int                      qti_pools_num;
251         int                      qti_glbl_lqe_idx;
252         /* The same is for lqe ... */
253         union {
254                 struct lquota_entry     *qti_lqes_small[QMT_MAX_POOL_NUM];
255                 /* Pointer to an array of lqes in case when
256                  * qti_lqes_cnt > QMT_MAX_POOL_NUM. */
257                 struct lquota_entry     **qti_lqes;
258         };
259         /* The number of lqes in qti_lqes */
260         int                      qti_lqes_cnt;
261         /* Maximum number of elements in qti_lqes array.
262          * By default it is QMT_MAX_POOL_NUM. */
263         int                      qti_lqes_num;
264 };
265
266 extern struct lu_context_key qmt_thread_key;
267
268 /* helper function to extract qmt_thread_info from current environment */
269 static inline
270 struct qmt_thread_info *qmt_info(const struct lu_env *env)
271 {
272         return lu_env_info(env, &qmt_thread_key);
273 }
274
275 #define qti_lqes_num(env)       (qmt_info(env)->qti_lqes_num)
276 #define qti_lqes_inited(env)    (qmt_info(env)->qti_lqes_num)
277 #define qti_lqes_cnt(env)       (qmt_info(env)->qti_lqes_cnt)
278 #define qti_glbl_lqe_idx(env)   (qmt_info(env)->qti_glbl_lqe_idx)
279 #define qti_lqes(env)           (qti_lqes_num(env) > QMT_MAX_POOL_NUM ? \
280                                         qmt_info(env)->qti_lqes : \
281                                         qmt_info(env)->qti_lqes_small)
282 #define qti_lqes_rstr(env)      (qti_lqes_num(env) > QMT_MAX_POOL_NUM ? \
283                                         qmt_info(env)->qti_lqes_rstr : \
284                                         qmt_info(env)->qti_lqes_rstr_small)
285 #define qti_lqes_glbl(env)      (qti_lqes(env)[qti_glbl_lqe_idx(env)])
286 #define qti_lqe_hard(env, i)    (qti_lqes(env)[i]->lqe_hardlimit)
287 #define qti_lqe_soft(env, i)    (qti_lqes(env)[i]->lqe_softlimit)
288 #define qti_lqe_granted(env, i) (qti_lqes(env)[i]->lqe_granted)
289 #define qti_lqe_qunit(env, i)   (qti_lqes(env)[i]->lqe_qunit)
290
291 /* helper routine to convert a lu_device into a qmt_device */
292 static inline struct qmt_device *lu2qmt_dev(struct lu_device *ld)
293 {
294         return container_of_safe(lu2dt_dev(ld), struct qmt_device, qmt_dt_dev);
295 }
296
297 /* helper routine to convert a qmt_device into lu_device */
298 static inline struct lu_device *qmt2lu_dev(struct qmt_device *qmt)
299 {
300         return &qmt->qmt_dt_dev.dd_lu_dev;
301 }
302
303 #define LQE_ROOT(lqe)    (lqe2qpi(lqe)->qpi_root)
304 #define LQE_GLB_OBJ(lqe) (lqe2qpi(lqe)->qpi_glb_obj[lqe_qtype(lqe)])
305
306 /* helper function returning grace time to use for a given lquota entry */
307 static inline __u64 qmt_lqe_grace(struct lquota_entry *lqe)
308 {
309         struct qmt_pool_info    *pool = lqe2qpi(lqe);
310         struct lquota_entry     *grace_lqe;
311
312         grace_lqe = pool->qpi_grace_lqe[lqe_qtype(lqe)];
313         LASSERT(grace_lqe != NULL);
314
315         return grace_lqe->lqe_gracetime;
316 }
317
318 static inline void qmt_restore(struct lquota_entry *lqe,
319                                struct qmt_lqe_restore *restore)
320 {
321         lqe->lqe_hardlimit = restore->qlr_hardlimit;
322         lqe->lqe_softlimit = restore->qlr_softlimit;
323         lqe->lqe_gracetime = restore->qlr_gracetime;
324         lqe->lqe_granted   = restore->qlr_granted;
325         lqe->lqe_qunit     = restore->qlr_qunit;
326 }
327
328 static inline void qmt_restore_lqes(const struct lu_env *env)
329 {
330         int i;
331
332         for (i = 0; i < qti_lqes_cnt(env); i++)
333                 qmt_restore(qti_lqes(env)[i], &qti_lqes_rstr(env)[i]);
334 }
335
336 #define QMT_GRANT(lqe, slv, cnt)             \
337         do {                                 \
338                 (lqe)->lqe_granted += (cnt); \
339                 (slv) += (cnt);              \
340         } while (0)
341 #define QMT_REL(lqe, slv, cnt)               \
342         do {                                 \
343                 (lqe)->lqe_granted -= (cnt); \
344                 (slv) -= (cnt);              \
345         } while (0)
346
347 /* helper routine returning true when reached hardlimit */
348 static inline bool qmt_hard_exhausted(struct lquota_entry *lqe)
349 {
350         if (lqe->lqe_hardlimit != 0 && lqe->lqe_granted >= lqe->lqe_hardlimit)
351                 return true;
352         return false;
353 }
354
355 /* helper routine returning true when reached softlimit */
356 static inline bool qmt_soft_exhausted(struct lquota_entry *lqe, __u64 now)
357 {
358         if (lqe->lqe_softlimit != 0 && lqe->lqe_granted > lqe->lqe_softlimit &&
359             lqe->lqe_gracetime != 0 && now >= lqe->lqe_gracetime)
360                 return true;
361         return false;
362 }
363
364 /* helper routine returning true when the id has run out of quota space:
365  * - reached hardlimit
366  * OR
367  * - reached softlimit and grace time expired already */
368 static inline bool qmt_space_exhausted(struct lquota_entry *lqe, __u64 now)
369 {
370         return (qmt_hard_exhausted(lqe) || qmt_soft_exhausted(lqe, now));
371 }
372
373 static inline bool qmt_space_exhausted_lqes(const struct lu_env *env, __u64 now)
374 {
375         bool exhausted = false;
376         int i;
377
378         for (i = 0; i < qti_lqes_cnt(env) && !exhausted; i++)
379                 exhausted |= qmt_space_exhausted(qti_lqes(env)[i], now);
380
381         return exhausted;
382 }
383
384 /* helper routine clearing the default quota setting  */
385 static inline void qmt_lqe_clear_default(struct lquota_entry *lqe)
386 {
387         lqe->lqe_is_default = false;
388         lqe->lqe_gracetime &= ~((__u64)LQUOTA_FLAG_DEFAULT <<
389                                                         LQUOTA_GRACE_BITS);
390 }
391
392 /* number of seconds to wait for slaves to release quota space after
393  * rebalancing */
394 #define QMT_REBA_TIMEOUT 2
395
396 /* qmt_pool.c */
397
398 void qmt_pool_free(const struct lu_env *, struct qmt_pool_info *);
399 /*
400  * Reference counter management for qmt_pool_info structures
401  */
402 static inline void qpi_getref(struct qmt_pool_info *pool)
403 {
404         atomic_inc(&pool->qpi_ref);
405 }
406
407 static inline void qpi_putref(const struct lu_env *env,
408                               struct qmt_pool_info *pool)
409 {
410         LASSERT(atomic_read(&pool->qpi_ref) > 0);
411         if (atomic_dec_and_test(&pool->qpi_ref))
412                 qmt_pool_free(env, pool);
413 }
414
415
416 void qmt_pool_fini(const struct lu_env *, struct qmt_device *);
417 int qmt_pool_init(const struct lu_env *, struct qmt_device *);
418 int qmt_pool_prepare(const struct lu_env *, struct qmt_device *,
419                    struct dt_object *, char *);
420 int qmt_pool_new_conn(const struct lu_env *, struct qmt_device *,
421                       struct lu_fid *, struct lu_fid *, __u64 *,
422                       struct obd_uuid *);
423
424 #define GLB_POOL_NAME   "0x0"
425 #define qmt_pool_lookup_glb(env, qmt, type) \
426                 qmt_pool_lookup(env, qmt, type, NULL, -1, false)
427 #define qmt_pool_lookup_name(env, qmt, type, name) \
428                 qmt_pool_lookup(env, qmt, type, name, -1, false)
429 #define qmt_pool_lookup_arr(env, qmt, type, idx) \
430                 qmt_pool_lookup(env, qmt, type, NULL, idx, true)
431 struct qmt_pool_info *qmt_pool_lookup(const struct lu_env *env,
432                                              struct qmt_device *qmt,
433                                              int rtype,
434                                              char *pool_name,
435                                              int idx,
436                                              bool add);
437 struct lquota_entry *qmt_pool_lqe_lookup(const struct lu_env *,
438                                          struct qmt_device *, int, int,
439                                          union lquota_id *, char *);
440 int qmt_pool_lqes_lookup(const struct lu_env *, struct qmt_device *, int,
441                          int, int, union lquota_id *, char *, int);
442 int qmt_pool_lqes_lookup_spec(const struct lu_env *env, struct qmt_device *qmt,
443                               int rtype, int qtype, union lquota_id *qid);
444 void qmt_lqes_sort(const struct lu_env *env);
445 int qmt_pool_new(struct obd_device *obd, char *poolname);
446 int qmt_pool_add(struct obd_device *obd, char *poolname, char *ostname);
447 int qmt_pool_rem(struct obd_device *obd, char *poolname, char *ostname);
448 int qmt_pool_del(struct obd_device *obd, char *poolname);
449
450 struct rw_semaphore *qmt_sarr_rwsem(struct qmt_pool_info *qpi);
451 int qmt_sarr_get_idx(struct qmt_pool_info *qpi, int arr_idx);
452 unsigned int qmt_sarr_count(struct qmt_pool_info *qpi);
453
454 /* qmt_entry.c */
455 extern const struct lquota_entry_operations qmt_lqe_ops;
456 int qmt_lqe_set_default(const struct lu_env *env, struct qmt_pool_info *pool,
457                         struct lquota_entry *lqe, bool create_record);
458 struct thandle *qmt_trans_start_with_slv(const struct lu_env *,
459                                          struct lquota_entry *,
460                                          struct dt_object *,
461                                          bool);
462 struct thandle *qmt_trans_start(const struct lu_env *, struct lquota_entry *);
463 int qmt_glb_write_lqes(const struct lu_env *, struct thandle *, __u32, __u64 *);
464 int qmt_glb_write(const struct lu_env *, struct thandle *,
465                   struct lquota_entry *, __u32, __u64 *);
466 int qmt_slv_write(const struct lu_env *, struct thandle *,
467                   struct lquota_entry *, struct dt_object *, __u32, __u64 *,
468                   __u64);
469 int qmt_slv_read(const struct lu_env *,  union lquota_id *,
470                  struct dt_object *, __u64 *);
471 int qmt_validate_limits(struct lquota_entry *, __u64, __u64);
472 bool qmt_adjust_qunit(const struct lu_env *, struct lquota_entry *);
473 bool qmt_adjust_edquot(struct lquota_entry *, __u64);
474
475 #define qmt_adjust_edquot_notify(env, qmt, now, qb_flags) \
476           qmt_adjust_edquot_qunit_notify(env, qmt, now, true, false, qb_flags)
477 #define qmt_adjust_qunit_notify(env, qmt, qb_flags) \
478           qmt_adjust_edquot_qunit_notify(env, qmt, 0, false, true, qb_flags)
479 #define qmt_adjust_and_notify(env, qmt, now, qb_flags) \
480           qmt_adjust_edquot_qunit_notify(env, qmt, now, true, true, qb_flags)
481 bool qmt_adjust_edquot_qunit_notify(const struct lu_env *, struct qmt_device *,
482                                     __u64, bool, bool, __u32);
483 bool qmt_revalidate(const struct lu_env *, struct lquota_entry *);
484 void qmt_revalidate_lqes(const struct lu_env *, struct qmt_device *, __u32);
485 __u64 qmt_alloc_expand(struct lquota_entry *, __u64, __u64);
486
487 void qti_lqes_init(const struct lu_env *env);
488 int qti_lqes_add(const struct lu_env *env, struct lquota_entry *lqe);
489 void qti_lqes_del(const struct lu_env *env, int index);
490 void qti_lqes_fini(const struct lu_env *env);
491 __u64 qti_lqes_min_qunit(const struct lu_env *env);
492 int qti_lqes_edquot(const struct lu_env *env);
493 int qti_lqes_restore_init(const struct lu_env *env);
494 void qti_lqes_restore_fini(const struct lu_env *env);
495 void qti_lqes_write_lock(const struct lu_env *env);
496 void qti_lqes_write_unlock(const struct lu_env *env);
497
498 struct lqe_glbl_data *qmt_alloc_lqe_gd(struct qmt_pool_info *, int);
499 void qmt_free_lqe_gd(struct lqe_glbl_data *);
500 void qmt_setup_lqe_gd(const struct lu_env *,  struct qmt_device *,
501                     struct lquota_entry *, struct lqe_glbl_data *, int);
502 #define qmt_seed_glbe_edquot(env, lqeg) \
503                 qmt_seed_glbe_all(env, lqeg, false, true)
504 #define qmt_seed_glbe_qunit(env, lqeg) \
505                 qmt_seed_glbe_all(env, lqeg, true, false)
506 #define qmt_seed_glbe(env, lqeg) \
507                 qmt_seed_glbe_all(env, lqeg, true, true)
508 void qmt_seed_glbe_all(const struct lu_env *, struct lqe_glbl_data *,
509                        bool , bool);
510
511 /* qmt_handler.c */
512 int qmt_set_with_lqe(const struct lu_env *env, struct qmt_device *qmt,
513                      struct lquota_entry *lqe, __u64 hard, __u64 soft,
514                      __u64 time, __u32 valid, bool is_default, bool is_updated);
515 int qmt_dqacq0(const struct lu_env *, struct qmt_device *, struct obd_uuid *,
516                __u32, __u64, __u64, struct quota_body *);
517 int qmt_uuid2idx(struct obd_uuid *, int *);
518
519 /* qmt_lock.c */
520 int qmt_intent_policy(const struct lu_env *, struct lu_device *,
521                       struct ptlrpc_request *, struct ldlm_lock **, int);
522 int qmt_lvbo_init(struct lu_device *, struct ldlm_resource *);
523 int qmt_lvbo_update(struct lu_device *, struct ldlm_resource *,
524                     struct ptlrpc_request *, int);
525 int qmt_lvbo_size(struct lu_device *, struct ldlm_lock *);
526 int qmt_lvbo_fill(struct lu_device *, struct ldlm_lock *, void *, int);
527 int qmt_lvbo_free(struct lu_device *, struct ldlm_resource *);
528 int qmt_start_reba_thread(struct qmt_device *);
529 void qmt_stop_reba_thread(struct qmt_device *);
530 void qmt_glb_lock_notify(const struct lu_env *, struct lquota_entry *, __u64);
531 void qmt_id_lock_notify(struct qmt_device *, struct lquota_entry *);
532 #endif /* _QMT_INTERNAL_H */