kernel/locking/qrwlock.c

   1 /*
   2  * Queued read/write locks
   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 #include <linux/smp.h>
  19 #include <linux/bug.h>
  20 #include <linux/cpumask.h>
  21 #include <linux/percpu.h>
  22 #include <linux/hardirq.h>
  23 #include <asm/qrwlock.h>
  24
  25 /*
  26  * This internal data structure is used for optimizing access to some of
  27  * the subfields within the atomic_t cnts.
  28  */
  29 struct __qrwlock {
  30         union {
  31                 atomic_t cnts;
  32                 struct {
  33 #ifdef __LITTLE_ENDIAN
  34                         u8 wmode;       /* Writer mode   */
  35                         u8 rcnts[3];    /* Reader counts */
  36 #else
  37                         u8 rcnts[3];    /* Reader counts */
  38                         u8 wmode;       /* Writer mode   */
  39 #endif
  40                 };
  41         };
  42         arch_spinlock_t lock;
  43 };
  44
  45 /**
  46  * rspin_until_writer_unlock - inc reader count & spin until writer is gone
  47  * @lock  : Pointer to queue rwlock structure
  48  * @writer: Current queue rwlock writer status byte
  49  *
  50  * In interrupt context or at the head of the queue, the reader will just
  51  * increment the reader count & wait until the writer releases the lock.
  52  */
  53 static __always_inline void
  54 rspin_until_writer_unlock(struct qrwlock *lock, u32 cnts)
  55 {
  56         while ((cnts & _QW_WMASK) == _QW_LOCKED) {
  57                 cpu_relax_lowlatency();
  58                 cnts = smp_load_acquire((u32 *)&lock->cnts);
  59         }
  60 }
  61
  62 /**
  63  * queued_read_lock_slowpath - acquire read lock of a queue rwlock
  64  * @lock: Pointer to queue rwlock structure
  65  * @cnts: Current qrwlock lock value
  66  */
  67 void queued_read_lock_slowpath(struct qrwlock *lock, u32 cnts)
  68 {
  69         /*
  70          * Readers come here when they cannot get the lock without waiting
  71          */
  72         if (unlikely(in_interrupt())) {
  73                 /*
  74                  * Readers in interrupt context will get the lock immediately
  75                  * if the writer is just waiting (not holding the lock yet).
  76                  * The rspin_until_writer_unlock() function returns immediately
  77                  * in this case. Otherwise, they will spin until the lock
  78                  * is available without waiting in the queue.
  79                  */
  80                 rspin_until_writer_unlock(lock, cnts);
  81                 return;
  82         }
  83         atomic_sub(_QR_BIAS, &lock->cnts);
  84
  85         /*
  86          * Put the reader into the wait queue
  87          */
  88         arch_spin_lock(&lock->lock);
  89
  90         /*
  91          * At the head of the wait queue now, wait until the writer state
  92          * goes to 0 and then try to increment the reader count and get
  93          * the lock. It is possible that an incoming writer may steal the
  94          * lock in the interim, so it is necessary to check the writer byte
  95          * to make sure that the write lock isn't taken.
  96          */
  97         while (atomic_read(&lock->cnts) & _QW_WMASK)
  98                 cpu_relax_lowlatency();
  99
 100         cnts = atomic_add_return(_QR_BIAS, &lock->cnts) - _QR_BIAS;
 101         rspin_until_writer_unlock(lock, cnts);
 102
 103         /*
 104          * Signal the next one in queue to become queue head
 105          */
 106         arch_spin_unlock(&lock->lock);
 107 }
 108 EXPORT_SYMBOL(queued_read_lock_slowpath);
 109
 110 /**
 111  * queued_write_lock_slowpath - acquire write lock of a queue rwlock
 112  * @lock : Pointer to queue rwlock structure
 113  */
 114 void queued_write_lock_slowpath(struct qrwlock *lock)
 115 {
 116         u32 cnts;
 117
 118         /* Put the writer into the wait queue */
 119         arch_spin_lock(&lock->lock);
 120
 121         /* Try to acquire the lock directly if no reader is present */
 122         if (!atomic_read(&lock->cnts) &&
 123             (atomic_cmpxchg(&lock->cnts, 0, _QW_LOCKED) == 0))
 124                 goto unlock;
 125
 126         /*
 127          * Set the waiting flag to notify readers that a writer is pending,
 128          * or wait for a previous writer to go away.
 129          */
 130         for (;;) {
 131                 struct __qrwlock *l = (struct __qrwlock *)lock;
 132
 133                 if (!READ_ONCE(l->wmode) &&
 134                    (cmpxchg(&l->wmode, 0, _QW_WAITING) == 0))
 135                         break;
 136
 137                 cpu_relax_lowlatency();
 138         }
 139
 140         /* When no more readers, set the locked flag */
 141         for (;;) {
 142                 cnts = atomic_read(&lock->cnts);
 143                 if ((cnts == _QW_WAITING) &&
 144                     (atomic_cmpxchg(&lock->cnts, _QW_WAITING,
 145                                     _QW_LOCKED) == _QW_WAITING))
 146                         break;
 147
 148                 cpu_relax_lowlatency();
 149         }
 150 unlock:
 151         arch_spin_unlock(&lock->lock);
 152 }
 153 EXPORT_SYMBOL(queued_write_lock_slowpath);