blob: bdf15319944e7a64a509e73912b1b9d8dcd6f530 [file] [log] [blame]
Jason Barone9d376f2009-02-05 11:51:38 -05001#ifndef _DYNAMIC_DEBUG_H
2#define _DYNAMIC_DEBUG_H
3
4/* dynamic_printk_enabled, and dynamic_printk_enabled2 are bitmasks in which
5 * bit n is set to 1 if any modname hashes into the bucket n, 0 otherwise. They
6 * use independent hash functions, to reduce the chance of false positives.
7 */
8extern long long dynamic_debug_enabled;
9extern long long dynamic_debug_enabled2;
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 */
16struct _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;
Jason Barone9d376f2009-02-05 11:51:38 -050025 unsigned int lineno:24;
26 /*
27 * The flags field controls the behaviour at the callsite.
28 * The bits here are changed dynamically when the user
Florian Ragwitz2b2f68b2010-05-24 14:33:21 -070029 * writes commands to <debugfs>/dynamic_debug/control
Jason Barone9d376f2009-02-05 11:51:38 -050030 */
31#define _DPRINTK_FLAGS_PRINT (1<<0) /* printk() a message using the format */
Bart Van Assche8ba6ebf52011-01-23 17:17:24 +010032#define _DPRINTK_FLAGS_INCL_MODNAME (1<<1)
33#define _DPRINTK_FLAGS_INCL_FUNCNAME (1<<2)
34#define _DPRINTK_FLAGS_INCL_LINENO (1<<3)
35#define _DPRINTK_FLAGS_INCL_TID (1<<4)
Jason Barone9d376f2009-02-05 11:51:38 -050036#define _DPRINTK_FLAGS_DEFAULT 0
37 unsigned int flags:8;
Jason Baron52159d92010-09-17 11:09:17 -040038 char enabled;
Jason Barone9d376f2009-02-05 11:51:38 -050039} __attribute__((aligned(8)));
40
41
42int ddebug_add_module(struct _ddebug *tab, unsigned int n,
43 const char *modname);
44
45#if defined(CONFIG_DYNAMIC_DEBUG)
Yehuda Sadehff49d742010-07-03 13:07:35 +100046extern int ddebug_remove_module(const char *mod_name);
Bart Van Assche8ba6ebf52011-01-23 17:17:24 +010047extern int __dynamic_pr_debug(struct _ddebug *descriptor, const char *fmt, ...)
48 __attribute__ ((format (printf, 2, 3)));
Jason Barone9d376f2009-02-05 11:51:38 -050049
Joe Perchescbc46632011-08-11 14:36:21 -040050struct device;
51
52extern int __dynamic_dev_dbg(struct _ddebug *descriptor,
53 const struct device *dev,
54 const char *fmt, ...)
55 __attribute__ ((format (printf, 3, 4)));
56
Jason Barone9d376f2009-02-05 11:51:38 -050057#define dynamic_pr_debug(fmt, ...) do { \
58 static struct _ddebug descriptor \
59 __used \
60 __attribute__((section("__verbose"), aligned(8))) = \
Jason Baron52159d92010-09-17 11:09:17 -040061 { KBUILD_MODNAME, __func__, __FILE__, fmt, __LINE__, \
62 _DPRINTK_FLAGS_DEFAULT }; \
Jason Baron2d75af22011-01-07 13:36:58 -050063 if (unlikely(descriptor.enabled)) \
Bart Van Assche8ba6ebf52011-01-23 17:17:24 +010064 __dynamic_pr_debug(&descriptor, pr_fmt(fmt), ##__VA_ARGS__); \
Jason Barone9d376f2009-02-05 11:51:38 -050065 } while (0)
66
Jason Barone9d376f2009-02-05 11:51:38 -050067#define dynamic_dev_dbg(dev, fmt, ...) do { \
68 static struct _ddebug descriptor \
69 __used \
70 __attribute__((section("__verbose"), aligned(8))) = \
Jason Baron52159d92010-09-17 11:09:17 -040071 { KBUILD_MODNAME, __func__, __FILE__, fmt, __LINE__, \
72 _DPRINTK_FLAGS_DEFAULT }; \
Jason Baron2d75af22011-01-07 13:36:58 -050073 if (unlikely(descriptor.enabled)) \
Joe Perchescbc46632011-08-11 14:36:21 -040074 __dynamic_dev_dbg(&descriptor, dev, fmt, ##__VA_ARGS__); \
Jason Barone9d376f2009-02-05 11:51:38 -050075 } while (0)
76
77#else
78
Yehuda Sadehff49d742010-07-03 13:07:35 +100079static inline int ddebug_remove_module(const char *mod)
Jason Barone9d376f2009-02-05 11:51:38 -050080{
81 return 0;
82}
83
Joe Perches00b558642009-12-14 18:00:14 -080084#define dynamic_pr_debug(fmt, ...) \
85 do { if (0) printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__); } while (0)
Philipp Reisnerbe70e262010-10-14 11:58:20 +020086#define dynamic_dev_dbg(dev, fmt, ...) \
Joe Perches00b558642009-12-14 18:00:14 -080087 do { if (0) dev_printk(KERN_DEBUG, dev, fmt, ##__VA_ARGS__); } while (0)
Jason Barone9d376f2009-02-05 11:51:38 -050088#endif
89
90#endif