kernel/locking/qspinlock_paravirt.h

   1 #ifndef _GEN_PV_LOCK_SLOWPATH
   2 #error "do not include this file"
   3 #endif
   4
   5 #include <linux/hash.h>
   6 #include <linux/bootmem.h>
   7 #include <linux/debug_locks.h>
   8
   9 /*
  10  * Implement paravirt qspinlocks; the general idea is to halt the vcpus instead
  11  * of spinning them.
  12  *
  13  * This relies on the architecture to provide two paravirt hypercalls:
  14  *
  15  *   pv_wait(u8 *ptr, u8 val) -- suspends the vcpu if *ptr == val
  16  *   pv_kick(cpu)             -- wakes a suspended vcpu
  17  *
  18  * Using these we implement __pv_queued_spin_lock_slowpath() and
  19  * __pv_queued_spin_unlock() to replace native_queued_spin_lock_slowpath() and
  20  * native_queued_spin_unlock().
  21  */
  22
  23 #define _Q_SLOW_VAL     (3U << _Q_LOCKED_OFFSET)
  24
  25 /*
  26  * Queue Node Adaptive Spinning
  27  *
  28  * A queue node vCPU will stop spinning if the vCPU in the previous node is
  29  * not running. The one lock stealing attempt allowed at slowpath entry
  30  * mitigates the slight slowdown for non-overcommitted guest with this
  31  * aggressive wait-early mechanism.
  32  *
  33  * The status of the previous node will be checked at fixed interval
  34  * controlled by PV_PREV_CHECK_MASK. This is to ensure that we won't
  35  * pound on the cacheline of the previous node too heavily.
  36  */
  37 #define PV_PREV_CHECK_MASK      0xff
  38
  39 /*
  40  * Queue node uses: vcpu_running & vcpu_halted.
  41  * Queue head uses: vcpu_running & vcpu_hashed.
  42  */
  43 enum vcpu_state {
  44         vcpu_running = 0,
  45         vcpu_halted,            /* Used only in pv_wait_node */
  46         vcpu_hashed,            /* = pv_hash'ed + vcpu_halted */
  47 };
  48
  49 struct pv_node {
  50         struct mcs_spinlock     mcs;
  51         struct mcs_spinlock     __res[3];
  52
  53         int                     cpu;
  54         u8                      state;
  55 };
  56
  57 /*
  58  * Include queued spinlock statistics code
  59  */
  60 #include "qspinlock_stat.h"
  61
  62 /*
  63  * By replacing the regular queued_spin_trylock() with the function below,
  64  * it will be called once when a lock waiter enter the PV slowpath before
  65  * being queued. By allowing one lock stealing attempt here when the pending
  66  * bit is off, it helps to reduce the performance impact of lock waiter
  67  * preemption without the drawback of lock starvation.
  68  */
  69 #define queued_spin_trylock(l)  pv_queued_spin_steal_lock(l)
  70 static inline bool pv_queued_spin_steal_lock(struct qspinlock *lock)
  71 {
  72         if (!(atomic_read(&lock->val) & _Q_LOCKED_PENDING_MASK) &&
  73             (cmpxchg(&lock->locked, 0, _Q_LOCKED_VAL) == 0)) {
  74                 qstat_inc(qstat_pv_lock_stealing, true);
  75                 return true;
  76         }
  77
  78         return false;
  79 }
  80
  81 /*
  82  * The pending bit is used by the queue head vCPU to indicate that it
  83  * is actively spinning on the lock and no lock stealing is allowed.
  84  */
  85 #if _Q_PENDING_BITS == 8
  86 static __always_inline void set_pending(struct qspinlock *lock)
  87 {
  88         WRITE_ONCE(lock->pending, 1);
  89 }
  90
  91 /*
  92  * The pending bit check in pv_queued_spin_steal_lock() isn't a memory
  93  * barrier. Therefore, an atomic cmpxchg() is used to acquire the lock
  94  * just to be sure that it will get it.
  95  */
  96 static __always_inline int trylock_clear_pending(struct qspinlock *lock)
  97 {
  98         return !READ_ONCE(lock->locked) &&
  99                (cmpxchg(&lock->locked_pending, _Q_PENDING_VAL, _Q_LOCKED_VAL)
 100                         == _Q_PENDING_VAL);
 101 }
 102 #else /* _Q_PENDING_BITS == 8 */
 103 static __always_inline void set_pending(struct qspinlock *lock)
 104 {
 105         atomic_or(_Q_PENDING_VAL, &lock->val);
 106 }
 107
 108 static __always_inline int trylock_clear_pending(struct qspinlock *lock)
 109 {
 110         int val = atomic_read(&lock->val);
 111
 112         for (;;) {
 113                 int old, new;
 114
 115                 if (val  & _Q_LOCKED_MASK)
 116                         break;
 117
 118                 /*
 119                  * Try to clear pending bit & set locked bit
 120                  */
 121                 old = val;
 122                 new = (val & ~_Q_PENDING_MASK) | _Q_LOCKED_VAL;
 123                 val = atomic_cmpxchg(&lock->val, old, new);
 124
 125                 if (val == old)
 126                         return 1;
 127         }
 128         return 0;
 129 }
 130 #endif /* _Q_PENDING_BITS == 8 */
 131
 132 /*
 133  * Lock and MCS node addresses hash table for fast lookup
 134  *
 135  * Hashing is done on a per-cacheline basis to minimize the need to access
 136  * more than one cacheline.
 137  *
 138  * Dynamically allocate a hash table big enough to hold at least 4X the
 139  * number of possible cpus in the system. Allocation is done on page
 140  * granularity. So the minimum number of hash buckets should be at least
 141  * 256 (64-bit) or 512 (32-bit) to fully utilize a 4k page.
 142  *
 143  * Since we should not be holding locks from NMI context (very rare indeed) the
 144  * max load factor is 0.75, which is around the point where open addressing
 145  * breaks down.
 146  *
 147  */
 148 struct pv_hash_entry {
 149         struct qspinlock *lock;
 150         struct pv_node   *node;
 151 };
 152
 153 #define PV_HE_PER_LINE  (SMP_CACHE_BYTES / sizeof(struct pv_hash_entry))
 154 #define PV_HE_MIN       (PAGE_SIZE / sizeof(struct pv_hash_entry))
 155
 156 static struct pv_hash_entry *pv_lock_hash;
 157 static unsigned int pv_lock_hash_bits __read_mostly;
 158
 159 /*
 160  * Allocate memory for the PV qspinlock hash buckets
 161  *
 162  * This function should be called from the paravirt spinlock initialization
 163  * routine.
 164  */
 165 void __init __pv_init_lock_hash(void)
 166 {
 167         int pv_hash_size = ALIGN(4 * num_possible_cpus(), PV_HE_PER_LINE);
 168
 169         if (pv_hash_size < PV_HE_MIN)
 170                 pv_hash_size = PV_HE_MIN;
 171
 172         /*
 173          * Allocate space from bootmem which should be page-size aligned
 174          * and hence cacheline aligned.
 175          */
 176         pv_lock_hash = alloc_large_system_hash("PV qspinlock",
 177                                                sizeof(struct pv_hash_entry),
 178                                                pv_hash_size, 0, HASH_EARLY,
 179                                                &pv_lock_hash_bits, NULL,
 180                                                pv_hash_size, pv_hash_size);
 181 }
 182
 183 #define for_each_hash_entry(he, offset, hash)                                           \
 184         for (hash &= ~(PV_HE_PER_LINE - 1), he = &pv_lock_hash[hash], offset = 0;       \
 185              offset < (1 << pv_lock_hash_bits);                                         \
 186              offset++, he = &pv_lock_hash[(hash + offset) & ((1 << pv_lock_hash_bits) - 1)])
 187
 188 static struct qspinlock **pv_hash(struct qspinlock *lock, struct pv_node *node)
 189 {
 190         unsigned long offset, hash = hash_ptr(lock, pv_lock_hash_bits);
 191         struct pv_hash_entry *he;
 192         int hopcnt = 0;
 193
 194         for_each_hash_entry(he, offset, hash) {
 195                 hopcnt++;
 196                 if (!cmpxchg(&he->lock, NULL, lock)) {
 197                         WRITE_ONCE(he->node, node);
 198                         qstat_hop(hopcnt);
 199                         return &he->lock;
 200                 }
 201         }
 202         /*
 203          * Hard assume there is a free entry for us.
 204          *
 205          * This is guaranteed by ensuring every blocked lock only ever consumes
 206          * a single entry, and since we only have 4 nesting levels per CPU
 207          * and allocated 4*nr_possible_cpus(), this must be so.
 208          *
 209          * The single entry is guaranteed by having the lock owner unhash
 210          * before it releases.
 211          */
 212         BUG();
 213 }
 214
 215 static struct pv_node *pv_unhash(struct qspinlock *lock)
 216 {
 217         unsigned long offset, hash = hash_ptr(lock, pv_lock_hash_bits);
 218         struct pv_hash_entry *he;
 219         struct pv_node *node;
 220
 221         for_each_hash_entry(he, offset, hash) {
 222                 if (READ_ONCE(he->lock) == lock) {
 223                         node = READ_ONCE(he->node);
 224                         WRITE_ONCE(he->lock, NULL);
 225                         return node;
 226                 }
 227         }
 228         /*
 229          * Hard assume we'll find an entry.
 230          *
 231          * This guarantees a limited lookup time and is itself guaranteed by
 232          * having the lock owner do the unhash -- IFF the unlock sees the
 233          * SLOW flag, there MUST be a hash entry.
 234          */
 235         BUG();
 236 }
 237
 238 /*
 239  * Return true if when it is time to check the previous node which is not
 240  * in a running state.
 241  */
 242 static inline bool
 243 pv_wait_early(struct pv_node *prev, int loop)
 244 {
 245         if ((loop & PV_PREV_CHECK_MASK) != 0)
 246                 return false;
 247
 248         return READ_ONCE(prev->state) != vcpu_running;
 249 }
 250
 251 /*
 252  * Initialize the PV part of the mcs_spinlock node.
 253  */
 254 static void pv_init_node(struct mcs_spinlock *node)
 255 {
 256         struct pv_node *pn = (struct pv_node *)node;
 257
 258         BUILD_BUG_ON(sizeof(struct pv_node) > 5*sizeof(struct mcs_spinlock));
 259
 260         pn->cpu = smp_processor_id();
 261         pn->state = vcpu_running;
 262 }
 263
 264 /*
 265  * Wait for node->locked to become true, halt the vcpu after a short spin.
 266  * pv_kick_node() is used to set _Q_SLOW_VAL and fill in hash table on its
 267  * behalf.
 268  */
 269 static void pv_wait_node(struct mcs_spinlock *node, struct mcs_spinlock *prev)
 270 {
 271         struct pv_node *pn = (struct pv_node *)node;
 272         struct pv_node *pp = (struct pv_node *)prev;
 273         int loop;
 274         bool wait_early;
 275
 276         for (;;) {
 277                 for (wait_early = false, loop = SPIN_THRESHOLD; loop; loop--) {
 278                         if (READ_ONCE(node->locked))
 279                                 return;
 280                         if (pv_wait_early(pp, loop)) {
 281                                 wait_early = true;
 282                                 break;
 283                         }
 284                         cpu_relax();
 285                 }
 286
 287                 /*
 288                  * Order pn->state vs pn->locked thusly:
 289                  *
 290                  * [S] pn->state = vcpu_halted    [S] next->locked = 1
 291                  *     MB                             MB
 292                  * [L] pn->locked               [RmW] pn->state = vcpu_hashed
 293                  *
 294                  * Matches the cmpxchg() from pv_kick_node().
 295                  */
 296                 smp_store_mb(pn->state, vcpu_halted);
 297
 298                 if (!READ_ONCE(node->locked)) {
 299                         qstat_inc(qstat_pv_wait_node, true);
 300                         qstat_inc(qstat_pv_wait_early, wait_early);
 301                         pv_wait(&pn->state, vcpu_halted);
 302                 }
 303
 304                 /*
 305                  * If pv_kick_node() changed us to vcpu_hashed, retain that
 306                  * value so that pv_wait_head_or_lock() knows to not also try
 307                  * to hash this lock.
 308                  */
 309                 cmpxchg(&pn->state, vcpu_halted, vcpu_running);
 310
 311                 /*
 312                  * If the locked flag is still not set after wakeup, it is a
 313                  * spurious wakeup and the vCPU should wait again. However,
 314                  * there is a pretty high overhead for CPU halting and kicking.
 315                  * So it is better to spin for a while in the hope that the
 316                  * MCS lock will be released soon.
 317                  */
 318                 qstat_inc(qstat_pv_spurious_wakeup, !READ_ONCE(node->locked));
 319         }
 320
 321         /*
 322          * By now our node->locked should be 1 and our caller will not actually
 323          * spin-wait for it. We do however rely on our caller to do a
 324          * load-acquire for us.
 325          */
 326 }
 327
 328 /*
 329  * Called after setting next->locked = 1 when we're the lock owner.
 330  *
 331  * Instead of waking the waiters stuck in pv_wait_node() advance their state
 332  * such that they're waiting in pv_wait_head_or_lock(), this avoids a
 333  * wake/sleep cycle.
 334  */
 335 static void pv_kick_node(struct qspinlock *lock, struct mcs_spinlock *node)
 336 {
 337         struct pv_node *pn = (struct pv_node *)node;
 338
 339         /*
 340          * If the vCPU is indeed halted, advance its state to match that of
 341          * pv_wait_node(). If OTOH this fails, the vCPU was running and will
 342          * observe its next->locked value and advance itself.
 343          *
 344          * Matches with smp_store_mb() and cmpxchg() in pv_wait_node()
 345          */
 346         if (cmpxchg(&pn->state, vcpu_halted, vcpu_hashed) != vcpu_halted)
 347                 return;
 348
 349         /*
 350          * Put the lock into the hash table and set the _Q_SLOW_VAL.
 351          *
 352          * As this is the same vCPU that will check the _Q_SLOW_VAL value and
 353          * the hash table later on at unlock time, no atomic instruction is
 354          * needed.
 355          */
 356         WRITE_ONCE(lock->locked, _Q_SLOW_VAL);
 357         (void)pv_hash(lock, pn);
 358 }
 359
 360 /*
 361  * Wait for l->locked to become clear and acquire the lock;
 362  * halt the vcpu after a short spin.
 363  * __pv_queued_spin_unlock() will wake us.
 364  *
 365  * The current value of the lock will be returned for additional processing.
 366  */
 367 static u32
 368 pv_wait_head_or_lock(struct qspinlock *lock, struct mcs_spinlock *node)
 369 {
 370         struct pv_node *pn = (struct pv_node *)node;
 371         struct qspinlock **lp = NULL;
 372         int waitcnt = 0;
 373         int loop;
 374
 375         /*
 376          * If pv_kick_node() already advanced our state, we don't need to
 377          * insert ourselves into the hash table anymore.
 378          */
 379         if (READ_ONCE(pn->state) == vcpu_hashed)
 380                 lp = (struct qspinlock **)1;
 381
 382         /*
 383          * Tracking # of slowpath locking operations
 384          */
 385         qstat_inc(qstat_pv_lock_slowpath, true);
 386
 387         for (;; waitcnt++) {
 388                 /*
 389                  * Set correct vCPU state to be used by queue node wait-early
 390                  * mechanism.
 391                  */
 392                 WRITE_ONCE(pn->state, vcpu_running);
 393
 394                 /*
 395                  * Set the pending bit in the active lock spinning loop to
 396                  * disable lock stealing before attempting to acquire the lock.
 397                  */
 398                 set_pending(lock);
 399                 for (loop = SPIN_THRESHOLD; loop; loop--) {
 400                         if (trylock_clear_pending(lock))
 401                                 goto gotlock;
 402                         cpu_relax();
 403                 }
 404                 clear_pending(lock);
 405
 406
 407                 if (!lp) { /* ONCE */
 408                         lp = pv_hash(lock, pn);
 409
 410                         /*
 411                          * We must hash before setting _Q_SLOW_VAL, such that
 412                          * when we observe _Q_SLOW_VAL in __pv_queued_spin_unlock()
 413                          * we'll be sure to be able to observe our hash entry.
 414                          *
 415                          *   [S] <hash>                 [Rmw] l->locked == _Q_SLOW_VAL
 416                          *       MB                           RMB
 417                          * [RmW] l->locked = _Q_SLOW_VAL  [L] <unhash>
 418                          *
 419                          * Matches the smp_rmb() in __pv_queued_spin_unlock().
 420                          */
 421                         if (xchg(&lock->locked, _Q_SLOW_VAL) == 0) {
 422                                 /*
 423                                  * The lock was free and now we own the lock.
 424                                  * Change the lock value back to _Q_LOCKED_VAL
 425                                  * and unhash the table.
 426                                  */
 427                                 WRITE_ONCE(lock->locked, _Q_LOCKED_VAL);
 428                                 WRITE_ONCE(*lp, NULL);
 429                                 goto gotlock;
 430                         }
 431                 }
 432                 WRITE_ONCE(pn->state, vcpu_hashed);
 433                 qstat_inc(qstat_pv_wait_head, true);
 434                 qstat_inc(qstat_pv_wait_again, waitcnt);
 435                 pv_wait(&lock->locked, _Q_SLOW_VAL);
 436
 437                 /*
 438                  * Because of lock stealing, the queue head vCPU may not be
 439                  * able to acquire the lock before it has to wait again.
 440                  */
 441         }
 442
 443         /*
 444          * The cmpxchg() or xchg() call before coming here provides the
 445          * acquire semantics for locking. The dummy ORing of _Q_LOCKED_VAL
 446          * here is to indicate to the compiler that the value will always
 447          * be nozero to enable better code optimization.
 448          */
 449 gotlock:
 450         return (u32)(atomic_read(&lock->val) | _Q_LOCKED_VAL);
 451 }
 452
 453 /*
 454  * PV versions of the unlock fastpath and slowpath functions to be used
 455  * instead of queued_spin_unlock().
 456  */
 457 __visible void
 458 __pv_queued_spin_unlock_slowpath(struct qspinlock *lock, u8 locked)
 459 {
 460         struct pv_node *node;
 461
 462         if (unlikely(locked != _Q_SLOW_VAL)) {
 463                 WARN(!debug_locks_silent,
 464                      "pvqspinlock: lock 0x%lx has corrupted value 0x%x!\n",
 465                      (unsigned long)lock, atomic_read(&lock->val));
 466                 return;
 467         }
 468
 469         /*
 470          * A failed cmpxchg doesn't provide any memory-ordering guarantees,
 471          * so we need a barrier to order the read of the node data in
 472          * pv_unhash *after* we've read the lock being _Q_SLOW_VAL.
 473          *
 474          * Matches the cmpxchg() in pv_wait_head_or_lock() setting _Q_SLOW_VAL.
 475          */
 476         smp_rmb();
 477
 478         /*
 479          * Since the above failed to release, this must be the SLOW path.
 480          * Therefore start by looking up the blocked node and unhashing it.
 481          */
 482         node = pv_unhash(lock);
 483
 484         /*
 485          * Now that we have a reference to the (likely) blocked pv_node,
 486          * release the lock.
 487          */
 488         smp_store_release(&lock->locked, 0);
 489
 490         /*
 491          * At this point the memory pointed at by lock can be freed/reused,
 492          * however we can still use the pv_node to kick the CPU.
 493          * The other vCPU may not really be halted, but kicking an active
 494          * vCPU is harmless other than the additional latency in completing
 495          * the unlock.
 496          */
 497         qstat_inc(qstat_pv_kick_unlock, true);
 498         pv_kick(node->cpu);
 499 }
 500
 501 /*
 502  * Include the architecture specific callee-save thunk of the
 503  * __pv_queued_spin_unlock(). This thunk is put together with
 504  * __pv_queued_spin_unlock() to make the callee-save thunk and the real unlock
 505  * function close to each other sharing consecutive instruction cachelines.
 506  * Alternatively, architecture specific version of __pv_queued_spin_unlock()
 507  * can be defined.
 508  */
 509 #include <asm/qspinlock_paravirt.h>
 510
 511 #ifndef __pv_queued_spin_unlock
 512 __visible void __pv_queued_spin_unlock(struct qspinlock *lock)
 513 {
 514         u8 locked;
 515
 516         /*
 517          * We must not unlock if SLOW, because in that case we must first
 518          * unhash. Otherwise it would be possible to have multiple @lock
 519          * entries, which would be BAD.
 520          */
 521         locked = cmpxchg_release(&lock->locked, _Q_LOCKED_VAL, 0);
 522         if (likely(locked == _Q_LOCKED_VAL))
 523                 return;
 524
 525         __pv_queued_spin_unlock_slowpath(lock, locked);
 526 }
 527 #endif /* __pv_queued_spin_unlock */