Hardware Locality (hwloc) 2.11.2

diff.h
1/*
2 * Copyright © 2013-2023 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
62 typedef enum hwloc_topology_diff_obj_attr_type_e {
67 HWLOC_TOPOLOGY_DIFF_OBJ_ATTR_SIZE,
68
74 HWLOC_TOPOLOGY_DIFF_OBJ_ATTR_NAME,
78 HWLOC_TOPOLOGY_DIFF_OBJ_ATTR_INFO
79} hwloc_topology_diff_obj_attr_type_t;
80
83 union hwloc_topology_diff_obj_attr_u {
84 struct hwloc_topology_diff_obj_attr_generic_s {
85 /* each part of the union must start with these */
86 hwloc_topology_diff_obj_attr_type_t type;
87 } generic;
88
90 struct hwloc_topology_diff_obj_attr_uint64_s {
91 /* used for storing integer attributes */
92 hwloc_topology_diff_obj_attr_type_t type;
93 hwloc_uint64_t index; /* not used for SIZE */
94 hwloc_uint64_t oldvalue;
95 hwloc_uint64_t newvalue;
96 } uint64;
97
99 struct hwloc_topology_diff_obj_attr_string_s {
100 /* used for storing name and info pairs */
101 hwloc_topology_diff_obj_attr_type_t type;
102 char *name; /* not used for NAME */
103 char *oldvalue;
104 char *newvalue;
105 } string;
106};
107
108
111 typedef enum hwloc_topology_diff_type_e {
115 HWLOC_TOPOLOGY_DIFF_OBJ_ATTR,
116
124 HWLOC_TOPOLOGY_DIFF_TOO_COMPLEX
125} hwloc_topology_diff_type_t;
126
129 typedef union hwloc_topology_diff_u {
130 struct hwloc_topology_diff_generic_s {
131 /* each part of the union must start with these */
132 hwloc_topology_diff_type_t type;
133 union hwloc_topology_diff_u * next; /* pointer to the next element of the list, or NULL */
134 } generic;
135
136 /* A difference in an object attribute. */
137 struct hwloc_topology_diff_obj_attr_s {
138 hwloc_topology_diff_type_t type; /* must be ::HWLOC_TOPOLOGY_DIFF_OBJ_ATTR */
139 union hwloc_topology_diff_u * next;
140 /* List of attribute differences for a single object */
141 int obj_depth;
142 unsigned obj_index;
143 union hwloc_topology_diff_obj_attr_u diff;
144 } obj_attr;
145
146 /* A difference that is too complex. */
147 struct hwloc_topology_diff_too_complex_s {
148 hwloc_topology_diff_type_t type; /* must be ::HWLOC_TOPOLOGY_DIFF_TOO_COMPLEX */
149 union hwloc_topology_diff_u * next;
150 /* Where we had to stop computing the diff in the first topology */
151 int obj_depth;
152 unsigned obj_index;
153 } too_complex;
154} * hwloc_topology_diff_t;
155
156
194HWLOC_DECLSPEC int hwloc_topology_diff_build(hwloc_topology_t topology, hwloc_topology_t newtopology, unsigned long flags, hwloc_topology_diff_t *diff);
195
198 enum hwloc_topology_diff_apply_flags_e {
202 HWLOC_TOPOLOGY_DIFF_APPLY_REVERSE = (1UL<<0)
203};
204
222HWLOC_DECLSPEC int hwloc_topology_diff_apply(hwloc_topology_t topology, hwloc_topology_diff_t diff, unsigned long flags);
223
228HWLOC_DECLSPEC int hwloc_topology_diff_destroy(hwloc_topology_diff_t diff);
229
243HWLOC_DECLSPEC int hwloc_topology_diff_load_xml(const char *xmlpath, hwloc_topology_diff_t *diff, char **refname);
244
256HWLOC_DECLSPEC int hwloc_topology_diff_export_xml(hwloc_topology_diff_t diff, const char *refname, const char *xmlpath);
257
276HWLOC_DECLSPEC int hwloc_topology_diff_load_xmlbuffer(const char *xmlbuffer, int buflen, hwloc_topology_diff_t *diff, char **refname);
277
294HWLOC_DECLSPEC int hwloc_topology_diff_export_xmlbuffer(hwloc_topology_diff_t diff, const char *refname, char **xmlbuffer, int *buflen);
295
299#ifdef __cplusplus
300} /* extern "C" */
301#endif
302
303
304#endif /* HWLOC_DIFF_H */
hwloc_topology_t
struct hwloc_topology * hwloc_topology_t
Topology context.
Definition hwloc.h:742
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_load_xml
int hwloc_topology_diff_load_xml(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:111
hwloc_topology_diff_destroy
int hwloc_topology_diff_destroy(hwloc_topology_diff_t diff)
Destroy a list of topology differences.
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_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_type_e
hwloc_topology_diff_obj_attr_type_e
Type of one object attribute difference.
Definition diff.h:62
hwloc_topology_diff_export_xml
int hwloc_topology_diff_export_xml(hwloc_topology_diff_t diff, const char *refname, const char *xmlpath)
Export a list of topology differences to a XML file.
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_export_xmlbuffer
int hwloc_topology_diff_export_xmlbuffer(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_load_xmlbuffer
int hwloc_topology_diff_load_xmlbuffer(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_apply_flags_e
hwloc_topology_diff_apply_flags_e
Flags to be given to hwloc_topology_diff_apply().
Definition diff.h:198
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_TOO_COMPLEX
@ 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:124
HWLOC_TOPOLOGY_DIFF_OBJ_ATTR
@ HWLOC_TOPOLOGY_DIFF_OBJ_ATTR
An object attribute was changed. The union is a hwloc_topology_diff_u::hwloc_topology_diff_obj_attr_s...
Definition diff.h:115
HWLOC_TOPOLOGY_DIFF_OBJ_ATTR_INFO
@ 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:78
HWLOC_TOPOLOGY_DIFF_OBJ_ATTR_NAME
@ 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:74
HWLOC_TOPOLOGY_DIFF_OBJ_ATTR_SIZE
@ 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:67
HWLOC_TOPOLOGY_DIFF_APPLY_REVERSE
@ HWLOC_TOPOLOGY_DIFF_APPLY_REVERSE
Apply topology diff in reverse direction.
Definition diff.h:202
hwloc_topology_diff_obj_attr_u
One object attribute difference.
Definition diff.h:83
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_obj_attr_u::uint64
struct hwloc_topology_diff_obj_attr_u::hwloc_topology_diff_obj_attr_uint64_s uint64
hwloc_topology_diff_obj_attr_u::hwloc_topology_diff_obj_attr_generic_s
Definition diff.h:84
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:86
hwloc_topology_diff_obj_attr_u::hwloc_topology_diff_obj_attr_uint64_s
Integer attribute modification with an optional index.
Definition diff.h:90
hwloc_topology_diff_obj_attr_u::hwloc_topology_diff_obj_attr_uint64_s::oldvalue
hwloc_uint64_t oldvalue
Definition diff.h:94
hwloc_topology_diff_obj_attr_u::hwloc_topology_diff_obj_attr_uint64_s::index
hwloc_uint64_t index
Definition diff.h:93
hwloc_topology_diff_obj_attr_u::hwloc_topology_diff_obj_attr_uint64_s::newvalue
hwloc_uint64_t newvalue
Definition diff.h:95
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:92
hwloc_topology_diff_obj_attr_u::hwloc_topology_diff_obj_attr_string_s
String attribute modification with an optional name.
Definition diff.h:99
hwloc_topology_diff_obj_attr_u::hwloc_topology_diff_obj_attr_string_s::oldvalue
char * oldvalue
Definition diff.h:103
hwloc_topology_diff_obj_attr_u::hwloc_topology_diff_obj_attr_string_s::newvalue
char * newvalue
Definition diff.h:104
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:101
hwloc_topology_diff_obj_attr_u::hwloc_topology_diff_obj_attr_string_s::name
char * name
Definition diff.h:102
hwloc_topology_diff_u
One element of a difference list between two topologies.
Definition diff.h:129
hwloc_topology_diff_u::hwloc_topology_diff_generic_s
Definition diff.h:130
hwloc_topology_diff_u::hwloc_topology_diff_generic_s::type
hwloc_topology_diff_type_t type
Definition diff.h:132
hwloc_topology_diff_u::hwloc_topology_diff_generic_s::next
union hwloc_topology_diff_u * next
Definition diff.h:133
hwloc_topology_diff_u::hwloc_topology_diff_obj_attr_s
Definition diff.h:137
hwloc_topology_diff_u::hwloc_topology_diff_obj_attr_s::type
hwloc_topology_diff_type_t type
Definition diff.h:138
hwloc_topology_diff_u::hwloc_topology_diff_obj_attr_s::obj_depth
int obj_depth
Definition diff.h:141
hwloc_topology_diff_u::hwloc_topology_diff_obj_attr_s::diff
union hwloc_topology_diff_obj_attr_u diff
Definition diff.h:143
hwloc_topology_diff_u::hwloc_topology_diff_obj_attr_s::next
union hwloc_topology_diff_u * next
Definition diff.h:139
hwloc_topology_diff_u::hwloc_topology_diff_obj_attr_s::obj_index
unsigned obj_index
Definition diff.h:142
hwloc_topology_diff_u::hwloc_topology_diff_too_complex_s
Definition diff.h:147
hwloc_topology_diff_u::hwloc_topology_diff_too_complex_s::next
union hwloc_topology_diff_u * next
Definition diff.h:149
hwloc_topology_diff_u::hwloc_topology_diff_too_complex_s::obj_index
unsigned obj_index
Definition diff.h:152
hwloc_topology_diff_u::hwloc_topology_diff_too_complex_s::type
hwloc_topology_diff_type_t type
Definition diff.h:148
hwloc_topology_diff_u::hwloc_topology_diff_too_complex_s::obj_depth
int obj_depth
Definition diff.h:151