dbus/dbus-watch.c

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