rocm-systems/source/lib/omnitrace-dl/dl.cpp

// MIT License
//
// Copyright (c) 2020, The Regents of the University of California,
// through Lawrence Berkeley National Laboratory (subject to receipt of any
// required approvals from the U.S. Dept. of Energy).  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.

#define OMNITRACE_COMMON_LIBRARY_NAME "dl"

#include "common/defines.h"
#include "common/delimit.hpp"
#include "common/environment.hpp"
#include "common/invoke.hpp"
#include "common/join.hpp"

#include <atomic>
#include <cstdint>
#include <cstdio>
#include <cstdlib>
#include <cstring>
#include <dlfcn.h>
#include <functional>
#include <gnu/libc-version.h>
#include <iostream>
#include <limits>
#include <memory>
#include <sstream>
#include <stdexcept>
#include <string>
#include <sys/stat.h>
#include <unistd.h>

#if !defined(OMNITRACE_USE_OMPT)
#    define OMNITRACE_USE_OMPT 0
#endif

#define OMNITRACE_DLSYM(VARNAME, HANDLE, FUNCNAME)                                       \
    if(HANDLE)                                                                           \
    {                                                                                    \
        *(void**) (&VARNAME) = dlsym(HANDLE, FUNCNAME);                                  \
        if(VARNAME == nullptr && _omnitrace_dl_verbose >= _warn_verbose)                 \
        {                                                                                \
            fprintf(stderr, "[omnitrace][dl][pid=%i]> %s :: %s\n", getpid(), FUNCNAME,   \
                    dlerror());                                                          \
        }                                                                                \
    }

//--------------------------------------------------------------------------------------//
//
//      omnitrace symbols
//
//--------------------------------------------------------------------------------------//

extern "C"
{
    struct ompt_start_tool_result_t;

    void omnitrace_init_library(void) OMNITRACE_PUBLIC_API;
    void omnitrace_init(const char*, bool, const char*) OMNITRACE_PUBLIC_API;
    void omnitrace_finalize(void) OMNITRACE_PUBLIC_API;
    void omnitrace_set_env(const char* env_name,
                           const char* env_val) OMNITRACE_PUBLIC_API;
    void omnitrace_set_mpi(bool use, bool attached) OMNITRACE_PUBLIC_API;
    void omnitrace_push_trace(const char* name) OMNITRACE_PUBLIC_API;
    void omnitrace_pop_trace(const char* name) OMNITRACE_PUBLIC_API;

    void omnitrace_user_start_trace_dl(void) OMNITRACE_HIDDEN_API;
    void omnitrace_user_stop_trace_dl(void) OMNITRACE_HIDDEN_API;

    void omnitrace_user_start_thread_trace_dl(void) OMNITRACE_HIDDEN_API;
    void omnitrace_user_stop_thread_trace_dl(void) OMNITRACE_HIDDEN_API;

    void omnitrace_user_push_region_dl(const char*) OMNITRACE_HIDDEN_API;
    void omnitrace_user_pop_region_dl(const char*) OMNITRACE_HIDDEN_API;

    ompt_start_tool_result_t* ompt_start_tool(unsigned int,
                                              const char*) OMNITRACE_PUBLIC_API;
}

//--------------------------------------------------------------------------------------//

namespace omnitrace
{
inline namespace dl
{
namespace
{
inline int
get_omnitrace_env()
{
    auto&& _debug = get_env("OMNITRACE_DEBUG", false);
    return get_env("OMNITRACE_VERBOSE", (_debug) ? 100 : 0);
}

// environment priority:
//  - OMNITRACE_DL_DEBUG
//  - OMNITRACE_DL_VERBOSE
//  - OMNITRACE_DEBUG
//  - OMNITRACE_VERBOSE
int _omnitrace_dl_verbose = get_env("OMNITRACE_DL_DEBUG", false)
                                ? 100
                                : get_env("OMNITRACE_DL_VERBOSE", get_omnitrace_env());

// The docs for dlopen suggest that the combination of RTLD_LOCAL + RTLD_DEEPBIND
// (when available) helps ensure that the symbols in the instrumentation library
// libomnitrace.so will use it's own symbols... not symbols that are potentially
// instrumented. However, this only applies to the symbols in libomnitrace.so,
// which is NOT self-contained, i.e. symbols in timemory and the libs it links to
// (such as libpapi.so) are not protected by the deep-bind option. Additionally,
// it should be noted that DynInst does *NOT* add instrumentation by manipulating the
// dynamic linker (otherwise it would only be limited to shared libs) -- it manipulates
// the instructions in the binary so that a call to a function such as "main" actually
// calls "main_dyninst", which executes the instrumentation snippets around the actual
// "main" (this is the reason you need the dyninstAPI_RT library).
//
//  UPDATE:
//      Use of RTLD_DEEPBIND has been removed because it causes the dyninst
//      ProcControlAPI to segfault within pthread_cond_wait on certain executables.
//
// Here are the docs on the dlopen options used:
//
// RTLD_LAZY
//    Perform lazy binding. Only resolve symbols as the code that references them is
//    executed. If the symbol is never referenced, then it is never resolved. (Lazy
//    binding is only performed for function references; references to variables are
//    always immediately bound when the library is loaded.)
//
// RTLD_LOCAL
//    This is the converse of RTLD_GLOBAL, and the default if neither flag is specified.
//    Symbols defined in this library are not made available to resolve references in
//    subsequently loaded libraries.
//
// RTLD_DEEPBIND (since glibc 2.3.4)
//    Place the lookup scope of the symbols in this library ahead of the global scope.
//    This means that a self-contained library will use its own symbols in preference to
//    global symbols with the same name contained in libraries that have already been
//    loaded. This flag is not specified in POSIX.1-2001.
//
#if __GLIBC__ >= 2 && __GLIBC_MINOR__ >= 4
auto        _omnitrace_dl_dlopen_flags = RTLD_LAZY | RTLD_LOCAL;
const char* _omnitrace_dl_dlopen_descr = "RTLD_LAZY | RTLD_LOCAL";
#else
auto        _omnitrace_dl_dlopen_flags = RTLD_LAZY | RTLD_LOCAL;
const char* _omnitrace_dl_dlopen_descr = "RTLD_LAZY | RTLD_LOCAL";
#endif

/// This class contains function pointers for omnitrace's instrumentation functions
struct OMNITRACE_HIDDEN_API indirect
{
    OMNITRACE_INLINE indirect(std::string omnilib, std::string userlib)
    : m_omnilib{ find_path(std::move(omnilib)) }
    , m_userlib{ find_path(std::move(userlib)) }
    {
        if(_omnitrace_dl_verbose > 0)
        {
            fprintf(stderr, "[omnitrace][dl][pid=%i] libomnitrace.so resolved to '%s'\n",
                    getpid(), m_omnilib.c_str());
        }
        auto        _omni_hsa_lib = m_omnilib;
        const char* _hsa_lib      = getenv("HSA_TOOLS_LIB");
        if(_hsa_lib) _omni_hsa_lib.append(":").append(_hsa_lib);
        setenv("HSA_TOOLS_LIB", _omni_hsa_lib.c_str(), 1);
        m_omnihandle = open(m_omnilib);
        m_userhandle = open(m_userlib);
        init();
    }

    OMNITRACE_INLINE ~indirect() { dlclose(m_omnihandle); }

    static OMNITRACE_INLINE void* open(const std::string& _lib)
    {
        auto* libhandle = dlopen(_lib.c_str(), _omnitrace_dl_dlopen_flags);

        if(libhandle)
        {
            if(_omnitrace_dl_verbose > 0)
            {
                fprintf(stderr, "[omnitrace][dl][pid=%i] dlopen(%s, %s) :: success\n",
                        getpid(), _lib.c_str(), _omnitrace_dl_dlopen_descr);
            }
        }
        else
        {
            if(_omnitrace_dl_verbose >= 0)
            {
                perror("dlopen");
                fprintf(stderr, "[omnitrace][dl][pid=%i] dlopen(%s, %s) :: %s\n",
                        getpid(), _lib.c_str(), _omnitrace_dl_dlopen_descr, dlerror());
            }
        }

        dlerror();  // Clear any existing error

        return libhandle;
    }

    OMNITRACE_INLINE void init()
    {
        if(!m_omnihandle) m_omnihandle = open(m_omnilib);

        int _warn_verbose = 0;
        // Initialize all pointers
        OMNITRACE_DLSYM(omnitrace_init_library_f, m_omnihandle, "omnitrace_init_library");
        OMNITRACE_DLSYM(omnitrace_init_f, m_omnihandle, "omnitrace_init");
        OMNITRACE_DLSYM(omnitrace_finalize_f, m_omnihandle, "omnitrace_finalize");
        OMNITRACE_DLSYM(omnitrace_set_env_f, m_omnihandle, "omnitrace_set_env");
        OMNITRACE_DLSYM(omnitrace_set_mpi_f, m_omnihandle, "omnitrace_set_mpi");
        OMNITRACE_DLSYM(omnitrace_push_trace_f, m_omnihandle, "omnitrace_push_trace");
        OMNITRACE_DLSYM(omnitrace_pop_trace_f, m_omnihandle, "omnitrace_pop_trace");
        OMNITRACE_DLSYM(omnitrace_push_region_f, m_omnihandle, "omnitrace_push_region");
        OMNITRACE_DLSYM(omnitrace_pop_region_f, m_omnihandle, "omnitrace_pop_region");
#if OMNITRACE_USE_OMPT == 0
        _warn_verbose = 5;
#endif
        OMNITRACE_DLSYM(ompt_start_tool_f, m_omnihandle, "ompt_start_tool");

        if(!m_userhandle) m_userhandle = open(m_userlib);
        _warn_verbose = 0;
        OMNITRACE_DLSYM(omnitrace_user_configure_f, m_userhandle,
                        "omnitrace_user_configure");

        if(omnitrace_user_configure_f)
        {
            (*omnitrace_user_configure_f)(
                &omnitrace_user_start_trace_dl, &omnitrace_user_stop_trace_dl,
                &omnitrace_user_start_thread_trace_dl,
                &omnitrace_user_stop_thread_trace_dl, &omnitrace_user_push_region_dl,
                &omnitrace_user_pop_region_dl);
        }
    }

    static OMNITRACE_INLINE std::string find_path(std::string&& _path)
    {
        auto _paths =
            delimit(join(":", get_env("OMNITRACE_PATH", ""),
                         get_env("LD_LIBRARY_PATH", ""), get_env("LIBRARY_PATH", "")),
                    ":");

        auto file_exists = [](const std::string& name) {
            struct stat buffer;
            return (stat(name.c_str(), &buffer) == 0);
        };

        for(auto&& itr : _paths)
        {
            auto _f = join('/', itr, _path);
            if(file_exists(_f)) return _f;
        }
        return _path;
    }

public:
    void (*omnitrace_init_library_f)(void)                    = nullptr;
    void (*omnitrace_init_f)(const char*, bool, const char*)  = nullptr;
    void (*omnitrace_finalize_f)(void)                        = nullptr;
    void (*omnitrace_set_env_f)(const char*, const char*)     = nullptr;
    void (*omnitrace_set_mpi_f)(bool, bool)                   = nullptr;
    void (*omnitrace_push_trace_f)(const char*)               = nullptr;
    void (*omnitrace_pop_trace_f)(const char*)                = nullptr;
    void (*omnitrace_push_region_f)(const char*)              = nullptr;
    void (*omnitrace_pop_region_f)(const char*)               = nullptr;
    void (*omnitrace_user_configure_f)(void (*)(void), void (*)(void), void (*)(void),
                                       void (*)(void), void (*)(const char*),
                                       void (*)(const char*)) = nullptr;
    ompt_start_tool_result_t* (*ompt_start_tool_f)(unsigned int, const char*);

private:
    void*       m_omnihandle = nullptr;
    void*       m_userhandle = nullptr;
    std::string m_omnilib    = {};
    std::string m_userlib    = {};
};

inline indirect&
get_indirect() OMNITRACE_HIDDEN_API;

indirect&
get_indirect()
{
    static auto _v =
        indirect{ get_env("OMNITRACE_LIBRARY", "libomnitrace.so"),
                  get_env("OMNITRACE_USER_LIBRARY", "libomnitrace-user.so") };
    return _v;
}

auto&
get_active()
{
    static bool _v = false;
    return _v;
}

auto&
get_enabled()
{
    static std::atomic<bool> _v{ get_env("OMNITRACE_INIT_ENABLED", true) };
    return _v;
}

auto&
get_thread_enabled()
{
    static thread_local bool _v = get_enabled();
    return _v;
}

auto&
get_count()
{
    static std::atomic<int64_t> _v{ 0 };
    return _v;
}

auto&
get_thread_count()
{
    static thread_local int64_t _v = 0;
    return _v;
}
}  // namespace
}  // namespace dl
}  // namespace omnitrace

//--------------------------------------------------------------------------------------//

#define OMNITRACE_DL_INVOKE(...)                                                         \
    ::omnitrace::common::invoke(__FUNCTION__, ::omnitrace::dl::_omnitrace_dl_verbose,    \
                                __VA_ARGS__)

using omnitrace::get_indirect;
namespace dl = omnitrace::dl;

extern "C"
{
    void omnitrace_init_library(void)
    {
        OMNITRACE_DL_INVOKE(get_indirect().omnitrace_init_library_f);
    }

    void omnitrace_init(const char* a, bool b, const char* c)
    {
        OMNITRACE_DL_INVOKE(get_indirect().omnitrace_init_f, a, b, c);
        dl::get_active() = true;
    }

    void omnitrace_finalize(void)
    {
        dl::get_active() = false;
        OMNITRACE_DL_INVOKE(get_indirect().omnitrace_finalize_f);
    }

    void omnitrace_push_trace(const char* name)
    {
        if(!dl::get_active()) return;
        if(dl::get_thread_enabled())
        {
            OMNITRACE_DL_INVOKE(get_indirect().omnitrace_push_trace_f, name);
        }
        else
        {
            ++dl::get_thread_count();
        }
    }

    void omnitrace_pop_trace(const char* name)
    {
        if(!dl::get_active()) return;
        if(dl::get_thread_enabled())
        {
            OMNITRACE_DL_INVOKE(get_indirect().omnitrace_pop_trace_f, name);
        }
        else
        {
            if(dl::get_thread_count()-- == 0) omnitrace_user_start_thread_trace_dl();
        }
    }

    void omnitrace_set_env(const char* a, const char* b)
    {
        setenv(a, b, 0);
        OMNITRACE_DL_INVOKE(get_indirect().omnitrace_set_env_f, a, b);
    }

    void omnitrace_set_mpi(bool a, bool b)
    {
        OMNITRACE_DL_INVOKE(get_indirect().omnitrace_set_mpi_f, a, b);
    }

    void omnitrace_user_start_trace_dl(void) { dl::get_enabled().store(true); }
    void omnitrace_user_stop_trace_dl(void) { dl::get_enabled().store(false); }
    void omnitrace_user_start_thread_trace_dl(void) { dl::get_thread_enabled() = true; }
    void omnitrace_user_stop_thread_trace_dl(void) { dl::get_thread_enabled() = false; }

    void omnitrace_user_push_region_dl(const char* name)
    {
        if(!dl::get_active()) return;
        OMNITRACE_DL_INVOKE(get_indirect().omnitrace_push_region_f, name);
    }

    void omnitrace_user_pop_region_dl(const char* name)
    {
        if(!dl::get_active()) return;
        OMNITRACE_DL_INVOKE(get_indirect().omnitrace_pop_region_f, name);
    }

    ompt_start_tool_result_t* ompt_start_tool(unsigned int omp_version,
                                              const char*  runtime_version)
    {
#if OMNITRACE_USE_OMPT == 0
        (void) omp_version;
        (void) runtime_version;
        return nullptr;
#else
        if(!omnitrace::common::get_env("OMNITRACE_USE_OMPT", true)) return nullptr;
        return OMNITRACE_DL_INVOKE(get_indirect().ompt_start_tool_f, omp_version,
                                   runtime_version);
#endif
    }
}