アセンブリ言語・入門の前に（３）

最終回の主役はスタックポインタレジスタてす。

### １　今回のプログラム

今まではいつも１から１００までの合計を求めてきましたが、今回はその最後の数を外から与えることにします。要するに引数付きの関数を書こうというわけです。
登場するレジスタはすべてハーフサイズ（一部はフルサイズ）ですから、４００までの合計でも桁あふれは生じないでしょう。なお私のgccではunsigned intは４バイトで、ハーフサイズのレジスタと同じです。
main関数は次のようになりますね。


~~~c:with_arg.c
/*** function with argument (with_arg.c) ***/

#include <stdio.h>

extern unsigned int addsub(unsigned int);



int main(int argc, char **argv)

{ unsigned int answer;

  answer = addsub(400);
  printf("%d\n", answer);

  return 0;
}
~~~
実は作業にかこつけて、ここでスタックの説明をしたかったのです。

### ２　スタックとは

スタックはよく棚に積まれたお皿にたとえられます。最後に積まれたお皿は最初に取り除くのが自然ですよね。お皿を積むのがpush、取り除くのがpopです。
プッシュ、ポップの語感からお皿自体が動くように誤解されそうですが、お皿の位置は不変で、スタックポインタレジスタがスタックを管理しています。名前が長いので今後はスタックポインタと呼ぶことにしましょう。

### ３　スタックポインタの動き

スタックポインタの動きを正確に説明します。その起算点は（デフォールトでなく）常にスタックセグメントSSです。ここではスタックポインタの初期値は0xC000だとしましょう。
~~~
       memory
BFFA ｜      ｜
BFFB ｜      ｜
BFFC ｜      ｜
BFFD ｜      ｜
BFFE ｜      ｜
BFFF ｜      ｜
C000
~~~
ここでレジスタaxをプッシュします。axは２バイトですから、これがメモリに格納されて、スタックポインタの値はBFFEになります。なおプッシュは一種の代入命令で、作業後もaxの値は変わりません。
次にediをプッシュしましょう。これは４バイトですから格納後のスタックポインタの値はBFFAになります。
最後に積まれたお皿は最初に取り除くのでした。ediをポップするとediはスタックから４バイトを取得して元の値を復元し、スタックポインタの値はBFFEになります。更にaxをポップするとaxも元の値に戻り、スタックポインタの値は初期値のC000になります。（注１）
ついでですが、ポップの順番をまちがえたら？まずaxをポップするとaxには元のediの半分がはいり、スタックポインタの値はBFFCになります。次にediをポップするとediには元のediの残り半分と元のaxの値がはいります。どちらも使い物にならないデータですね:sweat:
このようにスタックポインタの値が自動的に変化するというのが、ほかのレジスタにない特性です。変化幅は２か４（フルサイズのレジスタならば８）です。
説明が前後しましたが、起算点であるSS（スタックセグメントレジスタ）と（スタックポインタの初期値マイナス１）の範囲にあるメモリが、正式の「スタック」の定義です。なお正常にプッシュポップをしている限り、初期値の指しているメモリにデータを書くことはありません。
スタックポインタはadd命令などで値を外から変えることもできますが、これは厳禁です。そんな必要はほとんど考えられませんし、プログラムを実行してもきっとヘンな結果になるでしょう。

### ４　main関数への配慮

昔の本に「レジスタをローカル変数と思うな。みんなグローバル変数だ」と書いてありました。アセンブリ言語の関数を書いているときは、作業が終わればレジスタの値などはどこかに消えるものだと思ってしまいますが、実際にはリターン命令のとき、すべてのレジスタはそのままmain関数に返されます。
main関数に悪影響を及ぼさないよう、アセンブリ言語側で使うレジスタは最初にプッシュし、リターンの直前にポップして元の値に戻すのがmain関数への配慮というものでしょう。たとえば第１回の第１案は、正式には次のように書くべきでした。（注２）
~~~asm:fragment
asmadd:
    push    cx          /* save cx */
    push    bx          /* save bx */

	movw	$0, %ax		/* initialize answer */
	movw	$100, %bx	/* set limit (actually constant) */
	movw	$1, %cx		/* initialize addend */
    /* manipulate bx and cx */
    /* ... */

    pop bx             /* restore bx */
    pop cx             /* restore cx */

   ret
~~~

### ５　スタック・意外な利用者

ＣＰＵはメモリに並べられた機械語を読みながらmain関数の命令を実行して行きますが、関数を呼ぶ命令に対しては、「main関数の次の命令がはいっているメモリのアドレス」をスタックにプッシュしてから、呼ばれた関数の先頭にジャンプします。呼ばれた関数でリターン命令にぶつかると、ＣＰＵはさっきプッシュしておいたアドレスをポップして取り出し、main関数の実行を続けます。因みにアドレスのサイズは８バイトです。
こういう事情ですから、呼ばれた関数の中でプッシュしたレジスタは、その関数からリターンする前にすべてポップする必要があります。さもないとＣＰＵがプッシュしたアドレスを再取得することができなくなってしまいます。

### ６　ベースポインタレジスタ

このメモで初登場のレジスタです。これも名前が長いのでベースポインタと呼ぶことにしましょう。起算点はスタックポインタと同じでスタックセグメントSSです。
名前のとおりポインタですから、メモリの内容を参照できるのは当然ですが、ベースポインタの得意技として、丸かっこの左側に正負の数値を書けば付近のメモリの内容も参照できます。これは使い方の全体像を示す方が早いでしょう。（注２－２）
~~~
	push %rbp			    /* copy main's rbp in stack */
    mov	%rsp, %rbp		    /* rbp == rsp now */

	mov	0x08(%rbp), rax 	/* get main's rbp */
~~~
マルチタスクのＯＳではスタックポインタは外から（おそらくユーザーごとに）与えられるもので、フルサイズの可能性があるのでrspにしました。そのコピー先であるrbpも同様です。２行目はコピー命令で、rbpの値がrspと同じになりました。
次の１行はサンプルですが、さっきプッシュしたrbpの値をraxにコピーしています。
ところでスタック全体の状況を眺めてみると、上の方（アドレスの大きい方）はプッシュされたrbpやＣＰＵがプッシュしたアドレスなどが詰まっていますが、反対側は使われていません。ここに関数のローカル変数を格納することにしましょう。

### ７　アセンブリ言語の関数の完成

もうひとつ必要な情報がありました。引数の取得方法です。[Linux x64 Calling Convention](https://www.ired.team/miscellaneous-reversing-forensics/windows-kernel-internals/linux-x64-calling-convention-stack-frame)によれば、引数は左からrdi、rsi、rdx、rcxの順番で渡されます。われわれの引数はunsigned intで４バイトですから、実引数はediにはいっている筈です。
これでアセンブリ言語による関数を書けますね。

~~~asm:argument.s
/*** 'addsub' with argument (argument.s) ***/

	/*-- note: argument in %edi --*/
	/*-- note: %edi is unchanged (a constant) --*/

	.globl	addsub			/* global .. called by 'main' */
	.type	addsub, @function

	/* -0x04	answer (%eax) */
	/* -0x08	addend (%ecx) */
	/* -0x0c	thelimit (== argument) */

addsub:
	pushq	%rbp			/* copy %rbp in stack */
	mov	%rsp, %rbp		    /* %rbp == %rsp now */

	mov	%edi, -0x0c(%rbp)	/* store argument */
	mov	$0x0000, %eax		/* answer = 0 */
	mov	%eax, -0x04(%rbp)	/* store answer */
	mov	$0x0001, %ecx		/* addend = 1 */
	mov	%ecx, -0x08(%rbp)	/* store addend */

asmadd_l:
	mov	-0x04(%rbp), %eax	/* %eax = answer */
	add	-0x08(%rbp), %eax	/* answer += addend */
	mov	%eax, -0x04(%rbp)	/* store answer */
	mov	-0x08(%rbp), %ecx	/* %ecx = addend */
	inc	%ecx			    /* addend++ */
	mov	%ecx, -0x08(%rbp)	/* store addend */
	mov	-0x08(%rbp), %ecx	/* %ecx = addend again */
	mov	-0x0c(%rbp), %edi	/* %edi = thelimit */
	cmp	%ecx, %edi		    /* try (thelimit - addend) */
	jnc	asmadd_l		    /* jump if addend <= thelimit */

	mov	-0x04(%rbp), %eax	/* (unnecessary ^_^) */
	popq	%rbp			/* restore former %rbp */

	ret
~~~
ローカル変数とレジスタとの間でやたらにデータをやり取りしていますが、もともと「ローカル変数の使い方」みたいなプログラムですから、このままにしておきましょう。
足し算の結果は「400 * (1+400) / 2」ですから80200の筈です。読者のマシンは正しい答えを表示しましたか。

### ８　引数の受け渡し

引数の受け渡しには昔から２種類のやり方があって、片方はgccのようにレジスタを使う方法、もうひとつは実引数を右側からプッシュしてから関数を呼ぶ方法です。
まあ昔話はさて措き、読者はすでにスタックを理解しておられますから、実引数をプッシュする方法にも対処できる筈です。スタックポインタの上の方（アドレスの大きい方）を見ると、いちばん近くに８バイトのrbpがあり、その上にＣＰＵがプッシュした８バイトのアドレスがありますから、その更に上に４バイト（unsigned int）の実引数があります。
取り付きにくいアセンブリ言語の中でもスタックは特に取り付きにくい部分ですが、わかってしまえば簡単ですよね。
さて、読者のウォーミングアップもそろそろ終わりです。締めくくりとして次の一言を加えておきましょう。

### ９　アセンブリ言語の存在意義

アセンブリ言語を使えば、ＣＰＵの能力をすべて利用することができます。機械語の命令には、必ずそれに対応するアセンブリ言語が用意されています。アセンブリ言語で書けないような仕事は、そのＣＰＵにはできません。

### 終わりに（雑談です）

私がＴＫ－８０を買ってから、５０年近くが経過しました。今のマシンもあの機械と同様に、メモリに並べられた機械語を１バイトずつ読みながら命令を実行しているわけですが、メモリも補助記憶装置もサイズが飛躍的に増え（注３）、コンパイラも人間の書いたプログラムを添削するほど賢くなりました。
私はＡＩのことは何も知りませんが、ＡＩにパソコン（あるいは大型機）の操作をすべてやらせる計画もきっと進んでいることでしょう。人間が口で指示すれば銀行システムの構築やバグの発見・修復などはみんなＡＩがやってくれる、そんな日が来ればプログラミング言語は要らなくなりそうです。ひょっとしてプログラマーも:sweat:
しかし更に考えてみると、人間語だけでＡＩを操作するのは簡単ではなさそうです。たとえば私がＡＩに「１から１００までの合計を求めよ」と命令したとしましょう。あるＡＩは第１回で作ったような機械語をさっとメモリに並べてくれるでしょうが、愚直なＡＩは「１以上１００以下のすべての有理数・無理数の和を求めよ」と解釈し、必死になってアルゴリズムを考えるかもしれません。私はこの愚直なＡＩを責めることはできません。なぜなら私の命令は、そういう意味にも取れるからです。
人間語は人間としての常識に裏打ちされて、初めて意味が確定します。ＡＩが人間の常識を完全に理解する日までには、まだ時間が掛かりそうです。その日まではプロの読者も、ますます商売繁盛でしょうね:smile:


（注１）
スタックポインタの正確な位置を理解しておくことは大切で、まちがえるとスタックのデータを参照するときにずれてしまいます。
本文の繰り返しになりますが、スタックポインタは積まれたデータの最も小さいアドレス（同じことですが次に積むべきデータの位置よりも１だけ大きいアドレス）を指しています。

（注２）
[第１回](https://qiita.com/streaker/items/68b6a7f639777e6c0a24)のmain関数であるwith_asm.cを「gcc -S」で調べてみると、bxもcxも使っていませんから、実は本文のような配慮は不要でした。ただ一般論として、呼ばれた側の関数が自分で使うレジスタをプッシュ・ポップして、呼んだ側に迷惑が掛からないようにするのは、いい習慣だと思います。
追記
藤田さんのご指摘によれば、rbx（ebxとbxも同じ）はルールで変えてはいけないので、たとえmain関数でebxなどを使っていなくても、アセンブリ言語側でプッシュ・ポップして保護するのが正しいそうです。

（注２－２）
ここは藤田さんから間違いのご指摘を受けました。カッコ悪いですが間違いはそのまま残し、ご指摘が正しいことを確認済みです。

（注３）
ＴＫ－８０のメモリは、忘れもしない２５６バイトでした。
追記　藤田さんから「メモリと書いているがramでは？」と指摘を受けました。全くそのとおりで、ramに訂正します。藤田さんによれば、ほかにromを７６８　バイト積んでいたそうです。
そのramのサイズですが、当初は２５６バイトで、増設キットを買ってきてやっと１０２４バイトにした記憶があるのですが、何分にも５０年近く前のことで:sweat_smile: