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