11 #include <talloc/talloc.h>
12 #include <list/list.h>
14 #include <types/types.h>
15 #include <system/system.h>
16 #include <process/process.h>
19 #include "device-handler.h"
20 #include "discover-server.h"
29 struct device_handler {
30 struct discover_server *server;
33 struct discover_device **devices;
34 unsigned int n_devices;
36 struct waitset *waitset;
37 struct waiter *timeout_waiter;
38 bool autoboot_enabled;
39 unsigned int sec_to_boot;
41 struct discover_boot_option *default_boot_option;
42 struct list unresolved_boot_options;
44 struct boot_task *pending_boot;
45 bool pending_boot_is_default;
48 static int mount_device(struct discover_device *dev);
49 static int umount_device(struct discover_device *dev);
51 void discover_context_add_boot_option(struct discover_context *ctx,
52 struct discover_boot_option *boot_option)
54 boot_option->source = ctx->parser;
55 list_add_tail(&ctx->boot_options, &boot_option->list);
56 talloc_steal(ctx, boot_option);
60 * device_handler_get_device_count - Get the count of current handler devices.
63 int device_handler_get_device_count(const struct device_handler *handler)
65 return handler->n_devices;
69 * device_handler_get_device - Get a handler device by index.
72 const struct discover_device *device_handler_get_device(
73 const struct device_handler *handler, unsigned int index)
75 if (index >= handler->n_devices) {
76 assert(0 && "bad index");
80 return handler->devices[index];
83 struct discover_boot_option *discover_boot_option_create(
84 struct discover_context *ctx,
85 struct discover_device *device)
87 struct discover_boot_option *opt;
89 opt = talloc_zero(ctx, struct discover_boot_option);
90 opt->option = talloc_zero(opt, struct boot_option);
96 static int device_match_uuid(struct discover_device *dev, const char *uuid)
98 return dev->uuid && !strcmp(dev->uuid, uuid);
101 static int device_match_label(struct discover_device *dev, const char *label)
103 return dev->label && !strcmp(dev->label, label);
106 static int device_match_id(struct discover_device *dev, const char *id)
108 return !strcmp(dev->device->id, id);
111 static int device_match_serial(struct discover_device *dev, const char *serial)
113 const char *val = discover_device_get_param(dev, "ID_SERIAL");
114 return val && !strcmp(val, serial);
117 static struct discover_device *device_lookup(
118 struct device_handler *device_handler,
119 int (match_fn)(struct discover_device *, const char *),
122 struct discover_device *dev;
128 for (i = 0; i < device_handler->n_devices; i++) {
129 dev = device_handler->devices[i];
131 if (match_fn(dev, str))
138 struct discover_device *device_lookup_by_name(struct device_handler *handler,
141 if (!strncmp(name, "/dev/", strlen("/dev/")))
142 name += strlen("/dev/");
144 return device_lookup_by_id(handler, name);
147 struct discover_device *device_lookup_by_uuid(
148 struct device_handler *device_handler,
151 return device_lookup(device_handler, device_match_uuid, uuid);
154 struct discover_device *device_lookup_by_label(
155 struct device_handler *device_handler,
158 return device_lookup(device_handler, device_match_label, label);
161 struct discover_device *device_lookup_by_id(
162 struct device_handler *device_handler,
165 return device_lookup(device_handler, device_match_id, id);
168 struct discover_device *device_lookup_by_serial(
169 struct device_handler *device_handler,
172 return device_lookup(device_handler, device_match_serial, serial);
175 void device_handler_destroy(struct device_handler *handler)
177 talloc_free(handler);
180 static int destroy_device(void *arg)
182 struct discover_device *dev = arg;
189 struct discover_device *discover_device_create(struct device_handler *handler,
192 struct discover_device *dev;
194 dev = device_lookup_by_id(handler, id);
198 dev = talloc_zero(handler, struct discover_device);
199 dev->device = talloc_zero(dev, struct device);
200 dev->device->id = talloc_strdup(dev->device, id);
201 list_init(&dev->params);
202 list_init(&dev->boot_options);
204 talloc_set_destructor(dev, destroy_device);
209 struct discover_device_param {
212 struct list_item list;
215 void discover_device_set_param(struct discover_device *device,
216 const char *name, const char *value)
218 struct discover_device_param *param;
221 list_for_each_entry(&device->params, param, list) {
222 if (!strcmp(param->name, name)) {
231 param = talloc(device, struct discover_device_param);
232 param->name = talloc_strdup(param, name);
233 list_add(&device->params, ¶m->list);
236 list_remove(¶m->list);
240 talloc_free(param->value);
243 param->value = talloc_strdup(param, value);
246 const char *discover_device_get_param(struct discover_device *device,
249 struct discover_device_param *param;
251 list_for_each_entry(&device->params, param, list) {
252 if (!strcmp(param->name, name))
258 struct device_handler *device_handler_init(struct discover_server *server,
259 struct waitset *waitset, int dry_run)
261 struct device_handler *handler;
263 handler = talloc_zero(NULL, struct device_handler);
264 handler->server = server;
265 handler->waitset = waitset;
266 handler->dry_run = dry_run;
267 handler->autoboot_enabled = config_get()->autoboot_enabled;
269 list_init(&handler->unresolved_boot_options);
271 /* set up our mount point base */
272 pb_mkdir_recursive(mount_base());
279 void device_handler_remove(struct device_handler *handler,
280 struct discover_device *device)
282 struct discover_boot_option *opt, *tmp;
285 for (i = 0; i < handler->n_devices; i++)
286 if (handler->devices[i] == device)
289 if (i == handler->n_devices) {
294 /* Free any unresolved options, as they're currently allocated
295 * against the handler */
296 list_for_each_entry_safe(&handler->unresolved_boot_options,
298 if (opt->device != device)
300 list_remove(&opt->list);
304 handler->n_devices--;
305 memmove(&handler->devices[i], &handler->devices[i + 1],
306 (handler->n_devices - i) * sizeof(handler->devices[0]));
307 handler->devices = talloc_realloc(handler, handler->devices,
308 struct discover_device *, handler->n_devices);
310 if (device->notified)
311 discover_server_notify_device_remove(handler->server,
317 static void boot_status(void *arg, struct boot_status *status)
319 struct device_handler *handler = arg;
321 discover_server_notify_boot_status(handler->server, status);
324 static void countdown_status(struct device_handler *handler,
325 struct discover_boot_option *opt, unsigned int sec)
327 struct boot_status status;
329 status.type = BOOT_STATUS_INFO;
330 status.progress = -1;
331 status.detail = NULL;
332 status.message = talloc_asprintf(handler,
333 "Booting %s in %u sec", opt->option->name, sec);
335 discover_server_notify_boot_status(handler->server, &status);
337 talloc_free(status.message);
340 static int default_timeout(void *arg)
342 struct device_handler *handler = arg;
343 struct discover_boot_option *opt;
345 if (!handler->default_boot_option)
348 if (handler->pending_boot)
351 opt = handler->default_boot_option;
353 if (handler->sec_to_boot) {
354 countdown_status(handler, opt, handler->sec_to_boot);
355 handler->sec_to_boot--;
356 handler->timeout_waiter = waiter_register_timeout(
357 handler->waitset, 1000,
358 default_timeout, handler);
362 handler->timeout_waiter = NULL;
364 pb_log("Timeout expired, booting default option %s\n", opt->option->id);
366 handler->pending_boot = boot(handler, handler->default_boot_option,
367 NULL, handler->dry_run, boot_status, handler);
368 handler->pending_boot_is_default = true;
372 static bool priority_match(struct boot_priority *prio,
373 struct discover_boot_option *opt)
375 return prio->type == opt->device->device->type;
378 static int default_option_priority(struct discover_boot_option *opt)
380 const struct config *config;
381 struct boot_priority *prio;
384 config = config_get();
386 for (i = 0; i < config->n_boot_priorities; i++) {
387 prio = &config->boot_priorities[i];
388 if (priority_match(prio, opt))
389 return prio->priority;
395 static void set_default(struct device_handler *handler,
396 struct discover_boot_option *opt)
400 if (!handler->autoboot_enabled)
403 new_prio = default_option_priority(opt);
405 /* A negative priority indicates that we don't want to boot this device
410 /* Resolve any conflicts: if we have a new default option, it only
411 * replaces the current if it has a higher priority. */
412 if (handler->default_boot_option) {
415 cur_prio = default_option_priority(
416 handler->default_boot_option);
418 if (new_prio > cur_prio) {
419 handler->default_boot_option = opt;
420 /* extend the timeout a little, so the user sees some
421 * indication of the change */
422 handler->sec_to_boot += 2;
428 handler->sec_to_boot = config_get()->autoboot_timeout_sec;
429 handler->default_boot_option = opt;
431 pb_log("Boot option %s set as default, timeout %u sec.\n",
432 opt->option->id, handler->sec_to_boot);
434 default_timeout(handler);
437 static bool resource_is_resolved(struct resource *res)
439 return !res || res->resolved;
442 /* We only use this in an assert, which will disappear if we're compiling
443 * with NDEBUG, so we need the 'used' attribute for these builds */
444 static bool __attribute__((used)) boot_option_is_resolved(
445 struct discover_boot_option *opt)
447 return resource_is_resolved(opt->boot_image) &&
448 resource_is_resolved(opt->initrd) &&
449 resource_is_resolved(opt->dtb) &&
450 resource_is_resolved(opt->icon);
453 static bool resource_resolve(struct resource *res, const char *name,
454 struct discover_boot_option *opt,
455 struct device_handler *handler)
457 struct parser *parser = opt->source;
459 if (resource_is_resolved(res))
462 pb_debug("Attempting to resolve resource %s->%s with parser %s\n",
463 opt->option->id, name, parser->name);
464 parser->resolve_resource(handler, res);
466 return res->resolved;
469 static bool boot_option_resolve(struct discover_boot_option *opt,
470 struct device_handler *handler)
472 return resource_resolve(opt->boot_image, "boot_image", opt, handler) &&
473 resource_resolve(opt->initrd, "initrd", opt, handler) &&
474 resource_resolve(opt->dtb, "dtb", opt, handler) &&
475 resource_resolve(opt->icon, "icon", opt, handler);
478 static void boot_option_finalise(struct device_handler *handler,
479 struct discover_boot_option *opt)
481 assert(boot_option_is_resolved(opt));
483 /* check that the parsers haven't set any of the final data */
484 assert(!opt->option->boot_image_file);
485 assert(!opt->option->initrd_file);
486 assert(!opt->option->dtb_file);
487 assert(!opt->option->icon_file);
488 assert(!opt->option->device_id);
491 opt->option->boot_image_file = opt->boot_image->url->full;
493 opt->option->initrd_file = opt->initrd->url->full;
495 opt->option->dtb_file = opt->dtb->url->full;
497 opt->option->icon_file = opt->icon->url->full;
499 opt->option->device_id = opt->device->device->id;
501 if (opt->option->is_default)
502 set_default(handler, opt);
505 static void notify_boot_option(struct device_handler *handler,
506 struct discover_boot_option *opt)
508 struct discover_device *dev = opt->device;
511 discover_server_notify_device_add(handler->server,
512 opt->device->device);
513 dev->notified = true;
514 discover_server_notify_boot_option_add(handler->server, opt->option);
517 static void process_boot_option_queue(struct device_handler *handler)
519 struct discover_boot_option *opt, *tmp;
521 list_for_each_entry_safe(&handler->unresolved_boot_options,
524 pb_debug("queue: attempting resolution for %s\n",
527 if (!boot_option_resolve(opt, handler))
530 pb_debug("\tresolved!\n");
532 list_remove(&opt->list);
533 list_add_tail(&opt->device->boot_options, &opt->list);
534 talloc_steal(opt->device, opt);
535 boot_option_finalise(handler, opt);
536 notify_boot_option(handler, opt);
540 struct discover_context *device_handler_discover_context_create(
541 struct device_handler *handler,
542 struct discover_device *device)
544 struct discover_context *ctx;
546 ctx = talloc_zero(handler, struct discover_context);
547 ctx->device = device;
548 list_init(&ctx->boot_options);
554 * context_commit - Commit a temporary discovery context to the handler,
555 * and notify the clients about any new options / devices
557 void device_handler_discover_context_commit(struct device_handler *handler,
558 struct discover_context *ctx)
560 struct discover_device *dev = ctx->device;
561 struct discover_boot_option *opt, *tmp;
563 if (!device_lookup_by_id(handler, dev->device->id))
564 device_handler_add_device(handler, dev);
566 /* move boot options from the context to the device */
567 list_for_each_entry_safe(&ctx->boot_options, opt, tmp, list) {
568 list_remove(&opt->list);
570 if (boot_option_resolve(opt, handler)) {
571 pb_log("boot option %s is resolved, "
572 "sending to clients\n",
574 list_add_tail(&dev->boot_options, &opt->list);
575 talloc_steal(dev, opt);
576 boot_option_finalise(handler, opt);
577 notify_boot_option(handler, opt);
579 if (!opt->source->resolve_resource) {
580 pb_log("parser %s gave us an unresolved "
581 "resource (%s), but no way to "
583 opt->source->name, opt->option->id);
586 pb_log("boot option %s is unresolved, "
589 list_add(&handler->unresolved_boot_options,
591 talloc_steal(handler, opt);
597 void device_handler_add_device(struct device_handler *handler,
598 struct discover_device *device)
600 handler->n_devices++;
601 handler->devices = talloc_realloc(handler, handler->devices,
602 struct discover_device *, handler->n_devices);
603 handler->devices[handler->n_devices - 1] = device;
607 /* Start discovery on a hotplugged device. The device will be in our devices
608 * array, but has only just been initialised by the hotplug source.
610 int device_handler_discover(struct device_handler *handler,
611 struct discover_device *dev)
613 struct discover_context *ctx;
616 process_boot_option_queue(handler);
618 /* create our context */
619 ctx = device_handler_discover_context_create(handler, dev);
621 rc = mount_device(dev);
625 /* add this device to our system info */
626 system_info_register_blockdev(dev->device->id, dev->uuid,
629 /* run the parsers. This will populate the ctx's boot_option list. */
630 iterate_parsers(ctx);
632 /* add discovered stuff to the handler */
633 device_handler_discover_context_commit(handler, ctx);
641 /* Incoming dhcp event */
642 int device_handler_dhcp(struct device_handler *handler,
643 struct discover_device *dev, struct event *event)
645 struct discover_context *ctx;
647 /* create our context */
648 ctx = device_handler_discover_context_create(handler, dev);
651 iterate_parsers(ctx);
653 device_handler_discover_context_commit(handler, ctx);
660 /* incoming conf event */
661 int device_handler_conf(struct device_handler *handler,
662 struct discover_device *dev, struct pb_url *url)
664 struct discover_context *ctx;
666 /* create our context */
667 ctx = device_handler_discover_context_create(handler, dev);
670 iterate_parsers(ctx);
672 device_handler_discover_context_commit(handler, ctx);
679 static struct discover_boot_option *find_boot_option_by_id(
680 struct device_handler *handler, const char *id)
684 for (i = 0; i < handler->n_devices; i++) {
685 struct discover_device *dev = handler->devices[i];
686 struct discover_boot_option *opt;
688 list_for_each_entry(&dev->boot_options, opt, list)
689 if (!strcmp(opt->option->id, id))
696 void device_handler_boot(struct device_handler *handler,
697 struct boot_command *cmd)
699 struct discover_boot_option *opt = NULL;
701 if (cmd->option_id && strlen(cmd->option_id))
702 opt = find_boot_option_by_id(handler, cmd->option_id);
704 if (handler->pending_boot)
705 boot_cancel(handler->pending_boot);
706 handler->pending_boot = boot(handler, opt, cmd, handler->dry_run,
707 boot_status, handler);
708 handler->pending_boot_is_default = false;
711 void device_handler_cancel_default(struct device_handler *handler)
713 struct boot_status status;
715 if (handler->timeout_waiter)
716 waiter_remove(handler->timeout_waiter);
718 handler->timeout_waiter = NULL;
719 handler->autoboot_enabled = false;
721 /* we only send status if we had a default boot option queued */
722 if (!handler->default_boot_option)
725 pb_log("Cancelling default boot option\n");
727 if (handler->pending_boot && handler->pending_boot_is_default) {
728 boot_cancel(handler->pending_boot);
729 handler->pending_boot = NULL;
730 handler->pending_boot_is_default = false;
733 handler->default_boot_option = NULL;
735 status.type = BOOT_STATUS_INFO;
736 status.progress = -1;
737 status.detail = NULL;
738 status.message = "Default boot cancelled";
740 discover_server_notify_boot_status(handler->server, &status);
743 void device_handler_update_config(struct device_handler *handler,
744 struct config *config)
747 discover_server_notify_config(handler->server, config);
750 #ifndef PETITBOOT_TEST
751 static bool check_existing_mount(struct discover_device *dev)
753 struct stat devstat, mntstat;
758 rc = stat(dev->device_path, &devstat);
760 pb_debug("%s: stat failed: %s\n", __func__, strerror(errno));
764 if (!S_ISBLK(devstat.st_mode)) {
765 pb_debug("%s: %s isn't a block device?\n", __func__,
770 fp = fopen("/proc/self/mounts", "r");
777 if (!mnt->mnt_fsname || mnt->mnt_fsname[0] != '/')
780 rc = stat(mnt->mnt_fsname, &mntstat);
784 if (!S_ISBLK(mntstat.st_mode))
787 if (mntstat.st_rdev == devstat.st_rdev) {
788 dev->mount_path = talloc_strdup(dev, mnt->mnt_dir);
789 dev->mounted_rw = !!hasmntopt(mnt, "rw");
791 dev->unmount = false;
793 pb_debug("%s: %s is already mounted (r%c) at %s\n",
794 __func__, dev->device_path,
795 dev->mounted_rw ? 'w' : 'o',
806 static int mount_device(struct discover_device *dev)
810 if (!dev->device_path)
816 if (check_existing_mount(dev))
819 dev->mount_path = join_paths(dev, mount_base(),
822 if (pb_mkdir_recursive(dev->mount_path)) {
823 pb_log("couldn't create mount directory %s: %s\n",
824 dev->mount_path, strerror(errno));
828 rc = process_run_simple(dev, pb_system_apps.mount,
829 dev->device_path, dev->mount_path,
833 dev->mounted_rw = false;
838 /* Retry mount without ro option. */
839 rc = process_run_simple(dev, pb_system_apps.mount,
840 dev->device_path, dev->mount_path, NULL);
844 dev->mounted_rw = true;
849 pb_rmdir_recursive(mount_base(), dev->mount_path);
851 talloc_free(dev->mount_path);
852 dev->mount_path = NULL;
856 static int umount_device(struct discover_device *dev)
860 if (!dev->mounted || !dev->unmount)
863 status = process_run_simple(dev, pb_system_apps.umount,
864 dev->mount_path, NULL);
866 if (!WIFEXITED(status) || WEXITSTATUS(status) != 0)
869 dev->mounted = false;
871 pb_rmdir_recursive(mount_base(), dev->mount_path);
873 talloc_free(dev->mount_path);
874 dev->mount_path = NULL;
879 int device_request_write(struct discover_device *dev, bool *release)
891 rc = process_run_simple(dev, pb_system_apps.mount, dev->mount_path,
892 "-o", "remount,rw", NULL);
896 dev->mounted_rw = true;
901 void device_release_write(struct discover_device *dev, bool release)
906 process_run_simple(dev, pb_system_apps.mount, dev->mount_path,
907 "-o", "remount,ro", NULL);
908 dev->mounted_rw = false;
913 static int umount_device(struct discover_device *dev __attribute__((unused)))
918 static int __attribute__((unused)) mount_device(
919 struct discover_device *dev __attribute__((unused)))
924 int device_request_write(struct discover_device *dev __attribute__((unused)),
931 void device_release_write(struct discover_device *dev __attribute__((unused)),
932 bool release __attribute__((unused)))