sys/dev/drm/include/linux/seqlock.h

   1 /*
   2  * Copyright (c) 2017 François Tigeot <ftigeot@wolfpond.org>
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice unmodified, this list of conditions, and the following
  10  *    disclaimer.
  11  * 2. Redistributions in binary form must reproduce the above copyright
  12  *    notice, this list of conditions and the following disclaimer in the
  13  *    documentation and/or other materials provided with the distribution.
  14  *
  15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  16  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  17  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  18  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  19  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  20  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  21  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  22  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  24  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  25  */
  26
  27 #ifndef _LINUX_SEQLOCK_H_
  28 #define _LINUX_SEQLOCK_H_
  29
  30 #include <linux/spinlock.h>
  31 #include <linux/lockdep.h>
  32 #include <linux/compiler.h>
  33
  34 typedef struct {
  35         unsigned sequence;
  36         struct spinlock lock;
  37 } seqlock_t;
  38
  39 static inline void
  40 seqlock_init(seqlock_t *sl)
  41 {
  42         sl->sequence = 0;
  43         spin_init(&sl->lock, "lsql");
  44 }
  45
  46 /*
  47  * Writers always use a spinlock. We still use store barriers
  48  * in order to quickly update the state of the sequence variable
  49  * for readers.
  50  */
  51 static inline void
  52 write_seqlock(seqlock_t *sl)
  53 {
  54         spin_lock(&sl->lock);
  55         sl->sequence++;
  56         cpu_sfence();
  57 }
  58
  59 static inline void
  60 write_sequnlock(seqlock_t *sl)
  61 {
  62         sl->sequence--;
  63         spin_unlock(&sl->lock);
  64         cpu_sfence();
  65 }
  66
  67 /*
  68  * Read functions are fully unlocked.
  69  * We use load barriers to obtain a reasonably up-to-date state
  70  * for the sequence number.
  71  */
  72 static inline unsigned
  73 read_seqbegin(const seqlock_t *sl)
  74 {
  75         return READ_ONCE(sl->sequence);
  76 }
  77
  78 static inline unsigned
  79 read_seqretry(const seqlock_t *sl, unsigned start)
  80 {
  81         cpu_lfence();
  82         return (sl->sequence != start);
  83 }
  84
  85 typedef struct seqcount {
  86         unsigned sequence;
  87 } seqcount_t;
  88
  89 static inline void
  90 __seqcount_init(seqcount_t *s, const char *name, struct lock_class_key *key)
  91 {
  92         s->sequence = 0;
  93 }
  94
  95 #endif  /* _LINUX_SEQLOCK_H_ */