]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blame - lib/dynamic_debug.c
dynamic_debug: make dynamic-debug supersede DEBUG ccflag
[mirror_ubuntu-bionic-kernel.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.
e9d376f0
JB
11 */
12
4ad275e5
JP
13#define pr_fmt(fmt) KBUILD_MODNAME ":%s: " fmt, __func__
14
e9d376f0
JB
15#include <linux/kernel.h>
16#include <linux/module.h>
17#include <linux/moduleparam.h>
18#include <linux/kallsyms.h>
e9d376f0
JB
19#include <linux/types.h>
20#include <linux/mutex.h>
21#include <linux/proc_fs.h>
22#include <linux/seq_file.h>
23#include <linux/list.h>
24#include <linux/sysctl.h>
25#include <linux/ctype.h>
e7d2860b 26#include <linux/string.h>
e9d376f0
JB
27#include <linux/uaccess.h>
28#include <linux/dynamic_debug.h>
29#include <linux/debugfs.h>
5a0e3ad6 30#include <linux/slab.h>
52159d98 31#include <linux/jump_label.h>
8ba6ebf5 32#include <linux/hardirq.h>
e8d9792a 33#include <linux/sched.h>
cbc46635 34#include <linux/device.h>
ffa10cb4 35#include <linux/netdevice.h>
e9d376f0
JB
36
37extern struct _ddebug __start___verbose[];
38extern struct _ddebug __stop___verbose[];
39
e9d376f0
JB
40struct ddebug_table {
41 struct list_head link;
42 char *mod_name;
43 unsigned int num_ddebugs;
e9d376f0
JB
44 struct _ddebug *ddebugs;
45};
46
47struct ddebug_query {
48 const char *filename;
49 const char *module;
50 const char *function;
51 const char *format;
52 unsigned int first_lineno, last_lineno;
53};
54
55struct ddebug_iter {
56 struct ddebug_table *table;
57 unsigned int idx;
58};
59
60static DEFINE_MUTEX(ddebug_lock);
61static LIST_HEAD(ddebug_tables);
62static int verbose = 0;
63
64/* Return the last part of a pathname */
65static inline const char *basename(const char *path)
66{
67 const char *tail = strrchr(path, '/');
68 return tail ? tail+1 : path;
69}
70
8ba6ebf5
BVA
71static struct { unsigned flag:8; char opt_char; } opt_array[] = {
72 { _DPRINTK_FLAGS_PRINT, 'p' },
73 { _DPRINTK_FLAGS_INCL_MODNAME, 'm' },
74 { _DPRINTK_FLAGS_INCL_FUNCNAME, 'f' },
75 { _DPRINTK_FLAGS_INCL_LINENO, 'l' },
76 { _DPRINTK_FLAGS_INCL_TID, 't' },
77};
78
e9d376f0
JB
79/* format a string into buf[] which describes the _ddebug's flags */
80static char *ddebug_describe_flags(struct _ddebug *dp, char *buf,
81 size_t maxlen)
82{
83 char *p = buf;
8ba6ebf5 84 int i;
e9d376f0
JB
85
86 BUG_ON(maxlen < 4);
8ba6ebf5
BVA
87 for (i = 0; i < ARRAY_SIZE(opt_array); ++i)
88 if (dp->flags & opt_array[i].flag)
89 *p++ = opt_array[i].opt_char;
e9d376f0
JB
90 if (p == buf)
91 *p++ = '-';
92 *p = '\0';
93
94 return buf;
95}
96
e9d376f0
JB
97/*
98 * Search the tables for _ddebug's which match the given
99 * `query' and apply the `flags' and `mask' to them. Tells
100 * the user which ddebug's were changed, or whether none
101 * were matched.
102 */
103static void ddebug_change(const struct ddebug_query *query,
104 unsigned int flags, unsigned int mask)
105{
106 int i;
107 struct ddebug_table *dt;
108 unsigned int newflags;
109 unsigned int nfound = 0;
110 char flagbuf[8];
111
112 /* search for matching ddebugs */
113 mutex_lock(&ddebug_lock);
114 list_for_each_entry(dt, &ddebug_tables, link) {
115
116 /* match against the module name */
117 if (query->module != NULL &&
118 strcmp(query->module, dt->mod_name))
119 continue;
120
121 for (i = 0 ; i < dt->num_ddebugs ; i++) {
122 struct _ddebug *dp = &dt->ddebugs[i];
123
124 /* match against the source filename */
125 if (query->filename != NULL &&
126 strcmp(query->filename, dp->filename) &&
127 strcmp(query->filename, basename(dp->filename)))
128 continue;
129
130 /* match against the function */
131 if (query->function != NULL &&
132 strcmp(query->function, dp->function))
133 continue;
134
135 /* match against the format */
136 if (query->format != NULL &&
137 strstr(dp->format, query->format) == NULL)
138 continue;
139
140 /* match against the line number range */
141 if (query->first_lineno &&
142 dp->lineno < query->first_lineno)
143 continue;
144 if (query->last_lineno &&
145 dp->lineno > query->last_lineno)
146 continue;
147
148 nfound++;
149
150 newflags = (dp->flags & mask) | flags;
151 if (newflags == dp->flags)
152 continue;
e9d376f0 153 dp->flags = newflags;
e9d376f0 154 if (verbose)
4ad275e5 155 pr_info("changed %s:%d [%s]%s %s\n",
e9d376f0
JB
156 dp->filename, dp->lineno,
157 dt->mod_name, dp->function,
158 ddebug_describe_flags(dp, flagbuf,
159 sizeof(flagbuf)));
160 }
161 }
162 mutex_unlock(&ddebug_lock);
163
164 if (!nfound && verbose)
4ad275e5 165 pr_info("no matches for query\n");
e9d376f0
JB
166}
167
e9d376f0
JB
168/*
169 * Split the buffer `buf' into space-separated words.
9898abb3
GB
170 * Handles simple " and ' quoting, i.e. without nested,
171 * embedded or escaped \". Return the number of words
172 * or <0 on error.
e9d376f0
JB
173 */
174static int ddebug_tokenize(char *buf, char *words[], int maxwords)
175{
176 int nwords = 0;
177
9898abb3
GB
178 while (*buf) {
179 char *end;
180
181 /* Skip leading whitespace */
e7d2860b 182 buf = skip_spaces(buf);
9898abb3
GB
183 if (!*buf)
184 break; /* oh, it was trailing whitespace */
185
07100be7 186 /* find `end' of word, whitespace separated or quoted */
9898abb3
GB
187 if (*buf == '"' || *buf == '\'') {
188 int quote = *buf++;
189 for (end = buf ; *end && *end != quote ; end++)
190 ;
191 if (!*end)
192 return -EINVAL; /* unclosed quote */
193 } else {
194 for (end = buf ; *end && !isspace(*end) ; end++)
195 ;
196 BUG_ON(end == buf);
197 }
9898abb3 198
07100be7 199 /* `buf' is start of word, `end' is one past its end */
9898abb3
GB
200 if (nwords == maxwords)
201 return -EINVAL; /* ran out of words[] before bytes */
202 if (*end)
203 *end++ = '\0'; /* terminate the word */
204 words[nwords++] = buf;
205 buf = end;
206 }
e9d376f0
JB
207
208 if (verbose) {
209 int i;
4ad275e5 210 pr_info("split into words:");
e9d376f0 211 for (i = 0 ; i < nwords ; i++)
4ad275e5
JP
212 pr_cont(" \"%s\"", words[i]);
213 pr_cont("\n");
e9d376f0
JB
214 }
215
216 return nwords;
217}
218
219/*
220 * Parse a single line number. Note that the empty string ""
221 * is treated as a special case and converted to zero, which
222 * is later treated as a "don't care" value.
223 */
224static inline int parse_lineno(const char *str, unsigned int *val)
225{
226 char *end = NULL;
227 BUG_ON(str == NULL);
228 if (*str == '\0') {
229 *val = 0;
230 return 0;
231 }
232 *val = simple_strtoul(str, &end, 10);
233 return end == NULL || end == str || *end != '\0' ? -EINVAL : 0;
234}
235
236/*
237 * Undo octal escaping in a string, inplace. This is useful to
238 * allow the user to express a query which matches a format
239 * containing embedded spaces.
240 */
241#define isodigit(c) ((c) >= '0' && (c) <= '7')
242static char *unescape(char *str)
243{
244 char *in = str;
245 char *out = str;
246
247 while (*in) {
248 if (*in == '\\') {
249 if (in[1] == '\\') {
250 *out++ = '\\';
251 in += 2;
252 continue;
253 } else if (in[1] == 't') {
254 *out++ = '\t';
255 in += 2;
256 continue;
257 } else if (in[1] == 'n') {
258 *out++ = '\n';
259 in += 2;
260 continue;
261 } else if (isodigit(in[1]) &&
262 isodigit(in[2]) &&
263 isodigit(in[3])) {
264 *out++ = ((in[1] - '0')<<6) |
265 ((in[2] - '0')<<3) |
266 (in[3] - '0');
267 in += 4;
268 continue;
269 }
270 }
271 *out++ = *in++;
272 }
273 *out = '\0';
274
275 return str;
276}
277
278/*
279 * Parse words[] as a ddebug query specification, which is a series
280 * of (keyword, value) pairs chosen from these possibilities:
281 *
282 * func <function-name>
283 * file <full-pathname>
284 * file <base-filename>
285 * module <module-name>
286 * format <escaped-string-to-find-in-format>
287 * line <lineno>
288 * line <first-lineno>-<last-lineno> // where either may be empty
289 */
290static int ddebug_parse_query(char *words[], int nwords,
291 struct ddebug_query *query)
292{
293 unsigned int i;
294
295 /* check we have an even number of words */
296 if (nwords % 2 != 0)
297 return -EINVAL;
298 memset(query, 0, sizeof(*query));
299
300 for (i = 0 ; i < nwords ; i += 2) {
301 if (!strcmp(words[i], "func"))
302 query->function = words[i+1];
303 else if (!strcmp(words[i], "file"))
304 query->filename = words[i+1];
305 else if (!strcmp(words[i], "module"))
306 query->module = words[i+1];
307 else if (!strcmp(words[i], "format"))
308 query->format = unescape(words[i+1]);
309 else if (!strcmp(words[i], "line")) {
310 char *first = words[i+1];
311 char *last = strchr(first, '-');
312 if (last)
313 *last++ = '\0';
314 if (parse_lineno(first, &query->first_lineno) < 0)
315 return -EINVAL;
316 if (last != NULL) {
317 /* range <first>-<last> */
318 if (parse_lineno(last, &query->last_lineno) < 0)
319 return -EINVAL;
320 } else {
321 query->last_lineno = query->first_lineno;
322 }
323 } else {
324 if (verbose)
4ad275e5 325 pr_err("unknown keyword \"%s\"\n", words[i]);
e9d376f0
JB
326 return -EINVAL;
327 }
328 }
329
330 if (verbose)
4ad275e5
JP
331 pr_info("q->function=\"%s\" q->filename=\"%s\" "
332 "q->module=\"%s\" q->format=\"%s\" q->lineno=%u-%u\n",
333 query->function, query->filename,
e9d376f0
JB
334 query->module, query->format, query->first_lineno,
335 query->last_lineno);
336
337 return 0;
338}
339
340/*
341 * Parse `str' as a flags specification, format [-+=][p]+.
342 * Sets up *maskp and *flagsp to be used when changing the
343 * flags fields of matched _ddebug's. Returns 0 on success
344 * or <0 on error.
345 */
346static int ddebug_parse_flags(const char *str, unsigned int *flagsp,
347 unsigned int *maskp)
348{
349 unsigned flags = 0;
8ba6ebf5 350 int op = '=', i;
e9d376f0
JB
351
352 switch (*str) {
353 case '+':
354 case '-':
355 case '=':
356 op = *str++;
357 break;
358 default:
359 return -EINVAL;
360 }
361 if (verbose)
4ad275e5 362 pr_info("op='%c'\n", op);
e9d376f0
JB
363
364 for ( ; *str ; ++str) {
8ba6ebf5
BVA
365 for (i = ARRAY_SIZE(opt_array) - 1; i >= 0; i--) {
366 if (*str == opt_array[i].opt_char) {
367 flags |= opt_array[i].flag;
368 break;
369 }
e9d376f0 370 }
8ba6ebf5
BVA
371 if (i < 0)
372 return -EINVAL;
e9d376f0
JB
373 }
374 if (flags == 0)
375 return -EINVAL;
376 if (verbose)
4ad275e5 377 pr_info("flags=0x%x\n", flags);
e9d376f0
JB
378
379 /* calculate final *flagsp, *maskp according to mask and op */
380 switch (op) {
381 case '=':
382 *maskp = 0;
383 *flagsp = flags;
384 break;
385 case '+':
386 *maskp = ~0U;
387 *flagsp = flags;
388 break;
389 case '-':
390 *maskp = ~flags;
391 *flagsp = 0;
392 break;
393 }
394 if (verbose)
4ad275e5 395 pr_info("*flagsp=0x%x *maskp=0x%x\n", *flagsp, *maskp);
e9d376f0
JB
396 return 0;
397}
398
fd89cfb8
TR
399static int ddebug_exec_query(char *query_string)
400{
401 unsigned int flags = 0, mask = 0;
402 struct ddebug_query query;
403#define MAXWORDS 9
404 int nwords;
405 char *words[MAXWORDS];
406
407 nwords = ddebug_tokenize(query_string, words, MAXWORDS);
408 if (nwords <= 0)
409 return -EINVAL;
410 if (ddebug_parse_query(words, nwords-1, &query))
411 return -EINVAL;
412 if (ddebug_parse_flags(words[nwords-1], &flags, &mask))
413 return -EINVAL;
414
415 /* actually go and implement the change */
416 ddebug_change(&query, flags, mask);
417 return 0;
418}
419
431625da
JB
420#define PREFIX_SIZE 64
421
422static int remaining(int wrote)
423{
424 if (PREFIX_SIZE - wrote > 0)
425 return PREFIX_SIZE - wrote;
426 return 0;
427}
428
429static char *dynamic_emit_prefix(const struct _ddebug *desc, char *buf)
8ba6ebf5 430{
431625da
JB
431 int pos_after_tid;
432 int pos = 0;
8ba6ebf5 433
431625da
JB
434 pos += snprintf(buf + pos, remaining(pos), "%s", KERN_DEBUG);
435 if (desc->flags & _DPRINTK_FLAGS_INCL_TID) {
8ba6ebf5 436 if (in_interrupt())
431625da
JB
437 pos += snprintf(buf + pos, remaining(pos), "%s ",
438 "<intr>");
8ba6ebf5 439 else
431625da
JB
440 pos += snprintf(buf + pos, remaining(pos), "[%d] ",
441 task_pid_vnr(current));
8ba6ebf5 442 }
431625da
JB
443 pos_after_tid = pos;
444 if (desc->flags & _DPRINTK_FLAGS_INCL_MODNAME)
445 pos += snprintf(buf + pos, remaining(pos), "%s:",
446 desc->modname);
447 if (desc->flags & _DPRINTK_FLAGS_INCL_FUNCNAME)
448 pos += snprintf(buf + pos, remaining(pos), "%s:",
449 desc->function);
450 if (desc->flags & _DPRINTK_FLAGS_INCL_LINENO)
07100be7
JC
451 pos += snprintf(buf + pos, remaining(pos), "%d:",
452 desc->lineno);
431625da
JB
453 if (pos - pos_after_tid)
454 pos += snprintf(buf + pos, remaining(pos), " ");
455 if (pos >= PREFIX_SIZE)
456 buf[PREFIX_SIZE - 1] = '\0';
6c2140ee 457
431625da 458 return buf;
6c2140ee
JP
459}
460
8ba6ebf5
BVA
461int __dynamic_pr_debug(struct _ddebug *descriptor, const char *fmt, ...)
462{
463 va_list args;
464 int res;
431625da
JB
465 struct va_format vaf;
466 char buf[PREFIX_SIZE];
8ba6ebf5
BVA
467
468 BUG_ON(!descriptor);
469 BUG_ON(!fmt);
470
471 va_start(args, fmt);
431625da
JB
472 vaf.fmt = fmt;
473 vaf.va = &args;
474 res = printk("%s%pV", dynamic_emit_prefix(descriptor, buf), &vaf);
8ba6ebf5
BVA
475 va_end(args);
476
477 return res;
478}
479EXPORT_SYMBOL(__dynamic_pr_debug);
480
cbc46635
JP
481int __dynamic_dev_dbg(struct _ddebug *descriptor,
482 const struct device *dev, const char *fmt, ...)
483{
484 struct va_format vaf;
485 va_list args;
486 int res;
431625da 487 char buf[PREFIX_SIZE];
cbc46635
JP
488
489 BUG_ON(!descriptor);
490 BUG_ON(!fmt);
491
492 va_start(args, fmt);
cbc46635
JP
493 vaf.fmt = fmt;
494 vaf.va = &args;
431625da 495 res = __dev_printk(dynamic_emit_prefix(descriptor, buf), dev, &vaf);
cbc46635
JP
496 va_end(args);
497
498 return res;
499}
500EXPORT_SYMBOL(__dynamic_dev_dbg);
501
0feefd97
JB
502#ifdef CONFIG_NET
503
ffa10cb4
JB
504int __dynamic_netdev_dbg(struct _ddebug *descriptor,
505 const struct net_device *dev, const char *fmt, ...)
506{
507 struct va_format vaf;
508 va_list args;
509 int res;
431625da 510 char buf[PREFIX_SIZE];
ffa10cb4
JB
511
512 BUG_ON(!descriptor);
513 BUG_ON(!fmt);
514
515 va_start(args, fmt);
ffa10cb4
JB
516 vaf.fmt = fmt;
517 vaf.va = &args;
431625da 518 res = __netdev_printk(dynamic_emit_prefix(descriptor, buf), dev, &vaf);
ffa10cb4
JB
519 va_end(args);
520
521 return res;
522}
523EXPORT_SYMBOL(__dynamic_netdev_dbg);
524
0feefd97
JB
525#endif
526
a648ec05
TR
527static __initdata char ddebug_setup_string[1024];
528static __init int ddebug_setup_query(char *str)
529{
530 if (strlen(str) >= 1024) {
4ad275e5 531 pr_warn("ddebug boot param string too large\n");
a648ec05
TR
532 return 0;
533 }
534 strcpy(ddebug_setup_string, str);
535 return 1;
536}
537
538__setup("ddebug_query=", ddebug_setup_query);
539
e9d376f0
JB
540/*
541 * File_ops->write method for <debugfs>/dynamic_debug/conrol. Gathers the
542 * command text from userspace, parses and executes it.
543 */
544static ssize_t ddebug_proc_write(struct file *file, const char __user *ubuf,
545 size_t len, loff_t *offp)
546{
e9d376f0 547 char tmpbuf[256];
fd89cfb8 548 int ret;
e9d376f0
JB
549
550 if (len == 0)
551 return 0;
552 /* we don't check *offp -- multiple writes() are allowed */
553 if (len > sizeof(tmpbuf)-1)
554 return -E2BIG;
555 if (copy_from_user(tmpbuf, ubuf, len))
556 return -EFAULT;
557 tmpbuf[len] = '\0';
558 if (verbose)
4ad275e5 559 pr_info("read %d bytes from userspace\n", (int)len);
e9d376f0 560
fd89cfb8
TR
561 ret = ddebug_exec_query(tmpbuf);
562 if (ret)
563 return ret;
e9d376f0
JB
564
565 *offp += len;
566 return len;
567}
568
569/*
570 * Set the iterator to point to the first _ddebug object
571 * and return a pointer to that first object. Returns
572 * NULL if there are no _ddebugs at all.
573 */
574static struct _ddebug *ddebug_iter_first(struct ddebug_iter *iter)
575{
576 if (list_empty(&ddebug_tables)) {
577 iter->table = NULL;
578 iter->idx = 0;
579 return NULL;
580 }
581 iter->table = list_entry(ddebug_tables.next,
582 struct ddebug_table, link);
583 iter->idx = 0;
584 return &iter->table->ddebugs[iter->idx];
585}
586
587/*
588 * Advance the iterator to point to the next _ddebug
589 * object from the one the iterator currently points at,
590 * and returns a pointer to the new _ddebug. Returns
591 * NULL if the iterator has seen all the _ddebugs.
592 */
593static struct _ddebug *ddebug_iter_next(struct ddebug_iter *iter)
594{
595 if (iter->table == NULL)
596 return NULL;
597 if (++iter->idx == iter->table->num_ddebugs) {
598 /* iterate to next table */
599 iter->idx = 0;
600 if (list_is_last(&iter->table->link, &ddebug_tables)) {
601 iter->table = NULL;
602 return NULL;
603 }
604 iter->table = list_entry(iter->table->link.next,
605 struct ddebug_table, link);
606 }
607 return &iter->table->ddebugs[iter->idx];
608}
609
610/*
611 * Seq_ops start method. Called at the start of every
612 * read() call from userspace. Takes the ddebug_lock and
613 * seeks the seq_file's iterator to the given position.
614 */
615static void *ddebug_proc_start(struct seq_file *m, loff_t *pos)
616{
617 struct ddebug_iter *iter = m->private;
618 struct _ddebug *dp;
619 int n = *pos;
620
621 if (verbose)
4ad275e5 622 pr_info("called m=%p *pos=%lld\n", m, (unsigned long long)*pos);
e9d376f0
JB
623
624 mutex_lock(&ddebug_lock);
625
626 if (!n)
627 return SEQ_START_TOKEN;
628 if (n < 0)
629 return NULL;
630 dp = ddebug_iter_first(iter);
631 while (dp != NULL && --n > 0)
632 dp = ddebug_iter_next(iter);
633 return dp;
634}
635
636/*
637 * Seq_ops next method. Called several times within a read()
638 * call from userspace, with ddebug_lock held. Walks to the
639 * next _ddebug object with a special case for the header line.
640 */
641static void *ddebug_proc_next(struct seq_file *m, void *p, loff_t *pos)
642{
643 struct ddebug_iter *iter = m->private;
644 struct _ddebug *dp;
645
646 if (verbose)
4ad275e5
JP
647 pr_info("called m=%p p=%p *pos=%lld\n",
648 m, p, (unsigned long long)*pos);
e9d376f0
JB
649
650 if (p == SEQ_START_TOKEN)
651 dp = ddebug_iter_first(iter);
652 else
653 dp = ddebug_iter_next(iter);
654 ++*pos;
655 return dp;
656}
657
658/*
659 * Seq_ops show method. Called several times within a read()
660 * call from userspace, with ddebug_lock held. Formats the
661 * current _ddebug as a single human-readable line, with a
662 * special case for the header line.
663 */
664static int ddebug_proc_show(struct seq_file *m, void *p)
665{
666 struct ddebug_iter *iter = m->private;
667 struct _ddebug *dp = p;
668 char flagsbuf[8];
669
670 if (verbose)
4ad275e5 671 pr_info("called m=%p p=%p\n", m, p);
e9d376f0
JB
672
673 if (p == SEQ_START_TOKEN) {
674 seq_puts(m,
675 "# filename:lineno [module]function flags format\n");
676 return 0;
677 }
678
679 seq_printf(m, "%s:%u [%s]%s %s \"",
680 dp->filename, dp->lineno,
681 iter->table->mod_name, dp->function,
682 ddebug_describe_flags(dp, flagsbuf, sizeof(flagsbuf)));
683 seq_escape(m, dp->format, "\t\r\n\"");
684 seq_puts(m, "\"\n");
685
686 return 0;
687}
688
689/*
690 * Seq_ops stop method. Called at the end of each read()
691 * call from userspace. Drops ddebug_lock.
692 */
693static void ddebug_proc_stop(struct seq_file *m, void *p)
694{
695 if (verbose)
4ad275e5 696 pr_info("called m=%p p=%p\n", m, p);
e9d376f0
JB
697 mutex_unlock(&ddebug_lock);
698}
699
700static const struct seq_operations ddebug_proc_seqops = {
701 .start = ddebug_proc_start,
702 .next = ddebug_proc_next,
703 .show = ddebug_proc_show,
704 .stop = ddebug_proc_stop
705};
706
707/*
07100be7
JC
708 * File_ops->open method for <debugfs>/dynamic_debug/control. Does
709 * the seq_file setup dance, and also creates an iterator to walk the
710 * _ddebugs. Note that we create a seq_file always, even for O_WRONLY
711 * files where it's not needed, as doing so simplifies the ->release
712 * method.
e9d376f0
JB
713 */
714static int ddebug_proc_open(struct inode *inode, struct file *file)
715{
716 struct ddebug_iter *iter;
717 int err;
718
719 if (verbose)
4ad275e5 720 pr_info("called\n");
e9d376f0
JB
721
722 iter = kzalloc(sizeof(*iter), GFP_KERNEL);
723 if (iter == NULL)
724 return -ENOMEM;
725
726 err = seq_open(file, &ddebug_proc_seqops);
727 if (err) {
728 kfree(iter);
729 return err;
730 }
731 ((struct seq_file *) file->private_data)->private = iter;
732 return 0;
733}
734
735static const struct file_operations ddebug_proc_fops = {
736 .owner = THIS_MODULE,
737 .open = ddebug_proc_open,
738 .read = seq_read,
739 .llseek = seq_lseek,
740 .release = seq_release_private,
741 .write = ddebug_proc_write
742};
743
744/*
745 * Allocate a new ddebug_table for the given module
746 * and add it to the global list.
747 */
748int ddebug_add_module(struct _ddebug *tab, unsigned int n,
749 const char *name)
750{
751 struct ddebug_table *dt;
752 char *new_name;
753
754 dt = kzalloc(sizeof(*dt), GFP_KERNEL);
755 if (dt == NULL)
756 return -ENOMEM;
757 new_name = kstrdup(name, GFP_KERNEL);
758 if (new_name == NULL) {
759 kfree(dt);
760 return -ENOMEM;
761 }
762 dt->mod_name = new_name;
763 dt->num_ddebugs = n;
e9d376f0
JB
764 dt->ddebugs = tab;
765
766 mutex_lock(&ddebug_lock);
767 list_add_tail(&dt->link, &ddebug_tables);
768 mutex_unlock(&ddebug_lock);
769
770 if (verbose)
4ad275e5 771 pr_info("%u debug prints in module %s\n", n, dt->mod_name);
e9d376f0
JB
772 return 0;
773}
774EXPORT_SYMBOL_GPL(ddebug_add_module);
775
776static void ddebug_table_free(struct ddebug_table *dt)
777{
778 list_del_init(&dt->link);
779 kfree(dt->mod_name);
780 kfree(dt);
781}
782
783/*
784 * Called in response to a module being unloaded. Removes
785 * any ddebug_table's which point at the module.
786 */
ff49d74a 787int ddebug_remove_module(const char *mod_name)
e9d376f0
JB
788{
789 struct ddebug_table *dt, *nextdt;
790 int ret = -ENOENT;
791
792 if (verbose)
4ad275e5 793 pr_info("removing module \"%s\"\n", mod_name);
e9d376f0
JB
794
795 mutex_lock(&ddebug_lock);
796 list_for_each_entry_safe(dt, nextdt, &ddebug_tables, link) {
797 if (!strcmp(dt->mod_name, mod_name)) {
798 ddebug_table_free(dt);
799 ret = 0;
800 }
801 }
802 mutex_unlock(&ddebug_lock);
803 return ret;
804}
805EXPORT_SYMBOL_GPL(ddebug_remove_module);
806
807static void ddebug_remove_all_tables(void)
808{
809 mutex_lock(&ddebug_lock);
810 while (!list_empty(&ddebug_tables)) {
811 struct ddebug_table *dt = list_entry(ddebug_tables.next,
812 struct ddebug_table,
813 link);
814 ddebug_table_free(dt);
815 }
816 mutex_unlock(&ddebug_lock);
817}
818
6a5c083d
TR
819static __initdata int ddebug_init_success;
820
821static int __init dynamic_debug_init_debugfs(void)
e9d376f0
JB
822{
823 struct dentry *dir, *file;
6a5c083d
TR
824
825 if (!ddebug_init_success)
826 return -ENODEV;
e9d376f0
JB
827
828 dir = debugfs_create_dir("dynamic_debug", NULL);
829 if (!dir)
830 return -ENOMEM;
831 file = debugfs_create_file("control", 0644, dir, NULL,
832 &ddebug_proc_fops);
833 if (!file) {
834 debugfs_remove(dir);
835 return -ENOMEM;
836 }
6a5c083d
TR
837 return 0;
838}
839
840static int __init dynamic_debug_init(void)
841{
842 struct _ddebug *iter, *iter_start;
843 const char *modname = NULL;
844 int ret = 0;
845 int n = 0;
846
e9d376f0
JB
847 if (__start___verbose != __stop___verbose) {
848 iter = __start___verbose;
849 modname = iter->modname;
850 iter_start = iter;
851 for (; iter < __stop___verbose; iter++) {
852 if (strcmp(modname, iter->modname)) {
853 ret = ddebug_add_module(iter_start, n, modname);
854 if (ret)
855 goto out_free;
856 n = 0;
857 modname = iter->modname;
858 iter_start = iter;
859 }
860 n++;
861 }
862 ret = ddebug_add_module(iter_start, n, modname);
863 }
a648ec05
TR
864
865 /* ddebug_query boot param got passed -> set it up */
866 if (ddebug_setup_string[0] != '\0') {
867 ret = ddebug_exec_query(ddebug_setup_string);
868 if (ret)
4ad275e5
JP
869 pr_warn("Invalid ddebug boot param %s",
870 ddebug_setup_string);
a648ec05
TR
871 else
872 pr_info("ddebug initialized with string %s",
873 ddebug_setup_string);
874 }
875
e9d376f0 876out_free:
6a5c083d 877 if (ret)
e9d376f0 878 ddebug_remove_all_tables();
6a5c083d
TR
879 else
880 ddebug_init_success = 1;
e9d376f0
JB
881 return 0;
882}
6a5c083d
TR
883/* Allow early initialization for boot messages via boot param */
884arch_initcall(dynamic_debug_init);
885/* Debugfs setup must be done later */
886module_init(dynamic_debug_init_debugfs);