2019-07-09 00:15:34 +00:00
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2019-06-22 17:30:09 +00:00
< html xmlns = "http://www.w3.org/1999/xhtml" >
< head >
< meta http-equiv = "Content-Type" content = "text/xhtml;charset=UTF-8" / >
< meta http-equiv = "X-UA-Compatible" content = "IE=9" / >
2019-07-09 00:15:34 +00:00
< meta name = "generator" content = "Doxygen 1.8.15" / >
2019-06-22 17:30:09 +00:00
< meta name = "viewport" content = "width=device-width, initial-scale=1" / >
< title > mi-malloc: Overriding Malloc< / title >
< link href = "tabs.css" rel = "stylesheet" type = "text/css" / >
< script type = "text/javascript" src = "jquery.js" > < / script >
< script type = "text/javascript" src = "dynsections.js" > < / script >
< link href = "navtree.css" rel = "stylesheet" type = "text/css" / >
< script type = "text/javascript" src = "resize.js" > < / script >
< script type = "text/javascript" src = "navtreedata.js" > < / script >
< script type = "text/javascript" src = "navtree.js" > < / script >
< script type = "text/javascript" >
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3& dn=gpl-2.0.txt GPL-v2 */
$(document).ready(initResizable);
/* @license-end */< / 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 >
< script type = "text/javascript" >
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3& dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function() { init_search(); });
/* @license-end */
< / 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 style = "height: 56px;" >
< td id = "projectlogo" > < img alt = "Logo" src = "mimalloc-logo.svg" / > < / td >
< td id = "projectalign" style = "padding-left: 0.5em;" >
< div id = "projectname" > mi-malloc
  < span id = "projectnumber" > 1.0< / span >
< / div >
< / td >
< td > < div id = "MSearchBox" class = "MSearchBoxInactive" >
< span class = "left" >
< img id = "MSearchSelect" src = "search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
< input type = "text" id = "MSearchField" value = "Search" accesskey = "S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
< / span > < span class = "right" >
< a id = "MSearchClose" href = "javascript:searchBox.CloseResultsWindow()" > < img id = "MSearchCloseImg" border = "0" src = "search/close.png" alt = "" / > < / a >
< / span >
< / div >
< / td >
< / tr >
< / tbody >
< / table >
< / div >
<!-- end header part -->
2019-07-09 00:15:34 +00:00
<!-- Generated by Doxygen 1.8.15 -->
2019-06-22 17:30:09 +00:00
< script type = "text/javascript" >
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3& dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
< / 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" style = "-moz-user-select:none;"
class="ui-resizable-handle">
< / div >
< / div >
< script type = "text/javascript" >
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3& dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('overrides.html','');});
/* @license-end */
< / script >
< div id = "doc-content" >
<!-- window showing the filter options -->
< div id = "MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
< / div >
<!-- iframe showing the search results (closed by default) -->
< div id = "MSearchResultsWindow" >
< iframe src = "javascript:void(0)" frameborder = "0"
name="MSearchResults" id="MSearchResults">
< / iframe >
< / div >
2019-07-09 00:15:34 +00:00
< div class = "PageDoc" > < div class = "header" >
2019-06-22 17:30:09 +00:00
< div class = "headertitle" >
< div class = "title" > Overriding Malloc < / div > < / div >
< / div > <!-- header -->
< div class = "contents" >
< div class = "textblock" > < p > Overriding the standard < code > malloc< / code > can be done either < em > dynamically< / em > or < em > statically< / em > .< / p >
< h2 > Dynamic override< / h2 >
< p > This is the recommended way to override the standard malloc interface.< / p >
2019-06-23 07:29:41 +00:00
< h3 > Unix, BSD, macOS< / h3 >
2019-06-22 17:30:09 +00:00
< p > On these systems we preload the mimalloc shared library so all calls to the standard < code > malloc< / code > interface are resolved to the < em > mimalloc< / em > library.< / p >
< ul >
< li > < code > env LD_PRELOAD=/usr/lib/libmimalloc.so myprogram< / code > (on Linux, BSD, etc.)< / li >
2019-07-21 20:45:40 +00:00
< li > < p class = "startli" > < code > env DYLD_INSERT_LIBRARIES=/usr/lib/libmimalloc.dylib myprogram< / code > (On macOS)< / p >
2019-06-22 17:30:09 +00:00
< p class = "startli" > Note certain security restrictions may apply when doing this from the < a href = "https://stackoverflow.com/questions/43941322/dyld-insert-libraries-ignored-when-calling-application-through-bash" > shell< / a > .< / p >
< / li >
< / ul >
2019-07-09 00:15:34 +00:00
< p > You can set extra environment variables to check that mimalloc is running, like: < / p > < div class = "fragment" > < div class = "line" > env MIMALLOC_VERBOSE=1 LD_PRELOAD=/usr/lib/libmimalloc.so myprogram< / div > < / div > <!-- fragment --> < p > or run with the debug version to get detailed statistics: < / p > < div class = "fragment" > < div class = "line" > env MIMALLOC_SHOW_STATS=1 LD_PRELOAD=/usr/lib/libmimalloc-debug.so myprogram< / div > < / div > <!-- fragment --> < h3 > Windows< / h3 >
2019-06-22 17:30:09 +00:00
< p > On Windows you need to link your program explicitly with the mimalloc DLL, and use the C-runtime library as a DLL (the < code > /MD< / code > or < code > /MDd< / code > switch). To ensure the mimalloc DLL gets loaded it is easiest to insert some call to the mimalloc API in the < code > main< / code > function, like < code > mi_version()< / code > .< / p >
< p > Due to the way mimalloc intercepts the standard malloc at runtime, it is best to link to the mimalloc import library first on the command line so it gets loaded right after the universal C runtime DLL (< code > ucrtbase< / code > ). See the < code > mimalloc-override-test< / code > project for an example.< / p >
< h2 > Static override< / h2 >
< p > On Unix systems, you can also statically link with < em > mimalloc< / em > to override the standard malloc interface. The recommended way is to link the final program with the < em > mimalloc< / em > single object file (< code > mimalloc-override.o< / code > ). We use an object file instead of a library file as linkers give preference to that over archives to resolve symbols. To ensure that the standard malloc interface resolves to the < em > mimalloc< / em > library, link it as the first object file. For example:< / p >
< div class = "fragment" > < div class = "line" > gcc -o myprogram mimalloc-< span class = "keyword" > override< / span > .o myfile1.c ...< / div > < / div > <!-- fragment --> < h2 > List of Overrides:< / h2 >
< p > The specific functions that get redirected to the < em > mimalloc< / em > library are:< / p >
2019-07-09 00:15:34 +00:00
< div class = "fragment" > < div class = "line" > < span class = "comment" > // C< / span > < / div > < div class = "line" > < span class = "keywordtype" > void< / span > * malloc(< span class = "keywordtype" > size_t< / span > size);< / div > < div class = "line" > < span class = "keywordtype" > void< / span > * calloc(< span class = "keywordtype" > size_t< / span > size, < span class = "keywordtype" > size_t< / span > n);< / div > < div class = "line" > < span class = "keywordtype" > void< / span > * realloc(< span class = "keywordtype" > void< / span > * p, < span class = "keywordtype" > size_t< / span > newsize);< / div > < div class = "line" > < span class = "keywordtype" > void< / span > free(< span class = "keywordtype" > void< / span > * p);< / div > < div class = "line" > < / div > < div class = "line" > < span class = "comment" > // C++< / span > < / div > < div class = "line" > < span class = "keywordtype" > void< / span > < span class = "keyword" > operator< / span > < span class = "keyword" > delete< / span > (< span class = "keywordtype" > void< / span > * p);< / div > < div class = "line" > < span class = "keywordtype" > void< / span > < span class = "keyword" > operator< / span > < span class = "keyword" > delete< / span > [](< span class = "keywordtype" > void< / span > * p);< / div > < div class = "line" > < / div > < div class = "line" > < span class = "keywordtype" > void< / span > * < span class = "keyword" > operator< / span > < span class = "keyword" > new< / span > (std::size_t n) noexcept(< span class = "keyword" > false< / span > );< / div > < div class = "line" > < span class = "keywordtype" > void< / span > * < span class = "keyword" > operator< / span > < span class = "keyword" > new< / span > [](std::size_t n) noexcept(< span class = "keyword" > false< / span > );< / div > < div class = "line" > < span class = "keywordtype" > void< / span > * < span class = "keyword" > operator< / span > < span class = "keyword" > new< / span > ( std::size_t n, std::align_val_t align) noexcept(< span class = "keyword" > false< / span > );< / div > < div class = "line" > < span class = "keywordtype" > void< / span > * < span class = "keyword" > operator< / span > < span class = "keyword" > new< / span > []( std::size_t n, std::align_val_t align) noexcept(< span class = "keyword" > false< / span > );< / div > < div class = "line" > < / div > < div class = "line" > < span class = "keywordtype" > void< / span > * < span class = "keyword" > operator< / span > < span class = "keyword" > new< / span > ( std::size_t count, < span class = "keyword" > const< / span > std::nothrow_t& tag);< / div > < div class = "line" > < span class = "keywordtype" > void< / span > * < span class = "keyword" > operator< / span > < span class = "keyword" > new< / span > []( std::size_t count, < span class = "keyword" > const< / span > std::nothrow_t& tag);< / div > < div class = "line" > < span class = "keywordtype" > void< / span > * < span class = "keyword" > operator< / span > < span class = "keyword" > new< / span > ( std::size_t count, std::align_val_t al, < span class = "keyword" > const< / span > std::nothrow_t& );< / div > < div class = "line" > < span class = "keywordtype" > void< / span > * < span class = "keyword" > operator< / span > < span class = "keyword" > new< / span > []( std::size_t count, std::align_val_t al, < span class = "keyword" > const< / span > std::nothrow_t& );< / div > < div class = "line" > < / div > < div class = "line" > < span class = "comment" > // Posix< / span > < / div > < div class = "line" > < span class = "keywordtype" > int< / span > posix_memalign(< span class = "keywordtype" > void< / span > ** p, < span class = "keywordtype" > size_t< / span > alignment, < span class = "keywordtype" > size_t< / span > size);< / div > < div class = "line" > < / div > < div class = "line" > < span class = "comment" > // Linux< / span > < / div > < div class = "line" > < span class = "keywordtype" > void< / span > * memalign(< span class = "keywordtype" > size_t< / span > alignment, < span class = "keywordtype" > size_t< / span > size);< / div > < div class = "line" > < span class = "keywordtype" > void< / span > * aligned_alloc(< span class = "keywordtype" > size_t< / span > alignment, < span class = "keywordtype" > size_t< / span > size);< / div > < div class = "line" > < span class = "keywordtype" > void< / span > * valloc(< span class = "keywordtype" > size_t< / span > size);< / div > < div class = "line" > < span class = "keywordtype" > void< / span > * pvalloc(< span class = "keywordtype" > size_t< / span > size);< / div > < div class = "line" > < span class = "keywordtype" > size_t< / span > malloc_usable_size(< span class = "keywordtype" > void< / span > *p);< / div > < div class = "line" > < / div > < div class = "line" > < span class = "comment" > // BSD< / span > < / div > < div class = "line" > < span class = "keywordtype" > void< / span > * r
< / div > <!-- contents -->
2019-06-22 17:30:09 +00:00
< / div > <!-- doc - content -->
<!-- start footer part -->
< div id = "nav-path" class = "navpath" > <!-- id is needed for treeview function! -->
< ul >
< li class = "footer" > Generated by
< a href = "http://www.doxygen.org/index.html" >
2019-07-09 00:15:34 +00:00
< img class = "footer" src = "doxygen.png" alt = "doxygen" / > < / a > 1.8.15 < / li >
2019-06-22 17:30:09 +00:00
< / ul >
< / div >
< / body >
< / html >
