| 1 | /* Provide a netdb.h header file for systems lacking it (read: MinGW). |
| 2 | Copyright (C) 2008-2011 Free Software Foundation, Inc. |
| 3 | Written by Simon Josefsson. |
| 4 | |
| 5 | This program is free software; you can redistribute it and/or modify |
| 6 | it under the terms of the GNU Lesser General Public License as published by |
| 7 | the Free Software Foundation; either version 2, or (at your option) |
| 8 | any later version. |
| 9 | |
| 10 | This program is distributed in the hope that it will be useful, |
| 11 | but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 12 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 13 | GNU Lesser General Public License for more details. |
| 14 | |
| 15 | You should have received a copy of the GNU Lesser General Public License |
| 16 | along with this program; if not, write to the Free Software Foundation, |
| 17 | Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */ |
| 18 | |
| 19 | /* This file is supposed to be used on platforms that lack <netdb.h>. |
| 20 | It is intended to provide definitions and prototypes needed by an |
| 21 | application. */ |
| 22 | |
| 23 | #ifndef _GL_NETDB_H |
| 24 | |
| 25 | #if __GNUC__ >= 3 |
| 26 | @PRAGMA_SYSTEM_HEADER@ |
| 27 | #endif |
| 28 | @PRAGMA_COLUMNS@ |
| 29 | |
| 30 | #if @HAVE_NETDB_H@ |
| 31 | |
| 32 | /* The include_next requires a split double-inclusion guard. */ |
| 33 | # @INCLUDE_NEXT@ @NEXT_NETDB_H@ |
| 34 | |
| 35 | #endif |
| 36 | |
| 37 | #ifndef _GL_NETDB_H |
| 38 | #define _GL_NETDB_H |
| 39 | |
| 40 | /* Get <netdb.h> definitions such as 'socklen_t' on IRIX 6.5 and OSF/1 4.0 and |
| 41 | 'struct hostent' on MinGW. */ |
| 42 | #include <sys/socket.h> |
| 43 | |
| 44 | /* The definition of _GL_ARG_NONNULL is copied here. */ |
| 45 | |
| 46 | /* The definition of _GL_WARN_ON_USE is copied here. */ |
| 47 | |
| 48 | /* Declarations for a platform that lacks <netdb.h>, or where it is |
| 49 | incomplete. */ |
| 50 | |
| 51 | #if @GNULIB_GETADDRINFO@ |
| 52 | |
| 53 | # if !@HAVE_STRUCT_ADDRINFO@ |
| 54 | |
| 55 | # if !GNULIB_defined_struct_addrinfo |
| 56 | /* Structure to contain information about address of a service provider. */ |
| 57 | struct addrinfo |
| 58 | { |
| 59 | int ai_flags; /* Input flags. */ |
| 60 | int ai_family; /* Protocol family for socket. */ |
| 61 | int ai_socktype; /* Socket type. */ |
| 62 | int ai_protocol; /* Protocol for socket. */ |
| 63 | socklen_t ai_addrlen; /* Length of socket address. */ |
| 64 | struct sockaddr *ai_addr; /* Socket address for socket. */ |
| 65 | char *ai_canonname; /* Canonical name for service location. */ |
| 66 | struct addrinfo *ai_next; /* Pointer to next in list. */ |
| 67 | }; |
| 68 | # define GNULIB_defined_struct_addrinfo 1 |
| 69 | # endif |
| 70 | # endif |
| 71 | |
| 72 | /* Possible values for `ai_flags' field in `addrinfo' structure. */ |
| 73 | # ifndef AI_PASSIVE |
| 74 | # define AI_PASSIVE 0x0001 /* Socket address is intended for `bind'. */ |
| 75 | # endif |
| 76 | # ifndef AI_CANONNAME |
| 77 | # define AI_CANONNAME 0x0002 /* Request for canonical name. */ |
| 78 | # endif |
| 79 | # ifndef AI_NUMERICSERV |
| 80 | # define AI_NUMERICSERV 0x0400 /* Don't use name resolution. */ |
| 81 | # endif |
| 82 | |
| 83 | # if 0 |
| 84 | # define AI_NUMERICHOST 0x0004 /* Don't use name resolution. */ |
| 85 | # endif |
| 86 | |
| 87 | /* These symbolic constants are required to be present by POSIX, but |
| 88 | our getaddrinfo replacement doesn't use them (yet). Setting them |
| 89 | to 0 on systems that doesn't have them avoids causing problems for |
| 90 | system getaddrinfo implementations that would be confused by |
| 91 | unknown values. */ |
| 92 | # ifndef AI_V4MAPPED |
| 93 | # define AI_V4MAPPED 0 /* 0x0008: IPv4 mapped addresses are acceptable. */ |
| 94 | # endif |
| 95 | # ifndef AI_ALL |
| 96 | # define AI_ALL 0 /* 0x0010: Return IPv4 mapped and IPv6 addresses. */ |
| 97 | # endif |
| 98 | # ifndef AI_ADDRCONFIG |
| 99 | # define AI_ADDRCONFIG 0 /* 0x0020: Use configuration of this host to choose |
| 100 | returned address type. */ |
| 101 | # endif |
| 102 | |
| 103 | /* Error values for `getaddrinfo' function. */ |
| 104 | # ifndef EAI_BADFLAGS |
| 105 | # define EAI_BADFLAGS -1 /* Invalid value for `ai_flags' field. */ |
| 106 | # define EAI_NONAME -2 /* NAME or SERVICE is unknown. */ |
| 107 | # define EAI_AGAIN -3 /* Temporary failure in name resolution. */ |
| 108 | # define EAI_FAIL -4 /* Non-recoverable failure in name res. */ |
| 109 | # define EAI_NODATA -5 /* No address associated with NAME. */ |
| 110 | # define EAI_FAMILY -6 /* `ai_family' not supported. */ |
| 111 | # define EAI_SOCKTYPE -7 /* `ai_socktype' not supported. */ |
| 112 | # define EAI_SERVICE -8 /* SERVICE not supported for `ai_socktype'. */ |
| 113 | # define EAI_MEMORY -10 /* Memory allocation failure. */ |
| 114 | # endif |
| 115 | |
| 116 | /* Since EAI_NODATA is deprecated by RFC3493, some systems (at least |
| 117 | FreeBSD, which does define EAI_BADFLAGS) have removed the definition |
| 118 | in favor of EAI_NONAME. */ |
| 119 | # if !defined EAI_NODATA && defined EAI_NONAME |
| 120 | # define EAI_NODATA EAI_NONAME |
| 121 | # endif |
| 122 | |
| 123 | # ifndef EAI_OVERFLOW |
| 124 | /* Not defined on mingw32 and Haiku. */ |
| 125 | # define EAI_OVERFLOW -12 /* Argument buffer overflow. */ |
| 126 | # endif |
| 127 | # ifndef EAI_ADDRFAMILY |
| 128 | /* Not defined on mingw32. */ |
| 129 | # define EAI_ADDRFAMILY -9 /* Address family for NAME not supported. */ |
| 130 | # endif |
| 131 | # ifndef EAI_SYSTEM |
| 132 | /* Not defined on mingw32. */ |
| 133 | # define EAI_SYSTEM -11 /* System error returned in `errno'. */ |
| 134 | # endif |
| 135 | |
| 136 | # if 0 |
| 137 | /* The commented out definitions below are not yet implemented in the |
| 138 | GNULIB getaddrinfo() replacement, so are not yet needed. |
| 139 | |
| 140 | If they are restored, be sure to protect the definitions with #ifndef. */ |
| 141 | # ifndef EAI_INPROGRESS |
| 142 | # define EAI_INPROGRESS -100 /* Processing request in progress. */ |
| 143 | # define EAI_CANCELED -101 /* Request canceled. */ |
| 144 | # define EAI_NOTCANCELED -102 /* Request not canceled. */ |
| 145 | # define EAI_ALLDONE -103 /* All requests done. */ |
| 146 | # define EAI_INTR -104 /* Interrupted by a signal. */ |
| 147 | # define EAI_IDN_ENCODE -105 /* IDN encoding failed. */ |
| 148 | # endif |
| 149 | # endif |
| 150 | |
| 151 | # if !@HAVE_DECL_GETADDRINFO@ |
| 152 | /* Translate name of a service location and/or a service name to set of |
| 153 | socket addresses. |
| 154 | For more details, see the POSIX:2001 specification |
| 155 | <http://www.opengroup.org/susv3xsh/getaddrinfo.html>. */ |
| 156 | extern int getaddrinfo (const char *restrict nodename, |
| 157 | const char *restrict servname, |
| 158 | const struct addrinfo *restrict hints, |
| 159 | struct addrinfo **restrict res) |
| 160 | _GL_ARG_NONNULL ((4)); |
| 161 | # endif |
| 162 | |
| 163 | # if !@HAVE_DECL_FREEADDRINFO@ |
| 164 | /* Free `addrinfo' structure AI including associated storage. |
| 165 | For more details, see the POSIX:2001 specification |
| 166 | <http://www.opengroup.org/susv3xsh/getaddrinfo.html>. */ |
| 167 | extern void freeaddrinfo (struct addrinfo *ai) _GL_ARG_NONNULL ((1)); |
| 168 | # endif |
| 169 | |
| 170 | # if !@HAVE_DECL_GAI_STRERROR@ |
| 171 | /* Convert error return from getaddrinfo() to a string. |
| 172 | For more details, see the POSIX:2001 specification |
| 173 | <http://www.opengroup.org/susv3xsh/gai_strerror.html>. */ |
| 174 | extern const char *gai_strerror (int ecode); |
| 175 | # endif |
| 176 | |
| 177 | # if !@HAVE_DECL_GETNAMEINFO@ |
| 178 | /* Convert socket address to printable node and service names. |
| 179 | For more details, see the POSIX:2001 specification |
| 180 | <http://www.opengroup.org/susv3xsh/getnameinfo.html>. */ |
| 181 | extern int getnameinfo (const struct sockaddr *restrict sa, socklen_t salen, |
| 182 | char *restrict node, socklen_t nodelen, |
| 183 | char *restrict service, socklen_t servicelen, |
| 184 | int flags) |
| 185 | _GL_ARG_NONNULL ((1)); |
| 186 | # endif |
| 187 | |
| 188 | /* Possible flags for getnameinfo. */ |
| 189 | # ifndef NI_NUMERICHOST |
| 190 | # define NI_NUMERICHOST 1 |
| 191 | # endif |
| 192 | # ifndef NI_NUMERICSERV |
| 193 | # define NI_NUMERICSERV 2 |
| 194 | # endif |
| 195 | |
| 196 | #elif defined GNULIB_POSIXCHECK |
| 197 | |
| 198 | # undef getaddrinfo |
| 199 | # if HAVE_RAW_DECL_GETADDRINFO |
| 200 | _GL_WARN_ON_USE (getaddrinfo, "getaddrinfo is unportable - " |
| 201 | "use gnulib module getaddrinfo for portability"); |
| 202 | # endif |
| 203 | |
| 204 | # undef freeaddrinfo |
| 205 | # if HAVE_RAW_DECL_FREEADDRINFO |
| 206 | _GL_WARN_ON_USE (freeaddrinfo, "freeaddrinfo is unportable - " |
| 207 | "use gnulib module getaddrinfo for portability"); |
| 208 | # endif |
| 209 | |
| 210 | # undef gai_strerror |
| 211 | # if HAVE_RAW_DECL_GAI_STRERROR |
| 212 | _GL_WARN_ON_USE (gai_strerror, "gai_strerror is unportable - " |
| 213 | "use gnulib module getaddrinfo for portability"); |
| 214 | # endif |
| 215 | |
| 216 | # undef getnameinfo |
| 217 | # if HAVE_RAW_DECL_GETNAMEINFO |
| 218 | _GL_WARN_ON_USE (getnameinfo, "getnameinfo is unportable - " |
| 219 | "use gnulib module getaddrinfo for portability"); |
| 220 | # endif |
| 221 | |
| 222 | #endif |
| 223 | |
| 224 | #endif /* _GL_NETDB_H */ |
| 225 | #endif /* _GL_NETDB_H */ |