WebSVN – HelenOS-historic – Diff – /kernel/trunk/generic/src/console/kconsole.c


/*
 * Copyright (C) 2005 Jakub Jermar
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * - Redistributions of source code must retain the above copyright
 *   notice, this list of conditions and the following disclaimer.
 * - Redistributions in binary form must reproduce the above copyright
 *   notice, this list of conditions and the following disclaimer in the
 *   documentation and/or other materials provided with the distribution.
 * - The name of the author may not be used to endorse or promote products
 *   derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
 
#include <console/kconsole.h>
#include <console/console.h>
#include <console/chardev.h>
#include <console/cmd.h>
#include <print.h>
#include <panic.h>
#include <typedefs.h>
#include <arch/types.h>
#include <list.h>
#include <arch.h>
#include <macros.h>
#include <debug.h>
#include <func.h>
#include <symtab.h>
 
/** Simple kernel console.
 *
 * The console is realized by kernel thread kconsole.
 * It doesn't understand any useful command on its own,
 * but makes it possible for other kernel subsystems to
 * register their own commands.
 */
 
/** Locking.
 *
 * There is a list of cmd_info_t structures. This list
 * is protected by cmd_lock spinlock. Note that specially
 * the link elements of cmd_info_t are protected by
 * this lock.
 *
 * Each cmd_info_t also has its own lock, which protects
 * all elements thereof except the link element.
 *
 * cmd_lock must be acquired before any cmd_info lock.
 * When locking two cmd info structures, structure with
 * lower address must be locked first.
 */
 
spinlock_t cmd_lock;    /**< Lock protecting command list. */
link_t cmd_head;    /**< Command list. */
 
static cmd_info_t *parse_cmdline(char *cmdline, size_t len);
static bool parse_argument(char *cmdline, size_t len, index_t *start, index_t *end);
static char history[KCONSOLE_HISTORY][MAX_CMDLINE] = {};
 
/** Initialize kconsole data structures. */
void kconsole_init(void)
{
    int i;
 
    spinlock_initialize(&cmd_lock, "kconsole_cmd");
    list_initialize(&cmd_head);
 
    cmd_init();
    for (i=0; i<KCONSOLE_HISTORY; i++)
        history[i][0] = '\0';
}
 
 
/** Register kconsole command.
 *
 * @param cmd Structure describing the command.
 *
 * @return 0 on failure, 1 on success.
 */
int cmd_register(cmd_info_t *cmd)
{
    ipl_t ipl;
    link_t *cur;
   
    spinlock_lock(&cmd_lock);
   
    /*
     * Make sure the command is not already listed.
     */
    for (cur = cmd_head.next; cur != &cmd_head; cur = cur->next) {
        cmd_info_t *hlp;
       
        hlp = list_get_instance(cur, cmd_info_t, link);
 
        if (hlp == cmd) {
            /* The command is already there. */
            spinlock_unlock(&cmd_lock);
            return 0;
        }
 
        /* Avoid deadlock. */
        if (hlp < cmd) {
            spinlock_lock(&hlp->lock);
            spinlock_lock(&cmd->lock);
        } else {
            spinlock_lock(&cmd->lock);
            spinlock_lock(&hlp->lock);
        }
       
        if ((strncmp(hlp->name, cmd->name, strlen(cmd->name)) == 0)) {
            /* The command is already there. */
            spinlock_unlock(&hlp->lock);
            spinlock_unlock(&cmd->lock);
            spinlock_unlock(&cmd_lock);
            return 0;
        }
       
        spinlock_unlock(&hlp->lock);
        spinlock_unlock(&cmd->lock);
    }
   
    /*
     * Now the command can be added.
     */
    list_append(&cmd->link, &cmd_head);
   
    spinlock_unlock(&cmd_lock);
    return 1;
}
 
static void rdln_print_c(char ch, int count)
{
    int i;
    for (i=0;i<count;i++)
        putchar(ch);
}
 
static void insert_char(char *str, char ch, int pos)
{
    int i;
   
    for (i=strlen(str);i > pos; i--)
        str[i] = str[i-1];
    str[pos] = ch;
}
 
static const char * cmdtab_search_one(const char *name,link_t **startpos)
{
    int namelen = strlen(name);
    const char *curname;
    char *foundsym = NULL;
    int foundpos = 0;
 
    spinlock_lock(&cmd_lock);
 
    if (!*startpos)
        *startpos = cmd_head.next;
 
    for (;*startpos != &cmd_head;*startpos = (*startpos)->next) {
        cmd_info_t *hlp;
        hlp = list_get_instance(*startpos, cmd_info_t, link);
 
        curname = hlp->name;
        if (strlen(curname) < namelen)
            continue;
        if (strncmp(curname, name, namelen) == 0) {
            spinlock_unlock(&cmd_lock);
            return curname+namelen;
        }
    }
    spinlock_unlock(&cmd_lock);
    return NULL;
}
 
 
/** Command completion of the commands
 *
 * @param name - string to match, changed to hint on exit
 * @return number of found matches
 */
static int cmdtab_compl(char *name)
{
    char output[MAX_SYMBOL_NAME+1];
    link_t *startpos = NULL;
    const char *foundtxt;
    int found = 0;
    int i;
 
    output[0] = '\0';
    while ((foundtxt = cmdtab_search_one(name, &startpos))) {
        startpos = startpos->next;
        if (!found)
            strncpy(output, foundtxt, strlen(foundtxt)+1);
        else {
            for (i=0; output[i] && foundtxt[i] && output[i]==foundtxt[i]; i++)
                ;
            output[i] = '\0';
        }
        found++;
    }
    if (!found)
        return 0;
 
    if (found > 1 && !strlen(output)) {
        printf("\n");
        startpos = NULL;
        while ((foundtxt = cmdtab_search_one(name, &startpos))) {
            cmd_info_t *hlp;
            hlp = list_get_instance(startpos, cmd_info_t, link);
            printf("%s - %s\n", hlp->name, hlp->description);
            startpos = startpos->next;
        }
    }
    strncpy(name, output, MAX_SYMBOL_NAME);
    return found;
   
}
 
static char * clever_readline(const char *prompt, chardev_t *input)
{
    static int histposition = 0;
 
    char tmp[MAX_CMDLINE+1];
    int curlen = 0, position = 0;
    char *current = history[histposition];
    int i;
    char mod; /* Command Modifier */
    char c;
 
    printf("%s> ", prompt);
    while (1) {
        c = _getc(input);
        if (c == '\n') {
            putchar(c);
            break;
        } if (c == '\b') { /* Backspace */
            if (position == 0)
                continue;
            for (i=position; i<curlen;i++)
                current[i-1] = current[i];
            curlen--;
            position--;
            putchar('\b');
            for (i=position;i<curlen;i++)
                putchar(current[i]);
            putchar(' ');
            rdln_print_c('\b',curlen-position+1);
            continue;
        }
        if (c == '\t') { /* Tabulator */
            int found;
 
            /* Move to the end of the word */
            for (;position<curlen && current[position]!=' ';position++)
                putchar(current[position]);
            /* Copy to tmp last word */
            for (i=position-1;i >= 0 && current[i]!=' ' ;i--)
                ;
            /* If word begins with * or &, skip it */
            if (tmp[0] == '*' || tmp[0] == '&')
                for (i=1;tmp[i];i++)
                    tmp[i-1] = tmp[i];
            i++; /* I is at the start of the word */
            strncpy(tmp, current+i, position-i+1);
 
            if (i==0) { /* Command completion */
                found = cmdtab_compl(tmp);
            } else { /* Symtab completion */
                found = symtab_compl(tmp);
            }
 
            if (found == 0)
                continue;
            for (i=0;tmp[i] && curlen < MAX_CMDLINE;i++,curlen++)
                insert_char(current, tmp[i], i+position);
 
            if (strlen(tmp) || found==1) { /* If we have a hint */
                for (i=position;i<curlen;i++)
                    putchar(current[i]);
                position += strlen(tmp);
                /* Add space to end */
                if (found == 1 && position == curlen && \
                    curlen < MAX_CMDLINE) {
                    current[position] = ' ';
                    curlen++;
                    position++;
                    putchar(' ');
                }
            } else { /* No hint, table was printed */
                printf("%s> ", prompt);
                for (i=0; i<curlen;i++)
                    putchar(current[i]);
                position += strlen(tmp);
            }
            rdln_print_c('\b', curlen-position);
            continue;
        }
        if (c == 0x1b) { /* Special command */
            mod = _getc(input);
            c = _getc(input);
 
            if (mod != 0x5b && mod != 0x4f)
                continue;
 
            if (c == 0x33 && _getc(input) == 0x7e) {
                /* Delete */
                if (position == curlen)
                    continue;
                for (i=position+1; i<curlen;i++) {
                    putchar(current[i]);
                    current[i-1] = current[i];
                }
                putchar(' ');
                rdln_print_c('\b',curlen-position);
                curlen--;
            }
            else if (c == 0x48) { /* Home */
                rdln_print_c('\b',position);
                position = 0;
            }
            else if (c == 0x46) {  /* End */
                for (i=position;i<curlen;i++)
                    putchar(current[i]);
                position = curlen;
            }
            else if (c == 0x44) { /* Left */
                if (position > 0) {
                    putchar('\b');
                    position--;
                }
                continue;
            }
            else if (c == 0x43) { /* Right */
                if (position < curlen) {
                    putchar(current[position]);
                    position++;
                }
                continue;
            }
            else if (c == 0x41 || c == 0x42) {
                                /* Up,down */
                rdln_print_c('\b',position);
                rdln_print_c(' ',curlen);
                rdln_print_c('\b',curlen);
                if (c == 0x41) /* Up */
                    histposition--;
                else
                    histposition++;
                if (histposition < 0)
                    histposition = KCONSOLE_HISTORY -1 ;
                else
                    histposition =  histposition % KCONSOLE_HISTORY;
                current = history[histposition];
                printf("%s", current);
                curlen = strlen(current);
                position = curlen;
                continue;
            }
            continue;
        }
        if (curlen >= MAX_CMDLINE)
            continue;
 
        insert_char(current, c, position);
 
        curlen++;
        for (i=position;i<curlen;i++)
            putchar(current[i]);
        position++;
        rdln_print_c('\b',curlen-position);
    }
    if (curlen) {
        histposition++;
        histposition = histposition % KCONSOLE_HISTORY;
    }
    current[curlen] = '\0';
    return current;
}
 
/** Kernel console managing thread.
 *
 * @param arg Not used.
 */
void kconsole(void *arg)
{
    cmd_info_t *cmd_info;
    count_t len;
    char *cmdline;
 
    if (!stdin) {
        printf("%s: no stdin\n", __FUNCTION__);
        return;
    }
   
    while (true) {
        cmdline = clever_readline(__FUNCTION__, stdin);
        len = strlen(cmdline);
        if (!len)
            continue;
        cmd_info = parse_cmdline(cmdline, len);
        if (!cmd_info)
            continue;
        (void) cmd_info->func(cmd_info->argv);
    }
}
 
static int parse_int_arg(char *text, size_t len, __native *result)
{
    char symname[MAX_SYMBOL_NAME];
    __address symaddr;
    bool isaddr = false;
    bool isptr = false;
   
    /* If we get a name, try to find it in symbol table */
    if (text[0] < '0' | text[0] > '9') {
        if (text[0] == '&') {
            isaddr = true;
            text++;len--;
        } else if (text[0] == '*') {
            isptr = true;
            text++;len--;
        }
        strncpy(symname, text, min(len+1, MAX_SYMBOL_NAME));
        symaddr = get_symbol_addr(symname);
        if (!symaddr) {
            printf("Symbol %s not found.\n",symname);
            return -1;
        }
        if (symaddr == (__address) -1) {
            printf("Duplicate symbol %s.\n",symname);
            symtab_print_search(symname);
            return -1;
        }
        if (isaddr)
            *result = (__native)symaddr;
        else if (isptr)
            *result = **((__native **)symaddr);
        else
            *result = *((__native *)symaddr);
    } else /* It's a number - convert it */
        *result = atoi(text);
    return 0;
}
 
/** Parse command line.
 *
 * @param cmdline Command line as read from input device.
 * @param len Command line length.
 *
 * @return Structure describing the command.
 */
cmd_info_t *parse_cmdline(char *cmdline, size_t len)
{
    index_t start = 0, end = 0;
    cmd_info_t *cmd = NULL;
    link_t *cur;
    ipl_t ipl;
    int i;
   
    if (!parse_argument(cmdline, len, &start, &end)) {
        /* Command line did not contain alphanumeric word. */
        return NULL;
    }
 
    spinlock_lock(&cmd_lock);
   
    for (cur = cmd_head.next; cur != &cmd_head; cur = cur->next) {
        cmd_info_t *hlp;
       
        hlp = list_get_instance(cur, cmd_info_t, link);
        spinlock_lock(&hlp->lock);
       
        if (strncmp(hlp->name, &cmdline[start], (end - start) + 1) == 0) {
            cmd = hlp;
            break;
        }
       
        spinlock_unlock(&hlp->lock);
    }
   
    spinlock_unlock(&cmd_lock);
   
    if (!cmd) {
        /* Unknown command. */
        printf("Unknown command.\n");
        return NULL;
    }
 
    /* cmd == hlp is locked */
   
    /*
     * The command line must be further analyzed and
     * the parameters therefrom must be matched and
     * converted to those specified in the cmd info
     * structure.
     */
 
    for (i = 0; i < cmd->argc; i++) {
        char *buf;
        start = end + 1;
        if (!parse_argument(cmdline, len, &start, &end)) {
            printf("Too few arguments.\n");
            spinlock_unlock(&cmd->lock);
            return NULL;
        }
       
        switch (cmd->argv[i].type) {
        case ARG_TYPE_STRING:
                buf = cmd->argv[i].buffer;
                strncpy(buf, (const char *) &cmdline[start], min((end - start) + 2, cmd->argv[i].len));
            buf[min((end - start) + 1, cmd->argv[i].len - 1)] = '\0';
            break;
        case ARG_TYPE_INT:
            if (parse_int_arg(cmdline+start, end-start+1,
                      &cmd->argv[i].intval))
                return NULL;
            break;
        case ARG_TYPE_VAR:
            if (start != end && cmdline[start] == '"' && cmdline[end] == '"') {
                buf = cmd->argv[i].buffer;
                strncpy(buf, (const char *) &cmdline[start+1],
                    min((end-start), cmd->argv[i].len));
                buf[min((end - start), cmd->argv[i].len - 1)] = '\0';
                cmd->argv[i].intval = (__native) buf;
                cmd->argv[i].vartype = ARG_TYPE_STRING;
            } else if (!parse_int_arg(cmdline+start, end-start+1,
                         &cmd->argv[i].intval))
                cmd->argv[i].vartype = ARG_TYPE_INT;
            else {
                printf("Unrecognized variable argument.\n");
                return NULL;
            }
            break;
        case ARG_TYPE_INVALID:
        default:
            printf("invalid argument type\n");
            return NULL;
            break;
        }
    }
   
    start = end + 1;
    if (parse_argument(cmdline, len, &start, &end)) {
        printf("Too many arguments.\n");
        spinlock_unlock(&cmd->lock);
        return NULL;
    }
   
    spinlock_unlock(&cmd->lock);
    return cmd;
}
 
/** Parse argument.
 *
 * Find start and end positions of command line argument.
 *
 * @param cmdline Command line as read from the input device.
 * @param len Number of characters in cmdline.
 * @param start On entry, 'start' contains pointer to the index
 *        of first unprocessed character of cmdline.
 *        On successful exit, it marks beginning of the next argument.
 * @param end Undefined on entry. On exit, 'end' points to the last character
 *        of the next argument.
 *
 * @return false on failure, true on success.
 */
bool parse_argument(char *cmdline, size_t len, index_t *start, index_t *end)
{
    int i;
    bool found_start = false;
   
    ASSERT(start != NULL);
    ASSERT(end != NULL);
   
    for (i = *start; i < len; i++) {
        if (!found_start) {
            if (is_white(cmdline[i]))
                (*start)++;
            else
                found_start = true;
        } else {
            if (is_white(cmdline[i]))
                break;
        }
    }
    *end = i - 1;
 
    return found_start;
}
 

Rev 606	Rev 607
1	/*	1	/*
2	* Copyright (C) 2005 Jakub Jermar	2	* Copyright (C) 2005 Jakub Jermar
3	* All rights reserved.	3	* All rights reserved.
4	*	4	*
5	* Redistribution and use in source and binary forms, with or without	5	* Redistribution and use in source and binary forms, with or without
6	* modification, are permitted provided that the following conditions	6	* modification, are permitted provided that the following conditions
7	* are met:	7	* are met:
8	*	8	*
9	* - Redistributions of source code must retain the above copyright	9	* - Redistributions of source code must retain the above copyright
10	* notice, this list of conditions and the following disclaimer.	10	* notice, this list of conditions and the following disclaimer.
11	* - Redistributions in binary form must reproduce the above copyright	11	* - Redistributions in binary form must reproduce the above copyright
12	* notice, this list of conditions and the following disclaimer in the	12	* notice, this list of conditions and the following disclaimer in the
13	* documentation and/or other materials provided with the distribution.	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	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.	15	* derived from this software without specific prior written permission.
16	*	16	*
17	* THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR	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	18	* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19	* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.	19	* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20	* IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,	20	* IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21	* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT	21	* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22	* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,	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	23	* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24	* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT	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	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.	26	* THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27	*/	27	*/
28		28
29	#include <console/kconsole.h>	29	#include <console/kconsole.h>
30	#include <console/console.h>	30	#include <console/console.h>
31	#include <console/chardev.h>	31	#include <console/chardev.h>
32	#include <console/cmd.h>	32	#include <console/cmd.h>
33	#include <print.h>	33	#include <print.h>
34	#include <panic.h>	34	#include <panic.h>
35	#include <typedefs.h>	35	#include <typedefs.h>
36	#include <arch/types.h>	36	#include <arch/types.h>
37	#include <list.h>	37	#include <list.h>
38	#include <arch.h>	38	#include <arch.h>
39	#include <macros.h>	39	#include <macros.h>
40	#include <debug.h>	40	#include <debug.h>
41	#include <func.h>	41	#include <func.h>
42	#include <symtab.h>	42	#include <symtab.h>
43		43
44	/** Simple kernel console.	44	/** Simple kernel console.
45	*	45	*
46	* The console is realized by kernel thread kconsole.	46	* The console is realized by kernel thread kconsole.
47	* It doesn't understand any useful command on its own,	47	* It doesn't understand any useful command on its own,
48	* but makes it possible for other kernel subsystems to	48	* but makes it possible for other kernel subsystems to
49	* register their own commands.	49	* register their own commands.
50	*/	50	*/
51		51
52	/** Locking.	52	/** Locking.
53	*	53	*
54	* There is a list of cmd_info_t structures. This list	54	* There is a list of cmd_info_t structures. This list
55	* is protected by cmd_lock spinlock. Note that specially	55	* is protected by cmd_lock spinlock. Note that specially
56	* the link elements of cmd_info_t are protected by	56	* the link elements of cmd_info_t are protected by
57	* this lock.	57	* this lock.
58	*	58	*
59	* Each cmd_info_t also has its own lock, which protects	59	* Each cmd_info_t also has its own lock, which protects
60	* all elements thereof except the link element.	60	* all elements thereof except the link element.
61	*	61	*
62	* cmd_lock must be acquired before any cmd_info lock.	62	* cmd_lock must be acquired before any cmd_info lock.
63	* When locking two cmd info structures, structure with	63	* When locking two cmd info structures, structure with
64	* lower address must be locked first.	64	* lower address must be locked first.
65	*/	65	*/
66		66
67	spinlock_t cmd_lock; /*< Lock protecting command list. /	67	spinlock_t cmd_lock; /*< Lock protecting command list. /
68	link_t cmd_head; /*< Command list. /	68	link_t cmd_head; /*< Command list. /
69		69
70	static cmd_info_t parse_cmdline(char cmdline, size_t len);	70	static cmd_info_t parse_cmdline(char cmdline, size_t len);
71	static bool parse_argument(char cmdline, size_t len, index_t start, index_t *end);	71	static bool parse_argument(char cmdline, size_t len, index_t start, index_t *end);
72	static char history[KCONSOLE_HISTORY][MAX_CMDLINE] = {};	72	static char history[KCONSOLE_HISTORY][MAX_CMDLINE] = {};
73		73
74	/** Initialize kconsole data structures. */	74	/** Initialize kconsole data structures. */
75	void kconsole_init(void)	75	void kconsole_init(void)
76	{	76	{
77	int i;	77	int i;
78		78
79	spinlock_initialize(&cmd_lock, "kconsole_cmd");	79	spinlock_initialize(&cmd_lock, "kconsole_cmd");
80	list_initialize(&cmd_head);	80	list_initialize(&cmd_head);
81		81
82	cmd_init();	82	cmd_init();
83	for (i=0; i<KCONSOLE_HISTORY; i++)	83	for (i=0; i<KCONSOLE_HISTORY; i++)
84	history[i][0] = '\0';	84	history[i][0] = '\0';
85	}	85	}
86		86
87		87
88	/** Register kconsole command.	88	/** Register kconsole command.
89	*	89	*
90	* @param cmd Structure describing the command.	90	* @param cmd Structure describing the command.
91	*	91	*
92	* @return 0 on failure, 1 on success.	92	* @return 0 on failure, 1 on success.
93	*/	93	*/
94	int cmd_register(cmd_info_t *cmd)	94	int cmd_register(cmd_info_t *cmd)
95	{	95	{
96	ipl_t ipl;	96	ipl_t ipl;
97	link_t *cur;	97	link_t *cur;
98		98
99	spinlock_lock(&cmd_lock);	99	spinlock_lock(&cmd_lock);
100		100
101	/*	101	/*
102	* Make sure the command is not already listed.	102	* Make sure the command is not already listed.
103	*/	103	*/
104	for (cur = cmd_head.next; cur != &cmd_head; cur = cur->next) {	104	for (cur = cmd_head.next; cur != &cmd_head; cur = cur->next) {
105	cmd_info_t *hlp;	105	cmd_info_t *hlp;
106		106
107	hlp = list_get_instance(cur, cmd_info_t, link);	107	hlp = list_get_instance(cur, cmd_info_t, link);
108		108
109	if (hlp == cmd) {	109	if (hlp == cmd) {
110	/* The command is already there. */	110	/* The command is already there. */
111	spinlock_unlock(&cmd_lock);	111	spinlock_unlock(&cmd_lock);
112	return 0;	112	return 0;
113	}	113	}
114		114
115	/* Avoid deadlock. */	115	/* Avoid deadlock. */
116	if (hlp < cmd) {	116	if (hlp < cmd) {
117	spinlock_lock(&hlp->lock);	117	spinlock_lock(&hlp->lock);
118	spinlock_lock(&cmd->lock);	118	spinlock_lock(&cmd->lock);
119	} else {	119	} else {
120	spinlock_lock(&cmd->lock);	120	spinlock_lock(&cmd->lock);
121	spinlock_lock(&hlp->lock);	121	spinlock_lock(&hlp->lock);
122	}	122	}
123		123
124	if ((strncmp(hlp->name, cmd->name, strlen(cmd->name)) == 0)) {	124	if ((strncmp(hlp->name, cmd->name, strlen(cmd->name)) == 0)) {
125	/* The command is already there. */	125	/* The command is already there. */
126	spinlock_unlock(&hlp->lock);	126	spinlock_unlock(&hlp->lock);
127	spinlock_unlock(&cmd->lock);	127	spinlock_unlock(&cmd->lock);
128	spinlock_unlock(&cmd_lock);	128	spinlock_unlock(&cmd_lock);
129	return 0;	129	return 0;
130	}	130	}
131		131
132	spinlock_unlock(&hlp->lock);	132	spinlock_unlock(&hlp->lock);
133	spinlock_unlock(&cmd->lock);	133	spinlock_unlock(&cmd->lock);
134	}	134	}
135		135
136	/*	136	/*
137	* Now the command can be added.	137	* Now the command can be added.
138	*/	138	*/
139	list_append(&cmd->link, &cmd_head);	139	list_append(&cmd->link, &cmd_head);
140		140
141	spinlock_unlock(&cmd_lock);	141	spinlock_unlock(&cmd_lock);
142	return 1;	142	return 1;
143	}	143	}
144		144
145	static void rdln_print_c(char ch, int count)	145	static void rdln_print_c(char ch, int count)
146	{	146	{
147	int i;	147	int i;
148	for (i=0;i<count;i++)	148	for (i=0;i<count;i++)
149	putchar(ch);	149	putchar(ch);
150	}	150	}
151		151
152	static void insert_char(char *str, char ch, int pos)	152	static void insert_char(char *str, char ch, int pos)
153	{	153	{
154	int i;	154	int i;
155		155
156	for (i=strlen(str);i > pos; i--)	156	for (i=strlen(str);i > pos; i--)
157	str[i] = str[i-1];	157	str[i] = str[i-1];
158	str[pos] = ch;	158	str[pos] = ch;
159	}	159	}
160		160
161	static const char * cmdtab_search_one(const char name,link_t *startpos)	161	static const char * cmdtab_search_one(const char name,link_t *startpos)
162	{	162	{
163	int namelen = strlen(name);	163	int namelen = strlen(name);
164	const char *curname;	164	const char *curname;
165	char *foundsym = NULL;	165	char *foundsym = NULL;
166	int foundpos = 0;	166	int foundpos = 0;
167		167
168	spinlock_lock(&cmd_lock);	168	spinlock_lock(&cmd_lock);
169		169
170	if (!*startpos)	170	if (!*startpos)
171	*startpos = cmd_head.next;	171	*startpos = cmd_head.next;
172		172
173	for (;startpos != &cmd_head;startpos = (*startpos)->next) {	173	for (;startpos != &cmd_head;startpos = (*startpos)->next) {
174	cmd_info_t *hlp;	174	cmd_info_t *hlp;
175	hlp = list_get_instance(*startpos, cmd_info_t, link);	175	hlp = list_get_instance(*startpos, cmd_info_t, link);
176		176
177	curname = hlp->name;	177	curname = hlp->name;
178	if (strlen(curname) < namelen)	178	if (strlen(curname) < namelen)
179	continue;	179	continue;
180	if (strncmp(curname, name, namelen) == 0) {	180	if (strncmp(curname, name, namelen) == 0) {
181	spinlock_unlock(&cmd_lock);	181	spinlock_unlock(&cmd_lock);
182	return curname+namelen;	182	return curname+namelen;
183	}	183	}
184	}	184	}
185	spinlock_unlock(&cmd_lock);	185	spinlock_unlock(&cmd_lock);
186	return NULL;	186	return NULL;
187	}	187	}
188		188
189		189
190	/** Command completion of the commands	190	/** Command completion of the commands
191	*	191	*
192	* @param name - string to match, changed to hint on exit	192	* @param name - string to match, changed to hint on exit
193	* @return number of found matches	193	* @return number of found matches
194	*/	194	*/
195	static int cmdtab_compl(char *name)	195	static int cmdtab_compl(char *name)
196	{	196	{
197	char output[MAX_SYMBOL_NAME+1];	197	char output[MAX_SYMBOL_NAME+1];
198	link_t *startpos = NULL;	198	link_t *startpos = NULL;
199	const char *foundtxt;	199	const char *foundtxt;
200	int found = 0;	200	int found = 0;
201	int i;	201	int i;
202		202
203	output[0] = '\0';	203	output[0] = '\0';
204	while ((foundtxt = cmdtab_search_one(name, &startpos))) {	204	while ((foundtxt = cmdtab_search_one(name, &startpos))) {
205	startpos = startpos->next;	205	startpos = startpos->next;
206	if (!found)	206	if (!found)
207	strncpy(output, foundtxt, strlen(foundtxt)+1);	207	strncpy(output, foundtxt, strlen(foundtxt)+1);
208	else {	208	else {
209	for (i=0; output[i] && foundtxt[i] && output[i]==foundtxt[i]; i++)	209	for (i=0; output[i] && foundtxt[i] && output[i]==foundtxt[i]; i++)
210	;	210	;
211	output[i] = '\0';	211	output[i] = '\0';
212	}	212	}
213	found++;	213	found++;
214	}	214	}
215	if (!found)	215	if (!found)
216	return 0;	216	return 0;
217		217
218	if (found > 1 && !strlen(output)) {	218	if (found > 1 && !strlen(output)) {
219	printf("\n");	219	printf("\n");
220	startpos = NULL;	220	startpos = NULL;
221	while ((foundtxt = cmdtab_search_one(name, &startpos))) {	221	while ((foundtxt = cmdtab_search_one(name, &startpos))) {
222	cmd_info_t *hlp;	222	cmd_info_t *hlp;
223	hlp = list_get_instance(startpos, cmd_info_t, link);	223	hlp = list_get_instance(startpos, cmd_info_t, link);
224	printf("%s - %s\n", hlp->name, hlp->description);	224	printf("%s - %s\n", hlp->name, hlp->description);
225	startpos = startpos->next;	225	startpos = startpos->next;
226	}	226	}
227	}	227	}
228	strncpy(name, output, MAX_SYMBOL_NAME);	228	strncpy(name, output, MAX_SYMBOL_NAME);
229	return found;	229	return found;
230		230
231	}	231	}
232		232
233	static char * clever_readline(const char prompt, chardev_t input)	233	static char * clever_readline(const char prompt, chardev_t input)
234	{	234	{
235	static int histposition = 0;	235	static int histposition = 0;
236		236
237	char tmp[MAX_CMDLINE+1];	237	char tmp[MAX_CMDLINE+1];
238	int curlen = 0, position = 0;	238	int curlen = 0, position = 0;
239	char *current = history[histposition];	239	char *current = history[histposition];
240	int i;	240	int i;
241	char mod; /* Command Modifier */	241	char mod; /* Command Modifier */
242	char c;	242	char c;
243		243
244	printf("%s> ", prompt);	244	printf("%s> ", prompt);
245	while (1) {	245	while (1) {
246	c = _getc(input);	246	c = _getc(input);
247	if (c == '\n') {	247	if (c == '\n') {
248	putchar(c);	248	putchar(c);
249	break;	249	break;
250	} if (c == '\b') {	250	} if (c == '\b') { /* Backspace */
251	if (position == 0)	251	if (position == 0)
252	continue;	252	continue;
253	for (i=position; i<curlen;i++)	253	for (i=position; i<curlen;i++)
254	current[i-1] = current[i];	254	current[i-1] = current[i];
255	curlen--;	255	curlen--;
256	position--;	256	position--;
257	putchar('\b');	257	putchar('\b');
258	for (i=position;i<curlen;i++)	258	for (i=position;i<curlen;i++)
259	putchar(current[i]);	259	putchar(current[i]);
260	putchar(' ');	260	putchar(' ');
261	rdln_print_c('\b',curlen-position+1);	261	rdln_print_c('\b',curlen-position+1);
262	continue;	262	continue;
263	}	263	}
264	if (c == '\t') {	264	if (c == '\t') { /* Tabulator */
265	int found;	265	int found;
266		266
267	/* Move to the end of the word */	267	/* Move to the end of the word */
268	for (;position<curlen && current[position]!=' ';position++)	268	for (;position<curlen && current[position]!=' ';position++)
269	putchar(current[position]);	269	putchar(current[position]);
270	/* Copy to tmp last word */	270	/* Copy to tmp last word */
271	for (i=position-1;i >= 0 && current[i]!=' ' ;i--)	271	for (i=position-1;i >= 0 && current[i]!=' ' ;i--)
272	;	272	;
273	/* If word begins with * or &, skip it */	273	/* If word begins with * or &, skip it */
274	if (tmp[0] == '*' \|\| tmp[0] == '&')	274	if (tmp[0] == '*' \|\| tmp[0] == '&')
275	for (i=1;tmp[i];i++)	275	for (i=1;tmp[i];i++)
276	tmp[i-1] = tmp[i];	276	tmp[i-1] = tmp[i];
277	i++; /* I is at the start of the word */	277	i++; /* I is at the start of the word */
278	strncpy(tmp, current+i, position-i+1);	278	strncpy(tmp, current+i, position-i+1);
279		279
280	if (i==0) { /* Command completion */	280	if (i==0) { /* Command completion */
281	found = cmdtab_compl(tmp);	281	found = cmdtab_compl(tmp);
282	} else { /* Symtab completion */	282	} else { /* Symtab completion */
283	found = symtab_compl(tmp);	283	found = symtab_compl(tmp);
284	}	284	}
285		285
286	if (found == 0)	286	if (found == 0)
287	continue;	287	continue;
288	for (i=0;tmp[i] && curlen < MAX_CMDLINE;i++,curlen++)	288	for (i=0;tmp[i] && curlen < MAX_CMDLINE;i++,curlen++)
289	insert_char(current, tmp[i], i+position);	289	insert_char(current, tmp[i], i+position);
290		290
291	if (strlen(tmp) \|\| found==1) { /* If we have a hint */	291	if (strlen(tmp) \|\| found==1) { /* If we have a hint */
292	for (i=position;i<curlen;i++)	292	for (i=position;i<curlen;i++)
293	putchar(current[i]);	293	putchar(current[i]);
294	position += strlen(tmp);	294	position += strlen(tmp);
295	/* Add space to end */	295	/* Add space to end */
296	if (found == 1 && position == curlen && \	296	if (found == 1 && position == curlen && \
297	curlen < MAX_CMDLINE) {	297	curlen < MAX_CMDLINE) {
298	current[position] = ' ';	298	current[position] = ' ';
299	curlen++;	299	curlen++;
300	position++;	300	position++;
301	putchar(' ');	301	putchar(' ');
302	}	302	}
303	} else { /* No hint, table was printed */	303	} else { /* No hint, table was printed */
304	printf("%s> ", prompt);	304	printf("%s> ", prompt);
305	for (i=0; i<curlen;i++)	305	for (i=0; i<curlen;i++)
306	putchar(current[i]);	306	putchar(current[i]);
307	position += strlen(tmp);	307	position += strlen(tmp);
308	}	308	}
309	rdln_print_c('\b', curlen-position);	309	rdln_print_c('\b', curlen-position);
310	continue;	310	continue;
311	}	311	}
312	if (c == 0x1b) {	312	if (c == 0x1b) { /* Special command */
313	mod = _getc(input);	313	mod = _getc(input);
314	c = _getc(input);	314	c = _getc(input);
315		315
316	if (mod != 0x5b && mod != 0x4f)	316	if (mod != 0x5b && mod != 0x4f)
317	continue;	317	continue;
318		318
319	if (c == 0x33 && _getc(input) == 0x7e) {	319	if (c == 0x33 && _getc(input) == 0x7e) {
-		320	/* Delete */
320	if (position == curlen)	321	if (position == curlen)
321	continue;	322	continue;
322	for (i=position+1; i<curlen;i++) {	323	for (i=position+1; i<curlen;i++) {
323	putchar(current[i]);	324	putchar(current[i]);
324	current[i-1] = current[i];	325	current[i-1] = current[i];
325	}	326	}
326	putchar(' ');	327	putchar(' ');
327	rdln_print_c('\b',curlen-position);	328	rdln_print_c('\b',curlen-position);
328	curlen--;	329	curlen--;
329	}	330	}
330	else if (c == 0x48) { /* Home */	331	else if (c == 0x48) { /* Home */
331	rdln_print_c('\b',position);	332	rdln_print_c('\b',position);
332	position = 0;	333	position = 0;
333	}	334	}
334	else if (c == 0x46) {	335	else if (c == 0x46) { /* End */
335	for (i=position;i<curlen;i++)	336	for (i=position;i<curlen;i++)
336	putchar(current[i]);	337	putchar(current[i]);
337	position = curlen;	338	position = curlen;
338	}	339	}
339	else if (c == 0x44) { /* Left */	340	else if (c == 0x44) { /* Left */
340	if (position > 0) {	341	if (position > 0) {
341	putchar('\b');	342	putchar('\b');
342	position--;	343	position--;
343	}	344	}
344	continue;	345	continue;
345	}	346	}
346	else if (c == 0x43) { /* Right */	347	else if (c == 0x43) { /* Right */
347	if (position < curlen) {	348	if (position < curlen) {
348	putchar(current[position]);	349	putchar(current[position]);
349	position++;	350	position++;
350	}	351	}
351	continue;	352	continue;
352	}	353	}
353	else if (c == 0x41 \|\| c == 0x42) {	354	else if (c == 0x41 \|\| c == 0x42) {
354	/* Up,down */	355	/* Up,down */
355	rdln_print_c('\b',position);	356	rdln_print_c('\b',position);
356	rdln_print_c(' ',curlen);	357	rdln_print_c(' ',curlen);
357	rdln_print_c('\b',curlen);	358	rdln_print_c('\b',curlen);
358	if (c == 0x41)	359	if (c == 0x41) /* Up */
359	histposition--;	360	histposition--;
360	else	361	else
361	histposition++;	362	histposition++;
362	if (histposition < 0)	363	if (histposition < 0)
363	histposition = KCONSOLE_HISTORY -1 ;	364	histposition = KCONSOLE_HISTORY -1 ;
364	else	365	else
365	histposition = histposition % KCONSOLE_HISTORY;	366	histposition = histposition % KCONSOLE_HISTORY;
366	current = history[histposition];	367	current = history[histposition];
367	printf("%s", current);	368	printf("%s", current);
368	curlen = strlen(current);	369	curlen = strlen(current);
369	position = curlen;	370	position = curlen;
370	continue;	371	continue;
371	}	372	}
372	continue;	373	continue;
373	}	374	}
374	if (curlen >= MAX_CMDLINE)	375	if (curlen >= MAX_CMDLINE)
375	continue;	376	continue;
376		377
377	insert_char(current, c, position);	378	insert_char(current, c, position);
378		379
379	curlen++;	380	curlen++;
380	for (i=position;i<curlen;i++)	381	for (i=position;i<curlen;i++)
381	putchar(current[i]);	382	putchar(current[i]);
382	position++;	383	position++;
383	rdln_print_c('\b',curlen-position);	384	rdln_print_c('\b',curlen-position);
384	}	385	}
385	if (curlen) {	386	if (curlen) {
386	histposition++;	387	histposition++;
387	histposition = histposition % KCONSOLE_HISTORY;	388	histposition = histposition % KCONSOLE_HISTORY;
388	}	389	}
389	current[curlen] = '\0';	390	current[curlen] = '\0';
390	return current;	391	return current;
391	}	392	}
392		393
393	/** Kernel console managing thread.	394	/** Kernel console managing thread.
394	*	395	*
395	* @param arg Not used.	396	* @param arg Not used.
396	*/	397	*/
397	void kconsole(void *arg)	398	void kconsole(void *arg)
398	{	399	{
399	cmd_info_t *cmd_info;	400	cmd_info_t *cmd_info;
400	count_t len;	401	count_t len;
401	char *cmdline;	402	char *cmdline;
402		403
403	if (!stdin) {	404	if (!stdin) {
404	printf("%s: no stdin\n", __FUNCTION__);	405	printf("%s: no stdin\n", __FUNCTION__);
405	return;	406	return;
406	}	407	}
407		408
408	while (true) {	409	while (true) {
409	cmdline = clever_readline(__FUNCTION__, stdin);	410	cmdline = clever_readline(__FUNCTION__, stdin);
410	len = strlen(cmdline);	411	len = strlen(cmdline);
411	if (!len)	412	if (!len)
412	continue;	413	continue;
413	cmd_info = parse_cmdline(cmdline, len);	414	cmd_info = parse_cmdline(cmdline, len);
414	if (!cmd_info)	415	if (!cmd_info)
415	continue;	416	continue;
416	(void) cmd_info->func(cmd_info->argv);	417	(void) cmd_info->func(cmd_info->argv);
417	}	418	}
418	}	419	}
419		420
420	static int parse_int_arg(char text, size_t len, __native result)	421	static int parse_int_arg(char text, size_t len, __native result)
421	{	422	{
422	char symname[MAX_SYMBOL_NAME];	423	char symname[MAX_SYMBOL_NAME];
423	__address symaddr;	424	__address symaddr;
424	bool isaddr = false;	425	bool isaddr = false;
425	bool isptr = false;	426	bool isptr = false;
426		427
427	/* If we get a name, try to find it in symbol table */	428	/* If we get a name, try to find it in symbol table */
428	if (text[0] < '0' \| text[0] > '9') {	429	if (text[0] < '0' \| text[0] > '9') {
429	if (text[0] == '&') {	430	if (text[0] == '&') {
430	isaddr = true;	431	isaddr = true;
431	text++;len--;	432	text++;len--;
432	} else if (text[0] == '*') {	433	} else if (text[0] == '*') {
433	isptr = true;	434	isptr = true;
434	text++;len--;	435	text++;len--;
435	}	436	}
436	strncpy(symname, text, min(len+1, MAX_SYMBOL_NAME));	437	strncpy(symname, text, min(len+1, MAX_SYMBOL_NAME));
437	symaddr = get_symbol_addr(symname);	438	symaddr = get_symbol_addr(symname);
438	if (!symaddr) {	439	if (!symaddr) {
439	printf("Symbol %s not found.\n",symname);	440	printf("Symbol %s not found.\n",symname);
440	return -1;	441	return -1;
441	}	442	}
442	if (symaddr == (__address) -1) {	443	if (symaddr == (__address) -1) {
443	printf("Duplicate symbol %s.\n",symname);	444	printf("Duplicate symbol %s.\n",symname);
444	symtab_print_search(symname);	445	symtab_print_search(symname);
445	return -1;	446	return -1;
446	}	447	}
447	if (isaddr)	448	if (isaddr)
448	*result = (__native)symaddr;	449	*result = (__native)symaddr;
449	else if (isptr)	450	else if (isptr)
450	result = ((__native *)symaddr);	451	result = ((__native *)symaddr);
451	else	452	else
452	result = ((__native *)symaddr);	453	result = ((__native *)symaddr);
453	} else /* It's a number - convert it */	454	} else /* It's a number - convert it */
454	*result = atoi(text);	455	*result = atoi(text);
455	return 0;	456	return 0;
456	}	457	}
457		458
458	/** Parse command line.	459	/** Parse command line.
459	*	460	*
460	* @param cmdline Command line as read from input device.	461	* @param cmdline Command line as read from input device.
461	* @param len Command line length.	462	* @param len Command line length.
462	*	463	*
463	* @return Structure describing the command.	464	* @return Structure describing the command.
464	*/	465	*/
465	cmd_info_t parse_cmdline(char cmdline, size_t len)	466	cmd_info_t parse_cmdline(char cmdline, size_t len)
466	{	467	{
467	index_t start = 0, end = 0;	468	index_t start = 0, end = 0;
468	cmd_info_t *cmd = NULL;	469	cmd_info_t *cmd = NULL;
469	link_t *cur;	470	link_t *cur;
470	ipl_t ipl;	471	ipl_t ipl;
471	int i;	472	int i;
472		473
473	if (!parse_argument(cmdline, len, &start, &end)) {	474	if (!parse_argument(cmdline, len, &start, &end)) {
474	/* Command line did not contain alphanumeric word. */	475	/* Command line did not contain alphanumeric word. */
475	return NULL;	476	return NULL;
476	}	477	}
477		478
478	spinlock_lock(&cmd_lock);	479	spinlock_lock(&cmd_lock);
479		480
480	for (cur = cmd_head.next; cur != &cmd_head; cur = cur->next) {	481	for (cur = cmd_head.next; cur != &cmd_head; cur = cur->next) {
481	cmd_info_t *hlp;	482	cmd_info_t *hlp;
482		483
483	hlp = list_get_instance(cur, cmd_info_t, link);	484	hlp = list_get_instance(cur, cmd_info_t, link);
484	spinlock_lock(&hlp->lock);	485	spinlock_lock(&hlp->lock);
485		486
486	if (strncmp(hlp->name, &cmdline[start], (end - start) + 1) == 0) {	487	if (strncmp(hlp->name, &cmdline[start], (end - start) + 1) == 0) {
487	cmd = hlp;	488	cmd = hlp;
488	break;	489	break;
489	}	490	}
490		491
491	spinlock_unlock(&hlp->lock);	492	spinlock_unlock(&hlp->lock);
492	}	493	}
493		494
494	spinlock_unlock(&cmd_lock);	495	spinlock_unlock(&cmd_lock);
495		496
496	if (!cmd) {	497	if (!cmd) {
497	/* Unknown command. */	498	/* Unknown command. */
498	printf("Unknown command.\n");	499	printf("Unknown command.\n");
499	return NULL;	500	return NULL;

Subversion Repositories HelenOS-historic

(root)/kernel/trunk/generic/src/console/kconsole.c – Rev 606 → 607