]> git.ozlabs.org Git - petitboot/blobdiff - lib/pb-protocol/pb-protocol.c
protocol: Add boot_status (de-)serialisation functions
[petitboot] / lib / pb-protocol / pb-protocol.c
index 4981e95ef5a7b152d8a2f4d8b09f6c91c2adb4a0..2792bf832c7ea2866a6accbe3b82b191eaa406f4 100644 (file)
@@ -1,10 +1,13 @@
 
+#include <assert.h>
+#include <errno.h>
 #include <string.h>
 #include <stdint.h>
 #include <asm/byteorder.h>
 
 #include <talloc/talloc.h>
 #include <list/list.h>
+#include <log/log.h>
 
 #include "pb-protocol.h"
 
  * action = 0x2: device remove message
  *  payload:
  *   4-byte len, id
+ *
+ * action = 0x3: boot
+ *  payload:
+ *   4-byte len, boot option id
+ *   4-byte len, boot_image_file
+ *   4-byte len, initrd_file
+ *   4-byte len, boot_args
+ *
  */
 
+void pb_protocol_dump_device(const struct device *dev, const char *text,
+       FILE *stream)
+{
+       struct boot_option *opt;
+
+       fprintf(stream, "%snew dev:\n", text);
+       fprintf(stream, "%s\tid:   %s\n", text, dev->id);
+       fprintf(stream, "%s\tname: %s\n", text, dev->name);
+       fprintf(stream, "%s\tdesc: %s\n", text, dev->description);
+       fprintf(stream, "%s\ticon: %s\n", text, dev->icon_file);
+       fprintf(stream, "%s\tboot options:\n", text);
+       list_for_each_entry(&dev->boot_options, opt, list) {
+               fprintf(stream, "%s\t\tid:   %s\n", text, opt->id);
+               fprintf(stream, "%s\t\tname: %s\n", text, opt->name);
+               fprintf(stream, "%s\t\tdesc: %s\n", text, opt->description);
+               fprintf(stream, "%s\t\ticon: %s\n", text, opt->icon_file);
+               fprintf(stream, "%s\t\tboot: %s\n", text, opt->boot_image_file);
+               fprintf(stream, "%s\t\tinit: %s\n", text, opt->initrd_file);
+               fprintf(stream, "%s\t\targs: %s\n", text, opt->boot_args);
+       }
+}
+
+int pb_protocol_device_cmp(const struct device *a, const struct device *b)
+{
+       return !strcmp(a->id, b->id);
+}
+
+int pb_protocol_boot_option_cmp(const struct boot_option *a,
+       const struct boot_option *b)
+{
+       return !strcmp(a->id, b->id);
+}
 
 /* Write a string into the buffer, starting at pos.
  *
@@ -65,7 +108,8 @@ int pb_protocol_serialise_string(char *pos, const char *str)
  * @param[out] str     Pointer to resuling string
  * @return             zero on success, non-zero on failure
  */
-static int read_string(void *ctx, char **pos, int *len, char **str)
+static int read_string(void *ctx, const char **pos, unsigned int *len,
+       char **str)
 {
        uint32_t str_len, read_len;
 
@@ -93,10 +137,11 @@ static int read_string(void *ctx, char **pos, int *len, char **str)
 }
 
 char *pb_protocol_deserialise_string(void *ctx,
-               struct pb_protocol_message *message)
+               const struct pb_protocol_message *message)
 {
-       char *buf, *str;
-       int len;
+       const char *buf;
+       char *str;
+       unsigned int len;
 
        len = message->payload_len;
        buf = message->payload;
@@ -114,63 +159,111 @@ static int optional_strlen(const char *str)
        return strlen(str);
 }
 
-int pb_protocol_device_len(struct device *dev)
+int pb_protocol_device_len(const struct device *dev)
 {
-       struct boot_option *opt;
-       int len;
-
-       len =   4 + optional_strlen(dev->id) +
+       return  4 + optional_strlen(dev->id) +
                4 + optional_strlen(dev->name) +
                4 + optional_strlen(dev->description) +
-               4 + optional_strlen(dev->icon_file) +
-               4;
+               4 + optional_strlen(dev->icon_file);
+}
 
-       list_for_each_entry(&dev->boot_options, opt, list) {
-               len +=  4 + optional_strlen(opt->id) +
-                       4 + optional_strlen(opt->name) +
-                       4 + optional_strlen(opt->description) +
-                       4 + optional_strlen(opt->icon_file) +
-                       4 + optional_strlen(opt->boot_image_file) +
-                       4 + optional_strlen(opt->initrd_file) +
-                       4 + optional_strlen(opt->boot_args);
-       }
+int pb_protocol_boot_option_len(const struct boot_option *opt)
+{
 
-       return len;
+       return  4 + optional_strlen(opt->device_id) +
+               4 + optional_strlen(opt->id) +
+               4 + optional_strlen(opt->name) +
+               4 + optional_strlen(opt->description) +
+               4 + optional_strlen(opt->icon_file) +
+               4 + optional_strlen(opt->boot_image_file) +
+               4 + optional_strlen(opt->initrd_file) +
+               4 + optional_strlen(opt->boot_args);
 }
 
-int pb_protocol_serialise_device(struct device *dev, char *buf, int buf_len)
+int pb_protocol_boot_len(const struct boot_command *boot)
 {
-       struct boot_option *opt;
-       uint32_t n;
-       char *pos;
+       return  4 + optional_strlen(boot->option_id) +
+               4 + optional_strlen(boot->boot_image_file) +
+               4 + optional_strlen(boot->initrd_file) +
+               4 + optional_strlen(boot->boot_args);
+}
+
+int pb_protocol_boot_status_len(const struct boot_status *status)
+{
+       return  4 +
+               4 + optional_strlen(status->message) +
+               4 + optional_strlen(status->detail) +
+               4;
+}
 
-       pos = buf;
+int pb_protocol_serialise_device(const struct device *dev,
+               char *buf, int buf_len)
+{
+       char *pos = buf;
 
-       /* construct payload into buffer */
        pos += pb_protocol_serialise_string(pos, dev->id);
        pos += pb_protocol_serialise_string(pos, dev->name);
        pos += pb_protocol_serialise_string(pos, dev->description);
        pos += pb_protocol_serialise_string(pos, dev->icon_file);
 
-       /* write option count */
-       n = 0;
+       assert(pos <= buf + buf_len);
+       (void)buf_len;
+
+       return 0;
+}
+
+int pb_protocol_serialise_boot_option(const struct boot_option *opt,
+               char *buf, int buf_len)
+{
+       char *pos = buf;
+
+       pos += pb_protocol_serialise_string(pos, opt->device_id);
+       pos += pb_protocol_serialise_string(pos, opt->id);
+       pos += pb_protocol_serialise_string(pos, opt->name);
+       pos += pb_protocol_serialise_string(pos, opt->description);
+       pos += pb_protocol_serialise_string(pos, opt->icon_file);
+       pos += pb_protocol_serialise_string(pos, opt->boot_image_file);
+       pos += pb_protocol_serialise_string(pos, opt->initrd_file);
+       pos += pb_protocol_serialise_string(pos, opt->boot_args);
+
+       assert(pos <= buf + buf_len);
+       (void)buf_len;
+
+       return 0;
+}
+
+int pb_protocol_serialise_boot_command(const struct boot_command *boot,
+               char *buf, int buf_len)
+{
+       char *pos = buf;
+
+       pos += pb_protocol_serialise_string(pos, boot->option_id);
+       pos += pb_protocol_serialise_string(pos, boot->boot_image_file);
+       pos += pb_protocol_serialise_string(pos, boot->initrd_file);
+       pos += pb_protocol_serialise_string(pos, boot->boot_args);
 
-       list_for_each_entry(&dev->boot_options, opt, list)
-               n++;
+       assert(pos <= buf + buf_len);
+       (void)buf_len;
+
+       return 0;
+}
 
-       *(uint32_t *)pos = __cpu_to_be32(n);
+int pb_protocol_serialise_boot_status(const struct boot_status *status,
+               char *buf, int buf_len)
+{
+       char *pos = buf;
+
+       *(uint32_t *)pos = __cpu_to_be32(status->type);
        pos += sizeof(uint32_t);
 
-       /* write each option */
-       list_for_each_entry(&dev->boot_options, opt, list) {
-               pos += pb_protocol_serialise_string(pos, opt->id);
-               pos += pb_protocol_serialise_string(pos, opt->name);
-               pos += pb_protocol_serialise_string(pos, opt->description);
-               pos += pb_protocol_serialise_string(pos, opt->icon_file);
-               pos += pb_protocol_serialise_string(pos, opt->boot_image_file);
-               pos += pb_protocol_serialise_string(pos, opt->initrd_file);
-               pos += pb_protocol_serialise_string(pos, opt->boot_args);
-       }
+       pos += pb_protocol_serialise_string(pos, status->message);
+       pos += pb_protocol_serialise_string(pos, status->detail);
+
+       *(uint32_t *)pos = __cpu_to_be32(status->type);
+       pos += sizeof(uint32_t);
+
+       assert(pos <= buf + buf_len);
+       (void)buf_len;
 
        return 0;
 }
@@ -197,7 +290,11 @@ int pb_protocol_write_message(int fd, struct pb_protocol_message *message)
 
        talloc_free(message);
 
-       return total_len ? -1 : 0;
+       if (!total_len)
+               return 0;
+
+       pb_log("%s: failed: %s\n", __func__, strerror(errno));
+       return -1;
 }
 
 struct pb_protocol_message *pb_protocol_create_message(void *ctx,
@@ -205,8 +302,11 @@ struct pb_protocol_message *pb_protocol_create_message(void *ctx,
 {
        struct pb_protocol_message *message;
 
-       if (payload_len > PB_PROTOCOL_MAX_PAYLOAD_SIZE)
+       if (payload_len > PB_PROTOCOL_MAX_PAYLOAD_SIZE) {
+               pb_log("%s: payload too big %u/%u\n", __func__, payload_len,
+                       PB_PROTOCOL_MAX_PAYLOAD_SIZE);
                return NULL;
+       }
 
        message = talloc_size(ctx, sizeof(*message) + payload_len);
 
@@ -221,7 +321,8 @@ struct pb_protocol_message *pb_protocol_create_message(void *ctx,
 struct pb_protocol_message *pb_protocol_read_message(void *ctx, int fd)
 {
        struct pb_protocol_message *message, m;
-       int rc, len;
+       int rc;
+       unsigned int len;
 
        /* use the stack for the initial 8-byte read */
 
@@ -232,8 +333,11 @@ struct pb_protocol_message *pb_protocol_read_message(void *ctx, int fd)
        m.payload_len = __be32_to_cpu(m.payload_len);
        m.action = __be32_to_cpu(m.action);
 
-       if (m.payload_len > PB_PROTOCOL_MAX_PAYLOAD_SIZE)
+       if (m.payload_len > PB_PROTOCOL_MAX_PAYLOAD_SIZE) {
+               pb_log("%s: payload too big %u/%u\n", __func__, m.payload_len,
+                       PB_PROTOCOL_MAX_PAYLOAD_SIZE);
                return NULL;
+       }
 
        message = talloc_size(ctx, sizeof(m) + m.payload_len);
        memcpy(message, &m, sizeof(m));
@@ -243,6 +347,8 @@ struct pb_protocol_message *pb_protocol_read_message(void *ctx, int fd)
 
                if (rc <= 0) {
                        talloc_free(message);
+                       pb_log("%s: failed (%u): %s\n", __func__, len,
+                               strerror(errno));
                        return NULL;
                }
 
@@ -253,66 +359,148 @@ struct pb_protocol_message *pb_protocol_read_message(void *ctx, int fd)
 }
 
 
-struct device *pb_protocol_deserialise_device(void *ctx,
-               struct pb_protocol_message *message)
+int pb_protocol_deserialise_device(struct device *dev,
+               const struct pb_protocol_message *message)
 {
-       struct device *dev;
-       char *pos;
-       int i, n_options, len;
+       unsigned int len;
+       const char *pos;
+       int rc = -1;
 
        len = message->payload_len;
        pos = message->payload;
 
-       dev = talloc(ctx, struct device);
-
        if (read_string(dev, &pos, &len, &dev->id))
-               goto out_err;
+               goto out;
 
        if (read_string(dev, &pos, &len, &dev->name))
-               goto out_err;
+               goto out;
 
        if (read_string(dev, &pos, &len, &dev->description))
-               goto out_err;
+               goto out;
 
        if (read_string(dev, &pos, &len, &dev->icon_file))
-               goto out_err;
+               goto out;
 
-       n_options = __be32_to_cpu(*(uint32_t *)pos);
-       pos += sizeof(uint32_t);
+       rc = 0;
+
+out:
+       return rc;
+}
+
+int pb_protocol_deserialise_boot_option(struct boot_option *opt,
+               const struct pb_protocol_message *message)
+{
+       unsigned int len;
+       const char *pos;
+       int rc = -1;
+
+       len = message->payload_len;
+       pos = message->payload;
+
+       if (read_string(opt, &pos, &len, &opt->device_id))
+               goto out;
+
+       if (read_string(opt, &pos, &len, &opt->id))
+               goto out;
+
+       if (read_string(opt, &pos, &len, &opt->name))
+               goto out;
+
+       if (read_string(opt, &pos, &len, &opt->description))
+               goto out;
+
+       if (read_string(opt, &pos, &len, &opt->icon_file))
+               goto out;
+
+       if (read_string(opt, &pos, &len, &opt->boot_image_file))
+               goto out;
+
+       if (read_string(opt, &pos, &len, &opt->initrd_file))
+               goto out;
+
+       if (read_string(opt, &pos, &len, &opt->boot_args))
+               goto out;
+
+       rc = 0;
+
+out:
+       return rc;
+}
 
-       list_init(&dev->boot_options);
-
-       for (i = 0; i < n_options; i++) {
-               struct boot_option *opt;
-
-               opt = talloc(dev, struct boot_option);
-
-               if (read_string(opt, &pos, &len, &opt->id))
-                       goto out_err;
-               if (read_string(opt, &pos, &len, &opt->name))
-                       goto out_err;
-               if (read_string(opt, &pos, &len,
-                                       &opt->description))
-                       goto out_err;
-               if (read_string(opt, &pos, &len,
-                                       &opt->icon_file))
-                       goto out_err;
-               if (read_string(opt, &pos, &len,
-                                       &opt->boot_image_file))
-                       goto out_err;
-               if (read_string(opt, &pos, &len,
-                                       &opt->initrd_file))
-                       goto out_err;
-               if (read_string(opt, &pos, &len,
-                                       &opt->boot_args))
-                       goto out_err;
-
-               list_add(&dev->boot_options, &opt->list);
+int pb_protocol_deserialise_boot_command(struct boot_command *cmd,
+               const struct pb_protocol_message *message)
+{
+       unsigned int len;
+       const char *pos;
+       int rc = -1;
+
+       len = message->payload_len;
+       pos = message->payload;
+
+       if (read_string(cmd, &pos, &len, &cmd->option_id))
+               goto out;
+
+       if (read_string(cmd, &pos, &len, &cmd->boot_image_file))
+               goto out;
+
+       if (read_string(cmd, &pos, &len, &cmd->initrd_file))
+               goto out;
+
+       if (read_string(cmd, &pos, &len, &cmd->boot_args))
+               goto out;
+
+       rc = 0;
+
+out:
+       return rc;
+}
+
+int pb_protocol_deserialise_boot_status(struct boot_status *status,
+               const struct pb_protocol_message *message)
+{
+       unsigned int len;
+       const char *pos;
+       int rc = -1;
+
+       len = message->payload_len;
+       pos = message->payload;
+
+       /* first up, the type enum... */
+       if (len < sizeof(uint32_t))
+               goto out;
+
+       status->type = __be32_to_cpu(*(uint32_t *)(pos));
+
+       switch (status->type) {
+       case BOOT_STATUS_ERROR:
+       case BOOT_STATUS_INFO:
+               break;
+       default:
+               goto out;
        }
 
-       return dev;
+       pos += sizeof(uint32_t);
+       len -= sizeof(uint32_t);
+
+       /* message and detail strings */
+       if (read_string(status, &pos, &len, &status->message))
+               goto out;
+
+       if (read_string(status, &pos, &len, &status->detail))
+               goto out;
+
+       /* and finally, progress */
+       if (len < sizeof(uint32_t))
+               goto out;
+
+       status->progress = __be32_to_cpu(*(uint32_t *)(pos));
+
+       /* clamp to 100% */
+       if (status->progress > 100)
+               status->progress = 100;
+
+       rc = 0;
 
-out_err:
-       talloc_free(dev);
-       return NULL;
+out:
+       return rc;
 }