aboutsummaryrefslogtreecommitdiff
path: root/PhysX_3.4/Documentation/PhysXAPI/files/PxCudaMemoryManager_8h-source.html
blob: d1da4a9a81335a7c10baf88afd00c34258ec2880 (plain) (blame)
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
<html>
	<head>
		<title>NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxCudaMemoryManager.h Source File</title>
		<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
		<LINK HREF="NVIDIA.css" REL="stylesheet" TYPE="text/css">
	</head>

	<body bgcolor="#FFFFFF">
		<div id="header">
			<hr class="first">
			<img alt="" src="images/PhysXlogo.png" align="middle"> <br>
			<center>
				<a class="qindex" href="main.html">Main Page</a> &nbsp; 
				<a class="qindex" href="hierarchy.html">Class Hierarchy</a> &nbsp; 
				<a class="qindex" href="annotated.html">Compound List</a> &nbsp; 
				<a class="qindex" href="functions.html">Compound Members</a> &nbsp;  
			</center>
			<hr class="second">
		</div>
<!-- Generated by Doxygen 1.5.8 -->
<h1>PxCudaMemoryManager.h</h1><a href="PxCudaMemoryManager_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">// This code contains NVIDIA Confidential Information and is disclosed to you</span>
<a name="l00002"></a>00002 <span class="comment">// under a form of NVIDIA software license agreement provided separately to you.</span>
<a name="l00003"></a>00003 <span class="comment">//</span>
<a name="l00004"></a>00004 <span class="comment">// Notice</span>
<a name="l00005"></a>00005 <span class="comment">// NVIDIA Corporation and its licensors retain all intellectual property and</span>
<a name="l00006"></a>00006 <span class="comment">// proprietary rights in and to this software and related documentation and</span>
<a name="l00007"></a>00007 <span class="comment">// any modifications thereto. Any use, reproduction, disclosure, or</span>
<a name="l00008"></a>00008 <span class="comment">// distribution of this software and related documentation without an express</span>
<a name="l00009"></a>00009 <span class="comment">// license agreement from NVIDIA Corporation is strictly prohibited.</span>
<a name="l00010"></a>00010 <span class="comment">//</span>
<a name="l00011"></a>00011 <span class="comment">// ALL NVIDIA DESIGN SPECIFICATIONS, CODE ARE PROVIDED "AS IS.". NVIDIA MAKES</span>
<a name="l00012"></a>00012 <span class="comment">// NO WARRANTIES, EXPRESSED, IMPLIED, STATUTORY, OR OTHERWISE WITH RESPECT TO</span>
<a name="l00013"></a>00013 <span class="comment">// THE MATERIALS, AND EXPRESSLY DISCLAIMS ALL IMPLIED WARRANTIES OF NONINFRINGEMENT,</span>
<a name="l00014"></a>00014 <span class="comment">// MERCHANTABILITY, AND FITNESS FOR A PARTICULAR PURPOSE.</span>
<a name="l00015"></a>00015 <span class="comment">//</span>
<a name="l00016"></a>00016 <span class="comment">// Information and code furnished is believed to be accurate and reliable.</span>
<a name="l00017"></a>00017 <span class="comment">// However, NVIDIA Corporation assumes no responsibility for the consequences of use of such</span>
<a name="l00018"></a>00018 <span class="comment">// information or for any infringement of patents or other rights of third parties that may</span>
<a name="l00019"></a>00019 <span class="comment">// result from its use. No license is granted by implication or otherwise under any patent</span>
<a name="l00020"></a>00020 <span class="comment">// or patent rights of NVIDIA Corporation. Details are subject to change without notice.</span>
<a name="l00021"></a>00021 <span class="comment">// This code supersedes and replaces all information previously supplied.</span>
<a name="l00022"></a>00022 <span class="comment">// NVIDIA Corporation products are not authorized for use as critical</span>
<a name="l00023"></a>00023 <span class="comment">// components in life support devices or systems without express written approval of</span>
<a name="l00024"></a>00024 <span class="comment">// NVIDIA Corporation.</span>
<a name="l00025"></a>00025 <span class="comment">//</span>
<a name="l00026"></a>00026 <span class="comment">// Copyright (c) 2008-2017 NVIDIA Corporation. All rights reserved.</span>
<a name="l00027"></a>00027 
<a name="l00028"></a>00028 <span class="preprocessor">#ifndef PXCUDACONTEXTMANAGER_PXCUDAMEMORYMANAGER_H</span>
<a name="l00029"></a>00029 <span class="preprocessor"></span><span class="preprocessor">#define PXCUDACONTEXTMANAGER_PXCUDAMEMORYMANAGER_H</span>
<a name="l00030"></a>00030 <span class="preprocessor"></span>
<a name="l00031"></a>00031 <span class="preprocessor">#include "<a class="code" href="PxPreprocessor_8h.html">foundation/PxPreprocessor.h</a>"</span>
<a name="l00032"></a>00032 
<a name="l00033"></a>00033 <span class="preprocessor">#if PX_SUPPORT_GPU_PHYSX</span>
<a name="l00034"></a>00034 <span class="preprocessor"></span>
<a name="l00035"></a>00035 <span class="preprocessor">#include "<a class="code" href="PxTaskDefine_8h.html">task/PxTaskDefine.h</a>"</span>
<a name="l00036"></a>00036 
<a name="l00037"></a>00037 <span class="comment">// some macros to keep the source code more readable</span>
<a name="l00038"></a>00038 <span class="preprocessor">#define PX_ALLOC_INFO(name, ID) __FILE__, __LINE__, name, physx::PxAllocId::ID</span>
<a name="l00039"></a>00039 <span class="preprocessor"></span><span class="preprocessor">#define PX_ALLOC_INFO_PARAMS_DECL(p0, p1, p2, p3)  const char* file = p0, int line = p1, const char* allocName = p2, physx::PxAllocId::Enum allocId = physx::PxAllocId::p3</span>
<a name="l00040"></a>00040 <span class="preprocessor"></span><span class="preprocessor">#define PX_ALLOC_INFO_PARAMS_DEF()  const char* file, int line, const char* allocName, physx::PxAllocId::Enum allocId</span>
<a name="l00041"></a>00041 <span class="preprocessor"></span><span class="preprocessor">#define PX_ALLOC_INFO_PARAMS_INPUT()  file, line, allocName, allocId</span>
<a name="l00042"></a>00042 <span class="preprocessor"></span><span class="preprocessor">#define PX_ALLOC_INFO_PARAMS_INPUT_INFO(info) info.getFileName(), info.getLine(), info.getAllocName(), info.getAllocId()</span>
<a name="l00043"></a>00043 <span class="preprocessor"></span>
<a name="l00044"></a>00044 <span class="preprocessor">#ifndef NULL // don't want to include &lt;string.h&gt;</span>
<a name="l00045"></a>00045 <span class="preprocessor"></span><span class="preprocessor">#define NULL 0</span>
<a name="l00046"></a>00046 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
<a name="l00047"></a>00047 <span class="preprocessor"></span>
<a name="l00048"></a>00048 <span class="keyword">namespace </span>physx
<a name="l00049"></a>00049 {
<a name="l00050"></a>00050 
<a name="l00051"></a>00051 <a class="code" href="group__foundation.html#g1145ffab2cc9a77ca65b59ba4126342f">PX_PUSH_PACK_DEFAULT</a>
<a name="l00052"></a>00052 
<a name="l00057"></a>00057 <span class="keyword">struct </span>PxAllocId
<a name="l00058"></a>00058 {
<a name="l00062"></a>00062     <span class="keyword">enum</span> Enum
<a name="l00063"></a>00063     {
<a name="l00064"></a>00064         UNASSIGNED,     
<a name="l00065"></a>00065         APEX,           
<a name="l00066"></a>00066         PARTICLES,      
<a name="l00067"></a>00067         GPU_UTIL,       
<a name="l00068"></a>00068         CLOTH,          
<a name="l00069"></a>00069         NUM_IDS         
<a name="l00070"></a>00070     };
<a name="l00071"></a>00071 };
<a name="l00072"></a>00072 
<a name="l00074"></a>00074 <span class="keyword">struct </span>PxCudaBufferMemorySpace
<a name="l00075"></a>00075 {
<a name="l00079"></a>00079     <span class="keyword">enum</span> Enum
<a name="l00080"></a>00080     {
<a name="l00081"></a>00081         T_GPU,
<a name="l00082"></a>00082         T_PINNED_HOST,
<a name="l00083"></a>00083         T_WRITE_COMBINED,
<a name="l00084"></a>00084         T_HOST,
<a name="l00085"></a>00085         COUNT
<a name="l00086"></a>00086     };
<a name="l00087"></a>00087 };
<a name="l00088"></a>00088 
<a name="l00090"></a>00090 <span class="keyword">class </span>PxAllocInfo
<a name="l00091"></a>00091 {
<a name="l00092"></a>00092 <span class="keyword">public</span>:
<a name="l00096"></a>00096     PxAllocInfo() {}
<a name="l00097"></a>00097 
<a name="l00101"></a>00101     PxAllocInfo(<span class="keyword">const</span> <span class="keywordtype">char</span>* file, <span class="keywordtype">int</span> line, <span class="keyword">const</span> <span class="keywordtype">char</span>* allocName, PxAllocId::Enum allocId)
<a name="l00102"></a>00102         : mFileName(file)
<a name="l00103"></a>00103         , mLine(line)
<a name="l00104"></a>00104         , mAllocName(allocName)
<a name="l00105"></a>00105         , mAllocId(allocId)
<a name="l00106"></a>00106     {}
<a name="l00107"></a>00107 
<a name="l00109"></a>00109     <span class="keyword">inline</span>  <span class="keyword">const</span> <span class="keywordtype">char</span>*         getFileName()<span class="keyword"> const</span>
<a name="l00110"></a>00110 <span class="keyword">    </span>{
<a name="l00111"></a>00111         <span class="keywordflow">return</span> mFileName;
<a name="l00112"></a>00112     }
<a name="l00113"></a>00113 
<a name="l00115"></a>00115     <span class="keyword">inline</span>  <span class="keywordtype">int</span>                 getLine()<span class="keyword"> const</span>
<a name="l00116"></a>00116 <span class="keyword">    </span>{
<a name="l00117"></a>00117         <span class="keywordflow">return</span> mLine;
<a name="l00118"></a>00118     }
<a name="l00119"></a>00119 
<a name="l00121"></a>00121     <span class="keyword">inline</span>  <span class="keyword">const</span> <span class="keywordtype">char</span>*         getAllocName()<span class="keyword"> const</span>
<a name="l00122"></a>00122 <span class="keyword">    </span>{
<a name="l00123"></a>00123         <span class="keywordflow">return</span> mAllocName;
<a name="l00124"></a>00124     }
<a name="l00125"></a>00125 
<a name="l00127"></a>00127     <span class="keyword">inline</span>  PxAllocId::Enum     getAllocId()<span class="keyword"> const</span>
<a name="l00128"></a>00128 <span class="keyword">    </span>{
<a name="l00129"></a>00129         <span class="keywordflow">return</span> mAllocId;
<a name="l00130"></a>00130     }
<a name="l00131"></a>00131 
<a name="l00132"></a>00132 <span class="keyword">private</span>:
<a name="l00133"></a>00133     <span class="keyword">const</span> <span class="keywordtype">char</span>*         mFileName;
<a name="l00134"></a>00134     <span class="keywordtype">int</span>                 mLine;
<a name="l00135"></a>00135     <span class="keyword">const</span> <span class="keywordtype">char</span>*         mAllocName;
<a name="l00136"></a>00136     PxAllocId::Enum     mAllocId;
<a name="l00137"></a>00137 };
<a name="l00138"></a>00138 
<a name="l00140"></a>00140 <span class="keyword">struct </span>PxAllocIdStats
<a name="l00141"></a>00141 {
<a name="l00142"></a>00142     <span class="keywordtype">size_t</span> size;        
<a name="l00143"></a>00143     <span class="keywordtype">size_t</span> maxSize;     
<a name="l00144"></a>00144     <span class="keywordtype">size_t</span> elements;    
<a name="l00145"></a>00145     <span class="keywordtype">size_t</span> maxElements; 
<a name="l00146"></a>00146 };
<a name="l00147"></a>00147 
<a name="l00148"></a>00148 <span class="keyword">class </span>PxCudaMemoryManager;
<a name="l00149"></a>00149 <span class="keyword">typedef</span> <span class="keywordtype">size_t</span> PxCudaBufferPtr;
<a name="l00150"></a>00150 
<a name="l00152"></a>00152 <span class="keyword">struct </span>PxCudaBufferFlags
<a name="l00153"></a>00153 {
<a name="l00155"></a>00155     <span class="keyword">enum</span> Enum
<a name="l00156"></a>00156     {
<a name="l00157"></a>00157         F_READ          = (1 &lt;&lt; 0),
<a name="l00158"></a>00158         F_WRITE         = (1 &lt;&lt; 1),
<a name="l00159"></a>00159         F_READ_WRITE    = F_READ | F_WRITE
<a name="l00160"></a>00160     };
<a name="l00161"></a>00161 };
<a name="l00162"></a>00162 
<a name="l00163"></a>00163 
<a name="l00165"></a>00165 <span class="keyword">struct </span>PxCudaMemoryManagerStats
<a name="l00166"></a>00166 {
<a name="l00167"></a>00167 
<a name="l00168"></a>00168     <span class="keywordtype">size_t</span>          heapSize;       
<a name="l00169"></a>00169     <span class="keywordtype">size_t</span>          totalAllocated; 
<a name="l00170"></a>00170     <span class="keywordtype">size_t</span>          maxAllocated;   
<a name="l00171"></a>00171     PxAllocIdStats  allocIdStats[PxAllocId::NUM_IDS]; 
<a name="l00172"></a>00172 };
<a name="l00173"></a>00173 
<a name="l00174"></a>00174 
<a name="l00176"></a>00176 <span class="keyword">struct </span>PxCudaBufferType
<a name="l00177"></a>00177 {
<a name="l00179"></a>00179     <a class="code" href="group__foundation.html#gcb03347b642a2a5bdea1f9b305a6fbec">PX_INLINE</a> PxCudaBufferType(<span class="keyword">const</span> PxCudaBufferType&amp; t)
<a name="l00180"></a>00180         : memorySpace(t.memorySpace)
<a name="l00181"></a>00181         , flags(t.flags)
<a name="l00182"></a>00182     {}
<a name="l00183"></a>00183     
<a name="l00185"></a>00185     <a class="code" href="group__foundation.html#gcb03347b642a2a5bdea1f9b305a6fbec">PX_INLINE</a> PxCudaBufferType(PxCudaBufferMemorySpace::Enum _memSpace, PxCudaBufferFlags::Enum _flags)
<a name="l00186"></a>00186         : memorySpace(_memSpace)
<a name="l00187"></a>00187         , flags(_flags)
<a name="l00188"></a>00188     {}
<a name="l00189"></a>00189 
<a name="l00190"></a>00190     PxCudaBufferMemorySpace::Enum   memorySpace;    
<a name="l00191"></a>00191     PxCudaBufferFlags::Enum         flags;          
<a name="l00192"></a>00192 };
<a name="l00193"></a>00193 
<a name="l00194"></a>00194 
<a name="l00196"></a>00196 <span class="keyword">class </span>PxCudaBuffer
<a name="l00197"></a>00197 {
<a name="l00198"></a>00198 <span class="keyword">public</span>:
<a name="l00200"></a>00200     <span class="keyword">virtual</span> PxCudaMemoryManager*            getCudaMemoryManager() <span class="keyword">const</span> = 0;
<a name="l00201"></a>00201 
<a name="l00203"></a>00203     <span class="keyword">virtual</span> <span class="keywordtype">bool</span>                        free() = 0;
<a name="l00204"></a>00204 
<a name="l00209"></a>00209     <span class="keyword">virtual</span> <span class="keywordtype">bool</span>                        realloc(<span class="keywordtype">size_t</span> size, PX_ALLOC_INFO_PARAMS_DECL(NULL, 0, NULL, UNASSIGNED)) = 0;
<a name="l00210"></a>00210 
<a name="l00212"></a>00212     <span class="keyword">virtual</span> <span class="keyword">const</span> PxCudaBufferType&amp;     getType() <span class="keyword">const</span> = 0;
<a name="l00213"></a>00213 
<a name="l00215"></a>00215     <span class="keyword">virtual</span> PxCudaBufferPtr             getPtr() <span class="keyword">const</span> = 0;
<a name="l00216"></a>00216 
<a name="l00218"></a>00218     <span class="keyword">virtual</span> <span class="keywordtype">size_t</span>                      getSize() <span class="keyword">const</span> = 0;
<a name="l00219"></a>00219 
<a name="l00220"></a>00220 <span class="keyword">protected</span>:
<a name="l00222"></a>00222     <span class="keyword">virtual</span> ~PxCudaBuffer() {}
<a name="l00223"></a>00223 };
<a name="l00224"></a>00224 
<a name="l00225"></a>00225 
<a name="l00227"></a>00227 <span class="keyword">class </span>PxCudaMemoryManager
<a name="l00228"></a>00228 {
<a name="l00229"></a>00229 <span class="keyword">public</span>:
<a name="l00231"></a>00231     <span class="keyword">virtual</span> PxCudaBuffer*               alloc(<span class="keyword">const</span> PxCudaBufferType&amp; type, <span class="keywordtype">size_t</span> size, PX_ALLOC_INFO_PARAMS_DECL(NULL, 0, NULL, UNASSIGNED)) = 0;
<a name="l00232"></a>00232 
<a name="l00234"></a>00234     <span class="keyword">virtual</span> PxCudaBufferPtr             alloc(PxCudaBufferMemorySpace::Enum memorySpace, <span class="keywordtype">size_t</span> size, PX_ALLOC_INFO_PARAMS_DECL(NULL, 0, NULL, UNASSIGNED)) = 0;
<a name="l00235"></a>00235 
<a name="l00237"></a>00237     <span class="keyword">virtual</span> <span class="keywordtype">bool</span>                        free(PxCudaBufferMemorySpace::Enum memorySpace, PxCudaBufferPtr addr) = 0;
<a name="l00238"></a>00238 
<a name="l00240"></a>00240     <span class="keyword">virtual</span> <span class="keywordtype">bool</span>                        realloc(PxCudaBufferMemorySpace::Enum memorySpace, PxCudaBufferPtr addr, <span class="keywordtype">size_t</span> size, PX_ALLOC_INFO_PARAMS_DECL(NULL, 0, NULL, UNASSIGNED)) = 0;
<a name="l00241"></a>00241 
<a name="l00243"></a>00243     <span class="keyword">virtual</span> <span class="keywordtype">void</span>                        getStats(<span class="keyword">const</span> PxCudaBufferType&amp; type, PxCudaMemoryManagerStats&amp; outStats) = 0;
<a name="l00244"></a>00244 
<a name="l00247"></a>00247     <span class="keyword">virtual</span> <span class="keywordtype">bool</span>                        reserve(<span class="keyword">const</span> PxCudaBufferType&amp; type, <span class="keywordtype">size_t</span> size) = 0;
<a name="l00248"></a>00248 
<a name="l00252"></a>00252     <span class="keyword">virtual</span> <span class="keywordtype">bool</span>                        setPageSize(<span class="keyword">const</span> PxCudaBufferType&amp; type, <span class="keywordtype">size_t</span> size) = 0;
<a name="l00253"></a>00253 
<a name="l00256"></a>00256     <span class="keyword">virtual</span> <span class="keywordtype">bool</span>                        setMaxMemorySize(<span class="keyword">const</span> PxCudaBufferType&amp; type, <span class="keywordtype">size_t</span> size) = 0;
<a name="l00257"></a>00257 
<a name="l00259"></a>00259     <span class="keyword">virtual</span> <span class="keywordtype">size_t</span>                      getBaseSize(<span class="keyword">const</span> PxCudaBufferType&amp; type) = 0;
<a name="l00260"></a>00260 
<a name="l00262"></a>00262     <span class="keyword">virtual</span> <span class="keywordtype">size_t</span>                      getPageSize(<span class="keyword">const</span> PxCudaBufferType&amp; type) = 0;
<a name="l00263"></a>00263 
<a name="l00265"></a>00265     <span class="keyword">virtual</span> <span class="keywordtype">size_t</span>                      getMaxMemorySize(<span class="keyword">const</span> PxCudaBufferType&amp; type) = 0;
<a name="l00266"></a>00266 
<a name="l00268"></a>00268     <span class="keyword">virtual</span> PxCudaBufferPtr             getMappedPinnedPtr(PxCudaBufferPtr hostPtr) = 0;
<a name="l00269"></a>00269 
<a name="l00270"></a>00270 <span class="keyword">protected</span>:
<a name="l00272"></a>00272     <span class="keyword">virtual</span> ~PxCudaMemoryManager() {}
<a name="l00273"></a>00273 };
<a name="l00274"></a>00274 
<a name="l00275"></a>00275 <a class="code" href="group__foundation.html#g9aad3b08e5e15565ff39638b753f4a92">PX_POP_PACK</a>
<a name="l00276"></a>00276 
<a name="l00277"></a>00277 
<a name="l00278"></a>00278 } <span class="comment">// end physx namespace</span>
<a name="l00279"></a>00279 
<a name="l00280"></a>00280 <span class="preprocessor">#endif // PX_SUPPORT_GPU_PHYSX</span>
<a name="l00281"></a>00281 <span class="preprocessor"></span><span class="preprocessor">#endif // PXCUDACONTEXTMANAGER_PXCUDAMEMORYMANAGER_H</span>
</pre></div></div>

<hr style="width: 100%; height: 2px;"><br>
Copyright &copy; 2008-2017 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. <a href="http://www.nvidia.com ">www.nvidia.com</a>
</body>
</html>