Whamcloud - gitweb
LU-3030 build: Update Master Copyrights pre 2.4 split
[fs/lustre-release.git] / lustre / quota / qsd_lib.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, 2013, 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 /*
32  * Quota Slave Driver (QSD) management.
33  *
34  * The quota slave feature is implemented under the form of a library called
35  * QSD. Each OSD device should create a QSD instance via qsd_init() which will
36  * be used to manage quota enforcement for this device. This implies:
37  * - completing the reintegration procedure with the quota master (aka QMT, see
38  *   qmt_dev.c) to retrieve the latest quota settings and space distribution.
39  * - managing quota locks in order to be notified of configuration changes.
40  * - acquiring space from the QMT when quota space for a given user/group is
41  *   close to exhaustion.
42  * - allocating quota space to service threads for local request processing.
43  *
44  * Once the QSD instance created, the OSD device should invoke qsd_start()
45  * when recovery is completed. This notifies the QSD that we are about to
46  * process new requests on which quota should be strictly enforced.
47  * Then, qsd_op_begin/end can be used to reserve/release/pre-acquire quota space
48  * for/after each operation until shutdown where the QSD instance should be
49  * freed via qsd_fini().
50  */
51
52 #ifndef EXPORT_SYMTAB
53 # define EXPORT_SYMTAB
54 #endif
55
56 #define DEBUG_SUBSYSTEM S_LQUOTA
57
58 #include <obd_class.h>
59 #include "qsd_internal.h"
60
61 cfs_mem_cache_t *upd_kmem;
62
63 struct lu_kmem_descr qsd_caches[] = {
64         {
65                 .ckd_cache = &upd_kmem,
66                 .ckd_name  = "upd_kmem",
67                 .ckd_size  = sizeof(struct qsd_upd_rec)
68         },
69         {
70                 .ckd_cache = NULL
71         }
72 };
73
74 /* define qsd thread key */
75 LU_KEY_INIT_FINI(qsd, struct qsd_thread_info);
76 LU_CONTEXT_KEY_DEFINE(qsd, LCT_MD_THREAD | LCT_DT_THREAD | LCT_LOCAL);
77 LU_KEY_INIT_GENERIC(qsd);
78
79 /* some procfs helpers */
80 static int lprocfs_qsd_rd_state(char *page, char **start, off_t off,
81                                 int count, int *eof, void *data)
82 {
83         struct qsd_instance     *qsd = (struct qsd_instance *)data;
84         char                     enabled[5];
85         int                      rc;
86
87         LASSERT(qsd != NULL);
88
89         memset(enabled, 0, sizeof(enabled));
90         if (qsd_type_enabled(qsd, USRQUOTA))
91                 strcat(enabled, "u");
92         if (qsd_type_enabled(qsd, GRPQUOTA))
93                 strcat(enabled, "g");
94         if (strlen(enabled) == 0)
95                 strcat(enabled, "none");
96
97         rc = snprintf(page, count,
98                       "target name:    %s\n"
99                       "pool ID:        %d\n"
100                       "type:           %s\n"
101                       "quota enabled:  %s\n"
102                       "conn to master: %s\n",
103                       qsd->qsd_svname, qsd->qsd_pool_id,
104                       qsd->qsd_is_md ? "md" : "dt", enabled,
105                       qsd->qsd_exp_valid ? "setup" : "not setup yet");
106
107         if (qsd->qsd_prepared) {
108                 memset(enabled, 0, sizeof(enabled));
109                 if (qsd->qsd_type_array[USRQUOTA]->qqi_acct_obj != NULL)
110                         strcat(enabled, "u");
111                 if (qsd->qsd_type_array[GRPQUOTA]->qqi_acct_obj != NULL)
112                         strcat(enabled, "g");
113                 if (strlen(enabled) == 0)
114                         strcat(enabled, "none");
115                 rc +=  snprintf(page + rc, count - rc,
116                                 "space acct:     %s\n"
117                                 "user uptodate:  glb[%d],slv[%d],reint[%d]\n"
118                                 "group uptodate: glb[%d],slv[%d],reint[%d]\n",
119                                 enabled,
120                                 qsd->qsd_type_array[USRQUOTA]->qqi_glb_uptodate,
121                                 qsd->qsd_type_array[USRQUOTA]->qqi_slv_uptodate,
122                                 qsd->qsd_type_array[USRQUOTA]->qqi_reint,
123                                 qsd->qsd_type_array[GRPQUOTA]->qqi_glb_uptodate,
124                                 qsd->qsd_type_array[GRPQUOTA]->qqi_slv_uptodate,
125                                 qsd->qsd_type_array[GRPQUOTA]->qqi_reint);
126         }
127         return rc;
128 }
129
130 static int lprocfs_qsd_rd_enabled(char *page, char **start, off_t off,
131                                   int count, int *eof, void *data)
132 {
133         struct qsd_instance     *qsd = (struct qsd_instance *)data;
134         char                     enabled[5];
135
136         LASSERT(qsd != NULL);
137
138         memset(enabled, 0, sizeof(enabled));
139         if (qsd_type_enabled(qsd, USRQUOTA))
140                 strcat(enabled, "u");
141         if (qsd_type_enabled(qsd, GRPQUOTA))
142                 strcat(enabled, "g");
143         if (strlen(enabled) == 0)
144                 strcat(enabled, "none");
145
146         return snprintf(page, count, "%s\n", enabled);
147 }
148
149 /* force reintegration procedure to be executed.
150  * Used for test/debugging purpose */
151 static int lprocfs_qsd_wr_force_reint(struct file *file, const char *buffer,
152                                       unsigned long count, void *data)
153 {
154         struct qsd_instance     *qsd = (struct qsd_instance *)data;
155         int                      rc = 0, qtype;
156
157         LASSERT(qsd != NULL);
158
159         write_lock(&qsd->qsd_lock);
160         if (qsd->qsd_stopping) {
161                 /* don't mess up with shutdown procedure, it is already
162                  * complicated enough */
163                 rc = -ESHUTDOWN;
164         } else if (!qsd->qsd_prepared) {
165                 rc = -EAGAIN;
166         } else {
167                 /* mark all indexes as stale */
168                 for (qtype = USRQUOTA; qtype < MAXQUOTAS; qtype++) {
169                         qsd->qsd_type_array[qtype]->qqi_glb_uptodate = false;
170                         qsd->qsd_type_array[qtype]->qqi_slv_uptodate = false;
171                 }
172         }
173         write_unlock(&qsd->qsd_lock);
174
175         if (rc)
176                 return rc;
177
178         /* kick off reintegration */
179         for (qtype = USRQUOTA; qtype < MAXQUOTAS; qtype++) {
180                 rc = qsd_start_reint_thread(qsd->qsd_type_array[qtype]);
181                 if (rc)
182                         break;
183         }
184         return rc == 0 ? count : rc;
185 }
186
187 static int lprocfs_qsd_rd_timeout(char *page, char **start, off_t off,
188                                   int count, int *eof, void *data)
189 {
190         struct qsd_instance     *qsd = (struct qsd_instance *)data;
191         LASSERT(qsd != NULL);
192
193         return snprintf(page, count, "%d\n", qsd_wait_timeout(qsd));
194 }
195
196 static int lprocfs_qsd_wr_timeout(struct file *file, const char *buffer,
197                                   unsigned long count, void *data)
198 {
199         struct qsd_instance     *qsd = (struct qsd_instance *)data;
200         int                      timeout, rc;
201         LASSERT(qsd != NULL);
202
203         rc = lprocfs_write_helper(buffer, count, &timeout);
204         if (rc)
205                 return rc;
206         if (timeout < 0)
207                 return -EINVAL;
208
209         qsd->qsd_timeout = timeout;
210         return count;
211 }
212
213 static struct lprocfs_vars lprocfs_quota_qsd_vars[] = {
214         { "info", lprocfs_qsd_rd_state, 0, 0},
215         { "enabled", lprocfs_qsd_rd_enabled, 0, 0},
216         { "force_reint", 0, lprocfs_qsd_wr_force_reint, 0},
217         { "timeout", lprocfs_qsd_rd_timeout, lprocfs_qsd_wr_timeout, 0},
218         { NULL }
219 };
220
221 /*
222  * Callback function invoked by the OSP layer when the connection to the master
223  * has been set up.
224  *
225  * \param data - is a pointer to the qsd_instance
226  *
227  * \retval - 0 on success, appropriate error on failure
228  */
229 static int qsd_conn_callback(void *data)
230 {
231         struct qsd_instance *qsd = (struct qsd_instance *)data;
232         int                  type;
233         ENTRY;
234
235         /* qsd_exp should now be valid */
236         LASSERT(qsd->qsd_exp);
237
238         /* grab reference on namespace */
239         ldlm_namespace_get(class_exp2obd(qsd->qsd_exp)->obd_namespace);
240         qsd->qsd_ns = class_exp2obd(qsd->qsd_exp)->obd_namespace;
241
242         write_lock(&qsd->qsd_lock);
243         /* notify that qsd_exp is now valid */
244         qsd->qsd_exp_valid = true;
245         write_unlock(&qsd->qsd_lock);
246
247         /* Now that the connection to master is setup, we can initiate the
248          * reintegration procedure for quota types which are enabled.
249          * It is worth noting that, if the qsd_instance hasn't been started
250          * already, then we can only complete the first two steps of the
251          * reintegration procedure (i.e. global lock enqueue and slave
252          * index transfer) since the space usage reconciliation (i.e.
253          * step 3) will have to wait for qsd_start() to be called */
254         for (type = USRQUOTA; type < MAXQUOTAS; type++) {
255                 struct qsd_qtype_info *qqi = qsd->qsd_type_array[type];
256                 cfs_waitq_signal(&qqi->qqi_reint_thread.t_ctl_waitq);
257         }
258
259         RETURN(0);
260 }
261
262 /*
263  * Release qsd_qtype_info structure which contains data associated with a
264  * given quota type. This releases the accounting objects.
265  * It's called on OSD cleanup when the qsd instance is released.
266  *
267  * \param env - is the environment passed by the caller
268  * \param qsd - is the qsd instance managing the qsd_qtype_info structure
269  *              to be released
270  * \param qtype - is the quota type to be shutdown
271  */
272 static void qsd_qtype_fini(const struct lu_env *env, struct qsd_instance *qsd,
273                            int qtype)
274 {
275         struct qsd_qtype_info   *qqi;
276         ENTRY;
277
278         if (qsd->qsd_type_array[qtype] == NULL)
279                 RETURN_EXIT;
280         qqi = qsd->qsd_type_array[qtype];
281         qsd->qsd_type_array[qtype] = NULL;
282
283         /* all deferred work lists should be empty */
284         LASSERT(cfs_list_empty(&qqi->qqi_deferred_glb));
285         LASSERT(cfs_list_empty(&qqi->qqi_deferred_slv));
286
287         /* shutdown lquota site */
288         if (qqi->qqi_site != NULL && !IS_ERR(qqi->qqi_site)) {
289                 lquota_site_free(env, qqi->qqi_site);
290                 qqi->qqi_site = NULL;
291         }
292
293         /* by now, all qqi users should have gone away */
294         LASSERT(cfs_atomic_read(&qqi->qqi_ref) == 1);
295         lu_ref_fini(&qqi->qqi_reference);
296
297         /* release accounting object */
298         if (qqi->qqi_acct_obj != NULL && !IS_ERR(qqi->qqi_acct_obj)) {
299                 lu_object_put(env, &qqi->qqi_acct_obj->do_lu);
300                 qqi->qqi_acct_obj = NULL;
301         }
302
303         /* release slv index */
304         if (qqi->qqi_slv_obj != NULL && !IS_ERR(qqi->qqi_slv_obj)) {
305                 lu_object_put(env, &qqi->qqi_slv_obj->do_lu);
306                 qqi->qqi_slv_obj = NULL;
307                 qqi->qqi_slv_ver = 0;
308         }
309
310         /* release global index */
311         if (qqi->qqi_glb_obj != NULL && !IS_ERR(qqi->qqi_glb_obj)) {
312                 lu_object_put(env, &qqi->qqi_glb_obj->do_lu);
313                 qqi->qqi_glb_obj = NULL;
314                 qqi->qqi_glb_ver = 0;
315         }
316
317         OBD_FREE_PTR(qqi);
318         EXIT;
319 }
320
321 /*
322  * Allocate and initialize a qsd_qtype_info structure for quota type \qtype.
323  * This opens the accounting object and initializes the proc file.
324  * It's called on OSD start when the qsd_prepare() is invoked on the qsd
325  * instance.
326  *
327  * \param env  - the environment passed by the caller
328  * \param qsd  - is the qsd instance which will be in charge of the new
329  *               qsd_qtype_info instance.
330  * \param qtype - is quota type to set up
331  *
332  * \retval - 0 on success and qsd->qsd_type_array[qtype] is allocated,
333  *           appropriate error on failure
334  */
335 static int qsd_qtype_init(const struct lu_env *env, struct qsd_instance *qsd,
336                           int qtype)
337 {
338         struct qsd_qtype_info   *qqi;
339         int                      rc;
340         struct obd_uuid          uuid;
341         ENTRY;
342
343         LASSERT(qsd->qsd_type_array[qtype] == NULL);
344
345         /* allocate structure for this quota type */
346         OBD_ALLOC_PTR(qqi);
347         if (qqi == NULL)
348                 RETURN(-ENOMEM);
349         qsd->qsd_type_array[qtype] = qqi;
350         cfs_atomic_set(&qqi->qqi_ref, 1); /* referenced from qsd */
351
352         /* set backpointer and other parameters */
353         qqi->qqi_qsd   = qsd;
354         qqi->qqi_qtype = qtype;
355         lu_ref_init(&qqi->qqi_reference);
356         lquota_generate_fid(&qqi->qqi_fid, qsd->qsd_pool_id, QSD_RES_TYPE(qsd),
357                             qtype);
358         qqi->qqi_glb_uptodate = false;
359         qqi->qqi_slv_uptodate = false;
360         qqi->qqi_reint        = false;
361         cfs_waitq_init(&qqi->qqi_reint_thread.t_ctl_waitq);
362         thread_set_flags(&qqi->qqi_reint_thread, SVC_STOPPED);
363         CFS_INIT_LIST_HEAD(&qqi->qqi_deferred_glb);
364         CFS_INIT_LIST_HEAD(&qqi->qqi_deferred_slv);
365
366         /* open accounting object */
367         LASSERT(qqi->qqi_acct_obj == NULL);
368         qqi->qqi_acct_obj = acct_obj_lookup(env, qsd->qsd_dev, qtype);
369         if (IS_ERR(qqi->qqi_acct_obj)) {
370                 CDEBUG(D_QUOTA, "%s: no %s space accounting support rc:%ld\n",
371                        qsd->qsd_svname, QTYPE_NAME(qtype),
372                        PTR_ERR(qqi->qqi_acct_obj));
373                 qqi->qqi_acct_obj = NULL;
374                 qsd->qsd_acct_failed = true;
375         }
376
377         /* open global index copy */
378         LASSERT(qqi->qqi_glb_obj == NULL);
379         qqi->qqi_glb_obj = lquota_disk_glb_find_create(env, qsd->qsd_dev,
380                                                        qsd->qsd_root,
381                                                        &qqi->qqi_fid, true);
382         if (IS_ERR(qqi->qqi_glb_obj)) {
383                 CERROR("%s: can't open global index copy "DFID" %ld\n",
384                        qsd->qsd_svname, PFID(&qqi->qqi_fid),
385                        PTR_ERR(qqi->qqi_glb_obj));
386                 GOTO(out, rc = PTR_ERR(qqi->qqi_glb_obj));
387         }
388         qqi->qqi_glb_ver = dt_version_get(env, qqi->qqi_glb_obj);
389
390         /* open slave index copy */
391         LASSERT(qqi->qqi_slv_obj == NULL);
392         obd_str2uuid(&uuid, qsd->qsd_svname);
393         qqi->qqi_slv_obj = lquota_disk_slv_find_create(env, qsd->qsd_dev,
394                                                        qsd->qsd_root,
395                                                        &qqi->qqi_fid, &uuid,
396                                                        true);
397         if (IS_ERR(qqi->qqi_slv_obj)) {
398                 CERROR("%s: can't open slave index copy "DFID" %ld\n",
399                        qsd->qsd_svname, PFID(&qqi->qqi_fid),
400                        PTR_ERR(qqi->qqi_slv_obj));
401                 GOTO(out, rc = PTR_ERR(qqi->qqi_slv_obj));
402         }
403         qqi->qqi_slv_ver = dt_version_get(env, qqi->qqi_slv_obj);
404
405         /* allocate site */
406         qqi->qqi_site = lquota_site_alloc(env, qqi, false, qtype, &qsd_lqe_ops);
407         if (IS_ERR(qqi->qqi_site)) {
408                 CERROR("%s: can't allocate site "DFID" %ld\n", qsd->qsd_svname,
409                        PFID(&qqi->qqi_fid), PTR_ERR(qqi->qqi_site));
410                 GOTO(out, rc = PTR_ERR(qqi->qqi_site));
411         }
412
413         /* register proc entry for accounting & global index copy objects */
414         rc = lprocfs_seq_create(qsd->qsd_proc,
415                                 qtype == USRQUOTA ? "acct_user" : "acct_group",
416                                 0444, &lprocfs_quota_seq_fops,
417                                 qqi->qqi_acct_obj);
418         if (rc) {
419                 CERROR("%s: can't add procfs entry for accounting file %d\n",
420                        qsd->qsd_svname, rc);
421                 GOTO(out, rc);
422         }
423
424         rc = lprocfs_seq_create(qsd->qsd_proc,
425                                 qtype == USRQUOTA ? "limit_user" : "limit_group",
426                                 0444, &lprocfs_quota_seq_fops,
427                                 qqi->qqi_glb_obj);
428         if (rc) {
429                 CERROR("%s: can't add procfs entry for global index copy %d\n",
430                        qsd->qsd_svname, rc);
431                 GOTO(out, rc);
432         }
433         EXIT;
434 out:
435         if (rc)
436                 qsd_qtype_fini(env, qsd, qtype);
437         return rc;
438 }
439
440 /*
441  * Release a qsd_instance. Companion of qsd_init(). This releases all data
442  * structures associated with the quota slave (on-disk objects, lquota entry
443  * tables, ...).
444  * This function should be called when the OSD is shutting down.
445  *
446  * \param env - is the environment passed by the caller
447  * \param qsd - is the qsd instance to shutdown
448  */
449 void qsd_fini(const struct lu_env *env, struct qsd_instance *qsd)
450 {
451         int     qtype;
452         ENTRY;
453
454         if (unlikely(qsd == NULL))
455                 RETURN_EXIT;
456
457         CDEBUG(D_QUOTA, "%s: initiating QSD shutdown\n", qsd->qsd_svname);
458         write_lock(&qsd->qsd_lock);
459         qsd->qsd_stopping = true;
460         write_unlock(&qsd->qsd_lock);
461
462         /* remove qsd proc entry */
463         if (qsd->qsd_proc != NULL) {
464                 lprocfs_remove(&qsd->qsd_proc);
465                 qsd->qsd_proc = NULL;
466         }
467
468         /* stop the writeback thread */
469         qsd_stop_upd_thread(qsd);
470
471         /* shutdown the reintegration threads */
472         for (qtype = USRQUOTA; qtype < MAXQUOTAS; qtype++) {
473                 if (qsd->qsd_type_array[qtype] == NULL)
474                         continue;
475                 qsd_stop_reint_thread(qsd->qsd_type_array[qtype]);
476         }
477
478         /* release reference on namespace */
479         if (qsd->qsd_ns != NULL) {
480                 ldlm_namespace_put(qsd->qsd_ns);
481                 qsd->qsd_ns = NULL;
482         }
483
484         /* free per-quota type data */
485         for (qtype = USRQUOTA; qtype < MAXQUOTAS; qtype++)
486                 qsd_qtype_fini(env, qsd, qtype);
487
488         /* deregister connection to the quota master */
489         qsd->qsd_exp_valid = false;
490         lustre_deregister_lwp_item(&qsd->qsd_exp);
491
492         /* release per-filesystem information */
493         if (qsd->qsd_fsinfo != NULL) {
494                 down(&qsd->qsd_fsinfo->qfs_sem);
495                 /* remove from the list of fsinfo */
496                 cfs_list_del_init(&qsd->qsd_link);
497                 up(&qsd->qsd_fsinfo->qfs_sem);
498                 qsd_put_fsinfo(qsd->qsd_fsinfo);
499                 qsd->qsd_fsinfo = NULL;
500         }
501
502         /* release quota root directory */
503         if (qsd->qsd_root != NULL) {
504                 lu_object_put(env, &qsd->qsd_root->do_lu);
505                 qsd->qsd_root = NULL;
506         }
507
508         /* release reference on dt_device */
509         if (qsd->qsd_dev != NULL) {
510                 lu_ref_del(&qsd->qsd_dev->dd_lu_dev.ld_reference, "qsd", qsd);
511                 lu_device_put(&qsd->qsd_dev->dd_lu_dev);
512                 qsd->qsd_dev = NULL;
513         }
514
515         CDEBUG(D_QUOTA, "%s: QSD shutdown completed\n", qsd->qsd_svname);
516         OBD_FREE_PTR(qsd);
517         EXIT;
518 }
519 EXPORT_SYMBOL(qsd_fini);
520
521 /*
522  * Create a new qsd_instance to be associated with backend osd device
523  * identified by \dev.
524  *
525  * \param env    - the environment passed by the caller
526  * \param svname - is the service name of the OSD device creating this instance
527  * \param dev    - is the dt_device where to store quota index files
528  * \param osd_proc - is the procfs parent directory where to create procfs file
529  *                   related to this new qsd instance
530  *
531  * \retval - pointer to new qsd_instance associated with dev \dev on success,
532  *           appropriate error on failure
533  */
534 struct qsd_instance *qsd_init(const struct lu_env *env, char *svname,
535                               struct dt_device *dev,
536                               cfs_proc_dir_entry_t *osd_proc)
537 {
538         struct qsd_thread_info  *qti = qsd_info(env);
539         struct qsd_instance     *qsd;
540         int                      rc, type, idx;
541         ENTRY;
542
543         /* only configure qsd for MDT & OST */
544         type = server_name2index(svname, &idx, NULL);
545         if (type != LDD_F_SV_TYPE_MDT && type != LDD_F_SV_TYPE_OST)
546                 RETURN(NULL);
547
548         /* allocate qsd instance */
549         OBD_ALLOC_PTR(qsd);
550         if (qsd == NULL)
551                 RETURN(ERR_PTR(-ENOMEM));
552
553         /* generic initializations */
554         rwlock_init(&qsd->qsd_lock);
555         CFS_INIT_LIST_HEAD(&qsd->qsd_link);
556         thread_set_flags(&qsd->qsd_upd_thread, SVC_STOPPED);
557         cfs_waitq_init(&qsd->qsd_upd_thread.t_ctl_waitq);
558         CFS_INIT_LIST_HEAD(&qsd->qsd_upd_list);
559         spin_lock_init(&qsd->qsd_adjust_lock);
560         CFS_INIT_LIST_HEAD(&qsd->qsd_adjust_list);
561         qsd->qsd_prepared = false;
562         qsd->qsd_started = false;
563
564         /* copy service name */
565         if (strlcpy(qsd->qsd_svname, svname, sizeof(qsd->qsd_svname))
566             >= sizeof(qsd->qsd_svname))
567                 GOTO(out, rc = -E2BIG);
568
569         /* grab reference on osd device */
570         lu_device_get(&dev->dd_lu_dev);
571         lu_ref_add(&dev->dd_lu_dev.ld_reference, "qsd", qsd);
572         qsd->qsd_dev = dev;
573
574         /* we only support pool ID 0 (default data or metadata pool) for the
575          * time being. A different pool ID could be assigned to this target via
576          * the configuration log in the future */
577         qsd->qsd_pool_id  = 0;
578
579         /* get fsname from svname */
580         rc = server_name2fsname(svname, qti->qti_buf, NULL);
581         if (rc) {
582                 CERROR("%s: fail to extract filesystem name\n", svname);
583                 GOTO(out, rc);
584         }
585
586         /* look up quota setting for the filesystem the target belongs to */
587         qsd->qsd_fsinfo = qsd_get_fsinfo(qti->qti_buf, 1);
588         if (qsd->qsd_fsinfo == NULL) {
589                 CERROR("%s: failed to locate filesystem information\n", svname);
590                 GOTO(out, rc = -EINVAL);
591         }
592
593         /* add in the list of lquota_fsinfo */
594         down(&qsd->qsd_fsinfo->qfs_sem);
595         list_add_tail(&qsd->qsd_link, &qsd->qsd_fsinfo->qfs_qsd_list);
596         up(&qsd->qsd_fsinfo->qfs_sem);
597
598         /* register procfs directory */
599         qsd->qsd_proc = lprocfs_register(QSD_DIR, osd_proc,
600                                          lprocfs_quota_qsd_vars, qsd);
601         if (IS_ERR(qsd->qsd_proc)) {
602                 rc = PTR_ERR(qsd->qsd_proc);
603                 qsd->qsd_proc = NULL;
604                 CERROR("%s: fail to create quota slave proc entry (%d)\n",
605                        svname, rc);
606                 GOTO(out, rc);
607         }
608         EXIT;
609 out:
610         if (rc) {
611                 qsd_fini(env, qsd);
612                 return ERR_PTR(rc);
613         }
614         RETURN(qsd);
615 }
616 EXPORT_SYMBOL(qsd_init);
617
618 /*
619  * Initialize on-disk structures in order to manage quota enforcement for
620  * the target associated with the qsd instance \qsd and starts the reintegration
621  * procedure for each quota type as soon as possible.
622  * The last step of the reintegration will be completed once qsd_start() is
623  * called, at which points the space reconciliation with the master will be
624  * executed.
625  * This function must be called when the server stack is fully configured,
626  * typically when ->ldo_prepare is called across the stack.
627  *
628  * \param env - the environment passed by the caller
629  * \param qsd - is qsd_instance to prepare
630  *
631  * \retval - 0 on success, appropriate error on failure
632  */
633 int qsd_prepare(const struct lu_env *env, struct qsd_instance *qsd)
634 {
635         struct qsd_thread_info  *qti = qsd_info(env);
636         int                      qtype, rc = 0;
637         ENTRY;
638
639         if (unlikely(qsd == NULL))
640                 RETURN(0);
641
642         read_lock(&qsd->qsd_lock);
643         if (qsd->qsd_prepared) {
644                 CERROR("%s: qsd instance already prepared\n", qsd->qsd_svname);
645                 rc = -EALREADY;
646         }
647         read_unlock(&qsd->qsd_lock);
648         if (rc)
649                 RETURN(rc);
650
651         /* Record whether this qsd instance is managing quota enforcement for a
652          * MDT (i.e. inode quota) or OST (block quota) */
653         if (lu_device_is_md(qsd->qsd_dev->dd_lu_dev.ld_site->ls_top_dev)) {
654                 qsd->qsd_is_md = true;
655                 qsd->qsd_sync_threshold = LQUOTA_LEAST_QUNIT(LQUOTA_RES_MD);
656         } else {
657                 qsd->qsd_sync_threshold = LQUOTA_LEAST_QUNIT(LQUOTA_RES_DT);
658         }
659
660         /* look-up on-disk directory for the quota slave */
661         qsd->qsd_root = lquota_disk_dir_find_create(env, qsd->qsd_dev, NULL,
662                                                     QSD_DIR);
663         if (IS_ERR(qsd->qsd_root)) {
664                 rc = PTR_ERR(qsd->qsd_root);
665                 qsd->qsd_root = NULL;
666                 CERROR("%s: failed to create quota slave root dir (%d)\n",
667                        qsd->qsd_svname, rc);
668                 RETURN(rc);
669         }
670
671         /* initialize per-quota type data */
672         for (qtype = USRQUOTA; qtype < MAXQUOTAS; qtype++) {
673                 rc = qsd_qtype_init(env, qsd, qtype);
674                 if (rc)
675                         RETURN(rc);
676         }
677
678         /* pools successfully setup, mark the qsd as prepared */
679         write_lock(&qsd->qsd_lock);
680         qsd->qsd_prepared = true;
681         write_unlock(&qsd->qsd_lock);
682
683         /* start reintegration thread for each type, if required */
684         for (qtype = USRQUOTA; qtype < MAXQUOTAS; qtype++) {
685                 struct qsd_qtype_info   *qqi = qsd->qsd_type_array[qtype];
686
687                 if (qsd_type_enabled(qsd, qtype) && qsd->qsd_acct_failed) {
688                         LCONSOLE_ERROR("%s: can't enable quota enforcement "
689                                        "since space accounting isn't functional"
690                                        ". Please run tunefs.lustre --quota on "
691                                        "an unmounted filesystem if not done "
692                                        "already\n", qsd->qsd_svname);
693                         break;
694                 }
695
696                 rc = qsd_start_reint_thread(qqi);
697                 if (rc) {
698                         CERROR("%s: failed to start reint thread for type %s "
699                                "(%d)\n", qsd->qsd_svname, QTYPE_NAME(qtype),
700                                rc);
701                         RETURN(rc);
702                 }
703         }
704
705         /* start writeback thread */
706         rc = qsd_start_upd_thread(qsd);
707         if (rc) {
708                 CERROR("%s: failed to start writeback thread (%d)\n",
709                        qsd->qsd_svname, rc);
710                 RETURN(rc);
711         }
712
713         /* generate osp name */
714         rc = tgt_name2lwpname((char *)qsd->qsd_svname, qti->qti_buf);
715         if (rc) {
716                 CERROR("%s: failed to generate ospname (%d)\n",
717                        qsd->qsd_svname, rc);
718                 RETURN(rc);
719         }
720
721         /* the connection callback will start the reintegration
722          * procedure if quota is enabled */
723         rc = lustre_register_lwp_item(qti->qti_buf, &qsd->qsd_exp,
724                                       qsd_conn_callback, (void *)qsd);
725         if (rc) {
726                 CERROR("%s: fail to get connection to master (%d)\n",
727                        qsd->qsd_svname, rc);
728                 RETURN(rc);
729         }
730
731         RETURN(0);
732 }
733 EXPORT_SYMBOL(qsd_prepare);
734
735 /*
736  * Start a qsd instance. This will complete the last step of the reintegration
737  * procedure as soon as possible (provided that the master is reachable).
738  * This should be called when recovery has been completed and quota should now
739  * be enforced on every operations.
740  *
741  * \param env - the environment passed by the caller
742  * \param qsd - is the qsd instance associated with the osd device to start
743  */
744 int qsd_start(const struct lu_env *env, struct qsd_instance *qsd)
745 {
746         int     type, rc = 0;
747         ENTRY;
748
749         if (unlikely(qsd == NULL))
750                 RETURN(0);
751
752         write_lock(&qsd->qsd_lock);
753         if (!qsd->qsd_prepared) {
754                 CERROR("%s: can't start qsd instance since it wasn't properly "
755                        "initialized\n", qsd->qsd_svname);
756                 rc = -EFAULT;
757         } else if (qsd->qsd_started) {
758                 CERROR("%s: qsd instance already started\n", qsd->qsd_svname);
759                 rc = -EALREADY;
760         } else {
761                 /* notify that the qsd_instance is now started */
762                 qsd->qsd_started = true;
763         }
764         write_unlock(&qsd->qsd_lock);
765
766         if (rc)
767                 RETURN(rc);
768
769         /* Trigger the 3rd step of reintegration: If usage > granted, acquire
770          * up to usage; If usage < granted, release down to usage.  */
771         for (type = USRQUOTA; type < MAXQUOTAS; type++) {
772                 struct qsd_qtype_info   *qqi = qsd->qsd_type_array[type];
773                 cfs_waitq_signal(&qqi->qqi_reint_thread.t_ctl_waitq);
774         }
775
776         RETURN(rc);
777 }
778 EXPORT_SYMBOL(qsd_start);
779
780 void lustre_register_quota_process_config(int (*qpc)(struct lustre_cfg *lcfg));
781
782 /*
783  * Global initialization performed at module load time
784  */
785 int qsd_glb_init(void)
786 {
787         int     rc;
788
789         rc = lu_kmem_init(qsd_caches);
790         if (rc)
791                 return rc;
792
793         qsd_key_init_generic(&qsd_thread_key, NULL);
794         lu_context_key_register(&qsd_thread_key);
795         lustre_register_quota_process_config(qsd_process_config);
796
797         return 0;
798 }
799
800 /*
801  * Companion of qsd_glb_init() called at module unload time
802  */
803 void qsd_glb_fini(void)
804 {
805         lustre_register_quota_process_config(NULL);
806         lu_kmem_fini(qsd_caches);
807         lu_context_key_degister(&qsd_thread_key);
808 }