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