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,
226 struct discover_device *dev;
228 dev = device_lookup_by_id(handler, id);
232 dev = talloc_zero(handler, struct discover_device);
233 dev->device = talloc_zero(dev, struct device);
234 dev->device->id = talloc_strdup(dev->device, id);
235 list_init(&dev->params);
236 list_init(&dev->boot_options);
238 talloc_set_destructor(dev, destroy_device);
243 struct discover_device_param {
246 struct list_item list;
249 void discover_device_set_param(struct discover_device *device,
250 const char *name, const char *value)
252 struct discover_device_param *param;
255 list_for_each_entry(&device->params, param, list) {
256 if (!strcmp(param->name, name)) {
265 param = talloc(device, struct discover_device_param);
266 param->name = talloc_strdup(param, name);
267 list_add(&device->params, ¶m->list);
270 list_remove(¶m->list);
274 talloc_free(param->value);
277 param->value = talloc_strdup(param, value);
280 const char *discover_device_get_param(struct discover_device *device,
283 struct discover_device_param *param;
285 list_for_each_entry(&device->params, param, list) {
286 if (!strcmp(param->name, name))
292 struct device_handler *device_handler_init(struct discover_server *server,
293 struct waitset *waitset, int dry_run)
295 struct device_handler *handler;
298 handler = talloc_zero(NULL, struct device_handler);
299 handler->server = server;
300 handler->waitset = waitset;
301 handler->dry_run = dry_run;
302 handler->autoboot_enabled = config_get()->autoboot_enabled;
304 list_init(&handler->unresolved_boot_options);
306 /* set up our mount point base */
307 pb_mkdir_recursive(mount_base());
311 if (config_get()->safe_mode)
314 rc = device_handler_init_sources(handler);
316 talloc_free(handler);
323 void device_handler_reinit(struct device_handler *handler)
325 struct discover_boot_option *opt, *tmp;
326 struct ramdisk_device *ramdisk;
329 device_handler_cancel_default(handler);
331 /* free unresolved boot options */
332 list_for_each_entry_safe(&handler->unresolved_boot_options,
335 list_init(&handler->unresolved_boot_options);
337 /* drop all devices */
338 for (i = 0; i < handler->n_devices; i++) {
339 discover_server_notify_device_remove(handler->server,
340 handler->devices[i]->device);
341 ramdisk = handler->devices[i]->ramdisk;
342 talloc_free(handler->devices[i]);
343 talloc_free(ramdisk);
346 talloc_free(handler->devices);
347 handler->devices = NULL;
348 handler->n_devices = 0;
349 talloc_free(handler->ramdisks);
350 handler->ramdisks = NULL;
351 handler->n_ramdisks = 0;
353 device_handler_reinit_sources(handler);
356 void device_handler_remove(struct device_handler *handler,
357 struct discover_device *device)
359 struct discover_boot_option *opt, *tmp;
362 list_for_each_entry_safe(&device->boot_options, opt, tmp, list) {
363 if (opt == handler->default_boot_option) {
364 pb_log("Default option %s cancelled since device removed",
366 device_handler_cancel_default(handler);
371 for (i = 0; i < handler->n_devices; i++)
372 if (handler->devices[i] == device)
375 if (i == handler->n_devices) {
380 /* Free any unresolved options, as they're currently allocated
381 * against the handler */
382 list_for_each_entry_safe(&handler->unresolved_boot_options,
384 if (opt->device != device)
386 list_remove(&opt->list);
390 /* if this is a network device, we have to unregister it from the
392 if (device->device->type == DEVICE_TYPE_NETWORK)
393 network_unregister_device(handler->network, device);
395 handler->n_devices--;
396 memmove(&handler->devices[i], &handler->devices[i + 1],
397 (handler->n_devices - i) * sizeof(handler->devices[0]));
398 handler->devices = talloc_realloc(handler, handler->devices,
399 struct discover_device *, handler->n_devices);
401 if (device->notified)
402 discover_server_notify_device_remove(handler->server,
408 void device_handler_boot_status(void *arg, struct boot_status *status)
410 struct device_handler *handler = arg;
412 discover_server_notify_boot_status(handler->server, status);
415 static void countdown_status(struct device_handler *handler,
416 struct discover_boot_option *opt, unsigned int sec)
418 struct boot_status status;
420 status.type = BOOT_STATUS_INFO;
421 status.progress = -1;
422 status.detail = NULL;
423 status.message = talloc_asprintf(handler,
424 _("Booting in %d sec: %s"), sec, opt->option->name);
426 discover_server_notify_boot_status(handler->server, &status);
428 talloc_free(status.message);
431 static int default_timeout(void *arg)
433 struct device_handler *handler = arg;
434 struct discover_boot_option *opt;
436 if (!handler->default_boot_option)
439 if (handler->pending_boot)
442 opt = handler->default_boot_option;
444 if (handler->sec_to_boot) {
445 countdown_status(handler, opt, handler->sec_to_boot);
446 handler->sec_to_boot--;
447 handler->timeout_waiter = waiter_register_timeout(
448 handler->waitset, 1000,
449 default_timeout, handler);
453 handler->timeout_waiter = NULL;
455 pb_log("Timeout expired, booting default option %s\n", opt->option->id);
459 handler->pending_boot = boot(handler, handler->default_boot_option,
460 NULL, handler->dry_run, device_handler_boot_status,
462 handler->pending_boot_is_default = true;
467 enum ipmi_bootdev ipmi_type;
468 enum device_type device_type;
469 } device_type_map[] = {
470 { IPMI_BOOTDEV_NETWORK, DEVICE_TYPE_NETWORK },
471 { IPMI_BOOTDEV_DISK, DEVICE_TYPE_DISK },
472 { IPMI_BOOTDEV_DISK, DEVICE_TYPE_USB },
473 { IPMI_BOOTDEV_CDROM, DEVICE_TYPE_OPTICAL },
476 static bool ipmi_device_type_matches(enum ipmi_bootdev ipmi_type,
477 enum device_type device_type)
481 for (i = 0; i < ARRAY_SIZE(device_type_map); i++) {
482 if (device_type_map[i].device_type == device_type)
483 return device_type_map[i].ipmi_type == ipmi_type;
489 static int autoboot_option_priority(const struct config *config,
490 struct discover_boot_option *opt)
492 enum device_type type = opt->device->device->type;
493 const char *uuid = opt->device->uuid;
494 struct autoboot_option *auto_opt;
497 for (i = 0; i < config->n_autoboot_opts; i++) {
498 auto_opt = &config->autoboot_opts[i];
499 if (auto_opt->boot_type == BOOT_DEVICE_UUID)
500 if (!strcmp(auto_opt->uuid, uuid))
501 return DEFAULT_PRIORITY_LOCAL_FIRST + i;
503 if (auto_opt->boot_type == BOOT_DEVICE_TYPE)
504 if (auto_opt->type == type ||
505 auto_opt->type == DEVICE_TYPE_ANY)
506 return DEFAULT_PRIORITY_LOCAL_FIRST + i;
513 * We have different priorities to resolve conflicts between boot options that
514 * report to be the default for their device. This function assigns a priority
517 static enum default_priority default_option_priority(
518 struct discover_boot_option *opt)
520 const struct config *config;
522 config = config_get();
524 /* We give highest priority to IPMI-configured boot options. If
525 * we have an IPMI bootdev configuration set, then we don't allow
526 * any other defaults */
527 if (config->ipmi_bootdev) {
528 bool ipmi_match = ipmi_device_type_matches(config->ipmi_bootdev,
529 opt->device->device->type);
531 return DEFAULT_PRIORITY_REMOTE;
533 pb_debug("handler: disabled default priority due to "
534 "non-matching IPMI type %x\n",
535 config->ipmi_bootdev);
536 return DEFAULT_PRIORITY_DISABLED;
539 /* Next, try to match the option against the user-defined autoboot
540 * options, either by device UUID or type. */
541 if (config->n_autoboot_opts) {
542 int boot_match = autoboot_option_priority(config, opt);
547 /* If the option didn't match any entry in the array, it is disabled */
548 pb_debug("handler: disabled default priority due to "
549 "non-matching UUID or type\n");
550 return DEFAULT_PRIORITY_DISABLED;
553 static void set_default(struct device_handler *handler,
554 struct discover_boot_option *opt)
556 enum default_priority cur_prio, new_prio;
558 if (!handler->autoboot_enabled)
561 pb_debug("handler: new default option: %s\n", opt->option->id);
563 new_prio = default_option_priority(opt);
565 /* Anything outside our range prevents a default boot */
566 if (new_prio >= DEFAULT_PRIORITY_DISABLED)
569 pb_debug("handler: calculated priority %d\n", new_prio);
571 /* Resolve any conflicts: if we have a new default option, it only
572 * replaces the current if it has a higher priority. */
573 if (handler->default_boot_option) {
575 cur_prio = handler->default_boot_option_priority;
577 if (new_prio < cur_prio) {
578 pb_log("handler: new prio %d beats "
579 "old prio %d for %s\n",
581 handler->default_boot_option
583 handler->default_boot_option = opt;
584 handler->default_boot_option_priority = new_prio;
585 /* extend the timeout a little, so the user sees some
586 * indication of the change */
587 handler->sec_to_boot += 2;
593 handler->sec_to_boot = config_get()->autoboot_timeout_sec;
594 handler->default_boot_option = opt;
595 handler->default_boot_option_priority = new_prio;
597 pb_log("handler: boot option %s set as default, timeout %u sec.\n",
598 opt->option->id, handler->sec_to_boot);
600 default_timeout(handler);
603 static bool resource_is_resolved(struct resource *res)
605 return !res || res->resolved;
608 /* We only use this in an assert, which will disappear if we're compiling
609 * with NDEBUG, so we need the 'used' attribute for these builds */
610 static bool __attribute__((used)) boot_option_is_resolved(
611 struct discover_boot_option *opt)
613 return resource_is_resolved(opt->boot_image) &&
614 resource_is_resolved(opt->initrd) &&
615 resource_is_resolved(opt->dtb) &&
616 resource_is_resolved(opt->args_sig_file) &&
617 resource_is_resolved(opt->icon);
620 static bool resource_resolve(struct resource *res, const char *name,
621 struct discover_boot_option *opt,
622 struct device_handler *handler)
624 struct parser *parser = opt->source;
626 if (resource_is_resolved(res))
629 pb_debug("Attempting to resolve resource %s->%s with parser %s\n",
630 opt->option->id, name, parser->name);
631 parser->resolve_resource(handler, res);
633 return res->resolved;
636 static bool boot_option_resolve(struct discover_boot_option *opt,
637 struct device_handler *handler)
639 return resource_resolve(opt->boot_image, "boot_image", opt, handler) &&
640 resource_resolve(opt->initrd, "initrd", opt, handler) &&
641 resource_resolve(opt->dtb, "dtb", opt, handler) &&
642 resource_resolve(opt->args_sig_file, "args_sig_file", opt,
644 resource_resolve(opt->icon, "icon", opt, handler);
647 static void boot_option_finalise(struct device_handler *handler,
648 struct discover_boot_option *opt)
650 assert(boot_option_is_resolved(opt));
652 /* check that the parsers haven't set any of the final data */
653 assert(!opt->option->boot_image_file);
654 assert(!opt->option->initrd_file);
655 assert(!opt->option->dtb_file);
656 assert(!opt->option->icon_file);
657 assert(!opt->option->device_id);
658 assert(!opt->option->args_sig_file);
661 opt->option->boot_image_file = opt->boot_image->url->full;
663 opt->option->initrd_file = opt->initrd->url->full;
665 opt->option->dtb_file = opt->dtb->url->full;
667 opt->option->icon_file = opt->icon->url->full;
668 if (opt->args_sig_file)
669 opt->option->args_sig_file = opt->args_sig_file->url->full;
671 opt->option->device_id = opt->device->device->id;
673 if (opt->option->is_default)
674 set_default(handler, opt);
677 static void notify_boot_option(struct device_handler *handler,
678 struct discover_boot_option *opt)
680 struct discover_device *dev = opt->device;
683 discover_server_notify_device_add(handler->server,
684 opt->device->device);
685 dev->notified = true;
686 discover_server_notify_boot_option_add(handler->server, opt->option);
689 static void process_boot_option_queue(struct device_handler *handler)
691 struct discover_boot_option *opt, *tmp;
693 list_for_each_entry_safe(&handler->unresolved_boot_options,
696 pb_debug("queue: attempting resolution for %s\n",
699 if (!boot_option_resolve(opt, handler))
702 pb_debug("\tresolved!\n");
704 list_remove(&opt->list);
705 list_add_tail(&opt->device->boot_options, &opt->list);
706 talloc_steal(opt->device, opt);
707 boot_option_finalise(handler, opt);
708 notify_boot_option(handler, opt);
712 struct discover_context *device_handler_discover_context_create(
713 struct device_handler *handler,
714 struct discover_device *device)
716 struct discover_context *ctx;
718 ctx = talloc_zero(handler, struct discover_context);
719 ctx->device = device;
720 ctx->network = handler->network;
721 list_init(&ctx->boot_options);
726 void device_handler_add_device(struct device_handler *handler,
727 struct discover_device *device)
729 handler->n_devices++;
730 handler->devices = talloc_realloc(handler, handler->devices,
731 struct discover_device *, handler->n_devices);
732 handler->devices[handler->n_devices - 1] = device;
734 if (device->device->type == DEVICE_TYPE_NETWORK)
735 network_register_device(handler->network, device);
738 void device_handler_add_ramdisk(struct device_handler *handler,
741 struct ramdisk_device *dev;
747 for (i = 0; i < handler->n_ramdisks; i++)
748 if (!strcmp(handler->ramdisks[i]->path, path))
751 dev = talloc_zero(handler, struct ramdisk_device);
753 pb_log("Failed to allocate memory to track %s\n", path);
757 dev->path = talloc_strdup(handler, path);
759 handler->ramdisks = talloc_realloc(handler, handler->ramdisks,
760 struct ramdisk_device *,
761 handler->n_ramdisks + 1);
762 if (!handler->ramdisks) {
763 pb_log("Failed to reallocate memory"
764 "- ramdisk tracking inconsistent!\n");
768 handler->ramdisks[i] = dev;
769 i = handler->n_ramdisks++;
772 struct ramdisk_device *device_handler_get_ramdisk(
773 struct device_handler *handler)
779 /* Check if free ramdisk exists */
780 for (i = 0; i < handler->n_ramdisks; i++)
781 if (!handler->ramdisks[i]->snapshot &&
782 !handler->ramdisks[i]->origin &&
783 !handler->ramdisks[i]->base)
784 return handler->ramdisks[i];
786 /* Otherwise create a new one */
787 name = talloc_asprintf(handler, "/dev/ram%d",
788 handler->n_ramdisks);
790 pb_debug("Failed to allocate memory to name /dev/ram%d",
791 handler->n_ramdisks);
795 id = makedev(1, handler->n_ramdisks);
796 if (mknod(name, S_IFBLK, id)) {
797 if (errno == EEXIST) {
798 /* We haven't yet received updates for existing
799 * ramdisks - add and use this one */
800 pb_debug("Using untracked ramdisk %s\n", name);
802 pb_log("Failed to create new ramdisk %s: %s\n",
803 name, strerror(errno));
807 device_handler_add_ramdisk(handler, name);
810 return handler->ramdisks[i];
813 void device_handler_release_ramdisk(struct discover_device *device)
815 struct ramdisk_device *ramdisk = device->ramdisk;
817 talloc_free(ramdisk->snapshot);
818 talloc_free(ramdisk->origin);
819 talloc_free(ramdisk->base);
821 ramdisk->snapshot = ramdisk->origin = ramdisk->base = NULL;
822 ramdisk->sectors = 0;
824 device->ramdisk = NULL;
827 /* Start discovery on a hotplugged device. The device will be in our devices
828 * array, but has only just been initialised by the hotplug source.
830 int device_handler_discover(struct device_handler *handler,
831 struct discover_device *dev)
833 struct discover_context *ctx;
834 struct boot_status *status;
837 status = talloc_zero(handler, struct boot_status);
838 status->type = BOOT_STATUS_INFO;
840 * TRANSLATORS: this string will be passed the type and identifier
841 * of the device. For example, the first parameter could be "Disk",
842 * (which will be translated accordingly) and the second a Linux device
843 * identifier like 'sda1' (which will not be translated)
845 status->message = talloc_asprintf(status, _("Processing %s device %s"),
846 device_type_display_name(dev->device->type),
848 device_handler_boot_status(handler, status);
850 process_boot_option_queue(handler);
852 /* create our context */
853 ctx = device_handler_discover_context_create(handler, dev);
855 rc = mount_device(dev);
859 /* add this device to our system info */
860 system_info_register_blockdev(dev->device->id, dev->uuid,
863 /* run the parsers. This will populate the ctx's boot_option list. */
864 iterate_parsers(ctx);
866 /* add discovered stuff to the handler */
867 device_handler_discover_context_commit(handler, ctx);
871 * TRANSLATORS: the format specifier in this string is a Linux
872 * device identifier, like 'sda1'
874 status->message = talloc_asprintf(status,_("Processing %s complete"),
876 device_handler_boot_status(handler, status);
879 talloc_unlink(handler, ctx);
884 /* Incoming dhcp event */
885 int device_handler_dhcp(struct device_handler *handler,
886 struct discover_device *dev, struct event *event)
888 struct discover_context *ctx;
889 struct boot_status *status;
891 status = talloc_zero(handler, struct boot_status);
892 status->type = BOOT_STATUS_INFO;
894 * TRANSLATORS: this format specifier will be the name of a network
895 * device, like 'eth0'.
897 status->message = talloc_asprintf(status, _("Processing dhcp event on %s"),
899 device_handler_boot_status(handler, status);
901 /* create our context */
902 ctx = device_handler_discover_context_create(handler, dev);
903 talloc_steal(ctx, event);
906 iterate_parsers(ctx);
908 device_handler_discover_context_commit(handler, ctx);
911 * TRANSLATORS: this format specifier will be the name of a network
912 * device, like 'eth0'.
914 status->message = talloc_asprintf(status,_("Processing %s complete"),
916 device_handler_boot_status(handler, status);
919 talloc_unlink(handler, ctx);
924 /* incoming conf event */
925 int device_handler_conf(struct device_handler *handler,
926 struct discover_device *dev, struct pb_url *url)
928 struct discover_context *ctx;
929 struct boot_status *status;
931 status = talloc_zero(handler, struct boot_status);
932 status->type = BOOT_STATUS_INFO;
933 status->message = talloc_asprintf(status, _("Processing user config"));
934 device_handler_boot_status(handler, status);
936 /* create our context */
937 ctx = device_handler_discover_context_create(handler, dev);
940 iterate_parsers(ctx);
942 device_handler_discover_context_commit(handler, ctx);
944 status->message = talloc_asprintf(status,
945 _("Processing user config complete"));
946 device_handler_boot_status(handler, status);
949 talloc_unlink(handler, ctx);
954 static struct discover_boot_option *find_boot_option_by_id(
955 struct device_handler *handler, const char *id)
959 for (i = 0; i < handler->n_devices; i++) {
960 struct discover_device *dev = handler->devices[i];
961 struct discover_boot_option *opt;
963 list_for_each_entry(&dev->boot_options, opt, list)
964 if (!strcmp(opt->option->id, id))
971 void device_handler_boot(struct device_handler *handler,
972 struct boot_command *cmd)
974 struct discover_boot_option *opt = NULL;
976 if (cmd->option_id && strlen(cmd->option_id))
977 opt = find_boot_option_by_id(handler, cmd->option_id);
979 if (handler->pending_boot)
980 boot_cancel(handler->pending_boot);
984 handler->pending_boot = boot(handler, opt, cmd, handler->dry_run,
985 device_handler_boot_status, handler);
986 handler->pending_boot_is_default = false;
989 void device_handler_cancel_default(struct device_handler *handler)
991 struct boot_status status;
993 if (handler->timeout_waiter)
994 waiter_remove(handler->timeout_waiter);
996 handler->timeout_waiter = NULL;
997 handler->autoboot_enabled = false;
999 /* we only send status if we had a default boot option queued */
1000 if (!handler->default_boot_option)
1003 pb_log("Cancelling default boot option\n");
1005 if (handler->pending_boot && handler->pending_boot_is_default) {
1006 boot_cancel(handler->pending_boot);
1007 handler->pending_boot = NULL;
1008 handler->pending_boot_is_default = false;
1011 handler->default_boot_option = NULL;
1013 status.type = BOOT_STATUS_INFO;
1014 status.progress = -1;
1015 status.detail = NULL;
1016 status.message = _("Default boot cancelled");
1018 discover_server_notify_boot_status(handler->server, &status);
1021 void device_handler_update_config(struct device_handler *handler,
1022 struct config *config)
1026 rc = config_set(config);
1030 discover_server_notify_config(handler->server, config);
1031 device_handler_update_lang(config->lang);
1032 device_handler_reinit(handler);
1035 static char *device_from_addr(void *ctx, struct pb_url *url)
1037 char *ipaddr, *buf, *tok, *dev = NULL;
1038 const char *delim = " ";
1039 struct sockaddr_in *ip;
1040 struct sockaddr_in si;
1041 struct addrinfo *res;
1045 /* Note: IPv4 only */
1046 rc = inet_pton(AF_INET, url->host, &(si.sin_addr));
1050 /* need to turn hostname into a valid IP */
1051 rc = getaddrinfo(url->host, NULL, NULL, &res);
1053 pb_debug("%s: Invalid URL\n",__func__);
1056 ipaddr = talloc_array(ctx,char,INET_ADDRSTRLEN);
1057 ip = (struct sockaddr_in *) res->ai_addr;
1058 inet_ntop(AF_INET, &(ip->sin_addr), ipaddr, INET_ADDRSTRLEN);
1062 const char *argv[] = {
1064 "route", "show", "to", "match",
1069 p = process_create(ctx);
1071 p->path = pb_system_apps.ip;
1073 p->keep_stdout = true;
1075 rc = process_run_sync(p);
1077 if (rc || p->exit_status) {
1078 /* ip has complained for some reason; most likely
1079 * there is no route to the host - bail out */
1080 pb_debug("%s: `ip` returns non-zero exit status\n", __func__);
1081 pb_debug("ip buf: %s\n", p->stdout_buf);
1086 buf = p->stdout_buf;
1087 /* If a route is found, ip-route output will be of the form
1088 * "... dev DEVNAME ... " */
1089 tok = strtok(buf, delim);
1091 if (!strcmp(tok, "dev")) {
1092 tok = strtok(NULL, delim);
1093 dev = talloc_strdup(ctx, tok);
1096 tok = strtok(NULL, delim);
1101 pb_debug("%s: Found interface '%s'\n", __func__,dev);
1105 void device_handler_process_url(struct device_handler *handler,
1106 const char *url, const char *mac, const char *ip)
1108 struct discover_context *ctx;
1109 struct discover_device *dev;
1110 struct boot_status *status;
1111 struct pb_url *pb_url;
1112 struct event *event;
1113 struct param *param;
1115 status = talloc(handler, struct boot_status);
1117 status->type = BOOT_STATUS_ERROR;
1118 status->progress = 0;
1119 status->detail = talloc_asprintf(status,
1120 _("Received config URL %s"), url);
1122 if (!handler->network) {
1123 status->message = talloc_asprintf(handler,
1124 _("No network configured"));
1128 event = talloc(handler, struct event);
1129 event->type = EVENT_TYPE_USER;
1130 event->action = EVENT_ACTION_CONF;
1132 if (url[strlen(url) - 1] == '/') {
1133 event->params = talloc_array(event, struct param, 3);
1134 param = &event->params[0];
1135 param->name = talloc_strdup(event, "pxepathprefix");
1136 param->value = talloc_strdup(event, url);
1137 param = &event->params[1];
1138 param->name = talloc_strdup(event, "mac");
1139 param->value = talloc_strdup(event, mac);
1140 param = &event->params[2];
1141 param->name = talloc_strdup(event, "ip");
1142 param->value = talloc_strdup(event, ip);
1143 event->n_params = 3;
1145 event->params = talloc_array(event, struct param, 1);
1146 param = &event->params[0];
1147 param->name = talloc_strdup(event, "pxeconffile");
1148 param->value = talloc_strdup(event, url);
1149 event->n_params = 1;
1152 pb_url = pb_url_parse(event, event->params->value);
1153 if (!pb_url || (pb_url->scheme != pb_url_file && !pb_url->host)) {
1154 status->message = talloc_asprintf(handler,
1155 _("Invalid config URL!"));
1159 if (pb_url->scheme == pb_url_file)
1160 event->device = talloc_asprintf(event, "local");
1162 event->device = device_from_addr(event, pb_url);
1164 if (!event->device) {
1165 status->message = talloc_asprintf(status,
1166 _("Unable to route to host %s"),
1171 dev = discover_device_create(handler, event->device);
1172 if (pb_url->scheme == pb_url_file)
1173 dev->device->type = DEVICE_TYPE_ANY;
1174 ctx = device_handler_discover_context_create(handler, dev);
1175 talloc_steal(ctx, event);
1178 iterate_parsers(ctx);
1180 device_handler_discover_context_commit(handler, ctx);
1182 talloc_unlink(handler, ctx);
1184 status->type = BOOT_STATUS_INFO;
1185 status->message = talloc_asprintf(status, _("Config file %s parsed"),
1188 device_handler_boot_status(handler, status);
1189 talloc_free(status);
1192 #ifndef PETITBOOT_TEST
1195 * context_commit - Commit a temporary discovery context to the handler,
1196 * and notify the clients about any new options / devices
1198 void device_handler_discover_context_commit(struct device_handler *handler,
1199 struct discover_context *ctx)
1201 struct discover_device *dev = ctx->device;
1202 struct discover_boot_option *opt, *tmp;
1204 if (!device_lookup_by_id(handler, dev->device->id))
1205 device_handler_add_device(handler, dev);
1207 /* move boot options from the context to the device */
1208 list_for_each_entry_safe(&ctx->boot_options, opt, tmp, list) {
1209 list_remove(&opt->list);
1211 /* All boot options need at least a kernel image */
1212 if (!opt->boot_image || !opt->boot_image->url) {
1213 pb_log("boot option %s is missing boot image, ignoring\n",
1219 if (boot_option_resolve(opt, handler)) {
1220 pb_log("boot option %s is resolved, "
1221 "sending to clients\n",
1223 list_add_tail(&dev->boot_options, &opt->list);
1224 talloc_steal(dev, opt);
1225 boot_option_finalise(handler, opt);
1226 notify_boot_option(handler, opt);
1228 if (!opt->source->resolve_resource) {
1229 pb_log("parser %s gave us an unresolved "
1230 "resource (%s), but no way to "
1232 opt->source->name, opt->option->id);
1235 pb_log("boot option %s is unresolved, "
1236 "adding to queue\n",
1238 list_add(&handler->unresolved_boot_options,
1240 talloc_steal(handler, opt);
1246 static void device_handler_update_lang(const char *lang)
1248 const char *cur_lang;
1253 cur_lang = setlocale(LC_ALL, NULL);
1254 if (cur_lang && !strcmp(cur_lang, lang))
1257 setlocale(LC_ALL, lang);
1260 static int device_handler_init_sources(struct device_handler *handler)
1262 /* init our device sources: udev, network and user events */
1263 handler->udev = udev_init(handler, handler->waitset);
1267 handler->network = network_init(handler, handler->waitset,
1269 if (!handler->network)
1272 handler->user_event = user_event_init(handler, handler->waitset);
1273 if (!handler->user_event)
1279 static void device_handler_reinit_sources(struct device_handler *handler)
1281 /* if we haven't initialised sources previously (becuase we started in
1282 * safe mode), then init once here. */
1283 if (!(handler->udev || handler->network || handler->user_event)) {
1284 device_handler_init_sources(handler);
1288 udev_reinit(handler->udev);
1290 network_shutdown(handler->network);
1291 handler->network = network_init(handler, handler->waitset,
1295 static inline const char *get_device_path(struct discover_device *dev)
1297 return dev->ramdisk ? dev->ramdisk->snapshot : dev->device_path;
1300 static char *check_subvols(struct discover_device *dev)
1302 const char *fstype = discover_device_get_param(dev, "ID_FS_TYPE");
1307 if (strncmp(fstype, "btrfs", strlen("btrfs")))
1308 return dev->mount_path;
1310 /* On btrfs a device's root may be under a subvolume path */
1311 path = join_paths(dev, dev->mount_path, "@");
1312 rc = stat(path, &sb);
1313 if (!rc && S_ISDIR(sb.st_mode)) {
1314 pb_debug("Using '%s' for btrfs root path\n", path);
1319 return dev->mount_path;
1322 static bool check_existing_mount(struct discover_device *dev)
1324 struct stat devstat, mntstat;
1325 const char *device_path;
1330 device_path = get_device_path(dev);
1332 rc = stat(device_path, &devstat);
1334 pb_debug("%s: stat failed: %s\n", __func__, strerror(errno));
1338 if (!S_ISBLK(devstat.st_mode)) {
1339 pb_debug("%s: %s isn't a block device?\n", __func__,
1344 fp = fopen("/proc/self/mounts", "r");
1347 mnt = getmntent(fp);
1351 if (!mnt->mnt_fsname || mnt->mnt_fsname[0] != '/')
1354 rc = stat(mnt->mnt_fsname, &mntstat);
1358 if (!S_ISBLK(mntstat.st_mode))
1361 if (mntstat.st_rdev == devstat.st_rdev) {
1362 dev->mount_path = talloc_strdup(dev, mnt->mnt_dir);
1363 dev->root_path = check_subvols(dev);
1364 dev->mounted_rw = !!hasmntopt(mnt, "rw");
1365 dev->mounted = true;
1366 dev->unmount = false;
1368 pb_debug("%s: %s is already mounted (r%c) at %s\n",
1369 __func__, dev->device_path,
1370 dev->mounted_rw ? 'w' : 'o',
1382 * Attempt to mount a filesystem safely, while handling certain filesytem-
1385 static int try_mount(const char *device_path, const char *mount_path,
1386 const char *fstype, unsigned long flags,
1389 const char *fs, *safe_opts;
1392 /* Mount ext3 as ext4 instead so 'norecovery' can be used */
1393 if (strncmp(fstype, "ext3", strlen("ext3")) == 0) {
1394 pb_debug("Mounting ext3 filesystem as ext4\n");
1399 if (strncmp(fs, "xfs", strlen("xfs")) == 0 ||
1400 strncmp(fs, "ext4", strlen("ext4")) == 0)
1401 safe_opts = "norecovery";
1406 /* If no snapshot is available don't attempt recovery */
1408 return mount(device_path, mount_path, fs, flags, safe_opts);
1410 rc = mount(device_path, mount_path, fs, flags, NULL);
1415 /* Mounting failed; some filesystems will fail to mount if a recovery
1416 * journal exists (eg. cross-endian XFS), so try again with norecovery
1417 * where that option is available.
1418 * If mounting read-write just return the error as norecovery is not a
1420 if ((flags & MS_RDONLY) != MS_RDONLY || !safe_opts)
1424 return mount(device_path, mount_path, fs, flags, safe_opts);
1427 static int mount_device(struct discover_device *dev)
1429 const char *fstype, *device_path;
1432 if (!dev->device_path)
1438 if (check_existing_mount(dev))
1441 fstype = discover_device_get_param(dev, "ID_FS_TYPE");
1445 dev->mount_path = join_paths(dev, mount_base(),
1448 if (pb_mkdir_recursive(dev->mount_path)) {
1449 pb_log("couldn't create mount directory %s: %s\n",
1450 dev->mount_path, strerror(errno));
1454 device_path = get_device_path(dev);
1456 pb_log("mounting device %s read-only\n", dev->device_path);
1457 rc = try_mount(device_path, dev->mount_path, fstype,
1458 MS_RDONLY | MS_SILENT, dev->ramdisk);
1461 dev->mounted = true;
1462 dev->mounted_rw = false;
1463 dev->unmount = true;
1464 dev->root_path = check_subvols(dev);
1468 pb_log("couldn't mount device %s: mount failed: %s\n",
1469 device_path, strerror(errno));
1471 /* If mount fails clean up any snapshot */
1472 devmapper_destroy_snapshot(dev);
1474 pb_rmdir_recursive(mount_base(), dev->mount_path);
1476 talloc_free(dev->mount_path);
1477 dev->mount_path = NULL;
1481 static int umount_device(struct discover_device *dev)
1483 const char *device_path;
1486 if (!dev->mounted || !dev->unmount)
1489 device_path = get_device_path(dev);
1491 pb_log("unmounting device %s\n", device_path);
1492 rc = umount(dev->mount_path);
1496 dev->mounted = false;
1497 devmapper_destroy_snapshot(dev);
1499 pb_rmdir_recursive(mount_base(), dev->mount_path);
1501 talloc_free(dev->mount_path);
1502 dev->mount_path = NULL;
1503 dev->root_path = NULL;
1508 int device_request_write(struct discover_device *dev, bool *release)
1510 const char *fstype, *device_path;
1511 const struct config *config;
1516 config = config_get();
1517 if (!config->allow_writes)
1523 if (dev->mounted_rw)
1526 fstype = discover_device_get_param(dev, "ID_FS_TYPE");
1528 device_path = get_device_path(dev);
1530 pb_log("remounting device %s read-write\n", device_path);
1532 rc = umount(dev->mount_path);
1534 pb_log("Failed to unmount %s: %s\n",
1535 dev->mount_path, strerror(errno));
1539 rc = try_mount(device_path, dev->mount_path, fstype,
1540 MS_SILENT, dev->ramdisk);
1544 dev->mounted_rw = true;
1549 pb_log("Unable to remount device %s read-write: %s\n",
1550 device_path, strerror(errno));
1551 rc = try_mount(device_path, dev->mount_path, fstype,
1552 MS_RDONLY | MS_SILENT, dev->ramdisk);
1554 pb_log("Unable to recover mount for %s: %s\n",
1555 device_path, strerror(errno));
1559 void device_release_write(struct discover_device *dev, bool release)
1561 const char *fstype, *device_path;
1566 device_path = get_device_path(dev);
1568 fstype = discover_device_get_param(dev, "ID_FS_TYPE");
1570 pb_log("remounting device %s read-only\n", device_path);
1572 if (umount(dev->mount_path)) {
1573 pb_log("Failed to unmount %s\n", dev->mount_path);
1576 dev->mounted_rw = dev->mounted = false;
1579 devmapper_merge_snapshot(dev);
1580 /* device_path becomes stale after merge */
1581 device_path = get_device_path(dev);
1584 if (try_mount(device_path, dev->mount_path, fstype,
1585 MS_RDONLY | MS_SILENT, dev->ramdisk))
1586 pb_log("Failed to remount %s read-only: %s\n",
1587 device_path, strerror(errno));
1589 dev->mounted = true;
1592 void device_sync_snapshots(struct device_handler *handler, const char *device)
1594 struct discover_device *dev = NULL;
1598 /* Find matching device and sync */
1599 dev = device_lookup_by_name(handler, device);
1601 pb_log("%s: device name '%s' unrecognised\n",
1606 device_release_write(dev, true);
1608 pb_log("%s has no snapshot to merge, skipping\n",
1613 /* Otherwise sync all relevant devices */
1614 for (i = 0; i < handler->n_devices; i++) {
1615 dev = handler->devices[i];
1616 if (dev->device->type != DEVICE_TYPE_DISK &&
1617 dev->device->type != DEVICE_TYPE_USB)
1620 device_release_write(dev, true);
1622 pb_log("%s has no snapshot to merge, skipping\n",
1629 void device_handler_discover_context_commit(
1630 struct device_handler *handler __attribute__((unused)),
1631 struct discover_context *ctx __attribute__((unused)))
1633 pb_log("%s stubbed out for test cases\n", __func__);
1636 static void device_handler_update_lang(const char *lang __attribute__((unused)))
1640 static int device_handler_init_sources(
1641 struct device_handler *handler __attribute__((unused)))
1646 static void device_handler_reinit_sources(
1647 struct device_handler *handler __attribute__((unused)))
1651 static int umount_device(struct discover_device *dev __attribute__((unused)))
1656 static int __attribute__((unused)) mount_device(
1657 struct discover_device *dev __attribute__((unused)))
1662 int device_request_write(struct discover_device *dev __attribute__((unused)),
1669 void device_release_write(struct discover_device *dev __attribute__((unused)),
1670 bool release __attribute__((unused)))
1674 void device_sync_snapshots(
1675 struct device_handler *handler __attribute__((unused)),
1676 const char *device __attribute__((unused)))