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 #   endif
  74 #   include <netdb.h>
  75 #   define net_errno errno
  76 #endif
  77
  78 #if defined( __SYMBIAN32__ )
  79 #   undef AF_INET6
  80 #   undef IN6_IS_ADDR_MULTICAST
  81 #   undef IPV6_V6ONLY
  82 #   undef IPV6_MULTICAST_HOPS
  83 #   undef IPV6_MULTICAST_IF
  84 #   undef IPV6_TCLASS
  85 #   undef IPV6_JOIN_GROUP
  86 #endif
  87
  88 int vlc_socket (int, int, int, bool nonblock) VLC_USED;
  89
  90 struct sockaddr;
  91 VLC_API int vlc_accept( int, struct sockaddr *, socklen_t *, bool ) VLC_USED;
  92
  93 # ifdef __cplusplus
  94 extern "C" {
  95 # endif
  96
  97 /* Portable networking layer communication */
  98 int net_Socket (vlc_object_t *obj, int family, int socktype, int proto);
  99
 100 VLC_API int net_Connect(vlc_object_t *p_this, const char *psz_host, int i_port, int socktype, int protocol);
 101 #define net_Connect(a, b, c, d, e) net_Connect(VLC_OBJECT(a), b, c, d, e)
 102
 103 VLC_API int * net_Listen(vlc_object_t *p_this, const char *psz_host, int i_port, int socktype, int protocol);
 104
 105 #define net_ListenTCP(a, b, c) net_Listen(VLC_OBJECT(a), b, c, \
 106                                           SOCK_STREAM, IPPROTO_TCP)
 107
 108 static inline int net_ConnectTCP (vlc_object_t *obj, const char *host, int port)
 109 {
 110     return net_Connect (obj, host, port, SOCK_STREAM, IPPROTO_TCP);
 111 }
 112 #define net_ConnectTCP(a, b, c) net_ConnectTCP(VLC_OBJECT(a), b, c)
 113
 114 VLC_API int net_AcceptSingle(vlc_object_t *obj, int lfd);
 115
 116 VLC_API int net_Accept( vlc_object_t *, int * );
 117 #define net_Accept(a, b) \
 118         net_Accept(VLC_OBJECT(a), b)
 119
 120 VLC_API int net_ConnectDgram( vlc_object_t *p_this, const char *psz_host, int i_port, int hlim, int proto );
 121 #define net_ConnectDgram(a, b, c, d, e ) \
 122         net_ConnectDgram(VLC_OBJECT(a), b, c, d, e)
 123
 124 static inline int net_ConnectUDP (vlc_object_t *obj, const char *host, int port, int hlim)
 125 {
 126     return net_ConnectDgram (obj, host, port, hlim, IPPROTO_UDP);
 127 }
 128
 129 VLC_API int net_OpenDgram( vlc_object_t *p_this, const char *psz_bind, int i_bind, const char *psz_server, int i_server, int proto );
 130 #define net_OpenDgram( a, b, c, d, e, g ) \
 131         net_OpenDgram(VLC_OBJECT(a), b, c, d, e, g)
 132
 133 static inline int net_ListenUDP1 (vlc_object_t *obj, const char *host, int port)
 134 {
 135     return net_OpenDgram (obj, host, port, NULL, 0, IPPROTO_UDP);
 136 }
 137
 138 VLC_API void net_ListenClose( int *fd );
 139
 140 int net_Subscribe (vlc_object_t *obj, int fd, const struct sockaddr *addr,
 141                    socklen_t addrlen);
 142
 143 VLC_API int net_SetCSCov( int fd, int sendcov, int recvcov );
 144
 145 /* Functions to read from or write to the networking layer */
 146 struct virtual_socket_t
 147 {
 148     void *p_sys;
 149     int (*pf_recv) ( void *, void *, size_t );
 150     int (*pf_send) ( void *, const void *, size_t );
 151 };
 152
 153 VLC_API 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 );
 154 #define net_Read(a,b,c,d,e,f) net_Read(VLC_OBJECT(a),b,c,d,e,f)
 155 VLC_API ssize_t net_Write( vlc_object_t *p_this, int fd, const v_socket_t *, const void *p_data, size_t i_data );
 156 #define net_Write(a,b,c,d,e) net_Write(VLC_OBJECT(a),b,c,d,e)
 157 VLC_API char * net_Gets( vlc_object_t *p_this, int fd, const v_socket_t * );
 158 #define net_Gets(a,b,c) net_Gets(VLC_OBJECT(a),b,c)
 159
 160
 161 VLC_API ssize_t net_Printf( vlc_object_t *p_this, int fd, const v_socket_t *, const char *psz_fmt, ... ) VLC_FORMAT( 4, 5 );
 162 #define net_Printf(o,fd,vs,...) net_Printf(VLC_OBJECT(o),fd,vs, __VA_ARGS__)
 163 VLC_API ssize_t net_vaPrintf( vlc_object_t *p_this, int fd, const v_socket_t *, const char *psz_fmt, va_list args );
 164 #define net_vaPrintf(a,b,c,d,e) net_vaPrintf(VLC_OBJECT(a),b,c,d,e)
 165
 166 VLC_API int vlc_inet_pton(int af, const char *src, void *dst);
 167 VLC_API const char *vlc_inet_ntop(int af, const void *src,
 168                                   char *dst, socklen_t cnt);
 169 struct pollfd;
 170 VLC_API int vlc_poll(struct pollfd *fds, unsigned nfds, int timeout);
 171
 172
 173 #ifdef WIN32
 174 /* Microsoft: same semantic, same value, different name... go figure */
 175 # define SHUT_RD SD_RECEIVE
 176 # define SHUT_WR SD_SEND
 177 # define SHUT_RDWR SD_BOTH
 178 # define net_Close( fd ) closesocket ((SOCKET)fd)
 179 #else
 180 # ifdef __OS2__
 181 #  define SHUT_RD    0
 182 #  define SHUT_WR    1
 183 #  define SHUT_RDWR  2
 184 # endif
 185 #ifdef HAVE_UNISTD_H
 186 #include <unistd.h>
 187 #endif
 188 # define net_Close( fd ) (void)close (fd)
 189 #endif
 190
 191 /* Portable network names/addresses resolution layer */
 192
 193 /* GAI error codes */
 194 # ifndef EAI_BADFLAGS
 195 #  define EAI_BADFLAGS -1
 196 # endif
 197 # ifndef EAI_NONAME
 198 #  define EAI_NONAME -2
 199 # endif
 200 # ifndef EAI_AGAIN
 201 #  define EAI_AGAIN -3
 202 # endif
 203 # ifndef EAI_FAIL
 204 #  define EAI_FAIL -4
 205 # endif
 206 # ifndef EAI_NODATA
 207 #  define EAI_NODATA -5
 208 # endif
 209 # ifndef EAI_FAMILY
 210 #  define EAI_FAMILY -6
 211 # endif
 212 # ifndef EAI_SOCKTYPE
 213 #  define EAI_SOCKTYPE -7
 214 # endif
 215 # ifndef EAI_SERVICE
 216 #  define EAI_SERVICE -8
 217 # endif
 218 # ifndef EAI_ADDRFAMILY
 219 #  define EAI_ADDRFAMILY -9
 220 # endif
 221 # ifndef EAI_MEMORY
 222 #  define EAI_MEMORY -10
 223 # endif
 224 #ifndef EAI_OVERFLOW
 225 #  define EAI_OVERFLOW -11
 226 #endif
 227 # ifndef EAI_SYSTEM
 228 #  define EAI_SYSTEM -12
 229 # endif
 230
 231
 232 # ifndef NI_MAXHOST
 233 #  define NI_MAXHOST 1025
 234 #  define NI_MAXSERV 32
 235 # endif
 236 # define NI_MAXNUMERICHOST 64
 237
 238 #ifndef AI_NUMERICSERV
 239 # define AI_NUMERICSERV 0
 240 #endif
 241
 242 VLC_API int vlc_getnameinfo( const struct sockaddr *, int, char *, int, int *, int );
 243 VLC_API int vlc_getaddrinfo( vlc_object_t *, const char *, int, const struct addrinfo *, struct addrinfo ** );
 244
 245
 246 static inline bool
 247 net_SockAddrIsMulticast (const struct sockaddr *addr, socklen_t len)
 248 {
 249     switch (addr->sa_family)
 250     {
 251 #ifdef IN_MULTICAST
 252         case AF_INET:
 253         {
 254             const struct sockaddr_in *v4 = (const struct sockaddr_in *)addr;
 255             if ((size_t)len < sizeof (*v4))
 256                 return false;
 257             return IN_MULTICAST (ntohl (v4->sin_addr.s_addr)) != 0;
 258         }
 259 #endif
 260
 261 #ifdef IN6_IS_ADDR_MULTICAST
 262         case AF_INET6:
 263         {
 264             const struct sockaddr_in6 *v6 = (const struct sockaddr_in6 *)addr;
 265             if ((size_t)len < sizeof (*v6))
 266                 return false;
 267             return IN6_IS_ADDR_MULTICAST (&v6->sin6_addr) != 0;
 268         }
 269 #endif
 270     }
 271
 272     return false;
 273 }
 274
 275
 276 static inline int net_GetSockAddress( int fd, char *address, int *port )
 277 {
 278     struct sockaddr_storage addr;
 279     socklen_t addrlen = sizeof( addr );
 280
 281     return getsockname( fd, (struct sockaddr *)&addr, &addrlen )
 282         || vlc_getnameinfo( (struct sockaddr *)&addr, addrlen, address,
 283                             NI_MAXNUMERICHOST, port, NI_NUMERICHOST )
 284         ? VLC_EGENERIC : 0;
 285 }
 286
 287 static inline int net_GetPeerAddress( int fd, char *address, int *port )
 288 {
 289     struct sockaddr_storage addr;
 290     socklen_t addrlen = sizeof( addr );
 291
 292     return getpeername( fd, (struct sockaddr *)&addr, &addrlen )
 293         || vlc_getnameinfo( (struct sockaddr *)&addr, addrlen, address,
 294                             NI_MAXNUMERICHOST, port, NI_NUMERICHOST )
 295         ? VLC_EGENERIC : 0;
 296 }
 297
 298 static inline uint16_t net_GetPort (const struct sockaddr *addr)
 299 {
 300     switch (addr->sa_family)
 301     {
 302 #ifdef AF_INET6
 303         case AF_INET6:
 304             return ((const struct sockaddr_in6 *)addr)->sin6_port;
 305 #endif
 306         case AF_INET:
 307             return ((const struct sockaddr_in *)addr)->sin_port;
 308     }
 309     return 0;
 310 }
 311
 312 static inline void net_SetPort (struct sockaddr *addr, uint16_t port)
 313 {
 314     switch (addr->sa_family)
 315     {
 316 #ifdef AF_INET6
 317         case AF_INET6:
 318             ((struct sockaddr_in6 *)addr)->sin6_port = port;
 319         break;
 320 #endif
 321         case AF_INET:
 322             ((struct sockaddr_in *)addr)->sin_port = port;
 323         break;
 324     }
 325 }
 326 # ifdef __cplusplus
 327 }
 328 # endif
 329
 330 #endif