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