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