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 #ifndef VLC_NETWORK_H
  28 # define VLC_NETWORK_H
  29
  30 /**
  31  * \file
  32  * This file defines interface to communicate with network plug-ins
  33  */
  34
  35 #if defined( WIN32 )
  36 #   if !defined(UNDER_CE)
  37 #       define _NO_OLDNAMES 1
  38 #       include <io.h>
  39 #   endif
  40 #   include <winsock2.h>
  41 #   include <ws2tcpip.h>
  42 #   define ENETUNREACH WSAENETUNREACH
  43 #   define net_errno (WSAGetLastError())
  44 extern const char *net_strerror( int val );
  45
  46 struct iovec
  47 {
  48     void  *iov_base;
  49     size_t iov_len;
  50 };
  51
  52 struct msghdr
  53 {
  54     void         *msg_name;
  55     size_t        msg_namelen;
  56     struct iovec *msg_iov;
  57     size_t        msg_iovlen;
  58     void         *msg_control;
  59     size_t        msg_controllen;
  60     int           msg_flags;
  61 };
  62
  63 #   ifndef IPV6_V6ONLY
  64 #       define IPV6_V6ONLY 27
  65 #   endif
  66 #else
  67 #   include <sys/socket.h>
  68 #   ifdef HAVE_NETINET_IN_H
  69 #      include <netinet/in.h>
  70 #   endif
  71 #   ifdef HAVE_ARPA_INET_H
  72 #      include <arpa/inet.h>
  73 #   elif defined( SYS_BEOS )
  74 #      include <net/netdb.h>
  75 #   endif
  76 #   include <netdb.h>
  77 #   define net_errno errno
  78 #endif
  79
  80 # ifdef __cplusplus
  81 extern "C" {
  82 # endif
  83
  84 /* Portable networking layer communication */
  85 int net_Socket (vlc_object_t *obj, int family, int socktype, int proto);
  86 int net_SetupSocket (int fd);
  87
  88 VLC_EXPORT( int, net_Connect, (vlc_object_t *p_this, const char *psz_host, int i_port, int socktype, int protocol) );
  89 #define net_Connect(a, b, c, d, e) net_Connect(VLC_OBJECT(a), b, c, d, e)
  90
  91 VLC_EXPORT( int *, net_Listen, (vlc_object_t *p_this, const char *psz_host, int i_port, int protocol) );
  92
  93 #define net_ListenTCP(a, b, c) net_Listen(VLC_OBJECT(a), b, c, IPPROTO_TCP)
  94
  95 static inline int net_ConnectTCP (vlc_object_t *obj, const char *host, int port)
  96 {
  97     return net_Connect (obj, host, port, SOCK_STREAM, IPPROTO_TCP);
  98 }
  99 #define net_ConnectTCP(a, b, c) net_ConnectTCP(VLC_OBJECT(a), b, c)
 100
 101 VLC_EXPORT( int, net_AcceptSingle, (vlc_object_t *obj, int lfd) );
 102
 103 VLC_EXPORT( int, net_Accept, ( vlc_object_t *, int * ) );
 104 #define net_Accept(a, b) \
 105         net_Accept(VLC_OBJECT(a), b)
 106
 107 VLC_EXPORT( int, net_ConnectDgram, ( vlc_object_t *p_this, const char *psz_host, int i_port, int hlim, int proto ) );
 108 #define net_ConnectDgram(a, b, c, d, e ) \
 109         net_ConnectDgram(VLC_OBJECT(a), b, c, d, e)
 110
 111 static inline int net_ConnectUDP (vlc_object_t *obj, const char *host, int port, int hlim)
 112 {
 113     return net_ConnectDgram (obj, host, port, hlim, IPPROTO_UDP);
 114 }
 115
 116 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 ) );
 117 #define net_OpenDgram( a, b, c, d, e, g, h ) \
 118         net_OpenDgram(VLC_OBJECT(a), b, c, d, e, g, h)
 119
 120 static inline int net_ListenUDP1 (vlc_object_t *obj, const char *host, int port)
 121 {
 122     return net_OpenDgram (obj, host, port, NULL, 0, 0, IPPROTO_UDP);
 123 }
 124
 125 VLC_EXPORT( void, net_ListenClose, ( int *fd ) );
 126
 127 int net_Subscribe (vlc_object_t *obj, int fd, const struct sockaddr *addr,
 128                    socklen_t addrlen);
 129
 130 VLC_EXPORT( int, net_SetCSCov, ( int fd, int sendcov, int recvcov ) );
 131
 132 /* Functions to read from or write to the networking layer */
 133 struct virtual_socket_t
 134 {
 135     void *p_sys;
 136     int (*pf_recv) ( void *, void *, int );
 137     int (*pf_send) ( void *, const void *, int );
 138 };
 139
 140 VLC_EXPORT( ssize_t, net_Read, ( vlc_object_t *p_this, int fd, const v_socket_t *, void *p_data, size_t i_data, bool b_retry ) );
 141 #define net_Read(a,b,c,d,e,f) net_Read(VLC_OBJECT(a),b,c,d,e,f)
 142 VLC_EXPORT( ssize_t, net_Write, ( vlc_object_t *p_this, int fd, const v_socket_t *, const void *p_data, size_t i_data ) );
 143 #define net_Write(a,b,c,d,e) net_Write(VLC_OBJECT(a),b,c,d,e)
 144 VLC_EXPORT( char *, net_Gets, ( vlc_object_t *p_this, int fd, const v_socket_t * ) );
 145 #define net_Gets(a,b,c) net_Gets(VLC_OBJECT(a),b,c)
 146
 147
 148 VLC_EXPORT( ssize_t, net_Printf, ( vlc_object_t *p_this, int fd, const v_socket_t *, const char *psz_fmt, ... ) LIBVLC_FORMAT( 4, 5 ) );
 149 #define net_Printf(o,fd,vs,...) net_Printf(VLC_OBJECT(o),fd,vs, __VA_ARGS__)
 150 VLC_EXPORT( ssize_t, net_vaPrintf, ( vlc_object_t *p_this, int fd, const v_socket_t *, const char *psz_fmt, va_list args ) );
 151 #define net_vaPrintf(a,b,c,d,e) net_vaPrintf(VLC_OBJECT(a),b,c,d,e)
 152
 153 VLC_EXPORT (int, vlc_inet_pton, (int af, const char *src, void *dst) );
 154 VLC_EXPORT (const char *, vlc_inet_ntop, (int af, const void *src,
 155                                           char *dst, socklen_t cnt) );
 156 struct pollfd;
 157 VLC_EXPORT (int, vlc_poll, (struct pollfd *fds, unsigned nfds, int timeout));
 158
 159
 160 #ifdef WIN32
 161 /* Microsoft: same semantic, same value, different name... go figure */
 162 # define SHUT_RD SD_RECEIVE
 163 # define SHUT_WR SD_SEND
 164 # define SHUT_RDWR SD_BOTH
 165 # define net_Close( fd ) closesocket ((SOCKET)fd)
 166 #else
 167 #ifdef HAVE_UNISTD_H
 168 #include <unistd.h>
 169 #endif
 170 # define net_Close( fd ) (void)close (fd)
 171 #endif
 172
 173 /* Portable network names/addresses resolution layer */
 174
 175 /* GAI error codes */
 176 # ifndef EAI_BADFLAGS
 177 #  define EAI_BADFLAGS -1
 178 # endif
 179 # ifndef EAI_NONAME
 180 #  define EAI_NONAME -2
 181 # endif
 182 # ifndef EAI_AGAIN
 183 #  define EAI_AGAIN -3
 184 # endif
 185 # ifndef EAI_FAIL
 186 #  define EAI_FAIL -4
 187 # endif
 188 # ifndef EAI_NODATA
 189 #  define EAI_NODATA -5
 190 # endif
 191 # ifndef EAI_FAMILY
 192 #  define EAI_FAMILY -6
 193 # endif
 194 # ifndef EAI_SOCKTYPE
 195 #  define EAI_SOCKTYPE -7
 196 # endif
 197 # ifndef EAI_SERVICE
 198 #  define EAI_SERVICE -8
 199 # endif
 200 # ifndef EAI_ADDRFAMILY
 201 #  define EAI_ADDRFAMILY -9
 202 # endif
 203 # ifndef EAI_MEMORY
 204 #  define EAI_MEMORY -10
 205 # endif
 206 #ifndef EAI_OVERFLOW
 207 #  define EAI_OVERFLOW -11
 208 #endif
 209 # ifndef EAI_SYSTEM
 210 #  define EAI_SYSTEM -12
 211 # endif
 212
 213
 214 # ifndef NI_MAXHOST
 215 #  define NI_MAXHOST 1025
 216 #  define NI_MAXSERV 32
 217 # endif
 218 # define NI_MAXNUMERICHOST 64
 219
 220 # ifndef NI_NUMERICHOST
 221 #  define NI_NUMERICHOST 0x01
 222 #  define NI_NUMERICSERV 0x02
 223 #  define NI_NOFQDN      0x04
 224 #  define NI_NAMEREQD    0x08
 225 #  define NI_DGRAM       0x10
 226 # endif
 227
 228 # ifndef HAVE_STRUCT_ADDRINFO
 229 struct addrinfo
 230 {
 231     int ai_flags;
 232     int ai_family;
 233     int ai_socktype;
 234     int ai_protocol;
 235     size_t ai_addrlen;
 236     struct sockaddr *ai_addr;
 237     char *ai_canonname;
 238     struct addrinfo *ai_next;
 239 };
 240 #  define AI_PASSIVE     1
 241 #  define AI_CANONNAME   2
 242 #  define AI_NUMERICHOST 4
 243 # endif /* if !HAVE_STRUCT_ADDRINFO */
 244
 245 #ifndef AI_NUMERICSERV
 246 # define AI_NUMERICSERV 0
 247 #endif
 248
 249 VLC_EXPORT( const char *, vlc_gai_strerror, ( int ) );
 250 VLC_EXPORT( int, vlc_getnameinfo, ( const struct sockaddr *, int, char *, int, int *, int ) );
 251 VLC_EXPORT( int, vlc_getaddrinfo, ( vlc_object_t *, const char *, int, const struct addrinfo *, struct addrinfo ** ) );
 252 VLC_EXPORT( void, vlc_freeaddrinfo, ( struct addrinfo * ) );
 253
 254
 255 static inline bool
 256 net_SockAddrIsMulticast (const struct sockaddr *addr, socklen_t len)
 257 {
 258     switch (addr->sa_family)
 259     {
 260 #ifdef IN_MULTICAST
 261         case AF_INET:
 262         {
 263             const struct sockaddr_in *v4 = (const struct sockaddr_in *)addr;
 264             if ((size_t)len < sizeof (*v4))
 265                 return false;
 266             return IN_MULTICAST (ntohl (v4->sin_addr.s_addr)) != 0;
 267         }
 268 #endif
 269
 270 #ifdef IN6_IS_ADDR_MULTICAST
 271         case AF_INET6:
 272         {
 273             const struct sockaddr_in6 *v6 = (const struct sockaddr_in6 *)addr;
 274             if ((size_t)len < sizeof (*v6))
 275                 return false;
 276             return IN6_IS_ADDR_MULTICAST (&v6->sin6_addr) != 0;
 277         }
 278 #endif
 279     }
 280
 281     return false;
 282 }
 283
 284
 285 static inline int net_GetSockAddress( int fd, char *address, int *port )
 286 {
 287     struct sockaddr_storage addr;
 288     socklen_t addrlen = sizeof( addr );
 289
 290     return getsockname( fd, (struct sockaddr *)&addr, &addrlen )
 291         || vlc_getnameinfo( (struct sockaddr *)&addr, addrlen, address,
 292                             NI_MAXNUMERICHOST, port, NI_NUMERICHOST )
 293         ? VLC_EGENERIC : 0;
 294 }
 295
 296 static inline int net_GetPeerAddress( int fd, char *address, int *port )
 297 {
 298     struct sockaddr_storage addr;
 299     socklen_t addrlen = sizeof( addr );
 300
 301     return getpeername( fd, (struct sockaddr *)&addr, &addrlen )
 302         || vlc_getnameinfo( (struct sockaddr *)&addr, addrlen, address,
 303                             NI_MAXNUMERICHOST, port, NI_NUMERICHOST )
 304         ? VLC_EGENERIC : 0;
 305 }
 306
 307 static inline uint16_t net_GetPort (const struct sockaddr *addr)
 308 {
 309     switch (addr->sa_family)
 310     {
 311 #ifdef AF_INET6
 312         case AF_INET6:
 313             return ((const struct sockaddr_in6 *)addr)->sin6_port;
 314 #endif
 315         case AF_INET:
 316             return ((const struct sockaddr_in *)addr)->sin_port;
 317     }
 318     return 0;
 319 }
 320
 321 static inline void net_SetPort (struct sockaddr *addr, uint16_t port)
 322 {
 323     switch (addr->sa_family)
 324     {
 325 #ifdef AF_INET6
 326         case AF_INET6:
 327             ((struct sockaddr_in6 *)addr)->sin6_port = port;
 328         break;
 329 #endif
 330         case AF_INET:
 331             ((struct sockaddr_in *)addr)->sin_port = port;
 332         break;
 333     }
 334 }
 335 # ifdef __cplusplus
 336 }
 337 # endif
 338
 339 #endif