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) LIBVLC_USED;
  89
  90 struct sockaddr;
  91 VLC_EXPORT( int, vlc_accept, ( int, struct sockaddr *, socklen_t *, bool ) LIBVLC_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_EXPORT( 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_EXPORT( 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_EXPORT( int, net_AcceptSingle, (vlc_object_t *obj, int lfd) );
 115
 116 VLC_EXPORT( int, net_Accept, ( vlc_object_t *, int * ) );
 117 #define net_Accept(a, b) \
 118         net_Accept(VLC_OBJECT(a), b)
 119
 120 VLC_EXPORT( 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_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 ) );
 130 #define net_OpenDgram( a, b, c, d, e, g, h ) \
 131         net_OpenDgram(VLC_OBJECT(a), b, c, d, e, g, h)
 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, 0, IPPROTO_UDP);
 136 }
 137
 138 VLC_EXPORT( 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_EXPORT( 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 *, int );
 150     int (*pf_send) ( void *, const void *, int );
 151 };
 152
 153 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 ) );
 154 #define net_Read(a,b,c,d,e,f) net_Read(VLC_OBJECT(a),b,c,d,e,f)
 155 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 ) );
 156 #define net_Write(a,b,c,d,e) net_Write(VLC_OBJECT(a),b,c,d,e)
 157 VLC_EXPORT( 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_EXPORT( ssize_t, net_Printf, ( vlc_object_t *p_this, int fd, const v_socket_t *, const char *psz_fmt, ... ) LIBVLC_FORMAT( 4, 5 ) );
 162 #define net_Printf(o,fd,vs,...) net_Printf(VLC_OBJECT(o),fd,vs, __VA_ARGS__)
 163 VLC_EXPORT( 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_EXPORT (int, vlc_inet_pton, (int af, const char *src, void *dst) );
 167 VLC_EXPORT (const char *, vlc_inet_ntop, (int af, const void *src,
 168                                           char *dst, socklen_t cnt) );
 169 struct pollfd;
 170 VLC_EXPORT (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 HAVE_UNISTD_H
 181 #include <unistd.h>
 182 #endif
 183 # define net_Close( fd ) (void)close (fd)
 184 #endif
 185
 186 /* Portable network names/addresses resolution layer */
 187
 188 /* GAI error codes */
 189 # ifndef EAI_BADFLAGS
 190 #  define EAI_BADFLAGS -1
 191 # endif
 192 # ifndef EAI_NONAME
 193 #  define EAI_NONAME -2
 194 # endif
 195 # ifndef EAI_AGAIN
 196 #  define EAI_AGAIN -3
 197 # endif
 198 # ifndef EAI_FAIL
 199 #  define EAI_FAIL -4
 200 # endif
 201 # ifndef EAI_NODATA
 202 #  define EAI_NODATA -5
 203 # endif
 204 # ifndef EAI_FAMILY
 205 #  define EAI_FAMILY -6
 206 # endif
 207 # ifndef EAI_SOCKTYPE
 208 #  define EAI_SOCKTYPE -7
 209 # endif
 210 # ifndef EAI_SERVICE
 211 #  define EAI_SERVICE -8
 212 # endif
 213 # ifndef EAI_ADDRFAMILY
 214 #  define EAI_ADDRFAMILY -9
 215 # endif
 216 # ifndef EAI_MEMORY
 217 #  define EAI_MEMORY -10
 218 # endif
 219 #ifndef EAI_OVERFLOW
 220 #  define EAI_OVERFLOW -11
 221 #endif
 222 # ifndef EAI_SYSTEM
 223 #  define EAI_SYSTEM -12
 224 # endif
 225
 226
 227 # ifndef NI_MAXHOST
 228 #  define NI_MAXHOST 1025
 229 #  define NI_MAXSERV 32
 230 # endif
 231 # define NI_MAXNUMERICHOST 64
 232
 233 #ifndef AI_NUMERICSERV
 234 # define AI_NUMERICSERV 0
 235 #endif
 236
 237 VLC_EXPORT( int, vlc_getnameinfo, ( const struct sockaddr *, int, char *, int, int *, int ) );
 238 VLC_EXPORT( int, vlc_getaddrinfo, ( vlc_object_t *, const char *, int, const struct addrinfo *, struct addrinfo ** ) );
 239
 240
 241 static inline bool
 242 net_SockAddrIsMulticast (const struct sockaddr *addr, socklen_t len)
 243 {
 244     switch (addr->sa_family)
 245     {
 246 #ifdef IN_MULTICAST
 247         case AF_INET:
 248         {
 249             const struct sockaddr_in *v4 = (const struct sockaddr_in *)addr;
 250             if ((size_t)len < sizeof (*v4))
 251                 return false;
 252             return IN_MULTICAST (ntohl (v4->sin_addr.s_addr)) != 0;
 253         }
 254 #endif
 255
 256 #ifdef IN6_IS_ADDR_MULTICAST
 257         case AF_INET6:
 258         {
 259             const struct sockaddr_in6 *v6 = (const struct sockaddr_in6 *)addr;
 260             if ((size_t)len < sizeof (*v6))
 261                 return false;
 262             return IN6_IS_ADDR_MULTICAST (&v6->sin6_addr) != 0;
 263         }
 264 #endif
 265     }
 266
 267     return false;
 268 }
 269
 270
 271 static inline int net_GetSockAddress( int fd, char *address, int *port )
 272 {
 273     struct sockaddr_storage addr;
 274     socklen_t addrlen = sizeof( addr );
 275
 276     return getsockname( fd, (struct sockaddr *)&addr, &addrlen )
 277         || vlc_getnameinfo( (struct sockaddr *)&addr, addrlen, address,
 278                             NI_MAXNUMERICHOST, port, NI_NUMERICHOST )
 279         ? VLC_EGENERIC : 0;
 280 }
 281
 282 static inline int net_GetPeerAddress( int fd, char *address, int *port )
 283 {
 284     struct sockaddr_storage addr;
 285     socklen_t addrlen = sizeof( addr );
 286
 287     return getpeername( fd, (struct sockaddr *)&addr, &addrlen )
 288         || vlc_getnameinfo( (struct sockaddr *)&addr, addrlen, address,
 289                             NI_MAXNUMERICHOST, port, NI_NUMERICHOST )
 290         ? VLC_EGENERIC : 0;
 291 }
 292
 293 static inline uint16_t net_GetPort (const struct sockaddr *addr)
 294 {
 295     switch (addr->sa_family)
 296     {
 297 #ifdef AF_INET6
 298         case AF_INET6:
 299             return ((const struct sockaddr_in6 *)addr)->sin6_port;
 300 #endif
 301         case AF_INET:
 302             return ((const struct sockaddr_in *)addr)->sin_port;
 303     }
 304     return 0;
 305 }
 306
 307 static inline void net_SetPort (struct sockaddr *addr, uint16_t port)
 308 {
 309     switch (addr->sa_family)
 310     {
 311 #ifdef AF_INET6
 312         case AF_INET6:
 313             ((struct sockaddr_in6 *)addr)->sin6_port = port;
 314         break;
 315 #endif
 316         case AF_INET:
 317             ((struct sockaddr_in *)addr)->sin_port = port;
 318         break;
 319     }
 320 }
 321 # ifdef __cplusplus
 322 }
 323 # endif
 324
 325 #endif