350 lines
17 KiB

  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
  2. <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
  3. <title>Memory Allocation</title>
  4. <link href="doxygen.css" rel="stylesheet" type="text/css">
  5. <link href="tabs.css" rel="stylesheet" type="text/css">
  6. </head><body>
  7. <!-- Generated by Doxygen 1.4.7 -->
  8. <div class="tabs">
  9. <ul>
  10. <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
  11. <li><a href="modules.html"><span>Modules</span></a></li>
  12. <li><a href="namespaces.html"><span>Namespaces</span></a></li>
  13. <li><a href="annotated.html"><span>Classes</span></a></li>
  14. <li><a href="files.html"><span>Files</span></a></li>
  15. <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
  16. </ul></div>
  17. <h1>Memory Allocation</h1><table border="0" cellpadding="0" cellspacing="0">
  18. <tr><td></td></tr>
  19. <tr><td colspan="2"><br><h2>Classes</h2></td></tr>
  20. <tr><td class="memItemLeft" nowrap align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00265.html">tbb::aligned_space&lt; T, N &gt;</a></td></tr>
  21. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Block of space aligned sufficiently to construct an array T with N elements. <a href="a00265.html#_details">More...</a><br></td></tr>
  22. <tr><td class="memItemLeft" nowrap align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00276.html">tbb::cache_aligned_allocator&lt; T &gt;</a></td></tr>
  23. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Meets "allocator" requirements of ISO C++ Standard, Section 20.1.5. <a href="a00276.html#_details">More...</a><br></td></tr>
  24. <tr><td class="memItemLeft" nowrap align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00277.html">tbb::cache_aligned_allocator&lt; void &gt;</a></td></tr>
  25. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Analogous to std::allocator&lt;void&gt;, as defined in ISO C++ Standard, Section 20.4.1. <a href="a00277.html#_details">More...</a><br></td></tr>
  26. <tr><td class="memItemLeft" nowrap align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00308.html">tbb::interface6::memory_pool_allocator&lt; T, P &gt;</a></td></tr>
  27. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Meets "allocator" requirements of ISO C++ Standard, Section 20.1.5. <a href="a00308.html#_details">More...</a><br></td></tr>
  28. <tr><td class="memItemLeft" nowrap align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00309.html">tbb::interface6::memory_pool_allocator&lt; void, P &gt;</a></td></tr>
  29. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Analogous to std::allocator&lt;void&gt;, as defined in ISO C++ Standard, Section 20.4.1. <a href="a00309.html#_details">More...</a><br></td></tr>
  30. <tr><td class="memItemLeft" nowrap align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00337.html">tbb::scalable_allocator&lt; T &gt;</a></td></tr>
  31. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Meets "allocator" requirements of ISO C++ Standard, Section 20.1.5. <a href="a00337.html#_details">More...</a><br></td></tr>
  32. <tr><td class="memItemLeft" nowrap align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00338.html">tbb::scalable_allocator&lt; void &gt;</a></td></tr>
  33. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Analogous to std::allocator&lt;void&gt;, as defined in ISO C++ Standard, Section 20.4.1. <a href="a00338.html#_details">More...</a><br></td></tr>
  34. <tr><td class="memItemLeft" nowrap align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00356.html">tbb::tbb_allocator&lt; T &gt;</a></td></tr>
  35. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Meets "allocator" requirements of ISO C++ Standard, Section 20.1.5. <a href="a00356.html#_details">More...</a><br></td></tr>
  36. <tr><td class="memItemLeft" nowrap align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00357.html">tbb::tbb_allocator&lt; void &gt;</a></td></tr>
  37. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Analogous to std::allocator&lt;void&gt;, as defined in ISO C++ Standard, Section 20.4.1. <a href="a00357.html#_details">More...</a><br></td></tr>
  38. <tr><td class="memItemLeft" nowrap align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00366.html">tbb::zero_allocator&lt; T, Allocator &gt;</a></td></tr>
  39. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Meets "allocator" requirements of ISO C++ Standard, Section 20.1.5. <a href="a00366.html#_details">More...</a><br></td></tr>
  40. <tr><td class="memItemLeft" nowrap align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00367.html">tbb::zero_allocator&lt; void, Allocator &gt;</a></td></tr>
  41. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Analogous to std::allocator&lt;void&gt;, as defined in ISO C++ Standard, Section 20.4.1. <a href="a00367.html#_details">More...</a><br></td></tr>
  42. <tr><td colspan="2"><br><h2>Functions</h2></td></tr>
  43. <tr><td class="memItemLeft" nowrap align="right" valign="top">void *__TBB_EXPORTED_FUNC&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00443.html#gc25b8e6c76db0b346a8249796a7a2475">scalable_malloc</a> (size_t size)</td></tr>
  44. <tr><td class="memItemLeft" nowrap align="right" valign="top">void __TBB_EXPORTED_FUNC&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00443.html#gca3579c21244dba9f0c351e5984d4565">scalable_free</a> (void *ptr)</td></tr>
  45. <tr><td class="memItemLeft" nowrap align="right" valign="top">void *__TBB_EXPORTED_FUNC&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00443.html#g951bbbbd2d041acb59ba5fa910b52543">scalable_realloc</a> (void *ptr, size_t size)</td></tr>
  46. <tr><td class="memItemLeft" nowrap align="right" valign="top">void *__TBB_EXPORTED_FUNC&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00443.html#g3f5a2fde0bcaa3eda35be32c8658f444">scalable_calloc</a> (size_t nobj, size_t size)</td></tr>
  47. <tr><td class="memItemLeft" nowrap align="right" valign="top">int __TBB_EXPORTED_FUNC&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00443.html#g05dcec987480bb2c82ecdead6a085899">scalable_posix_memalign</a> (void **memptr, size_t alignment, size_t size)</td></tr>
  48. <tr><td class="memItemLeft" nowrap align="right" valign="top">void *__TBB_EXPORTED_FUNC&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00443.html#gc1c7aaa1fe85c17ba5a3a96f7e8d89e7">scalable_aligned_malloc</a> (size_t size, size_t alignment)</td></tr>
  49. <tr><td class="memItemLeft" nowrap align="right" valign="top">void *__TBB_EXPORTED_FUNC&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00443.html#gbaea91376be80dfabd7c93eaffd9abaa">scalable_aligned_realloc</a> (void *ptr, size_t size, size_t alignment)</td></tr>
  50. <tr><td class="memItemLeft" nowrap align="right" valign="top">void __TBB_EXPORTED_FUNC&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00443.html#g65a20e812012f15ec7442d5b45d0cba5">scalable_aligned_free</a> (void *ptr)</td></tr>
  51. <tr><td class="memItemLeft" nowrap align="right" valign="top">size_t __TBB_EXPORTED_FUNC&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00443.html#g0965ce1b4b7835f92869c7fd867265f7">scalable_msize</a> (void *ptr)</td></tr>
  52. <tr><td class="memItemLeft" nowrap align="right" valign="top">int __TBB_EXPORTED_FUNC&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00443.html#gb9ee52ffc5400f15c3d8af8c7613c05a">scalable_allocation_mode</a> (int param, intptr_t value)</td></tr>
  53. </table>
  54. <hr><h2>Function Documentation</h2>
  55. <a class="anchor" name="g65a20e812012f15ec7442d5b45d0cba5"></a><!-- doxytag: member="scalable_allocator.h::scalable_aligned_free" ref="g65a20e812012f15ec7442d5b45d0cba5" args="(void *ptr)" -->
  56. <div class="memitem">
  57. <div class="memproto">
  58. <table class="memname">
  59. <tr>
  60. <td class="memname">void __TBB_EXPORTED_FUNC scalable_aligned_free </td>
  61. <td>(</td>
  62. <td class="paramtype">void *&nbsp;</td>
  63. <td class="paramname"> <em>ptr</em> </td>
  64. <td>&nbsp;)&nbsp;</td>
  65. <td width="100%"></td>
  66. </tr>
  67. </table>
  68. </div>
  69. <div class="memdoc">
  70. <p>
  71. The "_aligned_free" analogue.
  72. </div>
  73. </div><p>
  74. <a class="anchor" name="gc1c7aaa1fe85c17ba5a3a96f7e8d89e7"></a><!-- doxytag: member="scalable_allocator.h::scalable_aligned_malloc" ref="gc1c7aaa1fe85c17ba5a3a96f7e8d89e7" args="(size_t size, size_t alignment)" -->
  75. <div class="memitem">
  76. <div class="memproto">
  77. <table class="memname">
  78. <tr>
  79. <td class="memname">void* __TBB_EXPORTED_FUNC scalable_aligned_malloc </td>
  80. <td>(</td>
  81. <td class="paramtype">size_t&nbsp;</td>
  82. <td class="paramname"> <em>size</em>, </td>
  83. </tr>
  84. <tr>
  85. <td class="paramkey"></td>
  86. <td></td>
  87. <td class="paramtype">size_t&nbsp;</td>
  88. <td class="paramname"> <em>alignment</em></td><td>&nbsp;</td>
  89. </tr>
  90. <tr>
  91. <td></td>
  92. <td>)</td>
  93. <td></td><td></td><td width="100%"></td>
  94. </tr>
  95. </table>
  96. </div>
  97. <div class="memdoc">
  98. <p>
  99. The "_aligned_malloc" analogue.
  100. </div>
  101. </div><p>
  102. <a class="anchor" name="gbaea91376be80dfabd7c93eaffd9abaa"></a><!-- doxytag: member="scalable_allocator.h::scalable_aligned_realloc" ref="gbaea91376be80dfabd7c93eaffd9abaa" args="(void *ptr, size_t size, size_t alignment)" -->
  103. <div class="memitem">
  104. <div class="memproto">
  105. <table class="memname">
  106. <tr>
  107. <td class="memname">void* __TBB_EXPORTED_FUNC scalable_aligned_realloc </td>
  108. <td>(</td>
  109. <td class="paramtype">void *&nbsp;</td>
  110. <td class="paramname"> <em>ptr</em>, </td>
  111. </tr>
  112. <tr>
  113. <td class="paramkey"></td>
  114. <td></td>
  115. <td class="paramtype">size_t&nbsp;</td>
  116. <td class="paramname"> <em>size</em>, </td>
  117. </tr>
  118. <tr>
  119. <td class="paramkey"></td>
  120. <td></td>
  121. <td class="paramtype">size_t&nbsp;</td>
  122. <td class="paramname"> <em>alignment</em></td><td>&nbsp;</td>
  123. </tr>
  124. <tr>
  125. <td></td>
  126. <td>)</td>
  127. <td></td><td></td><td width="100%"></td>
  128. </tr>
  129. </table>
  130. </div>
  131. <div class="memdoc">
  132. <p>
  133. The "_aligned_realloc" analogue.
  134. </div>
  135. </div><p>
  136. <a class="anchor" name="gb9ee52ffc5400f15c3d8af8c7613c05a"></a><!-- doxytag: member="scalable_allocator.h::scalable_allocation_mode" ref="gb9ee52ffc5400f15c3d8af8c7613c05a" args="(int param, intptr_t value)" -->
  137. <div class="memitem">
  138. <div class="memproto">
  139. <table class="memname">
  140. <tr>
  141. <td class="memname">int __TBB_EXPORTED_FUNC scalable_allocation_mode </td>
  142. <td>(</td>
  143. <td class="paramtype">int&nbsp;</td>
  144. <td class="paramname"> <em>param</em>, </td>
  145. </tr>
  146. <tr>
  147. <td class="paramkey"></td>
  148. <td></td>
  149. <td class="paramtype">intptr_t&nbsp;</td>
  150. <td class="paramname"> <em>value</em></td><td>&nbsp;</td>
  151. </tr>
  152. <tr>
  153. <td></td>
  154. <td>)</td>
  155. <td></td><td></td><td width="100%"></td>
  156. </tr>
  157. </table>
  158. </div>
  159. <div class="memdoc">
  160. <p>
  161. Set TBB allocator-specific allocation modes.
  162. </div>
  163. </div><p>
  164. <a class="anchor" name="g3f5a2fde0bcaa3eda35be32c8658f444"></a><!-- doxytag: member="scalable_allocator.h::scalable_calloc" ref="g3f5a2fde0bcaa3eda35be32c8658f444" args="(size_t nobj, size_t size)" -->
  165. <div class="memitem">
  166. <div class="memproto">
  167. <table class="memname">
  168. <tr>
  169. <td class="memname">void* __TBB_EXPORTED_FUNC scalable_calloc </td>
  170. <td>(</td>
  171. <td class="paramtype">size_t&nbsp;</td>
  172. <td class="paramname"> <em>nobj</em>, </td>
  173. </tr>
  174. <tr>
  175. <td class="paramkey"></td>
  176. <td></td>
  177. <td class="paramtype">size_t&nbsp;</td>
  178. <td class="paramname"> <em>size</em></td><td>&nbsp;</td>
  179. </tr>
  180. <tr>
  181. <td></td>
  182. <td>)</td>
  183. <td></td><td></td><td width="100%"></td>
  184. </tr>
  185. </table>
  186. </div>
  187. <div class="memdoc">
  188. <p>
  189. The "calloc" analogue complementing scalable_malloc.
  190. </div>
  191. </div><p>
  192. <a class="anchor" name="gca3579c21244dba9f0c351e5984d4565"></a><!-- doxytag: member="scalable_allocator.h::scalable_free" ref="gca3579c21244dba9f0c351e5984d4565" args="(void *ptr)" -->
  193. <div class="memitem">
  194. <div class="memproto">
  195. <table class="memname">
  196. <tr>
  197. <td class="memname">void __TBB_EXPORTED_FUNC scalable_free </td>
  198. <td>(</td>
  199. <td class="paramtype">void *&nbsp;</td>
  200. <td class="paramname"> <em>ptr</em> </td>
  201. <td>&nbsp;)&nbsp;</td>
  202. <td width="100%"></td>
  203. </tr>
  204. </table>
  205. </div>
  206. <div class="memdoc">
  207. <p>
  208. The "free" analogue to discard a previously allocated piece of memory.
  209. </div>
  210. </div><p>
  211. <a class="anchor" name="gc25b8e6c76db0b346a8249796a7a2475"></a><!-- doxytag: member="scalable_allocator.h::scalable_malloc" ref="gc25b8e6c76db0b346a8249796a7a2475" args="(size_t size)" -->
  212. <div class="memitem">
  213. <div class="memproto">
  214. <table class="memname">
  215. <tr>
  216. <td class="memname">void* __TBB_EXPORTED_FUNC scalable_malloc </td>
  217. <td>(</td>
  218. <td class="paramtype">size_t&nbsp;</td>
  219. <td class="paramname"> <em>size</em> </td>
  220. <td>&nbsp;)&nbsp;</td>
  221. <td width="100%"></td>
  222. </tr>
  223. </table>
  224. </div>
  225. <div class="memdoc">
  226. <p>
  227. The "malloc" analogue to allocate block of memory of size bytes.
  228. </div>
  229. </div><p>
  230. <a class="anchor" name="g0965ce1b4b7835f92869c7fd867265f7"></a><!-- doxytag: member="scalable_allocator.h::scalable_msize" ref="g0965ce1b4b7835f92869c7fd867265f7" args="(void *ptr)" -->
  231. <div class="memitem">
  232. <div class="memproto">
  233. <table class="memname">
  234. <tr>
  235. <td class="memname">size_t __TBB_EXPORTED_FUNC scalable_msize </td>
  236. <td>(</td>
  237. <td class="paramtype">void *&nbsp;</td>
  238. <td class="paramname"> <em>ptr</em> </td>
  239. <td>&nbsp;)&nbsp;</td>
  240. <td width="100%"></td>
  241. </tr>
  242. </table>
  243. </div>
  244. <div class="memdoc">
  245. <p>
  246. The analogue of _msize/malloc_size/malloc_usable_size. Returns the usable size of a memory block previously allocated by scalable_*, or 0 (zero) if ptr does not point to such a block.
  247. </div>
  248. </div><p>
  249. <a class="anchor" name="g05dcec987480bb2c82ecdead6a085899"></a><!-- doxytag: member="scalable_allocator.h::scalable_posix_memalign" ref="g05dcec987480bb2c82ecdead6a085899" args="(void **memptr, size_t alignment, size_t size)" -->
  250. <div class="memitem">
  251. <div class="memproto">
  252. <table class="memname">
  253. <tr>
  254. <td class="memname">int __TBB_EXPORTED_FUNC scalable_posix_memalign </td>
  255. <td>(</td>
  256. <td class="paramtype">void **&nbsp;</td>
  257. <td class="paramname"> <em>memptr</em>, </td>
  258. </tr>
  259. <tr>
  260. <td class="paramkey"></td>
  261. <td></td>
  262. <td class="paramtype">size_t&nbsp;</td>
  263. <td class="paramname"> <em>alignment</em>, </td>
  264. </tr>
  265. <tr>
  266. <td class="paramkey"></td>
  267. <td></td>
  268. <td class="paramtype">size_t&nbsp;</td>
  269. <td class="paramname"> <em>size</em></td><td>&nbsp;</td>
  270. </tr>
  271. <tr>
  272. <td></td>
  273. <td>)</td>
  274. <td></td><td></td><td width="100%"></td>
  275. </tr>
  276. </table>
  277. </div>
  278. <div class="memdoc">
  279. <p>
  280. The "posix_memalign" analogue.
  281. </div>
  282. </div><p>
  283. <a class="anchor" name="g951bbbbd2d041acb59ba5fa910b52543"></a><!-- doxytag: member="scalable_allocator.h::scalable_realloc" ref="g951bbbbd2d041acb59ba5fa910b52543" args="(void *ptr, size_t size)" -->
  284. <div class="memitem">
  285. <div class="memproto">
  286. <table class="memname">
  287. <tr>
  288. <td class="memname">void* __TBB_EXPORTED_FUNC scalable_realloc </td>
  289. <td>(</td>
  290. <td class="paramtype">void *&nbsp;</td>
  291. <td class="paramname"> <em>ptr</em>, </td>
  292. </tr>
  293. <tr>
  294. <td class="paramkey"></td>
  295. <td></td>
  296. <td class="paramtype">size_t&nbsp;</td>
  297. <td class="paramname"> <em>size</em></td><td>&nbsp;</td>
  298. </tr>
  299. <tr>
  300. <td></td>
  301. <td>)</td>
  302. <td></td><td></td><td width="100%"></td>
  303. </tr>
  304. </table>
  305. </div>
  306. <div class="memdoc">
  307. <p>
  308. The "realloc" analogue complementing scalable_malloc.
  309. </div>
  310. </div><p>
  311. <hr>
  312. <p></p>
  313. Copyright &copy; 2005-2013 Intel Corporation. All Rights Reserved.
  314. <p></p>
  315. Intel, Pentium, Intel Xeon, Itanium, Intel XScale and VTune are
  316. registered trademarks or trademarks of Intel Corporation or its
  317. subsidiaries in the United States and other countries.
  318. <p></p>
  319. * Other names and brands may be claimed as the property of others.