agent/component.c

   1 /*
   2  * This file is part of the Nice GLib ICE library.
   3  *
   4  * (C) 2006, 2007 Collabora Ltd.
   5  *  Contact: Dafydd Harries
   6  * (C) 2006, 2007 Nokia Corporation. All rights reserved.
   7  *  Contact: Kai Vehmanen
   8  *
   9  * The contents of this file are subject to the Mozilla Public License Version
  10  * 1.1 (the "License"); you may not use this file except in compliance with
  11  * the License. You may obtain a copy of the License at
  12  * http://www.mozilla.org/MPL/
  13  *
  14  * Software distributed under the License is distributed on an "AS IS" basis,
  15  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  16  * for the specific language governing rights and limitations under the
  17  * License.
  18  *
  19  * The Original Code is the Nice GLib ICE library.
  20  *
  21  * The Initial Developers of the Original Code are Collabora Ltd and Nokia
  22  * Corporation. All Rights Reserved.
  23  *
  24  * Contributors:
  25  *   Dafydd Harries, Collabora Ltd.
  26  *   Kai Vehmanen, Nokia
  27  *
  28  * Alternatively, the contents of this file may be used under the terms of the
  29  * the GNU Lesser General Public License Version 2.1 (the "LGPL"), in which
  30  * case the provisions of LGPL are applicable instead of those above. If you
  31  * wish to allow use of your version of this file only under the terms of the
  32  * LGPL and not to allow others to use your version of this file under the
  33  * MPL, indicate your decision by deleting the provisions above and replace
  34  * them with the notice and other provisions required by the LGPL. If you do
  35  * not delete the provisions above, a recipient may use your version of this
  36  * file under either the MPL or the LGPL.
  37  */
  38
  39 /*
  40  * @file component.c
  41  * @brief ICE component functions
  42  */
  43
  44 #ifdef HAVE_CONFIG_H
  45 # include <config.h>
  46 #endif
  47
  48 #include <string.h>
  49
  50 #include "debug.h"
  51
  52 #include "component.h"
  53 #include "agent-priv.h"
  54
  55 Component *
  56 component_new (
  57   G_GNUC_UNUSED
  58   guint id)
  59 {
  60   Component *component;
  61
  62   component = g_slice_new0 (Component);
  63   component->id = id;
  64   component->state = NICE_COMPONENT_STATE_DISCONNECTED;
  65   component->restart_candidate = NULL;
  66   return component;
  67 }
  68
  69
  70 void
  71 component_free (Component *cmp)
  72 {
  73   GSList *i;
  74   GList *item;
  75
  76   for (i = cmp->local_candidates; i; i = i->next) {
  77     NiceCandidate *candidate = i->data;
  78     nice_candidate_free (candidate);
  79   }
  80
  81   for (i = cmp->remote_candidates; i; i = i->next) {
  82     NiceCandidate *candidate = i->data;
  83     nice_candidate_free (candidate);
  84   }
  85
  86   if (cmp->restart_candidate)
  87     nice_candidate_free (cmp->restart_candidate),
  88       cmp->restart_candidate = NULL;
  89
  90   for (i = cmp->sockets; i; i = i->next) {
  91     NiceSocket *udpsocket = i->data;
  92     nice_socket_free (udpsocket);
  93   }
  94
  95   for (i = cmp->gsources; i; i = i->next) {
  96     GSource *source = i->data;
  97     g_source_destroy (source);
  98     g_source_unref (source);
  99   }
 100
 101   for (i = cmp->incoming_checks; i; i = i->next) {
 102     IncomingCheck *icheck = i->data;
 103     g_slice_free (IncomingCheck, icheck);
 104   }
 105
 106   g_slist_free (cmp->local_candidates);
 107   g_slist_free (cmp->remote_candidates);
 108   g_slist_free (cmp->sockets);
 109   g_slist_free (cmp->gsources);
 110   g_slist_free (cmp->incoming_checks);
 111
 112   for (item = cmp->turn_servers; item; item = g_list_next (item)) {
 113     TurnServer *turn = item->data;
 114     g_free (turn->username);
 115     g_free (turn->password);
 116     g_slice_free (TurnServer, turn);
 117   }
 118   g_list_free (cmp->turn_servers);
 119
 120   g_slice_free (Component, cmp);
 121 }
 122
 123 /*
 124  * Finds a candidate pair that has matching foundation ids.
 125  *
 126  * @return TRUE if pair found, pointer to pair stored at 'pair'
 127  */
 128 gboolean
 129 component_find_pair (Component *cmp, NiceAgent *agent, const gchar *lfoundation, const gchar *rfoundation, CandidatePair *pair)
 130 {
 131   GSList *i;
 132   CandidatePair result;
 133
 134   memset (&result, 0, sizeof(result));
 135
 136   for (i = cmp->local_candidates; i; i = i->next) {
 137     NiceCandidate *candidate = i->data;
 138     if (strncmp (candidate->foundation, lfoundation, NICE_CANDIDATE_MAX_FOUNDATION) == 0) {
 139       result.local = candidate;
 140       break;
 141     }
 142   }
 143
 144   for (i = cmp->remote_candidates; i; i = i->next) {
 145     NiceCandidate *candidate = i->data;
 146     if (strncmp (candidate->foundation, rfoundation, NICE_CANDIDATE_MAX_FOUNDATION) == 0) {
 147       result.remote = candidate;
 148       break;
 149     }
 150   }
 151
 152   if (result.local && result.remote) {
 153     result.priority = agent_candidate_pair_priority (agent, result.local, result.remote);
 154     if (pair)
 155       *pair = result;
 156     return TRUE;
 157   }
 158
 159   return FALSE;
 160 }
 161
 162 /*
 163  * Resets the component state to that of a ICE restarted
 164  * session.
 165  */
 166 gboolean
 167 component_restart (Component *cmp)
 168 {
 169   GSList *i;
 170
 171   for (i = cmp->remote_candidates; i; i = i->next) {
 172     NiceCandidate *candidate = i->data;
 173
 174     /* note: do not remove the remote candidate that is
 175      *       currently part of the 'selected pair', see ICE
 176      *       9.1.1.1. "ICE Restarts" (ID-19) */
 177     if (candidate == cmp->selected_pair.remote) {
 178       if (cmp->restart_candidate)
 179         nice_candidate_free (cmp->restart_candidate);
 180       cmp->restart_candidate = candidate;
 181     }
 182     else
 183       nice_candidate_free (candidate);
 184   }
 185   g_slist_free (cmp->remote_candidates),
 186     cmp->remote_candidates = NULL;
 187
 188   for (i = cmp->incoming_checks; i; i = i->next) {
 189     IncomingCheck *icheck = i->data;
 190     g_slice_free (IncomingCheck, icheck);
 191   }
 192
 193   /* note: component state managed by agent */
 194
 195   return TRUE;
 196 }
 197
 198 /*
 199  * Changes the selected pair for the component to 'pair'. Does not
 200  * emit the "selected-pair-changed" signal.
 201  */
 202 void component_update_selected_pair (Component *component, const CandidatePair *pair)
 203 {
 204   g_assert (component);
 205   g_assert (pair);
 206   nice_debug ("setting SELECTED PAIR for component %u: %s:%s (prio:%lu).",
 207            component->id, pair->local->foundation, pair->remote->foundation, (long unsigned)pair->priority);
 208
 209   if (component->selected_pair.keepalive.tick_source != NULL) {
 210     g_source_destroy (component->selected_pair.keepalive.tick_source);
 211     g_source_unref (component->selected_pair.keepalive.tick_source);
 212     component->selected_pair.keepalive.tick_source = NULL;
 213   }
 214
 215   memset (&component->selected_pair, 0, sizeof(CandidatePair));
 216
 217   component->selected_pair.local = pair->local;
 218   component->selected_pair.remote = pair->remote;
 219   component->selected_pair.priority = pair->priority;
 220
 221
 222 }
 223
 224 /*
 225  * Finds a remote candidate with matching address and
 226  * transport.
 227  *
 228  * @return pointer to candidate or NULL if not found
 229  */
 230 NiceCandidate *
 231 component_find_remote_candidate (const Component *component, const NiceAddress *addr, NiceCandidateTransport transport)
 232 {
 233   GSList *i;
 234
 235   for (i = component->remote_candidates; i; i = i->next) {
 236     NiceCandidate *candidate = i->data;
 237
 238     if (nice_address_equal(&candidate->addr, addr) &&
 239         candidate->transport == transport)
 240       return candidate;
 241
 242   }
 243
 244   return NULL;
 245 }
 246
 247 /*
 248  * Sets the desired remote candidate as the selected pair
 249  *
 250  * It will start sending on the highest priority pair available with
 251  * this candidate.
 252  */
 253
 254 NiceCandidate *
 255 component_set_selected_remote_candidate (NiceAgent *agent, Component *component,
 256     NiceCandidate *candidate)
 257 {
 258   NiceCandidate *local = NULL;
 259   NiceCandidate *remote = NULL;
 260   guint32 priority = 0;
 261   GSList *item = NULL;
 262
 263   for (item = component->local_candidates; item; item = g_slist_next (item)) {
 264     NiceCandidate *tmp = item->data;
 265     guint32 tmp_prio = 0;
 266
 267     if (tmp->transport != candidate->transport ||
 268         tmp->addr.s.addr.sa_family != candidate->addr.s.addr.sa_family ||
 269         tmp->type != NICE_CANDIDATE_TYPE_HOST)
 270       continue;
 271
 272     tmp_prio = agent_candidate_pair_priority (agent, tmp, candidate);
 273
 274     if (tmp_prio > priority) {
 275       priority = tmp_prio;
 276       local = tmp;
 277     }
 278   }
 279
 280   if (local == NULL)
 281     return NULL;
 282
 283   remote = component_find_remote_candidate (component, &candidate->addr,
 284       candidate->transport);
 285
 286   if (!remote) {
 287     GSList *modified_list = NULL;
 288
 289     remote = nice_candidate_copy (candidate);
 290
 291     modified_list = g_slist_append (component->remote_candidates,
 292                                     remote);
 293     if (modified_list) {
 294       component->remote_candidates = modified_list;
 295       agent_signal_new_remote_candidate (agent, remote);
 296     }
 297     else { /* error: memory alloc / list */
 298       nice_candidate_free (remote), remote = NULL;
 299       return NULL;
 300     }
 301   }
 302
 303   if (component->selected_pair.keepalive.tick_source != NULL) {
 304     g_source_destroy (component->selected_pair.keepalive.tick_source);
 305     g_source_unref (component->selected_pair.keepalive.tick_source);
 306     component->selected_pair.keepalive.tick_source = NULL;
 307   }
 308
 309   memset (&component->selected_pair, 0, sizeof(CandidatePair));
 310   component->selected_pair.local = local;
 311   component->selected_pair.remote = remote;
 312   component->selected_pair.priority = priority;
 313
 314   return local;
 315 }