1 #ifndef DEBUG_SYNC_INCLUDED 2 #define DEBUG_SYNC_INCLUDED 3 4 /* Copyright (c) 2009, 2021, Oracle and/or its affiliates. 5 6 This program is free software; you can redistribute it and/or modify 7 it under the terms of the GNU General Public License, version 2.0, 8 as published by the Free Software Foundation. 9 10 This program is also distributed with certain software (including 11 but not limited to OpenSSL) that is licensed under separate terms, 12 as designated in a particular file or component or in included license 13 documentation. The authors of MySQL hereby grant you an additional 14 permission to link the program and your derivative works with the 15 separately licensed software that they have included with MySQL. 16 17 This program is distributed in the hope that it will be useful, 18 but WITHOUT ANY WARRANTY; without even the implied warranty of 19 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 20 GNU General Public License, version 2.0, for more details. 21 22 You should have received a copy of the GNU General Public License 23 along with this program; if not, write to the Free Software Foundation, 24 51 Franklin Street, Suite 500, Boston, MA 02110-1335 USA */ 25 26 /** 27 @file 28 29 Declarations for the Debug Sync Facility. See debug_sync.cc for details. 30 */ 31 32 #include <my_global.h> 33 34 class THD; 35 36 #if defined(ENABLED_DEBUG_SYNC) 37 38 /* Macro to be put in the code at synchronization points. */ 39 #define DEBUG_SYNC(_thd_, _sync_point_name_) \ 40 do { if (unlikely(opt_debug_sync_timeout)) \ 41 debug_sync(_thd_, STRING_WITH_LEN(_sync_point_name_)); \ 42 } while (0) 43 44 /* Command line option --debug-sync-timeout. See mysqld.cc. */ 45 extern MYSQL_PLUGIN_IMPORT uint opt_debug_sync_timeout; 46 47 /* Default WAIT_FOR timeout if command line option is given without argument. */ 48 #define DEBUG_SYNC_DEFAULT_WAIT_TIMEOUT 300 49 50 /* Debug Sync prototypes. See debug_sync.cc. */ 51 extern int debug_sync_init(void); 52 extern void debug_sync_end(void); 53 extern void debug_sync_init_thread(THD *thd); 54 extern void debug_sync_claim_memory_ownership(THD *thd); 55 extern void debug_sync_end_thread(THD *thd); 56 extern void debug_sync(THD *thd, const char *sync_point_name, size_t name_len); 57 extern bool debug_sync_set_action(THD *thd, const char *action_str, size_t len); 58 59 #else /* defined(ENABLED_DEBUG_SYNC) */ 60 61 #define DEBUG_SYNC(_thd_, _sync_point_name_) /* disabled DEBUG_SYNC */ 62 63 #endif /* defined(ENABLED_DEBUG_SYNC) */ 64 65 #endif /* DEBUG_SYNC_INCLUDED */ 66