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 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 #   ifndef IPV6_V6ONLY
  45 #       define IPV6_V6ONLY 27
  46 #   endif
  47 #else
  48 #   if HAVE_SYS_SOCKET_H
  49 #      include <sys/socket.h>
  50 #   endif
  51 #   if HAVE_NETINET_IN_H
  52 #      include <netinet/in.h>
  53 #   endif
  54 #   if HAVE_ARPA_INET_H
  55 #      include <arpa/inet.h>
  56 #   elif defined( SYS_BEOS )
  57 #      include <net/netdb.h>
  58 #   endif
  59 #   include <netdb.h>
  60 #   define net_errno errno
  61 #endif
  62
  63 # ifdef __cplusplus
  64 extern "C" {
  65 # endif
  66
  67 /* Portable networking layer communication */
  68 int net_Socket (vlc_object_t *obj, int family, int socktype, int proto);
  69 int net_SetupSocket (int fd);
  70
  71 #define net_Connect(a, b, c, d, e) __net_Connect(VLC_OBJECT(a), b, c, d, e)
  72 VLC_EXPORT( int, __net_Connect, (vlc_object_t *p_this, const char *psz_host, int i_port, int socktype, int protocol) );
  73
  74 VLC_EXPORT( int *, net_Listen, (vlc_object_t *p_this, const char *psz_host, int i_port, int protocol) );
  75
  76 #define net_ListenTCP(a, b, c) net_Listen(VLC_OBJECT(a), b, c, IPPROTO_TCP)
  77 #define net_ConnectTCP(a, b, c) __net_ConnectTCP(VLC_OBJECT(a), b, c)
  78
  79 static inline int __net_ConnectTCP (vlc_object_t *obj, const char *host, int port)
  80 {
  81     return __net_Connect (obj, host, port, SOCK_STREAM, IPPROTO_TCP);
  82 }
  83
  84
  85 VLC_EXPORT( int, net_AcceptSingle, (vlc_object_t *obj, int lfd) );
  86
  87 #define net_Accept(a, b, c) __net_Accept(VLC_OBJECT(a), b, c)
  88 VLC_EXPORT( int, __net_Accept, ( vlc_object_t *, int *, mtime_t ) );
  89
  90 #define net_ConnectDgram(a, b, c, d, e ) __net_ConnectDgram(VLC_OBJECT(a), b, c, d, e)
  91 VLC_EXPORT( int, __net_ConnectDgram, ( vlc_object_t *p_this, const char *psz_host, int i_port, int hlim, int proto ) );
  92
  93 static inline int net_ConnectUDP (vlc_object_t *obj, const char *host, int port, int hlim)
  94 {
  95     return net_ConnectDgram (obj, host, port, hlim, IPPROTO_UDP);
  96 }
  97
  98 #define net_OpenDgram( a, b, c, d, e, g, h ) __net_OpenDgram(VLC_OBJECT(a), b, c, d, e, g, h)
  99 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 ) );
 100
 101 static inline int net_ListenUDP1 (vlc_object_t *obj, const char *host, int port)
 102 {
 103     return net_OpenDgram (obj, host, port, NULL, 0, 0, IPPROTO_UDP);
 104 }
 105
 106 VLC_EXPORT( void, net_ListenClose, ( int *fd ) );
 107
 108 int net_Subscribe (vlc_object_t *obj, int fd, const struct sockaddr *addr,
 109                    socklen_t addrlen);
 110
 111 VLC_EXPORT( int, net_SetCSCov, ( int fd, int sendcov, int recvcov ) );
 112
 113 /* Functions to read from or write to the networking layer */
 114 struct virtual_socket_t
 115 {
 116     void *p_sys;
 117     int (*pf_recv) ( void *, void *, int );
 118     int (*pf_send) ( void *, const void *, int );
 119 };
 120
 121 #define net_Read(a,b,c,d,e,f) __net_Read(VLC_OBJECT(a),b,c,d,e,f)
 122 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, vlc_bool_t b_retry ) );
 123
 124 #define net_Write(a,b,c,d,e) __net_Write(VLC_OBJECT(a),b,c,d,e)
 125 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 ) );
 126
 127 #define net_Gets(a,b,c) __net_Gets(VLC_OBJECT(a),b,c)
 128 VLC_EXPORT( char *, __net_Gets, ( vlc_object_t *p_this, int fd, const v_socket_t * ) );
 129
 130 VLC_EXPORT( ssize_t, net_Printf, ( vlc_object_t *p_this, int fd, const v_socket_t *, const char *psz_fmt, ... ) ATTRIBUTE_FORMAT( 4, 5 ) );
 131
 132 #define net_vaPrintf(a,b,c,d,e) __net_vaPrintf(VLC_OBJECT(a),b,c,d,e)
 133 VLC_EXPORT( ssize_t, __net_vaPrintf, ( vlc_object_t *p_this, int fd, const v_socket_t *, const char *psz_fmt, va_list args ) );
 134
 135
 136 #ifndef HAVE_INET_PTON
 137 /* only in core, so no need for C++ extern "C" */
 138     VLC_EXPORT (int, inet_pton, (int af, const char *src, void *dst) );
 139 #endif
 140
 141 #ifndef HAVE_INET_NTOP
 142 #ifdef WIN32
 143 /* only in core, so no need for C++ extern "C" */
 144     VLC_EXPORT (const char *, inet_ntop, (int af, const void *src,
 145                                           char *dst, socklen_t cnt) );
 146 #endif
 147 #endif
 148
 149 #ifndef HAVE_POLL
 150 enum
 151 {
 152     POLLIN=1,
 153     POLLOUT=2,
 154     POLLPRI=4,
 155     POLLERR=8,  // unsupported stub
 156     POLLHUP=16, // unsupported stub
 157     POLLNVAL=32 // unsupported stub
 158 };
 159
 160 struct pollfd
 161 {
 162     int fd;
 163     int events;
 164     int revents;
 165 };
 166
 167   VLC_EXPORT (int, poll, (struct pollfd *fds, unsigned nfds, int timeout));
 168 #endif
 169
 170 #ifdef WIN32
 171 /* Microsoft: same semantic, same value, different name... go figure */
 172 # define SHUT_RD SD_RECEIVE
 173 # define SHUT_WR SD_SEND
 174 # define SHUT_RDWR SD_BOTH
 175 # define net_Close( fd ) closesocket ((SOCKET)fd)
 176 #else
 177 #ifdef HAVE_UNISTD_H
 178 #include <unistd.h>
 179 #endif
 180 # define net_Close( fd ) (void)close (fd)
 181 #endif
 182
 183 /* Portable network names/addresses resolution layer */
 184
 185 /* GAI error codes */
 186 # ifndef EAI_BADFLAGS
 187 #  define EAI_BADFLAGS -1
 188 # endif
 189 # ifndef EAI_NONAME
 190 #  define EAI_NONAME -2
 191 # endif
 192 # ifndef EAI_AGAIN
 193 #  define EAI_AGAIN -3
 194 # endif
 195 # ifndef EAI_FAIL
 196 #  define EAI_FAIL -4
 197 # endif
 198 # ifndef EAI_NODATA
 199 #  define EAI_NODATA -5
 200 # endif
 201 # ifndef EAI_FAMILY
 202 #  define EAI_FAMILY -6
 203 # endif
 204 # ifndef EAI_SOCKTYPE
 205 #  define EAI_SOCKTYPE -7
 206 # endif
 207 # ifndef EAI_SERVICE
 208 #  define EAI_SERVICE -8
 209 # endif
 210 # ifndef EAI_ADDRFAMILY
 211 #  define EAI_ADDRFAMILY -9
 212 # endif
 213 # ifndef EAI_MEMORY
 214 #  define EAI_MEMORY -10
 215 # endif
 216 #ifndef EAI_OVERFLOW
 217 #  define EAI_OVERFLOW -11
 218 #endif
 219 # ifndef EAI_SYSTEM
 220 #  define EAI_SYSTEM -12
 221 # endif
 222
 223
 224 # ifndef NI_MAXHOST
 225 #  define NI_MAXHOST 1025
 226 #  define NI_MAXSERV 32
 227 # endif
 228 # define NI_MAXNUMERICHOST 64
 229
 230 # ifndef NI_NUMERICHOST
 231 #  define NI_NUMERICHOST 0x01
 232 #  define NI_NUMERICSERV 0x02
 233 #  define NI_NOFQDN      0x04
 234 #  define NI_NAMEREQD    0x08
 235 #  define NI_DGRAM       0x10
 236 # endif
 237
 238 # ifndef HAVE_STRUCT_ADDRINFO
 239 struct addrinfo
 240 {
 241     int ai_flags;
 242     int ai_family;
 243     int ai_socktype;
 244     int ai_protocol;
 245     size_t ai_addrlen;
 246     struct sockaddr *ai_addr;
 247     char *ai_canonname;
 248     struct addrinfo *ai_next;
 249 };
 250 #  define AI_PASSIVE     1
 251 #  define AI_CANONNAME   2
 252 #  define AI_NUMERICHOST 4
 253 # endif /* if !HAVE_STRUCT_ADDRINFO */
 254
 255 VLC_EXPORT( const char *, vlc_gai_strerror, ( int ) );
 256 VLC_EXPORT( int, vlc_getnameinfo, ( const struct sockaddr *, int, char *, int, int *, int ) );
 257 VLC_EXPORT( int, vlc_getaddrinfo, ( vlc_object_t *, const char *, int, const struct addrinfo *, struct addrinfo ** ) );
 258 VLC_EXPORT( void, vlc_freeaddrinfo, ( struct addrinfo * ) );
 259
 260
 261 static inline vlc_bool_t
 262 net_SockAddrIsMulticast (const struct sockaddr *addr, socklen_t len)
 263 {
 264     switch (addr->sa_family)
 265     {
 266 #ifdef IN_MULTICAST
 267         case AF_INET:
 268         {
 269             const struct sockaddr_in *v4 = (const struct sockaddr_in *)addr;
 270             if ((size_t)len < sizeof (*v4))
 271                 return VLC_FALSE;
 272             return IN_MULTICAST (ntohl (v4->sin_addr.s_addr)) != 0;
 273         }
 274 #endif
 275
 276 #ifdef IN6_IS_ADDR_MULTICAST
 277         case AF_INET6:
 278         {
 279             const struct sockaddr_in6 *v6 = (const struct sockaddr_in6 *)addr;
 280             if ((size_t)len < sizeof (*v6))
 281                 return VLC_FALSE;
 282             return IN6_IS_ADDR_MULTICAST (&v6->sin6_addr) != 0;
 283         }
 284 #endif
 285     }
 286
 287     return VLC_FALSE;
 288 }
 289
 290
 291
 292 /**
 293  * net_AddressIsMulticast
 294  * @return VLC_FALSE iff the psz_addr does not specify a multicast address,
 295  * or the address is not a valid address.
 296  */
 297 static inline vlc_bool_t net_AddressIsMulticast( vlc_object_t *p_object, const char *psz_addr )
 298 {
 299     struct addrinfo hints, *res;
 300
 301     memset (&hints, 0, sizeof (hints));
 302     hints.ai_socktype = SOCK_DGRAM; /* UDP */
 303     hints.ai_flags = AI_NUMERICHOST;
 304
 305     int i = vlc_getaddrinfo (p_object, psz_addr, 0,
 306                              &hints, &res);
 307     if (i)
 308     {
 309         msg_Err (p_object, "invalid address \"%s\" for net_AddressIsMulticast (%s)",
 310                  psz_addr, vlc_gai_strerror (i));
 311         return VLC_FALSE;
 312     }
 313
 314     vlc_bool_t b = net_SockAddrIsMulticast (res->ai_addr, res->ai_addrlen);
 315     vlc_freeaddrinfo (res);
 316     return b;
 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