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  *     manfreds@colorfullife.com
  15  * Rewrote bits to get rid of console_lock
  16  *      01Mar01 Andrew Morton <andrewm@uow.edu.au>
  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/smp_lock.h>
  24 #include <linux/console.h>
  25 #include <linux/init.h>
  26 #include <linux/module.h>
  27 #include <linux/interrupt.h>                    /* For in_interrupt() */
  28 #include <linux/config.h>
  29 #include <linux/delay.h>
  30 #include <linux/smp.h>
  31 #include <linux/security.h>
  32 #include <linux/bootmem.h>
  33
  34 #include <asm/uaccess.h>
  35
  36 #define __LOG_BUF_LEN   (1 << CONFIG_LOG_BUF_SHIFT)
  37
  38 /* printk's without a loglevel use this.. */
  39 #define DEFAULT_MESSAGE_LOGLEVEL 4 /* KERN_WARNING */
  40
  41 /* We show everything that is MORE important than this.. */
  42 #define MINIMUM_CONSOLE_LOGLEVEL 1 /* Minimum loglevel we let people use */
  43 #define DEFAULT_CONSOLE_LOGLEVEL 7 /* anything MORE serious than KERN_DEBUG */
  44
  45 DECLARE_WAIT_QUEUE_HEAD(log_wait);
  46
  47 int console_printk[4] = {
  48         DEFAULT_CONSOLE_LOGLEVEL,       /* console_loglevel */
  49         DEFAULT_MESSAGE_LOGLEVEL,       /* default_message_loglevel */
  50         MINIMUM_CONSOLE_LOGLEVEL,       /* minimum_console_loglevel */
  51         DEFAULT_CONSOLE_LOGLEVEL,       /* default_console_loglevel */
  52 };
  53
  54 EXPORT_SYMBOL(console_printk);
  55
  56 int oops_in_progress;
  57
  58 /*
  59  * console_sem protects the console_drivers list, and also
  60  * provides serialisation for access to the entire console
  61  * driver system.
  62  */
  63 static DECLARE_MUTEX(console_sem);
  64 struct console *console_drivers;
  65 /*
  66  * This is used for debugging the mess that is the VT code by
  67  * keeping track if we have the console semaphore held. It's
  68  * definitely not the perfect debug tool (we don't know if _WE_
  69  * hold it are racing, but it helps tracking those weird code
  70  * path in the console code where we end up in places I want
  71  * locked without the console sempahore held
  72  */
  73 static int console_locked;
  74
  75 /*
  76  * logbuf_lock protects log_buf, log_start, log_end, con_start and logged_chars
  77  * It is also used in interesting ways to provide interlocking in
  78  * release_console_sem().
  79  */
  80 static spinlock_t logbuf_lock = SPIN_LOCK_UNLOCKED;
  81
  82 static char __log_buf[__LOG_BUF_LEN];
  83 static char *log_buf = __log_buf;
  84 static int log_buf_len = __LOG_BUF_LEN;
  85
  86 #define LOG_BUF_MASK    (log_buf_len-1)
  87 #define LOG_BUF(idx) (log_buf[(idx) & LOG_BUF_MASK])
  88
  89 /*
  90  * The indices into log_buf are not constrained to log_buf_len - they
  91  * must be masked before subscripting
  92  */
  93 static unsigned long log_start; /* Index into log_buf: next char to be read by syslog() */
  94 static unsigned long con_start; /* Index into log_buf: next char to be sent to consoles */
  95 static unsigned long log_end;   /* Index into log_buf: most-recently-written-char + 1 */
  96 static unsigned long logged_chars; /* Number of chars produced since last read+clear operation */
  97
  98 /*
  99  *      Array of consoles built from command line options (console=)
 100  */
 101 struct console_cmdline
 102 {
 103         char    name[8];                        /* Name of the driver       */
 104         int     index;                          /* Minor dev. to use        */
 105         char    *options;                       /* Options for the driver   */
 106 };
 107
 108 #define MAX_CMDLINECONSOLES 8
 109
 110 static struct console_cmdline console_cmdline[MAX_CMDLINECONSOLES];
 111 static int preferred_console = -1;
 112
 113 /* Flag: console code may call schedule() */
 114 static int console_may_schedule;
 115
 116 /*
 117  *      Setup a list of consoles. Called from init/main.c
 118  */
 119 static int __init console_setup(char *str)
 120 {
 121         char name[sizeof(console_cmdline[0].name)];
 122         char *s, *options;
 123         int idx;
 124
 125         /*
 126          *      Decode str into name, index, options.
 127          */
 128         if (str[0] >= '0' && str[0] <= '9') {
 129                 strcpy(name, "ttyS");
 130                 strncpy(name + 4, str, sizeof(name) - 5);
 131         } else
 132                 strncpy(name, str, sizeof(name) - 1);
 133         name[sizeof(name) - 1] = 0;
 134         if ((options = strchr(str, ',')) != NULL)
 135                 *(options++) = 0;
 136 #ifdef __sparc__
 137         if (!strcmp(str, "ttya"))
 138                 strcpy(name, "ttyS0");
 139         if (!strcmp(str, "ttyb"))
 140                 strcpy(name, "ttyS1");
 141 #endif
 142         for(s = name; *s; s++)
 143                 if (*s >= '0' && *s <= '9')
 144                         break;
 145         idx = simple_strtoul(s, NULL, 10);
 146         *s = 0;
 147
 148         add_preferred_console(name, idx, options);
 149         return 1;
 150 }
 151
 152 __setup("console=", console_setup);
 153
 154 /**
 155  * add_preferred_console - add a device to the list of preferred consoles.
 156  *
 157  * The last preferred console added will be used for kernel messages
 158  * and stdin/out/err for init.  Normally this is used by console_setup
 159  * above to handle user-supplied console arguments; however it can also
 160  * be used by arch-specific code either to override the user or more
 161  * commonly to provide a default console (ie from PROM variables) when
 162  * the user has not supplied one.
 163  */
 164 int __init add_preferred_console(char *name, int idx, char *options)
 165 {
 166         struct console_cmdline *c;
 167         int i;
 168
 169         /*
 170          *      See if this tty is not yet registered, and
 171          *      if we have a slot free.
 172          */
 173         for(i = 0; i < MAX_CMDLINECONSOLES && console_cmdline[i].name[0]; i++)
 174                 if (strcmp(console_cmdline[i].name, name) == 0 &&
 175                           console_cmdline[i].index == idx) {
 176                                 preferred_console = i;
 177                                 return 0;
 178                 }
 179         if (i == MAX_CMDLINECONSOLES)
 180                 return -E2BIG;
 181         preferred_console = i;
 182         c = &console_cmdline[i];
 183         memcpy(c->name, name, sizeof(c->name));
 184         c->name[sizeof(c->name) - 1] = 0;
 185         c->options = options;
 186         c->index = idx;
 187         return 0;
 188 }
 189
 190 static int __init log_buf_len_setup(char *str)
 191 {
 192         unsigned long size = memparse(str, &str);
 193         unsigned long flags;
 194
 195         if (size > log_buf_len) {
 196                 unsigned long start, dest_idx, offset;
 197                 char * new_log_buf;
 198
 199                 new_log_buf = alloc_bootmem(size);
 200                 if (!new_log_buf) {
 201                         printk("log_buf_len: allocation failed\n");
 202                         goto out;
 203                 }
 204
 205                 spin_lock_irqsave(&logbuf_lock, flags);
 206                 log_buf_len = size;
 207                 log_buf = new_log_buf;
 208
 209                 offset = start = min(con_start, log_start);
 210                 dest_idx = 0;
 211                 while (start != log_end) {
 212                         log_buf[dest_idx] = __log_buf[start & (__LOG_BUF_LEN - 1)];
 213                         start++;
 214                         dest_idx++;
 215                 }
 216                 log_start -= offset;
 217                 con_start -= offset;
 218                 log_end -= offset;
 219                 spin_unlock_irqrestore(&logbuf_lock, flags);
 220
 221                 printk("log_buf_len: %d\n", log_buf_len);
 222         }
 223 out:
 224
 225         return 1;
 226 }
 227
 228 __setup("log_buf_len=", log_buf_len_setup);
 229
 230 /*
 231  * Commands to do_syslog:
 232  *
 233  *      0 -- Close the log.  Currently a NOP.
 234  *      1 -- Open the log. Currently a NOP.
 235  *      2 -- Read from the log.
 236  *      3 -- Read all messages remaining in the ring buffer.
 237  *      4 -- Read and clear all messages remaining in the ring buffer
 238  *      5 -- Clear ring buffer.
 239  *      6 -- Disable printk's to console
 240  *      7 -- Enable printk's to console
 241  *      8 -- Set level of messages printed to console
 242  *      9 -- Return number of unread characters in the log buffer
 243  *     10 -- Return size of the log buffer
 244  */
 245 int do_syslog(int type, char __user * buf, int len)
 246 {
 247         unsigned long i, j, limit, count;
 248         int do_clear = 0;
 249         char c;
 250         int error = 0;
 251
 252         error = security_syslog(type);
 253         if (error)
 254                 return error;
 255
 256         switch (type) {
 257         case 0:         /* Close log */
 258                 break;
 259         case 1:         /* Open log */
 260                 break;
 261         case 2:         /* Read from log */
 262                 error = -EINVAL;
 263                 if (!buf || len < 0)
 264                         goto out;
 265                 error = 0;
 266                 if (!len)
 267                         goto out;
 268                 error = verify_area(VERIFY_WRITE,buf,len);
 269                 if (error)
 270                         goto out;
 271                 error = wait_event_interruptible(log_wait, (log_start - log_end));
 272                 if (error)
 273                         goto out;
 274                 i = 0;
 275                 spin_lock_irq(&logbuf_lock);
 276                 while (!error && (log_start != log_end) && i < len) {
 277                         c = LOG_BUF(log_start);
 278                         log_start++;
 279                         spin_unlock_irq(&logbuf_lock);
 280                         error = __put_user(c,buf);
 281                         buf++;
 282                         i++;
 283                         cond_resched();
 284                         spin_lock_irq(&logbuf_lock);
 285                 }
 286                 spin_unlock_irq(&logbuf_lock);
 287                 if (!error)
 288                         error = i;
 289                 break;
 290         case 4:         /* Read/clear last kernel messages */
 291                 do_clear = 1;
 292                 /* FALL THRU */
 293         case 3:         /* Read last kernel messages */
 294                 error = -EINVAL;
 295                 if (!buf || len < 0)
 296                         goto out;
 297                 error = 0;
 298                 if (!len)
 299                         goto out;
 300                 error = verify_area(VERIFY_WRITE,buf,len);
 301                 if (error)
 302                         goto out;
 303                 count = len;
 304                 if (count > log_buf_len)
 305                         count = log_buf_len;
 306                 spin_lock_irq(&logbuf_lock);
 307                 if (count > logged_chars)
 308                         count = logged_chars;
 309                 if (do_clear)
 310                         logged_chars = 0;
 311                 limit = log_end;
 312                 /*
 313                  * __put_user() could sleep, and while we sleep
 314                  * printk() could overwrite the messages
 315                  * we try to copy to user space. Therefore
 316                  * the messages are copied in reverse. <manfreds>
 317                  */
 318                 for(i = 0; i < count && !error; i++) {
 319                         j = limit-1-i;
 320                         if (j + log_buf_len < log_end)
 321                                 break;
 322                         c = LOG_BUF(j);
 323                         spin_unlock_irq(&logbuf_lock);
 324                         error = __put_user(c,&buf[count-1-i]);
 325                         cond_resched();
 326                         spin_lock_irq(&logbuf_lock);
 327                 }
 328                 spin_unlock_irq(&logbuf_lock);
 329                 if (error)
 330                         break;
 331                 error = i;
 332                 if(i != count) {
 333                         int offset = count-error;
 334                         /* buffer overflow during copy, correct user buffer. */
 335                         for(i=0;i<error;i++) {
 336                                 if (__get_user(c,&buf[i+offset]) ||
 337                                     __put_user(c,&buf[i])) {
 338                                         error = -EFAULT;
 339                                         break;
 340                                 }
 341                                 cond_resched();
 342                         }
 343                 }
 344                 break;
 345         case 5:         /* Clear ring buffer */
 346                 logged_chars = 0;
 347                 break;
 348         case 6:         /* Disable logging to console */
 349                 console_loglevel = minimum_console_loglevel;
 350                 break;
 351         case 7:         /* Enable logging to console */
 352                 console_loglevel = default_console_loglevel;
 353                 break;
 354         case 8:         /* Set level of messages printed to console */
 355                 error = -EINVAL;
 356                 if (len < 1 || len > 8)
 357                         goto out;
 358                 if (len < minimum_console_loglevel)
 359                         len = minimum_console_loglevel;
 360                 console_loglevel = len;
 361                 error = 0;
 362                 break;
 363         case 9:         /* Number of chars in the log buffer */
 364                 error = log_end - log_start;
 365                 break;
 366         case 10:        /* Size of the log buffer */
 367                 error = log_buf_len;
 368                 break;
 369         default:
 370                 error = -EINVAL;
 371                 break;
 372         }
 373 out:
 374         return error;
 375 }
 376
 377 asmlinkage long sys_syslog(int type, char __user * buf, int len)
 378 {
 379         return do_syslog(type, buf, len);
 380 }
 381
 382 /*
 383  * Netdump special routine. Don't print to global log_buf, just to the
 384  * actual console device(s).
 385  */
 386 static void netdump_call_console_drivers(const char *buf, unsigned long len)
 387 {
 388         struct console *con;
 389
 390         for (con = console_drivers; con; con = con->next) {
 391                 if ((con->flags & CON_ENABLED) && con->write)
 392                         con->write(con, buf, len);
 393         }
 394 }
 395
 396 /*
 397  * Call the console drivers on a range of log_buf
 398  */
 399 static void __call_console_drivers(unsigned long start, unsigned long end)
 400 {
 401         struct console *con;
 402
 403         for (con = console_drivers; con; con = con->next) {
 404                 if ((con->flags & CON_ENABLED) && con->write)
 405                         con->write(con, &LOG_BUF(start), end - start);
 406         }
 407 }
 408
 409 /*
 410  * Write out chars from start to end - 1 inclusive
 411  */
 412 static void _call_console_drivers(unsigned long start,
 413                                 unsigned long end, int msg_log_level)
 414 {
 415         if (msg_log_level < console_loglevel &&
 416                         console_drivers && start != end) {
 417                 if ((start & LOG_BUF_MASK) > (end & LOG_BUF_MASK)) {
 418                         /* wrapped write */
 419                         __call_console_drivers(start & LOG_BUF_MASK,
 420                                                 log_buf_len);
 421                         __call_console_drivers(0, end & LOG_BUF_MASK);
 422                 } else {
 423                         __call_console_drivers(start, end);
 424                 }
 425         }
 426 }
 427
 428 /*
 429  * Call the console drivers, asking them to write out
 430  * log_buf[start] to log_buf[end - 1].
 431  * The console_sem must be held.
 432  */
 433 static void call_console_drivers(unsigned long start, unsigned long end)
 434 {
 435         unsigned long cur_index, start_print;
 436         static int msg_level = -1;
 437
 438         if (((long)(start - end)) > 0)
 439                 BUG();
 440
 441         cur_index = start;
 442         start_print = start;
 443         while (cur_index != end) {
 444                 if (    msg_level < 0 &&
 445                         ((end - cur_index) > 2) &&
 446                         LOG_BUF(cur_index + 0) == '<' &&
 447                         LOG_BUF(cur_index + 1) >= '0' &&
 448                         LOG_BUF(cur_index + 1) <= '7' &&
 449                         LOG_BUF(cur_index + 2) == '>')
 450                 {
 451                         msg_level = LOG_BUF(cur_index + 1) - '0';
 452                         cur_index += 3;
 453                         start_print = cur_index;
 454                 }
 455                 while (cur_index != end) {
 456                         char c = LOG_BUF(cur_index);
 457                         cur_index++;
 458
 459                         if (c == '\n') {
 460                                 if (msg_level < 0) {
 461                                         /*
 462                                          * printk() has already given us loglevel tags in
 463                                          * the buffer.  This code is here in case the
 464                                          * log buffer has wrapped right round and scribbled
 465                                          * on those tags
 466                                          */
 467                                         msg_level = default_message_loglevel;
 468                                 }
 469                                 _call_console_drivers(start_print, cur_index, msg_level);
 470                                 msg_level = -1;
 471                                 start_print = cur_index;
 472                                 break;
 473                         }
 474                 }
 475         }
 476         _call_console_drivers(start_print, end, msg_level);
 477 }
 478
 479 static void emit_log_char(char c)
 480 {
 481         LOG_BUF(log_end) = c;
 482         log_end++;
 483         if (log_end - log_start > log_buf_len)
 484                 log_start = log_end - log_buf_len;
 485         if (log_end - con_start > log_buf_len)
 486                 con_start = log_end - log_buf_len;
 487         if (logged_chars < log_buf_len)
 488                 logged_chars++;
 489 }
 490
 491 /*
 492  * Zap console related locks when oopsing. Only zap at most once
 493  * every 10 seconds, to leave time for slow consoles to print a
 494  * full oops.
 495  */
 496 static void zap_locks(void)
 497 {
 498         static unsigned long oops_timestamp;
 499
 500         if (time_after_eq(jiffies, oops_timestamp) &&
 501                         !time_after(jiffies, oops_timestamp + 30*HZ))
 502                 return;
 503
 504         oops_timestamp = jiffies;
 505
 506         /* If a crash is occurring, make sure we can't deadlock */
 507         spin_lock_init(&logbuf_lock);
 508         /* And make sure that we print immediately */
 509         init_MUTEX(&console_sem);
 510 }
 511
 512 /*
 513  * This is printk.  It can be called from any context.  We want it to work.
 514  *
 515  * We try to grab the console_sem.  If we succeed, it's easy - we log the output and
 516  * call the console drivers.  If we fail to get the semaphore we place the output
 517  * into the log buffer and return.  The current holder of the console_sem will
 518  * notice the new output in release_console_sem() and will send it to the
 519  * consoles before releasing the semaphore.
 520  *
 521  * One effect of this deferred printing is that code which calls printk() and
 522  * then changes console_loglevel may break. This is because console_loglevel
 523  * is inspected when the actual printing occurs.
 524  */
 525 asmlinkage int printk(const char *fmt, ...)
 526 {
 527         va_list args;
 528         unsigned long flags;
 529         int printed_len;
 530         char *p;
 531         static char printk_buf[1024];
 532         static int log_level_unknown = 1;
 533
 534         if (unlikely(oops_in_progress))
 535                 zap_locks();
 536
 537         /* This stops the holder of console_sem just where we want him */
 538         spin_lock_irqsave(&logbuf_lock, flags);
 539
 540         /* Emit the output into the temporary buffer */
 541         va_start(args, fmt);
 542         printed_len = vscnprintf(printk_buf, sizeof(printk_buf), fmt, args);
 543         va_end(args);
 544
 545         if (unlikely(netdump_mode)) {
 546                 netdump_call_console_drivers(printk_buf, printed_len);
 547                 spin_unlock_irqrestore(&logbuf_lock, flags);
 548                 goto out;
 549         }
 550
 551         /*
 552          * Copy the output into log_buf.  If the caller didn't provide
 553          * appropriate log level tags, we insert them here
 554          */
 555         for (p = printk_buf; *p; p++) {
 556                 if (log_level_unknown) {
 557                         if (p[0] != '<' || p[1] < '0' || p[1] > '7' || p[2] != '>') {
 558                                 emit_log_char('<');
 559                                 emit_log_char(default_message_loglevel + '0');
 560                                 emit_log_char('>');
 561                         }
 562                         log_level_unknown = 0;
 563                 }
 564                 emit_log_char(*p);
 565                 if (*p == '\n')
 566                         log_level_unknown = 1;
 567         }
 568
 569         if (!cpu_online(smp_processor_id()) &&
 570             system_state != SYSTEM_RUNNING) {
 571                 /*
 572                  * Some console drivers may assume that per-cpu resources have
 573                  * been allocated.  So don't allow them to be called by this
 574                  * CPU until it is officially up.  We shouldn't be calling into
 575                  * random console drivers on a CPU which doesn't exist yet..
 576                  */
 577                 spin_unlock_irqrestore(&logbuf_lock, flags);
 578                 goto out;
 579         }
 580         if (!down_trylock(&console_sem)) {
 581                 console_locked = 1;
 582                 /*
 583                  * We own the drivers.  We can drop the spinlock and let
 584                  * release_console_sem() print the text
 585                  */
 586                 spin_unlock_irqrestore(&logbuf_lock, flags);
 587                 console_may_schedule = 0;
 588                 release_console_sem();
 589         } else {
 590                 /*
 591                  * Someone else owns the drivers.  We drop the spinlock, which
 592                  * allows the semaphore holder to proceed and to call the
 593                  * console drivers with the output which we just produced.
 594                  */
 595                 spin_unlock_irqrestore(&logbuf_lock, flags);
 596         }
 597 out:
 598         return printed_len;
 599 }
 600 EXPORT_SYMBOL(printk);
 601
 602 /**
 603  * acquire_console_sem - lock the console system for exclusive use.
 604  *
 605  * Acquires a semaphore which guarantees that the caller has
 606  * exclusive access to the console system and the console_drivers list.
 607  *
 608  * Can sleep, returns nothing.
 609  */
 610 void acquire_console_sem(void)
 611 {
 612         if (in_interrupt())
 613                 BUG();
 614         down(&console_sem);
 615         console_locked = 1;
 616         console_may_schedule = 1;
 617 }
 618 EXPORT_SYMBOL(acquire_console_sem);
 619
 620 int is_console_locked(void)
 621 {
 622         return console_locked;
 623 }
 624 EXPORT_SYMBOL(is_console_locked);
 625
 626 /**
 627  * release_console_sem - unlock the console system
 628  *
 629  * Releases the semaphore which the caller holds on the console system
 630  * and the console driver list.
 631  *
 632  * While the semaphore was held, console output may have been buffered
 633  * by printk().  If this is the case, release_console_sem() emits
 634  * the output prior to releasing the semaphore.
 635  *
 636  * If there is output waiting for klogd, we wake it up.
 637  *
 638  * release_console_sem() may be called from any context.
 639  */
 640 void release_console_sem(void)
 641 {
 642         unsigned long flags;
 643         unsigned long _con_start, _log_end;
 644         unsigned long wake_klogd = 0;
 645
 646         for ( ; ; ) {
 647                 spin_lock_irqsave(&logbuf_lock, flags);
 648                 wake_klogd |= log_start - log_end;
 649                 if (con_start == log_end)
 650                         break;                  /* Nothing to print */
 651                 _con_start = con_start;
 652                 _log_end = log_end;
 653                 con_start = log_end;            /* Flush */
 654                 spin_unlock_irqrestore(&logbuf_lock, flags);
 655                 call_console_drivers(_con_start, _log_end);
 656         }
 657         console_locked = 0;
 658         console_may_schedule = 0;
 659         up(&console_sem);
 660         spin_unlock_irqrestore(&logbuf_lock, flags);
 661         if (wake_klogd && !oops_in_progress && waitqueue_active(&log_wait))
 662                 wake_up_interruptible(&log_wait);
 663 }
 664 EXPORT_SYMBOL(release_console_sem);
 665
 666 /** console_conditional_schedule - yield the CPU if required
 667  *
 668  * If the console code is currently allowed to sleep, and
 669  * if this CPU should yield the CPU to another task, do
 670  * so here.
 671  *
 672  * Must be called within acquire_console_sem().
 673  */
 674 void console_conditional_schedule(void)
 675 {
 676         if (console_may_schedule && need_resched()) {
 677                 set_current_state(TASK_RUNNING);
 678                 schedule();
 679         }
 680 }
 681 EXPORT_SYMBOL(console_conditional_schedule);
 682
 683 void console_print(const char *s)
 684 {
 685         printk(KERN_EMERG "%s", s);
 686 }
 687 EXPORT_SYMBOL(console_print);
 688
 689 void console_unblank(void)
 690 {
 691         struct console *c;
 692
 693         /*
 694          * Try to get the console semaphore. If someone else owns it
 695          * we have to return without unblanking because console_unblank
 696          * may be called in interrupt context.
 697          */
 698         if (down_trylock(&console_sem) != 0)
 699                 return;
 700         console_locked = 1;
 701         console_may_schedule = 0;
 702         for (c = console_drivers; c != NULL; c = c->next)
 703                 if ((c->flags & CON_ENABLED) && c->unblank)
 704                         c->unblank();
 705         release_console_sem();
 706 }
 707 EXPORT_SYMBOL(console_unblank);
 708
 709 /*
 710  * Return the console tty driver structure and its associated index
 711  */
 712 struct tty_driver *console_device(int *index)
 713 {
 714         struct console *c;
 715         struct tty_driver *driver = NULL;
 716
 717         acquire_console_sem();
 718         for (c = console_drivers; c != NULL; c = c->next) {
 719                 if (!c->device)
 720                         continue;
 721                 driver = c->device(c, index);
 722                 if (driver)
 723                         break;
 724         }
 725         release_console_sem();
 726         return driver;
 727 }
 728
 729 /*
 730  * Prevent further output on the passed console device so that (for example)
 731  * serial drivers can disable console output before suspending a port, and can
 732  * re-enable output afterwards.
 733  */
 734 void console_stop(struct console *console)
 735 {
 736         acquire_console_sem();
 737         console->flags &= ~CON_ENABLED;
 738         release_console_sem();
 739 }
 740 EXPORT_SYMBOL(console_stop);
 741
 742 void console_start(struct console *console)
 743 {
 744         acquire_console_sem();
 745         console->flags |= CON_ENABLED;
 746         release_console_sem();
 747 }
 748 EXPORT_SYMBOL(console_start);
 749
 750 /*
 751  * The console driver calls this routine during kernel initialization
 752  * to register the console printing procedure with printk() and to
 753  * print any messages that were printed by the kernel before the
 754  * console driver was initialized.
 755  */
 756 void register_console(struct console * console)
 757 {
 758         int     i;
 759         unsigned long flags;
 760
 761         /*
 762          *      See if we want to use this console driver. If we
 763          *      didn't select a console we take the first one
 764          *      that registers here.
 765          */
 766         if (preferred_console < 0) {
 767                 if (console->index < 0)
 768                         console->index = 0;
 769                 if (console->setup == NULL ||
 770                     console->setup(console, NULL) == 0) {
 771                         console->flags |= CON_ENABLED | CON_CONSDEV;
 772                         preferred_console = 0;
 773                 }
 774         }
 775
 776         /*
 777          *      See if this console matches one we selected on
 778          *      the command line.
 779          */
 780         for(i = 0; i < MAX_CMDLINECONSOLES && console_cmdline[i].name[0]; i++) {
 781                 if (strcmp(console_cmdline[i].name, console->name) != 0)
 782                         continue;
 783                 if (console->index >= 0 &&
 784                     console->index != console_cmdline[i].index)
 785                         continue;
 786                 if (console->index < 0)
 787                         console->index = console_cmdline[i].index;
 788                 if (console->setup &&
 789                     console->setup(console, console_cmdline[i].options) != 0)
 790                         break;
 791                 console->flags |= CON_ENABLED;
 792                 console->index = console_cmdline[i].index;
 793                 if (i == preferred_console)
 794                         console->flags |= CON_CONSDEV;
 795                 break;
 796         }
 797
 798         if (!(console->flags & CON_ENABLED))
 799                 return;
 800
 801         /*
 802          *      Put this console in the list - keep the
 803          *      preferred driver at the head of the list.
 804          */
 805         acquire_console_sem();
 806         if ((console->flags & CON_CONSDEV) || console_drivers == NULL) {
 807                 console->next = console_drivers;
 808                 console_drivers = console;
 809         } else {
 810                 console->next = console_drivers->next;
 811                 console_drivers->next = console;
 812         }
 813         if (console->flags & CON_PRINTBUFFER) {
 814                 /*
 815                  * release_console_sem() will print out the buffered messages
 816                  * for us.
 817                  */
 818                 spin_lock_irqsave(&logbuf_lock, flags);
 819                 con_start = log_start;
 820                 spin_unlock_irqrestore(&logbuf_lock, flags);
 821         }
 822         release_console_sem();
 823 }
 824 EXPORT_SYMBOL(register_console);
 825
 826 int unregister_console(struct console * console)
 827 {
 828         struct console *a,*b;
 829         int res = 1;
 830
 831         acquire_console_sem();
 832         if (console_drivers == console) {
 833                 console_drivers=console->next;
 834                 res = 0;
 835         } else {
 836                 for (a=console_drivers->next, b=console_drivers ;
 837                      a; b=a, a=b->next) {
 838                         if (a == console) {
 839                                 b->next = a->next;
 840                                 res = 0;
 841                                 break;
 842                         }
 843                 }
 844         }
 845
 846         /* If last console is removed, we re-enable picking the first
 847          * one that gets registered. Without that, pmac early boot console
 848          * would prevent fbcon from taking over.
 849          */
 850         if (console_drivers == NULL)
 851                 preferred_console = -1;
 852
 853
 854         release_console_sem();
 855         return res;
 856 }
 857 EXPORT_SYMBOL(unregister_console);
 858
 859 /**
 860  * tty_write_message - write a message to a certain tty, not just the console.
 861  *
 862  * This is used for messages that need to be redirected to a specific tty.
 863  * We don't put it into the syslog queue right now maybe in the future if
 864  * really needed.
 865  */
 866 void tty_write_message(struct tty_struct *tty, char *msg)
 867 {
 868         if (tty && tty->driver->write)
 869                 tty->driver->write(tty, 0, msg, strlen(msg));
 870         return;
 871 }
 872
 873 /*
 874  * printk rate limiting, lifted from the networking subsystem.
 875  *
 876  * This enforces a rate limit: not more than one kernel message
 877  * every printk_ratelimit_jiffies to make a denial-of-service
 878  * attack impossible.
 879  */
 880 int __printk_ratelimit(int ratelimit_jiffies, int ratelimit_burst)
 881 {
 882         static spinlock_t ratelimit_lock = SPIN_LOCK_UNLOCKED;
 883         static unsigned long toks = 10*5*HZ;
 884         static unsigned long last_msg;
 885         static int missed;
 886         unsigned long flags;
 887         unsigned long now = jiffies;
 888
 889         spin_lock_irqsave(&ratelimit_lock, flags);
 890         toks += now - last_msg;
 891         last_msg = now;
 892         if (toks > (ratelimit_burst * ratelimit_jiffies))
 893                 toks = ratelimit_burst * ratelimit_jiffies;
 894         if (toks >= ratelimit_jiffies) {
 895                 int lost = missed;
 896                 missed = 0;
 897                 toks -= ratelimit_jiffies;
 898                 spin_unlock_irqrestore(&ratelimit_lock, flags);
 899                 if (lost)
 900                         printk(KERN_WARNING "printk: %d messages suppressed.\n", lost);
 901                 return 1;
 902         }
 903         missed++;
 904         spin_unlock_irqrestore(&ratelimit_lock, flags);
 905         return 0;
 906 }
 907 EXPORT_SYMBOL(__printk_ratelimit);
 908
 909 /* minimum time in jiffies between messages */
 910 int printk_ratelimit_jiffies = 5*HZ;
 911
 912 /* number of messages we send before ratelimiting */
 913 int printk_ratelimit_burst = 10;
 914
 915 int printk_ratelimit(void)
 916 {
 917         return __printk_ratelimit(printk_ratelimit_jiffies,
 918                                 printk_ratelimit_burst);
 919 }
 920 EXPORT_SYMBOL(printk_ratelimit);