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
|
/*-
* See the file LICENSE for redistribution information.
*
* Copyright (c) 1998-2002
* Sleepycat Software. All rights reserved.
*
* $Id: debug.h,v 11.31 2002/08/06 06:37:08 bostic Exp $
*/
#ifndef _DB_DEBUG_H_
#define _DB_DEBUG_H_
#if defined(__cplusplus)
extern "C" {
#endif
/*
* When running with #DIAGNOSTIC defined, we smash memory and do memory
* guarding with a special byte value.
*/
#define CLEAR_BYTE 0xdb
#define GUARD_BYTE 0xdc
/*
* DB assertions.
*/
#if defined(DIAGNOSTIC) && defined(__STDC__)
#define DB_ASSERT(e) ((e) ? (void)0 : __db_assert(#e, __FILE__, __LINE__))
#else
#define DB_ASSERT(e)
#endif
/*
* Purify and other run-time tools complain about uninitialized reads/writes
* of structure fields whose only purpose is padding, as well as when heap
* memory that was never initialized is written to disk.
*/
#ifdef UMRW
#define UMRW_SET(v) (v) = 0
#else
#define UMRW_SET(v)
#endif
/*
* Error message handling. Use a macro instead of a function because va_list
* references to variadic arguments cannot be reset to the beginning of the
* variadic argument list (and then rescanned), by functions other than the
* original routine that took the variadic list of arguments.
*/
#if defined(__STDC__) || defined(__cplusplus)
#define DB_REAL_ERR(env, error, error_set, stderr_default, fmt) { \
va_list ap; \
\
/* Call the user's callback function, if specified. */ \
va_start(ap, fmt); \
if ((env) != NULL && (env)->db_errcall != NULL) \
__db_errcall(env, error, error_set, fmt, ap); \
va_end(ap); \
\
/* Write to the user's file descriptor, if specified. */ \
va_start(ap, fmt); \
if ((env) != NULL && (env)->db_errfile != NULL) \
__db_errfile(env, error, error_set, fmt, ap); \
va_end(ap); \
\
/* \
* If we have a default and we didn't do either of the above, \
* write to the default. \
*/ \
va_start(ap, fmt); \
if ((stderr_default) && ((env) == NULL || \
((env)->db_errcall == NULL && (env)->db_errfile == NULL))) \
__db_errfile(env, error, error_set, fmt, ap); \
va_end(ap); \
}
#else
#define DB_REAL_ERR(env, error, error_set, stderr_default, fmt) { \
va_list ap; \
\
/* Call the user's callback function, if specified. */ \
va_start(ap); \
if ((env) != NULL && (env)->db_errcall != NULL) \
__db_errcall(env, error, error_set, fmt, ap); \
va_end(ap); \
\
/* Write to the user's file descriptor, if specified. */ \
va_start(ap); \
if ((env) != NULL && (env)->db_errfile != NULL) \
__db_errfile(env, error, error_set, fmt, ap); \
va_end(ap); \
\
/* \
* If we have a default and we didn't do either of the above, \
* write to the default. \
*/ \
va_start(ap); \
if ((stderr_default) && ((env) == NULL || \
((env)->db_errcall == NULL && (env)->db_errfile == NULL))) \
__db_errfile(env, error, error_set, fmt, ap); \
va_end(ap); \
}
#endif
/*
* Debugging macro to log operations.
* If DEBUG_WOP is defined, log operations that modify the database.
* If DEBUG_ROP is defined, log operations that read the database.
*
* D dbp
* T txn
* O operation (string)
* K key
* A data
* F flags
*/
#define LOG_OP(C, T, O, K, A, F) { \
DB_LSN __lsn; \
DBT __op; \
if (DBC_LOGGING((C))) { \
memset(&__op, 0, sizeof(__op)); \
__op.data = O; \
__op.size = strlen(O) + 1; \
(void)__db_debug_log((C)->dbp->dbenv, T, &__lsn, 0, \
&__op, (C)->dbp->log_filename->id, K, A, F); \
} \
}
#ifdef DEBUG_ROP
#define DEBUG_LREAD(C, T, O, K, A, F) LOG_OP(C, T, O, K, A, F)
#else
#define DEBUG_LREAD(C, T, O, K, A, F)
#endif
#ifdef DEBUG_WOP
#define DEBUG_LWRITE(C, T, O, K, A, F) LOG_OP(C, T, O, K, A, F)
#else
#define DEBUG_LWRITE(C, T, O, K, A, F)
#endif
/*
* Hook for testing recovery at various places in the create/delete paths.
* Hook for testing subdb locks.
*/
#if CONFIG_TEST
#define DB_TEST_SUBLOCKS(env, flags) \
do { \
if ((env)->test_abort == DB_TEST_SUBDB_LOCKS) \
(flags) |= DB_LOCK_NOWAIT; \
} while (0)
#define DB_ENV_TEST_RECOVERY(env, val, ret, name) \
do { \
int __ret; \
PANIC_CHECK((env)); \
if ((env)->test_copy == (val)) { \
/* COPY the FILE */ \
if ((__ret = __db_testcopy((env), NULL, (name))) != 0) \
(ret) = __db_panic((env), __ret); \
} \
if ((env)->test_abort == (val)) { \
/* ABORT the TXN */ \
(env)->test_abort = 0; \
(ret) = EINVAL; \
goto db_tr_err; \
} \
} while (0)
#define DB_TEST_RECOVERY(dbp, val, ret, name) \
do { \
int __ret; \
PANIC_CHECK((dbp)->dbenv); \
if ((dbp)->dbenv->test_copy == (val)) { \
/* Copy the file. */ \
if (F_ISSET((dbp), \
DB_AM_OPEN_CALLED) && (dbp)->mpf != NULL) \
(void)(dbp)->sync((dbp), 0); \
if ((__ret = \
__db_testcopy((dbp)->dbenv, (dbp), (name))) != 0) \
(ret) = __db_panic((dbp)->dbenv, __ret); \
} \
if ((dbp)->dbenv->test_abort == (val)) { \
/* Abort the transaction. */ \
(dbp)->dbenv->test_abort = 0; \
(ret) = EINVAL; \
goto db_tr_err; \
} \
} while (0)
#define DB_TEST_RECOVERY_LABEL db_tr_err:
#else
#define DB_TEST_SUBLOCKS(env, flags)
#define DB_ENV_TEST_RECOVERY(env, val, ret, name)
#define DB_TEST_RECOVERY(dbp, val, ret, name)
#define DB_TEST_RECOVERY_LABEL
#endif
#if defined(__cplusplus)
}
#endif
#endif /* !_DB_DEBUG_H_ */
|