7 #include <asm/byteorder.h>
9 #include <talloc/talloc.h>
10 #include <list/list.h>
13 #include "pb-protocol.h"
18 * 4-byte action, determines the remaining message content
19 * 4-byte total payload len
20 * - not including action and payload len header
22 * action = 0x1: device add message
27 * 4-byte len, description
28 * 4-byte len, icon_file
34 * 4-byte len, description
35 * 4-byte len, icon_file
36 * 4-byte len, boot_image_file
37 * 4-byte len, initrd_file
38 * 4-byte len, dtb_file
39 * 4-byte len, boot_args
41 * action = 0x2: device remove message
47 * 4-byte len, boot option id
48 * 4-byte len, boot_image_file
49 * 4-byte len, initrd_file
50 * 4-byte len, dtb_file
51 * 4-byte len, boot_args
55 void pb_protocol_dump_device(const struct device *dev, const char *text,
58 struct boot_option *opt;
60 fprintf(stream, "%snew dev:\n", text);
61 fprintf(stream, "%s\tid: %s\n", text, dev->id);
62 fprintf(stream, "%s\tname: %s\n", text, dev->name);
63 fprintf(stream, "%s\tdesc: %s\n", text, dev->description);
64 fprintf(stream, "%s\ticon: %s\n", text, dev->icon_file);
65 fprintf(stream, "%s\tboot options:\n", text);
66 list_for_each_entry(&dev->boot_options, opt, list) {
67 fprintf(stream, "%s\t\tid: %s\n", text, opt->id);
68 fprintf(stream, "%s\t\tname: %s\n", text, opt->name);
69 fprintf(stream, "%s\t\tdesc: %s\n", text, opt->description);
70 fprintf(stream, "%s\t\ticon: %s\n", text, opt->icon_file);
71 fprintf(stream, "%s\t\tboot: %s\n", text, opt->boot_image_file);
72 fprintf(stream, "%s\t\tinit: %s\n", text, opt->initrd_file);
73 fprintf(stream, "%s\t\tdtb: %s\n", text, opt->dtb_file);
74 fprintf(stream, "%s\t\targs: %s\n", text, opt->boot_args);
78 int pb_protocol_device_cmp(const struct device *a, const struct device *b)
80 return !strcmp(a->id, b->id);
83 int pb_protocol_boot_option_cmp(const struct boot_option *a,
84 const struct boot_option *b)
86 return !strcmp(a->id, b->id);
89 /* Write a string into the buffer, starting at pos.
91 * Returns the total length used for the write, including length header.
93 int pb_protocol_serialise_string(char *pos, const char *str)
100 *(uint32_t *)pos = __cpu_to_be32(len);
101 pos += sizeof(uint32_t);
103 memcpy(pos, str, len);
105 return len + sizeof(uint32_t);
108 /* Read a string from a buffer, allocating the new string as necessary.
110 * @param[in] ctx The talloc context to base the allocation on
111 * @param[in,out] pos Where to start reading
112 * @param[in,out] len The amount of data remaining in the buffer
113 * @param[out] str Pointer to resuling string
114 * @return zero on success, non-zero on failure
116 static int read_string(void *ctx, const char **pos, unsigned int *len,
119 uint32_t str_len, read_len;
121 if (*len < sizeof(uint32_t))
124 str_len = __be32_to_cpu(*(uint32_t *)(*pos));
125 read_len = sizeof(uint32_t);
127 if (read_len + str_len > *len)
133 *str = talloc_strndup(ctx, *pos + read_len, str_len);
137 /* all ok, update the caller's pointers */
144 static int read_u32(const char **pos, unsigned int *len, unsigned int *p)
146 if (*len < sizeof(uint32_t))
149 *p = (unsigned int)__be32_to_cpu(*(uint32_t *)(*pos));
150 *pos += sizeof(uint32_t);
151 *len -= sizeof(uint32_t);
156 char *pb_protocol_deserialise_string(void *ctx,
157 const struct pb_protocol_message *message)
163 len = message->payload_len;
164 buf = message->payload;
166 if (read_string(ctx, &buf, &len, &str))
172 static int optional_strlen(const char *str)
179 int pb_protocol_device_len(const struct device *dev)
181 return 4 + optional_strlen(dev->id) +
183 4 + optional_strlen(dev->name) +
184 4 + optional_strlen(dev->description) +
185 4 + optional_strlen(dev->icon_file);
188 int pb_protocol_boot_option_len(const struct boot_option *opt)
191 return 4 + optional_strlen(opt->device_id) +
192 4 + optional_strlen(opt->id) +
193 4 + optional_strlen(opt->name) +
194 4 + optional_strlen(opt->description) +
195 4 + optional_strlen(opt->icon_file) +
196 4 + optional_strlen(opt->boot_image_file) +
197 4 + optional_strlen(opt->initrd_file) +
198 4 + optional_strlen(opt->dtb_file) +
199 4 + optional_strlen(opt->boot_args) +
200 sizeof(opt->is_default);
203 int pb_protocol_boot_len(const struct boot_command *boot)
205 return 4 + optional_strlen(boot->option_id) +
206 4 + optional_strlen(boot->boot_image_file) +
207 4 + optional_strlen(boot->initrd_file) +
208 4 + optional_strlen(boot->dtb_file) +
209 4 + optional_strlen(boot->boot_args);
212 int pb_protocol_boot_status_len(const struct boot_status *status)
215 4 + optional_strlen(status->message) +
216 4 + optional_strlen(status->detail) +
220 int pb_protocol_system_info_len(const struct system_info *sysinfo)
224 len = 4 + optional_strlen(sysinfo->type) +
225 4 + optional_strlen(sysinfo->identifier) +
228 for (i = 0; i < sysinfo->n_interfaces; i++) {
229 struct interface_info *if_info = sysinfo->interfaces[i];
230 len += 4 + if_info->hwaddr_size +
231 4 + optional_strlen(if_info->name) +
232 sizeof(if_info->link);
235 for (i = 0; i < sysinfo->n_blockdevs; i++) {
236 struct blockdev_info *bd_info = sysinfo->blockdevs[i];
237 len += 4 + optional_strlen(bd_info->name) +
238 4 + optional_strlen(bd_info->uuid) +
239 4 + optional_strlen(bd_info->mountpoint);
245 static int pb_protocol_interface_config_len(struct interface_config *conf)
249 len = sizeof(conf->hwaddr) +
250 4 /* conf->ignore */;
255 len += 4 /* conf->method */;
257 if (conf->method == CONFIG_METHOD_STATIC) {
258 len += 4 + optional_strlen(conf->static_config.address);
259 len += 4 + optional_strlen(conf->static_config.gateway);
265 int pb_protocol_config_len(const struct config *config)
269 len = 4 /* config->autoboot_enabled */ +
270 4 /* config->autoboot_timeout_sec */;
273 for (i = 0; i < config->network.n_interfaces; i++)
274 len += pb_protocol_interface_config_len(
275 config->network.interfaces[i]);
278 for (i = 0; i < config->network.n_dns_servers; i++)
279 len += 4 + optional_strlen(config->network.dns_servers[i]);
282 len += config->n_boot_priorities * 8;
287 int pb_protocol_serialise_device(const struct device *dev,
288 char *buf, int buf_len)
292 pos += pb_protocol_serialise_string(pos, dev->id);
293 *(enum device_type *)pos = dev->type;
294 pos += sizeof(enum device_type);
295 pos += pb_protocol_serialise_string(pos, dev->name);
296 pos += pb_protocol_serialise_string(pos, dev->description);
297 pos += pb_protocol_serialise_string(pos, dev->icon_file);
299 assert(pos <= buf + buf_len);
305 int pb_protocol_serialise_boot_option(const struct boot_option *opt,
306 char *buf, int buf_len)
310 pos += pb_protocol_serialise_string(pos, opt->device_id);
311 pos += pb_protocol_serialise_string(pos, opt->id);
312 pos += pb_protocol_serialise_string(pos, opt->name);
313 pos += pb_protocol_serialise_string(pos, opt->description);
314 pos += pb_protocol_serialise_string(pos, opt->icon_file);
315 pos += pb_protocol_serialise_string(pos, opt->boot_image_file);
316 pos += pb_protocol_serialise_string(pos, opt->initrd_file);
317 pos += pb_protocol_serialise_string(pos, opt->dtb_file);
318 pos += pb_protocol_serialise_string(pos, opt->boot_args);
320 *(bool *)pos = opt->is_default;
323 assert(pos <= buf + buf_len);
329 int pb_protocol_serialise_boot_command(const struct boot_command *boot,
330 char *buf, int buf_len)
334 pos += pb_protocol_serialise_string(pos, boot->option_id);
335 pos += pb_protocol_serialise_string(pos, boot->boot_image_file);
336 pos += pb_protocol_serialise_string(pos, boot->initrd_file);
337 pos += pb_protocol_serialise_string(pos, boot->dtb_file);
338 pos += pb_protocol_serialise_string(pos, boot->boot_args);
340 assert(pos <= buf + buf_len);
346 int pb_protocol_serialise_boot_status(const struct boot_status *status,
347 char *buf, int buf_len)
351 *(uint32_t *)pos = __cpu_to_be32(status->type);
352 pos += sizeof(uint32_t);
354 pos += pb_protocol_serialise_string(pos, status->message);
355 pos += pb_protocol_serialise_string(pos, status->detail);
357 *(uint32_t *)pos = __cpu_to_be32(status->type);
358 pos += sizeof(uint32_t);
360 assert(pos <= buf + buf_len);
366 int pb_protocol_serialise_system_info(const struct system_info *sysinfo,
367 char *buf, int buf_len)
372 pos += pb_protocol_serialise_string(pos, sysinfo->type);
373 pos += pb_protocol_serialise_string(pos, sysinfo->identifier);
375 *(uint32_t *)pos = __cpu_to_be32(sysinfo->n_interfaces);
376 pos += sizeof(uint32_t);
378 for (i = 0; i < sysinfo->n_interfaces; i++) {
379 struct interface_info *if_info = sysinfo->interfaces[i];
381 *(uint32_t *)pos = __cpu_to_be32(if_info->hwaddr_size);
382 pos += sizeof(uint32_t);
384 memcpy(pos, if_info->hwaddr, if_info->hwaddr_size);
385 pos += if_info->hwaddr_size;
387 pos += pb_protocol_serialise_string(pos, if_info->name);
389 *(bool *)pos = if_info->link;
393 *(uint32_t *)pos = __cpu_to_be32(sysinfo->n_blockdevs);
394 pos += sizeof(uint32_t);
396 for (i = 0; i < sysinfo->n_blockdevs; i++) {
397 struct blockdev_info *bd_info = sysinfo->blockdevs[i];
399 pos += pb_protocol_serialise_string(pos, bd_info->name);
400 pos += pb_protocol_serialise_string(pos, bd_info->uuid);
401 pos += pb_protocol_serialise_string(pos, bd_info->mountpoint);
404 assert(pos <= buf + buf_len);
410 static int pb_protocol_serialise_config_interface(char *buf,
411 struct interface_config *conf)
415 memcpy(pos, conf->hwaddr, sizeof(conf->hwaddr));
416 pos += sizeof(conf->hwaddr);
418 *(uint32_t *)pos = conf->ignore;
424 *(uint32_t *)pos = __cpu_to_be32(conf->method);
427 if (conf->method == CONFIG_METHOD_STATIC) {
428 pos += pb_protocol_serialise_string(pos,
429 conf->static_config.address);
430 pos += pb_protocol_serialise_string(pos,
431 conf->static_config.gateway);
437 int pb_protocol_serialise_config(const struct config *config,
438 char *buf, int buf_len)
443 *(uint32_t *)pos = config->autoboot_enabled;
446 *(uint32_t *)pos = __cpu_to_be32(config->autoboot_timeout_sec);
449 *(uint32_t *)pos = __cpu_to_be32(config->network.n_interfaces);
451 for (i = 0; i < config->network.n_interfaces; i++) {
452 struct interface_config *iface =
453 config->network.interfaces[i];
454 pos += pb_protocol_serialise_config_interface(pos, iface);
457 *(uint32_t *)pos = __cpu_to_be32(config->network.n_dns_servers);
459 for (i = 0; i < config->network.n_dns_servers; i++) {
460 pos += pb_protocol_serialise_string(pos,
461 config->network.dns_servers[i]);
464 *(uint32_t *)pos = __cpu_to_be32(config->n_boot_priorities);
466 for (i = 0; i < config->n_boot_priorities; i++) {
468 __cpu_to_be32(config->boot_priorities[i].type);
471 __cpu_to_be32(config->boot_priorities[i].priority);
475 pos += pb_protocol_serialise_string(pos, config->boot_device);
477 assert(pos <= buf + buf_len);
483 int pb_protocol_write_message(int fd, struct pb_protocol_message *message)
488 total_len = sizeof(*message) + message->payload_len;
490 message->payload_len = __cpu_to_be32(message->payload_len);
491 message->action = __cpu_to_be32(message->action);
493 for (pos = (void *)message; total_len;) {
494 rc = write(fd, pos, total_len);
503 talloc_free(message);
508 pb_log("%s: failed: %s\n", __func__, strerror(errno));
512 struct pb_protocol_message *pb_protocol_create_message(void *ctx,
513 enum pb_protocol_action action, int payload_len)
515 struct pb_protocol_message *message;
517 if (payload_len > PB_PROTOCOL_MAX_PAYLOAD_SIZE) {
518 pb_log("%s: payload too big %u/%u\n", __func__, payload_len,
519 PB_PROTOCOL_MAX_PAYLOAD_SIZE);
523 message = talloc_size(ctx, sizeof(*message) + payload_len);
525 /* we convert these to big-endian in write_message() */
526 message->action = action;
527 message->payload_len = payload_len;
533 struct pb_protocol_message *pb_protocol_read_message(void *ctx, int fd)
535 struct pb_protocol_message *message, m;
539 /* use the stack for the initial 8-byte read */
541 rc = read(fd, &m, sizeof(m));
545 m.payload_len = __be32_to_cpu(m.payload_len);
546 m.action = __be32_to_cpu(m.action);
548 if (m.payload_len > PB_PROTOCOL_MAX_PAYLOAD_SIZE) {
549 pb_log("%s: payload too big %u/%u\n", __func__, m.payload_len,
550 PB_PROTOCOL_MAX_PAYLOAD_SIZE);
554 message = talloc_size(ctx, sizeof(m) + m.payload_len);
555 memcpy(message, &m, sizeof(m));
557 for (len = 0; len < m.payload_len;) {
558 rc = read(fd, message->payload + len, m.payload_len - len);
561 talloc_free(message);
562 pb_log("%s: failed (%u): %s\n", __func__, len,
574 int pb_protocol_deserialise_device(struct device *dev,
575 const struct pb_protocol_message *message)
581 len = message->payload_len;
582 pos = message->payload;
584 if (read_string(dev, &pos, &len, &dev->id))
587 if (len < sizeof(enum device_type))
589 dev->type = *(enum device_type *)(pos);
590 pos += sizeof(enum device_type);
591 len -= sizeof(enum device_type);
593 if (read_string(dev, &pos, &len, &dev->name))
596 if (read_string(dev, &pos, &len, &dev->description))
599 if (read_string(dev, &pos, &len, &dev->icon_file))
608 int pb_protocol_deserialise_boot_option(struct boot_option *opt,
609 const struct pb_protocol_message *message)
615 len = message->payload_len;
616 pos = message->payload;
618 if (read_string(opt, &pos, &len, &opt->device_id))
621 if (read_string(opt, &pos, &len, &opt->id))
624 if (read_string(opt, &pos, &len, &opt->name))
627 if (read_string(opt, &pos, &len, &opt->description))
630 if (read_string(opt, &pos, &len, &opt->icon_file))
633 if (read_string(opt, &pos, &len, &opt->boot_image_file))
636 if (read_string(opt, &pos, &len, &opt->initrd_file))
639 if (read_string(opt, &pos, &len, &opt->dtb_file))
642 if (read_string(opt, &pos, &len, &opt->boot_args))
645 if (len < sizeof(bool))
647 opt->is_default = *(bool *)(pos);
655 int pb_protocol_deserialise_boot_command(struct boot_command *cmd,
656 const struct pb_protocol_message *message)
662 len = message->payload_len;
663 pos = message->payload;
665 if (read_string(cmd, &pos, &len, &cmd->option_id))
668 if (read_string(cmd, &pos, &len, &cmd->boot_image_file))
671 if (read_string(cmd, &pos, &len, &cmd->initrd_file))
674 if (read_string(cmd, &pos, &len, &cmd->dtb_file))
677 if (read_string(cmd, &pos, &len, &cmd->boot_args))
686 int pb_protocol_deserialise_boot_status(struct boot_status *status,
687 const struct pb_protocol_message *message)
693 len = message->payload_len;
694 pos = message->payload;
696 /* first up, the type enum... */
697 if (len < sizeof(uint32_t))
700 status->type = __be32_to_cpu(*(uint32_t *)(pos));
702 switch (status->type) {
703 case BOOT_STATUS_ERROR:
704 case BOOT_STATUS_INFO:
710 pos += sizeof(uint32_t);
711 len -= sizeof(uint32_t);
713 /* message and detail strings */
714 if (read_string(status, &pos, &len, &status->message))
717 if (read_string(status, &pos, &len, &status->detail))
720 /* and finally, progress */
721 if (len < sizeof(uint32_t))
724 status->progress = __be32_to_cpu(*(uint32_t *)(pos));
727 if (status->progress > 100)
728 status->progress = 100;
736 int pb_protocol_deserialise_system_info(struct system_info *sysinfo,
737 const struct pb_protocol_message *message)
743 len = message->payload_len;
744 pos = message->payload;
746 /* type and identifier strings */
747 if (read_string(sysinfo, &pos, &len, &sysinfo->type))
750 if (read_string(sysinfo, &pos, &len, &sysinfo->identifier))
753 /* number of interfaces */
754 if (read_u32(&pos, &len, &sysinfo->n_interfaces))
757 sysinfo->interfaces = talloc_array(sysinfo, struct interface_info *,
758 sysinfo->n_interfaces);
760 for (i = 0; i < sysinfo->n_interfaces; i++) {
761 struct interface_info *if_info = talloc(sysinfo,
762 struct interface_info);
764 if (read_u32(&pos, &len, &if_info->hwaddr_size))
767 if (len < if_info->hwaddr_size)
770 if_info->hwaddr = talloc_memdup(if_info, pos,
771 if_info->hwaddr_size);
772 pos += if_info->hwaddr_size;
773 len -= if_info->hwaddr_size;
775 if (read_string(if_info, &pos, &len, &if_info->name))
778 if_info->link = *(bool *)pos;
779 pos += sizeof(if_info->link);
781 sysinfo->interfaces[i] = if_info;
784 /* number of interfaces */
785 if (read_u32(&pos, &len, &sysinfo->n_blockdevs))
788 sysinfo->blockdevs = talloc_array(sysinfo, struct blockdev_info *,
789 sysinfo->n_blockdevs);
791 for (i = 0; i < sysinfo->n_blockdevs; i++) {
792 struct blockdev_info *bd_info = talloc(sysinfo,
793 struct blockdev_info);
795 if (read_string(bd_info, &pos, &len, &bd_info->name))
798 if (read_string(bd_info, &pos, &len, &bd_info->uuid))
801 if (read_string(bd_info, &pos, &len, &bd_info->mountpoint))
804 sysinfo->blockdevs[i] = bd_info;
812 static int pb_protocol_deserialise_config_interface(const char **buf,
813 unsigned int *len, struct interface_config *iface)
817 if (*len < sizeof(iface->hwaddr))
820 memcpy(iface->hwaddr, *buf, sizeof(iface->hwaddr));
821 *buf += sizeof(iface->hwaddr);
822 *len -= sizeof(iface->hwaddr);
824 if (read_u32(buf, len, &tmp))
826 iface->ignore = !!tmp;
831 if (read_u32(buf, len, &iface->method))
834 if (iface->method == CONFIG_METHOD_STATIC) {
835 if (read_string(iface, buf, len, &iface->static_config.address))
838 if (read_string(iface, buf, len, &iface->static_config.gateway))
845 int pb_protocol_deserialise_config(struct config *config,
846 const struct pb_protocol_message *message)
848 unsigned int len, i, tmp;
853 len = message->payload_len;
854 pos = message->payload;
856 if (read_u32(&pos, &len, &tmp))
858 config->autoboot_enabled = !!tmp;
860 if (read_u32(&pos, &len, &config->autoboot_timeout_sec))
863 if (read_u32(&pos, &len, &config->network.n_interfaces))
866 config->network.interfaces = talloc_array(config,
867 struct interface_config *, config->network.n_interfaces);
869 for (i = 0; i < config->network.n_interfaces; i++) {
870 struct interface_config *iface = talloc_zero(
871 config->network.interfaces,
872 struct interface_config);
873 if (pb_protocol_deserialise_config_interface(&pos, &len, iface))
875 config->network.interfaces[i] = iface;
878 if (read_u32(&pos, &len, &config->network.n_dns_servers))
880 config->network.dns_servers = talloc_array(config, const char *,
881 config->network.n_dns_servers);
883 for (i = 0; i < config->network.n_dns_servers; i++) {
884 if (read_string(config->network.dns_servers, &pos, &len, &str))
886 config->network.dns_servers[i] = str;
889 if (read_u32(&pos, &len, &config->n_boot_priorities))
891 config->boot_priorities = talloc_array(config, struct boot_priority,
892 config->n_boot_priorities);
894 for (i = 0; i < config->n_boot_priorities; i++) {
895 if (read_u32(&pos, &len, &tmp))
897 config->boot_priorities[i].priority = (int)tmp;
898 if (read_u32(&pos, &len, &tmp))
900 config->boot_priorities[i].type = tmp;
903 if (read_string(config, &pos, &len, &str))
906 config->boot_device = str;