単体テストの効率化を考える(4)
スタブの引数(ダブルポインタ)

2021年1月30日

どもです。

「単体テストの効率化について考える」の4回目です。
1回目から3回目まではコチラ:
単体テストの効率化を考える(1)-はじめに
単体テストの効率化を考える(2)-スタブの戻り値
単体テストの効率化を考える(3)-スタブの引数

1.振り返り

前々回から、

  • スタブを自動生成して単体テストを効率化するために、スタブで行うべき処理について考える。

というテーマで、考えたことを書いています。
前回のエントリでは、関数の引数に着目し、ポインタか否か、ポインタの場合には「入力」か「出力」か毎にスタブでの処理、実装について考えました。
その結果、

  • ポインタではない場合には、渡された値をそのまま代入/保持するためのバッファを用意する。
  • ポインタの場合は、「入力」であれば渡されたアドレスを代入/保持するためのバッファを用意する。
  • ポインタでありかつ「出力」の場合には、ポインタの実体に設定する値を保持するバッファを用意する。
  • ポインタでありかつ「出力」の場合には、呼び出される度に、用意したバッファの値をポインタの実体に代入して値を返す。
  • ポインタでありかつ「出力」かつポインタが「配列」を指す場合には、用意するバッファは2次元配列がよい。
    (ただし、自動化の際には工夫が必要。)

という結論になりました。
そして今回は前回に引き続き、「関数の引数」について考えます。
特に、「ダブルポインタ」について考えます。

2.ダブルポインタとは?

「そもそも」です。
「ダブルポインタ」とは何か。
それは、「ポインタへのポインタ」です。
それでは、「ポインタへのポインタ」とは何か。
言葉にすると長くなってしまうので、簡単ですが絵にして説明します。
think_about_unit_test_004_01
この絵について解説すると、変数aがPCのメモリ上のどこか(絵の中では、0x000004D6というアドレスの場所)に確保されています。
そこには、値「0x68」がセットされています。
また、別の変数bがメモリ上のどこか(絵の中では0x00002720)に確保されています。
変数bの値には、「0x000004D6」がセットされています。
この値は、変数aの値が格納されている場所の「アドレス」になります。
コレがポインタであり、「メモリ上のアドレスを格納する変数」です。
そしてさらに別の変数cがメモリ上のどこか(絵の中では0x00002774)に確保されています。
この変数cは、値「0x00002720」がセットされています。
これは変数bのアドレスであり、即ち変数cが「ポインタへのポインタ」です。
簡単だが、この関係を確認するためのサンプルプログラムが下記です。

#include 
#include 

int main()
{
    unsigned char a = 0x68;
    unsigned char* b = &a;
    unsigned char** c = &b;

    printf("a = 0x%02x\n", a);
    printf("b = %0p, *b = 0x%02x\n", b, *b);
    printf("c = %0p, *c = %0p, **c = 0x%02x\n", c, *c, **c);

    return 0;
}

実行すると、次のような結果が得られます。

a = 0x68
b = 0xffffcc17, *b = 0x68
c = 0xffffcc08, *c = 0xffffcc17, **c = 0x68

絵の中に書かれたアドレスは、上記プログラムの実行結果とは一致しませんが、意味しているものは同じです。

3.引数がダブルポインタの場合

では、関数の引数をダブルポインタにする場合は、どのような場合か?
(基本的には)何某かの値/領域のアドレスを関数から取得したい場合に、引数にダブルポインタが使用されます。
例えば、以下のようなコードになります。

#include <stdio.h>
        
int a = 0x68;
int* b = &a;

void get_pointer_to_a(int** doublePointer)
{
    printf("\nin get_pointer_to_a :\n");

    *doublePointer = b;
    printf(" doublePointer = %010p\n", doublePointer);
    printf("&doublePointer = %010p\n", &doublePointer);
}

int main()
{
    int* pointer_to_a = NULL;

    printf("before :\n");
    printf("             a = %0p\n", &a);
    printf("             b = %0p\n", &b);
    printf("  pointer_to_a = %010p\n", pointer_to_a);
    printf(" &pointer_to_a = %010p\n", &pointer_to_a);

    get_pointer_to_a(&pointer_to_a);

    printf("\nafter  : \n");
    printf("  pointer_to_a = %010p\n", pointer_to_a);
    printf(" &pointer_to_a = %010p\n", &pointer_to_a);
    printf(" *pointer_to_a = 0x%02x\n", *pointer_to_a);

    return 0;
}

上記コードをビルド、実行すると下記の結果が得られました。

before :
                a = 0x100402010
                b = 0x100402018
     pointer_to_a = 0x00000000
    &pointer_to_a = 0xffffcc18

in get_pointer_to_a :
     doublePointer = 0xffffcc18
    &doublePointer = 0xffffcbf0

after  :
     pointer_to_a = 0x100402010
    &pointer_to_a = 0xffffcc18
    *pointer_to_a = 0x68

4.引数がダブルポインタの場合のスタブ

前項まで、引数をダブルポインタにするのはどのような場合か、またどのような動作をするかがこれでわかりました。
それではやっと本題である、「スタブでのダブルポインタの引数への処理、実装」について考えます。

ここまで書いてきた内容から、ダブルポインタの変数が使用される場面は分かってきました。
そこから考えられる、ダブルポインタの変数に対してスタブが行うべき処理は、以下のことが考えられます。

  • ダブルポインタに格納された値の保持
  • ダブルポインタに別のポインタの値(アドレス)を設定する

具体的なスタブの実装、処理は下記のようになるかと思います。

int DoublePointer_called_count = 0; //呼び出し回数
int** DoublePointer_arg[100];       //引数のアドレスのバッファ(サイズは暫定)
int DoublePointer_arg_value[100][100];               //引数の戻り値(ポインタが指す領域)のバッファ(サイズは暫定)
void DoublePointer(int** arg)
{
    DoublePointer_arg[DoublePointer_called_count] = arg; //渡された値をコピー
    *arg = buffer[DoublePointer_called_count];           //バッファのアドレスを引数の実体にセット
    DoublePointer_called_count++;
}

この例では、ダブルポインタに設定されるアドレスのために、予め2次元配列を用意しています。
そして、スタブが実行される度に2次元配列の別の領域のアドレスがダブルポインタにセットされます。

関数の呼び出し元で返された領域の値を参照している場合には、事前にバッファ(上記の例では、「DoublePointer_arg_value」)に予め値をセットしておけば、対応ができます。

5.まとめ

今回のエントリでは、関数の引数にダブルポインタを持つ場合、その関数のスタブでのダブルポインタに対する処理を考えてみました。
結論ですが、

  • ダブルポインタに格納された値を保持する
  • ダブルポインタには、予め用意しておいたバッファへのアドレスを設定する。
  • ダブルポインタに設定する値は、スタブが複数回呼ばれた場合に備えて2次元配列にする。

です。

さて。
これまで4回にわたって

  • スタブを自動生成して単体テストを効率化するために、スタブで行うべき処理について考える。

について考えてきました。
この4回のエントリの中で、「スタブで行うべき処理」については分かってきました。
そこで、次回からは(やっと?とうとう?)スタブの自動生成に入ります。
ではっ!

続きはコチラ

単体テストの効率化を考える(5)-スタブの自動生成への入力
単体テストの効率化を考える(6)-スタブの自動生成ツール