1 /* SPDX-License-Identifier: LGPL-2.1+ */
4 #include <linux/filter.h>
5 #include <linux/netlink.h>
6 #include <sys/socket.h>
11 #include "MurmurHash2.h"
12 #include "alloc-util.h"
13 #include "device-monitor-private.h"
14 #include "device-private.h"
15 #include "device-util.h"
17 #include "format-util.h"
20 #include "mount-util.h"
22 #include "socket-util.h"
23 #include "string-util.h"
26 struct sd_device_monitor
{
30 union sockaddr_union snl
;
31 union sockaddr_union snl_trusted_sender
;
34 Hashmap
*subsystem_filter
;
39 sd_event_source
*event_source
;
40 int64_t event_priority
;
41 sd_device_monitor_handler_t callback
;
45 #define UDEV_MONITOR_MAGIC 0xfeedcafe
47 typedef struct monitor_netlink_header
{
48 /* "libudev" prefix to distinguish libudev and kernel messages */
50 /* Magic to protect against daemon <-> Library message format mismatch
51 * Used in the kernel from socket filter rules; needs to be stored in network order */
53 /* Total length of header structure known to the sender */
55 /* Properties string buffer */
56 unsigned properties_off
;
57 unsigned properties_len
;
58 /* Hashes of primary device properties strings, to let libudev subscribers
59 * use in-kernel socket filters; values need to be stored in network order */
60 unsigned filter_subsystem_hash
;
61 unsigned filter_devtype_hash
;
62 unsigned filter_tag_bloom_hi
;
63 unsigned filter_tag_bloom_lo
;
64 } monitor_netlink_header
;
66 static int monitor_set_nl_address(sd_device_monitor
*m
) {
67 union sockaddr_union snl
;
72 /* Get the address the kernel has assigned us.
73 * It is usually, but not necessarily the pid. */
74 addrlen
= sizeof(struct sockaddr_nl
);
75 if (getsockname(m
->sock
, &snl
.sa
, &addrlen
) < 0)
78 m
->snl
.nl
.nl_pid
= snl
.nl
.nl_pid
;
82 int device_monitor_allow_unicast_sender(sd_device_monitor
*m
, sd_device_monitor
*sender
) {
83 assert_return(m
, -EINVAL
);
84 assert_return(sender
, -EINVAL
);
86 m
->snl_trusted_sender
.nl
.nl_pid
= sender
->snl
.nl
.nl_pid
;
90 _public_
int sd_device_monitor_set_receive_buffer_size(sd_device_monitor
*m
, size_t size
) {
91 int r
, n
= (int) size
;
93 assert_return(m
, -EINVAL
);
94 assert_return((size_t) n
== size
, -EINVAL
);
96 if (setsockopt_int(m
->sock
, SOL_SOCKET
, SO_RCVBUF
, n
) < 0) {
97 r
= setsockopt_int(m
->sock
, SOL_SOCKET
, SO_RCVBUFFORCE
, n
);
105 int device_monitor_disconnect(sd_device_monitor
*m
) {
108 m
->sock
= safe_close(m
->sock
);
112 int device_monitor_get_fd(sd_device_monitor
*m
) {
113 assert_return(m
, -EINVAL
);
118 int device_monitor_new_full(sd_device_monitor
**ret
, MonitorNetlinkGroup group
, int fd
) {
119 _cleanup_(sd_device_monitor_unrefp
) sd_device_monitor
*m
= NULL
;
120 _cleanup_close_
int sock
= -1;
123 assert_return(ret
, -EINVAL
);
124 assert_return(group
>= 0 && group
< _MONITOR_NETLINK_GROUP_MAX
, -EINVAL
);
126 if (group
== MONITOR_GROUP_UDEV
&&
127 access("/run/udev/control", F_OK
) < 0 &&
128 dev_is_devtmpfs() <= 0) {
131 * We do not support subscribing to uevents if no instance of
132 * udev is running. Uevents would otherwise broadcast the
133 * processing data of the host into containers, which is not
136 * Containers will currently not get any udev uevents, until
137 * a supporting infrastructure is available.
139 * We do not set a netlink multicast group here, so the socket
140 * will not receive any messages.
143 log_debug("sd-device-monitor: The udev service seems not to be active, disabling the monitor");
144 group
= MONITOR_GROUP_NONE
;
148 sock
= socket(PF_NETLINK
, SOCK_RAW
|SOCK_CLOEXEC
|SOCK_NONBLOCK
, NETLINK_KOBJECT_UEVENT
);
150 return log_debug_errno(errno
, "sd-device-monitor: Failed to create socket: %m");
153 m
= new(sd_device_monitor
, 1);
157 *m
= (sd_device_monitor
) {
159 .sock
= fd
>= 0 ? fd
: TAKE_FD(sock
),
161 .snl
.nl
.nl_family
= AF_NETLINK
,
162 .snl
.nl
.nl_groups
= group
,
166 r
= monitor_set_nl_address(m
);
168 return log_debug_errno(r
, "sd-device-monitor: Failed to set netlink address: %m");
175 _public_
int sd_device_monitor_new(sd_device_monitor
**ret
) {
176 return device_monitor_new_full(ret
, MONITOR_GROUP_UDEV
, -1);
179 _public_
int sd_device_monitor_stop(sd_device_monitor
*m
) {
180 assert_return(m
, -EINVAL
);
182 m
->event_source
= sd_event_source_unref(m
->event_source
);
183 (void) device_monitor_disconnect(m
);
188 static int device_monitor_event_handler(sd_event_source
*s
, int fd
, uint32_t revents
, void *userdata
) {
189 _cleanup_(sd_device_unrefp
) sd_device
*device
= NULL
;
190 sd_device_monitor
*m
= userdata
;
194 if (device_monitor_receive_device(m
, &device
) <= 0)
198 return m
->callback(m
, device
, m
->userdata
);
203 _public_
int sd_device_monitor_start(sd_device_monitor
*m
, sd_device_monitor_handler_t callback
, void *userdata
, const char *description
) {
204 _cleanup_(sd_event_source_unrefp
) sd_event_source
*s
= NULL
;
207 assert_return(m
, -EINVAL
);
210 r
= sd_device_monitor_attach_event(m
, NULL
, 0);
215 r
= device_monitor_enable_receiving(m
);
219 m
->callback
= callback
;
220 m
->userdata
= userdata
;
222 r
= sd_event_add_io(m
->event
, &s
, m
->sock
, EPOLLIN
, device_monitor_event_handler
, m
);
226 r
= sd_event_source_set_priority(s
, m
->event_priority
);
231 r
= sd_event_source_set_description(s
, description
);
236 m
->event_source
= TAKE_PTR(s
);
241 _public_
int sd_device_monitor_detach_event(sd_device_monitor
*m
) {
242 assert_return(m
, -EINVAL
);
244 (void) sd_device_monitor_stop(m
);
245 m
->event
= sd_event_unref(m
->event
);
250 _public_
int sd_device_monitor_attach_event(sd_device_monitor
*m
, sd_event
*event
, int64_t priority
) {
253 assert_return(m
, -EINVAL
);
254 assert_return(!m
->event
, -EBUSY
);
257 m
->event
= sd_event_ref(event
);
259 r
= sd_event_default(&m
->event
);
264 m
->event_priority
= priority
;
269 _public_ sd_event
*sd_device_monitor_get_event(sd_device_monitor
*m
) {
270 assert_return(m
, NULL
);
275 _public_ sd_event_source
*sd_device_monitor_get_event_source(sd_device_monitor
*m
) {
276 assert_return(m
, NULL
);
278 return m
->event_source
;
281 int device_monitor_enable_receiving(sd_device_monitor
*m
) {
284 assert_return(m
, -EINVAL
);
286 if (!m
->filter_uptodate
) {
287 r
= sd_device_monitor_filter_update(m
);
289 return log_debug_errno(r
, "sd-device-monitor: Failed to update filter: %m");
293 if (bind(m
->sock
, &m
->snl
.sa
, sizeof(struct sockaddr_nl
)) < 0)
294 return log_debug_errno(errno
, "sd-device-monitor: Failed to bind monitoring socket to event source: %m");
299 r
= monitor_set_nl_address(m
);
301 return log_debug_errno(r
, "sd-device-monitor: Failed to set address: %m");
303 /* enable receiving of sender credentials */
304 r
= setsockopt_int(m
->sock
, SOL_SOCKET
, SO_PASSCRED
, true);
306 return log_debug_errno(r
, "sd-device-monitor: Failed to set socket option SO_PASSCRED: %m");
311 static sd_device_monitor
*device_monitor_free(sd_device_monitor
*m
) {
314 (void) sd_device_monitor_detach_event(m
);
316 hashmap_free_free_free(m
->subsystem_filter
);
317 set_free_free(m
->tag_filter
);
322 DEFINE_PUBLIC_TRIVIAL_REF_UNREF_FUNC(sd_device_monitor
, sd_device_monitor
, device_monitor_free
);
324 static int passes_filter(sd_device_monitor
*m
, sd_device
*device
) {
325 const char *tag
, *subsystem
, *devtype
, *s
, *d
= NULL
;
329 assert_return(m
, -EINVAL
);
330 assert_return(device
, -EINVAL
);
332 if (hashmap_isempty(m
->subsystem_filter
))
335 r
= sd_device_get_subsystem(device
, &s
);
339 r
= sd_device_get_devtype(device
, &d
);
340 if (r
< 0 && r
!= -ENOENT
)
343 HASHMAP_FOREACH_KEY(devtype
, subsystem
, m
->subsystem_filter
, i
) {
344 if (!streq(s
, subsystem
))
353 if (streq(d
, devtype
))
360 if (set_isempty(m
->tag_filter
))
363 SET_FOREACH(tag
, m
->tag_filter
, i
)
364 if (sd_device_has_tag(device
, tag
) > 0)
370 int device_monitor_receive_device(sd_device_monitor
*m
, sd_device
**ret
) {
371 _cleanup_(sd_device_unrefp
) sd_device
*device
= NULL
;
373 monitor_netlink_header nlh
;
378 .iov_len
= sizeof(buf
)
380 char cred_msg
[CMSG_SPACE(sizeof(struct ucred
))];
381 union sockaddr_union snl
;
382 struct msghdr smsg
= {
385 .msg_control
= cred_msg
,
386 .msg_controllen
= sizeof(cred_msg
),
388 .msg_namelen
= sizeof(snl
),
390 struct cmsghdr
*cmsg
;
392 ssize_t buflen
, bufpos
;
393 bool is_initialized
= false;
398 buflen
= recvmsg(m
->sock
, &smsg
, 0);
401 log_debug_errno(errno
, "sd-device-monitor: Failed to receive message: %m");
405 if (buflen
< 32 || (smsg
.msg_flags
& MSG_TRUNC
))
406 return log_debug_errno(EINVAL
, "sd-device-monitor: Invalid message length.");
408 if (snl
.nl
.nl_groups
== MONITOR_GROUP_NONE
) {
409 /* unicast message, check if we trust the sender */
410 if (m
->snl_trusted_sender
.nl
.nl_pid
== 0 ||
411 snl
.nl
.nl_pid
!= m
->snl_trusted_sender
.nl
.nl_pid
)
412 return log_debug_errno(EAGAIN
, "sd-device-monitor: Unicast netlink message ignored.");
414 } else if (snl
.nl
.nl_groups
== MONITOR_GROUP_KERNEL
) {
415 if (snl
.nl
.nl_pid
> 0)
416 return log_debug_errno(EAGAIN
, "sd-device-monitor: Multicast kernel netlink message from PID %"PRIu32
" ignored.", snl
.nl
.nl_pid
);
419 cmsg
= CMSG_FIRSTHDR(&smsg
);
420 if (!cmsg
|| cmsg
->cmsg_type
!= SCM_CREDENTIALS
)
421 return log_debug_errno(EAGAIN
, "sd-device-monitor: No sender credentials received, message ignored.");
423 cred
= (struct ucred
*) CMSG_DATA(cmsg
);
425 return log_debug_errno(EAGAIN
, "sd-device-monitor: Sender uid="UID_FMT
", message ignored.", cred
->uid
);
427 if (streq(buf
.raw
, "libudev")) {
428 /* udev message needs proper version magic */
429 if (buf
.nlh
.magic
!= htobe32(UDEV_MONITOR_MAGIC
))
430 return log_debug_errno(EAGAIN
, "sd-device-monitor: Invalid message signature (%x != %x)",
431 buf
.nlh
.magic
, htobe32(UDEV_MONITOR_MAGIC
));
433 if (buf
.nlh
.properties_off
+32 > (size_t) buflen
)
434 return log_debug_errno(EAGAIN
, "sd-device-monitor: Invalid message length (%u > %zd)",
435 buf
.nlh
.properties_off
+32, buflen
);
437 bufpos
= buf
.nlh
.properties_off
;
439 /* devices received from udev are always initialized */
440 is_initialized
= true;
443 /* kernel message with header */
444 bufpos
= strlen(buf
.raw
) + 1;
445 if ((size_t) bufpos
< sizeof("a@/d") || bufpos
>= buflen
)
446 return log_debug_errno(EAGAIN
, "sd-device-monitor: Invalid message length");
448 /* check message header */
449 if (!strstr(buf
.raw
, "@/"))
450 return log_debug_errno(EAGAIN
, "sd-device-monitor: Invalid message header");
453 r
= device_new_from_nulstr(&device
, (uint8_t*) &buf
.raw
[bufpos
], buflen
- bufpos
);
455 return log_debug_errno(r
, "sd-device-monitor: Failed to create device from received message: %m");
458 device_set_is_initialized(device
);
460 /* Skip device, if it does not pass the current filter */
461 r
= passes_filter(m
, device
);
463 return log_device_debug_errno(device
, r
, "sd-device-monitor: Failed to check received device passing filter: %m");
465 log_device_debug(device
, "sd-device-monitor: Received device does not pass filter, ignoring");
467 *ret
= TAKE_PTR(device
);
472 static uint32_t string_hash32(const char *str
) {
473 return MurmurHash2(str
, strlen(str
), 0);
476 /* Get a bunch of bit numbers out of the hash, and set the bits in our bit field */
477 static uint64_t string_bloom64(const char *str
) {
479 uint32_t hash
= string_hash32(str
);
481 bits
|= 1LLU << (hash
& 63);
482 bits
|= 1LLU << ((hash
>> 6) & 63);
483 bits
|= 1LLU << ((hash
>> 12) & 63);
484 bits
|= 1LLU << ((hash
>> 18) & 63);
488 int device_monitor_send_device(
489 sd_device_monitor
*m
,
490 sd_device_monitor
*destination
,
493 monitor_netlink_header nlh
= {
495 .magic
= htobe32(UDEV_MONITOR_MAGIC
),
496 .header_size
= sizeof nlh
,
498 struct iovec iov
[2] = {
499 { .iov_base
= &nlh
, .iov_len
= sizeof nlh
},
501 struct msghdr smsg
= {
505 /* default destination for sending */
506 union sockaddr_union default_destination
= {
507 .nl
.nl_family
= AF_NETLINK
,
508 .nl
.nl_groups
= MONITOR_GROUP_UDEV
,
510 uint64_t tag_bloom_bits
;
511 const char *buf
, *val
;
519 r
= device_get_properties_nulstr(device
, (const uint8_t **) &buf
, &blen
);
521 return log_device_debug_errno(device
, r
, "sd-device-monitor: Failed to get device properties: %m");
523 log_device_debug(device
, "sd-device-monitor: Length of device property nulstr is too small to contain valid device information");
527 /* fill in versioned header */
528 r
= sd_device_get_subsystem(device
, &val
);
530 return log_device_debug_errno(device
, r
, "sd-device-monitor: Failed to get device subsystem: %m");
531 nlh
.filter_subsystem_hash
= htobe32(string_hash32(val
));
533 if (sd_device_get_devtype(device
, &val
) >= 0)
534 nlh
.filter_devtype_hash
= htobe32(string_hash32(val
));
536 /* add tag bloom filter */
538 FOREACH_DEVICE_TAG(device
, val
)
539 tag_bloom_bits
|= string_bloom64(val
);
541 if (tag_bloom_bits
> 0) {
542 nlh
.filter_tag_bloom_hi
= htobe32(tag_bloom_bits
>> 32);
543 nlh
.filter_tag_bloom_lo
= htobe32(tag_bloom_bits
& 0xffffffff);
546 /* add properties list */
547 nlh
.properties_off
= iov
[0].iov_len
;
548 nlh
.properties_len
= blen
;
549 iov
[1] = (struct iovec
) {
550 .iov_base
= (char*) buf
,
555 * Use custom address for target, or the default one.
557 * If we send to a multicast group, we will get
558 * ECONNREFUSED, which is expected.
560 smsg
.msg_name
= destination
? &destination
->snl
: &default_destination
;
561 smsg
.msg_namelen
= sizeof(struct sockaddr_nl
);
562 count
= sendmsg(m
->sock
, &smsg
, 0);
564 if (!destination
&& errno
== ECONNREFUSED
) {
565 log_device_debug(device
, "sd-device-monitor: Passed to netlink monitor");
568 return log_device_debug_errno(device
, errno
, "sd-device-monitor: Failed to send device to netlink monitor: %m");
571 log_device_debug(device
, "sd-device-monitor: Passed %zi byte to netlink monitor", count
);
575 static void bpf_stmt(struct sock_filter
*ins
, unsigned *i
,
576 unsigned short code
, unsigned data
) {
577 ins
[(*i
)++] = (struct sock_filter
) {
583 static void bpf_jmp(struct sock_filter
*ins
, unsigned *i
,
584 unsigned short code
, unsigned data
,
585 unsigned short jt
, unsigned short jf
) {
586 ins
[(*i
)++] = (struct sock_filter
) {
594 _public_
int sd_device_monitor_filter_update(sd_device_monitor
*m
) {
595 struct sock_filter ins
[512] = {};
596 struct sock_fprog filter
;
597 const char *subsystem
, *devtype
, *tag
;
601 assert_return(m
, -EINVAL
);
603 if (hashmap_isempty(m
->subsystem_filter
) &&
604 set_isempty(m
->tag_filter
)) {
605 m
->filter_uptodate
= true;
609 /* load magic in A */
610 bpf_stmt(ins
, &i
, BPF_LD
|BPF_W
|BPF_ABS
, offsetof(monitor_netlink_header
, magic
));
611 /* jump if magic matches */
612 bpf_jmp(ins
, &i
, BPF_JMP
|BPF_JEQ
|BPF_K
, UDEV_MONITOR_MAGIC
, 1, 0);
613 /* wrong magic, pass packet */
614 bpf_stmt(ins
, &i
, BPF_RET
|BPF_K
, 0xffffffff);
616 if (!set_isempty(m
->tag_filter
)) {
617 int tag_matches
= set_size(m
->tag_filter
);
619 /* add all tags matches */
620 SET_FOREACH(tag
, m
->tag_filter
, it
) {
621 uint64_t tag_bloom_bits
= string_bloom64(tag
);
622 uint32_t tag_bloom_hi
= tag_bloom_bits
>> 32;
623 uint32_t tag_bloom_lo
= tag_bloom_bits
& 0xffffffff;
625 /* load device bloom bits in A */
626 bpf_stmt(ins
, &i
, BPF_LD
|BPF_W
|BPF_ABS
, offsetof(monitor_netlink_header
, filter_tag_bloom_hi
));
627 /* clear bits (tag bits & bloom bits) */
628 bpf_stmt(ins
, &i
, BPF_ALU
|BPF_AND
|BPF_K
, tag_bloom_hi
);
629 /* jump to next tag if it does not match */
630 bpf_jmp(ins
, &i
, BPF_JMP
|BPF_JEQ
|BPF_K
, tag_bloom_hi
, 0, 3);
632 /* load device bloom bits in A */
633 bpf_stmt(ins
, &i
, BPF_LD
|BPF_W
|BPF_ABS
, offsetof(monitor_netlink_header
, filter_tag_bloom_lo
));
634 /* clear bits (tag bits & bloom bits) */
635 bpf_stmt(ins
, &i
, BPF_ALU
|BPF_AND
|BPF_K
, tag_bloom_lo
);
636 /* jump behind end of tag match block if tag matches */
638 bpf_jmp(ins
, &i
, BPF_JMP
|BPF_JEQ
|BPF_K
, tag_bloom_lo
, 1 + (tag_matches
* 6), 0);
641 /* nothing matched, drop packet */
642 bpf_stmt(ins
, &i
, BPF_RET
|BPF_K
, 0);
645 /* add all subsystem matches */
646 if (!hashmap_isempty(m
->subsystem_filter
)) {
647 HASHMAP_FOREACH_KEY(devtype
, subsystem
, m
->subsystem_filter
, it
) {
648 uint32_t hash
= string_hash32(subsystem
);
650 /* load device subsystem value in A */
651 bpf_stmt(ins
, &i
, BPF_LD
|BPF_W
|BPF_ABS
, offsetof(monitor_netlink_header
, filter_subsystem_hash
));
653 /* jump if subsystem does not match */
654 bpf_jmp(ins
, &i
, BPF_JMP
|BPF_JEQ
|BPF_K
, hash
, 0, 1);
656 hash
= string_hash32(devtype
);
658 /* jump if subsystem does not match */
659 bpf_jmp(ins
, &i
, BPF_JMP
|BPF_JEQ
|BPF_K
, hash
, 0, 3);
660 /* load device devtype value in A */
661 bpf_stmt(ins
, &i
, BPF_LD
|BPF_W
|BPF_ABS
, offsetof(monitor_netlink_header
, filter_devtype_hash
));
662 /* jump if value does not match */
663 bpf_jmp(ins
, &i
, BPF_JMP
|BPF_JEQ
|BPF_K
, hash
, 0, 1);
666 /* matched, pass packet */
667 bpf_stmt(ins
, &i
, BPF_RET
|BPF_K
, 0xffffffff);
669 if (i
+1 >= ELEMENTSOF(ins
))
673 /* nothing matched, drop packet */
674 bpf_stmt(ins
, &i
, BPF_RET
|BPF_K
, 0);
677 /* matched, pass packet */
678 bpf_stmt(ins
, &i
, BPF_RET
|BPF_K
, 0xffffffff);
681 filter
= (struct sock_fprog
) {
685 if (setsockopt(m
->sock
, SOL_SOCKET
, SO_ATTACH_FILTER
, &filter
, sizeof(filter
)) < 0)
688 m
->filter_uptodate
= true;
692 _public_
int sd_device_monitor_filter_add_match_subsystem_devtype(sd_device_monitor
*m
, const char *subsystem
, const char *devtype
) {
693 _cleanup_free_
char *s
= NULL
, *d
= NULL
;
696 assert_return(m
, -EINVAL
);
697 assert_return(subsystem
, -EINVAL
);
699 s
= strdup(subsystem
);
709 r
= hashmap_ensure_allocated(&m
->subsystem_filter
, NULL
);
713 r
= hashmap_put(m
->subsystem_filter
, s
, d
);
718 m
->filter_uptodate
= false;
723 _public_
int sd_device_monitor_filter_add_match_tag(sd_device_monitor
*m
, const char *tag
) {
724 _cleanup_free_
char *t
= NULL
;
727 assert_return(m
, -EINVAL
);
728 assert_return(tag
, -EINVAL
);
734 r
= set_ensure_allocated(&m
->tag_filter
, &string_hash_ops
);
738 r
= set_put(m
->tag_filter
, t
);
745 m
->filter_uptodate
= false;
750 _public_
int sd_device_monitor_filter_remove(sd_device_monitor
*m
) {
751 static const struct sock_fprog filter
= { 0, NULL
};
753 assert_return(m
, -EINVAL
);
755 m
->subsystem_filter
= hashmap_free_free_free(m
->subsystem_filter
);
756 m
->tag_filter
= set_free_free(m
->tag_filter
);
758 if (setsockopt(m
->sock
, SOL_SOCKET
, SO_ATTACH_FILTER
, &filter
, sizeof(filter
)) < 0)
761 m
->filter_uptodate
= true;