sl@0: /* -*- mode: C; c-file-style: "gnu" -*- */
sl@0: /* expirelist.c  List of items that expire
sl@0:  *
sl@0:  * Copyright (C) 2003  Red Hat, Inc.
sl@0:  * Portion Copyright © 2008 Nokia Corporation and/or its subsidiary(-ies). All rights reserved.
sl@0:  * Licensed under the Academic Free License version 2.1
sl@0:  *
sl@0:  * This program is free software; you can redistribute it and/or modify
sl@0:  * it under the terms of the GNU General Public License as published by
sl@0:  * the Free Software Foundation; either version 2 of the License, or
sl@0:  * (at your option) any later version.
sl@0:  *
sl@0:  * This program is distributed in the hope that it will be useful,
sl@0:  * but WITHOUT ANY WARRANTY; without even the implied warranty of
sl@0:  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
sl@0:  * GNU General Public License for more details.
sl@0:  *
sl@0:  * You should have received a copy of the GNU General Public License
sl@0:  * along with this program; if not, write to the Free Software
sl@0:  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
sl@0:  *
sl@0:  */
sl@0: 
sl@0: #include "expirelist.h"
sl@0: #include "test.h"
sl@0: #ifndef __SYMBIAN32__
sl@0: #include <dbus/dbus-internals.h>
sl@0: #include <dbus/dbus-mainloop.h>
sl@0: #include <dbus/dbus-timeout.h>
sl@0: #else
sl@0: #include "dbus-internals.h"
sl@0: #include "dbus-mainloop.h"
sl@0: #include "dbus-timeout.h"
sl@0: #endif //__SYMBIAN32__
sl@0: 
sl@0: static dbus_bool_t expire_timeout_handler (void *data);
sl@0: 
sl@0: static void
sl@0: call_timeout_callback (DBusTimeout   *timeout,
sl@0:                        void          *data)
sl@0: {
sl@0:   /* can return FALSE on OOM but we just let it fire again later */
sl@0:   dbus_timeout_handle (timeout);
sl@0: }
sl@0: 
sl@0: BusExpireList*
sl@0: bus_expire_list_new (DBusLoop      *loop,
sl@0:                      int            expire_after,
sl@0:                      BusExpireFunc  expire_func,
sl@0:                      void          *data)
sl@0: {
sl@0:   BusExpireList *list;
sl@0: 
sl@0:   list = dbus_new0 (BusExpireList, 1);
sl@0:   if (list == NULL)
sl@0:     return NULL;
sl@0: 
sl@0:   list->expire_func = expire_func;
sl@0:   list->data = data;
sl@0:   list->loop = loop;
sl@0:   list->expire_after = expire_after;
sl@0: 
sl@0:   list->timeout = _dbus_timeout_new (100, /* irrelevant */
sl@0:                                      expire_timeout_handler,
sl@0:                                      list, NULL);
sl@0:   if (list->timeout == NULL)
sl@0:     goto failed;
sl@0: 
sl@0:   _dbus_timeout_set_enabled (list->timeout, FALSE);
sl@0: 
sl@0:   if (!_dbus_loop_add_timeout (list->loop,
sl@0:                                list->timeout,
sl@0:                                call_timeout_callback, NULL, NULL))
sl@0:     goto failed;
sl@0: 
sl@0:   return list;
sl@0: 
sl@0:  failed:
sl@0:   if (list->timeout)
sl@0:     _dbus_timeout_unref (list->timeout);
sl@0: 
sl@0:   dbus_free (list);
sl@0: 
sl@0:   return NULL;
sl@0: }
sl@0: 
sl@0: void
sl@0: bus_expire_list_free (BusExpireList *list)
sl@0: {
sl@0:   _dbus_assert (list->items == NULL);
sl@0: 
sl@0:   _dbus_loop_remove_timeout (list->loop, list->timeout,
sl@0:                              call_timeout_callback, NULL);
sl@0: 
sl@0:   _dbus_timeout_unref (list->timeout);
sl@0: 
sl@0:   dbus_free (list);
sl@0: }
sl@0: 
sl@0: void
sl@0: bus_expire_timeout_set_interval (DBusTimeout *timeout,
sl@0:                                  int          next_interval)
sl@0: {
sl@0:   if (next_interval >= 0)
sl@0:     {
sl@0:       _dbus_timeout_set_interval (timeout,
sl@0:                                   next_interval);
sl@0:       _dbus_timeout_set_enabled (timeout, TRUE);
sl@0: 
sl@0:       _dbus_verbose ("Enabled expire timeout with interval %d\n",
sl@0:                      next_interval);
sl@0:     }
sl@0:   else if (dbus_timeout_get_enabled (timeout))
sl@0:     {
sl@0:       _dbus_timeout_set_enabled (timeout, FALSE);
sl@0: 
sl@0:       _dbus_verbose ("Disabled expire timeout\n");
sl@0:     }
sl@0:   else
sl@0:     _dbus_verbose ("No need to disable expire timeout\n");
sl@0: }
sl@0: 
sl@0: static int
sl@0: do_expiration_with_current_time (BusExpireList *list,
sl@0:                                  long           tv_sec,
sl@0:                                  long           tv_usec)
sl@0: {
sl@0:   DBusList *link;
sl@0:   int next_interval;
sl@0: 
sl@0:   next_interval = -1;
sl@0:   
sl@0:   link = _dbus_list_get_first_link (&list->items);
sl@0:   while (link != NULL)
sl@0:     {
sl@0:       DBusList *next = _dbus_list_get_next_link (&list->items, link);
sl@0:       double elapsed;
sl@0:       BusExpireItem *item;
sl@0: 
sl@0:       item = link->data;
sl@0: 
sl@0:       elapsed = ELAPSED_MILLISECONDS_SINCE (item->added_tv_sec,
sl@0:                                             item->added_tv_usec,
sl@0:                                             tv_sec, tv_usec);
sl@0: 
sl@0:       if (elapsed >= (double) list->expire_after)
sl@0:         {
sl@0:           _dbus_verbose ("Expiring an item %p\n", item);
sl@0: 
sl@0:           /* If the expire function fails, we just end up expiring
sl@0:            * this item next time we walk through the list. This would
sl@0:            * be an indeterminate time normally, so we set up the
sl@0:            * next_interval to be "shortly" (just enough to avoid
sl@0:            * a busy loop)
sl@0:            */
sl@0:           if (!(* list->expire_func) (list, link, list->data))
sl@0:             {
sl@0:               next_interval = _dbus_get_oom_wait ();
sl@0:               break;
sl@0:             }
sl@0:         }
sl@0:       else
sl@0:         {
sl@0:           /* We can end the loop, since the connections are in oldest-first order */
sl@0:           next_interval = ((double)list->expire_after) - elapsed;
sl@0:           _dbus_verbose ("Item %p expires in %d milliseconds\n",
sl@0:                          item, next_interval);
sl@0: 
sl@0:           break;
sl@0:         }
sl@0: 
sl@0:       link = next;
sl@0:     }
sl@0: 
sl@0:   return next_interval;
sl@0: }
sl@0: 
sl@0: static void
sl@0: bus_expirelist_expire (BusExpireList *list)
sl@0: {
sl@0:   int next_interval;
sl@0: 
sl@0:   next_interval = -1;
sl@0: 
sl@0:   if (list->items != NULL)
sl@0:     {
sl@0:       long tv_sec, tv_usec;
sl@0: 
sl@0:       _dbus_get_current_time (&tv_sec, &tv_usec);
sl@0: 
sl@0:       next_interval = do_expiration_with_current_time (list, tv_sec, tv_usec);
sl@0:     }
sl@0: 
sl@0:   bus_expire_timeout_set_interval (list->timeout, next_interval);
sl@0: }
sl@0: 
sl@0: static dbus_bool_t
sl@0: expire_timeout_handler (void *data)
sl@0: {
sl@0:   BusExpireList *list = data;
sl@0: 
sl@0:   _dbus_verbose ("Running %s\n", _DBUS_FUNCTION_NAME);
sl@0: 
sl@0:   /* note that this may remove the timeout */
sl@0:   bus_expirelist_expire (list);
sl@0: 
sl@0:   return TRUE;
sl@0: }
sl@0: 
sl@0: #ifdef DBUS_BUILD_TESTS
sl@0: 
sl@0: typedef struct
sl@0: {
sl@0:   BusExpireItem item;
sl@0:   int expire_count;
sl@0: } TestExpireItem;
sl@0: 
sl@0: static dbus_bool_t
sl@0: test_expire_func (BusExpireList *list,
sl@0:                   DBusList      *link,
sl@0:                   void          *data)
sl@0: {
sl@0:   TestExpireItem *t;
sl@0: 
sl@0:   t = (TestExpireItem*) link->data;
sl@0: 
sl@0:   t->expire_count += 1;
sl@0: 
sl@0:   return TRUE;
sl@0: }
sl@0: 
sl@0: static void
sl@0: time_add_milliseconds (long *tv_sec,
sl@0:                        long *tv_usec,
sl@0:                        int   milliseconds)
sl@0: {
sl@0:   *tv_sec = *tv_sec + milliseconds / 1000;
sl@0:   *tv_usec = *tv_usec + milliseconds * 1000;
sl@0:   if (*tv_usec >= 1000000)
sl@0:     {
sl@0:       *tv_usec -= 1000000;
sl@0:       *tv_sec += 1;
sl@0:     }
sl@0: }
sl@0: 
sl@0: dbus_bool_t
sl@0: bus_expire_list_test (const DBusString *test_data_dir)
sl@0: {
sl@0:   DBusLoop *loop;
sl@0:   BusExpireList *list;
sl@0:   long tv_sec, tv_usec;
sl@0:   long tv_sec_not_expired, tv_usec_not_expired;
sl@0:   long tv_sec_expired, tv_usec_expired;
sl@0:   long tv_sec_past, tv_usec_past;
sl@0:   TestExpireItem *item;
sl@0:   int next_interval;
sl@0:   dbus_bool_t result = FALSE;
sl@0: 
sl@0: 
sl@0:   loop = _dbus_loop_new ();
sl@0:   _dbus_assert (loop != NULL);
sl@0: 
sl@0: #define EXPIRE_AFTER 100
sl@0:   
sl@0:   list = bus_expire_list_new (loop, EXPIRE_AFTER,
sl@0:                               test_expire_func, NULL);
sl@0:   _dbus_assert (list != NULL);
sl@0: 
sl@0:   _dbus_get_current_time (&tv_sec, &tv_usec);
sl@0: 
sl@0:   tv_sec_not_expired = tv_sec;
sl@0:   tv_usec_not_expired = tv_usec;
sl@0:   time_add_milliseconds (&tv_sec_not_expired,
sl@0:                          &tv_usec_not_expired, EXPIRE_AFTER - 1);
sl@0: 
sl@0:   tv_sec_expired = tv_sec;
sl@0:   tv_usec_expired = tv_usec;
sl@0:   time_add_milliseconds (&tv_sec_expired,
sl@0:                          &tv_usec_expired, EXPIRE_AFTER);
sl@0:   
sl@0: 
sl@0:   tv_sec_past = tv_sec - 1;
sl@0:   tv_usec_past = tv_usec;
sl@0: 
sl@0:   item = dbus_new0 (TestExpireItem, 1);
sl@0: 
sl@0:   if (item == NULL)
sl@0:     goto oom;
sl@0: 
sl@0:   item->item.added_tv_sec = tv_sec;
sl@0:   item->item.added_tv_usec = tv_usec;
sl@0:   if (!_dbus_list_append (&list->items, item))
sl@0:     _dbus_assert_not_reached ("out of memory");
sl@0: 
sl@0:   next_interval =
sl@0:     do_expiration_with_current_time (list, tv_sec_not_expired,
sl@0:                                      tv_usec_not_expired);
sl@0:   _dbus_assert (item->expire_count == 0);
sl@0:   _dbus_verbose ("next_interval = %d\n", next_interval);
sl@0:   _dbus_assert (next_interval == 1);
sl@0:   
sl@0:   next_interval =
sl@0:     do_expiration_with_current_time (list, tv_sec_expired,
sl@0:                                      tv_usec_expired);
sl@0:   _dbus_assert (item->expire_count == 1);
sl@0:   _dbus_verbose ("next_interval = %d\n", next_interval);
sl@0:   _dbus_assert (next_interval == -1);
sl@0: 
sl@0:   next_interval =
sl@0:     do_expiration_with_current_time (list, tv_sec_past,
sl@0:                                      tv_usec_past);
sl@0:   _dbus_assert (item->expire_count == 1);
sl@0:   _dbus_verbose ("next_interval = %d\n", next_interval);
sl@0:   _dbus_assert (next_interval == 1000 + EXPIRE_AFTER);
sl@0: 
sl@0:   _dbus_list_clear (&list->items);
sl@0:   dbus_free (item);
sl@0:   
sl@0:   bus_expire_list_free (list);
sl@0:   _dbus_loop_unref (loop);
sl@0:   
sl@0:   result = TRUE;
sl@0: 
sl@0:  oom:
sl@0:   return result;
sl@0: }
sl@0: 
sl@0: #endif /* DBUS_BUILD_TESTS */