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);
237 static int pb_protocol_interface_config_len(struct interface_config *conf)
241 len = sizeof(conf->hwaddr) +
242 4 /* conf->ignore */;
247 len += 4 /* conf->method */;
249 if (conf->method == CONFIG_METHOD_STATIC) {
250 len += 4 + optional_strlen(conf->static_config.address);
251 len += 4 + optional_strlen(conf->static_config.gateway);
257 int pb_protocol_config_len(const struct config *config)
261 len = 4 /* config->autoboot_enabled */ +
262 4 /* config->autoboot_timeout_sec */;
265 for (i = 0; i < config->network.n_interfaces; i++)
266 len += pb_protocol_interface_config_len(
267 config->network.interfaces[i]);
270 for (i = 0; i < config->network.n_dns_servers; i++)
271 len += 4 + optional_strlen(config->network.dns_servers[i]);
274 len += config->n_boot_priorities * 4;
279 int pb_protocol_serialise_device(const struct device *dev,
280 char *buf, int buf_len)
284 pos += pb_protocol_serialise_string(pos, dev->id);
285 *(enum device_type *)pos = dev->type;
286 pos += sizeof(enum device_type);
287 pos += pb_protocol_serialise_string(pos, dev->name);
288 pos += pb_protocol_serialise_string(pos, dev->description);
289 pos += pb_protocol_serialise_string(pos, dev->icon_file);
291 assert(pos <= buf + buf_len);
297 int pb_protocol_serialise_boot_option(const struct boot_option *opt,
298 char *buf, int buf_len)
302 pos += pb_protocol_serialise_string(pos, opt->device_id);
303 pos += pb_protocol_serialise_string(pos, opt->id);
304 pos += pb_protocol_serialise_string(pos, opt->name);
305 pos += pb_protocol_serialise_string(pos, opt->description);
306 pos += pb_protocol_serialise_string(pos, opt->icon_file);
307 pos += pb_protocol_serialise_string(pos, opt->boot_image_file);
308 pos += pb_protocol_serialise_string(pos, opt->initrd_file);
309 pos += pb_protocol_serialise_string(pos, opt->dtb_file);
310 pos += pb_protocol_serialise_string(pos, opt->boot_args);
312 *(bool *)pos = opt->is_default;
315 assert(pos <= buf + buf_len);
321 int pb_protocol_serialise_boot_command(const struct boot_command *boot,
322 char *buf, int buf_len)
326 pos += pb_protocol_serialise_string(pos, boot->option_id);
327 pos += pb_protocol_serialise_string(pos, boot->boot_image_file);
328 pos += pb_protocol_serialise_string(pos, boot->initrd_file);
329 pos += pb_protocol_serialise_string(pos, boot->dtb_file);
330 pos += pb_protocol_serialise_string(pos, boot->boot_args);
332 assert(pos <= buf + buf_len);
338 int pb_protocol_serialise_boot_status(const struct boot_status *status,
339 char *buf, int buf_len)
343 *(uint32_t *)pos = __cpu_to_be32(status->type);
344 pos += sizeof(uint32_t);
346 pos += pb_protocol_serialise_string(pos, status->message);
347 pos += pb_protocol_serialise_string(pos, status->detail);
349 *(uint32_t *)pos = __cpu_to_be32(status->type);
350 pos += sizeof(uint32_t);
352 assert(pos <= buf + buf_len);
358 int pb_protocol_serialise_system_info(const struct system_info *sysinfo,
359 char *buf, int buf_len)
364 pos += pb_protocol_serialise_string(pos, sysinfo->type);
365 pos += pb_protocol_serialise_string(pos, sysinfo->identifier);
367 *(uint32_t *)pos = __cpu_to_be32(sysinfo->n_interfaces);
368 pos += sizeof(uint32_t);
370 for (i = 0; i < sysinfo->n_interfaces; i++) {
371 struct interface_info *if_info = sysinfo->interfaces[i];
373 *(uint32_t *)pos = __cpu_to_be32(if_info->hwaddr_size);
374 pos += sizeof(uint32_t);
376 memcpy(pos, if_info->hwaddr, if_info->hwaddr_size);
377 pos += if_info->hwaddr_size;
379 pos += pb_protocol_serialise_string(pos, if_info->name);
382 assert(pos <= buf + buf_len);
388 static int pb_protocol_serialise_config_interface(char *buf,
389 struct interface_config *conf)
393 memcpy(pos, conf->hwaddr, sizeof(conf->hwaddr));
394 pos += sizeof(conf->hwaddr);
396 *(uint32_t *)pos = conf->ignore;
402 *(uint32_t *)pos = __cpu_to_be32(conf->method);
405 if (conf->method == CONFIG_METHOD_STATIC) {
406 pos += pb_protocol_serialise_string(pos,
407 conf->static_config.address);
408 pos += pb_protocol_serialise_string(pos,
409 conf->static_config.gateway);
415 int pb_protocol_serialise_config(const struct config *config,
416 char *buf, int buf_len)
421 *(uint32_t *)pos = config->autoboot_enabled;
424 *(uint32_t *)pos = __cpu_to_be32(config->autoboot_timeout_sec);
427 *(uint32_t *)pos = __cpu_to_be32(config->network.n_interfaces);
429 for (i = 0; i < config->network.n_interfaces; i++) {
430 struct interface_config *iface =
431 config->network.interfaces[i];
432 pos += pb_protocol_serialise_config_interface(pos, iface);
435 *(uint32_t *)pos = __cpu_to_be32(config->network.n_dns_servers);
437 for (i = 0; i < config->network.n_dns_servers; i++) {
438 pos += pb_protocol_serialise_string(pos,
439 config->network.dns_servers[i]);
442 *(uint32_t *)pos = __cpu_to_be32(config->n_boot_priorities);
444 for (i = 0; i < config->n_boot_priorities; i++) {
445 *(uint32_t *)pos = __cpu_to_be32(config->boot_priorities[i].type);
449 assert(pos <= buf + buf_len);
455 int pb_protocol_write_message(int fd, struct pb_protocol_message *message)
460 total_len = sizeof(*message) + message->payload_len;
462 message->payload_len = __cpu_to_be32(message->payload_len);
463 message->action = __cpu_to_be32(message->action);
465 for (pos = (void *)message; total_len;) {
466 rc = write(fd, pos, total_len);
475 talloc_free(message);
480 pb_log("%s: failed: %s\n", __func__, strerror(errno));
484 struct pb_protocol_message *pb_protocol_create_message(void *ctx,
485 enum pb_protocol_action action, int payload_len)
487 struct pb_protocol_message *message;
489 if (payload_len > PB_PROTOCOL_MAX_PAYLOAD_SIZE) {
490 pb_log("%s: payload too big %u/%u\n", __func__, payload_len,
491 PB_PROTOCOL_MAX_PAYLOAD_SIZE);
495 message = talloc_size(ctx, sizeof(*message) + payload_len);
497 /* we convert these to big-endian in write_message() */
498 message->action = action;
499 message->payload_len = payload_len;
505 struct pb_protocol_message *pb_protocol_read_message(void *ctx, int fd)
507 struct pb_protocol_message *message, m;
511 /* use the stack for the initial 8-byte read */
513 rc = read(fd, &m, sizeof(m));
517 m.payload_len = __be32_to_cpu(m.payload_len);
518 m.action = __be32_to_cpu(m.action);
520 if (m.payload_len > PB_PROTOCOL_MAX_PAYLOAD_SIZE) {
521 pb_log("%s: payload too big %u/%u\n", __func__, m.payload_len,
522 PB_PROTOCOL_MAX_PAYLOAD_SIZE);
526 message = talloc_size(ctx, sizeof(m) + m.payload_len);
527 memcpy(message, &m, sizeof(m));
529 for (len = 0; len < m.payload_len;) {
530 rc = read(fd, message->payload + len, m.payload_len - len);
533 talloc_free(message);
534 pb_log("%s: failed (%u): %s\n", __func__, len,
546 int pb_protocol_deserialise_device(struct device *dev,
547 const struct pb_protocol_message *message)
553 len = message->payload_len;
554 pos = message->payload;
556 if (read_string(dev, &pos, &len, &dev->id))
559 if (len < sizeof(enum device_type))
561 dev->type = *(enum device_type *)(pos);
562 pos += sizeof(enum device_type);
563 len -= sizeof(enum device_type);
565 if (read_string(dev, &pos, &len, &dev->name))
568 if (read_string(dev, &pos, &len, &dev->description))
571 if (read_string(dev, &pos, &len, &dev->icon_file))
580 int pb_protocol_deserialise_boot_option(struct boot_option *opt,
581 const struct pb_protocol_message *message)
587 len = message->payload_len;
588 pos = message->payload;
590 if (read_string(opt, &pos, &len, &opt->device_id))
593 if (read_string(opt, &pos, &len, &opt->id))
596 if (read_string(opt, &pos, &len, &opt->name))
599 if (read_string(opt, &pos, &len, &opt->description))
602 if (read_string(opt, &pos, &len, &opt->icon_file))
605 if (read_string(opt, &pos, &len, &opt->boot_image_file))
608 if (read_string(opt, &pos, &len, &opt->initrd_file))
611 if (read_string(opt, &pos, &len, &opt->dtb_file))
614 if (read_string(opt, &pos, &len, &opt->boot_args))
617 if (len < sizeof(bool))
619 opt->is_default = *(bool *)(pos);
627 int pb_protocol_deserialise_boot_command(struct boot_command *cmd,
628 const struct pb_protocol_message *message)
634 len = message->payload_len;
635 pos = message->payload;
637 if (read_string(cmd, &pos, &len, &cmd->option_id))
640 if (read_string(cmd, &pos, &len, &cmd->boot_image_file))
643 if (read_string(cmd, &pos, &len, &cmd->initrd_file))
646 if (read_string(cmd, &pos, &len, &cmd->dtb_file))
649 if (read_string(cmd, &pos, &len, &cmd->boot_args))
658 int pb_protocol_deserialise_boot_status(struct boot_status *status,
659 const struct pb_protocol_message *message)
665 len = message->payload_len;
666 pos = message->payload;
668 /* first up, the type enum... */
669 if (len < sizeof(uint32_t))
672 status->type = __be32_to_cpu(*(uint32_t *)(pos));
674 switch (status->type) {
675 case BOOT_STATUS_ERROR:
676 case BOOT_STATUS_INFO:
682 pos += sizeof(uint32_t);
683 len -= sizeof(uint32_t);
685 /* message and detail strings */
686 if (read_string(status, &pos, &len, &status->message))
689 if (read_string(status, &pos, &len, &status->detail))
692 /* and finally, progress */
693 if (len < sizeof(uint32_t))
696 status->progress = __be32_to_cpu(*(uint32_t *)(pos));
699 if (status->progress > 100)
700 status->progress = 100;
708 int pb_protocol_deserialise_system_info(struct system_info *sysinfo,
709 const struct pb_protocol_message *message)
715 len = message->payload_len;
716 pos = message->payload;
718 /* type and identifier strings */
719 if (read_string(sysinfo, &pos, &len, &sysinfo->type))
722 if (read_string(sysinfo, &pos, &len, &sysinfo->identifier))
725 /* number of interfaces */
726 if (read_u32(&pos, &len, &sysinfo->n_interfaces))
729 sysinfo->interfaces = talloc_array(sysinfo, struct interface_info *,
730 sysinfo->n_interfaces);
732 for (i = 0; i < sysinfo->n_interfaces; i++) {
733 struct interface_info *if_info = talloc(sysinfo,
734 struct interface_info);
736 if (read_u32(&pos, &len, &if_info->hwaddr_size))
739 if (len < if_info->hwaddr_size)
742 if_info->hwaddr = talloc_memdup(if_info, pos,
743 if_info->hwaddr_size);
744 pos += if_info->hwaddr_size;
745 len -= if_info->hwaddr_size;
747 if (read_string(if_info, &pos, &len, &if_info->name))
750 sysinfo->interfaces[i] = if_info;
759 static int pb_protocol_deserialise_config_interface(const char **buf,
760 unsigned int *len, struct interface_config *iface)
764 if (*len < sizeof(iface->hwaddr))
767 memcpy(iface->hwaddr, *buf, sizeof(iface->hwaddr));
768 *buf += sizeof(iface->hwaddr);
769 *len -= sizeof(iface->hwaddr);
771 if (read_u32(buf, len, &tmp))
773 iface->ignore = !!tmp;
778 if (read_u32(buf, len, &iface->method))
781 if (iface->method == CONFIG_METHOD_STATIC) {
782 if (read_string(iface, buf, len, &iface->static_config.address))
785 if (read_string(iface, buf, len, &iface->static_config.gateway))
792 int pb_protocol_deserialise_config(struct config *config,
793 const struct pb_protocol_message *message)
795 unsigned int len, i, tmp;
799 len = message->payload_len;
800 pos = message->payload;
802 if (read_u32(&pos, &len, &tmp))
804 config->autoboot_enabled = !!tmp;
806 if (read_u32(&pos, &len, &config->autoboot_timeout_sec))
809 if (read_u32(&pos, &len, &config->network.n_interfaces))
812 config->network.interfaces = talloc_array(config,
813 struct interface_config *, config->network.n_interfaces);
815 for (i = 0; i < config->network.n_interfaces; i++) {
816 struct interface_config *iface = talloc_zero(
817 config->network.interfaces,
818 struct interface_config);
819 if (pb_protocol_deserialise_config_interface(&pos, &len, iface))
821 config->network.interfaces[i] = iface;
824 if (read_u32(&pos, &len, &config->network.n_dns_servers))
826 config->network.dns_servers = talloc_array(config, const char *,
827 config->network.n_dns_servers);
829 for (i = 0; i < config->network.n_dns_servers; i++) {
831 if (read_string(config->network.dns_servers, &pos, &len, &tmp))
833 config->network.dns_servers[i] = tmp;
836 if (read_u32(&pos, &len, &config->n_boot_priorities))
838 config->boot_priorities = talloc_array(config, struct boot_priority,
839 config->n_boot_priorities);
841 for (i = 0; i < config->n_boot_priorities; i++) {
842 if (read_u32(&pos, &len, &tmp))
844 config->boot_priorities[i].type = tmp;