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
  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         LASSERT(obd->obd_stopping == 1 || obd->obd_set_up == 0);
  98         /* cleanup the llog ctxt here */
  99         if (CTXTP(ctxt, cleanup))
 100                 rc = CTXTP(ctxt, cleanup)(ctxt);
 101
 102         llog_ctxt_destroy(ctxt);
 103         wake_up(&olg->olg_waitq);
 104         return rc;
 105 }
 106 EXPORT_SYMBOL(__llog_ctxt_put);
 107
 108 int llog_cleanup(struct llog_ctxt *ctxt)
 109 {
 110         struct l_wait_info lwi = LWI_INTR(LWI_ON_SIGNAL_NOOP, NULL);
 111         struct obd_llog_group *olg;
 112         int rc, idx;
 113         ENTRY;
 114
 115         if (!ctxt) {
 116                 CERROR("No ctxt\n");
 117                 RETURN(-ENODEV);
 118         }
 119
 120         olg = ctxt->loc_olg;
 121         idx = ctxt->loc_idx;
 122
 123         /* banlance the ctxt get when calling llog_cleanup */
 124         LASSERT(atomic_read(&ctxt->loc_refcount) > 1);
 125         llog_ctxt_put(ctxt);
 126
 127         /* try to free the ctxt */
 128         rc = __llog_ctxt_put(ctxt);
 129         if (rc)
 130                 CERROR("Error %d while cleaning up ctxt %p\n",
 131                        rc, ctxt);
 132
 133         l_wait_event(olg->olg_waitq,
 134                      llog_group_ctxt_null(olg, idx), &lwi);
 135
 136         RETURN(rc);
 137 }
 138 EXPORT_SYMBOL(llog_cleanup);
 139
 140 int llog_setup(struct obd_device *obd,  struct obd_llog_group *olg, int index,
 141                struct obd_device *disk_obd, int count, struct llog_logid *logid,
 142                struct llog_operations *op)
 143 {
 144         int rc = 0;
 145         struct llog_ctxt *ctxt;
 146         ENTRY;
 147
 148         if (index < 0 || index >= LLOG_MAX_CTXTS)
 149                 RETURN(-EFAULT);
 150
 151         LASSERT(olg != NULL);
 152
 153         ctxt = llog_new_ctxt(obd);
 154         if (!ctxt)
 155                 GOTO(out, rc = -ENOMEM);
 156
 157         ctxt->loc_obd = obd;
 158         ctxt->loc_exp = class_export_get(disk_obd->obd_self_export);
 159         ctxt->loc_olg = olg;
 160         ctxt->loc_idx = index;
 161         ctxt->loc_logops = op;
 162         sema_init(&ctxt->loc_sem, 1);
 163
 164         rc = llog_group_set_ctxt(olg, ctxt, index);
 165         if (rc) {
 166                 llog_ctxt_destroy(ctxt);
 167                 if (rc == -EEXIST) {
 168                         /* sanity check */
 169                         ctxt = llog_group_get_ctxt(olg, index);
 170
 171                         /* mds_lov_update_mds might call here multiple times.
 172                          * So if the llog is already set up then don't to do
 173                          * it again. */
 174                         CDEBUG(D_CONFIG, "obd %s ctxt %d already set up\n",
 175                                 obd->obd_name, index);
 176                         LASSERT(ctxt->loc_olg == olg);
 177                         LASSERT(ctxt->loc_obd == obd);
 178                         LASSERT(ctxt->loc_exp == disk_obd->obd_self_export);
 179                         LASSERT(ctxt->loc_logops == op);
 180                         llog_ctxt_put(ctxt);
 181                         rc = 0;
 182                 }
 183                 GOTO(out, rc);
 184         }
 185
 186         if (op->lop_setup)
 187                 rc = op->lop_setup(obd, olg, index, disk_obd, count, logid);
 188
 189         if (rc) {
 190                 llog_ctxt_destroy(ctxt);
 191         }
 192 out:
 193         RETURN(rc);
 194 }
 195 EXPORT_SYMBOL(llog_setup);
 196
 197 int llog_sync(struct llog_ctxt *ctxt, struct obd_export *exp)
 198 {
 199         int rc = 0;
 200         ENTRY;
 201
 202         if (!ctxt)
 203                 RETURN(0);
 204
 205         if (CTXTP(ctxt, sync))
 206                 rc = CTXTP(ctxt, sync)(ctxt, exp);
 207
 208         RETURN(rc);
 209 }
 210 EXPORT_SYMBOL(llog_sync);
 211
 212 int llog_add(struct llog_ctxt *ctxt, struct llog_rec_hdr *rec,
 213              struct lov_stripe_md *lsm, struct llog_cookie *logcookies,
 214              int numcookies)
 215 {
 216         int raised, rc;
 217         ENTRY;
 218
 219         if (!ctxt) {
 220                 CERROR("No ctxt\n");
 221                 RETURN(-ENODEV);
 222         }
 223
 224         CTXT_CHECK_OP(ctxt, add, -EOPNOTSUPP);
 225         raised = cfs_cap_raised(CFS_CAP_SYS_RESOURCE);
 226         if (!raised)
 227                 cfs_cap_raise(CFS_CAP_SYS_RESOURCE);
 228         rc = CTXTP(ctxt, add)(ctxt, rec, lsm, logcookies, numcookies);
 229         if (!raised)
 230                 cfs_cap_lower(CFS_CAP_SYS_RESOURCE);
 231         RETURN(rc);
 232 }
 233 EXPORT_SYMBOL(llog_add);
 234
 235 int llog_cancel(struct llog_ctxt *ctxt, struct lov_stripe_md *lsm,
 236                 int count, struct llog_cookie *cookies, int flags)
 237 {
 238         int rc;
 239         ENTRY;
 240
 241         if (!ctxt) {
 242                 CERROR("No ctxt\n");
 243                 RETURN(-ENODEV);
 244         }
 245
 246         CTXT_CHECK_OP(ctxt, cancel, -EOPNOTSUPP);
 247         rc = CTXTP(ctxt, cancel)(ctxt, lsm, count, cookies, flags);
 248         RETURN(rc);
 249 }
 250 EXPORT_SYMBOL(llog_cancel);
 251
 252 /* callback func for llog_process in llog_obd_origin_setup */
 253 static int cat_cancel_cb(struct llog_handle *cathandle,
 254                           struct llog_rec_hdr *rec, void *data)
 255 {
 256         struct llog_logid_rec *lir = (struct llog_logid_rec *)rec;
 257         struct llog_handle *loghandle;
 258         struct llog_log_hdr *llh;
 259         int rc, index;
 260         ENTRY;
 261
 262         if (rec->lrh_type != LLOG_LOGID_MAGIC) {
 263                 CERROR("invalid record in catalog\n");
 264                 RETURN(-EINVAL);
 265         }
 266         CDEBUG(D_HA, "processing log "LPX64":%x at index %u of catalog "
 267                LPX64"\n", lir->lid_id.lgl_oid, lir->lid_id.lgl_ogen,
 268                rec->lrh_index, cathandle->lgh_id.lgl_oid);
 269
 270         rc = llog_cat_id2handle(cathandle, &loghandle, &lir->lid_id);
 271         if (rc) {
 272                 CERROR("Cannot find handle for log "LPX64"\n",
 273                        lir->lid_id.lgl_oid);
 274                 RETURN(rc);
 275         }
 276
 277         llh = loghandle->lgh_hdr;
 278         if ((llh->llh_flags & LLOG_F_ZAP_WHEN_EMPTY) &&
 279             (llh->llh_count == 1)) {
 280                 rc = llog_destroy(loghandle);
 281                 if (rc)
 282                         CERROR("failure destroying log in postsetup: %d\n", rc);
 283
 284                 index = loghandle->u.phd.phd_cookie.lgc_index;
 285                 llog_free_handle(loghandle);
 286
 287                 LASSERT(index);
 288                 llog_cat_set_first_idx(cathandle, index);
 289                 rc = llog_cancel_rec(cathandle, index);
 290                 if (rc == 0)
 291                         CDEBUG(D_HA, "cancel log "LPX64":%x at index %u of catalog "
 292                               LPX64"\n", lir->lid_id.lgl_oid,
 293                               lir->lid_id.lgl_ogen, rec->lrh_index,
 294                               cathandle->lgh_id.lgl_oid);
 295         }
 296
 297         RETURN(rc);
 298 }
 299
 300 /* lop_setup method for filter/osc */
 301 // XXX how to set exports
 302 int llog_obd_origin_setup(struct obd_device *obd, struct obd_llog_group *olg,
 303                           int index, struct obd_device *disk_obd, int count,
 304                           struct llog_logid *logid)
 305 {
 306         struct llog_ctxt *ctxt;
 307         struct llog_handle *handle;
 308         struct lvfs_run_ctxt saved;
 309         int rc;
 310         ENTRY;
 311
 312         if (count == 0)
 313                 RETURN(0);
 314
 315         LASSERT(count == 1);
 316
 317         LASSERT(olg != NULL);
 318         ctxt = llog_group_get_ctxt(olg, index);
 319
 320         LASSERT(ctxt);
 321         llog_gen_init(ctxt);
 322
 323         if (logid->lgl_oid)
 324                 rc = llog_create(ctxt, &handle, logid, NULL);
 325         else {
 326                 rc = llog_create(ctxt, &handle, NULL, NULL);
 327                 if (!rc)
 328                         *logid = handle->lgh_id;
 329         }
 330         if (rc)
 331                 GOTO(out, rc);
 332
 333         ctxt->loc_handle = handle;
 334         push_ctxt(&saved, &disk_obd->obd_lvfs_ctxt, NULL);
 335         rc = llog_init_handle(handle, LLOG_F_IS_CAT, NULL);
 336         pop_ctxt(&saved, &disk_obd->obd_lvfs_ctxt, NULL);
 337         if (rc)
 338                 GOTO(out, rc);
 339
 340         rc = llog_process(handle, (llog_cb_t)cat_cancel_cb, NULL, NULL);
 341         if (rc)
 342                 CERROR("llog_process with cat_cancel_cb failed: %d\n", rc);
 343 out:
 344         llog_ctxt_put(ctxt);
 345         RETURN(rc);
 346 }
 347 EXPORT_SYMBOL(llog_obd_origin_setup);
 348
 349 int llog_obd_origin_cleanup(struct llog_ctxt *ctxt)
 350 {
 351         struct llog_handle *cathandle, *n, *loghandle;
 352         struct llog_log_hdr *llh;
 353         int rc, index;
 354         ENTRY;
 355
 356         if (!ctxt)
 357                 RETURN(0);
 358
 359         cathandle = ctxt->loc_handle;
 360         if (cathandle) {
 361                 list_for_each_entry_safe(loghandle, n,
 362                                          &cathandle->u.chd.chd_head,
 363                                          u.phd.phd_entry) {
 364                         llh = loghandle->lgh_hdr;
 365                         if ((llh->llh_flags &
 366                                 LLOG_F_ZAP_WHEN_EMPTY) &&
 367                             (llh->llh_count == 1)) {
 368                                 rc = llog_destroy(loghandle);
 369                                 if (rc)
 370                                         CERROR("failure destroying log during "
 371                                                "cleanup: %d\n", rc);
 372
 373                                 index = loghandle->u.phd.phd_cookie.lgc_index;
 374                                 llog_free_handle(loghandle);
 375
 376                                 LASSERT(index);
 377                                 llog_cat_set_first_idx(cathandle, index);
 378                                 rc = llog_cancel_rec(cathandle, index);
 379                                 if (rc == 0)
 380                                         CDEBUG(D_RPCTRACE, "cancel plain log at"
 381                                                "index %u of catalog "LPX64"\n",
 382                                                index,cathandle->lgh_id.lgl_oid);
 383                         }
 384                 }
 385                 llog_cat_put(ctxt->loc_handle);
 386         }
 387         RETURN(0);
 388 }
 389 EXPORT_SYMBOL(llog_obd_origin_cleanup);
 390
 391 /* add for obdfilter/sz and mds/unlink */
 392 int llog_obd_origin_add(struct llog_ctxt *ctxt,
 393                         struct llog_rec_hdr *rec, struct lov_stripe_md *lsm,
 394                         struct llog_cookie *logcookies, int numcookies)
 395 {
 396         struct llog_handle *cathandle;
 397         int rc;
 398         ENTRY;
 399
 400         cathandle = ctxt->loc_handle;
 401         LASSERT(cathandle != NULL);
 402         rc = llog_cat_add_rec(cathandle, rec, logcookies, NULL);
 403         if (rc != 1)
 404                 CERROR("write one catalog record failed: %d\n", rc);
 405         RETURN(rc);
 406 }
 407 EXPORT_SYMBOL(llog_obd_origin_add);
 408
 409 int llog_cat_initialize(struct obd_device *obd, struct obd_llog_group *olg,
 410                         int idx, struct obd_uuid *uuid)
 411 {
 412         char name[32] = CATLIST;
 413         struct llog_catid idarray;
 414         int rc;
 415         ENTRY;
 416
 417         mutex_down(&olg->olg_cat_processing);
 418         rc = llog_get_cat_list(obd, obd, name, idx, 1, &idarray);
 419         if (rc) {
 420                 CERROR("rc: %d\n", rc);
 421                 GOTO(out, rc);
 422         }
 423
 424         CDEBUG(D_INFO, "%s: Init llog for %s/%d - catid "LPX64"/"LPX64":%x\n",
 425                obd->obd_name, uuid->uuid, idx, idarray.lci_logid.lgl_oid,
 426                idarray.lci_logid.lgl_ogr, idarray.lci_logid.lgl_ogen);
 427
 428         rc = obd_llog_init(obd, olg, obd, 1, &idarray, uuid);
 429         if (rc) {
 430                 CERROR("rc: %d\n", rc);
 431                 GOTO(out, rc);
 432         }
 433
 434         rc = llog_put_cat_list(obd, obd, name, idx, 1, &idarray);
 435         if (rc) {
 436                 CERROR("rc: %d\n", rc);
 437                 GOTO(out, rc);
 438         }
 439
 440  out:
 441         mutex_up(&olg->olg_cat_processing);
 442
 443         RETURN(rc);
 444 }
 445 EXPORT_SYMBOL(llog_cat_initialize);
 446
 447 int obd_llog_init(struct obd_device *obd, struct obd_llog_group *olg,
 448                   struct obd_device *disk_obd, int count,
 449                   struct llog_catid *logid, struct obd_uuid *uuid)
 450 {
 451         int rc;
 452         ENTRY;
 453         OBD_CHECK_DT_OP(obd, llog_init, 0);
 454         OBD_COUNTER_INCREMENT(obd, llog_init);
 455
 456         rc = OBP(obd, llog_init)(obd, olg, disk_obd, count, logid, uuid);
 457         RETURN(rc);
 458 }
 459 EXPORT_SYMBOL(obd_llog_init);
 460
 461 int obd_llog_finish(struct obd_device *obd, int count)
 462 {
 463         int rc;
 464         ENTRY;
 465         OBD_CHECK_DT_OP(obd, llog_finish, 0);
 466         OBD_COUNTER_INCREMENT(obd, llog_finish);
 467
 468         rc = OBP(obd, llog_finish)(obd, count);
 469         RETURN(rc);
 470 }
 471 EXPORT_SYMBOL(obd_llog_finish);