vlc_network.h 10.4 KB
Newer Older
Sam Hocevar's avatar
 
Sam Hocevar committed
1
/*****************************************************************************
zorglub's avatar
zorglub 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
zorglub's avatar
zorglub committed
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
dionoea's avatar
dionoea committed
24
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
Sam Hocevar's avatar
 
Sam Hocevar committed
25
26
 *****************************************************************************/

zorglub's avatar
zorglub 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
#if defined( WIN32 )
35
#   if !defined(UNDER_CE)
36
#       define _NO_OLDNAMES 1
gbazin's avatar
gbazin committed
37
38
#       include <io.h>
#   endif
damienf's avatar
damienf committed
39
#   include <winsock2.h>
40
#   include <ws2tcpip.h>
gbazin's avatar
gbazin committed
41
#   define ENETUNREACH WSAENETUNREACH
42
#   define net_errno (WSAGetLastError())
43
#   define AI_NUMERICSERV 0
44
extern const char *net_strerror( int val );
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62

struct iovec
{
    void  *iov_base;
    size_t iov_len;
};

struct msghdr
{
    void         *msg_name;
    size_t        msg_namelen;
    struct iovec *msg_iov;
    size_t        msg_iovlen;
    void         *msg_control;
    size_t        msg_controllen;
    int           msg_flags;
};

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
63
64
#define sendmsg vlc_sendmsg
#define recvmsg vlc_recvmsg
65

66
#   ifndef IPV6_V6ONLY
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
67
#       define IPV6_V6ONLY 27
68
#   endif
69
#else
70
#   include <sys/socket.h>
71
#   ifdef HAVE_NETINET_IN_H
72
73
#      include <netinet/in.h>
#   endif
74
#   ifdef HAVE_ARPA_INET_H
75
76
77
78
#      include <arpa/inet.h>
#   elif defined( SYS_BEOS )
#      include <net/netdb.h>
#   endif
79
#   include <netdb.h>
80
#   define net_errno errno
81
82
#endif

83
84
85
VLC_EXPORT( ssize_t, vlc_sendmsg, ( int, struct msghdr *, int ) );
VLC_EXPORT( ssize_t, vlc_recvmsg, ( int, struct msghdr *, int ) );

86
87
88
# ifdef __cplusplus
extern "C" {
# endif
89

90
/* Portable networking layer communication */
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
91
int net_Socket (vlc_object_t *obj, int family, int socktype, int proto);
92
int net_SetupSocket (int fd);
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
93

94
#define net_Connect(a, b, c, d, e) __net_Connect(VLC_OBJECT(a), b, c, d, e)
95
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
96

97
VLC_EXPORT( int *, net_Listen, (vlc_object_t *p_this, const char *psz_host, int i_port, int protocol) );
98

99
#define net_ListenTCP(a, b, c) net_Listen(VLC_OBJECT(a), b, c, IPPROTO_TCP)
100
101
102
103
104
105
106
#define net_ConnectTCP(a, b, c) __net_ConnectTCP(VLC_OBJECT(a), b, c)

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

107
108
109

VLC_EXPORT( int, net_AcceptSingle, (vlc_object_t *obj, int lfd) );

110
#define net_Accept(a, b, c) __net_Accept(VLC_OBJECT(a), b, c)
111
VLC_EXPORT( int, __net_Accept, ( vlc_object_t *, int *, mtime_t ) );
112

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
113
114
115
116
117
#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
118
    return net_ConnectDgram (obj, host, port, hlim, IPPROTO_UDP);
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
119
}
120

121
122
123
#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 ) );

Rémi Denis-Courmont's avatar
Cleanup    
Rémi Denis-Courmont committed
124
125
static inline int net_ListenUDP1 (vlc_object_t *obj, const char *host, int port)
{
126
    return net_OpenDgram (obj, host, port, NULL, 0, 0, IPPROTO_UDP);
Rémi Denis-Courmont's avatar
Cleanup    
Rémi Denis-Courmont committed
127
}
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
128

129
VLC_EXPORT( void, net_ListenClose, ( int *fd ) );
Laurent Aimar's avatar
   
Laurent Aimar committed
130

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
131
132
int net_Subscribe (vlc_object_t *obj, int fd, const struct sockaddr *addr,
                   socklen_t addrlen);
Laurent Aimar's avatar
   
Laurent Aimar committed
133

134
135
VLC_EXPORT( int, net_SetCSCov, ( int fd, int sendcov, int recvcov ) );

136
137
138
139
140
141
142
143
144
/* 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)
145
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, bool b_retry ) );
zorglub's avatar
zorglub committed
146

147
#define net_Write(a,b,c,d,e) __net_Write(VLC_OBJECT(a),b,c,d,e)
148
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
149

150
#define net_Gets(a,b,c) __net_Gets(VLC_OBJECT(a),b,c)
151
VLC_EXPORT( char *, __net_Gets, ( vlc_object_t *p_this, int fd, const v_socket_t * ) );
Laurent Aimar's avatar
   
Laurent Aimar committed
152

153
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 ) );
Laurent Aimar's avatar
   
Laurent Aimar committed
154

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

158

159
/* Don't go to an extra call layer if we have the symbol */
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
160
#ifndef HAVE_INET_PTON
161
#define inet_pton vlc_inet_pton
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
162
#endif
163
#ifndef HAVE_INET_NTOP
164
#define inet_ntop vlc_inet_ntop
165
166
#endif

167
168
169
170
VLC_EXPORT (int, vlc_inet_pton, (int af, const char *src, void *dst) );
VLC_EXPORT (const char *, vlc_inet_ntop, (int af, const void *src,
                                          char *dst, socklen_t cnt) );

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
171
172
173
174
175
#ifndef HAVE_POLL
enum
{
    POLLIN=1,
    POLLOUT=2,
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
176
    POLLPRI=4,
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
177
178
179
180
181
182
183
    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
184
185
186
    int fd;
    int events;
    int revents;
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
187
188
};

189
  VLC_EXPORT (int, poll, (struct pollfd *fds, unsigned nfds, int timeout));
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
190
191
#endif

192
#ifdef WIN32
193
194
195
/* Microsoft: same semantic, same value, different name... go figure */
# define SHUT_RD SD_RECEIVE
# define SHUT_WR SD_SEND
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
196
# define SHUT_RDWR SD_BOTH
197
198
# define net_Close( fd ) closesocket ((SOCKET)fd)
#else
199
200
201
#ifdef HAVE_UNISTD_H
#include <unistd.h>
#endif
202
# define net_Close( fd ) (void)close (fd)
203
204
#endif

205
206
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
/* 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
Rémi Denis-Courmont's avatar
Fixups    
Rémi Denis-Courmont committed
238
239
240
#ifndef EAI_OVERFLOW
#  define EAI_OVERFLOW -11
#endif
241
# ifndef EAI_SYSTEM
Rémi Denis-Courmont's avatar
Fixups    
Rémi Denis-Courmont committed
242
#  define EAI_SYSTEM -12
243
244
245
246
247
248
249
# endif


# ifndef NI_MAXHOST
#  define NI_MAXHOST 1025
#  define NI_MAXSERV 32
# endif
250
# define NI_MAXNUMERICHOST 64
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
277

# 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 ) );
278
VLC_EXPORT( int, vlc_getnameinfo, ( const struct sockaddr *, int, char *, int, int *, int ) );
279
VLC_EXPORT( int, vlc_getaddrinfo, ( vlc_object_t *, const char *, int, const struct addrinfo *, struct addrinfo ** ) );
280
281
VLC_EXPORT( void, vlc_freeaddrinfo, ( struct addrinfo * ) );

282

283
static inline bool
284
285
286
287
288
289
290
net_SockAddrIsMulticast (const struct sockaddr *addr, socklen_t len)
{
    switch (addr->sa_family)
    {
#ifdef IN_MULTICAST
        case AF_INET:
        {
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
291
            const struct sockaddr_in *v4 = (const struct sockaddr_in *)addr;
292
            if ((size_t)len < sizeof (*v4))
293
                return false;
294
            return IN_MULTICAST (ntohl (v4->sin_addr.s_addr)) != 0;
295
296
297
298
299
300
        }
#endif

#ifdef IN6_IS_ADDR_MULTICAST
        case AF_INET6:
        {
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
301
            const struct sockaddr_in6 *v6 = (const struct sockaddr_in6 *)addr;
302
            if ((size_t)len < sizeof (*v6))
303
                return false;
304
305
306
307
308
            return IN6_IS_ADDR_MULTICAST (&v6->sin6_addr) != 0;
        }
#endif
    }

309
    return false;
310
311
312
}


313
static inline int net_GetSockAddress( int fd, char *address, int *port )
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
314
315
316
317
{
    struct sockaddr_storage addr;
    socklen_t addrlen = sizeof( addr );

318
    return getsockname( fd, (struct sockaddr *)&addr, &addrlen )
319
320
321
322
        || 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
323

324
325
326
327
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
328

329
330
331
332
    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
333
334
}

335
336
337
338
339
340
341
342
343
344
345
346
347
348
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;
}

349
350
351
352
353
354
355
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;
356
        break;
357
358
359
#endif
        case AF_INET:
            ((struct sockaddr_in *)addr)->sin_port = port;
360
        break;
361
362
    }
}
363
364
365
366
# ifdef __cplusplus
}
# endif

367
#endif