blob: 7e3c53a900d8efe75796c8e35a9f14f91b1a8fd8 [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;
Jim Cromiee703ddae2011-12-19 17:12:59 -050018 unsigned int lineno:18;
Jason Barone9d376f2009-02-05 11:51:38 -050019 /*
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 */
Jim Cromie5ca7d2a2011-12-19 17:12:44 -050024#define _DPRINTK_FLAGS_NONE 0
25#define _DPRINTK_FLAGS_PRINT (1<<0) /* printk() a message using the format */
Bart Van Assche8ba6ebf2011-01-23 17:17:24 +010026#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)
Jim Cromieb558c962011-12-19 17:11:18 -050030#if defined DEBUG
31#define _DPRINTK_FLAGS_DEFAULT _DPRINTK_FLAGS_PRINT
32#else
Jason Barone9d376f2009-02-05 11:51:38 -050033#define _DPRINTK_FLAGS_DEFAULT 0
Jim Cromieb558c962011-12-19 17:11:18 -050034#endif
Jason Barone9d376f2009-02-05 11:51:38 -050035 unsigned int flags:8;
36} __attribute__((aligned(8)));
37
38
39int ddebug_add_module(struct _ddebug *tab, unsigned int n,
40 const char *modname);
41
42#if defined(CONFIG_DYNAMIC_DEBUG)
Yehuda Sadehff49d742010-07-03 13:07:35 +100043extern int ddebug_remove_module(const char *mod_name);
Joe Perchesb9075fa2011-10-31 17:11:33 -070044extern __printf(2, 3)
45int __dynamic_pr_debug(struct _ddebug *descriptor, const char *fmt, ...);
Jason Barone9d376f2009-02-05 11:51:38 -050046
Joe Perchescbc46632011-08-11 14:36:21 -040047struct device;
48
Joe Perchesb9075fa2011-10-31 17:11:33 -070049extern __printf(3, 4)
50int __dynamic_dev_dbg(struct _ddebug *descriptor, const struct device *dev,
51 const char *fmt, ...);
Joe Perchescbc46632011-08-11 14:36:21 -040052
Jason Baronffa10cb2011-08-11 14:36:48 -040053struct net_device;
54
Joe Perchesb9075fa2011-10-31 17:11:33 -070055extern __printf(3, 4)
56int __dynamic_netdev_dbg(struct _ddebug *descriptor,
57 const struct net_device *dev,
58 const char *fmt, ...);
Jason Baronffa10cb2011-08-11 14:36:48 -040059
Jason Baron07613b02011-10-04 14:13:15 -070060#define DEFINE_DYNAMIC_DEBUG_METADATA(name, fmt) \
61 static struct _ddebug __used __aligned(8) \
62 __attribute__((section("__verbose"))) name = { \
63 .modname = KBUILD_MODNAME, \
64 .function = __func__, \
65 .filename = __FILE__, \
66 .format = (fmt), \
67 .lineno = __LINE__, \
68 .flags = _DPRINTK_FLAGS_DEFAULT, \
Jason Baron07613b02011-10-04 14:13:15 -070069 }
Jason Barone9d376f2009-02-05 11:51:38 -050070
Jason Baron07613b02011-10-04 14:13:15 -070071#define dynamic_pr_debug(fmt, ...) \
72do { \
73 DEFINE_DYNAMIC_DEBUG_METADATA(descriptor, fmt); \
Jim Cromie87e6f962011-12-19 17:11:13 -050074 if (unlikely(descriptor.flags & _DPRINTK_FLAGS_PRINT)) \
Jason Baron07613b02011-10-04 14:13:15 -070075 __dynamic_pr_debug(&descriptor, pr_fmt(fmt), \
76 ##__VA_ARGS__); \
77} while (0)
Jason Barone9d376f2009-02-05 11:51:38 -050078
Jason Baron07613b02011-10-04 14:13:15 -070079#define dynamic_dev_dbg(dev, fmt, ...) \
80do { \
Jim Cromie87e6f962011-12-19 17:11:13 -050081 DEFINE_DYNAMIC_DEBUG_METADATA(descriptor, fmt); \
82 if (unlikely(descriptor.flags & _DPRINTK_FLAGS_PRINT)) \
Jason Baron07613b02011-10-04 14:13:15 -070083 __dynamic_dev_dbg(&descriptor, dev, fmt, \
84 ##__VA_ARGS__); \
85} while (0)
86
87#define dynamic_netdev_dbg(dev, fmt, ...) \
88do { \
89 DEFINE_DYNAMIC_DEBUG_METADATA(descriptor, fmt); \
Jim Cromie87e6f962011-12-19 17:11:13 -050090 if (unlikely(descriptor.flags & _DPRINTK_FLAGS_PRINT)) \
Jason Baron07613b02011-10-04 14:13:15 -070091 __dynamic_netdev_dbg(&descriptor, dev, fmt, \
92 ##__VA_ARGS__); \
93} while (0)
Jason Baronffa10cb2011-08-11 14:36:48 -040094
Jason Barone9d376f2009-02-05 11:51:38 -050095#else
96
Yehuda Sadehff49d742010-07-03 13:07:35 +100097static inline int ddebug_remove_module(const char *mod)
Jason Barone9d376f2009-02-05 11:51:38 -050098{
99 return 0;
100}
101
Joe Perches00b55862009-12-14 18:00:14 -0800102#define dynamic_pr_debug(fmt, ...) \
103 do { if (0) printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__); } while (0)
Philipp Reisnerbe70e262010-10-14 11:58:20 +0200104#define dynamic_dev_dbg(dev, fmt, ...) \
Joe Perches00b55862009-12-14 18:00:14 -0800105 do { if (0) dev_printk(KERN_DEBUG, dev, fmt, ##__VA_ARGS__); } while (0)
Jason Barone9d376f2009-02-05 11:51:38 -0500106#endif
107
108#endif