gdbusprivate.c 68 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
 *
 * 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
16
 * Public License along with this library; if not, see <http://www.gnu.org/licenses/>.
17 18 19 20 21 22 23 24 25 26
 *
 * Author: David Zeuthen <davidz@redhat.com>
 */

#include "config.h"

#include <stdlib.h>
#include <string.h>

#include "giotypes.h"
David Zeuthen's avatar
David Zeuthen committed
27
#include "gsocket.h"
28 29 30 31
#include "gdbusprivate.h"
#include "gdbusmessage.h"
#include "gdbuserror.h"
#include "gdbusintrospection.h"
32
#include "gtask.h"
David Zeuthen's avatar
David Zeuthen committed
33
#include "ginputstream.h"
34
#include "gmemoryinputstream.h"
David Zeuthen's avatar
David Zeuthen committed
35
#include "giostream.h"
Colin Walters's avatar
Colin Walters committed
36
#include "glib/gstdio.h"
David Zeuthen's avatar
David Zeuthen committed
37
#include "gsocketcontrolmessage.h"
38
#include "gsocketconnection.h"
39
#include "gsocketoutputstream.h"
David Zeuthen's avatar
David Zeuthen committed
40 41 42 43

#ifdef G_OS_UNIX
#include "gunixfdmessage.h"
#include "gunixconnection.h"
Matthias Clasen's avatar
Matthias Clasen committed
44
#include "gunixcredentialsmessage.h"
David Zeuthen's avatar
David Zeuthen committed
45 46
#endif

47 48 49 50
#ifdef G_OS_WIN32
#include <windows.h>
#endif

David Zeuthen's avatar
David Zeuthen committed
51
#include "glibintl.h"
52

53
static gboolean _g_dbus_worker_do_initial_read (gpointer data);
54
static void schedule_pending_close (GDBusWorker *worker);
55

56 57
/* ---------------------------------------------------------------------------------------------------- */

58 59
gchar *
_g_dbus_hexdump (const gchar *data, gsize len, guint indent)
60 61 62 63 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
{
 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
{
  void *buffer;
  gsize count;

  GSocketControlMessage ***messages;
  gint *num_messages;
} ReadWithControlData;

static void
read_with_control_data_free (ReadWithControlData *data)
{
111
  g_slice_free (ReadWithControlData, data);
112 113 114 115 116 117 118
}

static gboolean
_g_socket_read_with_control_messages_ready (GSocket      *socket,
                                            GIOCondition  condition,
                                            gpointer      user_data)
{
119 120
  GTask *task = user_data;
  ReadWithControlData *data = g_task_get_task_data (task);
121 122 123 124 125 126 127
  GError *error;
  gssize result;
  GInputVector vector;

  error = NULL;
  vector.buffer = data->buffer;
  vector.size = data->count;
128
  result = g_socket_receive_message (socket,
129 130 131 132 133 134
                                     NULL, /* address */
                                     &vector,
                                     1,
                                     data->messages,
                                     data->num_messages,
                                     NULL,
135
                                     g_task_get_cancellable (task),
136
                                     &error);
137 138

  if (g_error_matches (error, G_IO_ERROR, G_IO_ERROR_WOULD_BLOCK))
139
    {
140 141
      g_error_free (error);
      return TRUE;
142 143
    }

144 145 146
  g_assert (result >= 0 || error != NULL);
  if (result >= 0)
    g_task_return_int (task, result);
147
  else
148 149
    g_task_return_error (task, error);
  g_object_unref (task);
150 151 152 153 154 155 156 157 158 159 160 161 162 163 164

  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)
{
165
  GTask *task;
166
  ReadWithControlData *data;
167
  GSource *source;
168

169
  data = g_slice_new0 (ReadWithControlData);
170 171 172 173 174
  data->buffer = buffer;
  data->count = count;
  data->messages = messages;
  data->num_messages = num_messages;

175
  task = g_task_new (socket, cancellable, callback, user_data);
176
  g_task_set_source_tag (task, _g_socket_read_with_control_messages);
177
  g_task_set_task_data (task, data, (GDestroyNotify) read_with_control_data_free);
178

179
  if (g_socket_condition_check (socket, G_IO_IN))
180
    {
181 182
      if (!_g_socket_read_with_control_messages_ready (socket, G_IO_IN, task))
        return;
183
    }
184 185 186 187 188 189

  source = g_socket_create_source (socket,
                                   G_IO_IN | G_IO_HUP | G_IO_ERR,
                                   cancellable);
  g_task_attach_source (task, source, (GSourceFunc) _g_socket_read_with_control_messages_ready);
  g_source_unref (source);
190 191 192 193 194 195 196 197
}

static gssize
_g_socket_read_with_control_messages_finish (GSocket       *socket,
                                             GAsyncResult  *result,
                                             GError       **error)
{
  g_return_val_if_fail (G_IS_SOCKET (socket), -1);
198
  g_return_val_if_fail (g_task_is_valid (result, socket), -1);
199

200
  return g_task_propagate_int (G_TASK (result), error);
201 202 203 204
}

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

205 206 207 208 209 210 211 212 213 214 215
/* 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
216
release_required_types (void)
217 218 219 220 221 222 223 224 225 226 227
{
  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 ();
228
  ensure_type (G_TYPE_TASK);
229 230 231 232
  ensure_type (G_TYPE_MEMORY_INPUT_STREAM);
}
/* ---------------------------------------------------------------------------------------------------- */

233 234
typedef struct
{
235
  volatile gint refcount;
236 237 238 239 240 241
  GThread *thread;
  GMainContext *context;
  GMainLoop *loop;
} SharedThreadData;

static gpointer
242
gdbus_shared_thread_func (gpointer user_data)
243
{
244
  SharedThreadData *data = user_data;
245

246 247 248
  g_main_context_push_thread_default (data->context);
  g_main_loop_run (data->loop);
  g_main_context_pop_thread_default (data->context);
249

250
  release_required_types ();
251

252
  return NULL;
253 254
}

255 256
/* ---------------------------------------------------------------------------------------------------- */

257 258
static SharedThreadData *
_g_dbus_shared_thread_ref (void)
259
{
260 261
  static gsize shared_thread_data = 0;
  SharedThreadData *ret;
262

263
  if (g_once_init_enter (&shared_thread_data))
264
    {
265 266 267 268 269 270 271 272 273 274
      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);
275 276
      data->thread = g_thread_new ("gdbus",
                                   gdbus_shared_thread_func,
277
                                   data);
278 279
      /* We can cast between gsize and gpointer safely */
      g_once_init_leave (&shared_thread_data, (gsize) data);
280 281
    }

282 283 284
  ret = (SharedThreadData*) shared_thread_data;
  g_atomic_int_inc (&ret->refcount);
  return ret;
285 286 287
}

static void
288
_g_dbus_shared_thread_unref (SharedThreadData *data)
289 290 291
{
  /* TODO: actually destroy the shared thread here */
#if 0
292 293
  g_assert (data != NULL);
  if (g_atomic_int_dec_and_test (&data->refcount))
294
    {
295 296 297 298
      g_main_loop_quit (data->loop);
      //g_thread_join (data->thread);
      g_main_loop_unref (data->loop);
      g_main_context_unref (data->context);
299 300 301 302 303 304
    }
#endif
}

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

305 306 307 308 309 310 311
typedef enum {
    PENDING_NONE = 0,
    PENDING_WRITE,
    PENDING_FLUSH,
    PENDING_CLOSE
} OutputPending;

312 313 314
struct GDBusWorker
{
  volatile gint                       ref_count;
315

316 317
  SharedThreadData                   *shared_thread_data;

318 319
  /* really a boolean, but GLib 2.28 lacks atomic boolean ops */
  volatile gint                       stopped;
320 321 322 323 324 325

  /* 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;
326
  GDBusCapabilityFlags                capabilities;
327 328
  GQueue                             *received_messages_while_frozen;

329 330 331
  GIOStream                          *stream;
  GCancellable                       *cancellable;
  GDBusWorkerMessageReceivedCallback  message_received_callback;
332
  GDBusWorkerMessageAboutToBeSentCallback message_about_to_be_sent_callback;
333 334 335 336 337 338 339
  GDBusWorkerDisconnectedCallback     disconnected_callback;
  gpointer                            user_data;

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

  /* used for reading */
340
  GMutex                              read_lock;
341 342 343 344 345 346 347 348
  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;

349
  /* Whether an async write, flush or close, or none of those, is pending.
350 351 352 353
   * 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.
   */
354
  OutputPending                       output_pending;
355
  /* used for writing */
356
  GMutex                              write_lock;
357
  /* queue of MessageToWriteData, protected by write_lock */
358
  GQueue                             *write_queue;
359
  /* protected by write_lock */
360
  guint64                             write_num_messages_written;
361 362 363 364
  /* number of messages we'd written out last time we flushed;
   * protected by write_lock
   */
  guint64                             write_num_messages_flushed;
365
  /* list of FlushData, protected by write_lock */
366
  GList                              *write_pending_flushes;
367
  /* list of CloseData, protected by write_lock */
368
  GList                              *pending_close_attempts;
369 370
  /* no lock - only used from the worker thread */
  gboolean                            close_expected;
371 372
};

373 374
static void _g_dbus_worker_unref (GDBusWorker *worker);

375 376
/* ---------------------------------------------------------------------------------------------------- */

377 378
typedef struct
{
379 380
  GMutex  mutex;
  GCond   cond;
381
  guint64 number_to_wait_for;
382
  GError *error;
383 384
} FlushData;

385 386 387 388 389
struct _MessageToWriteData ;
typedef struct _MessageToWriteData MessageToWriteData;

static void message_to_write_data_free (MessageToWriteData *data);

390 391 392 393 394 395
static void read_message_print_transport_debug (gssize bytes_read,
                                                GDBusWorker *worker);

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

396 397
typedef struct {
    GDBusWorker *worker;
398
    GTask *task;
399 400 401 402
} CloseData;

static void close_data_free (CloseData *close_data)
{
403
  g_clear_object (&close_data->task);
404 405 406 407 408

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

409 410
/* ---------------------------------------------------------------------------------------------------- */

411 412 413 414 415 416 417 418 419 420 421 422
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))
    {
423 424
      g_assert (worker->write_pending_flushes == NULL);

425
      _g_dbus_shared_thread_unref (worker->shared_thread_data);
426 427 428

      g_object_unref (worker->stream);

429
      g_mutex_clear (&worker->read_lock);
430 431 432 433
      g_object_unref (worker->cancellable);
      if (worker->read_fd_list != NULL)
        g_object_unref (worker->read_fd_list);

434
      g_queue_free_full (worker->received_messages_while_frozen, (GDestroyNotify) g_object_unref);
435
      g_mutex_clear (&worker->write_lock);
436
      g_queue_free_full (worker->write_queue, (GDestroyNotify) message_to_write_data_free);
437 438
      g_free (worker->read_buffer);

439 440 441 442 443 444 445 446 447
      g_free (worker);
    }
}

static void
_g_dbus_worker_emit_disconnected (GDBusWorker  *worker,
                                  gboolean      remote_peer_vanished,
                                  GError       *error)
{
448
  if (!g_atomic_int_get (&worker->stopped))
449 450 451 452
    worker->disconnected_callback (worker, remote_peer_vanished, error, worker->user_data);
}

static void
453 454
_g_dbus_worker_emit_message_received (GDBusWorker  *worker,
                                      GDBusMessage *message)
455
{
456
  if (!g_atomic_int_get (&worker->stopped))
457 458 459
    worker->message_received_callback (worker, message, worker->user_data);
}

460
static GDBusMessage *
461 462 463
_g_dbus_worker_emit_message_about_to_be_sent (GDBusWorker  *worker,
                                              GDBusMessage *message)
{
464
  GDBusMessage *ret;
465
  if (!g_atomic_int_get (&worker->stopped))
466
    ret = worker->message_about_to_be_sent_callback (worker, message, worker->user_data);
467 468
  else
    ret = message;
469 470 471
  return ret;
}

472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496
/* 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;

497
  g_mutex_lock (&worker->read_lock);
498 499 500 501 502 503 504 505 506 507 508 509 510
  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);
    }
511
  g_mutex_unlock (&worker->read_lock);
512 513 514 515 516 517 518 519 520 521 522 523 524 525
  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);
526
  g_source_set_name (idle_source, "[gio] unfreeze_in_idle_cb");
527
  g_source_attach (idle_source, worker->shared_thread_data->context);
528 529 530 531 532
  g_source_unref (idle_source);
}

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

533 534 535 536 537 538 539 540 541 542 543 544
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;

545
  g_mutex_lock (&worker->read_lock);
546 547

  /* If already stopped, don't even process the reply */
548
  if (g_atomic_int_get (&worker->stopped))
549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589
    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);
Colin Walters's avatar
Colin Walters committed
590
                      (void) g_close (fds[n], NULL);
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
                    }
                }
              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)
    {
626 627 628 629 630 631 632 633 634 635 636 637 638
      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 ();
        }

639 640 641 642 643
      /* 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.
644 645 646 647 648 649 650 651 652
       *
       * 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.
653
       */
654 655
      if (worker->close_expected ||
          g_error_matches (error, G_IO_ERROR, G_IO_ERROR_CANCELLED))
656 657 658 659
        _g_dbus_worker_emit_disconnected (worker, FALSE, NULL);
      else
        _g_dbus_worker_emit_disconnected (worker, TRUE, error);

660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686
      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;
    }

687 688
  read_message_print_transport_debug (bytes_read, worker);

689 690 691 692 693 694 695 696 697 698 699 700 701 702
  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)
            {
703
              g_warning ("_g_dbus_worker_do_read_cb: error determining bytes needed: %s", error->message);
704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720
              _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,
721
                                                  worker->capabilities,
722 723 724
                                                  &error);
          if (message == NULL)
            {
725
              gchar *s;
726
              s = _g_dbus_hexdump (worker->read_buffer, worker->read_buffer_cur_size, 2);
727 728 729 730 731 732 733 734
              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);
735 736 737 738 739
              _g_dbus_worker_emit_disconnected (worker, FALSE, error);
              g_error_free (error);
              goto out;
            }

740
#ifdef G_OS_UNIX
741 742 743
          if (worker->read_fd_list != NULL)
            {
              g_dbus_message_set_unix_fd_list (message, worker->read_fd_list);
744
              g_object_unref (worker->read_fd_list);
745 746
              worker->read_fd_list = NULL;
            }
747
#endif
748 749 750 751

          if (G_UNLIKELY (_g_dbus_debug_message ()))
            {
              gchar *s;
752
              _g_dbus_debug_print_lock ();
753 754 755 756 757 758 759
              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);
760 761 762 763 764 765 766
              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 ();
767 768 769
            }

          /* yay, got a message, go deliver it */
770
          _g_dbus_worker_queue_or_deliver_received_message (worker, message);
771 772 773 774 775 776 777 778 779 780 781 782 783 784

          /* 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:
785
  g_mutex_unlock (&worker->read_lock);
786 787 788

  /* gives up the reference acquired when calling g_input_stream_read_async() */
  _g_dbus_worker_unref (worker);
789 790 791

  /* check if there is any pending close */
  schedule_pending_close (worker);
792 793 794 795 796 797
}

/* called in private thread shared by all GDBusConnection instances (with read-lock held) */
static void
_g_dbus_worker_do_read_unlocked (GDBusWorker *worker)
{
798 799 800 801
  /* 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'.
   */

802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841
  /* 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) */
842 843
static gboolean
_g_dbus_worker_do_initial_read (gpointer data)
844
{
845
  GDBusWorker *worker = data;
846
  g_mutex_lock (&worker->read_lock);
847
  _g_dbus_worker_do_read_unlocked (worker);
848
  g_mutex_unlock (&worker->read_lock);
849
  return FALSE;
850 851 852 853 854 855
}

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

struct _MessageToWriteData
{
856
  GDBusWorker  *worker;
857 858 859
  GDBusMessage *message;
  gchar        *blob;
  gsize         blob_size;
860

861 862
  gsize         total_written;
  GTask        *task;
863 864 865 866 867
};

static void
message_to_write_data_free (MessageToWriteData *data)
{
868
  _g_dbus_worker_unref (data->worker);
869 870
  if (data->message)
    g_object_unref (data->message);
871
  g_free (data->blob);
872
  g_slice_free (MessageToWriteData, data);
873 874 875 876
}

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

877 878
static void write_message_continue_writing (MessageToWriteData *data);

879 880 881
/* called in private thread shared by all GDBusConnection instances
 *
 * write-lock is not held on entry
882
 * output_pending is PENDING_WRITE on entry
883
 */
884 885 886 887
static void
write_message_async_cb (GObject      *source_object,
                        GAsyncResult *res,
                        gpointer      user_data)
888
{
889
  MessageToWriteData *data = user_data;
890
  GTask *task;
891 892
  gssize bytes_written;
  GError *error;
893

894
  /* Note: we can't access data->task after calling g_task_return_* () because the
895 896
   * callback can free @data and we're not completing in idle. So use a copy of the pointer.
   */
897
  task = data->task;
898

899 900 901 902 903 904
  error = NULL;
  bytes_written = g_output_stream_write_finish (G_OUTPUT_STREAM (source_object),
                                                res,
                                                &error);
  if (bytes_written == -1)
    {
905 906
      g_task_return_error (task, error);
      g_object_unref (task);
907 908 909 910 911
      goto out;
    }
  g_assert (bytes_written > 0); /* zero is never returned */

  write_message_print_transport_debug (bytes_written, data);
912

913 914 915 916
  data->total_written += bytes_written;
  g_assert (data->total_written <= data->blob_size);
  if (data->total_written == data->blob_size)
    {
917 918
      g_task_return_boolean (task, TRUE);
      g_object_unref (task);
919 920 921 922 923 924 925 926 927
      goto out;
    }

  write_message_continue_writing (data);

 out:
  ;
}

928 929 930
/* called in private thread shared by all GDBusConnection instances
 *
 * write-lock is not held on entry
931
 * output_pending is PENDING_WRITE on entry
932
 */
933
#ifdef G_OS_UNIX
934 935 936 937 938 939 940 941 942
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 */
}
943
#endif
944

945 946 947
/* called in private thread shared by all GDBusConnection instances
 *
 * write-lock is not held on entry
948
 * output_pending is PENDING_WRITE on entry
949
 */
950 951 952 953 954
static void
write_message_continue_writing (MessageToWriteData *data)
{
  GOutputStream *ostream;
#ifdef G_OS_UNIX
955
  GTask *task;
956 957 958
  GUnixFDList *fd_list;
#endif

959
#ifdef G_OS_UNIX
960
  /* Note: we can't access data->task after calling g_task_return_* () because the
961
   * callback can free @data and we're not completing in idle. So use a copy of the pointer.
962
   */
963
  task = data->task;
964
#endif
965 966 967 968 969 970 971 972 973

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

974 975 976
  if (FALSE)
    {
    }
977
#ifdef G_OS_UNIX
978
  else if (G_IS_SOCKET_OUTPUT_STREAM (ostream) && data->total_written == 0)
979 980
    {
      GOutputVector vector;
981
      GSocketControlMessage *control_message;
982
      gssize bytes_written;
983
      GError *error;
984

985 986
      vector.buffer = data->blob;
      vector.size = data->blob_size;
987

988 989
      control_message = NULL;
      if (fd_list != NULL && g_unix_fd_list_get_length (fd_list) > 0)
990
        {
991
          if (!(data->worker->capabilities & G_DBUS_CAPABILITY_FLAGS_UNIX_FD_PASSING))
992
            {
993 994 995 996 997
              g_task_return_new_error (task,
                                       G_IO_ERROR,
                                       G_IO_ERROR_FAILED,
                                       "Tried sending a file descriptor but remote peer does not support this capability");
              g_object_unref (task);
998 999
              goto out;
            }
1000
          control_message = g_unix_fd_message_new_with_fd_list (fd_list);
1001 1002
        }

1003 1004
      error = NULL;
      bytes_written = g_socket_send_message (data->worker->socket,
1005 1006 1007
                                             NULL, /* address */
                                             &vector,
                                             1,
1008 1009
                                             control_message != NULL ? &control_message : NULL,
                                             control_message != NULL ? 1 : 0,
1010
                                             G_SOCKET_MSG_NONE,
1011 1012 1013 1014 1015
                                             data->worker->cancellable,
                                             &error);
      if (control_message != NULL)
        g_object_unref (control_message);

1016 1017
      if (bytes_written == -1)
        {
1018
          /* Handle WOULD_BLOCK by waiting until there's room in the buffer */
Christian Persch's avatar
Christian Persch committed
1019
          if (g_error_matches (error, G_IO_ERROR, G_IO_ERROR_WOULD_BLOCK))
1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030
            {
              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
1031
              g_error_free (error);
1032 1033
              goto out;
            }
1034 1035
          g_task_return_error (task, error);
          g_object_unref (task);
1036 1037
          goto out;
        }
1038
      g_assert (bytes_written > 0); /* zero is never returned */
1039

1040 1041 1042 1043 1044
      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)
1045
        {
1046 1047
          g_task_return_boolean (task, TRUE);
          g_object_unref (task);
1048
          goto out;
1049
        }
1050 1051

      write_message_continue_writing (data);
1052
    }
1053
#endif
1054 1055
  else
    {
Matthias Clasen's avatar
Matthias Clasen committed
1056
#ifdef G_OS_UNIX
1057 1058
      if (fd_list != NULL)
        {
1059 1060 1061 1062 1063 1064
          g_task_return_new_error (task,
                                   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_object_unref (task);
1065 1066
          goto out;
        }
Matthias Clasen's avatar
Matthias Clasen committed
1067
#endif
1068 1069 1070 1071 1072 1073 1074 1075

      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);
1076
    }
1077
#ifdef G_OS_UNIX
1078
 out:
1079
#endif
1080 1081
  ;
}
1082

1083 1084 1085
/* called in private thread shared by all GDBusConnection instances
 *
 * write-lock is not held on entry
1086
 * output_pending is PENDING_WRITE on entry
1087
 */
1088 1089 1090 1091 1092 1093
static void
write_message_async (GDBusWorker         *worker,
                     MessageToWriteData  *data,
                     GAsyncReadyCallback  callback,
                     gpointer             user_data)
{
1094
  data->task = g_task_new (NULL, NULL, callback, user_data);
1095
  g_task_set_source_tag (data->task, write_message_async);
1096 1097 1098
  data->total_written = 0;
  write_message_continue_writing (data);
}
1099

1100
/* called in private thread shared by all GDBusConnection instances (with write-lock held) */
1101 1102 1103 1104
static gboolean
write_message_finish (GAsyncResult   *res,
                      GError        **error)
{
1105 1106 1107
  g_return_val_if_fail (g_task_is_valid (res, NULL), FALSE);

  return g_task_propagate_boolean (G_TASK (res), error);
1108 1109
}
/* ---------------------------------------------------------------------------------------------------- */
1110

1111
static void continue_writing (GDBusWorker *worker);
1112

1113 1114 1115 1116 1117 1118
typedef struct
{
  GDBusWorker *worker;
  GList *flushers;
} FlushAsyncData;

1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130
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;

1131 1132 1133
      g_mutex_lock (&f->mutex);
      g_cond_signal (&f->cond);
      g_mutex_unlock (&f->mutex);
1134 1135 1136
    }
}

1137 1138 1139
/* called in private thread shared by all GDBusConnection instances
 *
 * write-lock is not held on entry
1140
 * output_pending is PENDING_FLUSH on entry
1141
 */
1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157
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 ()))
1158
        {
1159 1160 1161 1162 1163 1164
          _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 ();
1165 1166 1167
        }
    }

1168
  g_assert (data->flushers != NULL);
1169
  flush_data_list_complete (data->flushers, error);
1170 1171 1172 1173 1174
  g_list_free (data->flushers);

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

1175 1176
  /* Make sure we tell folks that we don't have additional
     flushes pending */
1177
  g_mutex_lock (&data->worker->write_lock);
1178
  data->worker->write_num_messages_flushed = data->worker->write_num_messages_written;
1179 1180
  g_assert (data->worker->output_pending == PENDING_FLUSH);
  data->worker->output_pending = PENDING_NONE;
1181
  g_mutex_unlock (&data->worker->write_lock);
1182

1183
  /* OK, cool, finally kick off the next write */
1184
  continue_writing (data->worker);
1185 1186 1187 1188 1189

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

1190 1191 1192
/* called in private thread shared by all GDBusConnection instances
 *
 * write-lock is not held on entry
1193
 * output_pending is PENDING_FLUSH on entry
1194
 */
1195
static void
1196
start_flush (FlushAsyncData *data)
1197
{
1198 1199 1200 1201 1202 1203
  g_output_stream_flush_async (g_io_stream_get_output_stream (data->worker->stream),
                               G_PRIORITY_DEFAULT,
                               data->worker->cancellable,
                               ostream_flush_cb,
                               data);
}
1204

1205 1206 1207 1208 1209 1210 1211 1212 1213
/* 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)
{
1214 1215 1216
  if (G_UNLIKELY (_g_dbus_debug_message ()))
    {
      gchar *s;
1217
      _g_dbus_debug_print_lock ();
1218 1219 1220
      g_print ("========================================================================\n"
               "GDBus-debug:Message:\n"
               "  >>>> SENT D-Bus message (%" G_GSIZE_FORMAT " bytes)\n",
1221 1222
               message_data->blob_size);
      s = g_dbus_message_print (message_data->message, 2);
1223 1224
      g_print ("%s", s);
      g_free (s);
1225 1226
      if (G_UNLIKELY (_g_dbus_debug_payload ()))
        {
1227
          s = _g_dbus_hexdump (message_data->blob, message_data->blob_size, 2);
1228 1229 1230 1231
          g_print ("%s\n", s);
          g_free (s);
        }
      _g_dbus_debug_print_unlock ();
1232 1233
    }

1234
  worker->write_num_messages_written += 1;
1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251
}

/* 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;
1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262
  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);
        }
    }
1263 1264
  if (flushers != NULL)
    {
1265 1266
      g_assert (worker->output_pending == PENDING_NONE);
      worker->output_pending = PENDING_FLUSH;
1267
    }
1268 1269 1270 1271

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

1273 1274 1275
      data = g_new0 (FlushAsyncData, 1);
      data->worker = _g_dbus_worker_ref (worker);
      data->flushers = flushers;
1276
      return data;
1277
    }
1278 1279

  return NULL;
1280 1281
}

1282 1283 1284
/* called in private thread shared by all GDBusConnection instances
 *
 * write-lock is not held on entry
1285
 * output_pending is PENDING_WRITE on entry
1286
 */
1287 1288 1289 1290 1291 1292 1293 1294
static void
write_message_cb (GObject       *source_object,
                  GAsyncResult  *res,
                  gpointer       user_data)
{
  MessageToWriteData *data = user_data;
  GError *error;

1295
  g_mutex_lock (&data->worker->write_lock);
1296 1297
  g_assert (data->worker->output_pending == PENDING_WRITE);
  data->worker->output_pending = PENDING_NONE;
1298 1299 1300 1301

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

1304 1305 1306
      /* TODO: handle */
      _g_dbus_worker_emit_disconnected (data->worker, TRUE, error);
      g_error_free (error);
1307 1308

      g_mutex_lock (&data->worker->write_lock);
1309 1310
    }

1311 1312 1313 1314 1315
  message_written_unlocked (data->worker, data);

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

  continue_writing (data->worker);
1316 1317 1318

  message_to_write_data_free (data);
}
1319

1320 1321 1322
/* called in private thread shared by all GDBusConnection instances
 *
 * write-lock is not held on entry
1323
 * output_pending is PENDING_CLOSE on entry
1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336
 */
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);

1337
  g_mutex_lock (&worker->write_lock);
1338 1339 1340 1341 1342 1343 1344 1345 1346 1347

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

1348 1349
  g_assert (worker->output_pending == PENDING_CLOSE);
  worker->output_pending = PENDING_NONE;
1350

1351
  g_mutex_unlock (&worker->write_lock);
1352 1353 1354 1355 1356 1357 1358 1359

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

1360
      if (close_data->task != NULL)
1361 1362
        {
          if (error != NULL)
1363 1364 1365
            g_task_return_error (close_data->task, g_error_copy (error));
          else
            g_task_return_boolean (close_data->task, TRUE);
1366 1367 1368 1369 1370 1371 1372 1373
        }

      close_data_free (close_data);
    }

  g_clear_error (&error);

  /* all messages queued for sending are discarded */
1374
  g_queue_free_full (send_queue, (GDestroyNotify) message_to_write_data_free);
1375 1376 1377 1378 1379 1380 1381 1382 1383 1384
  /* 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);
}

1385 1386 1387
/* called in private thread shared by all GDBusConnection instances
 *
 * write-lock is not held on entry
1388
 * output_pending must be PENDING_NONE on entry
1389
 */
1390
static void
1391
continue_writing (GDBusWorker *worker)
1392 1393
{
  MessageToWriteData *data;
1394
  FlushAsyncData *flush_async_data;
1395 1396

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

1400
  g_mutex_lock (&worker->write_lock);
1401

1402 1403 1404
  data = NULL;
  flush_async_data = NULL;

1405 1406 1407
  /* if we want to close the connection, that takes precedence */
  if (worker->pending_close_attempts != NULL)
    {
1408
      GInputStream *input = g_io_stream_get_input_stream (worker->stream);
1409

1410 1411 1412 1413 1414 1415 1416 1417 1418
      if (!g_input_stream_has_pending (input))
        {
          worker->close_expected = TRUE;
          worker->output_pending = PENDING_CLOSE;

          g_io_stream_close_async (worker->stream, G_PRIORITY_DEFAULT,
                                   NULL, iostream_close_cb,
                                   _g_dbus_worker_ref (worker));
        }
1419 1420 1421
    }
  else
    {
1422
      flush_async_data = prepare_flush_unlocked (worker);
1423

1424 1425 1426 1427 1428 1429 1430
      if (flush_async_data == NULL)
        {
          data = g_queue_pop_head (worker->write_queue);

          if (data != NULL)
            worker->output_pending = PENDING_WRITE;
        }
1431 1432
    }

1433
  g_mutex_unlock (&worker->write_lock);
1434

1435
  /* Note that write_lock is only used for protecting the @write_queue
1436
   * and @output_pending fields of the GDBusWorker struct ... which we
1437 1438 1439 1440 1441 1442
   * 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.
   */
1443 1444 1445 1446 1447 1448 1449

  if (flush_async_data != NULL)
    {
      start_flush (flush_async_data);
      g_assert (data == NULL);
    }
  else if (data != NULL)
1450
    {
1451
      GDBusMessage *old_message;
1452 1453 1454 1455
      guchar *new_blob;
      gsize new_blob_size;
      GError *error;

1456 1457 1458
      old_message = data->message;
      data->message = _g_dbus_worker_emit_message_about_to_be_sent (worker, data->message);
      if (data->message == old_message)
1459
        {
1460 1461 1462 1463 1464
          /* filters had no effect - do nothing */
        }
      else if (data->message == NULL)
        {
          /* filters dropped message */
1465
          g_mutex_lock (&worker->write_lock);
1466
          worker->output_pending = PENDING_NONE;
1467
          g_mutex_unlock (&worker->write_lock);
1468 1469
          message_to_write_data_free (data);
          goto write_next;
1470 1471 1472 1473
        }
      else
        {
          /* filters altered the message -> reencode */
1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494
          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;
            }
1495
        }
1496 1497 1498 1499 1500

      write_message_async (worker,
                           data,
                           write_message_cb,
                           data);
1501
    }
1502
}
1503

1504 1505 1506
/* called in private thread shared by all GDBusConnection instances
 *
 * write-lock is not held on entry
1507
 * output_pending may be anything
1508
 */
1509
static gboolean
1510
continue_writing_in_idle_cb (gpointer user_data)
1511 1512
{
  GDBusWorker *worker = user_data;
1513 1514 1515 1516

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