Subversion Repositories HelenOS

Rev

Rev 614 | Rev 624 | 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. #include <console/kconsole.h>
  30. #include <console/console.h>
  31. #include <console/chardev.h>
  32. #include <console/cmd.h>
  33. #include <print.h>
  34. #include <panic.h>
  35. #include <typedefs.h>
  36. #include <arch/types.h>
  37. #include <list.h>
  38. #include <arch.h>
  39. #include <macros.h>
  40. #include <debug.h>
  41. #include <func.h>
  42. #include <symtab.h>
  43. #include <macros.h>
  44.  
  45. /** Simple kernel console.
  46.  *
  47.  * The console is realized by kernel thread kconsole.
  48.  * It doesn't understand any useful command on its own,
  49.  * but makes it possible for other kernel subsystems to
  50.  * register their own commands.
  51.  */
  52.  
  53. /** Locking.
  54.  *
  55.  * There is a list of cmd_info_t structures. This list
  56.  * is protected by cmd_lock spinlock. Note that specially
  57.  * the link elements of cmd_info_t are protected by
  58.  * this lock.
  59.  *
  60.  * Each cmd_info_t also has its own lock, which protects
  61.  * all elements thereof except the link element.
  62.  *
  63.  * cmd_lock must be acquired before any cmd_info lock.
  64.  * When locking two cmd info structures, structure with
  65.  * lower address must be locked first.
  66.  */
  67.  
  68. SPINLOCK_INITIALIZE(cmd_lock);  /**< Lock protecting command list. */
  69. link_t cmd_head;        /**< Command list. */
  70.  
  71. static cmd_info_t *parse_cmdline(char *cmdline, size_t len);
  72. static bool parse_argument(char *cmdline, size_t len, index_t *start, index_t *end);
  73. static char history[KCONSOLE_HISTORY][MAX_CMDLINE] = {};
  74.  
  75. /** Initialize kconsole data structures. */
  76. void kconsole_init(void)
  77. {
  78.     int i;
  79.  
  80.     list_initialize(&cmd_head);
  81.  
  82.     cmd_init();
  83.     for (i=0; i<KCONSOLE_HISTORY; i++)
  84.         history[i][0] = '\0';
  85. }
  86.  
  87.  
  88. /** Register kconsole command.
  89.  *
  90.  * @param cmd Structure describing the command.
  91.  *
  92.  * @return 0 on failure, 1 on success.
  93.  */
  94. int cmd_register(cmd_info_t *cmd)
  95. {
  96.     ipl_t ipl;
  97.     link_t *cur;
  98.    
  99.     spinlock_lock(&cmd_lock);
  100.    
  101.     /*
  102.      * Make sure the command is not already listed.
  103.      */
  104.     for (cur = cmd_head.next; cur != &cmd_head; cur = cur->next) {
  105.         cmd_info_t *hlp;
  106.        
  107.         hlp = list_get_instance(cur, cmd_info_t, link);
  108.  
  109.         if (hlp == cmd) {
  110.             /* The command is already there. */
  111.             spinlock_unlock(&cmd_lock);
  112.             return 0;
  113.         }
  114.  
  115.         /* Avoid deadlock. */
  116.         if (hlp < cmd) {
  117.             spinlock_lock(&hlp->lock);
  118.             spinlock_lock(&cmd->lock);
  119.         } else {
  120.             spinlock_lock(&cmd->lock);
  121.             spinlock_lock(&hlp->lock);
  122.         }
  123.        
  124.         if ((strncmp(hlp->name, cmd->name, strlen(cmd->name)) == 0)) {
  125.             /* The command is already there. */
  126.             spinlock_unlock(&hlp->lock);
  127.             spinlock_unlock(&cmd->lock);
  128.             spinlock_unlock(&cmd_lock);
  129.             return 0;
  130.         }
  131.        
  132.         spinlock_unlock(&hlp->lock);
  133.         spinlock_unlock(&cmd->lock);
  134.     }
  135.    
  136.     /*
  137.      * Now the command can be added.
  138.      */
  139.     list_append(&cmd->link, &cmd_head);
  140.    
  141.     spinlock_unlock(&cmd_lock);
  142.     return 1;
  143. }
  144.  
  145. static void rdln_print_c(char ch, int count)
  146. {
  147.     int i;
  148.     for (i=0;i<count;i++)
  149.         putchar(ch);
  150. }
  151.  
  152. static void insert_char(char *str, char ch, int pos)
  153. {
  154.     int i;
  155.    
  156.     for (i=strlen(str);i > pos; i--)
  157.         str[i] = str[i-1];
  158.     str[pos] = ch;
  159. }
  160.  
  161. static const char * cmdtab_search_one(const char *name,link_t **startpos)
  162. {
  163.     int namelen = strlen(name);
  164.     const char *curname;
  165.     char *foundsym = NULL;
  166.     int foundpos = 0;
  167.  
  168.     spinlock_lock(&cmd_lock);
  169.  
  170.     if (!*startpos)
  171.         *startpos = cmd_head.next;
  172.  
  173.     for (;*startpos != &cmd_head;*startpos = (*startpos)->next) {
  174.         cmd_info_t *hlp;
  175.         hlp = list_get_instance(*startpos, cmd_info_t, link);
  176.  
  177.         curname = hlp->name;
  178.         if (strlen(curname) < namelen)
  179.             continue;
  180.         if (strncmp(curname, name, namelen) == 0) {
  181.             spinlock_unlock(&cmd_lock);
  182.             return curname+namelen;
  183.         }
  184.     }
  185.     spinlock_unlock(&cmd_lock);
  186.     return NULL;
  187. }
  188.  
  189.  
  190. /** Command completion of the commands
  191.  *
  192.  * @param name - string to match, changed to hint on exit
  193.  * @return number of found matches
  194.  */
  195. static int cmdtab_compl(char *name)
  196. {
  197.     char output[MAX_SYMBOL_NAME+1];
  198.     link_t *startpos = NULL;
  199.     const char *foundtxt;
  200.     int found = 0;
  201.     int i;
  202.  
  203.     output[0] = '\0';
  204.     while ((foundtxt = cmdtab_search_one(name, &startpos))) {
  205.         startpos = startpos->next;
  206.         if (!found)
  207.             strncpy(output, foundtxt, strlen(foundtxt)+1);
  208.         else {
  209.             for (i=0; output[i] && foundtxt[i] && output[i]==foundtxt[i]; i++)
  210.                 ;
  211.             output[i] = '\0';
  212.         }
  213.         found++;
  214.     }
  215.     if (!found)
  216.         return 0;
  217.  
  218.     if (found > 1 && !strlen(output)) {
  219.         printf("\n");
  220.         startpos = NULL;
  221.         while ((foundtxt = cmdtab_search_one(name, &startpos))) {
  222.             cmd_info_t *hlp;
  223.             hlp = list_get_instance(startpos, cmd_info_t, link);
  224.             printf("%s - %s\n", hlp->name, hlp->description);
  225.             startpos = startpos->next;
  226.         }
  227.     }
  228.     strncpy(name, output, MAX_SYMBOL_NAME);
  229.     return found;
  230.    
  231. }
  232.  
  233. static char * clever_readline(const char *prompt, chardev_t *input)
  234. {
  235.     static int histposition = 0;
  236.  
  237.     char tmp[MAX_CMDLINE+1];
  238.     int curlen = 0, position = 0;
  239.     char *current = history[histposition];
  240.     int i;
  241.     char mod; /* Command Modifier */
  242.     char c;
  243.  
  244.     printf("%s> ", prompt);
  245.     while (1) {
  246.         c = _getc(input);
  247.         if (c == '\n') {
  248.             putchar(c);
  249.             break;
  250.         } if (c == '\b') { /* Backspace */
  251.             if (position == 0)
  252.                 continue;
  253.             for (i=position; i<curlen;i++)
  254.                 current[i-1] = current[i];
  255.             curlen--;
  256.             position--;
  257.             putchar('\b');
  258.             for (i=position;i<curlen;i++)
  259.                 putchar(current[i]);
  260.             putchar(' ');
  261.             rdln_print_c('\b',curlen-position+1);
  262.             continue;
  263.         }
  264.         if (c == '\t') { /* Tabulator */
  265.             int found;
  266.  
  267.             /* Move to the end of the word */
  268.             for (;position<curlen && current[position]!=' ';position++)
  269.                 putchar(current[position]);
  270.             /* Copy to tmp last word */
  271.             for (i=position-1;i >= 0 && current[i]!=' ' ;i--)
  272.                 ;
  273.             /* If word begins with * or &, skip it */
  274.             if (tmp[0] == '*' || tmp[0] == '&')
  275.                 for (i=1;tmp[i];i++)
  276.                     tmp[i-1] = tmp[i];
  277.             i++; /* I is at the start of the word */
  278.             strncpy(tmp, current+i, position-i+1);
  279.  
  280.             if (i==0) { /* Command completion */
  281.                 found = cmdtab_compl(tmp);
  282.             } else { /* Symtab completion */
  283.                 found = symtab_compl(tmp);
  284.             }
  285.  
  286.             if (found == 0)
  287.                 continue;
  288.             for (i=0;tmp[i] && curlen < MAX_CMDLINE;i++,curlen++)
  289.                 insert_char(current, tmp[i], i+position);
  290.  
  291.             if (strlen(tmp) || found==1) { /* If we have a hint */
  292.                 for (i=position;i<curlen;i++)
  293.                     putchar(current[i]);
  294.                 position += strlen(tmp);
  295.                 /* Add space to end */
  296.                 if (found == 1 && position == curlen && \
  297.                     curlen < MAX_CMDLINE) {
  298.                     current[position] = ' ';
  299.                     curlen++;
  300.                     position++;
  301.                     putchar(' ');
  302.                 }
  303.             } else { /* No hint, table was printed */
  304.                 printf("%s> ", prompt);
  305.                 for (i=0; i<curlen;i++)
  306.                     putchar(current[i]);
  307.                 position += strlen(tmp);
  308.             }
  309.             rdln_print_c('\b', curlen-position);
  310.             continue;
  311.         }
  312.         if (c == 0x1b) { /* Special command */
  313.             mod = _getc(input);
  314.             c = _getc(input);
  315.  
  316.             if (mod != 0x5b && mod != 0x4f)
  317.                 continue;
  318.  
  319.             if (c == 0x33 && _getc(input) == 0x7e) {
  320.                 /* Delete */
  321.                 if (position == curlen)
  322.                     continue;
  323.                 for (i=position+1; i<curlen;i++) {
  324.                     putchar(current[i]);
  325.                     current[i-1] = current[i];
  326.                 }
  327.                 putchar(' ');
  328.                 rdln_print_c('\b',curlen-position);
  329.                 curlen--;
  330.             }
  331.             else if (c == 0x48) { /* Home */
  332.                 rdln_print_c('\b',position);
  333.                 position = 0;
  334.             }
  335.             else if (c == 0x46) {  /* End */
  336.                 for (i=position;i<curlen;i++)
  337.                     putchar(current[i]);
  338.                 position = curlen;
  339.             }
  340.             else if (c == 0x44) { /* Left */
  341.                 if (position > 0) {
  342.                     putchar('\b');
  343.                     position--;
  344.                 }
  345.                 continue;
  346.             }
  347.             else if (c == 0x43) { /* Right */
  348.                 if (position < curlen) {
  349.                     putchar(current[position]);
  350.                     position++;
  351.                 }
  352.                 continue;
  353.             }
  354.             else if (c == 0x41 || c == 0x42) {
  355.                                 /* Up,down */
  356.                 rdln_print_c('\b',position);
  357.                 rdln_print_c(' ',curlen);
  358.                 rdln_print_c('\b',curlen);
  359.                 if (c == 0x41) /* Up */
  360.                     histposition--;
  361.                 else
  362.                     histposition++;
  363.                 if (histposition < 0)
  364.                     histposition = KCONSOLE_HISTORY -1 ;
  365.                 else
  366.                     histposition =  histposition % KCONSOLE_HISTORY;
  367.                 current = history[histposition];
  368.                 printf("%s", current);
  369.                 curlen = strlen(current);
  370.                 position = curlen;
  371.                 continue;
  372.             }
  373.             continue;
  374.         }
  375.         if (curlen >= MAX_CMDLINE)
  376.             continue;
  377.  
  378.         insert_char(current, c, position);
  379.  
  380.         curlen++;
  381.         for (i=position;i<curlen;i++)
  382.             putchar(current[i]);
  383.         position++;
  384.         rdln_print_c('\b',curlen-position);
  385.     }
  386.     if (curlen) {
  387.         histposition++;
  388.         histposition = histposition % KCONSOLE_HISTORY;
  389.     }
  390.     current[curlen] = '\0';
  391.     return current;
  392. }
  393.  
  394. /** Kernel console managing thread.
  395.  *
  396.  * @param arg Not used.
  397.  */
  398. void kconsole(void *prompt)
  399. {
  400.     cmd_info_t *cmd_info;
  401.     count_t len;
  402.     char *cmdline;
  403.  
  404.     if (!stdin) {
  405.         printf("%s: no stdin\n", __FUNCTION__);
  406.         return;
  407.     }
  408.    
  409.     while (true) {
  410.         cmdline = clever_readline(prompt, stdin);
  411.         len = strlen(cmdline);
  412.         if (!len)
  413.             continue;
  414.         cmd_info = parse_cmdline(cmdline, len);
  415.         if (!cmd_info)
  416.             continue;
  417.         if (strncmp(cmd_info->name,"exit", \
  418.                 min(strlen(cmd_info->name),5)) == 0)
  419.             break;
  420.         (void) cmd_info->func(cmd_info->argv);
  421.     }
  422. }
  423.  
  424. static int parse_int_arg(char *text, size_t len, __native *result)
  425. {
  426.     char symname[MAX_SYMBOL_NAME];
  427.     __address symaddr;
  428.     bool isaddr = false;
  429.     bool isptr = false;
  430.    
  431.     /* If we get a name, try to find it in symbol table */
  432.     if (text[0] < '0' || text[0] > '9') {
  433.         if (text[0] == '&') {
  434.             isaddr = true;
  435.             text++;len--;
  436.         } else if (text[0] == '*') {
  437.             isptr = true;
  438.             text++;len--;
  439.         }
  440.         strncpy(symname, text, min(len+1, MAX_SYMBOL_NAME));
  441.         symaddr = get_symbol_addr(symname);
  442.         if (!symaddr) {
  443.             printf("Symbol %s not found.\n",symname);
  444.             return -1;
  445.         }
  446.         if (symaddr == (__address) -1) {
  447.             printf("Duplicate symbol %s.\n",symname);
  448.             symtab_print_search(symname);
  449.             return -1;
  450.         }
  451.         if (isaddr)
  452.             *result = (__native)symaddr;
  453.         else if (isptr)
  454.             *result = **((__native **)symaddr);
  455.         else
  456.             *result = *((__native *)symaddr);
  457.     } else /* It's a number - convert it */
  458.         *result = atoi(text);
  459.     return 0;
  460. }
  461.  
  462. /** Parse command line.
  463.  *
  464.  * @param cmdline Command line as read from input device.
  465.  * @param len Command line length.
  466.  *
  467.  * @return Structure describing the command.
  468.  */
  469. cmd_info_t *parse_cmdline(char *cmdline, size_t len)
  470. {
  471.     index_t start = 0, end = 0;
  472.     cmd_info_t *cmd = NULL;
  473.     link_t *cur;
  474.     ipl_t ipl;
  475.     int i;
  476.    
  477.     if (!parse_argument(cmdline, len, &start, &end)) {
  478.         /* Command line did not contain alphanumeric word. */
  479.         return NULL;
  480.     }
  481.  
  482.     spinlock_lock(&cmd_lock);
  483.    
  484.     for (cur = cmd_head.next; cur != &cmd_head; cur = cur->next) {
  485.         cmd_info_t *hlp;
  486.        
  487.         hlp = list_get_instance(cur, cmd_info_t, link);
  488.         spinlock_lock(&hlp->lock);
  489.        
  490.         if (strncmp(hlp->name, &cmdline[start], strlen(hlp->name)) == 0) {
  491.             cmd = hlp;
  492.             break;
  493.         }
  494.        
  495.         spinlock_unlock(&hlp->lock);
  496.     }
  497.    
  498.     spinlock_unlock(&cmd_lock);
  499.    
  500.     if (!cmd) {
  501.         /* Unknown command. */
  502.         printf("Unknown command.\n");
  503.         return NULL;
  504.     }
  505.  
  506.     /* cmd == hlp is locked */
  507.    
  508.     /*
  509.      * The command line must be further analyzed and
  510.      * the parameters therefrom must be matched and
  511.      * converted to those specified in the cmd info
  512.      * structure.
  513.      */
  514.  
  515.     for (i = 0; i < cmd->argc; i++) {
  516.         char *buf;
  517.         start = end + 1;
  518.         if (!parse_argument(cmdline, len, &start, &end)) {
  519.             printf("Too few arguments.\n");
  520.             spinlock_unlock(&cmd->lock);
  521.             return NULL;
  522.         }
  523.        
  524.         switch (cmd->argv[i].type) {
  525.         case ARG_TYPE_STRING:
  526.                 buf = cmd->argv[i].buffer;
  527.                 strncpy(buf, (const char *) &cmdline[start], min((end - start) + 2, cmd->argv[i].len));
  528.             buf[min((end - start) + 1, cmd->argv[i].len - 1)] = '\0';
  529.             break;
  530.         case ARG_TYPE_INT:
  531.             if (parse_int_arg(cmdline+start, end-start+1,
  532.                       &cmd->argv[i].intval))
  533.                 return NULL;
  534.             break;
  535.         case ARG_TYPE_VAR:
  536.             if (start != end && cmdline[start] == '"' && cmdline[end] == '"') {
  537.                 buf = cmd->argv[i].buffer;
  538.                 strncpy(buf, (const char *) &cmdline[start+1],
  539.                     min((end-start), cmd->argv[i].len));
  540.                 buf[min((end - start), cmd->argv[i].len - 1)] = '\0';
  541.                 cmd->argv[i].intval = (__native) buf;
  542.                 cmd->argv[i].vartype = ARG_TYPE_STRING;
  543.             } else if (!parse_int_arg(cmdline+start, end-start+1,
  544.                          &cmd->argv[i].intval))
  545.                 cmd->argv[i].vartype = ARG_TYPE_INT;
  546.             else {
  547.                 printf("Unrecognized variable argument.\n");
  548.                 return NULL;
  549.             }
  550.             break;
  551.         case ARG_TYPE_INVALID:
  552.         default:
  553.             printf("invalid argument type\n");
  554.             return NULL;
  555.             break;
  556.         }
  557.     }
  558.    
  559.     start = end + 1;
  560.     if (parse_argument(cmdline, len, &start, &end)) {
  561.         printf("Too many arguments.\n");
  562.         spinlock_unlock(&cmd->lock);
  563.         return NULL;
  564.     }
  565.    
  566.     spinlock_unlock(&cmd->lock);
  567.     return cmd;
  568. }
  569.  
  570. /** Parse argument.
  571.  *
  572.  * Find start and end positions of command line argument.
  573.  *
  574.  * @param cmdline Command line as read from the input device.
  575.  * @param len Number of characters in cmdline.
  576.  * @param start On entry, 'start' contains pointer to the index
  577.  *        of first unprocessed character of cmdline.
  578.  *        On successful exit, it marks beginning of the next argument.
  579.  * @param end Undefined on entry. On exit, 'end' points to the last character
  580.  *        of the next argument.
  581.  *
  582.  * @return false on failure, true on success.
  583.  */
  584. bool parse_argument(char *cmdline, size_t len, index_t *start, index_t *end)
  585. {
  586.     int i;
  587.     bool found_start = false;
  588.    
  589.     ASSERT(start != NULL);
  590.     ASSERT(end != NULL);
  591.    
  592.     for (i = *start; i < len; i++) {
  593.         if (!found_start) {
  594.             if (is_white(cmdline[i]))
  595.                 (*start)++;
  596.             else
  597.                 found_start = true;
  598.         } else {
  599.             if (is_white(cmdline[i]))
  600.                 break;
  601.         }
  602.     }
  603.     *end = i - 1;
  604.  
  605.     return found_start;
  606. }
  607.