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, 2016, 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         int compat = 1;
  83         ENTRY;
  84
  85         /* There is no sense in lock with no bits set, I think.
  86          * Also, such a lock would be compatible with any other bit lock */
  87         LASSERT(req_bits != 0);
  88
  89         list_for_each(tmp, queue) {
  90                 struct list_head *mode_tail;
  91
  92                 lock = list_entry(tmp, struct ldlm_lock, l_res_link);
  93
  94                 /* We stop walking the queue if we hit ourselves so we don't
  95                  * take conflicting locks enqueued after us into account,
  96                  * or we'd wait forever. */
  97                 if (req == lock)
  98                         RETURN(compat);
  99
 100                 /* last lock in mode group */
 101                 LASSERT(lock->l_sl_mode.prev != NULL);
 102                 mode_tail = &list_entry(lock->l_sl_mode.prev,
 103                                         struct ldlm_lock,
 104                                         l_sl_mode)->l_res_link;
 105
 106                 /* if reqest lock is not COS_INCOMPAT and COS is disabled,
 107                  * they are compatible, IOW this request is from a local
 108                  * transaction on a DNE system. */
 109                 if (lock->l_req_mode == LCK_COS && !ldlm_is_cos_incompat(req) &&
 110                     !ldlm_is_cos_enabled(req)) {
 111                         /* jump to last lock in mode group */
 112                         tmp = mode_tail;
 113                         continue;
 114                 }
 115
 116                 /* locks' mode are compatible, bits don't matter */
 117                 if (lockmode_compat(lock->l_req_mode, req->l_req_mode)) {
 118                         /* jump to last lock in mode group */
 119                         tmp = mode_tail;
 120                         continue;
 121                 }
 122
 123                 for (;;) {
 124                         struct list_head *head;
 125
 126                         /* Advance loop cursor to last lock in policy group. */
 127                         tmp = &list_entry(lock->l_sl_policy.prev,
 128                                               struct ldlm_lock,
 129                                               l_sl_policy)->l_res_link;
 130
 131                         /* Locks with overlapping bits conflict. */
 132                         if (lock->l_policy_data.l_inodebits.bits & req_bits) {
 133                                 /* COS lock mode has a special compatibility
 134                                  * requirement: it is only compatible with
 135                                  * locks from the same client. */
 136                                 if (lock->l_req_mode == LCK_COS &&
 137                                     !ldlm_is_cos_incompat(req) &&
 138                                     ldlm_is_cos_enabled(req) &&
 139                                     lock->l_client_cookie == req->l_client_cookie)
 140                                         goto not_conflicting;
 141                                 /* Found a conflicting policy group. */
 142                                 if (!work_list)
 143                                         RETURN(0);
 144
 145                                 compat = 0;
 146
 147                                 /* Add locks of the policy group to @work_list
 148                                  * as blocking locks for @req */
 149                                 if (lock->l_blocking_ast)
 150                                         ldlm_add_ast_work_item(lock, req,
 151                                                                work_list);
 152                                 head = &lock->l_sl_policy;
 153                                 list_for_each_entry(lock, head, l_sl_policy)
 154                                         if (lock->l_blocking_ast)
 155                                                 ldlm_add_ast_work_item(lock, req,
 156                                                                        work_list);
 157                         }
 158                 not_conflicting:
 159                         if (tmp == mode_tail)
 160                                 break;
 161
 162                         tmp = tmp->next;
 163                         lock = list_entry(tmp, struct ldlm_lock,
 164                                               l_res_link);
 165                 } /* Loop over policy groups within one mode group. */
 166         } /* Loop over mode groups within @queue. */
 167
 168         RETURN(compat);
 169 }
 170
 171 /**
 172  * Process a granting attempt for IBITS lock.
 173  * Must be called with ns lock held
 174  *
 175  * This function looks for any conflicts for \a lock in the granted or
 176  * waiting queues. The lock is granted if no conflicts are found in
 177  * either queue.
 178  */
 179 int ldlm_process_inodebits_lock(struct ldlm_lock *lock, __u64 *flags,
 180                                 enum ldlm_process_intention intention,
 181                                 enum ldlm_error *err,
 182                                 struct list_head *work_list)
 183 {
 184         struct ldlm_resource *res = lock->l_resource;
 185         struct list_head rpc_list;
 186         int rc;
 187         ENTRY;
 188
 189         LASSERT(lock->l_granted_mode != lock->l_req_mode);
 190         LASSERT(list_empty(&res->lr_converting));
 191         INIT_LIST_HEAD(&rpc_list);
 192         check_res_locked(res);
 193
 194         /* (*flags & LDLM_FL_BLOCK_NOWAIT) is for layout lock right now. */
 195         if (intention == LDLM_PROCESS_RESCAN ||
 196             (*flags & LDLM_FL_BLOCK_NOWAIT)) {
 197                 *err = ELDLM_LOCK_ABORTED;
 198                 if (*flags & LDLM_FL_BLOCK_NOWAIT)
 199                         *err = ELDLM_LOCK_WOULDBLOCK;
 200
 201                 rc = ldlm_inodebits_compat_queue(&res->lr_granted, lock, NULL);
 202                 if (!rc)
 203                         RETURN(LDLM_ITER_STOP);
 204                 rc = ldlm_inodebits_compat_queue(&res->lr_waiting, lock, NULL);
 205                 if (!rc)
 206                         RETURN(LDLM_ITER_STOP);
 207
 208                 ldlm_resource_unlink_lock(lock);
 209                 ldlm_grant_lock(lock, work_list);
 210
 211                 *err = ELDLM_OK;
 212                 RETURN(LDLM_ITER_CONTINUE);
 213         }
 214
 215         LASSERT((intention == LDLM_PROCESS_ENQUEUE && work_list == NULL) ||
 216                 (intention == LDLM_PROCESS_RECOVERY && work_list != NULL));
 217  restart:
 218         rc = ldlm_inodebits_compat_queue(&res->lr_granted, lock, &rpc_list);
 219         rc += ldlm_inodebits_compat_queue(&res->lr_waiting, lock, &rpc_list);
 220
 221         if (rc != 2) {
 222                 rc = ldlm_handle_conflict_lock(lock, flags, &rpc_list, 0);
 223                 if (rc == -ERESTART)
 224                         GOTO(restart, rc);
 225                 *err = rc;
 226         } else {
 227                 ldlm_resource_unlink_lock(lock);
 228                 ldlm_grant_lock(lock, work_list);
 229                 rc = 0;
 230         }
 231
 232         if (!list_empty(&rpc_list))
 233                 ldlm_discard_bl_list(&rpc_list);
 234
 235         RETURN(rc);
 236 }
 237 #endif /* HAVE_SERVER_SUPPORT */
 238
 239 void ldlm_ibits_policy_wire_to_local(const union ldlm_wire_policy_data *wpolicy,
 240                                      union ldlm_policy_data *lpolicy)
 241 {
 242         lpolicy->l_inodebits.bits = wpolicy->l_inodebits.bits;
 243 }
 244
 245 void ldlm_ibits_policy_local_to_wire(const union ldlm_policy_data *lpolicy,
 246                                      union ldlm_wire_policy_data *wpolicy)
 247 {
 248         memset(wpolicy, 0, sizeof(*wpolicy));
 249         wpolicy->l_inodebits.bits = lpolicy->l_inodebits.bits;
 250 }