SealDebug.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2023 CERN for the benefit of the ATLAS collaboration
*/
 
#ifndef CXXUTILS_SEAL_DEBUG_H // wlav SEAL_BASE_DEBUG_H
#define CXXUTILS_SEAL_DEBUG_H // wlav SEAL_BASE_DEBUG_H
 
#include "CxxUtils/checker_macros.h"
#include "CxxUtils/SealCommon.h"  // sss -- needed for IOFD
# include <cstddef>
# include <atomic>
 
// wlav copied from SealBase/sysapi/DebugAids.h
// Windows doesn't have this, so fake a suitable substitute
# ifdef _WIN32
#  define STDERR_HANDLE GetStdHandle (STD_ERROR_HANDLE)
# else
#  define STDERR_HANDLE STDERR_FILENO
# endif
 
// Define a suitable wrapper to write to system file descriptors.
// This is needed because on Windows we are using HANDLEs, not the
// compiler's crippled posixy interface.
# ifdef _WIN32
#  define MYWRITE(fd,data,n)    do { DWORD written; WriteFile(fd,data,n,\
                                        &written,0); } while (0)
# else
#  define MYWRITE(fd,data,n)    write(fd,data,n)
# endif
 
 
namespace Athena {                             // wlav
 
 
// wlav copied from SealBase/BitTraits.h
template <class T>
struct BitTraits
{
    enum { Bits     = sizeof (T) * CHAR_BIT };
 
    enum { Bytes    = Bits / 8 + ((Bits % 8) > 0) };
 
    enum { Digits   = (Bits * 30103) / 100000 + 1 };
    // 30103 =~ M_LN2 / M_LN10 * 100000
 
    enum { HexDigits    = Bits / 4 + ((Bits % 4) > 0) };
};
 
 
class DebugAids
{
public:
    // Miscellaneous functions
    static IOFD         stacktraceFd (IOFD fd = IOFD_INVALID);
    static void         stacktrace ATLAS_NOT_THREAD_SAFE (IOFD fd = IOFD_INVALID);
    static void         coredump (int sig, ...);
    // sss
    static void                 stacktraceLine ATLAS_NOT_THREAD_SAFE (IOFD fd,
                                                                      unsigned long addr);
    static void                 setStackTraceAddr2Line ATLAS_NOT_THREAD_SAFE (const char* path);
 
    // fwinkl
    static unsigned long        enableCoreFiles();
    static void                 disableCoreFiles();
private:
    static std::atomic<IOFD>     s_stackTraceFd;
};
 
 
} // namespace Athena                             wlav
#endif // CXXUTILS_SEAL_DEBUG_H wlav SEAL_BASE_DEBUG_H