lustre/quota/qmt_dev.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 /*
  32  * Management of the device associated with a Quota Master Target (QMT).
  33  *
  34  * The QMT holds the cluster wide quota limits. It stores the quota settings
  35  * ({hard,soft} limit & grace time) in a global index file and is in charge
  36  * of allocating quota space to slaves while guaranteeing that the overall
  37  * limits aren't exceeded. The QMT also maintains one index per slave (in fact,
  38  * one per slave per quota type) used to track how much space is allocated
  39  * to a given slave. Now that the QMT is aware of the quota space distribution
  40  * among slaves, it can afford to rebalance efficiently quota space from one
  41  * slave to another. Slaves are asked to release quota space via glimpse
  42  * callbacks sent on DLM locks which are granted to slaves when those latters
  43  * acquire quota space.
  44  *
  45  * The QMT device is currently set up by the MDT and should probably be moved
  46  * to a separate target in the future. Meanwhile, the MDT forwards all quota
  47  * requests to the QMT via a list of request handlers (see struct qmt_handlers
  48  * in lustre_quota.h). The QMT also borrows the LDLM namespace from the MDT.
  49  *
  50  * To bring up a QMT device, the following steps must be completed:
  51  *
  52  * - call ->ldto_device_alloc to allocate the QMT device and perform basic
  53  *   initialization like connecting to the backend OSD device or setting up the
  54  *   default pools and the QMT procfs directory.
  55  *
  56  * - the MDT can then connect to the QMT instance via legacy obd_connect path.
  57  *
  58  * - once the MDT stack has been fully configured, ->ldto_prepare must be called
  59  *   to configure on-disk objects associated with this master target.
  60  *
  61  * To shutdown a QMT device, the MDT just has to disconnect from the QMT.
  62  *
  63  * The qmt_device_type structure is registered when the lquota module is
  64  * loaded and all the steps described above are automatically done when the MDT
  65  * set up the Quota Master Target via calls to class_attach/class_setup, see
  66  * mdt_quota_init() for more details.
  67  */
  68
  69 #define DEBUG_SUBSYSTEM S_LQUOTA
  70
  71 #include <obd_class.h>
  72 #include <lprocfs_status.h>
  73 #include <lustre_disk.h>
  74 #include "qmt_internal.h"
  75
  76 static const struct lu_device_operations qmt_lu_ops;
  77
  78 /*
  79  * Release quota master target and all data structure associated with this
  80  * target.
  81  * Called on MDT0 cleanup.
  82  *
  83  * \param env - is the environment passed by the caller
  84  * \param ld  - is the lu_device associated with the qmt device to be released
  85  *
  86  * \retval - NULL on success (backend OSD device is managed by the main stack),
  87  *           appropriate error on failure
  88  */
  89 static struct lu_device *qmt_device_fini(const struct lu_env *env,
  90                                          struct lu_device *ld)
  91 {
  92         struct qmt_device       *qmt = lu2qmt_dev(ld);
  93         ENTRY;
  94
  95         LASSERT(qmt != NULL);
  96
  97         CDEBUG(D_QUOTA, "%s: initiating QMT shutdown\n", qmt->qmt_svname);
  98         qmt->qmt_stopping = true;
  99
 100         /* kill pool instances, if any */
 101         qmt_pool_fini(env, qmt);
 102
 103         /* remove qmt proc entry */
 104         if (qmt->qmt_proc != NULL && !IS_ERR(qmt->qmt_proc)) {
 105                 lprocfs_remove(&qmt->qmt_proc);
 106                 qmt->qmt_proc = NULL;
 107         }
 108
 109         /* stop rebalance thread */
 110         if (!qmt->qmt_child->dd_rdonly)
 111                 qmt_stop_reba_thread(qmt);
 112
 113         /* disconnect from OSD */
 114         if (qmt->qmt_child_exp != NULL) {
 115                 obd_disconnect(qmt->qmt_child_exp);
 116                 qmt->qmt_child_exp = NULL;
 117                 qmt->qmt_child = NULL;
 118         }
 119
 120         /* clear references to MDT namespace */
 121         ld->ld_obd->obd_namespace = NULL;
 122         qmt->qmt_ns = NULL;
 123
 124         RETURN(NULL);
 125 }
 126
 127 /*
 128  * Connect a quota master to the backend OSD device.
 129  *
 130  * \param env - is the environment passed by the caller
 131  * \param qmt - is the quota master target to be connected
 132  * \param cfg - is the configuration log record from which we need to extract
 133  *              the service name of the backend OSD device to connect to.
 134  *
 135  * \retval - 0 on success, appropriate error on failure
 136  */
 137 static int qmt_connect_to_osd(const struct lu_env *env, struct qmt_device *qmt,
 138                               struct lustre_cfg *cfg)
 139 {
 140         struct obd_connect_data *data = NULL;
 141         struct obd_device       *obd;
 142         struct lu_device        *ld = qmt2lu_dev(qmt);
 143         int                      rc;
 144         ENTRY;
 145
 146         LASSERT(qmt->qmt_child_exp == NULL);
 147
 148         OBD_ALLOC_PTR(data);
 149         if (data == NULL)
 150                 GOTO(out, rc = -ENOMEM);
 151
 152         /* look-up OBD device associated with the backend OSD device.
 153          * The MDT is kind enough to pass the OBD name in QMT configuration */
 154         obd = class_name2obd(lustre_cfg_string(cfg, 3));
 155         if (obd == NULL) {
 156                 CERROR("%s: can't locate backend osd device: %s\n",
 157                        qmt->qmt_svname, lustre_cfg_string(cfg, 3));
 158                 GOTO(out, rc = -ENOTCONN);
 159         }
 160
 161         data->ocd_connect_flags = OBD_CONNECT_VERSION;
 162         data->ocd_version = LUSTRE_VERSION_CODE;
 163
 164         /* connect to OSD device */
 165         rc = obd_connect(NULL, &qmt->qmt_child_exp, obd, &obd->obd_uuid, data,
 166                          NULL);
 167         if (rc) {
 168                 CERROR("%s: cannot connect to osd dev %s (%d)\n",
 169                        qmt->qmt_svname, obd->obd_name, rc);
 170                 GOTO(out, rc);
 171         }
 172
 173         /* initialize site (although it isn't used anywhere) and lu_device
 174          * pointer to next device */
 175         qmt->qmt_child = lu2dt_dev(qmt->qmt_child_exp->exp_obd->obd_lu_dev);
 176         ld->ld_site = qmt->qmt_child_exp->exp_obd->obd_lu_dev->ld_site;
 177         EXIT;
 178 out:
 179         if (data)
 180                 OBD_FREE_PTR(data);
 181         return rc;
 182 }
 183
 184 /*
 185  * Initialize quota master target device. This includers connecting to
 186  * the backend OSD device, initializing the pool configuration and creating the
 187  * root procfs directory dedicated to this quota target.
 188  * The rest of the initialization is done when the stack is fully configured
 189  * (i.e. when ->ldo_start is called across the stack).
 190  *
 191  * This function is called on MDT0 setup.
 192  *
 193  * \param env - is the environment passed by the caller
 194  * \param qmt - is the quota master target to be initialized
 195  * \param ldt - is the device type structure associated with the qmt device
 196  * \param cfg - is the configuration record used to configure the qmt device
 197  *
 198  * \retval - 0 on success, appropriate error on failure
 199  */
 200 static int qmt_device_init0(const struct lu_env *env, struct qmt_device *qmt,
 201                             struct lu_device_type *ldt, struct lustre_cfg *cfg)
 202 {
 203         struct lu_device        *ld = qmt2lu_dev(qmt);
 204         struct obd_device       *obd, *mdt_obd;
 205         struct obd_type         *type;
 206         char                    *svname = lustre_cfg_string(cfg, 0);
 207         int                      rc;
 208         ENTRY;
 209
 210         if (svname == NULL)
 211                 RETURN(-EINVAL);
 212
 213         /* record who i am, it might be useful ... */
 214         rc = strlcpy(qmt->qmt_svname, svname, sizeof(qmt->qmt_svname));
 215         if (rc >= sizeof(qmt->qmt_svname))
 216                 RETURN(-E2BIG);
 217
 218         /* look-up the obd_device associated with the qmt */
 219         obd = class_name2obd(qmt->qmt_svname);
 220         if (obd == NULL)
 221                 RETURN(-ENOENT);
 222
 223         /* reference each other */
 224         obd->obd_lu_dev = ld;
 225         ld->ld_obd      = obd;
 226
 227         /* look-up the parent MDT to steal its ldlm namespace ... */
 228         mdt_obd = class_name2obd(lustre_cfg_string(cfg, 2));
 229         if (mdt_obd == NULL)
 230                 RETURN(-ENOENT);
 231
 232         /* borrow  MDT namespace. kind of a hack until we have our own namespace
 233          * & service threads */
 234         LASSERT(mdt_obd->obd_namespace != NULL);
 235         obd->obd_namespace = mdt_obd->obd_namespace;
 236         qmt->qmt_ns = obd->obd_namespace;
 237
 238         /* connect to backend osd device */
 239         rc = qmt_connect_to_osd(env, qmt, cfg);
 240         if (rc)
 241                 GOTO(out, rc);
 242
 243         /* set up and start rebalance thread */
 244         INIT_LIST_HEAD(&qmt->qmt_reba_list);
 245         spin_lock_init(&qmt->qmt_reba_lock);
 246         if (!qmt->qmt_child->dd_rdonly) {
 247                 rc = qmt_start_reba_thread(qmt);
 248                 if (rc) {
 249                         CERROR("%s: failed to start rebalance thread (%d)\n",
 250                                qmt->qmt_svname, rc);
 251                         GOTO(out, rc);
 252                 }
 253         }
 254
 255         /* at the moment there is no linkage between lu_type and obd_type, so
 256          * we lookup obd_type this way */
 257         type = class_search_type(LUSTRE_QMT_NAME);
 258         LASSERT(type != NULL);
 259
 260         /* put reference taken by class_search_type */
 261         kobject_put(&type->typ_kobj);
 262
 263         /* register proc directory associated with this qmt */
 264         qmt->qmt_proc = lprocfs_register(qmt->qmt_svname, type->typ_procroot,
 265                                          NULL, NULL);
 266         if (IS_ERR(qmt->qmt_proc)) {
 267                 rc = PTR_ERR(qmt->qmt_proc);
 268                 CERROR("%s: failed to create qmt proc entry (%d)\n",
 269                        qmt->qmt_svname, rc);
 270                 GOTO(out, rc);
 271         }
 272
 273         /* initialize pool configuration */
 274         rc = qmt_pool_init(env, qmt);
 275         if (rc)
 276                 GOTO(out, rc);
 277         EXIT;
 278 out:
 279         if (rc)
 280                 qmt_device_fini(env, ld);
 281         return rc;
 282 }
 283
 284 /*
 285  * Free quota master target device. Companion of qmt_device_alloc()
 286  *
 287  * \param env - is the environment passed by the caller
 288  * \param ld  - is the lu_device associated with the qmt dev to be freed
 289  *
 290  * \retval - NULL on success (backend OSD device is managed by the main stack),
 291  *           appropriate error on failure
 292  */
 293 static struct lu_device *qmt_device_free(const struct lu_env *env,
 294                                          struct lu_device *ld)
 295 {
 296         struct qmt_device       *qmt = lu2qmt_dev(ld);
 297         ENTRY;
 298
 299         LASSERT(qmt != NULL);
 300
 301         lu_device_fini(ld);
 302         OBD_FREE_PTR(qmt);
 303         RETURN(NULL);
 304 }
 305
 306 /*
 307  * Allocate quota master target and initialize it.
 308  *
 309  * \param env - is the environment passed by the caller
 310  * \param ldt - is the device type structure associated with the qmt
 311  * \param cfg - is the configuration record used to configure the qmt
 312  *
 313  * \retval - lu_device structure associated with the qmt on success,
 314  *           appropriate error on failure
 315  */
 316 static struct lu_device *qmt_device_alloc(const struct lu_env *env,
 317                                           struct lu_device_type *ldt,
 318                                           struct lustre_cfg *cfg)
 319 {
 320         struct qmt_device       *qmt;
 321         struct lu_device        *ld;
 322         int                      rc;
 323         ENTRY;
 324
 325         /* allocate qmt device */
 326         OBD_ALLOC_PTR(qmt);
 327         if (qmt == NULL)
 328                 RETURN(ERR_PTR(-ENOMEM));
 329
 330         /* configure lu/dt_device */
 331         ld = qmt2lu_dev(qmt);
 332         dt_device_init(&qmt->qmt_dt_dev, ldt);
 333         ld->ld_ops = &qmt_lu_ops;
 334
 335         /* initialize qmt device */
 336         rc = qmt_device_init0(env, qmt, ldt, cfg);
 337         if (rc != 0) {
 338                 qmt_device_free(env, ld);
 339                 RETURN(ERR_PTR(rc));
 340         }
 341
 342         RETURN(ld);
 343 }
 344
 345 LU_KEY_INIT_FINI(qmt, struct qmt_thread_info);
 346 LU_TYPE_INIT_FINI(qmt, &qmt_thread_key);
 347 LU_CONTEXT_KEY_DEFINE(qmt, LCT_MD_THREAD);
 348
 349 /*
 350  * lu device type operations associated with the master target.
 351  */
 352 static struct lu_device_type_operations qmt_device_type_ops = {
 353         .ldto_init              = qmt_type_init,
 354         .ldto_fini              = qmt_type_fini,
 355
 356         .ldto_start             = qmt_type_start,
 357         .ldto_stop              = qmt_type_stop,
 358
 359         .ldto_device_alloc      = qmt_device_alloc,
 360         .ldto_device_free       = qmt_device_free,
 361
 362         .ldto_device_fini       = qmt_device_fini,
 363 };
 364
 365 /*
 366  * lu device type structure associated with the master target.
 367  * MDT0 uses this structure to configure the qmt.
 368  */
 369 static struct lu_device_type qmt_device_type = {
 370         .ldt_tags       = LU_DEVICE_DT,
 371         .ldt_name       = LUSTRE_QMT_NAME,
 372         .ldt_ops        = &qmt_device_type_ops,
 373         .ldt_ctx_tags   = LCT_MD_THREAD,
 374 };
 375
 376 /*
 377  * obd_connect handler used by the MDT to connect to the master target.
 378  */
 379 static int qmt_device_obd_connect(const struct lu_env *env,
 380                                   struct obd_export **exp,
 381                                   struct obd_device *obd,
 382                                   struct obd_uuid *cluuid,
 383                                   struct obd_connect_data *data,
 384                                   void *localdata)
 385 {
 386         struct lustre_handle    conn;
 387         int                     rc;
 388         ENTRY;
 389
 390         rc = class_connect(&conn, obd, cluuid);
 391         if (rc)
 392                 RETURN(rc);
 393
 394         *exp = class_conn2export(&conn);
 395         RETURN(0);
 396 }
 397
 398 /*
 399  * obd_disconnect handler used by the MDT to disconnect from the master target.
 400  * We trigger cleanup on disconnect since it means that the MDT is about to
 401  * shutdown.
 402  */
 403 static int qmt_device_obd_disconnect(struct obd_export *exp)
 404 {
 405         struct obd_device       *obd = exp->exp_obd;
 406         int                      rc;
 407         ENTRY;
 408
 409         rc = class_disconnect(exp);
 410         if (rc)
 411                 RETURN(rc);
 412
 413         rc = class_manual_cleanup(obd);
 414         RETURN(0);
 415 }
 416
 417 /*
 418  * obd device operations associated with the master target.
 419  */
 420 static const struct obd_ops qmt_obd_ops = {
 421         .o_owner        = THIS_MODULE,
 422         .o_connect      = qmt_device_obd_connect,
 423         .o_disconnect   = qmt_device_obd_disconnect,
 424 };
 425
 426 /*
 427  * Called when the MDS is fully configured. We use it to set up local objects
 428  * associated with the quota master target.
 429  *
 430  * \param env - is the environment passed by the caller
 431  * \param parent - is the lu_device of the parent, that's to say the mdt
 432  * \param ld  - is the lu_device associated with the master target
 433  *
 434  * \retval    - 0 on success, appropriate error on failure
 435  */
 436 static int qmt_device_prepare(const struct lu_env *env,
 437                               struct lu_device *parent,
 438                               struct lu_device *ld)
 439 {
 440         struct qmt_device       *qmt = lu2qmt_dev(ld);
 441         struct dt_object        *qmt_root;
 442         int                      rc;
 443         ENTRY;
 444
 445         /* initialize quota master root directory where all index files will be
 446          * stored */
 447         qmt_root = lquota_disk_dir_find_create(env, qmt->qmt_child, NULL,
 448                                                QMT_DIR);
 449         if (IS_ERR(qmt_root)) {
 450                 rc = PTR_ERR(qmt_root);
 451                 CERROR("%s: failed to create master quota directory (%d)\n",
 452                        qmt->qmt_svname, rc);
 453                 RETURN(rc);
 454         }
 455
 456         /* initialize on-disk indexes associated with each pool */
 457         rc = qmt_pool_prepare(env, qmt, qmt_root);
 458
 459         dt_object_put(env, qmt_root);
 460         RETURN(rc);
 461 }
 462
 463 /*
 464  * lu device operations for the quota master target
 465  */
 466 static const struct lu_device_operations qmt_lu_ops = {
 467         .ldo_prepare            = qmt_device_prepare,
 468         .ldo_process_config     = NULL, /* to be defined for dynamic pool
 469                                          * configuration */
 470 };
 471
 472 /* global variable initialization called when the lquota module is loaded */
 473 int qmt_glb_init(void)
 474 {
 475         int rc;
 476         ENTRY;
 477
 478         rc = class_register_type(&qmt_obd_ops, NULL, true, NULL,
 479                                  LUSTRE_QMT_NAME, &qmt_device_type);
 480         RETURN(rc);
 481 }
 482
 483 /* called when the lquota module is about to be unloaded */
 484 void qmt_glb_fini(void)
 485 {
 486         class_unregister_type(LUSTRE_QMT_NAME);
 487 }