fake-addrinfo.h revision 7c478bd95313f5f23a4c958a745db2134aa03244
#pragma ident "%Z%%M% %I% %E% SMI"
/*
* Copyright (C) 2001,2002 by the Massachusetts Institute of Technology,
* Cambridge, MA, USA. All Rights Reserved.
*
* This software is being provided to you, the LICENSEE, by the
* Massachusetts Institute of Technology (M.I.T.) under the following
* that you have read, understood, and will comply with these terms and
* conditions:
*
* Export of this software from the United States of America may
* require a specific license from the United States Government.
* It is the responsibility of any person or organization contemplating
* export to obtain such a license before exporting.
*
* WITHIN THAT CONSTRAINT, permission to use, copy, modify and distribute
* this software and its documentation for any purpose and without fee or
* royalty is hereby granted, provided that you agree to comply with the
* following copyright notice and statements, including the disclaimer, and
* that the same appear on ALL copies of the software and documentation,
* including modifications that you make for internal use or for
* distribution:
*
* THIS SOFTWARE IS PROVIDED "AS IS", AND M.I.T. MAKES NO REPRESENTATIONS
* OR WARRANTIES, EXPRESS OR IMPLIED. By way of example, but not
* limitation, M.I.T. MAKES NO REPRESENTATIONS OR WARRANTIES OF
* MERCHANTABILITY OR FITNESS FOR ANY PARTICULAR PURPOSE OR THAT THE USE OF
* THE LICENSED SOFTWARE OR DOCUMENTATION WILL NOT INFRINGE ANY THIRD PARTY
* PATENTS, COPYRIGHTS, TRADEMARKS OR OTHER RIGHTS.
*
* The name of the Massachusetts Institute of Technology or M.I.T. may NOT
* be used in advertising or publicity pertaining to distribution of the
* software. Title to copyright in this software and any associated
* documentation shall at all times remain with M.I.T., and USER agrees to
* preserve same.
*
* Furthermore if you modify this software you must label
* your software as modified software and not distribute it in such a
* fashion that it might be confused with the original M.I.T. software.
*/
/* Approach overview:
If a system version is available but buggy, save pointers to it,
redefine the names to refer to static functions defined here, and
in those functions, call the system versions and fix up the
returned data. Use the native data structures and flag values.
If no system version exists, use gethostby* and fake it. Define
the data structures and flag values locally.
Note that recent Windows developers' code has an interesting hack:
When you include the right header files, with the right set of
macros indicating system versions, you'll get an inline function
that looks for getaddrinfo (or whatever) in the system library, and
calls it if it's there. If it's not there, it fakes it with
gethostby* calls.
We're taking a simpler approach: A system provides these routines or
it does not.
Someday, we may want to take into account different versions (say,
different revs of GNU libc) where some are broken in one way, and
some work or are broken in another way. Cross that bridge when we
come to it. */
/* To do, maybe:
+ For AIX 4.3.3, using the RFC 2133 definition: Implement
AI_NUMERICHOST. It's not defined in the header file.
For certain (old?) versions of GNU libc, AI_NUMERICHOST is
defined but not implemented.
+ Use gethostbyname2, inet_aton and other IPv6 or thread-safe
functions if available. But, see
gethostbyname2 problem on Linux. And besides, if a platform is
supporting IPv6 at all, they really should be doing getaddrinfo
by now.
+ inet_ntop, inet_pton
+ Upgrade host requirements to include working implementations of
these functions, and throw all this away. Pleeease? :-) */
#ifndef FAI_DEFINED
#define FAI_DEFINED
#include "port-sockets.h"
#include "socket-utils.h"
#ifdef S_SPLINT_S
/*@-incondefs@*/
extern int
/*@in@*/ /*@null@*/ const char *,
/*@out@*/ struct addrinfo **)
;
extern void
;
extern int
int flags)
/*@requires (maxSet(h)+1) >= hsz /\ (maxSet(s)+1) >= ssz @*/
/* too hard: maxRead(addr) >= (addrsz-1) */
/*@modifies *h, *s@*/;
/*@=incondefs@*/
#endif
#endif
/* See comments below. */
# define WRAP_GETADDRINFO
/* # define WRAP_GETNAMEINFO */
#endif
#ifdef __linux__
# define COPY_FIRST_CANONNAME
#endif
#ifdef _AIX
# define NUMERIC_SERVICE_BROKEN
# define COPY_FIRST_CANONNAME
#endif
#ifdef COPY_FIRST_CANONNAME
# include <string.h>
#endif
#ifdef NUMERIC_SERVICE_BROKEN
# include <ctype.h> /* isdigit */
# include <stdlib.h> /* strtoul */
#endif
#ifdef _WIN32
#define HAVE_GETADDRINFO 1
#define HAVE_GETNAMEINFO 1
#endif
/* Do we actually have *any* systems we care about that don't provide
either getaddrinfo or one of these two flavors of
gethostbyname_r? */
#if !defined(HAVE_GETHOSTBYNAME_R) || defined(THREADSAFE_GETHOSTBYNAME)
#else
#ifdef _AIX /* XXX should have a feature test! */
{ \
struct hostent_data my_h_ent_data; \
? 0 \
: &my_h_ent); \
}
/*
#define GET_HOST_BY_ADDR(ADDR, ADDRLEN, FAMILY, HP, ERR) \
{ \
struct hostent my_h_ent; \
struct hostent_data my_h_ent_data; \
(HP) = (gethostbyaddr_r((ADDR), (ADDRLEN), (FAMILY), &my_h_ent, \
&my_h_ent_data) \
? 0 \
: &my_h_ent); \
(ERR) = my_h_err; \
}
*/
#else
#ifdef GETHOSTBYNAME_R_RETURNS_INT
{ \
int my_h_err; \
char my_h_buf[8192]; \
&my_h_err) \
? 0 \
: &my_h_ent); \
}
{ \
int my_h_err; \
char my_h_buf[8192]; \
&my_h_err) \
? 0 \
: &my_h_ent); \
}
#else
{ \
int my_h_err; \
char my_h_buf[8192]; \
}
{ \
int my_h_err; \
char my_h_buf[8192]; \
}
#endif /* returns int? */
#endif /* _AIX */
#endif
/* Now do the same for getservby* functions. */
#ifndef HAVE_GETSERVBYNAME_R
#else
#ifdef GETSERVBYNAME_R_RETURNS_INT
{ \
int my_s_err; \
char my_s_buf[8192]; \
&my_s_err) \
? 0 \
: &my_s_ent); \
}
{ \
int my_s_err; \
char my_s_buf[8192]; \
&my_s_err) \
? 0 \
: &my_s_ent); \
}
#else
/* returns ptr -- IRIX? */
{ \
int my_s_err; \
char my_s_buf[8192]; \
}
{ \
char my_s_buf[8192]; \
}
#endif
#endif
#ifdef WRAP_GETADDRINFO
static int (*const gaiptr) (const char *, const char *,
const struct addrinfo *,
struct addrinfo **) = &getaddrinfo;
#endif
#ifdef WRAP_GETNAMEINFO
int) = &getnameinfo;
#endif
#if !defined (HAVE_GETADDRINFO) || defined(WRAP_GETADDRINFO)
#define getaddrinfo my_fake_getaddrinfo
#define freeaddrinfo my_fake_freeaddrinfo
#endif
#if !defined (HAVE_GETADDRINFO) || defined(WRAP_GETNAMEINFO)
#define getnameinfo my_fake_getnameinfo
#endif
#if !defined (HAVE_GETADDRINFO)
#define gai_strerror my_fake_gai_strerror
#define addrinfo my_fake_addrinfo
struct addrinfo {
int ai_family; /* PF_foo */
int ai_socktype; /* SOCK_foo */
int ai_protocol; /* 0, IPPROTO_foo */
int ai_flags; /* AI_PASSIVE etc */
char *ai_canonname; /* canonical name of host */
};
#define AI_PASSIVE 0x01
#define AI_CANONNAME 0x02
#define AI_NUMERICHOST 0x04
/* N.B.: AI_V4MAPPED, AI_ADDRCONFIG, AI_ALL, and AI_DEFAULT are part
of the spec for getipnodeby*, and *not* part of the spec for
getaddrinfo. Don't use them! */
#define AI_V4MAPPED eeeevil!
#define AI_ADDRCONFIG eeeevil!
#define AI_DEFAULT eeeevil!
#ifndef NI_MAXHOST
#define NI_MAXHOST 1025
#endif
#ifndef NI_MAXSERV
#define NI_MAXSERV 32
#endif
#define NI_NUMERICHOST 0x01
#define NI_NUMERICSERV 0x02
#define NI_NAMEREQD 0x04
#define NI_DGRAM 0x08
#define NI_NOFQDN 0x10
#define EAI_ADDRFAMILY 1
#define EAI_AGAIN 2
#define EAI_BADFLAGS 3
#define EAI_FAIL 4
#define EAI_FAMILY 5
#define EAI_MEMORY 6
#define EAI_NODATA 7
#define EAI_NONAME 8
#define EAI_SERVICE 9
#define EAI_SOCKTYPE 10
#define EAI_SYSTEM 11
#endif /* ! HAVE_GETADDRINFO */
/* Some debug routines. */
static const char *protoname (int p) {
static char buf[30];
#define X(N) if (p == IPPROTO_ ## N) return #N
X(TCP);
X(UDP);
X(ICMP);
X(IPV6);
#ifdef IPPROTO_GRE
X(GRE);
#endif
X(NONE);
X(RAW);
#ifdef IPPROTO_COMP
X(COMP);
#endif
return buf;
}
static const char *socktypename (int t) {
static char buf[30];
switch (t) {
case SOCK_DGRAM: return "DGRAM";
case SOCK_STREAM: return "STREAM";
case SOCK_RAW: return "RAW";
case SOCK_RDM: return "RDM";
case SOCK_SEQPACKET: return "SEQPACKET";
}
return buf;
}
static const char *familyname (int f) {
static char buf[30];
switch (f) {
default:
return buf;
case AF_INET: return "AF_INET";
case AF_INET6: return "AF_INET6";
#ifdef AF_UNIX
case AF_UNIX: return "AF_UNIX";
#endif
}
}
{
const char *sep;
"getaddrinfo(hostname %s, service %s,\n"
" hints { ",
if (hint) {
sep = "";
Z(CANONNAME);
Z(PASSIVE);
#ifdef AI_NUMERICHOST
Z(NUMERICHOST);
#endif
if (sep[0] == 0)
if (hint->ai_socktype)
if (hint->ai_protocol)
} else
}
static void debug_dump_error (int err)
{
}
{
int count = 0;
while (ai) {
count++;
}
}
#endif
#if !defined (HAVE_GETADDRINFO) || defined (WRAP_GETADDRINFO)
static
static
#endif
#if !defined (HAVE_GETADDRINFO) || defined (WRAP_GETNAMEINFO)
static
int flags);
#endif
#if !defined (HAVE_GETADDRINFO)
#define HAVE_FAKE_GETADDRINFO /* was not originally HAVE_GETADDRINFO */
#define HAVE_GETADDRINFO
#define HAVE_GETNAMEINFO 1
static
char *gai_strerror (int code);
#endif
/* Fudge things on older gai implementations. */
/* AIX 4.3.3 is based on RFC 2133; no AI_NUMERICHOST. */
#ifndef AI_NUMERICHOST
# define AI_NUMERICHOST 0
#endif
#if !defined(inline)
# if !defined(__GNUC__)
# define inline /* nothing, just static */
# else
# define inline __inline__
# endif
# define ADDRINFO_UNDEF_INLINE
#endif
/* Hack for HPUX, to get h_errno. */
# define _XOPEN_SOURCE_EXTENDED 1
# include <netdb.h>
#endif
#ifdef HAVE_FAKE_GETADDRINFO
#define NEED_FAKE_GETADDRINFO
#endif
#if defined(NEED_FAKE_GETADDRINFO) || defined(WRAP_GETADDRINFO)
#include <stdlib.h>
#endif
#ifdef NEED_FAKE_GETADDRINFO
#include <string.h> /* for strspn */
static inline int translate_h_errno (int h);
{
struct sockaddr_in *sin4;
if (n == 0)
return EAI_MEMORY;
return EAI_FAMILY;
*n = *template;
if (sin4 == 0)
return EAI_MEMORY;
#ifdef HAVE_SA_LEN
#endif
*result = n;
return 0;
}
{
int i, r;
int herr;
/* For now, real ipv6 support needs real getaddrinfo. */
return EAI_FAMILY;
if (hp == 0)
return translate_h_errno (herr);
for (i = 0; hp->h_addr_list[i]; i++) {
if (r)
return r;
}
return 0;
}
static inline void
{
while (ai) {
if (ai->ai_canonname)
}
}
static inline int
{
int ret;
int flags;
#ifdef DEBUG_ADDRINFO
#endif
if (hint != 0) {
return EAI_NODATA;
} else {
socktype = 0;
flags = 0;
}
if (serv) {
/* pure numeric */
if (p == 0 || p > 65535)
return EAI_NONAME;
} else {
int try_dgram_too = 0;
if (socktype == 0) {
try_dgram_too = 1;
}
#ifdef HAVE_GETSERVBYNAME_R
{
char my_s_buf[1024];
}
#else
#endif
if (sp == 0) {
if (try_dgram_too) {
goto try_service_lookup;
}
return EAI_SERVICE;
}
}
}
if (name == 0) {
flags |= AI_NUMERICHOST;
}
template.ai_protocol = 0;
template.ai_canonname = 0;
/* If NUMERICHOST is set, parse a numeric address.
If it's not set, don't accept such names. */
if (flags & AI_NUMERICHOST) {
#if 0
if (ret)
return EAI_NONAME;
#else
/* 255.255.255.255 or parse error, both bad */
return EAI_NONAME;
#endif
} else {
&res);
}
return ret;
}
if (res == 0)
return NO_ADDRESS;
return 0;
}
#include <errno.h>
static inline int
int flags)
{
const struct sockaddr_in *sinp;
return EAI_FAMILY;
}
return EAI_SYSTEM;
}
slen = servicelen;
return EAI_SYSTEM;
}
if (host) {
if (flags & NI_NUMERICHOST) {
/* The inet_ntoa call, passing a struct, fails on IRIX 6.5
using gcc 2.95; we get back "0.0.0.0". Since this in a
configuration still important at Athena, here's the
workaround, which also happens to be thread-safe.... */
const unsigned char *uc;
char tmpbuf[20];
#else
char *p;
#endif
} else {
int herr;
sizeof (struct in_addr),
if (hp == 0) {
goto numeric_host;
return translate_h_errno (herr);
}
/* According to the Open Group spec, getnameinfo can
silently truncate, but must still return a
null-terminated string. */
}
}
if (service) {
if (flags & NI_NUMERICSERV) {
char numbuf[10];
int port;
return EAI_FAIL;
} else {
int serr;
if (sp == 0)
goto numeric_service;
}
}
return 0;
}
#include <errno.h>
static inline
char *gai_strerror (int code)
{
switch (code) {
case EAI_ADDRFAMILY: return "address family for nodename not supported";
case EAI_AGAIN: return "temporary failure in name resolution";
case EAI_BADFLAGS: return "bad flags to getaddrinfo/getnameinfo";
case EAI_FAIL: return "non-recoverable failure in name resolution";
case EAI_FAMILY: return "ai_family not supported";
case EAI_MEMORY: return "out of memory";
case EAI_NODATA: return "no address associated with hostname";
case EAI_NONAME: return "name does not exist";
case EAI_SERVICE: return "service name not supported for specified socket type";
case EAI_SOCKTYPE: return "ai_socktype not supported";
default: return "bogus getaddrinfo error?";
}
}
static inline int translate_h_errno (int h)
{
switch (h) {
case 0:
return 0;
#ifdef NETDB_INTERNAL
case NETDB_INTERNAL:
return EAI_MEMORY;
return EAI_SYSTEM;
#endif
case HOST_NOT_FOUND:
return EAI_NONAME;
case TRY_AGAIN:
return EAI_AGAIN;
case NO_RECOVERY:
return EAI_FAIL;
case NO_DATA:
#if NO_DATA != NO_ADDRESS
case NO_ADDRESS:
#endif
return EAI_NODATA;
default:
return EAI_SYSTEM;
}
}
#ifdef HAVE_FAKE_GETADDRINFO
static inline
{
}
static inline
{
}
static inline
int flags)
{
flags);
}
#endif /* HAVE_FAKE_GETADDRINFO */
#endif /* NEED_FAKE_GETADDRINFO */
#ifdef WRAP_GETADDRINFO
static inline
int
{
int aierr;
#if defined(_AIX) || defined(COPY_FIRST_CANONNAME)
#endif
#ifdef NUMERIC_SERVICE_BROKEN
int service_is_numeric = 0;
int service_port = 0;
int socket_type = 0;
#endif
#ifdef DEBUG_ADDRINFO
#endif
#ifdef NUMERIC_SERVICE_BROKEN
/* AIX 4.3.3 is broken. (Or perhaps out of date?)
If a numeric service is provided, and it doesn't correspond to
a known service name for tcp or udp (as appropriate), an error
code (for "host not found") is returned. If the port maps to a
known service for both udp and tcp, all is well. */
unsigned long lport;
char *end;
if (!*end) {
if (lport > 65535)
return EAI_SOCKTYPE;
service_is_numeric = 1;
if (hint)
}
}
#endif
#ifdef DEBUG_ADDRINFO
#endif
return aierr;
}
/* Linux libc version 6 (libc-2.2.4.so on Debian) is broken.
RFC 2553 says that when AI_CANONNAME is set, the ai_canonname
flag of the first returned structure has the canonical name of
the host. Instead, GNU libc sets ai_canonname in each returned
structure to the name that the corresponding address maps to,
if any, or a printable numeric form.
RFC 2553 bis and the new Open Group spec say that field will be
the canonical name if it can be determined, otherwise, the
provided hostname or a copy of it.
IMNSHO, "canonical name" means CNAME processing and not PTR
processing, but I can see arguing it. Using the numeric form
when that's not the form provided is just wrong. So, let's fix
it.
The glibc 2.2.5 sources indicate that the canonical name is
*not* allocated separately, it's just some extra storage tacked
on the end of the addrinfo structure. So, let's try this
approach: If getaddrinfo sets ai_canonname, we'll replace the
*first* one with allocated storage, and free up that pointer in
freeaddrinfo if it's set; the other ai_canonname fields will be
left untouched. And we'll just pray that the application code
won't mess around with the list structure; if we start doing
that, we'll have to start replacing and freeing all of the
ai_canonname fields.
Since it's dependent on the target hostname, it's hard to check
for at configure time. Always do it on Linux for now. When
they get around to fixing it, add a compile-time or run-time
check for the glibc version in use.
Some Windows documentation says that even when AI_CANONNAME is
set, the returned ai_canonname field can be null. The NetBSD
1.5 implementation also does this, if the input hostname is a
numeric host address string. That case isn't handled well at
the moment. */
#ifdef COPY_FIRST_CANONNAME
/*
* This code must *always* return an error, return a null
* ai_canonname, or return an ai_canonname allocated here using
* malloc, so that freeaddrinfo can always free a non-null
* ai_canonname. Note that it really doesn't matter if the
* AI_CANONNAME flag was set.
*/
if (ai->ai_canonname) {
const char *name2 = 0;
int i, herr;
/*
* Current versions of GET_HOST_BY_NAME will fail if the
* target hostname has IPv6 addresses only. Make sure it
* fails fairly cleanly.
*/
if (hp == 0) {
/*
* This case probably means it's an IPv6-only name. If
* ai_canonname is a numeric address, get rid of it.
*/
ai->ai_canonname = 0;
} else {
first, and sometimes that file will have entries with
the unqualified name first. So take the first entry
that looks like it could be a FQDN. */
break;
}
}
/* Give up, just use the first name (h_name ==
h_aliases[0] on all systems I've seen). */
}
*result = 0;
#ifdef DEBUG_ADDRINFO
#endif
return EAI_MEMORY;
}
/* Zap the remaining ai_canonname fields glibc fills in, in
case the application messes around with the list
structure. */
ai->ai_canonname = 0;
}
#endif
#ifdef NUMERIC_SERVICE_BROKEN
if (service_port != 0) {
/* Is this check actually needed? */
case AF_INET:
break;
case AF_INET6:
break;
}
}
}
#endif
#ifdef _AIX
/* AIX 4.3.3 libc is broken. It doesn't set the family or len
fields of the sockaddr structures. Usually, sa_family is
zero, but I've seen it set to 1 in some cases also (maybe
just leftover from previous contents of the memory
block?). So, always override what libc returned. */
#ifdef HAVE_SA_LEN /* always true on AIX, actually */
#endif
}
#endif
/* Not dealt with currently:
- Some versions of GNU libc can lose some IPv4 addresses in
certain cases when multiple IPv4 and IPv6 addresses are
available. */
#ifdef DEBUG_ADDRINFO
#endif
return 0;
}
static inline
{
#ifdef COPY_FIRST_CANONNAME
if (ai) {
ai->ai_canonname = 0;
}
#else
#endif
}
#endif /* WRAP_GETADDRINFO */
#ifdef WRAP_GETNAMEINFO
static inline
int flags)
{
}
#endif /* WRAP_GETNAMEINFO */
#if defined(KRB5_USE_INET6) && defined(NEED_INSIXADDR_ANY)
/* If compiling with IPv6 support and C library does not define in6addr_any */
#endif
#ifdef ADDRINFO_UNDEF_INLINE
# undef inline
#endif
#endif /* FAI_DEFINED */