vlc_network.h 10.1 KB
Newer Older
Sam Hocevar's avatar
 
Sam Hocevar committed
1
/*****************************************************************************
Christophe Massiot's avatar
Christophe Massiot committed
2
 * 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
5
 * $Id$
Sam Hocevar's avatar
 
Sam Hocevar committed
6
 *
7
 * Authors: Christophe Massiot <massiot@via.ecp.fr>
8
 *          Laurent Aimar <fenrir@via.ecp.fr>
9
 *          Rémi Denis-Courmont <rem # videolan.org>
Sam Hocevar's avatar
 
Sam Hocevar committed
10 11 12 13 14 15 16 17 18 19 20 21 22
 *
 * 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
23
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
Sam Hocevar's avatar
 
Sam Hocevar committed
24 25
 *****************************************************************************/

26 27
#ifndef __VLC_NETWORK_H
# define __VLC_NETWORK_H
28

29 30 31 32
#if defined( WIN32 )
#   if defined(UNDER_CE) && defined(sockaddr_storage)
#       undef sockaddr_storage
#   endif
33 34 35
#   if defined(UNDER_CE)
#       define HAVE_STRUCT_ADDRINFO
#   else
36
#       define _NO_OLDNAMES 1
37 38
#       include <io.h>
#   endif
39
#   include <winsock2.h>
40
#   include <ws2tcpip.h>
41
#   define ENETUNREACH WSAENETUNREACH
42 43
#   define net_errno (WSAGetLastError())
extern const char *net_strerror( int val );
44
#else
45 46 47 48 49 50 51 52 53 54 55
#   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
56
#   include <netdb.h>
57 58
#   define net_errno errno
#   define net_strerror strerror
59 60
#endif

61 62 63
# ifdef __cplusplus
extern "C" {
# endif
64

65
/* Portable networking layer communication */
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
66 67
int net_Socket (vlc_object_t *obj, int family, int socktype, int proto);

68 69 70
#define net_ConnectTCP(a, b, c) __net_ConnectTCP(VLC_OBJECT(a), b, c)
#define net_OpenTCP(a, b, c) __net_ConnectTCP(VLC_OBJECT(a), b, c)
VLC_EXPORT( int, __net_ConnectTCP, ( vlc_object_t *p_this, const char *psz_host, int i_port ) );
Laurent Aimar's avatar
 
Laurent Aimar committed
71

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
72 73
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
74
VLC_EXPORT( int, net_ListenSingle, (vlc_object_t *p_this, const char *psz_host, int i_port, int family, int socktype, int protocol) );
75

76
#define net_ListenTCP(a, b, c) __net_ListenTCP(VLC_OBJECT(a), b, c)
77
VLC_EXPORT( int *, __net_ListenTCP, ( vlc_object_t *, const char *, int ) );
78

79
#define net_Accept(a, b, c) __net_Accept(VLC_OBJECT(a), b, c)
80
VLC_EXPORT( int, __net_Accept, ( vlc_object_t *, int *, mtime_t ) );
81

82 83 84
#define net_ConnectUDP(a, b, c, d ) __net_ConnectUDP(VLC_OBJECT(a), b, c, d)
VLC_EXPORT( int, __net_ConnectUDP, ( vlc_object_t *p_this, const char *psz_host, int i_port, int hlim ) );

Rémi Denis-Courmont's avatar
Cleanup  
Rémi Denis-Courmont committed
85 86 87 88
static inline int net_ListenUDP1 (vlc_object_t *obj, const char *host, int port)
{
	return net_ListenSingle (obj, host, port, AF_UNSPEC, SOCK_DGRAM, IPPROTO_UDP);
}
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
89

Laurent Aimar's avatar
Laurent Aimar committed
90
#define net_OpenUDP(a, b, c, d, e ) __net_OpenUDP(VLC_OBJECT(a), b, c, d, e)
91
VLC_EXPORT( int, __net_OpenUDP, ( vlc_object_t *p_this, const char *psz_bind, int i_bind, const char *psz_server, int i_server ) );
Laurent Aimar's avatar
Laurent Aimar committed
92

Laurent Aimar's avatar
 
Laurent Aimar committed
93
VLC_EXPORT( void, net_Close, ( int fd ) );
94
VLC_EXPORT( void, net_ListenClose, ( int *fd ) );
Laurent Aimar's avatar
 
Laurent Aimar committed
95

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

100 101 102 103 104 105 106 107 108
/* 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)
109
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 ) );
110

111
#define net_ReadNonBlock(a,b,c,d,e,f) __net_ReadNonBlock(VLC_OBJECT(a),b,c,d,e,f)
112
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 ) );
Clément Stenac's avatar
Clément Stenac committed
113

114
#define net_Select(a,b,c,d,e,f,g) __net_Select(VLC_OBJECT(a),b,c,d,e,f,g)
115
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 ) );
Clément Stenac's avatar
Clément Stenac committed
116

117
#define net_Write(a,b,c,d,e) __net_Write(VLC_OBJECT(a),b,c,d,e)
118
VLC_EXPORT( int, __net_Write, ( vlc_object_t *p_this, int fd, const v_socket_t *, const uint8_t *p_data, int i_data ) );
Laurent Aimar's avatar
 
Laurent Aimar committed
119

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

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

125
#define net_vaPrintf(a,b,c,d,e) __net_vaPrintf(VLC_OBJECT(a),b,c,d,e)
126
VLC_EXPORT( int, __net_vaPrintf, ( vlc_object_t *p_this, int fd, const v_socket_t *, const char *psz_fmt, va_list args ) );
127

128

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
129
#ifndef HAVE_INET_PTON
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
130 131 132 133 134
/* only in core, so no need for C++ extern "C" */
int inet_pton(int af, const char *src, void *dst);
#endif


135 136 137 138 139 140 141
/*****************************************************************************
 * net_StopRecv/Send
 *****************************************************************************
 * Wrappers for shutdown()
 *****************************************************************************/
#if defined (SHUT_WR)
/* the standard way */
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
142 143
# define net_StopSend( fd ) (void)shutdown( fd, SHUT_WR )
# define net_StopRecv( fd ) (void)shutdown( fd, SHUT_RD )
144 145
#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
146 147
# define net_StopSend( fd ) (void)shutdown( fd, SD_SEND )
# define net_StopRecv( fd ) (void)shutdown( fd, SD_RECEIVE )
148
#else
Eric Petit's avatar
Eric Petit committed
149 150 151
# 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
152 153
# define net_StopSend( fd ) (void)0
# define net_StopRecv( fd ) (void)0
154
#endif
155

156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197
/* 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
198
# define NI_MAXNUMERICHOST 64
199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225

# 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 ) );
226
VLC_EXPORT( int, vlc_getnameinfo, ( const struct sockaddr *, int, char *, int, int *, int ) );
227
VLC_EXPORT( int, vlc_getaddrinfo, ( vlc_object_t *, const char *, int, const struct addrinfo *, struct addrinfo ** ) );
228 229
VLC_EXPORT( void, vlc_freeaddrinfo, ( struct addrinfo * ) );

230 231 232 233 234 235 236 237 238 239

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;
240
            if ((size_t)len < sizeof (*v4))
241
                return VLC_FALSE;
242
            return IN_MULTICAST (ntohl (v4->sin_addr.s_addr)) != 0;
243 244 245 246 247 248 249
        }
#endif

#ifdef IN6_IS_ADDR_MULTICAST
        case AF_INET6:
        {
            struct sockaddr_in6 *v6 = (struct sockaddr_in6 *)addr;
250
            if ((size_t)len < sizeof (*v6))
251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266
                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
267
static inline vlc_bool_t net_AddressIsMulticast( vlc_object_t *p_object, const char *psz_addr )
268 269 270
{
    struct addrinfo hints, *res;

271
    memset (&hints, 0, sizeof (hints));
272 273 274
    hints.ai_socktype = SOCK_DGRAM; /* UDP */
    hints.ai_flags = AI_NUMERICHOST;

275 276 277
    int i = vlc_getaddrinfo (p_object, psz_addr, 0,
                             &hints, &res);
    if (i)
278
    {
279 280
        msg_Err (p_object, "invalid address \"%s\" for net_AddressIsMulticast (%s)",
                 psz_addr, vlc_gai_strerror (i));
281
        return VLC_FALSE;
282
    }
283

284 285 286
    vlc_bool_t b = net_SockAddrIsMulticast (res->ai_addr, res->ai_addrlen);
    vlc_freeaddrinfo (res);
    return b;
287 288
}

289
static inline int net_GetSockAddress( int fd, char *address, int *port )
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
290 291 292 293
{
    struct sockaddr_storage addr;
    socklen_t addrlen = sizeof( addr );

294
    return getsockname( fd, (struct sockaddr *)&addr, &addrlen )
295 296 297 298
        || 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
299

300 301 302 303
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
304

305 306 307 308
    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
309 310
}

311 312 313 314
# ifdef __cplusplus
}
# endif

315
#endif