blob: feaac1ee300178cbd70665bf04be04200cd2015b [file] [log] [blame]
Jason Barone9d376f2009-02-05 11:51:38 -05001#ifndef _DYNAMIC_DEBUG_H
2#define _DYNAMIC_DEBUG_H
3
Jason Barone9d376f2009-02-05 11:51:38 -05004/*
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 */
9struct _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;
Jason Barone9d376f2009-02-05 11:51:38 -050018 unsigned int lineno:24;
19 /*
20 * The flags field controls the behaviour at the callsite.
21 * The bits here are changed dynamically when the user
Florian Ragwitz2b2f68b2010-05-24 14:33:21 -070022 * writes commands to <debugfs>/dynamic_debug/control
Jason Barone9d376f2009-02-05 11:51:38 -050023 */
24#define _DPRINTK_FLAGS_PRINT (1<<0) /* printk() a message using the format */
Bart Van Assche8ba6ebf52011-01-23 17:17:24 +010025#define _DPRINTK_FLAGS_INCL_MODNAME (1<<1)
26#define _DPRINTK_FLAGS_INCL_FUNCNAME (1<<2)
27#define _DPRINTK_FLAGS_INCL_LINENO (1<<3)
28#define _DPRINTK_FLAGS_INCL_TID (1<<4)
Jason Barone9d376f2009-02-05 11:51:38 -050029#define _DPRINTK_FLAGS_DEFAULT 0
30 unsigned int flags:8;
Jason Baron52159d92010-09-17 11:09:17 -040031 char enabled;
Jason Barone9d376f2009-02-05 11:51:38 -050032} __attribute__((aligned(8)));
33
34
35int ddebug_add_module(struct _ddebug *tab, unsigned int n,
36 const char *modname);
37
38#if defined(CONFIG_DYNAMIC_DEBUG)
Yehuda Sadehff49d742010-07-03 13:07:35 +100039extern int ddebug_remove_module(const char *mod_name);
Bart Van Assche8ba6ebf52011-01-23 17:17:24 +010040extern int __dynamic_pr_debug(struct _ddebug *descriptor, const char *fmt, ...)
41 __attribute__ ((format (printf, 2, 3)));
Jason Barone9d376f2009-02-05 11:51:38 -050042
Joe Perchescbc46632011-08-11 14:36:21 -040043struct device;
44
45extern int __dynamic_dev_dbg(struct _ddebug *descriptor,
46 const struct device *dev,
47 const char *fmt, ...)
48 __attribute__ ((format (printf, 3, 4)));
49
Jason Baronffa10cb2011-08-11 14:36:48 -040050struct net_device;
51
52extern int __dynamic_netdev_dbg(struct _ddebug *descriptor,
53 const struct net_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
Jason Baronffa10cb2011-08-11 14:36:48 -040077#define dynamic_netdev_dbg(dev, fmt, ...) do { \
78 static struct _ddebug descriptor \
79 __used \
80 __attribute__((section("__verbose"), aligned(8))) = \
81 { KBUILD_MODNAME, __func__, __FILE__, fmt, __LINE__, \
82 _DPRINTK_FLAGS_DEFAULT }; \
83 if (unlikely(descriptor.enabled)) \
84 __dynamic_netdev_dbg(&descriptor, dev, fmt, ##__VA_ARGS__);\
85 } while (0)
86
Jason Barone9d376f2009-02-05 11:51:38 -050087#else
88
Yehuda Sadehff49d742010-07-03 13:07:35 +100089static inline int ddebug_remove_module(const char *mod)
Jason Barone9d376f2009-02-05 11:51:38 -050090{
91 return 0;
92}
93
Joe Perches00b558642009-12-14 18:00:14 -080094#define dynamic_pr_debug(fmt, ...) \
95 do { if (0) printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__); } while (0)
Philipp Reisnerbe70e262010-10-14 11:58:20 +020096#define dynamic_dev_dbg(dev, fmt, ...) \
Joe Perches00b558642009-12-14 18:00:14 -080097 do { if (0) dev_printk(KERN_DEBUG, dev, fmt, ##__VA_ARGS__); } while (0)
Jason Barone9d376f2009-02-05 11:51:38 -050098#endif
99
100#endif