/** \file   mon_breakpoint.c
 * \brief   The VICE built-in monitor breakpoint functions.
 *
 * \author  Andreas Boose <viceteam@t-online.de>
 * \author  Daniel Sladic <sladic@eecg.toronto.edu>
 * \author  Ettore Perazzoli <ettore@comm2000.it>
 */

/*
 * This file is part of VICE, the Versatile Commodore Emulator.
 * See README for copyright notice.
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
 *  02111-1307  USA.
 *
 */

#include "vice.h"

#include <stdio.h>
#include <stdlib.h>
#include <string.h>

#include "interrupt.h"
#include "lib.h"
#include "log.h"
#include "mon_breakpoint.h"
#include "mon_disassemble.h"
#include "mon_util.h"
#include "montypes.h"
#include "monitor.h"
#include "uimon.h"
#include "mon_breakpoint.h"

#ifdef HAVE_NETWORK
#include "monitor_binary.h"
#endif

/*#define DEBUG_BREAKPOINTS*/

#ifdef DEBUG_BREAKPOINTS
#define DBG(x)  log_printf x
#else
#define DBG(x)
#endif

struct checkpoint_list_s {
    mon_checkpoint_t *checkpt;
    struct checkpoint_list_s *next;
};
typedef struct checkpoint_list_s checkpoint_list_t;

static int breakpoint_count;
static checkpoint_list_t *all_checkpoints;
static checkpoint_list_t *breakpoints[NUM_MEMSPACES];
static checkpoint_list_t *watchpoints_load[NUM_MEMSPACES];
static checkpoint_list_t *watchpoints_store[NUM_MEMSPACES];


void mon_breakpoint_init(void)
{
    breakpoint_count = 1;
}

static void remove_checkpoint_from_list(checkpoint_list_t **head, mon_checkpoint_t *cp)
{
    checkpoint_list_t *cur_entry, *prev_entry;

    cur_entry = *head;
    prev_entry = NULL;

    while (cur_entry) {
        if (cur_entry->checkpt == cp) {
            break;
        }

        prev_entry = cur_entry;
        cur_entry = cur_entry->next;
    }

    if (!cur_entry) {
        log_error(LOG_DEFAULT, "Invalid checkpoint entry!");
        return;
    } else {
        if (!prev_entry) {
            *head = cur_entry->next;
        } else {
            prev_entry->next = cur_entry->next;
        }
        lib_free(cur_entry);
    }
}

/** \brief Get a list of all checkpoints
 *
 * \param[out]  len     length of the returned array
 *
 * \return The list of checkpoints
 */
mon_checkpoint_t **mon_breakpoint_checkpoint_list_get(unsigned int *len) {
    checkpoint_list_t *ptr;
    mon_checkpoint_t **concat;

    *len = 0;

    ptr = all_checkpoints;
    while (ptr) {
        ++*len;
        ptr = ptr->next;
    }

    concat = lib_malloc(sizeof(mon_checkpoint_t *) * *len);

    *len = -1;

    ptr = all_checkpoints;
    while (ptr) {
        ++*len;
        concat[*len] = ptr->checkpt;
        ptr = ptr->next;
    }
    ++*len;

    return concat;
}

/** \brief find the breakpoint with number 'brknum' in the linked list
 *
 * \param[in]  brknum     breakpoint number
 *
 * \return The checkpoint that has brknum, or NULL
 */
mon_checkpoint_t *mon_breakpoint_find_checkpoint(int brknum)
{
    checkpoint_list_t *ptr;

    ptr = all_checkpoints;
    while (ptr) {
        if (ptr->checkpt->checknum == brknum) {
            return ptr->checkpt;
        }
        ptr = ptr->next;
    }
    return NULL;
}

static void update_checkpoint_state(MEMSPACE mem)
{
    /* calls mem_toggle_watchpoints() */
    if (watchpoints_load[mem] != NULL ||
        watchpoints_store[mem] != NULL) {
        monitor_mask[mem] |= MI_WATCH;
        mon_interfaces[mem]->toggle_watchpoints_func(
            1 | (break_on_dummy_access << 1), mon_interfaces[mem]->context);
    } else {
        monitor_mask[mem] &= ~MI_WATCH;
        mon_interfaces[mem]->toggle_watchpoints_func(
            0, mon_interfaces[mem]->context);
    }

    if (breakpoints[mem] != NULL) {
        monitor_mask[mem] |= MI_BREAK;
    } else {
        monitor_mask[mem] &= ~MI_BREAK;
    }

    if (monitor_mask[mem]) {
        interrupt_monitor_trap_on(mon_interfaces[mem]->int_status);
    } else {
        interrupt_monitor_trap_off(mon_interfaces[mem]->int_status);
    }
}

/** \brief Ensure checkpoint state for memspaces is set correctly.
 *
 * Used to keep breakpoints working after a snapshot load.
 */
void mon_update_all_checkpoint_state(void)
{
    MEMSPACE i;

    for (i = FIRST_SPACE; i <= LAST_SPACE; i++) {
        update_checkpoint_state(i);
    }
}

/* FIXME: some day we might want to toggle the break-on-dummy-access per MEMSPACE,
          for now its a global option */
void mon_breakpoint_set_dummy_state(MEMSPACE mem, int state)
{
    if (mem == e_default_space) {
        mem = default_memspace;
    }
    break_on_dummy_access = state; /* this is redundant right now */
    update_checkpoint_state(mem);
}

static void remove_checkpoint(mon_checkpoint_t *cp)
{
    MEMSPACE mem;

    mem = addr_memspace(cp->start_addr);

    mon_delete_conditional(cp->condition);
    lib_free(cp->command);
    cp->command = NULL;

    remove_checkpoint_from_list(&all_checkpoints, cp);
    if (cp->check_exec) {
        remove_checkpoint_from_list(&(breakpoints[mem]), cp);
    }
    if (cp->check_load) {
        remove_checkpoint_from_list(&(watchpoints_load[mem]), cp);
    }
    if (cp->check_store) {
        remove_checkpoint_from_list(&(watchpoints_store[mem]), cp);
    }

    update_checkpoint_state(mem);
}

void mon_breakpoint_switch_checkpoint(int op, int cp_num)
{
    int i;
    mon_checkpoint_t *cp = NULL;

    if (cp_num == -1) {
        mon_out("Set all checkpoints to state: %s\n",
                (op == e_ON) ? "enabled" : "disabled");
        for (i = 1; i < breakpoint_count; i++) {
            cp = mon_breakpoint_find_checkpoint(i);
            if (cp) {
                cp->enabled = op;
            }
        }
        return;
    }

    cp = mon_breakpoint_find_checkpoint(cp_num);

    if (!cp) {
        mon_out("#%d not a valid checkpoint\n", cp_num);
        return;
    }

    cp->enabled = op;
}

void mon_breakpoint_set_ignore_count(int cp_num, int count)
{
    mon_checkpoint_t *cp;
    cp = mon_breakpoint_find_checkpoint(cp_num);

    if (!cp) {
        mon_out("#%d not a valid checkpoint\n", cp_num);
    } else {
        cp->ignore_count = count;
        mon_out("Will ignore the next %d hits of checkpoint #%d\n",
                count, cp_num);
    }
}

static void print_checkpoint_info(mon_checkpoint_t *cp)
{
    if (!cp->stop) {
        mon_out("TRACE: ");
    } else if (cp->check_load || cp->check_store) {
        mon_out("WATCH: ");
    } else {
        if (cp->temporary) {
            mon_out("UNTIL: ");
        } else {
            mon_out("BREAK: ");
        }
    }
    mon_out("%d  %s:$%04x", cp->checknum,
            mon_memspace_string[addr_memspace(cp->start_addr)], addr_location(cp->start_addr));
    if (mon_is_valid_addr(cp->end_addr) && (cp->start_addr != cp->end_addr)) {
        mon_out("-$%04x", addr_location(cp->end_addr));
    }

    mon_out(cp->stop ? "  (Stop on" : "  (Trace");
    if (cp->check_load) {
        mon_out(" load");
    }
    if (cp->check_store) {
        mon_out(" store");
    }
    if (cp->check_exec) {
        mon_out(" exec");
    }

    mon_out(")");
    if (cp->enabled != e_ON) {
        mon_out(" disabled");
    }
    mon_out("\n");

    if (cp->condition) {
        mon_out("\tCondition: ");
        mon_print_conditional(cp->condition);
        mon_out("\n");
    }
    if (cp->command) {
        mon_out("\tCommand: %s\n", cp->command);
    }
}

void mon_breakpoint_print_checkpoints(void)
{
    int i, any_set = 0;
    mon_checkpoint_t *bp;

    for (i = 1; i < breakpoint_count; i++) {
        if ((bp = mon_breakpoint_find_checkpoint(i))) {
            print_checkpoint_info(bp);
            any_set = 1;
        }
    }

    if (!any_set) {
        mon_out("No breakpoints are set\n");
    }
}

#ifdef DEBUG_BREAKPOINTS
/* show checkpoint list in the order it is in the list */
static void dump_checkpoint_list(void)
{
    checkpoint_list_t *ptr = all_checkpoints;
    mon_out("dump_checkpoint_list:\n");
    while (ptr) {
        print_checkpoint_info(ptr->checkpt);
        ptr = ptr->next;
    }
}
#endif

void mon_breakpoint_delete_checkpoint(int cp_num)
{
    int i;
    mon_checkpoint_t *cp = NULL;

    if (cp_num == -1) {
        /* Add user confirmation here. */
        mon_out("Deleting all checkpoints\n");
        for (i = 1; i < breakpoint_count; i++) {
            if ((cp = mon_breakpoint_find_checkpoint(i))) {
                remove_checkpoint(cp);
            }
        }
        /* reset the index to 1 */
        breakpoint_count = 1;
    } else if (!(cp = mon_breakpoint_find_checkpoint(cp_num))) {
        mon_out("#%d not a valid checkpoint\n", cp_num);
        return;
    } else {
        remove_checkpoint(cp);
        /* if there are still checkpoints in the list, return.
           else reset the index to 1 */
        for (i = 1; i < breakpoint_count; i++) {
            if ((cp = mon_breakpoint_find_checkpoint(i))) {
                return;
            }
        }
        breakpoint_count = 1;
    }
}

void mon_breakpoint_set_checkpoint_condition(int cp_num,
                                             cond_node_t *cnode)
{
    mon_checkpoint_t *cp;

    if (cnode) {
        cp = mon_breakpoint_find_checkpoint(cp_num);

        if (!cp) {
            mon_out("#%d not a valid checkpoint\n", cp_num);
        } else {
            cp->condition = cnode;

            mon_out("Setting checkpoint %d condition to: ", cp_num);
            mon_print_conditional(cnode);
            mon_out("\n");
        }
    }
}


void mon_breakpoint_set_checkpoint_command(int cp_num, char *cmd)
{
    mon_checkpoint_t *bp;
    bp = mon_breakpoint_find_checkpoint(cp_num);

    if (!bp) {
        mon_out("#%d not a valid checkpoint\n", cp_num);
    } else {
        bp->command = cmd;
        mon_out("Setting checkpoint %d command to: %s\n",
                cp_num, cmd);
    }
}

static checkpoint_list_t *search_checkpoint_list(checkpoint_list_t *head, unsigned loc)
{
    checkpoint_list_t *cur_entry;

    cur_entry = head;

    /* The list should be sorted in increasing order. If the current entry
       is > than the search item, we can drop out early.
    */
    while (cur_entry) {
        if (mon_is_in_range(cur_entry->checkpt->start_addr,
                            cur_entry->checkpt->end_addr, loc)) {
            return cur_entry;
        }

        cur_entry = cur_entry->next;
    }

    return NULL;
}

static int compare_checkpoints(mon_checkpoint_t *bp1, mon_checkpoint_t *bp2)
{
    unsigned addr1, addr2;
    /* Returns < 0 if bp1 < bp2
               = 0 if bp1 = bp2
               > 0 if bp1 > bp2
    */

    addr1 = addr_location(bp1->start_addr);
    addr2 = addr_location(bp2->start_addr);

    if (addr1 < addr2) {
        return -1;
    }

    if (addr1 > addr2) {
        return 1;
    }

    return 0;
}

static void mon_breakpoint_event(mon_checkpoint_t *checkpt) {
#ifdef HAVE_NETWORK
    if (monitor_is_binary()) {
        monitor_binary_response_checkpoint_info(0xffffffff, checkpt, 1);
    }
#endif
}

bool mon_breakpoint_check_checkpoint(MEMSPACE mem, unsigned int addr, unsigned int lastpc, MEMORY_OP op)
{
    checkpoint_list_t *ptr;
    mon_checkpoint_t *cp;
    checkpoint_list_t *list;
    monitor_cpu_type_t *monitor_cpu, *searchcpu;
    bool must_stop = FALSE;
    MON_ADDR instpc, searchpc;
    MON_ADDR loadstorepc;
    char is_loadstore = 0;
    const char *op_str;
    const char *action_str;
    supported_cpu_type_list_t *cpulist;
    int monbank = mon_interfaces[mem]->current_bank;

    monitor_cpu = monitor_cpu_for_memspace[mem];
    instpc = new_addr(mem, (monitor_cpu->mon_register_get_val)(mem, e_PC));
    loadstorepc = new_addr(mem, lastpc);

    /* HACK: the following is a hack to allow switching to another CPU when
             a breakpoint triggers (eg to the z80 of the c128). at some point
             we should refactor the checkpoint system to also provide us the
             CPU that triggered it instead.
       CAUTION: this only works for exec, not for load/store
    */

    /* if the address is not the same of the PC of the current CPU... */
    if ((op == e_exec) && (new_addr(mem, addr) != instpc)) {
        /* ... loop over the list of supported CPUs in this memspace ... */
        cpulist = monitor_cpu_type_supported[mem];
        while (cpulist != NULL) {
            searchcpu = cpulist->monitor_cpu_type_p;
            /* if we find other CPUs than the current one... */
            if (searchcpu != monitor_cpu) {
                searchpc = new_addr(mem, (searchcpu->mon_register_get_val)(mem, e_PC));
                /* check if the PC of the other CPU is not the same as the PC of the
                   current CPU, but the checkpoint address matches the PC of the CPU we found */
                if (searchpc != instpc && searchpc == new_addr(mem, addr)) {
                    /* if so, assume the checkpoint hit on the other CPU and switch to it */
                    instpc = searchpc;
                    monitor_cpu_for_memspace[mem] = monitor_cpu = searchcpu;
                    break;
                }
            }
            cpulist = cpulist->next;
        }
    }

    switch (op) {
        case e_load:
            list = watchpoints_load[mem];
            op_str = "load";
            is_loadstore = 1;
            break;

        case e_store:
            list = watchpoints_store[mem];
            op_str = "store";
            is_loadstore = 1;
            break;

        default: /* e_exec */
            list = breakpoints[mem];
            op_str = "exec";
            break;
    }

    ptr = search_checkpoint_list(list, addr);

    while (ptr) {
        cp = ptr->checkpt;
        ptr = ptr->next;
        if (cp && (cp->enabled == e_ON) &&
            mon_is_in_range(cp->start_addr, cp->end_addr, addr)) {

            /* If condition test fails, skip this checkpoint */
            if (cp->condition) {
                if (!mon_evaluate_conditional(cp->condition)) {
                    continue;
                }
            }

            /* Check if the user specified some ignores */
            if (cp->ignore_count) {
                cp->ignore_count--;
                continue;
            }

            cp->hit_count++;

            mon_breakpoint_event(cp);

            if (cp->stop) {
                must_stop = TRUE;
                action_str = "Stop on";
            } else {
                action_str = "Trace";
            }

            mon_out("#%d (%s %5s %04x) ", cp->checknum, action_str, op_str, addr);

            if (mon_interfaces[mem]->get_line_cycle != NULL) {
                unsigned int line, cycle;
                int half_cycle;

                mon_interfaces[mem]->get_line_cycle(&line, &cycle, &half_cycle);

                if (half_cycle == -1) {
                    mon_out(" %3u/$%03x, %3u/$%02x\n",
                            line, line, cycle, cycle);
                } else {
                    mon_out(" %3u/$%03x, %3u/$%02x %i\n",
                            line, line, cycle, cycle, half_cycle);
                }
            } else {
                mon_out("\n");
            }

            /* always disassemble using CPU bank */
            if (mon_interfaces[mem]->mem_bank_from_name != NULL) {
                mon_interfaces[mem]->current_bank = mon_interfaces[mem]->mem_bank_from_name("cpu");
            } else {
                mon_interfaces[mem]->current_bank = 0;
            }

            if (is_loadstore) {
                mon_disassemble_with_regdump(mem, loadstorepc);
            } else if (!is_loadstore || cp->stop) {
                mon_disassemble_with_regdump(mem, instpc);
            }
            mon_interfaces[mem]->current_bank = monbank; /* restore value used in monitor */

            if (cp->command) {
                mon_out("Executing: %s\n", cp->command);
                parse_and_execute_line(cp->command);
            }

            if (cp->temporary) {
                mon_breakpoint_delete_checkpoint(cp->checknum);
            }
        }
    }

    return must_stop;
}

static void add_to_checkpoint_list(checkpoint_list_t **head, mon_checkpoint_t *cp)
{
    checkpoint_list_t *new_entry, *cur_entry, *prev_entry;

    new_entry = lib_malloc(sizeof(checkpoint_list_t));
    new_entry->checkpt = cp;

    cur_entry = *head;
    prev_entry = NULL;

    /* Make sure the list is in increasing order. (Ranges are entered
       based on the lower bound) This way if the searched for address is
       less than the current ptr, we can skip the rest of the list. Note
       that ranges that wrap around 0xffff aren't handled in this scheme.
       Suggestion: Split the range and create two entries.
    */
    while (cur_entry && (compare_checkpoints(cur_entry->checkpt, cp) <= 0)) {
        prev_entry = cur_entry;
        cur_entry = cur_entry->next;
    }

    if (!prev_entry) {
        *head = new_entry;
        new_entry->next = cur_entry;
#ifdef DEBUG_BREAKPOINTS
        dump_checkpoint_list();
#endif
        return;
    }

    prev_entry->next = new_entry;
    new_entry->next = cur_entry;

#ifdef DEBUG_BREAKPOINTS
    dump_checkpoint_list();
#endif
}

static
int breakpoint_add_checkpoint(MON_ADDR start_addr, MON_ADDR end_addr,
                              bool stop, MEMORY_OP memory_op,
                              bool is_temp, bool do_print)
{
    mon_checkpoint_t *new_cp;
    MEMSPACE mem;

    mon_evaluate_address_range(&start_addr, &end_addr, FALSE, 0);
    new_cp = lib_malloc(sizeof(mon_checkpoint_t));

    new_cp->checknum = breakpoint_count++;
    new_cp->start_addr = start_addr;
    new_cp->end_addr = end_addr;
    new_cp->stop = stop;
    new_cp->enabled = e_ON;
    new_cp->hit_count = 0;
    new_cp->ignore_count = 0;
    new_cp->condition = NULL;
    new_cp->command = NULL;
    new_cp->check_load = memory_op & e_load;
    new_cp->check_store = memory_op & e_store;
    new_cp->check_exec = memory_op & e_exec;
    new_cp->temporary = is_temp;

    mem = addr_memspace(start_addr);
    add_to_checkpoint_list(&all_checkpoints, new_cp);
    if (new_cp->check_exec) {
        add_to_checkpoint_list(&(breakpoints[mem]), new_cp);
    }
    if (new_cp->check_load) {
        add_to_checkpoint_list(&(watchpoints_load[mem]), new_cp);
    }
    if (new_cp->check_store) {
        add_to_checkpoint_list(&(watchpoints_store[mem]), new_cp);
    }

    update_checkpoint_state(mem);

    if (is_temp) {
        exit_mon = exit_mon_continue;
    }

    if (do_print) {
        print_checkpoint_info(new_cp);
    }

    return new_cp->checknum;
}

int mon_breakpoint_add_checkpoint(MON_ADDR start_addr, MON_ADDR end_addr,
                                  bool stop, MEMORY_OP op, bool is_temp, bool do_print)
{
    return breakpoint_add_checkpoint(start_addr, end_addr, stop, op, is_temp, do_print);
}

mon_breakpoint_type_t mon_breakpoint_is(MON_ADDR address)
{
    MEMSPACE mem = addr_memspace(address);
    uint16_t addr = addr_location(address);
    checkpoint_list_t *ptr;

    ptr = search_checkpoint_list(breakpoints[mem], addr);

    if (!ptr) {
        return BP_NONE;
    }

    return (ptr->checkpt->enabled == e_ON) ? BP_ACTIVE : BP_INACTIVE;
}

void mon_breakpoint_set(MON_ADDR address)
{
    MEMSPACE mem = addr_memspace(address);
    uint16_t addr = addr_location(address);
    checkpoint_list_t *ptr;

    ptr = search_checkpoint_list(breakpoints[mem], addr);

    if (ptr) {
        /* there's a breakpoint, so enable it */
        ptr->checkpt->enabled = e_ON;
    } else {
        /* there's no breakpoint, so set a new one */
        breakpoint_add_checkpoint(address, address,
                                  TRUE, e_exec, FALSE, FALSE);
    }
}

void mon_breakpoint_unset(MON_ADDR address)
{
    MEMSPACE mem = addr_memspace(address);
    uint16_t addr = addr_location(address);
    checkpoint_list_t *ptr;

    ptr = search_checkpoint_list(breakpoints[mem], addr);

    if (ptr) {
        /* there's a breakpoint, so remove it */
        remove_checkpoint_from_list( &all_checkpoints, ptr->checkpt );
        remove_checkpoint_from_list( &breakpoints[mem], ptr->checkpt );
    }
}

void mon_breakpoint_enable(MON_ADDR address)
{
    MEMSPACE mem = addr_memspace(address);
    uint16_t addr = addr_location(address);
    checkpoint_list_t *ptr;

    ptr = search_checkpoint_list(breakpoints[mem], addr);

    if (ptr) {
        /* there's a breakpoint, so enable it */
        ptr->checkpt->enabled = e_ON;
    }
}

void mon_breakpoint_disable(MON_ADDR address)
{
    MEMSPACE mem = addr_memspace(address);
    uint16_t addr = addr_location(address);
    checkpoint_list_t *ptr;

    ptr = search_checkpoint_list(breakpoints[mem], addr);

    if (ptr) {
        /* there's a breakpoint, so disable it */
        ptr->checkpt->enabled = e_OFF;
    }
}