Skip to content

README.md

Latest commit

 

History

History
211 lines (153 loc) · 11.1 KB

README.md

File metadata and controls

211 lines (153 loc) · 11.1 KB
Raw

run68mpx

Human68k の実行ファイル（.x / .r）を macOS などのターミナルで実行する CUI エミュレータです。

このリポジトリは、次の2系統の run68 を土台として、現行macOSで保守・改良を続けるために作成しました。

現在のソースは、macOS対応と近年のコンパイラ修正を含む GOROman/run68mac の最新版を基準にしています。Windows版の独自変更は履歴を保持し、内容を確認しながら段階的に取り込みます。詳しくは doc/upstreams.md を参照してください。

GOROman/run68macからの主な改良

GOROman/run68mac が実現したmacOS／Linux移植とCMake対応を土台に、run68mpxでは次の改良を加えています。

MC68000コアの精度

  • 32ビット演算をMC68000と同じラップアラウンドとして扱い、ホストC言語の符号付きオーバーフローへの依存を削減
  • 加算・減算・比較・条件判定のCCR（X/N/Z/V/C）計算を修正
  • 実効アドレス計算、絶対ショートの符号拡張、A7のバイト単位増減、PC相対／インデックスアドレスを修正
  • BRA／BSR／Bcc／DBcc／Scc、ADDX／SUBX、ABCD／SBCD／NBCD、MULU／MULS、DIVU／DIVS、MOVEM、シフト／ローテートなどの境界条件とフラグ動作を修正
  • Fライン算術の32ビット境界値、除算、浮動小数点変換を安全化

例外とスタック

  • 通常例外用の共通6バイトフレームと、アドレスエラー用のMC68000形式14バイトフレームを実装
  • USP／SSPのスタックバンク切り替えとRTEによる復帰を実装
  • 不正命令、ゼロ除算、TRAPV、特権違反、A／Fライン、TRAP、アドレスエラーを例外ベクタへ接続
  • 命令途中の奇数アドレスへのワード／ロングアクセスを中断し、ベクタ3のハンドラへ移行

メモリと実行ファイルローダ

  • 24ビットアドレスのラップ、ビッグエンディアンアクセス、アラインメント、確保領域境界の検査を強化
  • Xファイルのヘッダ、コード／データ／BSSサイズ、ロード上限、エントリアドレスを検証
  • 通常形式と拡張形式のリロケーション、非ゼロのリンクベース、BSS初期化に対応
  • 壊れたヘッダ、範囲外セクション、奇数リロケーション先などをロード前に拒否

macOS／POSIX対応

  • DOSCALL FILES／NFILES のワイルドカード列挙、属性、更新日時、ファイルサイズ、継続検索を実装
  • 64ビットMacで検索ハンドルを安全に管理し、検索終了時にHuman68k互換のエラーコード -18 を返すよう修正
  • DOS形式の日時とPOSIXの更新日時を相互変換し、FILEDATEの取得・設定に対応
  • コンソール入力、ファイルI/O、文字列処理で、バッファ境界やホストAPIのエラー処理を強化

CLI向けDOSCALL／IOCSCALL

  • DOSCALLのPUTCHAR、KEYSNS、KFLUSH、KEYCTRLの先読み、CURDRVをPOSIX端末で動作するよう修正
  • GETDATE／SETDATEとGETTIME／SETTIME／SETTIM2を仮想RTCへ接続。ゲストから日時を変更してもMac本体のシステム時計は変更しない
  • SETENV／GETENVでゲスト環境ブロックを更新・参照。GETSS、WAIT、SETPDB、MAKETMP、FATCHK、S_MALLOC／S_MFREEをCLI向けに接続（S_PROCESSによるサブメモリ管理は未対応）
  • -S sizeで実行時スタックサイズ（KB）を指定可能（既定64KB）
  • IOCSのB_KEYINP、B_KEYSNS、B_SFTSNS、KEY_INITを標準入力へ接続し、通常キーのX68000スキャンコードを返す
  • B_CURON、B_CUROFF、B_UP、B_DOWN、B_RIGHT、B_LEFT、B_CLR_ST、B_ERA_ST、B_INS、B_DELをANSIエスケープシーケンスで実装
  • DATEBCD、DATESET、TIMEBCD、TIMESET、DATECNV、TIMECNVを実装し、既存のDATEGET／TIMEGETのBCD形式と月計算を修正
  • ONTIMEを単調時計によるエミュレータ起動後の1/100秒カウンタとして実装
  • B_MEMSTR、B_BPOKE、B_WPOKE、B_LPOKE、B_MEMSETを実装し、アドレスレジスタと転送カウンタもIOCS仕様に従って更新
  • DMAMOVEの固定／増加／減少アドレスと両方向転送に対応し、ゲストメモリ境界検査を経由するよう安全化
  • 実験的なYM2151（OPM）I/O、Timer A/B、IOCS OPMSET／OPMSNS／OPMINTSTを実装し、MusashiコアからWAVへ出力
  • MSM6258 4-bit ADPCMデコードとIOCS ADPCMOUT／ADPCMSNS／ADPCMMODを実装し、OPM出力へミックス
  • PCM8互換のTRAP #2 HLEと8チャンネルADPCMミキサーを実装し、EX-PDXの音量・周波数・パン・一時停止／再開に対応

VRAM、物理ディスク、シリアル、マウスなど、上記以外の実機ハードウェアを必要とするIOCSCALLは、このCLI対応の対象外です。

ビルドと品質確認

  • Apple Silicon／Intel macOSおよびLinuxを対象にしたCI構成へ更新
  • CTestによる24系統の回帰テストを追加し、CPU命令、例外、メモリ、ローダ、スタックレイアウト、DOSファイル検索、CLI向けDOS／IOCS、Musashiバックエンド、OPM／ADPCM／PCM8音声を検証
  • AddressSanitizer／UndefinedBehaviorSanitizerを有効にできる RUN68_ENABLE_SANITIZERS オプションを追加
  • コンパイラ警告を強化し、現在のバージョン表示を 0.10.0 に更新

これらの変更は元の作者・移植者の成果を置き換えるものではなく、既存の互換性を維持しながら精度とmacOS上の安全性を高めることを目的としています。

対応環境

  • macOS（Apple Silicon / Intel）
  • Linux
  • Windows（MSYS / MinGW）
  • Emscripten（既存の実験的対応）

主な開発対象はmacOSです。

ビルド

CMake 3.13以降が必要です。macOSでCMakeを未導入の場合はHomebrewでインストールできます。

brew install cmake
cmake -S . -B build -DCMAKE_BUILD_TYPE=Release
cmake --build build --parallel

生成された実行ファイルは build/run68 です。

Xcodeプロジェクトを生成する場合:

cmake -S . -B build-xcode -G Xcode
open build-xcode/run68.xcodeproj

テスト

CPU命令、メモリアクセス、Xファイルローダ、macOS互換層の回帰テストをCTestで実行できます。

cmake -S . -B build -DBUILD_TESTING=ON
cmake --build build --parallel
ctest --test-dir build --output-on-failure

AddressSanitizerとUndefinedBehaviorSanitizerを使う場合:

cmake -S . -B build-sanitize -DBUILD_TESTING=ON -DRUN68_ENABLE_SANITIZERS=ON
cmake --build build-sanitize --parallel
ctest --test-dir build-sanitize --output-on-failure

実際のXファイル群を従来コアとMusashiで比較する場合:

python3 scripts/compare_cpu_backends.py \
  --run68 build/run68 \
  --samples /path/to/x-files \
  --include-r \
  --exclude-file scripts/corpus_exclude.example.txt \
  --json-out /tmp/corpus.json \
  --csv-out /tmp/corpus.csv \
  --fail-list /tmp/corpus-fail.txt \
  --timeout 5

各サンプルを短い一時パスへコピーして両バックエンドで実行し、終了状態、 標準出力、標準エラーを比較します。DIFFは exit_code / stdout / stderr / timeout_mismatch などに分類され、JSON/CSVへ出力できます。入力待ちや ハードウェア待ちのプログラムは指定秒数で打ち切り、--exclude-fileで除外できます。

使い方

./build/run68 program.x [引数...]

スタックサイズを変更する場合（単位はKB、既定は64）:

./build/run68 -S 128 program.x

MPUバックエンドは、従来コアが既定です。実験的なMusashiバックエンドは 次のように選択できます。

./build/run68 --cpu=musashi program.x [引数...]

macOSのデフォルト音声デバイスでYM2151／MSM6258／PCM8をリアルタイム再生する場合:

./build/run68 --cpu=musashi --audio=live program.x [引数...]

OPM／ADPCM／PCM8のミックス出力をWAVへ保存することもできます。

./build/run68 --cpu=musashi --audio=wav:output.wav program.x [引数...]

音声は62.5 kHz、16-bitステレオです。リアルタイム出力は現在macOSに対応しています。

tests/HAS.Xとtests/hlk.rがある場合、MXDRV用CLIランチャーをビルドできます。

cmake --build build --target mxplay
./build/run68 --cpu=musashi --audio=live \
  ./build/MXPLAY.X tests/mxdrv.x tests/BOM_01.MDX

ランチャーはMXDRV.XをDOSCALL EXECで子プロセスとして起動し、KEEPPRで 常駐した後、MDXをMXDRV転送形式へ整形してTRAP #4のLOADMMLとM_PLAYを 呼びます。キーが押されるまで演奏を続け、1キー入力を受けるとM_ENDで停止します。 MDXにPDX名が埋め込まれている場合はMDXと同じディレクトリから検索し、拡張子が 省略されていれば.PDXを補ってLOADPCMへ転送します。標準の96音色PDXによる MSM6258単音再生に加え、EX-PDXによるPCM8の最大8音多重再生に対応します。

--audio=liveまたは--audio=wav:...を指定すると、run68mpxはTRAP #2ベクタに PCM8常駐シグネチャを公開し、MusashiのTRAP HLEからホスト側ミキサーへ接続します。 そのため、MXDRVでPCM8曲を再生する際に別途PCM8.Xを常駐させる必要はありません。 現在の内蔵PCM8はMXDRVのPDXで使われる4-bit ADPCMレートに対応し、PCM8派生ドライバの 8-bit／16-bitリニアPCMモードは対象外です。

MusashiモードでもDOSCALL（0xFFxx）、FLOAT（0xFExx）、IOCSCALL （TRAP #15）はrun68mpxのホスト実装へ接続されます。現在は互換性比較を 優先して1命令ごとに既存のレジスタ状態と同期するため、速度は今後の最適化 対象です。

標準出力と標準エラー出力のShift-JIS文字列は、対応環境ではUTF-8へ変換されます。

ライセンス

GNU General Public License version 2（GPL-2.0）です。詳細は LICENCE を参照してください。

元プロジェクトと各移植・修正の作者、コントリビューターに感謝します。 YM2151エミュレーションにはAaron Giles氏のBSD 3-Clauseライセンスの ymfmを使用しています。

実験的MPUバックエンドには Karl Stenerud による Musashi を使用しています。取り込んだ コミットとライセンスについては third_party/musashi/UPSTREAM.md を参照してください。 ymfmの取り込み元については third_party/ymfm/UPSTREAM.md を参照してください。