lustre/osp/lwp_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) 2013, 2014, Intel Corporation.
  25  * Use is subject to license terms.
  26  *
  27  * lustre/osp/lwp_dev.c
  28  *
  29  * This file provides code related to the Light Weight Proxy (LWP) managing
  30  * the connections established from OST to MDT, and MDT to MDT0.
  31  *
  32  * A LWP connection is used to send quota and FLD query requests. It's not
  33  * recoverable, which means target server doesn't have an on-disk record in
  34  * the last_rcvd file to remember the connection. Once LWP reconnect after
  35  * server reboot, server will always regard it as a new connection.
  36  *
  37  * Author: <di.wang@intel.com>
  38  * Author: <yawei.niu@intel.com>
  39  */
  40 #define DEBUG_SUBSYSTEM S_OST
  41
  42 #include <obd_class.h>
  43 #include <lustre_param.h>
  44 #include <lustre_log.h>
  45
  46 #include "osp_internal.h"
  47
  48 struct lwp_device {
  49         struct lu_device        lpd_dev;
  50         struct obd_device      *lpd_obd;   /* corresponding OBD device */
  51         struct obd_uuid         lpd_cluuid;/* UUID of LWP */
  52         struct obd_export      *lpd_exp;   /* export of LWP */
  53         int                     lpd_connects; /* use count, 0 or 1 */
  54 };
  55
  56 static inline struct lwp_device *lu2lwp_dev(struct lu_device *d)
  57 {
  58         return container_of0(d, struct lwp_device, lpd_dev);
  59 }
  60
  61 static inline struct lu_device *lwp2lu_dev(struct lwp_device *d)
  62 {
  63         return &d->lpd_dev;
  64 }
  65
  66 /**
  67  * Setup LWP device.
  68  *
  69  * \param[in] env       environment passed by caller
  70  * \param[in] lwp       LWP device to be setup
  71  * \param[in] nidstring remote target NID
  72  *
  73  * \retval              0 on success
  74  * \retval              negative number on error
  75  */
  76 static int lwp_setup(const struct lu_env *env, struct lwp_device *lwp,
  77                      char *nidstring)
  78 {
  79         struct lustre_cfg_bufs  *bufs = NULL;
  80         struct lustre_cfg       *lcfg = NULL;
  81         char                    *lwp_name = lwp->lpd_obd->obd_name;
  82         char                    *server_uuid = NULL;
  83         char                    *ptr;
  84         class_uuid_t             uuid;
  85         struct obd_import       *imp;
  86         int                      len = strlen(lwp_name) + 1;
  87         int                      rc;
  88         ENTRY;
  89
  90         OBD_ALLOC_PTR(bufs);
  91         if (bufs == NULL)
  92                 RETURN(-ENOMEM);
  93
  94         OBD_ALLOC(server_uuid, len);
  95         if (server_uuid == NULL)
  96                 GOTO(out, rc = -ENOMEM);
  97
  98         snprintf(server_uuid, len, "-%s-", LUSTRE_LWP_NAME);
  99         ptr = cfs_strrstr(lwp_name, server_uuid);
 100         if (ptr == NULL) {
 101                 CERROR("%s: failed to get server_uuid from lwp_name: rc = %d\n",
 102                        lwp_name, -EINVAL);
 103                 GOTO(out, rc = -EINVAL);
 104         }
 105
 106         strncpy(server_uuid, lwp_name, ptr - lwp_name);
 107         server_uuid[ptr - lwp_name] = '\0';
 108         strlcat(server_uuid, "_UUID", len);
 109         lustre_cfg_bufs_reset(bufs, lwp_name);
 110         lustre_cfg_bufs_set_string(bufs, 1, server_uuid);
 111         lustre_cfg_bufs_set_string(bufs, 2, nidstring);
 112         lcfg = lustre_cfg_new(LCFG_SETUP, bufs);
 113         if (lcfg == NULL)
 114                 GOTO(out, rc = -ENOMEM);
 115
 116         rc = client_obd_setup(lwp->lpd_obd, lcfg);
 117         if (rc != 0) {
 118                 CERROR("%s: client obd setup error: rc = %d\n",
 119                        lwp->lpd_obd->obd_name, rc);
 120                 GOTO(out, rc);
 121         }
 122
 123         imp = lwp->lpd_obd->u.cli.cl_import;
 124         rc = ptlrpc_init_import(imp);
 125         if (rc)
 126                 GOTO(out, rc);
 127
 128         ll_generate_random_uuid(uuid);
 129         class_uuid_unparse(uuid, &lwp->lpd_cluuid);
 130 out:
 131         if (bufs != NULL)
 132                 OBD_FREE_PTR(bufs);
 133         if (server_uuid != NULL)
 134                 OBD_FREE(server_uuid, len);
 135         if (lcfg != NULL)
 136                 lustre_cfg_free(lcfg);
 137         if (rc)
 138                 client_obd_cleanup(lwp->lpd_obd);
 139
 140         RETURN(rc);
 141 }
 142
 143 /**
 144  * Disconnect the import from LWP.
 145  *
 146  * \param[in] d         LWP device to be disconnected
 147  *
 148  * \retval              0 on success
 149  * \retval              negative number on error
 150  */
 151 static int lwp_disconnect(struct lwp_device *d)
 152 {
 153         struct obd_import *imp;
 154         int rc = 0;
 155
 156         imp = d->lpd_obd->u.cli.cl_import;
 157
 158         /*
 159          * Mark import deactivated now, so we don't try to reconnect if any
 160          * of the cleanup RPCs fails (e.g. ldlm cancel, etc).  We don't
 161          * fully deactivate the import because that would cause all requests
 162          * to be dropped.
 163          */
 164         LASSERT(imp != NULL);
 165         spin_lock(&imp->imp_lock);
 166         imp->imp_deactive = 1;
 167         spin_unlock(&imp->imp_lock);
 168
 169         ptlrpc_deactivate_import(imp);
 170
 171         /*
 172          * Some non-replayable imports (MDS's OSCs) are pinged, so just
 173          * delete it regardless.  (It's safe to delete an import that was
 174          * never added.)
 175          */
 176         ptlrpc_pinger_del_import(imp);
 177         rc = ptlrpc_disconnect_import(imp, 0);
 178         if (rc != 0)
 179                 CWARN("%s: can't disconnect: rc = %d\n",
 180                       d->lpd_obd->obd_name, rc);
 181
 182         ptlrpc_invalidate_import(imp);
 183
 184         RETURN(rc);
 185 }
 186
 187 /**
 188  * Implementation of lu_device_operations::ldo_process_config.
 189  *
 190  * Process a Lustre configuration request.
 191  *
 192  * \param[in] env       environment passed by caller
 193  * \param[in] dev       device to be processed
 194  * \param[in] lcfg      lustre_cfg, LCFG_PRE_CLEANUP or LCFG_CLEANUP
 195  *
 196  * \retval              0 on success
 197  * \retval              negative number on error
 198  */
 199 static int lwp_process_config(const struct lu_env *env,
 200                               struct lu_device *dev, struct lustre_cfg *lcfg)
 201 {
 202         struct lwp_device               *d = lu2lwp_dev(dev);
 203         int                              rc;
 204         ENTRY;
 205
 206         switch (lcfg->lcfg_command) {
 207         case LCFG_PRE_CLEANUP:
 208         case LCFG_CLEANUP:
 209                 rc = lwp_disconnect(d);
 210                 break;
 211         case LCFG_PARAM:
 212                 rc = -ENOSYS;
 213                 break;
 214         default:
 215                 CERROR("%s: unknown command %u\n",
 216                        (char *)lustre_cfg_string(lcfg, 0), lcfg->lcfg_command);
 217                 rc = 0;
 218                 break;
 219         }
 220
 221         RETURN(rc);
 222 }
 223
 224 static const struct lu_device_operations lwp_lu_ops = {
 225         .ldo_process_config     = lwp_process_config,
 226 };
 227
 228 /**
 229  * Initialize LWP device.
 230  *
 231  * \param[in] env       environment passed by caller
 232  * \param[in] lwp       device to be initialized
 233  * \param[in] ldt       not used
 234  * \param[in] cfg       lustre_cfg contains remote target uuid
 235  *
 236  * \retval              0 on success
 237  * \retval              -ENODEV if the device name cannot be found
 238  * \retval              negative numbers on other errors
 239  */
 240 static int lwp_init0(const struct lu_env *env, struct lwp_device *lwp,
 241                      struct lu_device_type *ldt, struct lustre_cfg *cfg)
 242 {
 243         int                        rc;
 244         ENTRY;
 245
 246         lwp->lpd_obd = class_name2obd(lustre_cfg_string(cfg, 0));
 247         if (lwp->lpd_obd == NULL) {
 248                 CERROR("Cannot find obd with name %s\n",
 249                        lustre_cfg_string(cfg, 0));
 250                 RETURN(-ENODEV);
 251         }
 252
 253         lwp->lpd_dev.ld_ops = &lwp_lu_ops;
 254         lwp->lpd_obd->obd_lu_dev = &lwp->lpd_dev;
 255
 256         rc = ptlrpcd_addref();
 257         if (rc) {
 258                 CERROR("%s: ptlrpcd addref error: rc =%d\n",
 259                        lwp->lpd_obd->obd_name, rc);
 260                 RETURN(rc);
 261         }
 262
 263         rc = lwp_setup(env, lwp, lustre_cfg_string(cfg, 1));
 264         if (rc) {
 265                 CERROR("%s: setup lwp failed. %d\n",
 266                        lwp->lpd_obd->obd_name, rc);
 267                 ptlrpcd_decref();
 268                 RETURN(rc);
 269         }
 270
 271         if (lprocfs_obd_setup(lwp->lpd_obd) == 0) {
 272                 sptlrpc_lprocfs_cliobd_attach(lwp->lpd_obd);
 273                 ptlrpc_lprocfs_register_obd(lwp->lpd_obd);
 274         }
 275
 276         RETURN(0);
 277 }
 278
 279 /**
 280  * Implementation of lu_device_type_operations::ldto_device_free.
 281  *
 282  * Free a LWP device.
 283  *
 284  * \param[in] env       environment passed by caller
 285  * \param[in] lu        device to be freed
 286  *
 287  * \retval              NULL to indicate that this is the bottom device
 288  *                      of the stack and there are no more devices
 289  *                      below this one to be cleaned up.
 290  */
 291 static struct lu_device *lwp_device_free(const struct lu_env *env,
 292                                          struct lu_device *lu)
 293 {
 294         struct lwp_device *m = lu2lwp_dev(lu);
 295         ENTRY;
 296
 297         if (atomic_read(&lu->ld_ref) && lu->ld_site) {
 298                 LIBCFS_DEBUG_MSG_DATA_DECL(msgdata, D_ERROR, NULL);
 299                 lu_site_print(env, lu->ld_site, &msgdata, lu_cdebug_printer);
 300         }
 301         lu_device_fini(&m->lpd_dev);
 302         OBD_FREE_PTR(m);
 303         RETURN(NULL);
 304 }
 305
 306 /**
 307  * Implementation of lu_device_type_operations::ldto_device_alloc.
 308  *
 309  * Allocate a LWP device.
 310  *
 311  * \param[in] env       environment passed by caller
 312  * \param[in] ldt       device type whose name is LUSTRE_LWP_NAME
 313  * \param[in] lcfg      lustre_cfg contains remote target UUID
 314  *
 315  * \retval              pointer of allocated LWP device on success
 316  * \retval              ERR_PTR(errno) on error
 317  */
 318 static struct lu_device *lwp_device_alloc(const struct lu_env *env,
 319                                           struct lu_device_type *ldt,
 320                                           struct lustre_cfg *lcfg)
 321 {
 322         struct lwp_device *lwp;
 323         struct lu_device  *ludev;
 324
 325         OBD_ALLOC_PTR(lwp);
 326         if (lwp == NULL) {
 327                 ludev = ERR_PTR(-ENOMEM);
 328         } else {
 329                 int rc;
 330
 331                 ludev = lwp2lu_dev(lwp);
 332                 lu_device_init(&lwp->lpd_dev, ldt);
 333                 rc = lwp_init0(env, lwp, ldt, lcfg);
 334                 if (rc != 0) {
 335                         lwp_device_free(env, ludev);
 336                         ludev = ERR_PTR(rc);
 337                 }
 338         }
 339         return ludev;
 340 }
 341
 342
 343 /**
 344  * Implementation of lu_device_type_operations::ltdo_device_fini.
 345  *
 346  * Finalize LWP device.
 347  *
 348  * \param[in] env       environment passed by caller
 349  * \param[in] ludev     device to be finalized
 350  *
 351  * \retval              NULL on success
 352  */
 353 static struct lu_device *lwp_device_fini(const struct lu_env *env,
 354                                          struct lu_device *ludev)
 355 {
 356         struct lwp_device *m = lu2lwp_dev(ludev);
 357         struct obd_import *imp;
 358         int                rc;
 359         ENTRY;
 360
 361         if (m->lpd_exp != NULL)
 362                 class_disconnect(m->lpd_exp);
 363
 364         imp = m->lpd_obd->u.cli.cl_import;
 365
 366         LASSERT(m->lpd_obd);
 367         ptlrpc_lprocfs_unregister_obd(m->lpd_obd);
 368         lprocfs_obd_cleanup(m->lpd_obd);
 369
 370         rc = client_obd_cleanup(m->lpd_obd);
 371         LASSERTF(rc == 0, "error %d\n", rc);
 372
 373         ptlrpcd_decref();
 374
 375         RETURN(NULL);
 376 }
 377
 378 static struct lu_device_type_operations lwp_device_type_ops = {
 379         .ldto_device_alloc   = lwp_device_alloc,
 380         .ldto_device_free    = lwp_device_free,
 381         .ldto_device_fini    = lwp_device_fini
 382 };
 383
 384 struct lu_device_type lwp_device_type = {
 385         .ldt_tags     = LU_DEVICE_DT,
 386         .ldt_name     = LUSTRE_LWP_NAME,
 387         .ldt_ops      = &lwp_device_type_ops,
 388         .ldt_ctx_tags = LCT_MD_THREAD
 389 };
 390
 391 /**
 392  * Implementation of OBD device operations obd_ops::o_connect.
 393  *
 394  * Create export for LWP, and connect to target server.
 395  *
 396  * \param[in] env       the environment passed by caller
 397  * \param[out] exp      export for the connection to be established
 398  * \param[in] obd       OBD device to perform the connect on
 399  * \param[in] cluuid    UUID of the OBD device
 400  * \param[in] data      connect data containing compatibility flags
 401  * \param[in] localdata not used
 402  *
 403  * \retval              0 on success
 404  * \retval              negative number on error
 405  */
 406 static int lwp_obd_connect(const struct lu_env *env, struct obd_export **exp,
 407                            struct obd_device *obd, struct obd_uuid *cluuid,
 408                            struct obd_connect_data *data, void *localdata)
 409 {
 410         struct lwp_device       *lwp = lu2lwp_dev(obd->obd_lu_dev);
 411         struct client_obd       *cli = &lwp->lpd_obd->u.cli;
 412         struct obd_import       *imp = cli->cl_import;
 413         struct obd_connect_data *ocd;
 414         struct lustre_handle     conn;
 415         int                      rc;
 416
 417         ENTRY;
 418
 419         CDEBUG(D_CONFIG, "connect #%d\n", lwp->lpd_connects);
 420
 421         *exp = NULL;
 422         down_write(&cli->cl_sem);
 423         rc = class_connect(&conn, obd, cluuid);
 424         if (rc != 0)
 425                 GOTO(out_sem, rc);
 426
 427         *exp = class_conn2export(&conn);
 428         lwp->lpd_exp = *exp;
 429
 430         lwp->lpd_connects++;
 431         LASSERT(lwp->lpd_connects == 1);
 432
 433         imp->imp_dlm_handle = conn;
 434         rc = ptlrpc_init_import(imp);
 435         if (rc != 0)
 436                 GOTO(out_dis, rc);
 437
 438         LASSERT(data != NULL);
 439         ocd = &imp->imp_connect_data;
 440         *ocd = *data;
 441
 442         LASSERT(ocd->ocd_connect_flags & OBD_CONNECT_LIGHTWEIGHT);
 443
 444         ocd->ocd_version = LUSTRE_VERSION_CODE;
 445         imp->imp_connect_flags_orig = ocd->ocd_connect_flags;
 446
 447         rc = ptlrpc_connect_import(imp);
 448         if (rc != 0) {
 449                 CERROR("%s: can't connect obd: rc = %d\n", obd->obd_name, rc);
 450                 GOTO(out_dis, rc);
 451         }
 452
 453         ptlrpc_pinger_add_import(imp);
 454
 455         GOTO(out_dis, rc = 0);
 456
 457 out_dis:
 458         if (rc != 0) {
 459                 class_disconnect(*exp);
 460                 *exp = NULL;
 461                 lwp->lpd_exp = NULL;
 462         }
 463
 464 out_sem:
 465         up_write(&cli->cl_sem);
 466
 467         return rc;
 468 }
 469
 470 /**
 471  * Implementation of OBD device operations obd_ops::o_disconnect.
 472  *
 473  * Release export for the LWP. Only disconnect the underlying layers
 474  * on the final disconnect.
 475  *
 476  * \param[in] exp       the export to perform disconnect on
 477  *
 478  * \retval              0 on success
 479  * \retval              negative number on error
 480  */
 481 static int lwp_obd_disconnect(struct obd_export *exp)
 482 {
 483         struct obd_device *obd = exp->exp_obd;
 484         struct lwp_device *lwp = lu2lwp_dev(obd->obd_lu_dev);
 485         int                rc;
 486         ENTRY;
 487
 488         LASSERT(lwp->lpd_connects == 1);
 489         lwp->lpd_connects--;
 490
 491         rc = class_disconnect(exp);
 492         if (rc)
 493                 CERROR("%s: class disconnect error: rc = %d\n",
 494                        obd->obd_name, rc);
 495
 496         RETURN(rc);
 497 }
 498
 499 /**
 500  * Handle import events for the LWP device.
 501  *
 502  * \param[in] obd       OBD device associated with the import
 503  * \param[in] imp       the import which event happened on
 504  * \param[in] event     event type
 505  *
 506  * \retval              0 on success
 507  * \retval              negative number on error
 508  */
 509 static int lwp_import_event(struct obd_device *obd, struct obd_import *imp,
 510                             enum obd_import_event event)
 511 {
 512         switch (event) {
 513         case IMP_EVENT_DISCON:
 514         case IMP_EVENT_INACTIVE:
 515         case IMP_EVENT_ACTIVE:
 516                 break;
 517         case IMP_EVENT_INVALIDATE:
 518                 if (obd->obd_namespace == NULL)
 519                         break;
 520                 ldlm_namespace_cleanup(obd->obd_namespace, LDLM_FL_LOCAL_ONLY);
 521                 break;
 522         case IMP_EVENT_OCD:
 523                 break;
 524         default:
 525                 CERROR("%s: unsupported import event: %#x\n",
 526                        obd->obd_name, event);
 527         }
 528         return 0;
 529 }
 530
 531 struct obd_ops lwp_obd_device_ops = {
 532         .o_owner        = THIS_MODULE,
 533         .o_add_conn     = client_import_add_conn,
 534         .o_del_conn     = client_import_del_conn,
 535         .o_connect      = lwp_obd_connect,
 536         .o_disconnect   = lwp_obd_disconnect,
 537         .o_import_event = lwp_import_event,
 538 };