diff options
Diffstat (limited to 'src/third_party/wiredtiger/src/include/verbose.h')
| -rw-r--r-- | src/third_party/wiredtiger/src/include/verbose.h | 166 |
1 files changed, 166 insertions, 0 deletions
diff --git a/src/third_party/wiredtiger/src/include/verbose.h b/src/third_party/wiredtiger/src/include/verbose.h new file mode 100644 index 00000000000..ab23f4667a4 --- /dev/null +++ b/src/third_party/wiredtiger/src/include/verbose.h @@ -0,0 +1,166 @@ +/*- + * Copyright (c) 2014-present MongoDB, Inc. + * Copyright (c) 2008-2014 WiredTiger, Inc. + * All rights reserved. + * + * See the file LICENSE for redistribution information. + */ + +/* Permitted verbose event categories that can be used when defining a verbose message. */ +typedef enum { + WT_VERB_API = 0, + WT_VERB_BACKUP, + WT_VERB_BLOCK, + WT_VERB_CHECKPOINT, + WT_VERB_CHECKPOINT_CLEANUP, + WT_VERB_CHECKPOINT_PROGRESS, + WT_VERB_COMPACT, + WT_VERB_COMPACT_PROGRESS, + WT_VERB_ERROR_RETURNS, + WT_VERB_EVICT, + WT_VERB_EVICTSERVER, + WT_VERB_EVICT_STUCK, + WT_VERB_FILEOPS, + WT_VERB_HANDLEOPS, + WT_VERB_HS, + WT_VERB_HS_ACTIVITY, + WT_VERB_LOG, + WT_VERB_LSM, + WT_VERB_LSM_MANAGER, + WT_VERB_METADATA, + WT_VERB_MUTEX, + WT_VERB_OVERFLOW, + WT_VERB_READ, + WT_VERB_RECONCILE, + WT_VERB_RECOVERY, + WT_VERB_RECOVERY_PROGRESS, + WT_VERB_RTS, + WT_VERB_SALVAGE, + WT_VERB_SHARED_CACHE, + WT_VERB_SPLIT, + WT_VERB_TEMPORARY, + WT_VERB_THREAD_GROUP, + WT_VERB_TIERED, + WT_VERB_TIMESTAMP, + WT_VERB_TRANSACTION, + WT_VERB_VERIFY, + WT_VERB_VERSION, + WT_VERB_WRITE, + /* This entry needs to be the last in order to track the number of category items. */ + WT_VERB_NUM_CATEGORIES, +} WT_VERBOSE_CATEGORY; + +/* + * Permitted verbosity levels; to be used when defining verbose messages. The levels define a range + * of severity categories, with WT_VERBOSE_ERROR being the lowest, most critical level (used by + * messages on critical error paths) and WT_VERBOSE_DEBUG being the highest verbosity/informational + * level (mostly adopted for debugging). + */ +typedef enum { + WT_VERBOSE_ERROR = -2, + WT_VERBOSE_WARNING, + WT_VERBOSE_INFO, + WT_VERBOSE_DEBUG +} WT_VERBOSE_LEVEL; + +/* + * Default verbosity level. WT_VERBOSE_DEBUG being the default level assigned to verbose messages + * prior to the introduction of verbosity levels. + */ +#define WT_VERBOSE_DEFAULT WT_VERBOSE_DEBUG + +/* + * WT_VERBOSE_MULTI_CATEGORY -- + * Simple structure to represent a set of verbose categories. + */ +struct __wt_verbose_multi_category { + WT_VERBOSE_CATEGORY *categories; + uint32_t cnt; +}; + +/* Generate a set of verbose categories. */ +#define WT_DECL_VERBOSE_MULTI_CATEGORY(items) \ + ((WT_VERBOSE_MULTI_CATEGORY){.categories = (items), .cnt = WT_ELEMENTS(items)}) + +/* Check if a given verbosity level satisfies the verbosity level of a category. */ +#define WT_VERBOSE_LEVEL_ISSET(session, category, level) (level <= S2C(session)->verbose[category]) + +/* + * Given this verbosity check is without an explicit verbosity level, the macro checks whether the + * given category satisfies the default verbosity level. + */ +#define WT_VERBOSE_ISSET(session, category) \ + WT_VERBOSE_LEVEL_ISSET(session, category, WT_VERBOSE_DEFAULT) + +/* + * __wt_verbose_level -- + * Display a verbose message considering a category and a verbosity level. + */ +#define __wt_verbose_level(session, category, level, fmt, ...) \ + do { \ + if (WT_VERBOSE_LEVEL_ISSET(session, category, level)) \ + __wt_verbose_worker(session, "[" #category "] " fmt, __VA_ARGS__); \ + } while (0) + +/* + * __wt_verbose_error -- + * Wrapper to __wt_verbose_level defaulting the verbosity level to WT_VERBOSE_ERROR. + */ +#define __wt_verbose_error(session, category, fmt, ...) \ + __wt_verbose_level(session, category, WT_VERBOSE_ERROR, fmt, __VA_ARGS__) + +/* + * __wt_verbose_warning -- + * Wrapper to __wt_verbose_level defaulting the verbosity level to WT_VERBOSE_WARNING. + */ +#define __wt_verbose_warning(session, category, fmt, ...) \ + __wt_verbose_level(session, category, WT_VERBOSE_WARNING, fmt, __VA_ARGS__) + +/* + * __wt_verbose_info -- + * Wrapper to __wt_verbose_level defaulting the verbosity level to WT_VERBOSE_INFO. + */ +#define __wt_verbose_info(session, category, fmt, ...) \ + __wt_verbose_level(session, category, WT_VERBOSE_INFO, fmt, __VA_ARGS__) + +/* + * __wt_verbose_debug -- + * Wrapper to __wt_verbose_level using the default verbosity level. + */ +#define __wt_verbose_debug(session, category, fmt, ...) \ + __wt_verbose_level(session, category, WT_VERBOSE_DEBUG, fmt, __VA_ARGS__) + +/* + * __wt_verbose -- + * Display a verbose message using the default verbosity level. Not an inlined function because + * you can't inline functions taking variadic arguments and we don't want to make a function + * call in production systems just to find out a verbose flag isn't set. The macro must take a + * format string and at least one additional argument, there's no portable way to remove the + * comma before an empty __VA_ARGS__ value. + */ +#define __wt_verbose(session, category, fmt, ...) \ + __wt_verbose_level(session, category, WT_VERBOSE_DEFAULT, fmt, __VA_ARGS__) + +/* + * __wt_verbose_level_multi -- + * Display a verbose message, given a set of multiple verbose categories. A verbose message will + * be displayed if at least one category in the set satisfies the required verbosity level. + */ +#define __wt_verbose_level_multi(session, multi_category, level, fmt, ...) \ + do { \ + uint32_t __v_idx; \ + for (__v_idx = 0; __v_idx < multi_category.cnt; __v_idx++) { \ + if (WT_VERBOSE_LEVEL_ISSET(session, multi_category.categories[__v_idx], level)) { \ + __wt_verbose_worker(session, "[" #multi_category "] " fmt, __VA_ARGS__); \ + break; \ + } \ + } \ + } while (0) + +/* + * __wt_verbose_multi -- + * Display a verbose message, given a set of multiple verbose categories using the default + * verbosity level. + */ +#define __wt_verbose_multi(session, multi_category, fmt, ...) \ + __wt_verbose_level_multi(session, multi_category, WT_VERBOSE_DEFAULT, fmt, __VA_ARGS__) |