1 ##########################################################################
3 # Copyright 2011 Jose Fonseca
6 # Permission is hereby granted, free of charge, to any person obtaining a copy
7 # of this software and associated documentation files (the "Software"), to deal
8 # in the Software without restriction, including without limitation the rights
9 # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 # copies of the Software, and to permit persons to whom the Software is
11 # furnished to do so, subject to the following conditions:
13 # The above copyright notice and this permission notice shall be included in
14 # all copies or substantial portions of the Software.
16 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
24 ##########################################################################/
27 """D3D retracer generator."""
31 from dllretrace import DllRetracer as Retracer
32 from specs.stdapi import API
33 from specs.dxgi import dxgi
34 from specs.d3d10 import d3d10
35 from specs.d3d10_1 import d3d10_1
36 from specs.d3d11 import d3d11
39 class D3DRetracer(Retracer):
41 def retraceApi(self, api):
42 print '// Swizzling mapping for lock addresses'
43 print 'static std::map<void *, void *> _maps;'
47 createWindow(DXGI_SWAP_CHAIN_DESC *pSwapChainDesc) {
48 if (pSwapChainDesc->Windowed) {
49 UINT Width = pSwapChainDesc->BufferDesc.Width;
50 UINT Height = pSwapChainDesc->BufferDesc.Height;
51 if (!Width) Width = 1024;
52 if (!Height) Height = 768;
53 pSwapChainDesc->OutputWindow = d3dretrace::createWindow(Width, Height);
58 self.table_name = 'd3dretrace::dxgi_callbacks'
60 Retracer.retraceApi(self, api)
62 createDeviceFunctionNames = [
64 "D3D10CreateDeviceAndSwapChain",
66 "D3D10CreateDeviceAndSwapChain1",
68 "D3D11CreateDeviceAndSwapChain",
71 def invokeFunction(self, function):
72 if function.name in self.createDeviceFunctionNames:
73 # create windows as neccessary
74 if 'pSwapChainDesc' in function.argNames():
75 print r' createWindow(pSwapChainDesc);'
77 # Compensate for the fact we don't trace DXGI object creation
78 if function.name.startswith('D3D11CreateDevice'):
79 print r' if (DriverType == D3D_DRIVER_TYPE_UNKNOWN && !pAdapter) {'
80 print r' DriverType = D3D_DRIVER_TYPE_HARDWARE;'
83 if function.name.startswith('D3D10CreateDevice'):
85 print r' Flags &= ~D3D10_CREATE_DEVICE_DEBUG;'
86 print r' if (retrace::debug) {'
87 print r' if (LoadLibraryA("d3d10sdklayers")) {'
88 print r' Flags |= D3D10_CREATE_DEVICE_DEBUG;'
93 self.forceDriver('D3D10_DRIVER_TYPE')
95 if function.name.startswith('D3D11CreateDevice'):
97 print r' Flags &= ~D3D11_CREATE_DEVICE_DEBUG;'
98 print r' if (retrace::debug) {'
99 print r' if (LoadLibraryA("d3d11sdklayers")) {'
100 print r' Flags |= D3D11_CREATE_DEVICE_DEBUG;'
105 self.forceDriver('D3D_DRIVER_TYPE')
107 Retracer.invokeFunction(self, function)
109 def forceDriver(self, enum):
110 # This can only work when pAdapter is NULL. For non-NULL pAdapter we
111 # need to override inside the EnumAdapters call below
112 print r' if (pAdapter == NULL) {'
113 print r' switch (retrace::driver) {'
114 print r' case retrace::DRIVER_HARDWARE:'
115 print r' DriverType = %s_HARDWARE;' % enum
116 print r' Software = NULL;'
118 print r' case retrace::DRIVER_SOFTWARE:'
119 print r' DriverType = %s_WARP;' % enum
120 print r' Software = NULL;'
122 print r' case retrace::DRIVER_REFERENCE:'
123 print r' DriverType = %s_REFERENCE;' % enum
124 print r' Software = NULL;'
126 print r' case retrace::DRIVER_NULL:'
127 print r' DriverType = %s_NULL;' % enum
128 print r' Software = NULL;'
130 print r' case retrace::DRIVER_MODULE:'
131 print r' DriverType = %s_SOFTWARE;' % enum
132 print r' Software = LoadLibraryA(retrace::driverModule);'
133 print r' if (!Software) {'
134 print r' retrace::warning(call) << "failed to load " << retrace::driverModule << "\n";'
139 print r' /* fall-through */'
140 print r' case retrace::DRIVER_DEFAULT:'
141 print r' if (DriverType == %s_SOFTWARE) {' % enum
142 print r' Software = LoadLibraryA("d3d10warp");'
143 print r' if (!Software) {'
144 print r' retrace::warning(call) << "failed to load d3d10warp.dll\n";'
150 print r' Software = NULL;'
153 def invokeInterfaceMethod(self, interface, method):
154 # keep track of the last used device for state dumping
155 if interface.name in ('ID3D10Device', 'ID3D10Device1'):
156 if method.name == 'Release':
157 print r' d3d10Dumper.unbindDevice(_this);'
159 print r' d3d10Dumper.bindDevice(_this);'
160 if interface.name in ('ID3D11DeviceContext',):
161 if method.name == 'Release':
162 print r' d3d11Dumper.unbindDevice(_this);'
164 print r' d3d11Dumper.bindDevice(_this);'
166 # create windows as neccessary
167 if method.name == 'CreateSwapChain':
168 print r' createWindow(pDesc);'
170 # notify frame has been completed
171 if method.name == 'Present':
172 print r' retrace::frameComplete(call);'
174 if 'pSharedResource' in method.argNames():
175 print r' if (pSharedResource) {'
176 print r' retrace::warning(call) << "shared surfaces unsupported\n";'
177 print r' pSharedResource = NULL;'
181 if interface.name.startswith('IDXGIFactory') and method.name == 'EnumAdapters':
182 print r' const char *szSoftware = NULL;'
183 print r' switch (retrace::driver) {'
184 print r' case retrace::DRIVER_REFERENCE:'
185 print r' case retrace::DRIVER_SOFTWARE:'
186 print r' szSoftware = "d3d10warp.dll";'
188 print r' case retrace::DRIVER_MODULE:'
189 print r' szSoftware = retrace::driverModule;'
194 print r' HMODULE hSoftware = NULL;'
195 print r' if (szSoftware) {'
196 print r' hSoftware = LoadLibraryA(szSoftware);'
197 print r' if (!hSoftware) {'
198 print r' retrace::warning(call) << "failed to load " << szSoftware << "\n";'
201 print r' if (hSoftware) {'
202 print r' _result = _this->CreateSoftwareAdapter(hSoftware, ppAdapter);'
204 Retracer.invokeInterfaceMethod(self, interface, method)
208 Retracer.invokeInterfaceMethod(self, interface, method)
210 # process events after presents
211 if method.name == 'Present':
212 print r' d3dretrace::processEvents();'
214 if method.name == 'Map':
215 print ' VOID *_pbData = NULL;'
216 print ' size_t _MappedSize = 0;'
217 print ' _getMapInfo(_this, %s, _pbData, _MappedSize);' % ', '.join(method.argNames())
218 print ' if (_MappedSize) {'
219 print ' _maps[_this] = _pbData;'
224 if method.name == 'Unmap':
225 print ' VOID *_pbData = 0;'
226 print ' _pbData = _maps[_this];'
227 print ' if (_pbData) {'
228 print ' retrace::delRegionByPointer(_pbData);'
229 print ' _maps[_this] = 0;'
232 # Attach shader byte code for lookup
233 if 'pShaderBytecode' in method.argNames():
234 ppShader = method.args[-1]
235 assert ppShader.output
236 print r' if (retrace::dumpingState && SUCCEEDED(_result)) {'
237 print r' (*%s)->SetPrivateData(d3dstate::GUID_D3DSTATE, BytecodeLength, pShaderBytecode);' % ppShader.name
242 print r'#include <string.h>'
244 print r'#include <iostream>'
246 print r'#include "d3dretrace.hpp"'
249 moduleNames = sys.argv[1:]
256 if 'd3d10' in moduleNames:
257 if 'd3d10_1' in moduleNames:
258 print r'#include "d3d10_1imports.hpp"'
259 api.addModule(d3d10_1)
261 print r'#include "d3d10imports.hpp"'
262 print r'#include "d3d10size.hpp"'
265 print '''static d3dretrace::D3DDumper<ID3D10Device> d3d10Dumper;'''
268 if 'd3d11' in moduleNames:
269 print r'#include "d3d11imports.hpp"'
270 if 'd3d11_1' in moduleNames:
271 print '#include <d3d11_1.h>'
273 print r'#include "d3d11size.hpp"'
274 print r'#include "d3dstate.hpp"'
278 print '''static d3dretrace::D3DDumper<ID3D11DeviceContext> d3d11Dumper;'''
281 retracer = D3DRetracer()
282 retracer.retraceApi(api)
285 if __name__ == '__main__':