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 ||
376 prio->type == DEVICE_TYPE_ANY;
379 static int default_option_priority(struct discover_boot_option *opt)
381 const struct config *config;
382 struct boot_priority *prio;
385 config = config_get();
387 for (i = 0; i < config->n_boot_priorities; i++) {
388 prio = &config->boot_priorities[i];
389 if (priority_match(prio, opt))
390 return prio->priority;
396 static void set_default(struct device_handler *handler,
397 struct discover_boot_option *opt)
401 if (!handler->autoboot_enabled)
404 new_prio = default_option_priority(opt);
406 /* A negative priority indicates that we don't want to boot this device
411 /* Resolve any conflicts: if we have a new default option, it only
412 * replaces the current if it has a higher priority. */
413 if (handler->default_boot_option) {
416 cur_prio = default_option_priority(
417 handler->default_boot_option);
419 if (new_prio > cur_prio) {
420 handler->default_boot_option = opt;
421 /* extend the timeout a little, so the user sees some
422 * indication of the change */
423 handler->sec_to_boot += 2;
429 handler->sec_to_boot = config_get()->autoboot_timeout_sec;
430 handler->default_boot_option = opt;
432 pb_log("Boot option %s set as default, timeout %u sec.\n",
433 opt->option->id, handler->sec_to_boot);
435 default_timeout(handler);
438 static bool resource_is_resolved(struct resource *res)
440 return !res || res->resolved;
443 /* We only use this in an assert, which will disappear if we're compiling
444 * with NDEBUG, so we need the 'used' attribute for these builds */
445 static bool __attribute__((used)) boot_option_is_resolved(
446 struct discover_boot_option *opt)
448 return resource_is_resolved(opt->boot_image) &&
449 resource_is_resolved(opt->initrd) &&
450 resource_is_resolved(opt->dtb) &&
451 resource_is_resolved(opt->icon);
454 static bool resource_resolve(struct resource *res, const char *name,
455 struct discover_boot_option *opt,
456 struct device_handler *handler)
458 struct parser *parser = opt->source;
460 if (resource_is_resolved(res))
463 pb_debug("Attempting to resolve resource %s->%s with parser %s\n",
464 opt->option->id, name, parser->name);
465 parser->resolve_resource(handler, res);
467 return res->resolved;
470 static bool boot_option_resolve(struct discover_boot_option *opt,
471 struct device_handler *handler)
473 return resource_resolve(opt->boot_image, "boot_image", opt, handler) &&
474 resource_resolve(opt->initrd, "initrd", opt, handler) &&
475 resource_resolve(opt->dtb, "dtb", opt, handler) &&
476 resource_resolve(opt->icon, "icon", opt, handler);
479 static void boot_option_finalise(struct device_handler *handler,
480 struct discover_boot_option *opt)
482 assert(boot_option_is_resolved(opt));
484 /* check that the parsers haven't set any of the final data */
485 assert(!opt->option->boot_image_file);
486 assert(!opt->option->initrd_file);
487 assert(!opt->option->dtb_file);
488 assert(!opt->option->icon_file);
489 assert(!opt->option->device_id);
492 opt->option->boot_image_file = opt->boot_image->url->full;
494 opt->option->initrd_file = opt->initrd->url->full;
496 opt->option->dtb_file = opt->dtb->url->full;
498 opt->option->icon_file = opt->icon->url->full;
500 opt->option->device_id = opt->device->device->id;
502 if (opt->option->is_default)
503 set_default(handler, opt);
506 static void notify_boot_option(struct device_handler *handler,
507 struct discover_boot_option *opt)
509 struct discover_device *dev = opt->device;
512 discover_server_notify_device_add(handler->server,
513 opt->device->device);
514 dev->notified = true;
515 discover_server_notify_boot_option_add(handler->server, opt->option);
518 static void process_boot_option_queue(struct device_handler *handler)
520 struct discover_boot_option *opt, *tmp;
522 list_for_each_entry_safe(&handler->unresolved_boot_options,
525 pb_debug("queue: attempting resolution for %s\n",
528 if (!boot_option_resolve(opt, handler))
531 pb_debug("\tresolved!\n");
533 list_remove(&opt->list);
534 list_add_tail(&opt->device->boot_options, &opt->list);
535 talloc_steal(opt->device, opt);
536 boot_option_finalise(handler, opt);
537 notify_boot_option(handler, opt);
541 struct discover_context *device_handler_discover_context_create(
542 struct device_handler *handler,
543 struct discover_device *device)
545 struct discover_context *ctx;
547 ctx = talloc_zero(handler, struct discover_context);
548 ctx->device = device;
549 list_init(&ctx->boot_options);
555 * context_commit - Commit a temporary discovery context to the handler,
556 * and notify the clients about any new options / devices
558 void device_handler_discover_context_commit(struct device_handler *handler,
559 struct discover_context *ctx)
561 struct discover_device *dev = ctx->device;
562 struct discover_boot_option *opt, *tmp;
564 if (!device_lookup_by_id(handler, dev->device->id))
565 device_handler_add_device(handler, dev);
567 /* move boot options from the context to the device */
568 list_for_each_entry_safe(&ctx->boot_options, opt, tmp, list) {
569 list_remove(&opt->list);
571 if (boot_option_resolve(opt, handler)) {
572 pb_log("boot option %s is resolved, "
573 "sending to clients\n",
575 list_add_tail(&dev->boot_options, &opt->list);
576 talloc_steal(dev, opt);
577 boot_option_finalise(handler, opt);
578 notify_boot_option(handler, opt);
580 if (!opt->source->resolve_resource) {
581 pb_log("parser %s gave us an unresolved "
582 "resource (%s), but no way to "
584 opt->source->name, opt->option->id);
587 pb_log("boot option %s is unresolved, "
590 list_add(&handler->unresolved_boot_options,
592 talloc_steal(handler, opt);
598 void device_handler_add_device(struct device_handler *handler,
599 struct discover_device *device)
601 handler->n_devices++;
602 handler->devices = talloc_realloc(handler, handler->devices,
603 struct discover_device *, handler->n_devices);
604 handler->devices[handler->n_devices - 1] = device;
608 /* Start discovery on a hotplugged device. The device will be in our devices
609 * array, but has only just been initialised by the hotplug source.
611 int device_handler_discover(struct device_handler *handler,
612 struct discover_device *dev)
614 struct discover_context *ctx;
617 process_boot_option_queue(handler);
619 /* create our context */
620 ctx = device_handler_discover_context_create(handler, dev);
622 rc = mount_device(dev);
626 /* add this device to our system info */
627 system_info_register_blockdev(dev->device->id, dev->uuid,
630 /* run the parsers. This will populate the ctx's boot_option list. */
631 iterate_parsers(ctx);
633 /* add discovered stuff to the handler */
634 device_handler_discover_context_commit(handler, ctx);
642 /* Incoming dhcp event */
643 int device_handler_dhcp(struct device_handler *handler,
644 struct discover_device *dev, struct event *event)
646 struct discover_context *ctx;
648 /* create our context */
649 ctx = device_handler_discover_context_create(handler, dev);
652 iterate_parsers(ctx);
654 device_handler_discover_context_commit(handler, ctx);
661 /* incoming conf event */
662 int device_handler_conf(struct device_handler *handler,
663 struct discover_device *dev, struct pb_url *url)
665 struct discover_context *ctx;
667 /* create our context */
668 ctx = device_handler_discover_context_create(handler, dev);
671 iterate_parsers(ctx);
673 device_handler_discover_context_commit(handler, ctx);
680 static struct discover_boot_option *find_boot_option_by_id(
681 struct device_handler *handler, const char *id)
685 for (i = 0; i < handler->n_devices; i++) {
686 struct discover_device *dev = handler->devices[i];
687 struct discover_boot_option *opt;
689 list_for_each_entry(&dev->boot_options, opt, list)
690 if (!strcmp(opt->option->id, id))
697 void device_handler_boot(struct device_handler *handler,
698 struct boot_command *cmd)
700 struct discover_boot_option *opt = NULL;
702 if (cmd->option_id && strlen(cmd->option_id))
703 opt = find_boot_option_by_id(handler, cmd->option_id);
705 if (handler->pending_boot)
706 boot_cancel(handler->pending_boot);
707 handler->pending_boot = boot(handler, opt, cmd, handler->dry_run,
708 boot_status, handler);
709 handler->pending_boot_is_default = false;
712 void device_handler_cancel_default(struct device_handler *handler)
714 struct boot_status status;
716 if (handler->timeout_waiter)
717 waiter_remove(handler->timeout_waiter);
719 handler->timeout_waiter = NULL;
720 handler->autoboot_enabled = false;
722 /* we only send status if we had a default boot option queued */
723 if (!handler->default_boot_option)
726 pb_log("Cancelling default boot option\n");
728 if (handler->pending_boot && handler->pending_boot_is_default) {
729 boot_cancel(handler->pending_boot);
730 handler->pending_boot = NULL;
731 handler->pending_boot_is_default = false;
734 handler->default_boot_option = NULL;
736 status.type = BOOT_STATUS_INFO;
737 status.progress = -1;
738 status.detail = NULL;
739 status.message = "Default boot cancelled";
741 discover_server_notify_boot_status(handler->server, &status);
744 void device_handler_update_config(struct device_handler *handler,
745 struct config *config)
748 discover_server_notify_config(handler->server, config);
751 #ifndef PETITBOOT_TEST
752 static bool check_existing_mount(struct discover_device *dev)
754 struct stat devstat, mntstat;
759 rc = stat(dev->device_path, &devstat);
761 pb_debug("%s: stat failed: %s\n", __func__, strerror(errno));
765 if (!S_ISBLK(devstat.st_mode)) {
766 pb_debug("%s: %s isn't a block device?\n", __func__,
771 fp = fopen("/proc/self/mounts", "r");
778 if (!mnt->mnt_fsname || mnt->mnt_fsname[0] != '/')
781 rc = stat(mnt->mnt_fsname, &mntstat);
785 if (!S_ISBLK(mntstat.st_mode))
788 if (mntstat.st_rdev == devstat.st_rdev) {
789 dev->mount_path = talloc_strdup(dev, mnt->mnt_dir);
790 dev->mounted_rw = !!hasmntopt(mnt, "rw");
792 dev->unmount = false;
794 pb_debug("%s: %s is already mounted (r%c) at %s\n",
795 __func__, dev->device_path,
796 dev->mounted_rw ? 'w' : 'o',
807 static int mount_device(struct discover_device *dev)
811 if (!dev->device_path)
817 if (check_existing_mount(dev))
820 dev->mount_path = join_paths(dev, mount_base(),
823 if (pb_mkdir_recursive(dev->mount_path)) {
824 pb_log("couldn't create mount directory %s: %s\n",
825 dev->mount_path, strerror(errno));
829 rc = process_run_simple(dev, pb_system_apps.mount,
830 dev->device_path, dev->mount_path,
834 dev->mounted_rw = false;
839 pb_log("couldn't mount device %s: mount failed with rc %d\n",
840 dev->device_path, rc);
842 pb_rmdir_recursive(mount_base(), dev->mount_path);
844 talloc_free(dev->mount_path);
845 dev->mount_path = NULL;
849 static int umount_device(struct discover_device *dev)
853 if (!dev->mounted || !dev->unmount)
856 status = process_run_simple(dev, pb_system_apps.umount,
857 dev->mount_path, NULL);
859 if (!WIFEXITED(status) || WEXITSTATUS(status) != 0)
862 dev->mounted = false;
864 pb_rmdir_recursive(mount_base(), dev->mount_path);
866 talloc_free(dev->mount_path);
867 dev->mount_path = NULL;
872 int device_request_write(struct discover_device *dev, bool *release)
884 rc = process_run_simple(dev, pb_system_apps.mount, dev->mount_path,
885 "-o", "remount,rw", NULL);
889 dev->mounted_rw = true;
894 void device_release_write(struct discover_device *dev, bool release)
899 process_run_simple(dev, pb_system_apps.mount, dev->mount_path,
900 "-o", "remount,ro", NULL);
901 dev->mounted_rw = false;
906 static int umount_device(struct discover_device *dev __attribute__((unused)))
911 static int __attribute__((unused)) mount_device(
912 struct discover_device *dev __attribute__((unused)))
917 int device_request_write(struct discover_device *dev __attribute__((unused)),
924 void device_release_write(struct discover_device *dev __attribute__((unused)),
925 bool release __attribute__((unused)))