include/linux/dynamic_debug.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 #ifndef _DYNAMIC_DEBUG_H
   3 #define _DYNAMIC_DEBUG_H
   4
   5 #if defined(CONFIG_JUMP_LABEL)
   6 #include <linux/jump_label.h>
   7 #endif
   8
   9 #include <linux/build_bug.h>
  10
  11 /*
  12  * An instance of this structure is created in a special
  13  * ELF section at every dynamic debug callsite.  At runtime,
  14  * the special section is treated as an array of these.
  15  */
  16 struct _ddebug {
  17         /*
  18          * These fields are used to drive the user interface
  19          * for selecting and displaying debug callsites.
  20          */
  21         const char *modname;
  22         const char *function;
  23         const char *filename;
  24         const char *format;
  25         unsigned int lineno:18;
  26 #define CLS_BITS 6
  27         unsigned int class_id:CLS_BITS;
  28 #define _DPRINTK_CLASS_DFLT             ((1 << CLS_BITS) - 1)
  29         /*
  30          * The flags field controls the behaviour at the callsite.
  31          * The bits here are changed dynamically when the user
  32          * writes commands to <debugfs>/dynamic_debug/control
  33          */
  34 #define _DPRINTK_FLAGS_NONE     0
  35 #define _DPRINTK_FLAGS_PRINT    (1<<0) /* printk() a message using the format */
  36 #define _DPRINTK_FLAGS_INCL_MODNAME     (1<<1)
  37 #define _DPRINTK_FLAGS_INCL_FUNCNAME    (1<<2)
  38 #define _DPRINTK_FLAGS_INCL_LINENO      (1<<3)
  39 #define _DPRINTK_FLAGS_INCL_TID         (1<<4)
  40
  41 #define _DPRINTK_FLAGS_INCL_ANY         \
  42         (_DPRINTK_FLAGS_INCL_MODNAME | _DPRINTK_FLAGS_INCL_FUNCNAME |\
  43          _DPRINTK_FLAGS_INCL_LINENO  | _DPRINTK_FLAGS_INCL_TID)
  44
  45 #if defined DEBUG
  46 #define _DPRINTK_FLAGS_DEFAULT _DPRINTK_FLAGS_PRINT
  47 #else
  48 #define _DPRINTK_FLAGS_DEFAULT 0
  49 #endif
  50         unsigned int flags:8;
  51 #ifdef CONFIG_JUMP_LABEL
  52         union {
  53                 struct static_key_true dd_key_true;
  54                 struct static_key_false dd_key_false;
  55         } key;
  56 #endif
  57 } __attribute__((aligned(8)));
  58
  59 enum class_map_type {
  60         DD_CLASS_TYPE_DISJOINT_BITS,
  61         /**
  62          * DD_CLASS_TYPE_DISJOINT_BITS: classes are independent, one per bit.
  63          * expecting hex input. Built for drm.debug, basis for other types.
  64          */
  65         DD_CLASS_TYPE_LEVEL_NUM,
  66         /**
  67          * DD_CLASS_TYPE_LEVEL_NUM: input is numeric level, 0-N.
  68          * N turns on just bits N-1 .. 0, so N=0 turns all bits off.
  69          */
  70         DD_CLASS_TYPE_DISJOINT_NAMES,
  71         /**
  72          * DD_CLASS_TYPE_DISJOINT_NAMES: input is a CSV of [+-]CLASS_NAMES,
  73          * classes are independent, like _DISJOINT_BITS.
  74          */
  75         DD_CLASS_TYPE_LEVEL_NAMES,
  76         /**
  77          * DD_CLASS_TYPE_LEVEL_NAMES: input is a CSV of [+-]CLASS_NAMES,
  78          * intended for names like: INFO,DEBUG,TRACE, with a module prefix
  79          * avoid EMERG,ALERT,CRIT,ERR,WARNING: they're not debug
  80          */
  81 };
  82
  83 struct ddebug_class_map {
  84         struct list_head link;
  85         struct module *mod;
  86         const char *mod_name;   /* needed for builtins */
  87         const char **class_names;
  88         const int length;
  89         const int base;         /* index of 1st .class_id, allows split/shared space */
  90         enum class_map_type map_type;
  91 };
  92
  93 /**
  94  * DECLARE_DYNDBG_CLASSMAP - declare classnames known by a module
  95  * @_var:   a struct ddebug_class_map, passed to module_param_cb
  96  * @_type:  enum class_map_type, chooses bits/verbose, numeric/symbolic
  97  * @_base:  offset of 1st class-name. splits .class_id space
  98  * @classes: class-names used to control class'd prdbgs
  99  */
 100 #define DECLARE_DYNDBG_CLASSMAP(_var, _maptype, _base, ...)             \
 101         static const char *_var##_classnames[] = { __VA_ARGS__ };       \
 102         static struct ddebug_class_map __aligned(8) __used              \
 103                 __section("__dyndbg_classes") _var = {                  \
 104                 .mod = THIS_MODULE,                                     \
 105                 .mod_name = KBUILD_MODNAME,                             \
 106                 .base = _base,                                          \
 107                 .map_type = _maptype,                                   \
 108                 .length = NUM_TYPE_ARGS(char*, __VA_ARGS__),            \
 109                 .class_names = _var##_classnames,                       \
 110         }
 111 #define NUM_TYPE_ARGS(eltype, ...)                              \
 112         (sizeof((eltype[]){__VA_ARGS__}) / sizeof(eltype))
 113
 114 /* encapsulate linker provided built-in (or module) dyndbg data */
 115 struct _ddebug_info {
 116         struct _ddebug *descs;
 117         unsigned int num_descs;
 118 };
 119
 120 #if defined(CONFIG_DYNAMIC_DEBUG_CORE)
 121
 122 int ddebug_add_module(struct _ddebug_info *dyndbg, const char *modname);
 123
 124 extern int ddebug_remove_module(const char *mod_name);
 125 extern __printf(2, 3)
 126 void __dynamic_pr_debug(struct _ddebug *descriptor, const char *fmt, ...);
 127
 128 extern int ddebug_dyndbg_module_param_cb(char *param, char *val,
 129                                         const char *modname);
 130
 131 struct device;
 132
 133 extern __printf(3, 4)
 134 void __dynamic_dev_dbg(struct _ddebug *descriptor, const struct device *dev,
 135                        const char *fmt, ...);
 136
 137 struct net_device;
 138
 139 extern __printf(3, 4)
 140 void __dynamic_netdev_dbg(struct _ddebug *descriptor,
 141                           const struct net_device *dev,
 142                           const char *fmt, ...);
 143
 144 struct ib_device;
 145
 146 extern __printf(3, 4)
 147 void __dynamic_ibdev_dbg(struct _ddebug *descriptor,
 148                          const struct ib_device *ibdev,
 149                          const char *fmt, ...);
 150
 151 #define DEFINE_DYNAMIC_DEBUG_METADATA_CLS(name, cls, fmt)       \
 152         static struct _ddebug  __aligned(8)                     \
 153         __section("__dyndbg") name = {                          \
 154                 .modname = KBUILD_MODNAME,                      \
 155                 .function = __func__,                           \
 156                 .filename = __FILE__,                           \
 157                 .format = (fmt),                                \
 158                 .lineno = __LINE__,                             \
 159                 .flags = _DPRINTK_FLAGS_DEFAULT,                \
 160                 .class_id = cls,                                \
 161                 _DPRINTK_KEY_INIT                               \
 162         };                                                      \
 163         BUILD_BUG_ON_MSG(cls > _DPRINTK_CLASS_DFLT,             \
 164                          "classid value overflow")
 165
 166 #define DEFINE_DYNAMIC_DEBUG_METADATA(name, fmt)                \
 167         DEFINE_DYNAMIC_DEBUG_METADATA_CLS(name, _DPRINTK_CLASS_DFLT, fmt)
 168
 169 #ifdef CONFIG_JUMP_LABEL
 170
 171 #ifdef DEBUG
 172
 173 #define _DPRINTK_KEY_INIT .key.dd_key_true = (STATIC_KEY_TRUE_INIT)
 174
 175 #define DYNAMIC_DEBUG_BRANCH(descriptor) \
 176         static_branch_likely(&descriptor.key.dd_key_true)
 177 #else
 178 #define _DPRINTK_KEY_INIT .key.dd_key_false = (STATIC_KEY_FALSE_INIT)
 179
 180 #define DYNAMIC_DEBUG_BRANCH(descriptor) \
 181         static_branch_unlikely(&descriptor.key.dd_key_false)
 182 #endif
 183
 184 #else /* !CONFIG_JUMP_LABEL */
 185
 186 #define _DPRINTK_KEY_INIT
 187
 188 #ifdef DEBUG
 189 #define DYNAMIC_DEBUG_BRANCH(descriptor) \
 190         likely(descriptor.flags & _DPRINTK_FLAGS_PRINT)
 191 #else
 192 #define DYNAMIC_DEBUG_BRANCH(descriptor) \
 193         unlikely(descriptor.flags & _DPRINTK_FLAGS_PRINT)
 194 #endif
 195
 196 #endif /* CONFIG_JUMP_LABEL */
 197
 198 /*
 199  * Factory macros: ($prefix)dynamic_func_call($suffix)
 200  *
 201  * Lower layer (with __ prefix) gets the callsite metadata, and wraps
 202  * the func inside a debug-branch/static-key construct.  Upper layer
 203  * (with _ prefix) does the UNIQUE_ID once, so that lower can ref the
 204  * name/label multiple times, and tie the elements together.
 205  * Multiple flavors:
 206  * (|_cls):     adds in _DPRINT_CLASS_DFLT as needed
 207  * (|_no_desc): former gets callsite descriptor as 1st arg (for prdbgs)
 208  */
 209 #define __dynamic_func_call_cls(id, cls, fmt, func, ...) do {   \
 210         DEFINE_DYNAMIC_DEBUG_METADATA_CLS(id, cls, fmt);        \
 211         if (DYNAMIC_DEBUG_BRANCH(id))                           \
 212                 func(&id, ##__VA_ARGS__);                       \
 213 } while (0)
 214 #define __dynamic_func_call(id, fmt, func, ...)                         \
 215         __dynamic_func_call_cls(id, _DPRINTK_CLASS_DFLT, fmt,           \
 216                                 func, ##__VA_ARGS__)
 217
 218 #define __dynamic_func_call_cls_no_desc(id, cls, fmt, func, ...) do {   \
 219         DEFINE_DYNAMIC_DEBUG_METADATA_CLS(id, cls, fmt);                \
 220         if (DYNAMIC_DEBUG_BRANCH(id))                                   \
 221                 func(__VA_ARGS__);                                      \
 222 } while (0)
 223 #define __dynamic_func_call_no_desc(id, fmt, func, ...)                 \
 224         __dynamic_func_call_cls_no_desc(id, _DPRINTK_CLASS_DFLT,        \
 225                                         fmt, func, ##__VA_ARGS__)
 226
 227 /*
 228  * "Factory macro" for generating a call to func, guarded by a
 229  * DYNAMIC_DEBUG_BRANCH. The dynamic debug descriptor will be
 230  * initialized using the fmt argument. The function will be called with
 231  * the address of the descriptor as first argument, followed by all
 232  * the varargs. Note that fmt is repeated in invocations of this
 233  * macro.
 234  */
 235 #define _dynamic_func_call_cls(cls, fmt, func, ...)                     \
 236         __dynamic_func_call_cls(__UNIQUE_ID(ddebug), cls, fmt, func, ##__VA_ARGS__)
 237 #define _dynamic_func_call(fmt, func, ...)                              \
 238         _dynamic_func_call_cls(_DPRINTK_CLASS_DFLT, fmt, func, ##__VA_ARGS__)
 239
 240 /*
 241  * A variant that does the same, except that the descriptor is not
 242  * passed as the first argument to the function; it is only called
 243  * with precisely the macro's varargs.
 244  */
 245 #define _dynamic_func_call_cls_no_desc(cls, fmt, func, ...)             \
 246         __dynamic_func_call_cls_no_desc(__UNIQUE_ID(ddebug), cls, fmt,  \
 247                                         func, ##__VA_ARGS__)
 248 #define _dynamic_func_call_no_desc(fmt, func, ...)                      \
 249         _dynamic_func_call_cls_no_desc(_DPRINTK_CLASS_DFLT, fmt,        \
 250                                        func, ##__VA_ARGS__)
 251
 252 #define dynamic_pr_debug_cls(cls, fmt, ...)                             \
 253         _dynamic_func_call_cls(cls, fmt, __dynamic_pr_debug,            \
 254                            pr_fmt(fmt), ##__VA_ARGS__)
 255
 256 #define dynamic_pr_debug(fmt, ...)                              \
 257         _dynamic_func_call(fmt, __dynamic_pr_debug,             \
 258                            pr_fmt(fmt), ##__VA_ARGS__)
 259
 260 #define dynamic_dev_dbg(dev, fmt, ...)                          \
 261         _dynamic_func_call(fmt, __dynamic_dev_dbg,              \
 262                            dev, fmt, ##__VA_ARGS__)
 263
 264 #define dynamic_netdev_dbg(dev, fmt, ...)                       \
 265         _dynamic_func_call(fmt, __dynamic_netdev_dbg,           \
 266                            dev, fmt, ##__VA_ARGS__)
 267
 268 #define dynamic_ibdev_dbg(dev, fmt, ...)                        \
 269         _dynamic_func_call(fmt, __dynamic_ibdev_dbg,            \
 270                            dev, fmt, ##__VA_ARGS__)
 271
 272 #define dynamic_hex_dump(prefix_str, prefix_type, rowsize,              \
 273                          groupsize, buf, len, ascii)                    \
 274         _dynamic_func_call_no_desc(__builtin_constant_p(prefix_str) ? prefix_str : "hexdump", \
 275                                    print_hex_dump,                      \
 276                                    KERN_DEBUG, prefix_str, prefix_type, \
 277                                    rowsize, groupsize, buf, len, ascii)
 278
 279 /* for test only, generally expect drm.debug style macro wrappers */
 280 #define __pr_debug_cls(cls, fmt, ...) do {                      \
 281         BUILD_BUG_ON_MSG(!__builtin_constant_p(cls),            \
 282                          "expecting constant class int/enum");  \
 283         dynamic_pr_debug_cls(cls, fmt, ##__VA_ARGS__);          \
 284         } while (0)
 285
 286 #else /* !CONFIG_DYNAMIC_DEBUG_CORE */
 287
 288 #include <linux/string.h>
 289 #include <linux/errno.h>
 290 #include <linux/printk.h>
 291
 292 static inline int ddebug_add_module(struct _ddebug_info *dinfo, const char *modname)
 293 {
 294         return 0;
 295 }
 296
 297 static inline int ddebug_remove_module(const char *mod)
 298 {
 299         return 0;
 300 }
 301
 302 static inline int ddebug_dyndbg_module_param_cb(char *param, char *val,
 303                                                 const char *modname)
 304 {
 305         if (!strcmp(param, "dyndbg")) {
 306                 /* avoid pr_warn(), which wants pr_fmt() fully defined */
 307                 printk(KERN_WARNING "dyndbg param is supported only in "
 308                         "CONFIG_DYNAMIC_DEBUG builds\n");
 309                 return 0; /* allow and ignore */
 310         }
 311         return -EINVAL;
 312 }
 313
 314 #define dynamic_pr_debug(fmt, ...)                                      \
 315         do { if (0) printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__); } while (0)
 316 #define dynamic_dev_dbg(dev, fmt, ...)                                  \
 317         do { if (0) dev_printk(KERN_DEBUG, dev, fmt, ##__VA_ARGS__); } while (0)
 318 #define dynamic_hex_dump(prefix_str, prefix_type, rowsize,              \
 319                          groupsize, buf, len, ascii)                    \
 320         do { if (0)                                                     \
 321                 print_hex_dump(KERN_DEBUG, prefix_str, prefix_type,     \
 322                                 rowsize, groupsize, buf, len, ascii);   \
 323         } while (0)
 324
 325 #endif /* !CONFIG_DYNAMIC_DEBUG_CORE */
 326
 327 #endif