xref: /freebsd/usr.sbin/rtadvd/timer.c (revision 8a16b7a18f5d0b031f09832fd7752fba717e2a97)
1ae326725SJun-ichiro itojun Hagino /*	$FreeBSD$	*/
2fa19f9beSHajimu UMEMOTO /*	$KAME: timer.c,v 1.9 2002/06/10 19:59:47 itojun Exp $	*/
3b26e03e9SKris Kennaway 
4*8a16b7a1SPedro F. Giffuni /*-
5*8a16b7a1SPedro F. Giffuni  * SPDX-License-Identifier: BSD-3-Clause
6*8a16b7a1SPedro F. Giffuni  *
79a4365d0SYoshinobu Inoue  * Copyright (C) 1998 WIDE Project.
837241896SHiroki Sato  * Copyright (C) 2011 Hiroki Sato <hrs@FreeBSD.org>
99a4365d0SYoshinobu Inoue  * All rights reserved.
109a4365d0SYoshinobu Inoue  *
119a4365d0SYoshinobu Inoue  * Redistribution and use in source and binary forms, with or without
129a4365d0SYoshinobu Inoue  * modification, are permitted provided that the following conditions
139a4365d0SYoshinobu Inoue  * are met:
149a4365d0SYoshinobu Inoue  * 1. Redistributions of source code must retain the above copyright
159a4365d0SYoshinobu Inoue  *    notice, this list of conditions and the following disclaimer.
169a4365d0SYoshinobu Inoue  * 2. Redistributions in binary form must reproduce the above copyright
179a4365d0SYoshinobu Inoue  *    notice, this list of conditions and the following disclaimer in the
189a4365d0SYoshinobu Inoue  *    documentation and/or other materials provided with the distribution.
199a4365d0SYoshinobu Inoue  * 3. Neither the name of the project nor the names of its contributors
209a4365d0SYoshinobu Inoue  *    may be used to endorse or promote products derived from this software
219a4365d0SYoshinobu Inoue  *    without specific prior written permission.
229a4365d0SYoshinobu Inoue  *
239a4365d0SYoshinobu Inoue  * THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
249a4365d0SYoshinobu Inoue  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
259a4365d0SYoshinobu Inoue  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
269a4365d0SYoshinobu Inoue  * ARE DISCLAIMED.  IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
279a4365d0SYoshinobu Inoue  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
289a4365d0SYoshinobu Inoue  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
299a4365d0SYoshinobu Inoue  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
309a4365d0SYoshinobu Inoue  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
319a4365d0SYoshinobu Inoue  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
329a4365d0SYoshinobu Inoue  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
339a4365d0SYoshinobu Inoue  * SUCH DAMAGE.
349a4365d0SYoshinobu Inoue  */
359a4365d0SYoshinobu Inoue 
36db82af41SHiroki Sato #include <sys/queue.h>
3737241896SHiroki Sato #include <sys/socket.h>
3837241896SHiroki Sato 
3937241896SHiroki Sato #include <net/if.h>
4037241896SHiroki Sato #include <net/if_dl.h>
4137241896SHiroki Sato #include <netinet/in.h>
429a4365d0SYoshinobu Inoue 
439a4365d0SYoshinobu Inoue #include <unistd.h>
449a4365d0SYoshinobu Inoue #include <syslog.h>
459a4365d0SYoshinobu Inoue #include <stdlib.h>
469a4365d0SYoshinobu Inoue #include <string.h>
4772286081SSUZUKI Shinsuke #include <search.h>
487d26db17SHiroki Sato #include <time.h>
4937241896SHiroki Sato #include <netdb.h>
509a4365d0SYoshinobu Inoue 
5137241896SHiroki Sato #include "rtadvd.h"
5237241896SHiroki Sato #include "timer_subr.h"
5337241896SHiroki Sato #include "timer.h"
549a4365d0SYoshinobu Inoue 
55db82af41SHiroki Sato struct rtadvd_timer_head_t ra_timer =
56db82af41SHiroki Sato     TAILQ_HEAD_INITIALIZER(ra_timer);
577d26db17SHiroki Sato static struct timespec tm_limit;
587d26db17SHiroki Sato static struct timespec tm_max;
599a4365d0SYoshinobu Inoue 
609a4365d0SYoshinobu Inoue void
61db82af41SHiroki Sato rtadvd_timer_init(void)
629a4365d0SYoshinobu Inoue {
637d26db17SHiroki Sato 	/* Generate maximum time in timespec. */
6437743840SHiroki Sato 	tm_limit.tv_sec = (-1) & ~((time_t)1 << ((sizeof(tm_max.tv_sec) * 8) - 1));
6537743840SHiroki Sato 	tm_limit.tv_nsec = (-1) & ~((long)1 << ((sizeof(tm_max.tv_nsec) * 8) - 1));
66db82af41SHiroki Sato 	tm_max = tm_limit;
67db82af41SHiroki Sato 	TAILQ_INIT(&ra_timer);
689a4365d0SYoshinobu Inoue }
699a4365d0SYoshinobu Inoue 
7037241896SHiroki Sato void
7137241896SHiroki Sato rtadvd_update_timeout_handler(void)
7237241896SHiroki Sato {
7337241896SHiroki Sato 	struct ifinfo *ifi;
7437241896SHiroki Sato 
7537241896SHiroki Sato 	TAILQ_FOREACH(ifi, &ifilist, ifi_next) {
7637241896SHiroki Sato 		switch (ifi->ifi_state) {
7737241896SHiroki Sato 		case IFI_STATE_CONFIGURED:
7837241896SHiroki Sato 		case IFI_STATE_TRANSITIVE:
7937241896SHiroki Sato 			if (ifi->ifi_ra_timer != NULL)
8037241896SHiroki Sato 				continue;
8137241896SHiroki Sato 
8237241896SHiroki Sato 			syslog(LOG_DEBUG, "<%s> add timer for %s (idx=%d)",
8337241896SHiroki Sato 			    __func__, ifi->ifi_ifname, ifi->ifi_ifindex);
8437241896SHiroki Sato 			ifi->ifi_ra_timer = rtadvd_add_timer(ra_timeout,
8537241896SHiroki Sato 			    ra_timer_update, ifi, ifi);
8637241896SHiroki Sato 			ra_timer_update((void *)ifi,
8737241896SHiroki Sato 			    &ifi->ifi_ra_timer->rat_tm);
8837241896SHiroki Sato 			rtadvd_set_timer(&ifi->ifi_ra_timer->rat_tm,
8937241896SHiroki Sato 			    ifi->ifi_ra_timer);
9037241896SHiroki Sato 			break;
9137241896SHiroki Sato 		case IFI_STATE_UNCONFIGURED:
9237241896SHiroki Sato 			if (ifi->ifi_ra_timer == NULL)
9337241896SHiroki Sato 				continue;
9437241896SHiroki Sato 
9537241896SHiroki Sato 			syslog(LOG_DEBUG,
9637241896SHiroki Sato 			    "<%s> remove timer for %s (idx=%d)", __func__,
9737241896SHiroki Sato 			    ifi->ifi_ifname, ifi->ifi_ifindex);
9837241896SHiroki Sato 			rtadvd_remove_timer(ifi->ifi_ra_timer);
9937241896SHiroki Sato 			ifi->ifi_ra_timer = NULL;
10037241896SHiroki Sato 			break;
10137241896SHiroki Sato 		}
10237241896SHiroki Sato 	}
10337241896SHiroki Sato 
10437241896SHiroki Sato 	return;
10537241896SHiroki Sato }
10637241896SHiroki Sato 
1079a4365d0SYoshinobu Inoue struct rtadvd_timer *
108784bddbcSKevin Lo rtadvd_add_timer(struct rtadvd_timer *(*timeout)(void *),
1097d26db17SHiroki Sato     void (*update)(void *, struct timespec *),
1109a4365d0SYoshinobu Inoue     void *timeodata, void *updatedata)
1119a4365d0SYoshinobu Inoue {
112db82af41SHiroki Sato 	struct rtadvd_timer *rat;
1139a4365d0SYoshinobu Inoue 
1149a4365d0SYoshinobu Inoue 	if (timeout == NULL) {
1159a4365d0SYoshinobu Inoue 		syslog(LOG_ERR,
116fa19f9beSHajimu UMEMOTO 		    "<%s> timeout function unspecified", __func__);
1179a4365d0SYoshinobu Inoue 		exit(1);
1189a4365d0SYoshinobu Inoue 	}
119db82af41SHiroki Sato 
120db82af41SHiroki Sato 	rat = malloc(sizeof(*rat));
121db82af41SHiroki Sato 	if (rat == NULL) {
122db82af41SHiroki Sato 		syslog(LOG_ERR,
123db82af41SHiroki Sato 		    "<%s> can't allocate memory", __func__);
124db82af41SHiroki Sato 		exit(1);
125db82af41SHiroki Sato 	}
126db82af41SHiroki Sato 	memset(rat, 0, sizeof(*rat));
127db82af41SHiroki Sato 
128db82af41SHiroki Sato 	rat->rat_expire = timeout;
129db82af41SHiroki Sato 	rat->rat_update = update;
130db82af41SHiroki Sato 	rat->rat_expire_data = timeodata;
131db82af41SHiroki Sato 	rat->rat_update_data = updatedata;
132db82af41SHiroki Sato 	rat->rat_tm = tm_max;
1339a4365d0SYoshinobu Inoue 
1349a4365d0SYoshinobu Inoue 	/* link into chain */
135db82af41SHiroki Sato 	TAILQ_INSERT_TAIL(&ra_timer, rat, rat_next);
1369a4365d0SYoshinobu Inoue 
137db82af41SHiroki Sato 	return (rat);
1389a4365d0SYoshinobu Inoue }
1399a4365d0SYoshinobu Inoue 
1409a4365d0SYoshinobu Inoue void
141db82af41SHiroki Sato rtadvd_remove_timer(struct rtadvd_timer *rat)
142b26e03e9SKris Kennaway {
143db82af41SHiroki Sato 
144db82af41SHiroki Sato 	if (rat == NULL)
145db82af41SHiroki Sato 		return;
146db82af41SHiroki Sato 
147db82af41SHiroki Sato 	TAILQ_REMOVE(&ra_timer, rat, rat_next);
148db82af41SHiroki Sato 	free(rat);
149b26e03e9SKris Kennaway }
150b26e03e9SKris Kennaway 
1519a4365d0SYoshinobu Inoue /*
1520a5f3ef4SHajimu UMEMOTO  * Check expiration for each timer. If a timer expires,
1539a4365d0SYoshinobu Inoue  * call the expire function for the timer and update the timer.
1549a4365d0SYoshinobu Inoue  * Return the next interval for select() call.
1559a4365d0SYoshinobu Inoue  */
1567d26db17SHiroki Sato struct timespec *
157db82af41SHiroki Sato rtadvd_check_timer(void)
1589a4365d0SYoshinobu Inoue {
1597d26db17SHiroki Sato 	static struct timespec returnval;
1607d26db17SHiroki Sato 	struct timespec now;
161db82af41SHiroki Sato 	struct rtadvd_timer *rat;
1629a4365d0SYoshinobu Inoue 
1637d26db17SHiroki Sato 	clock_gettime(CLOCK_MONOTONIC_FAST, &now);
164db82af41SHiroki Sato 	tm_max = tm_limit;
165db82af41SHiroki Sato 	TAILQ_FOREACH(rat, &ra_timer, rat_next) {
1667d26db17SHiroki Sato 		if (TS_CMP(&rat->rat_tm, &now, <=)) {
167db82af41SHiroki Sato 			if (((*rat->rat_expire)(rat->rat_expire_data) == NULL))
1680a5f3ef4SHajimu UMEMOTO 				continue; /* the timer was removed */
169db82af41SHiroki Sato 			if (rat->rat_update)
170db82af41SHiroki Sato 				(*rat->rat_update)(rat->rat_update_data, &rat->rat_tm);
1717d26db17SHiroki Sato 			TS_ADD(&rat->rat_tm, &now, &rat->rat_tm);
1729a4365d0SYoshinobu Inoue 		}
1737d26db17SHiroki Sato 		if (TS_CMP(&rat->rat_tm, &tm_max, <))
174db82af41SHiroki Sato 			tm_max = rat->rat_tm;
1759a4365d0SYoshinobu Inoue 	}
1767d26db17SHiroki Sato 	if (TS_CMP(&tm_max, &tm_limit, ==)) {
177b26e03e9SKris Kennaway 		/* no need to timeout */
178b26e03e9SKris Kennaway 		return (NULL);
1797d26db17SHiroki Sato 	} else if (TS_CMP(&tm_max, &now, <)) {
1809a4365d0SYoshinobu Inoue 		/* this may occur when the interval is too small */
1817d26db17SHiroki Sato 		returnval.tv_sec = returnval.tv_nsec = 0;
182fa19f9beSHajimu UMEMOTO 	} else
1837d26db17SHiroki Sato 		TS_SUB(&tm_max, &now, &returnval);
1849a4365d0SYoshinobu Inoue 	return (&returnval);
1859a4365d0SYoshinobu Inoue }
1869a4365d0SYoshinobu Inoue 
18737241896SHiroki Sato void
1887d26db17SHiroki Sato rtadvd_set_timer(struct timespec *tm, struct rtadvd_timer *rat)
1899a4365d0SYoshinobu Inoue {
1907d26db17SHiroki Sato 	struct timespec now;
1919a4365d0SYoshinobu Inoue 
19237241896SHiroki Sato 	/* reset the timer */
1937d26db17SHiroki Sato 	clock_gettime(CLOCK_MONOTONIC_FAST, &now);
1947d26db17SHiroki Sato 	TS_ADD(&now, tm, &rat->rat_tm);
1959a4365d0SYoshinobu Inoue 
19637241896SHiroki Sato 	/* update the next expiration time */
1977d26db17SHiroki Sato 	if (TS_CMP(&rat->rat_tm, &tm_max, <))
19837241896SHiroki Sato 		tm_max = rat->rat_tm;
1999a4365d0SYoshinobu Inoue 
20037241896SHiroki Sato 	return;
2019a4365d0SYoshinobu Inoue }
202