Add boot command structure to petitboot protocol description
[petitboot] / lib / pb-protocol / pb-protocol.c
index 2fd76c5dd10a78f5fcbab5d6fb83dbd6035b0ea0..1d1a84b8901a3069c6a957382b992b395dc7b7f4 100644 (file)
@@ -1,9 +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.
  *
@@ -64,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;
 
@@ -92,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;
@@ -113,9 +159,10 @@ 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)
 {
-       int len, i;
+       struct boot_option *opt;
+       int len;
 
        len =   4 + optional_strlen(dev->id) +
                4 + optional_strlen(dev->name) +
@@ -123,8 +170,7 @@ int pb_protocol_device_len(struct device *dev)
                4 + optional_strlen(dev->icon_file) +
                4;
 
-       for (i = 0; i < dev->n_options; i++) {
-               struct boot_option *opt = &dev->options[i];
+       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) +
@@ -137,10 +183,11 @@ int pb_protocol_device_len(struct device *dev)
        return len;
 }
 
-int pb_protocol_serialise_device(struct device *dev, char *buf, int buf_len)
+int pb_protocol_serialise_device(const struct device *dev, char *buf, int buf_len)
 {
+       struct boot_option *opt;
+       uint32_t n;
        char *pos;
-       int i;
 
        pos = buf;
 
@@ -151,12 +198,16 @@ int pb_protocol_serialise_device(struct device *dev, char *buf, int buf_len)
        pos += pb_protocol_serialise_string(pos, dev->icon_file);
 
        /* write option count */
-       *(uint32_t *)pos = __cpu_to_be32(dev->n_options);
+       n = 0;
+
+       list_for_each_entry(&dev->boot_options, opt, list)
+               n++;
+
+       *(uint32_t *)pos = __cpu_to_be32(n);
        pos += sizeof(uint32_t);
 
        /* write each option */
-       for (i = 0; i < dev->n_options; i++) {
-               struct boot_option *opt = &dev->options[i];
+       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);
@@ -166,6 +217,9 @@ int pb_protocol_serialise_device(struct device *dev, char *buf, int buf_len)
                pos += pb_protocol_serialise_string(pos, opt->boot_args);
        }
 
+       assert(pos <= buf + buf_len);
+       (void)buf_len;
+
        return 0;
 }
 
@@ -191,16 +245,23 @@ 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,
-               int action, int payload_len)
+               enum pb_protocol_action action, int payload_len)
 {
        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);
 
@@ -215,7 +276,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 */
 
@@ -226,8 +288,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));
@@ -237,6 +302,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;
                }
 
@@ -248,11 +315,12 @@ 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)
+               const struct pb_protocol_message *message)
 {
        struct device *dev;
-       char *pos;
-       int i, len;
+       const char *pos;
+       int i, n_options;
+       unsigned int len;
 
        len = message->payload_len;
        pos = message->payload;
@@ -271,12 +339,17 @@ struct device *pb_protocol_deserialise_device(void *ctx,
        if (read_string(dev, &pos, &len, &dev->icon_file))
                goto out_err;
 
-       dev->n_options = __be32_to_cpu(*(uint32_t *)pos);
-       dev->options = talloc_array(dev, struct boot_option, dev->n_options);
+       n_options = __be32_to_cpu(*(uint32_t *)pos);
        pos += sizeof(uint32_t);
 
-       for (i = 0; i < dev->n_options; i++) {
-               struct boot_option *opt = &dev->options[i];
+       dev->n_options = n_options;
+
+       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;
@@ -297,6 +370,8 @@ struct device *pb_protocol_deserialise_device(void *ctx,
                if (read_string(opt, &pos, &len,
                                        &opt->boot_args))
                        goto out_err;
+
+               list_add(&dev->boot_options, &opt->list);
        }
 
        return dev;