summaryrefslogtreecommitdiffstats
path: root/src/H5Cpkg.h
blob: a6204c52218a2ae8d5bbd69a0f8f106af27c9287 (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
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
 * Copyright by The HDF Group.                                               *
 * 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.                                                        *
 * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */

/*
 * Programmer: John Mainzer -- 10/12/04
 *
 * Purpose:	This file contains declarations which are visible only within
 *		the H5C package.  Source files outside the H5C package should
 *		include H5Cprivate.h instead.
 */

/* clang-format off */
/* Maintain current format by disabling format for this file */

#if !(defined H5C_FRIEND || defined H5C_MODULE)
#error "Do not include this file outside the H5C package!"
#endif

#ifndef H5Cpkg_H
#define H5Cpkg_H

/* Get package's private header */
#include "H5Cprivate.h"

/* Other private headers needed by this file */
#include "H5Clog.h"             /* Cache logging */
#include "H5SLprivate.h"        /* Skip lists */

/**************************/
/* Package Private Macros */
/**************************/

/* Number of epoch markers active */
#define H5C__MAX_EPOCH_MARKERS                  10

/* Cache configuration settings */
#define H5C__HASH_TABLE_LEN     (64 * 1024) /* must be a power of 2 */

/* Initial allocated size of the "flush_dep_parent" array */
#define H5C_FLUSH_DEP_PARENT_INIT 8


/****************************************************************************
 *
 * We maintain doubly linked lists of instances of H5C_cache_entry_t for a
 * variety of reasons -- protected list, LRU list, and the clean and dirty
 * LRU lists at present.  The following macros support linking and unlinking
 * of instances of H5C_cache_entry_t by both their regular and auxiliary next
 * and previous pointers.
 *
 * The size and length fields are also maintained.
 *
 * Note that the relevant pair of prev and next pointers are presumed to be
 * NULL on entry in the insertion macros.
 *
 * Finally, observe that the sanity checking macros evaluate to the empty
 * string when H5C_DO_SANITY_CHECKS is FALSE.  They also contain calls
 * to the HGOTO_ERROR macro, which may not be appropriate in all cases.
 * If so, we will need versions of the insertion and deletion macros which
 * do not reference the sanity checking macros.
 *
 ****************************************************************************/

#ifdef H5C_DO_SANITY_CHECKS

#define H5C__GEN_DLL_PRE_REMOVE_SC(entry_ptr, list_next, list_prev, head_ptr, tail_ptr, len, list_size, fail_val) \
if ((head_ptr) == NULL || (tail_ptr) == NULL ||                              \
    (entry_ptr) == NULL || (len) <= 0 ||                                     \
    (list_size) < (entry_ptr)->size ||                                       \
    ((entry_ptr)->list_prev == NULL && (head_ptr) != (entry_ptr)) ||         \
    ((entry_ptr)->list_next == NULL && (tail_ptr) != (entry_ptr)) ||         \
    ((len) == 1 &&                                                           \
     !((head_ptr) == (entry_ptr) && (tail_ptr) == (entry_ptr) &&             \
       (entry_ptr)->list_next == NULL && (entry_ptr)->list_prev == NULL &&   \
       (list_size) == (entry_ptr)->size                                      \
      )                                                                      \
    )                                                                        \
   ) {                                                                       \
    HGOTO_ERROR(H5E_CACHE, H5E_SYSTEM, (fail_val), "DLL pre remove SC failed") \
}

#define H5C__GEN_DLL_PRE_INSERT_SC(entry_ptr, list_next, list_prev, head_ptr, tail_ptr, len, list_size, fail_val) \
if ((entry_ptr) == NULL || (entry_ptr)->list_next != NULL || (entry_ptr)->list_prev != NULL || \
    (((head_ptr) == NULL || (tail_ptr) == NULL) && (head_ptr) != (tail_ptr)) || \
    ((len) == 0 &&                                                            \
        ((list_size) > 0 || (head_ptr) != NULL || (tail_ptr) != NULL)         \
    ) ||                                                                      \
    ((len) == 1 &&                                                            \
        ((head_ptr) != (tail_ptr) || (head_ptr) == NULL ||                    \
        (head_ptr)->size != (list_size))                                      \
    ) ||                                                                      \
    ((len) >= 1 &&                                                            \
     ((head_ptr) == NULL || (head_ptr)->list_prev != NULL ||                  \
      (tail_ptr) == NULL || (tail_ptr)->list_next != NULL)                    \
    )                                                                         \
   ) {                                                                        \
    HGOTO_ERROR(H5E_CACHE, H5E_SYSTEM, (fail_val), "DLL pre insert SC failed") \
}

#define H5C__GEN_DLL_PRE_SIZE_UPDATE_SC(dll_len, dll_size, old_size, new_size, fail_val) \
if ((dll_len) <= 0 || (dll_size) <= 0 || (old_size) <= 0 ||                   \
    (old_size) > (dll_size) || (new_size) <= 0 ||                             \
    ((dll_len) == 1 && (old_size) != (dll_size))                              \
   ) {                                                                        \
    HGOTO_ERROR(H5E_CACHE, H5E_SYSTEM, (fail_val), "DLL pre size update SC failed") \
}

#define H5C__GEN_DLL_POST_SIZE_UPDATE_SC(dll_len, dll_size, old_size, new_size, fail_val) \
if ((new_size) > (dll_size) || ((dll_len) == 1 && (new_size) != (dll_size))) { \
    HGOTO_ERROR(H5E_CACHE, H5E_SYSTEM, (fail_val), "DLL post size update SC failed") \
}
#else /* H5C_DO_SANITY_CHECKS */
#define H5C__GEN_DLL_PRE_REMOVE_SC(entry_ptr, list_next, list_prev, head_ptr, tail_ptr, len, list_size, fail_val)
#define H5C__GEN_DLL_PRE_INSERT_SC(entry_ptr, list_next, list_prev, head_ptr, tail_ptr, len, list_size, fail_val)
#define H5C__GEN_DLL_PRE_SIZE_UPDATE_SC(dll_len, dll_size, old_size, new_size, fail_val)
#define H5C__GEN_DLL_POST_SIZE_UPDATE_SC(dll_len, dll_size, old_size, new_size, fail_val)
#endif /* H5C_DO_SANITY_CHECKS */

#define H5C__GEN_DLL_APPEND(entry_ptr, list_next, list_prev, head_ptr, tail_ptr, len, list_size, fail_val)    \
{                                                                              \
    H5C__GEN_DLL_PRE_INSERT_SC(entry_ptr, list_next, list_prev, head_ptr, tail_ptr, len, list_size, fail_val) \
    if ((head_ptr) == NULL) {                                                  \
       (head_ptr) = (entry_ptr);                                               \
       (tail_ptr) = (entry_ptr);                                               \
    }                                                                          \
    else {                                                                     \
       (tail_ptr)->list_next = (entry_ptr);                                    \
       (entry_ptr)->list_prev = (tail_ptr);                                    \
       (tail_ptr) = (entry_ptr);                                               \
    }                                                                          \
    (len)++;                                                                   \
    (list_size) += (entry_ptr)->size;                                          \
} /* H5C__GEN_DLL_APPEND() */

#define H5C__GEN_DLL_PREPEND(entry_ptr, list_next, list_prev, head_ptr, tail_ptr, len, list_size, fail_val)    \
{                                                                              \
    H5C__GEN_DLL_PRE_INSERT_SC(entry_ptr, list_next, list_prev, head_ptr, tail_ptr, len, list_size, fail_val) \
    if ((head_ptr) == NULL) {                                                  \
       (head_ptr) = (entry_ptr);                                               \
       (tail_ptr) = (entry_ptr);                                               \
    }                                                                          \
    else {                                                                     \
       (head_ptr)->list_prev = (entry_ptr);                                    \
       (entry_ptr)->list_next = (head_ptr);                                    \
       (head_ptr) = (entry_ptr);                                               \
    }                                                                          \
    (len)++;                                                                   \
    (list_size) += (entry_ptr)->size;                                          \
} /* H5C__GEN_DLL_PREPEND() */

#define H5C__GEN_DLL_REMOVE(entry_ptr, list_next, list_prev, head_ptr, tail_ptr, len, list_size, fail_val)    \
{                                                                              \
    H5C__GEN_DLL_PRE_REMOVE_SC(entry_ptr, list_next, list_prev, head_ptr, tail_ptr, len, list_size, fail_val) \
    if ((head_ptr) == (entry_ptr)) {                                           \
       (head_ptr) = (entry_ptr)->list_next;                                    \
       if ((head_ptr) != NULL)                                                 \
          (head_ptr)->list_prev = NULL;                                        \
    }                                                                          \
    else                                                                       \
       (entry_ptr)->list_prev->list_next = (entry_ptr)->list_next;             \
    if ((tail_ptr) == (entry_ptr)) {                                           \
       (tail_ptr) = (entry_ptr)->list_prev;                                    \
       if ((tail_ptr) != NULL)                                                 \
          (tail_ptr)->list_next = NULL;                                        \
    }                                                                          \
    else                                                                       \
       (entry_ptr)->list_next->list_prev = (entry_ptr)->list_prev;             \
    (entry_ptr)->list_next = NULL;                                             \
    (entry_ptr)->list_prev = NULL;                                             \
    (len)--;                                                                   \
    (list_size) -= (entry_ptr)->size;                                          \
} /* H5C__GEN_DLL_REMOVE() */

#define H5C__GEN_DLL_UPDATE_FOR_SIZE_CHANGE(dll_len, dll_size, old_size, new_size, fail_val) \
{                                                                              \
    H5C__GEN_DLL_PRE_SIZE_UPDATE_SC(dll_len, dll_size, old_size, new_size, fail_val) \
    (dll_size) -= (old_size);                                                  \
    (dll_size) += (new_size);                                                  \
    H5C__GEN_DLL_POST_SIZE_UPDATE_SC(dll_len, dll_size, old_size, new_size, fail_val) \
} /* H5C__GEN_DLL_UPDATE_FOR_SIZE_CHANGE() */


/* Macros that modify the LRU/protected/pinned lists */
#define H5C__DLL_APPEND(entry_ptr, head_ptr, tail_ptr, len, list_size, fail_val)    \
    H5C__GEN_DLL_APPEND(entry_ptr, next, prev, head_ptr, tail_ptr, len, list_size, fail_val)
#define H5C__DLL_PREPEND(entry_ptr, head_ptr, tail_ptr, len, list_size, fail_val) \
    H5C__GEN_DLL_PREPEND(entry_ptr, next, prev, head_ptr, tail_ptr, len, list_size, fail_val)
#define H5C__DLL_REMOVE(entry_ptr, head_ptr, tail_ptr, len, list_size, fail_val) \
    H5C__GEN_DLL_REMOVE(entry_ptr, next, prev, head_ptr, tail_ptr, len, list_size, fail_val)
#define H5C__DLL_UPDATE_FOR_SIZE_CHANGE(dll_len, dll_size, old_size, new_size, fail_val) \
    H5C__GEN_DLL_UPDATE_FOR_SIZE_CHANGE(dll_len, dll_size, old_size, new_size, fail_val)

/* Macros that modify the "auxiliary" LRU list */
#define H5C__AUX_DLL_APPEND(entry_ptr, head_ptr, tail_ptr, len, list_size, fail_val)  \
    H5C__GEN_DLL_APPEND(entry_ptr, aux_next, aux_prev, head_ptr, tail_ptr, len, list_size, fail_val)
#define H5C__AUX_DLL_PREPEND(entry_ptr, head_ptr, tail_ptr, len, list_size, fail_val) \
    H5C__GEN_DLL_PREPEND(entry_ptr, aux_next, aux_prev, head_ptr, tail_ptr, len, list_size, fail_val)
#define H5C__AUX_DLL_REMOVE(entry_ptr, head_ptr, tail_ptr, len, list_size, fail_val)  \
    H5C__GEN_DLL_REMOVE(entry_ptr, aux_next, aux_prev, head_ptr, tail_ptr, len, list_size, fail_val)

/* Macros that modify the "index" list */
#define H5C__IL_DLL_APPEND(entry_ptr, head_ptr, tail_ptr, len, list_size, fail_val) \
    H5C__GEN_DLL_APPEND(entry_ptr, il_next, il_prev, head_ptr, tail_ptr, len, list_size, fail_val)
#define H5C__IL_DLL_REMOVE(entry_ptr, head_ptr, tail_ptr, len, list_size, fail_val) \
    H5C__GEN_DLL_REMOVE(entry_ptr, il_next, il_prev, head_ptr, tail_ptr, len, list_size, fail_val)


/***********************************************************************
 *
 * Stats collection macros
 *
 * The following macros must handle stats collection when this collection
 * is enabled, and evaluate to the empty string when it is not.
 *
 * The sole exception to this rule is
 * H5C__UPDATE_CACHE_HIT_RATE_STATS(), which is always active as
 * the cache hit rate stats are always collected and available.
 *
 ***********************************************************************/

#define H5C__UPDATE_CACHE_HIT_RATE_STATS(cache_ptr, hit) \
    (cache_ptr)->cache_accesses++;                       \
    if (hit)                                             \
        (cache_ptr)->cache_hits++;

#if H5C_COLLECT_CACHE_STATS

#define H5C__UPDATE_MAX_INDEX_SIZE_STATS(cache_ptr)                        \
    if ((cache_ptr)->index_size > (cache_ptr)->max_index_size)             \
        (cache_ptr)->max_index_size = (cache_ptr)->index_size;             \
    if ((cache_ptr)->clean_index_size > (cache_ptr)->max_clean_index_size) \
        (cache_ptr)->max_clean_index_size = (cache_ptr)->clean_index_size; \
    if ((cache_ptr)->dirty_index_size > (cache_ptr)->max_dirty_index_size) \
        (cache_ptr)->max_dirty_index_size = (cache_ptr)->dirty_index_size;

#define H5C__UPDATE_STATS_FOR_DIRTY_PIN(cache_ptr, entry_ptr) \
    (cache_ptr)->dirty_pins[(entry_ptr)->type->id]++;

#define H5C__UPDATE_STATS_FOR_UNPROTECT(cache_ptr)             \
    if ((cache_ptr)->slist_len > (cache_ptr)->max_slist_len)   \
        (cache_ptr)->max_slist_len = (cache_ptr)->slist_len;   \
    if ((cache_ptr)->slist_size > (cache_ptr)->max_slist_size) \
        (cache_ptr)->max_slist_size = (cache_ptr)->slist_size; \
    if ((cache_ptr)->pel_len > (cache_ptr)->max_pel_len)       \
        (cache_ptr)->max_pel_len = (cache_ptr)->pel_len;       \
    if ((cache_ptr)->pel_size > (cache_ptr)->max_pel_size)     \
        (cache_ptr)->max_pel_size = (cache_ptr)->pel_size;

#define H5C__UPDATE_STATS_FOR_MOVE(cache_ptr, entry_ptr)              \
    if ((cache_ptr)->flush_in_progress)                               \
        (cache_ptr)->cache_flush_moves[(entry_ptr)->type->id]++;      \
    if ((entry_ptr)->flush_in_progress)                               \
        (cache_ptr)->entry_flush_moves[(entry_ptr)->type->id]++;      \
    (cache_ptr)->moves[(entry_ptr)->type->id]++;                      \
    (cache_ptr)->entries_relocated_counter++;

#define H5C__UPDATE_STATS_FOR_ENTRY_SIZE_CHANGE(cache_ptr, entry_ptr, new_size) \
    if ((cache_ptr)->flush_in_progress)                                  \
        (cache_ptr)->cache_flush_size_changes[(entry_ptr)->type->id]++;  \
    if ((entry_ptr)->flush_in_progress)                                  \
        (cache_ptr)->entry_flush_size_changes[(entry_ptr)->type->id]++;  \
    if ((entry_ptr)->size < (new_size)) {                                \
        (cache_ptr)->size_increases[(entry_ptr)->type->id]++;            \
        H5C__UPDATE_MAX_INDEX_SIZE_STATS(cache_ptr)                      \
        if ((cache_ptr)->slist_size > (cache_ptr)->max_slist_size)       \
            (cache_ptr)->max_slist_size = (cache_ptr)->slist_size;       \
        if ((cache_ptr)->pl_size > (cache_ptr)->max_pl_size)             \
            (cache_ptr)->max_pl_size = (cache_ptr)->pl_size;             \
    } else if ((entry_ptr)->size > (new_size))                           \
        (cache_ptr)->size_decreases[(entry_ptr)->type->id]++;

#define H5C__UPDATE_STATS_FOR_HT_INSERTION(cache_ptr) \
    (cache_ptr)->total_ht_insertions++;

#define H5C__UPDATE_STATS_FOR_HT_DELETION(cache_ptr) \
    (cache_ptr)->total_ht_deletions++;

#define H5C__UPDATE_STATS_FOR_HT_SEARCH(cache_ptr, success, depth) \
    if (success) {                                                 \
        (cache_ptr)->successful_ht_searches++;                     \
        (cache_ptr)->total_successful_ht_search_depth += depth;    \
    } else {                                                       \
        (cache_ptr)->failed_ht_searches++;                         \
        (cache_ptr)->total_failed_ht_search_depth += depth;        \
    }

#define H5C__UPDATE_STATS_FOR_UNPIN(cache_ptr, entry_ptr) \
    (cache_ptr)->unpins[(entry_ptr)->type->id]++;

#define H5C__UPDATE_STATS_FOR_PREFETCH(cache_ptr, dirty) \
{                                                        \
    (cache_ptr)->prefetches++;                           \
    if (dirty)                                           \
        (cache_ptr)->dirty_prefetches++;                 \
}

#define H5C__UPDATE_STATS_FOR_PREFETCH_HIT(cache_ptr) \
    (cache_ptr)->prefetch_hits++;

#define H5C__UPDATE_STATS_FOR_SLIST_SCAN_RESTART(cache_ptr) \
    (cache_ptr)->slist_scan_restarts++;

#define H5C__UPDATE_STATS_FOR_LRU_SCAN_RESTART(cache_ptr) \
    (cache_ptr)->LRU_scan_restarts++;

#define H5C__UPDATE_STATS_FOR_INDEX_SCAN_RESTART(cache_ptr) \
    (cache_ptr)->index_scan_restarts++;

#if H5C_COLLECT_CACHE_ENTRY_STATS

#define H5C__RESET_CACHE_ENTRY_STATS(entry_ptr) \
{                                               \
    (entry_ptr)->accesses = 0;                  \
    (entry_ptr)->clears   = 0;                  \
    (entry_ptr)->flushes  = 0;                  \
    (entry_ptr)->pins     = 0;                  \
}

#define H5C__UPDATE_STATS_FOR_CLEAR(cache_ptr, entry_ptr)    \
{                                                            \
    (cache_ptr)->clears[(entry_ptr)->type->id]++;            \
    if((entry_ptr)->is_pinned)                               \
        (cache_ptr)->pinned_clears[(entry_ptr)->type->id]++; \
    (entry_ptr)->clears++;                                   \
}

#define H5C__UPDATE_STATS_FOR_FLUSH(cache_ptr, entry_ptr)     \
{                                                             \
    (cache_ptr)->flushes[(entry_ptr)->type->id]++;            \
    if((entry_ptr)->is_pinned)                                \
        (cache_ptr)->pinned_flushes[(entry_ptr)->type->id]++; \
    (entry_ptr)->flushes++;                                   \
}

#define H5C__UPDATE_STATS_FOR_EVICTION(cache_ptr, entry_ptr, take_ownership) \
{                                                                            \
    if (take_ownership)                                                      \
        (cache_ptr)->take_ownerships[(entry_ptr)->type->id]++;               \
    else                                                                     \
        (cache_ptr)->evictions[(entry_ptr)->type->id]++;                     \
    if ((entry_ptr)->accesses > (cache_ptr)->max_accesses[(entry_ptr)->type->id]) \
        (cache_ptr)->max_accesses[(entry_ptr)->type->id] = (entry_ptr)->accesses; \
    if ((entry_ptr)->accesses < (cache_ptr)->min_accesses[(entry_ptr)->type->id]) \
        (cache_ptr)->min_accesses[(entry_ptr)->type->id] = (entry_ptr)->accesses; \
    if ((entry_ptr)->clears > (cache_ptr)->max_clears[(entry_ptr)->type->id]) \
        (cache_ptr)->max_clears[(entry_ptr)->type->id] = (entry_ptr)->clears; \
    if ((entry_ptr)->flushes > (cache_ptr)->max_flushes[(entry_ptr)->type->id]) \
        (cache_ptr)->max_flushes[(entry_ptr)->type->id] = (entry_ptr)->flushes; \
    if ((entry_ptr)->size > (cache_ptr)->max_size[(entry_ptr)->type->id])    \
        (cache_ptr)->max_size[(entry_ptr)->type->id] = (entry_ptr)->size;    \
    if ((entry_ptr)->pins > (cache_ptr)->max_pins[(entry_ptr)->type->id])    \
        (cache_ptr)->max_pins[(entry_ptr)->type->id] = (entry_ptr)->pins;    \
}

#define H5C__UPDATE_STATS_FOR_INSERTION(cache_ptr, entry_ptr)             \
{                                                                         \
    (cache_ptr)->insertions[(entry_ptr)->type->id]++;                     \
    if ((entry_ptr)->is_pinned) {                                         \
        (cache_ptr)->pinned_insertions[(entry_ptr)->type->id]++;          \
        (cache_ptr)->pins[(entry_ptr)->type->id]++;                       \
        (entry_ptr)->pins++;                                              \
        if ((cache_ptr)->pel_len > (cache_ptr)->max_pel_len)              \
            (cache_ptr)->max_pel_len = (cache_ptr)->pel_len;              \
        if ((cache_ptr)->pel_size > (cache_ptr)->max_pel_size)            \
            (cache_ptr)->max_pel_size = (cache_ptr)->pel_size;            \
    }                                                                     \
    if ((cache_ptr)->index_len > (cache_ptr)->max_index_len)              \
        (cache_ptr)->max_index_len = (cache_ptr)->index_len;              \
    H5C__UPDATE_MAX_INDEX_SIZE_STATS(cache_ptr)                           \
    if ((cache_ptr)->slist_len > (cache_ptr)->max_slist_len)              \
        (cache_ptr)->max_slist_len = (cache_ptr)->slist_len;              \
    if ((cache_ptr)->slist_size > (cache_ptr)->max_slist_size)            \
        (cache_ptr)->max_slist_size = (cache_ptr)->slist_size;            \
    if ((entry_ptr)->size > (cache_ptr)->max_size[(entry_ptr)->type->id]) \
        (cache_ptr)->max_size[(entry_ptr)->type->id] = (entry_ptr)->size; \
    (cache_ptr)->entries_inserted_counter++;                              \
}

#define H5C__UPDATE_STATS_FOR_PROTECT(cache_ptr, entry_ptr, hit)          \
{                                                                         \
    if (hit)                                                              \
        (cache_ptr)->hits[(entry_ptr)->type->id]++;                       \
    else                                                                  \
        (cache_ptr)->misses[(entry_ptr)->type->id]++;                     \
    if (!(entry_ptr)->is_read_only)                                       \
        (cache_ptr)->write_protects[(entry_ptr)->type->id]++;             \
    else {                                                                \
        (cache_ptr)->read_protects[(entry_ptr)->type->id]++;              \
        if ((entry_ptr)->ro_ref_count > (cache_ptr)->max_read_protects[(entry_ptr)->type->id]) \
            (cache_ptr)->max_read_protects[(entry_ptr)->type->id] = (entry_ptr)->ro_ref_count; \
    }                                                                     \
    if ((cache_ptr)->index_len > (cache_ptr)->max_index_len)              \
        (cache_ptr)->max_index_len = (cache_ptr)->index_len;              \
    H5C__UPDATE_MAX_INDEX_SIZE_STATS(cache_ptr)                           \
    if ((cache_ptr)->pl_len > (cache_ptr)->max_pl_len)                    \
        (cache_ptr)->max_pl_len = (cache_ptr)->pl_len;                    \
    if ((cache_ptr)->pl_size > (cache_ptr)->max_pl_size)                  \
        (cache_ptr)->max_pl_size = (cache_ptr)->pl_size;                  \
    if ((entry_ptr)->size > (cache_ptr)->max_size[(entry_ptr)->type->id]) \
        (cache_ptr)->max_size[(entry_ptr)->type->id] = (entry_ptr)->size; \
    (entry_ptr)->accesses++;                                              \
}

#define H5C__UPDATE_STATS_FOR_PIN(cache_ptr, entry_ptr)      \
{                                                            \
    (cache_ptr)->pins[(entry_ptr)->type->id]++;              \
    (entry_ptr)->pins++;                                     \
    if ((cache_ptr)->pel_len > (cache_ptr)->max_pel_len)     \
        (cache_ptr)->max_pel_len = (cache_ptr)->pel_len;     \
    if ((cache_ptr)->pel_size > (cache_ptr)->max_pel_size)   \
        (cache_ptr)->max_pel_size = (cache_ptr)->pel_size;   \
}

#else /* H5C_COLLECT_CACHE_ENTRY_STATS */

#define H5C__RESET_CACHE_ENTRY_STATS(entry_ptr)

#define H5C__UPDATE_STATS_FOR_CLEAR(cache_ptr, entry_ptr)     \
{                                                             \
    (cache_ptr)->clears[(entry_ptr)->type->id]++;             \
    if((entry_ptr)->is_pinned)                                \
        (cache_ptr)->pinned_clears[(entry_ptr)->type->id]++;  \
}

#define H5C__UPDATE_STATS_FOR_FLUSH(cache_ptr, entry_ptr)     \
{                                                             \
    (cache_ptr)->flushes[(entry_ptr)->type->id]++;            \
    if ((entry_ptr)->is_pinned)                               \
        (cache_ptr)->pinned_flushes[(entry_ptr)->type->id]++; \
}

#define H5C__UPDATE_STATS_FOR_EVICTION(cache_ptr, entry_ptr, take_ownership) \
{                                                              \
    if (take_ownership)                                        \
        (cache_ptr)->take_ownerships[(entry_ptr)->type->id]++; \
    else                                                       \
        (cache_ptr)->evictions[(entry_ptr)->type->id]++;       \
}

#define H5C__UPDATE_STATS_FOR_INSERTION(cache_ptr, entry_ptr)    \
{                                                                \
    (cache_ptr)->insertions[(entry_ptr)->type->id]++;            \
    if ((entry_ptr)->is_pinned) {                                \
        (cache_ptr)->pinned_insertions[(entry_ptr)->type->id]++; \
        (cache_ptr)->pins[(entry_ptr)->type->id]++;              \
        if ((cache_ptr)->pel_len > (cache_ptr)->max_pel_len)     \
            (cache_ptr)->max_pel_len = (cache_ptr)->pel_len;     \
        if ((cache_ptr)->pel_size > (cache_ptr)->max_pel_size)   \
            (cache_ptr)->max_pel_size = (cache_ptr)->pel_size;   \
    }                                                            \
    if ((cache_ptr)->index_len > (cache_ptr)->max_index_len)     \
        (cache_ptr)->max_index_len = (cache_ptr)->index_len;     \
    H5C__UPDATE_MAX_INDEX_SIZE_STATS(cache_ptr)                  \
    if ((cache_ptr)->slist_len > (cache_ptr)->max_slist_len)     \
        (cache_ptr)->max_slist_len = (cache_ptr)->slist_len;     \
    if ((cache_ptr)->slist_size > (cache_ptr)->max_slist_size)   \
        (cache_ptr)->max_slist_size = (cache_ptr)->slist_size;   \
    (cache_ptr)->entries_inserted_counter++;                     \
}

#define H5C__UPDATE_STATS_FOR_PROTECT(cache_ptr, entry_ptr, hit)       \
{                                                                      \
    if (hit)                                                           \
        (cache_ptr)->hits[(entry_ptr)->type->id]++;                    \
    else                                                               \
        (cache_ptr)->misses[(entry_ptr)->type->id]++;                  \
    if (!(entry_ptr)->is_read_only)                                    \
        (cache_ptr)->write_protects[(entry_ptr)->type->id]++;          \
    else {                                                             \
        (cache_ptr)->read_protects[(entry_ptr)->type->id]++;           \
        if ((entry_ptr)->ro_ref_count >                                \
                (cache_ptr)->max_read_protects[(entry_ptr)->type->id]) \
            (cache_ptr)->max_read_protects[(entry_ptr)->type->id] =    \
                    (entry_ptr)->ro_ref_count;                         \
    }                                                                  \
    if ((cache_ptr)->index_len > (cache_ptr)->max_index_len)           \
        (cache_ptr)->max_index_len = (cache_ptr)->index_len;           \
    H5C__UPDATE_MAX_INDEX_SIZE_STATS(cache_ptr)                        \
    if ((cache_ptr)->pl_len > (cache_ptr)->max_pl_len)                 \
        (cache_ptr)->max_pl_len = (cache_ptr)->pl_len;                 \
    if ((cache_ptr)->pl_size > (cache_ptr)->max_pl_size)               \
        (cache_ptr)->max_pl_size = (cache_ptr)->pl_size;               \
}

#define H5C__UPDATE_STATS_FOR_PIN(cache_ptr, entry_ptr)    \
{                                                          \
    (cache_ptr)->pins[(entry_ptr)->type->id]++;            \
    if ((cache_ptr)->pel_len > (cache_ptr)->max_pel_len)   \
        (cache_ptr)->max_pel_len = (cache_ptr)->pel_len;   \
    if ((cache_ptr)->pel_size > (cache_ptr)->max_pel_size) \
        (cache_ptr)->max_pel_size = (cache_ptr)->pel_size; \
}

#endif /* H5C_COLLECT_CACHE_ENTRY_STATS */

#else /* H5C_COLLECT_CACHE_STATS */

#define H5C__RESET_CACHE_ENTRY_STATS(entry_ptr)
#define H5C__UPDATE_STATS_FOR_DIRTY_PIN(cache_ptr, entry_ptr)
#define H5C__UPDATE_STATS_FOR_UNPROTECT(cache_ptr)
#define H5C__UPDATE_STATS_FOR_MOVE(cache_ptr, entry_ptr)
#define H5C__UPDATE_STATS_FOR_ENTRY_SIZE_CHANGE(cache_ptr, entry_ptr, new_size)
#define H5C__UPDATE_STATS_FOR_HT_INSERTION(cache_ptr)
#define H5C__UPDATE_STATS_FOR_HT_DELETION(cache_ptr)
#define H5C__UPDATE_STATS_FOR_HT_SEARCH(cache_ptr, success, depth)
#define H5C__UPDATE_STATS_FOR_INSERTION(cache_ptr, entry_ptr)
#define H5C__UPDATE_STATS_FOR_CLEAR(cache_ptr, entry_ptr)                       {}
#define H5C__UPDATE_STATS_FOR_FLUSH(cache_ptr, entry_ptr)
#define H5C__UPDATE_STATS_FOR_EVICTION(cache_ptr, entry_ptr, take_ownership)
#define H5C__UPDATE_STATS_FOR_PROTECT(cache_ptr, entry_ptr, hit)
#define H5C__UPDATE_STATS_FOR_PIN(cache_ptr, entry_ptr)
#define H5C__UPDATE_STATS_FOR_UNPIN(cache_ptr, entry_ptr)
#define H5C__UPDATE_STATS_FOR_PREFETCH(cache_ptr, dirty)
#define H5C__UPDATE_STATS_FOR_PREFETCH_HIT(cache_ptr)
#define H5C__UPDATE_STATS_FOR_SLIST_SCAN_RESTART(cache_ptr)
#define H5C__UPDATE_STATS_FOR_LRU_SCAN_RESTART(cache_ptr)
#define H5C__UPDATE_STATS_FOR_INDEX_SCAN_RESTART(cache_ptr)

#endif /* H5C_COLLECT_CACHE_STATS */


/***********************************************************************
 *
 * Hash table access and manipulation macros:
 *
 * The following macros handle searches, insertions, and deletion in
 * the hash table.
 *
 ***********************************************************************/

#define H5C__HASH_MASK      ((size_t)(H5C__HASH_TABLE_LEN - 1) << 3)
#define H5C__HASH_FCN(x)    (int)((unsigned)((x) & H5C__HASH_MASK) >> 3)

#define H5C__POST_HT_SHIFT_TO_FRONT_SC_CMP(cache_ptr, entry_ptr, k) \
((cache_ptr) == NULL || (cache_ptr)->index[k] != (entry_ptr) ||     \
     (entry_ptr)->ht_prev != NULL                                   \
)
#define H5C__PRE_HT_SEARCH_SC_CMP(cache_ptr, entry_addr)                  \
((cache_ptr) == NULL ||                                                   \
    (cache_ptr)->index_size !=                                            \
       ((cache_ptr)->clean_index_size + (cache_ptr)->dirty_index_size) || \
    !H5_addr_defined(entry_addr) ||                                      \
    H5C__HASH_FCN(entry_addr) < 0 ||                                      \
    H5C__HASH_FCN(entry_addr) >= H5C__HASH_TABLE_LEN                      \
)
#define H5C__POST_SUC_HT_SEARCH_SC_CMP(cache_ptr, entry_ptr, k)               \
((cache_ptr) == NULL || (cache_ptr)->index_len < 1 ||                         \
    (entry_ptr) == NULL ||                                                    \
    (cache_ptr)->index_size < (entry_ptr)->size ||                            \
    (cache_ptr)->index_size !=                                                \
       ((cache_ptr)->clean_index_size + (cache_ptr)->dirty_index_size) ||     \
    (entry_ptr)->size <= 0 ||                                                 \
    (cache_ptr)->index[k] == NULL ||                                          \
    ((cache_ptr)->index[k] != (entry_ptr) && (entry_ptr)->ht_prev == NULL) || \
    ((cache_ptr)->index[k] == (entry_ptr) && (entry_ptr)->ht_prev != NULL) || \
    ((entry_ptr)->ht_prev != NULL && (entry_ptr)->ht_prev->ht_next != (entry_ptr)) || \
    ((entry_ptr)->ht_next != NULL && (entry_ptr)->ht_next->ht_prev != (entry_ptr)) \
)

#ifdef H5C_DO_SANITY_CHECKS

#define H5C__PRE_HT_INSERT_SC(cache_ptr, entry_ptr, fail_val)           \
if ((cache_ptr) == NULL ||                                              \
     (entry_ptr) == NULL || !H5_addr_defined((entry_ptr)->addr) ||     \
     (entry_ptr)->ht_next != NULL || (entry_ptr)->ht_prev != NULL ||    \
     (entry_ptr)->size <= 0 ||                                          \
     H5C__HASH_FCN((entry_ptr)->addr) < 0 ||                            \
     H5C__HASH_FCN((entry_ptr)->addr) >= H5C__HASH_TABLE_LEN ||         \
     (cache_ptr)->index_size !=                                         \
       ((cache_ptr)->clean_index_size + (cache_ptr)->dirty_index_size) || \
     (cache_ptr)->index_size < (cache_ptr)->clean_index_size ||         \
     (cache_ptr)->index_size < (cache_ptr)->dirty_index_size ||         \
     (entry_ptr)->ring <= H5C_RING_UNDEFINED ||                         \
     (entry_ptr)->ring >= H5C_RING_NTYPES ||                            \
     (cache_ptr)->index_ring_len[(entry_ptr)->ring] > (cache_ptr)->index_len || \
     (cache_ptr)->index_ring_size[(entry_ptr)->ring] > (cache_ptr)->index_size || \
     (cache_ptr)->index_ring_size[(entry_ptr)->ring] !=                 \
       ((cache_ptr)->clean_index_ring_size[(entry_ptr)->ring] +         \
        (cache_ptr)->dirty_index_ring_size[(entry_ptr)->ring]) ||       \
     (cache_ptr)->index_len != (cache_ptr)->il_len ||                   \
     (cache_ptr)->index_size != (cache_ptr)->il_size                    \
    ) {                                                                 \
    HGOTO_ERROR(H5E_CACHE, H5E_SYSTEM, fail_val, "pre HT insert SC failed") \
}

#define H5C__POST_HT_INSERT_SC(cache_ptr, entry_ptr, fail_val)          \
if ((cache_ptr) == NULL ||                                              \
     (cache_ptr)->index_size !=                                         \
       ((cache_ptr)->clean_index_size + (cache_ptr)->dirty_index_size) || \
     (cache_ptr)->index_size < (cache_ptr)->clean_index_size ||         \
     (cache_ptr)->index_size < (cache_ptr)->dirty_index_size ||         \
     (cache_ptr)->index_ring_len[(entry_ptr)->ring] == 0 ||             \
     (cache_ptr)->index_ring_len[(entry_ptr)->ring] > (cache_ptr)->index_len || \
     (cache_ptr)->index_ring_size[(entry_ptr)->ring] > (cache_ptr)->index_size || \
     (cache_ptr)->index_ring_size[(entry_ptr)->ring] !=                 \
       ((cache_ptr)->clean_index_ring_size[(entry_ptr)->ring] +         \
        (cache_ptr)->dirty_index_ring_size[(entry_ptr)->ring]) ||       \
     (cache_ptr)->index_len != (cache_ptr)->il_len ||                   \
     (cache_ptr)->index_size != (cache_ptr)->il_size                    \
    ) {                                                                 \
    HGOTO_ERROR(H5E_CACHE, H5E_SYSTEM, fail_val, "post HT insert SC failed") \
}

#define H5C__PRE_HT_REMOVE_SC(cache_ptr, entry_ptr, fail_val)           \
if ( (cache_ptr) == NULL || (cache_ptr)->index_len < 1 ||               \
     (entry_ptr) == NULL ||                                             \
     (cache_ptr)->index_size < (entry_ptr)->size ||                     \
     !H5_addr_defined((entry_ptr)->addr) ||                            \
     (entry_ptr)->size <= 0 ||                                          \
     H5C__HASH_FCN((entry_ptr)->addr) < 0 ||                            \
     H5C__HASH_FCN((entry_ptr)->addr) >= H5C__HASH_TABLE_LEN ||         \
     (cache_ptr)->index[H5C__HASH_FCN((entry_ptr)->addr)] == NULL ||    \
     ((cache_ptr)->index[H5C__HASH_FCN((entry_ptr)->addr)] != (entry_ptr) && \
       (entry_ptr)->ht_prev == NULL) ||                                 \
     ((cache_ptr)->index[H5C__HASH_FCN((entry_ptr)->addr)] == (entry_ptr) && \
       (entry_ptr)->ht_prev != NULL) ||                                 \
     (cache_ptr)->index_size !=                                         \
       ((cache_ptr)->clean_index_size + (cache_ptr)->dirty_index_size) || \
     (cache_ptr)->index_size < (cache_ptr)->clean_index_size ||         \
     (cache_ptr)->index_size < (cache_ptr)->dirty_index_size ||         \
     (entry_ptr)->ring <= H5C_RING_UNDEFINED ||                         \
     (entry_ptr)->ring >= H5C_RING_NTYPES ||                            \
     (cache_ptr)->index_ring_len[(entry_ptr)->ring] <= 0 ||             \
     (cache_ptr)->index_ring_len[(entry_ptr)->ring] > (cache_ptr)->index_len || \
     (cache_ptr)->index_ring_size[(entry_ptr)->ring] < (entry_ptr)->size || \
     (cache_ptr)->index_ring_size[(entry_ptr)->ring] > (cache_ptr)->index_size || \
     (cache_ptr)->index_ring_size[(entry_ptr)->ring] !=                 \
       ((cache_ptr)->clean_index_ring_size[(entry_ptr)->ring] +         \
        (cache_ptr)->dirty_index_ring_size[(entry_ptr)->ring]) ||       \
     (cache_ptr)->index_len != (cache_ptr)->il_len ||                   \
     (cache_ptr)->index_size != (cache_ptr)->il_size                    \
   ) {                                                                  \
    HGOTO_ERROR(H5E_CACHE, H5E_SYSTEM, (fail_val), "pre HT remove SC failed") \
}

#define H5C__POST_HT_REMOVE_SC(cache_ptr, entry_ptr, fail_val)            \
if ((cache_ptr) == NULL ||                                                \
     (entry_ptr) == NULL || !H5_addr_defined((entry_ptr)->addr) ||       \
     (entry_ptr)->size <= 0 ||                                            \
     (entry_ptr)->ht_next != NULL ||                                      \
     (entry_ptr)->ht_prev != NULL ||                                      \
     (cache_ptr)->index_size !=                                           \
       ((cache_ptr)->clean_index_size + (cache_ptr)->dirty_index_size) || \
     (cache_ptr)->index_size < (cache_ptr)->clean_index_size ||           \
     (cache_ptr)->index_size < (cache_ptr)->dirty_index_size ||           \
     (cache_ptr)->index_ring_len[(entry_ptr)->ring] > (cache_ptr)->index_len || \
     (cache_ptr)->index_ring_size[(entry_ptr)->ring] > (cache_ptr)->index_size || \
     (cache_ptr)->index_ring_size[(entry_ptr)->ring] !=                   \
       ((cache_ptr)->clean_index_ring_size[(entry_ptr)->ring] +           \
        (cache_ptr)->dirty_index_ring_size[(entry_ptr)->ring]) ||         \
     (cache_ptr)->index_len != (cache_ptr)->il_len ||                     \
     (cache_ptr)->index_size != (cache_ptr)->il_size                      \
   ) {                                                                    \
    HGOTO_ERROR(H5E_CACHE, H5E_SYSTEM, (fail_val), "post HT remove SC failed") \
}

#define H5C__PRE_HT_SEARCH_SC(cache_ptr, entry_addr, fail_val)            \
if (H5C__PRE_HT_SEARCH_SC_CMP(cache_ptr, entry_addr)) {                   \
    HGOTO_ERROR(H5E_CACHE, H5E_SYSTEM, (fail_val), "pre HT search SC failed") \
}

#define H5C__POST_SUC_HT_SEARCH_SC(cache_ptr, entry_ptr, k, fail_val)       \
if(H5C__POST_SUC_HT_SEARCH_SC_CMP(cache_ptr, entry_ptr, k)) {               \
    HGOTO_ERROR(H5E_CACHE, H5E_SYSTEM, (fail_val), "post successful HT search SC failed") \
}

#define H5C__POST_HT_SHIFT_TO_FRONT_SC(cache_ptr, entry_ptr, k, fail_val) \
if(H5C__POST_HT_SHIFT_TO_FRONT_SC_CMP(cache_ptr, entry_ptr, k)) {         \
    HGOTO_ERROR(H5E_CACHE, H5E_SYSTEM, (fail_val), "post HT shift to front SC failed") \
}

#define H5C__PRE_HT_ENTRY_SIZE_CHANGE_SC(cache_ptr, old_size, new_size,   \
                                entry_ptr, was_clean, fail_val)           \
if ((cache_ptr) == NULL ||                                                \
     (cache_ptr)->index_len <= 0 || (cache_ptr)->index_size <= 0 ||       \
     (new_size) <= 0 || (old_size) > (cache_ptr)->index_size ||           \
     ((cache_ptr)->index_len == 1 && (cache_ptr)->index_size != (old_size)) || \
     (cache_ptr)->index_size !=                                           \
       ((cache_ptr)->clean_index_size + (cache_ptr)->dirty_index_size) || \
     (cache_ptr)->index_size < (cache_ptr)->clean_index_size ||           \
     (cache_ptr)->index_size < (cache_ptr)->dirty_index_size ||           \
     ((!(was_clean) || (cache_ptr)->clean_index_size < (old_size)) &&     \
        ((was_clean) || (cache_ptr)->dirty_index_size < (old_size))) ||   \
     (entry_ptr) == NULL ||                                               \
     (entry_ptr)->ring <= H5C_RING_UNDEFINED ||                           \
     (entry_ptr)->ring >= H5C_RING_NTYPES ||                              \
     (cache_ptr)->index_ring_len[(entry_ptr)->ring] <= 0 ||               \
     (cache_ptr)->index_ring_len[(entry_ptr)->ring] > (cache_ptr)->index_len || \
     (cache_ptr)->index_ring_size[(entry_ptr)->ring] > (cache_ptr)->index_size || \
     (cache_ptr)->index_ring_size[(entry_ptr)->ring] !=                   \
       ((cache_ptr)->clean_index_ring_size[(entry_ptr)->ring] +           \
        (cache_ptr)->dirty_index_ring_size[(entry_ptr)->ring]) ||         \
     (cache_ptr)->index_len != (cache_ptr)->il_len ||                     \
     (cache_ptr)->index_size != (cache_ptr)->il_size                      \
   ) {                                                                    \
    HGOTO_ERROR(H5E_CACHE, H5E_SYSTEM, (fail_val), "pre HT entry size change SC failed") \
}

#define H5C__POST_HT_ENTRY_SIZE_CHANGE_SC(cache_ptr, old_size, new_size,    \
                                entry_ptr, fail_val)                        \
if ((cache_ptr) == NULL ||                                                  \
    (cache_ptr)->index_len <= 0 || (cache_ptr)->index_size <= 0 ||          \
    (new_size) > (cache_ptr)->index_size ||                                 \
    (cache_ptr)->index_size !=                                              \
        ((cache_ptr)->clean_index_size + (cache_ptr)->dirty_index_size) ||  \
    (cache_ptr)->index_size < (cache_ptr)->clean_index_size ||              \
    (cache_ptr)->index_size < (cache_ptr)->dirty_index_size ||              \
    ((!((entry_ptr)->is_dirty ) || (cache_ptr)->dirty_index_size < (new_size)) && \
      ((entry_ptr)->is_dirty || (cache_ptr)->clean_index_size < (new_size)) \
    ) ||                                                                    \
    ((cache_ptr)->index_len == 1 && (cache_ptr)->index_size != (new_size)) || \
    (cache_ptr)->index_ring_len[(entry_ptr)->ring] > (cache_ptr)->index_len || \
    (cache_ptr)->index_ring_size[(entry_ptr)->ring] > (cache_ptr)->index_size || \
    (cache_ptr)->index_ring_size[(entry_ptr)->ring] !=                      \
       ((cache_ptr)->clean_index_ring_size[(entry_ptr)->ring] +             \
        (cache_ptr)->dirty_index_ring_size[(entry_ptr)->ring]) ||           \
    (cache_ptr)->index_len != (cache_ptr)->il_len ||                        \
    (cache_ptr)->index_size != (cache_ptr)->il_size                         \
  ) {                                                                       \
    HGOTO_ERROR(H5E_CACHE, H5E_SYSTEM, (fail_val), "post HT entry size change SC failed") \
}

#define H5C__PRE_HT_UPDATE_FOR_ENTRY_CLEAN_SC(cache_ptr, entry_ptr, fail_val) \
if ((cache_ptr) == NULL || (cache_ptr)->index_len <= 0 ||                     \
    (entry_ptr) == NULL || (entry_ptr)->is_dirty != FALSE ||                  \
    (cache_ptr)->index_size < (entry_ptr)->size ||                            \
    (cache_ptr)->dirty_index_size < (entry_ptr)->size ||                      \
    (cache_ptr)->index_size != ((cache_ptr)->clean_index_size + (cache_ptr)->dirty_index_size) || \
    (cache_ptr)->index_size < ((cache_ptr)->clean_index_size) ||              \
    (cache_ptr)->index_size < ((cache_ptr)->dirty_index_size) ||              \
    (entry_ptr)->ring <= H5C_RING_UNDEFINED ||                                \
    (entry_ptr)->ring >= H5C_RING_NTYPES ||                                   \
    (cache_ptr)->index_ring_len[(entry_ptr)->ring] <= 0 ||                    \
    (cache_ptr)->index_ring_len[(entry_ptr)->ring] > (cache_ptr)->index_len || \
    (cache_ptr)->index_ring_size[(entry_ptr)->ring] > (cache_ptr)->index_size || \
    (cache_ptr)->index_ring_size[(entry_ptr)->ring] !=                        \
      ((cache_ptr)->clean_index_ring_size[(entry_ptr)->ring] +                \
       (cache_ptr)->dirty_index_ring_size[(entry_ptr)->ring])                 \
  ) {                                                                         \
    HGOTO_ERROR(H5E_CACHE, H5E_SYSTEM, (fail_val), "pre HT update for entry clean SC failed") \
}

#define H5C__PRE_HT_UPDATE_FOR_ENTRY_DIRTY_SC(cache_ptr, entry_ptr, fail_val) \
if ((cache_ptr) == NULL || (cache_ptr)->index_len <= 0 ||                     \
    (entry_ptr) == NULL || (entry_ptr)->is_dirty != TRUE ||                   \
    (cache_ptr)->index_size < (entry_ptr)->size ||                            \
    (cache_ptr)->clean_index_size < (entry_ptr)->size ||                      \
    (cache_ptr)->index_size != ((cache_ptr)->clean_index_size + (cache_ptr)->dirty_index_size) ||   \
    (cache_ptr)->index_size < (cache_ptr)->clean_index_size ||                \
    (cache_ptr)->index_size < (cache_ptr)->dirty_index_size ||                \
    (entry_ptr)->ring <= H5C_RING_UNDEFINED ||                                \
    (entry_ptr)->ring >= H5C_RING_NTYPES ||                                   \
    (cache_ptr)->index_ring_len[(entry_ptr)->ring] <= 0 ||                    \
    (cache_ptr)->index_ring_len[(entry_ptr)->ring] > (cache_ptr)->index_len || \
    (cache_ptr)->index_ring_size[(entry_ptr)->ring] > (cache_ptr)->index_size || \
    (cache_ptr)->index_ring_size[(entry_ptr)->ring] !=                        \
      ((cache_ptr)->clean_index_ring_size[(entry_ptr)->ring] +                \
       (cache_ptr)->dirty_index_ring_size[(entry_ptr)->ring])                 \
  ) {                                                                         \
    HGOTO_ERROR(H5E_CACHE, H5E_SYSTEM, (fail_val), "pre HT update for entry dirty SC failed") \
}

#define H5C__POST_HT_UPDATE_FOR_ENTRY_CLEAN_SC(cache_ptr, entry_ptr, fail_val) \
if ((cache_ptr)->index_size != ((cache_ptr)->clean_index_size + (cache_ptr)->dirty_index_size) || \
    (cache_ptr)->index_size < (cache_ptr)->clean_index_size ||                \
    (cache_ptr)->index_size < (cache_ptr)->dirty_index_size ||                \
    (cache_ptr)->index_ring_len[(entry_ptr)->ring] > (cache_ptr)->index_len || \
    (cache_ptr)->index_ring_size[(entry_ptr)->ring] > (cache_ptr)->index_size || \
    (cache_ptr)->index_ring_size[(entry_ptr)->ring] !=                        \
       ((cache_ptr)->clean_index_ring_size[(entry_ptr)->ring] +               \
        (cache_ptr)->dirty_index_ring_size[(entry_ptr)->ring])                \
  ) {                                                                         \
    HGOTO_ERROR(H5E_CACHE, H5E_SYSTEM, (fail_val), "post HT update for entry clean SC failed") \
}

#define H5C__POST_HT_UPDATE_FOR_ENTRY_DIRTY_SC(cache_ptr, entry_ptr, fail_val) \
if ((cache_ptr)->index_size != ((cache_ptr)->clean_index_size + (cache_ptr)->dirty_index_size) || \
    (cache_ptr)->index_size < (cache_ptr)->clean_index_size ||                \
    (cache_ptr)->index_size < (cache_ptr)->dirty_index_size ||                \
    (cache_ptr)->index_ring_len[(entry_ptr)->ring] > (cache_ptr)->index_len || \
    (cache_ptr)->index_ring_size[(entry_ptr)->ring] > (cache_ptr)->index_size || \
    (cache_ptr)->index_ring_size[(entry_ptr)->ring] !=                        \
       ((cache_ptr)->clean_index_ring_size[(entry_ptr)->ring] +               \
        (cache_ptr)->dirty_index_ring_size[(entry_ptr)->ring])                \
  ) {                                                                         \
    HGOTO_ERROR(H5E_CACHE, H5E_SYSTEM, (fail_val), "post HT update for entry dirty SC failed") \
}

#else /* H5C_DO_SANITY_CHECKS */

#define H5C__PRE_HT_INSERT_SC(cache_ptr, entry_ptr, fail_val)
#define H5C__POST_HT_INSERT_SC(cache_ptr, entry_ptr, fail_val)
#define H5C__PRE_HT_REMOVE_SC(cache_ptr, entry_ptr, fail_val)
#define H5C__POST_HT_REMOVE_SC(cache_ptr, entry_ptr, fail_val)
#define H5C__PRE_HT_SEARCH_SC(cache_ptr, entry_addr, fail_val)
#define H5C__POST_SUC_HT_SEARCH_SC(cache_ptr, entry_ptr, k, fail_val)
#define H5C__POST_HT_SHIFT_TO_FRONT_SC(cache_ptr, entry_ptr, k, fail_val)
#define H5C__PRE_HT_UPDATE_FOR_ENTRY_CLEAN_SC(cache_ptr, entry_ptr, fail_val)
#define H5C__PRE_HT_UPDATE_FOR_ENTRY_DIRTY_SC(cache_ptr, entry_ptr, fail_val)
#define H5C__PRE_HT_ENTRY_SIZE_CHANGE_SC(cache_ptr, old_size, new_size, entry_ptr, was_clean, fail_val)
#define H5C__POST_HT_ENTRY_SIZE_CHANGE_SC(cache_ptr, old_size, new_size, entry_ptr, fail_val)
#define H5C__POST_HT_UPDATE_FOR_ENTRY_CLEAN_SC(cache_ptr, entry_ptr, fail_val)
#define H5C__POST_HT_UPDATE_FOR_ENTRY_DIRTY_SC(cache_ptr, entry_ptr, fail_val)

#endif /* H5C_DO_SANITY_CHECKS */


#define H5C__INSERT_IN_INDEX(cache_ptr, entry_ptr, fail_val)                 \
do {                                                                         \
    int k;                                                                   \
    H5C__PRE_HT_INSERT_SC(cache_ptr, entry_ptr, fail_val)                    \
    k = H5C__HASH_FCN((entry_ptr)->addr);                                    \
    if((cache_ptr)->index[k] != NULL) {                                      \
        (entry_ptr)->ht_next = (cache_ptr)->index[k];                        \
        (entry_ptr)->ht_next->ht_prev = (entry_ptr);                         \
    }                                                                        \
    (cache_ptr)->index[k] = (entry_ptr);                                     \
    (cache_ptr)->index_len++;                                                \
    (cache_ptr)->index_size += (entry_ptr)->size;                            \
    (cache_ptr)->index_ring_len[(entry_ptr)->ring]++;                        \
    (cache_ptr)->index_ring_size[(entry_ptr)->ring] += (entry_ptr)->size;    \
    if((entry_ptr)->is_dirty) {                                              \
        (cache_ptr)->dirty_index_size += (entry_ptr)->size;                  \
        (cache_ptr)->dirty_index_ring_size[(entry_ptr)->ring] += (entry_ptr)->size; \
    } else {                                                                 \
        (cache_ptr)->clean_index_size += (entry_ptr)->size;                  \
        (cache_ptr)->clean_index_ring_size[(entry_ptr)->ring] += (entry_ptr)->size; \
    }                                                                        \
    if((entry_ptr)->flush_me_last) {                                         \
        (cache_ptr)->num_last_entries++;                                     \
        HDassert((cache_ptr)->num_last_entries <= 2);                        \
    }                                                                        \
    H5C__IL_DLL_APPEND((entry_ptr), (cache_ptr)->il_head,                    \
                       (cache_ptr)->il_tail, (cache_ptr)->il_len,            \
                       (cache_ptr)->il_size, fail_val)                       \
    H5C__UPDATE_STATS_FOR_HT_INSERTION(cache_ptr)                            \
    H5C__POST_HT_INSERT_SC(cache_ptr, entry_ptr, fail_val)                   \
} while (0)

#define H5C__DELETE_FROM_INDEX(cache_ptr, entry_ptr, fail_val)               \
do {                                                                         \
    int k;                                                                   \
    H5C__PRE_HT_REMOVE_SC(cache_ptr, entry_ptr, fail_val)                    \
    k = H5C__HASH_FCN((entry_ptr)->addr);                                    \
    if((entry_ptr)->ht_next)                                                 \
        (entry_ptr)->ht_next->ht_prev = (entry_ptr)->ht_prev;                \
    if((entry_ptr)->ht_prev)                                                 \
        (entry_ptr)->ht_prev->ht_next = (entry_ptr)->ht_next;                \
    if((cache_ptr)->index[k] == (entry_ptr))                                 \
        (cache_ptr)->index[k] = (entry_ptr)->ht_next;                        \
    (entry_ptr)->ht_next = NULL;                                             \
    (entry_ptr)->ht_prev = NULL;                                             \
    (cache_ptr)->index_len--;                                                \
    (cache_ptr)->index_size -= (entry_ptr)->size;                            \
    (cache_ptr)->index_ring_len[(entry_ptr)->ring]--;                        \
    (cache_ptr)->index_ring_size[(entry_ptr)->ring] -= (entry_ptr)->size;    \
    if((entry_ptr)->is_dirty) {                                              \
        (cache_ptr)->dirty_index_size -= (entry_ptr)->size;                  \
        (cache_ptr)->dirty_index_ring_size[(entry_ptr)->ring] -= (entry_ptr)->size; \
    } else {                                                                 \
        (cache_ptr)->clean_index_size -= (entry_ptr)->size;                  \
        (cache_ptr)->clean_index_ring_size[(entry_ptr)->ring] -= (entry_ptr)->size; \
    }                                                                        \
    if((entry_ptr)->flush_me_last) {                                         \
        (cache_ptr)->num_last_entries--;                                     \
        HDassert((cache_ptr)->num_last_entries <= 1);                        \
    }                                                                        \
    H5C__IL_DLL_REMOVE((entry_ptr), (cache_ptr)->il_head,                    \
                       (cache_ptr)->il_tail, (cache_ptr)->il_len,            \
                       (cache_ptr)->il_size, fail_val)                       \
    H5C__UPDATE_STATS_FOR_HT_DELETION(cache_ptr)                             \
    H5C__POST_HT_REMOVE_SC(cache_ptr, entry_ptr, fail_val)                   \
} while (0)

#define H5C__SEARCH_INDEX(cache_ptr, entry_addr, entry_ptr, fail_val)        \
{                                                                            \
    int k;                                                                   \
    int depth = 0;                                                           \
    H5C__PRE_HT_SEARCH_SC(cache_ptr, entry_addr, fail_val)                   \
    k = H5C__HASH_FCN(entry_addr);                                           \
    (entry_ptr) = (cache_ptr)->index[k];                                     \
    while(entry_ptr) {                                                       \
        if(H5_addr_eq(entry_addr, (entry_ptr)->addr)) {                     \
            H5C__POST_SUC_HT_SEARCH_SC(cache_ptr, entry_ptr, k, fail_val)    \
            if((entry_ptr) != (cache_ptr)->index[k]) {                       \
                if((entry_ptr)->ht_next)                                     \
                    (entry_ptr)->ht_next->ht_prev = (entry_ptr)->ht_prev;    \
                HDassert((entry_ptr)->ht_prev != NULL);                      \
                (entry_ptr)->ht_prev->ht_next = (entry_ptr)->ht_next;        \
                (cache_ptr)->index[k]->ht_prev = (entry_ptr);                \
                (entry_ptr)->ht_next = (cache_ptr)->index[k];                \
                (entry_ptr)->ht_prev = NULL;                                 \
                (cache_ptr)->index[k] = (entry_ptr);                         \
                H5C__POST_HT_SHIFT_TO_FRONT_SC(cache_ptr, entry_ptr, k, fail_val) \
            }                                                                \
            break;                                                           \
        }                                                                    \
        (entry_ptr) = (entry_ptr)->ht_next;                                  \
        (depth)++;                                                           \
    }                                                                        \
    H5C__UPDATE_STATS_FOR_HT_SEARCH(cache_ptr, ((entry_ptr) != NULL), depth) \
}

#define H5C__UPDATE_INDEX_FOR_ENTRY_CLEAN(cache_ptr, entry_ptr, fail_val)  \
{                                                                          \
    H5C__PRE_HT_UPDATE_FOR_ENTRY_CLEAN_SC(cache_ptr, entry_ptr, fail_val)  \
    (cache_ptr)->dirty_index_size -= (entry_ptr)->size;                    \
    (cache_ptr)->dirty_index_ring_size[(entry_ptr)->ring] -= (entry_ptr)->size; \
    (cache_ptr)->clean_index_size += (entry_ptr)->size;                    \
    (cache_ptr)->clean_index_ring_size[(entry_ptr)->ring] += (entry_ptr)->size; \
    H5C__POST_HT_UPDATE_FOR_ENTRY_CLEAN_SC(cache_ptr, entry_ptr, fail_val) \
}

#define H5C__UPDATE_INDEX_FOR_ENTRY_DIRTY(cache_ptr, entry_ptr, fail_val)  \
{                                                                          \
    H5C__PRE_HT_UPDATE_FOR_ENTRY_DIRTY_SC(cache_ptr, entry_ptr, fail_val)  \
    (cache_ptr)->clean_index_size -= (entry_ptr)->size;                    \
    (cache_ptr)->clean_index_ring_size[(entry_ptr)->ring] -= (entry_ptr)->size; \
    (cache_ptr)->dirty_index_size += (entry_ptr)->size;                    \
    (cache_ptr)->dirty_index_ring_size[(entry_ptr)->ring] += (entry_ptr)->size; \
    H5C__POST_HT_UPDATE_FOR_ENTRY_DIRTY_SC(cache_ptr, entry_ptr, fail_val) \
}

#define H5C__UPDATE_INDEX_FOR_SIZE_CHANGE(cache_ptr, old_size, new_size,    \
                                entry_ptr, was_clean, fail_val)             \
{                                                                           \
    H5C__PRE_HT_ENTRY_SIZE_CHANGE_SC(cache_ptr, old_size, new_size,         \
                            entry_ptr, was_clean, fail_val)                 \
    (cache_ptr)->index_size -= (old_size);                                  \
    (cache_ptr)->index_size += (new_size);                                  \
    (cache_ptr)->index_ring_size[(entry_ptr)->ring] -= (old_size);          \
    (cache_ptr)->index_ring_size[(entry_ptr)->ring] += (new_size);          \
    if(was_clean) {                                                         \
        (cache_ptr)->clean_index_size -= (old_size);                        \
        (cache_ptr)->clean_index_ring_size[(entry_ptr)->ring] -= (old_size); \
    } else {                                                                \
        (cache_ptr)->dirty_index_size -= (old_size);                        \
        (cache_ptr)->dirty_index_ring_size[(entry_ptr)->ring] -= (old_size); \
    }                                                                       \
    if((entry_ptr)->is_dirty) {                                             \
        (cache_ptr)->dirty_index_size += (new_size);                        \
        (cache_ptr)->dirty_index_ring_size[(entry_ptr)->ring] += (new_size); \
    } else {                                                                \
        (cache_ptr)->clean_index_size += (new_size);                        \
        (cache_ptr)->clean_index_ring_size[(entry_ptr)->ring] += (new_size); \
    }                                                                       \
    H5C__DLL_UPDATE_FOR_SIZE_CHANGE((cache_ptr)->il_len,                    \
                                    (cache_ptr)->il_size,                   \
                                    (old_size), (new_size), (fail_val))     \
    H5C__POST_HT_ENTRY_SIZE_CHANGE_SC(cache_ptr, old_size, new_size,        \
                                      entry_ptr, fail_val)                  \
} while (0)


/**************************************************************************
 *
 * Skip list modification macros
 *
 **************************************************************************/

#ifdef H5C_DO_SLIST_SANITY_CHECKS

#define H5C__ENTRY_IN_SLIST(cache_ptr, entry_ptr) \
    H5C__entry_in_skip_list((cache_ptr), (entry_ptr))

#else /* H5C_DO_SLIST_SANITY_CHECKS */

#define H5C__ENTRY_IN_SLIST(cache_ptr, entry_ptr) FALSE

#endif /* H5C_DO_SLIST_SANITY_CHECKS */


#ifdef H5C_DO_SANITY_CHECKS

#define H5C__SLIST_INSERT_ENTRY_SC(cache_ptr, entry_ptr)              \
{                                                                     \
    (cache_ptr)->slist_len_increase++;                                \
    (cache_ptr)->slist_size_increase += (int64_t)((entry_ptr)->size); \
} /* H5C__SLIST_INSERT_ENTRY_SC() */
#define H5C__SLIST_REMOVE_ENTRY_SC(cache_ptr, entry_ptr)              \
{                                                                     \
    (cache_ptr)->slist_len_increase--;                                \
    (cache_ptr)->slist_size_increase -= (int64_t)((entry_ptr)->size); \
} /* H5C__SLIST_REMOVE_ENTRY_SC() */
#define H5C__SLIST_UPDATE_FOR_ENTRY_SIZE_CHANGE_SC(cache_ptr, old_size, new_size) \
{                                                                     \
    (cache_ptr)->slist_size_increase -= (int64_t)(old_size);          \
    (cache_ptr)->slist_size_increase += (int64_t)(new_size);          \
} /* H5C__SLIST_UPDATE_FOR_ENTRY_SIZE_CHANGE_SC() */

#else /* H5C_DO_SANITY_CHECKS */

#define H5C__SLIST_INSERT_ENTRY_SC(cache_ptr, entry_ptr)
#define H5C__SLIST_REMOVE_ENTRY_SC(cache_ptr, entry_ptr)
#define H5C__SLIST_UPDATE_FOR_ENTRY_SIZE_CHANGE_SC(cache_ptr, old_size, new_size)

#endif /* H5C_DO_SANITY_CHECKS */


/*-------------------------------------------------------------------------
 *
 * Macro:       H5C__INSERT_ENTRY_IN_SLIST
 *
 * Purpose:     Insert a cache entry into a cache's skip list.  Updates
 *              the associated length and size fields.
 *
 * Note:        This macro is set up so that H5C_DO_SANITY_CHECKS and
 *              H5C_DO_SLIST_SANITY_CHECKS can be selected independently.
 *
 * Programmer:  John Mainzer, 5/10/04
 *
 *-------------------------------------------------------------------------
 */

#define H5C__INSERT_ENTRY_IN_SLIST(cache_ptr, entry_ptr, fail_val)             \
do {                                                                           \
    HDassert(cache_ptr);                                                       \
                                                                               \
    if((cache_ptr)->slist_enabled) {                                           \
        HDassert(entry_ptr);                                                   \
        HDassert((entry_ptr)->size > 0);                                       \
        HDassert(H5_addr_defined((entry_ptr)->addr));                         \
        HDassert(!(entry_ptr)->in_slist);                                      \
        HDassert(!H5C__ENTRY_IN_SLIST((cache_ptr), (entry_ptr)));              \
        HDassert((entry_ptr)->ring > H5C_RING_UNDEFINED);                      \
        HDassert((entry_ptr)->ring < H5C_RING_NTYPES);                         \
        HDassert((cache_ptr)->slist_ring_len[(entry_ptr)->ring] <=             \
                 (cache_ptr)->slist_len);                                      \
        HDassert((cache_ptr)->slist_ring_size[(entry_ptr)->ring] <=            \
                 (cache_ptr)->slist_size);                                     \
        HDassert((cache_ptr)->slist_ptr);                                      \
                                                                               \
        if(H5SL_insert((cache_ptr)->slist_ptr, entry_ptr, &((entry_ptr)->addr)) < 0) \
            HGOTO_ERROR(H5E_CACHE, H5E_BADVALUE, (fail_val), "can't insert entry in skip list") \
                                                                               \
        (entry_ptr)->in_slist = TRUE;                                          \
        (cache_ptr)->slist_changed = TRUE;                                     \
        (cache_ptr)->slist_len++;                                              \
        (cache_ptr)->slist_size += (entry_ptr)->size;                          \
        ((cache_ptr)->slist_ring_len[(entry_ptr)->ring])++;                    \
        ((cache_ptr)->slist_ring_size[(entry_ptr)->ring]) += (entry_ptr)->size;\
        H5C__SLIST_INSERT_ENTRY_SC(cache_ptr, entry_ptr)                       \
                                                                               \
        HDassert((cache_ptr)->slist_len > 0);                                  \
        HDassert((cache_ptr)->slist_size > 0);                                 \
    } else { /* slist disabled */                                              \
        HDassert((cache_ptr)->slist_len == 0);                                 \
        HDassert((cache_ptr)->slist_size == 0);                                \
    }                                                                          \
} while (0) /* H5C__INSERT_ENTRY_IN_SLIST */


/*-------------------------------------------------------------------------
 *
 * Macro:       H5C__REMOVE_ENTRY_FROM_SLIST
 *
 * Purpose:     Insert a cache entry into a cache's skip list.  Updates
 *              the associated length and size fields.
 *
 * Programmer:  John Mainzer, 5/10/04
 *
 *-------------------------------------------------------------------------
 */

#define H5C__REMOVE_ENTRY_FROM_SLIST(cache_ptr, entry_ptr, during_flush, fail_val) \
{                                                                              \
    HDassert(cache_ptr);                                                       \
                                                                               \
    if((cache_ptr)->slist_enabled) {                                           \
        HDassert(entry_ptr);                                                   \
        HDassert(!(entry_ptr)->is_read_only);                                  \
        HDassert((entry_ptr)->ro_ref_count == 0);                              \
        HDassert((entry_ptr)->size > 0);                                       \
        HDassert((entry_ptr)->in_slist);                                       \
        HDassert((cache_ptr)->slist_ptr);                                      \
        HDassert((entry_ptr)->ring > H5C_RING_UNDEFINED);                      \
        HDassert((entry_ptr)->ring < H5C_RING_NTYPES);                         \
        HDassert((cache_ptr)->slist_ring_len[(entry_ptr)->ring] <=             \
                 (cache_ptr)->slist_len);                                      \
        HDassert((cache_ptr)->slist_ring_size[(entry_ptr)->ring] <=            \
                 (cache_ptr)->slist_size);                                     \
        HDassert((cache_ptr)->slist_size >= (entry_ptr)->size);                \
                                                                               \
        if(H5SL_remove((cache_ptr)->slist_ptr, &(entry_ptr)->addr) != (entry_ptr) ) \
            HGOTO_ERROR(H5E_CACHE, H5E_BADVALUE, (fail_val), "can't delete entry from skip list") \
                                                                               \
        HDassert((cache_ptr)->slist_len > 0);                                  \
        if(!(during_flush))                                                    \
            (cache_ptr)->slist_changed = TRUE;                                 \
        (cache_ptr)->slist_len--;                                              \
        HDassert((cache_ptr)->slist_size >= (entry_ptr)->size);                \
        (cache_ptr)->slist_size -= (entry_ptr)->size;                          \
        (cache_ptr)->slist_ring_len[(entry_ptr)->ring]--;                      \
        HDassert((cache_ptr)->slist_ring_size[(entry_ptr)->ring] >= (entry_ptr)->size); \
        ((cache_ptr)->slist_ring_size[(entry_ptr)->ring]) -= (entry_ptr)->size;\
        H5C__SLIST_REMOVE_ENTRY_SC(cache_ptr, entry_ptr)                       \
        (entry_ptr)->in_slist = FALSE;                                         \
    } else { /* slist disabled */                                              \
        HDassert((cache_ptr)->slist_len == 0);                                 \
        HDassert((cache_ptr)->slist_size == 0);                                \
    }                                                                          \
} /* H5C__REMOVE_ENTRY_FROM_SLIST */


/*-------------------------------------------------------------------------
 *
 * Macro:       H5C__UPDATE_SLIST_FOR_SIZE_CHANGE
 *
 * Purpose:     Update cache_ptr->slist_size for a change in the size of
 *              and entry in the slist.
 *
 * Programmer:  John Mainzer, 9/07/05
 *
 *-------------------------------------------------------------------------
 */

#define H5C__UPDATE_SLIST_FOR_SIZE_CHANGE(cache_ptr, old_size, new_size)      \
do {                                                                          \
    HDassert(cache_ptr);                                                      \
                                                                              \
    if((cache_ptr)->slist_enabled) {                                          \
        HDassert((old_size) > 0);                                             \
        HDassert((new_size) > 0);                                             \
        HDassert((old_size) <= (cache_ptr)->slist_size);                      \
        HDassert((cache_ptr)->slist_len > 0);                                 \
        HDassert((cache_ptr)->slist_len > 1 ||                                \
                 (cache_ptr)->slist_size == (old_size));                      \
        HDassert((entry_ptr)->ring > H5C_RING_UNDEFINED);                     \
        HDassert((entry_ptr)->ring < H5C_RING_NTYPES);                        \
        HDassert((cache_ptr)->slist_ring_len[(entry_ptr)->ring] <=            \
                 (cache_ptr)->slist_len);                                     \
        HDassert((cache_ptr)->slist_ring_size[(entry_ptr)->ring] <=           \
                 (cache_ptr)->slist_size);                                    \
                                                                              \
        (cache_ptr)->slist_size -= (old_size);                                \
        (cache_ptr)->slist_size += (new_size);                                \
                                                                              \
        HDassert((cache_ptr)->slist_ring_size[(entry_ptr)->ring] >= (old_size)); \
                                                                              \
        (cache_ptr)->slist_ring_size[(entry_ptr)->ring] -= (old_size);        \
        (cache_ptr)->slist_ring_size[(entry_ptr)->ring] += (new_size);        \
                                                                              \
        H5C__SLIST_UPDATE_FOR_ENTRY_SIZE_CHANGE_SC(cache_ptr, old_size, new_size) \
                                                                              \
        HDassert((new_size) <= (cache_ptr)->slist_size);                      \
        HDassert((cache_ptr)->slist_len > 1 ||                                \
                  (cache_ptr)->slist_size == (new_size));                     \
    } else { /* slist disabled */                                             \
        HDassert((cache_ptr)->slist_len == 0);                                \
        HDassert((cache_ptr)->slist_size == 0);                               \
    }                                                                         \
} while (0) /* H5C__UPDATE_SLIST_FOR_SIZE_CHANGE */


/**************************************************************************
 *
 * Replacement policy update macros
 *
 **************************************************************************/

#if H5C_MAINTAIN_CLEAN_AND_DIRTY_LRU_LISTS

#define H5C__UPDATE_RP_FOR_EVICTION_CD_LRU(cache_ptr, entry_ptr, fail_val)   \
{                                                                            \
    /* If the entry is clean when it is evicted, it should be on the         \
     * clean LRU list, if it was dirty, it should be on the dirty LRU list.  \
     * Remove it from the appropriate list according to the value of the     \
     * dirty flag.                                                           \
     */                                                                      \
    if((entry_ptr)->is_dirty) {                                              \
        H5C__AUX_DLL_REMOVE((entry_ptr), (cache_ptr)->dLRU_head_ptr,         \
                            (cache_ptr)->dLRU_tail_ptr,                      \
                            (cache_ptr)->dLRU_list_len,                      \
                            (cache_ptr)->dLRU_list_size, (fail_val))         \
    } else {                                                                 \
        H5C__AUX_DLL_REMOVE((entry_ptr), (cache_ptr)->cLRU_head_ptr,         \
                            (cache_ptr)->cLRU_tail_ptr,                      \
                            (cache_ptr)->cLRU_list_len,                      \
                            (cache_ptr)->cLRU_list_size, (fail_val))         \
    }                                                                        \
} /* H5C__UPDATE_RP_FOR_EVICTION_CD_LRU() */
#define H5C__UPDATE_RP_FOR_FLUSH_CD_LRU(cache_ptr, entry_ptr, fail_val)      \
{                                                                            \
    /* An entry being flushed or cleared, may not be dirty.  Use the         \
     * dirty flag to infer whether the entry is on the clean or dirty        \
     * LRU list, and remove it.  Then insert it at the head of the           \
     * clean LRU list.                                                       \
     *                                                                       \
     * The function presumes that a dirty entry will be either cleared       \
     * or flushed shortly, so it is OK if we put a dirty entry on the        \
     * clean LRU list.                                                       \
     */                                                                      \
    if((entry_ptr)->is_dirty) {                                              \
        H5C__AUX_DLL_REMOVE((entry_ptr), (cache_ptr)->dLRU_head_ptr,         \
                            (cache_ptr)->dLRU_tail_ptr,                      \
                            (cache_ptr)->dLRU_list_len,                      \
                            (cache_ptr)->dLRU_list_size, (fail_val))         \
    } else {                                                                 \
        H5C__AUX_DLL_REMOVE((entry_ptr), (cache_ptr)->cLRU_head_ptr,         \
                            (cache_ptr)->cLRU_tail_ptr,                      \
                            (cache_ptr)->cLRU_list_len,                      \
                            (cache_ptr)->cLRU_list_size, (fail_val))         \
    }                                                                        \
                                                                             \
    H5C__AUX_DLL_PREPEND((entry_ptr), (cache_ptr)->cLRU_head_ptr,            \
                         (cache_ptr)->cLRU_tail_ptr,                         \
                         (cache_ptr)->cLRU_list_len,                         \
                         (cache_ptr)->cLRU_list_size, (fail_val))            \
} /* H5C__UPDATE_RP_FOR_FLUSH_CD_LRU() */
#define H5C__UPDATE_RP_FOR_INSERT_APPEND_CD_LRU(cache_ptr, entry_ptr, fail_val) \
{                                                                            \
    /* Insert the entry at the _tail_ of the clean or dirty LRU list as      \
     * appropriate.                                                          \
     */                                                                      \
    if((entry_ptr)->is_dirty) {                                              \
        H5C__AUX_DLL_APPEND((entry_ptr), (cache_ptr)->dLRU_head_ptr,         \
                            (cache_ptr)->dLRU_tail_ptr,                      \
                            (cache_ptr)->dLRU_list_len,                      \
                            (cache_ptr)->dLRU_list_size, (fail_val))         \
    } else {                                                                 \
        H5C__AUX_DLL_APPEND((entry_ptr), (cache_ptr)->cLRU_head_ptr,         \
                            (cache_ptr)->cLRU_tail_ptr,                      \
                            (cache_ptr)->cLRU_list_len,                      \
                            (cache_ptr)->cLRU_list_size, (fail_val))         \
    }                                                                        \
} /* H5C__UPDATE_RP_FOR_INSERT_APPEND_CD_LRU() */
#define H5C__UPDATE_RP_FOR_INSERTION_CD_LRU(cache_ptr, entry_ptr, fail_val) \
{                                                                           \
    /* Insert the entry at the head of the clean or dirty LRU list as       \
     * appropriate.                                                         \
     */                                                                     \
    if((entry_ptr)->is_dirty) {                                             \
        H5C__AUX_DLL_PREPEND((entry_ptr), (cache_ptr)->dLRU_head_ptr,       \
                             (cache_ptr)->dLRU_tail_ptr,                    \
                             (cache_ptr)->dLRU_list_len,                    \
                             (cache_ptr)->dLRU_list_size, (fail_val))       \
    } else {                                                                \
        H5C__AUX_DLL_PREPEND((entry_ptr), (cache_ptr)->cLRU_head_ptr,       \
                             (cache_ptr)->cLRU_tail_ptr,                    \
                             (cache_ptr)->cLRU_list_len,                    \
                             (cache_ptr)->cLRU_list_size, (fail_val))       \
    }                                                                       \
} /* H5C__UPDATE_RP_FOR_INSERTION_CD_LRU() */
#define H5C__UPDATE_RP_FOR_PROTECT_CD_LRU(cache_ptr, entry_ptr, fail_val)   \
{                                                                           \
    /* Remove the entry from the clean or dirty LRU list as appropriate */  \
    if((entry_ptr)->is_dirty) {                                             \
        H5C__AUX_DLL_REMOVE((entry_ptr), (cache_ptr)->dLRU_head_ptr,        \
                            (cache_ptr)->dLRU_tail_ptr,                     \
                            (cache_ptr)->dLRU_list_len,                     \
                            (cache_ptr)->dLRU_list_size, (fail_val))        \
    } else {                                                                \
        H5C__AUX_DLL_REMOVE((entry_ptr), (cache_ptr)->cLRU_head_ptr,        \
                            (cache_ptr)->cLRU_tail_ptr,                     \
                            (cache_ptr)->cLRU_list_len,                     \
                            (cache_ptr)->cLRU_list_size, (fail_val))        \
    }                                                                       \
} /* H5C__UPDATE_RP_FOR_PROTECT_CD_LRU() */
#define H5C__UPDATE_RP_FOR_MOVE_CD_LRU(cache_ptr, entry_ptr, was_dirty, fail_val) \
{                                                                      \
    /* Remove the entry from either the clean or dirty LRU list as     \
     * indicated by the was_dirty parameter                            \
     */                                                                \
    if(was_dirty) {                                                    \
        H5C__AUX_DLL_REMOVE((entry_ptr),                               \
                             (cache_ptr)->dLRU_head_ptr,               \
                             (cache_ptr)->dLRU_tail_ptr,               \
                             (cache_ptr)->dLRU_list_len,               \
                             (cache_ptr)->dLRU_list_size, (fail_val))  \
                                                                       \
    } else {                                                           \
        H5C__AUX_DLL_REMOVE((entry_ptr),                               \
                             (cache_ptr)->cLRU_head_ptr,               \
                             (cache_ptr)->cLRU_tail_ptr,               \
                             (cache_ptr)->cLRU_list_len,               \
                             (cache_ptr)->cLRU_list_size, (fail_val))  \
    }                                                                  \
                                                                       \
    /* Insert the entry at the head of either the clean or dirty       \
     * LRU list as appropriate.                                        \
     */                                                                \
    if((entry_ptr)->is_dirty) {                                        \
        H5C__AUX_DLL_PREPEND((entry_ptr),                              \
                              (cache_ptr)->dLRU_head_ptr,              \
                              (cache_ptr)->dLRU_tail_ptr,              \
                              (cache_ptr)->dLRU_list_len,              \
                              (cache_ptr)->dLRU_list_size, (fail_val)) \
    } else {                                                           \
        H5C__AUX_DLL_PREPEND((entry_ptr),                              \
                              (cache_ptr)->cLRU_head_ptr,              \
                              (cache_ptr)->cLRU_tail_ptr,              \
                              (cache_ptr)->cLRU_list_len,              \
                              (cache_ptr)->cLRU_list_size, (fail_val)) \
    }                                                                  \
} /* H5C__UPDATE_RP_FOR_MOVE_CD_LRU() */
#define H5C__UPDATE_RP_FOR_SIZE_CHANGE_CD_LRU(cache_ptr, entry_ptr, new_size, fail_val) \
{                                                                     \
    /* Update the size of the clean or dirty LRU list as              \
     * appropriate.                                                   \
     */                                                               \
    if((entry_ptr)->is_dirty) {                                       \
        H5C__DLL_UPDATE_FOR_SIZE_CHANGE((cache_ptr)->dLRU_list_len,   \
                                        (cache_ptr)->dLRU_list_size,  \
                                        (entry_ptr)->size,            \
                                        (new_size), (fail_val))       \
                                                                      \
    } else {                                                          \
        H5C__DLL_UPDATE_FOR_SIZE_CHANGE((cache_ptr)->cLRU_list_len,   \
                                        (cache_ptr)->cLRU_list_size,  \
                                        (entry_ptr)->size,            \
                                        (new_size), (fail_val))       \
    }                                                                 \
} /* H5C__UPDATE_RP_FOR_SIZE_CHANGE_CD_LRU() */
#define H5C__UPDATE_RP_FOR_UNPIN_CD_LRU(cache_ptr, entry_ptr, fail_val) \
{                                                                       \
    /* Insert the entry at the head of either the clean                 \
     * or dirty LRU list as appropriate.                                \
     */                                                                 \
    if((entry_ptr)->is_dirty) {                                         \
        H5C__AUX_DLL_PREPEND((entry_ptr),                               \
                              (cache_ptr)->dLRU_head_ptr,               \
                              (cache_ptr)->dLRU_tail_ptr,               \
                              (cache_ptr)->dLRU_list_len,               \
                              (cache_ptr)->dLRU_list_size, (fail_val))  \
    } else {                                                            \
        H5C__AUX_DLL_PREPEND((entry_ptr),                               \
                              (cache_ptr)->cLRU_head_ptr,               \
                              (cache_ptr)->cLRU_tail_ptr,               \
                              (cache_ptr)->cLRU_list_len,               \
                              (cache_ptr)->cLRU_list_size, (fail_val))  \
     }                                                                  \
} /* H5C__UPDATE_RP_FOR_UNPIN_CD_LRU() */
#define H5C__UPDATE_RP_FOR_UNPROTECT_CD_LRU(cache_ptr, entry_ptr, fail_val) \
{                                                                      \
    /* Insert the entry at the head of either the clean or             \
     * dirty LRU list as appropriate.                                  \
     */                                                                \
    if((entry_ptr)->is_dirty) {                                        \
        H5C__AUX_DLL_PREPEND((entry_ptr), (cache_ptr)->dLRU_head_ptr,  \
                             (cache_ptr)->dLRU_tail_ptr,               \
                             (cache_ptr)->dLRU_list_len,               \
                             (cache_ptr)->dLRU_list_size, (fail_val))  \
    } else {                                                           \
        H5C__AUX_DLL_PREPEND((entry_ptr), (cache_ptr)->cLRU_head_ptr,  \
                             (cache_ptr)->cLRU_tail_ptr,               \
                             (cache_ptr)->cLRU_list_len,               \
                             (cache_ptr)->cLRU_list_size, (fail_val))  \
    }                                                                  \
} /* H5C__UPDATE_RP_FOR_UNPROTECT_CD_LRU() */

#else /* H5C_MAINTAIN_CLEAN_AND_DIRTY_LRU_LISTS */

#define H5C__UPDATE_RP_FOR_EVICTION_CD_LRU(cache_ptr, entry_ptr, fail_val)
#define H5C__UPDATE_RP_FOR_FLUSH_CD_LRU(cache_ptr, entry_ptr, fail_val)
#define H5C__UPDATE_RP_FOR_INSERT_APPEND_CD_LRU(cache_ptr, entry_ptr, fail_val)
#define H5C__UPDATE_RP_FOR_INSERTION_CD_LRU(cache_ptr, entry_ptr, fail_val)
#define H5C__UPDATE_RP_FOR_PROTECT_CD_LRU(cache_ptr, entry_ptr, fail_val)
#define H5C__UPDATE_RP_FOR_MOVE_CD_LRU(cache_ptr, entry_ptr, was_dirty, fail_val)
#define H5C__UPDATE_RP_FOR_SIZE_CHANGE_CD_LRU(cache_ptr, entry_ptr, new_size, fail_val)
#define H5C__UPDATE_RP_FOR_UNPIN_CD_LRU(cache_ptr, entry_ptr, fail_val)
#define H5C__UPDATE_RP_FOR_UNPROTECT_CD_LRU(cache_ptr, entry_ptr, fail_val)

#endif /* H5C_MAINTAIN_CLEAN_AND_DIRTY_LRU_LISTS */

/*-------------------------------------------------------------------------
 *
 * Macro:       H5C__UPDATE_RP_FOR_EVICTION
 *
 * Purpose:     Update the replacement policy data structures for an
 *              eviction of the specified cache entry.
 *
 * Programmer:  John Mainzer, 5/10/04
 *
 *-------------------------------------------------------------------------
 */

#define H5C__UPDATE_RP_FOR_EVICTION(cache_ptr, entry_ptr, fail_val)          \
{                                                                            \
    HDassert(cache_ptr);                                                     \
    HDassert(entry_ptr);                                                     \
    HDassert(!(entry_ptr)->is_protected);                                    \
    HDassert(!(entry_ptr)->is_read_only);                                    \
    HDassert((entry_ptr)->ro_ref_count == 0);                                \
    HDassert(!(entry_ptr)->is_pinned);                                       \
    HDassert((entry_ptr)->size > 0);                                         \
                                                                             \
    /* Remove the entry from the LRU list */                                 \
    H5C__DLL_REMOVE((entry_ptr), (cache_ptr)->LRU_head_ptr,                  \
                    (cache_ptr)->LRU_tail_ptr, (cache_ptr)->LRU_list_len,    \
                    (cache_ptr)->LRU_list_size, (fail_val))                  \
                                                                             \
    /* Remove the entry from the clean & dirty LRU lists, if enabled */      \
    H5C__UPDATE_RP_FOR_EVICTION_CD_LRU(cache_ptr, entry_ptr, fail_val)       \
} /* H5C__UPDATE_RP_FOR_EVICTION */


/*-------------------------------------------------------------------------
 *
 * Macro:       H5C__UPDATE_RP_FOR_FLUSH
 *
 * Purpose:     Update the replacement policy data structures for a flush
 *              of the specified cache entry.
 *
 * Programmer:  John Mainzer, 5/6/04
 *
 *-------------------------------------------------------------------------
 */

#define H5C__UPDATE_RP_FOR_FLUSH(cache_ptr, entry_ptr, fail_val)            \
{                                                                           \
    HDassert(cache_ptr);                                                    \
    HDassert(entry_ptr);                                                    \
    HDassert(!(entry_ptr)->is_protected);                                   \
    HDassert(!(entry_ptr)->is_read_only);                                   \
    HDassert((entry_ptr)->ro_ref_count == 0);                               \
    HDassert((entry_ptr)->size > 0);                                        \
                                                                            \
    if(!(entry_ptr)->is_pinned) {                                           \
        /* Remove the entry from its location in the LRU list               \
         * and re-insert it at the head of the list.                        \
         */                                                                 \
        H5C__DLL_REMOVE((entry_ptr), (cache_ptr)->LRU_head_ptr,             \
                        (cache_ptr)->LRU_tail_ptr,                          \
                        (cache_ptr)->LRU_list_len,                          \
                        (cache_ptr)->LRU_list_size, (fail_val))             \
                                                                            \
        H5C__DLL_PREPEND((entry_ptr), (cache_ptr)->LRU_head_ptr,            \
                         (cache_ptr)->LRU_tail_ptr,                         \
                         (cache_ptr)->LRU_list_len,                         \
                         (cache_ptr)->LRU_list_size, (fail_val))            \
                                                                            \
        /* Maintain the clean & dirty LRU lists, if enabled */              \
        H5C__UPDATE_RP_FOR_FLUSH_CD_LRU(cache_ptr, entry_ptr, fail_val)     \
    }                                                                       \
} /* H5C__UPDATE_RP_FOR_FLUSH */


/*-------------------------------------------------------------------------
 *
 * Macro:       H5C__UPDATE_RP_FOR_INSERT_APPEND
 *
 * Purpose:     Update the replacement policy data structures for an
 *              insertion of the specified cache entry.
 *
 *              Unlike H5C__UPDATE_RP_FOR_INSERTION below, insert a non-pinned
 *              new entry as the LEAST recently used entry, not the
 *              most recently used.
 *
 * Programmer:  John Mainzer, 8/15/15
 *
 *-------------------------------------------------------------------------
 */

#define H5C__UPDATE_RP_FOR_INSERT_APPEND(cache_ptr, entry_ptr, fail_val)   \
do {                                                                       \
    HDassert(cache_ptr);                                                   \
    HDassert(entry_ptr);                                                   \
    HDassert(!(entry_ptr)->is_protected);                                  \
    HDassert(!(entry_ptr)->is_read_only);                                  \
    HDassert((entry_ptr)->ro_ref_count == 0 );                             \
    HDassert((entry_ptr)->size > 0 );                                      \
                                                                           \
    if((entry_ptr)->is_pinned) {                                           \
        H5C__DLL_PREPEND((entry_ptr), (cache_ptr)->pel_head_ptr,           \
                         (cache_ptr)->pel_tail_ptr,                        \
                         (cache_ptr)->pel_len,                             \
                         (cache_ptr)->pel_size, (fail_val))                \
    } else {                                                               \
        /* Insert the entry at the tail of the LRU list. */                \
        H5C__DLL_APPEND((entry_ptr), (cache_ptr)->LRU_head_ptr,            \
                        (cache_ptr)->LRU_tail_ptr,                         \
                        (cache_ptr)->LRU_list_len,                         \
                        (cache_ptr)->LRU_list_size, (fail_val))            \
                                                                           \
        /* Maintain the clean & dirty LRU lists, if enabled */             \
        H5C__UPDATE_RP_FOR_INSERT_APPEND_CD_LRU(cache_ptr, entry_ptr, fail_val) \
    }                                                                      \
} while (0)


/*-------------------------------------------------------------------------
 *
 * Macro:       H5C__UPDATE_RP_FOR_INSERTION
 *
 * Purpose:     Update the replacement policy data structures for an
 *              insertion of the specified cache entry.
 *
 * Programmer:  John Mainzer, 5/17/04
 *
 *-------------------------------------------------------------------------
 */

#define H5C__UPDATE_RP_FOR_INSERTION(cache_ptr, entry_ptr, fail_val)        \
{                                                                           \
    HDassert(cache_ptr);                                                    \
    HDassert(entry_ptr);                                                    \
    HDassert(!(entry_ptr)->is_protected);                                   \
    HDassert(!(entry_ptr)->is_read_only);                                   \
    HDassert((entry_ptr)->ro_ref_count == 0);                               \
    HDassert((entry_ptr)->size > 0);                                        \
                                                                            \
    if((entry_ptr)->is_pinned) {                                            \
        H5C__DLL_PREPEND((entry_ptr), (cache_ptr)->pel_head_ptr,            \
                         (cache_ptr)->pel_tail_ptr,                         \
                         (cache_ptr)->pel_len,                              \
                         (cache_ptr)->pel_size, (fail_val))                 \
                                                                            \
    } else {                                                                \
        /* Insert the entry at the head of the LRU list. */                 \
        H5C__DLL_PREPEND((entry_ptr), (cache_ptr)->LRU_head_ptr,            \
                         (cache_ptr)->LRU_tail_ptr,                         \
                         (cache_ptr)->LRU_list_len,                         \
                         (cache_ptr)->LRU_list_size, (fail_val))            \
                                                                            \
        /* Maintain the clean & dirty LRU lists, if enabled */              \
        H5C__UPDATE_RP_FOR_INSERTION_CD_LRU(cache_ptr, entry_ptr, fail_val) \
    }                                                                       \
}


/*-------------------------------------------------------------------------
 *
 * Macro:       H5C__UPDATE_RP_FOR_PROTECT
 *
 * Purpose:     Update the replacement policy data structures for a
 *              protect of the specified cache entry.
 *
 *              To do this, unlink the specified entry from any data
 *              structures used by the replacement policy (or the pinned list,
 *              which is outside of the replacement policy), and add the
 *              entry to the protected list.
 *
 * Programmer:  John Mainzer, 5/17/04
 *
 *-------------------------------------------------------------------------
 */

#define H5C__UPDATE_RP_FOR_PROTECT(cache_ptr, entry_ptr, fail_val)        \
{                                                                         \
    HDassert(cache_ptr);                                                  \
    HDassert(entry_ptr);                                                  \
    HDassert(!(entry_ptr)->is_protected);                                 \
    HDassert(!(entry_ptr)->is_read_only);                                 \
    HDassert((entry_ptr)->ro_ref_count == 0);                             \
    HDassert((entry_ptr)->size > 0);                                      \
                                                                          \
    if((entry_ptr)->is_pinned) {                                          \
        H5C__DLL_REMOVE((entry_ptr), (cache_ptr)->pel_head_ptr,           \
                        (cache_ptr)->pel_tail_ptr,                        \
                        (cache_ptr)->pel_len,                             \
                        (cache_ptr)->pel_size, (fail_val))                \
    } else {                                                              \
        /* Remove the entry from the LRU list. */                         \
        H5C__DLL_REMOVE((entry_ptr), (cache_ptr)->LRU_head_ptr,           \
                        (cache_ptr)->LRU_tail_ptr,                        \
                        (cache_ptr)->LRU_list_len,                        \
                        (cache_ptr)->LRU_list_size, (fail_val))           \
                                                                          \
        /* Maintain the clean & dirty LRU lists, if enabled */            \
        H5C__UPDATE_RP_FOR_PROTECT_CD_LRU(cache_ptr, entry_ptr, fail_val) \
    }                                                                     \
                                                                          \
    /* Regardless of whether the entry is pinned, add it to the protected \
     * list.                                                              \
     */                                                                   \
    H5C__DLL_APPEND((entry_ptr), (cache_ptr)->pl_head_ptr,                \
                    (cache_ptr)->pl_tail_ptr,                             \
                    (cache_ptr)->pl_len,                                  \
                    (cache_ptr)->pl_size, (fail_val))                     \
} /* H5C__UPDATE_RP_FOR_PROTECT */


/*-------------------------------------------------------------------------
 *
 * Macro:       H5C__UPDATE_RP_FOR_MOVE
 *
 * Purpose:     Update the replacement policy data structures for a
 *              move of the specified cache entry.
 *
 * Programmer:  John Mainzer, 5/17/04
 *
 *-------------------------------------------------------------------------
 */

#define H5C__UPDATE_RP_FOR_MOVE(cache_ptr, entry_ptr, was_dirty, fail_val)   \
do {                                                                         \
    HDassert(cache_ptr);                                                     \
    HDassert(entry_ptr);                                                     \
    HDassert(!(entry_ptr)->is_read_only);                                    \
    HDassert((entry_ptr)->ro_ref_count == 0);                                \
    HDassert((entry_ptr)->size > 0);                                         \
                                                                             \
    if(!(entry_ptr)->is_pinned && !(entry_ptr)->is_protected) {              \
        /* Remove the entry from the LRU list, and re-insert it at the head. \
         */                                                                  \
        H5C__DLL_REMOVE((entry_ptr), (cache_ptr)->LRU_head_ptr,              \
                         (cache_ptr)->LRU_tail_ptr,                          \
                         (cache_ptr)->LRU_list_len,                          \
                         (cache_ptr)->LRU_list_size, (fail_val))             \
                                                                             \
        H5C__DLL_PREPEND((entry_ptr), (cache_ptr)->LRU_head_ptr,             \
                         (cache_ptr)->LRU_tail_ptr,                          \
                         (cache_ptr)->LRU_list_len,                          \
                         (cache_ptr)->LRU_list_size, (fail_val))             \
                                                                             \
        /* Maintain the clean & dirty LRU lists, if enabled */               \
        H5C__UPDATE_RP_FOR_MOVE_CD_LRU(cache_ptr, entry_ptr, was_dirty, fail_val) \
    }                                                                        \
} while (0) /* H5C__UPDATE_RP_FOR_MOVE */


/*-------------------------------------------------------------------------
 *
 * Macro:       H5C__UPDATE_RP_FOR_SIZE_CHANGE
 *
 * Purpose:     Update the replacement policy data structures for a
 *              size change of the specified cache entry.
 *
 *              To do this, determine if the entry is pinned.  If it is,
 *              update the size of the pinned entry list.
 *
 *              If it isn't pinned, the entry must handled by the
 *              replacement policy.  Update the appropriate replacement
 *              policy data structures.
 *
 *              If the entry is accessed with collective operations for
 *              parallel I/O, update that list.
 *
 * Programmer:  John Mainzer, 8/23/06
 *
 *-------------------------------------------------------------------------
 */

#ifdef H5_HAVE_PARALLEL

#define H5C__UPDATE_RP_FOR_SIZE_CHANGE_COLL(cache_ptr, entry_ptr, new_size, fail_val) \
{                                                                      \
    if((entry_ptr)->coll_access) {                                     \
        H5C__DLL_UPDATE_FOR_SIZE_CHANGE((cache_ptr)->coll_list_len,    \
                                    (cache_ptr)->coll_list_size,       \
                                    (entry_ptr)->size,                 \
                                    (new_size), (fail_val));           \
                                                                       \
    }                                                                  \
} /* H5C__UPDATE_RP_FOR_SIZE_CHANGE_COLL() */

#else /* H5_HAVE_PARALLEL */

#define H5C__UPDATE_RP_FOR_SIZE_CHANGE_COLL(cache_ptr, entry_ptr, new_size, fail_val)

#endif /* H5_HAVE_PARALLEL */

#define H5C__UPDATE_RP_FOR_SIZE_CHANGE(cache_ptr, entry_ptr, new_size, fail_val)    \
{                                                                         \
    HDassert(cache_ptr);                                                  \
    HDassert(entry_ptr);                                                  \
    HDassert(!(entry_ptr)->is_protected);                                 \
    HDassert(!(entry_ptr)->is_read_only);                                 \
    HDassert((entry_ptr)->ro_ref_count == 0);                             \
    HDassert((entry_ptr)->size > 0 );                                     \
    HDassert(new_size > 0 );                                              \
                                                                          \
    /* Maintain the collective access list, if enabled */                 \
    H5C__UPDATE_RP_FOR_SIZE_CHANGE_COLL(cache_ptr, entry_ptr, new_size, fail_val) \
                                                                          \
    if((entry_ptr)->is_pinned) {                                          \
        H5C__DLL_UPDATE_FOR_SIZE_CHANGE((cache_ptr)->pel_len,             \
                                    (cache_ptr)->pel_size,                \
                                    (entry_ptr)->size,                    \
                                    (new_size), (fail_val))               \
    } else {                                                              \
        /* Update the size of the LRU list */                             \
        H5C__DLL_UPDATE_FOR_SIZE_CHANGE((cache_ptr)->LRU_list_len,        \
                                        (cache_ptr)->LRU_list_size,       \
                                        (entry_ptr)->size,                \
                                        (new_size), (fail_val))           \
                                                                          \
        /* Maintain the clean & dirty LRU lists, if enabled */            \
        H5C__UPDATE_RP_FOR_SIZE_CHANGE_CD_LRU(cache_ptr, entry_ptr, new_size, fail_val) \
    }                                                                     \
} /* H5C__UPDATE_RP_FOR_SIZE_CHANGE */


/*-------------------------------------------------------------------------
 *
 * Macro:       H5C__UPDATE_RP_FOR_UNPIN
 *
 * Purpose:     Update the replacement policy data structures for an
 *              unpin of the specified cache entry.
 *
 *              To do this, unlink the specified entry from the pinned
 *              entry list, and re-insert it in the data structures used
 *              by the current replacement policy.
 *
 * Programmer:  John Mainzer, 3/22/06
 *
 *-------------------------------------------------------------------------
 */

#define H5C__UPDATE_RP_FOR_UNPIN(cache_ptr, entry_ptr, fail_val)       \
{                                                                      \
    HDassert(cache_ptr);                                               \
    HDassert(entry_ptr);                                               \
    HDassert(!(entry_ptr)->is_protected);                              \
    HDassert(!(entry_ptr)->is_read_only);                              \
    HDassert((entry_ptr)->ro_ref_count == 0 );                         \
    HDassert((entry_ptr)->is_pinned);                                  \
    HDassert((entry_ptr)->size > 0);                                   \
                                                                       \
    /* Regardless of the replacement policy, remove the entry from the \
     * pinned entry list.                                              \
     */                                                                \
    H5C__DLL_REMOVE((entry_ptr), (cache_ptr)->pel_head_ptr,            \
                    (cache_ptr)->pel_tail_ptr, (cache_ptr)->pel_len,   \
                    (cache_ptr)->pel_size, (fail_val))                 \
                                                                       \
    /* Insert the entry at the head of the LRU list. */                \
    H5C__DLL_PREPEND((entry_ptr), (cache_ptr)->LRU_head_ptr,           \
                     (cache_ptr)->LRU_tail_ptr,                        \
                     (cache_ptr)->LRU_list_len,                        \
                     (cache_ptr)->LRU_list_size, (fail_val))           \
                                                                       \
    /* Maintain the clean & dirty LRU lists, if enabled */             \
    H5C__UPDATE_RP_FOR_UNPIN_CD_LRU(cache_ptr, entry_ptr, fail_val)    \
} /* H5C__UPDATE_RP_FOR_UNPIN */


/*-------------------------------------------------------------------------
 *
 * Macro:       H5C__UPDATE_RP_FOR_UNPROTECT
 *
 * Purpose:     Update the replacement policy data structures for an
 *              unprotect of the specified cache entry.
 *
 *              To do this, unlink the specified entry from the protected
 *              list, and re-insert it in the data structures used by the
 *              current replacement policy.
 *
 * Programmer:  John Mainzer, 5/19/04
 *
 *-------------------------------------------------------------------------
 */

#define H5C__UPDATE_RP_FOR_UNPROTECT(cache_ptr, entry_ptr, fail_val)       \
do {                                                                       \
    HDassert(cache_ptr);                                                   \
    HDassert(entry_ptr);                                                   \
    HDassert((entry_ptr)->is_protected);                                   \
    HDassert((entry_ptr)->size > 0);                                       \
                                                                           \
    /* Regardless of the replacement policy, remove the entry from the     \
     * protected list.                                                     \
     */                                                                    \
    H5C__DLL_REMOVE((entry_ptr), (cache_ptr)->pl_head_ptr,                 \
                    (cache_ptr)->pl_tail_ptr, (cache_ptr)->pl_len,         \
                    (cache_ptr)->pl_size, (fail_val))                      \
                                                                           \
    if((entry_ptr)->is_pinned) {                                           \
        H5C__DLL_PREPEND((entry_ptr), (cache_ptr)->pel_head_ptr,           \
                         (cache_ptr)->pel_tail_ptr,                        \
                         (cache_ptr)->pel_len,                             \
                         (cache_ptr)->pel_size, (fail_val))                \
    } else {                                                               \
        /* Insert the entry at the head of the LRU list. */                \
        H5C__DLL_PREPEND((entry_ptr), (cache_ptr)->LRU_head_ptr,           \
                         (cache_ptr)->LRU_tail_ptr,                        \
                         (cache_ptr)->LRU_list_len,                        \
                         (cache_ptr)->LRU_list_size, (fail_val))           \
                                                                           \
        /* Maintain the clean & dirty LRU lists, if enabled */             \
        H5C__UPDATE_RP_FOR_UNPROTECT_CD_LRU(cache_ptr, entry_ptr, fail_val) \
    }                                                                      \
} while (0) /* H5C__UPDATE_RP_FOR_UNPROTECT */


#ifdef H5_HAVE_PARALLEL

/* Macros that modify the "collective I/O" LRU list */
#define H5C__COLL_DLL_PREPEND(entry_ptr, head_ptr, tail_ptr, len, list_size, fail_val) \
    H5C__GEN_DLL_PREPEND(entry_ptr, coll_next, coll_prev, head_ptr, tail_ptr, len, list_size, fail_val)
#define H5C__COLL_DLL_REMOVE(entry_ptr, head_ptr, tail_ptr, len, list_size, fail_val)  \
    H5C__GEN_DLL_REMOVE(entry_ptr, coll_next, coll_prev, head_ptr, tail_ptr, len, list_size, fail_val)


/*-------------------------------------------------------------------------
 *
 * Macro:       H5C__INSERT_IN_COLL_LIST
 *
 * Purpose:     Insert entry into collective entries list
 *
 * Programmer:  Mohamad Chaarawi
 *
 *-------------------------------------------------------------------------
 */

#define H5C__INSERT_IN_COLL_LIST(cache_ptr, entry_ptr, fail_val)        \
{                                                                       \
    HDassert(cache_ptr);                                                \
    HDassert(entry_ptr);                                                \
                                                                        \
    /* Insert the entry at the head of the list. */                     \
    H5C__COLL_DLL_PREPEND((entry_ptr), (cache_ptr)->coll_head_ptr,      \
                          (cache_ptr)->coll_tail_ptr,                   \
                          (cache_ptr)->coll_list_len,                   \
                          (cache_ptr)->coll_list_size, (fail_val))      \
} /* H5C__INSERT_IN_COLL_LIST */


/*-------------------------------------------------------------------------
 *
 * Macro:       H5C__REMOVE_FROM_COLL_LIST
 *
 * Purpose:     Remove entry from collective entries list
 *
 * Programmer:  Mohamad Chaarawi
 *
 *-------------------------------------------------------------------------
 */

#define H5C__REMOVE_FROM_COLL_LIST(cache_ptr, entry_ptr, fail_val)      \
{                                                                       \
    HDassert(cache_ptr);                                                \
    HDassert(entry_ptr);                                                \
                                                                        \
    /* Remove the entry from the list. */                               \
    H5C__COLL_DLL_REMOVE((entry_ptr), (cache_ptr)->coll_head_ptr,       \
                         (cache_ptr)->coll_tail_ptr,                    \
                         (cache_ptr)->coll_list_len,                    \
                         (cache_ptr)->coll_list_size, (fail_val))       \
} /* H5C__REMOVE_FROM_COLL_LIST */


/*-------------------------------------------------------------------------
 *
 * Macro:       H5C__MOVE_TO_TOP_IN_COLL_LIST
 *
 * Purpose:     Update entry position in collective entries list
 *
 * Programmer:  Mohamad Chaarawi
 *
 *-------------------------------------------------------------------------
 */

#define H5C__MOVE_TO_TOP_IN_COLL_LIST(cache_ptr, entry_ptr, fail_val)   \
{                                                                       \
    HDassert(cache_ptr);                                                \
    HDassert(entry_ptr);                                                \
                                                                        \
    /* Remove entry and insert at the head of the list. */              \
    H5C__COLL_DLL_REMOVE((entry_ptr), (cache_ptr)->coll_head_ptr,       \
                         (cache_ptr)->coll_tail_ptr,                    \
                         (cache_ptr)->coll_list_len,                    \
                         (cache_ptr)->coll_list_size, (fail_val))       \
                                                                        \
    H5C__COLL_DLL_PREPEND((entry_ptr), (cache_ptr)->coll_head_ptr,      \
                          (cache_ptr)->coll_tail_ptr,                   \
                          (cache_ptr)->coll_list_len,                   \
                          (cache_ptr)->coll_list_size, (fail_val))      \
                                                                        \
} /* H5C__MOVE_TO_TOP_IN_COLL_LIST */
#endif /* H5_HAVE_PARALLEL */


/****************************/
/* Package Private Typedefs */
/****************************/

/****************************************************************************
 *
 * structure H5C_tag_info_t
 *
 * Structure about each set of tagged entries for an object in the file.
 *
 * Each H5C_tag_info_t struct corresponds to a particular object in the file.
 *
 * Each H5C_cache_entry struct in the linked list of entries for this tag
 *      also contains a pointer back to the H5C_tag_info_t struct for the
 *      overall object.
 *
 *
 * The fields of this structure are discussed individually below:
 *
 * tag:         Address (i.e. "tag") of the object header for all the entries
 *              corresponding to parts of that object.
 *
 * head:        Head of doubly-linked list of all entries belonging to the tag.
 *
 * entry_cnt:   Number of entries on linked list of entries for this tag.
 *
 * corked:      Boolean flag indicating whether entries for this object can be
 *              evicted.
 *
 * hh:          uthash hash table handle (must be last)
 *
 ****************************************************************************/
typedef struct H5C_tag_info_t {
    haddr_t tag;                /* Tag (address) of the entries (must be first, for skiplist) */
    H5C_cache_entry_t *head;    /* Head of the list of entries for this tag */
    size_t entry_cnt;           /* Number of entries on list */
    hbool_t corked;             /* Whether this object is corked */

    /* Hash table fields */
    UT_hash_handle hh;          /* Hash table handle (must be LAST) */
} H5C_tag_info_t;


/****************************************************************************
 *
 * structure H5C_t
 *
 * Structure for all information specific to an instance of the cache.
 *
 * While the cache was designed with multiple replacement policies in mind,
 * at present only a modified form of LRU is supported.
 *
 * The cache has a hash table in which all entries are stored.  Given the
 * advantages of flushing entries in increasing address order, a skip list
 * is used to track dirty entries.
 *
 * flush_in_progress: Boolean flag indicating whether a flush is in progress.
 *
 * log_info:    Information used by the cache logging functionality.
 *              Described in H5Clog.h.
 *
 * aux_ptr:    Pointer to void used to allow wrapper code to associate
 *        its data with an instance of H5C_t.  The H5C cache code
 *        sets this field to NULL, and otherwise leaves it alone.
 *
 * max_type_id:    Integer field containing the maximum type id number assigned
 *        to a type of entry in the cache.  All type ids from 0 to
 *        max_type_id inclusive must be defined.
 *
 * class_table_ptr: Pointer to an array of H5C_class_t of length
 *        max_type_id + 1.  Entry classes for the cache.
 *
 * max_cache_size:  Nominal maximum number of bytes that may be stored in the
 *        cache.  This value should be viewed as a soft limit, as the
 *        cache can exceed this value under the following circumstances:
 *
 *        a) All entries in the cache are protected, and the cache is
 *           asked to insert a new entry.  In this case the new entry
 *           will be created.  If this causes the cache to exceed
 *           max_cache_size, it will do so.  The cache will attempt
 *           to reduce its size as entries are unprotected.
 *
 *        b) When running in parallel mode, the cache may not be
 *           permitted to flush a dirty entry in response to a read.
 *           If there are no clean entries available to evict, the
 *           cache will exceed its maximum size.  Again the cache
 *           will attempt to reduce its size to the max_cache_size
 *           limit on the next cache write.
 *
 *        c) When an entry increases in size, the cache may exceed
 *           the max_cache_size limit until the next time the cache
 *           attempts to load or insert an entry.
 *
 *        d) When the evictions_enabled field is false (see below),
 *           the cache size will increase without limit until the
 *           field is set to true.
 *
 * min_clean_size: Nominal minimum number of clean bytes in the cache.
 *        The cache attempts to maintain this number of bytes of clean
 *        data so as to avoid case b) above.  Again, this is a soft limit.
 *
 * close_warning_received: Boolean flag indicating that a file closing
 *        warning has been received.
 *
 *
 * In addition to the callback functions required for each entry's class,
 * the cache requires the following callback functions for an instance of
 * the cache as a whole:
 *
 * check_write_permitted:  In certain applications, the cache may not
 *        be allowed to write to disk at certain time.  If specified,
 *        the check_write_permitted function is used to determine if
 *        a write is permissible at any given point in time.
 *
 *        If no such function is specified (i.e. this field is NULL),
 *        the cache uses the following write_permitted field to
 *        determine whether writes are permitted.
 *
 * write_permitted: If check_write_permitted is NULL, this boolean flag
 *        indicates whether writes are permitted.
 *
 * log_flush:    If provided, this function is called whenever a dirty
 *        entry is flushed to disk.
 *
 *
 * In cases where memory is plentiful, and performance is an issue, it may
 * be useful to disable all cache evictions, and thereby postpone metadata
 * writes.  The following field is used to implement this.
 *
 * evictions_enabled:  Boolean flag that is initialized to TRUE.  When
 *         this flag is set to FALSE, the metadata cache will not
 *         attempt to evict entries to make space for newly protected
 *         entries, and instead the will grow without limit.
 *
 *         Needless to say, this feature must be used with care.
 *
 *
 * The cache requires an index to facilitate searching for entries.  The
 * following fields support that index.
 *
 * We sometimes need to visit all entries in the cache, they are stored in
 * an index list.
 *
 * The index list is maintained by the same macros that maintain the
 * index, and must have the same length and size as the index proper.
 *
 * index_len:   Number of entries currently in the hash table used to index
 *        the cache.
 *
 * index_size:  Number of bytes of cache entries currently stored in the
 *        hash table used to index the cache.
 *
 *        This value should not be mistaken for footprint of the
 *        cache in memory.  The average cache entry is small, and
 *        the cache has a considerable overhead.  Multiplying the
 *        index_size by three should yield a conservative estimate
 *        of the cache's memory footprint.
 *
 * index_ring_len: Array of integer of length H5C_RING_NTYPES used to
 *        maintain a count of entries in the index by ring.  Note
 *        that the sum of all the cells in this array must equal
 *        the value stored in index_len above.
 *
 * index_ring_size: Array of size_t of length H5C_RING_NTYPES used to
 *        maintain the sum of the sizes of all entries in the index
 *        by ring.  Note that the sum of all cells in this array must
 *        equal the value stored in index_size above.
 *
 * clean_index_size: Number of bytes of clean entries currently stored in
 *        the hash table.  Note that the index_size field (above)
 *        is also the sum of the sizes of all entries in the cache.
 *        Thus we should have the invariant that clean_index_size +
 *        dirty_index_size == index_size.
 *
 *        WARNING:
 *           The value of the clean_index_size must not be mistaken for
 *           the current clean size of the cache.  Rather, the clean size
 *           of the cache is the current value of clean_index_size plus
 *           the amount of empty space (if any) in the cache.
 *
 * clean_index_ring_size: Array of size_t of length H5C_RING_NTYPES used to
 *        maintain the sum of the sizes of all clean entries in the
 *        index by ring.  Note that the sum of all cells in this array
 *        must equal the value stored in clean_index_size above.
 *
 * dirty_index_size: Number of bytes of dirty entries currently stored in
 *        the hash table.  Note that the index_size field (above)
 *        is also the sum of the sizes of all entries in the cache.
 *        Thus we should have the invariant that clean_index_size +
 *        dirty_index_size == index_size.
 *
 * dirty_index_ring_size: Array of size_t of length H5C_RING_NTYPES used to
 *        maintain the sum of the sizes of all dirty entries in the
 *        index by ring.  Note that the sum of all cells in this array
 *        must equal the value stored in dirty_index_size above.
 *
 * index: Array of pointers to H5C_cache_entry_t of size
 *        H5C__HASH_TABLE_LEN.  At present, this value is a power
 *        of two, not the usual prime number.
 *
 *        Hopefully the variable size of cache elements, the large
 *        hash table size, and the way in which HDF5 allocates space
 *        will combine to avoid problems with periodicity.  If so, we
 *        can use a trivial hash function (a bit-and and a 3 bit left
 *        shift) with some small savings.
 *
 *        If not, it will become evident in the statistics. Changing
 *        to the usual prime number length hash table will require
 *        changing the H5C__HASH_FCN macro and the deletion of the
 *        H5C__HASH_MASK #define.  No other changes should be required.
 *
 * il_len: Number of entries on the index list.
 *
 *        This must always be equal to index_len.  As such, this
 *        field is redundant.  However, the existing linked list
 *        management macros expect to maintain a length field, so
 *        this field exists primarily to avoid adding complexity to
 *        these macros.
 *
 * il_size: Number of bytes of cache entries currently stored in the
 *        index list.
 *
 *        This must always be equal to index_size.  As such, this
 *        field is redundant.  However, the existing linked list
 *        management macros expect to maintain a size field, so
 *        this field exists primarily to avoid adding complexity to
 *        these macros.
 *
 * il_head: Pointer to the head of the doubly linked list of entries in
 *        the index list.  Note that cache entries on this list are
 *        linked by their il_next and il_prev fields.
 *
 *        This field is NULL if the index is empty.
 *
 * il_tail: Pointer to the tail of the doubly linked list of entries in
 *        the index list.  Note that cache entries on this list are
 *        linked by their il_next and il_prev fields.
 *
 *        This field is NULL if the index is empty.
 *
 *
 * It is possible that an entry may be removed from the cache as the result
 * of the flush of a second entry.  In general, this causes little trouble,
 * but it is possible that the entry removed may be the next entry in the
 * scan of a list.  In this case, we must be able to detect the fact that the
 * entry has been removed, so that the scan doesn't attempt to proceed with
 * an entry that is no longer in the cache.
 *
 * The following fields are maintained to facilitate this.
 *
 * entries_removed_counter: Counter that is incremented each time an
 *        entry is removed from the cache by any means (eviction,
 *        expungement, or take ownership at this point in time).
 *        Functions that perform scans on lists may set this field
 *        to zero prior to calling H5C__flush_single_entry().
 *        Unexpected changes to the counter indicate that an entry
 *        was removed from the cache as a side effect of the flush.
 *
 * last_entry_removed_ptr: Pointer to the instance of H5C_cache_entry_t
 *        which contained the last entry to be removed from the cache,
 *        or NULL if there either is no such entry, or if a function
 *        performing a scan of a list has set this field to NULL prior
 *        to calling H5C__flush_single_entry().
 *
 *        WARNING!!! This field must NEVER be dereferenced.  It is
 *        maintained to allow functions that perform scans of lists
 *        to compare this pointer with their pointers to next, thus
 *        allowing them to avoid unnecessary restarts of scans if the
 *        pointers don't match, and if entries_removed_counter is one.
 *
 * entry_watched_for_removal:    Pointer to an instance of H5C_cache_entry_t
 *        which contains the 'next' entry for an iteration.  Removing
 *        this entry must trigger a rescan of the iteration, so each
 *        entry removed from the cache is compared against this pointer
 *        and the pointer is reset to NULL if the watched entry is
 *        removed.  (This functions similarly to a "dead man's switch")
 *
 *
 * When we flush the cache, we need to write entries out in increasing
 * address order.  An instance of a skip list is used to store dirty entries in
 * sorted order.
 *
 * The cost of maintaining the skip list is significant.  As it is only used
 * on flush and close, it is maintained only when needed.
 *
 * To do this, we add a flag to control maintenanace of the skip list.
 * This flag is initially set to FALSE, which disables all operations
 * on the skip list.
 *
 * At the beginning of either flush or close, we scan the index list,
 * insert all dirtly entries in the skip list, and enable operations
 * on skip list by setting above control flag to true.
 *
 * At the end of a complete flush, we verify that the skip list is empty,
 * and set the control flag back to false, so as to avoid skip list
 * maintenance overhead until the next flush or close.
 *
 * In the case of a partial flush (i.e. flush marked entries), we remove
 * all remaining entries from the skip list, and then set the control flag
 * back to false -- again avoiding skip list maintenance overhead until
 * the next flush or close.
 *
 * slist_enabled: Boolean flag used to control operation of the skip
 *        list.  If this filed is FALSE, operations on the slist are
 *        no-ops, and the slist must be empty.  If it is TRUE,
 *        operations on the skip list proceed as usual, and all dirty
 *        entries in the metadata cache must be listed in the skip list.
 *
 * slist_changed: Boolean flag used to indicate whether the contents of
 *        the skip list has changed since the last time this flag was
 *        reset.  This is used in the cache flush code to detect
 *        conditions in which pre-serialize or serialize callbacks
 *        have modified the skip list -- which obliges us to restart
 *        the scan of the skip list from the beginning.
 *
 * slist_len: Number of entries currently in the skip list. Used to
 *        maintain a sorted list of dirty entries in the cache.
 *
 * slist_size: Number of bytes of cache entries currently stored in the
 *        skip list used to maintain a sorted list of dirty entries in
 *        the cache.
 *
 * slist_ring_len: Array of integer of length H5C_RING_NTYPES used to
 *        maintain a count of entries in the skip list by ring.  Note
 *        that the sum of all the cells in this array must equal
 *        the value stored in slist_len above.
 *
 * slist_ring_size: Array of size_t of length H5C_RING_NTYPES used to
 *        maintain the sum of the sizes of all entries in the skip list
 *        by ring.  Note that the sum of all cells in this array must
 *        equal the value stored in slist_size above.
 *
 * slist_ptr: Pointer to the instance of H5SL_t used maintain a sorted
 *        list of dirty entries in the cache.  This sorted list has
 *        two uses:
 *
 *        a) It allows us to flush dirty entries in increasing address
 *           order, which results in significant savings.
 *
 *        b) It facilitates checking for adjacent dirty entries when
 *           attempting to evict entries from the cache.
 *
 * num_last_entries: The number of entries in the cache that can only be
 *        flushed after all other entries in the cache have been flushed.
 *
 *        Note: At this time, the this field will only be applied to
 *              two types of entries: the superblock and the file driver info
 *              message.  The code utilizing these flags is protected with
 *              HDasserts to enforce this.
 *
 * The cache must deal with the case in which entries may be dirtied, moved,
 * or have their sizes changed during a flush.  To allow sanity checks in this
 * situation, the following two fields have been added.  They are only
 * compiled in when H5C_DO_SANITY_CHECKS is TRUE.
 *
 * slist_len_increase: Number of entries that have been added to the
 *        skip list since the last time this field was set to zero.
 *        Note that this value can be negative.
 *
 * slist_size_increase: Total size of all entries that have been added
 *         to the skip list since the last time this field was set to
 *         zero.  Note that this value can be negative.
 *
 * Cache entries belonging to a particular object are "tagged" with that
 * object's base object header address.
 *
 * The following fields are maintained to facilitate this.
 *
 * tag_list: A collection to track entries that belong to an object.
 *         Each H5C_tag_info_t struct on the tag list corresponds to a
 *         particular object in the file.  Tagged entries can be flushed
 *         or evicted as a group, or corked to prevent entries from being
 *         evicted from the cache.
 *
 *         "Global" entries, like the superblock and the file's freelist,
 *         as well as shared entries like global heaps and shared object
 *         header messages, are not tagged.
 *
 * ignore_tags: Boolean flag to disable tag validation during entry insertion.
 *
 * num_objs_corked: Unsigned integer field containing the number of objects
 *         that are "corked".  The "corked" status of an object is found by
 *         searching the "tag_list".  This field is added for optimization
 *         so that the skip list search on "tag_list" can be skipped if this
 *         field is zero, i.e. no "corked" objects.
 *
 * When a cache entry is protected, it must be removed from the LRU
 * list(s), as it cannot be either flushed or evicted until it is unprotected.
 * The following fields are used to implement the protected list (pl).
 *
 * pl_len: Number of entries currently residing on the protected list.
 *
 * pl_size: Number of bytes of cache entries currently residing on the
 *         protected list.
 *
 * pl_head_ptr: Pointer to the head of the doubly linked list of protected
 *         entries.  Note that cache entries on this list are linked
 *         by their next and prev fields.
 *
 *         This field is NULL if the list is empty.
 *
 * pl_tail_ptr: Pointer to the tail of the doubly linked list of protected
 *         entries.  Note that cache entries on this list are linked
 *         by their next and prev fields.
 *
 *         This field is NULL if the list is empty.
 *
 *
 * For very frequently used entries, the protect/unprotect overhead can
 * become burdensome.  To avoid this overhead, the cache allows entries to
 * be "pinned".  A pinned entry is similar to a protected entry, in the
 * sense that it cannot be evicted, and that the entry can be modified at
 * any time.
 *
 * Pinning an entry has the following implications:
 *
 *      1) A pinned entry cannot be evicted.  Thus unprotected pinned
 *         entries reside in the pinned entry list, instead of the LRU
 *         list(s) or other lists maintained by the current replacement
 *         policy code.
 *
 *      2) A pinned entry can be accessed or modified at any time.
 *         This places an additional burden on the associated pre-serialize
 *         and serialize callbacks, which must ensure the entry is in
 *         a consistent state before creating an image of it.
 *
 *      3) A pinned entry can be marked as dirty (and possibly
 *         change size) while it is unprotected.
 *
 *      4) The flush-destroy code must allow pinned entries to
 *         be unpinned (and possibly unprotected) during the flush.
 *
 * Since pinned entries cannot be evicted, they must be kept on a pinned
 * entry list (pel), instead of being entrusted to the replacement policy
 * code.
 *
 * Maintaining the pinned entry list requires the following fields:
 *
 * pel_len: Number of entries currently residing on the pinned entry list.
 *
 * pel_size: Number of bytes of cache entries currently residing on
 *         the pinned entry list.
 *
 * pel_head_ptr: Pointer to the head of the doubly linked list of pinned
 *         but not protected entries.  Note that cache entries on
 *         this list are linked by their next and prev fields.
 *
 *         This field is NULL if the list is empty.
 *
 * pel_tail_ptr: Pointer to the tail of the doubly linked list of pinned
 *         but not protected entries.  Note that cache entries on
 *         this list are linked by their next and prev fields.
 *
 *         This field is NULL if the list is empty.
 *
 *
 * The cache must have a replacement policy, and the fields supporting this
 * policy must be accessible from this structure.
 *
 * Fields supporting the modified LRU policy:
 *
 * When operating in parallel mode, we must ensure that a read does not
 * cause a write.  If it does, the process will hang, as the write will
 * be collective and the other processes will not know to participate.
 *
 * To deal with this issue, the usual LRU policy has been modified by adding
 * clean and dirty LRU lists to the usual LRU list.  In general, these
 * lists only exist in parallel builds.
 *
 * The clean LRU list is simply the regular LRU list with all dirty cache
 * entries removed.
 *
 * Similarly, the dirty LRU list is the regular LRU list with all the clean
 * cache entries removed.
 *
 * When reading in parallel mode, we evict from the clean LRU list only.
 * This implies that we must try to ensure that the clean LRU list is
 * reasonably well stocked at all times.  We attempt to do this by trying
 * to flush enough entries on each write to keep the cLRU_list_size >=
 * min_clean_size.
 *
 * Even if we start with a completely clean cache, a sequence of protects
 * without unprotects can empty the clean LRU list.  In this case, the
 * cache must grow temporarily.  At the next sync point, we will attempt to
 * evict enough entries to reduce index_size to less than max_cache_size.
 * While this will usually be possible, all bets are off if enough entries
 * are protected.
 *
 * Discussions of the individual fields used by the modified LRU replacement
 * policy follow:
 *
 * LRU_list_len:  Number of cache entries currently on the LRU list.
 *
 *              The LRU_list_len + pl_len + pel_len must always
 *              equal index_len.
 *
 * LRU_list_size:  Number of bytes of cache entries currently residing on the
 *              LRU list.
 *
 *              The LRU_list_size + pl_size + pel_size must always
 *              equal index_size.
 *
 * LRU_head_ptr:  Pointer to the head of the doubly linked LRU list.  Cache
 *              entries on this list are linked by their next and prev fields.
 *
 *              This field is NULL if the list is empty.
 *
 * LRU_tail_ptr:  Pointer to the tail of the doubly linked LRU list.  Cache
 *              entries on this list are linked by their next and prev fields.
 *
 *              This field is NULL if the list is empty.
 *
 * cLRU_list_len: Number of cache entries currently on the clean LRU list.
 *
 *              The cLRU_list_len + dLRU_list_len must always
 *              equal LRU_list_len.
 *
 * cLRU_list_size:  Number of bytes of cache entries currently residing on
 *              the clean LRU list.
 *
 *              The cLRU_list_size + dLRU_list_size must always
 *              equal LRU_list_size.
 *
 * cLRU_head_ptr:  Pointer to the head of the doubly linked clean LRU list.
 *              Cache entries on this list are linked by their aux_next and
 *              aux_prev fields.
 *
 *              This field is NULL if the list is empty.
 *
 * cLRU_tail_ptr:  Pointer to the tail of the doubly linked clean LRU list.
 *              Cache entries on this list are linked by their aux_next and
 *              aux_prev fields.
 *
 *              This field is NULL if the list is empty.
 *
 * dLRU_list_len: Number of cache entries currently on the dirty LRU list.
 *
 *              The cLRU_list_len + dLRU_list_len must always
 *              equal LRU_list_len.
 *
 * dLRU_list_size:  Number of cache entries currently on the dirty LRU list.
 *
 *              The cLRU_list_len + dLRU_list_len must always
 *              equal LRU_list_len.
 *
 * dLRU_head_ptr:  Pointer to the head of the doubly linked dirty LRU list.
 *              Cache entries on this list are linked by their aux_next and
 *              aux_prev fields.
 *
 *              This field is NULL if the list is empty.
 *
 * dLRU_tail_ptr:  Pointer to the tail of the doubly linked dirty LRU list.
 *              Cache entries on this list are linked by their aux_next and
 *              aux_prev fields.
 *
 *              This field is NULL if the list is empty.
 *
 *
 * Automatic cache size adjustment:
 *
 * While the default cache size is adequate for many cases, there are
 * cases where the default is too small.  Ideally, the user should
 * adjust the cache size as required.  However, this is not possible in all
 * cases, so the cache has automatic cache size adjustment code.
 *
 * The configuration for the automatic cache size adjustment is stored in
 * the structure described below:
 *
 * size_increase_possible:  Depending on the configuration data given
 *        in the resize_ctl field, it may or may not be possible to
 *        increase the size of the cache.  Rather than test for all the
 *        ways this can happen, we simply set this flag when we receive
 *        a new configuration.
 *
 * flash_size_increase_possible: Depending on the configuration data given
 *        in the resize_ctl field, it may or may not be possible for a
 *        flash size increase to occur.  We set this flag whenever we
 *        receive a new configuration so as to avoid repeated calculations.
 *
 * flash_size_increase_threshold: If a flash cache size increase is possible,
 *        this field is used to store the minimum size of a new entry or size
 *        increase needed to trigger a flash cache size increase.  Note that
 *        this field must be updated whenever the size of the cache is changed.
 *
 * size_decrease_possible:  Depending on the configuration data given in the
 *        resize_ctl field, it may or may not be possible to decrease the
 *        size of the cache.  Rather than test for all the ways this can
 *        happen, we simply set this flag when we receive a new configuration.
 *
 * resize_enabled:  This is another convenience flag which is set whenever
 *        a new set of values for resize_ctl are provided.  Very simply:
 *
 *        resize_enabled = size_increase_possible || size_decrease_possible;
 *
 * cache_full: Boolean flag used to keep track of whether the cache is
 *        full, so we can refrain from increasing the size of a
 *        cache which hasn't used up the space allotted to it.
 *
 *        The field is initialized to FALSE, and then set to TRUE
 *        whenever we attempt to make space in the cache.
 *
 * size_decreased:  Boolean flag set to TRUE whenever the maximum cache
 *        size is decreased.  The flag triggers a call to
 *        H5C__make_space_in_cache() on the next call to H5C_protect().
 *
 * resize_in_progress: As the metadata cache has become re-entrant, it is
 *        possible that a protect may trigger a call to
 *        H5C__auto_adjust_cache_size(), which may trigger a flush,
 *        which may trigger a protect, which will result in another
 *        call to H5C__auto_adjust_cache_size().
 *
 *        The resize_in_progress boolean flag is used to detect this,
 *        and to prevent the infinite recursion that would otherwise
 *        occur.
 *
 * msic_in_progress: As the metadata cache has become re-entrant, and as
 *        the free space manager code has become more tightly integrated
 *        with the metadata cache, it is possible that a call to
 *        H5C_insert_entry() may trigger a call to H5C_make_space_in_cache(),
 *        which, via H5C__flush_single_entry() and client callbacks, may
 *        trigger an infinite regression of calls to H5C_make_space_in_cache().
 *
 *        The msic_in_progress boolean flag is used to detect this,
 *        and prevent the infinite regression that would otherwise occur.
 *
 * resize_ctl: Instance of H5C_auto_size_ctl_t containing configuration
 *         data for automatic cache resizing.
 *
 * epoch_markers_active:  Integer field containing the number of epoch
 *        markers currently in use in the LRU list.  This value
 *        must be in the range [0, H5C__MAX_EPOCH_MARKERS - 1].
 *
 * epoch_marker_active:  Array of boolean of length H5C__MAX_EPOCH_MARKERS.
 *        This array is used to track which epoch markers are currently
 *        in use.
 *
 * epoch_marker_ringbuf:  Array of int of length H5C__MAX_EPOCH_MARKERS + 1.
 *
 *        To manage the epoch marker cache entries, it is necessary
 *        to track their order in the LRU list.  This is done with
 *        epoch_marker_ringbuf.  When markers are inserted at the
 *        head of the LRU list, the index of the marker in the
 *        epoch_markers array is inserted at the tail of the ring
 *        buffer.  When it becomes the epoch_marker_active'th marker
 *        in the LRU list, it will have worked its way to the head
 *        of the ring buffer as well.  This allows us to remove it
 *        without scanning the LRU list if such is required.
 *
 * epoch_marker_ringbuf_first: Integer field containing the index of the
 *        first entry in the ring buffer.
 *
 * epoch_marker_ringbuf_last: Integer field containing the index of the
 *        last entry in the ring buffer.
 *
 * epoch_marker_ringbuf_size: Integer field containing the number of entries
 *        in the ring buffer.
 *
 * epoch_markers:  Array of instances of H5C_cache_entry_t of length
 *        H5C__MAX_EPOCH_MARKERS.  The entries are used as markers in the
 *        LRU list to identify cache entries that haven't been accessed for
 *        some (small) specified number of epochs.  These entries (if any)
 *        can then be evicted and the cache size reduced -- ideally without
 *        evicting any of the current working set.  Needless to say, the epoch
 *        length and the number of epochs before an unused entry must be
 *        chosen so that all, or almost all, the working set will be accessed
 *        before the limit.
 *
 *        Epoch markers only appear in the LRU list, never in the index or
 *        skip list.  While they are of type H5C__EPOCH_MARKER_TYPE, and have
 *        associated class functions, these functions should never be called.
 *
 *        The addr fields of these instances of H5C_cache_entry_t are set to
 *        the index of the instance in the epoch_markers array, the size is
 *        set to 0, and the type field points to the constant structure
 *        epoch_marker_class defined in H5Cepoch.c.  The next and prev fields
 *        are used as usual to link the entry into the LRU list.
 *
 *        All other fields are unused.
 *
 *
 * Cache hit rate collection fields:
 *
 * We supply the current cache hit rate on request, so we must keep a
 * simple cache hit rate computation regardless of whether statistics
 * collection is enabled.  The following fields support this capability.
 *
 * cache_hits: Number of cache hits since the last time the cache hit rate
 *        statistics were reset.  Note that when automatic cache re-sizing
 *        is enabled, this field will be reset every automatic resize epoch.
 *
 * cache_accesses: Number of times the cache has been accessed while
 *        since the last since the last time the cache hit rate statistics
 *        were reset.  Note that when automatic cache re-sizing is enabled,
 *        this field will be reset every automatic resize epoch.
 *
 *
 * Metadata cache image management related fields.
 *
 * image_ctl: Instance of H5C_cache_image_ctl_t containing configuration
 *        data for generation of a cache image on file close.
 *
 * serialization_in_progress: Boolean field that is set to TRUE iff
 *        the cache is in the process of being serialized.  This field is
 *        needed to support the H5C_serialization_in_progress() call, which
 *        is in turn required for sanity checks in some cache clients.
 *
 * load_image: Boolean flag indicating that the metadata cache image
 *        superblock extension message exists and should be read, and the
 *        image block read and decoded on the next call to H5C_protect().
 *
 * image_loaded: Boolean flag indicating that the metadata cache has
 *        loaded the metadata cache image as directed by the
 *        cache image superblock extension message.
 *
 * delete_image: Boolean flag indicating whether the metadata cache image
 *        superblock message should be deleted and the cache image
 *        file space freed after they have been read and decoded.
 *
 *        This flag should be set to TRUE iff the file is opened
 *        R/W and there is a cache image to be read.
 *
 * image_addr: The base address of the on-disk metadata cache image, or
 *        HADDR_UNDEF if that value is undefined.  Note that this field
 *        is used both in the construction and write, and the read and
 *        decode of metadata cache image blocks.
 *
 * image_len: The size of the on disk metadata cache image, or zero if that
 *        value is undefined.  Note that this field is used both in the
 *        construction and write, and the read and decode of metadata cache
 *        image blocks.
 *
 * image_data_len:  The number of bytes of data in the on disk metadata
 *        cache image, or zero if that value is undefined.
 *
 *        In most cases, this value is the same as the image_len
 *        above.  It exists to allow for metadata cache image blocks
 *        that are larger than the actual image.  Thus in all
 *        cases image_data_len <= image_len.
 *
 * To create the metadata cache image, we must first serialize all the
 * entries in the metadata cache.  This is done by a scan of the index.
 * As entries must be serialized in increasing flush dependency height
 * order, we scan the index repeatedly, once for each flush dependency
 * height in increasing order.
 *
 * This operation is complicated by the fact that entries other than the
 * target may be inserted, loaded, relocated, or removed from the cache
 * (either by eviction or the take ownership flag) as the result of a
 * pre_serialize or serialize callback.  While entry removals are not
 * a problem for the scan of the index, insertions, loads, and relocations
 * are.  Hence the entries loaded, inserted, and relocated counters
 * listed below have been implemented to allow these conditions to be
 * detected and dealt with by restarting the scan.
 *
 * The serialization operation is further complicated by the fact that
 * the flush dependency height of a given entry may increase (as the
 * result of an entry load or insert) or decrease (as the result of an
 * entry removal -- via either eviction or the take ownership flag).  The
 * entry_fd_height_change_counter field is maintained to allow detection
 * of this condition, and a restart of the scan when it occurs.
 *
 * Note that all these new fields would work just as well as booleans.
 *
 * entries_loaded_counter: Number of entries loaded into the cache
 *        since the last time this field was reset.
 *
 * entries_inserted_counter: Number of entries inserted into the cache
 *        since the last time this field was reset.
 *
 * entries relocated_counter: Number of entries whose base address has
 *        been changed since the last time this field was reset.
 *
 * entry_fd_height_change_counter: Number of entries whose flush dependency
 *        height has changed since the last time this field was reset.
 *
 * The following fields are used assemble the cache image prior to
 * writing it to disk.
 *
 * num_entries_in_image: Unsigned integer field containing the number of
 *        entries to be copied into the metadata cache image.  Note that
 *        this value will be less than the number of entries in the cache,
 *        and the superblock and its related entries are not written to the
 *        metadata cache image.
 *
 * image_entries: Pointer to a dynamically allocated array of instance of
 *        H5C_image_entry_t of length num_entries_in_image, or NULL
 *        if that array does not exist.  This array is used to
 *        assemble entry data to be included in the image, and to
 *        sort them by flush dependency height and LRU rank.
 *
 * image_buffer: Pointer to the dynamically allocated buffer of length
 *        image_len in which the metadata cache image is assembled,
 *        or NULL if that buffer does not exist.
 *
 *
 * Free Space Manager Related fields:
 *
 * The free space managers for the file must be informed when we are about to
 * close or flush the file so that they order themselves accordingly.  This
 * used to be done much later in the close process, but with cache image and
 * page buffering, this is no longer viable, as we must finalize the on
 * disk image of all metadata much sooner.
 *
 * This is handled by the H5MF_settle_raw_data_fsm() and
 * H5MF_settle_meta_data_fsm() routines.  As these calls are expensive,
 * the following fields are used to track whether the target free space
 * managers are clean.
 *
 * They are also used in sanity checking, as once a free space manager is
 * settled, it should not become unsettled (i.e. be asked to allocate or
 * free file space) either ever (in the case of a file close) or until the
 * flush is complete.
 *
 * rdfsm_settled:  Boolean flag indicating whether the raw data free space
 *        manager is settled -- i.e. whether the correct space has
 *        been allocated for it in the file.
 *
 *        Note that the name of this field is deceptive.  In the
 *        multi file case, the flag applies to all free space
 *        managers that are not involved in allocating space for
 *        free space manager metadata.
 *
 * mdfsm_settled:  Boolean flag indicating whether the meta data free space
 *        manager is settled -- i.e. whether the correct space has
 *        been allocated for it in the file.
 *
 *        Note that the name of this field is deceptive.  In the
 *        multi-file case, the flag applies only to free space
 *        managers that are involved in allocating space for free
 *        space managers.
 *
 *
 * Statistics collection fields:
 *
 * When enabled, these fields are used to collect statistics as described
 * below.  The first set are collected only when H5C_COLLECT_CACHE_STATS
 * is true.
 *
 * hits: Array to record the number of times an entry with type id
 *        equal to the array index has been in cache when requested in
 *        the current epoch.
 *
 * misses: Array to record the number of times an entry with type id
 *        equal to the array index has not been in cache when
 *        requested in the current epoch.
 *
 * write_protects: Array to record the number of times an entry with
 *         type id equal to the array index has been write protected
 *         in the current epoch.
 *
 *         Observe that (hits + misses) = (write_protects + read_protects).
 *
 * read_protects: Array to record the number of times an entry with
 *         type id equal to the array index has been read protected in
 *         the current epoch.
 *
 *         Observe that (hits + misses) = (write_protects + read_protects).
 *
 * max_read_protects: Array to maximum number of simultaneous read
 *         protects on any entry with type id equal to the array index
 *         in the current epoch.
 *
 * insertions: Array to record the number of times an entry with type
 *        id equal to the array index has been inserted into the
 *        cache in the current epoch.
 *
 * pinned_insertions: Array to record the number of times an entry
 *         with type id equal to the array index has been inserted
 *         pinned into the cache in the current epoch.
 *
 * clears: Array to record the number of times a dirty entry with type
 *        id equal to the array index has been cleared in the current epoch.
 *
 * flushes: Array to record the number of times an entry with type id
 *        equal to the array index has been written to disk in the
 *        current epoch.
 *
 * evictions: Array to record the number of times an entry with type id
 *        equal to the array index has been evicted from the cache in
 *        the current epoch.
 *
 * take_ownerships: Array to record the number of times an entry with
 *        type id equal to the array index has been removed from the
 *        cache via the H5C__TAKE_OWNERSHIP_FLAG in the current epoch.
 *
 * moves: Array to record the number of times an entry with type
 *        id equal to the array index has been moved in the current epoch.
 *
 * entry_flush_moves: Array to record the number of times an entry
 *         with type id equal to the array index has been moved
 *         during its pre-serialize callback in the current epoch.
 *
 * cache_flush_moves: Array to record the number of times an entry
 *         with type id equal to the array index has been moved
 *         during a cache flush in the current epoch.
 *
 * pins: Array to record the number of times an entry with type
 *        id equal to the array index has been pinned in the current epoch.
 *
 * unpins: Array to record the number of times an entry with type
 *        id equal to the array index has been unpinned in the current epoch.
 *
 * dirty_pins: Array to record the number of times an entry with type
 *        id equal to the array index has been marked dirty while pinned
 *        in the current epoch.
 *
 * pinned_flushes: Array to record the number of times an entry
 *         with type id equal to the array index has been flushed while
 *         pinned in the current epoch.
 *
 * pinned_clears: Array to record the number of times an entry
 *         with type id equal to the array index has been cleared while
 *         pinned in the current epoch.
 *
 * size_increases: Array to record the number of times an entry
 *        with type id equal to the array index has increased in
 *        size in the current epoch.
 *
 * size_decreases: Array to record the number of times an entry
 *        with type id equal to the array index has decreased in
 *        size in the current epoch.
 *
 * entry_flush_size_changes: Array to record the number of times an entry
 *        with type id equal to the array index has changed size while in
 *        its pre-serialize callback.
 *
 * cache_flush_size_changes: Array to record the number of times an entry
 *        with type id equal to the array index has changed size during a
 *        cache flush
 *
 * total_ht_insertions: Number of times entries have been inserted into the
 *        hash table in the current epoch.
 *
 * total_ht_deletions: Number of times entries have been deleted from the
 *        hash table in the current epoch.
 *
 * successful_ht_searches: The total number of successful searches of the
 *        hash table in the current epoch.
 *
 * total_successful_ht_search_depth: The total number of entries other than
 *        the targets examined in successful searches of the hash table in
 *        the current epoch.
 *
 * failed_ht_searches: The total number of unsuccessful searches of the hash
 *        table in the current epoch.
 *
 * total_failed_ht_search_depth: The total number of entries examined in
 *        unsuccessful searches of the hash table in the current epoch.
 *
 * max_index_len: Largest value attained by the index_len field in the
 *        current epoch.
 *
 * max_index_size: Largest value attained by the index_size field in the
 *        current epoch.
 *
 * max_clean_index_size: Largest value attained by the clean_index_size field
 *         in the current epoch.
 *
 * max_dirty_index_size: Largest value attained by the dirty_index_size field
 *         in the current epoch.
 *
 * max_slist_len: Largest value attained by the slist_len field in the
 *        current epoch.
 *
 * max_slist_size: Largest value attained by the slist_size field in the
 *        current epoch.
 *
 * max_pl_len:  Largest value attained by the pl_len field in the
 *        current epoch.
 *
 * max_pl_size: Largest value attained by the pl_size field in the
 *        current epoch.
 *
 * max_pel_len: Largest value attained by the pel_len field in the
 *        current epoch.
 *
 * max_pel_size: Largest value attained by the pel_size field in the
 *        current epoch.
 *
 * calls_to_msic: Total number of calls to H5C__make_space_in_cache
 *
 * total_entries_skipped_in_msic: Number of clean entries skipped while
 *        enforcing the min_clean_fraction in H5C__make_space_in_cache().
 *
 * total_dirty_pf_entries_skipped_in_msic: Number of dirty prefetched entries
 *        skipped in H5C__make_space_in_cache().  Note that this can
 *        only occur when a file is opened R/O with a cache image
 *        containing dirty entries.
 *
 * total_entries_scanned_in_msic: Number of clean entries skipped while
 *        enforcing the min_clean_fraction in H5C__make_space_in_cache().
 *
 * max_entries_skipped_in_msic: Maximum number of clean entries skipped
 *        in any one call to H5C__make_space_in_cache().
 *
 * max_dirty_pf_entries_skipped_in_msic: Maximum number of dirty prefetched
 *        entries skipped in any one call to H5C__make_space_in_cache().
 *        Note that this can only occur when the file is opened
 *        R/O with a cache image containing dirty entries.
 *
 * max_entries_scanned_in_msic: Maximum number of entries scanned over
 *        in any one call to H5C__make_space_in_cache().
 *
 * entries_scanned_to_make_space: Number of entries scanned only when looking
 *        for entries to evict in order to make space in cache.
 *
 *
 * The following fields track statistics on cache images.
 *
 * images_created:  The number of cache images created since the last
 *        time statistics were reset.
 *
 *        At present, this field must always be either 0 or 1.
 *        Further, since cache images are only created at file
 *        close, this field should only be set at that time.
 *
 * images_read: The number of cache images read from file.  Note that
 *        reading an image is different from loading it -- reading the
 *        image means just that, while loading the image refers to decoding
 *        it and loading it into the metadata cache.
 *
 *        In the serial case, image_read should always equal images_loaded.
 *        However, in the parallel case, the image should only be read by
 *        process 0.  All other processes should receive the cache image via
 *        a broadcast from process 0.
 *
 * images_loaded:  The number of cache images loaded since the last time
 *        statistics were reset.
 *
 *        At present, this field must always be either 0 or 1.
 *        Further, since cache images are only loaded at the
 *        time of the first protect or on file close, this value
 *        should only change on those events.
 *
 * last_image_size:  Size of the most recently loaded metadata cache image
 *        loaded into the cache, or zero if no image has been loaded.
 *
 *        At present, at most one cache image can be loaded into
 *        the metadata cache for any given file, and this image
 *        will be loaded either on the first protect, or on file
 *        close if no entry is protected before then.
 *
 *
 * Fields for tracking prefetched entries.  Note that flushes and evictions
 * of prefetched entries are tracked in the flushes and evictions arrays
 * discussed above.
 *
 * prefetches: Number of prefetched entries that are loaded to the cache.
 *
 * dirty_prefetches: Number of dirty prefetched entries that are loaded
 *        into the cache.
 *
 * prefetch_hits: Number of prefetched entries that are actually used.
 *
 *
 * Entries may move, load, dirty, and delete other entries in their
 * pre_serialize and serialize callbacks, there is code to restart scans of
 * lists so as to avoid improper behavior if the next entry in the list is
 * the target of one on these operations.
 *
 * The following fields are use to count such occurrences.  They are used
 * both in tests (to verify that the scan has been restarted), and to
 * obtain estimates of how frequently these restarts occur.
 *
 * slist_scan_restarts: Number of times a scan of the skip list (that contains
 *        calls to H5C__flush_single_entry()) has been restarted to
 *        avoid potential issues with change of status of the next
 *        entry in the scan.
 *
 * LRU_scan_restarts: Number of times a scan of the LRU list (that contains
 *        calls to H5C__flush_single_entry()) has been restarted to
 *        avoid potential issues with change of status of the next
 *        entry in the scan.
 *
 * index_scan_restarts: Number of times a scan of the index has been
 *        restarted to avoid potential issues with load, insertion
 *        or change in flush dependency height of an entry other
 *        than the target entry as the result of call(s) to the
 *        pre_serialize or serialize callbacks.
 *
 *        Note that at present, this condition can only be triggered
 *        by a call to H5C_serialize_single_entry().
 *
 * The remaining stats are collected only when both H5C_COLLECT_CACHE_STATS
 * and H5C_COLLECT_CACHE_ENTRY_STATS are true.
 *
 * max_accesses: Array to record the maximum number of times any single
 *        entry with type id equal to the array index has been
 *        accessed in the current epoch.
 *
 * min_accesses: Array to record the minimum number of times any single
 *        entry with type id equal to the array index has been
 *        accessed in the current epoch.
 *
 * max_clears: Array to record the maximum number of times any single
 *        entry with type id equal to the array index has been cleared
 *        in the current epoch.
 *
 * max_flushes: Array to record the maximum number of times any single
 *        entry with type id equal to the array index has been
 *        flushed in the current epoch.
 *
 * max_size: Array to record the maximum size of any single entry
 *        with type id equal to the array index that has resided in
 *        the cache in the current epoch.
 *
 * max_pins: Array to record the maximum number of times that any single
 *        entry with type id equal to the array index that has been
 *        marked as pinned in the cache in the current epoch.
 *
 *
 * Fields supporting testing:
 *
 * prefix: Array of char used to prefix debugging output.  The field is
 *        intended to allow marking of output of with the processes mpi rank.
 *
 * get_entry_ptr_from_addr_counter: Counter used to track the number of
 *        times the H5C_get_entry_ptr_from_addr() function has been
 *        called successfully.  This field is only defined when
 *        NDEBUG is not #defined.
 *
 ****************************************************************************/
struct H5C_t {
    hbool_t             flush_in_progress;
    H5C_log_info_t *    log_info;
    void *              aux_ptr;
    int32_t             max_type_id;
    const H5C_class_t * const *class_table_ptr;
    size_t              max_cache_size;
    size_t              min_clean_size;
    H5C_write_permitted_func_t check_write_permitted;
    hbool_t             write_permitted;
    H5C_log_flush_func_t log_flush;
    hbool_t             evictions_enabled;
    hbool_t             close_warning_received;

    /* Fields for maintaining the [hash table] index of entries */
    uint32_t            index_len;
    size_t              index_size;
    uint32_t            index_ring_len[H5C_RING_NTYPES];
    size_t              index_ring_size[H5C_RING_NTYPES];
    size_t              clean_index_size;
    size_t              clean_index_ring_size[H5C_RING_NTYPES];
    size_t              dirty_index_size;
    size_t              dirty_index_ring_size[H5C_RING_NTYPES];
    H5C_cache_entry_t * index[H5C__HASH_TABLE_LEN];
    uint32_t            il_len;
    size_t              il_size;
    H5C_cache_entry_t * il_head;
    H5C_cache_entry_t * il_tail;

    /* Fields to detect entries removed during scans */
    int64_t             entries_removed_counter;
    H5C_cache_entry_t * last_entry_removed_ptr;
    H5C_cache_entry_t * entry_watched_for_removal;

    /* Fields for maintaining list of in-order entries, for flushing */
    hbool_t             slist_enabled;
    hbool_t             slist_changed;
    uint32_t            slist_len;
    size_t              slist_size;
    uint32_t            slist_ring_len[H5C_RING_NTYPES];
    size_t              slist_ring_size[H5C_RING_NTYPES];
    H5SL_t *            slist_ptr;
    uint32_t            num_last_entries;
#ifdef H5C_DO_SANITY_CHECKS
    int32_t             slist_len_increase;
    int64_t             slist_size_increase;
#endif /* H5C_DO_SANITY_CHECKS */

    /* Fields for maintaining list of tagged entries */
    H5C_tag_info_t *    tag_list;
    hbool_t             ignore_tags;
    uint32_t            num_objs_corked;

    /* Fields for tracking protected entries */
    uint32_t            pl_len;
    size_t              pl_size;
    H5C_cache_entry_t * pl_head_ptr;
    H5C_cache_entry_t * pl_tail_ptr;

    /* Fields for tracking pinned entries */
    uint32_t            pel_len;
    size_t              pel_size;
    H5C_cache_entry_t * pel_head_ptr;
    H5C_cache_entry_t * pel_tail_ptr;

    /* Fields for complete LRU list of entries */
    uint32_t            LRU_list_len;
    size_t              LRU_list_size;
    H5C_cache_entry_t * LRU_head_ptr;
    H5C_cache_entry_t * LRU_tail_ptr;

#if H5C_MAINTAIN_CLEAN_AND_DIRTY_LRU_LISTS
    /* Fields for clean LRU list of entries */
    uint32_t            cLRU_list_len;
    size_t              cLRU_list_size;
    H5C_cache_entry_t * cLRU_head_ptr;
    H5C_cache_entry_t * cLRU_tail_ptr;

    /* Fields for dirty LRU list of entries */
    uint32_t            dLRU_list_len;
    size_t              dLRU_list_size;
    H5C_cache_entry_t * dLRU_head_ptr;
    H5C_cache_entry_t * dLRU_tail_ptr;
#endif /* H5C_MAINTAIN_CLEAN_AND_DIRTY_LRU_LISTS */

#ifdef H5_HAVE_PARALLEL
    /* Fields for collective metadata reads */
    uint32_t            coll_list_len;
    size_t              coll_list_size;
    H5C_cache_entry_t * coll_head_ptr;
    H5C_cache_entry_t * coll_tail_ptr;

    /* Fields for collective metadata writes */
    H5SL_t *            coll_write_list;
#endif /* H5_HAVE_PARALLEL */

    /* Fields for automatic cache size adjustment */
    hbool_t             size_increase_possible;
    hbool_t             flash_size_increase_possible;
    size_t              flash_size_increase_threshold;
    hbool_t             size_decrease_possible;
    hbool_t             resize_enabled;
    hbool_t             cache_full;
    hbool_t             size_decreased;
    hbool_t             resize_in_progress;
    hbool_t             msic_in_progress;
    H5C_auto_size_ctl_t resize_ctl;

    /* Fields for epoch markers used in automatic cache size adjustment */
    int32_t             epoch_markers_active;
    hbool_t             epoch_marker_active[H5C__MAX_EPOCH_MARKERS];
    int32_t             epoch_marker_ringbuf[H5C__MAX_EPOCH_MARKERS+1];
    int32_t             epoch_marker_ringbuf_first;
    int32_t             epoch_marker_ringbuf_last;
    int32_t             epoch_marker_ringbuf_size;
    H5C_cache_entry_t   epoch_markers[H5C__MAX_EPOCH_MARKERS];

    /* Fields for cache hit rate collection */
    int64_t             cache_hits;
    int64_t             cache_accesses;

    /* fields supporting generation of a cache image on file close */
    H5C_cache_image_ctl_t image_ctl;
    hbool_t             serialization_in_progress;
    hbool_t             load_image;
    hbool_t             image_loaded;
    hbool_t             delete_image;
    haddr_t             image_addr;
    hsize_t             image_len;
    hsize_t             image_data_len;
    int64_t             entries_loaded_counter;
    int64_t             entries_inserted_counter;
    int64_t             entries_relocated_counter;
    int64_t             entry_fd_height_change_counter;
    uint32_t            num_entries_in_image;
    H5C_image_entry_t * image_entries;
    void *              image_buffer;

    /* Free Space Manager Related fields */
    hbool_t             rdfsm_settled;
    hbool_t             mdfsm_settled;

#if H5C_COLLECT_CACHE_STATS
    /* stats fields */
    int64_t             hits[H5C__MAX_NUM_TYPE_IDS + 1];
    int64_t             misses[H5C__MAX_NUM_TYPE_IDS + 1];
    int64_t             write_protects[H5C__MAX_NUM_TYPE_IDS + 1];
    int64_t             read_protects[H5C__MAX_NUM_TYPE_IDS + 1];
    int32_t             max_read_protects[H5C__MAX_NUM_TYPE_IDS + 1];
    int64_t             insertions[H5C__MAX_NUM_TYPE_IDS + 1];
    int64_t             pinned_insertions[H5C__MAX_NUM_TYPE_IDS + 1];
    int64_t             clears[H5C__MAX_NUM_TYPE_IDS + 1];
    int64_t             flushes[H5C__MAX_NUM_TYPE_IDS + 1];
    int64_t             evictions[H5C__MAX_NUM_TYPE_IDS + 1];
    int64_t             take_ownerships[H5C__MAX_NUM_TYPE_IDS + 1];
    int64_t             moves[H5C__MAX_NUM_TYPE_IDS + 1];
    int64_t             entry_flush_moves[H5C__MAX_NUM_TYPE_IDS + 1];
    int64_t             cache_flush_moves[H5C__MAX_NUM_TYPE_IDS + 1];
    int64_t             pins[H5C__MAX_NUM_TYPE_IDS + 1];
    int64_t             unpins[H5C__MAX_NUM_TYPE_IDS + 1];
    int64_t             dirty_pins[H5C__MAX_NUM_TYPE_IDS + 1];
    int64_t             pinned_flushes[H5C__MAX_NUM_TYPE_IDS + 1];
    int64_t             pinned_clears[H5C__MAX_NUM_TYPE_IDS + 1];
    int64_t             size_increases[H5C__MAX_NUM_TYPE_IDS + 1];
    int64_t             size_decreases[H5C__MAX_NUM_TYPE_IDS + 1];
    int64_t             entry_flush_size_changes[H5C__MAX_NUM_TYPE_IDS + 1];
    int64_t             cache_flush_size_changes[H5C__MAX_NUM_TYPE_IDS + 1];

    /* Fields for hash table operations */
    int64_t             total_ht_insertions;
    int64_t             total_ht_deletions;
    int64_t             successful_ht_searches;
    int64_t             total_successful_ht_search_depth;
    int64_t             failed_ht_searches;
    int64_t             total_failed_ht_search_depth;
    uint32_t            max_index_len;
    size_t              max_index_size;
    size_t              max_clean_index_size;
    size_t              max_dirty_index_size;

    /* Fields for in-order skip list */
    uint32_t            max_slist_len;
    size_t              max_slist_size;

    /* Fields for protected entry list */
    uint32_t            max_pl_len;
    size_t              max_pl_size;

    /* Fields for pinned entry list */
    uint32_t            max_pel_len;
    size_t              max_pel_size;

    /* Fields for tracking 'make space in cache' (msic) operations */
    int64_t             calls_to_msic;
    int64_t             total_entries_skipped_in_msic;
    int64_t             total_dirty_pf_entries_skipped_in_msic;
    int64_t             total_entries_scanned_in_msic;
    int32_t             max_entries_skipped_in_msic;
    int32_t             max_dirty_pf_entries_skipped_in_msic;
    int32_t             max_entries_scanned_in_msic;
    int64_t             entries_scanned_to_make_space;

    /* Fields for tracking skip list scan restarts */
    int64_t             slist_scan_restarts;
    int64_t             LRU_scan_restarts;
    int64_t             index_scan_restarts;

    /* Fields for tracking cache image operations */
    int32_t             images_created;
    int32_t             images_read;
    int32_t             images_loaded;
    hsize_t             last_image_size;

    /* Fields for tracking prefetched entries */
    int64_t             prefetches;
    int64_t             dirty_prefetches;
    int64_t             prefetch_hits;

#if H5C_COLLECT_CACHE_ENTRY_STATS
    int32_t             max_accesses[H5C__MAX_NUM_TYPE_IDS + 1];
    int32_t             min_accesses[H5C__MAX_NUM_TYPE_IDS + 1];
    int32_t             max_clears[H5C__MAX_NUM_TYPE_IDS + 1];
    int32_t             max_flushes[H5C__MAX_NUM_TYPE_IDS + 1];
    size_t              max_size[H5C__MAX_NUM_TYPE_IDS + 1];
    int32_t             max_pins[H5C__MAX_NUM_TYPE_IDS + 1];
#endif /* H5C_COLLECT_CACHE_ENTRY_STATS */
#endif /* H5C_COLLECT_CACHE_STATS */

    char                prefix[H5C__PREFIX_LEN];

#ifndef NDEBUG
    int64_t             get_entry_ptr_from_addr_counter;
#endif

}; /* H5C_t */

/* Define typedef for tagged cache entry iteration callbacks */
typedef int (*H5C_tag_iter_cb_t)(H5C_cache_entry_t *entry, void *ctx);


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


/******************************/
/* Package Private Prototypes */
/******************************/
H5_DLL herr_t H5C__prep_image_for_file_close(H5F_t *f, hbool_t *image_generated);

/* General routines */
H5_DLL herr_t H5C__auto_adjust_cache_size(H5F_t *f, hbool_t write_permitted);
H5_DLL herr_t H5C__autoadjust__ageout__remove_all_markers(H5C_t *cache_ptr);
H5_DLL herr_t H5C__autoadjust__ageout__remove_excess_markers(H5C_t *cache_ptr);
H5_DLL herr_t H5C__flash_increase_cache_size(H5C_t *cache_ptr, size_t old_entry_size, size_t new_entry_size);
H5_DLL herr_t H5C__flush_invalidate_cache(H5F_t *f, unsigned flags);
H5_DLL herr_t H5C__flush_ring(H5F_t *f, H5C_ring_t ring, unsigned flags);
H5_DLL herr_t H5C__flush_single_entry(H5F_t *f, H5C_cache_entry_t *entry_ptr,
    unsigned flags);
H5_DLL herr_t H5C__generate_cache_image(H5F_t *f, H5C_t *cache_ptr);
H5_DLL herr_t H5C__load_cache_image(H5F_t *f);
H5_DLL herr_t H5C__make_space_in_cache(H5F_t * f, size_t space_needed,
    hbool_t write_permitted);
H5_DLL herr_t H5C__serialize_cache(H5F_t *f);
H5_DLL herr_t H5C__serialize_single_entry(H5F_t *f, H5C_t *cache_ptr, H5C_cache_entry_t *entry_ptr);
H5_DLL herr_t H5C__iter_tagged_entries(H5C_t *cache, haddr_t tag, hbool_t match_global,
    H5C_tag_iter_cb_t cb, void *cb_ctx);

/* Routines for operating on entry tags */
H5_DLL herr_t H5C__tag_entry(H5C_t * cache_ptr, H5C_cache_entry_t * entry_ptr);
H5_DLL herr_t H5C__untag_entry(H5C_t *cache, H5C_cache_entry_t *entry);

/* Routines for operating on cache images */
H5_DLL herr_t H5C__get_cache_image_config(const H5C_t *cache_ptr, H5C_cache_image_ctl_t *config_ptr);
H5_DLL herr_t H5C__image_stats(H5C_t *cache_ptr, hbool_t print_header);

/* Debugging routines */
#ifdef H5C_DO_SLIST_SANITY_CHECKS
H5_DLL hbool_t H5C__entry_in_skip_list(H5C_t *cache_ptr, H5C_cache_entry_t *target_ptr);
#endif
#ifdef H5C_DO_EXTREME_SANITY_CHECKS
H5_DLL herr_t H5C__validate_lru_list(H5C_t *cache_ptr);
H5_DLL herr_t H5C__validate_pinned_entry_list(H5C_t *cache_ptr);
H5_DLL herr_t H5C__validate_protected_entry_list(H5C_t *cache_ptr);
#endif /* H5C_DO_EXTREME_SANITY_CHECKS */

/* Testing functions */
#ifdef H5C_TESTING
H5_DLL herr_t H5C__verify_cork_tag_test(hid_t fid, H5O_token_t tag_token, hbool_t status);
#endif /* H5C_TESTING */

#endif /* H5Cpkg_H */
/* clang-format on */