[LTP] [PATCH v6 1/4] Refactor ioctl02.c to use the new test API
Cyril Hrubis
chrubis@suse.cz
Mon Oct 23 15:17:51 CEST 2023
Hi!
> +static const int checkpoint_child_ready = 1;
> +static const int checkpoint_parent_done_testing = 2;
1. It's more customary to make constants like this macros.
2. The names are overly too long
3. You can actually use single checkpoint
> -int main(int ac, char **av)
> +static void verify_ioctl(void)
> {
> - int lc;
> - int rval;
> -
> - tst_parse_opts(ac, av, options, &help);
> -
> -#ifdef UCLINUX
> - maybe_run_child(&do_child_uclinux, "dS", &parentpid, &childtty);
> -#endif
> -
> - if (!Devflag)
> - tst_brkm(TBROK, NULL, "You must specify a tty device with "
> - "the -D option.");
> -
> - tst_require_root();
> -
> - setup();
> -
> - for (lc = 0; TEST_LOOPING(lc); lc++) {
> -
> - tst_count = 0;
> -
> - parenttty = devname;
> - childtty = devname;
> -
> - parentpid = getpid();
> + parenttty = device;
> + childtty = device;
>
> - childpid = FORK_OR_VFORK();
> - if (childpid < 0)
> - tst_brkm(TBROK, cleanup, "fork failed");
> + parentpid = getpid();
> + childpid = SAFE_FORK();
> + if (childpid == 0)
> + do_child();
>
> - if (childpid == 0) { /* child */
> -#ifdef UCLINUX
> - if (self_exec(av[0], "dS", parentpid, childtty) < 0)
> - tst_brkm(TBROK, cleanup, "self_exec failed");
> -#else
> - do_child();
> -#endif
> - }
> -
> - while (!sigusr1)
> - sleep(1);
> + TST_CHECKPOINT_WAIT2(checkpoint_child_ready, 5000);
Why TST_CHECKPOINT_WAIT2(), why do you need to set the timeout?
> - sigusr1 = 0;
> -
> - parentfd = do_parent_setup();
> - if (parentfd < 0) {
> - kill(childpid, SIGTERM);
> - waitpid(childpid, NULL, 0);
> - cleanup();
> - }
> + parentfd = SAFE_OPEN(parenttty, O_RDWR, 0777);
> + /* flush tty queues to remove old output */
> + SAFE_IOCTL(parentfd, TCFLSH, 2);
>
> - /* run the parent test */
> - rval = run_ptest();
> - if (rval == -1) {
> - /*
> - * Parent cannot set/get ioctl parameters.
> - * SIGTERM the child and cleanup.
> - */
> - kill(childpid, SIGTERM);
> - waitpid(childpid, NULL, 0);
> - cleanup();
> - }
> + /* run the parent test */
> + int rval = run_ptest();
>
> - if (rval != 0)
> - tst_resm(TFAIL, "TCGETA/TCSETA tests FAILED with "
> - "%d %s", rval, rval > 1 ? "errors" : "error");
> - else
> - tst_resm(TPASS, "TCGETA/TCSETA tests SUCCEEDED");
> -
> - /* FIXME: check return codes. */
> - (void)kill(childpid, SIGTERM);
> - (void)waitpid(childpid, NULL, 0);
> -
> - /*
> - * Clean up things from the parent by restoring the
> - * tty device information that was saved in setup()
> - * and closing the tty file descriptor.
> - */
> - if (ioctl(parentfd, TCSETA, &save_io) == -1)
> - tst_resm(TINFO, "ioctl restore failed in main");
> - SAFE_CLOSE(cleanup, parentfd);
> -
> - closed = 1;
> - }
> - cleanup();
> + if (rval != 0)
> + tst_res(TFAIL, "TCGETA/TCSETA tests FAILED with "
> + "%d %s", rval, rval > 1 ? "errors" : "error");
> + else
> + tst_res(TPASS, "TCGETA/TCSETA tests SUCCEEDED");
Please no test result propagation like this. The TPASS/TFAIL should be
reported in the check_tty_params() directly. All that needs to be done
is to change the TINFO there to TPASS and TFAIL as needed and we can get
rid of this result propagation.
> - tst_exit();
> + TST_CHECKPOINT_WAKE(checkpoint_parent_done_testing);
> }
>
> static void do_child(void)
> @@ -201,28 +94,12 @@ static void do_child(void)
> _exit(0);
> }
This function is a bit useless now and all the indirection is making
things less readable. All we actually need to is to open the file
descriptor and wait on a checkpoint, I would just put all the code
directly in the if (!childpid) branch into the verify_ioctl() instead.
> -void do_child_uclinux(void)
> -{
> - struct sigaction act;
> -
> - /* Set up the signal handlers again */
> - act.sa_handler = (void *)sigterm_handler;
> - act.sa_flags = 0;
> - sigemptyset(&act.sa_mask);
> - (void)sigaction(SIGTERM, &act, 0);
> -
> - /* Run the normal child */
> - do_child();
> -}
> -
> /*
> * run_ptest() - setup the various termio structure values and issue
> * the TCSETA ioctl call with the TEST macro.
> */
> static int run_ptest(void)
> {
> - int i, rval;
> -
> /* Use "old" line discipline */
> termio.c_line = 0;
>
> @@ -230,7 +107,7 @@ static int run_ptest(void)
> termio.c_cflag = B50 | CS7 | CREAD | PARENB | PARODD | CLOCAL;
>
> /* Set control chars. */
> - for (i = 0; i < NCC; i++) {
> + for (int i = 0; i < NCC; i++) {
> if (i == VEOL2)
> continue;
> termio.c_cc[i] = CSTART;
> @@ -248,38 +125,18 @@ static int run_ptest(void)
> /* Set output modes. */
> termio.c_oflag = OPOST | OLCUC | ONLCR | ONOCR;
>
> - TEST(ioctl(parentfd, TCSETA, &termio));
> -
> - if (TEST_RETURN < 0) {
> - tst_resm(TFAIL, "ioctl TCSETA failed : "
> - "errno = %d", TEST_ERRNO);
> - return -1;
> - }
> + SAFE_IOCTL(parentfd, TCSETA, &termio);
>
> /* Get termio and see if all parameters actually got set */
> - rval = ioctl(parentfd, TCGETA, &termio);
> - if (rval < 0) {
> - tst_resm(TFAIL, "ioctl TCGETA failed. Ending test.");
> - return -1;
> - }
> -
> + SAFE_IOCTL(parentfd, TCGETA, &termio);
> return chk_tty_parms();
> }
>
> static int run_ctest(void)
> {
> - /*
> - * Wait till the parent has finished testing.
> - */
> - while (!sigterm)
> - sleep(1);
> -
> - sigterm = 0;
> -
> - tst_resm(TINFO, "child: Got SIGTERM from parent.");
> -
> - if (close(childfd) == -1)
> - tst_resm(TINFO, "close() in run_ctest() failed");
> + TST_CHECKPOINT_WAIT(checkpoint_parent_done_testing);
> + tst_res(TINFO, "child: parent has finished testing");
> + SAFE_CLOSE(childfd);
> return 0;
>
> }
>
> @@ -288,7 +145,7 @@ static int chk_tty_parms(void)
> int i, flag = 0;
>
> if (termio.c_line != 0) {
> - tst_resm(TINFO, "line discipline has incorrect value %o",
> + tst_res(TINFO, "line discipline has incorrect value %o",
> termio.c_line);
> flag++;
> }
> @@ -301,7 +158,7 @@ static int chk_tty_parms(void)
> */
> #if 0
> if (termio.c_cflag != (B50 | CS7 | CREAD | PARENB | PARODD | CLOCAL)) {
> - tst_resm(TINFO, "cflag has incorrect value. %o",
> + tst_res(TINFO, "cflag has incorrect value. %o",
> termio.c_cflag);
> flag++;
> }
> @@ -309,19 +166,18 @@ static int chk_tty_parms(void)
>
> for (i = 0; i < NCC; i++) {
> if (i == VEOL2) {
> - if (termio.c_cc[VEOL2] == CNUL) {
> + if (!termio.c_cc[i]) {
> continue;
> } else {
> - tst_resm(TINFO, "control char %d has "
> - "incorrect value %d %d", i,
> - termio.c_cc[i], CNUL);
> + tst_res(TINFO, "control char %d has "
> + "incorrect value %d", i, termio.c_cc[i]);
> flag++;
> continue;
> }
> }
>
> if (termio.c_cc[i] != CSTART) {
> - tst_resm(TINFO, "control char %d has incorrect "
> + tst_res(TINFO, "control char %d has incorrect "
> "value %d.", i, termio.c_cc[i]);
> flag++;
> }
> @@ -330,7 +186,7 @@ static int chk_tty_parms(void)
> if (!
> (termio.c_lflag
> && (ISIG | ICANON | XCASE | ECHO | ECHOE | NOFLSH))) {
> - tst_resm(TINFO, "lflag has incorrect value. %o",
> + tst_res(TINFO, "lflag has incorrect value. %o",
> termio.c_lflag);
> flag++;
> }
> @@ -339,130 +195,67 @@ static int chk_tty_parms(void)
> (termio.c_iflag
> && (BRKINT | IGNPAR | INPCK | ISTRIP | ICRNL | IUCLC | IXON | IXANY
> | IXOFF))) {
> - tst_resm(TINFO, "iflag has incorrect value. %o",
> + tst_res(TINFO, "iflag has incorrect value. %o",
> termio.c_iflag);
> flag++;
> }
>
> if (!(termio.c_oflag && (OPOST | OLCUC | ONLCR | ONOCR))) {
> - tst_resm(TINFO, "oflag has incorrect value. %o",
> + tst_res(TINFO, "oflag has incorrect value. %o",
> termio.c_oflag);
> flag++;
> }
>
> if (!flag)
> - tst_resm(TINFO, "termio values are set as expected");
> + tst_res(TINFO, "termio values are set as expected");
>
> return flag;
> }
>
> -static int do_parent_setup(void)
> -{
> - int pfd;
> -
> - pfd = SAFE_OPEN(cleanup, parenttty, O_RDWR, 0777);
> -
> - /* unset the closed flag */
> - closed = 0;
> -
> - /* flush tty queues to remove old output */
> - SAFE_IOCTL(cleanup, pfd, TCFLSH, 2);
> - return pfd;
> -}
> -
> static int do_child_setup(void)
> {
> - int cfd;
> -
> - cfd = open(childtty, O_RDWR, 0777);
> - if (cfd < 0) {
> - tst_resm(TINFO, "Could not open %s in do_child_setup(), errno "
> - "= %d", childtty, errno);
> - /* signal the parent so we don't hang the test */
> - kill(parentpid, SIGUSR1);
> - return -1;
> - }
> + int cfd = SAFE_OPEN(childtty, O_RDWR, 0777);
>
> /* flush tty queues to remove old output */
> - if (ioctl(cfd, TCFLSH, 2) < 0) {
> - tst_resm(TINFO, "ioctl TCFLSH failed. : errno = %d", errno);
> - /* signal the parent so we don't hang the test */
> - kill(parentpid, SIGUSR1);
> - return -1;
> - }
> + SAFE_IOCTL(cfd, TCFLSH, 2);
>
> /* tell the parent that we're done */
> - kill(parentpid, SIGUSR1);
> -
> + TST_CHECKPOINT_WAKE(checkpoint_child_ready);
> return cfd;
> }
>
> -/*
> - * Define the signals handlers here.
> - */
> -static void sigterm_handler(void)
> -{
> - sigterm = 1;
> -}
> -
> -static void sigusr1_handler(void)
> -{
> - sigusr1 = 1;
> -}
> -
> -static void sigusr2_handler(void)
> -{
> - sigusr2 = 1;
> -}
> -
> -static void help(void)
> -{
> - printf(" -D <tty device> : for example, /dev/tty[0-9]\n");
> -}
> -
> static void setup(void)
> {
> - int fd;
> - struct sigaction act;
> + if (!device)
> + tst_brk(TBROK, "You must specify a tty device with -D option");
>
> /* XXX: TERRNO required all over the place */
> - fd = SAFE_OPEN(NULL, devname, O_RDWR, 0777);
> + int fd = SAFE_OPEN(device, O_RDWR, 0777);
>
> /* Save the current device information - to be restored in cleanup() */
> - SAFE_IOCTL(cleanup, fd, TCGETA, &save_io);
> + SAFE_IOCTL(fd, TCGETA, &save_io);
>
> /* Close the device */
> - SAFE_CLOSE(cleanup, fd);
> -
> - /* Set up the signal handlers */
> - act.sa_handler = (void *)sigterm_handler;
> - act.sa_flags = 0;
> - sigemptyset(&act.sa_mask);
> - (void)sigaction(SIGTERM, &act, 0);
> -
> - act.sa_handler = (void *)sigusr1_handler;
> - act.sa_flags = 0;
> - (void)sigaction(SIGUSR1, &act, 0);
> -
> - act.sa_handler = (void *)sigusr2_handler;
> - act.sa_flags = 0;
> - (void)sigaction(SIGUSR2, &act, 0);
> -
> - act.sa_handler = SIG_IGN;
> - act.sa_flags = 0;
> - (void)sigaction(SIGTTOU, &act, 0);
> -
> - sigterm = sigusr1 = sigusr2 = 0;
> -
> - TEST_PAUSE;
> + SAFE_CLOSE(fd);
> }
>
> static void cleanup(void)
> {
> - if (!closed) {
> - if (ioctl(parentfd, TCSETA, &save_io) == -1)
> - tst_resm(TINFO, "ioctl restore failed in cleanup()");
> - if (close(parentfd) == -1)
> - tst_resm(TINFO, "close() failed in cleanup()");
> + if (parentfd >= 0) {
> + SAFE_IOCTL(parentfd, TCSETA, &save_io);
> + SAFE_CLOSE(parentfd);
> }
> }
> +
> +static struct tst_test test = {
> + .needs_root = 1,
> + .needs_checkpoints = 1,
> + .forks_child = 1,
> + .setup = setup,
> + .cleanup = cleanup,
> + .test_all = verify_ioctl,
> + .options = (struct tst_option[]) {
> + {"D:", &device, "Tty device. For example, /dev/tty[0-9]"},
> + {}
> + }
> +};
> \ No newline at end of file
> --
> 2.42.0
>
>
> --
> Mailing list info: https://lists.linux.it/listinfo/ltp
--
Cyril Hrubis
chrubis@suse.cz
More information about the ltp
mailing list