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, 2014, Intel Corporation.
25 * Use is subject to license terms.
28 #include "lquota_internal.h"
30 #ifndef _QSD_INTERNAL_H
31 #define _QSD_INTERNAL_H
37 * A QSD instance implements quota enforcement support for a given OSD.
38 * The instance can be created via qsd_init() and then freed with qsd_fini().
39 * This structure gathers all quota parameters and pointers to on-disk indexes
40 * required on quota slave to:
41 * i. acquire/release quota space from the QMT;
42 * ii. allocate this quota space to local requests.
45 /* name of service which created this qsd instance */
46 char qsd_svname[MAX_OBD_NAME];
48 /* pool ID is always 0 for now */
51 /* dt_device associated with this qsd instance */
52 struct dt_device *qsd_dev;
54 /* procfs directory where information related to the underlying slaves
56 struct proc_dir_entry *qsd_proc;
58 /* export used for the connection to quota master */
59 struct obd_export *qsd_exp;
61 /* ldlm namespace used for quota locks */
62 struct ldlm_namespace *qsd_ns;
64 /* on-disk directory where to store index files for this qsd instance */
65 struct dt_object *qsd_root;
67 /* We create 2 quota slave instances:
68 * - one for user quota
69 * - one for group quota
71 * This will have to be revisited if new quota types are added in the
72 * future. For the time being, we can just use an array. */
73 struct qsd_qtype_info *qsd_type_array[LL_MAXQUOTAS];
75 /* per-filesystem quota information */
76 struct qsd_fsinfo *qsd_fsinfo;
78 /* link into qfs_qsd_list of qfs_fsinfo */
79 struct list_head qsd_link;
81 /* list of lqe entry which might need quota space adjustment */
82 struct list_head qsd_adjust_list;
84 /* lock protecting adjust list */
85 spinlock_t qsd_adjust_lock;
87 /* dedicated thread for updating slave index files. */
88 struct ptlrpc_thread qsd_upd_thread;
90 /* list of update tasks */
91 struct list_head qsd_upd_list;
93 /* r/w spinlock protecting:
95 * - the qsd update list
97 * - flags of the qsd_qtype_info */
100 /* Default quota settings which apply to all identifiers */
101 /* when blk qunit reaches this value, later write reqs from client
102 * should be sync. b=16642 */
103 unsigned long qsd_sync_threshold;
105 /* how long a service thread can wait for quota space.
106 * value dynamically computed from obd_timeout and at_max if not
107 * enforced here (via procfs) */
110 unsigned long qsd_is_md:1, /* managing quota for mdt */
111 qsd_started:1, /* instance is now started */
112 qsd_prepared:1, /* qsd_prepare() successfully
114 qsd_exp_valid:1,/* qsd_exp is now valid */
115 qsd_stopping:1; /* qsd_instance is stopping */
120 * Per-type quota information.
121 * Quota slave instance for a specific quota type. The qsd instance has one such
122 * structure for each quota type (i.e. user & group).
124 struct qsd_qtype_info {
125 /* reference count incremented by each user of this structure */
128 /* quota type, either USRQUOTA or GRPQUOTA
129 * immutable after creation. */
132 /* Global index FID to use for this quota type */
133 struct lu_fid qqi_fid;
135 /* Slave index FID allocated by the master */
136 struct lu_fid qqi_slv_fid;
138 /* back pointer to qsd device
139 * immutable after creation. */
140 struct qsd_instance *qqi_qsd;
142 /* handle of global quota lock */
143 struct lustre_handle qqi_lockh;
145 /* Local index files storing quota settings for this quota type */
146 struct dt_object *qqi_acct_obj; /* accounting object */
147 struct dt_object *qqi_slv_obj; /* slave index copy */
148 struct dt_object *qqi_glb_obj; /* global index copy */
150 /* Current object versions */
151 __u64 qqi_slv_ver; /* slave index version */
152 __u64 qqi_glb_ver; /* global index version */
154 /* per quota ID information. All lquota entry are kept in a hash table
155 * and read from disk on cache miss. */
156 struct lquota_site *qqi_site;
158 /* Reintegration thread */
159 struct ptlrpc_thread qqi_reint_thread;
161 /* statistics on operations performed by this slave */
162 struct lprocfs_stats *qqi_stats;
164 /* deferred update for the global index copy */
165 struct list_head qqi_deferred_glb;
166 /* deferred update for the slave index copy */
167 struct list_head qqi_deferred_slv;
169 /* Various flags representing the current state of the slave for this
171 unsigned long qqi_glb_uptodate:1, /* global index uptodate
173 qqi_slv_uptodate:1, /* slave index uptodate
175 qqi_reint:1, /* in reintegration or not */
176 qqi_acct_failed:1; /* failed to setup acct */
178 /* A list of references to this instance, for debugging */
179 struct lu_ref qqi_reference;
181 /* default quota setting*/
182 __u64 qqi_default_hardlimit;
183 __u64 qqi_default_softlimit;
184 __u64 qqi_default_gracetime;
188 * Per-filesystem quota information
189 * Structure tracking quota enforcement status on a per-filesystem basis
192 /* filesystem name */
193 char qfs_name[MTI_NAME_MAXLEN];
195 /* what type of quota is enabled for each resource type. */
196 unsigned int qfs_enabled[LQUOTA_NR_RES];
198 /* list of all qsd_instance for this fs */
199 struct list_head qfs_qsd_list;
200 struct mutex qfs_mutex;
202 /* link to the global quota fsinfo list. */
203 struct list_head qfs_link;
205 /* reference count */
210 * Helper functions & prototypes
213 /* helper routine to find qsd_instance associated a lquota_entry */
214 static inline struct qsd_qtype_info *lqe2qqi(struct lquota_entry *lqe)
216 LASSERT(!lqe_is_master(lqe));
217 return (struct qsd_qtype_info *)lqe->lqe_site->lqs_parent;
220 /* qqi_getref/putref is used to track users of a qqi structure */
221 static inline void qqi_getref(struct qsd_qtype_info *qqi)
223 atomic_inc(&qqi->qqi_ref);
226 static inline void qqi_putref(struct qsd_qtype_info *qqi)
228 LASSERT(atomic_read(&qqi->qqi_ref) > 0);
229 atomic_dec(&qqi->qqi_ref);
232 #define QSD_RES_TYPE(qsd) ((qsd)->qsd_is_md ? LQUOTA_RES_MD : LQUOTA_RES_DT)
234 /* udpate record for slave & global index copy */
236 struct list_head qur_link; /* link into qsd_upd_list */
237 union lquota_id qur_qid;
238 union lquota_rec qur_rec;
239 struct qsd_qtype_info *qur_qqi;
240 struct lquota_entry *qur_lqe;
245 /* Common data shared by qsd-level handlers. This is allocated per-thread to
246 * reduce stack consumption. */
247 struct qsd_thread_info {
248 union lquota_rec qti_rec;
249 union lquota_id qti_id;
250 struct lu_fid qti_fid;
251 struct ldlm_res_id qti_resid;
252 struct ldlm_enqueue_info qti_einfo;
253 struct lustre_handle qti_lockh;
255 struct lquota_lvb qti_lvb;
257 struct quota_body qti_body;
258 struct idx_info qti_ii;
260 char qti_buf[MTI_NAME_MAXLEN];
263 extern struct lu_context_key qsd_thread_key;
266 struct qsd_thread_info *qsd_info(const struct lu_env *env)
268 struct qsd_thread_info *info;
270 info = lu_context_key_get(&env->le_ctx, &qsd_thread_key);
272 lu_env_refill((struct lu_env *)env);
273 info = lu_context_key_get(&env->le_ctx, &qsd_thread_key);
279 /* helper function to check whether a given quota type is enabled */
280 static inline int qsd_type_enabled(struct qsd_instance *qsd, int type)
284 LASSERT(qsd != NULL);
285 LASSERT(type < LL_MAXQUOTAS);
287 if (qsd->qsd_fsinfo == NULL)
290 pool = qsd->qsd_is_md ? LQUOTA_RES_MD : LQUOTA_RES_DT;
291 enabled = qsd->qsd_fsinfo->qfs_enabled[pool - LQUOTA_FIRST_RES];
293 return enabled & (1 << type);
296 /* helper function to set new qunit and compute associated qtune value */
297 static inline void qsd_set_qunit(struct lquota_entry *lqe, __u64 qunit)
299 if (lqe->lqe_qunit == qunit)
302 lqe->lqe_qunit = qunit;
304 /* With very large qunit support, we can't afford to have a static
305 * qtune value, e.g. with a 1PB qunit and qtune set to 50%, we would
306 * start pre-allocation when 512TB of free quota space remains.
307 * Therefore, we adapt qtune depending on the actual qunit value */
308 if (qunit == 0) /* if qunit is NULL */
309 lqe->lqe_qtune = 0; /* qtune = 0 */
310 else if (qunit == 1024) /* if 1MB or 1K inodes */
311 lqe->lqe_qtune = qunit >> 1; /* => 50% */
312 else if (qunit <= 1024 * 1024) /* up to 1GB or 1M inodes */
313 lqe->lqe_qtune = qunit >> 2; /* => 25% */
314 else if (qunit <= 4 * 1024 * 1024) /* up to 16GB or 16M inodes */
315 lqe->lqe_qtune = qunit >> 3; /* => 12.5% */
316 else /* above 4GB/4M */
317 lqe->lqe_qtune = 1024 * 1024; /* value capped to 1GB/1M */
319 LQUOTA_DEBUG(lqe, "changing qunit & qtune");
321 /* turn on pre-acquire when qunit is modified */
322 lqe->lqe_nopreacq = false;
325 /* helper function to set/clear edquot flag */
326 static inline void qsd_set_edquot(struct lquota_entry *lqe, bool edquot)
328 lqe->lqe_edquot = edquot;
330 lqe->lqe_edquot_time = ktime_get_seconds();
333 #define QSD_WB_INTERVAL 60 /* 60 seconds */
335 /* helper function calculating how long a service thread should be waiting for
337 static inline int qsd_wait_timeout(struct qsd_instance *qsd)
339 if (qsd->qsd_timeout != 0)
340 return qsd->qsd_timeout;
341 return min_t(int, at_max / 2, obd_timeout / 2);
345 extern struct lquota_entry_operations qsd_lqe_ops;
346 int qsd_refresh_usage(const struct lu_env *, struct lquota_entry *);
347 int qsd_update_index(const struct lu_env *, struct qsd_qtype_info *,
348 union lquota_id *, bool, __u64, void *);
349 int qsd_update_lqe(const struct lu_env *, struct lquota_entry *, bool,
351 int qsd_write_version(const struct lu_env *, struct qsd_qtype_info *,
355 extern struct ldlm_enqueue_info qsd_glb_einfo;
356 extern struct ldlm_enqueue_info qsd_id_einfo;
357 void qsd_update_default_quota(struct qsd_qtype_info *qqi, __u64 hardlimit,
358 __u64 softlimit, __u64 gracetime);
359 int qsd_id_lock_match(struct lustre_handle *, struct lustre_handle *);
360 int qsd_id_lock_cancel(const struct lu_env *, struct lquota_entry *);
363 int qsd_start_reint_thread(struct qsd_qtype_info *);
364 void qsd_stop_reint_thread(struct qsd_qtype_info *);
367 typedef void (*qsd_req_completion_t) (const struct lu_env *,
368 struct qsd_qtype_info *,
369 struct quota_body *, struct quota_body *,
370 struct lustre_handle *,
371 struct lquota_lvb *, void *, int);
372 int qsd_send_dqacq(const struct lu_env *, struct obd_export *,
373 struct quota_body *, bool, qsd_req_completion_t,
374 struct qsd_qtype_info *, struct lustre_handle *,
375 struct lquota_entry *);
376 int qsd_intent_lock(const struct lu_env *, struct obd_export *,
377 struct quota_body *, bool, int, qsd_req_completion_t,
378 struct qsd_qtype_info *, struct lquota_lvb *, void *);
379 int qsd_fetch_index(const struct lu_env *, struct obd_export *,
380 struct idx_info *, unsigned int, struct page **, bool *);
382 /* qsd_writeback.c */
383 void qsd_bump_version(struct qsd_qtype_info *, __u64, bool);
384 void qsd_upd_schedule(struct qsd_qtype_info *, struct lquota_entry *,
385 union lquota_id *, union lquota_rec *, __u64, bool);
387 struct qsd_fsinfo *qsd_get_fsinfo(char *, bool);
388 void qsd_put_fsinfo(struct qsd_fsinfo *);
389 int qsd_config(char *valstr, char *fsname, int pool);
390 int qsd_process_config(struct lustre_cfg *);
393 int qsd_adjust(const struct lu_env *, struct lquota_entry *);
395 /* qsd_writeback.c */
396 void qsd_upd_schedule(struct qsd_qtype_info *, struct lquota_entry *,
397 union lquota_id *, union lquota_rec *, __u64, bool);
398 void qsd_bump_version(struct qsd_qtype_info *, __u64, bool);
399 int qsd_start_upd_thread(struct qsd_instance *);
400 void qsd_stop_upd_thread(struct qsd_instance *);
401 void qsd_adjust_schedule(struct lquota_entry *, bool, bool);
402 #endif /* _QSD_INTERNAL_H */