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) && defined(sockaddr_storage)
  36 #       undef sockaddr_storage
  37 #   endif
  38 #   if defined(UNDER_CE)
  39 #       define HAVE_STRUCT_ADDRINFO
  40 #   else
  41 #       define _NO_OLDNAMES 1
  42 #       include <io.h>
  43 #   endif
  44 #   include <winsock2.h>
  45 #   include <ws2tcpip.h>
  46 #   define ENETUNREACH WSAENETUNREACH
  47 #   define net_errno (WSAGetLastError())
  48 extern const char *net_strerror( int val );
  49 #else
  50 #   if HAVE_SYS_SOCKET_H
  51 #      include <sys/socket.h>
  52 #   endif
  53 #   if HAVE_NETINET_IN_H
  54 #      include <netinet/in.h>
  55 #   endif
  56 #   if HAVE_ARPA_INET_H
  57 #      include <arpa/inet.h>
  58 #   elif defined( SYS_BEOS )
  59 #      include <net/netdb.h>
  60 #   endif
  61 #   include <netdb.h>
  62 #   define net_errno errno
  63 #   define net_strerror strerror
  64 #endif
  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 #define net_Connect(a, b, c, d, e) __net_Connect(VLC_OBJECT(a), b, c, d, e)
  74 VLC_EXPORT( int, __net_Connect, (vlc_object_t *p_this, const char *psz_host, int i_port, int socktype, int protocol) );
  75
  76 VLC_EXPORT( int *, net_Listen, (vlc_object_t *p_this, const char *psz_host, int i_port, int family, int socktype, int protocol) );
  77 VLC_EXPORT( int, net_ListenSingle, (vlc_object_t *p_this, const char *psz_host, int i_port, int family, int socktype, int protocol) );
  78
  79 #define net_ListenTCP(a, b, c) __net_ListenTCP(VLC_OBJECT(a), b, c)
  80 #define net_ConnectTCP(a, b, c) __net_ConnectTCP(VLC_OBJECT(a), b, c)
  81
  82 static inline int *__net_ListenTCP (vlc_object_t *obj, const char *host, int port)
  83 {
  84     return net_Listen (obj, host, port, AF_UNSPEC, SOCK_STREAM, IPPROTO_TCP);
  85 }
  86
  87 static inline int __net_ConnectTCP (vlc_object_t *obj, const char *host, int port)
  88 {
  89     return __net_Connect (obj, host, port, SOCK_STREAM, IPPROTO_TCP);
  90 }
  91
  92 #define net_Accept(a, b, c) __net_Accept(VLC_OBJECT(a), b, c)
  93 VLC_EXPORT( int, __net_Accept, ( vlc_object_t *, int *, mtime_t ) );
  94
  95 #define net_ConnectDgram(a, b, c, d, e ) __net_ConnectDgram(VLC_OBJECT(a), b, c, d, e)
  96 VLC_EXPORT( int, __net_ConnectDgram, ( vlc_object_t *p_this, const char *psz_host, int i_port, int hlim, int proto ) );
  97
  98 static inline int net_ConnectUDP (vlc_object_t *obj, const char *host, int port, int hlim)
  99 {
 100     return net_ConnectDgram (obj, host, port, hlim, IPPROTO_UDP);
 101 }
 102
 103 static inline int net_ListenUDP1 (vlc_object_t *obj, const char *host, int port)
 104 {
 105     return net_ListenSingle (obj, host, port, AF_UNSPEC, SOCK_DGRAM, 0);
 106 }
 107
 108 #define net_OpenDgram( a, b, c, d, e, g, h ) __net_OpenDgram(VLC_OBJECT(a), b, c, d, e, g, h)
 109 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 ) );
 110
 111 VLC_EXPORT( void, net_Close, ( int fd ) );
 112 VLC_EXPORT( void, net_ListenClose, ( int *fd ) );
 113
 114 VLC_EXPORT( int, net_SetDSCP, ( int fd, uint8_t dscp ) );
 115 int net_Subscribe (vlc_object_t *obj, int fd, const struct sockaddr *addr,
 116                    socklen_t addrlen);
 117
 118 /* Functions to read from or write to the networking layer */
 119 struct virtual_socket_t
 120 {
 121     void *p_sys;
 122     int (*pf_recv) ( void *, void *, int );
 123     int (*pf_send) ( void *, const void *, int );
 124 };
 125
 126 #define net_Read(a,b,c,d,e,f) __net_Read(VLC_OBJECT(a),b,c,d,e,f)
 127 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 ) );
 128
 129 #define net_ReadNonBlock(a,b,c,d,e) __net_ReadNonBlock(VLC_OBJECT(a),b,c,d,e)
 130 VLC_EXPORT( ssize_t, __net_ReadNonBlock, ( vlc_object_t *p_this, int fd, const v_socket_t *, uint8_t *p_data, size_t i_data ) );
 131
 132 #define net_Select(a,b,c,d,e) __net_Select(VLC_OBJECT(a),b,c,d,e)
 133 VLC_EXPORT( ssize_t, __net_Select, ( vlc_object_t *p_this, const int *pi_fd, int i_fd, uint8_t *p_data, size_t i_data ) );
 134
 135 #define net_Write(a,b,c,d,e) __net_Write(VLC_OBJECT(a),b,c,d,e)
 136 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 ) );
 137
 138 #define net_Gets(a,b,c) __net_Gets(VLC_OBJECT(a),b,c)
 139 VLC_EXPORT( char *, __net_Gets, ( vlc_object_t *p_this, int fd, const v_socket_t * ) );
 140
 141 VLC_EXPORT( ssize_t, net_Printf, ( vlc_object_t *p_this, int fd, const v_socket_t *, const char *psz_fmt, ... ) );
 142
 143 #define net_vaPrintf(a,b,c,d,e) __net_vaPrintf(VLC_OBJECT(a),b,c,d,e)
 144 VLC_EXPORT( ssize_t, __net_vaPrintf, ( vlc_object_t *p_this, int fd, const v_socket_t *, const char *psz_fmt, va_list args ) );
 145
 146
 147 #ifndef HAVE_INET_PTON
 148 /* only in core, so no need for C++ extern "C" */
 149 VLC_EXPORT (int, inet_pton, (int af, const char *src, void *dst) );
 150 #endif
 151
 152 #ifndef HAVE_INET_NTOP
 153 #ifdef WIN32
 154 /* only in core, so no need for C++ extern "C" */
 155 VLC_EXPORT (const char *, inet_ntop, (int af, const void *src,
 156                                       char *dst, socklen_t cnt) );
 157 #endif
 158 #endif
 159
 160 #ifndef HAVE_POLL
 161 enum
 162 {
 163     POLLIN=1,
 164     POLLOUT=2,
 165     POLLPRI=4,
 166     POLLERR=8,  // unsupported stub
 167     POLLHUP=16, // unsupported stub
 168     POLLNVAL=32 // unsupported stub
 169 };
 170
 171 struct pollfd
 172 {
 173     int fd;
 174     int events;
 175     int revents;
 176 };
 177
 178 int poll (struct pollfd *fds, unsigned nfds, int timeout);
 179 #endif
 180
 181
 182 /*****************************************************************************
 183  * net_StopRecv/Send
 184  *****************************************************************************
 185  * Wrappers for shutdown()
 186  *****************************************************************************/
 187 #if defined (SHUT_WR)
 188 /* the standard way */
 189 # define net_StopSend( fd ) (void)shutdown( fd, SHUT_WR )
 190 # define net_StopRecv( fd ) (void)shutdown( fd, SHUT_RD )
 191 #elif defined (SD_SEND)
 192 /* the Microsoft seemingly-purposedly-different-for-the-sake-of-it way */
 193 # define net_StopSend( fd ) (void)shutdown( fd, SD_SEND )
 194 # define net_StopRecv( fd ) (void)shutdown( fd, SD_RECEIVE )
 195 #else
 196 # ifndef SYS_BEOS /* R5 just doesn't have a working shutdown() */
 197 #  warning FIXME: implement shutdown on your platform!
 198 # endif
 199 # define net_StopSend( fd ) (void)0
 200 # define net_StopRecv( fd ) (void)0
 201 #endif
 202
 203 /* Portable network names/addresses resolution layer */
 204
 205 /* GAI error codes */
 206 # ifndef EAI_BADFLAGS
 207 #  define EAI_BADFLAGS -1
 208 # endif
 209 # ifndef EAI_NONAME
 210 #  define EAI_NONAME -2
 211 # endif
 212 # ifndef EAI_AGAIN
 213 #  define EAI_AGAIN -3
 214 # endif
 215 # ifndef EAI_FAIL
 216 #  define EAI_FAIL -4
 217 # endif
 218 # ifndef EAI_NODATA
 219 #  define EAI_NODATA -5
 220 # endif
 221 # ifndef EAI_FAMILY
 222 #  define EAI_FAMILY -6
 223 # endif
 224 # ifndef EAI_SOCKTYPE
 225 #  define EAI_SOCKTYPE -7
 226 # endif
 227 # ifndef EAI_SERVICE
 228 #  define EAI_SERVICE -8
 229 # endif
 230 # ifndef EAI_ADDRFAMILY
 231 #  define EAI_ADDRFAMILY -9
 232 # endif
 233 # ifndef EAI_MEMORY
 234 #  define EAI_MEMORY -10
 235 # endif
 236 # ifndef EAI_SYSTEM
 237 #  define EAI_SYSTEM -11
 238 # endif
 239
 240
 241 # ifndef NI_MAXHOST
 242 #  define NI_MAXHOST 1025
 243 #  define NI_MAXSERV 32
 244 # endif
 245 # define NI_MAXNUMERICHOST 64
 246
 247 # ifndef NI_NUMERICHOST
 248 #  define NI_NUMERICHOST 0x01
 249 #  define NI_NUMERICSERV 0x02
 250 #  define NI_NOFQDN      0x04
 251 #  define NI_NAMEREQD    0x08
 252 #  define NI_DGRAM       0x10
 253 # endif
 254
 255 # ifndef HAVE_STRUCT_ADDRINFO
 256 struct addrinfo
 257 {
 258     int ai_flags;
 259     int ai_family;
 260     int ai_socktype;
 261     int ai_protocol;
 262     size_t ai_addrlen;
 263     struct sockaddr *ai_addr;
 264     char *ai_canonname;
 265     struct addrinfo *ai_next;
 266 };
 267 #  define AI_PASSIVE     1
 268 #  define AI_CANONNAME   2
 269 #  define AI_NUMERICHOST 4
 270 # endif /* if !HAVE_STRUCT_ADDRINFO */
 271
 272 VLC_EXPORT( const char *, vlc_gai_strerror, ( int ) );
 273 VLC_EXPORT( int, vlc_getnameinfo, ( const struct sockaddr *, int, char *, int, int *, int ) );
 274 VLC_EXPORT( int, vlc_getaddrinfo, ( vlc_object_t *, const char *, int, const struct addrinfo *, struct addrinfo ** ) );
 275 VLC_EXPORT( void, vlc_freeaddrinfo, ( struct addrinfo * ) );
 276
 277
 278 static inline vlc_bool_t
 279 net_SockAddrIsMulticast (const struct sockaddr *addr, socklen_t len)
 280 {
 281     switch (addr->sa_family)
 282     {
 283 #ifdef IN_MULTICAST
 284         case AF_INET:
 285         {
 286             struct sockaddr_in *v4 = (struct sockaddr_in *)addr;
 287             if ((size_t)len < sizeof (*v4))
 288                 return VLC_FALSE;
 289             return IN_MULTICAST (ntohl (v4->sin_addr.s_addr)) != 0;
 290         }
 291 #endif
 292
 293 #ifdef IN6_IS_ADDR_MULTICAST
 294         case AF_INET6:
 295         {
 296             struct sockaddr_in6 *v6 = (struct sockaddr_in6 *)addr;
 297             if ((size_t)len < sizeof (*v6))
 298                 return VLC_FALSE;
 299             return IN6_IS_ADDR_MULTICAST (&v6->sin6_addr) != 0;
 300         }
 301 #endif
 302     }
 303
 304     return VLC_FALSE;
 305 }
 306
 307
 308
 309 /**
 310  * net_AddressIsMulticast
 311  * @return VLC_FALSE iff the psz_addr does not specify a multicast address,
 312  * or the address is not a valid address.
 313  */
 314 static inline vlc_bool_t net_AddressIsMulticast( vlc_object_t *p_object, const char *psz_addr )
 315 {
 316     struct addrinfo hints, *res;
 317
 318     memset (&hints, 0, sizeof (hints));
 319     hints.ai_socktype = SOCK_DGRAM; /* UDP */
 320     hints.ai_flags = AI_NUMERICHOST;
 321
 322     int i = vlc_getaddrinfo (p_object, psz_addr, 0,
 323                              &hints, &res);
 324     if (i)
 325     {
 326         msg_Err (p_object, "invalid address \"%s\" for net_AddressIsMulticast (%s)",
 327                  psz_addr, vlc_gai_strerror (i));
 328         return VLC_FALSE;
 329     }
 330
 331     vlc_bool_t b = net_SockAddrIsMulticast (res->ai_addr, res->ai_addrlen);
 332     vlc_freeaddrinfo (res);
 333     return b;
 334 }
 335
 336 static inline int net_GetSockAddress( int fd, char *address, int *port )
 337 {
 338     struct sockaddr_storage addr;
 339     socklen_t addrlen = sizeof( addr );
 340
 341     return getsockname( fd, (struct sockaddr *)&addr, &addrlen )
 342         || vlc_getnameinfo( (struct sockaddr *)&addr, addrlen, address,
 343                             NI_MAXNUMERICHOST, port, NI_NUMERICHOST )
 344         ? VLC_EGENERIC : 0;
 345 }
 346
 347 static inline int net_GetPeerAddress( int fd, char *address, int *port )
 348 {
 349     struct sockaddr_storage addr;
 350     socklen_t addrlen = sizeof( addr );
 351
 352     return getpeername( fd, (struct sockaddr *)&addr, &addrlen )
 353         || vlc_getnameinfo( (struct sockaddr *)&addr, addrlen, address,
 354                             NI_MAXNUMERICHOST, port, NI_NUMERICHOST )
 355         ? VLC_EGENERIC : 0;
 356 }
 357
 358 static inline uint16_t net_GetPort (const struct sockaddr *addr)
 359 {
 360     switch (addr->sa_family)
 361     {
 362 #ifdef AF_INET6
 363         case AF_INET6:
 364             return ((const struct sockaddr_in6 *)addr)->sin6_port;
 365 #endif
 366         case AF_INET:
 367             return ((const struct sockaddr_in *)addr)->sin_port;
 368     }
 369     return 0;
 370 }
 371
 372 static inline void net_SetPort (struct sockaddr *addr, uint16_t port)
 373 {
 374     switch (addr->sa_family)
 375     {
 376 #ifdef AF_INET6
 377         case AF_INET6:
 378             ((struct sockaddr_in6 *)addr)->sin6_port = port;
 379             break;
 380 #endif
 381         case AF_INET:
 382             ((struct sockaddr_in *)addr)->sin_port = port;
 383             break;
 384     }
 385 }
 386 # ifdef __cplusplus
 387 }
 388 # endif
 389
 390 #endif