1 /*-*- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil -*-*/
4 This file is part of systemd.
6 Copyright 2010 Lennart Poettering
8 systemd is free software; you can redistribute it and/or modify it
9 under the terms of the GNU Lesser General Public License as published by
10 the Free Software Foundation; either version 2.1 of the License, or
11 (at your option) any later version.
13 systemd is distributed in the hope that it will be useful, but
14 WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 Lesser General Public License for more details.
18 You should have received a copy of the GNU Lesser General Public License
19 along with systemd; If not, see <http://www.gnu.org/licenses/>.
23 #include <sys/epoll.h>
27 #include "alloc-util.h"
28 #include "dbus-device.h"
31 #include "parse-util.h"
32 #include "path-util.h"
33 #include "stat-util.h"
34 #include "string-util.h"
36 #include "udev-util.h"
37 #include "unit-name.h"
40 static const UnitActiveState state_translation_table
[_DEVICE_STATE_MAX
] = {
41 [DEVICE_DEAD
] = UNIT_INACTIVE
,
42 [DEVICE_TENTATIVE
] = UNIT_ACTIVATING
,
43 [DEVICE_PLUGGED
] = UNIT_ACTIVE
,
46 static int device_dispatch_io(sd_event_source
*source
, int fd
, uint32_t revents
, void *userdata
);
48 static void device_unset_sysfs(Device
*d
) {
57 /* Remove this unit from the chain of devices which share the
59 devices
= UNIT(d
)->manager
->devices_by_sysfs
;
60 first
= hashmap_get(devices
, d
->sysfs
);
61 LIST_REMOVE(same_sysfs
, first
, d
);
64 hashmap_remove_and_replace(devices
, d
->sysfs
, first
->sysfs
, first
);
66 hashmap_remove(devices
, d
->sysfs
);
68 d
->sysfs
= mfree(d
->sysfs
);
71 static int device_set_sysfs(Device
*d
, const char *sysfs
) {
78 if (streq_ptr(d
->sysfs
, sysfs
))
81 r
= hashmap_ensure_allocated(&UNIT(d
)->manager
->devices_by_sysfs
, &string_hash_ops
);
89 device_unset_sysfs(d
);
91 first
= hashmap_get(UNIT(d
)->manager
->devices_by_sysfs
, sysfs
);
92 LIST_PREPEND(same_sysfs
, first
, d
);
94 r
= hashmap_replace(UNIT(d
)->manager
->devices_by_sysfs
, copy
, first
);
96 LIST_REMOVE(same_sysfs
, first
, d
);
106 static void device_init(Unit
*u
) {
107 Device
*d
= DEVICE(u
);
110 assert(UNIT(d
)->load_state
== UNIT_STUB
);
112 /* In contrast to all other unit types we timeout jobs waiting
113 * for devices by default. This is because they otherwise wait
114 * indefinitely for plugged in devices, something which cannot
115 * happen for the other units since their operations time out
117 u
->job_timeout
= u
->manager
->default_timeout_start_usec
;
119 u
->ignore_on_isolate
= true;
120 u
->ignore_on_snapshot
= true;
123 static void device_done(Unit
*u
) {
124 Device
*d
= DEVICE(u
);
128 device_unset_sysfs(d
);
131 static void device_set_state(Device
*d
, DeviceState state
) {
132 DeviceState old_state
;
135 old_state
= d
->state
;
138 if (state
!= old_state
)
139 log_unit_debug(UNIT(d
), "Changed %s -> %s", device_state_to_string(old_state
), device_state_to_string(state
));
141 unit_notify(UNIT(d
), state_translation_table
[old_state
], state_translation_table
[state
], true);
144 static int device_coldplug(Unit
*u
) {
145 Device
*d
= DEVICE(u
);
148 assert(d
->state
== DEVICE_DEAD
);
150 if (d
->found
& DEVICE_FOUND_UDEV
)
151 /* If udev says the device is around, it's around */
152 device_set_state(d
, DEVICE_PLUGGED
);
153 else if (d
->found
!= DEVICE_NOT_FOUND
&& d
->deserialized_state
!= DEVICE_PLUGGED
)
154 /* If a device is found in /proc/self/mountinfo or
155 * /proc/swaps, and was not yet announced via udev,
156 * it's "tentatively" around. */
157 device_set_state(d
, DEVICE_TENTATIVE
);
162 static int device_serialize(Unit
*u
, FILE *f
, FDSet
*fds
) {
163 Device
*d
= DEVICE(u
);
169 unit_serialize_item(u
, f
, "state", device_state_to_string(d
->state
));
174 static int device_deserialize_item(Unit
*u
, const char *key
, const char *value
, FDSet
*fds
) {
175 Device
*d
= DEVICE(u
);
182 if (streq(key
, "state")) {
185 state
= device_state_from_string(value
);
187 log_unit_debug(u
, "Failed to parse state value: %s", value
);
189 d
->deserialized_state
= state
;
191 log_unit_debug(u
, "Unknown serialization key: %s", key
);
196 static void device_dump(Unit
*u
, FILE *f
, const char *prefix
) {
197 Device
*d
= DEVICE(u
);
202 "%sDevice State: %s\n"
203 "%sSysfs Path: %s\n",
204 prefix
, device_state_to_string(d
->state
),
205 prefix
, strna(d
->sysfs
));
208 _pure_
static UnitActiveState
device_active_state(Unit
*u
) {
211 return state_translation_table
[DEVICE(u
)->state
];
214 _pure_
static const char *device_sub_state_to_string(Unit
*u
) {
217 return device_state_to_string(DEVICE(u
)->state
);
220 static int device_update_description(Unit
*u
, struct udev_device
*dev
, const char *path
) {
228 model
= udev_device_get_property_value(dev
, "ID_MODEL_FROM_DATABASE");
230 model
= udev_device_get_property_value(dev
, "ID_MODEL");
235 /* Try to concatenate the device model string with a label, if there is one */
236 label
= udev_device_get_property_value(dev
, "ID_FS_LABEL");
238 label
= udev_device_get_property_value(dev
, "ID_PART_ENTRY_NAME");
240 label
= udev_device_get_property_value(dev
, "ID_PART_ENTRY_NUMBER");
243 _cleanup_free_
char *j
;
245 j
= strjoin(model
, " ", label
, NULL
);
247 r
= unit_set_description(u
, j
);
251 r
= unit_set_description(u
, model
);
253 r
= unit_set_description(u
, path
);
256 log_unit_error_errno(u
, r
, "Failed to set device description: %m");
261 static int device_add_udev_wants(Unit
*u
, struct udev_device
*dev
) {
263 const char *word
, *state
;
266 const char *property
;
271 property
= u
->manager
->running_as
== MANAGER_USER
? "MANAGER_USER_WANTS" : "SYSTEMD_WANTS";
272 wants
= udev_device_get_property_value(dev
, property
);
276 FOREACH_WORD_QUOTED(word
, l
, wants
, state
) {
277 _cleanup_free_
char *n
= NULL
;
283 r
= unit_name_mangle(e
, UNIT_NAME_NOGLOB
, &n
);
285 return log_unit_error_errno(u
, r
, "Failed to mangle unit name: %m");
287 r
= unit_add_dependency_by_name(u
, UNIT_WANTS
, n
, NULL
, true);
289 return log_unit_error_errno(u
, r
, "Failed to add wants dependency: %m");
292 log_unit_warning(u
, "Property %s on %s has trailing garbage, ignoring.", property
, strna(udev_device_get_syspath(dev
)));
297 static int device_setup_unit(Manager
*m
, struct udev_device
*dev
, const char *path
, bool main
) {
298 _cleanup_free_
char *e
= NULL
;
299 const char *sysfs
= NULL
;
308 sysfs
= udev_device_get_syspath(dev
);
313 r
= unit_name_from_path(path
, ".device", &e
);
315 return log_error_errno(r
, "Failed to generate unit name from device path: %m");
317 u
= manager_get_unit(m
, e
);
322 !path_equal(DEVICE(u
)->sysfs
, sysfs
)) {
323 log_unit_debug(u
, "Device %s appeared twice with different sysfs paths %s and %s", e
, DEVICE(u
)->sysfs
, sysfs
);
330 u
= unit_new(m
, sizeof(Device
));
334 r
= unit_add_name(u
, e
);
338 unit_add_to_load_queue(u
);
342 /* If this was created via some dependency and has not
343 * actually been seen yet ->sysfs will not be
344 * initialized. Hence initialize it if necessary. */
346 r
= device_set_sysfs(DEVICE(u
), sysfs
);
350 (void) device_update_description(u
, dev
, path
);
352 /* The additional systemd udev properties we only interpret
353 * for the main object */
355 (void) device_add_udev_wants(u
, dev
);
359 /* Note that this won't dispatch the load queue, the caller
360 * has to do that if needed and appropriate */
362 unit_add_to_dbus_queue(u
);
366 log_unit_warning_errno(u
, r
, "Failed to set up device unit: %m");
374 static int device_process_new(Manager
*m
, struct udev_device
*dev
) {
375 const char *sysfs
, *dn
, *alias
;
376 struct udev_list_entry
*item
= NULL
, *first
= NULL
;
381 sysfs
= udev_device_get_syspath(dev
);
385 /* Add the main unit named after the sysfs path */
386 r
= device_setup_unit(m
, dev
, sysfs
, true);
390 /* Add an additional unit for the device node */
391 dn
= udev_device_get_devnode(dev
);
393 (void) device_setup_unit(m
, dev
, dn
, false);
395 /* Add additional units for all symlinks */
396 first
= udev_device_get_devlinks_list_entry(dev
);
397 udev_list_entry_foreach(item
, first
) {
401 /* Don't bother with the /dev/block links */
402 p
= udev_list_entry_get_name(item
);
404 if (path_startswith(p
, "/dev/block/") ||
405 path_startswith(p
, "/dev/char/"))
408 /* Verify that the symlink in the FS actually belongs
409 * to this device. This is useful to deal with
410 * conflicting devices, e.g. when two disks want the
411 * same /dev/disk/by-label/xxx link because they have
412 * the same label. We want to make sure that the same
413 * device that won the symlink wins in systemd, so we
414 * check the device node major/minor */
415 if (stat(p
, &st
) >= 0)
416 if ((!S_ISBLK(st
.st_mode
) && !S_ISCHR(st
.st_mode
)) ||
417 st
.st_rdev
!= udev_device_get_devnum(dev
))
420 (void) device_setup_unit(m
, dev
, p
, false);
423 /* Add additional units for all explicitly configured
425 alias
= udev_device_get_property_value(dev
, "SYSTEMD_ALIAS");
427 const char *word
, *state
;
430 FOREACH_WORD_QUOTED(word
, l
, alias
, state
) {
436 if (path_is_absolute(e
))
437 (void) device_setup_unit(m
, dev
, e
, false);
439 log_warning("SYSTEMD_ALIAS for %s is not an absolute path, ignoring: %s", sysfs
, e
);
442 log_warning("SYSTEMD_ALIAS for %s has trailing garbage, ignoring.", sysfs
);
448 static void device_update_found_one(Device
*d
, bool add
, DeviceFound found
, bool now
) {
449 DeviceFound n
, previous
;
453 n
= add
? (d
->found
| found
) : (d
->found
& ~found
);
463 if (d
->found
& DEVICE_FOUND_UDEV
)
464 /* When the device is known to udev we consider it
466 device_set_state(d
, DEVICE_PLUGGED
);
467 else if (d
->found
!= DEVICE_NOT_FOUND
&& (previous
& DEVICE_FOUND_UDEV
) == 0)
468 /* If the device has not been seen by udev yet, but is
469 * now referenced by the kernel, then we assume the
470 * kernel knows it now, and udev might soon too. */
471 device_set_state(d
, DEVICE_TENTATIVE
);
473 /* If nobody sees the device, or if the device was
474 * previously seen by udev and now is only referenced
475 * from the kernel, then we consider the device is
476 * gone, the kernel just hasn't noticed it yet. */
477 device_set_state(d
, DEVICE_DEAD
);
480 static int device_update_found_by_sysfs(Manager
*m
, const char *sysfs
, bool add
, DeviceFound found
, bool now
) {
486 if (found
== DEVICE_NOT_FOUND
)
489 l
= hashmap_get(m
->devices_by_sysfs
, sysfs
);
490 LIST_FOREACH(same_sysfs
, d
, l
)
491 device_update_found_one(d
, add
, found
, now
);
496 static int device_update_found_by_name(Manager
*m
, const char *path
, bool add
, DeviceFound found
, bool now
) {
497 _cleanup_free_
char *e
= NULL
;
504 if (found
== DEVICE_NOT_FOUND
)
507 r
= unit_name_from_path(path
, ".device", &e
);
509 return log_error_errno(r
, "Failed to generate unit name from device path: %m");
511 u
= manager_get_unit(m
, e
);
515 device_update_found_one(DEVICE(u
), add
, found
, now
);
519 static bool device_is_ready(struct udev_device
*dev
) {
524 ready
= udev_device_get_property_value(dev
, "SYSTEMD_READY");
528 return parse_boolean(ready
) != 0;
531 static Unit
*device_following(Unit
*u
) {
532 Device
*d
= DEVICE(u
);
533 Device
*other
, *first
= NULL
;
537 if (startswith(u
->id
, "sys-"))
540 /* Make everybody follow the unit that's named after the sysfs path */
541 for (other
= d
->same_sysfs_next
; other
; other
= other
->same_sysfs_next
)
542 if (startswith(UNIT(other
)->id
, "sys-"))
545 for (other
= d
->same_sysfs_prev
; other
; other
= other
->same_sysfs_prev
) {
546 if (startswith(UNIT(other
)->id
, "sys-"))
555 static int device_following_set(Unit
*u
, Set
**_set
) {
556 Device
*d
= DEVICE(u
), *other
;
563 if (LIST_JUST_US(same_sysfs
, d
)) {
572 LIST_FOREACH_AFTER(same_sysfs
, other
, d
) {
573 r
= set_put(set
, other
);
578 LIST_FOREACH_BEFORE(same_sysfs
, other
, d
) {
579 r
= set_put(set
, other
);
592 static void device_shutdown(Manager
*m
) {
595 m
->udev_event_source
= sd_event_source_unref(m
->udev_event_source
);
597 if (m
->udev_monitor
) {
598 udev_monitor_unref(m
->udev_monitor
);
599 m
->udev_monitor
= NULL
;
602 m
->devices_by_sysfs
= hashmap_free(m
->devices_by_sysfs
);
605 static int device_enumerate(Manager
*m
) {
606 _cleanup_udev_enumerate_unref_
struct udev_enumerate
*e
= NULL
;
607 struct udev_list_entry
*item
= NULL
, *first
= NULL
;
612 if (!m
->udev_monitor
) {
613 m
->udev_monitor
= udev_monitor_new_from_netlink(m
->udev
, "udev");
614 if (!m
->udev_monitor
) {
619 /* This will fail if we are unprivileged, but that
620 * should not matter much, as user instances won't run
622 (void) udev_monitor_set_receive_buffer_size(m
->udev_monitor
, 128*1024*1024);
624 r
= udev_monitor_filter_add_match_tag(m
->udev_monitor
, "systemd");
628 r
= udev_monitor_enable_receiving(m
->udev_monitor
);
632 r
= sd_event_add_io(m
->event
, &m
->udev_event_source
, udev_monitor_get_fd(m
->udev_monitor
), EPOLLIN
, device_dispatch_io
, m
);
636 (void) sd_event_source_set_description(m
->udev_event_source
, "device");
639 e
= udev_enumerate_new(m
->udev
);
645 r
= udev_enumerate_add_match_tag(e
, "systemd");
649 r
= udev_enumerate_add_match_is_initialized(e
);
653 r
= udev_enumerate_scan_devices(e
);
657 first
= udev_enumerate_get_list_entry(e
);
658 udev_list_entry_foreach(item
, first
) {
659 _cleanup_udev_device_unref_
struct udev_device
*dev
= NULL
;
662 sysfs
= udev_list_entry_get_name(item
);
664 dev
= udev_device_new_from_syspath(m
->udev
, sysfs
);
670 if (!device_is_ready(dev
))
673 (void) device_process_new(m
, dev
);
675 device_update_found_by_sysfs(m
, sysfs
, true, DEVICE_FOUND_UDEV
, false);
681 log_error_errno(r
, "Failed to enumerate devices: %m");
687 static int device_dispatch_io(sd_event_source
*source
, int fd
, uint32_t revents
, void *userdata
) {
688 _cleanup_udev_device_unref_
struct udev_device
*dev
= NULL
;
689 Manager
*m
= userdata
;
690 const char *action
, *sysfs
;
695 if (revents
!= EPOLLIN
) {
696 static RATELIMIT_DEFINE(limit
, 10*USEC_PER_SEC
, 5);
698 if (!ratelimit_test(&limit
))
699 log_error_errno(errno
, "Failed to get udev event: %m");
700 if (!(revents
& EPOLLIN
))
705 * libudev might filter-out devices which pass the bloom
706 * filter, so getting NULL here is not necessarily an error.
708 dev
= udev_monitor_receive_device(m
->udev_monitor
);
712 sysfs
= udev_device_get_syspath(dev
);
714 log_error("Failed to get udev sys path.");
718 action
= udev_device_get_action(dev
);
720 log_error("Failed to get udev action string.");
724 if (streq(action
, "remove")) {
725 r
= swap_process_device_remove(m
, dev
);
727 log_error_errno(r
, "Failed to process swap device remove event: %m");
729 /* If we get notified that a device was removed by
730 * udev, then it's completely gone, hence unset all
732 device_update_found_by_sysfs(m
, sysfs
, false, DEVICE_FOUND_UDEV
|DEVICE_FOUND_MOUNT
|DEVICE_FOUND_SWAP
, true);
734 } else if (device_is_ready(dev
)) {
736 (void) device_process_new(m
, dev
);
738 r
= swap_process_device_new(m
, dev
);
740 log_error_errno(r
, "Failed to process swap device new event: %m");
742 manager_dispatch_load_queue(m
);
744 /* The device is found now, set the udev found bit */
745 device_update_found_by_sysfs(m
, sysfs
, true, DEVICE_FOUND_UDEV
, true);
748 /* The device is nominally around, but not ready for
749 * us. Hence unset the udev bit, but leave the rest
752 device_update_found_by_sysfs(m
, sysfs
, false, DEVICE_FOUND_UDEV
, true);
758 static bool device_supported(void) {
759 static int read_only
= -1;
761 /* If /sys is read-only we don't support device units, and any
762 * attempts to start one should fail immediately. */
765 read_only
= path_is_read_only_fs("/sys");
767 return read_only
<= 0;
770 int device_found_node(Manager
*m
, const char *node
, bool add
, DeviceFound found
, bool now
) {
771 _cleanup_udev_device_unref_
struct udev_device
*dev
= NULL
;
777 if (!device_supported())
780 /* This is called whenever we find a device referenced in
781 * /proc/swaps or /proc/self/mounts. Such a device might be
782 * mounted/enabled at a time where udev has not finished
783 * probing it yet, and we thus haven't learned about it
784 * yet. In this case we will set the device unit to
785 * "tentative" state. */
788 if (!path_startswith(node
, "/dev"))
791 /* We make an extra check here, if the device node
792 * actually exists. If it's missing, then this is an
793 * indication that device was unplugged but is still
794 * referenced in /proc/swaps or
795 * /proc/self/mountinfo. Note that this check doesn't
796 * really cover all cases where a device might be gone
797 * away, since drives that can have a medium inserted
798 * will still have a device node even when the medium
801 if (stat(node
, &st
) >= 0) {
802 if (!S_ISBLK(st
.st_mode
) && !S_ISCHR(st
.st_mode
))
805 dev
= udev_device_new_from_devnum(m
->udev
, S_ISBLK(st
.st_mode
) ? 'b' : 'c', st
.st_rdev
);
806 if (!dev
&& errno
!= ENOENT
)
807 return log_error_errno(errno
, "Failed to get udev device from devnum %u:%u: %m", major(st
.st_rdev
), minor(st
.st_rdev
));
809 } else if (errno
!= ENOENT
)
810 return log_error_errno(errno
, "Failed to stat device node file %s: %m", node
);
812 /* If the device is known in the kernel and newly
813 * appeared, then we'll create a device unit for it,
814 * under the name referenced in /proc/swaps or
815 * /proc/self/mountinfo. */
817 (void) device_setup_unit(m
, dev
, node
, false);
820 /* Update the device unit's state, should it exist */
821 return device_update_found_by_name(m
, node
, add
, found
, now
);
824 const UnitVTable device_vtable
= {
825 .object_size
= sizeof(Device
),
831 .no_instances
= true,
835 .load
= unit_load_fragment_and_dropin_optional
,
837 .coldplug
= device_coldplug
,
839 .serialize
= device_serialize
,
840 .deserialize_item
= device_deserialize_item
,
844 .active_state
= device_active_state
,
845 .sub_state_to_string
= device_sub_state_to_string
,
847 .bus_vtable
= bus_device_vtable
,
849 .following
= device_following
,
850 .following_set
= device_following_set
,
852 .enumerate
= device_enumerate
,
853 .shutdown
= device_shutdown
,
854 .supported
= device_supported
,
856 .status_message_formats
= {
857 .starting_stopping
= {
858 [0] = "Expecting device %s...",
860 .finished_start_job
= {
861 [JOB_DONE
] = "Found device %s.",
862 [JOB_TIMEOUT
] = "Timed out waiting for device %s.",