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 #include "trace_resource.hpp"
  37
  38
  39
  40 namespace trace {
  41
  42
  43 #if defined(__APPLE__)
  44 #define TRACE_VARIABLE "DYLD_LIBRARY_PATH"
  45 #define GL_TRACE_WRAPPER  "OpenGL"
  46 #elif defined(_WIN32)
  47 #define GL_TRACE_WRAPPER  "opengl32.dll"
  48 #else
  49 #define TRACE_VARIABLE "LD_PRELOAD"
  50 #define GL_TRACE_WRAPPER  "glxtrace.so"
  51 #define EGL_TRACE_WRAPPER  "egltrace.so"
  52 #endif
  53
  54
  55 static inline bool
  56 copyWrapper(const os::String & wrapperPath,
  57             const char *programPath,
  58             bool verbose)
  59 {
  60     os::String wrapperFilename(wrapperPath);
  61     wrapperFilename.trimDirectory();
  62
  63     os::String tmpWrapper(programPath);
  64     tmpWrapper.trimFilename();
  65     tmpWrapper.join(wrapperFilename);
  66
  67     if (verbose) {
  68         std::cerr << wrapperPath << " -> " << tmpWrapper << "\n";
  69     }
  70
  71     if (tmpWrapper.exists()) {
  72         std::cerr << "error: not overwriting " << tmpWrapper << "\n";
  73         return false;
  74     }
  75
  76     if (!os::copyFile(wrapperPath, tmpWrapper, false)) {
  77         std::cerr << "error: failed to copy " << wrapperPath << " into " << tmpWrapper << "\n";
  78         return false;
  79     }
  80
  81     return true;
  82 }
  83
  84
  85 static const char *glWrappers[] = {
  86     GL_TRACE_WRAPPER,
  87     NULL
  88 };
  89
  90 #ifdef EGL_TRACE_WRAPPER
  91 static const char *eglWrappers[] = {
  92     EGL_TRACE_WRAPPER,
  93     NULL
  94 };
  95 #endif
  96
  97 #ifdef _WIN32
  98 static const char *d3d7Wrappers[] = {
  99     "ddraw.dll",
 100     NULL
 101 };
 102
 103 static const char *d3d8Wrappers[] = {
 104     "d3d8.dll",
 105     NULL
 106 };
 107
 108 static const char *d3d9Wrappers[] = {
 109     "d3d9.dll",
 110     NULL
 111 };
 112
 113 static const char *dxgiWrappers[] = {
 114     "dxgitrace.dll",
 115     //"dxgi.dll",
 116     "d3d10.dll",
 117     "d3d10_1.dll",
 118     "d3d11.dll",
 119     NULL
 120 };
 121 #endif
 122
 123 int
 124 traceProgram(API api,
 125              char * const *argv,
 126              const char *output,
 127              bool verbose)
 128 {
 129     const char **wrapperFilenames;
 130     unsigned numWrappers;
 131     int status = 1;
 132
 133     /*
 134      * TODO: simplify code
 135      */
 136
 137     switch (api) {
 138     case API_GL:
 139         wrapperFilenames = glWrappers;
 140         break;
 141 #ifdef EGL_TRACE_WRAPPER
 142     case API_EGL:
 143         wrapperFilenames = eglWrappers;
 144         break;
 145 #endif
 146 #ifdef _WIN32
 147     case API_D3D7:
 148         wrapperFilenames = d3d7Wrappers;
 149         break;
 150     case API_D3D8:
 151         wrapperFilenames = d3d8Wrappers;
 152         break;
 153     case API_D3D9:
 154         wrapperFilenames = d3d9Wrappers;
 155         break;
 156     case API_D3D10:
 157     case API_D3D10_1:
 158     case API_D3D11:
 159         wrapperFilenames = dxgiWrappers;
 160         break;
 161 #endif
 162     default:
 163         std::cerr << "error: unsupported API\n";
 164         return 1;
 165     }
 166
 167     numWrappers = 0;
 168     while (wrapperFilenames[numWrappers]) {
 169         ++numWrappers;
 170     }
 171
 172     unsigned i;
 173     for (i = 0; i < numWrappers; ++i) {
 174         const char *wrapperFilename = wrapperFilenames[i];
 175
 176         os::String wrapperPath = findWrapper(wrapperFilename);
 177
 178         if (!wrapperPath.length()) {
 179             std::cerr << "error: failed to find " << wrapperFilename << "\n";
 180             goto exit;
 181         }
 182
 183 #if defined(_WIN32)
 184         /* On Windows copy the wrapper to the program directory.
 185          */
 186         if (!copyWrapper(wrapperPath, argv[0], verbose)) {
 187             goto exit;
 188         }
 189 #endif /* _WIN32 */
 190
 191 #if defined(__APPLE__)
 192         /* On Mac OS X, using DYLD_LIBRARY_PATH, we actually set the
 193          * directory, not the file. */
 194         wrapperPath.trimFilename();
 195 #endif
 196
 197 #if defined(TRACE_VARIABLE)
 198         assert(numWrappers == 1);
 199         if (verbose) {
 200             std::cerr << TRACE_VARIABLE << "=" << wrapperPath.str() << "\n";
 201         }
 202         /* FIXME: Don't modify the current environment */
 203         os::setEnvironment(TRACE_VARIABLE, wrapperPath.str());
 204 #endif /* TRACE_VARIABLE */
 205     }
 206
 207     if (output) {
 208         os::setEnvironment("TRACE_FILE", output);
 209     }
 210
 211     if (verbose) {
 212         const char *sep = "";
 213         for (char * const * arg = argv; *arg; ++arg) {
 214             std::cerr << *arg << sep;
 215             sep = " ";
 216         }
 217         std::cerr << "\n";
 218     }
 219
 220     status = os::execute(argv);
 221
 222 exit:
 223 #if defined(TRACE_VARIABLE)
 224     os::unsetEnvironment(TRACE_VARIABLE);
 225 #endif
 226 #if defined(_WIN32)
 227     for (unsigned j = 0; j < i; ++j) {
 228         const char *wrapperFilename = wrapperFilenames[j];
 229         os::String tmpWrapper(argv[0]);
 230         tmpWrapper.trimFilename();
 231         tmpWrapper.join(wrapperFilename);
 232         os::removeFile(tmpWrapper);
 233     }
 234 #endif
 235
 236     if (output) {
 237         os::unsetEnvironment("TRACE_FILE");
 238     }
 239
 240     return status;
 241
 242 }
 243
 244
 245 } /* namespace trace */