| 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): Installation</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><div class="header"> |
| 45 |
<div class="headertitle"><div class="title">Installation </div></div> |
| 46 |
</div><!--header--> |
| 47 |
<div class="contents"> |
| 48 |
<div class="textblock"><p>hwloc (<a href="https://www.open-mpi.org/projects/hwloc/">https://www.open-mpi.org/projects/hwloc/</a>) is available under the BSD license. It is hosted as a sub-project of the overall Open MPI project (<a href="https://www.open-mpi.org/">https://www.open-mpi.org/</a>). Note that hwloc does not require any functionality from Open MPI – it is a wholly separate (and much smaller!) project and code base. It just happens to be hosted as part of the overall Open MPI project.</p> |
| 49 |
<h1 class="doxsection"><a class="anchor" id="basic_installation"></a> |
| 50 |
Basic Installation</h1> |
| 51 |
<p>Installation is the fairly common GNU-based process:</p> |
| 52 |
<pre class="fragment">shell$ ./configure --prefix=... |
| 53 |
shell$ make |
| 54 |
shell$ make install |
| 55 |
</pre><p>The hwloc command-line tool "lstopo" produces human-readable topology maps, as mentioned above. Running the "lstopo" tool is a good way to check as a graphical output whether hwloc properly detected the architecture of your node.</p> |
| 56 |
<h1 class="doxsection"><a class="anchor" id="optional_dependencies"></a> |
| 57 |
Optional Dependencies</h1> |
| 58 |
<p>lstopo may also export graphics to the SVG and "fig" file formats. Support for PDF, Postscript, and PNG exporting is provided if the "Cairo" development package (usually <span class="tt">cairo-devel</span> or <span class="tt">libcairo2-dev</span>) can be found in "lstopo" when hwloc is configured and build. <br /> |
| 59 |
</p> |
| 60 |
<p>The hwloc core may also benefit from the following development packages: </p><ul> |
| 61 |
<li> |
| 62 |
libpciaccess for full I/O device discovery (<span class="tt">libpciaccess-devel</span> or <span class="tt">libpciaccess-dev</span> package). On Linux, PCI discovery may still be performed (without vendor/device names) even if libpciaccess cannot be used. </li> |
| 63 |
<li> |
| 64 |
AMD or NVIDIA OpenCL implementations for OpenCL device discovery. </li> |
| 65 |
<li> |
| 66 |
the NVIDIA CUDA Toolkit for CUDA device discovery. See <a class="el" href="a00386.html#faq_cuda_build">How do I enable CUDA and select which CUDA version to use?</a>. </li> |
| 67 |
<li> |
| 68 |
the NVIDIA Management Library (NVML) for NVML device discovery. It is included in CUDA since version 8.0. Older NVML releases were available within the NVIDIA GPU Deployment Kit from <a href="https://developer.nvidia.com/gpu-deployment-kit">https://developer.nvidia.com/gpu-deployment-kit</a> . </li> |
| 69 |
<li> |
| 70 |
the NV-CONTROL X extension library (NVCtrl) for NVIDIA display discovery. The relevant development package is usually <span class="tt">libXNVCtrl-devel</span> or <span class="tt">libxnvctrl-dev</span>. It is also available within nvidia-settings from <a href="ftp://download.nvidia.com/XFree86/nvidia-settings/">ftp://download.nvidia.com/XFree86/nvidia-settings/</a> and <a href="https://github.com/NVIDIA/nvidia-settings/">https://github.com/NVIDIA/nvidia-settings/</a> . </li> |
| 71 |
<li> |
| 72 |
the AMD SMI library for RSMI device discovery. The relevant development package is usually <span class="tt">amd-smi-lib</span> or <span class="tt">libamd-smi-dev</span>. If AMD SMI isn't available, the old ROCm SMI library may be used instead (<span class="tt">rocm-smi-lib</span> or <span class="tt">librocm-smi-dev</span> package). See <a class="el" href="a00386.html#faq_rocm_build">How do I enable AMD/ROCm SMI and select which version to use?</a>. </li> |
| 73 |
<li> |
| 74 |
the oneAPI Level Zero library. The relevant development package is usually <span class="tt">level-zero-dev</span> or <span class="tt">level-zero-devel</span>. The implementation must be recent enough to support <span class="tt">zesDriverGetDeviceByUuidExp()</span> </li> |
| 75 |
<li> |
| 76 |
libxml2 for full XML import/export support (otherwise, the internal minimalistic parser will only be able to import XML files that were exported by the same hwloc release). See <a class="el" href="a00380.html">Importing and exporting topologies from/to XML files</a> for details. The relevant development package is usually <span class="tt">libxml2-devel</span> or <span class="tt">libxml2-dev</span>. </li> |
| 77 |
<li> |
| 78 |
libudev on Linux for easier discovery of OS device information (otherwise hwloc will try to manually parse udev raw files). The relevant development package is usually <span class="tt">libudev-devel</span> or <span class="tt">libudev-dev</span>. </li> |
| 79 |
<li> |
| 80 |
libtool's ltdl library for dynamic plugin loading on Unix systems if the native dlopen cannot be used. The relevant development package is usually <span class="tt">libtool-ltdl-devel</span> or <span class="tt">libltdl-dev</span>. </li> |
| 81 |
</ul> |
| 82 |
<p>PCI and XML support may be statically built inside the main hwloc library, or as separate dynamically-loaded plugins (see the <a class="el" href="a00384.html">Components and plugins</a> section).</p> |
| 83 |
<p>Also note that if you install supplemental libraries in non-standard locations, hwloc's configure script may not be able to find them without some help. You may need to specify additional CPPFLAGS, LDFLAGS, or PKG_CONFIG_PATH values on the configure command line.</p> |
| 84 |
<p>For example, if libpciaccess was installed into /opt/pciaccess, hwloc's configure script may not find it by default. Try adding PKG_CONFIG_PATH to the ./configure command line, like this:</p> |
| 85 |
<pre class="fragment">./configure PKG_CONFIG_PATH=/opt/pciaccess/lib/pkgconfig ... |
| 86 |
</pre><p>Note that because of the possibility of GPL taint, the <span class="tt">pciutils</span> library <span class="tt">libpci</span> will not be used (remember that hwloc is BSD-licensed).</p> |
| 87 |
<h1 class="doxsection"><a class="anchor" id="gitclone_installation"></a> |
| 88 |
Installing from a Git clone</h1> |
| 89 |
<p>Additionally, the code can be directly cloned from Git:</p> |
| 90 |
<pre class="fragment">shell$ git clone https://github.com/open-mpi/hwloc.git |
| 91 |
shell$ cd hwloc |
| 92 |
shell$ ./autogen.sh |
| 93 |
</pre><p>Note that GNU Autoconf >=2.63, Automake >=1.11 and Libtool >=2.2.6 are required when building from a Git clone.</p> |
| 94 |
<p>Nightly development snapshots are available on the web site, they can be configured and built without any need for Git or GNU Autotools. </p> |
| 95 |
</div></div><!-- contents --> |
| 96 |
</div><!-- PageDoc --> |
| 97 |
<!-- start footer part --> |
| 98 |
<hr class="footer"/><address class="footer"><small> |
| 99 |
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 |
| 100 |
</small></address> |
| 101 |
</div><!-- doc-content --> |
| 102 |
</body> |
| 103 |
</html> |