ARM: dts: Enable emmc and sdmmc on the rk3288-evb boards
[linux-2.6/btrfs-unstable.git] / lib / dynamic_debug.c
blobc9afbe2c445af155e2d2912ca362efae4ce02950
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.
11 * Copyright (C) 2013 Du, Changbin <changbin.du@gmail.com>
14 #define pr_fmt(fmt) KBUILD_MODNAME ":%s: " fmt, __func__
16 #include <linux/kernel.h>
17 #include <linux/module.h>
18 #include <linux/moduleparam.h>
19 #include <linux/kallsyms.h>
20 #include <linux/types.h>
21 #include <linux/mutex.h>
22 #include <linux/proc_fs.h>
23 #include <linux/seq_file.h>
24 #include <linux/list.h>
25 #include <linux/sysctl.h>
26 #include <linux/ctype.h>
27 #include <linux/string.h>
28 #include <linux/parser.h>
29 #include <linux/string_helpers.h>
30 #include <linux/uaccess.h>
31 #include <linux/dynamic_debug.h>
32 #include <linux/debugfs.h>
33 #include <linux/slab.h>
34 #include <linux/jump_label.h>
35 #include <linux/hardirq.h>
36 #include <linux/sched.h>
37 #include <linux/device.h>
38 #include <linux/netdevice.h>
40 extern struct _ddebug __start___verbose[];
41 extern struct _ddebug __stop___verbose[];
43 struct ddebug_table {
44 struct list_head link;
45 char *mod_name;
46 unsigned int num_ddebugs;
47 struct _ddebug *ddebugs;
50 struct ddebug_query {
51 const char *filename;
52 const char *module;
53 const char *function;
54 const char *format;
55 unsigned int first_lineno, last_lineno;
58 struct ddebug_iter {
59 struct ddebug_table *table;
60 unsigned int idx;
63 static DEFINE_MUTEX(ddebug_lock);
64 static LIST_HEAD(ddebug_tables);
65 static int verbose;
66 module_param(verbose, int, 0644);
68 /* Return the path relative to source root */
69 static inline const char *trim_prefix(const char *path)
71 int skip = strlen(__FILE__) - strlen("lib/dynamic_debug.c");
73 if (strncmp(path, __FILE__, skip))
74 skip = 0; /* prefix mismatch, don't skip */
76 return path + skip;
79 static struct { unsigned flag:8; char opt_char; } opt_array[] = {
80 { _DPRINTK_FLAGS_PRINT, 'p' },
81 { _DPRINTK_FLAGS_INCL_MODNAME, 'm' },
82 { _DPRINTK_FLAGS_INCL_FUNCNAME, 'f' },
83 { _DPRINTK_FLAGS_INCL_LINENO, 'l' },
84 { _DPRINTK_FLAGS_INCL_TID, 't' },
85 { _DPRINTK_FLAGS_NONE, '_' },
88 /* format a string into buf[] which describes the _ddebug's flags */
89 static char *ddebug_describe_flags(struct _ddebug *dp, char *buf,
90 size_t maxlen)
92 char *p = buf;
93 int i;
95 BUG_ON(maxlen < 6);
96 for (i = 0; i < ARRAY_SIZE(opt_array); ++i)
97 if (dp->flags & opt_array[i].flag)
98 *p++ = opt_array[i].opt_char;
99 if (p == buf)
100 *p++ = '_';
101 *p = '\0';
103 return buf;
106 #define vpr_info(fmt, ...) \
107 do { \
108 if (verbose) \
109 pr_info(fmt, ##__VA_ARGS__); \
110 } while (0)
112 static void vpr_info_dq(const struct ddebug_query *query, const char *msg)
114 /* trim any trailing newlines */
115 int fmtlen = 0;
117 if (query->format) {
118 fmtlen = strlen(query->format);
119 while (fmtlen && query->format[fmtlen - 1] == '\n')
120 fmtlen--;
123 vpr_info("%s: func=\"%s\" file=\"%s\" module=\"%s\" format=\"%.*s\" lineno=%u-%u\n",
124 msg,
125 query->function ? query->function : "",
126 query->filename ? query->filename : "",
127 query->module ? query->module : "",
128 fmtlen, query->format ? query->format : "",
129 query->first_lineno, query->last_lineno);
133 * Search the tables for _ddebug's which match the given `query' and
134 * apply the `flags' and `mask' to them. Returns number of matching
135 * callsites, normally the same as number of changes. If verbose,
136 * logs the changes. Takes ddebug_lock.
138 static int ddebug_change(const struct ddebug_query *query,
139 unsigned int flags, unsigned int mask)
141 int i;
142 struct ddebug_table *dt;
143 unsigned int newflags;
144 unsigned int nfound = 0;
145 char flagbuf[10];
147 /* search for matching ddebugs */
148 mutex_lock(&ddebug_lock);
149 list_for_each_entry(dt, &ddebug_tables, link) {
151 /* match against the module name */
152 if (query->module &&
153 !match_wildcard(query->module, dt->mod_name))
154 continue;
156 for (i = 0; i < dt->num_ddebugs; i++) {
157 struct _ddebug *dp = &dt->ddebugs[i];
159 /* match against the source filename */
160 if (query->filename &&
161 !match_wildcard(query->filename, dp->filename) &&
162 !match_wildcard(query->filename,
163 kbasename(dp->filename)) &&
164 !match_wildcard(query->filename,
165 trim_prefix(dp->filename)))
166 continue;
168 /* match against the function */
169 if (query->function &&
170 !match_wildcard(query->function, dp->function))
171 continue;
173 /* match against the format */
174 if (query->format &&
175 !strstr(dp->format, query->format))
176 continue;
178 /* match against the line number range */
179 if (query->first_lineno &&
180 dp->lineno < query->first_lineno)
181 continue;
182 if (query->last_lineno &&
183 dp->lineno > query->last_lineno)
184 continue;
186 nfound++;
188 newflags = (dp->flags & mask) | flags;
189 if (newflags == dp->flags)
190 continue;
191 dp->flags = newflags;
192 vpr_info("changed %s:%d [%s]%s =%s\n",
193 trim_prefix(dp->filename), dp->lineno,
194 dt->mod_name, dp->function,
195 ddebug_describe_flags(dp, flagbuf,
196 sizeof(flagbuf)));
199 mutex_unlock(&ddebug_lock);
201 if (!nfound && verbose)
202 pr_info("no matches for query\n");
204 return nfound;
208 * Split the buffer `buf' into space-separated words.
209 * Handles simple " and ' quoting, i.e. without nested,
210 * embedded or escaped \". Return the number of words
211 * or <0 on error.
213 static int ddebug_tokenize(char *buf, char *words[], int maxwords)
215 int nwords = 0;
217 while (*buf) {
218 char *end;
220 /* Skip leading whitespace */
221 buf = skip_spaces(buf);
222 if (!*buf)
223 break; /* oh, it was trailing whitespace */
224 if (*buf == '#')
225 break; /* token starts comment, skip rest of line */
227 /* find `end' of word, whitespace separated or quoted */
228 if (*buf == '"' || *buf == '\'') {
229 int quote = *buf++;
230 for (end = buf; *end && *end != quote; end++)
232 if (!*end) {
233 pr_err("unclosed quote: %s\n", buf);
234 return -EINVAL; /* unclosed quote */
236 } else {
237 for (end = buf; *end && !isspace(*end); end++)
239 BUG_ON(end == buf);
242 /* `buf' is start of word, `end' is one past its end */
243 if (nwords == maxwords) {
244 pr_err("too many words, legal max <=%d\n", maxwords);
245 return -EINVAL; /* ran out of words[] before bytes */
247 if (*end)
248 *end++ = '\0'; /* terminate the word */
249 words[nwords++] = buf;
250 buf = end;
253 if (verbose) {
254 int i;
255 pr_info("split into words:");
256 for (i = 0; i < nwords; i++)
257 pr_cont(" \"%s\"", words[i]);
258 pr_cont("\n");
261 return nwords;
265 * Parse a single line number. Note that the empty string ""
266 * is treated as a special case and converted to zero, which
267 * is later treated as a "don't care" value.
269 static inline int parse_lineno(const char *str, unsigned int *val)
271 BUG_ON(str == NULL);
272 if (*str == '\0') {
273 *val = 0;
274 return 0;
276 if (kstrtouint(str, 10, val) < 0) {
277 pr_err("bad line-number: %s\n", str);
278 return -EINVAL;
280 return 0;
283 static int check_set(const char **dest, char *src, char *name)
285 int rc = 0;
287 if (*dest) {
288 rc = -EINVAL;
289 pr_err("match-spec:%s val:%s overridden by %s\n",
290 name, *dest, src);
292 *dest = src;
293 return rc;
297 * Parse words[] as a ddebug query specification, which is a series
298 * of (keyword, value) pairs chosen from these possibilities:
300 * func <function-name>
301 * file <full-pathname>
302 * file <base-filename>
303 * module <module-name>
304 * format <escaped-string-to-find-in-format>
305 * line <lineno>
306 * line <first-lineno>-<last-lineno> // where either may be empty
308 * Only 1 of each type is allowed.
309 * Returns 0 on success, <0 on error.
311 static int ddebug_parse_query(char *words[], int nwords,
312 struct ddebug_query *query, const char *modname)
314 unsigned int i;
315 int rc = 0;
317 /* check we have an even number of words */
318 if (nwords % 2 != 0) {
319 pr_err("expecting pairs of match-spec <value>\n");
320 return -EINVAL;
322 memset(query, 0, sizeof(*query));
324 if (modname)
325 /* support $modname.dyndbg=<multiple queries> */
326 query->module = modname;
328 for (i = 0; i < nwords; i += 2) {
329 if (!strcmp(words[i], "func")) {
330 rc = check_set(&query->function, words[i+1], "func");
331 } else if (!strcmp(words[i], "file")) {
332 rc = check_set(&query->filename, words[i+1], "file");
333 } else if (!strcmp(words[i], "module")) {
334 rc = check_set(&query->module, words[i+1], "module");
335 } else if (!strcmp(words[i], "format")) {
336 string_unescape_inplace(words[i+1], UNESCAPE_SPACE |
337 UNESCAPE_OCTAL |
338 UNESCAPE_SPECIAL);
339 rc = check_set(&query->format, words[i+1], "format");
340 } else if (!strcmp(words[i], "line")) {
341 char *first = words[i+1];
342 char *last = strchr(first, '-');
343 if (query->first_lineno || query->last_lineno) {
344 pr_err("match-spec: line used 2x\n");
345 return -EINVAL;
347 if (last)
348 *last++ = '\0';
349 if (parse_lineno(first, &query->first_lineno) < 0)
350 return -EINVAL;
351 if (last) {
352 /* range <first>-<last> */
353 if (parse_lineno(last, &query->last_lineno) < 0)
354 return -EINVAL;
356 if (query->last_lineno < query->first_lineno) {
357 pr_err("last-line:%d < 1st-line:%d\n",
358 query->last_lineno,
359 query->first_lineno);
360 return -EINVAL;
362 } else {
363 query->last_lineno = query->first_lineno;
365 } else {
366 pr_err("unknown keyword \"%s\"\n", words[i]);
367 return -EINVAL;
369 if (rc)
370 return rc;
372 vpr_info_dq(query, "parsed");
373 return 0;
377 * Parse `str' as a flags specification, format [-+=][p]+.
378 * Sets up *maskp and *flagsp to be used when changing the
379 * flags fields of matched _ddebug's. Returns 0 on success
380 * or <0 on error.
382 static int ddebug_parse_flags(const char *str, unsigned int *flagsp,
383 unsigned int *maskp)
385 unsigned flags = 0;
386 int op = '=', i;
388 switch (*str) {
389 case '+':
390 case '-':
391 case '=':
392 op = *str++;
393 break;
394 default:
395 pr_err("bad flag-op %c, at start of %s\n", *str, str);
396 return -EINVAL;
398 vpr_info("op='%c'\n", op);
400 for (; *str ; ++str) {
401 for (i = ARRAY_SIZE(opt_array) - 1; i >= 0; i--) {
402 if (*str == opt_array[i].opt_char) {
403 flags |= opt_array[i].flag;
404 break;
407 if (i < 0) {
408 pr_err("unknown flag '%c' in \"%s\"\n", *str, str);
409 return -EINVAL;
412 vpr_info("flags=0x%x\n", flags);
414 /* calculate final *flagsp, *maskp according to mask and op */
415 switch (op) {
416 case '=':
417 *maskp = 0;
418 *flagsp = flags;
419 break;
420 case '+':
421 *maskp = ~0U;
422 *flagsp = flags;
423 break;
424 case '-':
425 *maskp = ~flags;
426 *flagsp = 0;
427 break;
429 vpr_info("*flagsp=0x%x *maskp=0x%x\n", *flagsp, *maskp);
430 return 0;
433 static int ddebug_exec_query(char *query_string, const char *modname)
435 unsigned int flags = 0, mask = 0;
436 struct ddebug_query query;
437 #define MAXWORDS 9
438 int nwords, nfound;
439 char *words[MAXWORDS];
441 nwords = ddebug_tokenize(query_string, words, MAXWORDS);
442 if (nwords <= 0) {
443 pr_err("tokenize failed\n");
444 return -EINVAL;
446 /* check flags 1st (last arg) so query is pairs of spec,val */
447 if (ddebug_parse_flags(words[nwords-1], &flags, &mask)) {
448 pr_err("flags parse failed\n");
449 return -EINVAL;
451 if (ddebug_parse_query(words, nwords-1, &query, modname)) {
452 pr_err("query parse failed\n");
453 return -EINVAL;
455 /* actually go and implement the change */
456 nfound = ddebug_change(&query, flags, mask);
457 vpr_info_dq(&query, nfound ? "applied" : "no-match");
459 return nfound;
462 /* handle multiple queries in query string, continue on error, return
463 last error or number of matching callsites. Module name is either
464 in param (for boot arg) or perhaps in query string.
466 static int ddebug_exec_queries(char *query, const char *modname)
468 char *split;
469 int i, errs = 0, exitcode = 0, rc, nfound = 0;
471 for (i = 0; query; query = split) {
472 split = strpbrk(query, ";\n");
473 if (split)
474 *split++ = '\0';
476 query = skip_spaces(query);
477 if (!query || !*query || *query == '#')
478 continue;
480 vpr_info("query %d: \"%s\"\n", i, query);
482 rc = ddebug_exec_query(query, modname);
483 if (rc < 0) {
484 errs++;
485 exitcode = rc;
486 } else {
487 nfound += rc;
489 i++;
491 vpr_info("processed %d queries, with %d matches, %d errs\n",
492 i, nfound, errs);
494 if (exitcode)
495 return exitcode;
496 return nfound;
499 #define PREFIX_SIZE 64
501 static int remaining(int wrote)
503 if (PREFIX_SIZE - wrote > 0)
504 return PREFIX_SIZE - wrote;
505 return 0;
508 static char *dynamic_emit_prefix(const struct _ddebug *desc, char *buf)
510 int pos_after_tid;
511 int pos = 0;
513 *buf = '\0';
515 if (desc->flags & _DPRINTK_FLAGS_INCL_TID) {
516 if (in_interrupt())
517 pos += snprintf(buf + pos, remaining(pos), "<intr> ");
518 else
519 pos += snprintf(buf + pos, remaining(pos), "[%d] ",
520 task_pid_vnr(current));
522 pos_after_tid = pos;
523 if (desc->flags & _DPRINTK_FLAGS_INCL_MODNAME)
524 pos += snprintf(buf + pos, remaining(pos), "%s:",
525 desc->modname);
526 if (desc->flags & _DPRINTK_FLAGS_INCL_FUNCNAME)
527 pos += snprintf(buf + pos, remaining(pos), "%s:",
528 desc->function);
529 if (desc->flags & _DPRINTK_FLAGS_INCL_LINENO)
530 pos += snprintf(buf + pos, remaining(pos), "%d:",
531 desc->lineno);
532 if (pos - pos_after_tid)
533 pos += snprintf(buf + pos, remaining(pos), " ");
534 if (pos >= PREFIX_SIZE)
535 buf[PREFIX_SIZE - 1] = '\0';
537 return buf;
540 int __dynamic_pr_debug(struct _ddebug *descriptor, const char *fmt, ...)
542 va_list args;
543 int res;
544 struct va_format vaf;
545 char buf[PREFIX_SIZE];
547 BUG_ON(!descriptor);
548 BUG_ON(!fmt);
550 va_start(args, fmt);
552 vaf.fmt = fmt;
553 vaf.va = &args;
555 res = printk(KERN_DEBUG "%s%pV",
556 dynamic_emit_prefix(descriptor, buf), &vaf);
558 va_end(args);
560 return res;
562 EXPORT_SYMBOL(__dynamic_pr_debug);
564 int __dynamic_dev_dbg(struct _ddebug *descriptor,
565 const struct device *dev, const char *fmt, ...)
567 struct va_format vaf;
568 va_list args;
569 int res;
571 BUG_ON(!descriptor);
572 BUG_ON(!fmt);
574 va_start(args, fmt);
576 vaf.fmt = fmt;
577 vaf.va = &args;
579 if (!dev) {
580 res = printk(KERN_DEBUG "(NULL device *): %pV", &vaf);
581 } else {
582 char buf[PREFIX_SIZE];
584 res = dev_printk_emit(7, dev, "%s%s %s: %pV",
585 dynamic_emit_prefix(descriptor, buf),
586 dev_driver_string(dev), dev_name(dev),
587 &vaf);
590 va_end(args);
592 return res;
594 EXPORT_SYMBOL(__dynamic_dev_dbg);
596 #ifdef CONFIG_NET
598 int __dynamic_netdev_dbg(struct _ddebug *descriptor,
599 const struct net_device *dev, const char *fmt, ...)
601 struct va_format vaf;
602 va_list args;
603 int res;
605 BUG_ON(!descriptor);
606 BUG_ON(!fmt);
608 va_start(args, fmt);
610 vaf.fmt = fmt;
611 vaf.va = &args;
613 if (dev && dev->dev.parent) {
614 char buf[PREFIX_SIZE];
616 res = dev_printk_emit(7, dev->dev.parent,
617 "%s%s %s %s%s: %pV",
618 dynamic_emit_prefix(descriptor, buf),
619 dev_driver_string(dev->dev.parent),
620 dev_name(dev->dev.parent),
621 netdev_name(dev), netdev_reg_state(dev),
622 &vaf);
623 } else if (dev) {
624 res = printk(KERN_DEBUG "%s%s: %pV", netdev_name(dev),
625 netdev_reg_state(dev), &vaf);
626 } else {
627 res = printk(KERN_DEBUG "(NULL net_device): %pV", &vaf);
630 va_end(args);
632 return res;
634 EXPORT_SYMBOL(__dynamic_netdev_dbg);
636 #endif
638 #define DDEBUG_STRING_SIZE 1024
639 static __initdata char ddebug_setup_string[DDEBUG_STRING_SIZE];
641 static __init int ddebug_setup_query(char *str)
643 if (strlen(str) >= DDEBUG_STRING_SIZE) {
644 pr_warn("ddebug boot param string too large\n");
645 return 0;
647 strlcpy(ddebug_setup_string, str, DDEBUG_STRING_SIZE);
648 return 1;
651 __setup("ddebug_query=", ddebug_setup_query);
654 * File_ops->write method for <debugfs>/dynamic_debug/conrol. Gathers the
655 * command text from userspace, parses and executes it.
657 #define USER_BUF_PAGE 4096
658 static ssize_t ddebug_proc_write(struct file *file, const char __user *ubuf,
659 size_t len, loff_t *offp)
661 char *tmpbuf;
662 int ret;
664 if (len == 0)
665 return 0;
666 if (len > USER_BUF_PAGE - 1) {
667 pr_warn("expected <%d bytes into control\n", USER_BUF_PAGE);
668 return -E2BIG;
670 tmpbuf = kmalloc(len + 1, GFP_KERNEL);
671 if (!tmpbuf)
672 return -ENOMEM;
673 if (copy_from_user(tmpbuf, ubuf, len)) {
674 kfree(tmpbuf);
675 return -EFAULT;
677 tmpbuf[len] = '\0';
678 vpr_info("read %d bytes from userspace\n", (int)len);
680 ret = ddebug_exec_queries(tmpbuf, NULL);
681 kfree(tmpbuf);
682 if (ret < 0)
683 return ret;
685 *offp += len;
686 return len;
690 * Set the iterator to point to the first _ddebug object
691 * and return a pointer to that first object. Returns
692 * NULL if there are no _ddebugs at all.
694 static struct _ddebug *ddebug_iter_first(struct ddebug_iter *iter)
696 if (list_empty(&ddebug_tables)) {
697 iter->table = NULL;
698 iter->idx = 0;
699 return NULL;
701 iter->table = list_entry(ddebug_tables.next,
702 struct ddebug_table, link);
703 iter->idx = 0;
704 return &iter->table->ddebugs[iter->idx];
708 * Advance the iterator to point to the next _ddebug
709 * object from the one the iterator currently points at,
710 * and returns a pointer to the new _ddebug. Returns
711 * NULL if the iterator has seen all the _ddebugs.
713 static struct _ddebug *ddebug_iter_next(struct ddebug_iter *iter)
715 if (iter->table == NULL)
716 return NULL;
717 if (++iter->idx == iter->table->num_ddebugs) {
718 /* iterate to next table */
719 iter->idx = 0;
720 if (list_is_last(&iter->table->link, &ddebug_tables)) {
721 iter->table = NULL;
722 return NULL;
724 iter->table = list_entry(iter->table->link.next,
725 struct ddebug_table, link);
727 return &iter->table->ddebugs[iter->idx];
731 * Seq_ops start method. Called at the start of every
732 * read() call from userspace. Takes the ddebug_lock and
733 * seeks the seq_file's iterator to the given position.
735 static void *ddebug_proc_start(struct seq_file *m, loff_t *pos)
737 struct ddebug_iter *iter = m->private;
738 struct _ddebug *dp;
739 int n = *pos;
741 vpr_info("called m=%p *pos=%lld\n", m, (unsigned long long)*pos);
743 mutex_lock(&ddebug_lock);
745 if (!n)
746 return SEQ_START_TOKEN;
747 if (n < 0)
748 return NULL;
749 dp = ddebug_iter_first(iter);
750 while (dp != NULL && --n > 0)
751 dp = ddebug_iter_next(iter);
752 return dp;
756 * Seq_ops next method. Called several times within a read()
757 * call from userspace, with ddebug_lock held. Walks to the
758 * next _ddebug object with a special case for the header line.
760 static void *ddebug_proc_next(struct seq_file *m, void *p, loff_t *pos)
762 struct ddebug_iter *iter = m->private;
763 struct _ddebug *dp;
765 vpr_info("called m=%p p=%p *pos=%lld\n",
766 m, p, (unsigned long long)*pos);
768 if (p == SEQ_START_TOKEN)
769 dp = ddebug_iter_first(iter);
770 else
771 dp = ddebug_iter_next(iter);
772 ++*pos;
773 return dp;
777 * Seq_ops show method. Called several times within a read()
778 * call from userspace, with ddebug_lock held. Formats the
779 * current _ddebug as a single human-readable line, with a
780 * special case for the header line.
782 static int ddebug_proc_show(struct seq_file *m, void *p)
784 struct ddebug_iter *iter = m->private;
785 struct _ddebug *dp = p;
786 char flagsbuf[10];
788 vpr_info("called m=%p p=%p\n", m, p);
790 if (p == SEQ_START_TOKEN) {
791 seq_puts(m,
792 "# filename:lineno [module]function flags format\n");
793 return 0;
796 seq_printf(m, "%s:%u [%s]%s =%s \"",
797 trim_prefix(dp->filename), dp->lineno,
798 iter->table->mod_name, dp->function,
799 ddebug_describe_flags(dp, flagsbuf, sizeof(flagsbuf)));
800 seq_escape(m, dp->format, "\t\r\n\"");
801 seq_puts(m, "\"\n");
803 return 0;
807 * Seq_ops stop method. Called at the end of each read()
808 * call from userspace. Drops ddebug_lock.
810 static void ddebug_proc_stop(struct seq_file *m, void *p)
812 vpr_info("called m=%p p=%p\n", m, p);
813 mutex_unlock(&ddebug_lock);
816 static const struct seq_operations ddebug_proc_seqops = {
817 .start = ddebug_proc_start,
818 .next = ddebug_proc_next,
819 .show = ddebug_proc_show,
820 .stop = ddebug_proc_stop
824 * File_ops->open method for <debugfs>/dynamic_debug/control. Does
825 * the seq_file setup dance, and also creates an iterator to walk the
826 * _ddebugs. Note that we create a seq_file always, even for O_WRONLY
827 * files where it's not needed, as doing so simplifies the ->release
828 * method.
830 static int ddebug_proc_open(struct inode *inode, struct file *file)
832 struct ddebug_iter *iter;
833 int err;
835 vpr_info("called\n");
837 iter = kzalloc(sizeof(*iter), GFP_KERNEL);
838 if (iter == NULL)
839 return -ENOMEM;
841 err = seq_open(file, &ddebug_proc_seqops);
842 if (err) {
843 kfree(iter);
844 return err;
846 ((struct seq_file *)file->private_data)->private = iter;
847 return 0;
850 static const struct file_operations ddebug_proc_fops = {
851 .owner = THIS_MODULE,
852 .open = ddebug_proc_open,
853 .read = seq_read,
854 .llseek = seq_lseek,
855 .release = seq_release_private,
856 .write = ddebug_proc_write
860 * Allocate a new ddebug_table for the given module
861 * and add it to the global list.
863 int ddebug_add_module(struct _ddebug *tab, unsigned int n,
864 const char *name)
866 struct ddebug_table *dt;
867 char *new_name;
869 dt = kzalloc(sizeof(*dt), GFP_KERNEL);
870 if (dt == NULL)
871 return -ENOMEM;
872 new_name = kstrdup(name, GFP_KERNEL);
873 if (new_name == NULL) {
874 kfree(dt);
875 return -ENOMEM;
877 dt->mod_name = new_name;
878 dt->num_ddebugs = n;
879 dt->ddebugs = tab;
881 mutex_lock(&ddebug_lock);
882 list_add_tail(&dt->link, &ddebug_tables);
883 mutex_unlock(&ddebug_lock);
885 vpr_info("%u debug prints in module %s\n", n, dt->mod_name);
886 return 0;
888 EXPORT_SYMBOL_GPL(ddebug_add_module);
890 /* helper for ddebug_dyndbg_(boot|module)_param_cb */
891 static int ddebug_dyndbg_param_cb(char *param, char *val,
892 const char *modname, int on_err)
894 char *sep;
896 sep = strchr(param, '.');
897 if (sep) {
898 /* needed only for ddebug_dyndbg_boot_param_cb */
899 *sep = '\0';
900 modname = param;
901 param = sep + 1;
903 if (strcmp(param, "dyndbg"))
904 return on_err; /* determined by caller */
906 ddebug_exec_queries((val ? val : "+p"), modname);
908 return 0; /* query failure shouldnt stop module load */
911 /* handle both dyndbg and $module.dyndbg params at boot */
912 static int ddebug_dyndbg_boot_param_cb(char *param, char *val,
913 const char *unused)
915 vpr_info("%s=\"%s\"\n", param, val);
916 return ddebug_dyndbg_param_cb(param, val, NULL, 0);
920 * modprobe foo finds foo.params in boot-args, strips "foo.", and
921 * passes them to load_module(). This callback gets unknown params,
922 * processes dyndbg params, rejects others.
924 int ddebug_dyndbg_module_param_cb(char *param, char *val, const char *module)
926 vpr_info("module: %s %s=\"%s\"\n", module, param, val);
927 return ddebug_dyndbg_param_cb(param, val, module, -ENOENT);
930 static void ddebug_table_free(struct ddebug_table *dt)
932 list_del_init(&dt->link);
933 kfree(dt->mod_name);
934 kfree(dt);
938 * Called in response to a module being unloaded. Removes
939 * any ddebug_table's which point at the module.
941 int ddebug_remove_module(const char *mod_name)
943 struct ddebug_table *dt, *nextdt;
944 int ret = -ENOENT;
946 vpr_info("removing module \"%s\"\n", mod_name);
948 mutex_lock(&ddebug_lock);
949 list_for_each_entry_safe(dt, nextdt, &ddebug_tables, link) {
950 if (!strcmp(dt->mod_name, mod_name)) {
951 ddebug_table_free(dt);
952 ret = 0;
955 mutex_unlock(&ddebug_lock);
956 return ret;
958 EXPORT_SYMBOL_GPL(ddebug_remove_module);
960 static void ddebug_remove_all_tables(void)
962 mutex_lock(&ddebug_lock);
963 while (!list_empty(&ddebug_tables)) {
964 struct ddebug_table *dt = list_entry(ddebug_tables.next,
965 struct ddebug_table,
966 link);
967 ddebug_table_free(dt);
969 mutex_unlock(&ddebug_lock);
972 static __initdata int ddebug_init_success;
974 static int __init dynamic_debug_init_debugfs(void)
976 struct dentry *dir, *file;
978 if (!ddebug_init_success)
979 return -ENODEV;
981 dir = debugfs_create_dir("dynamic_debug", NULL);
982 if (!dir)
983 return -ENOMEM;
984 file = debugfs_create_file("control", 0644, dir, NULL,
985 &ddebug_proc_fops);
986 if (!file) {
987 debugfs_remove(dir);
988 return -ENOMEM;
990 return 0;
993 static int __init dynamic_debug_init(void)
995 struct _ddebug *iter, *iter_start;
996 const char *modname = NULL;
997 char *cmdline;
998 int ret = 0;
999 int n = 0, entries = 0, modct = 0;
1000 int verbose_bytes = 0;
1002 if (__start___verbose == __stop___verbose) {
1003 pr_warn("_ddebug table is empty in a CONFIG_DYNAMIC_DEBUG build\n");
1004 return 1;
1006 iter = __start___verbose;
1007 modname = iter->modname;
1008 iter_start = iter;
1009 for (; iter < __stop___verbose; iter++) {
1010 entries++;
1011 verbose_bytes += strlen(iter->modname) + strlen(iter->function)
1012 + strlen(iter->filename) + strlen(iter->format);
1014 if (strcmp(modname, iter->modname)) {
1015 modct++;
1016 ret = ddebug_add_module(iter_start, n, modname);
1017 if (ret)
1018 goto out_err;
1019 n = 0;
1020 modname = iter->modname;
1021 iter_start = iter;
1023 n++;
1025 ret = ddebug_add_module(iter_start, n, modname);
1026 if (ret)
1027 goto out_err;
1029 ddebug_init_success = 1;
1030 vpr_info("%d modules, %d entries and %d bytes in ddebug tables, %d bytes in (readonly) verbose section\n",
1031 modct, entries, (int)(modct * sizeof(struct ddebug_table)),
1032 verbose_bytes + (int)(__stop___verbose - __start___verbose));
1034 /* apply ddebug_query boot param, dont unload tables on err */
1035 if (ddebug_setup_string[0] != '\0') {
1036 pr_warn("ddebug_query param name is deprecated, change it to dyndbg\n");
1037 ret = ddebug_exec_queries(ddebug_setup_string, NULL);
1038 if (ret < 0)
1039 pr_warn("Invalid ddebug boot param %s\n",
1040 ddebug_setup_string);
1041 else
1042 pr_info("%d changes by ddebug_query\n", ret);
1044 /* now that ddebug tables are loaded, process all boot args
1045 * again to find and activate queries given in dyndbg params.
1046 * While this has already been done for known boot params, it
1047 * ignored the unknown ones (dyndbg in particular). Reusing
1048 * parse_args avoids ad-hoc parsing. This will also attempt
1049 * to activate queries for not-yet-loaded modules, which is
1050 * slightly noisy if verbose, but harmless.
1052 cmdline = kstrdup(saved_command_line, GFP_KERNEL);
1053 parse_args("dyndbg params", cmdline, NULL,
1054 0, 0, 0, &ddebug_dyndbg_boot_param_cb);
1055 kfree(cmdline);
1056 return 0;
1058 out_err:
1059 ddebug_remove_all_tables();
1060 return 0;
1062 /* Allow early initialization for boot messages via boot param */
1063 early_initcall(dynamic_debug_init);
1065 /* Debugfs setup must be done later */
1066 fs_initcall(dynamic_debug_init_debugfs);