[solanum.git] / librb / src / event.c

/*
 *  ircd-ratbox: A slightly useful ircd.
 *  event.c: Event functions.
 *
 *  Copyright (C) 1998-2000 Regents of the University of California
 *  Copyright (C) 2001-2002 Hybrid Development Team
 *  Copyright (C) 2002-2005 ircd-ratbox development team
 *
 *  Code borrowed from the squid web cache by Adrian Chadd.
 *  Original header:
 *
 *  DEBUG: section 41   Event Processing
 *  AUTHOR: Henrik Nordstrom
 *
 *  SQUID Internet Object Cache  http://squid.nlanr.net/Squid/
 *  ----------------------------------------------------------
 *
 *  Squid is the result of efforts by numerous individuals from the
 *  Internet community.  Development is led by Duane Wessels of the
 *  National Laboratory for Applied Network Research and funded by the
 *  National Science Foundation.  Squid is Copyrighted (C) 1998 by
 *  the Regents of the University of California.  Please see the
 *  COPYRIGHT file for full details.  Squid incorporates software
 *  developed and/or copyrighted by other sources.  Please see the
 *  CREDITS file for full details.
 *
 *  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., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301
 *  USA
 *
 *  $Id: event.c 26272 2008-12-10 05:55:10Z androsyn $
 */

#include <libratbox_config.h>
#include <ratbox_lib.h>
#include <commio-int.h>
#include <event-int.h>

#define EV_NAME_LEN 33
static char last_event_ran[EV_NAME_LEN];
static rb_dlink_list event_list;

static time_t event_time_min = -1;

/*
 * struct ev_entry *
 * rb_event_find(EVH *func, void *arg)
 *
 * Input: Event function and the argument passed to it
 * Output: Index to the slow in the event_table
 * Side Effects: None
 */
static struct ev_entry *
rb_event_find(EVH * func, void *arg)
{
	rb_dlink_node *ptr;
	struct ev_entry *ev;
	RB_DLINK_FOREACH(ptr, event_list.head)
	{
		ev = ptr->data;
		if((ev->func == func) && (ev->arg == arg))
			return ev;
	}

	return NULL;
}

static
struct ev_entry *
rb_event_add_common(const char *name, EVH * func, void *arg, time_t when, time_t frequency)
{
	struct ev_entry *ev;
	ev = rb_malloc(sizeof(struct ev_entry));
	ev->func = func;
	ev->name = rb_strndup(name, EV_NAME_LEN);
	ev->arg = arg;
	ev->when = rb_current_time() + when;
	ev->next = when;
	ev->frequency = frequency;

	if((ev->when < event_time_min) || (event_time_min == -1))
		event_time_min = ev->when;

	rb_dlinkAdd(ev, &ev->node, &event_list);
	rb_io_sched_event(ev, when);
	return ev;
}

/*
 * struct ev_entry *
 * rb_event_add(const char *name, EVH *func, void *arg, time_t when)
 *
 * Input: Name of event, function to call, arguments to pass, and frequency
 *	  of the event.
 * Output: None
 * Side Effects: Adds the event to the event list.
 */
struct ev_entry *
rb_event_add(const char *name, EVH * func, void *arg, time_t when)
{
	if (rb_unlikely(when <= 0)) {
		rb_lib_log("rb_event_add: tried to schedule %s event with a delay of "
			"%d seconds", name, (int) when);
		when = 1;
	}

	return rb_event_add_common(name, func, arg, when, when);
}

struct ev_entry *
rb_event_addonce(const char *name, EVH * func, void *arg, time_t when)
{
	if (rb_unlikely(when <= 0)) {
		rb_lib_log("rb_event_addonce: tried to schedule %s event to run in "
			"%d seconds", name, (int) when);
		when = 1;
	}

	return rb_event_add_common(name, func, arg, when, 0);
}

/*
 * void rb_event_delete(struct ev_entry *ev)
 *
 * Input: pointer to ev_entry for the event
 * Output: None
 * Side Effects: Removes the event from the event list
 */
void
rb_event_delete(struct ev_entry *ev)
{
	if(ev == NULL)
		return;

	rb_dlinkDelete(&ev->node, &event_list);
	rb_io_unsched_event(ev);
	rb_free(ev->name);
	rb_free(ev);
}

/*
 * void rb_event_find_delete(EVH *func, void *arg)
 *
 * Input: pointer to func and data
 * Output: None
 * Side Effects: Removes the event from the event list
 */
void
rb_event_find_delete(EVH * func, void *arg)
{
	rb_event_delete(rb_event_find(func, arg));
}

static time_t
rb_event_frequency(time_t frequency)
{
	if(frequency < 0)
	{
		const time_t two_third = (2 * labs(frequency)) / 3;
		frequency = two_third + ((rand() % 1000) * two_third) / 1000;
	}
	return frequency;
}

/*
 * struct ev_entry *
 * rb_event_addish(const char *name, EVH *func, void *arg, time_t delta_isa)
 *
 * Input: Name of event, function to call, arguments to pass, and frequency
 *	  of the event.
 * Output: None
 * Side Effects: Adds the event to the event list within +- 1/3 of the
 *	         specified frequency.
 */
struct ev_entry *
rb_event_addish(const char *name, EVH * func, void *arg, time_t delta_ish)
{
	delta_ish = labs(delta_ish);
	if(delta_ish >= 3.0)
		delta_ish = -delta_ish;
	return rb_event_add_common(name, func, arg,
		rb_event_frequency(delta_ish), delta_ish);
}


void
rb_run_event(struct ev_entry *ev)
{
	rb_strlcpy(last_event_ran, ev->name, sizeof(last_event_ran));
	ev->func(ev->arg);
	if(!ev->frequency)
	{
		rb_event_delete(ev);
		return;
	}
	ev->when = rb_current_time() + rb_event_frequency(ev->frequency);
	if((ev->when < event_time_min) || (event_time_min == -1))
		event_time_min = ev->when;
}

/*
 * void rb_event_run(void)
 *
 * Input: None
 * Output: None
 * Side Effects: Runs pending events in the event list
 */
void
rb_event_run(void)
{
	rb_dlink_node *ptr, *next;
	struct ev_entry *ev;

	if(rb_io_supports_event())
		return;

	event_time_min = -1;
	RB_DLINK_FOREACH_SAFE(ptr, next, event_list.head)
	{
		ev = ptr->data;
		if(ev->when <= rb_current_time())
		{
			rb_strlcpy(last_event_ran, ev->name, sizeof(last_event_ran));
			ev->func(ev->arg);

			/* event is scheduled more than once */
			if(ev->frequency)
			{
				ev->when = rb_current_time() + rb_event_frequency(ev->frequency);
				if((ev->when < event_time_min) || (event_time_min == -1))
					event_time_min = ev->when;
			}
			else
			{
				rb_dlinkDelete(&ev->node, &event_list);
				rb_free(ev);
			}
		}
		else
		{
			if((ev->when < event_time_min) || (event_time_min == -1))
				event_time_min = ev->when;
		}
	}
}

void
rb_event_io_register_all(void)
{
	rb_dlink_node *ptr;
	struct ev_entry *ev;

	if(!rb_io_supports_event())
		return;

	RB_DLINK_FOREACH(ptr, event_list.head)
	{
		ev = ptr->data;
		rb_io_sched_event(ev, ev->next);
	}
}

/*
 * void rb_event_init(void)
 *
 * Input: None
 * Output: None
 * Side Effects: Initializes the event system.
 */
void
rb_event_init(void)
{
	rb_strlcpy(last_event_ran, "NONE", sizeof(last_event_ran));
}

void
rb_dump_events(void (*func) (char *, void *), void *ptr)
{
	int len;
	char buf[512];
	rb_dlink_node *dptr;
	struct ev_entry *ev;
	len = sizeof(buf);

	snprintf(buf, len, "Last event to run: %s", last_event_ran);
	func(buf, ptr);

	rb_strlcpy(buf, "Operation                    Next Execution", len);
	func(buf, ptr);

	RB_DLINK_FOREACH(dptr, event_list.head)
	{
		ev = dptr->data;
		snprintf(buf, len, "%-28s %-4ld seconds (frequency=%d)", ev->name,
			    ev->when - (long)rb_current_time(), (int)ev->frequency);
		func(buf, ptr);
	}
}

/*
 * void rb_set_back_events(time_t by)
 * Input: Time to set back events by.
 * Output: None.
 * Side-effects: Sets back all events by "by" seconds.
 */
void
rb_set_back_events(time_t by)
{
	rb_dlink_node *ptr;
	struct ev_entry *ev;
	RB_DLINK_FOREACH(ptr, event_list.head)
	{
		ev = ptr->data;
		if(ev->when > by)
			ev->when -= by;
		else
			ev->when = 0;
	}
}

void
rb_event_update(struct ev_entry *ev, time_t freq)
{
	if(ev == NULL)
		return;

	ev->frequency = freq;

	/* update when it's scheduled to run if it's higher
	 * than the new frequency
	 */
	time_t next = rb_event_frequency(freq);
	if((rb_current_time() + next) < ev->when)
		ev->when = rb_current_time() + next;
	return;
}

time_t
rb_event_next(void)
{
	return event_time_min;
}
Commit	Line	Data
db137867 AC	1	/*
	2	* ircd-ratbox: A slightly useful ircd.
	3	* event.c: Event functions.
	4	*
	5	* Copyright (C) 1998-2000 Regents of the University of California
	6	* Copyright (C) 2001-2002 Hybrid Development Team
	7	* Copyright (C) 2002-2005 ircd-ratbox development team
	8	*
	9	* Code borrowed from the squid web cache by Adrian Chadd.
	10	* Original header:
	11	*
	12	* DEBUG: section 41 Event Processing
	13	* AUTHOR: Henrik Nordstrom
	14	*
	15	* SQUID Internet Object Cache http://squid.nlanr.net/Squid/
	16	* ----------------------------------------------------------
	17	*
	18	* Squid is the result of efforts by numerous individuals from the
	19	* Internet community. Development is led by Duane Wessels of the
	20	* National Laboratory for Applied Network Research and funded by the
	21	* National Science Foundation. Squid is Copyrighted (C) 1998 by
	22	* the Regents of the University of California. Please see the
	23	* COPYRIGHT file for full details. Squid incorporates software
	24	* developed and/or copyrighted by other sources. Please see the
	25	* CREDITS file for full details.
	26	*
	27	* This program is free software; you can redistribute it and/or modify
	28	* it under the terms of the GNU General Public License as published by
	29	* the Free Software Foundation; either version 2 of the License, or
	30	* (at your option) any later version.
	31	*
	32	* This program is distributed in the hope that it will be useful,
	33	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	34	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	35	* GNU General Public License for more details.
	36	*
	37	* You should have received a copy of the GNU General Public License
	38	* along with this program; if not, write to the Free Software
	39	* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301
	40	* USA
	41	*
030272f3	42	* $Id: event.c 26272 2008-12-10 05:55:10Z androsyn $
db137867 AC	43	*/
	44
	45	#include <libratbox_config.h>
	46	#include <ratbox_lib.h>
	47	#include <commio-int.h>
	48	#include <event-int.h>
	49
3202e249 VY	50	#define EV_NAME_LEN 33
3202e249 VY	51	static char last_event_ran[EV_NAME_LEN];
db137867 AC	52	static rb_dlink_list event_list;
	53
	54	static time_t event_time_min = -1;
db137867 AC	55
db137867 AC	56	/*
55abcbb2	57	* struct ev_entry *
db137867 AC	58	* rb_event_find(EVH func, void arg)
	59	*
	60	* Input: Event function and the argument passed to it
	61	* Output: Index to the slow in the event_table
	62	* Side Effects: None
	63	*/
	64	static struct ev_entry *
	65	rb_event_find(EVH * func, void *arg)
	66	{
	67	rb_dlink_node *ptr;
	68	struct ev_entry *ev;
	69	RB_DLINK_FOREACH(ptr, event_list.head)
	70	{
	71	ev = ptr->data;
	72	if((ev->func == func) && (ev->arg == arg))
	73	return ev;
	74	}
	75
	76	return NULL;
	77	}
	78
8ace0906 SA	79	static
	80	struct ev_entry *
	81	rb_event_add_common(const char name, EVH func, void *arg, time_t when, time_t frequency)
	82	{
	83	struct ev_entry *ev;
	84	ev = rb_malloc(sizeof(struct ev_entry));
	85	ev->func = func;
	86	ev->name = rb_strndup(name, EV_NAME_LEN);
	87	ev->arg = arg;
	88	ev->when = rb_current_time() + when;
	89	ev->next = when;
	90	ev->frequency = frequency;
	91
	92	if((ev->when < event_time_min) \|\| (event_time_min == -1))
	93	event_time_min = ev->when;
	94
	95	rb_dlinkAdd(ev, &ev->node, &event_list);
	96	rb_io_sched_event(ev, when);
	97	return ev;
	98	}
	99
db137867	100	/*
55abcbb2	101	* struct ev_entry *
db137867 AC	102	* rb_event_add(const char name, EVH func, void *arg, time_t when)
	103	*
	104	* Input: Name of event, function to call, arguments to pass, and frequency
	105	* of the event.
	106	* Output: None
	107	* Side Effects: Adds the event to the event list.
	108	*/
	109	struct ev_entry *
	110	rb_event_add(const char name, EVH func, void *arg, time_t when)
	111	{
8db50c03 KB	112	if (rb_unlikely(when <= 0)) {
	113	rb_lib_log("rb_event_add: tried to schedule %s event with a delay of "
	114	"%d seconds", name, (int) when);
	115	when = 1;
	116	}
db137867	117
8ace0906	118	return rb_event_add_common(name, func, arg, when, when);
db137867	119	}
3202e249	120
db137867 AC	121	struct ev_entry *
	122	rb_event_addonce(const char name, EVH func, void *arg, time_t when)
	123	{
8db50c03 KB	124	if (rb_unlikely(when <= 0)) {
	125	rb_lib_log("rb_event_addonce: tried to schedule %s event to run in "
	126	"%d seconds", name, (int) when);
	127	when = 1;
	128	}
db137867	129
8ace0906	130	return rb_event_add_common(name, func, arg, when, 0);
db137867 AC	131	}
	132
	133	/*
	134	* void rb_event_delete(struct ev_entry *ev)
	135	*
	136	* Input: pointer to ev_entry for the event
	137	* Output: None
	138	* Side Effects: Removes the event from the event list
	139	*/
	140	void
	141	rb_event_delete(struct ev_entry *ev)
	142	{
	143	if(ev == NULL)
	144	return;
	145
	146	rb_dlinkDelete(&ev->node, &event_list);
	147	rb_io_unsched_event(ev);
3202e249	148	rb_free(ev->name);
db137867 AC	149	rb_free(ev);
	150	}
	151
	152	/*
	153	* void rb_event_find_delete(EVH func, void arg)
	154	*
	155	* Input: pointer to func and data
	156	* Output: None
	157	* Side Effects: Removes the event from the event list
	158	*/
	159	void
3202e249	160	rb_event_find_delete(EVH * func, void *arg)
db137867 AC	161	{
	162	rb_event_delete(rb_event_find(func, arg));
	163	}
	164
8ace0906 SA	165	static time_t
	166	rb_event_frequency(time_t frequency)
	167	{
	168	if(frequency < 0)
	169	{
a1125230	170	const time_t two_third = (2 * labs(frequency)) / 3;
8ace0906 SA	171	frequency = two_third + ((rand() % 1000) * two_third) / 1000;
	172	}
	173	return frequency;
	174	}
	175
55abcbb2	176	/*
db137867 AC	177	* struct ev_entry *
	178	* rb_event_addish(const char name, EVH func, void *arg, time_t delta_isa)
	179	*
	180	* Input: Name of event, function to call, arguments to pass, and frequency
	181	* of the event.
	182	* Output: None
	183	* Side Effects: Adds the event to the event list within +- 1/3 of the
	184	* specified frequency.
	185	*/
	186	struct ev_entry *
	187	rb_event_addish(const char name, EVH func, void *arg, time_t delta_ish)
	188	{
a1125230	189	delta_ish = labs(delta_ish);
db137867	190	if(delta_ish >= 3.0)
8ace0906 SA	191	delta_ish = -delta_ish;
	192	return rb_event_add_common(name, func, arg,
	193	rb_event_frequency(delta_ish), delta_ish);
db137867 AC	194	}
	195
	196
	197	void
	198	rb_run_event(struct ev_entry *ev)
	199	{
3202e249	200	rb_strlcpy(last_event_ran, ev->name, sizeof(last_event_ran));
db137867 AC	201	ev->func(ev->arg);
	202	if(!ev->frequency)
	203	{
1d393245	204	rb_event_delete(ev);
db137867 AC	205	return;
db137867 AC	206	}
8ace0906	207	ev->when = rb_current_time() + rb_event_frequency(ev->frequency);
db137867 AC	208	if((ev->when < event_time_min) \|\| (event_time_min == -1))
	209	event_time_min = ev->when;
	210	}
	211
	212	/*
	213	* void rb_event_run(void)
	214	*
	215	* Input: None
	216	* Output: None
	217	* Side Effects: Runs pending events in the event list
	218	*/
	219	void
	220	rb_event_run(void)
	221	{
	222	rb_dlink_node ptr, next;
	223	struct ev_entry *ev;
3202e249	224
db137867 AC	225	if(rb_io_supports_event())
	226	return;
	227
	228	event_time_min = -1;
	229	RB_DLINK_FOREACH_SAFE(ptr, next, event_list.head)
	230	{
	231	ev = ptr->data;
	232	if(ev->when <= rb_current_time())
	233	{
3202e249	234	rb_strlcpy(last_event_ran, ev->name, sizeof(last_event_ran));
db137867 AC	235	ev->func(ev->arg);
	236
	237	/* event is scheduled more than once */
3202e249	238	if(ev->frequency)
db137867	239	{
8ace0906	240	ev->when = rb_current_time() + rb_event_frequency(ev->frequency);
db137867 AC	241	if((ev->when < event_time_min) \|\| (event_time_min == -1))
	242	event_time_min = ev->when;
	243	}
	244	else
	245	{
	246	rb_dlinkDelete(&ev->node, &event_list);
	247	rb_free(ev);
	248	}
3202e249 VY	249	}
	250	else
	251	{
db137867 AC	252	if((ev->when < event_time_min) \|\| (event_time_min == -1))
	253	event_time_min = ev->when;
	254	}
	255	}
	256	}
	257
	258	void
	259	rb_event_io_register_all(void)
	260	{
	261	rb_dlink_node *ptr;
	262	struct ev_entry *ev;
030272f3	263
db137867 AC	264	if(!rb_io_supports_event())
db137867 AC	265	return;
3202e249	266
db137867	267	RB_DLINK_FOREACH(ptr, event_list.head)
3202e249	268	{
db137867	269	ev = ptr->data;
030272f3	270	rb_io_sched_event(ev, ev->next);
db137867 AC	271	}
db137867 AC	272	}
3202e249	273
db137867 AC	274	/*
	275	* void rb_event_init(void)
	276	*
	277	* Input: None
	278	* Output: None
55abcbb2	279	* Side Effects: Initializes the event system.
db137867 AC	280	*/
	281	void
	282	rb_event_init(void)
	283	{
3202e249	284	rb_strlcpy(last_event_ran, "NONE", sizeof(last_event_ran));
db137867 AC	285	}
	286
	287	void
	288	rb_dump_events(void (func) (char , void ), void ptr)
	289	{
	290	int len;
	291	char buf[512];
	292	rb_dlink_node *dptr;
	293	struct ev_entry *ev;
	294	len = sizeof(buf);
3202e249	295
5203cba5	296	snprintf(buf, len, "Last event to run: %s", last_event_ran);
3202e249 VY	297	func(buf, ptr);
3202e249 VY	298
db137867 AC	299	rb_strlcpy(buf, "Operation Next Execution", len);
	300	func(buf, ptr);
	301
	302	RB_DLINK_FOREACH(dptr, event_list.head)
	303	{
	304	ev = dptr->data;
8ace0906 SA	305	snprintf(buf, len, "%-28s %-4ld seconds (frequency=%d)", ev->name,
8ace0906 SA	306	ev->when - (long)rb_current_time(), (int)ev->frequency);
db137867 AC	307	func(buf, ptr);
	308	}
	309	}
	310
55abcbb2	311	/*
db137867 AC	312	* void rb_set_back_events(time_t by)
	313	* Input: Time to set back events by.
	314	* Output: None.
	315	* Side-effects: Sets back all events by "by" seconds.
	316	*/
	317	void
	318	rb_set_back_events(time_t by)
	319	{
	320	rb_dlink_node *ptr;
	321	struct ev_entry *ev;
	322	RB_DLINK_FOREACH(ptr, event_list.head)
	323	{
	324	ev = ptr->data;
	325	if(ev->when > by)
	326	ev->when -= by;
	327	else
	328	ev->when = 0;
	329	}
	330	}
	331
	332	void
	333	rb_event_update(struct ev_entry *ev, time_t freq)
	334	{
	335	if(ev == NULL)
	336	return;
	337
	338	ev->frequency = freq;
	339
8ace0906	340	/* update when it's scheduled to run if it's higher
db137867 AC	341	* than the new frequency
db137867 AC	342	*/
8ace0906 SA	343	time_t next = rb_event_frequency(freq);
	344	if((rb_current_time() + next) < ev->when)
	345	ev->when = rb_current_time() + next;
db137867 AC	346	return;
	347	}
	348
	349	time_t
	350	rb_event_next(void)
	351	{
	352	return event_time_min;
	353	}