blob: 54a8e65e18b622edf10df6d07ca0d84fea9e49ae [file] [log] [blame]
Waiman Long70af2f82014-02-03 13:18:49 +01001/*
2 * Queue read/write lock
3 *
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation; either version 2 of the License, or
7 * (at your option) any later version.
8 *
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
13 *
14 * (C) Copyright 2013-2014 Hewlett-Packard Development Company, L.P.
15 *
16 * Authors: Waiman Long <waiman.long@hp.com>
17 */
18#ifndef __ASM_GENERIC_QRWLOCK_H
19#define __ASM_GENERIC_QRWLOCK_H
20
21#include <linux/atomic.h>
22#include <asm/barrier.h>
23#include <asm/processor.h>
24
25#include <asm-generic/qrwlock_types.h>
26
27/*
28 * Writer states & reader shift and bias
29 */
30#define _QW_WAITING 1 /* A writer is waiting */
31#define _QW_LOCKED 0xff /* A writer holds the lock */
32#define _QW_WMASK 0xff /* Writer mask */
33#define _QR_SHIFT 8 /* Reader count shift */
34#define _QR_BIAS (1U << _QR_SHIFT)
35
36/*
37 * External function declarations
38 */
Waiman Long0e06e5b2015-06-19 11:50:01 -040039extern void queued_read_lock_slowpath(struct qrwlock *lock, u32 cnts);
Waiman Longf7d71f22015-06-19 11:50:00 -040040extern void queued_write_lock_slowpath(struct qrwlock *lock);
Waiman Long70af2f82014-02-03 13:18:49 +010041
42/**
Waiman Longf7d71f22015-06-19 11:50:00 -040043 * queued_read_can_lock- would read_trylock() succeed?
Waiman Long70af2f82014-02-03 13:18:49 +010044 * @lock: Pointer to queue rwlock structure
45 */
Waiman Longf7d71f22015-06-19 11:50:00 -040046static inline int queued_read_can_lock(struct qrwlock *lock)
Waiman Long70af2f82014-02-03 13:18:49 +010047{
48 return !(atomic_read(&lock->cnts) & _QW_WMASK);
49}
50
51/**
Waiman Longf7d71f22015-06-19 11:50:00 -040052 * queued_write_can_lock- would write_trylock() succeed?
Waiman Long70af2f82014-02-03 13:18:49 +010053 * @lock: Pointer to queue rwlock structure
54 */
Waiman Longf7d71f22015-06-19 11:50:00 -040055static inline int queued_write_can_lock(struct qrwlock *lock)
Waiman Long70af2f82014-02-03 13:18:49 +010056{
57 return !atomic_read(&lock->cnts);
58}
59
60/**
Waiman Longf7d71f22015-06-19 11:50:00 -040061 * queued_read_trylock - try to acquire read lock of a queue rwlock
Waiman Long70af2f82014-02-03 13:18:49 +010062 * @lock : Pointer to queue rwlock structure
63 * Return: 1 if lock acquired, 0 if failed
64 */
Waiman Longf7d71f22015-06-19 11:50:00 -040065static inline int queued_read_trylock(struct qrwlock *lock)
Waiman Long70af2f82014-02-03 13:18:49 +010066{
67 u32 cnts;
68
69 cnts = atomic_read(&lock->cnts);
70 if (likely(!(cnts & _QW_WMASK))) {
Will Deacon77e430e2015-08-06 17:54:42 +010071 cnts = (u32)atomic_add_return_acquire(_QR_BIAS, &lock->cnts);
Waiman Long70af2f82014-02-03 13:18:49 +010072 if (likely(!(cnts & _QW_WMASK)))
73 return 1;
74 atomic_sub(_QR_BIAS, &lock->cnts);
75 }
76 return 0;
77}
78
79/**
Waiman Longf7d71f22015-06-19 11:50:00 -040080 * queued_write_trylock - try to acquire write lock of a queue rwlock
Waiman Long70af2f82014-02-03 13:18:49 +010081 * @lock : Pointer to queue rwlock structure
82 * Return: 1 if lock acquired, 0 if failed
83 */
Waiman Longf7d71f22015-06-19 11:50:00 -040084static inline int queued_write_trylock(struct qrwlock *lock)
Waiman Long70af2f82014-02-03 13:18:49 +010085{
86 u32 cnts;
87
88 cnts = atomic_read(&lock->cnts);
89 if (unlikely(cnts))
90 return 0;
91
Will Deacon77e430e2015-08-06 17:54:42 +010092 return likely(atomic_cmpxchg_acquire(&lock->cnts,
93 cnts, cnts | _QW_LOCKED) == cnts);
Waiman Long70af2f82014-02-03 13:18:49 +010094}
95/**
Waiman Longf7d71f22015-06-19 11:50:00 -040096 * queued_read_lock - acquire read lock of a queue rwlock
Waiman Long70af2f82014-02-03 13:18:49 +010097 * @lock: Pointer to queue rwlock structure
98 */
Waiman Longf7d71f22015-06-19 11:50:00 -040099static inline void queued_read_lock(struct qrwlock *lock)
Waiman Long70af2f82014-02-03 13:18:49 +0100100{
101 u32 cnts;
102
Will Deacon77e430e2015-08-06 17:54:42 +0100103 cnts = atomic_add_return_acquire(_QR_BIAS, &lock->cnts);
Waiman Long70af2f82014-02-03 13:18:49 +0100104 if (likely(!(cnts & _QW_WMASK)))
105 return;
106
107 /* The slowpath will decrement the reader count, if necessary. */
Waiman Long0e06e5b2015-06-19 11:50:01 -0400108 queued_read_lock_slowpath(lock, cnts);
Waiman Long70af2f82014-02-03 13:18:49 +0100109}
110
111/**
Waiman Longf7d71f22015-06-19 11:50:00 -0400112 * queued_write_lock - acquire write lock of a queue rwlock
Waiman Long70af2f82014-02-03 13:18:49 +0100113 * @lock : Pointer to queue rwlock structure
114 */
Waiman Longf7d71f22015-06-19 11:50:00 -0400115static inline void queued_write_lock(struct qrwlock *lock)
Waiman Long70af2f82014-02-03 13:18:49 +0100116{
117 /* Optimize for the unfair lock case where the fair flag is 0. */
Will Deacon77e430e2015-08-06 17:54:42 +0100118 if (atomic_cmpxchg_acquire(&lock->cnts, 0, _QW_LOCKED) == 0)
Waiman Long70af2f82014-02-03 13:18:49 +0100119 return;
120
Waiman Longf7d71f22015-06-19 11:50:00 -0400121 queued_write_lock_slowpath(lock);
Waiman Long70af2f82014-02-03 13:18:49 +0100122}
123
124/**
Waiman Longf7d71f22015-06-19 11:50:00 -0400125 * queued_read_unlock - release read lock of a queue rwlock
Waiman Long70af2f82014-02-03 13:18:49 +0100126 * @lock : Pointer to queue rwlock structure
127 */
Waiman Longf7d71f22015-06-19 11:50:00 -0400128static inline void queued_read_unlock(struct qrwlock *lock)
Waiman Long70af2f82014-02-03 13:18:49 +0100129{
130 /*
131 * Atomically decrement the reader count
132 */
Will Deacon77e430e2015-08-06 17:54:42 +0100133 (void)atomic_sub_return_release(_QR_BIAS, &lock->cnts);
Waiman Long70af2f82014-02-03 13:18:49 +0100134}
135
Waiman Long70af2f82014-02-03 13:18:49 +0100136/**
Waiman Longf7d71f22015-06-19 11:50:00 -0400137 * queued_write_unlock - release write lock of a queue rwlock
Waiman Long70af2f82014-02-03 13:18:49 +0100138 * @lock : Pointer to queue rwlock structure
139 */
Waiman Longf7d71f22015-06-19 11:50:00 -0400140static inline void queued_write_unlock(struct qrwlock *lock)
Waiman Long70af2f82014-02-03 13:18:49 +0100141{
Will Deacon2b2a85a2015-08-06 17:54:41 +0100142 smp_store_release((u8 *)&lock->cnts, 0);
Waiman Long70af2f82014-02-03 13:18:49 +0100143}
Waiman Long70af2f82014-02-03 13:18:49 +0100144
145/*
146 * Remapping rwlock architecture specific functions to the corresponding
147 * queue rwlock functions.
148 */
Waiman Longf7d71f22015-06-19 11:50:00 -0400149#define arch_read_can_lock(l) queued_read_can_lock(l)
150#define arch_write_can_lock(l) queued_write_can_lock(l)
151#define arch_read_lock(l) queued_read_lock(l)
152#define arch_write_lock(l) queued_write_lock(l)
153#define arch_read_trylock(l) queued_read_trylock(l)
154#define arch_write_trylock(l) queued_write_trylock(l)
155#define arch_read_unlock(l) queued_read_unlock(l)
156#define arch_write_unlock(l) queued_write_unlock(l)
Waiman Long70af2f82014-02-03 13:18:49 +0100157
158#endif /* __ASM_GENERIC_QRWLOCK_H */