summaryrefslogtreecommitdiff
path: root/tests/kernel/t_zombie.c
blob: 977aea168c4402f44275b49c3c51a75437a29f8e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
/*	$NetBSD: t_zombie.c,v 1.3 2022/05/24 20:08:38 andvar Exp $	*/

/*-
 * Copyright (c) 2018 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>
__COPYRIGHT("@(#) Copyright (c) 2018\
 The NetBSD Foundation, inc. All rights reserved.");
__RCSID("$NetBSD: t_zombie.c,v 1.3 2022/05/24 20:08:38 andvar Exp $");

#include <sys/types.h>
#include <sys/sysctl.h>
#include <sys/wait.h>
#include <errno.h>
#include <stdbool.h>
#include <stddef.h>
#include <stdio.h>
#include <stdlib.h>
#include <signal.h>
#include <time.h>
#include <unistd.h>
#include <err.h>

#include <atf-c.h>

static int debug = 0;

#define DPRINTF(a, ...)							\
do {									\
        if (debug) printf(a,  ##__VA_ARGS__);				\
} while (/*CONSTCOND*/0)

/*
 * A child process cannot call atf functions and expect them to magically
 * work like in the parent.
 * The printf(3) messaging from a child will not work out of the box as well
 * without establishing a communication protocol with its parent. To not
 * overcomplicate the tests - do not log from a child and use err(3)/errx(3)
 * wrapped with ASSERT_EQ()/ASSERT_NEQ() as that is guaranteed to work.
 */
#define ASSERT_EQ(x, y)								\
do {										\
	uintmax_t vx = (x);							\
	uintmax_t vy = (y);							\
	int ret = vx == vy;							\
	if (!ret)								\
		errx(EXIT_FAILURE, "%s:%d %s(): Assertion failed for: "		\
		    "%s(%ju) == %s(%ju)", __FILE__, __LINE__, __func__,		\
		    #x, vx, #y, vy);						\
} while (/*CONSTCOND*/0)

#define ASSERT_NEQ(x, y)							\
do {										\
	uintmax_t vx = (x);							\
	uintmax_t vy = (y);							\
	int ret = vx != vy;							\
	if (!ret)								\
		errx(EXIT_FAILURE, "%s:%d %s(): Assertion failed for: "		\
		    "%s(%ju) != %s(%ju)", __FILE__, __LINE__, __func__,		\
		    #x, vx, #y, vy);						\
} while (/*CONSTCOND*/0)

#define ASSERT(x)								\
do {										\
	int ret = (x);								\
	if (!ret)								\
		errx(EXIT_FAILURE, "%s:%d %s(): Assertion failed for: %s",	\
		     __FILE__, __LINE__, __func__, #x);				\
} while (/*CONSTCOND*/0)

static bool
check_zombie(pid_t process)
{
	struct kinfo_proc2 p;
	size_t len = sizeof(p);

	const int name[] = {
		[0] = CTL_KERN,
		[1] = KERN_PROC2,
		[2] = KERN_PROC_PID,
		[3] = process,
		[4] = sizeof(p),
		[5] = 1
	};

	const size_t namelen = __arraycount(name);

	ASSERT_EQ(sysctl(name, namelen, &p, &len, NULL, 0), 0);

	return (p.p_stat == LSZOMB);
}

static void __used
await_zombie(pid_t process)
{

	/* Await the process becoming a zombie */
	while (!check_zombie(process)) {
		ASSERT_EQ(usleep(100), 0);
	}
}

static void
signal_raw(int sig)
{
	int status;
	pid_t child1, child2, pid;

	child1 = atf_utils_fork();
	ATF_REQUIRE(child1 != -1);
	if (child1 == 0) {
		/* Just die and turn into a zombie */
		_exit(0);
	}

	child2 = atf_utils_fork();
	ATF_REQUIRE(child2 != -1);
	if (child2 == 0) {
		await_zombie(child1);

		/*
		 * zombie does not process signals
		 * POSIX requires that zombie does not set errno ESRCH
		 * return value of kill() for a zombie is not specified
		 *
		 * Try to emit a signal towards it from an unrelated process.
		 */
		errno = 0;
		kill(child1, sig);
		ASSERT_NEQ(errno, ESRCH);

		/* A zombie is still a zombie waiting for collecting */
		ASSERT(check_zombie(child1));

		_exit(0);
	}

	pid = waitpid(child2, &status, WEXITED);
	ATF_REQUIRE_EQ(pid, child2);
	ATF_REQUIRE(WIFEXITED(status));
	ATF_REQUIRE(!WIFCONTINUED(status));
	ATF_REQUIRE(!WIFSIGNALED(status));
	ATF_REQUIRE(!WIFSTOPPED(status));
	ATF_REQUIRE_EQ(WEXITSTATUS(status), 0);

	/* Assert that child1 is still a zombie after collecting child2 */
	ATF_REQUIRE(check_zombie(child1));

	/*
	 * zombie does not process signals
	 * POSIX requires that zombie does not set errno ESRCH
	 * return value of kill() for a zombie is not specified
	 *
	 * Try to emit a signal towards it from the parent.
	 */
	errno = 0;
	kill(child1, sig);
	// ATF_CHECK_NEQ not available
	ASSERT_NEQ(errno, ESRCH);

	/* Assert that child1 is still a zombie after emitting a signal */
	ATF_REQUIRE(check_zombie(child1));

	pid = waitpid(child1, &status, WEXITED);
	ATF_REQUIRE_EQ(pid, child1);
	ATF_REQUIRE(WIFEXITED(status));
	ATF_REQUIRE(!WIFCONTINUED(status));
	ATF_REQUIRE(!WIFSIGNALED(status));
	ATF_REQUIRE(!WIFSTOPPED(status));
	ATF_REQUIRE_EQ(WEXITSTATUS(status), 0);
}

#define KILLABLE(test, sig)							\
ATF_TC(test);									\
ATF_TC_HEAD(test, tc)								\
{										\
										\
	atf_tc_set_md_var(tc, "descr",						\
	    "process is not killable with " #sig);				\
}										\
										\
ATF_TC_BODY(test, tc)								\
{										\
										\
	signal_raw(sig);							\
}

KILLABLE(signal1, SIGKILL) /* non-maskable */
KILLABLE(signal2, SIGSTOP) /* non-maskable */
KILLABLE(signal3, SIGABRT) /* regular abort trap */
KILLABLE(signal4, SIGHUP)  /* hangup */
KILLABLE(signal5, SIGCONT) /* continued? */

ATF_TC(race1);
ATF_TC_HEAD(race1, tc)
{

	atf_tc_set_md_var(tc, "descr",
	    "check if there are any races with sending signals, killing and "
	    "lookup of a zombie");
}

ATF_TC_BODY(race1, tc)
{
        time_t start, end;
        double diff;
        unsigned long N = 0;
	int sig;

	/*
	 * Assert that a dying process can be correctly looked up
	 * with sysctl(3) kern.proc and operation KERN_PROC_PID.
	 *
	 * This test has been inspired by a bug fixed in
	 * sys/kern/kern_proc.c 1.211
	 * "Make sysctl_doeproc() more predictable"
	 */

        start = time(NULL);
        while (true) {
		/*
		 * A signal number does not matter, but it does not harm to
		 * randomize it.
		 *
		 * Skip signal 0 as sending to it to a zombie is not
		 * defined in POSIX, and explicitly discouraged.
		 */
		sig = 1 + arc4random_uniform(NSIG - 2);

                DPRINTF("Step: %lu (signal: %s)\n", N, signalname(sig));

		signal_raw(sig);
                end = time(NULL);
                diff = difftime(end, start);
                if (diff >= 5.0)
                        break;
                ++N;
        }
        DPRINTF("Iterations: %lu\n", N);
}

ATF_TP_ADD_TCS(tp)
{
	ATF_TP_ADD_TC(tp, signal1);
	ATF_TP_ADD_TC(tp, signal2);
	ATF_TP_ADD_TC(tp, signal3);
	ATF_TP_ADD_TC(tp, signal4);
	ATF_TP_ADD_TC(tp, signal5);

	ATF_TP_ADD_TC(tp, race1);

	return atf_no_error();
}