src/test/test-fd-util.c

   1 /* SPDX-License-Identifier: LGPL-2.1+ */
   2 /***
   3   This file is part of systemd.
   4
   5   Copyright 2010 Lennart Poettering
   6 ***/
   7
   8 #include <fcntl.h>
   9 #include <unistd.h>
  10
  11 #include "alloc-util.h"
  12 #include "fd-util.h"
  13 #include "fileio.h"
  14 #include "macro.h"
  15 #include "path-util.h"
  16 #include "process-util.h"
  17 #include "random-util.h"
  18 #include "string-util.h"
  19 #include "util.h"
  20
  21 static void test_close_many(void) {
  22         int fds[3];
  23         char name0[] = "/tmp/test-close-many.XXXXXX";
  24         char name1[] = "/tmp/test-close-many.XXXXXX";
  25         char name2[] = "/tmp/test-close-many.XXXXXX";
  26
  27         fds[0] = mkostemp_safe(name0);
  28         fds[1] = mkostemp_safe(name1);
  29         fds[2] = mkostemp_safe(name2);
  30
  31         close_many(fds, 2);
  32
  33         assert_se(fcntl(fds[0], F_GETFD) == -1);
  34         assert_se(fcntl(fds[1], F_GETFD) == -1);
  35         assert_se(fcntl(fds[2], F_GETFD) >= 0);
  36
  37         safe_close(fds[2]);
  38
  39         unlink(name0);
  40         unlink(name1);
  41         unlink(name2);
  42 }
  43
  44 static void test_close_nointr(void) {
  45         char name[] = "/tmp/test-test-close_nointr.XXXXXX";
  46         int fd;
  47
  48         fd = mkostemp_safe(name);
  49         assert_se(fd >= 0);
  50         assert_se(close_nointr(fd) >= 0);
  51         assert_se(close_nointr(fd) < 0);
  52
  53         unlink(name);
  54 }
  55
  56 #if 0 /// UNNEEDED by elogind
  57 static void test_same_fd(void) {
  58         _cleanup_close_pair_ int p[2] = { -1, -1 };
  59         _cleanup_close_ int a = -1, b = -1, c = -1;
  60
  61         assert_se(pipe2(p, O_CLOEXEC) >= 0);
  62         assert_se((a = fcntl(p[0], F_DUPFD, 3)) >= 0);
  63         assert_se((b = open("/dev/null", O_RDONLY|O_CLOEXEC)) >= 0);
  64         assert_se((c = fcntl(a, F_DUPFD, 3)) >= 0);
  65
  66         assert_se(same_fd(p[0], p[0]) > 0);
  67         assert_se(same_fd(p[1], p[1]) > 0);
  68         assert_se(same_fd(a, a) > 0);
  69         assert_se(same_fd(b, b) > 0);
  70
  71         assert_se(same_fd(a, p[0]) > 0);
  72         assert_se(same_fd(p[0], a) > 0);
  73         assert_se(same_fd(c, p[0]) > 0);
  74         assert_se(same_fd(p[0], c) > 0);
  75         assert_se(same_fd(a, c) > 0);
  76         assert_se(same_fd(c, a) > 0);
  77
  78         assert_se(same_fd(p[0], p[1]) == 0);
  79         assert_se(same_fd(p[1], p[0]) == 0);
  80         assert_se(same_fd(p[0], b) == 0);
  81         assert_se(same_fd(b, p[0]) == 0);
  82         assert_se(same_fd(p[1], a) == 0);
  83         assert_se(same_fd(a, p[1]) == 0);
  84         assert_se(same_fd(p[1], b) == 0);
  85         assert_se(same_fd(b, p[1]) == 0);
  86
  87         assert_se(same_fd(a, b) == 0);
  88         assert_se(same_fd(b, a) == 0);
  89 }
  90 #endif // 0
  91
  92 static void test_open_serialization_fd(void) {
  93         _cleanup_close_ int fd = -1;
  94
  95         fd = open_serialization_fd("test");
  96         assert_se(fd >= 0);
  97
  98         assert_se(write(fd, "test\n", 5) == 5);
  99 }
 100
 101 static void test_acquire_data_fd_one(unsigned flags) {
 102         char wbuffer[196*1024 - 7];
 103         char rbuffer[sizeof(wbuffer)];
 104         int fd;
 105
 106         fd = acquire_data_fd("foo", 3, flags);
 107         assert_se(fd >= 0);
 108
 109         zero(rbuffer);
 110         assert_se(read(fd, rbuffer, sizeof(rbuffer)) == 3);
 111         assert_se(streq(rbuffer, "foo"));
 112
 113         fd = safe_close(fd);
 114
 115         fd = acquire_data_fd("", 0, flags);
 116         assert_se(fd >= 0);
 117
 118         zero(rbuffer);
 119         assert_se(read(fd, rbuffer, sizeof(rbuffer)) == 0);
 120         assert_se(streq(rbuffer, ""));
 121
 122         fd = safe_close(fd);
 123
 124         random_bytes(wbuffer, sizeof(wbuffer));
 125
 126         fd = acquire_data_fd(wbuffer, sizeof(wbuffer), flags);
 127         assert_se(fd >= 0);
 128
 129         zero(rbuffer);
 130         assert_se(read(fd, rbuffer, sizeof(rbuffer)) == sizeof(rbuffer));
 131         assert_se(memcmp(rbuffer, wbuffer, sizeof(rbuffer)) == 0);
 132
 133         fd = safe_close(fd);
 134 }
 135
 136 static void test_acquire_data_fd(void) {
 137
 138         test_acquire_data_fd_one(0);
 139         test_acquire_data_fd_one(ACQUIRE_NO_DEV_NULL);
 140         test_acquire_data_fd_one(ACQUIRE_NO_MEMFD);
 141         test_acquire_data_fd_one(ACQUIRE_NO_DEV_NULL|ACQUIRE_NO_MEMFD);
 142         test_acquire_data_fd_one(ACQUIRE_NO_PIPE);
 143         test_acquire_data_fd_one(ACQUIRE_NO_DEV_NULL|ACQUIRE_NO_PIPE);
 144         test_acquire_data_fd_one(ACQUIRE_NO_MEMFD|ACQUIRE_NO_PIPE);
 145         test_acquire_data_fd_one(ACQUIRE_NO_DEV_NULL|ACQUIRE_NO_MEMFD|ACQUIRE_NO_PIPE);
 146         test_acquire_data_fd_one(ACQUIRE_NO_DEV_NULL|ACQUIRE_NO_MEMFD|ACQUIRE_NO_PIPE|ACQUIRE_NO_TMPFILE);
 147 }
 148
 149 static void test_fd_move_above_stdio(void) {
 150         int original_stdin, new_fd;
 151
 152         original_stdin = fcntl(0, F_DUPFD, 3);
 153         assert_se(original_stdin >= 3);
 154         assert_se(close_nointr(0) != EBADF);
 155
 156         new_fd = open("/dev/null", O_RDONLY);
 157         assert_se(new_fd == 0);
 158
 159         new_fd = fd_move_above_stdio(new_fd);
 160         assert_se(new_fd >= 3);
 161
 162         assert_se(dup(original_stdin) == 0);
 163         assert_se(close_nointr(original_stdin) != EBADF);
 164         assert_se(close_nointr(new_fd) != EBADF);
 165 }
 166
 167 static void test_rearrange_stdio(void) {
 168         pid_t pid;
 169         int r;
 170
 171         r = safe_fork("rearrange", FORK_WAIT|FORK_LOG, &pid);
 172         assert_se(r >= 0);
 173
 174         if (r == 0) {
 175                 _cleanup_free_ char *path = NULL;
 176                 char buffer[10];
 177
 178                 /* Child */
 179
 180                 safe_close(STDERR_FILENO); /* Let's close an fd < 2, to make it more interesting */
 181
 182                 assert_se(rearrange_stdio(-1, -1, -1) >= 0);
 183
 184                 assert_se(fd_get_path(STDIN_FILENO, &path) >= 0);
 185                 assert_se(path_equal(path, "/dev/null"));
 186                 path = mfree(path);
 187
 188                 assert_se(fd_get_path(STDOUT_FILENO, &path) >= 0);
 189                 assert_se(path_equal(path, "/dev/null"));
 190                 path = mfree(path);
 191
 192                 assert_se(fd_get_path(STDOUT_FILENO, &path) >= 0);
 193                 assert_se(path_equal(path, "/dev/null"));
 194                 path = mfree(path);
 195
 196                 safe_close(STDIN_FILENO);
 197                 safe_close(STDOUT_FILENO);
 198                 safe_close(STDERR_FILENO);
 199
 200                 {
 201                         int pair[2];
 202                         assert_se(pipe(pair) >= 0);
 203                         assert_se(pair[0] == 0);
 204                         assert_se(pair[1] == 1);
 205                         assert_se(fd_move_above_stdio(0) == 3);
 206                 }
 207                 assert_se(open("/dev/full", O_WRONLY|O_CLOEXEC) == 0);
 208                 assert_se(acquire_data_fd("foobar", 6, 0) == 2);
 209
 210                 assert_se(rearrange_stdio(2, 0, 1) >= 0);
 211
 212                 assert_se(write(1, "x", 1) < 0 && errno == ENOSPC);
 213                 assert_se(write(2, "z", 1) == 1);
 214                 assert_se(read(3, buffer, sizeof(buffer)) == 1);
 215                 assert_se(buffer[0] == 'z');
 216                 assert_se(read(0, buffer, sizeof(buffer)) == 6);
 217                 assert_se(memcmp(buffer, "foobar", 6) == 0);
 218
 219                 assert_se(rearrange_stdio(-1, 1, 2) >= 0);
 220                 assert_se(write(1, "a", 1) < 0 && errno == ENOSPC);
 221                 assert_se(write(2, "y", 1) == 1);
 222                 assert_se(read(3, buffer, sizeof(buffer)) == 1);
 223                 assert_se(buffer[0] == 'y');
 224
 225                 assert_se(fd_get_path(0, &path) >= 0);
 226                 assert_se(path_equal(path, "/dev/null"));
 227                 path = mfree(path);
 228
 229                 _exit(EXIT_SUCCESS);
 230         }
 231 }
 232
 233 static void assert_equal_fd(int fd1, int fd2) {
 234
 235         for (;;) {
 236                 uint8_t a[4096], b[4096];
 237                 ssize_t x, y;
 238
 239                 x = read(fd1, a, sizeof(a));
 240                 assert(x >= 0);
 241
 242                 y = read(fd2, b, sizeof(b));
 243                 assert(y >= 0);
 244
 245                 assert(x == y);
 246
 247                 if (x == 0)
 248                         break;
 249
 250                 assert(memcmp(a, b, x) == 0);
 251         }
 252 }
 253
 254 static void test_fd_duplicate_data_fd(void) {
 255         _cleanup_close_ int fd1 = -1, fd2 = -1;
 256         _cleanup_(close_pairp) int sfd[2] = { -1, -1 };
 257         _cleanup_(sigkill_waitp) pid_t pid = -1;
 258         uint64_t i, j;
 259         int r;
 260
 261         fd1 = open("/etc/fstab", O_RDONLY|O_CLOEXEC);
 262         if (fd1 >= 0) {
 263
 264                 fd2 = fd_duplicate_data_fd(fd1);
 265                 assert_se(fd2 >= 0);
 266
 267                 assert_se(lseek(fd1, 0, SEEK_SET) == 0);
 268                 assert_equal_fd(fd1, fd2);
 269         }
 270
 271         fd1 = safe_close(fd1);
 272         fd2 = safe_close(fd2);
 273
 274         fd1 = acquire_data_fd("hallo", 6,  0);
 275         assert_se(fd1 >= 0);
 276
 277         fd2 = fd_duplicate_data_fd(fd1);
 278         assert_se(fd2 >= 0);
 279
 280         safe_close(fd1);
 281         fd1 = acquire_data_fd("hallo", 6,  0);
 282         assert_se(fd1 >= 0);
 283
 284         assert_equal_fd(fd1, fd2);
 285
 286         fd1 = safe_close(fd1);
 287         fd2 = safe_close(fd2);
 288
 289         assert_se(socketpair(AF_UNIX, SOCK_STREAM|SOCK_CLOEXEC, 0, sfd) >= 0);
 290
 291         r = safe_fork("(sd-pipe)", FORK_RESET_SIGNALS|FORK_DEATHSIG|FORK_LOG, &pid);
 292         assert_se(r >= 0);
 293
 294         if (r == 0) {
 295                 /* child */
 296
 297                 sfd[0] = safe_close(sfd[0]);
 298
 299                 for (i = 0; i < 1536*1024 / sizeof(uint64_t); i++)
 300                         assert_se(write(sfd[1], &i, sizeof(i)) == sizeof(i));
 301
 302                 sfd[1] = safe_close(sfd[1]);
 303
 304                 _exit(EXIT_SUCCESS);
 305         }
 306
 307         sfd[1] = safe_close(sfd[1]);
 308
 309         fd2 = fd_duplicate_data_fd(sfd[0]);
 310         assert_se(fd2 >= 0);
 311
 312         for (i = 0; i < 1536*1024 / sizeof(uint64_t); i++) {
 313                 assert_se(read(fd2, &j, sizeof(j)) == sizeof(j));
 314                 assert_se(i == j);
 315         }
 316
 317         assert_se(read(fd2, &j, sizeof(j)) == 0);
 318 }
 319
 320 static void test_read_nr_open(void) {
 321         log_info("nr-open: %i", read_nr_open());
 322 }
 323
 324 int main(int argc, char *argv[]) {
 325
 326         log_set_max_level(LOG_DEBUG);
 327
 328         test_close_many();
 329         test_close_nointr();
 330 #if 0 /// UNNEEDED by elogind
 331         test_same_fd();
 332 #endif // 0
 333         test_open_serialization_fd();
 334         test_acquire_data_fd();
 335         test_fd_move_above_stdio();
 336         test_rearrange_stdio();
 337         test_fd_duplicate_data_fd();
 338         test_read_nr_open();
 339
 340         return 0;
 341 }