4 * make pr_debug()/dev_dbg() calls runtime configurable based upon their
7 * Copyright (C) 2008 Jason Baron <jbaron@redhat.com>
8 * By Greg Banks <gnb@melbourne.sgi.com>
9 * Copyright (c) 2008 Silicon Graphics Inc. All Rights Reserved.
10 * Copyright (C) 2011 Bart Van Assche. All Rights Reserved.
13 #include <linux/kernel.h>
14 #include <linux/module.h>
15 #include <linux/moduleparam.h>
16 #include <linux/kallsyms.h>
17 #include <linux/version.h>
18 #include <linux/types.h>
19 #include <linux/mutex.h>
20 #include <linux/proc_fs.h>
21 #include <linux/seq_file.h>
22 #include <linux/list.h>
23 #include <linux/sysctl.h>
24 #include <linux/ctype.h>
25 #include <linux/string.h>
26 #include <linux/uaccess.h>
27 #include <linux/dynamic_debug.h>
28 #include <linux/debugfs.h>
29 #include <linux/slab.h>
30 #include <linux/jump_label.h>
31 #include <linux/hardirq.h>
32 #include <linux/sched.h>
34 extern struct _ddebug __start___verbose
[];
35 extern struct _ddebug __stop___verbose
[];
38 struct list_head link
;
40 unsigned int num_ddebugs
;
41 unsigned int num_enabled
;
42 struct _ddebug
*ddebugs
;
50 unsigned int first_lineno
, last_lineno
;
54 struct ddebug_table
*table
;
58 static DEFINE_MUTEX(ddebug_lock
);
59 static LIST_HEAD(ddebug_tables
);
60 static int verbose
= 0;
62 /* Return the last part of a pathname */
63 static inline const char *basename(const char *path
)
65 const char *tail
= strrchr(path
, '/');
66 return tail
? tail
+1 : path
;
69 static struct { unsigned flag
:8; char opt_char
; } opt_array
[] = {
70 { _DPRINTK_FLAGS_PRINT
, 'p' },
71 { _DPRINTK_FLAGS_INCL_MODNAME
, 'm' },
72 { _DPRINTK_FLAGS_INCL_FUNCNAME
, 'f' },
73 { _DPRINTK_FLAGS_INCL_LINENO
, 'l' },
74 { _DPRINTK_FLAGS_INCL_TID
, 't' },
77 /* format a string into buf[] which describes the _ddebug's flags */
78 static char *ddebug_describe_flags(struct _ddebug
*dp
, char *buf
,
85 for (i
= 0; i
< ARRAY_SIZE(opt_array
); ++i
)
86 if (dp
->flags
& opt_array
[i
].flag
)
87 *p
++ = opt_array
[i
].opt_char
;
96 * Search the tables for _ddebug's which match the given
97 * `query' and apply the `flags' and `mask' to them. Tells
98 * the user which ddebug's were changed, or whether none
101 static void ddebug_change(const struct ddebug_query
*query
,
102 unsigned int flags
, unsigned int mask
)
105 struct ddebug_table
*dt
;
106 unsigned int newflags
;
107 unsigned int nfound
= 0;
110 /* search for matching ddebugs */
111 mutex_lock(&ddebug_lock
);
112 list_for_each_entry(dt
, &ddebug_tables
, link
) {
114 /* match against the module name */
115 if (query
->module
!= NULL
&&
116 strcmp(query
->module
, dt
->mod_name
))
119 for (i
= 0 ; i
< dt
->num_ddebugs
; i
++) {
120 struct _ddebug
*dp
= &dt
->ddebugs
[i
];
122 /* match against the source filename */
123 if (query
->filename
!= NULL
&&
124 strcmp(query
->filename
, dp
->filename
) &&
125 strcmp(query
->filename
, basename(dp
->filename
)))
128 /* match against the function */
129 if (query
->function
!= NULL
&&
130 strcmp(query
->function
, dp
->function
))
133 /* match against the format */
134 if (query
->format
!= NULL
&&
135 strstr(dp
->format
, query
->format
) == NULL
)
138 /* match against the line number range */
139 if (query
->first_lineno
&&
140 dp
->lineno
< query
->first_lineno
)
142 if (query
->last_lineno
&&
143 dp
->lineno
> query
->last_lineno
)
148 newflags
= (dp
->flags
& mask
) | flags
;
149 if (newflags
== dp
->flags
)
156 dp
->flags
= newflags
;
163 "ddebug: changed %s:%d [%s]%s %s\n",
164 dp
->filename
, dp
->lineno
,
165 dt
->mod_name
, dp
->function
,
166 ddebug_describe_flags(dp
, flagbuf
,
170 mutex_unlock(&ddebug_lock
);
172 if (!nfound
&& verbose
)
173 printk(KERN_INFO
"ddebug: no matches for query\n");
177 * Split the buffer `buf' into space-separated words.
178 * Handles simple " and ' quoting, i.e. without nested,
179 * embedded or escaped \". Return the number of words
182 static int ddebug_tokenize(char *buf
, char *words
[], int maxwords
)
189 /* Skip leading whitespace */
190 buf
= skip_spaces(buf
);
192 break; /* oh, it was trailing whitespace */
194 /* Run `end' over a word, either whitespace separated or quoted */
195 if (*buf
== '"' || *buf
== '\'') {
197 for (end
= buf
; *end
&& *end
!= quote
; end
++)
200 return -EINVAL
; /* unclosed quote */
202 for (end
= buf
; *end
&& !isspace(*end
) ; end
++)
206 /* Here `buf' is the start of the word, `end' is one past the end */
208 if (nwords
== maxwords
)
209 return -EINVAL
; /* ran out of words[] before bytes */
211 *end
++ = '\0'; /* terminate the word */
212 words
[nwords
++] = buf
;
218 printk(KERN_INFO
"%s: split into words:", __func__
);
219 for (i
= 0 ; i
< nwords
; i
++)
220 printk(" \"%s\"", words
[i
]);
228 * Parse a single line number. Note that the empty string ""
229 * is treated as a special case and converted to zero, which
230 * is later treated as a "don't care" value.
232 static inline int parse_lineno(const char *str
, unsigned int *val
)
240 *val
= simple_strtoul(str
, &end
, 10);
241 return end
== NULL
|| end
== str
|| *end
!= '\0' ? -EINVAL
: 0;
245 * Undo octal escaping in a string, inplace. This is useful to
246 * allow the user to express a query which matches a format
247 * containing embedded spaces.
249 #define isodigit(c) ((c) >= '0' && (c) <= '7')
250 static char *unescape(char *str
)
261 } else if (in
[1] == 't') {
265 } else if (in
[1] == 'n') {
269 } else if (isodigit(in
[1]) &&
272 *out
++ = ((in
[1] - '0')<<6) |
287 * Parse words[] as a ddebug query specification, which is a series
288 * of (keyword, value) pairs chosen from these possibilities:
290 * func <function-name>
291 * file <full-pathname>
292 * file <base-filename>
293 * module <module-name>
294 * format <escaped-string-to-find-in-format>
296 * line <first-lineno>-<last-lineno> // where either may be empty
298 static int ddebug_parse_query(char *words
[], int nwords
,
299 struct ddebug_query
*query
)
303 /* check we have an even number of words */
306 memset(query
, 0, sizeof(*query
));
308 for (i
= 0 ; i
< nwords
; i
+= 2) {
309 if (!strcmp(words
[i
], "func"))
310 query
->function
= words
[i
+1];
311 else if (!strcmp(words
[i
], "file"))
312 query
->filename
= words
[i
+1];
313 else if (!strcmp(words
[i
], "module"))
314 query
->module
= words
[i
+1];
315 else if (!strcmp(words
[i
], "format"))
316 query
->format
= unescape(words
[i
+1]);
317 else if (!strcmp(words
[i
], "line")) {
318 char *first
= words
[i
+1];
319 char *last
= strchr(first
, '-');
322 if (parse_lineno(first
, &query
->first_lineno
) < 0)
325 /* range <first>-<last> */
326 if (parse_lineno(last
, &query
->last_lineno
) < 0)
329 query
->last_lineno
= query
->first_lineno
;
333 printk(KERN_ERR
"%s: unknown keyword \"%s\"\n",
340 printk(KERN_INFO
"%s: q->function=\"%s\" q->filename=\"%s\" "
341 "q->module=\"%s\" q->format=\"%s\" q->lineno=%u-%u\n",
342 __func__
, query
->function
, query
->filename
,
343 query
->module
, query
->format
, query
->first_lineno
,
350 * Parse `str' as a flags specification, format [-+=][p]+.
351 * Sets up *maskp and *flagsp to be used when changing the
352 * flags fields of matched _ddebug's. Returns 0 on success
355 static int ddebug_parse_flags(const char *str
, unsigned int *flagsp
,
371 printk(KERN_INFO
"%s: op='%c'\n", __func__
, op
);
373 for ( ; *str
; ++str
) {
374 for (i
= ARRAY_SIZE(opt_array
) - 1; i
>= 0; i
--) {
375 if (*str
== opt_array
[i
].opt_char
) {
376 flags
|= opt_array
[i
].flag
;
386 printk(KERN_INFO
"%s: flags=0x%x\n", __func__
, flags
);
388 /* calculate final *flagsp, *maskp according to mask and op */
404 printk(KERN_INFO
"%s: *flagsp=0x%x *maskp=0x%x\n",
405 __func__
, *flagsp
, *maskp
);
409 static int ddebug_exec_query(char *query_string
)
411 unsigned int flags
= 0, mask
= 0;
412 struct ddebug_query query
;
415 char *words
[MAXWORDS
];
417 nwords
= ddebug_tokenize(query_string
, words
, MAXWORDS
);
420 if (ddebug_parse_query(words
, nwords
-1, &query
))
422 if (ddebug_parse_flags(words
[nwords
-1], &flags
, &mask
))
425 /* actually go and implement the change */
426 ddebug_change(&query
, flags
, mask
);
430 int __dynamic_pr_debug(struct _ddebug
*descriptor
, const char *fmt
, ...)
439 res
= printk(KERN_DEBUG
);
440 if (descriptor
->flags
& _DPRINTK_FLAGS_INCL_TID
) {
442 res
+= printk(KERN_CONT
"<intr> ");
444 res
+= printk(KERN_CONT
"[%d] ", task_pid_vnr(current
));
446 if (descriptor
->flags
& _DPRINTK_FLAGS_INCL_MODNAME
)
447 res
+= printk(KERN_CONT
"%s:", descriptor
->modname
);
448 if (descriptor
->flags
& _DPRINTK_FLAGS_INCL_FUNCNAME
)
449 res
+= printk(KERN_CONT
"%s:", descriptor
->function
);
450 if (descriptor
->flags
& _DPRINTK_FLAGS_INCL_LINENO
)
451 res
+= printk(KERN_CONT
"%d ", descriptor
->lineno
);
452 res
+= vprintk(fmt
, args
);
457 EXPORT_SYMBOL(__dynamic_pr_debug
);
459 static __initdata
char ddebug_setup_string
[1024];
460 static __init
int ddebug_setup_query(char *str
)
462 if (strlen(str
) >= 1024) {
463 pr_warning("ddebug boot param string too large\n");
466 strcpy(ddebug_setup_string
, str
);
470 __setup("ddebug_query=", ddebug_setup_query
);
473 * File_ops->write method for <debugfs>/dynamic_debug/conrol. Gathers the
474 * command text from userspace, parses and executes it.
476 static ssize_t
ddebug_proc_write(struct file
*file
, const char __user
*ubuf
,
477 size_t len
, loff_t
*offp
)
484 /* we don't check *offp -- multiple writes() are allowed */
485 if (len
> sizeof(tmpbuf
)-1)
487 if (copy_from_user(tmpbuf
, ubuf
, len
))
491 printk(KERN_INFO
"%s: read %d bytes from userspace\n",
494 ret
= ddebug_exec_query(tmpbuf
);
503 * Set the iterator to point to the first _ddebug object
504 * and return a pointer to that first object. Returns
505 * NULL if there are no _ddebugs at all.
507 static struct _ddebug
*ddebug_iter_first(struct ddebug_iter
*iter
)
509 if (list_empty(&ddebug_tables
)) {
514 iter
->table
= list_entry(ddebug_tables
.next
,
515 struct ddebug_table
, link
);
517 return &iter
->table
->ddebugs
[iter
->idx
];
521 * Advance the iterator to point to the next _ddebug
522 * object from the one the iterator currently points at,
523 * and returns a pointer to the new _ddebug. Returns
524 * NULL if the iterator has seen all the _ddebugs.
526 static struct _ddebug
*ddebug_iter_next(struct ddebug_iter
*iter
)
528 if (iter
->table
== NULL
)
530 if (++iter
->idx
== iter
->table
->num_ddebugs
) {
531 /* iterate to next table */
533 if (list_is_last(&iter
->table
->link
, &ddebug_tables
)) {
537 iter
->table
= list_entry(iter
->table
->link
.next
,
538 struct ddebug_table
, link
);
540 return &iter
->table
->ddebugs
[iter
->idx
];
544 * Seq_ops start method. Called at the start of every
545 * read() call from userspace. Takes the ddebug_lock and
546 * seeks the seq_file's iterator to the given position.
548 static void *ddebug_proc_start(struct seq_file
*m
, loff_t
*pos
)
550 struct ddebug_iter
*iter
= m
->private;
555 printk(KERN_INFO
"%s: called m=%p *pos=%lld\n",
556 __func__
, m
, (unsigned long long)*pos
);
558 mutex_lock(&ddebug_lock
);
561 return SEQ_START_TOKEN
;
564 dp
= ddebug_iter_first(iter
);
565 while (dp
!= NULL
&& --n
> 0)
566 dp
= ddebug_iter_next(iter
);
571 * Seq_ops next method. Called several times within a read()
572 * call from userspace, with ddebug_lock held. Walks to the
573 * next _ddebug object with a special case for the header line.
575 static void *ddebug_proc_next(struct seq_file
*m
, void *p
, loff_t
*pos
)
577 struct ddebug_iter
*iter
= m
->private;
581 printk(KERN_INFO
"%s: called m=%p p=%p *pos=%lld\n",
582 __func__
, m
, p
, (unsigned long long)*pos
);
584 if (p
== SEQ_START_TOKEN
)
585 dp
= ddebug_iter_first(iter
);
587 dp
= ddebug_iter_next(iter
);
593 * Seq_ops show method. Called several times within a read()
594 * call from userspace, with ddebug_lock held. Formats the
595 * current _ddebug as a single human-readable line, with a
596 * special case for the header line.
598 static int ddebug_proc_show(struct seq_file
*m
, void *p
)
600 struct ddebug_iter
*iter
= m
->private;
601 struct _ddebug
*dp
= p
;
605 printk(KERN_INFO
"%s: called m=%p p=%p\n",
608 if (p
== SEQ_START_TOKEN
) {
610 "# filename:lineno [module]function flags format\n");
614 seq_printf(m
, "%s:%u [%s]%s %s \"",
615 dp
->filename
, dp
->lineno
,
616 iter
->table
->mod_name
, dp
->function
,
617 ddebug_describe_flags(dp
, flagsbuf
, sizeof(flagsbuf
)));
618 seq_escape(m
, dp
->format
, "\t\r\n\"");
625 * Seq_ops stop method. Called at the end of each read()
626 * call from userspace. Drops ddebug_lock.
628 static void ddebug_proc_stop(struct seq_file
*m
, void *p
)
631 printk(KERN_INFO
"%s: called m=%p p=%p\n",
633 mutex_unlock(&ddebug_lock
);
636 static const struct seq_operations ddebug_proc_seqops
= {
637 .start
= ddebug_proc_start
,
638 .next
= ddebug_proc_next
,
639 .show
= ddebug_proc_show
,
640 .stop
= ddebug_proc_stop
644 * File_ops->open method for <debugfs>/dynamic_debug/control. Does the seq_file
645 * setup dance, and also creates an iterator to walk the _ddebugs.
646 * Note that we create a seq_file always, even for O_WRONLY files
647 * where it's not needed, as doing so simplifies the ->release method.
649 static int ddebug_proc_open(struct inode
*inode
, struct file
*file
)
651 struct ddebug_iter
*iter
;
655 printk(KERN_INFO
"%s: called\n", __func__
);
657 iter
= kzalloc(sizeof(*iter
), GFP_KERNEL
);
661 err
= seq_open(file
, &ddebug_proc_seqops
);
666 ((struct seq_file
*) file
->private_data
)->private = iter
;
670 static const struct file_operations ddebug_proc_fops
= {
671 .owner
= THIS_MODULE
,
672 .open
= ddebug_proc_open
,
675 .release
= seq_release_private
,
676 .write
= ddebug_proc_write
680 * Allocate a new ddebug_table for the given module
681 * and add it to the global list.
683 int ddebug_add_module(struct _ddebug
*tab
, unsigned int n
,
686 struct ddebug_table
*dt
;
689 dt
= kzalloc(sizeof(*dt
), GFP_KERNEL
);
692 new_name
= kstrdup(name
, GFP_KERNEL
);
693 if (new_name
== NULL
) {
697 dt
->mod_name
= new_name
;
702 mutex_lock(&ddebug_lock
);
703 list_add_tail(&dt
->link
, &ddebug_tables
);
704 mutex_unlock(&ddebug_lock
);
707 printk(KERN_INFO
"%u debug prints in module %s\n",
711 EXPORT_SYMBOL_GPL(ddebug_add_module
);
713 static void ddebug_table_free(struct ddebug_table
*dt
)
715 list_del_init(&dt
->link
);
721 * Called in response to a module being unloaded. Removes
722 * any ddebug_table's which point at the module.
724 int ddebug_remove_module(const char *mod_name
)
726 struct ddebug_table
*dt
, *nextdt
;
730 printk(KERN_INFO
"%s: removing module \"%s\"\n",
733 mutex_lock(&ddebug_lock
);
734 list_for_each_entry_safe(dt
, nextdt
, &ddebug_tables
, link
) {
735 if (!strcmp(dt
->mod_name
, mod_name
)) {
736 ddebug_table_free(dt
);
740 mutex_unlock(&ddebug_lock
);
743 EXPORT_SYMBOL_GPL(ddebug_remove_module
);
745 static void ddebug_remove_all_tables(void)
747 mutex_lock(&ddebug_lock
);
748 while (!list_empty(&ddebug_tables
)) {
749 struct ddebug_table
*dt
= list_entry(ddebug_tables
.next
,
752 ddebug_table_free(dt
);
754 mutex_unlock(&ddebug_lock
);
757 static __initdata
int ddebug_init_success
;
759 static int __init
dynamic_debug_init_debugfs(void)
761 struct dentry
*dir
, *file
;
763 if (!ddebug_init_success
)
766 dir
= debugfs_create_dir("dynamic_debug", NULL
);
769 file
= debugfs_create_file("control", 0644, dir
, NULL
,
778 static int __init
dynamic_debug_init(void)
780 struct _ddebug
*iter
, *iter_start
;
781 const char *modname
= NULL
;
785 if (__start___verbose
!= __stop___verbose
) {
786 iter
= __start___verbose
;
787 modname
= iter
->modname
;
789 for (; iter
< __stop___verbose
; iter
++) {
790 if (strcmp(modname
, iter
->modname
)) {
791 ret
= ddebug_add_module(iter_start
, n
, modname
);
795 modname
= iter
->modname
;
800 ret
= ddebug_add_module(iter_start
, n
, modname
);
803 /* ddebug_query boot param got passed -> set it up */
804 if (ddebug_setup_string
[0] != '\0') {
805 ret
= ddebug_exec_query(ddebug_setup_string
);
807 pr_warning("Invalid ddebug boot param %s",
808 ddebug_setup_string
);
810 pr_info("ddebug initialized with string %s",
811 ddebug_setup_string
);
816 ddebug_remove_all_tables();
818 ddebug_init_success
= 1;
821 /* Allow early initialization for boot messages via boot param */
822 arch_initcall(dynamic_debug_init
);
823 /* Debugfs setup must be done later */
824 module_init(dynamic_debug_init_debugfs
);