1 /*********************************************************************
3 * Copyright 2011 Intel Corporation
6 * Permission is hereby granted, free of charge, to any person
7 * obtaining a copy of this software and associated documentation
8 * files (the "Software"), to deal in the Software without
9 * restriction, including without limitation the rights to use, copy,
10 * modify, merge, publish, distribute, sublicense, and/or sell copies
11 * of the Software, and to permit persons to whom the Software is
12 * furnished to do so, subject to the following conditions:
14 * The above copyright notice and this permission notice shall be
15 * included in all copies or substantial portions of the Software.
17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
18 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
19 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
20 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
21 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
22 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
23 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
26 *********************************************************************/
36 #include "os_string.hpp"
37 #include "os_process.hpp"
40 #include "cli_resources.hpp"
43 #if defined(__APPLE__)
44 #define TRACE_VARIABLE "DYLD_LIBRARY_PATH"
45 #define GL_TRACE_WRAPPER "OpenGL"
47 #define GL_TRACE_WRAPPER "opengl32.dll"
49 #define TRACE_VARIABLE "LD_PRELOAD"
50 #define GL_TRACE_WRAPPER "glxtrace.so"
51 #define EGL_TRACE_WRAPPER "egltrace.so"
56 copyWrapper(const os::String & wrapperPath,
57 const char *programPath,
60 os::String wrapperFilename(wrapperPath);
61 wrapperFilename.trimDirectory();
63 os::String tmpWrapper(programPath);
64 tmpWrapper.trimFilename();
65 tmpWrapper.join(wrapperFilename);
68 std::cerr << wrapperPath << " -> " << tmpWrapper << "\n";
71 if (tmpWrapper.exists()) {
72 std::cerr << "error: not overwriting " << tmpWrapper << "\n";
76 if (!os::copyFile(wrapperPath, tmpWrapper, false)) {
77 std::cerr << "error: failed to copy " << wrapperPath << " into " << tmpWrapper << "\n";
86 traceProgram(trace::API api,
91 const char *wrapperFilename;
92 std::vector<const char *> args;
99 bool useInject = false;
102 wrapperFilename = GL_TRACE_WRAPPER;
104 #ifdef EGL_TRACE_WRAPPER
106 wrapperFilename = EGL_TRACE_WRAPPER;
110 case trace::API_D3D7:
111 wrapperFilename = "ddraw.dll";
113 case trace::API_D3D8:
114 wrapperFilename = "d3d8.dll";
116 case trace::API_D3D9:
117 wrapperFilename = "d3d9.dll";
119 case trace::API_DXGI:
120 wrapperFilename = "dxgitrace.dll";
125 std::cerr << "error: unsupported API\n";
129 os::String wrapperPath = findWrapper(wrapperFilename, verbose);
130 if (!wrapperPath.length()) {
131 std::cerr << "error: failed to find " << wrapperFilename << " wrapper\n";
138 args.push_back("inject");
139 args.push_back(wrapperPath);
141 /* On Windows copy the wrapper to the program directory.
143 if (!copyWrapper(wrapperPath, argv[0], verbose)) {
151 #if defined(__APPLE__)
152 /* On Mac OS X, using DYLD_LIBRARY_PATH, we actually set the
153 * directory, not the file. */
154 wrapperPath.trimFilename();
158 * Spawn child process.
162 #if defined(TRACE_VARIABLE)
163 const char *oldEnvVarValue = getenv(TRACE_VARIABLE);
164 if (oldEnvVarValue) {
165 wrapperPath.append(OS_PATH_SEP);
166 wrapperPath.append(oldEnvVarValue);
169 /* FIXME: Don't modify our (ie parent) environment */
170 os::setEnvironment(TRACE_VARIABLE, wrapperPath.str());
173 std::cerr << TRACE_VARIABLE << "=" << wrapperPath.str() << "\n";
175 #endif /* TRACE_VARIABLE */
178 os::setEnvironment("TRACE_FILE", output);
181 for (char * const * arg = argv; *arg; ++arg) {
182 args.push_back(*arg);
186 const char *sep = "";
187 for (unsigned i = 0; i < args.size(); ++i) {
188 std::cerr << sep << args[i];
194 args.push_back(NULL);
196 status = os::execute((char * const *)&args[0]);
198 #if defined(TRACE_VARIABLE)
199 if (oldEnvVarValue) {
200 os::setEnvironment(TRACE_VARIABLE, oldEnvVarValue);
202 os::unsetEnvironment(TRACE_VARIABLE);
210 os::String tmpWrapper(argv[0]);
211 tmpWrapper.trimFilename();
212 tmpWrapper.join(wrapperFilename);
213 os::removeFile(tmpWrapper);
218 os::unsetEnvironment("TRACE_FILE");
226 static const char *synopsis = "Generate a new trace by executing the given program.";
231 std::cout << "usage: apitrace trace [OPTIONS] PROGRAM [ARGS ...]\n"
234 " The given program will be executed with the given arguments.\n"
235 " During execution, all OpenGL calls will be captured to a trace\n"
236 " file. That trace file can then be used\n"
237 " with other apitrace utilities for replay or analysis.\n"
239 " -v, --verbose verbose output\n"
240 " -a, --api=API specify API to trace ("
242 "gl, d3d7, d3d8, d3d9, or dxgi (for d3d10 and higher) "
248 " -o, --output=TRACE specify output trace file;\n"
249 " default is `PROGRAM.trace`\n";
253 shortOptions = "+hva:o:";
255 const static struct option
257 {"help", no_argument, 0, 'h'},
258 {"verbose", no_argument, 0, 'v'},
259 {"api", required_argument, 0, 'a'},
260 {"output", required_argument, 0, 'o'},
265 command(int argc, char *argv[])
267 bool verbose = false;
268 trace::API api = trace::API_GL;
269 const char *output = NULL;
272 while ((opt = getopt_long(argc, argv, shortOptions, longOptions, NULL)) != -1) {
281 if (strcmp(optarg, "gl") == 0) {
283 } else if (strcmp(optarg, "egl") == 0) {
284 api = trace::API_EGL;
285 } else if (strcmp(optarg, "d3d7") == 0) {
286 api = trace::API_D3D7;
287 } else if (strcmp(optarg, "d3d8") == 0) {
288 api = trace::API_D3D8;
289 } else if (strcmp(optarg, "d3d9") == 0) {
290 api = trace::API_D3D9;
291 } else if (strcmp(optarg, "dxgi") == 0 ||
292 strcmp(optarg, "d3d10") == 0 ||
293 strcmp(optarg, "d3d10_1") == 0 ||
294 strcmp(optarg, "d3d11") == 0 ||
295 strcmp(optarg, "d3d11_1") == 0) {
296 api = trace::API_DXGI;
298 std::cerr << "error: unknown API `" << optarg << "`\n";
307 std::cerr << "error: unexpected option `" << opt << "`\n";
313 if (optind == argc) {
314 std::cerr << "error: no command specified\n";
319 assert(argv[argc] == 0);
320 return traceProgram(api, argv + optind, output, verbose);
323 const Command trace_command = {