| |
| <!DOCTYPE html> |
| |
| <html lang="en"> |
| <head> |
| <meta charset="utf-8" /> |
| <meta name="viewport" content="width=device-width, initial-scale=1.0" /> |
| <title>ProcessorCount — CMake 3.23.1 Documentation</title> |
| |
| <link rel="stylesheet" type="text/css" href="../_static/pygments.css" /> |
| <link rel="stylesheet" type="text/css" href="../_static/cmake.css" /> |
| |
| <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script> |
| <script src="../_static/jquery.js"></script> |
| <script src="../_static/underscore.js"></script> |
| <script src="../_static/doctools.js"></script> |
| |
| <link rel="shortcut icon" href="../_static/cmake-favicon.ico"/> |
| <link rel="index" title="Index" href="../genindex.html" /> |
| <link rel="search" title="Search" href="../search.html" /> |
| <link rel="next" title="SelectLibraryConfigurations" href="SelectLibraryConfigurations.html" /> |
| <link rel="prev" title="InstallRequiredSystemLibraries" href="InstallRequiredSystemLibraries.html" /> |
| |
| |
| </head><body> |
| |
| <div class="related" role="navigation" aria-label="related navigation"> |
| <h3>Navigation</h3> |
| <ul> |
| <li class="right" style="margin-right: 10px"> |
| <a href="../genindex.html" title="General Index" |
| accesskey="I">index</a></li> |
| <li class="right" > |
| <a href="SelectLibraryConfigurations.html" title="SelectLibraryConfigurations" |
| accesskey="N">next</a> |</li> |
| <li class="right" > |
| <a href="InstallRequiredSystemLibraries.html" title="InstallRequiredSystemLibraries" |
| accesskey="P">previous</a> |</li> |
| <li> |
| <img src="../_static/cmake-logo-16.png" alt="" |
| style="vertical-align: middle; margin-top: -2px" /> |
| </li> |
| <li> |
| <a href="https://cmake.org/">CMake</a> » |
| </li> |
| <li> |
| <a href="../index.html">3.23.1 Documentation</a> » |
| </li> |
| |
| <li class="nav-item nav-item-1"><a href="../manual/cmake-modules.7.html" accesskey="U">cmake-modules(7)</a> »</li> |
| <li class="nav-item nav-item-this"><a href="">ProcessorCount</a></li> |
| </ul> |
| </div> |
| |
| <div class="document"> |
| <div class="documentwrapper"> |
| <div class="bodywrapper"> |
| <div class="body" role="main"> |
| |
| <div class="section" id="processorcount"> |
| <span id="module:ProcessorCount"></span><h1>ProcessorCount<a class="headerlink" href="#processorcount" title="Permalink to this headline">ΒΆ</a></h1> |
| <p>ProcessorCount(var)</p> |
| <p>Determine the number of processors/cores and save value in ${var}</p> |
| <p>Sets the variable named ${var} to the number of physical cores |
| available on the machine if the information can be determined. |
| Otherwise it is set to 0. Currently this functionality is implemented |
| for AIX, cygwin, FreeBSD, HPUX, Linux, macOS, QNX, Sun and |
| Windows.</p> |
| <div class="versionchanged"> |
| <p><span class="versionmodified changed">Changed in version 3.15: </span>On Linux, returns the container CPU count instead of the host CPU count.</p> |
| </div> |
| <p>This function is guaranteed to return a positive integer (>=1) if it |
| succeeds. It returns 0 if there's a problem determining the processor |
| count.</p> |
| <p>Example use, in a ctest -S dashboard script:</p> |
| <div class="highlight-none notranslate"><div class="highlight"><pre><span></span>include(ProcessorCount) |
| ProcessorCount(N) |
| if(NOT N EQUAL 0) |
| set(CTEST_BUILD_FLAGS -j${N}) |
| set(ctest_test_args ${ctest_test_args} PARALLEL_LEVEL ${N}) |
| endif() |
| </pre></div> |
| </div> |
| <p>This function is intended to offer an approximation of the value of |
| the number of compute cores available on the current machine, such |
| that you may use that value for parallel building and parallel |
| testing. It is meant to help utilize as much of the machine as seems |
| reasonable. Of course, knowledge of what else might be running on the |
| machine simultaneously should be used when deciding whether to request |
| a machine's full capacity all for yourself.</p> |
| </div> |
| |
| |
| <div class="clearer"></div> |
| </div> |
| </div> |
| </div> |
| <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> |
| <div class="sphinxsidebarwrapper"> |
| <h4>Previous topic</h4> |
| <p class="topless"><a href="InstallRequiredSystemLibraries.html" |
| title="previous chapter">InstallRequiredSystemLibraries</a></p> |
| <h4>Next topic</h4> |
| <p class="topless"><a href="SelectLibraryConfigurations.html" |
| title="next chapter">SelectLibraryConfigurations</a></p> |
| <div role="note" aria-label="source link"> |
| <h3>This Page</h3> |
| <ul class="this-page-menu"> |
| <li><a href="../_sources/module/ProcessorCount.rst.txt" |
| rel="nofollow">Show Source</a></li> |
| </ul> |
| </div> |
| <div id="searchbox" style="display: none" role="search"> |
| <h3 id="searchlabel">Quick search</h3> |
| <div class="searchformwrapper"> |
| <form class="search" action="../search.html" method="get"> |
| <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/> |
| <input type="submit" value="Go" /> |
| </form> |
| </div> |
| </div> |
| <script>$('#searchbox').show(0);</script> |
| </div> |
| </div> |
| <div class="clearer"></div> |
| </div> |
| <div class="related" role="navigation" aria-label="related navigation"> |
| <h3>Navigation</h3> |
| <ul> |
| <li class="right" style="margin-right: 10px"> |
| <a href="../genindex.html" title="General Index" |
| >index</a></li> |
| <li class="right" > |
| <a href="SelectLibraryConfigurations.html" title="SelectLibraryConfigurations" |
| >next</a> |</li> |
| <li class="right" > |
| <a href="InstallRequiredSystemLibraries.html" title="InstallRequiredSystemLibraries" |
| >previous</a> |</li> |
| <li> |
| <img src="../_static/cmake-logo-16.png" alt="" |
| style="vertical-align: middle; margin-top: -2px" /> |
| </li> |
| <li> |
| <a href="https://cmake.org/">CMake</a> » |
| </li> |
| <li> |
| <a href="../index.html">3.23.1 Documentation</a> » |
| </li> |
| |
| <li class="nav-item nav-item-1"><a href="../manual/cmake-modules.7.html" >cmake-modules(7)</a> »</li> |
| <li class="nav-item nav-item-this"><a href="">ProcessorCount</a></li> |
| </ul> |
| </div> |
| |
| <div class="footer" role="contentinfo"> |
| © Copyright 2000-2022 Kitware, Inc. and Contributors. |
| Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 4.1.2. |
| </div> |
| </body> |
| </html> |
