component.c 13.4 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:
 *   Dafydd Harries, Collabora Ltd.
26
 *   Youness Alaoui, Collabora Ltd.
27
 *   Kai Vehmanen, Nokia
28
29
30
31
32
33
34
35
36
37
38
 *
 * 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.
 */
39

40
/*
41
42
43
44
45
46
47
48
 * @file component.c
 * @brief ICE component functions
 */

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

49
50
#include <string.h>

51
52
#include "debug.h"

53
#include "component.h"
54
#include "agent-priv.h"
55

56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76

static void
socket_source_detach (SocketSource *source)
{
  if (source->source != NULL) {
    g_source_destroy (source->source);
    g_source_unref (source->source);
  }
  source->source = NULL;
}

static void
socket_source_free (SocketSource *source)
{
  nice_socket_free (source->socket);
  socket_source_detach (source);

  g_slice_free (SocketSource, source);
}


77
Component *
78
component_new (guint id, NiceAgent *agent, Stream *stream)
79
80
81
82
{
  Component *component;

  component = g_slice_new0 (Component);
83
  component->id = id;
84
85
  component->state = NICE_COMPONENT_STATE_DISCONNECTED;
  component->restart_candidate = NULL;
86
  component->tcp = NULL;
87
88
  component->agent = agent;
  component->stream = stream;
89

90
91
92
93
94
95
96
  return component;
}

void
component_free (Component *cmp)
{
  GSList *i;
97
  GList *item;
98

99
100
101
102
  for (i = cmp->local_candidates; i; i = i->next) {
    NiceCandidate *candidate = i->data;
    nice_candidate_free (candidate);
  }
103

104
105
106
107
  for (i = cmp->remote_candidates; i; i = i->next) {
    NiceCandidate *candidate = i->data;
    nice_candidate_free (candidate);
  }
108

109
110
111
112
  if (cmp->restart_candidate)
    nice_candidate_free (cmp->restart_candidate),
      cmp->restart_candidate = NULL;

113
114
  for (i = cmp->incoming_checks; i; i = i->next) {
    IncomingCheck *icheck = i->data;
115
    g_free (icheck->username);
116
117
    g_slice_free (IncomingCheck, icheck);
  }
118
119
120

  g_slist_free (cmp->local_candidates);
  g_slist_free (cmp->remote_candidates);
121
  g_slist_free_full (cmp->socket_sources, (GDestroyNotify) socket_source_free);
122
  g_slist_free (cmp->incoming_checks);
123

124
125
126
127
128
129
130
  for (item = cmp->turn_servers; item; item = g_list_next (item)) {
    TurnServer *turn = item->data;
    g_free (turn->username);
    g_free (turn->password);
    g_slice_free (TurnServer, turn);
  }
  g_list_free (cmp->turn_servers);
131

132
133
134
135
136
137
  if (cmp->selected_pair.keepalive.tick_source != NULL) {
    g_source_destroy (cmp->selected_pair.keepalive.tick_source);
    g_source_unref (cmp->selected_pair.keepalive.tick_source);
    cmp->selected_pair.keepalive.tick_source = NULL;
  }

138
139
140
141
142
143
144
145
146
147
148
  if (cmp->tcp_clock) {
    g_source_destroy (cmp->tcp_clock);
    g_source_unref (cmp->tcp_clock);
    cmp->tcp_clock = NULL;
  }
  if (cmp->tcp) {
    pseudo_tcp_socket_close (cmp->tcp, TRUE);
    g_object_unref (cmp->tcp);
    cmp->tcp = NULL;
  }

149
150
151
152
153
  if (cmp->ctx != NULL) {
    g_main_context_unref (cmp->ctx);
    cmp->ctx = NULL;
  }

154
155
156
  g_slice_free (Component, cmp);
}

157
/*
158
159
160
161
162
163
164
165
 * Finds a candidate pair that has matching foundation ids.
 *
 * @return TRUE if pair found, pointer to pair stored at 'pair'
 */
gboolean
component_find_pair (Component *cmp, NiceAgent *agent, const gchar *lfoundation, const gchar *rfoundation, CandidatePair *pair)
{
  GSList *i;
166
167
168
  CandidatePair result;

  memset (&result, 0, sizeof(result));
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

  for (i = cmp->local_candidates; i; i = i->next) {
    NiceCandidate *candidate = i->data;
    if (strncmp (candidate->foundation, lfoundation, NICE_CANDIDATE_MAX_FOUNDATION) == 0) {
      result.local = candidate;
      break;
    }
  }

  for (i = cmp->remote_candidates; i; i = i->next) {
    NiceCandidate *candidate = i->data;
    if (strncmp (candidate->foundation, rfoundation, NICE_CANDIDATE_MAX_FOUNDATION) == 0) {
      result.remote = candidate;
      break;
    }
  }

  if (result.local && result.remote) {
    result.priority = agent_candidate_pair_priority (agent, result.local, result.remote);
    if (pair)
      *pair = result;
    return TRUE;
  }

  return FALSE;
}

196
/*
197
198
199
200
201
202
203
204
205
206
207
208
209
 * Resets the component state to that of a ICE restarted
 * session.
 */
gboolean
component_restart (Component *cmp)
{
  GSList *i;

  for (i = cmp->remote_candidates; i; i = i->next) {
    NiceCandidate *candidate = i->data;

    /* note: do not remove the remote candidate that is
     *       currently part of the 'selected pair', see ICE
210
     *       9.1.1.1. "ICE Restarts" (ID-19) */
211
212
213
214
215
216
217
218
219
220
221
    if (candidate == cmp->selected_pair.remote) {
      if (cmp->restart_candidate)
	nice_candidate_free (cmp->restart_candidate);
      cmp->restart_candidate = candidate;
    }
    else 
      nice_candidate_free (candidate);
  }
  g_slist_free (cmp->remote_candidates),
    cmp->remote_candidates = NULL;

222
223
  for (i = cmp->incoming_checks; i; i = i->next) {
    IncomingCheck *icheck = i->data;
224
    g_free (icheck->username);
225
226
    g_slice_free (IncomingCheck, icheck);
  }
227
228
  g_slist_free (cmp->incoming_checks);
  cmp->incoming_checks = NULL;
229

230
231
232
233
  /* note: component state managed by agent */

  return TRUE;
}
234

235
/*
236
237
238
239
240
241
242
 * Changes the selected pair for the component to 'pair'. Does not
 * emit the "selected-pair-changed" signal.
 */ 
void component_update_selected_pair (Component *component, const CandidatePair *pair)
{
  g_assert (component);
  g_assert (pair);
243
244
245
  nice_debug ("setting SELECTED PAIR for component %u: %s:%s (prio:%"
      G_GUINT64_FORMAT ").", component->id, pair->local->foundation,
      pair->remote->foundation, pair->priority);
246
247
248
249
250
251
252
253
254

  if (component->selected_pair.keepalive.tick_source != NULL) {
    g_source_destroy (component->selected_pair.keepalive.tick_source);
    g_source_unref (component->selected_pair.keepalive.tick_source);
    component->selected_pair.keepalive.tick_source = NULL;
  }

  memset (&component->selected_pair, 0, sizeof(CandidatePair));

255
256
257
  component->selected_pair.local = pair->local;
  component->selected_pair.remote = pair->remote;
  component->selected_pair.priority = pair->priority;
258

259
}
260

261
/*
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
 * Finds a remote candidate with matching address and 
 * transport.
 *
 * @return pointer to candidate or NULL if not found
 */
NiceCandidate *
component_find_remote_candidate (const Component *component, const NiceAddress *addr, NiceCandidateTransport transport)
{
  GSList *i;

  for (i = component->remote_candidates; i; i = i->next) {
    NiceCandidate *candidate = i->data;

    if (nice_address_equal(&candidate->addr, addr) &&
	candidate->transport == transport)
      return candidate;

  }
  
  return NULL;
}
283
284
285
286
287
288
289
290
291
292
293
294
295
296

/*
 * Sets the desired remote candidate as the selected pair
 *
 * It will start sending on the highest priority pair available with
 * this candidate.
 */

NiceCandidate *
component_set_selected_remote_candidate (NiceAgent *agent, Component *component,
    NiceCandidate *candidate)
{
  NiceCandidate *local = NULL;
  NiceCandidate *remote = NULL;
297
  guint64 priority = 0;
298
299
300
301
  GSList *item = NULL;

  for (item = component->local_candidates; item; item = g_slist_next (item)) {
    NiceCandidate *tmp = item->data;
302
    guint64 tmp_prio = 0;
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324

    if (tmp->transport != candidate->transport ||
	tmp->addr.s.addr.sa_family != candidate->addr.s.addr.sa_family ||
        tmp->type != NICE_CANDIDATE_TYPE_HOST)
      continue;

    tmp_prio = agent_candidate_pair_priority (agent, tmp, candidate);

    if (tmp_prio > priority) {
      priority = tmp_prio;
      local = tmp;
    }
  }

  if (local == NULL)
    return NULL;

  remote = component_find_remote_candidate (component, &candidate->addr,
      candidate->transport);

  if (!remote) {
    remote = nice_candidate_copy (candidate);
325
326
327
    component->remote_candidates = g_slist_append (component->remote_candidates,
        remote);
    agent_signal_new_remote_candidate (agent, remote);
328
329
  }

330
331
332
333
334
335
336
  if (component->selected_pair.keepalive.tick_source != NULL) {
    g_source_destroy (component->selected_pair.keepalive.tick_source);
    g_source_unref (component->selected_pair.keepalive.tick_source);
    component->selected_pair.keepalive.tick_source = NULL;
  }

  memset (&component->selected_pair, 0, sizeof(CandidatePair));
337
338
339
340
341
342
  component->selected_pair.local = local;
  component->selected_pair.remote = remote;
  component->selected_pair.priority = priority;

  return local;
}
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
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447

static gint
_find_socket_source (gconstpointer a, gconstpointer b)
{
  const SocketSource *source_a = a;
  const NiceSocket *socket_b = b;

  return (source_a->socket == socket_b) ? 0 : 1;
}

/* This takes ownership of socket and source.
 * It attaches the source to the component’s context. */
void
component_add_socket_source (Component *component, NiceSocket *socket,
    GSource *source)
{
  GSList *l;
  SocketSource *socket_source;

  g_assert (component != NULL);
  g_assert (socket != NULL);
  g_assert (source != NULL);

  /* Find an existing SocketSource in the component which contains socket, or
   * create a new one. */
  l = g_slist_find_custom (component->socket_sources, socket,
          _find_socket_source);
  if (l != NULL) {
    socket_source = l->data;
  } else {
    socket_source = g_slice_new0 (SocketSource);
    socket_source->socket = socket;
    component->socket_sources =
        g_slist_prepend (component->socket_sources, socket_source);
  }

  /* Add the source. */
  g_assert (socket_source->source == NULL);
  g_assert (component->ctx != NULL);
  socket_source->source = source;
  g_source_attach (source, component->ctx);
}

void
component_add_detached_socket (Component *component, NiceSocket *socket)
{
  SocketSource *socket_source;

  socket_source = g_slice_new0 (SocketSource);
  socket_source->socket = socket;
  socket_source->source = NULL;
  component->socket_sources =
      g_slist_prepend (component->socket_sources, socket_source);
}

/**
 * component_detach_socket_source:
 * @component: a #Component
 * @socket: the socket to detach the source for
 *
 * Detach the #GSource for the single specified @socket. Leave the socket itself
 * untouched.
 *
 * If the @socket doesn’t exist in this @component, do nothing.
 */
void
component_detach_socket_source (Component *component, NiceSocket *socket)
{
  GSList *l;
  SocketSource *socket_source;

  /* Find the SocketSource for the socket. */
  l = g_slist_find_custom (component->socket_sources, socket,
          _find_socket_source);
  if (l == NULL)
    return;

  /* Detach the source. */
  socket_source = l->data;
  socket_source_detach (socket_source);
}

/*
 * Detaches socket handles of @component from the main context. Leaves the
 * sockets themselves untouched.
 */
void
component_detach_socket_sources (Component *component)
{
  GSList *i;

  for (i = component->socket_sources; i != NULL; i = i->next) {
    SocketSource *socket_source = i->data;
    nice_debug ("Detach source %p.", socket_source->source);
    socket_source_detach (socket_source);
  }
}

void
component_free_socket_sources (Component *component)
{
  g_slist_free_full (component->socket_sources,
      (GDestroyNotify) socket_source_free);
  component->socket_sources = NULL;
}
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475

void
component_set_io_callback (Component *component, NiceAgentRecvFunc func,
    gpointer user_data, GMainContext *context)
{
  /* Reference the context early so we don’t accidentally free it below. */
  if (context != NULL && func != NULL)
    g_main_context_ref (context);

  if (component->io_callback != NULL)
    component_detach_socket_sources (component);

  component->io_callback = NULL;
  component->io_user_data = NULL;

  if (component->ctx != NULL)
    g_main_context_unref (component->ctx);
  component->ctx = NULL;

  if (func != NULL) {
    component->io_callback = func;
    component->io_user_data = user_data;
    component->ctx = context;  /* referenced above */
  }
}

/* This must be called with the agent lock *held*. */
void
476
477
component_emit_io_callback (Component *component,
    const guint8 *buf, gsize buf_len)
478
{
479
480
  NiceAgent *agent;
  guint stream_id, component_id;
481
482
483
484
485
486
487
  NiceAgentRecvFunc io_callback;
  gpointer io_user_data;

  g_assert (component != NULL);
  g_assert (buf != NULL);
  g_assert (buf_len > 0);

488
489
490
  agent = component->agent;
  stream_id = component->stream->id;
  component_id = component->id;
491
492
493
  io_callback = component->io_callback;
  io_user_data = component->io_user_data;

494
495
496
497
498
  g_assert (NICE_IS_AGENT (agent));
  g_assert (stream_id > 0);
  g_assert (component_id > 0);
  g_assert (io_callback != NULL);

499
500
501
502
503
504
505
  agent_unlock ();

  io_callback (agent, stream_id, component_id,
      buf_len, (gchar *) buf, io_user_data);

  agent_lock ();
}