summaryrefslogtreecommitdiff
path: root/bdb/tcl/docs/test.html
blob: 603ae56a51efd7a75a5205aee108ae21b1f4d005 (plain)
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
<!--Copyright 1999-2002 by Sleepycat Software, Inc.-->
<!--All rights reserved.-->
<HTML>
<HEAD>
   <META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=iso-8859-1">
   <META NAME="GENERATOR" CONTENT="Mozilla/4.08 [en] (X11; I; FreeBSD 2.2.8-19990120-SNAP i386) [Netscape]">
</HEAD>
<BODY>

<H2>
<A NAME="Debugging"></A>Debugging and Testing</H2>
We have imported the debugging system from the old test suite into the
new interface to aid in debugging problems.&nbsp; There are several variables
that are available both in gdb as globals to the C code, and variables
in Tcl that the user can set.&nbsp; These variables are linked together
so that changes in one venue are reflected in the other.&nbsp; The names
of the variables have been modified a bit to reduce the likelihood
<BR>of namespace trampling.&nbsp; We have added a double underscore to
all the names.
<P>The variables are all initialized to zero (0) thus resulting in debugging
being turned off.&nbsp; The purpose of the debugging, fundamentally, is
to allow the user to set a breakpoint prior to making a DB call.&nbsp;
This breakpoint is set in the <I>__db_loadme() </I>function.&nbsp; The
user may selectively turn on various debugging areas each controlled by
a separate variable (note they all have two (2) underscores prepended to
the name):
<UL>
<LI>
<B>__debug_on</B> - Turns on the debugging system.&nbsp; This must be on
for any debugging to occur</LI>

<LI>
<B>__debug_print - </B>Turns on printing a debug count statement on each
call</LI>

<LI>
<B>__debug_test -</B> Hits the breakpoint in <I>__db_loadme</I> on the
specific iteration</LI>

<LI>
<B>__debug_stop </B>- Hits the breakpoint in <I>__db_loadme</I> on every
(or the next) iteration</LI>
</UL>
<B>Note to developers:</B>&nbsp; Anyone extending this interface must place
a call to <B>_debug_check()</B> (no arguments) before every call into the
DB library.
<P>There is also a command available that will force a call to the _debug_check
function.
<P><B>> berkdb debug_check</B>
<P>
<HR WIDTH="100%">
<BR>For testing purposes we have added several hooks into the DB library
and a small interface into the environment and/or database commands to
manipulate the hooks.&nbsp; This command interface and the hooks and everything
that goes with it is only enabled when the test option is configured into
DB.
<P><B>> &lt;env> test copy <I>location</I></B>
<BR><B>> &lt;db> test copy <I>location</I></B>
<BR><B>> &lt;env> test abort <I>location</I></B>
<BR><B>> &lt;db> test abort <I>location</I></B>
<P>In order to test recovery we need to be able to abort the creation or
deletion process at various points.&nbsp; Also we want to invoke a copy
function to copy the database file(s)&nbsp; at various points as well so
that we can obtain before/after snapshots of the databases.&nbsp; The interface
provides the test command to specify a <B><I>location</I></B> where we
wish to invoke a <B>copy</B> or an <B>abort</B>.&nbsp; The command is available
from either the environment or the database for convenience.&nbsp; The
<B><I>location</I></B>
can be one of the following:
<UL>
<LI>
<B>none -</B> Clears the location</LI>

<LI>
<B>preopen -</B> Sets the location prior to the __os_open call in the creation
process</LI>

<LI>
<B>postopen</B> - Sets the location to immediately following the __os_open
call in creation</LI>

<LI>
<B>postlogmeta</B> - Sets the location to immediately following the __db_log_page
call to log the meta data in creation.&nbsp; Only valid for Btree.</LI>

<LI>
<B>postlog</B> - Sets the location to immediately following the last (or
only) __db_log_page call in creation.</LI>

<LI>
<B>postsync</B> - Sets the location to immediately following the sync of
the log page in creation.</LI>

<LI>
<B>prerename</B> - Sets the location prior to the __os_rename call in the
deletion process.</LI>

<LI>
<B>postrename</B> - Sets the location to immediately following the __os_rename
call in deletion</LI>
</UL>

<HR WIDTH="100%">
<BR><B>> &lt;env> mutex <I>mode nitems</I></B>
<P>This command creates a mutex region for testing.&nbsp; It sets the mode
of the region to <B><I>mode</I></B> and sets up for <B><I>nitems</I></B>
number of mutex entries.&nbsp; After we successfully get a handle to a
mutex we create a command of the form <B><I>$env.mutexX</I></B>, where
X is an integer starting at&nbsp; 0 (e.g. <B>$env.mutex0, $env.mutex1,
</B>etc).&nbsp;&nbsp;
We use the <I>Tcl_CreateObjCommand()&nbsp;</I> to create the top level
mutex function.&nbsp; It is through this handle that the user can access
all of the commands described below.&nbsp; Internally, the mutex handle
is sent as the <I>ClientData</I> portion of the new command set so that
all future mutex calls access the appropriate handle.
<P>
<HR WIDTH="100%"><B>> &lt;mutex> close</B>
<P>This command closes the mutex and renders the handle invalid.&nbsp;&nbsp;
This command directly translates to the __db_r_detach function call.&nbsp;
It returns either a 0 (for success),&nbsp; or it throws a Tcl error with
a system message.
<P>Additionally, since the handle is no longer valid, we will call <I>Tcl_DeleteCommand()
</I>so
that further uses of the handle will be dealt with properly by Tcl itself.&nbsp;
<HR WIDTH="100%"><B>> &lt;mutex> get <I>id</I></B>
<P>This command locks the mutex identified by <B><I>id</I></B>.&nbsp; It
returns either a 0 (for success),&nbsp; or it throws a Tcl error with a
system message.
<BR>
<HR WIDTH="100%"><B>> &lt;mutex> release <I>id</I></B>
<P>This command releases the mutex identified by <B><I>id</I></B>.&nbsp;
It returns either a 0 (for success),&nbsp; or it throws a Tcl error with
a system message.
<BR>
<HR WIDTH="100%"><B>> &lt;mutex> getval <I>id</I></B>
<P>This command gets the value stored for the mutex identified by <B><I>id</I></B>.&nbsp;
It returns either the value,&nbsp; or it throws a Tcl error with a system
message.
<BR>
<HR WIDTH="100%"><B>> &lt;mutex> setval <I>id val</I></B>
<P>This command sets the value stored for the mutex identified by <B><I>id
</I></B>to
<B><I>val</I></B>.&nbsp;
It returns either a 0 (for success),&nbsp; or it throws a Tcl error with
a system message.
<BR>
<HR WIDTH="100%">
<BR>&nbsp;
</BODY>
</HTML>