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