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