11 #include <sys/mount.h>
13 #include <talloc/talloc.h>
14 #include <list/list.h>
16 #include <types/types.h>
17 #include <system/system.h>
18 #include <process/process.h>
20 #include <i18n/i18n.h>
22 #include <sys/types.h>
23 #include <sys/socket.h>
25 #include <arpa/inet.h>
27 #include "device-handler.h"
28 #include "discover-server.h"
29 #include "devmapper.h"
30 #include "user-event.h"
42 enum default_priority {
43 DEFAULT_PRIORITY_REMOTE = 1,
44 DEFAULT_PRIORITY_LOCAL_FIRST = 2,
45 DEFAULT_PRIORITY_LOCAL_LAST = 0xfe,
46 DEFAULT_PRIORITY_DISABLED = 0xff,
49 struct device_handler {
50 struct discover_server *server;
54 struct network *network;
55 struct user_event *user_event;
57 struct discover_device **devices;
58 unsigned int n_devices;
60 struct ramdisk_device **ramdisks;
61 unsigned int n_ramdisks;
63 struct waitset *waitset;
64 struct waiter *timeout_waiter;
65 bool autoboot_enabled;
66 unsigned int sec_to_boot;
68 struct discover_boot_option *default_boot_option;
69 int default_boot_option_priority;
71 struct list unresolved_boot_options;
73 struct boot_task *pending_boot;
74 bool pending_boot_is_default;
77 static int mount_device(struct discover_device *dev);
78 static int umount_device(struct discover_device *dev);
80 static int device_handler_init_sources(struct device_handler *handler);
81 static void device_handler_reinit_sources(struct device_handler *handler);
83 static void device_handler_update_lang(const char *lang);
85 void discover_context_add_boot_option(struct discover_context *ctx,
86 struct discover_boot_option *boot_option)
88 boot_option->source = ctx->parser;
89 list_add_tail(&ctx->boot_options, &boot_option->list);
90 talloc_steal(ctx, boot_option);
94 * device_handler_get_device_count - Get the count of current handler devices.
97 int device_handler_get_device_count(const struct device_handler *handler)
99 return handler->n_devices;
103 * device_handler_get_device - Get a handler device by index.
106 const struct discover_device *device_handler_get_device(
107 const struct device_handler *handler, unsigned int index)
109 if (index >= handler->n_devices) {
110 assert(0 && "bad index");
114 return handler->devices[index];
117 struct discover_boot_option *discover_boot_option_create(
118 struct discover_context *ctx,
119 struct discover_device *device)
121 struct discover_boot_option *opt;
123 opt = talloc_zero(ctx, struct discover_boot_option);
124 opt->option = talloc_zero(opt, struct boot_option);
125 opt->device = device;
130 static int device_match_uuid(struct discover_device *dev, const char *uuid)
132 return dev->uuid && !strcmp(dev->uuid, uuid);
135 static int device_match_label(struct discover_device *dev, const char *label)
137 return dev->label && !strcmp(dev->label, label);
140 static int device_match_id(struct discover_device *dev, const char *id)
142 return !strcmp(dev->device->id, id);
145 static int device_match_serial(struct discover_device *dev, const char *serial)
147 const char *val = discover_device_get_param(dev, "ID_SERIAL");
148 return val && !strcmp(val, serial);
151 static struct discover_device *device_lookup(
152 struct device_handler *device_handler,
153 int (match_fn)(struct discover_device *, const char *),
156 struct discover_device *dev;
162 for (i = 0; i < device_handler->n_devices; i++) {
163 dev = device_handler->devices[i];
165 if (match_fn(dev, str))
172 struct discover_device *device_lookup_by_name(struct device_handler *handler,
175 if (!strncmp(name, "/dev/", strlen("/dev/")))
176 name += strlen("/dev/");
178 return device_lookup_by_id(handler, name);
181 struct discover_device *device_lookup_by_uuid(
182 struct device_handler *device_handler,
185 return device_lookup(device_handler, device_match_uuid, uuid);
188 struct discover_device *device_lookup_by_label(
189 struct device_handler *device_handler,
192 return device_lookup(device_handler, device_match_label, label);
195 struct discover_device *device_lookup_by_id(
196 struct device_handler *device_handler,
199 return device_lookup(device_handler, device_match_id, id);
202 struct discover_device *device_lookup_by_serial(
203 struct device_handler *device_handler,
206 return device_lookup(device_handler, device_match_serial, serial);
209 void device_handler_destroy(struct device_handler *handler)
211 talloc_free(handler);
214 static int destroy_device(void *arg)
216 struct discover_device *dev = arg;
223 struct discover_device *discover_device_create(struct device_handler *handler,
224 const char *uuid, const char *id)
226 struct discover_device *dev;
229 dev = device_lookup_by_uuid(handler, uuid);
231 dev = device_lookup_by_id(handler, id);
236 dev = talloc_zero(handler, struct discover_device);
237 dev->device = talloc_zero(dev, struct device);
238 dev->device->id = talloc_strdup(dev->device, id);
239 dev->uuid = talloc_strdup(dev, uuid);
240 list_init(&dev->params);
241 list_init(&dev->boot_options);
243 talloc_set_destructor(dev, destroy_device);
248 struct discover_device_param {
251 struct list_item list;
254 void discover_device_set_param(struct discover_device *device,
255 const char *name, const char *value)
257 struct discover_device_param *param;
260 list_for_each_entry(&device->params, param, list) {
261 if (!strcmp(param->name, name)) {
270 param = talloc(device, struct discover_device_param);
271 param->name = talloc_strdup(param, name);
272 list_add(&device->params, ¶m->list);
275 list_remove(¶m->list);
279 talloc_free(param->value);
282 param->value = talloc_strdup(param, value);
285 const char *discover_device_get_param(struct discover_device *device,
288 struct discover_device_param *param;
290 list_for_each_entry(&device->params, param, list) {
291 if (!strcmp(param->name, name))
297 struct device_handler *device_handler_init(struct discover_server *server,
298 struct waitset *waitset, int dry_run)
300 struct device_handler *handler;
303 handler = talloc_zero(NULL, struct device_handler);
304 handler->server = server;
305 handler->waitset = waitset;
306 handler->dry_run = dry_run;
307 handler->autoboot_enabled = config_get()->autoboot_enabled;
309 list_init(&handler->unresolved_boot_options);
311 /* set up our mount point base */
312 pb_mkdir_recursive(mount_base());
316 if (config_get()->safe_mode)
319 rc = device_handler_init_sources(handler);
321 talloc_free(handler);
328 void device_handler_reinit(struct device_handler *handler)
330 struct discover_boot_option *opt, *tmp;
331 struct ramdisk_device *ramdisk;
334 device_handler_cancel_default(handler);
336 /* free unresolved boot options */
337 list_for_each_entry_safe(&handler->unresolved_boot_options,
340 list_init(&handler->unresolved_boot_options);
342 /* drop all devices */
343 for (i = 0; i < handler->n_devices; i++) {
344 discover_server_notify_device_remove(handler->server,
345 handler->devices[i]->device);
346 ramdisk = handler->devices[i]->ramdisk;
347 talloc_free(handler->devices[i]);
348 talloc_free(ramdisk);
351 talloc_free(handler->devices);
352 handler->devices = NULL;
353 handler->n_devices = 0;
354 talloc_free(handler->ramdisks);
355 handler->ramdisks = NULL;
356 handler->n_ramdisks = 0;
358 device_handler_reinit_sources(handler);
361 void device_handler_remove(struct device_handler *handler,
362 struct discover_device *device)
364 struct discover_boot_option *opt, *tmp;
367 list_for_each_entry_safe(&device->boot_options, opt, tmp, list) {
368 if (opt == handler->default_boot_option) {
369 pb_log("Default option %s cancelled since device removed",
371 device_handler_cancel_default(handler);
376 for (i = 0; i < handler->n_devices; i++)
377 if (handler->devices[i] == device)
380 if (i == handler->n_devices) {
385 /* Free any unresolved options, as they're currently allocated
386 * against the handler */
387 list_for_each_entry_safe(&handler->unresolved_boot_options,
389 if (opt->device != device)
391 list_remove(&opt->list);
395 /* if this is a network device, we have to unregister it from the
397 if (device->device->type == DEVICE_TYPE_NETWORK)
398 network_unregister_device(handler->network, device);
400 handler->n_devices--;
401 memmove(&handler->devices[i], &handler->devices[i + 1],
402 (handler->n_devices - i) * sizeof(handler->devices[0]));
403 handler->devices = talloc_realloc(handler, handler->devices,
404 struct discover_device *, handler->n_devices);
406 if (device->notified)
407 discover_server_notify_device_remove(handler->server,
413 void device_handler_status(struct device_handler *handler,
414 struct status *status)
416 discover_server_notify_boot_status(handler->server, status);
419 static void _device_handler_vstatus(struct device_handler *handler,
420 enum status_type type, const char *fmt, va_list ap)
422 struct status status;
425 status.message = talloc_vasprintf(handler, fmt, ap);
427 device_handler_status(handler, &status);
429 talloc_free(status.message);
432 static void _device_handler_vdevstatus(struct device_handler *handler,
433 struct discover_device *device, enum status_type type,
434 const char *fmt, va_list ap)
438 msg = talloc_asprintf(handler, "[%s] %s",
439 device ? device->device->id : "unknown", fmt);
440 _device_handler_vstatus(handler, type, msg, ap);
444 void device_handler_status_dev_info(struct device_handler *handler,
445 struct discover_device *dev, const char *fmt, ...)
450 _device_handler_vdevstatus(handler, dev, STATUS_INFO, fmt, ap);
454 void device_handler_status_dev_err(struct device_handler *handler,
455 struct discover_device *dev, const char *fmt, ...)
460 _device_handler_vdevstatus(handler, dev, STATUS_ERROR, fmt, ap);
464 void device_handler_status_info(struct device_handler *handler,
465 const char *fmt, ...)
470 _device_handler_vstatus(handler, STATUS_INFO, fmt, ap);
474 void device_handler_status_err(struct device_handler *handler,
475 const char *fmt, ...)
480 _device_handler_vstatus(handler, STATUS_ERROR, fmt, ap);
484 static void device_handler_boot_status_cb(void *arg, struct status *status)
486 device_handler_status(arg, status);
489 static void countdown_status(struct device_handler *handler,
490 struct discover_boot_option *opt, unsigned int sec)
492 struct status status;
494 status.type = STATUS_INFO;
495 status.message = talloc_asprintf(handler,
496 _("Booting in %d sec: %s"), sec, opt->option->name);
498 device_handler_status(handler, &status);
500 talloc_free(status.message);
503 static int default_timeout(void *arg)
505 struct device_handler *handler = arg;
506 struct discover_boot_option *opt;
508 if (!handler->default_boot_option)
511 if (handler->pending_boot)
514 opt = handler->default_boot_option;
516 if (handler->sec_to_boot) {
517 countdown_status(handler, opt, handler->sec_to_boot);
518 handler->sec_to_boot--;
519 handler->timeout_waiter = waiter_register_timeout(
520 handler->waitset, 1000,
521 default_timeout, handler);
525 handler->timeout_waiter = NULL;
527 pb_log("Timeout expired, booting default option %s\n", opt->option->id);
531 handler->pending_boot = boot(handler, handler->default_boot_option,
532 NULL, handler->dry_run, device_handler_boot_status_cb,
534 handler->pending_boot_is_default = true;
539 enum ipmi_bootdev ipmi_type;
540 enum device_type device_type;
541 } device_type_map[] = {
542 { IPMI_BOOTDEV_NETWORK, DEVICE_TYPE_NETWORK },
543 { IPMI_BOOTDEV_DISK, DEVICE_TYPE_DISK },
544 { IPMI_BOOTDEV_DISK, DEVICE_TYPE_USB },
545 { IPMI_BOOTDEV_CDROM, DEVICE_TYPE_OPTICAL },
548 static bool ipmi_device_type_matches(enum ipmi_bootdev ipmi_type,
549 enum device_type device_type)
553 for (i = 0; i < ARRAY_SIZE(device_type_map); i++) {
554 if (device_type_map[i].device_type == device_type)
555 return device_type_map[i].ipmi_type == ipmi_type;
561 static int autoboot_option_priority(const struct config *config,
562 struct discover_boot_option *opt)
564 enum device_type type = opt->device->device->type;
565 const char *uuid = opt->device->uuid;
566 struct autoboot_option *auto_opt;
569 for (i = 0; i < config->n_autoboot_opts; i++) {
570 auto_opt = &config->autoboot_opts[i];
571 if (auto_opt->boot_type == BOOT_DEVICE_UUID)
572 if (!strcmp(auto_opt->uuid, uuid))
573 return DEFAULT_PRIORITY_LOCAL_FIRST + i;
575 if (auto_opt->boot_type == BOOT_DEVICE_TYPE)
576 if (auto_opt->type == type ||
577 auto_opt->type == DEVICE_TYPE_ANY)
578 return DEFAULT_PRIORITY_LOCAL_FIRST + i;
585 * We have different priorities to resolve conflicts between boot options that
586 * report to be the default for their device. This function assigns a priority
589 static enum default_priority default_option_priority(
590 struct discover_boot_option *opt)
592 const struct config *config;
594 config = config_get();
596 /* We give highest priority to IPMI-configured boot options. If
597 * we have an IPMI bootdev configuration set, then we don't allow
598 * any other defaults */
599 if (config->ipmi_bootdev) {
600 bool ipmi_match = ipmi_device_type_matches(config->ipmi_bootdev,
601 opt->device->device->type);
603 return DEFAULT_PRIORITY_REMOTE;
605 pb_debug("handler: disabled default priority due to "
606 "non-matching IPMI type %x\n",
607 config->ipmi_bootdev);
608 return DEFAULT_PRIORITY_DISABLED;
611 /* Next, try to match the option against the user-defined autoboot
612 * options, either by device UUID or type. */
613 if (config->n_autoboot_opts) {
614 int boot_match = autoboot_option_priority(config, opt);
619 /* If the option didn't match any entry in the array, it is disabled */
620 pb_debug("handler: disabled default priority due to "
621 "non-matching UUID or type\n");
622 return DEFAULT_PRIORITY_DISABLED;
625 static void set_default(struct device_handler *handler,
626 struct discover_boot_option *opt)
628 enum default_priority cur_prio, new_prio;
630 if (!handler->autoboot_enabled)
633 pb_debug("handler: new default option: %s\n", opt->option->id);
635 new_prio = default_option_priority(opt);
637 /* Anything outside our range prevents a default boot */
638 if (new_prio >= DEFAULT_PRIORITY_DISABLED)
641 pb_debug("handler: calculated priority %d\n", new_prio);
643 /* Resolve any conflicts: if we have a new default option, it only
644 * replaces the current if it has a higher priority. */
645 if (handler->default_boot_option) {
647 cur_prio = handler->default_boot_option_priority;
649 if (new_prio < cur_prio) {
650 pb_log("handler: new prio %d beats "
651 "old prio %d for %s\n",
653 handler->default_boot_option
655 handler->default_boot_option = opt;
656 handler->default_boot_option_priority = new_prio;
657 /* extend the timeout a little, so the user sees some
658 * indication of the change */
659 handler->sec_to_boot += 2;
665 handler->sec_to_boot = config_get()->autoboot_timeout_sec;
666 handler->default_boot_option = opt;
667 handler->default_boot_option_priority = new_prio;
669 pb_log("handler: boot option %s set as default, timeout %u sec.\n",
670 opt->option->id, handler->sec_to_boot);
672 default_timeout(handler);
675 static bool resource_is_resolved(struct resource *res)
677 return !res || res->resolved;
680 /* We only use this in an assert, which will disappear if we're compiling
681 * with NDEBUG, so we need the 'used' attribute for these builds */
682 static bool __attribute__((used)) boot_option_is_resolved(
683 struct discover_boot_option *opt)
685 return resource_is_resolved(opt->boot_image) &&
686 resource_is_resolved(opt->initrd) &&
687 resource_is_resolved(opt->dtb) &&
688 resource_is_resolved(opt->args_sig_file) &&
689 resource_is_resolved(opt->icon);
692 static bool resource_resolve(struct resource *res, const char *name,
693 struct discover_boot_option *opt,
694 struct device_handler *handler)
696 struct parser *parser = opt->source;
698 if (resource_is_resolved(res))
701 pb_debug("Attempting to resolve resource %s->%s with parser %s\n",
702 opt->option->id, name, parser->name);
703 parser->resolve_resource(handler, res);
705 return res->resolved;
708 static bool boot_option_resolve(struct discover_boot_option *opt,
709 struct device_handler *handler)
711 return resource_resolve(opt->boot_image, "boot_image", opt, handler) &&
712 resource_resolve(opt->initrd, "initrd", opt, handler) &&
713 resource_resolve(opt->dtb, "dtb", opt, handler) &&
714 resource_resolve(opt->args_sig_file, "args_sig_file", opt,
716 resource_resolve(opt->icon, "icon", opt, handler);
719 static void boot_option_finalise(struct device_handler *handler,
720 struct discover_boot_option *opt)
722 assert(boot_option_is_resolved(opt));
724 /* check that the parsers haven't set any of the final data */
725 assert(!opt->option->boot_image_file);
726 assert(!opt->option->initrd_file);
727 assert(!opt->option->dtb_file);
728 assert(!opt->option->icon_file);
729 assert(!opt->option->device_id);
730 assert(!opt->option->args_sig_file);
733 opt->option->boot_image_file = opt->boot_image->url->full;
735 opt->option->initrd_file = opt->initrd->url->full;
737 opt->option->dtb_file = opt->dtb->url->full;
739 opt->option->icon_file = opt->icon->url->full;
740 if (opt->args_sig_file)
741 opt->option->args_sig_file = opt->args_sig_file->url->full;
743 opt->option->device_id = opt->device->device->id;
745 if (opt->option->is_default)
746 set_default(handler, opt);
749 static void notify_boot_option(struct device_handler *handler,
750 struct discover_boot_option *opt)
752 struct discover_device *dev = opt->device;
755 discover_server_notify_device_add(handler->server,
756 opt->device->device);
757 dev->notified = true;
758 discover_server_notify_boot_option_add(handler->server, opt->option);
761 static void process_boot_option_queue(struct device_handler *handler)
763 struct discover_boot_option *opt, *tmp;
765 list_for_each_entry_safe(&handler->unresolved_boot_options,
768 pb_debug("queue: attempting resolution for %s\n",
771 if (!boot_option_resolve(opt, handler))
774 pb_debug("\tresolved!\n");
776 list_remove(&opt->list);
777 list_add_tail(&opt->device->boot_options, &opt->list);
778 talloc_steal(opt->device, opt);
779 boot_option_finalise(handler, opt);
780 notify_boot_option(handler, opt);
784 struct discover_context *device_handler_discover_context_create(
785 struct device_handler *handler,
786 struct discover_device *device)
788 struct discover_context *ctx;
790 ctx = talloc_zero(handler, struct discover_context);
791 ctx->device = device;
792 ctx->network = handler->network;
793 list_init(&ctx->boot_options);
798 void device_handler_add_device(struct device_handler *handler,
799 struct discover_device *device)
801 handler->n_devices++;
802 handler->devices = talloc_realloc(handler, handler->devices,
803 struct discover_device *, handler->n_devices);
804 handler->devices[handler->n_devices - 1] = device;
806 if (device->device->type == DEVICE_TYPE_NETWORK)
807 network_register_device(handler->network, device);
810 void device_handler_add_ramdisk(struct device_handler *handler,
813 struct ramdisk_device *dev;
819 for (i = 0; i < handler->n_ramdisks; i++)
820 if (!strcmp(handler->ramdisks[i]->path, path))
823 dev = talloc_zero(handler, struct ramdisk_device);
825 pb_log("Failed to allocate memory to track %s\n", path);
829 dev->path = talloc_strdup(handler, path);
831 handler->ramdisks = talloc_realloc(handler, handler->ramdisks,
832 struct ramdisk_device *,
833 handler->n_ramdisks + 1);
834 if (!handler->ramdisks) {
835 pb_log("Failed to reallocate memory"
836 "- ramdisk tracking inconsistent!\n");
840 handler->ramdisks[i] = dev;
841 i = handler->n_ramdisks++;
844 struct ramdisk_device *device_handler_get_ramdisk(
845 struct device_handler *handler)
851 /* Check if free ramdisk exists */
852 for (i = 0; i < handler->n_ramdisks; i++)
853 if (!handler->ramdisks[i]->snapshot &&
854 !handler->ramdisks[i]->origin &&
855 !handler->ramdisks[i]->base)
856 return handler->ramdisks[i];
858 /* Otherwise create a new one */
859 name = talloc_asprintf(handler, "/dev/ram%d",
860 handler->n_ramdisks);
862 pb_debug("Failed to allocate memory to name /dev/ram%d",
863 handler->n_ramdisks);
867 id = makedev(1, handler->n_ramdisks);
868 if (mknod(name, S_IFBLK, id)) {
869 if (errno == EEXIST) {
870 /* We haven't yet received updates for existing
871 * ramdisks - add and use this one */
872 pb_debug("Using untracked ramdisk %s\n", name);
874 pb_log("Failed to create new ramdisk %s: %s\n",
875 name, strerror(errno));
879 device_handler_add_ramdisk(handler, name);
882 return handler->ramdisks[i];
885 void device_handler_release_ramdisk(struct discover_device *device)
887 struct ramdisk_device *ramdisk = device->ramdisk;
889 talloc_free(ramdisk->snapshot);
890 talloc_free(ramdisk->origin);
891 talloc_free(ramdisk->base);
893 ramdisk->snapshot = ramdisk->origin = ramdisk->base = NULL;
894 ramdisk->sectors = 0;
896 device->ramdisk = NULL;
899 /* Start discovery on a hotplugged device. The device will be in our devices
900 * array, but has only just been initialised by the hotplug source.
902 int device_handler_discover(struct device_handler *handler,
903 struct discover_device *dev)
905 struct discover_context *ctx;
908 device_handler_status_dev_info(handler, dev,
910 * TRANSLATORS: this string will be passed the type of the
911 * device (eg "disk" or "network"), which will be translated
914 _("Processing new %s device"),
915 device_type_display_name(dev->device->type));
917 process_boot_option_queue(handler);
919 /* create our context */
920 ctx = device_handler_discover_context_create(handler, dev);
922 rc = mount_device(dev);
926 /* add this device to our system info */
927 system_info_register_blockdev(dev->device->id, dev->uuid,
930 /* run the parsers. This will populate the ctx's boot_option list. */
931 iterate_parsers(ctx);
933 /* add discovered stuff to the handler */
934 device_handler_discover_context_commit(handler, ctx);
937 device_handler_status_dev_info(handler, dev, _("Processing complete"));
939 talloc_unlink(handler, ctx);
944 /* Incoming dhcp event */
945 int device_handler_dhcp(struct device_handler *handler,
946 struct discover_device *dev, struct event *event)
948 struct discover_context *ctx;
950 device_handler_status_dev_info(handler, dev,
951 _("Processing dhcp event"));
953 /* create our context */
954 ctx = device_handler_discover_context_create(handler, dev);
955 talloc_steal(ctx, event);
958 iterate_parsers(ctx);
960 device_handler_discover_context_commit(handler, ctx);
962 device_handler_status_dev_info(handler, dev, _("Processing complete"));
964 talloc_unlink(handler, ctx);
969 static struct discover_boot_option *find_boot_option_by_id(
970 struct device_handler *handler, const char *id)
974 for (i = 0; i < handler->n_devices; i++) {
975 struct discover_device *dev = handler->devices[i];
976 struct discover_boot_option *opt;
978 list_for_each_entry(&dev->boot_options, opt, list)
979 if (!strcmp(opt->option->id, id))
986 void device_handler_boot(struct device_handler *handler,
987 struct boot_command *cmd)
989 struct discover_boot_option *opt = NULL;
991 if (cmd->option_id && strlen(cmd->option_id))
992 opt = find_boot_option_by_id(handler, cmd->option_id);
994 if (handler->pending_boot)
995 boot_cancel(handler->pending_boot);
999 handler->pending_boot = boot(handler, opt, cmd, handler->dry_run,
1000 device_handler_boot_status_cb, handler);
1001 handler->pending_boot_is_default = false;
1004 void device_handler_cancel_default(struct device_handler *handler)
1006 if (handler->timeout_waiter)
1007 waiter_remove(handler->timeout_waiter);
1009 handler->timeout_waiter = NULL;
1010 handler->autoboot_enabled = false;
1012 /* we only send status if we had a default boot option queued */
1013 if (!handler->default_boot_option)
1016 pb_log("Cancelling default boot option\n");
1018 if (handler->pending_boot && handler->pending_boot_is_default) {
1019 boot_cancel(handler->pending_boot);
1020 handler->pending_boot = NULL;
1021 handler->pending_boot_is_default = false;
1024 handler->default_boot_option = NULL;
1026 device_handler_status_info(handler, _("Default boot cancelled"));
1029 void device_handler_update_config(struct device_handler *handler,
1030 struct config *config)
1034 rc = config_set(config);
1038 discover_server_notify_config(handler->server, config);
1039 device_handler_update_lang(config->lang);
1040 device_handler_reinit(handler);
1043 static char *device_from_addr(void *ctx, struct pb_url *url)
1045 char *ipaddr, *buf, *tok, *dev = NULL;
1046 const char *delim = " ";
1047 struct sockaddr_in *ip;
1048 struct sockaddr_in si;
1049 struct addrinfo *res;
1053 /* Note: IPv4 only */
1054 rc = inet_pton(AF_INET, url->host, &(si.sin_addr));
1058 /* need to turn hostname into a valid IP */
1059 rc = getaddrinfo(url->host, NULL, NULL, &res);
1061 pb_debug("%s: Invalid URL\n",__func__);
1064 ipaddr = talloc_array(ctx,char,INET_ADDRSTRLEN);
1065 ip = (struct sockaddr_in *) res->ai_addr;
1066 inet_ntop(AF_INET, &(ip->sin_addr), ipaddr, INET_ADDRSTRLEN);
1070 const char *argv[] = {
1072 "route", "show", "to", "match",
1077 p = process_create(ctx);
1079 p->path = pb_system_apps.ip;
1081 p->keep_stdout = true;
1083 rc = process_run_sync(p);
1085 if (rc || p->exit_status) {
1086 /* ip has complained for some reason; most likely
1087 * there is no route to the host - bail out */
1088 pb_debug("%s: `ip` returns non-zero exit status\n", __func__);
1089 pb_debug("ip buf: %s\n", p->stdout_buf);
1094 buf = p->stdout_buf;
1095 /* If a route is found, ip-route output will be of the form
1096 * "... dev DEVNAME ... " */
1097 tok = strtok(buf, delim);
1099 if (!strcmp(tok, "dev")) {
1100 tok = strtok(NULL, delim);
1101 dev = talloc_strdup(ctx, tok);
1104 tok = strtok(NULL, delim);
1109 pb_debug("%s: Found interface '%s'\n", __func__,dev);
1113 void device_handler_process_url(struct device_handler *handler,
1114 const char *url, const char *mac, const char *ip)
1116 struct discover_context *ctx;
1117 struct discover_device *dev;
1118 struct pb_url *pb_url;
1119 struct event *event;
1120 struct param *param;
1122 if (!handler->network) {
1123 device_handler_status_err(handler, _("No network configured"));
1127 event = talloc(handler, struct event);
1128 event->type = EVENT_TYPE_USER;
1129 event->action = EVENT_ACTION_URL;
1131 if (url[strlen(url) - 1] == '/') {
1132 event->params = talloc_array(event, struct param, 3);
1133 param = &event->params[0];
1134 param->name = talloc_strdup(event, "pxepathprefix");
1135 param->value = talloc_strdup(event, url);
1136 param = &event->params[1];
1137 param->name = talloc_strdup(event, "mac");
1138 param->value = talloc_strdup(event, mac);
1139 param = &event->params[2];
1140 param->name = talloc_strdup(event, "ip");
1141 param->value = talloc_strdup(event, ip);
1142 event->n_params = 3;
1144 event->params = talloc_array(event, struct param, 1);
1145 param = &event->params[0];
1146 param->name = talloc_strdup(event, "pxeconffile");
1147 param->value = talloc_strdup(event, url);
1148 event->n_params = 1;
1151 pb_url = pb_url_parse(event, event->params->value);
1152 if (!pb_url || (pb_url->scheme != pb_url_file && !pb_url->host)) {
1153 device_handler_status_err(handler, _("Invalid config URL!"));
1157 if (pb_url->scheme == pb_url_file)
1158 event->device = talloc_asprintf(event, "local");
1160 event->device = device_from_addr(event, pb_url);
1162 if (!event->device) {
1163 device_handler_status_err(handler,
1164 _("Unable to route to host %s"),
1169 dev = discover_device_create(handler, mac, event->device);
1170 if (pb_url->scheme == pb_url_file)
1171 dev->device->type = DEVICE_TYPE_ANY;
1172 ctx = device_handler_discover_context_create(handler, dev);
1173 talloc_steal(ctx, event);
1176 iterate_parsers(ctx);
1178 device_handler_discover_context_commit(handler, ctx);
1180 talloc_unlink(handler, ctx);
1183 #ifndef PETITBOOT_TEST
1186 * context_commit - Commit a temporary discovery context to the handler,
1187 * and notify the clients about any new options / devices
1189 void device_handler_discover_context_commit(struct device_handler *handler,
1190 struct discover_context *ctx)
1192 struct discover_device *dev = ctx->device;
1193 struct discover_boot_option *opt, *tmp;
1195 if (!device_lookup_by_uuid(handler, dev->uuid))
1196 device_handler_add_device(handler, dev);
1198 /* move boot options from the context to the device */
1199 list_for_each_entry_safe(&ctx->boot_options, opt, tmp, list) {
1200 list_remove(&opt->list);
1202 /* All boot options need at least a kernel image */
1203 if (!opt->boot_image || !opt->boot_image->url) {
1204 pb_log("boot option %s is missing boot image, ignoring\n",
1210 if (boot_option_resolve(opt, handler)) {
1211 pb_log("boot option %s is resolved, "
1212 "sending to clients\n",
1214 list_add_tail(&dev->boot_options, &opt->list);
1215 talloc_steal(dev, opt);
1216 boot_option_finalise(handler, opt);
1217 notify_boot_option(handler, opt);
1219 if (!opt->source->resolve_resource) {
1220 pb_log("parser %s gave us an unresolved "
1221 "resource (%s), but no way to "
1223 opt->source->name, opt->option->id);
1226 pb_log("boot option %s is unresolved, "
1227 "adding to queue\n",
1229 list_add(&handler->unresolved_boot_options,
1231 talloc_steal(handler, opt);
1237 static void device_handler_update_lang(const char *lang)
1239 const char *cur_lang;
1244 cur_lang = setlocale(LC_ALL, NULL);
1245 if (cur_lang && !strcmp(cur_lang, lang))
1248 setlocale(LC_ALL, lang);
1251 static int device_handler_init_sources(struct device_handler *handler)
1253 /* init our device sources: udev, network and user events */
1254 handler->udev = udev_init(handler, handler->waitset);
1258 handler->network = network_init(handler, handler->waitset,
1260 if (!handler->network)
1263 handler->user_event = user_event_init(handler, handler->waitset);
1264 if (!handler->user_event)
1270 static void device_handler_reinit_sources(struct device_handler *handler)
1272 /* if we haven't initialised sources previously (becuase we started in
1273 * safe mode), then init once here. */
1274 if (!(handler->udev || handler->network || handler->user_event)) {
1275 device_handler_init_sources(handler);
1279 udev_reinit(handler->udev);
1281 network_shutdown(handler->network);
1282 handler->network = network_init(handler, handler->waitset,
1286 static inline const char *get_device_path(struct discover_device *dev)
1288 return dev->ramdisk ? dev->ramdisk->snapshot : dev->device_path;
1291 static char *check_subvols(struct discover_device *dev)
1293 const char *fstype = discover_device_get_param(dev, "ID_FS_TYPE");
1298 if (strncmp(fstype, "btrfs", strlen("btrfs")))
1299 return dev->mount_path;
1301 /* On btrfs a device's root may be under a subvolume path */
1302 path = join_paths(dev, dev->mount_path, "@");
1303 rc = stat(path, &sb);
1304 if (!rc && S_ISDIR(sb.st_mode)) {
1305 pb_debug("Using '%s' for btrfs root path\n", path);
1310 return dev->mount_path;
1313 static bool check_existing_mount(struct discover_device *dev)
1315 struct stat devstat, mntstat;
1316 const char *device_path;
1321 device_path = get_device_path(dev);
1323 rc = stat(device_path, &devstat);
1325 pb_debug("%s: stat failed: %s\n", __func__, strerror(errno));
1329 if (!S_ISBLK(devstat.st_mode)) {
1330 pb_debug("%s: %s isn't a block device?\n", __func__,
1335 fp = fopen("/proc/self/mounts", "r");
1338 mnt = getmntent(fp);
1342 if (!mnt->mnt_fsname || mnt->mnt_fsname[0] != '/')
1345 rc = stat(mnt->mnt_fsname, &mntstat);
1349 if (!S_ISBLK(mntstat.st_mode))
1352 if (mntstat.st_rdev == devstat.st_rdev) {
1353 dev->mount_path = talloc_strdup(dev, mnt->mnt_dir);
1354 dev->root_path = check_subvols(dev);
1355 dev->mounted_rw = !!hasmntopt(mnt, "rw");
1356 dev->mounted = true;
1357 dev->unmount = false;
1359 pb_debug("%s: %s is already mounted (r%c) at %s\n",
1360 __func__, dev->device_path,
1361 dev->mounted_rw ? 'w' : 'o',
1373 * Attempt to mount a filesystem safely, while handling certain filesytem-
1376 static int try_mount(const char *device_path, const char *mount_path,
1377 const char *fstype, unsigned long flags,
1380 const char *fs, *safe_opts;
1383 /* Mount ext3 as ext4 instead so 'norecovery' can be used */
1384 if (strncmp(fstype, "ext3", strlen("ext3")) == 0) {
1385 pb_debug("Mounting ext3 filesystem as ext4\n");
1390 if (strncmp(fs, "xfs", strlen("xfs")) == 0 ||
1391 strncmp(fs, "ext4", strlen("ext4")) == 0)
1392 safe_opts = "norecovery";
1397 /* If no snapshot is available don't attempt recovery */
1399 return mount(device_path, mount_path, fs, flags, safe_opts);
1401 rc = mount(device_path, mount_path, fs, flags, NULL);
1406 /* Mounting failed; some filesystems will fail to mount if a recovery
1407 * journal exists (eg. cross-endian XFS), so try again with norecovery
1408 * where that option is available.
1409 * If mounting read-write just return the error as norecovery is not a
1411 if ((flags & MS_RDONLY) != MS_RDONLY || !safe_opts)
1415 return mount(device_path, mount_path, fs, flags, safe_opts);
1418 static int mount_device(struct discover_device *dev)
1420 const char *fstype, *device_path;
1423 if (!dev->device_path)
1429 if (check_existing_mount(dev))
1432 fstype = discover_device_get_param(dev, "ID_FS_TYPE");
1436 dev->mount_path = join_paths(dev, mount_base(),
1439 if (pb_mkdir_recursive(dev->mount_path)) {
1440 pb_log("couldn't create mount directory %s: %s\n",
1441 dev->mount_path, strerror(errno));
1445 device_path = get_device_path(dev);
1447 pb_log("mounting device %s read-only\n", dev->device_path);
1448 rc = try_mount(device_path, dev->mount_path, fstype,
1449 MS_RDONLY | MS_SILENT, dev->ramdisk);
1452 dev->mounted = true;
1453 dev->mounted_rw = false;
1454 dev->unmount = true;
1455 dev->root_path = check_subvols(dev);
1459 pb_log("couldn't mount device %s: mount failed: %s\n",
1460 device_path, strerror(errno));
1462 /* If mount fails clean up any snapshot */
1463 devmapper_destroy_snapshot(dev);
1465 pb_rmdir_recursive(mount_base(), dev->mount_path);
1467 talloc_free(dev->mount_path);
1468 dev->mount_path = NULL;
1472 static int umount_device(struct discover_device *dev)
1474 const char *device_path;
1477 if (!dev->mounted || !dev->unmount)
1480 device_path = get_device_path(dev);
1482 pb_log("unmounting device %s\n", device_path);
1483 rc = umount(dev->mount_path);
1487 dev->mounted = false;
1488 devmapper_destroy_snapshot(dev);
1490 pb_rmdir_recursive(mount_base(), dev->mount_path);
1492 talloc_free(dev->mount_path);
1493 dev->mount_path = NULL;
1494 dev->root_path = NULL;
1499 int device_request_write(struct discover_device *dev, bool *release)
1501 const char *fstype, *device_path;
1502 const struct config *config;
1507 config = config_get();
1508 if (!config->allow_writes)
1514 if (dev->mounted_rw)
1517 fstype = discover_device_get_param(dev, "ID_FS_TYPE");
1519 device_path = get_device_path(dev);
1521 pb_log("remounting device %s read-write\n", device_path);
1523 rc = umount(dev->mount_path);
1525 pb_log("Failed to unmount %s: %s\n",
1526 dev->mount_path, strerror(errno));
1530 rc = try_mount(device_path, dev->mount_path, fstype,
1531 MS_SILENT, dev->ramdisk);
1535 dev->mounted_rw = true;
1540 pb_log("Unable to remount device %s read-write: %s\n",
1541 device_path, strerror(errno));
1542 rc = try_mount(device_path, dev->mount_path, fstype,
1543 MS_RDONLY | MS_SILENT, dev->ramdisk);
1545 pb_log("Unable to recover mount for %s: %s\n",
1546 device_path, strerror(errno));
1550 void device_release_write(struct discover_device *dev, bool release)
1552 const char *fstype, *device_path;
1557 device_path = get_device_path(dev);
1559 fstype = discover_device_get_param(dev, "ID_FS_TYPE");
1561 pb_log("remounting device %s read-only\n", device_path);
1563 if (umount(dev->mount_path)) {
1564 pb_log("Failed to unmount %s\n", dev->mount_path);
1567 dev->mounted_rw = dev->mounted = false;
1570 devmapper_merge_snapshot(dev);
1571 /* device_path becomes stale after merge */
1572 device_path = get_device_path(dev);
1575 if (try_mount(device_path, dev->mount_path, fstype,
1576 MS_RDONLY | MS_SILENT, dev->ramdisk))
1577 pb_log("Failed to remount %s read-only: %s\n",
1578 device_path, strerror(errno));
1580 dev->mounted = true;
1583 void device_sync_snapshots(struct device_handler *handler, const char *device)
1585 struct discover_device *dev = NULL;
1589 /* Find matching device and sync */
1590 dev = device_lookup_by_name(handler, device);
1592 pb_log("%s: device name '%s' unrecognised\n",
1597 device_release_write(dev, true);
1599 pb_log("%s has no snapshot to merge, skipping\n",
1604 /* Otherwise sync all relevant devices */
1605 for (i = 0; i < handler->n_devices; i++) {
1606 dev = handler->devices[i];
1607 if (dev->device->type != DEVICE_TYPE_DISK &&
1608 dev->device->type != DEVICE_TYPE_USB)
1611 device_release_write(dev, true);
1613 pb_log("%s has no snapshot to merge, skipping\n",
1620 void device_handler_discover_context_commit(
1621 struct device_handler *handler __attribute__((unused)),
1622 struct discover_context *ctx __attribute__((unused)))
1624 pb_log("%s stubbed out for test cases\n", __func__);
1627 static void device_handler_update_lang(const char *lang __attribute__((unused)))
1631 static int device_handler_init_sources(
1632 struct device_handler *handler __attribute__((unused)))
1637 static void device_handler_reinit_sources(
1638 struct device_handler *handler __attribute__((unused)))
1642 static int umount_device(struct discover_device *dev __attribute__((unused)))
1647 static int __attribute__((unused)) mount_device(
1648 struct discover_device *dev __attribute__((unused)))
1653 int device_request_write(struct discover_device *dev __attribute__((unused)),
1660 void device_release_write(struct discover_device *dev __attribute__((unused)),
1661 bool release __attribute__((unused)))
1665 void device_sync_snapshots(
1666 struct device_handler *handler __attribute__((unused)),
1667 const char *device __attribute__((unused)))