gdbusprivate.c 68.5 KB
Newer Older
1 2
/* GDBus - GLib D-Bus Library
 *
3
 * Copyright (C) 2008-2010 Red Hat, Inc.
4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General
 * Public License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
 * Boston, MA 02111-1307, USA.
 *
 * Author: David Zeuthen <davidz@redhat.com>
 */

#include "config.h"

#include <stdlib.h>
#include <string.h>
Matthias Clasen's avatar
Matthias Clasen committed
27
#ifdef HAVE_UNISTD_H
28 29 30 31
#include <unistd.h>
#endif

#include "giotypes.h"
David Zeuthen's avatar
David Zeuthen committed
32
#include "gsocket.h"
33 34 35 36
#include "gdbusprivate.h"
#include "gdbusmessage.h"
#include "gdbuserror.h"
#include "gdbusintrospection.h"
David Zeuthen's avatar
David Zeuthen committed
37 38 39
#include "gasyncresult.h"
#include "gsimpleasyncresult.h"
#include "ginputstream.h"
40
#include "gmemoryinputstream.h"
David Zeuthen's avatar
David Zeuthen committed
41 42
#include "giostream.h"
#include "gsocketcontrolmessage.h"
43
#include "gsocketconnection.h"
44
#include "gsocketoutputstream.h"
David Zeuthen's avatar
David Zeuthen committed
45 46 47 48

#ifdef G_OS_UNIX
#include "gunixfdmessage.h"
#include "gunixconnection.h"
Matthias Clasen's avatar
Matthias Clasen committed
49
#include "gunixcredentialsmessage.h"
David Zeuthen's avatar
David Zeuthen committed
50 51
#endif

52 53 54 55
#ifdef G_OS_WIN32
#include <windows.h>
#endif

David Zeuthen's avatar
David Zeuthen committed
56
#include "glibintl.h"
57

58 59
static gboolean _g_dbus_worker_do_initial_read (gpointer data);

60 61
/* ---------------------------------------------------------------------------------------------------- */

62 63
gchar *
_g_dbus_hexdump (const gchar *data, gsize len, guint indent)
64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124
{
 guint n, m;
 GString *ret;

 ret = g_string_new (NULL);

 for (n = 0; n < len; n += 16)
   {
     g_string_append_printf (ret, "%*s%04x: ", indent, "", n);

     for (m = n; m < n + 16; m++)
       {
         if (m > n && (m%4) == 0)
           g_string_append_c (ret, ' ');
         if (m < len)
           g_string_append_printf (ret, "%02x ", (guchar) data[m]);
         else
           g_string_append (ret, "   ");
       }

     g_string_append (ret, "   ");

     for (m = n; m < len && m < n + 16; m++)
       g_string_append_c (ret, g_ascii_isprint (data[m]) ? data[m] : '.');

     g_string_append_c (ret, '\n');
   }

 return g_string_free (ret, FALSE);
}

/* ---------------------------------------------------------------------------------------------------- */

/* Unfortunately ancillary messages are discarded when reading from a
 * socket using the GSocketInputStream abstraction. So we provide a
 * very GInputStream-ish API that uses GSocket in this case (very
 * similar to GSocketInputStream).
 */

typedef struct
{
  GSocket *socket;
  GCancellable *cancellable;

  void *buffer;
  gsize count;

  GSocketControlMessage ***messages;
  gint *num_messages;

  GSimpleAsyncResult *simple;

  gboolean from_mainloop;
} ReadWithControlData;

static void
read_with_control_data_free (ReadWithControlData *data)
{
  g_object_unref (data->socket);
  if (data->cancellable != NULL)
    g_object_unref (data->cancellable);
125
  g_object_unref (data->simple);
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
  g_free (data);
}

static gboolean
_g_socket_read_with_control_messages_ready (GSocket      *socket,
                                            GIOCondition  condition,
                                            gpointer      user_data)
{
  ReadWithControlData *data = user_data;
  GError *error;
  gssize result;
  GInputVector vector;

  error = NULL;
  vector.buffer = data->buffer;
  vector.size = data->count;
  result = g_socket_receive_message (data->socket,
                                     NULL, /* address */
                                     &vector,
                                     1,
                                     data->messages,
                                     data->num_messages,
                                     NULL,
                                     data->cancellable,
                                     &error);
  if (result >= 0)
    {
      g_simple_async_result_set_op_res_gssize (data->simple, result);
    }
  else
    {
      g_assert (error != NULL);
158
      g_simple_async_result_take_error (data->simple, error);
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 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233
    }

  if (data->from_mainloop)
    g_simple_async_result_complete (data->simple);
  else
    g_simple_async_result_complete_in_idle (data->simple);

  return FALSE;
}

static void
_g_socket_read_with_control_messages (GSocket                 *socket,
                                      void                    *buffer,
                                      gsize                    count,
                                      GSocketControlMessage ***messages,
                                      gint                    *num_messages,
                                      gint                     io_priority,
                                      GCancellable            *cancellable,
                                      GAsyncReadyCallback      callback,
                                      gpointer                 user_data)
{
  ReadWithControlData *data;

  data = g_new0 (ReadWithControlData, 1);
  data->socket = g_object_ref (socket);
  data->cancellable = cancellable != NULL ? g_object_ref (cancellable) : NULL;
  data->buffer = buffer;
  data->count = count;
  data->messages = messages;
  data->num_messages = num_messages;

  data->simple = g_simple_async_result_new (G_OBJECT (socket),
                                            callback,
                                            user_data,
                                            _g_socket_read_with_control_messages);

  if (!g_socket_condition_check (socket, G_IO_IN))
    {
      GSource *source;
      data->from_mainloop = TRUE;
      source = g_socket_create_source (data->socket,
                                       G_IO_IN | G_IO_HUP | G_IO_ERR,
                                       cancellable);
      g_source_set_callback (source,
                             (GSourceFunc) _g_socket_read_with_control_messages_ready,
                             data,
                             (GDestroyNotify) read_with_control_data_free);
      g_source_attach (source, g_main_context_get_thread_default ());
      g_source_unref (source);
    }
  else
    {
      _g_socket_read_with_control_messages_ready (data->socket, G_IO_IN, data);
      read_with_control_data_free (data);
    }
}

static gssize
_g_socket_read_with_control_messages_finish (GSocket       *socket,
                                             GAsyncResult  *result,
                                             GError       **error)
{
  GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (result);

  g_return_val_if_fail (G_IS_SOCKET (socket), -1);
  g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == _g_socket_read_with_control_messages);

  if (g_simple_async_result_propagate_error (simple, error))
      return -1;
  else
    return g_simple_async_result_get_op_res_gssize (simple);
}

/* ---------------------------------------------------------------------------------------------------- */

234 235 236 237 238 239 240 241 242 243 244
/* Work-around for https://bugzilla.gnome.org/show_bug.cgi?id=627724 */

static GPtrArray *ensured_classes = NULL;

static void
ensure_type (GType gtype)
{
  g_ptr_array_add (ensured_classes, g_type_class_ref (gtype));
}

static void
245
release_required_types (void)
246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261
{
  g_ptr_array_foreach (ensured_classes, (GFunc) g_type_class_unref, NULL);
  g_ptr_array_unref (ensured_classes);
  ensured_classes = NULL;
}

static void
ensure_required_types (void)
{
  g_assert (ensured_classes == NULL);
  ensured_classes = g_ptr_array_new ();
  ensure_type (G_TYPE_SIMPLE_ASYNC_RESULT);
  ensure_type (G_TYPE_MEMORY_INPUT_STREAM);
}
/* ---------------------------------------------------------------------------------------------------- */

262 263
typedef struct
{
264
  volatile gint refcount;
265 266 267 268 269 270
  GThread *thread;
  GMainContext *context;
  GMainLoop *loop;
} SharedThreadData;

static gpointer
271
gdbus_shared_thread_func (gpointer user_data)
272
{
273
  SharedThreadData *data = user_data;
274

275 276 277
  g_main_context_push_thread_default (data->context);
  g_main_loop_run (data->loop);
  g_main_context_pop_thread_default (data->context);
278

279
  release_required_types ();
280

281
  return NULL;
282 283
}

284 285
/* ---------------------------------------------------------------------------------------------------- */

286 287
static SharedThreadData *
_g_dbus_shared_thread_ref (void)
288
{
289 290
  static gsize shared_thread_data = 0;
  SharedThreadData *ret;
291

292
  if (g_once_init_enter (&shared_thread_data))
293
    {
294 295 296 297 298 299 300 301 302 303
      SharedThreadData *data;

      /* Work-around for https://bugzilla.gnome.org/show_bug.cgi?id=627724 */
      ensure_required_types ();

      data = g_new0 (SharedThreadData, 1);
      data->refcount = 0;
      
      data->context = g_main_context_new ();
      data->loop = g_main_loop_new (data->context, FALSE);
304 305
      data->thread = g_thread_new ("gdbus",
                                   gdbus_shared_thread_func,
306
                                   data);
307 308
      /* We can cast between gsize and gpointer safely */
      g_once_init_leave (&shared_thread_data, (gsize) data);
309 310
    }

311 312 313
  ret = (SharedThreadData*) shared_thread_data;
  g_atomic_int_inc (&ret->refcount);
  return ret;
314 315 316
}

static void
317
_g_dbus_shared_thread_unref (SharedThreadData *data)
318 319 320
{
  /* TODO: actually destroy the shared thread here */
#if 0
321 322
  g_assert (data != NULL);
  if (g_atomic_int_dec_and_test (&data->refcount))
323
    {
324 325 326 327
      g_main_loop_quit (data->loop);
      //g_thread_join (data->thread);
      g_main_loop_unref (data->loop);
      g_main_context_unref (data->context);
328 329 330 331 332 333
    }
#endif
}

/* ---------------------------------------------------------------------------------------------------- */

334 335 336 337 338 339 340
typedef enum {
    PENDING_NONE = 0,
    PENDING_WRITE,
    PENDING_FLUSH,
    PENDING_CLOSE
} OutputPending;

341 342 343
struct GDBusWorker
{
  volatile gint                       ref_count;
344

345 346
  SharedThreadData                   *shared_thread_data;

347 348
  /* really a boolean, but GLib 2.28 lacks atomic boolean ops */
  volatile gint                       stopped;
349 350 351 352 353 354

  /* TODO: frozen (e.g. G_DBUS_CONNECTION_FLAGS_DELAY_MESSAGE_PROCESSING) currently
   * only affects messages received from the other peer (since GDBusServer is the
   * only user) - we might want it to affect messages sent to the other peer too?
   */
  gboolean                            frozen;
355
  GDBusCapabilityFlags                capabilities;
356 357
  GQueue                             *received_messages_while_frozen;

358 359 360
  GIOStream                          *stream;
  GCancellable                       *cancellable;
  GDBusWorkerMessageReceivedCallback  message_received_callback;
361
  GDBusWorkerMessageAboutToBeSentCallback message_about_to_be_sent_callback;
362 363 364 365 366 367 368
  GDBusWorkerDisconnectedCallback     disconnected_callback;
  gpointer                            user_data;

  /* if not NULL, stream is GSocketConnection */
  GSocket *socket;

  /* used for reading */
369
  GMutex                              read_lock;
370 371 372 373 374 375 376 377
  gchar                              *read_buffer;
  gsize                               read_buffer_allocated_size;
  gsize                               read_buffer_cur_size;
  gsize                               read_buffer_bytes_wanted;
  GUnixFDList                        *read_fd_list;
  GSocketControlMessage             **read_ancillary_messages;
  gint                                read_num_ancillary_messages;

378
  /* Whether an async write, flush or close, or none of those, is pending.
379 380 381 382
   * Only the worker thread may change its value, and only with the write_lock.
   * Other threads may read its value when holding the write_lock.
   * The worker thread may read its value at any time.
   */
383
  OutputPending                       output_pending;
384
  /* used for writing */
385
  GMutex                              write_lock;
386
  /* queue of MessageToWriteData, protected by write_lock */
387
  GQueue                             *write_queue;
388
  /* protected by write_lock */
389
  guint64                             write_num_messages_written;
390 391 392 393
  /* number of messages we'd written out last time we flushed;
   * protected by write_lock
   */
  guint64                             write_num_messages_flushed;
394
  /* list of FlushData, protected by write_lock */
395
  GList                              *write_pending_flushes;
396
  /* list of CloseData, protected by write_lock */
397
  GList                              *pending_close_attempts;
398 399
  /* no lock - only used from the worker thread */
  gboolean                            close_expected;
400 401
};

402 403
static void _g_dbus_worker_unref (GDBusWorker *worker);

404 405
/* ---------------------------------------------------------------------------------------------------- */

406 407
typedef struct
{
408 409
  GMutex  mutex;
  GCond   cond;
410
  guint64 number_to_wait_for;
411
  GError *error;
412 413
} FlushData;

414 415 416 417 418
struct _MessageToWriteData ;
typedef struct _MessageToWriteData MessageToWriteData;

static void message_to_write_data_free (MessageToWriteData *data);

419 420 421 422 423 424
static void read_message_print_transport_debug (gssize bytes_read,
                                                GDBusWorker *worker);

static void write_message_print_transport_debug (gssize bytes_written,
                                                 MessageToWriteData *data);

425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442
typedef struct {
    GDBusWorker *worker;
    GCancellable *cancellable;
    GSimpleAsyncResult *result;
} CloseData;

static void close_data_free (CloseData *close_data)
{
  if (close_data->cancellable != NULL)
    g_object_unref (close_data->cancellable);

  if (close_data->result != NULL)
    g_object_unref (close_data->result);

  _g_dbus_worker_unref (close_data->worker);
  g_slice_free (CloseData, close_data);
}

443 444
/* ---------------------------------------------------------------------------------------------------- */

445 446 447 448 449 450 451 452 453 454 455 456
static GDBusWorker *
_g_dbus_worker_ref (GDBusWorker *worker)
{
  g_atomic_int_inc (&worker->ref_count);
  return worker;
}

static void
_g_dbus_worker_unref (GDBusWorker *worker)
{
  if (g_atomic_int_dec_and_test (&worker->ref_count))
    {
457 458
      g_assert (worker->write_pending_flushes == NULL);

459
      _g_dbus_shared_thread_unref (worker->shared_thread_data);
460 461 462

      g_object_unref (worker->stream);

463
      g_mutex_clear (&worker->read_lock);
464 465 466 467
      g_object_unref (worker->cancellable);
      if (worker->read_fd_list != NULL)
        g_object_unref (worker->read_fd_list);

468 469 470
      g_queue_foreach (worker->received_messages_while_frozen, (GFunc) g_object_unref, NULL);
      g_queue_free (worker->received_messages_while_frozen);

471
      g_mutex_clear (&worker->write_lock);
472
      g_queue_foreach (worker->write_queue, (GFunc) message_to_write_data_free, NULL);
473
      g_queue_free (worker->write_queue);
474

475 476
      g_free (worker->read_buffer);

477 478 479 480 481 482 483 484 485
      g_free (worker);
    }
}

static void
_g_dbus_worker_emit_disconnected (GDBusWorker  *worker,
                                  gboolean      remote_peer_vanished,
                                  GError       *error)
{
486
  if (!g_atomic_int_get (&worker->stopped))
487 488 489 490
    worker->disconnected_callback (worker, remote_peer_vanished, error, worker->user_data);
}

static void
491 492
_g_dbus_worker_emit_message_received (GDBusWorker  *worker,
                                      GDBusMessage *message)
493
{
494
  if (!g_atomic_int_get (&worker->stopped))
495 496 497
    worker->message_received_callback (worker, message, worker->user_data);
}

498
static GDBusMessage *
499 500 501
_g_dbus_worker_emit_message_about_to_be_sent (GDBusWorker  *worker,
                                              GDBusMessage *message)
{
502
  GDBusMessage *ret;
503
  if (!g_atomic_int_get (&worker->stopped))
504
    ret = worker->message_about_to_be_sent_callback (worker, message, worker->user_data);
505 506
  else
    ret = message;
507 508 509
  return ret;
}

510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534
/* can only be called from private thread with read-lock held - takes ownership of @message */
static void
_g_dbus_worker_queue_or_deliver_received_message (GDBusWorker  *worker,
                                                  GDBusMessage *message)
{
  if (worker->frozen || g_queue_get_length (worker->received_messages_while_frozen) > 0)
    {
      /* queue up */
      g_queue_push_tail (worker->received_messages_while_frozen, message);
    }
  else
    {
      /* not frozen, nor anything in queue */
      _g_dbus_worker_emit_message_received (worker, message);
      g_object_unref (message);
    }
}

/* called in private thread shared by all GDBusConnection instances (without read-lock held) */
static gboolean
unfreeze_in_idle_cb (gpointer user_data)
{
  GDBusWorker *worker = user_data;
  GDBusMessage *message;

535
  g_mutex_lock (&worker->read_lock);
536 537 538 539 540 541 542 543 544 545 546 547 548
  if (worker->frozen)
    {
      while ((message = g_queue_pop_head (worker->received_messages_while_frozen)) != NULL)
        {
          _g_dbus_worker_emit_message_received (worker, message);
          g_object_unref (message);
        }
      worker->frozen = FALSE;
    }
  else
    {
      g_assert (g_queue_get_length (worker->received_messages_while_frozen) == 0);
    }
549
  g_mutex_unlock (&worker->read_lock);
550 551 552 553 554 555 556 557 558 559 560 561 562 563
  return FALSE;
}

/* can be called from any thread */
void
_g_dbus_worker_unfreeze (GDBusWorker *worker)
{
  GSource *idle_source;
  idle_source = g_idle_source_new ();
  g_source_set_priority (idle_source, G_PRIORITY_DEFAULT);
  g_source_set_callback (idle_source,
                         unfreeze_in_idle_cb,
                         _g_dbus_worker_ref (worker),
                         (GDestroyNotify) _g_dbus_worker_unref);
564
  g_source_attach (idle_source, worker->shared_thread_data->context);
565 566 567 568 569
  g_source_unref (idle_source);
}

/* ---------------------------------------------------------------------------------------------------- */

570 571 572 573 574 575 576 577 578 579 580 581
static void _g_dbus_worker_do_read_unlocked (GDBusWorker *worker);

/* called in private thread shared by all GDBusConnection instances (without read-lock held) */
static void
_g_dbus_worker_do_read_cb (GInputStream  *input_stream,
                           GAsyncResult  *res,
                           gpointer       user_data)
{
  GDBusWorker *worker = user_data;
  GError *error;
  gssize bytes_read;

582
  g_mutex_lock (&worker->read_lock);
583 584

  /* If already stopped, don't even process the reply */
585
  if (g_atomic_int_get (&worker->stopped))
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
    goto out;

  error = NULL;
  if (worker->socket == NULL)
    bytes_read = g_input_stream_read_finish (g_io_stream_get_input_stream (worker->stream),
                                             res,
                                             &error);
  else
    bytes_read = _g_socket_read_with_control_messages_finish (worker->socket,
                                                              res,
                                                              &error);
  if (worker->read_num_ancillary_messages > 0)
    {
      gint n;
      for (n = 0; n < worker->read_num_ancillary_messages; n++)
        {
          GSocketControlMessage *control_message = G_SOCKET_CONTROL_MESSAGE (worker->read_ancillary_messages[n]);

          if (FALSE)
            {
            }
#ifdef G_OS_UNIX
          else if (G_IS_UNIX_FD_MESSAGE (control_message))
            {
              GUnixFDMessage *fd_message;
              gint *fds;
              gint num_fds;

              fd_message = G_UNIX_FD_MESSAGE (control_message);
              fds = g_unix_fd_message_steal_fds (fd_message, &num_fds);
              if (worker->read_fd_list == NULL)
                {
                  worker->read_fd_list = g_unix_fd_list_new_from_array (fds, num_fds);
                }
              else
                {
                  gint n;
                  for (n = 0; n < num_fds; n++)
                    {
                      /* TODO: really want a append_steal() */
                      g_unix_fd_list_append (worker->read_fd_list, fds[n], NULL);
                      close (fds[n]);
                    }
                }
              g_free (fds);
            }
          else if (G_IS_UNIX_CREDENTIALS_MESSAGE (control_message))
            {
              /* do nothing */
            }
#endif
          else
            {
              if (error == NULL)
                {
                  g_set_error (&error,
                               G_IO_ERROR,
                               G_IO_ERROR_FAILED,
                               "Unexpected ancillary message of type %s received from peer",
                               g_type_name (G_TYPE_FROM_INSTANCE (control_message)));
                  _g_dbus_worker_emit_disconnected (worker, TRUE, error);
                  g_error_free (error);
                  g_object_unref (control_message);
                  n++;
                  while (n < worker->read_num_ancillary_messages)
                    g_object_unref (worker->read_ancillary_messages[n++]);
                  g_free (worker->read_ancillary_messages);
                  goto out;
                }
            }
          g_object_unref (control_message);
        }
      g_free (worker->read_ancillary_messages);
    }

  if (bytes_read == -1)
    {
663 664 665 666 667 668 669 670 671 672 673 674 675
      if (G_UNLIKELY (_g_dbus_debug_transport ()))
        {
          _g_dbus_debug_print_lock ();
          g_print ("========================================================================\n"
                   "GDBus-debug:Transport:\n"
                   "  ---- READ ERROR on stream of type %s:\n"
                   "  ---- %s %d: %s\n",
                   g_type_name (G_TYPE_FROM_INSTANCE (g_io_stream_get_input_stream (worker->stream))),
                   g_quark_to_string (error->domain), error->code,
                   error->message);
          _g_dbus_debug_print_unlock ();
        }

676 677 678 679 680
      /* Every async read that uses this callback uses worker->cancellable
       * as its GCancellable. worker->cancellable gets cancelled if and only
       * if the GDBusConnection tells us to close (either via
       * _g_dbus_worker_stop, which is called on last-unref, or directly),
       * so a cancelled read must mean our connection was closed locally.
681 682 683 684 685 686 687 688 689
       *
       * If we're closing, other errors are possible - notably,
       * G_IO_ERROR_CLOSED can be seen if we close the stream with an async
       * read in-flight. It seems sensible to treat all read errors during
       * closing as an expected thing that doesn't trip exit-on-close.
       *
       * Because close_expected can't be set until we get into the worker
       * thread, but the cancellable is signalled sooner (from another
       * thread), we do still need to check the error.
690
       */
691 692
      if (worker->close_expected ||
          g_error_matches (error, G_IO_ERROR, G_IO_ERROR_CANCELLED))
693 694 695 696
        _g_dbus_worker_emit_disconnected (worker, FALSE, NULL);
      else
        _g_dbus_worker_emit_disconnected (worker, TRUE, error);

697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723
      g_error_free (error);
      goto out;
    }

#if 0
  g_debug ("read %d bytes (is_closed=%d blocking=%d condition=0x%02x) stream %p, %p",
           (gint) bytes_read,
           g_socket_is_closed (g_socket_connection_get_socket (G_SOCKET_CONNECTION (worker->stream))),
           g_socket_get_blocking (g_socket_connection_get_socket (G_SOCKET_CONNECTION (worker->stream))),
           g_socket_condition_check (g_socket_connection_get_socket (G_SOCKET_CONNECTION (worker->stream)),
                                     G_IO_IN | G_IO_OUT | G_IO_HUP),
           worker->stream,
           worker);
#endif

  /* TODO: hmm, hmm... */
  if (bytes_read == 0)
    {
      g_set_error (&error,
                   G_IO_ERROR,
                   G_IO_ERROR_FAILED,
                   "Underlying GIOStream returned 0 bytes on an async read");
      _g_dbus_worker_emit_disconnected (worker, TRUE, error);
      g_error_free (error);
      goto out;
    }

724 725
  read_message_print_transport_debug (bytes_read, worker);

726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757
  worker->read_buffer_cur_size += bytes_read;
  if (worker->read_buffer_bytes_wanted == worker->read_buffer_cur_size)
    {
      /* OK, got what we asked for! */
      if (worker->read_buffer_bytes_wanted == 16)
        {
          gssize message_len;
          /* OK, got the header - determine how many more bytes are needed */
          error = NULL;
          message_len = g_dbus_message_bytes_needed ((guchar *) worker->read_buffer,
                                                     16,
                                                     &error);
          if (message_len == -1)
            {
              g_warning ("_g_dbus_worker_do_read_cb: error determing bytes needed: %s", error->message);
              _g_dbus_worker_emit_disconnected (worker, FALSE, error);
              g_error_free (error);
              goto out;
            }

          worker->read_buffer_bytes_wanted = message_len;
          _g_dbus_worker_do_read_unlocked (worker);
        }
      else
        {
          GDBusMessage *message;
          error = NULL;

          /* TODO: use connection->priv->auth to decode the message */

          message = g_dbus_message_new_from_blob ((guchar *) worker->read_buffer,
                                                  worker->read_buffer_cur_size,
758
                                                  worker->capabilities,
759 760 761
                                                  &error);
          if (message == NULL)
            {
762
              gchar *s;
763
              s = _g_dbus_hexdump (worker->read_buffer, worker->read_buffer_cur_size, 2);
764 765 766 767 768 769 770 771
              g_warning ("Error decoding D-Bus message of %" G_GSIZE_FORMAT " bytes\n"
                         "The error is: %s\n"
                         "The payload is as follows:\n"
                         "%s\n",
                         worker->read_buffer_cur_size,
                         error->message,
                         s);
              g_free (s);
772 773 774 775 776
              _g_dbus_worker_emit_disconnected (worker, FALSE, error);
              g_error_free (error);
              goto out;
            }

777
#ifdef G_OS_UNIX
778 779 780
          if (worker->read_fd_list != NULL)
            {
              g_dbus_message_set_unix_fd_list (message, worker->read_fd_list);
781
              g_object_unref (worker->read_fd_list);
782 783
              worker->read_fd_list = NULL;
            }
784
#endif
785 786 787 788

          if (G_UNLIKELY (_g_dbus_debug_message ()))
            {
              gchar *s;
789
              _g_dbus_debug_print_lock ();
790 791 792 793 794 795 796
              g_print ("========================================================================\n"
                       "GDBus-debug:Message:\n"
                       "  <<<< RECEIVED D-Bus message (%" G_GSIZE_FORMAT " bytes)\n",
                       worker->read_buffer_cur_size);
              s = g_dbus_message_print (message, 2);
              g_print ("%s", s);
              g_free (s);
797 798 799 800 801 802 803
              if (G_UNLIKELY (_g_dbus_debug_payload ()))
                {
                  s = _g_dbus_hexdump (worker->read_buffer, worker->read_buffer_cur_size, 2);
                  g_print ("%s\n", s);
                  g_free (s);
                }
              _g_dbus_debug_print_unlock ();
804 805 806
            }

          /* yay, got a message, go deliver it */
807
          _g_dbus_worker_queue_or_deliver_received_message (worker, message);
808 809 810 811 812 813 814 815 816 817 818 819 820 821

          /* start reading another message! */
          worker->read_buffer_bytes_wanted = 0;
          worker->read_buffer_cur_size = 0;
          _g_dbus_worker_do_read_unlocked (worker);
        }
    }
  else
    {
      /* didn't get all the bytes we requested - so repeat the request... */
      _g_dbus_worker_do_read_unlocked (worker);
    }

 out:
822
  g_mutex_unlock (&worker->read_lock);
823 824 825 826 827 828 829 830 831

  /* gives up the reference acquired when calling g_input_stream_read_async() */
  _g_dbus_worker_unref (worker);
}

/* called in private thread shared by all GDBusConnection instances (with read-lock held) */
static void
_g_dbus_worker_do_read_unlocked (GDBusWorker *worker)
{
832 833 834 835
  /* Note that we do need to keep trying to read even if close_expected is
   * true, because only failing a read causes us to signal 'closed'.
   */

836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875
  /* if bytes_wanted is zero, it means start reading a message */
  if (worker->read_buffer_bytes_wanted == 0)
    {
      worker->read_buffer_cur_size = 0;
      worker->read_buffer_bytes_wanted = 16;
    }

  /* ensure we have a (big enough) buffer */
  if (worker->read_buffer == NULL || worker->read_buffer_bytes_wanted > worker->read_buffer_allocated_size)
    {
      /* TODO: 4096 is randomly chosen; might want a better chosen default minimum */
      worker->read_buffer_allocated_size = MAX (worker->read_buffer_bytes_wanted, 4096);
      worker->read_buffer = g_realloc (worker->read_buffer, worker->read_buffer_allocated_size);
    }

  if (worker->socket == NULL)
    g_input_stream_read_async (g_io_stream_get_input_stream (worker->stream),
                               worker->read_buffer + worker->read_buffer_cur_size,
                               worker->read_buffer_bytes_wanted - worker->read_buffer_cur_size,
                               G_PRIORITY_DEFAULT,
                               worker->cancellable,
                               (GAsyncReadyCallback) _g_dbus_worker_do_read_cb,
                               _g_dbus_worker_ref (worker));
  else
    {
      worker->read_ancillary_messages = NULL;
      worker->read_num_ancillary_messages = 0;
      _g_socket_read_with_control_messages (worker->socket,
                                            worker->read_buffer + worker->read_buffer_cur_size,
                                            worker->read_buffer_bytes_wanted - worker->read_buffer_cur_size,
                                            &worker->read_ancillary_messages,
                                            &worker->read_num_ancillary_messages,
                                            G_PRIORITY_DEFAULT,
                                            worker->cancellable,
                                            (GAsyncReadyCallback) _g_dbus_worker_do_read_cb,
                                            _g_dbus_worker_ref (worker));
    }
}

/* called in private thread shared by all GDBusConnection instances (without read-lock held) */
876 877
static gboolean
_g_dbus_worker_do_initial_read (gpointer data)
878
{
879
  GDBusWorker *worker = data;
880
  g_mutex_lock (&worker->read_lock);
881
  _g_dbus_worker_do_read_unlocked (worker);
882
  g_mutex_unlock (&worker->read_lock);
883
  return FALSE;
884 885 886 887 888 889
}

/* ---------------------------------------------------------------------------------------------------- */

struct _MessageToWriteData
{
890
  GDBusWorker  *worker;
891 892 893
  GDBusMessage *message;
  gchar        *blob;
  gsize         blob_size;
894 895 896 897

  gsize               total_written;
  GSimpleAsyncResult *simple;

898 899 900 901 902
};

static void
message_to_write_data_free (MessageToWriteData *data)
{
903
  _g_dbus_worker_unref (data->worker);
904 905
  if (data->message)
    g_object_unref (data->message);
906 907 908 909 910 911
  g_free (data->blob);
  g_free (data);
}

/* ---------------------------------------------------------------------------------------------------- */

912 913
static void write_message_continue_writing (MessageToWriteData *data);

914 915 916
/* called in private thread shared by all GDBusConnection instances
 *
 * write-lock is not held on entry
917
 * output_pending is PENDING_WRITE on entry
918
 */
919 920 921 922
static void
write_message_async_cb (GObject      *source_object,
                        GAsyncResult *res,
                        gpointer      user_data)
923
{
924 925 926 927
  MessageToWriteData *data = user_data;
  GSimpleAsyncResult *simple;
  gssize bytes_written;
  GError *error;
928

929 930 931 932
  /* Note: we can't access data->simple after calling g_async_result_complete () because the
   * callback can free @data and we're not completing in idle. So use a copy of the pointer.
   */
  simple = data->simple;
933

934 935 936 937 938 939
  error = NULL;
  bytes_written = g_output_stream_write_finish (G_OUTPUT_STREAM (source_object),
                                                res,
                                                &error);
  if (bytes_written == -1)
    {
940
      g_simple_async_result_take_error (simple, error);
941 942 943 944 945 946 947
      g_simple_async_result_complete (simple);
      g_object_unref (simple);
      goto out;
    }
  g_assert (bytes_written > 0); /* zero is never returned */

  write_message_print_transport_debug (bytes_written, data);
948

949 950 951 952 953 954 955 956 957 958 959 960 961 962 963
  data->total_written += bytes_written;
  g_assert (data->total_written <= data->blob_size);
  if (data->total_written == data->blob_size)
    {
      g_simple_async_result_complete (simple);
      g_object_unref (simple);
      goto out;
    }

  write_message_continue_writing (data);

 out:
  ;
}

964 965 966
/* called in private thread shared by all GDBusConnection instances
 *
 * write-lock is not held on entry
967
 * output_pending is PENDING_WRITE on entry
968
 */
969 970 971 972 973 974 975 976 977 978
static gboolean
on_socket_ready (GSocket      *socket,
                 GIOCondition  condition,
                 gpointer      user_data)
{
  MessageToWriteData *data = user_data;
  write_message_continue_writing (data);
  return FALSE; /* remove source */
}

979 980 981
/* called in private thread shared by all GDBusConnection instances
 *
 * write-lock is not held on entry
982
 * output_pending is PENDING_WRITE on entry
983
 */
984 985 986 987 988 989 990 991 992 993 994
static void
write_message_continue_writing (MessageToWriteData *data)
{
  GOutputStream *ostream;
  GSimpleAsyncResult *simple;
#ifdef G_OS_UNIX
  GUnixFDList *fd_list;
#endif

  /* Note: we can't access data->simple after calling g_async_result_complete () because the
   * callback can free @data and we're not completing in idle. So use a copy of the pointer.
995
   */
996 997 998 999 1000 1001 1002 1003 1004 1005
  simple = data->simple;

  ostream = g_io_stream_get_output_stream (data->worker->stream);
#ifdef G_OS_UNIX
  fd_list = g_dbus_message_get_unix_fd_list (data->message);
#endif

  g_assert (!g_output_stream_has_pending (ostream));
  g_assert_cmpint (data->total_written, <, data->blob_size);

1006 1007 1008
  if (FALSE)
    {
    }
1009
#ifdef G_OS_UNIX
1010
  else if (G_IS_SOCKET_OUTPUT_STREAM (ostream) && data->total_written == 0)
1011 1012
    {
      GOutputVector vector;
1013
      GSocketControlMessage *control_message;
1014
      gssize bytes_written;
1015
      GError *error;
1016

1017 1018
      vector.buffer = data->blob;
      vector.size = data->blob_size;
1019

1020 1021
      control_message = NULL;
      if (fd_list != NULL && g_unix_fd_list_get_length (fd_list) > 0)
1022
        {
1023
          if (!(data->worker->capabilities & G_DBUS_CAPABILITY_FLAGS_UNIX_FD_PASSING))
1024
            {
1025 1026 1027 1028 1029 1030
              g_simple_async_result_set_error (simple,
                                               G_IO_ERROR,
                                               G_IO_ERROR_FAILED,
                                               "Tried sending a file descriptor but remote peer does not support this capability");
              g_simple_async_result_complete (simple);
              g_object_unref (simple);
1031 1032
              goto out;
            }
1033
          control_message = g_unix_fd_message_new_with_fd_list (fd_list);
1034 1035
        }

1036 1037
      error = NULL;
      bytes_written = g_socket_send_message (data->worker->socket,
1038 1039 1040
                                             NULL, /* address */
                                             &vector,
                                             1,
1041 1042
                                             control_message != NULL ? &control_message : NULL,
                                             control_message != NULL ? 1 : 0,
1043
                                             G_SOCKET_MSG_NONE,
1044 1045 1046 1047 1048
                                             data->worker->cancellable,
                                             &error);
      if (control_message != NULL)
        g_object_unref (control_message);

1049 1050
      if (bytes_written == -1)
        {
1051
          /* Handle WOULD_BLOCK by waiting until there's room in the buffer */
Christian Persch's avatar
Christian Persch committed
1052
          if (g_error_matches (error, G_IO_ERROR, G_IO_ERROR_WOULD_BLOCK))
1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063
            {
              GSource *source;
              source = g_socket_create_source (data->worker->socket,
                                               G_IO_OUT | G_IO_HUP | G_IO_ERR,
                                               data->worker->cancellable);
              g_source_set_callback (source,
                                     (GSourceFunc) on_socket_ready,
                                     data,
                                     NULL); /* GDestroyNotify */
              g_source_attach (source, g_main_context_get_thread_default ());
              g_source_unref (source);
Christian Persch's avatar
Christian Persch committed
1064
              g_error_free (error);
1065 1066
              goto out;
            }
1067
          g_simple_async_result_take_error (simple, error);
1068 1069
          g_simple_async_result_complete (simple);
          g_object_unref (simple);
1070 1071
          goto out;
        }
1072
      g_assert (bytes_written > 0); /* zero is never returned */
1073

1074 1075 1076 1077 1078
      write_message_print_transport_debug (bytes_written, data);

      data->total_written += bytes_written;
      g_assert (data->total_written <= data->blob_size);
      if (data->total_written == data->blob_size)
1079
        {
1080 1081 1082
          g_simple_async_result_complete (simple);
          g_object_unref (simple);
          goto out;
1083
        }
1084 1085

      write_message_continue_writing (data);
1086
    }
1087
#endif
1088 1089
  else
    {
Matthias Clasen's avatar
Matthias Clasen committed
1090
#ifdef G_OS_UNIX
1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101
      if (fd_list != NULL)
        {
          g_simple_async_result_set_error (simple,
                                           G_IO_ERROR,
                                           G_IO_ERROR_FAILED,
                                           "Tried sending a file descriptor on unsupported stream of type %s",
                                           g_type_name (G_TYPE_FROM_INSTANCE (ostream)));
          g_simple_async_result_complete (simple);
          g_object_unref (simple);
          goto out;
        }
Matthias Clasen's avatar
Matthias Clasen committed
1102
#endif
1103 1104 1105 1106 1107 1108 1109 1110

      g_output_stream_write_async (ostream,
                                   (const gchar *) data->blob + data->total_written,
                                   data->blob_size - data->total_written,
                                   G_PRIORITY_DEFAULT,
                                   data->worker->cancellable,
                                   write_message_async_cb,
                                   data);
1111
    }
1112 1113 1114
 out:
  ;
}
1115

1116 1117 1118
/* called in private thread shared by all GDBusConnection instances
 *
 * write-lock is not held on entry
1119
 * output_pending is PENDING_WRITE on entry
1120
 */
1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133
static void
write_message_async (GDBusWorker         *worker,
                     MessageToWriteData  *data,
                     GAsyncReadyCallback  callback,
                     gpointer             user_data)
{
  data->simple = g_simple_async_result_new (NULL,
                                            callback,
                                            user_data,
                                            write_message_async);
  data->total_written = 0;
  write_message_continue_writing (data);
}
1134

1135
/* called in private thread shared by all GDBusConnection instances (with write-lock held) */
1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146
static gboolean
write_message_finish (GAsyncResult   *res,
                      GError        **error)
{
  g_warn_if_fail (g_simple_async_result_get_source_tag (G_SIMPLE_ASYNC_RESULT (res)) == write_message_async);
  if (g_simple_async_result_propagate_error (G_SIMPLE_ASYNC_RESULT (res), error))
    return FALSE;
  else
    return TRUE;
}
/* ---------------------------------------------------------------------------------------------------- */
1147

1148
static void continue_writing (GDBusWorker *worker);
1149

1150 1151 1152 1153 1154 1155
typedef struct
{
  GDBusWorker *worker;
  GList *flushers;
} FlushAsyncData;

1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167
static void
flush_data_list_complete (const GList  *flushers,
                          const GError *error)
{
  const GList *l;

  for (l = flushers; l != NULL; l = l->next)
    {
      FlushData *f = l->data;

      f->error = error != NULL ? g_error_copy (error) : NULL;

1168 1169 1170
      g_mutex_lock (&f->mutex);
      g_cond_signal (&f->cond);
      g_mutex_unlock (&f->mutex);
1171 1172 1173
    }
}

1174 1175 1176
/* called in private thread shared by all GDBusConnection instances
 *
 * write-lock is not held on entry
1177
 * output_pending is PENDING_FLUSH on entry
1178
 */
1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194
static void
ostream_flush_cb (GObject      *source_object,
                  GAsyncResult *res,
                  gpointer      user_data)
{
  FlushAsyncData *data = user_data;
  GError *error;

  error = NULL;
  g_output_stream_flush_finish (G_OUTPUT_STREAM (source_object),
                                res,
                                &error);

  if (error == NULL)
    {
      if (G_UNLIKELY (_g_dbus_debug_transport ()))
1195
        {
1196 1197 1198 1199 1200 1201
          _g_dbus_debug_print_lock ();
          g_print ("========================================================================\n"
                   "GDBus-debug:Transport:\n"
                   "  ---- FLUSHED stream of type %s\n",
                   g_type_name (G_TYPE_FROM_INSTANCE (g_io_stream_get_output_stream (data->worker->stream))));
          _g_dbus_debug_print_unlock ();
1202 1203 1204
        }
    }

1205
  g_assert (data->flushers != NULL);
1206
  flush_data_list_complete (data->flushers, error);
1207 1208 1209 1210 1211
  g_list_free (data->flushers);

  if (error != NULL)
    g_error_free (error);

1212 1213
  /* Make sure we tell folks that we don't have additional
     flushes pending */
1214
  g_mutex_lock (&data->worker->write_lock);
1215
  data->worker->write_num_messages_flushed = data->worker->write_num_messages_written;
1216 1217
  g_assert (data->worker->output_pending == PENDING_FLUSH);
  data->worker->output_pending = PENDING_NONE;
1218
  g_mutex_unlock (&data->worker->write_lock);
1219

1220
  /* OK, cool, finally kick off the next write */
1221
  continue_writing (data->worker);
1222 1223 1224 1225 1226

  _g_dbus_worker_unref (data->worker);
  g_free (data);
}

1227 1228 1229
/* called in private thread shared by all GDBusConnection instances
 *
 * write-lock is not held on entry
1230
 * output_pending is PENDING_FLUSH on entry
1231
 */
1232
static void
1233
start_flush (FlushAsyncData *data)
1234
{
1235 1236 1237 1238 1239 1240
  g_output_stream_flush_async (g_io_stream_get_output_stream (data->worker->stream),
                               G_PRIORITY_DEFAULT,
                               data->worker->cancellable,
                               ostream_flush_cb,
                               data);
}
1241

1242 1243 1244 1245 1246 1247 1248 1249 1250
/* called in private thread shared by all GDBusConnection instances
 *
 * write-lock is held on entry
 * output_pending is PENDING_NONE on entry
 */
static void
message_written_unlocked (GDBusWorker *worker,
                          MessageToWriteData *message_data)
{
1251 1252 1253
  if (G_UNLIKELY (_g_dbus_debug_message ()))
    {
      gchar *s;
1254
      _g_dbus_debug_print_lock ();
1255 1256 1257
      g_print ("========================================================================\n"
               "GDBus-debug:Message:\n"
               "  >>>> SENT D-Bus message (%" G_GSIZE_FORMAT " bytes)\n",
1258 1259
               message_data->blob_size);
      s = g_dbus_message_print (message_data->message, 2);
1260 1261
      g_print ("%s", s);
      g_free (s);
1262 1263
      if (G_UNLIKELY (_g_dbus_debug_payload ()))
        {
1264
          s = _g_dbus_hexdump (message_data->blob, message_data->blob_size, 2);
1265 1266 1267 1268
          g_print ("%s\n", s);
          g_free (s);
        }
      _g_dbus_debug_print_unlock ();
1269 1270
    }

1271
  worker->write_num_messages_written += 1;
1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288
}

/* called in private thread shared by all GDBusConnection instances
 *
 * write-lock is held on entry
 * output_pending is PENDING_NONE on entry
 *
 * Returns: non-%NULL, setting @output_pending, if we need to flush now
 */
static FlushAsyncData *
prepare_flush_unlocked (GDBusWorker *worker)
{
  GList *l;
  GList *ll;
  GList *flushers;

  flushers = NULL;
1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299
  for (l = worker->write_pending_flushes; l != NULL; l = ll)
    {
      FlushData *f = l->data;
      ll = l->next;

      if (f->number_to_wait_for == worker->write_num_messages_written)
        {
          flushers = g_list_append (flushers, f);
          worker->write_pending_flushes = g_list_delete_link (worker->write_pending_flushes, l);
        }
    }
1300 1301
  if (flushers != NULL)
    {
1302 1303
      g_assert (worker->output_pending == PENDING_NONE);
      worker->output_pending = PENDING_FLUSH;
1304
    }
1305 1306 1307 1308

  if (flushers != NULL)
    {
      FlushAsyncData *data;
1309

1310 1311 1312
      data = g_new0 (FlushAsyncData, 1);
      data->worker = _g_dbus_worker_ref (worker);
      data->flushers = flushers;
1313
      return data;
1314
    }
1315 1316

  return NULL;
1317 1318
}

1319 1320 1321
/* called in private thread shared by all GDBusConnection instances
 *
 * write-lock is not held on entry
1322
 * output_pending is PENDING_WRITE on entry
1323
 */
1324 1325 1326 1327 1328 1329 1330 1331
static void
write_message_cb (GObject       *source_object,
                  GAsyncResult  *res,
                  gpointer       user_data)
{
  MessageToWriteData *data = user_data;
  GError *error;

1332
  g_mutex_lock (&data->worker->write_lock);
1333 1334
  g_assert (data->worker->output_pending == PENDING_WRITE);
  data->worker->output_pending = PENDING_NONE;
1335 1336 1337 1338

  error = NULL;
  if (!write_message_finish (res, &error))
    {
1339 1340
      g_mutex_unlock (&data->worker->write_lock);

1341 1342 1343
      /* TODO: handle */
      _g_dbus_worker_emit_disconnected (data->worker, TRUE, error);
      g_error_free (error);
1344 1345

      g_mutex_lock (&data->worker->write_lock);
1346 1347
    }

1348 1349 1350 1351 1352
  message_written_unlocked (data->worker, data);

  g_mutex_unlock (&data->worker->write_lock);

  continue_writing (data->worker);
1353 1354 1355

  message_to_write_data_free (data);
}
1356

1357 1358 1359
/* called in private thread shared by all GDBusConnection instances
 *
 * write-lock is not held on entry
1360
 * output_pending is PENDING_CLOSE on entry
1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373
 */
static void
iostream_close_cb (GObject      *source_object,
                   GAsyncResult *res,
                   gpointer      user_data)
{
  GDBusWorker *worker = user_data;
  GError *error = NULL;
  GList *pending_close_attempts, *pending_flush_attempts;
  GQueue *send_queue;

  g_io_stream_close_finish (worker->stream, res, &error);

1374
  g_mutex_lock (&worker->write_lock);
1375 1376 1377 1378 1379 1380 1381 1382 1383 1384

  pending_close_attempts = worker->pending_close_attempts;
  worker->pending_close_attempts = NULL;

  pending_flush_attempts = worker->write_pending_flushes;
  worker->write_pending_flushes = NULL;

  send_queue = worker->write_queue;
  worker->write_queue = g_queue_new ();

1385 1386
  g_assert (worker->output_pending == PENDING_CLOSE);
  worker->output_pending = PENDING_NONE;
1387

1388
  g_mutex_unlock (&worker->write_lock);
1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426

  while (pending_close_attempts != NULL)
    {
      CloseData *close_data = pending_close_attempts->data;

      pending_close_attempts = g_list_delete_link (pending_close_attempts,
                                                   pending_close_attempts);

      if (close_data->result != NULL)
        {
          if (error != NULL)
            g_simple_async_result_set_from_error (close_data->result, error);

          /* this must be in an idle because the result is likely to be
           * intended for another thread
           */
          g_simple_async_result_complete_in_idle (close_data->result);
        }

      close_data_free (close_data);
    }

  g_clear_error (&error);

  /* all messages queued for sending are discarded */
  g_queue_foreach (send_queue, (GFunc) message_to_write_data_free, NULL);
  g_queue_free (send_queue);

  /* all queued flushes fail */
  error = g_error_new (G_IO_ERROR, G_IO_ERROR_CANCELLED,
                       _("Operation was cancelled"));
  flush_data_list_complete (pending_flush_attempts, error);
  g_list_free (pending_flush_attempts);
  g_clear_error (&error);

  _g_dbus_worker_unref (worker);
}

1427 1428 1429
/* called in private thread shared by all GDBusConnection instances
 *
 * write-lock is not held on entry
1430
 * output_pending must be PENDING_NONE on entry
1431
 */
1432
static void
1433
continue_writing (GDBusWorker *worker)
1434 1435
{
  MessageToWriteData *data;
1436
  FlushAsyncData *flush_async_data;
1437 1438

 write_next:
1439
  /* we mustn't try to write two things at once */
1440
  g_assert (worker->output_pending == PENDING_NONE);
1441

1442
  g_mutex_lock (&worker->write_lock);
1443

1444 1445 1446
  data = NULL;
  flush_async_data = NULL;

1447 1448 1449
  /* if we want to close the connection, that takes precedence */
  if (worker->pending_close_attempts != NULL)
    {
1450
      worker->close_expected = TRUE;
1451
      worker->output_pending = PENDING_CLOSE;
1452 1453 1454 1455 1456 1457 1458

      g_io_stream_close_async (worker->stream, G_PRIORITY_DEFAULT,
                               NULL, iostream_close_cb,
                               _g_dbus_worker_ref (worker));
    }
  else
    {
1459
      flush_async_data = prepare_flush_unlocked (worker);
1460

1461 1462 1463 1464 1465 1466 1467
      if (flush_async_data == NULL)
        {
          data = g_queue_pop_head (worker->write_queue);

          if (data != NULL)
            worker->output_pending = PENDING_WRITE;
        }
1468 1469
    }

1470
  g_mutex_unlock (&worker->write_lock);
1471

1472
  /* Note that write_lock is only used for protecting the @write_queue
1473
   * and @output_pending fields of the GDBusWorker struct ... which we
1474 1475 1476 1477 1478 1479
   * need to modify from arbitrary threads in _g_dbus_worker_send_message().
   *
   * Therefore, it's fine to drop it here when calling back into user
   * code and then writing the message out onto the GIOStream since this
   * function only runs on the worker thread.
   */
1480 1481 1482 1483 1484 1485 1486

  if (flush_async_data != NULL)
    {
      start_flush (flush_async_data);
      g_assert (data == NULL);
    }
  else if (data != NULL)
1487
    {
1488
      GDBusMessage *old_message;
1489 1490 1491 1492
      guchar *new_blob;
      gsize new_blob_size;
      GError *error;

1493 1494 1495
      old_message = data->message;
      data->message = _g_dbus_worker_emit_message_about_to_be_sent (worker, data->message);
      if (data->message == old_message)
1496
        {
1497 1498 1499 1500 1501
          /* filters had no effect - do nothing */
        }
      else if (data->message == NULL)
        {
          /* filters dropped message */
1502
          g_mutex_lock (&worker->write_lock);
1503
          worker->output_pending = PENDING_NONE;
1504
          g_mutex_unlock (&worker->write_lock);
1505 1506
          message_to_write_data_free (data);
          goto write_next;
1507 1508 1509 1510
        }
      else
        {
          /* filters altered the message -> reencode */
1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531
          error = NULL;
          new_blob = g_dbus_message_to_blob (data->message,
                                             &new_blob_size,
                                             worker->capabilities,
                                             &error);
          if (new_blob == NULL)
            {
              /* if filter make the GDBusMessage unencodeable, just complain on stderr and send
               * the old message instead
               */
              g_warning ("Error encoding GDBusMessage with serial %d altered by filter function: %s",
                         g_dbus_message_get_serial (data->message),
                         error->message);
              g_error_free (error);
            }
          else
            {
              g_free (data->blob);
              data->blob = (gchar *) new_blob;
              data->blob_size = new_blob_size;
            }
1532
        }
1533 1534 1535 1536 1537

      write_message_async (worker,
                           data,
                           write_message_cb,
                           data);
1538
    }
1539
}
1540

1541 1542 1543
/* called in private thread shared by all GDBusConnection instances
 *
 * write-lock is not held on entry
1544
 * output_pending may be anything
1545
 */
1546
static gboolean
1547
continue_writing_in_idle_cb (gpointer user_data)
1548 1549
{
  GDBusWorker *worker = user_data;
1550 1551 1552 1553

  /* Because this is the worker thread, we can read this struct member
   * without holding the lock: no other thread ever modifies it.
   */
1554
  if (worker->output_pending == PENDING_NONE)
1555
    continue_writing (worker);
1556

1557
  return FALSE;
1558 1559
}

1560 1561
/*
 * @write_data: (transfer full) (allow-none):
1562
 * @flush_data: (transfer full) (allow-none):
1563 1564 1565 1566
 * @close_data: (transfer full) (allow-none):
 *
 * Can be called from any thread
 *
1567
 * write_lock is held on entry
1568
 * output_pending may be anything
1569 1570
 */
static void
1571 1572
schedule_writing_unlocked (GDBusWorker        *worker,
                           MessageToWriteData *write_data,
1573
                           FlushData          *flush_data,
1574
                           CloseData          *close_data)
1575 1576 1577 1578
{
  if (write_data != NULL)
    g_queue_push_tail (worker->write_queue, write_data);

1579 1580 1581
  if (flush_data != NULL)
    worker->write_pending_flushes = g_list_prepend (worker->write_pending_flushes, flush_data);

1582 1583 1584 1585
  if (close_data != NULL)
    worker->pending_close_attempts = g_list_prepend (worker->pending_close_attempts,
                                                     close_data);

1586 1587 1588 1589 1590 1591 1592
  /* If we had output pending, the next bit of output will happen
   * automatically when it finishes, so we only need to do this
   * if nothing was pending.
   *
   * The idle callback will re-check that output_pending is still
   * PENDING_NONE, to guard against output starting before the idle.
   */
1593
  if (worker->output_pending == PENDING_NONE)
1594 1595 1596 1597 1598
    {
      GSource *idle_source;
      idle_source = g_idle_source_new ();
      g_source_set_priority (idle_source, G_PRIORITY_DEFAULT);
      g_source_set_callback (idle_source,
1599
                             continue_writing_in_idle_cb,
1600 1601 1602 1603 1604 1605 1606
                             _g_dbus_worker_ref (worker),
                             (GDestroyNotify) _g_dbus_worker_unref);
      g_source_attach (idle_source, worker->shared_thread_data->context);
      g_source_unref (idle_source);
    }
}

1607 1608
/* ---------------------------------------------------------------------------------------------------- */

1609 1610 1611
/* can be called from any thread - steals blob
 *
 * write_lock is not held on entry
1612
 * output_pending may be anything
1613
 */
1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626
void
_g_dbus_worker_send_message (GDBusWorker    *worker,
                             GDBusMessage   *message,
                             gchar          *blob,
                             gsize           blob_len)
{
  MessageToWriteData *data;

  g_return_if_fail (G_IS_DBUS_MESSAGE (message));
  g_return_if_fail (blob != NULL);
  g_return_if_fail (blob_len > 16);

  data = g_new0 (MessageToWriteData, 1);
1627
  data->worker = _g_dbus_worker_ref (worker);
1628 1629 1630 1631
  data->message = g_object_ref (message);
  data->blob = blob; /* steal! */
  data->blob_size = blob_len;

1632
  g_mutex_lock (&worker->write_lock);
1633
  schedule_writing_unlocked (worker, data, NULL, NULL);
1634
  g_mutex_unlock (&worker->write_lock);
1635 1636 1637 1638 1639
}

/* ---------------------------------------------------------------------------------------------------- */

GDBusWorker *
1640 1641
_g_dbus_worker_new (GIOStream                              *stream,
                    GDBusCapabilityFlags                    capabilities,
1642
                    gboolean                                initially_frozen,
1643 1644 1645 1646
                    GDBusWorkerMessageReceivedCallback      message_received_callback,
                    GDBusWorkerMessageAboutToBeSentCallback message_about_to_be_sent_callback,
                    GDBusWorkerDisconnectedCallback         disconnected_callback,
                    gpointer                                user_data)
1647 1648
{
  GDBusWorker *worker;
1649
  GSource *idle_source;
1650 1651 1652

  g_return_val_if_fail (G_IS_IO_STREAM (stream), NULL);
  g_return_val_if_fail (message_received_callback != NULL, NULL);
1653
  g_return_val_if_fail (message_about_to_be_sent_callback != NULL, NULL);
1654 1655 1656 1657 1658
  g_return_val_if_fail (disconnected_callback != NULL, NULL);

  worker = g_new0 (GDBusWorker, 1);
  worker->ref_count = 1;

1659
  g_mutex_init (&worker->read_lock);
1660
  worker->message_received_callback = message_received_callback;
1661
  worker->message_about_to_be_sent_callback = message_about_to_be_sent_callback;
1662 1663 1664 1665 1666
  worker->disconnected_callback = disconnected_callback;
  worker->user_data = user_data;
  worker->stream = g_object_ref (stream);
  worker->capabilities = capabilities;
  worker->cancellable = g_cancellable_new ();
1667
  worker->output_pending = PENDING_NONE;
David Zeuthen's avatar