inject: Use DLL injection for D3D10+ tracing.

[apitrace] / common / trace_tools_trace.cpp

diff --git a/common/trace_tools_trace.cpp b/common/trace_tools_trace.cpp
index 768fd108d3541eaf1352b09c910b2c4c335bd1ea..77fc5520ba90a3797bb5a1e3b6d75d50b9d91b21 100644 (file)
--- a/common/trace_tools_trace.cpp
+++ b/common/trace_tools_trace.cpp
@@ -32,8 +32,8 @@
 
 #include "os_string.hpp"
 #include "os_process.hpp"
-#include "trace_resource.hpp"
 #include "trace_tools.hpp"
+#include "trace_resource.hpp"
 
 
 
@@ -44,7 +44,6 @@ namespace trace {
 #define TRACE_VARIABLE "DYLD_LIBRARY_PATH"
 #define GL_TRACE_WRAPPER  "OpenGL"
 #elif defined(_WIN32)
-#define TRACE_VARIABLE ""
 #define GL_TRACE_WRAPPER  "opengl32.dll"
 #else
 #define TRACE_VARIABLE "LD_PRELOAD"
@@ -53,88 +52,155 @@ namespace trace {
 #endif
 
 
+static inline bool
+copyWrapper(const os::String & wrapperPath,
+            const char *programPath,
+            bool verbose)
+{
+    os::String wrapperFilename(wrapperPath);
+    wrapperFilename.trimDirectory();
+
+    os::String tmpWrapper(programPath);
+    tmpWrapper.trimFilename();
+    tmpWrapper.join(wrapperFilename);
+
+    if (verbose) {
+        std::cerr << wrapperPath << " -> " << tmpWrapper << "\n";
+    }
+
+    if (tmpWrapper.exists()) {
+        std::cerr << "error: not overwriting " << tmpWrapper << "\n";
+        return false;
+    }
+
+    if (!os::copyFile(wrapperPath, tmpWrapper, false)) {
+        std::cerr << "error: failed to copy " << wrapperPath << " into " << tmpWrapper << "\n";
+        return false;
+    }
+
+    return true;
+}
+
+
 int
 traceProgram(API api,
              char * const *argv,
              const char *output,
              bool verbose)
 {
-    const char *relPath;
-    const char *absPath;
+    const char *wrapperFilename;
+    std::vector<const char *> args;
+    int status = 1;
+
+    /*
+     * TODO: simplify code
+     */
 
+    bool useInject = false;
     switch (api) {
     case API_GL:
-        relPath = "wrappers/" GL_TRACE_WRAPPER;
-        absPath = APITRACE_WRAPPER_INSTALL_DIR "/" GL_TRACE_WRAPPER;
+        wrapperFilename = GL_TRACE_WRAPPER;
         break;
+#ifdef EGL_TRACE_WRAPPER
     case API_EGL:
-#ifndef EGL_TRACE_WRAPPER
-        std::cerr << "error: unsupported API\n";
-        return 1;
-#else
-        relPath = "wrappers/" EGL_TRACE_WRAPPER;
-        absPath = APITRACE_WRAPPER_INSTALL_DIR "/" EGL_TRACE_WRAPPER;
+        wrapperFilename = EGL_TRACE_WRAPPER;
+        break;
+#endif
+#ifdef _WIN32
+    case API_D3D7:
+        wrapperFilename = "ddraw.dll";
+        break;
+    case API_D3D8:
+        wrapperFilename = "d3d8.dll";
+        break;
+    case API_D3D9:
+        wrapperFilename = "d3d9.dll";
+        break;
+    case API_D3D10:
+    case API_D3D10_1:
+    case API_D3D11:
+        wrapperFilename = "dxgitrace.dll";
+        useInject = true;
         break;
 #endif
     default:
-        std::cerr << "error: invalid API\n";
+        std::cerr << "error: unsupported API\n";
         return 1;
     }
 
-    os::String wrapper;
-    wrapper = findFile(relPath, absPath, verbose);
-
-    if (!wrapper.length()) {
-        return 1;
+    os::String wrapperPath = findWrapper(wrapperFilename);
+    if (!wrapperPath.length()) {
+        std::cerr << "error: failed to find " << wrapperFilename << "\n";
+        goto exit;
     }
 
 #if defined(_WIN32)
-
-    std::cerr <<
-        "The 'apitrace trace' command is not supported for this operating system.\n"
-        "Instead, you will need to copy opengl32.dll, d3d8.dll, or d3d9.dll from\n"
-        APITRACE_WRAPPER_INSTALL_DIR "\n"
-        "to the directory with the application to trace, then run the application.\n";
-
-    return 1;
-
-#else
+    if (useInject) {
+        args.push_back("inject");
+        args.push_back(wrapperPath);
+    } else {
+        /* On Windows copy the wrapper to the program directory.
+         */
+        if (!copyWrapper(wrapperPath, argv[0], verbose)) {
+            goto exit;
+        }
+    }
+#else  /* !_WIN32 */
+    (void)useInject;
+#endif /* !_WIN32 */
 
 #if defined(__APPLE__)
     /* On Mac OS X, using DYLD_LIBRARY_PATH, we actually set the
      * directory, not the file. */
-    wrapper.trimFilename();
+    wrapperPath.trimFilename();
 #endif
 
+#if defined(TRACE_VARIABLE)
     if (verbose) {
-        std::cerr << TRACE_VARIABLE << "=" << wrapper.str() << "\n";
+        std::cerr << TRACE_VARIABLE << "=" << wrapperPath.str() << "\n";
     }
-
     /* FIXME: Don't modify the current environment */
-    setenv(TRACE_VARIABLE, wrapper.str(), 1);
+    os::setEnvironment(TRACE_VARIABLE, wrapperPath.str());
+#endif /* TRACE_VARIABLE */
 
     if (output) {
-        setenv("TRACE_FILE", output, 1);
+        os::setEnvironment("TRACE_FILE", output);
     }
 
+    for (char * const * arg = argv; *arg; ++arg) {
+        args.push_back(*arg);
+    }
+    args.push_back(NULL);
+
     if (verbose) {
         const char *sep = "";
-        for (char * const * arg = argv; *arg; ++arg) {
-            std::cerr << *arg << sep;
+        for (unsigned i = 0; i < args.size(); ++i) {
+            std::cerr << sep << args[i];
             sep = " ";
         }
         std::cerr << "\n";
     }
 
-    int status = os::execute(argv);
+    status = os::execute((char * const *)&args[0]);
+
+exit:
+#if defined(TRACE_VARIABLE)
+    os::unsetEnvironment(TRACE_VARIABLE);
+#endif
+#if defined(_WIN32)
+    if (!useInject) {
+        os::String tmpWrapper(argv[0]);
+        tmpWrapper.trimFilename();
+        tmpWrapper.join(wrapperFilename);
+        os::removeFile(tmpWrapper);
+    }
+#endif
 
-    unsetenv(TRACE_VARIABLE);
     if (output) {
-        unsetenv("TRACE_FILE");
+        os::unsetEnvironment("TRACE_FILE");
     }
     
     return status;
-#endif
 
 }