lustre/mdd/mdd_orphans.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, see
  18  * http://www.gnu.org/licenses/gpl-2.0.html
  19  *
  20  * GPL HEADER END
  21  */
  22 /*
  23  * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
  24  * Use is subject to license terms.
  25  *
  26  * Copyright (c) 2011, 2017, Intel Corporation.
  27  */
  28 /*
  29  * This file is part of Lustre, http://www.lustre.org/
  30  *
  31  * lustre/mdd/mdd_orphans.c
  32  *
  33  * Orphan handling code
  34  *
  35  * Author: Mike Pershin <tappro@clusterfs.com>
  36  *         Pravin B Shelar <pravin.shelar@sun.com>
  37  */
  38
  39 #define DEBUG_SUBSYSTEM S_MDS
  40
  41 #include <obd.h>
  42 #include <obd_class.h>
  43 #include <obd_support.h>
  44 #include <lustre_fid.h>
  45 #include "mdd_internal.h"
  46
  47 static const char mdd_orphan_index_name[] = MDT_ORPHAN_DIR;
  48 static const char dotdot[] = "..";
  49
  50 enum {
  51         ORPH_OP_UNLINK,
  52 };
  53
  54 /* obsolete after 2.11, needed for upgrades from older 2.x versions */
  55 #define ORPHAN_FILE_NAME_FORMAT_20      "%016llx:%08x:%08x:%2x"
  56
  57 static struct dt_key *mdd_orphan_key_fill(const struct lu_env *env,
  58                                           const struct lu_fid *lf)
  59 {
  60         char *key = mdd_env_info(env)->mdi_key;
  61
  62         LASSERT(key);
  63         if (!(MDI_KEEP_KEY & mdd_env_info(env)->mdi_flags))
  64                 snprintf(key, sizeof(mdd_env_info(env)->mdi_key),
  65                          DFID_NOBRACE, PFID(lf));
  66
  67         return (struct dt_key *)key;
  68 }
  69
  70 /* compatibility with orphan files created in versions before 2.11 */
  71 static struct dt_key *mdd_orphan_key_fill_20(const struct lu_env *env,
  72                                              const struct lu_fid *lf)
  73 {
  74         char *key = mdd_env_info(env)->mdi_key;
  75
  76         LASSERT(key);
  77         if (!(MDI_KEEP_KEY & mdd_env_info(env)->mdi_flags))
  78                 snprintf(key, sizeof(mdd_env_info(env)->mdi_key),
  79                          ORPHAN_FILE_NAME_FORMAT_20,
  80                          fid_seq(lf), fid_oid(lf), fid_ver(lf),
  81                          ORPH_OP_UNLINK);
  82
  83         return (struct dt_key *)key;
  84 }
  85
  86 static inline int mdd_orphan_insert_obj(const struct lu_env *env,
  87                                         struct mdd_device *mdd,
  88                                         struct mdd_object *obj,
  89                                         struct thandle *th)
  90 {
  91         struct dt_insert_rec *rec = &mdd_env_info(env)->mdi_dt_rec;
  92         struct dt_object *dor = mdd->mdd_orphans;
  93         const struct lu_fid *lf = mdd_object_fid(obj);
  94         struct dt_key *key = mdd_orphan_key_fill(env, lf);
  95
  96         rec->rec_fid = lf;
  97         rec->rec_type = mdd_object_type(obj);
  98
  99         return dt_insert(env, dor, (const struct dt_rec *)rec, key, th);
 100 }
 101
 102 int mdd_orphan_declare_insert(const struct lu_env *env, struct mdd_object *obj,
 103                               umode_t mode, struct thandle *th)
 104 {
 105         struct dt_insert_rec *rec = &mdd_env_info(env)->mdi_dt_rec;
 106         struct mdd_device *mdd = mdo2mdd(&obj->mod_obj);
 107         struct dt_key *key;
 108         int rc;
 109
 110         key = mdd_orphan_key_fill(env, mdd_object_fid(obj));
 111
 112         rec->rec_fid = mdd_object_fid(obj);
 113         rec->rec_type = mode;
 114         rc = dt_declare_insert(env, mdd->mdd_orphans,
 115                                (const struct dt_rec *)rec, key, th);
 116         if (rc != 0)
 117                 return rc;
 118
 119         rc = mdo_declare_ref_add(env, obj, th);
 120         if (rc)
 121                 return rc;
 122
 123         if (!S_ISDIR(mode))
 124                 return 0;
 125
 126         rc = mdo_declare_ref_add(env, obj, th);
 127         if (rc)
 128                 return rc;
 129
 130         rc = dt_declare_ref_add(env, mdd->mdd_orphans, th);
 131         if (rc)
 132                 return rc;
 133
 134         rc = mdo_declare_index_delete(env, obj, dotdot, th);
 135         if (rc)
 136                 return rc;
 137
 138         rc = mdo_declare_index_insert(env, obj,
 139                                       lu_object_fid(&mdd->mdd_orphans->do_lu),
 140                                       S_IFDIR, dotdot, th);
 141
 142         return rc;
 143 }
 144
 145 /**
 146  *  add an orphan \a obj to the orphan index.
 147  *  \param obj file or directory.
 148  *  \param th  transaction for index insert.
 149  *
 150  *  \pre obj nlink == 0 && obj->mod_count != 0
 151  *
 152  *  \retval 0  success
 153  *  \retval  -ve index operation error.
 154  */
 155 int mdd_orphan_insert(const struct lu_env *env, struct mdd_object *obj,
 156                       struct thandle *th)
 157 {
 158         struct mdd_device *mdd = mdo2mdd(&obj->mod_obj);
 159         struct dt_object *dor = mdd->mdd_orphans;
 160         const struct lu_fid *lf_dor = lu_object_fid(&dor->do_lu);
 161         struct dt_object *next = mdd_object_child(obj);
 162         struct dt_insert_rec *rec = &mdd_env_info(env)->mdi_dt_rec;
 163         int rc;
 164         ENTRY;
 165
 166         LASSERT(mdd_write_locked(env, obj) != 0);
 167         LASSERT(!(obj->mod_flags & ORPHAN_OBJ));
 168
 169         dt_write_lock(env, mdd->mdd_orphans, DT_TGT_ORPHAN);
 170
 171         rc = mdd_orphan_insert_obj(env, mdd, obj, th);
 172         if (rc)
 173                 GOTO(out, rc);
 174
 175         mdo_ref_add(env, obj, th);
 176
 177         if (!S_ISDIR(mdd_object_type(obj)))
 178                 GOTO(out, rc = 0);
 179
 180         mdo_ref_add(env, obj, th);
 181         dt_ref_add(env, mdd->mdd_orphans, th);
 182
 183         /* try best to fixup directory, do not return errors from here */
 184         if (!dt_try_as_dir(env, next, true))
 185                 GOTO(out, rc = 0);
 186
 187         dt_delete(env, next, (const struct dt_key *)dotdot, th);
 188
 189         rec->rec_fid = lf_dor;
 190         rec->rec_type = S_IFDIR;
 191         dt_insert(env, next, (const struct dt_rec *)rec,
 192                   (const struct dt_key *)dotdot, th);
 193
 194 out:
 195         if (rc == 0)
 196                 obj->mod_flags |= ORPHAN_OBJ;
 197
 198         dt_write_unlock(env, mdd->mdd_orphans);
 199
 200         RETURN(rc);
 201 }
 202
 203 int mdd_orphan_declare_delete(const struct lu_env *env, struct mdd_object *obj,
 204                               struct thandle *th)
 205 {
 206         struct mdd_device *mdd = mdo2mdd(&obj->mod_obj);
 207         struct dt_key *key;
 208         int rc;
 209
 210         key = mdd_orphan_key_fill(env, mdd_object_fid(obj));
 211
 212         rc = dt_declare_delete(env, mdd->mdd_orphans, key, th);
 213         if (rc)
 214                 return rc;
 215
 216         if (!mdd_object_exists(obj))
 217                 return -ENOENT;
 218
 219         rc = mdo_declare_ref_del(env, obj, th);
 220         if (rc)
 221                 return rc;
 222
 223         if (S_ISDIR(mdd_object_type(obj))) {
 224                 rc = mdo_declare_ref_del(env, obj, th);
 225                 if (rc)
 226                         return rc;
 227
 228                 rc = dt_declare_ref_del(env, mdd->mdd_orphans, th);
 229         }
 230
 231         return rc;
 232 }
 233
 234 /**
 235  *  delete an orphan \a obj from orphan index.
 236  *  \param obj file or directory.
 237  *  \param th  transaction for index deletion and object destruction.
 238  *
 239  *  \pre obj->mod_count == 0 && ORPHAN_OBJ is set for obj.
 240  *
 241  *  \retval 0  success
 242  *  \retval  -ve index operation error.
 243  */
 244 int mdd_orphan_delete(const struct lu_env *env, struct mdd_object *obj,
 245                       struct thandle *th)
 246 {
 247         struct mdd_device *mdd = mdo2mdd(&obj->mod_obj);
 248         struct dt_object *dor = mdd->mdd_orphans;
 249         struct dt_key *key;
 250         int rc = 0;
 251
 252         ENTRY;
 253
 254         LASSERT(mdd_write_locked(env, obj) != 0);
 255         LASSERT(obj->mod_flags & ORPHAN_OBJ);
 256         LASSERT(obj->mod_count == 0);
 257
 258         LASSERT(dor);
 259
 260         key = mdd_orphan_key_fill(env, mdd_object_fid(obj));
 261         dt_write_lock(env, mdd->mdd_orphans, DT_TGT_ORPHAN);
 262
 263         if (CFS_FAIL_CHECK(OBD_FAIL_MDS_ORPHAN_DELETE))
 264                 goto ref_del;
 265
 266         rc = dt_delete(env, mdd->mdd_orphans, key, th);
 267         if (rc == -ENOENT) {
 268                 key = mdd_orphan_key_fill_20(env, mdd_object_fid(obj));
 269                 rc = dt_delete(env, mdd->mdd_orphans, key, th);
 270         }
 271
 272 ref_del:
 273         if (!rc) {
 274                 /* lov objects will be destroyed by caller */
 275                 mdo_ref_del(env, obj, th);
 276                 if (S_ISDIR(mdd_object_type(obj))) {
 277                         mdo_ref_del(env, obj, th);
 278                         dt_ref_del(env, mdd->mdd_orphans, th);
 279                 }
 280                 obj->mod_flags &= ~ORPHAN_OBJ;
 281         } else {
 282                 CERROR("%s: could not delete orphan object "DFID": rc = %d\n",
 283                        mdd_obj_dev_name(obj), PFID(mdd_object_fid(obj)), rc);
 284         }
 285
 286         dt_write_unlock(env, mdd->mdd_orphans);
 287         RETURN(rc);
 288 }
 289
 290
 291 static int mdd_orphan_destroy(const struct lu_env *env, struct mdd_object *obj,
 292                               struct dt_key *key)
 293 {
 294         struct thandle *th = NULL;
 295         struct mdd_device *mdd = mdo2mdd(&obj->mod_obj);
 296         int rc = 0, rc1 = 0;
 297         ENTRY;
 298
 299         th = mdd_trans_create(env, mdd);
 300         if (IS_ERR(th)) {
 301                 rc = PTR_ERR(th);
 302                 if (rc != -EINPROGRESS)
 303                         CERROR("%s: cannot get orphan thandle: rc = %d\n",
 304                                mdd2obd_dev(mdd)->obd_name, rc);
 305                 RETURN(rc);
 306         }
 307
 308         rc = mdd_orphan_declare_delete(env, obj, th);
 309         if (rc && rc != -ENOENT)
 310                 GOTO(stop, rc);
 311
 312         if (rc != -ENOENT) {
 313                 rc = mdo_declare_destroy(env, obj, th);
 314                 if (rc && rc != -ENOENT)
 315                         GOTO(stop, rc);
 316         }
 317
 318         rc = mdd_trans_start(env, mdd, th);
 319         if (rc)
 320                 GOTO(stop, rc);
 321
 322         mdd_write_lock(env, obj, DT_TGT_CHILD);
 323         if (likely(obj->mod_count == 0)) {
 324                 dt_write_lock(env, mdd->mdd_orphans, DT_TGT_ORPHAN);
 325                 rc = dt_delete(env, mdd->mdd_orphans, key, th);
 326                 /* We should remove object even dt_delete failed */
 327                 if (mdd_object_exists(obj) &&
 328                     !lu_object_is_dying(obj->mod_obj.mo_lu.lo_header)) {
 329                         mdo_ref_del(env, obj, th);
 330                         if (S_ISDIR(mdd_object_type(obj))) {
 331                                 mdo_ref_del(env, obj, th);
 332                                 dt_ref_del(env, mdd->mdd_orphans, th);
 333                         }
 334                         rc1 = mdo_destroy(env, obj, th);
 335                 }
 336                 dt_write_unlock(env, mdd->mdd_orphans);
 337         }
 338         mdd_write_unlock(env, obj);
 339 stop:
 340         mdd_trans_stop(env, mdd, 0, th);
 341
 342         RETURN(rc ? rc : rc1);
 343 }
 344
 345 /**
 346  * Delete unused orphan with FID \a lf from PENDING directory
 347  *
 348  * \param mdd  MDD device finishing recovery
 349  * \param lf   FID of file or directory to delete
 350  * \param key  cookie for this entry in index iterator
 351  *
 352  * \retval 0   success
 353  * \retval -ve error
 354  */
 355 static int mdd_orphan_key_test_and_delete(const struct lu_env *env,
 356                                           struct mdd_device *mdd,
 357                                           struct lu_fid *lf, struct dt_key *key)
 358 {
 359         struct mdd_object *mdo;
 360         int rc;
 361
 362         mdo = mdd_object_find(env, mdd, lf);
 363
 364         if (IS_ERR(mdo))
 365                 return PTR_ERR(mdo);
 366
 367         rc = -EBUSY;
 368         if (mdo->mod_count == 0) {
 369                 CDEBUG(D_HA, "Found orphan "DFID", delete it\n", PFID(lf));
 370                 rc = mdd_orphan_destroy(env, mdo, key);
 371                 if (rc) /* below message checked in replay-single.sh test_37 */
 372                         CERROR("%s: error unlinking orphan "DFID": rc = %d\n",
 373                                mdd2obd_dev(mdd)->obd_name, PFID(lf), rc);
 374         } else {
 375                 mdd_write_lock(env, mdo, DT_TGT_CHILD);
 376                 if (likely(mdo->mod_count > 0)) {
 377                         CDEBUG(D_HA, "Found orphan "DFID" count %d, skip it\n",
 378                                PFID(lf), mdo->mod_count);
 379                         mdo->mod_flags |= ORPHAN_OBJ;
 380                 }
 381                 mdd_write_unlock(env, mdo);
 382         }
 383
 384         mdd_object_put(env, mdo);
 385         return rc;
 386 }
 387
 388 /**
 389  * delete unreferenced files and directories in the PENDING directory
 390  *
 391  * Files that remain in PENDING after client->MDS recovery has completed
 392  * have to be referenced (opened) by some client during recovery, or they
 393  * will be deleted here (for clients that did not complete recovery).
 394  *
 395  * \param thread  info about orphan cleanup thread
 396  *
 397  * \retval 0   success
 398  * \retval -ve error
 399  */
 400 static int mdd_orphan_index_iterate(const struct lu_env *env,
 401                                     struct mdd_generic_thread *thread)
 402 {
 403         struct mdd_device *mdd = (struct mdd_device *)thread->mgt_data;
 404         struct dt_object *dor = mdd->mdd_orphans;
 405         struct lu_dirent *ent = &mdd_env_info(env)->mdi_ent;
 406         const struct dt_it_ops *iops;
 407         struct dt_it *it;
 408         struct lu_fid fid;
 409         int key_sz = 0;
 410         int rc;
 411         ENTRY;
 412
 413         iops = &dor->do_index_ops->dio_it;
 414         it = iops->init(env, dor, LUDA_64BITHASH);
 415         if (IS_ERR(it)) {
 416                 rc = PTR_ERR(it);
 417                 CERROR("%s: cannot clean '%s': rc = %d\n",
 418                        mdd2obd_dev(mdd)->obd_name, mdd_orphan_index_name, rc);
 419                 GOTO(out, rc);
 420         }
 421
 422         rc = iops->load(env, it, 0);
 423         if (rc < 0)
 424                 GOTO(out_put, rc);
 425         if (rc == 0) {
 426                 CERROR("%s: error loading iterator to clean '%s'\n",
 427                        mdd2obd_dev(mdd)->obd_name, mdd_orphan_index_name);
 428                 /* Index contains no zero key? */
 429                 GOTO(out_put, rc = -EIO);
 430         }
 431
 432         mdd_env_info(env)->mdi_flags |= MDI_KEEP_KEY;
 433         do {
 434                 if (thread->mgt_abort)
 435                         break;
 436
 437                 key_sz = iops->key_size(env, it);
 438                 /* filter out "." and ".." entries from PENDING dir. */
 439                 if (key_sz < 8)
 440                         goto next;
 441
 442                 rc = iops->rec(env, it, (struct dt_rec *)ent, LUDA_64BITHASH);
 443                 if (rc != 0) {
 444                         CERROR("%s: fail to get FID for orphan it: rc = %d\n",
 445                                mdd2obd_dev(mdd)->obd_name, rc);
 446                         goto next;
 447                 }
 448
 449                 fid_le_to_cpu(&fid, &ent->lde_fid);
 450                 if (!fid_is_sane(&fid)) {
 451                         CERROR("%s: bad FID "DFID" cleaning '%s'\n",
 452                                mdd2obd_dev(mdd)->obd_name, PFID(&fid),
 453                                mdd_orphan_index_name);
 454                         goto next;
 455                 }
 456
 457                 /* kill orphan object */
 458                 iops->put(env, it);
 459                 rc = mdd_orphan_key_test_and_delete(env, mdd, &fid,
 460                                                 (struct dt_key *)ent->lde_name);
 461                 /* after index delete reset iterator */
 462                 if (rc == 0)
 463                         rc = iops->get(env, it, (const void *)"");
 464 next:
 465                 rc = iops->next(env, it);
 466         } while (rc == 0);
 467
 468         GOTO(out_put, rc = 0);
 469 out_put:
 470         iops->put(env, it);
 471         iops->fini(env, it);
 472
 473 out:
 474         return rc;
 475 }
 476
 477 /**
 478  * open the PENDING directory for device \a mdd
 479  *
 480  * The PENDING directory persistently tracks files and directories that were
 481  * unlinked from the namespace (nlink == 0) but are still held open by clients.
 482  * Those inodes shouldn't be deleted if the MDS crashes, because the clients
 483  * would not be able to recover and reopen those files.  Instead, these inodes
 484  * are linked into the PENDING directory on disk, and only deleted if all
 485  * clients close them, or the MDS finishes client recovery without any client
 486  * reopening them (i.e. former clients didn't join recovery).
 487  *  \param d   mdd device being started.
 488  *
 489  *  \retval 0  success
 490  *  \retval  -ve index operation error.
 491  *
 492  */
 493 int mdd_orphan_index_init(const struct lu_env *env, struct mdd_device *mdd)
 494 {
 495         struct lu_fid fid;
 496         struct dt_object *d;
 497         int rc = 0;
 498
 499         ENTRY;
 500
 501         /* create PENDING dir */
 502         fid_zero(&fid);
 503         rc = mdd_local_file_create(env, mdd, &mdd->mdd_local_root_fid,
 504                                    mdd_orphan_index_name, S_IFDIR | S_IRUGO |
 505                                    S_IWUSR | S_IXUGO, &fid);
 506         if (rc < 0)
 507                 RETURN(rc);
 508
 509         d = dt_locate(env, mdd->mdd_child, &fid);
 510         if (IS_ERR(d))
 511                 RETURN(PTR_ERR(d));
 512         LASSERT(lu_object_exists(&d->do_lu));
 513         if (!dt_try_as_dir(env, d, true)) {
 514                 CERROR("%s: orphan dir '%s' is not an index: rc = %d\n",
 515                        mdd2obd_dev(mdd)->obd_name, mdd_orphan_index_name, rc);
 516                 dt_object_put(env, d);
 517                 RETURN(-ENOTDIR);
 518         }
 519         mdd->mdd_orphans = d;
 520         RETURN(0);
 521 }
 522
 523 void mdd_orphan_index_fini(const struct lu_env *env, struct mdd_device *mdd)
 524 {
 525         ENTRY;
 526         if (mdd->mdd_orphans != NULL) {
 527                 dt_object_put(env, mdd->mdd_orphans);
 528                 mdd->mdd_orphans = NULL;
 529         }
 530         EXIT;
 531 }
 532
 533 static int mdd_orphan_cleanup_thread(void *args)
 534 {
 535         struct mdd_generic_thread *thread = (struct mdd_generic_thread *)args;
 536         struct lu_env *env = NULL;
 537         int rc;
 538         ENTRY;
 539
 540         complete(&thread->mgt_started);
 541
 542         OBD_ALLOC_PTR(env);
 543         if (env == NULL)
 544                 GOTO(out, rc = -ENOMEM);
 545
 546         rc = lu_env_init(env, LCT_MD_THREAD);
 547         if (rc)
 548                 GOTO(out, rc);
 549
 550         rc = mdd_orphan_index_iterate(env, thread);
 551
 552         lu_env_fini(env);
 553         GOTO(out, rc);
 554 out:
 555         if (env)
 556                 OBD_FREE_PTR(env);
 557         complete(&thread->mgt_finished);
 558         return rc;
 559 }
 560
 561 /**
 562  *  Iterate orphan index to cleanup orphan objects after recovery is done.
 563  *  \param d   mdd device in recovery.
 564  */
 565 int mdd_orphan_cleanup(const struct lu_env *env, struct mdd_device *d)
 566 {
 567         int rc = -ENOMEM;
 568         char *name = NULL;
 569
 570         OBD_ALLOC(name, MTI_NAME_MAXLEN);
 571         if (name == NULL)
 572                 goto out;
 573
 574         snprintf(name, MTI_NAME_MAXLEN, "orph_%s", mdd2obd_dev(d)->obd_name);
 575
 576         rc = mdd_generic_thread_start(&d->mdd_orphan_cleanup_thread,
 577                                       mdd_orphan_cleanup_thread, d, name);
 578 out:
 579         if (rc)
 580                 CERROR("%s: start orphan cleanup thread failed: rc = %d\n",
 581                        mdd2obd_dev(d)->obd_name, rc);
 582         if (name)
 583                 OBD_FREE(name, MTI_NAME_MAXLEN);
 584
 585         return rc;
 586 }