man3/getprotoent_r.3

   1 '\" t
   2 .\" Copyright 2008, Linux Foundation, written by Michael Kerrisk
   3 .\"     <mtk.manpages@gmail.com>
   4 .\"
   5 .\" SPDX-License-Identifier: Linux-man-pages-copyleft
   6 .\"
   7 .TH getprotoent_r 3 (date) "Linux man-pages (unreleased)"
   8 .SH NAME
   9 getprotoent_r, getprotobyname_r, getprotobynumber_r \- get
  10 protocol entry (reentrant)
  11 .SH LIBRARY
  12 Standard C library
  13 .RI ( libc ", " \-lc )
  14 .SH SYNOPSIS
  15 .nf
  16 .B #include <netdb.h>
  17 .PP
  18 .BI "int getprotoent_r(struct protoent *restrict " result_buf ,
  19 .BI "                  char " buf "[restrict ." buflen "], size_t " buflen ,
  20 .BI "                  struct protoent **restrict " result );
  21 .BI "int getprotobyname_r(const char *restrict " name ,
  22 .BI "                  struct protoent *restrict " result_buf ,
  23 .BI "                  char " buf "[restrict ." buflen "], size_t " buflen ,
  24 .BI "                  struct protoent **restrict " result );
  25 .BI "int getprotobynumber_r(int " proto ,
  26 .BI "                  struct protoent *restrict " result_buf ,
  27 .BI "                  char " buf "[restrict ." buflen "], size_t " buflen ,
  28 .BI "                  struct protoent **restrict " result );
  29 .PP
  30 .fi
  31 .RS -4
  32 Feature Test Macro Requirements for glibc (see
  33 .BR feature_test_macros (7)):
  34 .RE
  35 .PP
  36 .BR getprotoent_r (),
  37 .BR getprotobyname_r (),
  38 .BR getprotobynumber_r ():
  39 .nf
  40     Since glibc 2.19:
  41         _DEFAULT_SOURCE
  42     glibc 2.19 and earlier:
  43         _BSD_SOURCE || _SVID_SOURCE
  44 .fi
  45 .SH DESCRIPTION
  46 The
  47 .BR getprotoent_r (),
  48 .BR getprotobyname_r (),
  49 and
  50 .BR getprotobynumber_r ()
  51 functions are the reentrant equivalents of, respectively,
  52 .BR getprotoent (3),
  53 .BR getprotobyname (3),
  54 and
  55 .BR getprotobynumber (3).
  56 They differ in the way that the
  57 .I protoent
  58 structure is returned,
  59 and in the function calling signature and return value.
  60 This manual page describes just the differences from
  61 the nonreentrant functions.
  62 .PP
  63 Instead of returning a pointer to a statically allocated
  64 .I protoent
  65 structure as the function result,
  66 these functions copy the structure into the location pointed to by
  67 .IR result_buf .
  68 .PP
  69 The
  70 .I buf
  71 array is used to store the string fields pointed to by the returned
  72 .I protoent
  73 structure.
  74 (The nonreentrant functions allocate these strings in static storage.)
  75 The size of this array is specified in
  76 .IR buflen .
  77 If
  78 .I buf
  79 is too small, the call fails with the error
  80 .BR ERANGE ,
  81 and the caller must try again with a larger buffer.
  82 (A buffer of length 1024 bytes should be sufficient for most applications.)
  83 .\" I can find no information on the required/recommended buffer size;
  84 .\" the nonreentrant functions use a 1024 byte buffer.
  85 .\" The 1024 byte value is also what the Solaris man page suggests. -- mtk
  86 .PP
  87 If the function call successfully obtains a protocol record, then
  88 .I *result
  89 is set pointing to
  90 .IR result_buf ;
  91 otherwise,
  92 .I *result
  93 is set to NULL.
  94 .SH RETURN VALUE
  95 On success, these functions return 0.
  96 On error, they return one of the positive error numbers listed in ERRORS.
  97 .PP
  98 On error, record not found
  99 .RB ( getprotobyname_r (),
 100 .BR getprotobynumber_r ()),
 101 or end of input
 102 .RB ( getprotoent_r ())
 103 .I result
 104 is set to NULL.
 105 .SH ERRORS
 106 .TP
 107 .B ENOENT
 108 .RB ( getprotoent_r ())
 109 No more records in database.
 110 .TP
 111 .B ERANGE
 112 .I buf
 113 is too small.
 114 Try again with a larger buffer
 115 (and increased
 116 .IR buflen ).
 117 .SH ATTRIBUTES
 118 For an explanation of the terms used in this section, see
 119 .BR attributes (7).
 120 .ad l
 121 .nh
 122 .TS
 123 allbox;
 124 lbx lb lb
 125 l l l.
 126 Interface       Attribute       Value
 127 T{
 128 .BR getprotoent_r (),
 129 .BR getprotobyname_r (),
 130 .BR getprotobynumber_r ()
 131 T}      Thread safety   MT-Safe locale
 132 .TE
 133 .hy
 134 .ad
 135 .sp 1
 136 .SH STANDARDS
 137 These functions are GNU extensions.
 138 Functions with similar names exist on some other systems,
 139 though typically with different calling signatures.
 140 .SH EXAMPLES
 141 The program below uses
 142 .BR getprotobyname_r ()
 143 to retrieve the protocol record for the protocol named
 144 in its first command-line argument.
 145 If a second (integer) command-line argument is supplied,
 146 it is used as the initial value for
 147 .IR buflen ;
 148 if
 149 .BR getprotobyname_r ()
 150 fails with the error
 151 .BR ERANGE ,
 152 the program retries with larger buffer sizes.
 153 The following shell session shows a couple of sample runs:
 154 .PP
 155 .in +4n
 156 .EX
 157 .RB "$" " ./a.out tcp 1"
 158 ERANGE! Retrying with larger buffer
 159 getprotobyname_r() returned: 0 (success)  (buflen=78)
 160 p_name=tcp; p_proto=6; aliases=TCP
 161 .RB "$" " ./a.out xxx 1"
 162 ERANGE! Retrying with larger buffer
 163 getprotobyname_r() returned: 0 (success)  (buflen=100)
 164 Call failed/record not found
 165 .EE
 166 .in
 167 .SS Program source
 168 \&
 169 .\" SRC BEGIN (getprotoent_r.c)
 170 .EX
 171 #define _GNU_SOURCE
 172 #include <ctype.h>
 173 #include <errno.h>
 174 #include <netdb.h>
 175 #include <stdio.h>
 176 #include <stdlib.h>
 177 #include <string.h>
 178
 179 #define MAX_BUF 10000
 180
 181 int
 182 main(int argc, char *argv[])
 183 {
 184     int buflen, erange_cnt, s;
 185     struct protoent result_buf;
 186     struct protoent *result;
 187     char buf[MAX_BUF];
 188
 189     if (argc < 2) {
 190         printf("Usage: %s proto\-name [buflen]\en", argv[0]);
 191         exit(EXIT_FAILURE);
 192     }
 193
 194     buflen = 1024;
 195     if (argc > 2)
 196         buflen = atoi(argv[2]);
 197
 198     if (buflen > MAX_BUF) {
 199         printf("Exceeded buffer limit (%d)\en", MAX_BUF);
 200         exit(EXIT_FAILURE);
 201     }
 202
 203     erange_cnt = 0;
 204     do {
 205         s = getprotobyname_r(argv[1], &result_buf,
 206                              buf, buflen, &result);
 207         if (s == ERANGE) {
 208             if (erange_cnt == 0)
 209                 printf("ERANGE! Retrying with larger buffer\en");
 210             erange_cnt++;
 211
 212             /* Increment a byte at a time so we can see exactly
 213                what size buffer was required. */
 214
 215             buflen++;
 216
 217             if (buflen > MAX_BUF) {
 218                 printf("Exceeded buffer limit (%d)\en", MAX_BUF);
 219                 exit(EXIT_FAILURE);
 220             }
 221         }
 222     } while (s == ERANGE);
 223
 224     printf("getprotobyname_r() returned: %s  (buflen=%d)\en",
 225            (s == 0) ? "0 (success)" : (s == ENOENT) ? "ENOENT" :
 226            strerror(s), buflen);
 227
 228     if (s != 0 || result == NULL) {
 229         printf("Call failed/record not found\en");
 230         exit(EXIT_FAILURE);
 231     }
 232
 233     printf("p_name=%s; p_proto=%d; aliases=",
 234            result_buf.p_name, result_buf.p_proto);
 235     for (char **p = result_buf.p_aliases; *p != NULL; p++)
 236         printf("%s ", *p);
 237     printf("\en");
 238
 239     exit(EXIT_SUCCESS);
 240 }
 241 .EE
 242 .\" SRC END
 243 .SH SEE ALSO
 244 .BR getprotoent (3),
 245 .BR protocols (5)