Debian Codegraph @

doc/doxygen-doc/html/a00176.html

raw
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2 <html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
3 <head>
4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5 <meta http-equiv="X-UA-Compatible" content="IE=11"/>
6 <meta name="generator" content="Doxygen 1.15.0"/>
7 <meta name="viewport" content="width=device-width, initial-scale=1"/>
8 <title>Hardware Locality (hwloc): Topology Detection Configuration and Query</title>
9 <link href="tabs.css" rel="stylesheet" type="text/css"/>
10 <script type="text/javascript" src="jquery.js"></script>
11 <script type="text/javascript" src="dynsections.js"></script>
12 <script type="text/javascript" src="clipboard.js"></script>
13 <link href="doxygen.css" rel="stylesheet" type="text/css" />
14 </head>
15 <body>
16 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
17 <div id="titlearea">
18 <table cellspacing="0" cellpadding="0">
19 <tbody>
20 <tr id="projectrow">
21 <td id="projectalign">
22 <div id="projectname">Hardware Locality (hwloc)<span id="projectnumber">&#160;2.14.0</span>
23 </div>
24 </td>
25 </tr>
26 </tbody>
27 </table>
28 </div>
29 <!-- end header part -->
30 <!-- Generated by Doxygen 1.15.0 -->
31 <script type="text/javascript">
32 $(function() { codefold.init(); });
33 </script>
34 <script type="text/javascript" src="menudata.js"></script>
35 <script type="text/javascript" src="menu.js"></script>
36 <script type="text/javascript">
37 $(function() {
38 initMenu('',false,false,'search.php','Search',false);
39 });
40 </script>
41 <div id="main-nav"></div>
42 </div><!-- top -->
43 <div id="doc-content">
44 <div class="header">
45 <div class="summary">
46 <a href="#nested-classes">Data Structures</a> &#124;
47 <a href="#enum-members">Enumerations</a> &#124;
48 <a href="#func-members">Functions</a> </div>
49 <div class="headertitle"><div class="title">Topology Detection Configuration and Query </div></div>
50 </div><!--header-->
51 <div class="contents">
52 <table class="memberdecls">
53 <tr class="heading"><td colspan="2"><h2 id="header-nested-classes" class="groupheader"><a id="nested-classes" name="nested-classes"></a>
54 Data Structures</h2></td></tr>
55 <tr class="memitem:hwloc_5Ftopology_5Fdiscovery_5Fsupport" id="r_hwloc_5Ftopology_5Fdiscovery_5Fsupport"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00276.html">hwloc_topology_discovery_support</a></td></tr>
56 <tr class="memitem:hwloc_5Ftopology_5Fcpubind_5Fsupport" id="r_hwloc_5Ftopology_5Fcpubind_5Fsupport"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00280.html">hwloc_topology_cpubind_support</a></td></tr>
57 <tr class="memitem:hwloc_5Ftopology_5Fmembind_5Fsupport" id="r_hwloc_5Ftopology_5Fmembind_5Fsupport"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00284.html">hwloc_topology_membind_support</a></td></tr>
58 <tr class="memitem:hwloc_5Ftopology_5Fmisc_5Fsupport" id="r_hwloc_5Ftopology_5Fmisc_5Fsupport"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00288.html">hwloc_topology_misc_support</a></td></tr>
59 <tr class="memitem:hwloc_5Ftopology_5Fsupport" id="r_hwloc_5Ftopology_5Fsupport"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00292.html">hwloc_topology_support</a></td></tr>
60 </table><table class="memberdecls">
61 <tr class="heading"><td colspan="2"><h2 id="header-enum-members" class="groupheader"><a id="enum-members" name="enum-members"></a>
62 Enumerations</h2></td></tr>
63 <tr class="memitem:gada025d3ec20b4b420f8038d23d6e7bde" id="r_gada025d3ec20b4b420f8038d23d6e7bde"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#gada025d3ec20b4b420f8038d23d6e7bde">hwloc_topology_flags_e</a> { <br />
64 &#160;&#160;<a class="el" href="#ggada025d3ec20b4b420f8038d23d6e7bdea10907044bbb306fd0dc76acf046d9258">HWLOC_TOPOLOGY_FLAG_INCLUDE_DISALLOWED</a>
65 , <a class="el" href="#ggada025d3ec20b4b420f8038d23d6e7bdea6ecb6abc6a0bb75e81564f8bca85783b">HWLOC_TOPOLOGY_FLAG_IS_THISSYSTEM</a>
66 , <a class="el" href="#ggada025d3ec20b4b420f8038d23d6e7bdea1b66bbd66e900e5c837f71defb32ad89">HWLOC_TOPOLOGY_FLAG_THISSYSTEM_ALLOWED_RESOURCES</a>
67 , <a class="el" href="#ggada025d3ec20b4b420f8038d23d6e7bdead93e82b8668ee90e4f9354e201a2ed9c">HWLOC_TOPOLOGY_FLAG_IMPORT_SUPPORT</a> = (1UL&lt;&lt;3)
68 , <br />
69 &#160;&#160;<a class="el" href="#ggada025d3ec20b4b420f8038d23d6e7bdeaa595aed197779012acf43e8ca4a2658d">HWLOC_TOPOLOGY_FLAG_RESTRICT_TO_CPUBINDING</a> = (1UL&lt;&lt;4)
70 , <a class="el" href="#ggada025d3ec20b4b420f8038d23d6e7bdea368d7741135fe309f3782c59644d3caa">HWLOC_TOPOLOGY_FLAG_RESTRICT_TO_MEMBINDING</a> = (1UL&lt;&lt;5)
71 , <a class="el" href="#ggada025d3ec20b4b420f8038d23d6e7bdeae7a792e3db4360360a10f9160b10e631">HWLOC_TOPOLOGY_FLAG_DONT_CHANGE_BINDING</a> = (1UL&lt;&lt;6)
72 , <a class="el" href="#ggada025d3ec20b4b420f8038d23d6e7bdea5796b4909eba80f9727b66d07d3a7a05">HWLOC_TOPOLOGY_FLAG_NO_DISTANCES</a> = (1UL&lt;&lt;7)
73 , <br />
74 &#160;&#160;<a class="el" href="#ggada025d3ec20b4b420f8038d23d6e7bdead5636766a6603f24486f79c48899c1c3">HWLOC_TOPOLOGY_FLAG_NO_MEMATTRS</a> = (1UL&lt;&lt;8)
75 , <a class="el" href="#ggada025d3ec20b4b420f8038d23d6e7bdea3497cd4c2f8b1d842dd49b3aaae56a24">HWLOC_TOPOLOGY_FLAG_NO_CPUKINDS</a> = (1UL&lt;&lt;9)
76 <br />
77 }</td></tr>
78 <tr class="memitem:ga9a5a1f0140cd1952544477833733195b" id="r_ga9a5a1f0140cd1952544477833733195b"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ga9a5a1f0140cd1952544477833733195b">hwloc_type_filter_e</a> { <a class="el" href="#gga9a5a1f0140cd1952544477833733195bafda7b59e6810dfe778d8f9a4cc1e350e">HWLOC_TYPE_FILTER_KEEP_ALL</a>
79 , <a class="el" href="#gga9a5a1f0140cd1952544477833733195ba4f835955414de92c77d99b8419d4647a">HWLOC_TYPE_FILTER_KEEP_NONE</a>
80 , <a class="el" href="#gga9a5a1f0140cd1952544477833733195ba7664716643bf1db83e631eed34f659e4">HWLOC_TYPE_FILTER_KEEP_STRUCTURE</a>
81 , <a class="el" href="#gga9a5a1f0140cd1952544477833733195ba63fd24954e18c83ff7eae9588759adb5">HWLOC_TYPE_FILTER_KEEP_IMPORTANT</a>
82 }</td></tr>
83 </table><table class="memberdecls">
84 <tr class="heading"><td colspan="2"><h2 id="header-func-members" class="groupheader"><a id="func-members" name="func-members"></a>
85 Functions</h2></td></tr>
86 <tr class="memitem:gaaeed4df656979e5f16befea9d29b814b" id="r_gaaeed4df656979e5f16befea9d29b814b"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#gaaeed4df656979e5f16befea9d29b814b">hwloc_topology_set_flags</a> (<a class="el" href="a00169.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a> topology, unsigned long flags)</td></tr>
87 <tr class="memitem:ga09318f81c1d4713be907d64748a6f93c" id="r_ga09318f81c1d4713be907d64748a6f93c"><td class="memItemLeft" align="right" valign="top">unsigned long&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ga09318f81c1d4713be907d64748a6f93c">hwloc_topology_get_flags</a> (<a class="el" href="a00169.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a> topology)</td></tr>
88 <tr class="memitem:ga68ffdcfd9175cdf40709801092f18017" id="r_ga68ffdcfd9175cdf40709801092f18017"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ga68ffdcfd9175cdf40709801092f18017">hwloc_topology_is_thissystem</a> (<a class="el" href="a00169.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a> restrict topology)</td></tr>
89 <tr class="memitem:gac0927e93a9b962143be08a48bbff2e19" id="r_gac0927e93a9b962143be08a48bbff2e19"><td class="memItemLeft" align="right" valign="top">const struct <a class="el" href="a00292.html">hwloc_topology_support</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#gac0927e93a9b962143be08a48bbff2e19">hwloc_topology_get_support</a> (<a class="el" href="a00169.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a> restrict topology)</td></tr>
90 <tr class="memitem:gad894e70f15f8d4aada7be8d1aba38b7e" id="r_gad894e70f15f8d4aada7be8d1aba38b7e"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#gad894e70f15f8d4aada7be8d1aba38b7e">hwloc_topology_set_type_filter</a> (<a class="el" href="a00169.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a> topology, <a class="el" href="a00167.html#gacd37bb612667dc437d66bfb175a8dc55">hwloc_obj_type_t</a> type, enum <a class="el" href="#ga9a5a1f0140cd1952544477833733195b">hwloc_type_filter_e</a> filter)</td></tr>
91 <tr class="memitem:ga137ad1178f7a79f2383974d983083401" id="r_ga137ad1178f7a79f2383974d983083401"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ga137ad1178f7a79f2383974d983083401">hwloc_topology_get_type_filter</a> (<a class="el" href="a00169.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a> topology, <a class="el" href="a00167.html#gacd37bb612667dc437d66bfb175a8dc55">hwloc_obj_type_t</a> type, enum <a class="el" href="#ga9a5a1f0140cd1952544477833733195b">hwloc_type_filter_e</a> *filter)</td></tr>
92 <tr class="memitem:ga9eb8dc3b106f84921bf5789101e97e24" id="r_ga9eb8dc3b106f84921bf5789101e97e24"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ga9eb8dc3b106f84921bf5789101e97e24">hwloc_topology_set_all_types_filter</a> (<a class="el" href="a00169.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a> topology, enum <a class="el" href="#ga9a5a1f0140cd1952544477833733195b">hwloc_type_filter_e</a> filter)</td></tr>
93 <tr class="memitem:ga30bd6d330fe3c8f0cbaad724d114ee20" id="r_ga30bd6d330fe3c8f0cbaad724d114ee20"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ga30bd6d330fe3c8f0cbaad724d114ee20">hwloc_topology_set_cache_types_filter</a> (<a class="el" href="a00169.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a> topology, enum <a class="el" href="#ga9a5a1f0140cd1952544477833733195b">hwloc_type_filter_e</a> filter)</td></tr>
94 <tr class="memitem:ga37c7b2e599ed3cd76ad9164630024f30" id="r_ga37c7b2e599ed3cd76ad9164630024f30"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ga37c7b2e599ed3cd76ad9164630024f30">hwloc_topology_set_icache_types_filter</a> (<a class="el" href="a00169.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a> topology, enum <a class="el" href="#ga9a5a1f0140cd1952544477833733195b">hwloc_type_filter_e</a> filter)</td></tr>
95 <tr class="memitem:ga0ab38705357bc1203abe829da8a12ad3" id="r_ga0ab38705357bc1203abe829da8a12ad3"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ga0ab38705357bc1203abe829da8a12ad3">hwloc_topology_set_io_types_filter</a> (<a class="el" href="a00169.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a> topology, enum <a class="el" href="#ga9a5a1f0140cd1952544477833733195b">hwloc_type_filter_e</a> filter)</td></tr>
96 <tr class="memitem:ga2cc7b7b155cba58dda203e54f1637b9c" id="r_ga2cc7b7b155cba58dda203e54f1637b9c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ga2cc7b7b155cba58dda203e54f1637b9c">hwloc_topology_set_userdata</a> (<a class="el" href="a00169.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a> topology, const void *userdata)</td></tr>
97 <tr class="memitem:gad47dee1a30f4b00486b54872af030b43" id="r_gad47dee1a30f4b00486b54872af030b43"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#gad47dee1a30f4b00486b54872af030b43">hwloc_topology_get_userdata</a> (<a class="el" href="a00169.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a> topology)</td></tr>
98 </table>
99 <a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
100 <p>Several functions can optionally be called between <a class="el" href="a00169.html#ga03fd4a16d8b9ee1ffc32b25fd2f6bdfa" title="Allocate a topology context.">hwloc_topology_init()</a> and <a class="el" href="a00169.html#gabdf58d87ad77f6615fccdfe0535ff826" title="Build the actual topology.">hwloc_topology_load()</a> to configure how the detection should be performed, e.g. to ignore some objects types, define a synthetic topology, etc. </p>
101 <a name="doc-enum-members" id="doc-enum-members"></a><h2 id="header-doc-enum-members" class="groupheader">Enumeration Type Documentation</h2>
102 <a id="gada025d3ec20b4b420f8038d23d6e7bde" name="gada025d3ec20b4b420f8038d23d6e7bde"></a>
103 <h2 class="memtitle"><span class="permalink"><a href="#gada025d3ec20b4b420f8038d23d6e7bde">&#9670;&#160;</a></span>hwloc_topology_flags_e</h2>
104
105 <div class="memitem">
106 <div class="memproto">
107 <table class="memname">
108 <tr>
109 <td class="memname">enum <a class="el" href="#gada025d3ec20b4b420f8038d23d6e7bde">hwloc_topology_flags_e</a></td>
110 </tr>
111 </table>
112 </div><div class="memdoc">
113
114 <p>Flags to be set onto a topology context before load. </p>
115 <p>Flags should be given to <a class="el" href="#gaaeed4df656979e5f16befea9d29b814b" title="Set OR&#39;ed flags to non-yet-loaded topology.">hwloc_topology_set_flags()</a>. They may also be returned by <a class="el" href="#ga09318f81c1d4713be907d64748a6f93c" title="Get OR&#39;ed flags of a topology.">hwloc_topology_get_flags()</a>. </p>
116 <table class="fieldtable">
117 <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ggada025d3ec20b4b420f8038d23d6e7bdea10907044bbb306fd0dc76acf046d9258" name="ggada025d3ec20b4b420f8038d23d6e7bdea10907044bbb306fd0dc76acf046d9258"></a>HWLOC_TOPOLOGY_FLAG_INCLUDE_DISALLOWED&#160;</td><td class="fielddoc"><p>Detect the whole system, ignore reservations, include disallowed objects. </p>
118 <p>Gather all online resources, even if some were disabled by the administrator. For instance, ignore Linux Cgroup/Cpusets and gather all processors and memory nodes. However offline PUs and NUMA nodes are still ignored.</p>
119 <p>When this flag is not set, PUs and NUMA nodes that are disallowed are not added to the topology. Parent objects (package, core, cache, etc.) are added only if some of their children are allowed. All existing PUs and NUMA nodes in the topology are allowed. <a class="el" href="a00185.html#ga517d5d68ec9f24583d8933aab713be8e" title="Get allowed CPU set.">hwloc_topology_get_allowed_cpuset()</a> and <a class="el" href="a00185.html#ga21a4d7237a11e76b912ed4524ab78cbd" title="Get allowed node set.">hwloc_topology_get_allowed_nodeset()</a> are equal to the root object cpuset and nodeset.</p>
120 <p>When this flag is set, the actual sets of allowed PUs and NUMA nodes are given by <a class="el" href="a00185.html#ga517d5d68ec9f24583d8933aab713be8e" title="Get allowed CPU set.">hwloc_topology_get_allowed_cpuset()</a> and <a class="el" href="a00185.html#ga21a4d7237a11e76b912ed4524ab78cbd" title="Get allowed node set.">hwloc_topology_get_allowed_nodeset()</a>. They may be smaller than the root object cpuset and nodeset.</p>
121 <p>If the current topology is exported to XML and reimported later, this flag should be set again in the reimported topology so that disallowed resources are reimported as well. </p>
122 </td></tr>
123 <tr><td class="fieldname"><a id="ggada025d3ec20b4b420f8038d23d6e7bdea6ecb6abc6a0bb75e81564f8bca85783b" name="ggada025d3ec20b4b420f8038d23d6e7bdea6ecb6abc6a0bb75e81564f8bca85783b"></a>HWLOC_TOPOLOGY_FLAG_IS_THISSYSTEM&#160;</td><td class="fielddoc"><p>Assume that the selected backend provides the topology for the system on which we are running. </p>
124 <p>This forces <a class="el" href="#ga68ffdcfd9175cdf40709801092f18017" title="Does the topology context come from this system?">hwloc_topology_is_thissystem()</a> to return 1, i.e. makes hwloc assume that the selected backend provides the topology for the system on which we are running, even if it is not the OS-specific backend but the XML backend for instance. This means making the binding functions actually call the OS-specific system calls and really do binding, while the XML backend would otherwise provide empty hooks just returning success.</p>
125 <p>Setting the environment variable HWLOC_THISSYSTEM may also result in the same behavior.</p>
126 <p>This can be used for efficiency reasons to first detect the topology once, save it to an XML file, and quickly reload it later through the XML backend, but still having binding functions actually do bind. </p>
127 </td></tr>
128 <tr><td class="fieldname"><a id="ggada025d3ec20b4b420f8038d23d6e7bdea1b66bbd66e900e5c837f71defb32ad89" name="ggada025d3ec20b4b420f8038d23d6e7bdea1b66bbd66e900e5c837f71defb32ad89"></a>HWLOC_TOPOLOGY_FLAG_THISSYSTEM_ALLOWED_RESOURCES&#160;</td><td class="fielddoc"><p>Get the set of allowed resources from the local operating system even if the topology was loaded from XML or synthetic description. </p>
129 <p>If the topology was loaded from XML or from a synthetic string, restrict it by applying the current process restrictions such as Linux Cgroup/Cpuset.</p>
130 <p>This is useful when the topology is not loaded directly from the local machine (e.g. for performance reason) and it comes with all resources, while the running process is restricted to only parts of the machine.</p>
131 <p>This flag is ignored unless <a class="el" href="#ggada025d3ec20b4b420f8038d23d6e7bdea6ecb6abc6a0bb75e81564f8bca85783b" title="Assume that the selected backend provides the topology for the system on which we are running.">HWLOC_TOPOLOGY_FLAG_IS_THISSYSTEM</a> is also set since the loaded topology must match the underlying machine where restrictions will be gathered from.</p>
132 <p>Setting the environment variable HWLOC_THISSYSTEM_ALLOWED_RESOURCES would result in the same behavior. </p>
133 </td></tr>
134 <tr><td class="fieldname"><a id="ggada025d3ec20b4b420f8038d23d6e7bdead93e82b8668ee90e4f9354e201a2ed9c" name="ggada025d3ec20b4b420f8038d23d6e7bdead93e82b8668ee90e4f9354e201a2ed9c"></a>HWLOC_TOPOLOGY_FLAG_IMPORT_SUPPORT&#160;</td><td class="fielddoc"><p>Import support from the imported topology. </p>
135 <p>When importing a XML topology from a remote machine, binding is disabled by default (see <a class="el" href="#ggada025d3ec20b4b420f8038d23d6e7bdea6ecb6abc6a0bb75e81564f8bca85783b" title="Assume that the selected backend provides the topology for the system on which we are running.">HWLOC_TOPOLOGY_FLAG_IS_THISSYSTEM</a>). This disabling is also marked by putting zeroes in the corresponding supported feature bits reported by <a class="el" href="#gac0927e93a9b962143be08a48bbff2e19" title="Retrieve the topology support.">hwloc_topology_get_support()</a>.</p>
136 <p>The flag <a class="el" href="#ggada025d3ec20b4b420f8038d23d6e7bdead93e82b8668ee90e4f9354e201a2ed9c" title="Import support from the imported topology.">HWLOC_TOPOLOGY_FLAG_IMPORT_SUPPORT</a> actually imports support bits from the remote machine. It also sets the flag <code class="param">imported_support</code> in the struct <a class="el" href="a00288.html" title="Flags describing miscellaneous features.">hwloc_topology_misc_support</a> array. If the imported XML did not contain any support information (exporter hwloc is too old), this flag is not set.</p>
137 <p>Note that these supported features are only relevant for the hwloc installation that actually exported the XML topology (it may vary with the operating system, or with how hwloc was compiled).</p>
138 <p>Note that setting this flag however does not enable binding for the locally imported hwloc topology, it only reports what the remote hwloc and machine support. </p>
139 </td></tr>
140 <tr><td class="fieldname"><a id="ggada025d3ec20b4b420f8038d23d6e7bdeaa595aed197779012acf43e8ca4a2658d" name="ggada025d3ec20b4b420f8038d23d6e7bdeaa595aed197779012acf43e8ca4a2658d"></a>HWLOC_TOPOLOGY_FLAG_RESTRICT_TO_CPUBINDING&#160;</td><td class="fielddoc"><p>Do not consider resources outside of the process CPU binding. </p>
141 <p>If the binding of the process is limited to a subset of cores, ignore the other cores during discovery.</p>
142 <p>The resulting topology is identical to what a call to <a class="el" href="a00177.html#ga6db81ed13ac0a9d70cc80372ab537815" title="Restrict the topology to the given CPU set or nodeset.">hwloc_topology_restrict()</a> would generate, but this flag also prevents hwloc from ever touching other resources during the discovery.</p>
143 <p>This flag especially tells the x86 backend to never temporarily rebind a thread on any excluded core. This is useful on Windows because such temporary rebinding can change the process binding. Another use-case is to avoid cores that would not be able to perform the hwloc discovery anytime soon because they are busy executing some high-priority real-time tasks.</p>
144 <p>If process CPU binding is not supported, the thread CPU binding is considered instead if supported, or the flag is ignored.</p>
145 <p>This flag requires <a class="el" href="#ggada025d3ec20b4b420f8038d23d6e7bdea6ecb6abc6a0bb75e81564f8bca85783b" title="Assume that the selected backend provides the topology for the system on which we are running.">HWLOC_TOPOLOGY_FLAG_IS_THISSYSTEM</a> as well since binding support is required. </p>
146 </td></tr>
147 <tr><td class="fieldname"><a id="ggada025d3ec20b4b420f8038d23d6e7bdea368d7741135fe309f3782c59644d3caa" name="ggada025d3ec20b4b420f8038d23d6e7bdea368d7741135fe309f3782c59644d3caa"></a>HWLOC_TOPOLOGY_FLAG_RESTRICT_TO_MEMBINDING&#160;</td><td class="fielddoc"><p>Do not consider resources outside of the process memory binding. </p>
148 <p>If the binding of the process is limited to a subset of NUMA nodes, ignore the other NUMA nodes during discovery.</p>
149 <p>The resulting topology is identical to what a call to <a class="el" href="a00177.html#ga6db81ed13ac0a9d70cc80372ab537815" title="Restrict the topology to the given CPU set or nodeset.">hwloc_topology_restrict()</a> would generate, but this flag also prevents hwloc from ever touching other resources during the discovery.</p>
150 <p>This flag is meant to be used together with <a class="el" href="#ggada025d3ec20b4b420f8038d23d6e7bdeaa595aed197779012acf43e8ca4a2658d" title="Do not consider resources outside of the process CPU binding.">HWLOC_TOPOLOGY_FLAG_RESTRICT_TO_CPUBINDING</a> when both cores and NUMA nodes should be ignored outside of the process binding.</p>
151 <p>If process memory binding is not supported, the thread memory binding is considered instead if supported, or the flag is ignored.</p>
152 <p>This flag requires <a class="el" href="#ggada025d3ec20b4b420f8038d23d6e7bdea6ecb6abc6a0bb75e81564f8bca85783b" title="Assume that the selected backend provides the topology for the system on which we are running.">HWLOC_TOPOLOGY_FLAG_IS_THISSYSTEM</a> as well since binding support is required. </p>
153 </td></tr>
154 <tr><td class="fieldname"><a id="ggada025d3ec20b4b420f8038d23d6e7bdeae7a792e3db4360360a10f9160b10e631" name="ggada025d3ec20b4b420f8038d23d6e7bdeae7a792e3db4360360a10f9160b10e631"></a>HWLOC_TOPOLOGY_FLAG_DONT_CHANGE_BINDING&#160;</td><td class="fielddoc"><p>Do not ever modify the process or thread binding during discovery. </p>
155 <p>This flag disables all hwloc discovery steps that require a change of the process or thread binding. This currently only affects the x86 backend which gets entirely disabled.</p>
156 <p>This is useful when <a class="el" href="a00169.html#gabdf58d87ad77f6615fccdfe0535ff826" title="Build the actual topology.">hwloc_topology_load()</a> is called while the application also creates additional threads or modifies the binding.</p>
157 <p>This flag is also a strict way to make sure the process binding will not change to due thread binding changes on Windows (see <a class="el" href="#ggada025d3ec20b4b420f8038d23d6e7bdeaa595aed197779012acf43e8ca4a2658d" title="Do not consider resources outside of the process CPU binding.">HWLOC_TOPOLOGY_FLAG_RESTRICT_TO_CPUBINDING</a>). </p>
158 </td></tr>
159 <tr><td class="fieldname"><a id="ggada025d3ec20b4b420f8038d23d6e7bdea5796b4909eba80f9727b66d07d3a7a05" name="ggada025d3ec20b4b420f8038d23d6e7bdea5796b4909eba80f9727b66d07d3a7a05"></a>HWLOC_TOPOLOGY_FLAG_NO_DISTANCES&#160;</td><td class="fielddoc"><p>Ignore distances. </p>
160 <p>Ignore distance information from the operating systems (and from XML) and hence do not use distances for grouping. </p>
161 </td></tr>
162 <tr><td class="fieldname"><a id="ggada025d3ec20b4b420f8038d23d6e7bdead5636766a6603f24486f79c48899c1c3" name="ggada025d3ec20b4b420f8038d23d6e7bdead5636766a6603f24486f79c48899c1c3"></a>HWLOC_TOPOLOGY_FLAG_NO_MEMATTRS&#160;</td><td class="fielddoc"><p>Ignore memory attributes and tiers. </p>
163 <p>Ignore memory attribues from the operating systems (and from XML) Hence also do not try to build memory tiers. </p>
164 </td></tr>
165 <tr><td class="fieldname"><a id="ggada025d3ec20b4b420f8038d23d6e7bdea3497cd4c2f8b1d842dd49b3aaae56a24" name="ggada025d3ec20b4b420f8038d23d6e7bdea3497cd4c2f8b1d842dd49b3aaae56a24"></a>HWLOC_TOPOLOGY_FLAG_NO_CPUKINDS&#160;</td><td class="fielddoc"><p>Ignore CPU Kinds. </p>
166 <p>Ignore CPU kind information from the operating systems (and from XML). </p>
167 </td></tr>
168 </table>
169
170 </div>
171 </div>
172 <a id="ga9a5a1f0140cd1952544477833733195b" name="ga9a5a1f0140cd1952544477833733195b"></a>
173 <h2 class="memtitle"><span class="permalink"><a href="#ga9a5a1f0140cd1952544477833733195b">&#9670;&#160;</a></span>hwloc_type_filter_e</h2>
174
175 <div class="memitem">
176 <div class="memproto">
177 <table class="memname">
178 <tr>
179 <td class="memname">enum <a class="el" href="#ga9a5a1f0140cd1952544477833733195b">hwloc_type_filter_e</a></td>
180 </tr>
181 </table>
182 </div><div class="memdoc">
183
184 <p>Type filtering flags. </p>
185 <p>By default, most objects are kept (<a class="el" href="#gga9a5a1f0140cd1952544477833733195bafda7b59e6810dfe778d8f9a4cc1e350e" title="Keep all objects of this type.">HWLOC_TYPE_FILTER_KEEP_ALL</a>). Instruction caches, memory-side caches, I/O and Misc objects are ignored by default (<a class="el" href="#gga9a5a1f0140cd1952544477833733195ba4f835955414de92c77d99b8419d4647a" title="Ignore all objects of this type.">HWLOC_TYPE_FILTER_KEEP_NONE</a>). Group levels are ignored unless they bring structure (<a class="el" href="#gga9a5a1f0140cd1952544477833733195ba7664716643bf1db83e631eed34f659e4" title="Only ignore objects if their entire level does not bring any structure.">HWLOC_TYPE_FILTER_KEEP_STRUCTURE</a>).</p>
186 <p>Note that group objects are also ignored individually (without the entire level) when they do not bring structure. </p>
187 <table class="fieldtable">
188 <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="gga9a5a1f0140cd1952544477833733195bafda7b59e6810dfe778d8f9a4cc1e350e" name="gga9a5a1f0140cd1952544477833733195bafda7b59e6810dfe778d8f9a4cc1e350e"></a>HWLOC_TYPE_FILTER_KEEP_ALL&#160;</td><td class="fielddoc"><p>Keep all objects of this type. </p>
189 <p>Cannot be set for <a class="el" href="a00167.html#ggacd37bb612667dc437d66bfb175a8dc55a5269ef95be72f88465559d35c9b7ad56" title="Group objects. Objects which do not fit in the above but are detected by hwloc and are useful to take...">HWLOC_OBJ_GROUP</a> (groups are designed only to add more structure to the topology). </p>
190 </td></tr>
191 <tr><td class="fieldname"><a id="gga9a5a1f0140cd1952544477833733195ba4f835955414de92c77d99b8419d4647a" name="gga9a5a1f0140cd1952544477833733195ba4f835955414de92c77d99b8419d4647a"></a>HWLOC_TYPE_FILTER_KEEP_NONE&#160;</td><td class="fielddoc"><p>Ignore all objects of this type. </p>
192 <p>The bottom-level type <a class="el" href="a00167.html#ggacd37bb612667dc437d66bfb175a8dc55abca6887e80cb291353b0a0c1da83f661" title="Processing Unit, or (Logical) Processor. An execution unit (may share a core with some other logical ...">HWLOC_OBJ_PU</a>, the <a class="el" href="a00167.html#ggacd37bb612667dc437d66bfb175a8dc55a9d917a3e5497950c6d8948b8e183db5a" title="NUMA node. An object that contains memory that is directly and byte-accessible to the host processors...">HWLOC_OBJ_NUMANODE</a> type, and the top-level type <a class="el" href="a00167.html#ggacd37bb612667dc437d66bfb175a8dc55a3f4e83ffc4a259354959ae8a9eaa2a80" title="Machine. A set of processors and memory with cache coherency.">HWLOC_OBJ_MACHINE</a> may not be ignored. </p>
193 </td></tr>
194 <tr><td class="fieldname"><a id="gga9a5a1f0140cd1952544477833733195ba7664716643bf1db83e631eed34f659e4" name="gga9a5a1f0140cd1952544477833733195ba7664716643bf1db83e631eed34f659e4"></a>HWLOC_TYPE_FILTER_KEEP_STRUCTURE&#160;</td><td class="fielddoc"><p>Only ignore objects if their entire level does not bring any structure. </p>
195 <p>Keep the entire level of objects if at least one of these objects adds structure to the topology. An object brings structure when it has multiple children and it is not the only child of its parent.</p>
196 <p>If all objects in the level are the only child of their parent, or if all of them have a single child, the entire level may be removed. A common example is caches that are private to each core.</p>
197 <p>This filter cannot be used for I/O and Misc objects since the topology structure does not matter there. </p>
198 </td></tr>
199 <tr><td class="fieldname"><a id="gga9a5a1f0140cd1952544477833733195ba63fd24954e18c83ff7eae9588759adb5" name="gga9a5a1f0140cd1952544477833733195ba63fd24954e18c83ff7eae9588759adb5"></a>HWLOC_TYPE_FILTER_KEEP_IMPORTANT&#160;</td><td class="fielddoc"><p>Only keep likely-important objects of the given type. </p>
200 <p>It is only useful for I/O object types. For <a class="el" href="a00167.html#ggacd37bb612667dc437d66bfb175a8dc55a5d8117a54df1fbd3606ab19e42cb0ea9" title="PCI device (filtered out by default).">HWLOC_OBJ_PCI_DEVICE</a> and <a class="el" href="a00167.html#ggacd37bb612667dc437d66bfb175a8dc55a51e7280240fd9f25589cbbe538bdb075" title="Operating system device (filtered out by default).">HWLOC_OBJ_OS_DEVICE</a>, it means that only objects of major/common kinds are kept (storage, network, OpenFabrics, CUDA, OpenCL, RSMI, NVML, and displays). Also, only OS devices directly attached on PCI (e.g. no USB) are reported. For <a class="el" href="a00167.html#ggacd37bb612667dc437d66bfb175a8dc55a6825f10895fea60aca7a6ba9fe273db0" title="Bridge (filtered out by default). Any bridge (or PCI switch) that connects the host or an I/O bus,...">HWLOC_OBJ_BRIDGE</a>, it means that bridges are kept only if they have children.</p>
201 <p>This flag equivalent to <a class="el" href="#gga9a5a1f0140cd1952544477833733195bafda7b59e6810dfe778d8f9a4cc1e350e" title="Keep all objects of this type.">HWLOC_TYPE_FILTER_KEEP_ALL</a> for Normal, Memory and Misc types since they are likely important. </p>
202 </td></tr>
203 </table>
204
205 </div>
206 </div>
207 <a name="doc-func-members" id="doc-func-members"></a><h2 id="header-doc-func-members" class="groupheader">Function Documentation</h2>
208 <a id="ga09318f81c1d4713be907d64748a6f93c" name="ga09318f81c1d4713be907d64748a6f93c"></a>
209 <h2 class="memtitle"><span class="permalink"><a href="#ga09318f81c1d4713be907d64748a6f93c">&#9670;&#160;</a></span>hwloc_topology_get_flags()</h2>
210
211 <div class="memitem">
212 <div class="memproto">
213 <table class="memname">
214 <tr>
215 <td class="memname">unsigned long hwloc_topology_get_flags </td>
216 <td>(</td>
217 <td class="paramtype"><a class="el" href="a00169.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a></td> <td class="paramname"><span class="paramname"><em>topology</em></span></td><td>)</td>
218 <td></td>
219 </tr>
220 </table>
221 </div><div class="memdoc">
222
223 <p>Get OR'ed flags of a topology. </p>
224 <p>Get the OR'ed set of <a class="el" href="#gada025d3ec20b4b420f8038d23d6e7bde" title="Flags to be set onto a topology context before load.">hwloc_topology_flags_e</a> of a topology.</p>
225 <p>If <a class="el" href="#gaaeed4df656979e5f16befea9d29b814b" title="Set OR&#39;ed flags to non-yet-loaded topology.">hwloc_topology_set_flags()</a> was not called earlier, no flags are set (<code>0</code> is returned).</p>
226 <dl class="section return"><dt>Returns</dt><dd>the flags previously set with <a class="el" href="#gaaeed4df656979e5f16befea9d29b814b" title="Set OR&#39;ed flags to non-yet-loaded topology.">hwloc_topology_set_flags()</a>.</dd></dl>
227 <dl class="section note"><dt>Note</dt><dd>This function may also be called after <a class="el" href="a00169.html#gabdf58d87ad77f6615fccdfe0535ff826" title="Build the actual topology.">hwloc_topology_load()</a>. </dd></dl>
228
229 </div>
230 </div>
231 <a id="gac0927e93a9b962143be08a48bbff2e19" name="gac0927e93a9b962143be08a48bbff2e19"></a>
232 <h2 class="memtitle"><span class="permalink"><a href="#gac0927e93a9b962143be08a48bbff2e19">&#9670;&#160;</a></span>hwloc_topology_get_support()</h2>
233
234 <div class="memitem">
235 <div class="memproto">
236 <table class="memname">
237 <tr>
238 <td class="memname">const struct <a class="el" href="a00292.html">hwloc_topology_support</a> * hwloc_topology_get_support </td>
239 <td>(</td>
240 <td class="paramtype"><a class="el" href="a00169.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a> restrict</td> <td class="paramname"><span class="paramname"><em>topology</em></span></td><td>)</td>
241 <td></td>
242 </tr>
243 </table>
244 </div><div class="memdoc">
245
246 <p>Retrieve the topology support. </p>
247 <p>Each flag indicates whether a feature is supported. If set to 0, the feature is not supported. If set to 1, the feature is supported, but the corresponding call may still fail in some corner cases.</p>
248 <p>These features are also listed by hwloc-info --support</p>
249 <p>The reported features are what the current topology supports on the current machine. If the topology was exported to XML from another machine and later imported here, support still describes what is supported for this imported topology after import. By default, binding will be reported as unsupported in this case (see <a class="el" href="#ggada025d3ec20b4b420f8038d23d6e7bdea6ecb6abc6a0bb75e81564f8bca85783b" title="Assume that the selected backend provides the topology for the system on which we are running.">HWLOC_TOPOLOGY_FLAG_IS_THISSYSTEM</a>).</p>
250 <p>Topology flag <a class="el" href="#ggada025d3ec20b4b420f8038d23d6e7bdead93e82b8668ee90e4f9354e201a2ed9c" title="Import support from the imported topology.">HWLOC_TOPOLOGY_FLAG_IMPORT_SUPPORT</a> may be used to report the supported features of the original remote machine instead. If it was successfully imported, <code class="param">imported_support</code> will be set in the struct <a class="el" href="a00288.html" title="Flags describing miscellaneous features.">hwloc_topology_misc_support</a> array.</p>
251 <dl class="section return"><dt>Returns</dt><dd>A pointer to a support structure.</dd></dl>
252 <dl class="section note"><dt>Note</dt><dd>The function cannot return <code>NULL</code>. </dd>
253 <dd>
254 The returned pointer should not be freed, it belongs to the hwloc library.</dd>
255 <dd>
256 This function may be called before or after <a class="el" href="a00169.html#gabdf58d87ad77f6615fccdfe0535ff826" title="Build the actual topology.">hwloc_topology_load()</a> but the support structure only contains valid information after. </dd></dl>
257
258 </div>
259 </div>
260 <a id="ga137ad1178f7a79f2383974d983083401" name="ga137ad1178f7a79f2383974d983083401"></a>
261 <h2 class="memtitle"><span class="permalink"><a href="#ga137ad1178f7a79f2383974d983083401">&#9670;&#160;</a></span>hwloc_topology_get_type_filter()</h2>
262
263 <div class="memitem">
264 <div class="memproto">
265 <table class="memname">
266 <tr>
267 <td class="memname">int hwloc_topology_get_type_filter </td>
268 <td>(</td>
269 <td class="paramtype"><a class="el" href="a00169.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a></td> <td class="paramname"><span class="paramname"><em>topology</em></span>, </td>
270 </tr>
271 <tr>
272 <td class="paramkey"></td>
273 <td></td>
274 <td class="paramtype"><a class="el" href="a00167.html#gacd37bb612667dc437d66bfb175a8dc55">hwloc_obj_type_t</a></td> <td class="paramname"><span class="paramname"><em>type</em></span>, </td>
275 </tr>
276 <tr>
277 <td class="paramkey"></td>
278 <td></td>
279 <td class="paramtype">enum <a class="el" href="#ga9a5a1f0140cd1952544477833733195b">hwloc_type_filter_e</a> *</td> <td class="paramname"><span class="paramname"><em>filter</em></span>&#160;)</td>
280 </tr>
281 </table>
282 </div><div class="memdoc">
283
284 <p>Get the current filtering for the given object type. </p>
285 <dl class="section return"><dt>Returns</dt><dd>0 on success, -1 on error. </dd></dl>
286
287 </div>
288 </div>
289 <a id="gad47dee1a30f4b00486b54872af030b43" name="gad47dee1a30f4b00486b54872af030b43"></a>
290 <h2 class="memtitle"><span class="permalink"><a href="#gad47dee1a30f4b00486b54872af030b43">&#9670;&#160;</a></span>hwloc_topology_get_userdata()</h2>
291
292 <div class="memitem">
293 <div class="memproto">
294 <table class="memname">
295 <tr>
296 <td class="memname">void * hwloc_topology_get_userdata </td>
297 <td>(</td>
298 <td class="paramtype"><a class="el" href="a00169.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a></td> <td class="paramname"><span class="paramname"><em>topology</em></span></td><td>)</td>
299 <td></td>
300 </tr>
301 </table>
302 </div><div class="memdoc">
303
304 <p>Retrieve the topology-specific userdata pointer. </p>
305 <p>Retrieve the application-given private data pointer that was previously set with <a class="el" href="#ga2cc7b7b155cba58dda203e54f1637b9c" title="Set the topology-specific userdata pointer.">hwloc_topology_set_userdata()</a>.</p>
306 <dl class="section return"><dt>Returns</dt><dd>A pointer to the private-data if any. </dd>
307 <dd>
308 <code>NULL</code> if no private-data was previoulsy set. </dd></dl>
309
310 </div>
311 </div>
312 <a id="ga68ffdcfd9175cdf40709801092f18017" name="ga68ffdcfd9175cdf40709801092f18017"></a>
313 <h2 class="memtitle"><span class="permalink"><a href="#ga68ffdcfd9175cdf40709801092f18017">&#9670;&#160;</a></span>hwloc_topology_is_thissystem()</h2>
314
315 <div class="memitem">
316 <div class="memproto">
317 <table class="memname">
318 <tr>
319 <td class="memname">int hwloc_topology_is_thissystem </td>
320 <td>(</td>
321 <td class="paramtype"><a class="el" href="a00169.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a> restrict</td> <td class="paramname"><span class="paramname"><em>topology</em></span></td><td>)</td>
322 <td></td>
323 </tr>
324 </table>
325 </div><div class="memdoc">
326
327 <p>Does the topology context come from this system? </p>
328 <dl class="section return"><dt>Returns</dt><dd>1 if this topology context was built using the system running this program. </dd>
329 <dd>
330 0 instead (for instance if using another file-system root, a XML topology file, or a synthetic topology).</dd></dl>
331 <dl class="section note"><dt>Note</dt><dd>This function may also be called after <a class="el" href="a00169.html#gabdf58d87ad77f6615fccdfe0535ff826" title="Build the actual topology.">hwloc_topology_load()</a>. </dd></dl>
332
333 </div>
334 </div>
335 <a id="ga9eb8dc3b106f84921bf5789101e97e24" name="ga9eb8dc3b106f84921bf5789101e97e24"></a>
336 <h2 class="memtitle"><span class="permalink"><a href="#ga9eb8dc3b106f84921bf5789101e97e24">&#9670;&#160;</a></span>hwloc_topology_set_all_types_filter()</h2>
337
338 <div class="memitem">
339 <div class="memproto">
340 <table class="memname">
341 <tr>
342 <td class="memname">int hwloc_topology_set_all_types_filter </td>
343 <td>(</td>
344 <td class="paramtype"><a class="el" href="a00169.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a></td> <td class="paramname"><span class="paramname"><em>topology</em></span>, </td>
345 </tr>
346 <tr>
347 <td class="paramkey"></td>
348 <td></td>
349 <td class="paramtype">enum <a class="el" href="#ga9a5a1f0140cd1952544477833733195b">hwloc_type_filter_e</a></td> <td class="paramname"><span class="paramname"><em>filter</em></span>&#160;)</td>
350 </tr>
351 </table>
352 </div><div class="memdoc">
353
354 <p>Set the filtering for all object types. </p>
355 <p>If some types do not support this filtering, they are silently ignored.</p>
356 <dl class="section return"><dt>Returns</dt><dd>0 on success, -1 on error. </dd></dl>
357
358 </div>
359 </div>
360 <a id="ga30bd6d330fe3c8f0cbaad724d114ee20" name="ga30bd6d330fe3c8f0cbaad724d114ee20"></a>
361 <h2 class="memtitle"><span class="permalink"><a href="#ga30bd6d330fe3c8f0cbaad724d114ee20">&#9670;&#160;</a></span>hwloc_topology_set_cache_types_filter()</h2>
362
363 <div class="memitem">
364 <div class="memproto">
365 <table class="memname">
366 <tr>
367 <td class="memname">int hwloc_topology_set_cache_types_filter </td>
368 <td>(</td>
369 <td class="paramtype"><a class="el" href="a00169.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a></td> <td class="paramname"><span class="paramname"><em>topology</em></span>, </td>
370 </tr>
371 <tr>
372 <td class="paramkey"></td>
373 <td></td>
374 <td class="paramtype">enum <a class="el" href="#ga9a5a1f0140cd1952544477833733195b">hwloc_type_filter_e</a></td> <td class="paramname"><span class="paramname"><em>filter</em></span>&#160;)</td>
375 </tr>
376 </table>
377 </div><div class="memdoc">
378
379 <p>Set the filtering for all CPU cache object types. </p>
380 <p>Memory-side caches are not involved since they are not CPU caches.</p>
381 <dl class="section return"><dt>Returns</dt><dd>0 on success, -1 on error. </dd></dl>
382
383 </div>
384 </div>
385 <a id="gaaeed4df656979e5f16befea9d29b814b" name="gaaeed4df656979e5f16befea9d29b814b"></a>
386 <h2 class="memtitle"><span class="permalink"><a href="#gaaeed4df656979e5f16befea9d29b814b">&#9670;&#160;</a></span>hwloc_topology_set_flags()</h2>
387
388 <div class="memitem">
389 <div class="memproto">
390 <table class="memname">
391 <tr>
392 <td class="memname">int hwloc_topology_set_flags </td>
393 <td>(</td>
394 <td class="paramtype"><a class="el" href="a00169.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a></td> <td class="paramname"><span class="paramname"><em>topology</em></span>, </td>
395 </tr>
396 <tr>
397 <td class="paramkey"></td>
398 <td></td>
399 <td class="paramtype">unsigned long</td> <td class="paramname"><span class="paramname"><em>flags</em></span>&#160;)</td>
400 </tr>
401 </table>
402 </div><div class="memdoc">
403
404 <p>Set OR'ed flags to non-yet-loaded topology. </p>
405 <p>Set a OR'ed set of <a class="el" href="#gada025d3ec20b4b420f8038d23d6e7bde" title="Flags to be set onto a topology context before load.">hwloc_topology_flags_e</a> onto a topology that was not yet loaded.</p>
406 <p>If this function is called multiple times, the last invocation will erase and replace the set of flags that was previously set.</p>
407 <p>By default, no flags are set (<code>0</code>).</p>
408 <p>The flags set in a topology may be retrieved with <a class="el" href="#ga09318f81c1d4713be907d64748a6f93c" title="Get OR&#39;ed flags of a topology.">hwloc_topology_get_flags()</a>.</p>
409 <dl class="section return"><dt>Returns</dt><dd>0 on success. </dd>
410 <dd>
411 -1 on error, for instance if flags are invalid. </dd></dl>
412
413 </div>
414 </div>
415 <a id="ga37c7b2e599ed3cd76ad9164630024f30" name="ga37c7b2e599ed3cd76ad9164630024f30"></a>
416 <h2 class="memtitle"><span class="permalink"><a href="#ga37c7b2e599ed3cd76ad9164630024f30">&#9670;&#160;</a></span>hwloc_topology_set_icache_types_filter()</h2>
417
418 <div class="memitem">
419 <div class="memproto">
420 <table class="memname">
421 <tr>
422 <td class="memname">int hwloc_topology_set_icache_types_filter </td>
423 <td>(</td>
424 <td class="paramtype"><a class="el" href="a00169.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a></td> <td class="paramname"><span class="paramname"><em>topology</em></span>, </td>
425 </tr>
426 <tr>
427 <td class="paramkey"></td>
428 <td></td>
429 <td class="paramtype">enum <a class="el" href="#ga9a5a1f0140cd1952544477833733195b">hwloc_type_filter_e</a></td> <td class="paramname"><span class="paramname"><em>filter</em></span>&#160;)</td>
430 </tr>
431 </table>
432 </div><div class="memdoc">
433
434 <p>Set the filtering for all CPU instruction cache object types. </p>
435 <p>Memory-side caches are not involved since they are not CPU caches.</p>
436 <dl class="section return"><dt>Returns</dt><dd>0 on success, -1 on error. </dd></dl>
437
438 </div>
439 </div>
440 <a id="ga0ab38705357bc1203abe829da8a12ad3" name="ga0ab38705357bc1203abe829da8a12ad3"></a>
441 <h2 class="memtitle"><span class="permalink"><a href="#ga0ab38705357bc1203abe829da8a12ad3">&#9670;&#160;</a></span>hwloc_topology_set_io_types_filter()</h2>
442
443 <div class="memitem">
444 <div class="memproto">
445 <table class="memname">
446 <tr>
447 <td class="memname">int hwloc_topology_set_io_types_filter </td>
448 <td>(</td>
449 <td class="paramtype"><a class="el" href="a00169.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a></td> <td class="paramname"><span class="paramname"><em>topology</em></span>, </td>
450 </tr>
451 <tr>
452 <td class="paramkey"></td>
453 <td></td>
454 <td class="paramtype">enum <a class="el" href="#ga9a5a1f0140cd1952544477833733195b">hwloc_type_filter_e</a></td> <td class="paramname"><span class="paramname"><em>filter</em></span>&#160;)</td>
455 </tr>
456 </table>
457 </div><div class="memdoc">
458
459 <p>Set the filtering for all I/O object types. </p>
460 <dl class="section return"><dt>Returns</dt><dd>0 on success, -1 on error. </dd></dl>
461
462 </div>
463 </div>
464 <a id="gad894e70f15f8d4aada7be8d1aba38b7e" name="gad894e70f15f8d4aada7be8d1aba38b7e"></a>
465 <h2 class="memtitle"><span class="permalink"><a href="#gad894e70f15f8d4aada7be8d1aba38b7e">&#9670;&#160;</a></span>hwloc_topology_set_type_filter()</h2>
466
467 <div class="memitem">
468 <div class="memproto">
469 <table class="memname">
470 <tr>
471 <td class="memname">int hwloc_topology_set_type_filter </td>
472 <td>(</td>
473 <td class="paramtype"><a class="el" href="a00169.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a></td> <td class="paramname"><span class="paramname"><em>topology</em></span>, </td>
474 </tr>
475 <tr>
476 <td class="paramkey"></td>
477 <td></td>
478 <td class="paramtype"><a class="el" href="a00167.html#gacd37bb612667dc437d66bfb175a8dc55">hwloc_obj_type_t</a></td> <td class="paramname"><span class="paramname"><em>type</em></span>, </td>
479 </tr>
480 <tr>
481 <td class="paramkey"></td>
482 <td></td>
483 <td class="paramtype">enum <a class="el" href="#ga9a5a1f0140cd1952544477833733195b">hwloc_type_filter_e</a></td> <td class="paramname"><span class="paramname"><em>filter</em></span>&#160;)</td>
484 </tr>
485 </table>
486 </div><div class="memdoc">
487
488 <p>Set the filtering for the given object type. </p>
489 <dl class="section return"><dt>Returns</dt><dd>0 on success, -1 on error. </dd></dl>
490
491 </div>
492 </div>
493 <a id="ga2cc7b7b155cba58dda203e54f1637b9c" name="ga2cc7b7b155cba58dda203e54f1637b9c"></a>
494 <h2 class="memtitle"><span class="permalink"><a href="#ga2cc7b7b155cba58dda203e54f1637b9c">&#9670;&#160;</a></span>hwloc_topology_set_userdata()</h2>
495
496 <div class="memitem">
497 <div class="memproto">
498 <table class="memname">
499 <tr>
500 <td class="memname">void hwloc_topology_set_userdata </td>
501 <td>(</td>
502 <td class="paramtype"><a class="el" href="a00169.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a></td> <td class="paramname"><span class="paramname"><em>topology</em></span>, </td>
503 </tr>
504 <tr>
505 <td class="paramkey"></td>
506 <td></td>
507 <td class="paramtype">const void *</td> <td class="paramname"><span class="paramname"><em>userdata</em></span>&#160;)</td>
508 </tr>
509 </table>
510 </div><div class="memdoc">
511
512 <p>Set the topology-specific userdata pointer. </p>
513 <p>Each topology may store one application-given private data pointer. It is initialized to <code>NULL</code>. hwloc will never modify it.</p>
514 <p>Use it as you wish, after <a class="el" href="a00169.html#ga03fd4a16d8b9ee1ffc32b25fd2f6bdfa" title="Allocate a topology context.">hwloc_topology_init()</a> and until hwloc_topolog_destroy().</p>
515 <p>This pointer is not exported to XML. </p>
516
517 </div>
518 </div>
519 </div><!-- contents -->
520 <!-- start footer part -->
521 <hr class="footer"/><address class="footer"><small>
522 Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.15.0
523 </small></address>
524 </div><!-- doc-content -->
525 </body>
526 </html>