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