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 #endif
  67
  68 # ifdef __cplusplus
  69 extern "C" {
  70 # endif
  71
  72 /* Portable networking layer communication */
  73 int net_Socket (vlc_object_t *obj, int family, int socktype, int proto);
  74 int net_SetupSocket (int fd);
  75
  76 #define net_Connect(a, b, c, d, e) __net_Connect(VLC_OBJECT(a), b, c, d, e)
  77 VLC_EXPORT( int, __net_Connect, (vlc_object_t *p_this, const char *psz_host, int i_port, int socktype, int protocol) );
  78
  79 VLC_EXPORT( int *, net_Listen, (vlc_object_t *p_this, const char *psz_host, int i_port, int protocol) );
  80
  81 #define net_ListenTCP(a, b, c) net_Listen(VLC_OBJECT(a), b, c, IPPROTO_TCP)
  82 #define net_ConnectTCP(a, b, c) __net_ConnectTCP(VLC_OBJECT(a), b, c)
  83
  84 static inline int __net_ConnectTCP (vlc_object_t *obj, const char *host, int port)
  85 {
  86     return __net_Connect (obj, host, port, SOCK_STREAM, IPPROTO_TCP);
  87 }
  88
  89 #define net_Accept(a, b, c) __net_Accept(VLC_OBJECT(a), b, c)
  90 VLC_EXPORT( int, __net_Accept, ( vlc_object_t *, int *, mtime_t ) );
  91
  92 #define net_ConnectDgram(a, b, c, d, e ) __net_ConnectDgram(VLC_OBJECT(a), b, c, d, e)
  93 VLC_EXPORT( int, __net_ConnectDgram, ( vlc_object_t *p_this, const char *psz_host, int i_port, int hlim, int proto ) );
  94
  95 static inline int net_ConnectUDP (vlc_object_t *obj, const char *host, int port, int hlim)
  96 {
  97     return net_ConnectDgram (obj, host, port, hlim, IPPROTO_UDP);
  98 }
  99
 100 #define net_OpenDgram( a, b, c, d, e, g, h ) __net_OpenDgram(VLC_OBJECT(a), b, c, d, e, g, h)
 101 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 ) );
 102
 103 static inline int net_ListenUDP1 (vlc_object_t *obj, const char *host, int port)
 104 {
 105     return net_OpenDgram (obj, host, port, NULL, 0, 0, IPPROTO_UDP);
 106 }
 107
 108 VLC_EXPORT( void, net_ListenClose, ( int *fd ) );
 109
 110 int net_Subscribe (vlc_object_t *obj, int fd, const struct sockaddr *addr,
 111                    socklen_t addrlen);
 112
 113 VLC_EXPORT( int, net_SetCSCov, ( int fd, int sendcov, int recvcov ) );
 114
 115 /* Functions to read from or write to the networking layer */
 116 struct virtual_socket_t
 117 {
 118     void *p_sys;
 119     int (*pf_recv) ( void *, void *, int );
 120     int (*pf_send) ( void *, const void *, int );
 121 };
 122
 123 #define net_Read(a,b,c,d,e,f) __net_Read(VLC_OBJECT(a),b,c,d,e,f)
 124 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 ) );
 125
 126 #define net_Select(a,b,c,d,e) __net_Select(VLC_OBJECT(a),b,c,d,e)
 127 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 ) );
 128
 129 #define net_Write(a,b,c,d,e) __net_Write(VLC_OBJECT(a),b,c,d,e)
 130 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 ) );
 131
 132 #define net_Gets(a,b,c) __net_Gets(VLC_OBJECT(a),b,c)
 133 VLC_EXPORT( char *, __net_Gets, ( vlc_object_t *p_this, int fd, const v_socket_t * ) );
 134
 135 VLC_EXPORT( ssize_t, net_Printf, ( vlc_object_t *p_this, int fd, const v_socket_t *, const char *psz_fmt, ... ) ATTRIBUTE_FORMAT( 4, 5 ) );
 136
 137 #define net_vaPrintf(a,b,c,d,e) __net_vaPrintf(VLC_OBJECT(a),b,c,d,e)
 138 VLC_EXPORT( ssize_t, __net_vaPrintf, ( vlc_object_t *p_this, int fd, const v_socket_t *, const char *psz_fmt, va_list args ) );
 139
 140
 141 #ifndef HAVE_INET_PTON
 142 /* only in core, so no need for C++ extern "C" */
 143 VLC_EXPORT (int, inet_pton, (int af, const char *src, void *dst) );
 144 #endif
 145
 146 #ifndef HAVE_INET_NTOP
 147 #ifdef WIN32
 148 /* only in core, so no need for C++ extern "C" */
 149 VLC_EXPORT (const char *, inet_ntop, (int af, const void *src,
 150                                       char *dst, socklen_t cnt) );
 151 #endif
 152 #endif
 153
 154 #ifndef HAVE_POLL
 155 enum
 156 {
 157     POLLIN=1,
 158     POLLOUT=2,
 159     POLLPRI=4,
 160     POLLERR=8,  // unsupported stub
 161     POLLHUP=16, // unsupported stub
 162     POLLNVAL=32 // unsupported stub
 163 };
 164
 165 struct pollfd
 166 {
 167     int fd;
 168     int events;
 169     int revents;
 170 };
 171
 172 int poll (struct pollfd *fds, unsigned nfds, int timeout);
 173 #endif
 174
 175 #ifdef WIN32
 176 /* Microsoft: same semantic, same value, different name... go figure */
 177 # define SHUT_RD SD_RECEIVE
 178 # define SHUT_WR SD_SEND
 179 # define SHUT_RDWR SD_BOTH
 180 # define net_Close( fd ) closesocket ((SOCKET)fd)
 181 #else
 182 #ifdef HAVE_UNISTD_H
 183 #include <unistd.h>
 184 #endif
 185 # define net_Close( fd ) (void)close (fd)
 186 #endif
 187
 188 /* Portable network names/addresses resolution layer */
 189
 190 /* GAI error codes */
 191 # ifndef EAI_BADFLAGS
 192 #  define EAI_BADFLAGS -1
 193 # endif
 194 # ifndef EAI_NONAME
 195 #  define EAI_NONAME -2
 196 # endif
 197 # ifndef EAI_AGAIN
 198 #  define EAI_AGAIN -3
 199 # endif
 200 # ifndef EAI_FAIL
 201 #  define EAI_FAIL -4
 202 # endif
 203 # ifndef EAI_NODATA
 204 #  define EAI_NODATA -5
 205 # endif
 206 # ifndef EAI_FAMILY
 207 #  define EAI_FAMILY -6
 208 # endif
 209 # ifndef EAI_SOCKTYPE
 210 #  define EAI_SOCKTYPE -7
 211 # endif
 212 # ifndef EAI_SERVICE
 213 #  define EAI_SERVICE -8
 214 # endif
 215 # ifndef EAI_ADDRFAMILY
 216 #  define EAI_ADDRFAMILY -9
 217 # endif
 218 # ifndef EAI_MEMORY
 219 #  define EAI_MEMORY -10
 220 # endif
 221 #ifndef EAI_OVERFLOW
 222 #  define EAI_OVERFLOW -11
 223 #endif
 224 # ifndef EAI_SYSTEM
 225 #  define EAI_SYSTEM -12
 226 # endif
 227
 228
 229 # ifndef NI_MAXHOST
 230 #  define NI_MAXHOST 1025
 231 #  define NI_MAXSERV 32
 232 # endif
 233 # define NI_MAXNUMERICHOST 64
 234
 235 # ifndef NI_NUMERICHOST
 236 #  define NI_NUMERICHOST 0x01
 237 #  define NI_NUMERICSERV 0x02
 238 #  define NI_NOFQDN      0x04
 239 #  define NI_NAMEREQD    0x08
 240 #  define NI_DGRAM       0x10
 241 # endif
 242
 243 # ifndef HAVE_STRUCT_ADDRINFO
 244 struct addrinfo
 245 {
 246     int ai_flags;
 247     int ai_family;
 248     int ai_socktype;
 249     int ai_protocol;
 250     size_t ai_addrlen;
 251     struct sockaddr *ai_addr;
 252     char *ai_canonname;
 253     struct addrinfo *ai_next;
 254 };
 255 #  define AI_PASSIVE     1
 256 #  define AI_CANONNAME   2
 257 #  define AI_NUMERICHOST 4
 258 # endif /* if !HAVE_STRUCT_ADDRINFO */
 259
 260 VLC_EXPORT( const char *, vlc_gai_strerror, ( int ) );
 261 VLC_EXPORT( int, vlc_getnameinfo, ( const struct sockaddr *, int, char *, int, int *, int ) );
 262 VLC_EXPORT( int, vlc_getaddrinfo, ( vlc_object_t *, const char *, int, const struct addrinfo *, struct addrinfo ** ) );
 263 VLC_EXPORT( void, vlc_freeaddrinfo, ( struct addrinfo * ) );
 264
 265
 266 static inline vlc_bool_t
 267 net_SockAddrIsMulticast (const struct sockaddr *addr, socklen_t len)
 268 {
 269     switch (addr->sa_family)
 270     {
 271 #ifdef IN_MULTICAST
 272         case AF_INET:
 273         {
 274             const struct sockaddr_in *v4 = (const struct sockaddr_in *)addr;
 275             if ((size_t)len < sizeof (*v4))
 276                 return VLC_FALSE;
 277             return IN_MULTICAST (ntohl (v4->sin_addr.s_addr)) != 0;
 278         }
 279 #endif
 280
 281 #ifdef IN6_IS_ADDR_MULTICAST
 282         case AF_INET6:
 283         {
 284             const struct sockaddr_in6 *v6 = (const struct sockaddr_in6 *)addr;
 285             if ((size_t)len < sizeof (*v6))
 286                 return VLC_FALSE;
 287             return IN6_IS_ADDR_MULTICAST (&v6->sin6_addr) != 0;
 288         }
 289 #endif
 290     }
 291
 292     return VLC_FALSE;
 293 }
 294
 295
 296
 297 /**
 298  * net_AddressIsMulticast
 299  * @return VLC_FALSE iff the psz_addr does not specify a multicast address,
 300  * or the address is not a valid address.
 301  */
 302 static inline vlc_bool_t net_AddressIsMulticast( vlc_object_t *p_object, const char *psz_addr )
 303 {
 304     struct addrinfo hints, *res;
 305
 306     memset (&hints, 0, sizeof (hints));
 307     hints.ai_socktype = SOCK_DGRAM; /* UDP */
 308     hints.ai_flags = AI_NUMERICHOST;
 309
 310     int i = vlc_getaddrinfo (p_object, psz_addr, 0,
 311                              &hints, &res);
 312     if (i)
 313     {
 314         msg_Err (p_object, "invalid address \"%s\" for net_AddressIsMulticast (%s)",
 315                  psz_addr, vlc_gai_strerror (i));
 316         return VLC_FALSE;
 317     }
 318
 319     vlc_bool_t b = net_SockAddrIsMulticast (res->ai_addr, res->ai_addrlen);
 320     vlc_freeaddrinfo (res);
 321     return b;
 322 }
 323
 324 static inline int net_GetSockAddress( int fd, char *address, int *port )
 325 {
 326     struct sockaddr_storage addr;
 327     socklen_t addrlen = sizeof( addr );
 328
 329     return getsockname( fd, (struct sockaddr *)&addr, &addrlen )
 330         || vlc_getnameinfo( (struct sockaddr *)&addr, addrlen, address,
 331                             NI_MAXNUMERICHOST, port, NI_NUMERICHOST )
 332         ? VLC_EGENERIC : 0;
 333 }
 334
 335 static inline int net_GetPeerAddress( int fd, char *address, int *port )
 336 {
 337     struct sockaddr_storage addr;
 338     socklen_t addrlen = sizeof( addr );
 339
 340     return getpeername( fd, (struct sockaddr *)&addr, &addrlen )
 341         || vlc_getnameinfo( (struct sockaddr *)&addr, addrlen, address,
 342                             NI_MAXNUMERICHOST, port, NI_NUMERICHOST )
 343         ? VLC_EGENERIC : 0;
 344 }
 345
 346 static inline uint16_t net_GetPort (const struct sockaddr *addr)
 347 {
 348     switch (addr->sa_family)
 349     {
 350 #ifdef AF_INET6
 351         case AF_INET6:
 352             return ((const struct sockaddr_in6 *)addr)->sin6_port;
 353 #endif
 354         case AF_INET:
 355             return ((const struct sockaddr_in *)addr)->sin_port;
 356     }
 357     return 0;
 358 }
 359
 360 static inline void net_SetPort (struct sockaddr *addr, uint16_t port)
 361 {
 362     switch (addr->sa_family)
 363     {
 364 #ifdef AF_INET6
 365         case AF_INET6:
 366             ((struct sockaddr_in6 *)addr)->sin6_port = port;
 367         break;
 368 #endif
 369         case AF_INET:
 370             ((struct sockaddr_in *)addr)->sin_port = port;
 371         break;
 372     }
 373 }
 374 # ifdef __cplusplus
 375 }
 376 # endif
 377
 378 #endif