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;
235 snprintf (serv, servlen, "%u",
236 (unsigned int)ntohs (addr->sin_port));
237 serv[servlen - 1] = '\0';
244 #endif /* if !HAVE_GETNAMEINFO */
247 #ifndef HAVE_GETADDRINFO
249 * This functions must be used to free the memory allocated by getaddrinfo().
252 __freeaddrinfo (struct addrinfo *res)
256 if (res->ai_canonname != NULL)
257 free (res->ai_canonname);
258 if (res->ai_addr != NULL)
260 if (res->ai_next != NULL)
268 * Internal function that builds an addrinfo struct.
270 static struct addrinfo *
271 makeaddrinfo (int af, int type, int proto,
272 const struct sockaddr *addr, size_t addrlen,
273 const char *canonname)
275 struct addrinfo *res;
277 res = (struct addrinfo *)malloc (sizeof (struct addrinfo));
282 res->ai_socktype = type;
283 res->ai_protocol = proto;
284 res->ai_addrlen = addrlen;
285 res->ai_addr = malloc (addrlen);
286 res->ai_canonname = NULL;
289 if (res->ai_addr != NULL)
291 memcpy (res->ai_addr, addr, addrlen);
293 if (canonname != NULL)
295 res->ai_canonname = strdup (canonname);
296 if (res->ai_canonname != NULL)
297 return res; /* success ! */
304 vlc_freeaddrinfo (res);
309 static struct addrinfo *
310 makeipv4info (int type, int proto, u_long ip, u_short port, const char *name)
312 struct sockaddr_in addr;
314 memset (&addr, 0, sizeof (addr));
315 addr.sin_family = AF_INET;
317 addr.sin_len = sizeof (addr);
319 addr.sin_port = port;
320 addr.sin_addr.s_addr = ip;
322 return makeaddrinfo (AF_INET, type, proto,
323 (struct sockaddr*)&addr, sizeof (addr), name);
328 * getaddrinfo() non-thread-safe IPv4-only implementation
329 * Address-family-independant hostname to address resolution.
331 * This is meant for IPv6-unaware systems that do probably not provide
332 * getaddrinfo(), but still have old function gethostbyname().
334 * Only UDP and TCP over IPv4 are supported here.
337 __getaddrinfo (const char *node, const char *service,
338 const struct addrinfo *hints, struct addrinfo **res)
340 struct addrinfo *info;
343 int protocol = 0, flags = 0;
344 const char *name = NULL;
348 flags = hints->ai_flags;
350 if (flags & ~_AI_MASK)
352 /* only accept AF_INET and AF_UNSPEC */
353 if (hints->ai_family && (hints->ai_family != AF_INET))
356 /* protocol sanity check */
357 switch (hints->ai_socktype)
360 protocol = IPPROTO_TCP;
364 protocol = IPPROTO_UDP;
376 if (hints->ai_protocol && protocol
377 && (protocol != hints->ai_protocol))
386 if (flags & AI_PASSIVE)
387 ip = htonl (INADDR_ANY);
389 ip = htonl (INADDR_LOOPBACK);
392 if ((ip = inet_addr (node)) == INADDR_NONE)
394 struct hostent *entry = NULL;
396 /* hostname resolution */
397 if (!(flags & AI_NUMERICHOST))
398 entry = gethostbyname (node);
403 if ((entry->h_length != 4) || (entry->h_addrtype != AF_INET))
406 ip = *((u_long *) entry->h_addr);
407 if (flags & AI_CANONNAME)
408 name = entry->h_name;
411 if ((flags & AI_CANONNAME) && (name == NULL))
414 /* service resolution */
422 d = strtoul (service, &end, 0);
423 if (end[0] /* service is not a number */
426 struct servent *entry;
427 const char *protoname;
443 entry = getservbyname (service, protoname);
447 port = entry->s_port;
450 port = htons ((u_short)d);
453 /* building results... */
454 if ((!protocol) || (protocol == IPPROTO_UDP))
456 info = makeipv4info (SOCK_DGRAM, IPPROTO_UDP, ip, port, name);
462 if (flags & AI_PASSIVE)
463 info->ai_flags |= AI_PASSIVE;
466 if ((!protocol) || (protocol == IPPROTO_TCP))
468 info = makeipv4info (SOCK_STREAM, IPPROTO_TCP, ip, port, name);
474 info->ai_next = *res;
475 if (flags & AI_PASSIVE)
476 info->ai_flags |= AI_PASSIVE;
482 #endif /* if !HAVE_GETADDRINFO */
485 int vlc_getnameinfo( const struct sockaddr *sa, int salen,
486 char *host, int hostlen, int *portnum, int flags )
488 char psz_servbuf[6], *psz_serv;
489 int i_servlen, i_val;
490 #if defined( WIN32 ) && !defined( UNDER_CE )
492 * Here is the kind of kludge you need to keep binary compatibility among
493 * varying OS versions...
495 typedef int (CALLBACK * GETNAMEINFO) ( const struct sockaddr*, socklen_t,
496 char*, DWORD, char*, DWORD, int );
497 HINSTANCE wship6_module;
498 GETNAMEINFO ws2_getnameinfo;
501 flags |= NI_NUMERICSERV;
502 if( portnum != NULL )
504 psz_serv = psz_servbuf;
505 i_servlen = sizeof( psz_servbuf );
512 #if defined( WIN32 ) && !defined( UNDER_CE )
513 wship6_module = LoadLibrary( "wship6.dll" );
514 if( wship6_module != NULL )
516 ws2_getnameinfo = (GETNAMEINFO)GetProcAddress( wship6_module,
519 if( ws2_getnameinfo != NULL )
521 i_val = ws2_getnameinfo( sa, salen, host, hostlen, psz_serv,
523 FreeLibrary( wship6_module );
525 if( portnum != NULL )
526 *portnum = atoi( psz_serv );
530 FreeLibrary( wship6_module );
533 #if defined( HAVE_GETNAMEINFO ) || defined( UNDER_CE )
534 i_val = getnameinfo(sa, salen, host, hostlen, psz_serv, i_servlen, flags);
537 # ifdef HAVE_USABLE_MUTEX_THAT_DONT_NEED_LIBVLC_POINTER
538 static vlc_value_t lock;
540 /* my getnameinfo implementation is not thread-safe as it uses
541 * gethostbyaddr and the likes */
542 vlc_mutex_lock( lock.p_address );
544 //# warning FIXME : This is not thread-safe!
546 i_val = __getnameinfo( sa, salen, host, hostlen, psz_serv, i_servlen,
548 # ifdef HAVE_USABLE_MUTEX_THAT_DONT_NEED_LIBVLC_POINTER
549 vlc_mutex_unlock( lock.p_address );
554 if( portnum != NULL )
555 *portnum = atoi( psz_serv );
561 /* TODO: support for setting sin6_scope_id */
562 int vlc_getaddrinfo( vlc_object_t *p_this, const char *node,
563 int i_port, const struct addrinfo *p_hints,
564 struct addrinfo **res )
566 struct addrinfo hints;
567 char psz_buf[NI_MAXHOST], *psz_node, psz_service[6];
570 * In VLC, we always use port number as integer rather than strings
571 * for historical reasons (and portability).
573 if( ( i_port > 65535 ) || ( i_port < 0 ) )
575 msg_Err( p_this, "invalid port number %d specified", i_port );
579 /* cannot overflow */
580 snprintf( psz_service, 6, "%d", i_port );
582 /* Check if we have to force ipv4 or ipv6 */
583 if( p_hints == NULL )
584 memset( &hints, 0, sizeof( hints ) );
586 memcpy( &hints, p_hints, sizeof( hints ) );
588 if( hints.ai_family == AF_UNSPEC )
592 var_Create( p_this, "ipv4", VLC_VAR_BOOL | VLC_VAR_DOINHERIT );
593 var_Get( p_this, "ipv4", &val );
595 hints.ai_family = AF_INET;
598 var_Create( p_this, "ipv6", VLC_VAR_BOOL | VLC_VAR_DOINHERIT );
599 var_Get( p_this, "ipv6", &val );
601 hints.ai_family = AF_INET6;
607 * - accept "" as NULL
608 * - ignore square brackets
610 if( ( node == NULL ) || (node[0] == '\0' ) )
616 strncpy( psz_buf, node, NI_MAXHOST );
617 psz_buf[NI_MAXHOST - 1] = '\0';
621 if( psz_buf[0] == '[' )
625 ptr = strrchr( psz_buf, ']' );
626 if( ( ptr != NULL ) && (ptr[1] == '\0' ) )
634 #if defined( WIN32 ) && !defined( UNDER_CE )
636 typedef int (CALLBACK * GETADDRINFO) ( const char *, const char *,
637 const struct addrinfo *,
638 struct addrinfo ** );
639 HINSTANCE wship6_module;
640 GETADDRINFO ws2_getaddrinfo;
642 wship6_module = LoadLibrary( "wship6.dll" );
643 if( wship6_module != NULL )
645 ws2_getaddrinfo = (GETADDRINFO)GetProcAddress( wship6_module,
648 if( ws2_getaddrinfo != NULL )
652 i_ret = ws2_getaddrinfo( psz_node, psz_service, &hints, res );
653 FreeLibrary( wship6_module ); /* is this wise ? */
657 FreeLibrary( wship6_module );
661 #if defined( HAVE_GETADDRINFO ) || defined( UNDER_CE )
663 /* Run-time I18n Domain Names support */
665 static vlc_bool_t i_idn = VLC_TRUE; /* beware of thread-safety */
671 hints.ai_flags |= AI_IDN;
672 i_ret = getaddrinfo( psz_node, psz_service, &hints, res );
674 if( i_ret != EAI_BADFLAGS )
677 /* libidn not available: disable and retry without it */
679 /* NOTE: Using i_idn here would not be thread-safe */
680 hints.ai_flags &= ~AI_IDN;
682 msg_Dbg( p_this, "I18n Domain Names not supported - disabled" );
686 return getaddrinfo( psz_node, psz_service, &hints, res );
693 var_Create( p_this->p_libvlc, "getaddrinfo_mutex", VLC_VAR_MUTEX );
694 var_Get( p_this->p_libvlc, "getaddrinfo_mutex", &lock );
695 vlc_mutex_lock( lock.p_address );
697 i_ret = __getaddrinfo( psz_node, psz_service, &hints, res );
698 vlc_mutex_unlock( lock.p_address );
705 void vlc_freeaddrinfo( struct addrinfo *infos )
707 #if defined( WIN32 ) && !defined( UNDER_CE )
708 typedef void (CALLBACK * FREEADDRINFO) ( struct addrinfo * );
709 HINSTANCE wship6_module;
710 FREEADDRINFO ws2_freeaddrinfo;
712 wship6_module = LoadLibrary( "wship6.dll" );
713 if( wship6_module != NULL )
715 ws2_freeaddrinfo = (FREEADDRINFO)GetProcAddress( wship6_module,
719 * NOTE: it is assumed that wship6.dll defines either both
720 * getaddrinfo and freeaddrinfo or none of them.
722 if( ws2_freeaddrinfo != NULL )
724 ws2_freeaddrinfo( infos );
725 FreeLibrary( wship6_module );
729 FreeLibrary( wship6_module );
732 #if defined( HAVE_GETADDRINFO ) || defined( UNDER_CE )
733 freeaddrinfo( infos );
735 __freeaddrinfo( infos );