src/libsystemd/sd-event/test-event.c

   1 /* SPDX-License-Identifier: LGPL-2.1+ */
   2 /***
   3   Copyright 2013 Lennart Poettering
   4 ***/
   5
   6 #include <sys/wait.h>
   7
   8 #include "sd-event.h"
   9
  10 #include "alloc-util.h"
  11 #include "fd-util.h"
  12 #include "fileio.h"
  13 #include "fs-util.h"
  14 #include "log.h"
  15 #include "macro.h"
  16 #include "parse-util.h"
  17 #include "process-util.h"
  18 #include "rm-rf.h"
  19 #include "signal-util.h"
  20 #include "stdio-util.h"
  21 #include "string-util.h"
  22 #include "util.h"
  23
  24 static int prepare_handler(sd_event_source *s, void *userdata) {
  25         log_info("preparing %c", PTR_TO_INT(userdata));
  26         return 1;
  27 }
  28
  29 static bool got_a, got_b, got_c, got_unref;
  30 static unsigned got_d;
  31
  32 static int unref_handler(sd_event_source *s, int fd, uint32_t revents, void *userdata) {
  33         sd_event_source_unref(s);
  34         got_unref = true;
  35         return 0;
  36 }
  37
  38 static int io_handler(sd_event_source *s, int fd, uint32_t revents, void *userdata) {
  39
  40         log_info("got IO on %c", PTR_TO_INT(userdata));
  41
  42         if (userdata == INT_TO_PTR('a')) {
  43                 assert_se(sd_event_source_set_enabled(s, SD_EVENT_OFF) >= 0);
  44                 assert_se(!got_a);
  45                 got_a = true;
  46         } else if (userdata == INT_TO_PTR('b')) {
  47                 assert_se(!got_b);
  48                 got_b = true;
  49         } else if (userdata == INT_TO_PTR('d')) {
  50                 got_d++;
  51                 if (got_d < 2)
  52                         assert_se(sd_event_source_set_enabled(s, SD_EVENT_ONESHOT) >= 0);
  53                 else
  54                         assert_se(sd_event_source_set_enabled(s, SD_EVENT_OFF) >= 0);
  55         } else
  56                 assert_not_reached("Yuck!");
  57
  58         return 1;
  59 }
  60
  61 static int child_handler(sd_event_source *s, const siginfo_t *si, void *userdata) {
  62
  63         assert_se(s);
  64         assert_se(si);
  65
  66         log_info("got child on %c", PTR_TO_INT(userdata));
  67
  68         assert_se(userdata == INT_TO_PTR('f'));
  69
  70         assert_se(sd_event_exit(sd_event_source_get_event(s), 0) >= 0);
  71         sd_event_source_unref(s);
  72
  73         return 1;
  74 }
  75
  76 static int signal_handler(sd_event_source *s, const struct signalfd_siginfo *si, void *userdata) {
  77         sd_event_source *p = NULL;
  78         pid_t pid;
  79
  80         assert_se(s);
  81         assert_se(si);
  82
  83         log_info("got signal on %c", PTR_TO_INT(userdata));
  84
  85         assert_se(userdata == INT_TO_PTR('e'));
  86
  87         assert_se(sigprocmask_many(SIG_BLOCK, NULL, SIGCHLD, -1) >= 0);
  88
  89         pid = fork();
  90         assert_se(pid >= 0);
  91
  92         if (pid == 0)
  93                 _exit(EXIT_SUCCESS);
  94
  95         assert_se(sd_event_add_child(sd_event_source_get_event(s), &p, pid, WEXITED, child_handler, INT_TO_PTR('f')) >= 0);
  96         assert_se(sd_event_source_set_enabled(p, SD_EVENT_ONESHOT) >= 0);
  97
  98         sd_event_source_unref(s);
  99
 100         return 1;
 101 }
 102
 103 static int defer_handler(sd_event_source *s, void *userdata) {
 104         sd_event_source *p = NULL;
 105
 106         assert_se(s);
 107
 108         log_info("got defer on %c", PTR_TO_INT(userdata));
 109
 110         assert_se(userdata == INT_TO_PTR('d'));
 111
 112         assert_se(sigprocmask_many(SIG_BLOCK, NULL, SIGUSR1, -1) >= 0);
 113
 114         assert_se(sd_event_add_signal(sd_event_source_get_event(s), &p, SIGUSR1, signal_handler, INT_TO_PTR('e')) >= 0);
 115         assert_se(sd_event_source_set_enabled(p, SD_EVENT_ONESHOT) >= 0);
 116         raise(SIGUSR1);
 117
 118         sd_event_source_unref(s);
 119
 120         return 1;
 121 }
 122
 123 static bool do_quit = false;
 124
 125 static int time_handler(sd_event_source *s, uint64_t usec, void *userdata) {
 126         log_info("got timer on %c", PTR_TO_INT(userdata));
 127
 128         if (userdata == INT_TO_PTR('c')) {
 129
 130                 if (do_quit) {
 131                         sd_event_source *p;
 132
 133                         assert_se(sd_event_add_defer(sd_event_source_get_event(s), &p, defer_handler, INT_TO_PTR('d')) >= 0);
 134                         assert_se(sd_event_source_set_enabled(p, SD_EVENT_ONESHOT) >= 0);
 135                 } else {
 136                         assert_se(!got_c);
 137                         got_c = true;
 138                 }
 139         } else
 140                 assert_not_reached("Huh?");
 141
 142         return 2;
 143 }
 144
 145 static bool got_exit = false;
 146
 147 static int exit_handler(sd_event_source *s, void *userdata) {
 148         log_info("got quit handler on %c", PTR_TO_INT(userdata));
 149
 150         got_exit = true;
 151
 152         return 3;
 153 }
 154
 155 static bool got_post = false;
 156
 157 static int post_handler(sd_event_source *s, void *userdata) {
 158         log_info("got post handler");
 159
 160         got_post = true;
 161
 162         return 2;
 163 }
 164
 165 static void test_basic(void) {
 166         sd_event *e = NULL;
 167         sd_event_source *w = NULL, *x = NULL, *y = NULL, *z = NULL, *q = NULL, *t = NULL;
 168         static const char ch = 'x';
 169         int a[2] = { -1, -1 }, b[2] = { -1, -1}, d[2] = { -1, -1}, k[2] = { -1, -1 };
 170         uint64_t event_now;
 171         int64_t priority;
 172
 173         assert_se(pipe(a) >= 0);
 174         assert_se(pipe(b) >= 0);
 175         assert_se(pipe(d) >= 0);
 176         assert_se(pipe(k) >= 0);
 177
 178         assert_se(sd_event_default(&e) >= 0);
 179         assert_se(sd_event_now(e, CLOCK_MONOTONIC, &event_now) > 0);
 180
 181         assert_se(sd_event_set_watchdog(e, true) >= 0);
 182
 183         /* Test whether we cleanly can destroy an io event source from its own handler */
 184         got_unref = false;
 185         assert_se(sd_event_add_io(e, &t, k[0], EPOLLIN, unref_handler, NULL) >= 0);
 186         assert_se(write(k[1], &ch, 1) == 1);
 187         assert_se(sd_event_run(e, (uint64_t) -1) >= 1);
 188         assert_se(got_unref);
 189
 190         got_a = false, got_b = false, got_c = false, got_d = 0;
 191
 192         /* Add a oneshot handler, trigger it, re-enable it, and trigger
 193          * it again. */
 194         assert_se(sd_event_add_io(e, &w, d[0], EPOLLIN, io_handler, INT_TO_PTR('d')) >= 0);
 195         assert_se(sd_event_source_set_enabled(w, SD_EVENT_ONESHOT) >= 0);
 196         assert_se(write(d[1], &ch, 1) >= 0);
 197         assert_se(sd_event_run(e, (uint64_t) -1) >= 1);
 198         assert_se(got_d == 1);
 199         assert_se(write(d[1], &ch, 1) >= 0);
 200         assert_se(sd_event_run(e, (uint64_t) -1) >= 1);
 201         assert_se(got_d == 2);
 202
 203         assert_se(sd_event_add_io(e, &x, a[0], EPOLLIN, io_handler, INT_TO_PTR('a')) >= 0);
 204         assert_se(sd_event_add_io(e, &y, b[0], EPOLLIN, io_handler, INT_TO_PTR('b')) >= 0);
 205         assert_se(sd_event_add_time(e, &z, CLOCK_MONOTONIC, 0, 0, time_handler, INT_TO_PTR('c')) >= 0);
 206         assert_se(sd_event_add_exit(e, &q, exit_handler, INT_TO_PTR('g')) >= 0);
 207
 208         assert_se(sd_event_source_set_priority(x, 99) >= 0);
 209         assert_se(sd_event_source_get_priority(x, &priority) >= 0);
 210         assert_se(priority == 99);
 211         assert_se(sd_event_source_set_enabled(y, SD_EVENT_ONESHOT) >= 0);
 212         assert_se(sd_event_source_set_prepare(x, prepare_handler) >= 0);
 213         assert_se(sd_event_source_set_priority(z, 50) >= 0);
 214         assert_se(sd_event_source_set_enabled(z, SD_EVENT_ONESHOT) >= 0);
 215         assert_se(sd_event_source_set_prepare(z, prepare_handler) >= 0);
 216
 217         /* Test for floating event sources */
 218         assert_se(sigprocmask_many(SIG_BLOCK, NULL, SIGRTMIN+1, -1) >= 0);
 219         assert_se(sd_event_add_signal(e, NULL, SIGRTMIN+1, NULL, NULL) >= 0);
 220
 221         assert_se(write(a[1], &ch, 1) >= 0);
 222         assert_se(write(b[1], &ch, 1) >= 0);
 223
 224         assert_se(!got_a && !got_b && !got_c);
 225
 226         assert_se(sd_event_run(e, (uint64_t) -1) >= 1);
 227
 228         assert_se(!got_a && got_b && !got_c);
 229
 230         assert_se(sd_event_run(e, (uint64_t) -1) >= 1);
 231
 232         assert_se(!got_a && got_b && got_c);
 233
 234         assert_se(sd_event_run(e, (uint64_t) -1) >= 1);
 235
 236         assert_se(got_a && got_b && got_c);
 237
 238         sd_event_source_unref(x);
 239         sd_event_source_unref(y);
 240
 241         do_quit = true;
 242         assert_se(sd_event_add_post(e, NULL, post_handler, NULL) >= 0);
 243         assert_se(sd_event_now(e, CLOCK_MONOTONIC, &event_now) == 0);
 244         assert_se(sd_event_source_set_time(z, event_now + 200 * USEC_PER_MSEC) >= 0);
 245         assert_se(sd_event_source_set_enabled(z, SD_EVENT_ONESHOT) >= 0);
 246
 247         assert_se(sd_event_loop(e) >= 0);
 248         assert_se(got_post);
 249         assert_se(got_exit);
 250
 251         sd_event_source_unref(z);
 252         sd_event_source_unref(q);
 253
 254         sd_event_source_unref(w);
 255
 256         sd_event_unref(e);
 257
 258         safe_close_pair(a);
 259         safe_close_pair(b);
 260         safe_close_pair(d);
 261         safe_close_pair(k);
 262 }
 263
 264 static void test_sd_event_now(void) {
 265         _cleanup_(sd_event_unrefp) sd_event *e = NULL;
 266         uint64_t event_now;
 267
 268         assert_se(sd_event_new(&e) >= 0);
 269         assert_se(sd_event_now(e, CLOCK_MONOTONIC, &event_now) > 0);
 270         assert_se(sd_event_now(e, CLOCK_REALTIME, &event_now) > 0);
 271         assert_se(sd_event_now(e, CLOCK_REALTIME_ALARM, &event_now) > 0);
 272         if (clock_boottime_supported()) {
 273                 assert_se(sd_event_now(e, CLOCK_BOOTTIME, &event_now) > 0);
 274                 assert_se(sd_event_now(e, CLOCK_BOOTTIME_ALARM, &event_now) > 0);
 275         }
 276         assert_se(sd_event_now(e, -1, &event_now) == -EOPNOTSUPP);
 277         assert_se(sd_event_now(e, 900 /* arbitrary big number */, &event_now) == -EOPNOTSUPP);
 278
 279         assert_se(sd_event_run(e, 0) == 0);
 280
 281         assert_se(sd_event_now(e, CLOCK_MONOTONIC, &event_now) == 0);
 282         assert_se(sd_event_now(e, CLOCK_REALTIME, &event_now) == 0);
 283         assert_se(sd_event_now(e, CLOCK_REALTIME_ALARM, &event_now) == 0);
 284         if (clock_boottime_supported()) {
 285                 assert_se(sd_event_now(e, CLOCK_BOOTTIME, &event_now) == 0);
 286                 assert_se(sd_event_now(e, CLOCK_BOOTTIME_ALARM, &event_now) == 0);
 287         }
 288         assert_se(sd_event_now(e, -1, &event_now) == -EOPNOTSUPP);
 289         assert_se(sd_event_now(e, 900 /* arbitrary big number */, &event_now) == -EOPNOTSUPP);
 290 }
 291
 292 static int last_rtqueue_sigval = 0;
 293 static int n_rtqueue = 0;
 294
 295 static int rtqueue_handler(sd_event_source *s, const struct signalfd_siginfo *si, void *userdata) {
 296         last_rtqueue_sigval = si->ssi_int;
 297         n_rtqueue++;
 298         return 0;
 299 }
 300
 301 static void test_rtqueue(void) {
 302         sd_event_source *u = NULL, *v = NULL, *s = NULL;
 303         sd_event *e = NULL;
 304
 305         assert_se(sd_event_default(&e) >= 0);
 306
 307         assert_se(sigprocmask_many(SIG_BLOCK, NULL, SIGRTMIN+2, SIGRTMIN+3, SIGUSR2, -1) >= 0);
 308         assert_se(sd_event_add_signal(e, &u, SIGRTMIN+2, rtqueue_handler, NULL) >= 0);
 309         assert_se(sd_event_add_signal(e, &v, SIGRTMIN+3, rtqueue_handler, NULL) >= 0);
 310         assert_se(sd_event_add_signal(e, &s, SIGUSR2, rtqueue_handler, NULL) >= 0);
 311
 312         assert_se(sd_event_source_set_priority(v, -10) >= 0);
 313
 314         assert_se(sigqueue(getpid_cached(), SIGRTMIN+2, (union sigval) { .sival_int = 1 }) >= 0);
 315         assert_se(sigqueue(getpid_cached(), SIGRTMIN+3, (union sigval) { .sival_int = 2 }) >= 0);
 316         assert_se(sigqueue(getpid_cached(), SIGUSR2, (union sigval) { .sival_int = 3 }) >= 0);
 317         assert_se(sigqueue(getpid_cached(), SIGRTMIN+3, (union sigval) { .sival_int = 4 }) >= 0);
 318         assert_se(sigqueue(getpid_cached(), SIGUSR2, (union sigval) { .sival_int = 5 }) >= 0);
 319
 320         assert_se(n_rtqueue == 0);
 321         assert_se(last_rtqueue_sigval == 0);
 322
 323         assert_se(sd_event_run(e, (uint64_t) -1) >= 1);
 324         assert_se(n_rtqueue == 1);
 325         assert_se(last_rtqueue_sigval == 2); /* first SIGRTMIN+3 */
 326
 327         assert_se(sd_event_run(e, (uint64_t) -1) >= 1);
 328         assert_se(n_rtqueue == 2);
 329         assert_se(last_rtqueue_sigval == 4); /* second SIGRTMIN+3 */
 330
 331         assert_se(sd_event_run(e, (uint64_t) -1) >= 1);
 332         assert_se(n_rtqueue == 3);
 333         assert_se(last_rtqueue_sigval == 3); /* first SIGUSR2 */
 334
 335         assert_se(sd_event_run(e, (uint64_t) -1) >= 1);
 336         assert_se(n_rtqueue == 4);
 337         assert_se(last_rtqueue_sigval == 1); /* SIGRTMIN+2 */
 338
 339         assert_se(sd_event_run(e, 0) == 0); /* the other SIGUSR2 is dropped, because the first one was still queued */
 340         assert_se(n_rtqueue == 4);
 341         assert_se(last_rtqueue_sigval == 1);
 342
 343         sd_event_source_unref(u);
 344         sd_event_source_unref(v);
 345         sd_event_source_unref(s);
 346
 347         sd_event_unref(e);
 348 }
 349
 350 #define CREATE_EVENTS_MAX (70000U)
 351
 352 struct inotify_context {
 353         bool delete_self_handler_called;
 354         unsigned create_called[CREATE_EVENTS_MAX];
 355         unsigned create_overflow;
 356         unsigned n_create_events;
 357 };
 358
 359 static void maybe_exit(sd_event_source *s, struct inotify_context *c) {
 360         unsigned n;
 361
 362         assert(s);
 363         assert(c);
 364
 365         if (!c->delete_self_handler_called)
 366                 return;
 367
 368         for (n = 0; n < 3; n++) {
 369                 unsigned i;
 370
 371                 if (c->create_overflow & (1U << n))
 372                         continue;
 373
 374                 for (i = 0; i < c->n_create_events; i++)
 375                         if (!(c->create_called[i] & (1U << n)))
 376                                 return;
 377         }
 378
 379         sd_event_exit(sd_event_source_get_event(s), 0);
 380 }
 381
 382 static int inotify_handler(sd_event_source *s, const struct inotify_event *ev, void *userdata) {
 383         struct inotify_context *c = userdata;
 384         const char *description;
 385         unsigned bit, n;
 386
 387         assert_se(sd_event_source_get_description(s, &description) >= 0);
 388         assert_se(safe_atou(description, &n) >= 0);
 389
 390         assert_se(n <= 3);
 391         bit = 1U << n;
 392
 393         if (ev->mask & IN_Q_OVERFLOW) {
 394                 log_info("inotify-handler <%s>: overflow", description);
 395                 c->create_overflow |= bit;
 396         } else if (ev->mask & IN_CREATE) {
 397                 unsigned i;
 398
 399                 log_info("inotify-handler <%s>: create on %s", description, ev->name);
 400
 401                 if (!streq(ev->name, "sub")) {
 402                         assert_se(safe_atou(ev->name, &i) >= 0);
 403
 404                         assert_se(i < c->n_create_events);
 405                         c->create_called[i] |= bit;
 406                 }
 407         } else if (ev->mask & IN_DELETE) {
 408                 log_info("inotify-handler <%s>: delete of %s", description, ev->name);
 409                 assert_se(streq(ev->name, "sub"));
 410         } else
 411                 assert_not_reached("unexpected inotify event");
 412
 413         maybe_exit(s, c);
 414         return 1;
 415 }
 416
 417 static int delete_self_handler(sd_event_source *s, const struct inotify_event *ev, void *userdata) {
 418         struct inotify_context *c = userdata;
 419
 420         if (ev->mask & IN_Q_OVERFLOW) {
 421                 log_info("delete-self-handler: overflow");
 422                 c->delete_self_handler_called = true;
 423         } else if (ev->mask & IN_DELETE_SELF) {
 424                 log_info("delete-self-handler: delete-self");
 425                 c->delete_self_handler_called = true;
 426         } else if (ev->mask & IN_IGNORED) {
 427                 log_info("delete-self-handler: ignore");
 428         } else
 429                 assert_not_reached("unexpected inotify event (delete-self)");
 430
 431         maybe_exit(s, c);
 432         return 1;
 433 }
 434
 435 static void test_inotify(unsigned n_create_events) {
 436         _cleanup_(rm_rf_physical_and_freep) char *p = NULL;
 437         sd_event_source *a = NULL, *b = NULL, *c = NULL, *d = NULL;
 438         struct inotify_context context = {
 439                 .n_create_events = n_create_events,
 440         };
 441         sd_event *e = NULL;
 442         const char *q;
 443         unsigned i;
 444
 445         assert_se(sd_event_default(&e) >= 0);
 446
 447         assert_se(mkdtemp_malloc("/tmp/test-inotify-XXXXXX", &p) >= 0);
 448
 449         assert_se(sd_event_add_inotify(e, &a, p, IN_CREATE|IN_ONLYDIR, inotify_handler, &context) >= 0);
 450         assert_se(sd_event_add_inotify(e, &b, p, IN_CREATE|IN_DELETE|IN_DONT_FOLLOW, inotify_handler, &context) >= 0);
 451         assert_se(sd_event_source_set_priority(b, SD_EVENT_PRIORITY_IDLE) >= 0);
 452         assert_se(sd_event_source_set_priority(b, SD_EVENT_PRIORITY_NORMAL) >= 0);
 453         assert_se(sd_event_add_inotify(e, &c, p, IN_CREATE|IN_DELETE|IN_EXCL_UNLINK, inotify_handler, &context) >= 0);
 454         assert_se(sd_event_source_set_priority(c, SD_EVENT_PRIORITY_IDLE) >= 0);
 455
 456         assert_se(sd_event_source_set_description(a, "0") >= 0);
 457         assert_se(sd_event_source_set_description(b, "1") >= 0);
 458         assert_se(sd_event_source_set_description(c, "2") >= 0);
 459
 460         q = strjoina(p, "/sub");
 461         assert_se(touch(q) >= 0);
 462         assert_se(sd_event_add_inotify(e, &d, q, IN_DELETE_SELF, delete_self_handler, &context) >= 0);
 463
 464         for (i = 0; i < n_create_events; i++) {
 465                 char buf[DECIMAL_STR_MAX(unsigned)+1];
 466                 _cleanup_free_ char *z;
 467
 468                 xsprintf(buf, "%u", i);
 469                 assert_se(z = strjoin(p, "/", buf));
 470
 471                 assert_se(touch(z) >= 0);
 472         }
 473
 474         assert_se(unlink(q) >= 0);
 475
 476         assert_se(sd_event_loop(e) >= 0);
 477
 478         sd_event_source_unref(a);
 479         sd_event_source_unref(b);
 480         sd_event_source_unref(c);
 481         sd_event_source_unref(d);
 482
 483         sd_event_unref(e);
 484 }
 485
 486 int main(int argc, char *argv[]) {
 487
 488         log_set_max_level(LOG_DEBUG);
 489         log_parse_environment();
 490
 491         test_basic();
 492         test_sd_event_now();
 493         test_rtqueue();
 494
 495         test_inotify(100); /* should work without overflow */
 496         test_inotify(33000); /* should trigger a q overflow */
 497
 498         return 0;
 499 }