netdb.h 19 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517
  1. /* Copyright (C) 1996,1997,1998,1999,2000,2001 Free Software Foundation, Inc.
  2. This file is part of the GNU C Library.
  3. The GNU C Library is free software; you can redistribute it and/or
  4. modify it under the terms of the GNU Lesser General Public
  5. License as published by the Free Software Foundation; either
  6. version 2.1 of the License, or (at your option) any later version.
  7. The GNU C Library is distributed in the hope that it will be useful,
  8. but WITHOUT ANY WARRANTY; without even the implied warranty of
  9. MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  10. Lesser General Public License for more details.
  11. You should have received a copy of the GNU Lesser General Public
  12. License along with the GNU C Library; if not, write to the Free
  13. Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
  14. 02111-1307 USA. */
  15. /* All data returned by the network data base library are supplied in
  16. host order and returned in network order (suitable for use in
  17. system calls). */
  18. #ifndef _NETDB_H
  19. #define _NETDB_H 1
  20. #include <features.h>
  21. #include <netinet/in.h>
  22. #include <stdint.h>
  23. #ifdef __USE_MISC
  24. /* This is necessary to make this include file properly replace the
  25. Sun version. */
  26. # include <rpc/netdb.h>
  27. #endif
  28. #ifdef __USE_GNU
  29. # define __need_sigevent_t
  30. # include <bits/siginfo.h>
  31. # define __need_timespec
  32. # include <time.h>
  33. #endif
  34. #include <bits/netdb.h>
  35. /* Absolute file name for network data base files. */
  36. #define _PATH_HEQUIV "/etc/hosts.equiv"
  37. #define _PATH_HOSTS "/etc/hosts"
  38. #define _PATH_NETWORKS "/etc/networks"
  39. #define _PATH_NSSWITCH_CONF "/etc/nsswitch.conf"
  40. #define _PATH_PROTOCOLS "/etc/protocols"
  41. #define _PATH_SERVICES "/etc/services"
  42. __BEGIN_DECLS
  43. /* Error status for non-reentrant lookup functions. */
  44. extern int h_errno;
  45. /* Function to get address of global `h_errno' variable. */
  46. extern int *__h_errno_location (void) __THROW __attribute__ ((__const__));
  47. #ifdef _LIBC
  48. # ifdef _LIBC_REENTRANT
  49. static inline int
  50. __set_h_errno (int __err)
  51. {
  52. return *__h_errno_location () = __err;
  53. }
  54. # else
  55. # define __set_h_errno(x) (h_errno = (x))
  56. # endif /* _LIBC_REENTRANT */
  57. #endif /* _LIBC */
  58. #if !defined _LIBC || defined _LIBC_REENTRANT
  59. /* Use a macro to access always the thread specific `h_errno' variable. */
  60. # define h_errno (*__h_errno_location ())
  61. #endif
  62. /* Possible values left in `h_errno'. */
  63. #define NETDB_INTERNAL -1 /* See errno. */
  64. #define NETDB_SUCCESS 0 /* No problem. */
  65. #define HOST_NOT_FOUND 1 /* Authoritative Answer Host not found. */
  66. #define TRY_AGAIN 2 /* Non-Authoritative Host not found,
  67. or SERVERFAIL. */
  68. #define NO_RECOVERY 3 /* Non recoverable errors, FORMERR, REFUSED,
  69. NOTIMP. */
  70. #define NO_DATA 4 /* Valid name, no data record of requested
  71. type. */
  72. #define NO_ADDRESS NO_DATA /* No address, look for MX record. */
  73. #ifdef __USE_XOPEN2K
  74. /* Highest reserved Internet port number. */
  75. # define IPPORT_RESERVED 1024
  76. #endif
  77. #ifdef __USE_GNU
  78. /* Scope delimiter for getaddrinfo(), getnameinfo(). */
  79. # define SCOPE_DELIMITER '%'
  80. #endif
  81. /* Print error indicated by `h_errno' variable on standard error. STR
  82. if non-null is printed before the error string. */
  83. extern void herror (__const char *__str) __THROW;
  84. /* Return string associated with error ERR_NUM. */
  85. extern __const char *hstrerror (int __err_num) __THROW;
  86. /* Description of data base entry for a single host. */
  87. struct hostent
  88. {
  89. char *h_name; /* Official name of host. */
  90. char **h_aliases; /* Alias list. */
  91. int h_addrtype; /* Host address type. */
  92. int h_length; /* Length of address. */
  93. char **h_addr_list; /* List of addresses from name server. */
  94. #define h_addr h_addr_list[0] /* Address, for backward compatibility. */
  95. };
  96. /* Open host data base files and mark them as staying open even after
  97. a later search if STAY_OPEN is non-zero. */
  98. extern void sethostent (int __stay_open) __THROW;
  99. /* Close host data base files and clear `stay open' flag. */
  100. extern void endhostent (void) __THROW;
  101. /* Get next entry from host data base file. Open data base if
  102. necessary. */
  103. extern struct hostent *gethostent (void) __THROW;
  104. /* Return entry from host data base which address match ADDR with
  105. length LEN and type TYPE. */
  106. extern struct hostent *gethostbyaddr (__const void *__addr, __socklen_t __len,
  107. int __type) __THROW;
  108. /* Return entry from host data base for host with NAME. */
  109. extern struct hostent *gethostbyname (__const char *__name) __THROW;
  110. #ifdef __USE_MISC
  111. /* Return entry from host data base for host with NAME. AF must be
  112. set to the address type which is `AF_INET' for IPv4 or `AF_INET6'
  113. for IPv6. */
  114. extern struct hostent *gethostbyname2 (__const char *__name, int __af) __THROW;
  115. /* Reentrant versions of the functions above. The additional
  116. arguments specify a buffer of BUFLEN starting at BUF. The last
  117. argument is a pointer to a variable which gets the value which
  118. would be stored in the global variable `herrno' by the
  119. non-reentrant functions. */
  120. extern int gethostent_r (struct hostent *__restrict __result_buf,
  121. char *__restrict __buf, size_t __buflen,
  122. struct hostent **__restrict __result,
  123. int *__restrict __h_errnop) __THROW;
  124. extern int gethostbyaddr_r (__const void *__restrict __addr, __socklen_t __len,
  125. int __type,
  126. struct hostent *__restrict __result_buf,
  127. char *__restrict __buf, size_t __buflen,
  128. struct hostent **__restrict __result,
  129. int *__restrict __h_errnop) __THROW;
  130. extern int gethostbyname_r (__const char *__restrict __name,
  131. struct hostent *__restrict __result_buf,
  132. char *__restrict __buf, size_t __buflen,
  133. struct hostent **__restrict __result,
  134. int *__restrict __h_errnop) __THROW;
  135. extern int gethostbyname2_r (__const char *__restrict __name, int __af,
  136. struct hostent *__restrict __result_buf,
  137. char *__restrict __buf, size_t __buflen,
  138. struct hostent **__restrict __result,
  139. int *__restrict __h_errnop) __THROW;
  140. #endif /* misc */
  141. /* Open network data base files and mark them as staying open even
  142. after a later search if STAY_OPEN is non-zero. */
  143. extern void setnetent (int __stay_open) __THROW;
  144. /* Close network data base files and clear `stay open' flag. */
  145. extern void endnetent (void) __THROW;
  146. /* Get next entry from network data base file. Open data base if
  147. necessary. */
  148. extern struct netent *getnetent (void) __THROW;
  149. /* Return entry from network data base which address match NET and
  150. type TYPE. */
  151. extern struct netent *getnetbyaddr (uint32_t __net, int __type)
  152. __THROW;
  153. /* Return entry from network data base for network with NAME. */
  154. extern struct netent *getnetbyname (__const char *__name) __THROW;
  155. #ifdef __USE_MISC
  156. /* Reentrant versions of the functions above. The additional
  157. arguments specify a buffer of BUFLEN starting at BUF. The last
  158. argument is a pointer to a variable which gets the value which
  159. would be stored in the global variable `herrno' by the
  160. non-reentrant functions. */
  161. extern int getnetent_r (struct netent *__restrict __result_buf,
  162. char *__restrict __buf, size_t __buflen,
  163. struct netent **__restrict __result,
  164. int *__restrict __h_errnop) __THROW;
  165. extern int getnetbyaddr_r (uint32_t __net, int __type,
  166. struct netent *__restrict __result_buf,
  167. char *__restrict __buf, size_t __buflen,
  168. struct netent **__restrict __result,
  169. int *__restrict __h_errnop) __THROW;
  170. extern int getnetbyname_r (__const char *__restrict __name,
  171. struct netent *__restrict __result_buf,
  172. char *__restrict __buf, size_t __buflen,
  173. struct netent **__restrict __result,
  174. int *__restrict __h_errnop) __THROW;
  175. #endif /* misc */
  176. /* Description of data base entry for a single service. */
  177. struct servent
  178. {
  179. char *s_name; /* Official service name. */
  180. char **s_aliases; /* Alias list. */
  181. int s_port; /* Port number. */
  182. char *s_proto; /* Protocol to use. */
  183. };
  184. /* Open service data base files and mark them as staying open even
  185. after a later search if STAY_OPEN is non-zero. */
  186. extern void setservent (int __stay_open) __THROW;
  187. /* Close service data base files and clear `stay open' flag. */
  188. extern void endservent (void) __THROW;
  189. /* Get next entry from service data base file. Open data base if
  190. necessary. */
  191. extern struct servent *getservent (void) __THROW;
  192. /* Return entry from network data base for network with NAME and
  193. protocol PROTO. */
  194. extern struct servent *getservbyname (__const char *__name,
  195. __const char *__proto) __THROW;
  196. /* Return entry from service data base which matches port PORT and
  197. protocol PROTO. */
  198. extern struct servent *getservbyport (int __port, __const char *__proto)
  199. __THROW;
  200. #ifdef __USE_MISC
  201. /* Reentrant versions of the functions above. The additional
  202. arguments specify a buffer of BUFLEN starting at BUF. */
  203. extern int getservent_r (struct servent *__restrict __result_buf,
  204. char *__restrict __buf, size_t __buflen,
  205. struct servent **__restrict __result) __THROW;
  206. extern int getservbyname_r (__const char *__restrict __name,
  207. __const char *__restrict __proto,
  208. struct servent *__restrict __result_buf,
  209. char *__restrict __buf, size_t __buflen,
  210. struct servent **__restrict __result) __THROW;
  211. extern int getservbyport_r (int __port, __const char *__restrict __proto,
  212. struct servent *__restrict __result_buf,
  213. char *__restrict __buf, size_t __buflen,
  214. struct servent **__restrict __result) __THROW;
  215. #endif /* misc */
  216. /* Description of data base entry for a single service. */
  217. struct protoent
  218. {
  219. char *p_name; /* Official protocol name. */
  220. char **p_aliases; /* Alias list. */
  221. int p_proto; /* Protocol number. */
  222. };
  223. /* Open protocol data base files and mark them as staying open even
  224. after a later search if STAY_OPEN is non-zero. */
  225. extern void setprotoent (int __stay_open) __THROW;
  226. /* Close protocol data base files and clear `stay open' flag. */
  227. extern void endprotoent (void) __THROW;
  228. /* Get next entry from protocol data base file. Open data base if
  229. necessary. */
  230. extern struct protoent *getprotoent (void) __THROW;
  231. /* Return entry from protocol data base for network with NAME. */
  232. extern struct protoent *getprotobyname (__const char *__name) __THROW;
  233. /* Return entry from protocol data base which number is PROTO. */
  234. extern struct protoent *getprotobynumber (int __proto) __THROW;
  235. #ifdef __USE_MISC
  236. /* Reentrant versions of the functions above. The additional
  237. arguments specify a buffer of BUFLEN starting at BUF. */
  238. extern int getprotoent_r (struct protoent *__restrict __result_buf,
  239. char *__restrict __buf, size_t __buflen,
  240. struct protoent **__restrict __result) __THROW;
  241. extern int getprotobyname_r (__const char *__restrict __name,
  242. struct protoent *__restrict __result_buf,
  243. char *__restrict __buf, size_t __buflen,
  244. struct protoent **__restrict __result) __THROW;
  245. extern int getprotobynumber_r (int __proto,
  246. struct protoent *__restrict __result_buf,
  247. char *__restrict __buf, size_t __buflen,
  248. struct protoent **__restrict __result) __THROW;
  249. #endif /* misc */
  250. /* Establish network group NETGROUP for enumeration. */
  251. extern int setnetgrent (__const char *__netgroup) __THROW;
  252. /* Free all space allocated by previous `setnetgrent' call. */
  253. extern void endnetgrent (void) __THROW;
  254. /* Get next member of netgroup established by last `setnetgrent' call
  255. and return pointers to elements in HOSTP, USERP, and DOMAINP. */
  256. extern int getnetgrent (char **__restrict __hostp,
  257. char **__restrict __userp,
  258. char **__restrict __domainp) __THROW;
  259. #ifdef __USE_MISC
  260. /* Test whether NETGROUP contains the triple (HOST,USER,DOMAIN). */
  261. extern int innetgr (__const char *__netgroup, __const char *__host,
  262. __const char *__user, __const char *domain) __THROW;
  263. /* Reentrant version of `getnetgrent' where result is placed in BUFFER. */
  264. extern int getnetgrent_r (char **__restrict __hostp,
  265. char **__restrict __userp,
  266. char **__restrict __domainp,
  267. char *__restrict __buffer, size_t __buflen) __THROW;
  268. #endif /* misc */
  269. #ifdef __USE_BSD
  270. /* Call `rshd' at port RPORT on remote machine *AHOST to execute CMD.
  271. The local user is LOCUSER, on the remote machine the command is
  272. executed as REMUSER. In *FD2P the descriptor to the socket for the
  273. connection is returned. The caller must have the right to use a
  274. reserved port. When the function returns *AHOST contains the
  275. official host name. */
  276. extern int rcmd (char **__restrict __ahost, unsigned short int __rport,
  277. __const char *__restrict __locuser,
  278. __const char *__restrict __remuser,
  279. __const char *__restrict __cmd, int *__restrict __fd2p)
  280. __THROW;
  281. /* This is the equivalent function where the protocol can be selected
  282. and which therefore can be used for IPv6. */
  283. extern int rcmd_af (char **__restrict __ahost, unsigned short int __rport,
  284. __const char *__restrict __locuser,
  285. __const char *__restrict __remuser,
  286. __const char *__restrict __cmd, int *__restrict __fd2p,
  287. sa_family_t __af) __THROW;
  288. /* Call `rexecd' at port RPORT on remote machine *AHOST to execute
  289. CMD. The process runs at the remote machine using the ID of user
  290. NAME whose cleartext password is PASSWD. In *FD2P the descriptor
  291. to the socket for the connection is returned. When the function
  292. returns *AHOST contains the official host name. */
  293. extern int rexec (char **__restrict __ahost, int __rport,
  294. __const char *__restrict __name,
  295. __const char *__restrict __pass,
  296. __const char *__restrict __cmd, int *__restrict __fd2p)
  297. __THROW;
  298. /* This is the equivalent function where the protocol can be selected
  299. and which therefore can be used for IPv6. */
  300. extern int rexec_af (char **__restrict __ahost, int __rport,
  301. __const char *__restrict __name,
  302. __const char *__restrict __pass,
  303. __const char *__restrict __cmd, int *__restrict __fd2p,
  304. sa_family_t __af) __THROW;
  305. /* Check whether user REMUSER on system RHOST is allowed to login as LOCUSER.
  306. If SUSER is not zero the user tries to become superuser. Return 0 if
  307. it is possible. */
  308. extern int ruserok (__const char *__rhost, int __suser,
  309. __const char *__remuser, __const char *__locuser) __THROW;
  310. /* This is the equivalent function where the protocol can be selected
  311. and which therefore can be used for IPv6. */
  312. extern int ruserok_af (__const char *__rhost, int __suser,
  313. __const char *__remuser, __const char *__locuser,
  314. sa_family_t __af) __THROW;
  315. /* Try to allocate reserved port, returning a descriptor for a socket opened
  316. at this port or -1 if unsuccessful. The search for an available port
  317. will start at ALPORT and continues with lower numbers. */
  318. extern int rresvport (int *__alport) __THROW;
  319. /* This is the equivalent function where the protocol can be selected
  320. and which therefore can be used for IPv6. */
  321. extern int rresvport_af (int *__alport, sa_family_t __af) __THROW;
  322. #endif
  323. /* Extension from POSIX.1g. */
  324. #ifdef __USE_POSIX
  325. /* Structure to contain information about address of a service provider. */
  326. struct addrinfo
  327. {
  328. int ai_flags; /* Input flags. */
  329. int ai_family; /* Protocol family for socket. */
  330. int ai_socktype; /* Socket type. */
  331. int ai_protocol; /* Protocol for socket. */
  332. socklen_t ai_addrlen; /* Length of socket address. */
  333. struct sockaddr *ai_addr; /* Socket address for socket. */
  334. char *ai_canonname; /* Canonical name for service location. */
  335. struct addrinfo *ai_next; /* Pointer to next in list. */
  336. };
  337. # ifdef __USE_GNU
  338. /* Structure used as control block for asynchronous lookup. */
  339. struct gaicb
  340. {
  341. const char *ar_name; /* Name to look up. */
  342. const char *ar_service; /* Service name. */
  343. const struct addrinfo *ar_request; /* Additional request specification. */
  344. struct addrinfo *ar_result; /* Pointer to result. */
  345. /* The following are internal elements. */
  346. int __return;
  347. int __unused[5];
  348. };
  349. /* Lookup mode. */
  350. # define GAI_WAIT 0
  351. # define GAI_NOWAIT 1
  352. # endif
  353. /* Possible values for `ai_flags' field in `addrinfo' structure. */
  354. # define AI_PASSIVE 0x0001 /* Socket address is intended for `bind'. */
  355. # define AI_CANONNAME 0x0002 /* Request for canonical name. */
  356. # define AI_NUMERICHOST 0x0004 /* Don't use name resolution. */
  357. /* Error values for `getaddrinfo' function. */
  358. # define EAI_BADFLAGS -1 /* Invalid value for `ai_flags' field. */
  359. # define EAI_NONAME -2 /* NAME or SERVICE is unknown. */
  360. # define EAI_AGAIN -3 /* Temporary failure in name resolution. */
  361. # define EAI_FAIL -4 /* Non-recoverable failure in name res. */
  362. # define EAI_NODATA -5 /* No address associated with NAME. */
  363. # define EAI_FAMILY -6 /* `ai_family' not supported. */
  364. # define EAI_SOCKTYPE -7 /* `ai_socktype' not supported. */
  365. # define EAI_SERVICE -8 /* SERVICE not supported for `ai_socktype'. */
  366. # define EAI_ADDRFAMILY -9 /* Address family for NAME not supported. */
  367. # define EAI_MEMORY -10 /* Memory allocation failure. */
  368. # define EAI_SYSTEM -11 /* System error returned in `errno'. */
  369. # ifdef __USE_GNU
  370. # define EAI_INPROGRESS -100 /* Processing request in progress. */
  371. # define EAI_CANCELED -101 /* Request canceled. */
  372. # define EAI_NOTCANCELED -102 /* Request not canceled. */
  373. # define EAI_ALLDONE -103 /* All requests done. */
  374. # define EAI_INTR -104 /* Interrupted by a signal. */
  375. # endif
  376. # define NI_MAXHOST 1025
  377. # define NI_MAXSERV 32
  378. # define NI_NUMERICHOST 1 /* Don't try to look up hostname. */
  379. # define NI_NUMERICSERV 2 /* Don't convert port number to name. */
  380. # define NI_NOFQDN 4 /* Only return nodename portion. */
  381. # define NI_NAMEREQD 8 /* Don't return numeric addresses. */
  382. # define NI_DGRAM 16 /* Look up UDP service rather than TCP. */
  383. /* Translate name of a service location and/or a service name to set of
  384. socket addresses. */
  385. extern int getaddrinfo (__const char *__restrict __name,
  386. __const char *__restrict __service,
  387. __const struct addrinfo *__restrict __req,
  388. struct addrinfo **__restrict __pai) __THROW;
  389. /* Free `addrinfo' structure AI including associated storage. */
  390. extern void freeaddrinfo (struct addrinfo *__ai) __THROW;
  391. /* Convert error return from getaddrinfo() to a string. */
  392. extern __const char *gai_strerror (int __ecode) __THROW;
  393. /* Translate a socket address to a location and service name. */
  394. extern int getnameinfo (__const struct sockaddr *__restrict __sa,
  395. socklen_t __salen, char *__restrict __host,
  396. socklen_t __hostlen, char *__restrict __serv,
  397. socklen_t __servlen, unsigned int __flags) __THROW;
  398. # ifdef __USE_GNU
  399. /* Enqueue ENT requests from the LIST. If MODE is GAI_WAIT wait until all
  400. requests are handled. If WAIT is GAI_NOWAIT return immediately after
  401. queueing the requests and signal completion according to SIG. */
  402. extern int getaddrinfo_a (int __mode, struct gaicb *__list[__restrict_arr],
  403. int __ent, struct sigevent *__restrict __sig)
  404. __THROW;
  405. /* Suspend execution of the thread until at least one of the ENT requests
  406. in LIST is handled. If TIMEOUT is not a null pointer it specifies the
  407. longest time the function keeps waiting before returning with an error. */
  408. extern int gai_suspend (__const struct gaicb *__const __list[], int __ent,
  409. __const struct timespec *__timeout) __THROW;
  410. /* Get the error status of the request REQ. */
  411. extern int gai_error (struct gaicb *__req) __THROW;
  412. /* Cancel the requests associated with GAICBP. */
  413. extern int gai_cancel (struct gaicb *__gaicbp) __THROW;
  414. # endif /* GNU */
  415. #endif /* POSIX */
  416. __END_DECLS
  417. #endif /* netdb.h */