/*
 * Mach Operating System
 * Copyright (c) 1991,1990 Carnegie Mellon University
 * All Rights Reserved.
 *
 * Permission to use, copy, modify and distribute this software and its
 * documentation is hereby granted, provided that both the copyright
 * notice and this permission notice appear in all copies of the
 * software, derivative works or modified versions, and any portions
 * thereof, and that both notices appear in supporting documentation.
 *
 * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS
 * CONDITION.  CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR
 * ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
 *
 * Carnegie Mellon requests users of this software to return to
 *
 *  Software Distribution Coordinator  or  Software.Distribution@CS.CMU.EDU
 *  School of Computer Science
 *  Carnegie Mellon University
 *  Pittsburgh PA 15213-3890
 *
 * any improvements or extensions that they make and grant Carnegie the
 * rights to redistribute these changes.
 *
 * $FreeBSD: src/sys/ddb/db_command.c,v 1.34.2.2 2001/07/29 22:48:36 kris Exp $
 */

/*
 *      Author: David B. Golub, Carnegie Mellon University
 *      Date:   7/90
 */

/*
 * Command dispatcher.
 */
#include "use_acpi.h"

#include <sys/param.h>
#include <sys/linker_set.h>
#include <sys/reboot.h>
#include <sys/systm.h>
#include <sys/cons.h>

#include <ddb/ddb.h>
#include <ddb/db_command.h>
#include <ddb/db_lex.h>
#include <ddb/db_output.h>

#include <machine/md_var.h>     /* needed for db_reset() */
#include <machine/setjmp.h>
#if NACPI > 0
#include "opt_acpi.h"
#include <acpi.h>
#endif

/*
 * Exported global variables
 */
boolean_t       db_cmd_loop_done;
db_addr_t       db_dot;
jmp_buf         db_jmpbuf;
db_addr_t       db_last_addr;
db_addr_t       db_prev;
db_addr_t       db_next;

SET_DECLARE(db_cmd_set, struct command);
SET_DECLARE(db_show_cmd_set, struct command);

static db_cmdfcn_t      db_fncall;
static db_cmdfcn_t      db_gdb;
static db_cmdfcn_t      db_reset;

/*
 * 'show' commands
 */

static struct command db_show_all_cmds[] = {
#if 0
        { "threads",    db_show_all_threads,    0,      NULL },
#endif
        { "procs",      db_ps,                  0,      NULL },
        { NULL }
};

static struct command db_show_cmds[] = {
        { "all",        0,                      0,      db_show_all_cmds },
        { "registers",  db_show_regs,           0,      NULL },
        { "breaks",     db_listbreak_cmd,       0,      NULL },
#if 0
        { "thread",     db_show_one_thread,     0,      NULL },
#endif
#if 0
        { "port",       ipc_port_print,         0,      NULL },
#endif
        { NULL, }
};

static struct command db_command_table[] = {
        { "print",      db_print_cmd,           0,      NULL },
        { "p",          db_print_cmd,           0,      NULL },
        { "examine",    db_examine_cmd,         CS_SET_DOT, NULL },
        { "x",          db_examine_cmd,         CS_SET_DOT, NULL },
        { "search",     db_search_cmd,          CS_OWN|CS_SET_DOT, NULL },
        { "set",        db_set_cmd,             CS_OWN, NULL },
        { "write",      db_write_cmd,           CS_MORE|CS_SET_DOT, NULL },
        { "w",          db_write_cmd,           CS_MORE|CS_SET_DOT, NULL },
        { "delete",     db_delete_cmd,          0,      NULL },
        { "d",          db_delete_cmd,          0,      NULL },
        { "break",      db_breakpoint_cmd,      0,      NULL },
        { "dwatch",     db_deletewatch_cmd,     0,      NULL },
        { "watch",      db_watchpoint_cmd,      CS_MORE,NULL },
        { "dhwatch",    db_deletehwatch_cmd,    0,      NULL },
        { "hwatch",     db_hwatchpoint_cmd,     0,      NULL },
        { "step",       db_single_step_cmd,     0,      NULL },
        { "s",          db_single_step_cmd,     0,      NULL },
        { "continue",   db_continue_cmd,        0,      NULL },
        { "c",          db_continue_cmd,        0,      NULL },
        { "i",          db_invltlb_cmd,         0,      NULL },
        { "until",      db_trace_until_call_cmd,0,      NULL },
        { "next",       db_trace_until_matching_cmd,0,  NULL },
        { "match",      db_trace_until_matching_cmd,0,  NULL },
        { "trace",      db_stack_trace_cmd,     0,      NULL },
        { "where",      db_stack_trace_cmd, 0,  NULL },
        { "call",       db_fncall,              CS_OWN, NULL },
        { "show",       0,                      0,      db_show_cmds },
        { "ps",         db_ps,                  0,      NULL },
        { "gdb",        db_gdb,                 0,      NULL },
        { "reset",      db_reset,               0,      NULL },
        { NULL, }
};

static struct command   *db_last_command = NULL;

/*
 * if 'ed' style: 'dot' is set at start of last item printed,
 * and '+' points to next line.
 * Otherwise: 'dot' points to next item, '..' points to last.
 */
static boolean_t        db_ed_style = TRUE;

/*
 * Utility routine - discard tokens through end-of-line.
 */
void
db_skip_to_eol(void)
{
        int     t;
        do {
            t = db_read_token();
        } while (t != tEOL);
}

/*
 * Results of command search.
 */
#define CMD_UNIQUE      0
#define CMD_FOUND       1
#define CMD_NONE        2
#define CMD_AMBIGUOUS   3
#define CMD_HELP        4

static void     db_cmd_list (struct command *table,
                                 struct command **aux_tablep,
                                 struct command **aux_tablep_end);
static int      db_cmd_search (char *name, struct command *table,
                                   struct command **aux_tablep,
                                   struct command **aux_tablep_end,
                                   struct command **cmdp);
static void     db_command (struct command **last_cmdp,
                                struct command *cmd_table,
                                struct command **aux_cmd_tablep,
                                struct command **aux_cmd_tablep_end);

/*
 * Search for command prefix.
 *
 * Parameters:
 *     cmdp:    out
 */
static int
db_cmd_search(char *name, struct command *table, struct command **aux_tablep,
              struct command **aux_tablep_end, struct command **cmdp)
{
        struct command  *cmd;
        struct command  **aux_cmdp;
        int             result = CMD_NONE;

        for (cmd = table; cmd->name != 0; cmd++) {
            char *lp;
            char *rp;
            int  c;

            lp = name;
            rp = cmd->name;
            while ((c = *lp) == *rp) {
                if (c == 0) {
                    /* complete match */
                    *cmdp = cmd;
                    return (CMD_UNIQUE);
                }
                lp++;
                rp++;
            }
            if (c == 0) {
                /* end of name, not end of command -
                   partial match */
                if (result == CMD_FOUND) {
                    result = CMD_AMBIGUOUS;
                    /* but keep looking for a full match -
                       this lets us match single letters */
                }
                else {
                    *cmdp = cmd;
                    result = CMD_FOUND;
                }
            }
        }
        if (result == CMD_NONE && aux_tablep != NULL)
            /* XXX repeat too much code. */
            for (aux_cmdp = aux_tablep; aux_cmdp < aux_tablep_end; aux_cmdp++) {
                char *lp;
                char *rp;
                int  c;

                lp = name;
                rp = (*aux_cmdp)->name;
                while ((c = *lp) == *rp) {
                    if (c == 0) {
                        /* complete match */
                        *cmdp = *aux_cmdp;
                        return (CMD_UNIQUE);
                    }
                    lp++;
                    rp++;
                }
                if (c == 0) {
                    /* end of name, not end of command -
                       partial match */
                    if (result == CMD_FOUND) {
                        result = CMD_AMBIGUOUS;
                        /* but keep looking for a full match -
                           this lets us match single letters */
                    }
                    else {
                        *cmdp = *aux_cmdp;
                        result = CMD_FOUND;
                    }
                }
            }
        if (result == CMD_NONE) {
            /* check for 'help' */
                if (name[0] == 'h' && name[1] == 'e'
                    && name[2] == 'l' && name[3] == 'p')
                        result = CMD_HELP;
        }
        return (result);
}

static void
db_cmd_list(struct command *table, struct command **aux_tablep,
            struct command **aux_tablep_end)
{
        struct command *cmd;
        struct command **aux_cmdp;

        for (cmd = table; cmd->name != 0; cmd++) {
            db_printf("%-12s", cmd->name);
            db_end_line(12);
        }
        if (aux_tablep == NULL)
            return;
        for (aux_cmdp = aux_tablep; aux_cmdp < aux_tablep_end; aux_cmdp++) {
            db_printf("%-12s", (*aux_cmdp)->name);
            db_end_line(12);
        }
}

/*
 * Parameters:
 *     last_cmdp:       IN_OUT
 */
static void
db_command(struct command **last_cmdp, struct command *cmd_table,
           struct command **aux_cmd_tablep, struct command **aux_cmd_tablep_end)
{
        struct command  *cmd;
        int             t;
        char            modif[TOK_STRING_SIZE];
        db_expr_t       addr, count;
        boolean_t       have_addr = FALSE;
        int             result;

        cmd = NULL;
        t = db_read_token();
        if (t == tEOL) {
            /* empty line repeats last command, at 'next' */
            cmd = *last_cmdp;
            addr = (db_expr_t)db_next;
            have_addr = FALSE;
            count = 1;
            modif[0] = '\0';
        }
        else if (t == tEXCL) {
            db_fncall((db_expr_t)0, (boolean_t)0, (db_expr_t)0, NULL);
            return;
        }
        else if (t != tIDENT) {
            db_printf("?\n");
            db_flush_lex();
            return;
        }
        else {
            /*
             * Search for command
             */
            while (cmd_table) {
                result = db_cmd_search(db_tok_string,
                                       cmd_table,
                                       aux_cmd_tablep,
                                       aux_cmd_tablep_end,
                                       &cmd);
                switch (result) {
                    case CMD_NONE:
                        db_printf("No such command\n");
                        db_flush_lex();
                        return;
                    case CMD_AMBIGUOUS:
                        db_printf("Ambiguous\n");
                        db_flush_lex();
                        return;
                    case CMD_HELP:
                        db_cmd_list(cmd_table, aux_cmd_tablep, aux_cmd_tablep_end);
                        db_flush_lex();
                        return;
                    default:
                        break;
                }
                if ((cmd_table = cmd->more) != NULL) {
                    /* XXX usually no more aux's. */
                    aux_cmd_tablep = NULL;
                    if (cmd_table == db_show_cmds) {
                        aux_cmd_tablep = SET_BEGIN(db_show_cmd_set);
                        aux_cmd_tablep_end = SET_LIMIT(db_show_cmd_set);
                    }

                    t = db_read_token();
                    if (t != tIDENT) {
                        db_cmd_list(cmd_table, aux_cmd_tablep, aux_cmd_tablep_end);
                        db_flush_lex();
                        return;
                    }
                }
            }

            if ((cmd->flag & CS_OWN) == 0) {
                /*
                 * Standard syntax:
                 * command [/modifier] [addr] [,count]
                 */
                t = db_read_token();
                if (t == tSLASH) {
                    t = db_read_token();
                    if (t != tIDENT && t != tNUMBER) {
                        db_printf("Bad modifier\n");
                        db_flush_lex();
                        return;
                    }
                    db_strcpy(modif, db_tok_string);
                }
                else {
                    db_unread_token(t);
                    modif[0] = '\0';
                }

                if (db_expression(&addr)) {
                    db_dot = (db_addr_t) addr;
                    db_last_addr = db_dot;
                    have_addr = TRUE;
                }
                else {
                    addr = (db_expr_t) db_dot;
                    have_addr = FALSE;
                }
                t = db_read_token();
                if (t == tCOMMA) {
                    if (!db_expression(&count)) {
                        db_printf("Count missing\n");
                        db_flush_lex();
                        return;
                    }
                }
                else {
                    db_unread_token(t);
                    count = -1;
                }
                if ((cmd->flag & CS_MORE) == 0) {
                    db_skip_to_eol();
                }
            }
        }
        *last_cmdp = cmd;
        if (cmd != NULL) {
            /*
             * Execute the command.
             */
            (*cmd->fcn)(addr, have_addr, count, modif);

            if (cmd->flag & CS_SET_DOT) {
                /*
                 * If command changes dot, set dot to
                 * previous address displayed (if 'ed' style).
                 */
                if (db_ed_style) {
                    db_dot = db_prev;
                }
                else {
                    db_dot = db_next;
                }
            }
            else {
                /*
                 * If command does not change dot,
                 * set 'next' location to be the same.
                 */
                db_next = db_dot;
            }
        }
}

#if 0
void
db_help_cmd(void)
{
        struct command *cmd = db_command_table;

        while (cmd->name != 0) {
            db_printf("%-12s", cmd->name);
            db_end_line(12);
            cmd++;
        }
}
#endif

/*
 * At least one non-optional command must be implemented using
 * DB_COMMAND() so that db_cmd_set gets created.  Here is one.
 */
DB_COMMAND(panic, db_panic)
{
        panic("from debugger");
}

void
db_command_loop(void)
{
        /*
         * Initialize 'prev' and 'next' to dot.
         */
        cnpoll(TRUE);
        db_prev = db_dot;
        db_next = db_dot;

        db_cmd_loop_done = FALSE;
        while (!db_cmd_loop_done) {

            setjmp(db_jmpbuf);
            if (db_print_position() != 0)
                db_printf("\n");

            db_printf("db> ");
            db_read_line();

            db_command(&db_last_command, db_command_table,
                    SET_BEGIN(db_cmd_set), SET_LIMIT(db_cmd_set));
        }
        cnpoll(FALSE);
}

void
db_error(char *s)
{
        if (s)
            db_printf("%s", s);
        db_flush_lex();
        longjmp(db_jmpbuf, 1);
}


/*
 * Call random function:
 * !expr(arg,arg,arg)
 */
typedef union {
        db_expr_t       (*a0)(void);
        db_expr_t       (*a1)(db_expr_t);
        db_expr_t       (*a2)(db_expr_t, db_expr_t);
        db_expr_t       (*a3)(db_expr_t, db_expr_t, db_expr_t);
        db_expr_t       (*a4)(db_expr_t, db_expr_t, db_expr_t, db_expr_t);
        db_expr_t       (*a5)(db_expr_t, db_expr_t, db_expr_t, db_expr_t, db_expr_t);
        db_expr_t       (*a6)(db_expr_t, db_expr_t, db_expr_t, db_expr_t, db_expr_t,
                           db_expr_t);
        db_expr_t       (*a7)(db_expr_t, db_expr_t, db_expr_t, db_expr_t, db_expr_t,
                           db_expr_t, db_expr_t);
        db_expr_t       (*a8)(db_expr_t, db_expr_t, db_expr_t, db_expr_t, db_expr_t,
                           db_expr_t, db_expr_t, db_expr_t);
        db_expr_t       (*a9)(db_expr_t, db_expr_t, db_expr_t, db_expr_t, db_expr_t,
                           db_expr_t, db_expr_t, db_expr_t, db_expr_t);
        db_expr_t       (*a10)(db_expr_t, db_expr_t, db_expr_t, db_expr_t, db_expr_t,
                           db_expr_t, db_expr_t, db_expr_t, db_expr_t, db_expr_t);
} fcn_multiargs_t;


static void
db_fncall(db_expr_t dummy1, boolean_t dummy2, db_expr_t dummy3, char *dummy4)
{
        db_expr_t       fn_addr;
#define MAXARGS         11      /* XXX only 10 are passed */
        db_expr_t       args[MAXARGS];
        int             nargs = 0;
        db_expr_t       retval;
        fcn_multiargs_t func;
        int             t;

        if (!db_expression(&fn_addr)) {
            db_printf("Bad function\n");
            db_flush_lex();
            return;
        }
        func.a0 = (void *)fn_addr;

        t = db_read_token();
        if (t == tLPAREN) {
            if (db_expression(&args[0])) {
                nargs++;
                while ((t = db_read_token()) == tCOMMA) {
                    if (nargs == MAXARGS) {
                        db_printf("Too many arguments\n");
                        db_flush_lex();
                        return;
                    }
                    if (!db_expression(&args[nargs])) {
                        db_printf("Argument missing\n");
                        db_flush_lex();
                        return;
                    }
                    nargs++;
                }
                db_unread_token(t);
            }
            if (db_read_token() != tRPAREN) {
                db_printf("?\n");
                db_flush_lex();
                return;
            }
        }
        db_skip_to_eol();

        /*
         * This is mainly so kgdb doesn't get confused if ddb> call is
         * in its backtrace.
         */
        switch(nargs) {
        case 0:
                retval = (*func.a0)();
                break;
        case 1:
                retval = (*func.a1)(args[0]);
                break;
        case 2:
                retval = (*func.a2)(args[0], args[1]);
                break;
        case 3:
                retval = (*func.a3)(args[0], args[1], args[2]);
                break;
        case 4:
                retval = (*func.a4)(args[0], args[1], args[2], args[3]);
                break;
        case 5:
                retval = (*func.a5)(args[0], args[1], args[2], args[3], args[4]);
                break;
        case 6:
                retval = (*func.a6)(args[0], args[1], args[2], args[3], args[4],
                                    args[5]);
                break;
        case 7:
                retval = (*func.a7)(args[0], args[1], args[2], args[3], args[4],
                                    args[5], args[6]);
                break;
        case 8:
                retval = (*func.a8)(args[0], args[1], args[2], args[3], args[4],
                                    args[5], args[6], args[7]);
                break;
        case 9:
                retval = (*func.a9)(args[0], args[1], args[2], args[3], args[4],
                                    args[5], args[6], args[7], args[8]);
                break;
        case 10:
                retval = (*func.a10)(args[0], args[1], args[2], args[3], args[4],
                                     args[5], args[6], args[7], args[8], args[9]);
                break;
        default:
                db_printf("too many arguments\n");
                retval = 0;
                break;
        }
        db_printf("%s\n", db_num_to_str(retval));
}

/* Enter GDB remote protocol debugger on the next trap. */

static void
db_gdb(db_expr_t dummy1, boolean_t dummy2, db_expr_t dummy3, char *dummy4)
{
        if (gdb_tab == NULL) {
                db_printf("No gdb port enabled. Set flag 0x80 on desired port\n");
                db_printf("in your configuration file (currently sio only).\n");
                return;
        }
        boothowto ^= RB_GDB;

        db_printf("Next trap will enter %s\n",
                   boothowto & RB_GDB ? "GDB remote protocol mode"
                                      : "DDB debugger");
}

static void
db_reset(db_expr_t dummy1, boolean_t dummy2, db_expr_t dummy3, char * dummy4)
{
#if NACPI > 0
        // AcpiReset() should simply fail with AE_NOT_EXIST when called in
        // early boot, before the FADT has been parsed.
        ACPI_STATUS Status = AcpiReset();
        if (Status == AE_NOT_EXIST) {
                goto no_acpi_reset;
        } else if (ACPI_FAILURE(Status)) {
                kprintf("ACPI Reset failed\n");
        }
        DELAY(500000);
        kprintf("ACPI reset did not work, attempting next method\n");
        DELAY(1000000);
no_acpi_reset:
#endif
        cpu_reset();
}