1 /* SPDX-License-Identifier: GPL-2.0+ */
14 #include "alloc-util.h"
15 #include "device-private.h"
16 #include "device-util.h"
18 #include "format-util.h"
19 #include "libudev-util.h"
20 #include "netlink-util.h"
21 #include "path-util.h"
22 #include "process-util.h"
23 #include "rlimit-util.h"
24 #include "signal-util.h"
25 #include "stdio-util.h"
26 #include "string-util.h"
29 #include "udev-builtin.h"
30 #include "udev-node.h"
31 #include "udev-watch.h"
34 typedef struct Spawn
{
37 usec_t timeout_warn_usec
;
39 usec_t event_birth_usec
;
48 UdevEvent
*udev_event_new(sd_device
*dev
, usec_t exec_delay_usec
, sd_netlink
*rtnl
) {
53 event
= new(UdevEvent
, 1);
57 *event
= (UdevEvent
) {
58 .dev
= sd_device_ref(dev
),
59 .birth_usec
= now(CLOCK_MONOTONIC
),
60 .exec_delay_usec
= exec_delay_usec
,
61 .rtnl
= sd_netlink_ref(rtnl
),
67 UdevEvent
*udev_event_free(UdevEvent
*event
) {
71 sd_device_unref(event
->dev
);
72 sd_device_unref(event
->dev_db_clone
);
73 sd_netlink_unref(event
->rtnl
);
74 hashmap_free_free_key(event
->run_list
);
75 hashmap_free_free_free(event
->seclabel_list
);
76 free(event
->program_result
);
101 struct subst_map_entry
{
104 enum subst_type type
;
107 static const struct subst_map_entry map
[] = {
108 { .name
= "devnode", .fmt
= 'N', .type
= SUBST_DEVNODE
},
109 { .name
= "tempnode", .fmt
= 'N', .type
= SUBST_DEVNODE
},
110 { .name
= "attr", .fmt
= 's', .type
= SUBST_ATTR
},
111 { .name
= "sysfs", .fmt
= 's', .type
= SUBST_ATTR
},
112 { .name
= "env", .fmt
= 'E', .type
= SUBST_ENV
},
113 { .name
= "kernel", .fmt
= 'k', .type
= SUBST_KERNEL
},
114 { .name
= "number", .fmt
= 'n', .type
= SUBST_KERNEL_NUMBER
},
115 { .name
= "driver", .fmt
= 'd', .type
= SUBST_DRIVER
},
116 { .name
= "devpath", .fmt
= 'p', .type
= SUBST_DEVPATH
},
117 { .name
= "id", .fmt
= 'b', .type
= SUBST_ID
},
118 { .name
= "major", .fmt
= 'M', .type
= SUBST_MAJOR
},
119 { .name
= "minor", .fmt
= 'm', .type
= SUBST_MINOR
},
120 { .name
= "result", .fmt
= 'c', .type
= SUBST_RESULT
},
121 { .name
= "parent", .fmt
= 'P', .type
= SUBST_PARENT
},
122 { .name
= "name", .fmt
= 'D', .type
= SUBST_NAME
},
123 { .name
= "links", .fmt
= 'L', .type
= SUBST_LINKS
},
124 { .name
= "root", .fmt
= 'r', .type
= SUBST_ROOT
},
125 { .name
= "sys", .fmt
= 'S', .type
= SUBST_SYS
},
128 static ssize_t
subst_format_var(UdevEvent
*event
,
129 const struct subst_map_entry
*entry
, char *attr
,
130 char *dest
, size_t l
) {
131 sd_device
*parent
, *dev
= event
->dev
;
132 const char *val
= NULL
;
139 switch (entry
->type
) {
141 r
= sd_device_get_devpath(dev
, &val
);
144 l
= strpcpy(&s
, l
, val
);
147 r
= sd_device_get_sysname(dev
, &val
);
150 l
= strpcpy(&s
, l
, val
);
152 case SUBST_KERNEL_NUMBER
:
153 r
= sd_device_get_sysnum(dev
, &val
);
158 l
= strpcpy(&s
, l
, val
);
161 if (!event
->dev_parent
)
163 r
= sd_device_get_sysname(event
->dev_parent
, &val
);
166 l
= strpcpy(&s
, l
, val
);
169 if (!event
->dev_parent
)
171 r
= sd_device_get_driver(event
->dev_parent
, &val
);
176 l
= strpcpy(&s
, l
, val
);
180 char buf
[DECIMAL_STR_MAX(unsigned)];
182 r
= sd_device_get_devnum(dev
, &devnum
);
183 if (r
< 0 && r
!= -ENOENT
)
185 xsprintf(buf
, "%u", r
< 0 ? 0 : entry
->type
== SUBST_MAJOR
? major(devnum
) : minor(devnum
));
186 l
= strpcpy(&s
, l
, buf
);
193 if (!event
->program_result
)
196 /* get part of the result string */
199 i
= strtoul(attr
, &rest
, 10);
201 char result
[UTIL_PATH_SIZE
], tmp
[UTIL_PATH_SIZE
], *cpos
;
203 strscpy(result
, sizeof(result
), event
->program_result
);
206 while (cpos
[0] != '\0' && !isspace(cpos
[0]))
208 while (isspace(cpos
[0]))
214 log_error("requested part of result string not found");
217 strscpy(tmp
, sizeof(tmp
), cpos
);
218 /* %{2+}c copies the whole string from the second part on */
219 if (rest
[0] != '+') {
220 cpos
= strchr(tmp
, ' ');
224 l
= strpcpy(&s
, l
, tmp
);
226 l
= strpcpy(&s
, l
, event
->program_result
);
230 char vbuf
[UTIL_NAME_SIZE
];
237 /* try to read the value specified by "[dmi/id]product_name" */
238 if (util_resolve_subsys_kernel(attr
, vbuf
, sizeof(vbuf
), true) == 0)
241 /* try to read the attribute the device */
243 (void) sd_device_get_sysattr_value(dev
, attr
, &val
);
245 /* try to read the attribute of the parent device, other matches have selected */
246 if (!val
&& event
->dev_parent
&& event
->dev_parent
!= dev
)
247 (void) sd_device_get_sysattr_value(event
->dev_parent
, attr
, &val
);
252 /* strip trailing whitespace, and replace unwanted characters */
254 strscpy(vbuf
, sizeof(vbuf
), val
);
256 while (len
> 0 && isspace(vbuf
[--len
]))
258 count
= util_replace_chars(vbuf
, UDEV_ALLOWED_CHARS_INPUT
);
260 log_device_debug(dev
, "%i character(s) replaced", count
);
261 l
= strpcpy(&s
, l
, vbuf
);
265 r
= sd_device_get_parent(dev
, &parent
);
270 r
= sd_device_get_devname(parent
, &val
);
275 l
= strpcpy(&s
, l
, val
+ STRLEN("/dev/"));
278 r
= sd_device_get_devname(dev
, &val
);
283 l
= strpcpy(&s
, l
, val
);
287 l
= strpcpy(&s
, l
, event
->name
);
288 else if (sd_device_get_devname(dev
, &val
) >= 0)
289 l
= strpcpy(&s
, l
, val
+ STRLEN("/dev/"));
291 r
= sd_device_get_sysname(dev
, &val
);
294 l
= strpcpy(&s
, l
, val
);
298 FOREACH_DEVICE_DEVLINK(dev
, val
)
300 l
= strpcpy(&s
, l
, val
+ STRLEN("/dev/"));
302 l
= strpcpyl(&s
, l
, " ", val
+ STRLEN("/dev/"), NULL
);
307 l
= strpcpy(&s
, l
, "/dev");
310 l
= strpcpy(&s
, l
, "/sys");
315 r
= sd_device_get_property_value(dev
, attr
, &val
);
320 l
= strpcpy(&s
, l
, val
);
323 assert_not_reached("Unknown format substitution type");
333 ssize_t
udev_event_apply_format(UdevEvent
*event
,
334 const char *src
, char *dest
, size_t size
,
335 bool replace_whitespace
) {
351 const struct subst_map_entry
*entry
= NULL
;
352 char attrbuf
[UTIL_PATH_SIZE
], *attr
;
353 bool format_dollar
= false;
356 while (from
[0] != '\0') {
357 if (from
[0] == '$') {
358 /* substitute named variable */
361 if (from
[1] == '$') {
366 for (i
= 0; i
< ELEMENTSOF(map
); i
++) {
367 if (startswith(&from
[1], map
[i
].name
)) {
369 from
+= strlen(map
[i
].name
)+1;
370 format_dollar
= true;
374 } else if (from
[0] == '%') {
375 /* substitute format char */
378 if (from
[1] == '%') {
383 for (i
= 0; i
< ELEMENTSOF(map
); i
++) {
384 if (from
[1] == map
[i
].fmt
) {
393 if (l
< 2) /* need space for this char and the terminating NUL */
403 /* extract possible $format{attr} */
404 if (from
[0] == '{') {
408 for (i
= 0; from
[i
] != '}'; i
++)
409 if (from
[i
] == '\0') {
410 log_error("missing closing brace for format '%s'", src
);
414 if (i
>= sizeof(attrbuf
))
416 memcpy(attrbuf
, from
, i
);
423 subst_len
= subst_format_var(event
, entry
, attr
, s
, l
);
426 log_device_warning_errno(event
->dev
, subst_len
, "Failed to substitute variable '$%s', ignoring: %m", entry
->name
);
428 log_device_warning_errno(event
->dev
, subst_len
, "Failed to apply format '%%%c', ignoring: %m", entry
->fmt
);
433 /* SUBST_RESULT handles spaces itself */
434 if (replace_whitespace
&& entry
->type
!= SUBST_RESULT
)
435 /* util_replace_whitespace can replace in-place,
436 * and does nothing if subst_len == 0
438 subst_len
= util_replace_whitespace(s
, s
, subst_len
);
450 static int on_spawn_io(sd_event_source
*s
, int fd
, uint32_t revents
, void *userdata
) {
451 Spawn
*spawn
= userdata
;
457 assert(fd
== spawn
->fd_stdout
|| fd
== spawn
->fd_stderr
);
458 assert(!spawn
->result
|| spawn
->result_len
< spawn
->result_size
);
460 if (fd
== spawn
->fd_stdout
&& spawn
->result
) {
461 p
= spawn
->result
+ spawn
->result_len
;
462 size
= spawn
->result_size
- spawn
->result_len
;
468 l
= read(fd
, p
, size
- 1);
471 log_error_errno(errno
, "Failed to read stdout of '%s': %m", spawn
->cmd
);
477 if (fd
== spawn
->fd_stdout
&& spawn
->result
)
478 spawn
->result_len
+= l
;
480 /* Log output only if we watch stderr. */
481 if (l
> 0 && spawn
->fd_stderr
>= 0) {
482 _cleanup_strv_free_
char **v
= NULL
;
485 v
= strv_split_newlines(p
);
490 log_debug("'%s'(%s) '%s'", spawn
->cmd
,
491 fd
== spawn
->fd_stdout
? "out" : "err", *q
);
497 static int on_spawn_timeout(sd_event_source
*s
, uint64_t usec
, void *userdata
) {
498 Spawn
*spawn
= userdata
;
499 char timeout
[FORMAT_TIMESPAN_MAX
];
503 kill_and_sigcont(spawn
->pid
, SIGKILL
);
505 log_error("Spawned process '%s' ["PID_FMT
"] timed out after %s, killing", spawn
->cmd
, spawn
->pid
,
506 format_timespan(timeout
, sizeof(timeout
), spawn
->timeout_usec
, USEC_PER_SEC
));
511 static int on_spawn_timeout_warning(sd_event_source
*s
, uint64_t usec
, void *userdata
) {
512 Spawn
*spawn
= userdata
;
513 char timeout
[FORMAT_TIMESPAN_MAX
];
517 log_warning("Spawned process '%s' ["PID_FMT
"] is taking longer than %s to complete", spawn
->cmd
, spawn
->pid
,
518 format_timespan(timeout
, sizeof(timeout
), spawn
->timeout_warn_usec
, USEC_PER_SEC
));
523 static int on_spawn_sigchld(sd_event_source
*s
, const siginfo_t
*si
, void *userdata
) {
524 Spawn
*spawn
= userdata
;
529 switch (si
->si_code
) {
531 if (si
->si_status
== 0)
532 log_debug("Process '%s' succeeded.", spawn
->cmd
);
534 log_full(spawn
->accept_failure
? LOG_DEBUG
: LOG_WARNING
,
535 "Process '%s' failed with exit code %i.", spawn
->cmd
, si
->si_status
);
540 log_error("Process '%s' terminated by signal %s.", spawn
->cmd
, signal_to_string(si
->si_status
));
543 log_error("Process '%s' failed due to unknown reason.", spawn
->cmd
);
546 sd_event_exit(sd_event_source_get_event(s
), ret
);
550 static int spawn_wait(Spawn
*spawn
) {
551 _cleanup_(sd_event_unrefp
) sd_event
*e
= NULL
;
556 r
= sd_event_new(&e
);
560 if (spawn
->timeout_usec
> 0) {
561 usec_t usec
, age_usec
;
563 usec
= now(CLOCK_MONOTONIC
);
564 age_usec
= usec
- spawn
->event_birth_usec
;
565 if (age_usec
< spawn
->timeout_usec
) {
566 if (spawn
->timeout_warn_usec
> 0 &&
567 spawn
->timeout_warn_usec
< spawn
->timeout_usec
&&
568 spawn
->timeout_warn_usec
> age_usec
) {
569 spawn
->timeout_warn_usec
-= age_usec
;
571 r
= sd_event_add_time(e
, NULL
, CLOCK_MONOTONIC
,
572 usec
+ spawn
->timeout_warn_usec
, USEC_PER_SEC
,
573 on_spawn_timeout_warning
, spawn
);
578 spawn
->timeout_usec
-= age_usec
;
580 r
= sd_event_add_time(e
, NULL
, CLOCK_MONOTONIC
,
581 usec
+ spawn
->timeout_usec
, USEC_PER_SEC
, on_spawn_timeout
, spawn
);
587 if (spawn
->fd_stdout
>= 0) {
588 r
= sd_event_add_io(e
, NULL
, spawn
->fd_stdout
, EPOLLIN
, on_spawn_io
, spawn
);
593 if (spawn
->fd_stderr
>= 0) {
594 r
= sd_event_add_io(e
, NULL
, spawn
->fd_stderr
, EPOLLIN
, on_spawn_io
, spawn
);
599 r
= sd_event_add_child(e
, NULL
, spawn
->pid
, WEXITED
, on_spawn_sigchld
, spawn
);
603 return sd_event_loop(e
);
606 int udev_event_spawn(UdevEvent
*event
,
610 char *result
, size_t ressize
) {
611 _cleanup_close_pair_
int outpipe
[2] = {-1, -1}, errpipe
[2] = {-1, -1};
612 _cleanup_strv_free_
char **argv
= NULL
;
620 assert(result
|| ressize
== 0);
622 /* pipes from child to parent */
623 if (result
|| log_get_max_level() >= LOG_INFO
)
624 if (pipe2(outpipe
, O_NONBLOCK
|O_CLOEXEC
) != 0)
625 return log_error_errno(errno
, "Failed to create pipe for command '%s': %m", cmd
);
627 if (log_get_max_level() >= LOG_INFO
)
628 if (pipe2(errpipe
, O_NONBLOCK
|O_CLOEXEC
) != 0)
629 return log_error_errno(errno
, "Failed to create pipe for command '%s': %m", cmd
);
631 argv
= strv_split_full(cmd
, NULL
, SPLIT_QUOTES
|SPLIT_RELAX
);
635 if (isempty(argv
[0]))
636 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
),
637 "Invalid command '%s'", cmd
);
639 /* allow programs in /usr/lib/udev/ to be called without the path */
640 if (!path_is_absolute(argv
[0])) {
643 program
= path_join(UDEVLIBEXECDIR
, argv
[0]);
647 free_and_replace(argv
[0], program
);
650 r
= device_get_properties_strv(event
->dev
, &envp
);
652 return log_device_error_errno(event
->dev
, r
, "Failed to get device properties");
654 log_debug("Starting '%s'", cmd
);
656 r
= safe_fork("(spawn)", FORK_RESET_SIGNALS
|FORK_DEATHSIG
|FORK_LOG
, &pid
);
658 return log_error_errno(r
, "Failed to fork() to execute command '%s': %m", cmd
);
660 if (rearrange_stdio(-1, outpipe
[WRITE_END
], errpipe
[WRITE_END
]) < 0)
663 (void) close_all_fds(NULL
, 0);
664 (void) rlimit_nofile_safe();
666 execve(argv
[0], argv
, envp
);
670 /* parent closed child's ends of pipes */
671 outpipe
[WRITE_END
] = safe_close(outpipe
[WRITE_END
]);
672 errpipe
[WRITE_END
] = safe_close(errpipe
[WRITE_END
]);
677 .accept_failure
= accept_failure
,
678 .timeout_warn_usec
= udev_warn_timeout(timeout_usec
),
679 .timeout_usec
= timeout_usec
,
680 .event_birth_usec
= event
->birth_usec
,
681 .fd_stdout
= outpipe
[READ_END
],
682 .fd_stderr
= errpipe
[READ_END
],
684 .result_size
= ressize
,
686 r
= spawn_wait(&spawn
);
688 return log_error_errno(r
, "Failed to wait for spawned command '%s': %m", cmd
);
691 result
[spawn
.result_len
] = '\0';
693 return r
; /* 0 for success, and positive if the program failed */
696 static int rename_netif(UdevEvent
*event
) {
697 sd_device
*dev
= event
->dev
;
698 const char *action
, *oldname
;
703 return 0; /* No new name is requested. */
705 r
= sd_device_get_sysname(dev
, &oldname
);
707 return log_device_error_errno(dev
, r
, "Failed to get sysname: %m");
709 if (streq(event
->name
, oldname
))
710 return 0; /* The interface name is already requested name. */
712 r
= sd_device_get_property_value(dev
, "ACTION", &action
);
714 return log_device_error_errno(dev
, r
, "Failed to get property 'ACTION': %m");
716 if (!streq(action
, "add"))
717 return 0; /* Rename the interface only when it is added. */
719 r
= sd_device_get_ifindex(dev
, &ifindex
);
721 return 0; /* Device is not a network interface. */
723 return log_device_error_errno(dev
, r
, "Failed to get ifindex: %m");
725 strscpy(name
, IFNAMSIZ
, event
->name
);
726 r
= rtnl_set_link_name(&event
->rtnl
, ifindex
, name
);
728 return log_device_error_errno(dev
, r
, "Failed to rename network interface %i from '%s' to '%s': %m", ifindex
, oldname
, name
);
730 r
= device_rename(dev
, event
->name
);
732 return log_warning_errno(r
, "Network interface %i is renamed from '%s' to '%s', but could not update sd_device object: %m", ifindex
, oldname
, name
);
734 log_device_debug(dev
, "Network interface %i is renamed from '%s' to '%s'", ifindex
, oldname
, name
);
739 static int update_devnode(UdevEvent
*event
) {
740 sd_device
*dev
= event
->dev
;
745 r
= sd_device_get_devnum(dev
, NULL
);
749 return log_device_error_errno(dev
, r
, "Failed to get devnum: %m");
751 /* remove/update possible left-over symlinks from old database entry */
752 if (event
->dev_db_clone
)
753 (void) udev_node_update_old_links(dev
, event
->dev_db_clone
);
755 if (!event
->owner_set
) {
756 r
= device_get_devnode_uid(dev
, &event
->uid
);
757 if (r
< 0 && r
!= -ENOENT
)
758 return log_device_error_errno(dev
, r
, "Failed to get devnode UID: %m");
761 if (!event
->group_set
) {
762 r
= device_get_devnode_gid(dev
, &event
->gid
);
763 if (r
< 0 && r
!= -ENOENT
)
764 return log_device_error_errno(dev
, r
, "Failed to get devnode GID: %m");
767 if (!event
->mode_set
) {
768 r
= device_get_devnode_mode(dev
, &event
->mode
);
769 if (r
< 0 && r
!= -ENOENT
)
770 return log_device_error_errno(dev
, r
, "Failed to get devnode mode: %m");
773 /* default 0660 if a group is assigned */
781 r
= sd_device_get_property_value(dev
, "ACTION", &action
);
783 return log_device_error_errno(dev
, r
, "Failed to get property 'ACTION': %m");
785 apply
= streq(action
, "add") || event
->owner_set
|| event
->group_set
|| event
->mode_set
;
786 return udev_node_add(dev
, apply
, event
->mode
, event
->uid
, event
->gid
, event
->seclabel_list
);
789 static void event_execute_rules_on_remove(
792 Hashmap
*properties_list
,
795 sd_device
*dev
= event
->dev
;
798 r
= device_read_db_internal(dev
, true);
800 log_device_debug_errno(dev
, r
, "Failed to read database under /run/udev/data/: %m");
802 r
= device_tag_index(dev
, NULL
, false);
804 log_device_debug_errno(dev
, r
, "Failed to remove corresponding tag files under /run/udev/tag/, ignoring: %m");
806 r
= device_delete_db(dev
);
808 log_device_debug_errno(dev
, r
, "Failed to delete database under /run/udev/data/, ignoring: %m");
810 if (sd_device_get_devnum(dev
, NULL
) >= 0)
811 (void) udev_watch_end(dev
);
813 (void) udev_rules_apply_to_event(rules
, event
, timeout_usec
, properties_list
);
815 if (sd_device_get_devnum(dev
, NULL
) >= 0)
816 (void) udev_node_remove(dev
);
819 int udev_event_execute_rules(UdevEvent
*event
,
821 Hashmap
*properties_list
,
823 sd_device
*dev
= event
->dev
;
824 const char *subsystem
, *action
;
830 r
= sd_device_get_subsystem(dev
, &subsystem
);
832 return log_device_error_errno(dev
, r
, "Failed to get subsystem: %m");
834 r
= sd_device_get_property_value(dev
, "ACTION", &action
);
836 return log_device_error_errno(dev
, r
, "Failed to get property 'ACTION': %m");
838 if (streq(action
, "remove")) {
839 event_execute_rules_on_remove(event
, timeout_usec
, properties_list
, rules
);
843 r
= device_clone_with_db(dev
, &event
->dev_db_clone
);
845 log_device_debug_errno(dev
, r
, "Failed to clone sd_device object, ignoring: %m");
847 if (event
->dev_db_clone
) {
848 r
= sd_device_get_devnum(dev
, NULL
);
851 log_device_debug_errno(dev
, r
, "Failed to get devnum, ignoring: %m");
853 if (streq(action
, "move")) {
854 r
= device_copy_properties(dev
, event
->dev_db_clone
);
856 log_device_debug_errno(dev
, r
, "Failed to copy properties from cloned device, ignoring: %m");
859 /* Disable watch during event processing. */
860 (void) udev_watch_end(event
->dev_db_clone
);
863 (void) udev_rules_apply_to_event(rules
, event
, timeout_usec
, properties_list
);
865 (void) rename_netif(event
);
866 (void) update_devnode(event
);
868 /* preserve old, or get new initialization timestamp */
869 r
= device_ensure_usec_initialized(dev
, event
->dev_db_clone
);
871 log_device_debug_errno(dev
, r
, "Failed to set initialization timestamp, ignoring: %m");
873 /* (re)write database file */
874 r
= device_tag_index(dev
, event
->dev_db_clone
, true);
876 log_device_debug_errno(dev
, r
, "Failed to update tags under /run/udev/tag/, ignoring: %m");
878 r
= device_update_db(dev
);
880 log_device_debug_errno(dev
, r
, "Failed to update database under /run/udev/data/, ignoring: %m");
882 device_set_is_initialized(dev
);
884 event
->dev_db_clone
= sd_device_unref(event
->dev_db_clone
);
889 void udev_event_execute_run(UdevEvent
*event
, usec_t timeout_usec
) {
894 HASHMAP_FOREACH_KEY(val
, cmd
, event
->run_list
, i
) {
895 enum udev_builtin_cmd builtin_cmd
= PTR_TO_INT(val
);
896 char command
[UTIL_PATH_SIZE
];
898 udev_event_apply_format(event
, cmd
, command
, sizeof(command
), false);
900 if (builtin_cmd
>= 0 && builtin_cmd
< _UDEV_BUILTIN_MAX
)
901 udev_builtin_run(event
->dev
, builtin_cmd
, command
, false);
903 if (event
->exec_delay_usec
> 0) {
904 log_debug("delay execution of '%s'", command
);
905 (void) usleep(event
->exec_delay_usec
);
908 (void) udev_event_spawn(event
, timeout_usec
, false, command
, NULL
, 0);