xref: /openbsd-src/regress/sys/kern/kqueue/kqueue-timer.c (revision 471dbed6557370adeb557cac0c11d495824c9214)

/*	$OpenBSD: kqueue-timer.c,v 1.5 2023/08/13 08:29:28 visa Exp $	*/
/*
 * Copyright (c) 2015 Bret Stephen Lambert <blambert@openbsd.org>
 *
 * Permission to use, copy, modify, and distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 */

#include <sys/types.h>
#include <sys/time.h>
#include <sys/event.h>

#include <err.h>
#include <errno.h>
#include <stdio.h>
#include <stdint.h>
#include <string.h>
#include <time.h>
#include <unistd.h>

#include "main.h"

int
do_timer(void)
{
	static const int units[] = {
		NOTE_SECONDS, NOTE_MSECONDS, NOTE_USECONDS, NOTE_NSECONDS
	};
	struct kevent ev;
	struct timespec ts, start, end, now;
	int64_t usecs;
	int i, kq, n;

	ASS((kq = kqueue()) >= 0,
	    warn("kqueue"));

	memset(&ev, 0, sizeof(ev));
	ev.filter = EVFILT_TIMER;
	ev.flags = EV_ADD | EV_ENABLE | EV_ONESHOT;
	ev.data = 500;			/* 1/2 second in ms */

	n = kevent(kq, &ev, 1, NULL, 0, NULL);
	ASSX(n != -1);

	ts.tv_sec = 2;			/* wait 2s for kqueue timeout */
	ts.tv_nsec = 0;

	n = kevent(kq, NULL, 0, &ev, 1, &ts);
	ASSX(n == 1);

	/* Now retry w/o EV_ONESHOT, as EV_CLEAR is implicit */

	memset(&ev, 0, sizeof(ev));
	ev.filter = EVFILT_TIMER;
	ev.flags = EV_ADD | EV_ENABLE;
	ev.data = 500;			/* 1/2 second in ms */

	n = kevent(kq, &ev, 1, NULL, 0, NULL);
	ASSX(n != -1);

	ts.tv_sec = 2;			/* wait 2s for kqueue timeout */
	ts.tv_nsec = 0;

	n = kevent(kq, NULL, 0, &ev, 1, &ts);
	ASSX(n == 1);

	/* Test with different time units */

	for (i = 0; i < sizeof(units) / sizeof(units[0]); i++) {
		memset(&ev, 0, sizeof(ev));
		ev.filter = EVFILT_TIMER;
		ev.flags = EV_ADD | EV_ENABLE;
		ev.fflags = units[i];
		ev.data = 1;

		n = kevent(kq, &ev, 1, NULL, 0, NULL);
		ASSX(n != -1);

		ts.tv_sec = 2;			/* wait 2s for kqueue timeout */
		ts.tv_nsec = 0;

		n = kevent(kq, NULL, 0, &ev, 1, &ts);
		ASSX(n == 1);

		/* Delete timer to clear EV_CLEAR */

		memset(&ev, 0, sizeof(ev));
		ev.filter = EVFILT_TIMER;
		ev.flags = EV_DELETE;

		n = kevent(kq, &ev, 1, NULL, 0, NULL);
		ASSX(n != -1);

		/* Test with NOTE_ABSTIME, deadline in the future */

		clock_gettime(CLOCK_MONOTONIC, &start);

		clock_gettime(CLOCK_REALTIME, &now);
		memset(&ev, 0, sizeof(ev));
		ev.filter = EVFILT_TIMER;
		ev.flags = EV_ADD | EV_ENABLE;
		ev.fflags = NOTE_ABSTIME | units[i];

		switch (units[i]) {
		case NOTE_SECONDS:
			ev.data = now.tv_sec + 1;
			break;
		case NOTE_MSECONDS:
			ev.data = now.tv_sec * 1000 + now.tv_nsec / 1000000
			     + 100;
			break;
		case NOTE_USECONDS:
			ev.data = now.tv_sec * 1000000 + now.tv_nsec / 1000
			    + 100 * 1000;
			break;
		case NOTE_NSECONDS:
			ev.data = now.tv_sec * 1000000000 + now.tv_nsec
			    + 100 * 1000000;
			break;
		}

		n = kevent(kq, &ev, 1, NULL, 0, NULL);
		ASSX(n != -1);

		ts.tv_sec = 2;			/* wait 2s for kqueue timeout */
		ts.tv_nsec = 0;

		n = kevent(kq, NULL, 0, &ev, 1, &ts);
		ASSX(n == 1);

		clock_gettime(CLOCK_MONOTONIC, &end);
		timespecsub(&end, &start, &ts);
		usecs = ts.tv_sec * 1000000 + ts.tv_nsec / 1000;
		ASSX(usecs > 0);
		ASSX(usecs < 1500000);		/* allow wide margin */

		/* Test with NOTE_ABSTIME, deadline in the past. */

		clock_gettime(CLOCK_MONOTONIC, &start);

		memset(&ev, 0, sizeof(ev));
		ev.filter = EVFILT_TIMER;
		ev.flags = EV_ADD | EV_ENABLE;
		ev.fflags = NOTE_ABSTIME | units[i];

		clock_gettime(CLOCK_REALTIME, &now);
		switch (units[i]) {
		case NOTE_SECONDS:
			ev.data = now.tv_sec - 1;
			break;
		case NOTE_MSECONDS:
			ev.data = now.tv_sec * 1000 + now.tv_nsec / 1000000
			     - 100;
			break;
		case NOTE_USECONDS:
			ev.data = now.tv_sec * 1000000 + now.tv_nsec / 1000
			    - 100 * 1000;
			break;
		case NOTE_NSECONDS:
			ev.data = now.tv_sec * 1000000000 + now.tv_nsec
			    - 100 * 1000000;
			break;
		}

		n = kevent(kq, &ev, 1, NULL, 0, NULL);
		ASSX(n != -1);

		n = kevent(kq, NULL, 0, &ev, 1, &ts);
		ASSX(n == 1);

		clock_gettime(CLOCK_MONOTONIC, &end);
		timespecsub(&end, &start, &ts);
		usecs = ts.tv_sec * 1000000 + ts.tv_nsec / 1000;
		ASSX(usecs > 0);
		ASSX(usecs < 100000);		/* allow wide margin */

		/* Test that the event remains active */

		ts.tv_sec = 2;			/* wait 2s for kqueue timeout */
		ts.tv_nsec = 0;

		n = kevent(kq, NULL, 0, &ev, 1, &ts);
		ASSX(n == 1);
	}

	return (0);
}

int
do_invalid_timer(void)
{
	int i, kq, n;
	struct kevent ev;
	struct timespec invalid_ts[3] = { {-1, 0}, {0, -1}, {0, 1000000000L} };

	ASS((kq = kqueue()) >= 0,
	    warn("kqueue"));

	memset(&ev, 0, sizeof(ev));
	ev.filter = EVFILT_TIMER;
	ev.flags = EV_ADD | EV_ENABLE;
	ev.data = 500;			/* 1/2 second in ms */

	n = kevent(kq, &ev, 1, NULL, 0, NULL);
	ASSX(n != -1);

	for (i = 0; i < 3; i++) {
		n = kevent(kq, NULL, 0, &ev, 1, &invalid_ts[i]);
		ASS(n == -1 && errno == EINVAL,
		    warn("kevent: timeout %lld %ld",
		    (long long)invalid_ts[i].tv_sec, invalid_ts[i].tv_nsec));
	}

	/* Test invalid fflags */

	memset(&ev, 0, sizeof(ev));
	ev.filter = EVFILT_TIMER;
	ev.flags = EV_ADD | EV_ENABLE;
	ev.fflags = ~NOTE_SECONDS;
	ev.data = 1;

	n = kevent(kq, &ev, 1, NULL, 0, NULL);
	ASSX(n == -1 && errno == EINVAL);

	memset(&ev, 0, sizeof(ev));
	ev.filter = EVFILT_TIMER;
	ev.flags = EV_ADD | EV_ENABLE;
	ev.fflags = NOTE_MSECONDS;
	ev.data = 500;

	n = kevent(kq, &ev, 1, NULL, 0, NULL);
	ASSX(n == 0);

	/* Modify the existing timer */

	memset(&ev, 0, sizeof(ev));
	ev.filter = EVFILT_TIMER;
	ev.flags = EV_ADD | EV_ENABLE;
	ev.fflags = ~NOTE_SECONDS;
	ev.data = 1;

	n = kevent(kq, &ev, 1, NULL, 0, NULL);
	ASSX(n == -1 && errno == EINVAL);

	return (0);
}

int
do_reset_timer(void)
{
	int kq, msecs, n;
	struct kevent ev;
	struct timespec ts, start, end;

	ASS((kq = kqueue()) >= 0,
	    warn("kqueue"));

	clock_gettime(CLOCK_MONOTONIC, &start);

	memset(&ev, 0, sizeof(ev));
	ev.filter = EVFILT_TIMER;
	ev.flags = EV_ADD | EV_ENABLE | EV_ONESHOT;
	ev.data = 10;

	n = kevent(kq, &ev, 1, NULL, 0, NULL);
	ASSX(n != -1);

	/* Let the timer expire. */
	usleep(100000);

	/* Reset the expired timer. */
	ev.data = 60000;
	n = kevent(kq, &ev, 1, NULL, 0, NULL);
	ASSX(n != -1);

	/* Check that no event is pending. */
	ts.tv_sec = 0;
	ts.tv_nsec = 0;
	n = kevent(kq, NULL, 0, &ev, 1, &ts);
	ASSX(n == 0);

	/* Reset again for quick expiry. */
	memset(&ev, 0, sizeof(ev));
	ev.filter = EVFILT_TIMER;
	ev.flags = EV_ADD | EV_ENABLE | EV_ONESHOT;
	ev.data = 100;
	n = kevent(kq, &ev, 1, NULL, 0, NULL);
	ASSX(n != -1);

	/* Wait for expiry. */
	n = kevent(kq, NULL, 0, &ev, 1, NULL);
	ASSX(n == 1);

	clock_gettime(CLOCK_MONOTONIC, &end);
	timespecsub(&end, &start, &ts);
	msecs = ts.tv_sec * 1000 + ts.tv_nsec / 1000000;
	ASSX(msecs > 200);
	ASSX(msecs < 5000);	/* allow wide margin */

	return (0);
}