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 progress_info {
50 unsigned int percentage;
51 unsigned long size; /* size in bytes */
53 const struct process_info *procinfo;
54 struct list_item list;
57 struct device_handler {
58 struct discover_server *server;
62 struct network *network;
63 struct user_event *user_event;
65 struct discover_device **devices;
66 unsigned int n_devices;
68 struct ramdisk_device **ramdisks;
69 unsigned int n_ramdisks;
71 struct waitset *waitset;
72 struct waiter *timeout_waiter;
73 bool autoboot_enabled;
74 unsigned int sec_to_boot;
76 struct discover_boot_option *default_boot_option;
77 int default_boot_option_priority;
79 struct list unresolved_boot_options;
81 struct boot_task *pending_boot;
82 bool pending_boot_is_default;
85 unsigned int n_progress;
88 static int mount_device(struct discover_device *dev);
89 static int umount_device(struct discover_device *dev);
91 static int device_handler_init_sources(struct device_handler *handler);
92 static void device_handler_reinit_sources(struct device_handler *handler);
94 static void device_handler_update_lang(const char *lang);
96 void discover_context_add_boot_option(struct discover_context *ctx,
97 struct discover_boot_option *boot_option)
99 boot_option->source = ctx->parser;
100 list_add_tail(&ctx->boot_options, &boot_option->list);
101 talloc_steal(ctx, boot_option);
105 * device_handler_get_device_count - Get the count of current handler devices.
108 int device_handler_get_device_count(const struct device_handler *handler)
110 return handler->n_devices;
114 * device_handler_get_device - Get a handler device by index.
117 const struct discover_device *device_handler_get_device(
118 const struct device_handler *handler, unsigned int index)
120 if (index >= handler->n_devices) {
121 assert(0 && "bad index");
125 return handler->devices[index];
128 struct network *device_handler_get_network(
129 const struct device_handler *handler)
131 return handler->network;
134 struct discover_boot_option *discover_boot_option_create(
135 struct discover_context *ctx,
136 struct discover_device *device)
138 struct discover_boot_option *opt;
140 opt = talloc_zero(ctx, struct discover_boot_option);
141 opt->option = talloc_zero(opt, struct boot_option);
142 opt->device = device;
147 static int device_match_uuid(struct discover_device *dev, const char *uuid)
149 return dev->uuid && !strcmp(dev->uuid, uuid);
152 static int device_match_label(struct discover_device *dev, const char *label)
154 return dev->label && !strcmp(dev->label, label);
157 static int device_match_id(struct discover_device *dev, const char *id)
159 return !strcmp(dev->device->id, id);
162 static int device_match_serial(struct discover_device *dev, const char *serial)
164 const char *val = discover_device_get_param(dev, "ID_SERIAL");
165 return val && !strcmp(val, serial);
168 static struct discover_device *device_lookup(
169 struct device_handler *device_handler,
170 int (match_fn)(struct discover_device *, const char *),
173 struct discover_device *dev;
179 for (i = 0; i < device_handler->n_devices; i++) {
180 dev = device_handler->devices[i];
182 if (match_fn(dev, str))
189 struct discover_device *device_lookup_by_name(struct device_handler *handler,
192 if (!strncmp(name, "/dev/", strlen("/dev/")))
193 name += strlen("/dev/");
195 return device_lookup_by_id(handler, name);
198 struct discover_device *device_lookup_by_uuid(
199 struct device_handler *device_handler,
202 return device_lookup(device_handler, device_match_uuid, uuid);
205 struct discover_device *device_lookup_by_label(
206 struct device_handler *device_handler,
209 return device_lookup(device_handler, device_match_label, label);
212 struct discover_device *device_lookup_by_id(
213 struct device_handler *device_handler,
216 return device_lookup(device_handler, device_match_id, id);
219 struct discover_device *device_lookup_by_serial(
220 struct device_handler *device_handler,
223 return device_lookup(device_handler, device_match_serial, serial);
226 void device_handler_destroy(struct device_handler *handler)
228 talloc_free(handler);
231 static int destroy_device(void *arg)
233 struct discover_device *dev = arg;
240 struct discover_device *discover_device_create(struct device_handler *handler,
241 const char *uuid, const char *id)
243 struct discover_device *dev;
246 dev = device_lookup_by_uuid(handler, uuid);
248 dev = device_lookup_by_id(handler, id);
253 dev = talloc_zero(handler, struct discover_device);
254 dev->device = talloc_zero(dev, struct device);
255 dev->device->id = talloc_strdup(dev->device, id);
256 dev->uuid = talloc_strdup(dev, uuid);
257 list_init(&dev->params);
258 list_init(&dev->boot_options);
260 talloc_set_destructor(dev, destroy_device);
265 struct discover_device_param {
268 struct list_item list;
271 void discover_device_set_param(struct discover_device *device,
272 const char *name, const char *value)
274 struct discover_device_param *param;
277 list_for_each_entry(&device->params, param, list) {
278 if (!strcmp(param->name, name)) {
287 param = talloc(device, struct discover_device_param);
288 param->name = talloc_strdup(param, name);
289 list_add(&device->params, ¶m->list);
292 list_remove(¶m->list);
296 talloc_free(param->value);
299 param->value = talloc_strdup(param, value);
302 const char *discover_device_get_param(struct discover_device *device,
305 struct discover_device_param *param;
307 list_for_each_entry(&device->params, param, list) {
308 if (!strcmp(param->name, name))
314 struct device_handler *device_handler_init(struct discover_server *server,
315 struct waitset *waitset, int dry_run)
317 struct device_handler *handler;
320 handler = talloc_zero(NULL, struct device_handler);
321 handler->server = server;
322 handler->waitset = waitset;
323 handler->dry_run = dry_run;
324 handler->autoboot_enabled = config_get()->autoboot_enabled;
326 list_init(&handler->unresolved_boot_options);
328 list_init(&handler->progress);
330 /* set up our mount point base */
331 pb_mkdir_recursive(mount_base());
335 if (config_get()->safe_mode)
338 rc = device_handler_init_sources(handler);
340 talloc_free(handler);
347 void device_handler_reinit(struct device_handler *handler)
349 struct discover_boot_option *opt, *tmp;
350 struct ramdisk_device *ramdisk;
353 device_handler_cancel_default(handler);
355 /* free unresolved boot options */
356 list_for_each_entry_safe(&handler->unresolved_boot_options,
359 list_init(&handler->unresolved_boot_options);
361 /* drop all devices */
362 for (i = 0; i < handler->n_devices; i++) {
363 discover_server_notify_device_remove(handler->server,
364 handler->devices[i]->device);
365 ramdisk = handler->devices[i]->ramdisk;
366 talloc_free(handler->devices[i]);
367 talloc_free(ramdisk);
370 talloc_free(handler->devices);
371 handler->devices = NULL;
372 handler->n_devices = 0;
373 talloc_free(handler->ramdisks);
374 handler->ramdisks = NULL;
375 handler->n_ramdisks = 0;
377 device_handler_reinit_sources(handler);
380 void device_handler_remove(struct device_handler *handler,
381 struct discover_device *device)
383 struct discover_boot_option *opt, *tmp;
386 list_for_each_entry_safe(&device->boot_options, opt, tmp, list) {
387 if (opt == handler->default_boot_option) {
388 pb_log("Default option %s cancelled since device removed",
390 device_handler_cancel_default(handler);
395 for (i = 0; i < handler->n_devices; i++)
396 if (handler->devices[i] == device)
399 if (i == handler->n_devices) {
404 /* Free any unresolved options, as they're currently allocated
405 * against the handler */
406 list_for_each_entry_safe(&handler->unresolved_boot_options,
408 if (opt->device != device)
410 list_remove(&opt->list);
414 /* if this is a network device, we have to unregister it from the
416 if (device->device->type == DEVICE_TYPE_NETWORK)
417 network_unregister_device(handler->network, device);
419 handler->n_devices--;
420 memmove(&handler->devices[i], &handler->devices[i + 1],
421 (handler->n_devices - i) * sizeof(handler->devices[0]));
422 handler->devices = talloc_realloc(handler, handler->devices,
423 struct discover_device *, handler->n_devices);
425 if (device->notified)
426 discover_server_notify_device_remove(handler->server,
432 void device_handler_status(struct device_handler *handler,
433 struct status *status)
435 discover_server_notify_boot_status(handler->server, status);
438 static void _device_handler_vstatus(struct device_handler *handler,
439 enum status_type type, const char *fmt, va_list ap)
441 struct status status;
444 status.message = talloc_vasprintf(handler, fmt, ap);
446 device_handler_status(handler, &status);
448 talloc_free(status.message);
451 static void _device_handler_vdevstatus(struct device_handler *handler,
452 struct discover_device *device, enum status_type type,
453 const char *fmt, va_list ap)
457 msg = talloc_asprintf(handler, "[%s] %s",
458 device ? device->device->id : "unknown", fmt);
459 _device_handler_vstatus(handler, type, msg, ap);
463 void device_handler_status_dev_info(struct device_handler *handler,
464 struct discover_device *dev, const char *fmt, ...)
469 _device_handler_vdevstatus(handler, dev, STATUS_INFO, fmt, ap);
473 void device_handler_status_dev_err(struct device_handler *handler,
474 struct discover_device *dev, const char *fmt, ...)
479 _device_handler_vdevstatus(handler, dev, STATUS_ERROR, fmt, ap);
483 void device_handler_status_info(struct device_handler *handler,
484 const char *fmt, ...)
489 _device_handler_vstatus(handler, STATUS_INFO, fmt, ap);
493 void device_handler_status_err(struct device_handler *handler,
494 const char *fmt, ...)
499 _device_handler_vstatus(handler, STATUS_ERROR, fmt, ap);
503 void device_handler_status_download(struct device_handler *handler,
504 const struct process_info *procinfo,
505 unsigned int percentage, unsigned int size, char suffix)
507 struct progress_info *p, *progress = NULL;
508 uint64_t current_converted, current = 0;
509 const char *units = " kMGTP";
510 unsigned long size_bytes;
516 list_for_each_entry(&handler->progress, p, list)
517 if (p->procinfo == procinfo)
521 pb_log("Registering new progress struct\n");
522 progress = talloc_zero(handler, struct progress_info);
524 pb_log("Failed to allocate room for progress struct\n");
527 progress->procinfo = procinfo;
528 list_add(&handler->progress, &progress->list);
529 handler->n_progress++;
533 for (i = 0; i < strlen(units); i++) {
534 if (units[i] == suffix)
538 if (i >= strlen(units)) {
539 pb_log("Couldn't recognise suffix '%c'\n", suffix);
546 progress->percentage = percentage;
547 progress->size = size_bytes;
550 * Aggregate the info we have and update status. If a progress struct
551 * has zero for both percentage and size we assume progress information
552 * is unavailable and fall back to a generic progress message.
554 list_for_each_entry(&handler->progress, p, list) {
557 if (!p->percentage || !p->size) {
558 update = talloc_asprintf(handler,
559 _("%u downloads in progress..."),
560 handler->n_progress);
566 t = (100 * c) / p->percentage;
573 current_converted = current;
574 while (current_converted >= 1000) {
575 current_converted >>= 10;
578 update = talloc_asprintf(handler,
579 _("%u %s downloading: %.0f%% - %lu%cB"),
581 ngettext("item", "items", handler->n_progress),
582 (current / total) * 100, current_converted,
587 pb_log("%s: failed to allocate new status\n", __func__);
589 device_handler_status_info(handler, "%s\n", update);
594 void device_handler_status_download_remove(struct device_handler *handler,
595 struct process_info *procinfo)
597 struct progress_info *p, *tmp;
599 list_for_each_entry_safe(&handler->progress, p, tmp, list)
600 if (p->procinfo == procinfo) {
601 list_remove(&p->list);
603 handler->n_progress--;
607 static void device_handler_boot_status_cb(void *arg, struct status *status)
609 device_handler_status(arg, status);
612 static void countdown_status(struct device_handler *handler,
613 struct discover_boot_option *opt, unsigned int sec)
615 struct status status;
617 status.type = STATUS_INFO;
618 status.message = talloc_asprintf(handler,
619 _("Booting in %d sec: %s"), sec, opt->option->name);
621 device_handler_status(handler, &status);
623 talloc_free(status.message);
626 static int default_timeout(void *arg)
628 struct device_handler *handler = arg;
629 struct discover_boot_option *opt;
631 if (!handler->default_boot_option)
634 if (handler->pending_boot)
637 opt = handler->default_boot_option;
639 if (handler->sec_to_boot) {
640 countdown_status(handler, opt, handler->sec_to_boot);
641 handler->sec_to_boot--;
642 handler->timeout_waiter = waiter_register_timeout(
643 handler->waitset, 1000,
644 default_timeout, handler);
648 handler->timeout_waiter = NULL;
650 pb_log("Timeout expired, booting default option %s\n", opt->option->id);
654 handler->pending_boot = boot(handler, handler->default_boot_option,
655 NULL, handler->dry_run, device_handler_boot_status_cb,
657 handler->pending_boot_is_default = true;
662 enum ipmi_bootdev ipmi_type;
663 enum device_type device_type;
664 } device_type_map[] = {
665 { IPMI_BOOTDEV_NETWORK, DEVICE_TYPE_NETWORK },
666 { IPMI_BOOTDEV_DISK, DEVICE_TYPE_DISK },
667 { IPMI_BOOTDEV_DISK, DEVICE_TYPE_USB },
668 { IPMI_BOOTDEV_CDROM, DEVICE_TYPE_OPTICAL },
671 static bool ipmi_device_type_matches(enum ipmi_bootdev ipmi_type,
672 enum device_type device_type)
676 for (i = 0; i < ARRAY_SIZE(device_type_map); i++) {
677 if (device_type_map[i].device_type == device_type)
678 return device_type_map[i].ipmi_type == ipmi_type;
684 static int autoboot_option_priority(const struct config *config,
685 struct discover_boot_option *opt)
687 enum device_type type = opt->device->device->type;
688 const char *uuid = opt->device->uuid;
689 struct autoboot_option *auto_opt;
692 for (i = 0; i < config->n_autoboot_opts; i++) {
693 auto_opt = &config->autoboot_opts[i];
694 if (auto_opt->boot_type == BOOT_DEVICE_UUID)
695 if (!strcmp(auto_opt->uuid, uuid))
696 return DEFAULT_PRIORITY_LOCAL_FIRST + i;
698 if (auto_opt->boot_type == BOOT_DEVICE_TYPE)
699 if (auto_opt->type == type ||
700 auto_opt->type == DEVICE_TYPE_ANY)
701 return DEFAULT_PRIORITY_LOCAL_FIRST + i;
708 * We have different priorities to resolve conflicts between boot options that
709 * report to be the default for their device. This function assigns a priority
712 static enum default_priority default_option_priority(
713 struct discover_boot_option *opt)
715 const struct config *config;
717 config = config_get();
719 /* We give highest priority to IPMI-configured boot options. If
720 * we have an IPMI bootdev configuration set, then we don't allow
721 * any other defaults */
722 if (config->ipmi_bootdev) {
723 bool ipmi_match = ipmi_device_type_matches(config->ipmi_bootdev,
724 opt->device->device->type);
726 return DEFAULT_PRIORITY_REMOTE;
728 pb_debug("handler: disabled default priority due to "
729 "non-matching IPMI type %x\n",
730 config->ipmi_bootdev);
731 return DEFAULT_PRIORITY_DISABLED;
734 /* Next, try to match the option against the user-defined autoboot
735 * options, either by device UUID or type. */
736 if (config->n_autoboot_opts) {
737 int boot_match = autoboot_option_priority(config, opt);
742 /* If the option didn't match any entry in the array, it is disabled */
743 pb_debug("handler: disabled default priority due to "
744 "non-matching UUID or type\n");
745 return DEFAULT_PRIORITY_DISABLED;
748 static void set_default(struct device_handler *handler,
749 struct discover_boot_option *opt)
751 enum default_priority cur_prio, new_prio;
753 if (!handler->autoboot_enabled)
756 pb_debug("handler: new default option: %s\n", opt->option->id);
758 new_prio = default_option_priority(opt);
760 /* Anything outside our range prevents a default boot */
761 if (new_prio >= DEFAULT_PRIORITY_DISABLED)
764 pb_debug("handler: calculated priority %d\n", new_prio);
766 /* Resolve any conflicts: if we have a new default option, it only
767 * replaces the current if it has a higher priority. */
768 if (handler->default_boot_option) {
770 cur_prio = handler->default_boot_option_priority;
772 if (new_prio < cur_prio) {
773 pb_log("handler: new prio %d beats "
774 "old prio %d for %s\n",
776 handler->default_boot_option
778 handler->default_boot_option = opt;
779 handler->default_boot_option_priority = new_prio;
780 /* extend the timeout a little, so the user sees some
781 * indication of the change */
782 handler->sec_to_boot += 2;
788 handler->sec_to_boot = config_get()->autoboot_timeout_sec;
789 handler->default_boot_option = opt;
790 handler->default_boot_option_priority = new_prio;
792 pb_log("handler: boot option %s set as default, timeout %u sec.\n",
793 opt->option->id, handler->sec_to_boot);
795 default_timeout(handler);
798 static bool resource_is_resolved(struct resource *res)
800 return !res || res->resolved;
803 /* We only use this in an assert, which will disappear if we're compiling
804 * with NDEBUG, so we need the 'used' attribute for these builds */
805 static bool __attribute__((used)) boot_option_is_resolved(
806 struct discover_boot_option *opt)
808 return resource_is_resolved(opt->boot_image) &&
809 resource_is_resolved(opt->initrd) &&
810 resource_is_resolved(opt->dtb) &&
811 resource_is_resolved(opt->args_sig_file) &&
812 resource_is_resolved(opt->icon);
815 static bool resource_resolve(struct resource *res, const char *name,
816 struct discover_boot_option *opt,
817 struct device_handler *handler)
819 struct parser *parser = opt->source;
821 if (resource_is_resolved(res))
824 pb_debug("Attempting to resolve resource %s->%s with parser %s\n",
825 opt->option->id, name, parser->name);
826 parser->resolve_resource(handler, res);
828 return res->resolved;
831 static bool boot_option_resolve(struct discover_boot_option *opt,
832 struct device_handler *handler)
834 return resource_resolve(opt->boot_image, "boot_image", opt, handler) &&
835 resource_resolve(opt->initrd, "initrd", opt, handler) &&
836 resource_resolve(opt->dtb, "dtb", opt, handler) &&
837 resource_resolve(opt->args_sig_file, "args_sig_file", opt,
839 resource_resolve(opt->icon, "icon", opt, handler);
842 static void boot_option_finalise(struct device_handler *handler,
843 struct discover_boot_option *opt)
845 assert(boot_option_is_resolved(opt));
847 /* check that the parsers haven't set any of the final data */
848 assert(!opt->option->boot_image_file);
849 assert(!opt->option->initrd_file);
850 assert(!opt->option->dtb_file);
851 assert(!opt->option->icon_file);
852 assert(!opt->option->device_id);
853 assert(!opt->option->args_sig_file);
856 opt->option->boot_image_file = opt->boot_image->url->full;
858 opt->option->initrd_file = opt->initrd->url->full;
860 opt->option->dtb_file = opt->dtb->url->full;
862 opt->option->icon_file = opt->icon->url->full;
863 if (opt->args_sig_file)
864 opt->option->args_sig_file = opt->args_sig_file->url->full;
866 opt->option->device_id = opt->device->device->id;
868 if (opt->option->is_default)
869 set_default(handler, opt);
872 static void notify_boot_option(struct device_handler *handler,
873 struct discover_boot_option *opt)
875 struct discover_device *dev = opt->device;
878 discover_server_notify_device_add(handler->server,
879 opt->device->device);
880 dev->notified = true;
881 discover_server_notify_boot_option_add(handler->server, opt->option);
884 static void process_boot_option_queue(struct device_handler *handler)
886 struct discover_boot_option *opt, *tmp;
888 list_for_each_entry_safe(&handler->unresolved_boot_options,
891 pb_debug("queue: attempting resolution for %s\n",
894 if (!boot_option_resolve(opt, handler))
897 pb_debug("\tresolved!\n");
899 list_remove(&opt->list);
900 list_add_tail(&opt->device->boot_options, &opt->list);
901 talloc_steal(opt->device, opt);
902 boot_option_finalise(handler, opt);
903 notify_boot_option(handler, opt);
907 struct discover_context *device_handler_discover_context_create(
908 struct device_handler *handler,
909 struct discover_device *device)
911 struct discover_context *ctx;
913 ctx = talloc_zero(handler, struct discover_context);
914 ctx->handler = handler;
915 ctx->device = device;
916 list_init(&ctx->boot_options);
921 void device_handler_add_device(struct device_handler *handler,
922 struct discover_device *device)
924 handler->n_devices++;
925 handler->devices = talloc_realloc(handler, handler->devices,
926 struct discover_device *, handler->n_devices);
927 handler->devices[handler->n_devices - 1] = device;
929 if (device->device->type == DEVICE_TYPE_NETWORK)
930 network_register_device(handler->network, device);
933 void device_handler_add_ramdisk(struct device_handler *handler,
936 struct ramdisk_device *dev;
942 for (i = 0; i < handler->n_ramdisks; i++)
943 if (!strcmp(handler->ramdisks[i]->path, path))
946 dev = talloc_zero(handler, struct ramdisk_device);
948 pb_log("Failed to allocate memory to track %s\n", path);
952 dev->path = talloc_strdup(handler, path);
954 handler->ramdisks = talloc_realloc(handler, handler->ramdisks,
955 struct ramdisk_device *,
956 handler->n_ramdisks + 1);
957 if (!handler->ramdisks) {
958 pb_log("Failed to reallocate memory"
959 "- ramdisk tracking inconsistent!\n");
963 handler->ramdisks[i] = dev;
964 i = handler->n_ramdisks++;
967 struct ramdisk_device *device_handler_get_ramdisk(
968 struct device_handler *handler)
974 /* Check if free ramdisk exists */
975 for (i = 0; i < handler->n_ramdisks; i++)
976 if (!handler->ramdisks[i]->snapshot &&
977 !handler->ramdisks[i]->origin &&
978 !handler->ramdisks[i]->base)
979 return handler->ramdisks[i];
981 /* Otherwise create a new one */
982 name = talloc_asprintf(handler, "/dev/ram%d",
983 handler->n_ramdisks);
985 pb_debug("Failed to allocate memory to name /dev/ram%d",
986 handler->n_ramdisks);
990 id = makedev(1, handler->n_ramdisks);
991 if (mknod(name, S_IFBLK, id)) {
992 if (errno == EEXIST) {
993 /* We haven't yet received updates for existing
994 * ramdisks - add and use this one */
995 pb_debug("Using untracked ramdisk %s\n", name);
997 pb_log("Failed to create new ramdisk %s: %s\n",
998 name, strerror(errno));
1002 device_handler_add_ramdisk(handler, name);
1005 return handler->ramdisks[i];
1008 void device_handler_release_ramdisk(struct discover_device *device)
1010 struct ramdisk_device *ramdisk = device->ramdisk;
1012 talloc_free(ramdisk->snapshot);
1013 talloc_free(ramdisk->origin);
1014 talloc_free(ramdisk->base);
1016 ramdisk->snapshot = ramdisk->origin = ramdisk->base = NULL;
1017 ramdisk->sectors = 0;
1019 device->ramdisk = NULL;
1022 /* Start discovery on a hotplugged device. The device will be in our devices
1023 * array, but has only just been initialised by the hotplug source.
1025 int device_handler_discover(struct device_handler *handler,
1026 struct discover_device *dev)
1028 struct discover_context *ctx;
1031 device_handler_status_dev_info(handler, dev,
1033 * TRANSLATORS: this string will be passed the type of the
1034 * device (eg "disk" or "network"), which will be translated
1037 _("Processing new %s device"),
1038 device_type_display_name(dev->device->type));
1040 process_boot_option_queue(handler);
1042 /* create our context */
1043 ctx = device_handler_discover_context_create(handler, dev);
1045 rc = mount_device(dev);
1049 /* add this device to our system info */
1050 system_info_register_blockdev(dev->device->id, dev->uuid,
1053 /* run the parsers. This will populate the ctx's boot_option list. */
1054 iterate_parsers(ctx);
1056 /* add discovered stuff to the handler */
1057 device_handler_discover_context_commit(handler, ctx);
1060 talloc_unlink(handler, ctx);
1065 /* Incoming dhcp event */
1066 int device_handler_dhcp(struct device_handler *handler,
1067 struct discover_device *dev, struct event *event)
1069 struct discover_context *ctx;
1071 device_handler_status_dev_info(handler, dev,
1072 _("Processing DHCP lease response (ip: %s)"),
1073 event_get_param(event, "ip"));
1075 /* create our context */
1076 ctx = device_handler_discover_context_create(handler, dev);
1077 talloc_steal(ctx, event);
1080 iterate_parsers(ctx);
1082 device_handler_discover_context_commit(handler, ctx);
1084 talloc_unlink(handler, ctx);
1089 static struct discover_boot_option *find_boot_option_by_id(
1090 struct device_handler *handler, const char *id)
1094 for (i = 0; i < handler->n_devices; i++) {
1095 struct discover_device *dev = handler->devices[i];
1096 struct discover_boot_option *opt;
1098 list_for_each_entry(&dev->boot_options, opt, list)
1099 if (!strcmp(opt->option->id, id))
1106 void device_handler_boot(struct device_handler *handler,
1107 struct boot_command *cmd)
1109 struct discover_boot_option *opt = NULL;
1111 if (cmd->option_id && strlen(cmd->option_id))
1112 opt = find_boot_option_by_id(handler, cmd->option_id);
1114 if (handler->pending_boot)
1115 boot_cancel(handler->pending_boot);
1117 platform_pre_boot();
1119 handler->pending_boot = boot(handler, opt, cmd, handler->dry_run,
1120 device_handler_boot_status_cb, handler);
1121 handler->pending_boot_is_default = false;
1124 void device_handler_cancel_default(struct device_handler *handler)
1126 if (handler->timeout_waiter)
1127 waiter_remove(handler->timeout_waiter);
1129 handler->timeout_waiter = NULL;
1130 handler->autoboot_enabled = false;
1132 /* we only send status if we had a default boot option queued */
1133 if (!handler->default_boot_option)
1136 pb_log("Cancelling default boot option\n");
1138 if (handler->pending_boot && handler->pending_boot_is_default) {
1139 boot_cancel(handler->pending_boot);
1140 handler->pending_boot = NULL;
1141 handler->pending_boot_is_default = false;
1144 handler->default_boot_option = NULL;
1146 device_handler_status_info(handler, _("Default boot cancelled"));
1149 void device_handler_update_config(struct device_handler *handler,
1150 struct config *config)
1154 rc = config_set(config);
1158 discover_server_notify_config(handler->server, config);
1159 device_handler_update_lang(config->lang);
1160 device_handler_reinit(handler);
1163 static char *device_from_addr(void *ctx, struct pb_url *url)
1165 char *ipaddr, *buf, *tok, *dev = NULL;
1166 const char *delim = " ";
1167 struct sockaddr_in *ip;
1168 struct sockaddr_in si;
1169 struct addrinfo *res;
1173 /* Note: IPv4 only */
1174 rc = inet_pton(AF_INET, url->host, &(si.sin_addr));
1178 /* need to turn hostname into a valid IP */
1179 rc = getaddrinfo(url->host, NULL, NULL, &res);
1181 pb_debug("%s: Invalid URL\n",__func__);
1184 ipaddr = talloc_array(ctx,char,INET_ADDRSTRLEN);
1185 ip = (struct sockaddr_in *) res->ai_addr;
1186 inet_ntop(AF_INET, &(ip->sin_addr), ipaddr, INET_ADDRSTRLEN);
1190 const char *argv[] = {
1192 "route", "show", "to", "match",
1197 p = process_create(ctx);
1199 p->path = pb_system_apps.ip;
1201 p->keep_stdout = true;
1203 rc = process_run_sync(p);
1205 if (rc || p->exit_status) {
1206 /* ip has complained for some reason; most likely
1207 * there is no route to the host - bail out */
1208 pb_debug("%s: `ip` returns non-zero exit status\n", __func__);
1209 pb_debug("ip buf: %s\n", p->stdout_buf);
1214 buf = p->stdout_buf;
1215 /* If a route is found, ip-route output will be of the form
1216 * "... dev DEVNAME ... " */
1217 tok = strtok(buf, delim);
1219 if (!strcmp(tok, "dev")) {
1220 tok = strtok(NULL, delim);
1221 dev = talloc_strdup(ctx, tok);
1224 tok = strtok(NULL, delim);
1229 pb_debug("%s: Found interface '%s'\n", __func__,dev);
1233 void device_handler_process_url(struct device_handler *handler,
1234 const char *url, const char *mac, const char *ip)
1236 struct discover_context *ctx;
1237 struct discover_device *dev;
1238 struct pb_url *pb_url;
1239 struct event *event;
1240 struct param *param;
1242 if (!handler->network) {
1243 device_handler_status_err(handler, _("No network configured"));
1247 event = talloc(handler, struct event);
1248 event->type = EVENT_TYPE_USER;
1249 event->action = EVENT_ACTION_URL;
1251 if (url[strlen(url) - 1] == '/') {
1252 event->params = talloc_array(event, struct param, 3);
1253 param = &event->params[0];
1254 param->name = talloc_strdup(event, "pxepathprefix");
1255 param->value = talloc_strdup(event, url);
1256 param = &event->params[1];
1257 param->name = talloc_strdup(event, "mac");
1258 param->value = talloc_strdup(event, mac);
1259 param = &event->params[2];
1260 param->name = talloc_strdup(event, "ip");
1261 param->value = talloc_strdup(event, ip);
1262 event->n_params = 3;
1264 event->params = talloc_array(event, struct param, 1);
1265 param = &event->params[0];
1266 param->name = talloc_strdup(event, "pxeconffile");
1267 param->value = talloc_strdup(event, url);
1268 event->n_params = 1;
1271 pb_url = pb_url_parse(event, event->params->value);
1272 if (!pb_url || (pb_url->scheme != pb_url_file && !pb_url->host)) {
1273 device_handler_status_err(handler, _("Invalid config URL!"));
1277 if (pb_url->scheme == pb_url_file)
1278 event->device = talloc_asprintf(event, "local");
1280 event->device = device_from_addr(event, pb_url);
1282 if (!event->device) {
1283 device_handler_status_err(handler,
1284 _("Unable to route to host %s"),
1289 dev = discover_device_create(handler, mac, event->device);
1290 if (pb_url->scheme == pb_url_file)
1291 dev->device->type = DEVICE_TYPE_ANY;
1292 ctx = device_handler_discover_context_create(handler, dev);
1293 talloc_steal(ctx, event);
1296 iterate_parsers(ctx);
1298 device_handler_discover_context_commit(handler, ctx);
1300 talloc_unlink(handler, ctx);
1303 #ifndef PETITBOOT_TEST
1306 * context_commit - Commit a temporary discovery context to the handler,
1307 * and notify the clients about any new options / devices
1309 void device_handler_discover_context_commit(struct device_handler *handler,
1310 struct discover_context *ctx)
1312 struct discover_device *dev = ctx->device;
1313 struct discover_boot_option *opt, *tmp;
1315 if (!device_lookup_by_uuid(handler, dev->uuid))
1316 device_handler_add_device(handler, dev);
1318 /* move boot options from the context to the device */
1319 list_for_each_entry_safe(&ctx->boot_options, opt, tmp, list) {
1320 list_remove(&opt->list);
1322 /* All boot options need at least a kernel image */
1323 if (!opt->boot_image || !opt->boot_image->url) {
1324 pb_log("boot option %s is missing boot image, ignoring\n",
1330 if (boot_option_resolve(opt, handler)) {
1331 pb_log("boot option %s is resolved, "
1332 "sending to clients\n",
1334 list_add_tail(&dev->boot_options, &opt->list);
1335 talloc_steal(dev, opt);
1336 boot_option_finalise(handler, opt);
1337 notify_boot_option(handler, opt);
1339 if (!opt->source->resolve_resource) {
1340 pb_log("parser %s gave us an unresolved "
1341 "resource (%s), but no way to "
1343 opt->source->name, opt->option->id);
1346 pb_log("boot option %s is unresolved, "
1347 "adding to queue\n",
1349 list_add(&handler->unresolved_boot_options,
1351 talloc_steal(handler, opt);
1357 static void device_handler_update_lang(const char *lang)
1359 const char *cur_lang;
1364 cur_lang = setlocale(LC_ALL, NULL);
1365 if (cur_lang && !strcmp(cur_lang, lang))
1368 setlocale(LC_ALL, lang);
1371 static int device_handler_init_sources(struct device_handler *handler)
1373 /* init our device sources: udev, network and user events */
1374 handler->udev = udev_init(handler, handler->waitset);
1378 handler->network = network_init(handler, handler->waitset,
1380 if (!handler->network)
1383 handler->user_event = user_event_init(handler, handler->waitset);
1384 if (!handler->user_event)
1390 static void device_handler_reinit_sources(struct device_handler *handler)
1392 /* if we haven't initialised sources previously (becuase we started in
1393 * safe mode), then init once here. */
1394 if (!(handler->udev || handler->network || handler->user_event)) {
1395 device_handler_init_sources(handler);
1399 udev_reinit(handler->udev);
1401 network_shutdown(handler->network);
1402 handler->network = network_init(handler, handler->waitset,
1406 static inline const char *get_device_path(struct discover_device *dev)
1408 return dev->ramdisk ? dev->ramdisk->snapshot : dev->device_path;
1411 static char *check_subvols(struct discover_device *dev)
1413 const char *fstype = discover_device_get_param(dev, "ID_FS_TYPE");
1418 if (strncmp(fstype, "btrfs", strlen("btrfs")))
1419 return dev->mount_path;
1421 /* On btrfs a device's root may be under a subvolume path */
1422 path = join_paths(dev, dev->mount_path, "@");
1423 rc = stat(path, &sb);
1424 if (!rc && S_ISDIR(sb.st_mode)) {
1425 pb_debug("Using '%s' for btrfs root path\n", path);
1430 return dev->mount_path;
1433 static bool check_existing_mount(struct discover_device *dev)
1435 struct stat devstat, mntstat;
1436 const char *device_path;
1441 device_path = get_device_path(dev);
1443 rc = stat(device_path, &devstat);
1445 pb_debug("%s: stat failed: %s\n", __func__, strerror(errno));
1449 if (!S_ISBLK(devstat.st_mode)) {
1450 pb_debug("%s: %s isn't a block device?\n", __func__,
1455 fp = fopen("/proc/self/mounts", "r");
1458 mnt = getmntent(fp);
1462 if (!mnt->mnt_fsname || mnt->mnt_fsname[0] != '/')
1465 rc = stat(mnt->mnt_fsname, &mntstat);
1469 if (!S_ISBLK(mntstat.st_mode))
1472 if (mntstat.st_rdev == devstat.st_rdev) {
1473 dev->mount_path = talloc_strdup(dev, mnt->mnt_dir);
1474 dev->root_path = check_subvols(dev);
1475 dev->mounted_rw = !!hasmntopt(mnt, "rw");
1476 dev->mounted = true;
1477 dev->unmount = false;
1479 pb_debug("%s: %s is already mounted (r%c) at %s\n",
1480 __func__, dev->device_path,
1481 dev->mounted_rw ? 'w' : 'o',
1493 * Attempt to mount a filesystem safely, while handling certain filesytem-
1496 static int try_mount(const char *device_path, const char *mount_path,
1497 const char *fstype, unsigned long flags,
1500 const char *fs, *safe_opts;
1503 /* Mount ext3 as ext4 instead so 'norecovery' can be used */
1504 if (strncmp(fstype, "ext3", strlen("ext3")) == 0) {
1505 pb_debug("Mounting ext3 filesystem as ext4\n");
1510 if (strncmp(fs, "xfs", strlen("xfs")) == 0 ||
1511 strncmp(fs, "ext4", strlen("ext4")) == 0)
1512 safe_opts = "norecovery";
1517 /* If no snapshot is available don't attempt recovery */
1519 return mount(device_path, mount_path, fs, flags, safe_opts);
1521 rc = mount(device_path, mount_path, fs, flags, NULL);
1526 /* Mounting failed; some filesystems will fail to mount if a recovery
1527 * journal exists (eg. cross-endian XFS), so try again with norecovery
1528 * where that option is available.
1529 * If mounting read-write just return the error as norecovery is not a
1531 if ((flags & MS_RDONLY) != MS_RDONLY || !safe_opts)
1535 return mount(device_path, mount_path, fs, flags, safe_opts);
1538 static int mount_device(struct discover_device *dev)
1540 const char *fstype, *device_path;
1543 if (!dev->device_path)
1549 if (check_existing_mount(dev))
1552 fstype = discover_device_get_param(dev, "ID_FS_TYPE");
1556 dev->mount_path = join_paths(dev, mount_base(),
1559 if (pb_mkdir_recursive(dev->mount_path)) {
1560 pb_log("couldn't create mount directory %s: %s\n",
1561 dev->mount_path, strerror(errno));
1565 device_path = get_device_path(dev);
1567 pb_log("mounting device %s read-only\n", dev->device_path);
1568 rc = try_mount(device_path, dev->mount_path, fstype,
1569 MS_RDONLY | MS_SILENT, dev->ramdisk);
1572 dev->mounted = true;
1573 dev->mounted_rw = false;
1574 dev->unmount = true;
1575 dev->root_path = check_subvols(dev);
1579 pb_log("couldn't mount device %s: mount failed: %s\n",
1580 device_path, strerror(errno));
1582 /* If mount fails clean up any snapshot */
1583 devmapper_destroy_snapshot(dev);
1585 pb_rmdir_recursive(mount_base(), dev->mount_path);
1587 talloc_free(dev->mount_path);
1588 dev->mount_path = NULL;
1592 static int umount_device(struct discover_device *dev)
1594 const char *device_path;
1597 if (!dev->mounted || !dev->unmount)
1600 device_path = get_device_path(dev);
1602 pb_log("unmounting device %s\n", device_path);
1603 rc = umount(dev->mount_path);
1607 dev->mounted = false;
1608 devmapper_destroy_snapshot(dev);
1610 pb_rmdir_recursive(mount_base(), dev->mount_path);
1612 talloc_free(dev->mount_path);
1613 dev->mount_path = NULL;
1614 dev->root_path = NULL;
1619 int device_request_write(struct discover_device *dev, bool *release)
1621 const char *fstype, *device_path;
1622 const struct config *config;
1627 config = config_get();
1628 if (!config->allow_writes)
1634 if (dev->mounted_rw)
1637 fstype = discover_device_get_param(dev, "ID_FS_TYPE");
1639 device_path = get_device_path(dev);
1641 pb_log("remounting device %s read-write\n", device_path);
1643 rc = umount(dev->mount_path);
1645 pb_log("Failed to unmount %s: %s\n",
1646 dev->mount_path, strerror(errno));
1650 rc = try_mount(device_path, dev->mount_path, fstype,
1651 MS_SILENT, dev->ramdisk);
1655 dev->mounted_rw = true;
1660 pb_log("Unable to remount device %s read-write: %s\n",
1661 device_path, strerror(errno));
1662 rc = try_mount(device_path, dev->mount_path, fstype,
1663 MS_RDONLY | MS_SILENT, dev->ramdisk);
1665 pb_log("Unable to recover mount for %s: %s\n",
1666 device_path, strerror(errno));
1670 void device_release_write(struct discover_device *dev, bool release)
1672 const char *fstype, *device_path;
1677 device_path = get_device_path(dev);
1679 fstype = discover_device_get_param(dev, "ID_FS_TYPE");
1681 pb_log("remounting device %s read-only\n", device_path);
1683 if (umount(dev->mount_path)) {
1684 pb_log("Failed to unmount %s\n", dev->mount_path);
1687 dev->mounted_rw = dev->mounted = false;
1690 devmapper_merge_snapshot(dev);
1691 /* device_path becomes stale after merge */
1692 device_path = get_device_path(dev);
1695 if (try_mount(device_path, dev->mount_path, fstype,
1696 MS_RDONLY | MS_SILENT, dev->ramdisk))
1697 pb_log("Failed to remount %s read-only: %s\n",
1698 device_path, strerror(errno));
1700 dev->mounted = true;
1703 void device_sync_snapshots(struct device_handler *handler, const char *device)
1705 struct discover_device *dev = NULL;
1709 /* Find matching device and sync */
1710 dev = device_lookup_by_name(handler, device);
1712 pb_log("%s: device name '%s' unrecognised\n",
1717 device_release_write(dev, true);
1719 pb_log("%s has no snapshot to merge, skipping\n",
1724 /* Otherwise sync all relevant devices */
1725 for (i = 0; i < handler->n_devices; i++) {
1726 dev = handler->devices[i];
1727 if (dev->device->type != DEVICE_TYPE_DISK &&
1728 dev->device->type != DEVICE_TYPE_USB)
1731 device_release_write(dev, true);
1733 pb_log("%s has no snapshot to merge, skipping\n",
1740 void device_handler_discover_context_commit(
1741 struct device_handler *handler __attribute__((unused)),
1742 struct discover_context *ctx __attribute__((unused)))
1744 pb_log("%s stubbed out for test cases\n", __func__);
1747 static void device_handler_update_lang(const char *lang __attribute__((unused)))
1751 static int device_handler_init_sources(
1752 struct device_handler *handler __attribute__((unused)))
1757 static void device_handler_reinit_sources(
1758 struct device_handler *handler __attribute__((unused)))
1762 static int umount_device(struct discover_device *dev __attribute__((unused)))
1767 static int __attribute__((unused)) mount_device(
1768 struct discover_device *dev __attribute__((unused)))
1773 int device_request_write(struct discover_device *dev __attribute__((unused)),
1780 void device_release_write(struct discover_device *dev __attribute__((unused)),
1781 bool release __attribute__((unused)))
1785 void device_sync_snapshots(
1786 struct device_handler *handler __attribute__((unused)),
1787 const char *device __attribute__((unused)))