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 handler->n_devices--;
348 memmove(&handler->devices[i], &handler->devices[i + 1],
349 (handler->n_devices - i) * sizeof(handler->devices[0]));
350 handler->devices = talloc_realloc(handler, handler->devices,
351 struct discover_device *, handler->n_devices);
353 if (device->notified)
354 discover_server_notify_device_remove(handler->server,
360 static void boot_status(void *arg, struct boot_status *status)
362 struct device_handler *handler = arg;
364 discover_server_notify_boot_status(handler->server, status);
367 static void countdown_status(struct device_handler *handler,
368 struct discover_boot_option *opt, unsigned int sec)
370 struct boot_status status;
372 status.type = BOOT_STATUS_INFO;
373 status.progress = -1;
374 status.detail = NULL;
375 status.message = talloc_asprintf(handler,
376 "Booting %s in %u sec", opt->option->name, sec);
378 discover_server_notify_boot_status(handler->server, &status);
380 talloc_free(status.message);
383 static int default_timeout(void *arg)
385 struct device_handler *handler = arg;
386 struct discover_boot_option *opt;
388 if (!handler->default_boot_option)
391 if (handler->pending_boot)
394 opt = handler->default_boot_option;
396 if (handler->sec_to_boot) {
397 countdown_status(handler, opt, handler->sec_to_boot);
398 handler->sec_to_boot--;
399 handler->timeout_waiter = waiter_register_timeout(
400 handler->waitset, 1000,
401 default_timeout, handler);
405 handler->timeout_waiter = NULL;
407 pb_log("Timeout expired, booting default option %s\n", opt->option->id);
409 handler->pending_boot = boot(handler, handler->default_boot_option,
410 NULL, handler->dry_run, boot_status, handler);
411 handler->pending_boot_is_default = true;
415 static bool priority_match(struct boot_priority *prio,
416 struct discover_boot_option *opt)
418 return prio->type == opt->device->device->type ||
419 prio->type == DEVICE_TYPE_ANY;
422 static int default_option_priority(struct discover_boot_option *opt)
424 const struct config *config;
425 struct boot_priority *prio;
428 config = config_get();
430 for (i = 0; i < config->n_boot_priorities; i++) {
431 prio = &config->boot_priorities[i];
432 if (priority_match(prio, opt))
433 return prio->priority;
439 static void set_default(struct device_handler *handler,
440 struct discover_boot_option *opt)
444 if (!handler->autoboot_enabled)
447 new_prio = default_option_priority(opt);
449 /* A negative priority indicates that we don't want to boot this device
454 /* Resolve any conflicts: if we have a new default option, it only
455 * replaces the current if it has a higher priority. */
456 if (handler->default_boot_option) {
459 cur_prio = default_option_priority(
460 handler->default_boot_option);
462 if (new_prio > cur_prio) {
463 handler->default_boot_option = opt;
464 /* extend the timeout a little, so the user sees some
465 * indication of the change */
466 handler->sec_to_boot += 2;
472 handler->sec_to_boot = config_get()->autoboot_timeout_sec;
473 handler->default_boot_option = opt;
475 pb_log("Boot option %s set as default, timeout %u sec.\n",
476 opt->option->id, handler->sec_to_boot);
478 default_timeout(handler);
481 static bool resource_is_resolved(struct resource *res)
483 return !res || res->resolved;
486 /* We only use this in an assert, which will disappear if we're compiling
487 * with NDEBUG, so we need the 'used' attribute for these builds */
488 static bool __attribute__((used)) boot_option_is_resolved(
489 struct discover_boot_option *opt)
491 return resource_is_resolved(opt->boot_image) &&
492 resource_is_resolved(opt->initrd) &&
493 resource_is_resolved(opt->dtb) &&
494 resource_is_resolved(opt->icon);
497 static bool resource_resolve(struct resource *res, const char *name,
498 struct discover_boot_option *opt,
499 struct device_handler *handler)
501 struct parser *parser = opt->source;
503 if (resource_is_resolved(res))
506 pb_debug("Attempting to resolve resource %s->%s with parser %s\n",
507 opt->option->id, name, parser->name);
508 parser->resolve_resource(handler, res);
510 return res->resolved;
513 static bool boot_option_resolve(struct discover_boot_option *opt,
514 struct device_handler *handler)
516 return resource_resolve(opt->boot_image, "boot_image", opt, handler) &&
517 resource_resolve(opt->initrd, "initrd", opt, handler) &&
518 resource_resolve(opt->dtb, "dtb", opt, handler) &&
519 resource_resolve(opt->icon, "icon", opt, handler);
522 static void boot_option_finalise(struct device_handler *handler,
523 struct discover_boot_option *opt)
525 assert(boot_option_is_resolved(opt));
527 /* check that the parsers haven't set any of the final data */
528 assert(!opt->option->boot_image_file);
529 assert(!opt->option->initrd_file);
530 assert(!opt->option->dtb_file);
531 assert(!opt->option->icon_file);
532 assert(!opt->option->device_id);
535 opt->option->boot_image_file = opt->boot_image->url->full;
537 opt->option->initrd_file = opt->initrd->url->full;
539 opt->option->dtb_file = opt->dtb->url->full;
541 opt->option->icon_file = opt->icon->url->full;
543 opt->option->device_id = opt->device->device->id;
545 if (opt->option->is_default)
546 set_default(handler, opt);
549 static void notify_boot_option(struct device_handler *handler,
550 struct discover_boot_option *opt)
552 struct discover_device *dev = opt->device;
555 discover_server_notify_device_add(handler->server,
556 opt->device->device);
557 dev->notified = true;
558 discover_server_notify_boot_option_add(handler->server, opt->option);
561 static void process_boot_option_queue(struct device_handler *handler)
563 struct discover_boot_option *opt, *tmp;
565 list_for_each_entry_safe(&handler->unresolved_boot_options,
568 pb_debug("queue: attempting resolution for %s\n",
571 if (!boot_option_resolve(opt, handler))
574 pb_debug("\tresolved!\n");
576 list_remove(&opt->list);
577 list_add_tail(&opt->device->boot_options, &opt->list);
578 talloc_steal(opt->device, opt);
579 boot_option_finalise(handler, opt);
580 notify_boot_option(handler, opt);
584 struct discover_context *device_handler_discover_context_create(
585 struct device_handler *handler,
586 struct discover_device *device)
588 struct discover_context *ctx;
590 ctx = talloc_zero(handler, struct discover_context);
591 ctx->device = device;
592 list_init(&ctx->boot_options);
598 * context_commit - Commit a temporary discovery context to the handler,
599 * and notify the clients about any new options / devices
601 void device_handler_discover_context_commit(struct device_handler *handler,
602 struct discover_context *ctx)
604 struct discover_device *dev = ctx->device;
605 struct discover_boot_option *opt, *tmp;
607 if (!device_lookup_by_id(handler, dev->device->id))
608 device_handler_add_device(handler, dev);
610 /* move boot options from the context to the device */
611 list_for_each_entry_safe(&ctx->boot_options, opt, tmp, list) {
612 list_remove(&opt->list);
614 if (boot_option_resolve(opt, handler)) {
615 pb_log("boot option %s is resolved, "
616 "sending to clients\n",
618 list_add_tail(&dev->boot_options, &opt->list);
619 talloc_steal(dev, opt);
620 boot_option_finalise(handler, opt);
621 notify_boot_option(handler, opt);
623 if (!opt->source->resolve_resource) {
624 pb_log("parser %s gave us an unresolved "
625 "resource (%s), but no way to "
627 opt->source->name, opt->option->id);
630 pb_log("boot option %s is unresolved, "
633 list_add(&handler->unresolved_boot_options,
635 talloc_steal(handler, opt);
641 void device_handler_add_device(struct device_handler *handler,
642 struct discover_device *device)
644 handler->n_devices++;
645 handler->devices = talloc_realloc(handler, handler->devices,
646 struct discover_device *, handler->n_devices);
647 handler->devices[handler->n_devices - 1] = device;
651 /* Start discovery on a hotplugged device. The device will be in our devices
652 * array, but has only just been initialised by the hotplug source.
654 int device_handler_discover(struct device_handler *handler,
655 struct discover_device *dev)
657 struct discover_context *ctx;
660 process_boot_option_queue(handler);
662 /* create our context */
663 ctx = device_handler_discover_context_create(handler, dev);
665 rc = mount_device(dev);
669 /* add this device to our system info */
670 system_info_register_blockdev(dev->device->id, dev->uuid,
673 /* run the parsers. This will populate the ctx's boot_option list. */
674 iterate_parsers(ctx);
676 /* add discovered stuff to the handler */
677 device_handler_discover_context_commit(handler, ctx);
685 /* Incoming dhcp event */
686 int device_handler_dhcp(struct device_handler *handler,
687 struct discover_device *dev, struct event *event)
689 struct discover_context *ctx;
691 /* create our context */
692 ctx = device_handler_discover_context_create(handler, dev);
695 iterate_parsers(ctx);
697 device_handler_discover_context_commit(handler, ctx);
704 /* incoming conf event */
705 int device_handler_conf(struct device_handler *handler,
706 struct discover_device *dev, struct pb_url *url)
708 struct discover_context *ctx;
710 /* create our context */
711 ctx = device_handler_discover_context_create(handler, dev);
714 iterate_parsers(ctx);
716 device_handler_discover_context_commit(handler, ctx);
723 static struct discover_boot_option *find_boot_option_by_id(
724 struct device_handler *handler, const char *id)
728 for (i = 0; i < handler->n_devices; i++) {
729 struct discover_device *dev = handler->devices[i];
730 struct discover_boot_option *opt;
732 list_for_each_entry(&dev->boot_options, opt, list)
733 if (!strcmp(opt->option->id, id))
740 void device_handler_boot(struct device_handler *handler,
741 struct boot_command *cmd)
743 struct discover_boot_option *opt = NULL;
745 if (cmd->option_id && strlen(cmd->option_id))
746 opt = find_boot_option_by_id(handler, cmd->option_id);
748 if (handler->pending_boot)
749 boot_cancel(handler->pending_boot);
750 handler->pending_boot = boot(handler, opt, cmd, handler->dry_run,
751 boot_status, handler);
752 handler->pending_boot_is_default = false;
755 void device_handler_cancel_default(struct device_handler *handler)
757 struct boot_status status;
759 if (handler->timeout_waiter)
760 waiter_remove(handler->timeout_waiter);
762 handler->timeout_waiter = NULL;
763 handler->autoboot_enabled = false;
765 /* we only send status if we had a default boot option queued */
766 if (!handler->default_boot_option)
769 pb_log("Cancelling default boot option\n");
771 if (handler->pending_boot && handler->pending_boot_is_default) {
772 boot_cancel(handler->pending_boot);
773 handler->pending_boot = NULL;
774 handler->pending_boot_is_default = false;
777 handler->default_boot_option = NULL;
779 status.type = BOOT_STATUS_INFO;
780 status.progress = -1;
781 status.detail = NULL;
782 status.message = "Default boot cancelled";
784 discover_server_notify_boot_status(handler->server, &status);
787 void device_handler_update_config(struct device_handler *handler,
788 struct config *config)
791 discover_server_notify_config(handler->server, config);
792 device_handler_reinit(handler);
795 #ifndef PETITBOOT_TEST
797 static int device_handler_init_sources(struct device_handler *handler)
799 /* init our device sources: udev, network and user events */
800 handler->udev = udev_init(handler, handler->waitset);
804 handler->network = network_init(handler, handler->waitset,
806 if (!handler->network)
809 handler->user_event = user_event_init(handler, handler->waitset);
810 if (!handler->user_event)
816 static void device_handler_reinit_sources(struct device_handler *handler)
818 udev_reinit(handler->udev);
820 network_shutdown(handler->network);
821 handler->network = network_init(handler, handler->waitset,
825 static bool check_existing_mount(struct discover_device *dev)
827 struct stat devstat, mntstat;
832 rc = stat(dev->device_path, &devstat);
834 pb_debug("%s: stat failed: %s\n", __func__, strerror(errno));
838 if (!S_ISBLK(devstat.st_mode)) {
839 pb_debug("%s: %s isn't a block device?\n", __func__,
844 fp = fopen("/proc/self/mounts", "r");
851 if (!mnt->mnt_fsname || mnt->mnt_fsname[0] != '/')
854 rc = stat(mnt->mnt_fsname, &mntstat);
858 if (!S_ISBLK(mntstat.st_mode))
861 if (mntstat.st_rdev == devstat.st_rdev) {
862 dev->mount_path = talloc_strdup(dev, mnt->mnt_dir);
863 dev->mounted_rw = !!hasmntopt(mnt, "rw");
865 dev->unmount = false;
867 pb_debug("%s: %s is already mounted (r%c) at %s\n",
868 __func__, dev->device_path,
869 dev->mounted_rw ? 'w' : 'o',
880 static int mount_device(struct discover_device *dev)
885 if (!dev->device_path)
891 if (check_existing_mount(dev))
894 fstype = discover_device_get_param(dev, "ID_FS_TYPE");
898 dev->mount_path = join_paths(dev, mount_base(),
901 if (pb_mkdir_recursive(dev->mount_path)) {
902 pb_log("couldn't create mount directory %s: %s\n",
903 dev->mount_path, strerror(errno));
907 pb_log("mounting device %s read-only\n", dev->device_path);
909 rc = mount(dev->device_path, dev->mount_path, fstype,
910 MS_RDONLY | MS_SILENT, "");
913 dev->mounted_rw = false;
918 pb_log("couldn't mount device %s: mount failed: %s\n",
919 dev->device_path, strerror(errno));
921 pb_rmdir_recursive(mount_base(), dev->mount_path);
923 talloc_free(dev->mount_path);
924 dev->mount_path = NULL;
928 static int umount_device(struct discover_device *dev)
932 if (!dev->mounted || !dev->unmount)
935 pb_log("unmounting device %s\n", dev->device_path);
936 rc = umount(dev->mount_path);
940 dev->mounted = false;
942 pb_rmdir_recursive(mount_base(), dev->mount_path);
944 talloc_free(dev->mount_path);
945 dev->mount_path = NULL;
950 int device_request_write(struct discover_device *dev, bool *release)
962 pb_log("remounting device %s read-write\n", dev->device_path);
963 rc = mount(dev->device_path, dev->mount_path, "",
964 MS_REMOUNT | MS_SILENT, "");
968 dev->mounted_rw = true;
973 void device_release_write(struct discover_device *dev, bool release)
978 pb_log("remounting device %s read-only\n", dev->device_path);
979 mount(dev->device_path, dev->mount_path, "",
980 MS_REMOUNT | MS_RDONLY | MS_SILENT, "");
981 dev->mounted_rw = false;
986 static int device_handler_init_sources(
987 struct device_handler *handler __attribute__((unused)))
992 static void device_handler_reinit_sources(
993 struct device_handler *handler __attribute__((unused)))
997 static int umount_device(struct discover_device *dev __attribute__((unused)))
1002 static int __attribute__((unused)) mount_device(
1003 struct discover_device *dev __attribute__((unused)))
1008 int device_request_write(struct discover_device *dev __attribute__((unused)),
1015 void device_release_write(struct discover_device *dev __attribute__((unused)),
1016 bool release __attribute__((unused)))