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