Subversion Repositories HelenOS

Rev

Rev 4218 | Rev 4252 | Go to most recent revision | Blame | Compare with Previous | Last modification | View Log | Download | RSS feed

  1. /*
  2.  * Copyright (c) 2003 Josef Cejka
  3.  * Copyright (c) 2005 Jakub Jermar
  4.  * All rights reserved.
  5.  *
  6.  * Redistribution and use in source and binary forms, with or without
  7.  * modification, are permitted provided that the following conditions
  8.  * are met:
  9.  *
  10.  * - Redistributions of source code must retain the above copyright
  11.  *   notice, this list of conditions and the following disclaimer.
  12.  * - Redistributions in binary form must reproduce the above copyright
  13.  *   notice, this list of conditions and the following disclaimer in the
  14.  *   documentation and/or other materials provided with the distribution.
  15.  * - The name of the author may not be used to endorse or promote products
  16.  *   derived from this software without specific prior written permission.
  17.  *
  18.  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  19.  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  20.  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  21.  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  22.  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  23.  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  24.  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  25.  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  26.  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  27.  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  28.  */
  29.  
  30. /** @addtogroup genericconsole
  31.  * @{
  32.  */
  33. /** @file
  34.  */
  35.  
  36. #include <console/console.h>
  37. #include <console/chardev.h>
  38. #include <sysinfo/sysinfo.h>
  39. #include <synch/waitq.h>
  40. #include <synch/spinlock.h>
  41. #include <arch/types.h>
  42. #include <ddi/irq.h>
  43. #include <ddi/ddi.h>
  44. #include <event/event.h>
  45. #include <ipc/irq.h>
  46. #include <arch.h>
  47. #include <func.h>
  48. #include <print.h>
  49. #include <putchar.h>
  50. #include <atomic.h>
  51. #include <syscall/copy.h>
  52. #include <errno.h>
  53. #include <string.h>
  54.  
  55. #define KLOG_SIZE     PAGE_SIZE
  56. #define KLOG_LENGTH   (KLOG_SIZE / sizeof(wchar_t))
  57. #define KLOG_LATENCY  8
  58.  
  59. /** Kernel log cyclic buffer */
  60. static wchar_t klog[KLOG_LENGTH] __attribute__ ((aligned (PAGE_SIZE)));
  61.  
  62. /** Kernel log initialized */
  63. static bool klog_inited = false;
  64. /** First kernel log characters */
  65. static index_t klog_start = 0;
  66. /** Number of valid kernel log characters */
  67. static size_t klog_len = 0;
  68. /** Number of stored (not printed) kernel log characters */
  69. static size_t klog_stored = 0;
  70. /** Number of stored kernel log characters for uspace */
  71. static size_t klog_uspace = 0;
  72.  
  73. /** Silence output */
  74. bool silent = false;
  75.  
  76. /** Kernel log spinlock */
  77. SPINLOCK_INITIALIZE(klog_lock);
  78.  
  79. /** Physical memory area used for klog buffer */
  80. static parea_t klog_parea;
  81.  
  82. /** Standard input and output character devices */
  83. indev_t *stdin = NULL;
  84. outdev_t *stdout = NULL;
  85.  
  86. /** Initialize kernel logging facility
  87.  *
  88.  * The shared area contains kernel cyclic buffer. Userspace application may
  89.  * be notified on new data with indication of position and size
  90.  * of the data within the circular buffer.
  91.  *
  92.  */
  93. void klog_init(void)
  94. {
  95.     void *faddr = (void *) KA2PA(klog);
  96.    
  97.     ASSERT((uintptr_t) faddr % FRAME_SIZE == 0);
  98.     ASSERT(KLOG_SIZE % FRAME_SIZE == 0);
  99.    
  100.     klog_parea.pbase = (uintptr_t) faddr;
  101.     klog_parea.frames = SIZE2FRAMES(sizeof(klog));
  102.     ddi_parea_register(&klog_parea);
  103.    
  104.     sysinfo_set_item_val("klog.faddr", NULL, (unative_t) faddr);
  105.     sysinfo_set_item_val("klog.pages", NULL, SIZE2FRAMES(sizeof(klog)));
  106.    
  107.     spinlock_lock(&klog_lock);
  108.     klog_inited = true;
  109.     spinlock_unlock(&klog_lock);
  110. }
  111.  
  112. void grab_console(void)
  113. {
  114.     silent = false;
  115.     arch_grab_console();
  116. }
  117.  
  118. void release_console(void)
  119. {
  120.     silent = true;
  121.     arch_release_console();
  122. }
  123.  
  124. /** Tell kernel to get keyboard/console access again */
  125. unative_t sys_debug_enable_console(void)
  126. {
  127. #ifdef CONFIG_KCONSOLE
  128.     grab_console();
  129.     return true;
  130. #else
  131.     return false;
  132. #endif
  133. }
  134.  
  135. /** Tell kernel to relinquish keyboard/console access */
  136. unative_t sys_debug_disable_console(void)
  137. {
  138.     release_console();
  139.     return true;
  140. }
  141.  
  142. bool check_poll(indev_t *indev)
  143. {
  144.     if (indev == NULL)
  145.         return false;
  146.    
  147.     if (indev->op == NULL)
  148.         return false;
  149.    
  150.     return (indev->op->poll != NULL);
  151. }
  152.  
  153. /** Get character from input character device. Do not echo character.
  154.  *
  155.  * @param indev Input character device.
  156.  * @return Character read.
  157.  *
  158.  */
  159. wchar_t _getc(indev_t *indev)
  160. {
  161.     if (atomic_get(&haltstate)) {
  162.         /* If we are here, we are hopefully on the processor that
  163.          * issued the 'halt' command, so proceed to read the character
  164.          * directly from input
  165.          */
  166.         if (check_poll(indev))
  167.             return indev->op->poll(indev);
  168.        
  169.         /* No other way of interacting with user */
  170.         interrupts_disable();
  171.        
  172.         if (CPU)
  173.             printf("cpu%u: ", CPU->id);
  174.         else
  175.             printf("cpu: ");
  176.         printf("halted (no polling input)\n");
  177.         cpu_halt();
  178.     }
  179.    
  180.     waitq_sleep(&indev->wq);
  181.     ipl_t ipl = interrupts_disable();
  182.     spinlock_lock(&indev->lock);
  183.     wchar_t ch = indev->buffer[(indev->index - indev->counter) % INDEV_BUFLEN];
  184.     indev->counter--;
  185.     spinlock_unlock(&indev->lock);
  186.     interrupts_restore(ipl);
  187.    
  188.     return ch;
  189. }
  190.  
  191. /** Get string from input character device.
  192.  *
  193.  * Read characters from input character device until first occurrence
  194.  * of newline character.
  195.  *
  196.  * @param indev  Input character device.
  197.  * @param buf    Buffer where to store string terminated by NULL.
  198.  * @param buflen Size of the buffer.
  199.  *
  200.  * @return Number of characters read.
  201.  *
  202.  */
  203. count_t gets(indev_t *indev, char *buf, size_t buflen)
  204. {
  205.     size_t offset = 0;
  206.     count_t count = 0;
  207.     buf[offset] = 0;
  208.    
  209.     wchar_t ch;
  210.     while ((ch = _getc(indev)) != '\n') {
  211.         if (ch == '\b') {
  212.             if (count > 0) {
  213.                 /* Space, backspace, space */
  214.                 putchar('\b');
  215.                 putchar(' ');
  216.                 putchar('\b');
  217.                
  218.                 count--;
  219.                 offset = str_lsize(buf, count);
  220.                 buf[offset] = 0;
  221.             }
  222.         }
  223.         if (chr_encode(ch, buf, &offset, buflen - 1) == EOK) {
  224.             putchar(ch);
  225.             count++;
  226.             buf[offset] = 0;
  227.         }
  228.     }
  229.    
  230.     return count;
  231. }
  232.  
  233. /** Get character from input device & echo it to screen */
  234. wchar_t getc(indev_t *indev)
  235. {
  236.     wchar_t ch = _getc(indev);
  237.     putchar(ch);
  238.     return ch;
  239. }
  240.  
  241. void klog_update(void)
  242. {
  243.     spinlock_lock(&klog_lock);
  244.    
  245.     if ((klog_inited) && (event_is_subscribed(EVENT_KLOG)) && (klog_uspace > 0)) {
  246.         event_notify_3(EVENT_KLOG, klog_start, klog_len, klog_uspace);
  247.         klog_uspace = 0;
  248.     }
  249.    
  250.     spinlock_unlock(&klog_lock);
  251. }
  252.  
  253. void putchar(const wchar_t ch)
  254. {
  255.     spinlock_lock(&klog_lock);
  256.    
  257.     if ((klog_stored > 0) && (stdout) && (stdout->op->write)) {
  258.         /* Print charaters stored in kernel log */
  259.         index_t i;
  260.         for (i = klog_len - klog_stored; i < klog_len; i++)
  261.             stdout->op->write(stdout, klog[(klog_start + i) % KLOG_LENGTH], silent);
  262.         klog_stored = 0;
  263.     }
  264.    
  265.     /* Store character in the cyclic kernel log */
  266.     klog[(klog_start + klog_len) % KLOG_LENGTH] = ch;
  267.     if (klog_len < KLOG_LENGTH)
  268.         klog_len++;
  269.     else
  270.         klog_start = (klog_start + 1) % KLOG_LENGTH;
  271.    
  272.     if ((stdout) && (stdout->op->write))
  273.         stdout->op->write(stdout, ch, silent);
  274.     else {
  275.         /* The character is just in the kernel log */
  276.         if (klog_stored < klog_len)
  277.             klog_stored++;
  278.     }
  279.    
  280.     /* The character is stored for uspace */
  281.     if (klog_uspace < klog_len)
  282.         klog_uspace++;
  283.    
  284.     /* Check notify uspace to update */
  285.     bool update;
  286.     if ((klog_uspace > KLOG_LATENCY) || (ch == '\n'))
  287.         update = true;
  288.     else
  289.         update = false;
  290.    
  291.     spinlock_unlock(&klog_lock);
  292.    
  293.     if (update)
  294.         klog_update();
  295. }
  296.  
  297. /** Print using kernel facility
  298.  *
  299.  * Print to kernel log.
  300.  *
  301.  */
  302. unative_t sys_klog(int fd, const void *buf, size_t size)
  303. {
  304.     char *data;
  305.     int rc;
  306.    
  307.     if (size > PAGE_SIZE)
  308.         return ELIMIT;
  309.    
  310.     if (size > 0) {
  311.         data = (char *) malloc(size + 1, 0);
  312.         if (!data)
  313.             return ENOMEM;
  314.        
  315.         rc = copy_from_uspace(data, buf, size);
  316.         if (rc) {
  317.             free(data);
  318.             return rc;
  319.         }
  320.         data[size] = 0;
  321.        
  322.         printf("%s", data);
  323.         free(data);
  324.     } else
  325.         klog_update();
  326.    
  327.     return size;
  328. }
  329.  
  330. /** @}
  331.  */
  332.