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
|
/*
* Copyright (c) 2004-2006 High Performance Computing Center Stuttgart,
* University of Stuttgart. All rights reserved.
* $COPYRIGHT$
*
* Additional copyrights may follow
*
* $HEADER$
*
*/
#ifndef OPAL_MEMCHECKER_BASE_H
#define OPAL_MEMCHECKER_BASE_H
#include "opal_config.h"
#include "opal/mca/base/mca_base_framework.h"
#include "opal/mca/memchecker/memchecker.h"
/*
* Global functions for MCA overall memchecker open and close
*/
BEGIN_C_DECLS
/**
* Select one available component.
*
* @return OPAL_SUCCESS Upon success.
*
* This function invokes the selection process for memchecker
* components
*/
OPAL_DECLSPEC int opal_memchecker_base_select(void);
/**
* Framework structure for memchecker
*/
OPAL_DECLSPEC extern mca_base_framework_t opal_memchecker_base_framework;
/**
* Indication of whether one component was successfully selected
*/
OPAL_DECLSPEC extern bool opal_memchecker_base_selected;
/**
* Global component struct for the selected component
*/
OPAL_DECLSPEC extern const opal_memchecker_base_component_2_0_0_t *opal_memchecker_base_component;
/**
* Global module struct for the selected module
*/
OPAL_DECLSPEC extern const opal_memchecker_base_module_1_0_0_t *opal_memchecker_base_module;
/**
* Check if we are running under the memory debugger.
*
* @retval 0 if not running under memory debugger
* !=0 if running under memory debugger
*
*/
OPAL_DECLSPEC int opal_memchecker_base_runindebugger(void);
#if OPAL_WANT_MEMCHECKER == 0
# define opal_memchecker_base_runindebugger() 0
#endif
/**
* Check if a memory region is valid to address
*
* @param p Pointer to the memory region
* @param len Length of the memory region
*
* @retval OPAL_SUCCESS upon success.
*
* This function calls the selected memchecker, whether
* every Byte of this memory region is addressable
*/
OPAL_DECLSPEC int opal_memchecker_base_isaddressable(void *p, size_t len);
#if OPAL_WANT_MEMCHECKER == 0
# define opal_memchecker_base_isaddressable(p, len) 0
#endif
/**
* Check if a memory region is defined
*
* @param p Pointer to the memory region
* @param len Length of the memory region
*
* @retval OPAL_SUCCESS upon success.
*
* This function calls the selected memchecker, whether
* every Byte of this memory region is correctly initialized.
*/
OPAL_DECLSPEC int opal_memchecker_base_isdefined(void *p, size_t len);
#if OPAL_WANT_MEMCHECKER == 0
# define opal_memchecker_base_isdefined(p, len) 0
#endif
/**
* Set a memory region to not accessible
*
* @param p Pointer to the memory region
* @param len Length of the memory region
*
* @retval OPAL_SUCCESS upon success.
*
* This function calls the selected memchecker, to set
* every Byte of this memory region to not accessible.
*/
OPAL_DECLSPEC int opal_memchecker_base_mem_noaccess(void *p, size_t len);
#if OPAL_WANT_MEMCHECKER == 0
# define opal_memchecker_base_mem_noaccess(p, len)
#endif
/**
* Set a memory region to undefined
*
* @param p Pointer to the memory region
* @param len Length of the memory region
*
* @retval OPAL_SUCCESS upon success.
*
* This function calls the selected memchecker, to set
* every Byte of this memory region to not contain initialized data.
*/
OPAL_DECLSPEC int opal_memchecker_base_mem_undefined(void *p, size_t len);
#if OPAL_WANT_MEMCHECKER == 0
# define opal_memchecker_base_mem_undefined(p, len)
#endif
/**
* Set a memory region to defined
*
* @param p Pointer to the memory region
* @param len Length of the memory region
*
* @retval OPAL_SUCCESS upon success.
*
* This function calls the selected memchecker, to set
* every Byte of this memory region to contain valid, initialized data.
*/
OPAL_DECLSPEC int opal_memchecker_base_mem_defined(void *p, size_t len);
#if OPAL_WANT_MEMCHECKER == 0
# define opal_memchecker_base_mem_defined(p, len)
#endif
/**
* Set a memory region to defined only if the region is addressable
*
* @param p Pointer to the memory region
* @param len Length of the memory region
*
* @retval OPAL_SUCCESS upon success.
*
* This function calls the selected memchecker, to set
* every Byte of this memory region to contain valid, initialized data,
* but only, if the memory region is addressable.
*/
OPAL_DECLSPEC int opal_memchecker_base_mem_defined_if_addressable(void *p, size_t len);
#if OPAL_WANT_MEMCHECKER == 0
# define opal_memchecker_base_mem_defined_if_addressable(p, len)
#endif
/**
* Create a named memory region
*
* @param p Pointer to the memory region
* @param len Length of the memory region
* @param description Name of the memory region
*
* @retval OPAL_SUCCESS upon success.
*
* This function calls the selected memchecker, to name
* this memory region.
*/
OPAL_DECLSPEC int opal_memchecker_base_create_block(void *p, size_t len, char *description);
#if OPAL_WANT_MEMCHECKER == 0
# define opal_memchecker_base_create_block(p, len, description)
#endif
/**
* Discard a named memory region
*
* @param p Pointer to the memory region
*
* @retval OPAL_SUCCESS upon success.
*
* This function calls the selected memchecker, to discard
* the name information of the memory region.
*/
OPAL_DECLSPEC int opal_memchecker_base_discard_block(void *p);
#if OPAL_WANT_MEMCHECKER == 0
# define opal_memchecker_base_discard_block(p)
#endif
/**
* Perform leak check on lost allocated memory.
*
* @param len Length of the memory region
*
* @retval OPAL_SUCCESS upon success.
*
* This function calls the selected memchecker, to output
* information regarding lost allocated memory.
*/
OPAL_DECLSPEC int opal_memchecker_base_leakcheck(void);
#if OPAL_WANT_MEMCHECKER == 0
# define opal_memchecker_base_leakcheck
#endif
/**
* Get vbits of the memory
*
* @param p Pointer to the memory region
* @param vbits Pointer to the vbit table
* @param len Length of the memory region
*
* @retval OPAL_SUCCESS upon success.
*
* This function calls the selected memchecker, to get
* every vbit of this memory region.
*/
OPAL_DECLSPEC int opal_memchecker_base_get_vbits(void *p, char *vbits, size_t len);
#if OPAL_WANT_MEMCHECKER == 0
# define opal_memchecker_base_get_vbits(p, vbits, len)
#endif
/**
* Set vbits of the memory
*
* @param p Pointer to the memory region
* @param vbits Pointer to the vbit table
* @param len Length of the memory region
*
* @retval OPAL_SUCCESS upon success.
*
* This function calls the selected memchecker, to get
* every vbit of this memory region.
*/
OPAL_DECLSPEC int opal_memchecker_base_set_vbits(void *p, char *vbits, size_t len);
#if OPAL_WANT_MEMCHECKER == 0
# define opal_memchecker_base_set_vbits(p, vbits, len)
#endif
END_C_DECLS
#endif /* OPAL_MEMCHECKER_BASE_H */
|
