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