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