lustre/obdclass/llog.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, 2013, 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.c
  37  *
  38  * OST<->MDS recovery logging infrastructure.
  39  * Invariants in implementation:
  40  * - we do not share logs among different OST<->MDS connections, so that
  41  *   if an OST or MDS fails it need only look at log(s) relevant to itself
  42  *
  43  * Author: Andreas Dilger <adilger@clusterfs.com>
  44  * Author: Alex Zhuravlev <bzzz@whamcloud.com>
  45  * Author: Mikhail Pershin <tappro@whamcloud.com>
  46  */
  47
  48 #define DEBUG_SUBSYSTEM S_LOG
  49
  50 #ifndef __KERNEL__
  51 #include <liblustre.h>
  52 #endif
  53
  54 #include <obd_class.h>
  55 #include <lustre_log.h>
  56 #include "llog_internal.h"
  57
  58 /*
  59  * Allocate a new log or catalog handle
  60  * Used inside llog_open().
  61  */
  62 struct llog_handle *llog_alloc_handle(void)
  63 {
  64         struct llog_handle *loghandle;
  65
  66         OBD_ALLOC_PTR(loghandle);
  67         if (loghandle == NULL)
  68                 return NULL;
  69
  70         init_rwsem(&loghandle->lgh_lock);
  71         spin_lock_init(&loghandle->lgh_hdr_lock);
  72         CFS_INIT_LIST_HEAD(&loghandle->u.phd.phd_entry);
  73         atomic_set(&loghandle->lgh_refcount, 1);
  74
  75         return loghandle;
  76 }
  77
  78 /*
  79  * Free llog handle and header data if exists. Used in llog_close() only
  80  */
  81 void llog_free_handle(struct llog_handle *loghandle)
  82 {
  83         LASSERT(loghandle != NULL);
  84
  85         /* failed llog_init_handle */
  86         if (!loghandle->lgh_hdr)
  87                 goto out;
  88
  89         if (loghandle->lgh_hdr->llh_flags & LLOG_F_IS_PLAIN)
  90                 LASSERT(cfs_list_empty(&loghandle->u.phd.phd_entry));
  91         else if (loghandle->lgh_hdr->llh_flags & LLOG_F_IS_CAT)
  92                 LASSERT(cfs_list_empty(&loghandle->u.chd.chd_head));
  93         LASSERT(sizeof(*(loghandle->lgh_hdr)) == LLOG_CHUNK_SIZE);
  94         OBD_FREE(loghandle->lgh_hdr, LLOG_CHUNK_SIZE);
  95 out:
  96         OBD_FREE_PTR(loghandle);
  97 }
  98
  99 void llog_handle_get(struct llog_handle *loghandle)
 100 {
 101         atomic_inc(&loghandle->lgh_refcount);
 102 }
 103
 104 void llog_handle_put(struct llog_handle *loghandle)
 105 {
 106         LASSERT(atomic_read(&loghandle->lgh_refcount) > 0);
 107         if (atomic_dec_and_test(&loghandle->lgh_refcount))
 108                 llog_free_handle(loghandle);
 109 }
 110
 111 /* returns negative on error; 0 if success; 1 if success & log destroyed */
 112 int llog_cancel_rec(const struct lu_env *env, struct llog_handle *loghandle,
 113                     int index)
 114 {
 115         struct llog_log_hdr *llh = loghandle->lgh_hdr;
 116         int rc = 0;
 117         ENTRY;
 118
 119         CDEBUG(D_RPCTRACE, "Canceling %d in log "DOSTID"\n",
 120                index, POSTID(&loghandle->lgh_id.lgl_oi));
 121
 122         if (index == 0) {
 123                 CERROR("Can't cancel index 0 which is header\n");
 124                 RETURN(-EINVAL);
 125         }
 126
 127         spin_lock(&loghandle->lgh_hdr_lock);
 128         if (!ext2_clear_bit(index, llh->llh_bitmap)) {
 129                 spin_unlock(&loghandle->lgh_hdr_lock);
 130                 CDEBUG(D_RPCTRACE, "Catalog index %u already clear?\n", index);
 131                 RETURN(-ENOENT);
 132         }
 133
 134         llh->llh_count--;
 135
 136         if ((llh->llh_flags & LLOG_F_ZAP_WHEN_EMPTY) &&
 137             (llh->llh_count == 1) &&
 138             (loghandle->lgh_last_idx == (LLOG_BITMAP_BYTES * 8) - 1)) {
 139                 spin_unlock(&loghandle->lgh_hdr_lock);
 140                 rc = llog_destroy(env, loghandle);
 141                 if (rc < 0) {
 142                         CERROR("%s: can't destroy empty llog #"DOSTID
 143                                "#%08x: rc = %d\n",
 144                                loghandle->lgh_ctxt->loc_obd->obd_name,
 145                                POSTID(&loghandle->lgh_id.lgl_oi),
 146                                loghandle->lgh_id.lgl_ogen, rc);
 147                         GOTO(out_err, rc);
 148                 }
 149                 RETURN(LLOG_DEL_PLAIN);
 150         }
 151         spin_unlock(&loghandle->lgh_hdr_lock);
 152
 153         rc = llog_write(env, loghandle, &llh->llh_hdr, LLOG_HEADER_IDX);
 154         if (rc < 0) {
 155                 CERROR("%s: fail to write header for llog #"DOSTID
 156                        "#%08x: rc = %d\n",
 157                        loghandle->lgh_ctxt->loc_obd->obd_name,
 158                        POSTID(&loghandle->lgh_id.lgl_oi),
 159                        loghandle->lgh_id.lgl_ogen, rc);
 160                 GOTO(out_err, rc);
 161         }
 162         RETURN(0);
 163 out_err:
 164         spin_lock(&loghandle->lgh_hdr_lock);
 165         ext2_set_bit(index, llh->llh_bitmap);
 166         llh->llh_count++;
 167         spin_unlock(&loghandle->lgh_hdr_lock);
 168         return rc;
 169 }
 170 EXPORT_SYMBOL(llog_cancel_rec);
 171
 172 static int llog_read_header(const struct lu_env *env,
 173                             struct llog_handle *handle,
 174                             struct obd_uuid *uuid)
 175 {
 176         struct llog_operations *lop;
 177         int rc;
 178
 179         rc = llog_handle2ops(handle, &lop);
 180         if (rc)
 181                 RETURN(rc);
 182
 183         if (lop->lop_read_header == NULL)
 184                 RETURN(-EOPNOTSUPP);
 185
 186         rc = lop->lop_read_header(env, handle);
 187         if (rc == LLOG_EEMPTY) {
 188                 struct llog_log_hdr *llh = handle->lgh_hdr;
 189
 190                 handle->lgh_last_idx = 0; /* header is record with index 0 */
 191                 llh->llh_count = 1;         /* for the header record */
 192                 llh->llh_hdr.lrh_type = LLOG_HDR_MAGIC;
 193                 llh->llh_hdr.lrh_len = llh->llh_tail.lrt_len = LLOG_CHUNK_SIZE;
 194                 llh->llh_hdr.lrh_index = llh->llh_tail.lrt_index = 0;
 195                 llh->llh_timestamp = cfs_time_current_sec();
 196                 if (uuid)
 197                         memcpy(&llh->llh_tgtuuid, uuid,
 198                                sizeof(llh->llh_tgtuuid));
 199                 llh->llh_bitmap_offset = offsetof(typeof(*llh), llh_bitmap);
 200                 ext2_set_bit(0, llh->llh_bitmap);
 201                 rc = 0;
 202         }
 203         return rc;
 204 }
 205
 206 int llog_init_handle(const struct lu_env *env, struct llog_handle *handle,
 207                      int flags, struct obd_uuid *uuid)
 208 {
 209         struct llog_log_hdr     *llh;
 210         int                      rc;
 211
 212         ENTRY;
 213         LASSERT(handle->lgh_hdr == NULL);
 214
 215         OBD_ALLOC_PTR(llh);
 216         if (llh == NULL)
 217                 RETURN(-ENOMEM);
 218         handle->lgh_hdr = llh;
 219         /* first assign flags to use llog_client_ops */
 220         llh->llh_flags = flags;
 221         rc = llog_read_header(env, handle, uuid);
 222         if (rc == 0) {
 223                 if (unlikely((llh->llh_flags & LLOG_F_IS_PLAIN &&
 224                               flags & LLOG_F_IS_CAT) ||
 225                              (llh->llh_flags & LLOG_F_IS_CAT &&
 226                               flags & LLOG_F_IS_PLAIN))) {
 227                         CERROR("%s: llog type is %s but initializing %s\n",
 228                                handle->lgh_ctxt->loc_obd->obd_name,
 229                                llh->llh_flags & LLOG_F_IS_CAT ?
 230                                "catalog" : "plain",
 231                                flags & LLOG_F_IS_CAT ? "catalog" : "plain");
 232                         GOTO(out, rc = -EINVAL);
 233                 } else if (llh->llh_flags &
 234                            (LLOG_F_IS_PLAIN | LLOG_F_IS_CAT)) {
 235                         /*
 236                          * it is possible to open llog without specifying llog
 237                          * type so it is taken from llh_flags
 238                          */
 239                         flags = llh->llh_flags;
 240                 } else {
 241                         /* for some reason the llh_flags has no type set */
 242                         CERROR("llog type is not specified!\n");
 243                         GOTO(out, rc = -EINVAL);
 244                 }
 245                 if (unlikely(uuid &&
 246                              !obd_uuid_equals(uuid, &llh->llh_tgtuuid))) {
 247                         CERROR("%s: llog uuid mismatch: %s/%s\n",
 248                                handle->lgh_ctxt->loc_obd->obd_name,
 249                                (char *)uuid->uuid,
 250                                (char *)llh->llh_tgtuuid.uuid);
 251                         GOTO(out, rc = -EEXIST);
 252                 }
 253         }
 254         if (flags & LLOG_F_IS_CAT) {
 255                 LASSERT(cfs_list_empty(&handle->u.chd.chd_head));
 256                 CFS_INIT_LIST_HEAD(&handle->u.chd.chd_head);
 257                 llh->llh_size = sizeof(struct llog_logid_rec);
 258         } else if (!(flags & LLOG_F_IS_PLAIN)) {
 259                 CERROR("%s: unknown flags: %#x (expected %#x or %#x)\n",
 260                        handle->lgh_ctxt->loc_obd->obd_name,
 261                        flags, LLOG_F_IS_CAT, LLOG_F_IS_PLAIN);
 262                 rc = -EINVAL;
 263         }
 264 out:
 265         if (rc) {
 266                 OBD_FREE_PTR(llh);
 267                 handle->lgh_hdr = NULL;
 268         }
 269         RETURN(rc);
 270 }
 271 EXPORT_SYMBOL(llog_init_handle);
 272
 273 static int llog_process_thread(void *arg)
 274 {
 275         struct llog_process_info        *lpi = arg;
 276         struct llog_handle              *loghandle = lpi->lpi_loghandle;
 277         struct llog_log_hdr             *llh = loghandle->lgh_hdr;
 278         struct llog_process_cat_data    *cd  = lpi->lpi_catdata;
 279         char                            *buf;
 280         __u64                            cur_offset = LLOG_CHUNK_SIZE;
 281         __u64                            last_offset;
 282         int                              rc = 0, index = 1, last_index;
 283         int                              saved_index = 0;
 284         int                              last_called_index = 0;
 285
 286         ENTRY;
 287
 288         LASSERT(llh);
 289
 290         OBD_ALLOC(buf, LLOG_CHUNK_SIZE);
 291         if (!buf) {
 292                 lpi->lpi_rc = -ENOMEM;
 293                 RETURN(0);
 294         }
 295
 296         if (cd != NULL) {
 297                 last_called_index = cd->lpcd_first_idx;
 298                 index = cd->lpcd_first_idx + 1;
 299         }
 300         if (cd != NULL && cd->lpcd_last_idx)
 301                 last_index = cd->lpcd_last_idx;
 302         else
 303                 last_index = LLOG_BITMAP_BYTES * 8 - 1;
 304
 305         while (rc == 0) {
 306                 struct llog_rec_hdr *rec;
 307
 308                 /* skip records not set in bitmap */
 309                 while (index <= last_index &&
 310                        !ext2_test_bit(index, llh->llh_bitmap))
 311                         ++index;
 312
 313                 LASSERT(index <= last_index + 1);
 314                 if (index == last_index + 1)
 315                         break;
 316 repeat:
 317                 CDEBUG(D_OTHER, "index: %d last_index %d\n",
 318                        index, last_index);
 319
 320                 /* get the buf with our target record; avoid old garbage */
 321                 memset(buf, 0, LLOG_CHUNK_SIZE);
 322                 last_offset = cur_offset;
 323                 rc = llog_next_block(lpi->lpi_env, loghandle, &saved_index,
 324                                      index, &cur_offset, buf, LLOG_CHUNK_SIZE);
 325                 if (rc)
 326                         GOTO(out, rc);
 327
 328                 /* NB: when rec->lrh_len is accessed it is already swabbed
 329                  * since it is used at the "end" of the loop and the rec
 330                  * swabbing is done at the beginning of the loop. */
 331                 for (rec = (struct llog_rec_hdr *)buf;
 332                      (char *)rec < buf + LLOG_CHUNK_SIZE;
 333                      rec = (struct llog_rec_hdr *)((char *)rec + rec->lrh_len)){
 334
 335                         CDEBUG(D_OTHER, "processing rec 0x%p type %#x\n",
 336                                rec, rec->lrh_type);
 337
 338                         if (LLOG_REC_HDR_NEEDS_SWABBING(rec))
 339                                 lustre_swab_llog_rec(rec);
 340
 341                         CDEBUG(D_OTHER, "after swabbing, type=%#x idx=%d\n",
 342                                rec->lrh_type, rec->lrh_index);
 343
 344                         if (rec->lrh_index == 0) {
 345                                 /* probably another rec just got added? */
 346                                 if (index <= loghandle->lgh_last_idx)
 347                                         GOTO(repeat, rc = 0);
 348                                 GOTO(out, rc = 0); /* no more records */
 349                         }
 350                         if (rec->lrh_len == 0 ||
 351                             rec->lrh_len > LLOG_CHUNK_SIZE) {
 352                                 CWARN("invalid length %d in llog record for "
 353                                       "index %d/%d\n", rec->lrh_len,
 354                                       rec->lrh_index, index);
 355                                 GOTO(out, rc = -EINVAL);
 356                         }
 357
 358                         if (rec->lrh_index < index) {
 359                                 CDEBUG(D_OTHER, "skipping lrh_index %d\n",
 360                                        rec->lrh_index);
 361                                 continue;
 362                         }
 363
 364                         CDEBUG(D_OTHER,
 365                                "lrh_index: %d lrh_len: %d (%d remains)\n",
 366                                rec->lrh_index, rec->lrh_len,
 367                                (int)(buf + LLOG_CHUNK_SIZE - (char *)rec));
 368
 369                         loghandle->lgh_cur_idx = rec->lrh_index;
 370                         loghandle->lgh_cur_offset = (char *)rec - (char *)buf +
 371                                                     last_offset;
 372
 373                         /* if set, process the callback on this record */
 374                         if (ext2_test_bit(index, llh->llh_bitmap)) {
 375                                 rc = lpi->lpi_cb(lpi->lpi_env, loghandle, rec,
 376                                                  lpi->lpi_cbdata);
 377                                 last_called_index = index;
 378                                 if (rc == LLOG_PROC_BREAK) {
 379                                         GOTO(out, rc);
 380                                 } else if (rc == LLOG_DEL_RECORD) {
 381                                         rc = llog_cancel_rec(lpi->lpi_env,
 382                                                              loghandle,
 383                                                              rec->lrh_index);
 384                                 }
 385                                 if (rc)
 386                                         GOTO(out, rc);
 387                         } else {
 388                                 CDEBUG(D_OTHER, "Skipped index %d\n", index);
 389                         }
 390
 391                         /* next record, still in buffer? */
 392                         ++index;
 393                         if (index > last_index)
 394                                 GOTO(out, rc = 0);
 395                 }
 396         }
 397
 398 out:
 399         if (cd != NULL)
 400                 cd->lpcd_last_idx = last_called_index;
 401
 402         if (unlikely(rc == -EIO)) {
 403                 /* something bad happened to the processing, probably I/O
 404                  * error or the log got corrupted..
 405                  * to be able to finally release the log we discard any
 406                  * remaining bits in the header */
 407                 CERROR("llog found corrupted\n");
 408                 while (index <= last_index) {
 409                         if (ext2_test_bit(index, llh->llh_bitmap) != 0)
 410                                 llog_cancel_rec(lpi->lpi_env, loghandle, index);
 411                         index++;
 412                 }
 413                 rc = 0;
 414         }
 415
 416         OBD_FREE(buf, LLOG_CHUNK_SIZE);
 417         lpi->lpi_rc = rc;
 418         return 0;
 419 }
 420
 421 #ifdef __KERNEL__
 422 static int llog_process_thread_daemonize(void *arg)
 423 {
 424         struct llog_process_info        *lpi = arg;
 425         struct lu_env                    env;
 426         int                              rc;
 427
 428         unshare_fs_struct();
 429
 430         /* client env has no keys, tags is just 0 */
 431         rc = lu_env_init(&env, LCT_LOCAL | LCT_MG_THREAD);
 432         if (rc)
 433                 goto out;
 434         lpi->lpi_env = &env;
 435
 436         rc = llog_process_thread(arg);
 437
 438         lu_env_fini(&env);
 439 out:
 440         complete(&lpi->lpi_completion);
 441         return rc;
 442 }
 443 #endif
 444
 445 int llog_process_or_fork(const struct lu_env *env,
 446                          struct llog_handle *loghandle,
 447                          llog_cb_t cb, void *data, void *catdata, bool fork)
 448 {
 449         struct llog_process_info *lpi;
 450         int                      rc;
 451
 452         ENTRY;
 453
 454         OBD_ALLOC_PTR(lpi);
 455         if (lpi == NULL) {
 456                 CERROR("cannot alloc pointer\n");
 457                 RETURN(-ENOMEM);
 458         }
 459         lpi->lpi_loghandle = loghandle;
 460         lpi->lpi_cb        = cb;
 461         lpi->lpi_cbdata    = data;
 462         lpi->lpi_catdata   = catdata;
 463
 464 #ifdef __KERNEL__
 465         if (fork) {
 466                 struct task_struct *task;
 467
 468                 /* The new thread can't use parent env,
 469                  * init the new one in llog_process_thread_daemonize. */
 470                 lpi->lpi_env = NULL;
 471                 init_completion(&lpi->lpi_completion);
 472                 task = kthread_run(llog_process_thread_daemonize, lpi,
 473                                    "llog_process_thread");
 474                 if (IS_ERR(task)) {
 475                         rc = PTR_ERR(task);
 476                         CERROR("%s: cannot start thread: rc = %d\n",
 477                                loghandle->lgh_ctxt->loc_obd->obd_name, rc);
 478                         GOTO(out_lpi, rc);
 479                 }
 480                 wait_for_completion(&lpi->lpi_completion);
 481         } else {
 482                 lpi->lpi_env = env;
 483                 llog_process_thread(lpi);
 484         }
 485 #else
 486         lpi->lpi_env = env;
 487         llog_process_thread(lpi);
 488 #endif
 489         rc = lpi->lpi_rc;
 490
 491 #ifdef __KERNEL__
 492 out_lpi:
 493 #endif
 494         OBD_FREE_PTR(lpi);
 495         RETURN(rc);
 496 }
 497 EXPORT_SYMBOL(llog_process_or_fork);
 498
 499 int llog_process(const struct lu_env *env, struct llog_handle *loghandle,
 500                  llog_cb_t cb, void *data, void *catdata)
 501 {
 502         int rc;
 503         rc = llog_process_or_fork(env, loghandle, cb, data, catdata, true);
 504         return rc == LLOG_DEL_PLAIN ? 0 : rc;
 505 }
 506 EXPORT_SYMBOL(llog_process);
 507
 508 int llog_reverse_process(const struct lu_env *env,
 509                          struct llog_handle *loghandle, llog_cb_t cb,
 510                          void *data, void *catdata)
 511 {
 512         struct llog_log_hdr *llh = loghandle->lgh_hdr;
 513         struct llog_process_cat_data *cd = catdata;
 514         void *buf;
 515         int rc = 0, first_index = 1, index, idx;
 516         ENTRY;
 517
 518         OBD_ALLOC(buf, LLOG_CHUNK_SIZE);
 519         if (!buf)
 520                 RETURN(-ENOMEM);
 521
 522         if (cd != NULL)
 523                 first_index = cd->lpcd_first_idx + 1;
 524         if (cd != NULL && cd->lpcd_last_idx)
 525                 index = cd->lpcd_last_idx;
 526         else
 527                 index = LLOG_BITMAP_BYTES * 8 - 1;
 528
 529         while (rc == 0) {
 530                 struct llog_rec_hdr *rec;
 531                 struct llog_rec_tail *tail;
 532
 533                 /* skip records not set in bitmap */
 534                 while (index >= first_index &&
 535                        !ext2_test_bit(index, llh->llh_bitmap))
 536                         --index;
 537
 538                 LASSERT(index >= first_index - 1);
 539                 if (index == first_index - 1)
 540                         break;
 541
 542                 /* get the buf with our target record; avoid old garbage */
 543                 memset(buf, 0, LLOG_CHUNK_SIZE);
 544                 rc = llog_prev_block(env, loghandle, index, buf,
 545                                      LLOG_CHUNK_SIZE);
 546                 if (rc)
 547                         GOTO(out, rc);
 548
 549                 rec = buf;
 550                 idx = rec->lrh_index;
 551                 CDEBUG(D_RPCTRACE, "index %u : idx %u\n", index, idx);
 552                 while (idx < index) {
 553                         rec = (void *)rec + rec->lrh_len;
 554                         if (LLOG_REC_HDR_NEEDS_SWABBING(rec))
 555                                 lustre_swab_llog_rec(rec);
 556                         idx ++;
 557                 }
 558                 LASSERT(idx == index);
 559                 tail = (void *)rec + rec->lrh_len - sizeof(*tail);
 560
 561                 /* process records in buffer, starting where we found one */
 562                 while ((void *)tail > buf) {
 563                         if (tail->lrt_index == 0)
 564                                 GOTO(out, rc = 0); /* no more records */
 565
 566                         /* if set, process the callback on this record */
 567                         if (ext2_test_bit(index, llh->llh_bitmap)) {
 568                                 rec = (void *)tail - tail->lrt_len +
 569                                       sizeof(*tail);
 570
 571                                 rc = cb(env, loghandle, rec, data);
 572                                 if (rc == LLOG_PROC_BREAK) {
 573                                         GOTO(out, rc);
 574                                 } else if (rc == LLOG_DEL_RECORD) {
 575                                         rc = llog_cancel_rec(env, loghandle,
 576                                                              tail->lrt_index);
 577                                 }
 578                                 if (rc)
 579                                         GOTO(out, rc);
 580                         }
 581
 582                         /* previous record, still in buffer? */
 583                         --index;
 584                         if (index < first_index)
 585                                 GOTO(out, rc = 0);
 586                         tail = (void *)tail - tail->lrt_len;
 587                 }
 588         }
 589
 590 out:
 591         if (buf)
 592                 OBD_FREE(buf, LLOG_CHUNK_SIZE);
 593         RETURN(rc);
 594 }
 595 EXPORT_SYMBOL(llog_reverse_process);
 596
 597 /**
 598  * new llog API
 599  *
 600  * API functions:
 601  *      llog_open - open llog, may not exist
 602  *      llog_exist - check if llog exists
 603  *      llog_close - close opened llog, pair for open, frees llog_handle
 604  *      llog_declare_create - declare llog creation
 605  *      llog_create - create new llog on disk, need transaction handle
 606  *      llog_declare_write_rec - declaration of llog write
 607  *      llog_write_rec - write llog record on disk, need transaction handle
 608  *      llog_declare_add - declare llog catalog record addition
 609  *      llog_add - add llog record in catalog, need transaction handle
 610  */
 611 int llog_exist(struct llog_handle *loghandle)
 612 {
 613         struct llog_operations  *lop;
 614         int                      rc;
 615
 616         ENTRY;
 617
 618         rc = llog_handle2ops(loghandle, &lop);
 619         if (rc)
 620                 RETURN(rc);
 621         if (lop->lop_exist == NULL)
 622                 RETURN(-EOPNOTSUPP);
 623
 624         rc = lop->lop_exist(loghandle);
 625         RETURN(rc);
 626 }
 627 EXPORT_SYMBOL(llog_exist);
 628
 629 int llog_declare_create(const struct lu_env *env,
 630                         struct llog_handle *loghandle, struct thandle *th)
 631 {
 632         struct llog_operations  *lop;
 633         int                      raised, rc;
 634
 635         ENTRY;
 636
 637         rc = llog_handle2ops(loghandle, &lop);
 638         if (rc)
 639                 RETURN(rc);
 640         if (lop->lop_declare_create == NULL)
 641                 RETURN(-EOPNOTSUPP);
 642
 643         raised = cfs_cap_raised(CFS_CAP_SYS_RESOURCE);
 644         if (!raised)
 645                 cfs_cap_raise(CFS_CAP_SYS_RESOURCE);
 646         rc = lop->lop_declare_create(env, loghandle, th);
 647         if (!raised)
 648                 cfs_cap_lower(CFS_CAP_SYS_RESOURCE);
 649         RETURN(rc);
 650 }
 651 EXPORT_SYMBOL(llog_declare_create);
 652
 653 int llog_create(const struct lu_env *env, struct llog_handle *handle,
 654                 struct thandle *th)
 655 {
 656         struct llog_operations  *lop;
 657         int                      raised, rc;
 658
 659         ENTRY;
 660
 661         rc = llog_handle2ops(handle, &lop);
 662         if (rc)
 663                 RETURN(rc);
 664         if (lop->lop_create == NULL)
 665                 RETURN(-EOPNOTSUPP);
 666
 667         raised = cfs_cap_raised(CFS_CAP_SYS_RESOURCE);
 668         if (!raised)
 669                 cfs_cap_raise(CFS_CAP_SYS_RESOURCE);
 670         rc = lop->lop_create(env, handle, th);
 671         if (!raised)
 672                 cfs_cap_lower(CFS_CAP_SYS_RESOURCE);
 673         RETURN(rc);
 674 }
 675 EXPORT_SYMBOL(llog_create);
 676
 677 int llog_declare_write_rec(const struct lu_env *env,
 678                            struct llog_handle *handle,
 679                            struct llog_rec_hdr *rec, int idx,
 680                            struct thandle *th)
 681 {
 682         struct llog_operations  *lop;
 683         int                      raised, rc;
 684
 685         ENTRY;
 686
 687         rc = llog_handle2ops(handle, &lop);
 688         if (rc)
 689                 RETURN(rc);
 690         LASSERT(lop);
 691         if (lop->lop_declare_write_rec == NULL)
 692                 RETURN(-EOPNOTSUPP);
 693
 694         raised = cfs_cap_raised(CFS_CAP_SYS_RESOURCE);
 695         if (!raised)
 696                 cfs_cap_raise(CFS_CAP_SYS_RESOURCE);
 697         rc = lop->lop_declare_write_rec(env, handle, rec, idx, th);
 698         if (!raised)
 699                 cfs_cap_lower(CFS_CAP_SYS_RESOURCE);
 700         RETURN(rc);
 701 }
 702 EXPORT_SYMBOL(llog_declare_write_rec);
 703
 704 int llog_write_rec(const struct lu_env *env, struct llog_handle *handle,
 705                    struct llog_rec_hdr *rec, struct llog_cookie *logcookies,
 706                    int idx, struct thandle *th)
 707 {
 708         struct llog_operations  *lop;
 709         int                      raised, rc, buflen;
 710
 711         ENTRY;
 712
 713         rc = llog_handle2ops(handle, &lop);
 714         if (rc)
 715                 RETURN(rc);
 716
 717         LASSERT(lop);
 718         if (lop->lop_write_rec == NULL)
 719                 RETURN(-EOPNOTSUPP);
 720
 721         buflen = rec->lrh_len;
 722         LASSERT(cfs_size_round(buflen) == buflen);
 723
 724         raised = cfs_cap_raised(CFS_CAP_SYS_RESOURCE);
 725         if (!raised)
 726                 cfs_cap_raise(CFS_CAP_SYS_RESOURCE);
 727         rc = lop->lop_write_rec(env, handle, rec, logcookies, idx, th);
 728         if (!raised)
 729                 cfs_cap_lower(CFS_CAP_SYS_RESOURCE);
 730         RETURN(rc);
 731 }
 732 EXPORT_SYMBOL(llog_write_rec);
 733
 734 int llog_add(const struct lu_env *env, struct llog_handle *lgh,
 735              struct llog_rec_hdr *rec, struct llog_cookie *logcookies,
 736              struct thandle *th)
 737 {
 738         int raised, rc;
 739
 740         ENTRY;
 741
 742         if (lgh->lgh_logops->lop_add == NULL)
 743                 RETURN(-EOPNOTSUPP);
 744
 745         raised = cfs_cap_raised(CFS_CAP_SYS_RESOURCE);
 746         if (!raised)
 747                 cfs_cap_raise(CFS_CAP_SYS_RESOURCE);
 748         rc = lgh->lgh_logops->lop_add(env, lgh, rec, logcookies, th);
 749         if (!raised)
 750                 cfs_cap_lower(CFS_CAP_SYS_RESOURCE);
 751         RETURN(rc);
 752 }
 753 EXPORT_SYMBOL(llog_add);
 754
 755 int llog_declare_add(const struct lu_env *env, struct llog_handle *lgh,
 756                      struct llog_rec_hdr *rec, struct thandle *th)
 757 {
 758         int raised, rc;
 759
 760         ENTRY;
 761
 762         if (lgh->lgh_logops->lop_declare_add == NULL)
 763                 RETURN(-EOPNOTSUPP);
 764
 765         raised = cfs_cap_raised(CFS_CAP_SYS_RESOURCE);
 766         if (!raised)
 767                 cfs_cap_raise(CFS_CAP_SYS_RESOURCE);
 768         rc = lgh->lgh_logops->lop_declare_add(env, lgh, rec, th);
 769         if (!raised)
 770                 cfs_cap_lower(CFS_CAP_SYS_RESOURCE);
 771         RETURN(rc);
 772 }
 773 EXPORT_SYMBOL(llog_declare_add);
 774
 775 /**
 776  * Helper function to open llog or create it if doesn't exist.
 777  * It hides all transaction handling from caller.
 778  */
 779 int llog_open_create(const struct lu_env *env, struct llog_ctxt *ctxt,
 780                      struct llog_handle **res, struct llog_logid *logid,
 781                      char *name)
 782 {
 783         struct dt_device        *d;
 784         struct thandle          *th;
 785         int                      rc;
 786
 787         ENTRY;
 788
 789         rc = llog_open(env, ctxt, res, logid, name, LLOG_OPEN_NEW);
 790         if (rc)
 791                 RETURN(rc);
 792
 793         if (llog_exist(*res))
 794                 RETURN(0);
 795
 796         LASSERT((*res)->lgh_obj != NULL);
 797
 798         d = lu2dt_dev((*res)->lgh_obj->do_lu.lo_dev);
 799
 800         th = dt_trans_create(env, d);
 801         if (IS_ERR(th))
 802                 GOTO(out, rc = PTR_ERR(th));
 803
 804         rc = llog_declare_create(env, *res, th);
 805         if (rc == 0) {
 806                 rc = dt_trans_start_local(env, d, th);
 807                 if (rc == 0)
 808                         rc = llog_create(env, *res, th);
 809         }
 810         dt_trans_stop(env, d, th);
 811 out:
 812         if (rc)
 813                 llog_close(env, *res);
 814         RETURN(rc);
 815 }
 816 EXPORT_SYMBOL(llog_open_create);
 817
 818 /**
 819  * Helper function to delete existent llog.
 820  */
 821 int llog_erase(const struct lu_env *env, struct llog_ctxt *ctxt,
 822                struct llog_logid *logid, char *name)
 823 {
 824         struct llog_handle      *handle;
 825         int                      rc = 0, rc2;
 826
 827         ENTRY;
 828
 829         /* nothing to erase */
 830         if (name == NULL && logid == NULL)
 831                 RETURN(0);
 832
 833         rc = llog_open(env, ctxt, &handle, logid, name, LLOG_OPEN_EXISTS);
 834         if (rc < 0)
 835                 RETURN(rc);
 836
 837         rc = llog_init_handle(env, handle, LLOG_F_IS_PLAIN, NULL);
 838         if (rc == 0)
 839                 rc = llog_destroy(env, handle);
 840
 841         rc2 = llog_close(env, handle);
 842         if (rc == 0)
 843                 rc = rc2;
 844         RETURN(rc);
 845 }
 846 EXPORT_SYMBOL(llog_erase);
 847
 848 /*
 849  * Helper function for write record in llog.
 850  * It hides all transaction handling from caller.
 851  * Valid only with local llog.
 852  */
 853 int llog_write(const struct lu_env *env, struct llog_handle *loghandle,
 854                struct llog_rec_hdr *rec, int idx)
 855 {
 856         struct dt_device        *dt;
 857         struct thandle          *th;
 858         int                      rc;
 859
 860         ENTRY;
 861
 862         LASSERT(loghandle);
 863         LASSERT(loghandle->lgh_ctxt);
 864         LASSERT(loghandle->lgh_obj != NULL);
 865
 866         dt = lu2dt_dev(loghandle->lgh_obj->do_lu.lo_dev);
 867
 868         th = dt_trans_create(env, dt);
 869         if (IS_ERR(th))
 870                 RETURN(PTR_ERR(th));
 871
 872         rc = llog_declare_write_rec(env, loghandle, rec, idx, th);
 873         if (rc)
 874                 GOTO(out_trans, rc);
 875
 876         rc = dt_trans_start_local(env, dt, th);
 877         if (rc)
 878                 GOTO(out_trans, rc);
 879
 880         down_write(&loghandle->lgh_lock);
 881         rc = llog_write_rec(env, loghandle, rec, NULL, idx, th);
 882         up_write(&loghandle->lgh_lock);
 883 out_trans:
 884         dt_trans_stop(env, dt, th);
 885         RETURN(rc);
 886 }
 887 EXPORT_SYMBOL(llog_write);
 888
 889 int llog_open(const struct lu_env *env, struct llog_ctxt *ctxt,
 890               struct llog_handle **lgh, struct llog_logid *logid,
 891               char *name, enum llog_open_param open_param)
 892 {
 893         int      raised;
 894         int      rc;
 895
 896         ENTRY;
 897
 898         LASSERT(ctxt);
 899         LASSERT(ctxt->loc_logops);
 900
 901         if (ctxt->loc_logops->lop_open == NULL) {
 902                 *lgh = NULL;
 903                 RETURN(-EOPNOTSUPP);
 904         }
 905
 906         *lgh = llog_alloc_handle();
 907         if (*lgh == NULL)
 908                 RETURN(-ENOMEM);
 909         (*lgh)->lgh_ctxt = ctxt;
 910         (*lgh)->lgh_logops = ctxt->loc_logops;
 911
 912         raised = cfs_cap_raised(CFS_CAP_SYS_RESOURCE);
 913         if (!raised)
 914                 cfs_cap_raise(CFS_CAP_SYS_RESOURCE);
 915         rc = ctxt->loc_logops->lop_open(env, *lgh, logid, name, open_param);
 916         if (!raised)
 917                 cfs_cap_lower(CFS_CAP_SYS_RESOURCE);
 918         if (rc) {
 919                 llog_free_handle(*lgh);
 920                 *lgh = NULL;
 921         }
 922         RETURN(rc);
 923 }
 924 EXPORT_SYMBOL(llog_open);
 925
 926 int llog_close(const struct lu_env *env, struct llog_handle *loghandle)
 927 {
 928         struct llog_operations  *lop;
 929         int                      rc;
 930
 931         ENTRY;
 932
 933         rc = llog_handle2ops(loghandle, &lop);
 934         if (rc)
 935                 GOTO(out, rc);
 936         if (lop->lop_close == NULL)
 937                 GOTO(out, rc = -EOPNOTSUPP);
 938         rc = lop->lop_close(env, loghandle);
 939 out:
 940         llog_handle_put(loghandle);
 941         RETURN(rc);
 942 }
 943 EXPORT_SYMBOL(llog_close);
 944
 945 /**
 946  * Helper function to get the llog size in records. It is used by MGS
 947  * mostly to check that config llog exists and contains data.
 948  *
 949  * \param[in] env       execution environment
 950  * \param[in] ctxt      llog context
 951  * \param[in] name      llog name
 952  *
 953  * \retval              true if there are records in llog besides a header
 954  * \retval              false on error or llog without records
 955  */
 956 int llog_is_empty(const struct lu_env *env, struct llog_ctxt *ctxt,
 957                   char *name)
 958 {
 959         struct llog_handle      *llh;
 960         int                      rc = 0;
 961
 962         rc = llog_open(env, ctxt, &llh, NULL, name, LLOG_OPEN_EXISTS);
 963         if (rc < 0) {
 964                 if (likely(rc == -ENOENT))
 965                         rc = 0;
 966                 GOTO(out, rc);
 967         }
 968
 969         rc = llog_init_handle(env, llh, LLOG_F_IS_PLAIN, NULL);
 970         if (rc)
 971                 GOTO(out_close, rc);
 972         rc = llog_get_size(llh);
 973
 974 out_close:
 975         llog_close(env, llh);
 976 out:
 977         /* The header is record 1, the llog is still considered as empty
 978          * if there is only header */
 979         return (rc <= 1);
 980 }
 981 EXPORT_SYMBOL(llog_is_empty);
 982
 983 int llog_copy_handler(const struct lu_env *env, struct llog_handle *llh,
 984                       struct llog_rec_hdr *rec, void *data)
 985 {
 986         struct llog_handle      *copy_llh = data;
 987
 988         /* Append all records */
 989         return llog_write(env, copy_llh, rec, LLOG_NEXT_IDX);
 990 }
 991 EXPORT_SYMBOL(llog_copy_handler);
 992
 993 /* backup plain llog */
 994 int llog_backup(const struct lu_env *env, struct obd_device *obd,
 995                 struct llog_ctxt *ctxt, struct llog_ctxt *bctxt,
 996                 char *name, char *backup)
 997 {
 998         struct llog_handle      *llh, *bllh;
 999         int                      rc;
1000
1001         ENTRY;
1002
1003         /* open original log */
1004         rc = llog_open(env, ctxt, &llh, NULL, name, LLOG_OPEN_EXISTS);
1005         if (rc < 0) {
1006                 /* the -ENOENT case is also reported to the caller
1007                  * but silently so it should handle that if needed.
1008                  */
1009                 if (rc != -ENOENT)
1010                         CERROR("%s: failed to open log %s: rc = %d\n",
1011                                obd->obd_name, name, rc);
1012                 RETURN(rc);
1013         }
1014
1015         rc = llog_init_handle(env, llh, LLOG_F_IS_PLAIN, NULL);
1016         if (rc)
1017                 GOTO(out_close, rc);
1018
1019         /* Make sure there's no old backup log */
1020         rc = llog_erase(env, bctxt, NULL, backup);
1021         if (rc < 0 && rc != -ENOENT)
1022                 GOTO(out_close, rc);
1023
1024         /* open backup log */
1025         rc = llog_open_create(env, bctxt, &bllh, NULL, backup);
1026         if (rc) {
1027                 CERROR("%s: failed to open backup logfile %s: rc = %d\n",
1028                        obd->obd_name, backup, rc);
1029                 GOTO(out_close, rc);
1030         }
1031
1032         /* check that backup llog is not the same object as original one */
1033         if (llh->lgh_obj == bllh->lgh_obj) {
1034                 CERROR("%s: backup llog %s to itself (%s), objects %p/%p\n",
1035                        obd->obd_name, name, backup, llh->lgh_obj,
1036                        bllh->lgh_obj);
1037                 GOTO(out_backup, rc = -EEXIST);
1038         }
1039
1040         rc = llog_init_handle(env, bllh, LLOG_F_IS_PLAIN, NULL);
1041         if (rc)
1042                 GOTO(out_backup, rc);
1043
1044         /* Copy log record by record */
1045         rc = llog_process_or_fork(env, llh, llog_copy_handler, (void *)bllh,
1046                                   NULL, false);
1047         if (rc)
1048                 CERROR("%s: failed to backup log %s: rc = %d\n",
1049                        obd->obd_name, name, rc);
1050 out_backup:
1051         llog_close(env, bllh);
1052 out_close:
1053         llog_close(env, llh);
1054         RETURN(rc);
1055 }
1056 EXPORT_SYMBOL(llog_backup);