su.c 9.27 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 25 26 27 28 29 30 31 32 33 34
 * 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
 *
 */

/**@ingroup su_socket
 * @CFILE su.c OS-independent socket functions
 * 
 * @author Pekka Pessi <Pekka.Pessi@nokia.com>
 * 
 * @date Created: Thu Mar 18 19:40:51 1999 pessi
 */

#include "config.h" 

35 36 37
#include "sofia-sip/su.h"
#include "sofia-sip/su_log.h"
#include "sofia-sip/su_alloc.h"
Pekka Pessi's avatar
Pekka Pessi committed
38

39 40 41 42 43 44
#include <stdio.h>
#include <string.h>
#if HAVE_SIGNAL
#include <signal.h>
#endif

Pekka Pessi's avatar
Pekka Pessi committed
45 46 47 48
#if !SU_HAVE_BSDSOCK && !SU_HAVE_WINSOCK
#error Bad configuration
#endif

49 50 51 52 53 54
#ifndef FD_CLOEXEC
#define FD_CLOEXEC (1)
#endif

int su_socket_close_on_exec = 0;

55
/** Create an endpoint for communication. */
56
su_socket_t su_socket(int af, int socktype, int proto)
57
{
58
  su_socket_t s = socket(af, socktype, proto);
59
#if SU_HAVE_BSDSOCK
60
  if (s != INVALID_SOCKET && su_socket_close_on_exec) {
61 62 63 64
    fcntl(s, F_SETFD, FD_CLOEXEC); /* Close on exec */
  }
#endif
  return s;
65 66
}

Pekka Pessi's avatar
Pekka Pessi committed
67 68 69 70 71
#if SU_HAVE_BSDSOCK
int su_init(void)
{
  su_home_threadsafe(NULL);

72
#if HAVE_SIGPIPE
Pekka Pessi's avatar
Pekka Pessi committed
73
  signal(SIGPIPE, SIG_IGN);	/* we want to get EPIPE instead */
74
#endif
Pekka Pessi's avatar
Pekka Pessi committed
75 76 77 78 79 80 81 82 83 84 85

  su_log_init(su_log_default);
  su_log_init(su_log_global);

  return 0;
}

void su_deinit(void)
{
}

86 87 88 89 90 91
/** Close an socket descriptor. */
int su_close(su_socket_t s)
{
  return close(s);
}

92
int su_setblocking(su_socket_t s, int blocking)
Pekka Pessi's avatar
Pekka Pessi committed
93
{
94
  int mode = fcntl(s, F_GETFL, 0);
Pekka Pessi's avatar
Pekka Pessi committed
95 96 97 98 99 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 150

  if (mode < 0)
     return -1;

  if (blocking) 
    mode &= ~(O_NDELAY | O_NONBLOCK);
  else
    mode |= O_NDELAY | O_NONBLOCK;

  return fcntl(s, F_SETFL, mode);
}
#endif

#if SU_HAVE_WINSOCK
int su_init(void)
{
  WORD	wVersionRequested;
  WSADATA	wsaData;

  wVersionRequested = MAKEWORD(2, 0);

  if (WSAStartup(wVersionRequested, &wsaData) !=0) {
    return -1;
  }

  su_log_init(su_log_default);

  su_log_init(su_log_global);

  return 0;
}

void su_deinit(void)
{
  WSACleanup();
}

/** Close an socket descriptor. */
int su_close(su_socket_t s)
{
  return closesocket(s);
}

/** Control socket. */
int su_ioctl(su_socket_t s, int request, ...)
{
  int retval;
  void *argp;
  va_list va;
  va_start(va, request);
  argp = va_arg(va, void *);
  retval = ioctlsocket(s, request, argp);
  va_end(va);
  return retval;
}

151 152 153 154 155
int su_is_blocking(int errcode)
{
  return errcode == EAGAIN || errcode == EWOULDBLOCK || errcode == EINPROGRESS;
}

Pekka Pessi's avatar
Pekka Pessi committed
156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178
int su_setblocking(su_socket_t s, int blocking)
{
  unsigned long nonBlock = !blocking;
  
  return ioctlsocket(s, FIONBIO, &nonBlock);
}


#endif /* SU_HAVE_WINSOCK */

int su_soerror(su_socket_t s)
{
  int error = 0;
  socklen_t errorlen = sizeof(error);

  getsockopt(s, SOL_SOCKET, SO_ERROR, (void *)&error, &errorlen);

  return error;
}

int su_setreuseaddr(su_socket_t s, int reuse)
{
  return setsockopt(s, SOL_SOCKET, SO_REUSEADDR, 
179
		    (void *)&reuse, (socklen_t)sizeof(reuse));
Pekka Pessi's avatar
Pekka Pessi committed
180 181 182 183 184 185 186
}


#if HAVE_SYS_FILIO_H
#include <sys/filio.h>
#endif

187 188 189 190 191 192 193 194 195 196
#if SU_HAVE_WINSOCK
issize_t su_getmsgsize(su_socket_t s)
{
  unsigned long n = (unsigned long)-1;
  if (ioctlsocket(s, FIONREAD, &n) == -1)
    return -1;
  return (issize_t)n;
}
#else
issize_t su_getmsgsize(su_socket_t s)
Pekka Pessi's avatar
Pekka Pessi committed
197 198 199 200
{
  int n = -1;
  if (su_ioctl(s, FIONREAD, &n) == -1)
    return -1;
201
  return (issize_t)n;
Pekka Pessi's avatar
Pekka Pessi committed
202
}
203
#endif
Pekka Pessi's avatar
Pekka Pessi committed
204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222

#if SU_HAVE_WINSOCK && SU_HAVE_IN6
/** Return a pointer to the in6addr_any. */
struct in_addr6 const *su_in6addr_any(void)
{
  static const struct in_addr6 a = SU_IN6ADDR_ANY_INIT;
  return &a;
}

/** Return a pointer to IPv6 loopback address */
struct in_addr6 const *su_in6addr_loopback(void)
{
  static const struct in_addr6 a = SU_IN6ADDR_LOOPBACK_INIT;
  return &a;
}
#endif

#if SU_HAVE_WINSOCK

223 224 225 226 227 228 229 230 231 232 233 234 235
ssize_t su_send(su_socket_t s, void *buffer, size_t length, int flags)
{
  if (length > INT_MAX)
    length = INT_MAX;
  return (ssize_t)send(s, buffer, (int)length, flags);
}

ssize_t su_sendto(su_socket_t s, void *buffer, size_t length, int flags,
		   su_sockaddr_t const *to, socklen_t tolen)
{
  if (length > INT_MAX)
    length = INT_MAX;
  return (ssize_t)sendto(s, buffer, (int)length, flags,
236
			 &to->su_sa, (int) tolen);
237 238
}

Michael Jerris's avatar
Michael Jerris committed
239
ssize_t su_recv(su_socket_t s, void *buffer, size_t length, int flags)
240 241 242 243 244 245 246
{
  if (length > INT_MAX)
    length = INT_MAX;

  return (ssize_t)recv(s, buffer, (int)length, flags);
}

Michael Jerris's avatar
Michael Jerris committed
247
ssize_t su_recvfrom(su_socket_t s, void *buffer, size_t length, int flags,
248
		    su_sockaddr_t *from, socklen_t *fromlen)
249 250 251 252 253 254 255 256 257 258
{
  int retval, ilen;

  if (fromlen)
    ilen = *fromlen;

  if (length > INT_MAX)
    length = INT_MAX;

  retval = recvfrom(s, buffer, (int)length, flags, 
259
		    &from->su_sa, fromlen ? &ilen : NULL);
260 261 262 263 264 265 266

  if (fromlen)
    *fromlen = ilen;

  return (ssize_t)retval;
}

Pekka Pessi's avatar
Pekka Pessi committed
267
/** Scatter/gather send */
268 269 270
issize_t su_vsend(su_socket_t s,
		  su_iovec_t const iov[], isize_t iovlen, int flags,
		  su_sockaddr_t const *su, socklen_t sulen)
Pekka Pessi's avatar
Pekka Pessi committed
271
{
272
  int ret;
Michael Jerris's avatar
Michael Jerris committed
273
  DWORD bytes_sent = (DWORD)su_failure;
274
  
275 276 277 278 279 280 281 282 283
  ret = WSASendTo(s,
		  (LPWSABUF)iov,
		  (DWORD)iovlen,
		  &bytes_sent,
		  flags,
		  &su->su_sa,
		  sulen,
		  NULL,
		  NULL);
Pekka Pessi's avatar
Pekka Pessi committed
284
  if (ret < 0)
285
    return (issize_t)ret;
Pekka Pessi's avatar
Pekka Pessi committed
286
  else
287
    return (issize_t)bytes_sent;
Pekka Pessi's avatar
Pekka Pessi committed
288 289 290 291
}


/** Scatter/gather recv */
292 293
issize_t su_vrecv(su_socket_t s, su_iovec_t iov[], isize_t iovlen, int flags,
		  su_sockaddr_t *su, socklen_t *sulen)
Pekka Pessi's avatar
Pekka Pessi committed
294
{
295
  int ret;
Michael Jerris's avatar
Michael Jerris committed
296
  DWORD bytes_recv = (DWORD)su_failure;
297
  DWORD dflags = flags;
298
  int fromlen = sulen ? *sulen : 0;
Pekka Pessi's avatar
Pekka Pessi committed
299 300

  ret =  WSARecvFrom(s,
301
		     (LPWSABUF)iov,
302
		     (DWORD)iovlen,
Pekka Pessi's avatar
Pekka Pessi committed
303
		     &bytes_recv,
304
		     &dflags,
Pekka Pessi's avatar
Pekka Pessi committed
305
		     &su->su_sa,
306
		     sulen ? &fromlen : NULL,
Pekka Pessi's avatar
Pekka Pessi committed
307 308
		     NULL,
		     NULL);
309 310 311

  if (sulen) *sulen = fromlen;

Pekka Pessi's avatar
Pekka Pessi committed
312
  if (ret < 0)
313
    return (issize_t)ret;
Pekka Pessi's avatar
Pekka Pessi committed
314
  else
315
    return (issize_t)bytes_recv;
Pekka Pessi's avatar
Pekka Pessi committed
316 317 318 319 320
}


#else

321 322 323
issize_t su_vsend(su_socket_t s,
		  su_iovec_t const iov[], isize_t iovlen, int flags,
		  su_sockaddr_t const *su, socklen_t sulen)
Pekka Pessi's avatar
Pekka Pessi committed
324 325 326
{
  struct msghdr hdr[1] = {{0}};

327
  hdr->msg_name = (void *)su;
Pekka Pessi's avatar
Pekka Pessi committed
328 329 330 331 332 333 334
  hdr->msg_namelen = sulen;
  hdr->msg_iov = (struct iovec *)iov;
  hdr->msg_iovlen = iovlen;

  return sendmsg(s, hdr, flags);
}

335 336
issize_t su_vrecv(su_socket_t s, su_iovec_t iov[], isize_t iovlen, int flags,
		  su_sockaddr_t *su, socklen_t *sulen)
Pekka Pessi's avatar
Pekka Pessi committed
337 338
{
  struct msghdr hdr[1] = {{0}};
339
  issize_t retval;
Pekka Pessi's avatar
Pekka Pessi committed
340

341
  hdr->msg_name = (void *)su;
Pekka Pessi's avatar
Pekka Pessi committed
342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432
  if (su && sulen)
    hdr->msg_namelen = *sulen;
  hdr->msg_iov = (struct iovec *)iov;
  hdr->msg_iovlen = iovlen;

  retval = recvmsg(s, hdr, flags);

  if (su && sulen)
    *sulen = hdr->msg_namelen;

  return retval;
}

#endif

/** Compare two socket addresses */
int su_cmp_sockaddr(su_sockaddr_t const *a, su_sockaddr_t const *b)
{
  int rv;

  /* Check that a and b are non-NULL */
  if ((rv = (a != NULL) - (b != NULL)) || a == NULL /* && b == NULL */)
    return rv;

  if ((rv = a->su_family - b->su_family))
    return rv;
  
  if (a->su_family == AF_INET)
    rv = memcmp(&a->su_sin.sin_addr, &b->su_sin.sin_addr, 
		sizeof(struct in_addr));
#if SU_HAVE_IN6
  else if (a->su_family == AF_INET6)
    rv = memcmp(&a->su_sin6.sin6_addr, &b->su_sin6.sin6_addr, 
		sizeof(struct in6_addr));
#endif
  else
    rv = memcmp(a, b, sizeof(struct sockaddr));

  if (rv)
    return rv;
  
  return a->su_port - b->su_port;
}

/** Check if socket address b match with a.
 *
 * The function su_match_sockaddr() returns true if the socket address @a b
 * matches with the socket address @a a. This happens if either all the
 * interesting fields are identical: address family, port number, address,
 * and scope ID (in case of IPv6) or that the @a a contains a wildcard
 * (zero) in their place.
 */
int su_match_sockaddr(su_sockaddr_t const *a, su_sockaddr_t const *b)
{
  /* Check that a and b are non-NULL */
  if (a == NULL)
    return 1;
  if (b == NULL)
    return 0;

  if (a->su_family != 0 && a->su_family != b->su_family)
    return 0;

  if (a->su_family == 0 || SU_SOCKADDR_INADDR_ANY(a))
    ;
  else if (a->su_family == AF_INET) {
    if (memcmp(&a->su_sin.sin_addr, &b->su_sin.sin_addr, 
	       sizeof(struct in_addr)))
      return 0;
  }
#if SU_HAVE_IN6
  else if (a->su_family == AF_INET6) {
    if (a->su_scope_id != 0 && a->su_scope_id != b->su_scope_id)
      return 0;
    if (memcmp(&a->su_sin6.sin6_addr, &b->su_sin6.sin6_addr, 
	       sizeof(struct in6_addr)))
      return 0;
  }
#endif
  else if (memcmp(a, b, sizeof(struct sockaddr)))
    return 0;

  if (a->su_port == 0)
    return 1;
  
  return a->su_port == b->su_port;
}

/** Convert mapped/compat address to IPv4 address */
void su_canonize_sockaddr(su_sockaddr_t *su)
{
Pekka Pessi's avatar
Pekka Pessi committed
433
#if SU_HAVE_IN6
Pekka Pessi's avatar
Pekka Pessi committed
434 435 436 437 438 439 440 441 442 443 444 445 446 447
  if (su->su_family != AF_INET6)
    return;

  if (!IN6_IS_ADDR_V4MAPPED(&su->su_sin6.sin6_addr) &&
      !IN6_IS_ADDR_V4COMPAT(&su->su_sin6.sin6_addr))
    return;
  
  su->su_family = AF_INET;
  su->su_array32[1] = su->su_array32[5];
  su->su_array32[2] = 0; 
  su->su_array32[3] = 0;
#endif
}