blob: 29ea09ae30cf3887ee6c348f5085db984bb891cc [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 Assche8ba6ebf2011-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)
Jim Cromieb558c962011-12-19 17:11:18 -050029#if defined DEBUG
30#define _DPRINTK_FLAGS_DEFAULT _DPRINTK_FLAGS_PRINT
31#else
Jason Barone9d376f2009-02-05 11:51:38 -050032#define _DPRINTK_FLAGS_DEFAULT 0
Jim Cromieb558c962011-12-19 17:11:18 -050033#endif
Jason Barone9d376f2009-02-05 11:51:38 -050034 unsigned int flags:8;
35} __attribute__((aligned(8)));
36
37
38int ddebug_add_module(struct _ddebug *tab, unsigned int n,
39 const char *modname);
40
41#if defined(CONFIG_DYNAMIC_DEBUG)
Yehuda Sadehff49d742010-07-03 13:07:35 +100042extern int ddebug_remove_module(const char *mod_name);
Joe Perchesb9075fa2011-10-31 17:11:33 -070043extern __printf(2, 3)
44int __dynamic_pr_debug(struct _ddebug *descriptor, const char *fmt, ...);
Jason Barone9d376f2009-02-05 11:51:38 -050045
Joe Perchescbc46632011-08-11 14:36:21 -040046struct device;
47
Joe Perchesb9075fa2011-10-31 17:11:33 -070048extern __printf(3, 4)
49int __dynamic_dev_dbg(struct _ddebug *descriptor, const struct device *dev,
50 const char *fmt, ...);
Joe Perchescbc46632011-08-11 14:36:21 -040051
Jason Baronffa10cb2011-08-11 14:36:48 -040052struct net_device;
53
Joe Perchesb9075fa2011-10-31 17:11:33 -070054extern __printf(3, 4)
55int __dynamic_netdev_dbg(struct _ddebug *descriptor,
56 const struct net_device *dev,
57 const char *fmt, ...);
Jason Baronffa10cb2011-08-11 14:36:48 -040058
Jason Baron07613b02011-10-04 14:13:15 -070059#define DEFINE_DYNAMIC_DEBUG_METADATA(name, fmt) \
60 static struct _ddebug __used __aligned(8) \
61 __attribute__((section("__verbose"))) name = { \
62 .modname = KBUILD_MODNAME, \
63 .function = __func__, \
64 .filename = __FILE__, \
65 .format = (fmt), \
66 .lineno = __LINE__, \
67 .flags = _DPRINTK_FLAGS_DEFAULT, \
Jason Baron07613b02011-10-04 14:13:15 -070068 }
Jason Barone9d376f2009-02-05 11:51:38 -050069
Jason Baron07613b02011-10-04 14:13:15 -070070#define dynamic_pr_debug(fmt, ...) \
71do { \
72 DEFINE_DYNAMIC_DEBUG_METADATA(descriptor, fmt); \
Jim Cromie87e6f962011-12-19 17:11:13 -050073 if (unlikely(descriptor.flags & _DPRINTK_FLAGS_PRINT)) \
Jason Baron07613b02011-10-04 14:13:15 -070074 __dynamic_pr_debug(&descriptor, pr_fmt(fmt), \
75 ##__VA_ARGS__); \
76} while (0)
Jason Barone9d376f2009-02-05 11:51:38 -050077
Jason Baron07613b02011-10-04 14:13:15 -070078#define dynamic_dev_dbg(dev, fmt, ...) \
79do { \
Jim Cromie87e6f962011-12-19 17:11:13 -050080 DEFINE_DYNAMIC_DEBUG_METADATA(descriptor, fmt); \
81 if (unlikely(descriptor.flags & _DPRINTK_FLAGS_PRINT)) \
Jason Baron07613b02011-10-04 14:13:15 -070082 __dynamic_dev_dbg(&descriptor, dev, fmt, \
83 ##__VA_ARGS__); \
84} while (0)
85
86#define dynamic_netdev_dbg(dev, fmt, ...) \
87do { \
88 DEFINE_DYNAMIC_DEBUG_METADATA(descriptor, fmt); \
Jim Cromie87e6f962011-12-19 17:11:13 -050089 if (unlikely(descriptor.flags & _DPRINTK_FLAGS_PRINT)) \
Jason Baron07613b02011-10-04 14:13:15 -070090 __dynamic_netdev_dbg(&descriptor, dev, fmt, \
91 ##__VA_ARGS__); \
92} while (0)
Jason Baronffa10cb2011-08-11 14:36:48 -040093
Jason Barone9d376f2009-02-05 11:51:38 -050094#else
95
Yehuda Sadehff49d742010-07-03 13:07:35 +100096static inline int ddebug_remove_module(const char *mod)
Jason Barone9d376f2009-02-05 11:51:38 -050097{
98 return 0;
99}
100
Joe Perches00b55862009-12-14 18:00:14 -0800101#define dynamic_pr_debug(fmt, ...) \
102 do { if (0) printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__); } while (0)
Philipp Reisnerbe70e262010-10-14 11:58:20 +0200103#define dynamic_dev_dbg(dev, fmt, ...) \
Joe Perches00b55862009-12-14 18:00:14 -0800104 do { if (0) dev_printk(KERN_DEBUG, dev, fmt, ##__VA_ARGS__); } while (0)
Jason Barone9d376f2009-02-05 11:51:38 -0500105#endif
106
107#endif