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
|
// distribution boxbackup-0.10 (svn version: 494)
//
// Copyright (c) 2003 - 2006
// Ben Summers and contributors. All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions
// are met:
// 1. Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
// 2. 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.
// 3. All use of this software and associated advertising materials must
// display the following acknowledgment:
// This product includes software developed by Ben Summers.
// 4. The names of the Authors may not be used to endorse or promote
// products derived from this software without specific prior written
// permission.
//
// [Where legally impermissible the Authors do not disclaim liability for
// direct physical injury or death caused solely by defects in the software
// unless it is modified by a third party.]
//
// THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``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 AUTHORS 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.
//
//
//
// --------------------------------------------------------------------------
//
// 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"
// 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
#ifndef NDEBUG
#ifdef HAVE_EXECINFO_H
#define SHOW_BACKTRACE_ON_EXCEPTION
#endif
#endif
#ifdef SHOW_BACKTRACE_ON_EXCEPTION
#include "Utils.h"
#define OPTIONAL_DO_BACKTRACE DumpStackBacktrace();
#else
#define OPTIONAL_DO_BACKTRACE
#endif
#include "CommonException.h"
#ifndef NDEBUG
extern bool AssertFailuresToSyslog;
#define ASSERT_FAILS_TO_SYSLOG_ON {AssertFailuresToSyslog = true;}
void BoxDebugAssertFailed(char *cond, char *file, int line);
#define ASSERT(cond) {if(!(cond)) {BoxDebugAssertFailed(#cond, __FILE__, __LINE__); THROW_EXCEPTION(CommonException, AssertFailed)}}
// 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, ...);
#define TRACE0(msg) {BoxDebugTrace("%s", msg);}
#define TRACE1(msg, a0) {BoxDebugTrace(msg, a0);}
#define TRACE2(msg, a0, a1) {BoxDebugTrace(msg, a0, a1);}
#define TRACE3(msg, a0, a1, a2) {BoxDebugTrace(msg, a0, a1, a2);}
#define TRACE4(msg, a0, a1, a2, a3) {BoxDebugTrace(msg, a0, a1, a2, a3);}
#define TRACE5(msg, a0, a1, a2, a3, a4) {BoxDebugTrace(msg, a0, a1, a2, a3, a4);}
#define TRACE6(msg, a0, a1, a2, a3, a4, a5) {BoxDebugTrace(msg, a0, a1, a2, a3, a4, a5);}
#define TRACE7(msg, a0, a1, a2, a3, a4, a5, a6) {BoxDebugTrace(msg, a0, a1, a2, a3, a4, a5, a6);}
#define TRACE8(msg, a0, a1, a2, a3, a4, a5, a6, a7) {BoxDebugTrace(msg, a0, a1, a2, a3, a4, a5, a6, a7);}
#ifndef PLATFORM_DISABLE_MEM_LEAK_TESTING
#define BOX_MEMORY_LEAK_TESTING
#endif
// Exception names
#define EXCEPTION_CODENAMES_EXTENDED
#else
#define ASSERT_FAILS_TO_SYSLOG_ON
#define ASSERT(cond)
#define TRACE_TO_SYSLOG(x) {}
#define TRACE_TO_STDOUT(x) {}
#define TRACE0(msg)
#define TRACE1(msg, a0)
#define TRACE2(msg, a0, a1)
#define TRACE3(msg, a0, a1, a2)
#define TRACE4(msg, a0, a1, a2, a3)
#define TRACE5(msg, a0, a1, a2, a3, a4)
#define TRACE6(msg, a0, a1, a2, a3, a4, a5)
#define TRACE7(msg, a0, a1, a2, a3, a4, a5, a6)
#define TRACE8(msg, a0, a1, a2, a3, a4, a5, a6, a7)
// Box Backup builds release get extra information for exception logging
#define EXCEPTION_CODENAMES_EXTENDED
#define EXCEPTION_CODENAMES_EXTENDED_WITH_DESCRIPTION
#endif
#ifdef BOX_MEMORY_LEAK_TESTING
// Memory leak testing
#include "MemLeakFinder.h"
#define MEMLEAKFINDER_NOT_A_LEAK(x) memleakfinder_notaleak(x);
#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_START
#define MEMLEAKFINDER_STOP
#endif
#define THROW_EXCEPTION(type, subtype) \
{ \
OPTIONAL_DO_BACKTRACE \
TRACE1("Exception thrown: " #type "(" #subtype ") at " __FILE__ "(%d)\n", __LINE__) \
throw type(type::subtype); \
}
// 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
#endif // BOX__H
|
