GETPROTOENT_R(3)

名前
getprotoent_r, getprotobyname_r, getprotobynumber_r - プロトコル エントリーを取得する (リエントラント版)

書式
#include <netdb.h>

int getprotoent_r(struct protoent *result_buf, char *buf,
                size_t buflen, struct protoent **result);

int getprotobyname_r(const char *name,
                struct protoent *result_buf, char *buf,
                size_t buflen, struct protoent **result);

int getprotobynumber_r(int proto,
                struct protoent *result_buf, char *buf,
                size_t buflen, struct protoent **result);

    glibc 向けの機能検査マクロの要件 (feature_test_macros(7) 参照):

getprotoent_r(), getprotobyname_r(), getprotobynumber_r():
    Since glibc 2.19:
        _DEFAULT_SOURCE
    Glibc 2.19 and earlier:
        _BSD_SOURCE || _SVID_SOURCE

説明
関数 getprotoent_r(), getprotobyname_r(), getprotobynumber_r() は、それぞれ getprotoent(3), getprotobyname(3), getprotobynumber(3) のリエントラント版である。 protoent 構造体の返し方と、関数呼び出し時の引数と返り値が異なる。 このマニュアルページでは、リエントラントでない関数との違いだけを 説明する。

これらの関数は、関数の結果として静的に割り当てられた protoent 構造体 へのポインターを返すのではなく、 protoent 構造体を result_buf が 指す場所にコピーする。

配列 buf は、返される protoent 構造体が指す文字列フィールドを 格納するのに使用される (リエントラントでない関数の場合は、 これらの文字列は静的な領域に格納される)。 この配列の大きさは buflen で指定される。 buf が小さすぎる場合、関数呼び出しはエラー ERANGE で失敗し、 呼び出し側ではもっと大きなバッファーで再度呼び出す必要がある (ほとんどの アプリケーションでは、長さ 1024 バイトのバッファーで十分なはずである)。

関数呼び出しでプロトコルレコードの取得に成功すると、 *result は result_buf を指すように設定される。 それ以外の場合は *result に NULL が設定される。

返り値
成功すると、これらの関数は 0 を返す。エラーの場合、「エラー」の節の リストにある正のエラー番号のいずれかを返す。

エラーの場合、レコードが見つからなかった場合 (getprotobyname_r(), getprotobyaddr_r()) やこれ以上レコードがない場合 (getprotoent_r())、result には NULL が設定される。

エラー

ENOENT
    (getprotoent_r()) データベースにこれ以上レコードがない。

ERANGE
    buf が小さすぎる。もっと大きなバッファーにして (または buflen を増やして) 再度呼び出すこと。

属性
この節で使用されている用語の説明は attributes(7) を参照のこと。
Interface | Attribute | Value
getprotoent_r(), getprotobyname_r(), getprotobynumber_r() | Thread safety | MT-Safe locale

準拠
これらの関数は GNU による拡張である。 他のシステムにも同様の名前の関数が存在する場合があるが、 通常は関数の引数が異なる。

例
以下のプログラムは、 getprotobyname_r() を使って、最初のコマンド ライン引数で指定された名前のプロトコルのレコードを取得する。 二番目のコマンドライン引数 (整数値) が指定された場合は、 その値が buflen の初期値として使用される。 getprotobyname_r() がエラー ERANGE で失敗すると、プログラムは より大きなバッファーサイズで再度 getprotobyname_r を呼び出す。 下記のシェルのセッションは、実行例を示している。

    $ ./a.out tcp 1
    ERANGE! Retrying with larger buffer
    getprotobyname_r() returned: 0 (success)  (buflen=78)
    p_name=tcp; p_proto=6; aliases=TCP
    $ ./a.out xxx 1
    ERANGE! Retrying with larger buffer
    getprotobyname_r() returned: 0 (success)  (buflen=100)
    Call failed/record not found

  プログラムのソース
    #define _GNU_SOURCE
    #include <ctype.h>
    #include <netdb.h>
    #include <stdlib.h>
    #include <stdio.h>
    #include <errno.h>
    #include <string.h>
    #define MAX_BUF 10000
    int
    main(int argc, char *argv[])
    {
        int buflen, erange_cnt, s;
        struct protoent result_buf;
        struct protoent *result;
        char buf[MAX_BUF];
        if (argc < 2) {
            printf("Usage: %s proto-name [buflen]\n", argv[0]);
            exit(EXIT_FAILURE);
        }
        buflen = 1024;
        if (argc > 2)
            buflen = atoi(argv[2]);
        if (buflen > MAX_BUF) {
            printf("Exceeded buffer limit (%d)\n", MAX_BUF);
            exit(EXIT_FAILURE);
        }
        erange_cnt = 0;
        do {
            s = getprotobyname_r(argv[1], &result_buf,
                         buf, buflen, &result);
            if (s == ERANGE) {
                if (erange_cnt == 0)
                    printf("ERANGE! Retrying with larger buffer\n");
                erange_cnt++;
                /* Increment a byte at a time so we can see exactly
                   what size buffer was required */
                buflen++;
                if (buflen > MAX_BUF) {
                    printf("Exceeded buffer limit (%d)\n", MAX_BUF);
                    exit(EXIT_FAILURE);
                }
            }
        } while (s == ERANGE);
        printf("getprotobyname_r() returned: %s  (buflen=%d)\n",
                (s == 0) ? "0 (success)" : (s == ENOENT) ? "ENOENT" :
                strerror(s), buflen);
        if (s != 0 || result == NULL) {
            printf("Call failed/record not found\n");
            exit(EXIT_FAILURE);
        }
        printf("p_name=%s; p_proto=%d; aliases=",
                    result_buf.p_name, result_buf.p_proto);
        for (char **p = result_buf.p_aliases; *p != NULL; p++)
            printf("%s ", *p);
        printf("\n");
        exit(EXIT_SUCCESS);
    }

関連項目
getprotoent(3), protocols(5)

この文書について
この man ページは Linux man-pages プロジェクトのリリース 5.10 の一部である。プロジェクトの説明とバグ報告に関する情報は https://www.kernel.org/doc/man-pages/ に書かれている。