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 */ +
271 4 /* config->safe_mode */;
274 for (i = 0; i < config->network.n_interfaces; i++)
275 len += pb_protocol_interface_config_len(
276 config->network.interfaces[i]);
279 for (i = 0; i < config->network.n_dns_servers; i++)
280 len += 4 + optional_strlen(config->network.dns_servers[i]);
283 for (i = 0; i < config->n_autoboot_opts; i++) {
284 if (config->autoboot_opts[i].boot_type == BOOT_DEVICE_TYPE)
288 optional_strlen(config->autoboot_opts[i].uuid);
291 len += 4 + 4; /* ipmi_bootdev, ipmi_bootdev_persistent */
293 len += 4; /* allow_writes */
295 len += 4 + optional_strlen(config->lang);
300 int pb_protocol_url_len(const char *url)
302 /* url + length field */
303 return 4 + optional_strlen(url);
306 int pb_protocol_serialise_device(const struct device *dev,
307 char *buf, int buf_len)
311 pos += pb_protocol_serialise_string(pos, dev->id);
312 *(enum device_type *)pos = dev->type;
313 pos += sizeof(enum device_type);
314 pos += pb_protocol_serialise_string(pos, dev->name);
315 pos += pb_protocol_serialise_string(pos, dev->description);
316 pos += pb_protocol_serialise_string(pos, dev->icon_file);
318 assert(pos <= buf + buf_len);
324 int pb_protocol_serialise_boot_option(const struct boot_option *opt,
325 char *buf, int buf_len)
329 pos += pb_protocol_serialise_string(pos, opt->device_id);
330 pos += pb_protocol_serialise_string(pos, opt->id);
331 pos += pb_protocol_serialise_string(pos, opt->name);
332 pos += pb_protocol_serialise_string(pos, opt->description);
333 pos += pb_protocol_serialise_string(pos, opt->icon_file);
334 pos += pb_protocol_serialise_string(pos, opt->boot_image_file);
335 pos += pb_protocol_serialise_string(pos, opt->initrd_file);
336 pos += pb_protocol_serialise_string(pos, opt->dtb_file);
337 pos += pb_protocol_serialise_string(pos, opt->boot_args);
339 *(bool *)pos = opt->is_default;
342 assert(pos <= buf + buf_len);
348 int pb_protocol_serialise_boot_command(const struct boot_command *boot,
349 char *buf, int buf_len)
353 pos += pb_protocol_serialise_string(pos, boot->option_id);
354 pos += pb_protocol_serialise_string(pos, boot->boot_image_file);
355 pos += pb_protocol_serialise_string(pos, boot->initrd_file);
356 pos += pb_protocol_serialise_string(pos, boot->dtb_file);
357 pos += pb_protocol_serialise_string(pos, boot->boot_args);
359 assert(pos <= buf + buf_len);
365 int pb_protocol_serialise_boot_status(const struct boot_status *status,
366 char *buf, int buf_len)
370 *(uint32_t *)pos = __cpu_to_be32(status->type);
371 pos += sizeof(uint32_t);
373 pos += pb_protocol_serialise_string(pos, status->message);
374 pos += pb_protocol_serialise_string(pos, status->detail);
376 *(uint32_t *)pos = __cpu_to_be32(status->type);
377 pos += sizeof(uint32_t);
379 assert(pos <= buf + buf_len);
385 int pb_protocol_serialise_system_info(const struct system_info *sysinfo,
386 char *buf, int buf_len)
391 pos += pb_protocol_serialise_string(pos, sysinfo->type);
392 pos += pb_protocol_serialise_string(pos, sysinfo->identifier);
394 *(uint32_t *)pos = __cpu_to_be32(sysinfo->n_interfaces);
395 pos += sizeof(uint32_t);
397 for (i = 0; i < sysinfo->n_interfaces; i++) {
398 struct interface_info *if_info = sysinfo->interfaces[i];
400 *(uint32_t *)pos = __cpu_to_be32(if_info->hwaddr_size);
401 pos += sizeof(uint32_t);
403 memcpy(pos, if_info->hwaddr, if_info->hwaddr_size);
404 pos += if_info->hwaddr_size;
406 pos += pb_protocol_serialise_string(pos, if_info->name);
408 *(bool *)pos = if_info->link;
412 *(uint32_t *)pos = __cpu_to_be32(sysinfo->n_blockdevs);
413 pos += sizeof(uint32_t);
415 for (i = 0; i < sysinfo->n_blockdevs; i++) {
416 struct blockdev_info *bd_info = sysinfo->blockdevs[i];
418 pos += pb_protocol_serialise_string(pos, bd_info->name);
419 pos += pb_protocol_serialise_string(pos, bd_info->uuid);
420 pos += pb_protocol_serialise_string(pos, bd_info->mountpoint);
423 assert(pos <= buf + buf_len);
429 static int pb_protocol_serialise_config_interface(char *buf,
430 struct interface_config *conf)
434 memcpy(pos, conf->hwaddr, sizeof(conf->hwaddr));
435 pos += sizeof(conf->hwaddr);
437 *(uint32_t *)pos = conf->ignore;
443 *(uint32_t *)pos = __cpu_to_be32(conf->method);
446 if (conf->method == CONFIG_METHOD_STATIC) {
447 pos += pb_protocol_serialise_string(pos,
448 conf->static_config.address);
449 pos += pb_protocol_serialise_string(pos,
450 conf->static_config.gateway);
456 int pb_protocol_serialise_config(const struct config *config,
457 char *buf, int buf_len)
462 *(uint32_t *)pos = config->autoboot_enabled;
465 *(uint32_t *)pos = __cpu_to_be32(config->autoboot_timeout_sec);
468 *(uint32_t *)pos = config->safe_mode;
471 *(uint32_t *)pos = __cpu_to_be32(config->network.n_interfaces);
473 for (i = 0; i < config->network.n_interfaces; i++) {
474 struct interface_config *iface =
475 config->network.interfaces[i];
476 pos += pb_protocol_serialise_config_interface(pos, iface);
479 *(uint32_t *)pos = __cpu_to_be32(config->network.n_dns_servers);
481 for (i = 0; i < config->network.n_dns_servers; i++) {
482 pos += pb_protocol_serialise_string(pos,
483 config->network.dns_servers[i]);
486 *(uint32_t *)pos = __cpu_to_be32(config->n_autoboot_opts);
488 for (i = 0; i < config->n_autoboot_opts; i++) {
490 __cpu_to_be32(config->autoboot_opts[i].boot_type);
492 if (config->autoboot_opts[i].boot_type == BOOT_DEVICE_TYPE) {
494 __cpu_to_be32(config->autoboot_opts[i].type);
497 pos += pb_protocol_serialise_string(pos,
498 config->autoboot_opts[i].uuid);
502 *(uint32_t *)pos = __cpu_to_be32(config->ipmi_bootdev);
504 *(uint32_t *)pos = config->ipmi_bootdev_persistent;
507 *(uint32_t *)pos = config->allow_writes;
510 pos += pb_protocol_serialise_string(pos, config->lang);
512 assert(pos <= buf + buf_len);
518 int pb_protocol_serialise_url(const char *url, char *buf, int buf_len)
522 pos += pb_protocol_serialise_string(pos, url);
524 assert(pos <=buf+buf_len);
530 int pb_protocol_write_message(int fd, struct pb_protocol_message *message)
535 total_len = sizeof(*message) + message->payload_len;
537 message->payload_len = __cpu_to_be32(message->payload_len);
538 message->action = __cpu_to_be32(message->action);
540 for (pos = (void *)message; total_len;) {
541 rc = write(fd, pos, total_len);
550 talloc_free(message);
555 pb_log("%s: failed: %s\n", __func__, strerror(errno));
559 struct pb_protocol_message *pb_protocol_create_message(void *ctx,
560 enum pb_protocol_action action, int payload_len)
562 struct pb_protocol_message *message;
564 if (payload_len > PB_PROTOCOL_MAX_PAYLOAD_SIZE) {
565 pb_log("%s: payload too big %u/%u\n", __func__, payload_len,
566 PB_PROTOCOL_MAX_PAYLOAD_SIZE);
570 message = talloc_size(ctx, sizeof(*message) + payload_len);
572 /* we convert these to big-endian in write_message() */
573 message->action = action;
574 message->payload_len = payload_len;
580 struct pb_protocol_message *pb_protocol_read_message(void *ctx, int fd)
582 struct pb_protocol_message *message, m;
586 /* use the stack for the initial 8-byte read */
588 rc = read(fd, &m, sizeof(m));
592 m.payload_len = __be32_to_cpu(m.payload_len);
593 m.action = __be32_to_cpu(m.action);
595 if (m.payload_len > PB_PROTOCOL_MAX_PAYLOAD_SIZE) {
596 pb_log("%s: payload too big %u/%u\n", __func__, m.payload_len,
597 PB_PROTOCOL_MAX_PAYLOAD_SIZE);
601 message = talloc_size(ctx, sizeof(m) + m.payload_len);
602 memcpy(message, &m, sizeof(m));
604 for (len = 0; len < m.payload_len;) {
605 rc = read(fd, message->payload + len, m.payload_len - len);
608 talloc_free(message);
609 pb_log("%s: failed (%u): %s\n", __func__, len,
621 int pb_protocol_deserialise_device(struct device *dev,
622 const struct pb_protocol_message *message)
628 len = message->payload_len;
629 pos = message->payload;
631 if (read_string(dev, &pos, &len, &dev->id))
634 if (len < sizeof(enum device_type))
636 dev->type = *(enum device_type *)(pos);
637 pos += sizeof(enum device_type);
638 len -= sizeof(enum device_type);
640 if (read_string(dev, &pos, &len, &dev->name))
643 if (read_string(dev, &pos, &len, &dev->description))
646 if (read_string(dev, &pos, &len, &dev->icon_file))
655 int pb_protocol_deserialise_boot_option(struct boot_option *opt,
656 const struct pb_protocol_message *message)
662 len = message->payload_len;
663 pos = message->payload;
665 if (read_string(opt, &pos, &len, &opt->device_id))
668 if (read_string(opt, &pos, &len, &opt->id))
671 if (read_string(opt, &pos, &len, &opt->name))
674 if (read_string(opt, &pos, &len, &opt->description))
677 if (read_string(opt, &pos, &len, &opt->icon_file))
680 if (read_string(opt, &pos, &len, &opt->boot_image_file))
683 if (read_string(opt, &pos, &len, &opt->initrd_file))
686 if (read_string(opt, &pos, &len, &opt->dtb_file))
689 if (read_string(opt, &pos, &len, &opt->boot_args))
692 if (len < sizeof(bool))
694 opt->is_default = *(bool *)(pos);
702 int pb_protocol_deserialise_boot_command(struct boot_command *cmd,
703 const struct pb_protocol_message *message)
709 len = message->payload_len;
710 pos = message->payload;
712 if (read_string(cmd, &pos, &len, &cmd->option_id))
715 if (read_string(cmd, &pos, &len, &cmd->boot_image_file))
718 if (read_string(cmd, &pos, &len, &cmd->initrd_file))
721 if (read_string(cmd, &pos, &len, &cmd->dtb_file))
724 if (read_string(cmd, &pos, &len, &cmd->boot_args))
733 int pb_protocol_deserialise_boot_status(struct boot_status *status,
734 const struct pb_protocol_message *message)
740 len = message->payload_len;
741 pos = message->payload;
743 /* first up, the type enum... */
744 if (len < sizeof(uint32_t))
747 status->type = __be32_to_cpu(*(uint32_t *)(pos));
749 switch (status->type) {
750 case BOOT_STATUS_ERROR:
751 case BOOT_STATUS_INFO:
757 pos += sizeof(uint32_t);
758 len -= sizeof(uint32_t);
760 /* message and detail strings */
761 if (read_string(status, &pos, &len, &status->message))
764 if (read_string(status, &pos, &len, &status->detail))
767 /* and finally, progress */
768 if (len < sizeof(uint32_t))
771 status->progress = __be32_to_cpu(*(uint32_t *)(pos));
774 if (status->progress > 100)
775 status->progress = 100;
783 int pb_protocol_deserialise_system_info(struct system_info *sysinfo,
784 const struct pb_protocol_message *message)
790 len = message->payload_len;
791 pos = message->payload;
793 /* type and identifier strings */
794 if (read_string(sysinfo, &pos, &len, &sysinfo->type))
797 if (read_string(sysinfo, &pos, &len, &sysinfo->identifier))
800 /* number of interfaces */
801 if (read_u32(&pos, &len, &sysinfo->n_interfaces))
804 sysinfo->interfaces = talloc_array(sysinfo, struct interface_info *,
805 sysinfo->n_interfaces);
807 for (i = 0; i < sysinfo->n_interfaces; i++) {
808 struct interface_info *if_info = talloc(sysinfo,
809 struct interface_info);
811 if (read_u32(&pos, &len, &if_info->hwaddr_size))
814 if (len < if_info->hwaddr_size)
817 if_info->hwaddr = talloc_memdup(if_info, pos,
818 if_info->hwaddr_size);
819 pos += if_info->hwaddr_size;
820 len -= if_info->hwaddr_size;
822 if (read_string(if_info, &pos, &len, &if_info->name))
825 if_info->link = *(bool *)pos;
826 pos += sizeof(if_info->link);
828 sysinfo->interfaces[i] = if_info;
831 /* number of interfaces */
832 if (read_u32(&pos, &len, &sysinfo->n_blockdevs))
835 sysinfo->blockdevs = talloc_array(sysinfo, struct blockdev_info *,
836 sysinfo->n_blockdevs);
838 for (i = 0; i < sysinfo->n_blockdevs; i++) {
839 struct blockdev_info *bd_info = talloc(sysinfo,
840 struct blockdev_info);
842 if (read_string(bd_info, &pos, &len, &bd_info->name))
845 if (read_string(bd_info, &pos, &len, &bd_info->uuid))
848 if (read_string(bd_info, &pos, &len, &bd_info->mountpoint))
851 sysinfo->blockdevs[i] = bd_info;
859 static int pb_protocol_deserialise_config_interface(const char **buf,
860 unsigned int *len, struct interface_config *iface)
864 if (*len < sizeof(iface->hwaddr))
867 memcpy(iface->hwaddr, *buf, sizeof(iface->hwaddr));
868 *buf += sizeof(iface->hwaddr);
869 *len -= sizeof(iface->hwaddr);
871 if (read_u32(buf, len, &tmp))
873 iface->ignore = !!tmp;
878 if (read_u32(buf, len, &iface->method))
881 if (iface->method == CONFIG_METHOD_STATIC) {
882 if (read_string(iface, buf, len, &iface->static_config.address))
885 if (read_string(iface, buf, len, &iface->static_config.gateway))
892 int pb_protocol_deserialise_config(struct config *config,
893 const struct pb_protocol_message *message)
895 unsigned int len, i, tmp;
900 len = message->payload_len;
901 pos = message->payload;
903 if (read_u32(&pos, &len, &tmp))
905 config->autoboot_enabled = !!tmp;
907 if (read_u32(&pos, &len, &config->autoboot_timeout_sec))
910 if (read_u32(&pos, &len, &tmp))
912 config->safe_mode = !!tmp;
914 if (read_u32(&pos, &len, &config->network.n_interfaces))
917 config->network.interfaces = talloc_array(config,
918 struct interface_config *, config->network.n_interfaces);
920 for (i = 0; i < config->network.n_interfaces; i++) {
921 struct interface_config *iface = talloc_zero(
922 config->network.interfaces,
923 struct interface_config);
924 if (pb_protocol_deserialise_config_interface(&pos, &len, iface))
926 config->network.interfaces[i] = iface;
929 if (read_u32(&pos, &len, &config->network.n_dns_servers))
931 config->network.dns_servers = talloc_array(config, const char *,
932 config->network.n_dns_servers);
934 for (i = 0; i < config->network.n_dns_servers; i++) {
935 if (read_string(config->network.dns_servers, &pos, &len, &str))
937 config->network.dns_servers[i] = str;
940 if (read_u32(&pos, &len, &config->n_autoboot_opts))
942 config->autoboot_opts = talloc_array(config, struct autoboot_option,
943 config->n_autoboot_opts);
945 for (i = 0; i < config->n_autoboot_opts; i++) {
946 if (read_u32(&pos, &len, &tmp))
948 config->autoboot_opts[i].boot_type = (int)tmp;
949 if (config->autoboot_opts[i].boot_type == BOOT_DEVICE_TYPE) {
950 if (read_u32(&pos, &len, &tmp))
952 config->autoboot_opts[i].type = tmp;
954 if (read_string(config, &pos, &len, &str))
956 config->autoboot_opts[i].uuid = str;
960 if (read_u32(&pos, &len, &config->ipmi_bootdev))
962 if (read_u32(&pos, &len, &tmp))
964 config->ipmi_bootdev_persistent = !!tmp;
966 if (read_u32(&pos, &len, &tmp))
968 config->allow_writes = !!tmp;
970 if (read_string(config, &pos, &len, &str))