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
|
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
* 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: The public header file for the direct virtual file driver (VFD)
*/
#ifndef H5FDdirect_H
#define H5FDdirect_H
#ifdef H5_HAVE_DIRECT
/** Initializer for the direct VFD */
#define H5FD_DIRECT (H5FDperform_init(H5FD_direct_init))
/** Identifier for the direct VFD */
#define H5FD_DIRECT_VALUE H5_VFD_DIRECT
#else
/** Initializer for the direct VFD (disabled) */
#define H5FD_DIRECT (H5I_INVALID_HID)
/** Identifier for the direct VFD (disabled) */
#define H5FD_DIRECT_VALUE H5_VFD_INVALID
#endif /* H5_HAVE_DIRECT */
/** Default value for memory boundary */
#define MBOUNDARY_DEF 4096
/** Default value for file block size */
#define FBSIZE_DEF 4096
/** Default value for maximum copy buffer size */
#define CBSIZE_DEF (16 * 1024 * 1024)
#ifdef H5_HAVE_DIRECT
#ifdef __cplusplus
extern "C" {
#endif
/** @private
*
* \brief Private initializer for the direct VFD
*/
H5_DLL hid_t H5FD_direct_init(void);
/**
* \ingroup FAPL
*
* \brief Sets up use of the direct I/O driver
*
* \fapl_id
* \param[in] alignment Required memory alignment boundary
* \param[in] block_size File system block size
* \param[in] cbuf_size Copy buffer size
* \returns \herr_t
*
* \details H5Pset_fapl_direct() sets the file access property list, \p fapl_id,
* to use the direct I/O driver, #H5FD_DIRECT. With this driver, data
* is written to or read from the file synchronously without being
* cached by the system.
*
* File systems usually require the data address in memory, the file
* address, and the size of the data to be aligned. The HDF5 library's
* direct I/O driver is able to handle unaligned data, though that will
* consume some additional memory resources and may slow
* performance. To get better performance, use the system function \p
* posix_memalign to align the data buffer in memory and the HDF5
* function H5Pset_alignment() to align the data in the file. Be aware,
* however, that aligned data I/O may cause the HDF5 file to be bigger
* than the actual data size would otherwise require because the
* alignment may leave some holes in the file.
*
* \p alignment specifies the required alignment boundary in memory.
*
* \p block_size specifies the file system block size. A value of 0
* (zero) means to use HDF5 library's default value of 4KB.
*
* \p cbuf_size specifies the copy buffer size.
*
* \since 1.8.0
*
*/
H5_DLL herr_t H5Pset_fapl_direct(hid_t fapl_id, size_t alignment, size_t block_size, size_t cbuf_size);
/**
* \ingroup FAPL
*
* \brief Retrieves direct I/O driver settings
*
* \fapl_id
* \param[out] boundary Required memory alignment boundary
* \param[out] block_size File system block size
* \param[out] cbuf_size Copy buffer size
* \returns \herr_t
*
* \details H5Pget_fapl_direct() retrieves the required memory alignment (\p
* alignment), file system block size (\p block_size), and copy buffer
* size (\p cbuf_size) settings for the direct I/O driver, #H5FD_DIRECT,
* from the file access property list \p fapl_id.
*
* See H5Pset_fapl_direct() for discussion of these values,
* requirements, and important considerations.
*
* \since 1.8.0
*
*/
H5_DLL herr_t H5Pget_fapl_direct(hid_t fapl_id, size_t *boundary /*out*/, size_t *block_size /*out*/,
size_t *cbuf_size /*out*/);
#ifdef __cplusplus
}
#endif
#endif /* H5_HAVE_DIRECT */
#endif
|
