#ifndef __LINUX_SEQLOCK_H#define __LINUX_SEQLOCK_H/* * Reader/writer consistent mechanism without starving writers. This type of * lock for data where the reader wants a consistent set of information * and is willing to retry if the information changes. Readers never * block but they may have to retry if a writer is in * progress. Writers do not wait for readers. * * This is not as cache friendly as brlock. Also, this will not work * for data that contains pointers, because any writer could * invalidate a pointer that a reader was following. * * Expected reader usage: * do { * seq = read_seqbegin(&foo); * ... * } while (read_seqretry(&foo, seq)); * * * On non-SMP the spin locks disappear but the writer still needs * to increment the sequence variables because an interrupt routine could * change the state of the data. * * Based on x86_64 vsyscall gettimeofday * by Keith Owens and Andrea Arcangeli */#include<linux/spinlock.h>#include<linux/preempt.h>typedefstruct {unsigned sequence; // 顺序计数器spinlock_t lock; //锁
} seqlock_t;
/* * These macros triggered gcc-3.x compile-time problems. We think these are * OK now. Be cautious. */#define __SEQLOCK_UNLOCKED(lockname) \ { 0, __SPIN_LOCK_UNLOCKED(lockname) }#define SEQLOCK_UNLOCKED \ __SEQLOCK_UNLOCKED(old_style_seqlock_init)// 顺序锁初始化#define seqlock_init(x) \ do { \ (x)->sequence = 0; \ spin_lock_init(&(x)->lock); \ } while (0)#define DEFINE_SEQLOCK(x) \ seqlock_t x = __SEQLOCK_UNLOCKED(x)/* Lock out other writers and update the count. * Acts like a normal spin_lock/unlock. * Don't need preempt_disable() because that is in the spin_lock already. */staticinlinevoidwrite_seqlock(seqlock_t *sl)//写加锁{
spin_lock(&sl->lock); //利用自旋锁加锁
++sl->sequence; //增长顺序计数器,值总为奇数,代表写者正在写
smp_wmb();
}
staticinlinevoidwrite_sequnlock(seqlock_t *sl)//写解锁{
smp_wmb();
sl->sequence++; //递增顺序计数器,写结束时再递增一次,值总为偶数,代表写者结束写操做了。
spin_unlock(&sl->lock);
}
staticinlineintwrite_tryseqlock(seqlock_t *sl){
int ret = spin_trylock(&sl->lock);
if (ret) {
++sl->sequence;
smp_wmb();
}
return ret;
}
/* Start of read calculation -- fetch last complete writer token */static __always_inline unsignedread_seqbegin(constseqlock_t *sl)//开始读{
unsigned ret;
repeat:
ret = sl->sequence;
smp_rmb();
// 奇偶数判断,若是是奇数,说明写者尚未完成写操做,读者须要重复读取顺序计数器直到值为偶数,说明写者操做完成了。if (unlikely(ret & 1)) {
cpu_relax();
goto repeat;
}
return ret;
}
/* * Test if reader processed invalid data. * * If sequence value changed then writer changed data while in section. */static __always_inline intread_seqretry(constseqlock_t *sl, unsigned start)// 再次读取顺序计数器,与以前的作对比,检测是否有写者修改{
smp_rmb();
return (sl->sequence != start);
}
/* * Version using sequence counter only. * This can be used when code has its own mutex protecting the * updating starting before the write_seqcountbeqin() and ending * after the write_seqcount_end(). */// 顺序锁简化版本,若是外部代码实现了锁保证typedefstructseqcount {unsigned sequence;
} seqcount_t;
#define SEQCNT_ZERO { 0 }#define seqcount_init(x) do { *(x) = (seqcount_t) SEQCNT_ZERO; } while (0)/* Start of read using pointer to a sequence counter only. */staticinlineunsignedread_seqcount_begin(constseqcount_t *s){
unsigned ret;
repeat:
ret = s->sequence;
smp_rmb();
if (unlikely(ret & 1)) {
cpu_relax();
goto repeat;
}
return ret;
}
/* * Test if reader processed invalid data because sequence number has changed. */staticinlineintread_seqcount_retry(constseqcount_t *s, unsigned start){
smp_rmb();
return s->sequence != start;
}
/* * Sequence counter only version assumes that callers are using their * own mutexing. */staticinlinevoidwrite_seqcount_begin(seqcount_t *s){
s->sequence++;
smp_wmb();
}
staticinlinevoidwrite_seqcount_end(seqcount_t *s){
smp_wmb();
s->sequence++;
}
/* * Possible sw/hw IRQ protected versions of the interfaces. */#define write_seqlock_irqsave(lock, flags) \ do { local_irq_save(flags); write_seqlock(lock); } while (0)#define write_seqlock_irq(lock) \ do { local_irq_disable(); write_seqlock(lock); } while (0)#define write_seqlock_bh(lock) \ do { local_bh_disable(); write_seqlock(lock); } while (0)#define write_sequnlock_irqrestore(lock, flags) \ do { write_sequnlock(lock); local_irq_restore(flags); } while(0)#define write_sequnlock_irq(lock) \ do { write_sequnlock(lock); local_irq_enable(); } while(0)#define write_sequnlock_bh(lock) \ do { write_sequnlock(lock); local_bh_enable(); } while(0)#define read_seqbegin_irqsave(lock, flags) \ ({ local_irq_save(flags); read_seqbegin(lock); })#define read_seqretry_irqrestore(lock, iv, flags) \ ({ \ int ret = read_seqretry(lock, iv); \ local_irq_restore(flags); \ ret; \ })#endif/* __LINUX_SEQLOCK_H */复制代码
用法示例:fetch
/* 写者: write_seqlock(seq); 修改keyvalue write_sequnlock(seq); 读者: do { seq = read_seqbegin(&foo); 读取keyvalue } while (read_seqretry(&foo, seq)); */复制代码