drm/nouveau/core: allow non-maskable events
[linux-2.6.git] / lib / dynamic_debug.c
blob5276b99ca650df8fe6e6e07363f2639250418c5a
1 /*
2 * lib/dynamic_debug.c
4 * make pr_debug()/dev_dbg() calls runtime configurable based upon their
5 * source module.
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 #define pr_fmt(fmt) KBUILD_MODNAME ":%s: " fmt, __func__
15 #include <linux/kernel.h>
16 #include <linux/module.h>
17 #include <linux/moduleparam.h>
18 #include <linux/kallsyms.h>
19 #include <linux/types.h>
20 #include <linux/mutex.h>
21 #include <linux/proc_fs.h>
22 #include <linux/seq_file.h>
23 #include <linux/list.h>
24 #include <linux/sysctl.h>
25 #include <linux/ctype.h>
26 #include <linux/string.h>
27 #include <linux/uaccess.h>
28 #include <linux/dynamic_debug.h>
29 #include <linux/debugfs.h>
30 #include <linux/slab.h>
31 #include <linux/jump_label.h>
32 #include <linux/hardirq.h>
33 #include <linux/sched.h>
34 #include <linux/device.h>
35 #include <linux/netdevice.h>
37 extern struct _ddebug __start___verbose[];
38 extern struct _ddebug __stop___verbose[];
40 struct ddebug_table {
41 struct list_head link;
42 char *mod_name;
43 unsigned int num_ddebugs;
44 struct _ddebug *ddebugs;
47 struct ddebug_query {
48 const char *filename;
49 const char *module;
50 const char *function;
51 const char *format;
52 unsigned int first_lineno, last_lineno;
55 struct ddebug_iter {
56 struct ddebug_table *table;
57 unsigned int idx;
60 static DEFINE_MUTEX(ddebug_lock);
61 static LIST_HEAD(ddebug_tables);
62 static int verbose;
63 module_param(verbose, int, 0644);
65 /* Return the path relative to source root */
66 static inline const char *trim_prefix(const char *path)
68 int skip = strlen(__FILE__) - strlen("lib/dynamic_debug.c");
70 if (strncmp(path, __FILE__, skip))
71 skip = 0; /* prefix mismatch, don't skip */
73 return path + skip;
76 static struct { unsigned flag:8; char opt_char; } opt_array[] = {
77 { _DPRINTK_FLAGS_PRINT, 'p' },
78 { _DPRINTK_FLAGS_INCL_MODNAME, 'm' },
79 { _DPRINTK_FLAGS_INCL_FUNCNAME, 'f' },
80 { _DPRINTK_FLAGS_INCL_LINENO, 'l' },
81 { _DPRINTK_FLAGS_INCL_TID, 't' },
82 { _DPRINTK_FLAGS_NONE, '_' },
85 /* format a string into buf[] which describes the _ddebug's flags */
86 static char *ddebug_describe_flags(struct _ddebug *dp, char *buf,
87 size_t maxlen)
89 char *p = buf;
90 int i;
92 BUG_ON(maxlen < 6);
93 for (i = 0; i < ARRAY_SIZE(opt_array); ++i)
94 if (dp->flags & opt_array[i].flag)
95 *p++ = opt_array[i].opt_char;
96 if (p == buf)
97 *p++ = '_';
98 *p = '\0';
100 return buf;
103 #define vpr_info(fmt, ...) \
104 do { \
105 if (verbose) \
106 pr_info(fmt, ##__VA_ARGS__); \
107 } while (0)
109 static void vpr_info_dq(const struct ddebug_query *query, const char *msg)
111 /* trim any trailing newlines */
112 int fmtlen = 0;
114 if (query->format) {
115 fmtlen = strlen(query->format);
116 while (fmtlen && query->format[fmtlen - 1] == '\n')
117 fmtlen--;
120 vpr_info("%s: func=\"%s\" file=\"%s\" module=\"%s\" format=\"%.*s\" lineno=%u-%u\n",
121 msg,
122 query->function ? query->function : "",
123 query->filename ? query->filename : "",
124 query->module ? query->module : "",
125 fmtlen, query->format ? query->format : "",
126 query->first_lineno, query->last_lineno);
130 * Search the tables for _ddebug's which match the given `query' and
131 * apply the `flags' and `mask' to them. Returns number of matching
132 * callsites, normally the same as number of changes. If verbose,
133 * logs the changes. Takes ddebug_lock.
135 static int ddebug_change(const struct ddebug_query *query,
136 unsigned int flags, unsigned int mask)
138 int i;
139 struct ddebug_table *dt;
140 unsigned int newflags;
141 unsigned int nfound = 0;
142 char flagbuf[10];
144 /* search for matching ddebugs */
145 mutex_lock(&ddebug_lock);
146 list_for_each_entry(dt, &ddebug_tables, link) {
148 /* match against the module name */
149 if (query->module && strcmp(query->module, dt->mod_name))
150 continue;
152 for (i = 0; i < dt->num_ddebugs; i++) {
153 struct _ddebug *dp = &dt->ddebugs[i];
155 /* match against the source filename */
156 if (query->filename &&
157 strcmp(query->filename, dp->filename) &&
158 strcmp(query->filename, kbasename(dp->filename)) &&
159 strcmp(query->filename, trim_prefix(dp->filename)))
160 continue;
162 /* match against the function */
163 if (query->function &&
164 strcmp(query->function, dp->function))
165 continue;
167 /* match against the format */
168 if (query->format &&
169 !strstr(dp->format, query->format))
170 continue;
172 /* match against the line number range */
173 if (query->first_lineno &&
174 dp->lineno < query->first_lineno)
175 continue;
176 if (query->last_lineno &&
177 dp->lineno > query->last_lineno)
178 continue;
180 nfound++;
182 newflags = (dp->flags & mask) | flags;
183 if (newflags == dp->flags)
184 continue;
185 dp->flags = newflags;
186 vpr_info("changed %s:%d [%s]%s =%s\n",
187 trim_prefix(dp->filename), dp->lineno,
188 dt->mod_name, dp->function,
189 ddebug_describe_flags(dp, flagbuf,
190 sizeof(flagbuf)));
193 mutex_unlock(&ddebug_lock);
195 if (!nfound && verbose)
196 pr_info("no matches for query\n");
198 return nfound;
202 * Split the buffer `buf' into space-separated words.
203 * Handles simple " and ' quoting, i.e. without nested,
204 * embedded or escaped \". Return the number of words
205 * or <0 on error.
207 static int ddebug_tokenize(char *buf, char *words[], int maxwords)
209 int nwords = 0;
211 while (*buf) {
212 char *end;
214 /* Skip leading whitespace */
215 buf = skip_spaces(buf);
216 if (!*buf)
217 break; /* oh, it was trailing whitespace */
218 if (*buf == '#')
219 break; /* token starts comment, skip rest of line */
221 /* find `end' of word, whitespace separated or quoted */
222 if (*buf == '"' || *buf == '\'') {
223 int quote = *buf++;
224 for (end = buf; *end && *end != quote; end++)
226 if (!*end) {
227 pr_err("unclosed quote: %s\n", buf);
228 return -EINVAL; /* unclosed quote */
230 } else {
231 for (end = buf; *end && !isspace(*end); end++)
233 BUG_ON(end == buf);
236 /* `buf' is start of word, `end' is one past its end */
237 if (nwords == maxwords) {
238 pr_err("too many words, legal max <=%d\n", maxwords);
239 return -EINVAL; /* ran out of words[] before bytes */
241 if (*end)
242 *end++ = '\0'; /* terminate the word */
243 words[nwords++] = buf;
244 buf = end;
247 if (verbose) {
248 int i;
249 pr_info("split into words:");
250 for (i = 0; i < nwords; i++)
251 pr_cont(" \"%s\"", words[i]);
252 pr_cont("\n");
255 return nwords;
259 * Parse a single line number. Note that the empty string ""
260 * is treated as a special case and converted to zero, which
261 * is later treated as a "don't care" value.
263 static inline int parse_lineno(const char *str, unsigned int *val)
265 char *end = NULL;
266 BUG_ON(str == NULL);
267 if (*str == '\0') {
268 *val = 0;
269 return 0;
271 *val = simple_strtoul(str, &end, 10);
272 if (end == NULL || end == str || *end != '\0') {
273 pr_err("bad line-number: %s\n", str);
274 return -EINVAL;
276 return 0;
280 * Undo octal escaping in a string, inplace. This is useful to
281 * allow the user to express a query which matches a format
282 * containing embedded spaces.
284 #define isodigit(c) ((c) >= '0' && (c) <= '7')
285 static char *unescape(char *str)
287 char *in = str;
288 char *out = str;
290 while (*in) {
291 if (*in == '\\') {
292 if (in[1] == '\\') {
293 *out++ = '\\';
294 in += 2;
295 continue;
296 } else if (in[1] == 't') {
297 *out++ = '\t';
298 in += 2;
299 continue;
300 } else if (in[1] == 'n') {
301 *out++ = '\n';
302 in += 2;
303 continue;
304 } else if (isodigit(in[1]) &&
305 isodigit(in[2]) &&
306 isodigit(in[3])) {
307 *out++ = (((in[1] - '0') << 6) |
308 ((in[2] - '0') << 3) |
309 (in[3] - '0'));
310 in += 4;
311 continue;
314 *out++ = *in++;
316 *out = '\0';
318 return str;
321 static int check_set(const char **dest, char *src, char *name)
323 int rc = 0;
325 if (*dest) {
326 rc = -EINVAL;
327 pr_err("match-spec:%s val:%s overridden by %s\n",
328 name, *dest, src);
330 *dest = src;
331 return rc;
335 * Parse words[] as a ddebug query specification, which is a series
336 * of (keyword, value) pairs chosen from these possibilities:
338 * func <function-name>
339 * file <full-pathname>
340 * file <base-filename>
341 * module <module-name>
342 * format <escaped-string-to-find-in-format>
343 * line <lineno>
344 * line <first-lineno>-<last-lineno> // where either may be empty
346 * Only 1 of each type is allowed.
347 * Returns 0 on success, <0 on error.
349 static int ddebug_parse_query(char *words[], int nwords,
350 struct ddebug_query *query, const char *modname)
352 unsigned int i;
353 int rc;
355 /* check we have an even number of words */
356 if (nwords % 2 != 0) {
357 pr_err("expecting pairs of match-spec <value>\n");
358 return -EINVAL;
360 memset(query, 0, sizeof(*query));
362 if (modname)
363 /* support $modname.dyndbg=<multiple queries> */
364 query->module = modname;
366 for (i = 0; i < nwords; i += 2) {
367 if (!strcmp(words[i], "func")) {
368 rc = check_set(&query->function, words[i+1], "func");
369 } else if (!strcmp(words[i], "file")) {
370 rc = check_set(&query->filename, words[i+1], "file");
371 } else if (!strcmp(words[i], "module")) {
372 rc = check_set(&query->module, words[i+1], "module");
373 } else if (!strcmp(words[i], "format")) {
374 rc = check_set(&query->format, unescape(words[i+1]),
375 "format");
376 } else if (!strcmp(words[i], "line")) {
377 char *first = words[i+1];
378 char *last = strchr(first, '-');
379 if (query->first_lineno || query->last_lineno) {
380 pr_err("match-spec: line used 2x\n");
381 return -EINVAL;
383 if (last)
384 *last++ = '\0';
385 if (parse_lineno(first, &query->first_lineno) < 0) {
386 pr_err("line-number is <0\n");
387 return -EINVAL;
389 if (last) {
390 /* range <first>-<last> */
391 if (parse_lineno(last, &query->last_lineno)
392 < query->first_lineno) {
393 pr_err("last-line:%d < 1st-line:%d\n",
394 query->last_lineno,
395 query->first_lineno);
396 return -EINVAL;
398 } else {
399 query->last_lineno = query->first_lineno;
401 } else {
402 pr_err("unknown keyword \"%s\"\n", words[i]);
403 return -EINVAL;
405 if (rc)
406 return rc;
408 vpr_info_dq(query, "parsed");
409 return 0;
413 * Parse `str' as a flags specification, format [-+=][p]+.
414 * Sets up *maskp and *flagsp to be used when changing the
415 * flags fields of matched _ddebug's. Returns 0 on success
416 * or <0 on error.
418 static int ddebug_parse_flags(const char *str, unsigned int *flagsp,
419 unsigned int *maskp)
421 unsigned flags = 0;
422 int op = '=', i;
424 switch (*str) {
425 case '+':
426 case '-':
427 case '=':
428 op = *str++;
429 break;
430 default:
431 pr_err("bad flag-op %c, at start of %s\n", *str, str);
432 return -EINVAL;
434 vpr_info("op='%c'\n", op);
436 for (; *str ; ++str) {
437 for (i = ARRAY_SIZE(opt_array) - 1; i >= 0; i--) {
438 if (*str == opt_array[i].opt_char) {
439 flags |= opt_array[i].flag;
440 break;
443 if (i < 0) {
444 pr_err("unknown flag '%c' in \"%s\"\n", *str, str);
445 return -EINVAL;
448 vpr_info("flags=0x%x\n", flags);
450 /* calculate final *flagsp, *maskp according to mask and op */
451 switch (op) {
452 case '=':
453 *maskp = 0;
454 *flagsp = flags;
455 break;
456 case '+':
457 *maskp = ~0U;
458 *flagsp = flags;
459 break;
460 case '-':
461 *maskp = ~flags;
462 *flagsp = 0;
463 break;
465 vpr_info("*flagsp=0x%x *maskp=0x%x\n", *flagsp, *maskp);
466 return 0;
469 static int ddebug_exec_query(char *query_string, const char *modname)
471 unsigned int flags = 0, mask = 0;
472 struct ddebug_query query;
473 #define MAXWORDS 9
474 int nwords, nfound;
475 char *words[MAXWORDS];
477 nwords = ddebug_tokenize(query_string, words, MAXWORDS);
478 if (nwords <= 0) {
479 pr_err("tokenize failed\n");
480 return -EINVAL;
482 /* check flags 1st (last arg) so query is pairs of spec,val */
483 if (ddebug_parse_flags(words[nwords-1], &flags, &mask)) {
484 pr_err("flags parse failed\n");
485 return -EINVAL;
487 if (ddebug_parse_query(words, nwords-1, &query, modname)) {
488 pr_err("query parse failed\n");
489 return -EINVAL;
491 /* actually go and implement the change */
492 nfound = ddebug_change(&query, flags, mask);
493 vpr_info_dq(&query, nfound ? "applied" : "no-match");
495 return nfound;
498 /* handle multiple queries in query string, continue on error, return
499 last error or number of matching callsites. Module name is either
500 in param (for boot arg) or perhaps in query string.
502 static int ddebug_exec_queries(char *query, const char *modname)
504 char *split;
505 int i, errs = 0, exitcode = 0, rc, nfound = 0;
507 for (i = 0; query; query = split) {
508 split = strpbrk(query, ";\n");
509 if (split)
510 *split++ = '\0';
512 query = skip_spaces(query);
513 if (!query || !*query || *query == '#')
514 continue;
516 vpr_info("query %d: \"%s\"\n", i, query);
518 rc = ddebug_exec_query(query, modname);
519 if (rc < 0) {
520 errs++;
521 exitcode = rc;
522 } else {
523 nfound += rc;
525 i++;
527 vpr_info("processed %d queries, with %d matches, %d errs\n",
528 i, nfound, errs);
530 if (exitcode)
531 return exitcode;
532 return nfound;
535 #define PREFIX_SIZE 64
537 static int remaining(int wrote)
539 if (PREFIX_SIZE - wrote > 0)
540 return PREFIX_SIZE - wrote;
541 return 0;
544 static char *dynamic_emit_prefix(const struct _ddebug *desc, char *buf)
546 int pos_after_tid;
547 int pos = 0;
549 *buf = '\0';
551 if (desc->flags & _DPRINTK_FLAGS_INCL_TID) {
552 if (in_interrupt())
553 pos += snprintf(buf + pos, remaining(pos), "<intr> ");
554 else
555 pos += snprintf(buf + pos, remaining(pos), "[%d] ",
556 task_pid_vnr(current));
558 pos_after_tid = pos;
559 if (desc->flags & _DPRINTK_FLAGS_INCL_MODNAME)
560 pos += snprintf(buf + pos, remaining(pos), "%s:",
561 desc->modname);
562 if (desc->flags & _DPRINTK_FLAGS_INCL_FUNCNAME)
563 pos += snprintf(buf + pos, remaining(pos), "%s:",
564 desc->function);
565 if (desc->flags & _DPRINTK_FLAGS_INCL_LINENO)
566 pos += snprintf(buf + pos, remaining(pos), "%d:",
567 desc->lineno);
568 if (pos - pos_after_tid)
569 pos += snprintf(buf + pos, remaining(pos), " ");
570 if (pos >= PREFIX_SIZE)
571 buf[PREFIX_SIZE - 1] = '\0';
573 return buf;
576 int __dynamic_pr_debug(struct _ddebug *descriptor, const char *fmt, ...)
578 va_list args;
579 int res;
580 struct va_format vaf;
581 char buf[PREFIX_SIZE];
583 BUG_ON(!descriptor);
584 BUG_ON(!fmt);
586 va_start(args, fmt);
588 vaf.fmt = fmt;
589 vaf.va = &args;
591 res = printk(KERN_DEBUG "%s%pV",
592 dynamic_emit_prefix(descriptor, buf), &vaf);
594 va_end(args);
596 return res;
598 EXPORT_SYMBOL(__dynamic_pr_debug);
600 int __dynamic_dev_dbg(struct _ddebug *descriptor,
601 const struct device *dev, const char *fmt, ...)
603 struct va_format vaf;
604 va_list args;
605 int res;
607 BUG_ON(!descriptor);
608 BUG_ON(!fmt);
610 va_start(args, fmt);
612 vaf.fmt = fmt;
613 vaf.va = &args;
615 if (!dev) {
616 res = printk(KERN_DEBUG "(NULL device *): %pV", &vaf);
617 } else {
618 char buf[PREFIX_SIZE];
620 res = dev_printk_emit(7, dev, "%s%s %s: %pV",
621 dynamic_emit_prefix(descriptor, buf),
622 dev_driver_string(dev), dev_name(dev),
623 &vaf);
626 va_end(args);
628 return res;
630 EXPORT_SYMBOL(__dynamic_dev_dbg);
632 #ifdef CONFIG_NET
634 int __dynamic_netdev_dbg(struct _ddebug *descriptor,
635 const struct net_device *dev, const char *fmt, ...)
637 struct va_format vaf;
638 va_list args;
639 int res;
641 BUG_ON(!descriptor);
642 BUG_ON(!fmt);
644 va_start(args, fmt);
646 vaf.fmt = fmt;
647 vaf.va = &args;
649 if (dev && dev->dev.parent) {
650 char buf[PREFIX_SIZE];
652 res = dev_printk_emit(7, dev->dev.parent,
653 "%s%s %s %s: %pV",
654 dynamic_emit_prefix(descriptor, buf),
655 dev_driver_string(dev->dev.parent),
656 dev_name(dev->dev.parent),
657 netdev_name(dev), &vaf);
658 } else if (dev) {
659 res = printk(KERN_DEBUG "%s: %pV", netdev_name(dev), &vaf);
660 } else {
661 res = printk(KERN_DEBUG "(NULL net_device): %pV", &vaf);
664 va_end(args);
666 return res;
668 EXPORT_SYMBOL(__dynamic_netdev_dbg);
670 #endif
672 #define DDEBUG_STRING_SIZE 1024
673 static __initdata char ddebug_setup_string[DDEBUG_STRING_SIZE];
675 static __init int ddebug_setup_query(char *str)
677 if (strlen(str) >= DDEBUG_STRING_SIZE) {
678 pr_warn("ddebug boot param string too large\n");
679 return 0;
681 strlcpy(ddebug_setup_string, str, DDEBUG_STRING_SIZE);
682 return 1;
685 __setup("ddebug_query=", ddebug_setup_query);
688 * File_ops->write method for <debugfs>/dynamic_debug/conrol. Gathers the
689 * command text from userspace, parses and executes it.
691 #define USER_BUF_PAGE 4096
692 static ssize_t ddebug_proc_write(struct file *file, const char __user *ubuf,
693 size_t len, loff_t *offp)
695 char *tmpbuf;
696 int ret;
698 if (len == 0)
699 return 0;
700 if (len > USER_BUF_PAGE - 1) {
701 pr_warn("expected <%d bytes into control\n", USER_BUF_PAGE);
702 return -E2BIG;
704 tmpbuf = kmalloc(len + 1, GFP_KERNEL);
705 if (!tmpbuf)
706 return -ENOMEM;
707 if (copy_from_user(tmpbuf, ubuf, len)) {
708 kfree(tmpbuf);
709 return -EFAULT;
711 tmpbuf[len] = '\0';
712 vpr_info("read %d bytes from userspace\n", (int)len);
714 ret = ddebug_exec_queries(tmpbuf, NULL);
715 kfree(tmpbuf);
716 if (ret < 0)
717 return ret;
719 *offp += len;
720 return len;
724 * Set the iterator to point to the first _ddebug object
725 * and return a pointer to that first object. Returns
726 * NULL if there are no _ddebugs at all.
728 static struct _ddebug *ddebug_iter_first(struct ddebug_iter *iter)
730 if (list_empty(&ddebug_tables)) {
731 iter->table = NULL;
732 iter->idx = 0;
733 return NULL;
735 iter->table = list_entry(ddebug_tables.next,
736 struct ddebug_table, link);
737 iter->idx = 0;
738 return &iter->table->ddebugs[iter->idx];
742 * Advance the iterator to point to the next _ddebug
743 * object from the one the iterator currently points at,
744 * and returns a pointer to the new _ddebug. Returns
745 * NULL if the iterator has seen all the _ddebugs.
747 static struct _ddebug *ddebug_iter_next(struct ddebug_iter *iter)
749 if (iter->table == NULL)
750 return NULL;
751 if (++iter->idx == iter->table->num_ddebugs) {
752 /* iterate to next table */
753 iter->idx = 0;
754 if (list_is_last(&iter->table->link, &ddebug_tables)) {
755 iter->table = NULL;
756 return NULL;
758 iter->table = list_entry(iter->table->link.next,
759 struct ddebug_table, link);
761 return &iter->table->ddebugs[iter->idx];
765 * Seq_ops start method. Called at the start of every
766 * read() call from userspace. Takes the ddebug_lock and
767 * seeks the seq_file's iterator to the given position.
769 static void *ddebug_proc_start(struct seq_file *m, loff_t *pos)
771 struct ddebug_iter *iter = m->private;
772 struct _ddebug *dp;
773 int n = *pos;
775 vpr_info("called m=%p *pos=%lld\n", m, (unsigned long long)*pos);
777 mutex_lock(&ddebug_lock);
779 if (!n)
780 return SEQ_START_TOKEN;
781 if (n < 0)
782 return NULL;
783 dp = ddebug_iter_first(iter);
784 while (dp != NULL && --n > 0)
785 dp = ddebug_iter_next(iter);
786 return dp;
790 * Seq_ops next method. Called several times within a read()
791 * call from userspace, with ddebug_lock held. Walks to the
792 * next _ddebug object with a special case for the header line.
794 static void *ddebug_proc_next(struct seq_file *m, void *p, loff_t *pos)
796 struct ddebug_iter *iter = m->private;
797 struct _ddebug *dp;
799 vpr_info("called m=%p p=%p *pos=%lld\n",
800 m, p, (unsigned long long)*pos);
802 if (p == SEQ_START_TOKEN)
803 dp = ddebug_iter_first(iter);
804 else
805 dp = ddebug_iter_next(iter);
806 ++*pos;
807 return dp;
811 * Seq_ops show method. Called several times within a read()
812 * call from userspace, with ddebug_lock held. Formats the
813 * current _ddebug as a single human-readable line, with a
814 * special case for the header line.
816 static int ddebug_proc_show(struct seq_file *m, void *p)
818 struct ddebug_iter *iter = m->private;
819 struct _ddebug *dp = p;
820 char flagsbuf[10];
822 vpr_info("called m=%p p=%p\n", m, p);
824 if (p == SEQ_START_TOKEN) {
825 seq_puts(m,
826 "# filename:lineno [module]function flags format\n");
827 return 0;
830 seq_printf(m, "%s:%u [%s]%s =%s \"",
831 trim_prefix(dp->filename), dp->lineno,
832 iter->table->mod_name, dp->function,
833 ddebug_describe_flags(dp, flagsbuf, sizeof(flagsbuf)));
834 seq_escape(m, dp->format, "\t\r\n\"");
835 seq_puts(m, "\"\n");
837 return 0;
841 * Seq_ops stop method. Called at the end of each read()
842 * call from userspace. Drops ddebug_lock.
844 static void ddebug_proc_stop(struct seq_file *m, void *p)
846 vpr_info("called m=%p p=%p\n", m, p);
847 mutex_unlock(&ddebug_lock);
850 static const struct seq_operations ddebug_proc_seqops = {
851 .start = ddebug_proc_start,
852 .next = ddebug_proc_next,
853 .show = ddebug_proc_show,
854 .stop = ddebug_proc_stop
858 * File_ops->open method for <debugfs>/dynamic_debug/control. Does
859 * the seq_file setup dance, and also creates an iterator to walk the
860 * _ddebugs. Note that we create a seq_file always, even for O_WRONLY
861 * files where it's not needed, as doing so simplifies the ->release
862 * method.
864 static int ddebug_proc_open(struct inode *inode, struct file *file)
866 struct ddebug_iter *iter;
867 int err;
869 vpr_info("called\n");
871 iter = kzalloc(sizeof(*iter), GFP_KERNEL);
872 if (iter == NULL)
873 return -ENOMEM;
875 err = seq_open(file, &ddebug_proc_seqops);
876 if (err) {
877 kfree(iter);
878 return err;
880 ((struct seq_file *)file->private_data)->private = iter;
881 return 0;
884 static const struct file_operations ddebug_proc_fops = {
885 .owner = THIS_MODULE,
886 .open = ddebug_proc_open,
887 .read = seq_read,
888 .llseek = seq_lseek,
889 .release = seq_release_private,
890 .write = ddebug_proc_write
894 * Allocate a new ddebug_table for the given module
895 * and add it to the global list.
897 int ddebug_add_module(struct _ddebug *tab, unsigned int n,
898 const char *name)
900 struct ddebug_table *dt;
901 char *new_name;
903 dt = kzalloc(sizeof(*dt), GFP_KERNEL);
904 if (dt == NULL)
905 return -ENOMEM;
906 new_name = kstrdup(name, GFP_KERNEL);
907 if (new_name == NULL) {
908 kfree(dt);
909 return -ENOMEM;
911 dt->mod_name = new_name;
912 dt->num_ddebugs = n;
913 dt->ddebugs = tab;
915 mutex_lock(&ddebug_lock);
916 list_add_tail(&dt->link, &ddebug_tables);
917 mutex_unlock(&ddebug_lock);
919 vpr_info("%u debug prints in module %s\n", n, dt->mod_name);
920 return 0;
922 EXPORT_SYMBOL_GPL(ddebug_add_module);
924 /* helper for ddebug_dyndbg_(boot|module)_param_cb */
925 static int ddebug_dyndbg_param_cb(char *param, char *val,
926 const char *modname, int on_err)
928 char *sep;
930 sep = strchr(param, '.');
931 if (sep) {
932 /* needed only for ddebug_dyndbg_boot_param_cb */
933 *sep = '\0';
934 modname = param;
935 param = sep + 1;
937 if (strcmp(param, "dyndbg"))
938 return on_err; /* determined by caller */
940 ddebug_exec_queries((val ? val : "+p"), modname);
942 return 0; /* query failure shouldnt stop module load */
945 /* handle both dyndbg and $module.dyndbg params at boot */
946 static int ddebug_dyndbg_boot_param_cb(char *param, char *val,
947 const char *unused)
949 vpr_info("%s=\"%s\"\n", param, val);
950 return ddebug_dyndbg_param_cb(param, val, NULL, 0);
954 * modprobe foo finds foo.params in boot-args, strips "foo.", and
955 * passes them to load_module(). This callback gets unknown params,
956 * processes dyndbg params, rejects others.
958 int ddebug_dyndbg_module_param_cb(char *param, char *val, const char *module)
960 vpr_info("module: %s %s=\"%s\"\n", module, param, val);
961 return ddebug_dyndbg_param_cb(param, val, module, -ENOENT);
964 static void ddebug_table_free(struct ddebug_table *dt)
966 list_del_init(&dt->link);
967 kfree(dt->mod_name);
968 kfree(dt);
972 * Called in response to a module being unloaded. Removes
973 * any ddebug_table's which point at the module.
975 int ddebug_remove_module(const char *mod_name)
977 struct ddebug_table *dt, *nextdt;
978 int ret = -ENOENT;
980 vpr_info("removing module \"%s\"\n", mod_name);
982 mutex_lock(&ddebug_lock);
983 list_for_each_entry_safe(dt, nextdt, &ddebug_tables, link) {
984 if (!strcmp(dt->mod_name, mod_name)) {
985 ddebug_table_free(dt);
986 ret = 0;
989 mutex_unlock(&ddebug_lock);
990 return ret;
992 EXPORT_SYMBOL_GPL(ddebug_remove_module);
994 static void ddebug_remove_all_tables(void)
996 mutex_lock(&ddebug_lock);
997 while (!list_empty(&ddebug_tables)) {
998 struct ddebug_table *dt = list_entry(ddebug_tables.next,
999 struct ddebug_table,
1000 link);
1001 ddebug_table_free(dt);
1003 mutex_unlock(&ddebug_lock);
1006 static __initdata int ddebug_init_success;
1008 static int __init dynamic_debug_init_debugfs(void)
1010 struct dentry *dir, *file;
1012 if (!ddebug_init_success)
1013 return -ENODEV;
1015 dir = debugfs_create_dir("dynamic_debug", NULL);
1016 if (!dir)
1017 return -ENOMEM;
1018 file = debugfs_create_file("control", 0644, dir, NULL,
1019 &ddebug_proc_fops);
1020 if (!file) {
1021 debugfs_remove(dir);
1022 return -ENOMEM;
1024 return 0;
1027 static int __init dynamic_debug_init(void)
1029 struct _ddebug *iter, *iter_start;
1030 const char *modname = NULL;
1031 char *cmdline;
1032 int ret = 0;
1033 int n = 0, entries = 0, modct = 0;
1034 int verbose_bytes = 0;
1036 if (__start___verbose == __stop___verbose) {
1037 pr_warn("_ddebug table is empty in a CONFIG_DYNAMIC_DEBUG build\n");
1038 return 1;
1040 iter = __start___verbose;
1041 modname = iter->modname;
1042 iter_start = iter;
1043 for (; iter < __stop___verbose; iter++) {
1044 entries++;
1045 verbose_bytes += strlen(iter->modname) + strlen(iter->function)
1046 + strlen(iter->filename) + strlen(iter->format);
1048 if (strcmp(modname, iter->modname)) {
1049 modct++;
1050 ret = ddebug_add_module(iter_start, n, modname);
1051 if (ret)
1052 goto out_err;
1053 n = 0;
1054 modname = iter->modname;
1055 iter_start = iter;
1057 n++;
1059 ret = ddebug_add_module(iter_start, n, modname);
1060 if (ret)
1061 goto out_err;
1063 ddebug_init_success = 1;
1064 vpr_info("%d modules, %d entries and %d bytes in ddebug tables, %d bytes in (readonly) verbose section\n",
1065 modct, entries, (int)(modct * sizeof(struct ddebug_table)),
1066 verbose_bytes + (int)(__stop___verbose - __start___verbose));
1068 /* apply ddebug_query boot param, dont unload tables on err */
1069 if (ddebug_setup_string[0] != '\0') {
1070 pr_warn("ddebug_query param name is deprecated, change it to dyndbg\n");
1071 ret = ddebug_exec_queries(ddebug_setup_string, NULL);
1072 if (ret < 0)
1073 pr_warn("Invalid ddebug boot param %s\n",
1074 ddebug_setup_string);
1075 else
1076 pr_info("%d changes by ddebug_query\n", ret);
1078 /* now that ddebug tables are loaded, process all boot args
1079 * again to find and activate queries given in dyndbg params.
1080 * While this has already been done for known boot params, it
1081 * ignored the unknown ones (dyndbg in particular). Reusing
1082 * parse_args avoids ad-hoc parsing. This will also attempt
1083 * to activate queries for not-yet-loaded modules, which is
1084 * slightly noisy if verbose, but harmless.
1086 cmdline = kstrdup(saved_command_line, GFP_KERNEL);
1087 parse_args("dyndbg params", cmdline, NULL,
1088 0, 0, 0, &ddebug_dyndbg_boot_param_cb);
1089 kfree(cmdline);
1090 return 0;
1092 out_err:
1093 ddebug_remove_all_tables();
1094 return 0;
1096 /* Allow early initialization for boot messages via boot param */
1097 early_initcall(dynamic_debug_init);
1099 /* Debugfs setup must be done later */
1100 fs_initcall(dynamic_debug_init_debugfs);