Home | History | Annotate | Line # | Download | only in sys
t_ptrace_wait.h revision 1.35
      1  1.35  riastrad /*	$NetBSD: t_ptrace_wait.h,v 1.35 2024/05/14 16:04:17 riastradh Exp $	*/
      2   1.1     kamil 
      3   1.1     kamil /*-
      4  1.14     kamil  * Copyright (c) 2016, 2017, 2018, 2019 The NetBSD Foundation, Inc.
      5   1.1     kamil  * All rights reserved.
      6   1.1     kamil  *
      7   1.1     kamil  * Redistribution and use in source and binary forms, with or without
      8   1.1     kamil  * modification, are permitted provided that the following conditions
      9   1.1     kamil  * are met:
     10   1.1     kamil  * 1. Redistributions of source code must retain the above copyright
     11   1.1     kamil  *    notice, this list of conditions and the following disclaimer.
     12   1.1     kamil  * 2. Redistributions in binary form must reproduce the above copyright
     13   1.1     kamil  *    notice, this list of conditions and the following disclaimer in the
     14   1.1     kamil  *    documentation and/or other materials provided with the distribution.
     15   1.1     kamil  *
     16   1.1     kamil  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
     17   1.1     kamil  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
     18   1.1     kamil  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
     19   1.1     kamil  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
     20   1.1     kamil  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
     21   1.1     kamil  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
     22   1.1     kamil  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
     23   1.1     kamil  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
     24   1.1     kamil  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
     25   1.1     kamil  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
     26   1.1     kamil  * POSSIBILITY OF SUCH DAMAGE.
     27   1.1     kamil  */
     28   1.1     kamil 
     29   1.1     kamil /* Detect plain wait(2) use-case */
     30   1.1     kamil #if !defined(TWAIT_WAITPID) && \
     31   1.1     kamil     !defined(TWAIT_WAITID) && \
     32   1.1     kamil     !defined(TWAIT_WAIT3) && \
     33   1.1     kamil     !defined(TWAIT_WAIT4) && \
     34   1.1     kamil     !defined(TWAIT_WAIT6)
     35   1.1     kamil #define TWAIT_WAIT
     36   1.1     kamil #endif
     37   1.1     kamil 
     38   1.1     kamil /*
     39   1.1     kamil  * There are two classes of wait(2)-like functions:
     40   1.1     kamil  * - wait4(2)-like accepting pid_t, optional options parameter, struct rusage*
     41   1.1     kamil  * - wait6(2)-like accepting idtype_t, id_t, struct wrusage, mandatory options
     42   1.1     kamil  *
     43   1.1     kamil  * The TWAIT_FNAME value is to be used for convenience in debug messages.
     44   1.1     kamil  *
     45   1.1     kamil  * The TWAIT_GENERIC() macro is designed to reuse the same unmodified
     46   1.1     kamil  * code with as many wait(2)-like functions as possible.
     47   1.1     kamil  *
     48   1.1     kamil  * In a common use-case wait4(2) and wait6(2)-like function can work the almost
     49   1.1     kamil  * the same way, however there are few important differences:
     50   1.1     kamil  * wait6(2) must specify P_PID for idtype to match wpid from wait4(2).
     51   1.1     kamil  * To behave like wait4(2), wait6(2) the 'options' to wait must include
     52   1.1     kamil  * WEXITED|WTRUNCATED.
     53   1.1     kamil  *
     54   1.1     kamil  * There are two helper macros (they purpose it to mach more than one
     55   1.1     kamil  * wait(2)-like function):
     56   1.1     kamil  * The TWAIT_HAVE_STATUS - specifies whether a function can retrieve
     57   1.1     kamil  *                         status (as integer value).
     58   1.1     kamil  * The TWAIT_HAVE_PID    - specifies whether a function can request
     59   1.1     kamil  *                         exact process identifier
     60   1.1     kamil  * The TWAIT_HAVE_RUSAGE - specifies whether a function can request
     61   1.1     kamil  *                         the struct rusage value
     62   1.1     kamil  *
     63   1.1     kamil  */
     64   1.1     kamil 
     65   1.1     kamil #if defined(TWAIT_WAIT)
     66   1.1     kamil #	define TWAIT_FNAME			"wait"
     67   1.1     kamil #	define TWAIT_WAIT4TYPE(a,b,c,d)		wait((b))
     68   1.1     kamil #	define TWAIT_GENERIC(a,b,c)		wait((b))
     69   1.1     kamil #	define TWAIT_HAVE_STATUS		1
     70   1.1     kamil #elif defined(TWAIT_WAITPID)
     71   1.1     kamil #	define TWAIT_FNAME			"waitpid"
     72   1.1     kamil #	define TWAIT_WAIT4TYPE(a,b,c,d)		waitpid((a),(b),(c))
     73   1.1     kamil #	define TWAIT_GENERIC(a,b,c)		waitpid((a),(b),(c))
     74   1.1     kamil #	define TWAIT_HAVE_PID			1
     75   1.1     kamil #	define TWAIT_HAVE_STATUS		1
     76  1.19     kamil #	define TWAIT_HAVE_OPTIONS		1
     77   1.1     kamil #elif defined(TWAIT_WAITID)
     78   1.1     kamil #	define TWAIT_FNAME			"waitid"
     79   1.1     kamil #	define TWAIT_GENERIC(a,b,c)		\
     80   1.1     kamil 		waitid(P_PID,(a),NULL,(c)|WEXITED|WTRAPPED)
     81   1.1     kamil #	define TWAIT_WAIT6TYPE(a,b,c,d,e,f)	waitid((a),(b),(f),(d))
     82   1.1     kamil #	define TWAIT_HAVE_PID			1
     83  1.19     kamil #	define TWAIT_HAVE_OPTIONS		1
     84   1.1     kamil #elif defined(TWAIT_WAIT3)
     85   1.1     kamil #	define TWAIT_FNAME			"wait3"
     86   1.1     kamil #	define TWAIT_WAIT4TYPE(a,b,c,d)		wait3((b),(c),(d))
     87   1.1     kamil #	define TWAIT_GENERIC(a,b,c)		wait3((b),(c),NULL)
     88   1.1     kamil #	define TWAIT_HAVE_STATUS		1
     89   1.1     kamil #	define TWAIT_HAVE_RUSAGE		1
     90  1.19     kamil #	define TWAIT_HAVE_OPTIONS		1
     91   1.1     kamil #elif defined(TWAIT_WAIT4)
     92   1.1     kamil #	define TWAIT_FNAME			"wait4"
     93   1.1     kamil #	define TWAIT_WAIT4TYPE(a,b,c,d)		wait4((a),(b),(c),(d))
     94   1.1     kamil #	define TWAIT_GENERIC(a,b,c)		wait4((a),(b),(c),NULL)
     95   1.1     kamil #	define TWAIT_HAVE_PID			1
     96   1.1     kamil #	define TWAIT_HAVE_STATUS		1
     97   1.1     kamil #	define TWAIT_HAVE_RUSAGE		1
     98  1.19     kamil #	define TWAIT_HAVE_OPTIONS		1
     99   1.1     kamil #elif defined(TWAIT_WAIT6)
    100   1.1     kamil #	define TWAIT_FNAME			"wait6"
    101   1.1     kamil #	define TWAIT_WAIT6TYPE(a,b,c,d,e,f)	wait6((a),(b),(c),(d),(e),(f))
    102   1.1     kamil #	define TWAIT_GENERIC(a,b,c)		\
    103   1.1     kamil 		wait6(P_PID,(a),(b),(c)|WEXITED|WTRAPPED,NULL,NULL)
    104   1.1     kamil #	define TWAIT_HAVE_PID			1
    105   1.1     kamil #	define TWAIT_HAVE_STATUS		1
    106  1.19     kamil #	define TWAIT_HAVE_OPTIONS		1
    107   1.1     kamil #endif
    108   1.1     kamil 
    109   1.1     kamil /*
    110   1.1     kamil  * There are 3 groups of tests:
    111   1.1     kamil  * - TWAIT_GENERIC()	(wait, wait2, waitpid, wait3, wait4, wait6)
    112   1.1     kamil  * - TWAIT_WAIT4TYPE()	(wait2, waitpid, wait3, wait4)
    113   1.1     kamil  * - TWAIT_WAIT6TYPE()	(waitid, wait6)
    114   1.1     kamil  *
    115   1.1     kamil  * Tests only in the above categories are allowed. However some tests are not
    116   1.1     kamil  * possible in the context requested functionality to be verified, therefore
    117   1.1     kamil  * there are helper macros:
    118   1.1     kamil  * - TWAIT_HAVE_PID	(wait2, waitpid, waitid, wait4, wait6)
    119   1.1     kamil  * - TWAIT_HAVE_STATUS	(wait, wait2, waitpid, wait3, wait4, wait6)
    120   1.1     kamil  * - TWAIT_HAVE_RUSAGE	(wait3, wait4)
    121   1.1     kamil  * - TWAIT_HAVE_RETPID	(wait, wait2, waitpid, wait3, wait4, wait6)
    122   1.1     kamil  *
    123   1.1     kamil  * If there is an intention to test e.g. wait6(2) specific features in the
    124   1.1     kamil  * ptrace(2) context, find the most matching group and with #ifdefs reduce
    125   1.1     kamil  * functionality of less featured than wait6(2) interface (TWAIT_WAIT6TYPE).
    126   1.1     kamil  *
    127   1.1     kamil  * For clarity never use negative preprocessor checks, like:
    128   1.1     kamil  *     #if !defined(TWAIT_WAIT4)
    129   1.1     kamil  * always refer to checks for positive values.
    130   1.1     kamil  */
    131   1.1     kamil 
    132   1.1     kamil #define TEST_REQUIRE_EQ(x, y)						\
    133   1.1     kamil do {									\
    134   1.1     kamil 	uintmax_t vx = (x);						\
    135   1.1     kamil 	uintmax_t vy = (y);						\
    136   1.1     kamil 	int ret = vx == vy;						\
    137   1.1     kamil 	if (!ret)							\
    138   1.1     kamil 		ATF_REQUIRE_EQ_MSG(vx, vy, "%s(%ju) == %s(%ju)", 	\
    139   1.1     kamil 		    #x, vx, #y, vy);					\
    140   1.1     kamil } while (/*CONSTCOND*/0)
    141   1.1     kamil 
    142   1.1     kamil /*
    143   1.1     kamil  * A child process cannot call atf functions and expect them to magically
    144   1.1     kamil  * work like in the parent.
    145   1.1     kamil  * The printf(3) messaging from a child will not work out of the box as well
    146  1.34    andvar  * without establishing a communication protocol with its parent. To not
    147   1.1     kamil  * overcomplicate the tests - do not log from a child and use err(3)/errx(3)
    148   1.1     kamil  * wrapped with FORKEE_ASSERT()/FORKEE_ASSERTX() as that is guaranteed to work.
    149   1.1     kamil  */
    150   1.1     kamil #define FORKEE_ASSERT_EQ(x, y)						\
    151   1.1     kamil do {									\
    152   1.1     kamil 	uintmax_t vx = (x);						\
    153   1.1     kamil 	uintmax_t vy = (y);						\
    154   1.1     kamil 	int ret = vx == vy;						\
    155   1.1     kamil 	if (!ret)							\
    156   1.1     kamil 		errx(EXIT_FAILURE, "%s:%d %s(): Assertion failed for: "	\
    157   1.1     kamil 		    "%s(%ju) == %s(%ju)", __FILE__, __LINE__, __func__,	\
    158   1.1     kamil 		    #x, vx, #y, vy);					\
    159   1.1     kamil } while (/*CONSTCOND*/0)
    160   1.1     kamil 
    161   1.5     kamil #define FORKEE_ASSERT_NEQ(x, y)						\
    162   1.5     kamil do {									\
    163   1.5     kamil 	uintmax_t vx = (x);						\
    164   1.5     kamil 	uintmax_t vy = (y);						\
    165   1.5     kamil 	int ret = vx != vy;						\
    166   1.5     kamil 	if (!ret)							\
    167   1.5     kamil 		errx(EXIT_FAILURE, "%s:%d %s(): Assertion failed for: "	\
    168   1.5     kamil 		    "%s(%ju) != %s(%ju)", __FILE__, __LINE__, __func__,	\
    169   1.5     kamil 		    #x, vx, #y, vy);					\
    170   1.5     kamil } while (/*CONSTCOND*/0)
    171   1.5     kamil 
    172   1.1     kamil #define FORKEE_ASSERTX(x)						\
    173   1.1     kamil do {									\
    174   1.1     kamil 	int ret = (x);							\
    175   1.1     kamil 	if (!ret)							\
    176   1.1     kamil 		errx(EXIT_FAILURE, "%s:%d %s(): Assertion failed for: %s",\
    177   1.1     kamil 		     __FILE__, __LINE__, __func__, #x);			\
    178   1.1     kamil } while (/*CONSTCOND*/0)
    179   1.1     kamil 
    180   1.1     kamil #define FORKEE_ASSERT(x)						\
    181   1.1     kamil do {									\
    182   1.1     kamil 	int ret = (x);							\
    183   1.1     kamil 	if (!ret)							\
    184   1.1     kamil 		err(EXIT_FAILURE, "%s:%d %s(): Assertion failed for: %s",\
    185   1.1     kamil 		     __FILE__, __LINE__, __func__, #x);			\
    186   1.1     kamil } while (/*CONSTCOND*/0)
    187   1.1     kamil 
    188   1.1     kamil /*
    189   1.1     kamil  * Simplify logic for functions using general purpose registers add HAVE_GPREGS
    190   1.1     kamil  *
    191   1.1     kamil  * For platforms that do not implement all needed calls for simplicity assume
    192   1.1     kamil  * that they are unsupported at all.
    193   1.1     kamil  */
    194   1.1     kamil #if defined(PT_GETREGS)			\
    195   1.1     kamil     && defined(PT_SETREGS)		\
    196   1.1     kamil     && defined(PTRACE_REG_PC)		\
    197   1.1     kamil     && defined(PTRACE_REG_SET_PC)	\
    198   1.1     kamil     && defined(PTRACE_REG_SP)		\
    199   1.1     kamil     && defined(PTRACE_REG_INTRV)
    200   1.1     kamil #define HAVE_GPREGS
    201   1.1     kamil #endif
    202   1.1     kamil 
    203   1.1     kamil /* Add guards for floating point registers */
    204   1.1     kamil #if defined(PT_GETFPREGS)		\
    205   1.1     kamil     && defined(PT_SETFPREGS)
    206   1.1     kamil #define HAVE_FPREGS
    207   1.1     kamil #endif
    208   1.1     kamil 
    209   1.1     kamil /* Add guards for cpu debug registers */
    210   1.1     kamil #if defined(PT_GETDBREGS)		\
    211   1.1     kamil     && defined(PT_SETDBREGS)
    212   1.1     kamil #define HAVE_DBREGS
    213   1.1     kamil #endif
    214   1.1     kamil 
    215   1.1     kamil /*
    216   1.1     kamil  * If waitid(2) returns because one or more processes have a state change to
    217   1.1     kamil  * report, 0 is returned.  If an error is detected, a value of -1 is returned
    218   1.1     kamil  * and errno is set to indicate the error. If WNOHANG is specified and there
    219   1.1     kamil  * are no stopped, continued or exited children, 0 is returned.
    220   1.1     kamil  */
    221   1.1     kamil #if defined(TWAIT_WAITID)
    222   1.1     kamil #define TWAIT_REQUIRE_SUCCESS(a,b)	TEST_REQUIRE_EQ((a), 0)
    223   1.1     kamil #define TWAIT_REQUIRE_FAILURE(a,b)	ATF_REQUIRE_ERRNO((a),(b) == -1)
    224   1.1     kamil #define FORKEE_REQUIRE_SUCCESS(a,b)	FORKEE_ASSERT_EQ(a, 0)
    225   1.1     kamil #define FORKEE_REQUIRE_FAILURE(a,b)	\
    226   1.1     kamil 	FORKEE_ASSERTX(((a) == errno) && ((b) == -1))
    227   1.1     kamil #else
    228   1.1     kamil #define TWAIT_REQUIRE_SUCCESS(a,b)	TEST_REQUIRE_EQ((a), (b))
    229   1.1     kamil #define TWAIT_REQUIRE_FAILURE(a,b)	ATF_REQUIRE_ERRNO((a),(b) == -1)
    230   1.1     kamil #define FORKEE_REQUIRE_SUCCESS(a,b)	FORKEE_ASSERT_EQ(a, b)
    231   1.1     kamil #define FORKEE_REQUIRE_FAILURE(a,b)	\
    232   1.1     kamil 	FORKEE_ASSERTX(((a) == errno) && ((b) == -1))
    233   1.1     kamil #endif
    234   1.1     kamil 
    235   1.1     kamil /*
    236   1.1     kamil  * Helper tools to verify whether status reports exited value
    237   1.1     kamil  */
    238   1.1     kamil #if TWAIT_HAVE_STATUS
    239   1.1     kamil static void __used
    240   1.1     kamil validate_status_exited(int status, int expected)
    241   1.1     kamil {
    242   1.1     kamil         ATF_REQUIRE_MSG(WIFEXITED(status), "Reported !exited process");
    243   1.1     kamil         ATF_REQUIRE_MSG(!WIFCONTINUED(status), "Reported continued process");
    244   1.1     kamil         ATF_REQUIRE_MSG(!WIFSIGNALED(status), "Reported signaled process");
    245   1.1     kamil         ATF_REQUIRE_MSG(!WIFSTOPPED(status), "Reported stopped process");
    246   1.1     kamil 
    247   1.1     kamil 	ATF_REQUIRE_EQ_MSG(WEXITSTATUS(status), expected,
    248   1.1     kamil 	    "The process has exited with invalid value %d != %d",
    249   1.1     kamil 	    WEXITSTATUS(status), expected);
    250   1.1     kamil }
    251   1.1     kamil 
    252   1.1     kamil static void __used
    253   1.1     kamil forkee_status_exited(int status, int expected)
    254   1.1     kamil {
    255   1.1     kamil 	FORKEE_ASSERTX(WIFEXITED(status));
    256   1.1     kamil 	FORKEE_ASSERTX(!WIFCONTINUED(status));
    257   1.1     kamil 	FORKEE_ASSERTX(!WIFSIGNALED(status));
    258   1.1     kamil 	FORKEE_ASSERTX(!WIFSTOPPED(status));
    259   1.1     kamil 
    260   1.1     kamil 	FORKEE_ASSERT_EQ(WEXITSTATUS(status), expected);
    261   1.1     kamil }
    262   1.1     kamil 
    263   1.1     kamil static void __used
    264   1.1     kamil validate_status_continued(int status)
    265   1.1     kamil {
    266   1.1     kamil 	ATF_REQUIRE_MSG(!WIFEXITED(status), "Reported exited process");
    267   1.1     kamil 	ATF_REQUIRE_MSG(WIFCONTINUED(status), "Reported !continued process");
    268   1.1     kamil 	ATF_REQUIRE_MSG(!WIFSIGNALED(status), "Reported signaled process");
    269   1.1     kamil 	ATF_REQUIRE_MSG(!WIFSTOPPED(status), "Reported stopped process");
    270   1.1     kamil }
    271   1.1     kamil 
    272   1.1     kamil static void __used
    273   1.1     kamil forkee_status_continued(int status)
    274   1.1     kamil {
    275   1.1     kamil 	FORKEE_ASSERTX(!WIFEXITED(status));
    276   1.1     kamil 	FORKEE_ASSERTX(WIFCONTINUED(status));
    277   1.1     kamil 	FORKEE_ASSERTX(!WIFSIGNALED(status));
    278   1.1     kamil 	FORKEE_ASSERTX(!WIFSTOPPED(status));
    279   1.1     kamil }
    280   1.1     kamil 
    281   1.1     kamil static void __used
    282   1.1     kamil validate_status_signaled(int status, int expected_termsig, int expected_core)
    283   1.1     kamil {
    284   1.1     kamil 	ATF_REQUIRE_MSG(!WIFEXITED(status), "Reported exited process");
    285   1.1     kamil 	ATF_REQUIRE_MSG(!WIFCONTINUED(status), "Reported continued process");
    286   1.1     kamil 	ATF_REQUIRE_MSG(WIFSIGNALED(status), "Reported !signaled process");
    287   1.1     kamil 	ATF_REQUIRE_MSG(!WIFSTOPPED(status), "Reported stopped process");
    288   1.1     kamil 
    289   1.1     kamil 	ATF_REQUIRE_EQ_MSG(WTERMSIG(status), expected_termsig,
    290   1.1     kamil 	    "Unexpected signal received");
    291   1.1     kamil 
    292   1.3     kamil 	ATF_REQUIRE_EQ_MSG(!!WCOREDUMP(status), expected_core,
    293   1.1     kamil 	    "Unexpectedly core file %s generated", expected_core ? "not" : "");
    294   1.1     kamil }
    295   1.1     kamil 
    296   1.1     kamil static void __used
    297   1.1     kamil forkee_status_signaled(int status, int expected_termsig, int expected_core)
    298   1.1     kamil {
    299   1.1     kamil 	FORKEE_ASSERTX(!WIFEXITED(status));
    300   1.1     kamil 	FORKEE_ASSERTX(!WIFCONTINUED(status));
    301   1.1     kamil 	FORKEE_ASSERTX(WIFSIGNALED(status));
    302   1.1     kamil 	FORKEE_ASSERTX(!WIFSTOPPED(status));
    303   1.1     kamil 
    304   1.1     kamil 	FORKEE_ASSERT_EQ(WTERMSIG(status), expected_termsig);
    305   1.3     kamil 	FORKEE_ASSERT_EQ(!!WCOREDUMP(status), expected_core);
    306   1.1     kamil }
    307   1.1     kamil 
    308   1.1     kamil static void __used
    309   1.1     kamil validate_status_stopped(int status, int expected)
    310   1.1     kamil {
    311   1.1     kamil 	ATF_REQUIRE_MSG(!WIFEXITED(status), "Reported exited process");
    312   1.1     kamil 	ATF_REQUIRE_MSG(!WIFCONTINUED(status), "Reported continued process");
    313   1.1     kamil 	ATF_REQUIRE_MSG(!WIFSIGNALED(status), "Reported signaled process");
    314   1.1     kamil 	ATF_REQUIRE_MSG(WIFSTOPPED(status), "Reported !stopped process");
    315   1.1     kamil 
    316   1.1     kamil 	char st[128], ex[128];
    317   1.1     kamil 	strlcpy(st, strsignal(WSTOPSIG(status)), sizeof(st));
    318   1.1     kamil 	strlcpy(ex, strsignal(expected), sizeof(ex));
    319   1.1     kamil 
    320   1.1     kamil 	ATF_REQUIRE_EQ_MSG(WSTOPSIG(status), expected,
    321   1.1     kamil 	    "Unexpected stop signal received [%s] != [%s]", st, ex);
    322   1.1     kamil }
    323   1.1     kamil 
    324   1.1     kamil static void __used
    325   1.1     kamil forkee_status_stopped(int status, int expected)
    326   1.1     kamil {
    327   1.1     kamil 	FORKEE_ASSERTX(!WIFEXITED(status));
    328   1.1     kamil 	FORKEE_ASSERTX(!WIFCONTINUED(status));
    329   1.1     kamil 	FORKEE_ASSERTX(!WIFSIGNALED(status));
    330   1.1     kamil 	FORKEE_ASSERTX(WIFSTOPPED(status));
    331   1.1     kamil 
    332   1.1     kamil 	FORKEE_ASSERT_EQ(WSTOPSIG(status), expected);
    333   1.1     kamil }
    334   1.1     kamil #else
    335   1.1     kamil #define validate_status_exited(a,b)
    336   1.1     kamil #define forkee_status_exited(a,b)
    337   1.1     kamil #define validate_status_continued(a,b)
    338   1.1     kamil #define forkee_status_continued(a,b)
    339   1.1     kamil #define validate_status_signaled(a,b,c)
    340   1.1     kamil #define forkee_status_signaled(a,b,c)
    341   1.1     kamil #define validate_status_stopped(a,b)
    342   1.1     kamil #define forkee_status_stopped(a,b)
    343   1.1     kamil #endif
    344   1.1     kamil 
    345   1.1     kamil /* This function is currently designed to be run in the main/parent process */
    346   1.1     kamil static void __used
    347   1.2     kamil await_zombie_raw(pid_t process, useconds_t ms)
    348   1.1     kamil {
    349   1.1     kamil 	struct kinfo_proc2 p;
    350   1.1     kamil 	size_t len = sizeof(p);
    351   1.1     kamil 
    352   1.1     kamil 	const int name[] = {
    353   1.1     kamil 		[0] = CTL_KERN,
    354   1.1     kamil 		[1] = KERN_PROC2,
    355   1.1     kamil 		[2] = KERN_PROC_PID,
    356   1.1     kamil 		[3] = process,
    357   1.1     kamil 		[4] = sizeof(p),
    358   1.1     kamil 		[5] = 1
    359   1.1     kamil 	};
    360   1.1     kamil 
    361   1.1     kamil 	const size_t namelen = __arraycount(name);
    362   1.1     kamil 
    363   1.1     kamil 	/* Await the process becoming a zombie */
    364   1.1     kamil 	while(1) {
    365   1.1     kamil 		ATF_REQUIRE(sysctl(name, namelen, &p, &len, NULL, 0) == 0);
    366   1.1     kamil 
    367   1.1     kamil 		if (p.p_stat == LSZOMB)
    368   1.1     kamil 			break;
    369   1.1     kamil 
    370   1.2     kamil 		if (ms > 0) {
    371   1.2     kamil 			ATF_REQUIRE(usleep(ms) == 0);
    372   1.2     kamil 		}
    373   1.1     kamil 	}
    374   1.1     kamil }
    375   1.1     kamil 
    376   1.2     kamil static void __used
    377   1.2     kamil await_zombie(pid_t process)
    378   1.2     kamil {
    379   1.2     kamil 
    380   1.2     kamil 	await_zombie_raw(process, 1000);
    381   1.2     kamil }
    382   1.2     kamil 
    383  1.12     kamil static void __used
    384  1.12     kamil await_stopped(pid_t process)
    385  1.12     kamil {
    386  1.12     kamil 	struct kinfo_proc2 p;
    387  1.12     kamil 	size_t len = sizeof(p);
    388  1.12     kamil 
    389  1.12     kamil 	const int name[] = {
    390  1.12     kamil 		[0] = CTL_KERN,
    391  1.12     kamil 		[1] = KERN_PROC2,
    392  1.12     kamil 		[2] = KERN_PROC_PID,
    393  1.12     kamil 		[3] = process,
    394  1.12     kamil 		[4] = sizeof(p),
    395  1.12     kamil 		[5] = 1
    396  1.12     kamil 	};
    397  1.12     kamil 
    398  1.12     kamil 	const size_t namelen = __arraycount(name);
    399  1.12     kamil 
    400  1.12     kamil 	/* Await the process becoming a zombie */
    401  1.12     kamil 	while(1) {
    402  1.12     kamil 		ATF_REQUIRE(sysctl(name, namelen, &p, &len, NULL, 0) == 0);
    403  1.12     kamil 
    404  1.12     kamil 		if (p.p_stat == LSSTOP)
    405  1.12     kamil 			break;
    406  1.12     kamil 
    407  1.12     kamil 		ATF_REQUIRE(usleep(1000) == 0);
    408  1.12     kamil 	}
    409  1.12     kamil }
    410  1.12     kamil 
    411   1.5     kamil static pid_t __used
    412   1.5     kamil await_stopped_child(pid_t process)
    413   1.5     kamil {
    414   1.5     kamil 	struct kinfo_proc2 *p = NULL;
    415   1.5     kamil 	size_t i, len;
    416   1.5     kamil 	pid_t child = -1;
    417   1.5     kamil 
    418   1.5     kamil 	int name[] = {
    419   1.5     kamil 		[0] = CTL_KERN,
    420   1.5     kamil 		[1] = KERN_PROC2,
    421   1.5     kamil 		[2] = KERN_PROC_ALL,
    422   1.5     kamil 		[3] = 0,
    423   1.5     kamil 		[4] = sizeof(struct kinfo_proc2),
    424   1.5     kamil 		[5] = 0
    425   1.5     kamil 	};
    426   1.5     kamil 
    427   1.5     kamil 	const size_t namelen = __arraycount(name);
    428   1.5     kamil 
    429   1.5     kamil 	/* Await the process becoming a zombie */
    430   1.5     kamil 	while(1) {
    431   1.5     kamil 		name[5] = 0;
    432   1.5     kamil 
    433   1.5     kamil 		FORKEE_ASSERT_EQ(sysctl(name, namelen, 0, &len, NULL, 0), 0);
    434   1.5     kamil 
    435   1.5     kamil 		FORKEE_ASSERT_EQ(reallocarr(&p,
    436   1.5     kamil 		                            len,
    437   1.5     kamil 		                            sizeof(struct kinfo_proc2)), 0);
    438   1.5     kamil 
    439   1.5     kamil 		name[5] = len;
    440   1.5     kamil 
    441   1.5     kamil 		FORKEE_ASSERT_EQ(sysctl(name, namelen, p, &len, NULL, 0), 0);
    442   1.5     kamil 
    443   1.5     kamil 		for (i = 0; i < len/sizeof(struct kinfo_proc2); i++) {
    444   1.5     kamil 			if (p[i].p_pid == getpid())
    445   1.5     kamil 				continue;
    446   1.5     kamil 			if (p[i].p_ppid != process)
    447   1.5     kamil 				continue;
    448   1.5     kamil 			if (p[i].p_stat != LSSTOP)
    449   1.5     kamil 				continue;
    450   1.5     kamil 			child = p[i].p_pid;
    451   1.5     kamil 			break;
    452   1.5     kamil 		}
    453   1.5     kamil 
    454   1.5     kamil 		if (child != -1)
    455   1.5     kamil 			break;
    456   1.5     kamil 
    457   1.5     kamil 		FORKEE_ASSERT_EQ(usleep(1000), 0);
    458   1.5     kamil 	}
    459   1.5     kamil 
    460   1.5     kamil 	/* Free the buffer */
    461   1.5     kamil 	FORKEE_ASSERT_EQ(reallocarr(&p, 0, sizeof(struct kinfo_proc2)), 0);
    462   1.5     kamil 
    463   1.5     kamil 	return child;
    464   1.5     kamil }
    465   1.5     kamil 
    466  1.24     kamil static void __used
    467  1.24     kamil await_collected(pid_t process)
    468  1.24     kamil {
    469  1.24     kamil 	struct kinfo_proc2 p;
    470  1.24     kamil 	size_t len = sizeof(p);
    471  1.24     kamil 
    472  1.24     kamil 	const int name[] = {
    473  1.24     kamil 		[0] = CTL_KERN,
    474  1.24     kamil 		[1] = KERN_PROC2,
    475  1.24     kamil 		[2] = KERN_PROC_PID,
    476  1.24     kamil 		[3] = process,
    477  1.24     kamil 		[4] = sizeof(p),
    478  1.24     kamil 		[5] = 1
    479  1.24     kamil 	};
    480  1.24     kamil 
    481  1.24     kamil 	const size_t namelen = __arraycount(name);
    482  1.24     kamil 
    483  1.24     kamil 	/* Await the process to disappear */
    484  1.24     kamil 	while(1) {
    485  1.24     kamil 		FORKEE_ASSERT_EQ(sysctl(name, namelen, &p, &len, NULL, 0), 0);
    486  1.24     kamil 		if (len == 0)
    487  1.24     kamil 			break;
    488  1.24     kamil 
    489  1.24     kamil 		ATF_REQUIRE(usleep(1000) == 0);
    490  1.24     kamil 	}
    491  1.24     kamil }
    492  1.24     kamil 
    493   1.1     kamil /* Happy number sequence -- this function is used to just consume cpu cycles */
    494   1.1     kamil #define	HAPPY_NUMBER	1
    495   1.1     kamil 
    496   1.1     kamil /* If n is not happy then its sequence ends in the cycle:
    497   1.1     kamil  * 4, 16, 37, 58, 89, 145, 42, 20, 4, ... */
    498   1.1     kamil #define	SAD_NUMBER	4
    499   1.1     kamil 
    500   1.1     kamil /* Calculate the sum of the squares of the digits of n */
    501   1.1     kamil static unsigned __used
    502   1.1     kamil dsum(unsigned n)
    503   1.1     kamil {
    504   1.1     kamil 	unsigned sum, x;
    505   1.1     kamil 	for (sum = 0; n; n /= 10) {
    506   1.1     kamil 		x = n % 10;
    507   1.1     kamil 		sum += x * x;
    508   1.1     kamil 	}
    509   1.1     kamil 	return sum;
    510   1.1     kamil }
    511   1.1     kamil 
    512   1.1     kamil /*
    513   1.1     kamil  * XXX: Disabled optimization is required to make tests for hardware assisted
    514   1.1     kamil  * traps in .text functional
    515   1.1     kamil  *
    516   1.1     kamil  * Tested with GCC 5.4 on NetBSD 7.99.47 amd64
    517   1.1     kamil  */
    518   1.1     kamil static int __used
    519   1.1     kamil #ifdef __clang__
    520   1.1     kamil __attribute__((__optnone__))
    521   1.1     kamil #else
    522   1.1     kamil __attribute__((__optimize__("O0")))
    523   1.1     kamil #endif
    524   1.1     kamil check_happy(unsigned n)
    525   1.1     kamil {
    526   1.1     kamil 	for (;;) {
    527   1.1     kamil 		unsigned total = dsum(n);
    528   1.1     kamil 
    529   1.1     kamil 		if (total == HAPPY_NUMBER)
    530   1.1     kamil 			return 1;
    531   1.1     kamil 		if (total == SAD_NUMBER)
    532   1.1     kamil 			return 0;
    533   1.1     kamil 
    534   1.1     kamil 		n = total;
    535   1.1     kamil 	}
    536   1.1     kamil }
    537   1.1     kamil 
    538  1.14     kamil static void * __used
    539  1.13     kamil infinite_thread(void *arg __unused)
    540  1.13     kamil {
    541  1.13     kamil 
    542  1.13     kamil         while (true)
    543  1.13     kamil                 continue;
    544  1.13     kamil 
    545  1.13     kamil         __unreachable();
    546  1.13     kamil }
    547  1.13     kamil 
    548  1.15     kamil static int __used
    549  1.15     kamil clone_func(void *arg)
    550  1.15     kamil {
    551  1.15     kamil 	int ret;
    552  1.15     kamil 
    553  1.15     kamil 	ret = (int)(intptr_t)arg;
    554  1.15     kamil 
    555  1.15     kamil 	return ret;
    556  1.15     kamil }
    557  1.15     kamil 
    558   1.4     kamil #if defined(HAVE_DBREGS)
    559   1.6     kamil static bool __used
    560   1.4     kamil can_we_set_dbregs(void)
    561   1.4     kamil {
    562   1.4     kamil 	static long euid = -1;
    563   1.4     kamil 	static int user_set_dbregs  = -1;
    564   1.4     kamil 	size_t user_set_dbregs_len = sizeof(user_set_dbregs);
    565   1.4     kamil 
    566   1.4     kamil 	if (euid == -1)
    567   1.4     kamil 		euid = geteuid();
    568   1.4     kamil 
    569   1.4     kamil 	if (euid == 0)
    570   1.4     kamil 		return true;
    571   1.4     kamil 
    572   1.4     kamil 	if (user_set_dbregs == -1) {
    573   1.4     kamil 		if (sysctlbyname("security.models.extensions.user_set_dbregs",
    574   1.4     kamil 			&user_set_dbregs, &user_set_dbregs_len, NULL, 0)
    575   1.4     kamil 			== -1) {
    576   1.4     kamil 			return false;
    577   1.4     kamil 		}
    578   1.4     kamil 	}
    579   1.4     kamil 
    580   1.4     kamil 	if (user_set_dbregs > 0)
    581   1.4     kamil 		return true;
    582   1.4     kamil 	else
    583   1.4     kamil 		return false;
    584   1.4     kamil }
    585   1.4     kamil #endif
    586   1.4     kamil 
    587   1.8     kamil static bool __used
    588  1.17     kamil get_user_va0_disable(void)
    589  1.17     kamil {
    590  1.17     kamil 	static int user_va0_disable = -1;
    591  1.17     kamil 	size_t user_va0_disable_len = sizeof(user_va0_disable);
    592  1.17     kamil 
    593  1.17     kamil 	if (user_va0_disable == -1) {
    594  1.17     kamil 		if (sysctlbyname("vm.user_va0_disable",
    595  1.17     kamil 			&user_va0_disable, &user_va0_disable_len, NULL, 0)
    596  1.17     kamil 			== -1) {
    597  1.17     kamil 			return true;
    598  1.17     kamil 		}
    599  1.17     kamil 	}
    600  1.17     kamil 
    601  1.17     kamil 	if (user_va0_disable > 0)
    602  1.17     kamil 		return true;
    603  1.17     kamil 	else
    604  1.17     kamil 		return false;
    605  1.17     kamil }
    606  1.17     kamil 
    607  1.17     kamil static bool __used
    608   1.8     kamil can_we_write_to_text(pid_t pid)
    609   1.8     kamil {
    610   1.8     kamil 	int mib[3];
    611   1.8     kamil 	int paxflags;
    612   1.8     kamil 	size_t len = sizeof(int);
    613   1.8     kamil 
    614   1.8     kamil 	mib[0] = CTL_PROC;
    615   1.8     kamil 	mib[1] = pid;
    616   1.8     kamil 	mib[2] = PROC_PID_PAXFLAGS;
    617   1.8     kamil 
    618   1.8     kamil 	if (sysctl(mib, 3, &paxflags, &len, NULL, 0) == -1)
    619   1.8     kamil 		return false;
    620   1.8     kamil 
    621   1.8     kamil 	return !(paxflags & CTL_PROC_PAXFLAGS_MPROTECT);
    622   1.8     kamil }
    623   1.8     kamil 
    624   1.6     kamil static void __used
    625   1.6     kamil trigger_trap(void)
    626   1.6     kamil {
    627   1.6     kamil 
    628   1.6     kamil 	/* Software breakpoint causes CPU trap, translated to SIGTRAP */
    629   1.6     kamil #ifdef PTRACE_BREAKPOINT_ASM
    630   1.6     kamil 	PTRACE_BREAKPOINT_ASM;
    631   1.6     kamil #else
    632   1.6     kamil 	/* port me */
    633   1.6     kamil #endif
    634   1.6     kamil }
    635   1.6     kamil 
    636   1.6     kamil static void __used
    637   1.6     kamil trigger_segv(void)
    638   1.6     kamil {
    639   1.6     kamil 	static volatile char *ptr = NULL;
    640   1.6     kamil 
    641   1.6     kamil 	/* Access to unmapped memory causes CPU trap, translated to SIGSEGV */
    642   1.6     kamil 	*ptr = 1;
    643   1.6     kamil }
    644   1.6     kamil 
    645   1.6     kamil static void __used
    646   1.6     kamil trigger_ill(void)
    647   1.6     kamil {
    648   1.6     kamil 
    649   1.6     kamil 	/* Illegal instruction causes CPU trap, translated to SIGILL */
    650   1.6     kamil #ifdef PTRACE_ILLEGAL_ASM
    651  1.33      gson #ifndef __mips__ /* To avoid GXemul crash */
    652   1.6     kamil 	PTRACE_ILLEGAL_ASM;
    653  1.33      gson #endif
    654   1.6     kamil #else
    655   1.6     kamil 	/* port me */
    656   1.6     kamil #endif
    657   1.6     kamil }
    658   1.6     kamil 
    659  1.25  christos #include <fenv.h>
    660  1.25  christos 
    661  1.25  christos #if (__arm__ && !__SOFTFP__) || __aarch64__
    662  1.25  christos #include <ieeefp.h> /* only need for ARM Cortex/Neon hack */
    663  1.25  christos 
    664  1.16     kamil static bool __used
    665  1.16     kamil are_fpu_exceptions_supported(void)
    666  1.16     kamil {
    667  1.16     kamil 	/*
    668  1.16     kamil 	 * Some NEON fpus do not trap on IEEE 754 FP exceptions.
    669  1.16     kamil 	 * Skip these tests if running on them and compiled for
    670  1.16     kamil 	 * hard float.
    671  1.16     kamil 	 */
    672  1.16     kamil 	if (0 == fpsetmask(fpsetmask(FP_X_INV)))
    673  1.16     kamil 		return false;
    674  1.16     kamil 	return true;
    675  1.16     kamil }
    676  1.25  christos #else
    677  1.26     kamil #define are_fpu_exceptions_supported() 1
    678  1.25  christos #endif
    679  1.16     kamil 
    680  1.35  riastrad volatile double ignore_result;
    681  1.35  riastrad 
    682   1.9     kamil static void __used
    683   1.6     kamil trigger_fpe(void)
    684   1.6     kamil {
    685  1.32       rin #if __i386__ || __x86_64__
    686  1.32       rin 	/*
    687  1.32       rin 	 * XXX
    688  1.32       rin 	 * Hack for QEMU bug #1668041, by which floating-point division by
    689  1.32       rin 	 * zero is not trapped correctly. Also, assertions for si_code in
    690  1.32       rin 	 * ptrace_signal_wait.h are commented out. Clean them up after the
    691  1.32       rin 	 * bug is fixed.
    692  1.32       rin 	 */
    693  1.32       rin 	volatile int a, b;
    694  1.32       rin #else
    695  1.32       rin 	volatile double a, b;
    696  1.32       rin #endif
    697  1.32       rin 
    698  1.32       rin 	a = getpid();
    699  1.32       rin 	b = atoi("0");
    700   1.6     kamil 
    701  1.16     kamil #ifdef __HAVE_FENV
    702  1.16     kamil 	feenableexcept(FE_ALL_EXCEPT);
    703  1.16     kamil #endif
    704  1.16     kamil 
    705  1.31       rin 	/* Division by zero causes CPU trap, translated to SIGFPE */
    706  1.35  riastrad 	ignore_result = (int)(a / b);
    707   1.6     kamil }
    708   1.6     kamil 
    709   1.6     kamil static void __used
    710   1.6     kamil trigger_bus(void)
    711   1.6     kamil {
    712   1.6     kamil 	FILE *fp;
    713   1.6     kamil 	char *p;
    714   1.6     kamil 
    715   1.6     kamil 	/* Open an empty file for writing. */
    716   1.6     kamil 	fp = tmpfile();
    717   1.7     kamil 	FORKEE_ASSERT_NEQ((uintptr_t)fp, (uintptr_t)NULL);
    718   1.6     kamil 
    719  1.11     kamil 	/*
    720  1.11     kamil 	 * Map an empty file with mmap(2) to a pointer.
    721  1.11     kamil 	 *
    722  1.11     kamil 	 * PROT_READ handles read-modify-write sequences emitted for
    723  1.11     kamil 	 * certain combinations of CPUs and compilers (e.g. Alpha AXP).
    724  1.11     kamil 	 */
    725  1.10     kamil 	p = mmap(0, 1, PROT_READ|PROT_WRITE, MAP_PRIVATE, fileno(fp), 0);
    726   1.7     kamil 	FORKEE_ASSERT_NEQ((uintptr_t)p, (uintptr_t)MAP_FAILED);
    727   1.6     kamil 
    728   1.6     kamil 	/* Invalid memory access causes CPU trap, translated to SIGBUS */
    729   1.6     kamil 	*p = 'a';
    730   1.6     kamil }
    731   1.6     kamil 
    732  1.18     kamil struct lwp_event_count {
    733  1.18     kamil 	lwpid_t lec_lwp;
    734  1.18     kamil 	int lec_count;
    735  1.18     kamil };
    736  1.18     kamil 
    737  1.23     kamil static int * __used
    738  1.18     kamil find_event_count(struct lwp_event_count list[], lwpid_t lwp, size_t max_lwps)
    739  1.18     kamil {
    740  1.18     kamil 	size_t i;
    741  1.18     kamil 
    742  1.18     kamil 	for (i = 0; i < max_lwps; i++) {
    743  1.18     kamil 		if (list[i].lec_lwp == 0)
    744  1.18     kamil 			list[i].lec_lwp = lwp;
    745  1.18     kamil 		if (list[i].lec_lwp == lwp)
    746  1.18     kamil 			return &list[i].lec_count;
    747  1.18     kamil 	}
    748  1.18     kamil 
    749  1.18     kamil 	atf_tc_fail("More LWPs reported than expected");
    750  1.18     kamil }
    751  1.18     kamil 
    752  1.18     kamil #define FIND_EVENT_COUNT(list, lwp)			\
    753  1.18     kamil 	find_event_count(list, lwp, __arraycount(list))
    754  1.18     kamil 
    755  1.18     kamil 
    756   1.1     kamil #if defined(TWAIT_HAVE_PID)
    757   1.1     kamil #define ATF_TP_ADD_TC_HAVE_PID(a,b)	ATF_TP_ADD_TC(a,b)
    758   1.1     kamil #else
    759   1.1     kamil #define ATF_TP_ADD_TC_HAVE_PID(a,b)
    760   1.1     kamil #endif
    761   1.1     kamil 
    762  1.28     kamil #if defined(TWAIT_HAVE_STATUS)
    763  1.28     kamil #define ATF_TP_ADD_TC_HAVE_STATUS(a,b)	ATF_TP_ADD_TC(a,b)
    764  1.28     kamil #else
    765  1.28     kamil #define ATF_TP_ADD_TC_HAVE_STATUS(a,b)
    766  1.28     kamil #endif
    767  1.28     kamil 
    768  1.28     kamil #if defined(TWAIT_HAVE_STATUS) && (defined(__i386__) || defined(__x86_64__))
    769  1.28     kamil #define ATF_TP_ADD_TC_HAVE_STATUS_X86(a,b)	ATF_TP_ADD_TC(a,b)
    770  1.28     kamil #else
    771  1.28     kamil #define ATF_TP_ADD_TC_HAVE_STATUS_X86(a,b)
    772  1.28     kamil #endif
    773  1.28     kamil 
    774   1.1     kamil #if defined(HAVE_GPREGS)
    775   1.1     kamil #define ATF_TP_ADD_TC_HAVE_GPREGS(a,b)	ATF_TP_ADD_TC(a,b)
    776   1.1     kamil #else
    777   1.1     kamil #define ATF_TP_ADD_TC_HAVE_GPREGS(a,b)
    778   1.1     kamil #endif
    779   1.1     kamil 
    780   1.1     kamil #if defined(HAVE_FPREGS)
    781   1.1     kamil #define ATF_TP_ADD_TC_HAVE_FPREGS(a,b)	ATF_TP_ADD_TC(a,b)
    782   1.1     kamil #else
    783   1.1     kamil #define ATF_TP_ADD_TC_HAVE_FPREGS(a,b)
    784   1.1     kamil #endif
    785   1.1     kamil 
    786   1.1     kamil #if defined(HAVE_DBREGS)
    787   1.1     kamil #define ATF_TP_ADD_TC_HAVE_DBREGS(a,b) ATF_TP_ADD_TC(a,b)
    788   1.1     kamil #else
    789   1.1     kamil #define ATF_TP_ADD_TC_HAVE_DBREGS(a,b)
    790   1.1     kamil #endif
    791   1.1     kamil 
    792   1.1     kamil #if defined(PT_STEP)
    793   1.1     kamil #define ATF_TP_ADD_TC_PT_STEP(a,b)	ATF_TP_ADD_TC(a,b)
    794   1.1     kamil #else
    795   1.1     kamil #define ATF_TP_ADD_TC_PT_STEP(a,b)
    796   1.1     kamil #endif
    797