戻る

ESP32-S3でネイティブ動作するMetal Gear Solid

ドック上でMetal Gear Solidを動作させるXIAO ESP32S3携帯機、右上にレーダーが表示されている

私は子供の頃からMetal Gear Solidが大好きでした。小さなESP32-S3ボードを手に入れたとき、ひとつの疑問が頭から離れませんでした。こんなに小さなものでPlayStationのゲームが動くのだろうか?

Seeed Studio XIAO ESP32S3 Sense — カメラボードを取り付けた状態で21 × 17.8 × 15 mm(写真 — Seeed Studio)

使用したボードはSeeed Studio XIAO ESP32S3 Senseです。デュアルコアESP32-S3に8 MBのPSRAMと8 MBのフラッシュを搭載し、モジュールサイズは21 × 17.8 mmです。SenseバージョンにはカメラとmicroSDスロットを備えた拡張ボードが付属しており、ゲームのデータはこのmicroSDスロットに置かれています。

答えを見つけるまでにかなりの時間を費やしました。まず、PC上で動作するCコードとしてすでに再構築されたバージョンのゲームを探し、次にそのロジック全体がESP32-S3のフラッシュとmicroSDカードに収まるかどうかを確認しました。何度か試行錯誤しましたが、最終的にはうまくいきました。素晴らしいゲームが、約15米ドルのマイコンボード上で動作するようになったのです。

携帯機でのゲームプレイ — YouTubeで視聴する。

本記事では、Metal Gear Solid(PlayStation、1998年)がESP32-S3上でネイティブ移植としてどのように動作するかを解説します。FoxdieTeamのmgs_reversing逆コンパイルプロジェクトによって再構築されたゲームのCソースは、Xtensaマシンコードへ直接コンパイルされます。かつてPlayStationのハードウェアが提供していたものはすべて、ソフトウェアで置き換えられています。

本記事では、ハードウェア、プラットフォーム層、メモリ配置、デバッグ手法、最も重要だったバグ、性能、携帯機、そしてまだ動作しないものについて扱います。

コードと関連プロジェクト:

自分のディスクが必要です。リポジトリにはゲームから派生したものは一切含まれておらず、port/extract_disc.pyが自分のディスクイメージからファイルを抽出します。

ハードウェア

ドック上で携帯機を使ってMetal Gear Solidをプレイする様子

ESP32-S3は240 MHzで動作する2つのXtensaコアと512 KBの内蔵SRAMを備えています。ここで使用した両ボードには8 MBのPSRAMも搭載されており、フラッシュと同じキャッシュの背後に配置されています。

Waveshare ESP32-S3-Touch-LCD-2DIY携帯機(Seeed XIAO ESP32S3 Sense)
パネルST7789、320x240ILI9341、320x240ネイティブ
フラッシュ16 MB8 MB
ゲームデータmicroSD、またはフラッシュ内のトリミング済みSTAGE.DIRmicroSD(完全なSTAGE.DIR)
入力シリアル経由のキーボード(play.py)ドローンジンバルスティック、6ボタン抵抗ラダー、2つの直接ボタン

コードを書く前にギャップを測る

移植コードを書く前に、逆コンパイル版がXtensa向けにビルドするまでどれだけ離れているかを測定しました。

失敗した1つのファイルlibdg/chanl.cは、意図的に失敗させたままにしました。警告を黙らせるためのキャストは、ストライドを暗黙的に変えてしまうからです(後述のオーダリングテーブルのセクションを参照)。

残りは機械的なパスで対応し、それぞれが問題のクラス全体を解決しました。

結果は497ファイル中497のCファイルがXtensa向けにコンパイル成功でした。ELFは未定義参照0、重複定義0でした(text 987,073 B、bss 2,434,276 B)。ゲーム自身のメモリは804 KiB(428 KiBのヒープと2つの188 KiBパケットバッファ)で、PSRAMに余裕を持って収まります。

アーキテクチャ

この移植には、ゲームとSoCの間に3つの層があります。

移植の3層と2つのコア — すべてのmtsタスクとvblankティックはコア0、LCDスキャンアウトはコア1、LCDとmicroSDはSPI2を共有

ゲームからハードウェアまでの層は次のとおりです。

  1. MGSエンジン — 逆コンパイルされたC、Xtensaへコンパイル
  2. psyz — CによるPlayStation SDKとGTE、ソフトウェアラスタライザ
  3. プラットフォーム層 — FreeRTOS上のmtsスケジューラ、vblankティック、仮想CD、LCD、入力
  4. ESP32-S3

psyzとGTE

psyzはXeeynamoによるPlayStation SDKの再実装で、GTEのレジスタファイル全体とすべてのGTE命令をすでにCでモデル化しており、PCSX-ReduxのGTEテストスイートで検証済みでした。

当初の見積もりでは、不足しているマクロは64〜70個でした。この見積もりは過大でした。MGSは独自のMIPSインラインアセンブリヘッダ(inline_n.h、inline_x.h)を同梱しており、-fsyntax-onlyはレジスタ名をチェックしません。これらのヘッダをpsyzへ振り向けた時点で、実際の不足は41マクロでした。各マクロがどのCOP2レジスタに触れるかの仕様としてゲーム自身のアセンブリを使い、それらをpsyzに追加しました。その後、修正したpsyzに対して他のpsyzベースのプロジェクトを再ビルドし、何も壊れていないことを確認しました。

GTEマクロをエイリアスするときは、各制約が入力か出力かを確認してください。たとえばgte_read_opzは"=r"出力を持つので、そのエイリアスは&xを取る必要があります。

オーダリングテーブルのタグ — PSXでは1ワード、psyzでは2ワード

これが最も重要なレイアウトの違いであり、最も多くのバグを引き起こしました。PlayStationでは、すべてのプリミティブは1つの32ビットタグで始まります。次のプリミティブのアドレス24ビットと、長さ8ビットです。ホストのポインタは24ビットに収まらないため、psyzは2ワード、tagとlenを使います。すべてのプリミティブは4バイト増え、タグ以降のすべてのフィールドは1ワード分ずれます。

MGSはさらに長さバイトを悪用します。libdgは16ビット深度に対して2パスの基数ソートを実行します。

  1. divide.cが下位バイトでバケット分けし、上位バイトをタグの長さに退避します。
  2. sort.cがその上位バイトで再度バケット分けし、実際の長さを書き込みます。

psyzは2つのフィールドを分離しているため、変換は正確です。

pack->tag = (hi << 24) | *ot;  *ot = pack;     /* PSX */
addPrim(ot, pack); setlen(pack, hi);           /* psyz */

42個のローカル宣言と100個のパラメータをOT_TYPE*へ書き換えるのは簡単な部分でした。難しかったのは、パックされたレイアウトを前提としていることを明示せずに仮定していたコードです。

さらに厄介な要素があります。コンソールではaddPrim()が挿入のたびにタグワード全体を書き換えていたため、長さの設定忘れは決して気づかれませんでした。psyzでは、設定されなかった長さは単に書き込まれません。

FreeRTOS内のKonami製スケジューラ

MGSはKonami独自の協調スケジューラ上で動作します。起動バナーには今もMulti Task Scheduler for PSX ver2.02 Jul 11 1998と表示されます。これはBIOSのスレッドAPI(OpenTh/ChangeTh)上に位置し、vblank割り込みを使ってタイマーが期限切れになったタスクを起床させます。

移植では、各mtsスレッドはFreeRTOSタスクであり、同時に実行可能なのは常に1つだけです。最終的な設計は次のとおりです。

mts_GetTcbEntryは固定アドレス0x100にあるBIOSのテーブル・オブ・テーブルを読み、その結果を通じて書き込みもしていました。PSXの外ではそのアドレスはゴミを保持しているため、現在はプライベートなTCBテーブルを使用しています。

vblankティックと2つのクロック

port/esp32_vblank.cは16 msごとにゲームのVSyncコールバックを発火します。そのためにはVSyncCallback()をpsyzに実装する必要があり、そこではポインタすら保存されていませんでした。

VSync(-1)はフリーランニングのvblankカウントを返さなければなりません。最初のバージョンは提示されたフレーム数を返していたため、何も描画しないとカウントが進まず、タイマーが期限切れになることはありませんでした。

フレームレートは変動します。廊下では1フレームあたり2 vblank、広い部屋では4〜5です。そのため、vblankの仕事に見えて実はゲームフレームに属する2つのものがあります。

メモリ配置

すべての配置 — タスクスタックとホットループは内蔵SRAM、ゲームのRAMマップと1 MBのVRAMはPSRAM、ファームウェアはフラッシュ、STAGE.DIRはmicroSD

内蔵SRAMは乏しく高速です。PSRAMは豊富で低速です。フラッシュ読み出しはPSRAMも依存するキャッシュを無効化します。

このメモリマップにのみ存在するバグのクラスがあります。符号ビットに基づくポインタテストです。MGSはスクリプトブロックポインタと16ビットのproc idをproc_id < 0で区別します。PSX RAMは0x8xxxxxxxにあり、符号付き値としては負です。PSRAMは0x3Cxxxxxxにあり、正です。結果はPROC 3C1987D2 NOT FOUND、続いてEXCVADDR 0x00000003でのLoadProhibitedでした。GCL_IS_BLOCK_PTRマクロが、ヒットした箇所を修正します。同じパターンを持つ他の箇所はまだ監査が必要です。

FAT上の仮想CD

仮想CD — libfsが絶対セクタを要求し、virtual_cd.cがそれをmicroSD上のファイルとオフセットに変換して1セクタずつ返す

libfsは絶対セクタで動作します。ISO9660ディレクトリを一度読み、その後はファイル名を二度と使いません。port/virtual_cd.cがCD BIOSを置き換えます。

データは当初PSRAM上にあり、ゲームは少数のステージに制限されていました。本当の解決策はmicroSDでした。カードはSPIペリフェラルで、XIPフラッシュとは別であるため、読み出しが命令キャッシュを無効化しません。ファイルはカード上に留まり、PSRAMを消費しません。

カードとLCDはSPI2を共有しており、ESP-IDFは両者の間を調停しません。1つのLCDフレームは30個の非同期転送をキューに入れるため、フレームの途中でカード読み出しが起きるとassert failed: spi_hal_iram.c:134が発火し、再起動ループを引き起こしました。修正は明示的なバス所有権(Mgs_SpiBusTake/Give)で、バスを解放する前に進行中の転送をドレインします。

手法 — 推測せず、計測する

このプロジェクトで明らかと思われた説明のおよそ3分の1は、実際には間違っていた。うまくいったのは、仮説を決定づける数値をボードに出力させることだった。最も有用な教訓は、誤った答えを返したプローブから得られた。

ボードに書き込まずに各ビルドを実行する

この手法は試行のコストが低いときにしか機能しません。何時間も試行錯誤を続けると、変更のたびにボードへ書き込むのは安くありませんでした。USB で XIAO にイメージを書き込み、再起動を待ち、シリアルログを読み、また最初から。そこで各ビルドの実行と確認には Velxio のコマンドラインクライアント velxio-cli を使いました。ツールチェーンが生成したのと同じ .bin を受け取り、Velxio のシミュレートされた ESP32-S3 上で決まったシミュレーション時間だけ実行し、シリアル出力を返します。おかげで上記のプローブをハードウェアに触れずに読めました。ボードに新しいイメージを書き込むのは、そのビルドにその価値があるときだけでした。

# velxio.toml, next to the build: board = "xiao-esp32-s3", firmware = the merged .bin
velxio-cli run --timeout 5000 --timeout-exit-code 0 --serial-log-file serial.log .

インストールと最初の実行は数分で済みます。velxio-cli クイックスタートを参照してください。

バグ

携帯機でのゲームプレイ、右上にレーダー表示

strict aliasingが回転を削除した

白画面: 5つの誤った仮説、3つの真の原因

GPUサイズルール: GTEの-1024飽和限界で固定されたポリゴンが320x240画面に達する。PlayStation GPUは1023x511より大きいものを拒否するが、ソフトウェアラスタライザはそれを描画した

仮説4のカリング修正は、原因ではなかったものの、実際に効果があった。バウンディングボックステストは、ニアプレーンを横切るボックスを、完全にその背後にあるボックスと同じように扱っていた。2つのケースを分離することで、kept-saturatedは16,090から4,947になった。以前の試みは飽和座標に基づいており、画面テストが拒否したものの97%を救出した(ラスタライズ+40%)。大きく遠い壁も飽和するからだ。Zについて直接問い合わせる(SZ <= H/2)と、15,000ではなく1,440が得られた。

Square0が12ビットシフト: すべての距離が/64に

Snakeは3歩進み、壁に当たり、跳ね返り、決して前進しなかった。フレームレートが最初の容疑者だった。1つの観察がそれを除外した。ワールドは正常に動き、プレイヤーだけが動かなかった。GM_ActControlのプローブは、+4481のステップに続いて-14641のリバウンドを示した。

PSY-Qでは、数値サフィックスがシフトである。Square0はシフトせず、Square12はシフトする。移植版のSquare0は12だけシフトしていたため、すべてのSquare0 -> sum -> sqrtの長さが/64になった。これが壊したもの:

シフトを削除すると、軌道は単調になった。

間違った行からコピーされた5つのGTEオペコード

Snakeはワールドから落ち(Y = -3250)、移動は1フレームあたり0,1に固定され、ドックには水がなかった。psyzのPsyz_GteRtv0/Rtv1/Rtv2/Ll/Llv0は、MGS自身のinline_n.hテーブルの間違った行からMVMVAオペコードを使用していた。「このベクトルを回転」が「それを回転し、古い平行移動を加算」になり、ライティングはライト行列ではなく回転行列を使用していた。

修正後:

空のドックは2パスのスクリプトだった

ドックにはほんの一握りのオブジェクトグループしかなく、スクリプトは1つのコマンドを実行しているように見えた。s00aの実際の構造はif (var[5] < 6) { set up the Colonel's call } else { build the dock }であり、コールのprocはrestartである。ワールドは2パス目で構築され、コーデックに応答することがそれをトリガーする。

私はクラッシュを避けるために自分でコーデックをマスクしており、それがすべてのステージのすべてのradio -c ... -p procを無効にしていた。MENU_RadioDrainHeadlessは現在、コーデック画面を開かずにコールに応答し、そのprocをディスパッチする。オブジェクトグループは120フレームあたり480から3,240になり、水エリアが作成された。教訓: 一時的なスタブには、それを再訪することを強制する何かが必要である。

ゼロ除算: MIPSは生き残る、Xtensaは再起動する

libhzd/near.cは、退化したケースでゼロになりうる2D長の二乗で除算する。R3000は未定義の結果で続行する。XtensaはIntegerDivideByZeroを発生させ、ボードはリセットする。HZD_DIVは7つの実行時除数除算に適用された。その後、4方向すべてに80秒歩行する、以前クラッシュしていたパターンで、パニックは0だった。この移植では、計算された除数によるすべての除算にガードが必要である。

17.6分のフリーズ

psyzのVSyncはすべてのモードで結果を16ビットに切り詰めていたが、VSync(-1)は32ビットのフィールドカウントを返さなければならない。65,536フィールド(60 Hzで17.6分)で、タスクが65,537を待っている間にmtsクロックが64,800から1,064にラップし、永遠に待ち続けた。修正はmode < 0に対して完全なカウントを返す。これはpsyz上に構築されたすべてのプロジェクトに影響する。経過時間に依存するバグは、60秒のテストでは決して現れない。

ハングに見えたブート

何時間もの間、ブートはスタックしているように見えた。Konamiのmts_printfはPSXでは空のスタブであり、私の#define printf mts_printfがゲームのすべての出力をそこに送っていたため、ブートは静かに進行していた。mts_printfがvprintfを呼ぶと、ログはゲームがmemcard_init()に到達したことを示した。ハングを診断する前に、出力がどこかに行っていることを確認せよ。

mallocの失敗だった優先度デッドロック

ファイルデーモン(タスク10)は決してCPU時間を得られず、トレースは優先度デッドロックのように見えた。2つの実際の修正(ChangeThFromISRのセマンティクスとVSync(-1)クロック)は何も変えなかった。そして1行がそれを決着させた: [thread] OpenTh: xTaskCreate failed。

私はスタックを32 KBに引き上げており、FreeRTOSはそれらを内部SRAMから取るため、4番目のタスクが収まらなかった。OpenThは-1を返し、ChangeThはそのtidを永遠に拒否した。このSoCでは、PSRAMが数メガバイト空いていても、常にxTaskCreateの戻り値をチェックせよ。

カットシーンデータを追加した後の黒画面

DEMO.DAT、VOX.DAT、ZMOVIE.STRをカードにコピーすると画面が黒くなった。720フレーム、パニック0、送信されたプリミティブはゼロ。

ステージ変更コードはGM_StreamStatus() == -1を待つ。カットシーンのDEMO.DATストリームは決して進まなかった。仮想CDはセクタ読み取りを提供するが、連続リングバッファストリーミングパスは提供しないからだ。ファイルが存在する前は、ストリームは早期に拒否され、すべてが続行していた。

現在の処理:

より小さなバグ

パフォーマンス

ラスタライズ時間はラスタライザ内の esp_timer カウンタで、同じ位置で120フレームにわたって合計した値です。

最初の計測はs07aの小さな部屋で行いました。ラスタライズ時間の合計は923,000から903,900、次に794,000、そして741,700マイクロ秒へと減少しました(1フレームあたり7.69から6.18 ms)。3つのステップは次のとおりです。

  1. MGSのビルドでは SOFT_RASTER_IRAM が空だったため、ピクセル単位のループがフラッシュから実行されていました。これは IRAM_ATTR であるべきです。修正により-2%となりました。
  2. PSRAMとフラッシュを120 MHzにすると-12%となりました。 当初はこのボードでは無理だと結論づけました。「FLASH and PSRAM Mode configuration are not supported」というエラーは、単に CONFIG_IDF_EXPERIMENTAL_FEATURES=y が欠けていることを意味するだけです。生成された sdkconfig.h の CONFIG_SPIRAM_SPEED 120 を確認してください。
  3. スキャンアウトが30 fpsのゲームに対して62.5 Hzで動作していました。 プッシュの半分は同じ画像を再送しており、そのたびに約120 KBのPSRAMを読み込み、もう一方のコアにあるラスタライザのテクスチャを追い出していました。ゲームのレートに合わせることで-6.6%となりました。

フレーム時間:s07aのラスタライズが3ステップで7.69から6.18 msへ減少し、ドックのフレームはラスタライズ40.9 msに加えて約25 msのロジック、33.3 msの目標に対して約15 fps

ドック(s00a) ははるかに重いです。そこのプロファイルでは1フレームあたり46,400のテクスチャ付きピクセルと71,680のフラットピクセルが計測されました。ラスタライズに40.9 ms、加えてロジックとGTEに約25 msで、およそ15 fpsです。READMEには現在、敵がいるドックで約15 fpsと記載されています。ステータスドキュメントにはシーン別に8から15 fps、目標は30と記載されています。

フラットフィル用の32ビット高速パスはわずか2%の改善しか得られませんでした。コストはテクスチャ付きピクセルにあり、1ピクセルあたり約207サイクルです。2Dゲームは同じラスタライザではるかに高速に動作します。タイルマップはテクスチャを直線的に辿り、1つの64バイトキャッシュラインが128ピクセルに寄与します。MGSの回転した三角形では、UとVの両方がピクセルごとに変化し、ほぼすべてのピクセルがキャッシュミスとなります。データキャッシュはすでに64 KBの上限に達しています。

次のステップは、ホットなテクスチャページを内部SRAMへ移動することです。ステータスドキュメントでは40倍高速になると見積もられています。そのためには、過大なmtsスタックに閉じ込められている約90 KB(大きなタスクに24 KB、残りに6 KB)が必要です。UVはモデルに焼き込まれているため、テクスチャを縮小するという選択肢はありません。

ローディングも遅いです。カードから1.1 MBを読み込むのに約11.5秒かかります(およそ95 KB/s)。

携帯機の立ち上げ

携帯機の配線:XIAO ESP32S3 Sense、ILI9341パネル、D0/D1のアナログスティック、D2の6ボタン抵抗ラダー、D5/D7の2つの直接ボタン

 perfboard上の組み立て済み携帯機:左にアナログスティック、中央にボタンラダーの抵抗、下部にXIAO

携帯機は以下から構成されています。

XIAO ESP32S3 Senseの箱に入っているもの:カメラ付きのボード、Wi-Fiアンテナ、ピンヘッダ、ヒートシンク(写真:Seeed Studio)

XIAOの11本のピンすべてを使用しています。配線はハードウェアガイドに記載されています。立ち上げ時のメモ:

MGSは現在、携帯機上で起動し、カードをマウントし、ドックをロードし、パニックなしで動作します。フレームレートはREADMEがWaveshareボードと同程度と記載しています。

まだ動作しないもの

次のステップ

  1. mtsスタックを適正なサイズにし、ホットなテクスチャページを内部SRAMへ移動する。
  2. XIAOで120/120 MHzのメモリクロックを計測する。
  3. RADIO.DAT のインデックスを修正し、エレベーターがそれに続くか確認する。
  4. 仮想CDにストリーミングを実装し、カットシーンとボイスを取り戻す。
  5. ソフトウェアSPUを通じてオーディオを追加する。
  6. デバッグプローブを削除する。

結論

PlayStationは型パンニング、ゼロ除算、配列の範囲外読み取り、符号検査されたポインタを許容します。現代のコンパイラとCPUはそのいずれも許容しません。この移植でうまくいったアプローチは、あらゆる計測を失敗しうるように設計することでした。


共有:
David Montero

執筆者

David Montero

Creator of Velxio, the open-source circuit and Arduino simulator.

GitHub velxio.dev

関連記事


前の記事
Castlevania: Symphony of the Night が ESP32-S3 上でネイティブ動作
次の記事
222個のSeeed Groveモジュールがブラウザで動作するようになりました