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