2001-12-06 13:10:51 +01:00
|
|
|
/* Copyright (C) 2000 MySQL AB
|
|
|
|
|
|
|
|
|
|
This program is free software; you can redistribute it and/or modify
|
|
|
|
|
it under the terms of the GNU General Public License as published by
|
2006-12-23 20:17:15 +01:00
|
|
|
the Free Software Foundation; version 2 of the License.
|
2001-12-06 13:10:51 +01:00
|
|
|
|
|
|
|
|
This program is distributed in the hope that it will be useful,
|
2000-07-31 21:29:14 +02:00
|
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
2001-12-06 13:10:51 +01:00
|
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
|
|
GNU General Public License for more details.
|
|
|
|
|
|
|
|
|
|
You should have received a copy of the GNU General Public License
|
|
|
|
|
along with this program; if not, write to the Free Software
|
|
|
|
|
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */
|
2000-07-31 21:29:14 +02:00
|
|
|
|
|
|
|
|
#ifndef _dbug_h
|
|
|
|
|
#define _dbug_h
|
2004-06-27 23:42:02 +02:00
|
|
|
|
2009-10-30 19:13:58 +01:00
|
|
|
#ifdef __cplusplus
|
2000-07-31 21:29:14 +02:00
|
|
|
extern "C" {
|
|
|
|
|
#endif
|
|
|
|
|
#if !defined(DBUG_OFF) && !defined(_lint)
|
2009-10-30 19:13:58 +01:00
|
|
|
|
|
|
|
|
struct _db_stack_frame_ {
|
|
|
|
|
const char *func; /* function name of the previous stack frame */
|
|
|
|
|
const char *file; /* filename of the function of previous frame */
|
|
|
|
|
uint level; /* this nesting level, highest bit enables tracing */
|
|
|
|
|
struct _db_stack_frame_ *prev; /* pointer to the previous frame */
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
struct _db_code_state_;
|
|
|
|
|
extern my_bool _dbug_on_;
|
|
|
|
|
extern my_bool _db_keyword_(struct _db_code_state_ *, const char *, int);
|
WL#3817: Simplify string / memory area types and make things more consistent (first part)
The following type conversions was done:
- Changed byte to uchar
- Changed gptr to uchar*
- Change my_string to char *
- Change my_size_t to size_t
- Change size_s to size_t
Removed declaration of byte, gptr, my_string, my_size_t and size_s.
Following function parameter changes was done:
- All string functions in mysys/strings was changed to use size_t
instead of uint for string lengths.
- All read()/write() functions changed to use size_t (including vio).
- All protocoll functions changed to use size_t instead of uint
- Functions that used a pointer to a string length was changed to use size_t*
- Changed malloc(), free() and related functions from using gptr to use void *
as this requires fewer casts in the code and is more in line with how the
standard functions work.
- Added extra length argument to dirname_part() to return the length of the
created string.
- Changed (at least) following functions to take uchar* as argument:
- db_dump()
- my_net_write()
- net_write_command()
- net_store_data()
- DBUG_DUMP()
- decimal2bin() & bin2decimal()
- Changed my_compress() and my_uncompress() to use size_t. Changed one
argument to my_uncompress() from a pointer to a value as we only return
one value (makes function easier to use).
- Changed type of 'pack_data' argument to packfrm() to avoid casts.
- Changed in readfrm() and writefrom(), ha_discover and handler::discover()
the type for argument 'frmdata' to uchar** to avoid casts.
- Changed most Field functions to use uchar* instead of char* (reduced a lot of
casts).
- Changed field->val_xxx(xxx, new_ptr) to take const pointers.
Other changes:
- Removed a lot of not needed casts
- Added a few new cast required by other changes
- Added some cast to my_multi_malloc() arguments for safety (as string lengths
needs to be uint, not size_t).
- Fixed all calls to hash-get-key functions to use size_t*. (Needed to be done
explicitely as this conflict was often hided by casting the function to
hash_get_key).
- Changed some buffers to memory regions to uchar* to avoid casts.
- Changed some string lengths from uint to size_t.
- Changed field->ptr to be uchar* instead of char*. This allowed us to
get rid of a lot of casts.
- Some changes from true -> TRUE, false -> FALSE, unsigned char -> uchar
- Include zlib.h in some files as we needed declaration of crc32()
- Changed MY_FILE_ERROR to be (size_t) -1.
- Changed many variables to hold the result of my_read() / my_write() to be
size_t. This was needed to properly detect errors (which are
returned as (size_t) -1).
- Removed some very old VMS code
- Changed packfrm()/unpackfrm() to not be depending on uint size
(portability fix)
- Removed windows specific code to restore cursor position as this
causes slowdown on windows and we should not mix read() and pread()
calls anyway as this is not thread safe. Updated function comment to
reflect this. Changed function that depended on original behavior of
my_pwrite() to itself restore the cursor position (one such case).
- Added some missing checking of return value of malloc().
- Changed definition of MOD_PAD_CHAR_TO_FULL_LENGTH to avoid 'long' overflow.
- Changed type of table_def::m_size from my_size_t to ulong to reflect that
m_size is the number of elements in the array, not a string/memory
length.
- Moved THD::max_row_length() to table.cc (as it's not depending on THD).
Inlined max_row_length_blob() into this function.
- More function comments
- Fixed some compiler warnings when compiled without partitions.
- Removed setting of LEX_STRING() arguments in declaration (portability fix).
- Some trivial indentation/variable name changes.
- Some trivial code simplifications:
- Replaced some calls to alloc_root + memcpy to use
strmake_root()/strdup_root().
- Changed some calls from memdup() to strmake() (Safety fix)
- Simpler loops in client-simple.c
2007-05-10 11:59:39 +02:00
|
|
|
extern int _db_explain_(struct _db_code_state_ *cs, char *buf, size_t len);
|
|
|
|
|
extern int _db_explain_init_(char *buf, size_t len);
|
2009-10-30 19:13:58 +01:00
|
|
|
extern int _db_is_pushed_(void);
|
|
|
|
|
extern void _db_setjmp_(void);
|
|
|
|
|
extern void _db_longjmp_(void);
|
2006-02-14 22:36:11 +01:00
|
|
|
extern void _db_process_(const char *name);
|
2009-10-30 19:13:58 +01:00
|
|
|
extern void _db_push_(const char *control);
|
|
|
|
|
extern void _db_pop_(void);
|
|
|
|
|
extern void _db_set_(const char *control);
|
2006-02-14 22:36:11 +01:00
|
|
|
extern void _db_set_init_(const char *control);
|
2009-10-30 19:13:58 +01:00
|
|
|
extern void _db_enter_(const char *_func_, const char *_file_, uint _line_,
|
|
|
|
|
struct _db_stack_frame_ *_stack_frame_);
|
|
|
|
|
extern void _db_return_(uint _line_, struct _db_stack_frame_ *_stack_frame_);
|
|
|
|
|
extern void _db_pargs_(uint _line_,const char *keyword);
|
2010-07-15 13:16:06 +02:00
|
|
|
extern void _db_doprnt_(const char *format,...)
|
2006-10-12 20:02:17 +02:00
|
|
|
ATTRIBUTE_FORMAT(printf, 1, 2);
|
2009-10-30 19:13:58 +01:00
|
|
|
extern void _db_dump_(uint _line_,const char *keyword,
|
WL#3817: Simplify string / memory area types and make things more consistent (first part)
The following type conversions was done:
- Changed byte to uchar
- Changed gptr to uchar*
- Change my_string to char *
- Change my_size_t to size_t
- Change size_s to size_t
Removed declaration of byte, gptr, my_string, my_size_t and size_s.
Following function parameter changes was done:
- All string functions in mysys/strings was changed to use size_t
instead of uint for string lengths.
- All read()/write() functions changed to use size_t (including vio).
- All protocoll functions changed to use size_t instead of uint
- Functions that used a pointer to a string length was changed to use size_t*
- Changed malloc(), free() and related functions from using gptr to use void *
as this requires fewer casts in the code and is more in line with how the
standard functions work.
- Added extra length argument to dirname_part() to return the length of the
created string.
- Changed (at least) following functions to take uchar* as argument:
- db_dump()
- my_net_write()
- net_write_command()
- net_store_data()
- DBUG_DUMP()
- decimal2bin() & bin2decimal()
- Changed my_compress() and my_uncompress() to use size_t. Changed one
argument to my_uncompress() from a pointer to a value as we only return
one value (makes function easier to use).
- Changed type of 'pack_data' argument to packfrm() to avoid casts.
- Changed in readfrm() and writefrom(), ha_discover and handler::discover()
the type for argument 'frmdata' to uchar** to avoid casts.
- Changed most Field functions to use uchar* instead of char* (reduced a lot of
casts).
- Changed field->val_xxx(xxx, new_ptr) to take const pointers.
Other changes:
- Removed a lot of not needed casts
- Added a few new cast required by other changes
- Added some cast to my_multi_malloc() arguments for safety (as string lengths
needs to be uint, not size_t).
- Fixed all calls to hash-get-key functions to use size_t*. (Needed to be done
explicitely as this conflict was often hided by casting the function to
hash_get_key).
- Changed some buffers to memory regions to uchar* to avoid casts.
- Changed some string lengths from uint to size_t.
- Changed field->ptr to be uchar* instead of char*. This allowed us to
get rid of a lot of casts.
- Some changes from true -> TRUE, false -> FALSE, unsigned char -> uchar
- Include zlib.h in some files as we needed declaration of crc32()
- Changed MY_FILE_ERROR to be (size_t) -1.
- Changed many variables to hold the result of my_read() / my_write() to be
size_t. This was needed to properly detect errors (which are
returned as (size_t) -1).
- Removed some very old VMS code
- Changed packfrm()/unpackfrm() to not be depending on uint size
(portability fix)
- Removed windows specific code to restore cursor position as this
causes slowdown on windows and we should not mix read() and pread()
calls anyway as this is not thread safe. Updated function comment to
reflect this. Changed function that depended on original behavior of
my_pwrite() to itself restore the cursor position (one such case).
- Added some missing checking of return value of malloc().
- Changed definition of MOD_PAD_CHAR_TO_FULL_LENGTH to avoid 'long' overflow.
- Changed type of table_def::m_size from my_size_t to ulong to reflect that
m_size is the number of elements in the array, not a string/memory
length.
- Moved THD::max_row_length() to table.cc (as it's not depending on THD).
Inlined max_row_length_blob() into this function.
- More function comments
- Fixed some compiler warnings when compiled without partitions.
- Removed setting of LEX_STRING() arguments in declaration (portability fix).
- Some trivial indentation/variable name changes.
- Some trivial code simplifications:
- Replaced some calls to alloc_root + memcpy to use
strmake_root()/strdup_root().
- Changed some calls from memdup() to strmake() (Safety fix)
- Simpler loops in client-simple.c
2007-05-10 11:59:39 +02:00
|
|
|
const unsigned char *memory, size_t length);
|
2009-10-30 19:13:58 +01:00
|
|
|
extern void _db_end_(void);
|
|
|
|
|
extern void _db_lock_file_(void);
|
|
|
|
|
extern void _db_unlock_file_(void);
|
|
|
|
|
extern FILE *_db_fp_(void);
|
|
|
|
|
extern void _db_flush_();
|
WL#4828 and BUG#45747
NOTE: Backporting the patch to next-mr.
WL#4828 Augment DBUG_ENTER/DBUG_EXIT to crash MySQL in different functions
-------
The assessment of the replication code in the presence of faults is extremely
import to increase reliability. In particular, one needs to know if servers
will either correctly recovery or print out appropriate error messages thus
avoiding unexpected problems in a production environment.
In order to accomplish this, the current patch refactories the debug macros
already provided in the source code and introduces three new macros that
allows to inject faults, specifically crashes, while entering or exiting a
function or method. For instance, to crash a server while returning from
the init_slave function (see module sql/slave.cc), one needs to do what
follows:
1 - Modify the source replacing DBUG_RETURN by DBUG_CRASH_RETURN;
DBUG_CRASH_RETURN(0);
2 - Use the debug variable to activate dbug instructions:
SET SESSION debug="+d,init_slave_crash_return";
The new macros are briefly described below:
DBUG_CRASH_ENTER (function) is equivalent to DBUG_ENTER which registers the
beginning of a function but in addition to it allows for crashing the server
while entering the function if the appropriate dbug instruction is activate.
In this case, the dbug instruction should be "+d,function_crash_enter".
DBUG_CRASH_RETURN (value) is equivalent to DBUG_RETURN which notifies the
end of a function but in addition to it allows for crashing the server
while returning from the function if the appropriate dbug instruction is
activate. In this case, the dbug instruction should be
"+d,function_crash_return". Note that "function" should be the same string
used by either the DBUG_ENTER or DBUG_CRASH_ENTER.
DBUG_CRASH_VOID_RETURN (value) is equivalent to DBUG_VOID_RETURN which
notifies the end of a function but in addition to it allows for crashing
the server while returning from the function if the appropriate dbug
instruction is activate. In this case, the dbug instruction should be
"+d,function_crash_return". Note that "function" should be the same string
used by either the DBUG_ENTER or DBUG_CRASH_ENTER.
To inject other faults, for instance, wrong return values, one should rely
on the macros already available. The current patch also removes a set of
macros that were either not being used or were redundant as other macros
could be used to provide the same feature. In the future, we also consider
dynamic instrumentation of the code.
BUG#45747 DBUG_CRASH_* is not setting the strict option
---------
When combining DBUG_CRASH_* with "--debug=d:t:i:A,file" the server crashes
due to a call to the abort function in the DBUG_CRASH_* macro althought the
appropriate keyword has not been set.
2009-09-29 15:55:36 +02:00
|
|
|
extern const char* _db_get_func_(void);
|
2000-07-31 21:29:14 +02:00
|
|
|
|
2009-10-30 19:13:58 +01:00
|
|
|
#define DBUG_ENTER(a) struct _db_stack_frame_ _db_stack_frame_; \
|
|
|
|
|
_db_enter_ (a,__FILE__,__LINE__,&_db_stack_frame_)
|
|
|
|
|
#define DBUG_LEAVE _db_return_ (__LINE__, &_db_stack_frame_)
|
2006-02-14 22:36:11 +01:00
|
|
|
#define DBUG_RETURN(a1) do {DBUG_LEAVE; return(a1);} while(0)
|
|
|
|
|
#define DBUG_VOID_RETURN do {DBUG_LEAVE; return;} while(0)
|
2000-07-31 21:29:14 +02:00
|
|
|
#define DBUG_EXECUTE(keyword,a1) \
|
2009-10-30 19:13:58 +01:00
|
|
|
do {if (_db_keyword_(0, (keyword), 0)) { a1 }} while(0)
|
2006-02-14 22:36:11 +01:00
|
|
|
#define DBUG_EXECUTE_IF(keyword,a1) \
|
2009-10-30 19:13:58 +01:00
|
|
|
do {if (_db_keyword_(0, (keyword), 1)) { a1 }} while(0)
|
2006-02-14 22:36:11 +01:00
|
|
|
#define DBUG_EVALUATE(keyword,a1,a2) \
|
2009-10-30 19:13:58 +01:00
|
|
|
(_db_keyword_(0,(keyword), 0) ? (a1) : (a2))
|
2006-02-14 22:36:11 +01:00
|
|
|
#define DBUG_EVALUATE_IF(keyword,a1,a2) \
|
2009-10-30 19:13:58 +01:00
|
|
|
(_db_keyword_(0,(keyword), 1) ? (a1) : (a2))
|
2000-07-31 21:29:14 +02:00
|
|
|
#define DBUG_PRINT(keyword,arglist) \
|
2006-02-14 22:36:11 +01:00
|
|
|
do {_db_pargs_(__LINE__,keyword); _db_doprnt_ arglist;} while(0)
|
2000-07-31 21:29:14 +02:00
|
|
|
#define DBUG_PUSH(a1) _db_push_ (a1)
|
|
|
|
|
#define DBUG_POP() _db_pop_ ()
|
2009-10-30 19:13:58 +01:00
|
|
|
#define DBUG_SET(a1) _db_set_ (a1)
|
2006-02-14 22:36:11 +01:00
|
|
|
#define DBUG_SET_INITIAL(a1) _db_set_init_ (a1)
|
|
|
|
|
#define DBUG_PROCESS(a1) _db_process_(a1)
|
|
|
|
|
#define DBUG_FILE _db_fp_()
|
2000-07-31 21:29:14 +02:00
|
|
|
#define DBUG_SETJMP(a1) (_db_setjmp_ (), setjmp (a1))
|
|
|
|
|
#define DBUG_LONGJMP(a1,a2) (_db_longjmp_ (), longjmp (a1, a2))
|
2006-02-14 22:36:11 +01:00
|
|
|
#define DBUG_DUMP(keyword,a1,a2) _db_dump_(__LINE__,keyword,a1,a2)
|
2006-05-15 18:07:18 +02:00
|
|
|
#define DBUG_END() _db_end_ ()
|
2006-02-14 22:36:11 +01:00
|
|
|
#define DBUG_LOCK_FILE _db_lock_file_()
|
|
|
|
|
#define DBUG_UNLOCK_FILE _db_unlock_file_()
|
2001-09-08 10:47:34 +02:00
|
|
|
#define DBUG_ASSERT(A) assert(A)
|
2006-02-14 22:36:11 +01:00
|
|
|
#define DBUG_EXPLAIN(buf,len) _db_explain_(0, (buf),(len))
|
|
|
|
|
#define DBUG_EXPLAIN_INITIAL(buf,len) _db_explain_init_((buf),(len))
|
2009-10-30 19:13:58 +01:00
|
|
|
#define DEBUGGER_OFF do { _dbug_on_= 0; } while(0)
|
|
|
|
|
#define DEBUGGER_ON do { _dbug_on_= 1; } while(0)
|
|
|
|
|
#ifndef __WIN__
|
|
|
|
|
#define DBUG_ABORT() (_db_flush_(), abort())
|
|
|
|
|
#else
|
|
|
|
|
/*
|
|
|
|
|
Avoid popup with abort/retry/ignore buttons. When BUG#31745 is fixed we can
|
|
|
|
|
call abort() instead of _exit(3) (now it would cause a "test signal" popup).
|
|
|
|
|
*/
|
|
|
|
|
#include <crtdbg.h>
|
|
|
|
|
#define DBUG_ABORT() (_db_flush_(),\
|
|
|
|
|
(void)_CrtSetReportMode(_CRT_ERROR, _CRTDBG_MODE_FILE),\
|
|
|
|
|
(void)_CrtSetReportFile(_CRT_ERROR, _CRTDBG_FILE_STDERR),\
|
|
|
|
|
_exit(3))
|
|
|
|
|
#endif
|
WL#4828 and BUG#45747
NOTE: Backporting the patch to next-mr.
WL#4828 Augment DBUG_ENTER/DBUG_EXIT to crash MySQL in different functions
-------
The assessment of the replication code in the presence of faults is extremely
import to increase reliability. In particular, one needs to know if servers
will either correctly recovery or print out appropriate error messages thus
avoiding unexpected problems in a production environment.
In order to accomplish this, the current patch refactories the debug macros
already provided in the source code and introduces three new macros that
allows to inject faults, specifically crashes, while entering or exiting a
function or method. For instance, to crash a server while returning from
the init_slave function (see module sql/slave.cc), one needs to do what
follows:
1 - Modify the source replacing DBUG_RETURN by DBUG_CRASH_RETURN;
DBUG_CRASH_RETURN(0);
2 - Use the debug variable to activate dbug instructions:
SET SESSION debug="+d,init_slave_crash_return";
The new macros are briefly described below:
DBUG_CRASH_ENTER (function) is equivalent to DBUG_ENTER which registers the
beginning of a function but in addition to it allows for crashing the server
while entering the function if the appropriate dbug instruction is activate.
In this case, the dbug instruction should be "+d,function_crash_enter".
DBUG_CRASH_RETURN (value) is equivalent to DBUG_RETURN which notifies the
end of a function but in addition to it allows for crashing the server
while returning from the function if the appropriate dbug instruction is
activate. In this case, the dbug instruction should be
"+d,function_crash_return". Note that "function" should be the same string
used by either the DBUG_ENTER or DBUG_CRASH_ENTER.
DBUG_CRASH_VOID_RETURN (value) is equivalent to DBUG_VOID_RETURN which
notifies the end of a function but in addition to it allows for crashing
the server while returning from the function if the appropriate dbug
instruction is activate. In this case, the dbug instruction should be
"+d,function_crash_return". Note that "function" should be the same string
used by either the DBUG_ENTER or DBUG_CRASH_ENTER.
To inject other faults, for instance, wrong return values, one should rely
on the macros already available. The current patch also removes a set of
macros that were either not being used or were redundant as other macros
could be used to provide the same feature. In the future, we also consider
dynamic instrumentation of the code.
BUG#45747 DBUG_CRASH_* is not setting the strict option
---------
When combining DBUG_CRASH_* with "--debug=d:t:i:A,file" the server crashes
due to a call to the abort function in the DBUG_CRASH_* macro althought the
appropriate keyword has not been set.
2009-09-29 15:55:36 +02:00
|
|
|
#define DBUG_CHECK_CRASH(func, op) \
|
2009-10-30 19:13:58 +01:00
|
|
|
do { char _dbuf_[255]; strxnmov(_dbuf_, sizeof(_dbuf_)-1, (func), (op)); \
|
|
|
|
|
DBUG_EXECUTE_IF(_dbuf_, DBUG_ABORT()); } while(0)
|
WL#4828 and BUG#45747
NOTE: Backporting the patch to next-mr.
WL#4828 Augment DBUG_ENTER/DBUG_EXIT to crash MySQL in different functions
-------
The assessment of the replication code in the presence of faults is extremely
import to increase reliability. In particular, one needs to know if servers
will either correctly recovery or print out appropriate error messages thus
avoiding unexpected problems in a production environment.
In order to accomplish this, the current patch refactories the debug macros
already provided in the source code and introduces three new macros that
allows to inject faults, specifically crashes, while entering or exiting a
function or method. For instance, to crash a server while returning from
the init_slave function (see module sql/slave.cc), one needs to do what
follows:
1 - Modify the source replacing DBUG_RETURN by DBUG_CRASH_RETURN;
DBUG_CRASH_RETURN(0);
2 - Use the debug variable to activate dbug instructions:
SET SESSION debug="+d,init_slave_crash_return";
The new macros are briefly described below:
DBUG_CRASH_ENTER (function) is equivalent to DBUG_ENTER which registers the
beginning of a function but in addition to it allows for crashing the server
while entering the function if the appropriate dbug instruction is activate.
In this case, the dbug instruction should be "+d,function_crash_enter".
DBUG_CRASH_RETURN (value) is equivalent to DBUG_RETURN which notifies the
end of a function but in addition to it allows for crashing the server
while returning from the function if the appropriate dbug instruction is
activate. In this case, the dbug instruction should be
"+d,function_crash_return". Note that "function" should be the same string
used by either the DBUG_ENTER or DBUG_CRASH_ENTER.
DBUG_CRASH_VOID_RETURN (value) is equivalent to DBUG_VOID_RETURN which
notifies the end of a function but in addition to it allows for crashing
the server while returning from the function if the appropriate dbug
instruction is activate. In this case, the dbug instruction should be
"+d,function_crash_return". Note that "function" should be the same string
used by either the DBUG_ENTER or DBUG_CRASH_ENTER.
To inject other faults, for instance, wrong return values, one should rely
on the macros already available. The current patch also removes a set of
macros that were either not being used or were redundant as other macros
could be used to provide the same feature. In the future, we also consider
dynamic instrumentation of the code.
BUG#45747 DBUG_CRASH_* is not setting the strict option
---------
When combining DBUG_CRASH_* with "--debug=d:t:i:A,file" the server crashes
due to a call to the abort function in the DBUG_CRASH_* macro althought the
appropriate keyword has not been set.
2009-09-29 15:55:36 +02:00
|
|
|
#define DBUG_CRASH_ENTER(func) \
|
|
|
|
|
DBUG_ENTER(func); DBUG_CHECK_CRASH(func, "_crash_enter")
|
|
|
|
|
#define DBUG_CRASH_RETURN(val) \
|
2009-10-30 19:13:58 +01:00
|
|
|
DBUG_CHECK_CRASH(_db_get_func_(), "_crash_return")
|
WL#4828 and BUG#45747
NOTE: Backporting the patch to next-mr.
WL#4828 Augment DBUG_ENTER/DBUG_EXIT to crash MySQL in different functions
-------
The assessment of the replication code in the presence of faults is extremely
import to increase reliability. In particular, one needs to know if servers
will either correctly recovery or print out appropriate error messages thus
avoiding unexpected problems in a production environment.
In order to accomplish this, the current patch refactories the debug macros
already provided in the source code and introduces three new macros that
allows to inject faults, specifically crashes, while entering or exiting a
function or method. For instance, to crash a server while returning from
the init_slave function (see module sql/slave.cc), one needs to do what
follows:
1 - Modify the source replacing DBUG_RETURN by DBUG_CRASH_RETURN;
DBUG_CRASH_RETURN(0);
2 - Use the debug variable to activate dbug instructions:
SET SESSION debug="+d,init_slave_crash_return";
The new macros are briefly described below:
DBUG_CRASH_ENTER (function) is equivalent to DBUG_ENTER which registers the
beginning of a function but in addition to it allows for crashing the server
while entering the function if the appropriate dbug instruction is activate.
In this case, the dbug instruction should be "+d,function_crash_enter".
DBUG_CRASH_RETURN (value) is equivalent to DBUG_RETURN which notifies the
end of a function but in addition to it allows for crashing the server
while returning from the function if the appropriate dbug instruction is
activate. In this case, the dbug instruction should be
"+d,function_crash_return". Note that "function" should be the same string
used by either the DBUG_ENTER or DBUG_CRASH_ENTER.
DBUG_CRASH_VOID_RETURN (value) is equivalent to DBUG_VOID_RETURN which
notifies the end of a function but in addition to it allows for crashing
the server while returning from the function if the appropriate dbug
instruction is activate. In this case, the dbug instruction should be
"+d,function_crash_return". Note that "function" should be the same string
used by either the DBUG_ENTER or DBUG_CRASH_ENTER.
To inject other faults, for instance, wrong return values, one should rely
on the macros already available. The current patch also removes a set of
macros that were either not being used or were redundant as other macros
could be used to provide the same feature. In the future, we also consider
dynamic instrumentation of the code.
BUG#45747 DBUG_CRASH_* is not setting the strict option
---------
When combining DBUG_CRASH_* with "--debug=d:t:i:A,file" the server crashes
due to a call to the abort function in the DBUG_CRASH_* macro althought the
appropriate keyword has not been set.
2009-09-29 15:55:36 +02:00
|
|
|
#define DBUG_CRASH_VOID_RETURN \
|
2009-10-30 19:13:58 +01:00
|
|
|
DBUG_CHECK_CRASH (_db_get_func_(), "_crash_return")
|
|
|
|
|
|
|
|
|
|
#else /* No debugger */
|
2000-07-31 21:29:14 +02:00
|
|
|
|
|
|
|
|
#define DBUG_ENTER(a1)
|
2006-03-22 09:55:26 +01:00
|
|
|
#define DBUG_LEAVE
|
2009-10-30 19:13:58 +01:00
|
|
|
#define DBUG_RETURN(a1) do { return(a1); } while(0)
|
|
|
|
|
#define DBUG_VOID_RETURN do { return; } while(0)
|
|
|
|
|
#define DBUG_EXECUTE(keyword,a1) do { } while(0)
|
|
|
|
|
#define DBUG_EXECUTE_IF(keyword,a1) do { } while(0)
|
2006-02-14 22:36:11 +01:00
|
|
|
#define DBUG_EVALUATE(keyword,a1,a2) (a2)
|
|
|
|
|
#define DBUG_EVALUATE_IF(keyword,a1,a2) (a2)
|
2009-10-30 19:13:58 +01:00
|
|
|
#define DBUG_PRINT(keyword,arglist) do { } while(0)
|
|
|
|
|
#define DBUG_PUSH(a1) do { } while(0)
|
|
|
|
|
#define DBUG_SET(a1) do { } while(0)
|
|
|
|
|
#define DBUG_SET_INITIAL(a1) do { } while(0)
|
|
|
|
|
#define DBUG_POP() do { } while(0)
|
|
|
|
|
#define DBUG_PROCESS(a1) do { } while(0)
|
2006-02-14 22:36:11 +01:00
|
|
|
#define DBUG_SETJMP(a1) setjmp(a1)
|
|
|
|
|
#define DBUG_LONGJMP(a1) longjmp(a1)
|
2009-10-30 19:13:58 +01:00
|
|
|
#define DBUG_DUMP(keyword,a1,a2) do { } while(0)
|
|
|
|
|
#define DBUG_END() do { } while(0)
|
|
|
|
|
#define DBUG_ASSERT(A) do { } while(0)
|
|
|
|
|
#define DBUG_LOCK_FILE do { } while(0)
|
2006-02-14 22:36:11 +01:00
|
|
|
#define DBUG_FILE (stderr)
|
2009-10-30 19:13:58 +01:00
|
|
|
#define DBUG_UNLOCK_FILE do { } while(0)
|
2006-02-14 22:36:11 +01:00
|
|
|
#define DBUG_EXPLAIN(buf,len)
|
|
|
|
|
#define DBUG_EXPLAIN_INITIAL(buf,len)
|
2009-10-30 19:13:58 +01:00
|
|
|
#define DEBUGGER_OFF do { } while(0)
|
|
|
|
|
#define DEBUGGER_ON do { } while(0)
|
|
|
|
|
#define DBUG_ABORT() abort()
|
WL#4828 and BUG#45747
NOTE: Backporting the patch to next-mr.
WL#4828 Augment DBUG_ENTER/DBUG_EXIT to crash MySQL in different functions
-------
The assessment of the replication code in the presence of faults is extremely
import to increase reliability. In particular, one needs to know if servers
will either correctly recovery or print out appropriate error messages thus
avoiding unexpected problems in a production environment.
In order to accomplish this, the current patch refactories the debug macros
already provided in the source code and introduces three new macros that
allows to inject faults, specifically crashes, while entering or exiting a
function or method. For instance, to crash a server while returning from
the init_slave function (see module sql/slave.cc), one needs to do what
follows:
1 - Modify the source replacing DBUG_RETURN by DBUG_CRASH_RETURN;
DBUG_CRASH_RETURN(0);
2 - Use the debug variable to activate dbug instructions:
SET SESSION debug="+d,init_slave_crash_return";
The new macros are briefly described below:
DBUG_CRASH_ENTER (function) is equivalent to DBUG_ENTER which registers the
beginning of a function but in addition to it allows for crashing the server
while entering the function if the appropriate dbug instruction is activate.
In this case, the dbug instruction should be "+d,function_crash_enter".
DBUG_CRASH_RETURN (value) is equivalent to DBUG_RETURN which notifies the
end of a function but in addition to it allows for crashing the server
while returning from the function if the appropriate dbug instruction is
activate. In this case, the dbug instruction should be
"+d,function_crash_return". Note that "function" should be the same string
used by either the DBUG_ENTER or DBUG_CRASH_ENTER.
DBUG_CRASH_VOID_RETURN (value) is equivalent to DBUG_VOID_RETURN which
notifies the end of a function but in addition to it allows for crashing
the server while returning from the function if the appropriate dbug
instruction is activate. In this case, the dbug instruction should be
"+d,function_crash_return". Note that "function" should be the same string
used by either the DBUG_ENTER or DBUG_CRASH_ENTER.
To inject other faults, for instance, wrong return values, one should rely
on the macros already available. The current patch also removes a set of
macros that were either not being used or were redundant as other macros
could be used to provide the same feature. In the future, we also consider
dynamic instrumentation of the code.
BUG#45747 DBUG_CRASH_* is not setting the strict option
---------
When combining DBUG_CRASH_* with "--debug=d:t:i:A,file" the server crashes
due to a call to the abort function in the DBUG_CRASH_* macro althought the
appropriate keyword has not been set.
2009-09-29 15:55:36 +02:00
|
|
|
#define DBUG_CRASH_ENTER(func)
|
2009-10-30 19:13:58 +01:00
|
|
|
#define DBUG_CRASH_RETURN(val) do { return(val); } while(0)
|
|
|
|
|
#define DBUG_CRASH_VOID_RETURN do { return; } while(0)
|
|
|
|
|
|
2000-07-31 21:29:14 +02:00
|
|
|
#endif
|
2010-03-31 16:05:33 +02:00
|
|
|
|
|
|
|
|
#ifdef EXTRA_DEBUG
|
|
|
|
|
/**
|
|
|
|
|
Sync points allow us to force the server to reach a certain line of code
|
|
|
|
|
and block there until the client tells the server it is ok to go on.
|
|
|
|
|
The client tells the server to block with SELECT GET_LOCK()
|
|
|
|
|
and unblocks it with SELECT RELEASE_LOCK(). Used for debugging difficult
|
|
|
|
|
concurrency problems
|
|
|
|
|
*/
|
|
|
|
|
#define DBUG_SYNC_POINT(lock_name,lock_timeout) \
|
|
|
|
|
debug_sync_point(lock_name,lock_timeout)
|
|
|
|
|
void debug_sync_point(const char* lock_name, uint lock_timeout);
|
|
|
|
|
#else
|
|
|
|
|
#define DBUG_SYNC_POINT(lock_name,lock_timeout)
|
|
|
|
|
#endif /* EXTRA_DEBUG */
|
|
|
|
|
|
|
|
|
|
#ifdef __cplusplus
|
2000-07-31 21:29:14 +02:00
|
|
|
}
|
|
|
|
|
#endif
|
|
|
|
|
#endif
|