NA_timer_queue_aodv.cc

Go to the documentation of this file.

/*****************************************************************************
 *
 * Copyright (C) 2001 Uppsala University & Ericsson AB.
 *
 * 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
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 * Authors: Erik Nordstr�m, <erik.nordstrom@it.uu.se>
 *
 *****************************************************************************/
#define NS_PORT
#define OMNETPP
#include <stdlib.h>
#include <signal.h>

#ifndef _WIN32
#include <sys/time.h>
#endif

#ifdef NS_PORT
#ifndef OMNETPP
#include "ns/aodv-uu.h"
#else
#include "../NA_aodv_uu_omnet.h"
#endif
#else
#include "NA_timer_queue_aodv.h"
#include "NA_defs_aodv.h"
#include "NA_debug_aodv.h"
#include "NA_list.h"

static LIST(TQ);

/* #define DEBUG_TIMER_QUEUE */

#ifdef DEBUG_TIMER_QUEUE
static void printTQ(list_t * l);
#endif
#endif              /* NS_PORT */


#ifdef AODV_USE_STL
int NS_CLASS timer_init(struct timer *t, timeout_func_t f, void *data)
{
    if (!t)
        return -1;
    t->handler = f;
    t->data = data;
    t->timeout = 0;
    t->used = 0;
    return 0;
}

/* Called when a timer should timeout */
void NS_CLASS timer_timeout(const simtime_t &now)
{

    while (!aodvTimerMap.empty())
    {
        if (aodvTimerMap.begin()->first > now)
            return;
        struct timer *t = aodvTimerMap.begin()->second;
        aodvTimerMap.erase(aodvTimerMap.begin());
        t->used = 0;
        /* Execute handler function for expired timer... */
        if (t->handler)
        {
            (*this.*t->handler) (t->data);
        }

    }
}

NS_STATIC void NS_CLASS timer_add(struct timer *t)
{
    /* Sanity checks: */
    if (!t)
    {
        perror("NULL timer!!!\n");
        exit(-1);
    }
    if (!t->handler)
    {
        perror("NULL handler!!!\n");
        exit(-1);
    }

    /* Make sure we remove unexpired timers before adding a new timeout... */
    if (t->used)
        timer_remove(t);

    t->used = 1;
    aodvTimerMap.insert(std::make_pair(t->timeout,t));
    return;
}

int NS_CLASS timer_remove(struct timer *t)
{
    if (!t)
        return -1;

    t->used = 0;
    for (AodvTimerMap::iterator it = aodvTimerMap.begin();it != aodvTimerMap.end();it++)
    {
        if (it->second == t)
        {
            aodvTimerMap.erase(it);
            return 1;
        }
    }
    return 0;
}


int NS_CLASS timer_timeout_now(struct timer *t)
{
    if (timer_remove(t)>0)
    {
        (*this.*t->handler) (t->data);
        return 1;
    }
    return -1;
}


void NS_CLASS timer_set_timeout(struct timer *t, long msec)
{
    if (t->used)
    {
        timer_remove(t);
    }


    if (msec < 0)
    {
        DEBUG(LOG_WARNING, 0, "Negative timeout!!!");
        msec=0;
    }
    double auxtime = ((double)msec)/1000.0;
    t->timeout = simTime() + auxtime;
    timer_add(t);
}

simtime_t NS_CLASS timer_age_queue()
{
    simtime_t now;
    simtime_t remaining;
    now = simTime();
    timer_timeout(now);
    if (aodvTimerMap.empty())
        return remaining;
    remaining =  aodvTimerMap.begin()->first - now;
    return remaining;
}
#else
int NS_CLASS timer_init(struct timer *t, timeout_func_t f, void *data)
{
    if (!t)
        return -1;

    INIT_LIST_ELM(&t->l);
    t->handler = f;
    t->data = data;
    t->timeout.tv_sec = 0;
    t->timeout.tv_usec = 0;
    t->used = 0;

    return 0;
}

/* Called when a timer should timeout */
void NS_CLASS timer_timeout(struct timeval *now)
{
    LIST(expTQ);
    list_t *pos, *tmp;
    list_t *expTQ_ptr;

    expTQ_ptr=&expTQ;
#ifdef DEBUG_TIMER_QUEUE
    printf("\n######## timer_timeout: called!!\n");
#endif
    /* Remove expired timers from TQ and add them to expTQ */
    list_foreach_safe(pos, tmp, &TQ)
    {
        struct timer *t = (struct timer *) pos;

        if (timeval_diff(&t->timeout, now) > 0)
            break;

        list_detach(&t->l);
        list_add_tail(expTQ_ptr, &t->l);
    }

    /* Execute expired timers in expTQ safely by removing them at the head */
    while (!list_empty(expTQ_ptr))
    {
        struct timer *t = (struct timer *) list_first(expTQ_ptr);
        list_detach(&t->l);
        t->used = 0;
#ifdef DEBUG_TIMER_QUEUE
        printf("removing timer %lu %d\n", pos);
#endif
        /* Execute handler function for expired timer... */
        if (t->handler)
        {
#ifdef NS_PORT
            (*this.*t->handler) (t->data);
#else
            t->handler(t->data);
#endif
        }
    }
}

NS_STATIC void NS_CLASS timer_add(struct timer *t)
{
    list_t *pos;
    list_t * lista_ptr;
    /* Sanity checks: */

    if (!t)
    {
        perror("NULL timer!!!\n");
        exit(-1);
    }
    if (!t->handler)
    {
        perror("NULL handler!!!\n");
        exit(-1);
    }

    /* Make sure we remove unexpired timers before adding a new timeout... */
    if (t->used)
        timer_remove(t);

    t->used = 1;

#ifdef DEBUG_TIMER_QUEUE
    printf("New timer added!\n");
#endif
    lista_ptr = &TQ;
    /* Base case when queue is empty: */
    if (list_empty(&TQ))
    {
        list_add(&TQ, &t->l);
    }
    else
    {

        list_foreach(pos, &TQ)
        {
            struct timer *curr = (struct timer *) pos;
            if (timeval_diff(&t->timeout, &curr->timeout) < 0)
            {
                break;
            }
        }
        list_add(pos->prev, &t->l);
    }

#ifdef DEBUG_TIMER_QUEUE
    printTQ(&TQ);
#endif
    return;
}

int NS_CLASS timer_remove(struct timer *t)
{
    int res = 1;

    if (!t)
        return -1;


    if (list_unattached(&t->l))
        res = 0;
    else
        list_detach(&t->l);

    t->used = 0;

    return res;
}


int NS_CLASS timer_timeout_now(struct timer *t)
{
    if (timer_remove(t))
    {

#ifdef NS_PORT
        (*this.*t->handler) (t->data);
#else
        t->handler(t->data);
#endif
        return 1;
    }
    return -1;
}


void NS_CLASS timer_set_timeout(struct timer *t, long msec)
{
    if (t->used)
    {
        timer_remove(t);
    }

    gettimeofday(&t->timeout, NULL);

    if (msec < 0)
        DEBUG(LOG_WARNING, 0, "Negative timeout!!!");

    t->timeout.tv_usec += msec * 1000;
    t->timeout.tv_sec += t->timeout.tv_usec / 1000000;
    t->timeout.tv_usec = t->timeout.tv_usec % 1000000;

    timer_add(t);
}

#ifndef OMNETPP
long timer_left(struct timer *t)
{
    struct timeval now;

    if (!t)
        return -1;

    gettimeofday(&now, NULL);

    return timeval_diff(&now, &t->timeout);
}
#endif

struct timeval *NS_CLASS timer_age_queue()
{
    struct timeval now;
    struct timer *t;
    static struct timeval remaining;

    gettimeofday(&now, NULL);

    fflush(stdout);

    if (list_empty(&TQ))
        return NULL;

    timer_timeout(&now);

    /* Check emptyness again since the list might have been updated by a
     * timeout */
    if (list_empty(&TQ))
        return NULL;

    t = (struct timer *) TQ.next;

    remaining.tv_usec = (t->timeout.tv_usec - now.tv_usec);
    remaining.tv_sec = (t->timeout.tv_sec - now.tv_sec);

    if (remaining.tv_usec < 0)
    {
        remaining.tv_usec += 1000000;
        remaining.tv_sec -= 1;
    }
    return (&remaining);
}


#ifdef DEBUG_TIMER_QUEUE
void NS_CLASS printTQ(list_t * l)
{
    struct timeval now;
    int n = 0;
    list_t *pos;

    gettimeofday(&now, NULL);

    fprintf(stderr, "================\n");
    fprintf(stderr, "%-12s %-4s %lu\n", "left", "n", (unsigned long) l);

    list_foreach(pos, l)
    {
        struct timer *t = (struct timer *) pos;
        fprintf(stderr, "%-12ld %-4d %lu\n", timeval_diff(&t->timeout, &now), n,
                (unsigned long) pos);
        n++;
    }
}
#endif
#endif