pb_decode.c

   1 /* pb_decode.c -- decode a protobuf using minimal resources
   2  *
   3  * 2011 Petteri Aimonen <jpa@kapsi.fi>
   4  */
   5
   6 /* Use the GCC warn_unused_result attribute to check that all return values
   7  * are propagated correctly. On other compilers and gcc before 3.4.0 just
   8  * ignore the annotation.
   9  */
  10 #if !defined(__GNUC__) || ( __GNUC__ < 3) || (__GNUC__ == 3 && __GNUC_MINOR__ < 4)
  11     #define checkreturn
  12 #else
  13     #define checkreturn __attribute__((warn_unused_result))
  14 #endif
  15
  16 #define NANOPB_INTERNALS
  17 #include "pb.h"
  18 #include "pb_decode.h"
  19
  20 /**************************************
  21  * Declarations internal to this file *
  22  **************************************/
  23
  24 /* Iterator for pb_field_t list */
  25 typedef struct {
  26     const pb_field_t *start; /* Start of the pb_field_t array */
  27     const pb_field_t *pos; /* Current position of the iterator */
  28     unsigned field_index; /* Zero-based index of the field. */
  29     unsigned required_field_index; /* Zero-based index that counts only the required fields */
  30     void *dest_struct; /* Pointer to the destination structure to decode to */
  31     void *pData; /* Pointer where to store current field value */
  32     void *pSize; /* Pointer where to store the size of current array field */
  33 } pb_field_iterator_t;
  34
  35 typedef bool (*pb_decoder_t)(pb_istream_t *stream, const pb_field_t *field, void *dest) checkreturn;
  36
  37 static bool checkreturn buf_read(pb_istream_t *stream, uint8_t *buf, size_t count);
  38 static bool checkreturn pb_decode_varint32(pb_istream_t *stream, uint32_t *dest);
  39 static bool checkreturn read_raw_value(pb_istream_t *stream, pb_wire_type_t wire_type, uint8_t *buf, size_t *size);
  40 static void pb_field_init(pb_field_iterator_t *iter, const pb_field_t *fields, void *dest_struct);
  41 static bool pb_field_next(pb_field_iterator_t *iter);
  42 static bool checkreturn pb_field_find(pb_field_iterator_t *iter, uint32_t tag);
  43 static bool checkreturn decode_static_field(pb_istream_t *stream, pb_wire_type_t wire_type, pb_field_iterator_t *iter);
  44 static bool checkreturn decode_callback_field(pb_istream_t *stream, pb_wire_type_t wire_type, pb_field_iterator_t *iter);
  45 static bool checkreturn decode_field(pb_istream_t *stream, pb_wire_type_t wire_type, pb_field_iterator_t *iter);
  46 static bool checkreturn default_extension_decoder(pb_istream_t *stream, pb_extension_t *extension, uint32_t tag, pb_wire_type_t wire_type);
  47 static bool checkreturn decode_extension(pb_istream_t *stream, uint32_t tag, pb_wire_type_t wire_type, pb_field_iterator_t *iter);
  48 static bool checkreturn find_extension_field(pb_field_iterator_t *iter);
  49 static void pb_message_set_to_defaults(const pb_field_t fields[], void *dest_struct);
  50 static bool checkreturn pb_dec_varint(pb_istream_t *stream, const pb_field_t *field, void *dest);
  51 static bool checkreturn pb_dec_uvarint(pb_istream_t *stream, const pb_field_t *field, void *dest);
  52 static bool checkreturn pb_dec_svarint(pb_istream_t *stream, const pb_field_t *field, void *dest);
  53 static bool checkreturn pb_dec_fixed32(pb_istream_t *stream, const pb_field_t *field, void *dest);
  54 static bool checkreturn pb_dec_fixed64(pb_istream_t *stream, const pb_field_t *field, void *dest);
  55 static bool checkreturn pb_dec_bytes(pb_istream_t *stream, const pb_field_t *field, void *dest);
  56 static bool checkreturn pb_dec_string(pb_istream_t *stream, const pb_field_t *field, void *dest);
  57 static bool checkreturn pb_dec_submessage(pb_istream_t *stream, const pb_field_t *field, void *dest);
  58 static bool checkreturn pb_skip_varint(pb_istream_t *stream);
  59 static bool checkreturn pb_skip_string(pb_istream_t *stream);
  60
  61 /* --- Function pointers to field decoders ---
  62  * Order in the array must match pb_action_t LTYPE numbering.
  63  */
  64 static const pb_decoder_t PB_DECODERS[PB_LTYPES_COUNT] = {
  65     &pb_dec_varint,
  66     &pb_dec_uvarint,
  67     &pb_dec_svarint,
  68     &pb_dec_fixed32,
  69     &pb_dec_fixed64,
  70
  71     &pb_dec_bytes,
  72     &pb_dec_string,
  73     &pb_dec_submessage,
  74     NULL /* extensions */
  75 };
  76
  77 /*******************************
  78  * pb_istream_t implementation *
  79  *******************************/
  80
  81 static bool checkreturn buf_read(pb_istream_t *stream, uint8_t *buf, size_t count)
  82 {
  83     uint8_t *source = (uint8_t*)stream->state;
  84     stream->state = source + count;
  85
  86     if (buf != NULL)
  87     {
  88         while (count--)
  89             *buf++ = *source++;
  90     }
  91
  92     return true;
  93 }
  94
  95 bool checkreturn pb_read(pb_istream_t *stream, uint8_t *buf, size_t count)
  96 {
  97 #ifndef PB_BUFFER_ONLY
  98         if (buf == NULL && stream->callback != buf_read)
  99         {
 100                 /* Skip input bytes */
 101                 uint8_t tmp[16];
 102                 while (count > 16)
 103                 {
 104                         if (!pb_read(stream, tmp, 16))
 105                                 return false;
 106
 107                         count -= 16;
 108                 }
 109
 110                 return pb_read(stream, tmp, count);
 111         }
 112 #endif
 113
 114     if (stream->bytes_left < count)
 115         PB_RETURN_ERROR(stream, "end-of-stream");
 116
 117 #ifndef PB_BUFFER_ONLY
 118     if (!stream->callback(stream, buf, count))
 119         PB_RETURN_ERROR(stream, "io error");
 120 #else
 121     if (!buf_read(stream, buf, count))
 122         return false;
 123 #endif
 124
 125     stream->bytes_left -= count;
 126     return true;
 127 }
 128
 129 /* Read a single byte from input stream. buf may not be NULL.
 130  * This is an optimization for the varint decoding. */
 131 static bool checkreturn pb_readbyte(pb_istream_t *stream, uint8_t *buf)
 132 {
 133     if (!stream->bytes_left)
 134         PB_RETURN_ERROR(stream, "end-of-stream");
 135
 136 #ifndef PB_BUFFER_ONLY
 137     if (!stream->callback(stream, buf, 1))
 138         PB_RETURN_ERROR(stream, "io error");
 139 #else
 140     *buf = *(uint8_t*)stream->state;
 141     stream->state = (uint8_t*)stream->state + 1;
 142 #endif
 143
 144     stream->bytes_left--;
 145
 146     return true;
 147 }
 148
 149 pb_istream_t pb_istream_from_buffer(uint8_t *buf, size_t bufsize)
 150 {
 151     pb_istream_t stream;
 152 #ifdef PB_BUFFER_ONLY
 153     stream.callback = NULL;
 154 #else
 155     stream.callback = &buf_read;
 156 #endif
 157     stream.state = buf;
 158     stream.bytes_left = bufsize;
 159 #ifndef PB_NO_ERRMSG
 160     stream.errmsg = NULL;
 161 #endif
 162     return stream;
 163 }
 164
 165 /********************
 166  * Helper functions *
 167  ********************/
 168
 169 static bool checkreturn pb_decode_varint32(pb_istream_t *stream, uint32_t *dest)
 170 {
 171     uint8_t byte;
 172     uint32_t result;
 173
 174     if (!pb_readbyte(stream, &byte))
 175         return false;
 176
 177     if (!(byte & 0x80))
 178     {
 179         /* Quick case, 1 byte value */
 180         result = byte;
 181     }
 182     else
 183     {
 184         /* Multibyte case */
 185         uint8_t bitpos = 7;
 186         result = byte & 0x7F;
 187
 188         do
 189         {
 190             if (bitpos >= 32)
 191                 PB_RETURN_ERROR(stream, "varint overflow");
 192
 193             if (!pb_readbyte(stream, &byte))
 194                 return false;
 195
 196             result |= (uint32_t)(byte & 0x7F) << bitpos;
 197             bitpos = (uint8_t)(bitpos + 7);
 198         } while (byte & 0x80);
 199    }
 200
 201    *dest = result;
 202    return true;
 203 }
 204
 205 bool checkreturn pb_decode_varint(pb_istream_t *stream, uint64_t *dest)
 206 {
 207     uint8_t byte;
 208     uint8_t bitpos = 0;
 209     uint64_t result = 0;
 210
 211     do
 212     {
 213         if (bitpos >= 64)
 214             PB_RETURN_ERROR(stream, "varint overflow");
 215
 216         if (!pb_readbyte(stream, &byte))
 217             return false;
 218
 219         result |= (uint64_t)(byte & 0x7F) << bitpos;
 220         bitpos = (uint8_t)(bitpos + 7);
 221     } while (byte & 0x80);
 222
 223     *dest = result;
 224     return true;
 225 }
 226
 227 bool checkreturn pb_skip_varint(pb_istream_t *stream)
 228 {
 229     uint8_t byte;
 230     do
 231     {
 232         if (!pb_read(stream, &byte, 1))
 233             return false;
 234     } while (byte & 0x80);
 235     return true;
 236 }
 237
 238 bool checkreturn pb_skip_string(pb_istream_t *stream)
 239 {
 240     uint32_t length;
 241     if (!pb_decode_varint32(stream, &length))
 242         return false;
 243
 244     return pb_read(stream, NULL, length);
 245 }
 246
 247 bool checkreturn pb_decode_tag(pb_istream_t *stream, pb_wire_type_t *wire_type, uint32_t *tag, bool *eof)
 248 {
 249     uint32_t temp;
 250     *eof = false;
 251     *wire_type = (pb_wire_type_t) 0;
 252     *tag = 0;
 253
 254     if (!pb_decode_varint32(stream, &temp))
 255     {
 256         if (stream->bytes_left == 0)
 257             *eof = true;
 258
 259         return false;
 260     }
 261
 262     if (temp == 0)
 263     {
 264         *eof = true; /* Special feature: allow 0-terminated messages. */
 265         return false;
 266     }
 267
 268     *tag = temp >> 3;
 269     *wire_type = (pb_wire_type_t)(temp & 7);
 270     return true;
 271 }
 272
 273 bool checkreturn pb_skip_field(pb_istream_t *stream, pb_wire_type_t wire_type)
 274 {
 275     switch (wire_type)
 276     {
 277         case PB_WT_VARINT: return pb_skip_varint(stream);
 278         case PB_WT_64BIT: return pb_read(stream, NULL, 8);
 279         case PB_WT_STRING: return pb_skip_string(stream);
 280         case PB_WT_32BIT: return pb_read(stream, NULL, 4);
 281         default: PB_RETURN_ERROR(stream, "invalid wire_type");
 282     }
 283 }
 284
 285 /* Read a raw value to buffer, for the purpose of passing it to callback as
 286  * a substream. Size is maximum size on call, and actual size on return.
 287  */
 288 static bool checkreturn read_raw_value(pb_istream_t *stream, pb_wire_type_t wire_type, uint8_t *buf, size_t *size)
 289 {
 290     size_t max_size = *size;
 291     switch (wire_type)
 292     {
 293         case PB_WT_VARINT:
 294             *size = 0;
 295             do
 296             {
 297                 (*size)++;
 298                 if (*size > max_size) return false;
 299                 if (!pb_read(stream, buf, 1)) return false;
 300             } while (*buf++ & 0x80);
 301             return true;
 302
 303         case PB_WT_64BIT:
 304             *size = 8;
 305             return pb_read(stream, buf, 8);
 306
 307         case PB_WT_32BIT:
 308             *size = 4;
 309             return pb_read(stream, buf, 4);
 310
 311         default: PB_RETURN_ERROR(stream, "invalid wire_type");
 312     }
 313 }
 314
 315 /* Decode string length from stream and return a substream with limited length.
 316  * Remember to close the substream using pb_close_string_substream().
 317  */
 318 bool checkreturn pb_make_string_substream(pb_istream_t *stream, pb_istream_t *substream)
 319 {
 320     uint32_t size;
 321     if (!pb_decode_varint32(stream, &size))
 322         return false;
 323
 324     *substream = *stream;
 325     if (substream->bytes_left < size)
 326         PB_RETURN_ERROR(stream, "parent stream too short");
 327
 328     substream->bytes_left = size;
 329     stream->bytes_left -= size;
 330     return true;
 331 }
 332
 333 void pb_close_string_substream(pb_istream_t *stream, pb_istream_t *substream)
 334 {
 335     stream->state = substream->state;
 336
 337 #ifndef PB_NO_ERRMSG
 338     stream->errmsg = substream->errmsg;
 339 #endif
 340 }
 341
 342 static void pb_field_init(pb_field_iterator_t *iter, const pb_field_t *fields, void *dest_struct)
 343 {
 344     iter->start = iter->pos = fields;
 345     iter->field_index = 0;
 346     iter->required_field_index = 0;
 347     iter->pData = (char*)dest_struct + iter->pos->data_offset;
 348     iter->pSize = (char*)iter->pData + iter->pos->size_offset;
 349     iter->dest_struct = dest_struct;
 350 }
 351
 352 static bool pb_field_next(pb_field_iterator_t *iter)
 353 {
 354     bool notwrapped = true;
 355     size_t prev_size = iter->pos->data_size;
 356
 357     if (PB_ATYPE(iter->pos->type) == PB_ATYPE_STATIC &&
 358         PB_HTYPE(iter->pos->type) == PB_HTYPE_REPEATED)
 359     {
 360         prev_size *= iter->pos->array_size;
 361     }
 362     else if (PB_ATYPE(iter->pos->type) == PB_ATYPE_POINTER)
 363     {
 364         prev_size = sizeof(void*);
 365     }
 366
 367     if (iter->pos->tag == 0)
 368         return false; /* Only happens with empty message types */
 369
 370     if (PB_HTYPE(iter->pos->type) == PB_HTYPE_REQUIRED)
 371         iter->required_field_index++;
 372
 373     iter->pos++;
 374     iter->field_index++;
 375     if (iter->pos->tag == 0)
 376     {
 377         iter->pos = iter->start;
 378         iter->field_index = 0;
 379         iter->required_field_index = 0;
 380         iter->pData = iter->dest_struct;
 381         prev_size = 0;
 382         notwrapped = false;
 383     }
 384
 385     iter->pData = (char*)iter->pData + prev_size + iter->pos->data_offset;
 386     iter->pSize = (char*)iter->pData + iter->pos->size_offset;
 387     return notwrapped;
 388 }
 389
 390 static bool checkreturn pb_field_find(pb_field_iterator_t *iter, uint32_t tag)
 391 {
 392     unsigned start = iter->field_index;
 393
 394     do {
 395         if (iter->pos->tag == tag &&
 396             PB_LTYPE(iter->pos->type) != PB_LTYPE_EXTENSION)
 397         {
 398             return true;
 399         }
 400         pb_field_next(iter);
 401     } while (iter->field_index != start);
 402
 403     return false;
 404 }
 405
 406 /*************************
 407  * Decode a single field *
 408  *************************/
 409
 410 static bool checkreturn decode_static_field(pb_istream_t *stream, pb_wire_type_t wire_type, pb_field_iterator_t *iter)
 411 {
 412     pb_type_t type;
 413     pb_decoder_t func;
 414
 415     type = iter->pos->type;
 416     func = PB_DECODERS[PB_LTYPE(type)];
 417
 418     switch (PB_HTYPE(type))
 419     {
 420         case PB_HTYPE_REQUIRED:
 421             return func(stream, iter->pos, iter->pData);
 422
 423         case PB_HTYPE_OPTIONAL:
 424             *(bool*)iter->pSize = true;
 425             return func(stream, iter->pos, iter->pData);
 426
 427         case PB_HTYPE_REPEATED:
 428             if (wire_type == PB_WT_STRING
 429                 && PB_LTYPE(type) <= PB_LTYPE_LAST_PACKABLE)
 430             {
 431                 /* Packed array */
 432                 bool status = true;
 433                 size_t *size = (size_t*)iter->pSize;
 434                 pb_istream_t substream;
 435                 if (!pb_make_string_substream(stream, &substream))
 436                     return false;
 437
 438                 while (substream.bytes_left && *size < iter->pos->array_size)
 439                 {
 440                     void *pItem = (uint8_t*)iter->pData + iter->pos->data_size * (*size);
 441                     if (!func(&substream, iter->pos, pItem))
 442                     {
 443                         status = false;
 444                         break;
 445                     }
 446                     (*size)++;
 447                 }
 448                 pb_close_string_substream(stream, &substream);
 449
 450                 if (substream.bytes_left != 0)
 451                     PB_RETURN_ERROR(stream, "array overflow");
 452
 453                 return status;
 454             }
 455             else
 456             {
 457                 /* Repeated field */
 458                 size_t *size = (size_t*)iter->pSize;
 459                 void *pItem = (uint8_t*)iter->pData + iter->pos->data_size * (*size);
 460                 if (*size >= iter->pos->array_size)
 461                     PB_RETURN_ERROR(stream, "array overflow");
 462
 463                 (*size)++;
 464                 return func(stream, iter->pos, pItem);
 465             }
 466
 467         default:
 468             PB_RETURN_ERROR(stream, "invalid field type");
 469     }
 470 }
 471
 472 #ifdef PB_ENABLE_MALLOC
 473 /* Allocate storage for the field and store the pointer at iter->pData.
 474  * array_size is the number of entries to reserve in an array. */
 475 static bool checkreturn allocate_field(pb_istream_t *stream, void *pData, size_t data_size, size_t array_size)
 476 {
 477     void *ptr = *(void**)pData;
 478     size_t size = array_size * data_size;
 479
 480     /* Allocate new or expand previous allocation */
 481     /* Note: on failure the old pointer will remain in the structure,
 482      * the message must be freed by caller also on error return. */
 483     ptr = realloc(ptr, size);
 484     if (ptr == NULL)
 485         PB_RETURN_ERROR(stream, "realloc failed");
 486
 487     *(void**)pData = ptr;
 488     return true;
 489 }
 490 #endif
 491
 492 static bool checkreturn decode_pointer_field(pb_istream_t *stream, pb_wire_type_t wire_type, pb_field_iterator_t *iter)
 493 {
 494 #ifndef PB_ENABLE_MALLOC
 495     UNUSED(wire_type);
 496     UNUSED(iter);
 497     PB_RETURN_ERROR(stream, "no malloc support");
 498 #else
 499     pb_type_t type;
 500     pb_decoder_t func;
 501
 502     type = iter->pos->type;
 503     func = PB_DECODERS[PB_LTYPE(type)];
 504
 505     switch (PB_HTYPE(type))
 506     {
 507         case PB_HTYPE_REQUIRED:
 508         case PB_HTYPE_OPTIONAL:
 509             if (PB_LTYPE(type) == PB_LTYPE_STRING)
 510             {
 511                 return func(stream, iter->pos, iter->pData);
 512             }
 513             else
 514             {
 515                 if (!allocate_field(stream, iter->pData, iter->pos->data_size, 1))
 516                     return false;
 517
 518                 return func(stream, iter->pos, *(void**)iter->pData);
 519             }
 520
 521         case PB_HTYPE_REPEATED:
 522             if (wire_type == PB_WT_STRING
 523                 && PB_LTYPE(type) <= PB_LTYPE_LAST_PACKABLE)
 524             {
 525                 /* Packed array, multiple items come in at once. */
 526                 bool status = true;
 527                 size_t *size = (size_t*)iter->pSize;
 528                 size_t allocated_size = *size;
 529                 void *pItem;
 530                 pb_istream_t substream;
 531
 532                 if (!pb_make_string_substream(stream, &substream))
 533                     return false;
 534
 535                 while (substream.bytes_left)
 536                 {
 537                     if (*size + 1 > allocated_size)
 538                     {
 539                         /* Allocate more storage. This tries to guess the
 540                          * number of remaining entries. Round the division
 541                          * upwards. */
 542                         allocated_size += (substream.bytes_left - 1) / iter->pos->data_size + 1;
 543
 544                         if (!allocate_field(&substream, iter->pData, iter->pos->data_size, allocated_size))
 545                         {
 546                             status = false;
 547                             break;
 548                         }
 549                     }
 550
 551                     /* Decode the array entry */
 552                     pItem = *(uint8_t**)iter->pData + iter->pos->data_size * (*size);
 553                     if (!func(&substream, iter->pos, pItem))
 554                     {
 555                         status = false;
 556                         break;
 557                     }
 558                     (*size)++;
 559                 }
 560                 pb_close_string_substream(stream, &substream);
 561
 562                 return status;
 563             }
 564             else
 565             {
 566                 /* Normal repeated field, i.e. only one item at a time. */
 567                 size_t *size = (size_t*)iter->pSize;
 568                 void *pItem;
 569
 570                 if (!allocate_field(stream, iter->pData, iter->pos->data_size, *size + 1))
 571                     return false;
 572
 573                 pItem = *(uint8_t**)iter->pData + iter->pos->data_size * (*size);
 574
 575                 /* Clear the new item in case it contains a pointer, or is a submessage. */
 576                 if (PB_LTYPE(type) == PB_LTYPE_STRING)
 577                 {
 578                     *(char**)pItem = NULL;
 579                 }
 580                 else if (PB_LTYPE(type) == PB_LTYPE_BYTES)
 581                 {
 582                     memset(pItem, 0, iter->pos->data_size);
 583                 }
 584                 else if (PB_LTYPE(type) == PB_LTYPE_SUBMESSAGE)
 585                 {
 586                     pb_message_set_to_defaults((const pb_field_t *) iter->pos->ptr, pItem);
 587                 }
 588
 589                 (*size)++;
 590                 return func(stream, iter->pos, pItem);
 591             }
 592
 593         default:
 594             PB_RETURN_ERROR(stream, "invalid field type");
 595     }
 596 #endif
 597 }
 598
 599 static bool checkreturn decode_callback_field(pb_istream_t *stream, pb_wire_type_t wire_type, pb_field_iterator_t *iter)
 600 {
 601     pb_callback_t *pCallback = (pb_callback_t*)iter->pData;
 602
 603 #ifdef PB_OLD_CALLBACK_STYLE
 604     void *arg = pCallback->arg;
 605 #else
 606     void **arg = &(pCallback->arg);
 607 #endif
 608
 609     if (pCallback->funcs.decode == NULL)
 610         return pb_skip_field(stream, wire_type);
 611
 612     if (wire_type == PB_WT_STRING)
 613     {
 614         pb_istream_t substream;
 615
 616         if (!pb_make_string_substream(stream, &substream))
 617             return false;
 618
 619         do
 620         {
 621             if (!pCallback->funcs.decode(&substream, iter->pos, arg))
 622                 PB_RETURN_ERROR(stream, "callback failed");
 623         } while (substream.bytes_left);
 624
 625         pb_close_string_substream(stream, &substream);
 626         return true;
 627     }
 628     else
 629     {
 630         /* Copy the single scalar value to stack.
 631          * This is required so that we can limit the stream length,
 632          * which in turn allows to use same callback for packed and
 633          * not-packed fields. */
 634         pb_istream_t substream;
 635         uint8_t buffer[10];
 636         size_t size = sizeof(buffer);
 637
 638         if (!read_raw_value(stream, wire_type, buffer, &size))
 639             return false;
 640         substream = pb_istream_from_buffer(buffer, size);
 641
 642         return pCallback->funcs.decode(&substream, iter->pos, arg);
 643     }
 644 }
 645
 646 static bool checkreturn decode_field(pb_istream_t *stream, pb_wire_type_t wire_type, pb_field_iterator_t *iter)
 647 {
 648     switch (PB_ATYPE(iter->pos->type))
 649     {
 650         case PB_ATYPE_STATIC:
 651             return decode_static_field(stream, wire_type, iter);
 652
 653         case PB_ATYPE_POINTER:
 654             return decode_pointer_field(stream, wire_type, iter);
 655
 656         case PB_ATYPE_CALLBACK:
 657             return decode_callback_field(stream, wire_type, iter);
 658
 659         default:
 660             PB_RETURN_ERROR(stream, "invalid field type");
 661     }
 662 }
 663
 664 /* Default handler for extension fields. Expects a pb_field_t structure
 665  * in extension->type->arg. */
 666 static bool checkreturn default_extension_decoder(pb_istream_t *stream,
 667     pb_extension_t *extension, uint32_t tag, pb_wire_type_t wire_type)
 668 {
 669     const pb_field_t *field = (const pb_field_t*)extension->type->arg;
 670     pb_field_iterator_t iter;
 671     bool dummy;
 672
 673     if (field->tag != tag)
 674         return true;
 675
 676     iter.start = field;
 677     iter.pos = field;
 678     iter.field_index = 0;
 679     iter.required_field_index = 0;
 680     iter.dest_struct = extension->dest;
 681     iter.pData = extension->dest;
 682     iter.pSize = &dummy;
 683
 684     return decode_field(stream, wire_type, &iter);
 685 }
 686
 687 /* Try to decode an unknown field as an extension field. Tries each extension
 688  * decoder in turn, until one of them handles the field or loop ends. */
 689 static bool checkreturn decode_extension(pb_istream_t *stream,
 690     uint32_t tag, pb_wire_type_t wire_type, pb_field_iterator_t *iter)
 691 {
 692     pb_extension_t *extension = *(pb_extension_t* const *)iter->pData;
 693     size_t pos = stream->bytes_left;
 694
 695     while (extension && pos == stream->bytes_left)
 696     {
 697         bool status;
 698         if (extension->type->decode)
 699             status = extension->type->decode(stream, extension, tag, wire_type);
 700         else
 701             status = default_extension_decoder(stream, extension, tag, wire_type);
 702
 703         if (!status)
 704             return false;
 705
 706         extension = extension->next;
 707     }
 708
 709     return true;
 710 }
 711
 712 /* Step through the iterator until an extension field is found or until all
 713  * entries have been checked. There can be only one extension field per
 714  * message. Returns false if no extension field is found. */
 715 static bool checkreturn find_extension_field(pb_field_iterator_t *iter)
 716 {
 717     unsigned start = iter->field_index;
 718
 719     do {
 720         if (PB_LTYPE(iter->pos->type) == PB_LTYPE_EXTENSION)
 721             return true;
 722         pb_field_next(iter);
 723     } while (iter->field_index != start);
 724
 725     return false;
 726 }
 727
 728 /* Initialize message fields to default values, recursively */
 729 static void pb_message_set_to_defaults(const pb_field_t fields[], void *dest_struct)
 730 {
 731     pb_field_iterator_t iter;
 732     pb_field_init(&iter, fields, dest_struct);
 733
 734     do
 735     {
 736         pb_type_t type;
 737         type = iter.pos->type;
 738
 739         /* Avoid crash on empty message types (zero fields) */
 740         if (iter.pos->tag == 0)
 741             continue;
 742
 743         if (PB_ATYPE(type) == PB_ATYPE_STATIC)
 744         {
 745             if (PB_HTYPE(type) == PB_HTYPE_OPTIONAL)
 746             {
 747                 /* Set has_field to false. Still initialize the optional field
 748                  * itself also. */
 749                 *(bool*)iter.pSize = false;
 750             }
 751             else if (PB_HTYPE(type) == PB_HTYPE_REPEATED)
 752             {
 753                 /* Set array count to 0, no need to initialize contents. */
 754                 *(size_t*)iter.pSize = 0;
 755                 continue;
 756             }
 757
 758             if (PB_LTYPE(iter.pos->type) == PB_LTYPE_SUBMESSAGE)
 759             {
 760                 /* Initialize submessage to defaults */
 761                 pb_message_set_to_defaults((const pb_field_t *) iter.pos->ptr, iter.pData);
 762             }
 763             else if (iter.pos->ptr != NULL)
 764             {
 765                 /* Initialize to default value */
 766                 memcpy(iter.pData, iter.pos->ptr, iter.pos->data_size);
 767             }
 768             else
 769             {
 770                 /* Initialize to zeros */
 771                 memset(iter.pData, 0, iter.pos->data_size);
 772             }
 773         }
 774         else if (PB_ATYPE(type) == PB_ATYPE_POINTER)
 775         {
 776             /* Initialize the pointer to NULL. */
 777             *(void**)iter.pData = NULL;
 778
 779             /* Initialize array count to 0. */
 780             if (PB_HTYPE(type) == PB_HTYPE_REPEATED)
 781             {
 782                 *(size_t*)iter.pSize = 0;
 783             }
 784         }
 785         else if (PB_ATYPE(type) == PB_ATYPE_CALLBACK)
 786         {
 787             /* Don't overwrite callback */
 788         }
 789     } while (pb_field_next(&iter));
 790 }
 791
 792 /*********************
 793  * Decode all fields *
 794  *********************/
 795
 796 bool checkreturn pb_decode_noinit(pb_istream_t *stream, const pb_field_t fields[], void *dest_struct)
 797 {
 798     uint8_t fields_seen[(PB_MAX_REQUIRED_FIELDS + 7) / 8] = {0}; /* Used to check for required fields */
 799     uint32_t extension_range_start = 0;
 800     pb_field_iterator_t iter;
 801
 802     pb_field_init(&iter, fields, dest_struct);
 803
 804     while (stream->bytes_left)
 805     {
 806         uint32_t tag;
 807         pb_wire_type_t wire_type;
 808         bool eof;
 809
 810         if (!pb_decode_tag(stream, &wire_type, &tag, &eof))
 811         {
 812             if (eof)
 813                 break;
 814             else
 815                 return false;
 816         }
 817
 818         if (!pb_field_find(&iter, tag))
 819         {
 820             /* No match found, check if it matches an extension. */
 821             if (tag >= extension_range_start)
 822             {
 823                 if (!find_extension_field(&iter))
 824                     extension_range_start = (uint32_t)-1;
 825                 else
 826                     extension_range_start = iter.pos->tag;
 827
 828                 if (tag >= extension_range_start)
 829                 {
 830                     size_t pos = stream->bytes_left;
 831
 832                     if (!decode_extension(stream, tag, wire_type, &iter))
 833                         return false;
 834
 835                     if (pos != stream->bytes_left)
 836                     {
 837                         /* The field was handled */
 838                         continue;
 839                     }
 840                 }
 841             }
 842
 843             /* No match found, skip data */
 844             if (!pb_skip_field(stream, wire_type))
 845                 return false;
 846             continue;
 847         }
 848
 849         if (PB_HTYPE(iter.pos->type) == PB_HTYPE_REQUIRED
 850             && iter.required_field_index < PB_MAX_REQUIRED_FIELDS)
 851         {
 852             fields_seen[iter.required_field_index >> 3] |= (uint8_t)(1 << (iter.required_field_index & 7));
 853         }
 854
 855         if (!decode_field(stream, wire_type, &iter))
 856             return false;
 857     }
 858
 859     /* Check that all required fields were present. */
 860     {
 861         /* First figure out the number of required fields by
 862          * seeking to the end of the field array. Usually we
 863          * are already close to end after decoding.
 864          */
 865         unsigned req_field_count;
 866         pb_type_t last_type;
 867         unsigned i;
 868         do {
 869             req_field_count = iter.required_field_index;
 870             last_type = iter.pos->type;
 871         } while (pb_field_next(&iter));
 872
 873         /* Fixup if last field was also required. */
 874         if (PB_HTYPE(last_type) == PB_HTYPE_REQUIRED && iter.pos->tag)
 875             req_field_count++;
 876
 877         /* Check the whole bytes */
 878         for (i = 0; i < (req_field_count >> 3); i++)
 879         {
 880             if (fields_seen[i] != 0xFF)
 881                 PB_RETURN_ERROR(stream, "missing required field");
 882         }
 883
 884         /* Check the remaining bits */
 885         if (fields_seen[req_field_count >> 3] != (0xFF >> (8 - (req_field_count & 7))))
 886             PB_RETURN_ERROR(stream, "missing required field");
 887     }
 888
 889     return true;
 890 }
 891
 892 bool checkreturn pb_decode(pb_istream_t *stream, const pb_field_t fields[], void *dest_struct)
 893 {
 894     pb_message_set_to_defaults(fields, dest_struct);
 895     return pb_decode_noinit(stream, fields, dest_struct);
 896 }
 897
 898 bool pb_decode_delimited(pb_istream_t *stream, const pb_field_t fields[], void *dest_struct)
 899 {
 900     pb_istream_t substream;
 901     bool status;
 902
 903     if (!pb_make_string_substream(stream, &substream))
 904         return false;
 905
 906     status = pb_decode(&substream, fields, dest_struct);
 907     pb_close_string_substream(stream, &substream);
 908     return status;
 909 }
 910
 911 /* Field decoders */
 912
 913 bool pb_decode_svarint(pb_istream_t *stream, int64_t *dest)
 914 {
 915     uint64_t value;
 916     if (!pb_decode_varint(stream, &value))
 917         return false;
 918
 919     if (value & 1)
 920         *dest = (int64_t)(~(value >> 1));
 921     else
 922         *dest = (int64_t)(value >> 1);
 923
 924     return true;
 925 }
 926
 927 bool pb_decode_fixed32(pb_istream_t *stream, void *dest)
 928 {
 929     #ifdef __BIG_ENDIAN__
 930     uint8_t *bytes = (uint8_t*)dest;
 931     uint8_t lebytes[4];
 932
 933     if (!pb_read(stream, lebytes, 4))
 934         return false;
 935
 936     bytes[0] = lebytes[3];
 937     bytes[1] = lebytes[2];
 938     bytes[2] = lebytes[1];
 939     bytes[3] = lebytes[0];
 940     return true;
 941     #else
 942     return pb_read(stream, (uint8_t*)dest, 4);
 943     #endif
 944 }
 945
 946 bool pb_decode_fixed64(pb_istream_t *stream, void *dest)
 947 {
 948     #ifdef __BIG_ENDIAN__
 949     uint8_t *bytes = (uint8_t*)dest;
 950     uint8_t lebytes[8];
 951
 952     if (!pb_read(stream, lebytes, 8))
 953         return false;
 954
 955     bytes[0] = lebytes[7];
 956     bytes[1] = lebytes[6];
 957     bytes[2] = lebytes[5];
 958     bytes[3] = lebytes[4];
 959     bytes[4] = lebytes[3];
 960     bytes[5] = lebytes[2];
 961     bytes[6] = lebytes[1];
 962     bytes[7] = lebytes[0];
 963     return true;
 964     #else
 965     return pb_read(stream, (uint8_t*)dest, 8);
 966     #endif
 967 }
 968
 969 bool checkreturn pb_dec_varint(pb_istream_t *stream, const pb_field_t *field, void *dest)
 970 {
 971     uint64_t value;
 972     if (!pb_decode_varint(stream, &value))
 973         return false;
 974
 975     switch (field->data_size)
 976     {
 977         case 1: *(int8_t*)dest = (int8_t)value; break;
 978         case 2: *(int16_t*)dest = (int16_t)value; break;
 979         case 4: *(int32_t*)dest = (int32_t)value; break;
 980         case 8: *(int64_t*)dest = (int64_t)value; break;
 981         default: PB_RETURN_ERROR(stream, "invalid data_size");
 982     }
 983
 984     return true;
 985 }
 986
 987 bool checkreturn pb_dec_uvarint(pb_istream_t *stream, const pb_field_t *field, void *dest)
 988 {
 989     uint64_t value;
 990     if (!pb_decode_varint(stream, &value))
 991         return false;
 992
 993     switch (field->data_size)
 994     {
 995         case 4: *(uint32_t*)dest = (uint32_t)value; break;
 996         case 8: *(uint64_t*)dest = value; break;
 997         default: PB_RETURN_ERROR(stream, "invalid data_size");
 998     }
 999
1000     return true;
1001 }
1002
1003 bool checkreturn pb_dec_svarint(pb_istream_t *stream, const pb_field_t *field, void *dest)
1004 {
1005     int64_t value;
1006     if (!pb_decode_svarint(stream, &value))
1007         return false;
1008
1009     switch (field->data_size)
1010     {
1011         case 4: *(int32_t*)dest = (int32_t)value; break;
1012         case 8: *(int64_t*)dest = value; break;
1013         default: PB_RETURN_ERROR(stream, "invalid data_size");
1014     }
1015
1016     return true;
1017 }
1018
1019 bool checkreturn pb_dec_fixed32(pb_istream_t *stream, const pb_field_t *field, void *dest)
1020 {
1021     UNUSED(field);
1022     return pb_decode_fixed32(stream, dest);
1023 }
1024
1025 bool checkreturn pb_dec_fixed64(pb_istream_t *stream, const pb_field_t *field, void *dest)
1026 {
1027     UNUSED(field);
1028     return pb_decode_fixed64(stream, dest);
1029 }
1030
1031 bool checkreturn pb_dec_bytes(pb_istream_t *stream, const pb_field_t *field, void *dest)
1032 {
1033     uint32_t size;
1034     size_t alloc_size;
1035
1036     if (!pb_decode_varint32(stream, &size))
1037         return false;
1038
1039     /* Space for the size_t header */
1040     alloc_size = size + offsetof(pb_bytes_array_t, bytes);
1041
1042     if (PB_ATYPE(field->type) == PB_ATYPE_POINTER)
1043     {
1044 #ifndef PB_ENABLE_MALLOC
1045         PB_RETURN_ERROR(stream, "no malloc support");
1046 #else
1047         pb_bytes_ptr_t *bdest = (pb_bytes_ptr_t*)dest;
1048         if (!allocate_field(stream, &bdest->bytes, alloc_size, 1))
1049             return false;
1050
1051         bdest->size = size;
1052         return pb_read(stream, bdest->bytes, size);
1053 #endif
1054     }
1055     else
1056     {
1057         pb_bytes_array_t* bdest = (pb_bytes_array_t*)dest;
1058         if (alloc_size > field->data_size)
1059             PB_RETURN_ERROR(stream, "bytes overflow");
1060         bdest->size = size;
1061         return pb_read(stream, bdest->bytes, size);
1062     }
1063 }
1064
1065 bool checkreturn pb_dec_string(pb_istream_t *stream, const pb_field_t *field, void *dest)
1066 {
1067     uint32_t size;
1068     size_t alloc_size;
1069     bool status;
1070     if (!pb_decode_varint32(stream, &size))
1071         return false;
1072
1073     /* Space for null terminator */
1074     alloc_size = size + 1;
1075
1076     if (PB_ATYPE(field->type) == PB_ATYPE_POINTER)
1077     {
1078 #ifndef PB_ENABLE_MALLOC
1079         PB_RETURN_ERROR(stream, "no malloc support");
1080 #else
1081         if (!allocate_field(stream, dest, alloc_size, 1))
1082             return false;
1083         dest = *(void**)dest;
1084 #endif
1085     }
1086     else
1087     {
1088         if (alloc_size > field->data_size)
1089             PB_RETURN_ERROR(stream, "string overflow");
1090     }
1091
1092     status = pb_read(stream, (uint8_t*)dest, size);
1093     *((uint8_t*)dest + size) = 0;
1094     return status;
1095 }
1096
1097 bool checkreturn pb_dec_submessage(pb_istream_t *stream, const pb_field_t *field, void *dest)
1098 {
1099     bool status;
1100     pb_istream_t substream;
1101     const pb_field_t* submsg_fields = (const pb_field_t*)field->ptr;
1102
1103     if (!pb_make_string_substream(stream, &substream))
1104         return false;
1105
1106     if (field->ptr == NULL)
1107         PB_RETURN_ERROR(stream, "invalid field descriptor");
1108
1109     /* New array entries need to be initialized, while required and optional
1110      * submessages have already been initialized in the top-level pb_decode. */
1111     if (PB_HTYPE(field->type) == PB_HTYPE_REPEATED)
1112         status = pb_decode(&substream, submsg_fields, dest);
1113     else
1114         status = pb_decode_noinit(&substream, submsg_fields, dest);
1115
1116     pb_close_string_substream(stream, &substream);
1117     return status;
1118 }