lustre/ldlm/ldlm_plain.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) 2011, Whamcloud, Inc.
  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_plain.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 PLAIN lock type.
  44  *
  45  * PLAIN locks are the simplest form of LDLM locking, and are used when
  46  * there only needs to be a single lock on a resource. This avoids some
  47  * of the complexity of EXTENT and IBITS lock types, but doesn't allow
  48  * different "parts" of a resource to be locked concurrently.  Example
  49  * use cases for PLAIN locks include locking of MGS configuration logs
  50  * and (as of Lustre 2.4) quota records.
  51  */
  52
  53 #define DEBUG_SUBSYSTEM S_LDLM
  54
  55 #ifdef __KERNEL__
  56 #include <lustre_dlm.h>
  57 #include <obd_support.h>
  58 #include <lustre_lib.h>
  59 #else
  60 #include <liblustre.h>
  61 #endif
  62
  63 #include "ldlm_internal.h"
  64
  65 #ifdef HAVE_SERVER_SUPPORT
  66 /**
  67  * Determine if the lock is compatible with all locks on the queue.
  68  *
  69  * If \a work_list is provided, conflicting locks are linked there.
  70  * If \a work_list is not provided, we exit this function on first conflict.
  71  *
  72  * \retval 0 if there are conflicting locks in the \a queue
  73  * \retval 1 if the lock is compatible to all locks in \a queue
  74  */
  75 static inline int
  76 ldlm_plain_compat_queue(cfs_list_t *queue, struct ldlm_lock *req,
  77                         cfs_list_t *work_list)
  78 {
  79         cfs_list_t *tmp;
  80         struct ldlm_lock *lock;
  81         ldlm_mode_t req_mode = req->l_req_mode;
  82         int compat = 1;
  83         ENTRY;
  84
  85         lockmode_verify(req_mode);
  86
  87         cfs_list_for_each(tmp, queue) {
  88                 lock = cfs_list_entry(tmp, struct ldlm_lock, l_res_link);
  89
  90                 /* We stop walking the queue if we hit ourselves so we don't
  91                  * take conflicting locks enqueued after us into account,
  92                  * or we'd wait forever. */
  93                 if (req == lock)
  94                         RETURN(compat);
  95
  96                 /* Advance loop cursor to last lock of mode group. */
  97                 tmp = &cfs_list_entry(lock->l_sl_mode.prev,
  98                                       struct ldlm_lock,
  99                                       l_sl_mode)->l_res_link;
 100
 101                 if (lockmode_compat(lock->l_req_mode, req_mode))
 102                         continue;
 103
 104                 if (!work_list)
 105                         RETURN(0);
 106
 107                 compat = 0;
 108
 109                 /* Add locks of the mode group to \a work_list as
 110                  * blocking locks for \a req. */
 111                 if (lock->l_blocking_ast)
 112                         ldlm_add_ast_work_item(lock, req, work_list);
 113
 114                 {
 115                         cfs_list_t *head;
 116
 117                         head = &lock->l_sl_mode;
 118                         cfs_list_for_each_entry(lock, head, l_sl_mode)
 119                                 if (lock->l_blocking_ast)
 120                                         ldlm_add_ast_work_item(lock, req,
 121                                                                work_list);
 122                 }
 123         }
 124
 125         RETURN(compat);
 126 }
 127
 128 /**
 129  * Process a granting attempt for plain lock.
 130  * Must be called with ns lock held.
 131  *
 132  * This function looks for any conflicts for \a lock in the granted or
 133  * waiting queues. The lock is granted if no conflicts are found in
 134  * either queue.
 135  *
 136  * If \a first_enq is 0 (ie, called from ldlm_reprocess_queue):
 137  *   - blocking ASTs have already been sent
 138  *
 139  * If \a first_enq is 1 (ie, called from ldlm_lock_enqueue):
 140  *   - blocking ASTs have not been sent yet, so list of conflicting locks
 141  *     would be collected and ASTs sent.
 142  */
 143 int ldlm_process_plain_lock(struct ldlm_lock *lock, __u64 *flags,
 144                             int first_enq, ldlm_error_t *err,
 145                             cfs_list_t *work_list)
 146 {
 147         struct ldlm_resource *res = lock->l_resource;
 148         CFS_LIST_HEAD(rpc_list);
 149         int rc;
 150         ENTRY;
 151
 152         check_res_locked(res);
 153         LASSERT(cfs_list_empty(&res->lr_converting));
 154
 155         if (!first_enq) {
 156                 LASSERT(work_list != NULL);
 157                 rc = ldlm_plain_compat_queue(&res->lr_granted, lock, NULL);
 158                 if (!rc)
 159                         RETURN(LDLM_ITER_STOP);
 160                 rc = ldlm_plain_compat_queue(&res->lr_waiting, lock, NULL);
 161                 if (!rc)
 162                         RETURN(LDLM_ITER_STOP);
 163
 164                 ldlm_resource_unlink_lock(lock);
 165                 ldlm_grant_lock(lock, work_list);
 166                 RETURN(LDLM_ITER_CONTINUE);
 167         }
 168
 169  restart:
 170         rc = ldlm_plain_compat_queue(&res->lr_granted, lock, &rpc_list);
 171         rc += ldlm_plain_compat_queue(&res->lr_waiting, lock, &rpc_list);
 172
 173         if (rc != 2) {
 174                 /* If either of the compat_queue()s returned 0, then we
 175                  * have ASTs to send and must go onto the waiting list.
 176                  *
 177                  * bug 2322: we used to unlink and re-add here, which was a
 178                  * terrible folly -- if we goto restart, we could get
 179                  * re-ordered!  Causes deadlock, because ASTs aren't sent! */
 180                 if (cfs_list_empty(&lock->l_res_link))
 181                         ldlm_resource_add_lock(res, &res->lr_waiting, lock);
 182                 unlock_res(res);
 183                 rc = ldlm_run_ast_work(ldlm_res_to_ns(res), &rpc_list,
 184                                        LDLM_WORK_BL_AST);
 185                 lock_res(res);
 186                 if (rc == -ERESTART)
 187                         GOTO(restart, -ERESTART);
 188                 *flags |= LDLM_FL_BLOCK_GRANTED;
 189         } else {
 190                 ldlm_resource_unlink_lock(lock);
 191                 ldlm_grant_lock(lock, NULL);
 192         }
 193         RETURN(0);
 194 }
 195 #endif /* HAVE_SERVER_SUPPORT */
 196
 197 void ldlm_plain_policy_wire_to_local(const ldlm_wire_policy_data_t *wpolicy,
 198                                      ldlm_policy_data_t *lpolicy)
 199 {
 200         /* No policy for plain locks */
 201 }
 202
 203 void ldlm_plain_policy_local_to_wire(const ldlm_policy_data_t *lpolicy,
 204                                      ldlm_wire_policy_data_t *wpolicy)
 205 {
 206         /* No policy for plain locks */
 207 }