Hardware Locality (hwloc) 1.11.13

diff.h
1 /*
2 * Copyright © 2013-2018 Inria. All rights reserved.
3 * See COPYING in top-level directory.
4 */
5
10 #ifndef HWLOC_DIFF_H
11 #define HWLOC_DIFF_H
12
13 #ifndef HWLOC_H
14 #error Please include the main hwloc.h instead
15 #endif
16
17
18 #ifdef __cplusplus
19 extern "C" {
20 #elif 0
21 }
22 #endif
23
24
61 typedef enum hwloc_topology_diff_obj_attr_type_e {
66 HWLOC_TOPOLOGY_DIFF_OBJ_ATTR_SIZE,
67
73 HWLOC_TOPOLOGY_DIFF_OBJ_ATTR_NAME,
77 HWLOC_TOPOLOGY_DIFF_OBJ_ATTR_INFO
78 } hwloc_topology_diff_obj_attr_type_t;
79
82 union hwloc_topology_diff_obj_attr_u {
83 struct hwloc_topology_diff_obj_attr_generic_s {
84 /* each part of the union must start with these */
85 hwloc_topology_diff_obj_attr_type_t type;
86 } generic;
87
89 struct hwloc_topology_diff_obj_attr_uint64_s {
90 /* used for storing integer attributes */
91 hwloc_topology_diff_obj_attr_type_t type;
92 hwloc_uint64_t index; /* not used for SIZE */
93 hwloc_uint64_t oldvalue;
94 hwloc_uint64_t newvalue;
95 } uint64;
96
98 struct hwloc_topology_diff_obj_attr_string_s {
99 /* used for storing name and info pairs */
100 hwloc_topology_diff_obj_attr_type_t type;
101 char *name; /* not used for NAME */
102 char *oldvalue;
103 char *newvalue;
104 } string;
105 };
106
107
110 typedef enum hwloc_topology_diff_type_e {
114 HWLOC_TOPOLOGY_DIFF_OBJ_ATTR,
115
123 HWLOC_TOPOLOGY_DIFF_TOO_COMPLEX
124 } hwloc_topology_diff_type_t;
125
128 typedef union hwloc_topology_diff_u {
129 struct hwloc_topology_diff_generic_s {
130 /* each part of the union must start with these */
131 hwloc_topology_diff_type_t type;
132 union hwloc_topology_diff_u * next; /* pointer to the next element of the list, or NULL */
133 } generic;
134
135 /* A difference in an object attribute. */
136 struct hwloc_topology_diff_obj_attr_s {
137 hwloc_topology_diff_type_t type; /* must be ::HWLOC_TOPOLOGY_DIFF_OBJ_ATTR */
138 union hwloc_topology_diff_u * next;
139 /* List of attribute differences for a single object */
140 unsigned obj_depth;
141 unsigned obj_index;
142 union hwloc_topology_diff_obj_attr_u diff;
143 } obj_attr;
144
145 /* A difference that is too complex. */
146 struct hwloc_topology_diff_too_complex_s {
147 hwloc_topology_diff_type_t type; /* must be ::HWLOC_TOPOLOGY_DIFF_TOO_COMPLEX */
148 union hwloc_topology_diff_u * next;
149 /* Where we had to stop computing the diff in the first topology */
150 unsigned obj_depth;
151 unsigned obj_index;
152 } too_complex;
153 } * hwloc_topology_diff_t;
154
155
193 HWLOC_DECLSPEC int hwloc_topology_diff_build(hwloc_topology_t topology, hwloc_topology_t newtopology, unsigned long flags, hwloc_topology_diff_t *diff);
194
197 enum hwloc_topology_diff_apply_flags_e {
201 HWLOC_TOPOLOGY_DIFF_APPLY_REVERSE = (1UL<<0)
202 };
203
221 HWLOC_DECLSPEC int hwloc_topology_diff_apply(hwloc_topology_t topology, hwloc_topology_diff_t diff, unsigned long flags);
222
228 HWLOC_DECLSPEC int hwloc_topology_diff_destroy(hwloc_topology_t topology, hwloc_topology_diff_t diff);
229
244 HWLOC_DECLSPEC int hwloc_topology_diff_load_xml(hwloc_topology_t topology, const char *xmlpath, hwloc_topology_diff_t *diff, char **refname);
245
258 HWLOC_DECLSPEC int hwloc_topology_diff_export_xml(hwloc_topology_t topology, hwloc_topology_diff_t diff, const char *refname, const char *xmlpath);
259
274 HWLOC_DECLSPEC int hwloc_topology_diff_load_xmlbuffer(hwloc_topology_t topology, const char *xmlbuffer, int buflen, hwloc_topology_diff_t *diff, char **refname);
275
293 HWLOC_DECLSPEC int hwloc_topology_diff_export_xmlbuffer(hwloc_topology_t topology, hwloc_topology_diff_t diff, const char *refname, char **xmlbuffer, int *buflen);
294
298 #ifdef __cplusplus
299 } /* extern "C" */
300 #endif
301
302
303 #endif /* HWLOC_DIFF_H */
hwloc_topology_diff_obj_attr_u::hwloc_topology_diff_obj_attr_string_s::newvalue
char * newvalue
Definition: diff.h:103
hwloc_topology_diff_obj_attr_u
One object attribute difference.
Definition: diff.h:82
hwloc_topology_diff_obj_attr_type_t
enum hwloc_topology_diff_obj_attr_type_e hwloc_topology_diff_obj_attr_type_t
Type of one object attribute difference.
hwloc_topology_diff_obj_attr_u::string
struct hwloc_topology_diff_obj_attr_u::hwloc_topology_diff_obj_attr_string_s string
hwloc_topology_diff_u::hwloc_topology_diff_too_complex_s::obj_depth
unsigned obj_depth
Definition: diff.h:150
hwloc_topology_diff_u::hwloc_topology_diff_obj_attr_s::next
union hwloc_topology_diff_u * next
Definition: diff.h:138
hwloc_topology_diff_u::hwloc_topology_diff_too_complex_s::next
union hwloc_topology_diff_u * next
Definition: diff.h:148
hwloc_topology_diff_u::hwloc_topology_diff_generic_s::type
hwloc_topology_diff_type_t type
Definition: diff.h:131
hwloc_topology_diff_u::hwloc_topology_diff_generic_s
Definition: diff.h:129
hwloc_topology_diff_apply
int hwloc_topology_diff_apply(hwloc_topology_t topology, hwloc_topology_diff_t diff, unsigned long flags)
Apply a topology diff to an existing topology.
hwloc_topology_diff_obj_attr_u::hwloc_topology_diff_obj_attr_uint64_s
Integer attribute modification with an optional index.
Definition: diff.h:89
hwloc_topology_diff_obj_attr_u::hwloc_topology_diff_obj_attr_uint64_s::oldvalue
hwloc_uint64_t oldvalue
Definition: diff.h:93
HWLOC_TOPOLOGY_DIFF_OBJ_ATTR_INFO
the value of an info attribute is modified. The union is a hwloc_topology_diff_obj_attr_u::hwloc_topo...
Definition: diff.h:77
hwloc_topology_diff_u::hwloc_topology_diff_obj_attr_s::obj_index
unsigned obj_index
Definition: diff.h:141
hwloc_topology_diff_export_xml
int hwloc_topology_diff_export_xml(hwloc_topology_t topology, hwloc_topology_diff_t diff, const char *refname, const char *xmlpath)
Export a list of topology differences to a XML file.
hwloc_topology_diff_load_xml
int hwloc_topology_diff_load_xml(hwloc_topology_t topology, const char *xmlpath, hwloc_topology_diff_t *diff, char **refname)
Load a list of topology differences from a XML file.
hwloc_topology_diff_type_e
hwloc_topology_diff_type_e
Type of one element of a difference list.
Definition: diff.h:110
hwloc_topology_diff_u::hwloc_topology_diff_too_complex_s
Definition: diff.h:146
hwloc_topology_diff_obj_attr_u::hwloc_topology_diff_obj_attr_string_s::name
char * name
Definition: diff.h:101
hwloc_topology_diff_u
One element of a difference list between two topologies.
Definition: diff.h:128
hwloc_topology_diff_u::hwloc_topology_diff_obj_attr_s::obj_depth
unsigned obj_depth
Definition: diff.h:140
hwloc_topology_diff_u::hwloc_topology_diff_obj_attr_s::type
hwloc_topology_diff_type_t type
Definition: diff.h:137
hwloc_topology_t
struct hwloc_topology * hwloc_topology_t
Topology context.
Definition: hwloc.h:633
HWLOC_TOPOLOGY_DIFF_OBJ_ATTR_SIZE
The object local memory is modified. The union is a hwloc_topology_diff_obj_attr_u::hwloc_topology_di...
Definition: diff.h:66
hwloc_topology_diff_obj_attr_type_e
hwloc_topology_diff_obj_attr_type_e
Type of one object attribute difference.
Definition: diff.h:61
hwloc_topology_diff_t
union hwloc_topology_diff_u * hwloc_topology_diff_t
One element of a difference list between two topologies.
hwloc_topology_diff_obj_attr_u::hwloc_topology_diff_obj_attr_string_s::type
hwloc_topology_diff_obj_attr_type_t type
Definition: diff.h:100
hwloc_topology_diff_build
int hwloc_topology_diff_build(hwloc_topology_t topology, hwloc_topology_t newtopology, unsigned long flags, hwloc_topology_diff_t *diff)
Compute the difference between 2 topologies.
hwloc_topology_diff_apply_flags_e
hwloc_topology_diff_apply_flags_e
Flags to be given to hwloc_topology_diff_apply().
Definition: diff.h:197
hwloc_topology_diff_load_xmlbuffer
int hwloc_topology_diff_load_xmlbuffer(hwloc_topology_t topology, const char *xmlbuffer, int buflen, hwloc_topology_diff_t *diff, char **refname)
Load a list of topology differences from a XML buffer.
hwloc_topology_diff_u::hwloc_topology_diff_generic_s::next
union hwloc_topology_diff_u * next
Definition: diff.h:132
hwloc_topology_diff_obj_attr_u::hwloc_topology_diff_obj_attr_string_s::oldvalue
char * oldvalue
Definition: diff.h:102
hwloc_topology_diff_obj_attr_u::uint64
struct hwloc_topology_diff_obj_attr_u::hwloc_topology_diff_obj_attr_uint64_s uint64
HWLOC_TOPOLOGY_DIFF_APPLY_REVERSE
Apply topology diff in reverse direction.
Definition: diff.h:201
hwloc_topology_diff_type_t
enum hwloc_topology_diff_type_e hwloc_topology_diff_type_t
Type of one element of a difference list.
HWLOC_TOPOLOGY_DIFF_OBJ_ATTR_NAME
The object name is modified. The union is a hwloc_topology_diff_obj_attr_u::hwloc_topology_diff_obj_a...
Definition: diff.h:73
hwloc_topology_diff_obj_attr_u::hwloc_topology_diff_obj_attr_uint64_s::type
hwloc_topology_diff_obj_attr_type_t type
Definition: diff.h:91
hwloc_topology_diff_u::hwloc_topology_diff_too_complex_s::obj_index
unsigned obj_index
Definition: diff.h:151
hwloc_topology_diff_obj_attr_u::hwloc_topology_diff_obj_attr_generic_s
Definition: diff.h:83
HWLOC_TOPOLOGY_DIFF_TOO_COMPLEX
The difference is too complex, it cannot be represented. The difference below this object has not bee...
Definition: diff.h:123
hwloc_topology_diff_u::hwloc_topology_diff_too_complex_s::type
hwloc_topology_diff_type_t type
Definition: diff.h:147
hwloc_topology_diff_u::hwloc_topology_diff_obj_attr_s
Definition: diff.h:136
hwloc_topology_diff_obj_attr_u::hwloc_topology_diff_obj_attr_generic_s::type
hwloc_topology_diff_obj_attr_type_t type
Definition: diff.h:85
hwloc_topology_diff_export_xmlbuffer
int hwloc_topology_diff_export_xmlbuffer(hwloc_topology_t topology, hwloc_topology_diff_t diff, const char *refname, char **xmlbuffer, int *buflen)
Export a list of topology differences to a XML buffer.
hwloc_topology_diff_obj_attr_u::hwloc_topology_diff_obj_attr_string_s
String attribute modification with an optional name.
Definition: diff.h:98
hwloc_topology_diff_obj_attr_u::hwloc_topology_diff_obj_attr_uint64_s::newvalue
hwloc_uint64_t newvalue
Definition: diff.h:94
hwloc_topology_diff_destroy
int hwloc_topology_diff_destroy(hwloc_topology_t topology, hwloc_topology_diff_t diff)
Destroy a list of topology differences.
hwloc_topology_diff_obj_attr_u::hwloc_topology_diff_obj_attr_uint64_s::index
hwloc_uint64_t index
Definition: diff.h:92
HWLOC_TOPOLOGY_DIFF_OBJ_ATTR
An object attribute was changed. The union is a hwloc_topology_diff_obj_attr_u::hwloc_topology_diff_o...
Definition: diff.h:114