/usr/share/doc/libhwloc-doc/html/a00097.html is in libhwloc-doc 1.8-1ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>Hardware Locality (hwloc): Topology differences</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Hardware Locality (hwloc)
 <span id="projectnumber">1.8</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
</ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> |
<a href="#typedef-members">Typedefs</a> |
<a href="#enum-members">Enumerations</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Topology differences</div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">union  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00049.html">hwloc_topology_diff_obj_attr_u</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">union  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00052.html">hwloc_topology_diff_u</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:ga5f2dd099de2cacdc0d0d4858154b971a"><td class="memItemLeft" align="right" valign="top">typedef enum <br class="typebreak"/>
<a class="el" href="a00097.html#ga86f044210b0a9e9fa83acbdbbf7e05fd">hwloc_topology_diff_obj_attr_type_e</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00097.html#ga5f2dd099de2cacdc0d0d4858154b971a">hwloc_topology_diff_obj_attr_type_t</a></td></tr>
<tr class="separator:ga5f2dd099de2cacdc0d0d4858154b971a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga4b86adb00c8b2d09ebc4ef8f3bfd92b2"><td class="memItemLeft" align="right" valign="top">typedef enum <br class="typebreak"/>
<a class="el" href="a00097.html#ga38b28b7423b85a3321e6d0062d5f83d0">hwloc_topology_diff_type_e</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00097.html#ga4b86adb00c8b2d09ebc4ef8f3bfd92b2">hwloc_topology_diff_type_t</a></td></tr>
<tr class="separator:ga4b86adb00c8b2d09ebc4ef8f3bfd92b2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga2cf1b17332fe5d95f2198f6340cfd288"><td class="memItemLeft" align="right" valign="top">typedef union <br class="typebreak"/>
<a class="el" href="a00052.html">hwloc_topology_diff_u</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00097.html#ga2cf1b17332fe5d95f2198f6340cfd288">hwloc_topology_diff_t</a></td></tr>
<tr class="separator:ga2cf1b17332fe5d95f2198f6340cfd288"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:ga86f044210b0a9e9fa83acbdbbf7e05fd"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00097.html#ga86f044210b0a9e9fa83acbdbbf7e05fd">hwloc_topology_diff_obj_attr_type_e</a> { <a class="el" href="a00097.html#gga86f044210b0a9e9fa83acbdbbf7e05fdabc7f0c7ed0b6864e902f4b70f2c7bc94">HWLOC_TOPOLOGY_DIFF_OBJ_ATTR_SIZE</a>,
<a class="el" href="a00097.html#gga86f044210b0a9e9fa83acbdbbf7e05fda94a8f37c51d62d15ac6192665dd49310">HWLOC_TOPOLOGY_DIFF_OBJ_ATTR_NAME</a>,
<a class="el" href="a00097.html#gga86f044210b0a9e9fa83acbdbbf7e05fda63430bf932434bc456282f636d39c2c2">HWLOC_TOPOLOGY_DIFF_OBJ_ATTR_INFO</a>
}</td></tr>
<tr class="separator:ga86f044210b0a9e9fa83acbdbbf7e05fd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga38b28b7423b85a3321e6d0062d5f83d0"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00097.html#ga38b28b7423b85a3321e6d0062d5f83d0">hwloc_topology_diff_type_e</a> { <a class="el" href="a00097.html#gga38b28b7423b85a3321e6d0062d5f83d0accbcaee230f79989debb284c8626f0c0">HWLOC_TOPOLOGY_DIFF_OBJ_ATTR</a>,
<a class="el" href="a00097.html#gga38b28b7423b85a3321e6d0062d5f83d0a3dc01fdeff355efe3fb2516bb454a147">HWLOC_TOPOLOGY_DIFF_TOO_COMPLEX</a>
}</td></tr>
<tr class="separator:ga38b28b7423b85a3321e6d0062d5f83d0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gada4c1273ce020afaf02b649496f7edf5"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00097.html#gada4c1273ce020afaf02b649496f7edf5">hwloc_topology_diff_apply_flags_e</a> { <a class="el" href="a00097.html#ggada4c1273ce020afaf02b649496f7edf5a821a160512d67ea0dd05dab873d2fc54">HWLOC_TOPOLOGY_DIFF_APPLY_REVERSE</a>
}</td></tr>
<tr class="separator:gada4c1273ce020afaf02b649496f7edf5"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gac462f2f7c272aaf969a3ba8d161dd926"><td class="memItemLeft" align="right" valign="top"> int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00097.html#gac462f2f7c272aaf969a3ba8d161dd926">hwloc_topology_diff_build</a> (<a class="el" href="a00077.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a> topology, <a class="el" href="a00077.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a> newtopology, unsigned long flags, <a class="el" href="a00097.html#ga2cf1b17332fe5d95f2198f6340cfd288">hwloc_topology_diff_t</a> *diff)</td></tr>
<tr class="separator:gac462f2f7c272aaf969a3ba8d161dd926"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaba97b23dfdb50ef20c116975720db64c"><td class="memItemLeft" align="right" valign="top"> int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00097.html#gaba97b23dfdb50ef20c116975720db64c">hwloc_topology_diff_apply</a> (<a class="el" href="a00077.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a> topology, <a class="el" href="a00097.html#ga2cf1b17332fe5d95f2198f6340cfd288">hwloc_topology_diff_t</a> diff, unsigned long flags)</td></tr>
<tr class="separator:gaba97b23dfdb50ef20c116975720db64c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gadf553487ce19619fe4afb7161aa07bbd"><td class="memItemLeft" align="right" valign="top"> int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00097.html#gadf553487ce19619fe4afb7161aa07bbd">hwloc_topology_diff_destroy</a> (<a class="el" href="a00077.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a> topology, <a class="el" href="a00097.html#ga2cf1b17332fe5d95f2198f6340cfd288">hwloc_topology_diff_t</a> diff)</td></tr>
<tr class="separator:gadf553487ce19619fe4afb7161aa07bbd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga4d1e8ed4ad49d611e69fcd7bede1be1f"><td class="memItemLeft" align="right" valign="top"> int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00097.html#ga4d1e8ed4ad49d611e69fcd7bede1be1f">hwloc_topology_diff_load_xml</a> (<a class="el" href="a00077.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a> topology, const char *xmlpath, <a class="el" href="a00097.html#ga2cf1b17332fe5d95f2198f6340cfd288">hwloc_topology_diff_t</a> *diff, char **refname)</td></tr>
<tr class="separator:ga4d1e8ed4ad49d611e69fcd7bede1be1f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga38c6f4552990d983e49e4a00c8ebd104"><td class="memItemLeft" align="right" valign="top"> int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00097.html#ga38c6f4552990d983e49e4a00c8ebd104">hwloc_topology_diff_export_xml</a> (<a class="el" href="a00077.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a> topology, <a class="el" href="a00097.html#ga2cf1b17332fe5d95f2198f6340cfd288">hwloc_topology_diff_t</a> diff, const char *refname, const char *xmlpath)</td></tr>
<tr class="separator:ga38c6f4552990d983e49e4a00c8ebd104"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaac31b1a4b474f7ea08768ffdb1930c02"><td class="memItemLeft" align="right" valign="top"> int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00097.html#gaac31b1a4b474f7ea08768ffdb1930c02">hwloc_topology_diff_load_xmlbuffer</a> (<a class="el" href="a00077.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a> topology, const char *xmlbuffer, int buflen, <a class="el" href="a00097.html#ga2cf1b17332fe5d95f2198f6340cfd288">hwloc_topology_diff_t</a> *diff, char **refname)</td></tr>
<tr class="separator:gaac31b1a4b474f7ea08768ffdb1930c02"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga7ad9c978cea275dbea48d50c4fe7b45c"><td class="memItemLeft" align="right" valign="top"> int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00097.html#ga7ad9c978cea275dbea48d50c4fe7b45c">hwloc_topology_diff_export_xmlbuffer</a> (<a class="el" href="a00077.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a> topology, <a class="el" href="a00097.html#ga2cf1b17332fe5d95f2198f6340cfd288">hwloc_topology_diff_t</a> diff, const char *refname, char **xmlbuffer, int *buflen)</td></tr>
<tr class="separator:ga7ad9c978cea275dbea48d50c4fe7b45c"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Applications that manipulate many similar topologies, for instance one for each node of a homogeneous cluster, may want to compress topologies to reduce the memory footprint.</p>
<p>This file offers a way to manipulate the difference between topologies and export/import it to/from XML. Compression may therefore be achieved by storing one topology entirely while the others are only described by their differences with the former. The actual topology can be reconstructed when actually needed by applying the precomputed difference to the reference topology.</p>
<p>This interface targets very similar nodes. Only very simple differences between topologies are actually supported, for instance a change in the memory size, the name of the object, or some info attribute. More complex differences such as adding or removing objects cannot be represented in the difference structures and therefore return errors. </p>
<h2 class="groupheader">Typedef Documentation</h2>
<a class="anchor" id="ga5f2dd099de2cacdc0d0d4858154b971a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef enum <a class="el" href="a00097.html#ga86f044210b0a9e9fa83acbdbbf7e05fd">hwloc_topology_diff_obj_attr_type_e</a> <a class="el" href="a00097.html#ga5f2dd099de2cacdc0d0d4858154b971a">hwloc_topology_diff_obj_attr_type_t</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Type of one object attribute difference. </p>
</div>
</div>
<a class="anchor" id="ga2cf1b17332fe5d95f2198f6340cfd288"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef union <a class="el" href="a00052.html">hwloc_topology_diff_u</a> * <a class="el" href="a00097.html#ga2cf1b17332fe5d95f2198f6340cfd288">hwloc_topology_diff_t</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>One element of a difference list between two topologies. </p>
</div>
</div>
<a class="anchor" id="ga4b86adb00c8b2d09ebc4ef8f3bfd92b2"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef enum <a class="el" href="a00097.html#ga38b28b7423b85a3321e6d0062d5f83d0">hwloc_topology_diff_type_e</a> <a class="el" href="a00097.html#ga4b86adb00c8b2d09ebc4ef8f3bfd92b2">hwloc_topology_diff_type_t</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Type of one element of a difference list. </p>
</div>
</div>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a class="anchor" id="gada4c1273ce020afaf02b649496f7edf5"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="a00097.html#gada4c1273ce020afaf02b649496f7edf5">hwloc_topology_diff_apply_flags_e</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Flags to be given to <a class="el" href="a00097.html#gaba97b23dfdb50ef20c116975720db64c" title="Apply a topology diff to an existing topology. ">hwloc_topology_diff_apply()</a>. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="ggada4c1273ce020afaf02b649496f7edf5a821a160512d67ea0dd05dab873d2fc54"></a>HWLOC_TOPOLOGY_DIFF_APPLY_REVERSE</em> </td><td class="fielddoc">
<p>Apply topology diff in reverse direction. </p>
</td></tr>
</table>
</div>
</div>
<a class="anchor" id="ga86f044210b0a9e9fa83acbdbbf7e05fd"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="a00097.html#ga86f044210b0a9e9fa83acbdbbf7e05fd">hwloc_topology_diff_obj_attr_type_e</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Type of one object attribute difference. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="gga86f044210b0a9e9fa83acbdbbf7e05fdabc7f0c7ed0b6864e902f4b70f2c7bc94"></a>HWLOC_TOPOLOGY_DIFF_OBJ_ATTR_SIZE</em> </td><td class="fielddoc">
<p>The object local memory is modified. The union is a hwloc_topology_diff_obj_attr_uint64_s (and the index field is ignored). </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="gga86f044210b0a9e9fa83acbdbbf7e05fda94a8f37c51d62d15ac6192665dd49310"></a>HWLOC_TOPOLOGY_DIFF_OBJ_ATTR_NAME</em> </td><td class="fielddoc">
<p>The object name is modified. The union is a hwloc_topology_diff_obj_attr_string_s (and the name field is ignored). </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="gga86f044210b0a9e9fa83acbdbbf7e05fda63430bf932434bc456282f636d39c2c2"></a>HWLOC_TOPOLOGY_DIFF_OBJ_ATTR_INFO</em> </td><td class="fielddoc">
<p>the value of an info attribute is modified. The union is a hwloc_topology_diff_obj_attr_string_s. </p>
</td></tr>
</table>
</div>
</div>
<a class="anchor" id="ga38b28b7423b85a3321e6d0062d5f83d0"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="a00097.html#ga38b28b7423b85a3321e6d0062d5f83d0">hwloc_topology_diff_type_e</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Type of one element of a difference list. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="gga38b28b7423b85a3321e6d0062d5f83d0accbcaee230f79989debb284c8626f0c0"></a>HWLOC_TOPOLOGY_DIFF_OBJ_ATTR</em> </td><td class="fielddoc">
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="gga38b28b7423b85a3321e6d0062d5f83d0a3dc01fdeff355efe3fb2516bb454a147"></a>HWLOC_TOPOLOGY_DIFF_TOO_COMPLEX</em> </td><td class="fielddoc">
</td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="gaba97b23dfdb50ef20c116975720db64c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"> int hwloc_topology_diff_apply </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00077.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a> </td>
<td class="paramname"><em>topology</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="a00097.html#ga2cf1b17332fe5d95f2198f6340cfd288">hwloc_topology_diff_t</a> </td>
<td class="paramname"><em>diff</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned long </td>
<td class="paramname"><em>flags</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Apply a topology diff to an existing topology. </p>
<p><code>flags</code> is an OR'ed set of hwloc_topology_diff_apply_flags_e.</p>
<p>The new topology is modified in place. <a class="el" href="a00083.html#gaad1fc9486d7aa710bd2ce06a49c35fef" title="Duplicate a topology. ">hwloc_topology_dup()</a> may be used to duplicate before patching.</p>
<p>If the difference cannot be applied entirely, all previous applied portions are unapplied before returning.</p>
<dl class="section return"><dt>Returns</dt><dd>0 on success.</dd>
<dd>
-N if applying the difference failed while trying to apply the N-th part of the difference. For instance -1 is returned if the very first difference portion could not be applied. </dd></dl>
</div>
</div>
<a class="anchor" id="gac462f2f7c272aaf969a3ba8d161dd926"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"> int hwloc_topology_diff_build </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00077.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a> </td>
<td class="paramname"><em>topology</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="a00077.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a> </td>
<td class="paramname"><em>newtopology</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned long </td>
<td class="paramname"><em>flags</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="a00097.html#ga2cf1b17332fe5d95f2198f6340cfd288">hwloc_topology_diff_t</a> * </td>
<td class="paramname"><em>diff</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Compute the difference between 2 topologies. </p>
<p>The difference is stored as a list of hwloc_topology_diff_t entries starting at <code>diff</code>. It is computed by doing a depth-first traversal of both topology trees simultaneously.</p>
<p>If the difference between 2 objects is too complex to be represented (for instance if some objects are added or removed), a special diff entry of type HWLOC_TOPOLOGY_DIFF_TOO_COMPLEX is queued. The computation of the diff does not continue under these objects. So each such diff entry means that the difference between two subtrees could not be computed.</p>
<dl class="section return"><dt>Returns</dt><dd>0 if the difference can be represented properly.</dd>
<dd>
0 with <code>diff</code> pointing NULL if there is no difference between the topologies.</dd>
<dd>
1 if the difference is too complex (for instance if some objects are added or removed), some entries in the list will be of type HWLOC_TOPOLOGY_DIFF_TOO_COMPLEX and 1 is returned.</dd>
<dd>
-1 on any other error.</dd></dl>
<dl class="section note"><dt>Note</dt><dd><code>flags</code> is currently not used. It should be 0.</dd>
<dd>
The output diff has to be freed with <a class="el" href="a00097.html#gadf553487ce19619fe4afb7161aa07bbd" title="Destroy a list of topology differences. ">hwloc_topology_diff_destroy()</a>.</dd>
<dd>
The output diff can only be exported to XML or passed to <a class="el" href="a00097.html#gaba97b23dfdb50ef20c116975720db64c" title="Apply a topology diff to an existing topology. ">hwloc_topology_diff_apply()</a> if 0 was returned, i.e. if no entry of type HWLOC_TOPOLOGY_DIFF_TOO_COMPLEX is listed.</dd>
<dd>
The output diff may be modified by removing some entries from the list. The removed entries should be freed by passing them as a list to <a class="el" href="a00097.html#gadf553487ce19619fe4afb7161aa07bbd" title="Destroy a list of topology differences. ">hwloc_topology_diff_destroy()</a>. </dd></dl>
</div>
</div>
<a class="anchor" id="gadf553487ce19619fe4afb7161aa07bbd"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"> int hwloc_topology_diff_destroy </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00077.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a> </td>
<td class="paramname"><em>topology</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="a00097.html#ga2cf1b17332fe5d95f2198f6340cfd288">hwloc_topology_diff_t</a> </td>
<td class="paramname"><em>diff</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Destroy a list of topology differences. </p>
<dl class="section note"><dt>Note</dt><dd>The <code>topology</code> parameter must be a valid topology but it is not required that it is related to <code>diff</code>. </dd></dl>
</div>
</div>
<a class="anchor" id="ga38c6f4552990d983e49e4a00c8ebd104"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"> int hwloc_topology_diff_export_xml </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00077.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a> </td>
<td class="paramname"><em>topology</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="a00097.html#ga2cf1b17332fe5d95f2198f6340cfd288">hwloc_topology_diff_t</a> </td>
<td class="paramname"><em>diff</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>refname</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>xmlpath</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Export a list of topology differences to a XML file. </p>
<p>If not <code>NULL</code>, <code>refname</code> defines an identifier string for the reference topology which was used as a base when computing this difference. This identifier is usually the name of the other XML file that contains the reference topology. This attribute is given back when reading the diff from XML.</p>
<dl class="section note"><dt>Note</dt><dd>The <code>topology</code> parameter must be a valid topology but it is not required that it is related to <code>diff</code>. </dd></dl>
</div>
</div>
<a class="anchor" id="ga7ad9c978cea275dbea48d50c4fe7b45c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"> int hwloc_topology_diff_export_xmlbuffer </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00077.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a> </td>
<td class="paramname"><em>topology</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="a00097.html#ga2cf1b17332fe5d95f2198f6340cfd288">hwloc_topology_diff_t</a> </td>
<td class="paramname"><em>diff</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>refname</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char ** </td>
<td class="paramname"><em>xmlbuffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int * </td>
<td class="paramname"><em>buflen</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Export a list of topology differences to a XML buffer. </p>
<p>If not <code>NULL</code>, <code>refname</code> defines an identifier string for the reference topology which was used as a base when computing this difference. This identifier is usually the name of the other XML file that contains the reference topology. This attribute is given back when reading the diff from XML.</p>
<dl class="section note"><dt>Note</dt><dd>The XML buffer should later be freed with <a class="el" href="a00085.html#ga5e375acef034bebc1f20ead884697301" title="Free a buffer allocated by hwloc_topology_export_xmlbuffer() ">hwloc_free_xmlbuffer()</a>.</dd>
<dd>
The <code>topology</code> parameter must be a valid topology but it is not required that it is related to <code>diff</code>. </dd></dl>
</div>
</div>
<a class="anchor" id="ga4d1e8ed4ad49d611e69fcd7bede1be1f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"> int hwloc_topology_diff_load_xml </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00077.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a> </td>
<td class="paramname"><em>topology</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>xmlpath</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="a00097.html#ga2cf1b17332fe5d95f2198f6340cfd288">hwloc_topology_diff_t</a> * </td>
<td class="paramname"><em>diff</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char ** </td>
<td class="paramname"><em>refname</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Load a list of topology differences from a XML file. </p>
<p>If not <code>NULL</code>, <code>refname</code> will be filled with the identifier string of the reference topology for the difference file, if any was specified in the XML file. This identifier is usually the name of the other XML file that contains the reference topology.</p>
<dl class="section note"><dt>Note</dt><dd>The <code>topology</code> parameter must be a valid topology but it is not required that it is related to <code>diff</code>.</dd>
<dd>
the pointer returned in refname should later be freed by the caller. </dd></dl>
</div>
</div>
<a class="anchor" id="gaac31b1a4b474f7ea08768ffdb1930c02"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"> int hwloc_topology_diff_load_xmlbuffer </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00077.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a> </td>
<td class="paramname"><em>topology</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>xmlbuffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>buflen</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="a00097.html#ga2cf1b17332fe5d95f2198f6340cfd288">hwloc_topology_diff_t</a> * </td>
<td class="paramname"><em>diff</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char ** </td>
<td class="paramname"><em>refname</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Load a list of topology differences from a XML buffer. </p>
<p>If not <code>NULL</code>, <code>refname</code> will be filled with the identifier string of the reference topology for the difference file, if any was specified in the XML file. This identifier is usually the name of the other XML file that contains the reference topology.</p>
<dl class="section note"><dt>Note</dt><dd>The <code>topology</code> parameter must be a valid topology but it is not required that it is related to <code>diff</code>.</dd>
<dd>
the pointer returned in refname should later be freed by the caller. </dd></dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sun Dec 15 2013 16:14:34 for Hardware Locality (hwloc) by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.5
</small></address>
</body>
</html>
|