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);
248 static int pb_protocol_interface_config_len(struct interface_config *conf)
252 len = sizeof(conf->hwaddr) +
253 4 /* conf->ignore */;
258 len += 4 /* conf->method */;
260 if (conf->method == CONFIG_METHOD_STATIC) {
261 len += 4 + optional_strlen(conf->static_config.address);
262 len += 4 + optional_strlen(conf->static_config.gateway);
263 len += 4 + optional_strlen(conf->static_config.url);
269 int pb_protocol_config_len(const struct config *config)
273 len = 4 /* config->autoboot_enabled */ +
274 4 /* config->autoboot_timeout_sec */ +
275 4 /* config->safe_mode */;
278 for (i = 0; i < config->network.n_interfaces; i++)
279 len += pb_protocol_interface_config_len(
280 config->network.interfaces[i]);
283 for (i = 0; i < config->network.n_dns_servers; i++)
284 len += 4 + optional_strlen(config->network.dns_servers[i]);
287 for (i = 0; i < config->n_autoboot_opts; i++) {
288 if (config->autoboot_opts[i].boot_type == BOOT_DEVICE_TYPE)
292 optional_strlen(config->autoboot_opts[i].uuid);
295 len += 4 + 4; /* ipmi_bootdev, ipmi_bootdev_persistent */
297 len += 4; /* allow_writes */
299 len += 4 + optional_strlen(config->lang);
304 int pb_protocol_url_len(const char *url)
306 /* url + length field */
307 return 4 + optional_strlen(url);
310 int pb_protocol_serialise_device(const struct device *dev,
311 char *buf, int buf_len)
315 pos += pb_protocol_serialise_string(pos, dev->id);
316 *(enum device_type *)pos = dev->type;
317 pos += sizeof(enum device_type);
318 pos += pb_protocol_serialise_string(pos, dev->name);
319 pos += pb_protocol_serialise_string(pos, dev->description);
320 pos += pb_protocol_serialise_string(pos, dev->icon_file);
322 assert(pos <= buf + buf_len);
328 int pb_protocol_serialise_boot_option(const struct boot_option *opt,
329 char *buf, int buf_len)
333 pos += pb_protocol_serialise_string(pos, opt->device_id);
334 pos += pb_protocol_serialise_string(pos, opt->id);
335 pos += pb_protocol_serialise_string(pos, opt->name);
336 pos += pb_protocol_serialise_string(pos, opt->description);
337 pos += pb_protocol_serialise_string(pos, opt->icon_file);
338 pos += pb_protocol_serialise_string(pos, opt->boot_image_file);
339 pos += pb_protocol_serialise_string(pos, opt->initrd_file);
340 pos += pb_protocol_serialise_string(pos, opt->dtb_file);
341 pos += pb_protocol_serialise_string(pos, opt->boot_args);
343 *(bool *)pos = opt->is_default;
346 assert(pos <= buf + buf_len);
352 int pb_protocol_serialise_boot_command(const struct boot_command *boot,
353 char *buf, int buf_len)
357 pos += pb_protocol_serialise_string(pos, boot->option_id);
358 pos += pb_protocol_serialise_string(pos, boot->boot_image_file);
359 pos += pb_protocol_serialise_string(pos, boot->initrd_file);
360 pos += pb_protocol_serialise_string(pos, boot->dtb_file);
361 pos += pb_protocol_serialise_string(pos, boot->boot_args);
363 assert(pos <= buf + buf_len);
369 int pb_protocol_serialise_boot_status(const struct boot_status *status,
370 char *buf, int buf_len)
374 *(uint32_t *)pos = __cpu_to_be32(status->type);
375 pos += sizeof(uint32_t);
377 pos += pb_protocol_serialise_string(pos, status->message);
378 pos += pb_protocol_serialise_string(pos, status->detail);
380 *(uint32_t *)pos = __cpu_to_be32(status->type);
381 pos += sizeof(uint32_t);
383 assert(pos <= buf + buf_len);
389 int pb_protocol_serialise_system_info(const struct system_info *sysinfo,
390 char *buf, int buf_len)
395 pos += pb_protocol_serialise_string(pos, sysinfo->type);
396 pos += pb_protocol_serialise_string(pos, sysinfo->identifier);
398 *(uint32_t *)pos = __cpu_to_be32(sysinfo->n_interfaces);
399 pos += sizeof(uint32_t);
401 for (i = 0; i < sysinfo->n_interfaces; i++) {
402 struct interface_info *if_info = sysinfo->interfaces[i];
404 *(uint32_t *)pos = __cpu_to_be32(if_info->hwaddr_size);
405 pos += sizeof(uint32_t);
407 memcpy(pos, if_info->hwaddr, if_info->hwaddr_size);
408 pos += if_info->hwaddr_size;
410 pos += pb_protocol_serialise_string(pos, if_info->name);
412 *(bool *)pos = if_info->link;
416 *(uint32_t *)pos = __cpu_to_be32(sysinfo->n_blockdevs);
417 pos += sizeof(uint32_t);
419 for (i = 0; i < sysinfo->n_blockdevs; i++) {
420 struct blockdev_info *bd_info = sysinfo->blockdevs[i];
422 pos += pb_protocol_serialise_string(pos, bd_info->name);
423 pos += pb_protocol_serialise_string(pos, bd_info->uuid);
424 pos += pb_protocol_serialise_string(pos, bd_info->mountpoint);
427 if (sysinfo->bmc_mac)
428 memcpy(pos, sysinfo->bmc_mac, HWADDR_SIZE);
430 memset(pos, 0, HWADDR_SIZE);
433 assert(pos <= buf + buf_len);
439 static int pb_protocol_serialise_config_interface(char *buf,
440 struct interface_config *conf)
444 memcpy(pos, conf->hwaddr, sizeof(conf->hwaddr));
445 pos += sizeof(conf->hwaddr);
447 *(uint32_t *)pos = conf->ignore;
453 *(uint32_t *)pos = __cpu_to_be32(conf->method);
456 if (conf->method == CONFIG_METHOD_STATIC) {
457 pos += pb_protocol_serialise_string(pos,
458 conf->static_config.address);
459 pos += pb_protocol_serialise_string(pos,
460 conf->static_config.gateway);
461 pos += pb_protocol_serialise_string(pos,
462 conf->static_config.url);
468 int pb_protocol_serialise_config(const struct config *config,
469 char *buf, int buf_len)
474 *(uint32_t *)pos = config->autoboot_enabled;
477 *(uint32_t *)pos = __cpu_to_be32(config->autoboot_timeout_sec);
480 *(uint32_t *)pos = config->safe_mode;
483 *(uint32_t *)pos = __cpu_to_be32(config->network.n_interfaces);
485 for (i = 0; i < config->network.n_interfaces; i++) {
486 struct interface_config *iface =
487 config->network.interfaces[i];
488 pos += pb_protocol_serialise_config_interface(pos, iface);
491 *(uint32_t *)pos = __cpu_to_be32(config->network.n_dns_servers);
493 for (i = 0; i < config->network.n_dns_servers; i++) {
494 pos += pb_protocol_serialise_string(pos,
495 config->network.dns_servers[i]);
498 *(uint32_t *)pos = __cpu_to_be32(config->n_autoboot_opts);
500 for (i = 0; i < config->n_autoboot_opts; i++) {
502 __cpu_to_be32(config->autoboot_opts[i].boot_type);
504 if (config->autoboot_opts[i].boot_type == BOOT_DEVICE_TYPE) {
506 __cpu_to_be32(config->autoboot_opts[i].type);
509 pos += pb_protocol_serialise_string(pos,
510 config->autoboot_opts[i].uuid);
514 *(uint32_t *)pos = __cpu_to_be32(config->ipmi_bootdev);
516 *(uint32_t *)pos = config->ipmi_bootdev_persistent;
519 *(uint32_t *)pos = config->allow_writes;
522 pos += pb_protocol_serialise_string(pos, config->lang);
524 assert(pos <= buf + buf_len);
530 int pb_protocol_serialise_url(const char *url, char *buf, int buf_len)
534 pos += pb_protocol_serialise_string(pos, url);
536 assert(pos <=buf+buf_len);
542 int pb_protocol_write_message(int fd, struct pb_protocol_message *message)
547 total_len = sizeof(*message) + message->payload_len;
549 message->payload_len = __cpu_to_be32(message->payload_len);
550 message->action = __cpu_to_be32(message->action);
552 for (pos = (void *)message; total_len;) {
553 rc = write(fd, pos, total_len);
562 talloc_free(message);
567 pb_log("%s: failed: %s\n", __func__, strerror(errno));
571 struct pb_protocol_message *pb_protocol_create_message(void *ctx,
572 enum pb_protocol_action action, int payload_len)
574 struct pb_protocol_message *message;
576 if (payload_len > PB_PROTOCOL_MAX_PAYLOAD_SIZE) {
577 pb_log("%s: payload too big %u/%u\n", __func__, payload_len,
578 PB_PROTOCOL_MAX_PAYLOAD_SIZE);
582 message = talloc_size(ctx, sizeof(*message) + payload_len);
584 /* we convert these to big-endian in write_message() */
585 message->action = action;
586 message->payload_len = payload_len;
592 struct pb_protocol_message *pb_protocol_read_message(void *ctx, int fd)
594 struct pb_protocol_message *message, m;
598 /* use the stack for the initial 8-byte read */
600 rc = read(fd, &m, sizeof(m));
604 m.payload_len = __be32_to_cpu(m.payload_len);
605 m.action = __be32_to_cpu(m.action);
607 if (m.payload_len > PB_PROTOCOL_MAX_PAYLOAD_SIZE) {
608 pb_log("%s: payload too big %u/%u\n", __func__, m.payload_len,
609 PB_PROTOCOL_MAX_PAYLOAD_SIZE);
613 message = talloc_size(ctx, sizeof(m) + m.payload_len);
614 memcpy(message, &m, sizeof(m));
616 for (len = 0; len < m.payload_len;) {
617 rc = read(fd, message->payload + len, m.payload_len - len);
620 talloc_free(message);
621 pb_log("%s: failed (%u): %s\n", __func__, len,
633 int pb_protocol_deserialise_device(struct device *dev,
634 const struct pb_protocol_message *message)
640 len = message->payload_len;
641 pos = message->payload;
643 if (read_string(dev, &pos, &len, &dev->id))
646 if (len < sizeof(enum device_type))
648 dev->type = *(enum device_type *)(pos);
649 pos += sizeof(enum device_type);
650 len -= sizeof(enum device_type);
652 if (read_string(dev, &pos, &len, &dev->name))
655 if (read_string(dev, &pos, &len, &dev->description))
658 if (read_string(dev, &pos, &len, &dev->icon_file))
667 int pb_protocol_deserialise_boot_option(struct boot_option *opt,
668 const struct pb_protocol_message *message)
674 len = message->payload_len;
675 pos = message->payload;
677 if (read_string(opt, &pos, &len, &opt->device_id))
680 if (read_string(opt, &pos, &len, &opt->id))
683 if (read_string(opt, &pos, &len, &opt->name))
686 if (read_string(opt, &pos, &len, &opt->description))
689 if (read_string(opt, &pos, &len, &opt->icon_file))
692 if (read_string(opt, &pos, &len, &opt->boot_image_file))
695 if (read_string(opt, &pos, &len, &opt->initrd_file))
698 if (read_string(opt, &pos, &len, &opt->dtb_file))
701 if (read_string(opt, &pos, &len, &opt->boot_args))
704 if (len < sizeof(bool))
706 opt->is_default = *(bool *)(pos);
714 int pb_protocol_deserialise_boot_command(struct boot_command *cmd,
715 const struct pb_protocol_message *message)
721 len = message->payload_len;
722 pos = message->payload;
724 if (read_string(cmd, &pos, &len, &cmd->option_id))
727 if (read_string(cmd, &pos, &len, &cmd->boot_image_file))
730 if (read_string(cmd, &pos, &len, &cmd->initrd_file))
733 if (read_string(cmd, &pos, &len, &cmd->dtb_file))
736 if (read_string(cmd, &pos, &len, &cmd->boot_args))
745 int pb_protocol_deserialise_boot_status(struct boot_status *status,
746 const struct pb_protocol_message *message)
752 len = message->payload_len;
753 pos = message->payload;
755 /* first up, the type enum... */
756 if (len < sizeof(uint32_t))
759 status->type = __be32_to_cpu(*(uint32_t *)(pos));
761 switch (status->type) {
762 case BOOT_STATUS_ERROR:
763 case BOOT_STATUS_INFO:
769 pos += sizeof(uint32_t);
770 len -= sizeof(uint32_t);
772 /* message and detail strings */
773 if (read_string(status, &pos, &len, &status->message))
776 if (read_string(status, &pos, &len, &status->detail))
779 /* and finally, progress */
780 if (len < sizeof(uint32_t))
783 status->progress = __be32_to_cpu(*(uint32_t *)(pos));
786 if (status->progress > 100)
787 status->progress = 100;
795 int pb_protocol_deserialise_system_info(struct system_info *sysinfo,
796 const struct pb_protocol_message *message)
802 len = message->payload_len;
803 pos = message->payload;
805 /* type and identifier strings */
806 if (read_string(sysinfo, &pos, &len, &sysinfo->type))
809 if (read_string(sysinfo, &pos, &len, &sysinfo->identifier))
812 /* number of interfaces */
813 if (read_u32(&pos, &len, &sysinfo->n_interfaces))
816 sysinfo->interfaces = talloc_array(sysinfo, struct interface_info *,
817 sysinfo->n_interfaces);
819 for (i = 0; i < sysinfo->n_interfaces; i++) {
820 struct interface_info *if_info = talloc(sysinfo,
821 struct interface_info);
823 if (read_u32(&pos, &len, &if_info->hwaddr_size))
826 if (len < if_info->hwaddr_size)
829 if_info->hwaddr = talloc_memdup(if_info, pos,
830 if_info->hwaddr_size);
831 pos += if_info->hwaddr_size;
832 len -= if_info->hwaddr_size;
834 if (read_string(if_info, &pos, &len, &if_info->name))
837 if_info->link = *(bool *)pos;
838 pos += sizeof(if_info->link);
840 sysinfo->interfaces[i] = if_info;
843 /* number of interfaces */
844 if (read_u32(&pos, &len, &sysinfo->n_blockdevs))
847 sysinfo->blockdevs = talloc_array(sysinfo, struct blockdev_info *,
848 sysinfo->n_blockdevs);
850 for (i = 0; i < sysinfo->n_blockdevs; i++) {
851 struct blockdev_info *bd_info = talloc(sysinfo,
852 struct blockdev_info);
854 if (read_string(bd_info, &pos, &len, &bd_info->name))
857 if (read_string(bd_info, &pos, &len, &bd_info->uuid))
860 if (read_string(bd_info, &pos, &len, &bd_info->mountpoint))
863 sysinfo->blockdevs[i] = bd_info;
866 for (i = 0; i < HWADDR_SIZE; i++) {
868 sysinfo->bmc_mac = talloc_memdup(sysinfo, pos, HWADDR_SIZE);
881 static int pb_protocol_deserialise_config_interface(const char **buf,
882 unsigned int *len, struct interface_config *iface)
886 if (*len < sizeof(iface->hwaddr))
889 memcpy(iface->hwaddr, *buf, sizeof(iface->hwaddr));
890 *buf += sizeof(iface->hwaddr);
891 *len -= sizeof(iface->hwaddr);
893 if (read_u32(buf, len, &tmp))
895 iface->ignore = !!tmp;
900 if (read_u32(buf, len, &iface->method))
903 if (iface->method == CONFIG_METHOD_STATIC) {
904 if (read_string(iface, buf, len, &iface->static_config.address))
907 if (read_string(iface, buf, len, &iface->static_config.gateway))
910 if (read_string(iface, buf, len, &iface->static_config.url))
917 int pb_protocol_deserialise_config(struct config *config,
918 const struct pb_protocol_message *message)
920 unsigned int len, i, tmp;
925 len = message->payload_len;
926 pos = message->payload;
928 if (read_u32(&pos, &len, &tmp))
930 config->autoboot_enabled = !!tmp;
932 if (read_u32(&pos, &len, &config->autoboot_timeout_sec))
935 if (read_u32(&pos, &len, &tmp))
937 config->safe_mode = !!tmp;
939 if (read_u32(&pos, &len, &config->network.n_interfaces))
942 config->network.interfaces = talloc_array(config,
943 struct interface_config *, config->network.n_interfaces);
945 for (i = 0; i < config->network.n_interfaces; i++) {
946 struct interface_config *iface = talloc_zero(
947 config->network.interfaces,
948 struct interface_config);
949 if (pb_protocol_deserialise_config_interface(&pos, &len, iface))
951 config->network.interfaces[i] = iface;
954 if (read_u32(&pos, &len, &config->network.n_dns_servers))
956 config->network.dns_servers = talloc_array(config, const char *,
957 config->network.n_dns_servers);
959 for (i = 0; i < config->network.n_dns_servers; i++) {
960 if (read_string(config->network.dns_servers, &pos, &len, &str))
962 config->network.dns_servers[i] = str;
965 if (read_u32(&pos, &len, &config->n_autoboot_opts))
967 config->autoboot_opts = talloc_array(config, struct autoboot_option,
968 config->n_autoboot_opts);
970 for (i = 0; i < config->n_autoboot_opts; i++) {
971 if (read_u32(&pos, &len, &tmp))
973 config->autoboot_opts[i].boot_type = (int)tmp;
974 if (config->autoboot_opts[i].boot_type == BOOT_DEVICE_TYPE) {
975 if (read_u32(&pos, &len, &tmp))
977 config->autoboot_opts[i].type = tmp;
979 if (read_string(config, &pos, &len, &str))
981 config->autoboot_opts[i].uuid = str;
985 if (read_u32(&pos, &len, &config->ipmi_bootdev))
987 if (read_u32(&pos, &len, &tmp))
989 config->ipmi_bootdev_persistent = !!tmp;
991 if (read_u32(&pos, &len, &tmp))
993 config->allow_writes = !!tmp;
995 if (read_string(config, &pos, &len, &str))