dbus/dbus-resources.c

   1 /* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
   2 /* dbus-resources.c Resource tracking/limits
   3  *
   4  * Copyright (C) 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/dbus-resources.h>
  26 #include <dbus/dbus-internals.h>
  27
  28 /**
  29  * @defgroup DBusResources Resource limits related code
  30  * @ingroup  DBusInternals
  31  * @brief DBusCounter and other stuff related to resource limits
  32  *
  33  * Types and functions related to tracking resource limits,
  34  * such as the maximum amount of memory/unix fds a connection can use
  35  * for messages, etc.
  36  */
  37
  38 /**
  39  * @defgroup DBusResourcesInternals Resource limits implementation details
  40  * @ingroup  DBusInternals
  41  * @brief Resource limits implementation details
  42  *
  43  * Implementation details of resource limits code.
  44  *
  45  * @{
  46  */
  47
  48 /**
  49  * @brief Internals of DBusCounter.
  50  *
  51  * DBusCounter internals. DBusCounter is an opaque object, it must be
  52  * used via accessor functions.
  53  */
  54 struct DBusCounter
  55 {
  56   int refcount;  /**< reference count */
  57
  58   long size_value;       /**< current size counter value */
  59   long unix_fd_value;    /**< current unix fd counter value */
  60
  61 #ifdef DBUS_ENABLE_STATS
  62   long peak_size_value;     /**< largest ever size counter value */
  63   long peak_unix_fd_value;  /**< largest ever unix fd counter value */
  64 #endif
  65
  66   long notify_size_guard_value;    /**< call notify function when crossing this size value */
  67   long notify_unix_fd_guard_value; /**< call notify function when crossing this unix fd value */
  68
  69   DBusCounterNotifyFunction notify_function; /**< notify function */
  70   void *notify_data; /**< data for notify function */
  71 };
  72
  73 /** @} */  /* end of resource limits internals docs */
  74
  75 /**
  76  * @addtogroup DBusResources
  77  * @{
  78  */
  79
  80 /**
  81  * Creates a new DBusCounter. DBusCounter is used
  82  * to count usage of some resource such as memory.
  83  *
  84  * @returns new counter or #NULL on failure
  85  */
  86 DBusCounter*
  87 _dbus_counter_new (void)
  88 {
  89   DBusCounter *counter;
  90
  91   counter = dbus_new (DBusCounter, 1);
  92   if (counter == NULL)
  93     return NULL;
  94
  95   counter->refcount = 1;
  96   counter->size_value = 0;
  97   counter->unix_fd_value = 0;
  98
  99 #ifdef DBUS_ENABLE_STATS
 100   counter->peak_size_value = 0;
 101   counter->peak_unix_fd_value = 0;
 102 #endif
 103
 104   counter->notify_size_guard_value = 0;
 105   counter->notify_unix_fd_guard_value = 0;
 106   counter->notify_function = NULL;
 107   counter->notify_data = NULL;
 108
 109   return counter;
 110 }
 111
 112 /**
 113  * Increments refcount of the counter
 114  *
 115  * @param counter the counter
 116  * @returns the counter
 117  */
 118 DBusCounter *
 119 _dbus_counter_ref (DBusCounter *counter)
 120 {
 121   _dbus_assert (counter->refcount > 0);
 122
 123   counter->refcount += 1;
 124
 125   return counter;
 126 }
 127
 128 /**
 129  * Decrements refcount of the counter and possibly
 130  * finalizes the counter.
 131  *
 132  * @param counter the counter
 133  */
 134 void
 135 _dbus_counter_unref (DBusCounter *counter)
 136 {
 137   _dbus_assert (counter->refcount > 0);
 138
 139   counter->refcount -= 1;
 140
 141   if (counter->refcount == 0)
 142     {
 143
 144       dbus_free (counter);
 145     }
 146 }
 147
 148 /**
 149  * Adjusts the value of the size counter by the given
 150  * delta which may be positive or negative.
 151  * Calls the notify function from _dbus_counter_set_notify()
 152  * if that function has been specified.
 153  *
 154  * @param counter the counter
 155  * @param delta value to add to the size counter's current value
 156  */
 157 void
 158 _dbus_counter_adjust_size (DBusCounter *counter,
 159                            long         delta)
 160 {
 161   long old = counter->size_value;
 162
 163   counter->size_value += delta;
 164
 165 #ifdef DBUS_ENABLE_STATS
 166   if (counter->peak_size_value < counter->size_value)
 167     counter->peak_size_value = counter->size_value;
 168 #endif
 169
 170 #if 0
 171   _dbus_verbose ("Adjusting counter %ld by %ld = %ld\n",
 172                  old, delta, counter->size_value);
 173 #endif
 174
 175   if (counter->notify_function != NULL &&
 176       ((old < counter->notify_size_guard_value &&
 177         counter->size_value >= counter->notify_size_guard_value) ||
 178        (old >= counter->notify_size_guard_value &&
 179         counter->size_value < counter->notify_size_guard_value)))
 180     (* counter->notify_function) (counter, counter->notify_data);
 181 }
 182
 183 /**
 184  * Adjusts the value of the unix fd counter by the given
 185  * delta which may be positive or negative.
 186  * Calls the notify function from _dbus_counter_set_notify()
 187  * if that function has been specified.
 188  *
 189  * @param counter the counter
 190  * @param delta value to add to the unix fds counter's current value
 191  */
 192 void
 193 _dbus_counter_adjust_unix_fd (DBusCounter *counter,
 194                               long         delta)
 195 {
 196   long old = counter->unix_fd_value;
 197
 198   counter->unix_fd_value += delta;
 199
 200 #ifdef DBUS_ENABLE_STATS
 201   if (counter->peak_unix_fd_value < counter->unix_fd_value)
 202     counter->peak_unix_fd_value = counter->unix_fd_value;
 203 #endif
 204
 205 #if 0
 206   _dbus_verbose ("Adjusting counter %ld by %ld = %ld\n",
 207                  old, delta, counter->unix_fd_value);
 208 #endif
 209
 210   if (counter->notify_function != NULL &&
 211       ((old < counter->notify_unix_fd_guard_value &&
 212         counter->unix_fd_value >= counter->notify_unix_fd_guard_value) ||
 213        (old >= counter->notify_unix_fd_guard_value &&
 214         counter->unix_fd_value < counter->notify_unix_fd_guard_value)))
 215     (* counter->notify_function) (counter, counter->notify_data);
 216 }
 217
 218 /**
 219  * Gets the current value of the size counter.
 220  *
 221  * @param counter the counter
 222  * @returns its current size value
 223  */
 224 long
 225 _dbus_counter_get_size_value (DBusCounter *counter)
 226 {
 227   return counter->size_value;
 228 }
 229
 230 /**
 231  * Gets the current value of the unix fd counter.
 232  *
 233  * @param counter the counter
 234  * @returns its current unix fd value
 235  */
 236 long
 237 _dbus_counter_get_unix_fd_value (DBusCounter *counter)
 238 {
 239   return counter->unix_fd_value;
 240 }
 241
 242 /**
 243  * Sets the notify function for this counter; the notify function is
 244  * called whenever the counter's values cross the guard values in
 245  * either direction (moving up, or moving down).
 246  *
 247  * @param counter the counter
 248  * @param size_guard_value the value we're notified if the size counter crosses
 249  * @param unix_fd_guard_value the value we're notified if the unix fd counter crosses
 250  * @param function function to call in order to notify
 251  * @param user_data data to pass to the function
 252  */
 253 void
 254 _dbus_counter_set_notify (DBusCounter               *counter,
 255                           long                       size_guard_value,
 256                           long                       unix_fd_guard_value,
 257                           DBusCounterNotifyFunction  function,
 258                           void                      *user_data)
 259 {
 260   counter->notify_size_guard_value = size_guard_value;
 261   counter->notify_unix_fd_guard_value = unix_fd_guard_value;
 262   counter->notify_function = function;
 263   counter->notify_data = user_data;
 264 }
 265
 266 #ifdef DBUS_ENABLE_STATS
 267 long
 268 _dbus_counter_get_peak_size_value (DBusCounter *counter)
 269 {
 270   return counter->peak_size_value;
 271 }
 272
 273 long
 274 _dbus_counter_get_peak_unix_fd_value (DBusCounter *counter)
 275 {
 276   return counter->peak_unix_fd_value;
 277 }
 278 #endif
 279
 280 /** @} */  /* end of resource limits exported API */