mirror of
https://github.com/MariaDB/server.git
synced 2025-01-16 20:12:31 +01:00
b7f887652b
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.
134 lines
5.2 KiB
C
134 lines
5.2 KiB
C
/* 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
|
|
the Free Software Foundation; version 2 of the License.
|
|
|
|
This program is distributed in the hope that it will be useful,
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
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 */
|
|
|
|
#ifndef _dbug_h
|
|
#define _dbug_h
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
#if !defined(DBUG_OFF) && !defined(_lint)
|
|
struct _db_code_state_;
|
|
extern int _db_keyword_(struct _db_code_state_ *cs, const char *keyword);
|
|
extern int _db_keywords_(const char *, const char *);
|
|
extern int _db_strict_keyword_(const char *keyword);
|
|
extern int _db_explain_(struct _db_code_state_ *cs, char *buf, size_t len);
|
|
extern int _db_explain_init_(char *buf, size_t len);
|
|
extern void _db_setjmp_(void);
|
|
extern void _db_longjmp_(void);
|
|
extern void _db_process_(const char *name);
|
|
extern void _db_push_(const char *control);
|
|
extern void _db_pop_(void);
|
|
extern void _db_set_(struct _db_code_state_ *cs, const char *control);
|
|
extern void _db_set_init_(const char *control);
|
|
extern void _db_enter_(const char *_func_,const char *_file_,uint _line_,
|
|
const char **_sfunc_,const char **_sfile_,
|
|
uint *_slevel_, char ***);
|
|
extern void _db_return_(uint _line_,const char **_sfunc_,const char **_sfile_,
|
|
uint *_slevel_);
|
|
extern void _db_pargs_(uint _line_,const char *keyword);
|
|
extern void _db_doprnt_ _VARARGS((const char *format,...))
|
|
ATTRIBUTE_FORMAT(printf, 1, 2);
|
|
extern void _db_dump_(uint _line_,const char *keyword,
|
|
const unsigned char *memory, size_t length);
|
|
extern void _db_end_(void);
|
|
extern void _db_lock_file_(void);
|
|
extern void _db_unlock_file_(void);
|
|
extern FILE *_db_fp_(void);
|
|
extern const char* _db_get_func_(void);
|
|
|
|
#define DBUG_ENTER(a) const char *_db_func_, *_db_file_; uint _db_level_; \
|
|
char **_db_framep_; \
|
|
_db_enter_ (a,__FILE__,__LINE__,&_db_func_,&_db_file_,&_db_level_, \
|
|
&_db_framep_)
|
|
#define DBUG_LEAVE \
|
|
_db_return_ (__LINE__, &_db_func_, &_db_file_, &_db_level_)
|
|
#define DBUG_RETURN(a1) do {DBUG_LEAVE; return(a1);} while(0)
|
|
#define DBUG_VOID_RETURN do {DBUG_LEAVE; return;} while(0)
|
|
#define DBUG_EXECUTE(keyword,a1) \
|
|
do {if (_db_keyword_(0, (keyword))) { a1 }} while(0)
|
|
#define DBUG_EXECUTE_IF(keyword,a1) \
|
|
do {if (_db_strict_keyword_ (keyword)) { a1 } } while(0)
|
|
#define DBUG_EVALUATE(keyword,a1,a2) \
|
|
(_db_keyword_(0,(keyword)) ? (a1) : (a2))
|
|
#define DBUG_EVALUATE_IF(keyword,a1,a2) \
|
|
(_db_strict_keyword_((keyword)) ? (a1) : (a2))
|
|
#define DBUG_PRINT(keyword,arglist) \
|
|
do {_db_pargs_(__LINE__,keyword); _db_doprnt_ arglist;} while(0)
|
|
#define DBUG_PUSH(a1) _db_push_ (a1)
|
|
#define DBUG_POP() _db_pop_ ()
|
|
#define DBUG_SET(a1) _db_set_ (0, (a1))
|
|
#define DBUG_SET_INITIAL(a1) _db_set_init_ (a1)
|
|
#define DBUG_PROCESS(a1) _db_process_(a1)
|
|
#define DBUG_FILE _db_fp_()
|
|
#define DBUG_SETJMP(a1) (_db_setjmp_ (), setjmp (a1))
|
|
#define DBUG_LONGJMP(a1,a2) (_db_longjmp_ (), longjmp (a1, a2))
|
|
#define DBUG_DUMP(keyword,a1,a2) _db_dump_(__LINE__,keyword,a1,a2)
|
|
#define DBUG_END() _db_end_ ()
|
|
#define DBUG_LOCK_FILE _db_lock_file_()
|
|
#define DBUG_UNLOCK_FILE _db_unlock_file_()
|
|
#define DBUG_ASSERT(A) assert(A)
|
|
#define DBUG_EXPLAIN(buf,len) _db_explain_(0, (buf),(len))
|
|
#define DBUG_EXPLAIN_INITIAL(buf,len) _db_explain_init_((buf),(len))
|
|
#define IF_DBUG(A) A
|
|
#define _DBUG_MAX_FUNC_NAME_ 255
|
|
#define DBUG_CHECK_CRASH(func, op) \
|
|
do { \
|
|
if (_db_keywords_((func), (op))) \
|
|
{ abort(); } \
|
|
} while (0)
|
|
#define DBUG_CRASH_ENTER(func) \
|
|
DBUG_ENTER(func); DBUG_CHECK_CRASH(func, "_crash_enter")
|
|
#define DBUG_CRASH_RETURN(val) \
|
|
do {DBUG_CHECK_CRASH(_db_get_func_(), "_crash_return"); \
|
|
DBUG_RETURN(val);} while(0)
|
|
#define DBUG_CRASH_VOID_RETURN \
|
|
do {DBUG_CHECK_CRASH (_db_get_func_(), "_crash_return"); \
|
|
DBUG_VOID_RETURN;} while(0)
|
|
#else /* No debugger */
|
|
|
|
#define DBUG_ENTER(a1)
|
|
#define DBUG_LEAVE
|
|
#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)
|
|
#define DBUG_EVALUATE(keyword,a1,a2) (a2)
|
|
#define DBUG_EVALUATE_IF(keyword,a1,a2) (a2)
|
|
#define DBUG_PRINT(keyword,arglist) do { } while(0)
|
|
#define DBUG_PUSH(a1)
|
|
#define DBUG_SET(a1)
|
|
#define DBUG_SET_INITIAL(a1)
|
|
#define DBUG_POP()
|
|
#define DBUG_PROCESS(a1)
|
|
#define DBUG_SETJMP(a1) setjmp(a1)
|
|
#define DBUG_LONGJMP(a1) longjmp(a1)
|
|
#define DBUG_DUMP(keyword,a1,a2)
|
|
#define DBUG_END()
|
|
#define DBUG_ASSERT(A) do { } while(0)
|
|
#define DBUG_LOCK_FILE
|
|
#define DBUG_FILE (stderr)
|
|
#define DBUG_UNLOCK_FILE
|
|
#define DBUG_EXPLAIN(buf,len)
|
|
#define DBUG_EXPLAIN_INITIAL(buf,len)
|
|
#define IF_DBUG(A)
|
|
#define DBUG_CRASH_ENTER(func)
|
|
#define DBUG_CRASH_RETURN(val) do { return(val); } while(0)
|
|
#define DBUG_CRASH_VOID_RETURN do { return; } while(0)
|
|
#endif
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
#endif
|