openvino/thirdparty/itt_collector/sea_itt_lib/Utils.cpp

/*********************************************************************************************************************************************************************************************************************************************************************************************
#   Intel(R) Single Event API
#
#   This file is provided under the BSD 3-Clause license.
#   Copyright (c) 2021, Intel Corporation
#   All rights reserved.
#
#   Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
#       Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
#       Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
#       Neither the name of the Intel Corporation nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
#
#   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
#   IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
#   HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
#
**********************************************************************************************************************************************************************************************************************************************************************************************/

#include "Utils.h"

#include <string.h>

#include "IttNotifyStdSrc.h"

#ifdef _WIN32
#    include <Psapi.h>
#    undef API_VERSION
#    include <Dbghelp.h>
#else
#    include <cxxabi.h>
#    include <dlfcn.h>
#    include <execinfo.h>
#endif

#ifdef __APPLE__
#    include <mach-o/dyld.h>
#endif

#if defined(ARM32)
#    define NO_DL_ITERATE_PHDR
#endif

#if !defined(NO_DL_ITERATE_PHDR) && defined(__linux__)
#    ifndef _GNU_SOURCE
#        define _GNU_SOURCE
#    endif
#    include <link.h>
#endif

size_t GetStack(TStack& stack) {
#ifdef _WIN32
    typedef USHORT(WINAPI * FCaptureStackBackTrace)(__in ULONG, __in ULONG, __out PVOID*, __out_opt PULONG);
    static FCaptureStackBackTrace CaptureStackBackTrace =
        (FCaptureStackBackTrace)(GetProcAddress(LoadLibraryA("kernel32.dll"), "RtlCaptureStackBackTrace"));
    return CaptureStackBackTrace ? CaptureStackBackTrace(0, StackSize, stack, NULL) : 0;
#else
    return backtrace(stack, StackSize);
#endif
}

std::string GetStackString() {
#ifdef _WIN32
    return std::string();
#else
    TStack stack = {};
    size_t size = GetStack(stack);

    char** bt_syms = backtrace_symbols(stack, size);
    if (!bt_syms)
        return std::string();
    std::string res;
    for (size_t i = 2; i < size; i++) {
        if (res.size())
            res += "<-";
        res += bt_syms[i];
    }

    free(bt_syms);
    return res;
#endif
}

namespace sea {

#ifdef _WIN32
const char* GetProcessName(bool bFullPath) {
    assert(bFullPath);
    static char process_name[1024] = {};
    if (!process_name[0])
        GetModuleFileNameA(NULL, process_name, sizeof(process_name) - 1);
    return process_name;
}

SModuleInfo Fn2Mdl(void* fn) {
    HMODULE hModule = NULL;
    GetModuleHandleEx(GET_MODULE_HANDLE_EX_FLAG_FROM_ADDRESS, (LPCTSTR)fn, &hModule);
    char filename[1024] = {};
    GetModuleFileNameA(hModule, filename, sizeof(filename) - 1);
    MODULEINFO mi = {};
    GetModuleInformation(GetCurrentProcess(), hModule, &mi, sizeof(MODULEINFO));
    return SModuleInfo{hModule, mi.SizeOfImage, filename};
}

LONG WINAPI CreateMiniDump(EXCEPTION_POINTERS* pep) {
    typedef BOOL(WINAPI * PDUMPFN)(HANDLE hProcess,
                                   DWORD ProcessId,
                                   HANDLE hFile,
                                   MINIDUMP_TYPE DumpType,
                                   PMINIDUMP_EXCEPTION_INFORMATION ExceptionParam,
                                   PMINIDUMP_USER_STREAM_INFORMATION UserStreamParam,
                                   PMINIDUMP_CALLBACK_INFORMATION CallbackParam);

    PDUMPFN fnMiniDumpWriteDump = (PDUMPFN)GetProcAddress(::LoadLibraryA("DbgHelp.dll"), "MiniDumpWriteDump");
    if (!fnMiniDumpWriteDump)
        return EXCEPTION_EXECUTE_HANDLER;
    std::string path = g_savepath.empty() ? "c:/temp" : g_savepath;
    path += "/isea_minidump.dmp";
    HANDLE hFile =
        CreateFileA(path.c_str(), GENERIC_READ | GENERIC_WRITE, 0, NULL, CREATE_ALWAYS, FILE_ATTRIBUTE_NORMAL, NULL);
    if (!hFile || INVALID_HANDLE_VALUE == hFile)
        return EXCEPTION_EXECUTE_HANDLER;

    MINIDUMP_EXCEPTION_INFORMATION mdei = {};
    mdei.ThreadId = GetCurrentThreadId();
    mdei.ExceptionPointers = pep;
    mdei.ClientPointers = TRUE;

    fnMiniDumpWriteDump(GetCurrentProcess(),
                        GetCurrentProcessId(),
                        hFile,
                        MiniDumpNormal,
                        (pep != 0) ? &mdei : 0,
                        0,
                        0);
    CloseHandle(hFile);

    return EXCEPTION_EXECUTE_HANDLER;
}

void SetGlobalCrashHandler() {
    ::SetUnhandledExceptionFilter(CreateMiniDump);
}

#else

void SetGlobalCrashHandler() {
    // FIXME: implement
}

#    include <sys/stat.h>

size_t GetFileSize(const char* path) {
    struct stat st = {};

    if (0 == stat(path, &st))
        return st.st_size;

    return -1;
}

#    ifndef __APPLE__

#        if !defined(NO_DL_ITERATE_PHDR)
int iterate_callback(struct dl_phdr_info* info, size_t size, void* data) {
    Dl_info* pInfo = reinterpret_cast<Dl_info*>(data);
    VerbosePrint("iterate_callback: %lx, %s\n", (long int)info->dlpi_addr, info->dlpi_name);
    if (reinterpret_cast<void*>(info->dlpi_addr) == pInfo->dli_fbase)
        pInfo->dli_fname = strdup(info->dlpi_name);
    return 0;
}
#        endif

bool proc_self_map(Dl_info& info) {
    char base[100] = {};
    snprintf(base, sizeof(base), "%lx", (long int)info.dli_fbase);
    VerbosePrint("Base: %s\n", base);
    std::ifstream input("/proc/self/maps");
    std::string line;
    while (std::getline(input, line)) {
        VerbosePrint("/proc/self/maps: %s\n", line.c_str());
        if (0 == line.find(base)) {
            size_t pos = line.rfind(' ');
            info.dli_fname = strdup(line.substr(pos + 1).c_str());
            return true;
        }
    }
    return false;
}
#    endif

sea::SModuleInfo Fn2Mdl(void* fn) {
    Dl_info dl_info = {};
    dladdr(fn, &dl_info);
    VerbosePrint("Fn2Mdl: %p, %s\n", dl_info.dli_fbase, dl_info.dli_fname);
    if (!dl_info.dli_fname || !strstr(dl_info.dli_fname, ".so")) {
#    ifndef __APPLE__
#        if !defined(NO_DL_ITERATE_PHDR)
        dl_iterate_phdr(iterate_callback, &dl_info);
#        endif
        if (!dl_info.dli_fname || !strstr(dl_info.dli_fname, ".so"))
            proc_self_map(dl_info);
#    endif
        return SModuleInfo{dl_info.dli_fbase, 0, dl_info.dli_fname};
    }

    if (dl_info.dli_fname[0] == '/') {
        // path is absolute
        return SModuleInfo{dl_info.dli_fbase, GetFileSize(dl_info.dli_fname), dl_info.dli_fname};
    } else {
        if (const char* absolute = realpath(dl_info.dli_fname, nullptr)) {
            SModuleInfo mdlInfo{dl_info.dli_fbase, GetFileSize(absolute), absolute};
            free((void*)absolute);
            return mdlInfo;
        } else {
            return SModuleInfo{dl_info.dli_fbase, GetFileSize(dl_info.dli_fname), dl_info.dli_fname};
        }
    }
}

const char* GetProcessName(bool bFullPath) {
    static char process_name[1024] = {};
#    ifdef __APPLE__
    uint32_t size = 1023;
    _NSGetExecutablePath(process_name, &size);
#    else
    if (!process_name[0])
        process_name[readlink("/proc/self/exe", process_name, sizeof(process_name) / sizeof(process_name[0]) - 1)] = 0;
#    endif  //__APPLE__
    if (bFullPath)
        return process_name;
    return strrchr(process_name, '/') + 1;
}

#endif

}  // namespace sea