omnitrace-dl-library (#25)
* timemory submodule update
* Visibility, setting categories, and task-group protection
- OMNITRACE_VISIBILITY instead of TIMEMORY_VISIBILITY
- increased task group data-race protection
- add omnitrace categories to settings
* set component_apis type-trait
* omnitrace-dl-library implementation
- this library dlopen + dlsym's libomnitrace
- significantly reduces the instrumentation time
* omnitrace-avail categories
- suppress AVAILABLE column when --available
* omnitrace-exe update
- uses omnitrace-dl
- adds --print-excluded option
- removes --jump option
- comments out --stubs option
- removes --stdlib option
- support for C++ STL functions not in libstdc++
- tweak the --print-* outputs
- significantly refactors instrument_module and instrument_entity
- removes unused c_stdlib_module_constraint
- removes unused c_stdlib_function_constraint
- decreases get_whole_function_names() coverage
* library.cpp updates
- OMNITRACE_DEBUG -> OMNITRACE_DEBUG_F
- omnitrace_finalize sets state earlier
- omnitrace_finalize clears push/pop functors
- increased tasking shutdown safety
* - fix critical-trace thread hierarchy
- signal handler calls omnitrace_finalize
- get_cpu_cid_stack supports parent tid
- interval data reserves
- omnitrace-avail serialization support for module_functions
- omnitrace --simulate option
- omnitrace --print-format option
- omnitrace --load-instr option
- omnitrace runtime-inst doesn't oneTimeCode
- updated regex
- expand get_whole_function_names()
- Test Install CI update
* fixes to last commit
- expand get_whole_function_names()
- ignore sig c modules
- kill process in signal handler
* Remove RTLD_DEEPBIND + more
- removed use of RTLD_DEEPBIND
- causes dyninst segfaults
- fixed signal handling
- updated timemory submodule
* Build/link static timemory libraries
* omnitrace --{module,function}-restrict option
- Added restrict regex options
- Reworked handling of regex options
- Reworked reporting of module/function skipping
- Handle -o w/o file specified
* timemory-avail
- category views
- backtrace::sample checks state
* get_debug_sampling()
This commit is contained in:
Jonathan R. Madsen
committed by
GitHub
GitHub
parent
b016c8929f
commit
145a6ae06f
@@ -0,0 +1,325 @@
|
||||
// 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.
|
||||
|
||||
#include <timemory/backends/process.hpp>
|
||||
#include <timemory/environment.hpp>
|
||||
#include <timemory/environment/types.hpp>
|
||||
#include <timemory/macros/attributes.hpp>
|
||||
#include <timemory/utility/demangle.hpp>
|
||||
#include <timemory/variadic/macros.hpp>
|
||||
|
||||
#include <cstdint>
|
||||
#include <cstdio>
|
||||
#include <cstring>
|
||||
#include <dlfcn.h>
|
||||
#include <gnu/libc-version.h>
|
||||
#include <limits>
|
||||
#include <memory>
|
||||
#include <stdexcept>
|
||||
#include <string>
|
||||
#include <sys/stat.h>
|
||||
|
||||
#define OMNITRACE_VISIBLE __attribute__((visibility("default")))
|
||||
#define OMNITRACE_HIDDEN __attribute__((visibility("internal")))
|
||||
#define OMNITRACE_INLINE __attribute__((__always_inline__))
|
||||
#define OMNITRACE_DLSYM(VARNAME, HANDLE, FUNCNAME) \
|
||||
if(HANDLE) \
|
||||
{ \
|
||||
*(void**) (&VARNAME) = dlsym(HANDLE, FUNCNAME); \
|
||||
if(VARNAME == nullptr && _omnitrace_dl_verbose >= 0) \
|
||||
{ \
|
||||
fprintf(stderr, "[omnitrace][dl][pid=%i]> %s :: %s\n", process::get_id(), \
|
||||
FUNCNAME, dlerror()); \
|
||||
} \
|
||||
}
|
||||
|
||||
namespace process = tim::process;
|
||||
|
||||
//--------------------------------------------------------------------------------------//
|
||||
//
|
||||
// omnitrace symbols
|
||||
//
|
||||
//--------------------------------------------------------------------------------------//
|
||||
|
||||
extern "C"
|
||||
{
|
||||
void omnitrace_init_library(void) OMNITRACE_VISIBLE;
|
||||
void omnitrace_init(const char*, bool, const char*) OMNITRACE_VISIBLE;
|
||||
void omnitrace_finalize(void) OMNITRACE_VISIBLE;
|
||||
void omnitrace_set_env(const char* env_name, const char* env_val) OMNITRACE_VISIBLE;
|
||||
void omnitrace_set_mpi(bool use, bool attached) OMNITRACE_VISIBLE;
|
||||
void omnitrace_push_trace(const char* name) OMNITRACE_VISIBLE;
|
||||
void omnitrace_pop_trace(const char* name) OMNITRACE_VISIBLE;
|
||||
}
|
||||
|
||||
//--------------------------------------------------------------------------------------//
|
||||
|
||||
namespace
|
||||
{
|
||||
inline int
|
||||
get_omnitrace_env();
|
||||
|
||||
// environment priority:
|
||||
// - OMNITRACE_DL_DEBUG
|
||||
// - OMNITRACE_DL_VERBOSE
|
||||
// - OMNITRACE_DEBUG
|
||||
// - OMNITRACE_VERBOSE
|
||||
int _omnitrace_dl_verbose =
|
||||
tim::get_env<bool>("OMNITRACE_DL_DEBUG", false, false)
|
||||
? 100
|
||||
: tim::get_env<int>("OMNITRACE_DL_VERBOSE", get_omnitrace_env(), false);
|
||||
|
||||
// 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 indirect
|
||||
{
|
||||
explicit OMNITRACE_INLINE indirect(std::string libpath)
|
||||
: m_libpath{ find_path(std::move(libpath)) }
|
||||
{
|
||||
if(_omnitrace_dl_verbose > 0)
|
||||
{
|
||||
fprintf(stderr, "[omnitrace][dl][pid=%i] libomnitrace.so resolved to '%s'\n",
|
||||
process::get_id(), m_libpath.c_str());
|
||||
}
|
||||
tim::set_env("HSA_TOOLS_LIB", m_libpath, 0);
|
||||
open();
|
||||
init();
|
||||
}
|
||||
|
||||
OMNITRACE_INLINE ~indirect() { dlclose(m_libhandle); }
|
||||
|
||||
OMNITRACE_INLINE void open()
|
||||
{
|
||||
if(m_libhandle) return;
|
||||
|
||||
auto* libhandle = dlopen(m_libpath.c_str(), _omnitrace_dl_dlopen_flags);
|
||||
|
||||
if(libhandle)
|
||||
{
|
||||
m_libhandle = libhandle;
|
||||
if(_omnitrace_dl_verbose > 0)
|
||||
{
|
||||
fprintf(stderr, "[omnitrace][dl][pid=%i] dlopen(%s, %s) :: success\n",
|
||||
process::get_id(), m_libpath.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",
|
||||
process::get_id(), m_libpath.c_str(), _omnitrace_dl_dlopen_descr,
|
||||
dlerror());
|
||||
}
|
||||
}
|
||||
|
||||
dlerror(); // Clear any existing error
|
||||
}
|
||||
|
||||
OMNITRACE_INLINE void init()
|
||||
{
|
||||
if(!m_libhandle) open();
|
||||
|
||||
// Initialize all pointers
|
||||
OMNITRACE_DLSYM(omnitrace_init_library_f, m_libhandle, "omnitrace_init_library");
|
||||
OMNITRACE_DLSYM(omnitrace_init_f, m_libhandle, "omnitrace_init");
|
||||
OMNITRACE_DLSYM(omnitrace_finalize_f, m_libhandle, "omnitrace_finalize");
|
||||
OMNITRACE_DLSYM(omnitrace_set_env_f, m_libhandle, "omnitrace_set_env");
|
||||
OMNITRACE_DLSYM(omnitrace_set_mpi_f, m_libhandle, "omnitrace_set_mpi");
|
||||
OMNITRACE_DLSYM(omnitrace_push_trace_f, m_libhandle, "omnitrace_push_trace");
|
||||
OMNITRACE_DLSYM(omnitrace_pop_trace_f, m_libhandle, "omnitrace_pop_trace");
|
||||
}
|
||||
|
||||
static OMNITRACE_INLINE std::string find_path(std::string&& _path)
|
||||
{
|
||||
auto _paths = tim::delimit(
|
||||
TIMEMORY_JOIN(":", tim::get_env<std::string>("OMNITRACE_PATH", ""),
|
||||
tim::get_env<std::string>("LD_LIBRARY_PATH", ""),
|
||||
tim::get_env<std::string>("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 = TIMEMORY_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;
|
||||
|
||||
private:
|
||||
void* m_libhandle = nullptr;
|
||||
std::string m_libpath = {};
|
||||
};
|
||||
|
||||
inline std::unique_ptr<indirect>&
|
||||
get_indirect() OMNITRACE_HIDDEN;
|
||||
|
||||
template <typename FuncT, typename... Args>
|
||||
inline void
|
||||
invoke(const char* _name, FuncT&& _func, Args... _args) OMNITRACE_HIDDEN;
|
||||
} // namespace
|
||||
|
||||
//--------------------------------------------------------------------------------------//
|
||||
|
||||
extern "C"
|
||||
{
|
||||
void omnitrace_init_library(void)
|
||||
{
|
||||
invoke(__FUNCTION__, get_indirect()->omnitrace_init_library_f);
|
||||
}
|
||||
|
||||
void omnitrace_init(const char* a, bool b, const char* c)
|
||||
{
|
||||
invoke(__FUNCTION__, get_indirect()->omnitrace_init_f, a, b, c);
|
||||
}
|
||||
|
||||
void omnitrace_finalize(void)
|
||||
{
|
||||
invoke(__FUNCTION__, get_indirect()->omnitrace_finalize_f);
|
||||
}
|
||||
|
||||
void omnitrace_push_trace(const char* name)
|
||||
{
|
||||
invoke(__FUNCTION__, get_indirect()->omnitrace_push_trace_f, name);
|
||||
}
|
||||
|
||||
void omnitrace_pop_trace(const char* name)
|
||||
{
|
||||
invoke(__FUNCTION__, get_indirect()->omnitrace_pop_trace_f, name);
|
||||
}
|
||||
|
||||
void omnitrace_set_env(const char* a, const char* b)
|
||||
{
|
||||
tim::set_env(a, b, 0);
|
||||
invoke(__FUNCTION__, get_indirect()->omnitrace_set_env_f, a, b);
|
||||
}
|
||||
|
||||
void omnitrace_set_mpi(bool a, bool b)
|
||||
{
|
||||
invoke(__FUNCTION__, get_indirect()->omnitrace_set_mpi_f, a, b);
|
||||
}
|
||||
}
|
||||
|
||||
//--------------------------------------------------------------------------------------//
|
||||
|
||||
namespace
|
||||
{
|
||||
int
|
||||
get_omnitrace_env()
|
||||
{
|
||||
auto&& _debug = tim::get_env<bool>("OMNITRACE_DEBUG", false, false);
|
||||
return tim::get_env<int>("OMNITRACE_VERBOSE", (_debug) ? 100 : 0, false);
|
||||
}
|
||||
|
||||
std::unique_ptr<indirect>&
|
||||
get_indirect()
|
||||
{
|
||||
static std::unique_ptr<indirect> _v = std::make_unique<indirect>(
|
||||
tim::get_env<std::string>("OMNITRACE_LIBRARY", "libomnitrace.so"));
|
||||
return _v;
|
||||
}
|
||||
|
||||
template <typename FuncT, typename... Args>
|
||||
void
|
||||
invoke(const char* _name, FuncT&& _func, Args... _args)
|
||||
{
|
||||
if(!get_indirect())
|
||||
{
|
||||
// allow -2 verbosity to avoid throwing exception
|
||||
if(_omnitrace_dl_verbose >= -1)
|
||||
throw std::runtime_error(
|
||||
"[omnitrace][dl] nullptr to struct holding dlsym function");
|
||||
return;
|
||||
}
|
||||
|
||||
if(_func)
|
||||
{
|
||||
std::invoke(std::forward<FuncT>(_func), _args...);
|
||||
}
|
||||
else if(_omnitrace_dl_verbose >= 0)
|
||||
{
|
||||
fprintf(stderr, "[omnitrace][dl] %s\n",
|
||||
TIMEMORY_JOIN("", "null function pointer to ", _name, ". Ignoring ",
|
||||
_name, "(", _args..., ")")
|
||||
.c_str());
|
||||
}
|
||||
}
|
||||
} // namespace
|
||||
Reference in New Issue
Block a user