2 This file is part of systemd.
4 Copyright 2010 Lennart Poettering
6 systemd is free software; you can redistribute it and/or modify it
7 under the terms of the GNU Lesser General Public License as published by
8 the Free Software Foundation; either version 2.1 of the License, or
9 (at your option) any later version.
11 systemd is distributed in the hope that it will be useful, but
12 WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 Lesser General Public License for more details.
16 You should have received a copy of the GNU Lesser General Public License
17 along with systemd; If not, see <http://www.gnu.org/licenses/>.
21 #include <sys/epoll.h>
25 #include "alloc-util.h"
26 #include "dbus-device.h"
29 #include "parse-util.h"
30 #include "path-util.h"
31 #include "stat-util.h"
32 #include "string-util.h"
34 #include "udev-util.h"
35 #include "unit-name.h"
38 static const UnitActiveState state_translation_table
[_DEVICE_STATE_MAX
] = {
39 [DEVICE_DEAD
] = UNIT_INACTIVE
,
40 [DEVICE_TENTATIVE
] = UNIT_ACTIVATING
,
41 [DEVICE_PLUGGED
] = UNIT_ACTIVE
,
44 static int device_dispatch_io(sd_event_source
*source
, int fd
, uint32_t revents
, void *userdata
);
46 static void device_unset_sysfs(Device
*d
) {
55 /* Remove this unit from the chain of devices which share the
57 devices
= UNIT(d
)->manager
->devices_by_sysfs
;
58 first
= hashmap_get(devices
, d
->sysfs
);
59 LIST_REMOVE(same_sysfs
, first
, d
);
62 hashmap_remove_and_replace(devices
, d
->sysfs
, first
->sysfs
, first
);
64 hashmap_remove(devices
, d
->sysfs
);
66 d
->sysfs
= mfree(d
->sysfs
);
69 static int device_set_sysfs(Device
*d
, const char *sysfs
) {
76 if (streq_ptr(d
->sysfs
, sysfs
))
79 r
= hashmap_ensure_allocated(&UNIT(d
)->manager
->devices_by_sysfs
, &string_hash_ops
);
87 device_unset_sysfs(d
);
89 first
= hashmap_get(UNIT(d
)->manager
->devices_by_sysfs
, sysfs
);
90 LIST_PREPEND(same_sysfs
, first
, d
);
92 r
= hashmap_replace(UNIT(d
)->manager
->devices_by_sysfs
, copy
, first
);
94 LIST_REMOVE(same_sysfs
, first
, d
);
104 static void device_init(Unit
*u
) {
105 Device
*d
= DEVICE(u
);
108 assert(UNIT(d
)->load_state
== UNIT_STUB
);
110 /* In contrast to all other unit types we timeout jobs waiting
111 * for devices by default. This is because they otherwise wait
112 * indefinitely for plugged in devices, something which cannot
113 * happen for the other units since their operations time out
115 u
->job_running_timeout
= u
->manager
->default_timeout_start_usec
;
117 u
->ignore_on_isolate
= true;
120 static void device_done(Unit
*u
) {
121 Device
*d
= DEVICE(u
);
125 device_unset_sysfs(d
);
128 static void device_set_state(Device
*d
, DeviceState state
) {
129 DeviceState old_state
;
132 old_state
= d
->state
;
135 if (state
!= old_state
)
136 log_unit_debug(UNIT(d
), "Changed %s -> %s", device_state_to_string(old_state
), device_state_to_string(state
));
138 unit_notify(UNIT(d
), state_translation_table
[old_state
], state_translation_table
[state
], true);
141 static int device_coldplug(Unit
*u
) {
142 Device
*d
= DEVICE(u
);
145 assert(d
->state
== DEVICE_DEAD
);
147 if (d
->found
& DEVICE_FOUND_UDEV
)
148 /* If udev says the device is around, it's around */
149 device_set_state(d
, DEVICE_PLUGGED
);
150 else if (d
->found
!= DEVICE_NOT_FOUND
&& d
->deserialized_state
!= DEVICE_PLUGGED
)
151 /* If a device is found in /proc/self/mountinfo or
152 * /proc/swaps, and was not yet announced via udev,
153 * it's "tentatively" around. */
154 device_set_state(d
, DEVICE_TENTATIVE
);
159 static int device_serialize(Unit
*u
, FILE *f
, FDSet
*fds
) {
160 Device
*d
= DEVICE(u
);
166 unit_serialize_item(u
, f
, "state", device_state_to_string(d
->state
));
171 static int device_deserialize_item(Unit
*u
, const char *key
, const char *value
, FDSet
*fds
) {
172 Device
*d
= DEVICE(u
);
179 if (streq(key
, "state")) {
182 state
= device_state_from_string(value
);
184 log_unit_debug(u
, "Failed to parse state value: %s", value
);
186 d
->deserialized_state
= state
;
188 log_unit_debug(u
, "Unknown serialization key: %s", key
);
193 static void device_dump(Unit
*u
, FILE *f
, const char *prefix
) {
194 Device
*d
= DEVICE(u
);
199 "%sDevice State: %s\n"
200 "%sSysfs Path: %s\n",
201 prefix
, device_state_to_string(d
->state
),
202 prefix
, strna(d
->sysfs
));
205 _pure_
static UnitActiveState
device_active_state(Unit
*u
) {
208 return state_translation_table
[DEVICE(u
)->state
];
211 _pure_
static const char *device_sub_state_to_string(Unit
*u
) {
214 return device_state_to_string(DEVICE(u
)->state
);
217 static int device_update_description(Unit
*u
, struct udev_device
*dev
, const char *path
) {
225 model
= udev_device_get_property_value(dev
, "ID_MODEL_FROM_DATABASE");
227 model
= udev_device_get_property_value(dev
, "ID_MODEL");
232 /* Try to concatenate the device model string with a label, if there is one */
233 label
= udev_device_get_property_value(dev
, "ID_FS_LABEL");
235 label
= udev_device_get_property_value(dev
, "ID_PART_ENTRY_NAME");
237 label
= udev_device_get_property_value(dev
, "ID_PART_ENTRY_NUMBER");
240 _cleanup_free_
char *j
;
242 j
= strjoin(model
, " ", label
);
244 r
= unit_set_description(u
, j
);
248 r
= unit_set_description(u
, model
);
250 r
= unit_set_description(u
, path
);
253 log_unit_error_errno(u
, r
, "Failed to set device description: %m");
258 static int device_add_udev_wants(Unit
*u
, struct udev_device
*dev
) {
259 const char *wants
, *property
, *p
;
265 property
= MANAGER_IS_USER(u
->manager
) ? "SYSTEMD_USER_WANTS" : "SYSTEMD_WANTS";
266 wants
= udev_device_get_property_value(dev
, property
);
268 _cleanup_free_
char *word
= NULL
, *k
= NULL
;
270 r
= extract_first_word(&p
, &word
, NULL
, EXTRACT_QUOTES
);
276 return log_unit_error_errno(u
, r
, "Failed to add parse %s: %m", property
);
278 r
= unit_name_mangle(word
, UNIT_NAME_NOGLOB
, &k
);
280 return log_unit_error_errno(u
, r
, "Failed to mangle unit name \"%s\": %m", word
);
282 r
= unit_add_dependency_by_name(u
, UNIT_WANTS
, k
, NULL
, true);
284 return log_unit_error_errno(u
, r
, "Failed to add wants dependency: %m");
288 static bool device_is_bound_by_mounts(Unit
*d
, struct udev_device
*dev
) {
289 const char *bound_by
;
295 bound_by
= udev_device_get_property_value(dev
, "SYSTEMD_MOUNT_DEVICE_BOUND");
297 r
= parse_boolean(bound_by
) > 0;
299 DEVICE(d
)->bind_mounts
= r
;
303 static int device_upgrade_mount_deps(Unit
*u
) {
308 SET_FOREACH(other
, u
->dependencies
[UNIT_REQUIRED_BY
], i
) {
309 if (other
->type
!= UNIT_MOUNT
)
312 r
= unit_add_dependency(other
, UNIT_BINDS_TO
, u
, true);
319 static int device_setup_unit(Manager
*m
, struct udev_device
*dev
, const char *path
, bool main
) {
320 _cleanup_free_
char *e
= NULL
;
321 const char *sysfs
= NULL
;
330 sysfs
= udev_device_get_syspath(dev
);
335 r
= unit_name_from_path(path
, ".device", &e
);
337 return log_error_errno(r
, "Failed to generate unit name from device path: %m");
339 u
= manager_get_unit(m
, e
);
341 /* The device unit can still be present even if the device was
342 * unplugged: a mount unit can reference it hence preventing
343 * the GC to have garbaged it. That's desired since the device
344 * unit may have a dependency on the mount unit which was
345 * added during the loading of the later. */
346 if (dev
&& u
&& DEVICE(u
)->state
== DEVICE_PLUGGED
) {
347 /* This unit is in plugged state: we're sure it's
348 * attached to a device. */
349 if (!path_equal(DEVICE(u
)->sysfs
, sysfs
)) {
350 log_unit_debug(u
, "Dev %s appeared twice with different sysfs paths %s and %s",
351 e
, DEVICE(u
)->sysfs
, sysfs
);
359 r
= unit_new_for_name(m
, sizeof(Device
), e
, &u
);
363 unit_add_to_load_queue(u
);
367 /* If this was created via some dependency and has not
368 * actually been seen yet ->sysfs will not be
369 * initialized. Hence initialize it if necessary. */
371 r
= device_set_sysfs(DEVICE(u
), sysfs
);
375 (void) device_update_description(u
, dev
, path
);
377 /* The additional systemd udev properties we only interpret
378 * for the main object */
380 (void) device_add_udev_wants(u
, dev
);
383 /* So the user wants the mount units to be bound to the device but a
384 * mount unit might has been seen by systemd before the device appears
385 * on its radar. In this case the device unit is partially initialized
386 * and includes the deps on the mount unit but at that time the "bind
387 * mounts" flag wasn't not present. Fix this up now. */
388 if (dev
&& device_is_bound_by_mounts(u
, dev
))
389 device_upgrade_mount_deps(u
);
391 /* Note that this won't dispatch the load queue, the caller
392 * has to do that if needed and appropriate */
394 unit_add_to_dbus_queue(u
);
398 log_unit_warning_errno(u
, r
, "Failed to set up device unit: %m");
406 static int device_process_new(Manager
*m
, struct udev_device
*dev
) {
407 const char *sysfs
, *dn
, *alias
;
408 struct udev_list_entry
*item
= NULL
, *first
= NULL
;
413 sysfs
= udev_device_get_syspath(dev
);
417 /* Add the main unit named after the sysfs path */
418 r
= device_setup_unit(m
, dev
, sysfs
, true);
422 /* Add an additional unit for the device node */
423 dn
= udev_device_get_devnode(dev
);
425 (void) device_setup_unit(m
, dev
, dn
, false);
427 /* Add additional units for all symlinks */
428 first
= udev_device_get_devlinks_list_entry(dev
);
429 udev_list_entry_foreach(item
, first
) {
433 /* Don't bother with the /dev/block links */
434 p
= udev_list_entry_get_name(item
);
436 if (path_startswith(p
, "/dev/block/") ||
437 path_startswith(p
, "/dev/char/"))
440 /* Verify that the symlink in the FS actually belongs
441 * to this device. This is useful to deal with
442 * conflicting devices, e.g. when two disks want the
443 * same /dev/disk/by-label/xxx link because they have
444 * the same label. We want to make sure that the same
445 * device that won the symlink wins in systemd, so we
446 * check the device node major/minor */
447 if (stat(p
, &st
) >= 0)
448 if ((!S_ISBLK(st
.st_mode
) && !S_ISCHR(st
.st_mode
)) ||
449 st
.st_rdev
!= udev_device_get_devnum(dev
))
452 (void) device_setup_unit(m
, dev
, p
, false);
455 /* Add additional units for all explicitly configured
457 alias
= udev_device_get_property_value(dev
, "SYSTEMD_ALIAS");
459 _cleanup_free_
char *word
= NULL
;
461 r
= extract_first_word(&alias
, &word
, NULL
, EXTRACT_QUOTES
);
467 return log_warning_errno(r
, "Failed to add parse SYSTEMD_ALIAS for %s: %m", sysfs
);
469 if (path_is_absolute(word
))
470 (void) device_setup_unit(m
, dev
, word
, false);
472 log_warning("SYSTEMD_ALIAS for %s is not an absolute path, ignoring: %s", sysfs
, word
);
476 static void device_update_found_one(Device
*d
, bool add
, DeviceFound found
, bool now
) {
477 DeviceFound n
, previous
;
481 n
= add
? (d
->found
| found
) : (d
->found
& ~found
);
491 /* Didn't exist before, but does now? if so, generate a new invocation ID for it */
492 if (previous
== DEVICE_NOT_FOUND
&& d
->found
!= DEVICE_NOT_FOUND
)
493 (void) unit_acquire_invocation_id(UNIT(d
));
495 if (d
->found
& DEVICE_FOUND_UDEV
)
496 /* When the device is known to udev we consider it
498 device_set_state(d
, DEVICE_PLUGGED
);
499 else if (d
->found
!= DEVICE_NOT_FOUND
&& (previous
& DEVICE_FOUND_UDEV
) == 0)
500 /* If the device has not been seen by udev yet, but is
501 * now referenced by the kernel, then we assume the
502 * kernel knows it now, and udev might soon too. */
503 device_set_state(d
, DEVICE_TENTATIVE
);
505 /* If nobody sees the device, or if the device was
506 * previously seen by udev and now is only referenced
507 * from the kernel, then we consider the device is
508 * gone, the kernel just hasn't noticed it yet. */
510 device_set_state(d
, DEVICE_DEAD
);
511 device_unset_sysfs(d
);
516 static int device_update_found_by_sysfs(Manager
*m
, const char *sysfs
, bool add
, DeviceFound found
, bool now
) {
522 if (found
== DEVICE_NOT_FOUND
)
525 l
= hashmap_get(m
->devices_by_sysfs
, sysfs
);
526 LIST_FOREACH_SAFE(same_sysfs
, d
, n
, l
)
527 device_update_found_one(d
, add
, found
, now
);
532 static int device_update_found_by_name(Manager
*m
, const char *path
, bool add
, DeviceFound found
, bool now
) {
533 _cleanup_free_
char *e
= NULL
;
540 if (found
== DEVICE_NOT_FOUND
)
543 r
= unit_name_from_path(path
, ".device", &e
);
545 return log_error_errno(r
, "Failed to generate unit name from device path: %m");
547 u
= manager_get_unit(m
, e
);
551 device_update_found_one(DEVICE(u
), add
, found
, now
);
555 static bool device_is_ready(struct udev_device
*dev
) {
560 ready
= udev_device_get_property_value(dev
, "SYSTEMD_READY");
564 return parse_boolean(ready
) != 0;
567 static Unit
*device_following(Unit
*u
) {
568 Device
*d
= DEVICE(u
);
569 Device
*other
, *first
= NULL
;
573 if (startswith(u
->id
, "sys-"))
576 /* Make everybody follow the unit that's named after the sysfs path */
577 for (other
= d
->same_sysfs_next
; other
; other
= other
->same_sysfs_next
)
578 if (startswith(UNIT(other
)->id
, "sys-"))
581 for (other
= d
->same_sysfs_prev
; other
; other
= other
->same_sysfs_prev
) {
582 if (startswith(UNIT(other
)->id
, "sys-"))
591 static int device_following_set(Unit
*u
, Set
**_set
) {
592 Device
*d
= DEVICE(u
), *other
;
599 if (LIST_JUST_US(same_sysfs
, d
)) {
608 LIST_FOREACH_AFTER(same_sysfs
, other
, d
) {
609 r
= set_put(set
, other
);
614 LIST_FOREACH_BEFORE(same_sysfs
, other
, d
) {
615 r
= set_put(set
, other
);
628 static void device_shutdown(Manager
*m
) {
631 m
->udev_event_source
= sd_event_source_unref(m
->udev_event_source
);
633 if (m
->udev_monitor
) {
634 udev_monitor_unref(m
->udev_monitor
);
635 m
->udev_monitor
= NULL
;
638 m
->devices_by_sysfs
= hashmap_free(m
->devices_by_sysfs
);
641 static void device_enumerate(Manager
*m
) {
642 _cleanup_udev_enumerate_unref_
struct udev_enumerate
*e
= NULL
;
643 struct udev_list_entry
*item
= NULL
, *first
= NULL
;
648 if (!m
->udev_monitor
) {
649 m
->udev_monitor
= udev_monitor_new_from_netlink(m
->udev
, "udev");
650 if (!m
->udev_monitor
) {
655 /* This will fail if we are unprivileged, but that
656 * should not matter much, as user instances won't run
658 (void) udev_monitor_set_receive_buffer_size(m
->udev_monitor
, 128*1024*1024);
660 r
= udev_monitor_filter_add_match_tag(m
->udev_monitor
, "systemd");
662 log_error_errno(r
, "Failed to add udev tag match: %m");
666 r
= udev_monitor_enable_receiving(m
->udev_monitor
);
668 log_error_errno(r
, "Failed to enable udev event reception: %m");
672 r
= sd_event_add_io(m
->event
, &m
->udev_event_source
, udev_monitor_get_fd(m
->udev_monitor
), EPOLLIN
, device_dispatch_io
, m
);
674 log_error_errno(r
, "Failed to watch udev file descriptor: %m");
678 (void) sd_event_source_set_description(m
->udev_event_source
, "device");
681 e
= udev_enumerate_new(m
->udev
);
687 r
= udev_enumerate_add_match_tag(e
, "systemd");
689 log_error_errno(r
, "Failed to create udev tag enumeration: %m");
693 r
= udev_enumerate_add_match_is_initialized(e
);
695 log_error_errno(r
, "Failed to install initialization match into enumeration: %m");
699 r
= udev_enumerate_scan_devices(e
);
701 log_error_errno(r
, "Failed to enumerate devices: %m");
705 first
= udev_enumerate_get_list_entry(e
);
706 udev_list_entry_foreach(item
, first
) {
707 _cleanup_udev_device_unref_
struct udev_device
*dev
= NULL
;
710 sysfs
= udev_list_entry_get_name(item
);
712 dev
= udev_device_new_from_syspath(m
->udev
, sysfs
);
718 if (!device_is_ready(dev
))
721 (void) device_process_new(m
, dev
);
723 device_update_found_by_sysfs(m
, sysfs
, true, DEVICE_FOUND_UDEV
, false);
732 static int device_dispatch_io(sd_event_source
*source
, int fd
, uint32_t revents
, void *userdata
) {
733 _cleanup_udev_device_unref_
struct udev_device
*dev
= NULL
;
734 Manager
*m
= userdata
;
735 const char *action
, *sysfs
;
740 if (revents
!= EPOLLIN
) {
741 static RATELIMIT_DEFINE(limit
, 10*USEC_PER_SEC
, 5);
743 if (!ratelimit_test(&limit
))
744 log_error_errno(errno
, "Failed to get udev event: %m");
745 if (!(revents
& EPOLLIN
))
750 * libudev might filter-out devices which pass the bloom
751 * filter, so getting NULL here is not necessarily an error.
753 dev
= udev_monitor_receive_device(m
->udev_monitor
);
757 sysfs
= udev_device_get_syspath(dev
);
759 log_error("Failed to get udev sys path.");
763 action
= udev_device_get_action(dev
);
765 log_error("Failed to get udev action string.");
769 if (streq(action
, "remove")) {
770 r
= swap_process_device_remove(m
, dev
);
772 log_error_errno(r
, "Failed to process swap device remove event: %m");
774 /* If we get notified that a device was removed by
775 * udev, then it's completely gone, hence unset all
777 device_update_found_by_sysfs(m
, sysfs
, false, DEVICE_FOUND_UDEV
|DEVICE_FOUND_MOUNT
|DEVICE_FOUND_SWAP
, true);
779 } else if (device_is_ready(dev
)) {
781 (void) device_process_new(m
, dev
);
783 r
= swap_process_device_new(m
, dev
);
785 log_error_errno(r
, "Failed to process swap device new event: %m");
787 manager_dispatch_load_queue(m
);
789 /* The device is found now, set the udev found bit */
790 device_update_found_by_sysfs(m
, sysfs
, true, DEVICE_FOUND_UDEV
, true);
793 /* The device is nominally around, but not ready for
794 * us. Hence unset the udev bit, but leave the rest
797 device_update_found_by_sysfs(m
, sysfs
, false, DEVICE_FOUND_UDEV
, true);
803 static bool device_supported(void) {
804 static int read_only
= -1;
806 /* If /sys is read-only we don't support device units, and any
807 * attempts to start one should fail immediately. */
810 read_only
= path_is_read_only_fs("/sys");
812 return read_only
<= 0;
815 int device_found_node(Manager
*m
, const char *node
, bool add
, DeviceFound found
, bool now
) {
816 _cleanup_udev_device_unref_
struct udev_device
*dev
= NULL
;
822 if (!device_supported())
825 /* This is called whenever we find a device referenced in
826 * /proc/swaps or /proc/self/mounts. Such a device might be
827 * mounted/enabled at a time where udev has not finished
828 * probing it yet, and we thus haven't learned about it
829 * yet. In this case we will set the device unit to
830 * "tentative" state. */
833 if (!path_startswith(node
, "/dev"))
836 /* We make an extra check here, if the device node
837 * actually exists. If it's missing, then this is an
838 * indication that device was unplugged but is still
839 * referenced in /proc/swaps or
840 * /proc/self/mountinfo. Note that this check doesn't
841 * really cover all cases where a device might be gone
842 * away, since drives that can have a medium inserted
843 * will still have a device node even when the medium
846 if (stat(node
, &st
) >= 0) {
847 if (!S_ISBLK(st
.st_mode
) && !S_ISCHR(st
.st_mode
))
850 dev
= udev_device_new_from_devnum(m
->udev
, S_ISBLK(st
.st_mode
) ? 'b' : 'c', st
.st_rdev
);
851 if (!dev
&& errno
!= ENOENT
)
852 return log_error_errno(errno
, "Failed to get udev device from devnum %u:%u: %m", major(st
.st_rdev
), minor(st
.st_rdev
));
854 } else if (errno
!= ENOENT
)
855 return log_error_errno(errno
, "Failed to stat device node file %s: %m", node
);
857 /* If the device is known in the kernel and newly
858 * appeared, then we'll create a device unit for it,
859 * under the name referenced in /proc/swaps or
860 * /proc/self/mountinfo. */
862 (void) device_setup_unit(m
, dev
, node
, false);
865 /* Update the device unit's state, should it exist */
866 return device_update_found_by_name(m
, node
, add
, found
, now
);
869 bool device_shall_be_bound_by(Unit
*device
, Unit
*u
) {
871 if (u
->type
!= UNIT_MOUNT
)
874 return DEVICE(device
)->bind_mounts
;
877 const UnitVTable device_vtable
= {
878 .object_size
= sizeof(Device
),
888 .load
= unit_load_fragment_and_dropin_optional
,
890 .coldplug
= device_coldplug
,
892 .serialize
= device_serialize
,
893 .deserialize_item
= device_deserialize_item
,
897 .active_state
= device_active_state
,
898 .sub_state_to_string
= device_sub_state_to_string
,
900 .bus_vtable
= bus_device_vtable
,
902 .following
= device_following
,
903 .following_set
= device_following_set
,
905 .enumerate
= device_enumerate
,
906 .shutdown
= device_shutdown
,
907 .supported
= device_supported
,
909 .status_message_formats
= {
910 .starting_stopping
= {
911 [0] = "Expecting device %s...",
913 .finished_start_job
= {
914 [JOB_DONE
] = "Found device %s.",
915 [JOB_TIMEOUT
] = "Timed out waiting for device %s.",