2 This file is part of systemd.
4 Copyright 2008-2012 Kay Sievers <kay@vrfy.org>
5 Copyright 2014 Tom Gundersen <teg@jklm.no>
7 systemd is free software; you can redistribute it and/or modify it
8 under the terms of the GNU Lesser General Public License as published by
9 the Free Software Foundation; either version 2.1 of the License, or
10 (at your option) any later version.
12 systemd is distributed in the hope that it will be useful, but
13 WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 Lesser General Public License for more details.
17 You should have received a copy of the GNU Lesser General Public License
18 along with systemd; If not, see <http://www.gnu.org/licenses/>.
22 #include <sys/types.h>
28 #include "path-util.h"
36 #include "sd-device.h"
38 #include "device-util.h"
39 #include "device-internal.h"
40 #include "device-private.h"
42 int device_add_property(sd_device
*device
, const char *key
, const char *value
) {
48 r
= device_add_property_aux(device
, key
, value
, false);
53 r
= device_add_property_aux(device
, key
, value
, true);
61 static int device_add_property_internal_from_string(sd_device
*device
, const char *str
) {
62 _cleanup_free_
char *key
= NULL
;
72 value
= strchr(key
, '=');
81 return device_add_property_internal(device
, key
, value
);
84 static int handle_db_line(sd_device
*device
, char key
, const char *value
) {
93 path
= strjoina("/dev/", value
);
94 r
= device_add_devlink(device
, path
);
100 r
= safe_atoi(value
, &device
->devlink_priority
);
106 r
= device_add_property_internal_from_string(device
, value
);
112 r
= device_add_tag(device
, value
);
118 r
= safe_atoi(value
, &device
->watch_handle
);
124 r
= device_set_usec_initialized(device
, value
);
130 log_debug("device db: unknown key '%c'", key
);
136 void device_set_devlink_priority(sd_device
*device
, int priority
) {
139 device
->devlink_priority
= priority
;
142 void device_set_is_initialized(sd_device
*device
) {
145 device
->is_initialized
= true;
148 int device_ensure_usec_initialized(sd_device
*device
, sd_device
*device_old
) {
149 char num
[DECIMAL_STR_MAX(usec_t
)];
150 usec_t usec_initialized
;
155 if (device_old
&& device_old
->usec_initialized
> 0)
156 usec_initialized
= device_old
->usec_initialized
;
158 usec_initialized
= now(CLOCK_MONOTONIC
);
160 r
= snprintf(num
, sizeof(num
), USEC_FMT
, usec_initialized
);
164 r
= device_set_usec_initialized(device
, num
);
171 static int device_read_db(sd_device
*device
) {
172 _cleanup_free_
char *db
= NULL
;
174 const char *id
, *value
;
190 if (device
->db_loaded
|| device
->sealed
)
193 r
= device_get_id_filename(device
, &id
);
197 path
= strjoina("/run/udev/data/", id
);
199 r
= read_full_file(path
, &db
, &db_len
);
204 return log_debug_errno(r
, "sd-device: failed to read db '%s': %m", path
);
207 /* devices with a database entry are initialized */
208 device_set_is_initialized(device
);
210 for (i
= 0; i
< db_len
; i
++) {
213 if (!strchr(NEWLINE
, db
[i
])) {
222 log_debug("sd-device: ignoring invalid db entry with key '%c'", key
);
224 state
= INVALID_LINE
;
239 if (strchr(NEWLINE
, db
[i
]))
244 if (strchr(NEWLINE
, db
[i
])) {
246 r
= handle_db_line(device
, key
, value
);
248 log_debug_errno(r
, "sd-device: failed to handle db entry '%c:%s': %m", key
, value
);
255 assert_not_reached("invalid state when parsing db");
259 device
->db_loaded
= true;
264 uint64_t device_get_properties_generation(sd_device
*device
) {
267 return device
->properties_generation
;
270 uint64_t device_get_tags_generation(sd_device
*device
) {
273 return device
->tags_generation
;
276 uint64_t device_get_devlinks_generation(sd_device
*device
) {
279 return device
->devlinks_generation
;
282 int device_get_devnode_mode(sd_device
*device
, mode_t
*mode
) {
288 r
= device_read_db(device
);
292 *mode
= device
->devmode
;
297 int device_get_devnode_uid(sd_device
*device
, uid_t
*uid
) {
303 r
= device_read_db(device
);
307 *uid
= device
->devuid
;
312 static int device_set_devuid(sd_device
*device
, const char *uid
) {
319 r
= safe_atou(uid
, &u
);
323 r
= device_add_property_internal(device
, "DEVUID", uid
);
332 int device_get_devnode_gid(sd_device
*device
, gid_t
*gid
) {
338 r
= device_read_db(device
);
342 *gid
= device
->devgid
;
347 static int device_set_devgid(sd_device
*device
, const char *gid
) {
354 r
= safe_atou(gid
, &g
);
358 r
= device_add_property_internal(device
, "DEVGID", gid
);
367 static int device_amend(sd_device
*device
, const char *key
, const char *value
) {
374 if (streq(key
, "DEVPATH")) {
377 path
= strjoina("/sys", value
);
379 /* the caller must verify or trust this data (e.g., if it comes from the kernel) */
380 r
= device_set_syspath(device
, path
, false);
382 return log_debug_errno(r
, "sd-device: could not set syspath to '%s': %m", path
);
383 } else if (streq(key
, "SUBSYSTEM")) {
384 r
= device_set_subsystem(device
, value
);
386 return log_debug_errno(r
, "sd-device: could not set subsystem to '%s': %m", value
);
387 } else if (streq(key
, "DEVTYPE")) {
388 r
= device_set_devtype(device
, value
);
390 return log_debug_errno(r
, "sd-device: could not set devtype to '%s': %m", value
);
391 } else if (streq(key
, "DEVNAME")) {
392 r
= device_set_devname(device
, value
);
394 return log_debug_errno(r
, "sd-device: could not set devname to '%s': %m", value
);
395 } else if (streq(key
, "USEC_INITIALIZED")) {
396 r
= device_set_usec_initialized(device
, value
);
398 return log_debug_errno(r
, "sd-device: could not set usec-initialized to '%s': %m", value
);
399 } else if (streq(key
, "DRIVER")) {
400 r
= device_set_driver(device
, value
);
402 return log_debug_errno(r
, "sd-device: could not set driver to '%s': %m", value
);
403 } else if (streq(key
, "IFINDEX")) {
404 r
= device_set_ifindex(device
, value
);
406 return log_debug_errno(r
, "sd-device: could not set ifindex to '%s': %m", value
);
407 } else if (streq(key
, "DEVMODE")) {
408 r
= device_set_devmode(device
, value
);
410 return log_debug_errno(r
, "sd-device: could not set devmode to '%s': %m", value
);
411 } else if (streq(key
, "DEVUID")) {
412 r
= device_set_devuid(device
, value
);
414 return log_debug_errno(r
, "sd-device: could not set devuid to '%s': %m", value
);
415 } else if (streq(key
, "DEVGID")) {
416 r
= device_set_devgid(device
, value
);
418 return log_debug_errno(r
, "sd-device: could not set devgid to '%s': %m", value
);
419 } else if (streq(key
, "DEVLINKS")) {
420 const char *word
, *state
;
423 FOREACH_WORD(word
, l
, value
, state
) {
426 strncpy(devlink
, word
, l
);
429 r
= device_add_devlink(device
, devlink
);
431 return log_debug_errno(r
, "sd-device: could not add devlink '%s': %m", devlink
);
433 } else if (streq(key
, "TAGS")) {
434 const char *word
, *state
;
437 FOREACH_WORD_SEPARATOR(word
, l
, value
, ":", state
) {
440 (void)strncpy(tag
, word
, l
);
443 r
= device_add_tag(device
, tag
);
445 return log_debug_errno(r
, "sd-device: could not add tag '%s': %m", tag
);
448 r
= device_add_property_internal(device
, key
, value
);
450 return log_debug_errno(r
, "sd-device: could not add property '%s=%s': %m", key
, value
);
456 static const char* const device_action_table
[_DEVICE_ACTION_MAX
] = {
457 [DEVICE_ACTION_ADD
] = "add",
458 [DEVICE_ACTION_REMOVE
] = "remove",
459 [DEVICE_ACTION_CHANGE
] = "change",
460 [DEVICE_ACTION_MOVE
] = "move",
461 [DEVICE_ACTION_ONLINE
] = "online",
462 [DEVICE_ACTION_OFFLINE
] = "offline",
465 DEFINE_STRING_TABLE_LOOKUP(device_action
, DeviceAction
);
467 static int device_append(sd_device
*device
, char *key
, const char **_major
, const char **_minor
, uint64_t *_seqnum
,
468 DeviceAction
*_action
) {
469 DeviceAction action
= _DEVICE_ACTION_INVALID
;
471 const char *major
= NULL
, *minor
= NULL
;
482 value
= strchr(key
, '=');
484 log_debug("sd-device: not a key-value pair: '%s'", key
);
492 if (streq(key
, "MAJOR"))
494 else if (streq(key
, "MINOR"))
497 if (streq(key
, "ACTION")) {
498 action
= device_action_from_string(value
);
499 if (action
== _DEVICE_ACTION_INVALID
)
501 } else if (streq(key
, "SEQNUM")) {
502 r
= safe_atou64(value
, &seqnum
);
505 else if (seqnum
== 0)
506 /* kernel only sends seqnum > 0 */
510 r
= device_amend(device
, key
, value
);
521 if (action
!= _DEVICE_ACTION_INVALID
)
530 void device_seal(sd_device
*device
) {
533 device
->sealed
= true;
536 static int device_verify(sd_device
*device
, DeviceAction action
, uint64_t seqnum
) {
539 if (!device
->devpath
|| !device
->subsystem
|| action
== _DEVICE_ACTION_INVALID
|| seqnum
== 0) {
540 log_debug("sd-device: device created from strv lacks devpath, subsystem, action or seqnum");
544 device
->sealed
= true;
549 int device_new_from_strv(sd_device
**ret
, char **strv
) {
550 _cleanup_device_unref_ sd_device
*device
= NULL
;
552 const char *major
= NULL
, *minor
= NULL
;
553 DeviceAction action
= _DEVICE_ACTION_INVALID
;
560 r
= device_new_aux(&device
);
564 STRV_FOREACH(key
, strv
) {
565 r
= device_append(device
, *key
, &major
, &minor
, &seqnum
, &action
);
571 r
= device_set_devnum(device
, major
, minor
);
573 return log_debug_errno(r
, "sd-device: could not set devnum %s:%s: %m", major
, minor
);
576 r
= device_verify(device
, action
, seqnum
);
586 int device_new_from_nulstr(sd_device
**ret
, uint8_t *nulstr
, size_t len
) {
587 _cleanup_device_unref_ sd_device
*device
= NULL
;
588 const char *major
= NULL
, *minor
= NULL
;
589 DeviceAction action
= _DEVICE_ACTION_INVALID
;
598 r
= device_new_aux(&device
);
606 key
= (char*)&nulstr
[i
];
607 end
= memchr(key
, '\0', len
- i
);
609 log_debug("sd-device: failed to parse nulstr");
614 r
= device_append(device
, key
, &major
, &minor
, &seqnum
, &action
);
620 r
= device_set_devnum(device
, major
, minor
);
622 return log_debug_errno(r
, "sd-device: could not set devnum %s:%s: %m", major
, minor
);
625 r
= device_verify(device
, action
, seqnum
);
635 static int device_update_properties_bufs(sd_device
*device
) {
636 const char *val
, *prop
;
637 _cleanup_free_
char **buf_strv
= NULL
;
638 _cleanup_free_
uint8_t *buf_nulstr
= NULL
;
639 size_t allocated_nulstr
= 0;
640 size_t nulstr_len
= 0, num
= 0, i
= 0;
644 if (!device
->properties_buf_outdated
)
647 FOREACH_DEVICE_PROPERTY(device
, prop
, val
) {
650 len
= strlen(prop
) + 1 + strlen(val
);
652 buf_nulstr
= GREEDY_REALLOC0(buf_nulstr
, allocated_nulstr
, nulstr_len
+ len
+ 2);
656 strscpyl((char *)buf_nulstr
+ nulstr_len
, len
+ 1, prop
, "=", val
, NULL
);
657 nulstr_len
+= len
+ 1;
661 /* build buf_strv from buf_nulstr */
662 buf_strv
= new0(char *, num
+ 1);
666 NULSTR_FOREACH(val
, (char*) buf_nulstr
) {
667 buf_strv
[i
] = (char *) val
;
672 free(device
->properties_nulstr
);
673 device
->properties_nulstr
= buf_nulstr
;
675 device
->properties_nulstr_len
= nulstr_len
;
676 free(device
->properties_strv
);
677 device
->properties_strv
= buf_strv
;
680 device
->properties_buf_outdated
= false;
685 int device_get_properties_nulstr(sd_device
*device
, const uint8_t **nulstr
, size_t *len
) {
692 r
= device_update_properties_bufs(device
);
696 *nulstr
= device
->properties_nulstr
;
697 *len
= device
->properties_nulstr_len
;
702 int device_get_properties_strv(sd_device
*device
, char ***strv
) {
708 r
= device_update_properties_bufs(device
);
712 *strv
= device
->properties_strv
;
717 int device_get_devlink_priority(sd_device
*device
, int *priority
) {
723 r
= device_read_db(device
);
727 *priority
= device
->devlink_priority
;
732 int device_get_watch_handle(sd_device
*device
, int *handle
) {
738 r
= device_read_db(device
);
742 *handle
= device
->watch_handle
;
747 void device_set_watch_handle(sd_device
*device
, int handle
) {
750 device
->watch_handle
= handle
;
753 int device_rename(sd_device
*device
, const char *name
) {
754 _cleanup_free_
char *dirname
= NULL
;
756 const char *interface
;
762 dirname
= dirname_malloc(device
->syspath
);
766 new_syspath
= strjoina(dirname
, "/", name
);
768 /* the user must trust that the new name is correct */
769 r
= device_set_syspath(device
, new_syspath
, false);
773 r
= sd_device_get_property_value(device
, "INTERFACE", &interface
);
775 r
= device_add_property_internal(device
, "INTERFACE", name
);
779 /* like DEVPATH_OLD, INTERFACE_OLD is not saved to the db, but only stays around for the current event */
780 r
= device_add_property_internal(device
, "INTERFACE_OLD", interface
);
783 } else if (r
!= -ENOENT
)
789 int device_shallow_clone(sd_device
*old_device
, sd_device
**new_device
) {
790 _cleanup_device_unref_ sd_device
*ret
= NULL
;
796 r
= device_new_aux(&ret
);
800 r
= device_set_syspath(ret
, old_device
->syspath
, false);
804 r
= device_set_subsystem(ret
, old_device
->subsystem
);
808 ret
->devnum
= old_device
->devnum
;
816 int device_clone_with_db(sd_device
*old_device
, sd_device
**new_device
) {
817 _cleanup_device_unref_ sd_device
*ret
= NULL
;
823 r
= device_shallow_clone(old_device
, &ret
);
827 r
= device_read_db(ret
);
839 int device_new_from_synthetic_event(sd_device
**new_device
, const char *syspath
, const char *action
) {
840 _cleanup_device_unref_ sd_device
*ret
= NULL
;
847 r
= sd_device_new_from_syspath(&ret
, syspath
);
851 r
= device_read_uevent_file(ret
);
855 r
= device_add_property_internal(ret
, "ACTION", action
);
865 int device_copy_properties(sd_device
*device_dst
, sd_device
*device_src
) {
866 const char *property
, *value
;
872 FOREACH_DEVICE_PROPERTY(device_src
, property
, value
) {
873 r
= device_add_property(device_dst
, property
, value
);
881 void device_cleanup_tags(sd_device
*device
) {
884 set_free_free(device
->tags
);
886 device
->property_tags_outdated
= true;
887 device
->tags_generation
++;
890 void device_cleanup_devlinks(sd_device
*device
) {
893 set_free_free(device
->devlinks
);
894 device
->devlinks
= NULL
;
895 device
->property_devlinks_outdated
= true;
896 device
->devlinks_generation
++;
899 void device_remove_tag(sd_device
*device
, const char *tag
) {
903 free(set_remove(device
->tags
, tag
));
904 device
->property_tags_outdated
= true;
905 device
->tags_generation
++;
908 static int device_tag(sd_device
*device
, const char *tag
, bool add
) {
916 r
= device_get_id_filename(device
, &id
);
920 path
= strjoina("/run/udev/tags/", tag
, "/", id
);
923 r
= touch_file(path
, true, USEC_INFINITY
, UID_INVALID
, GID_INVALID
, 0444);
928 if (r
< 0 && errno
!= ENOENT
)
935 int device_tag_index(sd_device
*device
, sd_device
*device_old
, bool add
) {
939 if (add
&& device_old
) {
940 /* delete possible left-over tags */
941 FOREACH_DEVICE_TAG(device_old
, tag
) {
942 if (!sd_device_has_tag(device
, tag
)) {
943 k
= device_tag(device_old
, tag
, false);
950 FOREACH_DEVICE_TAG(device
, tag
) {
951 k
= device_tag(device
, tag
, add
);
959 static bool device_has_info(sd_device
*device
) {
962 if (!set_isempty(device
->devlinks
))
965 if (device
->devlink_priority
!= 0)
968 if (!ordered_hashmap_isempty(device
->properties_db
))
971 if (!set_isempty(device
->tags
))
974 if (device
->watch_handle
>= 0)
980 void device_set_db_persist(sd_device
*device
) {
983 device
->db_persist
= true;
986 int device_update_db(sd_device
*device
) {
989 _cleanup_fclose_
FILE *f
= NULL
;
990 _cleanup_free_
char *path_tmp
= NULL
;
996 has_info
= device_has_info(device
);
998 r
= device_get_id_filename(device
, &id
);
1002 path
= strjoina("/run/udev/data/", id
);
1004 /* do not store anything for otherwise empty devices */
1005 if (!has_info
&& major(device
->devnum
) == 0 && device
->ifindex
== 0) {
1007 if (r
< 0 && errno
!= ENOENT
)
1013 /* write a database file */
1014 r
= mkdir_parents(path
, 0755);
1018 r
= fopen_temporary(path
, &f
, &path_tmp
);
1023 * set 'sticky' bit to indicate that we should not clean the
1024 * database when we transition from initramfs to the real root
1026 if (device
->db_persist
) {
1027 r
= fchmod(fileno(f
), 01644);
1033 r
= fchmod(fileno(f
), 0644);
1041 const char *property
, *value
, *tag
;
1044 if (major(device
->devnum
) > 0) {
1045 const char *devlink
;
1047 FOREACH_DEVICE_DEVLINK(device
, devlink
)
1048 fprintf(f
, "S:%s\n", devlink
+ strlen("/dev/"));
1050 if (device
->devlink_priority
!= 0)
1051 fprintf(f
, "L:%i\n", device
->devlink_priority
);
1053 if (device
->watch_handle
>= 0)
1054 fprintf(f
, "W:%i\n", device
->watch_handle
);
1057 if (device
->usec_initialized
> 0)
1058 fprintf(f
, "I:"USEC_FMT
"\n", device
->usec_initialized
);
1060 ORDERED_HASHMAP_FOREACH_KEY(value
, property
, device
->properties_db
, i
)
1061 fprintf(f
, "E:%s=%s\n", property
, value
);
1063 FOREACH_DEVICE_TAG(device
, tag
)
1064 fprintf(f
, "G:%s\n", tag
);
1067 r
= fflush_and_check(f
);
1071 r
= rename(path_tmp
, path
);
1077 log_debug("created %s file '%s' for '%s'", has_info
? "db" : "empty",
1078 path
, device
->devpath
);
1083 (void) unlink(path
);
1084 (void) unlink(path_tmp
);
1086 return log_error_errno(r
, "failed to create %s file '%s' for '%s'", has_info
? "db" : "empty", path
, device
->devpath
);
1089 int device_delete_db(sd_device
*device
) {
1096 r
= device_get_id_filename(device
, &id
);
1100 path
= strjoina("/run/udev/data/", id
);
1103 if (r
< 0 && errno
!= ENOENT
)
1109 int device_read_db_force(sd_device
*device
) {
1112 return device_read_db_aux(device
, true);