lib/dynamic_debug.c

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