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.
11 * Copyright (C) 2013 Du, Changbin <changbin.du@gmail.com>
14 #define pr_fmt(fmt) "dyndbg: " fmt
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 #include <rdma/ib_verbs.h>
42 extern struct _ddebug __start___dyndbg[];
43 extern struct _ddebug __stop___dyndbg[];
44 extern struct ddebug_class_map __start___dyndbg_classes[];
45 extern struct ddebug_class_map __stop___dyndbg_classes[];
48 struct list_head link, maps;
50 unsigned int num_ddebugs;
51 struct _ddebug *ddebugs;
59 const char *class_string;
60 unsigned int first_lineno, last_lineno;
64 struct ddebug_table *table;
68 struct flag_settings {
73 static DEFINE_MUTEX(ddebug_lock);
74 static LIST_HEAD(ddebug_tables);
76 module_param(verbose, int, 0644);
77 MODULE_PARM_DESC(verbose, " dynamic_debug/control processing "
78 "( 0 = off (default), 1 = module add/rm, 2 = >control summary, 3 = parsing, 4 = per-site changes)");
80 /* Return the path relative to source root */
81 static inline const char *trim_prefix(const char *path)
83 int skip = strlen(__FILE__) - strlen("lib/dynamic_debug.c");
85 if (strncmp(path, __FILE__, skip))
86 skip = 0; /* prefix mismatch, don't skip */
91 static struct { unsigned flag:8; char opt_char; } opt_array[] = {
92 { _DPRINTK_FLAGS_PRINT, 'p' },
93 { _DPRINTK_FLAGS_INCL_MODNAME, 'm' },
94 { _DPRINTK_FLAGS_INCL_FUNCNAME, 'f' },
95 { _DPRINTK_FLAGS_INCL_LINENO, 'l' },
96 { _DPRINTK_FLAGS_INCL_TID, 't' },
97 { _DPRINTK_FLAGS_NONE, '_' },
100 struct flagsbuf { char buf[ARRAY_SIZE(opt_array)+1]; };
102 /* format a string into buf[] which describes the _ddebug's flags */
103 static char *ddebug_describe_flags(unsigned int flags, struct flagsbuf *fb)
108 for (i = 0; i < ARRAY_SIZE(opt_array); ++i)
109 if (flags & opt_array[i].flag)
110 *p++ = opt_array[i].opt_char;
118 #define vnpr_info(lvl, fmt, ...) \
120 if (verbose >= lvl) \
121 pr_info(fmt, ##__VA_ARGS__); \
124 #define vpr_info(fmt, ...) vnpr_info(1, fmt, ##__VA_ARGS__)
125 #define v2pr_info(fmt, ...) vnpr_info(2, fmt, ##__VA_ARGS__)
126 #define v3pr_info(fmt, ...) vnpr_info(3, fmt, ##__VA_ARGS__)
127 #define v4pr_info(fmt, ...) vnpr_info(4, fmt, ##__VA_ARGS__)
129 static void vpr_info_dq(const struct ddebug_query *query, const char *msg)
131 /* trim any trailing newlines */
135 fmtlen = strlen(query->format);
136 while (fmtlen && query->format[fmtlen - 1] == '\n')
140 v3pr_info("%s: func=\"%s\" file=\"%s\" module=\"%s\" format=\"%.*s\" lineno=%u-%u class=%s\n",
142 query->function ?: "",
143 query->filename ?: "",
145 fmtlen, query->format ?: "",
146 query->first_lineno, query->last_lineno, query->class_string);
149 static struct ddebug_class_map *ddebug_find_valid_class(struct ddebug_table const *dt,
150 const char *class_string, int *class_id)
152 struct ddebug_class_map *map;
155 list_for_each_entry(map, &dt->maps, link) {
156 idx = match_string(map->class_names, map->length, class_string);
158 *class_id = idx + map->base;
166 #define __outvar /* filled by callee */
168 * Search the tables for _ddebug's which match the given `query' and
169 * apply the `flags' and `mask' to them. Returns number of matching
170 * callsites, normally the same as number of changes. If verbose,
171 * logs the changes. Takes ddebug_lock.
173 static int ddebug_change(const struct ddebug_query *query,
174 struct flag_settings *modifiers)
177 struct ddebug_table *dt;
178 unsigned int newflags;
179 unsigned int nfound = 0;
180 struct flagsbuf fbuf, nbuf;
181 struct ddebug_class_map *map = NULL;
182 int __outvar valid_class;
184 /* search for matching ddebugs */
185 mutex_lock(&ddebug_lock);
186 list_for_each_entry(dt, &ddebug_tables, link) {
188 /* match against the module name */
190 !match_wildcard(query->module, dt->mod_name))
193 if (query->class_string) {
194 map = ddebug_find_valid_class(dt, query->class_string, &valid_class);
198 /* constrain query, do not touch class'd callsites */
199 valid_class = _DPRINTK_CLASS_DFLT;
202 for (i = 0; i < dt->num_ddebugs; i++) {
203 struct _ddebug *dp = &dt->ddebugs[i];
205 /* match site against query-class */
206 if (dp->class_id != valid_class)
209 /* match against the source filename */
210 if (query->filename &&
211 !match_wildcard(query->filename, dp->filename) &&
212 !match_wildcard(query->filename,
213 kbasename(dp->filename)) &&
214 !match_wildcard(query->filename,
215 trim_prefix(dp->filename)))
218 /* match against the function */
219 if (query->function &&
220 !match_wildcard(query->function, dp->function))
223 /* match against the format */
225 if (*query->format == '^') {
227 /* anchored search. match must be at beginning */
228 p = strstr(dp->format, query->format+1);
231 } else if (!strstr(dp->format, query->format))
235 /* match against the line number range */
236 if (query->first_lineno &&
237 dp->lineno < query->first_lineno)
239 if (query->last_lineno &&
240 dp->lineno > query->last_lineno)
245 newflags = (dp->flags & modifiers->mask) | modifiers->flags;
246 if (newflags == dp->flags)
248 #ifdef CONFIG_JUMP_LABEL
249 if (dp->flags & _DPRINTK_FLAGS_PRINT) {
250 if (!(newflags & _DPRINTK_FLAGS_PRINT))
251 static_branch_disable(&dp->key.dd_key_true);
252 } else if (newflags & _DPRINTK_FLAGS_PRINT) {
253 static_branch_enable(&dp->key.dd_key_true);
256 v4pr_info("changed %s:%d [%s]%s %s => %s\n",
257 trim_prefix(dp->filename), dp->lineno,
258 dt->mod_name, dp->function,
259 ddebug_describe_flags(dp->flags, &fbuf),
260 ddebug_describe_flags(newflags, &nbuf));
261 dp->flags = newflags;
264 mutex_unlock(&ddebug_lock);
266 if (!nfound && verbose)
267 pr_info("no matches for query\n");
273 * Split the buffer `buf' into space-separated words.
274 * Handles simple " and ' quoting, i.e. without nested,
275 * embedded or escaped \". Return the number of words
278 static int ddebug_tokenize(char *buf, char *words[], int maxwords)
285 /* Skip leading whitespace */
286 buf = skip_spaces(buf);
288 break; /* oh, it was trailing whitespace */
290 break; /* token starts comment, skip rest of line */
292 /* find `end' of word, whitespace separated or quoted */
293 if (*buf == '"' || *buf == '\'') {
295 for (end = buf; *end && *end != quote; end++)
298 pr_err("unclosed quote: %s\n", buf);
299 return -EINVAL; /* unclosed quote */
302 for (end = buf; *end && !isspace(*end); end++)
307 /* `buf' is start of word, `end' is one past its end */
308 if (nwords == maxwords) {
309 pr_err("too many words, legal max <=%d\n", maxwords);
310 return -EINVAL; /* ran out of words[] before bytes */
313 *end++ = '\0'; /* terminate the word */
314 words[nwords++] = buf;
320 pr_info("split into words:");
321 for (i = 0; i < nwords; i++)
322 pr_cont(" \"%s\"", words[i]);
330 * Parse a single line number. Note that the empty string ""
331 * is treated as a special case and converted to zero, which
332 * is later treated as a "don't care" value.
334 static inline int parse_lineno(const char *str, unsigned int *val)
341 if (kstrtouint(str, 10, val) < 0) {
342 pr_err("bad line-number: %s\n", str);
348 static int parse_linerange(struct ddebug_query *query, const char *first)
350 char *last = strchr(first, '-');
352 if (query->first_lineno || query->last_lineno) {
353 pr_err("match-spec: line used 2x\n");
358 if (parse_lineno(first, &query->first_lineno) < 0)
361 /* range <first>-<last> */
362 if (parse_lineno(last, &query->last_lineno) < 0)
365 /* special case for last lineno not specified */
366 if (query->last_lineno == 0)
367 query->last_lineno = UINT_MAX;
369 if (query->last_lineno < query->first_lineno) {
370 pr_err("last-line:%d < 1st-line:%d\n",
372 query->first_lineno);
376 query->last_lineno = query->first_lineno;
378 v3pr_info("parsed line %d-%d\n", query->first_lineno,
383 static int check_set(const char **dest, char *src, char *name)
389 pr_err("match-spec:%s val:%s overridden by %s\n",
397 * Parse words[] as a ddebug query specification, which is a series
398 * of (keyword, value) pairs chosen from these possibilities:
400 * func <function-name>
401 * file <full-pathname>
402 * file <base-filename>
403 * module <module-name>
404 * format <escaped-string-to-find-in-format>
406 * line <first-lineno>-<last-lineno> // where either may be empty
408 * Only 1 of each type is allowed.
409 * Returns 0 on success, <0 on error.
411 static int ddebug_parse_query(char *words[], int nwords,
412 struct ddebug_query *query, const char *modname)
418 /* check we have an even number of words */
419 if (nwords % 2 != 0) {
420 pr_err("expecting pairs of match-spec <value>\n");
424 for (i = 0; i < nwords; i += 2) {
425 char *keyword = words[i];
426 char *arg = words[i+1];
428 if (!strcmp(keyword, "func")) {
429 rc = check_set(&query->function, arg, "func");
430 } else if (!strcmp(keyword, "file")) {
431 if (check_set(&query->filename, arg, "file"))
434 /* tail :$info is function or line-range */
435 fline = strchr(query->filename, ':');
439 if (isalpha(*fline) || *fline == '*' || *fline == '?') {
440 /* take as function name */
441 if (check_set(&query->function, fline, "func"))
444 if (parse_linerange(query, fline))
447 } else if (!strcmp(keyword, "module")) {
448 rc = check_set(&query->module, arg, "module");
449 } else if (!strcmp(keyword, "format")) {
450 string_unescape_inplace(arg, UNESCAPE_SPACE |
453 rc = check_set(&query->format, arg, "format");
454 } else if (!strcmp(keyword, "line")) {
455 if (parse_linerange(query, arg))
457 } else if (!strcmp(keyword, "class")) {
458 rc = check_set(&query->class_string, arg, "class");
460 pr_err("unknown keyword \"%s\"\n", keyword);
466 if (!query->module && modname)
468 * support $modname.dyndbg=<multiple queries>, when
469 * not given in the query itself
471 query->module = modname;
473 vpr_info_dq(query, "parsed");
478 * Parse `str' as a flags specification, format [-+=][p]+.
479 * Sets up *maskp and *flagsp to be used when changing the
480 * flags fields of matched _ddebug's. Returns 0 on success
483 static int ddebug_parse_flags(const char *str, struct flag_settings *modifiers)
494 pr_err("bad flag-op %c, at start of %s\n", *str, str);
497 v3pr_info("op='%c'\n", op);
499 for (; *str ; ++str) {
500 for (i = ARRAY_SIZE(opt_array) - 1; i >= 0; i--) {
501 if (*str == opt_array[i].opt_char) {
502 modifiers->flags |= opt_array[i].flag;
507 pr_err("unknown flag '%c'\n", *str);
511 v3pr_info("flags=0x%x\n", modifiers->flags);
513 /* calculate final flags, mask based upon op */
516 /* modifiers->flags already set */
520 modifiers->mask = ~0U;
523 modifiers->mask = ~modifiers->flags;
524 modifiers->flags = 0;
527 v3pr_info("*flagsp=0x%x *maskp=0x%x\n", modifiers->flags, modifiers->mask);
532 static int ddebug_exec_query(char *query_string, const char *modname)
534 struct flag_settings modifiers = {};
535 struct ddebug_query query = {};
538 char *words[MAXWORDS];
540 nwords = ddebug_tokenize(query_string, words, MAXWORDS);
542 pr_err("tokenize failed\n");
545 /* check flags 1st (last arg) so query is pairs of spec,val */
546 if (ddebug_parse_flags(words[nwords-1], &modifiers)) {
547 pr_err("flags parse failed\n");
550 if (ddebug_parse_query(words, nwords-1, &query, modname)) {
551 pr_err("query parse failed\n");
554 /* actually go and implement the change */
555 nfound = ddebug_change(&query, &modifiers);
556 vpr_info_dq(&query, nfound ? "applied" : "no-match");
561 /* handle multiple queries in query string, continue on error, return
562 last error or number of matching callsites. Module name is either
563 in param (for boot arg) or perhaps in query string.
565 static int ddebug_exec_queries(char *query, const char *modname)
568 int i, errs = 0, exitcode = 0, rc, nfound = 0;
570 for (i = 0; query; query = split) {
571 split = strpbrk(query, ";\n");
575 query = skip_spaces(query);
576 if (!query || !*query || *query == '#')
579 vpr_info("query %d: \"%s\" mod:%s\n", i, query, modname ?: "*");
581 rc = ddebug_exec_query(query, modname);
591 v2pr_info("processed %d queries, with %d matches, %d errs\n",
599 /* apply a new bitmap to the sys-knob's current bit-state */
600 static int ddebug_apply_class_bitmap(const struct ddebug_class_param *dcp,
601 unsigned long *new_bits, unsigned long *old_bits)
603 #define QUERY_SIZE 128
604 char query[QUERY_SIZE];
605 const struct ddebug_class_map *map = dcp->map;
609 v2pr_info("apply: 0x%lx to: 0x%lx\n", *new_bits, *old_bits);
611 for (bi = 0; bi < map->length; bi++) {
612 if (test_bit(bi, new_bits) == test_bit(bi, old_bits))
615 snprintf(query, QUERY_SIZE, "class %s %c%s", map->class_names[bi],
616 test_bit(bi, new_bits) ? '+' : '-', dcp->flags);
618 ct = ddebug_exec_queries(query, NULL);
621 v2pr_info("bit_%d: %d matches on class: %s -> 0x%lx\n", bi,
622 ct, map->class_names[bi], *new_bits);
627 /* stub to later conditionally add "$module." prefix where not already done */
628 #define KP_NAME(kp) kp->name
630 #define CLASSMAP_BITMASK(width) ((1UL << (width)) - 1)
632 /* accept comma-separated-list of [+-] classnames */
633 static int param_set_dyndbg_classnames(const char *instr, const struct kernel_param *kp)
635 const struct ddebug_class_param *dcp = kp->arg;
636 const struct ddebug_class_map *map = dcp->map;
637 unsigned long curr_bits, old_bits;
638 char *cl_str, *p, *tmp;
639 int cls_id, totct = 0;
642 cl_str = tmp = kstrdup(instr, GFP_KERNEL);
643 p = strchr(cl_str, '\n');
647 /* start with previously set state-bits, then modify */
648 curr_bits = old_bits = *dcp->bits;
649 vpr_info("\"%s\" > %s:0x%lx\n", cl_str, KP_NAME(kp), curr_bits);
651 for (; cl_str; cl_str = p) {
652 p = strchr(cl_str, ',');
656 if (*cl_str == '-') {
664 cls_id = match_string(map->class_names, map->length, cl_str);
666 pr_err("%s unknown to %s\n", cl_str, KP_NAME(kp));
670 /* have one or more valid class_ids of one *_NAMES type */
671 switch (map->map_type) {
672 case DD_CLASS_TYPE_DISJOINT_NAMES:
673 /* the +/- pertains to a single bit */
674 if (test_bit(cls_id, &curr_bits) == wanted) {
675 v3pr_info("no change on %s\n", cl_str);
678 curr_bits ^= BIT(cls_id);
679 totct += ddebug_apply_class_bitmap(dcp, &curr_bits, dcp->bits);
680 *dcp->bits = curr_bits;
681 v2pr_info("%s: changed bit %d:%s\n", KP_NAME(kp), cls_id,
682 map->class_names[cls_id]);
684 case DD_CLASS_TYPE_LEVEL_NAMES:
685 /* cls_id = N in 0..max. wanted +/- determines N or N-1 */
686 old_bits = CLASSMAP_BITMASK(*dcp->lvl);
687 curr_bits = CLASSMAP_BITMASK(cls_id + (wanted ? 1 : 0 ));
689 totct += ddebug_apply_class_bitmap(dcp, &curr_bits, &old_bits);
690 *dcp->lvl = (cls_id + (wanted ? 1 : 0));
691 v2pr_info("%s: changed bit-%d: \"%s\" %lx->%lx\n", KP_NAME(kp), cls_id,
692 map->class_names[cls_id], old_bits, curr_bits);
695 pr_err("illegal map-type value %d\n", map->map_type);
699 vpr_info("total matches: %d\n", totct);
704 * param_set_dyndbg_classes - class FOO >control
705 * @instr: string echo>d to sysfs, input depends on map_type
706 * @kp: kp->arg has state: bits/lvl, map, map_type
708 * Enable/disable prdbgs by their class, as given in the arguments to
709 * DECLARE_DYNDBG_CLASSMAP. For LEVEL map-types, enforce relative
712 * Returns: 0 or <0 if error.
714 int param_set_dyndbg_classes(const char *instr, const struct kernel_param *kp)
716 const struct ddebug_class_param *dcp = kp->arg;
717 const struct ddebug_class_map *map = dcp->map;
718 unsigned long inrep, new_bits, old_bits;
721 switch (map->map_type) {
723 case DD_CLASS_TYPE_DISJOINT_NAMES:
724 case DD_CLASS_TYPE_LEVEL_NAMES:
725 /* handle [+-]classnames list separately, we are done here */
726 return param_set_dyndbg_classnames(instr, kp);
728 case DD_CLASS_TYPE_DISJOINT_BITS:
729 case DD_CLASS_TYPE_LEVEL_NUM:
730 /* numeric input, accept and fall-thru */
731 rc = kstrtoul(instr, 0, &inrep);
733 pr_err("expecting numeric input: %s > %s\n", instr, KP_NAME(kp));
738 pr_err("%s: bad map type: %d\n", KP_NAME(kp), map->map_type);
742 /* only _BITS,_NUM (numeric) map-types get here */
743 switch (map->map_type) {
744 case DD_CLASS_TYPE_DISJOINT_BITS:
745 /* expect bits. mask and warn if too many */
746 if (inrep & ~CLASSMAP_BITMASK(map->length)) {
747 pr_warn("%s: input: 0x%lx exceeds mask: 0x%lx, masking\n",
748 KP_NAME(kp), inrep, CLASSMAP_BITMASK(map->length));
749 inrep &= CLASSMAP_BITMASK(map->length);
751 v2pr_info("bits:%lx > %s\n", inrep, KP_NAME(kp));
752 totct += ddebug_apply_class_bitmap(dcp, &inrep, dcp->bits);
755 case DD_CLASS_TYPE_LEVEL_NUM:
756 /* input is bitpos, of highest verbosity to be enabled */
757 if (inrep > map->length) {
758 pr_warn("%s: level:%ld exceeds max:%d, clamping\n",
759 KP_NAME(kp), inrep, map->length);
762 old_bits = CLASSMAP_BITMASK(*dcp->lvl);
763 new_bits = CLASSMAP_BITMASK(inrep);
764 v2pr_info("lvl:%ld bits:0x%lx > %s\n", inrep, new_bits, KP_NAME(kp));
765 totct += ddebug_apply_class_bitmap(dcp, &new_bits, &old_bits);
769 pr_warn("%s: bad map type: %d\n", KP_NAME(kp), map->map_type);
771 vpr_info("%s: total matches: %d\n", KP_NAME(kp), totct);
774 EXPORT_SYMBOL(param_set_dyndbg_classes);
777 * param_get_dyndbg_classes - classes reader
778 * @buffer: string description of controlled bits -> classes
779 * @kp: kp->arg has state: bits, map
781 * Reads last written state, underlying prdbg state may have been
782 * altered by direct >control. Displays 0x for DISJOINT, 0-N for
783 * LEVEL Returns: #chars written or <0 on error
785 int param_get_dyndbg_classes(char *buffer, const struct kernel_param *kp)
787 const struct ddebug_class_param *dcp = kp->arg;
788 const struct ddebug_class_map *map = dcp->map;
790 switch (map->map_type) {
792 case DD_CLASS_TYPE_DISJOINT_NAMES:
793 case DD_CLASS_TYPE_DISJOINT_BITS:
794 return scnprintf(buffer, PAGE_SIZE, "0x%lx\n", *dcp->bits);
796 case DD_CLASS_TYPE_LEVEL_NAMES:
797 case DD_CLASS_TYPE_LEVEL_NUM:
798 return scnprintf(buffer, PAGE_SIZE, "%d\n", *dcp->lvl);
803 EXPORT_SYMBOL(param_get_dyndbg_classes);
805 const struct kernel_param_ops param_ops_dyndbg_classes = {
806 .set = param_set_dyndbg_classes,
807 .get = param_get_dyndbg_classes,
809 EXPORT_SYMBOL(param_ops_dyndbg_classes);
811 #define PREFIX_SIZE 64
813 static int remaining(int wrote)
815 if (PREFIX_SIZE - wrote > 0)
816 return PREFIX_SIZE - wrote;
820 static char *__dynamic_emit_prefix(const struct _ddebug *desc, char *buf)
825 if (desc->flags & _DPRINTK_FLAGS_INCL_TID) {
827 pos += snprintf(buf + pos, remaining(pos), "<intr> ");
829 pos += snprintf(buf + pos, remaining(pos), "[%d] ",
830 task_pid_vnr(current));
833 if (desc->flags & _DPRINTK_FLAGS_INCL_MODNAME)
834 pos += snprintf(buf + pos, remaining(pos), "%s:",
836 if (desc->flags & _DPRINTK_FLAGS_INCL_FUNCNAME)
837 pos += snprintf(buf + pos, remaining(pos), "%s:",
839 if (desc->flags & _DPRINTK_FLAGS_INCL_LINENO)
840 pos += snprintf(buf + pos, remaining(pos), "%d:",
842 if (pos - pos_after_tid)
843 pos += snprintf(buf + pos, remaining(pos), " ");
844 if (pos >= PREFIX_SIZE)
845 buf[PREFIX_SIZE - 1] = '\0';
850 static inline char *dynamic_emit_prefix(struct _ddebug *desc, char *buf)
852 if (unlikely(desc->flags & _DPRINTK_FLAGS_INCL_ANY))
853 return __dynamic_emit_prefix(desc, buf);
857 void __dynamic_pr_debug(struct _ddebug *descriptor, const char *fmt, ...)
860 struct va_format vaf;
861 char buf[PREFIX_SIZE] = "";
871 printk(KERN_DEBUG "%s%pV", dynamic_emit_prefix(descriptor, buf), &vaf);
875 EXPORT_SYMBOL(__dynamic_pr_debug);
877 void __dynamic_dev_dbg(struct _ddebug *descriptor,
878 const struct device *dev, const char *fmt, ...)
880 struct va_format vaf;
892 printk(KERN_DEBUG "(NULL device *): %pV", &vaf);
894 char buf[PREFIX_SIZE] = "";
896 dev_printk_emit(LOGLEVEL_DEBUG, dev, "%s%s %s: %pV",
897 dynamic_emit_prefix(descriptor, buf),
898 dev_driver_string(dev), dev_name(dev),
904 EXPORT_SYMBOL(__dynamic_dev_dbg);
908 void __dynamic_netdev_dbg(struct _ddebug *descriptor,
909 const struct net_device *dev, const char *fmt, ...)
911 struct va_format vaf;
922 if (dev && dev->dev.parent) {
923 char buf[PREFIX_SIZE] = "";
925 dev_printk_emit(LOGLEVEL_DEBUG, dev->dev.parent,
927 dynamic_emit_prefix(descriptor, buf),
928 dev_driver_string(dev->dev.parent),
929 dev_name(dev->dev.parent),
930 netdev_name(dev), netdev_reg_state(dev),
933 printk(KERN_DEBUG "%s%s: %pV", netdev_name(dev),
934 netdev_reg_state(dev), &vaf);
936 printk(KERN_DEBUG "(NULL net_device): %pV", &vaf);
941 EXPORT_SYMBOL(__dynamic_netdev_dbg);
945 #if IS_ENABLED(CONFIG_INFINIBAND)
947 void __dynamic_ibdev_dbg(struct _ddebug *descriptor,
948 const struct ib_device *ibdev, const char *fmt, ...)
950 struct va_format vaf;
958 if (ibdev && ibdev->dev.parent) {
959 char buf[PREFIX_SIZE] = "";
961 dev_printk_emit(LOGLEVEL_DEBUG, ibdev->dev.parent,
963 dynamic_emit_prefix(descriptor, buf),
964 dev_driver_string(ibdev->dev.parent),
965 dev_name(ibdev->dev.parent),
966 dev_name(&ibdev->dev),
969 printk(KERN_DEBUG "%s: %pV", dev_name(&ibdev->dev), &vaf);
971 printk(KERN_DEBUG "(NULL ib_device): %pV", &vaf);
976 EXPORT_SYMBOL(__dynamic_ibdev_dbg);
981 * Install a noop handler to make dyndbg look like a normal kernel cli param.
982 * This avoids warnings about dyndbg being an unknown cli param when supplied
985 static __init int dyndbg_setup(char *str)
990 __setup("dyndbg=", dyndbg_setup);
993 * File_ops->write method for <debugfs>/dynamic_debug/control. Gathers the
994 * command text from userspace, parses and executes it.
996 #define USER_BUF_PAGE 4096
997 static ssize_t ddebug_proc_write(struct file *file, const char __user *ubuf,
998 size_t len, loff_t *offp)
1005 if (len > USER_BUF_PAGE - 1) {
1006 pr_warn("expected <%d bytes into control\n", USER_BUF_PAGE);
1009 tmpbuf = memdup_user_nul(ubuf, len);
1011 return PTR_ERR(tmpbuf);
1012 v2pr_info("read %zu bytes from userspace\n", len);
1014 ret = ddebug_exec_queries(tmpbuf, NULL);
1024 * Set the iterator to point to the first _ddebug object
1025 * and return a pointer to that first object. Returns
1026 * NULL if there are no _ddebugs at all.
1028 static struct _ddebug *ddebug_iter_first(struct ddebug_iter *iter)
1030 if (list_empty(&ddebug_tables)) {
1034 iter->table = list_entry(ddebug_tables.next,
1035 struct ddebug_table, link);
1036 iter->idx = iter->table->num_ddebugs;
1037 return &iter->table->ddebugs[--iter->idx];
1041 * Advance the iterator to point to the next _ddebug
1042 * object from the one the iterator currently points at,
1043 * and returns a pointer to the new _ddebug. Returns
1044 * NULL if the iterator has seen all the _ddebugs.
1046 static struct _ddebug *ddebug_iter_next(struct ddebug_iter *iter)
1048 if (iter->table == NULL)
1050 if (--iter->idx < 0) {
1051 /* iterate to next table */
1052 if (list_is_last(&iter->table->link, &ddebug_tables)) {
1056 iter->table = list_entry(iter->table->link.next,
1057 struct ddebug_table, link);
1058 iter->idx = iter->table->num_ddebugs;
1061 return &iter->table->ddebugs[iter->idx];
1065 * Seq_ops start method. Called at the start of every
1066 * read() call from userspace. Takes the ddebug_lock and
1067 * seeks the seq_file's iterator to the given position.
1069 static void *ddebug_proc_start(struct seq_file *m, loff_t *pos)
1071 struct ddebug_iter *iter = m->private;
1075 mutex_lock(&ddebug_lock);
1078 return SEQ_START_TOKEN;
1081 dp = ddebug_iter_first(iter);
1082 while (dp != NULL && --n > 0)
1083 dp = ddebug_iter_next(iter);
1088 * Seq_ops next method. Called several times within a read()
1089 * call from userspace, with ddebug_lock held. Walks to the
1090 * next _ddebug object with a special case for the header line.
1092 static void *ddebug_proc_next(struct seq_file *m, void *p, loff_t *pos)
1094 struct ddebug_iter *iter = m->private;
1097 if (p == SEQ_START_TOKEN)
1098 dp = ddebug_iter_first(iter);
1100 dp = ddebug_iter_next(iter);
1105 #define class_in_range(class_id, map) \
1106 (class_id >= map->base && class_id < map->base + map->length)
1108 static const char *ddebug_class_name(struct ddebug_iter *iter, struct _ddebug *dp)
1110 struct ddebug_class_map *map;
1112 list_for_each_entry(map, &iter->table->maps, link)
1113 if (class_in_range(dp->class_id, map))
1114 return map->class_names[dp->class_id - map->base];
1120 * Seq_ops show method. Called several times within a read()
1121 * call from userspace, with ddebug_lock held. Formats the
1122 * current _ddebug as a single human-readable line, with a
1123 * special case for the header line.
1125 static int ddebug_proc_show(struct seq_file *m, void *p)
1127 struct ddebug_iter *iter = m->private;
1128 struct _ddebug *dp = p;
1129 struct flagsbuf flags;
1132 if (p == SEQ_START_TOKEN) {
1134 "# filename:lineno [module]function flags format\n");
1138 seq_printf(m, "%s:%u [%s]%s =%s \"",
1139 trim_prefix(dp->filename), dp->lineno,
1140 iter->table->mod_name, dp->function,
1141 ddebug_describe_flags(dp->flags, &flags));
1142 seq_escape_str(m, dp->format, ESCAPE_SPACE, "\t\r\n\"");
1145 if (dp->class_id != _DPRINTK_CLASS_DFLT) {
1146 class = ddebug_class_name(iter, dp);
1148 seq_printf(m, " class:%s", class);
1150 seq_printf(m, " class unknown, _id:%d", dp->class_id);
1158 * Seq_ops stop method. Called at the end of each read()
1159 * call from userspace. Drops ddebug_lock.
1161 static void ddebug_proc_stop(struct seq_file *m, void *p)
1163 mutex_unlock(&ddebug_lock);
1166 static const struct seq_operations ddebug_proc_seqops = {
1167 .start = ddebug_proc_start,
1168 .next = ddebug_proc_next,
1169 .show = ddebug_proc_show,
1170 .stop = ddebug_proc_stop
1173 static int ddebug_proc_open(struct inode *inode, struct file *file)
1175 return seq_open_private(file, &ddebug_proc_seqops,
1176 sizeof(struct ddebug_iter));
1179 static const struct file_operations ddebug_proc_fops = {
1180 .owner = THIS_MODULE,
1181 .open = ddebug_proc_open,
1183 .llseek = seq_lseek,
1184 .release = seq_release_private,
1185 .write = ddebug_proc_write
1188 static const struct proc_ops proc_fops = {
1189 .proc_open = ddebug_proc_open,
1190 .proc_read = seq_read,
1191 .proc_lseek = seq_lseek,
1192 .proc_release = seq_release_private,
1193 .proc_write = ddebug_proc_write
1196 static void ddebug_attach_module_classes(struct ddebug_table *dt,
1197 struct ddebug_class_map *classes,
1200 struct ddebug_class_map *cm;
1203 for (cm = classes, i = 0; i < num_classes; i++, cm++) {
1205 if (!strcmp(cm->mod_name, dt->mod_name)) {
1207 v2pr_info("class[%d]: module:%s base:%d len:%d ty:%d\n", i,
1208 cm->mod_name, cm->base, cm->length, cm->map_type);
1210 for (j = 0; j < cm->length; j++)
1211 v3pr_info(" %d: %d %s\n", j + cm->base, j,
1212 cm->class_names[j]);
1214 list_add(&cm->link, &dt->maps);
1219 vpr_info("module:%s attached %d classes\n", dt->mod_name, ct);
1223 * Allocate a new ddebug_table for the given module
1224 * and add it to the global list.
1226 static int ddebug_add_module(struct _ddebug_info *di, const char *modname)
1228 struct ddebug_table *dt;
1230 v3pr_info("add-module: %s.%d sites\n", modname, di->num_descs);
1231 if (!di->num_descs) {
1232 v3pr_info(" skip %s\n", modname);
1236 dt = kzalloc(sizeof(*dt), GFP_KERNEL);
1238 pr_err("error adding module: %s\n", modname);
1242 * For built-in modules, name lives in .rodata and is
1243 * immortal. For loaded modules, name points at the name[]
1244 * member of struct module, which lives at least as long as
1245 * this struct ddebug_table.
1247 dt->mod_name = modname;
1248 dt->ddebugs = di->descs;
1249 dt->num_ddebugs = di->num_descs;
1251 INIT_LIST_HEAD(&dt->link);
1252 INIT_LIST_HEAD(&dt->maps);
1254 if (di->classes && di->num_classes)
1255 ddebug_attach_module_classes(dt, di->classes, di->num_classes);
1257 mutex_lock(&ddebug_lock);
1258 list_add_tail(&dt->link, &ddebug_tables);
1259 mutex_unlock(&ddebug_lock);
1261 vpr_info("%3u debug prints in module %s\n", di->num_descs, modname);
1265 /* helper for ddebug_dyndbg_(boot|module)_param_cb */
1266 static int ddebug_dyndbg_param_cb(char *param, char *val,
1267 const char *modname, int on_err)
1271 sep = strchr(param, '.');
1273 /* needed only for ddebug_dyndbg_boot_param_cb */
1278 if (strcmp(param, "dyndbg"))
1279 return on_err; /* determined by caller */
1281 ddebug_exec_queries((val ? val : "+p"), modname);
1283 return 0; /* query failure shouldn't stop module load */
1286 /* handle both dyndbg and $module.dyndbg params at boot */
1287 static int ddebug_dyndbg_boot_param_cb(char *param, char *val,
1288 const char *unused, void *arg)
1290 vpr_info("%s=\"%s\"\n", param, val);
1291 return ddebug_dyndbg_param_cb(param, val, NULL, 0);
1295 * modprobe foo finds foo.params in boot-args, strips "foo.", and
1296 * passes them to load_module(). This callback gets unknown params,
1297 * processes dyndbg params, rejects others.
1299 int ddebug_dyndbg_module_param_cb(char *param, char *val, const char *module)
1301 vpr_info("module: %s %s=\"%s\"\n", module, param, val);
1302 return ddebug_dyndbg_param_cb(param, val, module, -ENOENT);
1305 static void ddebug_table_free(struct ddebug_table *dt)
1307 list_del_init(&dt->link);
1311 #ifdef CONFIG_MODULES
1314 * Called in response to a module being unloaded. Removes
1315 * any ddebug_table's which point at the module.
1317 static int ddebug_remove_module(const char *mod_name)
1319 struct ddebug_table *dt, *nextdt;
1322 mutex_lock(&ddebug_lock);
1323 list_for_each_entry_safe(dt, nextdt, &ddebug_tables, link) {
1324 if (dt->mod_name == mod_name) {
1325 ddebug_table_free(dt);
1330 mutex_unlock(&ddebug_lock);
1332 v2pr_info("removed module \"%s\"\n", mod_name);
1336 static int ddebug_module_notify(struct notifier_block *self, unsigned long val,
1339 struct module *mod = data;
1343 case MODULE_STATE_COMING:
1344 ret = ddebug_add_module(&mod->dyndbg_info, mod->name);
1346 WARN(1, "Failed to allocate memory: dyndbg may not work properly.\n");
1348 case MODULE_STATE_GOING:
1349 ddebug_remove_module(mod->name);
1353 return notifier_from_errno(ret);
1356 static struct notifier_block ddebug_module_nb = {
1357 .notifier_call = ddebug_module_notify,
1358 .priority = 0, /* dynamic debug depends on jump label */
1361 #endif /* CONFIG_MODULES */
1363 static void ddebug_remove_all_tables(void)
1365 mutex_lock(&ddebug_lock);
1366 while (!list_empty(&ddebug_tables)) {
1367 struct ddebug_table *dt = list_entry(ddebug_tables.next,
1368 struct ddebug_table,
1370 ddebug_table_free(dt);
1372 mutex_unlock(&ddebug_lock);
1375 static __initdata int ddebug_init_success;
1377 static int __init dynamic_debug_init_control(void)
1379 struct proc_dir_entry *procfs_dir;
1380 struct dentry *debugfs_dir;
1382 if (!ddebug_init_success)
1385 /* Create the control file in debugfs if it is enabled */
1386 if (debugfs_initialized()) {
1387 debugfs_dir = debugfs_create_dir("dynamic_debug", NULL);
1388 debugfs_create_file("control", 0644, debugfs_dir, NULL,
1392 /* Also create the control file in procfs */
1393 procfs_dir = proc_mkdir("dynamic_debug", NULL);
1395 proc_create("control", 0644, procfs_dir, &proc_fops);
1400 static int __init dynamic_debug_init(void)
1402 struct _ddebug *iter, *iter_mod_start;
1403 int ret, i, mod_sites, mod_ct;
1404 const char *modname;
1407 struct _ddebug_info di = {
1408 .descs = __start___dyndbg,
1409 .classes = __start___dyndbg_classes,
1410 .num_descs = __stop___dyndbg - __start___dyndbg,
1411 .num_classes = __stop___dyndbg_classes - __start___dyndbg_classes,
1414 #ifdef CONFIG_MODULES
1415 ret = register_module_notifier(&ddebug_module_nb);
1417 pr_warn("Failed to register dynamic debug module notifier\n");
1420 #endif /* CONFIG_MODULES */
1422 if (&__start___dyndbg == &__stop___dyndbg) {
1423 if (IS_ENABLED(CONFIG_DYNAMIC_DEBUG)) {
1424 pr_warn("_ddebug table is empty in a CONFIG_DYNAMIC_DEBUG build\n");
1427 pr_info("Ignore empty _ddebug table in a CONFIG_DYNAMIC_DEBUG_CORE build\n");
1428 ddebug_init_success = 1;
1432 iter = iter_mod_start = __start___dyndbg;
1433 modname = iter->modname;
1434 i = mod_sites = mod_ct = 0;
1436 for (; iter < __stop___dyndbg; iter++, i++, mod_sites++) {
1438 if (strcmp(modname, iter->modname)) {
1440 di.num_descs = mod_sites;
1441 di.descs = iter_mod_start;
1442 ret = ddebug_add_module(&di, modname);
1447 modname = iter->modname;
1448 iter_mod_start = iter;
1451 di.num_descs = mod_sites;
1452 di.descs = iter_mod_start;
1453 ret = ddebug_add_module(&di, modname);
1457 ddebug_init_success = 1;
1458 vpr_info("%d prdebugs in %d modules, %d KiB in ddebug tables, %d kiB in __dyndbg section\n",
1459 i, mod_ct, (int)((mod_ct * sizeof(struct ddebug_table)) >> 10),
1460 (int)((i * sizeof(struct _ddebug)) >> 10));
1463 v2pr_info(" %d builtin ddebug class-maps\n", di.num_classes);
1465 /* now that ddebug tables are loaded, process all boot args
1466 * again to find and activate queries given in dyndbg params.
1467 * While this has already been done for known boot params, it
1468 * ignored the unknown ones (dyndbg in particular). Reusing
1469 * parse_args avoids ad-hoc parsing. This will also attempt
1470 * to activate queries for not-yet-loaded modules, which is
1471 * slightly noisy if verbose, but harmless.
1473 cmdline = kstrdup(saved_command_line, GFP_KERNEL);
1474 parse_args("dyndbg params", cmdline, NULL,
1475 0, 0, 0, NULL, &ddebug_dyndbg_boot_param_cb);
1480 ddebug_remove_all_tables();
1483 /* Allow early initialization for boot messages via boot param */
1484 early_initcall(dynamic_debug_init);
1486 /* Debugfs setup must be done later */
1487 fs_initcall(dynamic_debug_init_control);