/* SPDX-License-Identifier: GPL-2.0 */ #ifndef _DYNAMIC_DEBUG_H #define _DYNAMIC_DEBUG_H #if defined(CONFIG_JUMP_LABEL) #include <linux/jump_label.h> #endif #include <linux/build_bug.h> /* * An instance of this structure is created in a special * ELF section at every dynamic debug callsite. At runtime, * the special section is treated as an array of these. */ struct _ddebug { … } __attribute__((aligned …)); enum class_map_type { … }; struct ddebug_class_map { … }; /** * DECLARE_DYNDBG_CLASSMAP - declare classnames known by a module * @_var: a struct ddebug_class_map, passed to module_param_cb * @_type: enum class_map_type, chooses bits/verbose, numeric/symbolic * @_base: offset of 1st class-name. splits .class_id space * @classes: class-names used to control class'd prdbgs */ #define DECLARE_DYNDBG_CLASSMAP(_var, _maptype, _base, ...) … #define NUM_TYPE_ARGS(eltype, ...) … /* encapsulate linker provided built-in (or module) dyndbg data */ struct _ddebug_info { … }; struct ddebug_class_param { … }; /* * pr_debug() and friends are globally enabled or modules have selectively * enabled them. */ #if defined(CONFIG_DYNAMIC_DEBUG) || \ (defined(CONFIG_DYNAMIC_DEBUG_CORE) && defined(DYNAMIC_DEBUG_MODULE)) extern __printf(2, 3) void __dynamic_pr_debug(struct _ddebug *descriptor, const char *fmt, ...); struct device; extern __printf(3, 4) void __dynamic_dev_dbg(struct _ddebug *descriptor, const struct device *dev, const char *fmt, ...); struct net_device; extern __printf(3, 4) void __dynamic_netdev_dbg(struct _ddebug *descriptor, const struct net_device *dev, const char *fmt, ...); struct ib_device; extern __printf(3, 4) void __dynamic_ibdev_dbg(struct _ddebug *descriptor, const struct ib_device *ibdev, const char *fmt, ...); #define DEFINE_DYNAMIC_DEBUG_METADATA_CLS(name, cls, fmt) … #define DEFINE_DYNAMIC_DEBUG_METADATA(name, fmt) … #ifdef CONFIG_JUMP_LABEL #ifdef DEBUG #define _DPRINTK_KEY_INIT … #define DYNAMIC_DEBUG_BRANCH … #else #define _DPRINTK_KEY_INIT … #define DYNAMIC_DEBUG_BRANCH(descriptor) … #endif #else /* !CONFIG_JUMP_LABEL */ #define _DPRINTK_KEY_INIT #ifdef DEBUG #define DYNAMIC_DEBUG_BRANCH … #else #define DYNAMIC_DEBUG_BRANCH … #endif #endif /* CONFIG_JUMP_LABEL */ /* * Factory macros: ($prefix)dynamic_func_call($suffix) * * Lower layer (with __ prefix) gets the callsite metadata, and wraps * the func inside a debug-branch/static-key construct. Upper layer * (with _ prefix) does the UNIQUE_ID once, so that lower can ref the * name/label multiple times, and tie the elements together. * Multiple flavors: * (|_cls): adds in _DPRINT_CLASS_DFLT as needed * (|_no_desc): former gets callsite descriptor as 1st arg (for prdbgs) */ #define __dynamic_func_call_cls(id, cls, fmt, func, ...) … #define __dynamic_func_call(id, fmt, func, ...) … #define __dynamic_func_call_cls_no_desc(id, cls, fmt, func, ...) … #define __dynamic_func_call_no_desc(id, fmt, func, ...) … /* * "Factory macro" for generating a call to func, guarded by a * DYNAMIC_DEBUG_BRANCH. The dynamic debug descriptor will be * initialized using the fmt argument. The function will be called with * the address of the descriptor as first argument, followed by all * the varargs. Note that fmt is repeated in invocations of this * macro. */ #define _dynamic_func_call_cls(cls, fmt, func, ...) … #define _dynamic_func_call(fmt, func, ...) … /* * A variant that does the same, except that the descriptor is not * passed as the first argument to the function; it is only called * with precisely the macro's varargs. */ #define _dynamic_func_call_cls_no_desc(cls, fmt, func, ...) … #define _dynamic_func_call_no_desc(fmt, func, ...) … #define dynamic_pr_debug_cls(cls, fmt, ...) … #define dynamic_pr_debug(fmt, ...) … #define dynamic_dev_dbg(dev, fmt, ...) … #define dynamic_netdev_dbg(dev, fmt, ...) … #define dynamic_ibdev_dbg(dev, fmt, ...) … #define dynamic_hex_dump(prefix_str, prefix_type, rowsize, \ groupsize, buf, len, ascii) … /* for test only, generally expect drm.debug style macro wrappers */ #define __pr_debug_cls(cls, fmt, ...) … #else /* !(CONFIG_DYNAMIC_DEBUG || (CONFIG_DYNAMIC_DEBUG_CORE && DYNAMIC_DEBUG_MODULE)) */ #include <linux/string.h> #include <linux/errno.h> #include <linux/printk.h> #define DEFINE_DYNAMIC_DEBUG_METADATA … #define DYNAMIC_DEBUG_BRANCH … #define dynamic_pr_debug … #define dynamic_dev_dbg … #define dynamic_hex_dump … #endif /* CONFIG_DYNAMIC_DEBUG || (CONFIG_DYNAMIC_DEBUG_CORE && DYNAMIC_DEBUG_MODULE) */ #ifdef CONFIG_DYNAMIC_DEBUG_CORE extern int ddebug_dyndbg_module_param_cb(char *param, char *val, const char *modname); struct kernel_param; int param_set_dyndbg_classes(const char *instr, const struct kernel_param *kp); int param_get_dyndbg_classes(char *buffer, const struct kernel_param *kp); #else static inline int ddebug_dyndbg_module_param_cb(char *param, char *val, const char *modname) { if (!strcmp(param, "dyndbg")) { /* avoid pr_warn(), which wants pr_fmt() fully defined */ printk(KERN_WARNING "dyndbg param is supported only in " "CONFIG_DYNAMIC_DEBUG builds\n"); return 0; /* allow and ignore */ } return -EINVAL; } struct kernel_param; static inline int param_set_dyndbg_classes(const char *instr, const struct kernel_param *kp) { return 0; } static inline int param_get_dyndbg_classes(char *buffer, const struct kernel_param *kp) { return 0; } #endif extern const struct kernel_param_ops param_ops_dyndbg_classes; #endif /* _DYNAMIC_DEBUG_H */
Codebase Browser
linux