dasharo/systemd
0
0
Fork 0
mirror of https://github.com/Dasharo/systemd.git synced 2026-03-06 15:02:31 -08:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #25007 from keszybz/rename-dbus-dump

Browse Source 
manager: rename dbus method
This commit is contained in:
Zbigniew Jędrzejewski-Szmek
2022-10-18 11:34:16 +02:00
committed by GitHub
parent 29dbc62d74 b08d86dc4a
commit 9e11abe817
4 changed files with 139 additions and 62 deletions
Download Patch File Download Diff File Expand all files Collapse all files

31
man/org.freedesktop.systemd1.xml
View File

@@ -162,9 +162,11 @@ node /org/freedesktop/systemd1 {
Subscribe();
Unsubscribe();
Dump(out s output);
DumpPatterns(in as patterns,
out s output);
DumpUnitsMatchingPatterns(in as patterns,
out s output);
DumpByFileDescriptor(out h fd);
DumpUnitsMatchingPatternsByFileDescriptor(in as patterns,
out h fd);
Reload();
@org.freedesktop.DBus.Method.NoReply("true")
Reexecute();
@@ -870,10 +872,12 @@ node /org/freedesktop/systemd1 {
<variablelist class="dbus-method" generated="True" extra-ref="Dump()"/>
<variablelist class="dbus-method" generated="True" extra-ref="DumpPatterns()"/>
<variablelist class="dbus-method" generated="True" extra-ref="DumpUnitsMatchingPatterns()"/>
<variablelist class="dbus-method" generated="True" extra-ref="DumpByFileDescriptor()"/>
<variablelist class="dbus-method" generated="True" extra-ref="DumpUnitsMatchingPatternsByFileDescriptor()"/>
<variablelist class="dbus-method" generated="True" extra-ref="Reload()"/>
<variablelist class="dbus-method" generated="True" extra-ref="Reexecute()"/>
@@ -1342,15 +1346,18 @@ node /org/freedesktop/systemd1 {
string guaranteed, and new fields may be added any time, and old fields removed. The general structure
may be rearranged drastically between releases. This is exposed by
<citerefentry><refentrytitle>systemd-analyze</refentrytitle><manvolnum>1</manvolnum></citerefentry>'s
<command>dump</command> command. Similarly, <function>DumpPatterns()</function> returns the internal
state of units whose names match the glob expressions specified in the <varname>patterns</varname>
argument. The <function>DumpByFileDescriptor()</function> method is identical to
<function>Dump()</function> but returns the data serialized into a file descriptor (the client should
read the text data from it until hitting EOF). Given the size limits on D-Bus messages and the possibly
large size of the returned string, <function>DumpByFileDescriptor()</function> is usually the
preferable interface, since it ensures the data can be passed reliably from the service manager to the
client. (Note though that <function>DumpByFileDescriptor()</function> cannot work when communicating
with the service manager remotely, as file descriptors are strictly local to a system.)</para>
<command>dump</command> command. Similarly, <function>DumpUnitsMatchingPatterns()</function> returns
the internal state of units whose names match the glob expressions specified in the
<varname>patterns</varname> argument. The
<function>DumpByFileDescriptor()</function>/<function>DumpUnitsMatchingPatternsByFileDescriptor()</function>
methods are identical to <function>Dump()</function>/<function>DumpUnitsMatchingPatterns()</function>,
but return data serialized into a file descriptor (the client should read the text data from it until
hitting EOF). Given the size limits on D-Bus messages and the possibly large size of the returned
strings,
<function>DumpByFileDescriptor()</function>/<function>DumpUnitsMatchingPatternsByFileDescriptor()</function>
are usually the preferred interface, since it ensures the data can be passed reliably from the service
manager to the client. Note though that they cannot work when communicating with the service manager
remotely, as file descriptors are strictly local to a system.</para>
<para><function>Reload()</function> may be invoked to reload all unit files.</para>

139
src/analyze/analyze-dump.c
View File

@@ -12,14 +12,72 @@
static int dump_fallback(sd_bus *bus) {
_cleanup_(sd_bus_error_free) sd_bus_error error = SD_BUS_ERROR_NULL;
_cleanup_(sd_bus_message_unrefp) sd_bus_message *reply = NULL;
const char *text = NULL;
const char *text;
int r;
assert(bus);
r = bus_call_method(bus, bus_systemd_mgr, "Dump", &error, &reply, NULL);
if (r < 0)
return log_error_errno(r, "Failed to issue method call Dump: %s", bus_error_message(&error, r));
return log_error_errno(r, "Failed to call Dump: %s", bus_error_message(&error, r));
r = sd_bus_message_read(reply, "s", &text);
if (r < 0)
return bus_log_parse_error(r);
fputs(text, stdout);
return 0;
}
static int dump_fd_reply(sd_bus_message *message) {
int fd, r;
r = sd_bus_message_read(message, "h", &fd);
if (r < 0)
return bus_log_parse_error(r);
fflush(stdout);
r = copy_bytes(fd, STDOUT_FILENO, UINT64_MAX, 0);
if (r < 0)
return r;
return 1; /* Success */
}
static int dump(sd_bus *bus) {
_cleanup_(sd_bus_error_free) sd_bus_error error = SD_BUS_ERROR_NULL;
_cleanup_(sd_bus_message_unrefp) sd_bus_message *reply = NULL;
int r;
r = bus_call_method(bus, bus_systemd_mgr, "DumpByFileDescriptor", &error, &reply, NULL);
if (IN_SET(r, -EACCES, -EBADR))
return 0; /* Fall back to non-fd method. We need to do this even if the bus supports sending
* fds to cater to very old managers which didn't have the fd-based method. */
if (r < 0)
return log_error_errno(r, "Failed to call DumpByFileDescriptor: %s",
bus_error_message(&error, r));
return dump_fd_reply(reply);
}
static int dump_patterns_fallback(sd_bus *bus, char **patterns) {
_cleanup_(sd_bus_error_free) sd_bus_error error = SD_BUS_ERROR_NULL;
_cleanup_(sd_bus_message_unrefp) sd_bus_message *reply = NULL, *m = NULL;
const char *text;
int r;
r = bus_message_new_method_call(bus, &m, bus_systemd_mgr, "DumpUnitsMatchingPatterns");
if (r < 0)
return bus_log_create_error(r);
r = sd_bus_message_append_strv(m, patterns);
if (r < 0)
return bus_log_create_error(r);
r = sd_bus_call(bus, m, 0, &error, &reply);
if (r < 0)
return log_error_errno(r, "Failed to call DumpUnitsMatchingPatterns: %s",
bus_error_message(&error, r));
r = sd_bus_message_read(reply, "s", &text);
if (r < 0)
@@ -32,48 +90,50 @@ static int dump_fallback(sd_bus *bus) {
static int dump_patterns(sd_bus *bus, char **patterns) {
_cleanup_(sd_bus_error_free) sd_bus_error error = SD_BUS_ERROR_NULL;
_cleanup_(sd_bus_message_unrefp) sd_bus_message *reply = NULL, *m = NULL;
_cleanup_strv_free_ char **mangled = NULL;
const char *text;
int r;
r = bus_message_new_method_call(bus, &m, bus_systemd_mgr, "DumpPatterns");
r = bus_message_new_method_call(bus, &m, bus_systemd_mgr, "DumpUnitsMatchingPatternsByFileDescriptor");
if (r < 0)
return bus_log_create_error(r);
STRV_FOREACH(pattern, patterns) {
r = sd_bus_message_append_strv(m, patterns);
if (r < 0)
return bus_log_create_error(r);
r = sd_bus_call(bus, m, 0, &error, &reply);
if (r < 0)
return log_error_errno(r, "Failed to call DumpUnitsMatchingPatternsByFileDescriptor: %s",
bus_error_message(&error, r));
return dump_fd_reply(reply);
}
static int mangle_patterns(char **args, char ***ret) {
_cleanup_strv_free_ char **mangled = NULL;
int r;
STRV_FOREACH(arg, args) {
char *t;
r = unit_name_mangle_with_suffix(*pattern, NULL, UNIT_NAME_MANGLE_GLOB, ".service", &t);
r = unit_name_mangle_with_suffix(*arg, NULL, UNIT_NAME_MANGLE_GLOB, ".service", &t);
if (r < 0)
return log_error_errno(r, "Failed to mangle name: %m");
return log_error_errno(r, "Failed to mangle name '%s': %m", *arg);
r = strv_consume(&mangled, t);
if (r < 0)
return log_oom();
}
r = sd_bus_message_append_strv(m, mangled);
if (r < 0)
return bus_log_create_error(r);
if (strv_isempty(mangled))
mangled = strv_free(mangled);
r = sd_bus_call(bus, m, 0, &error, &reply);
if (r < 0)
return log_error_errno(r, "Failed to issue method call DumpPatterns: %s",
bus_error_message(&error, r));
r = sd_bus_message_read(reply, "s", &text);
if (r < 0)
return bus_log_parse_error(r);
fputs(text, stdout);
return r;
*ret = TAKE_PTR(mangled);
return 0;
}
int verb_dump(int argc, char *argv[], void *userdata) {
_cleanup_(sd_bus_error_free) sd_bus_error error = SD_BUS_ERROR_NULL;
_cleanup_(sd_bus_message_unrefp) sd_bus_message *reply = NULL;
_cleanup_(sd_bus_flush_close_unrefp) sd_bus *bus = NULL;
int fd = -1;
_cleanup_strv_free_ char **patterns = NULL;
int r;
r = acquire_bus(&bus, NULL);
@@ -82,28 +142,17 @@ int verb_dump(int argc, char *argv[], void *userdata) {
pager_open(arg_pager_flags);
if (argc > 1)
return dump_patterns(bus, strv_skip(argv, 1));
if (!sd_bus_can_send(bus, SD_BUS_TYPE_UNIX_FD))
return dump_fallback(bus);
r = bus_call_method(bus, bus_systemd_mgr, "DumpByFileDescriptor", &error, &reply, NULL);
if (r < 0) {
/* fall back to Dump if DumpByFileDescriptor is not supported */
if (!IN_SET(r, -EACCES, -EBADR))
return log_error_errno(r, "Failed to issue method call DumpByFileDescriptor: %s",
bus_error_message(&error, r));
return dump_fallback(bus);
}
r = sd_bus_message_read(reply, "h", &fd);
r = mangle_patterns(strv_skip(argv, 1), &patterns);
if (r < 0)
return bus_log_parse_error(r);
return r;
fflush(stdout);
r = copy_bytes(fd, STDOUT_FILENO, UINT64_MAX, 0);
r = sd_bus_can_send(bus, SD_BUS_TYPE_UNIX_FD);
if (r < 0)
return log_error_errno(r, "Unable to determine if bus connection supports fd passing: %m");
if (r > 0)
r = patterns ? dump_patterns(bus, patterns) : dump(bus);
if (r == 0) /* wasn't supported */
r = patterns ? dump_patterns_fallback(bus, patterns) : dump_fallback(bus);
if (r < 0)
return r;

25
src/core/dbus-manager.c
View File

@@ -1392,7 +1392,11 @@ static int method_dump_by_fd(sd_bus_message *message, void *userdata, sd_bus_err
return dump_impl(message, userdata, error, NULL, reply_dump_by_fd);
}
static int method_dump_patterns(sd_bus_message *message, void *userdata, sd_bus_error *error) {
static int dump_units_matching_patterns(
sd_bus_message *message,
void *userdata,
sd_bus_error *error,
int (*reply)(sd_bus_message *, char *)) {
_cleanup_strv_free_ char **patterns = NULL;
int r;
@@ -1400,7 +1404,15 @@ static int method_dump_patterns(sd_bus_message *message, void *userdata, sd_bus_
if (r < 0)
return r;
return dump_impl(message, userdata, error, patterns, reply_dump);
return dump_impl(message, userdata, error, patterns, reply);
}
static int method_dump_units_matching_patterns(sd_bus_message *message, void *userdata, sd_bus_error *error) {
return dump_units_matching_patterns(message, userdata, error, reply_dump);
}
static int method_dump_units_matching_patterns_by_fd(sd_bus_message *message, void *userdata, sd_bus_error *error) {
return dump_units_matching_patterns(message, userdata, error, reply_dump_by_fd);
}
static int method_refuse_snapshot(sd_bus_message *message, void *userdata, sd_bus_error *error) {
@@ -3027,16 +3039,21 @@ const sd_bus_vtable bus_manager_vtable[] = {
SD_BUS_RESULT("s", output),
method_dump,
SD_BUS_VTABLE_UNPRIVILEGED),
SD_BUS_METHOD_WITH_ARGS("DumpPatterns",
SD_BUS_METHOD_WITH_ARGS("DumpUnitsMatchingPatterns",
SD_BUS_ARGS("as", patterns),
SD_BUS_RESULT("s", output),
method_dump_patterns,
method_dump_units_matching_patterns,
SD_BUS_VTABLE_UNPRIVILEGED),
SD_BUS_METHOD_WITH_ARGS("DumpByFileDescriptor",
SD_BUS_NO_ARGS,
SD_BUS_RESULT("h", fd),
method_dump_by_fd,
SD_BUS_VTABLE_UNPRIVILEGED),
SD_BUS_METHOD_WITH_ARGS("DumpUnitsMatchingPatternsByFileDescriptor",
SD_BUS_ARGS("as", patterns),
SD_BUS_RESULT("h", fd),
method_dump_units_matching_patterns_by_fd,
SD_BUS_VTABLE_UNPRIVILEGED),
SD_BUS_METHOD_WITH_ARGS("CreateSnapshot",
SD_BUS_ARGS("s", name, "b", cleanup),
SD_BUS_RESULT("o", unit),

6
src/core/org.freedesktop.systemd1.conf
View File

@@ -122,7 +122,11 @@
<allow send_destination="org.freedesktop.systemd1"
send_interface="org.freedesktop.systemd1.Manager"
send_member="DumpPatterns"/>
send_member="DumpUnitsMatchingPatterns"/>
<allow send_destination="org.freedesktop.systemd1"
send_interface="org.freedesktop.systemd1.Manager"
send_member="DumpUnitsMatchingPatternsByFileDescriptor"/>
<allow send_destination="org.freedesktop.systemd1"
send_interface="org.freedesktop.systemd1.Manager"