lustre/obdclass/llog_obd.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
  37 #define DEBUG_SUBSYSTEM S_LOG
  38
  39
  40 #include <obd_class.h>
  41 #include <lustre_log.h>
  42 #include "llog_internal.h"
  43
  44 /* helper functions for calling the llog obd methods */
  45 static struct llog_ctxt* llog_new_ctxt(struct obd_device *obd)
  46 {
  47         struct llog_ctxt *ctxt;
  48
  49         OBD_ALLOC_PTR(ctxt);
  50         if (!ctxt)
  51                 return NULL;
  52
  53         ctxt->loc_obd = obd;
  54         atomic_set(&ctxt->loc_refcount, 1);
  55
  56         return ctxt;
  57 }
  58
  59 static void llog_ctxt_destroy(struct llog_ctxt *ctxt)
  60 {
  61         if (ctxt->loc_exp) {
  62                 class_export_put(ctxt->loc_exp);
  63                 ctxt->loc_exp = NULL;
  64         }
  65         if (ctxt->loc_imp) {
  66                 class_import_put(ctxt->loc_imp);
  67                 ctxt->loc_imp = NULL;
  68         }
  69         OBD_FREE_PTR(ctxt);
  70 }
  71
  72 int __llog_ctxt_put(const struct lu_env *env, struct llog_ctxt *ctxt)
  73 {
  74         struct obd_llog_group *olg = ctxt->loc_olg;
  75         struct obd_device *obd;
  76         int rc = 0;
  77
  78         spin_lock(&olg->olg_lock);
  79         if (!atomic_dec_and_test(&ctxt->loc_refcount)) {
  80                 spin_unlock(&olg->olg_lock);
  81                 return rc;
  82         }
  83         olg->olg_ctxts[ctxt->loc_idx] = NULL;
  84         spin_unlock(&olg->olg_lock);
  85
  86         obd = ctxt->loc_obd;
  87         spin_lock(&obd->obd_dev_lock);
  88         /* sync with llog ctxt user thread */
  89         spin_unlock(&obd->obd_dev_lock);
  90
  91         /* obd->obd_starting is needed for the case of cleanup
  92          * in error case while obd is starting up. */
  93         LASSERTF(obd->obd_starting == 1 ||
  94                  obd->obd_stopping == 1 || obd->obd_set_up == 0,
  95                  "wrong obd state: %d/%d/%d\n", !!obd->obd_starting,
  96                  !!obd->obd_stopping, !!obd->obd_set_up);
  97
  98         /* cleanup the llog ctxt here */
  99         if (CTXTP(ctxt, cleanup))
 100                 rc = CTXTP(ctxt, cleanup)(env, 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(const struct lu_env *env, 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         LASSERT(ctxt != NULL);
 116         LASSERT(ctxt != LP_POISON);
 117
 118         olg = ctxt->loc_olg;
 119         LASSERT(olg != NULL);
 120         LASSERT(olg != LP_POISON);
 121
 122         idx = ctxt->loc_idx;
 123
 124         /*
 125          * Banlance the ctxt get when calling llog_cleanup()
 126          */
 127         LASSERT(atomic_read(&ctxt->loc_refcount) < LI_POISON);
 128         LASSERT(atomic_read(&ctxt->loc_refcount) > 1);
 129         llog_ctxt_put(ctxt);
 130
 131         /*
 132          * Try to free the ctxt.
 133          */
 134         rc = __llog_ctxt_put(env, ctxt);
 135         if (rc)
 136                 CERROR("Error %d while cleaning up ctxt %p\n",
 137                        rc, ctxt);
 138
 139         l_wait_event(olg->olg_waitq,
 140                      llog_group_ctxt_null(olg, idx), &lwi);
 141
 142         RETURN(rc);
 143 }
 144 EXPORT_SYMBOL(llog_cleanup);
 145
 146 int llog_setup(const struct lu_env *env, struct obd_device *obd,
 147                struct obd_llog_group *olg, int index,
 148                struct obd_device *disk_obd, struct llog_operations *op)
 149 {
 150         struct llog_ctxt *ctxt;
 151         int rc = 0;
 152         ENTRY;
 153
 154         if (index < 0 || index >= LLOG_MAX_CTXTS)
 155                 RETURN(-EINVAL);
 156
 157         LASSERT(olg != NULL);
 158
 159         ctxt = llog_new_ctxt(obd);
 160         if (!ctxt)
 161                 RETURN(-ENOMEM);
 162
 163         ctxt->loc_obd = obd;
 164         ctxt->loc_olg = olg;
 165         ctxt->loc_idx = index;
 166         ctxt->loc_logops = op;
 167         mutex_init(&ctxt->loc_mutex);
 168         ctxt->loc_exp = class_export_get(disk_obd->obd_self_export);
 169         ctxt->loc_flags = LLOG_CTXT_FLAG_UNINITIALIZED;
 170
 171         rc = llog_group_set_ctxt(olg, ctxt, index);
 172         if (rc) {
 173                 llog_ctxt_destroy(ctxt);
 174                 if (rc == -EEXIST) {
 175                         ctxt = llog_group_get_ctxt(olg, index);
 176                         if (ctxt) {
 177                                 /*
 178                                  * mds_lov_update_desc() might call here multiple
 179                                  * times. So if the llog is already set up then
 180                                  * don't to do it again.
 181                                  */
 182                                 CDEBUG(D_CONFIG, "obd %s ctxt %d already set up\n",
 183                                        obd->obd_name, index);
 184                                 LASSERT(ctxt->loc_olg == olg);
 185                                 LASSERT(ctxt->loc_obd == obd);
 186                                 LASSERT(ctxt->loc_exp == disk_obd->obd_self_export);
 187                                 LASSERT(ctxt->loc_logops == op);
 188                                 llog_ctxt_put(ctxt);
 189                         }
 190                         rc = 0;
 191                 }
 192                 RETURN(rc);
 193         }
 194
 195         if (op->lop_setup) {
 196                 if (OBD_FAIL_CHECK(OBD_FAIL_OBD_LLOG_SETUP))
 197                         rc = -EOPNOTSUPP;
 198                 else
 199                         rc = op->lop_setup(env, obd, olg, index, disk_obd);
 200         }
 201
 202         if (rc) {
 203                 CERROR("%s: ctxt %d lop_setup=%p failed: rc = %d\n",
 204                        obd->obd_name, index, op->lop_setup, rc);
 205                 llog_group_clear_ctxt(olg, index);
 206                 llog_ctxt_destroy(ctxt);
 207         } else {
 208                 CDEBUG(D_CONFIG, "obd %s ctxt %d is initialized\n",
 209                        obd->obd_name, index);
 210                 ctxt->loc_flags &= ~LLOG_CTXT_FLAG_UNINITIALIZED;
 211         }
 212
 213         RETURN(rc);
 214 }
 215 EXPORT_SYMBOL(llog_setup);
 216
 217 int llog_sync(struct llog_ctxt *ctxt, struct obd_export *exp, int flags)
 218 {
 219         int rc = 0;
 220         ENTRY;
 221
 222         if (!ctxt)
 223                 RETURN(0);
 224
 225         if (CTXTP(ctxt, sync))
 226                 rc = CTXTP(ctxt, sync)(ctxt, exp, flags);
 227
 228         RETURN(rc);
 229 }
 230 EXPORT_SYMBOL(llog_sync);
 231
 232 int llog_cancel(const struct lu_env *env, struct llog_ctxt *ctxt,
 233                 struct llog_cookie *cookies, int flags)
 234 {
 235         int rc;
 236         ENTRY;
 237
 238         if (!ctxt) {
 239                 CERROR("No ctxt\n");
 240                 RETURN(-ENODEV);
 241         }
 242
 243         CTXT_CHECK_OP(ctxt, cancel, -EOPNOTSUPP);
 244         rc = CTXTP(ctxt, cancel)(env, ctxt, cookies, flags);
 245         RETURN(rc);
 246 }
 247 EXPORT_SYMBOL(llog_cancel);
 248
 249 int obd_llog_init(struct obd_device *obd, struct obd_llog_group *olg,
 250                   struct obd_device *disk_obd, int *index)
 251 {
 252         int rc;
 253         ENTRY;
 254         OBD_CHECK_DT_OP(obd, llog_init, 0);
 255         OBD_COUNTER_INCREMENT(obd, llog_init);
 256
 257         rc = OBP(obd, llog_init)(obd, olg, disk_obd, index);
 258         RETURN(rc);
 259 }
 260 EXPORT_SYMBOL(obd_llog_init);
 261
 262 int obd_llog_finish(struct obd_device *obd, int count)
 263 {
 264         int rc;
 265         ENTRY;
 266         OBD_CHECK_DT_OP(obd, llog_finish, 0);
 267         OBD_COUNTER_INCREMENT(obd, llog_finish);
 268
 269         rc = OBP(obd, llog_finish)(obd, count);
 270         RETURN(rc);
 271 }
 272 EXPORT_SYMBOL(obd_llog_finish);
 273
 274 /* context key constructor/destructor: llog_key_init, llog_key_fini */
 275 LU_KEY_INIT_FINI(llog, struct llog_thread_info);
 276 /* context key: llog_thread_key */
 277 LU_CONTEXT_KEY_DEFINE(llog, LCT_MD_THREAD | LCT_MG_THREAD | LCT_LOCAL);
 278 LU_KEY_INIT_GENERIC(llog);
 279 EXPORT_SYMBOL(llog_thread_key);
 280
 281 int llog_info_init(void)
 282 {
 283         llog_key_init_generic(&llog_thread_key, NULL);
 284         lu_context_key_register(&llog_thread_key);
 285         return 0;
 286 }
 287
 288 void llog_info_fini(void)
 289 {
 290         lu_context_key_degister(&llog_thread_key);
 291 }