42 #include "kmp_debug.h"
52 #define KMP_PAD(type, sz) (sizeof(type) + (sz - ((sizeof(type) - 1) % (sz)) - 1))
53 #define KMP_GTID_DNE (-2)
74 #if KMP_OS_LINUX && defined(KMP_GOMP_COMPAT)
75 # define OMP_LOCK_T_SIZE sizeof(int)
76 # define OMP_NEST_LOCK_T_SIZE sizeof(void *)
78 # define OMP_LOCK_T_SIZE sizeof(void *)
79 # define OMP_NEST_LOCK_T_SIZE sizeof(void *)
87 #define OMP_CRITICAL_SIZE sizeof(void *)
88 #define INTEL_CRITICAL_SIZE 32
93 typedef kmp_uint32 kmp_lock_flags_t;
95 #define kmp_lf_critical_section 1
100 typedef kmp_uint32 kmp_lock_index_t;
106 struct kmp_lock_pool {
107 union kmp_user_lock *next;
108 kmp_lock_index_t index;
111 typedef struct kmp_lock_pool kmp_lock_pool_t;
114 extern void __kmp_validate_locks(
void );
158 struct kmp_base_tas_lock {
159 volatile kmp_int32 poll;
161 kmp_int32 depth_locked;
164 typedef struct kmp_base_tas_lock kmp_base_tas_lock_t;
167 kmp_base_tas_lock_t lk;
168 kmp_lock_pool_t pool;
173 typedef union kmp_tas_lock kmp_tas_lock_t;
179 #define KMP_TAS_LOCK_INITIALIZER( lock ) { { 0, 0 } }
181 extern void __kmp_acquire_tas_lock( kmp_tas_lock_t *lck, kmp_int32 gtid );
182 extern int __kmp_test_tas_lock( kmp_tas_lock_t *lck, kmp_int32 gtid );
183 extern void __kmp_release_tas_lock( kmp_tas_lock_t *lck, kmp_int32 gtid );
184 extern void __kmp_init_tas_lock( kmp_tas_lock_t *lck );
185 extern void __kmp_destroy_tas_lock( kmp_tas_lock_t *lck );
187 extern void __kmp_acquire_nested_tas_lock( kmp_tas_lock_t *lck, kmp_int32 gtid );
188 extern int __kmp_test_nested_tas_lock( kmp_tas_lock_t *lck, kmp_int32 gtid );
189 extern void __kmp_release_nested_tas_lock( kmp_tas_lock_t *lck, kmp_int32 gtid );
190 extern void __kmp_init_nested_tas_lock( kmp_tas_lock_t *lck );
191 extern void __kmp_destroy_nested_tas_lock( kmp_tas_lock_t *lck );
194 #if KMP_OS_LINUX && (KMP_ARCH_X86 || KMP_ARCH_X86_64 || KMP_ARCH_ARM || KMP_ARCH_AARCH64)
208 struct kmp_base_futex_lock {
209 volatile kmp_int32 poll;
212 kmp_int32 depth_locked;
215 typedef struct kmp_base_futex_lock kmp_base_futex_lock_t;
217 union kmp_futex_lock {
218 kmp_base_futex_lock_t lk;
219 kmp_lock_pool_t pool;
224 typedef union kmp_futex_lock kmp_futex_lock_t;
230 #define KMP_FUTEX_LOCK_INITIALIZER( lock ) { { 0, 0 } }
232 extern void __kmp_acquire_futex_lock( kmp_futex_lock_t *lck, kmp_int32 gtid );
233 extern int __kmp_test_futex_lock( kmp_futex_lock_t *lck, kmp_int32 gtid );
234 extern void __kmp_release_futex_lock( kmp_futex_lock_t *lck, kmp_int32 gtid );
235 extern void __kmp_init_futex_lock( kmp_futex_lock_t *lck );
236 extern void __kmp_destroy_futex_lock( kmp_futex_lock_t *lck );
238 extern void __kmp_acquire_nested_futex_lock( kmp_futex_lock_t *lck, kmp_int32 gtid );
239 extern int __kmp_test_nested_futex_lock( kmp_futex_lock_t *lck, kmp_int32 gtid );
240 extern void __kmp_release_nested_futex_lock( kmp_futex_lock_t *lck, kmp_int32 gtid );
241 extern void __kmp_init_nested_futex_lock( kmp_futex_lock_t *lck );
242 extern void __kmp_destroy_nested_futex_lock( kmp_futex_lock_t *lck );
244 #endif // KMP_OS_LINUX && (KMP_ARCH_X86 || KMP_ARCH_X86_64 || KMP_ARCH_ARM || KMP_ARCH_AARCH64)
251 struct kmp_base_ticket_lock {
253 volatile union kmp_ticket_lock * initialized;
255 volatile kmp_uint32 next_ticket;
256 volatile kmp_uint32 now_serving;
257 volatile kmp_int32 owner_id;
258 kmp_int32 depth_locked;
259 kmp_lock_flags_t flags;
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 lk;
266 kmp_lock_pool_t pool;
268 char lk_pad[ KMP_PAD( kmp_base_ticket_lock_t, CACHE_LINE ) ];
271 typedef union kmp_ticket_lock kmp_ticket_lock_t;
278 #define KMP_TICKET_LOCK_INITIALIZER( lock ) { { (kmp_ticket_lock_t *) & (lock), NULL, 0, 0, 0, -1 } }
280 extern void __kmp_acquire_ticket_lock( kmp_ticket_lock_t *lck, kmp_int32 gtid );
281 extern int __kmp_test_ticket_lock( kmp_ticket_lock_t *lck, kmp_int32 gtid );
282 extern int __kmp_test_ticket_lock_with_cheks( kmp_ticket_lock_t *lck, kmp_int32 gtid );
283 extern void __kmp_release_ticket_lock( kmp_ticket_lock_t *lck, kmp_int32 gtid );
284 extern void __kmp_init_ticket_lock( kmp_ticket_lock_t *lck );
285 extern void __kmp_destroy_ticket_lock( kmp_ticket_lock_t *lck );
287 extern void __kmp_acquire_nested_ticket_lock( kmp_ticket_lock_t *lck, kmp_int32 gtid );
288 extern int __kmp_test_nested_ticket_lock( kmp_ticket_lock_t *lck, kmp_int32 gtid );
289 extern void __kmp_release_nested_ticket_lock( kmp_ticket_lock_t *lck, kmp_int32 gtid );
290 extern void __kmp_init_nested_ticket_lock( kmp_ticket_lock_t *lck );
291 extern void __kmp_destroy_nested_ticket_lock( kmp_ticket_lock_t *lck );
298 #if KMP_USE_ADAPTIVE_LOCKS
300 struct kmp_adaptive_lock_info;
302 typedef struct kmp_adaptive_lock_info kmp_adaptive_lock_info_t;
304 #if KMP_DEBUG_ADAPTIVE_LOCKS
306 struct kmp_adaptive_lock_statistics {
308 kmp_adaptive_lock_info_t * next;
309 kmp_adaptive_lock_info_t * prev;
312 kmp_uint32 successfulSpeculations;
313 kmp_uint32 hardFailedSpeculations;
314 kmp_uint32 softFailedSpeculations;
315 kmp_uint32 nonSpeculativeAcquires;
316 kmp_uint32 nonSpeculativeAcquireAttempts;
317 kmp_uint32 lemmingYields;
320 typedef struct kmp_adaptive_lock_statistics kmp_adaptive_lock_statistics_t;
322 extern void __kmp_print_speculative_stats();
323 extern void __kmp_init_speculative_stats();
325 #endif // KMP_DEBUG_ADAPTIVE_LOCKS
327 struct kmp_adaptive_lock_info
334 kmp_uint32
volatile badness;
335 kmp_uint32
volatile acquire_attempts;
337 kmp_uint32 max_badness;
338 kmp_uint32 max_soft_retries;
340 #if KMP_DEBUG_ADAPTIVE_LOCKS
341 kmp_adaptive_lock_statistics_t
volatile stats;
345 #endif // KMP_USE_ADAPTIVE_LOCKS
348 struct kmp_base_queuing_lock {
351 volatile union kmp_queuing_lock *initialized;
357 volatile kmp_int32 tail_id;
359 volatile kmp_int32 head_id;
362 volatile kmp_uint32 next_ticket;
363 volatile kmp_uint32 now_serving;
364 volatile kmp_int32 owner_id;
365 kmp_int32 depth_locked;
367 kmp_lock_flags_t flags;
370 typedef struct kmp_base_queuing_lock kmp_base_queuing_lock_t;
372 KMP_BUILD_ASSERT( offsetof( kmp_base_queuing_lock_t, tail_id ) % 8 == 0 );
374 union KMP_ALIGN_CACHE kmp_queuing_lock {
375 kmp_base_queuing_lock_t lk;
376 kmp_lock_pool_t pool;
378 char lk_pad[ KMP_PAD( kmp_base_queuing_lock_t, CACHE_LINE ) ];
381 typedef union kmp_queuing_lock kmp_queuing_lock_t;
383 extern void __kmp_acquire_queuing_lock( kmp_queuing_lock_t *lck, kmp_int32 gtid );
384 extern int __kmp_test_queuing_lock( kmp_queuing_lock_t *lck, kmp_int32 gtid );
385 extern void __kmp_release_queuing_lock( kmp_queuing_lock_t *lck, kmp_int32 gtid );
386 extern void __kmp_init_queuing_lock( kmp_queuing_lock_t *lck );
387 extern void __kmp_destroy_queuing_lock( kmp_queuing_lock_t *lck );
389 extern void __kmp_acquire_nested_queuing_lock( kmp_queuing_lock_t *lck, kmp_int32 gtid );
390 extern int __kmp_test_nested_queuing_lock( kmp_queuing_lock_t *lck, kmp_int32 gtid );
391 extern void __kmp_release_nested_queuing_lock( kmp_queuing_lock_t *lck, kmp_int32 gtid );
392 extern void __kmp_init_nested_queuing_lock( kmp_queuing_lock_t *lck );
393 extern void __kmp_destroy_nested_queuing_lock( kmp_queuing_lock_t *lck );
395 #if KMP_USE_ADAPTIVE_LOCKS
400 struct kmp_base_adaptive_lock {
401 kmp_base_queuing_lock qlk;
402 KMP_ALIGN(CACHE_LINE)
403 kmp_adaptive_lock_info_t adaptive;
406 typedef struct kmp_base_adaptive_lock kmp_base_adaptive_lock_t;
408 union KMP_ALIGN_CACHE kmp_adaptive_lock {
409 kmp_base_adaptive_lock_t lk;
410 kmp_lock_pool_t pool;
412 char lk_pad[ KMP_PAD(kmp_base_adaptive_lock_t, CACHE_LINE) ];
414 typedef union kmp_adaptive_lock kmp_adaptive_lock_t;
416 # define GET_QLK_PTR(l) ((kmp_queuing_lock_t *) & (l)->lk.qlk)
418 #endif // KMP_USE_ADAPTIVE_LOCKS
424 struct kmp_base_drdpa_lock {
435 volatile union kmp_drdpa_lock * initialized;
437 volatile struct kmp_lock_poll {
440 volatile kmp_uint64 mask;
441 kmp_uint64 cleanup_ticket;
442 volatile struct kmp_lock_poll * old_polls;
443 kmp_uint32 num_polls;
451 volatile kmp_uint64 next_ticket;
470 kmp_uint64 now_serving;
471 volatile kmp_uint32 owner_id;
472 kmp_int32 depth_locked;
473 kmp_lock_flags_t flags;
476 typedef struct kmp_base_drdpa_lock kmp_base_drdpa_lock_t;
478 union KMP_ALIGN_CACHE kmp_drdpa_lock {
479 kmp_base_drdpa_lock_t lk;
480 kmp_lock_pool_t pool;
482 char lk_pad[ KMP_PAD( kmp_base_drdpa_lock_t, CACHE_LINE ) ];
485 typedef union kmp_drdpa_lock kmp_drdpa_lock_t;
487 extern void __kmp_acquire_drdpa_lock( kmp_drdpa_lock_t *lck, kmp_int32 gtid );
488 extern int __kmp_test_drdpa_lock( kmp_drdpa_lock_t *lck, kmp_int32 gtid );
489 extern void __kmp_release_drdpa_lock( kmp_drdpa_lock_t *lck, kmp_int32 gtid );
490 extern void __kmp_init_drdpa_lock( kmp_drdpa_lock_t *lck );
491 extern void __kmp_destroy_drdpa_lock( kmp_drdpa_lock_t *lck );
493 extern void __kmp_acquire_nested_drdpa_lock( kmp_drdpa_lock_t *lck, kmp_int32 gtid );
494 extern int __kmp_test_nested_drdpa_lock( kmp_drdpa_lock_t *lck, kmp_int32 gtid );
495 extern void __kmp_release_nested_drdpa_lock( kmp_drdpa_lock_t *lck, kmp_int32 gtid );
496 extern void __kmp_init_nested_drdpa_lock( kmp_drdpa_lock_t *lck );
497 extern void __kmp_destroy_nested_drdpa_lock( kmp_drdpa_lock_t *lck );
515 typedef kmp_ticket_lock_t kmp_bootstrap_lock_t;
517 #define KMP_BOOTSTRAP_LOCK_INITIALIZER( lock ) KMP_TICKET_LOCK_INITIALIZER( (lock) )
520 __kmp_acquire_bootstrap_lock( kmp_bootstrap_lock_t *lck )
522 __kmp_acquire_ticket_lock( lck, KMP_GTID_DNE );
526 __kmp_test_bootstrap_lock( kmp_bootstrap_lock_t *lck )
528 return __kmp_test_ticket_lock( lck, KMP_GTID_DNE );
532 __kmp_release_bootstrap_lock( kmp_bootstrap_lock_t *lck )
534 __kmp_release_ticket_lock( lck, KMP_GTID_DNE );
538 __kmp_init_bootstrap_lock( kmp_bootstrap_lock_t *lck )
540 __kmp_init_ticket_lock( lck );
544 __kmp_destroy_bootstrap_lock( kmp_bootstrap_lock_t *lck )
546 __kmp_destroy_ticket_lock( lck );
562 typedef kmp_ticket_lock_t kmp_lock_t;
565 __kmp_acquire_lock( kmp_lock_t *lck, kmp_int32 gtid )
567 __kmp_acquire_ticket_lock( lck, gtid );
571 __kmp_test_lock( kmp_lock_t *lck, kmp_int32 gtid )
573 return __kmp_test_ticket_lock( lck, gtid );
577 __kmp_release_lock( kmp_lock_t *lck, kmp_int32 gtid )
579 __kmp_release_ticket_lock( lck, gtid );
583 __kmp_init_lock( kmp_lock_t *lck )
585 __kmp_init_ticket_lock( lck );
589 __kmp_destroy_lock( kmp_lock_t *lck )
591 __kmp_destroy_ticket_lock( lck );
610 #if KMP_OS_LINUX && (KMP_ARCH_X86 || KMP_ARCH_X86_64 || KMP_ARCH_ARM || KMP_ARCH_AARCH64)
616 #if KMP_USE_ADAPTIVE_LOCKS
618 #endif // KMP_USE_ADAPTIVE_LOCKS
621 typedef enum kmp_lock_kind kmp_lock_kind_t;
623 extern kmp_lock_kind_t __kmp_user_lock_kind;
625 union kmp_user_lock {
627 #if KMP_OS_LINUX && (KMP_ARCH_X86 || KMP_ARCH_X86_64 || KMP_ARCH_ARM || KMP_ARCH_AARCH64)
628 kmp_futex_lock_t futex;
630 kmp_ticket_lock_t ticket;
631 kmp_queuing_lock_t queuing;
632 kmp_drdpa_lock_t drdpa;
633 #if KMP_USE_ADAPTIVE_LOCKS
634 kmp_adaptive_lock_t adaptive;
635 #endif // KMP_USE_ADAPTIVE_LOCKS
636 kmp_lock_pool_t pool;
639 typedef union kmp_user_lock *kmp_user_lock_p;
641 #if ! KMP_USE_DYNAMIC_LOCK
643 extern size_t __kmp_base_user_lock_size;
644 extern size_t __kmp_user_lock_size;
646 extern kmp_int32 ( *__kmp_get_user_lock_owner_ )( kmp_user_lock_p lck );
648 static inline kmp_int32
649 __kmp_get_user_lock_owner( kmp_user_lock_p lck )
651 KMP_DEBUG_ASSERT( __kmp_get_user_lock_owner_ != NULL );
652 return ( *__kmp_get_user_lock_owner_ )( lck );
655 extern void ( *__kmp_acquire_user_lock_with_checks_ )( kmp_user_lock_p lck, kmp_int32 gtid );
657 #if KMP_OS_LINUX && (KMP_ARCH_X86 || KMP_ARCH_X86_64 || KMP_ARCH_ARM || KMP_ARCH_AARCH64)
659 #define __kmp_acquire_user_lock_with_checks(lck,gtid) \
660 if (__kmp_user_lock_kind == lk_tas) { \
661 if ( __kmp_env_consistency_check ) { \
662 char const * const func = "omp_set_lock"; \
663 if ( ( sizeof ( kmp_tas_lock_t ) <= OMP_LOCK_T_SIZE ) \
664 && lck->tas.lk.depth_locked != -1 ) { \
665 KMP_FATAL( LockNestableUsedAsSimple, func ); \
667 if ( ( gtid >= 0 ) && ( lck->tas.lk.poll - 1 == gtid ) ) { \
668 KMP_FATAL( LockIsAlreadyOwned, func ); \
671 if ( ( lck->tas.lk.poll != 0 ) || \
672 ( ! KMP_COMPARE_AND_STORE_ACQ32( &(lck->tas.lk.poll), 0, gtid + 1 ) ) ) { \
674 KMP_FSYNC_PREPARE( lck ); \
675 KMP_INIT_YIELD( spins ); \
676 if ( TCR_4(__kmp_nth) > (__kmp_avail_proc ? __kmp_avail_proc : __kmp_xproc) ) { \
679 KMP_YIELD_SPIN( spins ); \
681 while ( ( lck->tas.lk.poll != 0 ) || \
682 ( ! KMP_COMPARE_AND_STORE_ACQ32( &(lck->tas.lk.poll), 0, gtid + 1 ) ) ) { \
683 if ( TCR_4(__kmp_nth) > (__kmp_avail_proc ? __kmp_avail_proc : __kmp_xproc) ) { \
686 KMP_YIELD_SPIN( spins ); \
690 KMP_FSYNC_ACQUIRED( lck ); \
692 KMP_DEBUG_ASSERT( __kmp_acquire_user_lock_with_checks_ != NULL ); \
693 ( *__kmp_acquire_user_lock_with_checks_ )( lck, gtid ); \
698 __kmp_acquire_user_lock_with_checks( kmp_user_lock_p lck, kmp_int32 gtid )
700 KMP_DEBUG_ASSERT( __kmp_acquire_user_lock_with_checks_ != NULL );
701 ( *__kmp_acquire_user_lock_with_checks_ )( lck, gtid );
705 extern int ( *__kmp_test_user_lock_with_checks_ )( kmp_user_lock_p lck, kmp_int32 gtid );
707 #if KMP_OS_LINUX && (KMP_ARCH_X86 || KMP_ARCH_X86_64 || KMP_ARCH_ARM || KMP_ARCH_AARCH64)
709 #include "kmp_i18n.h"
710 extern int __kmp_env_consistency_check;
712 __kmp_test_user_lock_with_checks( kmp_user_lock_p lck, kmp_int32 gtid )
714 if ( __kmp_user_lock_kind == lk_tas ) {
715 if ( __kmp_env_consistency_check ) {
716 char const *
const func =
"omp_test_lock";
717 if ( (
sizeof ( kmp_tas_lock_t ) <= OMP_LOCK_T_SIZE )
718 && lck->tas.lk.depth_locked != -1 ) {
719 KMP_FATAL( LockNestableUsedAsSimple, func );
722 return ( ( lck->tas.lk.poll == 0 ) &&
723 KMP_COMPARE_AND_STORE_ACQ32( &(lck->tas.lk.poll), 0, gtid + 1 ) );
725 KMP_DEBUG_ASSERT( __kmp_test_user_lock_with_checks_ != NULL );
726 return ( *__kmp_test_user_lock_with_checks_ )( lck, gtid );
731 __kmp_test_user_lock_with_checks( kmp_user_lock_p lck, kmp_int32 gtid )
733 KMP_DEBUG_ASSERT( __kmp_test_user_lock_with_checks_ != NULL );
734 return ( *__kmp_test_user_lock_with_checks_ )( lck, gtid );
738 extern void ( *__kmp_release_user_lock_with_checks_ )( kmp_user_lock_p lck, kmp_int32 gtid );
741 __kmp_release_user_lock_with_checks( kmp_user_lock_p lck, kmp_int32 gtid )
743 KMP_DEBUG_ASSERT( __kmp_release_user_lock_with_checks_ != NULL );
744 ( *__kmp_release_user_lock_with_checks_ ) ( lck, gtid );
747 extern void ( *__kmp_init_user_lock_with_checks_ )( kmp_user_lock_p lck );
750 __kmp_init_user_lock_with_checks( kmp_user_lock_p lck )
752 KMP_DEBUG_ASSERT( __kmp_init_user_lock_with_checks_ != NULL );
753 ( *__kmp_init_user_lock_with_checks_ )( lck );
760 extern void ( *__kmp_destroy_user_lock_ )( kmp_user_lock_p lck );
763 __kmp_destroy_user_lock( kmp_user_lock_p lck )
765 KMP_DEBUG_ASSERT( __kmp_destroy_user_lock_ != NULL );
766 ( *__kmp_destroy_user_lock_ )( lck );
769 extern void ( *__kmp_destroy_user_lock_with_checks_ )( kmp_user_lock_p lck );
772 __kmp_destroy_user_lock_with_checks( kmp_user_lock_p lck )
774 KMP_DEBUG_ASSERT( __kmp_destroy_user_lock_with_checks_ != NULL );
775 ( *__kmp_destroy_user_lock_with_checks_ )( lck );
778 extern void ( *__kmp_acquire_nested_user_lock_with_checks_ )( kmp_user_lock_p lck, kmp_int32 gtid );
780 #if KMP_OS_LINUX && (KMP_ARCH_X86 || KMP_ARCH_X86_64)
782 #define __kmp_acquire_nested_user_lock_with_checks(lck,gtid) \
783 if (__kmp_user_lock_kind == lk_tas) { \
784 if ( __kmp_env_consistency_check ) { \
785 char const * const func = "omp_set_nest_lock"; \
786 if ( ( sizeof ( kmp_tas_lock_t ) <= OMP_NEST_LOCK_T_SIZE ) \
787 && lck->tas.lk.depth_locked == -1 ) { \
788 KMP_FATAL( LockSimpleUsedAsNestable, func ); \
791 if ( lck->tas.lk.poll - 1 == gtid ) { \
792 lck->tas.lk.depth_locked += 1; \
794 if ( ( lck->tas.lk.poll != 0 ) || \
795 ( ! KMP_COMPARE_AND_STORE_ACQ32( &(lck->tas.lk.poll), 0, gtid + 1 ) ) ) { \
797 KMP_FSYNC_PREPARE( lck ); \
798 KMP_INIT_YIELD( spins ); \
799 if ( TCR_4(__kmp_nth) > (__kmp_avail_proc ? __kmp_avail_proc : __kmp_xproc) ) { \
802 KMP_YIELD_SPIN( spins ); \
804 while ( ( lck->tas.lk.poll != 0 ) || \
805 ( ! KMP_COMPARE_AND_STORE_ACQ32( &(lck->tas.lk.poll), 0, gtid + 1 ) ) ) { \
806 if ( TCR_4(__kmp_nth) > (__kmp_avail_proc ? __kmp_avail_proc : __kmp_xproc) ) { \
809 KMP_YIELD_SPIN( spins ); \
813 lck->tas.lk.depth_locked = 1; \
815 KMP_FSYNC_ACQUIRED( lck ); \
817 KMP_DEBUG_ASSERT( __kmp_acquire_nested_user_lock_with_checks_ != NULL ); \
818 ( *__kmp_acquire_nested_user_lock_with_checks_ )( lck, gtid ); \
823 __kmp_acquire_nested_user_lock_with_checks( kmp_user_lock_p lck, kmp_int32 gtid )
825 KMP_DEBUG_ASSERT( __kmp_acquire_nested_user_lock_with_checks_ != NULL );
826 ( *__kmp_acquire_nested_user_lock_with_checks_ )( lck, gtid );
830 extern int ( *__kmp_test_nested_user_lock_with_checks_ )( kmp_user_lock_p lck, kmp_int32 gtid );
832 #if KMP_OS_LINUX && (KMP_ARCH_X86 || KMP_ARCH_X86_64)
834 __kmp_test_nested_user_lock_with_checks( kmp_user_lock_p lck, kmp_int32 gtid )
836 if ( __kmp_user_lock_kind == lk_tas ) {
838 if ( __kmp_env_consistency_check ) {
839 char const *
const func =
"omp_test_nest_lock";
840 if ( (
sizeof ( kmp_tas_lock_t ) <= OMP_NEST_LOCK_T_SIZE )
841 && lck->tas.lk.depth_locked == -1 ) {
842 KMP_FATAL( LockSimpleUsedAsNestable, func );
845 KMP_DEBUG_ASSERT( gtid >= 0 );
846 if ( lck->tas.lk.poll - 1 == gtid ) {
847 return ++lck->tas.lk.depth_locked;
849 retval = ( ( lck->tas.lk.poll == 0 ) &&
850 KMP_COMPARE_AND_STORE_ACQ32( &(lck->tas.lk.poll), 0, gtid + 1 ) );
853 lck->tas.lk.depth_locked = 1;
857 KMP_DEBUG_ASSERT( __kmp_test_nested_user_lock_with_checks_ != NULL );
858 return ( *__kmp_test_nested_user_lock_with_checks_ )( lck, gtid );
863 __kmp_test_nested_user_lock_with_checks( kmp_user_lock_p lck, kmp_int32 gtid )
865 KMP_DEBUG_ASSERT( __kmp_test_nested_user_lock_with_checks_ != NULL );
866 return ( *__kmp_test_nested_user_lock_with_checks_ )( lck, gtid );
870 extern void ( *__kmp_release_nested_user_lock_with_checks_ )( kmp_user_lock_p lck, kmp_int32 gtid );
873 __kmp_release_nested_user_lock_with_checks( kmp_user_lock_p lck, kmp_int32 gtid )
875 KMP_DEBUG_ASSERT( __kmp_release_nested_user_lock_with_checks_ != NULL );
876 ( *__kmp_release_nested_user_lock_with_checks_ )( lck, gtid );
879 extern void ( *__kmp_init_nested_user_lock_with_checks_ )( kmp_user_lock_p lck );
881 static inline void __kmp_init_nested_user_lock_with_checks( kmp_user_lock_p lck )
883 KMP_DEBUG_ASSERT( __kmp_init_nested_user_lock_with_checks_ != NULL );
884 ( *__kmp_init_nested_user_lock_with_checks_ )( lck );
887 extern void ( *__kmp_destroy_nested_user_lock_with_checks_ )( kmp_user_lock_p lck );
890 __kmp_destroy_nested_user_lock_with_checks( kmp_user_lock_p lck )
892 KMP_DEBUG_ASSERT( __kmp_destroy_nested_user_lock_with_checks_ != NULL );
893 ( *__kmp_destroy_nested_user_lock_with_checks_ )( lck );
911 extern int ( *__kmp_is_user_lock_initialized_ )( kmp_user_lock_p lck );
915 extern const ident_t * ( *__kmp_get_user_lock_location_ )( kmp_user_lock_p lck );
918 __kmp_get_user_lock_location( kmp_user_lock_p lck )
920 if ( __kmp_get_user_lock_location_ != NULL ) {
921 return ( *__kmp_get_user_lock_location_ )( lck );
928 extern void ( *__kmp_set_user_lock_location_ )( kmp_user_lock_p lck,
const ident_t *loc );
931 __kmp_set_user_lock_location( kmp_user_lock_p lck,
const ident_t *loc )
933 if ( __kmp_set_user_lock_location_ != NULL ) {
934 ( *__kmp_set_user_lock_location_ )( lck, loc );
938 extern kmp_lock_flags_t ( *__kmp_get_user_lock_flags_ )( kmp_user_lock_p lck );
940 extern void ( *__kmp_set_user_lock_flags_ )( kmp_user_lock_p lck, kmp_lock_flags_t flags );
943 __kmp_set_user_lock_flags( kmp_user_lock_p lck, kmp_lock_flags_t flags )
945 if ( __kmp_set_user_lock_flags_ != NULL ) {
946 ( *__kmp_set_user_lock_flags_ )( lck, flags );
953 extern void __kmp_set_user_lock_vptrs( kmp_lock_kind_t user_lock_kind );
958 #define KMP_BIND_USER_LOCK_TEMPLATE(nest, kind, suffix) { \
959 __kmp_acquire##nest##user_lock_with_checks_ = ( void (*)( kmp_user_lock_p, kmp_int32 ) ) \
960 __kmp_acquire##nest##kind##_##suffix; \
961 __kmp_release##nest##user_lock_with_checks_ = ( void (*)( kmp_user_lock_p, kmp_int32 ) ) \
962 __kmp_release##nest##kind##_##suffix; \
963 __kmp_test##nest##user_lock_with_checks_ = ( int (*)( kmp_user_lock_p, kmp_int32 ) ) \
964 __kmp_test##nest##kind##_##suffix; \
965 __kmp_init##nest##user_lock_with_checks_ = ( void (*)( kmp_user_lock_p ) ) \
966 __kmp_init##nest##kind##_##suffix; \
967 __kmp_destroy##nest##user_lock_with_checks_ = ( void (*)( kmp_user_lock_p ) ) \
968 __kmp_destroy##nest##kind##_##suffix; \
971 #define KMP_BIND_USER_LOCK(kind) KMP_BIND_USER_LOCK_TEMPLATE(_, kind, lock)
972 #define KMP_BIND_USER_LOCK_WITH_CHECKS(kind) KMP_BIND_USER_LOCK_TEMPLATE(_, kind, lock_with_checks)
973 #define KMP_BIND_NESTED_USER_LOCK(kind) KMP_BIND_USER_LOCK_TEMPLATE(_nested_, kind, lock)
974 #define KMP_BIND_NESTED_USER_LOCK_WITH_CHECKS(kind) KMP_BIND_USER_LOCK_TEMPLATE(_nested_, kind, lock_with_checks)
1002 struct kmp_lock_table {
1003 kmp_lock_index_t used;
1004 kmp_lock_index_t allocated;
1005 kmp_user_lock_p * table;
1008 typedef struct kmp_lock_table kmp_lock_table_t;
1010 extern kmp_lock_table_t __kmp_user_lock_table;
1011 extern kmp_user_lock_p __kmp_lock_pool;
1013 struct kmp_block_of_locks {
1014 struct kmp_block_of_locks * next_block;
1018 typedef struct kmp_block_of_locks kmp_block_of_locks_t;
1020 extern kmp_block_of_locks_t *__kmp_lock_blocks;
1021 extern int __kmp_num_locks_in_block;
1023 extern kmp_user_lock_p __kmp_user_lock_allocate(
void **user_lock, kmp_int32 gtid, kmp_lock_flags_t flags );
1024 extern void __kmp_user_lock_free(
void **user_lock, kmp_int32 gtid, kmp_user_lock_p lck );
1025 extern kmp_user_lock_p __kmp_lookup_user_lock(
void **user_lock,
char const *func );
1026 extern void __kmp_cleanup_user_locks();
1028 #define KMP_CHECK_USER_LOCK_INIT() \
1030 if ( ! TCR_4( __kmp_init_user_locks ) ) { \
1031 __kmp_acquire_bootstrap_lock( &__kmp_initz_lock ); \
1032 if ( ! TCR_4( __kmp_init_user_locks ) ) { \
1033 TCW_4( __kmp_init_user_locks, TRUE ); \
1035 __kmp_release_bootstrap_lock( &__kmp_initz_lock ); \
1039 #endif // KMP_USE_DYNAMIC_LOCK
1044 #if KMP_USE_DYNAMIC_LOCK
1046 #define DYNA_HAS_FUTEX (KMP_OS_LINUX && (KMP_ARCH_X86 || KMP_ARCH_X86_64 || KMP_ARCH_ARM))
1047 #define DYNA_HAS_HLE (KMP_ARCH_X86 || KMP_ARCH_X86_64 || KMP_MIC)
1048 #define DYNA_USE_FAST_FUTEX 0 && DYNA_HAS_FUTEX
1049 #define DYNA_USE_FAST_TAS 1 && DYNA_HAS_FUTEX
1056 # define FOREACH_D_LOCK(m, a) m(tas, a) m(futex, a) m(hle, a)
1057 # define DYNA_LAST_D_LOCK_SEQ lockseq_hle
1059 # define FOREACH_D_LOCK(m, a) m(tas, a) m(futex, a)
1060 # define DYNA_LAST_D_LOCK_SEQ lockseq_futex
1061 # endif // DYNA_HAS_HLE
1062 # if KMP_USE_ADAPTIVE_LOCKS
1063 # define FOREACH_I_LOCK(m, a) m(ticket, a) m(queuing, a) m(adaptive, a) m(drdpa, a) \
1064 m(nested_tas, a) m(nested_futex, a) m(nested_ticket, a) \
1065 m(nested_queuing, a) m(nested_drdpa, a)
1067 # define FOREACH_I_LOCK(m, a) m(ticket, a) m(queuing, a) m(drdpa, a) \
1068 m(nested_tas, a) m(nested_futex, a) m(nested_ticket, a) \
1069 m(nested_queuing, a) m(nested_drdpa, a)
1070 # endif // KMP_USE_ADAPTIVE_LOCKS
1073 # define FOREACH_D_LOCK(m, a) m(tas, a) m(hle, a)
1074 # define DYNA_LAST_D_LOCK_SEQ lockseq_hle
1076 # define FOREACH_D_LOCK(m, a) m(tas, a)
1077 # define DYNA_LAST_D_LOCK_SEQ lockseq_tas
1078 # endif // DYNA_HAS_HLE
1079 # if KMP_USE_ADAPTIVE_LOCKS
1080 # define FOREACH_I_LOCK(m, a) m(ticket, a) m(queuing, a) m(adaptive, a) m(drdpa, a) \
1081 m(nested_tas, a) m(nested_ticket, a) \
1082 m(nested_queuing, a) m(nested_drdpa, a)
1084 # define FOREACH_I_LOCK(m, a) m(ticket, a) m(queuing, a) m(drdpa, a) \
1085 m(nested_tas, a) m(nested_ticket, a) \
1086 m(nested_queuing, a) m(nested_drdpa, a)
1087 # endif // KMP_USE_ADAPTIVE_LOCKS
1088 #endif // DYNA_HAS_FUTEX
1091 #define DYNA_LOCK_VALUE_SHIFT 8
1092 #define DYNA_LOCK_TYPE_MASK ((1<<DYNA_LOCK_VALUE_SHIFT)-1)
1093 #define DYNA_NUM_D_LOCKS DYNA_LAST_D_LOCK_SEQ
1094 #define DYNA_NUM_I_LOCKS (locktag_nested_drdpa+1)
1097 typedef kmp_uint32 kmp_dyna_lock_t;
1102 lockseq_indirect = 0,
1103 #define expand_seq(l,a) lockseq_##l,
1104 FOREACH_D_LOCK(expand_seq, 0)
1105 FOREACH_I_LOCK(expand_seq, 0)
1107 } kmp_dyna_lockseq_t;
1111 #define expand_tag(l,a) locktag_##l,
1112 FOREACH_I_LOCK(expand_tag, 0)
1114 } kmp_indirect_locktag_t;
1117 #define DYNA_IS_D_LOCK(seq) (seq >= lockseq_tas && seq <= DYNA_LAST_D_LOCK_SEQ)
1118 #define DYNA_IS_I_LOCK(seq) (seq >= lockseq_ticket && seq <= lockseq_nested_drdpa)
1119 #define DYNA_GET_I_TAG(seq) (kmp_indirect_locktag_t)(seq - lockseq_ticket)
1120 #define DYNA_GET_D_TAG(seq) (seq<<1 | 1)
1124 #define expand_tag(l,a) locktag_##l = DYNA_GET_D_TAG(lockseq_##l),
1125 FOREACH_D_LOCK(expand_tag, 0)
1127 } kmp_direct_locktag_t;
1131 kmp_user_lock_p lock;
1132 kmp_indirect_locktag_t type;
1133 } kmp_indirect_lock_t;
1136 extern void (*__kmp_direct_init_ops[])(kmp_dyna_lock_t *, kmp_dyna_lockseq_t);
1137 extern void (*__kmp_direct_destroy_ops[])(kmp_dyna_lock_t *);
1138 extern void (*(*__kmp_direct_set_ops))(kmp_dyna_lock_t *, kmp_int32);
1139 extern void (*(*__kmp_direct_unset_ops))(kmp_dyna_lock_t *, kmp_int32);
1140 extern int (*(*__kmp_direct_test_ops))(kmp_dyna_lock_t *, kmp_int32);
1143 extern void (*__kmp_indirect_init_ops[])(kmp_user_lock_p);
1144 extern void (*__kmp_indirect_destroy_ops[])(kmp_user_lock_p);
1145 extern void (*(*__kmp_indirect_set_ops))(kmp_user_lock_p, kmp_int32);
1146 extern void (*(*__kmp_indirect_unset_ops))(kmp_user_lock_p, kmp_int32);
1147 extern int (*(*__kmp_indirect_test_ops))(kmp_user_lock_p, kmp_int32);
1150 #define DYNA_EXTRACT_D_TAG(l) (*((kmp_dyna_lock_t *)(l)) & DYNA_LOCK_TYPE_MASK & -(*((kmp_dyna_lock_t *)(l)) & 1))
1153 #define DYNA_EXTRACT_I_INDEX(l) (*(kmp_lock_index_t *)(l) >> 1)
1156 #define DYNA_D_LOCK_FUNC(l, op) __kmp_direct_##op##_ops[DYNA_EXTRACT_D_TAG(l)]
1159 #define DYNA_I_LOCK_FUNC(l, op) __kmp_indirect_##op##_ops[((kmp_indirect_lock_t *)(l))->type]
1162 #define DYNA_INIT_D_LOCK(l, seq) __kmp_direct_init_ops[DYNA_GET_D_TAG(seq)]((kmp_dyna_lock_t *)l, seq)
1165 #define DYNA_INIT_I_LOCK(l, seq) __kmp_direct_init_ops[0]((kmp_dyna_lock_t *)(l), seq)
1168 #define DYNA_LOCK_FREE(type) (locktag_##type)
1171 #define DYNA_LOCK_BUSY(v, type) ((v)<<DYNA_LOCK_VALUE_SHIFT | locktag_##type)
1174 #define DYNA_LOCK_STRIP(v) ((v)>>DYNA_LOCK_VALUE_SHIFT)
1177 #define DYNA_STORE_LOCK_SEQ(type) (__kmp_user_lock_seq = lockseq_##type)
1180 extern void __kmp_init_lock_hinted(
void **,
int);
1181 extern void __kmp_init_nest_lock_hinted(
void **,
int);
1184 extern void __kmp_init_dynamic_user_locks();
1187 extern kmp_indirect_lock_t * __kmp_allocate_indirect_lock(
void **, kmp_int32, kmp_indirect_locktag_t);
1190 extern void __kmp_cleanup_indirect_user_locks();
1193 extern kmp_dyna_lockseq_t __kmp_user_lock_seq;
1196 extern void (*__kmp_indirect_set_location[DYNA_NUM_I_LOCKS])(kmp_user_lock_p,
const ident_t *);
1197 #define DYNA_SET_I_LOCK_LOCATION(lck, loc) { \
1198 if (__kmp_indirect_set_location[(lck)->type] != NULL) \
1199 __kmp_indirect_set_location[(lck)->type]((lck)->lock, loc); \
1203 extern void (*__kmp_indirect_set_flags[DYNA_NUM_I_LOCKS])(kmp_user_lock_p, kmp_lock_flags_t);
1204 #define DYNA_SET_I_LOCK_FLAGS(lck, flag) { \
1205 if (__kmp_indirect_set_flags[(lck)->type] != NULL) \
1206 __kmp_indirect_set_flags[(lck)->type]((lck)->lock, flag); \
1210 extern const ident_t * (*__kmp_indirect_get_location[DYNA_NUM_I_LOCKS])(kmp_user_lock_p);
1211 #define DYNA_GET_I_LOCK_LOCATION(lck) ( __kmp_indirect_get_location[(lck)->type] != NULL \
1212 ? __kmp_indirect_get_location[(lck)->type]((lck)->lock) \
1216 extern kmp_lock_flags_t (*__kmp_indirect_get_flags[DYNA_NUM_I_LOCKS])(kmp_user_lock_p);
1217 #define DYNA_GET_I_LOCK_FLAGS(lck) ( __kmp_indirect_get_flags[(lck)->type] != NULL \
1218 ? __kmp_indirect_get_flags[(lck)->type]((lck)->lock) \
1225 extern kmp_indirect_lock_t **__kmp_indirect_lock_table;
1227 extern kmp_lock_index_t __kmp_indirect_lock_table_size;
1229 extern kmp_lock_index_t __kmp_indirect_lock_table_next;
1233 extern int __kmp_num_locks_in_block;
1236 #define DYNA_LOOKUP_I_LOCK(l) ( (OMP_LOCK_T_SIZE < sizeof(void *)) \
1237 ? __kmp_indirect_lock_table[DYNA_EXTRACT_I_INDEX(l)] \
1238 : *((kmp_indirect_lock_t **)l) )
1242 __kmp_get_user_lock_owner(kmp_user_lock_p, kmp_uint32);
1244 #else // KMP_USE_DYNAMIC_LOCK
1246 # define DYNA_LOCK_BUSY(v, type) (v)
1247 # define DYNA_LOCK_FREE(type) 0
1248 # define DYNA_LOCK_STRIP(v) (v)
1249 # define DYNA_STORE_LOCK_SEQ(seq)
1251 #endif // KMP_USE_DYNAMIC_LOCK
1255 #endif // __cplusplus