trace_tools_trace.cpp

/*********************************************************************
 *
 * Copyright 2011 Intel Corporation
 * All Rights Reserved.
 *
 * Permission is hereby granted, free of charge, to any person
 * obtaining a copy of this software and associated documentation
 * files (the "Software"), to deal in the Software without
 * restriction, including without limitation the rights to use, copy,
 * modify, merge, publish, distribute, sublicense, and/or sell copies
 * of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be
 * included in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 *
 *********************************************************************/


#include <stdlib.h>

#include <iostream>

#include "os_path.hpp"
#include "os_process.hpp"
#include "trace_tools.hpp"



namespace trace {


#if defined(__APPLE__)
#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"
#define GL_TRACE_WRAPPER  "glxtrace.so"
#define EGL_TRACE_WRAPPER  "egltrace.so"
#endif


os::Path
findFile(const char *relPath,
         const char *absPath,
         bool verbose)
{
    os::Path complete;

    /* First look in the same directory from which this process is
     * running, (to support developers running a compiled program that
     * has not been installed. */
    os::Path process_dir = os::getProcessName();

    process_dir.trimFilename();

    complete = process_dir;
    complete.join(relPath);

    if (complete.exists())
        return complete;

    /* Second, look in the directory for installed wrappers. */
    complete = absPath;
    if (complete.exists())
        return complete;

    if (verbose) {
        std::cerr << "error: cannot find " << relPath << " or " << absPath << "\n";
    }

    return "";
}


int
traceProgram(API api,
             char * const *argv,
             const char *output,
             bool verbose)
{
    const char *relPath;
    const char *absPath;

    switch (api) {
    case API_GL:
        relPath = "wrappers/" GL_TRACE_WRAPPER;
        absPath = APITRACE_WRAPPER_INSTALL_DIR "/" GL_TRACE_WRAPPER;
        break;
    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;
        break;
#endif
    default:
        std::cerr << "error: invalid API\n";
        return 1;
    }

    os::Path wrapper;
    wrapper = findFile(relPath, absPath, verbose);

    if (!wrapper.length()) {
        return 1;
    }

#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 defined(__APPLE__)
    /* On Mac OS X, using DYLD_LIBRARY_PATH, we actually set the
     * directory, not the file. */
    wrapper.trimFilename();
#endif

    if (verbose) {
        std::cerr << TRACE_VARIABLE << "=" << wrapper.str() << "\n";
    }

    /* FIXME: Don't modify the current environment */
    setenv(TRACE_VARIABLE, wrapper.str(), 1);

    if (output) {
        setenv("TRACE_FILE", output, 1);
    }

    if (verbose) {
        const char *sep = "";
        for (char * const * arg = argv; *arg; ++arg) {
            std::cerr << *arg << sep;
            sep = " ";
        }
        std::cerr << "\n";
    }

    int status = os::execute(argv);

    unsetenv(TRACE_VARIABLE);
    if (output) {
        unsetenv("TRACE_FILE");
    }
    
    return status;
#endif

}


} /* namespace trace */