-
Notifications
You must be signed in to change notification settings - Fork 392
/
omrthread.c
5831 lines (5060 loc) · 164 KB
/
omrthread.c
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*******************************************************************************
* Copyright (c) 1991, 2021 IBM Corp. and others
*
* This program and the accompanying materials are made available under
* the terms of the Eclipse Public License 2.0 which accompanies this
* distribution and is available at https://www.eclipse.org/legal/epl-2.0/
* or the Apache License, Version 2.0 which accompanies this distribution and
* is available at https://www.apache.org/licenses/LICENSE-2.0.
*
* This Source Code may also be made available under the following
* Secondary Licenses when the conditions for such availability set
* forth in the Eclipse Public License, v. 2.0 are satisfied: GNU
* General Public License, version 2 with the GNU Classpath
* Exception [1] and GNU General Public License, version 2 with the
* OpenJDK Assembly Exception [2].
*
* [1] https://www.gnu.org/software/classpath/license.html
* [2] http://openjdk.java.net/legal/assembly-exception.html
*
* SPDX-License-Identifier: EPL-2.0 OR Apache-2.0 OR GPL-2.0 WITH Classpath-exception-2.0 OR LicenseRef-GPL-2.0 WITH Assembly-exception
*******************************************************************************/
/**
* @file
* @ingroup Thread
* @brief Threading and synchronization support
*/
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include "omrcfg.h"
#include "omrthread.h"
#include "threaddef.h"
#include "omrthreadattr.h"
#include "omrutilbase.h"
#include "ut_j9thr.h"
#include "thread_internal.h"
static void omrthread_shutdown(void);
static omrthread_t threadAllocate(omrthread_library_t lib, int globalIsLocked);
static intptr_t threadCreate(omrthread_t *handle, const omrthread_attr_t *attr, uintptr_t suspend, omrthread_entrypoint_t entrypoint, void *entryarg, int globalIsLocked);
static intptr_t threadDestroy(omrthread_t thread, int globalAlreadyLocked);
static void threadFree(omrthread_t thread, int globalAlreadyLocked);
static WRAPPER_TYPE thread_wrapper(WRAPPER_ARG arg);
static void OMRNORETURN threadInternalExit(int globalAlreadyLocked);
static void threadEnqueue(omrthread_t *queue, omrthread_t thread);
static void threadDequeue(omrthread_t volatile *queue, omrthread_t thread);
static omrthread_monitor_pool_t allocate_monitor_pool(omrthread_library_t lib);
static void free_monitor_pools(void);
static intptr_t init_global_monitor(omrthread_library_t lib);
static omrthread_monitor_t monitor_allocate(omrthread_t self, intptr_t policy, intptr_t policyData);
static intptr_t monitor_alloc_and_init(omrthread_monitor_t *handle, uintptr_t flags, intptr_t policy, intptr_t policyData, const char *name);
static intptr_t monitor_init(omrthread_monitor_t monitor, uintptr_t flags, omrthread_library_t lib, const char *name);
static void monitor_free(omrthread_library_t lib, omrthread_monitor_t monitor);
static void monitor_free_nolock(omrthread_library_t lib, omrthread_t thread, omrthread_monitor_t monitor);
#if !defined(OMR_THR_THREE_TIER_LOCKING)
static intptr_t monitor_enter(omrthread_t self, omrthread_monitor_t monitor);
#endif /* !defined(OMR_THR_THREE_TIER_LOCKING) */
static intptr_t monitor_exit(omrthread_t self, omrthread_monitor_t monitor);
static intptr_t monitor_wait(omrthread_monitor_t monitor, int64_t millis, intptr_t nanos, uintptr_t interruptible);
static intptr_t monitor_notify_one_or_all(omrthread_monitor_t monitor, int notifyall);
#if defined(OMR_THR_THREE_TIER_LOCKING)
static intptr_t monitor_enter_three_tier(omrthread_t self, omrthread_monitor_t monitor, BOOLEAN isAbortable);
static intptr_t monitor_wait_three_tier(omrthread_t self, omrthread_monitor_t monitor, int64_t millis, intptr_t nanos, uintptr_t interruptible);
static intptr_t monitor_notify_three_tier(omrthread_t self, omrthread_monitor_t monitor, int notifyall);
#endif /* OMR_THR_THREE_TIER_LOCKING */
static intptr_t monitor_wait_original(omrthread_t self, omrthread_monitor_t monitor, int64_t millis, intptr_t nanos, uintptr_t interruptible);
static intptr_t monitor_notify_original(omrthread_t self, omrthread_monitor_t monitor, int notifyall);
#if defined(OMR_THR_THREE_TIER_LOCKING)
static intptr_t init_spinCounts(omrthread_library_t lib);
#if !defined(OMR_THR_MCS_LOCKS)
static void unblock_spinlock_threads(omrthread_t self, omrthread_monitor_t monitor);
#endif /* !defined(OMR_THR_MCS_LOCKS) */
#endif /* OMR_THR_THREE_TIER_LOCKING */
static intptr_t init_threadParam(char *name, uintptr_t *pDefault);
static intptr_t init_spinParameters(omrthread_library_t lib);
static void threadInterrupt(omrthread_t thread, uintptr_t interruptFlag);
static void threadInterruptWake(omrthread_t thread, omrthread_monitor_t monitor);
static void threadNotify(omrthread_t threadToNotify);
static int32_t J9THREAD_PROC interruptServer(void *entryArg);
static intptr_t interrupt_waiting_thread(omrthread_t self, omrthread_t threadToInterrupt);
#if defined(OMR_THR_THREE_TIER_LOCKING)
static void interrupt_blocked_thread(omrthread_t self, omrthread_t threadToInterrupt);
#endif /* OMR_THR_THREE_TIER_LOCKING */
static intptr_t check_notified(omrthread_t self, omrthread_monitor_t monitor);
static uintptr_t monitor_maximum_wait_number(omrthread_monitor_t monitor);
static uintptr_t monitor_on_notify_all_wait_list(omrthread_t self, omrthread_monitor_t monitor);
static void monitor_notify_all_migration(omrthread_monitor_t monitor);
static intptr_t failedToSetAttr(intptr_t rc);
#if defined(OSX)
static intptr_t copyAttr(omrthread_attr_t *attrTo, const omrthread_attr_t *attrFrom);
#endif /* defined(OSX) */
static intptr_t fixupThreadAccounting(omrthread_t thread, uintptr_t type);
static void storeExitCpuUsage(omrthread_t thread);
static BOOLEAN fillInEmptyMemCategorySlot(const OMRMemCategorySet *const categorySet, OMRMemCategory *const category,
const uint32_t startIndex, uint32_t *const filledSlotIndex);
static void threadEnableCpuMonitor(omrthread_t thread);
#if defined(OMR_THR_FORK_SUPPORT)
static void postForkResetThreads(omrthread_t self);
static void postForkResetLib(omrthread_t self);
static void postForkResetMonitors(omrthread_t self);
static void postForkResetRWMutexes(omrthread_t self);
#if defined(OMR_THR_MCS_LOCKS)
static void preserveMCSNodesInForkSurvivor(omrthread_t forkSurvivorThread);
#endif /* defined(OMR_THR_MCS_LOCKS) */
#endif /* defined(OMR_THR_FORK_SUPPORT) */
#if defined(OMR_THR_MCS_LOCKS)
static omrthread_mcs_nodes_t allocate_mcs_nodes(omrthread_library_t lib);
static void free_mcs_nodes(omrthread_library_t lib, omrthread_mcs_nodes_t mcsNodes);
#endif /* defined(OMR_THR_MCS_LOCKS) */
#ifdef THREAD_ASSERTS
/**
* Helper variable for asserts.
* We use this to keep track of when the global lock is owned.
* We don't want to do a re-entrant enter on the global lock
*/
omrthread_t global_lock_owner = UNOWNED;
#endif /* THREAD_ASSERTS */
#ifdef OMR_THR_THREE_TIER_LOCKING
#define ASSERT_MONITOR_UNOWNED_IF_NOT_3TIER(monitor) do {} while (0)
#else
#define ASSERT_MONITOR_UNOWNED_IF_NOT_3TIER(monitor) \
do { \
ASSERT(NULL == (monitor)->owner); \
ASSERT(0 == (monitor)->count); \
} while (0)
#endif
#ifdef OMR_ENV_DATA64
#if defined(AIXPPC)
/* See CMVC 87602 - Problems on AIX 5.2 with very long wait times */
#define BOUNDED_I64_TO_IDATA(longValue) ((longValue) > 0x7FFFFFFFLL ? (intptr_t)0x7FFFFFFF : (intptr_t)(longValue))
#else /* AIXPPC */
#define BOUNDED_I64_TO_IDATA(longValue) ((intptr_t)longValue)
#endif /* AIXPPC */
#else /* OMR_ENV_DATA64 */
#define BOUNDED_I64_TO_IDATA(longValue) ((longValue) > 0x7FFFFFFF ? 0x7FFFFFFF : (intptr_t)(longValue))
#endif /* OMR_ENV_DATA64 */
#define USE_CLOCK_NANOSLEEP 0
#ifndef ADJUST_TIMEOUT
#define ADJUST_TIMEOUT(millis, nanos) \
(((nanos) && ((millis) != ((intptr_t) (((uintptr_t)-1) >> 1)))) ? \
((millis) + 1) : (millis))
#endif
#define MONITOR_WAIT_CONDITION(thread, monitor) (thread)->condition
/*
* Useful J9THREAD_FLAG_xxx masks
*/
#define J9THREAD_FLAGM_BLOCKED_ABORTABLE (J9THREAD_FLAG_BLOCKED | J9THREAD_FLAG_ABORTABLE)
#define J9THREAD_FLAGM_SLEEPING_TIMED (J9THREAD_FLAG_SLEEPING | J9THREAD_FLAG_TIMER_SET)
#define J9THREAD_FLAGM_SLEEPING_TIMED_INTERRUPTIBLE (J9THREAD_FLAGM_SLEEPING_TIMED | J9THREAD_FLAG_INTERRUPTABLE)
#define J9THREAD_FLAGM_PARKED_INTERRUPTIBLE (J9THREAD_FLAG_PARKED | J9THREAD_FLAG_INTERRUPTABLE)
#define J9THR_WAIT_INTERRUPTED(flags) (((flags) & J9THREAD_FLAG_INTERRUPTED) != 0)
#define J9THR_WAIT_PRI_INTERRUPTED(flags) (((flags) & (J9THREAD_FLAG_PRIORITY_INTERRUPTED | J9THREAD_FLAG_ABORTED)) != 0)
#if defined(OMR_OS_WINDOWS) || !defined(OMR_NOTIFY_POLICY_CONTROL)
#define NOTIFY_WRAPPER(thread) OMROSCOND_NOTIFY_ALL((thread)->condition);
#else /* defined(OMR_OS_WINDOWS) || !defined(OMR_NOTIFY_POLICY_CONTROL) */
#define NOTIFY_WRAPPER(thread) \
do { \
if (OMR_ARE_ALL_BITS_SET((thread)->library->flags, J9THREAD_LIB_FLAG_NOTIFY_POLICY_BROADCAST)) { \
OMROSCOND_NOTIFY_ALL((thread)->condition); \
} else { \
OMROSCOND_NOTIFY((thread)->condition); \
} \
} while (0)
#endif /* defined(OMR_OS_WINDOWS) || !defined(OMR_NOTIFY_POLICY_CONTROL) */
/*
* Thread Library
*/
#if !defined(OMR_OS_WINDOWS)
/**
* pthread TLS key destructor for self_ptr
*
* This will be called if the current pthread exits before it has been detached
* from the thread library with omrthread_detach.
*
* Up to a maximum of OMR_MAX_KEY_DELETION_ATTEMPTS times, the TLS key will be
* restored to allow other key destructors to run and use the thread library.
*
* Once the maximum number of attempts have been made, the key will no longer be
* restored and the behaviour of any remaining key destructors that attempt to use
* the thread library is undefined.
*
* @param[in] current_omr_thread the previous value of the TLS slot - the current omrthread_t
*/
#define OMR_MAX_KEY_DELETION_ATTEMPTS 10
static void
self_key_destructor(void *current_omr_thread)
{
omrthread_t omrthread = current_omr_thread;
uintptr_t attempts = omrthread->key_deletion_attempts;
if (attempts < OMR_MAX_KEY_DELETION_ATTEMPTS) {
omrthread->key_deletion_attempts = attempts + 1;
TLS_SET(((omrthread_library_t)GLOBAL_DATA(default_library))->self_ptr, current_omr_thread);
}
}
#undef OMR_MAX_KEY_DELETION_ATTEMPTS
#endif /* !defined(OMR_OS_WINDOWS) */
/**
* Initialize a J9 threading library.
*
* @note This must only be called once.
*
* If any OS threads were created before calling this function, they must be attached using
* omrthread_attach before accessing any J9 thread library functions.
*
* @param[in] lib pointer to the J9 thread library to be initialized (non-NULL)
* @return The J9 thread library's initStatus will be set to 0 on success or
* a negative value on failure.
*
* @see omrthread_attach, omrthread_shutdown
*/
void
omrthread_init(omrthread_library_t lib)
{
ASSERT(lib);
lib->spinlock = 0;
lib->threadCount = 0;
lib->globals = NULL;
#if defined(OMR_OS_WINDOWS)
lib->stack_usage = 0;
#endif /* defined(OMR_OS_WINDOWS) */
lib->flags = 0;
omrthread_mem_init(lib);
/* set all TLS finalizers to NULL. This indicates that the key is unused */
memset(lib->tls_finalizers, 0, sizeof(lib->tls_finalizers));
#if !(CALLER_LAST_INDEX <= MAX_CALLER_INDEX)
#error "CALLER_LAST_INDEX must be <= MAX_CALLER_INDEX"
#endif
#if defined(OMR_OS_WINDOWS)
if (TLS_ALLOC(lib->self_ptr))
#else /* defined(OMR_OS_WINDOWS) */
if (TLS_ALLOC_WITH_DESTRUCTOR(lib->self_ptr, self_key_destructor))
#endif /* defined(OMR_OS_WINDOWS) */
{
goto init_cleanup1;
}
lib->monitor_pool = allocate_monitor_pool(lib);
if (lib->monitor_pool == NULL) {
goto init_cleanup2;
}
#if defined(OMR_THR_FORK_SUPPORT)
lib->rwmutexPool = omrthread_rwmutex_init_pool(lib);
if (lib->rwmutexPool == NULL) {
goto init_cleanup3;
}
#endif /* defined(OMR_THR_FORK_SUPPORT) */
if (!OMROSMUTEX_INIT(lib->monitor_mutex)) {
goto init_cleanup4;
}
if (!OMROSMUTEX_INIT(lib->tls_mutex)) {
goto init_cleanup5;
}
if (!OMROSMUTEX_INIT(lib->global_mutex)) {
goto init_cleanup6;
}
if (!OMROSMUTEX_INIT(lib->resourceUsageMutex)) {
goto init_cleanup7;
}
lib->threadWalkMutexesHeld = 0;
lib->thread_pool = pool_new(sizeof(J9Thread), 0, 0, 0, OMR_GET_CALLSITE(), OMRMEM_CATEGORY_THREADS, omrthread_mallocWrapper, omrthread_freeWrapper, lib);
if (lib->thread_pool == NULL) {
goto init_cleanup8;
}
lib->global_pool = pool_new(sizeof(J9ThreadGlobal), 0, 0, 0, OMR_GET_CALLSITE(), OMRMEM_CATEGORY_THREADS, omrthread_mallocWrapper, omrthread_freeWrapper, lib);
if (lib->global_pool == NULL) {
goto init_cleanup9;
}
if (init_spinParameters(lib)) {
goto init_cleanup10;
}
if (init_global_monitor(lib)) {
goto init_cleanup10;
}
#ifdef OMR_THR_JLM
lib->monitor_tracing_pool = NULL;
lib->thread_tracing_pool = NULL;
lib->gc_lock_tracing = NULL;
#endif
#if defined(OMR_OS_WINDOWS)
lib->flags |= J9THREAD_LIB_FLAG_DESTROY_MUTEX_ON_MONITOR_FREE;
#endif /* defined(OMR_OS_WINDOWS) */
if (omrthread_attr_init(&lib->systemThreadAttr) != J9THREAD_SUCCESS) {
goto init_cleanup10;
}
#if defined(OSX)
if (KERN_SUCCESS != host_get_clock_service(mach_host_self(), SYSTEM_CLOCK, &lib->clockService)) {
goto init_cleanup11;
}
#endif /* defined(OSX) */
#if defined(OMR_PORT_NUMA_SUPPORT)
/* Load the numa library from the dll */
omrthread_numa_init(lib);
#endif /* OMR_PORT_NUMA_SUPPORT */
memset(&lib->cumulativeThreadsInfo, 0, sizeof(lib->cumulativeThreadsInfo));
lib->initStatus = 1;
return;
#if defined(OSX)
/* Unused cleanup label for future error handling. */
/* init_cleanup12: mach_port_deallocate(mach_task_self(), lib->clockService); */
init_cleanup11: omrthread_attr_destroy(&lib->systemThreadAttr);
#endif /* defined(OSX) */
init_cleanup10: pool_kill(lib->global_pool);
init_cleanup9: pool_kill(lib->thread_pool);
init_cleanup8: OMROSMUTEX_DESTROY(lib->resourceUsageMutex);
init_cleanup7: OMROSMUTEX_DESTROY(lib->global_mutex);
init_cleanup6: OMROSMUTEX_DESTROY(lib->tls_mutex);
init_cleanup5: OMROSMUTEX_DESTROY(lib->monitor_mutex);
#if defined(OMR_THR_FORK_SUPPORT)
init_cleanup4: pool_kill(lib->rwmutexPool);
init_cleanup3: free_monitor_pools();
#else /* defined(OMR_THR_FORK_SUPPORT) */
init_cleanup4: free_monitor_pools();
#endif /* defined(OMR_THR_FORK_SUPPORT) */
init_cleanup2: TLS_DESTROY(lib->self_ptr);
init_cleanup1: lib->initStatus = -1;
}
/**
* Look for an empty NULL slot in a J9MemoryCategorySet, and add a new category into it.
*
* @param[in] categorySet A J9MemoryCategorySet. Must be non-NULL.
* @param[in] category The category to add to categorySet. Must be non-NULL.
* @param[in] startIndex The first category slot to start searching from.
* @param[out] filledSlotIndex If found, the empty slot where the new category is added. Must be non-NULL.
* @return TRUE if an empty slot is found, FALSE if no empty slot is found.
*/
static BOOLEAN
fillInEmptyMemCategorySlot(const OMRMemCategorySet *const categorySet, OMRMemCategory *const category,
const uint32_t startIndex, uint32_t *const filledSlotIndex)
{
BOOLEAN foundEmptySlot = FALSE;
uint32_t i = 0;
for (i = startIndex; i < categorySet->numberOfCategories; i++) {
if (NULL == categorySet->categories[i]) {
categorySet->categories[i] = category;
*filledSlotIndex = i;
foundEmptySlot = TRUE;
break;
}
}
return foundEmptySlot;
}
intptr_t
omrthread_lib_control(const char *key, uintptr_t value)
{
intptr_t rc = -1;
if (0 != value) {
#if defined(OMR_RAS_TDF_TRACE)
/* return value of 0 is success */
if (0 == strcmp(J9THREAD_LIB_CONTROL_TRACE_START, key)) {
UtInterface *utIntf = (UtInterface *)value;
UT_MODULE_LOADED(utIntf);
Trc_THR_VMInitStages_Event1(NULL);
omrthread_lib_set_flags(J9THREAD_LIB_FLAG_TRACING_ENABLED);
rc = 0;
} else if (0 == strcmp(J9THREAD_LIB_CONTROL_TRACE_STOP, key)) {
UtInterface *utIntf = (UtInterface *)value;
utIntf->module->TraceTerm(NULL, &UT_MODULE_INFO);
rc = 0;
}
#endif
if (0 == strcmp(J9THREAD_LIB_CONTROL_GET_MEM_CATEGORIES, key)) {
omrthread_library_t lib = GLOBAL_DATA(default_library);
OMRMemCategorySet *categorySet = (OMRMemCategorySet *)value;
uint32_t filledSlotIndex = 0;
/* We can drop categories into any blank slot. The port library will
* reorganise them when they are properly registered.
*/
if (fillInEmptyMemCategorySlot(categorySet, &lib->threadLibraryCategory, 0, &filledSlotIndex)) {
if (fillInEmptyMemCategorySlot(categorySet, &lib->nativeStackCategory, filledSlotIndex + 1, &filledSlotIndex)) {
#if defined(OMR_THR_FORK_SUPPORT)
if (fillInEmptyMemCategorySlot(categorySet, &lib->mutexCategory, filledSlotIndex + 1, &filledSlotIndex)) {
if (fillInEmptyMemCategorySlot(categorySet, &lib->condvarCategory, filledSlotIndex + 1, &filledSlotIndex)) {
rc = 0;
}
}
#else /* defined(OMR_THR_FORK_SUPPORT) */
rc = 0;
#endif /* defined(OMR_THR_FORK_SUPPORT) */
}
}
}
}
#if defined(LINUX) || defined(OSX)
if (0 == strcmp(J9THREAD_LIB_CONTROL_USE_REALTIME_SCHEDULING, key)) {
if ((J9THREAD_LIB_CONTROL_USE_REALTIME_SCHEDULING_DISABLED == value)
|| (J9THREAD_LIB_CONTROL_USE_REALTIME_SCHEDULING_ENABLED == value)
) {
omrthread_library_t lib = GLOBAL_DATA(default_library);
if (value != (lib->flags & J9THREAD_LIB_FLAG_REALTIME_SCHEDULING_ENABLED)) {
pool_state state;
omrthread_t walkThread = NULL;
if (J9THREAD_LIB_CONTROL_USE_REALTIME_SCHEDULING_ENABLED == value) {
omrthread_lib_set_flags(J9THREAD_LIB_FLAG_REALTIME_SCHEDULING_ENABLED);
} else {
omrthread_lib_clear_flags(J9THREAD_LIB_FLAG_REALTIME_SCHEDULING_ENABLED);
}
/* re-initialize the priority map */
rc = initialize_priority_map();
GLOBAL_LOCK_SIMPLE(lib);
/* Walk the list of omrthread's and make them use the
* new priority map by resetting their priorities.
*/
walkThread = pool_startDo(lib->thread_pool, &state);
while ((0 == rc) && (NULL != walkThread)) {
omrthread_prio_t priority = walkThread->priority;
/* the omrthread_prio_t will be mapped to a different native priority */
rc = omrthread_set_priority(walkThread, priority);
walkThread = pool_nextDo(&state);
}
GLOBAL_UNLOCK_SIMPLE(lib);
} else {
/* no need to do anything if the value hasn't changed */
rc = 0;
}
}
}
#endif /* defined(LINUX) || defined(OSX) */
return rc;
}
BOOLEAN
omrthread_lib_use_realtime_scheduling(void)
{
#if defined(LINUX) || defined(OSX)
omrthread_library_t lib = GLOBAL_DATA(default_library);
return OMR_ARE_ALL_BITS_SET(lib->flags, J9THREAD_LIB_FLAG_REALTIME_SCHEDULING_ENABLED);
#else /* defined(LINUX) || defined(OSX) */
return FALSE;
#endif /* defined(LINUX) || defined(OSX) */
}
/**
* Initialize the mutex used to synchronize access
* to thread library global data.
*
* @param[in] lib pointer to the thread library
* @return 0 on success or negative value on failure
*
*/
static intptr_t
init_global_monitor(omrthread_library_t lib)
{
omrthread_monitor_pool_t pool = lib->monitor_pool;
omrthread_monitor_t monitor = pool->next_free;
static char name[] = "Thread global";
ASSERT(monitor);
pool->next_free = (omrthread_monitor_t)monitor->owner;
if (monitor_init(monitor, 0, lib, name) != 0) {
return -1;
}
if (!OMROSMUTEX_INIT(monitor->mutex)) {
return -1;
}
lib->globalMonitor = monitor;
return 0;
}
/**
* Initialize one thread parameter
* make it accessible to the outside world via the
* omrthread globals.
*
*/
static intptr_t
init_threadParam(char *name, uintptr_t *pDefault)
{
uintptr_t *p;
ASSERT(name);
ASSERT(pDefault);
p = omrthread_global(name);
if (NULL == p) {
return -1;
}
ASSERT(0 == *p);
*p = (uintptr_t)pDefault;
return 0;
}
#if (defined(OMR_THR_THREE_TIER_LOCKING))
/**
* Initialize default spin counts and make them
* accessible to the outside world via the
* omrthread globals.
*
* Must be called after globals are initialized
*
* These numbers are taken from the GC spinlock.
*
* N.B. Every spinCount must be > 0!
*
* @param[in] lib omrthread library
* @see omrthread_init, omrthread_global, omrthread_spinlock_acquire
*
*/
static intptr_t
init_spinCounts(omrthread_library_t lib)
{
ASSERT(lib);
lib->defaultMonitorSpinCount1 = 256;
lib->defaultMonitorSpinCount2 = 32;
#if defined(J9ZOS390)
/*
* z/OS has exponentially increasing yield times
* if you call it back to back within a short period
* of time.
*/
lib->defaultMonitorSpinCount3 = 1;
#else
lib->defaultMonitorSpinCount3 = 45;
#endif
/* Set up the globals so anyone can change the counts */
if (init_threadParam("defaultMonitorSpinCount1", &lib->defaultMonitorSpinCount1)) {
return -1;
}
if (init_threadParam("defaultMonitorSpinCount2", &lib->defaultMonitorSpinCount2)) {
return -1;
}
if (init_threadParam("defaultMonitorSpinCount3", &lib->defaultMonitorSpinCount3)) {
return -1;
}
ASSERT(lib->defaultMonitorSpinCount1 != 0);
ASSERT(lib->defaultMonitorSpinCount2 != 0);
ASSERT(lib->defaultMonitorSpinCount3 != 0);
return 0;
}
#endif /* OMR_THR_THREE_TIER_LOCKING */
/**
* Initialize spin parameters
*
* Must be called after globals are initialized
*
* These numbers are taken from the GC spinlock.
*
* N.B. Every spinCount must be > 0!
*
* @param[in] lib omrthread library
* @see omrthread_init, omrthread_global, omrthread_spinlock_acquire
*
*/
static intptr_t
init_spinParameters(omrthread_library_t lib)
{
ASSERT(lib);
#if defined(OMR_THR_ADAPTIVE_SPIN)
lib->adaptSpinHoldtime = 0;
if (init_threadParam("adaptSpinHoldtime", &lib->adaptSpinHoldtime)) {
return -1;
}
lib->adaptSpinSlowPercent = 0;
if (init_threadParam("adaptSpinSlowPercent", &lib->adaptSpinSlowPercent)) {
return -1;
}
lib->adaptSpinSampleThreshold = 0;
if (init_threadParam("adaptSpinSampleThreshold", &lib->adaptSpinSampleThreshold)) {
return -1;
}
lib->adaptSpinSampleStopCount = 0;
if (init_threadParam("adaptSpinSampleStopCount", &lib->adaptSpinSampleStopCount)) {
return -1;
}
lib->adaptSpinSampleCountStopRatio = 0;
if (init_threadParam("adaptSpinSampleCountStopRatio", &lib->adaptSpinSampleCountStopRatio)) {
return -1;
}
#endif
#if (defined(OMR_THR_YIELD_ALG))
lib->yieldAlgorithm = 0;
if (init_threadParam("yieldAlgorithm", &lib->yieldAlgorithm)) {
return -1;
}
lib->yieldUsleepMultiplier = 0;
if (init_threadParam("yieldUsleepMultiplier", &lib->yieldUsleepMultiplier)) {
return -1;
}
#endif
#if defined(OMR_THR_THREE_TIER_LOCKING)
#if defined(OMR_THR_SPIN_WAKE_CONTROL)
lib->maxSpinThreads = OMRTHREAD_MINIMUM_SPIN_THREADS;
if (init_threadParam("maxSpinThreads", &lib->maxSpinThreads)) {
return -1;
}
lib->maxWakeThreads = OMRTHREAD_MINIMUM_WAKE_THREADS;
if (init_threadParam("maxWakeThreads", &lib->maxWakeThreads)) {
return -1;
}
#endif /* defined(OMR_THR_SPIN_WAKE_CONTROL) */
return init_spinCounts(lib);
#else
return 0;
#endif
}
/**
* Shut down the J9 threading library associated with the current thread.
*
* @return none
*
* @see omrthread_init
*/
static void
omrthread_shutdown(void)
{
omrthread_library_t lib = GLOBAL_DATA(default_library);
ASSERT(lib);
/* Acquire the global lock here to wait until all outstanding omrthread_exit calls
* have completed. omrthread_exit holds the global lock until the thread is ready
* to exit to the OS.
*/
GLOBAL_LOCK_SIMPLE(lib);
GLOBAL_UNLOCK_SIMPLE(lib);
#if defined(OMR_PORT_NUMA_SUPPORT)
omrthread_numa_shutdown(lib);
#endif /* OMR_PORT_NUMA_SUPPORT */
omrthread_attr_destroy(&lib->systemThreadAttr);
OMROSMUTEX_DESTROY(lib->tls_mutex);
OMROSMUTEX_DESTROY(lib->monitor_mutex);
OMROSMUTEX_DESTROY(lib->global_mutex);
OMROSMUTEX_DESTROY(lib->resourceUsageMutex);
pool_kill(lib->global_pool);
lib->global_pool = 0;
free_monitor_pools();
TLS_DESTROY(lib->self_ptr);
pool_kill(lib->thread_pool);
lib->thread_pool = 0;
#if defined(OMR_THR_FORK_SUPPORT)
pool_kill(lib->rwmutexPool);
#endif /* defined(OMR_THR_FORK_SUPPORT) */
#if defined(OSX)
mach_port_deallocate(mach_task_self(), lib->clockService);
#endif /* defined(OSX) */
}
/**
* Acquire the threading library's global lock.
*
* @note This must not be called recursively by a thread that already owns the global lock.
* @param[in] self omrthread_t for the current thread
* @return none
*
* @see omrthread_lib_unlock
*/
void
omrthread_lib_lock(omrthread_t self)
{
ASSERT(self);
GLOBAL_LOCK(self, CALLER_GLOBAL_LOCK);
}
/**
* Attempt to enter the threading library's global lock without blocking.
*
* @param[in] self omrthread_t for the current thread
* @return zero on success, non-zero on failure
*/
intptr_t
omrthread_lib_try_lock(omrthread_t self)
{
#ifdef THREAD_ASSERTS
intptr_t retVal;
ASSERT(self);
retVal = GLOBAL_TRY_LOCK(self, CALLER_GLOBAL_LOCK);
if (retVal == 0) {
ASSERT(UNOWNED == global_lock_owner);
global_lock_owner = self;
}
return retVal;
#else
ASSERT(self);
return GLOBAL_TRY_LOCK(self, CALLER_GLOBAL_LOCK);
#endif
}
/**
* Release the threading library's global lock.
*
* @note This must be called only by the thread that currently has the global lock locked.
* @param[in] self omrthread_t for the current thread
* @return none
*
* @see omrthread_lib_lock
*/
void
omrthread_lib_unlock(omrthread_t self)
{
ASSERT(self);
GLOBAL_UNLOCK(self);
}
#if defined(OMR_THR_FORK_SUPPORT)
void
omrthread_lib_preFork(void)
{
omrthread_t self = MACRO_SELF();
omrthread_library_t lib = NULL;
if (NULL == self) {
fprintf(stderr, "Can't acquire locks from an unattached thread.\n");
abort();
}
lib = self->library;
OMROSMUTEX_ENTER(lib->monitor_mutex);
OMROSMUTEX_ENTER(lib->tls_mutex);
OMROSMUTEX_ENTER(lib->global_mutex);
OMROSMUTEX_ENTER(lib->resourceUsageMutex);
}
void
omrthread_lib_postForkParent(void)
{
omrthread_t self = MACRO_SELF();
omrthread_library_t lib = NULL;
if (NULL == self) {
fprintf(stderr, "Can't release locks from an unattached thread.\n");
abort();
}
lib = self->library;
OMROSMUTEX_EXIT(lib->resourceUsageMutex);
OMROSMUTEX_EXIT(lib->global_mutex);
OMROSMUTEX_EXIT(lib->tls_mutex);
OMROSMUTEX_EXIT(lib->monitor_mutex);
}
void
omrthread_lib_postForkChild(void)
{
omrthread_t self = MACRO_SELF();
omrthread_library_t lib = NULL;
if (NULL == self) {
fprintf(stderr, "Can't release locks from an unattached thread.\n");
abort();
}
lib = self->library;
postForkResetLib(self);
postForkResetMonitors(self);
postForkResetThreads(self);
postForkResetRWMutexes(self);
OMROSMUTEX_EXIT(lib->resourceUsageMutex);
OMROSMUTEX_EXIT(lib->global_mutex);
OMROSMUTEX_EXIT(lib->tls_mutex);
OMROSMUTEX_EXIT(lib->monitor_mutex);
}
/**
* To reset the omrthread's, destroy their mutexes and conds. For the fork survivor thread,
* fix the tid and handle and recreate the mutex and cond. Otherwise, free J9Thread.tracing,
* flush the destroyed monitor lists back into the pool, and tls_finalize() the tls.
*
* Note that the thread mutex and cond are reallocated and initialized without freeing the
* old ones, since if it allocates the same piece of memory, it fails with mutex already
* initialized.
*
* @pre There is a pre-condition that the monitors have been reset first with postForkResetMonitors
* in order for omrthread_tls_finalize to use mutexes. A user-provided tls_finalize callback
* may fail post-fork if it uses mutexes/cond vars the thread library does not know about.
* In case it uses omrthread_monitors, they must be reset first.
*/
static void
postForkResetThreads(omrthread_t self)
{
omrthread_library_t lib = self->library;
omrthread_t threadIterator = NULL;
J9PoolState threadPoolState;
#if defined(OMR_THR_MCS_LOCKS)
preserveMCSNodesInForkSurvivor(self);
#endif /* defined(OMR_THR_MCS_LOCKS) */
threadIterator = (omrthread_t)pool_startDo(lib->thread_pool, &threadPoolState);
while (NULL != threadIterator) {
if (threadIterator == self) {
/* cond/mutex reinitialized without freeing the old one. */
OMROSCOND_INIT(threadIterator->condition);
OMROSMUTEX_INIT(threadIterator->mutex);
threadIterator->tid = omrthread_get_ras_tid();
#if defined(OMR_OS_WINDOWS)
#error "The implementation of postForkResetThreads() is not complete in WIN32."
#endif /* defined(OMR_OS_WINDOWS) */
threadIterator->handle = THREAD_SELF();
} else {
omrthread_tls_finalizeNoLock(threadIterator);
#if defined(OMR_THR_MCS_LOCKS)
/* For all threads other than the fork survivor thread, the stack head and J9Pool,
* which is stored in J9Thread->mcsNodes, should be reset. This is part of
* resetting the monitors. This step is performed in postForkResetThreads instead
* of postForkResetMonitors because mcsNodes is the property of a thread. Thus, it
* is easier to process in postForkResetThreads.
*/
threadIterator->mcsNodes->stackHead = NULL;
pool_clear(threadIterator->mcsNodes->pool);
#endif /* defined(OMR_THR_MCS_LOCKS) */
/* Flush the thread local list of destroyed monitors of the thread that no longer exists to the global list. */
if (NULL != threadIterator->destroyed_monitor_head) {
threadIterator->destroyed_monitor_tail->owner = (omrthread_t)lib->monitor_pool->next_free;
lib->monitor_pool->next_free = threadIterator->destroyed_monitor_head;
}
/* Free the thread. */
threadFree(threadIterator, GLOBAL_IS_LOCKED);
}
threadIterator = (omrthread_t)pool_nextDo(&threadPoolState);
}
}
/**
* Reset the omrthread_library's mutexes, the global lock owner, and the dead threads info.
*/
static void
postForkResetLib(omrthread_t self)
{
omrthread_library_t lib = self->library;
memset(&lib->cumulativeThreadsInfo, 0, sizeof(lib->cumulativeThreadsInfo));
#ifdef THREAD_ASSERTS
if (self != global_lock_owner) {
global_lock_owner = NULL;
}
#endif /* THREAD_ASSERTS */
}
/**
* For each monitor in the pool, destroy and reinit the mutex if it is allocated,
* clear the waiting, blocking, and notifyAll thread list (with an assert if its the
* fork survivor), set the owner to null if it is not the fork survivor, and reset
* the spinLockState. If its not owned by the fork survivor, reset the owner,
* pinCount, and sampleCounter as well.
*
* Note that the mutex is reallocated and initialized without freeing the old ones,
* since if it allocates the same piece of memory, it fails with mutex already
* initialized.
*/
static void
postForkResetMonitors(omrthread_t self)
{
omrthread_library_t lib = self->library;
omrthread_monitor_pool_t threadMonitorPool = NULL;
threadMonitorPool = lib->monitor_pool;
while (NULL != threadMonitorPool) {
uintptr_t i;
omrthread_monitor_t entry = &threadMonitorPool->entries[0];
for (i = 0; i < MONITOR_POOL_SIZE - 1; i++, entry++) {
if (entry->flags != J9THREAD_MONITOR_MUTEX_UNINITIALIZED) {
OMROSMUTEX_INIT(entry->mutex);
}
if (FREE_TAG != entry->count) {
if (self != entry->owner) {
entry->owner = NULL;
#if defined(OMR_THR_ADAPTIVE_SPIN)
entry->sampleCounter = 0;
#endif /* defined(OMR_THR_ADAPTIVE_SPIN) */
entry->pinCount = 0;
#if defined(OMR_THR_THREE_TIER_LOCKING)
entry->spinlockState = J9THREAD_MONITOR_SPINLOCK_UNOWNED;
#if defined(OMR_THR_MCS_LOCKS)
entry->queueTail = NULL;
#endif /* defined(OMR_THR_MCS_LOCKS) */
#if defined(OMR_THR_SPIN_WAKE_CONTROL)
entry->spinThreads = 0;
#endif /* defined(OMR_THR_SPIN_WAKE_CONTROL) */
#endif /* defined(OMR_THR_THREE_TIER_LOCKING) */
} else {
#if defined(OMR_THR_THREE_TIER_LOCKING)
#if defined(OMR_THR_MCS_LOCKS)
/* Refer to preserveMCSNodesInForkSurvivor, which is invoked from postForkResetThreads.
* It is used to preserve the state of the MCS locks and nodes (monitors), which are
* owned by the fork survivor thread.
*/
entry->spinlockState = J9THREAD_MONITOR_SPINLOCK_OWNED;
#else /* defined(OMR_THR_MCS_LOCKS) */
if (J9THREAD_MONITOR_SPINLOCK_EXCEEDED == entry->spinlockState) {
entry->spinlockState = J9THREAD_MONITOR_SPINLOCK_OWNED;
}
#endif /* defined(OMR_THR_MCS_LOCKS) */
#endif /* defined(OMR_THR_THREE_TIER_LOCKING) */
}
#if defined(THREAD_ASSERTS)
{
omrthread_t threadIterator = NULL;
#if defined(OMR_THR_THREE_TIER_LOCKING)
threadIterator = entry->blocking;
while (NULL != threadIterator) {
ASSERT(threadIterator != self);
threadIterator = threadIterator->next;
}
#endif /* defined(OMR_THR_THREE_TIER_LOCKING) */
threadIterator = entry->waiting;
while (NULL != threadIterator) {
ASSERT(threadIterator != self);
threadIterator = threadIterator->next;
}
threadIterator = entry->notifyAllWaiting;
while (NULL != threadIterator) {
ASSERT(threadIterator != self);
threadIterator = threadIterator->next;
}
}