dbus/dbus-resources.c

   1 /* -*- mode: C; c-file-style: "gnu" -*- */
   2 /* dbus-resources.c Resource tracking/limits
   3  *
   4  * Copyright (C) 2003  Red Hat Inc.
   5  *
   6  * Licensed under the Academic Free License version 1.2
   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 #include <dbus/dbus-resources.h>
  24 #include <dbus/dbus-internals.h>
  25
  26 /**
  27  * @defgroup DBusResources Resource limits related code
  28  * @ingroup  DBusInternals
  29  * @brief DBusCounter and other stuff related to resource limits
  30  *
  31  * Types and functions related to tracking resource limits,
  32  * such as the maximum amount of memory a connection can use
  33  * for messages, etc.
  34  */
  35
  36 /**
  37  * @defgroup DBusResourcesInternals Resource limits implementation details
  38  * @ingroup  DBusInternals
  39  * @brief Resource limits implementation details
  40  *
  41  * Implementation details of resource limits code.
  42  *
  43  * @{
  44  */
  45
  46 /**
  47  * @brief Internals of DBusCounter.
  48  *
  49  * DBusCounter internals. DBusCounter is an opaque object, it must be
  50  * used via accessor functions.
  51  */
  52 struct DBusCounter
  53 {
  54   int refcount;  /**< reference count */
  55
  56   long value;    /**< current counter value */
  57
  58   long notify_guard_value; /**< call notify function when crossing this value */
  59   DBusCounterNotifyFunction notify_function; /**< notify function */
  60   void *notify_data; /**< data for notify function */
  61 };
  62
  63 /** @} */  /* end of resource limits internals docs */
  64
  65 /**
  66  * @addtogroup DBusResources
  67  * @{
  68  */
  69
  70 /**
  71  * Creates a new DBusCounter. DBusCounter is used
  72  * to count usage of some resource such as memory.
  73  *
  74  * @returns new counter or #NULL on failure
  75  */
  76 DBusCounter*
  77 _dbus_counter_new (void)
  78 {
  79   DBusCounter *counter;
  80
  81   counter = dbus_new (DBusCounter, 1);
  82   if (counter == NULL)
  83     return NULL;
  84
  85   counter->refcount = 1;
  86   counter->value = 0;
  87
  88   counter->notify_guard_value = 0;
  89   counter->notify_function = NULL;
  90   counter->notify_data = NULL;
  91
  92   return counter;
  93 }
  94
  95 /**
  96  * Increments refcount of the counter
  97  *
  98  * @param counter the counter
  99  */
 100 void
 101 _dbus_counter_ref (DBusCounter *counter)
 102 {
 103   _dbus_assert (counter->refcount > 0);
 104
 105   counter->refcount += 1;
 106 }
 107
 108 /**
 109  * Decrements refcount of the counter and possibly
 110  * finalizes the counter.
 111  *
 112  * @param counter the counter
 113  */
 114 void
 115 _dbus_counter_unref (DBusCounter *counter)
 116 {
 117   _dbus_assert (counter->refcount > 0);
 118
 119   counter->refcount -= 1;
 120
 121   if (counter->refcount == 0)
 122     {
 123
 124       dbus_free (counter);
 125     }
 126 }
 127
 128 /**
 129  * Adjusts the value of the counter by the given
 130  * delta which may be positive or negative.
 131  * Calls the notify function from _dbus_counter_set_notify()
 132  * if that function has been specified.
 133  *
 134  * @param counter the counter
 135  * @param delta value to add to the counter's current value
 136  */
 137 void
 138 _dbus_counter_adjust (DBusCounter *counter,
 139                       long         delta)
 140 {
 141   long old = counter->value;
 142
 143   counter->value += delta;
 144
 145 #if 0
 146   _dbus_verbose ("Adjusting counter %ld by %ld = %ld\n",
 147                  old, delta, counter->value);
 148 #endif
 149
 150   if (counter->notify_function != NULL &&
 151       ((old < counter->notify_guard_value &&
 152         counter->value >= counter->notify_guard_value) ||
 153        (old >= counter->notify_guard_value &&
 154         counter->value < counter->notify_guard_value)))
 155     (* counter->notify_function) (counter, counter->notify_data);
 156 }
 157
 158 /**
 159  * Gets the current value of the counter.
 160  *
 161  * @param counter the counter
 162  * @returns its current value
 163  */
 164 long
 165 _dbus_counter_get_value (DBusCounter *counter)
 166 {
 167   return counter->value;
 168 }
 169
 170 /**
 171  * Sets the notify function for this counter; the notify function is
 172  * called whenever the counter's value crosses the guard value in
 173  * either direction (moving up, or moving down).
 174  *
 175  * @param counter the counter
 176  * @param guard_value the value we're notified if the counter crosses
 177  * @param function function to call in order to notify
 178  * @param user_data data to pass to the function
 179  */
 180 void
 181 _dbus_counter_set_notify (DBusCounter               *counter,
 182                           long                       guard_value,
 183                           DBusCounterNotifyFunction  function,
 184                           void                      *user_data)
 185 {
 186   counter->notify_guard_value = guard_value;
 187   counter->notify_function = function;
 188   counter->notify_data = user_data;
 189 }
 190
 191 /** @} */  /* end of resource limits exported API */