qrwlock.h 4.1 KB
Newer Older
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
/*
 * Queue read/write lock
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * 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 for more details.
 *
 * (C) Copyright 2013-2014 Hewlett-Packard Development Company, L.P.
 *
 * Authors: Waiman Long <waiman.long@hp.com>
 */
#ifndef __ASM_GENERIC_QRWLOCK_H
#define __ASM_GENERIC_QRWLOCK_H

#include <linux/atomic.h>
#include <asm/barrier.h>
#include <asm/processor.h>

#include <asm-generic/qrwlock_types.h>

/*
28 29 30 31 32 33 34 35 36 37 38 39 40 41
 * Writer states & reader shift and bias.
 *
 *       | +0 | +1 | +2 | +3 |
 *   ----+----+----+----+----+
 *    LE | 78 | 56 | 34 | 12 | 0x12345678
 *   ----+----+----+----+----+
 *       | wr |      rd      |
 *       +----+----+----+----+
 *
 *   ----+----+----+----+----+
 *    BE | 12 | 34 | 56 | 78 | 0x12345678
 *   ----+----+----+----+----+
 *       |      rd      | wr |
 *       +----+----+----+----+
42 43 44 45 46 47 48 49 50 51
 */
#define	_QW_WAITING	1		/* A writer is waiting	   */
#define	_QW_LOCKED	0xff		/* A writer holds the lock */
#define	_QW_WMASK	0xff		/* Writer mask		   */
#define	_QR_SHIFT	8		/* Reader count shift	   */
#define _QR_BIAS	(1U << _QR_SHIFT)

/*
 * External function declarations
 */
52
extern void queued_read_lock_slowpath(struct qrwlock *lock);
53
extern void queued_write_lock_slowpath(struct qrwlock *lock);
54 55

/**
56
 * queued_read_trylock - try to acquire read lock of a queue rwlock
57 58 59
 * @lock : Pointer to queue rwlock structure
 * Return: 1 if lock acquired, 0 if failed
 */
60
static inline int queued_read_trylock(struct qrwlock *lock)
61 62 63 64 65
{
	u32 cnts;

	cnts = atomic_read(&lock->cnts);
	if (likely(!(cnts & _QW_WMASK))) {
66
		cnts = (u32)atomic_add_return_acquire(_QR_BIAS, &lock->cnts);
67 68 69 70 71 72 73 74
		if (likely(!(cnts & _QW_WMASK)))
			return 1;
		atomic_sub(_QR_BIAS, &lock->cnts);
	}
	return 0;
}

/**
75
 * queued_write_trylock - try to acquire write lock of a queue rwlock
76 77 78
 * @lock : Pointer to queue rwlock structure
 * Return: 1 if lock acquired, 0 if failed
 */
79
static inline int queued_write_trylock(struct qrwlock *lock)
80 81 82 83 84 85 86
{
	u32 cnts;

	cnts = atomic_read(&lock->cnts);
	if (unlikely(cnts))
		return 0;

87 88
	return likely(atomic_cmpxchg_acquire(&lock->cnts,
					     cnts, cnts | _QW_LOCKED) == cnts);
89 90
}
/**
91
 * queued_read_lock - acquire read lock of a queue rwlock
92 93
 * @lock: Pointer to queue rwlock structure
 */
94
static inline void queued_read_lock(struct qrwlock *lock)
95 96 97
{
	u32 cnts;

98
	cnts = atomic_add_return_acquire(_QR_BIAS, &lock->cnts);
99 100 101 102
	if (likely(!(cnts & _QW_WMASK)))
		return;

	/* The slowpath will decrement the reader count, if necessary. */
103
	queued_read_lock_slowpath(lock);
104 105 106
}

/**
107
 * queued_write_lock - acquire write lock of a queue rwlock
108 109
 * @lock : Pointer to queue rwlock structure
 */
110
static inline void queued_write_lock(struct qrwlock *lock)
111 112
{
	/* Optimize for the unfair lock case where the fair flag is 0. */
113
	if (atomic_cmpxchg_acquire(&lock->cnts, 0, _QW_LOCKED) == 0)
114 115
		return;

116
	queued_write_lock_slowpath(lock);
117 118 119
}

/**
120
 * queued_read_unlock - release read lock of a queue rwlock
121 122
 * @lock : Pointer to queue rwlock structure
 */
123
static inline void queued_read_unlock(struct qrwlock *lock)
124 125 126 127
{
	/*
	 * Atomically decrement the reader count
	 */
128
	(void)atomic_sub_return_release(_QR_BIAS, &lock->cnts);
129 130 131
}

/**
132
 * queued_write_unlock - release write lock of a queue rwlock
133 134
 * @lock : Pointer to queue rwlock structure
 */
135
static inline void queued_write_unlock(struct qrwlock *lock)
136
{
137
	smp_store_release(&lock->wmode, 0);
138 139 140 141 142 143
}

/*
 * Remapping rwlock architecture specific functions to the corresponding
 * queue rwlock functions.
 */
144 145 146 147 148 149
#define arch_read_lock(l)	queued_read_lock(l)
#define arch_write_lock(l)	queued_write_lock(l)
#define arch_read_trylock(l)	queued_read_trylock(l)
#define arch_write_trylock(l)	queued_write_trylock(l)
#define arch_read_unlock(l)	queued_read_unlock(l)
#define arch_write_unlock(l)	queued_write_unlock(l)
150 151

#endif /* __ASM_GENERIC_QRWLOCK_H */