/home/aaron/olsrd-current/olsrd/src/core/olsr_timer.c File Reference

#include <assert.h>
#include <stdlib.h>
#include <string.h>
#include <unistd.h>
#include "common/avl.h"
#include "common/avl_comp.h"
#include "olsr_clock.h"
#include "olsr_logging.h"
#include "olsr_memcookie.h"
#include "olsr_timer.h"

Include dependency graph for olsr_timer.c:

Go to the source code of this file.

Functions
static uint32_t	calc_jitter (unsigned int rel_time, uint8_t jitter_pct, unsigned int random_val)
void	olsr_timer_init (void)
void	olsr_timer_cleanup (void)
struct olsr_timer_info *	olsr_timer_add (const char *name, timer_cb_func callback, bool periodic)
void	olsr_timer_remove (struct olsr_timer_info *info)
struct olsr_timer_entry *	olsr_timer_start (unsigned int rel_time, uint8_t jitter_pct, void context, struct olsr_timer_info ti)
void	olsr_timer_stop (struct olsr_timer_entry *timer)
void	olsr_timer_change (struct olsr_timer_entry *timer, unsigned int rel_time, uint8_t jitter_pct)
void	olsr_timer_set (struct olsr_timer_entry *timer_ptr, unsigned int rel_time, uint8_t jitter_pct, void context, struct olsr_timer_info *ti)
void	olsr_timer_walk (void)
Variables
static struct list_entity	timer_wheel [TIMER_WHEEL_SLOTS]
static uint32_t	timer_last_run
struct list_entity	timerinfo_list
static struct olsr_memcookie_info *	timer_mem_cookie = NULL
static struct olsr_memcookie_info *	timerinfo_cookie = NULL

Function Documentation

static uint32_t calc_jitter	(	unsigned int	rel_time,
		uint8_t	jitter_pct,
		unsigned int	random_val
	)			`[static]`

Decrement a relative timer by a random number range.

Parameters:

	the	relative timer expressed in units of milliseconds.
	the	jitter in percent
	cached	result of random() at system init.

Returns:: the absolute timer

Definition at line 347 of file olsr_timer.c.

References LOG_TIMER, olsr_clock_getAbsolute(), and OLSR_DEBUG.

Referenced by olsr_timer_change(), and olsr_timer_start().

Here is the call graph for this function:

struct olsr_timer_info* olsr_timer_add	(	const char *	name,
		timer_cb_func	callback,
		bool	periodic
	)			`[read]`

Add a new group of timers to the scheduler

Parameters:

	name
	callback	timer event function
	periodic	true if the timer is periodic, false otherwise

Returns:: new timer info

Definition at line 140 of file olsr_timer.c.

References olsr_timer_info::callback, list_add_tail(), olsr_timer_info::name, olsr_timer_info::node, olsr_memcookie_malloc(), olsr_timer_info::periodic, and timerinfo_list.

Referenced by arproaming_init(), debuginfo_enable(), init_interfaces(), init_net(), InitOBAMP(), lq_etxff_initialize(), main(), mapwrite_init(), name_constructor(), olsr_com_init(), olsr_com_init_txt(), olsr_init_duplicate_set(), olsr_init_hna_set(), olsr_init_link_set(), olsr_init_mid_set(), olsr_init_neighbor_table(), olsr_init_spf(), olsr_init_tc(), olsr_init_willingness(), olsrd_plugin_init(), and secure_plugin_init().

Here is the call graph for this function:

void olsr_timer_change	(	struct olsr_timer_entry *	timer,
		unsigned int	rel_time,
		uint8_t	jitter_pct
	)

Change a olsr_timer_entry.

Parameters:

	olsr_timer_entry	to be changed.
	new	relative time expressed in units of milliseconds.
	new	jitter expressed in percent.

Returns:: nada

Definition at line 276 of file olsr_timer.c.

References calc_jitter(), list_add_before(), list_remove(), LOG_TIMER, olsr_timer_info::name, olsr_clock_toClockString(), OLSR_DEBUG, olsr_timer_info::periodic, olsr_timer_entry::timer_cb_context, olsr_timer_entry::timer_clock, olsr_timer_entry::timer_info, olsr_timer_entry::timer_jitter_pct, olsr_timer_entry::timer_list, olsr_timer_entry::timer_period, olsr_timer_entry::timer_random, timer_wheel, and TIMER_WHEEL_MASK.

Referenced by olsr_com_parse_txt(), olsr_expire_link_loss_timer(), olsr_is_duplicate_message(), olsr_link_nbr_nbr2(), olsr_timer_set(), and olsr_timer_walk().

Here is the call graph for this function:

void olsr_timer_cleanup ( void )

Cleanup timer scheduler, this stops and deletes all timers

Definition at line 97 of file olsr_timer.c.

References list_first_element, list_is_empty(), list_remove(), olsr_timer_info::name, list_entity::next, olsr_timer_info::node, OLSR_FOR_ALL_TIMERS, olsr_memcookie_free(), olsr_memcookie_remove(), olsr_timer_stop(), list_entity::prev, olsr_timer_entry::timer_list, timer_wheel, TIMER_WHEEL_MASK, TIMER_WHEEL_SLOTS, and timerinfo_list.

Referenced by olsr_shutdown().

Here is the call graph for this function:

void olsr_timer_init ( void )

Init datastructures for maintaining timers.

Definition at line 70 of file olsr_timer.c.

References list_init_head(), LOG_SCHEDULER, olsr_clock_getNow(), OLSR_INFO, olsr_memcookie_add(), timer_last_run, timer_wheel, TIMER_WHEEL_SLOTS, and timerinfo_list.

Referenced by main().

Here is the call graph for this function:

void olsr_timer_remove ( struct olsr_timer_info * info )

Removes a group of timers from the scheduler All pointers to timers of this timer_info will be invalid after this.

Parameters:

info

pointer to timer info

Definition at line 158 of file olsr_timer.c.

References list_for_each_element_safe, list_remove(), olsr_timer_info::name, olsr_timer_info::node, olsr_memcookie_free(), olsr_timer_stop(), olsr_timer_entry::timer_info, olsr_timer_entry::timer_list, timer_wheel, and TIMER_WHEEL_SLOTS.

Here is the call graph for this function:

void olsr_timer_set	(	struct olsr_timer_entry **	timer_ptr,
		unsigned int	rel_time,
		uint8_t	jitter_pct,
		void *	context,
		struct olsr_timer_info *	ti
	)

This is the one stop shop for all sort of timer manipulation. Depending on the passed in parameters a new timer is started, or an existing timer is started or an existing timer is terminated.

Parameters:

	timer_ptr	pointer to timer_entry pointer
	rel_time	time until the new timer should fire, 0 to stop timer
	jitter_pct	jitter of timer in percent
	context	context pointer of timer
	ti	timer_info of timer