]> git.ipfire.org Git - thirdparty/systemd.git/commitdiff
journald: split out varlink code into a separate .c file
authorLennart Poettering <lennart@poettering.net>
Tue, 25 Mar 2025 15:57:44 +0000 (11:57 -0400)
committerLennart Poettering <lennart@poettering.net>
Wed, 2 Apr 2025 15:32:05 +0000 (17:32 +0200)
No actual code changes just splitting out code.

src/journal/journald-server.c
src/journal/journald-server.h
src/journal/journald-varlink.c [new file with mode: 0644]
src/journal/journald-varlink.h [new file with mode: 0644]
src/journal/meson.build

index 13a95ef015d808aaacaaa741b7dc606a97e7404a..6144ff0de09ebdb0d7331182e19f539268a84f1a 100644 (file)
@@ -45,6 +45,7 @@
 #include "journald-socket.h"
 #include "journald-stream.h"
 #include "journald-syslog.h"
+#include "journald-varlink.h"
 #include "log.h"
 #include "memory-util.h"
 #include "missing_audit.h"
@@ -64,9 +65,6 @@
 #include "syslog-util.h"
 #include "uid-classification.h"
 #include "user-util.h"
-#include "varlink-io.systemd.Journal.h"
-#include "varlink-io.systemd.service.h"
-#include "varlink-util.h"
 
 #define USER_JOURNALS_MAX 1024
 
@@ -1462,7 +1460,7 @@ finish:
         return r;
 }
 
-static int server_relinquish_var(Server *s) {
+int server_relinquish_var(Server *s) {
         assert(s);
 
         if (s->storage == STORAGE_NONE)
@@ -1621,7 +1619,7 @@ int server_process_datagram(
         return 0;
 }
 
-static void server_full_flush(Server *s) {
+void server_full_flush(Server *s) {
         assert(s);
 
         (void) server_flush_to_var(s, false);
@@ -1647,7 +1645,7 @@ static int dispatch_sigusr1(sd_event_source *es, const struct signalfd_siginfo *
         return 0;
 }
 
-static void server_full_rotate(Server *s) {
+void server_full_rotate(Server *s) {
         const char *fn;
         int r;
 
@@ -1757,7 +1755,7 @@ fail:
         return 0;
 }
 
-static void server_full_sync(Server *s, bool wait) {
+void server_full_sync(Server *s, bool wait) {
         const char *fn;
         int r;
 
@@ -2188,201 +2186,6 @@ static int server_connect_notify(Server *s) {
         return 0;
 }
 
-static int synchronize_second_half(sd_event_source *event_source, void *userdata) {
-        sd_varlink *link = ASSERT_PTR(userdata);
-        Server *s;
-        int r;
-
-        assert_se(s = sd_varlink_get_userdata(link));
-
-        /* This is the "second half" of the Synchronize() varlink method. This function is called as deferred
-         * event source at a low priority to ensure the synchronization completes after all queued log
-         * messages are processed. */
-        server_full_sync(s, /* wait = */ true);
-
-        /* Let's get rid of the event source now, by marking it as non-floating again. It then has no ref
-         * anymore and is immediately destroyed after we return from this function, i.e. from this event
-         * source handler at the end. */
-        r = sd_event_source_set_floating(event_source, false);
-        if (r < 0)
-                return log_error_errno(r, "Failed to mark event source as non-floating: %m");
-
-        return sd_varlink_reply(link, NULL);
-}
-
-static void synchronize_destroy(void *userdata) {
-        sd_varlink_unref(userdata);
-}
-
-static int vl_method_synchronize(sd_varlink *link, sd_json_variant *parameters, sd_varlink_method_flags_t flags, void *userdata) {
-        _cleanup_(sd_event_source_unrefp) sd_event_source *event_source = NULL;
-        Server *s = ASSERT_PTR(userdata);
-        int r;
-
-        assert(link);
-
-        r = sd_varlink_dispatch(link, parameters, /* dispatch_table = */ NULL, /* userdata = */ NULL);
-        if (r != 0)
-                return r;
-
-        log_info("Received client request to sync journal.");
-
-        /* We don't do the main work now, but instead enqueue a deferred event loop job which will do
-         * it. That job is scheduled at low priority, so that we return from this method call only after all
-         * queued but not processed log messages are written to disk, so that this method call returning can
-         * be used as nice synchronization point. */
-        r = sd_event_add_defer(s->event, &event_source, synchronize_second_half, link);
-        if (r < 0)
-                return log_error_errno(r, "Failed to allocate defer event source: %m");
-
-        r = sd_event_source_set_destroy_callback(event_source, synchronize_destroy);
-        if (r < 0)
-                return log_error_errno(r, "Failed to set event source destroy callback: %m");
-
-        sd_varlink_ref(link); /* The varlink object is now left to the destroy callback to unref */
-
-        r = sd_event_source_set_priority(event_source, SD_EVENT_PRIORITY_NORMAL+15);
-        if (r < 0)
-                return log_error_errno(r, "Failed to set defer event source priority: %m");
-
-        /* Give up ownership of this event source. It will now be destroyed along with event loop itself,
-         * unless it destroys itself earlier. */
-        r = sd_event_source_set_floating(event_source, true);
-        if (r < 0)
-                return log_error_errno(r, "Failed to mark event source as floating: %m");
-
-        (void) sd_event_source_set_description(event_source, "deferred-sync");
-
-        return 0;
-}
-
-static int vl_method_rotate(sd_varlink *link, sd_json_variant *parameters, sd_varlink_method_flags_t flags, void *userdata) {
-        Server *s = ASSERT_PTR(userdata);
-        int r;
-
-        assert(link);
-
-        r = sd_varlink_dispatch(link, parameters, /* dispatch_table = */ NULL, /* userdata = */ NULL);
-        if (r != 0)
-                return r;
-
-        log_info("Received client request to rotate journal, rotating.");
-        server_full_rotate(s);
-
-        return sd_varlink_reply(link, NULL);
-}
-
-static int vl_method_flush_to_var(sd_varlink *link, sd_json_variant *parameters, sd_varlink_method_flags_t flags, void *userdata) {
-        Server *s = ASSERT_PTR(userdata);
-        int r;
-
-        assert(link);
-
-        r = sd_varlink_dispatch(link, parameters, /* dispatch_table = */ NULL, /* userdata = */ NULL);
-        if (r != 0)
-                return r;
-
-        if (s->namespace)
-                return sd_varlink_error(link, "io.systemd.Journal.NotSupportedByNamespaces", NULL);
-
-        log_info("Received client request to flush runtime journal.");
-        server_full_flush(s);
-
-        return sd_varlink_reply(link, NULL);
-}
-
-static int vl_method_relinquish_var(sd_varlink *link, sd_json_variant *parameters, sd_varlink_method_flags_t flags, void *userdata) {
-        Server *s = ASSERT_PTR(userdata);
-        int r;
-
-        assert(link);
-
-        r = sd_varlink_dispatch(link, parameters, /* dispatch_table = */ NULL, /* userdata = */ NULL);
-        if (r != 0)
-                return r;
-
-        if (s->namespace)
-                return sd_varlink_error(link, "io.systemd.Journal.NotSupportedByNamespaces", NULL);
-
-        log_info("Received client request to relinquish %s access.", s->system_storage.path);
-        server_relinquish_var(s);
-
-        return sd_varlink_reply(link, NULL);
-}
-
-static int vl_connect(sd_varlink_server *server, sd_varlink *link, void *userdata) {
-        Server *s = ASSERT_PTR(userdata);
-
-        assert(server);
-        assert(link);
-
-        (void) server_start_or_stop_idle_timer(s); /* maybe we are no longer idle */
-
-        return 0;
-}
-
-static void vl_disconnect(sd_varlink_server *server, sd_varlink *link, void *userdata) {
-        Server *s = ASSERT_PTR(userdata);
-
-        assert(server);
-        assert(link);
-
-        (void) server_start_or_stop_idle_timer(s); /* maybe we are idle now */
-}
-
-static int server_open_varlink(Server *s, const char *socket, int fd) {
-        int r;
-
-        assert(s);
-
-        r = varlink_server_new(
-                        &s->varlink_server,
-                        SD_VARLINK_SERVER_ROOT_ONLY|SD_VARLINK_SERVER_INHERIT_USERDATA,
-                        s);
-        if (r < 0)
-                return log_error_errno(r, "Failed to allocate varlink server object: %m");
-
-        r = sd_varlink_server_add_interface_many(
-                        s->varlink_server,
-                        &vl_interface_io_systemd_Journal,
-                        &vl_interface_io_systemd_service);
-        if (r < 0)
-                return log_error_errno(r, "Failed to add Journal interface to varlink server: %m");
-
-        r = sd_varlink_server_bind_method_many(
-                        s->varlink_server,
-                        "io.systemd.Journal.Synchronize",    vl_method_synchronize,
-                        "io.systemd.Journal.Rotate",         vl_method_rotate,
-                        "io.systemd.Journal.FlushToVar",     vl_method_flush_to_var,
-                        "io.systemd.Journal.RelinquishVar",  vl_method_relinquish_var,
-                        "io.systemd.service.Ping",           varlink_method_ping,
-                        "io.systemd.service.SetLogLevel",    varlink_method_set_log_level,
-                        "io.systemd.service.GetEnvironment", varlink_method_get_environment);
-        if (r < 0)
-                return r;
-
-        r = sd_varlink_server_bind_connect(s->varlink_server, vl_connect);
-        if (r < 0)
-                return r;
-
-        r = sd_varlink_server_bind_disconnect(s->varlink_server, vl_disconnect);
-        if (r < 0)
-                return r;
-
-        if (fd < 0)
-                r = sd_varlink_server_listen_address(s->varlink_server, socket, 0600);
-        else
-                r = sd_varlink_server_listen_fd(s->varlink_server, fd);
-        if (r < 0)
-                return r;
-
-        r = sd_varlink_server_attach_event(s->varlink_server, s->event, SD_EVENT_PRIORITY_NORMAL);
-        if (r < 0)
-                return r;
-
-        return 0;
-}
-
 int server_map_seqnum_file(
                 Server *s,
                 const char *fname,
index c8669a8a97699f621593a745a92e21c57a737f8f..50a25b89d0fa2dcadca9f1302e6538c4495e5a38 100644 (file)
@@ -232,9 +232,13 @@ int server_new(Server **ret);
 int server_init(Server *s, const char *namespace);
 Server* server_free(Server *s);
 DEFINE_TRIVIAL_CLEANUP_FUNC(Server*, server_free);
+void server_full_sync(Server *s, bool wait);
 void server_vacuum(Server *s, bool verbose);
 void server_rotate(Server *s);
+void server_full_rotate(Server *s);
 int server_flush_to_var(Server *s, bool require_flag_file);
+void server_full_flush(Server *s);
+int server_relinquish_var(Server *s);
 void server_maybe_append_tags(Server *s);
 int server_process_datagram(sd_event_source *es, int fd, uint32_t revents, void *userdata);
 void server_space_usage_message(Server *s, JournalStorage *storage);
diff --git a/src/journal/journald-varlink.c b/src/journal/journald-varlink.c
new file mode 100644 (file)
index 0000000..5e98b5e
--- /dev/null
@@ -0,0 +1,201 @@
+/* SPDX-License-Identifier: LGPL-2.1-or-later */
+
+#include "journald-varlink.h"
+#include "varlink-io.systemd.Journal.h"
+#include "varlink-io.systemd.service.h"
+#include "varlink-util.h"
+
+static int synchronize_second_half(sd_event_source *event_source, void *userdata) {
+        sd_varlink *link = ASSERT_PTR(userdata);
+        Server *s;
+        int r;
+
+        assert_se(s = sd_varlink_get_userdata(link));
+
+        /* This is the "second half" of the Synchronize() varlink method. This function is called as deferred
+         * event source at a low priority to ensure the synchronization completes after all queued log
+         * messages are processed. */
+        server_full_sync(s, /* wait = */ true);
+
+        /* Let's get rid of the event source now, by marking it as non-floating again. It then has no ref
+         * anymore and is immediately destroyed after we return from this function, i.e. from this event
+         * source handler at the end. */
+        r = sd_event_source_set_floating(event_source, false);
+        if (r < 0)
+                return log_error_errno(r, "Failed to mark event source as non-floating: %m");
+
+        return sd_varlink_reply(link, NULL);
+}
+
+static void synchronize_destroy(void *userdata) {
+        sd_varlink_unref(userdata);
+}
+
+static int vl_method_synchronize(sd_varlink *link, sd_json_variant *parameters, sd_varlink_method_flags_t flags, void *userdata) {
+        _cleanup_(sd_event_source_unrefp) sd_event_source *event_source = NULL;
+        Server *s = ASSERT_PTR(userdata);
+        int r;
+
+        assert(link);
+
+        r = sd_varlink_dispatch(link, parameters, /* dispatch_table = */ NULL, /* userdata = */ NULL);
+        if (r != 0)
+                return r;
+
+        log_info("Received client request to sync journal.");
+
+        /* We don't do the main work now, but instead enqueue a deferred event loop job which will do
+         * it. That job is scheduled at low priority, so that we return from this method call only after all
+         * queued but not processed log messages are written to disk, so that this method call returning can
+         * be used as nice synchronization point. */
+        r = sd_event_add_defer(s->event, &event_source, synchronize_second_half, link);
+        if (r < 0)
+                return log_error_errno(r, "Failed to allocate defer event source: %m");
+
+        r = sd_event_source_set_destroy_callback(event_source, synchronize_destroy);
+        if (r < 0)
+                return log_error_errno(r, "Failed to set event source destroy callback: %m");
+
+        sd_varlink_ref(link); /* The varlink object is now left to the destroy callback to unref */
+
+        r = sd_event_source_set_priority(event_source, SD_EVENT_PRIORITY_NORMAL+15);
+        if (r < 0)
+                return log_error_errno(r, "Failed to set defer event source priority: %m");
+
+        /* Give up ownership of this event source. It will now be destroyed along with event loop itself,
+         * unless it destroys itself earlier. */
+        r = sd_event_source_set_floating(event_source, true);
+        if (r < 0)
+                return log_error_errno(r, "Failed to mark event source as floating: %m");
+
+        (void) sd_event_source_set_description(event_source, "deferred-sync");
+
+        return 0;
+}
+
+static int vl_method_rotate(sd_varlink *link, sd_json_variant *parameters, sd_varlink_method_flags_t flags, void *userdata) {
+        Server *s = ASSERT_PTR(userdata);
+        int r;
+
+        assert(link);
+
+        r = sd_varlink_dispatch(link, parameters, /* dispatch_table = */ NULL, /* userdata = */ NULL);
+        if (r != 0)
+                return r;
+
+        log_info("Received client request to rotate journal, rotating.");
+        server_full_rotate(s);
+
+        return sd_varlink_reply(link, NULL);
+}
+
+static int vl_method_flush_to_var(sd_varlink *link, sd_json_variant *parameters, sd_varlink_method_flags_t flags, void *userdata) {
+        Server *s = ASSERT_PTR(userdata);
+        int r;
+
+        assert(link);
+
+        r = sd_varlink_dispatch(link, parameters, /* dispatch_table = */ NULL, /* userdata = */ NULL);
+        if (r != 0)
+                return r;
+
+        if (s->namespace)
+                return sd_varlink_error(link, "io.systemd.Journal.NotSupportedByNamespaces", NULL);
+
+        log_info("Received client request to flush runtime journal.");
+        server_full_flush(s);
+
+        return sd_varlink_reply(link, NULL);
+}
+
+static int vl_method_relinquish_var(sd_varlink *link, sd_json_variant *parameters, sd_varlink_method_flags_t flags, void *userdata) {
+        Server *s = ASSERT_PTR(userdata);
+        int r;
+
+        assert(link);
+
+        r = sd_varlink_dispatch(link, parameters, /* dispatch_table = */ NULL, /* userdata = */ NULL);
+        if (r != 0)
+                return r;
+
+        if (s->namespace)
+                return sd_varlink_error(link, "io.systemd.Journal.NotSupportedByNamespaces", NULL);
+
+        log_info("Received client request to relinquish %s access.", s->system_storage.path);
+        server_relinquish_var(s);
+
+        return sd_varlink_reply(link, NULL);
+}
+
+static int vl_connect(sd_varlink_server *server, sd_varlink *link, void *userdata) {
+        Server *s = ASSERT_PTR(userdata);
+
+        assert(server);
+        assert(link);
+
+        (void) server_start_or_stop_idle_timer(s); /* maybe we are no longer idle */
+
+        return 0;
+}
+
+static void vl_disconnect(sd_varlink_server *server, sd_varlink *link, void *userdata) {
+        Server *s = ASSERT_PTR(userdata);
+
+        assert(server);
+        assert(link);
+
+        (void) server_start_or_stop_idle_timer(s); /* maybe we are idle now */
+}
+
+int server_open_varlink(Server *s, const char *socket, int fd) {
+        int r;
+
+        assert(s);
+
+        r = varlink_server_new(
+                        &s->varlink_server,
+                        SD_VARLINK_SERVER_ROOT_ONLY|SD_VARLINK_SERVER_INHERIT_USERDATA,
+                        s);
+        if (r < 0)
+                return log_error_errno(r, "Failed to allocate varlink server object: %m");
+
+        r = sd_varlink_server_add_interface_many(
+                        s->varlink_server,
+                        &vl_interface_io_systemd_Journal,
+                        &vl_interface_io_systemd_service);
+        if (r < 0)
+                return log_error_errno(r, "Failed to add Journal interface to varlink server: %m");
+
+        r = sd_varlink_server_bind_method_many(
+                        s->varlink_server,
+                        "io.systemd.Journal.Synchronize",    vl_method_synchronize,
+                        "io.systemd.Journal.Rotate",         vl_method_rotate,
+                        "io.systemd.Journal.FlushToVar",     vl_method_flush_to_var,
+                        "io.systemd.Journal.RelinquishVar",  vl_method_relinquish_var,
+                        "io.systemd.service.Ping",           varlink_method_ping,
+                        "io.systemd.service.SetLogLevel",    varlink_method_set_log_level,
+                        "io.systemd.service.GetEnvironment", varlink_method_get_environment);
+        if (r < 0)
+                return r;
+
+        r = sd_varlink_server_bind_connect(s->varlink_server, vl_connect);
+        if (r < 0)
+                return r;
+
+        r = sd_varlink_server_bind_disconnect(s->varlink_server, vl_disconnect);
+        if (r < 0)
+                return r;
+
+        if (fd < 0)
+                r = sd_varlink_server_listen_address(s->varlink_server, socket, 0600);
+        else
+                r = sd_varlink_server_listen_fd(s->varlink_server, fd);
+        if (r < 0)
+                return r;
+
+        r = sd_varlink_server_attach_event(s->varlink_server, s->event, SD_EVENT_PRIORITY_NORMAL);
+        if (r < 0)
+                return r;
+
+        return 0;
+}
diff --git a/src/journal/journald-varlink.h b/src/journal/journald-varlink.h
new file mode 100644 (file)
index 0000000..55c7405
--- /dev/null
@@ -0,0 +1,6 @@
+/* SPDX-License-Identifier: LGPL-2.1-or-later */
+#pragma once
+
+#include "journald-server.h"
+
+int server_open_varlink(Server *s, const char *socket, int fd);
index 9f0e6995018d648583f47632a262d9faa36f170a..b7925fb97f97f370989e8bd1647b74e3e446e4a3 100644 (file)
@@ -9,10 +9,11 @@ sources = files(
         'journald-native.c',
         'journald-rate-limit.c',
         'journald-server.c',
+        'journald-socket.c',
         'journald-stream.c',
         'journald-syslog.c',
+        'journald-varlink.c',
         'journald-wall.c',
-        'journald-socket.c',
 )
 
 sources += custom_target(