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