git.sesse.net Git - vlc/blob - 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  * \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 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 #   ifndef IPV6_V6ONLY
  63 #       define IPV6_V6ONLY 27
  64 #   endif
  65 #else
  66 #   include <sys/types.h>
  67 #   include <unistd.h>
  68 #   include <sys/socket.h>
  69 #   include <netinet/in.h>
  70 #   include <netdb.h>
  71 #   define net_errno errno
  72 #endif
  73
  74 #if defined( __SYMBIAN32__ )
  75 #   undef AF_INET6
  76 #   undef IN6_IS_ADDR_MULTICAST
  77 #   undef IPV6_V6ONLY
  78 #   undef IPV6_MULTICAST_HOPS
  79 #   undef IPV6_MULTICAST_IF
  80 #   undef IPV6_TCLASS
  81 #   undef IPV6_JOIN_GROUP
  82 #endif
  83
  84 VLC_API int vlc_socket (int, int, int, bool nonblock) VLC_USED;
  85
  86 struct sockaddr;
  87 VLC_API int vlc_accept( int, struct sockaddr *, socklen_t *, bool ) VLC_USED;
  88
  89 # ifdef __cplusplus
  90 extern "C" {
  91 # endif
  92
  93 /* Portable networking layer communication */
  94 int net_Socket (vlc_object_t *obj, int family, int socktype, int proto);
  95
  96 VLC_API int net_Connect(vlc_object_t *p_this, const char *psz_host, int i_port, int socktype, int protocol);
  97 #define net_Connect(a, b, c, d, e) net_Connect(VLC_OBJECT(a), b, c, d, e)
  98
  99 VLC_API int * net_Listen(vlc_object_t *p_this, const char *psz_host, int i_port, int socktype, int protocol);
 100
 101 #define net_ListenTCP(a, b, c) net_Listen(VLC_OBJECT(a), b, c, \
 102                                           SOCK_STREAM, IPPROTO_TCP)
 103
 104 static inline int net_ConnectTCP (vlc_object_t *obj, const char *host, int port)
 105 {
 106     return net_Connect (obj, host, port, SOCK_STREAM, IPPROTO_TCP);
 107 }
 108 #define net_ConnectTCP(a, b, c) net_ConnectTCP(VLC_OBJECT(a), b, c)
 109
 110 VLC_API int net_AcceptSingle(vlc_object_t *obj, int lfd);
 111
 112 VLC_API int net_Accept( vlc_object_t *, int * );
 113 #define net_Accept(a, b) \
 114         net_Accept(VLC_OBJECT(a), b)
 115
 116 VLC_API int net_ConnectDgram( vlc_object_t *p_this, const char *psz_host, int i_port, int hlim, int proto );
 117 #define net_ConnectDgram(a, b, c, d, e ) \
 118         net_ConnectDgram(VLC_OBJECT(a), b, c, d, e)
 119
 120 static inline int net_ConnectUDP (vlc_object_t *obj, const char *host, int port, int hlim)
 121 {
 122     return net_ConnectDgram (obj, host, port, hlim, IPPROTO_UDP);
 123 }
 124
 125 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 );
 126 #define net_OpenDgram( a, b, c, d, e, g ) \
 127         net_OpenDgram(VLC_OBJECT(a), b, c, d, e, g)
 128
 129 static inline int net_ListenUDP1 (vlc_object_t *obj, const char *host, int port)
 130 {
 131     return net_OpenDgram (obj, host, port, NULL, 0, IPPROTO_UDP);
 132 }
 133
 134 VLC_API void net_ListenClose( int *fd );
 135
 136 int net_Subscribe (vlc_object_t *obj, int fd, const struct sockaddr *addr,
 137                    socklen_t addrlen);
 138
 139 VLC_API int net_SetCSCov( int fd, int sendcov, int recvcov );
 140
 141 /* Functions to read from or write to the networking layer */
 142 struct virtual_socket_t
 143 {
 144     void *p_sys;
 145     int (*pf_recv) ( void *, void *, size_t );
 146     int (*pf_send) ( void *, const void *, size_t );
 147 };
 148
 149 VLC_API 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 );
 150 #define net_Read(a,b,c,d,e,f) net_Read(VLC_OBJECT(a),b,c,d,e,f)
 151 VLC_API ssize_t net_Write( vlc_object_t *p_this, int fd, const v_socket_t *, const void *p_data, size_t i_data );
 152 #define net_Write(a,b,c,d,e) net_Write(VLC_OBJECT(a),b,c,d,e)
 153 VLC_API char * net_Gets( vlc_object_t *p_this, int fd, const v_socket_t * );
 154 #define net_Gets(a,b,c) net_Gets(VLC_OBJECT(a),b,c)
 155
 156
 157 VLC_API ssize_t net_Printf( vlc_object_t *p_this, int fd, const v_socket_t *, const char *psz_fmt, ... ) VLC_FORMAT( 4, 5 );
 158 #define net_Printf(o,fd,vs,...) net_Printf(VLC_OBJECT(o),fd,vs, __VA_ARGS__)
 159 VLC_API ssize_t net_vaPrintf( vlc_object_t *p_this, int fd, const v_socket_t *, const char *psz_fmt, va_list args );
 160 #define net_vaPrintf(a,b,c,d,e) net_vaPrintf(VLC_OBJECT(a),b,c,d,e)
 161
 162 #ifdef WIN32
 163 /* Microsoft: same semantic, same value, different name... go figure */
 164 # define SHUT_RD SD_RECEIVE
 165 # define SHUT_WR SD_SEND
 166 # define SHUT_RDWR SD_BOTH
 167 # define net_Close( fd ) closesocket ((SOCKET)fd)
 168 #else
 169 # ifdef __OS2__
 170 #  define SHUT_RD    0
 171 #  define SHUT_WR    1
 172 #  define SHUT_RDWR  2
 173 # endif
 174 # define net_Close( fd ) (void)close (fd)
 175 #endif
 176
 177 /* Portable network names/addresses resolution layer */
 178
 179 /* GAI error codes */
 180 # ifndef EAI_BADFLAGS
 181 #  define EAI_BADFLAGS -1
 182 # endif
 183 # ifndef EAI_NONAME
 184 #  define EAI_NONAME -2
 185 # endif
 186 # ifndef EAI_AGAIN
 187 #  define EAI_AGAIN -3
 188 # endif
 189 # ifndef EAI_FAIL
 190 #  define EAI_FAIL -4
 191 # endif
 192 # ifndef EAI_NODATA
 193 #  define EAI_NODATA -5
 194 # endif
 195 # ifndef EAI_FAMILY
 196 #  define EAI_FAMILY -6
 197 # endif
 198 # ifndef EAI_SOCKTYPE
 199 #  define EAI_SOCKTYPE -7
 200 # endif
 201 # ifndef EAI_SERVICE
 202 #  define EAI_SERVICE -8
 203 # endif
 204 # ifndef EAI_ADDRFAMILY
 205 #  define EAI_ADDRFAMILY -9
 206 # endif
 207 # ifndef EAI_MEMORY
 208 #  define EAI_MEMORY -10
 209 # endif
 210 #ifndef EAI_OVERFLOW
 211 #  define EAI_OVERFLOW -11
 212 #endif
 213 # ifndef EAI_SYSTEM
 214 #  define EAI_SYSTEM -12
 215 # endif
 216
 217
 218 # ifndef NI_MAXHOST
 219 #  define NI_MAXHOST 1025
 220 #  define NI_MAXSERV 32
 221 # endif
 222 # define NI_MAXNUMERICHOST 64
 223
 224 #ifndef AI_NUMERICSERV
 225 # define AI_NUMERICSERV 0
 226 #endif
 227 #ifndef AI_IDN
 228 # define AI_IDN 0 /* GNU/libc extension */
 229 #endif
 230
 231 #ifdef __OS2__
 232 # ifndef NI_NUMERICHOST
 233 #  define NI_NUMERICHOST 0x01
 234 #  define NI_NUMERICSERV 0x02
 235 #  define NI_NOFQDN      0x04
 236 #  define NI_NAMEREQD    0x08
 237 #  define NI_DGRAM       0x10
 238 # endif
 239
 240 struct addrinfo
 241 {
 242     int ai_flags;
 243     int ai_family;
 244     int ai_socktype;
 245     int ai_protocol;
 246     size_t ai_addrlen;
 247     struct sockaddr *ai_addr;
 248     char *ai_canonname;
 249     struct addrinfo *ai_next;
 250 };
 251
 252 # define AI_PASSIVE     1
 253 # define AI_CANONNAME   2
 254 # define AI_NUMERICHOST 4
 255
 256 VLC_API const char *gai_strerror( int errnum );
 257
 258 VLC_API int  getaddrinfo ( const char *, const char *,
 259                            const struct addrinfo *, struct addrinfo ** );
 260 VLC_API void freeaddrinfo( struct addrinfo * );
 261 VLC_API int  getnameinfo ( const struct sockaddr *, socklen_t,
 262                            char *, int, char *, int, int );
 263 #endif
 264
 265 VLC_API int vlc_getnameinfo( const struct sockaddr *, int, char *, int, int *, int );
 266 VLC_API int vlc_getaddrinfo (const char *, unsigned,
 267                              const struct addrinfo *, struct addrinfo **);
 268
 269
 270 #ifdef __OS2__
 271 /* OS/2 does not support IPv6, yet. But declare these only for compilation */
 272 struct in6_addr
 273 {
 274     uint8_t s6_addr[16];
 275 };
 276
 277 struct sockaddr_in6
 278 {
 279     uint8_t         sin6_len;
 280     uint8_t         sin6_family;
 281     uint16_t        sin6_port;
 282     uint32_t        sin6_flowinfo;
 283     struct in6_addr sin6_addr;
 284     uint32_t        sin6_scope_id;
 285 };
 286
 287 # define IN6_IS_ADDR_MULTICAST(a)   (((__const uint8_t *) (a))[0] == 0xff)
 288
 289 static const struct in6_addr in6addr_any =
 290     { { 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 } };
 291 #endif
 292
 293 static inline bool
 294 net_SockAddrIsMulticast (const struct sockaddr *addr, socklen_t len)
 295 {
 296     switch (addr->sa_family)
 297     {
 298 #ifdef IN_MULTICAST
 299         case AF_INET:
 300         {
 301             const struct sockaddr_in *v4 = (const struct sockaddr_in *)addr;
 302             if ((size_t)len < sizeof (*v4))
 303                 return false;
 304             return IN_MULTICAST (ntohl (v4->sin_addr.s_addr)) != 0;
 305         }
 306 #endif
 307
 308 #ifdef IN6_IS_ADDR_MULTICAST
 309         case AF_INET6:
 310         {
 311             const struct sockaddr_in6 *v6 = (const struct sockaddr_in6 *)addr;
 312             if ((size_t)len < sizeof (*v6))
 313                 return false;
 314             return IN6_IS_ADDR_MULTICAST (&v6->sin6_addr) != 0;
 315         }
 316 #endif
 317     }
 318
 319     return false;
 320 }
 321
 322
 323 static inline int net_GetSockAddress( int fd, char *address, int *port )
 324 {
 325     struct sockaddr_storage addr;
 326     socklen_t addrlen = sizeof( addr );
 327
 328     return getsockname( fd, (struct sockaddr *)&addr, &addrlen )
 329         || vlc_getnameinfo( (struct sockaddr *)&addr, addrlen, address,
 330                             NI_MAXNUMERICHOST, port, NI_NUMERICHOST )
 331         ? VLC_EGENERIC : 0;
 332 }
 333
 334 static inline int net_GetPeerAddress( int fd, char *address, int *port )
 335 {
 336     struct sockaddr_storage addr;
 337     socklen_t addrlen = sizeof( addr );
 338
 339     return getpeername( fd, (struct sockaddr *)&addr, &addrlen )
 340         || vlc_getnameinfo( (struct sockaddr *)&addr, addrlen, address,
 341                             NI_MAXNUMERICHOST, port, NI_NUMERICHOST )
 342         ? VLC_EGENERIC : 0;
 343 }
 344
 345 static inline uint16_t net_GetPort (const struct sockaddr *addr)
 346 {
 347     switch (addr->sa_family)
 348     {
 349 #ifdef AF_INET6
 350         case AF_INET6:
 351             return ((const struct sockaddr_in6 *)addr)->sin6_port;
 352 #endif
 353         case AF_INET:
 354             return ((const struct sockaddr_in *)addr)->sin_port;
 355     }
 356     return 0;
 357 }
 358
 359 static inline void net_SetPort (struct sockaddr *addr, uint16_t port)
 360 {
 361     switch (addr->sa_family)
 362     {
 363 #ifdef AF_INET6
 364         case AF_INET6:
 365             ((struct sockaddr_in6 *)addr)->sin6_port = port;
 366         break;
 367 #endif
 368         case AF_INET:
 369             ((struct sockaddr_in *)addr)->sin_port = port;
 370         break;
 371     }
 372 }
 373 # ifdef __cplusplus
 374 }
 375 # endif
 376
 377 #endif