kernel/printk.c

   1 /*
   2  *  linux/kernel/printk.c
   3  *
   4  *  Copyright (C) 1991, 1992  Linus Torvalds
   5  *
   6  * Modified to make sys_syslog() more flexible: added commands to
   7  * return the last 4k of kernel messages, regardless of whether
   8  * they've been read or not.  Added option to suppress kernel printk's
   9  * to the console.  Added hook for sending the console messages
  10  * elsewhere, in preparation for a serial line console (someday).
  11  * Ted Ts'o, 2/11/93.
  12  * Modified for sysctl support, 1/8/97, Chris Horn.
  13  * Fixed SMP synchronization, 08/08/99, Manfred Spraul
  14  *     manfred@colorfullife.com
  15  * Rewrote bits to get rid of console_lock
  16  *      01Mar01 Andrew Morton
  17  */
  18
  19 #include <linux/kernel.h>
  20 #include <linux/mm.h>
  21 #include <linux/tty.h>
  22 #include <linux/tty_driver.h>
  23 #include <linux/console.h>
  24 #include <linux/init.h>
  25 #include <linux/jiffies.h>
  26 #include <linux/nmi.h>
  27 #include <linux/module.h>
  28 #include <linux/moduleparam.h>
  29 #include <linux/interrupt.h>                    /* For in_interrupt() */
  30 #include <linux/delay.h>
  31 #include <linux/smp.h>
  32 #include <linux/security.h>
  33 #include <linux/bootmem.h>
  34 #include <linux/memblock.h>
  35 #include <linux/syscalls.h>
  36 #include <linux/kexec.h>
  37 #include <linux/kdb.h>
  38 #include <linux/ratelimit.h>
  39 #include <linux/kmsg_dump.h>
  40 #include <linux/syslog.h>
  41 #include <linux/cpu.h>
  42 #include <linux/notifier.h>
  43 #include <linux/rculist.h>
  44 #include <linux/poll.h>
  45
  46 #include <asm/uaccess.h>
  47
  48 #define CREATE_TRACE_POINTS
  49 #include <trace/events/printk.h>
  50
  51 /*
  52  * Architectures can override it:
  53  */
  54 void asmlinkage __attribute__((weak)) early_printk(const char *fmt, ...)
  55 {
  56 }
  57
  58 /* printk's without a loglevel use this.. */
  59 #define DEFAULT_MESSAGE_LOGLEVEL CONFIG_DEFAULT_MESSAGE_LOGLEVEL
  60
  61 /* We show everything that is MORE important than this.. */
  62 #define MINIMUM_CONSOLE_LOGLEVEL 1 /* Minimum loglevel we let people use */
  63 #define DEFAULT_CONSOLE_LOGLEVEL 7 /* anything MORE serious than KERN_DEBUG */
  64
  65 DECLARE_WAIT_QUEUE_HEAD(log_wait);
  66
  67 int console_printk[4] = {
  68         DEFAULT_CONSOLE_LOGLEVEL,       /* console_loglevel */
  69         DEFAULT_MESSAGE_LOGLEVEL,       /* default_message_loglevel */
  70         MINIMUM_CONSOLE_LOGLEVEL,       /* minimum_console_loglevel */
  71         DEFAULT_CONSOLE_LOGLEVEL,       /* default_console_loglevel */
  72 };
  73
  74 /*
  75  * Low level drivers may need that to know if they can schedule in
  76  * their unblank() callback or not. So let's export it.
  77  */
  78 int oops_in_progress;
  79 EXPORT_SYMBOL(oops_in_progress);
  80
  81 /*
  82  * console_sem protects the console_drivers list, and also
  83  * provides serialisation for access to the entire console
  84  * driver system.
  85  */
  86 static DEFINE_SEMAPHORE(console_sem);
  87 struct console *console_drivers;
  88 EXPORT_SYMBOL_GPL(console_drivers);
  89
  90 #ifdef CONFIG_LOCKDEP
  91 static struct lockdep_map console_lock_dep_map = {
  92         .name = "console_lock"
  93 };
  94 #endif
  95
  96 /*
  97  * This is used for debugging the mess that is the VT code by
  98  * keeping track if we have the console semaphore held. It's
  99  * definitely not the perfect debug tool (we don't know if _WE_
 100  * hold it are racing, but it helps tracking those weird code
 101  * path in the console code where we end up in places I want
 102  * locked without the console sempahore held
 103  */
 104 static int console_locked, console_suspended;
 105
 106 /*
 107  * If exclusive_console is non-NULL then only this console is to be printed to.
 108  */
 109 static struct console *exclusive_console;
 110
 111 /*
 112  *      Array of consoles built from command line options (console=)
 113  */
 114 struct console_cmdline
 115 {
 116         char    name[8];                        /* Name of the driver       */
 117         int     index;                          /* Minor dev. to use        */
 118         char    *options;                       /* Options for the driver   */
 119 #ifdef CONFIG_A11Y_BRAILLE_CONSOLE
 120         char    *brl_options;                   /* Options for braille driver */
 121 #endif
 122 };
 123
 124 #define MAX_CMDLINECONSOLES 8
 125
 126 static struct console_cmdline console_cmdline[MAX_CMDLINECONSOLES];
 127 static int selected_console = -1;
 128 static int preferred_console = -1;
 129 int console_set_on_cmdline;
 130 EXPORT_SYMBOL(console_set_on_cmdline);
 131
 132 /* Flag: console code may call schedule() */
 133 static int console_may_schedule;
 134
 135 /*
 136  * The printk log buffer consists of a chain of concatenated variable
 137  * length records. Every record starts with a record header, containing
 138  * the overall length of the record.
 139  *
 140  * The heads to the first and last entry in the buffer, as well as the
 141  * sequence numbers of these both entries are maintained when messages
 142  * are stored..
 143  *
 144  * If the heads indicate available messages, the length in the header
 145  * tells the start next message. A length == 0 for the next message
 146  * indicates a wrap-around to the beginning of the buffer.
 147  *
 148  * Every record carries the monotonic timestamp in microseconds, as well as
 149  * the standard userspace syslog level and syslog facility. The usual
 150  * kernel messages use LOG_KERN; userspace-injected messages always carry
 151  * a matching syslog facility, by default LOG_USER. The origin of every
 152  * message can be reliably determined that way.
 153  *
 154  * The human readable log message directly follows the message header. The
 155  * length of the message text is stored in the header, the stored message
 156  * is not terminated.
 157  *
 158  * Optionally, a message can carry a dictionary of properties (key/value pairs),
 159  * to provide userspace with a machine-readable message context.
 160  *
 161  * Examples for well-defined, commonly used property names are:
 162  *   DEVICE=b12:8               device identifier
 163  *                                b12:8         block dev_t
 164  *                                c127:3        char dev_t
 165  *                                n8            netdev ifindex
 166  *                                +sound:card0  subsystem:devname
 167  *   SUBSYSTEM=pci              driver-core subsystem name
 168  *
 169  * Valid characters in property names are [a-zA-Z0-9.-_]. The plain text value
 170  * follows directly after a '=' character. Every property is terminated by
 171  * a '\0' character. The last property is not terminated.
 172  *
 173  * Example of a message structure:
 174  *   0000  ff 8f 00 00 00 00 00 00      monotonic time in nsec
 175  *   0008  34 00                        record is 52 bytes long
 176  *   000a        0b 00                  text is 11 bytes long
 177  *   000c              1f 00            dictionary is 23 bytes long
 178  *   000e                    03 00      LOG_KERN (facility) LOG_ERR (level)
 179  *   0010  69 74 27 73 20 61 20 6c      "it's a l"
 180  *         69 6e 65                     "ine"
 181  *   001b           44 45 56 49 43      "DEVIC"
 182  *         45 3d 62 38 3a 32 00 44      "E=b8:2\0D"
 183  *         52 49 56 45 52 3d 62 75      "RIVER=bu"
 184  *         67                           "g"
 185  *   0032     00 00 00                  padding to next message header
 186  *
 187  * The 'struct log' buffer header must never be directly exported to
 188  * userspace, it is a kernel-private implementation detail that might
 189  * need to be changed in the future, when the requirements change.
 190  *
 191  * /dev/kmsg exports the structured data in the following line format:
 192  *   "level,sequnum,timestamp;<message text>\n"
 193  *
 194  * The optional key/value pairs are attached as continuation lines starting
 195  * with a space character and terminated by a newline. All possible
 196  * non-prinatable characters are escaped in the "\xff" notation.
 197  *
 198  * Users of the export format should ignore possible additional values
 199  * separated by ',', and find the message after the ';' character.
 200  */
 201
 202 enum log_flags {
 203         LOG_NOCONS      = 1,    /* already flushed, do not print to console */
 204         LOG_NEWLINE     = 2,    /* text ended with a newline */
 205         LOG_PREFIX      = 4,    /* text started with a prefix */
 206         LOG_CONT        = 8,    /* text is a fragment of a continuation line */
 207 };
 208
 209 struct log {
 210         u64 ts_nsec;            /* timestamp in nanoseconds */
 211         u16 len;                /* length of entire record */
 212         u16 text_len;           /* length of text buffer */
 213         u16 dict_len;           /* length of dictionary buffer */
 214         u8 facility;            /* syslog facility */
 215         u8 flags:5;             /* internal record flags */
 216         u8 level:3;             /* syslog level */
 217 };
 218
 219 /*
 220  * The logbuf_lock protects kmsg buffer, indices, counters. It is also
 221  * used in interesting ways to provide interlocking in console_unlock();
 222  */
 223 static DEFINE_RAW_SPINLOCK(logbuf_lock);
 224
 225 #ifdef CONFIG_PRINTK
 226 /* the next printk record to read by syslog(READ) or /proc/kmsg */
 227 static u64 syslog_seq;
 228 static u32 syslog_idx;
 229 static enum log_flags syslog_prev;
 230 static size_t syslog_partial;
 231
 232 /* index and sequence number of the first record stored in the buffer */
 233 static u64 log_first_seq;
 234 static u32 log_first_idx;
 235
 236 /* index and sequence number of the next record to store in the buffer */
 237 static u64 log_next_seq;
 238 static u32 log_next_idx;
 239
 240 /* the next printk record to write to the console */
 241 static u64 console_seq;
 242 static u32 console_idx;
 243 static enum log_flags console_prev;
 244
 245 /* the next printk record to read after the last 'clear' command */
 246 static u64 clear_seq;
 247 static u32 clear_idx;
 248
 249 #define PREFIX_MAX              32
 250 #define LOG_LINE_MAX            1024 - PREFIX_MAX
 251
 252 /* record buffer */
 253 #if defined(CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS)
 254 #define LOG_ALIGN 4
 255 #else
 256 #define LOG_ALIGN __alignof__(struct log)
 257 #endif
 258 #define __LOG_BUF_LEN (1 << CONFIG_LOG_BUF_SHIFT)
 259 static char __log_buf[__LOG_BUF_LEN] __aligned(LOG_ALIGN);
 260 static char *log_buf = __log_buf;
 261 static u32 log_buf_len = __LOG_BUF_LEN;
 262
 263 /* cpu currently holding logbuf_lock */
 264 static volatile unsigned int logbuf_cpu = UINT_MAX;
 265
 266 /* human readable text of the record */
 267 static char *log_text(const struct log *msg)
 268 {
 269         return (char *)msg + sizeof(struct log);
 270 }
 271
 272 /* optional key/value pair dictionary attached to the record */
 273 static char *log_dict(const struct log *msg)
 274 {
 275         return (char *)msg + sizeof(struct log) + msg->text_len;
 276 }
 277
 278 /* get record by index; idx must point to valid msg */
 279 static struct log *log_from_idx(u32 idx)
 280 {
 281         struct log *msg = (struct log *)(log_buf + idx);
 282
 283         /*
 284          * A length == 0 record is the end of buffer marker. Wrap around and
 285          * read the message at the start of the buffer.
 286          */
 287         if (!msg->len)
 288                 return (struct log *)log_buf;
 289         return msg;
 290 }
 291
 292 /* get next record; idx must point to valid msg */
 293 static u32 log_next(u32 idx)
 294 {
 295         struct log *msg = (struct log *)(log_buf + idx);
 296
 297         /* length == 0 indicates the end of the buffer; wrap */
 298         /*
 299          * A length == 0 record is the end of buffer marker. Wrap around and
 300          * read the message at the start of the buffer as *this* one, and
 301          * return the one after that.
 302          */
 303         if (!msg->len) {
 304                 msg = (struct log *)log_buf;
 305                 return msg->len;
 306         }
 307         return idx + msg->len;
 308 }
 309
 310 /* insert record into the buffer, discard old ones, update heads */
 311 static void log_store(int facility, int level,
 312                       enum log_flags flags, u64 ts_nsec,
 313                       const char *dict, u16 dict_len,
 314                       const char *text, u16 text_len)
 315 {
 316         struct log *msg;
 317         u32 size, pad_len;
 318
 319         /* number of '\0' padding bytes to next message */
 320         size = sizeof(struct log) + text_len + dict_len;
 321         pad_len = (-size) & (LOG_ALIGN - 1);
 322         size += pad_len;
 323
 324         while (log_first_seq < log_next_seq) {
 325                 u32 free;
 326
 327                 if (log_next_idx > log_first_idx)
 328                         free = max(log_buf_len - log_next_idx, log_first_idx);
 329                 else
 330                         free = log_first_idx - log_next_idx;
 331
 332                 if (free > size + sizeof(struct log))
 333                         break;
 334
 335                 /* drop old messages until we have enough contiuous space */
 336                 log_first_idx = log_next(log_first_idx);
 337                 log_first_seq++;
 338         }
 339
 340         if (log_next_idx + size + sizeof(struct log) >= log_buf_len) {
 341                 /*
 342                  * This message + an additional empty header does not fit
 343                  * at the end of the buffer. Add an empty header with len == 0
 344                  * to signify a wrap around.
 345                  */
 346                 memset(log_buf + log_next_idx, 0, sizeof(struct log));
 347                 log_next_idx = 0;
 348         }
 349
 350         /* fill message */
 351         msg = (struct log *)(log_buf + log_next_idx);
 352         memcpy(log_text(msg), text, text_len);
 353         msg->text_len = text_len;
 354         memcpy(log_dict(msg), dict, dict_len);
 355         msg->dict_len = dict_len;
 356         msg->facility = facility;
 357         msg->level = level & 7;
 358         msg->flags = flags & 0x1f;
 359         if (ts_nsec > 0)
 360                 msg->ts_nsec = ts_nsec;
 361         else
 362                 msg->ts_nsec = local_clock();
 363         memset(log_dict(msg) + dict_len, 0, pad_len);
 364         msg->len = sizeof(struct log) + text_len + dict_len + pad_len;
 365
 366         /* insert message */
 367         log_next_idx += msg->len;
 368         log_next_seq++;
 369 }
 370
 371 /* /dev/kmsg - userspace message inject/listen interface */
 372 struct devkmsg_user {
 373         u64 seq;
 374         u32 idx;
 375         enum log_flags prev;
 376         struct mutex lock;
 377         char buf[8192];
 378 };
 379
 380 static ssize_t devkmsg_writev(struct kiocb *iocb, const struct iovec *iv,
 381                               unsigned long count, loff_t pos)
 382 {
 383         char *buf, *line;
 384         int i;
 385         int level = default_message_loglevel;
 386         int facility = 1;       /* LOG_USER */
 387         size_t len = iov_length(iv, count);
 388         ssize_t ret = len;
 389
 390         if (len > LOG_LINE_MAX)
 391                 return -EINVAL;
 392         buf = kmalloc(len+1, GFP_KERNEL);
 393         if (buf == NULL)
 394                 return -ENOMEM;
 395
 396         line = buf;
 397         for (i = 0; i < count; i++) {
 398                 if (copy_from_user(line, iv[i].iov_base, iv[i].iov_len)) {
 399                         ret = -EFAULT;
 400                         goto out;
 401                 }
 402                 line += iv[i].iov_len;
 403         }
 404
 405         /*
 406          * Extract and skip the syslog prefix <[0-9]*>. Coming from userspace
 407          * the decimal value represents 32bit, the lower 3 bit are the log
 408          * level, the rest are the log facility.
 409          *
 410          * If no prefix or no userspace facility is specified, we
 411          * enforce LOG_USER, to be able to reliably distinguish
 412          * kernel-generated messages from userspace-injected ones.
 413          */
 414         line = buf;
 415         if (line[0] == '<') {
 416                 char *endp = NULL;
 417
 418                 i = simple_strtoul(line+1, &endp, 10);
 419                 if (endp && endp[0] == '>') {
 420                         level = i & 7;
 421                         if (i >> 3)
 422                                 facility = i >> 3;
 423                         endp++;
 424                         len -= endp - line;
 425                         line = endp;
 426                 }
 427         }
 428         line[len] = '\0';
 429
 430         printk_emit(facility, level, NULL, 0, "%s", line);
 431 out:
 432         kfree(buf);
 433         return ret;
 434 }
 435
 436 static ssize_t devkmsg_read(struct file *file, char __user *buf,
 437                             size_t count, loff_t *ppos)
 438 {
 439         struct devkmsg_user *user = file->private_data;
 440         struct log *msg;
 441         u64 ts_usec;
 442         size_t i;
 443         char cont = '-';
 444         size_t len;
 445         ssize_t ret;
 446
 447         if (!user)
 448                 return -EBADF;
 449
 450         ret = mutex_lock_interruptible(&user->lock);
 451         if (ret)
 452                 return ret;
 453         raw_spin_lock_irq(&logbuf_lock);
 454         while (user->seq == log_next_seq) {
 455                 if (file->f_flags & O_NONBLOCK) {
 456                         ret = -EAGAIN;
 457                         raw_spin_unlock_irq(&logbuf_lock);
 458                         goto out;
 459                 }
 460
 461                 raw_spin_unlock_irq(&logbuf_lock);
 462                 ret = wait_event_interruptible(log_wait,
 463                                                user->seq != log_next_seq);
 464                 if (ret)
 465                         goto out;
 466                 raw_spin_lock_irq(&logbuf_lock);
 467         }
 468
 469         if (user->seq < log_first_seq) {
 470                 /* our last seen message is gone, return error and reset */
 471                 user->idx = log_first_idx;
 472                 user->seq = log_first_seq;
 473                 ret = -EPIPE;
 474                 raw_spin_unlock_irq(&logbuf_lock);
 475                 goto out;
 476         }
 477
 478         msg = log_from_idx(user->idx);
 479         ts_usec = msg->ts_nsec;
 480         do_div(ts_usec, 1000);
 481
 482         /*
 483          * If we couldn't merge continuation line fragments during the print,
 484          * export the stored flags to allow an optional external merge of the
 485          * records. Merging the records isn't always neccessarily correct, like
 486          * when we hit a race during printing. In most cases though, it produces
 487          * better readable output. 'c' in the record flags mark the first
 488          * fragment of a line, '+' the following.
 489          */
 490         if (msg->flags & LOG_CONT && !(user->prev & LOG_CONT))
 491                 cont = 'c';
 492         else if ((msg->flags & LOG_CONT) ||
 493                  ((user->prev & LOG_CONT) && !(msg->flags & LOG_PREFIX)))
 494                 cont = '+';
 495
 496         len = sprintf(user->buf, "%u,%llu,%llu,%c;",
 497                       (msg->facility << 3) | msg->level,
 498                       user->seq, ts_usec, cont);
 499         user->prev = msg->flags;
 500
 501         /* escape non-printable characters */
 502         for (i = 0; i < msg->text_len; i++) {
 503                 unsigned char c = log_text(msg)[i];
 504
 505                 if (c < ' ' || c >= 127 || c == '\\')
 506                         len += sprintf(user->buf + len, "\\x%02x", c);
 507                 else
 508                         user->buf[len++] = c;
 509         }
 510         user->buf[len++] = '\n';
 511
 512         if (msg->dict_len) {
 513                 bool line = true;
 514
 515                 for (i = 0; i < msg->dict_len; i++) {
 516                         unsigned char c = log_dict(msg)[i];
 517
 518                         if (line) {
 519                                 user->buf[len++] = ' ';
 520                                 line = false;
 521                         }
 522
 523                         if (c == '\0') {
 524                                 user->buf[len++] = '\n';
 525                                 line = true;
 526                                 continue;
 527                         }
 528
 529                         if (c < ' ' || c >= 127 || c == '\\') {
 530                                 len += sprintf(user->buf + len, "\\x%02x", c);
 531                                 continue;
 532                         }
 533
 534                         user->buf[len++] = c;
 535                 }
 536                 user->buf[len++] = '\n';
 537         }
 538
 539         user->idx = log_next(user->idx);
 540         user->seq++;
 541         raw_spin_unlock_irq(&logbuf_lock);
 542
 543         if (len > count) {
 544                 ret = -EINVAL;
 545                 goto out;
 546         }
 547
 548         if (copy_to_user(buf, user->buf, len)) {
 549                 ret = -EFAULT;
 550                 goto out;
 551         }
 552         ret = len;
 553 out:
 554         mutex_unlock(&user->lock);
 555         return ret;
 556 }
 557
 558 static loff_t devkmsg_llseek(struct file *file, loff_t offset, int whence)
 559 {
 560         struct devkmsg_user *user = file->private_data;
 561         loff_t ret = 0;
 562
 563         if (!user)
 564                 return -EBADF;
 565         if (offset)
 566                 return -ESPIPE;
 567
 568         raw_spin_lock_irq(&logbuf_lock);
 569         switch (whence) {
 570         case SEEK_SET:
 571                 /* the first record */
 572                 user->idx = log_first_idx;
 573                 user->seq = log_first_seq;
 574                 break;
 575         case SEEK_DATA:
 576                 /*
 577                  * The first record after the last SYSLOG_ACTION_CLEAR,
 578                  * like issued by 'dmesg -c'. Reading /dev/kmsg itself
 579                  * changes no global state, and does not clear anything.
 580                  */
 581                 user->idx = clear_idx;
 582                 user->seq = clear_seq;
 583                 break;
 584         case SEEK_END:
 585                 /* after the last record */
 586                 user->idx = log_next_idx;
 587                 user->seq = log_next_seq;
 588                 break;
 589         default:
 590                 ret = -EINVAL;
 591         }
 592         raw_spin_unlock_irq(&logbuf_lock);
 593         return ret;
 594 }
 595
 596 static unsigned int devkmsg_poll(struct file *file, poll_table *wait)
 597 {
 598         struct devkmsg_user *user = file->private_data;
 599         int ret = 0;
 600
 601         if (!user)
 602                 return POLLERR|POLLNVAL;
 603
 604         poll_wait(file, &log_wait, wait);
 605
 606         raw_spin_lock_irq(&logbuf_lock);
 607         if (user->seq < log_next_seq) {
 608                 /* return error when data has vanished underneath us */
 609                 if (user->seq < log_first_seq)
 610                         ret = POLLIN|POLLRDNORM|POLLERR|POLLPRI;
 611                 ret = POLLIN|POLLRDNORM;
 612         }
 613         raw_spin_unlock_irq(&logbuf_lock);
 614
 615         return ret;
 616 }
 617
 618 static int devkmsg_open(struct inode *inode, struct file *file)
 619 {
 620         struct devkmsg_user *user;
 621         int err;
 622
 623         /* write-only does not need any file context */
 624         if ((file->f_flags & O_ACCMODE) == O_WRONLY)
 625                 return 0;
 626
 627         err = security_syslog(SYSLOG_ACTION_READ_ALL);
 628         if (err)
 629                 return err;
 630
 631         user = kmalloc(sizeof(struct devkmsg_user), GFP_KERNEL);
 632         if (!user)
 633                 return -ENOMEM;
 634
 635         mutex_init(&user->lock);
 636
 637         raw_spin_lock_irq(&logbuf_lock);
 638         user->idx = log_first_idx;
 639         user->seq = log_first_seq;
 640         raw_spin_unlock_irq(&logbuf_lock);
 641
 642         file->private_data = user;
 643         return 0;
 644 }
 645
 646 static int devkmsg_release(struct inode *inode, struct file *file)
 647 {
 648         struct devkmsg_user *user = file->private_data;
 649
 650         if (!user)
 651                 return 0;
 652
 653         mutex_destroy(&user->lock);
 654         kfree(user);
 655         return 0;
 656 }
 657
 658 const struct file_operations kmsg_fops = {
 659         .open = devkmsg_open,
 660         .read = devkmsg_read,
 661         .aio_write = devkmsg_writev,
 662         .llseek = devkmsg_llseek,
 663         .poll = devkmsg_poll,
 664         .release = devkmsg_release,
 665 };
 666
 667 #ifdef CONFIG_KEXEC
 668 /*
 669  * This appends the listed symbols to /proc/vmcoreinfo
 670  *
 671  * /proc/vmcoreinfo is used by various utiilties, like crash and makedumpfile to
 672  * obtain access to symbols that are otherwise very difficult to locate.  These
 673  * symbols are specifically used so that utilities can access and extract the
 674  * dmesg log from a vmcore file after a crash.
 675  */
 676 void log_buf_kexec_setup(void)
 677 {
 678         VMCOREINFO_SYMBOL(log_buf);
 679         VMCOREINFO_SYMBOL(log_buf_len);
 680         VMCOREINFO_SYMBOL(log_first_idx);
 681         VMCOREINFO_SYMBOL(log_next_idx);
 682         /*
 683          * Export struct log size and field offsets. User space tools can
 684          * parse it and detect any changes to structure down the line.
 685          */
 686         VMCOREINFO_STRUCT_SIZE(log);
 687         VMCOREINFO_OFFSET(log, ts_nsec);
 688         VMCOREINFO_OFFSET(log, len);
 689         VMCOREINFO_OFFSET(log, text_len);
 690         VMCOREINFO_OFFSET(log, dict_len);
 691 }
 692 #endif
 693
 694 /* requested log_buf_len from kernel cmdline */
 695 static unsigned long __initdata new_log_buf_len;
 696
 697 /* save requested log_buf_len since it's too early to process it */
 698 static int __init log_buf_len_setup(char *str)
 699 {
 700         unsigned size = memparse(str, &str);
 701
 702         if (size)
 703                 size = roundup_pow_of_two(size);
 704         if (size > log_buf_len)
 705                 new_log_buf_len = size;
 706
 707         return 0;
 708 }
 709 early_param("log_buf_len", log_buf_len_setup);
 710
 711 void __init setup_log_buf(int early)
 712 {
 713         unsigned long flags;
 714         char *new_log_buf;
 715         int free;
 716
 717         if (!new_log_buf_len)
 718                 return;
 719
 720         if (early) {
 721                 unsigned long mem;
 722
 723                 mem = memblock_alloc(new_log_buf_len, PAGE_SIZE);
 724                 if (!mem)
 725                         return;
 726                 new_log_buf = __va(mem);
 727         } else {
 728                 new_log_buf = alloc_bootmem_nopanic(new_log_buf_len);
 729         }
 730
 731         if (unlikely(!new_log_buf)) {
 732                 pr_err("log_buf_len: %ld bytes not available\n",
 733                         new_log_buf_len);
 734                 return;
 735         }
 736
 737         raw_spin_lock_irqsave(&logbuf_lock, flags);
 738         log_buf_len = new_log_buf_len;
 739         log_buf = new_log_buf;
 740         new_log_buf_len = 0;
 741         free = __LOG_BUF_LEN - log_next_idx;
 742         memcpy(log_buf, __log_buf, __LOG_BUF_LEN);
 743         raw_spin_unlock_irqrestore(&logbuf_lock, flags);
 744
 745         pr_info("log_buf_len: %d\n", log_buf_len);
 746         pr_info("early log buf free: %d(%d%%)\n",
 747                 free, (free * 100) / __LOG_BUF_LEN);
 748 }
 749
 750 static bool __read_mostly ignore_loglevel;
 751
 752 static int __init ignore_loglevel_setup(char *str)
 753 {
 754         ignore_loglevel = 1;
 755         printk(KERN_INFO "debug: ignoring loglevel setting.\n");
 756
 757         return 0;
 758 }
 759
 760 early_param("ignore_loglevel", ignore_loglevel_setup);
 761 module_param(ignore_loglevel, bool, S_IRUGO | S_IWUSR);
 762 MODULE_PARM_DESC(ignore_loglevel, "ignore loglevel setting, to"
 763         "print all kernel messages to the console.");
 764
 765 #ifdef CONFIG_BOOT_PRINTK_DELAY
 766
 767 static int boot_delay; /* msecs delay after each printk during bootup */
 768 static unsigned long long loops_per_msec;       /* based on boot_delay */
 769
 770 static int __init boot_delay_setup(char *str)
 771 {
 772         unsigned long lpj;
 773
 774         lpj = preset_lpj ? preset_lpj : 1000000;        /* some guess */
 775         loops_per_msec = (unsigned long long)lpj / 1000 * HZ;
 776
 777         get_option(&str, &boot_delay);
 778         if (boot_delay > 10 * 1000)
 779                 boot_delay = 0;
 780
 781         pr_debug("boot_delay: %u, preset_lpj: %ld, lpj: %lu, "
 782                 "HZ: %d, loops_per_msec: %llu\n",
 783                 boot_delay, preset_lpj, lpj, HZ, loops_per_msec);
 784         return 1;
 785 }
 786 __setup("boot_delay=", boot_delay_setup);
 787
 788 static void boot_delay_msec(int level)
 789 {
 790         unsigned long long k;
 791         unsigned long timeout;
 792
 793         if ((boot_delay == 0 || system_state != SYSTEM_BOOTING)
 794                 || (level >= console_loglevel && !ignore_loglevel)) {
 795                 return;
 796         }
 797
 798         k = (unsigned long long)loops_per_msec * boot_delay;
 799
 800         timeout = jiffies + msecs_to_jiffies(boot_delay);
 801         while (k) {
 802                 k--;
 803                 cpu_relax();
 804                 /*
 805                  * use (volatile) jiffies to prevent
 806                  * compiler reduction; loop termination via jiffies
 807                  * is secondary and may or may not happen.
 808                  */
 809                 if (time_after(jiffies, timeout))
 810                         break;
 811                 touch_nmi_watchdog();
 812         }
 813 }
 814 #else
 815 static inline void boot_delay_msec(int level)
 816 {
 817 }
 818 #endif
 819
 820 #ifdef CONFIG_SECURITY_DMESG_RESTRICT
 821 int dmesg_restrict = 1;
 822 #else
 823 int dmesg_restrict;
 824 #endif
 825
 826 static int syslog_action_restricted(int type)
 827 {
 828         if (dmesg_restrict)
 829                 return 1;
 830         /* Unless restricted, we allow "read all" and "get buffer size" for everybody */
 831         return type != SYSLOG_ACTION_READ_ALL && type != SYSLOG_ACTION_SIZE_BUFFER;
 832 }
 833
 834 static int check_syslog_permissions(int type, bool from_file)
 835 {
 836         /*
 837          * If this is from /proc/kmsg and we've already opened it, then we've
 838          * already done the capabilities checks at open time.
 839          */
 840         if (from_file && type != SYSLOG_ACTION_OPEN)
 841                 return 0;
 842
 843         if (syslog_action_restricted(type)) {
 844                 if (capable(CAP_SYSLOG))
 845                         return 0;
 846                 /* For historical reasons, accept CAP_SYS_ADMIN too, with a warning */
 847                 if (capable(CAP_SYS_ADMIN)) {
 848                         printk_once(KERN_WARNING "%s (%d): "
 849                                  "Attempt to access syslog with CAP_SYS_ADMIN "
 850                                  "but no CAP_SYSLOG (deprecated).\n",
 851                                  current->comm, task_pid_nr(current));
 852                         return 0;
 853                 }
 854                 return -EPERM;
 855         }
 856         return 0;
 857 }
 858
 859 #if defined(CONFIG_PRINTK_TIME)
 860 static bool printk_time = 1;
 861 #else
 862 static bool printk_time;
 863 #endif
 864 module_param_named(time, printk_time, bool, S_IRUGO | S_IWUSR);
 865
 866 static size_t print_time(u64 ts, char *buf)
 867 {
 868         unsigned long rem_nsec;
 869
 870         if (!printk_time)
 871                 return 0;
 872
 873         rem_nsec = do_div(ts, 1000000000);
 874
 875         if (!buf)
 876                 return snprintf(NULL, 0, "[%5lu.000000] ", (unsigned long)ts);
 877
 878         return sprintf(buf, "[%5lu.%06lu] ",
 879                        (unsigned long)ts, rem_nsec / 1000);
 880 }
 881
 882 static size_t print_prefix(const struct log *msg, bool syslog, char *buf)
 883 {
 884         size_t len = 0;
 885         unsigned int prefix = (msg->facility << 3) | msg->level;
 886
 887         if (syslog) {
 888                 if (buf) {
 889                         len += sprintf(buf, "<%u>", prefix);
 890                 } else {
 891                         len += 3;
 892                         if (prefix > 999)
 893                                 len += 3;
 894                         else if (prefix > 99)
 895                                 len += 2;
 896                         else if (prefix > 9)
 897                                 len++;
 898                 }
 899         }
 900
 901         len += print_time(msg->ts_nsec, buf ? buf + len : NULL);
 902         return len;
 903 }
 904
 905 static size_t msg_print_text(const struct log *msg, enum log_flags prev,
 906                              bool syslog, char *buf, size_t size)
 907 {
 908         const char *text = log_text(msg);
 909         size_t text_size = msg->text_len;
 910         bool prefix = true;
 911         bool newline = true;
 912         size_t len = 0;
 913
 914         if ((prev & LOG_CONT) && !(msg->flags & LOG_PREFIX))
 915                 prefix = false;
 916
 917         if (msg->flags & LOG_CONT) {
 918                 if ((prev & LOG_CONT) && !(prev & LOG_NEWLINE))
 919                         prefix = false;
 920
 921                 if (!(msg->flags & LOG_NEWLINE))
 922                         newline = false;
 923         }
 924
 925         do {
 926                 const char *next = memchr(text, '\n', text_size);
 927                 size_t text_len;
 928
 929                 if (next) {
 930                         text_len = next - text;
 931                         next++;
 932                         text_size -= next - text;
 933                 } else {
 934                         text_len = text_size;
 935                 }
 936
 937                 if (buf) {
 938                         if (print_prefix(msg, syslog, NULL) +
 939                             text_len + 1 >= size - len)
 940                                 break;
 941
 942                         if (prefix)
 943                                 len += print_prefix(msg, syslog, buf + len);
 944                         memcpy(buf + len, text, text_len);
 945                         len += text_len;
 946                         if (next || newline)
 947                                 buf[len++] = '\n';
 948                 } else {
 949                         /* SYSLOG_ACTION_* buffer size only calculation */
 950                         if (prefix)
 951                                 len += print_prefix(msg, syslog, NULL);
 952                         len += text_len;
 953                         if (next || newline)
 954                                 len++;
 955                 }
 956
 957                 prefix = true;
 958                 text = next;
 959         } while (text);
 960
 961         return len;
 962 }
 963
 964 static int syslog_print(char __user *buf, int size)
 965 {
 966         char *text;
 967         struct log *msg;
 968         int len = 0;
 969
 970         text = kmalloc(LOG_LINE_MAX + PREFIX_MAX, GFP_KERNEL);
 971         if (!text)
 972                 return -ENOMEM;
 973
 974         while (size > 0) {
 975                 size_t n;
 976                 size_t skip;
 977
 978                 raw_spin_lock_irq(&logbuf_lock);
 979                 if (syslog_seq < log_first_seq) {
 980                         /* messages are gone, move to first one */
 981                         syslog_seq = log_first_seq;
 982                         syslog_idx = log_first_idx;
 983                         syslog_prev = 0;
 984                         syslog_partial = 0;
 985                 }
 986                 if (syslog_seq == log_next_seq) {
 987                         raw_spin_unlock_irq(&logbuf_lock);
 988                         break;
 989                 }
 990
 991                 skip = syslog_partial;
 992                 msg = log_from_idx(syslog_idx);
 993                 n = msg_print_text(msg, syslog_prev, true, text,
 994                                    LOG_LINE_MAX + PREFIX_MAX);
 995                 if (n - syslog_partial <= size) {
 996                         /* message fits into buffer, move forward */
 997                         syslog_idx = log_next(syslog_idx);
 998                         syslog_seq++;
 999                         syslog_prev = msg->flags;
1000                         n -= syslog_partial;
1001                         syslog_partial = 0;
1002                 } else if (!len){
1003                         /* partial read(), remember position */
1004                         n = size;
1005                         syslog_partial += n;
1006                 } else
1007                         n = 0;
1008                 raw_spin_unlock_irq(&logbuf_lock);
1009
1010                 if (!n)
1011                         break;
1012
1013                 if (copy_to_user(buf, text + skip, n)) {
1014                         if (!len)
1015                                 len = -EFAULT;
1016                         break;
1017                 }
1018
1019                 len += n;
1020                 size -= n;
1021                 buf += n;
1022         }
1023
1024         kfree(text);
1025         return len;
1026 }
1027
1028 static int syslog_print_all(char __user *buf, int size, bool clear)
1029 {
1030         char *text;
1031         int len = 0;
1032
1033         text = kmalloc(LOG_LINE_MAX + PREFIX_MAX, GFP_KERNEL);
1034         if (!text)
1035                 return -ENOMEM;
1036
1037         raw_spin_lock_irq(&logbuf_lock);
1038         if (buf) {
1039                 u64 next_seq;
1040                 u64 seq;
1041                 u32 idx;
1042                 enum log_flags prev;
1043
1044                 if (clear_seq < log_first_seq) {
1045                         /* messages are gone, move to first available one */
1046                         clear_seq = log_first_seq;
1047                         clear_idx = log_first_idx;
1048                 }
1049
1050                 /*
1051                  * Find first record that fits, including all following records,
1052                  * into the user-provided buffer for this dump.
1053                  */
1054                 seq = clear_seq;
1055                 idx = clear_idx;
1056                 prev = 0;
1057                 while (seq < log_next_seq) {
1058                         struct log *msg = log_from_idx(idx);
1059
1060                         len += msg_print_text(msg, prev, true, NULL, 0);
1061                         prev = msg->flags;
1062                         idx = log_next(idx);
1063                         seq++;
1064                 }
1065
1066                 /* move first record forward until length fits into the buffer */
1067                 seq = clear_seq;
1068                 idx = clear_idx;
1069                 prev = 0;
1070                 while (len > size && seq < log_next_seq) {
1071                         struct log *msg = log_from_idx(idx);
1072
1073                         len -= msg_print_text(msg, prev, true, NULL, 0);
1074                         prev = msg->flags;
1075                         idx = log_next(idx);
1076                         seq++;
1077                 }
1078
1079                 /* last message fitting into this dump */
1080                 next_seq = log_next_seq;
1081
1082                 len = 0;
1083                 prev = 0;
1084                 while (len >= 0 && seq < next_seq) {
1085                         struct log *msg = log_from_idx(idx);
1086                         int textlen;
1087
1088                         textlen = msg_print_text(msg, prev, true, text,
1089                                                  LOG_LINE_MAX + PREFIX_MAX);
1090                         if (textlen < 0) {
1091                                 len = textlen;
1092                                 break;
1093                         }
1094                         idx = log_next(idx);
1095                         seq++;
1096                         prev = msg->flags;
1097
1098                         raw_spin_unlock_irq(&logbuf_lock);
1099                         if (copy_to_user(buf + len, text, textlen))
1100                                 len = -EFAULT;
1101                         else
1102                                 len += textlen;
1103                         raw_spin_lock_irq(&logbuf_lock);
1104
1105                         if (seq < log_first_seq) {
1106                                 /* messages are gone, move to next one */
1107                                 seq = log_first_seq;
1108                                 idx = log_first_idx;
1109                                 prev = 0;
1110                         }
1111                 }
1112         }
1113
1114         if (clear) {
1115                 clear_seq = log_next_seq;
1116                 clear_idx = log_next_idx;
1117         }
1118         raw_spin_unlock_irq(&logbuf_lock);
1119
1120         kfree(text);
1121         return len;
1122 }
1123
1124 int do_syslog(int type, char __user *buf, int len, bool from_file)
1125 {
1126         bool clear = false;
1127         static int saved_console_loglevel = -1;
1128         int error;
1129
1130         error = check_syslog_permissions(type, from_file);
1131         if (error)
1132                 goto out;
1133
1134         error = security_syslog(type);
1135         if (error)
1136                 return error;
1137
1138         switch (type) {
1139         case SYSLOG_ACTION_CLOSE:       /* Close log */
1140                 break;
1141         case SYSLOG_ACTION_OPEN:        /* Open log */
1142                 break;
1143         case SYSLOG_ACTION_READ:        /* Read from log */
1144                 error = -EINVAL;
1145                 if (!buf || len < 0)
1146                         goto out;
1147                 error = 0;
1148                 if (!len)
1149                         goto out;
1150                 if (!access_ok(VERIFY_WRITE, buf, len)) {
1151                         error = -EFAULT;
1152                         goto out;
1153                 }
1154                 error = wait_event_interruptible(log_wait,
1155                                                  syslog_seq != log_next_seq);
1156                 if (error)
1157                         goto out;
1158                 error = syslog_print(buf, len);
1159                 break;
1160         /* Read/clear last kernel messages */
1161         case SYSLOG_ACTION_READ_CLEAR:
1162                 clear = true;
1163                 /* FALL THRU */
1164         /* Read last kernel messages */
1165         case SYSLOG_ACTION_READ_ALL:
1166                 error = -EINVAL;
1167                 if (!buf || len < 0)
1168                         goto out;
1169                 error = 0;
1170                 if (!len)
1171                         goto out;
1172                 if (!access_ok(VERIFY_WRITE, buf, len)) {
1173                         error = -EFAULT;
1174                         goto out;
1175                 }
1176                 error = syslog_print_all(buf, len, clear);
1177                 break;
1178         /* Clear ring buffer */
1179         case SYSLOG_ACTION_CLEAR:
1180                 syslog_print_all(NULL, 0, true);
1181                 break;
1182         /* Disable logging to console */
1183         case SYSLOG_ACTION_CONSOLE_OFF:
1184                 if (saved_console_loglevel == -1)
1185                         saved_console_loglevel = console_loglevel;
1186                 console_loglevel = minimum_console_loglevel;
1187                 break;
1188         /* Enable logging to console */
1189         case SYSLOG_ACTION_CONSOLE_ON:
1190                 if (saved_console_loglevel != -1) {
1191                         console_loglevel = saved_console_loglevel;
1192                         saved_console_loglevel = -1;
1193                 }
1194                 break;
1195         /* Set level of messages printed to console */
1196         case SYSLOG_ACTION_CONSOLE_LEVEL:
1197                 error = -EINVAL;
1198                 if (len < 1 || len > 8)
1199                         goto out;
1200                 if (len < minimum_console_loglevel)
1201                         len = minimum_console_loglevel;
1202                 console_loglevel = len;
1203                 /* Implicitly re-enable logging to console */
1204                 saved_console_loglevel = -1;
1205                 error = 0;
1206                 break;
1207         /* Number of chars in the log buffer */
1208         case SYSLOG_ACTION_SIZE_UNREAD:
1209                 raw_spin_lock_irq(&logbuf_lock);
1210                 if (syslog_seq < log_first_seq) {
1211                         /* messages are gone, move to first one */
1212                         syslog_seq = log_first_seq;
1213                         syslog_idx = log_first_idx;
1214                         syslog_prev = 0;
1215                         syslog_partial = 0;
1216                 }
1217                 if (from_file) {
1218                         /*
1219                          * Short-cut for poll(/"proc/kmsg") which simply checks
1220                          * for pending data, not the size; return the count of
1221                          * records, not the length.
1222                          */
1223                         error = log_next_idx - syslog_idx;
1224                 } else {
1225                         u64 seq = syslog_seq;
1226                         u32 idx = syslog_idx;
1227                         enum log_flags prev = syslog_prev;
1228
1229                         error = 0;
1230                         while (seq < log_next_seq) {
1231                                 struct log *msg = log_from_idx(idx);
1232
1233                                 error += msg_print_text(msg, prev, true, NULL, 0);
1234                                 idx = log_next(idx);
1235                                 seq++;
1236                                 prev = msg->flags;
1237                         }
1238                         error -= syslog_partial;
1239                 }
1240                 raw_spin_unlock_irq(&logbuf_lock);
1241                 break;
1242         /* Size of the log buffer */
1243         case SYSLOG_ACTION_SIZE_BUFFER:
1244                 error = log_buf_len;
1245                 break;
1246         default:
1247                 error = -EINVAL;
1248                 break;
1249         }
1250 out:
1251         return error;
1252 }
1253
1254 SYSCALL_DEFINE3(syslog, int, type, char __user *, buf, int, len)
1255 {
1256         return do_syslog(type, buf, len, SYSLOG_FROM_CALL);
1257 }
1258
1259 /*
1260  * Call the console drivers, asking them to write out
1261  * log_buf[start] to log_buf[end - 1].
1262  * The console_lock must be held.
1263  */
1264 static void call_console_drivers(int level, const char *text, size_t len)
1265 {
1266         struct console *con;
1267
1268         trace_console(text, 0, len, len);
1269
1270         if (level >= console_loglevel && !ignore_loglevel)
1271                 return;
1272         if (!console_drivers)
1273                 return;
1274
1275         for_each_console(con) {
1276                 if (exclusive_console && con != exclusive_console)
1277                         continue;
1278                 if (!(con->flags & CON_ENABLED))
1279                         continue;
1280                 if (!con->write)
1281                         continue;
1282                 if (!cpu_online(smp_processor_id()) &&
1283                     !(con->flags & CON_ANYTIME))
1284                         continue;
1285                 con->write(con, text, len);
1286         }
1287 }
1288
1289 /*
1290  * Zap console related locks when oopsing. Only zap at most once
1291  * every 10 seconds, to leave time for slow consoles to print a
1292  * full oops.
1293  */
1294 static void zap_locks(void)
1295 {
1296         static unsigned long oops_timestamp;
1297
1298         if (time_after_eq(jiffies, oops_timestamp) &&
1299                         !time_after(jiffies, oops_timestamp + 30 * HZ))
1300                 return;
1301
1302         oops_timestamp = jiffies;
1303
1304         debug_locks_off();
1305         /* If a crash is occurring, make sure we can't deadlock */
1306         raw_spin_lock_init(&logbuf_lock);
1307         /* And make sure that we print immediately */
1308         sema_init(&console_sem, 1);
1309 }
1310
1311 /* Check if we have any console registered that can be called early in boot. */
1312 static int have_callable_console(void)
1313 {
1314         struct console *con;
1315
1316         for_each_console(con)
1317                 if (con->flags & CON_ANYTIME)
1318                         return 1;
1319
1320         return 0;
1321 }
1322
1323 /*
1324  * Can we actually use the console at this time on this cpu?
1325  *
1326  * Console drivers may assume that per-cpu resources have
1327  * been allocated. So unless they're explicitly marked as
1328  * being able to cope (CON_ANYTIME) don't call them until
1329  * this CPU is officially up.
1330  */
1331 static inline int can_use_console(unsigned int cpu)
1332 {
1333         return cpu_online(cpu) || have_callable_console();
1334 }
1335
1336 /*
1337  * Try to get console ownership to actually show the kernel
1338  * messages from a 'printk'. Return true (and with the
1339  * console_lock held, and 'console_locked' set) if it
1340  * is successful, false otherwise.
1341  *
1342  * This gets called with the 'logbuf_lock' spinlock held and
1343  * interrupts disabled. It should return with 'lockbuf_lock'
1344  * released but interrupts still disabled.
1345  */
1346 static int console_trylock_for_printk(unsigned int cpu)
1347         __releases(&logbuf_lock)
1348 {
1349         int retval = 0, wake = 0;
1350
1351         if (console_trylock()) {
1352                 retval = 1;
1353
1354                 /*
1355                  * If we can't use the console, we need to release
1356                  * the console semaphore by hand to avoid flushing
1357                  * the buffer. We need to hold the console semaphore
1358                  * in order to do this test safely.
1359                  */
1360                 if (!can_use_console(cpu)) {
1361                         console_locked = 0;
1362                         wake = 1;
1363                         retval = 0;
1364                 }
1365         }
1366         logbuf_cpu = UINT_MAX;
1367         if (wake)
1368                 up(&console_sem);
1369         raw_spin_unlock(&logbuf_lock);
1370         return retval;
1371 }
1372
1373 int printk_delay_msec __read_mostly;
1374
1375 static inline void printk_delay(void)
1376 {
1377         if (unlikely(printk_delay_msec)) {
1378                 int m = printk_delay_msec;
1379
1380                 while (m--) {
1381                         mdelay(1);
1382                         touch_nmi_watchdog();
1383                 }
1384         }
1385 }
1386
1387 /*
1388  * Continuation lines are buffered, and not committed to the record buffer
1389  * until the line is complete, or a race forces it. The line fragments
1390  * though, are printed immediately to the consoles to ensure everything has
1391  * reached the console in case of a kernel crash.
1392  */
1393 static struct cont {
1394         char buf[LOG_LINE_MAX];
1395         size_t len;                     /* length == 0 means unused buffer */
1396         size_t cons;                    /* bytes written to console */
1397         struct task_struct *owner;      /* task of first print*/
1398         u64 ts_nsec;                    /* time of first print */
1399         u8 level;                       /* log level of first message */
1400         u8 facility;                    /* log level of first message */
1401         enum log_flags flags;           /* prefix, newline flags */
1402         bool flushed:1;                 /* buffer sealed and committed */
1403 } cont;
1404
1405 static void cont_flush(enum log_flags flags)
1406 {
1407         if (cont.flushed)
1408                 return;
1409         if (cont.len == 0)
1410                 return;
1411
1412         if (cont.cons) {
1413                 /*
1414                  * If a fragment of this line was directly flushed to the
1415                  * console; wait for the console to pick up the rest of the
1416                  * line. LOG_NOCONS suppresses a duplicated output.
1417                  */
1418                 log_store(cont.facility, cont.level, flags | LOG_NOCONS,
1419                           cont.ts_nsec, NULL, 0, cont.buf, cont.len);
1420                 cont.flags = flags;
1421                 cont.flushed = true;
1422         } else {
1423                 /*
1424                  * If no fragment of this line ever reached the console,
1425                  * just submit it to the store and free the buffer.
1426                  */
1427                 log_store(cont.facility, cont.level, flags, 0,
1428                           NULL, 0, cont.buf, cont.len);
1429                 cont.len = 0;
1430         }
1431 }
1432
1433 static bool cont_add(int facility, int level, const char *text, size_t len)
1434 {
1435         if (cont.len && cont.flushed)
1436                 return false;
1437
1438         if (cont.len + len > sizeof(cont.buf)) {
1439                 /* the line gets too long, split it up in separate records */
1440                 cont_flush(LOG_CONT);
1441                 return false;
1442         }
1443
1444         if (!cont.len) {
1445                 cont.facility = facility;
1446                 cont.level = level;
1447                 cont.owner = current;
1448                 cont.ts_nsec = local_clock();
1449                 cont.flags = 0;
1450                 cont.cons = 0;
1451                 cont.flushed = false;
1452         }
1453
1454         memcpy(cont.buf + cont.len, text, len);
1455         cont.len += len;
1456
1457         if (cont.len > (sizeof(cont.buf) * 80) / 100)
1458                 cont_flush(LOG_CONT);
1459
1460         return true;
1461 }
1462
1463 static size_t cont_print_text(char *text, size_t size)
1464 {
1465         size_t textlen = 0;
1466         size_t len;
1467
1468         if (cont.cons == 0 && (console_prev & LOG_NEWLINE)) {
1469                 textlen += print_time(cont.ts_nsec, text);
1470                 size -= textlen;
1471         }
1472
1473         len = cont.len - cont.cons;
1474         if (len > 0) {
1475                 if (len+1 > size)
1476                         len = size-1;
1477                 memcpy(text + textlen, cont.buf + cont.cons, len);
1478                 textlen += len;
1479                 cont.cons = cont.len;
1480         }
1481
1482         if (cont.flushed) {
1483                 if (cont.flags & LOG_NEWLINE)
1484                         text[textlen++] = '\n';
1485                 /* got everything, release buffer */
1486                 cont.len = 0;
1487         }
1488         return textlen;
1489 }
1490
1491 asmlinkage int vprintk_emit(int facility, int level,
1492                             const char *dict, size_t dictlen,
1493                             const char *fmt, va_list args)
1494 {
1495         static int recursion_bug;
1496         static char textbuf[LOG_LINE_MAX];
1497         char *text = textbuf;
1498         size_t text_len;
1499         enum log_flags lflags = 0;
1500         unsigned long flags;
1501         int this_cpu;
1502         int printed_len = 0;
1503
1504         boot_delay_msec(level);
1505         printk_delay();
1506
1507         /* This stops the holder of console_sem just where we want him */
1508         local_irq_save(flags);
1509         this_cpu = smp_processor_id();
1510
1511         /*
1512          * Ouch, printk recursed into itself!
1513          */
1514         if (unlikely(logbuf_cpu == this_cpu)) {
1515                 /*
1516                  * If a crash is occurring during printk() on this CPU,
1517                  * then try to get the crash message out but make sure
1518                  * we can't deadlock. Otherwise just return to avoid the
1519                  * recursion and return - but flag the recursion so that
1520                  * it can be printed at the next appropriate moment:
1521                  */
1522                 if (!oops_in_progress && !lockdep_recursing(current)) {
1523                         recursion_bug = 1;
1524                         goto out_restore_irqs;
1525                 }
1526                 zap_locks();
1527         }
1528
1529         lockdep_off();
1530         raw_spin_lock(&logbuf_lock);
1531         logbuf_cpu = this_cpu;
1532
1533         if (recursion_bug) {
1534                 static const char recursion_msg[] =
1535                         "BUG: recent printk recursion!";
1536
1537                 recursion_bug = 0;
1538                 printed_len += strlen(recursion_msg);
1539                 /* emit KERN_CRIT message */
1540                 log_store(0, 2, LOG_PREFIX|LOG_NEWLINE, 0,
1541                           NULL, 0, recursion_msg, printed_len);
1542         }
1543
1544         /*
1545          * The printf needs to come first; we need the syslog
1546          * prefix which might be passed-in as a parameter.
1547          */
1548         text_len = vscnprintf(text, sizeof(textbuf), fmt, args);
1549
1550         /* mark and strip a trailing newline */
1551         if (text_len && text[text_len-1] == '\n') {
1552                 text_len--;
1553                 lflags |= LOG_NEWLINE;
1554         }
1555
1556         /* strip kernel syslog prefix and extract log level or control flags */
1557         if (facility == 0) {
1558                 int kern_level = printk_get_level(text);
1559
1560                 if (kern_level) {
1561                         const char *end_of_header = printk_skip_level(text);
1562                         switch (kern_level) {
1563                         case '0' ... '7':
1564                                 if (level == -1)
1565                                         level = kern_level - '0';
1566                         case 'd':       /* KERN_DEFAULT */
1567                                 lflags |= LOG_PREFIX;
1568                         case 'c':       /* KERN_CONT */
1569                                 break;
1570                         }
1571                         text_len -= end_of_header - text;
1572                         text = (char *)end_of_header;
1573                 }
1574         }
1575
1576         if (level == -1)
1577                 level = default_message_loglevel;
1578
1579         if (dict)
1580                 lflags |= LOG_PREFIX|LOG_NEWLINE;
1581
1582         if (!(lflags & LOG_NEWLINE)) {
1583                 /*
1584                  * Flush the conflicting buffer. An earlier newline was missing,
1585                  * or another task also prints continuation lines.
1586                  */
1587                 if (cont.len && (lflags & LOG_PREFIX || cont.owner != current))
1588                         cont_flush(LOG_NEWLINE);
1589
1590                 /* buffer line if possible, otherwise store it right away */
1591                 if (!cont_add(facility, level, text, text_len))
1592                         log_store(facility, level, lflags | LOG_CONT, 0,
1593                                   dict, dictlen, text, text_len);
1594         } else {
1595                 bool stored = false;
1596
1597                 /*
1598                  * If an earlier newline was missing and it was the same task,
1599                  * either merge it with the current buffer and flush, or if
1600                  * there was a race with interrupts (prefix == true) then just
1601                  * flush it out and store this line separately.
1602                  */
1603                 if (cont.len && cont.owner == current) {
1604                         if (!(lflags & LOG_PREFIX))
1605                                 stored = cont_add(facility, level, text, text_len);
1606                         cont_flush(LOG_NEWLINE);
1607                 }
1608
1609                 if (!stored)
1610                         log_store(facility, level, lflags, 0,
1611                                   dict, dictlen, text, text_len);
1612         }
1613         printed_len += text_len;
1614
1615         /*
1616          * Try to acquire and then immediately release the console semaphore.
1617          * The release will print out buffers and wake up /dev/kmsg and syslog()
1618          * users.
1619          *
1620          * The console_trylock_for_printk() function will release 'logbuf_lock'
1621          * regardless of whether it actually gets the console semaphore or not.
1622          */
1623         if (console_trylock_for_printk(this_cpu))
1624                 console_unlock();
1625
1626         lockdep_on();
1627 out_restore_irqs:
1628         local_irq_restore(flags);
1629
1630         return printed_len;
1631 }
1632 EXPORT_SYMBOL(vprintk_emit);
1633
1634 asmlinkage int vprintk(const char *fmt, va_list args)
1635 {
1636         return vprintk_emit(0, -1, NULL, 0, fmt, args);
1637 }
1638 EXPORT_SYMBOL(vprintk);
1639
1640 asmlinkage int printk_emit(int facility, int level,
1641                            const char *dict, size_t dictlen,
1642                            const char *fmt, ...)
1643 {
1644         va_list args;
1645         int r;
1646
1647         va_start(args, fmt);
1648         r = vprintk_emit(facility, level, dict, dictlen, fmt, args);
1649         va_end(args);
1650
1651         return r;
1652 }
1653 EXPORT_SYMBOL(printk_emit);
1654
1655 /**
1656  * printk - print a kernel message
1657  * @fmt: format string
1658  *
1659  * This is printk(). It can be called from any context. We want it to work.
1660  *
1661  * We try to grab the console_lock. If we succeed, it's easy - we log the
1662  * output and call the console drivers.  If we fail to get the semaphore, we
1663  * place the output into the log buffer and return. The current holder of
1664  * the console_sem will notice the new output in console_unlock(); and will
1665  * send it to the consoles before releasing the lock.
1666  *
1667  * One effect of this deferred printing is that code which calls printk() and
1668  * then changes console_loglevel may break. This is because console_loglevel
1669  * is inspected when the actual printing occurs.
1670  *
1671  * See also:
1672  * printf(3)
1673  *
1674  * See the vsnprintf() documentation for format string extensions over C99.
1675  */
1676 asmlinkage int printk(const char *fmt, ...)
1677 {
1678         va_list args;
1679         int r;
1680
1681 #ifdef CONFIG_KGDB_KDB
1682         if (unlikely(kdb_trap_printk)) {
1683                 va_start(args, fmt);
1684                 r = vkdb_printf(fmt, args);
1685                 va_end(args);
1686                 return r;
1687         }
1688 #endif
1689         va_start(args, fmt);
1690         r = vprintk_emit(0, -1, NULL, 0, fmt, args);
1691         va_end(args);
1692
1693         return r;
1694 }
1695 EXPORT_SYMBOL(printk);
1696
1697 #else /* CONFIG_PRINTK */
1698
1699 #define LOG_LINE_MAX            0
1700 #define PREFIX_MAX              0
1701 #define LOG_LINE_MAX 0
1702 static u64 syslog_seq;
1703 static u32 syslog_idx;
1704 static u64 console_seq;
1705 static u32 console_idx;
1706 static enum log_flags syslog_prev;
1707 static u64 log_first_seq;
1708 static u32 log_first_idx;
1709 static u64 log_next_seq;
1710 static enum log_flags console_prev;
1711 static struct cont {
1712         size_t len;
1713         size_t cons;
1714         u8 level;
1715         bool flushed:1;
1716 } cont;
1717 static struct log *log_from_idx(u32 idx) { return NULL; }
1718 static u32 log_next(u32 idx) { return 0; }
1719 static void call_console_drivers(int level, const char *text, size_t len) {}
1720 static size_t msg_print_text(const struct log *msg, enum log_flags prev,
1721                              bool syslog, char *buf, size_t size) { return 0; }
1722 static size_t cont_print_text(char *text, size_t size) { return 0; }
1723
1724 #endif /* CONFIG_PRINTK */
1725
1726 static int __add_preferred_console(char *name, int idx, char *options,
1727                                    char *brl_options)
1728 {
1729         struct console_cmdline *c;
1730         int i;
1731
1732         /*
1733          *      See if this tty is not yet registered, and
1734          *      if we have a slot free.
1735          */
1736         for (i = 0; i < MAX_CMDLINECONSOLES && console_cmdline[i].name[0]; i++)
1737                 if (strcmp(console_cmdline[i].name, name) == 0 &&
1738                           console_cmdline[i].index == idx) {
1739                                 if (!brl_options)
1740                                         selected_console = i;
1741                                 return 0;
1742                 }
1743         if (i == MAX_CMDLINECONSOLES)
1744                 return -E2BIG;
1745         if (!brl_options)
1746                 selected_console = i;
1747         c = &console_cmdline[i];
1748         strlcpy(c->name, name, sizeof(c->name));
1749         c->options = options;
1750 #ifdef CONFIG_A11Y_BRAILLE_CONSOLE
1751         c->brl_options = brl_options;
1752 #endif
1753         c->index = idx;
1754         return 0;
1755 }
1756 /*
1757  * Set up a list of consoles.  Called from init/main.c
1758  */
1759 static int __init console_setup(char *str)
1760 {
1761         char buf[sizeof(console_cmdline[0].name) + 4]; /* 4 for index */
1762         char *s, *options, *brl_options = NULL;
1763         int idx;
1764
1765 #ifdef CONFIG_A11Y_BRAILLE_CONSOLE
1766         if (!memcmp(str, "brl,", 4)) {
1767                 brl_options = "";
1768                 str += 4;
1769         } else if (!memcmp(str, "brl=", 4)) {
1770                 brl_options = str + 4;
1771                 str = strchr(brl_options, ',');
1772                 if (!str) {
1773                         printk(KERN_ERR "need port name after brl=\n");
1774                         return 1;
1775                 }
1776                 *(str++) = 0;
1777         }
1778 #endif
1779
1780         /*
1781          * Decode str into name, index, options.
1782          */
1783         if (str[0] >= '0' && str[0] <= '9') {
1784                 strcpy(buf, "ttyS");
1785                 strncpy(buf + 4, str, sizeof(buf) - 5);
1786         } else {
1787                 strncpy(buf, str, sizeof(buf) - 1);
1788         }
1789         buf[sizeof(buf) - 1] = 0;
1790         if ((options = strchr(str, ',')) != NULL)
1791                 *(options++) = 0;
1792 #ifdef __sparc__
1793         if (!strcmp(str, "ttya"))
1794                 strcpy(buf, "ttyS0");
1795         if (!strcmp(str, "ttyb"))
1796                 strcpy(buf, "ttyS1");
1797 #endif
1798         for (s = buf; *s; s++)
1799                 if ((*s >= '0' && *s <= '9') || *s == ',')
1800                         break;
1801         idx = simple_strtoul(s, NULL, 10);
1802         *s = 0;
1803
1804         __add_preferred_console(buf, idx, options, brl_options);
1805         console_set_on_cmdline = 1;
1806         return 1;
1807 }
1808 __setup("console=", console_setup);
1809
1810 /**
1811  * add_preferred_console - add a device to the list of preferred consoles.
1812  * @name: device name
1813  * @idx: device index
1814  * @options: options for this console
1815  *
1816  * The last preferred console added will be used for kernel messages
1817  * and stdin/out/err for init.  Normally this is used by console_setup
1818  * above to handle user-supplied console arguments; however it can also
1819  * be used by arch-specific code either to override the user or more
1820  * commonly to provide a default console (ie from PROM variables) when
1821  * the user has not supplied one.
1822  */
1823 int add_preferred_console(char *name, int idx, char *options)
1824 {
1825         return __add_preferred_console(name, idx, options, NULL);
1826 }
1827
1828 int update_console_cmdline(char *name, int idx, char *name_new, int idx_new, char *options)
1829 {
1830         struct console_cmdline *c;
1831         int i;
1832
1833         for (i = 0; i < MAX_CMDLINECONSOLES && console_cmdline[i].name[0]; i++)
1834                 if (strcmp(console_cmdline[i].name, name) == 0 &&
1835                           console_cmdline[i].index == idx) {
1836                                 c = &console_cmdline[i];
1837                                 strlcpy(c->name, name_new, sizeof(c->name));
1838                                 c->name[sizeof(c->name) - 1] = 0;
1839                                 c->options = options;
1840                                 c->index = idx_new;
1841                                 return i;
1842                 }
1843         /* not found */
1844         return -1;
1845 }
1846
1847 bool console_suspend_enabled = 1;
1848 EXPORT_SYMBOL(console_suspend_enabled);
1849
1850 static int __init console_suspend_disable(char *str)
1851 {
1852         console_suspend_enabled = 0;
1853         return 1;
1854 }
1855 __setup("no_console_suspend", console_suspend_disable);
1856 module_param_named(console_suspend, console_suspend_enabled,
1857                 bool, S_IRUGO | S_IWUSR);
1858 MODULE_PARM_DESC(console_suspend, "suspend console during suspend"
1859         " and hibernate operations");
1860
1861 /**
1862  * suspend_console - suspend the console subsystem
1863  *
1864  * This disables printk() while we go into suspend states
1865  */
1866 void suspend_console(void)
1867 {
1868         if (!console_suspend_enabled)
1869                 return;
1870         printk("Suspending console(s) (use no_console_suspend to debug)\n");
1871         console_lock();
1872         console_suspended = 1;
1873         up(&console_sem);
1874 }
1875
1876 void resume_console(void)
1877 {
1878         if (!console_suspend_enabled)
1879                 return;
1880         down(&console_sem);
1881         console_suspended = 0;
1882         console_unlock();
1883 }
1884
1885 /**
1886  * console_cpu_notify - print deferred console messages after CPU hotplug
1887  * @self: notifier struct
1888  * @action: CPU hotplug event
1889  * @hcpu: unused
1890  *
1891  * If printk() is called from a CPU that is not online yet, the messages
1892  * will be spooled but will not show up on the console.  This function is
1893  * called when a new CPU comes online (or fails to come up), and ensures
1894  * that any such output gets printed.
1895  */
1896 static int __cpuinit console_cpu_notify(struct notifier_block *self,
1897         unsigned long action, void *hcpu)
1898 {
1899         switch (action) {
1900         case CPU_ONLINE:
1901         case CPU_DEAD:
1902         case CPU_DOWN_FAILED:
1903         case CPU_UP_CANCELED:
1904                 console_lock();
1905                 console_unlock();
1906         }
1907         return NOTIFY_OK;
1908 }
1909
1910 /**
1911  * console_lock - lock the console system for exclusive use.
1912  *
1913  * Acquires a lock which guarantees that the caller has
1914  * exclusive access to the console system and the console_drivers list.
1915  *
1916  * Can sleep, returns nothing.
1917  */
1918 void console_lock(void)
1919 {
1920         might_sleep();
1921
1922         down(&console_sem);
1923         if (console_suspended)
1924                 return;
1925         console_locked = 1;
1926         console_may_schedule = 1;
1927         mutex_acquire(&console_lock_dep_map, 0, 0, _RET_IP_);
1928 }
1929 EXPORT_SYMBOL(console_lock);
1930
1931 /**
1932  * console_trylock - try to lock the console system for exclusive use.
1933  *
1934  * Tried to acquire a lock which guarantees that the caller has
1935  * exclusive access to the console system and the console_drivers list.
1936  *
1937  * returns 1 on success, and 0 on failure to acquire the lock.
1938  */
1939 int console_trylock(void)
1940 {
1941         if (down_trylock(&console_sem))
1942                 return 0;
1943         if (console_suspended) {
1944                 up(&console_sem);
1945                 return 0;
1946         }
1947         console_locked = 1;
1948         console_may_schedule = 0;
1949         mutex_acquire(&console_lock_dep_map, 0, 1, _RET_IP_);
1950         return 1;
1951 }
1952 EXPORT_SYMBOL(console_trylock);
1953
1954 int is_console_locked(void)
1955 {
1956         return console_locked;
1957 }
1958
1959 /*
1960  * Delayed printk version, for scheduler-internal messages:
1961  */
1962 #define PRINTK_BUF_SIZE         512
1963
1964 #define PRINTK_PENDING_WAKEUP   0x01
1965 #define PRINTK_PENDING_SCHED    0x02
1966
1967 static DEFINE_PER_CPU(int, printk_pending);
1968 static DEFINE_PER_CPU(char [PRINTK_BUF_SIZE], printk_sched_buf);
1969
1970 void printk_tick(void)
1971 {
1972         if (__this_cpu_read(printk_pending)) {
1973                 int pending = __this_cpu_xchg(printk_pending, 0);
1974                 if (pending & PRINTK_PENDING_SCHED) {
1975                         char *buf = __get_cpu_var(printk_sched_buf);
1976                         printk(KERN_WARNING "[sched_delayed] %s", buf);
1977                 }
1978                 if (pending & PRINTK_PENDING_WAKEUP)
1979                         wake_up_interruptible(&log_wait);
1980         }
1981 }
1982
1983 int printk_needs_cpu(int cpu)
1984 {
1985         if (cpu_is_offline(cpu))
1986                 printk_tick();
1987         return __this_cpu_read(printk_pending);
1988 }
1989
1990 void wake_up_klogd(void)
1991 {
1992         if (waitqueue_active(&log_wait))
1993                 this_cpu_or(printk_pending, PRINTK_PENDING_WAKEUP);
1994 }
1995
1996 static void console_cont_flush(char *text, size_t size)
1997 {
1998         unsigned long flags;
1999         size_t len;
2000
2001         raw_spin_lock_irqsave(&logbuf_lock, flags);
2002
2003         if (!cont.len)
2004                 goto out;
2005
2006         /*
2007          * We still queue earlier records, likely because the console was
2008          * busy. The earlier ones need to be printed before this one, we
2009          * did not flush any fragment so far, so just let it queue up.
2010          */
2011         if (console_seq < log_next_seq && !cont.cons)
2012                 goto out;
2013
2014         len = cont_print_text(text, size);
2015         raw_spin_unlock(&logbuf_lock);
2016         stop_critical_timings();
2017         call_console_drivers(cont.level, text, len);
2018         start_critical_timings();
2019         local_irq_restore(flags);
2020         return;
2021 out:
2022         raw_spin_unlock_irqrestore(&logbuf_lock, flags);
2023 }
2024
2025 /**
2026  * console_unlock - unlock the console system
2027  *
2028  * Releases the console_lock which the caller holds on the console system
2029  * and the console driver list.
2030  *
2031  * While the console_lock was held, console output may have been buffered
2032  * by printk().  If this is the case, console_unlock(); emits
2033  * the output prior to releasing the lock.
2034  *
2035  * If there is output waiting, we wake /dev/kmsg and syslog() users.
2036  *
2037  * console_unlock(); may be called from any context.
2038  */
2039 void console_unlock(void)
2040 {
2041         static char text[LOG_LINE_MAX + PREFIX_MAX];
2042         static u64 seen_seq;
2043         unsigned long flags;
2044         bool wake_klogd = false;
2045         bool retry;
2046
2047         if (console_suspended) {
2048                 up(&console_sem);
2049                 return;
2050         }
2051
2052         console_may_schedule = 0;
2053
2054         /* flush buffered message fragment immediately to console */
2055         console_cont_flush(text, sizeof(text));
2056 again:
2057         for (;;) {
2058                 struct log *msg;
2059                 size_t len;
2060                 int level;
2061
2062                 raw_spin_lock_irqsave(&logbuf_lock, flags);
2063                 if (seen_seq != log_next_seq) {
2064                         wake_klogd = true;
2065                         seen_seq = log_next_seq;
2066                 }
2067
2068                 if (console_seq < log_first_seq) {
2069                         /* messages are gone, move to first one */
2070                         console_seq = log_first_seq;
2071                         console_idx = log_first_idx;
2072                         console_prev = 0;
2073                 }
2074 skip:
2075                 if (console_seq == log_next_seq)
2076                         break;
2077
2078                 msg = log_from_idx(console_idx);
2079                 if (msg->flags & LOG_NOCONS) {
2080                         /*
2081                          * Skip record we have buffered and already printed
2082                          * directly to the console when we received it.
2083                          */
2084                         console_idx = log_next(console_idx);
2085                         console_seq++;
2086                         /*
2087                          * We will get here again when we register a new
2088                          * CON_PRINTBUFFER console. Clear the flag so we
2089                          * will properly dump everything later.
2090                          */
2091                         msg->flags &= ~LOG_NOCONS;
2092                         console_prev = msg->flags;
2093                         goto skip;
2094                 }
2095
2096                 level = msg->level;
2097                 len = msg_print_text(msg, console_prev, false,
2098                                      text, sizeof(text));
2099                 console_idx = log_next(console_idx);
2100                 console_seq++;
2101                 console_prev = msg->flags;
2102                 raw_spin_unlock(&logbuf_lock);
2103
2104                 stop_critical_timings();        /* don't trace print latency */
2105                 call_console_drivers(level, text, len);
2106                 start_critical_timings();
2107                 local_irq_restore(flags);
2108         }
2109         console_locked = 0;
2110         mutex_release(&console_lock_dep_map, 1, _RET_IP_);
2111
2112         /* Release the exclusive_console once it is used */
2113         if (unlikely(exclusive_console))
2114                 exclusive_console = NULL;
2115
2116         raw_spin_unlock(&logbuf_lock);
2117
2118         up(&console_sem);
2119
2120         /*
2121          * Someone could have filled up the buffer again, so re-check if there's
2122          * something to flush. In case we cannot trylock the console_sem again,
2123          * there's a new owner and the console_unlock() from them will do the
2124          * flush, no worries.
2125          */
2126         raw_spin_lock(&logbuf_lock);
2127         retry = console_seq != log_next_seq;
2128         raw_spin_unlock_irqrestore(&logbuf_lock, flags);
2129
2130         if (retry && console_trylock())
2131                 goto again;
2132
2133         if (wake_klogd)
2134                 wake_up_klogd();
2135 }
2136 EXPORT_SYMBOL(console_unlock);
2137
2138 /**
2139  * console_conditional_schedule - yield the CPU if required
2140  *
2141  * If the console code is currently allowed to sleep, and
2142  * if this CPU should yield the CPU to another task, do
2143  * so here.
2144  *
2145  * Must be called within console_lock();.
2146  */
2147 void __sched console_conditional_schedule(void)
2148 {
2149         if (console_may_schedule)
2150                 cond_resched();
2151 }
2152 EXPORT_SYMBOL(console_conditional_schedule);
2153
2154 void console_unblank(void)
2155 {
2156         struct console *c;
2157
2158         /*
2159          * console_unblank can no longer be called in interrupt context unless
2160          * oops_in_progress is set to 1..
2161          */
2162         if (oops_in_progress) {
2163                 if (down_trylock(&console_sem) != 0)
2164                         return;
2165         } else
2166                 console_lock();
2167
2168         console_locked = 1;
2169         console_may_schedule = 0;
2170         for_each_console(c)
2171                 if ((c->flags & CON_ENABLED) && c->unblank)
2172                         c->unblank();
2173         console_unlock();
2174 }
2175
2176 /*
2177  * Return the console tty driver structure and its associated index
2178  */
2179 struct tty_driver *console_device(int *index)
2180 {
2181         struct console *c;
2182         struct tty_driver *driver = NULL;
2183
2184         console_lock();
2185         for_each_console(c) {
2186                 if (!c->device)
2187                         continue;
2188                 driver = c->device(c, index);
2189                 if (driver)
2190                         break;
2191         }
2192         console_unlock();
2193         return driver;
2194 }
2195
2196 /*
2197  * Prevent further output on the passed console device so that (for example)
2198  * serial drivers can disable console output before suspending a port, and can
2199  * re-enable output afterwards.
2200  */
2201 void console_stop(struct console *console)
2202 {
2203         console_lock();
2204         console->flags &= ~CON_ENABLED;
2205         console_unlock();
2206 }
2207 EXPORT_SYMBOL(console_stop);
2208
2209 void console_start(struct console *console)
2210 {
2211         console_lock();
2212         console->flags |= CON_ENABLED;
2213         console_unlock();
2214 }
2215 EXPORT_SYMBOL(console_start);
2216
2217 static int __read_mostly keep_bootcon;
2218
2219 static int __init keep_bootcon_setup(char *str)
2220 {
2221         keep_bootcon = 1;
2222         printk(KERN_INFO "debug: skip boot console de-registration.\n");
2223
2224         return 0;
2225 }
2226
2227 early_param("keep_bootcon", keep_bootcon_setup);
2228
2229 /*
2230  * The console driver calls this routine during kernel initialization
2231  * to register the console printing procedure with printk() and to
2232  * print any messages that were printed by the kernel before the
2233  * console driver was initialized.
2234  *
2235  * This can happen pretty early during the boot process (because of
2236  * early_printk) - sometimes before setup_arch() completes - be careful
2237  * of what kernel features are used - they may not be initialised yet.
2238  *
2239  * There are two types of consoles - bootconsoles (early_printk) and
2240  * "real" consoles (everything which is not a bootconsole) which are
2241  * handled differently.
2242  *  - Any number of bootconsoles can be registered at any time.
2243  *  - As soon as a "real" console is registered, all bootconsoles
2244  *    will be unregistered automatically.
2245  *  - Once a "real" console is registered, any attempt to register a
2246  *    bootconsoles will be rejected
2247  */
2248 void register_console(struct console *newcon)
2249 {
2250         int i;
2251         unsigned long flags;
2252         struct console *bcon = NULL;
2253
2254         /*
2255          * before we register a new CON_BOOT console, make sure we don't
2256          * already have a valid console
2257          */
2258         if (console_drivers && newcon->flags & CON_BOOT) {
2259                 /* find the last or real console */
2260                 for_each_console(bcon) {
2261                         if (!(bcon->flags & CON_BOOT)) {
2262                                 printk(KERN_INFO "Too late to register bootconsole %s%d\n",
2263                                         newcon->name, newcon->index);
2264                                 return;
2265                         }
2266                 }
2267         }
2268
2269         if (console_drivers && console_drivers->flags & CON_BOOT)
2270                 bcon = console_drivers;
2271
2272         if (preferred_console < 0 || bcon || !console_drivers)
2273                 preferred_console = selected_console;
2274
2275         if (newcon->early_setup)
2276                 newcon->early_setup();
2277
2278         /*
2279          *      See if we want to use this console driver. If we
2280          *      didn't select a console we take the first one
2281          *      that registers here.
2282          */
2283         if (preferred_console < 0) {
2284                 if (newcon->index < 0)
2285                         newcon->index = 0;
2286                 if (newcon->setup == NULL ||
2287                     newcon->setup(newcon, NULL) == 0) {
2288                         newcon->flags |= CON_ENABLED;
2289                         if (newcon->device) {
2290                                 newcon->flags |= CON_CONSDEV;
2291                                 preferred_console = 0;
2292                         }
2293                 }
2294         }
2295
2296         /*
2297          *      See if this console matches one we selected on
2298          *      the command line.
2299          */
2300         for (i = 0; i < MAX_CMDLINECONSOLES && console_cmdline[i].name[0];
2301                         i++) {
2302                 if (strcmp(console_cmdline[i].name, newcon->name) != 0)
2303                         continue;
2304                 if (newcon->index >= 0 &&
2305                     newcon->index != console_cmdline[i].index)
2306                         continue;
2307                 if (newcon->index < 0)
2308                         newcon->index = console_cmdline[i].index;
2309 #ifdef CONFIG_A11Y_BRAILLE_CONSOLE
2310                 if (console_cmdline[i].brl_options) {
2311                         newcon->flags |= CON_BRL;
2312                         braille_register_console(newcon,
2313                                         console_cmdline[i].index,
2314                                         console_cmdline[i].options,
2315                                         console_cmdline[i].brl_options);
2316                         return;
2317                 }
2318 #endif
2319                 if (newcon->setup &&
2320                     newcon->setup(newcon, console_cmdline[i].options) != 0)
2321                         break;
2322                 newcon->flags |= CON_ENABLED;
2323                 newcon->index = console_cmdline[i].index;
2324                 if (i == selected_console) {
2325                         newcon->flags |= CON_CONSDEV;
2326                         preferred_console = selected_console;
2327                 }
2328                 break;
2329         }
2330
2331         if (!(newcon->flags & CON_ENABLED))
2332                 return;
2333
2334         /*
2335          * If we have a bootconsole, and are switching to a real console,
2336          * don't print everything out again, since when the boot console, and
2337          * the real console are the same physical device, it's annoying to
2338          * see the beginning boot messages twice
2339          */
2340         if (bcon && ((newcon->flags & (CON_CONSDEV | CON_BOOT)) == CON_CONSDEV))
2341                 newcon->flags &= ~CON_PRINTBUFFER;
2342
2343         /*
2344          *      Put this console in the list - keep the
2345          *      preferred driver at the head of the list.
2346          */
2347         console_lock();
2348         if ((newcon->flags & CON_CONSDEV) || console_drivers == NULL) {
2349                 newcon->next = console_drivers;
2350                 console_drivers = newcon;
2351                 if (newcon->next)
2352                         newcon->next->flags &= ~CON_CONSDEV;
2353         } else {
2354                 newcon->next = console_drivers->next;
2355                 console_drivers->next = newcon;
2356         }
2357         if (newcon->flags & CON_PRINTBUFFER) {
2358                 /*
2359                  * console_unlock(); will print out the buffered messages
2360                  * for us.
2361                  */
2362                 raw_spin_lock_irqsave(&logbuf_lock, flags);
2363                 console_seq = syslog_seq;
2364                 console_idx = syslog_idx;
2365                 console_prev = syslog_prev;
2366                 raw_spin_unlock_irqrestore(&logbuf_lock, flags);
2367                 /*
2368                  * We're about to replay the log buffer.  Only do this to the
2369                  * just-registered console to avoid excessive message spam to
2370                  * the already-registered consoles.
2371                  */
2372                 exclusive_console = newcon;
2373         }
2374         console_unlock();
2375         console_sysfs_notify();
2376
2377         /*
2378          * By unregistering the bootconsoles after we enable the real console
2379          * we get the "console xxx enabled" message on all the consoles -
2380          * boot consoles, real consoles, etc - this is to ensure that end
2381          * users know there might be something in the kernel's log buffer that
2382          * went to the bootconsole (that they do not see on the real console)
2383          */
2384         if (bcon &&
2385             ((newcon->flags & (CON_CONSDEV | CON_BOOT)) == CON_CONSDEV) &&
2386             !keep_bootcon) {
2387                 /* we need to iterate through twice, to make sure we print
2388                  * everything out, before we unregister the console(s)
2389                  */
2390                 printk(KERN_INFO "console [%s%d] enabled, bootconsole disabled\n",
2391                         newcon->name, newcon->index);
2392                 for_each_console(bcon)
2393                         if (bcon->flags & CON_BOOT)
2394                                 unregister_console(bcon);
2395         } else {
2396                 printk(KERN_INFO "%sconsole [%s%d] enabled\n",
2397                         (newcon->flags & CON_BOOT) ? "boot" : "" ,
2398                         newcon->name, newcon->index);
2399         }
2400 }
2401 EXPORT_SYMBOL(register_console);
2402
2403 int unregister_console(struct console *console)
2404 {
2405         struct console *a, *b;
2406         int res = 1;
2407
2408 #ifdef CONFIG_A11Y_BRAILLE_CONSOLE
2409         if (console->flags & CON_BRL)
2410                 return braille_unregister_console(console);
2411 #endif
2412
2413         console_lock();
2414         if (console_drivers == console) {
2415                 console_drivers=console->next;
2416                 res = 0;
2417         } else if (console_drivers) {
2418                 for (a=console_drivers->next, b=console_drivers ;
2419                      a; b=a, a=b->next) {
2420                         if (a == console) {
2421                                 b->next = a->next;
2422                                 res = 0;
2423                                 break;
2424                         }
2425                 }
2426         }
2427
2428         /*
2429          * If this isn't the last console and it has CON_CONSDEV set, we
2430          * need to set it on the next preferred console.
2431          */
2432         if (console_drivers != NULL && console->flags & CON_CONSDEV)
2433                 console_drivers->flags |= CON_CONSDEV;
2434
2435         console_unlock();
2436         console_sysfs_notify();
2437         return res;
2438 }
2439 EXPORT_SYMBOL(unregister_console);
2440
2441 static int __init printk_late_init(void)
2442 {
2443         struct console *con;
2444
2445         for_each_console(con) {
2446                 if (!keep_bootcon && con->flags & CON_BOOT) {
2447                         printk(KERN_INFO "turn off boot console %s%d\n",
2448                                 con->name, con->index);
2449                         unregister_console(con);
2450                 }
2451         }
2452         hotcpu_notifier(console_cpu_notify, 0);
2453         return 0;
2454 }
2455 late_initcall(printk_late_init);
2456
2457 #if defined CONFIG_PRINTK
2458
2459 int printk_sched(const char *fmt, ...)
2460 {
2461         unsigned long flags;
2462         va_list args;
2463         char *buf;
2464         int r;
2465
2466         local_irq_save(flags);
2467         buf = __get_cpu_var(printk_sched_buf);
2468
2469         va_start(args, fmt);
2470         r = vsnprintf(buf, PRINTK_BUF_SIZE, fmt, args);
2471         va_end(args);
2472
2473         __this_cpu_or(printk_pending, PRINTK_PENDING_SCHED);
2474         local_irq_restore(flags);
2475
2476         return r;
2477 }
2478
2479 /*
2480  * printk rate limiting, lifted from the networking subsystem.
2481  *
2482  * This enforces a rate limit: not more than 10 kernel messages
2483  * every 5s to make a denial-of-service attack impossible.
2484  */
2485 DEFINE_RATELIMIT_STATE(printk_ratelimit_state, 5 * HZ, 10);
2486
2487 int __printk_ratelimit(const char *func)
2488 {
2489         return ___ratelimit(&printk_ratelimit_state, func);
2490 }
2491 EXPORT_SYMBOL(__printk_ratelimit);
2492
2493 /**
2494  * printk_timed_ratelimit - caller-controlled printk ratelimiting
2495  * @caller_jiffies: pointer to caller's state
2496  * @interval_msecs: minimum interval between prints
2497  *
2498  * printk_timed_ratelimit() returns true if more than @interval_msecs
2499  * milliseconds have elapsed since the last time printk_timed_ratelimit()
2500  * returned true.
2501  */
2502 bool printk_timed_ratelimit(unsigned long *caller_jiffies,
2503                         unsigned int interval_msecs)
2504 {
2505         if (*caller_jiffies == 0
2506                         || !time_in_range(jiffies, *caller_jiffies,
2507                                         *caller_jiffies
2508                                         + msecs_to_jiffies(interval_msecs))) {
2509                 *caller_jiffies = jiffies;
2510                 return true;
2511         }
2512         return false;
2513 }
2514 EXPORT_SYMBOL(printk_timed_ratelimit);
2515
2516 static DEFINE_SPINLOCK(dump_list_lock);
2517 static LIST_HEAD(dump_list);
2518
2519 /**
2520  * kmsg_dump_register - register a kernel log dumper.
2521  * @dumper: pointer to the kmsg_dumper structure
2522  *
2523  * Adds a kernel log dumper to the system. The dump callback in the
2524  * structure will be called when the kernel oopses or panics and must be
2525  * set. Returns zero on success and %-EINVAL or %-EBUSY otherwise.
2526  */
2527 int kmsg_dump_register(struct kmsg_dumper *dumper)
2528 {
2529         unsigned long flags;
2530         int err = -EBUSY;
2531
2532         /* The dump callback needs to be set */
2533         if (!dumper->dump)
2534                 return -EINVAL;
2535
2536         spin_lock_irqsave(&dump_list_lock, flags);
2537         /* Don't allow registering multiple times */
2538         if (!dumper->registered) {
2539                 dumper->registered = 1;
2540                 list_add_tail_rcu(&dumper->list, &dump_list);
2541                 err = 0;
2542         }
2543         spin_unlock_irqrestore(&dump_list_lock, flags);
2544
2545         return err;
2546 }
2547 EXPORT_SYMBOL_GPL(kmsg_dump_register);
2548
2549 /**
2550  * kmsg_dump_unregister - unregister a kmsg dumper.
2551  * @dumper: pointer to the kmsg_dumper structure
2552  *
2553  * Removes a dump device from the system. Returns zero on success and
2554  * %-EINVAL otherwise.
2555  */
2556 int kmsg_dump_unregister(struct kmsg_dumper *dumper)
2557 {
2558         unsigned long flags;
2559         int err = -EINVAL;
2560
2561         spin_lock_irqsave(&dump_list_lock, flags);
2562         if (dumper->registered) {
2563                 dumper->registered = 0;
2564                 list_del_rcu(&dumper->list);
2565                 err = 0;
2566         }
2567         spin_unlock_irqrestore(&dump_list_lock, flags);
2568         synchronize_rcu();
2569
2570         return err;
2571 }
2572 EXPORT_SYMBOL_GPL(kmsg_dump_unregister);
2573
2574 static bool always_kmsg_dump;
2575 module_param_named(always_kmsg_dump, always_kmsg_dump, bool, S_IRUGO | S_IWUSR);
2576
2577 /**
2578  * kmsg_dump - dump kernel log to kernel message dumpers.
2579  * @reason: the reason (oops, panic etc) for dumping
2580  *
2581  * Call each of the registered dumper's dump() callback, which can
2582  * retrieve the kmsg records with kmsg_dump_get_line() or
2583  * kmsg_dump_get_buffer().
2584  */
2585 void kmsg_dump(enum kmsg_dump_reason reason)
2586 {
2587         struct kmsg_dumper *dumper;
2588         unsigned long flags;
2589
2590         if ((reason > KMSG_DUMP_OOPS) && !always_kmsg_dump)
2591                 return;
2592
2593         rcu_read_lock();
2594         list_for_each_entry_rcu(dumper, &dump_list, list) {
2595                 if (dumper->max_reason && reason > dumper->max_reason)
2596                         continue;
2597
2598                 /* initialize iterator with data about the stored records */
2599                 dumper->active = true;
2600
2601                 raw_spin_lock_irqsave(&logbuf_lock, flags);
2602                 dumper->cur_seq = clear_seq;
2603                 dumper->cur_idx = clear_idx;
2604                 dumper->next_seq = log_next_seq;
2605                 dumper->next_idx = log_next_idx;
2606                 raw_spin_unlock_irqrestore(&logbuf_lock, flags);
2607
2608                 /* invoke dumper which will iterate over records */
2609                 dumper->dump(dumper, reason);
2610
2611                 /* reset iterator */
2612                 dumper->active = false;
2613         }
2614         rcu_read_unlock();
2615 }
2616
2617 /**
2618  * kmsg_dump_get_line_nolock - retrieve one kmsg log line (unlocked version)
2619  * @dumper: registered kmsg dumper
2620  * @syslog: include the "<4>" prefixes
2621  * @line: buffer to copy the line to
2622  * @size: maximum size of the buffer
2623  * @len: length of line placed into buffer
2624  *
2625  * Start at the beginning of the kmsg buffer, with the oldest kmsg
2626  * record, and copy one record into the provided buffer.
2627  *
2628  * Consecutive calls will return the next available record moving
2629  * towards the end of the buffer with the youngest messages.
2630  *
2631  * A return value of FALSE indicates that there are no more records to
2632  * read.
2633  *
2634  * The function is similar to kmsg_dump_get_line(), but grabs no locks.
2635  */
2636 bool kmsg_dump_get_line_nolock(struct kmsg_dumper *dumper, bool syslog,
2637                                char *line, size_t size, size_t *len)
2638 {
2639         struct log *msg;
2640         size_t l = 0;
2641         bool ret = false;
2642
2643         if (!dumper->active)
2644                 goto out;
2645
2646         if (dumper->cur_seq < log_first_seq) {
2647                 /* messages are gone, move to first available one */
2648                 dumper->cur_seq = log_first_seq;
2649                 dumper->cur_idx = log_first_idx;
2650         }
2651
2652         /* last entry */
2653         if (dumper->cur_seq >= log_next_seq)
2654                 goto out;
2655
2656         msg = log_from_idx(dumper->cur_idx);
2657         l = msg_print_text(msg, 0, syslog, line, size);
2658
2659         dumper->cur_idx = log_next(dumper->cur_idx);
2660         dumper->cur_seq++;
2661         ret = true;
2662 out:
2663         if (len)
2664                 *len = l;
2665         return ret;
2666 }
2667
2668 /**
2669  * kmsg_dump_get_line - retrieve one kmsg log line
2670  * @dumper: registered kmsg dumper
2671  * @syslog: include the "<4>" prefixes
2672  * @line: buffer to copy the line to
2673  * @size: maximum size of the buffer
2674  * @len: length of line placed into buffer
2675  *
2676  * Start at the beginning of the kmsg buffer, with the oldest kmsg
2677  * record, and copy one record into the provided buffer.
2678  *
2679  * Consecutive calls will return the next available record moving
2680  * towards the end of the buffer with the youngest messages.
2681  *
2682  * A return value of FALSE indicates that there are no more records to
2683  * read.
2684  */
2685 bool kmsg_dump_get_line(struct kmsg_dumper *dumper, bool syslog,
2686                         char *line, size_t size, size_t *len)
2687 {
2688         unsigned long flags;
2689         bool ret;
2690
2691         raw_spin_lock_irqsave(&logbuf_lock, flags);
2692         ret = kmsg_dump_get_line_nolock(dumper, syslog, line, size, len);
2693         raw_spin_unlock_irqrestore(&logbuf_lock, flags);
2694
2695         return ret;
2696 }
2697 EXPORT_SYMBOL_GPL(kmsg_dump_get_line);
2698
2699 /**
2700  * kmsg_dump_get_buffer - copy kmsg log lines
2701  * @dumper: registered kmsg dumper
2702  * @syslog: include the "<4>" prefixes
2703  * @buf: buffer to copy the line to
2704  * @size: maximum size of the buffer
2705  * @len: length of line placed into buffer
2706  *
2707  * Start at the end of the kmsg buffer and fill the provided buffer
2708  * with as many of the the *youngest* kmsg records that fit into it.
2709  * If the buffer is large enough, all available kmsg records will be
2710  * copied with a single call.
2711  *
2712  * Consecutive calls will fill the buffer with the next block of
2713  * available older records, not including the earlier retrieved ones.
2714  *
2715  * A return value of FALSE indicates that there are no more records to
2716  * read.
2717  */
2718 bool kmsg_dump_get_buffer(struct kmsg_dumper *dumper, bool syslog,
2719                           char *buf, size_t size, size_t *len)
2720 {
2721         unsigned long flags;
2722         u64 seq;
2723         u32 idx;
2724         u64 next_seq;
2725         u32 next_idx;
2726         enum log_flags prev;
2727         size_t l = 0;
2728         bool ret = false;
2729
2730         if (!dumper->active)
2731                 goto out;
2732
2733         raw_spin_lock_irqsave(&logbuf_lock, flags);
2734         if (dumper->cur_seq < log_first_seq) {
2735                 /* messages are gone, move to first available one */
2736                 dumper->cur_seq = log_first_seq;
2737                 dumper->cur_idx = log_first_idx;
2738         }
2739
2740         /* last entry */
2741         if (dumper->cur_seq >= dumper->next_seq) {
2742                 raw_spin_unlock_irqrestore(&logbuf_lock, flags);
2743                 goto out;
2744         }
2745
2746         /* calculate length of entire buffer */
2747         seq = dumper->cur_seq;
2748         idx = dumper->cur_idx;
2749         prev = 0;
2750         while (seq < dumper->next_seq) {
2751                 struct log *msg = log_from_idx(idx);
2752
2753                 l += msg_print_text(msg, prev, true, NULL, 0);
2754                 idx = log_next(idx);
2755                 seq++;
2756                 prev = msg->flags;
2757         }
2758
2759         /* move first record forward until length fits into the buffer */
2760         seq = dumper->cur_seq;
2761         idx = dumper->cur_idx;
2762         prev = 0;
2763         while (l > size && seq < dumper->next_seq) {
2764                 struct log *msg = log_from_idx(idx);
2765
2766                 l -= msg_print_text(msg, prev, true, NULL, 0);
2767                 idx = log_next(idx);
2768                 seq++;
2769                 prev = msg->flags;
2770         }
2771
2772         /* last message in next interation */
2773         next_seq = seq;
2774         next_idx = idx;
2775
2776         l = 0;
2777         prev = 0;
2778         while (seq < dumper->next_seq) {
2779                 struct log *msg = log_from_idx(idx);
2780
2781                 l += msg_print_text(msg, prev, syslog, buf + l, size - l);
2782                 idx = log_next(idx);
2783                 seq++;
2784                 prev = msg->flags;
2785         }
2786
2787         dumper->next_seq = next_seq;
2788         dumper->next_idx = next_idx;
2789         ret = true;
2790         raw_spin_unlock_irqrestore(&logbuf_lock, flags);
2791 out:
2792         if (len)
2793                 *len = l;
2794         return ret;
2795 }
2796 EXPORT_SYMBOL_GPL(kmsg_dump_get_buffer);
2797
2798 /**
2799  * kmsg_dump_rewind_nolock - reset the interator (unlocked version)
2800  * @dumper: registered kmsg dumper
2801  *
2802  * Reset the dumper's iterator so that kmsg_dump_get_line() and
2803  * kmsg_dump_get_buffer() can be called again and used multiple
2804  * times within the same dumper.dump() callback.
2805  *
2806  * The function is similar to kmsg_dump_rewind(), but grabs no locks.
2807  */
2808 void kmsg_dump_rewind_nolock(struct kmsg_dumper *dumper)
2809 {
2810         dumper->cur_seq = clear_seq;
2811         dumper->cur_idx = clear_idx;
2812         dumper->next_seq = log_next_seq;
2813         dumper->next_idx = log_next_idx;
2814 }
2815
2816 /**
2817  * kmsg_dump_rewind - reset the interator
2818  * @dumper: registered kmsg dumper
2819  *
2820  * Reset the dumper's iterator so that kmsg_dump_get_line() and
2821  * kmsg_dump_get_buffer() can be called again and used multiple
2822  * times within the same dumper.dump() callback.
2823  */
2824 void kmsg_dump_rewind(struct kmsg_dumper *dumper)
2825 {
2826         unsigned long flags;
2827
2828         raw_spin_lock_irqsave(&logbuf_lock, flags);
2829         kmsg_dump_rewind_nolock(dumper);
2830         raw_spin_unlock_irqrestore(&logbuf_lock, flags);
2831 }
2832 EXPORT_SYMBOL_GPL(kmsg_dump_rewind);
2833 #endif