]> git.ipfire.org Git - thirdparty/systemd.git/blob - src/home/homed-manager.c
Merge pull request #21582 from mrc0mmand/lgtm-uninitialized
[thirdparty/systemd.git] / src / home / homed-manager.c
1 /* SPDX-License-Identifier: LGPL-2.1-or-later */
2
3 #include <grp.h>
4 #include <linux/fs.h>
5 #include <linux/magic.h>
6 #include <math.h>
7 #include <openssl/pem.h>
8 #include <pwd.h>
9 #include <sys/ioctl.h>
10 #include <sys/quota.h>
11 #include <sys/stat.h>
12
13 #include "btrfs-util.h"
14 #include "bus-common-errors.h"
15 #include "bus-error.h"
16 #include "bus-log-control-api.h"
17 #include "bus-polkit.h"
18 #include "clean-ipc.h"
19 #include "conf-files.h"
20 #include "device-util.h"
21 #include "dirent-util.h"
22 #include "fd-util.h"
23 #include "fileio.h"
24 #include "format-util.h"
25 #include "fs-util.h"
26 #include "gpt.h"
27 #include "home-util.h"
28 #include "homed-conf.h"
29 #include "homed-home-bus.h"
30 #include "homed-home.h"
31 #include "homed-manager-bus.h"
32 #include "homed-manager.h"
33 #include "homed-varlink.h"
34 #include "io-util.h"
35 #include "mkdir.h"
36 #include "process-util.h"
37 #include "quota-util.h"
38 #include "random-util.h"
39 #include "resize-fs.h"
40 #include "socket-util.h"
41 #include "sort-util.h"
42 #include "stat-util.h"
43 #include "strv.h"
44 #include "sync-util.h"
45 #include "tmpfile-util.h"
46 #include "udev-util.h"
47 #include "user-record-sign.h"
48 #include "user-record-util.h"
49 #include "user-record.h"
50 #include "user-util.h"
51
52 /* Where to look for private/public keys that are used to sign the user records. We are not using
53 * CONF_PATHS_NULSTR() here since we want to insert /var/lib/systemd/home/ in the middle. And we insert that
54 * since we want to auto-generate a persistent private/public key pair if we need to. */
55 #define KEY_PATHS_NULSTR \
56 "/etc/systemd/home/\0" \
57 "/run/systemd/home/\0" \
58 "/var/lib/systemd/home/\0" \
59 "/usr/local/lib/systemd/home/\0" \
60 "/usr/lib/systemd/home/\0"
61
62 static bool uid_is_home(uid_t uid) {
63 return uid >= HOME_UID_MIN && uid <= HOME_UID_MAX;
64 }
65 /* Takes a value generated randomly or by hashing and turns it into a UID in the right range */
66
67 #define UID_CLAMP_INTO_HOME_RANGE(rnd) (((uid_t) (rnd) % (HOME_UID_MAX - HOME_UID_MIN + 1)) + HOME_UID_MIN)
68
69 DEFINE_PRIVATE_HASH_OPS_WITH_VALUE_DESTRUCTOR(homes_by_uid_hash_ops, void, trivial_hash_func, trivial_compare_func, Home, home_free);
70 DEFINE_PRIVATE_HASH_OPS_WITH_VALUE_DESTRUCTOR(homes_by_name_hash_ops, char, string_hash_func, string_compare_func, Home, home_free);
71 DEFINE_PRIVATE_HASH_OPS_WITH_VALUE_DESTRUCTOR(homes_by_worker_pid_hash_ops, void, trivial_hash_func, trivial_compare_func, Home, home_free);
72 DEFINE_PRIVATE_HASH_OPS_WITH_VALUE_DESTRUCTOR(homes_by_sysfs_hash_ops, char, path_hash_func, path_compare, Home, home_free);
73
74 static int on_home_inotify(sd_event_source *s, const struct inotify_event *event, void *userdata);
75 static int manager_gc_images(Manager *m);
76 static int manager_enumerate_images(Manager *m);
77 static int manager_assess_image(Manager *m, int dir_fd, const char *dir_path, const char *dentry_name);
78 static void manager_revalidate_image(Manager *m, Home *h);
79
80 static void manager_watch_home(Manager *m) {
81 struct statfs sfs;
82 int r;
83
84 assert(m);
85
86 m->inotify_event_source = sd_event_source_disable_unref(m->inotify_event_source);
87 m->scan_slash_home = false;
88
89 if (statfs(get_home_root(), &sfs) < 0) {
90 log_full_errno(errno == ENOENT ? LOG_DEBUG : LOG_WARNING, errno,
91 "Failed to statfs() %s directory, disabling automatic scanning.", get_home_root());
92 return;
93 }
94
95 if (is_network_fs(&sfs)) {
96 log_info("%s is a network file system, disabling automatic scanning.", get_home_root());
97 return;
98 }
99
100 if (is_fs_type(&sfs, AUTOFS_SUPER_MAGIC)) {
101 log_info("%s is on autofs, disabling automatic scanning.", get_home_root());
102 return;
103 }
104
105 m->scan_slash_home = true;
106
107 r = sd_event_add_inotify(m->event, &m->inotify_event_source, get_home_root(),
108 IN_CREATE|IN_CLOSE_WRITE|IN_DELETE_SELF|IN_MOVE_SELF|IN_ONLYDIR|IN_MOVED_TO|IN_MOVED_FROM|IN_DELETE,
109 on_home_inotify, m);
110 if (r < 0)
111 log_full_errno(r == -ENOENT ? LOG_DEBUG : LOG_WARNING, r,
112 "Failed to create inotify watch on %s, ignoring.", get_home_root());
113
114 (void) sd_event_source_set_description(m->inotify_event_source, "home-inotify");
115
116 log_info("Watching %s.", get_home_root());
117 }
118
119 static int on_home_inotify(sd_event_source *s, const struct inotify_event *event, void *userdata) {
120 _cleanup_free_ char *j = NULL;
121 Manager *m = userdata;
122 const char *e, *n;
123
124 assert(m);
125 assert(event);
126
127 if ((event->mask & (IN_Q_OVERFLOW|IN_MOVE_SELF|IN_DELETE_SELF|IN_IGNORED|IN_UNMOUNT)) != 0) {
128
129 if (FLAGS_SET(event->mask, IN_Q_OVERFLOW))
130 log_debug("%s inotify queue overflow, rescanning.", get_home_root());
131 else if (FLAGS_SET(event->mask, IN_MOVE_SELF))
132 log_info("%s moved or renamed, recreating watch and rescanning.", get_home_root());
133 else if (FLAGS_SET(event->mask, IN_DELETE_SELF))
134 log_info("%s deleted, recreating watch and rescanning.", get_home_root());
135 else if (FLAGS_SET(event->mask, IN_UNMOUNT))
136 log_info("%s unmounted, recreating watch and rescanning.", get_home_root());
137 else if (FLAGS_SET(event->mask, IN_IGNORED))
138 log_info("%s watch invalidated, recreating watch and rescanning.", get_home_root());
139
140 manager_watch_home(m);
141 (void) manager_gc_images(m);
142 (void) manager_enumerate_images(m);
143 (void) bus_manager_emit_auto_login_changed(m);
144 return 0;
145 }
146
147 /* For the other inotify events, let's ignore all events for file names that don't match our
148 * expectations */
149 if (isempty(event->name))
150 return 0;
151 e = endswith(event->name, FLAGS_SET(event->mask, IN_ISDIR) ? ".homedir" : ".home");
152 if (!e)
153 return 0;
154
155 n = strndupa_safe(event->name, e - event->name);
156 if (!suitable_user_name(n))
157 return 0;
158
159 j = path_join(get_home_root(), event->name);
160 if (!j)
161 return log_oom();
162
163 if ((event->mask & (IN_CREATE|IN_CLOSE_WRITE|IN_MOVED_TO)) != 0) {
164 if (FLAGS_SET(event->mask, IN_CREATE))
165 log_debug("%s has been created, having a look.", j);
166 else if (FLAGS_SET(event->mask, IN_CLOSE_WRITE))
167 log_debug("%s has been modified, having a look.", j);
168 else if (FLAGS_SET(event->mask, IN_MOVED_TO))
169 log_debug("%s has been moved in, having a look.", j);
170
171 (void) manager_assess_image(m, -1, get_home_root(), event->name);
172 (void) bus_manager_emit_auto_login_changed(m);
173 }
174
175 if ((event->mask & (IN_DELETE | IN_CLOSE_WRITE | IN_MOVED_FROM)) != 0) {
176 Home *h;
177
178 if (FLAGS_SET(event->mask, IN_DELETE))
179 log_debug("%s has been deleted, revalidating.", j);
180 else if (FLAGS_SET(event->mask, IN_CLOSE_WRITE))
181 log_debug("%s has been closed after writing, revalidating.", j);
182 else if (FLAGS_SET(event->mask, IN_MOVED_FROM))
183 log_debug("%s has been moved away, revalidating.", j);
184
185 h = hashmap_get(m->homes_by_name, n);
186 if (h) {
187 manager_revalidate_image(m, h);
188 (void) bus_manager_emit_auto_login_changed(m);
189 }
190 }
191
192 return 0;
193 }
194
195 int manager_new(Manager **ret) {
196 _cleanup_(manager_freep) Manager *m = NULL;
197 int r;
198
199 assert(ret);
200
201 m = new(Manager, 1);
202 if (!m)
203 return -ENOMEM;
204
205 *m = (Manager) {
206 .default_storage = _USER_STORAGE_INVALID,
207 .rebalance_interval_usec = 2 * USEC_PER_MINUTE, /* initially, rebalance every 2min */
208 };
209
210 r = manager_parse_config_file(m);
211 if (r < 0)
212 return r;
213
214 r = sd_event_default(&m->event);
215 if (r < 0)
216 return r;
217
218 r = sd_event_add_signal(m->event, NULL, SIGINT, NULL, NULL);
219 if (r < 0)
220 return r;
221
222 r = sd_event_add_signal(m->event, NULL, SIGTERM, NULL, NULL);
223 if (r < 0)
224 return r;
225
226 (void) sd_event_set_watchdog(m->event, true);
227
228 m->homes_by_uid = hashmap_new(&homes_by_uid_hash_ops);
229 if (!m->homes_by_uid)
230 return -ENOMEM;
231
232 m->homes_by_name = hashmap_new(&homes_by_name_hash_ops);
233 if (!m->homes_by_name)
234 return -ENOMEM;
235
236 m->homes_by_worker_pid = hashmap_new(&homes_by_worker_pid_hash_ops);
237 if (!m->homes_by_worker_pid)
238 return -ENOMEM;
239
240 m->homes_by_sysfs = hashmap_new(&homes_by_sysfs_hash_ops);
241 if (!m->homes_by_sysfs)
242 return -ENOMEM;
243
244 *ret = TAKE_PTR(m);
245 return 0;
246 }
247
248 Manager* manager_free(Manager *m) {
249 Home *h;
250
251 assert(m);
252
253 HASHMAP_FOREACH(h, m->homes_by_worker_pid)
254 (void) home_wait_for_worker(h);
255
256 sd_bus_flush_close_unref(m->bus);
257 bus_verify_polkit_async_registry_free(m->polkit_registry);
258
259 m->device_monitor = sd_device_monitor_unref(m->device_monitor);
260
261 m->inotify_event_source = sd_event_source_unref(m->inotify_event_source);
262 m->notify_socket_event_source = sd_event_source_unref(m->notify_socket_event_source);
263 m->deferred_rescan_event_source = sd_event_source_unref(m->deferred_rescan_event_source);
264 m->deferred_gc_event_source = sd_event_source_unref(m->deferred_gc_event_source);
265 m->deferred_auto_login_event_source = sd_event_source_unref(m->deferred_auto_login_event_source);
266 m->rebalance_event_source = sd_event_source_unref(m->rebalance_event_source);
267
268 sd_event_unref(m->event);
269
270 hashmap_free(m->homes_by_uid);
271 hashmap_free(m->homes_by_name);
272 hashmap_free(m->homes_by_worker_pid);
273 hashmap_free(m->homes_by_sysfs);
274
275 if (m->private_key)
276 EVP_PKEY_free(m->private_key);
277
278 hashmap_free(m->public_keys);
279
280 varlink_server_unref(m->varlink_server);
281 free(m->userdb_service);
282
283 free(m->default_file_system_type);
284
285 return mfree(m);
286 }
287
288 int manager_verify_user_record(Manager *m, UserRecord *hr) {
289 EVP_PKEY *pkey;
290 int r;
291
292 assert(m);
293 assert(hr);
294
295 if (!m->private_key && hashmap_isempty(m->public_keys)) {
296 r = user_record_has_signature(hr);
297 if (r < 0)
298 return r;
299
300 return r ? -ENOKEY : USER_RECORD_UNSIGNED;
301 }
302
303 /* Is it our own? */
304 if (m->private_key) {
305 r = user_record_verify(hr, m->private_key);
306 switch (r) {
307
308 case USER_RECORD_FOREIGN:
309 /* This record is not signed by this key, but let's see below */
310 break;
311
312 case USER_RECORD_SIGNED: /* Signed by us, but also by others, let's propagate that */
313 case USER_RECORD_SIGNED_EXCLUSIVE: /* Signed by us, and nothing else, ditto */
314 case USER_RECORD_UNSIGNED: /* Not signed at all, ditto */
315 default:
316 return r;
317 }
318 }
319
320 HASHMAP_FOREACH(pkey, m->public_keys) {
321 r = user_record_verify(hr, pkey);
322 switch (r) {
323
324 case USER_RECORD_FOREIGN:
325 /* This record is not signed by this key, but let's see our other keys */
326 break;
327
328 case USER_RECORD_SIGNED: /* It's signed by this key we are happy with, but which is not our own. */
329 case USER_RECORD_SIGNED_EXCLUSIVE:
330 return USER_RECORD_FOREIGN;
331
332 case USER_RECORD_UNSIGNED: /* It's not signed at all */
333 default:
334 return r;
335 }
336 }
337
338 return -ENOKEY;
339 }
340
341 static int manager_add_home_by_record(
342 Manager *m,
343 const char *name,
344 int dir_fd,
345 const char *fname) {
346
347 _cleanup_(json_variant_unrefp) JsonVariant *v = NULL;
348 _cleanup_(user_record_unrefp) UserRecord *hr = NULL;
349 unsigned line, column;
350 int r, is_signed;
351 struct stat st;
352 Home *h;
353
354 assert(m);
355 assert(name);
356 assert(fname);
357
358 if (fstatat(dir_fd, fname, &st, 0) < 0)
359 return log_error_errno(errno, "Failed to stat identity record %s: %m", fname);
360
361 if (!S_ISREG(st.st_mode)) {
362 log_debug("Identity record file %s is not a regular file, ignoring.", fname);
363 return 0;
364 }
365
366 if (st.st_size == 0)
367 goto unlink_this_file;
368
369 r = json_parse_file_at(NULL, dir_fd, fname, JSON_PARSE_SENSITIVE, &v, &line, &column);
370 if (r < 0)
371 return log_error_errno(r, "Failed to parse identity record at %s:%u%u: %m", fname, line, column);
372
373 if (json_variant_is_blank_object(v))
374 goto unlink_this_file;
375
376 hr = user_record_new();
377 if (!hr)
378 return log_oom();
379
380 r = user_record_load(hr, v, USER_RECORD_LOAD_REFUSE_SECRET|USER_RECORD_LOG|USER_RECORD_PERMISSIVE);
381 if (r < 0)
382 return r;
383
384 if (!streq_ptr(hr->user_name, name))
385 return log_error_errno(SYNTHETIC_ERRNO(EINVAL),
386 "Identity's user name %s does not match file name %s, refusing.",
387 hr->user_name, name);
388
389 is_signed = manager_verify_user_record(m, hr);
390 switch (is_signed) {
391
392 case -ENOKEY:
393 return log_warning_errno(is_signed, "User record %s is not signed by any accepted key, ignoring.", fname);
394 case USER_RECORD_UNSIGNED:
395 return log_warning_errno(SYNTHETIC_ERRNO(EPERM), "User record %s is not signed at all, ignoring.", fname);
396 case USER_RECORD_SIGNED:
397 log_info("User record %s is signed by us (and others), accepting.", fname);
398 break;
399 case USER_RECORD_SIGNED_EXCLUSIVE:
400 log_info("User record %s is signed only by us, accepting.", fname);
401 break;
402 case USER_RECORD_FOREIGN:
403 log_info("User record %s is signed by registered key from others, accepting.", fname);
404 break;
405 default:
406 assert(is_signed < 0);
407 return log_error_errno(is_signed, "Failed to verify signature of user record in %s: %m", fname);
408 }
409
410 h = hashmap_get(m->homes_by_name, name);
411 if (h) {
412 r = home_set_record(h, hr);
413 if (r < 0)
414 return log_error_errno(r, "Failed to update home record for %s: %m", name);
415
416 /* If we acquired a record now for a previously unallocated entry, then reset the state. This
417 * makes sure home_get_state() will check for the availability of the image file dynamically
418 * in order to detect to distinguish HOME_INACTIVE and HOME_ABSENT. */
419 if (h->state == HOME_UNFIXATED)
420 h->state = _HOME_STATE_INVALID;
421 } else {
422 r = home_new(m, hr, NULL, &h);
423 if (r < 0)
424 return log_error_errno(r, "Failed to allocate new home object: %m");
425
426 log_info("Added registered home for user %s.", hr->user_name);
427 }
428
429 /* Only entries we exclusively signed are writable to us, hence remember the result */
430 h->signed_locally = is_signed == USER_RECORD_SIGNED_EXCLUSIVE;
431
432 return 1;
433
434 unlink_this_file:
435 /* If this is an empty file, then let's just remove it. An empty file is not useful in any case, and
436 * apparently xfs likes to leave empty files around when not unmounted cleanly (see
437 * https://github.com/systemd/systemd/issues/15178 for example). Note that we don't delete non-empty
438 * files even if they are invalid, because that's just too risky, we might delete data the user still
439 * needs. But empty files are never useful, hence let's just remove them. */
440
441 if (unlinkat(dir_fd, fname, 0) < 0)
442 return log_error_errno(errno, "Failed to remove empty user record file %s: %m", fname);
443
444 log_notice("Discovered empty user record file %s/%s, removed automatically.", home_record_dir(), fname);
445 return 0;
446 }
447
448 static int manager_enumerate_records(Manager *m) {
449 _cleanup_closedir_ DIR *d = NULL;
450 struct dirent *de;
451
452 assert(m);
453
454 d = opendir(home_record_dir());
455 if (!d)
456 return log_full_errno(errno == ENOENT ? LOG_DEBUG : LOG_ERR, errno,
457 "Failed to open %s: %m", home_record_dir());
458
459 FOREACH_DIRENT(de, d, return log_error_errno(errno, "Failed to read record directory: %m")) {
460 _cleanup_free_ char *n = NULL;
461 const char *e;
462
463 if (!dirent_is_file(de))
464 continue;
465
466 e = endswith(de->d_name, ".identity");
467 if (!e)
468 continue;
469
470 n = strndup(de->d_name, e - de->d_name);
471 if (!n)
472 return log_oom();
473
474 if (!suitable_user_name(n))
475 continue;
476
477 (void) manager_add_home_by_record(m, n, dirfd(d), de->d_name);
478 }
479
480 return 0;
481 }
482
483 static int search_quota(uid_t uid, const char *exclude_quota_path) {
484 struct stat exclude_st = {};
485 dev_t previous_devno = 0;
486 const char *where;
487 int r;
488
489 /* Checks whether the specified UID owns any files on the files system, but ignore any file system
490 * backing the specified file. The file is used when operating on home directories, where it's OK if
491 * the UID of them already owns files. */
492
493 if (exclude_quota_path && stat(exclude_quota_path, &exclude_st) < 0) {
494 if (errno != ENOENT)
495 return log_warning_errno(errno, "Failed to stat %s, ignoring: %m", exclude_quota_path);
496 }
497
498 /* Check a few usual suspects where regular users might own files. Note that this is by no means
499 * comprehensive, but should cover most cases. Note that in an ideal world every user would be
500 * registered in NSS and avoid our own UID range, but for all other cases, it's a good idea to be
501 * paranoid and check quota if we can. */
502 FOREACH_STRING(where, get_home_root(), "/tmp/", "/var/", "/var/mail/", "/var/tmp/", "/var/spool/") {
503 struct dqblk req;
504 struct stat st;
505
506 if (stat(where, &st) < 0) {
507 log_full_errno(errno == ENOENT ? LOG_DEBUG : LOG_ERR, errno,
508 "Failed to stat %s, ignoring: %m", where);
509 continue;
510 }
511
512 if (major(st.st_dev) == 0) {
513 log_debug("Directory %s is not on a real block device, not checking quota for UID use.", where);
514 continue;
515 }
516
517 if (st.st_dev == exclude_st.st_dev) { /* If an exclude path is specified, then ignore quota
518 * reported on the same block device as that path. */
519 log_debug("Directory %s is where the home directory is located, not checking quota for UID use.", where);
520 continue;
521 }
522
523 if (st.st_dev == previous_devno) { /* Does this directory have the same devno as the previous
524 * one we tested? If so, there's no point in testing this
525 * again. */
526 log_debug("Directory %s is on same device as previous tested directory, not checking quota for UID use a second time.", where);
527 continue;
528 }
529
530 previous_devno = st.st_dev;
531
532 r = quotactl_devno(QCMD_FIXED(Q_GETQUOTA, USRQUOTA), st.st_dev, uid, &req);
533 if (r < 0) {
534 if (ERRNO_IS_NOT_SUPPORTED(r))
535 log_debug_errno(r, "No UID quota support on %s, ignoring.", where);
536 else if (ERRNO_IS_PRIVILEGE(r))
537 log_debug_errno(r, "UID quota support for %s prohibited, ignoring.", where);
538 else
539 log_warning_errno(r, "Failed to query quota on %s, ignoring: %m", where);
540
541 continue;
542 }
543
544 if ((FLAGS_SET(req.dqb_valid, QIF_SPACE) && req.dqb_curspace > 0) ||
545 (FLAGS_SET(req.dqb_valid, QIF_INODES) && req.dqb_curinodes > 0)) {
546 log_debug_errno(errno, "Quota reports UID " UID_FMT " occupies disk space on %s.", uid, where);
547 return 1;
548 }
549 }
550
551 return 0;
552 }
553
554 static int manager_acquire_uid(
555 Manager *m,
556 uid_t start_uid,
557 const char *user_name,
558 const char *exclude_quota_path,
559 uid_t *ret) {
560
561 static const uint8_t hash_key[] = {
562 0xa3, 0xb8, 0x82, 0x69, 0x9a, 0x71, 0xf7, 0xa9,
563 0xe0, 0x7c, 0xf6, 0xf1, 0x21, 0x69, 0xd2, 0x1e
564 };
565
566 enum {
567 PHASE_SUGGESTED,
568 PHASE_HASHED,
569 PHASE_RANDOM
570 } phase = PHASE_SUGGESTED;
571
572 unsigned n_tries = 100;
573 int r;
574
575 assert(m);
576 assert(ret);
577
578 for (;;) {
579 struct passwd *pw;
580 struct group *gr;
581 uid_t candidate;
582 Home *other;
583
584 if (--n_tries <= 0)
585 return -EBUSY;
586
587 switch (phase) {
588
589 case PHASE_SUGGESTED:
590 phase = PHASE_HASHED;
591
592 if (!uid_is_home(start_uid))
593 continue;
594
595 candidate = start_uid;
596 break;
597
598 case PHASE_HASHED:
599 phase = PHASE_RANDOM;
600
601 if (!user_name)
602 continue;
603
604 candidate = UID_CLAMP_INTO_HOME_RANGE(siphash24(user_name, strlen(user_name), hash_key));
605 break;
606
607 case PHASE_RANDOM:
608 random_bytes(&candidate, sizeof(candidate));
609 candidate = UID_CLAMP_INTO_HOME_RANGE(candidate);
610 break;
611
612 default:
613 assert_not_reached();
614 }
615
616 other = hashmap_get(m->homes_by_uid, UID_TO_PTR(candidate));
617 if (other) {
618 log_debug("Candidate UID " UID_FMT " already used by another home directory (%s), let's try another.",
619 candidate, other->user_name);
620 continue;
621 }
622
623 pw = getpwuid(candidate);
624 if (pw) {
625 log_debug("Candidate UID " UID_FMT " already registered by another user in NSS (%s), let's try another.",
626 candidate, pw->pw_name);
627 continue;
628 }
629
630 gr = getgrgid((gid_t) candidate);
631 if (gr) {
632 log_debug("Candidate UID " UID_FMT " already registered by another group in NSS (%s), let's try another.",
633 candidate, gr->gr_name);
634 continue;
635 }
636
637 r = search_ipc(candidate, (gid_t) candidate);
638 if (r < 0)
639 continue;
640 if (r > 0) {
641 log_debug_errno(r, "Candidate UID " UID_FMT " already owns IPC objects, let's try another: %m",
642 candidate);
643 continue;
644 }
645
646 r = search_quota(candidate, exclude_quota_path);
647 if (r != 0)
648 continue;
649
650 *ret = candidate;
651 return 0;
652 }
653 }
654
655 static int manager_add_home_by_image(
656 Manager *m,
657 const char *user_name,
658 const char *realm,
659 const char *image_path,
660 const char *sysfs,
661 UserStorage storage,
662 uid_t start_uid) {
663
664 _cleanup_(user_record_unrefp) UserRecord *hr = NULL;
665 uid_t uid;
666 Home *h;
667 int r;
668
669 assert(m);
670
671 assert(m);
672 assert(user_name);
673 assert(image_path);
674 assert(storage >= 0);
675 assert(storage < _USER_STORAGE_MAX);
676
677 h = hashmap_get(m->homes_by_name, user_name);
678 if (h) {
679 bool same;
680
681 if (h->state != HOME_UNFIXATED) {
682 log_debug("Found an image for user %s which already has a record, skipping.", user_name);
683 return 0; /* ignore images that synthesize a user we already have a record for */
684 }
685
686 same = user_record_storage(h->record) == storage;
687 if (same) {
688 if (h->sysfs && sysfs)
689 same = path_equal(h->sysfs, sysfs);
690 else if (!!h->sysfs != !!sysfs)
691 same = false;
692 else {
693 const char *p;
694
695 p = user_record_image_path(h->record);
696 same = p && path_equal(p, image_path);
697 }
698 }
699
700 if (!same) {
701 log_debug("Found multiple images for user '%s', ignoring image '%s'.", user_name, image_path);
702 return 0;
703 }
704 } else {
705 /* Check NSS, in case there's another user or group by this name */
706 if (getpwnam(user_name) || getgrnam(user_name)) {
707 log_debug("Found an existing user or group by name '%s', ignoring image '%s'.", user_name, image_path);
708 return 0;
709 }
710 }
711
712 if (h && uid_is_valid(h->uid))
713 uid = h->uid;
714 else {
715 r = manager_acquire_uid(m, start_uid, user_name,
716 IN_SET(storage, USER_SUBVOLUME, USER_DIRECTORY, USER_FSCRYPT) ? image_path : NULL,
717 &uid);
718 if (r < 0)
719 return log_warning_errno(r, "Failed to acquire unused UID for %s: %m", user_name);
720 }
721
722 hr = user_record_new();
723 if (!hr)
724 return log_oom();
725
726 r = user_record_synthesize(hr, user_name, realm, image_path, storage, uid, (gid_t) uid);
727 if (r < 0)
728 return log_error_errno(r, "Failed to synthesize home record for %s (image %s): %m", user_name, image_path);
729
730 if (h) {
731 r = home_set_record(h, hr);
732 if (r < 0)
733 return log_error_errno(r, "Failed to update home record for %s: %m", user_name);
734 } else {
735 r = home_new(m, hr, sysfs, &h);
736 if (r < 0)
737 return log_error_errno(r, "Failed to allocate new home object: %m");
738
739 h->state = HOME_UNFIXATED;
740
741 log_info("Discovered new home for user %s through image %s.", user_name, image_path);
742 }
743
744 return 1;
745 }
746
747 int manager_augment_record_with_uid(
748 Manager *m,
749 UserRecord *hr) {
750
751 const char *exclude_quota_path = NULL;
752 uid_t start_uid = UID_INVALID, uid;
753 int r;
754
755 assert(m);
756 assert(hr);
757
758 if (uid_is_valid(hr->uid))
759 return 0;
760
761 if (IN_SET(hr->storage, USER_CLASSIC, USER_SUBVOLUME, USER_DIRECTORY, USER_FSCRYPT)) {
762 const char * ip;
763
764 ip = user_record_image_path(hr);
765 if (ip) {
766 struct stat st;
767
768 if (stat(ip, &st) < 0) {
769 if (errno != ENOENT)
770 log_warning_errno(errno, "Failed to stat(%s): %m", ip);
771 } else if (uid_is_home(st.st_uid)) {
772 start_uid = st.st_uid;
773 exclude_quota_path = ip;
774 }
775 }
776 }
777
778 r = manager_acquire_uid(m, start_uid, hr->user_name, exclude_quota_path, &uid);
779 if (r < 0)
780 return r;
781
782 log_debug("Acquired new UID " UID_FMT " for %s.", uid, hr->user_name);
783
784 r = user_record_add_binding(
785 hr,
786 _USER_STORAGE_INVALID,
787 NULL,
788 SD_ID128_NULL,
789 SD_ID128_NULL,
790 SD_ID128_NULL,
791 NULL,
792 NULL,
793 UINT64_MAX,
794 NULL,
795 NULL,
796 uid,
797 (gid_t) uid);
798 if (r < 0)
799 return r;
800
801 return 1;
802 }
803
804 static int manager_assess_image(
805 Manager *m,
806 int dir_fd,
807 const char *dir_path,
808 const char *dentry_name) {
809
810 char *luks_suffix, *directory_suffix;
811 _cleanup_free_ char *path = NULL;
812 struct stat st;
813 int r;
814
815 assert(m);
816 assert(dir_path);
817 assert(dentry_name);
818
819 luks_suffix = endswith(dentry_name, ".home");
820 if (luks_suffix)
821 directory_suffix = NULL;
822 else
823 directory_suffix = endswith(dentry_name, ".homedir");
824
825 /* Early filter out: by name */
826 if (!luks_suffix && !directory_suffix)
827 return 0;
828
829 path = path_join(dir_path, dentry_name);
830 if (!path)
831 return log_oom();
832
833 /* Follow symlinks here, to allow people to link in stuff to make them available locally. */
834 if (dir_fd >= 0)
835 r = fstatat(dir_fd, dentry_name, &st, 0);
836 else
837 r = stat(path, &st);
838 if (r < 0)
839 return log_full_errno(errno == ENOENT ? LOG_DEBUG : LOG_WARNING, errno,
840 "Failed to stat() directory entry '%s', ignoring: %m", dentry_name);
841
842 if (S_ISREG(st.st_mode)) {
843 _cleanup_free_ char *n = NULL, *user_name = NULL, *realm = NULL;
844
845 if (!luks_suffix)
846 return 0;
847
848 n = strndup(dentry_name, luks_suffix - dentry_name);
849 if (!n)
850 return log_oom();
851
852 r = split_user_name_realm(n, &user_name, &realm);
853 if (r == -EINVAL) /* Not the right format: ignore */
854 return 0;
855 if (r < 0)
856 return log_error_errno(r, "Failed to split image name into user name/realm: %m");
857
858 return manager_add_home_by_image(m, user_name, realm, path, NULL, USER_LUKS, UID_INVALID);
859 }
860
861 if (S_ISDIR(st.st_mode)) {
862 _cleanup_free_ char *n = NULL, *user_name = NULL, *realm = NULL;
863 _cleanup_close_ int fd = -1;
864 UserStorage storage;
865
866 if (!directory_suffix)
867 return 0;
868
869 n = strndup(dentry_name, directory_suffix - dentry_name);
870 if (!n)
871 return log_oom();
872
873 r = split_user_name_realm(n, &user_name, &realm);
874 if (r == -EINVAL) /* Not the right format: ignore */
875 return 0;
876 if (r < 0)
877 return log_error_errno(r, "Failed to split image name into user name/realm: %m");
878
879 if (dir_fd >= 0)
880 fd = openat(dir_fd, dentry_name, O_DIRECTORY|O_RDONLY|O_CLOEXEC);
881 else
882 fd = open(path, O_DIRECTORY|O_RDONLY|O_CLOEXEC);
883 if (fd < 0)
884 return log_full_errno(errno == ENOENT ? LOG_DEBUG : LOG_WARNING, errno,
885 "Failed to open directory '%s', ignoring: %m", path);
886
887 if (fstat(fd, &st) < 0)
888 return log_warning_errno(errno, "Failed to fstat() %s, ignoring: %m", path);
889
890 assert(S_ISDIR(st.st_mode)); /* Must hold, we used O_DIRECTORY above */
891
892 r = btrfs_is_subvol_fd(fd);
893 if (r < 0)
894 return log_warning_errno(errno, "Failed to determine whether %s is a btrfs subvolume: %m", path);
895 if (r > 0)
896 storage = USER_SUBVOLUME;
897 else {
898 struct fscrypt_policy policy;
899
900 if (ioctl(fd, FS_IOC_GET_ENCRYPTION_POLICY, &policy) < 0) {
901
902 if (errno == ENODATA)
903 log_debug_errno(errno, "Determined %s is not fscrypt encrypted.", path);
904 else if (ERRNO_IS_NOT_SUPPORTED(errno))
905 log_debug_errno(errno, "Determined %s is not fscrypt encrypted because kernel or file system doesn't support it.", path);
906 else
907 log_debug_errno(errno, "FS_IOC_GET_ENCRYPTION_POLICY failed with unexpected error code on %s, ignoring: %m", path);
908
909 storage = USER_DIRECTORY;
910 } else
911 storage = USER_FSCRYPT;
912 }
913
914 return manager_add_home_by_image(m, user_name, realm, path, NULL, storage, st.st_uid);
915 }
916
917 return 0;
918 }
919
920 int manager_enumerate_images(Manager *m) {
921 _cleanup_closedir_ DIR *d = NULL;
922 struct dirent *de;
923
924 assert(m);
925
926 if (!m->scan_slash_home)
927 return 0;
928
929 d = opendir(get_home_root());
930 if (!d)
931 return log_full_errno(errno == ENOENT ? LOG_DEBUG : LOG_ERR, errno,
932 "Failed to open %s: %m", get_home_root());
933
934 FOREACH_DIRENT(de, d, return log_error_errno(errno, "Failed to read %s directory: %m", get_home_root()))
935 (void) manager_assess_image(m, dirfd(d), get_home_root(), de->d_name);
936
937 return 0;
938 }
939
940 static int manager_connect_bus(Manager *m) {
941 const char *suffix, *busname;
942 int r;
943
944 assert(m);
945 assert(!m->bus);
946
947 r = sd_bus_default_system(&m->bus);
948 if (r < 0)
949 return log_error_errno(r, "Failed to connect to system bus: %m");
950
951 r = bus_add_implementation(m->bus, &manager_object, m);
952 if (r < 0)
953 return r;
954
955 r = bus_log_control_api_register(m->bus);
956 if (r < 0)
957 return r;
958
959 suffix = getenv("SYSTEMD_HOME_DEBUG_SUFFIX");
960 if (suffix)
961 busname = strjoina("org.freedesktop.home1.", suffix);
962 else
963 busname = "org.freedesktop.home1";
964
965 r = sd_bus_request_name_async(m->bus, NULL, busname, 0, NULL, NULL);
966 if (r < 0)
967 return log_error_errno(r, "Failed to request name: %m");
968
969 r = sd_bus_attach_event(m->bus, m->event, 0);
970 if (r < 0)
971 return log_error_errno(r, "Failed to attach bus to event loop: %m");
972
973 (void) sd_bus_set_exit_on_disconnect(m->bus, true);
974
975 return 0;
976 }
977
978 static int manager_bind_varlink(Manager *m) {
979 const char *suffix, *socket_path;
980 int r;
981
982 assert(m);
983 assert(!m->varlink_server);
984
985 r = varlink_server_new(&m->varlink_server, VARLINK_SERVER_ACCOUNT_UID|VARLINK_SERVER_INHERIT_USERDATA);
986 if (r < 0)
987 return log_error_errno(r, "Failed to allocate varlink server object: %m");
988
989 varlink_server_set_userdata(m->varlink_server, m);
990
991 r = varlink_server_bind_method_many(
992 m->varlink_server,
993 "io.systemd.UserDatabase.GetUserRecord", vl_method_get_user_record,
994 "io.systemd.UserDatabase.GetGroupRecord", vl_method_get_group_record,
995 "io.systemd.UserDatabase.GetMemberships", vl_method_get_memberships);
996 if (r < 0)
997 return log_error_errno(r, "Failed to register varlink methods: %m");
998
999 (void) mkdir_p("/run/systemd/userdb", 0755);
1000
1001 /* To make things easier to debug, when working from a homed managed home directory, let's optionally
1002 * use a different varlink socket name */
1003 suffix = getenv("SYSTEMD_HOME_DEBUG_SUFFIX");
1004 if (suffix)
1005 socket_path = strjoina("/run/systemd/userdb/io.systemd.Home.", suffix);
1006 else
1007 socket_path = "/run/systemd/userdb/io.systemd.Home";
1008
1009 r = varlink_server_listen_address(m->varlink_server, socket_path, 0666);
1010 if (r < 0)
1011 return log_error_errno(r, "Failed to bind to varlink socket: %m");
1012
1013 r = varlink_server_attach_event(m->varlink_server, m->event, SD_EVENT_PRIORITY_NORMAL);
1014 if (r < 0)
1015 return log_error_errno(r, "Failed to attach varlink connection to event loop: %m");
1016
1017 assert(!m->userdb_service);
1018 m->userdb_service = strdup(basename(socket_path));
1019 if (!m->userdb_service)
1020 return log_oom();
1021
1022 /* Avoid recursion */
1023 if (setenv("SYSTEMD_BYPASS_USERDB", m->userdb_service, 1) < 0)
1024 return log_error_errno(SYNTHETIC_ERRNO(EINVAL), "Failed to set $SYSTEMD_BYPASS_USERDB: %m");
1025
1026 return 0;
1027 }
1028
1029 static ssize_t read_datagram(
1030 int fd,
1031 struct ucred *ret_sender,
1032 void **ret,
1033 int *ret_passed_fd) {
1034
1035 CMSG_BUFFER_TYPE(CMSG_SPACE(sizeof(struct ucred)) + CMSG_SPACE(sizeof(int))) control;
1036 _cleanup_free_ void *buffer = NULL;
1037 _cleanup_close_ int passed_fd = -1;
1038 struct ucred *sender = NULL;
1039 struct cmsghdr *cmsg;
1040 struct msghdr mh;
1041 struct iovec iov;
1042 ssize_t n, m;
1043
1044 assert(fd >= 0);
1045 assert(ret_sender);
1046 assert(ret);
1047 assert(ret_passed_fd);
1048
1049 n = next_datagram_size_fd(fd);
1050 if (n < 0)
1051 return n;
1052
1053 buffer = malloc(n + 2);
1054 if (!buffer)
1055 return -ENOMEM;
1056
1057 /* Pass one extra byte, as a size check */
1058 iov = IOVEC_MAKE(buffer, n + 1);
1059
1060 mh = (struct msghdr) {
1061 .msg_iov = &iov,
1062 .msg_iovlen = 1,
1063 .msg_control = &control,
1064 .msg_controllen = sizeof(control),
1065 };
1066
1067 m = recvmsg_safe(fd, &mh, MSG_DONTWAIT|MSG_CMSG_CLOEXEC);
1068 if (m < 0)
1069 return m;
1070
1071 /* Ensure the size matches what we determined before */
1072 if (m != n) {
1073 cmsg_close_all(&mh);
1074 return -EMSGSIZE;
1075 }
1076
1077 CMSG_FOREACH(cmsg, &mh) {
1078 if (cmsg->cmsg_level == SOL_SOCKET &&
1079 cmsg->cmsg_type == SCM_CREDENTIALS &&
1080 cmsg->cmsg_len == CMSG_LEN(sizeof(struct ucred))) {
1081 assert(!sender);
1082 sender = (struct ucred*) CMSG_DATA(cmsg);
1083 }
1084
1085 if (cmsg->cmsg_level == SOL_SOCKET &&
1086 cmsg->cmsg_type == SCM_RIGHTS) {
1087
1088 if (cmsg->cmsg_len != CMSG_LEN(sizeof(int))) {
1089 cmsg_close_all(&mh);
1090 return -EMSGSIZE;
1091 }
1092
1093 assert(passed_fd < 0);
1094 passed_fd = *(int*) CMSG_DATA(cmsg);
1095 }
1096 }
1097
1098 if (sender)
1099 *ret_sender = *sender;
1100 else
1101 *ret_sender = (struct ucred) UCRED_INVALID;
1102
1103 *ret_passed_fd = TAKE_FD(passed_fd);
1104
1105 /* For safety reasons: let's always NUL terminate. */
1106 ((char*) buffer)[n] = 0;
1107 *ret = TAKE_PTR(buffer);
1108
1109 return 0;
1110 }
1111
1112 static int on_notify_socket(sd_event_source *s, int fd, uint32_t revents, void *userdata) {
1113 _cleanup_strv_free_ char **l = NULL;
1114 _cleanup_free_ void *datagram = NULL;
1115 _cleanup_close_ int passed_fd = -1;
1116 struct ucred sender = UCRED_INVALID;
1117 Manager *m = userdata;
1118 ssize_t n;
1119 Home *h;
1120
1121 assert(s);
1122 assert(m);
1123
1124 n = read_datagram(fd, &sender, &datagram, &passed_fd);
1125 if (n < 0) {
1126 if (ERRNO_IS_TRANSIENT(n))
1127 return 0;
1128 return log_error_errno(n, "Failed to read notify datagram: %m");
1129 }
1130
1131 if (sender.pid <= 0) {
1132 log_warning("Received notify datagram without valid sender PID, ignoring.");
1133 return 0;
1134 }
1135
1136 h = hashmap_get(m->homes_by_worker_pid, PID_TO_PTR(sender.pid));
1137 if (!h) {
1138 log_warning("Received notify datagram of unknown process, ignoring.");
1139 return 0;
1140 }
1141
1142 l = strv_split(datagram, "\n");
1143 if (!l)
1144 return log_oom();
1145
1146 home_process_notify(h, l, TAKE_FD(passed_fd));
1147 return 0;
1148 }
1149
1150 static int manager_listen_notify(Manager *m) {
1151 _cleanup_close_ int fd = -1;
1152 union sockaddr_union sa = {
1153 .un.sun_family = AF_UNIX,
1154 .un.sun_path = "/run/systemd/home/notify",
1155 };
1156 const char *suffix;
1157 int r;
1158
1159 assert(m);
1160 assert(!m->notify_socket_event_source);
1161
1162 suffix = getenv("SYSTEMD_HOME_DEBUG_SUFFIX");
1163 if (suffix) {
1164 const char *unix_path;
1165
1166 unix_path = strjoina("/run/systemd/home/notify.", suffix);
1167 r = sockaddr_un_set_path(&sa.un, unix_path);
1168 if (r < 0)
1169 return log_error_errno(r, "Socket path %s does not fit in sockaddr_un: %m", unix_path);
1170 }
1171
1172 fd = socket(AF_UNIX, SOCK_DGRAM|SOCK_CLOEXEC|SOCK_NONBLOCK, 0);
1173 if (fd < 0)
1174 return log_error_errno(errno, "Failed to create listening socket: %m");
1175
1176 (void) mkdir_parents(sa.un.sun_path, 0755);
1177 (void) sockaddr_un_unlink(&sa.un);
1178
1179 if (bind(fd, &sa.sa, SOCKADDR_UN_LEN(sa.un)) < 0)
1180 return log_error_errno(errno, "Failed to bind to socket: %m");
1181
1182 r = setsockopt_int(fd, SOL_SOCKET, SO_PASSCRED, true);
1183 if (r < 0)
1184 return r;
1185
1186 r = sd_event_add_io(m->event, &m->notify_socket_event_source, fd, EPOLLIN, on_notify_socket, m);
1187 if (r < 0)
1188 return log_error_errno(r, "Failed to allocate event source for notify socket: %m");
1189
1190 (void) sd_event_source_set_description(m->notify_socket_event_source, "notify-socket");
1191
1192 /* Make sure we process sd_notify() before SIGCHLD for any worker, so that we always know the error
1193 * number of a client before it exits. */
1194 r = sd_event_source_set_priority(m->notify_socket_event_source, SD_EVENT_PRIORITY_NORMAL - 5);
1195 if (r < 0)
1196 return log_error_errno(r, "Failed to alter priority of NOTIFY_SOCKET event source: %m");
1197
1198 r = sd_event_source_set_io_fd_own(m->notify_socket_event_source, true);
1199 if (r < 0)
1200 return log_error_errno(r, "Failed to pass ownership of notify socket: %m");
1201
1202 return TAKE_FD(fd);
1203 }
1204
1205 static int manager_add_device(Manager *m, sd_device *d) {
1206 _cleanup_free_ char *user_name = NULL, *realm = NULL, *node = NULL;
1207 const char *tabletype, *parttype, *partname, *partuuid, *sysfs;
1208 sd_id128_t id;
1209 int r;
1210
1211 assert(m);
1212 assert(d);
1213
1214 r = sd_device_get_syspath(d, &sysfs);
1215 if (r < 0)
1216 return log_error_errno(r, "Failed to acquire sysfs path of device: %m");
1217
1218 r = sd_device_get_property_value(d, "ID_PART_TABLE_TYPE", &tabletype);
1219 if (r == -ENOENT)
1220 return 0;
1221 if (r < 0)
1222 return log_error_errno(r, "Failed to acquire ID_PART_TABLE_TYPE device property, ignoring: %m");
1223
1224 if (!streq(tabletype, "gpt")) {
1225 log_debug("Found partition (%s) on non-GPT table, ignoring.", sysfs);
1226 return 0;
1227 }
1228
1229 r = sd_device_get_property_value(d, "ID_PART_ENTRY_TYPE", &parttype);
1230 if (r == -ENOENT)
1231 return 0;
1232 if (r < 0)
1233 return log_error_errno(r, "Failed to acquire ID_PART_ENTRY_TYPE device property, ignoring: %m");
1234 r = sd_id128_from_string(parttype, &id);
1235 if (r < 0)
1236 return log_debug_errno(r, "Failed to parse ID_PART_ENTRY_TYPE field '%s', ignoring: %m", parttype);
1237 if (!sd_id128_equal(id, GPT_USER_HOME)) {
1238 log_debug("Found partition (%s) we don't care about, ignoring.", sysfs);
1239 return 0;
1240 }
1241
1242 r = sd_device_get_property_value(d, "ID_PART_ENTRY_NAME", &partname);
1243 if (r < 0)
1244 return log_warning_errno(r, "Failed to acquire ID_PART_ENTRY_NAME device property, ignoring: %m");
1245
1246 r = split_user_name_realm(partname, &user_name, &realm);
1247 if (r == -EINVAL)
1248 return log_warning_errno(r, "Found partition with correct partition type but a non-parsable partition name '%s', ignoring.", partname);
1249 if (r < 0)
1250 return log_error_errno(r, "Failed to validate partition name '%s': %m", partname);
1251
1252 r = sd_device_get_property_value(d, "ID_FS_UUID", &partuuid);
1253 if (r < 0)
1254 return log_warning_errno(r, "Failed to acquire ID_FS_UUID device property, ignoring: %m");
1255
1256 r = sd_id128_from_string(partuuid, &id);
1257 if (r < 0)
1258 return log_warning_errno(r, "Failed to parse ID_FS_UUID field '%s', ignoring: %m", partuuid);
1259
1260 if (asprintf(&node, "/dev/disk/by-uuid/" SD_ID128_UUID_FORMAT_STR, SD_ID128_FORMAT_VAL(id)) < 0)
1261 return log_oom();
1262
1263 return manager_add_home_by_image(m, user_name, realm, node, sysfs, USER_LUKS, UID_INVALID);
1264 }
1265
1266 static int manager_on_device(sd_device_monitor *monitor, sd_device *d, void *userdata) {
1267 Manager *m = userdata;
1268 int r;
1269
1270 assert(m);
1271 assert(d);
1272
1273 if (device_for_action(d, SD_DEVICE_REMOVE)) {
1274 const char *sysfs;
1275 Home *h;
1276
1277 r = sd_device_get_syspath(d, &sysfs);
1278 if (r < 0) {
1279 log_warning_errno(r, "Failed to acquire sysfs path from device: %m");
1280 return 0;
1281 }
1282
1283 log_info("block device %s has been removed.", sysfs);
1284
1285 /* Let's see if we previously synthesized a home record from this device, if so, let's just
1286 * revalidate that. Otherwise let's revalidate them all, but asynchronously. */
1287 h = hashmap_get(m->homes_by_sysfs, sysfs);
1288 if (h)
1289 manager_revalidate_image(m, h);
1290 else
1291 manager_enqueue_gc(m, NULL);
1292 } else
1293 (void) manager_add_device(m, d);
1294
1295 (void) bus_manager_emit_auto_login_changed(m);
1296 return 0;
1297 }
1298
1299 static int manager_watch_devices(Manager *m) {
1300 int r;
1301
1302 assert(m);
1303 assert(!m->device_monitor);
1304
1305 r = sd_device_monitor_new(&m->device_monitor);
1306 if (r < 0)
1307 return log_error_errno(r, "Failed to allocate device monitor: %m");
1308
1309 r = sd_device_monitor_filter_add_match_subsystem_devtype(m->device_monitor, "block", NULL);
1310 if (r < 0)
1311 return log_error_errno(r, "Failed to configure device monitor match: %m");
1312
1313 r = sd_device_monitor_attach_event(m->device_monitor, m->event);
1314 if (r < 0)
1315 return log_error_errno(r, "Failed to attach device monitor to event loop: %m");
1316
1317 r = sd_device_monitor_start(m->device_monitor, manager_on_device, m);
1318 if (r < 0)
1319 return log_error_errno(r, "Failed to start device monitor: %m");
1320
1321 return 0;
1322 }
1323
1324 static int manager_enumerate_devices(Manager *m) {
1325 _cleanup_(sd_device_enumerator_unrefp) sd_device_enumerator *e = NULL;
1326 sd_device *d;
1327 int r;
1328
1329 assert(m);
1330
1331 r = sd_device_enumerator_new(&e);
1332 if (r < 0)
1333 return r;
1334
1335 r = sd_device_enumerator_add_match_subsystem(e, "block", true);
1336 if (r < 0)
1337 return r;
1338
1339 FOREACH_DEVICE(e, d)
1340 (void) manager_add_device(m, d);
1341
1342 return 0;
1343 }
1344
1345 static int manager_load_key_pair(Manager *m) {
1346 _cleanup_(fclosep) FILE *f = NULL;
1347 struct stat st;
1348 int r;
1349
1350 assert(m);
1351
1352 if (m->private_key) {
1353 EVP_PKEY_free(m->private_key);
1354 m->private_key = NULL;
1355 }
1356
1357 r = search_and_fopen_nulstr("local.private", "re", NULL, KEY_PATHS_NULSTR, &f, NULL);
1358 if (r == -ENOENT)
1359 return 0;
1360 if (r < 0)
1361 return log_error_errno(r, "Failed to read private key file: %m");
1362
1363 if (fstat(fileno(f), &st) < 0)
1364 return log_error_errno(errno, "Failed to stat private key file: %m");
1365
1366 r = stat_verify_regular(&st);
1367 if (r < 0)
1368 return log_error_errno(r, "Private key file is not regular: %m");
1369
1370 if (st.st_uid != 0 || (st.st_mode & 0077) != 0)
1371 return log_error_errno(SYNTHETIC_ERRNO(EPERM), "Private key file is readable by more than the root user");
1372
1373 m->private_key = PEM_read_PrivateKey(f, NULL, NULL, NULL);
1374 if (!m->private_key)
1375 return log_error_errno(SYNTHETIC_ERRNO(EIO), "Failed to load private key pair");
1376
1377 log_info("Successfully loaded private key pair.");
1378
1379 return 1;
1380 }
1381
1382 DEFINE_TRIVIAL_CLEANUP_FUNC_FULL(EVP_PKEY_CTX*, EVP_PKEY_CTX_free, NULL);
1383
1384 static int manager_generate_key_pair(Manager *m) {
1385 _cleanup_(EVP_PKEY_CTX_freep) EVP_PKEY_CTX *ctx = NULL;
1386 _cleanup_(unlink_and_freep) char *temp_public = NULL, *temp_private = NULL;
1387 _cleanup_fclose_ FILE *fpublic = NULL, *fprivate = NULL;
1388 int r;
1389
1390 if (m->private_key) {
1391 EVP_PKEY_free(m->private_key);
1392 m->private_key = NULL;
1393 }
1394
1395 ctx = EVP_PKEY_CTX_new_id(EVP_PKEY_ED25519, NULL);
1396 if (!ctx)
1397 return log_error_errno(SYNTHETIC_ERRNO(EIO), "Failed to allocate Ed25519 key generation context.");
1398
1399 if (EVP_PKEY_keygen_init(ctx) <= 0)
1400 return log_error_errno(SYNTHETIC_ERRNO(EIO), "Failed to initialize Ed25519 key generation context.");
1401
1402 log_info("Generating key pair for signing local user identity records.");
1403
1404 if (EVP_PKEY_keygen(ctx, &m->private_key) <= 0)
1405 return log_error_errno(SYNTHETIC_ERRNO(EIO), "Failed to generate Ed25519 key pair");
1406
1407 log_info("Successfully created Ed25519 key pair.");
1408
1409 (void) mkdir_p("/var/lib/systemd/home", 0755);
1410
1411 /* Write out public key (note that we only do that as a help to the user, we don't make use of this ever */
1412 r = fopen_temporary("/var/lib/systemd/home/local.public", &fpublic, &temp_public);
1413 if (r < 0)
1414 return log_error_errno(errno, "Failed to open key file for writing: %m");
1415
1416 if (PEM_write_PUBKEY(fpublic, m->private_key) <= 0)
1417 return log_error_errno(SYNTHETIC_ERRNO(EIO), "Failed to write public key.");
1418
1419 r = fflush_sync_and_check(fpublic);
1420 if (r < 0)
1421 return log_error_errno(r, "Failed to write private key: %m");
1422
1423 fpublic = safe_fclose(fpublic);
1424
1425 /* Write out the private key (this actually writes out both private and public, OpenSSL is confusing) */
1426 r = fopen_temporary("/var/lib/systemd/home/local.private", &fprivate, &temp_private);
1427 if (r < 0)
1428 return log_error_errno(errno, "Failed to open key file for writing: %m");
1429
1430 if (PEM_write_PrivateKey(fprivate, m->private_key, NULL, NULL, 0, NULL, 0) <= 0)
1431 return log_error_errno(SYNTHETIC_ERRNO(EIO), "Failed to write private key pair.");
1432
1433 r = fflush_sync_and_check(fprivate);
1434 if (r < 0)
1435 return log_error_errno(r, "Failed to write private key: %m");
1436
1437 fprivate = safe_fclose(fprivate);
1438
1439 /* Both are written now, move them into place */
1440
1441 if (rename(temp_public, "/var/lib/systemd/home/local.public") < 0)
1442 return log_error_errno(errno, "Failed to move public key file into place: %m");
1443 temp_public = mfree(temp_public);
1444
1445 if (rename(temp_private, "/var/lib/systemd/home/local.private") < 0) {
1446 (void) unlink_noerrno("/var/lib/systemd/home/local.public"); /* try to remove the file we already created */
1447 return log_error_errno(errno, "Failed to move private key file into place: %m");
1448 }
1449 temp_private = mfree(temp_private);
1450
1451 r = fsync_path_at(AT_FDCWD, "/var/lib/systemd/home/");
1452 if (r < 0)
1453 log_warning_errno(r, "Failed to sync /var/lib/systemd/home/, ignoring: %m");
1454
1455 return 1;
1456 }
1457
1458 int manager_acquire_key_pair(Manager *m) {
1459 int r;
1460
1461 assert(m);
1462
1463 /* Already there? */
1464 if (m->private_key)
1465 return 1;
1466
1467 /* First try to load key off disk */
1468 r = manager_load_key_pair(m);
1469 if (r != 0)
1470 return r;
1471
1472 /* Didn't work, generate a new one */
1473 return manager_generate_key_pair(m);
1474 }
1475
1476 int manager_sign_user_record(Manager *m, UserRecord *u, UserRecord **ret, sd_bus_error *error) {
1477 int r;
1478
1479 assert(m);
1480 assert(u);
1481 assert(ret);
1482
1483 r = manager_acquire_key_pair(m);
1484 if (r < 0)
1485 return r;
1486 if (r == 0)
1487 return sd_bus_error_set(error, BUS_ERROR_NO_PRIVATE_KEY, "Can't sign without local key.");
1488
1489 return user_record_sign(u, m->private_key, ret);
1490 }
1491
1492 DEFINE_PRIVATE_HASH_OPS_FULL(public_key_hash_ops, char, string_hash_func, string_compare_func, free, EVP_PKEY, EVP_PKEY_free);
1493 DEFINE_TRIVIAL_CLEANUP_FUNC_FULL(EVP_PKEY*, EVP_PKEY_free, NULL);
1494
1495 static int manager_load_public_key_one(Manager *m, const char *path) {
1496 _cleanup_(EVP_PKEY_freep) EVP_PKEY *pkey = NULL;
1497 _cleanup_fclose_ FILE *f = NULL;
1498 _cleanup_free_ char *fn = NULL;
1499 struct stat st;
1500 int r;
1501
1502 assert(m);
1503
1504 if (streq(basename(path), "local.public")) /* we already loaded the private key, which includes the public one */
1505 return 0;
1506
1507 f = fopen(path, "re");
1508 if (!f) {
1509 if (errno == ENOENT)
1510 return 0;
1511
1512 return log_error_errno(errno, "Failed to open public key %s: %m", path);
1513 }
1514
1515 if (fstat(fileno(f), &st) < 0)
1516 return log_error_errno(errno, "Failed to stat public key %s: %m", path);
1517
1518 r = stat_verify_regular(&st);
1519 if (r < 0)
1520 return log_error_errno(r, "Public key file %s is not a regular file: %m", path);
1521
1522 if (st.st_uid != 0 || (st.st_mode & 0022) != 0)
1523 return log_error_errno(SYNTHETIC_ERRNO(EPERM), "Public key file %s is writable by more than the root user, refusing.", path);
1524
1525 r = hashmap_ensure_allocated(&m->public_keys, &public_key_hash_ops);
1526 if (r < 0)
1527 return log_oom();
1528
1529 pkey = PEM_read_PUBKEY(f, &pkey, NULL, NULL);
1530 if (!pkey)
1531 return log_error_errno(SYNTHETIC_ERRNO(EIO), "Failed to parse public key file %s.", path);
1532
1533 fn = strdup(basename(path));
1534 if (!fn)
1535 return log_oom();
1536
1537 r = hashmap_put(m->public_keys, fn, pkey);
1538 if (r < 0)
1539 return log_error_errno(r, "Failed to add public key to set: %m");
1540
1541 TAKE_PTR(fn);
1542 TAKE_PTR(pkey);
1543
1544 return 0;
1545 }
1546
1547 static int manager_load_public_keys(Manager *m) {
1548 _cleanup_strv_free_ char **files = NULL;
1549 char **i;
1550 int r;
1551
1552 assert(m);
1553
1554 m->public_keys = hashmap_free(m->public_keys);
1555
1556 r = conf_files_list_nulstr(
1557 &files,
1558 ".public",
1559 NULL,
1560 CONF_FILES_REGULAR|CONF_FILES_FILTER_MASKED,
1561 KEY_PATHS_NULSTR);
1562 if (r < 0)
1563 return log_error_errno(r, "Failed to assemble list of public key directories: %m");
1564
1565 STRV_FOREACH(i, files)
1566 (void) manager_load_public_key_one(m, *i);
1567
1568 return 0;
1569 }
1570
1571 int manager_startup(Manager *m) {
1572 int r;
1573
1574 assert(m);
1575
1576 r = manager_listen_notify(m);
1577 if (r < 0)
1578 return r;
1579
1580 r = manager_connect_bus(m);
1581 if (r < 0)
1582 return r;
1583
1584 r = manager_bind_varlink(m);
1585 if (r < 0)
1586 return r;
1587
1588 r = manager_load_key_pair(m); /* only try to load it, don't generate any */
1589 if (r < 0)
1590 return r;
1591
1592 r = manager_load_public_keys(m);
1593 if (r < 0)
1594 return r;
1595
1596 manager_watch_home(m);
1597 (void) manager_watch_devices(m);
1598
1599 (void) manager_enumerate_records(m);
1600 (void) manager_enumerate_images(m);
1601 (void) manager_enumerate_devices(m);
1602
1603 /* Let's clean up home directories whose devices got removed while we were not running */
1604 (void) manager_enqueue_gc(m, NULL);
1605
1606 return 0;
1607 }
1608
1609 void manager_revalidate_image(Manager *m, Home *h) {
1610 int r;
1611
1612 assert(m);
1613 assert(h);
1614
1615 /* Frees an automatically discovered image, if it's synthetic and its image disappeared. Unmounts any
1616 * image if it's mounted but it's image vanished. */
1617
1618 if (h->current_operation || !ordered_set_isempty(h->pending_operations))
1619 return;
1620
1621 if (h->state == HOME_UNFIXATED) {
1622 r = user_record_test_image_path(h->record);
1623 if (r < 0)
1624 log_warning_errno(r, "Can't determine if image of %s exists, freeing unfixated user: %m", h->user_name);
1625 else if (r == USER_TEST_ABSENT)
1626 log_info("Image for %s disappeared, freeing unfixated user.", h->user_name);
1627 else
1628 return;
1629
1630 home_free(h);
1631
1632 } else if (h->state < 0) {
1633
1634 r = user_record_test_home_directory(h->record);
1635 if (r < 0) {
1636 log_warning_errno(r, "Unable to determine state of home directory, ignoring: %m");
1637 return;
1638 }
1639
1640 if (r == USER_TEST_MOUNTED) {
1641 r = user_record_test_image_path(h->record);
1642 if (r < 0) {
1643 log_warning_errno(r, "Unable to determine state of image path, ignoring: %m");
1644 return;
1645 }
1646
1647 if (r == USER_TEST_ABSENT) {
1648 _cleanup_(operation_unrefp) Operation *o = NULL;
1649
1650 log_notice("Backing image disappeared while home directory %s was mounted, unmounting it forcibly.", h->user_name);
1651 /* Wowza, the thing is mounted, but the device is gone? Act on it. */
1652
1653 r = home_killall(h);
1654 if (r < 0)
1655 log_warning_errno(r, "Failed to kill processes of user %s, ignoring: %m", h->user_name);
1656
1657 /* We enqueue the operation here, after all the home directory might
1658 * currently already run some operation, and we can deactivate it only after
1659 * that's complete. */
1660 o = operation_new(OPERATION_DEACTIVATE_FORCE, NULL);
1661 if (!o) {
1662 log_oom();
1663 return;
1664 }
1665
1666 r = home_schedule_operation(h, o, NULL);
1667 if (r < 0)
1668 log_warning_errno(r, "Failed to enqueue forced home directory %s deactivation, ignoring: %m", h->user_name);
1669 }
1670 }
1671 }
1672 }
1673
1674 int manager_gc_images(Manager *m) {
1675 Home *h;
1676
1677 assert_se(m);
1678
1679 if (m->gc_focus) {
1680 /* Focus on a specific home */
1681
1682 h = TAKE_PTR(m->gc_focus);
1683 manager_revalidate_image(m, h);
1684 } else {
1685 /* Gc all */
1686
1687 HASHMAP_FOREACH(h, m->homes_by_name)
1688 manager_revalidate_image(m, h);
1689 }
1690
1691 return 0;
1692 }
1693
1694 static int on_deferred_rescan(sd_event_source *s, void *userdata) {
1695 Manager *m = userdata;
1696
1697 assert(m);
1698
1699 m->deferred_rescan_event_source = sd_event_source_disable_unref(m->deferred_rescan_event_source);
1700
1701 manager_enumerate_devices(m);
1702 manager_enumerate_images(m);
1703 return 0;
1704 }
1705
1706 int manager_enqueue_rescan(Manager *m) {
1707 int r;
1708
1709 assert(m);
1710
1711 if (m->deferred_rescan_event_source)
1712 return 0;
1713
1714 if (!m->event)
1715 return 0;
1716
1717 if (IN_SET(sd_event_get_state(m->event), SD_EVENT_FINISHED, SD_EVENT_EXITING))
1718 return 0;
1719
1720 r = sd_event_add_defer(m->event, &m->deferred_rescan_event_source, on_deferred_rescan, m);
1721 if (r < 0)
1722 return log_error_errno(r, "Failed to allocate rescan event source: %m");
1723
1724 r = sd_event_source_set_priority(m->deferred_rescan_event_source, SD_EVENT_PRIORITY_IDLE+1);
1725 if (r < 0)
1726 log_warning_errno(r, "Failed to tweak priority of event source, ignoring: %m");
1727
1728 (void) sd_event_source_set_description(m->deferred_rescan_event_source, "deferred-rescan");
1729 return 1;
1730 }
1731
1732 static int on_deferred_gc(sd_event_source *s, void *userdata) {
1733 Manager *m = userdata;
1734
1735 assert(m);
1736
1737 m->deferred_gc_event_source = sd_event_source_disable_unref(m->deferred_gc_event_source);
1738
1739 manager_gc_images(m);
1740 return 0;
1741 }
1742
1743 int manager_enqueue_gc(Manager *m, Home *focus) {
1744 int r;
1745
1746 assert(m);
1747
1748 /* This enqueues a request to GC dead homes. It may be called with focus=NULL in which case all homes
1749 * will be scanned, or with the parameter set, in which case only that home is checked. */
1750
1751 if (!m->event)
1752 return 0;
1753
1754 if (IN_SET(sd_event_get_state(m->event), SD_EVENT_FINISHED, SD_EVENT_EXITING))
1755 return 0;
1756
1757 /* If a focus home is specified, then remember to focus just on this home. Otherwise invalidate any
1758 * focus that might be set to look at all homes. */
1759
1760 if (m->deferred_gc_event_source) {
1761 if (m->gc_focus != focus) /* not the same focus, then look at everything */
1762 m->gc_focus = NULL;
1763
1764 return 0;
1765 } else
1766 m->gc_focus = focus; /* start focused */
1767
1768 r = sd_event_add_defer(m->event, &m->deferred_gc_event_source, on_deferred_gc, m);
1769 if (r < 0)
1770 return log_error_errno(r, "Failed to allocate GC event source: %m");
1771
1772 r = sd_event_source_set_priority(m->deferred_gc_event_source, SD_EVENT_PRIORITY_IDLE);
1773 if (r < 0)
1774 log_warning_errno(r, "Failed to tweak priority of event source, ignoring: %m");
1775
1776 (void) sd_event_source_set_description(m->deferred_gc_event_source, "deferred-gc");
1777 return 1;
1778 }
1779
1780 static bool manager_shall_rebalance(Manager *m) {
1781 Home *h;
1782
1783 assert(m);
1784
1785 if (IN_SET(m->rebalance_state, REBALANCE_PENDING, REBALANCE_SHRINKING, REBALANCE_GROWING))
1786 return true;
1787
1788 HASHMAP_FOREACH(h, m->homes_by_name)
1789 if (home_shall_rebalance(h))
1790 return true;
1791
1792 return false;
1793 }
1794
1795 static int home_cmp(Home *const*a, Home *const*b) {
1796 int r;
1797
1798 assert(a);
1799 assert(*a);
1800 assert(b);
1801 assert(*b);
1802
1803 /* Order user records by their weight (and by their name, to make things stable). We put the records
1804 * with the highest weight last, since we distribute space from the beginning and round down, hence
1805 * later entries tend to get slightly more than earlier entries. */
1806
1807 r = CMP(user_record_rebalance_weight((*a)->record), user_record_rebalance_weight((*b)->record));
1808 if (r != 0)
1809 return r;
1810
1811 return strcmp((*a)->user_name, (*b)->user_name);
1812 }
1813
1814 static int manager_rebalance_calculate(Manager *m) {
1815 uint64_t weight_sum, free_sum, usage_sum = 0, min_free = UINT64_MAX;
1816 _cleanup_free_ Home **array = NULL;
1817 bool relevant = false;
1818 struct statfs sfs;
1819 int c = 0, r;
1820 Home *h;
1821
1822 assert(m);
1823
1824 if (statfs(get_home_root(), &sfs) < 0)
1825 return log_error_errno(errno, "Failed to statfs() /home: %m");
1826
1827 free_sum = (uint64_t) sfs.f_bsize * sfs.f_bavail; /* This much free space is available on the
1828 * underlying pool directory */
1829
1830 weight_sum = REBALANCE_WEIGHT_BACKING; /* Grant the underlying pool directory a fixed weight of 20
1831 * (home dirs get 100 by default, i.e. 5x more). This weight
1832 * is not configurable, the per-home weights are. */
1833
1834 HASHMAP_FOREACH(h, m->homes_by_name) {
1835 statfs_f_type_t fstype;
1836 h->rebalance_pending = false; /* First, reset the flag, we only want it to be true for the
1837 * homes that qualify for rebalancing */
1838
1839 if (!home_shall_rebalance(h)) /* Only look at actual candidates */
1840 continue;
1841
1842 if (home_is_busy(h))
1843 return -EBUSY; /* Let's not rebalance if there's a busy home directory. */
1844
1845 r = home_get_disk_status(
1846 h,
1847 &h->rebalance_size,
1848 &h->rebalance_usage,
1849 &h->rebalance_free,
1850 NULL,
1851 NULL,
1852 &fstype,
1853 NULL);
1854 if (r < 0) {
1855 log_warning_errno(r, "Failed to get free space of home '%s', ignoring.", h->user_name);
1856 continue;
1857 }
1858
1859 if (h->rebalance_free > UINT64_MAX - free_sum)
1860 return log_error_errno(SYNTHETIC_ERRNO(EOVERFLOW), "Rebalance free overflow");
1861 free_sum += h->rebalance_free;
1862
1863 if (h->rebalance_usage > UINT64_MAX - usage_sum)
1864 return log_error_errno(SYNTHETIC_ERRNO(EOVERFLOW), "Rebalance usage overflow");
1865 usage_sum += h->rebalance_usage;
1866
1867 h->rebalance_weight = user_record_rebalance_weight(h->record);
1868 if (h->rebalance_weight > UINT64_MAX - weight_sum)
1869 return log_error_errno(SYNTHETIC_ERRNO(EOVERFLOW), "Rebalance weight overflow");
1870 weight_sum += h->rebalance_weight;
1871
1872 h->rebalance_min = minimal_size_by_fs_magic(fstype);
1873
1874 if (!GREEDY_REALLOC(array, c+1))
1875 return log_oom();
1876
1877 array[c++] = h;
1878 }
1879
1880 if (c == 0) {
1881 log_debug("No homes to rebalance.");
1882 return 0;
1883 }
1884
1885 assert(weight_sum > 0);
1886
1887 log_debug("Disk space usage by all home directories to rebalance: %s — available disk space: %s",
1888 FORMAT_BYTES(usage_sum), FORMAT_BYTES(free_sum));
1889
1890 /* Bring the home directories in a well-defined order, so that we distribute space in a reproducible
1891 * way for the same parameters. */
1892 typesafe_qsort(array, c, home_cmp);
1893
1894 for (int i = 0; i < c; i++) {
1895 uint64_t new_free;
1896 double d;
1897
1898 h = array[i];
1899
1900 assert(h->rebalance_free <= free_sum);
1901 assert(h->rebalance_usage <= usage_sum);
1902 assert(h->rebalance_weight <= weight_sum);
1903
1904 d = ((double) (free_sum / 4096) * (double) h->rebalance_weight) / (double) weight_sum; /* Calculate new space for this home in units of 4K */
1905
1906 /* Convert from units of 4K back to bytes */
1907 if (d >= (double) (UINT64_MAX/4096))
1908 new_free = UINT64_MAX;
1909 else
1910 new_free = (uint64_t) d * 4096;
1911
1912 /* Subtract the weight and assigned space from the sums now, to distribute the rounding noise
1913 * to the remaining home dirs */
1914 free_sum = LESS_BY(free_sum, new_free);
1915 weight_sum = LESS_BY(weight_sum, h->rebalance_weight);
1916
1917 /* Keep track of home directory with the least amount of space left: we want to schedule the
1918 * next rebalance more quickly if this is low */
1919 if (new_free < min_free)
1920 min_free = h->rebalance_size;
1921
1922 if (new_free > UINT64_MAX - h->rebalance_usage)
1923 h->rebalance_goal = UINT64_MAX-1; /* maximum size */
1924 else {
1925 h->rebalance_goal = h->rebalance_usage + new_free;
1926
1927 if (h->rebalance_min != UINT64_MAX && h->rebalance_goal < h->rebalance_min)
1928 h->rebalance_goal = h->rebalance_min;
1929 }
1930
1931 /* Skip over this home if the state doesn't match the operation */
1932 if ((m->rebalance_state == REBALANCE_SHRINKING && h->rebalance_goal > h->rebalance_size) ||
1933 (m->rebalance_state == REBALANCE_GROWING && h->rebalance_goal < h->rebalance_size))
1934 h->rebalance_pending = false;
1935 else {
1936 log_debug("Rebalancing home directory '%s' %s → %s.", h->user_name,
1937 FORMAT_BYTES(h->rebalance_size), FORMAT_BYTES(h->rebalance_goal));
1938 h->rebalance_pending = true;
1939 }
1940
1941 if ((fabs((double) h->rebalance_size - (double) h->rebalance_goal) * 100 / (double) h->rebalance_size) >= 5.0)
1942 relevant = true;
1943 }
1944
1945 /* Scale next rebalancing interval based on the least amount of space of any of the home
1946 * directories. We pick a time in the range 1min … 15min, scaled by log2(min_free), so that:
1947 * 10M → ~0.7min, 100M → ~2.7min, 1G → ~4.6min, 10G → ~6.5min, 100G ~8.4 */
1948 m->rebalance_interval_usec = (usec_t) CLAMP((LESS_BY(log2(min_free), 22)*15*USEC_PER_MINUTE)/26,
1949 1 * USEC_PER_MINUTE,
1950 15 * USEC_PER_MINUTE);
1951
1952
1953 log_debug("Rebalancing interval set to %s.", FORMAT_TIMESPAN(m->rebalance_interval_usec, USEC_PER_MSEC));
1954
1955 /* Let's suppress small resizes, growing/shrinking file systems isn't free after all */
1956 if (!relevant) {
1957 log_debug("Skipping rebalancing, since all calculated size changes are below ±5%%.");
1958 return 0;
1959 }
1960
1961 return c;
1962 }
1963
1964 static int manager_rebalance_apply(Manager *m) {
1965 int c = 0, r;
1966 Home *h;
1967
1968 assert(m);
1969
1970 HASHMAP_FOREACH(h, m->homes_by_name) {
1971 _cleanup_(sd_bus_error_free) sd_bus_error error = SD_BUS_ERROR_NULL;
1972
1973 if (!h->rebalance_pending)
1974 continue;
1975
1976 h->rebalance_pending = false;
1977
1978 r = home_resize(h, h->rebalance_goal, /* secret= */ NULL, /* automatic= */ true, &error);
1979 if (r < 0)
1980 log_warning_errno(r, "Failed to resize home '%s' for rebalancing, ignoring: %s",
1981 h->user_name, bus_error_message(&error, r));
1982 else
1983 c++;
1984 }
1985
1986 return c;
1987 }
1988
1989 static void manager_rebalance_reply_messages(Manager *m) {
1990 int r;
1991
1992 assert(m);
1993
1994 for (;;) {
1995 _cleanup_(sd_bus_message_unrefp) sd_bus_message *msg =
1996 set_steal_first(m->rebalance_pending_method_calls);
1997
1998 if (!msg)
1999 break;
2000
2001 r = sd_bus_reply_method_return(msg, NULL);
2002 if (r < 0)
2003 log_debug_errno(r, "Failed to reply to rebalance method call, ignoring: %m");
2004 }
2005 }
2006
2007 static int manager_rebalance_now(Manager *m) {
2008 RebalanceState busy_state; /* the state to revert to when operation fails if busy */
2009 int r;
2010
2011 assert(m);
2012
2013 log_debug("Rebalancing now...");
2014
2015 /* We maintain a simple state engine here to keep track of what we are doing. We'll first shrink all
2016 * homes that shall be shrunk and then grow all homes that shall be grown, so that they can take up
2017 * the space now freed. */
2018
2019 for (;;) {
2020 switch (m->rebalance_state) {
2021
2022 case REBALANCE_IDLE:
2023 case REBALANCE_PENDING:
2024 case REBALANCE_WAITING:
2025 /* First shrink large home dirs */
2026 m->rebalance_state = REBALANCE_SHRINKING;
2027 busy_state = REBALANCE_PENDING;
2028
2029 /* We are initiating the next rebalancing cycle now, let's make the queued methods
2030 * calls the pending ones, and flush out any pending ones (which shouldn't exist at
2031 * this time anyway) */
2032 set_clear(m->rebalance_pending_method_calls);
2033 SWAP_TWO(m->rebalance_pending_method_calls, m->rebalance_queued_method_calls);
2034
2035 log_debug("Shrinking phase..");
2036 break;
2037
2038 case REBALANCE_SHRINKING:
2039 /* Then grow small home dirs */
2040 m->rebalance_state = REBALANCE_GROWING;
2041 busy_state = REBALANCE_SHRINKING;
2042 log_debug("Growing phase..");
2043 break;
2044
2045 case REBALANCE_GROWING:
2046 /* Finally, we are done */
2047 log_info("Rebalancing complete.");
2048 m->rebalance_state = REBALANCE_IDLE;
2049 r = 0;
2050 goto finish;
2051
2052 case REBALANCE_OFF:
2053 default:
2054 assert_not_reached();
2055 }
2056
2057 r = manager_rebalance_calculate(m);
2058 if (r == -EBUSY) {
2059 /* Calculations failed because one home directory is currently busy. Revert to a state that
2060 * tells us what to do next. */
2061 log_debug("Can't enter phase, busy.");
2062 m->rebalance_state = busy_state;
2063 return r;
2064 }
2065 if (r < 0)
2066 goto finish;
2067 if (r == 0)
2068 continue; /* got to next step immediately, if there's nothing to do */
2069
2070 r = manager_rebalance_apply(m);
2071 if (r < 0)
2072 goto finish;
2073 if (r > 0)
2074 break; /* At least one resize operation is now pending, we are done for now */
2075
2076 /* If there was nothing to apply, go for next state right-away */
2077 }
2078
2079 return 0;
2080
2081 finish:
2082 /* Reset state and schedule next rebalance */
2083 m->rebalance_state = REBALANCE_IDLE;
2084 manager_rebalance_reply_messages(m);
2085 (void) manager_schedule_rebalance(m, /* immediately= */ false);
2086 return r;
2087 }
2088
2089 static int on_rebalance_timer(sd_event_source *s, usec_t t, void *userdata) {
2090 Manager *m = userdata;
2091
2092 assert(s);
2093 assert(m);
2094 assert(IN_SET(m->rebalance_state, REBALANCE_WAITING, REBALANCE_PENDING, REBALANCE_SHRINKING, REBALANCE_GROWING));
2095
2096 (void) manager_rebalance_now(m);
2097 return 0;
2098 }
2099
2100 int manager_schedule_rebalance(Manager *m, bool immediately) {
2101 int r;
2102
2103 assert(m);
2104
2105 /* Check if there are any records where rebalancing is requested */
2106 if (!manager_shall_rebalance(m)) {
2107 log_debug("Not scheduling rebalancing, not needed.");
2108 r = 0; /* report that we didn't schedule anything because nothing needed it */
2109 goto turn_off;
2110 }
2111
2112 if (immediately) {
2113 /* If we are told to rebalance immediately, then mark a rebalance as pending (even if we area
2114 * already running one) */
2115
2116 if (m->rebalance_event_source) {
2117 r = sd_event_source_set_time(m->rebalance_event_source, 0);
2118 if (r < 0) {
2119 log_error_errno(r, "Failed to schedule immediate rebalancing: %m");
2120 goto turn_off;
2121 }
2122
2123 r = sd_event_source_set_enabled(m->rebalance_event_source, SD_EVENT_ONESHOT);
2124 if (r < 0) {
2125 log_error_errno(r, "Failed to enable rebalancing event source: %m");
2126 goto turn_off;
2127 }
2128 } else {
2129 r = sd_event_add_time(m->event, &m->rebalance_event_source, CLOCK_MONOTONIC, 0, USEC_PER_SEC, on_rebalance_timer, m);
2130 if (r < 0) {
2131 log_error_errno(r, "Failed to allocate rebalance event source: %m");
2132 goto turn_off;
2133 }
2134
2135 r = sd_event_source_set_priority(m->rebalance_event_source, SD_EVENT_PRIORITY_IDLE + 10);
2136 if (r < 0) {
2137 log_error_errno(r, "Failed to set rebalance event source priority: %m");
2138 goto turn_off;
2139 }
2140
2141 (void) sd_event_source_set_description(m->rebalance_event_source, "rebalance");
2142
2143 }
2144
2145 if (!IN_SET(m->rebalance_state, REBALANCE_PENDING, REBALANCE_SHRINKING, REBALANCE_GROWING))
2146 m->rebalance_state = REBALANCE_PENDING;
2147
2148 log_debug("Scheduled immediate rebalancing...");
2149 return 1; /* report that we scheduled something */
2150 }
2151
2152 /* If we are told to schedule a rebalancing eventually, then do so only if we are not executing
2153 * anything yet. Also if we have something scheduled already, leave it in place */
2154 if (!IN_SET(m->rebalance_state, REBALANCE_OFF, REBALANCE_IDLE))
2155 return 1; /* report that there's already something scheduled */
2156
2157 if (m->rebalance_event_source) {
2158 r = sd_event_source_set_time_relative(m->rebalance_event_source, m->rebalance_interval_usec);
2159 if (r < 0) {
2160 log_error_errno(r, "Failed to schedule immediate rebalancing: %m");
2161 goto turn_off;
2162 }
2163
2164 r = sd_event_source_set_enabled(m->rebalance_event_source, SD_EVENT_ONESHOT);
2165 if (r < 0) {
2166 log_error_errno(r, "Failed to enable rebalancing event source: %m");
2167 goto turn_off;
2168 }
2169 } else {
2170 r = sd_event_add_time_relative(m->event, &m->rebalance_event_source, CLOCK_MONOTONIC, m->rebalance_interval_usec, USEC_PER_SEC, on_rebalance_timer, m);
2171 if (r < 0) {
2172 log_error_errno(r, "Failed to allocate rebalance event source: %m");
2173 goto turn_off;
2174 }
2175
2176 r = sd_event_source_set_priority(m->rebalance_event_source, SD_EVENT_PRIORITY_IDLE + 10);
2177 if (r < 0) {
2178 log_error_errno(r, "Failed to set rebalance event source priority: %m");
2179 goto turn_off;
2180 }
2181
2182 (void) sd_event_source_set_description(m->rebalance_event_source, "rebalance");
2183 }
2184
2185 m->rebalance_state = REBALANCE_WAITING; /* We managed to enqueue a timer event, we now wait until it fires */
2186 log_debug("Scheduled rebalancing in %s...", FORMAT_TIMESPAN(m->rebalance_interval_usec, 0));
2187 return 1; /* report that we scheduled something */
2188
2189 turn_off:
2190 m->rebalance_event_source = sd_event_source_disable_unref(m->rebalance_event_source);
2191 m->rebalance_state = REBALANCE_OFF;
2192 manager_rebalance_reply_messages(m);
2193 return r;
2194 }
2195
2196 int manager_reschedule_rebalance(Manager *m) {
2197 int r;
2198
2199 assert(m);
2200
2201 /* If a rebalance is pending reschedules it so it gets executed immediately */
2202
2203 if (!IN_SET(m->rebalance_state, REBALANCE_PENDING, REBALANCE_SHRINKING, REBALANCE_GROWING))
2204 return 0;
2205
2206 r = manager_schedule_rebalance(m, /* immediately= */ true);
2207 if (r < 0)
2208 return r;
2209
2210 return 1;
2211 }