git.sesse.net Git - vlc/blob - include/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 #       include <io.h>
  37 #   endif
  38 #   include <winsock2.h>
  39 #   include <ws2tcpip.h>
  40 #   define ENETUNREACH WSAENETUNREACH
  41 #   define net_errno (WSAGetLastError())
  42 extern const char *net_strerror( int val );
  43 #else
  44 #   if HAVE_SYS_SOCKET_H
  45 #      include <sys/socket.h>
  46 #   endif
  47 #   if HAVE_NETINET_IN_H
  48 #      include <netinet/in.h>
  49 #   endif
  50 #   if HAVE_ARPA_INET_H
  51 #      include <arpa/inet.h>
  52 #   elif defined( SYS_BEOS )
  53 #      include <net/netdb.h>
  54 #   endif
  55 #   include <netdb.h>
  56 #   define net_errno errno
  57 #   define net_strerror strerror
  58 #endif
  59
  60 # ifdef __cplusplus
  61 extern "C" {
  62 # endif
  63
  64 /*****************************************************************************
  65  * network_socket_t: structure passed to a network plug-in to define the
  66  *                   kind of socket we want
  67  *****************************************************************************/
  68 struct network_socket_t
  69 {
  70     const char *psz_bind_addr;
  71     int i_bind_port;
  72
  73     const char *psz_server_addr;
  74     int i_server_port;
  75
  76     int i_ttl;
  77
  78     int v6only;
  79
  80     /* Return values */
  81     int i_handle;
  82     size_t i_mtu;
  83 };
  84
  85 /* Portable networking layer communication */
  86 #define net_ConnectTCP(a, b, c) __net_ConnectTCP(VLC_OBJECT(a), b, c)
  87 #define net_OpenTCP(a, b, c) __net_ConnectTCP(VLC_OBJECT(a), b, c)
  88 VLC_EXPORT( int, __net_ConnectTCP, ( vlc_object_t *p_this, const char *psz_host, int i_port ) );
  89
  90 #define net_ListenTCP(a, b, c) __net_ListenTCP(VLC_OBJECT(a), b, c)
  91 VLC_EXPORT( int *, __net_ListenTCP, ( vlc_object_t *, const char *, int ) );
  92
  93 #define net_Accept(a, b, c) __net_Accept(VLC_OBJECT(a), b, c)
  94 VLC_EXPORT( int, __net_Accept, ( vlc_object_t *, int *, mtime_t ) );
  95
  96 #define net_ConnectUDP(a, b, c, d ) __net_ConnectUDP(VLC_OBJECT(a), b, c, d)
  97 VLC_EXPORT( int, __net_ConnectUDP, ( vlc_object_t *p_this, const char *psz_host, int i_port, int hlim ) );
  98
  99 #define net_OpenUDP(a, b, c, d, e ) __net_OpenUDP(VLC_OBJECT(a), b, c, d, e)
 100 VLC_EXPORT( int, __net_OpenUDP, ( vlc_object_t *p_this, const char *psz_bind, int i_bind, const char *psz_server, int i_server ) );
 101
 102 VLC_EXPORT( void, net_Close, ( int fd ) );
 103 VLC_EXPORT( void, net_ListenClose, ( int *fd ) );
 104
 105
 106 /* Functions to read from or write to the networking layer */
 107 struct virtual_socket_t
 108 {
 109     void *p_sys;
 110     int (*pf_recv) ( void *, void *, int );
 111     int (*pf_send) ( void *, const void *, int );
 112 };
 113
 114 #define net_Read(a,b,c,d,e,f) __net_Read(VLC_OBJECT(a),b,c,d,e,f)
 115 VLC_EXPORT( int, __net_Read, ( vlc_object_t *p_this, int fd, v_socket_t *, uint8_t *p_data, int i_data, vlc_bool_t b_retry ) );
 116
 117 #define net_ReadNonBlock(a,b,c,d,e,f) __net_ReadNonBlock(VLC_OBJECT(a),b,c,d,e,f)
 118 VLC_EXPORT( int, __net_ReadNonBlock, ( vlc_object_t *p_this, int fd, v_socket_t *, uint8_t *p_data, int i_data, mtime_t i_wait ) );
 119
 120 #define net_Select(a,b,c,d,e,f,g) __net_Select(VLC_OBJECT(a),b,c,d,e,f,g)
 121 VLC_EXPORT( int, __net_Select, ( vlc_object_t *p_this, int *pi_fd, v_socket_t **, int i_fd, uint8_t *p_data, int i_data, mtime_t i_wait ) );
 122
 123 #define net_Write(a,b,c,d,e) __net_Write(VLC_OBJECT(a),b,c,d,e)
 124 VLC_EXPORT( int, __net_Write, ( vlc_object_t *p_this, int fd, v_socket_t *, const uint8_t *p_data, int i_data ) );
 125
 126 #define net_Gets(a,b,c) __net_Gets(VLC_OBJECT(a),b,c)
 127 VLC_EXPORT( char *, __net_Gets, ( vlc_object_t *p_this, int fd, v_socket_t * ) );
 128
 129 VLC_EXPORT( int, net_Printf, ( vlc_object_t *p_this, int fd, v_socket_t *, const char *psz_fmt, ... ) );
 130
 131 #define net_vaPrintf(a,b,c,d,e) __net_vaPrintf(VLC_OBJECT(a),b,c,d,e)
 132 VLC_EXPORT( int, __net_vaPrintf, ( vlc_object_t *p_this, int fd, v_socket_t *, const char *psz_fmt, va_list args ) );
 133
 134
 135 #if !HAVE_INET_PTON
 136 /* only in core, so no need for C++ extern "C" */
 137 int inet_pton(int af, const char *src, void *dst);
 138 #endif
 139
 140
 141 /*****************************************************************************
 142  * net_StopRecv/Send
 143  *****************************************************************************
 144  * Wrappers for shutdown()
 145  *****************************************************************************/
 146 #if defined (SHUT_WR)
 147 /* the standard way */
 148 # define net_StopSend( fd ) (void)shutdown( fd, SHUT_WR )
 149 # define net_StopRecv( fd ) (void)shutdown( fd, SHUT_RD )
 150 #elif defined (SD_SEND)
 151 /* the Microsoft seemingly-purposedly-different-for-the-sake-of-it way */
 152 # define net_StopSend( fd ) (void)shutdown( fd, SD_SEND )
 153 # define net_StopRecv( fd ) (void)shutdown( fd, SD_RECEIVE )
 154 #else
 155 # ifndef SYS_BEOS /* R5 just doesn't have a working shutdown() */
 156 #  warning FIXME: implement shutdown on your platform!
 157 # endif
 158 # define net_StopSend( fd ) (void)0
 159 # define net_StopRecv( fd ) (void)0
 160 #endif
 161
 162 /* Portable network names/addresses resolution layer */
 163
 164 /* GAI error codes */
 165 # ifndef EAI_BADFLAGS
 166 #  define EAI_BADFLAGS -1
 167 # endif
 168 # ifndef EAI_NONAME
 169 #  define EAI_NONAME -2
 170 # endif
 171 # ifndef EAI_AGAIN
 172 #  define EAI_AGAIN -3
 173 # endif
 174 # ifndef EAI_FAIL
 175 #  define EAI_FAIL -4
 176 # endif
 177 # ifndef EAI_NODATA
 178 #  define EAI_NODATA -5
 179 # endif
 180 # ifndef EAI_FAMILY
 181 #  define EAI_FAMILY -6
 182 # endif
 183 # ifndef EAI_SOCKTYPE
 184 #  define EAI_SOCKTYPE -7
 185 # endif
 186 # ifndef EAI_SERVICE
 187 #  define EAI_SERVICE -8
 188 # endif
 189 # ifndef EAI_ADDRFAMILY
 190 #  define EAI_ADDRFAMILY -9
 191 # endif
 192 # ifndef EAI_MEMORY
 193 #  define EAI_MEMORY -10
 194 # endif
 195 # ifndef EAI_SYSTEM
 196 #  define EAI_SYSTEM -11
 197 # endif
 198
 199
 200 # ifndef NI_MAXHOST
 201 #  define NI_MAXHOST 1025
 202 #  define NI_MAXSERV 32
 203 # endif
 204 # define NI_MAXNUMERICHOST 64
 205
 206 # ifndef NI_NUMERICHOST
 207 #  define NI_NUMERICHOST 0x01
 208 #  define NI_NUMERICSERV 0x02
 209 #  define NI_NOFQDN      0x04
 210 #  define NI_NAMEREQD    0x08
 211 #  define NI_DGRAM       0x10
 212 # endif
 213
 214 # ifndef HAVE_STRUCT_ADDRINFO
 215 struct addrinfo
 216 {
 217     int ai_flags;
 218     int ai_family;
 219     int ai_socktype;
 220     int ai_protocol;
 221     size_t ai_addrlen;
 222     struct sockaddr *ai_addr;
 223     char *ai_canonname;
 224     struct addrinfo *ai_next;
 225 };
 226 #  define AI_PASSIVE     1
 227 #  define AI_CANONNAME   2
 228 #  define AI_NUMERICHOST 4
 229 # endif /* if !HAVE_STRUCT_ADDRINFO */
 230
 231 VLC_EXPORT( const char *, vlc_gai_strerror, ( int ) );
 232 VLC_EXPORT( int, vlc_getnameinfo, ( const struct sockaddr *, int, char *, int, int *, int ) );
 233 VLC_EXPORT( int, vlc_getaddrinfo, ( vlc_object_t *, const char *, int, const struct addrinfo *, struct addrinfo ** ) );
 234 VLC_EXPORT( void, vlc_freeaddrinfo, ( struct addrinfo * ) );
 235
 236 /*****************************************************************************
 237  * net_AddressIsMulticast: This function returns VLC_FALSE if the psz_addr does
 238  * not specify a multicast address or if the address is not a valid address.
 239  *****************************************************************************/
 240 static inline vlc_bool_t net_AddressIsMulticast( vlc_object_t *p_object, const char *psz_addr )
 241 {
 242     struct addrinfo hints, *res;
 243     vlc_bool_t b_multicast = VLC_FALSE;
 244     int i;
 245
 246     memset( &hints, 0, sizeof( hints ) );
 247     hints.ai_socktype = SOCK_DGRAM; /* UDP */
 248     hints.ai_flags = AI_NUMERICHOST;
 249
 250     i = vlc_getaddrinfo( p_object, psz_addr, 0,
 251                          &hints, &res );
 252     if( i )
 253     {
 254         msg_Err( p_object, "invalid address for net_AddressIsMulticast: %s : %s",
 255                  psz_addr, vlc_gai_strerror( i ) );
 256         return VLC_FALSE;
 257     }
 258
 259     if( res->ai_family == AF_INET )
 260     {
 261 #if !defined( SYS_BEOS )
 262         struct sockaddr_in *v4 = (struct sockaddr_in *) res->ai_addr;
 263         b_multicast = ( ntohl( v4->sin_addr.s_addr ) >= 0xe0000000 )
 264                    && ( ntohl( v4->sin_addr.s_addr ) <= 0xefffffff );
 265 #endif
 266     }
 267 #if defined( WIN32 ) || defined( HAVE_GETADDRINFO )
 268     else if( res->ai_family == AF_INET6 )
 269     {
 270         struct sockaddr_in6 *v6 = (struct sockaddr_in6 *)res->ai_addr;
 271         b_multicast = IN6_IS_ADDR_MULTICAST( &v6->sin6_addr );
 272     }
 273 #endif
 274
 275     vlc_freeaddrinfo( res );
 276     return b_multicast;
 277 }
 278
 279 static inline int net_GetSockAddress( int fd, char *address, int *port )
 280 {
 281     struct sockaddr_storage addr;
 282     socklen_t addrlen = sizeof( addr );
 283
 284     return getsockname( fd, (struct sockaddr *)&addr, &addrlen )
 285         || vlc_getnameinfo( (struct sockaddr *)&addr, addrlen, address,
 286                             NI_MAXNUMERICHOST, port, NI_NUMERICHOST )
 287         ? VLC_EGENERIC : 0;
 288 }
 289
 290 static inline int net_GetPeerAddress( int fd, char *address, int *port )
 291 {
 292     struct sockaddr_storage addr;
 293     socklen_t addrlen = sizeof( addr );
 294
 295     return getpeername( 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 # ifdef __cplusplus
 302 }
 303 # endif
 304
 305 #endif