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         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         int rc = 0, rc1 = 0;
 296         ENTRY;
 297
 298         th = mdd_trans_create(env, mdd);
 299         if (IS_ERR(th)) {
 300                 rc = PTR_ERR(th);
 301                 if (rc != -EINPROGRESS)
 302                         CERROR("%s: cannot get orphan thandle: rc = %d\n",
 303                                mdd2obd_dev(mdd)->obd_name, rc);
 304                 RETURN(rc);
 305         }
 306
 307         rc = mdd_orphan_declare_delete(env, obj, th);
 308         if (rc && rc != -ENOENT)
 309                 GOTO(stop, rc);
 310
 311         if (rc != -ENOENT) {
 312                 rc = mdo_declare_destroy(env, obj, th);
 313                 if (rc && rc != -ENOENT)
 314                         GOTO(stop, rc);
 315         }
 316
 317         rc = mdd_trans_start(env, mdd, th);
 318         if (rc)
 319                 GOTO(stop, rc);
 320
 321         mdd_write_lock(env, obj, DT_TGT_CHILD);
 322         if (likely(obj->mod_count == 0)) {
 323                 dt_write_lock(env, mdd->mdd_orphans, DT_TGT_ORPHAN);
 324                 rc = dt_delete(env, mdd->mdd_orphans, key, th);
 325                 /* We should remove object even dt_delete failed */
 326                 if (mdd_object_exists(obj) &&
 327                     !lu_object_is_dying(obj->mod_obj.mo_lu.lo_header)) {
 328                         mdo_ref_del(env, obj, th);
 329                         if (S_ISDIR(mdd_object_type(obj))) {
 330                                 mdo_ref_del(env, obj, th);
 331                                 dt_ref_del(env, mdd->mdd_orphans, th);
 332                         }
 333                         rc1 = mdo_destroy(env, obj, th);
 334                 }
 335                 dt_write_unlock(env, mdd->mdd_orphans);
 336         }
 337         mdd_write_unlock(env, obj);
 338 stop:
 339         mdd_trans_stop(env, mdd, 0, th);
 340
 341         RETURN(rc ? rc : rc1);
 342 }
 343
 344 /**
 345  * Delete unused orphan with FID \a lf from PENDING directory
 346  *
 347  * \param mdd  MDD device finishing recovery
 348  * \param lf   FID of file or directory to delete
 349  * \param key  cookie for this entry in index iterator
 350  *
 351  * \retval 0   success
 352  * \retval -ve error
 353  */
 354 static int mdd_orphan_key_test_and_delete(const struct lu_env *env,
 355                                           struct mdd_device *mdd,
 356                                           struct lu_fid *lf, struct dt_key *key)
 357 {
 358         struct mdd_object *mdo;
 359         int rc;
 360
 361         mdo = mdd_object_find(env, mdd, lf);
 362
 363         if (IS_ERR(mdo))
 364                 return PTR_ERR(mdo);
 365
 366         rc = -EBUSY;
 367         if (mdo->mod_count == 0) {
 368                 CDEBUG(D_HA, "Found orphan "DFID", delete it\n", PFID(lf));
 369                 rc = mdd_orphan_destroy(env, mdo, key);
 370                 if (rc) /* below message checked in replay-single.sh test_37 */
 371                         CERROR("%s: error unlinking orphan "DFID": rc = %d\n",
 372                                mdd2obd_dev(mdd)->obd_name, PFID(lf), rc);
 373         } else {
 374                 mdd_write_lock(env, mdo, DT_TGT_CHILD);
 375                 if (likely(mdo->mod_count > 0)) {
 376                         CDEBUG(D_HA, "Found orphan "DFID" count %d, skip it\n",
 377                                PFID(lf), mdo->mod_count);
 378                         mdo->mod_flags |= ORPHAN_OBJ;
 379                 }
 380                 mdd_write_unlock(env, mdo);
 381         }
 382
 383         mdd_object_put(env, mdo);
 384         return rc;
 385 }
 386
 387 /**
 388  * delete unreferenced files and directories in the PENDING directory
 389  *
 390  * Files that remain in PENDING after client->MDS recovery has completed
 391  * have to be referenced (opened) by some client during recovery, or they
 392  * will be deleted here (for clients that did not complete recovery).
 393  *
 394  * \param thread  info about orphan cleanup thread
 395  *
 396  * \retval 0   success
 397  * \retval -ve error
 398  */
 399 static int mdd_orphan_index_iterate(const struct lu_env *env,
 400                                     struct mdd_generic_thread *thread)
 401 {
 402         struct mdd_device *mdd = (struct mdd_device *)thread->mgt_data;
 403         struct dt_object *dor = mdd->mdd_orphans;
 404         struct lu_dirent *ent = &mdd_env_info(env)->mdi_ent;
 405         const struct dt_it_ops *iops;
 406         struct dt_it *it;
 407         struct lu_fid fid;
 408         int key_sz = 0;
 409         int rc;
 410         ENTRY;
 411
 412         iops = &dor->do_index_ops->dio_it;
 413         it = iops->init(env, dor, LUDA_64BITHASH);
 414         if (IS_ERR(it)) {
 415                 rc = PTR_ERR(it);
 416                 CERROR("%s: cannot clean '%s': rc = %d\n",
 417                        mdd2obd_dev(mdd)->obd_name, mdd_orphan_index_name, rc);
 418                 GOTO(out, rc);
 419         }
 420
 421         rc = iops->load(env, it, 0);
 422         if (rc < 0)
 423                 GOTO(out_put, rc);
 424         if (rc == 0) {
 425                 CERROR("%s: error loading iterator to clean '%s'\n",
 426                        mdd2obd_dev(mdd)->obd_name, mdd_orphan_index_name);
 427                 /* Index contains no zero key? */
 428                 GOTO(out_put, rc = -EIO);
 429         }
 430
 431         mdd_env_info(env)->mdi_flags |= MDI_KEEP_KEY;
 432         do {
 433                 if (thread->mgt_abort)
 434                         break;
 435
 436                 key_sz = iops->key_size(env, it);
 437                 /* filter out "." and ".." entries from PENDING dir. */
 438                 if (key_sz < 8)
 439                         goto next;
 440
 441                 rc = iops->rec(env, it, (struct dt_rec *)ent, LUDA_64BITHASH);
 442                 if (rc != 0) {
 443                         CERROR("%s: fail to get FID for orphan it: rc = %d\n",
 444                                mdd2obd_dev(mdd)->obd_name, rc);
 445                         goto next;
 446                 }
 447
 448                 fid_le_to_cpu(&fid, &ent->lde_fid);
 449                 if (!fid_is_sane(&fid)) {
 450                         CERROR("%s: bad FID "DFID" cleaning '%s'\n",
 451                                mdd2obd_dev(mdd)->obd_name, PFID(&fid),
 452                                mdd_orphan_index_name);
 453                         goto next;
 454                 }
 455
 456                 /* kill orphan object */
 457                 iops->put(env, it);
 458                 rc = mdd_orphan_key_test_and_delete(env, mdd, &fid,
 459                                                 (struct dt_key *)ent->lde_name);
 460                 /* after index delete reset iterator */
 461                 if (rc == 0)
 462                         rc = iops->get(env, it, (const void *)"");
 463 next:
 464                 rc = iops->next(env, it);
 465         } while (rc == 0);
 466
 467         GOTO(out_put, rc = 0);
 468 out_put:
 469         iops->put(env, it);
 470         iops->fini(env, it);
 471
 472 out:
 473         return rc;
 474 }
 475
 476 /**
 477  * open the PENDING directory for device \a mdd
 478  *
 479  * The PENDING directory persistently tracks files and directories that were
 480  * unlinked from the namespace (nlink == 0) but are still held open by clients.
 481  * Those inodes shouldn't be deleted if the MDS crashes, because the clients
 482  * would not be able to recover and reopen those files.  Instead, these inodes
 483  * are linked into the PENDING directory on disk, and only deleted if all
 484  * clients close them, or the MDS finishes client recovery without any client
 485  * reopening them (i.e. former clients didn't join recovery).
 486  *  \param d   mdd device being started.
 487  *
 488  *  \retval 0  success
 489  *  \retval  -ve index operation error.
 490  *
 491  */
 492 int mdd_orphan_index_init(const struct lu_env *env, struct mdd_device *mdd)
 493 {
 494         struct lu_fid fid;
 495         struct dt_object *d;
 496         int rc = 0;
 497
 498         ENTRY;
 499
 500         /* create PENDING dir */
 501         fid_zero(&fid);
 502         rc = mdd_local_file_create(env, mdd, &mdd->mdd_local_root_fid,
 503                                    mdd_orphan_index_name, S_IFDIR | S_IRUGO |
 504                                    S_IWUSR | S_IXUGO, &fid);
 505         if (rc < 0)
 506                 RETURN(rc);
 507
 508         d = dt_locate(env, mdd->mdd_child, &fid);
 509         if (IS_ERR(d))
 510                 RETURN(PTR_ERR(d));
 511         LASSERT(lu_object_exists(&d->do_lu));
 512         if (!dt_try_as_dir(env, d)) {
 513                 CERROR("%s: orphan dir '%s' is not an index: rc = %d\n",
 514                        mdd2obd_dev(mdd)->obd_name, mdd_orphan_index_name, rc);
 515                 dt_object_put(env, d);
 516                 RETURN(-ENOTDIR);
 517         }
 518         mdd->mdd_orphans = d;
 519         RETURN(0);
 520 }
 521
 522 void mdd_orphan_index_fini(const struct lu_env *env, struct mdd_device *mdd)
 523 {
 524         ENTRY;
 525         if (mdd->mdd_orphans != NULL) {
 526                 dt_object_put(env, mdd->mdd_orphans);
 527                 mdd->mdd_orphans = NULL;
 528         }
 529         EXIT;
 530 }
 531
 532 static int mdd_orphan_cleanup_thread(void *args)
 533 {
 534         struct mdd_generic_thread *thread = (struct mdd_generic_thread *)args;
 535         struct lu_env *env = NULL;
 536         int rc;
 537         ENTRY;
 538
 539         complete(&thread->mgt_started);
 540
 541         OBD_ALLOC_PTR(env);
 542         if (env == NULL)
 543                 GOTO(out, rc = -ENOMEM);
 544
 545         rc = lu_env_init(env, LCT_MD_THREAD);
 546         if (rc)
 547                 GOTO(out, rc);
 548
 549         rc = mdd_orphan_index_iterate(env, thread);
 550
 551         lu_env_fini(env);
 552         GOTO(out, rc);
 553 out:
 554         if (env)
 555                 OBD_FREE_PTR(env);
 556         complete(&thread->mgt_finished);
 557         return rc;
 558 }
 559
 560 /**
 561  *  Iterate orphan index to cleanup orphan objects after recovery is done.
 562  *  \param d   mdd device in recovery.
 563  */
 564 int mdd_orphan_cleanup(const struct lu_env *env, struct mdd_device *d)
 565 {
 566         int rc = -ENOMEM;
 567         char *name = NULL;
 568
 569         OBD_ALLOC(name, MTI_NAME_MAXLEN);
 570         if (name == NULL)
 571                 goto out;
 572
 573         snprintf(name, MTI_NAME_MAXLEN, "orph_%s", mdd2obd_dev(d)->obd_name);
 574
 575         rc = mdd_generic_thread_start(&d->mdd_orphan_cleanup_thread,
 576                                       mdd_orphan_cleanup_thread, d, name);
 577 out:
 578         if (rc)
 579                 CERROR("%s: start orphan cleanup thread failed: rc = %d\n",
 580                        mdd2obd_dev(d)->obd_name, rc);
 581         if (name)
 582                 OBD_FREE(name, MTI_NAME_MAXLEN);
 583
 584         return rc;
 585 }