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.gnu.org/licenses/gpl-2.0.html
  19  *
  20  * GPL HEADER END
  21  */
  22 /*
  23  * Copyright (c) 2004, 2010, Oracle and/or its affiliates. All rights reserved.
  24  * Use is subject to license terms.
  25  *
  26  * Copyright (c) 2011, 2017, 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  * lustre/ldlm/ldlm_inodebits.c
  33  *
  34  * Author: Peter Braam <braam@clusterfs.com>
  35  * Author: Phil Schwan <phil@clusterfs.com>
  36  */
  37
  38 /**
  39  * This file contains implementation of IBITS lock type
  40  *
  41  * IBITS lock type contains a bit mask determining various properties of an
  42  * object. The meanings of specific bits are specific to the caller and are
  43  * opaque to LDLM code.
  44  *
  45  * Locks with intersecting bitmasks and conflicting lock modes (e.g.  LCK_PW)
  46  * are considered conflicting.  See the lock mode compatibility matrix
  47  * in lustre_dlm.h.
  48  */
  49
  50 #define DEBUG_SUBSYSTEM S_LDLM
  51
  52 #include <lustre_dlm.h>
  53 #include <obd_support.h>
  54 #include <lustre_lib.h>
  55 #include <obd_class.h>
  56
  57 #include "ldlm_internal.h"
  58
  59 #ifdef HAVE_SERVER_SUPPORT
  60 /**
  61  * Determine if the lock is compatible with all locks on the queue.
  62  *
  63  * If \a work_list is provided, conflicting locks are linked there.
  64  * If \a work_list is not provided, we exit this function on first conflict.
  65  *
  66  * \retval 0 if there are conflicting locks in the \a queue
  67  * \retval 1 if the lock is compatible to all locks in \a queue
  68  *
  69  * IBITS locks in granted queue are organized in bunches of
  70  * same-mode/same-bits locks called "skip lists". The First lock in the
  71  * bunch contains a pointer to the end of the bunch.  This allows us to
  72  * skip an entire bunch when iterating the list in search for conflicting
  73  * locks if first lock of the bunch is not conflicting with us.
  74  */
  75 static int
  76 ldlm_inodebits_compat_queue(struct list_head *queue, struct ldlm_lock *req,
  77                             struct list_head *work_list)
  78 {
  79         struct list_head *tmp;
  80         struct ldlm_lock *lock;
  81         __u64 req_bits = req->l_policy_data.l_inodebits.bits;
  82         __u64 *try_bits = &req->l_policy_data.l_inodebits.try_bits;
  83         int compat = 1;
  84
  85         ENTRY;
  86
  87         /* There is no sense in lock with no bits set. Also such a lock
  88          * would be compatible with any other bit lock.
  89          * Meanwhile that can be true if there were just try_bits and all
  90          * are failed, so just exit gracefully and let the caller to care.
  91          */
  92         if ((req_bits | *try_bits) == 0)
  93                 RETURN(0);
  94
  95         list_for_each(tmp, queue) {
  96                 struct list_head *mode_tail;
  97
  98                 lock = list_entry(tmp, struct ldlm_lock, l_res_link);
  99
 100                 /* We stop walking the queue if we hit ourselves so we don't
 101                  * take conflicting locks enqueued after us into account,
 102                  * or we'd wait forever. */
 103                 if (req == lock)
 104                         RETURN(compat);
 105
 106                 /* last lock in mode group */
 107                 LASSERT(lock->l_sl_mode.prev != NULL);
 108                 mode_tail = &list_entry(lock->l_sl_mode.prev, struct ldlm_lock,
 109                                         l_sl_mode)->l_res_link;
 110
 111                 /* if request lock is not COS_INCOMPAT and COS is disabled,
 112                  * they are compatible, IOW this request is from a local
 113                  * transaction on a DNE system. */
 114                 if (lock->l_req_mode == LCK_COS && !ldlm_is_cos_incompat(req) &&
 115                     !ldlm_is_cos_enabled(req)) {
 116                         /* jump to last lock in mode group */
 117                         tmp = mode_tail;
 118                         continue;
 119                 }
 120
 121                 /* locks' mode are compatible, bits don't matter */
 122                 if (lockmode_compat(lock->l_req_mode, req->l_req_mode)) {
 123                         /* jump to last lock in mode group */
 124                         tmp = mode_tail;
 125                         continue;
 126                 }
 127
 128                 for (;;) {
 129                         struct list_head *head;
 130
 131                         /* Advance loop cursor to last lock in policy group. */
 132                         tmp = &list_entry(lock->l_sl_policy.prev,
 133                                           struct ldlm_lock,
 134                                           l_sl_policy)->l_res_link;
 135
 136                         /* New lock's try_bits are filtered out by ibits
 137                          * of all locks in both granted and waiting queues.
 138                          */
 139                         *try_bits &= ~(lock->l_policy_data.l_inodebits.bits |
 140                                 lock->l_policy_data.l_inodebits.try_bits);
 141
 142                         if ((req_bits | *try_bits) == 0)
 143                                 RETURN(0);
 144
 145                         /* The new lock ibits is more preferable than try_bits
 146                          * of waiting locks so drop conflicting try_bits in
 147                          * the waiting queue.
 148                          * Notice that try_bits of granted locks must be zero.
 149                          */
 150                         lock->l_policy_data.l_inodebits.try_bits &= ~req_bits;
 151
 152                         /* Locks with overlapping bits conflict. */
 153                         if (lock->l_policy_data.l_inodebits.bits & req_bits) {
 154                                 /* COS lock mode has a special compatibility
 155                                  * requirement: it is only compatible with
 156                                  * locks from the same client. */
 157                                 if (lock->l_req_mode == LCK_COS &&
 158                                     !ldlm_is_cos_incompat(req) &&
 159                                     ldlm_is_cos_enabled(req) &&
 160                                     lock->l_client_cookie == req->l_client_cookie)
 161                                         goto not_conflicting;
 162
 163                                 /* Found a conflicting policy group. */
 164                                 if (!work_list)
 165                                         RETURN(0);
 166
 167                                 compat = 0;
 168
 169                                 /* Add locks of the policy group to @work_list
 170                                  * as blocking locks for @req */
 171                                 if (lock->l_blocking_ast)
 172                                         ldlm_add_ast_work_item(lock, req,
 173                                                                work_list);
 174                                 head = &lock->l_sl_policy;
 175                                 list_for_each_entry(lock, head, l_sl_policy)
 176                                         if (lock->l_blocking_ast)
 177                                                 ldlm_add_ast_work_item(lock,
 178                                                                 req, work_list);
 179                         }
 180 not_conflicting:
 181                         if (tmp == mode_tail)
 182                                 break;
 183
 184                         tmp = tmp->next;
 185                         lock = list_entry(tmp, struct ldlm_lock, l_res_link);
 186                 } /* Loop over policy groups within one mode group. */
 187         } /* Loop over mode groups within @queue. */
 188
 189         RETURN(compat);
 190 }
 191
 192 /**
 193  * Process a granting attempt for IBITS lock.
 194  * Must be called with ns lock held
 195  *
 196  * This function looks for any conflicts for \a lock in the granted or
 197  * waiting queues. The lock is granted if no conflicts are found in
 198  * either queue.
 199  */
 200 int ldlm_process_inodebits_lock(struct ldlm_lock *lock, __u64 *flags,
 201                                 enum ldlm_process_intention intention,
 202                                 enum ldlm_error *err,
 203                                 struct list_head *work_list)
 204 {
 205         struct ldlm_resource *res = lock->l_resource;
 206         struct list_head rpc_list;
 207         int rc;
 208
 209         ENTRY;
 210
 211         LASSERT(lock->l_granted_mode != lock->l_req_mode);
 212         INIT_LIST_HEAD(&rpc_list);
 213         check_res_locked(res);
 214
 215         if (intention == LDLM_PROCESS_RESCAN) {
 216                 *err = ELDLM_LOCK_ABORTED;
 217
 218                 LASSERT(lock->l_policy_data.l_inodebits.bits != 0);
 219
 220                 rc = ldlm_inodebits_compat_queue(&res->lr_granted, lock, NULL);
 221                 if (!rc)
 222                         RETURN(LDLM_ITER_STOP);
 223                 rc = ldlm_inodebits_compat_queue(&res->lr_waiting, lock, NULL);
 224                 if (!rc)
 225                         RETURN(LDLM_ITER_STOP);
 226
 227                 /* grant also try_bits if any */
 228                 if (lock->l_policy_data.l_inodebits.try_bits != 0) {
 229                         lock->l_policy_data.l_inodebits.bits |=
 230                                 lock->l_policy_data.l_inodebits.try_bits;
 231                         lock->l_policy_data.l_inodebits.try_bits = 0;
 232                         *flags |= LDLM_FL_LOCK_CHANGED;
 233                 }
 234                 ldlm_resource_unlink_lock(lock);
 235                 ldlm_grant_lock(lock, work_list);
 236
 237                 *err = ELDLM_OK;
 238                 RETURN(LDLM_ITER_CONTINUE);
 239         }
 240
 241         LASSERT((intention == LDLM_PROCESS_ENQUEUE && work_list == NULL) ||
 242                 (intention == LDLM_PROCESS_RECOVERY && work_list != NULL));
 243 restart:
 244         rc = ldlm_inodebits_compat_queue(&res->lr_granted, lock, &rpc_list);
 245         rc += ldlm_inodebits_compat_queue(&res->lr_waiting, lock, &rpc_list);
 246
 247         if (rc != 2) {
 248                 /* if there were only bits to try and all are conflicting */
 249                 if ((lock->l_policy_data.l_inodebits.bits |
 250                      lock->l_policy_data.l_inodebits.try_bits) == 0) {
 251                         rc = ELDLM_LOCK_WOULDBLOCK;
 252                 } else {
 253                         rc = ldlm_handle_conflict_lock(lock, flags,
 254                                                        &rpc_list, 0);
 255                         if (rc == -ERESTART)
 256                                 GOTO(restart, rc);
 257                 }
 258                 *err = rc;
 259         } else {
 260                 /* grant also all remaining try_bits */
 261                 if (lock->l_policy_data.l_inodebits.try_bits != 0) {
 262                         lock->l_policy_data.l_inodebits.bits |=
 263                                 lock->l_policy_data.l_inodebits.try_bits;
 264                         lock->l_policy_data.l_inodebits.try_bits = 0;
 265                         *flags |= LDLM_FL_LOCK_CHANGED;
 266                 }
 267                 LASSERT(lock->l_policy_data.l_inodebits.bits);
 268                 ldlm_resource_unlink_lock(lock);
 269                 ldlm_grant_lock(lock, work_list);
 270                 rc = 0;
 271         }
 272
 273         if (!list_empty(&rpc_list))
 274                 ldlm_discard_bl_list(&rpc_list);
 275
 276         RETURN(rc);
 277 }
 278 #endif /* HAVE_SERVER_SUPPORT */
 279
 280 void ldlm_ibits_policy_wire_to_local(const union ldlm_wire_policy_data *wpolicy,
 281                                      union ldlm_policy_data *lpolicy)
 282 {
 283         lpolicy->l_inodebits.bits = wpolicy->l_inodebits.bits;
 284         lpolicy->l_inodebits.try_bits = wpolicy->l_inodebits.try_bits;
 285 }
 286
 287 void ldlm_ibits_policy_local_to_wire(const union ldlm_policy_data *lpolicy,
 288                                      union ldlm_wire_policy_data *wpolicy)
 289 {
 290         memset(wpolicy, 0, sizeof(*wpolicy));
 291         wpolicy->l_inodebits.bits = lpolicy->l_inodebits.bits;
 292         wpolicy->l_inodebits.try_bits = lpolicy->l_inodebits.try_bits;
 293 }
 294
 295 int ldlm_inodebits_drop(struct ldlm_lock *lock,  __u64 to_drop)
 296 {
 297         ENTRY;
 298
 299         check_res_locked(lock->l_resource);
 300
 301         /* Just return if there are no conflicting bits */
 302         if ((lock->l_policy_data.l_inodebits.bits & to_drop) == 0) {
 303                 LDLM_WARN(lock, "try to drop unset bits %#llx/%#llx\n",
 304                           lock->l_policy_data.l_inodebits.bits, to_drop);
 305                 /* nothing to do */
 306                 RETURN(0);
 307         }
 308
 309         /* remove lock from a skiplist and put in the new place
 310          * according with new inodebits */
 311         ldlm_resource_unlink_lock(lock);
 312         lock->l_policy_data.l_inodebits.bits &= ~to_drop;
 313         ldlm_grant_lock_with_skiplist(lock);
 314         RETURN(0);
 315 }
 316 EXPORT_SYMBOL(ldlm_inodebits_drop);