git.cworth.org Git - apitrace/blob - common/trace_tools_trace.cpp

   1 /*********************************************************************
   2  *
   3  * Copyright 2011 Intel Corporation
   4  * All Rights Reserved.
   5  *
   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:
  13  *
  14  * The above copyright notice and this permission notice shall be
  15  * included in all copies or substantial portions of the Software.
  16  *
  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
  24  * SOFTWARE.
  25  *
  26  *********************************************************************/
  27
  28
  29 #include <stdlib.h>
  30
  31 #include <iostream>
  32
  33 #include "os_string.hpp"
  34 #include "os_process.hpp"
  35 #include "trace_tools.hpp"
  36
  37
  38
  39 namespace trace {
  40
  41
  42 #if defined(__APPLE__)
  43 #define TRACE_VARIABLE "DYLD_LIBRARY_PATH"
  44 #define GL_TRACE_WRAPPER  "OpenGL"
  45 #elif defined(_WIN32)
  46 #define GL_TRACE_WRAPPER  "opengl32.dll"
  47 #else
  48 #define TRACE_VARIABLE "LD_PRELOAD"
  49 #define GL_TRACE_WRAPPER  "glxtrace.so"
  50 #define EGL_TRACE_WRAPPER  "egltrace.so"
  51 #endif
  52
  53
  54 static os::String
  55 findWrapper(const char *wrapperFilename)
  56 {
  57     os::String wrapperPath;
  58
  59     os::String processDir = os::getProcessName();
  60     processDir.trimFilename();
  61
  62     // Try relative build directory
  63     // XXX: Just make build and install directory layout match
  64     wrapperPath = processDir;
  65     wrapperPath.join("wrappers");
  66     wrapperPath.join(wrapperFilename);
  67     if (wrapperPath.exists()) {
  68         return wrapperPath;
  69     }
  70
  71     // Try relative install directory
  72     wrapperPath = processDir;
  73 #if defined(_WIN32)
  74     wrapperPath.join("..\\lib\\wrappers");
  75 #elif defined(__APPLE__)
  76     wrapperPath.join("../lib/wrappers");
  77 #else
  78     wrapperPath.join("../lib/apitrace/wrappers");
  79 #endif
  80     wrapperPath.join(wrapperFilename);
  81     if (wrapperPath.exists()) {
  82         return wrapperPath;
  83     }
  84
  85 #ifndef _WIN32
  86     // Try absolute install directory
  87     wrapperPath = APITRACE_WRAPPERS_INSTALL_DIR;
  88     wrapperPath.join(wrapperFilename);
  89     if (wrapperPath.exists()) {
  90         return wrapperPath;
  91     }
  92 #endif
  93
  94     return "";
  95 }
  96
  97
  98 int
  99 traceProgram(API api,
 100              char * const *argv,
 101              const char *output,
 102              bool verbose)
 103 {
 104     const char *wrapperFilename;
 105
 106     /*
 107      * TODO: simplify code
 108      */
 109
 110     switch (api) {
 111     case API_GL:
 112         wrapperFilename = GL_TRACE_WRAPPER;
 113         break;
 114 #ifdef EGL_TRACE_WRAPPER
 115     case API_EGL:
 116         wrapperFilename = EGL_TRACE_WRAPPER;
 117         break;
 118 #endif
 119 #ifdef _WIN32
 120     case API_D3D7:
 121         wrapperFilename = "ddraw.dll";
 122         break;
 123     case API_D3D8:
 124         wrapperFilename = "d3d8.dll";
 125         break;
 126     case API_D3D9:
 127         wrapperFilename = "d3d9.dll";
 128         break;
 129     case API_D3D10:
 130         wrapperFilename = "d3d10.dll";
 131         break;
 132     case API_D3D10_1:
 133         wrapperFilename = "d3d10_1.dll";
 134         break;
 135     case API_D3D11:
 136         wrapperFilename = "d3d11.dll";
 137         break;
 138 #endif
 139     default:
 140         std::cerr << "error: unsupported API\n";
 141         return 1;
 142     }
 143
 144     os::String wrapperPath = findWrapper(wrapperFilename);
 145
 146     if (!wrapperPath.length()) {
 147         std::cerr << "error: failed to find " << wrapperFilename << "\n";
 148         return 1;
 149     }
 150
 151 #if defined(_WIN32)
 152     /* On Windows copy the wrapper to the program directory.
 153      */
 154     os::String tmpWrapper(argv[0]);
 155     tmpWrapper.trimFilename();
 156     tmpWrapper.join(wrapperFilename);
 157
 158     if (verbose) {
 159         std::cerr << wrapperPath << " -> " << tmpWrapper << "\n";
 160     }
 161
 162     if (tmpWrapper.exists()) {
 163         std::cerr << "error: not overwriting " << tmpWrapper << "\n";
 164         return 1;
 165     }
 166
 167     if (!os::copyFile(wrapperPath, tmpWrapper, false)) {
 168         std::cerr << "error: failed to copy " << wrapperPath << " into " << tmpWrapper << "\n";
 169         return 1;
 170     }
 171 #endif /* _WIN32 */
 172
 173 #if defined(__APPLE__)
 174     /* On Mac OS X, using DYLD_LIBRARY_PATH, we actually set the
 175      * directory, not the file. */
 176     wrapperPath.trimFilename();
 177 #endif
 178
 179 #if defined(TRACE_VARIABLE)
 180     if (verbose) {
 181         std::cerr << TRACE_VARIABLE << "=" << wrapperPath.str() << "\n";
 182     }
 183     /* FIXME: Don't modify the current environment */
 184     os::setEnvironment(TRACE_VARIABLE, wrapperPath.str());
 185 #endif /* TRACE_VARIABLE */
 186
 187     if (output) {
 188         os::setEnvironment("TRACE_FILE", output);
 189     }
 190
 191     if (verbose) {
 192         const char *sep = "";
 193         for (char * const * arg = argv; *arg; ++arg) {
 194             std::cerr << *arg << sep;
 195             sep = " ";
 196         }
 197         std::cerr << "\n";
 198     }
 199
 200     int status = os::execute(argv);
 201
 202 #if defined(TRACE_VARIABLE)
 203     os::unsetEnvironment(TRACE_VARIABLE);
 204 #endif
 205 #if defined(_WIN32)
 206     os::removeFile(tmpWrapper);
 207 #endif
 208
 209     if (output) {
 210         os::unsetEnvironment("TRACE_FILE");
 211     }
 212
 213     return status;
 214
 215 }
 216
 217
 218 } /* namespace trace */