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
|
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
* Copyright by the Board of Trustees of the University of Illinois. *
* All rights reserved. *
* *
* This file is part of HDF5. The full HDF5 copyright notice, including *
* terms governing use, modification, and redistribution, is contained in *
* the files COPYING and Copyright.html. COPYING can be found at the root *
* of the source code distribution tree; Copyright.html can be found at the *
* root level of an installed copy of the electronic HDF5 document set and *
* is linked from the top-level documents page. It can also be found at *
* http://hdf.ncsa.uiuc.edu/HDF5/doc/Copyright.html. If you do not have *
* access to either file, you may request a copy from hdfhelp@ncsa.uiuc.edu. *
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
/*
* Programmer: Quincey Koziol <koziol@ncsa.uiuc.edu>
* Thursday, March 23, 2000
*
* Purpose: Manage priority queues of free-lists (of blocks of bytes).
* These are used in various places in the library which allocate and
* free differently blocks of bytes repeatedly. Usually the same size
* of block is allocated and freed repeatly in a loop, while writing out
* chunked data for example, but the blocks may also be of different sizes
* from different datasets and an attempt is made to optimize access to
* the proper free list of blocks by using these priority queues to
* move frequently accessed free lists to the head of the queue.
*/
/* #define H5FL_DEBUG */
#include "H5private.h" /*library */
#include "H5Eprivate.h" /*error handling */
#include "H5MMprivate.h" /*Core memory management */
#include "H5FLprivate.h" /*Priority queues */
#define PABLO_MASK H5FL_mask
static int interface_initialize_g = 0;
#define INTERFACE_INIT NULL
/*
* Private type definitions
*/
/*
Default limits on how much memory can accumulate on each free list before
it is garbage collected.
*/
static size_t H5FL_reg_glb_mem_lim=1*16*65536;/* Default to 1MB limit on all regular free lists */
static size_t H5FL_reg_lst_mem_lim=1*65536; /* Default to 64KB limit on each regular free list */
static size_t H5FL_arr_glb_mem_lim=4*16*65536;/* Default to 4MB limit on all array free lists */
static size_t H5FL_arr_lst_mem_lim=4*65536; /* Default to 256KB limit on each array free list */
static size_t H5FL_blk_glb_mem_lim=16*16*65536; /* Default to 16MB limit on all block free lists */
static size_t H5FL_blk_lst_mem_lim=16*65536; /* Default to 1024KB (1MB) limit on each block free list */
/* A garbage collection node for regular free lists */
typedef struct H5FL_reg_gc_node_t {
H5FL_reg_head_t *list; /* Pointer to the head of the list to garbage collect */
struct H5FL_reg_gc_node_t *next; /* Pointer to the next node in the list of things to garbage collect */
} H5FL_reg_gc_node_t;
/* The garbage collection head for regular free lists */
typedef struct H5FL_reg_gc_list_t {
size_t mem_freed; /* Amount of free memory on list */
struct H5FL_reg_gc_node_t *first; /* Pointer to the first node in the list of things to garbage collect */
} H5FL_reg_gc_list_t;
/* The head of the list of things to garbage collect */
static H5FL_reg_gc_list_t H5FL_reg_gc_head={0,NULL};
/* A garbage collection node for array free lists */
typedef struct H5FL_gc_arr_node_t {
H5FL_arr_head_t *list; /* Pointer to the head of the list to garbage collect */
struct H5FL_gc_arr_node_t *next; /* Pointer to the next node in the list of things to garbage collect */
} H5FL_gc_arr_node_t;
/* The garbage collection head for array free lists */
typedef struct H5FL_gc_arr_list_t {
size_t mem_freed; /* Amount of free memory on list */
struct H5FL_gc_arr_node_t *first; /* Pointer to the first node in the list of things to garbage collect */
} H5FL_gc_arr_list_t;
/* The head of the list of array things to garbage collect */
static H5FL_gc_arr_list_t H5FL_arr_gc_head={0,NULL};
/* A garbage collection node for blocks */
typedef struct H5FL_blk_gc_node_t {
H5FL_blk_head_t *pq; /* Pointer to the head of the PQ to garbage collect */
struct H5FL_blk_gc_node_t *next; /* Pointer to the next node in the list of things to garbage collect */
} H5FL_blk_gc_node_t;
/* The garbage collection head for blocks */
typedef struct H5FL_blk_gc_list_t {
size_t mem_freed; /* Amount of free memory on list */
struct H5FL_blk_gc_node_t *first; /* Pointer to the first node in the list of things to garbage collect */
} H5FL_blk_gc_list_t;
/* The head of the list of PQs to garbage collect */
static H5FL_blk_gc_list_t H5FL_blk_gc_head={0,NULL};
/* Macros for turning off free lists in the library */
/* #define NO_FREE_LISTS */
#ifdef NO_FREE_LISTS
#define NO_REG_FREE_LISTS
#define NO_ARR_FREE_LISTS
#define NO_BLK_FREE_LISTS
#endif /* NO_FREE_LISTS */
/* Forward declarations of local static functions */
static herr_t H5FL_reg_gc(void);
static herr_t H5FL_reg_gc_list(H5FL_reg_head_t *head);
static herr_t H5FL_arr_gc(void);
static herr_t H5FL_arr_gc_list(H5FL_arr_head_t *head);
static herr_t H5FL_blk_gc(void);
static herr_t H5FL_blk_gc_list(H5FL_blk_head_t *head);
/* Declare a free list to manage the H5FL_blk_node_t struct */
H5FL_DEFINE(H5FL_blk_node_t);
/*-------------------------------------------------------------------------
* Function: H5FL_malloc
*
* Purpose: Attempt to allocate space using malloc. If malloc fails, garbage
* collect and try again. If malloc fails again, then return NULL.
*
* Return: Success: non-NULL
* Failure: NULL
*
* Programmer: Quincey Koziol
* Tuesday, August 1, 2000
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
static void *
H5FL_malloc(hsize_t mem_size)
{
void *ret_value=NULL; /* return value*/
FUNC_ENTER (H5FL_malloc, NULL);
/* Attempt to allocate the memory requested */
assert(mem_size==(hsize_t)((size_t)mem_size)); /*check for overflow*/
if(NULL==(ret_value=H5MM_malloc((size_t)mem_size))) {
/* If we can't allocate the memory now, try garbage collecting first */
H5FL_garbage_coll();
/* Now try allocating the memory again */
if(NULL==(ret_value=H5MM_malloc((size_t)mem_size)))
HGOTO_ERROR(H5E_RESOURCE, H5E_NOSPACE, NULL, "memory allocation failed for chunk");
} /* end if */
done:
FUNC_LEAVE (ret_value);
} /* end H5FL_malloc() */
/*-------------------------------------------------------------------------
* Function: H5FL_reg_init
*
* Purpose: Initialize a free list for a certain type. Right now, this just
* adds the free list to the list of things to garbage collect.
*
* Return: Success: Non-negative
* Failure: Negative
*
* Programmer: Quincey Koziol
* Friday, March 24, 2000
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
static herr_t
H5FL_reg_init(H5FL_reg_head_t *head)
{
H5FL_reg_gc_node_t *new_node; /* Pointer to the node for the new list to garbage collect */
herr_t ret_value=SUCCEED; /* return value*/
FUNC_ENTER (H5FL_reg_init, FAIL);
/* Allocate a new garbage collection node */
if (NULL==(new_node = H5MM_malloc(sizeof(H5FL_reg_gc_node_t))))
HRETURN_ERROR (H5E_RESOURCE, H5E_NOSPACE, FAIL, "memory allocation failed");
/* Initialize the new garbage collection node */
new_node->list=head;
/* Link in to the garbage collection list */
new_node->next=H5FL_reg_gc_head.first;
H5FL_reg_gc_head.first=new_node;
/* Indicate that the free list is initialized */
head->init=1;
FUNC_LEAVE (ret_value);
} /* end H5FL_reg_init() */
/*-------------------------------------------------------------------------
* Function: H5FL_reg_free
*
* Purpose: Release an object & put on free list
*
* Return: Success: Non-negative
* Failure: Negative
*
* Programmer: Quincey Koziol
* Friday, March 24, 2000
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
void *
H5FL_reg_free(H5FL_reg_head_t *head, void *obj)
{
H5FL_reg_node_t *temp; /* Temp. ptr to the new free list node allocated */
FUNC_ENTER (H5FL_reg_free, NULL);
/* Double check parameters */
assert(head);
assert(obj);
#ifdef H5FL_DEBUG
HDmemset(obj,255,head->size);
#endif /* H5FL_DEBUG */
#ifdef NO_REG_FREE_LISTS
H5MM_xfree(obj);
#else /* NO_REG_FREE_LISTS */
/* Make certain that the free list is initialized */
assert(head->init);
/* Get the pointer to the info header in front of the block to free */
temp=(H5FL_reg_node_t *)((unsigned char *)obj-sizeof(H5FL_reg_node_t));
#ifdef H5FL_DEBUG
assert(temp->inuse);
temp->inuse=0;
#endif /* H5FL_DEBUG */
/* Link into the free list */
temp->next=head->list;
/* Point free list at the node freed */
head->list=temp;
/* Increment the number of blocks & memory on free list */
head->onlist++;
head->list_mem+=head->size;
/* Increment the amount of "regular" freed memory globally */
H5FL_reg_gc_head.mem_freed+=head->size;
/* Check for exceeding free list memory use limits */
/* First check this particular list */
if(head->list_mem>H5FL_reg_lst_mem_lim)
H5FL_reg_gc_list(head);
/* Then check the global amount memory on regular free lists */
if(H5FL_reg_gc_head.mem_freed>H5FL_reg_glb_mem_lim)
H5FL_reg_gc();
#endif /* NO_REG_FREE_LISTS */
FUNC_LEAVE(NULL);
} /* end H5FL_reg_free() */
/*-------------------------------------------------------------------------
* Function: H5FL_reg_alloc
*
* Purpose: Allocate a block on a free list
*
* Return: Success: Pointer to a valid object
* Failure: NULL
*
* Programmer: Quincey Koziol
* Friday, March 24, 2000
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
void *
H5FL_reg_alloc(H5FL_reg_head_t *head, unsigned clear)
{
H5FL_reg_node_t *new_obj; /* Pointer to the new free list node allocated */
void *ret_value; /* Pointer to object to return */
FUNC_ENTER (H5FL_reg_alloc, NULL);
/* Double check parameters */
assert(head);
#ifdef NO_REG_FREE_LISTS
if(clear)
ret_value=H5MM_calloc(head->size);
else
ret_value=H5MM_malloc(head->size);
#else /* NO_REG_FREE_LISTS */
/* Make certain the list is initialized first */
if(!head->init)
H5FL_reg_init(head);
/* Check for nodes available on the free list first */
if(head->list!=NULL) {
/* Get a pointer to the block on the free list */
ret_value=((char *)(head->list))+sizeof(H5FL_reg_node_t);
#ifdef H5FL_DEBUG
head->list->inuse=1;
#endif /* H5FL_DEBUG */
/* Remove node from free list */
head->list=head->list->next;
/* Decrement the number of blocks & memory on free list */
head->onlist--;
head->list_mem-=head->size;
/* Decrement the amount of global "regular" free list memory in use */
H5FL_reg_gc_head.mem_freed-=(head->size);
} /* end if */
/* Otherwise allocate a node */
else {
if (NULL==(new_obj = H5FL_malloc((hsize_t)(sizeof(H5FL_reg_node_t)+head->size))))
HRETURN_ERROR (H5E_RESOURCE, H5E_NOSPACE, NULL, "memory allocation failed");
#ifdef H5FL_DEBUG
new_obj->inuse=1;
#endif /* H5FL_DEBUG */
/* Increment the number of blocks allocated in list */
head->allocated++;
/* Get a pointer to the new block */
ret_value=((char *)new_obj)+sizeof(H5FL_reg_node_t);
} /* end else */
/* Clear to zeros, if asked */
if(clear) {
assert(head->size==(hsize_t)((size_t)head->size)); /*check for overflow*/
HDmemset(ret_value,0,(size_t)head->size);
} /* end if */
#endif /* NO_REG_FREE_LISTS */
FUNC_LEAVE (ret_value);
} /* end H5FL_reg_alloc() */
/*-------------------------------------------------------------------------
* Function: H5FL_reg_gc_list
*
* Purpose: Garbage collect on a particular object free list
*
* Return: Success: Non-negative
* Failure: Negative
*
* Programmer: Quincey Koziol
* Tuesday, July 25, 2000
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
static herr_t
H5FL_reg_gc_list(H5FL_reg_head_t *head)
{
H5FL_reg_node_t *free_list; /* Pointer to nodes in free list being garbage collected */
void *tmp; /* Temporary node pointer */
size_t total_mem; /* Total memory used on list */
/* FUNC_ENTER_INIT() should not be called, it causes an infinite loop at library termination */
/* Calculate the total memory used on this list */
total_mem=head->onlist*head->size;
/* For each free list being garbage collected, walk through the nodes and free them */
free_list=head->list;
while(free_list!=NULL) {
tmp=free_list->next;
/* Decrement the count of nodes allocated and free the node */
head->allocated--;
/* Decrement count of free memory on this list */
head->list_mem-=head->size;
#ifdef H5FL_DEBUG
assert(!free_list->inuse);
#endif /* H5FL_DEBUG */
H5MM_xfree(free_list);
free_list=tmp;
} /* end while */
/* Double check that all the memory on this list is recycled */
assert(head->list_mem==0);
/* Indicate no free nodes on the free list */
head->list=NULL;
head->onlist=0;
/* Decrement global count of free memory on "regular" lists */
H5FL_reg_gc_head.mem_freed-=total_mem;
return(SUCCEED);
} /* end H5FL_reg_gc_list() */
/*-------------------------------------------------------------------------
* Function: H5FL_reg_gc
*
* Purpose: Garbage collect on all the object free lists
*
* Return: Success: Non-negative
* Failure: Negative
*
* Programmer: Quincey Koziol
* Friday, March 24, 2000
*
* Modifications:
* Broke into two parts, one for looping over all the free lists and
* another for freeing each list - QAK 7/25/00
*
*-------------------------------------------------------------------------
*/
static herr_t
H5FL_reg_gc(void)
{
H5FL_reg_gc_node_t *gc_node; /* Pointer into the list of things to garbage collect */
/* FUNC_ENTER_INIT() should not be called, it causes an infinite loop at library termination */
/* Walk through all the free lists, free()'ing the nodes */
gc_node=H5FL_reg_gc_head.first;
while(gc_node!=NULL) {
/* Release the free nodes on the list */
H5FL_reg_gc_list(gc_node->list);
/* Go on to the next free list to garbage collect */
gc_node=gc_node->next;
} /* end while */
/* Double check that all the memory on the free lists is recycled */
assert(H5FL_reg_gc_head.mem_freed==0);
return(SUCCEED);
} /* end H5FL_reg_gc() */
/*--------------------------------------------------------------------------
NAME
H5FL_reg_term
PURPOSE
Terminate various H5FL object free lists
USAGE
int H5FL_term()
RETURNS
Success: Positive if any action might have caused a change in some
other interface; zero otherwise.
Failure: Negative
DESCRIPTION
Release any resources allocated.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
Can't report errors...
EXAMPLES
REVISION LOG
Robb Matzke, 2000-04-25
If a list cannot be freed because something is using it then return
zero (failure to free a list doesn't affect any other part of the
library). If some other layer frees something during its termination
it will return non-zero, which will cause this function to get called
again to reclaim this layer's memory.
--------------------------------------------------------------------------*/
static int
H5FL_reg_term(void)
{
H5FL_reg_gc_node_t *left; /* pointer to garbage collection lists with work left */
H5FL_reg_gc_node_t *tmp; /* Temporary pointer to a garbage collection node */
if (interface_initialize_g) {
/* Free the nodes on the garbage collection list, keeping nodes with allocations outstanding */
left=NULL;
while(H5FL_reg_gc_head.first!=NULL) {
tmp=H5FL_reg_gc_head.first->next;
#ifdef H5FL_DEBUG
printf("H5FL_reg_term: head->name=%s, head->allocated=%d\n", H5FL_reg_gc_head.first->list->name,(int)H5FL_reg_gc_head.first->list->allocated);
#endif /* H5FL_DEBUG */
/* Check if the list has allocations outstanding */
if(H5FL_reg_gc_head.first->list->allocated>0) {
/* Add free list to the list of nodes with allocations open still */
H5FL_reg_gc_head.first->next=left;
left=H5FL_reg_gc_head.first;
} /* end if */
/* No allocations left open for list, get rid of it */
else {
/* Reset the "initialized" flag, in case we restart this list somehow (I don't know how..) */
H5FL_reg_gc_head.first->list->init=0;
/* Free the node from the garbage collection list */
H5MM_xfree(H5FL_reg_gc_head.first);
} /* end else */
H5FL_reg_gc_head.first=tmp;
} /* end while */
/* Point to the list of nodes left with allocations open, if any */
H5FL_reg_gc_head.first=left;
if (!left)
interface_initialize_g = 0; /*this layer has reached its initial state*/
}
/* Terminating this layer never affects other layers; rather, other layers affect
* the termination of this layer. */
return(0);
} /* end H5FL_reg_term() */
/*-------------------------------------------------------------------------
* Function: H5FL_blk_find_list
*
* Purpose: Finds the free list for blocks of a given size. Also moves that
* free list node to the head of the priority queue (if it isn't there
* already). This routine does not manage the actual free list, it just
* works with the priority queue.
*
* Return: Success: valid pointer to the free list node
*
* Failure: NULL
*
* Programmer: Quincey Koziol
* Thursday, March 23, 2000
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
static H5FL_blk_node_t *
H5FL_blk_find_list(H5FL_blk_node_t **head, hsize_t size)
{
H5FL_blk_node_t *temp; /* Temp. pointer to node in the native list */
H5FL_blk_node_t *ret_value=NULL;
FUNC_ENTER(H5FL_blk_find_list, NULL);
/* Find the correct free list */
temp=*head;
while(temp!=NULL && temp->size!=size)
temp=temp->next;
/* If the free list exists, move it to the front of the queue, if it's not there already */
if(temp!=NULL && temp!=*head) {
/* Take the node found out of it's current position */
if(temp->next==NULL) {
temp->prev->next=NULL;
} /* end if */
else {
temp->prev->next=temp->next;
temp->next->prev=temp->prev;
} /* end else */
/* Move the found node to the head of the list */
temp->prev=NULL;
temp->next=*head;
(*head)->prev=temp;
*head=temp;
} /* end if */
ret_value=temp;
FUNC_LEAVE(ret_value);
} /* end H5FL_blk_find_list() */
/*-------------------------------------------------------------------------
* Function: H5FL_blk_create_list
*
* Purpose: Creates a new free list for blocks of the given size at the
* head of the priority queue.
*
* Return: Success: valid pointer to the free list node
*
* Failure: NULL
*
* Programmer: Quincey Koziol
* Thursday, March 23, 2000
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
static H5FL_blk_node_t *
H5FL_blk_create_list(H5FL_blk_node_t **head, size_t size)
{
H5FL_blk_node_t *temp; /* Temp. pointer to node in the list */
H5FL_blk_node_t *ret_value=NULL;
FUNC_ENTER(H5FL_blk_create_list, NULL);
/* Allocate room for the new free list node */
if(NULL==(temp=H5FL_ALLOC(H5FL_blk_node_t,0)))
HGOTO_ERROR(H5E_RESOURCE, H5E_NOSPACE, NULL, "memory allocation failed for chunk info");
/* Set the correct values for the new free list */
H5_ASSIGN_OVERFLOW(temp->size,size,hsize_t,size_t);
temp->list=NULL;
/* Attach to head of priority queue */
if(*head==NULL) {
*head=temp;
temp->next=temp->prev=NULL;
} /* end if */
else {
temp->next=*head;
(*head)->prev=temp;
temp->prev=NULL;
*head=temp;
} /* end else */
ret_value=temp;
done:
FUNC_LEAVE(ret_value);
} /* end H5FL_blk_create_list() */
/*-------------------------------------------------------------------------
* Function: H5FL_blk_init
*
* Purpose: Initialize a priority queue of a certain type. Right now, this just
* adds the PQ to the list of things to garbage collect.
*
* Return: Success: Non-negative
* Failure: Negative
*
* Programmer: Quincey Koziol
* Saturday, March 25, 2000
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
static herr_t
H5FL_blk_init(H5FL_blk_head_t *head)
{
H5FL_blk_gc_node_t *new_node; /* Pointer to the node for the new list to garbage collect */
herr_t ret_value=SUCCEED; /* return value*/
FUNC_ENTER (H5FL_blk_init, FAIL);
/* Allocate a new garbage collection node */
if (NULL==(new_node = H5MM_malloc(sizeof(H5FL_blk_gc_node_t))))
HRETURN_ERROR (H5E_RESOURCE, H5E_NOSPACE, FAIL, "memory allocation failed");
/* Initialize the new garbage collection node */
new_node->pq=head;
/* Link in to the garbage collection list */
new_node->next=H5FL_blk_gc_head.first;
H5FL_blk_gc_head.first=new_node;
/* Indicate that the PQ is initialized */
head->init=1;
FUNC_LEAVE (ret_value);
} /* end H5FL_blk_init() */
/*-------------------------------------------------------------------------
* Function: H5FL_blk_alloc
*
* Purpose: Allocates memory for a block. This routine is used
* instead of malloc because the block can be kept on a free list so
* they don't thrash malloc/free as much.
*
* Return: Success: valid pointer to the block
*
* Failure: NULL
*
* Programmer: Quincey Koziol
* Thursday, March 23, 2000
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
void *
H5FL_blk_alloc(H5FL_blk_head_t *head, hsize_t size, unsigned clear)
{
H5FL_blk_node_t *free_list; /* The free list of nodes of correct size */
H5FL_blk_list_t *temp; /* Temp. ptr to the new native list allocated */
void *ret_value; /* Pointer to the block to return to the user */
FUNC_ENTER(H5FL_blk_alloc, NULL);
/* Double check parameters */
assert(head);
#ifdef NO_BLK_FREE_LISTS
if(clear)
ret_value=H5MM_calloc(size);
else
ret_value=H5MM_malloc(size);
#else /* NO_BLK_FREE_LISTS */
/* Make certain the list is initialized first */
if(!head->init)
H5FL_blk_init(head);
/* check if there is a free list for blocks of this size */
/* and if there are any blocks available on the list */
if((free_list=H5FL_blk_find_list(&(head->head),size))!=NULL && free_list->list!=NULL) {
/* Remove the first node from the list and return it */
ret_value=((char *)(free_list->list))+sizeof(H5FL_blk_list_t);
free_list->list=free_list->list->next;
/* Decrement the number of blocks & memory used on free list */
head->onlist--;
H5_ASSIGN_OVERFLOW(head->list_mem,head->list_mem-size,hsize_t,size_t);
/*head->list_mem-=size;*/
/* Decrement the amount of global "block" free list memory in use */
H5_ASSIGN_OVERFLOW(H5FL_blk_gc_head.mem_freed,H5FL_blk_gc_head.mem_freed-size,hsize_t,size_t);
/*H5FL_blk_gc_head.mem_freed-=size;*/
} /* end if */
/* No free list available, or there are no nodes on the list, allocate a new node to give to the user */
else {
/* Allocate new node, with room for the page info header and the actual page data */
if(NULL==(temp=H5FL_malloc(sizeof(H5FL_blk_list_t)+size)))
HGOTO_ERROR(H5E_RESOURCE, H5E_NOSPACE, NULL, "memory allocation failed for chunk");
/* Increment the number of blocks allocated */
head->allocated++;
/* Initialize the block allocated */
H5_ASSIGN_OVERFLOW(temp->size,size,hsize_t,size_t);
temp->next=NULL;
/* Set the return value to the block itself */
ret_value=((char *)temp)+sizeof(H5FL_blk_list_t);
} /* end else */
/* Clear the block to zeros, if requested */
if(clear) {
assert(size==(hsize_t)((size_t)size)); /*check for overflow*/
HDmemset(ret_value,0,(size_t)size);
} /* end if */
#endif /* NO_BLK_FREE_LISTS */
done:
FUNC_LEAVE(ret_value);
} /* end H5FL_blk_alloc() */
/*-------------------------------------------------------------------------
* Function: H5FL_blk_free
*
* Purpose: Releases memory for a block. This routine is used
* instead of free because the blocks can be kept on a free list so
* they don't thrash malloc/free as much.
*
* Return: Success: NULL
*
* Failure: never fails
*
* Programmer: Quincey Koziol
* Thursday, March 23, 2000
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
void *
H5FL_blk_free(H5FL_blk_head_t *head, void *block)
{
H5FL_blk_node_t *free_list; /* The free list of nodes of correct size */
H5FL_blk_list_t *temp; /* Temp. ptr to the new free list node allocated */
FUNC_ENTER(H5FL_blk_free, NULL);
/* Double check parameters */
assert(head);
assert(block);
#ifdef NO_BLK_FREE_LISTS
H5MM_xfree(block);
#else /* NO_BLK_FREE_LISTS */
/* Get the pointer to the native block info header in front of the native block to free */
temp=(H5FL_blk_list_t *)((unsigned char *)block-sizeof(H5FL_blk_list_t));
/* check if there is a free list for native blocks of this size */
if((free_list=H5FL_blk_find_list(&(head->head),(hsize_t)temp->size))==NULL) {
/* No free list available, create a new list node and insert it to the queue */
free_list=H5FL_blk_create_list(&(head->head),temp->size);
} /* end if */
/* Prepend the free'd native block to the front of the free list */
if(free_list!=NULL) {
temp->next=free_list->list;
free_list->list=temp;
} /* end if */
/* Increment the number of blocks on free list */
head->onlist++;
head->list_mem+=temp->size;
/* Increment the amount of "block" freed memory globally */
H5FL_blk_gc_head.mem_freed+=temp->size;
/* Check for exceeding free list memory use limits */
/* First check this particular list */
if(head->list_mem>H5FL_blk_lst_mem_lim) {
#ifdef QAK
printf("%s: temp->size=%u, head->name=%s, head->list_mem=%u, H5FL_blk_gc_head.mem_freed=%u, garbage collecting list\n",FUNC,(unsigned)temp->size,head->name,(unsigned)head->list_mem,(unsigned)H5FL_blk_gc_head.mem_freed);
#endif /* QAK */
H5FL_blk_gc_list(head);
} /* end if */
/* Then check the global amount memory on block free lists */
if(H5FL_blk_gc_head.mem_freed>H5FL_blk_glb_mem_lim) {
#ifdef QAK
printf("%s: head->name=%s, garbage collecting all block lists\n",FUNC,head->name);
#endif /* QAK */
H5FL_blk_gc();
} /* end if */
#endif /* NO_BLK_FREE_LISTS */
FUNC_LEAVE(NULL);
} /* end H5FL_blk_free() */
/*-------------------------------------------------------------------------
* Function: H5FL_blk_realloc
*
* Purpose: Resizes a block. This does things the straightforward, simple way,
* not actually using realloc.
*
* Return: Success: NULL
*
* Failure: never fails
*
* Programmer: Quincey Koziol
* Thursday, March 23, 2000
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
void *
H5FL_blk_realloc(H5FL_blk_head_t *head, void *block, hsize_t new_size)
{
hsize_t blk_size; /* Temporary block size */
H5FL_blk_list_t *temp; /* Temp. ptr to the new block node allocated */
void *ret_value=NULL; /* Return value */
FUNC_ENTER(H5FL_blk_realloc, NULL);
/* Double check parameters */
assert(head);
#ifdef NO_BLK_FREE_LISTS
ret_value=H5MM_realloc(block,new_size);
#else /* NO_BLK_FREE_LISTS */
/* Check if we are actually re-allocating a block */
if(block!=NULL) {
/* Get the pointer to the chunk info header in front of the chunk to free */
temp=(H5FL_blk_list_t *)((unsigned char *)block-sizeof(H5FL_blk_list_t));
/* check if we are actually changing the size of the buffer */
if(new_size!=temp->size) {
if((ret_value=H5FL_blk_alloc(head,new_size,0))==NULL)
HGOTO_ERROR(H5E_RESOURCE, H5E_NOSPACE, NULL, "memory allocation failed for block");
blk_size=MIN(new_size,temp->size);
assert(blk_size==(hsize_t)((size_t)blk_size)); /*check for overflow*/
HDmemcpy(ret_value,block,(size_t)blk_size);
H5FL_blk_free(head,block);
} /* end if */
else
ret_value=block;
} /* end if */
/* Not re-allocating, just allocate a fresh block */
else
ret_value=H5FL_blk_alloc(head,new_size,0);
#endif /* NO_BLK_FREE_LISTS */
done:
FUNC_LEAVE(ret_value);
} /* end H5FL_blk_realloc() */
/*-------------------------------------------------------------------------
* Function: H5FL_blk_gc_list
*
* Purpose: Garbage collect a priority queue
*
* Return: Success: Non-negative
* Failure: Negative
*
* Programmer: Quincey Koziol
* Thursday, March 23, 2000
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
static herr_t
H5FL_blk_gc_list(H5FL_blk_head_t *head)
{
H5FL_blk_list_t *list; /* The free list of native nodes of a particular size */
void *next; /* Temp. ptr to the free list list node */
void *temp; /* Temp. ptr to the free list page node */
/* FUNC_ENTER_INIT() should not be called, it causes an infinite loop at library termination */
/* Loop through all the nodes in the block free list queue */
while(head->head!=NULL) {
temp=head->head->next;
/* Loop through all the blocks in the free list, freeing them */
list=head->head->list;
while(list!=NULL) {
next=list->next;
/* Decrement the number of blocks & memory allocated from this PQ */
head->allocated--;
head->list_mem-=list->size;
/* Decrement global count of free memory on "block" lists */
H5FL_blk_gc_head.mem_freed-=list->size;
/* Free the block */
H5MM_xfree(list);
list=next;
} /* end while */
/* Free the free list node */
H5FL_FREE(H5FL_blk_node_t,head->head);
/* Advance to the next free list */
head->head=temp;
} /* end while */
/* Indicate no free nodes on the free list */
head->head=NULL;
head->onlist=0;
/* Double check that all the memory on this list is recycled */
assert(head->list_mem==0);
return(SUCCEED);
} /* end H5FL_blk_gc_list() */
/*-------------------------------------------------------------------------
* Function: H5FL_blk_gc
*
* Purpose: Garbage collect on all the priority queues
*
* Return: Success: Non-negative
* Failure: Negative
*
* Programmer: Quincey Koziol
* Saturday, March 25, 2000
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
static herr_t
H5FL_blk_gc(void)
{
H5FL_blk_gc_node_t *gc_node; /* Pointer into the list of things to garbage collect */
/* FUNC_ENTER_INIT() should not be called, it causes an infinite loop at library termination */
/* Walk through all the free lists, free()'ing the nodes */
gc_node=H5FL_blk_gc_head.first;
while(gc_node!=NULL) {
/* For each free list being garbage collected, walk through the nodes and free them */
H5FL_blk_gc_list(gc_node->pq);
/* Go on to the next free list to garbage collect */
gc_node=gc_node->next;
} /* end while */
/* Double check that all the memory on the free lists are recycled */
assert(H5FL_blk_gc_head.mem_freed==0);
return(SUCCEED);
} /* end H5FL_blk_gc() */
/*--------------------------------------------------------------------------
NAME
H5FL_blk_term
PURPOSE
Terminate various H5FL_blk objects
USAGE
void H5FL_blk_term()
RETURNS
Success: Positive if any action might have caused a change in some
other interface; zero otherwise.
Failure: Negative
DESCRIPTION
Release any resources allocated.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
Can't report errors...
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
static int
H5FL_blk_term(void)
{
H5FL_blk_gc_node_t *left; /* pointer to garbage collection lists with work left */
H5FL_blk_gc_node_t *tmp; /* Temporary pointer to a garbage collection node */
/* Free the nodes on the garbage collection list, keeping nodes with allocations outstanding */
left=NULL;
while(H5FL_blk_gc_head.first!=NULL) {
tmp=H5FL_blk_gc_head.first->next;
#ifdef H5FL_DEBUG
printf("H5FL_blk_term: head->name=%s, head->allocated=%d\n", H5FL_blk_gc_head.first->pq->name,(int)H5FL_blk_gc_head.first->pq->allocated);
#endif /* H5FL_DEBUG */
/* Check if the list has allocations outstanding */
if(H5FL_blk_gc_head.first->pq->allocated>0) {
/* Add free list to the list of nodes with allocations open still */
H5FL_blk_gc_head.first->next=left;
left=H5FL_blk_gc_head.first;
} /* end if */
/* No allocations left open for list, get rid of it */
else {
/* Reset the "initialized" flag, in case we restart this list somehow (I don't know how..) */
H5FL_blk_gc_head.first->pq->init=0;
/* Free the node from the garbage collection list */
H5MM_xfree(H5FL_blk_gc_head.first);
} /* end else */
H5FL_blk_gc_head.first=tmp;
} /* end while */
/* Point to the list of nodes left with allocations open, if any */
H5FL_blk_gc_head.first=left;
return (H5FL_blk_gc_head.first!=NULL ? 1 : 0);
} /* end H5FL_blk_term() */
/*-------------------------------------------------------------------------
* Function: H5FL_arr_init
*
* Purpose: Initialize a free list for a arrays of certain type. Right now,
* this just adds the free list to the list of things to garbage collect.
*
* Return: Success: Non-negative
* Failure: Negative
*
* Programmer: Quincey Koziol
* Saturday, March 25, 2000
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
static herr_t
H5FL_arr_init(H5FL_arr_head_t *head)
{
H5FL_gc_arr_node_t *new_node; /* Pointer to the node for the new list to garbage collect */
herr_t ret_value=SUCCEED; /* return value*/
FUNC_ENTER (H5FL_arr_init, FAIL);
/* Allocate a new garbage collection node */
if (NULL==(new_node = H5MM_malloc(sizeof(H5FL_gc_arr_node_t))))
HRETURN_ERROR (H5E_RESOURCE, H5E_NOSPACE, FAIL, "memory allocation failed");
/* Initialize the new garbage collection node */
new_node->list=head;
/* Link in to the garbage collection list */
new_node->next=H5FL_arr_gc_head.first;
H5FL_arr_gc_head.first=new_node;
/* Allocate room for the free lists, if the arrays have a maximum size */
if(head->maxelem>0) {
if (NULL==(head->u.list_arr = H5MM_calloc(head->maxelem*sizeof(H5FL_arr_node_t *))))
HRETURN_ERROR (H5E_RESOURCE, H5E_NOSPACE, FAIL, "memory allocation failed");
if (NULL==(head->onlist = H5MM_calloc(head->maxelem*sizeof(unsigned))))
HRETURN_ERROR (H5E_RESOURCE, H5E_NOSPACE, FAIL, "memory allocation failed");
} /* end if */
else {
head->u.queue.init=0;
head->u.queue.allocated=0;
head->u.queue.onlist=0;
head->u.queue.list_mem=0;
head->u.queue.name=head->name;
head->u.queue.head=NULL;
} /* end else */
/* Indicate that the free list is initialized */
head->init=1;
FUNC_LEAVE (ret_value);
} /* end H5FL_arr_init() */
/*-------------------------------------------------------------------------
* Function: H5FL_arr_free
*
* Purpose: Release an array of objects & put on free list
*
* Return: Success: Non-negative
* Failure: Negative
*
* Programmer: Quincey Koziol
* Friday, March 24, 2000
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
void *
H5FL_arr_free(H5FL_arr_head_t *head, void *obj)
{
H5FL_arr_node_t *temp; /* Temp. ptr to the new free list node allocated */
size_t mem_size; /* Size of memory being freed */
FUNC_ENTER (H5FL_arr_free, NULL);
#ifdef NO_ARR_FREE_LISTS
H5MM_xfree(obj);
#else /* NO_ARR_FREE_LISTS */
/* The H5MM_xfree code allows obj to null */
if (!obj)
HRETURN(NULL);
/* Double check parameters */
assert(head);
/* Make certain that the free list is initialized */
assert(head->init);
/* Check if there are a maximum number of elements in list */
if(head->maxelem>0) {
/* Get the pointer to the info header in front of the block to free */
temp=(H5FL_arr_node_t *)((unsigned char *)obj-sizeof(H5FL_arr_node_t));
/* Double-check that there is enough room for arrays of this size */
assert((int)temp->nelem<=head->maxelem);
/* Link into the free list */
temp->next=head->u.list_arr[temp->nelem];
/* Point free list at the node freed */
head->u.list_arr[temp->nelem]=temp;
/* Set the amount of memory being freed */
H5_ASSIGN_OVERFLOW(mem_size,temp->nelem*head->size,hsize_t,size_t);
/* Increment the number of blocks & memory used on free list */
head->onlist[temp->nelem]++;
head->list_mem+=mem_size;
/* Increment the amount of "array" freed memory globally */
H5FL_arr_gc_head.mem_freed+=mem_size;
/* Check for exceeding free list memory use limits */
/* First check this particular list */
if(head->list_mem>H5FL_arr_lst_mem_lim)
H5FL_arr_gc_list(head);
/* Then check the global amount memory on array free lists */
if(H5FL_arr_gc_head.mem_freed>H5FL_arr_glb_mem_lim)
H5FL_arr_gc();
} /* end if */
/* No maximum number of elements, use block routine */
else {
H5FL_blk_free(&(head->u.queue),obj);
} /* end else */
#endif /* NO_ARR_FREE_LISTS */
FUNC_LEAVE(NULL);
} /* end H5FL_arr_free() */
/*-------------------------------------------------------------------------
* Function: H5FL_arr_alloc
*
* Purpose: Allocate an array of objects
*
* Return: Success: Pointer to a valid array object
* Failure: NULL
*
* Programmer: Quincey Koziol
* Saturday, March 25, 2000
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
void *
H5FL_arr_alloc(H5FL_arr_head_t *head, hsize_t elem, unsigned clear)
{
H5FL_arr_node_t *new_obj; /* Pointer to the new free list node allocated */
void *ret_value; /* Pointer to object to return */
hsize_t mem_size; /* Size of memory block being recycled */
FUNC_ENTER (H5FL_arr_alloc, NULL);
/* Double check parameters */
assert(head);
#ifdef NO_ARR_FREE_LISTS
if(clear)
ret_value=H5MM_calloc(elem*head->size);
else
ret_value=H5MM_malloc(elem*head->size);
#else /* NO_ARR_FREE_LISTS */
/* Make certain the list is initialized first */
if(!head->init)
H5FL_arr_init(head);
/* Set the set of the memory block */
mem_size=head->size*elem;
/* Check if there is a maximum number of elements in array */
if(head->maxelem>0) {
/* Check for nodes available on the free list first */
if(head->u.list_arr[elem]!=NULL) {
/* Get a pointer to the block on the free list */
ret_value=((char *)(head->u.list_arr[elem]))+sizeof(H5FL_arr_node_t);
/* Remove node from free list */
head->u.list_arr[elem]=head->u.list_arr[elem]->next;
/* Decrement the number of blocks & memory used on free list */
head->onlist[elem]--;
head->list_mem-=mem_size;
/* Decrement the amount of global "array" free list memory in use */
H5_ASSIGN_OVERFLOW(H5FL_arr_gc_head.mem_freed,H5FL_arr_gc_head.mem_freed-mem_size,hsize_t,size_t);
} /* end if */
/* Otherwise allocate a node */
else {
if (NULL==(new_obj = H5FL_malloc(sizeof(H5FL_arr_node_t)+mem_size)))
HRETURN_ERROR (H5E_RESOURCE, H5E_NOSPACE, NULL, "memory allocation failed");
/* Increment the number of blocks allocated in list */
head->allocated++;
/* Initialize the new object */
new_obj->nelem=elem;
new_obj->next=NULL;
/* Get a pointer to the new block */
ret_value=((char *)new_obj)+sizeof(H5FL_arr_node_t);
} /* end else */
/* Clear to zeros, if asked */
if(clear) {
assert(mem_size==(hsize_t)((size_t)mem_size)); /*check for overflow*/
HDmemset(ret_value,0,(size_t)mem_size);
} /* end if */
} /* end if */
/* No fixed number of elements, use PQ routine */
else {
ret_value=H5FL_blk_alloc(&(head->u.queue),mem_size,clear);
} /* end else */
#endif /* NO_ARR_FREE_LISTS */
FUNC_LEAVE (ret_value);
} /* end H5FL_arr_alloc() */
/*-------------------------------------------------------------------------
* Function: H5FL_arr_realloc
*
* Purpose: Reallocate an array of objects
*
* Return: Success: Pointer to a valid array object
* Failure: NULL
*
* Programmer: Quincey Koziol
* Saturday, March 25, 2000
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
void *
H5FL_arr_realloc(H5FL_arr_head_t *head, void * obj, hsize_t new_elem)
{
hsize_t blk_size; /* Size of block */
H5FL_arr_node_t *temp; /* Temp. ptr to the new free list node allocated */
void *ret_value; /* Pointer to object to return */
FUNC_ENTER (H5FL_arr_realloc, NULL);
/* Double check parameters */
assert(head);
#ifdef NO_ARR_FREE_LISTS
ret_value=H5MM_realloc(obj,new_elem*head->size);
#else /* NO_ARR_FREE_LISTS */
/* Check if we are really allocating the object */
if(obj==NULL) {
ret_value=H5FL_arr_alloc(head,new_elem,0);
} /* end if */
else {
/* Check if there is a maximum number of elements in array */
if(head->maxelem>0) {
/* Get the pointer to the info header in front of the block to free */
temp=(H5FL_arr_node_t *)((unsigned char *)obj-sizeof(H5FL_arr_node_t));
/* Check if the size is really changing */
if(temp->nelem!=new_elem) {
/* Get the new array of objects */
ret_value=H5FL_arr_alloc(head,new_elem,0);
/* Copy the appropriate amount of elements */
blk_size=head->size*MIN(temp->nelem,new_elem);
assert(blk_size==(hsize_t)((size_t)blk_size)); /*check for overflow*/
HDmemcpy(ret_value,obj,(size_t)blk_size);
/* Free the old block */
H5FL_arr_free(head,obj);
} /* end if */
else
ret_value=obj;
} /* end if */
/* No fixed number of elements, use block routine */
else {
ret_value=H5FL_blk_realloc(&(head->u.queue),obj,head->size*new_elem);
} /* end else */
} /* end else */
#endif /* NO_ARR_FREE_LISTS */
FUNC_LEAVE (ret_value);
} /* end H5FL_arr_realloc() */
/*-------------------------------------------------------------------------
* Function: H5FL_arr_gc_list
*
* Purpose: Garbage collect on an array object free list
*
* Return: Success: Non-negative
* Failure: Negative
*
* Programmer: Quincey Koziol
* Tuesday, July 25, 2000
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
static herr_t
H5FL_arr_gc_list(H5FL_arr_head_t *head)
{
H5FL_arr_node_t *arr_free_list; /* Pointer to nodes in free list being garbage collected */
void *tmp; /* Temporary node pointer */
int i; /* Counter for array of free lists */
size_t total_mem; /* Total memory used on list */
/* FUNC_ENTER_INIT() should not be called, it causes an infinite loop at library termination */
/* Check if the array has a fixed maximum number of elements */
if(head->maxelem>0) {
/* Walk through the array of free lists */
for(i=0; i<head->maxelem; i++) {
if(head->onlist[i]>0) {
/* Calculate the total memory used on this list */
H5_ASSIGN_OVERFLOW(total_mem,head->onlist[i]*i*head->size,hsize_t,size_t);
/* For each free list being garbage collected, walk through the nodes and free them */
arr_free_list=head->u.list_arr[i];
while(arr_free_list!=NULL) {
tmp=arr_free_list->next;
/* Decrement the count of nodes allocated and free the node */
head->allocated--;
H5MM_xfree(arr_free_list);
arr_free_list=tmp;
} /* end while */
/* Indicate no free nodes on the free list */
head->u.list_arr[i]=NULL;
head->onlist[i]=0;
/* Decrement count of free memory on this "array" list */
head->list_mem-=total_mem;
/* Decrement global count of free memory on "array" lists */
H5FL_arr_gc_head.mem_freed-=total_mem;
} /* end if */
} /* end for */
/* Double check that all the memory on this list is recycled */
assert(head->list_mem==0);
} /* end if */
/* No maximum number of elements, use the block call to garbage collect */
else {
H5FL_blk_gc_list(&(head->u.queue));
} /* end else */
return(SUCCEED);
} /* end H5FL_arr_gc_list() */
/*-------------------------------------------------------------------------
* Function: H5FL_arr_gc
*
* Purpose: Garbage collect on all the array object free lists
*
* Return: Success: Non-negative
* Failure: Negative
*
* Programmer: Quincey Koziol
* Saturday, March 25, 2000
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
static herr_t
H5FL_arr_gc(void)
{
H5FL_gc_arr_node_t *gc_arr_node; /* Pointer into the list of things to garbage collect */
/* FUNC_ENTER_INIT() should not be called, it causes an infinite loop at library termination */
/* Walk through all the free lists, free()'ing the nodes */
gc_arr_node=H5FL_arr_gc_head.first;
while(gc_arr_node!=NULL) {
/* Release the free nodes on the list */
H5FL_arr_gc_list(gc_arr_node->list);
/* Go on to the next free list to garbage collect */
gc_arr_node=gc_arr_node->next;
} /* end while */
/* Double check that all the memory on the free lists are recycled */
assert(H5FL_arr_gc_head.mem_freed==0);
return(SUCCEED);
} /* end H5FL_arr_gc() */
/*--------------------------------------------------------------------------
NAME
H5FL_arr_term
PURPOSE
Terminate various H5FL array object free lists
USAGE
int H5FL_arr_term()
RETURNS
Success: Positive if any action might have caused a change in some
other interface; zero otherwise.
Failure: Negative
DESCRIPTION
Release any resources allocated.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
Can't report errors...
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
static int
H5FL_arr_term(void)
{
H5FL_gc_arr_node_t *left; /* pointer to garbage collection lists with work left */
H5FL_gc_arr_node_t *tmp; /* Temporary pointer to a garbage collection node */
/* Free the nodes on the garbage collection list, keeping nodes with allocations outstanding */
left=NULL;
while(H5FL_arr_gc_head.first!=NULL) {
tmp=H5FL_arr_gc_head.first->next;
/* Check if the array has a fixed maximum number of elements */
if(H5FL_arr_gc_head.first->list->maxelem>0) {
/* Check if the list has allocations outstanding */
#ifdef H5FL_DEBUG
printf("H5FL_arr_term: head->name=%s, head->allocated=%d\n", H5FL_arr_gc_head.first->list->name,(int)H5FL_arr_gc_head.first->list->allocated);
#endif /* H5FL_DEBUG */
if(H5FL_arr_gc_head.first->list->allocated>0) {
/* Add free list to the list of nodes with allocations open still */
H5FL_arr_gc_head.first->next=left;
left=H5FL_arr_gc_head.first;
} /* end if */
/* No allocations left open for list, get rid of it */
else {
/* Free the array of free lists */
H5MM_xfree(H5FL_arr_gc_head.first->list->u.list_arr);
/* Free the array of "onlist" counts */
H5MM_xfree(H5FL_arr_gc_head.first->list->onlist);
/* Reset the "initialized" flag, in case we restart this list somehow (I don't know how..) */
H5FL_arr_gc_head.first->list->init=0;
/* Free the node from the garbage collection list */
H5MM_xfree(H5FL_arr_gc_head.first);
} /* end else */
} /* end if */
/* No maximum number of elements, use the PQ information */
else {
#ifdef H5FL_DEBUG
printf("H5FL_arr_term: head->name=%s, head->allocated=%d\n", H5FL_arr_gc_head->list->name,(int)H5FL_arr_gc_head->list->u.queue.allocated);
#endif /* H5FL_DEBUG */
/* Check if the list has allocations outstanding */
if(H5FL_arr_gc_head.first->list->u.queue.allocated>0) {
/* Add free list to the list of nodes with allocations open still */
H5FL_arr_gc_head.first->next=left;
left=H5FL_arr_gc_head.first;
} /* end if */
/* No allocations left open for list, get rid of it */
else {
/* Reset the "initialized" flag, in case we restart this list somehow (I don't know how..) */
H5FL_arr_gc_head.first->list->init=0;
/* Free the node from the garbage collection list */
H5MM_xfree(H5FL_arr_gc_head.first);
} /* end else */
} /* end else */
H5FL_arr_gc_head.first=tmp;
} /* end while */
/* Point to the list of nodes left with allocations open, if any */
H5FL_arr_gc_head.first=left;
return (H5FL_arr_gc_head.first!=NULL ? 1 : 0);
} /* end H5FL_arr_term() */
/*-------------------------------------------------------------------------
* Function: H5FL_garbage_coll
*
* Purpose: Garbage collect on all the free lists
*
* Return: Success: Non-negative
* Failure: Negative
*
* Programmer: Quincey Koziol
* Friday, March 24, 2000
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5FL_garbage_coll(void)
{
/* FUNC_ENTER_INIT() should not be called, it causes an infinite loop at library termination */
/* Garbage collect the free lists for array objects */
H5FL_arr_gc();
/* Garbage collect free lists for blocks */
H5FL_blk_gc();
/* Garbage collect the free lists for regular objects */
H5FL_reg_gc();
return(SUCCEED);
} /* end H5FL_garbage_coll() */
/*-------------------------------------------------------------------------
* Function: H5FL_set_free_list_limits
*
* Purpose: Sets limits on the different kinds of free lists. Setting a value
* of -1 for a limit means no limit of that type. These limits are global
* for the entire library. Each "global" limit only applies to free lists
* of that type, so if an application sets a limit of 1 MB on each of the
* global lists, up to 3 MB of total storage might be allocated (1MB on
* each of regular, array and block type lists).
*
* Parameters:
* int reg_global_lim; IN: The limit on all "regular" free list memory used
* int reg_list_lim; IN: The limit on memory used in each "regular" free list
* int arr_global_lim; IN: The limit on all "array" free list memory used
* int arr_list_lim; IN: The limit on memory used in each "array" free list
* int blk_global_lim; IN: The limit on all "block" free list memory used
* int blk_list_lim; IN: The limit on memory used in each "block" free list
*
* Return: Success: non-negative
*
* Failure: negative
*
* Programmer: Quincey Koziol
* Wednesday, August 2, 2000
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5FL_set_free_list_limits(int reg_global_lim, int reg_list_lim, int arr_global_lim,
int arr_list_lim, int blk_global_lim, int blk_list_lim)
{
herr_t ret_value = SUCCEED;
FUNC_ENTER(H5FL_set_free_list_limits, FAIL);
/* Set the limit variables */
/* limit on all regular free lists */
H5FL_reg_glb_mem_lim=(reg_global_lim==-1 ? UINT_MAX : (size_t)reg_global_lim);
/* limit on each regular free list */
H5FL_reg_lst_mem_lim=(reg_list_lim==-1 ? UINT_MAX : (size_t)reg_list_lim);
/* limit on all array free lists */
H5FL_arr_glb_mem_lim=(arr_global_lim==-1 ? UINT_MAX : (size_t)arr_global_lim);
/* limit on each array free list */
H5FL_arr_lst_mem_lim=(arr_list_lim==-1 ? UINT_MAX : (size_t)arr_list_lim);
/* limit on all block free lists */
H5FL_blk_glb_mem_lim=(blk_global_lim==-1 ? UINT_MAX : (size_t)blk_global_lim);
/* limit on each block free list */
H5FL_blk_lst_mem_lim=(blk_list_lim==-1 ? UINT_MAX : (size_t)blk_list_lim);
FUNC_LEAVE(ret_value);
} /* end H5FL_set_free_list_limits() */
/*--------------------------------------------------------------------------
NAME
H5FL_term_interface
PURPOSE
Terminate various H5FL objects
USAGE
void H5FL_term_interface()
RETURNS
Success: Positive if any action might have caused a change in some
other interface; zero otherwise.
Failure: Negative
DESCRIPTION
Release any resources allocated.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
Can't report errors...
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
int
H5FL_term_interface(void)
{
int ret_value=0;
/* Garbage collect any nodes on the free lists */
H5FL_garbage_coll();
ret_value=H5FL_reg_term()+H5FL_arr_term()+H5FL_blk_term();
return(ret_value);
}
|