1
0
mirror of https://github.com/systemd/systemd synced 2026-04-07 07:34:50 +02:00

Compare commits

..

No commits in common. "6ebbcafeb433958e4552ebf49cacf10a9426d929" and "6401279fee182af092f1f5adbf231957d4c8d298" have entirely different histories.

15 changed files with 39 additions and 135 deletions

View File

@ -19,7 +19,6 @@
<refname>sd_event_source_set_ratelimit</refname>
<refname>sd_event_source_get_ratelimit</refname>
<refname>sd_event_source_is_ratelimited</refname>
<refname>sd_event_source_set_ratelimit_expire_callback</refname>
<refpurpose>Configure rate limiting on event sources</refpurpose>
</refnamediv>
@ -47,12 +46,6 @@
<paramdef>sd_event_source *<parameter>source</parameter></paramdef>
</funcprototype>
<funcprototype>
<funcdef>int <function>sd_event_source_set_ratelimit_expire_callback</function></funcdef>
<paramdef>sd_event_source *<parameter>source</parameter></paramdef>
<paramdef>sd_event_handler_t<parameter>callback</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
@ -85,10 +78,6 @@
is currently affected by rate limiting, i.e. it has recently hit the rate limit and is currently
temporarily disabled due to that.</para>
<para><function>sd_event_source_set_ratelimit_expire_callback</function> may be used to set a callback
function that is invoked every time the event source leaves rate limited state. Note that function is
called in the same event loop iteration in which state transition occured.</para>
<para>Rate limiting is currently implemented for I/O, timer, signal, defer and inotify event
sources.</para>
</refsect1>
@ -96,12 +85,11 @@
<refsect1>
<title>Return Value</title>
<para>On success, <function>sd_event_source_set_ratelimit()</function>,
<function>sd_event_source_set_ratelimit_expire_callback</function> and
<function>sd_event_source_get_ratelimit()</function> return a non-negative integer. On failure, they return
a negative errno-style error code. <function>sd_event_source_is_ratelimited</function> returns zero if rate
limiting is currently not in effect and greater than zero if it is in effect; it returns a negative
errno-style error code on failure.</para>
<para>On success, <function>sd_event_source_set_ratelimit()</function> and
<function>sd_event_source_get_ratelimit()</function> return a non-negative integer. On failure, they
return a negative errno-style error code. <function>sd_event_source_is_ratelimited</function> returns
zero if rate limiting is currently not in effect and greater than zero if it is in effect; it returns a
negative errno-style error code on failure.</para>
<refsect2>
<title>Errors</title>

View File

@ -1063,7 +1063,7 @@ static bool automount_supported(void) {
return supported;
}
static int automount_can_start(Unit *u) {
static int automount_test_start_limit(Unit *u) {
Automount *a = AUTOMOUNT(u);
int r;
@ -1075,7 +1075,7 @@ static int automount_can_start(Unit *u) {
return r;
}
return 1;
return 0;
}
static const char* const automount_result_table[_AUTOMOUNT_RESULT_MAX] = {
@ -1142,5 +1142,5 @@ const UnitVTable automount_vtable = {
},
},
.can_start = automount_can_start,
.test_start_limit = automount_test_start_limit,
};

View File

@ -1838,21 +1838,6 @@ static bool mount_is_mounted(Mount *m) {
return UNIT(m)->perpetual || FLAGS_SET(m->proc_flags, MOUNT_PROC_IS_MOUNTED);
}
static int mount_on_ratelimit_expire(sd_event_source *s, void *userdata) {
Manager *m = userdata;
int r;
assert(m);
/* By entering ratelimited state we made all mount start jobs not runnable, now rate limit is over so let's
* make sure we dispatch them in the next iteration. */
r = sd_event_source_set_enabled(m->run_queue_event_source, SD_EVENT_ONESHOT);
if (r < 0)
log_debug_errno(r, "Failed to enable run queue event source, ignoring: %m");
return 0;
}
static void mount_enumerate(Manager *m) {
int r;
@ -1906,12 +1891,6 @@ static void mount_enumerate(Manager *m) {
goto fail;
}
r = sd_event_source_set_ratelimit_expire_callback(m->mount_event_source, mount_on_ratelimit_expire);
if (r < 0) {
log_error_errno(r, "Failed to enable rate limit for mount events: %m");
goto fail;
}
(void) sd_event_source_set_description(m->mount_event_source, "mount-monitor-dispatch");
}
@ -2156,22 +2135,19 @@ static int mount_can_clean(Unit *u, ExecCleanMask *ret) {
return exec_context_get_clean_mask(&m->exec_context, ret);
}
static int mount_can_start(Unit *u) {
static int mount_test_start_limit(Unit *u) {
Mount *m = MOUNT(u);
int r;
assert(m);
if (sd_event_source_is_ratelimited(u->manager->mount_event_source))
return -EAGAIN;
r = unit_test_start_limit(u);
if (r < 0) {
mount_enter_dead(m, MOUNT_FAILURE_START_LIMIT_HIT);
return r;
}
return 1;
return 0;
}
static const char* const mount_exec_command_table[_MOUNT_EXEC_COMMAND_MAX] = {
@ -2272,5 +2248,5 @@ const UnitVTable mount_vtable = {
},
},
.can_start = mount_can_start,
.test_start_limit = mount_test_start_limit,
};

View File

@ -811,7 +811,7 @@ static void path_reset_failed(Unit *u) {
p->result = PATH_SUCCESS;
}
static int path_can_start(Unit *u) {
static int path_test_start_limit(Unit *u) {
Path *p = PATH(u);
int r;
@ -823,7 +823,7 @@ static int path_can_start(Unit *u) {
return r;
}
return 1;
return 0;
}
static const char* const path_type_table[_PATH_TYPE_MAX] = {
@ -882,5 +882,5 @@ const UnitVTable path_vtable = {
.bus_set_property = bus_path_set_property,
.can_start = path_can_start,
.test_start_limit = path_test_start_limit,
};

View File

@ -4482,7 +4482,7 @@ static const char *service_finished_job(Unit *u, JobType t, JobResult result) {
return NULL;
}
static int service_can_start(Unit *u) {
static int service_test_start_limit(Unit *u) {
Service *s = SERVICE(u);
int r;
@ -4495,7 +4495,7 @@ static int service_can_start(Unit *u) {
return r;
}
return 1;
return 0;
}
static const char* const service_restart_table[_SERVICE_RESTART_MAX] = {
@ -4669,5 +4669,5 @@ const UnitVTable service_vtable = {
.finished_job = service_finished_job,
},
.can_start = service_can_start,
.test_start_limit = service_test_start_limit,
};

View File

@ -3427,7 +3427,7 @@ static int socket_can_clean(Unit *u, ExecCleanMask *ret) {
return exec_context_get_clean_mask(&s->exec_context, ret);
}
static int socket_can_start(Unit *u) {
static int socket_test_start_limit(Unit *u) {
Socket *s = SOCKET(u);
int r;
@ -3439,7 +3439,7 @@ static int socket_can_start(Unit *u) {
return r;
}
return 1;
return 0;
}
static const char* const socket_exec_command_table[_SOCKET_EXEC_COMMAND_MAX] = {
@ -3570,5 +3570,5 @@ const UnitVTable socket_vtable = {
},
},
.can_start = socket_can_start,
.test_start_limit = socket_test_start_limit,
};

View File

@ -1581,7 +1581,7 @@ static int swap_can_clean(Unit *u, ExecCleanMask *ret) {
return exec_context_get_clean_mask(&s->exec_context, ret);
}
static int swap_can_start(Unit *u) {
static int swap_test_start_limit(Unit *u) {
Swap *s = SWAP(u);
int r;
@ -1593,7 +1593,7 @@ static int swap_can_start(Unit *u) {
return r;
}
return 1;
return 0;
}
static const char* const swap_exec_command_table[_SWAP_EXEC_COMMAND_MAX] = {
@ -1692,5 +1692,5 @@ const UnitVTable swap_vtable = {
},
},
.can_start = swap_can_start,
.test_start_limit = swap_test_start_limit,
};

View File

@ -889,7 +889,7 @@ static int timer_can_clean(Unit *u, ExecCleanMask *ret) {
return 0;
}
static int timer_can_start(Unit *u) {
static int timer_test_start_limit(Unit *u) {
Timer *t = TIMER(u);
int r;
@ -901,7 +901,7 @@ static int timer_can_start(Unit *u) {
return r;
}
return 1;
return 0;
}
static const char* const timer_base_table[_TIMER_BASE_MAX] = {
@ -965,5 +965,5 @@ const UnitVTable timer_vtable = {
.bus_set_property = bus_timer_set_property,
.can_start = timer_can_start,
.test_start_limit = timer_test_start_limit,
};

View File

@ -1904,9 +1904,9 @@ int unit_start(Unit *u) {
return unit_start(following);
}
/* Check our ability to start early so that failure conditions don't cause us to enter a busy loop. */
if (UNIT_VTABLE(u)->can_start) {
r = UNIT_VTABLE(u)->can_start(u);
/* Check start rate limiting early so that failure conditions don't cause us to enter a busy loop. */
if (UNIT_VTABLE(u)->test_start_limit) {
r = UNIT_VTABLE(u)->test_start_limit(u);
if (r < 0)
return r;
}

View File

@ -665,7 +665,7 @@ typedef struct UnitVTable {
/* If this function is set, it's invoked first as part of starting a unit to allow start rate
* limiting checks to occur before we do anything else. */
int (*can_start)(Unit *u);
int (*test_start_limit)(Unit *u);
/* The strings to print in status messages */
UnitStatusMessageFormats status_message_formats;

View File

@ -767,5 +767,4 @@ LIBSYSTEMD_250 {
global:
sd_device_get_diskseq;
sd_event_add_inotify_fd;
sd_event_source_set_ratelimit_expire_callback;
} LIBSYSTEMD_249;

View File

@ -71,7 +71,6 @@ struct sd_event_source {
uint64_t prepare_iteration;
sd_event_destroy_t destroy_callback;
sd_event_handler_t ratelimit_expire_callback;
LIST_FIELDS(sd_event_source, sources);

View File

@ -2908,7 +2908,7 @@ fail:
return r;
}
static int event_source_leave_ratelimit(sd_event_source *s, bool run_callback) {
static int event_source_leave_ratelimit(sd_event_source *s) {
int r;
assert(s);
@ -2940,30 +2940,6 @@ static int event_source_leave_ratelimit(sd_event_source *s, bool run_callback) {
ratelimit_reset(&s->rate_limit);
log_debug("Event source %p (%s) left rate limit state.", s, strna(s->description));
if (run_callback && s->ratelimit_expire_callback) {
s->dispatching = true;
r = s->ratelimit_expire_callback(s, s->userdata);
s->dispatching = false;
if (r < 0) {
log_debug_errno(r, "Ratelimit expiry callback of event source %s (type %s) returned error, %s: %m",
strna(s->description),
event_source_type_to_string(s->type),
s->exit_on_failure ? "exiting" : "disabling");
if (s->exit_on_failure)
(void) sd_event_exit(s->event, r);
}
if (s->n_ref == 0)
source_free(s);
else if (r < 0)
sd_event_source_set_enabled(s, SD_EVENT_OFF);
return 1;
}
return 0;
fail:
@ -3163,7 +3139,6 @@ static int process_timer(
struct clock_data *d) {
sd_event_source *s;
bool callback_invoked = false;
int r;
assert(e);
@ -3181,11 +3156,9 @@ static int process_timer(
* again. */
assert(s->ratelimited);
r = event_source_leave_ratelimit(s, /* run_callback */ true);
r = event_source_leave_ratelimit(s);
if (r < 0)
return r;
else if (r == 1)
callback_invoked = true;
continue;
}
@ -3200,7 +3173,7 @@ static int process_timer(
event_source_time_prioq_reshuffle(s);
}
return callback_invoked;
return 0;
}
static int process_child(sd_event *e, int64_t threshold, int64_t *ret_min_priority) {
@ -4124,10 +4097,6 @@ _public_ int sd_event_wait(sd_event *e, uint64_t timeout) {
if (r < 0)
goto finish;
r = process_inotify(e);
if (r < 0)
goto finish;
r = process_timer(e, e->timestamp.realtime, &e->realtime);
if (r < 0)
goto finish;
@ -4136,6 +4105,10 @@ _public_ int sd_event_wait(sd_event *e, uint64_t timeout) {
if (r < 0)
goto finish;
r = process_timer(e, e->timestamp.monotonic, &e->monotonic);
if (r < 0)
goto finish;
r = process_timer(e, e->timestamp.realtime, &e->realtime_alarm);
if (r < 0)
goto finish;
@ -4144,20 +4117,9 @@ _public_ int sd_event_wait(sd_event *e, uint64_t timeout) {
if (r < 0)
goto finish;
r = process_timer(e, e->timestamp.monotonic, &e->monotonic);
r = process_inotify(e);
if (r < 0)
goto finish;
else if (r == 1) {
/* Ratelimit expiry callback was called. Let's postpone processing pending sources and
* put loop in the initial state in order to evaluate (in the next iteration) also sources
* there were potentially re-enabled by the callback.
*
* Wondering why we treat only this invocation of process_timer() differently? Once event
* source is ratelimited we essentially transform it into CLOCK_MONOTONIC timer hence
* ratelimit expiry callback is never called for any other timer type. */
r = 0;
goto finish;
}
if (event_next_pending(e)) {
e->state = SD_EVENT_PENDING;
@ -4526,7 +4488,7 @@ _public_ int sd_event_source_set_ratelimit(sd_event_source *s, uint64_t interval
/* When ratelimiting is configured we'll always reset the rate limit state first and start fresh,
* non-ratelimited. */
r = event_source_leave_ratelimit(s, /* run_callback */ false);
r = event_source_leave_ratelimit(s);
if (r < 0)
return r;
@ -4534,13 +4496,6 @@ _public_ int sd_event_source_set_ratelimit(sd_event_source *s, uint64_t interval
return 0;
}
_public_ int sd_event_source_set_ratelimit_expire_callback(sd_event_source *s, sd_event_handler_t callback) {
assert_return(s, -EINVAL);
s->ratelimit_expire_callback = callback;
return 0;
}
_public_ int sd_event_source_get_ratelimit(sd_event_source *s, uint64_t *ret_interval, unsigned *ret_burst) {
assert_return(s, -EINVAL);

View File

@ -623,11 +623,6 @@ static int ratelimit_time_handler(sd_event_source *s, uint64_t usec, void *userd
return 0;
}
static int expired = -1;
static int ratelimit_expired(sd_event_source *s, void *userdata) {
return ++expired;
}
static void test_ratelimit(void) {
_cleanup_close_pair_ int p[2] = {-1, -1};
_cleanup_(sd_event_unrefp) sd_event *e = NULL;
@ -691,19 +686,12 @@ static void test_ratelimit(void) {
assert_se(sd_event_source_set_ratelimit(s, 1 * USEC_PER_SEC, 10) >= 0);
/* Set callback that will be invoked when we leave rate limited state. */
assert_se(sd_event_source_set_ratelimit_expire_callback(s, ratelimit_expired) >= 0);
do {
assert_se(sd_event_run(e, UINT64_MAX) >= 0);
} while (!sd_event_source_is_ratelimited(s));
log_info("ratelimit_time_handler: called 10 more times, event source got ratelimited");
assert_se(count == 20);
/* Dispatch the event loop once more and check that ratelimit expiration callback got called */
assert_se(sd_event_run(e, UINT64_MAX) >= 0);
assert_se(expired == 0);
}
static void test_simple_timeout(void) {

View File

@ -166,7 +166,6 @@ int sd_event_source_set_exit_on_failure(sd_event_source *s, int b);
int sd_event_source_set_ratelimit(sd_event_source *s, uint64_t interval_usec, unsigned burst);
int sd_event_source_get_ratelimit(sd_event_source *s, uint64_t *ret_interval_usec, unsigned *ret_burst);
int sd_event_source_is_ratelimited(sd_event_source *s);
int sd_event_source_set_ratelimit_expire_callback(sd_event_source *s, sd_event_handler_t callback);
/* Define helpers so that __attribute__((cleanup(sd_event_unrefp))) and similar may be used. */
_SD_DEFINE_POINTER_CLEANUP_FUNC(sd_event, sd_event_unref);