-
Notifications
You must be signed in to change notification settings - Fork 4
Expand file tree
/
Copy pathfam_get_option.html
More file actions
382 lines (377 loc) · 10.2 KB
/
fam_get_option.html
File metadata and controls
382 lines (377 loc) · 10.2 KB
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
379
380
381
382
<!DOCTYPE html>
<html lang="en">
<head>
<link rel="stylesheet" type="text/css" href="styles/style.css">
<title>OpenFAM: A library for programming Fabric-Attached Memory</title>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
</head>
<body>
<header>
<h1>OpenFAM Reference Implementation</h1>
</header>
<section>
<nav>
<ul>
<li><a href="index.html">Home</a></li>
<li><a href="release_notes.html">Release Notes</a></li>
<li><a href="limitations.html">Design Choices</a></li>
<li><a href="errors.html">Exceptions and Error Codes</a></li>
<li><a href="services.html">Services</a></li>
<li><a href="config_files.html">Configuration Files</a></li>
</ul>
<hr>
Initialization and Finalization
<ul>
<li><a href="fam_initialize.html">fam_initialize</a></li>
<li><a href="fam_finalize.html">fam_finalize</a></li>
<li><a href="fam_abort.html">fam_abort</a></li>
</ul>
<hr>
Options & Query
<ul>
<li><a href="fam_list_options.html">fam_list_options</a></li>
<li><a href="fam_get_option.html">fam_get_option</a></li>
<li><a href="fam_lookup.html">fam_lookup</a></li>
<li><a href="fam_stat.html">fam_stat</a></li>
</ul>
<hr>
Memory Allocation
<ul>
<li><a href="fam_create_region.html">fam_create_region</a></li>
<li><a href="fam_destroy_region.html">fam_destroy_region</a></li>
<li><a href="fam_resize_region.html">fam_resize_region</a></li>
<li><a href="fam_allocate.html">fam_allocate</a></li>
<li><a href="fam_deallocate.html">fam_deallocate</a></li>
<li><a href="fam_change_permissions.html">fam_change_permissions</a></li>
<li><a href="fam_close.html">fam_close</a></li>
</ul>
<hr>
Memory Map
<ul>
<li><a href="fam_map.html">fam_map</a></li>
<li><a href="fam_unmap.html">fam_unmap</a></li>
</ul>
<hr>
Data Path Operations
<ul>
<li><a href="fam_get.html">fam_get</a></li>
<li><a href="fam_put.html">fam_put</a></li>
<li><a href="fam_gather.html">fam_gather</a></li>
<li><a href="fam_scatter.html">fam_scatter</a></li>
<li><a href="fam_copy.html">fam_copy</a></li>
<li><a href="fam_copy_wait.html">fam_copy_wait</a></li>
<li><a href="fam_backup.html">fam_backup</a></li>
<li><a href="fam_backup_wait.html">fam_backup_wait</a></li>
<li><a href="fam_restore.html">fam_restore</a></li>
<li><a href="fam_restore_wait.html">fam_restore_wait</a></li>
<li><a href="fam_delete_backup.html">fam_delete_backup</a></li>
<li><a href="fam_delete_backup_wait.html">fam_delete_backup_wait</a></li>
</ul>
<hr>
Atomics
<ul>
<li><a href="fam_set.html">fam_set</a></li>
<li><a href="fam_add.html">fam_add</a></li>
<li><a href="fam_subtract.html">fam_subtract</a></li>
<li><a href="fam_min.html">fam_min</a></li>
<li><a href="fam_max.html">fam_max</a></li>
<li><a href="fam_and.html">fam_and</a></li>
<li><a href="fam_or.html">fam_or</a></li>
<li><a href="fam_xor.html">fam_xor</a></li>
<li><a href="fam_fetch_TYPE.html">fam_fetch_TYPE</a></li>
<li><a href="fam_swap.html">fam_swap</a></li>
<li><a href="fam_compare_swap.html">fam_compare_swap</a></li>
<li><a href="fam_fetch_add.html">fam_fetch_add</a></li>
<li><a href="fam_fetch_subtract.html">fam_fetch_subtract</a></li>
<li><a href="fam_fetch_min.html">fam_fetch_min</a></li>
<li><a href="fam_fetch_and.html">fam_fetch_and</a></li>
<li><a href="fam_fetch_max.html">fam_fetch_max</a></li>
<li><a href="fam_fetch_or.html">fam_fetch_or</a></li>
<li><a href="fam_fetch_xor.html">fam_fetch_xor</a></li>
</ul>
<hr>
Ordering
<ul>
<li><a href="fam_barrier_all.html">fam_barrier_all</a></li>
<li><a href="fam_fence.html">fam_fence</a></li>
<li><a href="fam_quiet.html">fam_quiet</a></li>
<li><a href="fam_progress.html">fam_progress</a></li>
<li><a href="fam_context_open.html">fam_context_open</a></li>
<li><a href="fam_context_close.html">fam_context_close</a></li>
</ul>
<hr>
</nav>
<article>
<h1 class="code">openfam::fam::fam_get_option</h1>
<p>Get the value for a pre-defined option in the FAM library.</p>
<h2>Synopsis</h2>
<p class="code">const void *fam_get_option(char *optionName);</p>
<h2>Description</h2>
<p>This method can be used to retrieve values of state variables
maintained within OpenFAM or set using the options argument to
<code>fam_initialize()</code>. The supported names (and returned types) are
implementation specific.</p>
<h2>Input Arguments</h2>
<table>
<tbody>
<tr><th>Name</th><th>Description</th></tr>
<tr><td class="code">optionName</td><td>Name of the option to be retrieved.</td></tr>
</tbody>
</table>
The following option names are available:
<table id="e1">
<tbody>
<tr><th>Name</th><th>Description</th><th>Return type</th><th>Default Value</th></tr>
<tr><td class="code">"VERSION"</td>
<td>Version of the current implementation of the OpenFAM API.</td>
<td class="code">char*</td>
<td class="code">"3.0"</td>
</tr>
<tr>
<td class="code">
"DEFAULT_REGION_NAME"
</td>
<td>
The default Region name used with in the program.
</td>
<td class="code">
char*
</td>
<td class="code">
"default"
</td>
</tr>
<tr>
<td class="code">
"CIS_SERVER"
</td>
<td>
Client Interface Server set by the application.
</td>
<td class="code">
char*
</td>
<td class="code">
"127.0.0.1"
</td>
</tr>
<tr>
<td class="code">
"GRPC_PORT"
</td>
<td>
Grpc port used by Client Interface Server.
</td>
<td class="code">
char*
</td>
<td class="code">
"8787"
</td>
</tr>
<tr>
<td class="code">
"LIBFABRIC_PROVIDER"
</td>
<td>
Libfabric provider type set by the application.
</td>
<td class="code">
char*
</td>
<td class="code">
"sockets"
</td>
</tr>
<tr>
<td class="code">
"FAM_THREAD_MODEL"
</td>
<td>
Thread model used by the application.
</td>
<td class="code">
char*
</td>
<td class="code">
"FAM_THREAD_SERIALIZE"
</td>
</tr>
<tr>
<td class="code">
"CIS_INTERFACE_TYPE"
</td>
<td>
Interface Type for CIS Server.
</td>
<td class="code">
char*
</td>
<td class="code">
"FAM_THREAD_SERIALIZE"
</td>
</tr>
<tr>
<td class="code">
"OPENFAM_MODEL"
</td>
<td>
OpenFAM allocator model used by the application.
</td>
<td class="code">
char*
</td>
<td class="code">
"memory_server"
</td>
</tr>
<tr>
<td class="code">
"FAM_CONTEXT_MODEL"
</td>
<td>
Fam context model used by the application.
</td>
<td class="code">
char*
</td>
<td class="code">
"FAM_CONTEXT_DEFAULT"
</td>
</tr>
<tr>
<td class="code">
"PE_COUNT"
</td>
<td>
Number of PEs running the application program.
</td>
<td class="code">
int*
</td>
<td class="code">
1
</td>
</tr>
<tr>
<td class="code">
"PE_ID"
</td>
<td>
PE id of the current program.
</td>
<td class="code">
int*
</td>
<td class="code">
0
</td>
</tr>
<tr>
<td class="code">
"RUNTIME"
</td>
<td>
Runtime environment used by the application.
</td>
<td class="code">
char*
</td>
<td class="code">
"PMIX"
</td>
</tr>
<tr>
<td class="code">
"NUM_CONSUMER"
</td>
<td>
Number of consumer threads running in shared memory
allocator.
</td>
<td class="code">
char*
</td>
<td class="code">
"1"
</td>
</tr>
<tr>
<td class="code">
"FAM_DEFAULT_MEMORY_TYPE"
</td>
<td>
Memory type used for region creation and allocation.
(Volatile/Persistent)
</td>
<td class="code">
char*
</td>
<td class="code">
"VOLATILE"
</td>
</tr>
<tr>
<td class="code">
"IF_DEVICE"
</td>
<td>
Device Name to be used for data path operations with remote memory servers.
</td>
<td class="code">
char*
</td>
<td class="code">
"cxi0" for cxi devices and "ib0" for Infiniband devices.
</td>
</tr>
</tbody>
</table>
<p> </p>
<p>Note: The following options are not supported in current
implementation and should not be used, even though they have default values.
<code>"DEFAULT_REGION_NAME"</code> and <code>"FAM_CONTEXT_MODEL"</code></p>
<h2>Return Values</h2>
<p>A pointer to the value of the option. Throws <code>Fam_Exception</code> on
error.</p>
<h2>Fam Error Numbers</h2>
<table>
<tbody>
<tr><th>Error</th><th>Description</th></tr>
<tr><td class="code">FAM_ERR_INVALID</td><td>If <code>optionName</code> not found.</td></tr>
</tbody>
</table>
<h2>Notes</h2>
<p>None.</p>
<h2>Example</h2>
<pre>
#include <stdlib.h>
#include <stdio.h>
#include <string.h>
#include <fam/fam.h>
#include <fam/fam_exception.h>
using namespace std;
using namespace openfam;
int main(void) {
fam *myFam = new fam();
// ... initialization code here
try {
// assume that library version is one of the supported options
const char * libraryVersion = (const char *)myFam->fam_get_option(strdup("VERSION"));
printf("%s\n", libraryVersion);
} catch (Fam_Exception& e) {
printf("FAM API failed: %s\n", e.fam_error_msg());
myFam->fam_abort(-1); // abort the program
return -1;
}
// ... finalization code here
}
</pre>
</article>
</section>
<footer>
<p>Copyright 2021-2023, Hewlett Packard Enterprise Development Co, LLP</p>
</footer>
</body>
</html>