]> git.ozlabs.org Git - petitboot/blobdiff - discover/device-handler.c
discover: Maintain a backlog of status updates
[petitboot] / discover / device-handler.c
index cd4e3acba1bd0814f378771232a337309d391a2d..48bfa0e237cfd410415d83a265fbbc0bed5a2284 100644 (file)
@@ -46,6 +46,14 @@ enum default_priority {
        DEFAULT_PRIORITY_DISABLED       = 0xff,
 };
 
+struct progress_info {
+       unsigned int                    percentage;
+       unsigned long                   size;           /* size in bytes */
+
+       const struct process_info       *procinfo;
+       struct list_item        list;
+};
+
 struct device_handler {
        struct discover_server  *server;
        int                     dry_run;
@@ -72,6 +80,9 @@ struct device_handler {
 
        struct boot_task        *pending_boot;
        bool                    pending_boot_is_default;
+
+       struct list             progress;
+       unsigned int            n_progress;
 };
 
 static int mount_device(struct discover_device *dev);
@@ -114,6 +125,12 @@ const struct discover_device *device_handler_get_device(
        return handler->devices[index];
 }
 
+struct network *device_handler_get_network(
+               const struct device_handler *handler)
+{
+       return handler->network;
+}
+
 struct discover_boot_option *discover_boot_option_create(
                struct discover_context *ctx,
                struct discover_device *device)
@@ -221,17 +238,22 @@ static int destroy_device(void *arg)
 }
 
 struct discover_device *discover_device_create(struct device_handler *handler,
-               const char *id)
+               const char *uuid, const char *id)
 {
        struct discover_device *dev;
 
-       dev = device_lookup_by_id(handler, id);
+       if (uuid)
+               dev = device_lookup_by_uuid(handler, uuid);
+       else
+               dev = device_lookup_by_id(handler, id);
+
        if (dev)
                return dev;
 
        dev = talloc_zero(handler, struct discover_device);
        dev->device = talloc_zero(dev, struct device);
        dev->device->id = talloc_strdup(dev->device, id);
+       dev->uuid = talloc_strdup(dev, uuid);
        list_init(&dev->params);
        list_init(&dev->boot_options);
 
@@ -303,6 +325,8 @@ struct device_handler *device_handler_init(struct discover_server *server,
 
        list_init(&handler->unresolved_boot_options);
 
+       list_init(&handler->progress);
+
        /* set up our mount point base */
        pb_mkdir_recursive(mount_base());
 
@@ -359,6 +383,15 @@ void device_handler_remove(struct device_handler *handler,
        struct discover_boot_option *opt, *tmp;
        unsigned int i;
 
+       list_for_each_entry_safe(&device->boot_options, opt, tmp, list) {
+               if (opt == handler->default_boot_option) {
+                       pb_log("Default option %s cancelled since device removed",
+                                       opt->option->name);
+                       device_handler_cancel_default(handler);
+                       break;
+               }
+       }
+
        for (i = 0; i < handler->n_devices; i++)
                if (handler->devices[i] == device)
                        break;
@@ -396,25 +429,198 @@ void device_handler_remove(struct device_handler *handler,
        talloc_free(device);
 }
 
-void device_handler_boot_status(void *arg, struct boot_status *status)
+void device_handler_status(struct device_handler *handler,
+               struct status *status)
 {
-       struct device_handler *handler = arg;
-
        discover_server_notify_boot_status(handler->server, status);
 }
 
+static void _device_handler_vstatus(struct device_handler *handler,
+               enum status_type type, const char *fmt, va_list ap)
+{
+       struct status status;
+
+       status.type = type;
+       status.message = talloc_vasprintf(handler, fmt, ap);
+       status.backlog = false;
+
+       device_handler_status(handler, &status);
+
+       talloc_free(status.message);
+}
+
+static void _device_handler_vdevstatus(struct device_handler *handler,
+               struct discover_device *device, enum status_type type,
+               const char *fmt, va_list ap)
+{
+       char *msg;
+
+       msg = talloc_asprintf(handler, "[%s] %s",
+                       device ? device->device->id : "unknown", fmt);
+       _device_handler_vstatus(handler, type, msg, ap);
+       talloc_free(msg);
+}
+
+void device_handler_status_dev_info(struct device_handler *handler,
+               struct discover_device *dev, const char *fmt, ...)
+{
+       va_list ap;
+
+       va_start(ap, fmt);
+       _device_handler_vdevstatus(handler, dev, STATUS_INFO, fmt, ap);
+       va_end(ap);
+}
+
+void device_handler_status_dev_err(struct device_handler *handler,
+               struct discover_device *dev, const char *fmt, ...)
+{
+       va_list ap;
+
+       va_start(ap, fmt);
+       _device_handler_vdevstatus(handler, dev, STATUS_ERROR, fmt, ap);
+       va_end(ap);
+}
+
+void device_handler_status_info(struct device_handler *handler,
+               const char *fmt, ...)
+{
+       va_list ap;
+
+       va_start(ap, fmt);
+       _device_handler_vstatus(handler, STATUS_INFO, fmt, ap);
+       va_end(ap);
+}
+
+void device_handler_status_err(struct device_handler *handler,
+               const char *fmt, ...)
+{
+       va_list ap;
+
+       va_start(ap, fmt);
+       _device_handler_vstatus(handler, STATUS_ERROR, fmt, ap);
+       va_end(ap);
+}
+
+void device_handler_status_download(struct device_handler *handler,
+               const struct process_info *procinfo,
+               unsigned int percentage, unsigned int size, char suffix)
+{
+       struct progress_info *p, *progress = NULL;
+       uint64_t current_converted, current = 0;
+       const char *units = " kMGTP";
+       unsigned long size_bytes;
+       char *update = NULL;
+       double total = 0;
+       unsigned int i;
+       int unit = 0;
+
+       list_for_each_entry(&handler->progress, p, list)
+               if (p->procinfo == procinfo)
+                       progress = p;
+
+       if (!progress) {
+               pb_log("Registering new progress struct\n");
+               progress = talloc_zero(handler, struct progress_info);
+               if (!progress) {
+                       pb_log("Failed to allocate room for progress struct\n");
+                       return;
+               }
+               progress->procinfo = procinfo;
+               list_add(&handler->progress, &progress->list);
+               handler->n_progress++;
+       }
+
+       size_bytes = size;
+       for (i = 0; i < strlen(units); i++) {
+               if (units[i] == suffix)
+                       break;
+       }
+
+       if (i >= strlen(units)) {
+           pb_log("Couldn't recognise suffix '%c'\n", suffix);
+           size_bytes = 0;
+       } else {
+               while (i--)
+                       size_bytes <<= 10;
+       }
+
+       progress->percentage = percentage;
+       progress->size = size_bytes;
+
+       /*
+        * Aggregate the info we have and update status. If a progress struct
+        * has zero for both percentage and size we assume progress information
+        * is unavailable and fall back to a generic progress message.
+        */
+       list_for_each_entry(&handler->progress, p, list) {
+               uint64_t c;
+               double t;
+               if (!p->percentage || !p->size) {
+                       update = talloc_asprintf(handler,
+                                       _("%u downloads in progress..."),
+                                       handler->n_progress);
+                       current = total = 0;
+                       break;
+               }
+
+               c = p->size;
+               t = (100 * c) / p->percentage;
+
+               current += c;
+               total += t;
+       }
+
+       if (total) {
+               current_converted = current;
+               while (current_converted >= 1000) {
+                       current_converted >>= 10;
+                       unit++;
+               }
+               update = talloc_asprintf(handler,
+                               _("%u %s downloading: %.0f%% - %lu%cB"),
+                               handler->n_progress,
+                               ngettext("item", "items", handler->n_progress),
+                               (current / total) * 100, current_converted,
+                               units[unit]);
+       }
+
+       if (!update) {
+               pb_log("%s: failed to allocate new status\n", __func__);
+       } else {
+               device_handler_status_info(handler, "%s\n", update);
+               talloc_free(update);
+       }
+}
+
+void device_handler_status_download_remove(struct device_handler *handler,
+               struct process_info *procinfo)
+{
+       struct progress_info *p, *tmp;
+
+       list_for_each_entry_safe(&handler->progress, p, tmp, list)
+               if (p->procinfo == procinfo) {
+                       list_remove(&p->list);
+                       talloc_free(p);
+                       handler->n_progress--;
+               }
+}
+
+static void device_handler_boot_status_cb(void *arg, struct status *status)
+{
+       device_handler_status(arg, status);
+}
+
 static void countdown_status(struct device_handler *handler,
                struct discover_boot_option *opt, unsigned int sec)
 {
-       struct boot_status status;
+       struct status status;
 
-       status.type = BOOT_STATUS_INFO;
-       status.progress = -1;
-       status.detail = NULL;
+       status.type = STATUS_INFO;
        status.message = talloc_asprintf(handler,
                        _("Booting in %d sec: %s"), sec, opt->option->name);
+       status.backlog = false;
 
-       discover_server_notify_boot_status(handler->server, &status);
+       device_handler_status(handler, &status);
 
        talloc_free(status.message);
 }
@@ -448,7 +654,7 @@ static int default_timeout(void *arg)
        platform_pre_boot();
 
        handler->pending_boot = boot(handler, handler->default_boot_option,
-                       NULL, handler->dry_run, device_handler_boot_status,
+                       NULL, handler->dry_run, device_handler_boot_status_cb,
                        handler);
        handler->pending_boot_is_default = true;
        return 0;
@@ -604,6 +810,7 @@ static bool __attribute__((used)) boot_option_is_resolved(
        return resource_is_resolved(opt->boot_image) &&
                resource_is_resolved(opt->initrd) &&
                resource_is_resolved(opt->dtb) &&
+               resource_is_resolved(opt->args_sig_file) &&
                resource_is_resolved(opt->icon);
 }
 
@@ -629,6 +836,8 @@ static bool boot_option_resolve(struct discover_boot_option *opt,
        return resource_resolve(opt->boot_image, "boot_image", opt, handler) &&
                resource_resolve(opt->initrd, "initrd", opt, handler) &&
                resource_resolve(opt->dtb, "dtb", opt, handler) &&
+               resource_resolve(opt->args_sig_file, "args_sig_file", opt,
+                       handler) &&
                resource_resolve(opt->icon, "icon", opt, handler);
 }
 
@@ -643,6 +852,7 @@ static void boot_option_finalise(struct device_handler *handler,
        assert(!opt->option->dtb_file);
        assert(!opt->option->icon_file);
        assert(!opt->option->device_id);
+       assert(!opt->option->args_sig_file);
 
        if (opt->boot_image)
                opt->option->boot_image_file = opt->boot_image->url->full;
@@ -652,6 +862,8 @@ static void boot_option_finalise(struct device_handler *handler,
                opt->option->dtb_file = opt->dtb->url->full;
        if (opt->icon)
                opt->option->icon_file = opt->icon->url->full;
+       if (opt->args_sig_file)
+               opt->option->args_sig_file = opt->args_sig_file->url->full;
 
        opt->option->device_id = opt->device->device->id;
 
@@ -701,8 +913,8 @@ struct discover_context *device_handler_discover_context_create(
        struct discover_context *ctx;
 
        ctx = talloc_zero(handler, struct discover_context);
+       ctx->handler = handler;
        ctx->device = device;
-       ctx->network = handler->network;
        list_init(&ctx->boot_options);
 
        return ctx;
@@ -816,21 +1028,16 @@ int device_handler_discover(struct device_handler *handler,
                struct discover_device *dev)
 {
        struct discover_context *ctx;
-       struct boot_status *status;
        int rc;
 
-       status = talloc_zero(handler, struct boot_status);
-       status->type = BOOT_STATUS_INFO;
-       /*
-        * TRANSLATORS: this string will be passed the type and identifier
-        * of the device. For example, the first parameter could be "Disk",
-        * (which will be translated accordingly) and the second a Linux device
-        * identifier like 'sda1' (which will not be translated)
-        */
-       status->message = talloc_asprintf(status, _("Processing %s device %s"),
-                               device_type_display_name(dev->device->type),
-                               dev->device->id);
-       device_handler_boot_status(handler, status);
+       device_handler_status_dev_info(handler, dev,
+               /*
+                * TRANSLATORS: this string will be passed the type of the
+                * device (eg "disk" or "network"), which will be translated
+                * accordingly.
+                */
+               _("Processing new %s device"),
+               device_type_display_name(dev->device->type));
 
        process_boot_option_queue(handler);
 
@@ -852,15 +1059,6 @@ int device_handler_discover(struct device_handler *handler,
        device_handler_discover_context_commit(handler, ctx);
 
 out:
-       /*
-        * TRANSLATORS: the format specifier in this string is a Linux
-        * device identifier, like 'sda1'
-        */
-       status->message = talloc_asprintf(status,_("Processing %s complete"),
-                               dev->device->id);
-       device_handler_boot_status(handler, status);
-
-       talloc_free(status);
        talloc_unlink(handler, ctx);
 
        return 0;
@@ -871,65 +1069,20 @@ int device_handler_dhcp(struct device_handler *handler,
                struct discover_device *dev, struct event *event)
 {
        struct discover_context *ctx;
-       struct boot_status *status;
 
-       status = talloc_zero(handler, struct boot_status);
-       status->type = BOOT_STATUS_INFO;
-       /*
-        * TRANSLATORS: this format specifier will be the name of a network
-        * device, like 'eth0'.
-        */
-       status->message = talloc_asprintf(status, _("Processing dhcp event on %s"),
-                               dev->device->id);
-       device_handler_boot_status(handler, status);
+       device_handler_status_dev_info(handler, dev,
+                       _("Processing DHCP lease response (ip: %s)"),
+                       event_get_param(event, "ip"));
 
        /* create our context */
        ctx = device_handler_discover_context_create(handler, dev);
+       talloc_steal(ctx, event);
        ctx->event = event;
 
        iterate_parsers(ctx);
 
        device_handler_discover_context_commit(handler, ctx);
 
-       /*
-        * TRANSLATORS: this format specifier will be the name of a network
-        * device, like 'eth0'.
-        */
-       status->message = talloc_asprintf(status,_("Processing %s complete"),
-                               dev->device->id);
-       device_handler_boot_status(handler, status);
-
-       talloc_free(status);
-       talloc_unlink(handler, ctx);
-
-       return 0;
-}
-
-/* incoming conf event */
-int device_handler_conf(struct device_handler *handler,
-               struct discover_device *dev, struct pb_url *url)
-{
-       struct discover_context *ctx;
-       struct boot_status *status;
-
-       status = talloc_zero(handler, struct boot_status);
-       status->type = BOOT_STATUS_INFO;
-       status->message = talloc_asprintf(status, _("Processing user config"));
-       device_handler_boot_status(handler, status);
-
-       /* create our context */
-       ctx = device_handler_discover_context_create(handler, dev);
-       ctx->conf_url = url;
-
-       iterate_parsers(ctx);
-
-       device_handler_discover_context_commit(handler, ctx);
-
-       status->message = talloc_asprintf(status,
-                               _("Processing user config complete"));
-       device_handler_boot_status(handler, status);
-
-       talloc_free(status);
        talloc_unlink(handler, ctx);
 
        return 0;
@@ -966,14 +1119,12 @@ void device_handler_boot(struct device_handler *handler,
        platform_pre_boot();
 
        handler->pending_boot = boot(handler, opt, cmd, handler->dry_run,
-                       device_handler_boot_status, handler);
+                       device_handler_boot_status_cb, handler);
        handler->pending_boot_is_default = false;
 }
 
 void device_handler_cancel_default(struct device_handler *handler)
 {
-       struct boot_status status;
-
        if (handler->timeout_waiter)
                waiter_remove(handler->timeout_waiter);
 
@@ -994,12 +1145,7 @@ void device_handler_cancel_default(struct device_handler *handler)
 
        handler->default_boot_option = NULL;
 
-       status.type = BOOT_STATUS_INFO;
-       status.progress = -1;
-       status.detail = NULL;
-       status.message = _("Default boot cancelled");
-
-       discover_server_notify_boot_status(handler->server, &status);
+       device_handler_status_info(handler, _("Default boot cancelled"));
 }
 
 void device_handler_update_config(struct device_handler *handler,
@@ -1091,27 +1237,18 @@ void device_handler_process_url(struct device_handler *handler,
 {
        struct discover_context *ctx;
        struct discover_device *dev;
-       struct boot_status *status;
        struct pb_url *pb_url;
        struct event *event;
        struct param *param;
 
-       status = talloc(handler, struct boot_status);
-
-       status->type = BOOT_STATUS_ERROR;
-       status->progress = 0;
-       status->detail = talloc_asprintf(status,
-                       _("Received config URL %s"), url);
-
        if (!handler->network) {
-               status->message = talloc_asprintf(handler,
-                                       _("No network configured"));
-               goto msg;
+               device_handler_status_err(handler, _("No network configured"));
+               return;
        }
 
        event = talloc(handler, struct event);
        event->type = EVENT_TYPE_USER;
-       event->action = EVENT_ACTION_CONF;
+       event->action = EVENT_ACTION_URL;
 
        if (url[strlen(url) - 1] == '/') {
                event->params = talloc_array(event, struct param, 3);
@@ -1135,9 +1272,8 @@ void device_handler_process_url(struct device_handler *handler,
 
        pb_url = pb_url_parse(event, event->params->value);
        if (!pb_url || (pb_url->scheme != pb_url_file && !pb_url->host)) {
-               status->message = talloc_asprintf(handler,
-                                       _("Invalid config URL!"));
-               goto msg;
+               device_handler_status_err(handler, _("Invalid config URL!"));
+               return;
        }
 
        if (pb_url->scheme == pb_url_file)
@@ -1146,16 +1282,17 @@ void device_handler_process_url(struct device_handler *handler,
                event->device = device_from_addr(event, pb_url);
 
        if (!event->device) {
-               status->message = talloc_asprintf(status,
+               device_handler_status_err(handler,
                                        _("Unable to route to host %s"),
                                        pb_url->host);
-               goto msg;
+               return;
        }
 
-       dev = discover_device_create(handler, event->device);
+       dev = discover_device_create(handler, mac, event->device);
        if (pb_url->scheme == pb_url_file)
                dev->device->type = DEVICE_TYPE_ANY;
        ctx = device_handler_discover_context_create(handler, dev);
+       talloc_steal(ctx, event);
        ctx->event = event;
 
        iterate_parsers(ctx);
@@ -1163,13 +1300,6 @@ void device_handler_process_url(struct device_handler *handler,
        device_handler_discover_context_commit(handler, ctx);
 
        talloc_unlink(handler, ctx);
-
-       status->type = BOOT_STATUS_INFO;
-       status->message = talloc_asprintf(status, _("Config file %s parsed"),
-                                       pb_url->file);
-msg:
-       device_handler_boot_status(handler, status);
-       talloc_free(status);
 }
 
 #ifndef PETITBOOT_TEST
@@ -1184,13 +1314,21 @@ void device_handler_discover_context_commit(struct device_handler *handler,
        struct discover_device *dev = ctx->device;
        struct discover_boot_option *opt, *tmp;
 
-       if (!device_lookup_by_id(handler, dev->device->id))
+       if (!device_lookup_by_uuid(handler, dev->uuid))
                device_handler_add_device(handler, dev);
 
        /* move boot options from the context to the device */
        list_for_each_entry_safe(&ctx->boot_options, opt, tmp, list) {
                list_remove(&opt->list);
 
+               /* All boot options need at least a kernel image */
+               if (!opt->boot_image || !opt->boot_image->url) {
+                       pb_log("boot option %s is missing boot image, ignoring\n",
+                               opt->option->id);
+                       talloc_free(opt);
+                       continue;
+               }
+
                if (boot_option_resolve(opt, handler)) {
                        pb_log("boot option %s is resolved, "
                                        "sending to clients\n",
@@ -1564,6 +1702,41 @@ void device_release_write(struct discover_device *dev, bool release)
                dev->mounted = true;
 }
 
+void device_sync_snapshots(struct device_handler *handler, const char *device)
+{
+       struct discover_device *dev = NULL;
+       unsigned int i;
+
+       if (device) {
+               /* Find matching device and sync */
+               dev = device_lookup_by_name(handler, device);
+               if (!dev) {
+                       pb_log("%s: device name '%s' unrecognised\n",
+                               __func__, device);
+                       return;
+               }
+               if (dev->ramdisk)
+                       device_release_write(dev, true);
+               else
+                       pb_log("%s has no snapshot to merge, skipping\n",
+                               dev->device->id);
+               return;
+       }
+
+       /* Otherwise sync all relevant devices */
+       for (i = 0; i < handler->n_devices; i++) {
+               dev = handler->devices[i];
+               if (dev->device->type != DEVICE_TYPE_DISK &&
+                       dev->device->type != DEVICE_TYPE_USB)
+                       continue;
+               if (dev->ramdisk)
+                       device_release_write(dev, true);
+               else
+                       pb_log("%s has no snapshot to merge, skipping\n",
+                               dev->device->id);
+       }
+}
+
 #else
 
 void device_handler_discover_context_commit(
@@ -1611,4 +1784,10 @@ void device_release_write(struct discover_device *dev __attribute__((unused)),
 {
 }
 
+void device_sync_snapshots(
+               struct device_handler *handler __attribute__((unused)),
+               const char *device __attribute__((unused)))
+{
+}
+
 #endif