su.h 10.7 KB
Newer Older
Pekka Pessi's avatar
Pekka Pessi committed
1 2 3 4 5 6 7
/*
 * This file is part of the Sofia-SIP package
 *
 * Copyright (C) 2005 Nokia Corporation.
 *
 * Contact: Pekka Pessi <pekka.pessi@nokia.com>
 *
8
 * This library is free software; you can redistribute it and/or
Pekka Pessi's avatar
Pekka Pessi committed
9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24
 * modify it under the terms of the GNU Lesser General Public License
 * as published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This library 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA
 *
 */

Pekka Pessi's avatar
Pekka Pessi committed
25 26
#ifndef SU_H
/** Defined when <sofia-sip/su.h> has been included. */
Pekka Pessi's avatar
Pekka Pessi committed
27
#define SU_H
Pekka Pessi's avatar
Pekka Pessi committed
28
/**@ingroup su_socket 
Pekka Pessi's avatar
Pekka Pessi committed
29
 * @file sofia-sip/su.h Socket and network address interface
Pekka Pessi's avatar
Pekka Pessi committed
30 31 32 33 34 35 36 37 38 39
 *
 * @author Pekka Pessi <Pekka.Pessi@nokia.com>
 * 
 * @date Created: Thu Mar 18 19:40:51 1999 pessi
 */

/* ---------------------------------------------------------------------- */
/* Includes */

#ifndef SU_CONFIG_H
40
#include "sofia-sip/su_config.h"
Pekka Pessi's avatar
Pekka Pessi committed
41 42
#endif
#ifndef SU_TYPES_H
43
#include "sofia-sip/su_types.h"
Pekka Pessi's avatar
Pekka Pessi committed
44
#endif
Pekka Pessi's avatar
Pekka Pessi committed
45
#ifndef SU_ERRNO_H
46
#include <sofia-sip/su_errno.h>
Pekka Pessi's avatar
Pekka Pessi committed
47
#endif
Pekka Pessi's avatar
Pekka Pessi committed
48 49 50

#include <stdio.h>

51 52
SOFIA_BEGIN_DECLS

Pekka Pessi's avatar
Pekka Pessi committed
53 54 55
#if SU_HAVE_BSDSOCK		/* Unix-compatible includes */
#include <errno.h>
#include <unistd.h>
56
#include <limits.h>
Pekka Pessi's avatar
Pekka Pessi committed
57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89

#include <fcntl.h>
#include <sys/types.h>
#include <sys/socket.h>
#include <sys/ioctl.h>

#include <netinet/in.h>
#include <arpa/inet.h>
#include <netdb.h>
#endif

#if SU_HAVE_WINSOCK		/* Windows includes */
#  include <winsock2.h>
#  include <ws2tcpip.h>

static __inline
uint16_t su_ntohs(uint16_t s)
{
  return (uint16_t)(((s & 255) << 8) | ((s & 0xff00) >> 8));
}

static __inline
uint32_t su_ntohl(uint32_t l)
{
  return ((l & 0xff) << 24) | ((l & 0xff00) << 8)
       | ((l & 0xff0000) >> 8) | ((l & 0xff000000U) >> 24);
}

#define ntohs su_ntohs
#define htons su_ntohs
#define ntohl su_ntohl
#define htonl su_ntohl

90 91 92 93
#  if defined(IPPROTO_IPV6)
/* IPv6 defined in ws2tcpip.h */
#  elif SU_HAVE_IN6 
#    include <tpipv6.h>		/* From "IPv6 Tech Preview"  */
Pekka Pessi's avatar
Pekka Pessi committed
94
#  else
95
#    error Winsock with IPv6 support required
Pekka Pessi's avatar
Pekka Pessi committed
96
#  endif
Pekka Pessi's avatar
Pekka Pessi committed
97

98 99
#include <limits.h>

Pekka Pessi's avatar
Pekka Pessi committed
100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149
#endif

/* ---------------------------------------------------------------------- */
/* Constant definitions */

#if SU_HAVE_BSDSOCK || DOCUMENTATION_ONLY
enum {
  /** Invalid socket descriptor */ 
  INVALID_SOCKET = -1,
  /** Error from su_socket() call */
  SOCKET_ERROR = -1,

  /** Return code for a successful call */
  su_success = 0, 
  /** Return code for an unsuccessful call */
  su_failure = -1
};
#elif SU_HAVE_WINSOCK
enum { 
  su_success = 0, 
  su_failure = 0xffffffffUL 
};

#define MSG_NOSIGNAL (0)

#endif

/**@HI Maximum size of host name. */
#define SU_MAXHOST (1025)
/**@HI Maximum size of service name. */
#define SU_MAXSERV (25)

/**@HI Maximum size of address in text format. */
#define SU_ADDRSIZE (48)
/**@HI Maximum size of port number in text format. */
#define SU_SERVSIZE (16)

#define SU_SUCCESS su_success
#define SU_FAILURE su_failure

/* ---------------------------------------------------------------------- */
/* Type definitions */

/** Socket descriptor type. */
#if SU_HAVE_BSDSOCK || DOCUMENTATION_ONLY
typedef int su_socket_t;
#elif SU_HAVE_WINSOCK
typedef SOCKET su_socket_t;
#endif

150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172
#if !SU_HAVE_SOCKADDR_STORAGE
/*
 * RFC 2553: protocol-independent placeholder for socket addresses
 */
#define _SS_MAXSIZE	128
#define _SS_ALIGNSIZE	(sizeof(int64_t))
#define _SS_PAD1SIZE	(_SS_ALIGNSIZE - sizeof(u_char) * 2)
#define _SS_PAD2SIZE	(_SS_MAXSIZE - sizeof(u_char) * 2 - \
				_SS_PAD1SIZE - _SS_ALIGNSIZE)

struct sockaddr_storage {
#if SU_HAVE_SOCKADDR_SA_LEN
	unsigned char ss_len;		/* address length */
	unsigned char ss_family;	/* address family */
#else
	unsigned short ss_family;	/* address family */
#endif
	char	__ss_pad1[_SS_PAD1SIZE];
	int64_t __ss_align;	/* force desired structure storage alignment */
	char	__ss_pad2[_SS_PAD2SIZE];
};
#endif

Pekka Pessi's avatar
Pekka Pessi committed
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 198 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 226 227 228 229 230
/** Common socket address structure. */
union su_sockaddr_u {
#ifdef DOCUMENTATION_ONLY
  uint8_t             su_len;         /**< Length of structure */
  uint8_t             su_family;      /**< Address family. */
  uint16_t            su_port;        /**< Port number. */
#else
  short               su_dummy;	      /**< Dummy member to initialize */
#if SU_HAVE_SOCKADDR_SA_LEN
#define               su_len          su_sa.sa_len
#define               su_family       su_sa.sa_family
#else
#define               su_len          su_array[0]
  short               su_family;
#endif
#define               su_port         su_sin.sin_port  
#endif

  char                su_array[32];   /**< Presented as chars */
  uint16_t            su_array16[16]; /**< Presented as 16-bit ints */
  uint32_t            su_array32[8];  /**< Presented as 32-bit ints */
  struct sockaddr     su_sa;          /**< Address in struct sockaddr format */
  struct sockaddr_in  su_sin;         /**< Address in IPv4 format */
#if SU_HAVE_IN6
  struct sockaddr_in6 su_sin6;        /**< Address in IPv6 format */
#endif
#ifdef DOCUMENTATION_ONLY
  uint32_t            su_scope_id;    /**< Scope ID. */
#else
#define               su_scope_id     su_array32[6]
#endif
};

typedef union su_sockaddr_u su_sockaddr_t;

#if SU_HAVE_BSDSOCK || DOCUMENTATION_ONLY
/** IO vector for su_vsend() and su_vrecv(). 
 * @note Ordering of the fields is reversed on Windows.
 */
struct su_iovec_s {
  void  *siv_base;		/**< Pointer to buffer. */
  size_t siv_len;		/**< Size of buffer.  */
};
#endif

#if SU_HAVE_WINSOCK
struct su_iovec_s {
  long  siv_len;
  void *siv_base;
};
#endif

/** I/O vector for scatter-gather I/O. */
typedef struct su_iovec_s   su_iovec_t;

/* ---------------------------------------------------------------------- */
/* Socket compatibility functions */

231 232
SOFIAPUBFUN int su_init(void);
SOFIAPUBFUN void su_deinit(void);
Pekka Pessi's avatar
Pekka Pessi committed
233 234

/** Create an endpoint for communication. */
235
SOFIAPUBFUN su_socket_t su_socket(int af, int sock, int proto);
Pekka Pessi's avatar
Pekka Pessi committed
236
/** Close an socket descriptor. */
237
SOFIAPUBFUN int su_close(su_socket_t s);
Pekka Pessi's avatar
Pekka Pessi committed
238
/** Control socket. */
239
SOFIAPUBFUN int su_ioctl(su_socket_t s, int request, ...);
Pekka Pessi's avatar
Pekka Pessi committed
240 241

/** Checks if the previous call failed because it would have blocked. */
242
SOFIAPUBFUN int su_isblocking(void);
Pekka Pessi's avatar
Pekka Pessi committed
243
/** Set/reset blocking option. */ 
244
SOFIAPUBFUN int su_setblocking(su_socket_t s, int blocking);
Pekka Pessi's avatar
Pekka Pessi committed
245
/** Set/reset address reusing option. */
246
SOFIAPUBFUN int su_setreuseaddr(su_socket_t s, int reuse);
Pekka Pessi's avatar
Pekka Pessi committed
247
/** Get the error code associated with the socket. */
248
SOFIAPUBFUN int su_soerror(su_socket_t s);
Pekka Pessi's avatar
Pekka Pessi committed
249
/** Get size of message available in socket. */
250
SOFIAPUBFUN int su_getmsgsize(su_socket_t s);
Pekka Pessi's avatar
Pekka Pessi committed
251 252

/** Scatter-gather send. */
253
SOFIAPUBFUN
Pekka Pessi's avatar
Pekka Pessi committed
254 255 256
int su_vsend(su_socket_t s, su_iovec_t const iov[], int iovlen, int flags, 
             su_sockaddr_t const *su, socklen_t sulen);
/** Scatter-gather receive. */
257
SOFIAPUBFUN
Pekka Pessi's avatar
Pekka Pessi committed
258 259 260
int su_vrecv(su_socket_t s, su_iovec_t iov[], int iovlen, int flags, 
             su_sockaddr_t *su, socklen_t *sulen);
/** Return local IP address */
261
SOFIAPUBFUN int su_getlocalip(su_sockaddr_t *sin);
Pekka Pessi's avatar
Pekka Pessi committed
262

263
#include <sofia-sip/su_addrinfo.h>
Pekka Pessi's avatar
Pekka Pessi committed
264 265 266 267 268 269 270

#if SU_HAVE_BSDSOCK
#define su_ioctl  ioctl
#define su_isblocking() (su_errno() == EAGAIN || su_errno() == EWOULDBLOCK)
#endif

#if SU_HAVE_WINSOCK
271 272 273
SOFIAPUBFUN int inet_pton(int af, char const *src, void *dst);
SOFIAPUBFUN const char *inet_ntop(int af, void const *src,
				  char *dst, size_t size);
Pekka Pessi's avatar
Pekka Pessi committed
274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305
#endif

/* ---------------------------------------------------------------------- */
/* Other compatibility stuff */

#if SU_HAVE_WINSOCK
#define getuid() (0x505)
#endif

#ifndef IPPROTO_SCTP
#define IPPROTO_SCTP (132)
#endif

/* ---------------------------------------------------------------------- */
/* Address manipulation macros */

/**@HI Get pointer to address field.
 *
 * The macro SU_ADDR() returns pointer to the address field (sin_data,
 * sin_addr or sin_addr6, depending on the address family).
 */
#if SU_HAVE_IN6
#define SU_ADDR(su) \
  ((su)->su_family == AF_INET ? (void *)&(su)->su_sin.sin_addr : \
  ((su)->su_family == AF_INET6 ? (void *)&(su)->su_sin6.sin6_addr : \
  (void *)&(su)->su_sa.sa_data))
#else
#define SU_ADDR(su) \
  ((su)->su_family == AF_INET ? (void *)&(su)->su_sin.sin_addr : \
  (void *)&(su)->su_sa.sa_data)
#endif

Pekka Pessi's avatar
Pekka Pessi committed
306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321
/**@HI Get length of address field.
 *
 * The macro SU_ADDRLEN() returns length of the address field (sin_data,
 * sin_addr or sin_addr6, depending on the address family).
 */
#if SU_HAVE_IN6
#define SU_ADDRLEN(su) \
  ((su)->su_family == AF_INET ? sizeof((su)->su_sin.sin_addr) :	    \
   ((su)->su_family == AF_INET6 ? sizeof((su)->su_sin6.sin6_addr) : \
    sizeof((su)->su_sa.sa_data)))
#else
#define SU_ADDRLEN(su) \
  ((su)->su_family == AF_INET ? sizeof((su)->su_sin.sin_addr) :	    \
   sizeof((su)->su_sa.sa_data))
#endif

Pekka Pessi's avatar
Pekka Pessi committed
322 323
/**@HI Test if su_sockaddr_t is INADDR_ANY or IN6ADDR_ANY. */
#if SU_HAVE_IN6
324
#define SU_HAS_INADDR_ANY(su) \
Pekka Pessi's avatar
Pekka Pessi committed
325 326 327 328 329 330
  ((su)->su_family == AF_INET \
   ? ((su)->su_sin.sin_addr.s_addr == INADDR_ANY) \
   : ((su)->su_family == AF_INET6 \
      ? (memcmp(&(su)->su_sin6.sin6_addr, su_in6addr_any(), \
		sizeof(*su_in6addr_any())) == 0) : 0))
#else
331
#define SU_HAS_INADDR_ANY(su) \
Pekka Pessi's avatar
Pekka Pessi committed
332 333 334 335
  ((su)->su_family == AF_INET \
  ? ((su)->su_sin.sin_addr.s_addr == INADDR_ANY) : 0)
#endif

336 337
#define SU_SOCKADDR_INADDR_ANY(su) SU_HAS_INADDR_ANY(su)

Pekka Pessi's avatar
Pekka Pessi committed
338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358
/**@HI Calculate correct size of su_sockaddr_t structure. */ 
#if SU_HAVE_IN6
#define SU_SOCKADDR_SIZE(su) \
  ((su)->su_family == AF_INET ? sizeof((su)->su_sin) \
   : ((su)->su_family == AF_INET6 ? sizeof((su)->su_sin6) \
      : sizeof(*su)))
#else
#define SU_SOCKADDR_SIZE(su) \
  ((su)->su_family == AF_INET ? sizeof((su)->su_sin) \
    : sizeof(*su))
#endif
#define su_sockaddr_size SU_SOCKADDR_SIZE

#if SU_HAVE_IN6
#if SU_HAVE_BSDSOCK
#define su_in6addr_any()         (&in6addr_any)
#define su_in6addr_loopback()    (&in6addr_loopback)
#define SU_IN6ADDR_ANY_INIT      IN6ADDR_ANY_INIT
#define SU_IN6ADDR_LOOPBACK_INIT IN6ADDR_LOOPBACK_INIT
#endif
#if SU_HAVE_WINSOCK || DOCUMENTATION_ONLY
Pekka Pessi's avatar
Pekka Pessi committed
359 360
SOFIAPUBVAR const struct in_addr6 *su_in6addr_any(void);
SOFIAPUBVAR const struct in_addr6 *su_in6addr_loopback(void);
Pekka Pessi's avatar
Pekka Pessi committed
361 362 363 364 365
#define SU_IN6ADDR_ANY_INIT      { 0 }
#define SU_IN6ADDR_LOOPBACK_INIT { 0,0,0,0, 0,0,0,0, 0,0,0,0, 0,0,0,1 }
#endif
#endif /* SU_HAVE_IN6 */

366 367 368 369 370
SOFIAPUBFUN int su_cmp_sockaddr(su_sockaddr_t const *a,
				su_sockaddr_t const *b);
SOFIAPUBFUN int su_match_sockaddr(su_sockaddr_t const *a,
				  su_sockaddr_t const *b);
SOFIAPUBFUN void su_canonize_sockaddr(su_sockaddr_t *su);
Pekka Pessi's avatar
Pekka Pessi committed
371

372
#if SU_HAVE_IN6
Pekka Pessi's avatar
Pekka Pessi committed
373 374
#define SU_CANONIZE_SOCKADDR(su) \
  ((su)->su_family == AF_INET6 ? su_canonize_sockaddr(su) : (void)0)
375 376 377 378 379
#else
#define SU_CANONIZE_SOCKADDR(su) \
  ((void)0)
#endif

380
SOFIA_END_DECLS
Pekka Pessi's avatar
Pekka Pessi committed
381 382

#endif /* !defined(SU_H) */