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 int net_Socket (vlc_object_t *obj, int family, int socktype, int proto);
  87
  88 #define net_ConnectTCP(a, b, c) __net_ConnectTCP(VLC_OBJECT(a), b, c)
  89 #define net_OpenTCP(a, b, c) __net_ConnectTCP(VLC_OBJECT(a), b, c)
  90 VLC_EXPORT( int, __net_ConnectTCP, ( vlc_object_t *p_this, const char *psz_host, int i_port ) );
  91
  92 int *net_Listen (vlc_object_t *p_this, const char *psz_host, int i_port,
  93                  int family, int socktype, int protocol);
  94
  95 #define net_ListenTCP(a, b, c) __net_ListenTCP(VLC_OBJECT(a), b, c)
  96 VLC_EXPORT( int *, __net_ListenTCP, ( vlc_object_t *, const char *, int ) );
  97
  98 #define net_Accept(a, b, c) __net_Accept(VLC_OBJECT(a), b, c)
  99 VLC_EXPORT( int, __net_Accept, ( vlc_object_t *, int *, mtime_t ) );
 100
 101 #define net_ConnectUDP(a, b, c, d ) __net_ConnectUDP(VLC_OBJECT(a), b, c, d)
 102 VLC_EXPORT( int, __net_ConnectUDP, ( vlc_object_t *p_this, const char *psz_host, int i_port, int hlim ) );
 103
 104 int net_ListenUDP1 (vlc_object_t *obj, const char *host, int port);
 105
 106 #define net_OpenUDP(a, b, c, d, e ) __net_OpenUDP(VLC_OBJECT(a), b, c, d, e)
 107 VLC_EXPORT( int, __net_OpenUDP, ( vlc_object_t *p_this, const char *psz_bind, int i_bind, const char *psz_server, int i_server ) );
 108
 109 VLC_EXPORT( void, net_Close, ( int fd ) );
 110 VLC_EXPORT( void, net_ListenClose, ( int *fd ) );
 111
 112 VLC_EXPORT( int, net_SetDSCP, ( int fd, uint8_t dscp ) );
 113 int net_Subscribe (vlc_object_t *obj, int fd, const struct sockaddr *addr,
 114                    socklen_t addrlen);
 115
 116 /* Functions to read from or write to the networking layer */
 117 struct virtual_socket_t
 118 {
 119     void *p_sys;
 120     int (*pf_recv) ( void *, void *, int );
 121     int (*pf_send) ( void *, const void *, int );
 122 };
 123
 124 #define net_Read(a,b,c,d,e,f) __net_Read(VLC_OBJECT(a),b,c,d,e,f)
 125 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 ) );
 126
 127 #define net_ReadNonBlock(a,b,c,d,e,f) __net_ReadNonBlock(VLC_OBJECT(a),b,c,d,e,f)
 128 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 ) );
 129
 130 #define net_Select(a,b,c,d,e,f,g) __net_Select(VLC_OBJECT(a),b,c,d,e,f,g)
 131 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 ) );
 132
 133 #define net_Write(a,b,c,d,e) __net_Write(VLC_OBJECT(a),b,c,d,e)
 134 VLC_EXPORT( int, __net_Write, ( vlc_object_t *p_this, int fd, const v_socket_t *, const uint8_t *p_data, int i_data ) );
 135
 136 #define net_Gets(a,b,c) __net_Gets(VLC_OBJECT(a),b,c)
 137 VLC_EXPORT( char *, __net_Gets, ( vlc_object_t *p_this, int fd, const v_socket_t * ) );
 138
 139 VLC_EXPORT( int, net_Printf, ( vlc_object_t *p_this, int fd, const v_socket_t *, const char *psz_fmt, ... ) );
 140
 141 #define net_vaPrintf(a,b,c,d,e) __net_vaPrintf(VLC_OBJECT(a),b,c,d,e)
 142 VLC_EXPORT( int, __net_vaPrintf, ( vlc_object_t *p_this, int fd, const v_socket_t *, const char *psz_fmt, va_list args ) );
 143
 144
 145 #ifndef HAVE_INET_PTON
 146 /* only in core, so no need for C++ extern "C" */
 147 int inet_pton(int af, const char *src, void *dst);
 148 #endif
 149
 150
 151 /*****************************************************************************
 152  * net_StopRecv/Send
 153  *****************************************************************************
 154  * Wrappers for shutdown()
 155  *****************************************************************************/
 156 #if defined (SHUT_WR)
 157 /* the standard way */
 158 # define net_StopSend( fd ) (void)shutdown( fd, SHUT_WR )
 159 # define net_StopRecv( fd ) (void)shutdown( fd, SHUT_RD )
 160 #elif defined (SD_SEND)
 161 /* the Microsoft seemingly-purposedly-different-for-the-sake-of-it way */
 162 # define net_StopSend( fd ) (void)shutdown( fd, SD_SEND )
 163 # define net_StopRecv( fd ) (void)shutdown( fd, SD_RECEIVE )
 164 #else
 165 # ifndef SYS_BEOS /* R5 just doesn't have a working shutdown() */
 166 #  warning FIXME: implement shutdown on your platform!
 167 # endif
 168 # define net_StopSend( fd ) (void)0
 169 # define net_StopRecv( fd ) (void)0
 170 #endif
 171
 172 /* Portable network names/addresses resolution layer */
 173
 174 /* GAI error codes */
 175 # ifndef EAI_BADFLAGS
 176 #  define EAI_BADFLAGS -1
 177 # endif
 178 # ifndef EAI_NONAME
 179 #  define EAI_NONAME -2
 180 # endif
 181 # ifndef EAI_AGAIN
 182 #  define EAI_AGAIN -3
 183 # endif
 184 # ifndef EAI_FAIL
 185 #  define EAI_FAIL -4
 186 # endif
 187 # ifndef EAI_NODATA
 188 #  define EAI_NODATA -5
 189 # endif
 190 # ifndef EAI_FAMILY
 191 #  define EAI_FAMILY -6
 192 # endif
 193 # ifndef EAI_SOCKTYPE
 194 #  define EAI_SOCKTYPE -7
 195 # endif
 196 # ifndef EAI_SERVICE
 197 #  define EAI_SERVICE -8
 198 # endif
 199 # ifndef EAI_ADDRFAMILY
 200 #  define EAI_ADDRFAMILY -9
 201 # endif
 202 # ifndef EAI_MEMORY
 203 #  define EAI_MEMORY -10
 204 # endif
 205 # ifndef EAI_SYSTEM
 206 #  define EAI_SYSTEM -11
 207 # endif
 208
 209
 210 # ifndef NI_MAXHOST
 211 #  define NI_MAXHOST 1025
 212 #  define NI_MAXSERV 32
 213 # endif
 214 # define NI_MAXNUMERICHOST 64
 215
 216 # ifndef NI_NUMERICHOST
 217 #  define NI_NUMERICHOST 0x01
 218 #  define NI_NUMERICSERV 0x02
 219 #  define NI_NOFQDN      0x04
 220 #  define NI_NAMEREQD    0x08
 221 #  define NI_DGRAM       0x10
 222 # endif
 223
 224 # ifndef HAVE_STRUCT_ADDRINFO
 225 struct addrinfo
 226 {
 227     int ai_flags;
 228     int ai_family;
 229     int ai_socktype;
 230     int ai_protocol;
 231     size_t ai_addrlen;
 232     struct sockaddr *ai_addr;
 233     char *ai_canonname;
 234     struct addrinfo *ai_next;
 235 };
 236 #  define AI_PASSIVE     1
 237 #  define AI_CANONNAME   2
 238 #  define AI_NUMERICHOST 4
 239 # endif /* if !HAVE_STRUCT_ADDRINFO */
 240
 241 VLC_EXPORT( const char *, vlc_gai_strerror, ( int ) );
 242 VLC_EXPORT( int, vlc_getnameinfo, ( const struct sockaddr *, int, char *, int, int *, int ) );
 243 VLC_EXPORT( int, vlc_getaddrinfo, ( vlc_object_t *, const char *, int, const struct addrinfo *, struct addrinfo ** ) );
 244 VLC_EXPORT( void, vlc_freeaddrinfo, ( struct addrinfo * ) );
 245
 246
 247 static inline vlc_bool_t
 248 net_SockAddrIsMulticast (const struct sockaddr *addr, socklen_t len)
 249 {
 250     switch (addr->sa_family)
 251     {
 252 #ifdef IN_MULTICAST
 253         case AF_INET:
 254         {
 255             struct sockaddr_in *v4 = (struct sockaddr_in *)addr;
 256             if (len < sizeof (*v4))
 257                 return VLC_FALSE;
 258             return IN_MULTICAST (v4->sin_addr.s_addr) != 0;
 259         }
 260 #endif
 261
 262 #ifdef IN6_IS_ADDR_MULTICAST
 263         case AF_INET6:
 264         {
 265             struct sockaddr_in6 *v6 = (struct sockaddr_in6 *)addr;
 266             if (len < sizeof (*v6))
 267                 return VLC_FALSE;
 268             return IN6_IS_ADDR_MULTICAST (&v6->sin6_addr) != 0;
 269         }
 270 #endif
 271     }
 272
 273     return VLC_FALSE;
 274 }
 275
 276
 277
 278 /**
 279  * net_AddressIsMulticast
 280  * @return VLC_FALSE iff the psz_addr does not specify a multicast address,
 281  * or the address is not a valid address.
 282  */
 283 static inline vlc_bool_t net_AddressIsMulticast( vlc_object_t *p_object, const char *psz_addr )
 284 {
 285     struct addrinfo hints, *res;
 286
 287     memset (&hints, 0, sizeof (hints));
 288     hints.ai_socktype = SOCK_DGRAM; /* UDP */
 289     hints.ai_flags = AI_NUMERICHOST;
 290
 291     int i = vlc_getaddrinfo (p_object, psz_addr, 0,
 292                              &hints, &res);
 293     if (i)
 294     {
 295         msg_Err (p_object, "invalid address \"%s\" for net_AddressIsMulticast (%s)",
 296                  psz_addr, vlc_gai_strerror (i));
 297         return VLC_FALSE;
 298     }
 299
 300     vlc_bool_t b = net_SockAddrIsMulticast (res->ai_addr, res->ai_addrlen);
 301     vlc_freeaddrinfo (res);
 302     return b;
 303 }
 304
 305 static inline int net_GetSockAddress( int fd, char *address, int *port )
 306 {
 307     struct sockaddr_storage addr;
 308     socklen_t addrlen = sizeof( addr );
 309
 310     return getsockname( fd, (struct sockaddr *)&addr, &addrlen )
 311         || vlc_getnameinfo( (struct sockaddr *)&addr, addrlen, address,
 312                             NI_MAXNUMERICHOST, port, NI_NUMERICHOST )
 313         ? VLC_EGENERIC : 0;
 314 }
 315
 316 static inline int net_GetPeerAddress( int fd, char *address, int *port )
 317 {
 318     struct sockaddr_storage addr;
 319     socklen_t addrlen = sizeof( addr );
 320
 321     return getpeername( fd, (struct sockaddr *)&addr, &addrlen )
 322         || vlc_getnameinfo( (struct sockaddr *)&addr, addrlen, address,
 323                             NI_MAXNUMERICHOST, port, NI_NUMERICHOST )
 324         ? VLC_EGENERIC : 0;
 325 }
 326
 327 # ifdef __cplusplus
 328 }
 329 # endif
 330
 331 #endif