Debian Codegraph @

doc/doxygen-doc/man/man3/hwlocality_syntheticexport.3

raw
1 .TH "hwlocality_syntheticexport" 3 "Version 2.14.0" "Hardware Locality (hwloc)" \" -*- nroff -*-
2 .ad l
3 .nh
4 .SH NAME
5 hwlocality_syntheticexport \- Exporting Topologies to Synthetic
6 .SH SYNOPSIS
7 .br
8 .PP
9 .SS "Enumerations"
10
11 .in +1c
12 .ti -1c
13 .RI "enum \fBhwloc_topology_export_synthetic_flags_e\fP { \fBHWLOC_TOPOLOGY_EXPORT_SYNTHETIC_FLAG_NO_EXTENDED_TYPES\fP, \fBHWLOC_TOPOLOGY_EXPORT_SYNTHETIC_FLAG_NO_ATTRS\fP, \fBHWLOC_TOPOLOGY_EXPORT_SYNTHETIC_FLAG_V1\fP, \fBHWLOC_TOPOLOGY_EXPORT_SYNTHETIC_FLAG_IGNORE_MEMORY\fP }"
14 .br
15 .in -1c
16 .SS "Functions"
17
18 .in +1c
19 .ti -1c
20 .RI "int \fBhwloc_topology_export_synthetic\fP (\fBhwloc_topology_t\fP topology, char *buffer, size_t buflen, unsigned long flags)"
21 .br
22 .in -1c
23 .SH "Detailed Description"
24 .PP
25
26 .SH "Enumeration Type Documentation"
27 .PP
28 .SS "enum \fBhwloc_topology_export_synthetic_flags_e\fP"
29
30 .PP
31 Flags for exporting synthetic topologies\&. Flags to be given as a OR'ed set to \fBhwloc_topology_export_synthetic()\fP\&.
32 .PP
33 \fBEnumerator\fP
34 .in +1c
35 .TP
36 \f(BIHWLOC_TOPOLOGY_EXPORT_SYNTHETIC_FLAG_NO_EXTENDED_TYPES \fP
37 Export extended types such as L2dcache as basic types such as Cache\&. This is required if loading the synthetic description with hwloc < 1\&.9\&.
38 .TP
39 \f(BIHWLOC_TOPOLOGY_EXPORT_SYNTHETIC_FLAG_NO_ATTRS \fP
40 Do not export level attributes\&. Ignore level attributes such as memory/cache sizes or PU indexes\&. This is required if loading the synthetic description with hwloc < 1\&.10\&.
41 .TP
42 \f(BIHWLOC_TOPOLOGY_EXPORT_SYNTHETIC_FLAG_V1 \fP
43 Export the memory hierarchy as expected in hwloc 1\&.x\&. Instead of attaching memory children to levels, export single NUMA node child as normal intermediate levels, when possible\&. This is required if loading the synthetic description with hwloc 1\&.x\&. However this may fail if some objects have multiple local NUMA nodes\&.
44 .TP
45 \f(BIHWLOC_TOPOLOGY_EXPORT_SYNTHETIC_FLAG_IGNORE_MEMORY \fP
46 Do not export memory information\&. Only export the actual hierarchy of normal CPU-side objects and ignore where memory is attached\&. This is useful for when the hierarchy of CPUs is what really matters, but it behaves as if there was a single machine-wide NUMA node\&.
47 .SH "Function Documentation"
48 .PP
49 .SS "int hwloc_topology_export_synthetic (\fBhwloc_topology_t\fP topology, char * buffer, size_t buflen, unsigned long flags)"
50
51 .PP
52 Export the topology as a synthetic string\&. At most \fRbuflen\fP characters will be written in \fRbuffer\fP, including the terminating \\0\&.
53
54 .PP
55 This exported string may be given back to \fBhwloc_topology_set_synthetic()\fP\&.
56
57 .PP
58 \fRflags\fP is a OR'ed set of \fBhwloc_topology_export_synthetic_flags_e\fP\&.
59
60 .PP
61 \fBReturns\fP
62 .RS 4
63 The number of characters that were written, not including the terminating \\0\&.
64
65 .PP
66 -1 if the topology could not be exported, for instance if it is not symmetric\&.
67 .RE
68 .PP
69 \fBNote\fP
70 .RS 4
71 I/O and Misc children are ignored, the synthetic string only describes normal children\&.
72
73 .PP
74 A 1024-byte buffer should be large enough for exporting topologies in the vast majority of cases\&.
75 .RE
76 .PP
77
78 .SH "Author"
79 .PP
80 Generated automatically by Doxygen for Hardware Locality (hwloc) from the source code\&.