--- nono/debugger/debugger_private.h 2026/04/29 17:04:37 1.1.1.3 +++ nono/debugger/debugger_private.h 2026/04/29 17:05:09 1.1.1.9 @@ -4,69 +4,227 @@ // Licensed under nono-license.txt // +// +// デバッガ (内部用) +// + #pragma once #include "branchhistory.h" #include "bus.h" -#include "cvprompt.h" +#include "monitor.h" #include "textscreen.h" +#include "thread.h" #include +#include +#include using ConstStringPair = std::pair; using HelpMessages = std::vector; +class HostCOMDevice; +class VectorTable; + // 諸情報付きのアドレス -struct saddr_t +class saddr_t { - uint32 addr = 0; // アドレス(32bit) + public: + // コンストラクタ + saddr_t() { } + + saddr_t(uint32 addr_, bool super_) + : saddr_t(addr_, super_, false) { } + + saddr_t(uint32 addr_, bool super_, bool data_) { + Set(addr_, super_, data_); + } + // コピーコンストラクタ + saddr_t(const saddr_t& rhs) { + Set(rhs); + } + // 代入演算子 + saddr_t& operator=(const saddr_t& rhs) { + Set(rhs); + return *this; + } + + // 代入演算子 (uint32 を代入するとアドレスだけ差し替える) + saddr_t& operator=(uint32 rhs) { + SetAddr(rhs); + return *this; + } + + // 代入 + void Set(uint32 addr_, bool super_, bool data_) { + addr = addr_; + super = super_; + data = data_; + } - // addr が論理アドレスなら true。 - // MMU の有効/無効状態はここにセットするのではなく、メモリアクセスに - // 際してアドレス変換を行う側がその時点で改めてチェックするので、 - // ここはどちらかというと物理アドレスなら false くらいの意味合い。 - bool logical = false; - - // addr が論理アドレスの場合に、テーブルサーチも行うなら true。 - // false なら TT、ATC のみ検索する。 - bool search = false; - - // addr がスーパバイザアクセスなら true。 - bool super = false; - - // addr がデータアクセスなら true。 - bool data = false; - - bool IsLogical() const { return logical; } - bool IsSearch() const { return search; } - bool IsSuper() const { return super; } - bool IsData() const { return data; } - bool IsInst() const { return !data; } - - // (論理)アドレスと Super/User ビットを合わせた 33bit アドレスを返す - uint64 GetSaddr() const { - uint64 sa = addr; - if (IsSuper()) { - sa |= 0x100000000ULL; - } - return sa; + uint32 GetAddr() const { return addr; } + bool IsSuper() const { return super; } + bool IsData() const { return data; } + void SetAddr(uint32 addr_) { addr = addr_; } + void SetSuper(bool super_) { super = super_; } + void SetData(bool data_) { data = data_; } + + // (uint32)saddr でアドレスだけ取り出せると楽 + explicit operator uint32() const { return GetAddr(); } + + // saddr += n でアドレス進められると楽 + uint32 operator+=(uint32 val) { + addr += val; + return addr; } + // saddr++ でアドレス進められると楽 + void operator++(int n) { + addr++; + } + + private: + void Set(const saddr_t& rhs) { + addr = rhs.addr; + super = rhs.super; + data = rhs.data; + } + + uint32 addr {}; // アドレス (32bit) + bool super {}; // スーパーバイザアクセスなら true + bool data {}; // データ空間アクセスなら true +}; + +enum class MemoryMode : bool +{ + Logical = false, + Physical = true, }; -enum MemdumpMode { - Physical = 0, // 物理アドレス - Logical_atc, // 論理アドレス (ただし TT、ATC のみ検索) - Logical_search, // 論理アドレス (TT、ATC、テーブルサーチすべて行う) +enum class MMULookupMode : bool +{ + False = false, + True = true, + // MemoryMode::Physical ならこの項は意味を持たないので、 + // True でも False でもないと言いたい。 + None = false, }; -class Console; -class DebuggerMD; +// saddr_t の後で Debugger の前... +#include "debugger_memory.h" + +class Debugger; class Disasm; -class Debugger final +// デバッガの CPU 依存部分 +class DebuggerMD { + public: + enum class Arch { + M680x0, + M88xx0, + }; + + public: + DebuggerMD(Debugger *parent_, Arch arch_) { + parent = parent_; + arch = arch_; + } + virtual ~DebuggerMD(); + + // CPU のリクエストフラグに flag を立てる + virtual void ReqSet(uint32 flag) = 0; + // CPU のリクエストフラグから flag を落とす + virtual void ReqClr(uint32 flag) = 0; + + // 特権モードなら true を返す + virtual bool IsSuper() const = 0; + // MMU が有効なら true を返す + virtual bool MMUEnabled() const = 0; + + // アドレス変換をする。 + // MMUEnabled() が true であることは呼び出し側が確認すること。 + // lookup が true ならテーブルサーチまで行う。 + // 変換できなければ (uint64)-1 を返す。 + virtual uint64 TranslateAddr(saddr_t laddr, bool lookup) const = 0; + + // 現在の命令先頭アドレスを返す + virtual uint32 GetPC() const = 0; + + // ステップアウトを設定する + virtual void SetStepOut() = 0; + // ステップアウトなら true を返す + virtual bool IsStepOut() const = 0; + + // この命令がステップイン出来るなら true を返す (cmd_n 用) + virtual bool IsOpStepIn(DebuggerMemoryStream& mem) = 0; + + // name で示されるのレジスタの値を返す。 + // メモリダンプで指定するケースを想定しているので、明らかにアドレスでは + // ないレジスタは含まなくてよい (m680x0 の SR など)。ただし Dn は含めて + // よい。また m680x0 の SRP/CRP は下位32ビットでよい。 + // name が正しくない場合は (uint64)-1 を返す。 + virtual uint64 GetRegAddr(const char *name) const = 0; + + // 現在のレジスタセットを内部にバックアップする + virtual void BackupRegs() = 0; + + // レジスタ表示系のコマンドを実行。処理すれば true を返す。 + virtual bool ShowRegister(FILE *, const std::vector& args) = 0; + // レジスタ表示系コマンドのヘルプ一覧を取得 + virtual const HelpMessages& GetHelpListReg() const = 0; + // レジスタ表示系コマンドのヘルプメッセージを取得 + virtual const HelpMessages& GetHelpReg() const = 0; + + // ブランチ履歴・例外履歴(オブジェクト)を取得 + virtual BranchHistory& GetBrHist() const = 0; + virtual BranchHistory& GetExHist() const = 0; + + // 直近の命令でアクセスした laddr が一致したら true を返す + // 1 命令で複数にアクセスする場合を考慮して、md 側で判断する + virtual bool CheckLEA(uint32 laddr) = 0; + + // 逆アセンブル。 + // mem.laddr の位置の命令を一つ逆アセンブルする。 + // 成功すれば true を返し、失敗すれば(?) false を返す。 + // 成功した場合 mnemonic に逆アセンブルした文字列が、 + // bin にこの命令のバイナリ列が格納されている。 + // mnemonic は単純に命令部分のみ、16進ダンプや付随情報は含まない。 + // bin はメモリイメージのバイト順で格納すること。 + virtual bool Disassemble(DebuggerMemoryStream& mem, + std::string& mnemonic, std::vector& bin) = 0; + + // 逆アセンブルをフォーマット。 + // オフライン版は逆アセンブルウィンドウなど、 + // オンライン版(Live) はデバッガプロンプトで表示するやつ。 + virtual std::string FormatDisasm(const std::string& mnemonic, + const std::vector& bin) = 0; + virtual std::string FormatDisasmLive(const std::string& mnemonic, + const std::vector& bin) = 0; + + // 機種 + Arch arch {}; + + // 最短の1命令のバイト数 + uint inst_bytes {}; + // 命令が固定長ならそのバイト数、可変長なら 0 + uint inst_bytes_fixed {}; + + protected: + Debugger *parent {}; // 親クラス +}; + +class Debugger : public ThreadDevice +{ + using inherited = ThreadDevice; friend class DebuggerMD_m680x0; friend class DebuggerMD_m88xx0; + private: + // リクエストフラグ + static const uint32 REQUEST_EXIT = 0x0001; // 終了 + static const uint32 REQUEST_RXCHAR = 0x0002; // 1文字受信 + static const uint32 REQUEST_ACCEPT = 0x0004; // 着信通知 + static const uint32 REQUEST_PROMPT = 0x0008; // プロンプト要求 + // 型 enum CommandAction { Stay, // デバッガプロンプトに留まる @@ -74,11 +232,11 @@ class Debugger final Quit, // デバッガとの接続を終了する }; using cmdfunc_t = void (Debugger::*)(); - typedef struct { + struct cmddef_t { const char *name; cmdfunc_t func; CommandAction action; - } cmddef_t; + }; // ブレークポイント種別 enum BreakpointType { @@ -90,7 +248,7 @@ class Debugger final }; // ブレークポイント - typedef struct { + struct breakpoint_t { BreakpointType type {}; // 種別 // 種別ごとのパラメータ union { @@ -113,25 +271,46 @@ class Debugger final // n(>0) なら n 回の成立をスキップし、(n+1) 回目でブレークの意。 int32 skip {}; // スキップ回数 (ユーザ指定値) int32 skipremain {}; // 残りスキップ回数 (0 で成立) - } breakpoint_t; + }; static const int MAX_BREAKPOINTS = 8; public: Debugger(); - ~Debugger() { } + ~Debugger() override; - void Init(); - void ThreadRun(); - bool Check(); + void SetLogLevel(int) override; + bool Create() override; + bool Init() override; + void ThreadRun() override; + void Terminate() override; + + void Exec(); void NotifyException(int vector); - // ブレークポイントモニタを更新 - void MonitorBreakpoint(TextScreen& monitor); + // MPU トレースが必要なら true を返す + bool IsTrace() const; + + // FILE コールバック + int ReadFunc(char *, int); + int WriteFunc(const char *, int); + + // メモリダンプモニタ + // GUI 用 (show コマンドでも見れるけど) + std::array memdump_monitor {}; + + // m/M コマンド用のメモリダンプモニタ + Monitor m_monitor { this }; private: - bool Accept(); - bool AcquirePrompt(); - CommandAction MainLoop(); + void Close(); + void RxCallback(); + void AcceptCallback(); + void Input(int); + void EnterPrompt(); + void LeavePrompt(); + void PrintPrompt(); + + CommandAction Command(); bool CheckAllBreakpoints(); bool CheckBreakpointInst(breakpoint_t&); void ParseCmdbuf(); @@ -142,166 +321,130 @@ class Debugger final void cmd_bv(); void cmd_b_list(); void cmd_b_set(BreakpointType); + void cmd_b_delete(); void cmd_brhist(); void cmd_bx(); void cmd_c(); void cmd_d(); void cmd_dt(); void cmd_D(); + void cmd_disp(); void cmd_exhist(); void cmd_h(); + void cmd_hb(); + void cmd_hr(); void cmd_L(); void cmd_m(); void cmd_mt(); void cmd_M(); void cmd_minus(); void cmd_n(); + void cmd_nt(); void cmd_q(); + void cmd_reset(); void cmd_s(); + void cmd_st(); void cmd_so(); + void cmd_sot(); void cmd_show(); void cmd_t(); + bool Check(); int AddBreakpoint(const breakpoint_t&); void RecalcInstMask(); - bool GetAddr(uint32& addr, uint32& lastaddr); - void cmd_d_common(MemdumpMode mode); - void cmd_hist_common(BranchHistory& hist, uint64 flag); - void cmd_m_common(MemdumpMode mode); + bool GetAddr(saddr_t *addr, bool); + void cmd_d_common(MemoryMode access_mode, MMULookupMode lookup_mode); + void cmd_hist_common(BranchHistory& hist); + void cmd_m_common(MemoryMode access_mode, MMULookupMode lookup_mode); + void cmd_n_common(bool); + void cmd_s_common(bool); + void cmd_so_common(bool); bool ParseVerbHex(const char *arg, uint32 *valp); bool ParseAddr(const char *arg, uint32_t *addrp); - bool SetNBreakpoint(); + void SetNBreakpoint(); - static const HelpMessages HelpMsgMain; - void Help(const HelpMessages msgs); + static const HelpMessages HelpListMain; + static const HelpMessages HelpListBreakpoints; + static const HelpMessages HelpDetails; + void ShowHelpList(const HelpMessages& msgs); + + // 個別ヘルプメッセージを出力用に置換 + std::string HelpConvert(const std::string& msg); // モニターを更新して表示 - void ShowMonitor(IMonitor& monitor); + void ShowMonitor(Monitor& monitor); // テキストスクリーンを表示 void ShowTextScreen(TextScreen& screen); - // アドレスをダンプ表示用に整形して返す - bool FormatDumpAddr(saddr_t addr, std::string& addrstr); + std::unique_ptr md {}; // 機種依存部分 - DebuggerMD *md = NULL; // 機種依存部分 + std::mutex mtx {}; + // このスレッドへのリクエスト + std::condition_variable cv_request {}; + uint32 request {}; + // コマンドモード(プロンプト)なら true + std::condition_variable cv_prompt {}; + bool prompt_released {}; + + bool is_prompt {}; + + // コンソール + std::unique_ptr hostcom /*{}*/; + FILE *cons {}; - Console *cons = NULL; // 入出力 - const char *prompt; // プロンプト文字列 + const char *prompt {}; // プロンプト文字列 std::string cmdbuf {}; // 現在のコマンドライン std::string last_cmdbuf {}; // 直前のコマンドライン std::vector args {}; - uint32 pc = 0; - uint32 nextpc = 0; + uint32 pc {}; std::vector ir {}; // この後実行する命令のバイナリ列 std::array bpoint {}; - bool bc_enable = false; - uint32 bc_addr = 0; - uint32 bi_inst = 0; - int bi_inst_bytes = 0; - int bi_need_bytes = 0; + bool bc_enable {}; + uint32 bc_addr {}; + uint32 bi_inst {}; + int bi_inst_bytes {}; + int bi_need_bytes {}; int bv_vector = -1; - uint32 d_last_addr = 0; - uint32 m_last_addr = 0; - bool n_enable = false; - bool n_breakenable = false; - uint32 n_breakaddr = 0; - uint32 n_count = 0; - bool s_enable = false; - uint32 s_count = 0; - bool so_enable = false; - bool t_enable = false; - uint32 t_count = 0; + saddr_t d_last_addr {}; + saddr_t m_last_addr {}; + bool n_enable {}; + uint32 n_breakaddr {}; + uint32 n_count {}; + bool s_enable {}; + uint32 s_count {}; + bool so_enable {}; + bool t_enable {}; + uint32 t_count {}; // 一度VMを実行して再びプロンプトに来たら true - bool is_continued = false; + bool is_continued {}; - static std::vector cmdtable; -}; + // MPU を一時停止するとき true (ワンショット) + bool is_pause {}; -// デバッガの CPU 依存部分 -class DebuggerMD -{ - public: - DebuggerMD(Debugger *arg) { - parent = arg; - } - virtual ~DebuggerMD() { } + // プロンプトで表示するレジスタ群 + std::vector disp_regs {}; - // CPU のリクエストフラグに flag を立てる - virtual void ReqSet(uint32 flag) = 0; - // CPU のリクエストフラグから flag を落とす - virtual void ReqClr(uint32 flag) = 0; + // ブレークポイント到達メッセージ + // (コンソールが獲得できるまで保留しておくため) + std::string bpointmsg {}; - // 特権モードなら true を返す - virtual bool IsSuper() const = 0; - // MMU が有効なら true を返す - virtual bool MMUEnabled() const = 0; + // ブレークポイントモニタ + DECLARE_MONITOR_CALLBACK(MonitorUpdateBpoint); + Monitor bpoint_monitor { this }; - // アドレス変換をする。 - // MMUEnabled() が true であることは呼び出し側が確認すること。 - // 変換できなければ (uint64)-1 を返す。 - virtual uint64 TranslateAddr(saddr_t laddr) = 0; + // メモリダンプモニタ + DECLARE_MONITOR_CALLBACK(MonitorUpdateMemdump); - // 現在の命令先頭アドレスを返す - virtual uint32 GetPC() const = 0; + // ベクタテーブル + std::unique_ptr pVectorTable /*{}*/; - // ステップアウトを設定する - virtual void SetStepOut() = 0; - // ステップアウトなら true を返す - virtual bool IsStepOut() const = 0; - - // name で示されるのレジスタの値を返す。 - // メモリダンプで指定するケースを想定しているので、明らかにアドレスでは - // ないレジスタは含まなくてよい (m680x0 の SR など)。ただし Dn は含めて - // よい。また m680x0 の SRP/CRP は下位32ビットでよい。 - // name が正しくない場合は (uint64)-1 を返す。 - virtual uint64 GetRegAddr(const char *name) const = 0; - - // 現在のレジスタセットを内部にバックアップする - virtual void BackupRegs() = 0; - - // レジスタ表示系のコマンドを実行。処理すれば true を返す。 - virtual bool ShowRegister(Console *cons, - const std::vector& args) = 0; - // レジスタ表示系コマンドのヘルプメッセージを取得 - virtual const HelpMessages& GetRegisterHelp() const = 0; - - // ブランチ履歴・例外履歴(オブジェクト)を取得 - virtual BranchHistory& GetBrHist() const = 0; - virtual BranchHistory& GetExHist() const = 0; - - // 直近の命令でアクセスした laddr が一致したら true を返す - // 1 命令で複数にアクセスする場合を考慮して、md 側で判断する - virtual bool CheckLEA(uint32 laddr) = 0; - - // 逆アセンブル。 - // laddr の位置の命令を一つ逆アセンブルする。 - // 成功すれば true を返し、失敗すれば(?) false を返す。 - // 成功した場合 mnemonic に逆アセンブルした文字列が、 - // bin にこの命令のバイナリ列が格納されている。 - // mnemonic は単純に命令部分のみ、16進ダンプや付随情報は含まない。 - // bin はメモリイメージのバイト順で格納すること。 - virtual bool Disassemble(saddr_t laddr, - std::string& mnemonic, std::vector& bin) = 0; - - // 逆アセンブルをフォーマット。 - // オフライン版は逆アセンブルウィンドウなど、 - // オンライン版(Live) はデバッガプロンプトで表示するやつ。 - virtual std::string FormatDisasm(const std::string& mnemonic, - const std::vector& bin) = 0; - virtual std::string FormatDisasmLive(const std::string& mnemonic, - const std::vector& bin) = 0; - - // ベクタ番号の最大値 (+1) - int vector_max = 0; - // 1命令の最小ビット数 - uint inst_bits = 0; - - protected: - Debugger *parent; // 親クラス + static std::vector cmdtable; }; +extern Debugger *gDebugger; + #define NORM "\x1b[0m" #define BOLD "\x1b[1m" #define BOLDIF(n) ((n) ? BOLD : "")