dbus/dbus-pending-call.c

   1 /* -*- mode: C; c-file-style: "gnu" -*- */
   2 /* dbus-pending-call.c Object representing a call in progress.
   3  *
   4  * Copyright (C) 2002, 2003 Red Hat Inc.
   5  *
   6  * Licensed under the Academic Free License version 2.1
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; either version 2 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program; if not, write to the Free Software
  20  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  21  *
  22  */
  23
  24 #include "dbus-internals.h"
  25 #include "dbus-connection-internal.h"
  26 #include "dbus-pending-call-internal.h"
  27 #include "dbus-pending-call.h"
  28 #include "dbus-list.h"
  29 #include "dbus-threads.h"
  30 #include "dbus-test.h"
  31
  32 /**
  33  * @defgroup DBusPendingCallInternals DBusPendingCall implementation details
  34  * @ingroup DBusInternals
  35  * @brief DBusPendingCall private implementation details.
  36  *
  37  * The guts of DBusPendingCall and its methods.
  38  *
  39  * @{
  40  */
  41
  42 /**
  43  * @brief Internals of DBusPendingCall
  44  *
  45  * Opaque object representing a reply message that we're waiting for.
  46  */
  47 struct DBusPendingCall
  48 {
  49   DBusAtomic refcount;                            /**< reference count */
  50
  51   DBusDataSlotList slot_list;                     /**< Data stored by allocated integer ID */
  52
  53   DBusPendingCallNotifyFunction function;         /**< Notifier when reply arrives. */
  54
  55   DBusConnection *connection;                     /**< Connections we're associated with */
  56   DBusMessage *reply;                             /**< Reply (after we've received it) */
  57   DBusTimeout *timeout;                           /**< Timeout */
  58
  59   DBusList *timeout_link;                         /**< Preallocated timeout response */
  60
  61   dbus_uint32_t reply_serial;                     /**< Expected serial of reply */
  62
  63   unsigned int completed : 1;                     /**< TRUE if completed */
  64   unsigned int timeout_added : 1;                 /**< Have added the timeout */
  65 };
  66
  67 static dbus_int32_t notify_user_data_slot = -1;
  68
  69 /**
  70  * Creates a new pending reply object.
  71  *
  72  * @param connection connection where reply will arrive
  73  * @param timeout_milliseconds length of timeout, -1 for default
  74  * @param timeout_handler timeout handler, takes pending call as data
  75  * @returns a new #DBusPendingCall or #NULL if no memory.
  76  */
  77 DBusPendingCall*
  78 _dbus_pending_call_new (DBusConnection    *connection,
  79                         int                timeout_milliseconds,
  80                         DBusTimeoutHandler timeout_handler)
  81 {
  82   DBusPendingCall *pending;
  83   DBusTimeout *timeout;
  84
  85   _dbus_assert (timeout_milliseconds >= 0 || timeout_milliseconds == -1);
  86
  87   if (timeout_milliseconds == -1)
  88     timeout_milliseconds = _DBUS_DEFAULT_TIMEOUT_VALUE;
  89
  90   /* it would probably seem logical to pass in _DBUS_INT_MAX for
  91    * infinite timeout, but then math in
  92    * _dbus_connection_block_for_reply would get all overflow-prone, so
  93    * smack that down.
  94    */
  95   if (timeout_milliseconds > _DBUS_ONE_HOUR_IN_MILLISECONDS * 6)
  96     timeout_milliseconds = _DBUS_ONE_HOUR_IN_MILLISECONDS * 6;
  97
  98   if (!dbus_pending_call_allocate_data_slot (&notify_user_data_slot))
  99     return NULL;
 100
 101   pending = dbus_new0 (DBusPendingCall, 1);
 102
 103   if (pending == NULL)
 104     {
 105       dbus_pending_call_free_data_slot (&notify_user_data_slot);
 106       return NULL;
 107     }
 108
 109   timeout = _dbus_timeout_new (timeout_milliseconds,
 110                                timeout_handler,
 111                                pending, NULL);
 112
 113   if (timeout == NULL)
 114     {
 115       dbus_pending_call_free_data_slot (&notify_user_data_slot);
 116       dbus_free (pending);
 117       return NULL;
 118     }
 119
 120   pending->refcount.value = 1;
 121   pending->connection = connection;
 122   _dbus_connection_ref_unlocked (pending->connection);
 123
 124   pending->timeout = timeout;
 125
 126
 127   _dbus_data_slot_list_init (&pending->slot_list);
 128
 129   return pending;
 130 }
 131
 132 /**
 133  * Sets the reply of a pending call with the given message,
 134  * or if the message is #NULL, by timing out the pending call.
 135  *
 136  * @param pending the pending call
 137  * @param message the message to complete the call with, or #NULL
 138  *  to time out the call
 139  */
 140 void
 141 _dbus_pending_call_set_reply (DBusPendingCall *pending,
 142                               DBusMessage     *message)
 143 {
 144   if (message == NULL)
 145     {
 146       message = pending->timeout_link->data;
 147       _dbus_list_clear (&pending->timeout_link);
 148     }
 149   else
 150     dbus_message_ref (message);
 151
 152   _dbus_verbose ("  handing message %p (%s) to pending call serial %u\n",
 153                  message,
 154                  dbus_message_get_type (message) == DBUS_MESSAGE_TYPE_METHOD_RETURN ?
 155                  "method return" :
 156                  dbus_message_get_type (message) == DBUS_MESSAGE_TYPE_ERROR ?
 157                  "error" : "other type",
 158                  pending->reply_serial);
 159
 160   _dbus_assert (pending->reply == NULL);
 161   _dbus_assert (pending->reply_serial == dbus_message_get_reply_serial (message));
 162   pending->reply = message;
 163 }
 164
 165 /**
 166  * Calls notifier function for the pending call
 167  * and sets the call to completed.
 168  *
 169  * @param pending the pending call
 170  *
 171  */
 172 void
 173 _dbus_pending_call_complete (DBusPendingCall *pending)
 174 {
 175   _dbus_assert (!pending->completed);
 176
 177   pending->completed = TRUE;
 178
 179   if (pending->function)
 180     {
 181       void *user_data;
 182       user_data = dbus_pending_call_get_data (pending,
 183                                               notify_user_data_slot);
 184
 185       (* pending->function) (pending, user_data);
 186     }
 187 }
 188
 189 void
 190 _dbus_pending_call_queue_timeout_error (DBusPendingCall *pending,
 191                                         DBusConnection *connection)
 192 {
 193   if (pending->timeout_link)
 194     {
 195       _dbus_connection_queue_synthesized_message_link (connection,
 196                                                        pending->timeout_link);
 197       pending->timeout_link = NULL;
 198     }
 199 }
 200
 201 /**
 202  * Checks to see if a timeout has been added
 203  *
 204  * @param pending the pending_call
 205  * @returns #TRUE if there is a timeout or #FALSE if not
 206  */
 207 dbus_bool_t
 208 _dbus_pending_call_is_timeout_added (DBusPendingCall  *pending)
 209 {
 210   _dbus_assert (pending != NULL);
 211
 212   return pending->timeout_added;
 213 }
 214
 215
 216 /**
 217  * Sets wether the timeout has been added
 218  *
 219  * @param pending the pending_call
 220  * @param is_added whether or not a timeout is added
 221  */
 222 void
 223 _dbus_pending_call_set_timeout_added (DBusPendingCall  *pending,
 224                                       dbus_bool_t       is_added)
 225 {
 226   _dbus_assert (pending != NULL);
 227
 228   pending->timeout_added = is_added;
 229 }
 230
 231
 232 /**
 233  * Retrives the timeout
 234  *
 235  * @param pending the pending_call
 236  * @returns a timeout object
 237  */
 238 DBusTimeout *
 239 _dbus_pending_call_get_timeout (DBusPendingCall  *pending)
 240 {
 241   _dbus_assert (pending != NULL);
 242
 243   return pending->timeout;
 244 }
 245
 246 /**
 247  * Gets the reply's serial number
 248  *
 249  * @param pending the pending_call
 250  * @returns a serial number for the reply or 0
 251  */
 252 dbus_uint32_t
 253 _dbus_pending_call_get_reply_serial (DBusPendingCall  *pending)
 254 {
 255   _dbus_assert (pending != NULL);
 256
 257   return pending->reply_serial;
 258 }
 259
 260 /**
 261  * Sets the reply's serial number
 262  *
 263  * @param pending the pending_call
 264  * @param serial the serial number
 265  */
 266 void
 267 _dbus_pending_call_set_reply_serial  (DBusPendingCall *pending,
 268                                       dbus_uint32_t serial)
 269 {
 270   _dbus_assert (pending != NULL);
 271   _dbus_assert (pending->reply_serial == 0);
 272
 273   pending->reply_serial = serial;
 274 }
 275
 276 /**
 277  * Gets the connection associated with this pending call
 278  *
 279  * @param pending the pending_call
 280  * @returns the connection associated with the pending call
 281  */
 282 DBusConnection *
 283 _dbus_pending_call_get_connection (DBusPendingCall *pending)
 284 {
 285   _dbus_assert (pending != NULL);
 286
 287   return pending->connection;
 288 }
 289
 290 /**
 291  * Sets the reply message associated with the pending call to a timeout error
 292  *
 293  * @param pending the pending_call
 294  * @param message the message we are sending the error reply to
 295  * @param serial serial number for the reply
 296  * @return #FALSE on OOM
 297  */
 298 dbus_bool_t
 299 _dbus_pending_call_set_timeout_error (DBusPendingCall *pending,
 300                                       DBusMessage *message,
 301                                       dbus_uint32_t serial)
 302 {
 303   DBusList *reply_link;
 304   DBusMessage *reply;
 305
 306   reply = dbus_message_new_error (message, DBUS_ERROR_NO_REPLY,
 307                                   "Did not receive a reply. Possible causes include: "
 308                                   "the remote application did not send a reply, "
 309                                   "the message bus security policy blocked the reply, "
 310                                   "the reply timeout expired, or "
 311                                   "the network connection was broken.");
 312   if (reply == NULL)
 313     return FALSE;
 314
 315   reply_link = _dbus_list_alloc_link (reply);
 316   if (reply_link == NULL)
 317     {
 318       dbus_message_unref (reply);
 319       return FALSE;
 320     }
 321
 322   pending->timeout_link = reply_link;
 323
 324   _dbus_pending_call_set_reply_serial (pending, serial);
 325
 326   return TRUE;
 327 }
 328
 329 /** @} */
 330
 331 /**
 332  * @defgroup DBusPendingCall DBusPendingCall
 333  * @ingroup  DBus
 334  * @brief Pending reply to a method call message
 335  *
 336  * A DBusPendingCall is an object representing an
 337  * expected reply. A #DBusPendingCall can be created
 338  * when you send a message that should have a reply.
 339  *
 340  * @{
 341  */
 342
 343 /**
 344  * @typedef DBusPendingCall
 345  *
 346  * Opaque data type representing a message pending.
 347  */
 348
 349 /**
 350  * Increments the reference count on a pending call.
 351  *
 352  * @param pending the pending call object
 353  * @returns the pending call object
 354  */
 355 DBusPendingCall *
 356 dbus_pending_call_ref (DBusPendingCall *pending)
 357 {
 358   _dbus_return_val_if_fail (pending != NULL, NULL);
 359
 360   _dbus_atomic_inc (&pending->refcount);
 361
 362   return pending;
 363 }
 364
 365 /**
 366  * Decrements the reference count on a pending call,
 367  * freeing it if the count reaches 0.
 368  *
 369  * @param pending the pending call object
 370  */
 371 void
 372 dbus_pending_call_unref (DBusPendingCall *pending)
 373 {
 374   dbus_bool_t last_unref;
 375
 376   _dbus_return_if_fail (pending != NULL);
 377
 378   last_unref = (_dbus_atomic_dec (&pending->refcount) == 1);
 379
 380   if (last_unref)
 381     {
 382       /* If we get here, we should be already detached
 383        * from the connection, or never attached.
 384        */
 385       _dbus_assert (!pending->timeout_added);
 386
 387       dbus_connection_unref (pending->connection);
 388
 389       /* this assumes we aren't holding connection lock... */
 390       _dbus_data_slot_list_free (&pending->slot_list);
 391
 392       if (pending->timeout != NULL)
 393         _dbus_timeout_unref (pending->timeout);
 394
 395       if (pending->timeout_link)
 396         {
 397           dbus_message_unref ((DBusMessage *)pending->timeout_link->data);
 398           _dbus_list_free_link (pending->timeout_link);
 399           pending->timeout_link = NULL;
 400         }
 401
 402       if (pending->reply)
 403         {
 404           dbus_message_unref (pending->reply);
 405           pending->reply = NULL;
 406         }
 407
 408       dbus_free (pending);
 409
 410       dbus_pending_call_free_data_slot (&notify_user_data_slot);
 411     }
 412 }
 413
 414 /**
 415  * Sets a notification function to be called when the reply is
 416  * received or the pending call times out.
 417  *
 418  * @param pending the pending call
 419  * @param function notifier function
 420  * @param user_data data to pass to notifier function
 421  * @param free_user_data function to free the user data
 422  * @returns #FALSE if not enough memory
 423  */
 424 dbus_bool_t
 425 dbus_pending_call_set_notify (DBusPendingCall              *pending,
 426                               DBusPendingCallNotifyFunction function,
 427                               void                         *user_data,
 428                               DBusFreeFunction              free_user_data)
 429 {
 430   _dbus_return_val_if_fail (pending != NULL, FALSE);
 431
 432   /* could invoke application code! */
 433   if (!dbus_pending_call_set_data (pending, notify_user_data_slot,
 434                                    user_data, free_user_data))
 435     return FALSE;
 436
 437   pending->function = function;
 438
 439   return TRUE;
 440 }
 441
 442 /**
 443  * Cancels the pending call, such that any reply or error received
 444  * will just be ignored.  Drops the dbus library's internal reference
 445  * to the #DBusPendingCall so will free the call if nobody else is
 446  * holding a reference. However you usually get a reference
 447  * from dbus_connection_send() so probably your app owns a ref also.
 448  *
 449  * @param pending the pending call
 450  */
 451 void
 452 dbus_pending_call_cancel (DBusPendingCall *pending)
 453 {
 454   if (pending->connection)
 455     _dbus_connection_remove_pending_call (pending->connection,
 456                                           pending);
 457 }
 458
 459 /**
 460  * Checks whether the pending call has received a reply
 461  * yet, or not.
 462  *
 463  * @todo not thread safe? I guess it has to lock though it sucks
 464  *
 465  * @param pending the pending call
 466  * @returns #TRUE if a reply has been received */
 467 dbus_bool_t
 468 dbus_pending_call_get_completed (DBusPendingCall *pending)
 469 {
 470   return pending->completed;
 471 }
 472
 473 /**
 474  * Gets the reply, or returns #NULL if none has been received
 475  * yet. Ownership of the reply message passes to the caller. This
 476  * function can only be called once per pending call, since the reply
 477  * message is tranferred to the caller.
 478  *
 479  * @param pending the pending call
 480  * @returns the reply message or #NULL.
 481  */
 482 DBusMessage*
 483 dbus_pending_call_steal_reply (DBusPendingCall *pending)
 484 {
 485   DBusMessage *message;
 486
 487   _dbus_return_val_if_fail (pending->completed, NULL);
 488   _dbus_return_val_if_fail (pending->reply != NULL, NULL);
 489
 490   message = pending->reply;
 491   pending->reply = NULL;
 492
 493   return message;
 494 }
 495
 496 /**
 497  * Block until the pending call is completed.  The blocking is as with
 498  * dbus_connection_send_with_reply_and_block(); it does not enter the
 499  * main loop or process other messages, it simply waits for the reply
 500  * in question.
 501  *
 502  * If the pending call is already completed, this function returns
 503  * immediately.
 504  *
 505  * @todo when you start blocking, the timeout is reset, but it should
 506  * really only use time remaining since the pending call was created.
 507  *
 508  * @param pending the pending call
 509  */
 510 void
 511 dbus_pending_call_block (DBusPendingCall *pending)
 512 {
 513   _dbus_connection_block_pending_call (pending);
 514 }
 515
 516 static DBusDataSlotAllocator slot_allocator;
 517 _DBUS_DEFINE_GLOBAL_LOCK (pending_call_slots);
 518
 519 /**
 520  * Allocates an integer ID to be used for storing application-specific
 521  * data on any DBusPendingCall. The allocated ID may then be used
 522  * with dbus_pending_call_set_data() and dbus_pending_call_get_data().
 523  * The passed-in slot must be initialized to -1, and is filled in
 524  * with the slot ID. If the passed-in slot is not -1, it's assumed
 525  * to be already allocated, and its refcount is incremented.
 526  *
 527  * The allocated slot is global, i.e. all DBusPendingCall objects will
 528  * have a slot with the given integer ID reserved.
 529  *
 530  * @param slot_p address of a global variable storing the slot
 531  * @returns #FALSE on failure (no memory)
 532  */
 533 dbus_bool_t
 534 dbus_pending_call_allocate_data_slot (dbus_int32_t *slot_p)
 535 {
 536   return _dbus_data_slot_allocator_alloc (&slot_allocator,
 537                                           _DBUS_LOCK_NAME (pending_call_slots),
 538                                           slot_p);
 539 }
 540
 541 /**
 542  * Deallocates a global ID for #DBusPendingCall data slots.
 543  * dbus_pending_call_get_data() and dbus_pending_call_set_data() may
 544  * no longer be used with this slot.  Existing data stored on existing
 545  * DBusPendingCall objects will be freed when the #DBusPendingCall is
 546  * finalized, but may not be retrieved (and may only be replaced if
 547  * someone else reallocates the slot).  When the refcount on the
 548  * passed-in slot reaches 0, it is set to -1.
 549  *
 550  * @param slot_p address storing the slot to deallocate
 551  */
 552 void
 553 dbus_pending_call_free_data_slot (dbus_int32_t *slot_p)
 554 {
 555   _dbus_return_if_fail (*slot_p >= 0);
 556
 557   _dbus_data_slot_allocator_free (&slot_allocator, slot_p);
 558 }
 559
 560 /**
 561  * Stores a pointer on a #DBusPendingCall, along
 562  * with an optional function to be used for freeing
 563  * the data when the data is set again, or when
 564  * the pending call is finalized. The slot number
 565  * must have been allocated with dbus_pending_call_allocate_data_slot().
 566  *
 567  * @param pending the pending_call
 568  * @param slot the slot number
 569  * @param data the data to store
 570  * @param free_data_func finalizer function for the data
 571  * @returns #TRUE if there was enough memory to store the data
 572  */
 573 dbus_bool_t
 574 dbus_pending_call_set_data (DBusPendingCall  *pending,
 575                             dbus_int32_t      slot,
 576                             void             *data,
 577                             DBusFreeFunction  free_data_func)
 578 {
 579   DBusFreeFunction old_free_func;
 580   void *old_data;
 581   dbus_bool_t retval;
 582
 583   _dbus_return_val_if_fail (pending != NULL, FALSE);
 584   _dbus_return_val_if_fail (slot >= 0, FALSE);
 585
 586   retval = _dbus_data_slot_list_set (&slot_allocator,
 587                                      &pending->slot_list,
 588                                      slot, data, free_data_func,
 589                                      &old_free_func, &old_data);
 590
 591   if (retval)
 592     {
 593       if (old_free_func)
 594         (* old_free_func) (old_data);
 595     }
 596
 597   return retval;
 598 }
 599
 600 /**
 601  * Retrieves data previously set with dbus_pending_call_set_data().
 602  * The slot must still be allocated (must not have been freed).
 603  *
 604  * @param pending the pending_call
 605  * @param slot the slot to get data from
 606  * @returns the data, or #NULL if not found
 607  */
 608 void*
 609 dbus_pending_call_get_data (DBusPendingCall   *pending,
 610                             dbus_int32_t       slot)
 611 {
 612   void *res;
 613
 614   _dbus_return_val_if_fail (pending != NULL, NULL);
 615
 616   res = _dbus_data_slot_list_get (&slot_allocator,
 617                                   &pending->slot_list,
 618                                   slot);
 619
 620   return res;
 621 }
 622
 623 /** @} */
 624
 625 #ifdef DBUS_BUILD_TESTS
 626
 627 /**
 628  * @ingroup DBusPendingCallInternals
 629  * Unit test for DBusPendingCall.
 630  *
 631  * @returns #TRUE on success.
 632  */
 633 dbus_bool_t
 634 _dbus_pending_call_test (const char *test_data_dir)
 635 {
 636
 637   return TRUE;
 638 }
 639 #endif /* DBUS_BUILD_TESTS */