summaryrefslogtreecommitdiffstats
path: root/src/H5TS.c
blob: 72d158ff4da4adcb5fa28f31cb31e12a1a6d35c0 (plain)
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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
 * Copyright by The HDF Group.                                               *
 * Copyright by the Board of Trustees of the University of Illinois.         *
 * All rights reserved.                                                      *
 *                                                                           *
 * This file is part of HDF5.  The full HDF5 copyright notice, including     *
 * terms governing use, modification, and redistribution, is contained in    *
 * the COPYING file, which can be found at the root of the source code       *
 * distribution tree, or in https://www.hdfgroup.org/licenses.               *
 * If you do not have access to either file, you may request a copy from     *
 * help@hdfgroup.org.                                                        *
 * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */

/*
 * Purpose: This file contains the framework for ensuring that the global
 *          library lock is held when an API routine is called.  This
 *          framework works in concert with the FUNC_ENTER_API / FUNC_LEAVE_API
 *          macros defined in H5private.h.
 *
 * Note:    Because this threadsafety framework operates outside the library,
 *          it does not use the error stack.
 */

/****************/
/* Module Setup */
/****************/

/***********/
/* Headers */
/***********/
#include "H5private.h"  /* Generic Functions                        */
#include "H5Eprivate.h" /* Error handling                           */

#ifdef H5_HAVE_THREADSAFE

/****************/
/* Local Macros */
/****************/

/******************/
/* Local Typedefs */
/******************/

/* Cancellability structure */
typedef struct H5TS_cancel_struct {
    int          previous_state;
    unsigned int cancel_count;
} H5TS_cancel_t;

#ifndef H5_HAVE_WIN_THREADS
/* An H5TS_tid_t is a record of a thread identifier that is
 * available for reuse.
 */
struct _tid;
typedef struct _tid H5TS_tid_t;

struct _tid {
    H5TS_tid_t *next;
    uint64_t    id;
};
#endif

/********************/
/* Local Prototypes */
/********************/
static void H5TS__key_destructor(void *key_val);
#ifndef H5_HAVE_WIN_THREADS
static void H5TS_tid_destructor(void *_v);
static void H5TS_tid_init(void);
#endif

/*********************/
/* Package Variables */
/*********************/

/*****************************/
/* Library Private Variables */
/*****************************/

/* Global variable definitions */
#ifdef H5_HAVE_WIN_THREADS
H5TS_once_t H5TS_first_init_g;
#else
H5TS_once_t H5TS_first_init_g = PTHREAD_ONCE_INIT;
#endif

/* Thread-local keys, used by other interfaces */

/* Error stack */
H5TS_key_t H5TS_errstk_key_g;

/* Function stack */
#ifdef H5_HAVE_CODESTACK
H5TS_key_t H5TS_funcstk_key_g;
#endif

/* API context */
H5TS_key_t H5TS_apictx_key_g;

/*******************/
/* Local Variables */
/*******************/

/* Thread-local keys, used in this module */
static H5TS_key_t H5TS_cancel_key_s; /* Thread cancellation state */

#ifndef H5_HAVE_WIN_THREADS

/* Pointer to first free thread ID record or NULL. */
static H5TS_tid_t *H5TS_tid_next_free = NULL;
static uint64_t    H5TS_tid_next_id   = 0;

/* Mutual exclusion for access to H5TS_tid_next_free and H5TS_tid_next_id. */
static pthread_mutex_t H5TS_tid_mtx;

/* Key for thread-local storage of the thread ID. */
static H5TS_key_t H5TS_tid_key;

#endif

/*--------------------------------------------------------------------------
 * Function:    H5TS__key_destructor
 *
 * Returns:     void
 *
 * Description:
 *   Frees the memory for a key.  Called by each thread as it exits.
 *   Currently all the thread-specific information for all keys are simple
 *   structures allocated with malloc, so we can free them all uniformly.
 *
 * Programmer:  Quincey Koziol
 *              February 7, 2003
 *--------------------------------------------------------------------------
 */
static void
H5TS__key_destructor(void *key_val)
{
    /* Use HDfree here instead of H5MM_xfree(), to avoid calling the H5CS routines */
    if (key_val != NULL)
        HDfree(key_val);
} /* end H5TS__key_destructor() */

#ifndef H5_HAVE_WIN_THREADS

/*--------------------------------------------------------------------------
 * Function:    H5TS_tid_destructor
 *
 * Returns:     void
 *
 * Description:
 *   When a thread shuts down, put its ID record on the free list.
 *--------------------------------------------------------------------------
 */
static void
H5TS_tid_destructor(void *_v)
{
    H5TS_tid_t *tid = _v;

    if (tid == NULL)
        return;

    /* TBD use an atomic CAS */
    pthread_mutex_lock(&H5TS_tid_mtx);
    tid->next          = H5TS_tid_next_free;
    H5TS_tid_next_free = tid;
    pthread_mutex_unlock(&H5TS_tid_mtx);
}

/*--------------------------------------------------------------------------
 * Function:    H5TS_tid_init
 *
 * Returns:     void
 *
 * Description:
 *   Initialization for integer thread identifiers.
 *--------------------------------------------------------------------------
 */
static void
H5TS_tid_init(void)
{
    pthread_mutex_init(&H5TS_tid_mtx, NULL);
    pthread_key_create(&H5TS_tid_key, H5TS_tid_destructor);
}

#endif

#ifdef H5_HAVE_WIN_THREADS
/*--------------------------------------------------------------------------
 * Function:    H5TS_win32_process_enter
 *
 * Returns:     TRUE on success, FALSE on failure
 *
 * Description:
 *    Per-process setup on Windows when using Win32 threads.
 *
 *--------------------------------------------------------------------------
 */
H5_DLL BOOL CALLBACK
H5TS_win32_process_enter(PINIT_ONCE InitOnce, PVOID Parameter, PVOID *lpContex)
{
    BOOL ret_value = TRUE;

    /* initialize global API mutex lock */
    InitializeCriticalSection(&H5_g.init_lock.CriticalSection);

    /* Set up thread local storage */
    if (TLS_OUT_OF_INDEXES == (H5TS_errstk_key_g = TlsAlloc()))
        ret_value = FALSE;

#ifdef H5_HAVE_CODESTACK
    if (TLS_OUT_OF_INDEXES == (H5TS_funcstk_key_g = TlsAlloc()))
        ret_value = FALSE;
#endif

    if (TLS_OUT_OF_INDEXES == (H5TS_apictx_key_g = TlsAlloc()))
        ret_value = FALSE;

    return ret_value;
} /* H5TS_win32_process_enter() */

/*--------------------------------------------------------------------------
 * Function:    H5TS_win32_thread_enter
 *
 * Returns:     SUCCEED/FAIL
 *
 * Description:
 *    Per-thread setup on Windows when using Win32 threads.
 *
 *--------------------------------------------------------------------------
 */
herr_t
H5TS_win32_thread_enter(void)
{
    herr_t ret_value = SUCCEED;

    /* Currently a placeholder function.  TLS setup is performed
     * elsewhere in the library.
     *
     * WARNING: Do NOT use C standard library functions here.
     * CRT functions are not allowed in DllMain, which is where this code
     * is used.
     */

    return ret_value;
} /* H5TS_win32_thread_enter() */

/*--------------------------------------------------------------------------
 * Function:    H5TS_win32_process_exit
 *
 * Returns:     void
 *
 * Description:
 *    Per-process cleanup on Windows when using Win32 threads.
 *
 *--------------------------------------------------------------------------
 */
void
H5TS_win32_process_exit(void)
{

    /* Windows uses a different thread local storage mechanism which does
     * not support auto-freeing like pthreads' keys.
     *
     * This function is currently registered via atexit() and is called
     * AFTER H5_term_library().
     */

    /* Clean up critical section resources (can't fail) */
    DeleteCriticalSection(&H5_g.init_lock.CriticalSection);

    /* Clean up per-process thread local storage */
    TlsFree(H5TS_errstk_key_g);
#ifdef H5_HAVE_CODESTACK
    TlsFree(H5TS_funcstk_key_g);
#endif
    TlsFree(H5TS_apictx_key_g);

    return;
} /* end H5TS_win32_process_exit() */

/*--------------------------------------------------------------------------
 * Function:    H5TS_win32_thread_exit
 *
 * Returns:     SUCCEED/FAIL
 *
 * Description:
 *    Per-thread cleanup on Windows when using Win32 threads.
 *
 *--------------------------------------------------------------------------
 */
herr_t
H5TS_win32_thread_exit(void)
{
    LPVOID lpvData;
    herr_t ret_value = SUCCEED;

    /* Windows uses a different thread local storage mechanism which does
     * not support auto-freeing like pthreads' keys.
     *
     * WARNING: Do NOT use C standard library functions here.
     * CRT functions are not allowed in DllMain, which is where this code
     * is used.
     */

    /* Clean up per-thread thread local storage */
    lpvData = TlsGetValue(H5TS_errstk_key_g);
    if (lpvData)
        LocalFree((HLOCAL)lpvData);

#ifdef H5_HAVE_CODESTACK
    lpvData = TlsGetValue(H5TS_funcstk_key_g);
    if (lpvData)
        LocalFree((HLOCAL)lpvData);
#endif

    lpvData = TlsGetValue(H5TS_apictx_key_g);
    if (lpvData)
        LocalFree((HLOCAL)lpvData);

    return ret_value;
} /* end H5TS_win32_thread_exit() */

#endif /* H5_HAVE_WIN_THREADS */

#ifndef H5_HAVE_WIN_THREADS

/*--------------------------------------------------------------------------
 * Function:    H5TS_thread_id
 *
 * Returns:     An integer identifier for the current thread
 *
 * Description:
 *   The ID satisfies the following properties:
 *
 *   1 1 <= ID <= UINT64_MAX
 *   2 ID is constant over the thread's lifetime.
 *   3 No two threads share an ID during their lifetimes.
 *   4 A thread's ID is available for reuse as soon as it is joined.
 *
 *   ID 0 is reserved.  H5TS_thread_id() returns 0 if the library was not
 *   built with thread safety or if an error prevents it from assigning an
 *   ID.
 *
 *--------------------------------------------------------------------------
 */
uint64_t
H5TS_thread_id(void)
{
    H5TS_tid_t *tid = pthread_getspecific(H5TS_tid_key);
    H5TS_tid_t  proto_tid;

    /* An ID is already assigned. */
    if (tid != NULL)
        return tid->id;

    /* An ID is *not* already assigned: reuse an ID that's on the
     * free list, or else generate a new ID.
     *
     * Allocating memory while holding a mutex is bad form, so
     * point `tid` at `proto_tid` if we need to allocate some
     * memory.
     */
    pthread_mutex_lock(&H5TS_tid_mtx);
    if ((tid = H5TS_tid_next_free) != NULL)
        H5TS_tid_next_free = tid->next;
    else if (H5TS_tid_next_id != UINT64_MAX) {
        tid     = &proto_tid;
        tid->id = ++H5TS_tid_next_id;
    }
    pthread_mutex_unlock(&H5TS_tid_mtx);

    /* If a prototype ID record was established, copy it to the heap. */
    if (tid == &proto_tid)
        if ((tid = HDmalloc(sizeof(*tid))) != NULL)
            *tid = proto_tid;

    if (tid == NULL)
        return 0;

    /* Finish initializing the ID record and set a thread-local pointer
     * to it.
     */
    tid->next = NULL;
    if (pthread_setspecific(H5TS_tid_key, tid) != 0) {
        H5TS_tid_destructor(tid);
        return 0;
    }

    return tid->id;
}

/*--------------------------------------------------------------------------
 * Function:    H5TS_pthread_first_thread_init
 *
 * Returns:     void
 *
 * Description:
 *   Initialization of global API lock, keys for per-thread error stacks and
 *   cancallability information. Called by the first thread that enters the
 *   library.
 *
 * Programmer: Chee Wai LEE
 *             May 2, 2000
 *
 *--------------------------------------------------------------------------
 */
void
H5TS_pthread_first_thread_init(void)
{
    H5_g.H5_libinit_g = FALSE; /* Library hasn't been initialized */
    H5_g.H5_libterm_g = FALSE; /* Library isn't being shutdown */

#ifdef H5_HAVE_WIN32_API
#ifdef PTW32_STATIC_LIB
    pthread_win32_process_attach_np();
#endif
#endif

    /* initialize global API mutex lock */
#ifdef H5_USE_RECURSIVE_WRITER_LOCKS
    H5TS_rw_lock_init(&H5_g.init_rw_lock, H5TS_RW_LOCK_POLICY_FAVOR_WRITERS);
#else
    pthread_mutex_init(&H5_g.init_lock.atomic_lock, NULL);
    pthread_cond_init(&H5_g.init_lock.cond_var, NULL);
    H5_g.init_lock.lock_count = 0;
#endif

    /* Initialize integer thread identifiers. */
    H5TS_tid_init();

    /* initialize key for thread-specific error stacks */
    pthread_key_create(&H5TS_errstk_key_g, H5TS__key_destructor);

#ifdef H5_HAVE_CODESTACK
    /* initialize key for thread-specific function stacks */
    pthread_key_create(&H5TS_funcstk_key_g, H5TS__key_destructor);
#endif

    /* initialize key for thread-specific API contexts */
    pthread_key_create(&H5TS_apictx_key_g, H5TS__key_destructor);

    /* initialize key for thread cancellability mechanism */
    pthread_key_create(&H5TS_cancel_key_s, H5TS__key_destructor);

} /* end H5TS_pthread_first_thread_init() */

#endif /* H5_HAVE_WIN_THREADS */

/*--------------------------------------------------------------------------
 * Function:    H5TS_mutex_lock
 *
 *
 * Returns:     SUCCEED/FAIL
 *
 * Description:
 *    Recursive lock semantics for HDF5 (locking) -
 *    Multiple acquisition of a lock by a thread is permitted with a
 *    corresponding unlock operation required.
 *
 * Programmer: Chee Wai LEE
 *             May 2, 2000
 *
 *--------------------------------------------------------------------------
 */
herr_t
H5TS_mutex_lock(H5TS_mutex_t *mutex)
{
    herr_t ret_value = SUCCEED;

#ifdef H5_HAVE_WIN_THREADS
    EnterCriticalSection(&mutex->CriticalSection);
#else
    /* Acquire the library lock */
    if (pthread_mutex_lock(&mutex->atomic_lock) != 0)
        return FAIL;

    /* Check if this thread already owns the lock */
    if (mutex->lock_count && pthread_equal(pthread_self(), mutex->owner_thread))
        /* already owned by self - increment count */
        mutex->lock_count++;
    else {
        /* Wait until the lock is released by current owner thread */
        while (mutex->lock_count)
            pthread_cond_wait(&mutex->cond_var, &mutex->atomic_lock);

        /* After we've received the signal, take ownership of the mutex */
        mutex->owner_thread = pthread_self();
        mutex->lock_count   = 1;
    } /* end else */

    /* Release the library lock */
    if (pthread_mutex_unlock(&mutex->atomic_lock) != 0)
        ret_value = FAIL;
#endif

    return ret_value;
} /* end H5TS_mutex_lock() */

/*--------------------------------------------------------------------------
 * Function:    H5TS_mutex_unlock
 *
 * Returns:     SUCCEED/FAIL
 *
 * Description:
 *    Recursive lock semantics for HDF5 (unlocking) -
 *    Multiple acquisition of a lock by a thread is permitted with a
 *    corresponding unlock operation required.
 *
 * Programmer: Chee Wai LEE
 *             May 2, 2000
 *
 *--------------------------------------------------------------------------
 */
herr_t
H5TS_mutex_unlock(H5TS_mutex_t *mutex)
{
    herr_t ret_value = SUCCEED;

#ifdef H5_HAVE_WIN_THREADS
    /* Releases ownership of the specified critical section object. */
    LeaveCriticalSection(&mutex->CriticalSection);
#else

    /* Decrement the lock count for this thread */
    if (pthread_mutex_lock(&mutex->atomic_lock) != 0)
        return FAIL;
    mutex->lock_count--;
    if (pthread_mutex_unlock(&mutex->atomic_lock) != 0)
        ret_value = FAIL;

    /* If the lock count drops to zero, signal the condition variable, to
     * wake another thread.
     */
    if (mutex->lock_count == 0)
        if (pthread_cond_signal(&mutex->cond_var) != 0)
            ret_value = FAIL;
#endif /* H5_HAVE_WIN_THREADS */

    return ret_value;
} /* H5TS_mutex_unlock */

/*--------------------------------------------------------------------------
 * Function:    H5TS_cancel_count_inc
 *
 * Returns:     SUCCEED/FAIL
 *
 * Description:
 *    Creates a cancellation counter for a thread if it is the first time
 *    the thread is entering the library.
 *
 *    if counter value is zero, then set cancellability type of the thread
 *    to PTHREAD_CANCEL_DISABLE as thread is entering the library and store
 *    the previous cancellability type into cancellation counter.
 *
 *    Increase the counter value by 1.
 *
 * Programmer: Chee Wai LEE
 *            May 2, 2000
 *
 *--------------------------------------------------------------------------
 */
herr_t
H5TS_cancel_count_inc(void)
{
    herr_t ret_value = SUCCEED;

#ifndef H5_HAVE_WIN_THREADS
    H5TS_cancel_t *cancel_counter;

    /* Acquire the thread's cancellation counter */
    cancel_counter = (H5TS_cancel_t *)H5TS_get_thread_local_value(H5TS_cancel_key_s);

    /* Check if it's created yet */
    if (!cancel_counter) {
        /*
         * First time thread calls library - create new counter and associate
         * with key.
         *
         * Don't use H5MM calls here since the destructor has to use HDfree in
         * order to avoid codestack calls.
         */
        cancel_counter = HDcalloc(1, sizeof(*cancel_counter));
        if (NULL == cancel_counter) {
            HERROR(H5E_RESOURCE, H5E_NOSPACE, "memory allocation failed");
            return FAIL;
        }

        /* Set the thread's cancellation counter with the new object */
        if (pthread_setspecific(H5TS_cancel_key_s, (void *)cancel_counter) != 0) {
            HDfree(cancel_counter);
            return FAIL;
        }
    }

    /* Check if thread entering library */
    if (cancel_counter->cancel_count == 0)
        /* Set cancellation state to 'disable', and remember previous state */
        if (pthread_setcancelstate(PTHREAD_CANCEL_DISABLE, &cancel_counter->previous_state) != 0)
            ret_value = FAIL;

    /* Increment # of times the library API was re-entered, to avoid resetting
     * previous cancellation state until the final API routine is returning.
     */
    ++cancel_counter->cancel_count;
#endif /* H5_HAVE_WIN_THREADS */

    return ret_value;
} /* end H5TS_cancel_count_inc() */

/*--------------------------------------------------------------------------
 * Function:    H5TS_cancel_count_dec
 *
 * Returns:     SUCCEED/FAIL
 *
 * Description:
 *    If counter value is one, then set cancellability type of the thread
 *    to the previous cancellability type stored in the cancellation counter.
 *    (the thread is leaving the library).
 *
 *    Decrement the counter value by 1.
 *
 * Programmer: Chee Wai LEE
 *             May 2, 2000
 *
 *--------------------------------------------------------------------------
 */
herr_t
H5TS_cancel_count_dec(void)
{
    herr_t ret_value = SUCCEED;

#ifndef H5_HAVE_WIN_THREADS
    H5TS_cancel_t *cancel_counter;

    /* Acquire the thread's cancellation counter */
    cancel_counter = (H5TS_cancel_t *)H5TS_get_thread_local_value(H5TS_cancel_key_s);

    /* Check for leaving last API routine */
    if (cancel_counter->cancel_count == 1)
        /* Reset to previous thread cancellation state, if last API */
        if (pthread_setcancelstate(cancel_counter->previous_state, NULL) != 0)
            ret_value = FAIL;

    /* Decrement cancellation counter */
    --cancel_counter->cancel_count;
#endif /* H5_HAVE_WIN_THREADS */

    return ret_value;
} /* end H5TS_cancel_count_dec() */

#ifdef H5_USE_RECURSIVE_WRITER_LOCKS

/*--------------------------------------------------------------------------
 * Function:    H5TS_alloc_rec_entry_count
 *
 * Returns:
 *    Pointer to allocated and initialized instance of
 *    H5TS_rec_entry_count, or NULL on failure.
 *
 * Description:
 *    Allocate and initialize an instance of H5TS_rec_entry_count.
 *
 * Programmer:  John Mainzer
 *              August 28, 2020
 *
 *--------------------------------------------------------------------------
 */
H5TS_rec_entry_count *
H5TS_alloc_rec_entry_count(hbool_t write_lock)
{
    H5TS_rec_entry_count *ret_value = NULL;

    ret_value = HDmalloc(sizeof(*ret_value));

    if (ret_value) {

        ret_value->magic          = H5TS_RW_ENTRY_COUNT_MAGIC;
        ret_value->write_lock     = write_lock;
        ret_value->rec_lock_count = 1;
    }

    return ret_value;

} /* end H5TS_alloc_rec_entry_count() */

/*--------------------------------------------------------------------------
 * Function:    H5TS_free_rec_entry_count
 *
 * Returns:     void
 *
 * Description:
 *    Frees the supplied instance of H5TS_rec_entry_count.
 *
 * Programmer:  John Mainzer
 *              August 28, 2020
 *
 *--------------------------------------------------------------------------
 */
void
H5TS_free_rec_entry_count(void *target)
{
    H5TS_rec_entry_count *count;

    count = (H5TS_rec_entry_count *)target;

    HDassert(count);
    HDassert(count->magic == H5TS_RW_ENTRY_COUNT_MAGIC);

    count->magic = 0;

    HDfree(count);

    return;

} /* end H5TS_free_rec_entry_count() */

/*--------------------------------------------------------------------------
 * Function:    H5TS_rw_lock_init
 *
 * Returns:     SUCCEED/FAIL
 *
 * Description:
 *    Initialize the supplied instance of H5TS_rw_lock_t.
 *
 * Programmer:  John Mainzer
 *              August 28, 2020
 *
 *--------------------------------------------------------------------------
 */
herr_t
H5TS_rw_lock_init(H5TS_rw_lock_t *rw_lock, int policy)
{
    herr_t ret_value = SUCCEED;

    /* Sanity checks -- until other policies are implemented,
     * policy must equal H5TS_RW_LOCK_POLICY_FAVOR_WRITERS.
     */
    if ((rw_lock == NULL) || (policy != H5TS_RW_LOCK_POLICY_FAVOR_WRITERS)) {

        ret_value = FAIL;
    }

    /* NOTE: Win32 thread init functions tend to have a return type of void while
     *        Pthreads return an int. We've gone with the lowest common denominator
     *        here, but we're going to have to better abstract this in the future.
     */

    /* Initialize the mutex */
    if (ret_value == SUCCEED)
        if (H5TS_mutex_init(&(rw_lock->mutex)) != 0)
            ret_value = FAIL;

    /* Initialize the waiting readers cv */
    if (ret_value == SUCCEED)
        if (H5TS_cond_init(&(rw_lock->readers_cv)) != 0)
            ret_value = FAIL;

    /* Initialize the waiting writers cv */
    if (ret_value == SUCCEED)
        if (H5TS_cond_init(&(rw_lock->writers_cv)) != 0)
            ret_value = FAIL;

    /* Initialize the counts key */
    if (ret_value == SUCCEED)
        if (pthread_key_create(&(rw_lock->rec_entry_count_key), H5TS_free_rec_entry_count) != 0)
            ret_value = FAIL;

    if (ret_value == SUCCEED) {

        /* Initialize scalar fields */

        rw_lock->magic                                = H5TS_RW_LOCK_MAGIC;
        rw_lock->policy                               = policy;
        rw_lock->waiting_readers_count                = 0;
        rw_lock->waiting_writers_count                = 0;
        rw_lock->active_readers                       = 0;
        rw_lock->active_writers                       = 0;
        rw_lock->stats.read_locks_granted             = 0;
        rw_lock->stats.read_locks_released            = 0;
        rw_lock->stats.real_read_locks_granted        = 0;
        rw_lock->stats.real_read_locks_released       = 0;
        rw_lock->stats.max_read_locks                 = 0;
        rw_lock->stats.max_read_lock_recursion_depth  = 0;
        rw_lock->stats.read_locks_delayed             = 0;
        rw_lock->stats.max_read_locks_pending         = 0;
        rw_lock->stats.write_locks_granted            = 0;
        rw_lock->stats.write_locks_released           = 0;
        rw_lock->stats.real_write_locks_granted       = 0;
        rw_lock->stats.real_write_locks_released      = 0;
        rw_lock->stats.max_write_locks                = 0;
        rw_lock->stats.max_write_lock_recursion_depth = 0;
        rw_lock->stats.write_locks_delayed            = 0;
        rw_lock->stats.max_write_locks_pending        = 0;
    }

    return ret_value;

} /* end H5TS_rw_lock_init() */

/*--------------------------------------------------------------------------
 * Function:    H5TS_rw_lock_destroy
 *
 * Returns:     SUCCEED/FAIL
 *
 * Description:
 *    Take down an instance of H5TS_rw_lock_t.  All mutex, condition
 *    variables, and keys are destroyed, and magic is set to an invalid
 *    value.  However, the instance of H5TS_rw_lock_t is not
 *    freed.
 *
 * Programmer:  John Mainzer
 *              August 28, 2020
 *
 *--------------------------------------------------------------------------
 */
herr_t
H5TS_rw_lock_destroy(H5TS_rw_lock_t *rw_lock)
{
    herr_t ret_value = SUCCEED;

    if ((rw_lock == NULL) || (rw_lock->magic != H5TS_RW_LOCK_MAGIC)) {

        ret_value = FAIL;
    }
    else {

        /* We are committed to the destroy at this point.  Set magic
         * to an invalid value, and call the appropriate pthread
         * destroy routines.  Call them all, even if one fails along
         * the way.
         */
        rw_lock->magic = 0;

        if (H5TS_mutex_destroy(&(rw_lock->mutex)) < 0)
            ret_value = FAIL;

        if (H5TS_cond_destroy(&(rw_lock->readers_cv)) < 0)
            ret_value = FAIL;

        if (H5TS_cond_destroy(&(rw_lock->writers_cv)) < 0)
            ret_value = FAIL;

        if (pthread_key_delete(rw_lock->rec_entry_count_key) < 0)
            ret_value = FAIL;
    }

    return ret_value;

} /* end H5TS_rw_lock_destroy() */

/*--------------------------------------------------------------------------
 * Function:    H5TS_rw_rdlock
 *
 * Returns:     SUCCEED/FAIL
 *
 * Description:
 *    Attempt to obtain a read lock on the associated recursive read / write
 *    lock.
 *
 * Programmer:  John Mainzer
 *              August 28, 2020
 *
 *--------------------------------------------------------------------------
 */
herr_t
H5TS_rw_rdlock(H5TS_rw_lock_t *rw_lock)
{
    hbool_t               have_mutex = FALSE;
    int                   result;
    H5TS_rec_entry_count *count;
    herr_t                ret_value = SUCCEED;

    if ((rw_lock == NULL) || (rw_lock->magic != H5TS_RW_LOCK_MAGIC)) {

        ret_value = FAIL;
    }

    /* Obtain the mutex */
    if (ret_value == SUCCEED) {
        if (H5TS_mutex_lock_simple(&(rw_lock->mutex)) != 0)
            ret_value = FAIL;
        else
            have_mutex = TRUE;
    }

    /* If there is no specific data for this thread, this is an
     * initial read lock request.
     */
    if (ret_value == SUCCEED) {

        count = (H5TS_rec_entry_count *)H5TS_get_thread_local_value(rw_lock->rec_entry_count_key);

        if (count) { /* This is a recursive lock */

            if ((count->write_lock) || (rw_lock->active_readers == 0) || (rw_lock->active_writers != 0)) {

                ret_value = FAIL;
            }
            else {

                count->rec_lock_count++;

                H5TS_update_stats_rd_lock(rw_lock, count);
            }
        }
        else { /* This is an initial read lock request */

            switch (rw_lock->policy) {

                case H5TS_RW_LOCK_POLICY_FAVOR_WRITERS:
                    if ((rw_lock->active_writers != 0) || (rw_lock->waiting_writers_count != 0)) {

                        int delayed = rw_lock->waiting_readers_count + 1;

                        H5TS_update_stats_rd_lock_delay(rw_lock, delayed);
                    }

                    while ((rw_lock->active_writers != 0) || (rw_lock->waiting_writers_count != 0)) {

                        rw_lock->waiting_readers_count++;

                        result = H5TS_cond_wait(&(rw_lock->readers_cv), &(rw_lock->mutex));

                        rw_lock->waiting_readers_count--;

                        if (result != 0) {

                            ret_value = FAIL;
                            break;
                        }
                    }
                    break;

                default:
                    ret_value = FAIL;
                    break;
            }

            if ((ret_value == SUCCEED) && (NULL == (count = H5TS_alloc_rec_entry_count(FALSE)))) {

                ret_value = FAIL;
            }

            if ((ret_value == SUCCEED) &&
                (H5TS_set_thread_local_value(rw_lock->rec_entry_count_key, (void *)count) != 0)) {

                ret_value = FAIL;
            }

            if (ret_value == SUCCEED) {

                rw_lock->active_readers++;

                HDassert(count->rec_lock_count == 1);

                H5TS_update_stats_rd_lock(rw_lock, count);
            }
        }
    }

    if (have_mutex) {

        H5TS_mutex_unlock_simple(&(rw_lock->mutex));
    }

    return ret_value;

} /* end H5TS_rw_rdlock() */

/*--------------------------------------------------------------------------
 * Function:    H5TS_rw_wrlock
 *
 * Returns:     SUCCEED/FAIL
 *
 * Description:
 *    Attempt to obtain a write lock on the associated recursive read / write
 *    lock.
 *
 * Programmer:  John Mainzer
 *              August 28, 2020
 *
 *--------------------------------------------------------------------------
 */
herr_t
H5TS_rw_wrlock(H5TS_rw_lock_t *rw_lock)
{
    hbool_t               have_mutex = FALSE;
    int                   result;
    H5TS_rec_entry_count *count;
    herr_t                ret_value = SUCCEED;

    if ((rw_lock == NULL) || (rw_lock->magic != H5TS_RW_LOCK_MAGIC)) {

        ret_value = FAIL;
    }

    /* Obtain the mutex */
    if (ret_value == SUCCEED) {
        if (H5TS_mutex_lock_simple(&(rw_lock->mutex)) != 0)
            ret_value = FAIL;
        else
            have_mutex = TRUE;
    }

    /* If there is no specific data for this thread, this is an
     * initial write lock request.
     */
    if (ret_value == SUCCEED) {

        count = (H5TS_rec_entry_count *)H5TS_get_thread_local_value(rw_lock->rec_entry_count_key);

        if (count) { /* this is a recursive lock */

            if ((!(count->write_lock)) || (rw_lock->active_readers != 0) || (rw_lock->active_writers != 1)) {

                ret_value = FAIL;
            }
            else {

                count->rec_lock_count++;

                H5TS_update_stats_wr_lock(rw_lock, count);
            }
        }
        else { /* This is an initial write lock request */

            switch (rw_lock->policy) {

                case H5TS_RW_LOCK_POLICY_FAVOR_WRITERS:
                    if ((rw_lock->active_readers > 0) || (rw_lock->active_writers > 0)) {

                        int delayed = rw_lock->waiting_writers_count + 1;

                        H5TS_update_stats_wr_lock_delay(rw_lock, delayed);
                    }

                    while ((rw_lock->active_readers > 0) || (rw_lock->active_writers > 0)) {

                        rw_lock->waiting_writers_count++;

                        result = H5TS_cond_wait(&(rw_lock->writers_cv), &(rw_lock->mutex));

                        rw_lock->waiting_writers_count--;

                        if (result != 0) {

                            ret_value = FAIL;
                            break;
                        }
                    }
                    break;

                default:
                    ret_value = FAIL;
                    break;
            }

            if ((ret_value == SUCCEED) && (NULL == (count = H5TS_alloc_rec_entry_count(TRUE)))) {

                ret_value = FAIL;
            }

            if ((ret_value == SUCCEED) &&
                (H5TS_set_thread_local_value(rw_lock->rec_entry_count_key, (void *)count) != 0)) {

                ret_value = FAIL;
            }

            if (ret_value == SUCCEED) {

                rw_lock->active_writers++;

                HDassert(count->rec_lock_count == 1);

                H5TS_update_stats_wr_lock(rw_lock, count);
            }
        }
    }

    if (have_mutex) {

        H5TS_mutex_unlock_simple(&(rw_lock->mutex));
    }

    return ret_value;

} /* end H5TS_rw_wrlock() */

/*--------------------------------------------------------------------------
 * Function:    H5TS_rw_unlock
 *
 * Returns:     SUCCEED/FAIL
 *
 * Description:
 *    Attempt to unlock either a read or a write lock on the supplied
 *    recursive read / write lock.
 *
 * Programmer:  John Mainzer
 *              August 28, 2020
 *
 *--------------------------------------------------------------------------
 */
herr_t
H5TS_rw_unlock(H5TS_rw_lock_t *rw_lock)
{
    hbool_t               have_mutex        = FALSE;
    hbool_t               discard_rec_count = FALSE;
    H5TS_rec_entry_count *count;
    herr_t                ret_value = SUCCEED;

    if ((rw_lock == NULL) || (rw_lock->magic != H5TS_RW_LOCK_MAGIC)) {

        ret_value = FAIL;
    }

    /* Obtain the mutex */
    if (ret_value == SUCCEED) {
        if (H5TS_mutex_lock_simple(&(rw_lock->mutex)) != 0)
            ret_value = FAIL;
        else
            have_mutex = TRUE;
    }

    /* If there is no specific data for this thread, no lock was held,
     * and thus the unlock call must fail.
     */
    if (ret_value == SUCCEED) {

        count = (H5TS_rec_entry_count *)H5TS_get_thread_local_value(rw_lock->rec_entry_count_key);

        HDassert(count);
        HDassert(count->magic == H5TS_RW_ENTRY_COUNT_MAGIC);
        HDassert(count->rec_lock_count > 0);

        if (NULL == count) {

            ret_value = FAIL;
        }
        else if (count->magic != H5TS_RW_ENTRY_COUNT_MAGIC) {

            ret_value = FAIL;
        }
        else if (count->rec_lock_count <= 0) { /* Corrupt count? */

            ret_value = FAIL;
        }
        else if (count->write_lock) { /* Drop a write lock */

            HDassert((rw_lock->active_readers == 0) && (rw_lock->active_writers == 1));

            if ((rw_lock->active_readers != 0) || (rw_lock->active_writers != 1)) {

                ret_value = FAIL;
            }
            else {

                count->rec_lock_count--;

                HDassert(count->rec_lock_count >= 0);

                if (count->rec_lock_count == 0) {

                    /* Make note that we must discard the
                     * recursive entry counter so it will not
                     * confuse us on the next lock request.
                     */
                    discard_rec_count = TRUE;

                    /* Drop the write lock -- will signal later if needed */
                    rw_lock->active_writers--;

                    HDassert(rw_lock->active_writers == 0);
                }
            }

            H5TS_update_stats_wr_unlock(rw_lock, count);
        }
        else { /* drop a read lock */

            HDassert((rw_lock->active_readers > 0) && (rw_lock->active_writers == 0));

            if ((rw_lock->active_readers <= 0) || (rw_lock->active_writers != 0)) {

                ret_value = FAIL;
            }
            else {

                count->rec_lock_count--;

                HDassert(count->rec_lock_count >= 0);

                if (count->rec_lock_count == 0) {

                    /* Make note that we must discard the
                     * recursive entry counter so it will not
                     * confuse us on the next lock request.
                     */
                    discard_rec_count = TRUE;

                    /* Drop the read lock -- will signal later if needed */
                    rw_lock->active_readers--;
                }
            }

            H5TS_update_stats_rd_unlock(rw_lock, count);
        }

        if ((ret_value == SUCCEED) && (rw_lock->active_readers == 0) && (rw_lock->active_writers == 0)) {

            /* No locks held -- signal condition variables if required */

            switch (rw_lock->policy) {

                case H5TS_RW_LOCK_POLICY_FAVOR_WRITERS:
#ifdef H5_HAVE_WIN_THREADS
                    if (rw_lock->waiting_writers_count > 0)
                        H5TS_cond_signal(&(rw_lock->writers_cv));
                    else if (rw_lock->waiting_readers_count > 0)
                        H5TS_cond_broadcast(&(rw_lock->readers_cv));
#else
                    if (rw_lock->waiting_writers_count > 0) {

                        if (H5TS_cond_signal(&(rw_lock->writers_cv)) != 0)
                            ret_value = FAIL;
                    }
                    else if (rw_lock->waiting_readers_count > 0) {

                        if (H5TS_cond_broadcast(&(rw_lock->readers_cv)) != 0)
                            ret_value = FAIL;
                    }
#endif
                    break;
                default:
                    ret_value = FAIL;
                    break;
            }
        }
    }

    /* If we are really dropping the lock, must set the value of
     * rec_entry_count_key for this thread to NULL, so that
     * when this thread next requests a lock, it will appear
     * as an initial lock, not a recursive lock.
     */
    if (discard_rec_count) {

        HDassert(count);

        if (H5TS_set_thread_local_value(rw_lock->rec_entry_count_key, (void *)NULL) != 0) {

            ret_value = FAIL;
        }

        H5TS_free_rec_entry_count((void *)count);
        count = NULL;
    }

    if (have_mutex) {

        H5TS_mutex_unlock_simple(&(rw_lock->mutex));
    }

    return ret_value;

} /* end H5TS_rw_unlock() */

/*--------------------------------------------------------------------------
 * Function:    H5TS_rw_lock_get_stats
 *
 * Returns:     SUCCEED/FAIL
 *
 * Description:
 *    Obtain a copy of the current statistics on the supplied
 *    recursive read / write lock.  Note that to obtain a consistent
 *    set of statistics, the function must obtain the lock mutex.
 *
 * Programmer:  John Mainzer
 *              August 28, 2020
 *
 *--------------------------------------------------------------------------
 */
herr_t
H5TS_rw_lock_get_stats(H5TS_rw_lock_t *rw_lock, H5TS_rw_lock_stats_t *stats)
{
    hbool_t have_mutex = FALSE;
    herr_t  ret_value  = SUCCEED;

    if ((rw_lock == NULL) || (rw_lock->magic != H5TS_RW_LOCK_MAGIC) || (stats == NULL)) {

        ret_value = FAIL;
    }

    /* Obtain the mutex */
    if (ret_value == SUCCEED) {
        if (H5TS_mutex_lock_simple(&(rw_lock->mutex)) != 0)
            ret_value = FAIL;
        else
            have_mutex = TRUE;
    }

    if (ret_value == SUCCEED) {

        *stats = rw_lock->stats;
    }

    if (have_mutex) {

        H5TS_mutex_unlock_simple(&(rw_lock->mutex));
    }

    return ret_value;

} /* end H5TS_rw_lock_get_stats() */

/*--------------------------------------------------------------------------
 * Function:    H5TS_rw_lock_reset_stats
 *
 * Returns:     SUCCEED/FAIL
 *
 * Description:
 *    Reset the statistics for the supplied recursive read / write lock.
 *    Note that to reset the statistics consistently, the function must
 *    obtain the lock mutex.
 *
 * Programmer:  John Mainzer
 *              August 28, 2020
 *
 *--------------------------------------------------------------------------
 */
herr_t
H5TS_rw_lock_reset_stats(H5TS_rw_lock_t *rw_lock)
{
    hbool_t have_mutex = FALSE;
    /* NOTE: Update this initializer if you modify H5TS_rw_lock_stats_t */
    static const H5TS_rw_lock_stats_t reset_stats = {/* read_locks_granted             = */ 0,
                                                     /* read_locks_released            = */ 0,
                                                     /* real_read_locks_granted        = */ 0,
                                                     /* real_read_locks_released       = */ 0,
                                                     /* max_read_locks                 = */ 0,
                                                     /* max_read_lock_recursion_depth  = */ 0,
                                                     /* read_locks_delayed             = */ 0,
                                                     /* max_read_locks_pending         = */ 0,
                                                     /* write_locks_granted            = */ 0,
                                                     /* write_locks_released           = */ 0,
                                                     /* real_write_locks_granted       = */ 0,
                                                     /* real_write_locks_released      = */ 0,
                                                     /* max_write_locks                = */ 0,
                                                     /* max_write_lock_recursion_depth = */ 0,
                                                     /* write_locks_delayed            = */ 0,
                                                     /* max_write_locks_pending        = */ 0};
    herr_t                            ret_value   = SUCCEED;

    if ((rw_lock == NULL) || (rw_lock->magic != H5TS_RW_LOCK_MAGIC)) {

        ret_value = FAIL;
    }

    /* Obtain the mutex */
    if (ret_value == SUCCEED) {
        if (H5TS_mutex_lock_simple(&(rw_lock->mutex)) != 0)
            ret_value = FAIL;
        else
            have_mutex = TRUE;
    }

    if (ret_value == SUCCEED) {

        rw_lock->stats = reset_stats;
    }

    if (have_mutex) {

        H5TS_mutex_unlock_simple(&(rw_lock->mutex));
    }

    return ret_value;

} /* end H5TS_rw_lock_reset_stats() */

/*--------------------------------------------------------------------------
 * Function:    H5TS_rw_lock_print_stats
 *
 * Returns:     SUCCEED/FAIL
 *
 * Description:
 *    Print the supplied pthresds recursive R/W lock statistics to
 *    standard out.
 *
 *    UPDATE THIS FUNCTION IF YOU MODIFY H5TS_rw_lock_stats_t.
 *
 * Programmer:  John Mainzer
 *              August 28, 2020
 *
 *--------------------------------------------------------------------------
 */
herr_t
H5TS_rw_lock_print_stats(const char *header_str, H5TS_rw_lock_stats_t *stats)
{
    herr_t ret_value = SUCCEED;

    if ((header_str == NULL) || (stats == NULL)) {

        ret_value = FAIL;
    }
    else {

        HDfprintf(stdout, "\n\n%s\n\n", header_str);
        HDfprintf(stdout, "  read_locks_granted             = %" PRId64 "\n", stats->read_locks_granted);
        HDfprintf(stdout, "  read_locks_released            = %" PRId64 "\n", stats->read_locks_released);
        HDfprintf(stdout, "  real_read_locks_granted        = %" PRId64 "\n", stats->real_read_locks_granted);
        HDfprintf(stdout, "  real_read_locks_released       = %" PRId64 "\n",
                  stats->real_read_locks_released);
        HDfprintf(stdout, "  max_read_locks                 = %" PRId64 "\n", stats->max_read_locks);
        HDfprintf(stdout, "  max_read_lock_recursion_depth  = %" PRId64 "\n",
                  stats->max_read_lock_recursion_depth);
        HDfprintf(stdout, "  read_locks_delayed             = %" PRId64 "\n", stats->read_locks_delayed);
        HDfprintf(stdout, "  max_read_locks_pending         = %" PRId64 "\n", stats->max_read_locks_pending);
        HDfprintf(stdout, "  write_locks_granted            = %" PRId64 "\n", stats->write_locks_granted);
        HDfprintf(stdout, "  write_locks_released           = %" PRId64 "\n", stats->write_locks_released);
        HDfprintf(stdout, "  real_write_locks_granted       = %" PRId64 "\n",
                  stats->real_write_locks_granted);
        HDfprintf(stdout, "  real_write_locks_released      = %" PRId64 "\n",
                  stats->real_write_locks_released);
        HDfprintf(stdout, "  max_write_locks                = %" PRId64 "\n", stats->max_write_locks);
        HDfprintf(stdout, "  max_write_lock_recursion_depth = %" PRId64 "\n",
                  stats->max_write_lock_recursion_depth);
        HDfprintf(stdout, "  write_locks_delayed            = %" PRId64 "\n", stats->write_locks_delayed);
        HDfprintf(stdout, "  max_write_locks_pending        = %" PRId64 "\n\n",
                  stats->max_write_locks_pending);
    }

    return ret_value;

} /* end H5TS_rw_lock_print_stats() */

#endif /* H5_USE_RECURSIVE_WRITER_LOCKS */

/*--------------------------------------------------------------------------
 * NAME
 *    H5TS_create_thread
 *
 * RETURNS
 *    Thread identifier.
 *
 * DESCRIPTION
 *    Spawn off a new thread calling function 'func' with input 'udata'.
 *
 * PROGRAMMER: Mike McGreevy
 *             August 31, 2010
 *
 *--------------------------------------------------------------------------
 */
H5TS_thread_t
H5TS_create_thread(void *(*func)(void *), H5TS_attr_t *attr, void *udata)
{
    H5TS_thread_t ret_value;

#ifdef H5_HAVE_WIN_THREADS
    /* When calling C runtime functions, you should use _beginthread or
     * _beginthreadex instead of CreateThread.  Threads created with
     * CreateThread risk being killed in low-memory situations. Since we
     * only create threads in our test code, this is unlikely to be an issue
     * and we'll use the easier-to-deal-with CreateThread for now.
     *
     * NOTE: _beginthread() auto-recycles its handle when execution completes
     *       so you can't wait on it, making it unsuitable for the existing
     *       test code.
     */
    ret_value = CreateThread(NULL, 0, (LPTHREAD_START_ROUTINE)func, udata, 0, NULL);

#else /* H5_HAVE_WIN_THREADS */

    pthread_create(&ret_value, attr, (void *(*)(void *))func, udata);

#endif /* H5_HAVE_WIN_THREADS */

    return ret_value;
} /* end H5TS_create_thread() */

#endif /* H5_HAVE_THREADSAFE */