blob: 2fe93b26b42fa71aa741689cf174cfbc86d1d781 [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 /*
Jim Cromie3faa2862012-04-27 14:30:33 -060020 * 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 Assche8ba6ebf52011-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
Jim Cromieb48420c2012-04-27 14:30:35 -060047extern int ddebug_dyndbg_module_param_cb(char *param, char *val,
48 const char *modname);
49
Joe Perchescbc46632011-08-11 14:36:21 -040050struct device;
51
Joe Perchesb9075fa2011-10-31 17:11:33 -070052extern __printf(3, 4)
53int __dynamic_dev_dbg(struct _ddebug *descriptor, const struct device *dev,
54 const char *fmt, ...);
Joe Perchescbc46632011-08-11 14:36:21 -040055
Jason Baronffa10cb2011-08-11 14:36:48 -040056struct net_device;
57
Joe Perchesb9075fa2011-10-31 17:11:33 -070058extern __printf(3, 4)
59int __dynamic_netdev_dbg(struct _ddebug *descriptor,
60 const struct net_device *dev,
61 const char *fmt, ...);
Jason Baronffa10cb2011-08-11 14:36:48 -040062
Jason Baron07613b02011-10-04 14:13:15 -070063#define DEFINE_DYNAMIC_DEBUG_METADATA(name, fmt) \
Joe Perchesc0d2af62012-10-18 12:07:03 -070064 static struct _ddebug __aligned(8) \
Jason Baron07613b02011-10-04 14:13:15 -070065 __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, \
Jason Baron07613b02011-10-04 14:13:15 -070072 }
Jason Barone9d376f2009-02-05 11:51:38 -050073
Jason Baron07613b02011-10-04 14:13:15 -070074#define dynamic_pr_debug(fmt, ...) \
75do { \
76 DEFINE_DYNAMIC_DEBUG_METADATA(descriptor, fmt); \
Jim Cromie87e6f962011-12-19 17:11:13 -050077 if (unlikely(descriptor.flags & _DPRINTK_FLAGS_PRINT)) \
Jason Baron07613b02011-10-04 14:13:15 -070078 __dynamic_pr_debug(&descriptor, pr_fmt(fmt), \
79 ##__VA_ARGS__); \
80} while (0)
Jason Barone9d376f2009-02-05 11:51:38 -050081
Jason Baron07613b02011-10-04 14:13:15 -070082#define dynamic_dev_dbg(dev, fmt, ...) \
83do { \
Jim Cromie87e6f962011-12-19 17:11:13 -050084 DEFINE_DYNAMIC_DEBUG_METADATA(descriptor, fmt); \
85 if (unlikely(descriptor.flags & _DPRINTK_FLAGS_PRINT)) \
Jason Baron07613b02011-10-04 14:13:15 -070086 __dynamic_dev_dbg(&descriptor, dev, fmt, \
87 ##__VA_ARGS__); \
88} while (0)
89
90#define dynamic_netdev_dbg(dev, fmt, ...) \
91do { \
92 DEFINE_DYNAMIC_DEBUG_METADATA(descriptor, fmt); \
Jim Cromie87e6f962011-12-19 17:11:13 -050093 if (unlikely(descriptor.flags & _DPRINTK_FLAGS_PRINT)) \
Jason Baron07613b02011-10-04 14:13:15 -070094 __dynamic_netdev_dbg(&descriptor, dev, fmt, \
95 ##__VA_ARGS__); \
96} while (0)
Jason Baronffa10cb2011-08-11 14:36:48 -040097
Vladimir Kondratiev7a555612012-12-05 16:48:27 -050098#define dynamic_hex_dump(prefix_str, prefix_type, rowsize, \
99 groupsize, buf, len, ascii) \
100do { \
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
Jason Barone9d376f2009-02-05 11:51:38 -0500109#else
110
Jim Cromieb48420c2012-04-27 14:30:35 -0600111#include <linux/string.h>
112#include <linux/errno.h>
113
Yehuda Sadehff49d742010-07-03 13:07:35 +1000114static inline int ddebug_remove_module(const char *mod)
Jason Barone9d376f2009-02-05 11:51:38 -0500115{
116 return 0;
117}
118
Jim Cromieb48420c2012-04-27 14:30:35 -0600119static inline int ddebug_dyndbg_module_param_cb(char *param, char *val,
120 const char *modname)
121{
122 if (strstr(param, "dyndbg")) {
Jim Cromie516cf1b2012-05-01 05:23:12 -0600123 /* avoid pr_warn(), which wants pr_fmt() fully defined */
124 printk(KERN_WARNING "dyndbg param is supported only in "
Jim Cromieb48420c2012-04-27 14:30:35 -0600125 "CONFIG_DYNAMIC_DEBUG builds\n");
126 return 0; /* allow and ignore */
127 }
128 return -EINVAL;
129}
130
Joe Perches00b55862009-12-14 18:00:14 -0800131#define dynamic_pr_debug(fmt, ...) \
132 do { if (0) printk(KERN_DEBUG pr_fmt(fmt), ##__VA_ARGS__); } while (0)
Philipp Reisnerbe70e262010-10-14 11:58:20 +0200133#define dynamic_dev_dbg(dev, fmt, ...) \
Joe Perches00b55862009-12-14 18:00:14 -0800134 do { if (0) dev_printk(KERN_DEBUG, dev, fmt, ##__VA_ARGS__); } while (0)
Jason Barone9d376f2009-02-05 11:51:38 -0500135#endif
136
137#endif