schedule.c

Go to the documentation of this file.

/*
 * Copyright 2012 Vincent Sanders <vince@netsurf-browser.co.uk>
 *
 * This file is part of NetSurf, http://www.netsurf-browser.org/
 *
 * NetSurf 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; version 2 of the License.
 *
 * NetSurf 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, see <http://www.gnu.org/licenses/>.
 */
 
#include <time.h>
#include <stdlib.h>
 
#include "utils/sys_time.h"
#include "utils/log.h"
 
#include "monkey/schedule.h"
 
/* linked list of scheduled callbacks */
static struct nscallback *schedule_list = NULL;
 
/**
 * scheduled callback.
 */
struct nscallback
{
        struct nscallback *next;
        struct timeval tv;
        void (*callback)(void *p);
        void *p;
};
 
/**
 * Unschedule a callback.
 *
 * \param  callback  callback function
 * \param  p         user parameter, passed to callback function
 * \return NSERROR_OK if callback found and removed else NSERROR_NOT_FOUND
 *
 * All scheduled callbacks matching both callback and p are removed.
 */
static nserror schedule_remove(void (*callback)(void *p), void *p)
{
        struct nscallback *cur_nscb;
        struct nscallback *prev_nscb;
        struct nscallback *unlnk_nscb;
        bool removed = false;
 
        /* check there is something on the list to remove */
        if (schedule_list == NULL) {
                return NSERROR_NOT_FOUND;
        }
 
        NSLOG(schedule, DEBUG, "removing %p, %p", callback, p);
 
        cur_nscb = schedule_list;
        prev_nscb = NULL;
 
        while (cur_nscb != NULL) {
                if ((cur_nscb->callback ==  callback) &&
                    (cur_nscb->p ==  p)) {
                        /* item to remove */
 
                        NSLOG(schedule, DEBUG, "callback entry %p removing  %p(%p)",
                              cur_nscb, cur_nscb->callback, cur_nscb->p);
 
                        /* remove callback */
                        unlnk_nscb = cur_nscb;
                        cur_nscb = unlnk_nscb->next;
 
                        if (prev_nscb == NULL) {
                                schedule_list = cur_nscb;
                        } else {
                                prev_nscb->next = cur_nscb;
                        }
                        free (unlnk_nscb);
                        removed = true;
                } else {
                        /* move to next element */
                        prev_nscb = cur_nscb;
                        cur_nscb = prev_nscb->next;
                }
        }
 
        if (removed == false) {
                return NSERROR_NOT_FOUND;
        }
        return NSERROR_OK;
}
 
/* exported function documented in monkey/schedule.h */
nserror monkey_schedule(int tival, void (*callback)(void *p), void *p)
{
        struct nscallback *nscb;
        struct timeval tv;
        nserror ret;
 
        /* ensure uniqueness of the callback and context */
        ret = schedule_remove(callback, p);
        if (tival < 0) {
                return ret;
        }
 
        NSLOG(schedule, DEBUG, "Adding %p(%p) in %d", callback, p, tival);
 
        tv.tv_sec = tival / 1000; /* miliseconds to seconds */
        tv.tv_usec = (tival % 1000) * 1000; /* remainder to microseconds */
 
        nscb = calloc(1, sizeof(struct nscallback));
 
        gettimeofday(&nscb->tv, NULL);
        timeradd(&nscb->tv, &tv, &nscb->tv);
 
        nscb->callback = callback;
        nscb->p = p;
 
        /* add to list front */
        nscb->next = schedule_list;
        schedule_list = nscb;
 
        return NSERROR_OK;
}
 
/* exported function documented in monkey/schedule.h */
int monkey_schedule_run(void)
{
        struct timeval tv;
        struct timeval nexttime;
        struct timeval rettime;
        struct nscallback *cur_nscb;
        struct nscallback *prev_nscb;
        struct nscallback *unlnk_nscb;
 
        if (schedule_list == NULL)
                return -1;
 
        /* reset enumeration to the start of the list */
        cur_nscb = schedule_list;
        prev_nscb = NULL;
        nexttime = cur_nscb->tv;
 
        gettimeofday(&tv, NULL);
 
        while (cur_nscb != NULL) {
                if (timercmp(&tv, &cur_nscb->tv, >)) {
                        /* scheduled time */
 
                        /* remove callback */
                        unlnk_nscb = cur_nscb;
 
                        if (prev_nscb == NULL) {
                                schedule_list = unlnk_nscb->next;
                        } else {
                                prev_nscb->next = unlnk_nscb->next;
                        }
 
                        unlnk_nscb->callback(unlnk_nscb->p);
 
                        free(unlnk_nscb);
 
                        /* need to deal with callback modifying the list. */
                        if (schedule_list == NULL)
                                return -1; /* no more callbacks scheduled */
 
                        /* reset enumeration to the start of the list */
                        cur_nscb = schedule_list;
                        prev_nscb = NULL;
                        nexttime = cur_nscb->tv;
                } else {
                        /* if the time to the event is sooner than the
                         * currently recorded soonest event record it
                         */
                        if (timercmp(&nexttime, &cur_nscb->tv, >)) {
                                nexttime = cur_nscb->tv;
                        }
                        /* move to next element */
                        prev_nscb = cur_nscb;
                        cur_nscb = prev_nscb->next;
                }
        }
 
        /* make rettime relative to now */
        timersub(&nexttime, &tv, &rettime);
 
        NSLOG(schedule, DEBUG, "returning time to next event as %ldms",
              (long)((rettime.tv_sec * 1000) + (rettime.tv_usec / 1000)));
 
        /* return next event time in milliseconds (24days max wait) */
        return (rettime.tv_sec * 1000) + (rettime.tv_usec / 1000);
}
 
void monkey_schedule_list(void)
{
        struct timeval tv;
        struct nscallback *cur_nscb;
 
        gettimeofday(&tv, NULL);
 
        NSLOG(netsurf, INFO, "schedule list at %lld:%ld",
              (long long)tv.tv_sec, tv.tv_usec);
 
        cur_nscb = schedule_list;
 
        while (cur_nscb != NULL) {
                NSLOG(netsurf, INFO, "Schedule %p at %lld:%ld", cur_nscb,
                      (long long)cur_nscb->tv.tv_sec, cur_nscb->tv.tv_usec);
                cur_nscb = cur_nscb->next;
        }
}