Commit | Line | Data |
---|---|---|
e9d376f0 JB |
1 | #ifndef _DYNAMIC_DEBUG_H |
2 | #define _DYNAMIC_DEBUG_H | |
3 | ||
e9d376f0 JB |
4 | /* |
5 | * An instance of this structure is created in a special | |
6 | * ELF section at every dynamic debug callsite. At runtime, | |
7 | * the special section is treated as an array of these. | |
8 | */ | |
9 | struct _ddebug { | |
10 | /* | |
11 | * These fields are used to drive the user interface | |
12 | * for selecting and displaying debug callsites. | |
13 | */ | |
14 | const char *modname; | |
15 | const char *function; | |
16 | const char *filename; | |
17 | const char *format; | |
e703ddae | 18 | unsigned int lineno:18; |
e9d376f0 | 19 | /* |
3faa2860 JC |
20 | * The flags field controls the behaviour at the callsite. |
21 | * The bits here are changed dynamically when the user | |
2b2f68b5 | 22 | * writes commands to <debugfs>/dynamic_debug/control |
e9d376f0 | 23 | */ |
5ca7d2a6 JC |
24 | #define _DPRINTK_FLAGS_NONE 0 |
25 | #define _DPRINTK_FLAGS_PRINT (1<<0) /* printk() a message using the format */ | |
8ba6ebf5 BVA |
26 | #define _DPRINTK_FLAGS_INCL_MODNAME (1<<1) |
27 | #define _DPRINTK_FLAGS_INCL_FUNCNAME (1<<2) | |
28 | #define _DPRINTK_FLAGS_INCL_LINENO (1<<3) | |
29 | #define _DPRINTK_FLAGS_INCL_TID (1<<4) | |
b558c96f JC |
30 | #if defined DEBUG |
31 | #define _DPRINTK_FLAGS_DEFAULT _DPRINTK_FLAGS_PRINT | |
32 | #else | |
e9d376f0 | 33 | #define _DPRINTK_FLAGS_DEFAULT 0 |
b558c96f | 34 | #endif |
e9d376f0 JB |
35 | unsigned int flags:8; |
36 | } __attribute__((aligned(8))); | |
37 | ||
38 | ||
39 | int ddebug_add_module(struct _ddebug *tab, unsigned int n, | |
40 | const char *modname); | |
41 | ||
42 | #if defined(CONFIG_DYNAMIC_DEBUG) | |
ff49d74a | 43 | extern int ddebug_remove_module(const char *mod_name); |
b9075fa9 JP |
44 | extern __printf(2, 3) |
45 | int __dynamic_pr_debug(struct _ddebug *descriptor, const char *fmt, ...); | |
e9d376f0 | 46 | |
b48420c1 JC |
47 | extern int ddebug_dyndbg_module_param_cb(char *param, char *val, |
48 | const char *modname); | |
49 | ||
cbc46635 JP |
50 | struct device; |
51 | ||
b9075fa9 JP |
52 | extern __printf(3, 4) |
53 | int __dynamic_dev_dbg(struct _ddebug *descriptor, const struct device *dev, | |
54 | const char *fmt, ...); | |
cbc46635 | 55 | |
ffa10cb4 JB |
56 | struct net_device; |
57 | ||
b9075fa9 JP |
58 | extern __printf(3, 4) |
59 | int __dynamic_netdev_dbg(struct _ddebug *descriptor, | |
60 | const struct net_device *dev, | |
61 | const char *fmt, ...); | |
ffa10cb4 | 62 | |
07613b0b | 63 | #define DEFINE_DYNAMIC_DEBUG_METADATA(name, fmt) \ |
c0d2af63 | 64 | static struct _ddebug __aligned(8) \ |
07613b0b JB |
65 | __attribute__((section("__verbose"))) name = { \ |
66 | .modname = KBUILD_MODNAME, \ | |
67 | .function = __func__, \ | |
68 | .filename = __FILE__, \ | |
69 | .format = (fmt), \ | |
70 | .lineno = __LINE__, \ | |
71 | .flags = _DPRINTK_FLAGS_DEFAULT, \ | |
07613b0b JB |
72 | } |
73 | ||
74 | #define dynamic_pr_debug(fmt, ...) \ | |
75 | do { \ | |
76 | DEFINE_DYNAMIC_DEBUG_METADATA(descriptor, fmt); \ | |
87e6f968 | 77 | if (unlikely(descriptor.flags & _DPRINTK_FLAGS_PRINT)) \ |
07613b0b JB |
78 | __dynamic_pr_debug(&descriptor, pr_fmt(fmt), \ |
79 | ##__VA_ARGS__); \ | |
80 | } while (0) | |
81 | ||
82 | #define dynamic_dev_dbg(dev, fmt, ...) \ | |
83 | do { \ | |
87e6f968 JC |
84 | DEFINE_DYNAMIC_DEBUG_METADATA(descriptor, fmt); \ |
85 | if (unlikely(descriptor.flags & _DPRINTK_FLAGS_PRINT)) \ | |
07613b0b JB |
86 | __dynamic_dev_dbg(&descriptor, dev, fmt, \ |
87 | ##__VA_ARGS__); \ | |
88 | } while (0) | |
89 | ||
90 | #define dynamic_netdev_dbg(dev, fmt, ...) \ | |
91 | do { \ | |
92 | DEFINE_DYNAMIC_DEBUG_METADATA(descriptor, fmt); \ | |
87e6f968 | 93 | if (unlikely(descriptor.flags & _DPRINTK_FLAGS_PRINT)) \ |
07613b0b JB |
94 | __dynamic_netdev_dbg(&descriptor, dev, fmt, \ |
95 | ##__VA_ARGS__); \ | |
96 | } while (0) | |
ffa10cb4 | 97 | |
7a555613 VK |
98 | #define dynamic_hex_dump(prefix_str, prefix_type, rowsize, \ |
99 | groupsize, buf, len, ascii) \ | |
100 | do { \ | |
101 | DEFINE_DYNAMIC_DEBUG_METADATA(descriptor, \ | |
102 | __builtin_constant_p(prefix_str) ? prefix_str : "hexdump");\ | |
103 | if (unlikely(descriptor.flags & _DPRINTK_FLAGS_PRINT)) \ | |
104 | print_hex_dump(KERN_DEBUG, prefix_str, \ | |
105 | prefix_type, rowsize, groupsize, \ | |
106 | buf, len, ascii); \ | |
107 | } while (0) | |
108 | ||
e9d376f0 JB |
109 | #else |
110 | ||
b48420c1 JC |
111 | #include <linux/string.h> |
112 | #include <linux/errno.h> | |
113 | ||
ff49d74a | 114 | static inline int ddebug_remove_module(const char *mod) |
e9d376f0 JB |
115 | { |
116 | return 0; | |
117 | } | |
118 | ||
b48420c1 JC |
119 | static inline int ddebug_dyndbg_module_param_cb(char *param, char *val, |
120 | const char *modname) | |
121 | { | |
122 | if (strstr(param, "dyndbg")) { | |
516cf1be JC |
123 | /* avoid pr_warn(), which wants pr_fmt() fully defined */ |
124 | printk(KERN_WARNING "dyndbg param is supported only in " | |
b48420c1 JC |
125 | "CONFIG_DYNAMIC_DEBUG builds\n"); |
126 | return 0; /* allow and ignore */ | |
127 | } | |
128 | return -EINVAL; | |
129 | } | |
130 | ||
00b55864 JP |
131 | #define dynamic_pr_debug(fmt, ...) \ |
132 | do { if (0) printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__); } while (0) | |
be70e267 | 133 | #define dynamic_dev_dbg(dev, fmt, ...) \ |
00b55864 | 134 | do { if (0) dev_printk(KERN_DEBUG, dev, fmt, ##__VA_ARGS__); } while (0) |
e9d376f0 JB |
135 | #endif |
136 | ||
137 | #endif |