From ff5ba2d6fe18a40b7ed42a87e932f19c373c6a6d Mon Sep 17 00:00:00 2001 From: Yu Watanabe Date: Thu, 10 Oct 2024 10:01:24 +0900 Subject: [PATCH] sd-event: rename output parameters to ret --- man/sd_event_add_child.xml | 2 +- man/sd_event_add_io.xml | 4 +- man/sd_event_add_time.xml | 6 +- man/sd_event_exit.xml | 4 +- man/sd_event_new.xml | 2 +- man/sd_event_now.xml | 8 +-- man/sd_event_source_set_description.xml | 4 +- man/sd_event_source_set_enabled.xml | 6 +- src/libsystemd/sd-event/sd-event.c | 74 ++++++++++++------------- src/systemd/sd-event.h | 24 ++++---- 10 files changed, 67 insertions(+), 67 deletions(-) diff --git a/man/sd_event_add_child.xml b/man/sd_event_add_child.xml index 3406432afdd..fa2361d221a 100644 --- a/man/sd_event_add_child.xml +++ b/man/sd_event_add_child.xml @@ -66,7 +66,7 @@ int sd_event_source_get_child_pid sd_event_source *source - pid_t *pid + pid_t *ret diff --git a/man/sd_event_add_io.xml b/man/sd_event_add_io.xml index 3a405f0595c..6eab52b0305 100644 --- a/man/sd_event_add_io.xml +++ b/man/sd_event_add_io.xml @@ -57,7 +57,7 @@ int sd_event_source_get_io_events sd_event_source *source - uint32_t *events + uint32_t *ret @@ -69,7 +69,7 @@ int sd_event_source_get_io_revents sd_event_source *source - uint32_t *revents + uint32_t *ret diff --git a/man/sd_event_add_time.xml b/man/sd_event_add_time.xml index 159d5c9ebd3..c65c367eacc 100644 --- a/man/sd_event_add_time.xml +++ b/man/sd_event_add_time.xml @@ -67,7 +67,7 @@ int sd_event_source_get_time sd_event_source *source - uint64_t *usec + uint64_t *ret @@ -85,7 +85,7 @@ int sd_event_source_get_time_accuracy sd_event_source *source - uint64_t *usec + uint64_t *ret @@ -97,7 +97,7 @@ int sd_event_source_get_time_clock sd_event_source *source - clockid_t *clock + clockid_t *ret diff --git a/man/sd_event_exit.xml b/man/sd_event_exit.xml index aa3bc29e98d..faa1ea992fd 100644 --- a/man/sd_event_exit.xml +++ b/man/sd_event_exit.xml @@ -35,7 +35,7 @@ int sd_event_get_exit_code sd_event *event - int *code + int *ret @@ -66,7 +66,7 @@ otherwise no further operation is executed. sd_event_get_exit_code() may be used to query the exit code passed to an - earlier call of sd_event_exit(). The return parameter code + earlier call of sd_event_exit(). The return parameter ret may be set to NULL, in order to simply check if sd_event_exit() has been called before (as sd_event_get_exit_code() fails with -ENODATA if that's not the case, see below). diff --git a/man/sd_event_new.xml b/man/sd_event_new.xml index 57f448cb669..315b8f41db3 100644 --- a/man/sd_event_new.xml +++ b/man/sd_event_new.xml @@ -61,7 +61,7 @@ int sd_event_get_tid sd_event *event - pid_t *tid + pid_t *ret diff --git a/man/sd_event_now.xml b/man/sd_event_now.xml index 6f175a43c1b..123644ac572 100644 --- a/man/sd_event_now.xml +++ b/man/sd_event_now.xml @@ -29,7 +29,7 @@ int sd_event_now sd_event *event clockid_t clock - uint64_t *usec + uint64_t *ret @@ -52,7 +52,7 @@ CLOCK_BOOTTIME_ALARM), see clock_gettime2 for more information on the various clocks. The retrieved - timestamp is stored in the usec parameter, + timestamp is stored in the ret parameter, in μs since the clock's epoch. If this function is invoked before the first event loop iteration, the current time is returned, as reported by clock_gettime(). To distinguish @@ -65,8 +65,8 @@ Return Value If the first event loop iteration has not run yet sd_event_now() writes - current time to usec and returns a positive return value. Otherwise, it will - write the requested timestamp to usec and return 0. On failure, the call returns a + current time to ret and returns a positive return value. Otherwise, it will + write the requested timestamp to ret and return 0. On failure, the call returns a negative errno-style error code. diff --git a/man/sd_event_source_set_description.xml b/man/sd_event_source_set_description.xml index 1e50f2f06e8..2eb017be540 100644 --- a/man/sd_event_source_set_description.xml +++ b/man/sd_event_source_set_description.xml @@ -35,7 +35,7 @@ int sd_event_source_get_description sd_event_source *source - const char **description + const char **ret @@ -61,7 +61,7 @@ sd_event_source_get_description() may be used to query the current descriptive name assigned to the event source object source. It returns a - pointer to the current name in description, + pointer to the current name in ret, stored in memory internal to the event source. The memory is invalidated when the event source is destroyed or the descriptive name is changed. diff --git a/man/sd_event_source_set_enabled.xml b/man/sd_event_source_set_enabled.xml index 625bf13335f..d21a95f1440 100644 --- a/man/sd_event_source_set_enabled.xml +++ b/man/sd_event_source_set_enabled.xml @@ -44,7 +44,7 @@ int sd_event_source_get_enabled sd_event_source *source - int *enabled + int *ret @@ -69,10 +69,10 @@ sd_event_source_get_enabled() may be used to query whether the event source object source is currently enabled or not. If both the - source and the output parameter enabled are + source and the output parameter ret are NULL, this function returns false. Otherwise, source must be a valid pointer to an sd_event_source object. If the output parameter - enabled is not NULL, it is set to the enablement state (one + ret is not NULL, it is set to the enablement state (one of SD_EVENT_ON, SD_EVENT_OFF, SD_EVENT_ONESHOT). The function also returns true if the event source is not disabled. diff --git a/src/libsystemd/sd-event/sd-event.c b/src/libsystemd/sd-event/sd-event.c index ae1ab2dff9c..26b28d7bcf0 100644 --- a/src/libsystemd/sd-event/sd-event.c +++ b/src/libsystemd/sd-event/sd-event.c @@ -2618,14 +2618,14 @@ _public_ int sd_event_source_set_description(sd_event_source *s, const char *des return free_and_strdup(&s->description, description); } -_public_ int sd_event_source_get_description(sd_event_source *s, const char **description) { +_public_ int sd_event_source_get_description(sd_event_source *s, const char **ret) { assert_return(s, -EINVAL); - assert_return(description, -EINVAL); + assert_return(ret, -EINVAL); if (!s->description) return -ENXIO; - *description = s->description; + *ret = s->description; return 0; } @@ -2705,13 +2705,13 @@ _public_ int sd_event_source_set_io_fd_own(sd_event_source *s, int own) { return 0; } -_public_ int sd_event_source_get_io_events(sd_event_source *s, uint32_t* events) { +_public_ int sd_event_source_get_io_events(sd_event_source *s, uint32_t *ret) { assert_return(s, -EINVAL); - assert_return(events, -EINVAL); + assert_return(ret, -EINVAL); assert_return(s->type == SOURCE_IO, -EDOM); assert_return(!event_origin_changed(s->event), -ECHILD); - *events = s->io.events; + *ret = s->io.events; return 0; } @@ -2743,14 +2743,14 @@ _public_ int sd_event_source_set_io_events(sd_event_source *s, uint32_t events) return 0; } -_public_ int sd_event_source_get_io_revents(sd_event_source *s, uint32_t* revents) { +_public_ int sd_event_source_get_io_revents(sd_event_source *s, uint32_t *ret) { assert_return(s, -EINVAL); - assert_return(revents, -EINVAL); + assert_return(ret, -EINVAL); assert_return(s->type == SOURCE_IO, -EDOM); assert_return(s->pending, -ENODATA); assert_return(!event_origin_changed(s->event), -ECHILD); - *revents = s->io.revents; + *ret = s->io.revents; return 0; } @@ -2762,11 +2762,12 @@ _public_ int sd_event_source_get_signal(sd_event_source *s) { return s->signal.sig; } -_public_ int sd_event_source_get_priority(sd_event_source *s, int64_t *priority) { +_public_ int sd_event_source_get_priority(sd_event_source *s, int64_t *ret) { assert_return(s, -EINVAL); + assert_return(ret, -EINVAL); assert_return(!event_origin_changed(s->event), -ECHILD); - *priority = s->priority; + *ret = s->priority; return 0; } @@ -3107,13 +3108,13 @@ _public_ int sd_event_source_set_enabled(sd_event_source *s, int m) { return 0; } -_public_ int sd_event_source_get_time(sd_event_source *s, uint64_t *usec) { +_public_ int sd_event_source_get_time(sd_event_source *s, uint64_t *ret) { assert_return(s, -EINVAL); - assert_return(usec, -EINVAL); + assert_return(ret, -EINVAL); assert_return(EVENT_SOURCE_IS_TIME(s->type), -EDOM); assert_return(!event_origin_changed(s->event), -ECHILD); - *usec = s->time.next; + *ret = s->time.next; return 0; } @@ -3157,13 +3158,13 @@ _public_ int sd_event_source_set_time_relative(sd_event_source *s, uint64_t usec return sd_event_source_set_time(s, usec); } -_public_ int sd_event_source_get_time_accuracy(sd_event_source *s, uint64_t *usec) { +_public_ int sd_event_source_get_time_accuracy(sd_event_source *s, uint64_t *ret) { assert_return(s, -EINVAL); - assert_return(usec, -EINVAL); + assert_return(ret, -EINVAL); assert_return(EVENT_SOURCE_IS_TIME(s->type), -EDOM); assert_return(!event_origin_changed(s->event), -ECHILD); - *usec = s->time.accuracy; + *ret = s->time.accuracy; return 0; } @@ -3189,23 +3190,23 @@ _public_ int sd_event_source_set_time_accuracy(sd_event_source *s, uint64_t usec return 0; } -_public_ int sd_event_source_get_time_clock(sd_event_source *s, clockid_t *clock) { +_public_ int sd_event_source_get_time_clock(sd_event_source *s, clockid_t *ret) { assert_return(s, -EINVAL); - assert_return(clock, -EINVAL); + assert_return(ret, -EINVAL); assert_return(EVENT_SOURCE_IS_TIME(s->type), -EDOM); assert_return(!event_origin_changed(s->event), -ECHILD); - *clock = event_source_type_to_clock(s->type); + *ret = event_source_type_to_clock(s->type); return 0; } -_public_ int sd_event_source_get_child_pid(sd_event_source *s, pid_t *pid) { +_public_ int sd_event_source_get_child_pid(sd_event_source *s, pid_t *ret) { assert_return(s, -EINVAL); - assert_return(pid, -EINVAL); + assert_return(ret, -EINVAL); assert_return(s->type == SOURCE_CHILD, -EDOM); assert_return(!event_origin_changed(s->event), -ECHILD); - *pid = s->child.pid; + *ret = s->child.pid; return 0; } @@ -4951,7 +4952,7 @@ _public_ int sd_event_get_state(sd_event *e) { return e->state; } -_public_ int sd_event_get_exit_code(sd_event *e, int *code) { +_public_ int sd_event_get_exit_code(sd_event *e, int *ret) { assert_return(e, -EINVAL); assert_return(e = event_resolve(e), -ENOPKG); assert_return(!event_origin_changed(e), -ECHILD); @@ -4959,8 +4960,8 @@ _public_ int sd_event_get_exit_code(sd_event *e, int *code) { if (!e->exit_requested) return -ENODATA; - if (code) - *code = e->exit_code; + if (ret) + *ret = e->exit_code; return 0; } @@ -4976,10 +4977,10 @@ _public_ int sd_event_exit(sd_event *e, int code) { return 0; } -_public_ int sd_event_now(sd_event *e, clockid_t clock, uint64_t *usec) { +_public_ int sd_event_now(sd_event *e, clockid_t clock, uint64_t *ret) { assert_return(e, -EINVAL); assert_return(e = event_resolve(e), -ENOPKG); - assert_return(usec, -EINVAL); + assert_return(ret, -EINVAL); assert_return(!event_origin_changed(e), -ECHILD); if (!TRIPLE_TIMESTAMP_HAS_CLOCK(clock)) @@ -4987,11 +4988,11 @@ _public_ int sd_event_now(sd_event *e, clockid_t clock, uint64_t *usec) { if (!triple_timestamp_is_set(&e->timestamp)) { /* Implicitly fall back to now() if we never ran before and thus have no cached time. */ - *usec = now(clock); + *ret = now(clock); return 1; } - *usec = triple_timestamp_by_clock(&e->timestamp, clock); + *ret = triple_timestamp_by_clock(&e->timestamp, clock); return 0; } @@ -5019,18 +5020,17 @@ _public_ int sd_event_default(sd_event **ret) { return 1; } -_public_ int sd_event_get_tid(sd_event *e, pid_t *tid) { +_public_ int sd_event_get_tid(sd_event *e, pid_t *ret) { assert_return(e, -EINVAL); assert_return(e = event_resolve(e), -ENOPKG); - assert_return(tid, -EINVAL); + assert_return(ret, -EINVAL); assert_return(!event_origin_changed(e), -ECHILD); - if (e->tid != 0) { - *tid = e->tid; - return 0; - } + if (e->tid == 0) + return -ENXIO; - return -ENXIO; + *ret = e->tid; + return 0; } _public_ int sd_event_set_watchdog(sd_event *e, int b) { diff --git a/src/systemd/sd-event.h b/src/systemd/sd-event.h index 17479bd4e59..1e19dd4eac8 100644 --- a/src/systemd/sd-event.h +++ b/src/systemd/sd-event.h @@ -108,12 +108,12 @@ int sd_event_run(sd_event *e, uint64_t usec); int sd_event_loop(sd_event *e); int sd_event_exit(sd_event *e, int code); -int sd_event_now(sd_event *e, clockid_t clock, uint64_t *usec); +int sd_event_now(sd_event *e, clockid_t clock, uint64_t *ret); int sd_event_get_fd(sd_event *e); int sd_event_get_state(sd_event *e); -int sd_event_get_tid(sd_event *e, pid_t *tid); -int sd_event_get_exit_code(sd_event *e, int *code); +int sd_event_get_tid(sd_event *e, pid_t *ret); +int sd_event_get_exit_code(sd_event *e, int *ret); int sd_event_set_watchdog(sd_event *e, int b); int sd_event_get_watchdog(sd_event *e); int sd_event_get_iteration(sd_event *e, uint64_t *ret); @@ -128,28 +128,28 @@ void* sd_event_source_get_userdata(sd_event_source *s); void* sd_event_source_set_userdata(sd_event_source *s, void *userdata); int sd_event_source_set_description(sd_event_source *s, const char *description); -int sd_event_source_get_description(sd_event_source *s, const char **description); +int sd_event_source_get_description(sd_event_source *s, const char **ret); int sd_event_source_set_prepare(sd_event_source *s, sd_event_handler_t callback); int sd_event_source_get_pending(sd_event_source *s); -int sd_event_source_get_priority(sd_event_source *s, int64_t *priority); +int sd_event_source_get_priority(sd_event_source *s, int64_t *ret); int sd_event_source_set_priority(sd_event_source *s, int64_t priority); -int sd_event_source_get_enabled(sd_event_source *s, int *enabled); +int sd_event_source_get_enabled(sd_event_source *s, int *ret); int sd_event_source_set_enabled(sd_event_source *s, int enabled); int sd_event_source_get_io_fd(sd_event_source *s); int sd_event_source_set_io_fd(sd_event_source *s, int fd); int sd_event_source_get_io_fd_own(sd_event_source *s); int sd_event_source_set_io_fd_own(sd_event_source *s, int own); -int sd_event_source_get_io_events(sd_event_source *s, uint32_t* events); +int sd_event_source_get_io_events(sd_event_source *s, uint32_t *ret); int sd_event_source_set_io_events(sd_event_source *s, uint32_t events); -int sd_event_source_get_io_revents(sd_event_source *s, uint32_t* revents); -int sd_event_source_get_time(sd_event_source *s, uint64_t *usec); +int sd_event_source_get_io_revents(sd_event_source *s, uint32_t *ret); +int sd_event_source_get_time(sd_event_source *s, uint64_t *ret); int sd_event_source_set_time(sd_event_source *s, uint64_t usec); int sd_event_source_set_time_relative(sd_event_source *s, uint64_t usec); -int sd_event_source_get_time_accuracy(sd_event_source *s, uint64_t *usec); +int sd_event_source_get_time_accuracy(sd_event_source *s, uint64_t *ret); int sd_event_source_set_time_accuracy(sd_event_source *s, uint64_t usec); -int sd_event_source_get_time_clock(sd_event_source *s, clockid_t *clock); +int sd_event_source_get_time_clock(sd_event_source *s, clockid_t *ret); int sd_event_source_get_signal(sd_event_source *s); -int sd_event_source_get_child_pid(sd_event_source *s, pid_t *pid); +int sd_event_source_get_child_pid(sd_event_source *s, pid_t *ret); int sd_event_source_get_child_pidfd(sd_event_source *s); int sd_event_source_get_child_pidfd_own(sd_event_source *s); int sd_event_source_set_child_pidfd_own(sd_event_source *s, int own); -- 2.47.3