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 "dbus-device.h"
29 #include "path-util.h"
30 #include "string-util.h"
32 #include "udev-util.h"
33 #include "unit-name.h"
37 static const UnitActiveState state_translation_table
[_DEVICE_STATE_MAX
] = {
38 [DEVICE_DEAD
] = UNIT_INACTIVE
,
39 [DEVICE_TENTATIVE
] = UNIT_ACTIVATING
,
40 [DEVICE_PLUGGED
] = UNIT_ACTIVE
,
43 static int device_dispatch_io(sd_event_source
*source
, int fd
, uint32_t revents
, void *userdata
);
45 static void device_unset_sysfs(Device
*d
) {
54 /* Remove this unit from the chain of devices which share the
56 devices
= UNIT(d
)->manager
->devices_by_sysfs
;
57 first
= hashmap_get(devices
, d
->sysfs
);
58 LIST_REMOVE(same_sysfs
, first
, d
);
61 hashmap_remove_and_replace(devices
, d
->sysfs
, first
->sysfs
, first
);
63 hashmap_remove(devices
, d
->sysfs
);
65 d
->sysfs
= mfree(d
->sysfs
);
68 static int device_set_sysfs(Device
*d
, const char *sysfs
) {
75 if (streq_ptr(d
->sysfs
, sysfs
))
78 r
= hashmap_ensure_allocated(&UNIT(d
)->manager
->devices_by_sysfs
, &string_hash_ops
);
86 device_unset_sysfs(d
);
88 first
= hashmap_get(UNIT(d
)->manager
->devices_by_sysfs
, sysfs
);
89 LIST_PREPEND(same_sysfs
, first
, d
);
91 r
= hashmap_replace(UNIT(d
)->manager
->devices_by_sysfs
, copy
, first
);
93 LIST_REMOVE(same_sysfs
, first
, d
);
103 static void device_init(Unit
*u
) {
104 Device
*d
= DEVICE(u
);
107 assert(UNIT(d
)->load_state
== UNIT_STUB
);
109 /* In contrast to all other unit types we timeout jobs waiting
110 * for devices by default. This is because they otherwise wait
111 * indefinitely for plugged in devices, something which cannot
112 * happen for the other units since their operations time out
114 u
->job_timeout
= u
->manager
->default_timeout_start_usec
;
116 u
->ignore_on_isolate
= true;
117 u
->ignore_on_snapshot
= 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
, NULL
);
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
) {
260 const char *word
, *state
;
263 const char *property
;
268 property
= u
->manager
->running_as
== MANAGER_USER
? "MANAGER_USER_WANTS" : "SYSTEMD_WANTS";
269 wants
= udev_device_get_property_value(dev
, property
);
273 FOREACH_WORD_QUOTED(word
, l
, wants
, state
) {
274 _cleanup_free_
char *n
= NULL
;
280 r
= unit_name_mangle(e
, UNIT_NAME_NOGLOB
, &n
);
282 return log_unit_error_errno(u
, r
, "Failed to mangle unit name: %m");
284 r
= unit_add_dependency_by_name(u
, UNIT_WANTS
, n
, NULL
, true);
286 return log_unit_error_errno(u
, r
, "Failed to add wants dependency: %m");
289 log_unit_warning(u
, "Property %s on %s has trailing garbage, ignoring.", property
, strna(udev_device_get_syspath(dev
)));
294 static int device_setup_unit(Manager
*m
, struct udev_device
*dev
, const char *path
, bool main
) {
295 _cleanup_free_
char *e
= NULL
;
296 const char *sysfs
= NULL
;
305 sysfs
= udev_device_get_syspath(dev
);
310 r
= unit_name_from_path(path
, ".device", &e
);
312 return log_error_errno(r
, "Failed to generate unit name from device path: %m");
314 u
= manager_get_unit(m
, e
);
319 !path_equal(DEVICE(u
)->sysfs
, sysfs
)) {
320 log_unit_debug(u
, "Device %s appeared twice with different sysfs paths %s and %s", e
, DEVICE(u
)->sysfs
, sysfs
);
327 u
= unit_new(m
, sizeof(Device
));
331 r
= unit_add_name(u
, e
);
335 unit_add_to_load_queue(u
);
339 /* If this was created via some dependency and has not
340 * actually been seen yet ->sysfs will not be
341 * initialized. Hence initialize it if necessary. */
343 r
= device_set_sysfs(DEVICE(u
), sysfs
);
347 (void) device_update_description(u
, dev
, path
);
349 /* The additional systemd udev properties we only interpret
350 * for the main object */
352 (void) device_add_udev_wants(u
, dev
);
356 /* Note that this won't dispatch the load queue, the caller
357 * has to do that if needed and appropriate */
359 unit_add_to_dbus_queue(u
);
363 log_unit_warning_errno(u
, r
, "Failed to set up device unit: %m");
371 static int device_process_new(Manager
*m
, struct udev_device
*dev
) {
372 const char *sysfs
, *dn
, *alias
;
373 struct udev_list_entry
*item
= NULL
, *first
= NULL
;
378 sysfs
= udev_device_get_syspath(dev
);
382 /* Add the main unit named after the sysfs path */
383 r
= device_setup_unit(m
, dev
, sysfs
, true);
387 /* Add an additional unit for the device node */
388 dn
= udev_device_get_devnode(dev
);
390 (void) device_setup_unit(m
, dev
, dn
, false);
392 /* Add additional units for all symlinks */
393 first
= udev_device_get_devlinks_list_entry(dev
);
394 udev_list_entry_foreach(item
, first
) {
398 /* Don't bother with the /dev/block links */
399 p
= udev_list_entry_get_name(item
);
401 if (path_startswith(p
, "/dev/block/") ||
402 path_startswith(p
, "/dev/char/"))
405 /* Verify that the symlink in the FS actually belongs
406 * to this device. This is useful to deal with
407 * conflicting devices, e.g. when two disks want the
408 * same /dev/disk/by-label/xxx link because they have
409 * the same label. We want to make sure that the same
410 * device that won the symlink wins in systemd, so we
411 * check the device node major/minor */
412 if (stat(p
, &st
) >= 0)
413 if ((!S_ISBLK(st
.st_mode
) && !S_ISCHR(st
.st_mode
)) ||
414 st
.st_rdev
!= udev_device_get_devnum(dev
))
417 (void) device_setup_unit(m
, dev
, p
, false);
420 /* Add additional units for all explicitly configured
422 alias
= udev_device_get_property_value(dev
, "SYSTEMD_ALIAS");
424 const char *word
, *state
;
427 FOREACH_WORD_QUOTED(word
, l
, alias
, state
) {
433 if (path_is_absolute(e
))
434 (void) device_setup_unit(m
, dev
, e
, false);
436 log_warning("SYSTEMD_ALIAS for %s is not an absolute path, ignoring: %s", sysfs
, e
);
439 log_warning("SYSTEMD_ALIAS for %s has trailing garbage, ignoring.", sysfs
);
445 static void device_update_found_one(Device
*d
, bool add
, DeviceFound found
, bool now
) {
446 DeviceFound n
, previous
;
450 n
= add
? (d
->found
| found
) : (d
->found
& ~found
);
460 if (d
->found
& DEVICE_FOUND_UDEV
)
461 /* When the device is known to udev we consider it
463 device_set_state(d
, DEVICE_PLUGGED
);
464 else if (d
->found
!= DEVICE_NOT_FOUND
&& (previous
& DEVICE_FOUND_UDEV
) == 0)
465 /* If the device has not been seen by udev yet, but is
466 * now referenced by the kernel, then we assume the
467 * kernel knows it now, and udev might soon too. */
468 device_set_state(d
, DEVICE_TENTATIVE
);
470 /* If nobody sees the device, or if the device was
471 * previously seen by udev and now is only referenced
472 * from the kernel, then we consider the device is
473 * gone, the kernel just hasn't noticed it yet. */
474 device_set_state(d
, DEVICE_DEAD
);
477 static int device_update_found_by_sysfs(Manager
*m
, const char *sysfs
, bool add
, DeviceFound found
, bool now
) {
483 if (found
== DEVICE_NOT_FOUND
)
486 l
= hashmap_get(m
->devices_by_sysfs
, sysfs
);
487 LIST_FOREACH(same_sysfs
, d
, l
)
488 device_update_found_one(d
, add
, found
, now
);
493 static int device_update_found_by_name(Manager
*m
, const char *path
, bool add
, DeviceFound found
, bool now
) {
494 _cleanup_free_
char *e
= NULL
;
501 if (found
== DEVICE_NOT_FOUND
)
504 r
= unit_name_from_path(path
, ".device", &e
);
506 return log_error_errno(r
, "Failed to generate unit name from device path: %m");
508 u
= manager_get_unit(m
, e
);
512 device_update_found_one(DEVICE(u
), add
, found
, now
);
516 static bool device_is_ready(struct udev_device
*dev
) {
521 ready
= udev_device_get_property_value(dev
, "SYSTEMD_READY");
525 return parse_boolean(ready
) != 0;
528 static Unit
*device_following(Unit
*u
) {
529 Device
*d
= DEVICE(u
);
530 Device
*other
, *first
= NULL
;
534 if (startswith(u
->id
, "sys-"))
537 /* Make everybody follow the unit that's named after the sysfs path */
538 for (other
= d
->same_sysfs_next
; other
; other
= other
->same_sysfs_next
)
539 if (startswith(UNIT(other
)->id
, "sys-"))
542 for (other
= d
->same_sysfs_prev
; other
; other
= other
->same_sysfs_prev
) {
543 if (startswith(UNIT(other
)->id
, "sys-"))
552 static int device_following_set(Unit
*u
, Set
**_set
) {
553 Device
*d
= DEVICE(u
), *other
;
560 if (LIST_JUST_US(same_sysfs
, d
)) {
569 LIST_FOREACH_AFTER(same_sysfs
, other
, d
) {
570 r
= set_put(set
, other
);
575 LIST_FOREACH_BEFORE(same_sysfs
, other
, d
) {
576 r
= set_put(set
, other
);
589 static void device_shutdown(Manager
*m
) {
592 m
->udev_event_source
= sd_event_source_unref(m
->udev_event_source
);
594 if (m
->udev_monitor
) {
595 udev_monitor_unref(m
->udev_monitor
);
596 m
->udev_monitor
= NULL
;
599 m
->devices_by_sysfs
= hashmap_free(m
->devices_by_sysfs
);
602 static int device_enumerate(Manager
*m
) {
603 _cleanup_udev_enumerate_unref_
struct udev_enumerate
*e
= NULL
;
604 struct udev_list_entry
*item
= NULL
, *first
= NULL
;
609 if (!m
->udev_monitor
) {
610 m
->udev_monitor
= udev_monitor_new_from_netlink(m
->udev
, "udev");
611 if (!m
->udev_monitor
) {
616 /* This will fail if we are unprivileged, but that
617 * should not matter much, as user instances won't run
619 (void) udev_monitor_set_receive_buffer_size(m
->udev_monitor
, 128*1024*1024);
621 r
= udev_monitor_filter_add_match_tag(m
->udev_monitor
, "systemd");
625 r
= udev_monitor_enable_receiving(m
->udev_monitor
);
629 r
= sd_event_add_io(m
->event
, &m
->udev_event_source
, udev_monitor_get_fd(m
->udev_monitor
), EPOLLIN
, device_dispatch_io
, m
);
633 (void) sd_event_source_set_description(m
->udev_event_source
, "device");
636 e
= udev_enumerate_new(m
->udev
);
642 r
= udev_enumerate_add_match_tag(e
, "systemd");
646 r
= udev_enumerate_add_match_is_initialized(e
);
650 r
= udev_enumerate_scan_devices(e
);
654 first
= udev_enumerate_get_list_entry(e
);
655 udev_list_entry_foreach(item
, first
) {
656 _cleanup_udev_device_unref_
struct udev_device
*dev
= NULL
;
659 sysfs
= udev_list_entry_get_name(item
);
661 dev
= udev_device_new_from_syspath(m
->udev
, sysfs
);
667 if (!device_is_ready(dev
))
670 (void) device_process_new(m
, dev
);
672 device_update_found_by_sysfs(m
, sysfs
, true, DEVICE_FOUND_UDEV
, false);
678 log_error_errno(r
, "Failed to enumerate devices: %m");
684 static int device_dispatch_io(sd_event_source
*source
, int fd
, uint32_t revents
, void *userdata
) {
685 _cleanup_udev_device_unref_
struct udev_device
*dev
= NULL
;
686 Manager
*m
= userdata
;
687 const char *action
, *sysfs
;
692 if (revents
!= EPOLLIN
) {
693 static RATELIMIT_DEFINE(limit
, 10*USEC_PER_SEC
, 5);
695 if (!ratelimit_test(&limit
))
696 log_error_errno(errno
, "Failed to get udev event: %m");
697 if (!(revents
& EPOLLIN
))
702 * libudev might filter-out devices which pass the bloom
703 * filter, so getting NULL here is not necessarily an error.
705 dev
= udev_monitor_receive_device(m
->udev_monitor
);
709 sysfs
= udev_device_get_syspath(dev
);
711 log_error("Failed to get udev sys path.");
715 action
= udev_device_get_action(dev
);
717 log_error("Failed to get udev action string.");
721 if (streq(action
, "remove")) {
722 r
= swap_process_device_remove(m
, dev
);
724 log_error_errno(r
, "Failed to process swap device remove event: %m");
726 /* If we get notified that a device was removed by
727 * udev, then it's completely gone, hence unset all
729 device_update_found_by_sysfs(m
, sysfs
, false, DEVICE_FOUND_UDEV
|DEVICE_FOUND_MOUNT
|DEVICE_FOUND_SWAP
, true);
731 } else if (device_is_ready(dev
)) {
733 (void) device_process_new(m
, dev
);
735 r
= swap_process_device_new(m
, dev
);
737 log_error_errno(r
, "Failed to process swap device new event: %m");
739 manager_dispatch_load_queue(m
);
741 /* The device is found now, set the udev found bit */
742 device_update_found_by_sysfs(m
, sysfs
, true, DEVICE_FOUND_UDEV
, true);
745 /* The device is nominally around, but not ready for
746 * us. Hence unset the udev bit, but leave the rest
749 device_update_found_by_sysfs(m
, sysfs
, false, DEVICE_FOUND_UDEV
, true);
755 static bool device_supported(void) {
756 static int read_only
= -1;
758 /* If /sys is read-only we don't support device units, and any
759 * attempts to start one should fail immediately. */
762 read_only
= path_is_read_only_fs("/sys");
764 return read_only
<= 0;
767 int device_found_node(Manager
*m
, const char *node
, bool add
, DeviceFound found
, bool now
) {
768 _cleanup_udev_device_unref_
struct udev_device
*dev
= NULL
;
774 if (!device_supported())
777 /* This is called whenever we find a device referenced in
778 * /proc/swaps or /proc/self/mounts. Such a device might be
779 * mounted/enabled at a time where udev has not finished
780 * probing it yet, and we thus haven't learned about it
781 * yet. In this case we will set the device unit to
782 * "tentative" state. */
785 if (!path_startswith(node
, "/dev"))
788 /* We make an extra check here, if the device node
789 * actually exists. If it's missing, then this is an
790 * indication that device was unplugged but is still
791 * referenced in /proc/swaps or
792 * /proc/self/mountinfo. Note that this check doesn't
793 * really cover all cases where a device might be gone
794 * away, since drives that can have a medium inserted
795 * will still have a device node even when the medium
798 if (stat(node
, &st
) >= 0) {
799 if (!S_ISBLK(st
.st_mode
) && !S_ISCHR(st
.st_mode
))
802 dev
= udev_device_new_from_devnum(m
->udev
, S_ISBLK(st
.st_mode
) ? 'b' : 'c', st
.st_rdev
);
803 if (!dev
&& errno
!= ENOENT
)
804 return log_error_errno(errno
, "Failed to get udev device from devnum %u:%u: %m", major(st
.st_rdev
), minor(st
.st_rdev
));
806 } else if (errno
!= ENOENT
)
807 return log_error_errno(errno
, "Failed to stat device node file %s: %m", node
);
809 /* If the device is known in the kernel and newly
810 * appeared, then we'll create a device unit for it,
811 * under the name referenced in /proc/swaps or
812 * /proc/self/mountinfo. */
814 (void) device_setup_unit(m
, dev
, node
, false);
817 /* Update the device unit's state, should it exist */
818 return device_update_found_by_name(m
, node
, add
, found
, now
);
821 const UnitVTable device_vtable
= {
822 .object_size
= sizeof(Device
),
828 .no_instances
= true,
832 .load
= unit_load_fragment_and_dropin_optional
,
834 .coldplug
= device_coldplug
,
836 .serialize
= device_serialize
,
837 .deserialize_item
= device_deserialize_item
,
841 .active_state
= device_active_state
,
842 .sub_state_to_string
= device_sub_state_to_string
,
844 .bus_vtable
= bus_device_vtable
,
846 .following
= device_following
,
847 .following_set
= device_following_set
,
849 .enumerate
= device_enumerate
,
850 .shutdown
= device_shutdown
,
851 .supported
= device_supported
,
853 .status_message_formats
= {
854 .starting_stopping
= {
855 [0] = "Expecting device %s...",
857 .finished_start_job
= {
858 [JOB_DONE
] = "Found device %s.",
859 [JOB_TIMEOUT
] = "Timed out waiting for device %s.",