aboutsummaryrefslogtreecommitdiff
path: root/doc/oscl_html/oscl__mem_8h.html
blob: 49c95e65a88839225f0bc610e75cdfd07e4489d4 (plain)
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
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>oscl: oscl_mem.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.3 -->
<div class="navigation" id="top">
  <div class="tabs">
    <ul>
      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
      <li class="current"><a href="files.html"><span>Files</span></a></li>
    </ul>
  </div>
  <div class="tabs">
    <ul>
      <li><a href="files.html"><span>File&nbsp;List</span></a></li>
      <li><a href="globals.html"><span>Globals</span></a></li>
    </ul>
  </div>
</div>
<div class="contents">
<h1>oscl_mem.h File Reference</h1>
<p>This file contains basic memory definitions for common use across platforms.  
<a href="#_details">More...</a></p>
<code>#include &quot;<a class="el" href="osclconfig__memory_8h_source.html">osclconfig_memory.h</a>&quot;</code><br/>
<code>#include &quot;<a class="el" href="oscl__base_8h_source.html">oscl_base.h</a>&quot;</code><br/>
<code>#include &quot;<a class="el" href="oscl__types_8h_source.html">oscl_types.h</a>&quot;</code><br/>
<code>#include &quot;<a class="el" href="oscl__assert_8h_source.html">oscl_assert.h</a>&quot;</code><br/>
<code>#include &quot;<a class="el" href="oscl__mem__basic__functions_8h_source.html">oscl_mem_basic_functions.h</a>&quot;</code><br/>
<code>#include &quot;<a class="el" href="oscl__lock__base_8h_source.html">oscl_lock_base.h</a>&quot;</code><br/>
<code>#include &quot;<a class="el" href="osclconfig__compiler__warnings_8h_source.html">osclconfig_compiler_warnings.h</a>&quot;</code><br/>
<code>#include &quot;<a class="el" href="oscl__mem__inst_8h_source.html">oscl_mem_inst.h</a>&quot;</code><br/>
<code>#include &quot;<a class="el" href="oscl__heapbase_8h_source.html">oscl_heapbase.h</a>&quot;</code><br/>
<code>#include &quot;<a class="el" href="oscl__defalloc_8h_source.html">oscl_defalloc.h</a>&quot;</code><br/>
<code>#include &quot;<a class="el" href="oscl__refcounter_8h_source.html">oscl_refcounter.h</a>&quot;</code><br/>
<code>#include &quot;<a class="el" href="oscl__error_8h_source.html">oscl_error.h</a>&quot;</code><br/>
<code>#include &quot;<a class="el" href="oscl__exception_8h_source.html">oscl_exception.h</a>&quot;</code><br/>
<code>#include &quot;<a class="el" href="oscl__mem_8h_source.html">oscl_mem.inl</a>&quot;</code><br/>

<p><a href="oscl__mem_8h_source.html">Go to the source code of this file.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Data Structures</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOsclMem.html">OsclMem</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOsclAuditCB.html">OsclAuditCB</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOsclMemAllocator.html">OsclMemAllocator</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOsclMemBasicAllocator.html">OsclMemBasicAllocator</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOsclMemAllocDestructDealloc.html">OsclMemAllocDestructDealloc&lt; T &gt;</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOsclMemBasicAllocDestructDealloc.html">OsclMemBasicAllocDestructDealloc&lt; T &gt;</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOsclMemGlobalAuditObject.html">OsclMemGlobalAuditObject</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classHeapBase.html">HeapBase</a></td></tr>
<tr><td colspan="2"><h2>Defines</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__osclmemory.html#ga9fcc278d0a7a8d1c95f95c3bd7067994">OSCL_DISABLE_WARNING_TRUNCATE_DEBUG_MESSAGE</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__osclmemory.html#gae92c2c0f2f9ac61cc741efc88c67264d">OSCL_CLEANUP_BASE_CLASS</a>(T)&nbsp;&nbsp;&nbsp;_OSCL_CLEANUP_BASE_CLASS(T)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__osclmemory.html#gadf4b04d6c6c95fbeb0fdbe2c70ecb93a">OSCL_ALLOC_NEW</a>(T_allocator, T, params)&nbsp;&nbsp;&nbsp;new(T_allocator.allocate(1)) T params</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__osclmemory.html#ga86a28832146864af539f81cac7aabc98">OSCL_TRAP_ALLOC_NEW</a>(T_ptr, T_allocator, T, params)&nbsp;&nbsp;&nbsp;_OSCL_TRAP_NEW(T_allocator.allocate(1),T_allocator.deallocate,T_ptr,T,params)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__osclmemory.html#gabc57a479922c1847e023cc109436c5c7">OSCL_ALLOC_DELETE</a>(ptr, T_allocator, T)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__osclmemory.html#gaad47d106cc1abb0dfd1537624a853bb9">OSCL_MALLOC</a>(count)&nbsp;&nbsp;&nbsp;_oscl_malloc(count)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__osclmemory.html#ga62f4f8f35a828108fafb74763a77e982">oscl_malloc</a>(a)&nbsp;&nbsp;&nbsp;OSCL_MALLOC(a)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__osclmemory.html#gaeacd31255b9df354cff629d3be15254e">OSCL_DEFAULT_MALLOC</a>(x)&nbsp;&nbsp;&nbsp;OSCL_MALLOC(x)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__osclmemory.html#ga938ceee8172e01d3a07d912ab890f354">OSCL_AUDIT_MALLOC</a>(auditCB, count)&nbsp;&nbsp;&nbsp;_oscl_malloc(count)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__osclmemory.html#gaa31d8d7f56f28a804d0477a8e3b7187d">OSCL_CALLOC</a>(num, size)&nbsp;&nbsp;&nbsp;_oscl_calloc(num,size)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__osclmemory.html#ga2f18a90c9bd6f42979c24ff4fe9c6af8">oscl_calloc</a>(a, b)&nbsp;&nbsp;&nbsp;OSCL_CALLOC(a,b)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__osclmemory.html#gab326396170985b0576e2fbdf6db37e12">OSCL_AUDIT_CALLOC</a>(auditCB, num, size)&nbsp;&nbsp;&nbsp;_oscl_calloc(num,size)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__osclmemory.html#ga3f7525d7b5b6271c8ed1126f440f7207">OSCL_REALLOC</a>(ptr, new_size)&nbsp;&nbsp;&nbsp;_oscl_realloc(ptr,new_size)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__osclmemory.html#gabba179de4366364caeced4ff07da4498">oscl_realloc</a>(a, b)&nbsp;&nbsp;&nbsp;OSCL_REALLOC(a,b)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__osclmemory.html#gaad322da2c7b8bca314e8d8821693af2d">OSCL_AUDIT_REALLOC</a>(auditCB, ptr, new_size)&nbsp;&nbsp;&nbsp;_oscl_realloc(ptr,new_size)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__osclmemory.html#gaa894caeca157b3af4322127dabd3517b">OSCL_FREE</a>(ptr)&nbsp;&nbsp;&nbsp;_oscl_free(ptr)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__osclmemory.html#ga5111350e6bd7e7271250036d57a74415">oscl_free</a>(x)&nbsp;&nbsp;&nbsp;OSCL_FREE(x)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__osclmemory.html#ga6ce74633d169d36bf72af0a15ab30220">OSCL_DEFAULT_FREE</a>(x)&nbsp;&nbsp;&nbsp;OSCL_FREE(x)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__osclmemory.html#gaa6688a3dbf6c7555f8d54bc45445cf89">OSCL_NEW</a>(T, params)&nbsp;&nbsp;&nbsp;new T params</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__osclmemory.html#ga4bf8a56280e6377de56a030a453bb447">OSCL_PLACEMENT_NEW</a>(ptr, constructor)&nbsp;&nbsp;&nbsp;new(ptr) constructor</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__osclmemory.html#ga7241ae171c8204aaac0e676448ad1a2d">OSCL_TRAP_NEW</a>(T_ptr, T, params)&nbsp;&nbsp;&nbsp;_OSCL_TRAP_NEW(_oscl_default_new(sizeof(T)),_oscl_free,T_ptr,T,params)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__osclmemory.html#ga3902cc39c0c2b1fbb14e7c766c582baa">OSCL_AUDIT_NEW</a>(auditCB, T, params)&nbsp;&nbsp;&nbsp;new(_oscl_default_new(sizeof(T))) T params</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__osclmemory.html#ga0994c7d54254eb8c26345875a36f1199">OSCL_TRAP_AUDIT_NEW</a>(T_ptr, auditCB, T, params)&nbsp;&nbsp;&nbsp;_OSCL_TRAP_NEW(_oscl_default_new(sizeof(T)),_oscl_free,T_ptr,T,params)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__osclmemory.html#ga1a1abac94dc334b1b865949f6f250b0f">OSCL_DELETE</a>(ptr)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__osclmemory.html#ga4d6fdce3b21c895572f55e83036a5218">OSCL_AUDIT_ARRAY_NEW</a>(auditCB, T, count)&nbsp;&nbsp;&nbsp;new(_oscl_default_new(sizeof(T)*(count))) T</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__osclmemory.html#gaad051c81e38be8309c6c55f1c722a8d7">OSCL_ARRAY_NEW</a>(T, count)&nbsp;&nbsp;&nbsp;new T[count]</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__osclmemory.html#gadae9885f5ec2c7425e04e2c98cde4569">OSCL_ARRAY_DELETE</a>(ptr)&nbsp;&nbsp;&nbsp;delete [] ptr</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__osclmemory.html#ga9fcc278d0a7a8d1c95f95c3bd7067994">OSCL_DISABLE_WARNING_TRUNCATE_DEBUG_MESSAGE</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__osclmemory.html#ga78e9f1a2eb0b94459e5eabf2567fb411">_OSCL_TRAP_NEW</a>(exp, freeFunc, T_ptr, T, params)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__osclmemory.html#ga2e43fc73e266e6625fc0bcf2b567b9ce">_OSCL_CLEANUP_BASE_CLASS</a>(T)&nbsp;&nbsp;&nbsp;this-&gt;T::~T()</td></tr>
<tr><td colspan="2"><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">OSCL_COND_IMPORT_REF <a class="el" href="group__osclbase.html#ga91ad9478d81a7aaf2593e8d9c3d06a14">uint</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__osclmemory.html#gafc84155a0fe1f007724c2ba84f4ab49e">oscl_mem_aligned_size</a> (<a class="el" href="group__osclbase.html#ga91ad9478d81a7aaf2593e8d9c3d06a14">uint</a> size)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">OSCL_IMPORT_REF void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__osclmemory.html#gae7baa332d3b04c960012a6f9ee48c529">OsclMemInit</a> (<a class="el" href="classOsclAuditCB.html">OsclAuditCB</a> &amp;auditCB)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">OSCL_IMPORT_REF void *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__osclmemory.html#gadbb314ea54c51f3ba9f9360b372f74a2">_oscl_default_new</a> (size_t nBytes)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__osclmemory.html#ga63aa026bc049b4be1d9f37e74c44547b">operator new</a> (size_t aSize)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__osclmemory.html#gabdecd5532f7e93535072e2767b6d3d02">operator delete</a> (void *aPtr)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__osclmemory.html#ga688aaaff7516e3b9c98c9d92087dffab">operator new[]</a> (size_t aSize)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__osclmemory.html#gabdce7034b7215d3cbf51b776437f1b04">operator delete[]</a> (void *aPtr)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>This file contains basic memory definitions for common use across platforms. </p>
<p>This is the main entry point header file for the OSCL memory library. It should be the only one users directly include. Basic memory copy, compare, and move functions are defined here as well as the allocation functions. </p>
</div>
<hr size="1"><img src="pvlogo_small.jpg"><address style="align: right;"><small>OSCL API</small>
<address style="align: left;"><small>Posting Version: CORE_9.005.1.1 </small>
</small></address>
</body>
</html>