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 #if defined( WIN32 )
  31 #   if !defined(UNDER_CE)
  32 #       define _NO_OLDNAMES 1
  33 #       include <io.h>
  34 #   endif
  35 #   include <winsock2.h>
  36 #   include <ws2tcpip.h>
  37 #   define ENETUNREACH WSAENETUNREACH
  38 #   define net_errno (WSAGetLastError())
  39 extern const char *net_strerror( int val );
  40
  41 struct iovec
  42 {
  43     void  *iov_base;
  44     size_t iov_len;
  45 };
  46
  47 struct msghdr
  48 {
  49     void         *msg_name;
  50     size_t        msg_namelen;
  51     struct iovec *msg_iov;
  52     size_t        msg_iovlen;
  53     void         *msg_control;
  54     size_t        msg_controllen;
  55     int           msg_flags;
  56 };
  57
  58 #define sendmsg vlc_sendmsg
  59 #define recvmsg vlc_recvmsg
  60
  61 #   ifndef IPV6_V6ONLY
  62 #       define IPV6_V6ONLY 27
  63 #   endif
  64 #else
  65 #   include <sys/socket.h>
  66 #   ifdef HAVE_NETINET_IN_H
  67 #      include <netinet/in.h>
  68 #   endif
  69 #   ifdef HAVE_ARPA_INET_H
  70 #      include <arpa/inet.h>
  71 #   elif defined( SYS_BEOS )
  72 #      include <net/netdb.h>
  73 #   endif
  74 #   include <netdb.h>
  75 #   define net_errno errno
  76 #endif
  77
  78 VLC_EXPORT( ssize_t, vlc_sendmsg, ( int, struct msghdr *, int ) );
  79 VLC_EXPORT( ssize_t, vlc_recvmsg, ( int, struct msghdr *, int ) );
  80
  81 # ifdef __cplusplus
  82 extern "C" {
  83 # endif
  84
  85 /* Portable networking layer communication */
  86 int net_Socket (vlc_object_t *obj, int family, int socktype, int proto);
  87 int net_SetupSocket (int fd);
  88
  89 #define net_Connect(a, b, c, d, e) __net_Connect(VLC_OBJECT(a), b, c, d, e)
  90 VLC_EXPORT( int, __net_Connect, (vlc_object_t *p_this, const char *psz_host, int i_port, int socktype, int protocol) );
  91
  92 VLC_EXPORT( int *, net_Listen, (vlc_object_t *p_this, const char *psz_host, int i_port, int protocol) );
  93
  94 #define net_ListenTCP(a, b, c) net_Listen(VLC_OBJECT(a), b, c, IPPROTO_TCP)
  95 #define net_ConnectTCP(a, b, c) __net_ConnectTCP(VLC_OBJECT(a), b, c)
  96
  97 static inline int __net_ConnectTCP (vlc_object_t *obj, const char *host, int port)
  98 {
  99     return __net_Connect (obj, host, port, SOCK_STREAM, IPPROTO_TCP);
 100 }
 101
 102
 103 VLC_EXPORT( int, net_AcceptSingle, (vlc_object_t *obj, int lfd) );
 104
 105 #define net_Accept(a, b, c) __net_Accept(VLC_OBJECT(a), b, c)
 106 VLC_EXPORT( int, __net_Accept, ( vlc_object_t *, int *, mtime_t ) );
 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 *, uint8_t *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 uint8_t *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
 184   VLC_EXPORT (int, poll, (struct pollfd *fds, unsigned nfds, int timeout));
 185 #endif
 186
 187 #ifdef WIN32
 188 /* Microsoft: same semantic, same value, different name... go figure */
 189 # define SHUT_RD SD_RECEIVE
 190 # define SHUT_WR SD_SEND
 191 # define SHUT_RDWR SD_BOTH
 192 # define net_Close( fd ) closesocket ((SOCKET)fd)
 193 #else
 194 #ifdef HAVE_UNISTD_H
 195 #include <unistd.h>
 196 #endif
 197 # define net_Close( fd ) (void)close (fd)
 198 #endif
 199
 200 /* Portable network names/addresses resolution layer */
 201
 202 /* GAI error codes */
 203 # ifndef EAI_BADFLAGS
 204 #  define EAI_BADFLAGS -1
 205 # endif
 206 # ifndef EAI_NONAME
 207 #  define EAI_NONAME -2
 208 # endif
 209 # ifndef EAI_AGAIN
 210 #  define EAI_AGAIN -3
 211 # endif
 212 # ifndef EAI_FAIL
 213 #  define EAI_FAIL -4
 214 # endif
 215 # ifndef EAI_NODATA
 216 #  define EAI_NODATA -5
 217 # endif
 218 # ifndef EAI_FAMILY
 219 #  define EAI_FAMILY -6
 220 # endif
 221 # ifndef EAI_SOCKTYPE
 222 #  define EAI_SOCKTYPE -7
 223 # endif
 224 # ifndef EAI_SERVICE
 225 #  define EAI_SERVICE -8
 226 # endif
 227 # ifndef EAI_ADDRFAMILY
 228 #  define EAI_ADDRFAMILY -9
 229 # endif
 230 # ifndef EAI_MEMORY
 231 #  define EAI_MEMORY -10
 232 # endif
 233 #ifndef EAI_OVERFLOW
 234 #  define EAI_OVERFLOW -11
 235 #endif
 236 # ifndef EAI_SYSTEM
 237 #  define EAI_SYSTEM -12
 238 # endif
 239
 240
 241 # ifndef NI_MAXHOST
 242 #  define NI_MAXHOST 1025
 243 #  define NI_MAXSERV 32
 244 # endif
 245 # define NI_MAXNUMERICHOST 64
 246
 247 # ifndef NI_NUMERICHOST
 248 #  define NI_NUMERICHOST 0x01
 249 #  define NI_NUMERICSERV 0x02
 250 #  define NI_NOFQDN      0x04
 251 #  define NI_NAMEREQD    0x08
 252 #  define NI_DGRAM       0x10
 253 # endif
 254
 255 # ifndef HAVE_STRUCT_ADDRINFO
 256 struct addrinfo
 257 {
 258     int ai_flags;
 259     int ai_family;
 260     int ai_socktype;
 261     int ai_protocol;
 262     size_t ai_addrlen;
 263     struct sockaddr *ai_addr;
 264     char *ai_canonname;
 265     struct addrinfo *ai_next;
 266 };
 267 #  define AI_PASSIVE     1
 268 #  define AI_CANONNAME   2
 269 #  define AI_NUMERICHOST 4
 270 # endif /* if !HAVE_STRUCT_ADDRINFO */
 271
 272 #ifndef AI_NUMERICSERV
 273 # define AI_NUMERICSERV 0
 274 #endif
 275
 276 VLC_EXPORT( const char *, vlc_gai_strerror, ( int ) );
 277 VLC_EXPORT( int, vlc_getnameinfo, ( const struct sockaddr *, int, char *, int, int *, int ) );
 278 VLC_EXPORT( int, vlc_getaddrinfo, ( vlc_object_t *, const char *, int, const struct addrinfo *, struct addrinfo ** ) );
 279 VLC_EXPORT( void, vlc_freeaddrinfo, ( struct addrinfo * ) );
 280
 281
 282 static inline bool
 283 net_SockAddrIsMulticast (const struct sockaddr *addr, socklen_t len)
 284 {
 285     switch (addr->sa_family)
 286     {
 287 #ifdef IN_MULTICAST
 288         case AF_INET:
 289         {
 290             const struct sockaddr_in *v4 = (const struct sockaddr_in *)addr;
 291             if ((size_t)len < sizeof (*v4))
 292                 return false;
 293             return IN_MULTICAST (ntohl (v4->sin_addr.s_addr)) != 0;
 294         }
 295 #endif
 296
 297 #ifdef IN6_IS_ADDR_MULTICAST
 298         case AF_INET6:
 299         {
 300             const struct sockaddr_in6 *v6 = (const struct sockaddr_in6 *)addr;
 301             if ((size_t)len < sizeof (*v6))
 302                 return false;
 303             return IN6_IS_ADDR_MULTICAST (&v6->sin6_addr) != 0;
 304         }
 305 #endif
 306     }
 307
 308     return false;
 309 }
 310
 311
 312 static inline int net_GetSockAddress( int fd, char *address, int *port )
 313 {
 314     struct sockaddr_storage addr;
 315     socklen_t addrlen = sizeof( addr );
 316
 317     return getsockname( fd, (struct sockaddr *)&addr, &addrlen )
 318         || vlc_getnameinfo( (struct sockaddr *)&addr, addrlen, address,
 319                             NI_MAXNUMERICHOST, port, NI_NUMERICHOST )
 320         ? VLC_EGENERIC : 0;
 321 }
 322
 323 static inline int net_GetPeerAddress( int fd, char *address, int *port )
 324 {
 325     struct sockaddr_storage addr;
 326     socklen_t addrlen = sizeof( addr );
 327
 328     return getpeername( fd, (struct sockaddr *)&addr, &addrlen )
 329         || vlc_getnameinfo( (struct sockaddr *)&addr, addrlen, address,
 330                             NI_MAXNUMERICHOST, port, NI_NUMERICHOST )
 331         ? VLC_EGENERIC : 0;
 332 }
 333
 334 static inline uint16_t net_GetPort (const struct sockaddr *addr)
 335 {
 336     switch (addr->sa_family)
 337     {
 338 #ifdef AF_INET6
 339         case AF_INET6:
 340             return ((const struct sockaddr_in6 *)addr)->sin6_port;
 341 #endif
 342         case AF_INET:
 343             return ((const struct sockaddr_in *)addr)->sin_port;
 344     }
 345     return 0;
 346 }
 347
 348 static inline void net_SetPort (struct sockaddr *addr, uint16_t port)
 349 {
 350     switch (addr->sa_family)
 351     {
 352 #ifdef AF_INET6
 353         case AF_INET6:
 354             ((struct sockaddr_in6 *)addr)->sin6_port = port;
 355         break;
 356 #endif
 357         case AF_INET:
 358             ((struct sockaddr_in *)addr)->sin_port = port;
 359         break;
 360     }
 361 }
 362 # ifdef __cplusplus
 363 }
 364 # endif
 365
 366 #endif