include/vlc_network.h

   1 /*****************************************************************************
   2  * vlc_network.h: interface to communicate with network plug-ins
   3  *****************************************************************************
   4  * Copyright (C) 2002-2005 VLC authors and VideoLAN
   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 it
  13  * under the terms of the GNU Lesser General Public License as published by
  14  * the Free Software Foundation; either version 2.1 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 Lesser General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU Lesser General Public License
  23  * along with this program; if not, write to the Free Software Foundation,
  24  * 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  * \ingroup file
  32  * \defgroup sockets Internet sockets
  33  * @{
  34  * \file
  35  * Definitions for sockets and low-level networking
  36  */
  37
  38 #if defined( _WIN32 )
  39 #   define _NO_OLDNAMES 1
  40 #   include <io.h>
  41 #   include <winsock2.h>
  42 #   include <ws2tcpip.h>
  43 #   define net_errno (WSAGetLastError())
  44 #   ifndef IPV6_V6ONLY
  45 #       define IPV6_V6ONLY 27
  46 #   endif
  47 #else
  48 #   include <sys/types.h>
  49 #   include <unistd.h>
  50 #   include <sys/socket.h>
  51 #   include <netinet/in.h>
  52 #   include <netdb.h>
  53 #   define net_errno errno
  54 #endif
  55
  56 #ifndef MSG_NOSIGNAL
  57 # define MSG_NOSIGNAL 0
  58 #endif
  59
  60 VLC_API int vlc_socket (int, int, int, bool nonblock) VLC_USED;
  61 VLC_API int vlc_socketpair (int, int, int, int [2], bool nonblock);
  62
  63 struct sockaddr;
  64 VLC_API int vlc_accept( int, struct sockaddr *, socklen_t *, bool ) VLC_USED;
  65
  66 # ifdef __cplusplus
  67 extern "C" {
  68 # endif
  69
  70 /* Portable networking layer communication */
  71 int net_Socket (vlc_object_t *obj, int family, int socktype, int proto);
  72
  73 VLC_API int net_Connect(vlc_object_t *p_this, const char *psz_host, int i_port, int socktype, int protocol);
  74 #define net_Connect(a, b, c, d, e) net_Connect(VLC_OBJECT(a), b, c, d, e)
  75
  76 VLC_API int * net_Listen(vlc_object_t *p_this, const char *psz_host, int i_port, int socktype, int protocol);
  77
  78 #define net_ListenTCP(a, b, c) net_Listen(VLC_OBJECT(a), b, c, \
  79                                           SOCK_STREAM, IPPROTO_TCP)
  80
  81 static inline int net_ConnectTCP (vlc_object_t *obj, const char *host, int port)
  82 {
  83     return net_Connect (obj, host, port, SOCK_STREAM, IPPROTO_TCP);
  84 }
  85 #define net_ConnectTCP(a, b, c) net_ConnectTCP(VLC_OBJECT(a), b, c)
  86
  87 VLC_API int net_AcceptSingle(vlc_object_t *obj, int lfd);
  88
  89 VLC_API int net_Accept( vlc_object_t *, int * );
  90 #define net_Accept(a, b) \
  91         net_Accept(VLC_OBJECT(a), b)
  92
  93 VLC_API int net_ConnectDgram( vlc_object_t *p_this, const char *psz_host, int i_port, int hlim, int proto );
  94 #define net_ConnectDgram(a, b, c, d, e ) \
  95         net_ConnectDgram(VLC_OBJECT(a), b, c, d, e)
  96
  97 static inline int net_ConnectUDP (vlc_object_t *obj, const char *host, int port, int hlim)
  98 {
  99     return net_ConnectDgram (obj, host, port, hlim, IPPROTO_UDP);
 100 }
 101
 102 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 );
 103 #define net_OpenDgram( a, b, c, d, e, g ) \
 104         net_OpenDgram(VLC_OBJECT(a), b, c, d, e, g)
 105
 106 static inline int net_ListenUDP1 (vlc_object_t *obj, const char *host, int port)
 107 {
 108     return net_OpenDgram (obj, host, port, NULL, 0, IPPROTO_UDP);
 109 }
 110
 111 VLC_API void net_ListenClose( int *fd );
 112
 113 int net_Subscribe (vlc_object_t *obj, int fd, const struct sockaddr *addr,
 114                    socklen_t addrlen);
 115
 116 VLC_API int net_SetCSCov( int fd, int sendcov, int recvcov );
 117
 118 VLC_API ssize_t net_Read( vlc_object_t *p_this, int fd, void *p_data, size_t i_data );
 119 #define net_Read(a,b,c,d) net_Read(VLC_OBJECT(a),b,c,d)
 120 VLC_API ssize_t net_Write( vlc_object_t *p_this, int fd, const void *p_data, size_t i_data );
 121 #define net_Write(a,b,c,d) net_Write(VLC_OBJECT(a),b,c,d)
 122 VLC_API char * net_Gets( vlc_object_t *p_this, int fd );
 123 #define net_Gets(a,b) net_Gets(VLC_OBJECT(a),b)
 124
 125
 126 VLC_API ssize_t net_Printf( vlc_object_t *p_this, int fd, const char *psz_fmt, ... ) VLC_FORMAT( 3, 4 );
 127 #define net_Printf(o,fd,...) net_Printf(VLC_OBJECT(o),fd, __VA_ARGS__)
 128 VLC_API ssize_t net_vaPrintf( vlc_object_t *p_this, int fd, const char *psz_fmt, va_list args );
 129 #define net_vaPrintf(a,b,c,d) net_vaPrintf(VLC_OBJECT(a),b,c,d)
 130
 131 #ifdef _WIN32
 132 /* Microsoft: same semantic, same value, different name... go figure */
 133 # define SHUT_RD SD_RECEIVE
 134 # define SHUT_WR SD_SEND
 135 # define SHUT_RDWR SD_BOTH
 136 # define net_Close( fd ) closesocket ((SOCKET)fd)
 137 #else
 138 # ifdef __OS2__
 139 #  define SHUT_RD    0
 140 #  define SHUT_WR    1
 141 #  define SHUT_RDWR  2
 142 # endif
 143
 144 VLC_API int vlc_close(int);
 145 # define net_Close( fd ) (void)vlc_close (fd)
 146 #endif
 147
 148 /* Portable network names/addresses resolution layer */
 149
 150 /* GAI error codes */
 151 # ifndef EAI_BADFLAGS
 152 #  define EAI_BADFLAGS -1
 153 # endif
 154 # ifndef EAI_NONAME
 155 #  define EAI_NONAME -2
 156 # endif
 157 # ifndef EAI_AGAIN
 158 #  define EAI_AGAIN -3
 159 # endif
 160 # ifndef EAI_FAIL
 161 #  define EAI_FAIL -4
 162 # endif
 163 # ifndef EAI_NODATA
 164 #  define EAI_NODATA -5
 165 # endif
 166 # ifndef EAI_FAMILY
 167 #  define EAI_FAMILY -6
 168 # endif
 169 # ifndef EAI_SOCKTYPE
 170 #  define EAI_SOCKTYPE -7
 171 # endif
 172 # ifndef EAI_SERVICE
 173 #  define EAI_SERVICE -8
 174 # endif
 175 # ifndef EAI_ADDRFAMILY
 176 #  define EAI_ADDRFAMILY -9
 177 # endif
 178 # ifndef EAI_MEMORY
 179 #  define EAI_MEMORY -10
 180 # endif
 181 #ifndef EAI_OVERFLOW
 182 #  define EAI_OVERFLOW -11
 183 #endif
 184 # ifndef EAI_SYSTEM
 185 #  define EAI_SYSTEM -12
 186 # endif
 187
 188
 189 # ifndef NI_MAXHOST
 190 #  define NI_MAXHOST 1025
 191 #  define NI_MAXSERV 32
 192 # endif
 193 # define NI_MAXNUMERICHOST 64
 194
 195 #ifndef AI_NUMERICSERV
 196 # define AI_NUMERICSERV 0
 197 #endif
 198 #ifndef AI_IDN
 199 # define AI_IDN 0 /* GNU/libc extension */
 200 #endif
 201
 202 #ifdef _WIN32
 203 # if !defined(WINAPI_FAMILY) || WINAPI_FAMILY != WINAPI_FAMILY_APP
 204 #  undef gai_strerror
 205 #  define gai_strerror gai_strerrorA
 206 # endif
 207 #endif
 208
 209 #ifdef __OS2__
 210 # ifndef NI_NUMERICHOST
 211 #  define NI_NUMERICHOST 0x01
 212 #  define NI_NUMERICSERV 0x02
 213 #  define NI_NOFQDN      0x04
 214 #  define NI_NAMEREQD    0x08
 215 #  define NI_DGRAM       0x10
 216 # endif
 217
 218 # define AI_PASSIVE     1
 219 # define AI_CANONNAME   2
 220 # define AI_NUMERICHOST 4
 221
 222 VLC_API const char *gai_strerror( int errnum );
 223
 224 VLC_API int  getaddrinfo ( const char *, const char *,
 225                            const struct addrinfo *, struct addrinfo ** );
 226 VLC_API void freeaddrinfo( struct addrinfo * );
 227 VLC_API int  getnameinfo ( const struct sockaddr *, socklen_t,
 228                            char *, int, char *, int, int );
 229 #endif
 230
 231 VLC_API int vlc_getnameinfo( const struct sockaddr *, int, char *, int, int *, int );
 232 VLC_API int vlc_getaddrinfo (const char *, unsigned,
 233                              const struct addrinfo *, struct addrinfo **);
 234 int vlc_getaddrinfo_i11e(const char *, unsigned, const struct addrinfo *,
 235                          struct addrinfo **);
 236
 237 #ifdef __OS2__
 238 /* OS/2 does not support IPv6, yet. But declare these only for compilation */
 239 struct in6_addr
 240 {
 241     uint8_t s6_addr[16];
 242 };
 243
 244 struct sockaddr_in6
 245 {
 246     uint8_t         sin6_len;
 247     uint8_t         sin6_family;
 248     uint16_t        sin6_port;
 249     uint32_t        sin6_flowinfo;
 250     struct in6_addr sin6_addr;
 251     uint32_t        sin6_scope_id;
 252 };
 253
 254 # define IN6_IS_ADDR_MULTICAST(a)   (((__const uint8_t *) (a))[0] == 0xff)
 255
 256 static const struct in6_addr in6addr_any =
 257     { { 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 } };
 258 #endif
 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
 341 VLC_API char *vlc_getProxyUrl(const char *);
 342
 343 # ifdef __cplusplus
 344 }
 345 # endif
 346
 347 /** @} */
 348
 349 #endif