Subversion Repositories HelenOS

Rev

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

  1. /*
  2.  * Copyright (c) 2005 Jakub Jermar
  3.  * All rights reserved.
  4.  *
  5.  * Redistribution and use in source and binary forms, with or without
  6.  * modification, are permitted provided that the following conditions
  7.  * are met:
  8.  *
  9.  * - Redistributions of source code must retain the above copyright
  10.  *   notice, this list of conditions and the following disclaimer.
  11.  * - Redistributions in binary form must reproduce the above copyright
  12.  *   notice, this list of conditions and the following disclaimer in the
  13.  *   documentation and/or other materials provided with the distribution.
  14.  * - The name of the author may not be used to endorse or promote products
  15.  *   derived from this software without specific prior written permission.
  16.  *
  17.  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  18.  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  19.  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  20.  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  21.  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  22.  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  23.  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  24.  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25.  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  26.  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27.  */
  28.  
  29. /** @addtogroup genericconsole
  30.  * @{
  31.  */
  32.  
  33. /**
  34.  * @file  kconsole.c
  35.  * @brief Kernel console.
  36.  *
  37.  * This file contains kernel thread managing the kernel console.
  38.  *
  39.  */
  40.  
  41. #include <console/kconsole.h>
  42. #include <console/console.h>
  43. #include <console/chardev.h>
  44. #include <console/cmd.h>
  45. #include <print.h>
  46. #include <panic.h>
  47. #include <arch/types.h>
  48. #include <adt/list.h>
  49. #include <arch.h>
  50. #include <macros.h>
  51. #include <debug.h>
  52. #include <func.h>
  53. #include <string.h>
  54. #include <macros.h>
  55. #include <sysinfo/sysinfo.h>
  56. #include <ddi/device.h>
  57. #include <symtab.h>
  58. #include <errno.h>
  59. #include <putchar.h>
  60. #include <string.h>
  61.  
  62. /** Simple kernel console.
  63.  *
  64.  * The console is realized by kernel thread kconsole.
  65.  * It doesn't understand any useful command on its own,
  66.  * but makes it possible for other kernel subsystems to
  67.  * register their own commands.
  68.  */
  69.  
  70. /** Locking.
  71.  *
  72.  * There is a list of cmd_info_t structures. This list
  73.  * is protected by cmd_lock spinlock. Note that specially
  74.  * the link elements of cmd_info_t are protected by
  75.  * this lock.
  76.  *
  77.  * Each cmd_info_t also has its own lock, which protects
  78.  * all elements thereof except the link element.
  79.  *
  80.  * cmd_lock must be acquired before any cmd_info lock.
  81.  * When locking two cmd info structures, structure with
  82.  * lower address must be locked first.
  83.  */
  84.  
  85. SPINLOCK_INITIALIZE(cmd_lock);  /**< Lock protecting command list. */
  86. LIST_INITIALIZE(cmd_head);      /**< Command list. */
  87.  
  88. static wchar_t history[KCONSOLE_HISTORY][MAX_CMDLINE] = {};
  89. static count_t history_pos = 0;
  90.  
  91. /** Initialize kconsole data structures
  92.  *
  93.  * This is the most basic initialization, almost no
  94.  * other kernel subsystem is ready yet.
  95.  *
  96.  */
  97. void kconsole_init(void)
  98. {
  99.     unsigned int i;
  100.    
  101.     cmd_init();
  102.     for (i = 0; i < KCONSOLE_HISTORY; i++)
  103.         history[i][0] = 0;
  104. }
  105.  
  106. /** Register kconsole command.
  107.  *
  108.  * @param cmd Structure describing the command.
  109.  *
  110.  * @return False on failure, true on success.
  111.  *
  112.  */
  113. bool cmd_register(cmd_info_t *cmd)
  114. {
  115.     link_t *cur;
  116.    
  117.     spinlock_lock(&cmd_lock);
  118.    
  119.     /*
  120.      * Make sure the command is not already listed.
  121.      */
  122.     for (cur = cmd_head.next; cur != &cmd_head; cur = cur->next) {
  123.         cmd_info_t *hlp = list_get_instance(cur, cmd_info_t, link);
  124.        
  125.         if (hlp == cmd) {
  126.             /* The command is already there. */
  127.             spinlock_unlock(&cmd_lock);
  128.             return false;
  129.         }
  130.        
  131.         /* Avoid deadlock. */
  132.         if (hlp < cmd) {
  133.             spinlock_lock(&hlp->lock);
  134.             spinlock_lock(&cmd->lock);
  135.         } else {
  136.             spinlock_lock(&cmd->lock);
  137.             spinlock_lock(&hlp->lock);
  138.         }
  139.        
  140.         if (str_cmp(hlp->name, cmd->name) == 0) {
  141.             /* The command is already there. */
  142.             spinlock_unlock(&hlp->lock);
  143.             spinlock_unlock(&cmd->lock);
  144.             spinlock_unlock(&cmd_lock);
  145.             return false;
  146.         }
  147.        
  148.         spinlock_unlock(&hlp->lock);
  149.         spinlock_unlock(&cmd->lock);
  150.     }
  151.    
  152.     /*
  153.      * Now the command can be added.
  154.      */
  155.     list_append(&cmd->link, &cmd_head);
  156.    
  157.     spinlock_unlock(&cmd_lock);
  158.     return true;
  159. }
  160.  
  161. /** Print count times a character */
  162. static void print_cc(wchar_t ch, count_t count)
  163. {
  164.     count_t i;
  165.     for (i = 0; i < count; i++)
  166.         putchar(ch);
  167. }
  168.  
  169. /** Try to find a command beginning with prefix */
  170. static const char *cmdtab_search_one(const char *name, link_t **startpos)
  171. {
  172.     count_t namelen = str_length(name);
  173.    
  174.     spinlock_lock(&cmd_lock);
  175.    
  176.     if (*startpos == NULL)
  177.         *startpos = cmd_head.next;
  178.    
  179.     for (; *startpos != &cmd_head; *startpos = (*startpos)->next) {
  180.         cmd_info_t *hlp = list_get_instance(*startpos, cmd_info_t, link);
  181.        
  182.         const char *curname = hlp->name;
  183.         if (str_length(curname) < namelen)
  184.             continue;
  185.        
  186.         if (str_lcmp(curname, name, namelen) == 0) {
  187.             spinlock_unlock(&cmd_lock);
  188.             return (curname + str_lsize(curname, namelen));
  189.         }
  190.     }
  191.    
  192.     spinlock_unlock(&cmd_lock);
  193.     return NULL;
  194. }
  195.  
  196. /** Command completion of the commands
  197.  *
  198.  * @param name String to match, changed to hint on exit
  199.  * @param size Input buffer size
  200.  *
  201.  * @return Number of found matches
  202.  *
  203.  */
  204. static int cmdtab_compl(char *input, size_t size)
  205. {
  206.     const char *name = input;
  207.    
  208.     count_t found = 0;
  209.     link_t *pos = NULL;
  210.     const char *hint;
  211.     char output[MAX_CMDLINE];
  212.    
  213.     output[0] = 0;
  214.    
  215.     while ((hint = cmdtab_search_one(name, &pos))) {
  216.         if ((found == 0) || (str_length(output) > str_length(hint)))
  217.             str_cpy(output, MAX_CMDLINE, hint);
  218.        
  219.         pos = pos->next;
  220.         found++;
  221.     }
  222.    
  223.     if ((found > 1) && (str_length(output) != 0)) {
  224.         printf("\n");
  225.         pos = NULL;
  226.         while ((hint = cmdtab_search_one(name, &pos))) {
  227.             cmd_info_t *hlp = list_get_instance(pos, cmd_info_t, link);
  228.             printf("%s (%s)\n", hlp->name, hlp->description);
  229.             pos = pos->next;
  230.         }
  231.     }
  232.    
  233.     if (found > 0)
  234.         str_cpy(input, size, output);
  235.    
  236.     return found;
  237. }
  238.  
  239. static wchar_t *clever_readline(const char *prompt, indev_t *indev)
  240. {
  241.     printf("%s> ", prompt);
  242.    
  243.     count_t position = 0;
  244.     wchar_t *current = history[history_pos];
  245.     current[0] = 0;
  246.    
  247.     while (true) {
  248.         wchar_t ch = _getc(indev);
  249.        
  250.         if (ch == '\n') {
  251.             /* Enter */
  252.             putchar(ch);
  253.             break;
  254.         }
  255.        
  256.         if (ch == '\b') {
  257.             /* Backspace */
  258.             if (position == 0)
  259.                 continue;
  260.            
  261.             if (wstr_remove(current, position - 1)) {
  262.                 position--;
  263.                 putchar('\b');
  264.                 printf("%ls ", current + position);
  265.                 print_cc('\b', wstr_length(current) - position + 1);
  266.                 continue;
  267.             }
  268.         }
  269.        
  270.         if (ch == '\t') {
  271.             /* Tab completion */
  272.            
  273.             /* Move to the end of the word */
  274.             for (; (current[position] != 0) && (!isspace(current[position]));
  275.                 position++)
  276.                 putchar(current[position]);
  277.            
  278.             if (position == 0)
  279.                 continue;
  280.            
  281.             /* Find the beginning of the word
  282.                and copy it to tmp */
  283.             count_t beg;
  284.             for (beg = position - 1; (beg > 0) && (!isspace(current[beg]));
  285.                 beg--);
  286.            
  287.             if (isspace(current[beg]))
  288.                 beg++;
  289.            
  290.             char tmp[STR_BOUNDS(MAX_CMDLINE)];
  291.             wstr_nstr(tmp, current + beg, position - beg + 1);
  292.            
  293.             int found;
  294.             if (beg == 0) {
  295.                 /* Command completion */
  296.                 found = cmdtab_compl(tmp, STR_BOUNDS(MAX_CMDLINE));
  297.             } else {
  298.                 /* Symbol completion */
  299.                 found = symtab_compl(tmp, STR_BOUNDS(MAX_CMDLINE));
  300.             }
  301.            
  302.             if (found == 0)
  303.                 continue;
  304.            
  305.             if (found > 1) {
  306.                 /* No unique hint, list was printed */
  307.                 printf("%s> ", prompt);
  308.                 printf("%ls", current);
  309.                 print_cc('\b', wstr_length(current) - position);
  310.                 continue;
  311.             }
  312.            
  313.             /* We have a hint */
  314.            
  315.             size_t off = 0;
  316.             count_t i = 0;
  317.             while ((ch = str_decode(tmp, &off, STR_NO_LIMIT)) != 0) {
  318.                 if (!wstr_linsert(current, ch, position + i, MAX_CMDLINE))
  319.                     break;
  320.                 i++;
  321.             }
  322.            
  323.             printf("%ls", current + position);
  324.             position += str_length(tmp);
  325.             print_cc('\b', wstr_length(current) - position);
  326.            
  327.             if (position == wstr_length(current)) {
  328.                 /* Insert a space after the last completed argument */
  329.                 if (wstr_linsert(current, ' ', position, MAX_CMDLINE)) {
  330.                     printf("%ls", current + position);
  331.                     position++;
  332.                 }
  333.             }
  334.             continue;
  335.         }
  336.        
  337.         if (ch == U_LEFT_ARROW) {
  338.             /* Left */
  339.             if (position > 0) {
  340.                 putchar('\b');
  341.                 position--;
  342.             }
  343.             continue;
  344.         }
  345.        
  346.         if (ch == U_RIGHT_ARROW) {
  347.             /* Right */
  348.             if (position < wstr_length(current)) {
  349.                 putchar(current[position]);
  350.                 position++;
  351.             }
  352.             continue;
  353.         }
  354.        
  355.         if ((ch == U_UP_ARROW) || (ch == U_DOWN_ARROW)) {
  356.             /* Up, down */
  357.             print_cc('\b', position);
  358.             print_cc(' ', wstr_length(current));
  359.             print_cc('\b', wstr_length(current));
  360.            
  361.             if (ch == U_UP_ARROW) {
  362.                 /* Up */
  363.                 if (history_pos == 0)
  364.                     history_pos = KCONSOLE_HISTORY - 1;
  365.                 else
  366.                     history_pos--;
  367.             } else {
  368.                 /* Down */
  369.                 history_pos++;
  370.                 history_pos = history_pos % KCONSOLE_HISTORY;
  371.             }
  372.             current = history[history_pos];
  373.             printf("%ls", current);
  374.             position = wstr_length(current);
  375.             continue;
  376.         }
  377.        
  378.         if (ch == U_HOME_ARROW) {
  379.             /* Home */
  380.             print_cc('\b', position);
  381.             position = 0;
  382.             continue;
  383.         }
  384.        
  385.         if (ch == U_END_ARROW) {
  386.             /* End */
  387.             printf("%ls", current + position);
  388.             position = wstr_length(current);
  389.             continue;
  390.         }
  391.        
  392.         if (ch == U_DELETE) {
  393.             /* Delete */
  394.             if (position == wstr_length(current))
  395.                 continue;
  396.            
  397.             if (wstr_remove(current, position)) {
  398.                 printf("%ls ", current + position);
  399.                 print_cc('\b', wstr_length(current) - position + 1);
  400.             }
  401.             continue;
  402.         }
  403.        
  404.         if (wstr_linsert(current, ch, position, MAX_CMDLINE)) {
  405.             printf("%ls", current + position);
  406.             position++;
  407.             print_cc('\b', wstr_length(current) - position);
  408.         }
  409.     }
  410.    
  411.     if (wstr_length(current) > 0) {
  412.         history_pos++;
  413.         history_pos = history_pos % KCONSOLE_HISTORY;
  414.     }
  415.    
  416.     return current;
  417. }
  418.  
  419. bool kconsole_check_poll(void)
  420. {
  421.     return check_poll(stdin);
  422. }
  423.  
  424. static bool parse_int_arg(const char *text, size_t len, unative_t *result)
  425. {
  426.     bool isaddr = false;
  427.     bool isptr = false;
  428.    
  429.     /* If we get a name, try to find it in symbol table */
  430.     if (text[0] == '&') {
  431.         isaddr = true;
  432.         text++;
  433.         len--;
  434.     } else if (text[0] == '*') {
  435.         isptr = true;
  436.         text++;
  437.         len--;
  438.     }
  439.    
  440.     if ((text[0] < '0') || (text[0] > '9')) {
  441.         char symname[MAX_SYMBOL_NAME];
  442.         str_ncpy(symname, MAX_SYMBOL_NAME, text, len + 1);
  443.        
  444.         uintptr_t symaddr;
  445.         int rc = symtab_addr_lookup(symname, &symaddr);
  446.         switch (rc) {
  447.         case ENOENT:
  448.             printf("Symbol %s not found.\n", symname);
  449.             return false;
  450.         case EOVERFLOW:
  451.             printf("Duplicate symbol %s.\n", symname);
  452.             symtab_print_search(symname);
  453.             return false;
  454.         case ENOTSUP:
  455.             printf("No symbol information available.\n");
  456.             return false;
  457.         }
  458.        
  459.         if (isaddr)
  460.             *result = (unative_t) symaddr;
  461.         else if (isptr)
  462.             *result = **((unative_t **) symaddr);
  463.         else
  464.             *result = *((unative_t *) symaddr);
  465.     } else {
  466.         /* It's a number - convert it */
  467.         *result = atoi(text);
  468.         if (isptr)
  469.             *result = *((unative_t *) *result);
  470.     }
  471.    
  472.     return true;
  473. }
  474.  
  475. /** Parse argument.
  476.  *
  477.  * Find start and end positions of command line argument.
  478.  *
  479.  * @param cmdline Command line as read from the input device.
  480.  * @param size    Size (in bytes) of the string.
  481.  * @param start   On entry, 'start' contains pointer to the offset
  482.  *                of the first unprocessed character of cmdline.
  483.  *                On successful exit, it marks beginning of the next argument.
  484.  * @param end     Undefined on entry. On exit, 'end' is the offset of the first
  485.  *                character behind the next argument.
  486.  *
  487.  * @return False on failure, true on success.
  488.  *
  489.  */
  490. static bool parse_argument(const char *cmdline, size_t size, size_t *start, size_t *end)
  491. {
  492.     ASSERT(start != NULL);
  493.     ASSERT(end != NULL);
  494.    
  495.     bool found_start = false;
  496.     size_t offset = *start;
  497.     size_t prev = *start;
  498.     wchar_t ch;
  499.    
  500.     while ((ch = str_decode(cmdline, &offset, size)) != 0) {
  501.         if (!found_start) {
  502.             if (!isspace(ch)) {
  503.                 *start = prev;
  504.                 found_start = true;
  505.             }
  506.         } else {
  507.             if (isspace(ch))
  508.                 break;
  509.         }
  510.        
  511.         prev = offset;
  512.     }
  513.     *end = prev;
  514.    
  515.     return found_start;
  516. }
  517.  
  518. /** Parse command line.
  519.  *
  520.  * @param cmdline Command line as read from input device.
  521.  * @param size    Size (in bytes) of the string.
  522.  *
  523.  * @return Structure describing the command.
  524.  *
  525.  */
  526. static cmd_info_t *parse_cmdline(const char *cmdline, size_t size)
  527. {
  528.     size_t start = 0;
  529.     size_t end = 0;
  530.     if (!parse_argument(cmdline, size, &start, &end)) {
  531.         /* Command line did not contain alphanumeric word. */
  532.         return NULL;
  533.     }
  534.     spinlock_lock(&cmd_lock);
  535.    
  536.     cmd_info_t *cmd = NULL;
  537.     link_t *cur;
  538.    
  539.     for (cur = cmd_head.next; cur != &cmd_head; cur = cur->next) {
  540.         cmd_info_t *hlp = list_get_instance(cur, cmd_info_t, link);
  541.         spinlock_lock(&hlp->lock);
  542.        
  543.         if (str_lcmp(hlp->name, cmdline + start,
  544.             max(str_length(hlp->name),
  545.             str_nlength(cmdline + start, (count_t) (end - start) - 1))) == 0) {
  546.             cmd = hlp;
  547.             break;
  548.         }
  549.        
  550.         spinlock_unlock(&hlp->lock);
  551.     }
  552.    
  553.     spinlock_unlock(&cmd_lock);
  554.    
  555.     if (!cmd) {
  556.         /* Unknown command. */
  557.         printf("Unknown command.\n");
  558.         return NULL;
  559.     }
  560.    
  561.     /* cmd == hlp is locked */
  562.    
  563.     /*
  564.      * The command line must be further analyzed and
  565.      * the parameters therefrom must be matched and
  566.      * converted to those specified in the cmd info
  567.      * structure.
  568.      */
  569.    
  570.     bool error = false;
  571.     count_t i;
  572.     for (i = 0; i < cmd->argc; i++) {
  573.         start = end;
  574.         if (!parse_argument(cmdline, size, &start, &end)) {
  575.             printf("Too few arguments.\n");
  576.             spinlock_unlock(&cmd->lock);
  577.             return NULL;
  578.         }
  579.        
  580.         char *buf;
  581.         switch (cmd->argv[i].type) {
  582.         case ARG_TYPE_STRING:
  583.             buf = (char *) cmd->argv[i].buffer;
  584.             str_ncpy(buf, cmd->argv[i].len, cmdline + start,
  585.                 end - start);
  586.             break;
  587.         case ARG_TYPE_INT:
  588.             if (!parse_int_arg(cmdline + start, end - start,
  589.                 &cmd->argv[i].intval))
  590.                 error = true;
  591.             break;
  592.         case ARG_TYPE_VAR:
  593.             if ((start < end - 1) && (cmdline[start] == '"')) {
  594.                 if (cmdline[end - 1] == '"') {
  595.                     buf = (char *) cmd->argv[i].buffer;
  596.                     str_ncpy(buf, cmd->argv[i].len,
  597.                         cmdline + start + 1,
  598.                         (end - start) - 1);
  599.                     cmd->argv[i].intval = (unative_t) buf;
  600.                     cmd->argv[i].vartype = ARG_TYPE_STRING;
  601.                 } else {
  602.                     printf("Wrong synxtax.\n");
  603.                     error = true;
  604.                 }
  605.             } else if (parse_int_arg(cmdline + start,
  606.                 end - start, &cmd->argv[i].intval)) {
  607.                 cmd->argv[i].vartype = ARG_TYPE_INT;
  608.             } else {
  609.                 printf("Unrecognized variable argument.\n");
  610.                 error = true;
  611.             }
  612.             break;
  613.         case ARG_TYPE_INVALID:
  614.         default:
  615.             printf("Invalid argument type\n");
  616.             error = true;
  617.             break;
  618.         }
  619.     }
  620.    
  621.     if (error) {
  622.         spinlock_unlock(&cmd->lock);
  623.         return NULL;
  624.     }
  625.    
  626.     start = end;
  627.     if (parse_argument(cmdline, size, &start, &end)) {
  628.         printf("Too many arguments.\n");
  629.         spinlock_unlock(&cmd->lock);
  630.         return NULL;
  631.     }
  632.    
  633.     spinlock_unlock(&cmd->lock);
  634.     return cmd;
  635. }
  636.  
  637. /** Kernel console prompt.
  638.  *
  639.  * @param prompt Kernel console prompt (e.g kconsole/panic).
  640.  * @param msg    Message to display in the beginning.
  641.  * @param kcon   Wait for keypress to show the prompt
  642.  *               and never exit.
  643.  *
  644.  */
  645. void kconsole(char *prompt, char *msg, bool kcon)
  646. {
  647.     if (!stdin) {
  648.         LOG("No stdin for kernel console");
  649.         return;
  650.     }
  651.    
  652.     if (msg)
  653.         printf("%s", msg);
  654.    
  655.     if (kcon)
  656.         _getc(stdin);
  657.     else
  658.         printf("Type \"exit\" to leave the console.\n");
  659.    
  660.     while (true) {
  661.         wchar_t *tmp = clever_readline((char *) prompt, stdin);
  662.         count_t len = wstr_length(tmp);
  663.         if (!len)
  664.             continue;
  665.        
  666.         char cmdline[STR_BOUNDS(MAX_CMDLINE)];
  667.         wstr_nstr(cmdline, tmp, STR_BOUNDS(MAX_CMDLINE));
  668.        
  669.         if ((!kcon) && (len == 4) && (str_lcmp(cmdline, "exit", 4) == 0))
  670.             break;
  671.        
  672.         cmd_info_t *cmd_info = parse_cmdline(cmdline, STR_BOUNDS(MAX_CMDLINE));
  673.         if (!cmd_info)
  674.             continue;
  675.        
  676.         (void) cmd_info->func(cmd_info->argv);
  677.     }
  678. }
  679.  
  680. /** Kernel console managing thread.
  681.  *
  682.  */
  683. void kconsole_thread(void *data)
  684. {
  685.     kconsole("kconsole", "Kernel console ready (press any key to activate)\n", true);
  686. }
  687.  
  688. /** @}
  689.  */
  690.