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 #ifndef VLC_NETWORK_H
  28 # define VLC_NETWORK_H
  29
  30 /**
  31  * \file
  32  * This file defines interface to communicate with network plug-ins
  33  */
  34
  35 #if defined( WIN32 )
  36 #   if !defined(UNDER_CE)
  37 #       define _NO_OLDNAMES 1
  38 #       include <io.h>
  39 #   endif
  40 #   include <winsock2.h>
  41 #   include <ws2tcpip.h>
  42 #   define ENETUNREACH WSAENETUNREACH
  43 #   define net_errno (WSAGetLastError())
  44 extern const char *net_strerror( int val );
  45
  46 struct iovec
  47 {
  48     void  *iov_base;
  49     size_t iov_len;
  50 };
  51
  52 struct msghdr
  53 {
  54     void         *msg_name;
  55     size_t        msg_namelen;
  56     struct iovec *msg_iov;
  57     size_t        msg_iovlen;
  58     void         *msg_control;
  59     size_t        msg_controllen;
  60     int           msg_flags;
  61 };
  62
  63 #   ifndef IPV6_V6ONLY
  64 #       define IPV6_V6ONLY 27
  65 #   endif
  66 #else
  67 #   include <sys/socket.h>
  68 #   ifdef HAVE_NETINET_IN_H
  69 #      include <netinet/in.h>
  70 #   endif
  71 #   ifdef HAVE_ARPA_INET_H
  72 #      include <arpa/inet.h>
  73 #   elif defined( SYS_BEOS )
  74 #      include <net/netdb.h>
  75 #   endif
  76 #   include <netdb.h>
  77 #   define net_errno errno
  78 #endif
  79
  80 # ifdef __cplusplus
  81 extern "C" {
  82 # endif
  83
  84 /* Portable networking layer communication */
  85 int net_Socket (vlc_object_t *obj, int family, int socktype, int proto);
  86 int net_SetupSocket (int fd);
  87
  88 #define net_Connect(a, b, c, d, e) __net_Connect(VLC_OBJECT(a), b, c, d, e)
  89 VLC_EXPORT( int, __net_Connect, (vlc_object_t *p_this, const char *psz_host, int i_port, int socktype, int protocol) );
  90
  91 VLC_EXPORT( int *, net_Listen, (vlc_object_t *p_this, const char *psz_host, int i_port, int protocol) );
  92
  93 #define net_ListenTCP(a, b, c) net_Listen(VLC_OBJECT(a), b, c, IPPROTO_TCP)
  94 #define net_ConnectTCP(a, b, c) __net_ConnectTCP(VLC_OBJECT(a), b, c)
  95
  96 static inline int __net_ConnectTCP (vlc_object_t *obj, const char *host, int port)
  97 {
  98     return __net_Connect (obj, host, port, SOCK_STREAM, IPPROTO_TCP);
  99 }
 100
 101
 102 VLC_EXPORT( int, net_AcceptSingle, (vlc_object_t *obj, int lfd) );
 103
 104 VLC_EXPORT( int, net_Accept, ( vlc_object_t *, int * ) );
 105 #define net_Accept(a, b) \
 106         net_Accept(VLC_OBJECT(a), b)
 107
 108 #define net_ConnectDgram(a, b, c, d, e ) __net_ConnectDgram(VLC_OBJECT(a), b, c, d, e)
 109 VLC_EXPORT( int, __net_ConnectDgram, ( vlc_object_t *p_this, const char *psz_host, int i_port, int hlim, int proto ) );
 110
 111 static inline int net_ConnectUDP (vlc_object_t *obj, const char *host, int port, int hlim)
 112 {
 113     return net_ConnectDgram (obj, host, port, hlim, IPPROTO_UDP);
 114 }
 115
 116 #define net_OpenDgram( a, b, c, d, e, g, h ) __net_OpenDgram(VLC_OBJECT(a), b, c, d, e, g, h)
 117 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 ) );
 118
 119 static inline int net_ListenUDP1 (vlc_object_t *obj, const char *host, int port)
 120 {
 121     return net_OpenDgram (obj, host, port, NULL, 0, 0, IPPROTO_UDP);
 122 }
 123
 124 VLC_EXPORT( void, net_ListenClose, ( int *fd ) );
 125
 126 int net_Subscribe (vlc_object_t *obj, int fd, const struct sockaddr *addr,
 127                    socklen_t addrlen);
 128
 129 VLC_EXPORT( int, net_SetCSCov, ( int fd, int sendcov, int recvcov ) );
 130
 131 /* Functions to read from or write to the networking layer */
 132 struct virtual_socket_t
 133 {
 134     void *p_sys;
 135     int (*pf_recv) ( void *, void *, int );
 136     int (*pf_send) ( void *, const void *, int );
 137 };
 138
 139 #define net_Read(a,b,c,d,e,f) __net_Read(VLC_OBJECT(a),b,c,d,e,f)
 140 VLC_EXPORT( ssize_t, __net_Read, ( vlc_object_t *p_this, int fd, const v_socket_t *, void *p_data, size_t i_data, bool b_retry ) );
 141
 142 #define net_Write(a,b,c,d,e) __net_Write(VLC_OBJECT(a),b,c,d,e)
 143 VLC_EXPORT( ssize_t, __net_Write, ( vlc_object_t *p_this, int fd, const v_socket_t *, const void *p_data, size_t i_data ) );
 144
 145 #define net_Gets(a,b,c) __net_Gets(VLC_OBJECT(a),b,c)
 146 VLC_EXPORT( char *, __net_Gets, ( vlc_object_t *p_this, int fd, const v_socket_t * ) );
 147
 148 VLC_EXPORT( ssize_t, net_Printf, ( vlc_object_t *p_this, int fd, const v_socket_t *, const char *psz_fmt, ... ) LIBVLC_FORMAT( 4, 5 ) );
 149
 150 #define net_vaPrintf(a,b,c,d,e) __net_vaPrintf(VLC_OBJECT(a),b,c,d,e)
 151 VLC_EXPORT( ssize_t, __net_vaPrintf, ( vlc_object_t *p_this, int fd, const v_socket_t *, const char *psz_fmt, va_list args ) );
 152
 153
 154 /* Don't go to an extra call layer if we have the symbol */
 155 #ifndef HAVE_INET_PTON
 156 #define inet_pton vlc_inet_pton
 157 #endif
 158 #ifndef HAVE_INET_NTOP
 159 #define inet_ntop vlc_inet_ntop
 160 #endif
 161
 162 VLC_EXPORT (int, vlc_inet_pton, (int af, const char *src, void *dst) );
 163 VLC_EXPORT (const char *, vlc_inet_ntop, (int af, const void *src,
 164                                           char *dst, socklen_t cnt) );
 165
 166 #ifndef HAVE_POLL
 167 enum
 168 {
 169     POLLIN=1,
 170     POLLOUT=2,
 171     POLLPRI=4,
 172     POLLERR=8,  // unsupported stub
 173     POLLHUP=16, // unsupported stub
 174     POLLNVAL=32 // unsupported stub
 175 };
 176
 177 struct pollfd
 178 {
 179     int fd;
 180     int events;
 181     int revents;
 182 };
 183 # define poll(a, b, c) vlc_poll(a, b, c)
 184 #endif
 185 struct pollfd;
 186 VLC_EXPORT (int, vlc_poll, (struct pollfd *fds, unsigned nfds, int timeout));
 187
 188
 189 #ifdef WIN32
 190 /* Microsoft: same semantic, same value, different name... go figure */
 191 # define SHUT_RD SD_RECEIVE
 192 # define SHUT_WR SD_SEND
 193 # define SHUT_RDWR SD_BOTH
 194 # define net_Close( fd ) closesocket ((SOCKET)fd)
 195 #else
 196 #ifdef HAVE_UNISTD_H
 197 #include <unistd.h>
 198 #endif
 199 # define net_Close( fd ) (void)close (fd)
 200 #endif
 201
 202 /* Portable network names/addresses resolution layer */
 203
 204 /* GAI error codes */
 205 # ifndef EAI_BADFLAGS
 206 #  define EAI_BADFLAGS -1
 207 # endif
 208 # ifndef EAI_NONAME
 209 #  define EAI_NONAME -2
 210 # endif
 211 # ifndef EAI_AGAIN
 212 #  define EAI_AGAIN -3
 213 # endif
 214 # ifndef EAI_FAIL
 215 #  define EAI_FAIL -4
 216 # endif
 217 # ifndef EAI_NODATA
 218 #  define EAI_NODATA -5
 219 # endif
 220 # ifndef EAI_FAMILY
 221 #  define EAI_FAMILY -6
 222 # endif
 223 # ifndef EAI_SOCKTYPE
 224 #  define EAI_SOCKTYPE -7
 225 # endif
 226 # ifndef EAI_SERVICE
 227 #  define EAI_SERVICE -8
 228 # endif
 229 # ifndef EAI_ADDRFAMILY
 230 #  define EAI_ADDRFAMILY -9
 231 # endif
 232 # ifndef EAI_MEMORY
 233 #  define EAI_MEMORY -10
 234 # endif
 235 #ifndef EAI_OVERFLOW
 236 #  define EAI_OVERFLOW -11
 237 #endif
 238 # ifndef EAI_SYSTEM
 239 #  define EAI_SYSTEM -12
 240 # endif
 241
 242
 243 # ifndef NI_MAXHOST
 244 #  define NI_MAXHOST 1025
 245 #  define NI_MAXSERV 32
 246 # endif
 247 # define NI_MAXNUMERICHOST 64
 248
 249 # ifndef NI_NUMERICHOST
 250 #  define NI_NUMERICHOST 0x01
 251 #  define NI_NUMERICSERV 0x02
 252 #  define NI_NOFQDN      0x04
 253 #  define NI_NAMEREQD    0x08
 254 #  define NI_DGRAM       0x10
 255 # endif
 256
 257 # ifndef HAVE_STRUCT_ADDRINFO
 258 struct addrinfo
 259 {
 260     int ai_flags;
 261     int ai_family;
 262     int ai_socktype;
 263     int ai_protocol;
 264     size_t ai_addrlen;
 265     struct sockaddr *ai_addr;
 266     char *ai_canonname;
 267     struct addrinfo *ai_next;
 268 };
 269 #  define AI_PASSIVE     1
 270 #  define AI_CANONNAME   2
 271 #  define AI_NUMERICHOST 4
 272 # endif /* if !HAVE_STRUCT_ADDRINFO */
 273
 274 #ifndef AI_NUMERICSERV
 275 # define AI_NUMERICSERV 0
 276 #endif
 277
 278 VLC_EXPORT( const char *, vlc_gai_strerror, ( int ) );
 279 VLC_EXPORT( int, vlc_getnameinfo, ( const struct sockaddr *, int, char *, int, int *, int ) );
 280 VLC_EXPORT( int, vlc_getaddrinfo, ( vlc_object_t *, const char *, int, const struct addrinfo *, struct addrinfo ** ) );
 281 VLC_EXPORT( void, vlc_freeaddrinfo, ( struct addrinfo * ) );
 282
 283
 284 static inline bool
 285 net_SockAddrIsMulticast (const struct sockaddr *addr, socklen_t len)
 286 {
 287     switch (addr->sa_family)
 288     {
 289 #ifdef IN_MULTICAST
 290         case AF_INET:
 291         {
 292             const struct sockaddr_in *v4 = (const struct sockaddr_in *)addr;
 293             if ((size_t)len < sizeof (*v4))
 294                 return false;
 295             return IN_MULTICAST (ntohl (v4->sin_addr.s_addr)) != 0;
 296         }
 297 #endif
 298
 299 #ifdef IN6_IS_ADDR_MULTICAST
 300         case AF_INET6:
 301         {
 302             const struct sockaddr_in6 *v6 = (const struct sockaddr_in6 *)addr;
 303             if ((size_t)len < sizeof (*v6))
 304                 return false;
 305             return IN6_IS_ADDR_MULTICAST (&v6->sin6_addr) != 0;
 306         }
 307 #endif
 308     }
 309
 310     return false;
 311 }
 312
 313
 314 static inline int net_GetSockAddress( int fd, char *address, int *port )
 315 {
 316     struct sockaddr_storage addr;
 317     socklen_t addrlen = sizeof( addr );
 318
 319     return getsockname( fd, (struct sockaddr *)&addr, &addrlen )
 320         || vlc_getnameinfo( (struct sockaddr *)&addr, addrlen, address,
 321                             NI_MAXNUMERICHOST, port, NI_NUMERICHOST )
 322         ? VLC_EGENERIC : 0;
 323 }
 324
 325 static inline int net_GetPeerAddress( int fd, char *address, int *port )
 326 {
 327     struct sockaddr_storage addr;
 328     socklen_t addrlen = sizeof( addr );
 329
 330     return getpeername( fd, (struct sockaddr *)&addr, &addrlen )
 331         || vlc_getnameinfo( (struct sockaddr *)&addr, addrlen, address,
 332                             NI_MAXNUMERICHOST, port, NI_NUMERICHOST )
 333         ? VLC_EGENERIC : 0;
 334 }
 335
 336 static inline uint16_t net_GetPort (const struct sockaddr *addr)
 337 {
 338     switch (addr->sa_family)
 339     {
 340 #ifdef AF_INET6
 341         case AF_INET6:
 342             return ((const struct sockaddr_in6 *)addr)->sin6_port;
 343 #endif
 344         case AF_INET:
 345             return ((const struct sockaddr_in *)addr)->sin_port;
 346     }
 347     return 0;
 348 }
 349
 350 static inline void net_SetPort (struct sockaddr *addr, uint16_t port)
 351 {
 352     switch (addr->sa_family)
 353     {
 354 #ifdef AF_INET6
 355         case AF_INET6:
 356             ((struct sockaddr_in6 *)addr)->sin6_port = port;
 357         break;
 358 #endif
 359         case AF_INET:
 360             ((struct sockaddr_in *)addr)->sin_port = port;
 361         break;
 362     }
 363 }
 364 # ifdef __cplusplus
 365 }
 366 # endif
 367
 368 #endif