Subversion Repositories HelenOS

/*

 * 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    cmd.c

 * @brief   Kernel console command wrappers.

 *

 * This file is meant to contain all wrapper functions for

 * all kconsole commands. The point is in separating

 * kconsole specific wrappers from kconsole-unaware functions

 * from other subsystems.

 */

#include <console/cmd.h>

#include <console/console.h>

#include <console/kconsole.h>

#include <print.h>

#include <panic.h>

#include <arch/types.h>

#include <adt/list.h>

#include <arch.h>

#include <config.h>

#include <func.h>

#include <string.h>

#include <macros.h>

#include <debug.h>

#include <symtab.h>

#include <cpu.h>

#include <mm/tlb.h>

#include <arch/mm/tlb.h>

#include <mm/frame.h>

#include <main/version.h>

#include <mm/slab.h>

#include <proc/scheduler.h>

#include <proc/thread.h>

#include <proc/task.h>

#include <ipc/ipc.h>

#include <ipc/irq.h>

#ifdef CONFIG_TEST

#include <test.h>

#endif

/* Data and methods for 'help' command. */

static int cmd_help(cmd_arg_t *argv);

static cmd_info_t help_info = {

    .name = "help",

    .description = "List of supported commands.",

    .func = cmd_help,

    .argc = 0

};

static cmd_info_t exit_info = {

    .name = "exit",

    .description = "Exit kconsole.",

    .argc = 0

};

static int cmd_reboot(cmd_arg_t *argv);

static cmd_info_t reboot_info = {

    .name = "reboot",

    .description = "Reboot.",

    .func = cmd_reboot,

    .argc = 0

};

static int cmd_uptime(cmd_arg_t *argv);

static cmd_info_t uptime_info = {

    .name = "uptime",

    .description = "Print uptime information.",

    .func = cmd_uptime,

    .argc = 0

};

static int cmd_continue(cmd_arg_t *argv);

static cmd_info_t continue_info = {

    .name = "continue",

    .description = "Return console back to userspace.",

    .func = cmd_continue,

    .argc = 0

};

#ifdef CONFIG_TEST

static int cmd_tests(cmd_arg_t *argv);

static cmd_info_t tests_info = {

    .name = "tests",

    .description = "Print available kernel tests.",

    .func = cmd_tests,

    .argc = 0

};

static char test_buf[MAX_CMDLINE + 1];

static int cmd_test(cmd_arg_t *argv);

static cmd_arg_t test_argv[] = {

    {

        .type = ARG_TYPE_STRING,

        .buffer = test_buf,

        .len = sizeof(test_buf)

    }

};

static cmd_info_t test_info = {

    .name = "test",

    .description = "Run kernel test.",

    .func = cmd_test,

    .argc = 1,

    .argv = test_argv

};

static int cmd_bench(cmd_arg_t *argv);

static cmd_arg_t bench_argv[] = {

    {

        .type = ARG_TYPE_STRING,

        .buffer = test_buf,

        .len = sizeof(test_buf)

    },

    {

        .type = ARG_TYPE_INT,

    }

};

static cmd_info_t bench_info = {

    .name = "bench",

    .description = "Run kernel test as benchmark.",

    .func = cmd_bench,

    .argc = 2,

    .argv = bench_argv

};

#endif

/* Data and methods for 'description' command. */

static int cmd_desc(cmd_arg_t *argv);

static void desc_help(void);

static char desc_buf[MAX_CMDLINE+1];

static cmd_arg_t desc_argv = {

    .type = ARG_TYPE_STRING,

    .buffer = desc_buf,

    .len = sizeof(desc_buf)

};

static cmd_info_t desc_info = {

    .name = "describe",

    .description = "Describe specified command.",

    .help = desc_help,

    .func = cmd_desc,

    .argc = 1,

    .argv = &desc_argv

};

/* Data and methods for 'symaddr' command. */

static int cmd_symaddr(cmd_arg_t *argv);

static char symaddr_buf[MAX_CMDLINE+1];

static cmd_arg_t symaddr_argv = {

    .type = ARG_TYPE_STRING,

    .buffer = symaddr_buf,

    .len = sizeof(symaddr_buf)

};

static cmd_info_t symaddr_info = {

    .name = "symaddr",

    .description = "Return symbol address.",

    .func = cmd_symaddr,

    .argc = 1,

    .argv = &symaddr_argv

};

static char set_buf[MAX_CMDLINE+1];

static int cmd_set4(cmd_arg_t *argv);

static cmd_arg_t set4_argv[] = {

    {

        .type = ARG_TYPE_STRING,

        .buffer = set_buf,

        .len = sizeof(set_buf)

    },

    {

        .type = ARG_TYPE_INT

    }

};

static cmd_info_t set4_info = {

    .name = "set4",

    .description = "set <dest_addr> <value> - 4byte version",

    .func = cmd_set4,

    .argc = 2,

    .argv = set4_argv

};

/* Data and methods for 'call0' command. */

static char call0_buf[MAX_CMDLINE + 1];

static char carg1_buf[MAX_CMDLINE + 1];

static char carg2_buf[MAX_CMDLINE + 1];

static char carg3_buf[MAX_CMDLINE + 1];

static int cmd_call0(cmd_arg_t *argv);

static cmd_arg_t call0_argv = {

    .type = ARG_TYPE_STRING,

    .buffer = call0_buf,

    .len = sizeof(call0_buf)

};

static cmd_info_t call0_info = {

    .name = "call0",

    .description = "call0 <function> -> call function().",

    .func = cmd_call0,

    .argc = 1,

    .argv = &call0_argv

};

/* Data and methods for 'mcall0' command. */

static int cmd_mcall0(cmd_arg_t *argv);

static cmd_arg_t mcall0_argv = {

    .type = ARG_TYPE_STRING,

    .buffer = call0_buf,

    .len = sizeof(call0_buf)

};

static cmd_info_t mcall0_info = {

    .name = "mcall0",

    .description = "mcall0 <function> -> call function() on each CPU.",

    .func = cmd_mcall0,

    .argc = 1,

    .argv = &mcall0_argv

};

/* Data and methods for 'call1' command. */

static int cmd_call1(cmd_arg_t *argv);

static cmd_arg_t call1_argv[] = {

    {

        .type = ARG_TYPE_STRING,

        .buffer = call0_buf,

        .len = sizeof(call0_buf)

    },

    {

        .type = ARG_TYPE_VAR,

        .buffer = carg1_buf,

        .len = sizeof(carg1_buf)

    }

};

static cmd_info_t call1_info = {

    .name = "call1",

    .description = "call1 <function> <arg1> -> call function(arg1).",

    .func = cmd_call1,

    .argc = 2,

    .argv = call1_argv

};

/* Data and methods for 'call2' command. */

static int cmd_call2(cmd_arg_t *argv);

static cmd_arg_t call2_argv[] = {

    {

        .type = ARG_TYPE_STRING,

        .buffer = call0_buf,

        .len = sizeof(call0_buf)

    },

    {

        .type = ARG_TYPE_VAR,

        .buffer = carg1_buf,

        .len = sizeof(carg1_buf)

    },

    {

        .type = ARG_TYPE_VAR,

        .buffer = carg2_buf,

        .len = sizeof(carg2_buf)

    }

};

static cmd_info_t call2_info = {

    .name = "call2",

    .description = "call2 <function> <arg1> <arg2> -> call function(arg1,arg2).",

    .func = cmd_call2,

    .argc = 3,

    .argv = call2_argv

};

/* Data and methods for 'call3' command. */

static int cmd_call3(cmd_arg_t *argv);

static cmd_arg_t call3_argv[] = {

    {

        .type = ARG_TYPE_STRING,

        .buffer = call0_buf,

        .len = sizeof(call0_buf)

    },

    {

        .type = ARG_TYPE_VAR,

        .buffer = carg1_buf,

        .len = sizeof(carg1_buf)

    },

    {

        .type = ARG_TYPE_VAR,

        .buffer = carg2_buf,

        .len = sizeof(carg2_buf)

    },

    {

        .type = ARG_TYPE_VAR,

        .buffer = carg3_buf,

        .len = sizeof(carg3_buf)

    }

};

static cmd_info_t call3_info = {

    .name = "call3",

    .description = "call3 <function> <arg1> <arg2> <arg3> -> call function(arg1,arg2,arg3).",

    .func = cmd_call3,

    .argc = 4,

    .argv = call3_argv

};

/* Data and methods for 'halt' command. */

static int cmd_halt(cmd_arg_t *argv);

static cmd_info_t halt_info = {

    .name = "halt",

    .description = "Halt the kernel.",

    .func = cmd_halt,

    .argc = 0

};

/* Data and methods for 'physmem' command. */

static int cmd_physmem(cmd_arg_t *argv);

cmd_info_t physmem_info = {

    .name = "physmem",

    .description = "Print physical memory configuration.",

    .help = NULL,

    .func = cmd_physmem,

    .argc = 0,

    .argv = NULL

};

/* Data and methods for 'tlb' command. */

static int cmd_tlb(cmd_arg_t *argv);

cmd_info_t tlb_info = {

    .name = "tlb",

    .description = "Print TLB of current processor.",

    .help = NULL,

    .func = cmd_tlb,

    .argc = 0,

    .argv = NULL

};

static int cmd_threads(cmd_arg_t *argv);

static cmd_info_t threads_info = {

    .name = "threads",

    .description = "List all threads.",

    .func = cmd_threads,

    .argc = 0

};

static int cmd_tasks(cmd_arg_t *argv);

static cmd_info_t tasks_info = {

    .name = "tasks",

    .description = "List all tasks.",

    .func = cmd_tasks,

    .argc = 0

};

static int cmd_sched(cmd_arg_t *argv);

static cmd_info_t sched_info = {

    .name = "scheduler",

    .description = "List all scheduler information.",

    .func = cmd_sched,

    .argc = 0

};

static int cmd_slabs(cmd_arg_t *argv);

static cmd_info_t slabs_info = {

    .name = "slabs",

    .description = "List slab caches.",

    .func = cmd_slabs,

    .argc = 0

};

/* Data and methods for 'zones' command */

static int cmd_zones(cmd_arg_t *argv);

static cmd_info_t zones_info = {

    .name = "zones",

    .description = "List of memory zones.",

    .func = cmd_zones,

    .argc = 0

};

/* Data and methods for 'ipc' command */

static int cmd_ipc(cmd_arg_t *argv);

static cmd_arg_t ipc_argv = {

    .type = ARG_TYPE_INT,

};

static cmd_info_t ipc_info = {

    .name = "ipc",

    .description = "ipc <taskid> Show IPC information of given task.",

    .func = cmd_ipc,

    .argc = 1,

    .argv = &ipc_argv

};

/* Data and methods for 'zone' command */

static int cmd_zone(cmd_arg_t *argv);

static cmd_arg_t zone_argv = {

    .type = ARG_TYPE_INT,

};

static cmd_info_t zone_info = {

    .name = "zone",

    .description = "Show memory zone structure.",

    .func = cmd_zone,

    .argc = 1,

    .argv = &zone_argv

};

/* Data and methods for 'cpus' command. */

static int cmd_cpus(cmd_arg_t *argv);

cmd_info_t cpus_info = {

    .name = "cpus",

    .description = "List all processors.",

    .help = NULL,

    .func = cmd_cpus,

    .argc = 0,

    .argv = NULL

};

/* Data and methods for 'version' command. */

static int cmd_version(cmd_arg_t *argv);

cmd_info_t version_info = {

    .name = "version",

    .description = "Print version information.",

    .help = NULL,

    .func = cmd_version,

    .argc = 0,

    .argv = NULL

};

static cmd_info_t *basic_commands[] = {

    &call0_info,

    &mcall0_info,

    &call1_info,

    &call2_info,

    &call3_info,

    &continue_info,

    &cpus_info,

    &desc_info,

    &exit_info,

    &reboot_info,

    &uptime_info,

    &halt_info,

    &help_info,

    &ipc_info,

    &set4_info,

    &slabs_info,

    &symaddr_info,

    &sched_info,

    &threads_info,

    &tasks_info,

    &physmem_info,

    &tlb_info,

    &version_info,

    &zones_info,

    &zone_info,

#ifdef CONFIG_TEST

    &tests_info,

    &test_info,

    &bench_info,

#endif

    NULL

};

/** Initialize command info structure.

 *

 * @param cmd Command info structure.

 *

 */

void cmd_initialize(cmd_info_t *cmd)

{

    spinlock_initialize(&cmd->lock, "cmd");

    link_initialize(&cmd->link);

}

/** Initialize and register commands. */

void cmd_init(void)

{

    unsigned int i;

    for (i = 0; basic_commands[i]; i++) {

        cmd_initialize(basic_commands[i]);

        if (!cmd_register(basic_commands[i]))

            printf("Cannot register command %s\n", basic_commands[i]->name);

    }

}

/** List supported commands.

 *

 * @param argv Argument vector.

 *

 * @return 0 on failure, 1 on success.

 */

int cmd_help(cmd_arg_t *argv)

{

    spinlock_lock(&cmd_lock);

    link_t *cur;

    size_t len = 0;

    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 (strlen(hlp->name) > len)

            len = strlen(hlp->name);

        spinlock_unlock(&hlp->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);

        printf("%-*s %s\n", len, hlp->name, hlp->description);

        spinlock_unlock(&hlp->lock);

    }

    spinlock_unlock(&cmd_lock);

    return 1;

}

/** Reboot the system.

 *

 * @param argv Argument vector.

 *

 * @return 0 on failure, 1 on success.

 */

int cmd_reboot(cmd_arg_t *argv)

{

    reboot();

    /* Not reached */

    return 1;

}

/** Print system uptime information.

 *

 * @param argv Argument vector.

 *

 * @return 0 on failure, 1 on success.

 */

int cmd_uptime(cmd_arg_t *argv)

{

    ASSERT(uptime);

    /* This doesn't have to be very accurate */

    unative_t sec = uptime->seconds1;

    printf("Up %" PRIun " days, %" PRIun " hours, %" PRIun " minutes, %" PRIun " seconds\n",

        sec / 86400, (sec % 86400) / 3600, (sec % 3600) / 60, sec % 60);

    return 1;

}

/** Describe specified command.

 *

 * @param argv Argument vector.

 *

 * @return 0 on failure, 1 on success.

 */

int cmd_desc(cmd_arg_t *argv)

{

    link_t *cur;

    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, (const char *) argv->buffer, strlen(hlp->name)) == 0) {

            printf("%s - %s\n", hlp->name, hlp->description);

            if (hlp->help)

                hlp->help();

            spinlock_unlock(&hlp->lock);

            break;

        }

        spinlock_unlock(&hlp->lock);

    }

    spinlock_unlock(&cmd_lock);

    return 1;

}

/** Search symbol table */

int cmd_symaddr(cmd_arg_t *argv)

{

    symtab_print_search((char *) argv->buffer);

    return 1;

}

/** Call function with zero parameters */

int cmd_call0(cmd_arg_t *argv)

{

    uintptr_t symaddr;

    char *symbol;

    unative_t (*fnc)(void);

    fncptr_t fptr;

    symaddr = get_symbol_addr((char *) argv->buffer);

    if (!symaddr)

        printf("Symbol %s not found.\n", argv->buffer);

    else if (symaddr == (uintptr_t) -1) {

        symtab_print_search((char *) argv->buffer);

        printf("Duplicate symbol, be more specific.\n");

    } else {

        symbol = get_symtab_entry(symaddr);

        fnc = (unative_t (*)(void)) arch_construct_function(&fptr, (void *) symaddr, (void *) cmd_call0);

        printf("Calling %s() (%p)\n", symbol, symaddr);

        printf("Result: %#" PRIxn "\n", fnc());

    }

    return 1;

}

/** Call function with zero parameters on each CPU */

int cmd_mcall0(cmd_arg_t *argv)

{

    /*

     * For each CPU, create a thread which will

     * call the function.

     */

    count_t i;

    for (i = 0; i < config.cpu_count; i++) {

        if (!cpus[i].active)

            continue;

        thread_t *t;

        if ((t = thread_create((void (*)(void *)) cmd_call0, (void *) argv, TASK, THREAD_FLAG_WIRED, "call0", false))) {

            spinlock_lock(&t->lock);

            t->cpu = &cpus[i];

            spinlock_unlock(&t->lock);

            printf("cpu%u: ", i);

            thread_ready(t);

            thread_join(t);

            thread_detach(t);

        } else

            printf("Unable to create thread for cpu%u\n", i);

    }

    return 1;

}

/** Call function with one parameter */

int cmd_call1(cmd_arg_t *argv)

{

    uintptr_t symaddr;

    char *symbol;

    unative_t (*fnc)(unative_t, ...);

    unative_t arg1 = argv[1].intval;

    fncptr_t fptr;

    symaddr = get_symbol_addr((char *) argv->buffer);

    if (!symaddr)

        printf("Symbol %s not found.\n", argv->buffer);

    else if (symaddr == (uintptr_t) -1) {

        symtab_print_search((char *) argv->buffer);

        printf("Duplicate symbol, be more specific.\n");

    } else {

        symbol = get_symtab_entry(symaddr);

        fnc = (unative_t (*)(unative_t, ...)) arch_construct_function(&fptr, (void *) symaddr, (void *) cmd_call1);

        printf("Calling f(%#" PRIxn "): %p: %s\n", arg1, symaddr, symbol);

        printf("Result: %#" PRIxn "\n", fnc(arg1));

    }

    return 1;

}

/** Call function with two parameters */

int cmd_call2(cmd_arg_t *argv)

{

    uintptr_t symaddr;

    char *symbol;

    unative_t (*fnc)(unative_t, unative_t, ...);

    unative_t arg1 = argv[1].intval;

    unative_t arg2 = argv[2].intval;

    fncptr_t fptr;

    symaddr = get_symbol_addr((char *) argv->buffer);

    if (!symaddr)

        printf("Symbol %s not found.\n", argv->buffer);

    else if (symaddr == (uintptr_t) -1) {

        symtab_print_search((char *) argv->buffer);

        printf("Duplicate symbol, be more specific.\n");

    } else {

        symbol = get_symtab_entry(symaddr);

        fnc = (unative_t (*)(unative_t, unative_t, ...)) arch_construct_function(&fptr, (void *) symaddr, (void *) cmd_call2);

        printf("Calling f(%#" PRIxn ", %#" PRIxn "): %p: %s\n",

               arg1, arg2, symaddr, symbol);

        printf("Result: %#" PRIxn "\n", fnc(arg1, arg2));

    }

    return 1;

}

/** Call function with three parameters */

int cmd_call3(cmd_arg_t *argv)

{

    uintptr_t symaddr;

    char *symbol;

    unative_t (*fnc)(unative_t, unative_t, unative_t, ...);

    unative_t arg1 = argv[1].intval;

    unative_t arg2 = argv[2].intval;

    unative_t arg3 = argv[3].intval;

    fncptr_t fptr;

    symaddr = get_symbol_addr((char *) argv->buffer);

    if (!symaddr)

        printf("Symbol %s not found.\n", argv->buffer);

    else if (symaddr == (uintptr_t) -1) {

        symtab_print_search((char *) argv->buffer);

        printf("Duplicate symbol, be more specific.\n");

    } else {

        symbol = get_symtab_entry(symaddr);

        fnc = (unative_t (*)(unative_t, unative_t, unative_t, ...)) arch_construct_function(&fptr, (void *) symaddr, (void *) cmd_call3);

        printf("Calling f(%#" PRIxn ",%#" PRIxn ", %#" PRIxn "): %p: %s\n",

               arg1, arg2, arg3, symaddr, symbol);

        printf("Result: %#" PRIxn "\n", fnc(arg1, arg2, arg3));

    }

    return 1;

}

/** Print detailed description of 'describe' command. */

void desc_help(void)

{

    printf("Syntax: describe command_name\n");

}

/** Halt the kernel.

 *

 * @param argv Argument vector (ignored).

 *

 * @return 0 on failure, 1 on success (never returns).

 */