spinlock.h 7.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229
  1. #ifndef __LINUX_SPINLOCK_H
  2. #define __LINUX_SPINLOCK_H
  3. /*
  4. * include/linux/spinlock.h - generic spinlock/rwlock declarations
  5. *
  6. * here's the role of the various spinlock/rwlock related include files:
  7. *
  8. * on SMP builds:
  9. *
  10. * asm/spinlock_types.h: contains the raw_spinlock_t/raw_rwlock_t and the
  11. * initializers
  12. *
  13. * linux/spinlock_types.h:
  14. * defines the generic type and initializers
  15. *
  16. * asm/spinlock.h: contains the __raw_spin_*()/etc. lowlevel
  17. * implementations, mostly inline assembly code
  18. *
  19. * (also included on UP-debug builds:)
  20. *
  21. * linux/spinlock_api_smp.h:
  22. * contains the prototypes for the _spin_*() APIs.
  23. *
  24. * linux/spinlock.h: builds the final spin_*() APIs.
  25. *
  26. * on UP builds:
  27. *
  28. * linux/spinlock_type_up.h:
  29. * contains the generic, simplified UP spinlock type.
  30. * (which is an empty structure on non-debug builds)
  31. *
  32. * linux/spinlock_types.h:
  33. * defines the generic type and initializers
  34. *
  35. * linux/spinlock_up.h:
  36. * contains the __raw_spin_*()/etc. version of UP
  37. * builds. (which are NOPs on non-debug, non-preempt
  38. * builds)
  39. *
  40. * (included on UP-non-debug builds:)
  41. *
  42. * linux/spinlock_api_up.h:
  43. * builds the _spin_*() APIs.
  44. *
  45. * linux/spinlock.h: builds the final spin_*() APIs.
  46. */
  47. #include <linux/config.h>
  48. #include <linux/preempt.h>
  49. #include <linux/linkage.h>
  50. #include <linux/compiler.h>
  51. #include <linux/thread_info.h>
  52. #include <linux/kernel.h>
  53. #include <linux/stringify.h>
  54. #include <asm/system.h>
  55. /*
  56. * Must define these before including other files, inline functions need them
  57. */
  58. #define LOCK_SECTION_NAME \
  59. ".text.lock." __stringify(KBUILD_BASENAME)
  60. #define LOCK_SECTION_START(extra) \
  61. ".subsection 1\n\t" \
  62. extra \
  63. ".ifndef " LOCK_SECTION_NAME "\n\t" \
  64. LOCK_SECTION_NAME ":\n\t" \
  65. ".endif\n"
  66. #define LOCK_SECTION_END \
  67. ".previous\n\t"
  68. #define __lockfunc fastcall __attribute__((section(".spinlock.text")))
  69. /*
  70. * Pull the raw_spinlock_t and raw_rwlock_t definitions:
  71. */
  72. #include <linux/spinlock_types.h>
  73. extern int __lockfunc generic__raw_read_trylock(raw_rwlock_t *lock);
  74. /*
  75. * Pull the __raw*() functions/declarations (UP-nondebug doesnt need them):
  76. */
  77. #if defined(CONFIG_SMP)
  78. # include <asm/spinlock.h>
  79. #else
  80. # include <linux/spinlock_up.h>
  81. #endif
  82. #define spin_lock_init(lock) do { *(lock) = SPIN_LOCK_UNLOCKED; } while (0)
  83. #define rwlock_init(lock) do { *(lock) = RW_LOCK_UNLOCKED; } while (0)
  84. #define spin_is_locked(lock) __raw_spin_is_locked(&(lock)->raw_lock)
  85. /**
  86. * spin_unlock_wait - wait until the spinlock gets unlocked
  87. * @lock: the spinlock in question.
  88. */
  89. #define spin_unlock_wait(lock) __raw_spin_unlock_wait(&(lock)->raw_lock)
  90. /*
  91. * Pull the _spin_*()/_read_*()/_write_*() functions/declarations:
  92. */
  93. #if defined(CONFIG_SMP) || defined(CONFIG_DEBUG_SPINLOCK)
  94. # include <linux/spinlock_api_smp.h>
  95. #else
  96. # include <linux/spinlock_api_up.h>
  97. #endif
  98. #ifdef CONFIG_DEBUG_SPINLOCK
  99. extern void _raw_spin_lock(spinlock_t *lock);
  100. #define _raw_spin_lock_flags(lock, flags) _raw_spin_lock(lock)
  101. extern int _raw_spin_trylock(spinlock_t *lock);
  102. extern void _raw_spin_unlock(spinlock_t *lock);
  103. extern void _raw_read_lock(rwlock_t *lock);
  104. extern int _raw_read_trylock(rwlock_t *lock);
  105. extern void _raw_read_unlock(rwlock_t *lock);
  106. extern void _raw_write_lock(rwlock_t *lock);
  107. extern int _raw_write_trylock(rwlock_t *lock);
  108. extern void _raw_write_unlock(rwlock_t *lock);
  109. #else
  110. # define _raw_spin_unlock(lock) __raw_spin_unlock(&(lock)->raw_lock)
  111. # define _raw_spin_trylock(lock) __raw_spin_trylock(&(lock)->raw_lock)
  112. # define _raw_spin_lock(lock) __raw_spin_lock(&(lock)->raw_lock)
  113. # define _raw_spin_lock_flags(lock, flags) \
  114. __raw_spin_lock_flags(&(lock)->raw_lock, *(flags))
  115. # define _raw_read_lock(rwlock) __raw_read_lock(&(rwlock)->raw_lock)
  116. # define _raw_write_lock(rwlock) __raw_write_lock(&(rwlock)->raw_lock)
  117. # define _raw_read_unlock(rwlock) __raw_read_unlock(&(rwlock)->raw_lock)
  118. # define _raw_write_unlock(rwlock) __raw_write_unlock(&(rwlock)->raw_lock)
  119. # define _raw_read_trylock(rwlock) __raw_read_trylock(&(rwlock)->raw_lock)
  120. # define _raw_write_trylock(rwlock) __raw_write_trylock(&(rwlock)->raw_lock)
  121. #endif
  122. #define read_can_lock(rwlock) __raw_read_can_lock(&(rwlock)->raw_lock)
  123. #define write_can_lock(rwlock) __raw_write_can_lock(&(rwlock)->raw_lock)
  124. /*
  125. * Define the various spin_lock and rw_lock methods. Note we define these
  126. * regardless of whether CONFIG_SMP or CONFIG_PREEMPT are set. The various
  127. * methods are defined as nops in the case they are not required.
  128. */
  129. #define spin_trylock(lock) __cond_lock(_spin_trylock(lock))
  130. #define read_trylock(lock) __cond_lock(_read_trylock(lock))
  131. #define write_trylock(lock) __cond_lock(_write_trylock(lock))
  132. #define spin_lock(lock) _spin_lock(lock)
  133. #define write_lock(lock) _write_lock(lock)
  134. #define read_lock(lock) _read_lock(lock)
  135. #if defined(CONFIG_SMP) || defined(CONFIG_DEBUG_SPINLOCK)
  136. #define spin_lock_irqsave(lock, flags) flags = _spin_lock_irqsave(lock)
  137. #define read_lock_irqsave(lock, flags) flags = _read_lock_irqsave(lock)
  138. #define write_lock_irqsave(lock, flags) flags = _write_lock_irqsave(lock)
  139. #else
  140. #define spin_lock_irqsave(lock, flags) _spin_lock_irqsave(lock, flags)
  141. #define read_lock_irqsave(lock, flags) _read_lock_irqsave(lock, flags)
  142. #define write_lock_irqsave(lock, flags) _write_lock_irqsave(lock, flags)
  143. #endif
  144. #define spin_lock_irq(lock) _spin_lock_irq(lock)
  145. #define spin_lock_bh(lock) _spin_lock_bh(lock)
  146. #define read_lock_irq(lock) _read_lock_irq(lock)
  147. #define read_lock_bh(lock) _read_lock_bh(lock)
  148. #define write_lock_irq(lock) _write_lock_irq(lock)
  149. #define write_lock_bh(lock) _write_lock_bh(lock)
  150. #define spin_unlock(lock) _spin_unlock(lock)
  151. #define write_unlock(lock) _write_unlock(lock)
  152. #define read_unlock(lock) _read_unlock(lock)
  153. #define spin_unlock_irqrestore(lock, flags) \
  154. _spin_unlock_irqrestore(lock, flags)
  155. #define spin_unlock_irq(lock) _spin_unlock_irq(lock)
  156. #define spin_unlock_bh(lock) _spin_unlock_bh(lock)
  157. #define read_unlock_irqrestore(lock, flags) \
  158. _read_unlock_irqrestore(lock, flags)
  159. #define read_unlock_irq(lock) _read_unlock_irq(lock)
  160. #define read_unlock_bh(lock) _read_unlock_bh(lock)
  161. #define write_unlock_irqrestore(lock, flags) \
  162. _write_unlock_irqrestore(lock, flags)
  163. #define write_unlock_irq(lock) _write_unlock_irq(lock)
  164. #define write_unlock_bh(lock) _write_unlock_bh(lock)
  165. #define spin_trylock_bh(lock) __cond_lock(_spin_trylock_bh(lock))
  166. #define spin_trylock_irq(lock) \
  167. ({ \
  168. local_irq_disable(); \
  169. _spin_trylock(lock) ? \
  170. 1 : ({ local_irq_enable(); 0; }); \
  171. })
  172. #define spin_trylock_irqsave(lock, flags) \
  173. ({ \
  174. local_irq_save(flags); \
  175. _spin_trylock(lock) ? \
  176. 1 : ({ local_irq_restore(flags); 0; }); \
  177. })
  178. /*
  179. * Pull the atomic_t declaration:
  180. * (asm-mips/atomic.h needs above definitions)
  181. */
  182. #include <asm/atomic.h>
  183. /**
  184. * atomic_dec_and_lock - lock on reaching reference count zero
  185. * @atomic: the atomic counter
  186. * @lock: the spinlock in question
  187. */
  188. extern int _atomic_dec_and_lock(atomic_t *atomic, spinlock_t *lock);
  189. #define atomic_dec_and_lock(atomic, lock) \
  190. __cond_lock(_atomic_dec_and_lock(atomic, lock))
  191. /**
  192. * spin_can_lock - would spin_trylock() succeed?
  193. * @lock: the spinlock in question.
  194. */
  195. #define spin_can_lock(lock) (!spin_is_locked(lock))
  196. #endif /* __LINUX_SPINLOCK_H */