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)->mti_key;
  61
  62         LASSERT(key);
  63         if (!(MTI_KEEP_KEY & mdd_env_info(env)->mti_flags))
  64                 snprintf(key, sizeof(mdd_env_info(env)->mti_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)->mti_key;
  75
  76         LASSERT(key);
  77         if (!(MTI_KEEP_KEY & mdd_env_info(env)->mti_flags))
  78                 snprintf(key, sizeof(mdd_env_info(env)->mti_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)->mti_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)->mti_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)->mti_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         if (!S_ISDIR(mdd_object_type(obj)))
 177                 GOTO(out, rc = 0);
 178
 179         mdo_ref_add(env, obj, th);
 180         dt_ref_add(env, mdd->mdd_orphans, th);
 181
 182         /* try best to fixup directory, do not return errors from here */
 183         if (!dt_try_as_dir(env, next))
 184                 GOTO(out, rc = 0);
 185
 186         dt_delete(env, next, (const struct dt_key *)dotdot, th);
 187
 188         rec->rec_fid = lf_dor;
 189         rec->rec_type = S_IFDIR;
 190         dt_insert(env, next, (const struct dt_rec *)rec,
 191                   (const struct dt_key *)dotdot, th);
 192
 193 out:
 194         if (rc == 0)
 195                 obj->mod_flags |= ORPHAN_OBJ;
 196
 197         dt_write_unlock(env, mdd->mdd_orphans);
 198
 199         RETURN(rc);
 200 }
 201
 202 int mdd_orphan_declare_delete(const struct lu_env *env, struct mdd_object *obj,
 203                               struct thandle *th)
 204 {
 205         struct mdd_device *mdd = mdo2mdd(&obj->mod_obj);
 206         struct dt_key *key;
 207         int rc;
 208
 209         key = mdd_orphan_key_fill(env, mdd_object_fid(obj));
 210
 211         rc = dt_declare_delete(env, mdd->mdd_orphans, key, th);
 212         if (rc)
 213                 return rc;
 214
 215         if (!mdd_object_exists(obj))
 216                 return -ENOENT;
 217
 218         rc = mdo_declare_ref_del(env, obj, th);
 219         if (rc)
 220                 return rc;
 221
 222         if (S_ISDIR(mdd_object_type(obj))) {
 223                 rc = mdo_declare_ref_del(env, obj, th);
 224                 if (rc)
 225                         return rc;
 226
 227                 rc = dt_declare_ref_del(env, mdd->mdd_orphans, th);
 228         }
 229
 230         return rc;
 231 }
 232
 233 /**
 234  *  delete an orphan \a obj from orphan index.
 235  *  \param obj file or directory.
 236  *  \param th  transaction for index deletion and object destruction.
 237  *
 238  *  \pre obj->mod_count == 0 && ORPHAN_OBJ is set for obj.
 239  *
 240  *  \retval 0  success
 241  *  \retval  -ve index operation error.
 242  */
 243 int mdd_orphan_delete(const struct lu_env *env, struct mdd_object *obj,
 244                       struct thandle *th)
 245 {
 246         struct mdd_device *mdd = mdo2mdd(&obj->mod_obj);
 247         struct dt_object *dor = mdd->mdd_orphans;
 248         struct dt_key *key;
 249         int rc = 0;
 250
 251         ENTRY;
 252
 253         LASSERT(mdd_write_locked(env, obj) != 0);
 254         LASSERT(obj->mod_flags & ORPHAN_OBJ);
 255         LASSERT(obj->mod_count == 0);
 256
 257         LASSERT(dor);
 258
 259         key = mdd_orphan_key_fill(env, mdd_object_fid(obj));
 260         dt_write_lock(env, mdd->mdd_orphans, DT_TGT_ORPHAN);
 261
 262         if (OBD_FAIL_CHECK(OBD_FAIL_MDS_ORPHAN_DELETE))
 263                 goto ref_del;
 264
 265         rc = dt_delete(env, mdd->mdd_orphans, key, th);
 266         if (rc == -ENOENT) {
 267                 key = mdd_orphan_key_fill_20(env, mdd_object_fid(obj));
 268                 rc = dt_delete(env, mdd->mdd_orphans, key, th);
 269         }
 270
 271 ref_del:
 272         if (!rc) {
 273                 /* lov objects will be destroyed by caller */
 274                 mdo_ref_del(env, obj, th);
 275                 if (S_ISDIR(mdd_object_type(obj))) {
 276                         mdo_ref_del(env, obj, th);
 277                         dt_ref_del(env, mdd->mdd_orphans, th);
 278                 }
 279                 obj->mod_flags &= ~ORPHAN_OBJ;
 280         } else {
 281                 CERROR("%s: could not delete orphan object "DFID": rc = %d\n",
 282                        mdd_obj_dev_name(obj), PFID(mdd_object_fid(obj)), rc);
 283         }
 284
 285         dt_write_unlock(env, mdd->mdd_orphans);
 286         RETURN(rc);
 287 }
 288
 289
 290 static int mdd_orphan_destroy(const struct lu_env *env, struct mdd_object *obj,
 291                               struct dt_key *key)
 292 {
 293         struct thandle *th = NULL;
 294         struct mdd_device *mdd = mdo2mdd(&obj->mod_obj);
 295         bool orphan_exists = true;
 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         mdd_write_lock(env, obj, DT_TGT_CHILD);
 309         rc = mdd_orphan_declare_delete(env, obj, th);
 310         if (rc == -ENOENT || lu_object_is_dying(obj->mod_obj.mo_lu.lo_header))
 311                 orphan_exists = false;
 312         else if (rc)
 313                 GOTO(unlock, rc);
 314
 315         if (orphan_exists) {
 316                 rc = mdo_declare_destroy(env, obj, th);
 317                 if (rc)
 318                         GOTO(unlock, rc);
 319         }
 320
 321         rc = mdd_trans_start(env, mdd, th);
 322         if (rc)
 323                 GOTO(unlock, rc);
 324
 325         if (likely(obj->mod_count == 0)) {
 326                 dt_write_lock(env, mdd->mdd_orphans, DT_TGT_ORPHAN);
 327                 rc = dt_delete(env, mdd->mdd_orphans, key, th);
 328                 /* We should remove object even dt_delete failed */
 329                 if (orphan_exists) {
 330                         mdo_ref_del(env, obj, th);
 331                         if (S_ISDIR(mdd_object_type(obj))) {
 332                                 mdo_ref_del(env, obj, th);
 333                                 dt_ref_del(env, mdd->mdd_orphans, th);
 334                         }
 335                         rc1 = mdo_destroy(env, obj, th);
 336                 }
 337                 dt_write_unlock(env, mdd->mdd_orphans);
 338         }
 339 unlock:
 340         mdd_write_unlock(env, obj);
 341         mdd_trans_stop(env, mdd, 0, th);
 342
 343         RETURN(rc ? rc : rc1);
 344 }
 345
 346 /**
 347  * Delete unused orphan with FID \a lf from PENDING directory
 348  *
 349  * \param mdd  MDD device finishing recovery
 350  * \param lf   FID of file or directory to delete
 351  * \param key  cookie for this entry in index iterator
 352  *
 353  * \retval 0   success
 354  * \retval -ve error
 355  */
 356 static int mdd_orphan_key_test_and_delete(const struct lu_env *env,
 357                                           struct mdd_device *mdd,
 358                                           struct lu_fid *lf, struct dt_key *key)
 359 {
 360         struct mdd_object *mdo;
 361         int rc;
 362
 363         mdo = mdd_object_find(env, mdd, lf);
 364
 365         if (IS_ERR(mdo))
 366                 return PTR_ERR(mdo);
 367
 368         rc = -EBUSY;
 369         if (mdo->mod_count == 0) {
 370                 CDEBUG(D_HA, "Found orphan "DFID", delete it\n", PFID(lf));
 371                 rc = mdd_orphan_destroy(env, mdo, key);
 372                 if (rc) /* below message checked in replay-single.sh test_37 */
 373                         CERROR("%s: error unlinking orphan "DFID": rc = %d\n",
 374                                mdd2obd_dev(mdd)->obd_name, PFID(lf), rc);
 375         } else {
 376                 mdd_write_lock(env, mdo, DT_TGT_CHILD);
 377                 if (likely(mdo->mod_count > 0)) {
 378                         CDEBUG(D_HA, "Found orphan "DFID" count %d, skip it\n",
 379                                PFID(lf), mdo->mod_count);
 380                         mdo->mod_flags |= ORPHAN_OBJ;
 381                 }
 382                 mdd_write_unlock(env, mdo);
 383         }
 384
 385         mdd_object_put(env, mdo);
 386         return rc;
 387 }
 388
 389 /**
 390  * delete unreferenced files and directories in the PENDING directory
 391  *
 392  * Files that remain in PENDING after client->MDS recovery has completed
 393  * have to be referenced (opened) by some client during recovery, or they
 394  * will be deleted here (for clients that did not complete recovery).
 395  *
 396  * \param thread  info about orphan cleanup thread
 397  *
 398  * \retval 0   success
 399  * \retval -ve error
 400  */
 401 static int mdd_orphan_index_iterate(const struct lu_env *env,
 402                                     struct mdd_generic_thread *thread)
 403 {
 404         struct mdd_device *mdd = (struct mdd_device *)thread->mgt_data;
 405         struct dt_object *dor = mdd->mdd_orphans;
 406         struct lu_dirent *ent = &mdd_env_info(env)->mti_ent;
 407         const struct dt_it_ops *iops;
 408         struct dt_it *it;
 409         struct lu_fid fid;
 410         int key_sz = 0;
 411         int rc;
 412         ENTRY;
 413
 414         iops = &dor->do_index_ops->dio_it;
 415         it = iops->init(env, dor, LUDA_64BITHASH);
 416         if (IS_ERR(it)) {
 417                 rc = PTR_ERR(it);
 418                 CERROR("%s: cannot clean '%s': rc = %d\n",
 419                        mdd2obd_dev(mdd)->obd_name, mdd_orphan_index_name, rc);
 420                 GOTO(out, rc);
 421         }
 422
 423         rc = iops->load(env, it, 0);
 424         if (rc < 0)
 425                 GOTO(out_put, rc);
 426         if (rc == 0) {
 427                 CERROR("%s: error loading iterator to clean '%s'\n",
 428                        mdd2obd_dev(mdd)->obd_name, mdd_orphan_index_name);
 429                 /* Index contains no zero key? */
 430                 GOTO(out_put, rc = -EIO);
 431         }
 432
 433         mdd_env_info(env)->mti_flags |= MTI_KEEP_KEY;
 434         do {
 435                 if (thread->mgt_abort)
 436                         break;
 437
 438                 key_sz = iops->key_size(env, it);
 439                 /* filter out "." and ".." entries from PENDING dir. */
 440                 if (key_sz < 8)
 441                         goto next;
 442
 443                 rc = iops->rec(env, it, (struct dt_rec *)ent, LUDA_64BITHASH);
 444                 if (rc != 0) {
 445                         CERROR("%s: fail to get FID for orphan it: rc = %d\n",
 446                                mdd2obd_dev(mdd)->obd_name, rc);
 447                         goto next;
 448                 }
 449
 450                 fid_le_to_cpu(&fid, &ent->lde_fid);
 451                 if (!fid_is_sane(&fid)) {
 452                         CERROR("%s: bad FID "DFID" cleaning '%s'\n",
 453                                mdd2obd_dev(mdd)->obd_name, PFID(&fid),
 454                                mdd_orphan_index_name);
 455                         goto next;
 456                 }
 457
 458                 /* kill orphan object */
 459                 iops->put(env, it);
 460                 rc = mdd_orphan_key_test_and_delete(env, mdd, &fid,
 461                                                 (struct dt_key *)ent->lde_name);
 462                 /* after index delete reset iterator */
 463                 if (rc == 0)
 464                         rc = iops->get(env, it, (const void *)"");
 465 next:
 466                 rc = iops->next(env, it);
 467         } while (rc == 0);
 468
 469         GOTO(out_put, rc = 0);
 470 out_put:
 471         iops->put(env, it);
 472         iops->fini(env, it);
 473
 474 out:
 475         return rc;
 476 }
 477
 478 /**
 479  * open the PENDING directory for device \a mdd
 480  *
 481  * The PENDING directory persistently tracks files and directories that were
 482  * unlinked from the namespace (nlink == 0) but are still held open by clients.
 483  * Those inodes shouldn't be deleted if the MDS crashes, because the clients
 484  * would not be able to recover and reopen those files.  Instead, these inodes
 485  * are linked into the PENDING directory on disk, and only deleted if all
 486  * clients close them, or the MDS finishes client recovery without any client
 487  * reopening them (i.e. former clients didn't join recovery).
 488  *  \param d   mdd device being started.
 489  *
 490  *  \retval 0  success
 491  *  \retval  -ve index operation error.
 492  *
 493  */
 494 int mdd_orphan_index_init(const struct lu_env *env, struct mdd_device *mdd)
 495 {
 496         struct lu_fid fid;
 497         struct dt_object *d;
 498         int rc = 0;
 499
 500         ENTRY;
 501
 502         /* create PENDING dir */
 503         fid_zero(&fid);
 504         rc = mdd_local_file_create(env, mdd, &mdd->mdd_local_root_fid,
 505                                    mdd_orphan_index_name, S_IFDIR | S_IRUGO |
 506                                    S_IWUSR | S_IXUGO, &fid);
 507         if (rc < 0)
 508                 RETURN(rc);
 509
 510         d = dt_locate(env, mdd->mdd_child, &fid);
 511         if (IS_ERR(d))
 512                 RETURN(PTR_ERR(d));
 513         LASSERT(lu_object_exists(&d->do_lu));
 514         if (!dt_try_as_dir(env, d)) {
 515                 CERROR("%s: orphan dir '%s' is not an index: rc = %d\n",
 516                        mdd2obd_dev(mdd)->obd_name, mdd_orphan_index_name, rc);
 517                 dt_object_put(env, d);
 518                 RETURN(-ENOTDIR);
 519         }
 520         mdd->mdd_orphans = d;
 521         RETURN(0);
 522 }
 523
 524 void mdd_orphan_index_fini(const struct lu_env *env, struct mdd_device *mdd)
 525 {
 526         ENTRY;
 527         if (mdd->mdd_orphans != NULL) {
 528                 dt_object_put(env, mdd->mdd_orphans);
 529                 mdd->mdd_orphans = NULL;
 530         }
 531         EXIT;
 532 }
 533
 534 static int mdd_orphan_cleanup_thread(void *args)
 535 {
 536         struct mdd_generic_thread *thread = (struct mdd_generic_thread *)args;
 537         struct lu_env *env = NULL;
 538         int rc;
 539         ENTRY;
 540
 541         complete(&thread->mgt_started);
 542
 543         OBD_ALLOC_PTR(env);
 544         if (env == NULL)
 545                 GOTO(out, rc = -ENOMEM);
 546
 547         rc = lu_env_init(env, LCT_MD_THREAD);
 548         if (rc)
 549                 GOTO(out, rc);
 550
 551         rc = mdd_orphan_index_iterate(env, thread);
 552
 553         lu_env_fini(env);
 554         GOTO(out, rc);
 555 out:
 556         if (env)
 557                 OBD_FREE_PTR(env);
 558         complete(&thread->mgt_finished);
 559         return rc;
 560 }
 561
 562 /**
 563  *  Iterate orphan index to cleanup orphan objects after recovery is done.
 564  *  \param d   mdd device in recovery.
 565  */
 566 int mdd_orphan_cleanup(const struct lu_env *env, struct mdd_device *d)
 567 {
 568         int rc = -ENOMEM;
 569         char *name = NULL;
 570
 571         OBD_ALLOC(name, MTI_NAME_MAXLEN);
 572         if (name == NULL)
 573                 goto out;
 574
 575         snprintf(name, MTI_NAME_MAXLEN, "orph_%s", mdd2obd_dev(d)->obd_name);
 576
 577         rc = mdd_generic_thread_start(&d->mdd_orphan_cleanup_thread,
 578                                       mdd_orphan_cleanup_thread, d, name);
 579 out:
 580         if (rc)
 581                 CERROR("%s: start orphan cleanup thread failed: rc = %d\n",
 582                        mdd2obd_dev(d)->obd_name, rc);
 583         if (name)
 584                 OBD_FREE(name, MTI_NAME_MAXLEN);
 585
 586         return rc;
 587 }