summaryrefslogtreecommitdiffstats
path: root/src/H5Ostab.c
blob: db5ccdd6068b3a99fd9477ba6f7ab8acc4e33093 (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
/*-------------------------------------------------------------------------
 * Copyright (C) 1997	National Center for Supercomputing Applications.
 *                      All rights reserved.
 *
 *-------------------------------------------------------------------------
 *
 * Created:		H5Ostab.c
 * 			Aug  6 1997
 * 			Robb Matzke <matzke@llnl.gov>
 *
 * Purpose:		Symbol table messages.
 *
 * Modifications:	
 *
 *-------------------------------------------------------------------------
 */
#include <H5private.h>
#include <H5Eprivate.h>
#include <H5Gprivate.h>
#include <H5MMprivate.h>
#include <H5Oprivate.h>

#define PABLO_MASK	H5O_stab_mask

/* PRIVATE PROTOTYPES */
static void *H5O_stab_decode (H5F_t *f, size_t raw_size, const uint8 *p);
static herr_t H5O_stab_encode (H5F_t *f, size_t size, uint8 *p,
			       const void *_mesg);
static void *H5O_stab_fast (const H5G_cache_t *cache, void *_mesg);
static hbool_t H5O_stab_cache (H5G_type_t *cache_type, H5G_cache_t *cache,
			       const void *_mesg);
static void *H5O_stab_copy (const void *_mesg, void *_dest);
static size_t H5O_stab_size (H5F_t *f, const void *_mesg);
static herr_t H5O_stab_debug (H5F_t *f, const void *_mesg,
			      FILE *stream, intn indent, intn fwidth);

/* This message derives from H5O */
const H5O_class_t H5O_STAB[1] = {{
   H5O_STAB_ID,				/*message id number		*/
   "stab",				/*message name for debugging	*/
   sizeof (H5O_stab_t),			/*native message size		*/
   H5G_CACHED_STAB, 			/*symtab entry `type' field	*/
   H5O_stab_decode,			/*decode message		*/
   H5O_stab_encode,			/*encode message		*/
   H5O_stab_fast,			/*get message from stab entry	*/
   H5O_stab_cache,			/*put message into stab entry	*/
   H5O_stab_copy,			/*copy the native value		*/
   H5O_stab_size,			/*size of symbol table entry	*/
   NULL,				/*default reset method		*/
   H5O_stab_debug,			/*debug the message		*/
}};

/* Interface initialization */
static hbool_t interface_initialize_g = FALSE;
#define INTERFACE_INIT	NULL


/*-------------------------------------------------------------------------
 * Function:	H5O_stab_decode
 *
 * Purpose:	Decode a symbol table message and return a pointer to
 *		a new one created with malloc().
 *
 * Return:	Success:	Ptr to new message in native order.
 *
 *		Failure:	NULL
 *
 * Programmer:	Robb Matzke
 *		matzke@llnl.gov
 *		Aug  6 1997
 *
 * Modifications:
 *
 *-------------------------------------------------------------------------
 */
static void *
H5O_stab_decode (H5F_t *f, size_t raw_size, const uint8 *p)
{
   H5O_stab_t	*stab;
   
   FUNC_ENTER (H5O_stab_decode, NULL);

   /* check args */
   assert (f);
   assert (raw_size == 2*H5F_SIZEOF_ADDR(f));
   assert (p);

   /* decode */
   stab = H5MM_xcalloc (1, sizeof(H5O_stab_t));
   H5F_addr_decode (f, &p, &(stab->btree_addr));
   H5F_addr_decode (f, &p, &(stab->heap_addr));

   FUNC_LEAVE (stab);
}


/*-------------------------------------------------------------------------
 * Function:	H5O_stab_encode
 *
 * Purpose:	Encodes a symbol table message.
 *
 * Return:	Success:	SUCCEED
 *
 *		Failure:	FAIL
 *
 * Programmer:	Robb Matzke
 *		matzke@llnl.gov
 *		Aug  6 1997
 *
 * Modifications:
 *
 *-------------------------------------------------------------------------
 */
static herr_t
H5O_stab_encode (H5F_t *f, size_t raw_size, uint8 *p, const void *_mesg)
{
   const H5O_stab_t	*stab = (const H5O_stab_t *)_mesg;

   FUNC_ENTER (H5O_stab_encode, FAIL);

   /* check args */
   assert (f);
   assert (raw_size == 2 * H5F_SIZEOF_ADDR(f));
   assert (p);
   assert (stab);

   /* encode */
   H5F_addr_encode (f, &p, &(stab->btree_addr));
   H5F_addr_encode (f, &p, &(stab->heap_addr));

   FUNC_LEAVE (SUCCEED);
}


/*-------------------------------------------------------------------------
 * Function:	H5O_stab_fast
 *
 * Purpose:	Initializes a new message struct with info from the cache of
 *		a symbol table entry.
 *
 * Return:	Success:	Ptr to message struct, allocated if none
 *				supplied.
 *
 *		Failure:	NULL
 *
 * Programmer:	Robb Matzke
 *		matzke@llnl.gov
 *		Aug  6 1997
 *
 * Modifications:
 *
 *-------------------------------------------------------------------------
 */
static void *
H5O_stab_fast (const H5G_cache_t *cache, void *_mesg)
{
   H5O_stab_t	*stab = (H5O_stab_t *)_mesg;
   
   FUNC_ENTER (H5O_stab_fast, NULL);

   /* check args */
   assert (cache);

   if (!stab) stab = H5MM_xcalloc (1, sizeof(H5O_stab_t));
   stab->btree_addr = cache->stab.btree_addr;
   stab->heap_addr = cache->stab.heap_addr;

   FUNC_LEAVE (stab);
}


/*-------------------------------------------------------------------------
 * Function:	H5O_stab_cache
 *
 * Purpose:	Copies a message into the cache portion of a symbol table
 *		entry.
 *
 * Return:	Success:	TRUE if modified; FALSE if not modified.
 *				In either case, the new cache type is
 *				returned through the CACHE_TYPE argument.
 *
 *		Failure:	FAIL
 *
 * Programmer:	Robb Matzke
 *		matzke@llnl.gov
 *		Aug  6 1997
 *
 * Modifications:
 *
 *-------------------------------------------------------------------------
 */
static hbool_t
H5O_stab_cache (H5G_type_t *cache_type, H5G_cache_t *cache, const void *_mesg)
{
   const H5O_stab_t	*stab = (const H5O_stab_t *)_mesg;
   hbool_t		modified = FALSE;
   
   FUNC_ENTER (H5O_stab_cache, FAIL);

   /* check args */
   assert (cache_type);
   assert (cache);
   assert (stab);

   if (H5G_CACHED_STAB != *cache_type) {
      modified = TRUE;
      *cache_type = H5G_CACHED_STAB;
      cache->stab.btree_addr = stab->btree_addr;
      cache->stab.heap_addr = stab->heap_addr;
   } else {
      if (H5F_addr_ne (&(cache->stab.btree_addr), &(stab->btree_addr))) {
	 modified = TRUE;
	 cache->stab.btree_addr = stab->btree_addr;
      }

      if (H5F_addr_ne (&(cache->stab.heap_addr), &(stab->heap_addr))) {
	 modified = TRUE;
	 cache->stab.heap_addr = stab->heap_addr;
      }
   }

   FUNC_LEAVE (modified);
}


/*-------------------------------------------------------------------------
 * Function:	H5O_stab_copy
 *
 * Purpose:	Copies a message from _MESG to _DEST, allocating _DEST if
 *		necessary.
 *
 * Return:	Success:	Ptr to _DEST
 *
 *		Failure:	NULL
 *
 * Programmer:	Robb Matzke
 *		matzke@llnl.gov
 *		Aug  6 1997
 *
 * Modifications:
 *
 *-------------------------------------------------------------------------
 */
static void *
H5O_stab_copy (const void *_mesg, void *_dest)
{
   const H5O_stab_t	*stab = (const H5O_stab_t *)_mesg;
   H5O_stab_t		*dest = (H5O_stab_t *)_dest;
   
   FUNC_ENTER (H5O_stab_copy, NULL);

   /* check args */
   assert (stab);
   if (!dest) dest = H5MM_xcalloc (1, sizeof(H5O_stab_t));

   /* copy */
   *dest = *stab;

   FUNC_LEAVE ((void*)dest);
}


/*-------------------------------------------------------------------------
 * Function:	H5O_stab_size
 *
 * Purpose:	Returns the size of the raw message in bytes not counting
 *		the message type or size fields, but only the data fields.
 *		This function doesn't take into account alignment.
 *
 * Return:	Success:	Message data size in bytes without alignment.
 *
 *		Failure:	FAIL
 *
 * Programmer:	Robb Matzke
 *		matzke@llnl.gov
 *		Aug  6 1997
 *
 * Modifications:
 *
 *-------------------------------------------------------------------------
 */
static size_t
H5O_stab_size (H5F_t *f, const void *_mesg)
{
   FUNC_ENTER (H5O_stab_size, FAIL);
   FUNC_LEAVE (2 * H5F_SIZEOF_ADDR(f));
}


/*-------------------------------------------------------------------------
 * Function:	H5O_stab_debug
 *
 * Purpose:	Prints debugging info for a symbol table message.
 *
 * Return:	Success:	SUCCEED
 *
 *		Failure:	FAIL
 *
 * Programmer:	Robb Matzke
 *		matzke@llnl.gov
 *		Aug  6 1997
 *
 * Modifications:
 *
 *-------------------------------------------------------------------------
 */
static herr_t
H5O_stab_debug (H5F_t *f, const void *_mesg, FILE *stream, intn indent,
		intn fwidth)
{
   const H5O_stab_t	*stab = (const H5O_stab_t *)_mesg;
   
   FUNC_ENTER (H5O_stab_debug, FAIL);

   /* check args */
   assert (f);
   assert (stab);
   assert (stream);
   assert (indent>=0);
   assert (fwidth>=0);

   fprintf (stream, "%*s%-*s ", indent, "", fwidth,
	    "B-tree address:");
   H5F_addr_print (stream, &(stab->btree_addr));
   fprintf (stream, "\n");
   
   fprintf (stream, "%*s%-*s ", indent, "", fwidth,
	    "Name heap address:");
   H5F_addr_print (stream, &(stab->heap_addr));
   fprintf (stream, "\n");
   
   FUNC_LEAVE (SUCCEED);
}