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/vs_base.h>
  34 #include <linux/syscalls.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 spinlock_t logbuf_lock = SPIN_LOCK_UNLOCKED;
  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 = -EPERM;
 256
 257         if (!vx_check(0, VX_ADMIN|VX_WATCH))
 258                 return error;
 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         default:
 375                 error = -EINVAL;
 376                 break;
 377         }
 378 out:
 379         return error;
 380 }
 381
 382 asmlinkage long sys_syslog(int type, char __user * buf, int len)
 383 {
 384         return do_syslog(type, buf, len);
 385 }
 386
 387 /*
 388  * Crashdump special routine. Don't print to global log_buf, just to the
 389  * actual console device(s).
 390  */
 391 static void crashdump_call_console_drivers(const char *buf, unsigned long len)
 392 {
 393         struct console *con;
 394
 395         for (con = console_drivers; con; con = con->next) {
 396                 if ((con->flags & CON_ENABLED) && con->write)
 397                         con->write(con, buf, len);
 398         }
 399 }
 400
 401 /*
 402  * Call the console drivers on a range of log_buf
 403  */
 404 static void __call_console_drivers(unsigned long start, unsigned long end)
 405 {
 406         struct console *con;
 407
 408         for (con = console_drivers; con; con = con->next) {
 409                 if ((con->flags & CON_ENABLED) && con->write)
 410                         con->write(con, &LOG_BUF(start), end - start);
 411         }
 412 }
 413
 414 /*
 415  * Write out chars from start to end - 1 inclusive
 416  */
 417 static void _call_console_drivers(unsigned long start,
 418                                 unsigned long end, int msg_log_level)
 419 {
 420         if (msg_log_level < console_loglevel &&
 421                         console_drivers && start != end) {
 422                 if ((start & LOG_BUF_MASK) > (end & LOG_BUF_MASK)) {
 423                         /* wrapped write */
 424                         __call_console_drivers(start & LOG_BUF_MASK,
 425                                                 log_buf_len);
 426                         __call_console_drivers(0, end & LOG_BUF_MASK);
 427                 } else {
 428                         __call_console_drivers(start, end);
 429                 }
 430         }
 431 }
 432
 433 /*
 434  * Call the console drivers, asking them to write out
 435  * log_buf[start] to log_buf[end - 1].
 436  * The console_sem must be held.
 437  */
 438 static void call_console_drivers(unsigned long start, unsigned long end)
 439 {
 440         unsigned long cur_index, start_print;
 441         static int msg_level = -1;
 442
 443         if (((long)(start - end)) > 0)
 444                 BUG();
 445
 446         cur_index = start;
 447         start_print = start;
 448         while (cur_index != end) {
 449                 if (    msg_level < 0 &&
 450                         ((end - cur_index) > 2) &&
 451                         LOG_BUF(cur_index + 0) == '<' &&
 452                         LOG_BUF(cur_index + 1) >= '0' &&
 453                         LOG_BUF(cur_index + 1) <= '7' &&
 454                         LOG_BUF(cur_index + 2) == '>')
 455                 {
 456                         msg_level = LOG_BUF(cur_index + 1) - '0';
 457                         cur_index += 3;
 458                         start_print = cur_index;
 459                 }
 460                 while (cur_index != end) {
 461                         char c = LOG_BUF(cur_index);
 462                         cur_index++;
 463
 464                         if (c == '\n') {
 465                                 if (msg_level < 0) {
 466                                         /*
 467                                          * printk() has already given us loglevel tags in
 468                                          * the buffer.  This code is here in case the
 469                                          * log buffer has wrapped right round and scribbled
 470                                          * on those tags
 471                                          */
 472                                         msg_level = default_message_loglevel;
 473                                 }
 474                                 _call_console_drivers(start_print, cur_index, msg_level);
 475                                 msg_level = -1;
 476                                 start_print = cur_index;
 477                                 break;
 478                         }
 479                 }
 480         }
 481         _call_console_drivers(start_print, end, msg_level);
 482 }
 483
 484 static void emit_log_char(char c)
 485 {
 486         LOG_BUF(log_end) = c;
 487         log_end++;
 488         if (log_end - log_start > log_buf_len)
 489                 log_start = log_end - log_buf_len;
 490         if (log_end - con_start > log_buf_len)
 491                 con_start = log_end - log_buf_len;
 492         if (logged_chars < log_buf_len)
 493                 logged_chars++;
 494 }
 495
 496 /*
 497  * Zap console related locks when oopsing. Only zap at most once
 498  * every 10 seconds, to leave time for slow consoles to print a
 499  * full oops.
 500  */
 501 static void zap_locks(void)
 502 {
 503         static unsigned long oops_timestamp;
 504
 505         if (time_after_eq(jiffies, oops_timestamp) &&
 506                         !time_after(jiffies, oops_timestamp + 30*HZ))
 507                 return;
 508
 509         oops_timestamp = jiffies;
 510
 511         /* If a crash is occurring, make sure we can't deadlock */
 512         spin_lock_init(&logbuf_lock);
 513         /* And make sure that we print immediately */
 514         init_MUTEX(&console_sem);
 515 }
 516
 517 /*
 518  * This is printk.  It can be called from any context.  We want it to work.
 519  *
 520  * We try to grab the console_sem.  If we succeed, it's easy - we log the output and
 521  * call the console drivers.  If we fail to get the semaphore we place the output
 522  * into the log buffer and return.  The current holder of the console_sem will
 523  * notice the new output in release_console_sem() and will send it to the
 524  * consoles before releasing the semaphore.
 525  *
 526  * One effect of this deferred printing is that code which calls printk() and
 527  * then changes console_loglevel may break. This is because console_loglevel
 528  * is inspected when the actual printing occurs.
 529  */
 530 asmlinkage int printk(const char *fmt, ...)
 531 {
 532         va_list args;
 533         int r;
 534
 535         va_start(args, fmt);
 536         r = vprintk(fmt, args);
 537         va_end(args);
 538
 539         return r;
 540 }
 541
 542 static volatile int printk_cpu = -1;
 543
 544 asmlinkage int vprintk(const char *fmt, va_list args)
 545 {
 546         unsigned long flags;
 547         int printed_len;
 548         char *p;
 549         static char printk_buf[1024];
 550         static int log_level_unknown = 1;
 551
 552         if (unlikely(oops_in_progress && printk_cpu == smp_processor_id()))
 553                 zap_locks();
 554
 555         /* This stops the holder of console_sem just where we want him */
 556         spin_lock_irqsave(&logbuf_lock, flags);
 557         printk_cpu = smp_processor_id();
 558
 559         /* Emit the output into the temporary buffer */
 560         printed_len = vscnprintf(printk_buf, sizeof(printk_buf), fmt, args);
 561
 562         if (unlikely(crashdump_mode())) {
 563                 crashdump_call_console_drivers(printk_buf, printed_len);
 564                 spin_unlock_irqrestore(&logbuf_lock, flags);
 565                 goto out;
 566         }
 567
 568         /*
 569          * Copy the output into log_buf.  If the caller didn't provide
 570          * appropriate log level tags, we insert them here
 571          */
 572         for (p = printk_buf; *p; p++) {
 573                 if (log_level_unknown) {
 574                         if (p[0] != '<' || p[1] < '0' || p[1] > '7' || p[2] != '>') {
 575                                 emit_log_char('<');
 576                                 emit_log_char(default_message_loglevel + '0');
 577                                 emit_log_char('>');
 578                         }
 579                         log_level_unknown = 0;
 580                 }
 581                 emit_log_char(*p);
 582                 if (*p == '\n')
 583                         log_level_unknown = 1;
 584         }
 585
 586         if (!cpu_online(smp_processor_id()) &&
 587             system_state != SYSTEM_RUNNING) {
 588                 /*
 589                  * Some console drivers may assume that per-cpu resources have
 590                  * been allocated.  So don't allow them to be called by this
 591                  * CPU until it is officially up.  We shouldn't be calling into
 592                  * random console drivers on a CPU which doesn't exist yet..
 593                  */
 594                 spin_unlock_irqrestore(&logbuf_lock, flags);
 595                 goto out;
 596         }
 597         if (!down_trylock(&console_sem)) {
 598                 console_locked = 1;
 599                 /*
 600                  * We own the drivers.  We can drop the spinlock and let
 601                  * release_console_sem() print the text
 602                  */
 603                 spin_unlock_irqrestore(&logbuf_lock, flags);
 604                 console_may_schedule = 0;
 605                 release_console_sem();
 606         } else {
 607                 /*
 608                  * Someone else owns the drivers.  We drop the spinlock, which
 609                  * allows the semaphore holder to proceed and to call the
 610                  * console drivers with the output which we just produced.
 611                  */
 612                 spin_unlock_irqrestore(&logbuf_lock, flags);
 613         }
 614 out:
 615         return printed_len;
 616 }
 617 EXPORT_SYMBOL(printk);
 618 EXPORT_SYMBOL(vprintk);
 619
 620 /**
 621  * acquire_console_sem - lock the console system for exclusive use.
 622  *
 623  * Acquires a semaphore which guarantees that the caller has
 624  * exclusive access to the console system and the console_drivers list.
 625  *
 626  * Can sleep, returns nothing.
 627  */
 628 void acquire_console_sem(void)
 629 {
 630         if (in_interrupt())
 631                 BUG();
 632         down(&console_sem);
 633         console_locked = 1;
 634         console_may_schedule = 1;
 635 }
 636 EXPORT_SYMBOL(acquire_console_sem);
 637
 638 int is_console_locked(void)
 639 {
 640         return console_locked;
 641 }
 642 EXPORT_SYMBOL(is_console_locked);
 643
 644 /**
 645  * release_console_sem - unlock the console system
 646  *
 647  * Releases the semaphore which the caller holds on the console system
 648  * and the console driver list.
 649  *
 650  * While the semaphore was held, console output may have been buffered
 651  * by printk().  If this is the case, release_console_sem() emits
 652  * the output prior to releasing the semaphore.
 653  *
 654  * If there is output waiting for klogd, we wake it up.
 655  *
 656  * release_console_sem() may be called from any context.
 657  */
 658 void release_console_sem(void)
 659 {
 660         unsigned long flags;
 661         unsigned long _con_start, _log_end;
 662         unsigned long wake_klogd = 0;
 663
 664         for ( ; ; ) {
 665                 spin_lock_irqsave(&logbuf_lock, flags);
 666                 wake_klogd |= log_start - log_end;
 667                 if (con_start == log_end)
 668                         break;                  /* Nothing to print */
 669                 _con_start = con_start;
 670                 _log_end = log_end;
 671                 con_start = log_end;            /* Flush */
 672                 spin_unlock_irqrestore(&logbuf_lock, flags);
 673                 call_console_drivers(_con_start, _log_end);
 674         }
 675         console_locked = 0;
 676         console_may_schedule = 0;
 677         up(&console_sem);
 678         spin_unlock_irqrestore(&logbuf_lock, flags);
 679         if (wake_klogd && !oops_in_progress && waitqueue_active(&log_wait))
 680                 wake_up_interruptible(&log_wait);
 681 }
 682 EXPORT_SYMBOL(release_console_sem);
 683
 684 /** console_conditional_schedule - yield the CPU if required
 685  *
 686  * If the console code is currently allowed to sleep, and
 687  * if this CPU should yield the CPU to another task, do
 688  * so here.
 689  *
 690  * Must be called within acquire_console_sem().
 691  */
 692 void __sched console_conditional_schedule(void)
 693 {
 694         if (console_may_schedule)
 695                 cond_resched();
 696 }
 697 EXPORT_SYMBOL(console_conditional_schedule);
 698
 699 void console_print(const char *s)
 700 {
 701         printk(KERN_EMERG "%s", s);
 702 }
 703 EXPORT_SYMBOL(console_print);
 704
 705 void console_unblank(void)
 706 {
 707         struct console *c;
 708
 709         /*
 710          * Try to get the console semaphore. If someone else owns it
 711          * we have to return without unblanking because console_unblank
 712          * may be called in interrupt context.
 713          */
 714         if (down_trylock(&console_sem) != 0)
 715                 return;
 716         console_locked = 1;
 717         console_may_schedule = 0;
 718         for (c = console_drivers; c != NULL; c = c->next)
 719                 if ((c->flags & CON_ENABLED) && c->unblank)
 720                         c->unblank();
 721         release_console_sem();
 722 }
 723 EXPORT_SYMBOL(console_unblank);
 724
 725 /*
 726  * Return the console tty driver structure and its associated index
 727  */
 728 struct tty_driver *console_device(int *index)
 729 {
 730         struct console *c;
 731         struct tty_driver *driver = NULL;
 732
 733         acquire_console_sem();
 734         for (c = console_drivers; c != NULL; c = c->next) {
 735                 if (!c->device)
 736                         continue;
 737                 driver = c->device(c, index);
 738                 if (driver)
 739                         break;
 740         }
 741         release_console_sem();
 742         return driver;
 743 }
 744
 745 /*
 746  * Prevent further output on the passed console device so that (for example)
 747  * serial drivers can disable console output before suspending a port, and can
 748  * re-enable output afterwards.
 749  */
 750 void console_stop(struct console *console)
 751 {
 752         acquire_console_sem();
 753         console->flags &= ~CON_ENABLED;
 754         release_console_sem();
 755 }
 756 EXPORT_SYMBOL(console_stop);
 757
 758 void console_start(struct console *console)
 759 {
 760         acquire_console_sem();
 761         console->flags |= CON_ENABLED;
 762         release_console_sem();
 763 }
 764 EXPORT_SYMBOL(console_start);
 765
 766 /*
 767  * The console driver calls this routine during kernel initialization
 768  * to register the console printing procedure with printk() and to
 769  * print any messages that were printed by the kernel before the
 770  * console driver was initialized.
 771  */
 772 void register_console(struct console * console)
 773 {
 774         int     i;
 775         unsigned long flags;
 776
 777         if (preferred_console < 0)
 778                 preferred_console = selected_console;
 779
 780         /*
 781          *      See if we want to use this console driver. If we
 782          *      didn't select a console we take the first one
 783          *      that registers here.
 784          */
 785         if (preferred_console < 0) {
 786                 if (console->index < 0)
 787                         console->index = 0;
 788                 if (console->setup == NULL ||
 789                     console->setup(console, NULL) == 0) {
 790                         console->flags |= CON_ENABLED | CON_CONSDEV;
 791                         preferred_console = 0;
 792                 }
 793         }
 794
 795         /*
 796          *      See if this console matches one we selected on
 797          *      the command line.
 798          */
 799         for(i = 0; i < MAX_CMDLINECONSOLES && console_cmdline[i].name[0]; i++) {
 800                 if (strcmp(console_cmdline[i].name, console->name) != 0)
 801                         continue;
 802                 if (console->index >= 0 &&
 803                     console->index != console_cmdline[i].index)
 804                         continue;
 805                 if (console->index < 0)
 806                         console->index = console_cmdline[i].index;
 807                 if (console->setup &&
 808                     console->setup(console, console_cmdline[i].options) != 0)
 809                         break;
 810                 console->flags |= CON_ENABLED;
 811                 console->index = console_cmdline[i].index;
 812                 if (i == preferred_console)
 813                         console->flags |= CON_CONSDEV;
 814                 break;
 815         }
 816
 817         if (!(console->flags & CON_ENABLED))
 818                 return;
 819
 820         /*
 821          *      Put this console in the list - keep the
 822          *      preferred driver at the head of the list.
 823          */
 824         acquire_console_sem();
 825         if ((console->flags & CON_CONSDEV) || console_drivers == NULL) {
 826                 console->next = console_drivers;
 827                 console_drivers = console;
 828         } else {
 829                 console->next = console_drivers->next;
 830                 console_drivers->next = console;
 831         }
 832         if (console->flags & CON_PRINTBUFFER) {
 833                 /*
 834                  * release_console_sem() will print out the buffered messages
 835                  * for us.
 836                  */
 837                 spin_lock_irqsave(&logbuf_lock, flags);
 838                 con_start = log_start;
 839                 spin_unlock_irqrestore(&logbuf_lock, flags);
 840         }
 841         release_console_sem();
 842 }
 843 EXPORT_SYMBOL(register_console);
 844
 845 int unregister_console(struct console * console)
 846 {
 847         struct console *a,*b;
 848         int res = 1;
 849
 850         acquire_console_sem();
 851         if (console_drivers == console) {
 852                 console_drivers=console->next;
 853                 res = 0;
 854         } else {
 855                 for (a=console_drivers->next, b=console_drivers ;
 856                      a; b=a, a=b->next) {
 857                         if (a == console) {
 858                                 b->next = a->next;
 859                                 res = 0;
 860                                 break;
 861                         }
 862                 }
 863         }
 864
 865         /* If last console is removed, we re-enable picking the first
 866          * one that gets registered. Without that, pmac early boot console
 867          * would prevent fbcon from taking over.
 868          */
 869         if (console_drivers == NULL)
 870                 preferred_console = selected_console;
 871
 872
 873         release_console_sem();
 874         return res;
 875 }
 876 EXPORT_SYMBOL(unregister_console);
 877
 878 /**
 879  * tty_write_message - write a message to a certain tty, not just the console.
 880  *
 881  * This is used for messages that need to be redirected to a specific tty.
 882  * We don't put it into the syslog queue right now maybe in the future if
 883  * really needed.
 884  */
 885 void tty_write_message(struct tty_struct *tty, char *msg)
 886 {
 887         if (tty && tty->driver->write)
 888                 tty->driver->write(tty, msg, strlen(msg));
 889         return;
 890 }
 891
 892 /*
 893  * printk rate limiting, lifted from the networking subsystem.
 894  *
 895  * This enforces a rate limit: not more than one kernel message
 896  * every printk_ratelimit_jiffies to make a denial-of-service
 897  * attack impossible.
 898  */
 899 int __printk_ratelimit(int ratelimit_jiffies, int ratelimit_burst)
 900 {
 901         static spinlock_t ratelimit_lock = SPIN_LOCK_UNLOCKED;
 902         static unsigned long toks = 10*5*HZ;
 903         static unsigned long last_msg;
 904         static int missed;
 905         unsigned long flags;
 906         unsigned long now = jiffies;
 907
 908         spin_lock_irqsave(&ratelimit_lock, flags);
 909         toks += now - last_msg;
 910         last_msg = now;
 911         if (toks > (ratelimit_burst * ratelimit_jiffies))
 912                 toks = ratelimit_burst * ratelimit_jiffies;
 913         if (toks >= ratelimit_jiffies) {
 914                 int lost = missed;
 915                 missed = 0;
 916                 toks -= ratelimit_jiffies;
 917                 spin_unlock_irqrestore(&ratelimit_lock, flags);
 918                 if (lost)
 919                         printk(KERN_WARNING "printk: %d messages suppressed.\n", lost);
 920                 return 1;
 921         }
 922         missed++;
 923         spin_unlock_irqrestore(&ratelimit_lock, flags);
 924         return 0;
 925 }
 926 EXPORT_SYMBOL(__printk_ratelimit);
 927
 928 /* minimum time in jiffies between messages */
 929 int printk_ratelimit_jiffies = 5*HZ;
 930
 931 /* number of messages we send before ratelimiting */
 932 int printk_ratelimit_burst = 10;
 933
 934 int printk_ratelimit(void)
 935 {
 936         return __printk_ratelimit(printk_ratelimit_jiffies,
 937                                 printk_ratelimit_burst);
 938 }
 939 EXPORT_SYMBOL(printk_ratelimit);