関数の定義位置により結果が変わるコード
はじめに
少し前、こんなポストをしました。
これは、C言語において、関数の宣言よりも前に関数呼び出しがあり、かつ引数の型が異なる場合、結果が想定の逆になってしまう、というものです。
この現象の本質は、暗黙のプロトタイプ宣言とABIにあり、以下の記事で説明は尽きています。
ですが、先のポストへの反応を見ていると、いまいち何が起きているかが伝わっていないようだったので、簡単に説明しようと思います。
以下、使用コンパイラはGCC 9.3.0、環境はWSL上のUbuntu 20.04です。
現象
まず、この現象はprintf関数が本質ではありません。それを見るため、以下のようなコードを書いてみましょう。
int func(int a, double b){
return a;
}
int main(){
return func(1.0,2);
}
実行して、終了ステータスを見てみます。
$ gcc test1.c; ./a.out; echo $?
1
funcからは1が返ってきます。
では、コードはそのままで、mainとfuncの順序を入れ替えてみましょう。
int main(){
return func(1.0,2);
}
int func(int a, double b){
return a;
}
先程と同様に実行し、終了ステータスを見てみます。
$ gcc test2.c; ./a.out; echo $?
2
2になりましたね。printfとか関係なく、単にファイルの中の関数の順序を入れ替えるだけで結果が変わります。これがなぜかを理解するには、ABIと暗黙の関数のプロトタイプ宣言について知る必要があります。
関数の引数について
まず、以下の2つの関数を考えます。
void func1(int a, double b);
void func2(double b, int a);
引数の順序が違いますが、どちらもint aはレジスタediに、double bはxmm0に入ってきます。見てみましょう。こんなコードを書きます。
void func1(int a, double b){}
void func2(double b, int a){}
int main(){
func1(1, 2.3);
func2(2.3, 1);
}
コンパイルしてgdbでfunc1、func2に入ったところで止め、ediとxmm0の値を確認します。
$ gcc -g func.c; gdb -q ./a.out
Reading symbols from ./a.out...
(gdb) b func1
Breakpoint 1 at 0x1129: file func.c, line 1.
(gdb) b func2
Breakpoint 2 at 0x113c: file func.c, line 3.
(gdb) r
Starting program: ./a.out
Breakpoint 1, func1 (a=21845, b=0) at func.c:1
1 void func1(int a, double b){}
いま、func1のところで止まったところです。ediとxmm0の値を見てみます。
(gdb) p/d $edi
$1 = 1
(gdb) p/f $xmm0.v2_int64
$2 = {2.2999999999999998, 0}
ediに1が、xmm0に2.3が入っていますね。
続けて、func2でも同じことをしてみます。
(gdb) c
Continuing.
Breakpoint 2, func2 (b=2.829327078342936e-314, a=1073899110) at func.c:3
3 void func2(double b, int a){}
(gdb) p/d $edi
$3 = 1
(gdb) p/f $xmm0.v2_int64
$4 = {2.2999999999999998, 0}
func1と引数の順序が異なるにも関わらず、ediに1が、xmm0に2.3が入っています。
要するに、x86_64のABIでは、引数の順序に関係なく、最初の整数の引数はediを、最初の浮動小数の引数はxmm0を使う、と決まっています。
暗黙のプロトタイプ宣言
次に、暗黙の型宣言についてです。C言語では、関数がプロトタイプ宣言無しに呼ばれた場合、返り値はintを返す関数であると仮定し、かつ引数については何も情報がないとします(チェックが行われない)。
すると、プロトタイプ宣言無しで
func1(1, 2.3);
と呼ばれた場合、この関数のプロトタイプは
int func1(int a, double b);
かもしれませんし
int func1(int a, ...);
かもしれませんし、
int func1(...);
かもしれません。この全ての可能性に対応するため、決められた個数の引数についてはレジスタを使い、かつ使った浮動小数点レジスタの数をrax(の下位8bit)に入れてから関数を呼ぶことになります。見てみましょう。
void func2(void){
func1(1, 2.3)
}
アセンブリを見てみましょう。
$ gcc -S proto.c
func2:
.LFB0:
endbr64
pushq %rbp
movq %rsp, %rbp
movq .LC0(%rip), %rax
movq %rax, %xmm0
movl $1, %edi
movl $1, %eax
call func1@PLT
popq %rbp
ret
.LC0:
.long 1717986918
不要な情報を一部削除していますが、
-
ediに1を -
xmm0に2.3を -
eaxに1を
代入しているのがわかると思います。ediが整数引数、xmm0が浮動小数点です。そして、eaxに使った浮動小数点の数である1が入っています。
func1のプロトタイプ宣言がある場合、可変長引数の可能性が消えるため、eaxへの代入は不要になります。
int func1(int, double);
void func2(void){
func1(1, 2.3);
}
$ gcc -S proto2.c
func2:
.LFB0:
endbr64
pushq %rbp
movq %rsp, %rbp
movq .LC0(%rip), %rax
movq %rax, %xmm0
movl $1, %edi
call func1@PLT
popq %rbp
ret
.cfi_endproc
callの前のmovl $1, %eaxが消えたのがわかりますね。どちらにせよ、整数引数はediに、浮動小数点引数はxmm0に入れて渡されます。
何がおきたか
以上を踏まえて、最初のコードで何が起きたか見てみましょう。
最初にfunc2の情報がないまま呼ばれています。
void func1(){
func2(1.0, 2);
}
仕方ないのでコンパイラはfunc2(double, int)もしくはfunc2(...)のどちらでもいけるように、
-
ediに2を -
xmm0に1.0を -
eaxに1を
代入してcall func2するコードを吐きます。
しかし、実際にはfunc2はfunc2(int, double)でした。
void func2(int a, double b){
printf("%d %f\n", a, b);
}
func2では、ediにaの値が、xmm0にbの値が代入されてくると思っています。なので、
func2(1.0, 2);
と呼び出したにもかかわらず、
func2(2, 1.0);
として呼び出されたとして処理されてしまいます。これが値がひっくり返る理由です。
まとめ
暗黙のプロトタイプ宣言と、関数の引数に関するABIがからんだ、少し直感に反するC言語の処理について紹介しました。
ここで紹介したようなコードに対しては、最近のコンパイラは警告を出しますし、処理系によってはエラーで落とすこともあるようです。ただ、「警告を無視するな」で終わらせるにはちょっともったいないかな、と思って少し丁寧に説明してみました。
冗談で怖さを煽るようなポストをしてしまいましたが、こういう直感に反するC言語の処理の理解は、ABIなど低レイヤを学ぶ絶好の機会だと思います。
この記事で、少しでもC言語が面白いと思ってもらえたら幸いです。
Discussion