[LTP] [PATCH v2] getdents: update to new api, don't mix libc and kernel types
Cyril Hrubis
chrubis@suse.cz
Thu Nov 19 14:00:46 CET 2020
Hi!
> #include <stdint.h>
> -#include "test.h"
> -#include "lapi/syscalls.h"
> #include "config.h"
> +#include "lapi/syscalls.h"
> +
> +#if HAVE_GETDENTS || HAVE_GETDENTS64
> +#include <unistd.h>
> +#endif
> +
> /*
> * See fs/compat.c struct compat_linux_dirent
> */
> @@ -34,17 +38,12 @@ struct linux_dirent {
> char d_name[];
> };
>
> -#if HAVE_GETDENTS
> -#include <unistd.h>
> -#else
> static inline int
> -getdents(unsigned int fd, struct linux_dirent *dirp, unsigned int size)
> +linux_getdents(unsigned int fd, struct linux_dirent *dirp, unsigned int size)
> {
> - return ltp_syscall(__NR_getdents, fd, dirp, size);
> + return tst_syscall(__NR_getdents, fd, dirp, size);
> }
>
> -#endif /* HAVE_GETDENTS */
> -
> struct linux_dirent64 {
> uint64_t d_ino;
> int64_t d_off;
> @@ -53,14 +52,149 @@ struct linux_dirent64 {
> char d_name[];
> };
>
> +static inline int
> +linux_getdents64(unsigned int fd, struct linux_dirent64 *dirp64, unsigned int size)
> +{
> + return tst_syscall(__NR_getdents64, fd, dirp64, size);
> +}
> +
> +static inline size_t
> +tst_dirp_size(void)
> +{
> + switch (tst_variant) {
> + case 0:
> + return sizeof(struct linux_dirent);
> + case 1:
> + return sizeof(struct linux_dirent64);
> + case 2:
> +#if HAVE_GETDENTS
> + return sizeof(struct dirent);
> +#else
> + tst_brk(TCONF, "libc getdents() is not implemented");
> + break;
> +#endif
> + case 3:
> #if HAVE_GETDENTS64
> -#include <dirent.h>
> -#include <unistd.h>
> + return sizeof(struct dirent64);
> +#else
> + tst_brk(TCONF, "libc getdents64() is not implemented");
> + break;
Well we do call the getdents_info() as a first thing in the test
setup() so I would say that we do not have to stuff tst_brk(TCONF, ...)
to all of the wrappers here since the test will exit before these
function are reached.
So maybe we can just do return 0; here and be done with it.
> +#endif
> + }
> + return 0;
> +}
> +
> +static inline void *
> +tst_dirp_alloc(void)
> +{
> + return tst_alloc(tst_dirp_size());
> +}
Can we please avoid adding this wrapper?
We do call tst_dirp_size() in the setup anyways, so passing the size we
get to tst_alloc() is not more complicated than this.
> +static inline const char *
> +tst_dirp_name(void *dirp)
> +{
> + switch (tst_variant) {
> + case 0:
> + return ((struct linux_dirent *)dirp)->d_name;
> + case 1:
> + return ((struct linux_dirent64 *)dirp)->d_name;
> + case 2:
> +#if HAVE_GETDENTS
> + return ((struct dirent *)dirp)->d_name;
> #else
> + tst_brk(TCONF, "libc getdents() is not implemented");
> + break;
> +#endif
> + case 3:
> +#if HAVE_GETDENTS64
> + return ((struct dirent64 *)dirp)->d_name;
> +#else
> + tst_brk(TCONF, "libc getdents64() is not implemented");
> + break;
> +#endif
> + }
> + return NULL;
> +}
> +
> +static inline size_t
> +tst_dirp_reclen(void *dirp)
> +{
> + switch (tst_variant) {
> + case 0:
> + return ((struct linux_dirent *)dirp)->d_reclen;
> + case 1:
> + return ((struct linux_dirent64 *)dirp)->d_reclen;
> + case 2:
> +#if HAVE_GETDENTS
> + return ((struct dirent *)dirp)->d_reclen;
> +#else
> + tst_brk(TCONF, "libc getdents() is not implemented");
> + break;
> +#endif
> + case 3:
> +#if HAVE_GETDENTS64
> + return ((struct dirent64 *)dirp)->d_reclen;
> +#else
> + tst_brk(TCONF, "libc getdents64() is not implemented");
> + break;
> +#endif
> + }
> + return 0;
> +}
> +
> static inline int
> -getdents64(unsigned int fd, struct linux_dirent64 *dirp64, unsigned int size)
> +tst_getdents(int fd, void *dirp, unsigned int size)
> +{
> + switch (tst_variant) {
> + case 0:
> + return linux_getdents(fd, dirp, size);
> + case 1:
> + return linux_getdents64(fd, dirp, size);
> + case 2:
> +#if HAVE_GETDENTS
> + return getdents(fd, dirp, size);
> +#else
> + tst_brk(TCONF, "libc getdents() is not implemented");
> + break;
> +#endif
> + case 3:
> +#if HAVE_GETDENTS64
> + return getdents64(fd, dirp, size);
> +#else
> + tst_brk(TCONF, "libc getdents64() is not implemented");
> + break;
> +#endif
> + }
> + return -1;
> +}
> +
> +static inline void
> +getdents_info(void)
> {
> - return ltp_syscall(__NR_getdents64, fd, dirp64, size);
> + switch (tst_variant) {
> + case 0:
> + tst_res(TINFO, "Testing the SYS_getdents syscall");
> + break;
> + case 1:
> + tst_res(TINFO, "Testing the SYS_getdents64 syscall");
> + break;
> + case 2:
> +#if HAVE_GETDENTS
> + tst_res(TINFO, "Testing libc getdents()");
> +#else
> + tst_brk(TCONF, "libc getdents() is not implemented");
> +#endif
> + break;
> + case 3:
> +#if HAVE_GETDENTS64
> + tst_res(TINFO, "Testing libc getdents64()");
> +#else
> + tst_brk(TCONF, "libc getdents64() is not implemented");
> +#endif
> + break;
> + }
> }
> -#endif /* HAVE_GETDENTS64 */
> +
> +#define TEST_VARIANTS 4
> +
> #endif /* GETDENTS_H */
> diff --git a/testcases/kernel/syscalls/getdents/getdents01.c b/testcases/kernel/syscalls/getdents/getdents01.c
> index eca572d42..bdf939ab0 100644
> --- a/testcases/kernel/syscalls/getdents/getdents01.c
> +++ b/testcases/kernel/syscalls/getdents/getdents01.c
> @@ -20,16 +20,12 @@
> */
>
> #define _GNU_SOURCE
> -#include <stdio.h>
> -#include <errno.h>
> -#include <sys/types.h>
> -#include <sys/stat.h>
> -#include <fcntl.h>
> -
> -#include "test.h"
> -#include "safe_macros.h"
> +
> +#include "tst_test.h"
> #include "getdents.h"
>
> +#include <stdlib.h>
> +
> static void cleanup(void);
> static void setup(void);
These two declarations are useless now.
> @@ -37,21 +33,7 @@ static void reset_flags(void);
> static void check_flags(void);
> static void set_flag(const char *name);
>
> -char *TCID = "getdents01";
> -int TST_TOTAL = 1;
> -
> -static int longsyscall;
> -
> -static option_t options[] = {
> - /* -l long option. Tests getdents64 */
> - {"l", &longsyscall, NULL},
> - {NULL, NULL, NULL}
> -};
> -
> -static void help(void)
> -{
> - printf(" -l Test the getdents64 system call\n");
> -}
> +static int fd;
>
> enum entry_type {
> ENTRY_DIR,
> @@ -80,95 +62,49 @@ struct testcase testcases[] = {
> */
> #define BUFSIZE 512
>
> -int main(int ac, char **av)
> +void run(void)
> {
> - int lc;
> - int rval, fd;
> - struct linux_dirent64 *dirp64;
> - struct linux_dirent *dirp;
> - void *buf;
> -
> - tst_parse_opts(ac, av, options, &help);
> + int rval;
> + void *dirp;
>
> /* The buffer is allocated to make sure it's suitably aligned */
> - buf = malloc(BUFSIZE);
> -
> - if (buf == NULL)
> - tst_brkm(TBROK, NULL, "malloc failed");
> -
> - dirp64 = buf;
> - dirp = buf;
> + dirp = tst_alloc(BUFSIZE);
>
> - setup();
> + if (dirp == NULL)
> + tst_brk(TBROK, "malloc failed");
This is not how tst_alloc() is supposed to work.
First of all it never fails, but that is not the most important problem
here. The guarded buffers are supposed to be allocated in the test setup
once for the lifetime of the test.
The run() function could be looped over (with the -i command line
parameter) which would trigger allocation failure sooner or later.
Constant size buffers can be allocated by setting the .bufs in the
tst_test structure, see add_keys01.c for example.
> - for (lc = 0; TEST_LOOPING(lc); lc++) {
> - const char *d_name;
> + rval = tst_getdents(fd, dirp, BUFSIZE);
>
> - tst_count = 0;
> -
> - if ((fd = open(".", O_RDONLY)) == -1)
> - tst_brkm(TBROK, cleanup, "open of directory failed");
> -
> - if (longsyscall)
> - rval = getdents64(fd, dirp64, BUFSIZE);
> + if (rval < 0) {
> + if (errno == ENOSYS)
> + tst_brk(TCONF, "syscall not implemented");
> else
> - rval = getdents(fd, dirp, BUFSIZE);
> -
> - if (rval < 0) {
> - if (errno == ENOSYS)
> - tst_resm(TCONF, "syscall not implemented");
> - else
> - tst_resm(TFAIL | TERRNO,
> - "getdents failed unexpectedly");
> - continue;
> - }
> -
> - if (rval == 0) {
> - tst_resm(TFAIL,
> - "getdents failed - returned end of directory");
> - continue;
> - }
> -
> - reset_flags();
> -
> - do {
> - size_t d_reclen;
> + tst_brk(TFAIL | TERRNO, "getdents failed unexpectedly");
> + }
>
> - if (longsyscall) {
> - d_reclen = dirp64->d_reclen;
> - d_name = dirp64->d_name;
> - } else {
> - d_reclen = dirp->d_reclen;
> - d_name = dirp->d_name;
> - }
> + if (rval == 0)
> + tst_brk(TFAIL, "getdents failed - returned end of directory");
You must not use tst_brk() with TFAIL, here you should use tst_res()
followed by a return.
> - set_flag(d_name);
> + reset_flags();
>
> - tst_resm(TINFO, "Found '%s'", d_name);
> -
> - rval -= d_reclen;
> -
> - if (longsyscall)
> - dirp64 = (void*)dirp64 + d_reclen;
> - else
> - dirp = (void*)dirp + d_reclen;
> + do {
> + size_t d_reclen = tst_dirp_reclen(dirp);
> + const char *d_name = tst_dirp_name(dirp);
>
> - } while (rval > 0);
> + set_flag(d_name);
>
> - SAFE_CLOSE(cleanup, fd);
> -
> - check_flags();
> - }
> + tst_res(TINFO, "Found '%s'", d_name);
>
> - free(buf);
> + rval -= d_reclen;
> + dirp += d_reclen;
> + } while (rval > 0);
>
> - cleanup();
> - tst_exit();
> + check_flags();
> }
>
> static void reset_flags(void)
> {
> - int i;
> + size_t i;
>
> for (i = 0; i < ARRAY_SIZE(testcases); i++)
> testcases[i].found = 0;
> @@ -176,24 +112,25 @@ static void reset_flags(void)
>
> static void check_flags(void)
> {
> - int i, err = 0;
> + size_t i;
> + int err = 0;
>
> for (i = 0; i < ARRAY_SIZE(testcases); i++) {
> if (!testcases[i].found) {
> - tst_resm(TINFO, "Entry '%s' not found", testcases[i].name);
> + tst_res(TINFO, "Entry '%s' not found", testcases[i].name);
> err++;
> }
> }
>
> if (err)
> - tst_resm(TFAIL, "Some entires not found");
> + tst_res(TFAIL, "Some entries not found");
> else
> - tst_resm(TPASS, "All entires found");
> + tst_res(TPASS, "All entries found");
> }
>
> static void set_flag(const char *name)
> {
> - int i;
> + size_t i;
>
> for (i = 0; i < ARRAY_SIZE(testcases); i++) {
> if (!strcmp(name, testcases[i].name)) {
> @@ -202,39 +139,47 @@ static void set_flag(const char *name)
> }
> }
>
> - tst_resm(TFAIL, "Unexpected entry '%s' found", name);
> + tst_res(TFAIL, "Unexpected entry '%s' found", name);
> }
>
> static void setup(void)
> {
> - int i;
> -
> - tst_sig(NOFORK, DEF_HANDLER, cleanup);
> -
> - tst_tmpdir();
> -
> - for (i = 0; i < ARRAY_SIZE(testcases); i++) {
> -
> - if (!testcases[i].create)
> - continue;
> -
> - switch (testcases[i].type) {
> - case ENTRY_DIR:
> - SAFE_MKDIR(cleanup, testcases[i].name, 0777);
> - break;
> - case ENTRY_FILE:
> - SAFE_FILE_PRINTF(cleanup, testcases[i].name, " ");
> - break;
> - case ENTRY_SYMLINK:
> - SAFE_SYMLINK(cleanup, "nonexistent", testcases[i].name);
> - break;
> + size_t i;
> +
> + getdents_info();
> +
> + if (!tst_variant) {
> + for (i = 0; i < ARRAY_SIZE(testcases); i++) {
> + if (!testcases[i].create)
> + continue;
> +
> + switch (testcases[i].type) {
> + case ENTRY_DIR:
> + SAFE_MKDIR(testcases[i].name, 0777);
> + break;
> + case ENTRY_FILE:
> + SAFE_FILE_PRINTF(testcases[i].name, " ");
> + break;
> + case ENTRY_SYMLINK:
> + SAFE_SYMLINK("nonexistent", testcases[i].name);
> + break;
> + }
> }
> }
>
> - TEST_PAUSE;
> + fd = SAFE_OPEN(".", O_RDONLY|O_DIRECTORY);
> }
>
> static void cleanup(void)
> {
> - tst_rmdir();
> + if (fd != 0)
> + SAFE_CLOSE(fd);
> }
> +
> +static struct tst_test test = {
> + .needs_tmpdir = 1,
> + .test_all = run,
> + .setup = setup,
> + .cleanup = cleanup,
> + .test_variants = TEST_VARIANTS,
> +};
> diff --git a/testcases/kernel/syscalls/getdents/getdents02.c b/testcases/kernel/syscalls/getdents/getdents02.c
> index 4cf54aea3..82932b7b1 100644
> --- a/testcases/kernel/syscalls/getdents/getdents02.c
> +++ b/testcases/kernel/syscalls/getdents/getdents02.c
> @@ -34,22 +34,15 @@
> */
>
> #define _GNU_SOURCE
> -#include <stdio.h>
> #include <errno.h>
> -#include <sys/types.h>
> -#include <sys/stat.h>
> -#include <fcntl.h>
>
> -#include "test.h"
> +#include "tst_test.h"
> #include "getdents.h"
> -#include "safe_macros.h"
>
> #define DIR_MODE (S_IRUSR|S_IWUSR|S_IXUSR|S_IRGRP| \
> S_IXGRP|S_IROTH|S_IXOTH)
> #define TEST_DIR "test_dir"
>
> -static void cleanup(void);
> -static void setup(void);
> static void print_test_result(int err, int exp_errno);
>
> char *TCID = "getdents02";
> @@ -64,58 +57,33 @@ static void (*testfunc[])(void) = { test_ebadf, test_einval,
>
> int TST_TOTAL = ARRAY_SIZE(testfunc);
>
> -static int longsyscall;
> +static void *dirp;
> +static size_t size;
>
> -option_t options[] = {
> - /* -l long option. Tests getdents64 */
> - {"l", &longsyscall, NULL},
> - {NULL, NULL, NULL}
> -};
> -
> -static void help(void)
> -{
> - printf(" -l Test the getdents64 system call\n");
> -}
> -
> -int main(int ac, char **av)
> +static void setup(void)
> {
> - int lc, i;
> -
> - tst_parse_opts(ac, av, options, &help);
> -
> - setup();
> -
> - for (lc = 0; TEST_LOOPING(lc); lc++) {
> - tst_count = 0;
> + getdents_info();
>
> - for (i = 0; i < TST_TOTAL; i++)
> - (*testfunc[i])();
> - }
> -
> - cleanup();
> - tst_exit();
> + dirp = tst_dirp_alloc();
> + size = tst_dirp_size();
> }
>
> -static void setup(void)
> +static void run(unsigned int i)
> {
> - tst_sig(NOFORK, DEF_HANDLER, cleanup);
> -
> - tst_tmpdir();
> -
> - TEST_PAUSE;
> + testfunc[i]();
> }
>
> static void print_test_result(int err, int exp_errno)
> {
> if (err == 0) {
> - tst_resm(TFAIL, "call succeeded unexpectedly");
> + tst_res(TFAIL, "call succeeded unexpectedly");
> } else if (err == exp_errno) {
> - tst_resm(TPASS, "getdents failed as expected: %s",
> + tst_res(TPASS, "getdents failed as expected: %s",
> strerror(err));
> } else if (err == ENOSYS) {
> - tst_resm(TCONF, "syscall not implemented");
> + tst_res(TCONF, "syscall not implemented");
> } else {
> - tst_resm(TFAIL, "getdents failed unexpectedly: %s",
> + tst_res(TFAIL, "getdents failed unexpectedly: %s",
> strerror(err));
> }
> }
> @@ -123,13 +91,8 @@ static void print_test_result(int err, int exp_errno)
> static void test_ebadf(void)
> {
> int fd = -5;
> - struct linux_dirent64 dirp64;
> - struct linux_dirent dirp;
>
> - if (longsyscall)
> - getdents64(fd, &dirp64, sizeof(dirp64));
> - else
> - getdents(fd, &dirp, sizeof(dirp));
> + tst_getdents(fd, dirp, size);
>
> print_test_result(errno, EBADF);
> }
> @@ -139,59 +102,49 @@ static void test_einval(void)
> int fd;
> char buf[1];
>
> - fd = SAFE_OPEN(cleanup, ".", O_RDONLY);
> + fd = SAFE_OPEN(".", O_RDONLY);
>
> /* Pass one byte long buffer. The result should be EINVAL */
> - if (longsyscall)
> - getdents64(fd, (void *)buf, sizeof(buf));
> - else
> - getdents(fd, (void *)buf, sizeof(buf));
> + tst_getdents(fd, (void *)buf, sizeof(buf));
>
> print_test_result(errno, EINVAL);
>
> - SAFE_CLOSE(cleanup, fd);
> + SAFE_CLOSE(fd);
> }
>
> static void test_enotdir(void)
> {
> int fd;
> - struct linux_dirent64 dir64;
> - struct linux_dirent dir;
>
> - fd = SAFE_OPEN(cleanup, "test", O_CREAT | O_RDWR, 0644);
> + fd = SAFE_OPEN("test", O_CREAT | O_RDWR, 0644);
>
> - if (longsyscall)
> - getdents64(fd, &dir64, sizeof(dir64));
> - else
> - getdents(fd, &dir, sizeof(dir));
> + tst_getdents(fd, dirp, size);
>
> print_test_result(errno, ENOTDIR);
>
> - SAFE_CLOSE(cleanup, fd);
> + SAFE_CLOSE(fd);
> }
>
> static void test_enoent(void)
> {
> int fd;
> - struct linux_dirent64 dir64;
> - struct linux_dirent dir;
>
> - SAFE_MKDIR(cleanup, TEST_DIR, DIR_MODE);
> + SAFE_MKDIR(TEST_DIR, DIR_MODE);
>
> - fd = SAFE_OPEN(cleanup, TEST_DIR, O_DIRECTORY);
> - SAFE_RMDIR(cleanup, TEST_DIR);
> + fd = SAFE_OPEN(TEST_DIR, O_DIRECTORY);
> + SAFE_RMDIR(TEST_DIR);
>
> - if (longsyscall)
> - getdents64(fd, &dir64, sizeof(dir64));
> - else
> - getdents(fd, &dir, sizeof(dir));
> + tst_getdents(fd, dirp, size);
>
> print_test_result(errno, ENOENT);
>
> - SAFE_CLOSE(cleanup, fd);
> + SAFE_CLOSE(fd);
> }
>
> -static void cleanup(void)
> -{
> - tst_rmdir();
> -}
> +static struct tst_test test = {
> + .needs_tmpdir = 1,
> + .test = run,
> + .setup = setup,
> + .tcnt = ARRAY_SIZE(testfunc),
> + .test_variants = TEST_VARIANTS,
> +};
Not that it's wrong however these days we tend to write these tests in a
more data driver way such as access/access04.c
Also can you please switch to SPDX licence identifier while you are
touching the source code?
Other than this it looks good.
--
Cyril Hrubis
chrubis@suse.cz
More information about the ltp
mailing list