vlc_network.h 10.4 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
 *****************************************************************************/

27 28
#ifndef VLC_NETWORK_H
# define VLC_NETWORK_H
29

30
#if defined( WIN32 )
31
#   if !defined(UNDER_CE)
32
#       define _NO_OLDNAMES 1
33 34
#       include <io.h>
#   endif
35
#   include <winsock2.h>
36
#   include <ws2tcpip.h>
37
#   define ENETUNREACH WSAENETUNREACH
38 39
#   define net_errno (WSAGetLastError())
extern const char *net_strerror( int val );
40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57

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
58 59
#define sendmsg vlc_sendmsg
#define recvmsg vlc_recvmsg
60

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

78 79 80
VLC_EXPORT( ssize_t, vlc_sendmsg, ( int, struct msghdr *, int ) );
VLC_EXPORT( ssize_t, vlc_recvmsg, ( int, struct msghdr *, int ) );

81 82 83
# ifdef __cplusplus
extern "C" {
# endif
84

85
/* Portable networking layer communication */
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
86
int net_Socket (vlc_object_t *obj, int family, int socktype, int proto);
87
int net_SetupSocket (int fd);
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
88

89
#define net_Connect(a, b, c, d, e) __net_Connect(VLC_OBJECT(a), b, c, d, e)
90
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
91

92
VLC_EXPORT( int *, net_Listen, (vlc_object_t *p_this, const char *psz_host, int i_port, int protocol) );
93

94
#define net_ListenTCP(a, b, c) net_Listen(VLC_OBJECT(a), b, c, IPPROTO_TCP)
95 96 97 98 99 100 101
#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);
}

102 103 104

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

105
#define net_Accept(a, b, c) __net_Accept(VLC_OBJECT(a), b, c)
106
VLC_EXPORT( int, __net_Accept, ( vlc_object_t *, int *, mtime_t ) );
107

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
108 109 110 111 112
#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
113
    return net_ConnectDgram (obj, host, port, hlim, IPPROTO_UDP);
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
114
}
115

116 117 118
#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
119 120
static inline int net_ListenUDP1 (vlc_object_t *obj, const char *host, int port)
{
121
    return net_OpenDgram (obj, host, port, NULL, 0, 0, IPPROTO_UDP);
Rémi Denis-Courmont's avatar
Cleanup  
Rémi Denis-Courmont committed
122
}
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
123

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

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

129 130
VLC_EXPORT( int, net_SetCSCov, ( int fd, int sendcov, int recvcov ) );

131 132 133 134 135 136 137 138 139
/* 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)
140
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 ) );
141

142
#define net_Write(a,b,c,d,e) __net_Write(VLC_OBJECT(a),b,c,d,e)
143
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
144

145
#define net_Gets(a,b,c) __net_Gets(VLC_OBJECT(a),b,c)
146
VLC_EXPORT( char *, __net_Gets, ( vlc_object_t *p_this, int fd, const v_socket_t * ) );
Laurent Aimar's avatar
 
Laurent Aimar committed
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 ) );
Laurent Aimar's avatar
 
Laurent Aimar committed
149

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

153

154
/* Don't go to an extra call layer if we have the symbol */
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
155
#ifndef HAVE_INET_PTON
156
#define inet_pton vlc_inet_pton
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
157
#endif
158
#ifndef HAVE_INET_NTOP
159
#define inet_ntop vlc_inet_ntop
160 161
#endif

162 163 164 165
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
166 167 168 169 170
#ifndef HAVE_POLL
enum
{
    POLLIN=1,
    POLLOUT=2,
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
171
    POLLPRI=4,
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
172 173 174 175 176 177 178
    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
179 180 181
    int fd;
    int events;
    int revents;
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
182
};
183
# define poll(a, b, c) vlc_poll(a, b, c)
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
184
#endif
185 186 187
struct pollfd;
VLC_EXPORT (int, vlc_poll, (struct pollfd *fds, unsigned nfds, int timeout));

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

189
#ifdef WIN32
190 191 192
/* 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
193
# define SHUT_RDWR SD_BOTH
194 195
# define net_Close( fd ) closesocket ((SOCKET)fd)
#else
196 197 198
#ifdef HAVE_UNISTD_H
#include <unistd.h>
#endif
199
# define net_Close( fd ) (void)close (fd)
200 201
#endif

202 203 204 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
/* 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
235 236 237
#ifndef EAI_OVERFLOW
#  define EAI_OVERFLOW -11
#endif
238
# ifndef EAI_SYSTEM
Rémi Denis-Courmont's avatar
Fixups  
Rémi Denis-Courmont committed
239
#  define EAI_SYSTEM -12
240 241 242 243 244 245 246
# endif


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

# 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 */

274
#ifndef AI_NUMERICSERV
275
# define AI_NUMERICSERV 0
276 277
#endif

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

283

284
static inline bool
285 286 287 288 289 290 291
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
292
            const struct sockaddr_in *v4 = (const struct sockaddr_in *)addr;
293
            if ((size_t)len < sizeof (*v4))
294
                return false;
295
            return IN_MULTICAST (ntohl (v4->sin_addr.s_addr)) != 0;
296 297 298 299 300 301
        }
#endif

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

310
    return false;
311 312 313
}


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

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

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

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

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

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

368
#endif