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 <string.h>
#include <macros.h>
#include <sysinfo/sysinfo.h>
#include <ddi/device.h>
#include <symtab.h>
#include <errno.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
 *
 * This is the most basic initialization, almost no
 * other kernel subsystem is ready yet.
 *
 */
void kconsole_init(void)
{
    unsigned 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*/128 + 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, 128/*MAX_SYMBOL_NAME*/);
    return found;
}
 
static char *clever_readline(const char *prompt, indev_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;
}
 
bool kconsole_check_poll(void)
{
    return check_poll(stdin);
}
 
/** Kernel console prompt.
 *
 * @param prompt Kernel console prompt (e.g kconsole/panic).
 * @param msg    Message to display in the beginning.
 * @param kcon   Wait for keypress to show the prompt
 *               and never exit.
 *
 */
void kconsole(char *prompt, char *msg, bool kcon)
{
    cmd_info_t *cmd_info;
    count_t len;
    char *cmdline;
   
    if (!stdin) {
        LOG("No stdin for kernel console");
        return;
    }
   
    if (msg)
        printf("%s", msg);
   
    if (kcon)
        _getc(stdin);
    else
        printf("Type \"exit\" to leave the console.\n");
   
    while (true) {
        cmdline = clever_readline((char *) prompt, stdin);
        len = strlen(cmdline);
        if (!len)
            continue;
       
        if ((!kcon) && (len == 4) && (strncmp(cmdline, "exit", 4) == 0))
            break;
       
        cmd_info = parse_cmdline(cmdline, len);
        if (!cmd_info)
            continue;
       
        (void) cmd_info->func(cmd_info->argv);
    }
}
 
/** Kernel console managing thread.
 *
 */
void kconsole_thread(void *data)
{
    kconsole("kconsole", "Kernel console ready (press any key to activate)\n", true);
}
 
static int parse_int_arg(char *text, size_t len, unative_t *result)
{
    uintptr_t symaddr;
    bool isaddr = false;
    bool isptr = false;
    int rc;
 
    static char symname[MAX_SYMBOL_NAME];
   
    /* 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));
        rc = symtab_addr_lookup(symname, &symaddr);
        switch (rc) {
        case ENOENT:
            printf("Symbol %s not found.\n", symname);
            return -1;
        case EOVERFLOW:
            printf("Duplicate symbol %s.\n", symname);
            symtab_print_search(symname);
            return -1;
        default:
            printf("No symbol information available.\n");
            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 (isspace(cmdline[i]))
                (*start)++;
            else
                found_start = true;
        } else {
            if (isspace(cmdline[i]))
                break;
        }
    }
    *end = i - 1;
 
    return found_start;
}
 
/** @}
 */
 

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

Subversion Repositories HelenOS

(root)/trunk/kernel/generic/src/console/kconsole.c – Rev 4148 → 4173