libmimalloc-sys2 0.1.53

Sys crate wrapping the mimalloc allocator
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
<!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.11.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>mi-malloc: Thread-local heaps</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>
<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="resize.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>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  $(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 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;1.8/2.1</span>
   </div>
  </td>
    <td>        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <span id="MSearchSelect"                onmouseover="return searchBox.OnSearchSelectShow()"                onmouseout="return searchBox.OnSearchSelectHide()">&#160;</span>
          <input type="text" id="MSearchField" value="" placeholder="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.svg" alt=""/></a>
          </span>
        </div>
</td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.11.0 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @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:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){initNavTree('group__theap.html',''); initResizable(true); });
/* @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">
<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 class="header">
  <div class="summary">
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle"><div class="title">Thread-local heaps</div></div>
</div><!--header-->
<div class="contents">

<p><b>v3</b>: Thread local heaps.  
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="typedef-members" name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:ga8722f6ac4f638b4692e06ddfddc844f8" id="r_ga8722f6ac4f638b4692e06ddfddc844f8"><td class="memItemLeft" align="right" valign="top">typedef struct mi_theap_s&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ga8722f6ac4f638b4692e06ddfddc844f8">mi_theap_t</a></td></tr>
<tr class="memdesc:ga8722f6ac4f638b4692e06ddfddc844f8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Type of thread-local heaps.  <br /></td></tr>
<tr class="separator:ga8722f6ac4f638b4692e06ddfddc844f8"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga7905a73865733da8a43339a500533180" id="r_ga7905a73865733da8a43339a500533180"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#ga8722f6ac4f638b4692e06ddfddc844f8">mi_theap_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ga7905a73865733da8a43339a500533180">mi_heap_theap</a> (<a class="el" href="group__heap.html#ga34a47cde5a5b38c29f1aa3c5e76943c2">mi_heap_t</a> *heap)</td></tr>
<tr class="memdesc:ga7905a73865733da8a43339a500533180"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the thread-local theap for the given heap.  <br /></td></tr>
<tr class="separator:ga7905a73865733da8a43339a500533180"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga9377a43095b8dd14996613ceb73d9a32" id="r_ga9377a43095b8dd14996613ceb73d9a32"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ga9377a43095b8dd14996613ceb73d9a32">mi_theap_collect</a> (<a class="el" href="#ga8722f6ac4f638b4692e06ddfddc844f8">mi_theap_t</a> *theap, bool force)</td></tr>
<tr class="memdesc:ga9377a43095b8dd14996613ceb73d9a32"><td class="mdescLeft">&#160;</td><td class="mdescRight">Release outstanding resources in a specific theap.  <br /></td></tr>
<tr class="separator:ga9377a43095b8dd14996613ceb73d9a32"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga04420ce52785019412397e4de24a984a" id="r_ga04420ce52785019412397e4de24a984a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#ga8722f6ac4f638b4692e06ddfddc844f8">mi_theap_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ga04420ce52785019412397e4de24a984a">mi_theap_set_default</a> (<a class="el" href="#ga8722f6ac4f638b4692e06ddfddc844f8">mi_theap_t</a> *theap)</td></tr>
<tr class="memdesc:ga04420ce52785019412397e4de24a984a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the default thread-local theap to use in the current thread for <a class="el" href="group__malloc.html#gae1dd97b542420c87ae085e822b1229e8" title="Allocate size bytes.">mi_malloc()</a> et al.  <br /></td></tr>
<tr class="separator:ga04420ce52785019412397e4de24a984a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga78afbb07c1e0cd333c7539cf7403dfd5" id="r_ga78afbb07c1e0cd333c7539cf7403dfd5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#ga8722f6ac4f638b4692e06ddfddc844f8">mi_theap_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ga78afbb07c1e0cd333c7539cf7403dfd5">mi_theap_get_default</a> ()</td></tr>
<tr class="memdesc:ga78afbb07c1e0cd333c7539cf7403dfd5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the default theap that is used for <a class="el" href="group__malloc.html#gae1dd97b542420c87ae085e822b1229e8" title="Allocate size bytes.">mi_malloc()</a> et al. for the current thread.  <br /></td></tr>
<tr class="separator:ga78afbb07c1e0cd333c7539cf7403dfd5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac7308e029c59e6675dd5ab5ec54f304a" id="r_gac7308e029c59e6675dd5ab5ec54f304a"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#gac7308e029c59e6675dd5ab5ec54f304a">mi_theap_malloc</a> (<a class="el" href="#ga8722f6ac4f638b4692e06ddfddc844f8">mi_theap_t</a> *theap, size_t size)</td></tr>
<tr class="memdesc:gac7308e029c59e6675dd5ab5ec54f304a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allocate in a specific theap.  <br /></td></tr>
<tr class="separator:gac7308e029c59e6675dd5ab5ec54f304a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga1fc65302a212daaecb21abda96ff247c" id="r_ga1fc65302a212daaecb21abda96ff247c"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ga1fc65302a212daaecb21abda96ff247c">mi_theap_malloc_small</a> (<a class="el" href="#ga8722f6ac4f638b4692e06ddfddc844f8">mi_theap_t</a> *theap, size_t size)</td></tr>
<tr class="memdesc:ga1fc65302a212daaecb21abda96ff247c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allocate a small object in a specific theap. <em>size</em> must be smaller or equal to <a class="el" href="group__extended.html#ga1ea64283508718d9d645c38efc2f4305" title="Maximum size allowed for small allocations in mi_malloc_small, mi_zalloc_small, mi_heap_malloc_small,...">MI_SMALL_SIZE_MAX()</a>.  <br /></td></tr>
<tr class="separator:ga1fc65302a212daaecb21abda96ff247c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaa7fd973dcd8c75eb05707bdeffbc06f7" id="r_gaa7fd973dcd8c75eb05707bdeffbc06f7"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#gaa7fd973dcd8c75eb05707bdeffbc06f7">mi_theap_zalloc</a> (<a class="el" href="#ga8722f6ac4f638b4692e06ddfddc844f8">mi_theap_t</a> *theap, size_t size)</td></tr>
<tr class="memdesc:gaa7fd973dcd8c75eb05707bdeffbc06f7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allocate zero-initialized in a specific heap.  <br /></td></tr>
<tr class="separator:gaa7fd973dcd8c75eb05707bdeffbc06f7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaa85fccf9d40af3e826c5932aded1d534" id="r_gaa85fccf9d40af3e826c5932aded1d534"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#gaa85fccf9d40af3e826c5932aded1d534">mi_theap_zalloc_small</a> (<a class="el" href="#ga8722f6ac4f638b4692e06ddfddc844f8">mi_theap_t</a> *theap, size_t size)</td></tr>
<tr class="memdesc:gaa85fccf9d40af3e826c5932aded1d534"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allocate a small object in a specific theap. <em>size</em> must be smaller or equal to <a class="el" href="group__extended.html#ga1ea64283508718d9d645c38efc2f4305" title="Maximum size allowed for small allocations in mi_malloc_small, mi_zalloc_small, mi_heap_malloc_small,...">MI_SMALL_SIZE_MAX()</a>.  <br /></td></tr>
<tr class="separator:gaa85fccf9d40af3e826c5932aded1d534"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gadbf8f27bfe9edf7834e19d32cab63edc" id="r_gadbf8f27bfe9edf7834e19d32cab63edc"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#gadbf8f27bfe9edf7834e19d32cab63edc">mi_theap_calloc</a> (<a class="el" href="#ga8722f6ac4f638b4692e06ddfddc844f8">mi_theap_t</a> *theap, size_t count, size_t size)</td></tr>
<tr class="separator:gadbf8f27bfe9edf7834e19d32cab63edc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga84503fc2bd83fbfb7f789b7d80d76f36" id="r_ga84503fc2bd83fbfb7f789b7d80d76f36"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ga84503fc2bd83fbfb7f789b7d80d76f36">mi_theap_malloc_aligned</a> (<a class="el" href="#ga8722f6ac4f638b4692e06ddfddc844f8">mi_theap_t</a> *theap, size_t size, size_t alignment)</td></tr>
<tr class="separator:ga84503fc2bd83fbfb7f789b7d80d76f36"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga11943128dc354313c4189e72f4299dbb" id="r_ga11943128dc354313c4189e72f4299dbb"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ga11943128dc354313c4189e72f4299dbb">mi_theap_realloc</a> (<a class="el" href="#ga8722f6ac4f638b4692e06ddfddc844f8">mi_theap_t</a> *theap, void *p, size_t newsize)</td></tr>
<tr class="separator:ga11943128dc354313c4189e72f4299dbb"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p><b>v3</b>: Thread local heaps. </p>
<p>The use of thread-local heaps is discouraged and only recommended for special cases like runtime systems that keep their own thread-local state. The "theaps" are thread-local heaps that <b>v3</b> uses internally to implement efficient first-class heaps.</p>
<p><b>v1</b>,<b>v2</b>: the <code>mi_heap_t</code> heaps in v1/v2 are exactly these <code>mi_theap_t</code> theaps in v3. </p>
<h2 class="groupheader">Typedef Documentation</h2>
<a id="ga8722f6ac4f638b4692e06ddfddc844f8" name="ga8722f6ac4f638b4692e06ddfddc844f8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga8722f6ac4f638b4692e06ddfddc844f8">&#9670;&#160;</a></span>mi_theap_t</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef struct mi_theap_s <a class="el" href="#ga8722f6ac4f638b4692e06ddfddc844f8">mi_theap_t</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Type of thread-local heaps. </p>

</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga7905a73865733da8a43339a500533180" name="ga7905a73865733da8a43339a500533180"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga7905a73865733da8a43339a500533180">&#9670;&#160;</a></span>mi_heap_theap()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="#ga8722f6ac4f638b4692e06ddfddc844f8">mi_theap_t</a> * mi_heap_theap </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__heap.html#ga34a47cde5a5b38c29f1aa3c5e76943c2">mi_heap_t</a> *</td>          <td class="paramname"><span class="paramname"><em>heap</em></span></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Return the thread-local theap for the given heap. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">heap</td><td>The owning heap. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The theap that serves thread-local allocations for the given <code>heap</code>. This can be used by runtime systems to request the thread-local theap once and then use it in its allocation functions (like <a class="el" href="#gac7308e029c59e6675dd5ab5ec54f304a" title="Allocate in a specific theap.">mi_theap_malloc()</a> or <a class="el" href="#ga1fc65302a212daaecb21abda96ff247c" title="Allocate a small object in a specific theap. size must be smaller or equal to MI_SMALL_SIZE_MAX().">mi_theap_malloc_small()</a> ) to avoid re-looking up the theap at each allocation call. </dd></dl>

</div>
</div>
<a id="gadbf8f27bfe9edf7834e19d32cab63edc" name="gadbf8f27bfe9edf7834e19d32cab63edc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gadbf8f27bfe9edf7834e19d32cab63edc">&#9670;&#160;</a></span>mi_theap_calloc()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void * mi_theap_calloc </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="#ga8722f6ac4f638b4692e06ddfddc844f8">mi_theap_t</a> *</td>          <td class="paramname"><span class="paramname"><em>theap</em></span>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t</td>          <td class="paramname"><span class="paramname"><em>count</em></span>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t</td>          <td class="paramname"><span class="paramname"><em>size</em></span>&#160;)</td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a id="ga9377a43095b8dd14996613ceb73d9a32" name="ga9377a43095b8dd14996613ceb73d9a32"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga9377a43095b8dd14996613ceb73d9a32">&#9670;&#160;</a></span>mi_theap_collect()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void mi_theap_collect </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="#ga8722f6ac4f638b4692e06ddfddc844f8">mi_theap_t</a> *</td>          <td class="paramname"><span class="paramname"><em>theap</em></span>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool</td>          <td class="paramname"><span class="paramname"><em>force</em></span>&#160;)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Release outstanding resources in a specific theap. </p>

</div>
</div>
<a id="ga78afbb07c1e0cd333c7539cf7403dfd5" name="ga78afbb07c1e0cd333c7539cf7403dfd5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga78afbb07c1e0cd333c7539cf7403dfd5">&#9670;&#160;</a></span>mi_theap_get_default()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="#ga8722f6ac4f638b4692e06ddfddc844f8">mi_theap_t</a> * mi_theap_get_default </td>
          <td>(</td>
          <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Get the default theap that is used for <a class="el" href="group__malloc.html#gae1dd97b542420c87ae085e822b1229e8" title="Allocate size bytes.">mi_malloc()</a> et al. for the current thread. </p>
<dl class="section return"><dt>Returns</dt><dd>The current default theap. </dd></dl>

</div>
</div>
<a id="gac7308e029c59e6675dd5ab5ec54f304a" name="gac7308e029c59e6675dd5ab5ec54f304a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gac7308e029c59e6675dd5ab5ec54f304a">&#9670;&#160;</a></span>mi_theap_malloc()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void * mi_theap_malloc </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="#ga8722f6ac4f638b4692e06ddfddc844f8">mi_theap_t</a> *</td>          <td class="paramname"><span class="paramname"><em>theap</em></span>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t</td>          <td class="paramname"><span class="paramname"><em>size</em></span>&#160;)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Allocate in a specific theap. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__malloc.html#gae1dd97b542420c87ae085e822b1229e8" title="Allocate size bytes.">mi_malloc()</a> </dd></dl>

</div>
</div>
<a id="ga84503fc2bd83fbfb7f789b7d80d76f36" name="ga84503fc2bd83fbfb7f789b7d80d76f36"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga84503fc2bd83fbfb7f789b7d80d76f36">&#9670;&#160;</a></span>mi_theap_malloc_aligned()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void * mi_theap_malloc_aligned </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="#ga8722f6ac4f638b4692e06ddfddc844f8">mi_theap_t</a> *</td>          <td class="paramname"><span class="paramname"><em>theap</em></span>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t</td>          <td class="paramname"><span class="paramname"><em>size</em></span>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t</td>          <td class="paramname"><span class="paramname"><em>alignment</em></span>&#160;)</td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a id="ga1fc65302a212daaecb21abda96ff247c" name="ga1fc65302a212daaecb21abda96ff247c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga1fc65302a212daaecb21abda96ff247c">&#9670;&#160;</a></span>mi_theap_malloc_small()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void * mi_theap_malloc_small </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="#ga8722f6ac4f638b4692e06ddfddc844f8">mi_theap_t</a> *</td>          <td class="paramname"><span class="paramname"><em>theap</em></span>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t</td>          <td class="paramname"><span class="paramname"><em>size</em></span>&#160;)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Allocate a small object in a specific theap. <em>size</em> must be smaller or equal to <a class="el" href="group__extended.html#ga1ea64283508718d9d645c38efc2f4305" title="Maximum size allowed for small allocations in mi_malloc_small, mi_zalloc_small, mi_heap_malloc_small,...">MI_SMALL_SIZE_MAX()</a>. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__extended.html#ga7f050bc6b897da82692174f5fce59cde" title="Allocate a small object.">mi_malloc_small()</a> </dd></dl>

</div>
</div>
<a id="ga11943128dc354313c4189e72f4299dbb" name="ga11943128dc354313c4189e72f4299dbb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga11943128dc354313c4189e72f4299dbb">&#9670;&#160;</a></span>mi_theap_realloc()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void * mi_theap_realloc </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="#ga8722f6ac4f638b4692e06ddfddc844f8">mi_theap_t</a> *</td>          <td class="paramname"><span class="paramname"><em>theap</em></span>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">void *</td>          <td class="paramname"><span class="paramname"><em>p</em></span>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t</td>          <td class="paramname"><span class="paramname"><em>newsize</em></span>&#160;)</td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a id="ga04420ce52785019412397e4de24a984a" name="ga04420ce52785019412397e4de24a984a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga04420ce52785019412397e4de24a984a">&#9670;&#160;</a></span>mi_theap_set_default()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="#ga8722f6ac4f638b4692e06ddfddc844f8">mi_theap_t</a> * mi_theap_set_default </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="#ga8722f6ac4f638b4692e06ddfddc844f8">mi_theap_t</a> *</td>          <td class="paramname"><span class="paramname"><em>theap</em></span></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Set the default thread-local theap to use in the current thread for <a class="el" href="group__malloc.html#gae1dd97b542420c87ae085e822b1229e8" title="Allocate size bytes.">mi_malloc()</a> et al. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">theap</td><td>The new default theap. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The previous default theap. By default it will point to the theap belonging to the main heap (<a class="el" href="group__heap.html#ga8fc318a65dc79ee8778c6a0e52d12477" title="v3: the main heap (of the current sub-process)">mi_heap_main()</a>). </dd></dl>

</div>
</div>
<a id="gaa7fd973dcd8c75eb05707bdeffbc06f7" name="gaa7fd973dcd8c75eb05707bdeffbc06f7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaa7fd973dcd8c75eb05707bdeffbc06f7">&#9670;&#160;</a></span>mi_theap_zalloc()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void * mi_theap_zalloc </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="#ga8722f6ac4f638b4692e06ddfddc844f8">mi_theap_t</a> *</td>          <td class="paramname"><span class="paramname"><em>theap</em></span>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t</td>          <td class="paramname"><span class="paramname"><em>size</em></span>&#160;)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Allocate zero-initialized in a specific heap. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__malloc.html#gae6e38c4403247a7b40d80419e093bfb8" title="Allocate zero-initialized size bytes.">mi_zalloc()</a> </dd></dl>

</div>
</div>
<a id="gaa85fccf9d40af3e826c5932aded1d534" name="gaa85fccf9d40af3e826c5932aded1d534"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaa85fccf9d40af3e826c5932aded1d534">&#9670;&#160;</a></span>mi_theap_zalloc_small()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void * mi_theap_zalloc_small </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="#ga8722f6ac4f638b4692e06ddfddc844f8">mi_theap_t</a> *</td>          <td class="paramname"><span class="paramname"><em>theap</em></span>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t</td>          <td class="paramname"><span class="paramname"><em>size</em></span>&#160;)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Allocate a small object in a specific theap. <em>size</em> must be smaller or equal to <a class="el" href="group__extended.html#ga1ea64283508718d9d645c38efc2f4305" title="Maximum size allowed for small allocations in mi_malloc_small, mi_zalloc_small, mi_heap_malloc_small,...">MI_SMALL_SIZE_MAX()</a>. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__extended.html#ga51c47637e81df0e2f13a2d7a2dec123e" title="Allocate a zero initialized small object.">mi_zalloc_small()</a> </dd></dl>

</div>
</div>
</div><!-- contents -->
</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="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.11.0 </li>
  </ul>
</div>
</body>
</html>