lustre/obdclass/llog_obd.c

   1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
   2  * vim:expandtab:shiftwidth=8:tabstop=8:
   3  *
   4  * GPL HEADER START
   5  *
   6  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License version 2 only,
  10  * as published by the Free Software Foundation.
  11  *
  12  * This program is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * General Public License version 2 for more details (a copy is included
  16  * in the LICENSE file that accompanied this code).
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * version 2 along with this program; If not, see
  20  * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
  21  *
  22  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
  23  * CA 95054 USA or visit www.sun.com if you need additional information or
  24  * have any questions.
  25  *
  26  * GPL HEADER END
  27  */
  28 /*
  29  * Copyright  2008 Sun Microsystems, Inc. All rights reserved
  30  * Use is subject to license terms.
  31  */
  32 /*
  33  * This file is part of Lustre, http://www.lustre.org/
  34  * Lustre is a trademark of Sun Microsystems, Inc.
  35  */
  36
  37 #define DEBUG_SUBSYSTEM S_LOG
  38
  39 #ifndef EXPORT_SYMTAB
  40 #define EXPORT_SYMTAB
  41 #endif
  42
  43 #ifndef __KERNEL__
  44 #include <liblustre.h>
  45 #endif
  46
  47 #include <obd_class.h>
  48 #include <lustre_log.h>
  49 #include <libcfs/list.h>
  50 #include "llog_internal.h"
  51
  52 /* helper functions for calling the llog obd methods */
  53 static struct llog_ctxt* llog_new_ctxt(struct obd_device *obd)
  54 {
  55         struct llog_ctxt *ctxt;
  56
  57         OBD_ALLOC_PTR(ctxt);
  58         if (!ctxt)
  59                 return NULL;
  60
  61         ctxt->loc_obd = obd;
  62         atomic_set(&ctxt->loc_refcount, 1);
  63
  64         return ctxt;
  65 }
  66
  67 static void llog_ctxt_destroy(struct llog_ctxt *ctxt)
  68 {
  69         if (ctxt->loc_exp)
  70                 class_export_put(ctxt->loc_exp);
  71         if (ctxt->loc_imp) {
  72                 class_import_put(ctxt->loc_imp);
  73                 ctxt->loc_imp = NULL;
  74         }
  75         LASSERT(ctxt->loc_llcd == NULL);
  76         OBD_FREE_PTR(ctxt);
  77         return;
  78 }
  79
  80 int __llog_ctxt_put(struct llog_ctxt *ctxt)
  81 {
  82         struct obd_llog_group *olg = ctxt->loc_olg;
  83         struct obd_device *obd;
  84         int rc = 0;
  85
  86         spin_lock(&olg->olg_lock);
  87         if (!atomic_dec_and_test(&ctxt->loc_refcount)) {
  88                 spin_unlock(&olg->olg_lock);
  89                 return rc;
  90         }
  91         olg->olg_ctxts[ctxt->loc_idx] = NULL;
  92         spin_unlock(&olg->olg_lock);
  93
  94         obd = ctxt->loc_obd;
  95         spin_lock(&obd->obd_dev_lock);
  96         spin_unlock(&obd->obd_dev_lock); /* sync with llog ctxt user thread */
  97
  98         /* obd->obd_starting is needed for the case of cleanup
  99          * in error case while obd is starting up. */
 100         LASSERTF(obd->obd_starting == 1 ||
 101                  obd->obd_stopping == 1 || obd->obd_set_up == 0,
 102                  "wrong obd state: %d/%d/%d\n", !!obd->obd_starting,
 103                  !!obd->obd_stopping, !!obd->obd_set_up);
 104
 105         /* cleanup the llog ctxt here */
 106         if (CTXTP(ctxt, cleanup))
 107                 rc = CTXTP(ctxt, cleanup)(ctxt);
 108
 109         llog_ctxt_destroy(ctxt);
 110         wake_up(&olg->olg_waitq);
 111         return rc;
 112 }
 113 EXPORT_SYMBOL(__llog_ctxt_put);
 114
 115 int llog_cleanup(struct llog_ctxt *ctxt)
 116 {
 117         struct l_wait_info lwi = LWI_INTR(LWI_ON_SIGNAL_NOOP, NULL);
 118         struct obd_llog_group *olg;
 119         int rc, idx;
 120         ENTRY;
 121
 122         if (!ctxt) {
 123                 CERROR("No ctxt\n");
 124                 RETURN(-ENODEV);
 125         }
 126
 127         olg = ctxt->loc_olg;
 128         idx = ctxt->loc_idx;
 129
 130         /* banlance the ctxt get when calling llog_cleanup */
 131         LASSERT(atomic_read(&ctxt->loc_refcount) > 1);
 132         llog_ctxt_put(ctxt);
 133
 134         /* try to free the ctxt */
 135         rc = __llog_ctxt_put(ctxt);
 136         if (rc)
 137                 CERROR("Error %d while cleaning up ctxt %p\n",
 138                        rc, ctxt);
 139
 140         l_wait_event(olg->olg_waitq,
 141                      llog_group_ctxt_null(olg, idx), &lwi);
 142
 143         RETURN(rc);
 144 }
 145 EXPORT_SYMBOL(llog_cleanup);
 146
 147 int llog_setup(struct obd_device *obd,  struct obd_llog_group *olg, int index,
 148                struct obd_device *disk_obd, int count, struct llog_logid *logid,
 149                struct llog_operations *op)
 150 {
 151         int rc = 0;
 152         struct llog_ctxt *ctxt;
 153         ENTRY;
 154
 155         if (index < 0 || index >= LLOG_MAX_CTXTS)
 156                 RETURN(-EFAULT);
 157
 158         LASSERT(olg != NULL);
 159
 160         ctxt = llog_new_ctxt(obd);
 161         if (!ctxt)
 162                 GOTO(out, rc = -ENOMEM);
 163
 164         ctxt->loc_obd = obd;
 165         ctxt->loc_exp = class_export_get(disk_obd->obd_self_export);
 166         ctxt->loc_olg = olg;
 167         ctxt->loc_idx = index;
 168         ctxt->loc_logops = op;
 169         sema_init(&ctxt->loc_sem, 1);
 170
 171         rc = llog_group_set_ctxt(olg, ctxt, index);
 172         if (rc) {
 173                 llog_ctxt_destroy(ctxt);
 174                 if (rc == -EEXIST) {
 175                         /* sanity check */
 176                         ctxt = llog_group_get_ctxt(olg, index);
 177
 178                         /* mds_lov_update_mds might call here multiple times.
 179                          * So if the llog is already set up then don't to do
 180                          * it again. */
 181                         CDEBUG(D_CONFIG, "obd %s ctxt %d already set up\n",
 182                                 obd->obd_name, index);
 183                         LASSERT(ctxt->loc_olg == olg);
 184                         LASSERT(ctxt->loc_obd == obd);
 185                         LASSERT(ctxt->loc_exp == disk_obd->obd_self_export);
 186                         LASSERT(ctxt->loc_logops == op);
 187                         llog_ctxt_put(ctxt);
 188                         rc = 0;
 189                 }
 190                 GOTO(out, rc);
 191         }
 192
 193         if (op->lop_setup)
 194                 rc = op->lop_setup(obd, olg, index, disk_obd, count, logid);
 195
 196         if (rc) {
 197                 llog_ctxt_destroy(ctxt);
 198         }
 199 out:
 200         RETURN(rc);
 201 }
 202 EXPORT_SYMBOL(llog_setup);
 203
 204 int llog_sync(struct llog_ctxt *ctxt, struct obd_export *exp)
 205 {
 206         int rc = 0;
 207         ENTRY;
 208
 209         if (!ctxt)
 210                 RETURN(0);
 211
 212         if (CTXTP(ctxt, sync))
 213                 rc = CTXTP(ctxt, sync)(ctxt, exp);
 214
 215         RETURN(rc);
 216 }
 217 EXPORT_SYMBOL(llog_sync);
 218
 219 int llog_add(struct llog_ctxt *ctxt, struct llog_rec_hdr *rec,
 220              struct lov_stripe_md *lsm, struct llog_cookie *logcookies,
 221              int numcookies)
 222 {
 223         int raised, rc;
 224         ENTRY;
 225
 226         if (!ctxt) {
 227                 CERROR("No ctxt\n");
 228                 RETURN(-ENODEV);
 229         }
 230
 231         CTXT_CHECK_OP(ctxt, add, -EOPNOTSUPP);
 232         raised = cfs_cap_raised(CFS_CAP_SYS_RESOURCE);
 233         if (!raised)
 234                 cfs_cap_raise(CFS_CAP_SYS_RESOURCE);
 235         rc = CTXTP(ctxt, add)(ctxt, rec, lsm, logcookies, numcookies);
 236         if (!raised)
 237                 cfs_cap_lower(CFS_CAP_SYS_RESOURCE);
 238         RETURN(rc);
 239 }
 240 EXPORT_SYMBOL(llog_add);
 241
 242 int llog_cancel(struct llog_ctxt *ctxt, struct lov_stripe_md *lsm,
 243                 int count, struct llog_cookie *cookies, int flags)
 244 {
 245         int rc;
 246         ENTRY;
 247
 248         if (!ctxt) {
 249                 CERROR("No ctxt\n");
 250                 RETURN(-ENODEV);
 251         }
 252
 253         CTXT_CHECK_OP(ctxt, cancel, -EOPNOTSUPP);
 254         rc = CTXTP(ctxt, cancel)(ctxt, lsm, count, cookies, flags);
 255         RETURN(rc);
 256 }
 257 EXPORT_SYMBOL(llog_cancel);
 258
 259 /* callback func for llog_process in llog_obd_origin_setup */
 260 static int cat_cancel_cb(struct llog_handle *cathandle,
 261                           struct llog_rec_hdr *rec, void *data)
 262 {
 263         struct llog_logid_rec *lir = (struct llog_logid_rec *)rec;
 264         struct llog_handle *loghandle;
 265         struct llog_log_hdr *llh;
 266         int rc, index;
 267         ENTRY;
 268
 269         if (rec->lrh_type != LLOG_LOGID_MAGIC) {
 270                 CERROR("invalid record in catalog\n");
 271                 RETURN(-EINVAL);
 272         }
 273         CDEBUG(D_HA, "processing log "LPX64":%x at index %u of catalog "
 274                LPX64"\n", lir->lid_id.lgl_oid, lir->lid_id.lgl_ogen,
 275                rec->lrh_index, cathandle->lgh_id.lgl_oid);
 276
 277         rc = llog_cat_id2handle(cathandle, &loghandle, &lir->lid_id);
 278         if (rc) {
 279                 CERROR("Cannot find handle for log "LPX64"\n",
 280                        lir->lid_id.lgl_oid);
 281                 RETURN(rc);
 282         }
 283
 284         llh = loghandle->lgh_hdr;
 285         if ((llh->llh_flags & LLOG_F_ZAP_WHEN_EMPTY) &&
 286             (llh->llh_count == 1)) {
 287                 rc = llog_destroy(loghandle);
 288                 if (rc)
 289                         CERROR("failure destroying log in postsetup: %d\n", rc);
 290
 291                 index = loghandle->u.phd.phd_cookie.lgc_index;
 292                 llog_free_handle(loghandle);
 293
 294                 LASSERT(index);
 295                 llog_cat_set_first_idx(cathandle, index);
 296                 rc = llog_cancel_rec(cathandle, index);
 297                 if (rc == 0)
 298                         CDEBUG(D_HA, "cancel log "LPX64":%x at index %u of catalog "
 299                               LPX64"\n", lir->lid_id.lgl_oid,
 300                               lir->lid_id.lgl_ogen, rec->lrh_index,
 301                               cathandle->lgh_id.lgl_oid);
 302         }
 303
 304         RETURN(rc);
 305 }
 306
 307 /* lop_setup method for filter/osc */
 308 // XXX how to set exports
 309 int llog_obd_origin_setup(struct obd_device *obd, struct obd_llog_group *olg,
 310                           int index, struct obd_device *disk_obd, int count,
 311                           struct llog_logid *logid)
 312 {
 313         struct llog_ctxt *ctxt;
 314         struct llog_handle *handle;
 315         struct lvfs_run_ctxt saved;
 316         int rc;
 317         ENTRY;
 318
 319         if (count == 0)
 320                 RETURN(0);
 321
 322         LASSERT(count == 1);
 323
 324         LASSERT(olg != NULL);
 325         ctxt = llog_group_get_ctxt(olg, index);
 326
 327         LASSERT(ctxt);
 328         llog_gen_init(ctxt);
 329
 330         if (logid->lgl_oid)
 331                 rc = llog_create(ctxt, &handle, logid, NULL);
 332         else {
 333                 rc = llog_create(ctxt, &handle, NULL, NULL);
 334                 if (!rc)
 335                         *logid = handle->lgh_id;
 336         }
 337         if (rc)
 338                 GOTO(out, rc);
 339
 340         ctxt->loc_handle = handle;
 341         push_ctxt(&saved, &disk_obd->obd_lvfs_ctxt, NULL);
 342         rc = llog_init_handle(handle, LLOG_F_IS_CAT, NULL);
 343         pop_ctxt(&saved, &disk_obd->obd_lvfs_ctxt, NULL);
 344         if (rc)
 345                 GOTO(out, rc);
 346
 347         rc = llog_process(handle, (llog_cb_t)cat_cancel_cb, NULL, NULL);
 348         if (rc)
 349                 CERROR("llog_process with cat_cancel_cb failed: %d\n", rc);
 350 out:
 351         llog_ctxt_put(ctxt);
 352         RETURN(rc);
 353 }
 354 EXPORT_SYMBOL(llog_obd_origin_setup);
 355
 356 int llog_obd_origin_cleanup(struct llog_ctxt *ctxt)
 357 {
 358         struct llog_handle *cathandle, *n, *loghandle;
 359         struct llog_log_hdr *llh;
 360         int rc, index;
 361         ENTRY;
 362
 363         if (!ctxt)
 364                 RETURN(0);
 365
 366         cathandle = ctxt->loc_handle;
 367         if (cathandle) {
 368                 list_for_each_entry_safe(loghandle, n,
 369                                          &cathandle->u.chd.chd_head,
 370                                          u.phd.phd_entry) {
 371                         llh = loghandle->lgh_hdr;
 372                         if ((llh->llh_flags &
 373                                 LLOG_F_ZAP_WHEN_EMPTY) &&
 374                             (llh->llh_count == 1)) {
 375                                 rc = llog_destroy(loghandle);
 376                                 if (rc)
 377                                         CERROR("failure destroying log during "
 378                                                "cleanup: %d\n", rc);
 379
 380                                 index = loghandle->u.phd.phd_cookie.lgc_index;
 381                                 llog_free_handle(loghandle);
 382
 383                                 LASSERT(index);
 384                                 llog_cat_set_first_idx(cathandle, index);
 385                                 rc = llog_cancel_rec(cathandle, index);
 386                                 if (rc == 0)
 387                                         CDEBUG(D_RPCTRACE, "cancel plain log at"
 388                                                "index %u of catalog "LPX64"\n",
 389                                                index,cathandle->lgh_id.lgl_oid);
 390                         }
 391                 }
 392                 llog_cat_put(ctxt->loc_handle);
 393         }
 394         RETURN(0);
 395 }
 396 EXPORT_SYMBOL(llog_obd_origin_cleanup);
 397
 398 /* add for obdfilter/sz and mds/unlink */
 399 int llog_obd_origin_add(struct llog_ctxt *ctxt,
 400                         struct llog_rec_hdr *rec, struct lov_stripe_md *lsm,
 401                         struct llog_cookie *logcookies, int numcookies)
 402 {
 403         struct llog_handle *cathandle;
 404         int rc;
 405         ENTRY;
 406
 407         cathandle = ctxt->loc_handle;
 408         LASSERT(cathandle != NULL);
 409         rc = llog_cat_add_rec(cathandle, rec, logcookies, NULL);
 410         if (rc != 1)
 411                 CERROR("write one catalog record failed: %d\n", rc);
 412         RETURN(rc);
 413 }
 414 EXPORT_SYMBOL(llog_obd_origin_add);
 415
 416 int llog_cat_initialize(struct obd_device *obd, struct obd_llog_group *olg,
 417                         int idx, struct obd_uuid *uuid)
 418 {
 419         char name[32] = CATLIST;
 420         struct llog_catid idarray;
 421         int rc;
 422         ENTRY;
 423
 424         mutex_down(&olg->olg_cat_processing);
 425         rc = llog_get_cat_list(obd, obd, name, idx, 1, &idarray);
 426         if (rc) {
 427                 CERROR("rc: %d\n", rc);
 428                 GOTO(out, rc);
 429         }
 430
 431         CDEBUG(D_INFO, "%s: Init llog for %s/%d - catid "LPX64"/"LPX64":%x\n",
 432                obd->obd_name, uuid->uuid, idx, idarray.lci_logid.lgl_oid,
 433                idarray.lci_logid.lgl_ogr, idarray.lci_logid.lgl_ogen);
 434
 435         rc = obd_llog_init(obd, olg, obd, 1, &idarray, uuid);
 436         if (rc) {
 437                 CERROR("rc: %d\n", rc);
 438                 GOTO(out, rc);
 439         }
 440
 441         rc = llog_put_cat_list(obd, obd, name, idx, 1, &idarray);
 442         if (rc) {
 443                 CERROR("rc: %d\n", rc);
 444                 GOTO(out, rc);
 445         }
 446
 447  out:
 448         mutex_up(&olg->olg_cat_processing);
 449
 450         RETURN(rc);
 451 }
 452 EXPORT_SYMBOL(llog_cat_initialize);
 453
 454 int obd_llog_init(struct obd_device *obd, struct obd_llog_group *olg,
 455                   struct obd_device *disk_obd, int count,
 456                   struct llog_catid *logid, struct obd_uuid *uuid)
 457 {
 458         int rc;
 459         ENTRY;
 460         OBD_CHECK_DT_OP(obd, llog_init, 0);
 461         OBD_COUNTER_INCREMENT(obd, llog_init);
 462
 463         rc = OBP(obd, llog_init)(obd, olg, disk_obd, count, logid, uuid);
 464         RETURN(rc);
 465 }
 466 EXPORT_SYMBOL(obd_llog_init);
 467
 468 int obd_llog_finish(struct obd_device *obd, int count)
 469 {
 470         int rc;
 471         ENTRY;
 472         OBD_CHECK_DT_OP(obd, llog_finish, 0);
 473         OBD_COUNTER_INCREMENT(obd, llog_finish);
 474
 475         rc = OBP(obd, llog_finish)(obd, count);
 476         RETURN(rc);
 477 }
 478 EXPORT_SYMBOL(obd_llog_finish);