1 /* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
2 /* expirelist.c List of items that expire
4 * Copyright (C) 2003 Red Hat, Inc.
6 * Licensed under the Academic Free License version 2.1
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.
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.
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
25 #include "expirelist.h"
27 #include <dbus/dbus-internals.h>
28 #include <dbus/dbus-mainloop.h>
29 #include <dbus/dbus-timeout.h>
33 DBusList *items; /**< List of BusExpireItem */
36 BusExpireFunc expire_func;
38 int expire_after; /**< Expire after milliseconds (thousandths) */
41 static dbus_bool_t expire_timeout_handler (void *data);
44 bus_expire_list_new (DBusLoop *loop,
46 BusExpireFunc expire_func,
51 list = dbus_new0 (BusExpireList, 1);
55 list->expire_func = expire_func;
58 list->expire_after = expire_after;
60 list->timeout = _dbus_timeout_new (100, /* irrelevant */
61 expire_timeout_handler,
63 if (list->timeout == NULL)
66 _dbus_timeout_disable (list->timeout);
68 if (!_dbus_loop_add_timeout (list->loop, list->timeout))
75 _dbus_timeout_unref (list->timeout);
83 bus_expire_list_free (BusExpireList *list)
85 _dbus_assert (list->items == NULL);
87 _dbus_loop_remove_timeout (list->loop, list->timeout);
89 _dbus_timeout_unref (list->timeout);
95 bus_expire_timeout_set_interval (DBusTimeout *timeout,
98 if (next_interval >= 0)
100 _dbus_timeout_restart (timeout, next_interval);
102 _dbus_verbose ("Enabled an expire timeout with interval %d\n",
105 else if (dbus_timeout_get_enabled (timeout))
107 _dbus_timeout_disable (timeout);
109 _dbus_verbose ("Disabled an expire timeout\n");
112 _dbus_verbose ("No need to disable this expire timeout\n");
116 bus_expire_list_recheck_immediately (BusExpireList *list)
118 _dbus_verbose ("setting interval on expire list to 0 for immediate recheck\n");
120 bus_expire_timeout_set_interval (list->timeout, 0);
124 do_expiration_with_monotonic_time (BusExpireList *list,
129 int next_interval, min_wait_time, items_to_expire;
132 min_wait_time = 3600 * 1000; /* this is reset anyway if used */
135 link = _dbus_list_get_first_link (&list->items);
138 DBusList *next = _dbus_list_get_next_link (&list->items, link);
144 elapsed = ELAPSED_MILLISECONDS_SINCE (item->added_tv_sec,
148 if (((item->added_tv_sec == 0) && (item->added_tv_usec == 0)) ||
149 ((list->expire_after > 0) && (elapsed >= (double) list->expire_after)))
151 _dbus_verbose ("Expiring an item %p\n", item);
153 /* If the expire function fails, we just end up expiring
154 * this item next time we walk through the list. This would
155 * be an indeterminate time normally, so we set up the
156 * next_interval to be "shortly" (just enough to avoid
159 if (!(* list->expire_func) (list, link, list->data))
161 next_interval = _dbus_get_oom_wait ();
165 else if (list->expire_after > 0)
170 to_wait = (double) list->expire_after - elapsed;
171 if (min_wait_time > to_wait)
172 min_wait_time = to_wait;
178 if (next_interval < 0 && items_to_expire)
179 next_interval = min_wait_time;
181 return next_interval;
185 bus_expirelist_expire (BusExpireList *list)
191 if (list->items != NULL)
193 long tv_sec, tv_usec;
195 _dbus_get_monotonic_time (&tv_sec, &tv_usec);
197 next_interval = do_expiration_with_monotonic_time (list, tv_sec, tv_usec);
200 bus_expire_timeout_set_interval (list->timeout, next_interval);
204 expire_timeout_handler (void *data)
206 BusExpireList *list = data;
208 _dbus_verbose ("Running\n");
210 /* note that this may remove the timeout */
211 bus_expirelist_expire (list);
217 bus_expire_list_remove_link (BusExpireList *list,
220 _dbus_list_remove_link (&list->items, link);
224 bus_expire_list_remove (BusExpireList *list,
227 return _dbus_list_remove (&list->items, item);
231 bus_expire_list_unlink (BusExpireList *list,
234 _dbus_list_unlink (&list->items, link);
238 bus_expire_list_add (BusExpireList *list,
243 ret = _dbus_list_prepend (&list->items, item);
244 if (ret && !dbus_timeout_get_enabled (list->timeout))
245 bus_expire_timeout_set_interval (list->timeout, 0);
251 bus_expire_list_add_link (BusExpireList *list,
254 _dbus_assert (link->data != NULL);
256 _dbus_list_prepend_link (&list->items, link);
258 if (!dbus_timeout_get_enabled (list->timeout))
259 bus_expire_timeout_set_interval (list->timeout, 0);
263 bus_expire_list_get_first_link (BusExpireList *list)
265 return _dbus_list_get_first_link (&list->items);
269 bus_expire_list_get_next_link (BusExpireList *list,
272 return _dbus_list_get_next_link (&list->items, link);
276 bus_expire_list_contains_item (BusExpireList *list,
279 return _dbus_list_find_last (&list->items, item) != NULL;
282 #ifdef DBUS_ENABLE_EMBEDDED_TESTS
291 test_expire_func (BusExpireList *list,
297 t = (TestExpireItem*) link->data;
299 t->expire_count += 1;
305 time_add_milliseconds (long *tv_sec,
309 *tv_sec = *tv_sec + milliseconds / 1000;
310 *tv_usec = *tv_usec + milliseconds * 1000;
311 if (*tv_usec >= 1000000)
319 bus_expire_list_test (const DBusString *test_data_dir)
323 long tv_sec, tv_usec;
324 long tv_sec_not_expired, tv_usec_not_expired;
325 long tv_sec_expired, tv_usec_expired;
326 long tv_sec_past, tv_usec_past;
327 TestExpireItem *item;
329 dbus_bool_t result = FALSE;
332 loop = _dbus_loop_new ();
333 _dbus_assert (loop != NULL);
335 #define EXPIRE_AFTER 100
337 list = bus_expire_list_new (loop, EXPIRE_AFTER,
338 test_expire_func, NULL);
339 _dbus_assert (list != NULL);
341 _dbus_get_monotonic_time (&tv_sec, &tv_usec);
343 tv_sec_not_expired = tv_sec;
344 tv_usec_not_expired = tv_usec;
345 time_add_milliseconds (&tv_sec_not_expired,
346 &tv_usec_not_expired, EXPIRE_AFTER - 1);
348 tv_sec_expired = tv_sec;
349 tv_usec_expired = tv_usec;
350 time_add_milliseconds (&tv_sec_expired,
351 &tv_usec_expired, EXPIRE_AFTER);
354 tv_sec_past = tv_sec - 1;
355 tv_usec_past = tv_usec;
357 item = dbus_new0 (TestExpireItem, 1);
362 item->item.added_tv_sec = tv_sec;
363 item->item.added_tv_usec = tv_usec;
364 if (!bus_expire_list_add (list, &item->item))
365 _dbus_assert_not_reached ("out of memory");
368 do_expiration_with_monotonic_time (list, tv_sec_not_expired,
369 tv_usec_not_expired);
370 _dbus_assert (item->expire_count == 0);
371 _dbus_verbose ("next_interval = %d\n", next_interval);
372 _dbus_assert (next_interval == 1);
375 do_expiration_with_monotonic_time (list, tv_sec_expired,
377 _dbus_assert (item->expire_count == 1);
378 _dbus_verbose ("next_interval = %d\n", next_interval);
379 _dbus_assert (next_interval == -1);
382 do_expiration_with_monotonic_time (list, tv_sec_past,
384 _dbus_assert (item->expire_count == 1);
385 _dbus_verbose ("next_interval = %d\n", next_interval);
386 _dbus_assert (next_interval == 1000 + EXPIRE_AFTER);
388 bus_expire_list_remove (list, &item->item);
391 bus_expire_list_free (list);
392 _dbus_loop_unref (loop);
400 #endif /* DBUS_ENABLE_EMBEDDED_TESTS */