lustre/ldlm/ldlm_inodebits.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) 2004, 2010, Oracle and/or its affiliates. All rights reserved.
  28  * Use is subject to license terms.
  29  *
  30  * Copyright (c) 2011, 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  * lustre/ldlm/ldlm_inodebits.c
  37  *
  38  * Author: Peter Braam <braam@clusterfs.com>
  39  * Author: Phil Schwan <phil@clusterfs.com>
  40  */
  41
  42 /**
  43  * This file contains implementation of IBITS lock type
  44  *
  45  * IBITS lock type contains a bit mask determining various properties of an
  46  * object. The meanings of specific bits are specific to the caller and are
  47  * opaque to LDLM code.
  48  *
  49  * Locks with intersecting bitmasks and conflicting lock modes (e.g.  LCK_PW)
  50  * are considered conflicting.  See the lock mode compatibility matrix
  51  * in lustre_dlm.h.
  52  */
  53
  54 #define DEBUG_SUBSYSTEM S_LDLM
  55
  56 #include <lustre_dlm.h>
  57 #include <obd_support.h>
  58 #include <lustre_lib.h>
  59 #include <obd_class.h>
  60
  61 #include "ldlm_internal.h"
  62
  63 #ifdef HAVE_SERVER_SUPPORT
  64 /**
  65  * Determine if the lock is compatible with all locks on the queue.
  66  *
  67  * If \a work_list is provided, conflicting locks are linked there.
  68  * If \a work_list is not provided, we exit this function on first conflict.
  69  *
  70  * \retval 0 if there are conflicting locks in the \a queue
  71  * \retval 1 if the lock is compatible to all locks in \a queue
  72  *
  73  * IBITS locks in granted queue are organized in bunches of
  74  * same-mode/same-bits locks called "skip lists". The First lock in the
  75  * bunch contains a pointer to the end of the bunch.  This allows us to
  76  * skip an entire bunch when iterating the list in search for conflicting
  77  * locks if first lock of the bunch is not conflicting with us.
  78  */
  79 static int
  80 ldlm_inodebits_compat_queue(struct list_head *queue, struct ldlm_lock *req,
  81                             struct list_head *work_list)
  82 {
  83         struct list_head *tmp;
  84         struct ldlm_lock *lock;
  85         __u64 req_bits = req->l_policy_data.l_inodebits.bits;
  86         int compat = 1;
  87         ENTRY;
  88
  89         /* There is no sense in lock with no bits set, I think.
  90          * Also, such a lock would be compatible with any other bit lock */
  91         LASSERT(req_bits != 0);
  92
  93         list_for_each(tmp, queue) {
  94                 struct list_head *mode_tail;
  95
  96                 lock = list_entry(tmp, struct ldlm_lock, l_res_link);
  97
  98                 /* We stop walking the queue if we hit ourselves so we don't
  99                  * take conflicting locks enqueued after us into account,
 100                  * or we'd wait forever. */
 101                 if (req == lock)
 102                         RETURN(compat);
 103
 104                 /* last lock in mode group */
 105                 LASSERT(lock->l_sl_mode.prev != NULL);
 106                 mode_tail = &list_entry(lock->l_sl_mode.prev,
 107                                         struct ldlm_lock,
 108                                         l_sl_mode)->l_res_link;
 109
 110                 /* if reqest lock is not COS_INCOMPAT and COS is disabled,
 111                  * they are compatible, IOW this request is from a local
 112                  * transaction on a DNE system. */
 113                 if (lock->l_req_mode == LCK_COS && !ldlm_is_cos_incompat(req) &&
 114                     !ldlm_is_cos_enabled(req)) {
 115                         /* jump to last lock in mode group */
 116                         tmp = mode_tail;
 117                         continue;
 118                 }
 119
 120                 /* locks' mode are compatible, bits don't matter */
 121                 if (lockmode_compat(lock->l_req_mode, req->l_req_mode)) {
 122                         /* jump to last lock in mode group */
 123                         tmp = mode_tail;
 124                         continue;
 125                 }
 126
 127                 for (;;) {
 128                         struct list_head *head;
 129
 130                         /* Advance loop cursor to last lock in policy group. */
 131                         tmp = &list_entry(lock->l_sl_policy.prev,
 132                                               struct ldlm_lock,
 133                                               l_sl_policy)->l_res_link;
 134
 135                         /* Locks with overlapping bits conflict. */
 136                         if (lock->l_policy_data.l_inodebits.bits & req_bits) {
 137                                 /* COS lock mode has a special compatibility
 138                                  * requirement: it is only compatible with
 139                                  * locks from the same client. */
 140                                 if (lock->l_req_mode == LCK_COS &&
 141                                     !ldlm_is_cos_incompat(req) &&
 142                                     ldlm_is_cos_enabled(req) &&
 143                                     lock->l_client_cookie == req->l_client_cookie)
 144                                         goto not_conflicting;
 145                                 /* Found a conflicting policy group. */
 146                                 if (!work_list)
 147                                         RETURN(0);
 148
 149                                 compat = 0;
 150
 151                                 /* Add locks of the policy group to @work_list
 152                                  * as blocking locks for @req */
 153                                 if (lock->l_blocking_ast)
 154                                         ldlm_add_ast_work_item(lock, req,
 155                                                                work_list);
 156                                 head = &lock->l_sl_policy;
 157                                 list_for_each_entry(lock, head, l_sl_policy)
 158                                         if (lock->l_blocking_ast)
 159                                                 ldlm_add_ast_work_item(lock, req,
 160                                                                        work_list);
 161                         }
 162                 not_conflicting:
 163                         if (tmp == mode_tail)
 164                                 break;
 165
 166                         tmp = tmp->next;
 167                         lock = list_entry(tmp, struct ldlm_lock,
 168                                               l_res_link);
 169                 } /* Loop over policy groups within one mode group. */
 170         } /* Loop over mode groups within @queue. */
 171
 172         RETURN(compat);
 173 }
 174
 175 /**
 176  * Process a granting attempt for IBITS lock.
 177  * Must be called with ns lock held
 178  *
 179  * This function looks for any conflicts for \a lock in the granted or
 180  * waiting queues. The lock is granted if no conflicts are found in
 181  * either queue.
 182  *
 183  * If \a first_enq is 0 (ie, called from ldlm_reprocess_queue):
 184  *   - blocking ASTs have already been sent
 185  *
 186  * If \a first_enq is 1 (ie, called from ldlm_lock_enqueue):
 187  *   - blocking ASTs have not been sent yet, so list of conflicting locks
 188  *     would be collected and ASTs sent.
 189  */
 190 int ldlm_process_inodebits_lock(struct ldlm_lock *lock, __u64 *flags,
 191                                 int first_enq, enum ldlm_error *err,
 192                                 struct list_head *work_list)
 193 {
 194         struct ldlm_resource *res = lock->l_resource;
 195         struct list_head rpc_list;
 196         int rc;
 197         ENTRY;
 198
 199         LASSERT(lock->l_granted_mode != lock->l_req_mode);
 200         LASSERT(list_empty(&res->lr_converting));
 201         INIT_LIST_HEAD(&rpc_list);
 202         check_res_locked(res);
 203
 204         /* (*flags & LDLM_FL_BLOCK_NOWAIT) is for layout lock right now. */
 205         if (!first_enq || (*flags & LDLM_FL_BLOCK_NOWAIT)) {
 206                 *err = ELDLM_LOCK_ABORTED;
 207                 if (*flags & LDLM_FL_BLOCK_NOWAIT)
 208                         *err = ELDLM_LOCK_WOULDBLOCK;
 209
 210                 rc = ldlm_inodebits_compat_queue(&res->lr_granted, lock, NULL);
 211                 if (!rc)
 212                         RETURN(LDLM_ITER_STOP);
 213                 rc = ldlm_inodebits_compat_queue(&res->lr_waiting, lock, NULL);
 214                 if (!rc)
 215                         RETURN(LDLM_ITER_STOP);
 216
 217                 ldlm_resource_unlink_lock(lock);
 218                 ldlm_grant_lock(lock, work_list);
 219
 220                 *err = ELDLM_OK;
 221                 RETURN(LDLM_ITER_CONTINUE);
 222         }
 223
 224  restart:
 225         rc = ldlm_inodebits_compat_queue(&res->lr_granted, lock, &rpc_list);
 226         rc += ldlm_inodebits_compat_queue(&res->lr_waiting, lock, &rpc_list);
 227
 228         if (rc != 2) {
 229                 /* If either of the compat_queue()s returned 0, then we
 230                  * have ASTs to send and must go onto the waiting list.
 231                  *
 232                  * bug 2322: we used to unlink and re-add here, which was a
 233                  * terrible folly -- if we goto restart, we could get
 234                  * re-ordered!  Causes deadlock, because ASTs aren't sent! */
 235                 if (list_empty(&lock->l_res_link))
 236                         ldlm_resource_add_lock(res, &res->lr_waiting, lock);
 237                 unlock_res(res);
 238                 rc = ldlm_run_ast_work(ldlm_res_to_ns(res), &rpc_list,
 239                                        LDLM_WORK_BL_AST);
 240                 lock_res(res);
 241                 if (rc == -ERESTART)
 242                         GOTO(restart, rc);
 243                 *flags |= LDLM_FL_BLOCK_GRANTED;
 244         } else {
 245                 ldlm_resource_unlink_lock(lock);
 246                 ldlm_grant_lock(lock, NULL);
 247         }
 248         RETURN(0);
 249 }
 250 #endif /* HAVE_SERVER_SUPPORT */
 251
 252 void ldlm_ibits_policy_wire_to_local(const union ldlm_wire_policy_data *wpolicy,
 253                                      union ldlm_policy_data *lpolicy)
 254 {
 255         lpolicy->l_inodebits.bits = wpolicy->l_inodebits.bits;
 256 }
 257
 258 void ldlm_ibits_policy_local_to_wire(const union ldlm_policy_data *lpolicy,
 259                                      union ldlm_wire_policy_data *wpolicy)
 260 {
 261         memset(wpolicy, 0, sizeof(*wpolicy));
 262         wpolicy->l_inodebits.bits = lpolicy->l_inodebits.bits;
 263 }