]> git.ipfire.org Git - thirdparty/systemd.git/blame - src/libudev/libudev-monitor.c
update TODO
[thirdparty/systemd.git] / src / libudev / libudev-monitor.c
CommitLineData
88a6477e
KS
1/***
2 This file is part of systemd.
3
4 Copyright 2008-2012 Kay Sievers <kay@vrfy.org>
5
6 systemd is free software; you can redistribute it and/or modify it
7 under the terms of the GNU Lesser General Public License as published by
8 the Free Software Foundation; either version 2.1 of the License, or
9 (at your option) any later version.
10
11 systemd is distributed in the hope that it will be useful, but
12 WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 Lesser General Public License for more details.
15
16 You should have received a copy of the GNU Lesser General Public License
17 along with systemd; If not, see <http://www.gnu.org/licenses/>.
18***/
ba6929f6 19
07630cea
LP
20#include <errno.h>
21#include <linux/filter.h>
22#include <linux/netlink.h>
23#include <poll.h>
24#include <stddef.h>
ba6929f6
KS
25#include <stdio.h>
26#include <stdlib.h>
ba6929f6 27#include <string.h>
ba6929f6 28#include <sys/socket.h>
07630cea 29#include <unistd.h>
ba6929f6
KS
30
31#include "libudev.h"
07630cea 32
b5efdb8a 33#include "alloc-util.h"
3ffd4af2 34#include "fd-util.h"
0d39fa9c 35#include "fileio.h"
07630cea 36#include "formats-util.h"
ba6929f6 37#include "libudev-private.h"
df32a1ca 38#include "missing.h"
07630cea
LP
39#include "socket-util.h"
40#include "string-util.h"
ba6929f6 41
ce1d6d7f
KS
42/**
43 * SECTION:libudev-monitor
44 * @short_description: device event source
45 *
46 * Connects to a device event source.
47 */
48
ce1d6d7f
KS
49/**
50 * udev_monitor:
51 *
50579295 52 * Opaque object handling an event source.
ce1d6d7f 53 */
ba6929f6 54struct udev_monitor {
912541b0
KS
55 struct udev *udev;
56 int refcount;
57 int sock;
b49d9b50
KS
58 union sockaddr_union snl;
59 union sockaddr_union snl_trusted_sender;
60 union sockaddr_union snl_destination;
912541b0
KS
61 socklen_t addrlen;
62 struct udev_list filter_subsystem_list;
63 struct udev_list filter_tag_list;
64 bool bound;
ba6929f6
KS
65};
66
f2b93744 67enum udev_monitor_netlink_group {
912541b0
KS
68 UDEV_MONITOR_NONE,
69 UDEV_MONITOR_KERNEL,
70 UDEV_MONITOR_UDEV,
f2b93744
KS
71};
72
912541b0 73#define UDEV_MONITOR_MAGIC 0xfeedcafe
e14bdd88 74struct udev_monitor_netlink_header {
912541b0
KS
75 /* "libudev" prefix to distinguish libudev and kernel messages */
76 char prefix[8];
77 /*
78 * magic to protect against daemon <-> library message format mismatch
79 * used in the kernel from socket filter rules; needs to be stored in network order
80 */
81 unsigned int magic;
82 /* total length of header structure known to the sender */
83 unsigned int header_size;
84 /* properties string buffer */
85 unsigned int properties_off;
86 unsigned int properties_len;
87 /*
88 * hashes of primary device properties strings, to let libudev subscribers
89 * use in-kernel socket filters; values need to be stored in network order
90 */
91 unsigned int filter_subsystem_hash;
92 unsigned int filter_devtype_hash;
93 unsigned int filter_tag_bloom_hi;
94 unsigned int filter_tag_bloom_lo;
e14bdd88
KS
95};
96
97static struct udev_monitor *udev_monitor_new(struct udev *udev)
98{
912541b0
KS
99 struct udev_monitor *udev_monitor;
100
955d98c9 101 udev_monitor = new0(struct udev_monitor, 1);
912541b0
KS
102 if (udev_monitor == NULL)
103 return NULL;
104 udev_monitor->refcount = 1;
105 udev_monitor->udev = udev;
106 udev_list_init(udev, &udev_monitor->filter_subsystem_list, false);
107 udev_list_init(udev, &udev_monitor->filter_tag_list, true);
108 return udev_monitor;
e14bdd88
KS
109}
110
df32a1ca
KS
111/* we consider udev running when /dev is on devtmpfs */
112static bool udev_has_devtmpfs(struct udev *udev) {
21749924 113
2695c5c4 114 union file_handle_union h = FILE_HANDLE_INIT;
df32a1ca
KS
115 _cleanup_fclose_ FILE *f = NULL;
116 char line[LINE_MAX], *e;
21749924 117 int mount_id;
df32a1ca
KS
118 int r;
119
370c860f 120 r = name_to_handle_at(AT_FDCWD, "/dev", &h.handle, &mount_id, 0);
e6c47472
ZJS
121 if (r < 0) {
122 if (errno != EOPNOTSUPP)
56f64d95 123 log_debug_errno(errno, "name_to_handle_at on /dev: %m");
df32a1ca 124 return false;
e6c47472 125 }
df32a1ca 126
df32a1ca
KS
127 f = fopen("/proc/self/mountinfo", "re");
128 if (!f)
129 return false;
130
131 FOREACH_LINE(line, f, return false) {
df32a1ca
KS
132 int mid;
133
134 if (sscanf(line, "%i", &mid) != 1)
135 continue;
136
137 if (mid != mount_id)
138 continue;
139
140 e = strstr(line, " - ");
141 if (!e)
142 continue;
143
144 /* accept any name that starts with the currently expected type */
145 if (startswith(e + 3, "devtmpfs"))
146 return true;
147 }
148
149 return false;
150}
151
44daf75d
TG
152static void monitor_set_nl_address(struct udev_monitor *udev_monitor) {
153 union sockaddr_union snl;
154 socklen_t addrlen;
155 int r;
156
157 assert(udev_monitor);
158
159 /* get the address the kernel has assigned us
160 * it is usually, but not necessarily the pid
161 */
162 addrlen = sizeof(struct sockaddr_nl);
163 r = getsockname(udev_monitor->sock, &snl.sa, &addrlen);
164 if (r >= 0)
165 udev_monitor->snl.nl.nl_pid = snl.nl.nl_pid;
166}
167
7459bcdc 168struct udev_monitor *udev_monitor_new_from_netlink_fd(struct udev *udev, const char *name, int fd)
1c7047ea 169{
912541b0
KS
170 struct udev_monitor *udev_monitor;
171 unsigned int group;
172
173 if (udev == NULL)
174 return NULL;
175
176 if (name == NULL)
177 group = UDEV_MONITOR_NONE;
e8a3b2dc
KS
178 else if (streq(name, "udev")) {
179 /*
180 * We do not support subscribing to uevents if no instance of
181 * udev is running. Uevents would otherwise broadcast the
182 * processing data of the host into containers, which is not
183 * desired.
184 *
185 * Containers will currently not get any udev uevents, until
186 * a supporting infrastructure is available.
187 *
188 * We do not set a netlink multicast group here, so the socket
189 * will not receive any messages.
190 */
9ea28c55 191 if (access("/run/udev/control", F_OK) < 0 && !udev_has_devtmpfs(udev)) {
ff49bc32 192 log_debug("the udev service seems not to be active, disable the monitor");
e8a3b2dc
KS
193 group = UDEV_MONITOR_NONE;
194 } else
195 group = UDEV_MONITOR_UDEV;
196 } else if (streq(name, "kernel"))
912541b0
KS
197 group = UDEV_MONITOR_KERNEL;
198 else
199 return NULL;
200
201 udev_monitor = udev_monitor_new(udev);
202 if (udev_monitor == NULL)
203 return NULL;
204
205 if (fd < 0) {
206 udev_monitor->sock = socket(PF_NETLINK, SOCK_RAW|SOCK_CLOEXEC|SOCK_NONBLOCK, NETLINK_KOBJECT_UEVENT);
44daf75d 207 if (udev_monitor->sock < 0) {
56f64d95 208 log_debug_errno(errno, "error getting socket: %m");
912541b0
KS
209 free(udev_monitor);
210 return NULL;
211 }
212 } else {
213 udev_monitor->bound = true;
214 udev_monitor->sock = fd;
44daf75d 215 monitor_set_nl_address(udev_monitor);
912541b0
KS
216 }
217
b49d9b50
KS
218 udev_monitor->snl.nl.nl_family = AF_NETLINK;
219 udev_monitor->snl.nl.nl_groups = group;
912541b0
KS
220
221 /* default destination for sending */
b49d9b50
KS
222 udev_monitor->snl_destination.nl.nl_family = AF_NETLINK;
223 udev_monitor->snl_destination.nl.nl_groups = UDEV_MONITOR_UDEV;
912541b0 224
912541b0 225 return udev_monitor;
1c7047ea
KS
226}
227
7459bcdc
KS
228/**
229 * udev_monitor_new_from_netlink:
230 * @udev: udev library context
231 * @name: name of event source
232 *
233 * Create new udev monitor and connect to a specified event
234 * source. Valid sources identifiers are "udev" and "kernel".
235 *
236 * Applications should usually not connect directly to the
237 * "kernel" events, because the devices might not be useable
238 * at that time, before udev has configured them, and created
50579295
KS
239 * device nodes. Accessing devices at the same time as udev,
240 * might result in unpredictable behavior. The "udev" events
241 * are sent out after udev has finished its event processing,
242 * all rules have been processed, and needed device nodes are
243 * created.
7459bcdc
KS
244 *
245 * The initial refcount is 1, and needs to be decremented to
246 * release the resources of the udev monitor.
247 *
248 * Returns: a new udev monitor, or #NULL, in case of an error
249 **/
54cf0b7f 250_public_ struct udev_monitor *udev_monitor_new_from_netlink(struct udev *udev, const char *name)
7459bcdc 251{
912541b0 252 return udev_monitor_new_from_netlink_fd(udev, name, -1);
7459bcdc
KS
253}
254
e14bdd88 255static inline void bpf_stmt(struct sock_filter *inss, unsigned int *i,
912541b0 256 unsigned short code, unsigned int data)
e14bdd88 257{
912541b0 258 struct sock_filter *ins = &inss[*i];
e14bdd88 259
912541b0
KS
260 ins->code = code;
261 ins->k = data;
262 (*i)++;
e14bdd88
KS
263}
264
265static inline void bpf_jmp(struct sock_filter *inss, unsigned int *i,
912541b0
KS
266 unsigned short code, unsigned int data,
267 unsigned short jt, unsigned short jf)
e14bdd88 268{
912541b0 269 struct sock_filter *ins = &inss[*i];
e14bdd88 270
912541b0
KS
271 ins->code = code;
272 ins->jt = jt;
273 ins->jf = jf;
274 ins->k = data;
275 (*i)++;
e14bdd88
KS
276}
277
ce1d6d7f
KS
278/**
279 * udev_monitor_filter_update:
280 * @udev_monitor: monitor
281 *
50579295
KS
282 * Update the installed socket filter. This is only needed,
283 * if the filter was removed or changed.
ce1d6d7f
KS
284 *
285 * Returns: 0 on success, otherwise a negative error value.
286 */
54cf0b7f 287_public_ int udev_monitor_filter_update(struct udev_monitor *udev_monitor)
e14bdd88 288{
912541b0
KS
289 struct sock_filter ins[512];
290 struct sock_fprog filter;
291 unsigned int i;
292 struct udev_list_entry *list_entry;
293 int err;
294
295 if (udev_list_get_entry(&udev_monitor->filter_subsystem_list) == NULL &&
296 udev_list_get_entry(&udev_monitor->filter_tag_list) == NULL)
297 return 0;
298
29804cc1 299 memzero(ins, sizeof(ins));
912541b0
KS
300 i = 0;
301
302 /* load magic in A */
303 bpf_stmt(ins, &i, BPF_LD|BPF_W|BPF_ABS, offsetof(struct udev_monitor_netlink_header, magic));
304 /* jump if magic matches */
305 bpf_jmp(ins, &i, BPF_JMP|BPF_JEQ|BPF_K, UDEV_MONITOR_MAGIC, 1, 0);
306 /* wrong magic, pass packet */
307 bpf_stmt(ins, &i, BPF_RET|BPF_K, 0xffffffff);
308
309 if (udev_list_get_entry(&udev_monitor->filter_tag_list) != NULL) {
310 int tag_matches;
311
312 /* count tag matches, to calculate end of tag match block */
313 tag_matches = 0;
314 udev_list_entry_foreach(list_entry, udev_list_get_entry(&udev_monitor->filter_tag_list))
315 tag_matches++;
316
317 /* add all tags matches */
318 udev_list_entry_foreach(list_entry, udev_list_get_entry(&udev_monitor->filter_tag_list)) {
319 uint64_t tag_bloom_bits = util_string_bloom64(udev_list_entry_get_name(list_entry));
320 uint32_t tag_bloom_hi = tag_bloom_bits >> 32;
321 uint32_t tag_bloom_lo = tag_bloom_bits & 0xffffffff;
322
323 /* load device bloom bits in A */
324 bpf_stmt(ins, &i, BPF_LD|BPF_W|BPF_ABS, offsetof(struct udev_monitor_netlink_header, filter_tag_bloom_hi));
325 /* clear bits (tag bits & bloom bits) */
326 bpf_stmt(ins, &i, BPF_ALU|BPF_AND|BPF_K, tag_bloom_hi);
327 /* jump to next tag if it does not match */
328 bpf_jmp(ins, &i, BPF_JMP|BPF_JEQ|BPF_K, tag_bloom_hi, 0, 3);
329
330 /* load device bloom bits in A */
331 bpf_stmt(ins, &i, BPF_LD|BPF_W|BPF_ABS, offsetof(struct udev_monitor_netlink_header, filter_tag_bloom_lo));
332 /* clear bits (tag bits & bloom bits) */
333 bpf_stmt(ins, &i, BPF_ALU|BPF_AND|BPF_K, tag_bloom_lo);
334 /* jump behind end of tag match block if tag matches */
335 tag_matches--;
336 bpf_jmp(ins, &i, BPF_JMP|BPF_JEQ|BPF_K, tag_bloom_lo, 1 + (tag_matches * 6), 0);
337 }
338
339 /* nothing matched, drop packet */
340 bpf_stmt(ins, &i, BPF_RET|BPF_K, 0);
341 }
342
343 /* add all subsystem matches */
344 if (udev_list_get_entry(&udev_monitor->filter_subsystem_list) != NULL) {
345 udev_list_entry_foreach(list_entry, udev_list_get_entry(&udev_monitor->filter_subsystem_list)) {
346 unsigned int hash = util_string_hash32(udev_list_entry_get_name(list_entry));
347
348 /* load device subsystem value in A */
349 bpf_stmt(ins, &i, BPF_LD|BPF_W|BPF_ABS, offsetof(struct udev_monitor_netlink_header, filter_subsystem_hash));
350 if (udev_list_entry_get_value(list_entry) == NULL) {
351 /* jump if subsystem does not match */
352 bpf_jmp(ins, &i, BPF_JMP|BPF_JEQ|BPF_K, hash, 0, 1);
353 } else {
354 /* jump if subsystem does not match */
355 bpf_jmp(ins, &i, BPF_JMP|BPF_JEQ|BPF_K, hash, 0, 3);
356
357 /* load device devtype value in A */
358 bpf_stmt(ins, &i, BPF_LD|BPF_W|BPF_ABS, offsetof(struct udev_monitor_netlink_header, filter_devtype_hash));
359 /* jump if value does not match */
360 hash = util_string_hash32(udev_list_entry_get_value(list_entry));
361 bpf_jmp(ins, &i, BPF_JMP|BPF_JEQ|BPF_K, hash, 0, 1);
362 }
363
364 /* matched, pass packet */
365 bpf_stmt(ins, &i, BPF_RET|BPF_K, 0xffffffff);
366
8fef0ff2 367 if (i+1 >= ELEMENTSOF(ins))
994e0234 368 return -E2BIG;
912541b0
KS
369 }
370
371 /* nothing matched, drop packet */
372 bpf_stmt(ins, &i, BPF_RET|BPF_K, 0);
373 }
374
375 /* matched, pass packet */
376 bpf_stmt(ins, &i, BPF_RET|BPF_K, 0xffffffff);
377
378 /* install filter */
29804cc1 379 memzero(&filter, sizeof(filter));
912541b0
KS
380 filter.len = i;
381 filter.filter = ins;
382 err = setsockopt(udev_monitor->sock, SOL_SOCKET, SO_ATTACH_FILTER, &filter, sizeof(filter));
994e0234 383 return err < 0 ? -errno : 0;
e14bdd88
KS
384}
385
1e03b754
KS
386int udev_monitor_allow_unicast_sender(struct udev_monitor *udev_monitor, struct udev_monitor *sender)
387{
b49d9b50 388 udev_monitor->snl_trusted_sender.nl.nl_pid = sender->snl.nl.nl_pid;
912541b0 389 return 0;
1e03b754 390}
44daf75d 391
ce1d6d7f
KS
392/**
393 * udev_monitor_enable_receiving:
394 * @udev_monitor: the monitor which should receive events
395 *
396 * Binds the @udev_monitor socket to the event source.
397 *
398 * Returns: 0 on success, otherwise a negative error value.
399 */
54cf0b7f 400_public_ int udev_monitor_enable_receiving(struct udev_monitor *udev_monitor)
d59f11e1 401{
912541b0
KS
402 int err = 0;
403 const int on = 1;
404
2d13da88
KS
405 udev_monitor_filter_update(udev_monitor);
406
407 if (!udev_monitor->bound) {
408 err = bind(udev_monitor->sock,
b49d9b50 409 &udev_monitor->snl.sa, sizeof(struct sockaddr_nl));
2d13da88
KS
410 if (err == 0)
411 udev_monitor->bound = true;
912541b0
KS
412 }
413
44daf75d
TG
414 if (err >= 0)
415 monitor_set_nl_address(udev_monitor);
416 else {
56f64d95 417 log_debug_errno(errno, "bind failed: %m");
994e0234 418 return -errno;
912541b0
KS
419 }
420
421 /* enable receiving of sender credentials */
9dedfe7f
TG
422 err = setsockopt(udev_monitor->sock, SOL_SOCKET, SO_PASSCRED, &on, sizeof(on));
423 if (err < 0)
56f64d95 424 log_debug_errno(errno, "setting SO_PASSCRED failed: %m");
9dedfe7f 425
912541b0 426 return 0;
ba6929f6
KS
427}
428
f712894d
KS
429/**
430 * udev_monitor_set_receive_buffer_size:
431 * @udev_monitor: the monitor which should receive events
432 * @size: the size in bytes
433 *
434 * Set the size of the kernel socket buffer. This call needs the
435 * appropriate privileges to succeed.
436 *
437 * Returns: 0 on success, otherwise -1 on error.
438 */
54cf0b7f 439_public_ int udev_monitor_set_receive_buffer_size(struct udev_monitor *udev_monitor, int size)
cb25a958 440{
912541b0 441 if (udev_monitor == NULL)
994e0234 442 return -EINVAL;
912541b0 443 return setsockopt(udev_monitor->sock, SOL_SOCKET, SO_RCVBUFFORCE, &size, sizeof(size));
cb25a958
KS
444}
445
1e03b754
KS
446int udev_monitor_disconnect(struct udev_monitor *udev_monitor)
447{
912541b0 448 int err;
1e03b754 449
912541b0
KS
450 err = close(udev_monitor->sock);
451 udev_monitor->sock = -1;
994e0234 452 return err < 0 ? -errno : 0;
1e03b754
KS
453}
454
7d8787b3
KS
455/**
456 * udev_monitor_ref:
457 * @udev_monitor: udev monitor
458 *
459 * Take a reference of a udev monitor.
460 *
461 * Returns: the passed udev monitor
462 **/
54cf0b7f 463_public_ struct udev_monitor *udev_monitor_ref(struct udev_monitor *udev_monitor)
ba6929f6 464{
912541b0
KS
465 if (udev_monitor == NULL)
466 return NULL;
467 udev_monitor->refcount++;
468 return udev_monitor;
ba6929f6
KS
469}
470
7d8787b3
KS
471/**
472 * udev_monitor_unref:
473 * @udev_monitor: udev monitor
474 *
ff109b8d 475 * Drop a reference of a udev monitor. If the refcount reaches zero,
be7de409 476 * the bound socket will be closed, and the resources of the monitor
7d8787b3
KS
477 * will be released.
478 *
725d7e6c 479 * Returns: #NULL
7d8787b3 480 **/
20bbd54f 481_public_ struct udev_monitor *udev_monitor_unref(struct udev_monitor *udev_monitor)
ba6929f6 482{
912541b0 483 if (udev_monitor == NULL)
20bbd54f 484 return NULL;
912541b0
KS
485 udev_monitor->refcount--;
486 if (udev_monitor->refcount > 0)
725d7e6c 487 return NULL;
912541b0
KS
488 if (udev_monitor->sock >= 0)
489 close(udev_monitor->sock);
490 udev_list_cleanup(&udev_monitor->filter_subsystem_list);
491 udev_list_cleanup(&udev_monitor->filter_tag_list);
912541b0 492 free(udev_monitor);
20bbd54f 493 return NULL;
ba6929f6
KS
494}
495
7d8787b3
KS
496/**
497 * udev_monitor_get_udev:
498 * @udev_monitor: udev monitor
499 *
b98fd840 500 * Retrieve the udev library context the monitor was created with.
7d8787b3
KS
501 *
502 * Returns: the udev library context
503 **/
54cf0b7f 504_public_ struct udev *udev_monitor_get_udev(struct udev_monitor *udev_monitor)
ba6929f6 505{
912541b0
KS
506 if (udev_monitor == NULL)
507 return NULL;
508 return udev_monitor->udev;
ba6929f6
KS
509}
510
7d8787b3
KS
511/**
512 * udev_monitor_get_fd:
513 * @udev_monitor: udev monitor
514 *
515 * Retrieve the socket file descriptor associated with the monitor.
516 *
517 * Returns: the socket file descriptor
518 **/
54cf0b7f 519_public_ int udev_monitor_get_fd(struct udev_monitor *udev_monitor)
ba6929f6 520{
912541b0 521 if (udev_monitor == NULL)
994e0234 522 return -EINVAL;
912541b0 523 return udev_monitor->sock;
ba6929f6
KS
524}
525
e14bdd88
KS
526static int passes_filter(struct udev_monitor *udev_monitor, struct udev_device *udev_device)
527{
912541b0
KS
528 struct udev_list_entry *list_entry;
529
530 if (udev_list_get_entry(&udev_monitor->filter_subsystem_list) == NULL)
531 goto tag;
532 udev_list_entry_foreach(list_entry, udev_list_get_entry(&udev_monitor->filter_subsystem_list)) {
533 const char *subsys = udev_list_entry_get_name(list_entry);
534 const char *dsubsys = udev_device_get_subsystem(udev_device);
535 const char *devtype;
536 const char *ddevtype;
537
090be865 538 if (!streq(dsubsys, subsys))
912541b0
KS
539 continue;
540
541 devtype = udev_list_entry_get_value(list_entry);
542 if (devtype == NULL)
543 goto tag;
544 ddevtype = udev_device_get_devtype(udev_device);
545 if (ddevtype == NULL)
546 continue;
090be865 547 if (streq(ddevtype, devtype))
912541b0
KS
548 goto tag;
549 }
550 return 0;
28460195
KS
551
552tag:
912541b0
KS
553 if (udev_list_get_entry(&udev_monitor->filter_tag_list) == NULL)
554 return 1;
555 udev_list_entry_foreach(list_entry, udev_list_get_entry(&udev_monitor->filter_tag_list)) {
556 const char *tag = udev_list_entry_get_name(list_entry);
557
558 if (udev_device_has_tag(udev_device, tag))
559 return 1;
560 }
561 return 0;
e14bdd88
KS
562}
563
7d8787b3 564/**
d59f11e1 565 * udev_monitor_receive_device:
7d8787b3
KS
566 * @udev_monitor: udev monitor
567 *
d59f11e1 568 * Receive data from the udev monitor socket, allocate a new udev
b98fd840 569 * device, fill in the received data, and return the device.
7d8787b3 570 *
50579295 571 * Only socket connections with uid=0 are accepted.
7d8787b3 572 *
b30b4260
KS
573 * The monitor socket is by default set to NONBLOCK. A variant of poll() on
574 * the file descriptor returned by udev_monitor_get_fd() should to be used to
575 * wake up when new devices arrive, or alternatively the file descriptor
576 * switched into blocking mode.
577 *
7d8787b3 578 * The initial refcount is 1, and needs to be decremented to
be7de409 579 * release the resources of the udev device.
7d8787b3
KS
580 *
581 * Returns: a new udev device, or #NULL, in case of an error
582 **/
54cf0b7f 583_public_ struct udev_device *udev_monitor_receive_device(struct udev_monitor *udev_monitor)
ba6929f6 584{
912541b0
KS
585 struct udev_device *udev_device;
586 struct msghdr smsg;
587 struct iovec iov;
588 char cred_msg[CMSG_SPACE(sizeof(struct ucred))];
589 struct cmsghdr *cmsg;
b49d9b50 590 union sockaddr_union snl;
912541b0 591 struct ucred *cred;
bf3dd6b1
SL
592 union {
593 struct udev_monitor_netlink_header nlh;
594 char raw[8192];
595 } buf;
912541b0
KS
596 ssize_t buflen;
597 ssize_t bufpos;
2df959ec 598 bool is_initialized = false;
ba6929f6 599
e14bdd88 600retry:
912541b0
KS
601 if (udev_monitor == NULL)
602 return NULL;
912541b0
KS
603 iov.iov_base = &buf;
604 iov.iov_len = sizeof(buf);
29804cc1 605 memzero(&smsg, sizeof(struct msghdr));
912541b0
KS
606 smsg.msg_iov = &iov;
607 smsg.msg_iovlen = 1;
608 smsg.msg_control = cred_msg;
609 smsg.msg_controllen = sizeof(cred_msg);
f6613dd9
KS
610 smsg.msg_name = &snl;
611 smsg.msg_namelen = sizeof(snl);
912541b0 612
a38d9945 613 buflen = recvmsg(udev_monitor->sock, &smsg, 0);
912541b0
KS
614 if (buflen < 0) {
615 if (errno != EINTR)
ff49bc32 616 log_debug("unable to receive message");
912541b0
KS
617 return NULL;
618 }
619
9c89c1ca 620 if (buflen < 32 || (smsg.msg_flags & MSG_TRUNC)) {
ff49bc32 621 log_debug("invalid message length");
912541b0
KS
622 return NULL;
623 }
624
f6613dd9
KS
625 if (snl.nl.nl_groups == 0) {
626 /* unicast message, check if we trust the sender */
627 if (udev_monitor->snl_trusted_sender.nl.nl_pid == 0 ||
628 snl.nl.nl_pid != udev_monitor->snl_trusted_sender.nl.nl_pid) {
ff49bc32 629 log_debug("unicast netlink message ignored");
f6613dd9
KS
630 return NULL;
631 }
632 } else if (snl.nl.nl_groups == UDEV_MONITOR_KERNEL) {
633 if (snl.nl.nl_pid > 0) {
1fa2f38f
ZJS
634 log_debug("multicast kernel netlink message from PID %"PRIu32" ignored",
635 snl.nl.nl_pid);
f6613dd9 636 return NULL;
912541b0
KS
637 }
638 }
639
640 cmsg = CMSG_FIRSTHDR(&smsg);
641 if (cmsg == NULL || cmsg->cmsg_type != SCM_CREDENTIALS) {
ff49bc32 642 log_debug("no sender credentials received, message ignored");
912541b0
KS
643 return NULL;
644 }
645
646 cred = (struct ucred *)CMSG_DATA(cmsg);
647 if (cred->uid != 0) {
1fa2f38f 648 log_debug("sender uid="UID_FMT", message ignored", cred->uid);
912541b0
KS
649 return NULL;
650 }
651
bf3dd6b1 652 if (memcmp(buf.raw, "libudev", 8) == 0) {
912541b0 653 /* udev message needs proper version magic */
bf3dd6b1 654 if (buf.nlh.magic != htonl(UDEV_MONITOR_MAGIC)) {
ff49bc32 655 log_debug("unrecognized message signature (%x != %x)",
bf3dd6b1 656 buf.nlh.magic, htonl(UDEV_MONITOR_MAGIC));
912541b0
KS
657 return NULL;
658 }
bf3dd6b1 659 if (buf.nlh.properties_off+32 > (size_t)buflen) {
e6ac88dd
TG
660 log_debug("message smaller than expected (%u > %zd)",
661 buf.nlh.properties_off+32, buflen);
912541b0 662 return NULL;
f6613dd9
KS
663 }
664
bf3dd6b1 665 bufpos = buf.nlh.properties_off;
f6613dd9
KS
666
667 /* devices received from udev are always initialized */
2df959ec 668 is_initialized = true;
912541b0
KS
669 } else {
670 /* kernel message with header */
bf3dd6b1 671 bufpos = strlen(buf.raw) + 1;
912541b0 672 if ((size_t)bufpos < sizeof("a@/d") || bufpos >= buflen) {
ff49bc32 673 log_debug("invalid message length");
912541b0
KS
674 return NULL;
675 }
676
677 /* check message header */
bf3dd6b1 678 if (strstr(buf.raw, "@/") == NULL) {
ff49bc32 679 log_debug("unrecognized message header");
912541b0
KS
680 return NULL;
681 }
682 }
683
2df959ec 684 udev_device = udev_device_new_from_nulstr(udev_monitor->udev, &buf.raw[bufpos], buflen - bufpos);
e6ac88dd
TG
685 if (!udev_device) {
686 log_debug("could not create device: %m");
912541b0 687 return NULL;
e6ac88dd 688 }
2df959ec
TG
689
690 if (is_initialized)
691 udev_device_set_is_initialized(udev_device);
912541b0
KS
692
693 /* skip device, if it does not pass the current filter */
694 if (!passes_filter(udev_monitor, udev_device)) {
695 struct pollfd pfd[1];
696 int rc;
697
698 udev_device_unref(udev_device);
699
700 /* if something is queued, get next device */
701 pfd[0].fd = udev_monitor->sock;
702 pfd[0].events = POLLIN;
703 rc = poll(pfd, 1, 0);
704 if (rc > 0)
705 goto retry;
706 return NULL;
707 }
708
709 return udev_device;
ba6929f6 710}
9925ab04 711
1e03b754 712int udev_monitor_send_device(struct udev_monitor *udev_monitor,
912541b0 713 struct udev_monitor *destination, struct udev_device *udev_device)
9925ab04 714{
81b9fe54
ZJS
715 const char *buf, *val;
716 ssize_t blen, count;
717 struct udev_monitor_netlink_header nlh = {
718 .prefix = "libudev",
719 .magic = htonl(UDEV_MONITOR_MAGIC),
720 .header_size = sizeof nlh,
721 };
722 struct iovec iov[2] = {
723 { .iov_base = &nlh, .iov_len = sizeof nlh },
724 };
725 struct msghdr smsg = {
726 .msg_iov = iov,
727 .msg_iovlen = 2,
728 };
2d13da88
KS
729 struct udev_list_entry *list_entry;
730 uint64_t tag_bloom_bits;
731
912541b0 732 blen = udev_device_get_properties_monitor_buf(udev_device, &buf);
e6ac88dd
TG
733 if (blen < 32) {
734 log_debug("device buffer is too small to contain a valid device");
912541b0 735 return -EINVAL;
e6ac88dd 736 }
912541b0 737
81b9fe54 738 /* fill in versioned header */
2d13da88
KS
739 val = udev_device_get_subsystem(udev_device);
740 nlh.filter_subsystem_hash = htonl(util_string_hash32(val));
81b9fe54 741
2d13da88
KS
742 val = udev_device_get_devtype(udev_device);
743 if (val != NULL)
744 nlh.filter_devtype_hash = htonl(util_string_hash32(val));
2d13da88
KS
745
746 /* add tag bloom filter */
747 tag_bloom_bits = 0;
748 udev_list_entry_foreach(list_entry, udev_device_get_tags_list_entry(udev_device))
749 tag_bloom_bits |= util_string_bloom64(udev_list_entry_get_name(list_entry));
750 if (tag_bloom_bits > 0) {
751 nlh.filter_tag_bloom_hi = htonl(tag_bloom_bits >> 32);
752 nlh.filter_tag_bloom_lo = htonl(tag_bloom_bits & 0xffffffff);
912541b0
KS
753 }
754
2d13da88
KS
755 /* add properties list */
756 nlh.properties_off = iov[0].iov_len;
757 nlh.properties_len = blen;
758 iov[1].iov_base = (char *)buf;
759 iov[1].iov_len = blen;
912541b0 760
2d13da88
KS
761 /*
762 * Use custom address for target, or the default one.
763 *
764 * If we send to a multicast group, we will get
765 * ECONNREFUSED, which is expected.
766 */
a4445e88 767 if (destination)
2d13da88
KS
768 smsg.msg_name = &destination->snl;
769 else
770 smsg.msg_name = &udev_monitor->snl_destination;
771 smsg.msg_namelen = sizeof(struct sockaddr_nl);
772 count = sendmsg(udev_monitor->sock, &smsg, 0);
a4445e88
TG
773 if (count < 0) {
774 if (!destination && errno == ECONNREFUSED) {
7800bf71 775 log_debug("passed device to netlink monitor %p", udev_monitor);
a4445e88
TG
776 return 0;
777 } else
778 return -errno;
779 }
780
965288c5 781 log_debug("passed %zi byte device to netlink monitor %p", count, udev_monitor);
2d13da88 782 return count;
9925ab04 783}
e14bdd88 784
ce1d6d7f
KS
785/**
786 * udev_monitor_filter_add_match_subsystem_devtype:
787 * @udev_monitor: the monitor
788 * @subsystem: the subsystem value to match the incoming devices against
214a6c79 789 * @devtype: the devtype value to match the incoming devices against
ce1d6d7f 790 *
50579295 791 * This filter is efficiently executed inside the kernel, and libudev subscribers
28460195
KS
792 * will usually not be woken up for devices which do not match.
793 *
ce1d6d7f
KS
794 * The filter must be installed before the monitor is switched to listening mode.
795 *
796 * Returns: 0 on success, otherwise a negative error value.
797 */
54cf0b7f 798_public_ int udev_monitor_filter_add_match_subsystem_devtype(struct udev_monitor *udev_monitor, const char *subsystem, const char *devtype)
e14bdd88 799{
912541b0
KS
800 if (udev_monitor == NULL)
801 return -EINVAL;
802 if (subsystem == NULL)
803 return -EINVAL;
804 if (udev_list_entry_add(&udev_monitor->filter_subsystem_list, subsystem, devtype) == NULL)
805 return -ENOMEM;
806 return 0;
e14bdd88 807}
08a7a795 808
28460195
KS
809/**
810 * udev_monitor_filter_add_match_tag:
811 * @udev_monitor: the monitor
812 * @tag: the name of a tag
813 *
50579295 814 * This filter is efficiently executed inside the kernel, and libudev subscribers
28460195
KS
815 * will usually not be woken up for devices which do not match.
816 *
817 * The filter must be installed before the monitor is switched to listening mode.
818 *
819 * Returns: 0 on success, otherwise a negative error value.
820 */
54cf0b7f 821_public_ int udev_monitor_filter_add_match_tag(struct udev_monitor *udev_monitor, const char *tag)
28460195 822{
912541b0
KS
823 if (udev_monitor == NULL)
824 return -EINVAL;
825 if (tag == NULL)
826 return -EINVAL;
827 if (udev_list_entry_add(&udev_monitor->filter_tag_list, tag, NULL) == NULL)
828 return -ENOMEM;
829 return 0;
28460195
KS
830}
831
ce1d6d7f
KS
832/**
833 * udev_monitor_filter_remove:
834 * @udev_monitor: monitor
835 *
836 * Remove all filters from monitor.
837 *
838 * Returns: 0 on success, otherwise a negative error value.
839 */
54cf0b7f 840_public_ int udev_monitor_filter_remove(struct udev_monitor *udev_monitor)
08a7a795 841{
912541b0 842 static struct sock_fprog filter = { 0, NULL };
08a7a795 843
912541b0
KS
844 udev_list_cleanup(&udev_monitor->filter_subsystem_list);
845 return setsockopt(udev_monitor->sock, SOL_SOCKET, SO_ATTACH_FILTER, &filter, sizeof(filter));
08a7a795 846}