vey-mimalloc-sys 0.3.2+3.7.0

Rust FFI binding to mimalloc
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
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
<!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: Thread-local heaps</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.6/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('group__theap.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 class="header">
  <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 id="header-typedef-members" class="groupheader"><a id="typedef-members" name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:ga8722f6ac4f638b4692e06ddfddc844f8" id="r_ga8722f6ac4f638b4692e06ddfddc844f8"><td class="memItemLeft">typedef struct mi_theap_s&#160;</td><td class="memItemRight"><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>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 id="header-func-members" class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga7905a73865733da8a43339a500533180" id="r_ga7905a73865733da8a43339a500533180"><td class="memItemLeft"><a class="el" href="#ga8722f6ac4f638b4692e06ddfddc844f8">mi_theap_t</a> *&#160;</td><td class="memItemRight"><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="memitem:ga9377a43095b8dd14996613ceb73d9a32" id="r_ga9377a43095b8dd14996613ceb73d9a32"><td class="memItemLeft">void&#160;</td><td class="memItemRight"><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="memitem:ga9f782a7118d8ef2717d17d9681faa459" id="r_ga9f782a7118d8ef2717d17d9681faa459"><td class="memItemLeft">void&#160;</td><td class="memItemRight"><a class="el" href="#ga9f782a7118d8ef2717d17d9681faa459">mi_theap_delete</a> (<a class="el" href="#ga8722f6ac4f638b4692e06ddfddc844f8">mi_theap_t</a> *theap)</td></tr>
<tr class="memdesc:ga9f782a7118d8ef2717d17d9681faa459"><td class="mdescLeft">&#160;</td><td class="mdescRight"><b>experimental</b>: Abandon a theap's pages and delete the theap, preserving its heap and live blocks.  <br /></td></tr>
<tr class="memitem:gab042c89cab6553b6ff775d6d92362800" id="r_gab042c89cab6553b6ff775d6d92362800"><td class="memItemLeft">void&#160;</td><td class="memItemRight"><a class="el" href="#gab042c89cab6553b6ff775d6d92362800">mi_theap_quiescent_abandon</a> (<a class="el" href="#ga8722f6ac4f638b4692e06ddfddc844f8">mi_theap_t</a> *theap)</td></tr>
<tr class="memdesc:gab042c89cab6553b6ff775d6d92362800"><td class="mdescLeft">&#160;</td><td class="mdescRight"><b>experimental</b>: Abandon all pages, preserving the theap and live blocks for reuse.  <br /></td></tr>
<tr class="memitem:ga04420ce52785019412397e4de24a984a" id="r_ga04420ce52785019412397e4de24a984a"><td class="memItemLeft"><a class="el" href="#ga8722f6ac4f638b4692e06ddfddc844f8">mi_theap_t</a> *&#160;</td><td class="memItemRight"><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="memitem:ga78afbb07c1e0cd333c7539cf7403dfd5" id="r_ga78afbb07c1e0cd333c7539cf7403dfd5"><td class="memItemLeft"><a class="el" href="#ga8722f6ac4f638b4692e06ddfddc844f8">mi_theap_t</a> *&#160;</td><td class="memItemRight"><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.  <br /></td></tr>
<tr class="memitem:gac7308e029c59e6675dd5ab5ec54f304a" id="r_gac7308e029c59e6675dd5ab5ec54f304a"><td class="memItemLeft">void *&#160;</td><td class="memItemRight"><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="memitem:ga1fc65302a212daaecb21abda96ff247c" id="r_ga1fc65302a212daaecb21abda96ff247c"><td class="memItemLeft">void *&#160;</td><td class="memItemRight"><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.  <br /></td></tr>
<tr class="memitem:ga6bcfc116fe2f73f808826f67e39057d7" id="r_ga6bcfc116fe2f73f808826f67e39057d7"><td class="memItemLeft">void *&#160;</td><td class="memItemRight"><a class="el" href="#ga6bcfc116fe2f73f808826f67e39057d7">mi_theap_wmalloc_small</a> (<a class="el" href="#ga8722f6ac4f638b4692e06ddfddc844f8">mi_theap_t</a> *theap, size_t wsize)</td></tr>
<tr class="memdesc:ga6bcfc116fe2f73f808826f67e39057d7"><td class="mdescLeft">&#160;</td><td class="mdescRight">As <a class="el" href="group__extended.html#gaddce8f584e649a1b7ca48298dc52fe77" title="v3: Allocate a small object with its size expressed in machine words.">mi_wmalloc_small()</a>, using a non-NULL theap belonging to the calling thread.  <br /></td></tr>
<tr class="memitem:gaa37999725c71106b26aab944f5f80551" id="r_gaa37999725c71106b26aab944f5f80551"><td class="memItemLeft">void *&#160;</td><td class="memItemRight"><a class="el" href="#gaa37999725c71106b26aab944f5f80551">mi_theap_wzalloc_small</a> (<a class="el" href="#ga8722f6ac4f638b4692e06ddfddc844f8">mi_theap_t</a> *theap, size_t wsize)</td></tr>
<tr class="memdesc:gaa37999725c71106b26aab944f5f80551"><td class="mdescLeft">&#160;</td><td class="mdescRight">As <a class="el" href="group__extended.html#ga61113cc91b1d6de4ace7b693739b2352" title="v3: As mi_wmalloc_small(), but zero-initialize the allocation.">mi_wzalloc_small()</a>, using a non-NULL theap belonging to the calling thread.  <br /></td></tr>
<tr class="memitem:gaa7fd973dcd8c75eb05707bdeffbc06f7" id="r_gaa7fd973dcd8c75eb05707bdeffbc06f7"><td class="memItemLeft">void *&#160;</td><td class="memItemRight"><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="memitem:gaa85fccf9d40af3e826c5932aded1d534" id="r_gaa85fccf9d40af3e826c5932aded1d534"><td class="memItemLeft">void *&#160;</td><td class="memItemRight"><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.  <br /></td></tr>
<tr class="memitem:gadbf8f27bfe9edf7834e19d32cab63edc" id="r_gadbf8f27bfe9edf7834e19d32cab63edc"><td class="memItemLeft">void *&#160;</td><td class="memItemRight"><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="memitem:ga84503fc2bd83fbfb7f789b7d80d76f36" id="r_ga84503fc2bd83fbfb7f789b7d80d76f36"><td class="memItemLeft">void *&#160;</td><td class="memItemRight"><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="memitem:ga11943128dc354313c4189e72f4299dbb" id="r_ga11943128dc354313c4189e72f4299dbb"><td class="memItemLeft">void *&#160;</td><td class="memItemRight"><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="memitem:gaa73e21ada632a3f688f7cdbb5ce84ae6" id="r_gaa73e21ada632a3f688f7cdbb5ce84ae6"><td class="memItemLeft">void *&#160;</td><td class="memItemRight"><a class="el" href="#gaa73e21ada632a3f688f7cdbb5ce84ae6">mi_theap_zalloc_aligned</a> (<a class="el" href="#ga8722f6ac4f638b4692e06ddfddc844f8">mi_theap_t</a> *theap, size_t size, size_t alignment)</td></tr>
<tr class="memdesc:gaa73e21ada632a3f688f7cdbb5ce84ae6"><td class="mdescLeft">&#160;</td><td class="mdescRight">As <a class="el" href="group__aligned.html#gaac7d0beb782f9b9ac31f47492b130f82">mi_zalloc_aligned()</a>, using a theap belonging to the calling thread.  <br /></td></tr>
<tr class="memitem:gae23ae0b8776745a65198799883b67d33" id="r_gae23ae0b8776745a65198799883b67d33"><td class="memItemLeft">void *&#160;</td><td class="memItemRight"><a class="el" href="#gae23ae0b8776745a65198799883b67d33">mi_theap_rezalloc</a> (<a class="el" href="#ga8722f6ac4f638b4692e06ddfddc844f8">mi_theap_t</a> *theap, void *p, size_t newsize)</td></tr>
<tr class="memdesc:gae23ae0b8776745a65198799883b67d33"><td class="mdescLeft">&#160;</td><td class="mdescRight">As <a class="el" href="group__zeroinit.html#gadfd34cd7b4f2bbda7ae06367a6360756">mi_rezalloc()</a>, using a theap belonging to the calling thread.  <br /></td></tr>
<tr class="memitem:ga38eaa06d528e2a6b16cfe7d94113173a" id="r_ga38eaa06d528e2a6b16cfe7d94113173a"><td class="memItemLeft">void *&#160;</td><td class="memItemRight"><a class="el" href="#ga38eaa06d528e2a6b16cfe7d94113173a">mi_theap_realloc_aligned</a> (<a class="el" href="#ga8722f6ac4f638b4692e06ddfddc844f8">mi_theap_t</a> *theap, void *p, size_t newsize, size_t alignment)</td></tr>
<tr class="memdesc:ga38eaa06d528e2a6b16cfe7d94113173a"><td class="mdescLeft">&#160;</td><td class="mdescRight">As <a class="el" href="group__aligned.html#ga5d7a46d054b4d7abe9d8d2474add2edf">mi_realloc_aligned()</a>, using a theap belonging to the calling thread.  <br /></td></tr>
<tr class="memitem:gab9644d3321db2e7970923970642faa5e" id="r_gab9644d3321db2e7970923970642faa5e"><td class="memItemLeft">void *&#160;</td><td class="memItemRight"><a class="el" href="#gab9644d3321db2e7970923970642faa5e">mi_theap_rezalloc_aligned</a> (<a class="el" href="#ga8722f6ac4f638b4692e06ddfddc844f8">mi_theap_t</a> *theap, void *p, size_t newsize, size_t alignment)</td></tr>
<tr class="memdesc:gab9644d3321db2e7970923970642faa5e"><td class="mdescLeft">&#160;</td><td class="mdescRight">As <a class="el" href="group__zeroinit.html#ga4d02404fe1e7db00beb65f185e012caa">mi_rezalloc_aligned()</a>, using a theap belonging to the calling thread.  <br /></td></tr>
<tr class="memitem:ga4c23c5ba89c9210a3d3375d06e2fb0b5" id="r_ga4c23c5ba89c9210a3d3375d06e2fb0b5"><td class="memItemLeft">void&#160;</td><td class="memItemRight"><a class="el" href="#ga4c23c5ba89c9210a3d3375d06e2fb0b5">mi_theap_guarded_set_sample_rate</a> (<a class="el" href="#ga8722f6ac4f638b4692e06ddfddc844f8">mi_theap_t</a> *theap, size_t sample_rate, size_t seed)</td></tr>
<tr class="memdesc:ga4c23c5ba89c9210a3d3375d06e2fb0b5"><td class="mdescLeft">&#160;</td><td class="mdescRight"><b>experimental</b>: Set guarded-allocation sampling for a theap belonging to the calling thread.  <br /></td></tr>
<tr class="memitem:ga1071de3351e1bcd88c75716dd11639b1" id="r_ga1071de3351e1bcd88c75716dd11639b1"><td class="memItemLeft">void&#160;</td><td class="memItemRight"><a class="el" href="#ga1071de3351e1bcd88c75716dd11639b1">mi_theap_guarded_set_size_bound</a> (<a class="el" href="#ga8722f6ac4f638b4692e06ddfddc844f8">mi_theap_t</a> *theap, size_t min, size_t max)</td></tr>
<tr class="memdesc:ga1071de3351e1bcd88c75716dd11639b1"><td class="mdescLeft">&#160;</td><td class="mdescRight"><b>experimental</b>: Set inclusive size bounds in bytes for guarded allocations in this theap.  <br /></td></tr>
<tr class="memitem:ga93245a8b72250149459d2e667c4a6a4c" id="r_ga93245a8b72250149459d2e667c4a6a4c"><td class="memItemLeft">bool&#160;</td><td class="memItemRight"><a class="el" href="#ga93245a8b72250149459d2e667c4a6a4c">mi_theap_visit_blocks</a> (const <a class="el" href="#ga8722f6ac4f638b4692e06ddfddc844f8">mi_theap_t</a> *theap, bool visit_blocks, <a class="el" href="group__analysis.html#ga8255dc9371e6b299d9802a610c4e34ec">mi_block_visit_fun</a> *visitor, void *arg)</td></tr>
</table>
<a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
<div class="textblock"><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 <span class="tt"><a class="el" href="group__heap.html#ga34a47cde5a5b38c29f1aa3c5e76943c2" title="Type of first-class heaps.">mi_heap_t</a></span> heaps in v1/v2 are exactly these <span class="tt"><a class="el" href="#ga8722f6ac4f638b4692e06ddfddc844f8" title="Type of thread-local heaps.">mi_theap_t</a></span> theaps in v3. </p>
</div><a name="doc-typedef-members" id="doc-typedef-members"></a><h2 id="header-doc-typedef-members" 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>
<a name="doc-func-members" id="doc-func-members"></a><h2 id="header-doc-func-members" 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 <span class="tt"><a class="el" href="group__heap.html" title="First-class heaps.">Heaps</a></span>. 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.">mi_theap_malloc_small()</a> ) to avoid re-looking up the theap at each allocation call.</dd></dl>
<p>This is never NULL: if the theap could not be created, or if the current thread has already terminated (after <a class="el" href="group__extended.html#ga0ae4581e85453456a0d658b2b98bf7bf" title="Uninitialize mimalloc on a thread.">mi_thread_done()</a>), a special empty theap is returned instead. Allocation through such an empty theap returns NULL </p>

</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="ga9f782a7118d8ef2717d17d9681faa459" name="ga9f782a7118d8ef2717d17d9681faa459"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga9f782a7118d8ef2717d17d9681faa459">&#9670;&#160;</a></span>mi_theap_delete()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void mi_theap_delete </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><b>experimental</b>: Abandon a theap's pages and delete the theap, preserving its heap and live blocks. </p>
<p>Only the owning thread may call this function. </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. </p>
<p>for the current thread. </p><dl class="section return"><dt>Returns</dt><dd>The current default theap. </dd></dl>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void mi_theap_guarded_set_sample_rate </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>sample_rate</em></span>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t</td>          <td class="paramname"><span class="paramname"><em>seed</em></span>&#160;)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><b>experimental</b>: Set guarded-allocation sampling for a theap belonging to the calling thread. </p>
<p><em class="arg">sample_rate</em> is measured in bytes: 0 disables sampling, 1 guards every eligible allocation. <em class="arg">seed</em> is a reproducible sampling seed, or 0 for a random seed. Requires <span class="tt">MI_GUARDED</span>. </p>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void mi_theap_guarded_set_size_bound </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>min</em></span>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t</td>          <td class="paramname"><span class="paramname"><em>max</em></span>&#160;)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p><b>experimental</b>: Set inclusive size bounds in bytes for guarded allocations in this theap. </p>
<p>Only the owning thread may call this function. Requires <span class="tt">MI_GUARDED</span>. </p>

</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. </p>
<p><em class="arg">size</em> must be smaller or equal to <a class="el" href="group__extended.html#ga1ea64283508718d9d645c38efc2f4305" title="Maximum size in bytes allowed for small allocations in mi_malloc_small, mi_zalloc_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="gab042c89cab6553b6ff775d6d92362800" name="gab042c89cab6553b6ff775d6d92362800"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gab042c89cab6553b6ff775d6d92362800">&#9670;&#160;</a></span>mi_theap_quiescent_abandon()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void mi_theap_quiescent_abandon </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><b>experimental</b>: Abandon all pages, preserving the theap and live blocks for reuse. </p>
<p>The owner must be the calling thread or quiescent outside mimalloc. Heap and theap deletion must not run concurrently. </p>

</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="ga38eaa06d528e2a6b16cfe7d94113173a" name="ga38eaa06d528e2a6b16cfe7d94113173a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga38eaa06d528e2a6b16cfe7d94113173a">&#9670;&#160;</a></span>mi_theap_realloc_aligned()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void * mi_theap_realloc_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">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>, </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">

<p>As <a class="el" href="group__aligned.html#ga5d7a46d054b4d7abe9d8d2474add2edf">mi_realloc_aligned()</a>, using a theap belonging to the calling thread. </p>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void * mi_theap_rezalloc </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">

<p>As <a class="el" href="group__zeroinit.html#gadfd34cd7b4f2bbda7ae06367a6360756">mi_rezalloc()</a>, using a theap belonging to the calling thread. </p>
<p><em class="arg">p</em> must be <em class="arg">NULL</em> or originate from a zero-initialized allocation. </p>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void * mi_theap_rezalloc_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">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>, </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">

<p>As <a class="el" href="group__zeroinit.html#ga4d02404fe1e7db00beb65f185e012caa">mi_rezalloc_aligned()</a>, using a theap belonging to the calling thread. </p>
<p><em class="arg">p</em> must be <em class="arg">NULL</em> or originate from a zero-initialized allocation. </p>

</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="ga93245a8b72250149459d2e667c4a6a4c" name="ga93245a8b72250149459d2e667c4a6a4c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga93245a8b72250149459d2e667c4a6a4c">&#9670;&#160;</a></span>mi_theap_visit_blocks()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool mi_theap_visit_blocks </td>
          <td>(</td>
          <td class="paramtype">const <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>visit_blocks</em></span>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__analysis.html#ga8255dc9371e6b299d9802a610c4e34ec">mi_block_visit_fun</a> *</td>          <td class="paramname"><span class="paramname"><em>visitor</em></span>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">void *</td>          <td class="paramname"><span class="paramname"><em>arg</em></span>&#160;)</td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000009">Deprecated</a></b></dt><dd>Visit areas and optionally allocated blocks in a thread-local heap. Prevent concurrent mutation during the visit; prefer <a class="el" href="group__analysis.html#gae69fcff3324f8e419af850e34cf54c46" title="Visit all areas and blocks in a heap.">mi_heap_visit_blocks()</a>. </dd></dl>
<dl class="section return"><dt>Returns</dt><dd><em class="arg">true</em> if the visit completed. </dd></dl>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void * mi_theap_wmalloc_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>wsize</em></span>&#160;)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>As <a class="el" href="group__extended.html#gaddce8f584e649a1b7ca48298dc52fe77" title="v3: Allocate a small object with its size expressed in machine words.">mi_wmalloc_small()</a>, using a non-NULL theap belonging to the calling thread. </p>
<p><em class="arg">wsize</em> must not exceed <a class="el" href="group__extended.html#ga070c011175b3a1de57a481966a57b8ba" title="Maximum number of machine words allowed for mi_wmalloc_small().">MI_SMALL_WSIZE_MAX</a>. </p>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void * mi_theap_wzalloc_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>wsize</em></span>&#160;)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>As <a class="el" href="group__extended.html#ga61113cc91b1d6de4ace7b693739b2352" title="v3: As mi_wmalloc_small(), but zero-initialize the allocation.">mi_wzalloc_small()</a>, using a non-NULL theap belonging to the calling thread. </p>
<p><em class="arg">wsize</em> must not exceed <a class="el" href="group__extended.html#ga070c011175b3a1de57a481966a57b8ba" title="Maximum number of machine words allowed for mi_wmalloc_small().">MI_SMALL_WSIZE_MAX</a>. </p>

</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="gaa73e21ada632a3f688f7cdbb5ce84ae6" name="gaa73e21ada632a3f688f7cdbb5ce84ae6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaa73e21ada632a3f688f7cdbb5ce84ae6">&#9670;&#160;</a></span>mi_theap_zalloc_aligned()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void * mi_theap_zalloc_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">

<p>As <a class="el" href="group__aligned.html#gaac7d0beb782f9b9ac31f47492b130f82">mi_zalloc_aligned()</a>, using a theap belonging to the calling thread. </p>

</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. </p>
<p><em class="arg">size</em> must be smaller or equal to <a class="el" href="group__extended.html#ga1ea64283508718d9d645c38efc2f4305" title="Maximum size in bytes allowed for small allocations in mi_malloc_small, mi_zalloc_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 -->
<div id="page-nav" class="page-nav-panel">
<div id="page-nav-resize-handle"></div>
<div id="page-nav-tree">
<div id="page-nav-contents">
</div><!-- page-nav-contents -->
</div><!-- page-nav-tree -->
</div><!-- page-nav -->
</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>