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