19 #include "kmp_debug.h"
32 #define KMP_PAD(type, sz) \
33 (sizeof(type) + (sz - ((sizeof(type) - 1) % (sz)) - 1))
34 #define KMP_GTID_DNE (-2)
53 #if KMP_OS_LINUX && defined(KMP_GOMP_COMPAT)
54 #define OMP_LOCK_T_SIZE sizeof(int)
55 #define OMP_NEST_LOCK_T_SIZE sizeof(void *)
57 #define OMP_LOCK_T_SIZE sizeof(void *)
58 #define OMP_NEST_LOCK_T_SIZE sizeof(void *)
64 #define OMP_CRITICAL_SIZE sizeof(void *)
65 #define INTEL_CRITICAL_SIZE 32
68 typedef kmp_uint32 kmp_lock_flags_t;
70 #define kmp_lf_critical_section 1
73 typedef kmp_uint32 kmp_lock_index_t;
77 struct kmp_lock_pool {
78 union kmp_user_lock *next;
79 kmp_lock_index_t index;
82 typedef struct kmp_lock_pool kmp_lock_pool_t;
84 extern void __kmp_validate_locks(
void);
121 struct kmp_base_tas_lock {
123 std::atomic<kmp_int32> poll;
124 kmp_int32 depth_locked;
127 typedef struct kmp_base_tas_lock kmp_base_tas_lock_t;
130 kmp_base_tas_lock_t lk;
131 kmp_lock_pool_t pool;
135 typedef union kmp_tas_lock kmp_tas_lock_t;
139 #define KMP_TAS_LOCK_INITIALIZER(lock) \
141 { ATOMIC_VAR_INIT(KMP_LOCK_FREE(tas)), 0 } \
144 extern int __kmp_acquire_tas_lock(kmp_tas_lock_t *lck, kmp_int32 gtid);
145 extern int __kmp_test_tas_lock(kmp_tas_lock_t *lck, kmp_int32 gtid);
146 extern int __kmp_release_tas_lock(kmp_tas_lock_t *lck, kmp_int32 gtid);
147 extern void __kmp_init_tas_lock(kmp_tas_lock_t *lck);
148 extern void __kmp_destroy_tas_lock(kmp_tas_lock_t *lck);
150 extern int __kmp_acquire_nested_tas_lock(kmp_tas_lock_t *lck, kmp_int32 gtid);
151 extern int __kmp_test_nested_tas_lock(kmp_tas_lock_t *lck, kmp_int32 gtid);
152 extern int __kmp_release_nested_tas_lock(kmp_tas_lock_t *lck, kmp_int32 gtid);
153 extern void __kmp_init_nested_tas_lock(kmp_tas_lock_t *lck);
154 extern void __kmp_destroy_nested_tas_lock(kmp_tas_lock_t *lck);
156 #define KMP_LOCK_RELEASED 1
157 #define KMP_LOCK_STILL_HELD 0
158 #define KMP_LOCK_ACQUIRED_FIRST 1
159 #define KMP_LOCK_ACQUIRED_NEXT 0
160 #ifndef KMP_USE_FUTEX
161 #define KMP_USE_FUTEX \
162 (KMP_OS_LINUX && !KMP_OS_CNK && \
163 (KMP_ARCH_X86 || KMP_ARCH_X86_64 || KMP_ARCH_ARM || KMP_ARCH_AARCH64))
178 struct kmp_base_futex_lock {
179 volatile kmp_int32 poll;
182 kmp_int32 depth_locked;
185 typedef struct kmp_base_futex_lock kmp_base_futex_lock_t;
187 union kmp_futex_lock {
188 kmp_base_futex_lock_t lk;
189 kmp_lock_pool_t pool;
194 typedef union kmp_futex_lock kmp_futex_lock_t;
198 #define KMP_FUTEX_LOCK_INITIALIZER(lock) \
200 { KMP_LOCK_FREE(futex), 0 } \
203 extern int __kmp_acquire_futex_lock(kmp_futex_lock_t *lck, kmp_int32 gtid);
204 extern int __kmp_test_futex_lock(kmp_futex_lock_t *lck, kmp_int32 gtid);
205 extern int __kmp_release_futex_lock(kmp_futex_lock_t *lck, kmp_int32 gtid);
206 extern void __kmp_init_futex_lock(kmp_futex_lock_t *lck);
207 extern void __kmp_destroy_futex_lock(kmp_futex_lock_t *lck);
209 extern int __kmp_acquire_nested_futex_lock(kmp_futex_lock_t *lck,
211 extern int __kmp_test_nested_futex_lock(kmp_futex_lock_t *lck, kmp_int32 gtid);
212 extern int __kmp_release_nested_futex_lock(kmp_futex_lock_t *lck,
214 extern void __kmp_init_nested_futex_lock(kmp_futex_lock_t *lck);
215 extern void __kmp_destroy_nested_futex_lock(kmp_futex_lock_t *lck);
217 #endif // KMP_USE_FUTEX
228 struct kmp_base_ticket_lock {
230 std::atomic_bool initialized;
231 volatile union kmp_ticket_lock *
self;
235 std::atomic_uint now_serving;
236 std::atomic_int owner_id;
237 std::atomic_int depth_locked;
238 kmp_lock_flags_t flags;
241 struct kmp_base_ticket_lock {
243 std::atomic<bool> initialized;
244 volatile union kmp_ticket_lock *
self;
246 std::atomic<unsigned>
248 std::atomic<unsigned>
250 std::atomic<int> owner_id;
251 std::atomic<int> depth_locked;
252 kmp_lock_flags_t flags;
258 struct kmp_base_ticket_lock;
260 #endif // !__cplusplus
262 typedef struct kmp_base_ticket_lock kmp_base_ticket_lock_t;
264 union KMP_ALIGN_CACHE kmp_ticket_lock {
265 kmp_base_ticket_lock_t
267 kmp_lock_pool_t pool;
269 char lk_pad[KMP_PAD(kmp_base_ticket_lock_t, CACHE_LINE)];
272 typedef union kmp_ticket_lock kmp_ticket_lock_t;
277 #define KMP_TICKET_LOCK_INITIALIZER(lock) \
280 ATOMIC_VAR_INIT(true) \
281 , &(lock), NULL, ATOMIC_VAR_INIT(0U), ATOMIC_VAR_INIT(0U), \
282 ATOMIC_VAR_INIT(0), ATOMIC_VAR_INIT(-1) \
286 extern int __kmp_acquire_ticket_lock(kmp_ticket_lock_t *lck, kmp_int32 gtid);
287 extern int __kmp_test_ticket_lock(kmp_ticket_lock_t *lck, kmp_int32 gtid);
288 extern int __kmp_test_ticket_lock_with_cheks(kmp_ticket_lock_t *lck,
290 extern int __kmp_release_ticket_lock(kmp_ticket_lock_t *lck, kmp_int32 gtid);
291 extern void __kmp_init_ticket_lock(kmp_ticket_lock_t *lck);
292 extern void __kmp_destroy_ticket_lock(kmp_ticket_lock_t *lck);
294 extern int __kmp_acquire_nested_ticket_lock(kmp_ticket_lock_t *lck,
296 extern int __kmp_test_nested_ticket_lock(kmp_ticket_lock_t *lck,
298 extern int __kmp_release_nested_ticket_lock(kmp_ticket_lock_t *lck,
300 extern void __kmp_init_nested_ticket_lock(kmp_ticket_lock_t *lck);
301 extern void __kmp_destroy_nested_ticket_lock(kmp_ticket_lock_t *lck);
306 #if KMP_USE_ADAPTIVE_LOCKS
308 struct kmp_adaptive_lock_info;
310 typedef struct kmp_adaptive_lock_info kmp_adaptive_lock_info_t;
312 #if KMP_DEBUG_ADAPTIVE_LOCKS
314 struct kmp_adaptive_lock_statistics {
316 kmp_adaptive_lock_info_t *next;
317 kmp_adaptive_lock_info_t *prev;
320 kmp_uint32 successfulSpeculations;
321 kmp_uint32 hardFailedSpeculations;
322 kmp_uint32 softFailedSpeculations;
323 kmp_uint32 nonSpeculativeAcquires;
324 kmp_uint32 nonSpeculativeAcquireAttempts;
325 kmp_uint32 lemmingYields;
328 typedef struct kmp_adaptive_lock_statistics kmp_adaptive_lock_statistics_t;
330 extern void __kmp_print_speculative_stats();
331 extern void __kmp_init_speculative_stats();
333 #endif // KMP_DEBUG_ADAPTIVE_LOCKS
335 struct kmp_adaptive_lock_info {
340 kmp_uint32
volatile badness;
341 kmp_uint32
volatile acquire_attempts;
343 kmp_uint32 max_badness;
344 kmp_uint32 max_soft_retries;
346 #if KMP_DEBUG_ADAPTIVE_LOCKS
347 kmp_adaptive_lock_statistics_t
volatile stats;
351 #endif // KMP_USE_ADAPTIVE_LOCKS
353 struct kmp_base_queuing_lock {
356 volatile union kmp_queuing_lock
374 volatile kmp_int32 owner_id;
375 kmp_int32 depth_locked;
377 kmp_lock_flags_t flags;
380 typedef struct kmp_base_queuing_lock kmp_base_queuing_lock_t;
382 KMP_BUILD_ASSERT(offsetof(kmp_base_queuing_lock_t, tail_id) % 8 == 0);
384 union KMP_ALIGN_CACHE kmp_queuing_lock {
385 kmp_base_queuing_lock_t
387 kmp_lock_pool_t pool;
389 char lk_pad[KMP_PAD(kmp_base_queuing_lock_t, CACHE_LINE)];
392 typedef union kmp_queuing_lock kmp_queuing_lock_t;
394 extern int __kmp_acquire_queuing_lock(kmp_queuing_lock_t *lck, kmp_int32 gtid);
395 extern int __kmp_test_queuing_lock(kmp_queuing_lock_t *lck, kmp_int32 gtid);
396 extern int __kmp_release_queuing_lock(kmp_queuing_lock_t *lck, kmp_int32 gtid);
397 extern void __kmp_init_queuing_lock(kmp_queuing_lock_t *lck);
398 extern void __kmp_destroy_queuing_lock(kmp_queuing_lock_t *lck);
400 extern int __kmp_acquire_nested_queuing_lock(kmp_queuing_lock_t *lck,
402 extern int __kmp_test_nested_queuing_lock(kmp_queuing_lock_t *lck,
404 extern int __kmp_release_nested_queuing_lock(kmp_queuing_lock_t *lck,
406 extern void __kmp_init_nested_queuing_lock(kmp_queuing_lock_t *lck);
407 extern void __kmp_destroy_nested_queuing_lock(kmp_queuing_lock_t *lck);
409 #if KMP_USE_ADAPTIVE_LOCKS
413 struct kmp_base_adaptive_lock {
414 kmp_base_queuing_lock qlk;
415 KMP_ALIGN(CACHE_LINE)
416 kmp_adaptive_lock_info_t
420 typedef struct kmp_base_adaptive_lock kmp_base_adaptive_lock_t;
422 union KMP_ALIGN_CACHE kmp_adaptive_lock {
423 kmp_base_adaptive_lock_t lk;
424 kmp_lock_pool_t pool;
426 char lk_pad[KMP_PAD(kmp_base_adaptive_lock_t, CACHE_LINE)];
428 typedef union kmp_adaptive_lock kmp_adaptive_lock_t;
430 #define GET_QLK_PTR(l) ((kmp_queuing_lock_t *)&(l)->lk.qlk)
432 #endif // KMP_USE_ADAPTIVE_LOCKS
436 struct kmp_base_drdpa_lock {
445 volatile union kmp_drdpa_lock
448 std::atomic<std::atomic<kmp_uint64> *> polls;
449 std::atomic<kmp_uint64> mask;
450 kmp_uint64 cleanup_ticket;
451 std::atomic<kmp_uint64> *old_polls;
452 kmp_uint32 num_polls;
458 std::atomic<kmp_uint64> next_ticket;
473 kmp_uint64 now_serving;
474 volatile kmp_uint32 owner_id;
475 kmp_int32 depth_locked;
476 kmp_lock_flags_t flags;
479 typedef struct kmp_base_drdpa_lock kmp_base_drdpa_lock_t;
481 union KMP_ALIGN_CACHE kmp_drdpa_lock {
482 kmp_base_drdpa_lock_t
484 kmp_lock_pool_t pool;
486 char lk_pad[KMP_PAD(kmp_base_drdpa_lock_t, CACHE_LINE)];
489 typedef union kmp_drdpa_lock kmp_drdpa_lock_t;
491 extern int __kmp_acquire_drdpa_lock(kmp_drdpa_lock_t *lck, kmp_int32 gtid);
492 extern int __kmp_test_drdpa_lock(kmp_drdpa_lock_t *lck, kmp_int32 gtid);
493 extern int __kmp_release_drdpa_lock(kmp_drdpa_lock_t *lck, kmp_int32 gtid);
494 extern void __kmp_init_drdpa_lock(kmp_drdpa_lock_t *lck);
495 extern void __kmp_destroy_drdpa_lock(kmp_drdpa_lock_t *lck);
497 extern int __kmp_acquire_nested_drdpa_lock(kmp_drdpa_lock_t *lck,
499 extern int __kmp_test_nested_drdpa_lock(kmp_drdpa_lock_t *lck, kmp_int32 gtid);
500 extern int __kmp_release_nested_drdpa_lock(kmp_drdpa_lock_t *lck,
502 extern void __kmp_init_nested_drdpa_lock(kmp_drdpa_lock_t *lck);
503 extern void __kmp_destroy_nested_drdpa_lock(kmp_drdpa_lock_t *lck);
517 typedef kmp_ticket_lock_t kmp_bootstrap_lock_t;
519 #define KMP_BOOTSTRAP_LOCK_INITIALIZER(lock) KMP_TICKET_LOCK_INITIALIZER((lock))
520 #define KMP_BOOTSTRAP_LOCK_INIT(lock) \
521 kmp_bootstrap_lock_t lock = KMP_TICKET_LOCK_INITIALIZER(lock)
523 static inline int __kmp_acquire_bootstrap_lock(kmp_bootstrap_lock_t *lck) {
524 return __kmp_acquire_ticket_lock(lck, KMP_GTID_DNE);
527 static inline int __kmp_test_bootstrap_lock(kmp_bootstrap_lock_t *lck) {
528 return __kmp_test_ticket_lock(lck, KMP_GTID_DNE);
531 static inline void __kmp_release_bootstrap_lock(kmp_bootstrap_lock_t *lck) {
532 __kmp_release_ticket_lock(lck, KMP_GTID_DNE);
535 static inline void __kmp_init_bootstrap_lock(kmp_bootstrap_lock_t *lck) {
536 __kmp_init_ticket_lock(lck);
539 static inline void __kmp_destroy_bootstrap_lock(kmp_bootstrap_lock_t *lck) {
540 __kmp_destroy_ticket_lock(lck);
551 typedef kmp_ticket_lock_t kmp_lock_t;
553 #define KMP_LOCK_INIT(lock) kmp_lock_t lock = KMP_TICKET_LOCK_INITIALIZER(lock)
555 static inline int __kmp_acquire_lock(kmp_lock_t *lck, kmp_int32 gtid) {
556 return __kmp_acquire_ticket_lock(lck, gtid);
559 static inline int __kmp_test_lock(kmp_lock_t *lck, kmp_int32 gtid) {
560 return __kmp_test_ticket_lock(lck, gtid);
563 static inline void __kmp_release_lock(kmp_lock_t *lck, kmp_int32 gtid) {
564 __kmp_release_ticket_lock(lck, gtid);
567 static inline void __kmp_init_lock(kmp_lock_t *lck) {
568 __kmp_init_ticket_lock(lck);
571 static inline void __kmp_destroy_lock(kmp_lock_t *lck) {
572 __kmp_destroy_ticket_lock(lck);
588 #if KMP_USE_DYNAMIC_LOCK && KMP_USE_TSX
595 #if KMP_USE_ADAPTIVE_LOCKS
597 #endif // KMP_USE_ADAPTIVE_LOCKS
600 typedef enum kmp_lock_kind kmp_lock_kind_t;
602 extern kmp_lock_kind_t __kmp_user_lock_kind;
604 union kmp_user_lock {
607 kmp_futex_lock_t futex;
609 kmp_ticket_lock_t ticket;
610 kmp_queuing_lock_t queuing;
611 kmp_drdpa_lock_t drdpa;
612 #if KMP_USE_ADAPTIVE_LOCKS
613 kmp_adaptive_lock_t adaptive;
614 #endif // KMP_USE_ADAPTIVE_LOCKS
615 kmp_lock_pool_t pool;
618 typedef union kmp_user_lock *kmp_user_lock_p;
620 #if !KMP_USE_DYNAMIC_LOCK
622 extern size_t __kmp_base_user_lock_size;
623 extern size_t __kmp_user_lock_size;
625 extern kmp_int32 (*__kmp_get_user_lock_owner_)(kmp_user_lock_p lck);
627 static inline kmp_int32 __kmp_get_user_lock_owner(kmp_user_lock_p lck) {
628 KMP_DEBUG_ASSERT(__kmp_get_user_lock_owner_ != NULL);
629 return (*__kmp_get_user_lock_owner_)(lck);
632 extern int (*__kmp_acquire_user_lock_with_checks_)(kmp_user_lock_p lck,
635 #if KMP_OS_LINUX && \
636 (KMP_ARCH_X86 || KMP_ARCH_X86_64 || KMP_ARCH_ARM || KMP_ARCH_AARCH64)
638 #define __kmp_acquire_user_lock_with_checks(lck, gtid) \
639 if (__kmp_user_lock_kind == lk_tas) { \
640 if (__kmp_env_consistency_check) { \
641 char const *const func = "omp_set_lock"; \
642 if ((sizeof(kmp_tas_lock_t) <= OMP_LOCK_T_SIZE) && \
643 lck->tas.lk.depth_locked != -1) { \
644 KMP_FATAL(LockNestableUsedAsSimple, func); \
646 if ((gtid >= 0) && (lck->tas.lk.poll - 1 == gtid)) { \
647 KMP_FATAL(LockIsAlreadyOwned, func); \
650 if (lck->tas.lk.poll != 0 || \
651 !__kmp_atomic_compare_store_acq(&lck->tas.lk.poll, 0, gtid + 1)) { \
653 KMP_FSYNC_PREPARE(lck); \
654 KMP_INIT_YIELD(spins); \
655 if (TCR_4(__kmp_nth) > \
656 (__kmp_avail_proc ? __kmp_avail_proc : __kmp_xproc)) { \
659 KMP_YIELD_SPIN(spins); \
661 while (lck->tas.lk.poll != 0 || !__kmp_atomic_compare_store_acq( \
662 &lck->tas.lk.poll, 0, gtid + 1)) { \
663 if (TCR_4(__kmp_nth) > \
664 (__kmp_avail_proc ? __kmp_avail_proc : __kmp_xproc)) { \
667 KMP_YIELD_SPIN(spins); \
671 KMP_FSYNC_ACQUIRED(lck); \
673 KMP_DEBUG_ASSERT(__kmp_acquire_user_lock_with_checks_ != NULL); \
674 (*__kmp_acquire_user_lock_with_checks_)(lck, gtid); \
678 static inline int __kmp_acquire_user_lock_with_checks(kmp_user_lock_p lck,
680 KMP_DEBUG_ASSERT(__kmp_acquire_user_lock_with_checks_ != NULL);
681 return (*__kmp_acquire_user_lock_with_checks_)(lck, gtid);
685 extern int (*__kmp_test_user_lock_with_checks_)(kmp_user_lock_p lck,
688 #if KMP_OS_LINUX && \
689 (KMP_ARCH_X86 || KMP_ARCH_X86_64 || KMP_ARCH_ARM || KMP_ARCH_AARCH64)
691 #include "kmp_i18n.h"
692 extern int __kmp_env_consistency_check;
693 static inline int __kmp_test_user_lock_with_checks(kmp_user_lock_p lck,
695 if (__kmp_user_lock_kind == lk_tas) {
696 if (__kmp_env_consistency_check) {
697 char const *
const func =
"omp_test_lock";
698 if ((
sizeof(kmp_tas_lock_t) <= OMP_LOCK_T_SIZE) &&
699 lck->tas.lk.depth_locked != -1) {
700 KMP_FATAL(LockNestableUsedAsSimple, func);
703 return ((lck->tas.lk.poll == 0) &&
704 __kmp_atomic_compare_store_acq(&lck->tas.lk.poll, 0, gtid + 1));
706 KMP_DEBUG_ASSERT(__kmp_test_user_lock_with_checks_ != NULL);
707 return (*__kmp_test_user_lock_with_checks_)(lck, gtid);
711 static inline int __kmp_test_user_lock_with_checks(kmp_user_lock_p lck,
713 KMP_DEBUG_ASSERT(__kmp_test_user_lock_with_checks_ != NULL);
714 return (*__kmp_test_user_lock_with_checks_)(lck, gtid);
718 extern int (*__kmp_release_user_lock_with_checks_)(kmp_user_lock_p lck,
721 static inline void __kmp_release_user_lock_with_checks(kmp_user_lock_p lck,
723 KMP_DEBUG_ASSERT(__kmp_release_user_lock_with_checks_ != NULL);
724 (*__kmp_release_user_lock_with_checks_)(lck, gtid);
727 extern void (*__kmp_init_user_lock_with_checks_)(kmp_user_lock_p lck);
729 static inline void __kmp_init_user_lock_with_checks(kmp_user_lock_p lck) {
730 KMP_DEBUG_ASSERT(__kmp_init_user_lock_with_checks_ != NULL);
731 (*__kmp_init_user_lock_with_checks_)(lck);
736 extern void (*__kmp_destroy_user_lock_)(kmp_user_lock_p lck);
738 static inline void __kmp_destroy_user_lock(kmp_user_lock_p lck) {
739 KMP_DEBUG_ASSERT(__kmp_destroy_user_lock_ != NULL);
740 (*__kmp_destroy_user_lock_)(lck);
743 extern void (*__kmp_destroy_user_lock_with_checks_)(kmp_user_lock_p lck);
745 static inline void __kmp_destroy_user_lock_with_checks(kmp_user_lock_p lck) {
746 KMP_DEBUG_ASSERT(__kmp_destroy_user_lock_with_checks_ != NULL);
747 (*__kmp_destroy_user_lock_with_checks_)(lck);
750 extern int (*__kmp_acquire_nested_user_lock_with_checks_)(kmp_user_lock_p lck,
753 #if KMP_OS_LINUX && (KMP_ARCH_X86 || KMP_ARCH_X86_64)
755 #define __kmp_acquire_nested_user_lock_with_checks(lck, gtid, depth) \
756 if (__kmp_user_lock_kind == lk_tas) { \
757 if (__kmp_env_consistency_check) { \
758 char const *const func = "omp_set_nest_lock"; \
759 if ((sizeof(kmp_tas_lock_t) <= OMP_NEST_LOCK_T_SIZE) && \
760 lck->tas.lk.depth_locked == -1) { \
761 KMP_FATAL(LockSimpleUsedAsNestable, func); \
764 if (lck->tas.lk.poll - 1 == gtid) { \
765 lck->tas.lk.depth_locked += 1; \
766 *depth = KMP_LOCK_ACQUIRED_NEXT; \
768 if ((lck->tas.lk.poll != 0) || \
769 !__kmp_atomic_compare_store_acq(&lck->tas.lk.poll, 0, gtid + 1)) { \
771 KMP_FSYNC_PREPARE(lck); \
772 KMP_INIT_YIELD(spins); \
773 if (TCR_4(__kmp_nth) > \
774 (__kmp_avail_proc ? __kmp_avail_proc : __kmp_xproc)) { \
777 KMP_YIELD_SPIN(spins); \
780 (lck->tas.lk.poll != 0) || \
781 !__kmp_atomic_compare_store_acq(&lck->tas.lk.poll, 0, gtid + 1)) { \
782 if (TCR_4(__kmp_nth) > \
783 (__kmp_avail_proc ? __kmp_avail_proc : __kmp_xproc)) { \
786 KMP_YIELD_SPIN(spins); \
790 lck->tas.lk.depth_locked = 1; \
791 *depth = KMP_LOCK_ACQUIRED_FIRST; \
793 KMP_FSYNC_ACQUIRED(lck); \
795 KMP_DEBUG_ASSERT(__kmp_acquire_nested_user_lock_with_checks_ != NULL); \
796 *depth = (*__kmp_acquire_nested_user_lock_with_checks_)(lck, gtid); \
801 __kmp_acquire_nested_user_lock_with_checks(kmp_user_lock_p lck, kmp_int32 gtid,
803 KMP_DEBUG_ASSERT(__kmp_acquire_nested_user_lock_with_checks_ != NULL);
804 *depth = (*__kmp_acquire_nested_user_lock_with_checks_)(lck, gtid);
808 extern int (*__kmp_test_nested_user_lock_with_checks_)(kmp_user_lock_p lck,
811 #if KMP_OS_LINUX && (KMP_ARCH_X86 || KMP_ARCH_X86_64)
812 static inline int __kmp_test_nested_user_lock_with_checks(kmp_user_lock_p lck,
814 if (__kmp_user_lock_kind == lk_tas) {
816 if (__kmp_env_consistency_check) {
817 char const *
const func =
"omp_test_nest_lock";
818 if ((
sizeof(kmp_tas_lock_t) <= OMP_NEST_LOCK_T_SIZE) &&
819 lck->tas.lk.depth_locked == -1) {
820 KMP_FATAL(LockSimpleUsedAsNestable, func);
823 KMP_DEBUG_ASSERT(gtid >= 0);
824 if (lck->tas.lk.poll - 1 ==
826 return ++lck->tas.lk.depth_locked;
828 retval = ((lck->tas.lk.poll == 0) &&
829 __kmp_atomic_compare_store_acq(&lck->tas.lk.poll, 0, gtid + 1));
832 lck->tas.lk.depth_locked = 1;
836 KMP_DEBUG_ASSERT(__kmp_test_nested_user_lock_with_checks_ != NULL);
837 return (*__kmp_test_nested_user_lock_with_checks_)(lck, gtid);
841 static inline int __kmp_test_nested_user_lock_with_checks(kmp_user_lock_p lck,
843 KMP_DEBUG_ASSERT(__kmp_test_nested_user_lock_with_checks_ != NULL);
844 return (*__kmp_test_nested_user_lock_with_checks_)(lck, gtid);
848 extern int (*__kmp_release_nested_user_lock_with_checks_)(kmp_user_lock_p lck,
852 __kmp_release_nested_user_lock_with_checks(kmp_user_lock_p lck,
854 KMP_DEBUG_ASSERT(__kmp_release_nested_user_lock_with_checks_ != NULL);
855 return (*__kmp_release_nested_user_lock_with_checks_)(lck, gtid);
858 extern void (*__kmp_init_nested_user_lock_with_checks_)(kmp_user_lock_p lck);
861 __kmp_init_nested_user_lock_with_checks(kmp_user_lock_p lck) {
862 KMP_DEBUG_ASSERT(__kmp_init_nested_user_lock_with_checks_ != NULL);
863 (*__kmp_init_nested_user_lock_with_checks_)(lck);
866 extern void (*__kmp_destroy_nested_user_lock_with_checks_)(kmp_user_lock_p lck);
869 __kmp_destroy_nested_user_lock_with_checks(kmp_user_lock_p lck) {
870 KMP_DEBUG_ASSERT(__kmp_destroy_nested_user_lock_with_checks_ != NULL);
871 (*__kmp_destroy_nested_user_lock_with_checks_)(lck);
887 extern int (*__kmp_is_user_lock_initialized_)(kmp_user_lock_p lck);
891 extern const ident_t *(*__kmp_get_user_lock_location_)(kmp_user_lock_p lck);
893 static inline const ident_t *__kmp_get_user_lock_location(kmp_user_lock_p lck) {
894 if (__kmp_get_user_lock_location_ != NULL) {
895 return (*__kmp_get_user_lock_location_)(lck);
901 extern void (*__kmp_set_user_lock_location_)(kmp_user_lock_p lck,
904 static inline void __kmp_set_user_lock_location(kmp_user_lock_p lck,
906 if (__kmp_set_user_lock_location_ != NULL) {
907 (*__kmp_set_user_lock_location_)(lck, loc);
911 extern kmp_lock_flags_t (*__kmp_get_user_lock_flags_)(kmp_user_lock_p lck);
913 extern void (*__kmp_set_user_lock_flags_)(kmp_user_lock_p lck,
914 kmp_lock_flags_t flags);
916 static inline void __kmp_set_user_lock_flags(kmp_user_lock_p lck,
917 kmp_lock_flags_t flags) {
918 if (__kmp_set_user_lock_flags_ != NULL) {
919 (*__kmp_set_user_lock_flags_)(lck, flags);
924 extern void __kmp_set_user_lock_vptrs(kmp_lock_kind_t user_lock_kind);
927 #define KMP_BIND_USER_LOCK_TEMPLATE(nest, kind, suffix) \
929 __kmp_acquire##nest##user_lock_with_checks_ = (int (*)( \
930 kmp_user_lock_p, kmp_int32))__kmp_acquire##nest##kind##_##suffix; \
931 __kmp_release##nest##user_lock_with_checks_ = (int (*)( \
932 kmp_user_lock_p, kmp_int32))__kmp_release##nest##kind##_##suffix; \
933 __kmp_test##nest##user_lock_with_checks_ = (int (*)( \
934 kmp_user_lock_p, kmp_int32))__kmp_test##nest##kind##_##suffix; \
935 __kmp_init##nest##user_lock_with_checks_ = \
936 (void (*)(kmp_user_lock_p))__kmp_init##nest##kind##_##suffix; \
937 __kmp_destroy##nest##user_lock_with_checks_ = \
938 (void (*)(kmp_user_lock_p))__kmp_destroy##nest##kind##_##suffix; \
941 #define KMP_BIND_USER_LOCK(kind) KMP_BIND_USER_LOCK_TEMPLATE(_, kind, lock)
942 #define KMP_BIND_USER_LOCK_WITH_CHECKS(kind) \
943 KMP_BIND_USER_LOCK_TEMPLATE(_, kind, lock_with_checks)
944 #define KMP_BIND_NESTED_USER_LOCK(kind) \
945 KMP_BIND_USER_LOCK_TEMPLATE(_nested_, kind, lock)
946 #define KMP_BIND_NESTED_USER_LOCK_WITH_CHECKS(kind) \
947 KMP_BIND_USER_LOCK_TEMPLATE(_nested_, kind, lock_with_checks)
972 struct kmp_lock_table {
973 kmp_lock_index_t used;
974 kmp_lock_index_t allocated;
975 kmp_user_lock_p *table;
978 typedef struct kmp_lock_table kmp_lock_table_t;
980 extern kmp_lock_table_t __kmp_user_lock_table;
981 extern kmp_user_lock_p __kmp_lock_pool;
983 struct kmp_block_of_locks {
984 struct kmp_block_of_locks *next_block;
988 typedef struct kmp_block_of_locks kmp_block_of_locks_t;
990 extern kmp_block_of_locks_t *__kmp_lock_blocks;
991 extern int __kmp_num_locks_in_block;
993 extern kmp_user_lock_p __kmp_user_lock_allocate(
void **user_lock,
995 kmp_lock_flags_t flags);
996 extern void __kmp_user_lock_free(
void **user_lock, kmp_int32 gtid,
997 kmp_user_lock_p lck);
998 extern kmp_user_lock_p __kmp_lookup_user_lock(
void **user_lock,
1000 extern void __kmp_cleanup_user_locks();
1002 #define KMP_CHECK_USER_LOCK_INIT() \
1004 if (!TCR_4(__kmp_init_user_locks)) { \
1005 __kmp_acquire_bootstrap_lock(&__kmp_initz_lock); \
1006 if (!TCR_4(__kmp_init_user_locks)) { \
1007 TCW_4(__kmp_init_user_locks, TRUE); \
1009 __kmp_release_bootstrap_lock(&__kmp_initz_lock); \
1013 #endif // KMP_USE_DYNAMIC_LOCK
1018 #if KMP_USE_DYNAMIC_LOCK
1056 #define KMP_USE_INLINED_TAS \
1057 (KMP_OS_LINUX && (KMP_ARCH_X86 || KMP_ARCH_X86_64 || KMP_ARCH_ARM)) && 1
1058 #define KMP_USE_INLINED_FUTEX KMP_USE_FUTEX && 0
1065 #define KMP_FOREACH_D_LOCK(m, a) m(tas, a) m(futex, a) m(hle, a)
1066 #define KMP_FOREACH_I_LOCK(m, a) \
1067 m(ticket, a) m(queuing, a) m(adaptive, a) m(drdpa, a) m(rtm, a) \
1068 m(nested_tas, a) m(nested_futex, a) m(nested_ticket, a) \
1069 m(nested_queuing, a) m(nested_drdpa, a)
1071 #define KMP_FOREACH_D_LOCK(m, a) m(tas, a) m(hle, a)
1072 #define KMP_FOREACH_I_LOCK(m, a) \
1073 m(ticket, a) m(queuing, a) m(adaptive, a) m(drdpa, a) m(rtm, a) \
1074 m(nested_tas, a) m(nested_ticket, a) m(nested_queuing, a) \
1076 #endif // KMP_USE_FUTEX
1077 #define KMP_LAST_D_LOCK lockseq_hle
1080 #define KMP_FOREACH_D_LOCK(m, a) m(tas, a) m(futex, a)
1081 #define KMP_FOREACH_I_LOCK(m, a) \
1082 m(ticket, a) m(queuing, a) m(drdpa, a) m(nested_tas, a) m(nested_futex, a) \
1083 m(nested_ticket, a) m(nested_queuing, a) m(nested_drdpa, a)
1084 #define KMP_LAST_D_LOCK lockseq_futex
1086 #define KMP_FOREACH_D_LOCK(m, a) m(tas, a)
1087 #define KMP_FOREACH_I_LOCK(m, a) \
1088 m(ticket, a) m(queuing, a) m(drdpa, a) m(nested_tas, a) m(nested_ticket, a) \
1089 m(nested_queuing, a) m(nested_drdpa, a)
1090 #define KMP_LAST_D_LOCK lockseq_tas
1091 #endif // KMP_USE_FUTEX
1092 #endif // KMP_USE_TSX
1095 #define KMP_LOCK_SHIFT \
1096 8 // number of low bits to be used as tag for direct locks
1097 #define KMP_FIRST_D_LOCK lockseq_tas
1098 #define KMP_FIRST_I_LOCK lockseq_ticket
1099 #define KMP_LAST_I_LOCK lockseq_nested_drdpa
1100 #define KMP_NUM_I_LOCKS \
1101 (locktag_nested_drdpa + 1) // number of indirect lock types
1104 typedef kmp_uint32 kmp_dyna_lock_t;
1109 lockseq_indirect = 0,
1110 #define expand_seq(l, a) lockseq_##l,
1111 KMP_FOREACH_D_LOCK(expand_seq, 0) KMP_FOREACH_I_LOCK(expand_seq, 0)
1113 } kmp_dyna_lockseq_t;
1117 #define expand_tag(l, a) locktag_##l,
1118 KMP_FOREACH_I_LOCK(expand_tag, 0)
1120 } kmp_indirect_locktag_t;
1123 #define KMP_IS_D_LOCK(seq) \
1124 ((seq) >= KMP_FIRST_D_LOCK && (seq) <= KMP_LAST_D_LOCK)
1125 #define KMP_IS_I_LOCK(seq) \
1126 ((seq) >= KMP_FIRST_I_LOCK && (seq) <= KMP_LAST_I_LOCK)
1127 #define KMP_GET_I_TAG(seq) (kmp_indirect_locktag_t)((seq)-KMP_FIRST_I_LOCK)
1128 #define KMP_GET_D_TAG(seq) ((seq) << 1 | 1)
1132 #define expand_tag(l, a) locktag_##l = KMP_GET_D_TAG(lockseq_##l),
1133 KMP_FOREACH_D_LOCK(expand_tag, 0)
1135 } kmp_direct_locktag_t;
1139 kmp_user_lock_p lock;
1140 kmp_indirect_locktag_t type;
1141 } kmp_indirect_lock_t;
1145 extern void (*__kmp_direct_init[])(kmp_dyna_lock_t *, kmp_dyna_lockseq_t);
1146 extern void (*(*__kmp_direct_destroy))(kmp_dyna_lock_t *);
1147 extern int (*(*__kmp_direct_set))(kmp_dyna_lock_t *, kmp_int32);
1148 extern int (*(*__kmp_direct_unset))(kmp_dyna_lock_t *, kmp_int32);
1149 extern int (*(*__kmp_direct_test))(kmp_dyna_lock_t *, kmp_int32);
1153 extern void (*__kmp_indirect_init[])(kmp_user_lock_p);
1154 extern void (*(*__kmp_indirect_destroy))(kmp_user_lock_p);
1155 extern int (*(*__kmp_indirect_set))(kmp_user_lock_p, kmp_int32);
1156 extern int (*(*__kmp_indirect_unset))(kmp_user_lock_p, kmp_int32);
1157 extern int (*(*__kmp_indirect_test))(kmp_user_lock_p, kmp_int32);
1160 #define KMP_EXTRACT_D_TAG(l) \
1161 (*((kmp_dyna_lock_t *)(l)) & ((1 << KMP_LOCK_SHIFT) - 1) & \
1162 -(*((kmp_dyna_lock_t *)(l)) & 1))
1165 #define KMP_EXTRACT_I_INDEX(l) (*(kmp_lock_index_t *)(l) >> 1)
1169 #define KMP_D_LOCK_FUNC(l, op) __kmp_direct_##op[KMP_EXTRACT_D_TAG(l)]
1173 #define KMP_I_LOCK_FUNC(l, op) \
1174 __kmp_indirect_##op[((kmp_indirect_lock_t *)(l))->type]
1177 #define KMP_INIT_D_LOCK(l, seq) \
1178 __kmp_direct_init[KMP_GET_D_TAG(seq)]((kmp_dyna_lock_t *)l, seq)
1181 #define KMP_INIT_I_LOCK(l, seq) \
1182 __kmp_direct_init[0]((kmp_dyna_lock_t *)(l), seq)
1185 #define KMP_LOCK_FREE(type) (locktag_##type)
1188 #define KMP_LOCK_BUSY(v, type) ((v) << KMP_LOCK_SHIFT | locktag_##type)
1191 #define KMP_LOCK_STRIP(v) ((v) >> KMP_LOCK_SHIFT)
1195 extern void __kmp_init_dynamic_user_locks();
1198 extern kmp_indirect_lock_t *
1199 __kmp_allocate_indirect_lock(
void **, kmp_int32, kmp_indirect_locktag_t);
1202 extern void __kmp_cleanup_indirect_user_locks();
1205 extern kmp_dyna_lockseq_t __kmp_user_lock_seq;
1208 extern void (*__kmp_indirect_set_location[KMP_NUM_I_LOCKS])(kmp_user_lock_p,
1210 #define KMP_SET_I_LOCK_LOCATION(lck, loc) \
1212 if (__kmp_indirect_set_location[(lck)->type] != NULL) \
1213 __kmp_indirect_set_location[(lck)->type]((lck)->lock, loc); \
1217 extern void (*__kmp_indirect_set_flags[KMP_NUM_I_LOCKS])(kmp_user_lock_p,
1219 #define KMP_SET_I_LOCK_FLAGS(lck, flag) \
1221 if (__kmp_indirect_set_flags[(lck)->type] != NULL) \
1222 __kmp_indirect_set_flags[(lck)->type]((lck)->lock, flag); \
1226 extern const ident_t *(*__kmp_indirect_get_location[KMP_NUM_I_LOCKS])(
1228 #define KMP_GET_I_LOCK_LOCATION(lck) \
1229 (__kmp_indirect_get_location[(lck)->type] != NULL \
1230 ? __kmp_indirect_get_location[(lck)->type]((lck)->lock) \
1234 extern kmp_lock_flags_t (*__kmp_indirect_get_flags[KMP_NUM_I_LOCKS])(
1236 #define KMP_GET_I_LOCK_FLAGS(lck) \
1237 (__kmp_indirect_get_flags[(lck)->type] != NULL \
1238 ? __kmp_indirect_get_flags[(lck)->type]((lck)->lock) \
1241 #define KMP_I_LOCK_CHUNK \
1242 1024 // number of kmp_indirect_lock_t objects to be allocated together
1245 typedef struct kmp_indirect_lock_table {
1246 kmp_indirect_lock_t **table;
1247 kmp_lock_index_t size;
1248 kmp_lock_index_t next;
1249 } kmp_indirect_lock_table_t;
1251 extern kmp_indirect_lock_table_t __kmp_i_lock_table;
1254 #define KMP_GET_I_LOCK(index) \
1255 (*(__kmp_i_lock_table.table + (index) / KMP_I_LOCK_CHUNK) + \
1256 (index) % KMP_I_LOCK_CHUNK)
1261 extern int __kmp_num_locks_in_block;
1264 #define KMP_LOOKUP_I_LOCK(l) \
1265 ((OMP_LOCK_T_SIZE < sizeof(void *)) ? KMP_GET_I_LOCK(KMP_EXTRACT_I_INDEX(l)) \
1266 : *((kmp_indirect_lock_t **)(l)))
1269 extern kmp_int32 __kmp_get_user_lock_owner(kmp_user_lock_p, kmp_uint32);
1271 #else // KMP_USE_DYNAMIC_LOCK
1273 #define KMP_LOCK_BUSY(v, type) (v)
1274 #define KMP_LOCK_FREE(type) 0
1275 #define KMP_LOCK_STRIP(v) (v)
1277 #endif // KMP_USE_DYNAMIC_LOCK
1282 kmp_uint32 max_backoff;
1283 kmp_uint32 min_tick;
1287 extern kmp_backoff_t __kmp_spin_backoff_params;
1290 extern void __kmp_spin_backoff(kmp_backoff_t *);
1294 #endif // __cplusplus