ysyx-workbench/npc/csrc/Flow/gdbstub_wrapper.cpp

extern "C" {
#include <gdbstub.h>
}
#include "components.hpp"
#include <VFlow.h>
#include <config.hpp>
#include <cstdint>
#include <cstdlib>
#include <devices.hpp>
#include <string>
#include <types.h>
#include <vl_wrapper.hpp>
#include <vpi_user.h>
#include <vpi_wrapper.hpp>

using Registers = _RegistersVPI<uint32_t, 32>;
using VlModule = VlModuleInterfaceCommon<VFlow, Registers>;

// SDB::SDB<NPC::npc_interface> sdb_dut;
bool g_skip_memcheck = false;
VlModule *top;
Registers *regs;
vpiHandle pc = nullptr;

const size_t PMEM_START = 0x80000000;
const size_t PMEM_END = 0x87ffffff;

extern "C" {
/* === Memory Access === */
using MMap = MemoryMap<Memory<128 * 1024>, Devices::DeviceMap>;
void *pmem_get() {
  static Devices::DeviceMap devices{
      new Devices::Serial(0x10000000, 0x1000),
      new Devices::RTC(0x10001000, 0x1000),
  };
  static auto pmem = new MemoryMap<Memory<128 * 1024>, Devices::DeviceMap>(
      std::make_unique<Memory<128 * 1024>>(config.memory_file, true, PMEM_START,
                                           PMEM_END),
      std::make_unique<Devices::DeviceMap>(devices));
  return pmem;
}

int pmem_read(int raddr, int rmask) {
  void *pmem = pmem_get();
  auto mem = static_cast<MMap *>(pmem);
  // TODO: Do memory difftest at memory read and write to diagnose at a finer
  // granularity
  if (g_skip_memcheck)
    return mem->read(PMEM_START, rmask);
  return mem->read(raddr, rmask);
}

void pmem_write(int waddr, int wdata, char wmask) {
  void *pmem = pmem_get();
  auto mem = static_cast<MMap *>(pmem);
  return mem->write((std::size_t)waddr, wdata, wmask);
}

/* === For gdbstub === */

int npc_read_mem(void *args, size_t addr, size_t len, void *val) {
  void *pmem = pmem_get();
  auto mmap = static_cast<MMap *>(pmem);
  return mmap->copy_to(addr, (uint8_t *)val, len);
}

int npc_write_mem(void *args, size_t addr, size_t len, void *val) {
  void *pmem = pmem_get();
  auto mmap = static_cast<MMap *>(pmem);
  return mmap->copy_from(addr, (uint8_t *)val, len);
}

int npc_read_reg(void *args, int regno, size_t *value) {
  if (regno == 32)
    *value = regs->get_pc();
  else
    *value = (*regs)[regno];
  return 0;
}

int npc_write_reg(void *args, int regno, size_t value) { return 1; }

inline void breakpoint_to_action(const Breakpoint *bp, gdb_action_t *res) {
  if (bp == nullptr) {
    res->reason = gdb_action_t::ACT_NONE;
    return;
  }
  switch (bp->type) {
  case BP_SOFTWARE:
    res->reason = gdb_action_t::ACT_BREAKPOINT;
    break;
  case BP_ACCESS:
    res->reason = gdb_action_t::ACT_WATCH;
    break;
  case BP_WRITE:
    res->reason = gdb_action_t::ACT_WWATCH;
    break;
  case BP_READ:
    res->reason = gdb_action_t::ACT_RWATCH;
    break;
  }
  res->data = bp->addr;
}

void npc_cont(void *args, gdb_action_t *res) {
  DbgState *dbg = (DbgState *)args;
  const Breakpoint *stopped_at = nullptr;
  stopped_at = top->cont(*dbg->bp);
  breakpoint_to_action(stopped_at, res);
}

void npc_stepi(void *args, gdb_action_t *res) {
  DbgState *dbg = (DbgState *)args;
  const Breakpoint *stopped_at = nullptr;
  stopped_at = top->stepi(*dbg->bp);
  breakpoint_to_action(stopped_at, res);
}

bool npc_set_bp(void *args, size_t addr, bp_type_t type) {
  DbgState *dbg = (DbgState *)args;
  for (const auto &bp : *dbg->bp) {
    if (bp.addr == addr && bp.type == type) {
      return true;
    }
  }
  dbg->bp->push_back({.addr = addr, .type = type});
  return true;
}

bool npc_del_bp(void *args, size_t addr, bp_type_t type) {
  DbgState *dbg = (DbgState *)args;
  for (auto it = dbg->bp->begin(); it != dbg->bp->end(); it++) {
    if (it->addr == addr && it->type == type) {
      std::swap(*it, *dbg->bp->rbegin());
      dbg->bp->pop_back();
      return true;
    }
  }
  return false;
}

void npc_on_interrupt(void *args) { ; }

void npc_init(void *args) {
  DbgState *dbg = (DbgState *)args;
  void *mem = pmem_get();
  dbg->bp = new std::vector<Breakpoint>;
  dbg->cmd_return_buf = new std::string;

  top = new VlModule;
  regs = new Registers("TOP.Flow.ID.regs_regFile_",
                       "TOP.Flow.WB.msgio_in_bits_pc");
  top->setup(config.wavefile, regs);
  top->reset_eval(10);
}

char *npc_monitor(void *args, char **argv, int argc) {
  DbgState *dbg = (DbgState *)args;
  std::string *cmd_return_buf = dbg->cmd_return_buf;

  if (strncmp(argv[0], "trace", 5) == 0) {
    if (strncmp(argv[1], "on", 2) == 0) {
      *cmd_return_buf = "Tracing turned on\n";
      if (!top->start_trace())
        *cmd_return_buf = "Failed to turn on tracing\n";
      return cmd_return_buf->data();
    } else if (strncmp(argv[1], "off", 3) == 0) {
      *cmd_return_buf = "Tracing turned off\n";
      if (!top->end_trace())
        *cmd_return_buf = "Failed to turn on tracing\n";
      return cmd_return_buf->data();
    }
  }

  *cmd_return_buf = "Command not found\n";
  return cmd_return_buf->data();
}

bool npc_do_difftest = true;

static gdbstub_t gdbstub_priv;
arch_info_t npc_isa_arch_info{
    .target_desc = strdup(TARGET_RV32), .reg_num = 32, .reg_byte = 4};

size_t npc_dbg_state_size = sizeof(DbgState);

} // extern "C"

int gdbstub_loop() {
  DbgState dbg;

  target_ops npc_gdbstub_ops = {.cont = npc_cont,
                                .stepi = npc_stepi,
                                .read_reg = npc_read_reg,
                                .write_reg = npc_write_reg,
                                .read_mem = npc_read_mem,
                                .write_mem = npc_write_mem,
                                .set_bp = npc_set_bp,
                                .del_bp = npc_del_bp,
                                .on_interrupt = NULL};

  if (!config.do_debug) {
    gdb_action_t res;
    npc_init(&dbg);
    npc_cont(&dbg, &res);
    return !(res.reason == gdb_action_t::ACT_SHUTDOWN);
  }

  if (!gdbstub_init(&gdbstub_priv, &npc_gdbstub_ops,
                    (arch_info_t)npc_isa_arch_info, NULL,
                    config.gdbsocket.c_str())) {
    return EINVAL;
  }
  npc_init(&dbg);

  bool success = gdbstub_run(&gdbstub_priv, &dbg);
  // gdbstub_close(&gdbstub_priv);
  return !success;
}