syscalls/pipe07: Rewrite the test using new LTP API
PATCH 1/1 syscalls/pipe07: Rewrite the test using new LTP API
--- testcases/kernel/syscalls/pipe/pipe07.c | 201 +++++++----------------- 1 file changed, 60 insertions(+), 141 deletions(-)
testcases/kernel/syscalls/pipe/pipe07.c +60 -141
@@ -1,176 +1,95 @@ +// SPDX-License-Identifier: GPL-2.0-or-later /* * Copyright (c) International Business Machines Corp., 2002 -* Ported by Paul Larson +* Ported by Paul Larson * Copyright (c) 2013 Cyril Hrubis <[email protected]> -* -* This program is free software; you can redistribute it and/or modify -* it under the terms of the GNU General Public License as published by -* the Free Software Foundation; either version 2 of the License, or -* (at your option) any later version. -* -* This program is distributed in the hope that it will be useful, -* but WITHOUT ANY WARRANTY; without even the implied warranty of -* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See -* the GNU General Public License for more details. -* -* You should have received a copy of the GNU General Public License -* along with this program; if not, write to the Free Software -* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA +* Copyright (c) 2023 SUSE LLC Avinesh Kumar <[email protected]> */ -/* -* Test the ability of pipe to open the maximum even number of file -* descriptors permitted (or (maxfds - 3)/2 pipes) +/*\ +* [Description] * -* ALGORITHM -* 1. record file descriptors open prior to test run -* 2. open pipes until EMFILE is returned -* 3. check to see that the number of pipes opened is (maxfds - 3) / 2 -* 4. close all fds in range 0, maximal fd that were not open prior to -* the test execution +* Verify that, pipe(2) syscall can open the maximum number of +* file descriptors permitted. */ -#include <unistd.h> -#include <fcntl.h> -#include <errno.h> -#include <stdlib.h> -#include <stdio.h> -#include <string.h> -#include <dirent.h> - -#include "test.h" -#include "safe_macros.h" -char *TCID ="pipe07" ; -int TST_TOTAL =1 ; - -/* used to record file descriptors open at the test start */ -static int rec_fds[128 ]; -static int rec_fds_max; -static void record_open_fds (void ); -static void close_test_fds (int max_fd); +#include "tst_test.h" +#include <stdlib.h> -static void setup (void ); -static void cleanup (void ); +static int *opened_fds, *pipe_fds; +static int num_opened_fds, num_pipe_fds, exp_num_pipe_fds; -int main (int ac,char **av) +static void record_open_fds (void ) { -int lc; -int min, ret; -int npipes; -int pipes[2 ], max_fd =0 ; - -tst_parse_opts (ac, av,NULL ,NULL ); - -setup (); +DIR *dir; +struct dirent *ent; +int fd; - min =getdtablesize () - rec_fds_max; + dir =SAFE_OPENDIR ("/proc/self/fd" ); -for (lc =0 ;TEST_LOOPING (lc); lc++) { - tst_count =0 ; - -for (npipes =0 ;; npipes++) { - ret =pipe (pipes); -if (ret <0 ) { -if (errno !=EMFILE ) { -tst_brkm (TFAIL , cleanup, -"got unexpected error - %d" , - errno); - } -break ; - } - - max_fd =MAX (pipes[0 ], max_fd); - max_fd =MAX (pipes[1 ], max_fd); - } - -if (npipes == (min /2 )) -tst_resm (TPASS ,"Opened %d pipes" , npipes); -else -tst_resm (TFAIL ,"Unable to open maxfds/2 pipes" ); - -close_test_fds (max_fd); - max_fd =0 ; +while ((ent =SAFE_READDIR (dir))) { +if (!strcmp (ent->d_name,"." ) || + !strcmp (ent->d_name,".." )) +continue ; + fd =atoi (ent->d_name); + opened_fds =SAFE_REALLOC (opened_fds, (num_opened_fds +1 ) *sizeof (int )); + opened_fds[num_opened_fds++] = fd; } - -cleanup (); -tst_exit (); }static void setup (void ) { -tst_sig (FORK ,DEF_HANDLER , cleanup); -TEST_PAUSE ; +int max_fds; + + max_fds =getdtablesize (); +tst_res (TINFO ,"getdtablesize() = %d" , max_fds); + pipe_fds =SAFE_MALLOC (max_fds *sizeof (int ));record_open_fds (); +tst_res (TINFO ,"open fds before pipe() calls: %d" , num_opened_fds); + + exp_num_pipe_fds = max_fds - num_opened_fds; + exp_num_pipe_fds = (exp_num_pipe_fds %2 ) ? + (exp_num_pipe_fds -1 ) : exp_num_pipe_fds; +tst_res (TINFO ,"expected max fds to be opened by pipe(): %d" , exp_num_pipe_fds); } -static void record_open_fds (void ) +static void run (void ) { -DIR *dir =opendir ("/proc/self/fd" ); -int dir_fd, fd; -struct dirent *file; +int fds[2 ]; -if (dir ==NULL ) -tst_brkm (TBROK |TERRNO , cleanup,"opendir()" ); - - dir_fd =dirfd (dir); - -if (dir_fd ==-1 ) -tst_brkm (TBROK |TERRNO , cleanup,"dirfd()" ); - - errno =0 ; - -while ((file =readdir (dir))) { -if (!strcmp (file->d_name,"." ) || !strcmp (file->d_name,".." )) -continue ; - - fd =atoi (file->d_name); - -if (fd == dir_fd) -continue ; - -if (rec_fds_max >= (int )ARRAY_SIZE (rec_fds)) { -tst_brkm (TBROK , cleanup, -"Too much file descriptors open" ); +do { +TEST (pipe (fds)); +if (TST_RET !=-1 ) { + pipe_fds[num_pipe_fds++] = fds[0 ]; + pipe_fds[num_pipe_fds++] = fds[1 ]; } + }while (TST_RET !=-1 ); - rec_fds[rec_fds_max++] = fd; - } - -if (errno) -tst_brkm (TBROK |TERRNO , cleanup,"readdir()" ); +TST_EXP_EQ_LI (errno,EMFILE ); +TST_EXP_EQ_LI (exp_num_pipe_fds, num_pipe_fds); -closedir (dir); +for (int i =0 ; i < num_pipe_fds; i++) +SAFE_CLOSE (pipe_fds[i]); -tst_resm (TINFO ,"Found %u files open" , rec_fds_max); + num_pipe_fds =0 ; } -static int not_recorded (int fd) +static void cleanup (void ) { -int i; +if (opened_fds) +free (opened_fds); -for (i =0 ; i < rec_fds_max; i++) -if (fd == rec_fds[i]) -return 0 ; +if (pipe_fds) +free (pipe_fds); -return 1 ; -} - -static void close_test_fds (int max_fd) -{ -int i; - -for (i =0 ; i <= max_fd; i++) { -if (not_recorded (i)) { -if (close (i)) { -if (errno ==EBADF ) -continue ; -tst_resm (TWARN |TERRNO ,"close(%i)" , i); - } - } - } +for (int i =0 ; i < num_pipe_fds; i++) +if (pipe_fds[i]) +SAFE_CLOSE (pipe_fds[i]); } -static void cleanup (void ) -{ -} +static struct tst_test test = { + .setup = setup, + .cleanup = cleanup, + .test_all = run +};
Signature · 5 lines
2.41.0 -- Mailing list info: https://lists.linux.it/listinfo/ltp
Hi Avinesh,
generally LGTM, thank you.
BTW it's funny that when run with valgrind, it fails because valgrind opens some file descriptors:
$ valgrind ./pipe07 ... pipe07.c:45: TINFO: getdtablesize() = 1024 pipe07.c:49: TINFO: open fds before pipe() calls: 10 pipe07.c:54: TINFO: expected max fds to be opened by pipe(): 1014 ==1629480== Warning: invalid file descriptor 1030 in syscall pipe2() pipe07.c:69: TPASS: errno == EMFILE (24) pipe07.c:70: TFAIL: exp_num_pipe_fds (1014) != num_pipe_fds (1020)
Quoted 1 line
+static void
record_open_fds(void)
nit: num_opened_fds is used only in setup(), I'd personally return int and store variable in setup().
Quoted 7 lines
{
testcases/kernel/syscalls/pipe/pipe07.c +4
-1+DIR *dir; +struct dirent *ent; +int fd; - min =getdtablesize () - rec_fds_max; + dir =SAFE_OPENDIR ("/proc/self/fd" );
...
Quoted 2 lines
+static void run(void)
{
...
testcases/kernel/syscalls/pipe/pipe07.c line 63
Quoted 3 lines
testcases/kernel/syscalls/pipe/pipe07.c +3
-0+ do { + TEST(pipe(fds)); + if (TST_RET != -1) {
nit: wouldn't be safer to use: if (!TST_RET) (i.e. for TST_RET == 0) (we check that return on error is exactly -1, not > 0)
Kind regards,
Petr
Quoted 4 lines
testcases/kernel/syscalls/pipe/pipe07.c +3
-0+ pipe_fds[num_pipe_fds++] = fds[0 ]; + pipe_fds[num_pipe_fds++] = fds[1 ]; } + }while (TST_RET !=-1 );
...
Signature · 1 line
Mailing list info: https://lists.linux.it/listinfo/ltp
Hi!
Quoted 2 lines
BTW it's funny that when run with valgrind, it fails because valgrind opens some file descriptors:
For that to happen they have to be opened after the test setup() in the context of the process, which does sound strange....
Signature · 5 lines
Cyril Hrubis [email protected] -- Mailing list info: https://lists.linux.it/listinfo/ltp
Hi Petr,
Thank you for the review.
Quoted 9 lines · IST Petr Vorel
Hi Avinesh,
generally LGTM, thank you.
Reviewed-by Petr Vorel <[email protected]>BTW it's funny that when run with valgrind, it fails because valgrind opens some file descriptors:
Quoted 9 lines
$ valgrind ./pipe07 ... pipe07.c:45: TINFO: getdtablesize() = 1024 pipe07.c:49: TINFO: open fds before pipe() calls: 10 pipe07.c:54: TINFO: expected max fds to be opened by pipe(): 1014 ==1629480== Warning: invalid file descriptor 1030 in syscall pipe2() pipe07.c:69: TPASS: errno == EMFILE (24) pipe07.c:70: TFAIL: exp_num_pipe_fds (1014) != num_pipe_fds (1020)
Ah yes, I also tried this. So valgrind is opening some file descriptors in the process context, but I don't know if it's ok to ignore this behavior.
I'm taking care of other nit suggestions in revised patch.
Quoted 32 lines
Quoted 1 line
+static void
record_open_fds(void)nit:
num_opened_fdsis used only insetup(), I'd personally return int and store variable insetup().Quoted 8 lines
{
testcases/kernel/syscalls/pipe/pipe07.c +4
-1+DIR *dir; +struct dirent *ent; +int fd; - min =getdtablesize () - rec_fds_max; + dir =SAFE_OPENDIR ("/proc/self/fd" );...
Quoted 3 lines
+static void run(void)
{
...
testcases/kernel/syscalls/pipe/pipe07.c line 63
Quoted 3 lines
testcases/kernel/syscalls/pipe/pipe07.c +3
-0+ do { + TEST(pipe(fds)); + if (TST_RET != -1) {nit: wouldn't be safer to use: if (!TST_RET) (i.e. for
TST_RET== 0) (we check that return on error is exactly -1, not > 0)Kind regards,
Petr
Quoted 8 lines
Quoted 6 lines
testcases/kernel/syscalls/pipe/pipe07.c +3
-0+ pipe_fds[num_pipe_fds++] = fds[0 ]; + pipe_fds[num_pipe_fds++] = fds[1 ]; } + }while (TST_RET !=-1 );...
--
Regards,
Avinesh
Signature · 1 line
Mailing list info: https://lists.linux.it/listinfo/ltp
Hi!
testcases/kernel/syscalls/pipe/pipe07.c line 34
Quoted 5 lines
testcases/kernel/syscalls/pipe/pipe07.c +5
-0+while ((ent =SAFE_READDIR (dir))) { +if (!strcmp (ent->d_name,"." ) || + !strcmp (ent->d_name,".." )) +continue ; + fd =atoi (ent->d_name);
What about the if (fd == dir_fd) continue; why did you drop that part from here?
testcases/kernel/syscalls/pipe/pipe07.c line 35
Quoted 1 line
testcases/kernel/syscalls/pipe/pipe07.c +1
-0+ opened_fds =SAFE_REALLOC (opened_fds, (num_opened_fds +1 ) *sizeof (int ));
It's more usuall to double array size if we go out of space since incresing the size by one element is` slow in case of realloc(). I guess that it does not matter us much here, but I would do something as:
int arr_size = 0;
int arr_used = 0;
int *array = NULL;
if (arr_used >= arr_size) {
arr_size = MAX(1, arr_size * 2);
array = realloc(array, arr_size * sizeof(int));
}
array[arr_used++] = foo;Quoted 13 lines
testcases/kernel/syscalls/pipe/pipe07.c +3
-5+ opened_fds[num_opened_fds++] = fd; } - -cleanup (); -tst_exit (); }static void setup (void ) { -tst_sig (FORK ,DEF_HANDLER , cleanup); -TEST_PAUSE ; +int max_fds; +
testcases/kernel/syscalls/pipe/pipe07.c line 53
Quoted 10 lines
testcases/kernel/syscalls/pipe/pipe07.c +8
-0+ max_fds =getdtablesize (); +tst_res (TINFO ,"getdtablesize() = %d" , max_fds); + pipe_fds =SAFE_MALLOC (max_fds *sizeof (int ));record_open_fds (); +tst_res (TINFO ,"open fds before pipe() calls: %d" , num_opened_fds); + + exp_num_pipe_fds = max_fds - num_opened_fds; + exp_num_pipe_fds = (exp_num_pipe_fds %2 ) ? + (exp_num_pipe_fds -1 ) : exp_num_pipe_fds;
The previous code that compared the number of pipes was IMHO easier to read, i.e.
exp_num_pipes = (max_fds - num_opened_fds)/2;
Then you can use:
2 * exp_num_pipes as the number of expected fds
Quoted 41 lines
testcases/kernel/syscalls/pipe/pipe07.c +9
-26+tst_res (TINFO ,"expected max fds to be opened by pipe(): %d" , exp_num_pipe_fds); } -static void record_open_fds (void ) +static void run (void ) { -DIR *dir =opendir ("/proc/self/fd" ); -int dir_fd, fd; -struct dirent *file; +int fds[2 ]; -if (dir ==NULL ) -tst_brkm (TBROK |TERRNO , cleanup,"opendir()" ); - - dir_fd =dirfd (dir); - -if (dir_fd ==-1 ) -tst_brkm (TBROK |TERRNO , cleanup,"dirfd()" ); - - errno =0 ; - -while ((file =readdir (dir))) { -if (!strcmp (file->d_name,"." ) || !strcmp (file->d_name,".." )) -continue ; - - fd =atoi (file->d_name); - -if (fd == dir_fd) -continue ; - -if (rec_fds_max >= (int )ARRAY_SIZE (rec_fds)) { -tst_brkm (TBROK , cleanup, -"Too much file descriptors open" ); +do { +TEST (pipe (fds)); +if (TST_RET !=-1 ) { + pipe_fds[num_pipe_fds++] = fds[0 ]; + pipe_fds[num_pipe_fds++] = fds[1 ]; } + }while (TST_RET !=-1 );
testcases/kernel/syscalls/pipe/pipe07.c line 72
Quoted 10 lines
testcases/kernel/syscalls/pipe/pipe07.c +3
-6- rec_fds[rec_fds_max++] = fd; - } - -if (errno) -tst_brkm (TBROK |TERRNO , cleanup,"readdir()" ); +TST_EXP_EQ_LI (errno,EMFILE ); +TST_EXP_EQ_LI (exp_num_pipe_fds, num_pipe_fds); -closedir (dir); +for (int i =0 ; i < num_pipe_fds; i++)
I suppose that this is fine since we now compile with -std=gnu99
Quoted 27 lines
testcases/kernel/syscalls/pipe/pipe07.c +7
-14+SAFE_CLOSE (pipe_fds[i]); -tst_resm (TINFO ,"Found %u files open" , rec_fds_max); + num_pipe_fds =0 ; } -static int not_recorded (int fd) +static void cleanup (void ) { -int i; +if (opened_fds) +free (opened_fds); -for (i =0 ; i < rec_fds_max; i++) -if (fd == rec_fds[i]) -return 0 ; +if (pipe_fds) +free (pipe_fds); -return 1 ; -} - -static void close_test_fds (int max_fd) -{ -int i; - -for (i =0 ; i <= max_fd; i++) {
testcases/kernel/syscalls/pipe/pipe07.c line 87
Quoted 10 lines
testcases/kernel/syscalls/pipe/pipe07.c +2
-8-if (not_recorded (i)) { -if (close (i)) { -if (errno ==EBADF ) -continue ; -tst_resm (TWARN |TERRNO ,"close(%i)" , i); - } - } - } +for (int i =0 ; i < num_pipe_fds; i++) +if (pipe_fds[i])
^
This should be pipe_fds[i] > 0
However this branch is never triggered as long as the loop that closes all pipe_fds in run succeeds. I'm not sure that if we fail to close a pipe it makes sense to contine closing the rest. Since pipes are only backed by RAM the possible failures from close() would mean that something horrible happend to the kernel, possibly RAM corruption or something along the lines.
Quoted 17 lines
testcases/kernel/syscalls/pipe/pipe07.c +6
-3+SAFE_CLOSE (pipe_fds[i]); } -static void cleanup (void ) -{ -} +static struct tst_test test = { + .setup = setup, + .cleanup = cleanup, + .test_all = run +};Signature · 5 lines
2.41.0 -- Mailing list info: https://lists.linux.it/listinfo/ltp
Signature · 5 lines
Cyril Hrubis [email protected] -- Mailing list info: https://lists.linux.it/listinfo/ltp
Hi Cyril,
Thank you for reviewing the patch and the suggested changes. I'm incorporating the suggested changes in the v2.
--
Regards,
Avinesh
Signature · 1 line
Mailing list info: https://lists.linux.it/listinfo/ltp