]> git.ipfire.org Git - thirdparty/systemd.git/blob - src/core/device.c
Merge pull request #11827 from keszybz/pkgconfig-variables
[thirdparty/systemd.git] / src / core / device.c
1 /* SPDX-License-Identifier: LGPL-2.1+ */
2
3 #include <errno.h>
4 #include <sys/epoll.h>
5
6 #include "alloc-util.h"
7 #include "bus-error.h"
8 #include "dbus-device.h"
9 #include "dbus-unit.h"
10 #include "device-private.h"
11 #include "device-util.h"
12 #include "device.h"
13 #include "log.h"
14 #include "parse-util.h"
15 #include "path-util.h"
16 #include "serialize.h"
17 #include "stat-util.h"
18 #include "string-util.h"
19 #include "swap.h"
20 #include "unit-name.h"
21 #include "unit.h"
22
23 static const UnitActiveState state_translation_table[_DEVICE_STATE_MAX] = {
24 [DEVICE_DEAD] = UNIT_INACTIVE,
25 [DEVICE_TENTATIVE] = UNIT_ACTIVATING,
26 [DEVICE_PLUGGED] = UNIT_ACTIVE,
27 };
28
29 static int device_dispatch_io(sd_device_monitor *monitor, sd_device *dev, void *userdata);
30 static void device_update_found_one(Device *d, DeviceFound found, DeviceFound mask);
31
32 static void device_unset_sysfs(Device *d) {
33 Hashmap *devices;
34 Device *first;
35
36 assert(d);
37
38 if (!d->sysfs)
39 return;
40
41 /* Remove this unit from the chain of devices which share the
42 * same sysfs path. */
43 devices = UNIT(d)->manager->devices_by_sysfs;
44 first = hashmap_get(devices, d->sysfs);
45 LIST_REMOVE(same_sysfs, first, d);
46
47 if (first)
48 hashmap_remove_and_replace(devices, d->sysfs, first->sysfs, first);
49 else
50 hashmap_remove(devices, d->sysfs);
51
52 d->sysfs = mfree(d->sysfs);
53 }
54
55 static int device_set_sysfs(Device *d, const char *sysfs) {
56 _cleanup_free_ char *copy = NULL;
57 Device *first;
58 int r;
59
60 assert(d);
61
62 if (streq_ptr(d->sysfs, sysfs))
63 return 0;
64
65 r = hashmap_ensure_allocated(&UNIT(d)->manager->devices_by_sysfs, &path_hash_ops);
66 if (r < 0)
67 return r;
68
69 copy = strdup(sysfs);
70 if (!copy)
71 return -ENOMEM;
72
73 device_unset_sysfs(d);
74
75 first = hashmap_get(UNIT(d)->manager->devices_by_sysfs, sysfs);
76 LIST_PREPEND(same_sysfs, first, d);
77
78 r = hashmap_replace(UNIT(d)->manager->devices_by_sysfs, copy, first);
79 if (r < 0) {
80 LIST_REMOVE(same_sysfs, first, d);
81 return r;
82 }
83
84 d->sysfs = TAKE_PTR(copy);
85 return 0;
86 }
87
88 static void device_init(Unit *u) {
89 Device *d = DEVICE(u);
90
91 assert(d);
92 assert(UNIT(d)->load_state == UNIT_STUB);
93
94 /* In contrast to all other unit types we timeout jobs waiting
95 * for devices by default. This is because they otherwise wait
96 * indefinitely for plugged in devices, something which cannot
97 * happen for the other units since their operations time out
98 * anyway. */
99 u->job_running_timeout = u->manager->default_timeout_start_usec;
100
101 u->ignore_on_isolate = true;
102
103 d->deserialized_state = _DEVICE_STATE_INVALID;
104 }
105
106 static void device_done(Unit *u) {
107 Device *d = DEVICE(u);
108
109 assert(d);
110
111 device_unset_sysfs(d);
112 d->wants_property = strv_free(d->wants_property);
113 }
114
115 static int device_load(Unit *u) {
116 int r;
117
118 r = unit_load_fragment_and_dropin_optional(u);
119 if (r < 0)
120 return r;
121
122 if (!u->description) {
123 /* Generate a description based on the path, to be used until the
124 device is initialized properly */
125 r = unit_name_to_path(u->id, &u->description);
126 if (r < 0)
127 log_unit_debug_errno(u, r, "Failed to unescape name: %m");
128 }
129
130 return 0;
131 }
132
133 static void device_set_state(Device *d, DeviceState state) {
134 DeviceState old_state;
135 assert(d);
136
137 if (d->state != state)
138 bus_unit_send_pending_change_signal(UNIT(d), false);
139
140 old_state = d->state;
141 d->state = state;
142
143 if (state == DEVICE_DEAD)
144 device_unset_sysfs(d);
145
146 if (state != old_state)
147 log_unit_debug(UNIT(d), "Changed %s -> %s", device_state_to_string(old_state), device_state_to_string(state));
148
149 unit_notify(UNIT(d), state_translation_table[old_state], state_translation_table[state], 0);
150 }
151
152 static int device_coldplug(Unit *u) {
153 Device *d = DEVICE(u);
154
155 assert(d);
156 assert(d->state == DEVICE_DEAD);
157
158 /* First, let's put the deserialized state and found mask into effect, if we have it. */
159
160 if (d->deserialized_state < 0 ||
161 (d->deserialized_state == d->state &&
162 d->deserialized_found == d->found))
163 return 0;
164
165 d->found = d->deserialized_found;
166 device_set_state(d, d->deserialized_state);
167 return 0;
168 }
169
170 static void device_catchup(Unit *u) {
171 Device *d = DEVICE(u);
172
173 assert(d);
174
175 /* Second, let's update the state with the enumerated state if it's different */
176 if (d->enumerated_found == d->found)
177 return;
178
179 device_update_found_one(d, d->enumerated_found, DEVICE_FOUND_MASK);
180 }
181
182 static const struct {
183 DeviceFound flag;
184 const char *name;
185 } device_found_map[] = {
186 { DEVICE_FOUND_UDEV, "found-udev" },
187 { DEVICE_FOUND_MOUNT, "found-mount" },
188 { DEVICE_FOUND_SWAP, "found-swap" },
189 };
190
191 static int device_found_to_string_many(DeviceFound flags, char **ret) {
192 _cleanup_free_ char *s = NULL;
193 unsigned i;
194
195 assert(ret);
196
197 for (i = 0; i < ELEMENTSOF(device_found_map); i++) {
198 if (!FLAGS_SET(flags, device_found_map[i].flag))
199 continue;
200
201 if (!strextend_with_separator(&s, ",", device_found_map[i].name, NULL))
202 return -ENOMEM;
203 }
204
205 *ret = TAKE_PTR(s);
206
207 return 0;
208 }
209
210 static int device_found_from_string_many(const char *name, DeviceFound *ret) {
211 DeviceFound flags = 0;
212 int r;
213
214 assert(ret);
215
216 for (;;) {
217 _cleanup_free_ char *word = NULL;
218 DeviceFound f = 0;
219 unsigned i;
220
221 r = extract_first_word(&name, &word, ",", 0);
222 if (r < 0)
223 return r;
224 if (r == 0)
225 break;
226
227 for (i = 0; i < ELEMENTSOF(device_found_map); i++)
228 if (streq(word, device_found_map[i].name)) {
229 f = device_found_map[i].flag;
230 break;
231 }
232
233 if (f == 0)
234 return -EINVAL;
235
236 flags |= f;
237 }
238
239 *ret = flags;
240 return 0;
241 }
242
243 static int device_serialize(Unit *u, FILE *f, FDSet *fds) {
244 _cleanup_free_ char *s = NULL;
245 Device *d = DEVICE(u);
246
247 assert(u);
248 assert(f);
249 assert(fds);
250
251 (void) serialize_item(f, "state", device_state_to_string(d->state));
252
253 if (device_found_to_string_many(d->found, &s) >= 0)
254 (void) serialize_item(f, "found", s);
255
256 return 0;
257 }
258
259 static int device_deserialize_item(Unit *u, const char *key, const char *value, FDSet *fds) {
260 Device *d = DEVICE(u);
261 int r;
262
263 assert(u);
264 assert(key);
265 assert(value);
266 assert(fds);
267
268 if (streq(key, "state")) {
269 DeviceState state;
270
271 state = device_state_from_string(value);
272 if (state < 0)
273 log_unit_debug(u, "Failed to parse state value, ignoring: %s", value);
274 else
275 d->deserialized_state = state;
276
277 } else if (streq(key, "found")) {
278 r = device_found_from_string_many(value, &d->deserialized_found);
279 if (r < 0)
280 log_unit_debug_errno(u, r, "Failed to parse found value '%s', ignoring: %m", value);
281
282 } else
283 log_unit_debug(u, "Unknown serialization key: %s", key);
284
285 return 0;
286 }
287
288 static void device_dump(Unit *u, FILE *f, const char *prefix) {
289 Device *d = DEVICE(u);
290 _cleanup_free_ char *s = NULL;
291
292 assert(d);
293
294 (void) device_found_to_string_many(d->found, &s);
295
296 fprintf(f,
297 "%sDevice State: %s\n"
298 "%sSysfs Path: %s\n"
299 "%sFound: %s\n",
300 prefix, device_state_to_string(d->state),
301 prefix, strna(d->sysfs),
302 prefix, strna(s));
303
304 if (!strv_isempty(d->wants_property)) {
305 char **i;
306
307 STRV_FOREACH(i, d->wants_property)
308 fprintf(f, "%sudev SYSTEMD_WANTS: %s\n",
309 prefix, *i);
310 }
311 }
312
313 _pure_ static UnitActiveState device_active_state(Unit *u) {
314 assert(u);
315
316 return state_translation_table[DEVICE(u)->state];
317 }
318
319 _pure_ static const char *device_sub_state_to_string(Unit *u) {
320 assert(u);
321
322 return device_state_to_string(DEVICE(u)->state);
323 }
324
325 static int device_update_description(Unit *u, sd_device *dev, const char *path) {
326 _cleanup_free_ char *j = NULL;
327 const char *model, *label, *desc;
328 int r;
329
330 assert(u);
331 assert(path);
332
333 desc = path;
334
335 if (dev &&
336 (sd_device_get_property_value(dev, "ID_MODEL_FROM_DATABASE", &model) >= 0 ||
337 sd_device_get_property_value(dev, "ID_MODEL", &model) >= 0)) {
338 desc = model;
339
340 /* Try to concatenate the device model string with a label, if there is one */
341 if (sd_device_get_property_value(dev, "ID_FS_LABEL", &label) >= 0 ||
342 sd_device_get_property_value(dev, "ID_PART_ENTRY_NAME", &label) >= 0 ||
343 sd_device_get_property_value(dev, "ID_PART_ENTRY_NUMBER", &label) >= 0) {
344
345 desc = j = strjoin(model, " ", label);
346 if (!j)
347 return log_oom();
348 }
349 }
350
351 r = unit_set_description(u, desc);
352 if (r < 0)
353 return log_unit_error_errno(u, r, "Failed to set device description: %m");
354
355 return 0;
356 }
357
358 static int device_add_udev_wants(Unit *u, sd_device *dev) {
359 _cleanup_strv_free_ char **added = NULL;
360 const char *wants, *property;
361 Device *d = DEVICE(u);
362 int r;
363
364 assert(d);
365 assert(dev);
366
367 property = MANAGER_IS_USER(u->manager) ? "SYSTEMD_USER_WANTS" : "SYSTEMD_WANTS";
368
369 r = sd_device_get_property_value(dev, property, &wants);
370 if (r < 0)
371 return 0;
372
373 for (;;) {
374 _cleanup_free_ char *word = NULL, *k = NULL;
375
376 r = extract_first_word(&wants, &word, NULL, EXTRACT_QUOTES);
377 if (r == 0)
378 break;
379 if (r == -ENOMEM)
380 return log_oom();
381 if (r < 0)
382 return log_unit_error_errno(u, r, "Failed to parse property %s with value %s: %m", property, wants);
383
384 if (unit_name_is_valid(word, UNIT_NAME_TEMPLATE) && d->sysfs) {
385 _cleanup_free_ char *escaped = NULL;
386
387 /* If the unit name is specified as template, then automatically fill in the sysfs path of the
388 * device as instance name, properly escaped. */
389
390 r = unit_name_path_escape(d->sysfs, &escaped);
391 if (r < 0)
392 return log_unit_error_errno(u, r, "Failed to escape %s: %m", d->sysfs);
393
394 r = unit_name_replace_instance(word, escaped, &k);
395 if (r < 0)
396 return log_unit_error_errno(u, r, "Failed to build %s instance of template %s: %m", escaped, word);
397 } else {
398 /* If this is not a template, then let's mangle it so, that it becomes a valid unit name. */
399
400 r = unit_name_mangle(word, UNIT_NAME_MANGLE_WARN, &k);
401 if (r < 0)
402 return log_unit_error_errno(u, r, "Failed to mangle unit name \"%s\": %m", word);
403 }
404
405 r = unit_add_dependency_by_name(u, UNIT_WANTS, k, true, UNIT_DEPENDENCY_UDEV);
406 if (r < 0)
407 return log_unit_error_errno(u, r, "Failed to add Wants= dependency: %m");
408
409 r = strv_push(&added, k);
410 if (r < 0)
411 return log_oom();
412
413 k = NULL;
414 }
415
416 if (d->state != DEVICE_DEAD) {
417 char **i;
418
419 /* So here's a special hack, to compensate for the fact that the udev database's reload cycles are not
420 * synchronized with our own reload cycles: when we detect that the SYSTEMD_WANTS property of a device
421 * changes while the device unit is already up, let's manually trigger any new units listed in it not
422 * seen before. This typically appens during the boot-time switch root transition, as udev devices
423 * will generally already be up in the initrd, but SYSTEMD_WANTS properties get then added through udev
424 * rules only available on the host system, and thus only when the initial udev coldplug trigger runs.
425 *
426 * We do this only if the device has been up already when we parse this, as otherwise the usual
427 * dependency logic that is run from the dead → plugged transition will trigger these deps. */
428
429 STRV_FOREACH(i, added) {
430 _cleanup_(sd_bus_error_free) sd_bus_error error = SD_BUS_ERROR_NULL;
431
432 if (strv_contains(d->wants_property, *i)) /* Was this unit already listed before? */
433 continue;
434
435 r = manager_add_job_by_name(u->manager, JOB_START, *i, JOB_FAIL, &error, NULL);
436 if (r < 0)
437 log_unit_warning_errno(u, r, "Failed to enqueue SYSTEMD_WANTS= job, ignoring: %s", bus_error_message(&error, r));
438 }
439 }
440
441 strv_free(d->wants_property);
442 d->wants_property = TAKE_PTR(added);
443
444 return 0;
445 }
446
447 static bool device_is_bound_by_mounts(Device *d, sd_device *dev) {
448 const char *bound_by;
449 int r;
450
451 assert(d);
452 assert(dev);
453
454 if (sd_device_get_property_value(dev, "SYSTEMD_MOUNT_DEVICE_BOUND", &bound_by) >= 0) {
455 r = parse_boolean(bound_by);
456 if (r < 0)
457 log_device_warning_errno(dev, r, "Failed to parse SYSTEMD_MOUNT_DEVICE_BOUND='%s' udev property, ignoring: %m", bound_by);
458
459 d->bind_mounts = r > 0;
460 } else
461 d->bind_mounts = false;
462
463 return d->bind_mounts;
464 }
465
466 static void device_upgrade_mount_deps(Unit *u) {
467 Unit *other;
468 Iterator i;
469 void *v;
470 int r;
471
472 /* Let's upgrade Requires= to BindsTo= on us. (Used when SYSTEMD_MOUNT_DEVICE_BOUND is set) */
473
474 HASHMAP_FOREACH_KEY(v, other, u->dependencies[UNIT_REQUIRED_BY], i) {
475 if (other->type != UNIT_MOUNT)
476 continue;
477
478 r = unit_add_dependency(other, UNIT_BINDS_TO, u, true, UNIT_DEPENDENCY_UDEV);
479 if (r < 0)
480 log_unit_warning_errno(u, r, "Failed to add BindsTo= dependency between device and mount unit, ignoring: %m");
481 }
482 }
483
484 static int device_setup_unit(Manager *m, sd_device *dev, const char *path, bool main) {
485 _cleanup_free_ char *e = NULL;
486 const char *sysfs = NULL;
487 Unit *u = NULL;
488 bool delete;
489 int r;
490
491 assert(m);
492 assert(path);
493
494 if (dev) {
495 r = sd_device_get_syspath(dev, &sysfs);
496 if (r < 0) {
497 log_device_debug_errno(dev, r, "Couldn't get syspath from device, ignoring: %m");
498 return 0;
499 }
500 }
501
502 r = unit_name_from_path(path, ".device", &e);
503 if (r < 0)
504 return log_device_error_errno(dev, r, "Failed to generate unit name from device path: %m");
505
506 u = manager_get_unit(m, e);
507 if (u) {
508 /* The device unit can still be present even if the device was unplugged: a mount unit can reference it
509 * hence preventing the GC to have garbaged it. That's desired since the device unit may have a
510 * dependency on the mount unit which was added during the loading of the later. When the device is
511 * plugged the sysfs might not be initialized yet, as we serialize the device's state but do not
512 * serialize the sysfs path across reloads/reexecs. Hence, when coming back from a reload/restart we
513 * might have the state valid, but not the sysfs path. Hence, let's filter out conflicting devices, but
514 * let's accept devices in any state with no sysfs path set. */
515
516 if (DEVICE(u)->state == DEVICE_PLUGGED &&
517 DEVICE(u)->sysfs &&
518 sysfs &&
519 !path_equal(DEVICE(u)->sysfs, sysfs)) {
520 log_unit_debug(u, "Device %s appeared twice with different sysfs paths %s and %s, ignoring the latter.",
521 e, DEVICE(u)->sysfs, sysfs);
522 return -EEXIST;
523 }
524
525 delete = false;
526
527 /* Let's remove all dependencies generated due to udev properties. We'll readd whatever is configured
528 * now below. */
529 unit_remove_dependencies(u, UNIT_DEPENDENCY_UDEV);
530 } else {
531 delete = true;
532
533 r = unit_new_for_name(m, sizeof(Device), e, &u);
534 if (r < 0) {
535 log_device_error_errno(dev, r, "Failed to allocate device unit %s: %m", e);
536 goto fail;
537 }
538
539 unit_add_to_load_queue(u);
540 }
541
542 /* If this was created via some dependency and has not actually been seen yet ->sysfs will not be
543 * initialized. Hence initialize it if necessary. */
544 if (sysfs) {
545 r = device_set_sysfs(DEVICE(u), sysfs);
546 if (r < 0) {
547 log_unit_error_errno(u, r, "Failed to set sysfs path %s: %m", sysfs);
548 goto fail;
549 }
550
551 /* The additional systemd udev properties we only interpret for the main object */
552 if (main)
553 (void) device_add_udev_wants(u, dev);
554 }
555
556 (void) device_update_description(u, dev, path);
557
558 /* So the user wants the mount units to be bound to the device but a mount unit might has been seen by systemd
559 * before the device appears on its radar. In this case the device unit is partially initialized and includes
560 * the deps on the mount unit but at that time the "bind mounts" flag wasn't not present. Fix this up now. */
561 if (dev && device_is_bound_by_mounts(DEVICE(u), dev))
562 device_upgrade_mount_deps(u);
563
564 /* Note that this won't dispatch the load queue, the caller has to do that if needed and appropriate */
565 unit_add_to_dbus_queue(u);
566
567 return 0;
568
569 fail:
570 if (delete)
571 unit_free(u);
572
573 return r;
574 }
575
576 static int device_process_new(Manager *m, sd_device *dev) {
577 const char *sysfs, *dn, *alias;
578 dev_t devnum;
579 int r;
580
581 assert(m);
582
583 if (sd_device_get_syspath(dev, &sysfs) < 0)
584 return 0;
585
586 /* Add the main unit named after the sysfs path */
587 r = device_setup_unit(m, dev, sysfs, true);
588 if (r < 0)
589 return r;
590
591 /* Add an additional unit for the device node */
592 if (sd_device_get_devname(dev, &dn) >= 0)
593 (void) device_setup_unit(m, dev, dn, false);
594
595 /* Add additional units for all symlinks */
596 if (sd_device_get_devnum(dev, &devnum) >= 0) {
597 const char *p;
598
599 FOREACH_DEVICE_DEVLINK(dev, p) {
600 struct stat st;
601
602 if (PATH_STARTSWITH_SET(p, "/dev/block/", "/dev/char/"))
603 continue;
604
605 /* Verify that the symlink in the FS actually belongs
606 * to this device. This is useful to deal with
607 * conflicting devices, e.g. when two disks want the
608 * same /dev/disk/by-label/xxx link because they have
609 * the same label. We want to make sure that the same
610 * device that won the symlink wins in systemd, so we
611 * check the device node major/minor */
612 if (stat(p, &st) >= 0 &&
613 ((!S_ISBLK(st.st_mode) && !S_ISCHR(st.st_mode)) ||
614 st.st_rdev != devnum))
615 continue;
616
617 (void) device_setup_unit(m, dev, p, false);
618 }
619 }
620
621 /* Add additional units for all explicitly configured aliases */
622 if (sd_device_get_property_value(dev, "SYSTEMD_ALIAS", &alias) < 0)
623 return 0;
624
625 for (;;) {
626 _cleanup_free_ char *word = NULL;
627
628 r = extract_first_word(&alias, &word, NULL, EXTRACT_QUOTES);
629 if (r == 0)
630 break;
631 if (r == -ENOMEM)
632 return log_oom();
633 if (r < 0)
634 return log_device_warning_errno(dev, r, "Failed to parse SYSTEMD_ALIAS property: %m");
635
636 if (!path_is_absolute(word))
637 log_device_warning(dev, "SYSTEMD_ALIAS is not an absolute path, ignoring: %s", word);
638 else if (!path_is_normalized(word))
639 log_device_warning(dev, "SYSTEMD_ALIAS is not a normalized path, ignoring: %s", word);
640 else
641 (void) device_setup_unit(m, dev, word, false);
642 }
643
644 return 0;
645 }
646
647 static void device_found_changed(Device *d, DeviceFound previous, DeviceFound now) {
648 assert(d);
649
650 /* Didn't exist before, but does now? if so, generate a new invocation ID for it */
651 if (previous == DEVICE_NOT_FOUND && now != DEVICE_NOT_FOUND)
652 (void) unit_acquire_invocation_id(UNIT(d));
653
654 if (FLAGS_SET(now, DEVICE_FOUND_UDEV))
655 /* When the device is known to udev we consider it plugged. */
656 device_set_state(d, DEVICE_PLUGGED);
657 else if (now != DEVICE_NOT_FOUND && !FLAGS_SET(previous, DEVICE_FOUND_UDEV))
658 /* If the device has not been seen by udev yet, but is now referenced by the kernel, then we assume the
659 * kernel knows it now, and udev might soon too. */
660 device_set_state(d, DEVICE_TENTATIVE);
661 else
662 /* If nobody sees the device, or if the device was previously seen by udev and now is only referenced
663 * from the kernel, then we consider the device is gone, the kernel just hasn't noticed it yet. */
664 device_set_state(d, DEVICE_DEAD);
665 }
666
667 static void device_update_found_one(Device *d, DeviceFound found, DeviceFound mask) {
668 assert(d);
669
670 if (MANAGER_IS_RUNNING(UNIT(d)->manager)) {
671 DeviceFound n, previous;
672
673 /* When we are already running, then apply the new mask right-away, and trigger state changes
674 * right-away */
675
676 n = (d->found & ~mask) | (found & mask);
677 if (n == d->found)
678 return;
679
680 previous = d->found;
681 d->found = n;
682
683 device_found_changed(d, previous, n);
684 } else
685 /* We aren't running yet, let's apply the new mask to the shadow variable instead, which we'll apply as
686 * soon as we catch-up with the state. */
687 d->enumerated_found = (d->enumerated_found & ~mask) | (found & mask);
688 }
689
690 static void device_update_found_by_sysfs(Manager *m, const char *sysfs, DeviceFound found, DeviceFound mask) {
691 Device *d, *l, *n;
692
693 assert(m);
694 assert(sysfs);
695
696 if (mask == 0)
697 return;
698
699 l = hashmap_get(m->devices_by_sysfs, sysfs);
700 LIST_FOREACH_SAFE(same_sysfs, d, n, l)
701 device_update_found_one(d, found, mask);
702 }
703
704 static int device_update_found_by_name(Manager *m, const char *path, DeviceFound found, DeviceFound mask) {
705 _cleanup_free_ char *e = NULL;
706 Unit *u;
707 int r;
708
709 assert(m);
710 assert(path);
711
712 if (mask == 0)
713 return 0;
714
715 r = unit_name_from_path(path, ".device", &e);
716 if (r < 0)
717 return log_error_errno(r, "Failed to generate unit name from device path: %m");
718
719 u = manager_get_unit(m, e);
720 if (!u)
721 return 0;
722
723 device_update_found_one(DEVICE(u), found, mask);
724 return 0;
725 }
726
727 static bool device_is_ready(sd_device *dev) {
728 const char *ready;
729
730 assert(dev);
731
732 if (sd_device_get_property_value(dev, "SYSTEMD_READY", &ready) < 0)
733 return true;
734
735 return parse_boolean(ready) != 0;
736 }
737
738 static Unit *device_following(Unit *u) {
739 Device *d = DEVICE(u);
740 Device *other, *first = NULL;
741
742 assert(d);
743
744 if (startswith(u->id, "sys-"))
745 return NULL;
746
747 /* Make everybody follow the unit that's named after the sysfs path */
748 LIST_FOREACH_AFTER(same_sysfs, other, d)
749 if (startswith(UNIT(other)->id, "sys-"))
750 return UNIT(other);
751
752 LIST_FOREACH_BEFORE(same_sysfs, other, d) {
753 if (startswith(UNIT(other)->id, "sys-"))
754 return UNIT(other);
755
756 first = other;
757 }
758
759 return UNIT(first);
760 }
761
762 static int device_following_set(Unit *u, Set **_set) {
763 Device *d = DEVICE(u), *other;
764 _cleanup_set_free_ Set *set = NULL;
765 int r;
766
767 assert(d);
768 assert(_set);
769
770 if (LIST_JUST_US(same_sysfs, d)) {
771 *_set = NULL;
772 return 0;
773 }
774
775 set = set_new(NULL);
776 if (!set)
777 return -ENOMEM;
778
779 LIST_FOREACH_AFTER(same_sysfs, other, d) {
780 r = set_put(set, other);
781 if (r < 0)
782 return r;
783 }
784
785 LIST_FOREACH_BEFORE(same_sysfs, other, d) {
786 r = set_put(set, other);
787 if (r < 0)
788 return r;
789 }
790
791 *_set = TAKE_PTR(set);
792 return 1;
793 }
794
795 static void device_shutdown(Manager *m) {
796 assert(m);
797
798 m->device_monitor = sd_device_monitor_unref(m->device_monitor);
799 m->devices_by_sysfs = hashmap_free(m->devices_by_sysfs);
800 }
801
802 static void device_enumerate(Manager *m) {
803 _cleanup_(sd_device_enumerator_unrefp) sd_device_enumerator *e = NULL;
804 sd_device *dev;
805 int r;
806
807 assert(m);
808
809 if (!m->device_monitor) {
810 r = sd_device_monitor_new(&m->device_monitor);
811 if (r < 0) {
812 log_error_errno(r, "Failed to allocate device monitor: %m");
813 goto fail;
814 }
815
816 /* This will fail if we are unprivileged, but that
817 * should not matter much, as user instances won't run
818 * during boot. */
819 (void) sd_device_monitor_set_receive_buffer_size(m->device_monitor, 128*1024*1024);
820
821 r = sd_device_monitor_filter_add_match_tag(m->device_monitor, "systemd");
822 if (r < 0) {
823 log_error_errno(r, "Failed to add udev tag match: %m");
824 goto fail;
825 }
826
827 r = sd_device_monitor_attach_event(m->device_monitor, m->event);
828 if (r < 0) {
829 log_error_errno(r, "Failed to attach event to device monitor: %m");
830 goto fail;
831 }
832
833 r = sd_device_monitor_start(m->device_monitor, device_dispatch_io, m);
834 if (r < 0) {
835 log_error_errno(r, "Failed to start device monitor: %m");
836 goto fail;
837 }
838 }
839
840 r = sd_device_enumerator_new(&e);
841 if (r < 0) {
842 log_error_errno(r, "Failed to allocate device enumerator: %m");
843 goto fail;
844 }
845
846 r = sd_device_enumerator_add_match_tag(e, "systemd");
847 if (r < 0) {
848 log_error_errno(r, "Failed to set tag for device enumeration: %m");
849 goto fail;
850 }
851
852 FOREACH_DEVICE(e, dev) {
853 const char *sysfs;
854
855 if (!device_is_ready(dev))
856 continue;
857
858 (void) device_process_new(m, dev);
859
860 if (sd_device_get_syspath(dev, &sysfs) < 0)
861 continue;
862
863 device_update_found_by_sysfs(m, sysfs, DEVICE_FOUND_UDEV, DEVICE_FOUND_UDEV);
864 }
865
866 return;
867
868 fail:
869 device_shutdown(m);
870 }
871
872 static void device_propagate_reload_by_sysfs(Manager *m, const char *sysfs) {
873 Device *d, *l, *n;
874 int r;
875
876 assert(m);
877 assert(sysfs);
878
879 l = hashmap_get(m->devices_by_sysfs, sysfs);
880 LIST_FOREACH_SAFE(same_sysfs, d, n, l) {
881 if (d->state == DEVICE_DEAD)
882 continue;
883
884 r = manager_propagate_reload(m, UNIT(d), JOB_REPLACE, NULL);
885 if (r < 0)
886 log_warning_errno(r, "Failed to propagate reload, ignoring: %m");
887 }
888 }
889
890 static int device_dispatch_io(sd_device_monitor *monitor, sd_device *dev, void *userdata) {
891 Manager *m = userdata;
892 const char *action, *sysfs;
893 int r;
894
895 assert(m);
896 assert(dev);
897
898 r = sd_device_get_syspath(dev, &sysfs);
899 if (r < 0) {
900 log_device_error_errno(dev, r, "Failed to get device sys path: %m");
901 return 0;
902 }
903
904 r = sd_device_get_property_value(dev, "ACTION", &action);
905 if (r < 0) {
906 log_device_error_errno(dev, r, "Failed to get udev action string: %m");
907 return 0;
908 }
909
910 if (streq(action, "change"))
911 device_propagate_reload_by_sysfs(m, sysfs);
912
913 /* A change event can signal that a device is becoming ready, in particular if
914 * the device is using the SYSTEMD_READY logic in udev
915 * so we need to reach the else block of the follwing if, even for change events */
916 if (streq(action, "remove")) {
917 r = swap_process_device_remove(m, dev);
918 if (r < 0)
919 log_device_warning_errno(dev, r, "Failed to process swap device remove event, ignoring: %m");
920
921 /* If we get notified that a device was removed by
922 * udev, then it's completely gone, hence unset all
923 * found bits */
924 device_update_found_by_sysfs(m, sysfs, 0, DEVICE_FOUND_UDEV|DEVICE_FOUND_MOUNT|DEVICE_FOUND_SWAP);
925
926 } else if (device_is_ready(dev)) {
927
928 (void) device_process_new(m, dev);
929
930 r = swap_process_device_new(m, dev);
931 if (r < 0)
932 log_device_warning_errno(dev, r, "Failed to process swap device new event, ignoring: %m");
933
934 manager_dispatch_load_queue(m);
935
936 /* The device is found now, set the udev found bit */
937 device_update_found_by_sysfs(m, sysfs, DEVICE_FOUND_UDEV, DEVICE_FOUND_UDEV);
938
939 } else {
940 /* The device is nominally around, but not ready for
941 * us. Hence unset the udev bit, but leave the rest
942 * around. */
943
944 device_update_found_by_sysfs(m, sysfs, 0, DEVICE_FOUND_UDEV);
945 }
946
947 return 0;
948 }
949
950 static bool device_supported(void) {
951 static int read_only = -1;
952
953 /* If /sys is read-only we don't support device units, and any
954 * attempts to start one should fail immediately. */
955
956 if (read_only < 0)
957 read_only = path_is_read_only_fs("/sys");
958
959 return read_only <= 0;
960 }
961
962 static int validate_node(Manager *m, const char *node, sd_device **ret) {
963 struct stat st;
964 int r;
965
966 assert(m);
967 assert(node);
968 assert(ret);
969
970 /* Validates a device node that showed up in /proc/swaps or /proc/self/mountinfo if it makes sense for us to
971 * track. Note that this validator is fine within missing device nodes, but not with badly set up ones! */
972
973 if (!path_startswith(node, "/dev")) {
974 *ret = NULL;
975 return 0; /* bad! */
976 }
977
978 if (stat(node, &st) < 0) {
979 if (errno != ENOENT)
980 return log_error_errno(errno, "Failed to stat() device node file %s: %m", node);
981
982 *ret = NULL;
983 return 1; /* good! (though missing) */
984
985 } else {
986 _cleanup_(sd_device_unrefp) sd_device *dev = NULL;
987
988 r = device_new_from_stat_rdev(&dev, &st);
989 if (r == -ENOENT) {
990 *ret = NULL;
991 return 1; /* good! (though missing) */
992 } else if (r == -ENOTTY) {
993 *ret = NULL;
994 return 0; /* bad! (not a device node but some other kind of file system node) */
995 } else if (r < 0)
996 return log_error_errno(r, "Failed to get udev device from devnum %u:%u: %m", major(st.st_rdev), minor(st.st_rdev));
997
998 *ret = TAKE_PTR(dev);
999 return 1; /* good! */
1000 }
1001 }
1002
1003 void device_found_node(Manager *m, const char *node, DeviceFound found, DeviceFound mask) {
1004 int r;
1005
1006 assert(m);
1007 assert(node);
1008
1009 if (!device_supported())
1010 return;
1011
1012 if (mask == 0)
1013 return;
1014
1015 /* This is called whenever we find a device referenced in /proc/swaps or /proc/self/mounts. Such a device might
1016 * be mounted/enabled at a time where udev has not finished probing it yet, and we thus haven't learned about
1017 * it yet. In this case we will set the device unit to "tentative" state.
1018 *
1019 * This takes a pair of DeviceFound flags parameters. The 'mask' parameter is a bit mask that indicates which
1020 * bits of 'found' to copy into the per-device DeviceFound flags field. Thus, this function may be used to set
1021 * and unset individual bits in a single call, while merging partially with previous state. */
1022
1023 if ((found & mask) != 0) {
1024 _cleanup_(sd_device_unrefp) sd_device *dev = NULL;
1025
1026 /* If the device is known in the kernel and newly appeared, then we'll create a device unit for it,
1027 * under the name referenced in /proc/swaps or /proc/self/mountinfo. But first, let's validate if
1028 * everything is alright with the device node. */
1029
1030 r = validate_node(m, node, &dev);
1031 if (r <= 0)
1032 return; /* Don't create a device unit for this if the device node is borked. */
1033
1034 (void) device_setup_unit(m, dev, node, false);
1035 }
1036
1037 /* Update the device unit's state, should it exist */
1038 (void) device_update_found_by_name(m, node, found, mask);
1039 }
1040
1041 bool device_shall_be_bound_by(Unit *device, Unit *u) {
1042 assert(device);
1043 assert(u);
1044
1045 if (u->type != UNIT_MOUNT)
1046 return false;
1047
1048 return DEVICE(device)->bind_mounts;
1049 }
1050
1051 const UnitVTable device_vtable = {
1052 .object_size = sizeof(Device),
1053 .sections =
1054 "Unit\0"
1055 "Device\0"
1056 "Install\0",
1057
1058 .gc_jobs = true,
1059
1060 .init = device_init,
1061 .done = device_done,
1062 .load = device_load,
1063
1064 .coldplug = device_coldplug,
1065 .catchup = device_catchup,
1066
1067 .serialize = device_serialize,
1068 .deserialize_item = device_deserialize_item,
1069
1070 .dump = device_dump,
1071
1072 .active_state = device_active_state,
1073 .sub_state_to_string = device_sub_state_to_string,
1074
1075 .bus_vtable = bus_device_vtable,
1076
1077 .following = device_following,
1078 .following_set = device_following_set,
1079
1080 .enumerate = device_enumerate,
1081 .shutdown = device_shutdown,
1082 .supported = device_supported,
1083
1084 .status_message_formats = {
1085 .starting_stopping = {
1086 [0] = "Expecting device %s...",
1087 },
1088 .finished_start_job = {
1089 [JOB_DONE] = "Found device %s.",
1090 [JOB_TIMEOUT] = "Timed out waiting for device %s.",
1091 },
1092 },
1093 };