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