Loading...
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 | // SPDX-License-Identifier: GPL-2.0
/*
* GPL HEADER START
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License version 2 only,
* as published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* General Public License version 2 for more details (a copy is included
* in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU General Public License
* version 2 along with this program; If not, see
* http://www.gnu.org/licenses/gpl-2.0.html
*
* GPL HEADER END
*/
/*
* Range lock is used to allow multiple threads writing a single shared
* file given each thread is writing to a non-overlapping portion of the
* file.
*
* Refer to the possible upstream kernel version of range lock by
* Jan Kara <jack@suse.cz>: https://lkml.org/lkml/2013/1/31/480
*
* This file could later replaced by the upstream kernel version.
*/
/*
* Author: Prakash Surya <surya1@llnl.gov>
* Author: Bobi Jam <bobijam.xu@intel.com>
*/
#include "range_lock.h"
#include <uapi/linux/lustre/lustre_idl.h>
/**
* Initialize a range lock tree
*
* \param tree [in] an empty range lock tree
*
* Pre: Caller should have allocated the range lock tree.
* Post: The range lock tree is ready to function.
*/
void range_lock_tree_init(struct range_lock_tree *tree)
{
tree->rlt_root = NULL;
tree->rlt_sequence = 0;
spin_lock_init(&tree->rlt_lock);
}
/**
* Initialize a range lock node
*
* \param lock [in] an empty range lock node
* \param start [in] start of the covering region
* \param end [in] end of the covering region
*
* Pre: Caller should have allocated the range lock node.
* Post: The range lock node is meant to cover [start, end] region
*/
int range_lock_init(struct range_lock *lock, __u64 start, __u64 end)
{
int rc;
memset(&lock->rl_node, 0, sizeof(lock->rl_node));
if (end != LUSTRE_EOF)
end >>= PAGE_SHIFT;
rc = interval_set(&lock->rl_node, start >> PAGE_SHIFT, end);
if (rc)
return rc;
INIT_LIST_HEAD(&lock->rl_next_lock);
lock->rl_task = NULL;
lock->rl_lock_count = 0;
lock->rl_blocking_ranges = 0;
lock->rl_sequence = 0;
return rc;
}
static inline struct range_lock *next_lock(struct range_lock *lock)
{
return list_entry(lock->rl_next_lock.next, typeof(*lock), rl_next_lock);
}
/**
* Helper function of range_unlock()
*
* \param node [in] a range lock found overlapped during interval node
* search
* \param arg [in] the range lock to be tested
*
* \retval INTERVAL_ITER_CONT indicate to continue the search for next
* overlapping range node
* \retval INTERVAL_ITER_STOP indicate to stop the search
*/
static enum interval_iter range_unlock_cb(struct interval_node *node, void *arg)
{
struct range_lock *lock = arg;
struct range_lock *overlap = node2rangelock(node);
struct range_lock *iter;
list_for_each_entry(iter, &overlap->rl_next_lock, rl_next_lock) {
if (iter->rl_sequence > lock->rl_sequence) {
--iter->rl_blocking_ranges;
LASSERT(iter->rl_blocking_ranges > 0);
}
}
if (overlap->rl_sequence > lock->rl_sequence) {
--overlap->rl_blocking_ranges;
if (overlap->rl_blocking_ranges == 0)
wake_up_process(overlap->rl_task);
}
return INTERVAL_ITER_CONT;
}
/**
* Unlock a range lock, wake up locks blocked by this lock.
*
* \param tree [in] range lock tree
* \param lock [in] range lock to be deleted
*
* If this lock has been granted, relase it; if not, just delete it from
* the tree or the same region lock list. Wake up those locks only blocked
* by this lock through range_unlock_cb().
*/
void range_unlock(struct range_lock_tree *tree, struct range_lock *lock)
{
spin_lock(&tree->rlt_lock);
if (!list_empty(&lock->rl_next_lock)) {
struct range_lock *next;
if (interval_is_intree(&lock->rl_node)) { /* first lock */
/* Insert the next same range lock into the tree */
next = next_lock(lock);
next->rl_lock_count = lock->rl_lock_count - 1;
interval_erase(&lock->rl_node, &tree->rlt_root);
interval_insert(&next->rl_node, &tree->rlt_root);
} else {
/* find the first lock in tree */
list_for_each_entry(next, &lock->rl_next_lock,
rl_next_lock) {
if (!interval_is_intree(&next->rl_node))
continue;
LASSERT(next->rl_lock_count > 0);
next->rl_lock_count--;
break;
}
}
list_del_init(&lock->rl_next_lock);
} else {
LASSERT(interval_is_intree(&lock->rl_node));
interval_erase(&lock->rl_node, &tree->rlt_root);
}
interval_search(tree->rlt_root, &lock->rl_node.in_extent,
range_unlock_cb, lock);
spin_unlock(&tree->rlt_lock);
}
/**
* Helper function of range_lock()
*
* \param node [in] a range lock found overlapped during interval node
* search
* \param arg [in] the range lock to be tested
*
* \retval INTERVAL_ITER_CONT indicate to continue the search for next
* overlapping range node
* \retval INTERVAL_ITER_STOP indicate to stop the search
*/
static enum interval_iter range_lock_cb(struct interval_node *node, void *arg)
{
struct range_lock *lock = arg;
struct range_lock *overlap = node2rangelock(node);
lock->rl_blocking_ranges += overlap->rl_lock_count + 1;
return INTERVAL_ITER_CONT;
}
/**
* Lock a region
*
* \param tree [in] range lock tree
* \param lock [in] range lock node containing the region span
*
* \retval 0 get the range lock
* \retval <0 error code while not getting the range lock
*
* If there exists overlapping range lock, the new lock will wait and
* retry, if later it find that it is not the chosen one to wake up,
* it wait again.
*/
int range_lock(struct range_lock_tree *tree, struct range_lock *lock)
{
struct interval_node *node;
int rc = 0;
spin_lock(&tree->rlt_lock);
/*
* We need to check for all conflicting intervals
* already in the tree.
*/
interval_search(tree->rlt_root, &lock->rl_node.in_extent,
range_lock_cb, lock);
/*
* Insert to the tree if I am unique, otherwise I've been linked to
* the rl_next_lock of another lock which has the same range as mine
* in range_lock_cb().
*/
node = interval_insert(&lock->rl_node, &tree->rlt_root);
if (node) {
struct range_lock *tmp = node2rangelock(node);
list_add_tail(&lock->rl_next_lock, &tmp->rl_next_lock);
tmp->rl_lock_count++;
}
lock->rl_sequence = ++tree->rlt_sequence;
while (lock->rl_blocking_ranges > 0) {
lock->rl_task = current;
__set_current_state(TASK_INTERRUPTIBLE);
spin_unlock(&tree->rlt_lock);
schedule();
if (signal_pending(current)) {
range_unlock(tree, lock);
rc = -EINTR;
goto out;
}
spin_lock(&tree->rlt_lock);
}
spin_unlock(&tree->rlt_lock);
out:
return rc;
}
|