vlc_network.h 11.8 KB
Newer Older
Sam Hocevar's avatar
 
Sam Hocevar committed
1
/*****************************************************************************
Clément Stenac's avatar
Clément Stenac committed
2
 * vlc_network.h: interface to communicate with network plug-ins
Sam Hocevar's avatar
 
Sam Hocevar committed
3
 *****************************************************************************
4
 * Copyright (C) 2002-2005 the VideoLAN team
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
5
 * Copyright © 2006-2007 Rémi Denis-Courmont
6
 * $Id$
Sam Hocevar's avatar
 
Sam Hocevar committed
7
 *
8
 * Authors: Christophe Massiot <massiot@via.ecp.fr>
9
 *          Laurent Aimar <fenrir@via.ecp.fr>
10
 *          Rémi Denis-Courmont <rem # videolan.org>
Sam Hocevar's avatar
 
Sam Hocevar committed
11 12 13 14 15 16 17 18 19 20 21 22 23
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
Antoine Cellerier's avatar
Antoine Cellerier committed
24
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
Sam Hocevar's avatar
 
Sam Hocevar committed
25 26
 *****************************************************************************/

Clément Stenac's avatar
Clément Stenac committed
27 28 29 30
#if !defined( __LIBVLC__ )
  #error You are not libvlc or one of its plugins. You cannot include this file
#endif

31 32
#ifndef __VLC_NETWORK_H
# define __VLC_NETWORK_H
33

34 35 36 37
#if defined( WIN32 )
#   if defined(UNDER_CE) && defined(sockaddr_storage)
#       undef sockaddr_storage
#   endif
38 39 40
#   if defined(UNDER_CE)
#       define HAVE_STRUCT_ADDRINFO
#   else
41
#       define _NO_OLDNAMES 1
42 43
#       include <io.h>
#   endif
44
#   include <winsock2.h>
45
#   include <ws2tcpip.h>
46
#   define ENETUNREACH WSAENETUNREACH
47 48
#   define net_errno (WSAGetLastError())
extern const char *net_strerror( int val );
49
#else
50 51 52 53 54 55 56 57 58 59 60
#   if HAVE_SYS_SOCKET_H
#      include <sys/socket.h>
#   endif
#   if HAVE_NETINET_IN_H
#      include <netinet/in.h>
#   endif
#   if HAVE_ARPA_INET_H
#      include <arpa/inet.h>
#   elif defined( SYS_BEOS )
#      include <net/netdb.h>
#   endif
61
#   include <netdb.h>
62 63
#   define net_errno errno
#   define net_strerror strerror
64 65
#endif

66 67 68
# ifdef __cplusplus
extern "C" {
# endif
69

70
/* Portable networking layer communication */
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
71
int net_Socket (vlc_object_t *obj, int family, int socktype, int proto);
72
int net_SetupSocket (int fd);
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
73

74
#define net_Connect(a, b, c, d, e) __net_Connect(VLC_OBJECT(a), b, c, d, e)
75
VLC_EXPORT( int, __net_Connect, (vlc_object_t *p_this, const char *psz_host, int i_port, int socktype, int protocol) );
Laurent Aimar's avatar
 
Laurent Aimar committed
76

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
77
VLC_EXPORT( int *, net_Listen, (vlc_object_t *p_this, const char *psz_host, int i_port, int family, int socktype, int protocol) );
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
78
VLC_EXPORT( int, net_ListenSingle, (vlc_object_t *p_this, const char *psz_host, int i_port, int family, int socktype, int protocol) );
79

80
#define net_ListenTCP(a, b, c) __net_ListenTCP(VLC_OBJECT(a), b, c)
81 82 83
#define net_ConnectTCP(a, b, c) __net_ConnectTCP(VLC_OBJECT(a), b, c)

static inline int *__net_ListenTCP (vlc_object_t *obj, const char *host, int port)
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
84 85 86
{
    return net_Listen (obj, host, port, AF_UNSPEC, SOCK_STREAM, IPPROTO_TCP);
}
87

88 89 90 91 92
static inline int __net_ConnectTCP (vlc_object_t *obj, const char *host, int port)
{
    return __net_Connect (obj, host, port, SOCK_STREAM, IPPROTO_TCP);
}

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

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
96 97 98 99 100
#define net_ConnectDgram(a, b, c, d, e ) __net_ConnectDgram(VLC_OBJECT(a), b, c, d, e)
VLC_EXPORT( int, __net_ConnectDgram, ( vlc_object_t *p_this, const char *psz_host, int i_port, int hlim, int proto ) );

static inline int net_ConnectUDP (vlc_object_t *obj, const char *host, int port, int hlim)
{
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
101
    return net_ConnectDgram (obj, host, port, hlim, IPPROTO_UDP);
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
102
}
103

Rémi Denis-Courmont's avatar
Cleanup  
Rémi Denis-Courmont committed
104 105
static inline int net_ListenUDP1 (vlc_object_t *obj, const char *host, int port)
{
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
106
    return net_ListenSingle (obj, host, port, AF_UNSPEC, SOCK_DGRAM, 0);
Rémi Denis-Courmont's avatar
Cleanup  
Rémi Denis-Courmont committed
107
}
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
108

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
109 110
#define net_OpenDgram( a, b, c, d, e, g, h ) __net_OpenDgram(VLC_OBJECT(a), b, c, d, e, g, h)
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 ) );
Laurent Aimar's avatar
Laurent Aimar committed
111

Laurent Aimar's avatar
 
Laurent Aimar committed
112
VLC_EXPORT( void, net_Close, ( int fd ) );
113
VLC_EXPORT( void, net_ListenClose, ( int *fd ) );
Laurent Aimar's avatar
 
Laurent Aimar committed
114

115
VLC_EXPORT( int, net_SetDSCP, ( int fd, uint8_t dscp ) );
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
116 117
int net_Subscribe (vlc_object_t *obj, int fd, const struct sockaddr *addr,
                   socklen_t addrlen);
Laurent Aimar's avatar
 
Laurent Aimar committed
118

119 120 121 122 123 124 125 126 127
/* Functions to read from or write to the networking layer */
struct virtual_socket_t
{
    void *p_sys;
    int (*pf_recv) ( void *, void *, int );
    int (*pf_send) ( void *, const void *, int );
};

#define net_Read(a,b,c,d,e,f) __net_Read(VLC_OBJECT(a),b,c,d,e,f)
128
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 ) );
129

130 131
#define net_Select(a,b,c,d,e) __net_Select(VLC_OBJECT(a),b,c,d,e)
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 ) );
Clément Stenac's avatar
Clément Stenac committed
132

133
#define net_Write(a,b,c,d,e) __net_Write(VLC_OBJECT(a),b,c,d,e)
134
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 ) );
Laurent Aimar's avatar
 
Laurent Aimar committed
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 * ) );
Laurent Aimar's avatar
 
Laurent Aimar committed
138

139
VLC_EXPORT( ssize_t, net_Printf, ( vlc_object_t *p_this, int fd, const v_socket_t *, const char *psz_fmt, ... ) );
Laurent Aimar's avatar
 
Laurent Aimar committed
140

141
#define net_vaPrintf(a,b,c,d,e) __net_vaPrintf(VLC_OBJECT(a),b,c,d,e)
142
VLC_EXPORT( ssize_t, __net_vaPrintf, ( vlc_object_t *p_this, int fd, const v_socket_t *, const char *psz_fmt, va_list args ) );
143

144

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
145
#ifndef HAVE_INET_PTON
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
146
/* only in core, so no need for C++ extern "C" */
147
VLC_EXPORT (int, inet_pton, (int af, const char *src, void *dst) );
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
148 149
#endif

150 151 152 153 154 155 156 157
#ifndef HAVE_INET_NTOP
#ifdef WIN32
/* only in core, so no need for C++ extern "C" */
VLC_EXPORT (const char *, inet_ntop, (int af, const void *src, 
                                      char *dst, socklen_t cnt) );
#endif
#endif

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
158 159 160 161 162
#ifndef HAVE_POLL
enum
{
    POLLIN=1,
    POLLOUT=2,
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
163
    POLLPRI=4,
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
164 165 166 167 168 169 170
    POLLERR=8,  // unsupported stub
    POLLHUP=16, // unsupported stub
    POLLNVAL=32 // unsupported stub
};

struct pollfd
{
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
171 172 173
    int fd;
    int events;
    int revents;
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
174 175 176 177 178
};

int poll (struct pollfd *fds, unsigned nfds, int timeout);
#endif

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
179

180 181 182 183 184 185 186
/*****************************************************************************
 * net_StopRecv/Send
 *****************************************************************************
 * Wrappers for shutdown()
 *****************************************************************************/
#if defined (SHUT_WR)
/* the standard way */
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
187 188
# define net_StopSend( fd ) (void)shutdown( fd, SHUT_WR )
# define net_StopRecv( fd ) (void)shutdown( fd, SHUT_RD )
189 190
#elif defined (SD_SEND)
/* the Microsoft seemingly-purposedly-different-for-the-sake-of-it way */
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
191 192
# define net_StopSend( fd ) (void)shutdown( fd, SD_SEND )
# define net_StopRecv( fd ) (void)shutdown( fd, SD_RECEIVE )
193
#else
Eric Petit's avatar
Eric Petit committed
194 195 196
# ifndef SYS_BEOS /* R5 just doesn't have a working shutdown() */
#  warning FIXME: implement shutdown on your platform!
# endif
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
197 198
# define net_StopSend( fd ) (void)0
# define net_StopRecv( fd ) (void)0
199
#endif
200

201 202 203 204 205 206
#ifdef WIN32
# define net_Close( fd ) closesocket ((SOCKET)fd)
#else
# define net_Close( fd ) close (fd)
#endif

207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248
/* Portable network names/addresses resolution layer */

/* GAI error codes */
# ifndef EAI_BADFLAGS
#  define EAI_BADFLAGS -1
# endif
# ifndef EAI_NONAME
#  define EAI_NONAME -2
# endif
# ifndef EAI_AGAIN
#  define EAI_AGAIN -3
# endif
# ifndef EAI_FAIL
#  define EAI_FAIL -4
# endif
# ifndef EAI_NODATA
#  define EAI_NODATA -5
# endif
# ifndef EAI_FAMILY
#  define EAI_FAMILY -6
# endif
# ifndef EAI_SOCKTYPE
#  define EAI_SOCKTYPE -7
# endif
# ifndef EAI_SERVICE
#  define EAI_SERVICE -8
# endif
# ifndef EAI_ADDRFAMILY
#  define EAI_ADDRFAMILY -9
# endif
# ifndef EAI_MEMORY
#  define EAI_MEMORY -10
# endif
# ifndef EAI_SYSTEM
#  define EAI_SYSTEM -11
# endif


# ifndef NI_MAXHOST
#  define NI_MAXHOST 1025
#  define NI_MAXSERV 32
# endif
249
# define NI_MAXNUMERICHOST 64
250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276

# ifndef NI_NUMERICHOST
#  define NI_NUMERICHOST 0x01
#  define NI_NUMERICSERV 0x02
#  define NI_NOFQDN      0x04
#  define NI_NAMEREQD    0x08
#  define NI_DGRAM       0x10
# endif

# ifndef HAVE_STRUCT_ADDRINFO
struct addrinfo
{
    int ai_flags;
    int ai_family;
    int ai_socktype;
    int ai_protocol;
    size_t ai_addrlen;
    struct sockaddr *ai_addr;
    char *ai_canonname;
    struct addrinfo *ai_next;
};
#  define AI_PASSIVE     1
#  define AI_CANONNAME   2
#  define AI_NUMERICHOST 4
# endif /* if !HAVE_STRUCT_ADDRINFO */

VLC_EXPORT( const char *, vlc_gai_strerror, ( int ) );
277
VLC_EXPORT( int, vlc_getnameinfo, ( const struct sockaddr *, int, char *, int, int *, int ) );
278
VLC_EXPORT( int, vlc_getaddrinfo, ( vlc_object_t *, const char *, int, const struct addrinfo *, struct addrinfo ** ) );
279 280
VLC_EXPORT( void, vlc_freeaddrinfo, ( struct addrinfo * ) );

281 282 283 284 285 286 287 288 289 290

static inline vlc_bool_t
net_SockAddrIsMulticast (const struct sockaddr *addr, socklen_t len)
{
    switch (addr->sa_family)
    {
#ifdef IN_MULTICAST
        case AF_INET:
        {
            struct sockaddr_in *v4 = (struct sockaddr_in *)addr;
291
            if ((size_t)len < sizeof (*v4))
292
                return VLC_FALSE;
293
            return IN_MULTICAST (ntohl (v4->sin_addr.s_addr)) != 0;
294 295 296 297 298 299 300
        }
#endif

#ifdef IN6_IS_ADDR_MULTICAST
        case AF_INET6:
        {
            struct sockaddr_in6 *v6 = (struct sockaddr_in6 *)addr;
301
            if ((size_t)len < sizeof (*v6))
302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317
                return VLC_FALSE;
            return IN6_IS_ADDR_MULTICAST (&v6->sin6_addr) != 0;
        }
#endif
    }

    return VLC_FALSE;
}



/**
 * net_AddressIsMulticast
 * @return VLC_FALSE iff the psz_addr does not specify a multicast address,
 * or the address is not a valid address.
 */
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
318
static inline vlc_bool_t net_AddressIsMulticast( vlc_object_t *p_object, const char *psz_addr )
319 320 321
{
    struct addrinfo hints, *res;

322
    memset (&hints, 0, sizeof (hints));
323 324 325
    hints.ai_socktype = SOCK_DGRAM; /* UDP */
    hints.ai_flags = AI_NUMERICHOST;

326 327 328
    int i = vlc_getaddrinfo (p_object, psz_addr, 0,
                             &hints, &res);
    if (i)
329
    {
330 331
        msg_Err (p_object, "invalid address \"%s\" for net_AddressIsMulticast (%s)",
                 psz_addr, vlc_gai_strerror (i));
332
        return VLC_FALSE;
333
    }
334

335 336 337
    vlc_bool_t b = net_SockAddrIsMulticast (res->ai_addr, res->ai_addrlen);
    vlc_freeaddrinfo (res);
    return b;
338 339
}

340
static inline int net_GetSockAddress( int fd, char *address, int *port )
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
341 342 343 344
{
    struct sockaddr_storage addr;
    socklen_t addrlen = sizeof( addr );

345
    return getsockname( fd, (struct sockaddr *)&addr, &addrlen )
346 347 348 349
        || vlc_getnameinfo( (struct sockaddr *)&addr, addrlen, address,
                            NI_MAXNUMERICHOST, port, NI_NUMERICHOST )
        ? VLC_EGENERIC : 0;
}
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
350

351 352 353 354
static inline int net_GetPeerAddress( int fd, char *address, int *port )
{
    struct sockaddr_storage addr;
    socklen_t addrlen = sizeof( addr );
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
355

356 357 358 359
    return getpeername( fd, (struct sockaddr *)&addr, &addrlen )
        || vlc_getnameinfo( (struct sockaddr *)&addr, addrlen, address,
                            NI_MAXNUMERICHOST, port, NI_NUMERICHOST )
        ? VLC_EGENERIC : 0;
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
360 361
}

362 363 364 365 366 367 368 369 370 371 372 373 374 375
static inline uint16_t net_GetPort (const struct sockaddr *addr)
{
    switch (addr->sa_family)
    {
#ifdef AF_INET6
        case AF_INET6:
            return ((const struct sockaddr_in6 *)addr)->sin6_port;
#endif
        case AF_INET:
            return ((const struct sockaddr_in *)addr)->sin_port;
    }
    return 0;
}

376 377 378 379 380 381 382 383 384 385 386 387 388 389
static inline void net_SetPort (struct sockaddr *addr, uint16_t port)
{
    switch (addr->sa_family)
    {
#ifdef AF_INET6
        case AF_INET6:
            ((struct sockaddr_in6 *)addr)->sin6_port = port;
	    break;
#endif
        case AF_INET:
            ((struct sockaddr_in *)addr)->sin_port = port;
	    break;
    }
}
390 391 392 393
# ifdef __cplusplus
}
# endif

394
#endif