summaryrefslogtreecommitdiffstats
path: root/discover/udev.c
blob: fa5d4b417a0f7f2164b6f4245bcf20e09f52ab2e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639

#if defined(HAVE_CONFIG_H)
#include "config.h"
#endif

#include <assert.h>
#include <errno.h>
#include <libudev.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <unistd.h>
#include <sys/socket.h>
#include <sys/types.h>
#include <sys/un.h>

#include <log/log.h>
#include <types/types.h>
#include <talloc/talloc.h>
#include <waiter/waiter.h>
#include <system/system.h>
#include <process/process.h>

#include "event.h"
#include "udev.h"
#include "pb-discover.h"
#include "device-handler.h"
#include "cdrom.h"
#include "devmapper.h"
#include "network.h"

/* We set a default monitor buffer size, as we may not process monitor
 * events while performing device discvoery. systemd uses a 128M buffer, so
 * we'll do the same here */
static const int monitor_bufsize = 128 * 1024 * 1024;

struct pb_udev {
	struct udev *udev;
	struct udev_monitor *monitor;
	struct device_handler *handler;
};

static int udev_destructor(void *p)
{
	struct pb_udev *udev = p;

	if (udev->monitor) {
		udev_monitor_unref(udev->monitor);
		udev->monitor = NULL;
	}

	if (udev->udev) {
		udev_unref(udev->udev);
		udev->udev = NULL;
	}

	return 0;
}

static void udev_setup_device_params(struct udev_device *udev,
		struct discover_device *dev)
{
	struct udev_list_entry *list, *entry;

	list = udev_device_get_properties_list_entry(udev);
	if (!list)
		return;

	udev_list_entry_foreach(entry, list)
		discover_device_set_param(dev,
				udev_list_entry_get_name(entry),
				udev_list_entry_get_value(entry));
}

/*
 * Search for LVM logical volumes. If any exist they should be recognised
 * by udev as normal.
 * Normally this is handled in an init script, but on some platforms
 * disks are slow enough to come up that we need to check again.
 */
static void lvm_vg_search(struct device_handler *handler)
{
	if (process_run_simple(handler, pb_system_apps.vgscan, "-qq", NULL))
		pb_log_fn("Failed to execute vgscan\n");

	if (process_run_simple(handler, pb_system_apps.vgchange, "-ay", "-qq",
				NULL))
		pb_log_fn("Failed to execute vgchange\n");
}

static int udev_handle_block_add(struct pb_udev *udev, struct udev_device *dev,
		const char *name)
{
	char *devlinks = NULL, *link, *saveptr = NULL;
	struct discover_device *ddev;
	unsigned int i = 0;
	const char *typestr;
	const char *uuid;
	const char *path;
	const char *node;
	const char *prop;
	const char *type;
	const char *devname;
	const char *ignored_types[] = {
		"linux_raid_member",
		"swap",
		NULL,
	};
	bool cdrom, usb;

	typestr = udev_device_get_devtype(dev);
	if (!typestr) {
		pb_debug("udev_device_get_devtype failed\n");
		return -1;
	}

	if (!(!strcmp(typestr, "disk") || !strcmp(typestr, "partition"))) {
		pb_log("SKIP %s: invalid type %s\n", name, typestr);
		return 0;
	}

	node = udev_device_get_devnode(dev);
	path = udev_device_get_devpath(dev);
	if (path && strstr(path, "virtual/block/loop")) {
		pb_log("SKIP: %s: ignored (path=%s)\n", name, path);
		return 0;
	}

	if (path && strstr(path, "virtual/block/ram")) {
		device_handler_add_ramdisk(udev->handler, node);
		return 0;
	}

	cdrom = node && !!udev_device_get_property_value(dev, "ID_CDROM");
	if (cdrom) {
		/* CDROMs require a little initialisation, to get
		 * petitboot-compatible tray behaviour */
		cdrom_init(node);
		if (!cdrom_media_present(node)) {
			pb_log("SKIP: %s: no media present\n", name);
			return 0;
		}
	}

	/* Ignore any device mapper devices that aren't logical volumes */
	devname = udev_device_get_property_value(dev, "DM_NAME");
	if (devname && ! udev_device_get_property_value(dev, "DM_LV_NAME")) {
		pb_debug("SKIP: dm-device %s\n", devname);
		return 0;
	}

	type = udev_device_get_property_value(dev, "ID_FS_TYPE");
	if (!type) {
		pb_log("SKIP: %s: no ID_FS_TYPE property\n", name);
		return 0;
	}

	while (ignored_types[i]) {
		if (!strncmp(type, ignored_types[i], strlen(ignored_types[i]))) {
			pb_log("SKIP: %s: ignore '%s' filesystem\n", name, type);
			return 0;
		}
		i++;
	}

	/* Search for LVM logical volumes if we see an LVM member */
	if (strncmp(type, "LVM2_member", strlen("LVM2_member")) == 0) {
		lvm_vg_search(udev->handler);
		return 0;
	}

	/* We may see multipath devices; they'll have the same uuid as an
	 * existing device, so only parse the first. */
	uuid = udev_device_get_property_value(dev, "ID_FS_UUID");
	if (uuid) {
		ddev = device_lookup_by_uuid(udev->handler, uuid);
		if (ddev) {
			pb_log("SKIP: %s UUID [%s] already present (as %s)\n",
					name, uuid, ddev->device->id);
			return 0;
		}
	}

	/* Use DM_NAME for logical volumes, or the device name otherwise */
	ddev = discover_device_create(udev->handler, uuid, devname ?: name);

	if (devname) {
		/*
		 * For logical volumes udev_device_get_devnode() returns a path
		 * of the form "/dev/dm-xx". These nodes names are not
		 * persistent and are opaque to the user. Instead use the more
		 * recognisable "/dev/mapper/lv-name" node if it is available.
		 */
		devlinks = talloc_strdup(ddev,
				udev_device_get_property_value(dev, "DEVLINKS"));
		link = devlinks ? strtok_r(devlinks, " ", &saveptr) : NULL;
		while (link) {
			if (strncmp(link, "/dev/mapper/",
					strlen("/dev/mapper/")) == 0) {
				node = link;
				break;
			}
			link = strtok_r(NULL, " ", &saveptr);
		}
	}

	ddev->device_path = talloc_strdup(ddev, node);
	talloc_free(devlinks);

	if (uuid)
		ddev->uuid = talloc_strdup(ddev, uuid);
	prop = udev_device_get_property_value(dev, "ID_FS_LABEL");
	if (prop)
		ddev->label = talloc_strdup(ddev, prop);

	usb = !!udev_device_get_property_value(dev, "ID_USB_DRIVER");
	if (cdrom)
		ddev->device->type = DEVICE_TYPE_OPTICAL;
	else
		ddev->device->type = usb ? DEVICE_TYPE_USB : DEVICE_TYPE_DISK;

	udev_setup_device_params(dev, ddev);

	/* Create a snapshot for all disk devices */
	if ((ddev->device->type == DEVICE_TYPE_DISK ||
	     ddev->device->type == DEVICE_TYPE_USB))
		devmapper_init_snapshot(udev->handler, ddev);

	device_handler_discover(udev->handler, ddev);

	return 0;
}

/*
 * Mark valid interfaces as 'ready'.
 * The udev_enumerate_add_match_is_initialized() filter in udev_enumerate()
 * ensures that any device we see is properly initialized by udev (eg. interface
 * names); here we check that the properties are sane and mark the interface
 * as ready for configuration in discover/network.
 */
static int udev_check_interface_ready(struct device_handler *handler,
		struct udev_device *dev)
{
	const char *name, *ifindex, *interface, *mac_name;
	uint8_t *mac;
	char byte[3];
	unsigned int i, j;


	name = udev_device_get_sysname(dev);
	if (!name) {
		pb_debug("udev_device_get_sysname failed\n");
		return -1;
	}

	ifindex = udev_device_get_property_value(dev, "IFINDEX");
	interface = udev_device_get_property_value(dev, "INTERFACE");
	mac_name = udev_device_get_property_value(dev, "ID_NET_NAME_MAC");

	/* Physical interfaces should have all of these properties */
	if (!ifindex || !interface || !mac_name) {
		pb_debug("%s: interface %s missing properties\n",
				__func__, name);
		return -1;
	}

	/* ID_NET_NAME_MAC format is enxMACADDR */
	if (strlen(mac_name) < 15) {
		pb_debug("%s: Unexpected MAC format: %s\n",
				__func__, mac_name);
		return -1;
	}

	mac = talloc_array(handler, uint8_t, HWADDR_SIZE);
	if (!mac)
		return -1;

	/*
	 * ID_NET_NAME_MAC is not a conventionally formatted MAC
	 * string - convert it before passing it to network.c
	 */
	byte[2] = '\0';
	for (i = strlen("enx"), j = 0;
			i < strlen(mac_name) && j < HWADDR_SIZE; i += 2) {
		memcpy(byte, &mac_name[i], 2);
		mac[j++] = strtoul(byte, NULL, 16);
	}

	network_mark_interface_ready(handler,
			atoi(ifindex), interface, mac, HWADDR_SIZE);

	talloc_free(mac);
	return 0;
}

static int udev_handle_dev_add(struct pb_udev *udev, struct udev_device *dev)
{
	const char *subsys;
	const char *name;

	name = udev_device_get_sysname(dev);
	if (!name) {
		pb_debug("udev_device_get_sysname failed\n");
		return -1;
	}

	subsys = udev_device_get_subsystem(dev);
	if (!subsys) {
		pb_debug("udev_device_get_subsystem failed\n");
		return -1;
	}

	/* If we see a net device, check if it is ready to be used */
	if (!strncmp(subsys, "net", strlen("net")))
		return udev_check_interface_ready(udev->handler, dev);

	if (device_lookup_by_id(udev->handler, name)) {
		pb_debug("device %s is already present?\n", name);
		return -1;
	}

	if (!strcmp(subsys, "block")) {
		return udev_handle_block_add(udev, dev, name);
	}

	pb_log("SKIP %s: unknown subsystem %s\n", name, subsys);
	return -1;
}


static int udev_handle_dev_remove(struct pb_udev *udev, struct udev_device *dev)
{
	struct discover_device *ddev;
	const char *name;

	name = udev_device_get_sysname(dev);
	if (!name) {
		pb_debug("udev_device_get_sysname failed\n");
		return -1;
	}

	ddev = device_lookup_by_id(udev->handler, name);
	if (!ddev)
		return 0;

	device_handler_remove(udev->handler, ddev);

	return 0;
}

/* returns true if further event processing should stop (eg., we've
 * ejected the cdrom)
 */
static bool udev_handle_cdrom_events(struct pb_udev *udev,
		struct udev_device *dev, struct discover_device *ddev)
{
	const char *node;
	bool eject = false;

	node = udev_device_get_devnode(dev);

	/* handle CDROM eject requests */
	if (udev_device_get_property_value(dev, "DISK_EJECT_REQUEST")) {
		pb_debug("udev: eject request\n");

		/* If the device is mounted, cdrom_id's own eject request may
		 * have failed. So, we'll need to do our own here.
		 */
		if (ddev) {
			eject = ddev->mounted;
			udev_handle_dev_remove(udev, dev);
		}

		if (eject)
			cdrom_eject(node);

		return true;
	}

	if (udev_device_get_property_value(dev, "DISK_MEDIA_CHANGE")) {
		if (cdrom_media_present(node))
			udev_handle_dev_add(udev, dev);
		else
			udev_handle_dev_remove(udev, dev);
		return true;
	}

	return false;
}

static int udev_handle_dev_change(struct pb_udev *udev, struct udev_device *dev)
{
	struct discover_device *ddev;
	const char *subsys;
	const char *name;
	int rc = 0;

	name = udev_device_get_sysname(dev);
	subsys = udev_device_get_subsystem(dev);

	/* If we see a net device, check if it is ready to be used */
	if (!strncmp(subsys, "net", strlen("net")))
		return udev_check_interface_ready(udev->handler, dev);

	ddev = device_lookup_by_id(udev->handler, name);

	/* if this is a CDROM device, process eject & media change requests;
	 * these may stop further processing */
	if (!udev_device_get_property_value(dev, "ID_CDROM")) {
		if (udev_handle_cdrom_events(udev, dev, ddev))
			return 0;
	}

	/* if this is a new device, treat it as an add */
	if (!ddev)
		rc = udev_handle_dev_add(udev, dev);

	return rc;
}

static int udev_handle_dev_action(struct udev_device *dev, const char *action)
{
	struct pb_udev *udev = udev_get_userdata(udev_device_get_udev(dev));
	struct udev_list_entry *list;
	const char *name;

	list = udev_device_get_properties_list_entry(dev);
	name = udev_device_get_sysname(dev);

	pb_debug("udev: action %s, device %s\n", action, name);
	pb_debug("udev: properties:\n");

	for (; list; list = udev_list_entry_get_next(list))
		pb_debug("\t%-20s: %s\n", udev_list_entry_get_name(list),
				udev_list_entry_get_value(list));

	if (!strcmp(action, "add"))
		return udev_handle_dev_add(udev, dev);

	else if (!strcmp(action, "remove"))
		return udev_handle_dev_remove(udev, dev);

	else if (!strcmp(action, "change"))
		return udev_handle_dev_change(udev, dev);

	return 0;
}

static int udev_enumerate(struct udev *udev)
{
	int result;
	struct udev_list_entry *list, *entry;
	struct udev_enumerate *enumerate;

	enumerate = udev_enumerate_new(udev);

	if (!enumerate) {
		pb_log("udev_enumerate_new failed\n");
		return -1;
	}

	result = udev_enumerate_add_match_subsystem(enumerate, "block");
	if (result) {
		pb_log("udev_enumerate_add_match_subsystem failed\n");
		goto fail;
	}

	result = udev_enumerate_add_match_subsystem(enumerate, "net");
	if (result) {
		pb_log("udev_enumerate_add_match_subsystem failed\n");
		goto fail;
	}

	result = udev_enumerate_add_match_is_initialized(enumerate);
	if (result) {
		pb_log("udev_enumerate_add_match_is_initialised failed\n");
		goto fail;
	}

	udev_enumerate_scan_devices(enumerate);

	list = udev_enumerate_get_list_entry(enumerate);

	udev_list_entry_foreach(entry, list) {
		const char *syspath;
		struct udev_device *dev;

		syspath = udev_list_entry_get_name(entry);
		dev = udev_device_new_from_syspath(udev, syspath);

		udev_handle_dev_action(dev, "add");

		udev_device_unref(dev);
	}

	udev_enumerate_unref(enumerate);
	return 0;

fail:
	udev_enumerate_unref(enumerate);
	return -1;
}

static int udev_setup_monitor(struct udev *udev, struct udev_monitor **monitor)
{
	int result;
	struct udev_monitor *m;

	*monitor = NULL;
	m = udev_monitor_new_from_netlink(udev, "udev");

	if (!m) {
		pb_log("udev_monitor_new_from_netlink failed\n");
		goto out_err;
	}

	result = udev_monitor_set_receive_buffer_size(m, monitor_bufsize);
	if (result) {
		pb_log("udev_monitor_set_rx_bufsize(%d) failed\n",
			monitor_bufsize);
	}

	result = udev_monitor_filter_add_match_subsystem_devtype(m, "block",
		NULL);

	if (result) {
		pb_log("udev_monitor_filter_add_match_subsystem_devtype failed\n");
		goto out_err;
	}

	result = udev_monitor_filter_add_match_subsystem_devtype(m, "net",
		NULL);

	if (result) {
		pb_log("udev_monitor_filter_add_match_subsystem_devtype failed\n");
		goto out_err;
	}

	result = udev_monitor_enable_receiving(m);

	if (result) {
		pb_log("udev_monitor_enable_receiving failed\n");
		goto out_err;
	}

	*monitor = m;
	return 0;

out_err:
	udev_monitor_unref(m);
	return -1;
}

/*
 * udev_process - waiter callback for monitor netlink.
 */

static int udev_process(void *arg)
{
	struct udev_monitor *monitor = arg;
	struct udev_device *dev;
	const char *action;

	dev = udev_monitor_receive_device(monitor);
	if (!dev) {
		pb_log("udev_monitor_receive_device failed\n");
		return -1;
	}

	action = udev_device_get_action(dev);

	if (!action) {
		pb_log("udev_device_get_action failed\n");
	} else {
		udev_handle_dev_action(dev, action);
	}

	udev_device_unref(dev);
	return 0;
}

#ifdef UDEV_LOGGING
static void udev_log_fn(struct udev __attribute__((unused)) *udev,
	int __attribute__((unused)) priority, const char *file, int line,
	const char *fn, const char *format, va_list args)
{
      pb_log("libudev: %s %s:%d: ", fn, file, line);
      vfprintf(pb_log_get_stream(), format, args);
}
#endif

struct pb_udev *udev_init(struct device_handler *handler,
		struct waitset *waitset)
{
	struct pb_udev *udev;
	int result;

	udev = talloc_zero(handler, struct pb_udev);
	talloc_set_destructor(udev, udev_destructor);
	udev->handler = handler;

	udev->udev = udev_new();

	if (!udev->udev) {
		pb_log("udev_new failed\n");
		goto fail;
	}

	udev_set_userdata(udev->udev, udev);

#ifdef UDEV_LOGGING
	udev_set_log_fn(udev->udev, udev_log_fn);
#endif

	result = udev_setup_monitor(udev->udev, &udev->monitor);
	if (result)
		goto fail;

	result = udev_enumerate(udev->udev);
	if (result)
		goto fail;

	waiter_register_io(waitset, udev_monitor_get_fd(udev->monitor), WAIT_IN,
		udev_process, udev->monitor);

	pb_debug("%s: waiting on udev\n", __func__);

	return udev;

fail:
	talloc_free(udev);
	return NULL;
}

void udev_reinit(struct pb_udev *udev)
{
	pb_log("udev: reinit requested, starting enumeration\n");
	udev_enumerate(udev->udev);
}
OpenPOWER on IntegriCloud