component.c 22.1 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
static void
component_schedule_io_callback (Component *component);
static void
component_deschedule_io_callback (Component *component);


/* Must *not* take the agent lock, since it’s called from within
64
 * component_set_io_context(), which holds the Component’s I/O lock. */
65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85
static void
socket_source_attach (SocketSource *socket_source, GMainContext *context)
{
  GSource *source;

  /* Create a source. */
  source = g_socket_create_source (socket_source->socket->fileno,
      G_IO_IN, NULL);
  g_source_set_callback (source, (GSourceFunc) component_io_cb,
      socket_source, NULL);

  /* Add the source. */
  nice_debug ("Attaching source %p (socket %p, FD %d) to context %p", source,
      socket_source->socket, g_socket_get_fd (socket_source->socket->fileno),
      context);

  g_assert (socket_source->source == NULL);
  socket_source->source = source;
  g_source_attach (source, context);
}

86 87 88
static void
socket_source_detach (SocketSource *source)
{
89 90 91 92 93 94
  nice_debug ("Detaching source %p (socket %p, FD %d) from context %p",
      source->source, source->socket,
      (source->socket->fileno != NULL) ?
          g_socket_get_fd (source->socket->fileno) : 0,
      (source->source != NULL) ? g_source_get_context (source->source) : 0);

95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110
  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);
}

111
Component *
112
component_new (guint id, NiceAgent *agent, Stream *stream)
113 114 115 116
{
  Component *component;

  component = g_slice_new0 (Component);
117
  component->id = id;
118 119
  component->state = NICE_COMPONENT_STATE_DISCONNECTED;
  component->restart_candidate = NULL;
120
  component->tcp = NULL;
121 122
  component->agent = agent;
  component->stream = stream;
123

124 125 126 127 128 129 130 131
  g_mutex_init (&component->io_mutex);
  g_queue_init (&component->pending_io_messages);
  component->io_callback_id = 0;

  /* Start off with a fresh main context and all I/O paused. This
   * will be updated when nice_agent_attach_recv() or nice_agent_recv() are
   * called. */
  component_set_io_context (component, NULL);
132
  component_set_io_callback (component, NULL, NULL, NULL, 0, NULL);
133

134 135 136 137 138 139 140
  return component;
}

void
component_free (Component *cmp)
{
  GSList *i;
141
  GList *item;
142
  IOCallbackData *data;
143

144 145 146 147
  for (i = cmp->local_candidates; i; i = i->next) {
    NiceCandidate *candidate = i->data;
    nice_candidate_free (candidate);
  }
148

149 150 151 152
  for (i = cmp->remote_candidates; i; i = i->next) {
    NiceCandidate *candidate = i->data;
    nice_candidate_free (candidate);
  }
153

154 155 156 157
  if (cmp->restart_candidate)
    nice_candidate_free (cmp->restart_candidate),
      cmp->restart_candidate = NULL;

158 159
  for (i = cmp->incoming_checks; i; i = i->next) {
    IncomingCheck *icheck = i->data;
160
    g_free (icheck->username);
161 162
    g_slice_free (IncomingCheck, icheck);
  }
163 164 165

  g_slist_free (cmp->local_candidates);
  g_slist_free (cmp->remote_candidates);
166
  component_free_socket_sources (cmp);
167
  g_slist_free (cmp->incoming_checks);
168

169 170 171 172 173 174 175
  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);
176

177 178 179 180 181 182
  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;
  }

183 184 185 186 187 188 189 190 191 192 193
  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;
  }

194 195 196 197 198
  while ((data = g_queue_pop_head (&cmp->pending_io_messages)) != NULL)
    io_callback_data_free (data);

  component_deschedule_io_callback (cmp);

199 200 201 202 203
  if (cmp->ctx != NULL) {
    g_main_context_unref (cmp->ctx);
    cmp->ctx = NULL;
  }

204 205
  g_mutex_clear (&cmp->io_mutex);

206 207 208
  g_slice_free (Component, cmp);
}

209
/*
210 211 212 213 214 215 216 217
 * 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;
218 219 220
  CandidatePair result;

  memset (&result, 0, sizeof(result));
221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247

  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;
}

248
/*
249 250 251 252 253 254 255 256 257 258 259 260 261
 * 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
262
     *       9.1.1.1. "ICE Restarts" (ID-19) */
263 264 265 266 267 268 269 270 271 272 273
    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;

274 275
  for (i = cmp->incoming_checks; i; i = i->next) {
    IncomingCheck *icheck = i->data;
276
    g_free (icheck->username);
277 278
    g_slice_free (IncomingCheck, icheck);
  }
279 280
  g_slist_free (cmp->incoming_checks);
  cmp->incoming_checks = NULL;
281

282 283 284 285
  /* note: component state managed by agent */

  return TRUE;
}
286

287
/*
288 289 290 291 292 293 294
 * 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);
295 296 297
  nice_debug ("setting SELECTED PAIR for component %u: %s:%s (prio:%"
      G_GUINT64_FORMAT ").", component->id, pair->local->foundation,
      pair->remote->foundation, pair->priority);
298 299 300 301 302 303 304 305 306

  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));

307 308 309
  component->selected_pair.local = pair->local;
  component->selected_pair.remote = pair->remote;
  component->selected_pair.priority = pair->priority;
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
 * 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;
}
335 336 337 338 339 340 341 342 343 344 345 346 347 348

/*
 * 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;
349
  guint64 priority = 0;
350 351 352 353
  GSList *item = NULL;

  for (item = component->local_candidates; item; item = g_slist_next (item)) {
    NiceCandidate *tmp = item->data;
354
    guint64 tmp_prio = 0;
355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376

    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);
377 378 379
    component->remote_candidates = g_slist_append (component->remote_candidates,
        remote);
    agent_signal_new_remote_candidate (agent, remote);
380 381
  }

382 383 384 385 386 387 388
  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));
389 390 391 392 393 394
  component->selected_pair.local = local;
  component->selected_pair.remote = remote;
  component->selected_pair.priority = priority;

  return local;
}
395 396 397 398 399 400 401 402 403 404

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;
}

405 406
/* This takes ownership of the socket.
 * It creates and attaches a source to the component’s context. */
407
void
408
component_attach_socket (Component *component, NiceSocket *socket)
409 410 411 412 413 414 415
{
  GSList *l;
  SocketSource *socket_source;

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

416 417 418
  g_assert (component->ctx != NULL);

  /* Find an existing SocketSource in the component which contains @socket, or
419 420 421 422 423 424 425 426
   * 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;
427
    socket_source->component = component;
428 429 430 431
    component->socket_sources =
        g_slist_prepend (component->socket_sources, socket_source);
  }

432 433 434 435
  /* Create and attach a source */
  nice_debug ("Component %p (agent %p): Attach source (stream %u).",
      component, component->agent, component->stream->id);
  socket_source_attach (socket_source, component->ctx);
436 437
}

438 439 440
/* Reattaches socket handles of @component to the main context.
 *
 * Must *not* take the agent lock, since it’s called from within
441
 * component_set_io_context(), which holds the Component’s I/O lock. */
442 443
static void
component_reattach_all_sockets (Component *component)
444
{
445
  GSList *i;
446

447 448 449 450 451 452
  for (i = component->socket_sources; i != NULL; i = i->next) {
    SocketSource *socket_source = i->data;
    nice_debug ("Reattach source %p.", socket_source->source);
    socket_source_detach (socket_source);
    socket_source_attach (socket_source, component->ctx);
  }
453 454 455
}

/**
456
 * component_detach_socket:
457 458 459 460 461 462 463 464 465
 * @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
466
component_detach_socket (Component *component, NiceSocket *socket)
467 468 469 470
{
  GSList *l;
  SocketSource *socket_source;

471 472
  nice_debug ("Detach socket %p.", socket);

473 474 475 476 477 478 479 480 481 482 483 484 485 486
  /* 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.
487 488
 *
 * Must *not* take the agent lock, since it’s called from within
489
 * component_set_io_context(), which holds the Component’s I/O lock.
490 491
 */
void
492
component_detach_all_sockets (Component *component)
493 494 495 496 497
{
  GSList *i;

  for (i = component->socket_sources; i != NULL; i = i->next) {
    SocketSource *socket_source = i->data;
498 499
    nice_debug ("Detach source %p, socket %p.", socket_source->source,
        socket_source->socket);
500 501 502 503 504 505 506
    socket_source_detach (socket_source);
  }
}

void
component_free_socket_sources (Component *component)
{
507 508
  nice_debug ("Free socket sources for component %p.", component);

509 510 511 512
  g_slist_free_full (component->socket_sources,
      (GDestroyNotify) socket_source_free);
  component->socket_sources = NULL;
}
513

514 515 516 517 518 519
GMainContext *
component_dup_io_context (Component *component)
{
  return g_main_context_ref (component->ctx);
}

520 521
/* If @context is %NULL, a fresh context is used, so component->ctx is always
 * guaranteed to be non-%NULL. */
522
void
523
component_set_io_context (Component *component, GMainContext *context)
524
{
525 526
  g_mutex_lock (&component->io_mutex);

527 528 529 530 531 532 533 534 535 536 537 538
  if (component->ctx != context || component->ctx == NULL) {
    if (context == NULL)
      context = g_main_context_new ();
    else
      g_main_context_ref (context);

    component_detach_all_sockets (component);
    if (component->ctx != NULL)
      g_main_context_unref (component->ctx);
    component->ctx = context;
    component_reattach_all_sockets (component);
  }
539

540 541
  g_mutex_unlock (&component->io_mutex);
}
542

543 544 545
/* (func, user_data) and (recv_buf, recv_buf_len) are mutually exclusive.
 * At most one of the two must be specified; if both are NULL, the Component
 * will not receive any data (i.e. reception is paused). */
546 547
void
component_set_io_callback (Component *component,
548 549 550
    NiceAgentRecvFunc func, gpointer user_data,
    guint8 *recv_buf, gsize recv_buf_len,
    GError **error)
551
{
552 553 554 555
  g_assert (func == NULL || recv_buf == NULL);
  g_assert (recv_buf != NULL || recv_buf_len == 0);
  g_assert (error == NULL || *error == NULL);

556
  g_mutex_lock (&component->io_mutex);
557 558 559 560

  if (func != NULL) {
    component->io_callback = func;
    component->io_user_data = user_data;
561 562
    component->recv_buf = NULL;
    component->recv_buf_len = 0;
563 564 565

    component_schedule_io_callback (component);
  } else {
566 567
    component->io_callback = NULL;
    component->io_user_data = NULL;
568 569
    component->recv_buf = recv_buf;
    component->recv_buf_len = recv_buf_len;
570

571
    component_deschedule_io_callback (component);
572
  }
573

574 575 576
  component->recv_buf_valid_len = 0;
  component->recv_buf_error = error;

577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681
  g_mutex_unlock (&component->io_mutex);
}

gboolean
component_has_io_callback (Component *component)
{
  gboolean has_io_callback;

  g_mutex_lock (&component->io_mutex);
  has_io_callback = (component->io_callback != NULL);
  g_mutex_unlock (&component->io_mutex);

  return has_io_callback;
}

IOCallbackData *
io_callback_data_new (const guint8 *buf, gsize buf_len)
{
  IOCallbackData *data;

  data = g_slice_new0 (IOCallbackData);
  data->buf = g_memdup (buf, buf_len);
  data->buf_len = buf_len;
  data->offset = 0;

  return data;
}

void
io_callback_data_free (IOCallbackData *data)
{
  g_free (data->buf);
  g_slice_free (IOCallbackData, data);
}

/* This is called with the global agent lock released. It does not take that
 * lock, but does take the io_mutex. */
static gboolean
emit_io_callback_cb (gpointer user_data)
{
  Component *component = user_data;
  IOCallbackData *data;
  NiceAgentRecvFunc io_callback;
  gpointer io_user_data;
  guint stream_id, component_id;
  NiceAgent *agent;

  agent = component->agent;
  g_object_add_weak_pointer (G_OBJECT (agent), (gpointer *) &agent);

  stream_id = component->stream->id;
  component_id = component->id;

  g_mutex_lock (&component->io_mutex);

  /* The members of Component are guaranteed not to have changed since this
   * GSource was attached in component_emit_io_callback(). The Component’s agent
   * and stream are immutable after construction, as are the stream and
   * component IDs. The callback and its user data may have changed, but are
   * guaranteed to be non-%NULL at the start as the idle source is removed when
   * the callback is set to %NULL. They may become %NULL during the io_callback,
   * so must be re-checked every loop iteration. The data buffer is copied into
   * the #IOCallbackData closure.
   *
   * If the component is destroyed (which happens if the agent or stream are
   * destroyed) between attaching the GSource and firing it, the GSource is
   * detached in component_free() and this callback is never invoked. If the
   * agent is destroyed during an io_callback, its weak pointer will be
   * nullified. Similarly, the Component needs to be re-queried for after every
   * iteration, just in case the client has removed the stream in the
   * callback. */
  while (TRUE) {
    io_callback = component->io_callback;
    io_user_data = component->io_user_data;
    data = g_queue_peek_head (&component->pending_io_messages);

    if (data == NULL || io_callback == NULL)
      break;

    g_mutex_unlock (&component->io_mutex);

    io_callback (agent, stream_id, component_id,
        data->buf_len - data->offset, (gchar *) data->buf + data->offset,
        io_user_data);

    /* Check for the user destroying things underneath our feet. */
    if (agent == NULL ||
        !agent_find_component (agent, stream_id, component_id,
            NULL, &component)) {
      nice_debug ("%s: Agent or component destroyed.", G_STRFUNC);
      return G_SOURCE_REMOVE;
    }

    g_queue_pop_head (&component->pending_io_messages);
    io_callback_data_free (data);

    g_mutex_lock (&component->io_mutex);
  }

  component->io_callback_id = 0;
  g_mutex_unlock (&component->io_mutex);

  g_object_remove_weak_pointer (G_OBJECT (agent), (gpointer *) &agent);

  return G_SOURCE_REMOVE;
682 683 684 685
}

/* This must be called with the agent lock *held*. */
void
686 687
component_emit_io_callback (Component *component,
    const guint8 *buf, gsize buf_len)
688
{
689 690
  NiceAgent *agent;
  guint stream_id, component_id;
691 692 693 694 695 696 697
  NiceAgentRecvFunc io_callback;
  gpointer io_user_data;

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

698 699 700
  agent = component->agent;
  stream_id = component->stream->id;
  component_id = component->id;
701 702

  g_mutex_lock (&component->io_mutex);
703 704
  io_callback = component->io_callback;
  io_user_data = component->io_user_data;
705 706 707 708 709 710
  g_mutex_unlock (&component->io_mutex);

  /* Allow this to be called with a NULL io_callback, since the caller can’t
   * lock io_mutex to check beforehand. */
  if (io_callback == NULL)
    return;
711

712 713 714 715 716
  g_assert (NICE_IS_AGENT (agent));
  g_assert (stream_id > 0);
  g_assert (component_id > 0);
  g_assert (io_callback != NULL);

717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748
  /* Only allocate a closure if the callback is being deferred to an idle
   * handler. */
  if (g_main_context_is_owner (component->ctx)) {
    /* Thread owns the main context, so invoke the callback directly. */
    agent_unlock ();
    io_callback (agent, stream_id,
        component_id, buf_len, (gchar *) buf, io_user_data);
    agent_lock ();
  } else {
    IOCallbackData *data;

    g_mutex_lock (&component->io_mutex);

    /* Slow path: Current thread doesn’t own the Component’s context at the
     * moment, so schedule the callback in an idle handler. */
    data = io_callback_data_new (buf, buf_len);
    g_queue_push_tail (&component->pending_io_messages,
        data);  /* transfer ownership */

    nice_debug ("%s: **WARNING: SLOW PATH**", G_STRFUNC);

    component_schedule_io_callback (component);

    g_mutex_unlock (&component->io_mutex);
  }
}

/* Note: Must be called with the io_mutex held. */
static void
component_schedule_io_callback (Component *component)
{
  GSource *source;
749

750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773
  /* Already scheduled or nothing to schedule? */
  if (component->io_callback_id != 0 ||
      g_queue_is_empty (&component->pending_io_messages))
    return;

  /* Add the idle callback. If nice_agent_attach_recv() is called with a
   * NULL callback before this source is dispatched, the source will be
   * destroyed, but any pending data will remain in
   * component->pending_io_messages, ready to be picked up when a callback
   * is re-attached, or if nice_agent_recv() is called. */
  source = g_idle_source_new ();
  g_source_set_priority (source, G_PRIORITY_DEFAULT);
  g_source_set_callback (source, emit_io_callback_cb, component, NULL);
  component->io_callback_id = g_source_attach (source, component->ctx);
  g_source_unref (source);
}

/* Note: Must be called with the io_mutex held. */
static void
component_deschedule_io_callback (Component *component)
{
  /* Already descheduled? */
  if (component->io_callback_id == 0)
    return;
774

775 776
  g_source_remove (component->io_callback_id);
  component->io_callback_id = 0;
777
}