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 the software renderer
78 # module LoadLibrary call
79 if 'Software' in function.argNames():
80 print r' if (Software) {'
81 print r' retrace::warning(call) << "using WARP for software device\n";'
82 print r' Software = LoadLibraryA("d3d10warp");'
85 # Compensate for the fact we don't trace DXGI object creation
86 if function.name.startswith('D3D11CreateDevice'):
87 print r' if (DriverType == D3D_DRIVER_TYPE_UNKNOWN && !pAdapter) {'
88 print r' DriverType = D3D_DRIVER_TYPE_HARDWARE;'
91 if function.name.startswith('D3D10CreateDevice'):
92 self.forceDriver('D3D10_DRIVER_TYPE')
93 if function.name.startswith('D3D11CreateDevice'):
94 self.forceDriver('D3D_DRIVER_TYPE')
96 Retracer.invokeFunction(self, function)
98 def forceDriver(self, enum):
99 print r' switch (retrace::driver) {'
100 print r' case retrace::DRIVER_HARDWARE:'
101 print r' DriverType = %s_HARDWARE;' % enum
102 print r' Software = NULL;'
104 print r' case retrace::DRIVER_SOFTWARE:'
105 print r' pAdapter = NULL;'
106 print r' DriverType = %s_WARP;' % enum
107 print r' Software = NULL;'
109 print r' case retrace::DRIVER_REFERENCE:'
110 print r' pAdapter = NULL;'
111 print r' DriverType = %s_REFERENCE;' % enum
112 print r' Software = NULL;'
114 print r' case retrace::DRIVER_NULL:'
115 print r' pAdapter = NULL;'
116 print r' DriverType = %s_NULL;' % enum
117 print r' Software = NULL;'
119 print r' case retrace::DRIVER_MODULE:'
120 print r' pAdapter = NULL;'
121 print r' DriverType = %s_SOFTWARE;' % enum
122 print r' Software = LoadLibraryA(retrace::driverModule);'
123 print r' if (!Software) {'
124 print r' retrace::warning(call) << "failed to load " << retrace::driverModule << "\n";'
129 print r' /* fall-through */'
130 print r' case retrace::DRIVER_DEFAULT:'
131 print r' if (DriverType == %s_SOFTWARE) {' % enum
132 print r' Software = LoadLibraryA("d3d10warp");'
133 print r' if (!Software) {'
134 print r' retrace::warning(call) << "failed to load d3d10warp.dll\n";'
140 def invokeInterfaceMethod(self, interface, method):
141 # keep track of the last used device for state dumping
142 if interface.name in ('ID3D10Device', 'ID3D10Device1'):
143 if method.name == 'Release':
144 print r' d3d10Dumper.unbindDevice(_this);'
146 print r' d3d10Dumper.bindDevice(_this);'
147 if interface.name in ('ID3D11DeviceContext',):
148 if method.name == 'Release':
149 print r' d3d11Dumper.unbindDevice(_this);'
151 print r' d3d11Dumper.bindDevice(_this);'
153 # create windows as neccessary
154 if method.name == 'CreateSwapChain':
155 print r' createWindow(pDesc);'
157 # notify frame has been completed
158 if method.name == 'Present':
159 print r' retrace::frameComplete(call);'
161 if 'pSharedResource' in method.argNames():
162 print r' if (pSharedResource) {'
163 print r' retrace::warning(call) << "shared surfaces unsupported\n";'
164 print r' pSharedResource = NULL;'
167 Retracer.invokeInterfaceMethod(self, interface, method)
169 # process events after presents
170 if method.name == 'Present':
171 print r' d3dretrace::processEvents();'
173 if method.name == 'Map':
174 print ' VOID *_pbData = NULL;'
175 print ' size_t _MappedSize = 0;'
176 print ' _getMapInfo(_this, %s, _pbData, _MappedSize);' % ', '.join(method.argNames())
177 print ' if (_MappedSize) {'
178 print ' _maps[_this] = _pbData;'
183 if method.name == 'Unmap':
184 print ' VOID *_pbData = 0;'
185 print ' _pbData = _maps[_this];'
186 print ' if (_pbData) {'
187 print ' retrace::delRegionByPointer(_pbData);'
188 print ' _maps[_this] = 0;'
191 # Attach shader byte code for lookup
192 if 'pShaderBytecode' in method.argNames():
193 ppShader = method.args[-1]
194 assert ppShader.output
195 print r' if (retrace::dumpingState && SUCCEEDED(_result)) {'
196 print r' (*%s)->SetPrivateData(d3dstate::GUID_D3DSTATE, BytecodeLength, pShaderBytecode);' % ppShader.name
201 print r'#include <string.h>'
203 print r'#include <iostream>'
205 print r'#include "d3dretrace.hpp"'
208 moduleNames = sys.argv[1:]
215 if 'd3d10' in moduleNames:
216 if 'd3d10_1' in moduleNames:
217 print r'#include "d3d10_1imports.hpp"'
218 api.addModule(d3d10_1)
220 print r'#include "d3d10imports.hpp"'
221 print r'#include "d3d10size.hpp"'
224 print '''static d3dretrace::D3DDumper<ID3D10Device> d3d10Dumper;'''
227 if 'd3d11' in moduleNames:
228 print r'#include "d3d11imports.hpp"'
229 if 'd3d11_1' in moduleNames:
230 print '#include <d3d11_1.h>'
232 print r'#include "d3d11size.hpp"'
233 print r'#include "d3dstate.hpp"'
237 print '''static d3dretrace::D3DDumper<ID3D11DeviceContext> d3d11Dumper;'''
240 retracer = D3DRetracer()
241 retracer.retraceApi(api)
244 if __name__ == '__main__':