10 #include <sys/mount.h>
12 #include <talloc/talloc.h>
13 #include <list/list.h>
15 #include <types/types.h>
16 #include <system/system.h>
17 #include <process/process.h>
20 #include "device-handler.h"
21 #include "discover-server.h"
22 #include "user-event.h"
33 struct device_handler {
34 struct discover_server *server;
38 struct network *network;
39 struct user_event *user_event;
41 struct discover_device **devices;
42 unsigned int n_devices;
44 struct waitset *waitset;
45 struct waiter *timeout_waiter;
46 bool autoboot_enabled;
47 unsigned int sec_to_boot;
49 struct discover_boot_option *default_boot_option;
50 struct list unresolved_boot_options;
52 struct boot_task *pending_boot;
53 bool pending_boot_is_default;
56 static int mount_device(struct discover_device *dev);
57 static int umount_device(struct discover_device *dev);
59 static int device_handler_init_sources(struct device_handler *handler);
60 static void device_handler_reinit_sources(struct device_handler *handler);
62 void discover_context_add_boot_option(struct discover_context *ctx,
63 struct discover_boot_option *boot_option)
65 boot_option->source = ctx->parser;
66 list_add_tail(&ctx->boot_options, &boot_option->list);
67 talloc_steal(ctx, boot_option);
71 * device_handler_get_device_count - Get the count of current handler devices.
74 int device_handler_get_device_count(const struct device_handler *handler)
76 return handler->n_devices;
80 * device_handler_get_device - Get a handler device by index.
83 const struct discover_device *device_handler_get_device(
84 const struct device_handler *handler, unsigned int index)
86 if (index >= handler->n_devices) {
87 assert(0 && "bad index");
91 return handler->devices[index];
94 struct discover_boot_option *discover_boot_option_create(
95 struct discover_context *ctx,
96 struct discover_device *device)
98 struct discover_boot_option *opt;
100 opt = talloc_zero(ctx, struct discover_boot_option);
101 opt->option = talloc_zero(opt, struct boot_option);
102 opt->device = device;
107 static int device_match_uuid(struct discover_device *dev, const char *uuid)
109 return dev->uuid && !strcmp(dev->uuid, uuid);
112 static int device_match_label(struct discover_device *dev, const char *label)
114 return dev->label && !strcmp(dev->label, label);
117 static int device_match_id(struct discover_device *dev, const char *id)
119 return !strcmp(dev->device->id, id);
122 static int device_match_serial(struct discover_device *dev, const char *serial)
124 const char *val = discover_device_get_param(dev, "ID_SERIAL");
125 return val && !strcmp(val, serial);
128 static struct discover_device *device_lookup(
129 struct device_handler *device_handler,
130 int (match_fn)(struct discover_device *, const char *),
133 struct discover_device *dev;
139 for (i = 0; i < device_handler->n_devices; i++) {
140 dev = device_handler->devices[i];
142 if (match_fn(dev, str))
149 struct discover_device *device_lookup_by_name(struct device_handler *handler,
152 if (!strncmp(name, "/dev/", strlen("/dev/")))
153 name += strlen("/dev/");
155 return device_lookup_by_id(handler, name);
158 struct discover_device *device_lookup_by_uuid(
159 struct device_handler *device_handler,
162 return device_lookup(device_handler, device_match_uuid, uuid);
165 struct discover_device *device_lookup_by_label(
166 struct device_handler *device_handler,
169 return device_lookup(device_handler, device_match_label, label);
172 struct discover_device *device_lookup_by_id(
173 struct device_handler *device_handler,
176 return device_lookup(device_handler, device_match_id, id);
179 struct discover_device *device_lookup_by_serial(
180 struct device_handler *device_handler,
183 return device_lookup(device_handler, device_match_serial, serial);
186 void device_handler_destroy(struct device_handler *handler)
188 talloc_free(handler);
191 static int destroy_device(void *arg)
193 struct discover_device *dev = arg;
200 struct discover_device *discover_device_create(struct device_handler *handler,
203 struct discover_device *dev;
205 dev = device_lookup_by_id(handler, id);
209 dev = talloc_zero(handler, struct discover_device);
210 dev->device = talloc_zero(dev, struct device);
211 dev->device->id = talloc_strdup(dev->device, id);
212 list_init(&dev->params);
213 list_init(&dev->boot_options);
215 talloc_set_destructor(dev, destroy_device);
220 struct discover_device_param {
223 struct list_item list;
226 void discover_device_set_param(struct discover_device *device,
227 const char *name, const char *value)
229 struct discover_device_param *param;
232 list_for_each_entry(&device->params, param, list) {
233 if (!strcmp(param->name, name)) {
242 param = talloc(device, struct discover_device_param);
243 param->name = talloc_strdup(param, name);
244 list_add(&device->params, ¶m->list);
247 list_remove(¶m->list);
251 talloc_free(param->value);
254 param->value = talloc_strdup(param, value);
257 const char *discover_device_get_param(struct discover_device *device,
260 struct discover_device_param *param;
262 list_for_each_entry(&device->params, param, list) {
263 if (!strcmp(param->name, name))
269 struct device_handler *device_handler_init(struct discover_server *server,
270 struct waitset *waitset, int dry_run)
272 struct device_handler *handler;
275 handler = talloc_zero(NULL, struct device_handler);
276 handler->server = server;
277 handler->waitset = waitset;
278 handler->dry_run = dry_run;
279 handler->autoboot_enabled = config_get()->autoboot_enabled;
281 list_init(&handler->unresolved_boot_options);
283 /* set up our mount point base */
284 pb_mkdir_recursive(mount_base());
288 rc = device_handler_init_sources(handler);
290 talloc_free(handler);
297 void device_handler_reinit(struct device_handler *handler)
299 struct discover_boot_option *opt, *tmp;
302 device_handler_cancel_default(handler);
304 /* free unresolved boot options */
305 list_for_each_entry_safe(&handler->unresolved_boot_options,
308 list_init(&handler->unresolved_boot_options);
310 /* drop all devices */
311 for (i = 0; i < handler->n_devices; i++)
312 discover_server_notify_device_remove(handler->server,
313 handler->devices[i]->device);
315 talloc_free(handler->devices);
316 handler->devices = NULL;
317 handler->n_devices = 0;
319 device_handler_reinit_sources(handler);
322 void device_handler_remove(struct device_handler *handler,
323 struct discover_device *device)
325 struct discover_boot_option *opt, *tmp;
328 for (i = 0; i < handler->n_devices; i++)
329 if (handler->devices[i] == device)
332 if (i == handler->n_devices) {
337 /* Free any unresolved options, as they're currently allocated
338 * against the handler */
339 list_for_each_entry_safe(&handler->unresolved_boot_options,
341 if (opt->device != device)
343 list_remove(&opt->list);
347 /* if this is a network device, we have to unregister it from the
349 if (device->device->type == DEVICE_TYPE_NETWORK)
350 network_unregister_device(handler->network, device);
352 handler->n_devices--;
353 memmove(&handler->devices[i], &handler->devices[i + 1],
354 (handler->n_devices - i) * sizeof(handler->devices[0]));
355 handler->devices = talloc_realloc(handler, handler->devices,
356 struct discover_device *, handler->n_devices);
358 if (device->notified)
359 discover_server_notify_device_remove(handler->server,
365 static void boot_status(void *arg, struct boot_status *status)
367 struct device_handler *handler = arg;
369 discover_server_notify_boot_status(handler->server, status);
372 static void countdown_status(struct device_handler *handler,
373 struct discover_boot_option *opt, unsigned int sec)
375 struct boot_status status;
377 status.type = BOOT_STATUS_INFO;
378 status.progress = -1;
379 status.detail = NULL;
380 status.message = talloc_asprintf(handler,
381 "Booting in %d sec: %s", sec, opt->option->name);
383 discover_server_notify_boot_status(handler->server, &status);
385 talloc_free(status.message);
388 static int default_timeout(void *arg)
390 struct device_handler *handler = arg;
391 struct discover_boot_option *opt;
393 if (!handler->default_boot_option)
396 if (handler->pending_boot)
399 opt = handler->default_boot_option;
401 if (handler->sec_to_boot) {
402 countdown_status(handler, opt, handler->sec_to_boot);
403 handler->sec_to_boot--;
404 handler->timeout_waiter = waiter_register_timeout(
405 handler->waitset, 1000,
406 default_timeout, handler);
410 handler->timeout_waiter = NULL;
412 pb_log("Timeout expired, booting default option %s\n", opt->option->id);
414 handler->pending_boot = boot(handler, handler->default_boot_option,
415 NULL, handler->dry_run, boot_status, handler);
416 handler->pending_boot_is_default = true;
420 static bool priority_match(struct boot_priority *prio,
421 struct discover_boot_option *opt)
423 return prio->type == opt->device->device->type ||
424 prio->type == DEVICE_TYPE_ANY;
427 static int default_option_priority(struct discover_boot_option *opt)
429 const struct config *config;
430 struct boot_priority *prio;
433 config = config_get();
435 for (i = 0; i < config->n_boot_priorities; i++) {
436 prio = &config->boot_priorities[i];
437 if (priority_match(prio, opt))
438 return prio->priority;
444 static void set_default(struct device_handler *handler,
445 struct discover_boot_option *opt)
449 if (!handler->autoboot_enabled)
452 new_prio = default_option_priority(opt);
454 /* A negative priority indicates that we don't want to boot this device
459 /* Resolve any conflicts: if we have a new default option, it only
460 * replaces the current if it has a higher priority. */
461 if (handler->default_boot_option) {
464 cur_prio = default_option_priority(
465 handler->default_boot_option);
467 if (new_prio > cur_prio) {
468 handler->default_boot_option = opt;
469 /* extend the timeout a little, so the user sees some
470 * indication of the change */
471 handler->sec_to_boot += 2;
477 handler->sec_to_boot = config_get()->autoboot_timeout_sec;
478 handler->default_boot_option = opt;
480 pb_log("Boot option %s set as default, timeout %u sec.\n",
481 opt->option->id, handler->sec_to_boot);
483 default_timeout(handler);
486 static bool resource_is_resolved(struct resource *res)
488 return !res || res->resolved;
491 /* We only use this in an assert, which will disappear if we're compiling
492 * with NDEBUG, so we need the 'used' attribute for these builds */
493 static bool __attribute__((used)) boot_option_is_resolved(
494 struct discover_boot_option *opt)
496 return resource_is_resolved(opt->boot_image) &&
497 resource_is_resolved(opt->initrd) &&
498 resource_is_resolved(opt->dtb) &&
499 resource_is_resolved(opt->icon);
502 static bool resource_resolve(struct resource *res, const char *name,
503 struct discover_boot_option *opt,
504 struct device_handler *handler)
506 struct parser *parser = opt->source;
508 if (resource_is_resolved(res))
511 pb_debug("Attempting to resolve resource %s->%s with parser %s\n",
512 opt->option->id, name, parser->name);
513 parser->resolve_resource(handler, res);
515 return res->resolved;
518 static bool boot_option_resolve(struct discover_boot_option *opt,
519 struct device_handler *handler)
521 return resource_resolve(opt->boot_image, "boot_image", opt, handler) &&
522 resource_resolve(opt->initrd, "initrd", opt, handler) &&
523 resource_resolve(opt->dtb, "dtb", opt, handler) &&
524 resource_resolve(opt->icon, "icon", opt, handler);
527 static void boot_option_finalise(struct device_handler *handler,
528 struct discover_boot_option *opt)
530 assert(boot_option_is_resolved(opt));
532 /* check that the parsers haven't set any of the final data */
533 assert(!opt->option->boot_image_file);
534 assert(!opt->option->initrd_file);
535 assert(!opt->option->dtb_file);
536 assert(!opt->option->icon_file);
537 assert(!opt->option->device_id);
540 opt->option->boot_image_file = opt->boot_image->url->full;
542 opt->option->initrd_file = opt->initrd->url->full;
544 opt->option->dtb_file = opt->dtb->url->full;
546 opt->option->icon_file = opt->icon->url->full;
548 opt->option->device_id = opt->device->device->id;
550 if (opt->option->is_default)
551 set_default(handler, opt);
554 static void notify_boot_option(struct device_handler *handler,
555 struct discover_boot_option *opt)
557 struct discover_device *dev = opt->device;
560 discover_server_notify_device_add(handler->server,
561 opt->device->device);
562 dev->notified = true;
563 discover_server_notify_boot_option_add(handler->server, opt->option);
566 static void process_boot_option_queue(struct device_handler *handler)
568 struct discover_boot_option *opt, *tmp;
570 list_for_each_entry_safe(&handler->unresolved_boot_options,
573 pb_debug("queue: attempting resolution for %s\n",
576 if (!boot_option_resolve(opt, handler))
579 pb_debug("\tresolved!\n");
581 list_remove(&opt->list);
582 list_add_tail(&opt->device->boot_options, &opt->list);
583 talloc_steal(opt->device, opt);
584 boot_option_finalise(handler, opt);
585 notify_boot_option(handler, opt);
589 struct discover_context *device_handler_discover_context_create(
590 struct device_handler *handler,
591 struct discover_device *device)
593 struct discover_context *ctx;
595 ctx = talloc_zero(handler, struct discover_context);
596 ctx->device = device;
597 list_init(&ctx->boot_options);
603 * context_commit - Commit a temporary discovery context to the handler,
604 * and notify the clients about any new options / devices
606 void device_handler_discover_context_commit(struct device_handler *handler,
607 struct discover_context *ctx)
609 struct discover_device *dev = ctx->device;
610 struct discover_boot_option *opt, *tmp;
612 if (!device_lookup_by_id(handler, dev->device->id))
613 device_handler_add_device(handler, dev);
615 /* move boot options from the context to the device */
616 list_for_each_entry_safe(&ctx->boot_options, opt, tmp, list) {
617 list_remove(&opt->list);
619 if (boot_option_resolve(opt, handler)) {
620 pb_log("boot option %s is resolved, "
621 "sending to clients\n",
623 list_add_tail(&dev->boot_options, &opt->list);
624 talloc_steal(dev, opt);
625 boot_option_finalise(handler, opt);
626 notify_boot_option(handler, opt);
628 if (!opt->source->resolve_resource) {
629 pb_log("parser %s gave us an unresolved "
630 "resource (%s), but no way to "
632 opt->source->name, opt->option->id);
635 pb_log("boot option %s is unresolved, "
638 list_add(&handler->unresolved_boot_options,
640 talloc_steal(handler, opt);
646 void device_handler_add_device(struct device_handler *handler,
647 struct discover_device *device)
649 handler->n_devices++;
650 handler->devices = talloc_realloc(handler, handler->devices,
651 struct discover_device *, handler->n_devices);
652 handler->devices[handler->n_devices - 1] = device;
654 if (device->device->type == DEVICE_TYPE_NETWORK)
655 network_register_device(handler->network, device);
658 /* Start discovery on a hotplugged device. The device will be in our devices
659 * array, but has only just been initialised by the hotplug source.
661 int device_handler_discover(struct device_handler *handler,
662 struct discover_device *dev)
664 struct discover_context *ctx;
667 process_boot_option_queue(handler);
669 /* create our context */
670 ctx = device_handler_discover_context_create(handler, dev);
672 rc = mount_device(dev);
676 /* add this device to our system info */
677 system_info_register_blockdev(dev->device->id, dev->uuid,
680 /* run the parsers. This will populate the ctx's boot_option list. */
681 iterate_parsers(ctx);
683 /* add discovered stuff to the handler */
684 device_handler_discover_context_commit(handler, ctx);
692 /* Incoming dhcp event */
693 int device_handler_dhcp(struct device_handler *handler,
694 struct discover_device *dev, struct event *event)
696 struct discover_context *ctx;
698 /* create our context */
699 ctx = device_handler_discover_context_create(handler, dev);
702 iterate_parsers(ctx);
704 device_handler_discover_context_commit(handler, ctx);
711 /* incoming conf event */
712 int device_handler_conf(struct device_handler *handler,
713 struct discover_device *dev, struct pb_url *url)
715 struct discover_context *ctx;
717 /* create our context */
718 ctx = device_handler_discover_context_create(handler, dev);
721 iterate_parsers(ctx);
723 device_handler_discover_context_commit(handler, ctx);
730 static struct discover_boot_option *find_boot_option_by_id(
731 struct device_handler *handler, const char *id)
735 for (i = 0; i < handler->n_devices; i++) {
736 struct discover_device *dev = handler->devices[i];
737 struct discover_boot_option *opt;
739 list_for_each_entry(&dev->boot_options, opt, list)
740 if (!strcmp(opt->option->id, id))
747 void device_handler_boot(struct device_handler *handler,
748 struct boot_command *cmd)
750 struct discover_boot_option *opt = NULL;
752 if (cmd->option_id && strlen(cmd->option_id))
753 opt = find_boot_option_by_id(handler, cmd->option_id);
755 if (handler->pending_boot)
756 boot_cancel(handler->pending_boot);
757 handler->pending_boot = boot(handler, opt, cmd, handler->dry_run,
758 boot_status, handler);
759 handler->pending_boot_is_default = false;
762 void device_handler_cancel_default(struct device_handler *handler)
764 struct boot_status status;
766 if (handler->timeout_waiter)
767 waiter_remove(handler->timeout_waiter);
769 handler->timeout_waiter = NULL;
770 handler->autoboot_enabled = false;
772 /* we only send status if we had a default boot option queued */
773 if (!handler->default_boot_option)
776 pb_log("Cancelling default boot option\n");
778 if (handler->pending_boot && handler->pending_boot_is_default) {
779 boot_cancel(handler->pending_boot);
780 handler->pending_boot = NULL;
781 handler->pending_boot_is_default = false;
784 handler->default_boot_option = NULL;
786 status.type = BOOT_STATUS_INFO;
787 status.progress = -1;
788 status.detail = NULL;
789 status.message = "Default boot cancelled";
791 discover_server_notify_boot_status(handler->server, &status);
794 void device_handler_update_config(struct device_handler *handler,
795 struct config *config)
798 discover_server_notify_config(handler->server, config);
799 device_handler_reinit(handler);
802 #ifndef PETITBOOT_TEST
804 static int device_handler_init_sources(struct device_handler *handler)
806 /* init our device sources: udev, network and user events */
807 handler->udev = udev_init(handler, handler->waitset);
811 handler->network = network_init(handler, handler->waitset,
813 if (!handler->network)
816 handler->user_event = user_event_init(handler, handler->waitset);
817 if (!handler->user_event)
823 static void device_handler_reinit_sources(struct device_handler *handler)
825 udev_reinit(handler->udev);
827 network_shutdown(handler->network);
828 handler->network = network_init(handler, handler->waitset,
832 static bool check_existing_mount(struct discover_device *dev)
834 struct stat devstat, mntstat;
839 rc = stat(dev->device_path, &devstat);
841 pb_debug("%s: stat failed: %s\n", __func__, strerror(errno));
845 if (!S_ISBLK(devstat.st_mode)) {
846 pb_debug("%s: %s isn't a block device?\n", __func__,
851 fp = fopen("/proc/self/mounts", "r");
858 if (!mnt->mnt_fsname || mnt->mnt_fsname[0] != '/')
861 rc = stat(mnt->mnt_fsname, &mntstat);
865 if (!S_ISBLK(mntstat.st_mode))
868 if (mntstat.st_rdev == devstat.st_rdev) {
869 dev->mount_path = talloc_strdup(dev, mnt->mnt_dir);
870 dev->mounted_rw = !!hasmntopt(mnt, "rw");
872 dev->unmount = false;
874 pb_debug("%s: %s is already mounted (r%c) at %s\n",
875 __func__, dev->device_path,
876 dev->mounted_rw ? 'w' : 'o',
887 static int mount_device(struct discover_device *dev)
892 if (!dev->device_path)
898 if (check_existing_mount(dev))
901 fstype = discover_device_get_param(dev, "ID_FS_TYPE");
905 dev->mount_path = join_paths(dev, mount_base(),
908 if (pb_mkdir_recursive(dev->mount_path)) {
909 pb_log("couldn't create mount directory %s: %s\n",
910 dev->mount_path, strerror(errno));
914 pb_log("mounting device %s read-only\n", dev->device_path);
916 rc = mount(dev->device_path, dev->mount_path, fstype,
917 MS_RDONLY | MS_SILENT, "");
920 dev->mounted_rw = false;
925 pb_log("couldn't mount device %s: mount failed: %s\n",
926 dev->device_path, strerror(errno));
928 pb_rmdir_recursive(mount_base(), dev->mount_path);
930 talloc_free(dev->mount_path);
931 dev->mount_path = NULL;
935 static int umount_device(struct discover_device *dev)
939 if (!dev->mounted || !dev->unmount)
942 pb_log("unmounting device %s\n", dev->device_path);
943 rc = umount(dev->mount_path);
947 dev->mounted = false;
949 pb_rmdir_recursive(mount_base(), dev->mount_path);
951 talloc_free(dev->mount_path);
952 dev->mount_path = NULL;
957 int device_request_write(struct discover_device *dev, bool *release)
969 pb_log("remounting device %s read-write\n", dev->device_path);
970 rc = mount(dev->device_path, dev->mount_path, "",
971 MS_REMOUNT | MS_SILENT, "");
975 dev->mounted_rw = true;
980 void device_release_write(struct discover_device *dev, bool release)
985 pb_log("remounting device %s read-only\n", dev->device_path);
986 mount(dev->device_path, dev->mount_path, "",
987 MS_REMOUNT | MS_RDONLY | MS_SILENT, "");
988 dev->mounted_rw = false;
993 static int device_handler_init_sources(
994 struct device_handler *handler __attribute__((unused)))
999 static void device_handler_reinit_sources(
1000 struct device_handler *handler __attribute__((unused)))
1004 static int umount_device(struct discover_device *dev __attribute__((unused)))
1009 static int __attribute__((unused)) mount_device(
1010 struct discover_device *dev __attribute__((unused)))
1015 int device_request_write(struct discover_device *dev __attribute__((unused)),
1022 void device_release_write(struct discover_device *dev __attribute__((unused)),
1023 bool release __attribute__((unused)))