1 /*****************************************************************************
2 * getaddrinfo.c: getaddrinfo/getnameinfo replacement functions
3 *****************************************************************************
4 * Copyright (C) 2005 the VideoLAN team
5 * Copyright (C) 2002-2004 Rémi Denis-Courmont
8 * Author: Rémi Denis-Courmont <rem # videolan.org>
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software
22 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
23 *****************************************************************************/
27 #include <stddef.h> /* size_t */
28 #include <string.h> /* strncpy(), strlen(), memcpy(), memset(), strchr() */
29 #include <stdlib.h> /* malloc(), free(), strtoul() */
32 #ifdef HAVE_SYS_TYPES_H
33 # include <sys/types.h>
35 #ifdef HAVE_ARPA_INET_H
36 # include <arpa/inet.h>
38 #ifdef HAVE_NETINET_IN_H
39 # include <netinet/in.h>
48 # define NO_ADDRESS NO_DATA
51 # define INADDR_NONE 0xFFFFFFFF
57 #define _NI_MASK (NI_NUMERICHOST|NI_NUMERICSERV|NI_NOFQDN|NI_NAMEREQD|\
59 #define _AI_MASK (AI_PASSIVE|AI_CANONNAME|AI_NUMERICHOST)
62 #ifndef HAVE_GAI_STRERROR
67 } const __gai_errlist[] =
70 { EAI_BADFLAGS, "Invalid flag used" },
71 { EAI_NONAME, "Host or service not found" },
72 { EAI_AGAIN, "Temporary name service failure" },
73 { EAI_FAIL, "Non-recoverable name service failure" },
74 { EAI_NODATA, "No data for host name" },
75 { EAI_FAMILY, "Unsupported address family" },
76 { EAI_SOCKTYPE, "Unsupported socket type" },
77 { EAI_SERVICE, "Incompatible service for socket type" },
78 { EAI_ADDRFAMILY, "Unavailable address family for host name" },
79 { EAI_MEMORY, "Memory allocation failure" },
80 { EAI_SYSTEM, "System error" },
84 static const char *__gai_unknownerr = "Unrecognized error number";
86 /****************************************************************************
87 * Converts an EAI_* error code into human readable english text.
88 ****************************************************************************/
89 const char *vlc_gai_strerror( int errnum )
93 for (i = 0; __gai_errlist[i].msg != NULL; i++)
94 if (errnum == __gai_errlist[i].code)
95 return __gai_errlist[i].msg;
97 return __gai_unknownerr;
99 # undef _EAI_POSITIVE_MAX
100 #else /* ifndef HAVE_GAI_STRERROR */
101 const char *vlc_gai_strerror( int errnum )
103 return gai_strerror( errnum );
107 #if !(defined (HAVE_GETNAMEINFO) && defined (HAVE_GETADDRINFO))
109 * Converts the current herrno error value into an EAI_* error code.
110 * That error code is normally returned by getnameinfo() or getaddrinfo().
113 gai_error_from_herrno( void )
121 # if (NO_ADDRESS != NO_DATA)
134 #endif /* if !(HAVE_GETNAMEINFO && HAVE_GETADDRINFO) */
136 #ifndef HAVE_GETNAMEINFO
138 * getnameinfo() non-thread-safe IPv4-only implementation,
139 * Address-family-independant address to hostname translation
140 * (reverse DNS lookup in case of IPv4).
142 * This is meant for use on old IP-enabled systems that are not IPv6-aware,
143 * and probably do not have getnameinfo(), but have the old gethostbyaddr()
146 * GNU C library 2.0.x is known to lack this function, even though it defines
150 __getnameinfo( const struct sockaddr *sa, socklen_t salen,
151 char *host, int hostlen, char *serv, int servlen, int flags )
153 if (((unsigned)salen < sizeof (struct sockaddr_in))
154 || (sa->sa_family != AF_INET))
156 else if (flags & (~_NI_MASK))
160 const struct sockaddr_in *addr;
162 addr = (const struct sockaddr_in *)sa;
168 /* host name resolution */
169 if (!(flags & NI_NUMERICHOST))
171 struct hostent *hent;
173 hent = gethostbyaddr ((const void*)&addr->sin_addr,
178 strncpy (host, hent->h_name, hostlen);
179 host[hostlen - 1] = '\0';
182 * only keep first part of hostname
183 * if user don't want fully qualified
186 if (flags & NI_NOFQDN)
190 ptr = strchr (host, '.');
197 else if (flags & NI_NAMEREQD)
198 return gai_error_from_herrno ();
203 /* inet_ntoa() can't fail */
204 strncpy (host, inet_ntoa (addr->sin_addr), hostlen);
205 host[hostlen - 1] = '\0';
211 struct servent *sent = NULL;
213 #ifndef SYS_BEOS /* No getservbyport() */
216 /* service name resolution */
217 if (!(flags & NI_NUMERICSERV))
220 sent = getservbyport(addr->sin_port,
225 strncpy (serv, sent->s_name, servlen);
226 serv[servlen - 1] = 0;
233 snprintf (serv, servlen, "%u",
234 (unsigned int)ntohs (addr->sin_port));
235 serv[servlen - 1] = '\0';
242 #endif /* if !HAVE_GETNAMEINFO */
245 #ifndef HAVE_GETADDRINFO
247 * This functions must be used to free the memory allocated by getaddrinfo().
250 __freeaddrinfo (struct addrinfo *res)
254 if (res->ai_canonname != NULL)
255 free (res->ai_canonname);
256 if (res->ai_addr != NULL)
258 if (res->ai_next != NULL)
266 * Internal function that builds an addrinfo struct.
268 static struct addrinfo *
269 makeaddrinfo (int af, int type, int proto,
270 const struct sockaddr *addr, size_t addrlen,
271 const char *canonname)
273 struct addrinfo *res;
275 res = (struct addrinfo *)malloc (sizeof (struct addrinfo));
280 res->ai_socktype = type;
281 res->ai_protocol = proto;
282 res->ai_addrlen = addrlen;
283 res->ai_addr = malloc (addrlen);
284 res->ai_canonname = NULL;
287 if (res->ai_addr != NULL)
289 memcpy (res->ai_addr, addr, addrlen);
291 if (canonname != NULL)
293 res->ai_canonname = strdup (canonname);
294 if (res->ai_canonname != NULL)
295 return res; /* success ! */
302 vlc_freeaddrinfo (res);
307 static struct addrinfo *
308 makeipv4info (int type, int proto, u_long ip, u_short port, const char *name)
310 struct sockaddr_in addr;
312 memset (&addr, 0, sizeof (addr));
313 addr.sin_family = AF_INET;
315 addr.sin_len = sizeof (addr);
317 addr.sin_port = port;
318 addr.sin_addr.s_addr = ip;
320 return makeaddrinfo (AF_INET, type, proto,
321 (struct sockaddr*)&addr, sizeof (addr), name);
326 * getaddrinfo() non-thread-safe IPv4-only implementation
327 * Address-family-independant hostname to address resolution.
329 * This is meant for IPv6-unaware systems that do probably not provide
330 * getaddrinfo(), but still have old function gethostbyname().
332 * Only UDP and TCP over IPv4 are supported here.
335 __getaddrinfo (const char *node, const char *service,
336 const struct addrinfo *hints, struct addrinfo **res)
338 struct addrinfo *info;
341 int protocol = 0, flags = 0;
342 const char *name = NULL;
346 * Maybe you knew already that Winsock does not handle TCP/RST packets
347 * properly, so that when a TCP connection fails, it will wait until it
348 * times out even if the remote host did return a TCP/RST. However, it
349 * still sees the TCP/RST as the error code is 10061 instead of 10060.
350 * Basically, we have the stupid brainfucked behavior with DNS queries...
351 * When the recursive DNS server returns an error, Winsock waits about
352 * 2 seconds before it returns to the callers, even though it should know
353 * that is pointless. I'd like to know how come this hasn't been fixed
354 * for the past decade, or maybe not.
356 * Anyway, this is causing a severe delay when the SAP listener tries
357 * to resolve more than ten IPv6 numeric addresses. Modern systems will
358 * eventually realize that it is an IPv6 address, and won't try to resolve
359 * it as a IPv4 address via the Domain Name Service. Old systems
360 * (including Windows XP without the IPv6 stack) will not. It is normally
361 * not an issue as the DNS server usually returns an error very quickly.
362 * But it IS a severe issue on Windows, given the bug explained above.
363 * So here comes one more bug-to-bug Windows compatibility fix.
365 if ((node != NULL) && (strchr (node, ':') != NULL))
371 flags = hints->ai_flags;
373 if (flags & ~_AI_MASK)
375 /* only accept AF_INET and AF_UNSPEC */
376 if (hints->ai_family && (hints->ai_family != AF_INET))
379 /* protocol sanity check */
380 switch (hints->ai_socktype)
383 protocol = IPPROTO_TCP;
387 protocol = IPPROTO_UDP;
399 if (hints->ai_protocol && protocol
400 && (protocol != hints->ai_protocol))
409 if (flags & AI_PASSIVE)
410 ip = htonl (INADDR_ANY);
412 ip = htonl (INADDR_LOOPBACK);
415 if ((ip = inet_addr (node)) == INADDR_NONE)
417 struct hostent *entry = NULL;
419 /* hostname resolution */
420 if (!(flags & AI_NUMERICHOST))
421 entry = gethostbyname (node);
426 if ((entry->h_length != 4) || (entry->h_addrtype != AF_INET))
429 ip = *((u_long *) entry->h_addr);
430 if (flags & AI_CANONNAME)
431 name = entry->h_name;
434 if ((flags & AI_CANONNAME) && (name == NULL))
437 /* service resolution */
445 d = strtoul (service, &end, 0);
446 if (end[0] /* service is not a number */
449 struct servent *entry;
450 const char *protoname;
466 entry = getservbyname (service, protoname);
470 port = entry->s_port;
473 port = htons ((u_short)d);
476 /* building results... */
477 if ((!protocol) || (protocol == IPPROTO_UDP))
479 info = makeipv4info (SOCK_DGRAM, IPPROTO_UDP, ip, port, name);
485 if (flags & AI_PASSIVE)
486 info->ai_flags |= AI_PASSIVE;
489 if ((!protocol) || (protocol == IPPROTO_TCP))
491 info = makeipv4info (SOCK_STREAM, IPPROTO_TCP, ip, port, name);
497 info->ai_next = *res;
498 if (flags & AI_PASSIVE)
499 info->ai_flags |= AI_PASSIVE;
505 #endif /* if !HAVE_GETADDRINFO */
508 int vlc_getnameinfo( const struct sockaddr *sa, int salen,
509 char *host, int hostlen, int *portnum, int flags )
511 char psz_servbuf[6], *psz_serv;
512 int i_servlen, i_val;
513 #if defined( WIN32 ) && !defined( UNDER_CE )
515 * Here is the kind of kludge you need to keep binary compatibility among
516 * varying OS versions...
518 typedef int (CALLBACK * GETNAMEINFO) ( const struct sockaddr*, socklen_t,
519 char*, DWORD, char*, DWORD, int );
520 HINSTANCE wship6_module;
521 GETNAMEINFO ws2_getnameinfo;
524 flags |= NI_NUMERICSERV;
525 if( portnum != NULL )
527 psz_serv = psz_servbuf;
528 i_servlen = sizeof( psz_servbuf );
535 #if defined( WIN32 ) && !defined( UNDER_CE )
536 wship6_module = LoadLibrary( "wship6.dll" );
537 if( wship6_module != NULL )
539 ws2_getnameinfo = (GETNAMEINFO)GetProcAddress( wship6_module,
542 if( ws2_getnameinfo != NULL )
544 i_val = ws2_getnameinfo( sa, salen, host, hostlen, psz_serv,
546 FreeLibrary( wship6_module );
548 if( portnum != NULL )
549 *portnum = atoi( psz_serv );
553 FreeLibrary( wship6_module );
556 #if defined( HAVE_GETNAMEINFO ) || defined( UNDER_CE )
557 i_val = getnameinfo(sa, salen, host, hostlen, psz_serv, i_servlen, flags);
560 # ifdef HAVE_USABLE_MUTEX_THAT_DONT_NEED_LIBVLC_POINTER
561 static vlc_value_t lock;
563 /* my getnameinfo implementation is not thread-safe as it uses
564 * gethostbyaddr and the likes */
565 vlc_mutex_lock( lock.p_address );
567 //# warning FIXME : This is not thread-safe!
569 i_val = __getnameinfo( sa, salen, host, hostlen, psz_serv, i_servlen,
571 # ifdef HAVE_USABLE_MUTEX_THAT_DONT_NEED_LIBVLC_POINTER
572 vlc_mutex_unlock( lock.p_address );
577 if( portnum != NULL )
578 *portnum = atoi( psz_serv );
584 /* TODO: support for setting sin6_scope_id */
585 int vlc_getaddrinfo( vlc_object_t *p_this, const char *node,
586 int i_port, const struct addrinfo *p_hints,
587 struct addrinfo **res )
589 struct addrinfo hints;
590 char psz_buf[NI_MAXHOST], *psz_node, psz_service[6];
593 * In VLC, we always use port number as integer rather than strings
594 * for historical reasons (and portability).
596 if( ( i_port > 65535 ) || ( i_port < 0 ) )
598 msg_Err( p_this, "invalid port number %d specified", i_port );
602 /* cannot overflow */
603 snprintf( psz_service, 6, "%d", i_port );
605 /* Check if we have to force ipv4 or ipv6 */
606 if( p_hints == NULL )
607 memset( &hints, 0, sizeof( hints ) );
609 memcpy( &hints, p_hints, sizeof( hints ) );
611 if( hints.ai_family == AF_UNSPEC )
615 var_Create( p_this, "ipv4", VLC_VAR_BOOL | VLC_VAR_DOINHERIT );
616 var_Get( p_this, "ipv4", &val );
618 hints.ai_family = AF_INET;
621 var_Create( p_this, "ipv6", VLC_VAR_BOOL | VLC_VAR_DOINHERIT );
622 var_Get( p_this, "ipv6", &val );
624 hints.ai_family = AF_INET6;
630 * - accept "" as NULL
631 * - ignore square brackets
633 if( ( node == NULL ) || (node[0] == '\0' ) )
639 strncpy( psz_buf, node, NI_MAXHOST );
640 psz_buf[NI_MAXHOST - 1] = '\0';
644 if( psz_buf[0] == '[' )
648 ptr = strrchr( psz_buf, ']' );
649 if( ( ptr != NULL ) && (ptr[1] == '\0' ) )
657 #if defined( WIN32 ) && !defined( UNDER_CE )
659 typedef int (CALLBACK * GETADDRINFO) ( const char *, const char *,
660 const struct addrinfo *,
661 struct addrinfo ** );
662 HINSTANCE wship6_module;
663 GETADDRINFO ws2_getaddrinfo;
665 wship6_module = LoadLibrary( "wship6.dll" );
666 if( wship6_module != NULL )
668 ws2_getaddrinfo = (GETADDRINFO)GetProcAddress( wship6_module,
671 if( ws2_getaddrinfo != NULL )
675 i_ret = ws2_getaddrinfo( psz_node, psz_service, &hints, res );
676 FreeLibrary( wship6_module ); /* is this wise ? */
680 FreeLibrary( wship6_module );
684 #if defined( HAVE_GETADDRINFO ) || defined( UNDER_CE )
686 /* Run-time I18n Domain Names support */
688 static vlc_bool_t i_idn = VLC_TRUE; /* beware of thread-safety */
694 hints.ai_flags |= AI_IDN;
695 i_ret = getaddrinfo( psz_node, psz_service, &hints, res );
697 if( i_ret != EAI_BADFLAGS )
700 /* libidn not available: disable and retry without it */
702 /* NOTE: Using i_idn here would not be thread-safe */
703 hints.ai_flags &= ~AI_IDN;
705 msg_Dbg( p_this, "I18n Domain Names not supported - disabled" );
709 return getaddrinfo( psz_node, psz_service, &hints, res );
716 var_Create( p_this->p_libvlc, "getaddrinfo_mutex", VLC_VAR_MUTEX );
717 var_Get( p_this->p_libvlc, "getaddrinfo_mutex", &lock );
718 vlc_mutex_lock( lock.p_address );
720 i_ret = __getaddrinfo( psz_node, psz_service, &hints, res );
721 vlc_mutex_unlock( lock.p_address );
728 void vlc_freeaddrinfo( struct addrinfo *infos )
730 #if defined( WIN32 ) && !defined( UNDER_CE )
731 typedef void (CALLBACK * FREEADDRINFO) ( struct addrinfo * );
732 HINSTANCE wship6_module;
733 FREEADDRINFO ws2_freeaddrinfo;
735 wship6_module = LoadLibrary( "wship6.dll" );
736 if( wship6_module != NULL )
738 ws2_freeaddrinfo = (FREEADDRINFO)GetProcAddress( wship6_module,
742 * NOTE: it is assumed that wship6.dll defines either both
743 * getaddrinfo and freeaddrinfo or none of them.
745 if( ws2_freeaddrinfo != NULL )
747 ws2_freeaddrinfo( infos );
748 FreeLibrary( wship6_module );
752 FreeLibrary( wship6_module );
755 #if defined( HAVE_GETADDRINFO ) || defined( UNDER_CE )
756 freeaddrinfo( infos );
758 __freeaddrinfo( infos );