mmap_lock.h 5.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197
  1. #ifndef _LINUX_MMAP_LOCK_H
  2. #define _LINUX_MMAP_LOCK_H
  3. #include <linux/lockdep.h>
  4. #include <linux/mm_types.h>
  5. #include <linux/mmdebug.h>
  6. #include <linux/rwsem.h>
  7. #include <linux/tracepoint-defs.h>
  8. #include <linux/types.h>
  9. #define MMAP_LOCK_INITIALIZER(name) \
  10. .mmap_lock = __RWSEM_INITIALIZER((name).mmap_lock),
  11. DECLARE_TRACEPOINT(mmap_lock_start_locking);
  12. DECLARE_TRACEPOINT(mmap_lock_acquire_returned);
  13. DECLARE_TRACEPOINT(mmap_lock_released);
  14. #ifdef CONFIG_TRACING
  15. void __mmap_lock_do_trace_start_locking(struct mm_struct *mm, bool write);
  16. void __mmap_lock_do_trace_acquire_returned(struct mm_struct *mm, bool write,
  17. bool success);
  18. void __mmap_lock_do_trace_released(struct mm_struct *mm, bool write);
  19. static inline void __mmap_lock_trace_start_locking(struct mm_struct *mm,
  20. bool write)
  21. {
  22. if (tracepoint_enabled(mmap_lock_start_locking))
  23. __mmap_lock_do_trace_start_locking(mm, write);
  24. }
  25. static inline void __mmap_lock_trace_acquire_returned(struct mm_struct *mm,
  26. bool write, bool success)
  27. {
  28. if (tracepoint_enabled(mmap_lock_acquire_returned))
  29. __mmap_lock_do_trace_acquire_returned(mm, write, success);
  30. }
  31. static inline void __mmap_lock_trace_released(struct mm_struct *mm, bool write)
  32. {
  33. if (tracepoint_enabled(mmap_lock_released))
  34. __mmap_lock_do_trace_released(mm, write);
  35. }
  36. #else /* !CONFIG_TRACING */
  37. static inline void __mmap_lock_trace_start_locking(struct mm_struct *mm,
  38. bool write)
  39. {
  40. }
  41. static inline void __mmap_lock_trace_acquire_returned(struct mm_struct *mm,
  42. bool write, bool success)
  43. {
  44. }
  45. static inline void __mmap_lock_trace_released(struct mm_struct *mm, bool write)
  46. {
  47. }
  48. #endif /* CONFIG_TRACING */
  49. static inline void mmap_assert_locked(struct mm_struct *mm)
  50. {
  51. lockdep_assert_held(&mm->mmap_lock);
  52. VM_BUG_ON_MM(!rwsem_is_locked(&mm->mmap_lock), mm);
  53. }
  54. static inline void mmap_assert_write_locked(struct mm_struct *mm)
  55. {
  56. lockdep_assert_held_write(&mm->mmap_lock);
  57. VM_BUG_ON_MM(!rwsem_is_locked(&mm->mmap_lock), mm);
  58. }
  59. #ifdef CONFIG_PER_VMA_LOCK
  60. /*
  61. * Drop all currently-held per-VMA locks.
  62. * This is called from the mmap_lock implementation directly before releasing
  63. * a write-locked mmap_lock (or downgrading it to read-locked).
  64. * This should normally NOT be called manually from other places.
  65. * If you want to call this manually anyway, keep in mind that this will release
  66. * *all* VMA write locks, including ones from further up the stack.
  67. */
  68. static inline void vma_end_write_all(struct mm_struct *mm)
  69. {
  70. mmap_assert_write_locked(mm);
  71. /*
  72. * Nobody can concurrently modify mm->mm_lock_seq due to exclusive
  73. * mmap_lock being held.
  74. * We need RELEASE semantics here to ensure that preceding stores into
  75. * the VMA take effect before we unlock it with this store.
  76. * Pairs with ACQUIRE semantics in vma_start_read().
  77. */
  78. smp_store_release(&mm->mm_lock_seq, mm->mm_lock_seq + 1);
  79. }
  80. #else
  81. static inline void vma_end_write_all(struct mm_struct *mm) {}
  82. #endif
  83. static inline void mmap_init_lock(struct mm_struct *mm)
  84. {
  85. init_rwsem(&mm->mmap_lock);
  86. }
  87. static inline void mmap_write_lock(struct mm_struct *mm)
  88. {
  89. __mmap_lock_trace_start_locking(mm, true);
  90. down_write(&mm->mmap_lock);
  91. __mmap_lock_trace_acquire_returned(mm, true, true);
  92. }
  93. static inline void mmap_write_lock_nested(struct mm_struct *mm, int subclass)
  94. {
  95. __mmap_lock_trace_start_locking(mm, true);
  96. down_write_nested(&mm->mmap_lock, subclass);
  97. __mmap_lock_trace_acquire_returned(mm, true, true);
  98. }
  99. static inline int mmap_write_lock_killable(struct mm_struct *mm)
  100. {
  101. int ret;
  102. __mmap_lock_trace_start_locking(mm, true);
  103. ret = down_write_killable(&mm->mmap_lock);
  104. __mmap_lock_trace_acquire_returned(mm, true, ret == 0);
  105. return ret;
  106. }
  107. static inline bool mmap_write_trylock(struct mm_struct *mm)
  108. {
  109. bool ret;
  110. __mmap_lock_trace_start_locking(mm, true);
  111. ret = down_write_trylock(&mm->mmap_lock) != 0;
  112. __mmap_lock_trace_acquire_returned(mm, true, ret);
  113. return ret;
  114. }
  115. static inline void mmap_write_unlock(struct mm_struct *mm)
  116. {
  117. __mmap_lock_trace_released(mm, true);
  118. vma_end_write_all(mm);
  119. up_write(&mm->mmap_lock);
  120. }
  121. static inline void mmap_write_downgrade(struct mm_struct *mm)
  122. {
  123. __mmap_lock_trace_acquire_returned(mm, false, true);
  124. vma_end_write_all(mm);
  125. downgrade_write(&mm->mmap_lock);
  126. }
  127. static inline void mmap_read_lock(struct mm_struct *mm)
  128. {
  129. __mmap_lock_trace_start_locking(mm, false);
  130. down_read(&mm->mmap_lock);
  131. __mmap_lock_trace_acquire_returned(mm, false, true);
  132. }
  133. static inline int mmap_read_lock_killable(struct mm_struct *mm)
  134. {
  135. int ret;
  136. __mmap_lock_trace_start_locking(mm, false);
  137. ret = down_read_killable(&mm->mmap_lock);
  138. __mmap_lock_trace_acquire_returned(mm, false, ret == 0);
  139. return ret;
  140. }
  141. static inline bool mmap_read_trylock(struct mm_struct *mm)
  142. {
  143. bool ret;
  144. __mmap_lock_trace_start_locking(mm, false);
  145. ret = down_read_trylock(&mm->mmap_lock) != 0;
  146. __mmap_lock_trace_acquire_returned(mm, false, ret);
  147. return ret;
  148. }
  149. static inline void mmap_read_unlock(struct mm_struct *mm)
  150. {
  151. __mmap_lock_trace_released(mm, false);
  152. up_read(&mm->mmap_lock);
  153. }
  154. static inline void mmap_read_unlock_non_owner(struct mm_struct *mm)
  155. {
  156. __mmap_lock_trace_released(mm, false);
  157. up_read_non_owner(&mm->mmap_lock);
  158. }
  159. static inline int mmap_lock_is_contended(struct mm_struct *mm)
  160. {
  161. return rwsem_is_contended(&mm->mmap_lock);
  162. }
  163. #endif /* _LINUX_MMAP_LOCK_H */