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

Subversion Repositories HelenOS

(root)/trunk/kernel/generic/src/console/kconsole.c – Rev 2113 → 2462