Open MPI logo

Portable Hardware Locality (hwloc) Documentation: v1.9

  |   Home   |   Support   |   FAQ   |  
diff.h
1 /*
2  * Copyright © 2013-2014 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 
66 
78 
83  /* each part of the union must start with these */
85  } generic;
86 
89  /* used for storing integer attributes */
91  hwloc_uint64_t index; /* not used for SIZE */
92  hwloc_uint64_t oldvalue;
93  hwloc_uint64_t newvalue;
94  } uint64;
95 
98  /* used for storing name and info pairs */
100  char *name; /* not used for NAME */
101  char *oldvalue;
102  char *newvalue;
103  } string;
104 };
105 
106 
110  /*< \brief An object attribute was changed.
111  * The union is a hwloc_topology_diff_obj_attr_s.
112  */
114 
115  /*< \brief The difference is too complex,
116  * it cannot be represented. The difference below
117  * this object has not been checked.
118  * hwloc_topology_diff_build() will return 1.
119  *
120  * The union is a hwloc_topology_diff_too_complex_s.
121  */
124 
127 typedef union hwloc_topology_diff_u {
129  /* each part of the union must start with these */
131  union hwloc_topology_diff_u * next; /* pointer to the next element of the list, or NULL */
132  } generic;
133 
134  /* A difference in an object attribute. */
136  hwloc_topology_diff_type_t type; /* must be HWLOC_TOPOLOGY_DIFF_OBJ_ATTR */
138  /* List of attribute differences for a single object */
139  unsigned obj_depth;
140  unsigned obj_index;
142  } obj_attr;
143 
144  /* A difference that is too complex. */
146  hwloc_topology_diff_type_t type; /* must be HWLOC_TOPOLOGY_DIFF_TOO_COMPLEX */
148  /* Where we had to stop computing the diff in the first topology */
149  unsigned obj_depth;
150  unsigned obj_index;
151  } too_complex;
153 
154 
192 HWLOC_DECLSPEC int hwloc_topology_diff_build(hwloc_topology_t topology, hwloc_topology_t newtopology, unsigned long flags, hwloc_topology_diff_t *diff);
193 
201 };
202 
220 HWLOC_DECLSPEC int hwloc_topology_diff_apply(hwloc_topology_t topology, hwloc_topology_diff_t diff, unsigned long flags);
221 
227 HWLOC_DECLSPEC int hwloc_topology_diff_destroy(hwloc_topology_t topology, hwloc_topology_diff_t diff);
228 
243 HWLOC_DECLSPEC int hwloc_topology_diff_load_xml(hwloc_topology_t topology, const char *xmlpath, hwloc_topology_diff_t *diff, char **refname);
244 
257 HWLOC_DECLSPEC int hwloc_topology_diff_export_xml(hwloc_topology_t topology, hwloc_topology_diff_t diff, const char *refname, const char *xmlpath);
258 
273 HWLOC_DECLSPEC int hwloc_topology_diff_load_xmlbuffer(hwloc_topology_t topology, const char *xmlbuffer, int buflen, hwloc_topology_diff_t *diff, char **refname);
274 
289 HWLOC_DECLSPEC int hwloc_topology_diff_export_xmlbuffer(hwloc_topology_t topology, hwloc_topology_diff_t diff, const char *refname, char **xmlbuffer, int *buflen);
290 
294 #ifdef __cplusplus
295 } /* extern "C" */
296 #endif
297 
298 
299 #endif /* HWLOC_HELPER_H */
Integer attribute modification with an optional index.
Definition: diff.h:88
union hwloc_topology_diff_u * hwloc_topology_diff_t
One element of a difference list between two topologies.
hwloc_topology_diff_type_e
Type of one element of a difference list.
Definition: diff.h:109
union hwloc_topology_diff_u * next
Definition: diff.h:131
struct hwloc_topology_diff_obj_attr_u::hwloc_topology_diff_obj_attr_uint64_s uint64
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.
The object local memory is modified. The union is a hwloc_topology_diff_obj_attr_uint64_s (and the in...
Definition: diff.h:65
hwloc_topology_diff_type_t type
Definition: diff.h:130
String attribute modification with an optional name.
Definition: diff.h:97
Apply topology diff in reverse direction.
Definition: diff.h:200
hwloc_topology_diff_obj_attr_type_t type
Definition: diff.h:84
union hwloc_topology_diff_u * next
Definition: diff.h:147
hwloc_topology_diff_obj_attr_type_t type
Definition: diff.h:99
Definition: diff.h:113
struct hwloc_topology_diff_obj_attr_u::hwloc_topology_diff_obj_attr_string_s string
hwloc_topology_diff_apply_flags_e
Flags to be given to hwloc_topology_diff_apply().
Definition: diff.h:196
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.
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.
One element of a difference list between two topologies.
Definition: diff.h:127
hwloc_topology_diff_type_t type
Definition: diff.h:136
Definition: diff.h:122
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
Type of one object attribute difference.
Definition: diff.h:60
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.
the value of an info attribute is modified. The union is a hwloc_topology_diff_obj_attr_string_s.
Definition: diff.h:76
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_obj_attr_type_t type
Definition: diff.h:90
One object attribute difference.
Definition: diff.h:81
enum hwloc_topology_diff_obj_attr_type_e hwloc_topology_diff_obj_attr_type_t
Type of one object attribute difference.
int hwloc_topology_diff_destroy(hwloc_topology_t topology, hwloc_topology_diff_t diff)
Destroy a list of topology differences.
struct hwloc_topology * hwloc_topology_t
Topology context.
Definition: hwloc.h:577
The object name is modified. The union is a hwloc_topology_diff_obj_attr_string_s (and the name field...
Definition: diff.h:72
union hwloc_topology_diff_u * next
Definition: diff.h:137
hwloc_topology_diff_type_t type
Definition: diff.h:146
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.