pb_decode.c

   1 /* pb_decode.c -- decode a protobuf using minimal resources
   2  *
   3  * 2011 Petteri Aimonen <jpa@kapsi.fi>
   4  */
   5
   6 /* The warn_unused_result attribute appeared first in gcc-3.4.0 */
   7 #if !defined(__GNUC__) || ( __GNUC__ < 3) || (__GNUC__ == 3 && __GNUC_MINOR__ < 4)
   8     #define checkreturn
   9 #else
  10     /* Verify that we remember to check all return values for proper error propagation */
  11     #define checkreturn __attribute__((warn_unused_result))
  12 #endif
  13
  14 #define NANOPB_INTERNALS
  15 #include "pb.h"
  16 #include "pb_decode.h"
  17
  18 typedef bool (*pb_decoder_t)(pb_istream_t *stream, const pb_field_t *field, void *dest) checkreturn;
  19
  20 /* --- Function pointers to field decoders ---
  21  * Order in the array must match pb_action_t LTYPE numbering.
  22  */
  23 static const pb_decoder_t PB_DECODERS[PB_LTYPES_COUNT] = {
  24     &pb_dec_varint,
  25     &pb_dec_svarint,
  26     &pb_dec_fixed32,
  27     &pb_dec_fixed64,
  28
  29     &pb_dec_bytes,
  30     &pb_dec_string,
  31     &pb_dec_submessage
  32 };
  33
  34 /**************
  35  * pb_istream *
  36  **************/
  37
  38 static bool checkreturn buf_read(pb_istream_t *stream, uint8_t *buf, size_t count)
  39 {
  40     uint8_t *source = (uint8_t*)stream->state;
  41     stream->state = source + count;
  42
  43     if (buf != NULL)
  44     {
  45         while (count--)
  46             *buf++ = *source++;
  47     }
  48
  49     return true;
  50 }
  51
  52 bool checkreturn pb_read(pb_istream_t *stream, uint8_t *buf, size_t count)
  53 {
  54 #ifndef PB_BUFFER_ONLY
  55         if (buf == NULL && stream->callback != buf_read)
  56         {
  57                 /* Skip input bytes */
  58                 uint8_t tmp[16];
  59                 while (count > 16)
  60                 {
  61                         if (!pb_read(stream, tmp, 16))
  62                                 return false;
  63
  64                         count -= 16;
  65                 }
  66
  67                 return pb_read(stream, tmp, count);
  68         }
  69 #endif
  70
  71     if (stream->bytes_left < count)
  72         PB_RETURN_ERROR(stream, "end-of-stream");
  73
  74 #ifndef PB_BUFFER_ONLY
  75     if (!stream->callback(stream, buf, count))
  76         PB_RETURN_ERROR(stream, "io error");
  77 #else
  78     if (!buf_read(stream, buf, count))
  79         return false;
  80 #endif
  81
  82     stream->bytes_left -= count;
  83     return true;
  84 }
  85
  86 pb_istream_t pb_istream_from_buffer(uint8_t *buf, size_t bufsize)
  87 {
  88     pb_istream_t stream;
  89 #ifdef PB_BUFFER_ONLY
  90     stream.callback = NULL;
  91 #else
  92     stream.callback = &buf_read;
  93 #endif
  94     stream.state = buf;
  95     stream.bytes_left = bufsize;
  96 #ifndef PB_NO_ERRMSG
  97     stream.errmsg = NULL;
  98 #endif
  99     return stream;
 100 }
 101
 102 /********************
 103  * Helper functions *
 104  ********************/
 105
 106 static bool checkreturn pb_decode_varint32(pb_istream_t *stream, uint32_t *dest)
 107 {
 108     uint8_t byte;
 109     uint32_t result;
 110
 111     if (!pb_read(stream, &byte, 1))
 112         return false;
 113
 114     if (!(byte & 0x80))
 115     {
 116         /* Quick case, 1 byte value */
 117         result = byte;
 118     }
 119     else
 120     {
 121         /* Multibyte case */
 122         uint8_t bitpos = 7;
 123         result = byte & 0x7F;
 124
 125         do
 126         {
 127             if (bitpos >= 32)
 128                 PB_RETURN_ERROR(stream, "varint overflow");
 129
 130             if (!pb_read(stream, &byte, 1))
 131                 return false;
 132
 133             result |= (uint32_t)(byte & 0x7F) << bitpos;
 134             bitpos = (uint8_t)(bitpos + 7);
 135         } while (byte & 0x80);
 136    }
 137
 138    *dest = result;
 139    return true;
 140 }
 141
 142 bool checkreturn pb_decode_varint(pb_istream_t *stream, uint64_t *dest)
 143 {
 144     uint8_t byte;
 145     uint8_t bitpos = 0;
 146     uint64_t result = 0;
 147
 148     do
 149     {
 150         if (bitpos >= 64)
 151             PB_RETURN_ERROR(stream, "varint overflow");
 152
 153         if (!pb_read(stream, &byte, 1))
 154             return false;
 155
 156         result |= (uint64_t)(byte & 0x7F) << bitpos;
 157         bitpos = (uint8_t)(bitpos + 7);
 158     } while (byte & 0x80);
 159
 160     *dest = result;
 161     return true;
 162 }
 163
 164 bool checkreturn pb_skip_varint(pb_istream_t *stream)
 165 {
 166     uint8_t byte;
 167     do
 168     {
 169         if (!pb_read(stream, &byte, 1))
 170             return false;
 171     } while (byte & 0x80);
 172     return true;
 173 }
 174
 175 bool checkreturn pb_skip_string(pb_istream_t *stream)
 176 {
 177     uint32_t length;
 178     if (!pb_decode_varint32(stream, &length))
 179         return false;
 180
 181     return pb_read(stream, NULL, length);
 182 }
 183
 184 bool checkreturn pb_decode_tag(pb_istream_t *stream, pb_wire_type_t *wire_type, uint32_t *tag, bool *eof)
 185 {
 186     uint32_t temp;
 187     *eof = false;
 188     *wire_type = (pb_wire_type_t) 0;
 189     *tag = 0;
 190
 191     if (!pb_decode_varint32(stream, &temp))
 192     {
 193         if (stream->bytes_left == 0)
 194             *eof = true;
 195
 196         return false;
 197     }
 198
 199     if (temp == 0)
 200     {
 201         *eof = true; /* Special feature: allow 0-terminated messages. */
 202         return false;
 203     }
 204
 205     *tag = temp >> 3;
 206     *wire_type = (pb_wire_type_t)(temp & 7);
 207     return true;
 208 }
 209
 210 bool checkreturn pb_skip_field(pb_istream_t *stream, pb_wire_type_t wire_type)
 211 {
 212     switch (wire_type)
 213     {
 214         case PB_WT_VARINT: return pb_skip_varint(stream);
 215         case PB_WT_64BIT: return pb_read(stream, NULL, 8);
 216         case PB_WT_STRING: return pb_skip_string(stream);
 217         case PB_WT_32BIT: return pb_read(stream, NULL, 4);
 218         default: PB_RETURN_ERROR(stream, "invalid wire_type");
 219     }
 220 }
 221
 222 /* Read a raw value to buffer, for the purpose of passing it to callback as
 223  * a substream. Size is maximum size on call, and actual size on return.
 224  */
 225 static bool checkreturn read_raw_value(pb_istream_t *stream, pb_wire_type_t wire_type, uint8_t *buf, size_t *size)
 226 {
 227     size_t max_size = *size;
 228     switch (wire_type)
 229     {
 230         case PB_WT_VARINT:
 231             *size = 0;
 232             do
 233             {
 234                 (*size)++;
 235                 if (*size > max_size) return false;
 236                 if (!pb_read(stream, buf, 1)) return false;
 237             } while (*buf++ & 0x80);
 238             return true;
 239
 240         case PB_WT_64BIT:
 241             *size = 8;
 242             return pb_read(stream, buf, 8);
 243
 244         case PB_WT_32BIT:
 245             *size = 4;
 246             return pb_read(stream, buf, 4);
 247
 248         default: PB_RETURN_ERROR(stream, "invalid wire_type");
 249     }
 250 }
 251
 252 /* Decode string length from stream and return a substream with limited length.
 253  * Remember to close the substream using pb_close_string_substream().
 254  */
 255 bool checkreturn pb_make_string_substream(pb_istream_t *stream, pb_istream_t *substream)
 256 {
 257     uint32_t size;
 258     if (!pb_decode_varint32(stream, &size))
 259         return false;
 260
 261     *substream = *stream;
 262     if (substream->bytes_left < size)
 263         PB_RETURN_ERROR(stream, "parent stream too short");
 264
 265     substream->bytes_left = size;
 266     stream->bytes_left -= size;
 267     return true;
 268 }
 269
 270 void pb_close_string_substream(pb_istream_t *stream, pb_istream_t *substream)
 271 {
 272     stream->state = substream->state;
 273
 274 #ifndef PB_NO_ERRMSG
 275     stream->errmsg = substream->errmsg;
 276 #endif
 277 }
 278
 279 /* Iterator for pb_field_t list */
 280 typedef struct {
 281     const pb_field_t *start; /* Start of the pb_field_t array */
 282     const pb_field_t *pos; /* Current position of the iterator */
 283     unsigned field_index; /* Zero-based index of the field. */
 284     unsigned required_field_index; /* Zero-based index that counts only the required fields */
 285     void *dest_struct; /* Pointer to the destination structure to decode to */
 286     void *pData; /* Pointer where to store current field value */
 287     void *pSize; /* Pointer where to store the size of current array field */
 288 } pb_field_iterator_t;
 289
 290 static void pb_field_init(pb_field_iterator_t *iter, const pb_field_t *fields, void *dest_struct)
 291 {
 292     iter->start = iter->pos = fields;
 293     iter->field_index = 0;
 294     iter->required_field_index = 0;
 295     iter->pData = (char*)dest_struct + iter->pos->data_offset;
 296     iter->pSize = (char*)iter->pData + iter->pos->size_offset;
 297     iter->dest_struct = dest_struct;
 298 }
 299
 300 static bool pb_field_next(pb_field_iterator_t *iter)
 301 {
 302     bool notwrapped = true;
 303     size_t prev_size = iter->pos->data_size;
 304
 305     if (PB_ATYPE(iter->pos->type) == PB_ATYPE_STATIC &&
 306         PB_HTYPE(iter->pos->type) == PB_HTYPE_REPEATED)
 307     {
 308         prev_size *= iter->pos->array_size;
 309     }
 310
 311     if (PB_HTYPE(iter->pos->type) == PB_HTYPE_REQUIRED)
 312         iter->required_field_index++;
 313
 314     if (iter->pos->tag == 0)
 315         return false; /* Only happens with empty message types */
 316
 317     iter->pos++;
 318     iter->field_index++;
 319     if (iter->pos->tag == 0)
 320     {
 321         iter->pos = iter->start;
 322         iter->field_index = 0;
 323         iter->required_field_index = 0;
 324         iter->pData = iter->dest_struct;
 325         prev_size = 0;
 326         notwrapped = false;
 327     }
 328
 329     iter->pData = (char*)iter->pData + prev_size + iter->pos->data_offset;
 330     iter->pSize = (char*)iter->pData + iter->pos->size_offset;
 331     return notwrapped;
 332 }
 333
 334 static bool checkreturn pb_field_find(pb_field_iterator_t *iter, uint32_t tag)
 335 {
 336     unsigned start = iter->field_index;
 337
 338     do {
 339         if (iter->pos->tag == tag)
 340             return true;
 341         pb_field_next(iter);
 342     } while (iter->field_index != start);
 343
 344     return false;
 345 }
 346
 347 /*************************
 348  * Decode a single field *
 349  *************************/
 350
 351 static bool checkreturn decode_static_field(pb_istream_t *stream, pb_wire_type_t wire_type, pb_field_iterator_t *iter)
 352 {
 353     pb_type_t type;
 354     pb_decoder_t func;
 355
 356     type = iter->pos->type;
 357     func = PB_DECODERS[PB_LTYPE(type)];
 358
 359     switch (PB_HTYPE(type))
 360     {
 361         case PB_HTYPE_REQUIRED:
 362             return func(stream, iter->pos, iter->pData);
 363
 364         case PB_HTYPE_OPTIONAL:
 365             *(bool*)iter->pSize = true;
 366             return func(stream, iter->pos, iter->pData);
 367
 368         case PB_HTYPE_REPEATED:
 369             if (wire_type == PB_WT_STRING
 370                 && PB_LTYPE(type) <= PB_LTYPE_LAST_PACKABLE)
 371             {
 372                 /* Packed array */
 373                 bool status = true;
 374                 size_t *size = (size_t*)iter->pSize;
 375                 pb_istream_t substream;
 376                 if (!pb_make_string_substream(stream, &substream))
 377                     return false;
 378
 379                 while (substream.bytes_left && *size < iter->pos->array_size)
 380                 {
 381                     void *pItem = (uint8_t*)iter->pData + iter->pos->data_size * (*size);
 382                     if (!func(&substream, iter->pos, pItem))
 383                     {
 384                         status = false;
 385                         break;
 386                     }
 387                     (*size)++;
 388                 }
 389                 pb_close_string_substream(stream, &substream);
 390
 391                 if (substream.bytes_left != 0)
 392                     PB_RETURN_ERROR(stream, "array overflow");
 393
 394                 return status;
 395             }
 396             else
 397             {
 398                 /* Repeated field */
 399                 size_t *size = (size_t*)iter->pSize;
 400                 void *pItem = (uint8_t*)iter->pData + iter->pos->data_size * (*size);
 401                 if (*size >= iter->pos->array_size)
 402                     PB_RETURN_ERROR(stream, "array overflow");
 403
 404                 (*size)++;
 405                 return func(stream, iter->pos, pItem);
 406             }
 407
 408         default:
 409             PB_RETURN_ERROR(stream, "invalid field type");
 410     }
 411 }
 412
 413 static bool checkreturn decode_callback_field(pb_istream_t *stream, pb_wire_type_t wire_type, pb_field_iterator_t *iter)
 414 {
 415     pb_callback_t *pCallback = (pb_callback_t*)iter->pData;
 416
 417     if (pCallback->funcs.decode == NULL)
 418         return pb_skip_field(stream, wire_type);
 419
 420     if (wire_type == PB_WT_STRING)
 421     {
 422         pb_istream_t substream;
 423
 424         if (!pb_make_string_substream(stream, &substream))
 425             return false;
 426
 427         while (substream.bytes_left)
 428         {
 429             if (!pCallback->funcs.decode(&substream, iter->pos, pCallback->arg))
 430                 PB_RETURN_ERROR(stream, "callback failed");
 431         }
 432
 433         pb_close_string_substream(stream, &substream);
 434         return true;
 435     }
 436     else
 437     {
 438         /* Copy the single scalar value to stack.
 439          * This is required so that we can limit the stream length,
 440          * which in turn allows to use same callback for packed and
 441          * not-packed fields. */
 442         pb_istream_t substream;
 443         uint8_t buffer[10];
 444         size_t size = sizeof(buffer);
 445
 446         if (!read_raw_value(stream, wire_type, buffer, &size))
 447             return false;
 448         substream = pb_istream_from_buffer(buffer, size);
 449
 450         return pCallback->funcs.decode(&substream, iter->pos, pCallback->arg);
 451     }
 452 }
 453
 454 static bool checkreturn decode_field(pb_istream_t *stream, pb_wire_type_t wire_type, pb_field_iterator_t *iter)
 455 {
 456     switch (PB_ATYPE(iter->pos->type))
 457     {
 458         case PB_ATYPE_STATIC:
 459             return decode_static_field(stream, wire_type, iter);
 460
 461         case PB_ATYPE_CALLBACK:
 462             return decode_callback_field(stream, wire_type, iter);
 463
 464         default:
 465             PB_RETURN_ERROR(stream, "invalid field type");
 466     }
 467 }
 468
 469 /* Initialize message fields to default values, recursively */
 470 static void pb_message_set_to_defaults(const pb_field_t fields[], void *dest_struct)
 471 {
 472     pb_field_iterator_t iter;
 473     pb_field_init(&iter, fields, dest_struct);
 474
 475     /* Initialize size/has fields and apply default values */
 476     do
 477     {
 478         pb_type_t type;
 479         type = iter.pos->type;
 480
 481         if (iter.pos->tag == 0)
 482             continue;
 483
 484         if (PB_ATYPE(type) == PB_ATYPE_STATIC)
 485         {
 486             /* Initialize the size field for optional/repeated fields to 0. */
 487             if (PB_HTYPE(type) == PB_HTYPE_OPTIONAL)
 488             {
 489                 *(bool*)iter.pSize = false;
 490             }
 491             else if (PB_HTYPE(type) == PB_HTYPE_REPEATED)
 492             {
 493                 *(size_t*)iter.pSize = 0;
 494                 continue; /* Array is empty, no need to initialize contents */
 495             }
 496
 497             /* Initialize field contents to default value */
 498             if (PB_LTYPE(iter.pos->type) == PB_LTYPE_SUBMESSAGE)
 499             {
 500                 pb_message_set_to_defaults((const pb_field_t *) iter.pos->ptr, iter.pData);
 501             }
 502             else if (iter.pos->ptr != NULL)
 503             {
 504                 memcpy(iter.pData, iter.pos->ptr, iter.pos->data_size);
 505             }
 506             else
 507             {
 508                 memset(iter.pData, 0, iter.pos->data_size);
 509             }
 510         }
 511         else if (PB_ATYPE(type) == PB_ATYPE_CALLBACK)
 512         {
 513             continue; /* Don't overwrite callback */
 514         }
 515     } while (pb_field_next(&iter));
 516 }
 517
 518 /*********************
 519  * Decode all fields *
 520  *********************/
 521
 522 bool checkreturn pb_decode_noinit(pb_istream_t *stream, const pb_field_t fields[], void *dest_struct)
 523 {
 524     uint8_t fields_seen[(PB_MAX_REQUIRED_FIELDS + 7) / 8] = {0}; /* Used to check for required fields */
 525     pb_field_iterator_t iter;
 526
 527     pb_field_init(&iter, fields, dest_struct);
 528
 529     while (stream->bytes_left)
 530     {
 531         uint32_t tag;
 532         pb_wire_type_t wire_type;
 533         bool eof;
 534
 535         if (!pb_decode_tag(stream, &wire_type, &tag, &eof))
 536         {
 537             if (eof)
 538                 break;
 539             else
 540                 return false;
 541         }
 542
 543         if (!pb_field_find(&iter, tag))
 544         {
 545             /* No match found, skip data */
 546             if (!pb_skip_field(stream, wire_type))
 547                 return false;
 548             continue;
 549         }
 550
 551         if (PB_HTYPE(iter.pos->type) == PB_HTYPE_REQUIRED
 552             && iter.required_field_index < PB_MAX_REQUIRED_FIELDS)
 553         {
 554             fields_seen[iter.required_field_index >> 3] |= (uint8_t)(1 << (iter.required_field_index & 7));
 555         }
 556
 557         if (!decode_field(stream, wire_type, &iter))
 558             return false;
 559     }
 560
 561     /* Check that all required fields were present. */
 562     {
 563         /* First figure out the number of required fields by
 564          * seeking to the end of the field array. Usually we
 565          * are already close to end after decoding.
 566          */
 567         unsigned req_field_count;
 568         pb_type_t last_type;
 569         unsigned i;
 570         do {
 571             req_field_count = iter.required_field_index;
 572             last_type = iter.pos->type;
 573         } while (pb_field_next(&iter));
 574
 575         /* Fixup if last field was also required. */
 576         if (PB_HTYPE(last_type) == PB_HTYPE_REQUIRED && iter.pos->tag)
 577             req_field_count++;
 578
 579         /* Check the whole bytes */
 580         for (i = 0; i < (req_field_count >> 3); i++)
 581         {
 582             if (fields_seen[i] != 0xFF)
 583                 PB_RETURN_ERROR(stream, "missing required field");
 584         }
 585
 586         /* Check the remaining bits */
 587         if (fields_seen[req_field_count >> 3] != (0xFF >> (8 - (req_field_count & 7))))
 588             PB_RETURN_ERROR(stream, "missing required field");
 589     }
 590
 591     return true;
 592 }
 593
 594 bool checkreturn pb_decode(pb_istream_t *stream, const pb_field_t fields[], void *dest_struct)
 595 {
 596     pb_message_set_to_defaults(fields, dest_struct);
 597     return pb_decode_noinit(stream, fields, dest_struct);
 598 }
 599
 600 /* Field decoders */
 601
 602 bool pb_decode_svarint(pb_istream_t *stream, int64_t *dest)
 603 {
 604     uint64_t value;
 605     if (!pb_decode_varint(stream, &value))
 606         return false;
 607
 608     if (value & 1)
 609         *dest = (int64_t)(~(value >> 1));
 610     else
 611         *dest = (int64_t)(value >> 1);
 612
 613     return true;
 614 }
 615
 616 bool pb_decode_fixed32(pb_istream_t *stream, void *dest)
 617 {
 618     #ifdef __BIG_ENDIAN__
 619     uint8_t *bytes = (uint8_t*)dest;
 620     uint8_t lebytes[4];
 621
 622     if (!pb_read(stream, lebytes, 4))
 623         return false;
 624
 625     bytes[0] = lebytes[3];
 626     bytes[1] = lebytes[2];
 627     bytes[2] = lebytes[1];
 628     bytes[3] = lebytes[0];
 629     return true;
 630     #else
 631     return pb_read(stream, (uint8_t*)dest, 4);
 632     #endif
 633 }
 634
 635 bool pb_decode_fixed64(pb_istream_t *stream, void *dest)
 636 {
 637     #ifdef __BIG_ENDIAN__
 638     uint8_t *bytes = (uint8_t*)dest;
 639     uint8_t lebytes[8];
 640
 641     if (!pb_read(stream, lebytes, 8))
 642         return false;
 643
 644     bytes[0] = lebytes[7];
 645     bytes[1] = lebytes[6];
 646     bytes[2] = lebytes[5];
 647     bytes[3] = lebytes[4];
 648     bytes[4] = lebytes[3];
 649     bytes[5] = lebytes[2];
 650     bytes[6] = lebytes[1];
 651     bytes[7] = lebytes[0];
 652     return true;
 653     #else
 654     return pb_read(stream, (uint8_t*)dest, 8);
 655     #endif
 656 }
 657
 658 bool checkreturn pb_dec_varint(pb_istream_t *stream, const pb_field_t *field, void *dest)
 659 {
 660     uint64_t value;
 661     bool status = pb_decode_varint(stream, &value);
 662
 663     switch (field->data_size)
 664     {
 665         case 1: *(uint8_t*)dest = (uint8_t)value; break;
 666         case 2: *(uint16_t*)dest = (uint16_t)value; break;
 667         case 4: *(uint32_t*)dest = (uint32_t)value; break;
 668         case 8: *(uint64_t*)dest = value; break;
 669         default: PB_RETURN_ERROR(stream, "invalid data_size");
 670     }
 671
 672     return status;
 673 }
 674
 675 bool checkreturn pb_dec_svarint(pb_istream_t *stream, const pb_field_t *field, void *dest)
 676 {
 677     int64_t value;
 678     bool status = pb_decode_svarint(stream, &value);
 679
 680     switch (field->data_size)
 681     {
 682         case 4: *(int32_t*)dest = (int32_t)value; break;
 683         case 8: *(int64_t*)dest = value; break;
 684         default: PB_RETURN_ERROR(stream, "invalid data_size");
 685     }
 686
 687     return status;
 688 }
 689
 690 bool checkreturn pb_dec_fixed32(pb_istream_t *stream, const pb_field_t *field, void *dest)
 691 {
 692     UNUSED(field);
 693     return pb_decode_fixed32(stream, dest);
 694 }
 695
 696 bool checkreturn pb_dec_fixed64(pb_istream_t *stream, const pb_field_t *field, void *dest)
 697 {
 698     UNUSED(field);
 699     return pb_decode_fixed64(stream, dest);
 700 }
 701
 702 bool checkreturn pb_dec_bytes(pb_istream_t *stream, const pb_field_t *field, void *dest)
 703 {
 704     pb_bytes_array_t *x = (pb_bytes_array_t*)dest;
 705
 706     uint32_t temp;
 707     if (!pb_decode_varint32(stream, &temp))
 708         return false;
 709     x->size = temp;
 710
 711     /* Check length, noting the space taken by the size_t header. */
 712     if (x->size > field->data_size - offsetof(pb_bytes_array_t, bytes))
 713         PB_RETURN_ERROR(stream, "bytes overflow");
 714
 715     return pb_read(stream, x->bytes, x->size);
 716 }
 717
 718 bool checkreturn pb_dec_string(pb_istream_t *stream, const pb_field_t *field, void *dest)
 719 {
 720     uint32_t size;
 721     bool status;
 722     if (!pb_decode_varint32(stream, &size))
 723         return false;
 724
 725     /* Check length, noting the null terminator */
 726     if (size + 1 > field->data_size)
 727         PB_RETURN_ERROR(stream, "string overflow");
 728
 729     status = pb_read(stream, (uint8_t*)dest, size);
 730     *((uint8_t*)dest + size) = 0;
 731     return status;
 732 }
 733
 734 bool checkreturn pb_dec_submessage(pb_istream_t *stream, const pb_field_t *field, void *dest)
 735 {
 736     bool status;
 737     pb_istream_t substream;
 738     const pb_field_t* submsg_fields = (const pb_field_t*)field->ptr;
 739
 740     if (!pb_make_string_substream(stream, &substream))
 741         return false;
 742
 743     if (field->ptr == NULL)
 744         PB_RETURN_ERROR(stream, "invalid field descriptor");
 745
 746     /* New array entries need to be initialized, while required and optional
 747      * submessages have already been initialized in the top-level pb_decode. */
 748     if (PB_HTYPE(field->type) == PB_HTYPE_REPEATED)
 749         status = pb_decode(&substream, submsg_fields, dest);
 750     else
 751         status = pb_decode_noinit(&substream, submsg_fields, dest);
 752
 753     pb_close_string_substream(stream, &substream);
 754     return status;
 755 }