expirelist.c 10.1 KB
Newer Older
1
/* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
Havoc Pennington's avatar
Havoc Pennington committed
2 3 4 5
/* expirelist.c  List of items that expire
 *
 * Copyright (C) 2003  Red Hat, Inc.
 *
6
 * Licensed under the Academic Free License version 2.1
Havoc Pennington's avatar
Havoc Pennington committed
7 8 9 10 11 12 13 14 15 16 17 18 19
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
20
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
Havoc Pennington's avatar
Havoc Pennington committed
21 22 23
 *
 */

24
#include <config.h>
Havoc Pennington's avatar
Havoc Pennington committed
25 26 27 28 29 30
#include "expirelist.h"
#include "test.h"
#include <dbus/dbus-internals.h>
#include <dbus/dbus-mainloop.h>
#include <dbus/dbus-timeout.h>

31 32 33 34 35 36 37 38 39 40
struct BusExpireList
{
  DBusList      *items; /**< List of BusExpireItem */
  DBusTimeout   *timeout;
  DBusLoop      *loop;
  BusExpireFunc  expire_func;
  void          *data;
  int            expire_after; /**< Expire after milliseconds (thousandths) */
};

Havoc Pennington's avatar
Havoc Pennington committed
41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67
static dbus_bool_t expire_timeout_handler (void *data);

BusExpireList*
bus_expire_list_new (DBusLoop      *loop,
                     int            expire_after,
                     BusExpireFunc  expire_func,
                     void          *data)
{
  BusExpireList *list;

  list = dbus_new0 (BusExpireList, 1);
  if (list == NULL)
    return NULL;

  list->expire_func = expire_func;
  list->data = data;
  list->loop = loop;
  list->expire_after = expire_after;

  list->timeout = _dbus_timeout_new (100, /* irrelevant */
                                     expire_timeout_handler,
                                     list, NULL);
  if (list->timeout == NULL)
    goto failed;

  _dbus_timeout_set_enabled (list->timeout, FALSE);

68
  if (!_dbus_loop_add_timeout (list->loop, list->timeout))
Havoc Pennington's avatar
Havoc Pennington committed
69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86
    goto failed;

  return list;

 failed:
  if (list->timeout)
    _dbus_timeout_unref (list->timeout);

  dbus_free (list);

  return NULL;
}

void
bus_expire_list_free (BusExpireList *list)
{
  _dbus_assert (list->items == NULL);

87
  _dbus_loop_remove_timeout (list->loop, list->timeout);
Havoc Pennington's avatar
Havoc Pennington committed
88 89 90 91 92 93 94

  _dbus_timeout_unref (list->timeout);

  dbus_free (list);
}

void
95 96
bus_expire_timeout_set_interval (DBusTimeout   *timeout,
                                 int            next_interval)
Havoc Pennington's avatar
Havoc Pennington committed
97 98 99 100 101 102 103
{
  if (next_interval >= 0)
    {
      _dbus_timeout_set_interval (timeout,
                                  next_interval);
      _dbus_timeout_set_enabled (timeout, TRUE);

104
      _dbus_verbose ("Enabled an expire timeout with interval %d\n",
Havoc Pennington's avatar
Havoc Pennington committed
105 106 107 108 109 110
                     next_interval);
    }
  else if (dbus_timeout_get_enabled (timeout))
    {
      _dbus_timeout_set_enabled (timeout, FALSE);

111
      _dbus_verbose ("Disabled an expire timeout\n");
Havoc Pennington's avatar
Havoc Pennington committed
112 113
    }
  else
114 115 116 117 118 119 120 121 122
    _dbus_verbose ("No need to disable this expire timeout\n");
}

void
bus_expire_list_recheck_immediately (BusExpireList *list)
{
  _dbus_verbose ("setting interval on expire list to 0 for immediate recheck\n");

  bus_expire_timeout_set_interval (list->timeout, 0);
Havoc Pennington's avatar
Havoc Pennington committed
123 124 125
}

static int
126 127 128
do_expiration_with_monotonic_time (BusExpireList *list,
                                   long           tv_sec,
                                   long           tv_usec)
Havoc Pennington's avatar
Havoc Pennington committed
129 130
{
  DBusList *link;
131
  int next_interval, min_wait_time, items_to_expire;
Havoc Pennington's avatar
Havoc Pennington committed
132 133

  next_interval = -1;
134 135
  min_wait_time = 3600 * 1000; /* this is reset anyway if used */
  items_to_expire = 0;
Havoc Pennington's avatar
Havoc Pennington committed
136 137 138 139 140 141 142 143 144 145 146 147 148 149
  
  link = _dbus_list_get_first_link (&list->items);
  while (link != NULL)
    {
      DBusList *next = _dbus_list_get_next_link (&list->items, link);
      double elapsed;
      BusExpireItem *item;

      item = link->data;

      elapsed = ELAPSED_MILLISECONDS_SINCE (item->added_tv_sec,
                                            item->added_tv_usec,
                                            tv_sec, tv_usec);

150
      if (((item->added_tv_sec == 0) && (item->added_tv_usec == 0)) ||
151
          ((list->expire_after > 0) && (elapsed >= (double) list->expire_after)))
Havoc Pennington's avatar
Havoc Pennington committed
152 153
        {
          _dbus_verbose ("Expiring an item %p\n", item);
154 155

          /* If the expire function fails, we just end up expiring
156 157 158 159
           * this item next time we walk through the list. This would
           * be an indeterminate time normally, so we set up the
           * next_interval to be "shortly" (just enough to avoid
           * a busy loop)
160
           */
161 162 163 164 165
          if (!(* list->expire_func) (list, link, list->data))
            {
              next_interval = _dbus_get_oom_wait ();
              break;
            }
Havoc Pennington's avatar
Havoc Pennington committed
166
        }
167
      else if (list->expire_after > 0)
Havoc Pennington's avatar
Havoc Pennington committed
168
        {
169
          double to_wait;
Havoc Pennington's avatar
Havoc Pennington committed
170

171 172 173 174
          items_to_expire = 1;
          to_wait = (double) list->expire_after - elapsed;
          if (min_wait_time > to_wait)
            min_wait_time = to_wait;
Havoc Pennington's avatar
Havoc Pennington committed
175 176 177 178 179
        }

      link = next;
    }

180 181 182
  if (next_interval < 0 && items_to_expire)
    next_interval = min_wait_time;

Havoc Pennington's avatar
Havoc Pennington committed
183 184 185 186 187 188 189 190 191 192 193 194 195 196
  return next_interval;
}

static void
bus_expirelist_expire (BusExpireList *list)
{
  int next_interval;

  next_interval = -1;

  if (list->items != NULL)
    {
      long tv_sec, tv_usec;

197
      _dbus_get_monotonic_time (&tv_sec, &tv_usec);
Havoc Pennington's avatar
Havoc Pennington committed
198

199
      next_interval = do_expiration_with_monotonic_time (list, tv_sec, tv_usec);
Havoc Pennington's avatar
Havoc Pennington committed
200 201 202 203 204 205 206 207 208 209
    }

  bus_expire_timeout_set_interval (list->timeout, next_interval);
}

static dbus_bool_t
expire_timeout_handler (void *data)
{
  BusExpireList *list = data;

210
  _dbus_verbose ("Running\n");
Havoc Pennington's avatar
Havoc Pennington committed
211 212 213 214 215 216 217

  /* note that this may remove the timeout */
  bus_expirelist_expire (list);

  return TRUE;
}

218 219 220 221
void
bus_expire_list_remove_link (BusExpireList *list,
                             DBusList      *link)
{
222
  _dbus_list_remove_link (&list->items, link);
223 224 225 226 227 228
}

dbus_bool_t
bus_expire_list_remove (BusExpireList *list,
                        BusExpireItem *item)
{
229
  return _dbus_list_remove (&list->items, item);
230 231 232 233 234 235 236 237 238 239 240 241 242
}

void
bus_expire_list_unlink (BusExpireList *list,
                        DBusList      *link)
{
  _dbus_list_unlink (&list->items, link);
}

dbus_bool_t
bus_expire_list_add (BusExpireList *list,
                     BusExpireItem *item)
{
243 244 245 246 247 248 249
  dbus_bool_t ret;

  ret = _dbus_list_prepend (&list->items, item);
  if (ret && !dbus_timeout_get_enabled (list->timeout))
    bus_expire_timeout_set_interval (list->timeout, 0);

  return ret;
250 251 252 253 254 255 256 257
}

void
bus_expire_list_add_link (BusExpireList *list,
                          DBusList      *link)
{
  _dbus_assert (link->data != NULL);
  
258 259 260 261
  _dbus_list_prepend_link (&list->items, link);

  if (!dbus_timeout_get_enabled (list->timeout))
    bus_expire_timeout_set_interval (list->timeout, 0);
262 263 264 265 266 267 268 269 270 271 272 273
}

DBusList*
bus_expire_list_get_first_link (BusExpireList *list)
{
  return _dbus_list_get_first_link (&list->items);
}

DBusList*
bus_expire_list_get_next_link (BusExpireList *list,
                               DBusList      *link)
{
274
  return _dbus_list_get_next_link (&list->items, link);
275 276 277 278 279 280 281 282 283
}

dbus_bool_t
bus_expire_list_contains_item (BusExpireList *list,
                               BusExpireItem *item)
{
  return _dbus_list_find_last (&list->items, item) != NULL;
}

284
#ifdef DBUS_ENABLE_EMBEDDED_TESTS
Havoc Pennington's avatar
Havoc Pennington committed
285 286 287 288 289 290 291

typedef struct
{
  BusExpireItem item;
  int expire_count;
} TestExpireItem;

292
static dbus_bool_t
Havoc Pennington's avatar
Havoc Pennington committed
293
test_expire_func (BusExpireList *list,
294
                  DBusList      *link,
Havoc Pennington's avatar
Havoc Pennington committed
295 296 297 298
                  void          *data)
{
  TestExpireItem *t;

299
  t = (TestExpireItem*) link->data;
Havoc Pennington's avatar
Havoc Pennington committed
300 301

  t->expire_count += 1;
302 303

  return TRUE;
Havoc Pennington's avatar
Havoc Pennington committed
304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330
}

static void
time_add_milliseconds (long *tv_sec,
                       long *tv_usec,
                       int   milliseconds)
{
  *tv_sec = *tv_sec + milliseconds / 1000;
  *tv_usec = *tv_usec + milliseconds * 1000;
  if (*tv_usec >= 1000000)
    {
      *tv_usec -= 1000000;
      *tv_sec += 1;
    }
}

dbus_bool_t
bus_expire_list_test (const DBusString *test_data_dir)
{
  DBusLoop *loop;
  BusExpireList *list;
  long tv_sec, tv_usec;
  long tv_sec_not_expired, tv_usec_not_expired;
  long tv_sec_expired, tv_usec_expired;
  long tv_sec_past, tv_usec_past;
  TestExpireItem *item;
  int next_interval;
331 332 333
  dbus_bool_t result = FALSE;


Havoc Pennington's avatar
Havoc Pennington committed
334 335 336 337 338 339 340 341 342
  loop = _dbus_loop_new ();
  _dbus_assert (loop != NULL);

#define EXPIRE_AFTER 100
  
  list = bus_expire_list_new (loop, EXPIRE_AFTER,
                              test_expire_func, NULL);
  _dbus_assert (list != NULL);

343
  _dbus_get_monotonic_time (&tv_sec, &tv_usec);
Havoc Pennington's avatar
Havoc Pennington committed
344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360

  tv_sec_not_expired = tv_sec;
  tv_usec_not_expired = tv_usec;
  time_add_milliseconds (&tv_sec_not_expired,
                         &tv_usec_not_expired, EXPIRE_AFTER - 1);

  tv_sec_expired = tv_sec;
  tv_usec_expired = tv_usec;
  time_add_milliseconds (&tv_sec_expired,
                         &tv_usec_expired, EXPIRE_AFTER);
  

  tv_sec_past = tv_sec - 1;
  tv_usec_past = tv_usec;

  item = dbus_new0 (TestExpireItem, 1);

361 362 363
  if (item == NULL)
    goto oom;

Havoc Pennington's avatar
Havoc Pennington committed
364 365
  item->item.added_tv_sec = tv_sec;
  item->item.added_tv_usec = tv_usec;
366
  if (!bus_expire_list_add (list, &item->item))
Havoc Pennington's avatar
Havoc Pennington committed
367 368 369
    _dbus_assert_not_reached ("out of memory");

  next_interval =
370 371
    do_expiration_with_monotonic_time (list, tv_sec_not_expired,
                                       tv_usec_not_expired);
Havoc Pennington's avatar
Havoc Pennington committed
372 373 374 375 376
  _dbus_assert (item->expire_count == 0);
  _dbus_verbose ("next_interval = %d\n", next_interval);
  _dbus_assert (next_interval == 1);
  
  next_interval =
377 378
    do_expiration_with_monotonic_time (list, tv_sec_expired,
                                       tv_usec_expired);
Havoc Pennington's avatar
Havoc Pennington committed
379 380 381 382 383
  _dbus_assert (item->expire_count == 1);
  _dbus_verbose ("next_interval = %d\n", next_interval);
  _dbus_assert (next_interval == -1);

  next_interval =
384 385
    do_expiration_with_monotonic_time (list, tv_sec_past,
                                       tv_usec_past);
Havoc Pennington's avatar
Havoc Pennington committed
386 387 388 389
  _dbus_assert (item->expire_count == 1);
  _dbus_verbose ("next_interval = %d\n", next_interval);
  _dbus_assert (next_interval == 1000 + EXPIRE_AFTER);

390
  bus_expire_list_remove (list, &item->item);
Havoc Pennington's avatar
Havoc Pennington committed
391 392 393 394 395
  dbus_free (item);
  
  bus_expire_list_free (list);
  _dbus_loop_unref (loop);
  
396 397 398 399
  result = TRUE;

 oom:
  return result;
Havoc Pennington's avatar
Havoc Pennington committed
400 401
}

402
#endif /* DBUS_ENABLE_EMBEDDED_TESTS */