1 /* SPDX-License-Identifier: LGPL-2.1-or-later */
3 #include "core-varlink.h"
4 #include "mkdir-label.h"
8 #include "varlink-io.systemd.UserDatabase.h"
9 #include "varlink-io.systemd.ManagedOOM.h"
11 typedef struct LookupParameters
{
12 const char *user_name
;
13 const char *group_name
;
21 static const char* const managed_oom_mode_properties
[] = {
23 "ManagedOOMMemoryPressure",
26 static int build_user_json(const char *user_name
, uid_t uid
, JsonVariant
**ret
) {
28 assert(uid_is_valid(uid
));
31 return json_build(ret
, JSON_BUILD_OBJECT(
32 JSON_BUILD_PAIR("record", JSON_BUILD_OBJECT(
33 JSON_BUILD_PAIR("userName", JSON_BUILD_STRING(user_name
)),
34 JSON_BUILD_PAIR("uid", JSON_BUILD_UNSIGNED(uid
)),
35 JSON_BUILD_PAIR("gid", JSON_BUILD_UNSIGNED(uid
)),
36 JSON_BUILD_PAIR("realName", JSON_BUILD_CONST_STRING("Dynamic User")),
37 JSON_BUILD_PAIR("homeDirectory", JSON_BUILD_CONST_STRING("/")),
38 JSON_BUILD_PAIR("shell", JSON_BUILD_CONST_STRING(NOLOGIN
)),
39 JSON_BUILD_PAIR("locked", JSON_BUILD_BOOLEAN(true)),
40 JSON_BUILD_PAIR("service", JSON_BUILD_CONST_STRING("io.systemd.DynamicUser")),
41 JSON_BUILD_PAIR("disposition", JSON_BUILD_CONST_STRING("dynamic"))))));
44 static bool user_match_lookup_parameters(LookupParameters
*p
, const char *name
, uid_t uid
) {
47 if (p
->user_name
&& !streq(name
, p
->user_name
))
50 if (uid_is_valid(p
->uid
) && uid
!= p
->uid
)
56 static int build_managed_oom_json_array_element(Unit
*u
, const char *property
, JsonVariant
**ret_v
) {
57 bool use_limit
= false;
65 if (!UNIT_VTABLE(u
)->can_set_managed_oom
)
68 c
= unit_get_cgroup_context(u
);
72 CGroupRuntime
*crt
= unit_get_cgroup_runtime(u
);
76 if (UNIT_IS_INACTIVE_OR_FAILED(unit_active_state(u
)))
77 /* systemd-oomd should always treat inactive units as though they didn't enable any action since they
78 * should not have a valid cgroup */
79 mode
= managed_oom_mode_to_string(MANAGED_OOM_AUTO
);
80 else if (streq(property
, "ManagedOOMSwap"))
81 mode
= managed_oom_mode_to_string(c
->moom_swap
);
82 else if (streq(property
, "ManagedOOMMemoryPressure")) {
83 mode
= managed_oom_mode_to_string(c
->moom_mem_pressure
);
88 return json_build(ret_v
, JSON_BUILD_OBJECT(
89 JSON_BUILD_PAIR("mode", JSON_BUILD_STRING(mode
)),
90 JSON_BUILD_PAIR("path", JSON_BUILD_STRING(crt
->cgroup_path
)),
91 JSON_BUILD_PAIR("property", JSON_BUILD_STRING(property
)),
92 JSON_BUILD_PAIR_CONDITION(use_limit
, "limit", JSON_BUILD_UNSIGNED(c
->moom_mem_pressure_limit
))));
95 int manager_varlink_send_managed_oom_update(Unit
*u
) {
96 _cleanup_(json_variant_unrefp
) JsonVariant
*arr
= NULL
, *v
= NULL
;
103 if (!UNIT_VTABLE(u
)->can_set_managed_oom
|| !u
->manager
)
106 crt
= unit_get_cgroup_runtime(u
);
107 if (!crt
|| !crt
->cgroup_path
)
110 if (MANAGER_IS_SYSTEM(u
->manager
)) {
111 /* In system mode we can't send any notifications unless oomd connected back to us. In this
112 * mode oomd must initiate communication, not us. */
113 if (!u
->manager
->managed_oom_varlink
)
116 /* If we are in user mode, let's connect to oomd if we aren't connected yet. In this mode we
117 * must initiate communication to oomd, not the other way round. */
118 r
= manager_varlink_init(u
->manager
);
123 c
= unit_get_cgroup_context(u
);
127 r
= json_build(&arr
, JSON_BUILD_EMPTY_ARRAY
);
131 FOREACH_ELEMENT(i
, managed_oom_mode_properties
) {
132 _cleanup_(json_variant_unrefp
) JsonVariant
*e
= NULL
;
134 r
= build_managed_oom_json_array_element(u
, *i
, &e
);
138 r
= json_variant_append_array(&arr
, e
);
143 r
= json_build(&v
, JSON_BUILD_OBJECT(JSON_BUILD_PAIR("cgroups", JSON_BUILD_VARIANT(arr
))));
147 if (MANAGER_IS_SYSTEM(u
->manager
))
148 /* in system mode, oomd is our client, thus send out notifications as replies to the
149 * initiating method call from them. */
150 r
= varlink_notify(u
->manager
->managed_oom_varlink
, v
);
152 /* in user mode, we are oomd's client, thus send out notifications as method calls that do
153 * not expect a reply. */
154 r
= varlink_send(u
->manager
->managed_oom_varlink
, "io.systemd.oom.ReportManagedOOMCGroups", v
);
159 static int build_managed_oom_cgroups_json(Manager
*m
, JsonVariant
**ret
) {
160 _cleanup_(json_variant_unrefp
) JsonVariant
*v
= NULL
, *arr
= NULL
;
166 r
= json_build(&arr
, JSON_BUILD_EMPTY_ARRAY
);
170 for (UnitType t
= 0; t
< _UNIT_TYPE_MAX
; t
++) {
172 if (!unit_vtable
[t
]->can_set_managed_oom
)
175 LIST_FOREACH(units_by_type
, u
, m
->units_by_type
[t
]) {
178 if (UNIT_IS_INACTIVE_OR_FAILED(unit_active_state(u
)))
181 c
= unit_get_cgroup_context(u
);
185 FOREACH_ELEMENT(i
, managed_oom_mode_properties
) {
186 _cleanup_(json_variant_unrefp
) JsonVariant
*e
= NULL
;
188 /* For the initial varlink call we only care about units that enabled (i.e. mode is not
189 * set to "auto") oomd properties. */
190 if (!(streq(*i
, "ManagedOOMSwap") && c
->moom_swap
== MANAGED_OOM_KILL
) &&
191 !(streq(*i
, "ManagedOOMMemoryPressure") && c
->moom_mem_pressure
== MANAGED_OOM_KILL
))
194 r
= build_managed_oom_json_array_element(u
, *i
, &e
);
198 r
= json_variant_append_array(&arr
, e
);
205 r
= json_build(&v
, JSON_BUILD_OBJECT(JSON_BUILD_PAIR("cgroups", JSON_BUILD_VARIANT(arr
))));
213 static int vl_method_subscribe_managed_oom_cgroups(
215 JsonVariant
*parameters
,
216 VarlinkMethodFlags flags
,
219 _cleanup_(json_variant_unrefp
) JsonVariant
*v
= NULL
;
220 Manager
*m
= ASSERT_PTR(userdata
);
227 r
= varlink_get_peer_pid(link
, &pid
);
231 u
= manager_get_unit_by_pid(m
, pid
);
233 return varlink_error(link
, VARLINK_ERROR_PERMISSION_DENIED
, NULL
);
235 /* This is meant to be a deterrent and not actual security. The alternative is to check for the systemd-oom
236 * user that this unit runs as, but NSS lookups are blocking and not allowed from PID 1. */
237 if (!streq(u
->id
, "systemd-oomd.service"))
238 return varlink_error(link
, VARLINK_ERROR_PERMISSION_DENIED
, NULL
);
240 if (json_variant_elements(parameters
) > 0)
241 return varlink_error_invalid_parameter(link
, parameters
);
243 /* We only take one subscriber for this method so return an error if there's already an existing one.
244 * This shouldn't happen since systemd-oomd is the only client of this method. */
245 if (FLAGS_SET(flags
, VARLINK_METHOD_MORE
) && m
->managed_oom_varlink
)
246 return varlink_error(link
, "io.systemd.ManagedOOM.SubscriptionTaken", NULL
);
248 r
= build_managed_oom_cgroups_json(m
, &v
);
252 if (!FLAGS_SET(flags
, VARLINK_METHOD_MORE
))
253 return varlink_reply(link
, v
);
255 assert(!m
->managed_oom_varlink
);
256 m
->managed_oom_varlink
= varlink_ref(link
);
257 return varlink_notify(m
->managed_oom_varlink
, v
);
260 static int manager_varlink_send_managed_oom_initial(Manager
*m
) {
261 _cleanup_(json_variant_unrefp
) JsonVariant
*v
= NULL
;
266 if (MANAGER_IS_SYSTEM(m
))
269 assert(m
->managed_oom_varlink
);
271 r
= build_managed_oom_cgroups_json(m
, &v
);
275 return varlink_send(m
->managed_oom_varlink
, "io.systemd.oom.ReportManagedOOMCGroups", v
);
278 static int vl_method_get_user_record(Varlink
*link
, JsonVariant
*parameters
, VarlinkMethodFlags flags
, void *userdata
) {
280 static const JsonDispatch dispatch_table
[] = {
281 { "uid", JSON_VARIANT_UNSIGNED
, json_dispatch_uid_gid
, offsetof(LookupParameters
, uid
), 0 },
282 { "userName", JSON_VARIANT_STRING
, json_dispatch_const_string
, offsetof(LookupParameters
, user_name
), JSON_SAFE
},
283 { "service", JSON_VARIANT_STRING
, json_dispatch_const_string
, offsetof(LookupParameters
, service
), 0 },
287 _cleanup_(json_variant_unrefp
) JsonVariant
*v
= NULL
;
288 LookupParameters p
= {
291 _cleanup_free_
char *found_name
= NULL
;
292 uid_t found_uid
= UID_INVALID
, uid
;
293 Manager
*m
= ASSERT_PTR(userdata
);
299 r
= varlink_dispatch(link
, parameters
, dispatch_table
, &p
);
303 if (!streq_ptr(p
.service
, "io.systemd.DynamicUser"))
304 return varlink_error(link
, "io.systemd.UserDatabase.BadService", NULL
);
306 if (uid_is_valid(p
.uid
))
307 r
= dynamic_user_lookup_uid(m
, p
.uid
, &found_name
);
308 else if (p
.user_name
)
309 r
= dynamic_user_lookup_name(m
, p
.user_name
, &found_uid
);
313 HASHMAP_FOREACH(d
, m
->dynamic_users
) {
314 r
= dynamic_user_current(d
, &uid
);
315 if (r
== -EAGAIN
) /* not realized yet? */
320 if (!user_match_lookup_parameters(&p
, d
->name
, uid
))
324 r
= varlink_notify(link
, v
);
328 v
= json_variant_unref(v
);
331 r
= build_user_json(d
->name
, uid
, &v
);
337 return varlink_error(link
, "io.systemd.UserDatabase.NoRecordFound", NULL
);
339 return varlink_reply(link
, v
);
342 return varlink_error(link
, "io.systemd.UserDatabase.NoRecordFound", NULL
);
346 uid
= uid_is_valid(found_uid
) ? found_uid
: p
.uid
;
347 un
= found_name
?: p
.user_name
;
349 if (!user_match_lookup_parameters(&p
, un
, uid
))
350 return varlink_error(link
, "io.systemd.UserDatabase.ConflictingRecordFound", NULL
);
352 r
= build_user_json(un
, uid
, &v
);
356 return varlink_reply(link
, v
);
359 static int build_group_json(const char *group_name
, gid_t gid
, JsonVariant
**ret
) {
361 assert(gid_is_valid(gid
));
364 return json_build(ret
, JSON_BUILD_OBJECT(
365 JSON_BUILD_PAIR("record", JSON_BUILD_OBJECT(
366 JSON_BUILD_PAIR("groupName", JSON_BUILD_STRING(group_name
)),
367 JSON_BUILD_PAIR("description", JSON_BUILD_CONST_STRING("Dynamic Group")),
368 JSON_BUILD_PAIR("gid", JSON_BUILD_UNSIGNED(gid
)),
369 JSON_BUILD_PAIR("service", JSON_BUILD_CONST_STRING("io.systemd.DynamicUser")),
370 JSON_BUILD_PAIR("disposition", JSON_BUILD_CONST_STRING("dynamic"))))));
373 static bool group_match_lookup_parameters(LookupParameters
*p
, const char *name
, gid_t gid
) {
376 if (p
->group_name
&& !streq(name
, p
->group_name
))
379 if (gid_is_valid(p
->gid
) && gid
!= p
->gid
)
385 static int vl_method_get_group_record(Varlink
*link
, JsonVariant
*parameters
, VarlinkMethodFlags flags
, void *userdata
) {
387 static const JsonDispatch dispatch_table
[] = {
388 { "gid", JSON_VARIANT_UNSIGNED
, json_dispatch_uid_gid
, offsetof(LookupParameters
, gid
), 0 },
389 { "groupName", JSON_VARIANT_STRING
, json_dispatch_const_string
, offsetof(LookupParameters
, group_name
), JSON_SAFE
},
390 { "service", JSON_VARIANT_STRING
, json_dispatch_const_string
, offsetof(LookupParameters
, service
), 0 },
394 _cleanup_(json_variant_unrefp
) JsonVariant
*v
= NULL
;
395 LookupParameters p
= {
398 _cleanup_free_
char *found_name
= NULL
;
399 uid_t found_gid
= GID_INVALID
, gid
;
400 Manager
*m
= ASSERT_PTR(userdata
);
406 r
= varlink_dispatch(link
, parameters
, dispatch_table
, &p
);
410 if (!streq_ptr(p
.service
, "io.systemd.DynamicUser"))
411 return varlink_error(link
, "io.systemd.UserDatabase.BadService", NULL
);
413 if (gid_is_valid(p
.gid
))
414 r
= dynamic_user_lookup_uid(m
, (uid_t
) p
.gid
, &found_name
);
415 else if (p
.group_name
)
416 r
= dynamic_user_lookup_name(m
, p
.group_name
, (uid_t
*) &found_gid
);
420 HASHMAP_FOREACH(d
, m
->dynamic_users
) {
423 r
= dynamic_user_current(d
, &uid
);
429 if (!group_match_lookup_parameters(&p
, d
->name
, (gid_t
) uid
))
433 r
= varlink_notify(link
, v
);
437 v
= json_variant_unref(v
);
440 r
= build_group_json(d
->name
, (gid_t
) uid
, &v
);
446 return varlink_error(link
, "io.systemd.UserDatabase.NoRecordFound", NULL
);
448 return varlink_reply(link
, v
);
451 return varlink_error(link
, "io.systemd.UserDatabase.NoRecordFound", NULL
);
455 gid
= gid_is_valid(found_gid
) ? found_gid
: p
.gid
;
456 gn
= found_name
?: p
.group_name
;
458 if (!group_match_lookup_parameters(&p
, gn
, gid
))
459 return varlink_error(link
, "io.systemd.UserDatabase.ConflictingRecordFound", NULL
);
461 r
= build_group_json(gn
, gid
, &v
);
465 return varlink_reply(link
, v
);
468 static int vl_method_get_memberships(Varlink
*link
, JsonVariant
*parameters
, VarlinkMethodFlags flags
, void *userdata
) {
470 static const JsonDispatch dispatch_table
[] = {
471 { "userName", JSON_VARIANT_STRING
, json_dispatch_const_string
, offsetof(LookupParameters
, user_name
), JSON_SAFE
},
472 { "groupName", JSON_VARIANT_STRING
, json_dispatch_const_string
, offsetof(LookupParameters
, group_name
), JSON_SAFE
},
473 { "service", JSON_VARIANT_STRING
, json_dispatch_const_string
, offsetof(LookupParameters
, service
), 0 },
477 LookupParameters p
= {};
482 r
= varlink_dispatch(link
, parameters
, dispatch_table
, &p
);
486 if (!streq_ptr(p
.service
, "io.systemd.DynamicUser"))
487 return varlink_error(link
, "io.systemd.UserDatabase.BadService", NULL
);
489 /* We don't support auxiliary groups with dynamic users. */
490 return varlink_error(link
, "io.systemd.UserDatabase.NoRecordFound", NULL
);
493 static void vl_disconnect(VarlinkServer
*s
, Varlink
*link
, void *userdata
) {
494 Manager
*m
= ASSERT_PTR(userdata
);
499 if (link
== m
->managed_oom_varlink
)
500 m
->managed_oom_varlink
= varlink_unref(link
);
503 static int manager_setup_varlink_server(Manager
*m
, VarlinkServer
**ret
) {
504 _cleanup_(varlink_server_unrefp
) VarlinkServer
*s
= NULL
;
510 r
= varlink_server_new(&s
, VARLINK_SERVER_ACCOUNT_UID
|VARLINK_SERVER_INHERIT_USERDATA
);
512 return log_debug_errno(r
, "Failed to allocate varlink server object: %m");
514 varlink_server_set_userdata(s
, m
);
516 r
= varlink_server_add_interface_many(
518 &vl_interface_io_systemd_UserDatabase
,
519 &vl_interface_io_systemd_ManagedOOM
);
521 return log_debug_errno(r
, "Failed to add interfaces to varlink server: %m");
523 r
= varlink_server_bind_method_many(
525 "io.systemd.UserDatabase.GetUserRecord", vl_method_get_user_record
,
526 "io.systemd.UserDatabase.GetGroupRecord", vl_method_get_group_record
,
527 "io.systemd.UserDatabase.GetMemberships", vl_method_get_memberships
,
528 "io.systemd.ManagedOOM.SubscribeManagedOOMCGroups", vl_method_subscribe_managed_oom_cgroups
);
530 return log_debug_errno(r
, "Failed to register varlink methods: %m");
532 r
= varlink_server_bind_disconnect(s
, vl_disconnect
);
534 return log_debug_errno(r
, "Failed to register varlink disconnect handler: %m");
540 static int manager_varlink_init_system(Manager
*m
) {
541 _cleanup_(varlink_server_unrefp
) VarlinkServer
*s
= NULL
;
546 if (m
->varlink_server
)
549 if (!MANAGER_IS_SYSTEM(m
))
552 r
= manager_setup_varlink_server(m
, &s
);
554 return log_error_errno(r
, "Failed to set up varlink server: %m");
556 if (!MANAGER_IS_TEST_RUN(m
)) {
557 (void) mkdir_p_label("/run/systemd/userdb", 0755);
559 FOREACH_STRING(address
, "/run/systemd/userdb/io.systemd.DynamicUser", VARLINK_ADDR_PATH_MANAGED_OOM_SYSTEM
) {
560 if (MANAGER_IS_RELOADING(m
)) {
561 /* If manager is reloading, we skip listening on existing addresses, since
562 * the fd should be acquired later through deserialization. */
563 if (access(address
, F_OK
) >= 0)
566 return log_error_errno(errno
,
567 "Failed to check if varlink socket '%s' exists: %m", address
);
570 r
= varlink_server_listen_address(s
, address
, 0666);
572 return log_error_errno(r
, "Failed to bind to varlink socket '%s': %m", address
);
576 r
= varlink_server_attach_event(s
, m
->event
, EVENT_PRIORITY_IPC
);
578 return log_error_errno(r
, "Failed to attach varlink connection to event loop: %m");
580 m
->varlink_server
= TAKE_PTR(s
);
584 static int vl_reply(Varlink
*link
, JsonVariant
*parameters
, const char *error_id
, VarlinkReplyFlags flags
, void *userdata
) {
585 Manager
*m
= ASSERT_PTR(userdata
);
589 log_debug("varlink systemd-oomd client error: %s", error_id
);
591 if (FLAGS_SET(flags
, VARLINK_REPLY_ERROR
) && FLAGS_SET(flags
, VARLINK_REPLY_LOCAL
)) {
592 /* Varlink connection was closed, likely because of systemd-oomd restart. Let's try to
593 * reconnect and send the initial ManagedOOM update again. */
595 m
->managed_oom_varlink
= varlink_unref(link
);
597 log_debug("Reconnecting to %s", VARLINK_ADDR_PATH_MANAGED_OOM_USER
);
599 r
= manager_varlink_init(m
);
607 static int manager_varlink_init_user(Manager
*m
) {
608 _cleanup_(varlink_close_unrefp
) Varlink
*link
= NULL
;
613 if (m
->managed_oom_varlink
)
616 if (MANAGER_IS_TEST_RUN(m
))
619 r
= varlink_connect_address(&link
, VARLINK_ADDR_PATH_MANAGED_OOM_USER
);
621 if (r
== -ENOENT
|| ERRNO_IS_DISCONNECT(r
)) {
622 log_debug("systemd-oomd varlink unix socket not found, skipping user manager varlink setup");
625 return log_error_errno(r
, "Failed to connect to %s: %m", VARLINK_ADDR_PATH_MANAGED_OOM_USER
);
628 varlink_set_userdata(link
, m
);
630 r
= varlink_bind_reply(link
, vl_reply
);
634 r
= varlink_attach_event(link
, m
->event
, EVENT_PRIORITY_IPC
);
636 return log_error_errno(r
, "Failed to attach varlink connection to event loop: %m");
638 m
->managed_oom_varlink
= TAKE_PTR(link
);
640 /* Queue the initial ManagedOOM update. */
641 (void) manager_varlink_send_managed_oom_initial(m
);
646 int manager_varlink_init(Manager
*m
) {
647 return MANAGER_IS_SYSTEM(m
) ? manager_varlink_init_system(m
) : manager_varlink_init_user(m
);
650 void manager_varlink_done(Manager
*m
) {
653 /* Explicitly close the varlink connection to oomd. Note we first take the varlink connection out of
654 * the manager, and only then disconnect it — in two steps – so that we don't end up accidentally
655 * unreffing it twice. After all, closing the connection might cause the disconnect handler we
656 * installed (vl_disconnect() above) to be called, where we will unref it too. */
657 varlink_close_unref(TAKE_PTR(m
->managed_oom_varlink
));
659 m
->varlink_server
= varlink_server_unref(m
->varlink_server
);
660 m
->managed_oom_varlink
= varlink_close_unref(m
->managed_oom_varlink
);