C言語のPOSIX定義関数のlfindで配列要素の検索がうまくできているか自信がない

Question

以前、以下で投稿した内容の関連質問となります。

C言語でPOSIX規定関数のlfind関数で配列要素にマッチした文字列の参照方法

Ubuntu 16.04+gcc 5.4.0で，以下のサンプルコードでC言語のlfind関数により，文字列配列とint型の配列から指定した要素 ("break"と2)を検索しています。

/// \file example_lfind.c
#include <stdio.h>
#include <string.h>
#include <search.h>
int main(void) {
    // lfind for string array.
    char tab1[] = {"auto", "break", "continue"};
    size_t size1 = sizeof(tab1)/sizeof(tab1[0]);
    char key1 = "break";
    char entry1 = lfind(&key1, tab1, &size1, sizeof(tab1[0]), (int ()(const void , const void))strcmp);
if (entry1) {
    printf(&quot;array: %p:%s\n&quot;, (void *)&amp;tab1[1], tab1[1] );
    printf(&quot;found: %p:%s\n&quot;, entry1, entry1);
} else {
    puts(&quot;STR NOT FOUND&quot;);
}

// lfind for int array.
int tab2[] = {1, 2, 3};
size_t size2 = sizeof(tab2)/sizeof(tab2[0]);
int key2 = 2;
int *entry2 = lfind(&amp;key2, tab2, &amp;size2, sizeof(tab2[0]), (int (*)(const void *, const void*))strcmp);

if (entry2) {
    printf(&quot;array: %p:%d\n&quot;, (void *)&amp;tab2[1], tab2[1] );
    printf(&quot;found: %p:%d\n&quot;, (void *)entry2, *entry2);
} else {
    puts(&quot;INT NOT FOUND&quot;);
}

return 0;

}

実行結果例は以下となります。

array: 0x7ffe40601408:break
found: 0x7ffe40601408:@
array: 0x7ffe406013f4:2
found: 0x7ffe406013f4:2

冒頭にあげた質問で，文字列配列 (tab1) でマッチした entry1 はlfindの第5引数に指定する検索に使用する比較関数に渡される引数と，結果を受け取るポインター(entry1)のデータ型が合っていないので，正しくマッチ後の値を参照できずに，"break"ではなく"@" (NULL?)が表示されていることがわかりました。

ただ，マッチ自体はうまくできているようにみえます。int型の配列の検索結果entry2に至っては，検索した値 (2) も検索結果のentry2からきちんと参照できています。

しかし，先の質問で以下の通り，たまたまうまくいっているだけとの指摘をいただきました。

あなたのコードではポインタの内容の4または8バイトの内容をstrcmpで比較してしまっています。ポインタそのものを表すバイトの途中に0x00が現れれば、誤った結果を出すでしょうし、逆に0x00がどこにもない領域に配列が置かれていたら、メモリ未割り当ての領域アクセスで異常終了するかもしれません。

そこで，2点の質問です。

1. 今回の比較関数にstrcmpを使ったchar* 配列のtab1とint配列のtab2の検索でうまくいかない具体的なパターンを教えてほしい。
2. 配列の検索は頻出事項であり，可能であれば準標準関数であるlfindとlfindの第5引数の比較関数に採用可能な標準関数(strcmpなど)だけで(できれば自前での比較用関数の実装は避けたい)，手短に文字列配列，数値配列 (int, float/double)の検索を実現したい。なにかいい方法があれば教えてほしい (文字配列はstrchr単独で検索可能なため除外)。

片方だけの回答でも歓迎です。どうぞよろしくお願いします。

Answer 1

1. 今回の比較関数にstrcmpを使ったchar 配列のtab1とint配列のtab2の検索でうまくいかない具体的なパターンを教えてほしい。*

まずは、こちらの後半の質問にお答えしておきます。

まずは、int用のテストコードをこちらのように修正して実行して見てください。

// lfind for int array.
int tab2[] = {256, 512, 768};
size_t size2 = sizeof(tab2)/sizeof(tab2[0]);
int key2 = 512;
int *entry2 = lfind(&key2, tab2, &size2, sizeof(tab2[0]), (int (*)(const void *, const void*))strcmp);

if (entry2) {
    printf("array: %p:%d\n", (void *)&tab2[1], tab2[1] );
    printf("found: %p:%d\n", entry2, *entry2);
} else {
    puts("INT NOT FOUND");
}

実行結果はこんな風になるはずです。

array: 0x7ffeefbff5e0:512
found: 0x7ffeefbff5dc:256

lfindによる検索結果はkey2の値に一致する2個目ではなく、1個目の256だと出力されています。これはint型の数値の256や512がどのようにメモリ中に保存されているのかを考えるとわかります。

(Big endianの特殊なUbuntuではないと思うので、little endianで示しています。)

256 -> 0x00000100 -> |0x00|0x01|0x00|0x00|
512 -> 0x00000200 -> |0x00|0x02|0x00|0x00|

strcmpは引数のポインターから、NUL文字、つまり0x00となるまでの範囲を比較するのはご存知かと思います。したがって256が格納された領域の先頭アドレスと512が格納された先頭アドレスにはどちらも先頭に0x00、NUL文字が入っていることになるので、そこで比較が終わってしまうのです。

int a = 256;
int b = 512;
int result = strcmp((char *)&a, (char *)&b);
printf("result=%d\n", result);

resultの値は、「等しい」を表す0になるはずです。

(strcmp("", "")の結果が0になるのと同じなんですが、お分かりでしょうか。)

---

char *の場合は、ポインターで、ポインターそのもののアドレス値が特定のビットパターンになるようにするのは難しいのですが、ポインターの実態は単に整数値で0x7ffe40601408だとか、0x7ffeefbff5e0とか言った中身になっているのは%pの出力でお分かりでしょう。

たまたま2つのポインターが0x7ffe40601400と0x7ffeefbff500なんてアドレスになっていたら、上記の256と512と同様に全体としては全然違うアドレスだけど、strcmpが等しいと判定してしまうと言うことが起こり得ます。

ここでは例を簡単にするために最下位の1バイトが0x00になるような例を作りましたが、もちろん最下位以外のどこかのバイトが0x00でそこまでは全バイト等しい、なんてアドレスの比較でもstrcmpは「等しい」と判定してしまうでしょう。

(例えば、0x7ffe40600014と0x7ffeefbf0014を上のaとbに入れてみてください。)

ちなみにこのご質問のstring array版では、ポインターのアドレス値同士をstrcmpで比較してしまっているので、「アドレスは違っているけど、ポインターの指す先にある文字列は同じ内容」と言う場合にも所望の動作をしなくなります。

---

2. 配列の検索は頻出事項であり，可能であれば準標準関数であるlfindとlfindの第5引数の比較関数に採用可能な標準関数(strcmpなど)だけで(できれば自前での比較用関数の実装は避けたい)，手短に文字列配列，数値配列 (int, float/double)の検索を実現したい。なにかいい方法があれば教えてほしい (文字配列はstrchr単独で検索可能なため除外)。

私的には、「できれば自前での比較用関数の実装は避けたい」なんてことにこだわるよりも、比較関数の定型的な書き方をさっさと身につけた方が良いのではないか、と言うところです。

int型の比較を行う正しいコードはこんな感じになります。

int cmpare_int(int *pInt1, int *pInt2) {
    int i1 = *pInt1;
    int i2 = *pInt2;

    if( i1 < i2 ) {
        return -1;
    } else if( i1 == i2 ) {
        return 0;
    } else {
        return 1;
    }
}

int main(void) {

    // lfind for int array.
    int tab2[] = {256, 512, 768};
    size_t size2 = sizeof(tab2)/sizeof(tab2[0]);
    int key2 = 512;
    int *entry2 = lfind(&key2, tab2, &size2, sizeof(tab2[0]), (int (*)(const void *, const void*))cmpare_int);

    if (entry2) {
        printf("array: %p:%d\n", (void *)&tab2[1], tab2[1] );
        printf("found: %p:%d\n", entry2, *entry2);
    } else {
        puts("INT NOT FOUND");
    }

    return 0;
}

結果は正しく、

array: 0x7ffeefbff5e0:512
found: 0x7ffeefbff5e0:512

と言った感じになるはずです。

左の方が小さければ負の値、等しければ0、そうでなければ(左のほうが大きければ)正の値を返すと言う処理を書くだけです。ちょくちょく出てくる処理を書くために(下手すると自分で専用処理を書くのと大差ない長さの)比較関数を書かないといけないと言うのは、ある意味C言語の制約上仕方ないと言ったところでしょうか。

(ちなみにcmpare_int関数はlfind専用でよければもう少し簡略化できますが、bsearch等に使えなくなってしまうため、そちらのコードは掲載しないでおきます。)

この辺をしっかり身につけてからテンプレートやらジェネリクスやらのある言語をやると、その便利さがよくわかるかもしれません。