Merge branch 'acpica-fixes'
[linux-2.6-block.git] / lib / dynamic_debug.c
CommitLineData
e9d376f0
JB
1/*
2 * lib/dynamic_debug.c
3 *
4 * make pr_debug()/dev_dbg() calls runtime configurable based upon their
5 * source module.
6 *
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.
8ba6ebf5 10 * Copyright (C) 2011 Bart Van Assche. All Rights Reserved.
578b1e07 11 * Copyright (C) 2013 Du, Changbin <changbin.du@gmail.com>
e9d376f0
JB
12 */
13
4ad275e5
JP
14#define pr_fmt(fmt) KBUILD_MODNAME ":%s: " fmt, __func__
15
e9d376f0
JB
16#include <linux/kernel.h>
17#include <linux/module.h>
fef15d2f
GKH
18#include <linux/moduleparam.h>
19#include <linux/kallsyms.h>
20#include <linux/types.h>
e9d376f0 21#include <linux/mutex.h>
fef15d2f 22#include <linux/proc_fs.h>
e9d376f0 23#include <linux/seq_file.h>
fef15d2f
GKH
24#include <linux/list.h>
25#include <linux/sysctl.h>
e9d376f0 26#include <linux/ctype.h>
fef15d2f 27#include <linux/string.h>
578b1e07 28#include <linux/parser.h>
d338b137 29#include <linux/string_helpers.h>
fef15d2f 30#include <linux/uaccess.h>
e9d376f0
JB
31#include <linux/dynamic_debug.h>
32#include <linux/debugfs.h>
5a0e3ad6 33#include <linux/slab.h>
fef15d2f 34#include <linux/jump_label.h>
8ba6ebf5 35#include <linux/hardirq.h>
e8d9792a 36#include <linux/sched.h>
fef15d2f 37#include <linux/device.h>
ffa10cb4 38#include <linux/netdevice.h>
e9d376f0
JB
39
40extern struct _ddebug __start___verbose[];
41extern struct _ddebug __stop___verbose[];
42
e9d376f0
JB
43struct ddebug_table {
44 struct list_head link;
3e406b1d 45 const char *mod_name;
e9d376f0 46 unsigned int num_ddebugs;
e9d376f0
JB
47 struct _ddebug *ddebugs;
48};
49
50struct 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;
56};
57
58struct ddebug_iter {
59 struct ddebug_table *table;
60 unsigned int idx;
61};
62
63static DEFINE_MUTEX(ddebug_lock);
64static LIST_HEAD(ddebug_tables);
f657fd21 65static int verbose;
74df138d 66module_param(verbose, int, 0644);
e9d376f0 67
2b678319
JC
68/* Return the path relative to source root */
69static inline const char *trim_prefix(const char *path)
70{
71 int skip = strlen(__FILE__) - strlen("lib/dynamic_debug.c");
72
73 if (strncmp(path, __FILE__, skip))
74 skip = 0; /* prefix mismatch, don't skip */
75
76 return path + skip;
77}
78
8ba6ebf5
BVA
79static 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' },
5ca7d2a6 85 { _DPRINTK_FLAGS_NONE, '_' },
8ba6ebf5
BVA
86};
87
e9d376f0
JB
88/* format a string into buf[] which describes the _ddebug's flags */
89static char *ddebug_describe_flags(struct _ddebug *dp, char *buf,
90 size_t maxlen)
91{
92 char *p = buf;
8ba6ebf5 93 int i;
e9d376f0 94
5ca7d2a6 95 BUG_ON(maxlen < 6);
8ba6ebf5
BVA
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;
e9d376f0 99 if (p == buf)
5ca7d2a6 100 *p++ = '_';
e9d376f0
JB
101 *p = '\0';
102
103 return buf;
104}
105
f657fd21 106#define vpr_info(fmt, ...) \
b8ccd5de 107do { \
f657fd21
JP
108 if (verbose) \
109 pr_info(fmt, ##__VA_ARGS__); \
574b3725
JC
110} while (0)
111
f657fd21
JP
112static void vpr_info_dq(const struct ddebug_query *query, const char *msg)
113{
114 /* trim any trailing newlines */
115 int fmtlen = 0;
116
117 if (query->format) {
118 fmtlen = strlen(query->format);
119 while (fmtlen && query->format[fmtlen - 1] == '\n')
120 fmtlen--;
121 }
122
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);
130}
131
e9d376f0 132/*
85f7f6c0
JC
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.
e9d376f0 137 */
85f7f6c0
JC
138static int ddebug_change(const struct ddebug_query *query,
139 unsigned int flags, unsigned int mask)
e9d376f0
JB
140{
141 int i;
142 struct ddebug_table *dt;
143 unsigned int newflags;
144 unsigned int nfound = 0;
5ca7d2a6 145 char flagbuf[10];
e9d376f0
JB
146
147 /* search for matching ddebugs */
148 mutex_lock(&ddebug_lock);
149 list_for_each_entry(dt, &ddebug_tables, link) {
150
151 /* match against the module name */
578b1e07
DC
152 if (query->module &&
153 !match_wildcard(query->module, dt->mod_name))
e9d376f0
JB
154 continue;
155
f657fd21 156 for (i = 0; i < dt->num_ddebugs; i++) {
e9d376f0
JB
157 struct _ddebug *dp = &dt->ddebugs[i];
158
159 /* match against the source filename */
d6a238d2 160 if (query->filename &&
578b1e07
DC
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)))
e9d376f0
JB
166 continue;
167
168 /* match against the function */
d6a238d2 169 if (query->function &&
578b1e07 170 !match_wildcard(query->function, dp->function))
e9d376f0
JB
171 continue;
172
173 /* match against the format */
d6a238d2
JC
174 if (query->format &&
175 !strstr(dp->format, query->format))
e9d376f0
JB
176 continue;
177
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;
185
186 nfound++;
187
188 newflags = (dp->flags & mask) | flags;
189 if (newflags == dp->flags)
190 continue;
e9d376f0 191 dp->flags = newflags;
b8ccd5de 192 vpr_info("changed %s:%d [%s]%s =%s\n",
f657fd21
JP
193 trim_prefix(dp->filename), dp->lineno,
194 dt->mod_name, dp->function,
195 ddebug_describe_flags(dp, flagbuf,
196 sizeof(flagbuf)));
e9d376f0
JB
197 }
198 }
199 mutex_unlock(&ddebug_lock);
200
201 if (!nfound && verbose)
4ad275e5 202 pr_info("no matches for query\n");
85f7f6c0
JC
203
204 return nfound;
e9d376f0
JB
205}
206
e9d376f0
JB
207/*
208 * Split the buffer `buf' into space-separated words.
9898abb3
GB
209 * Handles simple " and ' quoting, i.e. without nested,
210 * embedded or escaped \". Return the number of words
211 * or <0 on error.
e9d376f0
JB
212 */
213static int ddebug_tokenize(char *buf, char *words[], int maxwords)
214{
215 int nwords = 0;
216
9898abb3
GB
217 while (*buf) {
218 char *end;
219
220 /* Skip leading whitespace */
e7d2860b 221 buf = skip_spaces(buf);
9898abb3
GB
222 if (!*buf)
223 break; /* oh, it was trailing whitespace */
8bd6026e
JC
224 if (*buf == '#')
225 break; /* token starts comment, skip rest of line */
9898abb3 226
07100be7 227 /* find `end' of word, whitespace separated or quoted */
9898abb3
GB
228 if (*buf == '"' || *buf == '\'') {
229 int quote = *buf++;
f657fd21 230 for (end = buf; *end && *end != quote; end++)
9898abb3 231 ;
18c216c5
JC
232 if (!*end) {
233 pr_err("unclosed quote: %s\n", buf);
9898abb3 234 return -EINVAL; /* unclosed quote */
18c216c5 235 }
9898abb3 236 } else {
f657fd21 237 for (end = buf; *end && !isspace(*end); end++)
9898abb3
GB
238 ;
239 BUG_ON(end == buf);
240 }
9898abb3 241
07100be7 242 /* `buf' is start of word, `end' is one past its end */
18c216c5
JC
243 if (nwords == maxwords) {
244 pr_err("too many words, legal max <=%d\n", maxwords);
9898abb3 245 return -EINVAL; /* ran out of words[] before bytes */
18c216c5 246 }
9898abb3
GB
247 if (*end)
248 *end++ = '\0'; /* terminate the word */
249 words[nwords++] = buf;
250 buf = end;
251 }
e9d376f0
JB
252
253 if (verbose) {
254 int i;
4ad275e5 255 pr_info("split into words:");
f657fd21 256 for (i = 0; i < nwords; i++)
4ad275e5
JP
257 pr_cont(" \"%s\"", words[i]);
258 pr_cont("\n");
e9d376f0
JB
259 }
260
261 return nwords;
262}
263
264/*
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.
268 */
269static inline int parse_lineno(const char *str, unsigned int *val)
270{
e9d376f0
JB
271 BUG_ON(str == NULL);
272 if (*str == '\0') {
273 *val = 0;
274 return 0;
275 }
4592599a 276 if (kstrtouint(str, 10, val) < 0) {
18c216c5
JC
277 pr_err("bad line-number: %s\n", str);
278 return -EINVAL;
279 }
280 return 0;
e9d376f0
JB
281}
282
820874c7
JC
283static int check_set(const char **dest, char *src, char *name)
284{
285 int rc = 0;
286
287 if (*dest) {
288 rc = -EINVAL;
f657fd21
JP
289 pr_err("match-spec:%s val:%s overridden by %s\n",
290 name, *dest, src);
820874c7
JC
291 }
292 *dest = src;
293 return rc;
294}
295
e9d376f0
JB
296/*
297 * Parse words[] as a ddebug query specification, which is a series
298 * of (keyword, value) pairs chosen from these possibilities:
299 *
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
820874c7
JC
307 *
308 * Only 1 of each type is allowed.
309 * Returns 0 on success, <0 on error.
e9d376f0
JB
310 */
311static int ddebug_parse_query(char *words[], int nwords,
8e59b5cf 312 struct ddebug_query *query, const char *modname)
e9d376f0
JB
313{
314 unsigned int i;
bd8c154a 315 int rc = 0;
e9d376f0
JB
316
317 /* check we have an even number of words */
18c216c5
JC
318 if (nwords % 2 != 0) {
319 pr_err("expecting pairs of match-spec <value>\n");
e9d376f0 320 return -EINVAL;
18c216c5 321 }
e9d376f0
JB
322 memset(query, 0, sizeof(*query));
323
8e59b5cf
JC
324 if (modname)
325 /* support $modname.dyndbg=<multiple queries> */
326 query->module = modname;
327
f657fd21
JP
328 for (i = 0; i < nwords; i += 2) {
329 if (!strcmp(words[i], "func")) {
820874c7 330 rc = check_set(&query->function, words[i+1], "func");
f657fd21 331 } else if (!strcmp(words[i], "file")) {
820874c7 332 rc = check_set(&query->filename, words[i+1], "file");
f657fd21 333 } else if (!strcmp(words[i], "module")) {
820874c7 334 rc = check_set(&query->module, words[i+1], "module");
f657fd21 335 } else if (!strcmp(words[i], "format")) {
d338b137
AS
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");
f657fd21 340 } else if (!strcmp(words[i], "line")) {
e9d376f0
JB
341 char *first = words[i+1];
342 char *last = strchr(first, '-');
820874c7 343 if (query->first_lineno || query->last_lineno) {
18c216c5 344 pr_err("match-spec: line used 2x\n");
820874c7
JC
345 return -EINVAL;
346 }
e9d376f0
JB
347 if (last)
348 *last++ = '\0';
d9e133e6 349 if (parse_lineno(first, &query->first_lineno) < 0)
e9d376f0 350 return -EINVAL;
820874c7 351 if (last) {
e9d376f0 352 /* range <first>-<last> */
3ace678f
AR
353 if (parse_lineno(last, &query->last_lineno) < 0)
354 return -EINVAL;
355
356 if (query->last_lineno < query->first_lineno) {
18c216c5
JC
357 pr_err("last-line:%d < 1st-line:%d\n",
358 query->last_lineno,
359 query->first_lineno);
e9d376f0 360 return -EINVAL;
820874c7 361 }
e9d376f0
JB
362 } else {
363 query->last_lineno = query->first_lineno;
364 }
365 } else {
ae27f86a 366 pr_err("unknown keyword \"%s\"\n", words[i]);
e9d376f0
JB
367 return -EINVAL;
368 }
820874c7
JC
369 if (rc)
370 return rc;
e9d376f0 371 }
574b3725 372 vpr_info_dq(query, "parsed");
e9d376f0
JB
373 return 0;
374}
375
376/*
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.
381 */
382static int ddebug_parse_flags(const char *str, unsigned int *flagsp,
383 unsigned int *maskp)
384{
385 unsigned flags = 0;
8ba6ebf5 386 int op = '=', i;
e9d376f0
JB
387
388 switch (*str) {
389 case '+':
390 case '-':
391 case '=':
392 op = *str++;
393 break;
394 default:
18c216c5 395 pr_err("bad flag-op %c, at start of %s\n", *str, str);
e9d376f0
JB
396 return -EINVAL;
397 }
b8ccd5de 398 vpr_info("op='%c'\n", op);
e9d376f0 399
f657fd21 400 for (; *str ; ++str) {
8ba6ebf5
BVA
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;
405 }
e9d376f0 406 }
18c216c5
JC
407 if (i < 0) {
408 pr_err("unknown flag '%c' in \"%s\"\n", *str, str);
8ba6ebf5 409 return -EINVAL;
18c216c5 410 }
e9d376f0 411 }
b8ccd5de 412 vpr_info("flags=0x%x\n", flags);
e9d376f0
JB
413
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;
428 }
b8ccd5de 429 vpr_info("*flagsp=0x%x *maskp=0x%x\n", *flagsp, *maskp);
e9d376f0
JB
430 return 0;
431}
432
8e59b5cf 433static int ddebug_exec_query(char *query_string, const char *modname)
fd89cfb8
TR
434{
435 unsigned int flags = 0, mask = 0;
436 struct ddebug_query query;
437#define MAXWORDS 9
85f7f6c0 438 int nwords, nfound;
fd89cfb8
TR
439 char *words[MAXWORDS];
440
441 nwords = ddebug_tokenize(query_string, words, MAXWORDS);
18c216c5
JC
442 if (nwords <= 0) {
443 pr_err("tokenize failed\n");
fd89cfb8 444 return -EINVAL;
18c216c5
JC
445 }
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");
fd89cfb8 449 return -EINVAL;
18c216c5
JC
450 }
451 if (ddebug_parse_query(words, nwords-1, &query, modname)) {
452 pr_err("query parse failed\n");
fd89cfb8 453 return -EINVAL;
18c216c5 454 }
fd89cfb8 455 /* actually go and implement the change */
85f7f6c0 456 nfound = ddebug_change(&query, flags, mask);
f657fd21 457 vpr_info_dq(&query, nfound ? "applied" : "no-match");
85f7f6c0
JC
458
459 return nfound;
460}
461
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.
465*/
8e59b5cf 466static int ddebug_exec_queries(char *query, const char *modname)
85f7f6c0
JC
467{
468 char *split;
469 int i, errs = 0, exitcode = 0, rc, nfound = 0;
470
471 for (i = 0; query; query = split) {
472 split = strpbrk(query, ";\n");
473 if (split)
474 *split++ = '\0';
475
476 query = skip_spaces(query);
477 if (!query || !*query || *query == '#')
478 continue;
479
b8ccd5de 480 vpr_info("query %d: \"%s\"\n", i, query);
85f7f6c0 481
8e59b5cf 482 rc = ddebug_exec_query(query, modname);
85f7f6c0
JC
483 if (rc < 0) {
484 errs++;
485 exitcode = rc;
f657fd21 486 } else {
85f7f6c0 487 nfound += rc;
f657fd21 488 }
85f7f6c0
JC
489 i++;
490 }
b8ccd5de 491 vpr_info("processed %d queries, with %d matches, %d errs\n",
85f7f6c0
JC
492 i, nfound, errs);
493
494 if (exitcode)
495 return exitcode;
496 return nfound;
fd89cfb8
TR
497}
498
431625da
JB
499#define PREFIX_SIZE 64
500
501static int remaining(int wrote)
502{
503 if (PREFIX_SIZE - wrote > 0)
504 return PREFIX_SIZE - wrote;
505 return 0;
506}
507
508static char *dynamic_emit_prefix(const struct _ddebug *desc, char *buf)
8ba6ebf5 509{
431625da
JB
510 int pos_after_tid;
511 int pos = 0;
8ba6ebf5 512
798efc60
JP
513 *buf = '\0';
514
431625da 515 if (desc->flags & _DPRINTK_FLAGS_INCL_TID) {
8ba6ebf5 516 if (in_interrupt())
798efc60 517 pos += snprintf(buf + pos, remaining(pos), "<intr> ");
8ba6ebf5 518 else
431625da 519 pos += snprintf(buf + pos, remaining(pos), "[%d] ",
798efc60 520 task_pid_vnr(current));
8ba6ebf5 521 }
431625da
JB
522 pos_after_tid = pos;
523 if (desc->flags & _DPRINTK_FLAGS_INCL_MODNAME)
524 pos += snprintf(buf + pos, remaining(pos), "%s:",
798efc60 525 desc->modname);
431625da
JB
526 if (desc->flags & _DPRINTK_FLAGS_INCL_FUNCNAME)
527 pos += snprintf(buf + pos, remaining(pos), "%s:",
798efc60 528 desc->function);
431625da 529 if (desc->flags & _DPRINTK_FLAGS_INCL_LINENO)
07100be7 530 pos += snprintf(buf + pos, remaining(pos), "%d:",
798efc60 531 desc->lineno);
431625da
JB
532 if (pos - pos_after_tid)
533 pos += snprintf(buf + pos, remaining(pos), " ");
534 if (pos >= PREFIX_SIZE)
535 buf[PREFIX_SIZE - 1] = '\0';
6c2140ee 536
431625da 537 return buf;
6c2140ee
JP
538}
539
906d2015 540void __dynamic_pr_debug(struct _ddebug *descriptor, const char *fmt, ...)
8ba6ebf5
BVA
541{
542 va_list args;
431625da
JB
543 struct va_format vaf;
544 char buf[PREFIX_SIZE];
8ba6ebf5
BVA
545
546 BUG_ON(!descriptor);
547 BUG_ON(!fmt);
548
549 va_start(args, fmt);
798efc60 550
431625da
JB
551 vaf.fmt = fmt;
552 vaf.va = &args;
798efc60 553
906d2015 554 printk(KERN_DEBUG "%s%pV", dynamic_emit_prefix(descriptor, buf), &vaf);
798efc60 555
8ba6ebf5 556 va_end(args);
8ba6ebf5
BVA
557}
558EXPORT_SYMBOL(__dynamic_pr_debug);
559
906d2015 560void __dynamic_dev_dbg(struct _ddebug *descriptor,
cbc46635
JP
561 const struct device *dev, const char *fmt, ...)
562{
563 struct va_format vaf;
564 va_list args;
cbc46635
JP
565
566 BUG_ON(!descriptor);
567 BUG_ON(!fmt);
568
569 va_start(args, fmt);
798efc60 570
cbc46635
JP
571 vaf.fmt = fmt;
572 vaf.va = &args;
798efc60
JP
573
574 if (!dev) {
906d2015 575 printk(KERN_DEBUG "(NULL device *): %pV", &vaf);
798efc60
JP
576 } else {
577 char buf[PREFIX_SIZE];
798efc60 578
a39d4a85 579 dev_printk_emit(LOGLEVEL_DEBUG, dev, "%s%s %s: %pV",
906d2015
JP
580 dynamic_emit_prefix(descriptor, buf),
581 dev_driver_string(dev), dev_name(dev),
582 &vaf);
798efc60
JP
583 }
584
cbc46635 585 va_end(args);
cbc46635
JP
586}
587EXPORT_SYMBOL(__dynamic_dev_dbg);
588
0feefd97
JB
589#ifdef CONFIG_NET
590
906d2015
JP
591void __dynamic_netdev_dbg(struct _ddebug *descriptor,
592 const struct net_device *dev, const char *fmt, ...)
ffa10cb4
JB
593{
594 struct va_format vaf;
595 va_list args;
ffa10cb4
JB
596
597 BUG_ON(!descriptor);
598 BUG_ON(!fmt);
599
600 va_start(args, fmt);
b004ff49 601
ffa10cb4
JB
602 vaf.fmt = fmt;
603 vaf.va = &args;
b004ff49
JP
604
605 if (dev && dev->dev.parent) {
606 char buf[PREFIX_SIZE];
666f355f 607
a39d4a85 608 dev_printk_emit(LOGLEVEL_DEBUG, dev->dev.parent,
906d2015
JP
609 "%s%s %s %s%s: %pV",
610 dynamic_emit_prefix(descriptor, buf),
611 dev_driver_string(dev->dev.parent),
612 dev_name(dev->dev.parent),
613 netdev_name(dev), netdev_reg_state(dev),
614 &vaf);
b004ff49 615 } else if (dev) {
906d2015
JP
616 printk(KERN_DEBUG "%s%s: %pV", netdev_name(dev),
617 netdev_reg_state(dev), &vaf);
b004ff49 618 } else {
906d2015 619 printk(KERN_DEBUG "(NULL net_device): %pV", &vaf);
b004ff49
JP
620 }
621
ffa10cb4 622 va_end(args);
ffa10cb4
JB
623}
624EXPORT_SYMBOL(__dynamic_netdev_dbg);
625
0feefd97
JB
626#endif
627
bc757f6f
JC
628#define DDEBUG_STRING_SIZE 1024
629static __initdata char ddebug_setup_string[DDEBUG_STRING_SIZE];
630
a648ec05
TR
631static __init int ddebug_setup_query(char *str)
632{
bc757f6f 633 if (strlen(str) >= DDEBUG_STRING_SIZE) {
4ad275e5 634 pr_warn("ddebug boot param string too large\n");
a648ec05
TR
635 return 0;
636 }
bc757f6f 637 strlcpy(ddebug_setup_string, str, DDEBUG_STRING_SIZE);
a648ec05
TR
638 return 1;
639}
640
641__setup("ddebug_query=", ddebug_setup_query);
642
e9d376f0 643/*
231821d4 644 * File_ops->write method for <debugfs>/dynamic_debug/control. Gathers the
e9d376f0
JB
645 * command text from userspace, parses and executes it.
646 */
7281491c 647#define USER_BUF_PAGE 4096
e9d376f0
JB
648static ssize_t ddebug_proc_write(struct file *file, const char __user *ubuf,
649 size_t len, loff_t *offp)
650{
7281491c 651 char *tmpbuf;
fd89cfb8 652 int ret;
e9d376f0
JB
653
654 if (len == 0)
655 return 0;
7281491c
JC
656 if (len > USER_BUF_PAGE - 1) {
657 pr_warn("expected <%d bytes into control\n", USER_BUF_PAGE);
e9d376f0 658 return -E2BIG;
7281491c 659 }
16e5c1fc
AV
660 tmpbuf = memdup_user_nul(ubuf, len);
661 if (IS_ERR(tmpbuf))
662 return PTR_ERR(tmpbuf);
b8ccd5de 663 vpr_info("read %d bytes from userspace\n", (int)len);
e9d376f0 664
8e59b5cf 665 ret = ddebug_exec_queries(tmpbuf, NULL);
7281491c 666 kfree(tmpbuf);
85f7f6c0 667 if (ret < 0)
fd89cfb8 668 return ret;
e9d376f0
JB
669
670 *offp += len;
671 return len;
672}
673
674/*
675 * Set the iterator to point to the first _ddebug object
676 * and return a pointer to that first object. Returns
677 * NULL if there are no _ddebugs at all.
678 */
679static struct _ddebug *ddebug_iter_first(struct ddebug_iter *iter)
680{
681 if (list_empty(&ddebug_tables)) {
682 iter->table = NULL;
683 iter->idx = 0;
684 return NULL;
685 }
686 iter->table = list_entry(ddebug_tables.next,
687 struct ddebug_table, link);
688 iter->idx = 0;
689 return &iter->table->ddebugs[iter->idx];
690}
691
692/*
693 * Advance the iterator to point to the next _ddebug
694 * object from the one the iterator currently points at,
695 * and returns a pointer to the new _ddebug. Returns
696 * NULL if the iterator has seen all the _ddebugs.
697 */
698static struct _ddebug *ddebug_iter_next(struct ddebug_iter *iter)
699{
700 if (iter->table == NULL)
701 return NULL;
702 if (++iter->idx == iter->table->num_ddebugs) {
703 /* iterate to next table */
704 iter->idx = 0;
705 if (list_is_last(&iter->table->link, &ddebug_tables)) {
706 iter->table = NULL;
707 return NULL;
708 }
709 iter->table = list_entry(iter->table->link.next,
710 struct ddebug_table, link);
711 }
712 return &iter->table->ddebugs[iter->idx];
713}
714
715/*
716 * Seq_ops start method. Called at the start of every
717 * read() call from userspace. Takes the ddebug_lock and
718 * seeks the seq_file's iterator to the given position.
719 */
720static void *ddebug_proc_start(struct seq_file *m, loff_t *pos)
721{
722 struct ddebug_iter *iter = m->private;
723 struct _ddebug *dp;
724 int n = *pos;
725
b8ccd5de 726 vpr_info("called m=%p *pos=%lld\n", m, (unsigned long long)*pos);
e9d376f0
JB
727
728 mutex_lock(&ddebug_lock);
729
730 if (!n)
731 return SEQ_START_TOKEN;
732 if (n < 0)
733 return NULL;
734 dp = ddebug_iter_first(iter);
735 while (dp != NULL && --n > 0)
736 dp = ddebug_iter_next(iter);
737 return dp;
738}
739
740/*
741 * Seq_ops next method. Called several times within a read()
742 * call from userspace, with ddebug_lock held. Walks to the
743 * next _ddebug object with a special case for the header line.
744 */
745static void *ddebug_proc_next(struct seq_file *m, void *p, loff_t *pos)
746{
747 struct ddebug_iter *iter = m->private;
748 struct _ddebug *dp;
749
b8ccd5de 750 vpr_info("called m=%p p=%p *pos=%lld\n",
f657fd21 751 m, p, (unsigned long long)*pos);
e9d376f0
JB
752
753 if (p == SEQ_START_TOKEN)
754 dp = ddebug_iter_first(iter);
755 else
756 dp = ddebug_iter_next(iter);
757 ++*pos;
758 return dp;
759}
760
761/*
762 * Seq_ops show method. Called several times within a read()
763 * call from userspace, with ddebug_lock held. Formats the
764 * current _ddebug as a single human-readable line, with a
765 * special case for the header line.
766 */
767static int ddebug_proc_show(struct seq_file *m, void *p)
768{
769 struct ddebug_iter *iter = m->private;
770 struct _ddebug *dp = p;
5ca7d2a6 771 char flagsbuf[10];
e9d376f0 772
b8ccd5de 773 vpr_info("called m=%p p=%p\n", m, p);
e9d376f0
JB
774
775 if (p == SEQ_START_TOKEN) {
776 seq_puts(m,
f657fd21 777 "# filename:lineno [module]function flags format\n");
e9d376f0
JB
778 return 0;
779 }
780
5ca7d2a6 781 seq_printf(m, "%s:%u [%s]%s =%s \"",
f657fd21
JP
782 trim_prefix(dp->filename), dp->lineno,
783 iter->table->mod_name, dp->function,
784 ddebug_describe_flags(dp, flagsbuf, sizeof(flagsbuf)));
e9d376f0
JB
785 seq_escape(m, dp->format, "\t\r\n\"");
786 seq_puts(m, "\"\n");
787
788 return 0;
789}
790
791/*
792 * Seq_ops stop method. Called at the end of each read()
793 * call from userspace. Drops ddebug_lock.
794 */
795static void ddebug_proc_stop(struct seq_file *m, void *p)
796{
b8ccd5de 797 vpr_info("called m=%p p=%p\n", m, p);
e9d376f0
JB
798 mutex_unlock(&ddebug_lock);
799}
800
801static const struct seq_operations ddebug_proc_seqops = {
802 .start = ddebug_proc_start,
803 .next = ddebug_proc_next,
804 .show = ddebug_proc_show,
805 .stop = ddebug_proc_stop
806};
807
808/*
07100be7
JC
809 * File_ops->open method for <debugfs>/dynamic_debug/control. Does
810 * the seq_file setup dance, and also creates an iterator to walk the
811 * _ddebugs. Note that we create a seq_file always, even for O_WRONLY
812 * files where it's not needed, as doing so simplifies the ->release
813 * method.
e9d376f0
JB
814 */
815static int ddebug_proc_open(struct inode *inode, struct file *file)
816{
b8ccd5de 817 vpr_info("called\n");
4bad78c5
RJ
818 return seq_open_private(file, &ddebug_proc_seqops,
819 sizeof(struct ddebug_iter));
e9d376f0
JB
820}
821
822static const struct file_operations ddebug_proc_fops = {
823 .owner = THIS_MODULE,
824 .open = ddebug_proc_open,
825 .read = seq_read,
826 .llseek = seq_lseek,
827 .release = seq_release_private,
828 .write = ddebug_proc_write
829};
830
831/*
832 * Allocate a new ddebug_table for the given module
833 * and add it to the global list.
834 */
835int ddebug_add_module(struct _ddebug *tab, unsigned int n,
836 const char *name)
837{
838 struct ddebug_table *dt;
3e406b1d 839 const char *new_name;
e9d376f0
JB
840
841 dt = kzalloc(sizeof(*dt), GFP_KERNEL);
842 if (dt == NULL)
843 return -ENOMEM;
3e406b1d 844 new_name = kstrdup_const(name, GFP_KERNEL);
e9d376f0
JB
845 if (new_name == NULL) {
846 kfree(dt);
847 return -ENOMEM;
848 }
849 dt->mod_name = new_name;
850 dt->num_ddebugs = n;
e9d376f0
JB
851 dt->ddebugs = tab;
852
853 mutex_lock(&ddebug_lock);
854 list_add_tail(&dt->link, &ddebug_tables);
855 mutex_unlock(&ddebug_lock);
856
b8ccd5de 857 vpr_info("%u debug prints in module %s\n", n, dt->mod_name);
e9d376f0
JB
858 return 0;
859}
860EXPORT_SYMBOL_GPL(ddebug_add_module);
861
6ab676e9
JC
862/* helper for ddebug_dyndbg_(boot|module)_param_cb */
863static int ddebug_dyndbg_param_cb(char *param, char *val,
864 const char *modname, int on_err)
b48420c1 865{
b48420c1
JC
866 char *sep;
867
868 sep = strchr(param, '.');
869 if (sep) {
6ab676e9 870 /* needed only for ddebug_dyndbg_boot_param_cb */
b48420c1
JC
871 *sep = '\0';
872 modname = param;
873 param = sep + 1;
874 }
875 if (strcmp(param, "dyndbg"))
6ab676e9 876 return on_err; /* determined by caller */
b48420c1 877
8e59b5cf
JC
878 ddebug_exec_queries((val ? val : "+p"), modname);
879
b48420c1
JC
880 return 0; /* query failure shouldnt stop module load */
881}
882
6ab676e9
JC
883/* handle both dyndbg and $module.dyndbg params at boot */
884static int ddebug_dyndbg_boot_param_cb(char *param, char *val,
ecc86170 885 const char *unused, void *arg)
b48420c1 886{
6ab676e9
JC
887 vpr_info("%s=\"%s\"\n", param, val);
888 return ddebug_dyndbg_param_cb(param, val, NULL, 0);
889}
b48420c1 890
6ab676e9
JC
891/*
892 * modprobe foo finds foo.params in boot-args, strips "foo.", and
893 * passes them to load_module(). This callback gets unknown params,
894 * processes dyndbg params, rejects others.
895 */
896int ddebug_dyndbg_module_param_cb(char *param, char *val, const char *module)
897{
898 vpr_info("module: %s %s=\"%s\"\n", module, param, val);
899 return ddebug_dyndbg_param_cb(param, val, module, -ENOENT);
b48420c1
JC
900}
901
e9d376f0
JB
902static void ddebug_table_free(struct ddebug_table *dt)
903{
904 list_del_init(&dt->link);
3e406b1d 905 kfree_const(dt->mod_name);
e9d376f0
JB
906 kfree(dt);
907}
908
909/*
910 * Called in response to a module being unloaded. Removes
911 * any ddebug_table's which point at the module.
912 */
ff49d74a 913int ddebug_remove_module(const char *mod_name)
e9d376f0
JB
914{
915 struct ddebug_table *dt, *nextdt;
916 int ret = -ENOENT;
917
b8ccd5de 918 vpr_info("removing module \"%s\"\n", mod_name);
e9d376f0
JB
919
920 mutex_lock(&ddebug_lock);
921 list_for_each_entry_safe(dt, nextdt, &ddebug_tables, link) {
922 if (!strcmp(dt->mod_name, mod_name)) {
923 ddebug_table_free(dt);
924 ret = 0;
925 }
926 }
927 mutex_unlock(&ddebug_lock);
928 return ret;
929}
930EXPORT_SYMBOL_GPL(ddebug_remove_module);
931
932static void ddebug_remove_all_tables(void)
933{
934 mutex_lock(&ddebug_lock);
935 while (!list_empty(&ddebug_tables)) {
936 struct ddebug_table *dt = list_entry(ddebug_tables.next,
937 struct ddebug_table,
938 link);
939 ddebug_table_free(dt);
940 }
941 mutex_unlock(&ddebug_lock);
942}
943
6a5c083d
TR
944static __initdata int ddebug_init_success;
945
946static int __init dynamic_debug_init_debugfs(void)
e9d376f0
JB
947{
948 struct dentry *dir, *file;
6a5c083d
TR
949
950 if (!ddebug_init_success)
951 return -ENODEV;
e9d376f0
JB
952
953 dir = debugfs_create_dir("dynamic_debug", NULL);
954 if (!dir)
955 return -ENOMEM;
956 file = debugfs_create_file("control", 0644, dir, NULL,
957 &ddebug_proc_fops);
958 if (!file) {
959 debugfs_remove(dir);
960 return -ENOMEM;
961 }
6a5c083d
TR
962 return 0;
963}
964
965static int __init dynamic_debug_init(void)
966{
967 struct _ddebug *iter, *iter_start;
968 const char *modname = NULL;
b48420c1 969 char *cmdline;
6a5c083d 970 int ret = 0;
41076927
JC
971 int n = 0, entries = 0, modct = 0;
972 int verbose_bytes = 0;
6a5c083d 973
b5b78f83 974 if (__start___verbose == __stop___verbose) {
f657fd21 975 pr_warn("_ddebug table is empty in a CONFIG_DYNAMIC_DEBUG build\n");
b5b78f83
JC
976 return 1;
977 }
978 iter = __start___verbose;
979 modname = iter->modname;
980 iter_start = iter;
981 for (; iter < __stop___verbose; iter++) {
41076927
JC
982 entries++;
983 verbose_bytes += strlen(iter->modname) + strlen(iter->function)
984 + strlen(iter->filename) + strlen(iter->format);
985
b5b78f83 986 if (strcmp(modname, iter->modname)) {
41076927 987 modct++;
b5b78f83
JC
988 ret = ddebug_add_module(iter_start, n, modname);
989 if (ret)
af442399 990 goto out_err;
b5b78f83
JC
991 n = 0;
992 modname = iter->modname;
993 iter_start = iter;
e9d376f0 994 }
b5b78f83 995 n++;
e9d376f0 996 }
b5b78f83
JC
997 ret = ddebug_add_module(iter_start, n, modname);
998 if (ret)
af442399 999 goto out_err;
a648ec05 1000
af442399 1001 ddebug_init_success = 1;
f657fd21
JP
1002 vpr_info("%d modules, %d entries and %d bytes in ddebug tables, %d bytes in (readonly) verbose section\n",
1003 modct, entries, (int)(modct * sizeof(struct ddebug_table)),
1004 verbose_bytes + (int)(__stop___verbose - __start___verbose));
af442399
JC
1005
1006 /* apply ddebug_query boot param, dont unload tables on err */
a648ec05 1007 if (ddebug_setup_string[0] != '\0') {
f657fd21 1008 pr_warn("ddebug_query param name is deprecated, change it to dyndbg\n");
8e59b5cf 1009 ret = ddebug_exec_queries(ddebug_setup_string, NULL);
85f7f6c0 1010 if (ret < 0)
f657fd21 1011 pr_warn("Invalid ddebug boot param %s\n",
4ad275e5 1012 ddebug_setup_string);
a648ec05 1013 else
85f7f6c0 1014 pr_info("%d changes by ddebug_query\n", ret);
a648ec05 1015 }
b48420c1
JC
1016 /* now that ddebug tables are loaded, process all boot args
1017 * again to find and activate queries given in dyndbg params.
1018 * While this has already been done for known boot params, it
1019 * ignored the unknown ones (dyndbg in particular). Reusing
1020 * parse_args avoids ad-hoc parsing. This will also attempt
1021 * to activate queries for not-yet-loaded modules, which is
1022 * slightly noisy if verbose, but harmless.
1023 */
1024 cmdline = kstrdup(saved_command_line, GFP_KERNEL);
1025 parse_args("dyndbg params", cmdline, NULL,
ecc86170 1026 0, 0, 0, NULL, &ddebug_dyndbg_boot_param_cb);
b48420c1 1027 kfree(cmdline);
af442399 1028 return 0;
a648ec05 1029
af442399
JC
1030out_err:
1031 ddebug_remove_all_tables();
e9d376f0
JB
1032 return 0;
1033}
6a5c083d 1034/* Allow early initialization for boot messages via boot param */
3ec5652a 1035early_initcall(dynamic_debug_init);
b48420c1 1036
6a5c083d 1037/* Debugfs setup must be done later */
3ec5652a 1038fs_initcall(dynamic_debug_init_debugfs);