Globals.h

Go to the documentation of this file.

#ifndef GLOBALS_H
#define GLOBALS_H
 
// NOLINTBEGIN(cppcoreguidelines-macro-usage)
#define RESET_COLOR "\033[m"
#define BLUE "\033[1;34m"
#define YELLOW "\033[1;33m"
#define GREEN "\033[1;32m"
#define RED "\033[1;31m"
#define BLACK "\033[1;30m"
#define MAGENTA "\033[1;35m"
#define CYAN "\033[1;36m"
#define WHITE "\033[1;37m"
 
#define DBLUE "\033[0;34m"
#define DYELLOW "\033[0;33m"
#define DGREEN "\033[0;32m"
#define DRED "\033[0;31m"
#define DBLACK "\033[0;30m"
#define DMAGENTA "\033[0;35m"
#define DCYAN "\033[0;36m"
#define DWHITE "\033[0;37m"
 
#define BG_WHITE "\033[47m"
#define BG_RED "\033[41m"
#define BG_GREEN "\033[42m"
#define BG_YELLOW "\033[43m"
#define BG_BLUE "\033[44m"
#define BG_MAGENTA "\033[45m"
#define BG_CYAN "\033[46m"
 
#define HIDE_CURSOR "\033[?25l"
#define SHOW_CURSOR "\033[?25h"
 
#define ALERTTEXT "\033[47m\033[0;31m"
// NOLINTEND(cppcoreguidelines-macro-usage)
 
#if defined(__APPLE__) && defined(__CINT__) && !defined(__CLING__)
#undef __GNUC__
typedef char __signed;
typedef char int8_t;
#endif
 
#if __APPLE__
//#include <_types/_uint8_t.h>
#include <_types/_uint16_t.h>
#include <_types/_uint32_t.h>
#include <_types/_uint64_t.h>
#include <sys/_types/_int16_t.h>
#endif
 
#include <iostream>
#include <iomanip>
#include <stdexcept>
#include <string>
#include <cstdio>
#include <cstdint>
#include <cstdlib>
#include <execinfo.h>
#include <cxxabi.h>
#include <sstream>
#include <array>
#include <memory>
#include <unistd.h>
#include <map>
#include <fstream>
#include <algorithm>
 
const std::string& ProgramName();
 
namespace grsi {
struct exit_exception : public std::exception {
public:
   explicit exit_exception(int c, const char* msg = "") : code(c), message(msg) {}
   /*     virtual const char* what() const throw {
           //  LOG(what); // write to log file
           return what.c_str();
        }*/
 
   const int   code;   // NOLINT(cppcoreguidelines-avoid-const-or-ref-data-members)
   const char* message;
};
 
void SetGRSIEnv();
 
//-------------------- three function templates that print all arguments into a string
// this template uses existing stream and appends the last argument to it
template <typename T>
void Append(std::ostringstream& stream, const T& tail)
{
   // append last argument
   stream << tail;
}
 
// this template uses existing stream and appends to it
template <typename T, typename... U>
void Append(std::ostringstream& stream, const T& head, const U&... tail)
{
   // append first argument
   stream << head;
 
   // reversely call this template (or the one with the last argument)
   Append(stream, tail...);
}
 
// this function typically gets called by user
template <typename T, typename... U>
std::string Stringify(const T& head, const U&... tail)
{
   // print first arguments to string
   std::ostringstream stream;
   stream << head;
 
   // call the second template (or the third if tail is just one argument)
   Append(stream, tail...);
 
   // append a newline
   stream << std::endl;
 
   // return resulting string
   return stream.str();
}
 
}   // end of namespace grsi
 
template <typename T>
inline std::string hex(T val, int width = -1)
{
   std::ostringstream str;
   str << "0x" << std::hex;
   if(width > 0) {
      str << std::setfill('0') << std::setw(width);
   }
   str << val;
   if(width > 0) {
      str << std::setfill(' ');
   }
   return str.str();
}
 
enum class EVerbosity : std::uint8_t {
   kQuiet       = 0,
   kBasicFlow   = 1,
   kSubroutines = 2,
   kLoops       = 3,
   kAll         = 4
};
 
static inline std::string getexepath()
{
   std::array<char, 1024> result{};
   ssize_t                count = readlink("/proc/self/exe", result.data(), sizeof(result) - 1);
   return {result.data(), static_cast<size_t>((count > 0) ? count : 0)};
}
 
static inline std::string sh(const std::string& cmd)
{
   std::array<char, 128> buffer{};
   std::string           result;
   std::shared_ptr<FILE> pipe(popen(cmd.c_str(), "r"), pclose);
   if(!pipe) { throw std::runtime_error("popen() failed!"); }
   while(feof(pipe.get()) == 0) {
      if(fgets(buffer.data(), 128, pipe.get()) != nullptr) {
         result += buffer.data();
      }
   }
   return result;
}
 
extern std::map<std::string, uint64_t> gAddressOffset;
 
inline bool FindAddressOffsets(bool update)
{
   if(!update && !gAddressOffset.empty()) {
      std::cerr << "Warning, already have " << gAddressOffset.size() << " address offsets, not checking again!" << std::endl;
      return false;
   }
 
   // need to read /proc/self should be for this process, but doesn't any grsisort libraries?
   // so read /proc/<PID>/maps instead
   //std::stringstream mapName;
   //mapName << "/proc/" << getpid() << "/maps";
   //std::ifstream procMap(mapName.str());
   std::ifstream procMap("/proc/self/maps");
   if(!procMap.is_open()) {
      std::cerr << "Failed to open \"/proc/self/maps\"" << std::endl;
      return false;
   }
   std::string line;
   while(std::getline(procMap, line)) {
      // line has format
      // <start address>-<end address> <four letters for permissions> <offset> <device major>:<device minor> <inode> <so-library>
      // if <inode> is 0 there is no so-library
      std::stringstream str(line);
 
      uint64_t    startAddress = 0;
      char        dash         = '\0';
      uint64_t    endAddress   = 0;
      std::string permissions;
      uint64_t    offset = 0;
      std::string device;
      int         inode = 0;
      std::string soLibrary;
 
      str >> std::hex >> startAddress >> dash >> endAddress >> permissions >> std::dec >> offset >> device >> inode;
 
      if(inode != 0) {
         str >> soLibrary;
 
         // we only keep the first starting address
         if(gAddressOffset.find(soLibrary) == gAddressOffset.end()) {
            gAddressOffset[soLibrary] = startAddress;
         }
      }
   }
 
   return true;
}
 
// print a demangled stack backtrace of the caller function (copied from https://panthema.net/2008/0901-stacktrace-demangled/)
static inline void PrintStacktrace(std::ostream& out = std::cout, int maxFrames = 63)
{
   if(gAddressOffset.empty()) {
      if(!FindAddressOffsets(false)) {
         throw;
      }
   }
   std::ostringstream output;
   output << "stack trace:" << std::endl;
 
   // storage array for stack trace address data
   void** addrlist = new void*[maxFrames + 1];
 
   // retrieve current stack addresses
   int addrlen = backtrace(addrlist, maxFrames + 1);
 
   if(addrlen == 0) {
      output << "  <empty, possibly corrupt>" << std::endl;
      out << output.str();
      return;
   }
 
   // resolve addresses into strings containing "filename(function+address)",
   // this array must be free()-ed
   char** symbollist = backtrace_symbols(addrlist, addrlen);
 
   // allocate string which will be filled with the demangled function name
   size_t funcnamesize = 256;
   auto*  funcname     = new char[funcnamesize];
 
   // iterate over the returned symbol lines. skip the first, it is the
   // address of this function.
   for(int i = 2; i < addrlen; i++) {
      char* begin_name   = nullptr;
      char* begin_offset = nullptr;
 
      // find parentheses and +address offset surrounding the mangled name:
      // ./module(function+0x15c) [0x8048a6d]
      for(char* p = symbollist[i]; *p != 0; ++p) {
         if(*p == '(') {
            begin_name = p;
         } else if(*p == '+') {
            begin_offset = p;
            break;
         }
      }
 
      // try and decode file and line number (only if we have an absolute path)
      std::string line;
      if(symbollist[i][0] == '/') {
         std::ostringstream command;
         std::string        filename = symbollist[i];
         filename                    = filename.substr(0, filename.find_first_of('('));
         if(gAddressOffset.find(filename) == gAddressOffset.end()) {
            FindAddressOffsets(true);
         }
         // convert addrlist[i] to integer and subtract offset
         if(gAddressOffset.find(filename) != gAddressOffset.end()) {
            command << "addr2line " << hex(reinterpret_cast<uint64_t>(addrlist[i]) - gAddressOffset.at(filename)) << " -e " << filename;
            line = sh(command.str());
            line.erase(std::remove(line.begin(), line.end(), '\n'), line.end());
            //std::cout << symbollist[i] << ": (" << addrlist[i] << "/" << hex(reinterpret_cast<uint64_t>(addrlist[i])) << " - " << hex(gAddressOffset.at(filename)) << ") executed command " << command.str() << " = " << line << std::endl;
         }
 
         if(begin_name != nullptr && begin_offset != nullptr && begin_name < begin_offset) {
            *begin_name++   = '\0';
            *begin_offset++ = '\0';
 
            // mangled name is now in [begin_name, begin_offset)
            // now apply __cxa_demangle():
 
            int   status = 0;
            char* ret    = abi::__cxa_demangle(begin_name, funcname, &funcnamesize, &status);
            if(status == 0) {
               funcname = ret;   // use possibly realloc()-ed string
               output << "  " << line << " - " << funcname << std::endl;
            } else {
               // demangling failed. Output function name as a C function with no arguments.
               output << "  " << line << " - " << begin_name << std::endl;
            }
         } else {
            // couldn't parse the line? print the whole line.
            output << "  " << line << " - " << symbollist[i] << std::endl;
         }
      }
   }
 
   delete[] funcname;
   delete symbollist;
   out << output.str();
}
 
#if !__APPLE__
#include <sys/wait.h>
#include <sys/prctl.h>
static inline void PrintGdbStacktrace()
{
   std::array<char, 30> pid_buf{};
   sprintf(pid_buf.data(), "%d", getpid());
   std::array<char, 512> name_buf{};
   name_buf[readlink("/proc/self/exe", name_buf.data(), 511)] = 0;
   prctl(PR_SET_PTRACER, PR_SET_PTRACER_ANY, 0, 0, 0);
   int child_pid = fork();
   if(child_pid == 0) {
      dup2(2, 1);   // redirect output to stderr - edit: unnecessary?
      execl("/usr/bin/gdb", "gdb", "--batch", "-n", "-ex", "thread", "-ex", "bt", name_buf.data(), pid_buf.data(), nullptr);
      abort(); /* If gdb failed to start */
   } else {
      waitpid(child_pid, nullptr, 0);
   }
}
#endif
 
#endif