lustre/obdclass/llog_cat.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) 2003, 2010, Oracle and/or its affiliates. All rights reserved.
  28  * Use is subject to license terms.
  29  *
  30  * Copyright (c) 2012, Intel Corporation.
  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/obdclass/llog_cat.c
  37  *
  38  * OST<->MDS recovery logging infrastructure.
  39  *
  40  * Invariants in implementation:
  41  * - we do not share logs among different OST<->MDS connections, so that
  42  *   if an OST or MDS fails it need only look at log(s) relevant to itself
  43  *
  44  * Author: Andreas Dilger <adilger@clusterfs.com>
  45  * Author: Alexey Zhuravlev <alexey.zhuravlev@intel.com>
  46  * Author: Mikhail Pershin <mike.pershin@intel.com>
  47  */
  48
  49 #define DEBUG_SUBSYSTEM S_LOG
  50
  51 #ifndef __KERNEL__
  52 #include <liblustre.h>
  53 #endif
  54
  55 #include <obd_class.h>
  56
  57 #include "llog_internal.h"
  58
  59 /* Create a new log handle and add it to the open list.
  60  * This log handle will be closed when all of the records in it are removed.
  61  *
  62  * Assumes caller has already pushed us into the kernel context and is locking.
  63  */
  64 static int llog_cat_new_log(const struct lu_env *env,
  65                             struct llog_handle *cathandle,
  66                             struct llog_handle *loghandle,
  67                             struct thandle *th)
  68 {
  69
  70         struct llog_log_hdr *llh;
  71         struct llog_logid_rec rec = { { 0 }, };
  72         int rc, index, bitmap_size;
  73         ENTRY;
  74
  75         llh = cathandle->lgh_hdr;
  76         bitmap_size = LLOG_BITMAP_SIZE(llh);
  77
  78         index = (cathandle->lgh_last_idx + 1) % bitmap_size;
  79
  80         /* maximum number of available slots in catlog is bitmap_size - 2 */
  81         if (llh->llh_cat_idx == index) {
  82                 CERROR("no free catalog slots for log...\n");
  83                 RETURN(-ENOSPC);
  84         }
  85
  86         if (OBD_FAIL_CHECK(OBD_FAIL_MDS_LLOG_CREATE_FAILED))
  87                 RETURN(-ENOSPC);
  88
  89         rc = llog_create(env, loghandle, th);
  90         /* if llog is already created, no need to initialize it */
  91         if (rc == -EEXIST) {
  92                 RETURN(0);
  93         } else if (rc != 0) {
  94                 CERROR("%s: can't create new plain llog in catalog: rc = %d\n",
  95                        loghandle->lgh_ctxt->loc_obd->obd_name, rc);
  96                 RETURN(rc);
  97         }
  98
  99         rc = llog_init_handle(env, loghandle,
 100                               LLOG_F_IS_PLAIN | LLOG_F_ZAP_WHEN_EMPTY,
 101                               &cathandle->lgh_hdr->llh_tgtuuid);
 102         if (rc)
 103                 GOTO(out_destroy, rc);
 104
 105         if (index == 0)
 106                 index = 1;
 107
 108         spin_lock(&loghandle->lgh_hdr_lock);
 109         llh->llh_count++;
 110         if (ext2_set_bit(index, llh->llh_bitmap)) {
 111                 CERROR("argh, index %u already set in log bitmap?\n",
 112                        index);
 113                 spin_unlock(&loghandle->lgh_hdr_lock);
 114                 LBUG(); /* should never happen */
 115         }
 116         spin_unlock(&loghandle->lgh_hdr_lock);
 117
 118         cathandle->lgh_last_idx = index;
 119         llh->llh_tail.lrt_index = index;
 120
 121         CDEBUG(D_RPCTRACE,"new recovery log "LPX64":%x for index %u of catalog "
 122                LPX64"\n", loghandle->lgh_id.lgl_oid, loghandle->lgh_id.lgl_ogen,
 123                index, cathandle->lgh_id.lgl_oid);
 124         /* build the record for this log in the catalog */
 125         rec.lid_hdr.lrh_len = sizeof(rec);
 126         rec.lid_hdr.lrh_index = index;
 127         rec.lid_hdr.lrh_type = LLOG_LOGID_MAGIC;
 128         rec.lid_id = loghandle->lgh_id;
 129         rec.lid_tail.lrt_len = sizeof(rec);
 130         rec.lid_tail.lrt_index = index;
 131
 132         /* update the catalog: header and record */
 133         rc = llog_write_rec(env, cathandle, &rec.lid_hdr,
 134                             &loghandle->u.phd.phd_cookie, 1, NULL, index, th);
 135         if (rc < 0)
 136                 GOTO(out_destroy, rc);
 137
 138         loghandle->lgh_hdr->llh_cat_idx = index;
 139         RETURN(0);
 140 out_destroy:
 141         llog_destroy(env, loghandle);
 142         RETURN(rc);
 143 }
 144
 145 /* Open an existent log handle and add it to the open list.
 146  * This log handle will be closed when all of the records in it are removed.
 147  *
 148  * Assumes caller has already pushed us into the kernel context and is locking.
 149  * We return a lock on the handle to ensure nobody yanks it from us.
 150  *
 151  * This takes extra reference on llog_handle via llog_handle_get() and require
 152  * this reference to be put by caller using llog_handle_put()
 153  */
 154 int llog_cat_id2handle(const struct lu_env *env, struct llog_handle *cathandle,
 155                        struct llog_handle **res, struct llog_logid *logid)
 156 {
 157         struct llog_handle      *loghandle;
 158         int                      rc = 0;
 159
 160         ENTRY;
 161
 162         if (cathandle == NULL)
 163                 RETURN(-EBADF);
 164
 165         down_write(&cathandle->lgh_lock);
 166         cfs_list_for_each_entry(loghandle, &cathandle->u.chd.chd_head,
 167                                 u.phd.phd_entry) {
 168                 struct llog_logid *cgl = &loghandle->lgh_id;
 169
 170                 if (cgl->lgl_oid == logid->lgl_oid) {
 171                         if (cgl->lgl_ogen != logid->lgl_ogen) {
 172                                 CERROR("%s: log "LPX64" generation %x != %x\n",
 173                                        loghandle->lgh_ctxt->loc_obd->obd_name,
 174                                        logid->lgl_oid, cgl->lgl_ogen,
 175                                        logid->lgl_ogen);
 176                                 continue;
 177                         }
 178                         loghandle->u.phd.phd_cat_handle = cathandle;
 179                         up_write(&cathandle->lgh_lock);
 180                         GOTO(out, rc = 0);
 181                 }
 182         }
 183         up_write(&cathandle->lgh_lock);
 184
 185         rc = llog_open(env, cathandle->lgh_ctxt, &loghandle, logid, NULL,
 186                        LLOG_OPEN_EXISTS);
 187         if (rc < 0) {
 188                 CERROR("%s: error opening log id "LPX64":%x: rc = %d\n",
 189                        cathandle->lgh_ctxt->loc_obd->obd_name,
 190                        logid->lgl_oid, logid->lgl_ogen, rc);
 191                 RETURN(rc);
 192         }
 193
 194         rc = llog_init_handle(env, loghandle, LLOG_F_IS_PLAIN, NULL);
 195         if (rc < 0) {
 196                 llog_close(env, loghandle);
 197                 RETURN(rc);
 198         }
 199
 200         down_write(&cathandle->lgh_lock);
 201         cfs_list_add(&loghandle->u.phd.phd_entry, &cathandle->u.chd.chd_head);
 202         up_write(&cathandle->lgh_lock);
 203
 204         loghandle->u.phd.phd_cat_handle = cathandle;
 205         loghandle->u.phd.phd_cookie.lgc_lgl = cathandle->lgh_id;
 206         loghandle->u.phd.phd_cookie.lgc_index =
 207                                 loghandle->lgh_hdr->llh_cat_idx;
 208         EXIT;
 209 out:
 210         llog_handle_get(loghandle);
 211         *res = loghandle;
 212         return 0;
 213 }
 214
 215 int llog_cat_close(const struct lu_env *env, struct llog_handle *cathandle)
 216 {
 217         struct llog_handle      *loghandle, *n;
 218         int                      rc;
 219
 220         ENTRY;
 221
 222         cfs_list_for_each_entry_safe(loghandle, n, &cathandle->u.chd.chd_head,
 223                                      u.phd.phd_entry) {
 224                 struct llog_log_hdr     *llh = loghandle->lgh_hdr;
 225                 int                      index;
 226
 227                 /* unlink open-not-created llogs */
 228                 cfs_list_del_init(&loghandle->u.phd.phd_entry);
 229                 llh = loghandle->lgh_hdr;
 230                 if (loghandle->lgh_obj != NULL && llh != NULL &&
 231                     (llh->llh_flags & LLOG_F_ZAP_WHEN_EMPTY) &&
 232                     (llh->llh_count == 1)) {
 233                         rc = llog_destroy(env, loghandle);
 234                         if (rc)
 235                                 CERROR("%s: failure destroying log during "
 236                                        "cleanup: rc = %d\n",
 237                                        loghandle->lgh_ctxt->loc_obd->obd_name,
 238                                        rc);
 239
 240                         index = loghandle->u.phd.phd_cookie.lgc_index;
 241                         llog_cat_cleanup(env, cathandle, NULL, index);
 242                 }
 243                 llog_close(env, loghandle);
 244         }
 245         /* if handle was stored in ctxt, remove it too */
 246         if (cathandle->lgh_ctxt->loc_handle == cathandle)
 247                 cathandle->lgh_ctxt->loc_handle = NULL;
 248         rc = llog_close(env, cathandle);
 249         RETURN(rc);
 250 }
 251 EXPORT_SYMBOL(llog_cat_close);
 252
 253 /**
 254  * lockdep markers for nested struct llog_handle::lgh_lock locking.
 255  */
 256 enum {
 257         LLOGH_CAT,
 258         LLOGH_LOG
 259 };
 260
 261 /** Return the currently active log handle.  If the current log handle doesn't
 262  * have enough space left for the current record, start a new one.
 263  *
 264  * If reclen is 0, we only want to know what the currently active log is,
 265  * otherwise we get a lock on this log so nobody can steal our space.
 266  *
 267  * Assumes caller has already pushed us into the kernel context and is locking.
 268  *
 269  * NOTE: loghandle is write-locked upon successful return
 270  */
 271 static struct llog_handle *llog_cat_current_log(struct llog_handle *cathandle,
 272                                                 struct thandle *th)
 273 {
 274         struct llog_handle *loghandle = NULL;
 275         ENTRY;
 276
 277         down_read_nested(&cathandle->lgh_lock, LLOGH_CAT);
 278         loghandle = cathandle->u.chd.chd_current_log;
 279         if (loghandle) {
 280                 struct llog_log_hdr *llh;
 281
 282                 down_write_nested(&loghandle->lgh_lock, LLOGH_LOG);
 283                 llh = loghandle->lgh_hdr;
 284                 if (llh == NULL ||
 285                     loghandle->lgh_last_idx < LLOG_BITMAP_SIZE(llh) - 1) {
 286                         up_read(&cathandle->lgh_lock);
 287                         RETURN(loghandle);
 288                 } else {
 289                         up_write(&loghandle->lgh_lock);
 290                 }
 291         }
 292         up_read(&cathandle->lgh_lock);
 293
 294         /* time to use next log */
 295
 296         /* first, we have to make sure the state hasn't changed */
 297         down_write_nested(&cathandle->lgh_lock, LLOGH_CAT);
 298         loghandle = cathandle->u.chd.chd_current_log;
 299         if (loghandle) {
 300                 struct llog_log_hdr *llh;
 301
 302                 down_write_nested(&loghandle->lgh_lock, LLOGH_LOG);
 303                 llh = loghandle->lgh_hdr;
 304                 LASSERT(llh);
 305                 if (loghandle->lgh_last_idx < LLOG_BITMAP_SIZE(llh) - 1) {
 306                         up_write(&cathandle->lgh_lock);
 307                         RETURN(loghandle);
 308                 } else {
 309                         up_write(&loghandle->lgh_lock);
 310                 }
 311         }
 312
 313         CDEBUG(D_INODE, "use next log\n");
 314
 315         loghandle = cathandle->u.chd.chd_next_log;
 316         cathandle->u.chd.chd_current_log = loghandle;
 317         cathandle->u.chd.chd_next_log = NULL;
 318         down_write_nested(&loghandle->lgh_lock, LLOGH_LOG);
 319         up_write(&cathandle->lgh_lock);
 320         LASSERT(loghandle);
 321         RETURN(loghandle);
 322 }
 323
 324 /* Add a single record to the recovery log(s) using a catalog
 325  * Returns as llog_write_record
 326  *
 327  * Assumes caller has already pushed us into the kernel context.
 328  */
 329 int llog_cat_add_rec(const struct lu_env *env, struct llog_handle *cathandle,
 330                      struct llog_rec_hdr *rec, struct llog_cookie *reccookie,
 331                      void *buf, struct thandle *th)
 332 {
 333         struct llog_handle *loghandle;
 334         int rc;
 335         ENTRY;
 336
 337         LASSERT(rec->lrh_len <= LLOG_CHUNK_SIZE);
 338         loghandle = llog_cat_current_log(cathandle, th);
 339         LASSERT(!IS_ERR(loghandle));
 340
 341         /* loghandle is already locked by llog_cat_current_log() for us */
 342         if (!llog_exist(loghandle)) {
 343                 rc = llog_cat_new_log(env, cathandle, loghandle, th);
 344                 if (rc < 0) {
 345                         up_write(&loghandle->lgh_lock);
 346                         RETURN(rc);
 347                 }
 348         }
 349         /* now let's try to add the record */
 350         rc = llog_write_rec(env, loghandle, rec, reccookie, 1, buf, -1, th);
 351         if (rc < 0)
 352                 CDEBUG_LIMIT(rc == -ENOSPC ? D_HA : D_ERROR,
 353                              "llog_write_rec %d: lh=%p\n", rc, loghandle);
 354         up_write(&loghandle->lgh_lock);
 355         if (rc == -ENOSPC) {
 356                 /* try to use next log */
 357                 loghandle = llog_cat_current_log(cathandle, th);
 358                 LASSERT(!IS_ERR(loghandle));
 359                 /* new llog can be created concurrently */
 360                 if (!llog_exist(loghandle)) {
 361                         rc = llog_cat_new_log(env, cathandle, loghandle, th);
 362                         if (rc < 0) {
 363                                 up_write(&loghandle->lgh_lock);
 364                                 RETURN(rc);
 365                         }
 366                 }
 367                 /* now let's try to add the record */
 368                 rc = llog_write_rec(env, loghandle, rec, reccookie, 1, buf,
 369                                     -1, th);
 370                 if (rc < 0)
 371                         CERROR("llog_write_rec %d: lh=%p\n", rc, loghandle);
 372                 up_write(&loghandle->lgh_lock);
 373         }
 374
 375         RETURN(rc);
 376 }
 377 EXPORT_SYMBOL(llog_cat_add_rec);
 378
 379 int llog_cat_declare_add_rec(const struct lu_env *env,
 380                              struct llog_handle *cathandle,
 381                              struct llog_rec_hdr *rec, struct thandle *th)
 382 {
 383         struct llog_handle      *loghandle, *next;
 384         int                      rc = 0;
 385
 386         ENTRY;
 387
 388         if (cathandle->u.chd.chd_current_log == NULL) {
 389                 /* declare new plain llog */
 390                 down_write(&cathandle->lgh_lock);
 391                 if (cathandle->u.chd.chd_current_log == NULL) {
 392                         rc = llog_open(env, cathandle->lgh_ctxt, &loghandle,
 393                                        NULL, NULL, LLOG_OPEN_NEW);
 394                         if (rc == 0) {
 395                                 cathandle->u.chd.chd_current_log = loghandle;
 396                                 cfs_list_add_tail(&loghandle->u.phd.phd_entry,
 397                                                   &cathandle->u.chd.chd_head);
 398                         }
 399                 }
 400                 up_write(&cathandle->lgh_lock);
 401         } else if (cathandle->u.chd.chd_next_log == NULL) {
 402                 /* declare next plain llog */
 403                 down_write(&cathandle->lgh_lock);
 404                 if (cathandle->u.chd.chd_next_log == NULL) {
 405                         rc = llog_open(env, cathandle->lgh_ctxt, &loghandle,
 406                                        NULL, NULL, LLOG_OPEN_NEW);
 407                         if (rc == 0) {
 408                                 cathandle->u.chd.chd_next_log = loghandle;
 409                                 cfs_list_add_tail(&loghandle->u.phd.phd_entry,
 410                                                   &cathandle->u.chd.chd_head);
 411                         }
 412                 }
 413                 up_write(&cathandle->lgh_lock);
 414         }
 415         if (rc)
 416                 GOTO(out, rc);
 417
 418         if (!llog_exist(cathandle->u.chd.chd_current_log)) {
 419                 rc = llog_declare_create(env, cathandle->u.chd.chd_current_log,
 420                                          th);
 421                 if (rc)
 422                         GOTO(out, rc);
 423                 llog_declare_write_rec(env, cathandle, NULL, -1, th);
 424         }
 425         /* declare records in the llogs */
 426         rc = llog_declare_write_rec(env, cathandle->u.chd.chd_current_log,
 427                                     rec, -1, th);
 428         if (rc)
 429                 GOTO(out, rc);
 430
 431         next = cathandle->u.chd.chd_next_log;
 432         if (next) {
 433                 if (!llog_exist(next)) {
 434                         rc = llog_declare_create(env, next, th);
 435                         llog_declare_write_rec(env, cathandle, NULL, -1, th);
 436                 }
 437                 llog_declare_write_rec(env, next, rec, -1, th);
 438         }
 439 out:
 440         RETURN(rc);
 441 }
 442 EXPORT_SYMBOL(llog_cat_declare_add_rec);
 443
 444 int llog_cat_add(const struct lu_env *env, struct llog_handle *cathandle,
 445                  struct llog_rec_hdr *rec, struct llog_cookie *reccookie,
 446                  void *buf)
 447 {
 448         struct llog_ctxt        *ctxt;
 449         struct dt_device        *dt;
 450         struct thandle          *th = NULL;
 451         int                      rc;
 452
 453         ctxt = cathandle->lgh_ctxt;
 454         LASSERT(ctxt);
 455         LASSERT(ctxt->loc_exp);
 456
 457         if (cathandle->lgh_obj != NULL) {
 458                 dt = ctxt->loc_exp->exp_obd->obd_lvfs_ctxt.dt;
 459                 LASSERT(dt);
 460
 461                 th = dt_trans_create(env, dt);
 462                 if (IS_ERR(th))
 463                         RETURN(PTR_ERR(th));
 464
 465                 rc = llog_cat_declare_add_rec(env, cathandle, rec, th);
 466                 if (rc)
 467                         GOTO(out_trans, rc);
 468
 469                 rc = dt_trans_start_local(env, dt, th);
 470                 if (rc)
 471                         GOTO(out_trans, rc);
 472                 rc = llog_cat_add_rec(env, cathandle, rec, reccookie, buf, th);
 473 out_trans:
 474                 dt_trans_stop(env, dt, th);
 475         } else { /* lvfs compat code */
 476                 LASSERT(cathandle->lgh_file != NULL);
 477                 rc = llog_cat_declare_add_rec(env, cathandle, rec, th);
 478                 if (rc == 0)
 479                         rc = llog_cat_add_rec(env, cathandle, rec, reccookie,
 480                                               buf, th);
 481         }
 482         RETURN(rc);
 483 }
 484 EXPORT_SYMBOL(llog_cat_add);
 485
 486 /* For each cookie in the cookie array, we clear the log in-use bit and either:
 487  * - the log is empty, so mark it free in the catalog header and delete it
 488  * - the log is not empty, just write out the log header
 489  *
 490  * The cookies may be in different log files, so we need to get new logs
 491  * each time.
 492  *
 493  * Assumes caller has already pushed us into the kernel context.
 494  */
 495 int llog_cat_cancel_records(const struct lu_env *env,
 496                             struct llog_handle *cathandle, int count,
 497                             struct llog_cookie *cookies)
 498 {
 499         int i, index, rc = 0, failed = 0;
 500
 501         ENTRY;
 502
 503         for (i = 0; i < count; i++, cookies++) {
 504                 struct llog_handle      *loghandle;
 505                 struct llog_logid       *lgl = &cookies->lgc_lgl;
 506                 int                      lrc;
 507
 508                 rc = llog_cat_id2handle(env, cathandle, &loghandle, lgl);
 509                 if (rc) {
 510                         CERROR("%s: cannot find handle for llog "LPX64": %d\n",
 511                                cathandle->lgh_ctxt->loc_obd->obd_name,
 512                                lgl->lgl_oid, rc);
 513                         failed++;
 514                         continue;
 515                 }
 516
 517                 lrc = llog_cancel_rec(env, loghandle, cookies->lgc_index);
 518                 if (lrc == 1) {          /* log has been destroyed */
 519                         index = loghandle->u.phd.phd_cookie.lgc_index;
 520                         rc = llog_cat_cleanup(env, cathandle, loghandle,
 521                                               index);
 522                 } else if (lrc == -ENOENT) {
 523                         if (rc == 0) /* ENOENT shouldn't rewrite any error */
 524                                 rc = lrc;
 525                 } else if (lrc < 0) {
 526                         failed++;
 527                         rc = lrc;
 528                 }
 529                 llog_handle_put(loghandle);
 530         }
 531         if (rc)
 532                 CERROR("%s: fail to cancel %d of %d llog-records: rc = %d\n",
 533                        cathandle->lgh_ctxt->loc_obd->obd_name, failed, count,
 534                        rc);
 535
 536         RETURN(rc);
 537 }
 538 EXPORT_SYMBOL(llog_cat_cancel_records);
 539
 540 int llog_cat_process_cb(const struct lu_env *env, struct llog_handle *cat_llh,
 541                         struct llog_rec_hdr *rec, void *data)
 542 {
 543         struct llog_process_data *d = data;
 544         struct llog_logid_rec *lir = (struct llog_logid_rec *)rec;
 545         struct llog_handle *llh;
 546         int rc;
 547
 548         ENTRY;
 549         if (rec->lrh_type != LLOG_LOGID_MAGIC) {
 550                 CERROR("invalid record in catalog\n");
 551                 RETURN(-EINVAL);
 552         }
 553         CDEBUG(D_HA, "processing log "LPX64":%x at index %u of catalog "
 554                LPX64"\n", lir->lid_id.lgl_oid, lir->lid_id.lgl_ogen,
 555                rec->lrh_index, cat_llh->lgh_id.lgl_oid);
 556
 557         rc = llog_cat_id2handle(env, cat_llh, &llh, &lir->lid_id);
 558         if (rc) {
 559                 CERROR("%s: cannot find handle for llog "LPX64": %d\n",
 560                        cat_llh->lgh_ctxt->loc_obd->obd_name,
 561                        lir->lid_id.lgl_oid, rc);
 562                 RETURN(rc);
 563         }
 564
 565         if (rec->lrh_index < d->lpd_startcat)
 566                 /* Skip processing of the logs until startcat */
 567                 RETURN(0);
 568
 569         if (d->lpd_startidx > 0) {
 570                 struct llog_process_cat_data cd;
 571
 572                 cd.lpcd_first_idx = d->lpd_startidx;
 573                 cd.lpcd_last_idx = 0;
 574                 rc = llog_process_or_fork(env, llh, d->lpd_cb, d->lpd_data,
 575                                           &cd, false);
 576                 /* Continue processing the next log from idx 0 */
 577                 d->lpd_startidx = 0;
 578         } else {
 579                 rc = llog_process_or_fork(env, llh, d->lpd_cb, d->lpd_data,
 580                                           NULL, false);
 581         }
 582         llog_handle_put(llh);
 583
 584         RETURN(rc);
 585 }
 586
 587 int llog_cat_process_or_fork(const struct lu_env *env,
 588                              struct llog_handle *cat_llh,
 589                              llog_cb_t cb, void *data, int startcat,
 590                              int startidx, bool fork)
 591 {
 592         struct llog_process_data d;
 593         struct llog_log_hdr *llh = cat_llh->lgh_hdr;
 594         int rc;
 595         ENTRY;
 596
 597         LASSERT(llh->llh_flags & LLOG_F_IS_CAT);
 598         d.lpd_data = data;
 599         d.lpd_cb = cb;
 600         d.lpd_startcat = startcat;
 601         d.lpd_startidx = startidx;
 602
 603         if (llh->llh_cat_idx > cat_llh->lgh_last_idx) {
 604                 struct llog_process_cat_data cd;
 605
 606                 CWARN("catlog "LPX64" crosses index zero\n",
 607                       cat_llh->lgh_id.lgl_oid);
 608
 609                 cd.lpcd_first_idx = llh->llh_cat_idx;
 610                 cd.lpcd_last_idx = 0;
 611                 rc = llog_process_or_fork(env, cat_llh, llog_cat_process_cb,
 612                                           &d, &cd, fork);
 613                 if (rc != 0)
 614                         RETURN(rc);
 615
 616                 cd.lpcd_first_idx = 0;
 617                 cd.lpcd_last_idx = cat_llh->lgh_last_idx;
 618                 rc = llog_process_or_fork(env, cat_llh, llog_cat_process_cb,
 619                                           &d, &cd, fork);
 620         } else {
 621                 rc = llog_process_or_fork(env, cat_llh, llog_cat_process_cb,
 622                                           &d, NULL, fork);
 623         }
 624
 625         RETURN(rc);
 626 }
 627 EXPORT_SYMBOL(llog_cat_process_or_fork);
 628
 629 int llog_cat_process(const struct lu_env *env, struct llog_handle *cat_llh,
 630                      llog_cb_t cb, void *data, int startcat, int startidx)
 631 {
 632         return llog_cat_process_or_fork(env, cat_llh, cb, data, startcat,
 633                                         startidx, false);
 634 }
 635 EXPORT_SYMBOL(llog_cat_process);
 636
 637 #ifdef __KERNEL__
 638 int llog_cat_process_thread(void *data)
 639 {
 640         struct llog_process_cat_args *args = data;
 641         struct llog_ctxt *ctxt = args->lpca_ctxt;
 642         struct llog_handle *llh = NULL;
 643         llog_cb_t cb = args->lpca_cb;
 644         struct llog_thread_info *lgi;
 645         struct lu_env            env;
 646         int rc;
 647         ENTRY;
 648
 649         cfs_daemonize_ctxt("ll_log_process");
 650
 651         rc = lu_env_init(&env, LCT_LOCAL);
 652         if (rc)
 653                 GOTO(out, rc);
 654         lgi = llog_info(&env);
 655         LASSERT(lgi);
 656
 657         lgi->lgi_logid = *(struct llog_logid *)(args->lpca_arg);
 658         rc = llog_open(&env, ctxt, &llh, &lgi->lgi_logid, NULL,
 659                        LLOG_OPEN_EXISTS);
 660         if (rc) {
 661                 CERROR("%s: cannot open llog "LPX64":%x: rc = %d\n",
 662                        ctxt->loc_obd->obd_name, lgi->lgi_logid.lgl_oid,
 663                        lgi->lgi_logid.lgl_ogen, rc);
 664                 GOTO(out_env, rc);
 665         }
 666         rc = llog_init_handle(&env, llh, LLOG_F_IS_CAT, NULL);
 667         if (rc) {
 668                 CERROR("%s: llog_init_handle failed: rc = %d\n",
 669                        llh->lgh_ctxt->loc_obd->obd_name, rc);
 670                 GOTO(release_llh, rc);
 671         }
 672
 673         if (cb) {
 674                 rc = llog_cat_process(&env, llh, cb, NULL, 0, 0);
 675                 if (rc != LLOG_PROC_BREAK && rc != 0)
 676                         CERROR("%s: llog_cat_process() failed: rc = %d\n",
 677                                llh->lgh_ctxt->loc_obd->obd_name, rc);
 678                 cb(&env, llh, NULL, NULL);
 679         } else {
 680                 CWARN("No callback function for recovery\n");
 681         }
 682
 683         /*
 684          * Make sure that all cached data is sent.
 685          */
 686         llog_sync(ctxt, NULL, 0);
 687         GOTO(release_llh, rc);
 688 release_llh:
 689         rc = llog_cat_close(&env, llh);
 690         if (rc)
 691                 CERROR("%s: llog_cat_close() failed: rc = %d\n",
 692                        llh->lgh_ctxt->loc_obd->obd_name, rc);
 693 out_env:
 694         lu_env_fini(&env);
 695 out:
 696         llog_ctxt_put(ctxt);
 697         OBD_FREE_PTR(args);
 698         return rc;
 699 }
 700 EXPORT_SYMBOL(llog_cat_process_thread);
 701 #endif
 702
 703 static int llog_cat_reverse_process_cb(const struct lu_env *env,
 704                                        struct llog_handle *cat_llh,
 705                                        struct llog_rec_hdr *rec, void *data)
 706 {
 707         struct llog_process_data *d = data;
 708         struct llog_logid_rec *lir = (struct llog_logid_rec *)rec;
 709         struct llog_handle *llh;
 710         int rc;
 711
 712         if (le32_to_cpu(rec->lrh_type) != LLOG_LOGID_MAGIC) {
 713                 CERROR("invalid record in catalog\n");
 714                 RETURN(-EINVAL);
 715         }
 716         CDEBUG(D_HA, "processing log "LPX64":%x at index %u of catalog "
 717                LPX64"\n", lir->lid_id.lgl_oid, lir->lid_id.lgl_ogen,
 718                le32_to_cpu(rec->lrh_index), cat_llh->lgh_id.lgl_oid);
 719
 720         rc = llog_cat_id2handle(env, cat_llh, &llh, &lir->lid_id);
 721         if (rc) {
 722                 CERROR("%s: cannot find handle for llog "LPX64": %d\n",
 723                        cat_llh->lgh_ctxt->loc_obd->obd_name,
 724                        lir->lid_id.lgl_oid, rc);
 725                 RETURN(rc);
 726         }
 727
 728         rc = llog_reverse_process(env, llh, d->lpd_cb, d->lpd_data, NULL);
 729         llog_handle_put(llh);
 730         RETURN(rc);
 731 }
 732
 733 int llog_cat_reverse_process(const struct lu_env *env,
 734                              struct llog_handle *cat_llh,
 735                              llog_cb_t cb, void *data)
 736 {
 737         struct llog_process_data d;
 738         struct llog_process_cat_data cd;
 739         struct llog_log_hdr *llh = cat_llh->lgh_hdr;
 740         int rc;
 741         ENTRY;
 742
 743         LASSERT(llh->llh_flags & LLOG_F_IS_CAT);
 744         d.lpd_data = data;
 745         d.lpd_cb = cb;
 746
 747         if (llh->llh_cat_idx > cat_llh->lgh_last_idx) {
 748                 CWARN("catalog "LPX64" crosses index zero\n",
 749                       cat_llh->lgh_id.lgl_oid);
 750
 751                 cd.lpcd_first_idx = 0;
 752                 cd.lpcd_last_idx = cat_llh->lgh_last_idx;
 753                 rc = llog_reverse_process(env, cat_llh,
 754                                           llog_cat_reverse_process_cb,
 755                                           &d, &cd);
 756                 if (rc != 0)
 757                         RETURN(rc);
 758
 759                 cd.lpcd_first_idx = le32_to_cpu(llh->llh_cat_idx);
 760                 cd.lpcd_last_idx = 0;
 761                 rc = llog_reverse_process(env, cat_llh,
 762                                           llog_cat_reverse_process_cb,
 763                                           &d, &cd);
 764         } else {
 765                 rc = llog_reverse_process(env, cat_llh,
 766                                           llog_cat_reverse_process_cb,
 767                                           &d, NULL);
 768         }
 769
 770         RETURN(rc);
 771 }
 772 EXPORT_SYMBOL(llog_cat_reverse_process);
 773
 774 int llog_cat_set_first_idx(struct llog_handle *cathandle, int index)
 775 {
 776         struct llog_log_hdr *llh = cathandle->lgh_hdr;
 777         int i, bitmap_size, idx;
 778         ENTRY;
 779
 780         bitmap_size = LLOG_BITMAP_SIZE(llh);
 781         if (llh->llh_cat_idx == (index - 1)) {
 782                 idx = llh->llh_cat_idx + 1;
 783                 llh->llh_cat_idx = idx;
 784                 if (idx == cathandle->lgh_last_idx)
 785                         goto out;
 786                 for (i = (index + 1) % bitmap_size;
 787                      i != cathandle->lgh_last_idx;
 788                      i = (i + 1) % bitmap_size) {
 789                         if (!ext2_test_bit(i, llh->llh_bitmap)) {
 790                                 idx = llh->llh_cat_idx + 1;
 791                                 llh->llh_cat_idx = idx;
 792                         } else if (i == 0) {
 793                                 llh->llh_cat_idx = 0;
 794                         } else {
 795                                 break;
 796                         }
 797                 }
 798 out:
 799                 CDEBUG(D_RPCTRACE, "set catlog "LPX64" first idx %u\n",
 800                        cathandle->lgh_id.lgl_oid, llh->llh_cat_idx);
 801         }
 802
 803         RETURN(0);
 804 }
 805
 806 /* Cleanup deleted plain llog traces from catalog */
 807 int llog_cat_cleanup(const struct lu_env *env, struct llog_handle *cathandle,
 808                      struct llog_handle *loghandle, int index)
 809 {
 810         int rc;
 811
 812         LASSERT(index);
 813         if (loghandle != NULL) {
 814                 /* remove destroyed llog from catalog list and
 815                  * chd_current_log variable */
 816                 down_write(&cathandle->lgh_lock);
 817                 if (cathandle->u.chd.chd_current_log == loghandle)
 818                         cathandle->u.chd.chd_current_log = NULL;
 819                 cfs_list_del_init(&loghandle->u.phd.phd_entry);
 820                 up_write(&cathandle->lgh_lock);
 821                 LASSERT(index == loghandle->u.phd.phd_cookie.lgc_index);
 822                 /* llog was opened and keep in a list, close it now */
 823                 llog_close(env, loghandle);
 824         }
 825         /* remove plain llog entry from catalog by index */
 826         llog_cat_set_first_idx(cathandle, index);
 827         rc = llog_cancel_rec(env, cathandle, index);
 828         if (rc == 0)
 829                 CDEBUG(D_HA, "cancel plain log at index"
 830                        " %u of catalog "LPX64"\n",
 831                        index, cathandle->lgh_id.lgl_oid);
 832         return rc;
 833 }
 834
 835 int cat_cancel_cb(const struct lu_env *env, struct llog_handle *cathandle,
 836                   struct llog_rec_hdr *rec, void *data)
 837 {
 838         struct llog_logid_rec   *lir = (struct llog_logid_rec *)rec;
 839         struct llog_handle      *loghandle;
 840         struct llog_log_hdr     *llh;
 841         int                      rc;
 842
 843         ENTRY;
 844
 845         if (rec->lrh_type != LLOG_LOGID_MAGIC) {
 846                 CERROR("%s: invalid record in catalog\n",
 847                        loghandle->lgh_ctxt->loc_obd->obd_name);
 848                 RETURN(-EINVAL);
 849         }
 850         CDEBUG(D_HA, "processing log "LPX64":%x at index %u of catalog "
 851                LPX64"\n", lir->lid_id.lgl_oid, lir->lid_id.lgl_ogen,
 852                rec->lrh_index, cathandle->lgh_id.lgl_oid);
 853
 854         rc = llog_cat_id2handle(env, cathandle, &loghandle, &lir->lid_id);
 855         if (rc) {
 856                 CERROR("%s: cannot find handle for llog "LPX64": %d\n",
 857                        cathandle->lgh_ctxt->loc_obd->obd_name,
 858                        lir->lid_id.lgl_oid, rc);
 859                 if (rc == -ENOENT || rc == -ESTALE) {
 860                         /* remove index from catalog */
 861                         llog_cat_cleanup(env, cathandle, NULL, rec->lrh_index);
 862                 }
 863                 RETURN(rc);
 864         }
 865
 866         llh = loghandle->lgh_hdr;
 867         if ((llh->llh_flags & LLOG_F_ZAP_WHEN_EMPTY) &&
 868             (llh->llh_count == 1)) {
 869                 rc = llog_destroy(env, loghandle);
 870                 if (rc)
 871                         CERROR("%s: fail to destroy empty log: rc = %d\n",
 872                                loghandle->lgh_ctxt->loc_obd->obd_name, rc);
 873
 874                 llog_cat_cleanup(env, cathandle, loghandle,
 875                                  loghandle->u.phd.phd_cookie.lgc_index);
 876         }
 877         llog_handle_put(loghandle);
 878
 879         RETURN(rc);
 880 }
 881 EXPORT_SYMBOL(cat_cancel_cb);
 882
 883 /* helper to initialize catalog llog and process it to cancel */
 884 int llog_cat_init_and_process(const struct lu_env *env,
 885                               struct llog_handle *llh)
 886 {
 887         int rc;
 888
 889         rc = llog_init_handle(env, llh, LLOG_F_IS_CAT, NULL);
 890         if (rc)
 891                 RETURN(rc);
 892
 893         rc = llog_process_or_fork(env, llh, cat_cancel_cb, NULL, NULL, false);
 894         if (rc)
 895                 CERROR("%s: llog_process() with cat_cancel_cb failed: rc = "
 896                        "%d\n", llh->lgh_ctxt->loc_obd->obd_name, rc);
 897         RETURN(0);
 898 }
 899 EXPORT_SYMBOL(llog_cat_init_and_process);
 900