tport_type_udp.c 12.8 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24
/*
 * This file is part of the Sofia-SIP package
 *
 * Copyright (C) 2006 Nokia Corporation.
 *
 * Contact: Pekka Pessi <pekka.pessi@nokia.com>
 *
 * This library is free software; you can redistribute it and/or
 * 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
 *
 */

25
/**@CFILE tport_type_udp.c UDP Transport
26 27 28 29 30 31 32 33 34 35 36 37
 *
 * See tport.docs for more detailed description of tport interface.
 *
 * @author Pekka Pessi <Pekka.Pessi@nokia.com>
 * @author Martti Mela <Martti.Mela@nokia.com>
 *
 * @date Created: Fri Mar 24 08:45:49 EET 2006 ppessi
 */

#include "config.h"

#include "tport_internal.h"
38
#include "sofia-sip/hostdomain.h"
39 40 41 42 43 44 45 46

#if HAVE_IP_RECVERR || HAVE_IPV6_RECVERR
#include <linux/types.h>
#include <linux/errqueue.h>
#include <sys/uio.h>
#endif

#include <stdlib.h>
47
#include <string.h>
48 49 50 51 52 53 54 55
#include <time.h>
#include <assert.h>
#include <errno.h>
#include <limits.h>

/* ---------------------------------------------------------------------- */
/* UDP */

56 57 58 59 60 61 62
static
int tport_udp_init_client(tport_primary_t *pri,
			  tp_name_t tpn[1],
			  su_addrinfo_t *ai,
			  tagi_t const *tags,
			  char const **return_culprit);

63 64 65 66 67 68 69
#if HAVE_FUNC
#elif HAVE_FUNCTION
#define __func__ __FUNCTION__
#else
static char const __func__[] = "tport_type_udp";
#endif

70
tport_vtable_t const tport_udp_client_vtable =
71 72 73
{
  "udp", tport_type_client,
  sizeof (tport_primary_t),
74
  tport_udp_init_client,
75 76 77 78 79 80 81 82 83 84 85 86 87
  NULL,
  NULL,
  NULL,
  sizeof (tport_t),
  NULL,
  NULL,
  NULL,
  NULL,
  NULL,
  tport_recv_dgram,
  tport_send_dgram,
};

88
tport_vtable_t const tport_udp_vtable =
89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105
{
  "udp", tport_type_local,
  sizeof (tport_primary_t),
  tport_udp_init_primary,
  NULL,
  NULL,
  NULL,
  sizeof (tport_t),
  NULL,
  NULL,
  NULL,
  NULL,
  NULL,
  tport_recv_dgram,
  tport_send_dgram,
};

106 107
static void tport_check_trunc(tport_t *tp, su_addrinfo_t *ai);

108
int tport_udp_init_primary(tport_primary_t *pri,
109
			   tp_name_t tpn[1],
110 111 112 113 114 115 116
			   su_addrinfo_t *ai,
			   tagi_t const *tags,
			   char const **return_culprit)
{
  unsigned rmem = 0, wmem = 0;
  int events = SU_WAIT_IN;
  int s;
117
#if HAVE_IP_ADD_MEMBERSHIP
118
  su_sockaddr_t *su = (su_sockaddr_t *)ai->ai_addr;
119
#endif
120
  int const one = 1; (void)one;
121 122

  s = su_socket(ai->ai_family, ai->ai_socktype, ai->ai_protocol);
123
  if (s == INVALID_SOCKET)
124 125 126 127 128 129 130
    return *return_culprit = "socket", -1;

  pri->pri_primary->tp_socket = s;

  if (tport_bind_socket(s, ai, return_culprit) < 0)
    return -1;

131 132
  tport_set_tos(s, ai, pri->pri_params->tpp_tos);

133 134 135 136 137 138
#if HAVE_IP_ADD_MEMBERSHIP
  if (ai->ai_family == AF_INET && 
      IN_MULTICAST(ntohl(su->su_sin.sin_addr.s_addr))) {
    /* Try to join to the multicast group */
    /* Bind to the SIP address like 
       <sip:88.77.66.55:5060;maddr=224.0.1.75;transport=udp> */
139 140
    struct ip_mreq imr[1];
    struct in_addr iface;
141 142 143 144 145 146

    memset(imr, 0, sizeof imr);
      
    imr->imr_multiaddr = su->su_sin.sin_addr;

    if (host_is_ip4_address(tpn->tpn_canon) &&
147
	su_inet_pton(AF_INET, tpn->tpn_canon, &iface) > 0) {
148
      imr->imr_interface = iface;
149 150
    }

151
    if (setsockopt(s, IPPROTO_IP, IP_ADD_MEMBERSHIP, imr, (sizeof imr)) < 0) {
152 153 154 155 156
      SU_DEBUG_3(("setsockopt(%s): %s\n",
		  "IP_ADD_MEMBERSHIP", su_strerror(su_errno())));
    }
#if HAVE_IP_MULTICAST_LOOP
    else 
157
      if (setsockopt(s, IPPROTO_IP, IP_MULTICAST_LOOP, &one, sizeof one) < 0) {
158 159 160 161 162 163 164
	SU_DEBUG_3(("setsockopt(%s): %s\n",
		    "IP_MULTICAST_LOOP", su_strerror(su_errno())));
    }
#endif
  }
#endif

165 166 167 168 169 170 171 172 173 174 175
#if HAVE_IP_MTU_DISCOVER
  {
    /* Turn off DF flag on Linux */
    int dont = IP_PMTUDISC_DONT;
    if (setsockopt(s, IPPROTO_IP, IP_MTU_DISCOVER, &dont, sizeof(dont)) < 0) {
	SU_DEBUG_3(("setsockopt(%s): %s\n",
		    "IP_MTU_DISCOVER", su_strerror(su_errno())));
    }
  }
#endif

176 177
#if HAVE_IP_RECVERR
  if (ai->ai_family == AF_INET || ai->ai_family == AF_INET6) {
178
    if (setsockopt(s, IPPROTO_IP, IP_RECVERR, &one, sizeof(one)) < 0) {
179
      if (ai->ai_family == AF_INET)
180 181
	SU_DEBUG_3(("setsockopt(%s): %s\n",
		    "IPVRECVERR", su_strerror(su_errno())));
182 183 184 185 186 187
    }
    events |= SU_WAIT_ERR;
  }
#endif
#if HAVE_IPV6_RECVERR
  if (ai->ai_family == AF_INET6) {
188
    if (setsockopt(s, IPPROTO_IPV6, IPV6_RECVERR, &one, sizeof(one)) < 0)
189 190 191 192 193 194 195 196 197 198 199
      SU_DEBUG_3(("setsockopt(IPV6_RECVERR): %s\n", su_strerror(su_errno())));
    events |= SU_WAIT_ERR;
  }
#endif

  tl_gets(tags, 
	  TPTAG_UDP_RMEM_REF(rmem),
	  TPTAG_UDP_WMEM_REF(wmem),
	  TAG_END());

  if (rmem != 0 && 
200 201 202
#if HAVE_SO_RCVBUFFORCE
      setsockopt(s, SOL_SOCKET, SO_RCVBUFFORCE, (void *)&rmem, sizeof rmem) < 0 &&
#endif
203 204 205 206 207 208
      setsockopt(s, SOL_SOCKET, SO_RCVBUF, (void *)&rmem, sizeof rmem) < 0) {
    SU_DEBUG_3(("setsockopt(SO_RCVBUF): %s\n", 
		su_strerror(su_errno())));
  }

  if (wmem != 0 && 
209 210 211
#if HAVE_SO_SNDBUFFORCE
      setsockopt(s, SOL_SOCKET, SO_SNDBUFFORCE, (void *)&wmem, sizeof wmem) < 0 &&
#endif
212 213 214 215 216 217 218
      setsockopt(s, SOL_SOCKET, SO_SNDBUF, (void *)&wmem, sizeof wmem) < 0) {
    SU_DEBUG_3(("setsockopt(SO_SNDBUF): %s\n", 
		su_strerror(su_errno())));
  }

  pri->pri_primary->tp_events = events;

219 220
  tport_init_compressor(pri->pri_primary, tpn->tpn_comp, tags);

221 222
  tport_check_trunc(pri->pri_primary, ai);

223
#if HAVE_SOFIA_STUN
224
  tport_stun_server_add_socket(pri->pri_primary);
225
#endif
226

227 228 229
  return 0;
}

230 231 232 233 234 235 236 237 238 239 240
static
int tport_udp_init_client(tport_primary_t *pri,
			  tp_name_t tpn[1],
			  su_addrinfo_t *ai,
			  tagi_t const *tags,
			  char const **return_culprit)
{
  pri->pri_primary->tp_conn_orient = 1;
  return 0;
}

241 242 243 244
/** Runtime test making sure MSG_TRUNC work as expected */
static void tport_check_trunc(tport_t *tp, su_addrinfo_t *ai)
{
#if HAVE_MSG_TRUNC
245
  ssize_t n;
246 247 248 249
  char buffer[2];
  su_sockaddr_t su[1];
  socklen_t sulen = sizeof su;

250 251
  n = su_sendto(tp->tp_socket,
		"TEST", 4, 0,
Michael Jerris's avatar
Michael Jerris committed
252
		(void *)ai->ai_addr, (socklen_t)ai->ai_addrlen);
253

254 255 256
  if (n != 4)
    return;

257
  for (;;) {
258 259
    n = su_recvfrom(tp->tp_socket, buffer, sizeof buffer, MSG_TRUNC, 
		    (void *)&su, &sulen);
260

261
    if (n > (ssize_t)sizeof buffer) {
262 263 264 265 266 267 268 269 270 271 272
      tp->tp_trunc = 1;
      return;
    }

    /* XXX - check that su and tp->tp_addrinfo->ai_addr match */

    return;
  }
#endif
}

273 274 275 276
/** Receive datagram.
 *
 * @retval -1 error
 * @retval 0  end-of-stream  
277 278 279
 * @retval 1  normal receive (should never happen)
 * @retval 2  incomplete recv, call me again (should never happen)
 * @retval 3  STUN keepalive, ignore
280 281 282
 */
int tport_recv_dgram(tport_t *self)
{
283
  msg_t *msg;
284
  ssize_t n, veclen, N;
Pekka Pessi's avatar
Pekka Pessi committed
285
  su_addrinfo_t *ai;
286
  su_sockaddr_t *from;
Pekka Pessi's avatar
Pekka Pessi committed
287
  socklen_t fromlen;
288 289
  msg_iovec_t iovec[msg_n_fragments] = {{ 0 }};
  uint8_t sample[1];
290 291 292

  /* Simulate packet loss */
  if (self->tp_params->tpp_drop && 
293
      (unsigned)su_randint(0, 1000) < self->tp_params->tpp_drop) {
294
    su_recv(self->tp_socket, sample, 1, 0);
295
    SU_DEBUG_3(("tport(%p): simulated packet loss!\n", (void *)self));
296 297 298
    return 0;
  }

299
  assert(self->tp_msg == NULL);
300

301 302 303 304 305 306 307
#if nomore
  /* We used to resize the buffer, but it fragments the memory */
  N = 65535;
#else
  N = (ssize_t)su_getmsgsize(self->tp_socket);
  if (N == -1) {
    int err = su_errno();
308
    SU_DEBUG_1(("%s(%p): su_getmsgsize(): %s (%d)\n", __func__, (void *)self,
309 310 311
		su_strerror(err), err));
    return -1;
  }
312 313 314 315 316
  if (N == 0) {
    su_recv(self->tp_socket, sample, 1, 0);
    SU_DEBUG_3(("tport(%p): zero length packet", (void *)self));
    return 0;
  }
317 318 319 320
#endif

  veclen = tport_recv_iovec(self, &self->tp_msg, iovec, N, 1);
  if (veclen == -1)
321 322
    return -1;

323
  msg = self->tp_msg;
324

Pekka Pessi's avatar
Pekka Pessi committed
325
  ai = msg_addrinfo(msg);
326
  from = (su_sockaddr_t *)ai->ai_addr, fromlen = (socklen_t)(ai->ai_addrlen);
327

Pekka Pessi's avatar
Pekka Pessi committed
328 329 330 331
  n = su_vrecv(self->tp_socket, iovec, veclen, 0, from, &fromlen);
  
  ai->ai_addrlen = fromlen;
  
332 333
  if (n == SOCKET_ERROR) {
    int error = su_errno();
334
    msg_destroy(msg); self->tp_msg = NULL;
335
    su_seterrno(error);
336

337
    if (su_is_blocking(error))
338 339 340 341 342
      return 0;
    else
      return -1;
  }
  else if (n <= 1) {
343 344
    SU_DEBUG_1(("%s(%p): runt of "MOD_ZD" bytes\n",
		"tport_recv_dgram", (void *)self, n));
345 346
    msg_destroy(msg), self->tp_msg = NULL;
    return 0;
347 348
  }

349 350
  tport_recv_bytes(self, n, n);

351 352
  SU_CANONIZE_SOCKADDR(from);

353
  if (self->tp_master->mr_dump_file)
354 355
    tport_dump_iovec(self, msg, n, iovec, veclen, "recv", "from");

356
  *sample = *((uint8_t *)iovec[0].mv_base);
357

358 359 360 361 362
  /* Commit received data into buffer. This may relocate iovec contents */
  msg_recv_commit(msg, n, 1);

  if ((sample[0] & 0xf8) == 0xf8)
    /* SigComp */
363 364
    return tport_recv_comp_dgram(self, self->tp_comp, &self->tp_msg, 
				 from, fromlen);
365
#if HAVE_SOFIA_STUN
366 367
  else if (sample[0] == 0 || sample[0] == 1)
    /* STUN request or response */
368
    return tport_recv_stun_dgram(self, &self->tp_msg, from, fromlen);
369
#endif
370 371
  else
    return 0;
372 373 374
}

/** Send using su_vsend(). Map IPv4 addresses as IPv6 addresses, if needed. */
375 376 377
ssize_t tport_send_dgram(tport_t const *self, msg_t *msg, 
			 msg_iovec_t iov[], 
			 size_t iovused)
378
{
379 380
  su_sockaddr_t su[1];
  socklen_t sulen = sizeof su;
381 382 383 384

  if (tport_is_connection_oriented(self))
    return su_vsend(self->tp_socket, iov, iovused, MSG_NOSIGNAL, NULL, 0);

385
  msg_get_address(msg, su, &sulen);
386 387 388

#if SU_HAVE_IN6 && defined(IN6_INADDR_TO_V4MAPPED)
  if (su->su_family == AF_INET && self->tp_addrinfo->ai_family == AF_INET6) {
389 390
    su_sockaddr_t su0[1];

391 392 393 394 395 396 397
    memset(su0, 0, sizeof su0);

    su0->su_family = self->tp_addrinfo->ai_family;
    su0->su_port = su->su_port;

    IN6_INADDR_TO_V4MAPPED(&su->su_sin.sin_addr, &su0->su_sin6.sin6_addr);

398
    memcpy(su, su0, sulen = sizeof(su0->su_sin6));
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 433 434 435 436 437 438 439 440
  }
#endif

  su_soerror(self->tp_socket); /* XXX - we *still* have a race condition */

  return su_vsend(self->tp_socket, iov, iovused, MSG_NOSIGNAL, su, sulen);
}


#if !HAVE_IP_RECVERR && !HAVE_IPV6_RECVERR

/** Process UDP error event. */
int tport_udp_error(tport_t const *self, su_sockaddr_t name[1])
{
  if (tport_is_connection_oriented(self))
    name[0] = self->tp_addr[0];
  return su_soerror(self->tp_socket);
}

#else

/** Process UDP error event. */
int tport_udp_error(tport_t const *self, su_sockaddr_t name[1])
{
  struct cmsghdr *c;
  struct sock_extended_err *ee;
  su_sockaddr_t *from;
  char control[512];
  char errmsg[64 + 768];
  struct iovec iov[1];
  struct msghdr msg[1] = {{ 0 }};
  int n;

  msg->msg_name = name, msg->msg_namelen = sizeof(*name);
  msg->msg_iov = iov, msg->msg_iovlen = 1;
  iov->iov_base = errmsg, iov->iov_len = sizeof(errmsg);
  msg->msg_control = control, msg->msg_controllen = sizeof(control);

  n = recvmsg(self->tp_socket, msg, MSG_ERRQUEUE);

  if (n < 0) {
    int err = su_errno();
441
    if (!su_is_blocking(err))
442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464
      SU_DEBUG_1(("%s: recvmsg: %s\n", __func__, su_strerror(err)));
    return 0;
  }

  if ((msg->msg_flags & MSG_ERRQUEUE) != MSG_ERRQUEUE) {
    SU_DEBUG_1(("%s: recvmsg: no errqueue\n", __func__));
    return 0;
  }

  if (msg->msg_flags & MSG_CTRUNC) {
    SU_DEBUG_1(("%s: extended error was truncated\n", __func__));
    return 0;
  }

  if (msg->msg_flags & MSG_TRUNC) {
    /* ICMP message may contain original message... */
    SU_DEBUG_3(("%s: icmp(6) message was truncated (at %d)\n", __func__, n));
  }

  /* Go through the ancillary data */
  for (c = CMSG_FIRSTHDR(msg); c; c = CMSG_NXTHDR(msg, c)) {
    if (0
#if HAVE_IP_RECVERR
465
	|| (c->cmsg_level == IPPROTO_IP && c->cmsg_type == IP_RECVERR)
466 467
#endif
#if HAVE_IPV6_RECVERR
468
	|| (c->cmsg_level == IPPROTO_IPV6 && c->cmsg_type == IPV6_RECVERR)
469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508
#endif
	) {
      char info[128];
      char const *origin;

      ee = (struct sock_extended_err *)CMSG_DATA(c);
      from = (su_sockaddr_t *)SO_EE_OFFENDER(ee);
      info[0] = '\0';

      switch (ee->ee_origin) {
      case SO_EE_ORIGIN_LOCAL:
	origin = "local";
	break;
      case SO_EE_ORIGIN_ICMP:
	origin = "icmp";
	snprintf(info, sizeof(info), " type=%u code=%u", 
		 ee->ee_type, ee->ee_code);
	break;
      case SO_EE_ORIGIN_ICMP6:
	origin = "icmp6";
	snprintf(info, sizeof(info), " type=%u code=%u", 
		ee->ee_type, ee->ee_code);
	break;
      case SO_EE_ORIGIN_NONE:
	origin = "none";
	break;
      default:
	origin = "unknown";
	break;
      }

      if (ee->ee_info)
	snprintf(info + strlen(info), sizeof(info) - strlen(info), 
		 " info=%08x", ee->ee_info);

      SU_DEBUG_3(("%s: %s (%d) [%s%s]\n",
		  __func__, su_strerror(ee->ee_errno), ee->ee_errno, 
		  origin, info));
      if (from->su_family != AF_UNSPEC)
	SU_DEBUG_3(("\treported by [%s]:%u\n",
509 510
		    su_inet_ntop(from->su_family, SU_ADDR(from),
				 info, sizeof(info)),
511 512 513 514 515 516 517 518 519 520 521 522 523 524
		    ntohs(from->su_port)));

      if (msg->msg_namelen == 0)
	name->su_family = AF_UNSPEC;

      SU_CANONIZE_SOCKADDR(name);

      return ee->ee_errno;
    }
  }

  return 0;
}
#endif