dbus/dbus-watch.c

   1 /* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
   2 /* dbus-watch.c DBusWatch implementation
   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., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
  21  *
  22  */
  23
  24 #include <config.h>
  25 #include "dbus-internals.h"
  26 #include "dbus-watch.h"
  27 #include "dbus-list.h"
  28
  29 /**
  30  * @defgroup DBusWatchInternals DBusWatch implementation details
  31  * @ingroup  DBusInternals
  32  * @brief implementation details for DBusWatch
  33  *
  34  * @{
  35  */
  36
  37 /**
  38  * Implementation of DBusWatch
  39  */
  40 struct DBusWatch
  41 {
  42   int refcount;                        /**< Reference count */
  43   int fd;                              /**< File descriptor. */
  44   unsigned int flags;                  /**< Conditions to watch. */
  45
  46   DBusWatchHandler handler;                    /**< Watch handler. */
  47   void *handler_data;                          /**< Watch handler data. */
  48   DBusFreeFunction free_handler_data_function; /**< Free the watch handler data. */
  49
  50   void *data;                          /**< Application data. */
  51   DBusFreeFunction free_data_function; /**< Free the application data. */
  52   unsigned int enabled : 1;            /**< Whether it's enabled. */
  53   unsigned int oom_last_time : 1;      /**< Whether it was OOM last time. */
  54 };
  55
  56 dbus_bool_t
  57 _dbus_watch_get_enabled (DBusWatch *watch)
  58 {
  59   return watch->enabled;
  60 }
  61
  62 dbus_bool_t
  63 _dbus_watch_get_oom_last_time (DBusWatch *watch)
  64 {
  65   return watch->oom_last_time;
  66 }
  67
  68 void
  69 _dbus_watch_set_oom_last_time (DBusWatch   *watch,
  70                                dbus_bool_t  oom)
  71 {
  72   watch->oom_last_time = oom;
  73 }
  74
  75 /**
  76  * Creates a new DBusWatch. Used to add a file descriptor to be polled
  77  * by a main loop.
  78  *
  79  * @param fd the file descriptor to be watched.
  80  * @param flags the conditions to watch for on the descriptor.
  81  * @param enabled the initial enabled state
  82  * @param handler the handler function
  83  * @param data data for handler function
  84  * @param free_data_function function to free the data
  85  * @returns the new DBusWatch object.
  86  */
  87 DBusWatch*
  88 _dbus_watch_new (int               fd,
  89                  unsigned int      flags,
  90                  dbus_bool_t       enabled,
  91                  DBusWatchHandler  handler,
  92                  void             *data,
  93                  DBusFreeFunction  free_data_function)
  94 {
  95   DBusWatch *watch;
  96
  97 #define VALID_WATCH_FLAGS (DBUS_WATCH_WRITABLE | DBUS_WATCH_READABLE)
  98
  99   _dbus_assert ((flags & VALID_WATCH_FLAGS) == flags);
 100
 101   watch = dbus_new0 (DBusWatch, 1);
 102   if (watch == NULL)
 103     return NULL;
 104
 105   watch->refcount = 1;
 106   watch->fd = fd;
 107   watch->flags = flags;
 108   watch->enabled = enabled;
 109
 110   watch->handler = handler;
 111   watch->handler_data = data;
 112   watch->free_handler_data_function = free_data_function;
 113
 114   return watch;
 115 }
 116
 117 /**
 118  * Increments the reference count of a DBusWatch object.
 119  *
 120  * @param watch the watch object.
 121  * @returns the watch object.
 122  */
 123 DBusWatch *
 124 _dbus_watch_ref (DBusWatch *watch)
 125 {
 126   watch->refcount += 1;
 127
 128   return watch;
 129 }
 130
 131 /**
 132  * Decrements the reference count of a DBusWatch object
 133  * and finalizes the object if the count reaches zero.
 134  *
 135  * @param watch the watch object.
 136  */
 137 void
 138 _dbus_watch_unref (DBusWatch *watch)
 139 {
 140   _dbus_assert (watch != NULL);
 141   _dbus_assert (watch->refcount > 0);
 142
 143   watch->refcount -= 1;
 144   if (watch->refcount == 0)
 145     {
 146       if (watch->fd != -1)
 147         _dbus_warn ("this watch should have been invalidated");
 148
 149       dbus_watch_set_data (watch, NULL, NULL); /* call free_data_function */
 150
 151       if (watch->free_handler_data_function)
 152         (* watch->free_handler_data_function) (watch->handler_data);
 153
 154       dbus_free (watch);
 155     }
 156 }
 157
 158 /**
 159  * Clears the file descriptor from a now-invalid watch object so that
 160  * no one tries to use it.  This is because a watch may stay alive due
 161  * to reference counts after the file descriptor is closed.
 162  * Invalidation makes it easier to catch bugs. It also
 163  * keeps people from doing dorky things like assuming file descriptors
 164  * are unique (never recycled).
 165  *
 166  * @param watch the watch object.
 167  */
 168 void
 169 _dbus_watch_invalidate (DBusWatch *watch)
 170 {
 171   watch->fd = -1;
 172   watch->flags = 0;
 173 }
 174
 175 /**
 176  * Sanitizes the given condition so that it only contains
 177  * flags that the DBusWatch requested. e.g. if the
 178  * watch is a DBUS_WATCH_READABLE watch then
 179  * DBUS_WATCH_WRITABLE will be stripped from the condition.
 180  *
 181  * @param watch the watch object.
 182  * @param condition address of the condition to sanitize.
 183  */
 184 void
 185 _dbus_watch_sanitize_condition (DBusWatch    *watch,
 186                                 unsigned int *condition)
 187 {
 188   if (!(watch->flags & DBUS_WATCH_READABLE))
 189     *condition &= ~DBUS_WATCH_READABLE;
 190   if (!(watch->flags & DBUS_WATCH_WRITABLE))
 191     *condition &= ~DBUS_WATCH_WRITABLE;
 192 }
 193
 194
 195 /**
 196  * @typedef DBusWatchList
 197  *
 198  * Opaque data type representing a list of watches
 199  * and a set of DBusAddWatchFunction/DBusRemoveWatchFunction.
 200  * Automatically handles removing/re-adding watches
 201  * when the DBusAddWatchFunction is updated or changed.
 202  * Holds a reference count to each watch.
 203  *
 204  * Used in the implementation of both DBusServer and
 205  * DBusClient.
 206  *
 207  */
 208
 209 /**
 210  * DBusWatchList implementation details. All fields
 211  * are private.
 212  *
 213  */
 214 struct DBusWatchList
 215 {
 216   DBusList *watches;           /**< Watch objects. */
 217
 218   DBusAddWatchFunction add_watch_function;    /**< Callback for adding a watch. */
 219   DBusRemoveWatchFunction remove_watch_function; /**< Callback for removing a watch. */
 220   DBusWatchToggledFunction watch_toggled_function; /**< Callback on toggling enablement */
 221   void *watch_data;                           /**< Data for watch callbacks */
 222   DBusFreeFunction watch_free_data_function;  /**< Free function for watch callback data */
 223 };
 224
 225 /**
 226  * Creates a new watch list. Returns #NULL if insufficient
 227  * memory exists.
 228  *
 229  * @returns the new watch list, or #NULL on failure.
 230  */
 231 DBusWatchList*
 232 _dbus_watch_list_new (void)
 233 {
 234   DBusWatchList *watch_list;
 235
 236   watch_list = dbus_new0 (DBusWatchList, 1);
 237   if (watch_list == NULL)
 238     return NULL;
 239
 240   return watch_list;
 241 }
 242
 243 /**
 244  * Frees a DBusWatchList.
 245  *
 246  * @param watch_list the watch list.
 247  */
 248 void
 249 _dbus_watch_list_free (DBusWatchList *watch_list)
 250 {
 251   /* free watch_data and removes watches as a side effect */
 252   _dbus_watch_list_set_functions (watch_list,
 253                                   NULL, NULL, NULL, NULL, NULL);
 254   _dbus_list_foreach (&watch_list->watches,
 255                       (DBusForeachFunction) _dbus_watch_unref,
 256                       NULL);
 257   _dbus_list_clear (&watch_list->watches);
 258
 259   dbus_free (watch_list);
 260 }
 261
 262 #ifdef DBUS_ENABLE_VERBOSE_MODE
 263 static const char*
 264 watch_flags_to_string (int flags)
 265 {
 266   const char *watch_type;
 267
 268   if ((flags & DBUS_WATCH_READABLE) &&
 269       (flags & DBUS_WATCH_WRITABLE))
 270     watch_type = "readwrite";
 271   else if (flags & DBUS_WATCH_READABLE)
 272     watch_type = "read";
 273   else if (flags & DBUS_WATCH_WRITABLE)
 274     watch_type = "write";
 275   else
 276     watch_type = "not read or write";
 277   return watch_type;
 278 }
 279 #endif /* DBUS_ENABLE_VERBOSE_MODE */
 280
 281 /**
 282  * Sets the watch functions. This function is the "backend"
 283  * for dbus_connection_set_watch_functions() and
 284  * dbus_server_set_watch_functions().
 285  *
 286  * @param watch_list the watch list.
 287  * @param add_function the add watch function.
 288  * @param remove_function the remove watch function.
 289  * @param toggled_function function on toggling enabled flag, or #NULL
 290  * @param data the data for those functions.
 291  * @param free_data_function the function to free the data.
 292  * @returns #FALSE if not enough memory
 293  *
 294  */
 295 dbus_bool_t
 296 _dbus_watch_list_set_functions (DBusWatchList           *watch_list,
 297                                 DBusAddWatchFunction     add_function,
 298                                 DBusRemoveWatchFunction  remove_function,
 299                                 DBusWatchToggledFunction toggled_function,
 300                                 void                    *data,
 301                                 DBusFreeFunction         free_data_function)
 302 {
 303   /* Add watches with the new watch function, failing on OOM */
 304   if (add_function != NULL)
 305     {
 306       DBusList *link;
 307
 308       link = _dbus_list_get_first_link (&watch_list->watches);
 309       while (link != NULL)
 310         {
 311           DBusList *next = _dbus_list_get_next_link (&watch_list->watches,
 312                                                      link);
 313
 314           _dbus_verbose ("Adding a %s watch on fd %d using newly-set add watch function\n",
 315                          watch_flags_to_string (dbus_watch_get_flags (link->data)),
 316                          dbus_watch_get_socket (link->data));
 317
 318           if (!(* add_function) (link->data, data))
 319             {
 320               /* remove it all again and return FALSE */
 321               DBusList *link2;
 322
 323               link2 = _dbus_list_get_first_link (&watch_list->watches);
 324               while (link2 != link)
 325                 {
 326                   DBusList *next = _dbus_list_get_next_link (&watch_list->watches,
 327                                                              link2);
 328
 329                   _dbus_verbose ("Removing watch on fd %d using newly-set remove function because initial add failed\n",
 330                                  dbus_watch_get_socket (link2->data));
 331
 332                   (* remove_function) (link2->data, data);
 333
 334                   link2 = next;
 335                 }
 336
 337               return FALSE;
 338             }
 339
 340           link = next;
 341         }
 342     }
 343
 344   /* Remove all current watches from previous watch handlers */
 345
 346   if (watch_list->remove_watch_function != NULL)
 347     {
 348       _dbus_verbose ("Removing all pre-existing watches\n");
 349
 350       _dbus_list_foreach (&watch_list->watches,
 351                           (DBusForeachFunction) watch_list->remove_watch_function,
 352                           watch_list->watch_data);
 353     }
 354
 355   if (watch_list->watch_free_data_function != NULL)
 356     (* watch_list->watch_free_data_function) (watch_list->watch_data);
 357
 358   watch_list->add_watch_function = add_function;
 359   watch_list->remove_watch_function = remove_function;
 360   watch_list->watch_toggled_function = toggled_function;
 361   watch_list->watch_data = data;
 362   watch_list->watch_free_data_function = free_data_function;
 363
 364   return TRUE;
 365 }
 366
 367 /**
 368  * Adds a new watch to the watch list, invoking the
 369  * application DBusAddWatchFunction if appropriate.
 370  *
 371  * @param watch_list the watch list.
 372  * @param watch the watch to add.
 373  * @returns #TRUE on success, #FALSE if no memory.
 374  */
 375 dbus_bool_t
 376 _dbus_watch_list_add_watch (DBusWatchList *watch_list,
 377                             DBusWatch     *watch)
 378 {
 379   if (!_dbus_list_append (&watch_list->watches, watch))
 380     return FALSE;
 381
 382   _dbus_watch_ref (watch);
 383
 384   if (watch_list->add_watch_function != NULL)
 385     {
 386       _dbus_verbose ("Adding watch on fd %d\n",
 387                      dbus_watch_get_socket (watch));
 388
 389       if (!(* watch_list->add_watch_function) (watch,
 390                                                watch_list->watch_data))
 391         {
 392           _dbus_list_remove_last (&watch_list->watches, watch);
 393           _dbus_watch_unref (watch);
 394           return FALSE;
 395         }
 396     }
 397
 398   return TRUE;
 399 }
 400
 401 /**
 402  * Removes a watch from the watch list, invoking the
 403  * application's DBusRemoveWatchFunction if appropriate.
 404  *
 405  * @param watch_list the watch list.
 406  * @param watch the watch to remove.
 407  */
 408 void
 409 _dbus_watch_list_remove_watch  (DBusWatchList *watch_list,
 410                                 DBusWatch     *watch)
 411 {
 412   if (!_dbus_list_remove (&watch_list->watches, watch))
 413     _dbus_assert_not_reached ("Nonexistent watch was removed");
 414
 415   if (watch_list->remove_watch_function != NULL)
 416     {
 417       _dbus_verbose ("Removing watch on fd %d\n",
 418                      dbus_watch_get_socket (watch));
 419
 420       (* watch_list->remove_watch_function) (watch,
 421                                              watch_list->watch_data);
 422     }
 423
 424   _dbus_watch_unref (watch);
 425 }
 426
 427 /**
 428  * Sets a watch to the given enabled state, invoking the
 429  * application's DBusWatchToggledFunction if appropriate.
 430  *
 431  * @param watch_list the watch list.
 432  * @param watch the watch to toggle.
 433  * @param enabled #TRUE to enable
 434  */
 435 void
 436 _dbus_watch_list_toggle_watch (DBusWatchList           *watch_list,
 437                                DBusWatch               *watch,
 438                                dbus_bool_t              enabled)
 439 {
 440   enabled = !!enabled;
 441
 442   if (enabled == watch->enabled)
 443     return;
 444
 445   watch->enabled = enabled;
 446
 447   if (watch_list->watch_toggled_function != NULL)
 448     {
 449       _dbus_verbose ("Toggling watch %p on fd %d to %d\n",
 450                      watch, dbus_watch_get_socket (watch), watch->enabled);
 451
 452       (* watch_list->watch_toggled_function) (watch,
 453                                               watch_list->watch_data);
 454     }
 455 }
 456
 457 /**
 458  * Sets the handler for the watch.
 459  *
 460  * @todo this function only exists because of the weird
 461  * way connection watches are done, see the note
 462  * in docs for _dbus_connection_handle_watch().
 463  *
 464  * @param watch the watch
 465  * @param handler the new handler
 466  * @param data the data
 467  * @param free_data_function free data with this
 468  */
 469 void
 470 _dbus_watch_set_handler (DBusWatch        *watch,
 471                          DBusWatchHandler  handler,
 472                          void             *data,
 473                          DBusFreeFunction  free_data_function)
 474 {
 475   if (watch->free_handler_data_function)
 476     (* watch->free_handler_data_function) (watch->handler_data);
 477
 478   watch->handler = handler;
 479   watch->handler_data = data;
 480   watch->free_handler_data_function = free_data_function;
 481 }
 482
 483 /** @} */
 484
 485 /**
 486  * @defgroup DBusWatch DBusWatch
 487  * @ingroup  DBus
 488  * @brief Object representing a file descriptor to be watched.
 489  *
 490  * Types and functions related to DBusWatch. A watch represents
 491  * a file descriptor that the main loop needs to monitor,
 492  * as in Qt's QSocketNotifier or GLib's g_io_add_watch().
 493  *
 494  * Use dbus_connection_set_watch_functions() or dbus_server_set_watch_functions()
 495  * to be notified when libdbus needs to add or remove watches.
 496  *
 497  * @{
 498  */
 499
 500 /**
 501  * @typedef DBusWatch
 502  *
 503  * Opaque object representing a file descriptor
 504  * to be watched for changes in readability,
 505  * writability, or hangup.
 506  */
 507
 508 /**
 509  * Deprecated former name of dbus_watch_get_unix_fd().
 510  *
 511  * @param watch the DBusWatch object.
 512  * @returns the file descriptor to watch.
 513  */
 514 int
 515 dbus_watch_get_fd (DBusWatch *watch)
 516 {
 517   _dbus_return_val_if_fail (watch != NULL, -1);
 518
 519   return dbus_watch_get_unix_fd(watch);
 520 }
 521
 522 /**
 523  * Returns a UNIX file descriptor to be watched,
 524  * which may be a pipe, socket, or other type of
 525  * descriptor. On UNIX this is preferred to
 526  * dbus_watch_get_socket() since it works with
 527  * more kinds of #DBusWatch.
 528  *
 529  * Always returns -1 on Windows. On Windows you use
 530  * dbus_watch_get_socket() to get a Winsock socket to watch.
 531  *
 532  * @param watch the DBusWatch object.
 533  * @returns the file descriptor to watch.
 534  */
 535 int
 536 dbus_watch_get_unix_fd (DBusWatch *watch)
 537 {
 538   _dbus_return_val_if_fail (watch != NULL, -1);
 539
 540   /* FIXME remove #ifdef and do this on a lower level
 541    * (watch should have set_socket and set_unix_fd and track
 542    * which it has, and the transport should provide the
 543    * appropriate watch type)
 544    */
 545 #ifdef DBUS_UNIX
 546   return watch->fd;
 547 #else
 548   return dbus_watch_get_socket( watch );
 549 #endif
 550 }
 551
 552 /**
 553  * Returns a socket to be watched, on UNIX this will return -1 if our
 554  * transport is not socket-based so dbus_watch_get_unix_fd() is
 555  * preferred.
 556  *
 557  * On Windows, dbus_watch_get_unix_fd() returns -1 but this function
 558  * returns a Winsock socket (assuming the transport is socket-based,
 559  * as it always is for now).
 560  *
 561  * @param watch the DBusWatch object.
 562  * @returns the socket to watch.
 563  */
 564 int
 565 dbus_watch_get_socket (DBusWatch *watch)
 566 {
 567   _dbus_return_val_if_fail (watch != NULL, -1);
 568
 569   return watch->fd;
 570 }
 571
 572 /**
 573  * Gets flags from DBusWatchFlags indicating
 574  * what conditions should be monitored on the
 575  * file descriptor.
 576  *
 577  * The flags returned will only contain DBUS_WATCH_READABLE
 578  * and DBUS_WATCH_WRITABLE, never DBUS_WATCH_HANGUP or
 579  * DBUS_WATCH_ERROR; all watches implicitly include a watch
 580  * for hangups, errors, and other exceptional conditions.
 581  *
 582  * @param watch the DBusWatch object.
 583  * @returns the conditions to watch.
 584  */
 585 unsigned int
 586 dbus_watch_get_flags (DBusWatch *watch)
 587 {
 588   _dbus_return_val_if_fail (watch != NULL, 0);
 589   _dbus_assert ((watch->flags & VALID_WATCH_FLAGS) == watch->flags);
 590
 591   return watch->flags;
 592 }
 593
 594 /**
 595  * Gets data previously set with dbus_watch_set_data()
 596  * or #NULL if none.
 597  *
 598  * @param watch the DBusWatch object.
 599  * @returns previously-set data.
 600  */
 601 void*
 602 dbus_watch_get_data (DBusWatch *watch)
 603 {
 604   _dbus_return_val_if_fail (watch != NULL, NULL);
 605
 606   return watch->data;
 607 }
 608
 609 /**
 610  * Sets data which can be retrieved with dbus_watch_get_data().
 611  * Intended for use by the DBusAddWatchFunction and
 612  * DBusRemoveWatchFunction to store their own data.  For example with
 613  * Qt you might store the QSocketNotifier for this watch and with GLib
 614  * you might store a GSource.
 615  *
 616  * @param watch the DBusWatch object.
 617  * @param data the data.
 618  * @param free_data_function function to be called to free the data.
 619  */
 620 void
 621 dbus_watch_set_data (DBusWatch        *watch,
 622                      void             *data,
 623                      DBusFreeFunction  free_data_function)
 624 {
 625   _dbus_return_if_fail (watch != NULL);
 626
 627   _dbus_verbose ("Setting watch fd %d data to data = %p function = %p from data = %p function = %p\n",
 628                  dbus_watch_get_socket (watch),
 629                  data, free_data_function, watch->data, watch->free_data_function);
 630
 631   if (watch->free_data_function != NULL)
 632     (* watch->free_data_function) (watch->data);
 633
 634   watch->data = data;
 635   watch->free_data_function = free_data_function;
 636 }
 637
 638 /**
 639  * Returns whether a watch is enabled or not. If not
 640  * enabled, it should not be polled by the main loop.
 641  *
 642  * @param watch the DBusWatch object
 643  * @returns #TRUE if the watch is enabled
 644  */
 645 dbus_bool_t
 646 dbus_watch_get_enabled (DBusWatch *watch)
 647 {
 648   _dbus_return_val_if_fail (watch != NULL, FALSE);
 649
 650   return watch->enabled;
 651 }
 652
 653
 654 /**
 655  * Called to notify the D-Bus library when a previously-added watch is
 656  * ready for reading or writing, or has an exception such as a hangup.
 657  *
 658  * If this function returns #FALSE, then the file descriptor may still
 659  * be ready for reading or writing, but more memory is needed in order
 660  * to do the reading or writing. If you ignore the #FALSE return, your
 661  * application may spin in a busy loop on the file descriptor until
 662  * memory becomes available, but nothing more catastrophic should
 663  * happen.
 664  *
 665  * dbus_watch_handle() cannot be called during the
 666  * DBusAddWatchFunction, as the connection will not be ready to handle
 667  * that watch yet.
 668  *
 669  * It is not allowed to reference a DBusWatch after it has been passed
 670  * to remove_function.
 671  *
 672  * @param watch the DBusWatch object.
 673  * @param flags the poll condition using #DBusWatchFlags values
 674  * @returns #FALSE if there wasn't enough memory
 675  */
 676 dbus_bool_t
 677 dbus_watch_handle (DBusWatch    *watch,
 678                    unsigned int  flags)
 679 {
 680   _dbus_return_val_if_fail (watch != NULL, FALSE);
 681
 682 #ifndef DBUS_DISABLE_CHECKS
 683   if (watch->fd < 0 || watch->flags == 0)
 684     {
 685       _dbus_warn_check_failed ("Watch is invalid, it should have been removed\n");
 686       return TRUE;
 687     }
 688 #endif
 689
 690   _dbus_return_val_if_fail (watch->fd >= 0 /* fails if watch was removed */, TRUE);
 691
 692   _dbus_watch_sanitize_condition (watch, &flags);
 693
 694   if (flags == 0)
 695     {
 696       _dbus_verbose ("After sanitization, watch flags on fd %d were 0\n",
 697                      watch->fd);
 698       return TRUE;
 699     }
 700   else
 701     return (* watch->handler) (watch, flags,
 702                                watch->handler_data);
 703 }
 704
 705
 706 /** @} */