Module Name:    src
Committed By:   thorpej
Date:           Sat Oct 23 18:46:26 UTC 2021

Modified Files:
        src/distrib/sets/lists/debug: mi
        src/distrib/sets/lists/tests: mi
        src/sys/kern: kern_event.c
        src/tests/kernel/kqueue: Makefile
Added Files:
        src/tests/kernel/kqueue: t_oneshot.c

Log Message:
Fix a regression introduced in kern_event.c,v 1.129 that would cause
"udata" to get clobbered on ONESHOT events, and add a unit test for it.
Reported by martin@ (manifested in his case as a KASSERT() firing when
running unit tests in COMPAT_NETBSD32).


To generate a diff of this commit:
cvs rdiff -u -r1.366 -r1.367 src/distrib/sets/lists/debug/mi
cvs rdiff -u -r1.1154 -r1.1155 src/distrib/sets/lists/tests/mi
cvs rdiff -u -r1.137 -r1.138 src/sys/kern/kern_event.c
cvs rdiff -u -r1.8 -r1.9 src/tests/kernel/kqueue/Makefile
cvs rdiff -u -r0 -r1.1 src/tests/kernel/kqueue/t_oneshot.c

Please note that diffs are not public domain; they are subject to the
copyright notices on the relevant files.

Modified files:

Index: src/distrib/sets/lists/debug/mi
diff -u src/distrib/sets/lists/debug/mi:1.366 src/distrib/sets/lists/debug/mi:1.367
--- src/distrib/sets/lists/debug/mi:1.366	Sat Oct 23 01:28:33 2021
+++ src/distrib/sets/lists/debug/mi	Sat Oct 23 18:46:26 2021
@@ -1,4 +1,4 @@
-# $NetBSD: mi,v 1.366 2021/10/23 01:28:33 thorpej Exp $
+# $NetBSD: mi,v 1.367 2021/10/23 18:46:26 thorpej Exp $
 ./etc/mtree/set.debug                           comp-sys-root
 ./usr/lib					comp-sys-usr		compatdir
 ./usr/lib/i18n/libBIG5_g.a			comp-c-debuglib		debuglib,compatfile
@@ -1762,6 +1762,7 @@
 ./usr/libdata/debug/usr/tests/kernel/kqueue/read/t_ttypty.debug		tests-kernel-tests	debug,atf,compattestfile
 ./usr/libdata/debug/usr/tests/kernel/kqueue/t_empty.debug		tests-kernel-tests	debug,atf,compattestfile
 ./usr/libdata/debug/usr/tests/kernel/kqueue/t_ioctl.debug		tests-kernel-tests	debug,atf,compattestfile
+./usr/libdata/debug/usr/tests/kernel/kqueue/t_oneshot.debug		tests-kernel-tests	debug,atf,compattestfile
 ./usr/libdata/debug/usr/tests/kernel/kqueue/t_proc1.debug		tests-kernel-tests	debug,atf,compattestfile
 ./usr/libdata/debug/usr/tests/kernel/kqueue/t_proc2.debug		tests-kernel-tests	debug,atf,compattestfile
 ./usr/libdata/debug/usr/tests/kernel/kqueue/t_proc3.debug		tests-kernel-tests	debug,atf,compattestfile

Index: src/distrib/sets/lists/tests/mi
diff -u src/distrib/sets/lists/tests/mi:1.1154 src/distrib/sets/lists/tests/mi:1.1155
--- src/distrib/sets/lists/tests/mi:1.1154	Sat Oct 23 01:28:34 2021
+++ src/distrib/sets/lists/tests/mi	Sat Oct 23 18:46:26 2021
@@ -1,4 +1,4 @@
-# $NetBSD: mi,v 1.1154 2021/10/23 01:28:34 thorpej Exp $
+# $NetBSD: mi,v 1.1155 2021/10/23 18:46:26 thorpej Exp $
 #
 # Note: don't delete entries from here - mark them as "obsolete" instead.
 #
@@ -2182,6 +2182,7 @@
 ./usr/tests/kernel/kqueue/read/t_ttypty			tests-kernel-tests	compattestfile,atf
 ./usr/tests/kernel/kqueue/t_empty			tests-kernel-tests	compattestfile,atf
 ./usr/tests/kernel/kqueue/t_ioctl			tests-kernel-tests	compattestfile,atf
+./usr/tests/kernel/kqueue/t_oneshot			tests-kernel-tests	compattestfile,atf
 ./usr/tests/kernel/kqueue/t_proc1			tests-kernel-tests	compattestfile,atf
 ./usr/tests/kernel/kqueue/t_proc2			tests-kernel-tests	compattestfile,atf
 ./usr/tests/kernel/kqueue/t_proc3			tests-kernel-tests	compattestfile,atf

Index: src/sys/kern/kern_event.c
diff -u src/sys/kern/kern_event.c:1.137 src/sys/kern/kern_event.c:1.138
--- src/sys/kern/kern_event.c:1.137	Sat Oct 23 01:28:33 2021
+++ src/sys/kern/kern_event.c	Sat Oct 23 18:46:26 2021
@@ -1,4 +1,4 @@
-/*	$NetBSD: kern_event.c,v 1.137 2021/10/23 01:28:33 thorpej Exp $	*/
+/*	$NetBSD: kern_event.c,v 1.138 2021/10/23 18:46:26 thorpej Exp $	*/
 
 /*-
  * Copyright (c) 2008, 2009, 2021 The NetBSD Foundation, Inc.
@@ -63,7 +63,7 @@
 #endif /* _KERNEL_OPT */
 
 #include <sys/cdefs.h>
-__KERNEL_RCSID(0, "$NetBSD: kern_event.c,v 1.137 2021/10/23 01:28:33 thorpej Exp $");
+__KERNEL_RCSID(0, "$NetBSD: kern_event.c,v 1.138 2021/10/23 18:46:26 thorpej Exp $");
 
 #include <sys/param.h>
 #include <sys/systm.h>
@@ -2262,17 +2262,15 @@ relock:
 			}
 		} else {
 			/*
-			 * This ONESHOT note is going to be detached
-			 * below.  Mark the knote as not long for this
-			 * world before we release the kq lock so that
-			 * no one else will put it in a state of flux.
+			 * Must NOT drop kq_lock until we can do
+			 * the KNOTE_WILLDETACH() below.
 			 */
-			KNOTE_WILLDETACH(kn);
 		}
 		KASSERT(kn->kn_fop != NULL);
 		touch = (!(kn->kn_fop->f_flags & FILTEROP_ISFD) &&
 				kn->kn_fop->f_touch != NULL);
 		/* XXXAD should be got from f_event if !oneshot. */
+		KASSERT((kn->kn_status & KN_WILLDETACH) == 0);
 		if (touch) {
 			(void)filter_touch(kn, kevp, EVENT_PROCESS);
 		} else {
@@ -2283,6 +2281,7 @@ relock:
 		influx = 1;
 		if (kn->kn_flags & EV_ONESHOT) {
 			/* delete ONESHOT events after retrieval */
+			KNOTE_WILLDETACH(kn);
 			kn->kn_status &= ~KN_BUSY;
 			kq->kq_count--;
 			KASSERT(kn_in_flux(kn) == false);

Index: src/tests/kernel/kqueue/Makefile
diff -u src/tests/kernel/kqueue/Makefile:1.8 src/tests/kernel/kqueue/Makefile:1.9
--- src/tests/kernel/kqueue/Makefile:1.8	Sat Oct 23 01:28:33 2021
+++ src/tests/kernel/kqueue/Makefile	Sat Oct 23 18:46:26 2021
@@ -1,4 +1,4 @@
-# $NetBSD: Makefile,v 1.8 2021/10/23 01:28:33 thorpej Exp $
+# $NetBSD: Makefile,v 1.9 2021/10/23 18:46:26 thorpej Exp $
 
 WARNS?=6
 NOMAN=		# defined
@@ -12,6 +12,7 @@ TESTS_SUBDIRS+=	write
 
 TESTS_C=	t_empty
 TESTS_C+=	t_ioctl
+TESTS_C+=	t_oneshot
 TESTS_C+=	t_proc1
 TESTS_C+=	t_proc2
 TESTS_C+=	t_proc3

Added files:

Index: src/tests/kernel/kqueue/t_oneshot.c
diff -u /dev/null src/tests/kernel/kqueue/t_oneshot.c:1.1
--- /dev/null	Sat Oct 23 18:46:26 2021
+++ src/tests/kernel/kqueue/t_oneshot.c	Sat Oct 23 18:46:26 2021
@@ -0,0 +1,73 @@
+/* $NetBSD: t_oneshot.c,v 1.1 2021/10/23 18:46:26 thorpej Exp $ */
+
+/*-
+ * Copyright (c) 2021 The NetBSD Foundation, Inc.
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ * 1. Redistributions of source code must retain the above copyright
+ *    notice, this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright
+ *    notice, this list of conditions and the following disclaimer in the
+ *    documentation and/or other materials provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
+ * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
+ * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+ * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
+ * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
+
+#include <sys/cdefs.h>
+__RCSID("$NetBSD: t_oneshot.c,v 1.1 2021/10/23 18:46:26 thorpej Exp $");
+
+#include <sys/types.h>
+#include <sys/event.h>
+#include <errno.h>
+#include <stdio.h>
+#include <stdlib.h>
+#include <time.h>
+#include <unistd.h>
+
+#include <atf-c.h>
+
+#define	MY_UDATA	((void *)0xbeefcafe)
+
+ATF_TC(oneshot_udata);
+ATF_TC_HEAD(oneshot_udata, tc)
+{
+	atf_tc_set_md_var(tc, "descr",
+	    "tests that udata is round-tripped correctly for ONESHOT events.");
+}
+
+ATF_TC_BODY(oneshot_udata, tc)
+{
+	struct kevent event[1];
+	int kq;
+
+	ATF_REQUIRE((kq = kqueue()) >= 0);
+
+	EV_SET(&event[0], 1, EVFILT_TIMER, EV_ADD | EV_ONESHOT, 0, 1, MY_UDATA);
+
+	ATF_REQUIRE(kevent(kq, event, 1, NULL, 0, NULL) == 0);
+	memset(event, 0, sizeof(event));
+	ATF_REQUIRE(kevent(kq, NULL, 0, event, 1, NULL) == 1);
+	ATF_REQUIRE(event[0].ident == 1);
+	ATF_REQUIRE(event[0].data == 1);
+	ATF_REQUIRE(event[0].udata == MY_UDATA);
+}
+
+ATF_TP_ADD_TCS(tp)
+{
+	ATF_TP_ADD_TC(tp, oneshot_udata);
+
+	return atf_no_error();
+}

Reply via email to