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