docs/build.html

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.18.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>mi-malloc: Building</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="codefolding.js"></script>
<script type="text/javascript" src="clipboard.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="cookie.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="mimalloc-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 id="projectrow">
  <td id="projectlogo"><img alt="Logo" src="mimalloc-logo.svg"/></td>
  <td id="projectalign">
   <div id="projectname">mi-malloc<span id="projectnumber">&#160;3.5/2.5/1.15</span>
   </div>
  </td>
    <td>        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <span id="MSearchSelect" class="search-icon"><span class="search-icon-dropdown"></span></span>
          <input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><div id="MSearchCloseImg" class="close-icon"></div></a>
          </span>
        </div>
</td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.18.0 -->
<script type="text/javascript">
let searchBox = new SearchBox("searchBox", "search/",'.html');
</script>
<script type="text/javascript">
document.addEventListener('DOMContentLoaded', codefold.init);
</script>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
document.addEventListener('DOMContentLoaded',() => { initNavTree('build.html','',''); });
</script>
<div id="container">
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>

<div><div class="header">
  <div class="headertitle"><div class="title">Building </div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p>Checkout the sources from GitHub: </p><div class="fragment"><div class="line">git clone https:<span class="comment">//github.com/microsoft/mimalloc</span></div>
</div><!-- fragment --><h2>Windows</h2>
<p>Open <span class="tt">ide/vs2022/mimalloc.sln</span> in Visual Studio 2022 and build. The <span class="tt">mimalloc-lib</span> project builds a static library (in <span class="tt">out/msvc-x64</span>), while the <span class="tt">mimalloc-override-dll</span> project builds a DLL for overriding malloc in the entire program.</p>
<h2>Linux, macOS, BSD, etc.</h2>
<p>We use <a href="https://cmake.org"><span class="tt">cmake</span></a> as the build system:</p>
<div class="fragment"><div class="line">&gt; mkdir -p out/release</div>
<div class="line">&gt; cd out/release</div>
<div class="line">&gt; cmake ../..</div>
<div class="line">&gt; make</div>
</div><!-- fragment --><p> This builds the library as a shared (dynamic) library (<span class="tt">.so</span> or <span class="tt">.dylib</span>), a static library (<span class="tt">.a</span>), and as a single object file (<span class="tt">.o</span>).</p>
<p><span class="tt">&gt; sudo make install</span> (install the library and header files in <span class="tt">/usr/local/lib</span> and <span class="tt">/usr/local/include</span>)</p>
<p>You can build the debug version which does many internal checks and maintains detailed statistics as:</p>
<div class="fragment"><div class="line">&gt; mkdir -p out/debug</div>
<div class="line">&gt; cd out/debug</div>
<div class="line">&gt; cmake -DCMAKE_BUILD_TYPE=Debug ../..</div>
<div class="line">&gt; make</div>
</div><!-- fragment --><p>This will name the shared library as <span class="tt">libmimalloc-debug.so</span>.</p>
<p>Finally, you can build a <em>secure</em> version that uses guard pages, encrypted free lists, etc., as:</p>
<div class="fragment"><div class="line">&gt; mkdir -p out/secure</div>
<div class="line">&gt; cd out/secure</div>
<div class="line">&gt; cmake -DMI_SECURE=ON ../..</div>
<div class="line">&gt; make</div>
</div><!-- fragment --><p>This will name the shared library as <span class="tt">libmimalloc-secure.so</span>. Use <span class="tt">cmake ../.. -LH</span> to see all the available build options.</p>
<p>The examples use the default compiler. If you like to use another, use:</p>
<div class="fragment"><div class="line">&gt; CC=clang CXX=clang++ cmake ../..</div>
</div><!-- fragment --><h2>Cmake with Visual Studio</h2>
<p>You can also use cmake on Windows. Open a Visual Studio 2022 development prompt and invoke <span class="tt">cmake</span> with the right <a href="https://cmake.org/cmake/help/latest/generator/Visual%20Studio%2017%202022.html">generator</a> and architecture, like:</p>
<div class="fragment"><div class="line">&gt; cmake ..\.. -G <span class="stringliteral">&quot;Visual Studio 17 2022&quot;</span> -A x64 -DMI_OVERRIDE=ON</div>
</div><!-- fragment --><p>The cmake build type is specified when actually building, for example:</p>
<div class="fragment"><div class="line">&gt; cmake --build . --config=Release</div>
</div><!-- fragment --><p>You can also install the <a href="https://learn.microsoft.com/en-us/cpp/build/clang-support-msbuild?view=msvc-170#install-1">LLVM toolset</a> on Windows to build with the <span class="tt">clang-cl</span> compiler directly:</p>
<div class="fragment"><div class="line">&gt; cmake ../.. -G <span class="stringliteral">&quot;Visual Studio 17 2022&quot;</span> -T ClangCl</div>
</div><!-- fragment --><h2>Single Source</h2>
<p>You can also directly build the single <span class="tt">src/static.c</span> file as part of your project without needing <span class="tt">cmake</span> at all. Make sure to also add the mimalloc <span class="tt">include</span> directory to the include path. </p>
</div></div><!-- contents -->
</div><!-- PageDoc -->
</div><!-- doc-content -->
</div><!-- container -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.18.0 </li>
  </ul>
</div>
</body>
</html>