10 #include <pb-config/pb-config.h>
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"
27 struct device_handler {
28 struct discover_server *server;
31 struct discover_device **devices;
32 unsigned int n_devices;
34 struct waitset *waitset;
35 struct waiter *timeout_waiter;
36 bool autoboot_enabled;
37 unsigned int sec_to_boot;
39 struct discover_boot_option *default_boot_option;
40 struct list unresolved_boot_options;
43 static int mount_device(struct discover_device *dev);
44 static int umount_device(struct discover_device *dev);
46 void discover_context_add_boot_option(struct discover_context *ctx,
47 struct discover_boot_option *boot_option)
49 boot_option->source = ctx->parser;
50 list_add_tail(&ctx->boot_options, &boot_option->list);
51 talloc_steal(ctx, boot_option);
55 * device_handler_get_device_count - Get the count of current handler devices.
58 int device_handler_get_device_count(const struct device_handler *handler)
60 return handler->n_devices;
64 * device_handler_get_device - Get a handler device by index.
67 const struct discover_device *device_handler_get_device(
68 const struct device_handler *handler, unsigned int index)
70 if (index >= handler->n_devices) {
71 assert(0 && "bad index");
75 return handler->devices[index];
78 struct discover_boot_option *discover_boot_option_create(
79 struct discover_context *ctx,
80 struct discover_device *device)
82 struct discover_boot_option *opt;
84 opt = talloc_zero(ctx, struct discover_boot_option);
85 opt->option = talloc_zero(opt, struct boot_option);
91 static int device_match_uuid(struct discover_device *dev, const char *uuid)
93 return dev->uuid && !strcmp(dev->uuid, uuid);
96 static int device_match_label(struct discover_device *dev, const char *label)
98 return dev->label && !strcmp(dev->label, label);
101 static int device_match_id(struct discover_device *dev, const char *id)
103 return !strcmp(dev->device->id, id);
106 static struct discover_device *device_lookup(
107 struct device_handler *device_handler,
108 int (match_fn)(struct discover_device *, const char *),
111 struct discover_device *dev;
117 for (i = 0; i < device_handler->n_devices; i++) {
118 dev = device_handler->devices[i];
120 if (match_fn(dev, str))
127 struct discover_device *device_lookup_by_name(struct device_handler *handler,
130 if (!strncmp(name, "/dev/", strlen("/dev/")))
131 name += strlen("/dev/");
133 return device_lookup_by_id(handler, name);
136 struct discover_device *device_lookup_by_uuid(
137 struct device_handler *device_handler,
140 return device_lookup(device_handler, device_match_uuid, uuid);
143 struct discover_device *device_lookup_by_label(
144 struct device_handler *device_handler,
147 return device_lookup(device_handler, device_match_label, label);
150 struct discover_device *device_lookup_by_id(
151 struct device_handler *device_handler,
154 return device_lookup(device_handler, device_match_id, id);
157 void device_handler_destroy(struct device_handler *handler)
159 talloc_free(handler);
162 static int destroy_device(void *arg)
164 struct discover_device *dev = arg;
171 struct discover_device *discover_device_create(struct device_handler *handler,
174 struct discover_device *dev;
176 dev = device_lookup_by_id(handler, id);
180 dev = talloc_zero(handler, struct discover_device);
181 dev->device = talloc_zero(dev, struct device);
182 dev->device->id = talloc_strdup(dev->device, id);
183 list_init(&dev->params);
184 list_init(&dev->boot_options);
186 talloc_set_destructor(dev, destroy_device);
191 struct discover_device_param {
194 struct list_item list;
197 void discover_device_set_param(struct discover_device *device,
198 const char *name, const char *value)
200 struct discover_device_param *param;
203 list_for_each_entry(&device->params, param, list) {
204 if (!strcmp(param->name, name)) {
213 param = talloc(device, struct discover_device_param);
214 param->name = talloc_strdup(param, name);
215 list_add(&device->params, ¶m->list);
218 list_remove(¶m->list);
222 talloc_free(param->value);
225 param->value = talloc_strdup(param, value);
228 const char *discover_device_get_param(struct discover_device *device,
231 struct discover_device_param *param;
233 list_for_each_entry(&device->params, param, list) {
234 if (!strcmp(param->name, name))
240 struct device_handler *device_handler_init(struct discover_server *server,
241 struct waitset *waitset, int dry_run)
243 struct device_handler *handler;
245 handler = talloc_zero(NULL, struct device_handler);
246 handler->server = server;
247 handler->waitset = waitset;
248 handler->dry_run = dry_run;
249 handler->autoboot_enabled = config_get()->autoboot_enabled;
251 list_init(&handler->unresolved_boot_options);
253 /* set up our mount point base */
254 pb_mkdir_recursive(mount_base());
261 void device_handler_remove(struct device_handler *handler,
262 struct discover_device *device)
266 for (i = 0; i < handler->n_devices; i++)
267 if (handler->devices[i] == device)
270 if (i == handler->n_devices) {
275 handler->n_devices--;
276 memmove(&handler->devices[i], &handler->devices[i + 1],
277 (handler->n_devices - i) * sizeof(handler->devices[0]));
278 handler->devices = talloc_realloc(handler, handler->devices,
279 struct discover_device *, handler->n_devices);
281 if (device->notified)
282 discover_server_notify_device_remove(handler->server,
288 static void boot_status(void *arg, struct boot_status *status)
290 struct device_handler *handler = arg;
292 discover_server_notify_boot_status(handler->server, status);
295 static void countdown_status(struct device_handler *handler,
296 struct discover_boot_option *opt, unsigned int sec)
298 struct boot_status status;
300 status.type = BOOT_STATUS_INFO;
301 status.progress = -1;
302 status.detail = NULL;
303 status.message = talloc_asprintf(handler,
304 "Booting %s in %u sec", opt->option->name, sec);
306 discover_server_notify_boot_status(handler->server, &status);
308 talloc_free(status.message);
311 static int default_timeout(void *arg)
313 struct device_handler *handler = arg;
314 struct discover_boot_option *opt;
316 if (!handler->default_boot_option)
319 opt = handler->default_boot_option;
321 if (handler->sec_to_boot) {
322 countdown_status(handler, opt, handler->sec_to_boot);
323 handler->sec_to_boot--;
324 handler->timeout_waiter = waiter_register_timeout(
325 handler->waitset, 1000,
326 default_timeout, handler);
330 pb_log("Timeout expired, booting default option %s\n", opt->option->id);
332 boot(handler, handler->default_boot_option, NULL,
333 handler->dry_run, boot_status, handler);
337 static void set_default(struct device_handler *handler,
338 struct discover_boot_option *opt)
340 if (handler->default_boot_option)
343 if (!handler->autoboot_enabled)
346 handler->default_boot_option = opt;
347 handler->sec_to_boot = config_get()->autoboot_timeout_sec;
349 pb_log("Boot option %s set as default, timeout %u sec.\n",
350 opt->option->id, handler->sec_to_boot);
352 default_timeout(handler);
355 static bool resource_is_resolved(struct resource *res)
357 return !res || res->resolved;
360 /* We only use this in an assert, which will disappear if we're compiling
361 * with NDEBUG, so we need the 'used' attribute for these builds */
362 static bool __attribute__((used)) boot_option_is_resolved(
363 struct discover_boot_option *opt)
365 return resource_is_resolved(opt->boot_image) &&
366 resource_is_resolved(opt->initrd) &&
367 resource_is_resolved(opt->dtb) &&
368 resource_is_resolved(opt->icon);
371 static bool resource_resolve(struct resource *res, const char *name,
372 struct discover_boot_option *opt,
373 struct device_handler *handler)
375 struct parser *parser = opt->source;
377 if (resource_is_resolved(res))
380 pb_log("Attempting to resolve resource %s->%s with parser %s\n",
381 opt->option->id, name, parser->name);
382 parser->resolve_resource(handler, res);
384 return res->resolved;
387 static bool boot_option_resolve(struct discover_boot_option *opt,
388 struct device_handler *handler)
390 return resource_resolve(opt->boot_image, "boot_image", opt, handler) &&
391 resource_resolve(opt->initrd, "initrd", opt, handler) &&
392 resource_resolve(opt->dtb, "dtb", opt, handler) &&
393 resource_resolve(opt->icon, "icon", opt, handler);
396 static void boot_option_finalise(struct device_handler *handler,
397 struct discover_boot_option *opt)
399 assert(boot_option_is_resolved(opt));
401 /* check that the parsers haven't set any of the final data */
402 assert(!opt->option->boot_image_file);
403 assert(!opt->option->initrd_file);
404 assert(!opt->option->dtb_file);
405 assert(!opt->option->icon_file);
406 assert(!opt->option->device_id);
409 opt->option->boot_image_file = opt->boot_image->url->full;
411 opt->option->initrd_file = opt->initrd->url->full;
413 opt->option->dtb_file = opt->dtb->url->full;
415 opt->option->icon_file = opt->icon->url->full;
417 opt->option->device_id = opt->device->device->id;
419 if (opt->option->is_default)
420 set_default(handler, opt);
423 static void notify_boot_option(struct device_handler *handler,
424 struct discover_boot_option *opt)
426 struct discover_device *dev = opt->device;
429 discover_server_notify_device_add(handler->server,
430 opt->device->device);
431 dev->notified = true;
432 discover_server_notify_boot_option_add(handler->server, opt->option);
435 static void process_boot_option_queue(struct device_handler *handler)
437 struct discover_boot_option *opt, *tmp;
439 list_for_each_entry_safe(&handler->unresolved_boot_options,
442 pb_log("queue: attempting resolution for %s\n",
445 if (!boot_option_resolve(opt, handler))
448 pb_log("\tresolved!\n");
450 list_remove(&opt->list);
451 list_add_tail(&opt->device->boot_options, &opt->list);
452 talloc_steal(opt->device, opt);
453 boot_option_finalise(handler, opt);
454 notify_boot_option(handler, opt);
458 struct discover_context *device_handler_discover_context_create(
459 struct device_handler *handler,
460 struct discover_device *device)
462 struct discover_context *ctx;
464 ctx = talloc(handler, struct discover_context);
465 ctx->device = device;
466 ctx->conf_url = NULL;
467 list_init(&ctx->boot_options);
473 * context_commit - Commit a temporary discovery context to the handler,
474 * and notify the clients about any new options / devices
476 void device_handler_discover_context_commit(struct device_handler *handler,
477 struct discover_context *ctx)
479 struct discover_device *dev = ctx->device;
480 struct discover_boot_option *opt, *tmp;
482 if (!device_lookup_by_id(handler, dev->device->id))
483 device_handler_add_device(handler, dev);
485 /* move boot options from the context to the device */
486 list_for_each_entry_safe(&ctx->boot_options, opt, tmp, list) {
487 list_remove(&opt->list);
489 if (boot_option_resolve(opt, handler)) {
490 pb_log("boot option %s is resolved, "
491 "sending to clients\n",
493 list_add_tail(&dev->boot_options, &opt->list);
494 talloc_steal(dev, opt);
495 boot_option_finalise(handler, opt);
496 notify_boot_option(handler, opt);
498 if (!opt->source->resolve_resource) {
499 pb_log("parser %s gave us an unresolved "
500 "resource (%s), but no way to "
502 opt->source->name, opt->option->id);
505 pb_log("boot option %s is unresolved, "
508 list_add(&handler->unresolved_boot_options,
510 talloc_steal(handler, opt);
516 void device_handler_add_device(struct device_handler *handler,
517 struct discover_device *device)
519 handler->n_devices++;
520 handler->devices = talloc_realloc(handler, handler->devices,
521 struct discover_device *, handler->n_devices);
522 handler->devices[handler->n_devices - 1] = device;
526 /* Start discovery on a hotplugged device. The device will be in our devices
527 * array, but has only just been initialised by the hotplug source.
529 int device_handler_discover(struct device_handler *handler,
530 struct discover_device *dev, enum conf_method method)
532 struct discover_context *ctx;
534 process_boot_option_queue(handler);
536 /* create our context */
537 ctx = device_handler_discover_context_create(handler, dev);
541 /* run the parsers. This will populate the ctx's boot_option list. */
542 iterate_parsers(ctx, method);
544 /* add discovered stuff to the handler */
545 device_handler_discover_context_commit(handler, ctx);
552 /* incoming conf event */
553 int device_handler_conf(struct device_handler *handler,
554 struct discover_device *dev, struct pb_url *url,
555 enum conf_method method)
557 struct discover_context *ctx;
559 /* create our context */
560 ctx = device_handler_discover_context_create(handler, dev);
563 iterate_parsers(ctx, method);
565 device_handler_discover_context_commit(handler, ctx);
572 static struct discover_boot_option *find_boot_option_by_id(
573 struct device_handler *handler, const char *id)
577 for (i = 0; i < handler->n_devices; i++) {
578 struct discover_device *dev = handler->devices[i];
579 struct discover_boot_option *opt;
581 list_for_each_entry(&dev->boot_options, opt, list)
582 if (!strcmp(opt->option->id, id))
589 void device_handler_boot(struct device_handler *handler,
590 struct boot_command *cmd)
592 struct discover_boot_option *opt;
594 opt = find_boot_option_by_id(handler, cmd->option_id);
596 boot(handler, opt, cmd, handler->dry_run, boot_status, handler);
599 void device_handler_cancel_default(struct device_handler *handler)
601 struct boot_status status;
603 if (handler->timeout_waiter)
604 waiter_remove(handler->timeout_waiter);
606 handler->timeout_waiter = NULL;
607 handler->autoboot_enabled = false;
609 /* we only send status if we had a default boot option queued */
610 if (!handler->default_boot_option)
613 pb_log("Cancelling default boot option\n");
615 handler->default_boot_option = NULL;
617 status.type = BOOT_STATUS_INFO;
618 status.progress = -1;
619 status.detail = NULL;
620 status.message = "Default boot cancelled";
622 discover_server_notify_boot_status(handler->server, &status);
625 #ifndef PETITBOOT_TEST
626 static int mount_device(struct discover_device *dev)
630 if (!dev->device_path)
633 if (!dev->mount_path)
634 dev->mount_path = join_paths(dev, mount_base(),
637 if (pb_mkdir_recursive(dev->mount_path))
638 pb_log("couldn't create mount directory %s: %s\n",
639 dev->mount_path, strerror(errno));
641 rc = process_run_simple(dev, pb_system_apps.mount,
642 dev->device_path, dev->mount_path,
648 /* Retry mount without ro option. */
649 rc = process_run_simple(dev, pb_system_apps.mount,
650 dev->device_path, dev->mount_path, NULL);
655 pb_rmdir_recursive(mount_base(), dev->mount_path);
659 static int umount_device(struct discover_device *dev)
663 if (!dev->mount_path)
666 status = process_run_simple(dev, pb_system_apps.umount,
667 dev->mount_path, NULL);
669 if (!WIFEXITED(status) || WEXITSTATUS(status) != 0)
672 pb_rmdir_recursive(mount_base(), dev->mount_path);
678 static int umount_device(struct discover_device *dev __attribute__((unused)))
683 static int __attribute__((unused)) mount_device(
684 struct discover_device *dev __attribute__((unused)))