drivers/tty/tty_ldsem.c

   1 /*
   2  * Ldisc rw semaphore
   3  *
   4  * The ldisc semaphore is semantically a rw_semaphore but which enforces
   5  * an alternate policy, namely:
   6  *   1) Supports lock wait timeouts
   7  *   2) Write waiter has priority
   8  *   3) Downgrading is not supported
   9  *
  10  * Implementation notes:
  11  *   1) Upper half of semaphore count is a wait count (differs from rwsem
  12  *      in that rwsem normalizes the upper half to the wait bias)
  13  *   2) Lacks overflow checking
  14  *
  15  * The generic counting was copied and modified from include/asm-generic/rwsem.h
  16  * by Paul Mackerras <paulus@samba.org>.
  17  *
  18  * The scheduling policy was copied and modified from lib/rwsem.c
  19  * Written by David Howells (dhowells@redhat.com).
  20  *
  21  * This implementation incorporates the write lock stealing work of
  22  * Michel Lespinasse <walken@google.com>.
  23  *
  24  * Copyright (C) 2013 Peter Hurley <peter@hurleysoftware.com>
  25  *
  26  * This file may be redistributed under the terms of the GNU General Public
  27  * License v2.
  28  */
  29
  30 #include <linux/list.h>
  31 #include <linux/spinlock.h>
  32 #include <linux/atomic.h>
  33 #include <linux/tty.h>
  34 #include <linux/sched.h>
  35 #include <linux/sched/debug.h>
  36 #include <linux/sched/task.h>
  37
  38
  39 #ifdef CONFIG_DEBUG_LOCK_ALLOC
  40 # define __acq(l, s, t, r, c, n, i)             \
  41                                 lock_acquire(&(l)->dep_map, s, t, r, c, n, i)
  42 # define __rel(l, n, i)                         \
  43                                 lock_release(&(l)->dep_map, n, i)
  44 #define lockdep_acquire(l, s, t, i)             __acq(l, s, t, 0, 1, NULL, i)
  45 #define lockdep_acquire_nest(l, s, t, n, i)     __acq(l, s, t, 0, 1, n, i)
  46 #define lockdep_acquire_read(l, s, t, i)        __acq(l, s, t, 1, 1, NULL, i)
  47 #define lockdep_release(l, n, i)                __rel(l, n, i)
  48 #else
  49 # define lockdep_acquire(l, s, t, i)            do { } while (0)
  50 # define lockdep_acquire_nest(l, s, t, n, i)    do { } while (0)
  51 # define lockdep_acquire_read(l, s, t, i)       do { } while (0)
  52 # define lockdep_release(l, n, i)               do { } while (0)
  53 #endif
  54
  55 #ifdef CONFIG_LOCK_STAT
  56 # define lock_stat(_lock, stat)         lock_##stat(&(_lock)->dep_map, _RET_IP_)
  57 #else
  58 # define lock_stat(_lock, stat)         do { } while (0)
  59 #endif
  60
  61
  62 #if BITS_PER_LONG == 64
  63 # define LDSEM_ACTIVE_MASK      0xffffffffL
  64 #else
  65 # define LDSEM_ACTIVE_MASK      0x0000ffffL
  66 #endif
  67
  68 #define LDSEM_UNLOCKED          0L
  69 #define LDSEM_ACTIVE_BIAS       1L
  70 #define LDSEM_WAIT_BIAS         (-LDSEM_ACTIVE_MASK-1)
  71 #define LDSEM_READ_BIAS         LDSEM_ACTIVE_BIAS
  72 #define LDSEM_WRITE_BIAS        (LDSEM_WAIT_BIAS + LDSEM_ACTIVE_BIAS)
  73
  74 struct ldsem_waiter {
  75         struct list_head list;
  76         struct task_struct *task;
  77 };
  78
  79 static inline long ldsem_atomic_update(long delta, struct ld_semaphore *sem)
  80 {
  81         return atomic_long_add_return(delta, (atomic_long_t *)&sem->count);
  82 }
  83
  84 /*
  85  * ldsem_cmpxchg() updates @*old with the last-known sem->count value.
  86  * Returns 1 if count was successfully changed; @*old will have @new value.
  87  * Returns 0 if count was not changed; @*old will have most recent sem->count
  88  */
  89 static inline int ldsem_cmpxchg(long *old, long new, struct ld_semaphore *sem)
  90 {
  91         long tmp = atomic_long_cmpxchg(&sem->count, *old, new);
  92         if (tmp == *old) {
  93                 *old = new;
  94                 return 1;
  95         } else {
  96                 *old = tmp;
  97                 return 0;
  98         }
  99 }
 100
 101 /*
 102  * Initialize an ldsem:
 103  */
 104 void __init_ldsem(struct ld_semaphore *sem, const char *name,
 105                   struct lock_class_key *key)
 106 {
 107 #ifdef CONFIG_DEBUG_LOCK_ALLOC
 108         /*
 109          * Make sure we are not reinitializing a held semaphore:
 110          */
 111         debug_check_no_locks_freed((void *)sem, sizeof(*sem));
 112         lockdep_init_map(&sem->dep_map, name, key, 0);
 113 #endif
 114         sem->count = LDSEM_UNLOCKED;
 115         sem->wait_readers = 0;
 116         raw_spin_lock_init(&sem->wait_lock);
 117         INIT_LIST_HEAD(&sem->read_wait);
 118         INIT_LIST_HEAD(&sem->write_wait);
 119 }
 120
 121 static void __ldsem_wake_readers(struct ld_semaphore *sem)
 122 {
 123         struct ldsem_waiter *waiter, *next;
 124         struct task_struct *tsk;
 125         long adjust, count;
 126
 127         /* Try to grant read locks to all readers on the read wait list.
 128          * Note the 'active part' of the count is incremented by
 129          * the number of readers before waking any processes up.
 130          */
 131         adjust = sem->wait_readers * (LDSEM_ACTIVE_BIAS - LDSEM_WAIT_BIAS);
 132         count = ldsem_atomic_update(adjust, sem);
 133         do {
 134                 if (count > 0)
 135                         break;
 136                 if (ldsem_cmpxchg(&count, count - adjust, sem))
 137                         return;
 138         } while (1);
 139
 140         list_for_each_entry_safe(waiter, next, &sem->read_wait, list) {
 141                 tsk = waiter->task;
 142                 smp_store_release(&waiter->task, NULL);
 143                 wake_up_process(tsk);
 144                 put_task_struct(tsk);
 145         }
 146         INIT_LIST_HEAD(&sem->read_wait);
 147         sem->wait_readers = 0;
 148 }
 149
 150 static inline int writer_trylock(struct ld_semaphore *sem)
 151 {
 152         /* only wake this writer if the active part of the count can be
 153          * transitioned from 0 -> 1
 154          */
 155         long count = ldsem_atomic_update(LDSEM_ACTIVE_BIAS, sem);
 156         do {
 157                 if ((count & LDSEM_ACTIVE_MASK) == LDSEM_ACTIVE_BIAS)
 158                         return 1;
 159                 if (ldsem_cmpxchg(&count, count - LDSEM_ACTIVE_BIAS, sem))
 160                         return 0;
 161         } while (1);
 162 }
 163
 164 static void __ldsem_wake_writer(struct ld_semaphore *sem)
 165 {
 166         struct ldsem_waiter *waiter;
 167
 168         waiter = list_entry(sem->write_wait.next, struct ldsem_waiter, list);
 169         wake_up_process(waiter->task);
 170 }
 171
 172 /*
 173  * handle the lock release when processes blocked on it that can now run
 174  * - if we come here from up_xxxx(), then:
 175  *   - the 'active part' of count (&0x0000ffff) reached 0 (but may have changed)
 176  *   - the 'waiting part' of count (&0xffff0000) is -ve (and will still be so)
 177  * - the spinlock must be held by the caller
 178  * - woken process blocks are discarded from the list after having task zeroed
 179  */
 180 static void __ldsem_wake(struct ld_semaphore *sem)
 181 {
 182         if (!list_empty(&sem->write_wait))
 183                 __ldsem_wake_writer(sem);
 184         else if (!list_empty(&sem->read_wait))
 185                 __ldsem_wake_readers(sem);
 186 }
 187
 188 static void ldsem_wake(struct ld_semaphore *sem)
 189 {
 190         unsigned long flags;
 191
 192         raw_spin_lock_irqsave(&sem->wait_lock, flags);
 193         __ldsem_wake(sem);
 194         raw_spin_unlock_irqrestore(&sem->wait_lock, flags);
 195 }
 196
 197 /*
 198  * wait for the read lock to be granted
 199  */
 200 static struct ld_semaphore __sched *
 201 down_read_failed(struct ld_semaphore *sem, long count, long timeout)
 202 {
 203         struct ldsem_waiter waiter;
 204         long adjust = -LDSEM_ACTIVE_BIAS + LDSEM_WAIT_BIAS;
 205
 206         /* set up my own style of waitqueue */
 207         raw_spin_lock_irq(&sem->wait_lock);
 208
 209         /* Try to reverse the lock attempt but if the count has changed
 210          * so that reversing fails, check if there are are no waiters,
 211          * and early-out if not */
 212         do {
 213                 if (ldsem_cmpxchg(&count, count + adjust, sem))
 214                         break;
 215                 if (count > 0) {
 216                         raw_spin_unlock_irq(&sem->wait_lock);
 217                         return sem;
 218                 }
 219         } while (1);
 220
 221         list_add_tail(&waiter.list, &sem->read_wait);
 222         sem->wait_readers++;
 223
 224         waiter.task = current;
 225         get_task_struct(current);
 226
 227         /* if there are no active locks, wake the new lock owner(s) */
 228         if ((count & LDSEM_ACTIVE_MASK) == 0)
 229                 __ldsem_wake(sem);
 230
 231         raw_spin_unlock_irq(&sem->wait_lock);
 232
 233         /* wait to be given the lock */
 234         for (;;) {
 235                 set_current_state(TASK_UNINTERRUPTIBLE);
 236
 237                 if (!smp_load_acquire(&waiter.task))
 238                         break;
 239                 if (!timeout)
 240                         break;
 241                 timeout = schedule_timeout(timeout);
 242         }
 243
 244         __set_current_state(TASK_RUNNING);
 245
 246         if (!timeout) {
 247                 /* lock timed out but check if this task was just
 248                  * granted lock ownership - if so, pretend there
 249                  * was no timeout; otherwise, cleanup lock wait */
 250                 raw_spin_lock_irq(&sem->wait_lock);
 251                 if (waiter.task) {
 252                         ldsem_atomic_update(-LDSEM_WAIT_BIAS, sem);
 253                         list_del(&waiter.list);
 254                         raw_spin_unlock_irq(&sem->wait_lock);
 255                         put_task_struct(waiter.task);
 256                         return NULL;
 257                 }
 258                 raw_spin_unlock_irq(&sem->wait_lock);
 259         }
 260
 261         return sem;
 262 }
 263
 264 /*
 265  * wait for the write lock to be granted
 266  */
 267 static struct ld_semaphore __sched *
 268 down_write_failed(struct ld_semaphore *sem, long count, long timeout)
 269 {
 270         struct ldsem_waiter waiter;
 271         long adjust = -LDSEM_ACTIVE_BIAS;
 272         int locked = 0;
 273
 274         /* set up my own style of waitqueue */
 275         raw_spin_lock_irq(&sem->wait_lock);
 276
 277         /* Try to reverse the lock attempt but if the count has changed
 278          * so that reversing fails, check if the lock is now owned,
 279          * and early-out if so */
 280         do {
 281                 if (ldsem_cmpxchg(&count, count + adjust, sem))
 282                         break;
 283                 if ((count & LDSEM_ACTIVE_MASK) == LDSEM_ACTIVE_BIAS) {
 284                         raw_spin_unlock_irq(&sem->wait_lock);
 285                         return sem;
 286                 }
 287         } while (1);
 288
 289         list_add_tail(&waiter.list, &sem->write_wait);
 290
 291         waiter.task = current;
 292
 293         set_current_state(TASK_UNINTERRUPTIBLE);
 294         for (;;) {
 295                 if (!timeout)
 296                         break;
 297                 raw_spin_unlock_irq(&sem->wait_lock);
 298                 timeout = schedule_timeout(timeout);
 299                 raw_spin_lock_irq(&sem->wait_lock);
 300                 set_current_state(TASK_UNINTERRUPTIBLE);
 301                 locked = writer_trylock(sem);
 302                 if (locked)
 303                         break;
 304         }
 305
 306         if (!locked)
 307                 ldsem_atomic_update(-LDSEM_WAIT_BIAS, sem);
 308         list_del(&waiter.list);
 309
 310         /*
 311          * In case of timeout, wake up every reader who gave the right of way
 312          * to writer. Prevent separation readers into two groups:
 313          * one that helds semaphore and another that sleeps.
 314          * (in case of no contention with a writer)
 315          */
 316         if (!locked && list_empty(&sem->write_wait))
 317                 __ldsem_wake_readers(sem);
 318
 319         raw_spin_unlock_irq(&sem->wait_lock);
 320
 321         __set_current_state(TASK_RUNNING);
 322
 323         /* lock wait may have timed out */
 324         if (!locked)
 325                 return NULL;
 326         return sem;
 327 }
 328
 329
 330
 331 static int __ldsem_down_read_nested(struct ld_semaphore *sem,
 332                                            int subclass, long timeout)
 333 {
 334         long count;
 335
 336         lockdep_acquire_read(sem, subclass, 0, _RET_IP_);
 337
 338         count = ldsem_atomic_update(LDSEM_READ_BIAS, sem);
 339         if (count <= 0) {
 340                 lock_stat(sem, contended);
 341                 if (!down_read_failed(sem, count, timeout)) {
 342                         lockdep_release(sem, 1, _RET_IP_);
 343                         return 0;
 344                 }
 345         }
 346         lock_stat(sem, acquired);
 347         return 1;
 348 }
 349
 350 static int __ldsem_down_write_nested(struct ld_semaphore *sem,
 351                                             int subclass, long timeout)
 352 {
 353         long count;
 354
 355         lockdep_acquire(sem, subclass, 0, _RET_IP_);
 356
 357         count = ldsem_atomic_update(LDSEM_WRITE_BIAS, sem);
 358         if ((count & LDSEM_ACTIVE_MASK) != LDSEM_ACTIVE_BIAS) {
 359                 lock_stat(sem, contended);
 360                 if (!down_write_failed(sem, count, timeout)) {
 361                         lockdep_release(sem, 1, _RET_IP_);
 362                         return 0;
 363                 }
 364         }
 365         lock_stat(sem, acquired);
 366         return 1;
 367 }
 368
 369
 370 /*
 371  * lock for reading -- returns 1 if successful, 0 if timed out
 372  */
 373 int __sched ldsem_down_read(struct ld_semaphore *sem, long timeout)
 374 {
 375         might_sleep();
 376         return __ldsem_down_read_nested(sem, 0, timeout);
 377 }
 378
 379 /*
 380  * trylock for reading -- returns 1 if successful, 0 if contention
 381  */
 382 int ldsem_down_read_trylock(struct ld_semaphore *sem)
 383 {
 384         long count = sem->count;
 385
 386         while (count >= 0) {
 387                 if (ldsem_cmpxchg(&count, count + LDSEM_READ_BIAS, sem)) {
 388                         lockdep_acquire_read(sem, 0, 1, _RET_IP_);
 389                         lock_stat(sem, acquired);
 390                         return 1;
 391                 }
 392         }
 393         return 0;
 394 }
 395
 396 /*
 397  * lock for writing -- returns 1 if successful, 0 if timed out
 398  */
 399 int __sched ldsem_down_write(struct ld_semaphore *sem, long timeout)
 400 {
 401         might_sleep();
 402         return __ldsem_down_write_nested(sem, 0, timeout);
 403 }
 404
 405 /*
 406  * trylock for writing -- returns 1 if successful, 0 if contention
 407  */
 408 int ldsem_down_write_trylock(struct ld_semaphore *sem)
 409 {
 410         long count = sem->count;
 411
 412         while ((count & LDSEM_ACTIVE_MASK) == 0) {
 413                 if (ldsem_cmpxchg(&count, count + LDSEM_WRITE_BIAS, sem)) {
 414                         lockdep_acquire(sem, 0, 1, _RET_IP_);
 415                         lock_stat(sem, acquired);
 416                         return 1;
 417                 }
 418         }
 419         return 0;
 420 }
 421
 422 /*
 423  * release a read lock
 424  */
 425 void ldsem_up_read(struct ld_semaphore *sem)
 426 {
 427         long count;
 428
 429         lockdep_release(sem, 1, _RET_IP_);
 430
 431         count = ldsem_atomic_update(-LDSEM_READ_BIAS, sem);
 432         if (count < 0 && (count & LDSEM_ACTIVE_MASK) == 0)
 433                 ldsem_wake(sem);
 434 }
 435
 436 /*
 437  * release a write lock
 438  */
 439 void ldsem_up_write(struct ld_semaphore *sem)
 440 {
 441         long count;
 442
 443         lockdep_release(sem, 1, _RET_IP_);
 444
 445         count = ldsem_atomic_update(-LDSEM_WRITE_BIAS, sem);
 446         if (count < 0)
 447                 ldsem_wake(sem);
 448 }
 449
 450
 451 #ifdef CONFIG_DEBUG_LOCK_ALLOC
 452
 453 int ldsem_down_read_nested(struct ld_semaphore *sem, int subclass, long timeout)
 454 {
 455         might_sleep();
 456         return __ldsem_down_read_nested(sem, subclass, timeout);
 457 }
 458
 459 int ldsem_down_write_nested(struct ld_semaphore *sem, int subclass,
 460                             long timeout)
 461 {
 462         might_sleep();
 463         return __ldsem_down_write_nested(sem, subclass, timeout);
 464 }
 465
 466 #endif