dynamic_debug.c 21.8 KB
Newer Older
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.
B
Bart Van Assche 已提交
10
 * Copyright (C) 2011 Bart Van Assche.  All Rights Reserved.
11 12
 */

13 14
#define pr_fmt(fmt) KBUILD_MODNAME ":%s: " fmt, __func__

15 16 17 18 19 20 21 22 23 24 25
#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>
26
#include <linux/string.h>
27 28 29
#include <linux/uaccess.h>
#include <linux/dynamic_debug.h>
#include <linux/debugfs.h>
30
#include <linux/slab.h>
31
#include <linux/jump_label.h>
B
Bart Van Assche 已提交
32
#include <linux/hardirq.h>
33
#include <linux/sched.h>
34
#include <linux/device.h>
35
#include <linux/netdevice.h>
36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62

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;
63
module_param(verbose, int, 0644);
64 65 66 67 68 69 70 71

/* 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;
}

72 73 74 75 76 77 78 79 80 81 82
/* 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;
}

B
Bart Van Assche 已提交
83 84 85 86 87 88
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' },
89
	{ _DPRINTK_FLAGS_NONE, '_' },
B
Bart Van Assche 已提交
90 91
};

92 93 94 95 96
/* 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;
B
Bart Van Assche 已提交
97
	int i;
98

99
	BUG_ON(maxlen < 6);
B
Bart Van Assche 已提交
100 101 102
	for (i = 0; i < ARRAY_SIZE(opt_array); ++i)
		if (dp->flags & opt_array[i].flag)
			*p++ = opt_array[i].opt_char;
103
	if (p == buf)
104
		*p++ = '_';
105 106 107 108 109
	*p = '\0';

	return buf;
}

110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125
#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)

126 127 128 129 130 131 132 133 134 135 136 137 138
/*
 * Search the tables for _ddebug's which match the given
 * `query' and apply the `flags' and `mask' to them.  Tells
 * the user which ddebug's were changed, or whether none
 * were matched.
 */
static void 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;
139
	char flagbuf[10];
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 */
146
		if (query->module && strcmp(query->module, dt->mod_name))
147 148 149 150 151 152
			continue;

		for (i = 0 ; i < dt->num_ddebugs ; i++) {
			struct _ddebug *dp = &dt->ddebugs[i];

			/* match against the source filename */
153
			if (query->filename &&
154
			    strcmp(query->filename, dp->filename) &&
155 156
			    strcmp(query->filename, basename(dp->filename)) &&
			    strcmp(query->filename, trim_prefix(dp->filename)))
157 158 159
				continue;

			/* match against the function */
160
			if (query->function &&
161 162 163 164
			    strcmp(query->function, dp->function))
				continue;

			/* match against the format */
165 166
			if (query->format &&
			    !strstr(dp->format, query->format))
167 168 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;
			dp->flags = newflags;
			if (verbose)
184
				pr_info("changed %s:%d [%s]%s =%s\n",
185
					trim_prefix(dp->filename), dp->lineno,
186 187 188 189 190 191 192 193
					dt->mod_name, dp->function,
					ddebug_describe_flags(dp, flagbuf,
							sizeof(flagbuf)));
		}
	}
	mutex_unlock(&ddebug_lock);

	if (!nfound && verbose)
194
		pr_info("no matches for query\n");
195 196 197 198
}

/*
 * Split the buffer `buf' into space-separated words.
199 200 201
 * Handles simple " and ' quoting, i.e. without nested,
 * embedded or escaped \".  Return the number of words
 * or <0 on error.
202 203 204 205 206
 */
static int ddebug_tokenize(char *buf, char *words[], int maxwords)
{
	int nwords = 0;

207 208 209 210
	while (*buf) {
		char *end;

		/* Skip leading whitespace */
211
		buf = skip_spaces(buf);
212 213
		if (!*buf)
			break;	/* oh, it was trailing whitespace */
214 215
		if (*buf == '#')
			break;	/* token starts comment, skip rest of line */
216

217
		/* find `end' of word, whitespace separated or quoted */
218 219 220 221 222 223 224 225 226 227 228 229
		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);
		}

230
		/* `buf' is start of word, `end' is one past its end */
231 232 233 234 235 236 237
		if (nwords == maxwords)
			return -EINVAL;	/* ran out of words[] before bytes */
		if (*end)
			*end++ = '\0';	/* terminate the word */
		words[nwords++] = buf;
		buf = end;
	}
238 239 240

	if (verbose) {
		int i;
241
		pr_info("split into words:");
242
		for (i = 0 ; i < nwords ; i++)
243 244
			pr_cont(" \"%s\"", words[i]);
		pr_cont("\n");
245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308
	}

	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;
}

309 310 311 312 313 314 315 316 317 318 319 320 321
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;
}

322 323 324 325 326 327 328 329 330 331 332
/*
 * 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
333 334 335
 *
 * Only 1 of each type is allowed.
 * Returns 0 on success, <0 on error.
336 337 338 339 340
 */
static int ddebug_parse_query(char *words[], int nwords,
			       struct ddebug_query *query)
{
	unsigned int i;
341
	int rc;
342 343 344 345 346 347 348 349

	/* 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"))
350
			rc = check_set(&query->function, words[i+1], "func");
351
		else if (!strcmp(words[i], "file"))
352
			rc = check_set(&query->filename, words[i+1], "file");
353
		else if (!strcmp(words[i], "module"))
354
			rc = check_set(&query->module, words[i+1], "module");
355
		else if (!strcmp(words[i], "format"))
356 357
			rc = check_set(&query->format, unescape(words[i+1]),
				"format");
358 359 360
		else if (!strcmp(words[i], "line")) {
			char *first = words[i+1];
			char *last = strchr(first, '-');
361 362 363 364
			if (query->first_lineno || query->last_lineno) {
				pr_err("match-spec:line given 2 times\n");
				return -EINVAL;
			}
365 366 367 368
			if (last)
				*last++ = '\0';
			if (parse_lineno(first, &query->first_lineno) < 0)
				return -EINVAL;
369
			if (last) {
370
				/* range <first>-<last> */
371 372 373
				if (parse_lineno(last, &query->last_lineno)
				    < query->first_lineno) {
					pr_err("last-line < 1st-line\n");
374
					return -EINVAL;
375
				}
376 377 378 379
			} else {
				query->last_lineno = query->first_lineno;
			}
		} else {
380
			pr_err("unknown keyword \"%s\"\n", words[i]);
381 382
			return -EINVAL;
		}
383 384
		if (rc)
			return rc;
385
	}
386
	vpr_info_dq(query, "parsed");
387 388 389 390 391 392 393 394 395 396 397 398 399
	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;
B
Bart Van Assche 已提交
400
	int op = '=', i;
401 402 403 404 405 406 407 408 409 410 411

	switch (*str) {
	case '+':
	case '-':
	case '=':
		op = *str++;
		break;
	default:
		return -EINVAL;
	}
	if (verbose)
412
		pr_info("op='%c'\n", op);
413 414

	for ( ; *str ; ++str) {
B
Bart Van Assche 已提交
415 416 417 418 419
		for (i = ARRAY_SIZE(opt_array) - 1; i >= 0; i--) {
			if (*str == opt_array[i].opt_char) {
				flags |= opt_array[i].flag;
				break;
			}
420
		}
B
Bart Van Assche 已提交
421 422
		if (i < 0)
			return -EINVAL;
423 424
	}
	if (verbose)
425
		pr_info("flags=0x%x\n", flags);
426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442

	/* 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)
443
		pr_info("*flagsp=0x%x *maskp=0x%x\n", *flagsp, *maskp);
444 445 446
	return 0;
}

447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467
static int ddebug_exec_query(char *query_string)
{
	unsigned int flags = 0, mask = 0;
	struct ddebug_query query;
#define MAXWORDS 9
	int nwords;
	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 */
	ddebug_change(&query, flags, mask);
	return 0;
}

468 469 470 471 472 473 474 475 476 477
#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)
B
Bart Van Assche 已提交
478
{
479 480
	int pos_after_tid;
	int pos = 0;
B
Bart Van Assche 已提交
481

482 483
	pos += snprintf(buf + pos, remaining(pos), "%s", KERN_DEBUG);
	if (desc->flags & _DPRINTK_FLAGS_INCL_TID) {
B
Bart Van Assche 已提交
484
		if (in_interrupt())
485 486
			pos += snprintf(buf + pos, remaining(pos), "%s ",
						"<intr>");
B
Bart Van Assche 已提交
487
		else
488 489
			pos += snprintf(buf + pos, remaining(pos), "[%d] ",
						task_pid_vnr(current));
B
Bart Van Assche 已提交
490
	}
491 492 493 494 495 496 497 498
	pos_after_tid = pos;
	if (desc->flags & _DPRINTK_FLAGS_INCL_MODNAME)
		pos += snprintf(buf + pos, remaining(pos), "%s:",
					desc->modname);
	if (desc->flags & _DPRINTK_FLAGS_INCL_FUNCNAME)
		pos += snprintf(buf + pos, remaining(pos), "%s:",
					desc->function);
	if (desc->flags & _DPRINTK_FLAGS_INCL_LINENO)
499 500
		pos += snprintf(buf + pos, remaining(pos), "%d:",
					desc->lineno);
501 502 503 504
	if (pos - pos_after_tid)
		pos += snprintf(buf + pos, remaining(pos), " ");
	if (pos >= PREFIX_SIZE)
		buf[PREFIX_SIZE - 1] = '\0';
505

506
	return buf;
507 508
}

B
Bart Van Assche 已提交
509 510 511 512
int __dynamic_pr_debug(struct _ddebug *descriptor, const char *fmt, ...)
{
	va_list args;
	int res;
513 514
	struct va_format vaf;
	char buf[PREFIX_SIZE];
B
Bart Van Assche 已提交
515 516 517 518 519

	BUG_ON(!descriptor);
	BUG_ON(!fmt);

	va_start(args, fmt);
520 521 522
	vaf.fmt = fmt;
	vaf.va = &args;
	res = printk("%s%pV", dynamic_emit_prefix(descriptor, buf), &vaf);
B
Bart Van Assche 已提交
523 524 525 526 527 528
	va_end(args);

	return res;
}
EXPORT_SYMBOL(__dynamic_pr_debug);

529 530 531 532 533 534
int __dynamic_dev_dbg(struct _ddebug *descriptor,
		      const struct device *dev, const char *fmt, ...)
{
	struct va_format vaf;
	va_list args;
	int res;
535
	char buf[PREFIX_SIZE];
536 537 538 539 540 541 542

	BUG_ON(!descriptor);
	BUG_ON(!fmt);

	va_start(args, fmt);
	vaf.fmt = fmt;
	vaf.va = &args;
543
	res = __dev_printk(dynamic_emit_prefix(descriptor, buf), dev, &vaf);
544 545 546 547 548 549
	va_end(args);

	return res;
}
EXPORT_SYMBOL(__dynamic_dev_dbg);

550 551
#ifdef CONFIG_NET

552 553 554 555 556 557
int __dynamic_netdev_dbg(struct _ddebug *descriptor,
		      const struct net_device *dev, const char *fmt, ...)
{
	struct va_format vaf;
	va_list args;
	int res;
558
	char buf[PREFIX_SIZE];
559 560 561 562 563 564 565

	BUG_ON(!descriptor);
	BUG_ON(!fmt);

	va_start(args, fmt);
	vaf.fmt = fmt;
	vaf.va = &args;
566
	res = __netdev_printk(dynamic_emit_prefix(descriptor, buf), dev, &vaf);
567 568 569 570 571 572
	va_end(args);

	return res;
}
EXPORT_SYMBOL(__dynamic_netdev_dbg);

573 574
#endif

575 576 577
#define DDEBUG_STRING_SIZE 1024
static __initdata char ddebug_setup_string[DDEBUG_STRING_SIZE];

578 579
static __init int ddebug_setup_query(char *str)
{
580
	if (strlen(str) >= DDEBUG_STRING_SIZE) {
581
		pr_warn("ddebug boot param string too large\n");
582 583
		return 0;
	}
584
	strlcpy(ddebug_setup_string, str, DDEBUG_STRING_SIZE);
585 586 587 588 589
	return 1;
}

__setup("ddebug_query=", ddebug_setup_query);

590 591 592 593
/*
 * File_ops->write method for <debugfs>/dynamic_debug/conrol.  Gathers the
 * command text from userspace, parses and executes it.
 */
594
#define USER_BUF_PAGE 4096
595 596 597
static ssize_t ddebug_proc_write(struct file *file, const char __user *ubuf,
				  size_t len, loff_t *offp)
{
598
	char *tmpbuf;
599
	int ret;
600 601 602

	if (len == 0)
		return 0;
603 604
	if (len > USER_BUF_PAGE - 1) {
		pr_warn("expected <%d bytes into control\n", USER_BUF_PAGE);
605
		return -E2BIG;
606 607 608 609 610 611
	}
	tmpbuf = kmalloc(len + 1, GFP_KERNEL);
	if (!tmpbuf)
		return -ENOMEM;
	if (copy_from_user(tmpbuf, ubuf, len)) {
		kfree(tmpbuf);
612
		return -EFAULT;
613
	}
614 615
	tmpbuf[len] = '\0';
	if (verbose)
616
		pr_info("read %d bytes from userspace\n", (int)len);
617

618
	ret = ddebug_exec_query(tmpbuf);
619
	kfree(tmpbuf);
620 621
	if (ret)
		return ret;
622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679

	*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;

	if (verbose)
680
		pr_info("called m=%p *pos=%lld\n", m, (unsigned long long)*pos);
681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704

	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;

	if (verbose)
705 706
		pr_info("called m=%p p=%p *pos=%lld\n",
			m, p, (unsigned long long)*pos);
707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725

	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;
726
	char flagsbuf[10];
727 728

	if (verbose)
729
		pr_info("called m=%p p=%p\n", m, p);
730 731 732 733 734 735 736

	if (p == SEQ_START_TOKEN) {
		seq_puts(m,
			"# filename:lineno [module]function flags format\n");
		return 0;
	}

737
	seq_printf(m, "%s:%u [%s]%s =%s \"",
738
		trim_prefix(dp->filename), dp->lineno,
739 740
		iter->table->mod_name, dp->function,
		ddebug_describe_flags(dp, flagsbuf, sizeof(flagsbuf)));
741 742 743 744 745 746 747 748 749 750 751 752 753
	seq_escape(m, dp->format, "\t\r\n\"");
	seq_puts(m, "\"\n");

	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)
{
	if (verbose)
754
		pr_info("called m=%p p=%p\n", m, p);
755 756 757 758 759 760 761 762 763 764 765
	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
};

/*
766 767 768 769 770
 * 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.
771 772 773 774 775 776 777
 */
static int ddebug_proc_open(struct inode *inode, struct file *file)
{
	struct ddebug_iter *iter;
	int err;

	if (verbose)
778
		pr_info("called\n");
779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828

	iter = kzalloc(sizeof(*iter), GFP_KERNEL);
	if (iter == NULL)
		return -ENOMEM;

	err = seq_open(file, &ddebug_proc_seqops);
	if (err) {
		kfree(iter);
		return err;
	}
	((struct seq_file *) file->private_data)->private = iter;
	return 0;
}

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;
	char *new_name;

	dt = kzalloc(sizeof(*dt), GFP_KERNEL);
	if (dt == NULL)
		return -ENOMEM;
	new_name = kstrdup(name, GFP_KERNEL);
	if (new_name == NULL) {
		kfree(dt);
		return -ENOMEM;
	}
	dt->mod_name = new_name;
	dt->num_ddebugs = n;
	dt->ddebugs = tab;

	mutex_lock(&ddebug_lock);
	list_add_tail(&dt->link, &ddebug_tables);
	mutex_unlock(&ddebug_lock);

	if (verbose)
829
		pr_info("%u debug prints in module %s\n", n, dt->mod_name);
830 831 832 833 834 835 836 837 838 839 840 841 842 843 844
	return 0;
}
EXPORT_SYMBOL_GPL(ddebug_add_module);

static void ddebug_table_free(struct ddebug_table *dt)
{
	list_del_init(&dt->link);
	kfree(dt->mod_name);
	kfree(dt);
}

/*
 * Called in response to a module being unloaded.  Removes
 * any ddebug_table's which point at the module.
 */
845
int ddebug_remove_module(const char *mod_name)
846 847 848 849 850
{
	struct ddebug_table *dt, *nextdt;
	int ret = -ENOENT;

	if (verbose)
851
		pr_info("removing module \"%s\"\n", mod_name);
852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876

	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);
}

877 878 879
static __initdata int ddebug_init_success;

static int __init dynamic_debug_init_debugfs(void)
880 881
{
	struct dentry *dir, *file;
882 883 884

	if (!ddebug_init_success)
		return -ENODEV;
885 886 887 888 889 890 891 892 893 894

	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;
	}
895 896 897 898 899 900 901 902 903 904
	return 0;
}

static int __init dynamic_debug_init(void)
{
	struct _ddebug *iter, *iter_start;
	const char *modname = NULL;
	int ret = 0;
	int n = 0;

905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920
	if (__start___verbose == __stop___verbose) {
		pr_warn("_ddebug table is empty in a "
			"CONFIG_DYNAMIC_DEBUG build");
		return 1;
	}
	iter = __start___verbose;
	modname = iter->modname;
	iter_start = iter;
	for (; iter < __stop___verbose; iter++) {
		if (strcmp(modname, iter->modname)) {
			ret = ddebug_add_module(iter_start, n, modname);
			if (ret)
				goto out_free;
			n = 0;
			modname = iter->modname;
			iter_start = iter;
921
		}
922
		n++;
923
	}
924 925 926
	ret = ddebug_add_module(iter_start, n, modname);
	if (ret)
		goto out_free;
927 928 929 930 931

	/* ddebug_query boot param got passed -> set it up */
	if (ddebug_setup_string[0] != '\0') {
		ret = ddebug_exec_query(ddebug_setup_string);
		if (ret)
932 933
			pr_warn("Invalid ddebug boot param %s",
				ddebug_setup_string);
934 935 936 937 938
		else
			pr_info("ddebug initialized with string %s",
				ddebug_setup_string);
	}

939
out_free:
940
	if (ret)
941
		ddebug_remove_all_tables();
942 943
	else
		ddebug_init_success = 1;
944 945
	return 0;
}
946 947 948 949
/* Allow early initialization for boot messages via boot param */
arch_initcall(dynamic_debug_init);
/* Debugfs setup must be done later */
module_init(dynamic_debug_init_debugfs);