12 #include <sys/mount.h>
14 #include <talloc/talloc.h>
15 #include <list/list.h>
17 #include <types/types.h>
18 #include <system/system.h>
19 #include <process/process.h>
21 #include <i18n/i18n.h>
22 #include <pb-config/pb-config.h>
24 #include <sys/sysmacros.h>
25 #include <sys/types.h>
26 #include <sys/socket.h>
28 #include <arpa/inet.h>
30 #include "device-handler.h"
31 #include "discover-server.h"
32 #include "devmapper.h"
33 #include "user-event.h"
45 enum default_priority {
46 DEFAULT_PRIORITY_REMOTE = 1,
47 DEFAULT_PRIORITY_LOCAL_FIRST = 2,
48 DEFAULT_PRIORITY_LOCAL_LAST = 0xfe,
49 DEFAULT_PRIORITY_DISABLED = 0xff,
52 struct progress_info {
53 unsigned int percentage;
54 unsigned long size; /* size in bytes */
56 const struct process_info *procinfo;
57 struct list_item list;
60 struct device_handler {
61 struct discover_server *server;
65 struct network *network;
66 struct user_event *user_event;
68 struct discover_device **devices;
69 unsigned int n_devices;
71 struct ramdisk_device **ramdisks;
72 unsigned int n_ramdisks;
74 struct waitset *waitset;
75 struct waiter *timeout_waiter;
76 bool autoboot_enabled;
77 unsigned int sec_to_boot;
79 struct discover_boot_option *default_boot_option;
80 int default_boot_option_priority;
82 struct list unresolved_boot_options;
84 struct boot_task *pending_boot;
85 bool pending_boot_is_default;
88 unsigned int n_progress;
90 struct plugin_option **plugins;
91 unsigned int n_plugins;
92 bool plugin_installing;
95 static int mount_device(struct discover_device *dev);
96 static int umount_device(struct discover_device *dev);
98 static int device_handler_init_sources(struct device_handler *handler);
99 static void device_handler_reinit_sources(struct device_handler *handler);
101 static void device_handler_update_lang(const char *lang);
103 void discover_context_add_boot_option(struct discover_context *ctx,
104 struct discover_boot_option *boot_option)
106 boot_option->source = ctx->parser;
107 list_add_tail(&ctx->boot_options, &boot_option->list);
108 talloc_steal(ctx, boot_option);
112 * device_handler_get_device_count - Get the count of current handler devices.
115 int device_handler_get_device_count(const struct device_handler *handler)
117 return handler->n_devices;
121 * device_handler_get_device - Get a handler device by index.
124 const struct discover_device *device_handler_get_device(
125 const struct device_handler *handler, unsigned int index)
127 if (index >= handler->n_devices) {
128 assert(0 && "bad index");
132 return handler->devices[index];
136 * device_handler_get_plugin_count - Get the count of current handler plugins.
138 int device_handler_get_plugin_count(const struct device_handler *handler)
140 return handler->n_plugins;
144 * discover_handler_get_plugin - Get a handler plugin by index.
146 const struct plugin_option *device_handler_get_plugin(
147 const struct device_handler *handler, unsigned int index)
149 if (index >= handler->n_plugins) {
150 assert(0 && "bad index");
154 return handler->plugins[index];
157 struct network *device_handler_get_network(
158 const struct device_handler *handler)
160 return handler->network;
163 struct discover_boot_option *discover_boot_option_create(
164 struct discover_context *ctx,
165 struct discover_device *device)
167 struct discover_boot_option *opt;
169 opt = talloc_zero(ctx, struct discover_boot_option);
170 opt->option = talloc_zero(opt, struct boot_option);
171 opt->device = device;
176 static int device_match_uuid(struct discover_device *dev, const char *uuid)
178 return dev->uuid && !strcmp(dev->uuid, uuid);
181 static int device_match_label(struct discover_device *dev, const char *label)
183 return dev->label && !strcmp(dev->label, label);
186 static int device_match_id(struct discover_device *dev, const char *id)
188 return !strcmp(dev->device->id, id);
191 static int device_match_serial(struct discover_device *dev, const char *serial)
193 const char *val = discover_device_get_param(dev, "ID_SERIAL");
194 return val && !strcmp(val, serial);
197 static struct discover_device *device_lookup(
198 struct device_handler *device_handler,
199 int (match_fn)(struct discover_device *, const char *),
202 struct discover_device *dev;
208 for (i = 0; i < device_handler->n_devices; i++) {
209 dev = device_handler->devices[i];
211 if (match_fn(dev, str))
218 struct discover_device *device_lookup_by_name(struct device_handler *handler,
221 if (!strncmp(name, "/dev/", strlen("/dev/")))
222 name += strlen("/dev/");
224 return device_lookup_by_id(handler, name);
227 struct discover_device *device_lookup_by_uuid(
228 struct device_handler *device_handler,
231 return device_lookup(device_handler, device_match_uuid, uuid);
234 struct discover_device *device_lookup_by_label(
235 struct device_handler *device_handler,
238 return device_lookup(device_handler, device_match_label, label);
241 struct discover_device *device_lookup_by_id(
242 struct device_handler *device_handler,
245 return device_lookup(device_handler, device_match_id, id);
248 struct discover_device *device_lookup_by_serial(
249 struct device_handler *device_handler,
252 return device_lookup(device_handler, device_match_serial, serial);
255 void device_handler_destroy(struct device_handler *handler)
257 talloc_free(handler);
260 static int destroy_device(void *arg)
262 struct discover_device *dev = arg;
269 struct discover_device *discover_device_create(struct device_handler *handler,
270 const char *uuid, const char *id)
272 struct discover_device *dev;
275 dev = device_lookup_by_uuid(handler, uuid);
277 dev = device_lookup_by_id(handler, id);
282 dev = talloc_zero(handler, struct discover_device);
283 dev->device = talloc_zero(dev, struct device);
284 dev->device->id = talloc_strdup(dev->device, id);
285 dev->uuid = talloc_strdup(dev, uuid);
286 list_init(&dev->params);
287 list_init(&dev->boot_options);
289 talloc_set_destructor(dev, destroy_device);
294 struct discover_device_param {
297 struct list_item list;
300 void discover_device_set_param(struct discover_device *device,
301 const char *name, const char *value)
303 struct discover_device_param *param;
306 list_for_each_entry(&device->params, param, list) {
307 if (!strcmp(param->name, name)) {
316 param = talloc(device, struct discover_device_param);
317 param->name = talloc_strdup(param, name);
318 list_add(&device->params, ¶m->list);
321 list_remove(¶m->list);
325 talloc_free(param->value);
328 param->value = talloc_strdup(param, value);
331 const char *discover_device_get_param(struct discover_device *device,
334 struct discover_device_param *param;
336 list_for_each_entry(&device->params, param, list) {
337 if (!strcmp(param->name, name))
343 static void set_env_variables(const struct config *config)
345 if (config->http_proxy)
346 setenv("http_proxy", config->http_proxy, 1);
348 unsetenv("http_proxy");
350 if (config->https_proxy)
351 setenv("https_proxy", config->https_proxy, 1);
353 unsetenv("https_proxy");
355 /* Reduce noise in the log from LVM listing open file descriptors */
356 setenv("LVM_SUPPRESS_FD_WARNINGS", "1", 1);
359 struct device_handler *device_handler_init(struct discover_server *server,
360 struct waitset *waitset, int dry_run)
362 struct device_handler *handler;
365 handler = talloc_zero(NULL, struct device_handler);
366 handler->server = server;
367 handler->waitset = waitset;
368 handler->dry_run = dry_run;
369 handler->autoboot_enabled = config_autoboot_active(config_get());
371 list_init(&handler->unresolved_boot_options);
373 list_init(&handler->progress);
375 /* set up our mount point base */
376 pb_mkdir_recursive(mount_base());
380 if (config_get()->safe_mode)
383 set_env_variables(config_get());
385 rc = device_handler_init_sources(handler);
387 talloc_free(handler);
394 void device_handler_reinit(struct device_handler *handler)
396 struct discover_boot_option *opt, *tmp;
397 struct ramdisk_device *ramdisk;
398 struct config *config;
401 device_handler_cancel_default(handler);
402 /* Cancel any pending non-default boot */
403 if (handler->pending_boot) {
404 boot_cancel(handler->pending_boot);
405 handler->pending_boot = NULL;
406 handler->pending_boot_is_default = false;
409 /* Cancel any remaining async jobs */
410 process_stop_async_all();
411 pending_network_jobs_cancel();
413 /* free unresolved boot options */
414 list_for_each_entry_safe(&handler->unresolved_boot_options,
417 list_init(&handler->unresolved_boot_options);
419 /* drop all devices */
420 for (i = 0; i < handler->n_devices; i++) {
421 discover_server_notify_device_remove(handler->server,
422 handler->devices[i]->device);
423 ramdisk = handler->devices[i]->ramdisk;
424 talloc_free(handler->devices[i]);
425 talloc_free(ramdisk);
428 talloc_free(handler->devices);
429 handler->devices = NULL;
430 handler->n_devices = 0;
431 talloc_free(handler->ramdisks);
432 handler->ramdisks = NULL;
433 handler->n_ramdisks = 0;
435 /* drop any known plugins */
436 for (i = 0; i < handler->n_plugins; i++)
437 talloc_free(handler->plugins[i]);
438 talloc_free(handler->plugins);
439 handler->plugins = NULL;
440 handler->n_plugins = 0;
442 discover_server_notify_plugins_remove(handler->server);
444 set_env_variables(config_get());
446 /* If the safe mode warning was active disable it now */
447 if (config_get()->safe_mode) {
448 config = config_copy(handler, config_get());
449 config->safe_mode = false;
451 discover_server_notify_config(handler->server, config);
454 device_handler_reinit_sources(handler);
457 void device_handler_remove(struct device_handler *handler,
458 struct discover_device *device)
460 struct discover_boot_option *opt, *tmp;
463 list_for_each_entry_safe(&device->boot_options, opt, tmp, list) {
464 if (opt == handler->default_boot_option) {
465 pb_log("Default option %s cancelled since device removed",
467 device_handler_cancel_default(handler);
472 for (i = 0; i < handler->n_devices; i++)
473 if (handler->devices[i] == device)
476 if (i == handler->n_devices) {
481 /* Free any unresolved options, as they're currently allocated
482 * against the handler */
483 list_for_each_entry_safe(&handler->unresolved_boot_options,
485 if (opt->device != device)
487 list_remove(&opt->list);
491 /* if this is a network device, we have to unregister it from the
493 if (device->device->type == DEVICE_TYPE_NETWORK)
494 network_unregister_device(handler->network, device);
496 handler->n_devices--;
497 memmove(&handler->devices[i], &handler->devices[i + 1],
498 (handler->n_devices - i) * sizeof(handler->devices[0]));
499 handler->devices = talloc_realloc(handler, handler->devices,
500 struct discover_device *, handler->n_devices);
502 if (device->notified)
503 discover_server_notify_device_remove(handler->server,
509 void device_handler_status(struct device_handler *handler,
510 struct status *status)
512 discover_server_notify_boot_status(handler->server, status);
515 static void _device_handler_vstatus(struct device_handler *handler,
516 enum status_type type, const char *fmt, va_list ap)
518 struct status status;
521 status.message = talloc_vasprintf(handler, fmt, ap);
522 status.backlog = false;
524 device_handler_status(handler, &status);
526 talloc_free(status.message);
529 static void _device_handler_vdevstatus(struct device_handler *handler,
530 struct discover_device *device, enum status_type type,
531 const char *fmt, va_list ap)
535 msg = talloc_asprintf(handler, "[%s] %s",
536 device ? device->device->id : "unknown", fmt);
537 _device_handler_vstatus(handler, type, msg, ap);
541 void device_handler_status_dev_info(struct device_handler *handler,
542 struct discover_device *dev, const char *fmt, ...)
547 _device_handler_vdevstatus(handler, dev, STATUS_INFO, fmt, ap);
551 void device_handler_status_dev_err(struct device_handler *handler,
552 struct discover_device *dev, const char *fmt, ...)
557 _device_handler_vdevstatus(handler, dev, STATUS_ERROR, fmt, ap);
561 void device_handler_status_info(struct device_handler *handler,
562 const char *fmt, ...)
567 _device_handler_vstatus(handler, STATUS_INFO, fmt, ap);
571 void device_handler_status_err(struct device_handler *handler,
572 const char *fmt, ...)
577 _device_handler_vstatus(handler, STATUS_ERROR, fmt, ap);
581 void device_handler_status_download(struct device_handler *handler,
582 const struct process_info *procinfo,
583 unsigned int percentage, unsigned int size, char suffix)
585 struct progress_info *p, *progress = NULL;
586 uint64_t current_converted, current = 0;
587 const char *units = " kMGTP";
588 unsigned long size_bytes;
594 list_for_each_entry(&handler->progress, p, list)
595 if (p->procinfo == procinfo)
599 pb_log("Registering new progress struct\n");
600 progress = talloc_zero(handler, struct progress_info);
602 pb_log("Failed to allocate room for progress struct\n");
605 progress->procinfo = procinfo;
606 list_add(&handler->progress, &progress->list);
607 handler->n_progress++;
611 for (i = 0; i < strlen(units); i++) {
612 if (units[i] == suffix)
616 if (i >= strlen(units)) {
617 pb_log("Couldn't recognise suffix '%c'\n", suffix);
624 progress->percentage = percentage;
625 progress->size = size_bytes;
628 * Aggregate the info we have and update status. If a progress struct
629 * has zero for both percentage and size we assume progress information
630 * is unavailable and fall back to a generic progress message.
632 list_for_each_entry(&handler->progress, p, list) {
635 if (!p->percentage || !p->size) {
636 update = talloc_asprintf(handler,
637 _("%u downloads in progress..."),
638 handler->n_progress);
644 t = (100 * c) / p->percentage;
651 current_converted = current;
652 while (current_converted >= 1000) {
653 current_converted >>= 10;
656 update = talloc_asprintf(handler,
657 _("%u %s downloading: %.0f%% - %" PRIu64 "%cB"),
659 ngettext("item", "items", handler->n_progress),
660 (current / total) * 100, current_converted,
665 pb_log("%s: failed to allocate new status\n", __func__);
667 device_handler_status_info(handler, "%s\n", update);
672 static void device_handler_plugin_scan_device(struct device_handler *handler,
673 struct discover_device *dev)
677 pb_debug("Scanning %s for plugin files\n", dev->device->id);
679 rc = process_run_simple(handler, pb_system_apps.pb_plugin,
680 "scan", dev->mount_path,
683 pb_log("Error from pb-plugin scan %s\n",
687 void device_handler_status_download_remove(struct device_handler *handler,
688 struct process_info *procinfo)
690 struct progress_info *p, *tmp;
692 list_for_each_entry_safe(&handler->progress, p, tmp, list)
693 if (p->procinfo == procinfo) {
694 list_remove(&p->list);
696 handler->n_progress--;
700 static void device_handler_boot_status_cb(void *arg, struct status *status)
702 device_handler_status(arg, status);
705 static void countdown_status(struct device_handler *handler,
706 struct discover_boot_option *opt, unsigned int sec)
708 struct status status;
710 status.type = STATUS_INFO;
711 status.message = talloc_asprintf(handler,
712 _("Booting in %d sec: [%s] %s"), sec,
713 opt->device->device->id, opt->option->name);
714 status.backlog = false;
716 device_handler_status(handler, &status);
718 talloc_free(status.message);
721 static int default_timeout(void *arg)
723 struct device_handler *handler = arg;
724 struct discover_boot_option *opt;
726 if (!handler->default_boot_option)
729 if (handler->pending_boot)
732 opt = handler->default_boot_option;
734 if (handler->sec_to_boot) {
735 countdown_status(handler, opt, handler->sec_to_boot);
736 handler->sec_to_boot--;
737 handler->timeout_waiter = waiter_register_timeout(
738 handler->waitset, 1000,
739 default_timeout, handler);
743 handler->timeout_waiter = NULL;
745 pb_log("Timeout expired, booting default option %s\n", opt->option->id);
749 handler->pending_boot = boot(handler, handler->default_boot_option,
750 NULL, handler->dry_run, device_handler_boot_status_cb,
752 handler->pending_boot_is_default = true;
757 enum ipmi_bootdev ipmi_type;
758 enum device_type device_type;
759 } device_type_map[] = {
760 { IPMI_BOOTDEV_NETWORK, DEVICE_TYPE_NETWORK },
761 { IPMI_BOOTDEV_DISK, DEVICE_TYPE_DISK },
762 { IPMI_BOOTDEV_DISK, DEVICE_TYPE_USB },
763 { IPMI_BOOTDEV_CDROM, DEVICE_TYPE_OPTICAL },
766 static bool ipmi_device_type_matches(enum ipmi_bootdev ipmi_type,
767 enum device_type device_type)
771 for (i = 0; i < ARRAY_SIZE(device_type_map); i++) {
772 if (device_type_map[i].device_type == device_type)
773 return device_type_map[i].ipmi_type == ipmi_type;
779 static int autoboot_option_priority(const struct config *config,
780 struct discover_boot_option *opt)
782 enum device_type type = opt->device->device->type;
783 const char *uuid = opt->device->uuid;
784 struct autoboot_option *auto_opt;
787 for (i = 0; i < config->n_autoboot_opts; i++) {
788 auto_opt = &config->autoboot_opts[i];
789 if (auto_opt->boot_type == BOOT_DEVICE_UUID)
790 if (!strcmp(auto_opt->uuid, uuid))
791 return DEFAULT_PRIORITY_LOCAL_FIRST + i;
793 if (auto_opt->boot_type == BOOT_DEVICE_TYPE)
794 if (auto_opt->type == type ||
795 auto_opt->type == DEVICE_TYPE_ANY)
796 return DEFAULT_PRIORITY_LOCAL_FIRST + i;
803 * We have different priorities to resolve conflicts between boot options that
804 * report to be the default for their device. This function assigns a priority
807 static enum default_priority default_option_priority(
808 struct discover_boot_option *opt)
810 const struct config *config;
812 config = config_get();
814 /* We give highest priority to IPMI-configured boot options. If
815 * we have an IPMI bootdev configuration set, then we don't allow
816 * any other defaults */
817 if (config->ipmi_bootdev) {
818 bool ipmi_match = ipmi_device_type_matches(config->ipmi_bootdev,
819 opt->device->device->type);
821 return DEFAULT_PRIORITY_REMOTE;
823 pb_debug("handler: disabled default priority due to "
824 "non-matching IPMI type %x\n",
825 config->ipmi_bootdev);
826 return DEFAULT_PRIORITY_DISABLED;
829 /* Next, try to match the option against the user-defined autoboot
830 * options, either by device UUID or type. */
831 if (config->n_autoboot_opts) {
832 int boot_match = autoboot_option_priority(config, opt);
836 /* If there is no specific boot order, boot any device */
837 return DEFAULT_PRIORITY_LOCAL_FIRST;
840 /* If the option didn't match any entry in the array, it is disabled */
841 pb_debug("handler: disabled default priority due to "
842 "non-matching UUID or type\n");
843 return DEFAULT_PRIORITY_DISABLED;
846 static void set_default(struct device_handler *handler,
847 struct discover_boot_option *opt)
849 enum default_priority cur_prio, new_prio;
851 if (!handler->autoboot_enabled)
854 pb_debug("handler: new default option: %s\n", opt->option->id);
856 new_prio = default_option_priority(opt);
858 /* Anything outside our range prevents a default boot */
859 if (new_prio >= DEFAULT_PRIORITY_DISABLED)
862 pb_debug("handler: calculated priority %d\n", new_prio);
864 /* Resolve any conflicts: if we have a new default option, it only
865 * replaces the current if it has a higher priority. */
866 if (handler->default_boot_option) {
868 cur_prio = handler->default_boot_option_priority;
870 if (new_prio < cur_prio) {
871 pb_log("handler: new prio %d beats "
872 "old prio %d for %s\n",
874 handler->default_boot_option
876 handler->default_boot_option = opt;
877 handler->default_boot_option_priority = new_prio;
878 /* extend the timeout a little, so the user sees some
879 * indication of the change */
880 handler->sec_to_boot += 2;
886 handler->sec_to_boot = config_get()->autoboot_timeout_sec;
887 handler->default_boot_option = opt;
888 handler->default_boot_option_priority = new_prio;
890 pb_log("handler: boot option %s set as default, timeout %u sec.\n",
891 opt->option->id, handler->sec_to_boot);
893 default_timeout(handler);
896 static bool resource_is_resolved(struct resource *res)
898 return !res || res->resolved;
901 /* We only use this in an assert, which will disappear if we're compiling
902 * with NDEBUG, so we need the 'used' attribute for these builds */
903 static bool __attribute__((used)) boot_option_is_resolved(
904 struct discover_boot_option *opt)
906 return resource_is_resolved(opt->boot_image) &&
907 resource_is_resolved(opt->initrd) &&
908 resource_is_resolved(opt->dtb) &&
909 resource_is_resolved(opt->args_sig_file) &&
910 resource_is_resolved(opt->icon);
913 static bool resource_resolve(struct resource *res, const char *name,
914 struct discover_boot_option *opt,
915 struct device_handler *handler)
917 struct parser *parser = opt->source;
919 if (resource_is_resolved(res))
922 pb_debug("Attempting to resolve resource %s->%s with parser %s\n",
923 opt->option->id, name, parser->name);
924 parser->resolve_resource(handler, res);
926 return res->resolved;
929 static bool boot_option_resolve(struct discover_boot_option *opt,
930 struct device_handler *handler)
932 return resource_resolve(opt->boot_image, "boot_image", opt, handler) &&
933 resource_resolve(opt->initrd, "initrd", opt, handler) &&
934 resource_resolve(opt->dtb, "dtb", opt, handler) &&
935 resource_resolve(opt->args_sig_file, "args_sig_file", opt,
937 resource_resolve(opt->icon, "icon", opt, handler);
940 static void boot_option_finalise(struct device_handler *handler,
941 struct discover_boot_option *opt)
943 assert(boot_option_is_resolved(opt));
945 /* check that the parsers haven't set any of the final data */
946 assert(!opt->option->boot_image_file);
947 assert(!opt->option->initrd_file);
948 assert(!opt->option->dtb_file);
949 assert(!opt->option->icon_file);
950 assert(!opt->option->device_id);
951 assert(!opt->option->args_sig_file);
954 opt->option->boot_image_file = opt->boot_image->url->full;
956 opt->option->initrd_file = opt->initrd->url->full;
958 opt->option->dtb_file = opt->dtb->url->full;
960 opt->option->icon_file = opt->icon->url->full;
961 if (opt->args_sig_file)
962 opt->option->args_sig_file = opt->args_sig_file->url->full;
964 opt->option->device_id = opt->device->device->id;
966 if (opt->option->is_default)
967 set_default(handler, opt);
970 static void notify_boot_option(struct device_handler *handler,
971 struct discover_boot_option *opt)
973 struct discover_device *dev = opt->device;
976 discover_server_notify_device_add(handler->server,
977 opt->device->device);
978 dev->notified = true;
979 discover_server_notify_boot_option_add(handler->server, opt->option);
982 static void process_boot_option_queue(struct device_handler *handler)
984 struct discover_boot_option *opt, *tmp;
986 list_for_each_entry_safe(&handler->unresolved_boot_options,
989 pb_debug("queue: attempting resolution for %s\n",
992 if (!boot_option_resolve(opt, handler))
995 pb_debug("\tresolved!\n");
997 list_remove(&opt->list);
998 list_add_tail(&opt->device->boot_options, &opt->list);
999 talloc_steal(opt->device, opt);
1000 boot_option_finalise(handler, opt);
1001 notify_boot_option(handler, opt);
1005 struct discover_context *device_handler_discover_context_create(
1006 struct device_handler *handler,
1007 struct discover_device *device)
1009 struct discover_context *ctx;
1011 ctx = talloc_zero(handler, struct discover_context);
1012 ctx->handler = handler;
1013 ctx->device = device;
1014 list_init(&ctx->boot_options);
1019 void device_handler_add_device(struct device_handler *handler,
1020 struct discover_device *device)
1022 handler->n_devices++;
1023 handler->devices = talloc_realloc(handler, handler->devices,
1024 struct discover_device *, handler->n_devices);
1025 handler->devices[handler->n_devices - 1] = device;
1027 if (device->device->type == DEVICE_TYPE_NETWORK)
1028 network_register_device(handler->network, device);
1031 void device_handler_add_ramdisk(struct device_handler *handler,
1034 struct ramdisk_device *dev;
1040 for (i = 0; i < handler->n_ramdisks; i++)
1041 if (!strcmp(handler->ramdisks[i]->path, path))
1044 dev = talloc_zero(handler, struct ramdisk_device);
1046 pb_log("Failed to allocate memory to track %s\n", path);
1050 dev->path = talloc_strdup(handler, path);
1052 handler->ramdisks = talloc_realloc(handler, handler->ramdisks,
1053 struct ramdisk_device *,
1054 handler->n_ramdisks + 1);
1055 if (!handler->ramdisks) {
1056 pb_log("Failed to reallocate memory"
1057 "- ramdisk tracking inconsistent!\n");
1061 handler->ramdisks[i] = dev;
1062 i = handler->n_ramdisks++;
1065 struct ramdisk_device *device_handler_get_ramdisk(
1066 struct device_handler *handler)
1072 /* Check if free ramdisk exists */
1073 for (i = 0; i < handler->n_ramdisks; i++)
1074 if (!handler->ramdisks[i]->snapshot &&
1075 !handler->ramdisks[i]->origin &&
1076 !handler->ramdisks[i]->base)
1077 return handler->ramdisks[i];
1079 /* Otherwise create a new one */
1080 name = talloc_asprintf(handler, "/dev/ram%d",
1081 handler->n_ramdisks);
1083 pb_debug("Failed to allocate memory to name /dev/ram%d",
1084 handler->n_ramdisks);
1088 id = makedev(1, handler->n_ramdisks);
1089 if (mknod(name, S_IFBLK, id)) {
1090 if (errno == EEXIST) {
1091 /* We haven't yet received updates for existing
1092 * ramdisks - add and use this one */
1093 pb_debug("Using untracked ramdisk %s\n", name);
1095 pb_log("Failed to create new ramdisk %s: %s\n",
1096 name, strerror(errno));
1100 device_handler_add_ramdisk(handler, name);
1103 return handler->ramdisks[i];
1106 void device_handler_release_ramdisk(struct discover_device *device)
1108 struct ramdisk_device *ramdisk = device->ramdisk;
1110 talloc_free(ramdisk->snapshot);
1111 talloc_free(ramdisk->origin);
1112 talloc_free(ramdisk->base);
1114 ramdisk->snapshot = ramdisk->origin = ramdisk->base = NULL;
1115 ramdisk->sectors = 0;
1117 device->ramdisk = NULL;
1120 /* Start discovery on a hotplugged device. The device will be in our devices
1121 * array, but has only just been initialised by the hotplug source.
1123 int device_handler_discover(struct device_handler *handler,
1124 struct discover_device *dev)
1126 struct discover_context *ctx;
1129 device_handler_status_dev_info(handler, dev,
1131 * TRANSLATORS: this string will be passed the type of the
1132 * device (eg "disk" or "network"), which will be translated
1135 _("Processing new %s device"),
1136 device_type_display_name(dev->device->type));
1138 /* create our context */
1139 ctx = device_handler_discover_context_create(handler, dev);
1141 rc = mount_device(dev);
1145 /* add this device to our system info */
1146 system_info_register_blockdev(dev->device->id, dev->uuid,
1149 /* run the parsers. This will populate the ctx's boot_option list. */
1150 iterate_parsers(ctx);
1152 /* add discovered stuff to the handler */
1153 device_handler_discover_context_commit(handler, ctx);
1155 process_boot_option_queue(handler);
1157 /* Check this device for pb-plugins */
1158 device_handler_plugin_scan_device(handler, dev);
1160 talloc_unlink(handler, ctx);
1165 /* Incoming dhcp event */
1166 int device_handler_dhcp(struct device_handler *handler,
1167 struct discover_device *dev, struct event *event)
1169 struct discover_context *ctx;
1171 device_handler_status_dev_info(handler, dev,
1172 _("Processing DHCP lease response (ip: %s)"),
1173 event_get_param(event, "ip"));
1175 pending_network_jobs_start();
1177 /* create our context */
1178 ctx = device_handler_discover_context_create(handler, dev);
1179 talloc_steal(ctx, event);
1182 iterate_parsers(ctx);
1184 device_handler_discover_context_commit(handler, ctx);
1186 talloc_unlink(handler, ctx);
1191 static struct discover_boot_option *find_boot_option_by_id(
1192 struct device_handler *handler, const char *id)
1196 for (i = 0; i < handler->n_devices; i++) {
1197 struct discover_device *dev = handler->devices[i];
1198 struct discover_boot_option *opt;
1200 list_for_each_entry(&dev->boot_options, opt, list)
1201 if (!strcmp(opt->option->id, id))
1208 void device_handler_boot(struct device_handler *handler,
1209 struct boot_command *cmd)
1211 struct discover_boot_option *opt = NULL;
1213 if (cmd->option_id && strlen(cmd->option_id))
1214 opt = find_boot_option_by_id(handler, cmd->option_id);
1216 if (handler->pending_boot)
1217 boot_cancel(handler->pending_boot);
1219 platform_pre_boot();
1221 handler->pending_boot = boot(handler, opt, cmd, handler->dry_run,
1222 device_handler_boot_status_cb, handler);
1223 handler->pending_boot_is_default = false;
1226 void device_handler_cancel_default(struct device_handler *handler)
1228 if (handler->timeout_waiter)
1229 waiter_remove(handler->timeout_waiter);
1231 handler->timeout_waiter = NULL;
1232 handler->autoboot_enabled = false;
1234 /* we only send status if we had a default boot option queued */
1235 if (!handler->default_boot_option)
1238 pb_log("Cancelling default boot option\n");
1240 if (handler->pending_boot && handler->pending_boot_is_default) {
1241 boot_cancel(handler->pending_boot);
1242 handler->pending_boot = NULL;
1243 handler->pending_boot_is_default = false;
1246 handler->default_boot_option = NULL;
1248 device_handler_status_info(handler, _("Default boot cancelled"));
1251 void device_handler_update_config(struct device_handler *handler,
1252 struct config *config)
1256 rc = config_set(config);
1260 discover_server_notify_config(handler->server, config);
1261 device_handler_update_lang(config->lang);
1262 device_handler_reinit(handler);
1265 static char *device_from_addr(void *ctx, struct pb_url *url)
1267 char *ipaddr, *buf, *tok, *dev = NULL;
1268 const char *delim = " ";
1269 struct sockaddr_in *ip;
1270 struct sockaddr_in si;
1271 struct addrinfo *res;
1275 /* Note: IPv4 only */
1276 rc = inet_pton(AF_INET, url->host, &(si.sin_addr));
1280 /* need to turn hostname into a valid IP */
1281 rc = getaddrinfo(url->host, NULL, NULL, &res);
1283 pb_debug("%s: Invalid URL\n",__func__);
1286 ipaddr = talloc_array(ctx,char,INET_ADDRSTRLEN);
1287 ip = (struct sockaddr_in *) res->ai_addr;
1288 inet_ntop(AF_INET, &(ip->sin_addr), ipaddr, INET_ADDRSTRLEN);
1292 const char *argv[] = {
1294 "route", "show", "to", "match",
1299 p = process_create(ctx);
1301 p->path = pb_system_apps.ip;
1303 p->keep_stdout = true;
1305 rc = process_run_sync(p);
1307 if (rc || p->exit_status) {
1308 /* ip has complained for some reason; most likely
1309 * there is no route to the host - bail out */
1310 pb_debug("%s: `ip` returns non-zero exit status\n", __func__);
1311 pb_debug("ip buf: %s\n", p->stdout_buf);
1316 buf = p->stdout_buf;
1317 /* If a route is found, ip-route output will be of the form
1318 * "... dev DEVNAME ... " */
1319 tok = strtok(buf, delim);
1321 if (!strcmp(tok, "dev")) {
1322 tok = strtok(NULL, delim);
1323 dev = talloc_strdup(ctx, tok);
1326 tok = strtok(NULL, delim);
1331 pb_debug("%s: Found interface '%s'\n", __func__,dev);
1335 static void process_url_cb(struct load_url_result *result, void *data)
1337 struct device_handler *handler;
1338 struct discover_context *ctx;
1339 struct discover_device *dev;
1340 struct event *event = data;
1343 if (result->status != LOAD_OK) {
1344 pb_log("%s: Load failed for %s\n", __func__, result->url->full);
1351 handler = talloc_parent(event);
1355 event->device = device_from_addr(event, result->url);
1356 if (!event->device) {
1357 pb_log("Downloaded a file but can't find its interface - pretending it was local\n");
1358 event->device = talloc_asprintf(event, "local");
1361 mac = event_get_param(event, "mac");
1362 char *url = talloc_asprintf(event, "file://%s", result->local);
1363 event_set_param(event, "pxeconffile-local", url);
1365 dev = discover_device_create(handler, mac, event->device);
1366 ctx = device_handler_discover_context_create(handler, dev);
1367 talloc_steal(ctx, event);
1370 iterate_parsers(ctx);
1372 device_handler_discover_context_commit(handler, ctx);
1374 talloc_unlink(handler, ctx);
1377 void device_handler_process_url(struct device_handler *handler,
1378 const char *url, const char *mac, const char *ip)
1380 struct discover_context *ctx;
1381 struct discover_device *dev;
1382 bool allow_async = false;
1383 struct pb_url *pb_url;
1384 struct event *event;
1386 event = talloc_zero(handler, struct event);
1387 event->type = EVENT_TYPE_USER;
1388 event->action = EVENT_ACTION_URL;
1390 pb_url = pb_url_parse(event, url);
1391 if (!pb_url || (pb_url->scheme != pb_url_file && !pb_url->host)) {
1392 device_handler_status_err(handler, _("Invalid config URL!"));
1397 if (url[strlen(url) - 1] == '/') {
1398 event_set_param(event, "pxepathprefix", url);
1399 event_set_param(event, "mac", mac);
1400 event_set_param(event, "ip", ip);
1401 event->device = device_from_addr(event, pb_url);
1402 if (!event->device) {
1403 device_handler_status_err(handler,
1404 _("Unable to route to host %s"),
1410 event_set_param(event, "pxeconffile", url);
1414 if (pb_url->scheme == pb_url_file)
1415 event->device = talloc_asprintf(event, "local");
1416 else if (allow_async) {
1417 /* If file is remote load asynchronously before passing to
1418 * parser. This allows us to wait for network to be available */
1419 if (!load_url_async(handler, pb_url, process_url_cb, event,
1421 pb_log("Failed to load url %s\n", pb_url->full);
1422 device_handler_status_err(handler, _("Failed to load URL!"));
1428 /* If path is local we can parse straight away */
1430 dev = discover_device_create(handler, mac, event->device);
1431 if (pb_url->scheme == pb_url_file)
1432 dev->device->type = DEVICE_TYPE_ANY;
1433 ctx = device_handler_discover_context_create(handler, dev);
1434 talloc_steal(ctx, event);
1437 iterate_parsers(ctx);
1439 device_handler_discover_context_commit(handler, ctx);
1441 talloc_unlink(handler, ctx);
1444 static void plugin_install_cb(struct process *process)
1446 struct device_handler *handler = process->data;
1449 pb_log("%s: Missing data!\n", __func__);
1453 handler->plugin_installing = false;
1454 if (process->exit_status) {
1455 device_handler_status_err(handler, "Plugin failed to install!");
1456 pb_log("Failed to install plugin:\n%s\n", process->stdout_buf);
1460 void device_handler_install_plugin(struct device_handler *handler,
1461 const char *plugin_file)
1466 if (handler->plugin_installing) {
1467 pb_log("Plugin install cancelled - install already running");
1471 p = process_create(handler);
1473 pb_log("install_plugin: Failed to create process\n");
1477 const char *argv[] = {
1478 pb_system_apps.pb_plugin,
1485 p->path = pb_system_apps.pb_plugin;
1487 p->exit_cb = plugin_install_cb;
1489 p->keep_stdout = true;
1491 result = process_run_async(p);
1494 device_handler_status_err(handler, "Could not install plugin");
1496 handler->plugin_installing = true;
1499 #ifndef PETITBOOT_TEST
1502 * context_commit - Commit a temporary discovery context to the handler,
1503 * and notify the clients about any new options / devices
1505 void device_handler_discover_context_commit(struct device_handler *handler,
1506 struct discover_context *ctx)
1508 struct discover_device *dev = ctx->device;
1509 struct discover_boot_option *opt, *tmp;
1511 if (!device_lookup_by_uuid(handler, dev->uuid))
1512 device_handler_add_device(handler, dev);
1514 /* move boot options from the context to the device */
1515 list_for_each_entry_safe(&ctx->boot_options, opt, tmp, list) {
1516 list_remove(&opt->list);
1518 /* All boot options need at least a kernel image */
1519 if (!opt->boot_image || !opt->boot_image->url) {
1520 pb_log("boot option %s is missing boot image, ignoring\n",
1526 if (boot_option_resolve(opt, handler)) {
1527 pb_log("boot option %s is resolved, "
1528 "sending to clients\n",
1530 list_add_tail(&dev->boot_options, &opt->list);
1531 talloc_steal(dev, opt);
1532 boot_option_finalise(handler, opt);
1533 notify_boot_option(handler, opt);
1535 if (!opt->source->resolve_resource) {
1536 pb_log("parser %s gave us an unresolved "
1537 "resource (%s), but no way to "
1539 opt->source->name, opt->option->id);
1542 pb_log("boot option %s is unresolved, "
1543 "adding to queue\n",
1545 list_add(&handler->unresolved_boot_options,
1547 talloc_steal(handler, opt);
1553 void device_handler_add_plugin_option(struct device_handler *handler,
1554 struct plugin_option *opt)
1556 struct plugin_option *tmp;
1559 for (i = 0; i < handler->n_plugins; i++) {
1560 tmp = handler->plugins[i];
1561 /* If both id and version match, ignore */
1562 if (strncmp(opt->id, tmp->id, strlen(opt->id)) == 0 &&
1563 strncmp(opt->version, tmp->version,
1564 strlen(opt->version) == 0)) {
1565 pb_log("discover: Plugin '%s' already exists, ignoring\n",
1571 handler->plugins = talloc_realloc(handler, handler->plugins,
1572 struct plugin_option *, handler->n_plugins + 1);
1573 if (!handler->plugins) {
1574 pb_log("Failed to allocate memory for new plugin\n");
1575 handler->n_plugins = 0;
1579 handler->plugins[handler->n_plugins++] = opt;
1580 discover_server_notify_plugin_option_add(handler->server, opt);
1583 static void device_handler_update_lang(const char *lang)
1585 const char *cur_lang;
1590 cur_lang = setlocale(LC_ALL, NULL);
1591 if (cur_lang && !strcmp(cur_lang, lang))
1594 setlocale(LC_ALL, lang);
1597 static int device_handler_init_sources(struct device_handler *handler)
1599 /* init our device sources: udev, network and user events */
1600 handler->user_event = user_event_init(handler, handler->waitset);
1601 if (!handler->user_event)
1604 handler->network = network_init(handler, handler->waitset,
1606 if (!handler->network)
1609 handler->udev = udev_init(handler, handler->waitset);
1616 static void device_handler_reinit_sources(struct device_handler *handler)
1618 /* if we haven't initialised sources previously (becuase we started in
1619 * safe mode), then init once here. */
1620 if (!(handler->udev || handler->network || handler->user_event)) {
1621 device_handler_init_sources(handler);
1625 system_info_reinit();
1627 network_shutdown(handler->network);
1628 handler->network = network_init(handler, handler->waitset,
1631 udev_reinit(handler->udev);
1634 static inline const char *get_device_path(struct discover_device *dev)
1636 return dev->ramdisk ? dev->ramdisk->snapshot : dev->device_path;
1639 static char *check_subvols(struct discover_device *dev)
1641 const char *fstype = discover_device_get_param(dev, "ID_FS_TYPE");
1646 if (strncmp(fstype, "btrfs", strlen("btrfs")))
1647 return dev->mount_path;
1649 /* On btrfs a device's root may be under a subvolume path */
1650 path = join_paths(dev, dev->mount_path, "@");
1651 rc = stat(path, &sb);
1652 if (!rc && S_ISDIR(sb.st_mode)) {
1653 pb_debug("Using '%s' for btrfs root path\n", path);
1658 return dev->mount_path;
1661 static bool check_existing_mount(struct discover_device *dev)
1663 struct stat devstat, mntstat;
1664 const char *device_path;
1669 device_path = get_device_path(dev);
1671 rc = stat(device_path, &devstat);
1673 pb_debug("%s: stat failed: %s\n", __func__, strerror(errno));
1677 if (!S_ISBLK(devstat.st_mode)) {
1678 pb_debug("%s: %s isn't a block device?\n", __func__,
1683 fp = fopen("/proc/self/mounts", "r");
1686 mnt = getmntent(fp);
1690 if (!mnt->mnt_fsname || mnt->mnt_fsname[0] != '/')
1693 rc = stat(mnt->mnt_fsname, &mntstat);
1697 if (!S_ISBLK(mntstat.st_mode))
1700 if (mntstat.st_rdev == devstat.st_rdev) {
1701 dev->mount_path = talloc_strdup(dev, mnt->mnt_dir);
1702 dev->root_path = check_subvols(dev);
1703 dev->mounted_rw = !!hasmntopt(mnt, "rw");
1704 dev->mounted = true;
1705 dev->unmount = false;
1707 pb_debug("%s: %s is already mounted (r%c) at %s\n",
1708 __func__, dev->device_path,
1709 dev->mounted_rw ? 'w' : 'o',
1721 * Attempt to mount a filesystem safely, while handling certain filesytem-
1724 static int try_mount(const char *device_path, const char *mount_path,
1725 const char *fstype, unsigned long flags,
1728 const char *fs, *safe_opts;
1731 /* Mount ext3 as ext4 instead so 'norecovery' can be used */
1732 if (strncmp(fstype, "ext3", strlen("ext3")) == 0) {
1733 pb_debug("Mounting ext3 filesystem as ext4\n");
1738 if (strncmp(fs, "xfs", strlen("xfs")) == 0 ||
1739 strncmp(fs, "ext4", strlen("ext4")) == 0)
1740 safe_opts = "norecovery";
1745 /* If no snapshot is available don't attempt recovery */
1747 return mount(device_path, mount_path, fs, flags, safe_opts);
1749 rc = mount(device_path, mount_path, fs, flags, NULL);
1754 /* Mounting failed; some filesystems will fail to mount if a recovery
1755 * journal exists (eg. cross-endian XFS), so try again with norecovery
1756 * where that option is available.
1757 * If mounting read-write just return the error as norecovery is not a
1759 if ((flags & MS_RDONLY) != MS_RDONLY || !safe_opts)
1763 return mount(device_path, mount_path, fs, flags, safe_opts);
1766 static int mount_device(struct discover_device *dev)
1768 const char *fstype, *device_path;
1771 if (!dev->device_path)
1777 if (check_existing_mount(dev))
1780 fstype = discover_device_get_param(dev, "ID_FS_TYPE");
1784 dev->mount_path = join_paths(dev, mount_base(),
1787 if (pb_mkdir_recursive(dev->mount_path)) {
1788 pb_log("couldn't create mount directory %s: %s\n",
1789 dev->mount_path, strerror(errno));
1793 device_path = get_device_path(dev);
1795 pb_log("mounting device %s read-only\n", dev->device_path);
1796 rc = try_mount(device_path, dev->mount_path, fstype,
1797 MS_RDONLY | MS_SILENT, dev->ramdisk);
1799 /* If mount fails clean up any snapshot and try again */
1800 if (rc && dev->ramdisk) {
1801 pb_log("couldn't mount snapshot for %s: mount failed: %s\n",
1802 device_path, strerror(errno));
1803 pb_log("falling back to actual device\n");
1805 devmapper_destroy_snapshot(dev);
1807 device_path = get_device_path(dev);
1808 pb_log("mounting device %s read-only\n", dev->device_path);
1809 rc = try_mount(device_path, dev->mount_path, fstype,
1810 MS_RDONLY | MS_SILENT, dev->ramdisk);
1814 dev->mounted = true;
1815 dev->mounted_rw = false;
1816 dev->unmount = true;
1817 dev->root_path = check_subvols(dev);
1821 pb_log("couldn't mount device %s: mount failed: %s\n",
1822 device_path, strerror(errno));
1824 pb_rmdir_recursive(mount_base(), dev->mount_path);
1826 talloc_free(dev->mount_path);
1827 dev->mount_path = NULL;
1831 static int umount_device(struct discover_device *dev)
1833 const char *device_path;
1836 if (!dev->mounted || !dev->unmount)
1839 device_path = get_device_path(dev);
1841 pb_log("unmounting device %s\n", device_path);
1842 rc = umount(dev->mount_path);
1846 dev->mounted = false;
1847 devmapper_destroy_snapshot(dev);
1849 pb_rmdir_recursive(mount_base(), dev->mount_path);
1851 talloc_free(dev->mount_path);
1852 dev->mount_path = NULL;
1853 dev->root_path = NULL;
1858 int device_request_write(struct discover_device *dev, bool *release)
1860 const char *fstype, *device_path;
1861 const struct config *config;
1866 config = config_get();
1867 if (!config->allow_writes)
1873 if (dev->mounted_rw)
1876 fstype = discover_device_get_param(dev, "ID_FS_TYPE");
1878 device_path = get_device_path(dev);
1880 pb_log("remounting device %s read-write\n", device_path);
1882 rc = umount(dev->mount_path);
1884 pb_log("Failed to unmount %s: %s\n",
1885 dev->mount_path, strerror(errno));
1889 rc = try_mount(device_path, dev->mount_path, fstype,
1890 MS_SILENT, dev->ramdisk);
1894 dev->mounted_rw = true;
1899 pb_log("Unable to remount device %s read-write: %s\n",
1900 device_path, strerror(errno));
1901 rc = try_mount(device_path, dev->mount_path, fstype,
1902 MS_RDONLY | MS_SILENT, dev->ramdisk);
1904 pb_log("Unable to recover mount for %s: %s\n",
1905 device_path, strerror(errno));
1909 void device_release_write(struct discover_device *dev, bool release)
1911 const char *fstype, *device_path;
1916 device_path = get_device_path(dev);
1918 fstype = discover_device_get_param(dev, "ID_FS_TYPE");
1920 pb_log("remounting device %s read-only\n", device_path);
1922 if (umount(dev->mount_path)) {
1923 pb_log("Failed to unmount %s\n", dev->mount_path);
1926 dev->mounted_rw = dev->mounted = false;
1929 devmapper_merge_snapshot(dev);
1930 /* device_path becomes stale after merge */
1931 device_path = get_device_path(dev);
1934 if (try_mount(device_path, dev->mount_path, fstype,
1935 MS_RDONLY | MS_SILENT, dev->ramdisk))
1936 pb_log("Failed to remount %s read-only: %s\n",
1937 device_path, strerror(errno));
1939 dev->mounted = true;
1942 void device_sync_snapshots(struct device_handler *handler, const char *device)
1944 struct discover_device *dev = NULL;
1948 /* Find matching device and sync */
1949 dev = device_lookup_by_name(handler, device);
1951 pb_log("%s: device name '%s' unrecognised\n",
1956 device_release_write(dev, true);
1958 pb_log("%s has no snapshot to merge, skipping\n",
1963 /* Otherwise sync all relevant devices */
1964 for (i = 0; i < handler->n_devices; i++) {
1965 dev = handler->devices[i];
1966 if (dev->device->type != DEVICE_TYPE_DISK &&
1967 dev->device->type != DEVICE_TYPE_USB)
1970 device_release_write(dev, true);
1972 pb_log("%s has no snapshot to merge, skipping\n",
1979 void device_handler_discover_context_commit(
1980 struct device_handler *handler __attribute__((unused)),
1981 struct discover_context *ctx __attribute__((unused)))
1983 pb_log("%s stubbed out for test cases\n", __func__);
1986 static void device_handler_update_lang(const char *lang __attribute__((unused)))
1990 static int device_handler_init_sources(
1991 struct device_handler *handler __attribute__((unused)))
1996 static void device_handler_reinit_sources(
1997 struct device_handler *handler __attribute__((unused)))
2001 static int umount_device(struct discover_device *dev __attribute__((unused)))
2006 static int __attribute__((unused)) mount_device(
2007 struct discover_device *dev __attribute__((unused)))
2012 int device_request_write(struct discover_device *dev __attribute__((unused)),
2019 void device_release_write(struct discover_device *dev __attribute__((unused)),
2020 bool release __attribute__((unused)))
2024 void device_sync_snapshots(
2025 struct device_handler *handler __attribute__((unused)),
2026 const char *device __attribute__((unused)))