conncheck.c 153 KB
Newer Older
1 2 3
/*
 * This file is part of the Nice GLib ICE library.
 *
4 5 6
 * (C) 2006-2009 Collabora Ltd.
 *  Contact: Youness Alaoui
 * (C) 2006-2009 Nokia Corporation. All rights reserved.
7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25
 *  Contact: Kai Vehmanen
 *
 * The contents of this file are subject to the Mozilla Public License Version
 * 1.1 (the "License"); you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at
 * http://www.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS" basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
 * for the specific language governing rights and limitations under the
 * License.
 *
 * The Original Code is the Nice GLib ICE library.
 *
 * The Initial Developers of the Original Code are Collabora Ltd and Nokia
 * Corporation. All Rights Reserved.
 *
 * Contributors:
 *   Kai Vehmanen, Nokia
26
 *   Youness Alaoui, Collabora Ltd.
27 28 29 30 31 32 33 34 35 36 37 38 39
 *   Dafydd Harries, Collabora Ltd.
 *
 * Alternatively, the contents of this file may be used under the terms of the
 * the GNU Lesser General Public License Version 2.1 (the "LGPL"), in which
 * case the provisions of LGPL are applicable instead of those above. If you
 * wish to allow use of your version of this file only under the terms of the
 * LGPL and not to allow others to use your version of this file under the
 * MPL, indicate your decision by deleting the provisions above and replace
 * them with the notice and other provisions required by the LGPL. If you do
 * not delete the provisions above, a recipient may use your version of this
 * file under either the MPL or the LGPL.
 */

40
/*
41 42 43 44 45 46 47 48
 * @file conncheck.c
 * @brief ICE connectivity checks
 */

#ifdef HAVE_CONFIG_H
# include <config.h>
#endif

49 50 51 52 53
#include <errno.h>
#include <string.h>

#include <glib.h>

54 55
#include "debug.h"

56 57 58 59
#include "agent.h"
#include "agent-priv.h"
#include "conncheck.h"
#include "discovery.h"
Jakub Adam's avatar
Jakub Adam committed
60
#include "stun/stun5389.h"
61
#include "stun/usages/ice.h"
62 63
#include "stun/usages/bind.h"
#include "stun/usages/turn.h"
64

65
static void priv_update_check_list_failed_components (NiceAgent *agent, NiceStream *stream);
66
static void priv_update_check_list_state_for_ready (NiceAgent *agent, NiceStream *stream, NiceComponent *component);
67
static guint priv_prune_pending_checks (NiceAgent *agent, NiceStream *stream, guint component_id);
68
static gboolean priv_schedule_triggered_check (NiceAgent *agent, NiceStream *stream, NiceComponent *component, NiceSocket *local_socket, NiceCandidate *remote_cand);
69
static void priv_mark_pair_nominated (NiceAgent *agent, NiceStream *stream, NiceComponent *component, NiceCandidate *localcand, NiceCandidate *remotecand);
70
static size_t priv_create_username (NiceAgent *agent, NiceStream *stream,
71 72
    guint component_id, NiceCandidate *remote, NiceCandidate *local,
    uint8_t *dest, guint dest_len, gboolean inbound);
73
static size_t priv_get_password (NiceAgent *agent, NiceStream *stream,
74
    NiceCandidate *remote, uint8_t **password);
75
static void conn_check_free_item (gpointer data);
76 77 78
static CandidateCheckPair *priv_conn_check_add_for_candidate_pair_matched (
    NiceAgent *agent, guint stream_id, NiceComponent *component,
    NiceCandidate *local, NiceCandidate *remote, NiceCheckState initial_state);
79 80
static gboolean priv_update_selected_pair (NiceAgent *agent,
    NiceComponent *component, CandidateCheckPair *pair);
81

82
static int priv_timer_expired (GTimeVal *timer, GTimeVal *now)
83 84 85 86 87
{
  return (now->tv_sec == timer->tv_sec) ?
    now->tv_usec >= timer->tv_usec :
    now->tv_sec >= timer->tv_sec;
}
88

89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109
static gchar
priv_state_to_gchar (NiceCheckState state)
{
  switch (state) {
    case NICE_CHECK_WAITING:
      return 'W';
    case NICE_CHECK_IN_PROGRESS:
      return 'I';
    case NICE_CHECK_SUCCEEDED:
      return 'S';
    case NICE_CHECK_FAILED:
      return 'F';
    case NICE_CHECK_FROZEN:
      return 'Z';
    case NICE_CHECK_DISCOVERED:
      return 'D';
    default:
      g_assert_not_reached ();
  }
}

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 151 152 153 154 155 156 157
static const gchar *
priv_state_to_string (NiceCheckState state)
{
  switch (state) {
    case NICE_CHECK_WAITING:
      return "waiting";
    case NICE_CHECK_IN_PROGRESS:
      return "in progress";
    case NICE_CHECK_SUCCEEDED:
      return "succeeded";
    case NICE_CHECK_FAILED:
      return "failed";
    case NICE_CHECK_FROZEN:
      return "frozen";
    case NICE_CHECK_DISCOVERED:
      return "discovered";
    default:
      g_assert_not_reached ();
  }
}

static const gchar *
priv_ice_return_to_string (StunUsageIceReturn ice_return)
{
  switch (ice_return) {
    case STUN_USAGE_ICE_RETURN_SUCCESS:
      return "success";
    case STUN_USAGE_ICE_RETURN_ERROR:
      return "error";
    case STUN_USAGE_ICE_RETURN_INVALID:
      return "invalid";
    case STUN_USAGE_ICE_RETURN_ROLE_CONFLICT:
      return "role conflict";
    case STUN_USAGE_ICE_RETURN_INVALID_REQUEST:
      return "invalid request";
    case STUN_USAGE_ICE_RETURN_INVALID_METHOD:
      return "invalid method";
    case STUN_USAGE_ICE_RETURN_MEMORY_ERROR:
      return "memory error";
    case STUN_USAGE_ICE_RETURN_INVALID_ADDRESS:
      return "invalid address";
    case STUN_USAGE_ICE_RETURN_NO_MAPPED_ADDRESS:
      return "no mapped address";
    default:
      g_assert_not_reached ();
  }
}

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 198
static const gchar *
priv_candidate_type_to_string (NiceCandidateType type)
{
  switch (type) {
    case NICE_CANDIDATE_TYPE_HOST:
      return "host";
    case NICE_CANDIDATE_TYPE_SERVER_REFLEXIVE:
      return "srflx";
    case NICE_CANDIDATE_TYPE_PEER_REFLEXIVE:
      return "prflx";
    case NICE_CANDIDATE_TYPE_RELAYED:
      return "relay";
    default:
      g_assert_not_reached ();
  }
}

/*
 * Dump the conncheck lists of the agent
 */
static void
priv_print_conn_check_lists (NiceAgent *agent, const gchar *where, const gchar *detail)
{
  GSList *i, *k;
  guint j;

  if (!nice_debug_is_verbose ())
    return;

#define PRIORITY_LEN 32

  nice_debug ("Agent %p : *** conncheck list DUMP (called from %s%s)",
      agent, where, detail ? detail : "");
  for (i = agent->streams; i ; i = i->next) {
    NiceStream *stream = i->data;
    for (j = 1; j <= stream->n_components; j++) {
      for (k = stream->conncheck_list; k ; k = k->next) {
        CandidateCheckPair *pair = k->data;
        if (pair->component_id == j) {
          gchar local_addr[INET6_ADDRSTRLEN];
          gchar remote_addr[INET6_ADDRSTRLEN];
199
          StunTimer *timer = &pair->timer;
200 201 202 203 204

          nice_address_to_string (&pair->local->addr, local_addr);
          nice_address_to_string (&pair->remote->addr, remote_addr);

          nice_debug ("Agent %p : *** sc=%d/%d : pair %p : "
205 206
              "f=%s t=%s:%s timer=%d/%d %d/%dms "
              "[%s]:%u > [%s]:%u state=%c%s%s%s",
207 208 209 210
              agent, pair->stream_id, pair->component_id, pair,
              pair->foundation,
              priv_candidate_type_to_string (pair->local->type),
              priv_candidate_type_to_string (pair->remote->type),
211 212
              timer->retransmissions, timer->max_retransmissions,
              timer->delay - stun_timer_remainder (timer), timer->delay,
213 214 215 216 217 218 219 220 221 222 223 224
              local_addr, nice_address_get_port (&pair->local->addr),
              remote_addr, nice_address_get_port (&pair->remote->addr),
              priv_state_to_gchar (pair->state),
              pair->valid ? "V" : "",
              pair->nominated ? "N" : "",
              g_slist_find (agent->triggered_check_queue, pair) ? "T" : "");
        }
      }
    }
  }
}

225 226 227 228 229 230 231 232 233 234
/* Verify if the pair is in the triggered checks list
 */

static gboolean
priv_is_pair_in_triggered_check_queue (NiceAgent *agent, CandidateCheckPair *pair)
{
  g_assert (pair);
  return (g_slist_find (agent->triggered_check_queue, pair) != NULL);
}

235 236 237 238 239 240 241
/* Add the pair to the triggered checks list, if not already present
 */
static void
priv_add_pair_to_triggered_check_queue (NiceAgent *agent, CandidateCheckPair *pair)
{
  g_assert (pair);

242 243
  pair->state = NICE_CHECK_WAITING;
  nice_debug ("Agent %p : pair %p state WAITING", agent, pair);
244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271
  if (agent->triggered_check_queue == NULL ||
      g_slist_find (agent->triggered_check_queue, pair) == NULL)
    agent->triggered_check_queue = g_slist_append (agent->triggered_check_queue, pair);
}

/* Remove the pair from the triggered checks list
 */
static void
priv_remove_pair_from_triggered_check_queue (NiceAgent *agent, CandidateCheckPair *pair)
{
  g_assert (pair);
  agent->triggered_check_queue = g_slist_remove (agent->triggered_check_queue, pair);
}

/* Get the pair from the triggered checks list
 */
static CandidateCheckPair *
priv_get_pair_from_triggered_check_queue (NiceAgent *agent)
{
  CandidateCheckPair *pair = NULL;

  if (agent->triggered_check_queue) {
    pair = (CandidateCheckPair *)agent->triggered_check_queue->data;
    priv_remove_pair_from_triggered_check_queue (agent, pair);
  }
  return pair;
}

272 273 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 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354
/*
 * Check if the conncheck list if Active according to
 * ICE spec, 5.7.4 (Computing States)
 *
 * note: the ICE spec in unclear about that, but the check list should
 * be considered active when there is at least a pair in Waiting state
 * OR a pair in In-Progress state.
 */
static gboolean
priv_is_checklist_active (NiceStream *stream)
{
  GSList *i;

  for (i = stream->conncheck_list; i ; i = i->next) {
    CandidateCheckPair *p = i->data;
    if (p->state == NICE_CHECK_WAITING || p->state == NICE_CHECK_IN_PROGRESS)
      return TRUE;
  }
  return FALSE;
}

/*
 * Check if the conncheck list if Frozen according to
 * ICE spec, 5.7.4 (Computing States)
 */
static gboolean
priv_is_checklist_frozen (NiceStream *stream)
{
  GSList *i;

  if (stream->conncheck_list == NULL)
    return FALSE;

  for (i = stream->conncheck_list; i ; i = i->next) {
    CandidateCheckPair *p = i->data;
    if (p->state != NICE_CHECK_FROZEN)
      return FALSE;
  }
  return TRUE;
}

/*
 * Check if all components of the stream have
 * a valid pair (used for ICE spec, 7.1.3.2.3, point 2.)
 */
static gboolean
priv_all_components_have_valid_pair (NiceStream *stream)
{
  guint i;
  GSList *j;

  for (i = 1; i <= stream->n_components; i++) {
    for (j = stream->conncheck_list; j ; j = j->next) {
      CandidateCheckPair *p = j->data;
      if (p->component_id == i && p->valid)
        break;
    }
    if (j == NULL)
      return FALSE;
  }
  return TRUE;
}

/*
 * Check if the foundation in parameter matches the foundation
 * of a valid pair in the conncheck list [of stream] (used for ICE spec,
 * 7.1.3.2.3, point 2.)
 */
static gboolean
priv_foundation_matches_a_valid_pair (const gchar *foundation, NiceStream *stream)
{
  GSList *i;

  for (i = stream->conncheck_list; i ; i = i->next) {
    CandidateCheckPair *p = i->data;
    if (p->valid &&
        strncmp (p->foundation, foundation,
            NICE_CANDIDATE_PAIR_MAX_FOUNDATION) == 0)
      return TRUE;
  }
  return FALSE;
}

355
/*
356 357 358 359 360 361
 * Finds the next connectivity check in WAITING state.
 */
static CandidateCheckPair *priv_conn_check_find_next_waiting (GSList *conn_check_list)
{
  GSList *i;

362 363
  /* note: list is sorted in priority order to first waiting check has
   *       the highest priority */
364 365 366 367 368 369 370 371 372
  for (i = conn_check_list; i ; i = i->next) {
    CandidateCheckPair *p = i->data;
    if (p->state == NICE_CHECK_WAITING)
      return p;
  }

  return NULL;
}

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 433 434 435 436 437 438 439 440
/*
 * Finds the next connectivity check in FROZEN state.
 */
static CandidateCheckPair *
priv_conn_check_find_next_frozen (GSList *conn_check_list)
{
  GSList *i;

  /* note: list is sorted in priority order to first frozen check has
   *       the highest priority */
  for (i = conn_check_list; i ; i = i->next) {
    CandidateCheckPair *p = i->data;
    if (p->state == NICE_CHECK_FROZEN)
      return p;
  }

  return NULL;
}

/*
 * Returns the number of check lists of the agent
 */
static guint
priv_number_of_check_lists (NiceAgent *agent)
{
  guint n = 0;
  GSList *i;

  for (i = agent->streams; i ; i = i->next) {
    NiceStream *stream = i->data;
    if (stream->conncheck_list != NULL)
      n++;
  }
  return n;
}

/*
 * Returns the number of active check lists of the agent
 */
static guint
priv_number_of_active_check_lists (NiceAgent *agent)
{
  guint n = 0;
  GSList *i;

  for (i = agent->streams; i ; i = i->next)
    if (priv_is_checklist_active (i->data))
      n++;
  return n;
}

/*
 * Returns the first stream of the agent having a Frozen
 * connection check list
 */
static NiceStream *
priv_find_first_frozen_check_list (NiceAgent *agent)
{
  GSList *i;

  for (i = agent->streams; i ; i = i->next) {
    NiceStream *stream = i->data;
    if (priv_is_checklist_frozen (stream))
      return stream;
  }
  return NULL;
}

441
/*
442 443 444 445 446 447 448
 * Initiates a new connectivity check for a ICE candidate pair.
 *
 * @return TRUE on success, FALSE on error
 */
static gboolean priv_conn_check_initiate (NiceAgent *agent, CandidateCheckPair *pair)
{
  g_get_current_time (&pair->next_tick);
449
  g_time_val_add (&pair->next_tick, agent->timer_ta * 1000);
450
  pair->state = NICE_CHECK_IN_PROGRESS;
451
  nice_debug ("Agent %p : pair %p state IN_PROGRESS", agent, pair);
452 453 454 455
  conn_check_send (agent, pair);
  return TRUE;
}

456
/*
457
 * Unfreezes the next connectivity check in the list. Follows the
458
 * algorithm (2.) defined in 5.7.4 (Computing States) of the ICE spec
459
 * (RFC5245)
460 461 462
 *
 * See also sect 7.1.2.2.3 (Updating Pair States), and
 * priv_conn_check_unfreeze_related().
463 464 465
 * 
 * @return TRUE on success, and FALSE if no frozen candidates were found.
 */
466
static gboolean priv_conn_check_unfreeze_next (NiceAgent *agent, NiceStream *stream)
467
{
468
  GSList *i, *j;
469 470
  GSList *found_list = NULL;
  gboolean result = FALSE;
471

472
  priv_print_conn_check_lists (agent, G_STRFUNC, NULL);
473

474 475 476 477 478
  for (i = stream->conncheck_list; i ; i = i->next) {
    CandidateCheckPair *p1 = i->data;
    CandidateCheckPair *pair = NULL;
    guint lowest_component_id = stream->n_components + 1;
    guint64 highest_priority = 0;
479

480 481 482
    if (g_slist_find_custom (found_list, p1->foundation, (GCompareFunc)strcmp))
      continue;
    found_list = g_slist_prepend (found_list, p1->foundation);
483

484
    for (j = stream->conncheck_list; j ; j = j->next) {
485 486 487 488 489 490 491 492 493 494
      CandidateCheckPair *p2 = i->data;
      if (strncmp (p2->foundation, p1->foundation,
              NICE_CANDIDATE_PAIR_MAX_FOUNDATION) == 0) {
        if (p2->component_id < lowest_component_id ||
            (p2->component_id == lowest_component_id &&
             p2->priority > highest_priority)) {
          pair = p2;
          lowest_component_id = p2->component_id;
          highest_priority = p2->priority;
        }
495 496
      }
    }
497

498 499 500 501 502 503 504
    if (pair) {
      nice_debug ("Agent %p : Pair %p with s/c-id %u/%u (%s) unfrozen.",
          agent, pair, pair->stream_id, pair->component_id, pair->foundation);
      pair->state = NICE_CHECK_WAITING;
      nice_debug ("Agent %p : pair %p state WAITING", agent, pair);
      result = TRUE;
    }
505
  }
506 507
  g_slist_free (found_list);
  return result;
508 509
}

510
/*
511
 * Unfreezes the next next connectivity check in the list after
Youness Alaoui's avatar
Youness Alaoui committed
512
 * check 'success_check' has successfully completed.
513
 *
514
 * See sect 7.1.2.2.3 (Updating Pair States) of ICE spec (ID-19).
515 516 517 518 519 520
 * 
 * @param agent context
 * @param ok_check a connectivity check that has just completed
 *
 * @return TRUE on success, and FALSE if no frozen candidates were found.
 */
521
static void priv_conn_check_unfreeze_related (NiceAgent *agent, NiceStream *stream, CandidateCheckPair *ok_check)
522 523 524 525 526
{
  GSList *i, *j;

  g_assert (ok_check);
  g_assert (ok_check->state == NICE_CHECK_SUCCEEDED);
527 528
  g_assert (stream);
  g_assert (stream->id == ok_check->stream_id);
529

530 531
  priv_print_conn_check_lists (agent, G_STRFUNC, NULL);

532
  /* step: perform the step (1) of 'Updating Pair States' */
533
  for (i = stream->conncheck_list; i ; i = i->next) {
534 535 536 537
    CandidateCheckPair *p = i->data;
   
    if (p->stream_id == ok_check->stream_id) {
      if (p->state == NICE_CHECK_FROZEN &&
538 539
          strncmp (p->foundation, ok_check->foundation,
              NICE_CANDIDATE_PAIR_MAX_FOUNDATION) == 0) {
Youness Alaoui's avatar
Youness Alaoui committed
540
	nice_debug ("Agent %p : Unfreezing check %p (after successful check %p).", agent, p, ok_check);
541
	p->state = NICE_CHECK_WAITING;
542
        nice_debug ("Agent %p : pair %p state WAITING", agent, p);
543 544 545 546 547 548
      }
    }
  }

  /* step: perform the step (2) of 'Updating Pair States' */
  stream = agent_find_stream (agent, ok_check->stream_id);
549
  if (priv_all_components_have_valid_pair (stream)) {
550
    for (i = agent->streams; i ; i = i->next) {
551 552 553
      /* the agent examines the check list for each other
       * media stream in turn
       */
554
      NiceStream *s = i->data;
555 556 557 558 559 560 561 562 563
      if (s->id == ok_check->stream_id)
        continue;
      if (priv_is_checklist_active (s)) {
        /* checklist is Active
         */
        for (j = s->conncheck_list; j ; j = j->next) {
	  CandidateCheckPair *p = j->data;
          if (p->state == NICE_CHECK_FROZEN &&
              priv_foundation_matches_a_valid_pair (p->foundation, stream)) {
Youness Alaoui's avatar
Youness Alaoui committed
564
	    nice_debug ("Agent %p : Unfreezing check %p from stream %u (after successful check %p).", agent, p, s->id, ok_check);
565
	    p->state = NICE_CHECK_WAITING;
566
            nice_debug ("Agent %p : pair %p state WAITING", agent, p);
567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592
          }
        }
      } else if (priv_is_checklist_frozen (s)) {
        /* checklist is Frozen
         */
        gboolean match_found = FALSE;
        /* check if there is one pair in the check list whose
         * foundation matches a pair in the valid list under
         * consideration
         */
        for (j = s->conncheck_list; j ; j = j->next) {
	  CandidateCheckPair *p = j->data;
          if (priv_foundation_matches_a_valid_pair (p->foundation, stream)) {
            match_found = TRUE;
            nice_debug ("Agent %p : Unfreezing check %p from stream %u (after successful check %p).", agent, p, s->id, ok_check);
            p->state = NICE_CHECK_WAITING;
            nice_debug ("Agent %p : pair %p state WAITING", agent, p);
          }
        }

        if (!match_found) {
          /* set the pair with the lowest component ID
           * and highest priority to Waiting
           */
          priv_conn_check_unfreeze_next (agent, s);
        }
593 594 595 596 597
      }
    }
  }    
}

598
static void
599
candidate_check_pair_fail (NiceStream *stream, NiceAgent *agent, CandidateCheckPair *p)
600 601
{
  StunTransactionId id;
602
  NiceComponent *component;
603

604
  component = nice_stream_find_component_by_id (stream, p->component_id);
605 606 607 608

  p->state = NICE_CHECK_FAILED;
  nice_debug ("Agent %p : pair %p state FAILED", agent, p);

609 610 611 612
  if (p->stun_message.buffer != NULL) {
    stun_message_id (&p->stun_message, id);
    stun_agent_forget_transaction (&component->stun_agent, id);
  }
613 614 615 616 617

  p->stun_message.buffer = NULL;
  p->stun_message.buffer_len = 0;
}

618 619 620 621 622 623 624 625 626 627
/*
 * Function that resubmits a new connection check, after a previous
 * check in in-progress state got cancelled due to an incoming stun
 * request matching this same pair
 *
 * @return will return TRUE if the pair is scheduled for recheck
 */
static gboolean
priv_conn_recheck_on_timeout (NiceAgent *agent, CandidateCheckPair *p)
{
628
  if (p->recheck_on_timeout) {
629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645
    g_assert (p->state == NICE_CHECK_IN_PROGRESS);
    /* this cancelled pair may have the flag 'mark nominated
     * on response arrival' set, we want to keep it, because
     * this is needed to nominate this pair in aggressive
     * nomination, when the agent is in controlled mode.
     *
     * this cancelled pair may also have the flag 'use candidate
     * on next check' set, that we want to preserve too.
     */
    nice_debug ("Agent %p : pair %p was cancelled, "
        "triggering a new connection check", agent, p);
    priv_add_pair_to_triggered_check_queue (agent, p);
    return TRUE;
  }
  return FALSE;
}

646
/*
647 648 649 650 651 652 653
 * Helper function for connectivity check timer callback that
 * runs through the stream specific part of the state machine. 
 *
 * @param schedule if TRUE, schedule a new check
 *
 * @return will return FALSE when no more pending timers.
 */
654
static gboolean priv_conn_check_tick_stream (NiceStream *stream, NiceAgent *agent, GTimeVal *now)
655 656
{
  gboolean keep_timer_going = FALSE;
657 658
  GSList *i;
  CandidateCheckPair *pair;
659
  unsigned int timeout;
660

661
  /* step: process ongoing STUN transactions */
662 663
  for (i = stream->conncheck_list; i ; i = i->next) {
    CandidateCheckPair *p = i->data;
664 665
    gchar tmpbuf1[INET6_ADDRSTRLEN], tmpbuf2[INET6_ADDRSTRLEN];
    NiceComponent *component;
666

667 668 669 670 671 672
    if (!agent_find_component (agent, p->stream_id, p->component_id,
        NULL, &component))
      continue;

    if (p->state != NICE_CHECK_IN_PROGRESS)
      continue;
673

674 675 676 677 678 679 680 681 682
    if (p->stun_message.buffer == NULL) {
      nice_debug ("Agent %p : STUN connectivity check was cancelled, marking as done.", agent);
      p->state = NICE_CHECK_FAILED;
      nice_debug ("Agent %p : pair %p state FAILED", agent, p);
      continue;
    }

    if (!priv_timer_expired (&p->next_tick, now))
      continue;
683

684 685
    switch (stun_timer_refresh (&p->timer)) {
      case STUN_USAGE_TIMER_RETURN_TIMEOUT:
686
timer_timeout:
687 688 689 690 691 692 693
        /* case: conncheck cancelled due to in-progress incoming
         * check, requeing the pair, ICE spec, sect 7.2.1.4
         * "Triggered Checks", "If the state of that pair is
         * In-Progress..."
         */
        if (priv_conn_recheck_on_timeout (agent, p))
          break;
694

695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715
        /* case: error, abort processing */
        nice_address_to_string (&p->local->addr, tmpbuf1);
        nice_address_to_string (&p->remote->addr, tmpbuf2);
        nice_debug ("Agent %p : Retransmissions failed, giving up on connectivity check %p", agent, p);
        nice_debug ("Agent %p : Failed pair is [%s]:%u --> [%s]:%u", agent,
            tmpbuf1, nice_address_get_port (&p->local->addr),
            tmpbuf2, nice_address_get_port (&p->remote->addr));
        candidate_check_pair_fail (stream, agent, p);
        priv_print_conn_check_lists (agent, G_STRFUNC,
            ", retransmission failed");

        /* perform a check if a transition state from connected to
         * ready can be performed. This may happen here, when the last
         * in-progress pair has expired its retransmission count
         * in priv_conn_check_tick_stream(), which is a condition to
         * make the transition connected to ready.
         */
        priv_update_check_list_state_for_ready (agent, stream, component);
        break;
      case STUN_USAGE_TIMER_RETURN_RETRANSMIT:
        timeout = stun_timer_remainder (&p->timer);
716

717 718 719 720 721 722
        /* case: retransmission stopped, due to the nomination of
         * a pair with a higher priority than this in-progress pair,
         * ICE spec, sect 8.1.2 "Updating States", item 2.2
         */
        if (!p->retransmit_on_timeout)
          goto timer_timeout;
723

724 725 726 727 728 729 730
        /* case: conncheck cancelled due to in-progress incoming
         * check, requeing the pair, ICE spec, sect 7.2.1.4
         * "Triggered Checks", "If the state of that pair is
         * In-Progress..."
         */
        if (priv_conn_recheck_on_timeout (agent, p))
          break;
731

732 733 734 735
        /* case: not ready, so schedule a new timeout */
        nice_debug ("Agent %p :STUN transaction retransmitted on pair %p "
            "(timeout %dms, delay=%dms, retrans=%d).",
            agent, p, timeout, p->timer.delay, p->timer.retransmissions);
736

737 738 739
        agent_socket_send (p->sockptr, &p->remote->addr,
            stun_message_length (&p->stun_message),
            (gchar *)p->stun_buffer);
740 741


742 743 744
        /* note: convert from milli to microseconds for g_time_val_add() */
        p->next_tick = *now;
        g_time_val_add (&p->next_tick, timeout * 1000);
745

746 747 748
        return TRUE;
      case STUN_USAGE_TIMER_RETURN_SUCCESS:
        timeout = stun_timer_remainder (&p->timer);
749

750 751 752
        /* note: convert from milli to microseconds for g_time_val_add() */
        p->next_tick = *now;
        g_time_val_add (&p->next_tick, timeout * 1000);
Youness Alaoui's avatar
Youness Alaoui committed
753

754 755 756 757 758
        keep_timer_going = TRUE;
        break;
      default:
        /* Nothing to do. */
        break;
759
    }
760
  }
761 762 763 764 765 766 767

  /* step: perform an ordinary check, ICE spec, 5.8 "Scheduling Checks"
   * note: This code is executed when the triggered checks list is
   * empty, and when no STUN message has been sent (pacing constraint)
   */
  pair = priv_conn_check_find_next_waiting (stream->conncheck_list);
  if (pair) {
768 769 770 771 772 773
    /* remove the pair from the triggered check list if needed. This
     * may happen with the cancelled pair, that's just been added
     * in state waiting to the triggered check list above in the
     * same function.
     */
    priv_remove_pair_from_triggered_check_queue (agent, pair);
774 775
    priv_print_conn_check_lists (agent, G_STRFUNC,
        ", got a pair in Waiting state");
776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794
    priv_conn_check_initiate (agent, pair);
    return TRUE;
  }

  /* note: this is unclear in the ICE spec, but a check list in Frozen
   * state (where all pairs are in Frozen state) is not supposed to
   * change its state by an ordinary check, but only by the success of
   * checks in other check lists, in priv_conn_check_unfreeze_related().
   * The underlying idea is to concentrate the checks on a single check
   * list initially.
   */
  if (priv_is_checklist_frozen (stream))
    return keep_timer_going;

  /* step: ordinary check continued, if there's no pair in the waiting
   * state, pick a pair in the frozen state
   */
  pair = priv_conn_check_find_next_frozen (stream->conncheck_list);
  if (pair) {
795 796
    priv_print_conn_check_lists (agent, G_STRFUNC,
        ", got a pair in Frozen state");
797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817
    pair->state = NICE_CHECK_WAITING;
    nice_debug ("Agent %p : pair %p state WAITING", agent, pair);
    priv_conn_check_initiate (agent, pair);
    return TRUE;
  }
  return keep_timer_going;
}

static gboolean
priv_conn_check_tick_stream_nominate (NiceStream *stream, NiceAgent *agent)
{
  gboolean keep_timer_going = FALSE;
  guint s_inprogress = 0;
  guint s_succeeded = 0;
  guint s_discovered = 0;
  guint s_nominated = 0;
  guint s_waiting_for_nomination = 0;
  guint s_valid = 0;
  guint frozen = 0;
  guint waiting = 0;
  GSList *i, *k;
818

819 820
  for (i = stream->conncheck_list; i ; i = i->next) {
    CandidateCheckPair *p = i->data;
821 822 823 824 825 826 827 828
    if (p->state == NICE_CHECK_FROZEN)
      ++frozen;
    else if (p->state == NICE_CHECK_IN_PROGRESS)
      ++s_inprogress;
    else if (p->state == NICE_CHECK_WAITING)
      ++waiting;
    else if (p->state == NICE_CHECK_SUCCEEDED)
      ++s_succeeded;
829 830
    else if (p->state == NICE_CHECK_DISCOVERED)
      ++s_discovered;
831 832
    if (p->valid)
      ++s_valid;
833

834 835
    if ((p->state == NICE_CHECK_SUCCEEDED || p->state == NICE_CHECK_DISCOVERED)
        && p->nominated)
836
      ++s_nominated;
837 838
    else if ((p->state == NICE_CHECK_SUCCEEDED ||
            p->state == NICE_CHECK_DISCOVERED) && !p->nominated)
839
      ++s_waiting_for_nomination;
840
  }
841

842 843 844 845 846 847
    /* note: keep the timer going as long as there is work to be done */
  if (s_inprogress)
    keep_timer_going = TRUE;
  
  if (s_nominated < stream->n_components &&
      s_waiting_for_nomination) {
848 849
    if (NICE_AGENT_IS_COMPATIBLE_WITH_RFC5245_OR_OC2007R2 (agent)) {
      if (agent->nomination_mode == NICE_NOMINATION_MODE_REGULAR &&
850 851
          agent->controlling_mode) {
#define NICE_MIN_NUMBER_OF_VALID_PAIRS 2
852
        /* ICE 8.1.1.1 Regular nomination
853 854 855 856
         * we choose to nominate the valid pair of a component if
         * - there is no pair left frozen, waiting or in-progress, or
         * - if there are at least two valid pairs, or
         * - if there is at least one valid pair of type HOST-HOST
857 858 859 860 861 862 863 864 865 866 867 868
         *
         * This is the "stopping criterion" described in 8.1.1.1, and is
         * a "local optimization" between accumulating more valid pairs,
         * and limiting the time spent waiting for in-progress connections
         * checks until they finally fail.
         */
        GSList *component_item;

        for (component_item = stream->components; component_item;
             component_item = component_item->next) {
          NiceComponent *component = component_item->data;
          gboolean already_done = FALSE;
869 870 871 872 873 874
          gboolean stopping_criterion = FALSE;
          guint p_valid = 0;
          guint p_frozen = 0;
          guint p_waiting = 0;
          guint p_inprogress = 0;
          guint p_host_host_valid = 0;
875 876 877 878 879 880

          /* verify that the choice of the pair to be nominated
           * has not already been done
           */
          for (k = stream->conncheck_list; k ; k = k->next) {
            CandidateCheckPair *p = k->data;
881 882 883 884 885 886 887 888 889 890 891 892 893 894 895
            if (p->component_id == component->id) {
              if (p->use_candidate_on_next_check)
                already_done = TRUE;
              if (p->state == NICE_CHECK_FROZEN)
                p_frozen++;
              else if (p->state == NICE_CHECK_WAITING)
                p_waiting++;
              else if (p->state == NICE_CHECK_IN_PROGRESS)
                p_inprogress++;
              if (p->valid)
                p_valid++;
              if (p->valid &&
                  p->local->type == NICE_CANDIDATE_TYPE_HOST &&
                  p->remote->type == NICE_CANDIDATE_TYPE_HOST)
                p_host_host_valid++;
896 897 898
            }
          }

899 900 901 902 903 904 905 906 907 908 909 910 911 912
          if (already_done)
            continue;

          stopping_criterion =
              (p_host_host_valid > 0 ||
               p_valid >= NICE_MIN_NUMBER_OF_VALID_PAIRS ||
               (p_waiting == 0 && p_inprogress == 0 && p_frozen == 0));

          if (!stopping_criterion)
            continue;

          /* when the stopping criterion is satisfied, we choose
           * a pair to be nominated in the list of valid pairs,
           * and add it to the triggered checks list
913
           */
914 915 916 917 918 919 920
          for (k = stream->conncheck_list; k ; k = k->next) {
            CandidateCheckPair *p = k->data;
            /* note: highest priority item selected (list always sorted) */
            if (p->component_id == component->id &&
                !p->nominated &&
                !p->use_candidate_on_next_check &&
                p->valid) {
921 922 923 924 925 926 927 928 929 930
              /* According a ICE spec, sect 8.1.1.1.  "Regular
               * Nomination", we enqueue the check that produced this
               * valid pair. When this pair has been discovered, we want
               * to test its parent pair instead.
               */
              if (p->succeeded_pair != NULL) {
                g_assert (p->state == NICE_CHECK_DISCOVERED);
                p = p->succeeded_pair;
              }
              g_assert (p->state == NICE_CHECK_SUCCEEDED);
931 932
              nice_debug ("Agent %p : restarting check %p with "
                  "USE-CANDIDATE attrib (regular nomination)", agent, p);
933
              p->recheck_on_timeout = FALSE;
934 935
              p->use_candidate_on_next_check = TRUE;
              priv_add_pair_to_triggered_check_queue (agent, p);
936
              keep_timer_going = TRUE;
937
              break; /* move to the next component */
938 939 940 941 942
            }
          }
        }
      }
    } else if (agent->controlling_mode) {
943 944 945 946
      GSList *component_item;

      for (component_item = stream->components; component_item;
           component_item = component_item->next) {
947
        NiceComponent *component = component_item->data;
948

949 950 951
	for (k = stream->conncheck_list; k ; k = k->next) {
	  CandidateCheckPair *p = k->data;
	  /* note: highest priority item selected (list always sorted) */
952 953 954
	  if (p->component_id == component->id &&
              (p->state == NICE_CHECK_SUCCEEDED ||
               p->state == NICE_CHECK_DISCOVERED)) {
955
	    nice_debug ("Agent %p : restarting check %p as the nominated pair.", agent, p);
956
	    p->nominated = TRUE;
957
            p->recheck_on_timeout = FALSE;
958
            priv_update_selected_pair (agent, component, p);
959
            priv_add_pair_to_triggered_check_queue (agent, p);
960
            keep_timer_going = TRUE;
961 962 963 964 965 966
	    break; /* move to the next component */
	  }
	}
      }
    }
  }
967 968 969 970 971 972
  if (stream->tick_counter++ % 50 == 0)
    nice_debug ("Agent %p : stream %u: timer tick #%u: %u frozen, %u in-progress, "
        "%u waiting, %u succeeded, %u discovered, %u nominated, "
        "%u waiting-for-nom, %u valid.", agent, stream->id,
        stream->tick_counter, frozen, s_inprogress, waiting, s_succeeded,
        s_discovered, s_nominated, s_waiting_for_nomination, s_valid);
973 974 975 976 977

  return keep_timer_going;

}

978 979 980 981 982 983 984 985 986
static void
conn_check_stop (NiceAgent *agent)
{
  if (agent->conncheck_timer_source == NULL)
    return;

  g_source_destroy (agent->conncheck_timer_source);
  g_source_unref (agent->conncheck_timer_source);
  agent->conncheck_timer_source = NULL;
987
  agent->conncheck_timer_grace_period = 0;
988 989
}

Youness Alaoui's avatar
Youness Alaoui committed
990

991
/*
992 993 994 995 996 997 998
 * Timer callback that handles initiating and managing connectivity
 * checks (paced by the Ta timer).
 *
 * This function is designed for the g_timeout_add() interface.
 *
 * @return will return FALSE when no more pending timers.
 */
999
static gboolean priv_conn_check_tick_unlocked (NiceAgent *agent)
1000 1001 1002
{
  CandidateCheckPair *pair = NULL;
  gboolean keep_timer_going = FALSE;
1003
  GSList *i, *j;
1004
  GTimeVal now;
1005 1006

  g_get_current_time (&now);
1007

1008 1009 1010 1011
  /* the conncheck really starts when we have built
   * a connection check list for each stream
   */
  if (priv_number_of_check_lists (agent) < g_slist_length (agent->streams))
1012 1013
    return TRUE;

1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030
  /* configure the initial state of the check lists of the agent
   * as described in ICE spec, 5.7.4
   *
   * if all pairs in all check lists are in frozen state, then
   * we are in the initial state (5.7.4, point 1.)
   */
  if (priv_number_of_active_check_lists (agent) == 0) {
    /* set some pairs of the first stream in the waiting state
     * ICE spec, 5.7.4, point 2.
     *
     * note: we adapt the ICE spec here, by selecting the first
     * frozen check list, which is not necessarily the check
     * list of the first stream (the first stream may be completed)
     */
    NiceStream *stream = priv_find_first_frozen_check_list (agent);
    if (stream)
      priv_conn_check_unfreeze_next (agent, stream);
1031 1032
  }

1033 1034 1035
  /* step: perform a test from the triggered checks list,
   * ICE spec, 5.8 "Scheduling Checks"
   */
1036 1037 1038
  pair = priv_get_pair_from_triggered_check_queue (agent);

  if (pair) {
1039 1040
    priv_print_conn_check_lists (agent, G_STRFUNC,
        ", got a pair from triggered check list");
1041 1042 1043 1044
    priv_conn_check_initiate (agent, pair);
    return TRUE;
  }

1045 1046
  /* step: process ongoing STUN transactions and
   * perform an ordinary check, ICE spec, 5.8, "Scheduling Checks"
1047
   */
1048
  for (i = agent->streams; i ; i = i->next) {
1049
    NiceStream *stream = i->data;
1050 1051 1052 1053
    if (priv_conn_check_tick_stream (stream, agent, &now))
      keep_timer_going = TRUE;
    if (priv_conn_check_tick_stream_nominate (stream, agent))
      keep_timer_going = TRUE;
1054
  }
1055

1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069
  /* step: if no work left and a conncheck list of a stream is still
   * frozen, set the pairs to waiting, according to ICE SPEC, sect
   * 7.1.3.3.  "Check List and Timer State Updates"
   */
  if (!keep_timer_going) {
    for (i = agent->streams; i ; i = i->next) {
      NiceStream *stream = i->data;
      if (priv_is_checklist_frozen (stream)) {
        nice_debug ("Agent %p : stream %d conncheck list is still "
            "frozen, while other lists are completed. Unfreeze it.",
            agent, stream->id);
        keep_timer_going = priv_conn_check_unfreeze_next (agent, stream);
      }
    }
1070 1071
  }

1072 1073 1074
  /* note: we provide a grace period before declaring a component as
   * failed. Components marked connected, and then ready follow another
   * code path, and are not concerned by this grace period.
1075
   */
1076 1077 1078
  if (!keep_timer_going && agent->conncheck_timer_grace_period == 0)
    nice_debug ("Agent %p : waiting %d msecs before checking "
        "for failed components.", agent, NICE_AGENT_MAX_TIMER_GRACE_PERIOD);
1079

1080 1081 1082 1083
  if (keep_timer_going)
    agent->conncheck_timer_grace_period = 0;
  else
    agent->conncheck_timer_grace_period += agent->timer_ta;
1084

1085
  /* step: stop timer if no work left */
1086 1087 1088
  if (!keep_timer_going &&
      agent->conncheck_timer_grace_period >= NICE_AGENT_MAX_TIMER_GRACE_PERIOD) {
    nice_debug ("Agent %p : checking for failed components now.", agent);
1089
    for (i = agent->streams; i; i = i->next) {
1090
      NiceStream *stream = i->data;
1091
      priv_update_check_list_failed_components (agent, stream);
1092
      for (j = stream->components; j; j = j->next) {
1093
        NiceComponent *component = j->data;
1094 1095
        priv_update_check_list_state_for_ready (agent, stream, component);
      }
1096
    }
1097

1098
    nice_debug ("Agent %p : %s: stopping conncheck timer", agent, G_STRFUNC);
1099 1100 1101
    priv_print_conn_check_lists (agent, G_STRFUNC,
        ", conncheck timer stopped");

1102 1103 1104
    /* Stopping the timer so destroy the source.. this will allow
       the timer to be reset if we get a set_remote_candidates after this
       point */
1105
    conn_check_stop (agent);
1106

1107
    /* XXX: what to signal, is all processing now really done? */
1108
    nice_debug ("Agent %p : changing conncheck state to COMPLETED.", agent);
1109
    return FALSE;
1110 1111
  }

1112
  return TRUE;
1113 1114
}

Youness Alaoui's avatar
Youness Alaoui committed
1115 1116 1117
static gboolean priv_conn_check_tick (gpointer pointer)
{
  gboolean ret;
1118
  NiceAgent *agent = pointer;
Youness Alaoui's avatar
Youness Alaoui committed
1119

1120 1121 1122 1123 1124 1125 1126
  agent_lock();
  if (g_source_is_destroyed (g_main_current_source ())) {
    nice_debug ("Source was destroyed. "
        "Avoided race condition in priv_conn_check_tick");
    agent_unlock ();
    return FALSE;
  }
1127 1128 1129

  ret = priv_conn_check_tick_unlocked (agent);
  agent_unlock_and_emit (agent);
Youness Alaoui's avatar
Youness Alaoui committed
1130 1131 1132 1133

  return ret;
}

1134 1135 1136 1137
static gboolean priv_conn_keepalive_retransmissions_tick (gpointer pointer)
{
  CandidatePair *pair = (CandidatePair *) pointer;

1138
  agent_lock();
1139

1140 1141 1142 1143
  /* A race condition might happen where the mutex above waits for the lock
   * and in the meantime another thread destroys the source.
   * In that case, we don't need to run our retransmission tick since it should
   * have been cancelled */
1144 1145 1146 1147
  if (g_source_is_destroyed (g_main_current_source ())) {
    nice_debug ("Source was destroyed. "
        "Avoided race condition in priv_conn_keepalive_retransmissions_tick");
    agent_unlock ();
1148 1149 1150
    return FALSE;
  }

1151 1152 1153 1154 1155 1156
  g_source_destroy (pair->keepalive.tick_source);
  g_source_unref (pair->keepalive.tick_source);
  pair->keepalive.tick_source = NULL;

  switch (stun_timer_refresh (&pair->keepalive.timer)) {
    case STUN_USAGE_TIMER_RETURN_TIMEOUT:
1157 1158 1159
      {
        /* Time out */
        StunTransactionId id;
1160
        NiceComponent *component;
1161 1162 1163 1164 1165 1166 1167 1168 1169

        if (!agent_find_component (pair->keepalive.agent,
                pair->keepalive.stream_id, pair->keepalive.component_id,
                NULL, &component)) {
          nice_debug ("Could not find stream or component in"
              " priv_conn_keepalive_retransmissions_tick");
          agent_unlock ();
          return FALSE;
        }
1170 1171

        stun_message_id (&pair->keepalive.stun_message, id);
1172
        stun_agent_forget_transaction (&component->stun_agent, id);
1173
        pair->keepalive.stun_message.buffer = NULL;
1174

1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185
        if (pair->keepalive.agent->media_after_tick) {
          nice_debug ("Agent %p : Keepalive conncheck timed out!! "
              "but media was received. Suspecting keepalive lost because of "
              "network bottleneck", pair->keepalive.agent);
        } else {
          nice_debug ("Agent %p : Keepalive conncheck timed out!! "
              "peer probably lost connection", pair->keepalive.agent);
          agent_signal_component_state_change (pair->keepalive.agent,
              pair->keepalive.stream_id, pair->keepalive.component_id,
              NICE_COMPONENT_STATE_FAILED);
        }
1186 1187
        break;
      }
1188 1189
    case STUN_USAGE_TIMER_RETURN_RETRANSMIT:
      /* Retransmit */
1190
      agent_socket_send (pair->local->sockptr, &pair->remote->addr,
1191 1192 1193
          stun_message_length (&pair->keepalive.stun_message),
          (gchar *)pair->keepalive.stun_buffer);