xref: /netbsd-src/usr.sbin/rtadvd/timer.c (revision 5bbd2a12505d72a8177929a37b5cee489d0a1cfd)
1 /*	$NetBSD: timer.c,v 1.10 2011/12/10 19:14:29 roy Exp $	*/
2 /*	$KAME: timer.c,v 1.11 2005/04/14 06:22:35 suz Exp $	*/
3 
4 /*
5  * Copyright (C) 1998 WIDE Project.
6  * All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  * 3. Neither the name of the project nor the names of its contributors
17  *    may be used to endorse or promote products derived from this software
18  *    without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
21  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23  * ARE DISCLAIMED.  IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
24  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30  * SUCH DAMAGE.
31  */
32 
33 #include <sys/queue.h>
34 #include <sys/time.h>
35 
36 #include <unistd.h>
37 #include <syslog.h>
38 #include <stdlib.h>
39 #include <string.h>
40 #include <search.h>
41 #include "timer.h"
42 
43 struct rtadvd_timer_head_t ra_timer = TAILQ_HEAD_INITIALIZER(ra_timer);
44 
45 #define MILLION 1000000
46 #define TIMEVAL_EQUAL(t1,t2) ((t1)->tv_sec == (t2)->tv_sec &&\
47  (t1)->tv_usec == (t2)->tv_usec)
48 
49 static struct timeval tm_limit = {0x7fffffff, 0x7fffffff};
50 static struct timeval tm_max;
51 
52 void
53 rtadvd_timer_init(void)
54 {
55 
56 	TAILQ_INIT(&ra_timer);
57 	tm_max = tm_limit;
58 }
59 
60 struct rtadvd_timer *
61 rtadvd_add_timer(struct rtadvd_timer *(*timeout) (void *),
62     void (*update) (void *, struct timeval *),
63     void *timeodata, void *updatedata)
64 {
65 	struct rtadvd_timer *newtimer;
66 
67 	if ((newtimer = malloc(sizeof(*newtimer))) == NULL) {
68 		syslog(LOG_ERR,
69 		       "<%s> can't allocate memory", __func__);
70 		exit(1);
71 	}
72 
73 	memset(newtimer, 0, sizeof(*newtimer));
74 
75 	if (timeout == NULL) {
76 		syslog(LOG_ERR,
77 		       "<%s> timeout function unspecified", __func__);
78 		exit(1);
79 	}
80 	newtimer->expire = timeout;
81 	newtimer->update = update;
82 	newtimer->expire_data = timeodata;
83 	newtimer->update_data = updatedata;
84 	newtimer->tm = tm_max;
85 
86 	/* link into chain */
87 	TAILQ_INSERT_TAIL(&ra_timer, newtimer, next);
88 
89 	return(newtimer);
90 }
91 
92 void
93 rtadvd_remove_timer(struct rtadvd_timer **timer)
94 {
95 
96 	TAILQ_REMOVE(&ra_timer, *timer, next);
97 	free(*timer);
98 	*timer = NULL;
99 }
100 
101 void
102 rtadvd_set_timer(struct timeval *tm, struct rtadvd_timer *timer)
103 {
104 	struct timeval now;
105 
106 	/* reset the timer */
107 	gettimeofday(&now, NULL);
108 
109 	TIMEVAL_ADD(&now, tm, &timer->tm);
110 
111 	/* update the next expiration time */
112 	if (TIMEVAL_LT(timer->tm, tm_max))
113 		tm_max = timer->tm;
114 
115 	return;
116 }
117 
118 /*
119  * Check expiration for each timer. If a timer expires,
120  * call the expire function for the timer and update the timer.
121  * Return the next interval for select() call.
122  */
123 struct timeval *
124 rtadvd_check_timer(void)
125 {
126 	static struct timeval returnval;
127 	struct timeval now;
128 	struct rtadvd_timer *tm;
129 
130 	gettimeofday(&now, NULL);
131 	tm_max = tm_limit;
132 
133 	TAILQ_FOREACH(tm, &ra_timer, next) {
134 		if (TIMEVAL_LEQ(tm->tm, now)) {
135 			if ((*tm->expire)(tm->expire_data) == NULL)
136 				continue; /* the timer was removed */
137 			if (tm->update)
138 				(*tm->update)(tm->update_data, &tm->tm);
139 			TIMEVAL_ADD(&tm->tm, &now, &tm->tm);
140 		}
141 
142 		if (TIMEVAL_LT(tm->tm, tm_max))
143 			tm_max = tm->tm;
144 	}
145 
146 	if (TIMEVAL_EQUAL(&tm_max, &tm_limit)) {
147 		/* no need to timeout */
148 		return(NULL);
149 	} else if (TIMEVAL_LT(tm_max, now)) {
150 		/* this may occur when the interval is too small */
151 		returnval.tv_sec = returnval.tv_usec = 0;
152 	} else
153 		TIMEVAL_SUB(&tm_max, &now, &returnval);
154 	return(&returnval);
155 }
156 
157 struct timeval *
158 rtadvd_timer_rest(struct rtadvd_timer *timer)
159 {
160 	static struct timeval returnval, now;
161 
162 	gettimeofday(&now, NULL);
163 	if (TIMEVAL_LEQ(timer->tm, now)) {
164 		syslog(LOG_DEBUG,
165 		       "<%s> a timer must be expired, but not yet",
166 		       __func__);
167 		returnval.tv_sec = returnval.tv_usec = 0;
168 	}
169 	else
170 		TIMEVAL_SUB(&timer->tm, &now, &returnval);
171 
172 	return(&returnval);
173 }
174 
175 /* result = a + b */
176 void
177 TIMEVAL_ADD(struct timeval *a, struct timeval *b, struct timeval *result)
178 {
179 	long l;
180 
181 	if ((l = a->tv_usec + b->tv_usec) < MILLION) {
182 		result->tv_usec = l;
183 		result->tv_sec = a->tv_sec + b->tv_sec;
184 	}
185 	else {
186 		result->tv_usec = l - MILLION;
187 		result->tv_sec = a->tv_sec + b->tv_sec + 1;
188 	}
189 }
190 
191 /*
192  * result = a - b
193  * XXX: this function assumes that a >= b.
194  */
195 void
196 TIMEVAL_SUB(struct timeval *a, struct timeval *b, struct timeval *result)
197 {
198 	long l;
199 
200 	if ((l = a->tv_usec - b->tv_usec) >= 0) {
201 		result->tv_usec = l;
202 		result->tv_sec = a->tv_sec - b->tv_sec;
203 	}
204 	else {
205 		result->tv_usec = MILLION + l;
206 		result->tv_sec = a->tv_sec - b->tv_sec - 1;
207 	}
208 }
209