1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201
|
// --------------------------------------------------------------------------
//
// File
// Name: Box.h
// Purpose: Main header file for the Box project
// Created: 2003/07/08
//
// --------------------------------------------------------------------------
#ifndef BOX__H
#define BOX__H
// Use the same changes as gcc3 for gcc4
#ifdef PLATFORM_GCC4
#define PLATFORM_GCC3
#endif
#include "BoxPlatform.h"
#include <memory>
// uncomment this line to enable full memory leak finding on all
// malloc-ed blocks (at least, ones used by the STL)
//#define MEMLEAKFINDER_FULL_MALLOC_MONITORING
// Show backtraces on exceptions in release builds until further notice
// (they are only logged at TRACE level anyway)
#ifdef HAVE_EXECINFO_H
#define SHOW_BACKTRACE_ON_EXCEPTION
#endif
#ifdef SHOW_BACKTRACE_ON_EXCEPTION
#include "Utils.h"
#define OPTIONAL_DO_BACKTRACE DumpStackBacktrace();
#else
#define OPTIONAL_DO_BACKTRACE
#endif
#include "CommonException.h"
#include "Logging.h"
#ifndef BOX_RELEASE_BUILD // this is a debug build:
extern bool AssertFailuresToSyslog;
#define ASSERT_FAILS_TO_SYSLOG_ON {AssertFailuresToSyslog = true;}
void BoxDebugAssertFailed(const char *cond, const char *file, int line);
#define ASSERT(cond) \
{ \
if(!(cond)) \
{ \
BoxDebugAssertFailed(#cond, __FILE__, __LINE__); \
THROW_EXCEPTION_MESSAGE(CommonException, \
AssertFailed, #cond); \
} \
}
// Note that syslog tracing is independent of BoxDebugTraceOn,
// but stdout tracing is not
extern bool BoxDebugTraceToSyslog;
#define TRACE_TO_SYSLOG(x) {BoxDebugTraceToSyslog = x;}
extern bool BoxDebugTraceToStdout;
#define TRACE_TO_STDOUT(x) {BoxDebugTraceToStdout = x;}
extern bool BoxDebugTraceOn;
int BoxDebug_printf(const char *format, ...);
int BoxDebugTrace(const char *format, ...);
#ifndef PLATFORM_DISABLE_MEM_LEAK_TESTING
#define BOX_MEMORY_LEAK_TESTING
#endif
// Exception names
#define EXCEPTION_CODENAMES_EXTENDED
#else // this is a release build:
#define ASSERT_FAILS_TO_SYSLOG_ON
#define ASSERT(cond)
#define TRACE_TO_SYSLOG(x) {}
#define TRACE_TO_STDOUT(x) {}
// Box Backup builds release get extra information for exception logging
#define EXCEPTION_CODENAMES_EXTENDED
#define EXCEPTION_CODENAMES_EXTENDED_WITH_DESCRIPTION
#ifdef BOX_MEMORY_LEAK_TESTING
#error BOX_MEMORY_LEAK_TESTING should not already be defined in release builds!
#endif
#endif
#if defined DEBUG_LEAKS // optionally enable memory leak debugging even in release builds
#ifdef PLATFORM_DISABLE_MEM_LEAK_TESTING
#error Compiling with DEBUG_LEAKS enabled, but not supported on this platform
#else
#define BOX_MEMORY_LEAK_TESTING
#endif
#endif // DEBUG_LEAKS
#ifdef BOX_MEMORY_LEAK_TESTING
// Memory leak testing
#include "MemLeakFinder.h"
#define DEBUG_NEW new(__FILE__,__LINE__)
#define MEMLEAKFINDER_NOT_A_LEAK(x) memleakfinder_notaleak(x);
#define MEMLEAKFINDER_NO_LEAKS MemLeakSuppressionGuard _guard;
#define MEMLEAKFINDER_INIT memleakfinder_init();
#define MEMLEAKFINDER_START {memleakfinder_global_enable = true;}
#define MEMLEAKFINDER_STOP {memleakfinder_global_enable = false;}
#else
#define DEBUG_NEW new
#define MEMLEAKFINDER_NOT_A_LEAK(x)
#define MEMLEAKFINDER_NO_LEAKS
#define MEMLEAKFINDER_INIT
#define MEMLEAKFINDER_START
#define MEMLEAKFINDER_STOP
#endif
#define THROW_EXCEPTION(type, subtype) \
{ \
if((!HideExceptionMessageGuard::ExceptionsHidden() \
&& !HideSpecificExceptionGuard::IsHidden( \
type::ExceptionType, type::subtype))) \
{ \
OPTIONAL_DO_BACKTRACE \
BOX_WARNING("Exception thrown: " \
#type "(" #subtype ") " \
"at " __FILE__ "(" << __LINE__ << ")") \
} \
throw type(type::subtype); \
}
#define THROW_EXCEPTION_MESSAGE(type, subtype, message) \
{ \
std::ostringstream _box_throw_line; \
_box_throw_line << message; \
if((!HideExceptionMessageGuard::ExceptionsHidden() \
&& !HideSpecificExceptionGuard::IsHidden( \
type::ExceptionType, type::subtype))) \
{ \
OPTIONAL_DO_BACKTRACE \
BOX_WARNING("Exception thrown: " \
#type "(" #subtype ") (" << \
_box_throw_line.str() << \
") at " __FILE__ ":" << __LINE__) \
} \
throw type(type::subtype, _box_throw_line.str()); \
}
// extra macros for converting to network byte order
#ifdef HAVE_NETINET_IN_H
#include <netinet/in.h>
#endif
// Always define a swap64 function, as it's useful.
inline uint64_t box_swap64(uint64_t x)
{
return ((x & 0xff) << 56 |
(x & 0xff00LL) << 40 |
(x & 0xff0000LL) << 24 |
(x & 0xff000000LL) << 8 |
(x & 0xff00000000LL) >> 8 |
(x & 0xff0000000000LL) >> 24 |
(x & 0xff000000000000LL) >> 40 |
(x & 0xff00000000000000LL) >> 56);
}
#ifdef WORDS_BIGENDIAN
#define box_hton64(x) (x)
#define box_ntoh64(x) (x)
#elif defined(HAVE_BSWAP64)
#ifdef HAVE_SYS_ENDIAN_H
#include <sys/endian.h>
#endif
#ifdef HAVE_ASM_BYTEORDER_H
#include <asm/byteorder.h>
#endif
#define box_hton64(x) BSWAP64(x)
#define box_ntoh64(x) BSWAP64(x)
#else
#define box_hton64(x) box_swap64(x)
#define box_ntoh64(x) box_swap64(x)
#endif
// overloaded auto-conversion functions
inline uint64_t hton(uint64_t in) { return box_hton64(in); }
inline uint32_t hton(uint32_t in) { return htonl(in); }
inline uint16_t hton(uint16_t in) { return htons(in); }
inline uint8_t hton(uint8_t in) { return in; }
inline int64_t hton(int64_t in) { return box_hton64(in); }
inline int32_t hton(int32_t in) { return htonl(in); }
inline int16_t hton(int16_t in) { return htons(in); }
inline int8_t hton(int8_t in) { return in; }
inline uint64_t ntoh(uint64_t in) { return box_ntoh64(in); }
inline uint32_t ntoh(uint32_t in) { return ntohl(in); }
inline uint16_t ntoh(uint16_t in) { return ntohs(in); }
inline uint8_t ntoh(uint8_t in) { return in; }
inline int64_t ntoh(int64_t in) { return box_ntoh64(in); }
inline int32_t ntoh(int32_t in) { return ntohl(in); }
inline int16_t ntoh(int16_t in) { return ntohs(in); }
inline int8_t ntoh(int8_t in) { return in; }
#endif // BOX__H
|