| 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): hwloc_disc_component Struct Reference</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"> 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="#pub-attribs">Data Fields</a> </div> |
| 47 |
<div class="headertitle"><div class="title">hwloc_disc_component Struct Reference<div class="ingroups"><a class="el" href="a00214.html">Components and Plugins: Discovery components and backends</a></div></div></div> |
| 48 |
</div><!--header--> |
| 49 |
<div class="contents"> |
| 50 |
|
| 51 |
<p><code>#include <<a class="el" href="a00161_source.html">plugins.h</a>></code></p> |
| 52 |
<table class="memberdecls"> |
| 53 |
<tr class="heading"><td colspan="2"><h2 id="header-pub-attribs" class="groupheader"><a id="pub-attribs" name="pub-attribs"></a> |
| 54 |
Data Fields</h2></td></tr> |
| 55 |
<tr class="memitem:a4064c3b5d9213027e87caebef380a840" id="r_a4064c3b5d9213027e87caebef380a840"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="#a4064c3b5d9213027e87caebef380a840">name</a></td></tr> |
| 56 |
<tr class="memitem:a61ad3151efa02e3dbad5d919758f9c90" id="r_a61ad3151efa02e3dbad5d919758f9c90"><td class="memItemLeft" align="right" valign="top">unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="#a61ad3151efa02e3dbad5d919758f9c90">phases</a></td></tr> |
| 57 |
<tr class="memitem:acbb9957914dbf7b8f504215aa0c8d3fe" id="r_acbb9957914dbf7b8f504215aa0c8d3fe"><td class="memItemLeft" align="right" valign="top">unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="#acbb9957914dbf7b8f504215aa0c8d3fe">excluded_phases</a></td></tr> |
| 58 |
<tr class="memitem:a12e780d0acf89da7a8c8e37e51a3abcb" id="r_a12e780d0acf89da7a8c8e37e51a3abcb"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="a00364.html">hwloc_backend</a> *(* </td><td class="memItemRight" valign="bottom"><a class="el" href="#a12e780d0acf89da7a8c8e37e51a3abcb">instantiate</a> )(struct hwloc_topology *topology, struct <a class="el" href="a00356.html">hwloc_disc_component</a> *component, unsigned <a class="el" href="#acbb9957914dbf7b8f504215aa0c8d3fe">excluded_phases</a>, const void *data1, const void *data2, const void *data3)</td></tr> |
| 59 |
<tr class="memitem:ae86d283c272c5ae24073a235efbf6b59" id="r_ae86d283c272c5ae24073a235efbf6b59"><td class="memItemLeft" align="right" valign="top">unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="#ae86d283c272c5ae24073a235efbf6b59">priority</a></td></tr> |
| 60 |
<tr class="memitem:ace80cafe2b1732b047b3fc3da47e6517" id="r_ace80cafe2b1732b047b3fc3da47e6517"><td class="memItemLeft" align="right" valign="top">unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="#ace80cafe2b1732b047b3fc3da47e6517">enabled_by_default</a></td></tr> |
| 61 |
</table> |
| 62 |
<a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2> |
| 63 |
<div class="textblock"><p>Discovery component structure. </p> |
| 64 |
<p>This is the major kind of components, taking care of the discovery. They are registered by generic components, either statically-built or as plugins. </p> |
| 65 |
</div><a name="doc-variable-members" id="doc-variable-members"></a><h2 id="header-doc-variable-members" class="groupheader">Field Documentation</h2> |
| 66 |
<a id="ace80cafe2b1732b047b3fc3da47e6517" name="ace80cafe2b1732b047b3fc3da47e6517"></a> |
| 67 |
<h2 class="memtitle"><span class="permalink"><a href="#ace80cafe2b1732b047b3fc3da47e6517">◆ </a></span>enabled_by_default</h2> |
| 68 |
|
| 69 |
<div class="memitem"> |
| 70 |
<div class="memproto"> |
| 71 |
<table class="memname"> |
| 72 |
<tr> |
| 73 |
<td class="memname">unsigned hwloc_disc_component::enabled_by_default</td> |
| 74 |
</tr> |
| 75 |
</table> |
| 76 |
</div><div class="memdoc"> |
| 77 |
|
| 78 |
<p>Enabled by default. If unset, if will be disabled unless explicitly requested. </p> |
| 79 |
|
| 80 |
</div> |
| 81 |
</div> |
| 82 |
<a id="acbb9957914dbf7b8f504215aa0c8d3fe" name="acbb9957914dbf7b8f504215aa0c8d3fe"></a> |
| 83 |
<h2 class="memtitle"><span class="permalink"><a href="#acbb9957914dbf7b8f504215aa0c8d3fe">◆ </a></span>excluded_phases</h2> |
| 84 |
|
| 85 |
<div class="memitem"> |
| 86 |
<div class="memproto"> |
| 87 |
<table class="memname"> |
| 88 |
<tr> |
| 89 |
<td class="memname">unsigned hwloc_disc_component::excluded_phases</td> |
| 90 |
</tr> |
| 91 |
</table> |
| 92 |
</div><div class="memdoc"> |
| 93 |
|
| 94 |
<p>Component phases to exclude, as an OR'ed set of <a class="el" href="a00214.html#ga600bba1a62022d5f516800649b1edb61" title="Discovery phase.">hwloc_disc_phase_t</a>. </p> |
| 95 |
<p>For a GLOBAL component, this usually includes all other phases (<code>~UL</code>).</p> |
| 96 |
<p>Other components only exclude types that may bring conflicting topology information. MISC components should likely not be excluded since they usually bring non-primary additional information. </p> |
| 97 |
|
| 98 |
</div> |
| 99 |
</div> |
| 100 |
<a id="a12e780d0acf89da7a8c8e37e51a3abcb" name="a12e780d0acf89da7a8c8e37e51a3abcb"></a> |
| 101 |
<h2 class="memtitle"><span class="permalink"><a href="#a12e780d0acf89da7a8c8e37e51a3abcb">◆ </a></span>instantiate</h2> |
| 102 |
|
| 103 |
<div class="memitem"> |
| 104 |
<div class="memproto"> |
| 105 |
<table class="memname"> |
| 106 |
<tr> |
| 107 |
<td class="memname">struct <a class="el" href="a00364.html">hwloc_backend</a> *(* hwloc_disc_component::instantiate) (struct hwloc_topology *topology, struct <a class="el" href="a00356.html">hwloc_disc_component</a> *component, unsigned <a class="el" href="#acbb9957914dbf7b8f504215aa0c8d3fe">excluded_phases</a>, const void *data1, const void *data2, const void *data3)</td> |
| 108 |
</tr> |
| 109 |
</table> |
| 110 |
</div><div class="memdoc"> |
| 111 |
|
| 112 |
<p>Instantiate callback to create a backend from the component. Parameters data1, data2, data3 are NULL except for components that have special enabling routines such as <a class="el" href="a00175.html#ga879439b7ee99407ee911b3ac64e9a25e" title="Enable XML-file based topology.">hwloc_topology_set_xml()</a>. </p> |
| 113 |
|
| 114 |
</div> |
| 115 |
</div> |
| 116 |
<a id="a4064c3b5d9213027e87caebef380a840" name="a4064c3b5d9213027e87caebef380a840"></a> |
| 117 |
<h2 class="memtitle"><span class="permalink"><a href="#a4064c3b5d9213027e87caebef380a840">◆ </a></span>name</h2> |
| 118 |
|
| 119 |
<div class="memitem"> |
| 120 |
<div class="memproto"> |
| 121 |
<table class="memname"> |
| 122 |
<tr> |
| 123 |
<td class="memname">const char* hwloc_disc_component::name</td> |
| 124 |
</tr> |
| 125 |
</table> |
| 126 |
</div><div class="memdoc"> |
| 127 |
|
| 128 |
<p>Name. If this component is built as a plugin, this name does not have to match the plugin filename. </p> |
| 129 |
|
| 130 |
</div> |
| 131 |
</div> |
| 132 |
<a id="a61ad3151efa02e3dbad5d919758f9c90" name="a61ad3151efa02e3dbad5d919758f9c90"></a> |
| 133 |
<h2 class="memtitle"><span class="permalink"><a href="#a61ad3151efa02e3dbad5d919758f9c90">◆ </a></span>phases</h2> |
| 134 |
|
| 135 |
<div class="memitem"> |
| 136 |
<div class="memproto"> |
| 137 |
<table class="memname"> |
| 138 |
<tr> |
| 139 |
<td class="memname">unsigned hwloc_disc_component::phases</td> |
| 140 |
</tr> |
| 141 |
</table> |
| 142 |
</div><div class="memdoc"> |
| 143 |
|
| 144 |
<p>Discovery phases performed by this component. OR'ed set of <a class="el" href="a00214.html#ga600bba1a62022d5f516800649b1edb61" title="Discovery phase.">hwloc_disc_phase_t</a>. </p> |
| 145 |
|
| 146 |
</div> |
| 147 |
</div> |
| 148 |
<a id="ae86d283c272c5ae24073a235efbf6b59" name="ae86d283c272c5ae24073a235efbf6b59"></a> |
| 149 |
<h2 class="memtitle"><span class="permalink"><a href="#ae86d283c272c5ae24073a235efbf6b59">◆ </a></span>priority</h2> |
| 150 |
|
| 151 |
<div class="memitem"> |
| 152 |
<div class="memproto"> |
| 153 |
<table class="memname"> |
| 154 |
<tr> |
| 155 |
<td class="memname">unsigned hwloc_disc_component::priority</td> |
| 156 |
</tr> |
| 157 |
</table> |
| 158 |
</div><div class="memdoc"> |
| 159 |
|
| 160 |
<p>Component priority. Used to sort topology->components, higher priority first. Also used to decide between two components with the same name. </p> |
| 161 |
<p>Usual values are 50 for native OS (or platform) components, 45 for x86, 40 for no-OS fallback, 30 for global components (xml, synthetic), 20 for pci, 10 for other misc components (opencl etc.). </p> |
| 162 |
|
| 163 |
</div> |
| 164 |
</div> |
| 165 |
<hr/>The documentation for this struct was generated from the following file:<ul> |
| 166 |
<li><a class="el" href="a00161_source.html">plugins.h</a></li> |
| 167 |
</ul> |
| 168 |
</div><!-- contents --> |
| 169 |
<!-- start footer part --> |
| 170 |
<hr class="footer"/><address class="footer"><small> |
| 171 |
Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.15.0 |
| 172 |
</small></address> |
| 173 |
</div><!-- doc-content --> |
| 174 |
</body> |
| 175 |
</html> |