git.sesse.net Git - vlc/blob - include/vlc_network.h

   1 /*****************************************************************************
   2  * network.h: interface to communicate with network plug-ins
   3  *****************************************************************************
   4  * Copyright (C) 2002-2005 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Christophe Massiot <massiot@via.ecp.fr>
   8  *          Laurent Aimar <fenrir@via.ecp.fr>
   9  *          Rémi Denis-Courmont <rem # videolan.org>
  10  *
  11  * This program is free software; you can redistribute it and/or modify
  12  * it under the terms of the GNU General Public License as published by
  13  * the Free Software Foundation; either version 2 of the License, or
  14  * (at your option) any later version.
  15  *
  16  * This program is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU General Public License
  22  * along with this program; if not, write to the Free Software
  23  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  24  *****************************************************************************/
  25
  26 #ifndef __VLC_NETWORK_H
  27 # define __VLC_NETWORK_H
  28
  29 #if defined( WIN32 )
  30 #   if defined(UNDER_CE) && defined(sockaddr_storage)
  31 #       undef sockaddr_storage
  32 #   endif
  33 #   if defined(UNDER_CE)
  34 #       define HAVE_STRUCT_ADDRINFO
  35 #   else
  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 #else
  45 #   if HAVE_SYS_SOCKET_H
  46 #      include <sys/socket.h>
  47 #   endif
  48 #   if HAVE_NETINET_IN_H
  49 #      include <netinet/in.h>
  50 #   endif
  51 #   if HAVE_ARPA_INET_H
  52 #      include <arpa/inet.h>
  53 #   elif defined( SYS_BEOS )
  54 #      include <net/netdb.h>
  55 #   endif
  56 #   include <netdb.h>
  57 #   define net_errno errno
  58 #   define net_strerror strerror
  59 #endif
  60
  61 # ifdef __cplusplus
  62 extern "C" {
  63 # endif
  64
  65 /* Portable networking layer communication */
  66 int net_Socket (vlc_object_t *obj, int family, int socktype, int proto);
  67
  68 #define net_ConnectTCP(a, b, c) __net_ConnectTCP(VLC_OBJECT(a), b, c)
  69 #define net_OpenTCP(a, b, c) __net_ConnectTCP(VLC_OBJECT(a), b, c)
  70 VLC_EXPORT( int, __net_ConnectTCP, ( vlc_object_t *p_this, const char *psz_host, int i_port ) );
  71
  72 int *net_Listen (vlc_object_t *p_this, const char *psz_host, int i_port,
  73                                 int family, int socktype, int protocol);
  74 VLC_EXPORT( int, net_ListenSingle, (vlc_object_t *p_this, const char *psz_host, int i_port, int family, int socktype, int protocol) );
  75
  76 #define net_ListenTCP(a, b, c) __net_ListenTCP(VLC_OBJECT(a), b, c)
  77 VLC_EXPORT( int *, __net_ListenTCP, ( vlc_object_t *, const char *, int ) );
  78
  79 #define net_Accept(a, b, c) __net_Accept(VLC_OBJECT(a), b, c)
  80 VLC_EXPORT( int, __net_Accept, ( vlc_object_t *, int *, mtime_t ) );
  81
  82 #define net_ConnectUDP(a, b, c, d ) __net_ConnectUDP(VLC_OBJECT(a), b, c, d)
  83 VLC_EXPORT( int, __net_ConnectUDP, ( vlc_object_t *p_this, const char *psz_host, int i_port, int hlim ) );
  84
  85 static inline int net_ListenUDP1 (vlc_object_t *obj, const char *host, int port)
  86 {
  87         return net_ListenSingle (obj, host, port, AF_UNSPEC, SOCK_DGRAM, IPPROTO_UDP);
  88 }
  89
  90 #define net_OpenUDP(a, b, c, d, e ) __net_OpenUDP(VLC_OBJECT(a), b, c, d, e)
  91 VLC_EXPORT( int, __net_OpenUDP, ( vlc_object_t *p_this, const char *psz_bind, int i_bind, const char *psz_server, int i_server ) );
  92
  93 VLC_EXPORT( void, net_Close, ( int fd ) );
  94 VLC_EXPORT( void, net_ListenClose, ( int *fd ) );
  95
  96 VLC_EXPORT( int, net_SetDSCP, ( int fd, uint8_t dscp ) );
  97 int net_Subscribe (vlc_object_t *obj, int fd, const struct sockaddr *addr,
  98                    socklen_t addrlen);
  99
 100 /* Functions to read from or write to the networking layer */
 101 struct virtual_socket_t
 102 {
 103     void *p_sys;
 104     int (*pf_recv) ( void *, void *, int );
 105     int (*pf_send) ( void *, const void *, int );
 106 };
 107
 108 #define net_Read(a,b,c,d,e,f) __net_Read(VLC_OBJECT(a),b,c,d,e,f)
 109 VLC_EXPORT( int, __net_Read, ( vlc_object_t *p_this, int fd, const v_socket_t *, uint8_t *p_data, int i_data, vlc_bool_t b_retry ) );
 110
 111 #define net_ReadNonBlock(a,b,c,d,e,f) __net_ReadNonBlock(VLC_OBJECT(a),b,c,d,e,f)
 112 VLC_EXPORT( int, __net_ReadNonBlock, ( vlc_object_t *p_this, int fd, const v_socket_t *, uint8_t *p_data, int i_data, mtime_t i_wait ) );
 113
 114 #define net_Select(a,b,c,d,e,f,g) __net_Select(VLC_OBJECT(a),b,c,d,e,f,g)
 115 VLC_EXPORT( int, __net_Select, ( vlc_object_t *p_this, const int *pi_fd, const v_socket_t *const *, int i_fd, uint8_t *p_data, int i_data, mtime_t i_wait ) );
 116
 117 #define net_Write(a,b,c,d,e) __net_Write(VLC_OBJECT(a),b,c,d,e)
 118 VLC_EXPORT( int, __net_Write, ( vlc_object_t *p_this, int fd, const v_socket_t *, const uint8_t *p_data, int i_data ) );
 119
 120 #define net_Gets(a,b,c) __net_Gets(VLC_OBJECT(a),b,c)
 121 VLC_EXPORT( char *, __net_Gets, ( vlc_object_t *p_this, int fd, const v_socket_t * ) );
 122
 123 VLC_EXPORT( int, net_Printf, ( vlc_object_t *p_this, int fd, const v_socket_t *, const char *psz_fmt, ... ) );
 124
 125 #define net_vaPrintf(a,b,c,d,e) __net_vaPrintf(VLC_OBJECT(a),b,c,d,e)
 126 VLC_EXPORT( int, __net_vaPrintf, ( vlc_object_t *p_this, int fd, const v_socket_t *, const char *psz_fmt, va_list args ) );
 127
 128
 129 #ifndef HAVE_INET_PTON
 130 /* only in core, so no need for C++ extern "C" */
 131 int inet_pton(int af, const char *src, void *dst);
 132 #endif
 133
 134
 135 /*****************************************************************************
 136  * net_StopRecv/Send
 137  *****************************************************************************
 138  * Wrappers for shutdown()
 139  *****************************************************************************/
 140 #if defined (SHUT_WR)
 141 /* the standard way */
 142 # define net_StopSend( fd ) (void)shutdown( fd, SHUT_WR )
 143 # define net_StopRecv( fd ) (void)shutdown( fd, SHUT_RD )
 144 #elif defined (SD_SEND)
 145 /* the Microsoft seemingly-purposedly-different-for-the-sake-of-it way */
 146 # define net_StopSend( fd ) (void)shutdown( fd, SD_SEND )
 147 # define net_StopRecv( fd ) (void)shutdown( fd, SD_RECEIVE )
 148 #else
 149 # ifndef SYS_BEOS /* R5 just doesn't have a working shutdown() */
 150 #  warning FIXME: implement shutdown on your platform!
 151 # endif
 152 # define net_StopSend( fd ) (void)0
 153 # define net_StopRecv( fd ) (void)0
 154 #endif
 155
 156 /* Portable network names/addresses resolution layer */
 157
 158 /* GAI error codes */
 159 # ifndef EAI_BADFLAGS
 160 #  define EAI_BADFLAGS -1
 161 # endif
 162 # ifndef EAI_NONAME
 163 #  define EAI_NONAME -2
 164 # endif
 165 # ifndef EAI_AGAIN
 166 #  define EAI_AGAIN -3
 167 # endif
 168 # ifndef EAI_FAIL
 169 #  define EAI_FAIL -4
 170 # endif
 171 # ifndef EAI_NODATA
 172 #  define EAI_NODATA -5
 173 # endif
 174 # ifndef EAI_FAMILY
 175 #  define EAI_FAMILY -6
 176 # endif
 177 # ifndef EAI_SOCKTYPE
 178 #  define EAI_SOCKTYPE -7
 179 # endif
 180 # ifndef EAI_SERVICE
 181 #  define EAI_SERVICE -8
 182 # endif
 183 # ifndef EAI_ADDRFAMILY
 184 #  define EAI_ADDRFAMILY -9
 185 # endif
 186 # ifndef EAI_MEMORY
 187 #  define EAI_MEMORY -10
 188 # endif
 189 # ifndef EAI_SYSTEM
 190 #  define EAI_SYSTEM -11
 191 # endif
 192
 193
 194 # ifndef NI_MAXHOST
 195 #  define NI_MAXHOST 1025
 196 #  define NI_MAXSERV 32
 197 # endif
 198 # define NI_MAXNUMERICHOST 64
 199
 200 # ifndef NI_NUMERICHOST
 201 #  define NI_NUMERICHOST 0x01
 202 #  define NI_NUMERICSERV 0x02
 203 #  define NI_NOFQDN      0x04
 204 #  define NI_NAMEREQD    0x08
 205 #  define NI_DGRAM       0x10
 206 # endif
 207
 208 # ifndef HAVE_STRUCT_ADDRINFO
 209 struct addrinfo
 210 {
 211     int ai_flags;
 212     int ai_family;
 213     int ai_socktype;
 214     int ai_protocol;
 215     size_t ai_addrlen;
 216     struct sockaddr *ai_addr;
 217     char *ai_canonname;
 218     struct addrinfo *ai_next;
 219 };
 220 #  define AI_PASSIVE     1
 221 #  define AI_CANONNAME   2
 222 #  define AI_NUMERICHOST 4
 223 # endif /* if !HAVE_STRUCT_ADDRINFO */
 224
 225 VLC_EXPORT( const char *, vlc_gai_strerror, ( int ) );
 226 VLC_EXPORT( int, vlc_getnameinfo, ( const struct sockaddr *, int, char *, int, int *, int ) );
 227 VLC_EXPORT( int, vlc_getaddrinfo, ( vlc_object_t *, const char *, int, const struct addrinfo *, struct addrinfo ** ) );
 228 VLC_EXPORT( void, vlc_freeaddrinfo, ( struct addrinfo * ) );
 229
 230
 231 static inline vlc_bool_t
 232 net_SockAddrIsMulticast (const struct sockaddr *addr, socklen_t len)
 233 {
 234     switch (addr->sa_family)
 235     {
 236 #ifdef IN_MULTICAST
 237         case AF_INET:
 238         {
 239             struct sockaddr_in *v4 = (struct sockaddr_in *)addr;
 240             if ((size_t)len < sizeof (*v4))
 241                 return VLC_FALSE;
 242             return IN_MULTICAST (ntohl (v4->sin_addr.s_addr)) != 0;
 243         }
 244 #endif
 245
 246 #ifdef IN6_IS_ADDR_MULTICAST
 247         case AF_INET6:
 248         {
 249             struct sockaddr_in6 *v6 = (struct sockaddr_in6 *)addr;
 250             if ((size_t)len < sizeof (*v6))
 251                 return VLC_FALSE;
 252             return IN6_IS_ADDR_MULTICAST (&v6->sin6_addr) != 0;
 253         }
 254 #endif
 255     }
 256
 257     return VLC_FALSE;
 258 }
 259
 260
 261
 262 /**
 263  * net_AddressIsMulticast
 264  * @return VLC_FALSE iff the psz_addr does not specify a multicast address,
 265  * or the address is not a valid address.
 266  */
 267 static inline vlc_bool_t net_AddressIsMulticast( vlc_object_t *p_object, const char *psz_addr )
 268 {
 269     struct addrinfo hints, *res;
 270
 271     memset (&hints, 0, sizeof (hints));
 272     hints.ai_socktype = SOCK_DGRAM; /* UDP */
 273     hints.ai_flags = AI_NUMERICHOST;
 274
 275     int i = vlc_getaddrinfo (p_object, psz_addr, 0,
 276                              &hints, &res);
 277     if (i)
 278     {
 279         msg_Err (p_object, "invalid address \"%s\" for net_AddressIsMulticast (%s)",
 280                  psz_addr, vlc_gai_strerror (i));
 281         return VLC_FALSE;
 282     }
 283
 284     vlc_bool_t b = net_SockAddrIsMulticast (res->ai_addr, res->ai_addrlen);
 285     vlc_freeaddrinfo (res);
 286     return b;
 287 }
 288
 289 static inline int net_GetSockAddress( int fd, char *address, int *port )
 290 {
 291     struct sockaddr_storage addr;
 292     socklen_t addrlen = sizeof( addr );
 293
 294     return getsockname( fd, (struct sockaddr *)&addr, &addrlen )
 295         || vlc_getnameinfo( (struct sockaddr *)&addr, addrlen, address,
 296                             NI_MAXNUMERICHOST, port, NI_NUMERICHOST )
 297         ? VLC_EGENERIC : 0;
 298 }
 299
 300 static inline int net_GetPeerAddress( int fd, char *address, int *port )
 301 {
 302     struct sockaddr_storage addr;
 303     socklen_t addrlen = sizeof( addr );
 304
 305     return getpeername( fd, (struct sockaddr *)&addr, &addrlen )
 306         || vlc_getnameinfo( (struct sockaddr *)&addr, addrlen, address,
 307                             NI_MAXNUMERICHOST, port, NI_NUMERICHOST )
 308         ? VLC_EGENERIC : 0;
 309 }
 310
 311 # ifdef __cplusplus
 312 }
 313 # endif
 314
 315 #endif