summaryrefslogtreecommitdiffstats
path: root/src/H5Oprivate.h
blob: e39bf8a85bf0f426722e0729e45ab10e8cab1de7 (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
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
 * 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. *
 * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */

/*-------------------------------------------------------------------------
 *
 * Created:		H5Oprivate.h
 *			Aug  5 1997
 *			Robb Matzke <matzke@llnl.gov>
 *
 * Purpose:		Object header private include file.
 *
 * Modifications:
 *
 *-------------------------------------------------------------------------
 */
#ifndef _H5Oprivate_H
#define _H5Oprivate_H

#include "H5Opublic.h"
#include "H5Dpublic.h"

/* Private headers needed by this file */
#include "H5private.h"
#include "H5Fprivate.h"
#include "H5Gprivate.h"
#include "H5HGprivate.h"
#include "H5Rprivate.h"
#include "H5Spublic.h"
#include "H5Tprivate.h"
#include "H5Zprivate.h"

/*
 * Align messages on 8-byte boundaries because we would like to copy the
 * object header chunks directly into memory and operate on them there, even
 * on 64-bit architectures.  This allows us to reduce the number of disk I/O
 * requests with a minimum amount of mem-to-mem copies.
 */
#define H5O_ALIGN(X)		(8*(((X)+8-1)/8))

#define H5O_MIN_SIZE	H5O_ALIGN(32)	/*min obj header data size	     */
#define H5O_MAX_SIZE	65536	        /*max obj header data size	     */
#define H5O_NMESGS	32		/*initial number of messages	     */
#define H5O_NCHUNKS	8		/*initial number of chunks	     */
#define H5O_NEW_MESG	(-1)		/*new message			     */
#define H5O_ALL		(-1)		/*delete all messages of type	     */

/* Flags which are part of a message */
#define H5O_FLAG_CONSTANT	0x01u
#define H5O_FLAG_SHARED		0x02u
#define H5O_FLAG_BITS		0x03u
#define H5O_VERSION		1

/*
 * Size of object header header.
 */
#define H5O_SIZEOF_HDR(F)						      \
    H5O_ALIGN(1 +		/*version number	*/		      \
	      1 +		/*alignment		*/		      \
	      2 +		/*number of messages	*/		      \
	      4 +		/*reference count	*/		      \
	      4)		/*header data size	*/

/*
 * Size of message header
 */
#define H5O_SIZEOF_MSGHDR(F)						      \
     H5O_ALIGN(2 +	/*message type		*/			      \
	       2 +	/*sizeof message data	*/			      \
	       4)	/*reserved		*/

struct H5O_shared_t;
typedef struct H5O_class_t {
    int	id;				 /*message type ID on disk   */
    const char	*name;				 /*for debugging             */
    size_t	native_size;			 /*size of native message    */
    void	*(*decode)(H5F_t*, const uint8_t*, struct H5O_shared_t*);
    herr_t	(*encode)(H5F_t*, uint8_t*, const void*);
    void	*(*copy)(const void*, void*);    /*copy native value         */
    size_t	(*raw_size)(H5F_t*, const void*);/*sizeof raw val	     */
    herr_t	(*reset)(void *);		 /*free nested data structs  */
    herr_t	(*free)(void *);		 /*free main data struct  */
    herr_t	(*get_share)(H5F_t*, const void*, struct H5O_shared_t*);
    herr_t  (*set_share)(H5F_t*, void*, const struct H5O_shared_t*);
    herr_t	(*debug)(H5F_t*, const void*, FILE*, int, int);
} H5O_class_t;

typedef struct H5O_mesg_t {
    const H5O_class_t	*type;		/*type of message		     */
    hbool_t		dirty;		/*raw out of date wrt native	     */
    uint8_t		flags;		/*message flags			     */
    void		*native;	/*native format message		     */
    uint8_t		*raw;		/*ptr to raw data		     */
    size_t		raw_size;	/*size with alignment		     */
    unsigned		chunkno;	/*chunk number for this mesg	     */
} H5O_mesg_t;

typedef struct H5O_chunk_t {
    hbool_t	dirty;			/*dirty flag			     */
    haddr_t	addr;			/*chunk file address		     */
    size_t	size;			/*chunk size			     */
    uint8_t	*image;			/*image of file			     */
} H5O_chunk_t;

typedef struct H5O_t {
    H5AC_info_t cache_info; /* Information for H5AC cache functions, _must_ be */
                            /* first field in structure */
    hbool_t	dirty;			/*out of data wrt disk		     */
    int	version;		/*version number		     */
    int	nlink;			/*link count			     */
    unsigned	nmesgs;			/*number of messages		     */
    unsigned	alloc_nmesgs;	/*number of message slots	     */
    H5O_mesg_t	*mesg;		/*array of messages		     */
    unsigned	nchunks;		/*number of chunks		     */
    unsigned	alloc_nchunks;	/*chunks allocated		     */
    H5O_chunk_t *chunk;		/*array of chunks		     */
} H5O_t;

/*
 * Null Message.
 */
#define H5O_NULL_ID	0x0000
H5_DLLVAR const H5O_class_t H5O_NULL[1];

/*
 * Simple Data Space Message.
 */
#define H5O_SDSPACE_ID	0x0001
H5_DLLVAR const H5O_class_t H5O_SDSPACE[1];

/* operates on an H5S_t struct */

/*
 * Data Type Message.
 */
#define H5O_DTYPE_ID	0x0003
H5_DLLVAR const H5O_class_t H5O_DTYPE[1];

/* operates on an H5T_t struct */

/*
 * Old Fill Value Message.
 */
#define H5O_FILL_ID         0x0004
H5_DLLVAR const H5O_class_t    H5O_FILL[1];

typedef struct H5O_fill_t {
    H5T_t               *type;          /*type. Null implies same as dataset */
    size_t              size;           /*number of bytes in the fill value  */
    void                *buf;           /*the fill value                     */
} H5O_fill_t;

/*
 * New Fill Value Message.  The new fill value message is fill value plus 
 * space allocation time and fill value writing time and whether fill 
 * value is defined.
 */
#define H5O_FILL_NEW_ID           0x0005
H5_DLLVAR const H5O_class_t	H5O_FILL_NEW[1];

typedef struct H5O_fill_new_t {
    H5T_t		*type;		/*type. Null implies same as dataset */
    ssize_t		size;		/*number of bytes in the fill value  */
    void		*buf;		/*the fill value		     */
    H5D_alloc_time_t	alloc_time;	/* time to allocate space	     */
    H5D_fill_time_t	fill_time;	/* time to write fill value	     */	
    htri_t		fill_defined;   /* whether fill value is defined     */	
} H5O_fill_new_t;

/*
 * External File List Message
 */
#define H5O_EFL_ID		0x0007	/*external file list id		     */
#define H5O_EFL_ALLOC		16	/*number of slots to alloc at once   */
#define H5O_EFL_UNLIMITED	H5F_UNLIMITED /*max possible file size	     */
H5_DLLVAR const H5O_class_t H5O_EFL[1];/*external file list class	     */

typedef struct H5O_efl_entry_t {
    size_t	name_offset;	/*offset of name within heap	     */
    char	*name;			/*malloc'd name			     */
    off_t	offset;			/*offset of data within file	     */
    hsize_t	size;			/*size allocated within file	     */
} H5O_efl_entry_t;

typedef struct H5O_efl_t {
    haddr_t	heap_addr;		/*address of name heap		     */
    int	nalloc;			/*number of slots allocated	     */
    int	nused;			/*number of slots used		     */
    H5O_efl_entry_t *slot;	/*array of external file entries     */
} H5O_efl_t;

/*
 * Data Layout Message.
 */
#define H5O_LAYOUT_ID		0x0008
#define H5O_LAYOUT_NDIMS	(H5S_MAX_RANK+1)
H5_DLLVAR const H5O_class_t H5O_LAYOUT[1];

typedef struct H5O_layout_t {
    int		type;			/*type of layout, H5D_layout_t	     */
    haddr_t	addr;			/*file address of data or B-tree     */ 
    unsigned	ndims;			/*num dimensions in stored data	     */
    hsize_t	dim[H5O_LAYOUT_NDIMS];	/*size of data or chunk in bytes     */
    hbool_t     dirty;                  /*dirty flag for compact dataset     */ 
    size_t      size;                   /*size of compact dataset in bytes   */
    void        *buf;                   /*buffer for compact dataset         */
} H5O_layout_t;

/*
 * Filter pipeline message.
 */
#define H5O_PLINE_ID	0x000b
H5_DLLVAR const H5O_class_t H5O_PLINE[1];

typedef struct H5O_pline_t {
    size_t	nfilters;		/*num filters defined		     */
    size_t	nalloc;			/*num elements in `filter' array     */
    struct {
        H5Z_filter_t	id;		/*filter identification number	     */
        unsigned		flags;		/*defn and invocation flags	     */
        char		*name;		/*optional filter name		     */
        size_t		cd_nelmts;	/*number of elements in cd_values[]  */
        unsigned		*cd_values;	/*client data values		     */
    } *filter;				/*array of filters		     */
} H5O_pline_t;

/*
 * Attribute Message.
 */
#define H5O_ATTR_ID	0x000c
H5_DLLVAR const H5O_class_t H5O_ATTR[1];

/* operates on an H5A_t struct */

/*
 * Object name message.
 */
#define H5O_NAME_ID	0x000d
H5_DLLVAR const H5O_class_t H5O_NAME[1];

typedef struct H5O_name_t {
    char	*s;			/*ptr to malloc'd memory	     */
} H5O_name_t;

/*
 * Modification time message.  The message is just a `time_t'.
 */
#define H5O_MTIME_ID	0x000e
H5_DLLVAR const H5O_class_t H5O_MTIME[1];

/*
 * Shared object message.  This message ID never really appears in an object
 * header.  Instead, bit 2 of the `Flags' field will be set and the ID field
 * will be the ID of the pointed-to message.
 */
#define H5O_SHARED_ID	0x000f
H5_DLLVAR const H5O_class_t H5O_SHARED[1];

typedef struct H5O_shared_t {
    hbool_t		in_gh;		/*shared by global heap?	     */
    union {
	H5HG_t		gh;		/*global heap info		     */
	H5G_entry_t	ent;		/*symbol table entry info	     */
    } u;
} H5O_shared_t;

/*
 * Object header continuation message.
 */
#define H5O_CONT_ID	0x0010
H5_DLLVAR const H5O_class_t H5O_CONT[1];

typedef struct H5O_cont_t {
    haddr_t	addr;			/*address of continuation block	     */
    size_t	size;			/*size of continuation block	     */

    /* the following field(s) do not appear on disk */
    unsigned	chunkno;		/*chunk this mesg refers to	     */
} H5O_cont_t;

/*
 * Symbol table message.
 */
#define H5O_STAB_ID	0x0011
H5_DLLVAR const H5O_class_t H5O_STAB[1];

H5_DLL void *H5O_stab_fast(const H5G_cache_t *cache, const H5O_class_t *type,
			    void *_mesg);

typedef struct H5O_stab_t {
    haddr_t	btree_addr;		/*address of B-tree		     */
    haddr_t	heap_addr;		/*address of name heap		     */
} H5O_stab_t;

/*
 * Generic property list message.
 */
#define H5O_PLIST_ID	0x0012
H5_DLLVAR const H5O_class_t H5O_PLIST[1];

/* operates on an H5P_genplist_t struct */

#ifdef H5_HAVE_FPHDF5
/*
 * Flexible parallel message
 */
#define H5O_FPHDF5_ID	0x0013
H5_DLLVAR const H5O_class_t H5O_FPHDF5[1];

struct H5S_simple_t;
struct H5P_genplist_t;

typedef struct H5O_fphdf5_t {
    uint8_t oid[H5R_OBJ_REF_BUF_SIZE];  /* OID of object                    */
    haddr_t header;                     /* Header address info              */
    struct H5S_simple_t *sdim;          /* Simple dimensionality structure  */
    H5T_t *dtype;                       /* Datatype structure               */
    time_t *mtime;                      /* Modification time                */
    H5O_layout_t *layout;               /* Dataset layout                   */
    H5O_name_t *group;                  /* Group name                       */
    H5O_name_t *dset;                   /* Dataset name                     */
    H5O_efl_t *efl;                     /* External file layout             */
    struct H5P_genplist_t *plist;       /* Property list of the object      */
} H5O_fphdf5_t;

/* operates on an H5O_fphdf5_t struct */
#endif  /* H5_HAVE_FPHDF5 */

/* General message operators */
H5_DLL herr_t H5O_create(H5F_t *f, size_t size_hint,
			  H5G_entry_t *ent/*out*/);
H5_DLL herr_t H5O_init(H5F_t *f, size_t size_hint,
                       H5G_entry_t *ent/*out*/, haddr_t header);
H5_DLL herr_t H5O_open(H5G_entry_t *ent);
H5_DLL herr_t H5O_close(H5G_entry_t *ent);
H5_DLL int H5O_link(H5G_entry_t *ent, int adjust);
H5_DLL int H5O_count(H5G_entry_t *ent, const H5O_class_t *type);
H5_DLL htri_t H5O_exists(H5G_entry_t *ent, const H5O_class_t *type,
			  int sequence);
H5_DLL void *H5O_read(H5G_entry_t *ent, const H5O_class_t *type,
		       int sequence, void *mesg);
H5_DLL int H5O_modify(H5G_entry_t *ent, const H5O_class_t *type,
			int overwrite, unsigned flags, const void *mesg);
H5_DLL herr_t H5O_touch(H5G_entry_t *ent, hbool_t force);
H5_DLL herr_t H5O_remove(H5G_entry_t *ent, const H5O_class_t *type,
			  int sequence);
H5_DLL herr_t H5O_reset(const H5O_class_t *type, void *native);
H5_DLL void *H5O_free(const H5O_class_t *type, void *mesg);
H5_DLL void *H5O_copy(const H5O_class_t *type, const void *mesg, void *dst);
H5_DLL herr_t H5O_share(H5F_t *f, const H5O_class_t *type, const void *mesg,
			 H5HG_t *hobj/*out*/);
H5_DLL herr_t H5O_debug(H5F_t *f, haddr_t addr, FILE * stream, int indent,
			 int fwidth);

/* Layout operators */
H5_DLL size_t H5O_layout_meta_size(H5F_t *f, const void *_mesg);

/* EFL operators */
H5_DLL hsize_t H5O_efl_total_size(H5O_efl_t *efl);
H5_DLL herr_t H5O_efl_read(H5F_t *f, const H5O_efl_t *efl, haddr_t addr,
			    size_t size, uint8_t *buf);
H5_DLL herr_t H5O_efl_write(H5F_t *f, const H5O_efl_t *efl, haddr_t addr,
			     size_t size, const uint8_t *buf);

/* Fill value operators */
H5_DLL herr_t H5O_fill_convert(void *_fill, H5T_t *type);

#endif