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
68typedef kmp_uint32 kmp_lock_flags_t;
70#define kmp_lf_critical_section 1
73typedef kmp_uint32 kmp_lock_index_t;
78 union kmp_user_lock *next;
79 kmp_lock_index_t index;
82typedef struct kmp_lock_pool kmp_lock_pool_t;
84extern void __kmp_validate_locks(
void);
121struct kmp_base_tas_lock {
123 std::atomic<kmp_int32> poll;
124 kmp_int32 depth_locked;
127typedef struct kmp_base_tas_lock kmp_base_tas_lock_t;
130 kmp_base_tas_lock_t lk;
131 kmp_lock_pool_t pool;
135typedef union kmp_tas_lock kmp_tas_lock_t;
139#define KMP_TAS_LOCK_INITIALIZER(lock) \
141 { ATOMIC_VAR_INIT(KMP_LOCK_FREE(tas)), 0 } \
144extern int __kmp_acquire_tas_lock(kmp_tas_lock_t *lck, kmp_int32 gtid);
145extern int __kmp_test_tas_lock(kmp_tas_lock_t *lck, kmp_int32 gtid);
146extern int __kmp_release_tas_lock(kmp_tas_lock_t *lck, kmp_int32 gtid);
147extern void __kmp_init_tas_lock(kmp_tas_lock_t *lck);
148extern void __kmp_destroy_tas_lock(kmp_tas_lock_t *lck);
150extern int __kmp_acquire_nested_tas_lock(kmp_tas_lock_t *lck, kmp_int32 gtid);
151extern int __kmp_test_nested_tas_lock(kmp_tas_lock_t *lck, kmp_int32 gtid);
152extern int __kmp_release_nested_tas_lock(kmp_tas_lock_t *lck, kmp_int32 gtid);
153extern void __kmp_init_nested_tas_lock(kmp_tas_lock_t *lck);
154extern 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
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))
178struct kmp_base_futex_lock {
179 volatile kmp_int32 poll;
182 kmp_int32 depth_locked;
185typedef struct kmp_base_futex_lock kmp_base_futex_lock_t;
187union kmp_futex_lock {
188 kmp_base_futex_lock_t lk;
189 kmp_lock_pool_t pool;
194typedef union kmp_futex_lock kmp_futex_lock_t;
198#define KMP_FUTEX_LOCK_INITIALIZER(lock) \
200 { KMP_LOCK_FREE(futex), 0 } \
203extern int __kmp_acquire_futex_lock(kmp_futex_lock_t *lck, kmp_int32 gtid);
204extern int __kmp_test_futex_lock(kmp_futex_lock_t *lck, kmp_int32 gtid);
205extern int __kmp_release_futex_lock(kmp_futex_lock_t *lck, kmp_int32 gtid);
206extern void __kmp_init_futex_lock(kmp_futex_lock_t *lck);
207extern void __kmp_destroy_futex_lock(kmp_futex_lock_t *lck);
209extern int __kmp_acquire_nested_futex_lock(kmp_futex_lock_t *lck,
211extern int __kmp_test_nested_futex_lock(kmp_futex_lock_t *lck, kmp_int32 gtid);
212extern int __kmp_release_nested_futex_lock(kmp_futex_lock_t *lck,
214extern void __kmp_init_nested_futex_lock(kmp_futex_lock_t *lck);
215extern void __kmp_destroy_nested_futex_lock(kmp_futex_lock_t *lck);
228struct 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;
241struct 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;
258struct kmp_base_ticket_lock;
262typedef struct kmp_base_ticket_lock kmp_base_ticket_lock_t;
264union 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)];
272typedef 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) \
286extern int __kmp_acquire_ticket_lock(kmp_ticket_lock_t *lck, kmp_int32 gtid);
287extern int __kmp_test_ticket_lock(kmp_ticket_lock_t *lck, kmp_int32 gtid);
288extern int __kmp_test_ticket_lock_with_cheks(kmp_ticket_lock_t *lck,
290extern int __kmp_release_ticket_lock(kmp_ticket_lock_t *lck, kmp_int32 gtid);
291extern void __kmp_init_ticket_lock(kmp_ticket_lock_t *lck);
292extern void __kmp_destroy_ticket_lock(kmp_ticket_lock_t *lck);
294extern int __kmp_acquire_nested_ticket_lock(kmp_ticket_lock_t *lck,
296extern int __kmp_test_nested_ticket_lock(kmp_ticket_lock_t *lck,
298extern int __kmp_release_nested_ticket_lock(kmp_ticket_lock_t *lck,
300extern void __kmp_init_nested_ticket_lock(kmp_ticket_lock_t *lck);
301extern void __kmp_destroy_nested_ticket_lock(kmp_ticket_lock_t *lck);
306#if KMP_USE_ADAPTIVE_LOCKS
308struct kmp_adaptive_lock_info;
310typedef struct kmp_adaptive_lock_info kmp_adaptive_lock_info_t;
312#if KMP_DEBUG_ADAPTIVE_LOCKS
314struct 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;
328typedef struct kmp_adaptive_lock_statistics kmp_adaptive_lock_statistics_t;
330extern void __kmp_print_speculative_stats();
331extern void __kmp_init_speculative_stats();
335struct 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;
353struct 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;
380typedef struct kmp_base_queuing_lock kmp_base_queuing_lock_t;
382KMP_BUILD_ASSERT(offsetof(kmp_base_queuing_lock_t, tail_id) % 8 == 0);
384union 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)];
392typedef union kmp_queuing_lock kmp_queuing_lock_t;
394extern int __kmp_acquire_queuing_lock(kmp_queuing_lock_t *lck, kmp_int32 gtid);
395extern int __kmp_test_queuing_lock(kmp_queuing_lock_t *lck, kmp_int32 gtid);
396extern int __kmp_release_queuing_lock(kmp_queuing_lock_t *lck, kmp_int32 gtid);
397extern void __kmp_init_queuing_lock(kmp_queuing_lock_t *lck);
398extern void __kmp_destroy_queuing_lock(kmp_queuing_lock_t *lck);
400extern int __kmp_acquire_nested_queuing_lock(kmp_queuing_lock_t *lck,
402extern int __kmp_test_nested_queuing_lock(kmp_queuing_lock_t *lck,
404extern int __kmp_release_nested_queuing_lock(kmp_queuing_lock_t *lck,
406extern void __kmp_init_nested_queuing_lock(kmp_queuing_lock_t *lck);
407extern void __kmp_destroy_nested_queuing_lock(kmp_queuing_lock_t *lck);
409#if KMP_USE_ADAPTIVE_LOCKS
413struct kmp_base_adaptive_lock {
414 kmp_base_queuing_lock qlk;
415 KMP_ALIGN(CACHE_LINE)
416 kmp_adaptive_lock_info_t
420typedef struct kmp_base_adaptive_lock kmp_base_adaptive_lock_t;
422union 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)];
428typedef union kmp_adaptive_lock kmp_adaptive_lock_t;
430#define GET_QLK_PTR(l) ((kmp_queuing_lock_t *)&(l)->lk.qlk)
436struct 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;
479typedef struct kmp_base_drdpa_lock kmp_base_drdpa_lock_t;
481union 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)];
489typedef union kmp_drdpa_lock kmp_drdpa_lock_t;
491extern int __kmp_acquire_drdpa_lock(kmp_drdpa_lock_t *lck, kmp_int32 gtid);
492extern int __kmp_test_drdpa_lock(kmp_drdpa_lock_t *lck, kmp_int32 gtid);
493extern int __kmp_release_drdpa_lock(kmp_drdpa_lock_t *lck, kmp_int32 gtid);
494extern void __kmp_init_drdpa_lock(kmp_drdpa_lock_t *lck);
495extern void __kmp_destroy_drdpa_lock(kmp_drdpa_lock_t *lck);
497extern int __kmp_acquire_nested_drdpa_lock(kmp_drdpa_lock_t *lck,
499extern int __kmp_test_nested_drdpa_lock(kmp_drdpa_lock_t *lck, kmp_int32 gtid);
500extern int __kmp_release_nested_drdpa_lock(kmp_drdpa_lock_t *lck,
502extern void __kmp_init_nested_drdpa_lock(kmp_drdpa_lock_t *lck);
503extern void __kmp_destroy_nested_drdpa_lock(kmp_drdpa_lock_t *lck);
517typedef 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)
523static inline int __kmp_acquire_bootstrap_lock(kmp_bootstrap_lock_t *lck) {
524 return __kmp_acquire_ticket_lock(lck, KMP_GTID_DNE);
527static inline int __kmp_test_bootstrap_lock(kmp_bootstrap_lock_t *lck) {
528 return __kmp_test_ticket_lock(lck, KMP_GTID_DNE);
531static inline void __kmp_release_bootstrap_lock(kmp_bootstrap_lock_t *lck) {
532 __kmp_release_ticket_lock(lck, KMP_GTID_DNE);
535static inline void __kmp_init_bootstrap_lock(kmp_bootstrap_lock_t *lck) {
536 __kmp_init_ticket_lock(lck);
539static inline void __kmp_destroy_bootstrap_lock(kmp_bootstrap_lock_t *lck) {
540 __kmp_destroy_ticket_lock(lck);
551typedef kmp_ticket_lock_t kmp_lock_t;
553#define KMP_LOCK_INIT(lock) kmp_lock_t lock = KMP_TICKET_LOCK_INITIALIZER(lock)
555static inline int __kmp_acquire_lock(kmp_lock_t *lck, kmp_int32 gtid) {
556 return __kmp_acquire_ticket_lock(lck, gtid);
559static inline int __kmp_test_lock(kmp_lock_t *lck, kmp_int32 gtid) {
560 return __kmp_test_ticket_lock(lck, gtid);
563static inline void __kmp_release_lock(kmp_lock_t *lck, kmp_int32 gtid) {
564 __kmp_release_ticket_lock(lck, gtid);
567static inline void __kmp_init_lock(kmp_lock_t *lck) {
568 __kmp_init_ticket_lock(lck);
571static 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
600typedef enum kmp_lock_kind kmp_lock_kind_t;
602extern kmp_lock_kind_t __kmp_user_lock_kind;
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;
615 kmp_lock_pool_t pool;
618typedef union kmp_user_lock *kmp_user_lock_p;
620#if !KMP_USE_DYNAMIC_LOCK
622extern size_t __kmp_base_user_lock_size;
623extern size_t __kmp_user_lock_size;
625extern kmp_int32 (*__kmp_get_user_lock_owner_)(kmp_user_lock_p lck);
627static 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);
632extern int (*__kmp_acquire_user_lock_with_checks_)(kmp_user_lock_p lck,
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); \
656 KMP_YIELD_OVERSUB_ELSE_SPIN(spins); \
658 lck->tas.lk.poll != 0 || \
659 !__kmp_atomic_compare_store_acq(&lck->tas.lk.poll, 0, gtid + 1)); \
661 KMP_FSYNC_ACQUIRED(lck); \
663 KMP_DEBUG_ASSERT(__kmp_acquire_user_lock_with_checks_ != NULL); \
664 (*__kmp_acquire_user_lock_with_checks_)(lck, gtid); \
668static inline int __kmp_acquire_user_lock_with_checks(kmp_user_lock_p lck,
670 KMP_DEBUG_ASSERT(__kmp_acquire_user_lock_with_checks_ != NULL);
671 return (*__kmp_acquire_user_lock_with_checks_)(lck, gtid);
675extern int (*__kmp_test_user_lock_with_checks_)(kmp_user_lock_p lck,
679 (KMP_ARCH_X86 || KMP_ARCH_X86_64 || KMP_ARCH_ARM || KMP_ARCH_AARCH64)
682extern int __kmp_env_consistency_check;
683static inline int __kmp_test_user_lock_with_checks(kmp_user_lock_p lck,
685 if (__kmp_user_lock_kind == lk_tas) {
686 if (__kmp_env_consistency_check) {
687 char const *
const func =
"omp_test_lock";
688 if ((
sizeof(kmp_tas_lock_t) <= OMP_LOCK_T_SIZE) &&
689 lck->tas.lk.depth_locked != -1) {
690 KMP_FATAL(LockNestableUsedAsSimple, func);
693 return ((lck->tas.lk.poll == 0) &&
694 __kmp_atomic_compare_store_acq(&lck->tas.lk.poll, 0, gtid + 1));
696 KMP_DEBUG_ASSERT(__kmp_test_user_lock_with_checks_ != NULL);
697 return (*__kmp_test_user_lock_with_checks_)(lck, gtid);
701static inline int __kmp_test_user_lock_with_checks(kmp_user_lock_p lck,
703 KMP_DEBUG_ASSERT(__kmp_test_user_lock_with_checks_ != NULL);
704 return (*__kmp_test_user_lock_with_checks_)(lck, gtid);
708extern int (*__kmp_release_user_lock_with_checks_)(kmp_user_lock_p lck,
711static inline void __kmp_release_user_lock_with_checks(kmp_user_lock_p lck,
713 KMP_DEBUG_ASSERT(__kmp_release_user_lock_with_checks_ != NULL);
714 (*__kmp_release_user_lock_with_checks_)(lck, gtid);
717extern void (*__kmp_init_user_lock_with_checks_)(kmp_user_lock_p lck);
719static inline void __kmp_init_user_lock_with_checks(kmp_user_lock_p lck) {
720 KMP_DEBUG_ASSERT(__kmp_init_user_lock_with_checks_ != NULL);
721 (*__kmp_init_user_lock_with_checks_)(lck);
726extern void (*__kmp_destroy_user_lock_)(kmp_user_lock_p lck);
728static inline void __kmp_destroy_user_lock(kmp_user_lock_p lck) {
729 KMP_DEBUG_ASSERT(__kmp_destroy_user_lock_ != NULL);
730 (*__kmp_destroy_user_lock_)(lck);
733extern void (*__kmp_destroy_user_lock_with_checks_)(kmp_user_lock_p lck);
735static inline void __kmp_destroy_user_lock_with_checks(kmp_user_lock_p lck) {
736 KMP_DEBUG_ASSERT(__kmp_destroy_user_lock_with_checks_ != NULL);
737 (*__kmp_destroy_user_lock_with_checks_)(lck);
740extern int (*__kmp_acquire_nested_user_lock_with_checks_)(kmp_user_lock_p lck,
743#if KMP_OS_LINUX && (KMP_ARCH_X86 || KMP_ARCH_X86_64)
745#define __kmp_acquire_nested_user_lock_with_checks(lck, gtid, depth) \
746 if (__kmp_user_lock_kind == lk_tas) { \
747 if (__kmp_env_consistency_check) { \
748 char const *const func = "omp_set_nest_lock"; \
749 if ((sizeof(kmp_tas_lock_t) <= OMP_NEST_LOCK_T_SIZE) && \
750 lck->tas.lk.depth_locked == -1) { \
751 KMP_FATAL(LockSimpleUsedAsNestable, func); \
754 if (lck->tas.lk.poll - 1 == gtid) { \
755 lck->tas.lk.depth_locked += 1; \
756 *depth = KMP_LOCK_ACQUIRED_NEXT; \
758 if ((lck->tas.lk.poll != 0) || \
759 !__kmp_atomic_compare_store_acq(&lck->tas.lk.poll, 0, gtid + 1)) { \
761 KMP_FSYNC_PREPARE(lck); \
762 KMP_INIT_YIELD(spins); \
764 KMP_YIELD_OVERSUB_ELSE_SPIN(spins); \
766 (lck->tas.lk.poll != 0) || \
767 !__kmp_atomic_compare_store_acq(&lck->tas.lk.poll, 0, gtid + 1)); \
769 lck->tas.lk.depth_locked = 1; \
770 *depth = KMP_LOCK_ACQUIRED_FIRST; \
772 KMP_FSYNC_ACQUIRED(lck); \
774 KMP_DEBUG_ASSERT(__kmp_acquire_nested_user_lock_with_checks_ != NULL); \
775 *depth = (*__kmp_acquire_nested_user_lock_with_checks_)(lck, gtid); \
780__kmp_acquire_nested_user_lock_with_checks(kmp_user_lock_p lck, kmp_int32 gtid,
782 KMP_DEBUG_ASSERT(__kmp_acquire_nested_user_lock_with_checks_ != NULL);
783 *depth = (*__kmp_acquire_nested_user_lock_with_checks_)(lck, gtid);
787extern int (*__kmp_test_nested_user_lock_with_checks_)(kmp_user_lock_p lck,
790#if KMP_OS_LINUX && (KMP_ARCH_X86 || KMP_ARCH_X86_64)
791static inline int __kmp_test_nested_user_lock_with_checks(kmp_user_lock_p lck,
793 if (__kmp_user_lock_kind == lk_tas) {
795 if (__kmp_env_consistency_check) {
796 char const *
const func =
"omp_test_nest_lock";
797 if ((
sizeof(kmp_tas_lock_t) <= OMP_NEST_LOCK_T_SIZE) &&
798 lck->tas.lk.depth_locked == -1) {
799 KMP_FATAL(LockSimpleUsedAsNestable, func);
802 KMP_DEBUG_ASSERT(gtid >= 0);
803 if (lck->tas.lk.poll - 1 ==
805 return ++lck->tas.lk.depth_locked;
807 retval = ((lck->tas.lk.poll == 0) &&
808 __kmp_atomic_compare_store_acq(&lck->tas.lk.poll, 0, gtid + 1));
811 lck->tas.lk.depth_locked = 1;
815 KMP_DEBUG_ASSERT(__kmp_test_nested_user_lock_with_checks_ != NULL);
816 return (*__kmp_test_nested_user_lock_with_checks_)(lck, gtid);
820static inline int __kmp_test_nested_user_lock_with_checks(kmp_user_lock_p lck,
822 KMP_DEBUG_ASSERT(__kmp_test_nested_user_lock_with_checks_ != NULL);
823 return (*__kmp_test_nested_user_lock_with_checks_)(lck, gtid);
827extern int (*__kmp_release_nested_user_lock_with_checks_)(kmp_user_lock_p lck,
831__kmp_release_nested_user_lock_with_checks(kmp_user_lock_p lck,
833 KMP_DEBUG_ASSERT(__kmp_release_nested_user_lock_with_checks_ != NULL);
834 return (*__kmp_release_nested_user_lock_with_checks_)(lck, gtid);
837extern void (*__kmp_init_nested_user_lock_with_checks_)(kmp_user_lock_p lck);
840__kmp_init_nested_user_lock_with_checks(kmp_user_lock_p lck) {
841 KMP_DEBUG_ASSERT(__kmp_init_nested_user_lock_with_checks_ != NULL);
842 (*__kmp_init_nested_user_lock_with_checks_)(lck);
845extern void (*__kmp_destroy_nested_user_lock_with_checks_)(kmp_user_lock_p lck);
848__kmp_destroy_nested_user_lock_with_checks(kmp_user_lock_p lck) {
849 KMP_DEBUG_ASSERT(__kmp_destroy_nested_user_lock_with_checks_ != NULL);
850 (*__kmp_destroy_nested_user_lock_with_checks_)(lck);
866extern int (*__kmp_is_user_lock_initialized_)(kmp_user_lock_p lck);
870extern const ident_t *(*__kmp_get_user_lock_location_)(kmp_user_lock_p lck);
872static inline const ident_t *__kmp_get_user_lock_location(kmp_user_lock_p lck) {
873 if (__kmp_get_user_lock_location_ != NULL) {
874 return (*__kmp_get_user_lock_location_)(lck);
880extern void (*__kmp_set_user_lock_location_)(kmp_user_lock_p lck,
883static inline void __kmp_set_user_lock_location(kmp_user_lock_p lck,
885 if (__kmp_set_user_lock_location_ != NULL) {
886 (*__kmp_set_user_lock_location_)(lck, loc);
890extern kmp_lock_flags_t (*__kmp_get_user_lock_flags_)(kmp_user_lock_p lck);
892extern void (*__kmp_set_user_lock_flags_)(kmp_user_lock_p lck,
893 kmp_lock_flags_t flags);
895static inline void __kmp_set_user_lock_flags(kmp_user_lock_p lck,
896 kmp_lock_flags_t flags) {
897 if (__kmp_set_user_lock_flags_ != NULL) {
898 (*__kmp_set_user_lock_flags_)(lck, flags);
903extern void __kmp_set_user_lock_vptrs(kmp_lock_kind_t user_lock_kind);
906#define KMP_BIND_USER_LOCK_TEMPLATE(nest, kind, suffix) \
908 __kmp_acquire##nest##user_lock_with_checks_ = (int (*)( \
909 kmp_user_lock_p, kmp_int32))__kmp_acquire##nest##kind##_##suffix; \
910 __kmp_release##nest##user_lock_with_checks_ = (int (*)( \
911 kmp_user_lock_p, kmp_int32))__kmp_release##nest##kind##_##suffix; \
912 __kmp_test##nest##user_lock_with_checks_ = (int (*)( \
913 kmp_user_lock_p, kmp_int32))__kmp_test##nest##kind##_##suffix; \
914 __kmp_init##nest##user_lock_with_checks_ = \
915 (void (*)(kmp_user_lock_p))__kmp_init##nest##kind##_##suffix; \
916 __kmp_destroy##nest##user_lock_with_checks_ = \
917 (void (*)(kmp_user_lock_p))__kmp_destroy##nest##kind##_##suffix; \
920#define KMP_BIND_USER_LOCK(kind) KMP_BIND_USER_LOCK_TEMPLATE(_, kind, lock)
921#define KMP_BIND_USER_LOCK_WITH_CHECKS(kind) \
922 KMP_BIND_USER_LOCK_TEMPLATE(_, kind, lock_with_checks)
923#define KMP_BIND_NESTED_USER_LOCK(kind) \
924 KMP_BIND_USER_LOCK_TEMPLATE(_nested_, kind, lock)
925#define KMP_BIND_NESTED_USER_LOCK_WITH_CHECKS(kind) \
926 KMP_BIND_USER_LOCK_TEMPLATE(_nested_, kind, lock_with_checks)
951struct kmp_lock_table {
952 kmp_lock_index_t used;
953 kmp_lock_index_t allocated;
954 kmp_user_lock_p *table;
957typedef struct kmp_lock_table kmp_lock_table_t;
959extern kmp_lock_table_t __kmp_user_lock_table;
960extern kmp_user_lock_p __kmp_lock_pool;
962struct kmp_block_of_locks {
963 struct kmp_block_of_locks *next_block;
967typedef struct kmp_block_of_locks kmp_block_of_locks_t;
969extern kmp_block_of_locks_t *__kmp_lock_blocks;
970extern int __kmp_num_locks_in_block;
972extern kmp_user_lock_p __kmp_user_lock_allocate(
void **user_lock,
974 kmp_lock_flags_t flags);
975extern void __kmp_user_lock_free(
void **user_lock, kmp_int32 gtid,
976 kmp_user_lock_p lck);
977extern kmp_user_lock_p __kmp_lookup_user_lock(
void **user_lock,
979extern void __kmp_cleanup_user_locks();
981#define KMP_CHECK_USER_LOCK_INIT() \
983 if (!TCR_4(__kmp_init_user_locks)) { \
984 __kmp_acquire_bootstrap_lock(&__kmp_initz_lock); \
985 if (!TCR_4(__kmp_init_user_locks)) { \
986 TCW_4(__kmp_init_user_locks, TRUE); \
988 __kmp_release_bootstrap_lock(&__kmp_initz_lock); \
997#if KMP_USE_DYNAMIC_LOCK
1035#define KMP_USE_INLINED_TAS \
1036 (KMP_OS_LINUX && (KMP_ARCH_X86 || KMP_ARCH_X86_64 || KMP_ARCH_ARM)) && 1
1037#define KMP_USE_INLINED_FUTEX KMP_USE_FUTEX && 0
1044#define KMP_FOREACH_D_LOCK(m, a) m(tas, a) m(futex, a) m(hle, a)
1045#define KMP_FOREACH_I_LOCK(m, a) \
1046 m(ticket, a) m(queuing, a) m(adaptive, a) m(drdpa, a) m(rtm, a) \
1047 m(nested_tas, a) m(nested_futex, a) m(nested_ticket, a) \
1048 m(nested_queuing, a) m(nested_drdpa, a)
1050#define KMP_FOREACH_D_LOCK(m, a) m(tas, a) m(hle, a)
1051#define KMP_FOREACH_I_LOCK(m, a) \
1052 m(ticket, a) m(queuing, a) m(adaptive, a) m(drdpa, a) m(rtm, a) \
1053 m(nested_tas, a) m(nested_ticket, a) m(nested_queuing, a) \
1056#define KMP_LAST_D_LOCK lockseq_hle
1059#define KMP_FOREACH_D_LOCK(m, a) m(tas, a) m(futex, a)
1060#define KMP_FOREACH_I_LOCK(m, a) \
1061 m(ticket, a) m(queuing, a) m(drdpa, a) m(nested_tas, a) m(nested_futex, a) \
1062 m(nested_ticket, a) m(nested_queuing, a) m(nested_drdpa, a)
1063#define KMP_LAST_D_LOCK lockseq_futex
1065#define KMP_FOREACH_D_LOCK(m, a) m(tas, a)
1066#define KMP_FOREACH_I_LOCK(m, a) \
1067 m(ticket, a) m(queuing, a) m(drdpa, a) m(nested_tas, a) m(nested_ticket, a) \
1068 m(nested_queuing, a) m(nested_drdpa, a)
1069#define KMP_LAST_D_LOCK lockseq_tas
1074#define KMP_LOCK_SHIFT \
1076#define KMP_FIRST_D_LOCK lockseq_tas
1077#define KMP_FIRST_I_LOCK lockseq_ticket
1078#define KMP_LAST_I_LOCK lockseq_nested_drdpa
1079#define KMP_NUM_I_LOCKS \
1080 (locktag_nested_drdpa + 1)
1083typedef kmp_uint32 kmp_dyna_lock_t;
1088 lockseq_indirect = 0,
1089#define expand_seq(l, a) lockseq_##l,
1090 KMP_FOREACH_D_LOCK(expand_seq, 0) KMP_FOREACH_I_LOCK(expand_seq, 0)
1092} kmp_dyna_lockseq_t;
1096#define expand_tag(l, a) locktag_##l,
1097 KMP_FOREACH_I_LOCK(expand_tag, 0)
1099} kmp_indirect_locktag_t;
1102#define KMP_IS_D_LOCK(seq) \
1103 ((seq) >= KMP_FIRST_D_LOCK && (seq) <= KMP_LAST_D_LOCK)
1104#define KMP_IS_I_LOCK(seq) \
1105 ((seq) >= KMP_FIRST_I_LOCK && (seq) <= KMP_LAST_I_LOCK)
1106#define KMP_GET_I_TAG(seq) (kmp_indirect_locktag_t)((seq)-KMP_FIRST_I_LOCK)
1107#define KMP_GET_D_TAG(seq) ((seq) << 1 | 1)
1111#define expand_tag(l, a) locktag_##l = KMP_GET_D_TAG(lockseq_##l),
1112 KMP_FOREACH_D_LOCK(expand_tag, 0)
1114} kmp_direct_locktag_t;
1118 kmp_user_lock_p lock;
1119 kmp_indirect_locktag_t type;
1120} kmp_indirect_lock_t;
1124extern void (*__kmp_direct_init[])(kmp_dyna_lock_t *, kmp_dyna_lockseq_t);
1125extern void (**__kmp_direct_destroy)(kmp_dyna_lock_t *);
1126extern int (**__kmp_direct_set)(kmp_dyna_lock_t *, kmp_int32);
1127extern int (**__kmp_direct_unset)(kmp_dyna_lock_t *, kmp_int32);
1128extern int (**__kmp_direct_test)(kmp_dyna_lock_t *, kmp_int32);
1132extern void (*__kmp_indirect_init[])(kmp_user_lock_p);
1133extern void (**__kmp_indirect_destroy)(kmp_user_lock_p);
1134extern int (**__kmp_indirect_set)(kmp_user_lock_p, kmp_int32);
1135extern int (**__kmp_indirect_unset)(kmp_user_lock_p, kmp_int32);
1136extern int (**__kmp_indirect_test)(kmp_user_lock_p, kmp_int32);
1139#define KMP_EXTRACT_D_TAG(l) \
1140 (*((kmp_dyna_lock_t *)(l)) & ((1 << KMP_LOCK_SHIFT) - 1) & \
1141 -(*((kmp_dyna_lock_t *)(l)) & 1))
1144#define KMP_EXTRACT_I_INDEX(l) (*(kmp_lock_index_t *)(l) >> 1)
1148#define KMP_D_LOCK_FUNC(l, op) __kmp_direct_##op[KMP_EXTRACT_D_TAG(l)]
1152#define KMP_I_LOCK_FUNC(l, op) \
1153 __kmp_indirect_##op[((kmp_indirect_lock_t *)(l))->type]
1156#define KMP_INIT_D_LOCK(l, seq) \
1157 __kmp_direct_init[KMP_GET_D_TAG(seq)]((kmp_dyna_lock_t *)l, seq)
1160#define KMP_INIT_I_LOCK(l, seq) \
1161 __kmp_direct_init[0]((kmp_dyna_lock_t *)(l), seq)
1164#define KMP_LOCK_FREE(type) (locktag_##type)
1167#define KMP_LOCK_BUSY(v, type) ((v) << KMP_LOCK_SHIFT | locktag_##type)
1170#define KMP_LOCK_STRIP(v) ((v) >> KMP_LOCK_SHIFT)
1174extern void __kmp_init_dynamic_user_locks();
1177extern kmp_indirect_lock_t *
1178__kmp_allocate_indirect_lock(
void **, kmp_int32, kmp_indirect_locktag_t);
1181extern void __kmp_cleanup_indirect_user_locks();
1184extern kmp_dyna_lockseq_t __kmp_user_lock_seq;
1187extern void (*__kmp_indirect_set_location[KMP_NUM_I_LOCKS])(kmp_user_lock_p,
1189#define KMP_SET_I_LOCK_LOCATION(lck, loc) \
1191 if (__kmp_indirect_set_location[(lck)->type] != NULL) \
1192 __kmp_indirect_set_location[(lck)->type]((lck)->lock, loc); \
1196extern void (*__kmp_indirect_set_flags[KMP_NUM_I_LOCKS])(kmp_user_lock_p,
1198#define KMP_SET_I_LOCK_FLAGS(lck, flag) \
1200 if (__kmp_indirect_set_flags[(lck)->type] != NULL) \
1201 __kmp_indirect_set_flags[(lck)->type]((lck)->lock, flag); \
1205extern const ident_t *(*__kmp_indirect_get_location[KMP_NUM_I_LOCKS])(
1207#define KMP_GET_I_LOCK_LOCATION(lck) \
1208 (__kmp_indirect_get_location[(lck)->type] != NULL \
1209 ? __kmp_indirect_get_location[(lck)->type]((lck)->lock) \
1213extern kmp_lock_flags_t (*__kmp_indirect_get_flags[KMP_NUM_I_LOCKS])(
1215#define KMP_GET_I_LOCK_FLAGS(lck) \
1216 (__kmp_indirect_get_flags[(lck)->type] != NULL \
1217 ? __kmp_indirect_get_flags[(lck)->type]((lck)->lock) \
1220#define KMP_I_LOCK_CHUNK \
1224typedef struct kmp_indirect_lock_table {
1225 kmp_indirect_lock_t **table;
1226 kmp_lock_index_t size;
1227 kmp_lock_index_t next;
1228} kmp_indirect_lock_table_t;
1230extern kmp_indirect_lock_table_t __kmp_i_lock_table;
1233#define KMP_GET_I_LOCK(index) \
1234 (*(__kmp_i_lock_table.table + (index) / KMP_I_LOCK_CHUNK) + \
1235 (index) % KMP_I_LOCK_CHUNK)
1240extern int __kmp_num_locks_in_block;
1243#define KMP_LOOKUP_I_LOCK(l) \
1244 ((OMP_LOCK_T_SIZE < sizeof(void *)) ? KMP_GET_I_LOCK(KMP_EXTRACT_I_INDEX(l)) \
1245 : *((kmp_indirect_lock_t **)(l)))
1248extern kmp_int32 __kmp_get_user_lock_owner(kmp_user_lock_p, kmp_uint32);
1252#define KMP_LOCK_BUSY(v, type) (v)
1253#define KMP_LOCK_FREE(type) 0
1254#define KMP_LOCK_STRIP(v) (v)
1261 kmp_uint32 max_backoff;
1262 kmp_uint32 min_tick;
1266extern kmp_backoff_t __kmp_spin_backoff_params;
1269extern void __kmp_spin_backoff(kmp_backoff_t *);