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
|
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
* 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. *
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
/*
* Purpose: This file contains declarations which are visible only within
* the H5MF package. Source files outside the H5MF package should
* include H5MFprivate.h instead.
*/
#if !(defined H5MF_FRIEND || defined H5MF_MODULE)
#error "Do not include this file outside the H5MF package!"
#endif
#ifndef H5MFpkg_H
#define H5MFpkg_H
/* Get package's private header */
#include "H5MFprivate.h"
/* Other private headers needed by this file */
#include "H5FSprivate.h" /* File free space */
/**************************/
/* Package Private Macros */
/**************************/
/* Define this to display information about file allocations */
/* #define H5MF_ALLOC_DEBUG */
/* Define this to display more information about file allocations */
/* #define H5MF_ALLOC_DEBUG_MORE */
/* Define this to display more information about block aggregator actions */
/* #define H5MF_AGGR_DEBUG */
/* Define this to dump free space tracker contents after they've been modified */
/* #define H5MF_ALLOC_DEBUG_DUMP */
/* Free-space section types for file */
/* (values stored in free space data structures in file) */
/* For non-paged aggregation: section is a range of actual bytes in file */
#define H5MF_FSPACE_SECT_SIMPLE 0
/* For paged aggregation: "small" meta/raw data section which is < fsp_size) */
#define H5MF_FSPACE_SECT_SMALL 1
/* For paged aggregation: "large" Section which is >= fsp_size) */
#define H5MF_FSPACE_SECT_LARGE 2
/* Get section class type based on size */
#define H5MF_SECT_CLASS_TYPE(F, S) \
((H5F_PAGED_AGGR(F)) \
? ((S >= (F)->shared->fs_page_size) ? H5MF_FSPACE_SECT_LARGE : H5MF_FSPACE_SECT_SMALL) \
: H5MF_FSPACE_SECT_SIMPLE)
/* Get section class cls */
#define H5MF_SECT_CLS_TYPE(F, S) \
((H5F_PAGED_AGGR(F)) \
? ((S >= (F)->shared->fs_page_size) ? H5MF_FSPACE_SECT_CLS_LARGE : H5MF_FSPACE_SECT_CLS_SMALL) \
: H5MF_FSPACE_SECT_CLS_SIMPLE)
/* Calculate the mis-aligned fragment */
#define H5MF_EOA_MISALIGN(F, E, A, FR) \
do { \
hsize_t m; \
\
if (H5_addr_gt((E), 0) && ((m) = ((E) + H5F_BASE_ADDR(F)) % (A))) \
(FR) = (A)-m; \
else \
(FR) = 0; \
} while (0)
/****************************/
/* Package Private Typedefs */
/****************************/
/* File free space section info */
typedef struct H5MF_free_section_t {
H5FS_section_info_t sect_info; /* Free space section information (must be first in struct) */
#ifdef NOT_YET
union {
struct {
H5HF_indirect_t *parent; /* Indirect block parent for free section's direct block */
unsigned par_entry; /* Entry of free section's direct block in parent indirect block */
} single;
struct {
struct H5HF_free_section_t *under; /* Pointer to indirect block underlying row section */
unsigned row; /* Row for range of blocks */
unsigned col; /* Column for range of blocks */
unsigned num_entries; /* Number of entries covered */
/* Fields that aren't stored */
hbool_t checked_out; /* Flag to indicate that a row section is temporarily out of the free space
manager */
} row;
struct {
/* Holds either a pointer to an indirect block (if its "live") or
* the block offset of it's indirect block (if its "serialized")
* (This allows the indirect block that the section is within to
* be compared with other sections, whether it's serialized
* or not)
*/
union {
H5HF_indirect_t *iblock; /* Indirect block for free section */
hsize_t iblock_off; /* Indirect block offset in "heap space" */
} u;
unsigned row; /* Row for range of blocks */
unsigned col; /* Column for range of blocks */
unsigned num_entries; /* Number of entries covered */
/* Fields that aren't stored */
struct H5HF_free_section_t *parent; /* Pointer to "parent" indirect section */
unsigned par_entry; /* Entry within parent indirect section */
hsize_t span_size; /* Size of space tracked, in "heap space" */
unsigned iblock_entries; /* Number of entries in indirect block where section is located */
unsigned rc; /* Reference count of outstanding row & child indirect sections */
unsigned dir_nrows; /* Number of direct rows in section */
struct H5HF_free_section_t **dir_rows; /* Array of pointers to outstanding row sections */
unsigned indir_nents; /* Number of indirect entries in section */
struct H5HF_free_section_t *
*indir_ents; /* Array of pointers to outstanding child indirect sections */
} indirect;
} u;
#endif /* NOT_YET */
} H5MF_free_section_t;
/* Type of "container shrink" operation to perform */
typedef enum {
H5MF_SHRINK_EOA, /* Section should shrink the EOA value */
H5MF_SHRINK_AGGR_ABSORB_SECT, /* Section should merge into the aggregator block */
H5MF_SHRINK_SECT_ABSORB_AGGR /* Aggregator block should merge into the section */
} H5MF_shrink_type_t;
/* User data for free space manager section callbacks */
typedef struct H5MF_sect_ud_t {
/* Down */
H5F_t *f; /* Pointer to file to operate on */
H5FD_mem_t alloc_type; /* Type of memory being allocated */
hbool_t allow_sect_absorb; /* Whether sections are allowed to absorb a block aggregator */
hbool_t allow_eoa_shrink_only; /* Whether shrinking eoa is allowed only for the section */
/* Up */
H5MF_shrink_type_t shrink; /* Type of shrink operation to perform */
H5F_blk_aggr_t *aggr; /* Aggregator block to operate on */
} H5MF_sect_ud_t;
/* Information about the current free-space manager to use */
typedef struct H5MF_fs_t {
H5F_fs_state_t *fs_state;
haddr_t *fs_addr;
H5FS_t **fs_man;
hsize_t align_thres; /* Threshold for alignment */
hsize_t alignment; /* Alignment */
} H5MF_fs_t;
/*****************************/
/* Package Private Variables */
/*****************************/
/* H5MF single section inherits serializable properties from H5FS_section_class_t */
H5_DLLVAR const H5FS_section_class_t H5MF_FSPACE_SECT_CLS_SIMPLE[1];
H5_DLLVAR const H5FS_section_class_t H5MF_FSPACE_SECT_CLS_SMALL[1];
H5_DLLVAR const H5FS_section_class_t H5MF_FSPACE_SECT_CLS_LARGE[1];
/******************************/
/* Package Private Prototypes */
/******************************/
/* Allocator routines */
H5_DLL herr_t H5MF__open_fstype(H5F_t *f, H5F_mem_page_t type);
H5_DLL herr_t H5MF__start_fstype(H5F_t *f, H5F_mem_page_t type);
H5_DLL htri_t H5MF__find_sect(H5F_t *f, H5FD_mem_t alloc_type, hsize_t size, H5FS_t *fspace, haddr_t *addr);
H5_DLL herr_t H5MF__add_sect(H5F_t *f, H5FD_mem_t alloc_type, H5FS_t *fspace, H5MF_free_section_t *node);
H5_DLL void H5MF__alloc_to_fs_type(H5F_shared_t *f_sh, H5FD_mem_t alloc_type, hsize_t size,
H5F_mem_page_t *fs_type);
/* 'simple/small/large' section routines */
H5_DLL H5MF_free_section_t *H5MF__sect_new(unsigned ctype, haddr_t sect_off, hsize_t sect_size);
H5_DLL herr_t H5MF__sect_free(H5FS_section_info_t *sect);
/* Block aggregator routines */
H5_DLL htri_t H5MF__aggr_try_extend(H5F_t *f, H5F_blk_aggr_t *aggr, H5FD_mem_t type, haddr_t abs_blk_end,
hsize_t extra_requested);
H5_DLL htri_t H5MF__aggrs_try_shrink_eoa(H5F_t *f);
H5_DLL htri_t H5MF__aggr_can_absorb(const H5F_t *f, const H5F_blk_aggr_t *aggr,
const H5MF_free_section_t *sect, H5MF_shrink_type_t *shrink);
H5_DLL herr_t H5MF__aggr_absorb(const H5F_t *f, H5F_blk_aggr_t *aggr, H5MF_free_section_t *sect,
hbool_t allow_sect_absorb);
H5_DLL herr_t H5MF__aggr_query(const H5F_t *f, const H5F_blk_aggr_t *aggr, haddr_t *addr, hsize_t *size);
/* Debugging routines */
#ifdef H5MF_ALLOC_DEBUG_DUMP
H5_DLL herr_t H5MF__sects_dump(H5F_t *f, FILE *stream);
#endif /* H5MF_ALLOC_DEBUG_DUMP */
/* Testing routines */
#ifdef H5MF_TESTING
#endif /* H5MF_TESTING */
#endif /* H5MFpkg_H */
|
