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 bool device_allows_default(struct discover_device *dev)
448 dev_str = config_get()->boot_device;
450 if (!dev_str || !strlen(dev_str))
453 /* default devices are specified by UUIDs at present */
454 if (strcmp(dev->uuid, dev_str))
460 static void set_default(struct device_handler *handler,
461 struct discover_boot_option *opt)
465 if (!handler->autoboot_enabled)
468 /* do we allow default-booting from this device? */
469 if (!device_allows_default(opt->device))
472 new_prio = default_option_priority(opt);
474 /* A negative priority indicates that we don't want to boot this device
479 /* Resolve any conflicts: if we have a new default option, it only
480 * replaces the current if it has a higher priority. */
481 if (handler->default_boot_option) {
484 cur_prio = default_option_priority(
485 handler->default_boot_option);
487 if (new_prio > cur_prio) {
488 handler->default_boot_option = opt;
489 /* extend the timeout a little, so the user sees some
490 * indication of the change */
491 handler->sec_to_boot += 2;
497 handler->sec_to_boot = config_get()->autoboot_timeout_sec;
498 handler->default_boot_option = opt;
500 pb_log("Boot option %s set as default, timeout %u sec.\n",
501 opt->option->id, handler->sec_to_boot);
503 default_timeout(handler);
506 static bool resource_is_resolved(struct resource *res)
508 return !res || res->resolved;
511 /* We only use this in an assert, which will disappear if we're compiling
512 * with NDEBUG, so we need the 'used' attribute for these builds */
513 static bool __attribute__((used)) boot_option_is_resolved(
514 struct discover_boot_option *opt)
516 return resource_is_resolved(opt->boot_image) &&
517 resource_is_resolved(opt->initrd) &&
518 resource_is_resolved(opt->dtb) &&
519 resource_is_resolved(opt->icon);
522 static bool resource_resolve(struct resource *res, const char *name,
523 struct discover_boot_option *opt,
524 struct device_handler *handler)
526 struct parser *parser = opt->source;
528 if (resource_is_resolved(res))
531 pb_debug("Attempting to resolve resource %s->%s with parser %s\n",
532 opt->option->id, name, parser->name);
533 parser->resolve_resource(handler, res);
535 return res->resolved;
538 static bool boot_option_resolve(struct discover_boot_option *opt,
539 struct device_handler *handler)
541 return resource_resolve(opt->boot_image, "boot_image", opt, handler) &&
542 resource_resolve(opt->initrd, "initrd", opt, handler) &&
543 resource_resolve(opt->dtb, "dtb", opt, handler) &&
544 resource_resolve(opt->icon, "icon", opt, handler);
547 static void boot_option_finalise(struct device_handler *handler,
548 struct discover_boot_option *opt)
550 assert(boot_option_is_resolved(opt));
552 /* check that the parsers haven't set any of the final data */
553 assert(!opt->option->boot_image_file);
554 assert(!opt->option->initrd_file);
555 assert(!opt->option->dtb_file);
556 assert(!opt->option->icon_file);
557 assert(!opt->option->device_id);
560 opt->option->boot_image_file = opt->boot_image->url->full;
562 opt->option->initrd_file = opt->initrd->url->full;
564 opt->option->dtb_file = opt->dtb->url->full;
566 opt->option->icon_file = opt->icon->url->full;
568 opt->option->device_id = opt->device->device->id;
570 if (opt->option->is_default)
571 set_default(handler, opt);
574 static void notify_boot_option(struct device_handler *handler,
575 struct discover_boot_option *opt)
577 struct discover_device *dev = opt->device;
580 discover_server_notify_device_add(handler->server,
581 opt->device->device);
582 dev->notified = true;
583 discover_server_notify_boot_option_add(handler->server, opt->option);
586 static void process_boot_option_queue(struct device_handler *handler)
588 struct discover_boot_option *opt, *tmp;
590 list_for_each_entry_safe(&handler->unresolved_boot_options,
593 pb_debug("queue: attempting resolution for %s\n",
596 if (!boot_option_resolve(opt, handler))
599 pb_debug("\tresolved!\n");
601 list_remove(&opt->list);
602 list_add_tail(&opt->device->boot_options, &opt->list);
603 talloc_steal(opt->device, opt);
604 boot_option_finalise(handler, opt);
605 notify_boot_option(handler, opt);
609 struct discover_context *device_handler_discover_context_create(
610 struct device_handler *handler,
611 struct discover_device *device)
613 struct discover_context *ctx;
615 ctx = talloc_zero(handler, struct discover_context);
616 ctx->device = device;
617 list_init(&ctx->boot_options);
623 * context_commit - Commit a temporary discovery context to the handler,
624 * and notify the clients about any new options / devices
626 void device_handler_discover_context_commit(struct device_handler *handler,
627 struct discover_context *ctx)
629 struct discover_device *dev = ctx->device;
630 struct discover_boot_option *opt, *tmp;
632 if (!device_lookup_by_id(handler, dev->device->id))
633 device_handler_add_device(handler, dev);
635 /* move boot options from the context to the device */
636 list_for_each_entry_safe(&ctx->boot_options, opt, tmp, list) {
637 list_remove(&opt->list);
639 if (boot_option_resolve(opt, handler)) {
640 pb_log("boot option %s is resolved, "
641 "sending to clients\n",
643 list_add_tail(&dev->boot_options, &opt->list);
644 talloc_steal(dev, opt);
645 boot_option_finalise(handler, opt);
646 notify_boot_option(handler, opt);
648 if (!opt->source->resolve_resource) {
649 pb_log("parser %s gave us an unresolved "
650 "resource (%s), but no way to "
652 opt->source->name, opt->option->id);
655 pb_log("boot option %s is unresolved, "
658 list_add(&handler->unresolved_boot_options,
660 talloc_steal(handler, opt);
666 void device_handler_add_device(struct device_handler *handler,
667 struct discover_device *device)
669 handler->n_devices++;
670 handler->devices = talloc_realloc(handler, handler->devices,
671 struct discover_device *, handler->n_devices);
672 handler->devices[handler->n_devices - 1] = device;
674 if (device->device->type == DEVICE_TYPE_NETWORK)
675 network_register_device(handler->network, device);
678 /* Start discovery on a hotplugged device. The device will be in our devices
679 * array, but has only just been initialised by the hotplug source.
681 int device_handler_discover(struct device_handler *handler,
682 struct discover_device *dev)
684 struct discover_context *ctx;
687 process_boot_option_queue(handler);
689 /* create our context */
690 ctx = device_handler_discover_context_create(handler, dev);
692 rc = mount_device(dev);
696 /* add this device to our system info */
697 system_info_register_blockdev(dev->device->id, dev->uuid,
700 /* run the parsers. This will populate the ctx's boot_option list. */
701 iterate_parsers(ctx);
703 /* add discovered stuff to the handler */
704 device_handler_discover_context_commit(handler, ctx);
712 /* Incoming dhcp event */
713 int device_handler_dhcp(struct device_handler *handler,
714 struct discover_device *dev, struct event *event)
716 struct discover_context *ctx;
718 /* create our context */
719 ctx = device_handler_discover_context_create(handler, dev);
722 iterate_parsers(ctx);
724 device_handler_discover_context_commit(handler, ctx);
731 /* incoming conf event */
732 int device_handler_conf(struct device_handler *handler,
733 struct discover_device *dev, struct pb_url *url)
735 struct discover_context *ctx;
737 /* create our context */
738 ctx = device_handler_discover_context_create(handler, dev);
741 iterate_parsers(ctx);
743 device_handler_discover_context_commit(handler, ctx);
750 static struct discover_boot_option *find_boot_option_by_id(
751 struct device_handler *handler, const char *id)
755 for (i = 0; i < handler->n_devices; i++) {
756 struct discover_device *dev = handler->devices[i];
757 struct discover_boot_option *opt;
759 list_for_each_entry(&dev->boot_options, opt, list)
760 if (!strcmp(opt->option->id, id))
767 void device_handler_boot(struct device_handler *handler,
768 struct boot_command *cmd)
770 struct discover_boot_option *opt = NULL;
772 if (cmd->option_id && strlen(cmd->option_id))
773 opt = find_boot_option_by_id(handler, cmd->option_id);
775 if (handler->pending_boot)
776 boot_cancel(handler->pending_boot);
777 handler->pending_boot = boot(handler, opt, cmd, handler->dry_run,
778 boot_status, handler);
779 handler->pending_boot_is_default = false;
782 void device_handler_cancel_default(struct device_handler *handler)
784 struct boot_status status;
786 if (handler->timeout_waiter)
787 waiter_remove(handler->timeout_waiter);
789 handler->timeout_waiter = NULL;
790 handler->autoboot_enabled = false;
792 /* we only send status if we had a default boot option queued */
793 if (!handler->default_boot_option)
796 pb_log("Cancelling default boot option\n");
798 if (handler->pending_boot && handler->pending_boot_is_default) {
799 boot_cancel(handler->pending_boot);
800 handler->pending_boot = NULL;
801 handler->pending_boot_is_default = false;
804 handler->default_boot_option = NULL;
806 status.type = BOOT_STATUS_INFO;
807 status.progress = -1;
808 status.detail = NULL;
809 status.message = "Default boot cancelled";
811 discover_server_notify_boot_status(handler->server, &status);
814 void device_handler_update_config(struct device_handler *handler,
815 struct config *config)
818 discover_server_notify_config(handler->server, config);
819 device_handler_reinit(handler);
822 #ifndef PETITBOOT_TEST
824 static int device_handler_init_sources(struct device_handler *handler)
826 /* init our device sources: udev, network and user events */
827 handler->udev = udev_init(handler, handler->waitset);
831 handler->network = network_init(handler, handler->waitset,
833 if (!handler->network)
836 handler->user_event = user_event_init(handler, handler->waitset);
837 if (!handler->user_event)
843 static void device_handler_reinit_sources(struct device_handler *handler)
845 udev_reinit(handler->udev);
847 network_shutdown(handler->network);
848 handler->network = network_init(handler, handler->waitset,
852 static bool check_existing_mount(struct discover_device *dev)
854 struct stat devstat, mntstat;
859 rc = stat(dev->device_path, &devstat);
861 pb_debug("%s: stat failed: %s\n", __func__, strerror(errno));
865 if (!S_ISBLK(devstat.st_mode)) {
866 pb_debug("%s: %s isn't a block device?\n", __func__,
871 fp = fopen("/proc/self/mounts", "r");
878 if (!mnt->mnt_fsname || mnt->mnt_fsname[0] != '/')
881 rc = stat(mnt->mnt_fsname, &mntstat);
885 if (!S_ISBLK(mntstat.st_mode))
888 if (mntstat.st_rdev == devstat.st_rdev) {
889 dev->mount_path = talloc_strdup(dev, mnt->mnt_dir);
890 dev->mounted_rw = !!hasmntopt(mnt, "rw");
892 dev->unmount = false;
894 pb_debug("%s: %s is already mounted (r%c) at %s\n",
895 __func__, dev->device_path,
896 dev->mounted_rw ? 'w' : 'o',
907 static int mount_device(struct discover_device *dev)
912 if (!dev->device_path)
918 if (check_existing_mount(dev))
921 fstype = discover_device_get_param(dev, "ID_FS_TYPE");
925 dev->mount_path = join_paths(dev, mount_base(),
928 if (pb_mkdir_recursive(dev->mount_path)) {
929 pb_log("couldn't create mount directory %s: %s\n",
930 dev->mount_path, strerror(errno));
934 pb_log("mounting device %s read-only\n", dev->device_path);
936 rc = mount(dev->device_path, dev->mount_path, fstype,
937 MS_RDONLY | MS_SILENT, "");
940 dev->mounted_rw = false;
945 pb_log("couldn't mount device %s: mount failed: %s\n",
946 dev->device_path, strerror(errno));
948 pb_rmdir_recursive(mount_base(), dev->mount_path);
950 talloc_free(dev->mount_path);
951 dev->mount_path = NULL;
955 static int umount_device(struct discover_device *dev)
959 if (!dev->mounted || !dev->unmount)
962 pb_log("unmounting device %s\n", dev->device_path);
963 rc = umount(dev->mount_path);
967 dev->mounted = false;
969 pb_rmdir_recursive(mount_base(), dev->mount_path);
971 talloc_free(dev->mount_path);
972 dev->mount_path = NULL;
977 int device_request_write(struct discover_device *dev, bool *release)
989 pb_log("remounting device %s read-write\n", dev->device_path);
990 rc = mount(dev->device_path, dev->mount_path, "",
991 MS_REMOUNT | MS_SILENT, "");
995 dev->mounted_rw = true;
1000 void device_release_write(struct discover_device *dev, bool release)
1005 pb_log("remounting device %s read-only\n", dev->device_path);
1006 mount(dev->device_path, dev->mount_path, "",
1007 MS_REMOUNT | MS_RDONLY | MS_SILENT, "");
1008 dev->mounted_rw = false;
1013 static int device_handler_init_sources(
1014 struct device_handler *handler __attribute__((unused)))
1019 static void device_handler_reinit_sources(
1020 struct device_handler *handler __attribute__((unused)))
1024 static int umount_device(struct discover_device *dev __attribute__((unused)))
1029 static int __attribute__((unused)) mount_device(
1030 struct discover_device *dev __attribute__((unused)))
1035 int device_request_write(struct discover_device *dev __attribute__((unused)),
1042 void device_release_write(struct discover_device *dev __attribute__((unused)),
1043 bool release __attribute__((unused)))