/* * 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. * Copyright (C) 2011 Bart Van Assche. All Rights Reserved. */ #define pr_fmt(fmt) KBUILD_MODNAME ":%s: " fmt, __func__ #include <linux/kernel.h>#include <linux/module.h>#include <linux/moduleparam.h>#include <linux/kallsyms.h>#include <linux/types.h>#include <linux/mutex.h>#include <linux/proc_fs.h>#include <linux/seq_file.h>#include <linux/list.h>#include <linux/sysctl.h>#include <linux/ctype.h>#include <linux/string.h>#include <linux/uaccess.h>#include <linux/dynamic_debug.h>#include <linux/debugfs.h>#include <linux/slab.h>#include <linux/jump_label.h>#include <linux/hardirq.h>#include <linux/sched.h>#include <linux/device.h>#include <linux/netdevice.h> extern struct _ddebug __start___verbose[];extern struct _ddebug __stop___verbose[]; struct ddebug_table { struct list_head link; char *mod_name; unsigned int num_ddebugs; 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);static int verbose = 0;module_param(verbose, int, 0644); /* Return the last part of a pathname */static inline const char *basename(const char *path){ const char *tail = strrchr(path, '/'); return tail ? tail+1 : path;} /* 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;} 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' }, { _DPRINTK_FLAGS_NONE, '_' },}; /* 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; int i; BUG_ON(maxlen < 6); for (i = 0; i < ARRAY_SIZE(opt_array); ++i) if (dp->flags & opt_array[i].flag) *p++ = opt_array[i].opt_char; if (p == buf) *p++ = '_'; *p = '\0'; return buf;} #define vpr_info_dq(q, msg) \do { \ if (verbose) \ /* trim last char off format print */ \ pr_info("%s: func=\"%s\" file=\"%s\" " \ "module=\"%s\" format=\"%.*s\" " \ "lineno=%u-%u", \ msg, \ q->function ? q->function : "", \ q->filename ? q->filename : "", \ q->module ? q->module : "", \ (int)(q->format ? strlen(q->format) - 1 : 0), \ q->format ? q->format : "", \ q->first_lineno, q->last_lineno); \} while (0) /* * 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. */static int ddebug_change(const struct ddebug_query *query, unsigned int flags, unsigned int mask){ int i; struct ddebug_table *dt; unsigned int newflags; unsigned int nfound = 0; char flagbuf[10]; /* search for matching ddebugs */ mutex_lock(&ddebug_lock); list_for_each_entry(dt, &ddebug_tables, link) { /* match against the module name */ if (query->module && strcmp(query->module, dt->mod_name)) continue; for (i = 0 ; i < dt->num_ddebugs ; i++) { struct _ddebug *dp = &dt->ddebugs[i]; /* match against the source filename */ if (query->filename && strcmp(query->filename, dp->filename) && strcmp(query->filename, basename(dp->filename)) && strcmp(query->filename, trim_prefix(dp->filename))) continue; /* match against the function */ if (query->function && strcmp(query->function, dp->function)) continue; /* match against the format */ if (query->format && !strstr(dp->format, query->format)) 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; dp->flags = newflags; if (verbose) pr_info("changed %s:%d [%s]%s =%s\n", trim_prefix(dp->filename), dp->lineno, dt->mod_name, dp->function, ddebug_describe_flags(dp, flagbuf, sizeof(flagbuf))); } } mutex_unlock(&ddebug_lock); if (!nfound && verbose) pr_info("no matches for query\n"); return nfound;} /* * Split the buffer `buf' into space-separated words. * Handles simple " and ' quoting, i.e. without nested, * embedded or escaped \". Return the number of words * or <0 on error. */static int ddebug_tokenize(char *buf, char *words[], int maxwords){ int nwords = 0; while (*buf) { char *end; /* Skip leading whitespace */ buf = skip_spaces(buf); if (!*buf) break; /* oh, it was trailing whitespace */ if (*buf == '#') break; /* token starts comment, skip rest of line */ /* find `end' of word, whitespace separated or quoted */ if (*buf == '"' || *buf == '\'') { int quote = *buf++; for (end = buf ; *end && *end != quote ; end++) ; if (!*end) return -EINVAL; /* unclosed quote */ } else { for (end = buf ; *end && !isspace(*end) ; end++) ; BUG_ON(end == buf); } /* `buf' is start of word, `end' is one past its end */ if (nwords == maxwords) return -EINVAL; /* ran out of words[] before bytes */ if (*end) *end++ = '\0'; /* terminate the word */ words[nwords++] = buf; buf = end; } if (verbose) { int i; pr_info("split into words:"); for (i = 0 ; i < nwords ; i++) pr_cont(" \"%s\"", words[i]); pr_cont("\n"); } 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){ char *end = NULL; BUG_ON(str == NULL); if (*str == '\0') { *val = 0; return 0; } *val = simple_strtoul(str, &end, 10); return end == NULL || end == str || *end != '\0' ? -EINVAL : 0;} /* * Undo octal escaping in a string, inplace. This is useful to * allow the user to express a query which matches a format * containing embedded spaces. */#define isodigit(c) ((c) >= '0' && (c) <= '7')static char *unescape(char *str){ char *in = str; char *out = str; while (*in) { if (*in == '\\') { if (in[1] == '\\') { *out++ = '\\'; in += 2; continue; } else if (in[1] == 't') { *out++ = '\t'; in += 2; continue; } else if (in[1] == 'n') { *out++ = '\n'; in += 2; continue; } else if (isodigit(in[1]) && isodigit(in[2]) && isodigit(in[3])) { *out++ = ((in[1] - '0')<<6) | ((in[2] - '0')<<3) | (in[3] - '0'); in += 4; continue; } } *out++ = *in++; } *out = '\0'; return str;} static int check_set(const char **dest, char *src, char *name){ int rc = 0; if (*dest) { rc = -EINVAL; pr_err("match-spec:%s val:%s overridden by %s", name, *dest, src); } *dest = src; return rc;} /* * 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 * * Only 1 of each type is allowed. * Returns 0 on success, <0 on error. */static int ddebug_parse_query(char *words[], int nwords, struct ddebug_query *query){ unsigned int i; int rc; /* check we have an even number of words */ if (nwords % 2 != 0) return -EINVAL; memset(query, 0, sizeof(*query)); for (i = 0 ; i < nwords ; i += 2) { if (!strcmp(words[i], "func")) rc = check_set(&query->function, words[i+1], "func"); else if (!strcmp(words[i], "file")) rc = check_set(&query->filename, words[i+1], "file"); else if (!strcmp(words[i], "module")) rc = check_set(&query->module, words[i+1], "module"); else if (!strcmp(words[i], "format")) rc = check_set(&query->format, unescape(words[i+1]), "format"); else if (!strcmp(words[i], "line")) { char *first = words[i+1]; char *last = strchr(first, '-'); if (query->first_lineno || query->last_lineno) { pr_err("match-spec:line given 2 times\n"); return -EINVAL; } if (last) *last++ = '\0'; if (parse_lineno(first, &query->first_lineno) < 0) return -EINVAL; if (last) { /* range <first>-<last> */ if (parse_lineno(last, &query->last_lineno) < query->first_lineno) { pr_err("last-line < 1st-line\n"); return -EINVAL; } } else { query->last_lineno = query->first_lineno; } } else { pr_err("unknown keyword \"%s\"\n", words[i]); return -EINVAL; } if (rc) return rc; } vpr_info_dq(query, "parsed"); 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; int op = '=', i; switch (*str) { case '+': case '-': case '=': op = *str++; break; default: return -EINVAL; } if (verbose) pr_info("op='%c'\n", op); for ( ; *str ; ++str) { for (i = ARRAY_SIZE(opt_array) - 1; i >= 0; i--) { if (*str == opt_array[i].opt_char) { flags |= opt_array[i].flag; break; } } if (i < 0) return -EINVAL; } if (verbose) pr_info("flags=0x%x\n", flags); /* 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; } if (verbose) pr_info("*flagsp=0x%x *maskp=0x%x\n", *flagsp, *maskp); return 0;} static int ddebug_exec_query(char *query_string){ unsigned int flags = 0, mask = 0; struct ddebug_query query;#define MAXWORDS 9 int nwords, nfound; char *words[MAXWORDS]; nwords = ddebug_tokenize(query_string, words, MAXWORDS); if (nwords <= 0) return -EINVAL; if (ddebug_parse_query(words, nwords-1, &query)) return -EINVAL; if (ddebug_parse_flags(words[nwords-1], &flags, &mask)) return -EINVAL; /* actually go and implement the change */ nfound = ddebug_change(&query, flags, mask); vpr_info_dq((&query), (nfound) ? "applied" : "no-match"); 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.*/static int ddebug_exec_queries(char *query){ char *split; int i, errs = 0, exitcode = 0, rc, nfound = 0; for (i = 0; query; query = split) { split = strpbrk(query, ";\n"); if (split) *split++ = '\0'; query = skip_spaces(query); if (!query || !*query || *query == '#') continue; if (verbose) pr_info("query %d: \"%s\"\n", i, query); rc = ddebug_exec_query(query); if (rc < 0) { errs++; exitcode = rc; } else nfound += rc; i++; }Lines 1–500 of 992. Load more
/* * 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. * Copyright (C) 2011 Bart Van Assche. All Rights Reserved. */ #define pr_fmt(fmt) KBUILD_MODNAME ":%s: " fmt, __func__ #include <linux/kernel.h> #include <linux/module.h> #include <linux/moduleparam.h> #include <linux/kallsyms.h> #include <linux/types.h> #include <linux/mutex.h> #include <linux/proc_fs.h> #include <linux/seq_file.h> #include <linux/list.h> #include <linux/sysctl.h> #include <linux/ctype.h> #include <linux/string.h> #include <linux/uaccess.h> #include <linux/dynamic_debug.h> #include <linux/debugfs.h> #include <linux/slab.h> #include <linux/jump_label.h> #include <linux/hardirq.h> #include <linux/sched.h> #include <linux/device.h> #include <linux/netdevice.h> extern struct _ddebug __start___verbose[]; extern struct _ddebug __stop___verbose[]; struct ddebug_table { struct list_head link; char *mod_name; unsigned int num_ddebugs; 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); static int verbose = 0; module_param(verbose, int, 0644); /* Return the last part of a pathname */ static inline const char *basename(const char *path) { const char *tail = strrchr(path, '/'); return tail ? tail+1 : path; } /* 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; } 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' }, { _DPRINTK_FLAGS_NONE, '_' }, }; /* 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; int i; BUG_ON(maxlen < 6); for (i = 0; i < ARRAY_SIZE(opt_array); ++i) if (dp->flags & opt_array[i].flag) *p++ = opt_array[i].opt_char; if (p == buf) *p++ = '_'; *p = '\0'; return buf; } #define vpr_info_dq(q, msg) \ do { \ if (verbose) \ /* trim last char off format print */ \ pr_info("%s: func=\"%s\" file=\"%s\" " \ "module=\"%s\" format=\"%.*s\" " \ "lineno=%u-%u", \ msg, \ q->function ? q->function : "", \ q->filename ? q->filename : "", \ q->module ? q->module : "", \ (int)(q->format ? strlen(q->format) - 1 : 0), \ q->format ? q->format : "", \ q->first_lineno, q->last_lineno); \ } while (0) /* * 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. */ static int ddebug_change(const struct ddebug_query *query, unsigned int flags, unsigned int mask) { int i; struct ddebug_table *dt; unsigned int newflags; unsigned int nfound = 0; char flagbuf[10]; /* search for matching ddebugs */ mutex_lock(&ddebug_lock); list_for_each_entry(dt, &ddebug_tables, link) { /* match against the module name */ if (query->module && strcmp(query->module, dt->mod_name)) continue; for (i = 0 ; i < dt->num_ddebugs ; i++) { struct _ddebug *dp = &dt->ddebugs[i]; /* match against the source filename */ if (query->filename && strcmp(query->filename, dp->filename) && strcmp(query->filename, basename(dp->filename)) && strcmp(query->filename, trim_prefix(dp->filename))) continue; /* match against the function */ if (query->function && strcmp(query->function, dp->function)) continue; /* match against the format */ if (query->format && !strstr(dp->format, query->format)) 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; dp->flags = newflags; if (verbose) pr_info("changed %s:%d [%s]%s =%s\n", trim_prefix(dp->filename), dp->lineno, dt->mod_name, dp->function, ddebug_describe_flags(dp, flagbuf, sizeof(flagbuf))); } } mutex_unlock(&ddebug_lock); if (!nfound && verbose) pr_info("no matches for query\n"); return nfound; } /* * Split the buffer `buf' into space-separated words. * Handles simple " and ' quoting, i.e. without nested, * embedded or escaped \". Return the number of words * or <0 on error. */ static int ddebug_tokenize(char *buf, char *words[], int maxwords) { int nwords = 0; while (*buf) { char *end; /* Skip leading whitespace */ buf = skip_spaces(buf); if (!*buf) break; /* oh, it was trailing whitespace */ if (*buf == '#') break; /* token starts comment, skip rest of line */ /* find `end' of word, whitespace separated or quoted */ if (*buf == '"' || *buf == '\'') { int quote = *buf++; for (end = buf ; *end && *end != quote ; end++) ; if (!*end) return -EINVAL; /* unclosed quote */ } else { for (end = buf ; *end && !isspace(*end) ; end++) ; BUG_ON(end == buf); } /* `buf' is start of word, `end' is one past its end */ if (nwords == maxwords) return -EINVAL; /* ran out of words[] before bytes */ if (*end) *end++ = '\0'; /* terminate the word */ words[nwords++] = buf; buf = end; } if (verbose) { int i; pr_info("split into words:"); for (i = 0 ; i < nwords ; i++) pr_cont(" \"%s\"", words[i]); pr_cont("\n"); } 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) { char *end = NULL; BUG_ON(str == NULL); if (*str == '\0') { *val = 0; return 0; } *val = simple_strtoul(str, &end, 10); return end == NULL || end == str || *end != '\0' ? -EINVAL : 0; } /* * Undo octal escaping in a string, inplace. This is useful to * allow the user to express a query which matches a format * containing embedded spaces. */ #define isodigit(c) ((c) >= '0' && (c) <= '7') static char *unescape(char *str) { char *in = str; char *out = str; while (*in) { if (*in == '\\') { if (in[1] == '\\') { *out++ = '\\'; in += 2; continue; } else if (in[1] == 't') { *out++ = '\t'; in += 2; continue; } else if (in[1] == 'n') { *out++ = '\n'; in += 2; continue; } else if (isodigit(in[1]) && isodigit(in[2]) && isodigit(in[3])) { *out++ = ((in[1] - '0')<<6) | ((in[2] - '0')<<3) | (in[3] - '0'); in += 4; continue; } } *out++ = *in++; } *out = '\0'; return str; } static int check_set(const char **dest, char *src, char *name) { int rc = 0; if (*dest) { rc = -EINVAL; pr_err("match-spec:%s val:%s overridden by %s", name, *dest, src); } *dest = src; return rc; } /* * 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 * * Only 1 of each type is allowed. * Returns 0 on success, <0 on error. */ static int ddebug_parse_query(char *words[], int nwords, struct ddebug_query *query) { unsigned int i; int rc; /* check we have an even number of words */ if (nwords % 2 != 0) return -EINVAL; memset(query, 0, sizeof(*query)); for (i = 0 ; i < nwords ; i += 2) { if (!strcmp(words[i], "func")) rc = check_set(&query->function, words[i+1], "func"); else if (!strcmp(words[i], "file")) rc = check_set(&query->filename, words[i+1], "file"); else if (!strcmp(words[i], "module")) rc = check_set(&query->module, words[i+1], "module"); else if (!strcmp(words[i], "format")) rc = check_set(&query->format, unescape(words[i+1]), "format"); else if (!strcmp(words[i], "line")) { char *first = words[i+1]; char *last = strchr(first, '-'); if (query->first_lineno || query->last_lineno) { pr_err("match-spec:line given 2 times\n"); return -EINVAL; } if (last) *last++ = '\0'; if (parse_lineno(first, &query->first_lineno) < 0) return -EINVAL; if (last) { /* range <first>-<last> */ if (parse_lineno(last, &query->last_lineno) < query->first_lineno) { pr_err("last-line < 1st-line\n"); return -EINVAL; } } else { query->last_lineno = query->first_lineno; } } else { pr_err("unknown keyword \"%s\"\n", words[i]); return -EINVAL; } if (rc) return rc; } vpr_info_dq(query, "parsed"); 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; int op = '=', i; switch (*str) { case '+': case '-': case '=': op = *str++; break; default: return -EINVAL; } if (verbose) pr_info("op='%c'\n", op); for ( ; *str ; ++str) { for (i = ARRAY_SIZE(opt_array) - 1; i >= 0; i--) { if (*str == opt_array[i].opt_char) { flags |= opt_array[i].flag; break; } } if (i < 0) return -EINVAL; } if (verbose) pr_info("flags=0x%x\n", flags); /* 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; } if (verbose) pr_info("*flagsp=0x%x *maskp=0x%x\n", *flagsp, *maskp); return 0; } static int ddebug_exec_query(char *query_string) { unsigned int flags = 0, mask = 0; struct ddebug_query query; #define MAXWORDS 9 int nwords, nfound; char *words[MAXWORDS]; nwords = ddebug_tokenize(query_string, words, MAXWORDS); if (nwords <= 0) return -EINVAL; if (ddebug_parse_query(words, nwords-1, &query)) return -EINVAL; if (ddebug_parse_flags(words[nwords-1], &flags, &mask)) return -EINVAL; /* actually go and implement the change */ nfound = ddebug_change(&query, flags, mask); vpr_info_dq((&query), (nfound) ? "applied" : "no-match"); 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. */ static int ddebug_exec_queries(char *query) { char *split; int i, errs = 0, exitcode = 0, rc, nfound = 0; for (i = 0; query; query = split) { split = strpbrk(query, ";\n"); if (split) *split++ = '\0'; query = skip_spaces(query); if (!query || !*query || *query == '#') continue; if (verbose) pr_info("query %d: \"%s\"\n", i, query); rc = ddebug_exec_query(query); if (rc < 0) { errs++; exitcode = rc; } else nfound += rc; i++; }