lustre/obdclass/cl_lock.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.gnu.org/licenses/gpl-2.0.html
  19  *
  20  * GPL HEADER END
  21  */
  22 /*
  23  * Copyright (c) 2008, 2010, Oracle and/or its affiliates. All rights reserved.
  24  * Use is subject to license terms.
  25  *
  26  * Copyright (c) 2011, 2014, Intel Corporation.
  27  */
  28 /*
  29  * This file is part of Lustre, http://www.lustre.org/
  30  * Lustre is a trademark of Sun Microsystems, Inc.
  31  *
  32  * Client Extent Lock.
  33  *
  34  *   Author: Nikita Danilov <nikita.danilov@sun.com>
  35  *   Author: Jinshan Xiong <jinshan.xiong@intel.com>
  36  */
  37
  38 #define DEBUG_SUBSYSTEM S_CLASS
  39
  40 #include <linux/list.h>
  41 #include <libcfs/libcfs.h>
  42 #include <obd_class.h>
  43 #include <obd_support.h>
  44 #include <lustre_fid.h>
  45 #include <cl_object.h>
  46 #include "cl_internal.h"
  47
  48 static void cl_lock_trace0(int level, const struct lu_env *env,
  49                            const char *prefix, const struct cl_lock *lock,
  50                            const char *func, const int line)
  51 {
  52         struct cl_object_header *h = cl_object_header(lock->cll_descr.cld_obj);
  53         CDEBUG(level, "%s: %p (%p/%d) at %s():%d\n",
  54                prefix, lock, env, h->coh_nesting, func, line);
  55 }
  56 #define cl_lock_trace(level, env, prefix, lock)                         \
  57         cl_lock_trace0(level, env, prefix, lock, __FUNCTION__, __LINE__)
  58
  59 /**
  60  * Adds lock slice to the compound lock.
  61  *
  62  * This is called by cl_object_operations::coo_lock_init() methods to add a
  63  * per-layer state to the lock. New state is added at the end of
  64  * cl_lock::cll_layers list, that is, it is at the bottom of the stack.
  65  *
  66  * \see cl_req_slice_add(), cl_page_slice_add(), cl_io_slice_add()
  67  */
  68 void cl_lock_slice_add(struct cl_lock *lock, struct cl_lock_slice *slice,
  69                        struct cl_object *obj,
  70                        const struct cl_lock_operations *ops)
  71 {
  72         ENTRY;
  73         slice->cls_lock = lock;
  74         list_add_tail(&slice->cls_linkage, &lock->cll_layers);
  75         slice->cls_obj = obj;
  76         slice->cls_ops = ops;
  77         EXIT;
  78 }
  79 EXPORT_SYMBOL(cl_lock_slice_add);
  80
  81 void cl_lock_fini(const struct lu_env *env, struct cl_lock *lock)
  82 {
  83         ENTRY;
  84
  85         cl_lock_trace(D_DLMTRACE, env, "destroy lock", lock);
  86
  87         while (!list_empty(&lock->cll_layers)) {
  88                 struct cl_lock_slice *slice;
  89
  90                 slice = list_entry(lock->cll_layers.next,
  91                                 struct cl_lock_slice, cls_linkage);
  92                 list_del_init(lock->cll_layers.next);
  93                 slice->cls_ops->clo_fini(env, slice);
  94         }
  95         POISON(lock, 0x5a, sizeof(*lock));
  96         EXIT;
  97 }
  98 EXPORT_SYMBOL(cl_lock_fini);
  99
 100 int cl_lock_init(const struct lu_env *env, struct cl_lock *lock,
 101                  const struct cl_io *io)
 102 {
 103         struct cl_object *obj = lock->cll_descr.cld_obj;
 104         struct cl_object *scan;
 105         int result = 0;
 106         ENTRY;
 107
 108         /* Make sure cl_lock::cll_descr is initialized. */
 109         LASSERT(obj != NULL);
 110
 111         INIT_LIST_HEAD(&lock->cll_layers);
 112         list_for_each_entry(scan, &obj->co_lu.lo_header->loh_layers,
 113                             co_lu.lo_linkage) {
 114                 result = scan->co_ops->coo_lock_init(env, scan, lock, io);
 115                 if (result != 0) {
 116                         cl_lock_fini(env, lock);
 117                         break;
 118                 }
 119         }
 120         RETURN(result);
 121 }
 122 EXPORT_SYMBOL(cl_lock_init);
 123
 124 /**
 125  * Returns a slice with a lock, corresponding to the given layer in the
 126  * device stack.
 127  *
 128  * \see cl_page_at()
 129  */
 130 const struct cl_lock_slice *cl_lock_at(const struct cl_lock *lock,
 131                                        const struct lu_device_type *dtype)
 132 {
 133         const struct cl_lock_slice *slice;
 134
 135         ENTRY;
 136
 137         list_for_each_entry(slice, &lock->cll_layers, cls_linkage) {
 138                 if (slice->cls_obj->co_lu.lo_dev->ld_type == dtype)
 139                         RETURN(slice);
 140         }
 141         RETURN(NULL);
 142 }
 143 EXPORT_SYMBOL(cl_lock_at);
 144
 145 void cl_lock_cancel(const struct lu_env *env, struct cl_lock *lock)
 146 {
 147         const struct cl_lock_slice *slice;
 148         ENTRY;
 149
 150         cl_lock_trace(D_DLMTRACE, env, "cancel lock", lock);
 151         list_for_each_entry_reverse(slice, &lock->cll_layers, cls_linkage) {
 152                 if (slice->cls_ops->clo_cancel != NULL)
 153                         slice->cls_ops->clo_cancel(env, slice);
 154         }
 155
 156         EXIT;
 157 }
 158 EXPORT_SYMBOL(cl_lock_cancel);
 159
 160 /**
 161  * Enqueue a lock.
 162  * \param anchor: if we need to wait for resources before getting the lock,
 163  *                use @anchor for the purpose.
 164  * \retval 0  enqueue successfully
 165  * \retval <0 error code
 166  */
 167 int cl_lock_enqueue(const struct lu_env *env, struct cl_io *io,
 168                     struct cl_lock *lock, struct cl_sync_io *anchor)
 169 {
 170         const struct cl_lock_slice      *slice;
 171         int                             rc = -ENOSYS;
 172
 173         ENTRY;
 174
 175         list_for_each_entry(slice, &lock->cll_layers, cls_linkage) {
 176                 if (slice->cls_ops->clo_enqueue == NULL)
 177                         continue;
 178
 179                 rc = slice->cls_ops->clo_enqueue(env, slice, io, anchor);
 180                 if (rc != 0)
 181                         break;
 182         }
 183         RETURN(rc);
 184 }
 185 EXPORT_SYMBOL(cl_lock_enqueue);
 186
 187 /**
 188  * Main high-level entry point of cl_lock interface that finds existing or
 189  * enqueues new lock matching given description.
 190  */
 191 int cl_lock_request(const struct lu_env *env, struct cl_io *io,
 192                     struct cl_lock *lock)
 193 {
 194         struct cl_sync_io       *anchor = NULL;
 195         __u32                   enq_flags = lock->cll_descr.cld_enq_flags;
 196         int                     rc;
 197         ENTRY;
 198
 199         rc = cl_lock_init(env, lock, io);
 200         if (rc < 0)
 201                 RETURN(rc);
 202
 203         if ((enq_flags & CEF_ASYNC) && !(enq_flags & CEF_AGL)) {
 204                 anchor = &cl_env_info(env)->clt_anchor;
 205                 cl_sync_io_init(anchor, 1, cl_sync_io_end);
 206         }
 207
 208         rc = cl_lock_enqueue(env, io, lock, anchor);
 209
 210         if (anchor != NULL) {
 211                 int rc2;
 212
 213                 /* drop the reference count held at initialization time */
 214                 cl_sync_io_note(env, anchor, 0);
 215                 rc2 = cl_sync_io_wait(env, anchor, 0);
 216                 if (rc2 < 0 && rc == 0)
 217                         rc = rc2;
 218         }
 219
 220         if (rc < 0)
 221                 cl_lock_release(env, lock);
 222         RETURN(rc);
 223 }
 224 EXPORT_SYMBOL(cl_lock_request);
 225
 226 /**
 227  * Releases a hold and a reference on a lock, obtained by cl_lock_hold().
 228  */
 229 void cl_lock_release(const struct lu_env *env, struct cl_lock *lock)
 230 {
 231         ENTRY;
 232
 233         cl_lock_trace(D_DLMTRACE, env, "release lock", lock);
 234         cl_lock_cancel(env, lock);
 235         cl_lock_fini(env, lock);
 236         EXIT;
 237 }
 238 EXPORT_SYMBOL(cl_lock_release);
 239
 240 const char *cl_lock_mode_name(const enum cl_lock_mode mode)
 241 {
 242         static const char * const names[] = {
 243                 [CLM_READ]    = "R",
 244                 [CLM_WRITE]   = "W",
 245                 [CLM_GROUP]   = "G"
 246         };
 247         CLASSERT(CLM_MAX == ARRAY_SIZE(names));
 248         return names[mode];
 249 }
 250 EXPORT_SYMBOL(cl_lock_mode_name);
 251
 252 /**
 253  * Prints human readable representation of a lock description.
 254  */
 255 void cl_lock_descr_print(const struct lu_env *env, void *cookie,
 256                          lu_printer_t printer,
 257                          const struct cl_lock_descr *descr)
 258 {
 259         const struct lu_fid  *fid;
 260
 261         fid = lu_object_fid(&descr->cld_obj->co_lu);
 262         (*printer)(env, cookie, DDESCR"@"DFID, PDESCR(descr), PFID(fid));
 263 }
 264 EXPORT_SYMBOL(cl_lock_descr_print);
 265
 266 /**
 267  * Prints human readable representation of \a lock to the \a f.
 268  */
 269 void cl_lock_print(const struct lu_env *env, void *cookie,
 270                    lu_printer_t printer, const struct cl_lock *lock)
 271 {
 272         const struct cl_lock_slice *slice;
 273
 274         (*printer)(env, cookie, "lock@%p", lock);
 275         cl_lock_descr_print(env, cookie, printer, &lock->cll_descr);
 276         (*printer)(env, cookie, " {\n");
 277
 278         list_for_each_entry(slice, &lock->cll_layers, cls_linkage) {
 279                 (*printer)(env, cookie, "    %s@%p: ",
 280                            slice->cls_obj->co_lu.lo_dev->ld_type->ldt_name,
 281                            slice);
 282                 if (slice->cls_ops->clo_print != NULL)
 283                         slice->cls_ops->clo_print(env, cookie, printer, slice);
 284                 (*printer)(env, cookie, "\n");
 285         }
 286         (*printer)(env, cookie, "} lock@%p\n", lock);
 287 }
 288 EXPORT_SYMBOL(cl_lock_print);