include/vlc_network.h

   1 /*****************************************************************************
   2  * vlc_network.h: interface to communicate with network plug-ins
   3  *****************************************************************************
   4  * Copyright (C) 2002-2005 the VideoLAN team
   5  * Copyright © 2006-2007 Rémi Denis-Courmont
   6  * $Id$
   7  *
   8  * Authors: Christophe Massiot <massiot@via.ecp.fr>
   9  *          Laurent Aimar <fenrir@via.ecp.fr>
  10  *          Rémi Denis-Courmont <rem # videolan.org>
  11  *
  12  * This program is free software; you can redistribute it and/or modify
  13  * it under the terms of the GNU General Public License as published by
  14  * the Free Software Foundation; either version 2 of the License, or
  15  * (at your option) any later version.
  16  *
  17  * This program is distributed in the hope that it will be useful,
  18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20  * GNU General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU General Public License
  23  * along with this program; if not, write to the Free Software
  24  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  25  *****************************************************************************/
  26
  27 #if !defined( __LIBVLC__ )
  28   #error You are not libvlc or one of its plugins. You cannot include this file
  29 #endif
  30
  31 #ifndef __VLC_NETWORK_H
  32 # define __VLC_NETWORK_H
  33
  34 #if defined( WIN32 )
  35 #   if defined(UNDER_CE) && defined(sockaddr_storage)
  36 #       undef sockaddr_storage
  37 #   endif
  38 #   if defined(UNDER_CE)
  39 #       define HAVE_STRUCT_ADDRINFO
  40 #   else
  41 #       define _NO_OLDNAMES 1
  42 #       include <io.h>
  43 #   endif
  44 #   include <winsock2.h>
  45 #   include <ws2tcpip.h>
  46 #   define ENETUNREACH WSAENETUNREACH
  47 #   define net_errno (WSAGetLastError())
  48 extern const char *net_strerror( int val );
  49 #   ifndef IPV6_V6ONLY
  50 #       define IPV6_V6ONLY 27
  51 #   endif
  52 #else
  53 #   if HAVE_SYS_SOCKET_H
  54 #      include <sys/socket.h>
  55 #   endif
  56 #   if HAVE_NETINET_IN_H
  57 #      include <netinet/in.h>
  58 #   endif
  59 #   if HAVE_ARPA_INET_H
  60 #      include <arpa/inet.h>
  61 #   elif defined( SYS_BEOS )
  62 #      include <net/netdb.h>
  63 #   endif
  64 #   include <netdb.h>
  65 #   define net_errno errno
  66 #   define net_strerror strerror
  67 #endif
  68
  69 # ifdef __cplusplus
  70 extern "C" {
  71 # endif
  72
  73 /* Portable networking layer communication */
  74 int net_Socket (vlc_object_t *obj, int family, int socktype, int proto);
  75 int net_SetupSocket (int fd);
  76
  77 #define net_Connect(a, b, c, d, e) __net_Connect(VLC_OBJECT(a), b, c, d, e)
  78 VLC_EXPORT( int, __net_Connect, (vlc_object_t *p_this, const char *psz_host, int i_port, int socktype, int protocol) );
  79
  80 VLC_EXPORT( int *, net_Listen, (vlc_object_t *p_this, const char *psz_host, int i_port, int family, int socktype, int protocol) );
  81
  82 #define net_ListenTCP(a, b, c) __net_ListenTCP(VLC_OBJECT(a), b, c)
  83 #define net_ConnectTCP(a, b, c) __net_ConnectTCP(VLC_OBJECT(a), b, c)
  84
  85 static inline int *__net_ListenTCP (vlc_object_t *obj, const char *host, int port)
  86 {
  87     return net_Listen (obj, host, port, AF_UNSPEC, SOCK_STREAM, IPPROTO_TCP);
  88 }
  89
  90 static inline int __net_ConnectTCP (vlc_object_t *obj, const char *host, int port)
  91 {
  92     return __net_Connect (obj, host, port, SOCK_STREAM, IPPROTO_TCP);
  93 }
  94
  95 #define net_Accept(a, b, c) __net_Accept(VLC_OBJECT(a), b, c)
  96 VLC_EXPORT( int, __net_Accept, ( vlc_object_t *, int *, mtime_t ) );
  97
  98 #define net_ConnectDgram(a, b, c, d, e ) __net_ConnectDgram(VLC_OBJECT(a), b, c, d, e)
  99 VLC_EXPORT( int, __net_ConnectDgram, ( vlc_object_t *p_this, const char *psz_host, int i_port, int hlim, int proto ) );
 100
 101 static inline int net_ConnectUDP (vlc_object_t *obj, const char *host, int port, int hlim)
 102 {
 103     return net_ConnectDgram (obj, host, port, hlim, IPPROTO_UDP);
 104 }
 105
 106 #define net_OpenDgram( a, b, c, d, e, g, h ) __net_OpenDgram(VLC_OBJECT(a), b, c, d, e, g, h)
 107 VLC_EXPORT( int, __net_OpenDgram, ( vlc_object_t *p_this, const char *psz_bind, int i_bind, const char *psz_server, int i_server, int family, int proto ) );
 108
 109 static inline int net_ListenUDP1 (vlc_object_t *obj, const char *host, int port)
 110 {
 111     return net_OpenDgram (obj, host, port, NULL, 0, 0, IPPROTO_UDP);
 112 }
 113
 114 VLC_EXPORT( void, net_ListenClose, ( int *fd ) );
 115
 116 int net_Subscribe (vlc_object_t *obj, int fd, const struct sockaddr *addr,
 117                    socklen_t addrlen);
 118
 119 /* Functions to read from or write to the networking layer */
 120 struct virtual_socket_t
 121 {
 122     void *p_sys;
 123     int (*pf_recv) ( void *, void *, int );
 124     int (*pf_send) ( void *, const void *, int );
 125 };
 126
 127 #define net_Read(a,b,c,d,e,f) __net_Read(VLC_OBJECT(a),b,c,d,e,f)
 128 VLC_EXPORT( ssize_t, __net_Read, ( vlc_object_t *p_this, int fd, const v_socket_t *, uint8_t *p_data, size_t i_data, vlc_bool_t b_retry ) );
 129
 130 #define net_Select(a,b,c,d,e) __net_Select(VLC_OBJECT(a),b,c,d,e)
 131 VLC_EXPORT( ssize_t, __net_Select, ( vlc_object_t *p_this, const int *pi_fd, int i_fd, uint8_t *p_data, size_t i_data ) );
 132
 133 #define net_Write(a,b,c,d,e) __net_Write(VLC_OBJECT(a),b,c,d,e)
 134 VLC_EXPORT( ssize_t, __net_Write, ( vlc_object_t *p_this, int fd, const v_socket_t *, const uint8_t *p_data, size_t i_data ) );
 135
 136 #define net_Gets(a,b,c) __net_Gets(VLC_OBJECT(a),b,c)
 137 VLC_EXPORT( char *, __net_Gets, ( vlc_object_t *p_this, int fd, const v_socket_t * ) );
 138
 139 VLC_EXPORT( ssize_t, net_Printf, ( vlc_object_t *p_this, int fd, const v_socket_t *, const char *psz_fmt, ... ) );
 140
 141 #define net_vaPrintf(a,b,c,d,e) __net_vaPrintf(VLC_OBJECT(a),b,c,d,e)
 142 VLC_EXPORT( ssize_t, __net_vaPrintf, ( vlc_object_t *p_this, int fd, const v_socket_t *, const char *psz_fmt, va_list args ) );
 143
 144
 145 #ifndef HAVE_INET_PTON
 146 /* only in core, so no need for C++ extern "C" */
 147 VLC_EXPORT (int, inet_pton, (int af, const char *src, void *dst) );
 148 #endif
 149
 150 #ifndef HAVE_INET_NTOP
 151 #ifdef WIN32
 152 /* only in core, so no need for C++ extern "C" */
 153 VLC_EXPORT (const char *, inet_ntop, (int af, const void *src,
 154                                       char *dst, socklen_t cnt) );
 155 #endif
 156 #endif
 157
 158 #ifndef HAVE_POLL
 159 enum
 160 {
 161     POLLIN=1,
 162     POLLOUT=2,
 163     POLLPRI=4,
 164     POLLERR=8,  // unsupported stub
 165     POLLHUP=16, // unsupported stub
 166     POLLNVAL=32 // unsupported stub
 167 };
 168
 169 struct pollfd
 170 {
 171     int fd;
 172     int events;
 173     int revents;
 174 };
 175
 176 int poll (struct pollfd *fds, unsigned nfds, int timeout);
 177 #endif
 178
 179 #ifdef WIN32
 180 /* Microsoft: same semantic, same value, different name... go figure */
 181 # define SHUT_RD SD_RECEIVE
 182 # define SHUT_WR SD_SEND
 183 # define SHUT_RDWR SD_BOTH
 184 # define net_Close( fd ) closesocket ((SOCKET)fd)
 185 #else
 186 #ifdef HAVE_UNISTD_H
 187 #include <unistd.h>
 188 #endif
 189 # define net_Close( fd ) (void)close (fd)
 190 #endif
 191
 192 /* Portable network names/addresses resolution layer */
 193
 194 /* GAI error codes */
 195 # ifndef EAI_BADFLAGS
 196 #  define EAI_BADFLAGS -1
 197 # endif
 198 # ifndef EAI_NONAME
 199 #  define EAI_NONAME -2
 200 # endif
 201 # ifndef EAI_AGAIN
 202 #  define EAI_AGAIN -3
 203 # endif
 204 # ifndef EAI_FAIL
 205 #  define EAI_FAIL -4
 206 # endif
 207 # ifndef EAI_NODATA
 208 #  define EAI_NODATA -5
 209 # endif
 210 # ifndef EAI_FAMILY
 211 #  define EAI_FAMILY -6
 212 # endif
 213 # ifndef EAI_SOCKTYPE
 214 #  define EAI_SOCKTYPE -7
 215 # endif
 216 # ifndef EAI_SERVICE
 217 #  define EAI_SERVICE -8
 218 # endif
 219 # ifndef EAI_ADDRFAMILY
 220 #  define EAI_ADDRFAMILY -9
 221 # endif
 222 # ifndef EAI_MEMORY
 223 #  define EAI_MEMORY -10
 224 # endif
 225 #ifndef EAI_OVERFLOW
 226 #  define EAI_OVERFLOW -11
 227 #endif
 228 # ifndef EAI_SYSTEM
 229 #  define EAI_SYSTEM -12
 230 # endif
 231
 232
 233 # ifndef NI_MAXHOST
 234 #  define NI_MAXHOST 1025
 235 #  define NI_MAXSERV 32
 236 # endif
 237 # define NI_MAXNUMERICHOST 64
 238
 239 # ifndef NI_NUMERICHOST
 240 #  define NI_NUMERICHOST 0x01
 241 #  define NI_NUMERICSERV 0x02
 242 #  define NI_NOFQDN      0x04
 243 #  define NI_NAMEREQD    0x08
 244 #  define NI_DGRAM       0x10
 245 # endif
 246
 247 # ifndef HAVE_STRUCT_ADDRINFO
 248 struct addrinfo
 249 {
 250     int ai_flags;
 251     int ai_family;
 252     int ai_socktype;
 253     int ai_protocol;
 254     size_t ai_addrlen;
 255     struct sockaddr *ai_addr;
 256     char *ai_canonname;
 257     struct addrinfo *ai_next;
 258 };
 259 #  define AI_PASSIVE     1
 260 #  define AI_CANONNAME   2
 261 #  define AI_NUMERICHOST 4
 262 # endif /* if !HAVE_STRUCT_ADDRINFO */
 263
 264 VLC_EXPORT( const char *, vlc_gai_strerror, ( int ) );
 265 VLC_EXPORT( int, vlc_getnameinfo, ( const struct sockaddr *, int, char *, int, int *, int ) );
 266 VLC_EXPORT( int, vlc_getaddrinfo, ( vlc_object_t *, const char *, int, const struct addrinfo *, struct addrinfo ** ) );
 267 VLC_EXPORT( void, vlc_freeaddrinfo, ( struct addrinfo * ) );
 268
 269
 270 static inline vlc_bool_t
 271 net_SockAddrIsMulticast (const struct sockaddr *addr, socklen_t len)
 272 {
 273     switch (addr->sa_family)
 274     {
 275 #ifdef IN_MULTICAST
 276         case AF_INET:
 277         {
 278             const struct sockaddr_in *v4 = (const struct sockaddr_in *)addr;
 279             if ((size_t)len < sizeof (*v4))
 280                 return VLC_FALSE;
 281             return IN_MULTICAST (ntohl (v4->sin_addr.s_addr)) != 0;
 282         }
 283 #endif
 284
 285 #ifdef IN6_IS_ADDR_MULTICAST
 286         case AF_INET6:
 287         {
 288             const struct sockaddr_in6 *v6 = (const struct sockaddr_in6 *)addr;
 289             if ((size_t)len < sizeof (*v6))
 290                 return VLC_FALSE;
 291             return IN6_IS_ADDR_MULTICAST (&v6->sin6_addr) != 0;
 292         }
 293 #endif
 294     }
 295
 296     return VLC_FALSE;
 297 }
 298
 299
 300
 301 /**
 302  * net_AddressIsMulticast
 303  * @return VLC_FALSE iff the psz_addr does not specify a multicast address,
 304  * or the address is not a valid address.
 305  */
 306 static inline vlc_bool_t net_AddressIsMulticast( vlc_object_t *p_object, const char *psz_addr )
 307 {
 308     struct addrinfo hints, *res;
 309
 310     memset (&hints, 0, sizeof (hints));
 311     hints.ai_socktype = SOCK_DGRAM; /* UDP */
 312     hints.ai_flags = AI_NUMERICHOST;
 313
 314     int i = vlc_getaddrinfo (p_object, psz_addr, 0,
 315                              &hints, &res);
 316     if (i)
 317     {
 318         msg_Err (p_object, "invalid address \"%s\" for net_AddressIsMulticast (%s)",
 319                  psz_addr, vlc_gai_strerror (i));
 320         return VLC_FALSE;
 321     }
 322
 323     vlc_bool_t b = net_SockAddrIsMulticast (res->ai_addr, res->ai_addrlen);
 324     vlc_freeaddrinfo (res);
 325     return b;
 326 }
 327
 328 static inline int net_GetSockAddress( int fd, char *address, int *port )
 329 {
 330     struct sockaddr_storage addr;
 331     socklen_t addrlen = sizeof( addr );
 332
 333     return getsockname( fd, (struct sockaddr *)&addr, &addrlen )
 334         || vlc_getnameinfo( (struct sockaddr *)&addr, addrlen, address,
 335                             NI_MAXNUMERICHOST, port, NI_NUMERICHOST )
 336         ? VLC_EGENERIC : 0;
 337 }
 338
 339 static inline int net_GetPeerAddress( int fd, char *address, int *port )
 340 {
 341     struct sockaddr_storage addr;
 342     socklen_t addrlen = sizeof( addr );
 343
 344     return getpeername( fd, (struct sockaddr *)&addr, &addrlen )
 345         || vlc_getnameinfo( (struct sockaddr *)&addr, addrlen, address,
 346                             NI_MAXNUMERICHOST, port, NI_NUMERICHOST )
 347         ? VLC_EGENERIC : 0;
 348 }
 349
 350 static inline uint16_t net_GetPort (const struct sockaddr *addr)
 351 {
 352     switch (addr->sa_family)
 353     {
 354 #ifdef AF_INET6
 355         case AF_INET6:
 356             return ((const struct sockaddr_in6 *)addr)->sin6_port;
 357 #endif
 358         case AF_INET:
 359             return ((const struct sockaddr_in *)addr)->sin_port;
 360     }
 361     return 0;
 362 }
 363
 364 static inline void net_SetPort (struct sockaddr *addr, uint16_t port)
 365 {
 366     switch (addr->sa_family)
 367     {
 368 #ifdef AF_INET6
 369         case AF_INET6:
 370             ((struct sockaddr_in6 *)addr)->sin6_port = port;
 371             break;
 372 #endif
 373         case AF_INET:
 374             ((struct sockaddr_in *)addr)->sin_port = port;
 375             break;
 376     }
 377 }
 378 # ifdef __cplusplus
 379 }
 380 # endif
 381
 382 #endif