lustre/obdclass/llog_cat.c

   1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
   2  * vim:expandtab:shiftwidth=8:tabstop=8:
   3  *
   4  *  Copyright (C) 2001-2003 Cluster File Systems, Inc.
   5  *   Author: Andreas Dilger <adilger@clusterfs.com>
   6  *
   7  *   This file is part of the Lustre file system, http://www.lustre.org
   8  *   Lustre is a trademark of Cluster File Systems, Inc.
   9  *
  10  *   You may have signed or agreed to another license before downloading
  11  *   this software.  If so, you are bound by the terms and conditions
  12  *   of that agreement, and the following does not apply to you.  See the
  13  *   LICENSE file included with this distribution for more information.
  14  *
  15  *   If you did not agree to a different license, then this copy of Lustre
  16  *   is open source software; you can redistribute it and/or modify it
  17  *   under the terms of version 2 of the GNU General Public License as
  18  *   published by the Free Software Foundation.
  19  *
  20  *   In either case, Lustre is distributed in the hope that it will be
  21  *   useful, but WITHOUT ANY WARRANTY; without even the implied warranty
  22  *   of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  23  *   license text for more details.
  24  *
  25  * OST<->MDS recovery logging infrastructure.
  26  *
  27  * Invariants in implementation:
  28  * - we do not share logs among different OST<->MDS connections, so that
  29  *   if an OST or MDS fails it need only look at log(s) relevant to itself
  30  */
  31
  32 #define DEBUG_SUBSYSTEM S_LOG
  33
  34 #ifndef EXPORT_SYMTAB
  35 #define EXPORT_SYMTAB
  36 #endif
  37
  38 #ifdef __KERNEL__
  39 #include <linux/fs.h>
  40 #else
  41 #include <liblustre.h>
  42 #endif
  43
  44 #include <linux/obd_class.h>
  45 #include <linux/lustre_log.h>
  46 #include <libcfs/list.h>
  47
  48 /* Create a new log handle and add it to the open list.
  49  * This log handle will be closed when all of the records in it are removed.
  50  *
  51  * Assumes caller has already pushed us into the kernel context and is locking.
  52  */
  53 static struct llog_handle *llog_cat_new_log(struct llog_handle *cathandle)
  54 {
  55         struct llog_handle *loghandle;
  56         struct llog_log_hdr *llh;
  57         struct llog_logid_rec rec = { { 0 }, };
  58         int rc, index, bitmap_size;
  59         ENTRY;
  60
  61         llh = cathandle->lgh_hdr;
  62         bitmap_size = LLOG_BITMAP_SIZE(llh);
  63
  64         index = (cathandle->lgh_last_idx + 1) % bitmap_size;
  65
  66         /* maximum number of available slots in catlog is bitmap_size - 2 */
  67         if (llh->llh_cat_idx == index) {
  68                 CERROR("no free catalog slots for log...\n");
  69                 RETURN(ERR_PTR(-ENOSPC));
  70         } else {
  71                 if (index == 0)
  72                         index = 1;
  73                 if (ext2_set_bit(index, llh->llh_bitmap)) {
  74                         CERROR("argh, index %u already set in log bitmap?\n",
  75                                index);
  76                         LBUG(); /* should never happen */
  77                 }
  78                 cathandle->lgh_last_idx = index;
  79                 llh->llh_count++;
  80                 llh->llh_tail.lrt_index = index;
  81         }
  82
  83         rc = llog_create(cathandle->lgh_ctxt, &loghandle, NULL, NULL, NULL);
  84         if (rc)
  85                 RETURN(ERR_PTR(rc));
  86
  87         rc = llog_init_handle(loghandle,
  88                               LLOG_F_IS_PLAIN | LLOG_F_ZAP_WHEN_EMPTY,
  89                               &cathandle->lgh_hdr->llh_tgtuuid);
  90         if (rc)
  91                 GOTO(out_destroy, rc);
  92
  93         CDEBUG(D_HA, "new recovery log "LPX64":%x for index %u of catalog "
  94                LPX64"\n", loghandle->lgh_id.lgl_oid, loghandle->lgh_id.lgl_ogen,
  95                index, cathandle->lgh_id.lgl_oid);
  96         /* build the record for this log in the catalog */
  97         rec.lid_hdr.lrh_len = sizeof(rec);
  98         rec.lid_hdr.lrh_index = index;
  99         rec.lid_hdr.lrh_type = LLOG_LOGID_MAGIC;
 100         rec.lid_id = loghandle->lgh_id;
 101         rec.lid_tail.lrt_len = sizeof(rec);
 102         rec.lid_tail.lrt_index = index;
 103
 104         /* update the catalog: header and record */
 105         rc = llog_write_rec(cathandle, &rec.lid_hdr,
 106                             &loghandle->u.phd.phd_cookie, 1, NULL, index);
 107         if (rc < 0) {
 108                 GOTO(out_destroy, rc);
 109         }
 110
 111         loghandle->lgh_hdr->llh_cat_idx = index;
 112         cathandle->u.chd.chd_current_log = loghandle;
 113         LASSERT(list_empty(&loghandle->u.phd.phd_entry));
 114         list_add_tail(&loghandle->u.phd.phd_entry, &cathandle->u.chd.chd_head);
 115
 116  out_destroy:
 117         if (rc < 0)
 118                 llog_destroy(loghandle);
 119
 120         RETURN(loghandle);
 121 }
 122 EXPORT_SYMBOL(llog_cat_new_log);
 123
 124 /* Open an existent log handle and add it to the open list.
 125  * This log handle will be closed when all of the records in it are removed.
 126  *
 127  * Assumes caller has already pushed us into the kernel context and is locking.
 128  * We return a lock on the handle to ensure nobody yanks it from us.
 129  */
 130 int llog_cat_id2handle(struct llog_handle *cathandle, struct llog_handle **res,
 131                        struct llog_logid *logid)
 132 {
 133         struct llog_handle *loghandle;
 134         int rc = 0;
 135         ENTRY;
 136
 137         if (cathandle == NULL)
 138                 RETURN(-EBADF);
 139
 140         list_for_each_entry(loghandle, &cathandle->u.chd.chd_head,
 141                             u.phd.phd_entry) {
 142                 struct llog_logid *cgl = &loghandle->lgh_id;
 143                 if (cgl->lgl_oid == logid->lgl_oid) {
 144                         if (cgl->lgl_ogen != logid->lgl_ogen) {
 145                                 CERROR("log "LPX64" generation %x != %x\n",
 146                                        logid->lgl_oid, cgl->lgl_ogen,
 147                                        logid->lgl_ogen);
 148                                 continue;
 149                         }
 150                         loghandle->u.phd.phd_cat_handle = cathandle;
 151                         GOTO(out, rc = 0);
 152                 }
 153         }
 154
 155         rc = llog_create(cathandle->lgh_ctxt, &loghandle, logid, NULL, NULL);
 156         if (rc) {
 157                 CERROR("error opening log id "LPX64":%x: rc %d\n",
 158                        logid->lgl_oid, logid->lgl_ogen, rc);
 159         } else {
 160                 rc = llog_init_handle(loghandle, LLOG_F_IS_PLAIN, NULL);
 161                 if (!rc) {
 162                         list_add(&loghandle->u.phd.phd_entry,
 163                                  &cathandle->u.chd.chd_head);
 164                 }
 165         }
 166         if (!rc) {
 167                 loghandle->u.phd.phd_cat_handle = cathandle;
 168                 loghandle->u.phd.phd_cookie.lgc_lgl = cathandle->lgh_id;
 169                 loghandle->u.phd.phd_cookie.lgc_index =
 170                         loghandle->lgh_hdr->llh_cat_idx;
 171         }
 172
 173 out:
 174         *res = loghandle;
 175         RETURN(rc);
 176 }
 177
 178 int llog_cat_put(struct llog_handle *cathandle)
 179 {
 180         struct llog_handle *loghandle, *n;
 181         int rc;
 182         ENTRY;
 183
 184         list_for_each_entry_safe(loghandle, n, &cathandle->u.chd.chd_head,
 185                                  u.phd.phd_entry) {
 186                 int err = llog_close(loghandle);
 187                 if (err)
 188                         CERROR("error closing loghandle\n");
 189         }
 190         rc = llog_close(cathandle);
 191         RETURN(rc);
 192 }
 193 EXPORT_SYMBOL(llog_cat_put);
 194
 195 /* Return the currently active log handle.  If the current log handle doesn't
 196  * have enough space left for the current record, start a new one.
 197  *
 198  * If reclen is 0, we only want to know what the currently active log is,
 199  * otherwise we get a lock on this log so nobody can steal our space.
 200  *
 201  * Assumes caller has already pushed us into the kernel context and is locking.
 202  *
 203  * NOTE: loghandle is write-locked upon successful return
 204  */
 205 static struct llog_handle *llog_cat_current_log(struct llog_handle *cathandle,
 206                                                 int create)
 207 {
 208         struct llog_handle *loghandle = NULL;
 209         ENTRY;
 210
 211         down_read(&cathandle->lgh_lock);
 212         loghandle = cathandle->u.chd.chd_current_log;
 213         if (loghandle) {
 214                 struct llog_log_hdr *llh = loghandle->lgh_hdr;
 215                 down_write(&loghandle->lgh_lock);
 216                 if (loghandle->lgh_last_idx < LLOG_BITMAP_SIZE(llh) - 1) {
 217                         up_read(&cathandle->lgh_lock);
 218                         RETURN(loghandle);
 219                 } else {
 220                         up_write(&loghandle->lgh_lock);
 221                 }
 222         }
 223         if (!create) {
 224                 if (loghandle)
 225                         down_write(&loghandle->lgh_lock);
 226                 up_read(&cathandle->lgh_lock);
 227                 RETURN(loghandle);
 228         }
 229         up_read(&cathandle->lgh_lock);
 230
 231         /* time to create new log */
 232
 233         /* first, we have to make sure the state hasn't changed */
 234         down_write(&cathandle->lgh_lock);
 235         loghandle = cathandle->u.chd.chd_current_log;
 236         if (loghandle) {
 237                 struct llog_log_hdr *llh = loghandle->lgh_hdr;
 238                 down_write(&loghandle->lgh_lock);
 239                 if (loghandle->lgh_last_idx < LLOG_BITMAP_SIZE(llh) - 1) {
 240                         up_write(&cathandle->lgh_lock);
 241                         RETURN(loghandle);
 242                 } else {
 243                         up_write(&loghandle->lgh_lock);
 244                 }
 245         }
 246
 247         CDEBUG(D_INODE, "creating new log\n");
 248         loghandle = llog_cat_new_log(cathandle);
 249         if (!IS_ERR(loghandle))
 250                 down_write(&loghandle->lgh_lock);
 251         up_write(&cathandle->lgh_lock);
 252         RETURN(loghandle);
 253 }
 254
 255 /* Add a single record to the recovery log(s) using a catalog
 256  * Returns as llog_write_record
 257  *
 258  * Assumes caller has already pushed us into the kernel context.
 259  */
 260 int llog_cat_add_rec(struct llog_handle *cathandle, struct llog_rec_hdr *rec,
 261                      struct llog_cookie *reccookie, void *buf)
 262 {
 263         struct llog_handle *loghandle;
 264         int rc;
 265         ENTRY;
 266
 267         LASSERT(rec->lrh_len <= LLOG_CHUNK_SIZE);
 268         loghandle = llog_cat_current_log(cathandle, 1);
 269         if (IS_ERR(loghandle))
 270                 RETURN(PTR_ERR(loghandle));
 271         /* loghandle is already locked by llog_cat_current_log() for us */
 272         rc = llog_write_rec(loghandle, rec, reccookie, 1, buf, -1);
 273         up_write(&loghandle->lgh_lock);
 274         if (rc == -ENOSPC) {
 275                 /* to create a new plain log */
 276                 loghandle = llog_cat_current_log(cathandle, 1);
 277                 if (IS_ERR(loghandle))
 278                         RETURN(PTR_ERR(loghandle));
 279                 rc = llog_write_rec(loghandle, rec, reccookie, 1, buf, -1);
 280                 up_write(&loghandle->lgh_lock);
 281         }
 282
 283         RETURN(rc);
 284 }
 285 EXPORT_SYMBOL(llog_cat_add_rec);
 286
 287 /* For each cookie in the cookie array, we clear the log in-use bit and either:
 288  * - the log is empty, so mark it free in the catalog header and delete it
 289  * - the log is not empty, just write out the log header
 290  *
 291  * The cookies may be in different log files, so we need to get new logs
 292  * each time.
 293  *
 294  * Assumes caller has already pushed us into the kernel context.
 295  */
 296 int llog_cat_cancel_records(struct llog_handle *cathandle, int count,
 297                         struct llog_cookie *cookies)
 298 {
 299         int i, index, rc = 0;
 300         ENTRY;
 301
 302         down_write(&cathandle->lgh_lock);
 303         for (i = 0; i < count; i++, cookies++) {
 304                 struct llog_handle *loghandle;
 305                 struct llog_logid *lgl = &cookies->lgc_lgl;
 306
 307                 rc = llog_cat_id2handle(cathandle, &loghandle, lgl);
 308                 if (rc) {
 309                         CERROR("Cannot find log "LPX64"\n", lgl->lgl_oid);
 310                         break;
 311                 }
 312
 313                 down_write(&loghandle->lgh_lock);
 314                 rc = llog_cancel_rec(loghandle, cookies->lgc_index);
 315                 up_write(&loghandle->lgh_lock);
 316
 317                 if (rc == 1) {          /* log has been destroyed */
 318                         index = loghandle->u.phd.phd_cookie.lgc_index;
 319                         if (cathandle->u.chd.chd_current_log == loghandle)
 320                                 cathandle->u.chd.chd_current_log = NULL;
 321                         llog_free_handle(loghandle);
 322
 323                         LASSERT(index);
 324                         llog_cat_set_first_idx(cathandle, index);
 325                         rc = llog_cancel_rec(cathandle, index);
 326                         if (rc == 0)
 327                                 CDEBUG(D_HA, "cancel plain log at index %u "
 328                                        "of catalog "LPX64"\n",
 329                                        index, cathandle->lgh_id.lgl_oid);
 330                 }
 331         }
 332         up_write(&cathandle->lgh_lock);
 333
 334         RETURN(rc);
 335 }
 336 EXPORT_SYMBOL(llog_cat_cancel_records);
 337
 338 int llog_cat_process_cb(struct llog_handle *cat_llh, struct llog_rec_hdr *rec,
 339                         void *data)
 340 {
 341         struct llog_process_data *d = data;
 342         struct llog_logid_rec *lir = (struct llog_logid_rec *)rec;
 343         struct llog_handle *llh;
 344         int rc;
 345
 346         if (rec->lrh_type != LLOG_LOGID_MAGIC) {
 347                 CERROR("invalid record in catalog\n");
 348                 RETURN(-EINVAL);
 349         }
 350         CWARN("processing log "LPX64":%x at index %u of catalog "LPX64"\n",
 351                lir->lid_id.lgl_oid, lir->lid_id.lgl_ogen,
 352                rec->lrh_index, cat_llh->lgh_id.lgl_oid);
 353
 354         rc = llog_cat_id2handle(cat_llh, &llh, &lir->lid_id);
 355         if (rc) {
 356                 CERROR("Cannot find handle for log "LPX64"\n",
 357                        lir->lid_id.lgl_oid);
 358                 RETURN(rc);
 359         }
 360
 361         rc = llog_process(llh, d->lpd_cb, d->lpd_data, NULL);
 362         RETURN(rc);
 363 }
 364
 365 int llog_cat_process(struct llog_handle *cat_llh, llog_cb_t cb, void *data)
 366 {
 367         struct llog_process_data d;
 368         struct llog_process_cat_data cd;
 369         struct llog_log_hdr *llh = cat_llh->lgh_hdr;
 370         int rc;
 371         ENTRY;
 372
 373         LASSERT(llh->llh_flags & LLOG_F_IS_CAT);
 374         d.lpd_data = data;
 375         d.lpd_cb = cb;
 376
 377         if (llh->llh_cat_idx > cat_llh->lgh_last_idx) {
 378                 CWARN("catlog "LPX64" crosses index zero\n",
 379                       cat_llh->lgh_id.lgl_oid);
 380
 381                 cd.first_idx = llh->llh_cat_idx;
 382                 cd.last_idx = 0;
 383                 rc = llog_process(cat_llh, llog_cat_process_cb, &d, &cd);
 384                 if (rc != 0)
 385                         RETURN(rc);
 386
 387                 cd.first_idx = 0;
 388                 cd.last_idx = cat_llh->lgh_last_idx;
 389                 rc = llog_process(cat_llh, llog_cat_process_cb, &d, &cd);
 390         } else {
 391                 rc = llog_process(cat_llh, llog_cat_process_cb, &d, NULL);
 392         }
 393
 394         RETURN(rc);
 395 }
 396 EXPORT_SYMBOL(llog_cat_process);
 397
 398 int llog_cat_set_first_idx(struct llog_handle *cathandle, int index)
 399 {
 400         struct llog_log_hdr *llh = cathandle->lgh_hdr;
 401         int i, bitmap_size, idx;
 402         ENTRY;
 403
 404         bitmap_size = LLOG_BITMAP_SIZE(llh);
 405         if (llh->llh_cat_idx == (index - 1)) {
 406                 idx = llh->llh_cat_idx + 1;
 407                 llh->llh_cat_idx = idx;
 408                 if (idx == cathandle->lgh_last_idx)
 409                         goto out;
 410                 for (i = (index + 1) % bitmap_size;
 411                      i != cathandle->lgh_last_idx;
 412                      i = (i + 1) % bitmap_size) {
 413                         if (!ext2_test_bit(i, llh->llh_bitmap)) {
 414                                 idx = llh->llh_cat_idx + 1;
 415                                 llh->llh_cat_idx = idx;
 416                         } else if (i == 0) {
 417                                 llh->llh_cat_idx = 0;
 418                         } else {
 419                                 break;
 420                         }
 421                 }
 422 out:
 423                 CDEBUG(D_HA, "set catlog "LPX64" first idx %u\n",
 424                        cathandle->lgh_id.lgl_oid, llh->llh_cat_idx);
 425         }
 426
 427         RETURN(0);
 428 }
 429
 430 #if 0
 431 /* Assumes caller has already pushed us into the kernel context. */
 432 int llog_cat_init(struct llog_handle *cathandle, struct obd_uuid *tgtuuid)
 433 {
 434         struct llog_log_hdr *llh;
 435         loff_t offset = 0;
 436         int rc = 0;
 437         ENTRY;
 438
 439         LASSERT(sizeof(*llh) == LLOG_CHUNK_SIZE);
 440
 441         down(&cathandle->lgh_lock);
 442         llh = cathandle->lgh_hdr;
 443
 444         if (cathandle->lgh_file->f_dentry->d_inode->i_size == 0) {
 445                 llog_write_rec(cathandle, &llh->llh_hdr, NULL, 0, NULL, 0);
 446
 447 write_hdr:
 448                 rc = lustre_fwrite(cathandle->lgh_file, llh, LLOG_CHUNK_SIZE,
 449                                    &offset);
 450                 if (rc != LLOG_CHUNK_SIZE) {
 451                         CERROR("error writing catalog header: rc %d\n", rc);
 452                         OBD_FREE(llh, sizeof(*llh));
 453                         if (rc >= 0)
 454                                 rc = -ENOSPC;
 455                 } else
 456                         rc = 0;
 457         } else {
 458                 rc = lustre_fread(cathandle->lgh_file, llh, LLOG_CHUNK_SIZE,
 459                                   &offset);
 460                 if (rc != LLOG_CHUNK_SIZE) {
 461                         CERROR("error reading catalog header: rc %d\n", rc);
 462                         /* Can we do much else if the header is bad? */
 463                         goto write_hdr;
 464                 } else
 465                         rc = 0;
 466         }
 467
 468         cathandle->lgh_tgtuuid = &llh->llh_tgtuuid;
 469         up(&cathandle->lgh_lock);
 470         RETURN(rc);
 471 }
 472 EXPORT_SYMBOL(llog_cat_init);
 473
 474 #endif