include/linux/seqlock.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 #ifndef __LINUX_SEQLOCK_H
   3 #define __LINUX_SEQLOCK_H
   4 /*
   5  * Reader/writer consistent mechanism without starving writers. This type of
   6  * lock for data where the reader wants a consistent set of information
   7  * and is willing to retry if the information changes. There are two types
   8  * of readers:
   9  * 1. Sequence readers which never block a writer but they may have to retry
  10  *    if a writer is in progress by detecting change in sequence number.
  11  *    Writers do not wait for a sequence reader.
  12  * 2. Locking readers which will wait if a writer or another locking reader
  13  *    is in progress. A locking reader in progress will also block a writer
  14  *    from going forward. Unlike the regular rwlock, the read lock here is
  15  *    exclusive so that only one locking reader can get it.
  16  *
  17  * This is not as cache friendly as brlock. Also, this may not work well
  18  * for data that contains pointers, because any writer could
  19  * invalidate a pointer that a reader was following.
  20  *
  21  * Expected non-blocking reader usage:
  22  *      do {
  23  *          seq = read_seqbegin(&foo);
  24  *      ...
  25  *      } while (read_seqretry(&foo, seq));
  26  *
  27  *
  28  * On non-SMP the spin locks disappear but the writer still needs
  29  * to increment the sequence variables because an interrupt routine could
  30  * change the state of the data.
  31  *
  32  * Based on x86_64 vsyscall gettimeofday
  33  * by Keith Owens and Andrea Arcangeli
  34  */
  35
  36 #include <linux/spinlock.h>
  37 #include <linux/preempt.h>
  38 #include <linux/lockdep.h>
  39 #include <linux/compiler.h>
  40 #include <asm/processor.h>
  41
  42 /*
  43  * Version using sequence counter only.
  44  * This can be used when code has its own mutex protecting the
  45  * updating starting before the write_seqcountbeqin() and ending
  46  * after the write_seqcount_end().
  47  */
  48 typedef struct seqcount {
  49         unsigned sequence;
  50 #ifdef CONFIG_DEBUG_LOCK_ALLOC
  51         struct lockdep_map dep_map;
  52 #endif
  53 } seqcount_t;
  54
  55 static inline void __seqcount_init(seqcount_t *s, const char *name,
  56                                           struct lock_class_key *key)
  57 {
  58         /*
  59          * Make sure we are not reinitializing a held lock:
  60          */
  61         lockdep_init_map(&s->dep_map, name, key, 0);
  62         s->sequence = 0;
  63 }
  64
  65 #ifdef CONFIG_DEBUG_LOCK_ALLOC
  66 # define SEQCOUNT_DEP_MAP_INIT(lockname) \
  67                 .dep_map = { .name = #lockname } \
  68
  69 # define seqcount_init(s)                               \
  70         do {                                            \
  71                 static struct lock_class_key __key;     \
  72                 __seqcount_init((s), #s, &__key);       \
  73         } while (0)
  74
  75 static inline void seqcount_lockdep_reader_access(const seqcount_t *s)
  76 {
  77         seqcount_t *l = (seqcount_t *)s;
  78         unsigned long flags;
  79
  80         local_irq_save(flags);
  81         seqcount_acquire_read(&l->dep_map, 0, 0, _RET_IP_);
  82         seqcount_release(&l->dep_map, 1, _RET_IP_);
  83         local_irq_restore(flags);
  84 }
  85
  86 #else
  87 # define SEQCOUNT_DEP_MAP_INIT(lockname)
  88 # define seqcount_init(s) __seqcount_init(s, NULL, NULL)
  89 # define seqcount_lockdep_reader_access(x)
  90 #endif
  91
  92 #define SEQCNT_ZERO(lockname) { .sequence = 0, SEQCOUNT_DEP_MAP_INIT(lockname)}
  93
  94
  95 /**
  96  * __read_seqcount_begin - begin a seq-read critical section (without barrier)
  97  * @s: pointer to seqcount_t
  98  * Returns: count to be passed to read_seqcount_retry
  99  *
 100  * __read_seqcount_begin is like read_seqcount_begin, but has no smp_rmb()
 101  * barrier. Callers should ensure that smp_rmb() or equivalent ordering is
 102  * provided before actually loading any of the variables that are to be
 103  * protected in this critical section.
 104  *
 105  * Use carefully, only in critical code, and comment how the barrier is
 106  * provided.
 107  */
 108 static inline unsigned __read_seqcount_begin(const seqcount_t *s)
 109 {
 110         unsigned ret;
 111
 112 repeat:
 113         ret = READ_ONCE(s->sequence);
 114         if (unlikely(ret & 1)) {
 115                 cpu_relax();
 116                 goto repeat;
 117         }
 118         return ret;
 119 }
 120
 121 /**
 122  * raw_read_seqcount - Read the raw seqcount
 123  * @s: pointer to seqcount_t
 124  * Returns: count to be passed to read_seqcount_retry
 125  *
 126  * raw_read_seqcount opens a read critical section of the given
 127  * seqcount without any lockdep checking and without checking or
 128  * masking the LSB. Calling code is responsible for handling that.
 129  */
 130 static inline unsigned raw_read_seqcount(const seqcount_t *s)
 131 {
 132         unsigned ret = READ_ONCE(s->sequence);
 133         smp_rmb();
 134         return ret;
 135 }
 136
 137 /**
 138  * raw_read_seqcount_begin - start seq-read critical section w/o lockdep
 139  * @s: pointer to seqcount_t
 140  * Returns: count to be passed to read_seqcount_retry
 141  *
 142  * raw_read_seqcount_begin opens a read critical section of the given
 143  * seqcount, but without any lockdep checking. Validity of the critical
 144  * section is tested by checking read_seqcount_retry function.
 145  */
 146 static inline unsigned raw_read_seqcount_begin(const seqcount_t *s)
 147 {
 148         unsigned ret = __read_seqcount_begin(s);
 149         smp_rmb();
 150         return ret;
 151 }
 152
 153 /**
 154  * read_seqcount_begin - begin a seq-read critical section
 155  * @s: pointer to seqcount_t
 156  * Returns: count to be passed to read_seqcount_retry
 157  *
 158  * read_seqcount_begin opens a read critical section of the given seqcount.
 159  * Validity of the critical section is tested by checking read_seqcount_retry
 160  * function.
 161  */
 162 static inline unsigned read_seqcount_begin(const seqcount_t *s)
 163 {
 164         seqcount_lockdep_reader_access(s);
 165         return raw_read_seqcount_begin(s);
 166 }
 167
 168 /**
 169  * raw_seqcount_begin - begin a seq-read critical section
 170  * @s: pointer to seqcount_t
 171  * Returns: count to be passed to read_seqcount_retry
 172  *
 173  * raw_seqcount_begin opens a read critical section of the given seqcount.
 174  * Validity of the critical section is tested by checking read_seqcount_retry
 175  * function.
 176  *
 177  * Unlike read_seqcount_begin(), this function will not wait for the count
 178  * to stabilize. If a writer is active when we begin, we will fail the
 179  * read_seqcount_retry() instead of stabilizing at the beginning of the
 180  * critical section.
 181  */
 182 static inline unsigned raw_seqcount_begin(const seqcount_t *s)
 183 {
 184         unsigned ret = READ_ONCE(s->sequence);
 185         smp_rmb();
 186         return ret & ~1;
 187 }
 188
 189 /**
 190  * __read_seqcount_retry - end a seq-read critical section (without barrier)
 191  * @s: pointer to seqcount_t
 192  * @start: count, from read_seqcount_begin
 193  * Returns: 1 if retry is required, else 0
 194  *
 195  * __read_seqcount_retry is like read_seqcount_retry, but has no smp_rmb()
 196  * barrier. Callers should ensure that smp_rmb() or equivalent ordering is
 197  * provided before actually loading any of the variables that are to be
 198  * protected in this critical section.
 199  *
 200  * Use carefully, only in critical code, and comment how the barrier is
 201  * provided.
 202  */
 203 static inline int __read_seqcount_retry(const seqcount_t *s, unsigned start)
 204 {
 205         return unlikely(s->sequence != start);
 206 }
 207
 208 /**
 209  * read_seqcount_retry - end a seq-read critical section
 210  * @s: pointer to seqcount_t
 211  * @start: count, from read_seqcount_begin
 212  * Returns: 1 if retry is required, else 0
 213  *
 214  * read_seqcount_retry closes a read critical section of the given seqcount.
 215  * If the critical section was invalid, it must be ignored (and typically
 216  * retried).
 217  */
 218 static inline int read_seqcount_retry(const seqcount_t *s, unsigned start)
 219 {
 220         smp_rmb();
 221         return __read_seqcount_retry(s, start);
 222 }
 223
 224
 225
 226 static inline void raw_write_seqcount_begin(seqcount_t *s)
 227 {
 228         s->sequence++;
 229         smp_wmb();
 230 }
 231
 232 static inline void raw_write_seqcount_end(seqcount_t *s)
 233 {
 234         smp_wmb();
 235         s->sequence++;
 236 }
 237
 238 /**
 239  * raw_write_seqcount_barrier - do a seq write barrier
 240  * @s: pointer to seqcount_t
 241  *
 242  * This can be used to provide an ordering guarantee instead of the
 243  * usual consistency guarantee. It is one wmb cheaper, because we can
 244  * collapse the two back-to-back wmb()s.
 245  *
 246  * Note that, writes surrounding the barrier should be declared atomic (e.g.
 247  * via WRITE_ONCE): a) to ensure the writes become visible to other threads
 248  * atomically, avoiding compiler optimizations; b) to document which writes are
 249  * meant to propagate to the reader critical section. This is necessary because
 250  * neither writes before and after the barrier are enclosed in a seq-writer
 251  * critical section that would ensure readers are aware of ongoing writes.
 252  *
 253  *      seqcount_t seq;
 254  *      bool X = true, Y = false;
 255  *
 256  *      void read(void)
 257  *      {
 258  *              bool x, y;
 259  *
 260  *              do {
 261  *                      int s = read_seqcount_begin(&seq);
 262  *
 263  *                      x = X; y = Y;
 264  *
 265  *              } while (read_seqcount_retry(&seq, s));
 266  *
 267  *              BUG_ON(!x && !y);
 268  *      }
 269  *
 270  *      void write(void)
 271  *      {
 272  *              WRITE_ONCE(Y, true);
 273  *
 274  *              raw_write_seqcount_barrier(seq);
 275  *
 276  *              WRITE_ONCE(X, false);
 277  *      }
 278  */
 279 static inline void raw_write_seqcount_barrier(seqcount_t *s)
 280 {
 281         s->sequence++;
 282         smp_wmb();
 283         s->sequence++;
 284 }
 285
 286 static inline int raw_read_seqcount_latch(seqcount_t *s)
 287 {
 288         int seq = READ_ONCE(s->sequence);
 289         /* Pairs with the first smp_wmb() in raw_write_seqcount_latch() */
 290         smp_read_barrier_depends();
 291         return seq;
 292 }
 293
 294 /**
 295  * raw_write_seqcount_latch - redirect readers to even/odd copy
 296  * @s: pointer to seqcount_t
 297  *
 298  * The latch technique is a multiversion concurrency control method that allows
 299  * queries during non-atomic modifications. If you can guarantee queries never
 300  * interrupt the modification -- e.g. the concurrency is strictly between CPUs
 301  * -- you most likely do not need this.
 302  *
 303  * Where the traditional RCU/lockless data structures rely on atomic
 304  * modifications to ensure queries observe either the old or the new state the
 305  * latch allows the same for non-atomic updates. The trade-off is doubling the
 306  * cost of storage; we have to maintain two copies of the entire data
 307  * structure.
 308  *
 309  * Very simply put: we first modify one copy and then the other. This ensures
 310  * there is always one copy in a stable state, ready to give us an answer.
 311  *
 312  * The basic form is a data structure like:
 313  *
 314  * struct latch_struct {
 315  *      seqcount_t              seq;
 316  *      struct data_struct      data[2];
 317  * };
 318  *
 319  * Where a modification, which is assumed to be externally serialized, does the
 320  * following:
 321  *
 322  * void latch_modify(struct latch_struct *latch, ...)
 323  * {
 324  *      smp_wmb();      <- Ensure that the last data[1] update is visible
 325  *      latch->seq++;
 326  *      smp_wmb();      <- Ensure that the seqcount update is visible
 327  *
 328  *      modify(latch->data[0], ...);
 329  *
 330  *      smp_wmb();      <- Ensure that the data[0] update is visible
 331  *      latch->seq++;
 332  *      smp_wmb();      <- Ensure that the seqcount update is visible
 333  *
 334  *      modify(latch->data[1], ...);
 335  * }
 336  *
 337  * The query will have a form like:
 338  *
 339  * struct entry *latch_query(struct latch_struct *latch, ...)
 340  * {
 341  *      struct entry *entry;
 342  *      unsigned seq, idx;
 343  *
 344  *      do {
 345  *              seq = raw_read_seqcount_latch(&latch->seq);
 346  *
 347  *              idx = seq & 0x01;
 348  *              entry = data_query(latch->data[idx], ...);
 349  *
 350  *              smp_rmb();
 351  *      } while (seq != latch->seq);
 352  *
 353  *      return entry;
 354  * }
 355  *
 356  * So during the modification, queries are first redirected to data[1]. Then we
 357  * modify data[0]. When that is complete, we redirect queries back to data[0]
 358  * and we can modify data[1].
 359  *
 360  * NOTE: The non-requirement for atomic modifications does _NOT_ include
 361  *       the publishing of new entries in the case where data is a dynamic
 362  *       data structure.
 363  *
 364  *       An iteration might start in data[0] and get suspended long enough
 365  *       to miss an entire modification sequence, once it resumes it might
 366  *       observe the new entry.
 367  *
 368  * NOTE: When data is a dynamic data structure; one should use regular RCU
 369  *       patterns to manage the lifetimes of the objects within.
 370  */
 371 static inline void raw_write_seqcount_latch(seqcount_t *s)
 372 {
 373        smp_wmb();      /* prior stores before incrementing "sequence" */
 374        s->sequence++;
 375        smp_wmb();      /* increment "sequence" before following stores */
 376 }
 377
 378 /*
 379  * Sequence counter only version assumes that callers are using their
 380  * own mutexing.
 381  */
 382 static inline void write_seqcount_begin_nested(seqcount_t *s, int subclass)
 383 {
 384         raw_write_seqcount_begin(s);
 385         seqcount_acquire(&s->dep_map, subclass, 0, _RET_IP_);
 386 }
 387
 388 static inline void write_seqcount_begin(seqcount_t *s)
 389 {
 390         write_seqcount_begin_nested(s, 0);
 391 }
 392
 393 static inline void write_seqcount_end(seqcount_t *s)
 394 {
 395         seqcount_release(&s->dep_map, 1, _RET_IP_);
 396         raw_write_seqcount_end(s);
 397 }
 398
 399 /**
 400  * write_seqcount_invalidate - invalidate in-progress read-side seq operations
 401  * @s: pointer to seqcount_t
 402  *
 403  * After write_seqcount_invalidate, no read-side seq operations will complete
 404  * successfully and see data older than this.
 405  */
 406 static inline void write_seqcount_invalidate(seqcount_t *s)
 407 {
 408         smp_wmb();
 409         s->sequence+=2;
 410 }
 411
 412 typedef struct {
 413         struct seqcount seqcount;
 414         spinlock_t lock;
 415 } seqlock_t;
 416
 417 /*
 418  * These macros triggered gcc-3.x compile-time problems.  We think these are
 419  * OK now.  Be cautious.
 420  */
 421 #define __SEQLOCK_UNLOCKED(lockname)                    \
 422         {                                               \
 423                 .seqcount = SEQCNT_ZERO(lockname),      \
 424                 .lock = __SPIN_LOCK_UNLOCKED(lockname)  \
 425         }
 426
 427 #define seqlock_init(x)                                 \
 428         do {                                            \
 429                 seqcount_init(&(x)->seqcount);          \
 430                 spin_lock_init(&(x)->lock);             \
 431         } while (0)
 432
 433 #define DEFINE_SEQLOCK(x) \
 434                 seqlock_t x = __SEQLOCK_UNLOCKED(x)
 435
 436 /*
 437  * Read side functions for starting and finalizing a read side section.
 438  */
 439 static inline unsigned read_seqbegin(const seqlock_t *sl)
 440 {
 441         return read_seqcount_begin(&sl->seqcount);
 442 }
 443
 444 static inline unsigned read_seqretry(const seqlock_t *sl, unsigned start)
 445 {
 446         return read_seqcount_retry(&sl->seqcount, start);
 447 }
 448
 449 /*
 450  * Lock out other writers and update the count.
 451  * Acts like a normal spin_lock/unlock.
 452  * Don't need preempt_disable() because that is in the spin_lock already.
 453  */
 454 static inline void write_seqlock(seqlock_t *sl)
 455 {
 456         spin_lock(&sl->lock);
 457         write_seqcount_begin(&sl->seqcount);
 458 }
 459
 460 static inline void write_sequnlock(seqlock_t *sl)
 461 {
 462         write_seqcount_end(&sl->seqcount);
 463         spin_unlock(&sl->lock);
 464 }
 465
 466 static inline void write_seqlock_bh(seqlock_t *sl)
 467 {
 468         spin_lock_bh(&sl->lock);
 469         write_seqcount_begin(&sl->seqcount);
 470 }
 471
 472 static inline void write_sequnlock_bh(seqlock_t *sl)
 473 {
 474         write_seqcount_end(&sl->seqcount);
 475         spin_unlock_bh(&sl->lock);
 476 }
 477
 478 static inline void write_seqlock_irq(seqlock_t *sl)
 479 {
 480         spin_lock_irq(&sl->lock);
 481         write_seqcount_begin(&sl->seqcount);
 482 }
 483
 484 static inline void write_sequnlock_irq(seqlock_t *sl)
 485 {
 486         write_seqcount_end(&sl->seqcount);
 487         spin_unlock_irq(&sl->lock);
 488 }
 489
 490 static inline unsigned long __write_seqlock_irqsave(seqlock_t *sl)
 491 {
 492         unsigned long flags;
 493
 494         spin_lock_irqsave(&sl->lock, flags);
 495         write_seqcount_begin(&sl->seqcount);
 496         return flags;
 497 }
 498
 499 #define write_seqlock_irqsave(lock, flags)                              \
 500         do { flags = __write_seqlock_irqsave(lock); } while (0)
 501
 502 static inline void
 503 write_sequnlock_irqrestore(seqlock_t *sl, unsigned long flags)
 504 {
 505         write_seqcount_end(&sl->seqcount);
 506         spin_unlock_irqrestore(&sl->lock, flags);
 507 }
 508
 509 /*
 510  * A locking reader exclusively locks out other writers and locking readers,
 511  * but doesn't update the sequence number. Acts like a normal spin_lock/unlock.
 512  * Don't need preempt_disable() because that is in the spin_lock already.
 513  */
 514 static inline void read_seqlock_excl(seqlock_t *sl)
 515 {
 516         spin_lock(&sl->lock);
 517 }
 518
 519 static inline void read_sequnlock_excl(seqlock_t *sl)
 520 {
 521         spin_unlock(&sl->lock);
 522 }
 523
 524 /**
 525  * read_seqbegin_or_lock - begin a sequence number check or locking block
 526  * @lock: sequence lock
 527  * @seq : sequence number to be checked
 528  *
 529  * First try it once optimistically without taking the lock. If that fails,
 530  * take the lock. The sequence number is also used as a marker for deciding
 531  * whether to be a reader (even) or writer (odd).
 532  * N.B. seq must be initialized to an even number to begin with.
 533  */
 534 static inline void read_seqbegin_or_lock(seqlock_t *lock, int *seq)
 535 {
 536         if (!(*seq & 1))        /* Even */
 537                 *seq = read_seqbegin(lock);
 538         else                    /* Odd */
 539                 read_seqlock_excl(lock);
 540 }
 541
 542 static inline int need_seqretry(seqlock_t *lock, int seq)
 543 {
 544         return !(seq & 1) && read_seqretry(lock, seq);
 545 }
 546
 547 static inline void done_seqretry(seqlock_t *lock, int seq)
 548 {
 549         if (seq & 1)
 550                 read_sequnlock_excl(lock);
 551 }
 552
 553 static inline void read_seqlock_excl_bh(seqlock_t *sl)
 554 {
 555         spin_lock_bh(&sl->lock);
 556 }
 557
 558 static inline void read_sequnlock_excl_bh(seqlock_t *sl)
 559 {
 560         spin_unlock_bh(&sl->lock);
 561 }
 562
 563 static inline void read_seqlock_excl_irq(seqlock_t *sl)
 564 {
 565         spin_lock_irq(&sl->lock);
 566 }
 567
 568 static inline void read_sequnlock_excl_irq(seqlock_t *sl)
 569 {
 570         spin_unlock_irq(&sl->lock);
 571 }
 572
 573 static inline unsigned long __read_seqlock_excl_irqsave(seqlock_t *sl)
 574 {
 575         unsigned long flags;
 576
 577         spin_lock_irqsave(&sl->lock, flags);
 578         return flags;
 579 }
 580
 581 #define read_seqlock_excl_irqsave(lock, flags)                          \
 582         do { flags = __read_seqlock_excl_irqsave(lock); } while (0)
 583
 584 static inline void
 585 read_sequnlock_excl_irqrestore(seqlock_t *sl, unsigned long flags)
 586 {
 587         spin_unlock_irqrestore(&sl->lock, flags);
 588 }
 589
 590 static inline unsigned long
 591 read_seqbegin_or_lock_irqsave(seqlock_t *lock, int *seq)
 592 {
 593         unsigned long flags = 0;
 594
 595         if (!(*seq & 1))        /* Even */
 596                 *seq = read_seqbegin(lock);
 597         else                    /* Odd */
 598                 read_seqlock_excl_irqsave(lock, flags);
 599
 600         return flags;
 601 }
 602
 603 static inline void
 604 done_seqretry_irqrestore(seqlock_t *lock, int seq, unsigned long flags)
 605 {
 606         if (seq & 1)
 607                 read_sequnlock_excl_irqrestore(lock, flags);
 608 }
 609 #endif /* __LINUX_SEQLOCK_H */