Move internal interfaces to include/netdb.h.
[kopensolaris-gnu/glibc.git] / resolv / netdb.h
index 38622e8..299d695 100644 (file)
@@ -1,4 +1,4 @@
-/* Copyright (C) 1996 Free Software Foundation, Inc.
+/* Copyright (C) 1996, 1997, 1998 Free Software Foundation, Inc.
    This file is part of the GNU C Library.
 
    The GNU C Library is free software; you can redistribute it
    This file is part of the GNU C Library.
 
    The GNU C Library is free software; you can redistribute it
    system calls).  */
 
 #ifndef        _NETDB_H
    system calls).  */
 
 #ifndef        _NETDB_H
-
 #define        _NETDB_H        1
 #define        _NETDB_H        1
+
 #include <features.h>
 
 /* This is necessary to make this include file properly replace the
    Sun version.  */
 #include <rpc/netdb.h>
 #include <features.h>
 
 /* This is necessary to make this include file properly replace the
    Sun version.  */
 #include <rpc/netdb.h>
+#include <sys/socket.h>                /* need socklen_t */
+#define __need_size_t
+#include <stddef.h>
 
 /* Absolute file name for network data base files.  */
 #define        _PATH_HEQUIV            "/etc/hosts.equiv"
 
 /* Absolute file name for network data base files.  */
 #define        _PATH_HEQUIV            "/etc/hosts.equiv"
@@ -43,28 +46,33 @@ __BEGIN_DECLS
 /* Error status for non-reentrant lookup functions.  */
 extern int h_errno;
 
 /* Error status for non-reentrant lookup functions.  */
 extern int h_errno;
 
-#if defined __USE_REENTRANT && (!defined _LIBC || defined _LIBC_REENTRANT)
-/* Function to access thread specific `h_errno' variable.  */
+/* Function to get address of global `h_errno' variable.  */
 extern int *__h_errno_location __P ((void)) __attribute__ ((__const__));
 
 extern int *__h_errno_location __P ((void)) __attribute__ ((__const__));
 
-/* An alias name for above variable.  */
-extern int __h_errno;
+#ifdef _LIBC
+# ifdef _LIBC_REENTRANT
+static inline int
+__set_h_errno (int __err)
+{
+  return *__h_errno_location () = __err;
+}
+# else
+#  define __set_h_errno(x) (h_errno = (x))
+# endif        /* _LIBC_REENTRANT */
+#endif /* _LIBC */
 
 
-/* Use a macro to access always the thread specific `h_errno' variable.  */
-#define h_errno (*__h_errno_location ())
 
 
-/* Retain some binary compatibility with old libraries by having both the
-   global variable and the per-thread variable set on error.  */
-#define __set_h_errno(x) (h_errno = __h_errno = (x))
-#else
-#define __set_h_errno(x) (h_errno = (x))
+#if !defined _LIBC || defined _LIBC_REENTRANT
+/* Use a macro to access always the thread specific `h_errno' variable.  */
+# define h_errno (*__h_errno_location ())
 #endif
 
 #endif
 
+
 /* Possible values left in `h_errno'.  */
 #define        NETDB_INTERNAL  -1      /* See errno.  */
 #define        NETDB_SUCCESS   0       /* No problem.  */
 #define        HOST_NOT_FOUND  1       /* Authoritative Answer Host not found.  */
 /* Possible values left in `h_errno'.  */
 #define        NETDB_INTERNAL  -1      /* See errno.  */
 #define        NETDB_SUCCESS   0       /* No problem.  */
 #define        HOST_NOT_FOUND  1       /* Authoritative Answer Host not found.  */
-#define        TRY_AGAIN       2       /* Non-Authoritive Host not found,
+#define        TRY_AGAIN       2       /* Non-Authoritative Host not found,
                                   or SERVERFAIL.  */
 #define        NO_RECOVERY     3       /* Non recoverable errors, FORMERR, REFUSED,
                                   NOTIMP.  */
                                   or SERVERFAIL.  */
 #define        NO_RECOVERY     3       /* Non recoverable errors, FORMERR, REFUSED,
                                   NOTIMP.  */
@@ -89,7 +97,7 @@ struct hostent
   int h_addrtype;              /* Host address type.  */
   int h_length;                        /* Length of address.  */
   char **h_addr_list;          /* List of addresses from name server.  */
   int h_addrtype;              /* Host address type.  */
   int h_length;                        /* Length of address.  */
   char **h_addr_list;          /* List of addresses from name server.  */
-#define        h_addr  h_addr_list[0]  /* Address, for backward compatiblity.  */
+#define        h_addr  h_addr_list[0]  /* Address, for backward compatibility.  */
 };
 
 /* Open host data base files and mark them as staying open even after
 };
 
 /* Open host data base files and mark them as staying open even after
@@ -112,52 +120,53 @@ extern struct hostent *gethostbyaddr __P ((__const char *__addr, int __len,
 extern struct hostent *gethostbyname __P ((__const char *__name));
 
 /* Return entry from host data base for host with NAME.  AF must be
 extern struct hostent *gethostbyname __P ((__const char *__name));
 
 /* Return entry from host data base for host with NAME.  AF must be
-   set to the address type which as `AF_INET' for IPv4 or `AF_INET6'
+   set to the address type which is `AF_INET' for IPv4 or `AF_INET6'
    for IPv6.  */
 extern struct hostent *gethostbyname2 __P ((__const char *__name, int __af));
 
    for IPv6.  */
 extern struct hostent *gethostbyname2 __P ((__const char *__name, int __af));
 
-#ifdef __USE_REENTRANT
+#ifdef __USE_MISC
 /* Reentrant versions of the functions above.  The additional
    arguments specify a buffer of BUFLEN starting at BUF.  The last
    argument is a pointer to a variable which gets the value which
    would be stored in the global variable `herrno' by the
    non-reentrant functions.  */
 /* Reentrant versions of the functions above.  The additional
    arguments specify a buffer of BUFLEN starting at BUF.  The last
    argument is a pointer to a variable which gets the value which
    would be stored in the global variable `herrno' by the
    non-reentrant functions.  */
-extern struct hostent *__gethostent_r __P ((struct hostent *__result_buf,
-                                           char *__buf, int __buf_len,
-                                           int *__h_errnop));
-extern struct hostent *gethostent_r __P ((struct hostent *__result_buf,
-                                         char *__buf, int __buf_len,
-                                         int *__h_errnop));
-
-extern struct hostent *__gethostbyaddr_r __P ((__const char *__addr, int __len,
-                                              int __type,
-                                              struct hostent *__result_buf,
-                                              char *__buf, int __buflen,
-                                              int *__h_errnop));
-extern struct hostent *gethostbyaddr_r __P ((__const char *__addr, int __len,
-                                            int __type,
-                                            struct hostent *__result_buf,
-                                            char *__buf, int __buflen,
-                                            int *__h_errnop));
-
-extern struct hostent *__gethostbyname_r __P ((__const char *__name,
-                                              struct hostent *__result_buf,
-                                              char *__buf, int __buflen,
-                                              int *__h_errnop));
-extern struct hostent *gethostbyname_r __P ((__const char *__name,
-                                            struct hostent *__result_buf,
-                                            char *__buf, int __buflen,
-                                            int *__h_errnop));
-
-extern struct hostent *__gethostbyname2_r __P ((__const char *__name, int __af,
-                                               struct hostent *__result_buf,
-                                               char *__buf, int __buflen,
-                                               int *__h_errnop));
-extern struct hostent *gethostbyname2_r __P ((__const char *__name, int __af,
-                                             struct hostent *__result_buf,
-                                             char *__buf, int __buflen,
-                                             int *__h_errnop));
-#endif /* reentrant */
+extern int gethostent_r __P ((struct hostent *__restrict __result_buf,
+                             char *__restrict __buf, size_t __buflen,
+                             struct hostent **__restrict __result,
+                             int *__restrict __h_errnop));
+
+extern int gethostbyaddr_r __P ((__const char *__restrict __addr, int __len,
+                                int __type,
+                                struct hostent *__restrict __result_buf,
+                                char *__restrict __buf, size_t __buflen,
+                                struct hostent **__restrict __result,
+                                int *__restrict __h_errnop));
+
+extern int gethostbyname_r __P ((__const char *__restrict __name,
+                                struct hostent *__restrict __result_buf,
+                                char *__restrict __buf, size_t __buflen,
+                                struct hostent **__restrict __result,
+                                int *__restrict __h_errnop));
+
+extern int gethostbyname2_r __P ((__const char *__restrict __name, int __af,
+                                 struct hostent *__restrict __result_buf,
+                                 char *__restrict __buf, size_t __buflen,
+                                 struct hostent **__restrict __result,
+                                 int *__restrict __h_errnop));
+#endif /* misc */
+
+
+/* Return entry from host data base for host with NAME.  AF must be
+   set to the desired address type (either `AF_INET' or `AF_INET6').
+   FLAGS is some combination of the following AI_* values.  */
+extern struct hostent *getnodebyname __P ((__const char *__name, int __af,
+                                          int __flags));
+
+#define AI_V4MAPPED    1       /* IPv4-mapped addresses are acceptable.  */
+#define AI_ALL         2       /* Return both IPv4 and IPv6 addresses.  */
+#define AI_ADDRCONFIG  4       /* Use configuration of this host to choose
+                                  returned address type.  */
+#define AI_DEFAULT     (AI_V4MAPPED | AI_ADDRCONFIG)
 
 
 /* Description of data base entry for a single network.  NOTE: here a
 
 
 /* Description of data base entry for a single network.  NOTE: here a
@@ -190,39 +199,29 @@ extern struct netent *getnetbyaddr __P ((unsigned long int __net,
 /* Return entry from network data base for network with NAME.  */
 extern struct netent *getnetbyname __P ((__const char *__name));
 
 /* Return entry from network data base for network with NAME.  */
 extern struct netent *getnetbyname __P ((__const char *__name));
 
-#ifdef __USE_REENTRANT
+#ifdef __USE_MISC
 /* Reentrant versions of the functions above.  The additional
    arguments specify a buffer of BUFLEN starting at BUF.  The last
    argument is a pointer to a variable which gets the value which
    would be stored in the global variable `herrno' by the
    non-reentrant functions.  */
 /* Reentrant versions of the functions above.  The additional
    arguments specify a buffer of BUFLEN starting at BUF.  The last
    argument is a pointer to a variable which gets the value which
    would be stored in the global variable `herrno' by the
    non-reentrant functions.  */
-extern struct netent *__getnetent_r __P ((struct netent *__result_buf,
-                                         char *__buf, int __buf_len,
-                                         int *__h_errnop));
-extern struct netent *getnetent_r __P ((struct netent *__result_buf,
-                                       char *__buf, int __buf_len,
-                                       int *__h_errnop));
-
-extern struct netent *__getnetbyaddr_r __P ((unsigned long int __net,
-                                            int __type,
-                                            struct netent *__result_buf,
-                                            char *__buf, int __buflen,
-                                            int *__h_errnop));
-extern struct netent *getnetbyaddr_r __P ((unsigned long int __net,
-                                          int __type,
-                                          struct netent *__result_buf,
-                                          char *__buf, int __buflen,
-                                          int *__h_errnop));
-
-extern struct netent *__getnetbyname_r __P ((__const char *__name,
-                                            struct netent *__result_buf,
-                                            char *__buf, int __buflen,
-                                            int *__h_errnop));
-extern struct netent *getnetbyname_r __P ((__const char *__name,
-                                          struct netent *__result_buf,
-                                          char *__buf, int __buflen,
-                                          int *__h_errnop));
-#endif /* reentrant */
+extern int getnetent_r __P ((struct netent *__restrict __result_buf,
+                            char *__restrict __buf, size_t __buflen,
+                            struct netent **__restrict __result,
+                            int *__restrict __h_errnop));
+
+extern int getnetbyaddr_r __P ((unsigned long int __net, int __type,
+                               struct netent *__restrict __result_buf,
+                               char *__restrict __buf, size_t __buflen,
+                               struct netent **__restrict __result,
+                               int *__restrict __h_errnop));
+
+extern int getnetbyname_r __P ((__const char *__restrict __name,
+                               struct netent *__restrict __result_buf,
+                               char *__restrict __buf, size_t __buflen,
+                               struct netent **__restrict __result,
+                               int *__restrict __h_errnop));
+#endif /* misc */
 
 
 /* Description of data base entry for a single service.  */
 
 
 /* Description of data base entry for a single service.  */
@@ -255,31 +254,24 @@ extern struct servent *getservbyname __P ((__const char *__name,
 extern struct servent *getservbyport __P ((int __port, __const char *__proto));
 
 
 extern struct servent *getservbyport __P ((int __port, __const char *__proto));
 
 
-#ifdef __USE_REENTRANT
+#ifdef __USE_MISC
 /* Reentrant versions of the functions above.  The additional
    arguments specify a buffer of BUFLEN starting at BUF.  */
 /* Reentrant versions of the functions above.  The additional
    arguments specify a buffer of BUFLEN starting at BUF.  */
-extern struct servent *__getservent_r __P ((struct servent *__result_buf,
-                                           char *__buf, int __buf_len));
-extern struct servent *getservent_r __P ((struct servent *__result_buf,
-                                         char *__buf, int __buf_len));
-
-extern struct servent *__getservbyname_r __P ((__const char *__name,
-                                              __const char *__proto,
-                                              struct servent *__result_buf,
-                                              char *__buf, int __buflen));
-extern struct servent *getservbyname_r __P ((__const char *__name,
-                                            __const char *__proto,
-                                            struct servent *__result_buf,
-                                            char *__buf, int __buflen));
-
-extern struct servent *__getservbyport_r __P ((int __port,
-                                              __const char *__proto,
-                                              struct servent *__result_buf,
-                                              char *__buf, int __buflen));
-extern struct servent *getservbyport_r __P ((int __port, __const char *__proto,
-                                            struct servent *__result_buf,
-                                            char *__buf, int __buflen));
-#endif /* reentrant */
+extern int getservent_r __P ((struct servent *__restrict __result_buf,
+                             char *__restrict __buf, size_t __buflen,
+                             struct servent **__restrict __result));
+
+extern int getservbyname_r __P ((__const char *__restrict __name,
+                                __const char *__restrict __proto,
+                                struct servent *__restrict __result_buf,
+                                char *__restrict __buf, size_t __buflen,
+                                struct servent **__restrict __result));
+
+extern int getservbyport_r __P ((int __port, __const char *__restrict __proto,
+                                struct servent *__restrict __result_buf,
+                                char *__restrict __buf, size_t __buflen,
+                                struct servent **__restrict __result));
+#endif /* misc */
 
 
 /* Description of data base entry for a single service.  */
 
 
 /* Description of data base entry for a single service.  */
@@ -308,28 +300,23 @@ extern struct protoent *getprotobyname __P ((__const char *__name));
 extern struct protoent *getprotobynumber __P ((int __proto));
 
 
 extern struct protoent *getprotobynumber __P ((int __proto));
 
 
-#ifdef __USE_REENTRANT
+#ifdef __USE_MISC
 /* Reentrant versions of the functions above.  The additional
    arguments specify a buffer of BUFLEN starting at BUF.  */
 /* Reentrant versions of the functions above.  The additional
    arguments specify a buffer of BUFLEN starting at BUF.  */
-extern struct protoent *__getprotoent_r __P ((struct protoent *__result_buf,
-                                             char *__buf, int __buf_len));
-extern struct protoent *getprotoent_r __P ((struct protoent *__result_buf,
-                                           char *__buf, int __buf_len));
-
-extern struct protoent *__getprotobyname_r __P ((__const char *__name,
-                                                struct protoent *__result_buf,
-                                                char *__buf, int __buflen));
-extern struct protoent *getprotobyname_r __P ((__const char *__name,
-                                              struct protoent *__result_buf,
-                                              char *__buf, int __buflen));
-
-extern struct protoent *__getprotobynumber_r __P ((int __proto,
-                                                  struct protoent *__res_buf,
-                                                  char *__buf, int __buflen));
-extern struct protoent *getprotobynumber_r __P ((int __proto,
-                                                struct protoent *__result_buf,
-                                                char *__buf, int __buflen));
-#endif /* reentrant */
+extern int getprotoent_r __P ((struct protoent *__restrict __result_buf,
+                              char *__restrict __buf, size_t __buflen,
+                              struct protoent **__restrict __result));
+
+extern int getprotobyname_r __P ((__const char *__restrict __name,
+                                 struct protoent *__restrict __result_buf,
+                                 char *__restrict __buf, size_t __buflen,
+                                 struct protoent **__restrict __result));
+
+extern int getprotobynumber_r __P ((int __proto,
+                                   struct protoent *__restrict __result_buf,
+                                   char *__restrict __buf, size_t __buflen,
+                                   struct protoent **__restrict __result));
+#endif /* misc */
 
 
 /* Establish network group NETGROUP for enumeration.  */
 
 
 /* Establish network group NETGROUP for enumeration.  */
@@ -340,21 +327,56 @@ extern void endnetgrent __P ((void));
 
 /* Get next member of netgroup established by last `setnetgrent' call
    and return pointers to elements in HOSTP, USERP, and DOMAINP.  */
 
 /* Get next member of netgroup established by last `setnetgrent' call
    and return pointers to elements in HOSTP, USERP, and DOMAINP.  */
-extern int getnetgrent __P ((char **__hostp, char **__userp,
-                            char **__domainp));
+extern int getnetgrent __P ((char **__restrict __hostp,
+                            char **__restrict __userp,
+                            char **__restrict __domainp));
 
 /* Test whether NETGROUP contains the triple (HOST,USER,DOMAIN).  */
 extern int innetgr __P ((__const char *__netgroup, __const char *__host,
                         __const char *__user, __const char *domain));
 
 
 /* Test whether NETGROUP contains the triple (HOST,USER,DOMAIN).  */
 extern int innetgr __P ((__const char *__netgroup, __const char *__host,
                         __const char *__user, __const char *domain));
 
-#ifdef __USE_REENTRANT
+#ifdef __USE_MISC
 /* Reentrant version of `getnetgrent' where result is placed in BUFFER.  */
 /* Reentrant version of `getnetgrent' where result is placed in BUFFER.  */
-extern int __getnetgrent_r __P ((char **__hostp, char **__userp,
-                                char **__domainp,
-                                char *__buffer, int __buflen));
-extern int getnetgrent_r __P ((char **__hostp, char **__userp,
-                              char **__domainp,
-                              char *__buffer, int __buflen));
+extern int getnetgrent_r __P ((char **__restrict __hostp,
+                              char **__restrict __userp,
+                              char **__restrict __domainp,
+                              char *__restrict __buffer, size_t __buflen));
+#endif /* misc */
+
+
+#ifdef __USE_BSD
+/* Call `rshd' at port RPORT on remote machine *AHOST to execute CMD.
+   The local user is LOCUSER, on the remote machine the command is
+   executed as REMUSER.  In *FD2P the descriptor to the socket for the
+   connection is returned.  The caller must have the right to use a
+   reserved port.  When the function returns *AHOST contains the
+   official host name.  */
+extern int rcmd __P ((char **__restrict __ahost, unsigned short int __rport,
+                     __const char *__restrict __locuser,
+                     __const char *__restrict __remuser,
+                     __const char *__restrict __cmd, int *__restrict __fd2p));
+
+/* Call `rexecd' at port RPORT on remote machine *AHOST to execute
+   CMD.  The process runs at the remote machine using the ID of user
+   NAME whose cleartext password is PASSWD.  In *FD2P the descriptor
+   to the socket for the connection is returned.  When the function
+   returns *AHOST contains the official host name.  */
+extern int rexec __P ((char **__restrict __ahost, int __rport,
+                      __const char *__restrict __name,
+                      __const char *__restrict __pass,
+                      __const char *__restrict __cmd,
+                      int *__restrict __fd2p));
+
+/* Check whether user REMUSER on system RHOST is allowed to login as LOCUSER.
+   If SUSER is not zero the user tries to become superuser.  Return 0 if
+   it is possible.  */
+extern int ruserok __P ((__const char *__rhost, int __suser,
+                        __const char *__remuser, __const char *__locuser));
+
+/* Try to allocate reserved port, returning a descriptor for a socket opened
+   at this port or -1 if unsuccessful.  The search for an available port
+   will start at ALPORT and continues with lower numbers.  */
+extern int rresvport __P ((int *__alport));
 #endif
 
 
 #endif
 
 
@@ -374,31 +396,52 @@ struct addrinfo
 };
 
 /* Possible values for `ai_flags' field in `addrinfo' structure.  */
 };
 
 /* Possible values for `ai_flags' field in `addrinfo' structure.  */
-#define        AI_PASSIVE      1       /* Socket address is intended for `bind'.  */
-#define        AI_CANONNAME    2       /* Request for canonical name.  */
+# define AI_PASSIVE    1       /* Socket address is intended for `bind'.  */
+# define AI_CANONNAME  2       /* Request for canonical name.  */
+# define AI_NUMERICHOST        3       /* Don't use name resolution.  */
 
 /* Error values for `getaddrinfo' function.  */
 
 /* Error values for `getaddrinfo' function.  */
-#define        EAI_BADFLAGS    -1      /* Invalid value for `ai_flags' field.  */
-#define        EAI_NONAME      -2      /* NAME or SERVICE is unknown.  */
-#define        EAI_AGAIN       -3      /* Temporary failure in name resolution.  */
-#define        EAI_FAIL        -4      /* Non-recoverable failure in name res.  */
-#define        EAI_NODATA      -5      /* No address associated with NAME.  */
-#define        EAI_FAMILY      -6      /* `ai_family' not supported.  */
-#define        EAI_SOCKTYPE    -7      /* `ai_socktype' not supported.  */
-#define        EAI_SERVICE     -8      /* SERVICE not supported for `ai_socktype'.  */
-#define        EAI_ADDRFAMILY  -9      /* Address family for NAME not supported.  */
-#define        EAI_MEMORY      -10     /* Memory allocation failure.  */
-#define        EAI_SYSTEM      -11     /* System error returned in `errno'.  */
-
+# define EAI_BADFLAGS  -1      /* Invalid value for `ai_flags' field.  */
+# define EAI_NONAME    -2      /* NAME or SERVICE is unknown.  */
+# define EAI_AGAIN     -3      /* Temporary failure in name resolution.  */
+# define EAI_FAIL      -4      /* Non-recoverable failure in name res.  */
+# define EAI_NODATA    -5      /* No address associated with NAME.  */
+# define EAI_FAMILY    -6      /* `ai_family' not supported.  */
+# define EAI_SOCKTYPE  -7      /* `ai_socktype' not supported.  */
+# define EAI_SERVICE   -8      /* SERVICE not supported for `ai_socktype'.  */
+# define EAI_ADDRFAMILY        -9      /* Address family for NAME not supported.  */
+# define EAI_MEMORY    -10     /* Memory allocation failure.  */
+# define EAI_SYSTEM    -11     /* System error returned in `errno'.  */
+
+# define NI_MAXHOST      1025
+# define NI_MAXSERV      32
+
+# define NI_NUMERICHOST        1       /* Don't try to look up hostname.  */
+# define NI_NUMERICSERV 2      /* Don't convert port number to name.  */
+# define NI_NOFQDN     4       /* Only return nodename portion.  */
+# define NI_NAMEREQD   8       /* Don't return numeric addresses.  */
+# define NI_DGRAM      16      /* Look up UDP service rather than TCP.  */
 
 /* Translate name of a service location and/or a service name to set of
    socket addresses.  */
 
 /* Translate name of a service location and/or a service name to set of
    socket addresses.  */
-extern int getaddrinfo __P ((__const char *__name, __const char *__service,
-                            __const struct addrinfo *__req,
-                            struct addrinfo **__pai));
+extern int getaddrinfo __P ((__const char *__restrict __name,
+                            __const char *__restrict __service,
+                            __const struct addrinfo *__restrict __req,
+                            struct addrinfo **__restrict __pai));
 
 /* Free `addrinfo' structure AI including associated storage.  */
 extern void freeaddrinfo __P ((struct addrinfo *__ai));
 
 /* Free `addrinfo' structure AI including associated storage.  */
 extern void freeaddrinfo __P ((struct addrinfo *__ai));
+
+/* Convert error return from getaddrinfo() to a string.  */
+extern char *gai_strerror __P  ((int __ecode));
+
+/* Translate a socket address to a location and service name.  */
+extern int getnameinfo __P ((__const struct sockaddr *__restrict __sa,
+                            socklen_t __salen,
+                            char *__restrict __host, size_t __hostlen,
+                            char *__restrict __serv, size_t __servlen,
+                            int __flags));
+
 #endif /* POSIX */
 
 __END_DECLS
 #endif /* POSIX */
 
 __END_DECLS