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, pb_field_iterator_t *iter, size_t array_size)
 476 {
 477     void *ptr = *(void**)iter->pData;
 478     size_t size = array_size * iter->pos->data_size;
 479
 480     if (ptr == NULL)
 481     {
 482         /* First allocation */
 483         ptr = malloc(size);
 484         if (ptr == NULL)
 485             PB_RETURN_ERROR(stream, "malloc failed");
 486     }
 487     else
 488     {
 489         /* Expand previous allocation */
 490         /* Note: on failure the old pointer will remain in the structure,
 491          * the message must be freed by caller also on error return. */
 492         ptr = realloc(ptr, size);
 493         if (ptr == NULL)
 494             PB_RETURN_ERROR(stream, "realloc failed");
 495     }
 496
 497     *(void**)iter->pData = ptr;
 498     return true;
 499 }
 500 #endif
 501
 502 static bool checkreturn decode_pointer_field(pb_istream_t *stream, pb_wire_type_t wire_type, pb_field_iterator_t *iter)
 503 {
 504 #ifndef PB_ENABLE_MALLOC
 505     UNUSED(wire_type);
 506     UNUSED(iter);
 507     PB_RETURN_ERROR(stream, "no malloc support");
 508 #else
 509     pb_type_t type;
 510     pb_decoder_t func;
 511
 512     type = iter->pos->type;
 513     func = PB_DECODERS[PB_LTYPE(type)];
 514
 515     switch (PB_HTYPE(type))
 516     {
 517         case PB_HTYPE_REQUIRED:
 518         case PB_HTYPE_OPTIONAL:
 519             if (PB_LTYPE(type) == PB_LTYPE_STRING)
 520             {
 521                 return func(stream, iter->pos, iter->pData);
 522             }
 523             else
 524             {
 525                 if (!allocate_field(stream, iter, 1))
 526                     return false;
 527
 528                 return func(stream, iter->pos, *(void**)iter->pData);
 529             }
 530
 531         case PB_HTYPE_REPEATED:
 532             if (wire_type == PB_WT_STRING
 533                 && PB_LTYPE(type) <= PB_LTYPE_LAST_PACKABLE)
 534             {
 535                 /* Packed array, multiple items come in at once. */
 536                 bool status = true;
 537                 size_t *size = (size_t*)iter->pSize;
 538                 size_t allocated_size = *size;
 539                 void *pItem;
 540                 pb_istream_t substream;
 541
 542                 if (!pb_make_string_substream(stream, &substream))
 543                     return false;
 544
 545                 while (substream.bytes_left)
 546                 {
 547                     if (*size + 1 > allocated_size)
 548                     {
 549                         /* Allocate more storage. This tries to guess the
 550                          * number of remaining entries. */
 551                         allocated_size += substream.bytes_left / iter->pos->data_size;
 552                         if (*size + 1 > allocated_size)
 553                             allocated_size++; /* Division gave zero. */
 554
 555                         if (!allocate_field(&substream, iter, allocated_size))
 556                         {
 557                             status = false;
 558                             break;
 559                         }
 560                     }
 561
 562                     /* Decode the array entry */
 563                     pItem = (uint8_t*)iter->pData + iter->pos->data_size * (*size);
 564                     if (!func(&substream, iter->pos, pItem))
 565                     {
 566                         status = false;
 567                         break;
 568                     }
 569                     (*size)++;
 570                 }
 571                 pb_close_string_substream(stream, &substream);
 572
 573                 return status;
 574             }
 575             else
 576             {
 577                 /* Normal repeated field, i.e. only one item at a time. */
 578                 size_t *size = (size_t*)iter->pSize;
 579                 void *pItem = (uint8_t*)iter->pData + iter->pos->data_size * (*size);
 580
 581                 if (!allocate_field(stream, iter, *size + 1))
 582                     return false;
 583
 584
 585                 (*size)++;
 586                 return func(stream, iter->pos, pItem);
 587             }
 588
 589         default:
 590             PB_RETURN_ERROR(stream, "invalid field type");
 591     }
 592 #endif
 593 }
 594
 595 static bool checkreturn decode_callback_field(pb_istream_t *stream, pb_wire_type_t wire_type, pb_field_iterator_t *iter)
 596 {
 597     pb_callback_t *pCallback = (pb_callback_t*)iter->pData;
 598
 599 #ifdef PB_OLD_CALLBACK_STYLE
 600     void *arg = pCallback->arg;
 601 #else
 602     void **arg = &(pCallback->arg);
 603 #endif
 604
 605     if (pCallback->funcs.decode == NULL)
 606         return pb_skip_field(stream, wire_type);
 607
 608     if (wire_type == PB_WT_STRING)
 609     {
 610         pb_istream_t substream;
 611
 612         if (!pb_make_string_substream(stream, &substream))
 613             return false;
 614
 615         do
 616         {
 617             if (!pCallback->funcs.decode(&substream, iter->pos, arg))
 618                 PB_RETURN_ERROR(stream, "callback failed");
 619         } while (substream.bytes_left);
 620
 621         pb_close_string_substream(stream, &substream);
 622         return true;
 623     }
 624     else
 625     {
 626         /* Copy the single scalar value to stack.
 627          * This is required so that we can limit the stream length,
 628          * which in turn allows to use same callback for packed and
 629          * not-packed fields. */
 630         pb_istream_t substream;
 631         uint8_t buffer[10];
 632         size_t size = sizeof(buffer);
 633
 634         if (!read_raw_value(stream, wire_type, buffer, &size))
 635             return false;
 636         substream = pb_istream_from_buffer(buffer, size);
 637
 638         return pCallback->funcs.decode(&substream, iter->pos, arg);
 639     }
 640 }
 641
 642 static bool checkreturn decode_field(pb_istream_t *stream, pb_wire_type_t wire_type, pb_field_iterator_t *iter)
 643 {
 644     switch (PB_ATYPE(iter->pos->type))
 645     {
 646         case PB_ATYPE_STATIC:
 647             return decode_static_field(stream, wire_type, iter);
 648
 649         case PB_ATYPE_POINTER:
 650             return decode_pointer_field(stream, wire_type, iter);
 651
 652         case PB_ATYPE_CALLBACK:
 653             return decode_callback_field(stream, wire_type, iter);
 654
 655         default:
 656             PB_RETURN_ERROR(stream, "invalid field type");
 657     }
 658 }
 659
 660 /* Default handler for extension fields. Expects a pb_field_t structure
 661  * in extension->type->arg. */
 662 static bool checkreturn default_extension_decoder(pb_istream_t *stream,
 663     pb_extension_t *extension, uint32_t tag, pb_wire_type_t wire_type)
 664 {
 665     const pb_field_t *field = (const pb_field_t*)extension->type->arg;
 666     pb_field_iterator_t iter;
 667     bool dummy;
 668
 669     if (field->tag != tag)
 670         return true;
 671
 672     iter.start = field;
 673     iter.pos = field;
 674     iter.field_index = 0;
 675     iter.required_field_index = 0;
 676     iter.dest_struct = extension->dest;
 677     iter.pData = extension->dest;
 678     iter.pSize = &dummy;
 679
 680     return decode_field(stream, wire_type, &iter);
 681 }
 682
 683 /* Try to decode an unknown field as an extension field. Tries each extension
 684  * decoder in turn, until one of them handles the field or loop ends. */
 685 static bool checkreturn decode_extension(pb_istream_t *stream,
 686     uint32_t tag, pb_wire_type_t wire_type, pb_field_iterator_t *iter)
 687 {
 688     pb_extension_t *extension = *(pb_extension_t* const *)iter->pData;
 689     size_t pos = stream->bytes_left;
 690
 691     while (extension && pos == stream->bytes_left)
 692     {
 693         bool status;
 694         if (extension->type->decode)
 695             status = extension->type->decode(stream, extension, tag, wire_type);
 696         else
 697             status = default_extension_decoder(stream, extension, tag, wire_type);
 698
 699         if (!status)
 700             return false;
 701
 702         extension = extension->next;
 703     }
 704
 705     return true;
 706 }
 707
 708 /* Step through the iterator until an extension field is found or until all
 709  * entries have been checked. There can be only one extension field per
 710  * message. Returns false if no extension field is found. */
 711 static bool checkreturn find_extension_field(pb_field_iterator_t *iter)
 712 {
 713     unsigned start = iter->field_index;
 714
 715     do {
 716         if (PB_LTYPE(iter->pos->type) == PB_LTYPE_EXTENSION)
 717             return true;
 718         pb_field_next(iter);
 719     } while (iter->field_index != start);
 720
 721     return false;
 722 }
 723
 724 /* Initialize message fields to default values, recursively */
 725 static void pb_message_set_to_defaults(const pb_field_t fields[], void *dest_struct)
 726 {
 727     pb_field_iterator_t iter;
 728     pb_field_init(&iter, fields, dest_struct);
 729
 730     do
 731     {
 732         pb_type_t type;
 733         type = iter.pos->type;
 734
 735         /* Avoid crash on empty message types (zero fields) */
 736         if (iter.pos->tag == 0)
 737             continue;
 738
 739         if (PB_ATYPE(type) == PB_ATYPE_STATIC)
 740         {
 741             if (PB_HTYPE(type) == PB_HTYPE_OPTIONAL)
 742             {
 743                 /* Set has_field to false. Still initialize the optional field
 744                  * itself also. */
 745                 *(bool*)iter.pSize = false;
 746             }
 747             else if (PB_HTYPE(type) == PB_HTYPE_REPEATED)
 748             {
 749                 /* Set array count to 0, no need to initialize contents. */
 750                 *(size_t*)iter.pSize = 0;
 751                 continue;
 752             }
 753
 754             if (PB_LTYPE(iter.pos->type) == PB_LTYPE_SUBMESSAGE)
 755             {
 756                 /* Initialize submessage to defaults */
 757                 pb_message_set_to_defaults((const pb_field_t *) iter.pos->ptr, iter.pData);
 758             }
 759             else if (iter.pos->ptr != NULL)
 760             {
 761                 /* Initialize to default value */
 762                 memcpy(iter.pData, iter.pos->ptr, iter.pos->data_size);
 763             }
 764             else
 765             {
 766                 /* Initialize to zeros */
 767                 memset(iter.pData, 0, iter.pos->data_size);
 768             }
 769         }
 770         else if (PB_ATYPE(type) == PB_ATYPE_POINTER)
 771         {
 772             /* Initialize the pointer to NULL. */
 773             *(void**)iter.pData = NULL;
 774
 775             /* Initialize array count to 0. */
 776             if (PB_HTYPE(type) == PB_HTYPE_REPEATED)
 777             {
 778                 *(size_t*)iter.pSize = 0;
 779             }
 780         }
 781         else if (PB_ATYPE(type) == PB_ATYPE_CALLBACK)
 782         {
 783             /* Don't overwrite callback */
 784         }
 785     } while (pb_field_next(&iter));
 786 }
 787
 788 /*********************
 789  * Decode all fields *
 790  *********************/
 791
 792 bool checkreturn pb_decode_noinit(pb_istream_t *stream, const pb_field_t fields[], void *dest_struct)
 793 {
 794     uint8_t fields_seen[(PB_MAX_REQUIRED_FIELDS + 7) / 8] = {0}; /* Used to check for required fields */
 795     uint32_t extension_range_start = 0;
 796     pb_field_iterator_t iter;
 797
 798     pb_field_init(&iter, fields, dest_struct);
 799
 800     while (stream->bytes_left)
 801     {
 802         uint32_t tag;
 803         pb_wire_type_t wire_type;
 804         bool eof;
 805
 806         if (!pb_decode_tag(stream, &wire_type, &tag, &eof))
 807         {
 808             if (eof)
 809                 break;
 810             else
 811                 return false;
 812         }
 813
 814         if (!pb_field_find(&iter, tag))
 815         {
 816             /* No match found, check if it matches an extension. */
 817             if (tag >= extension_range_start)
 818             {
 819                 if (!find_extension_field(&iter))
 820                     extension_range_start = (uint32_t)-1;
 821                 else
 822                     extension_range_start = iter.pos->tag;
 823
 824                 if (tag >= extension_range_start)
 825                 {
 826                     size_t pos = stream->bytes_left;
 827
 828                     if (!decode_extension(stream, tag, wire_type, &iter))
 829                         return false;
 830
 831                     if (pos != stream->bytes_left)
 832                     {
 833                         /* The field was handled */
 834                         continue;
 835                     }
 836                 }
 837             }
 838
 839             /* No match found, skip data */
 840             if (!pb_skip_field(stream, wire_type))
 841                 return false;
 842             continue;
 843         }
 844
 845         if (PB_HTYPE(iter.pos->type) == PB_HTYPE_REQUIRED
 846             && iter.required_field_index < PB_MAX_REQUIRED_FIELDS)
 847         {
 848             fields_seen[iter.required_field_index >> 3] |= (uint8_t)(1 << (iter.required_field_index & 7));
 849         }
 850
 851         if (!decode_field(stream, wire_type, &iter))
 852             return false;
 853     }
 854
 855     /* Check that all required fields were present. */
 856     {
 857         /* First figure out the number of required fields by
 858          * seeking to the end of the field array. Usually we
 859          * are already close to end after decoding.
 860          */
 861         unsigned req_field_count;
 862         pb_type_t last_type;
 863         unsigned i;
 864         do {
 865             req_field_count = iter.required_field_index;
 866             last_type = iter.pos->type;
 867         } while (pb_field_next(&iter));
 868
 869         /* Fixup if last field was also required. */
 870         if (PB_HTYPE(last_type) == PB_HTYPE_REQUIRED && iter.pos->tag)
 871             req_field_count++;
 872
 873         /* Check the whole bytes */
 874         for (i = 0; i < (req_field_count >> 3); i++)
 875         {
 876             if (fields_seen[i] != 0xFF)
 877                 PB_RETURN_ERROR(stream, "missing required field");
 878         }
 879
 880         /* Check the remaining bits */
 881         if (fields_seen[req_field_count >> 3] != (0xFF >> (8 - (req_field_count & 7))))
 882             PB_RETURN_ERROR(stream, "missing required field");
 883     }
 884
 885     return true;
 886 }
 887
 888 bool checkreturn pb_decode(pb_istream_t *stream, const pb_field_t fields[], void *dest_struct)
 889 {
 890     pb_message_set_to_defaults(fields, dest_struct);
 891     return pb_decode_noinit(stream, fields, dest_struct);
 892 }
 893
 894 bool pb_decode_delimited(pb_istream_t *stream, const pb_field_t fields[], void *dest_struct)
 895 {
 896     pb_istream_t substream;
 897     bool status;
 898
 899     if (!pb_make_string_substream(stream, &substream))
 900         return false;
 901
 902     status = pb_decode(&substream, fields, dest_struct);
 903     pb_close_string_substream(stream, &substream);
 904     return status;
 905 }
 906
 907 /* Field decoders */
 908
 909 bool pb_decode_svarint(pb_istream_t *stream, int64_t *dest)
 910 {
 911     uint64_t value;
 912     if (!pb_decode_varint(stream, &value))
 913         return false;
 914
 915     if (value & 1)
 916         *dest = (int64_t)(~(value >> 1));
 917     else
 918         *dest = (int64_t)(value >> 1);
 919
 920     return true;
 921 }
 922
 923 bool pb_decode_fixed32(pb_istream_t *stream, void *dest)
 924 {
 925     #ifdef __BIG_ENDIAN__
 926     uint8_t *bytes = (uint8_t*)dest;
 927     uint8_t lebytes[4];
 928
 929     if (!pb_read(stream, lebytes, 4))
 930         return false;
 931
 932     bytes[0] = lebytes[3];
 933     bytes[1] = lebytes[2];
 934     bytes[2] = lebytes[1];
 935     bytes[3] = lebytes[0];
 936     return true;
 937     #else
 938     return pb_read(stream, (uint8_t*)dest, 4);
 939     #endif
 940 }
 941
 942 bool pb_decode_fixed64(pb_istream_t *stream, void *dest)
 943 {
 944     #ifdef __BIG_ENDIAN__
 945     uint8_t *bytes = (uint8_t*)dest;
 946     uint8_t lebytes[8];
 947
 948     if (!pb_read(stream, lebytes, 8))
 949         return false;
 950
 951     bytes[0] = lebytes[7];
 952     bytes[1] = lebytes[6];
 953     bytes[2] = lebytes[5];
 954     bytes[3] = lebytes[4];
 955     bytes[4] = lebytes[3];
 956     bytes[5] = lebytes[2];
 957     bytes[6] = lebytes[1];
 958     bytes[7] = lebytes[0];
 959     return true;
 960     #else
 961     return pb_read(stream, (uint8_t*)dest, 8);
 962     #endif
 963 }
 964
 965 bool checkreturn pb_dec_varint(pb_istream_t *stream, const pb_field_t *field, void *dest)
 966 {
 967     uint64_t value;
 968     if (!pb_decode_varint(stream, &value))
 969         return false;
 970
 971     switch (field->data_size)
 972     {
 973         case 1: *(int8_t*)dest = (int8_t)value; break;
 974         case 2: *(int16_t*)dest = (int16_t)value; break;
 975         case 4: *(int32_t*)dest = (int32_t)value; break;
 976         case 8: *(int64_t*)dest = (int64_t)value; break;
 977         default: PB_RETURN_ERROR(stream, "invalid data_size");
 978     }
 979
 980     return true;
 981 }
 982
 983 bool checkreturn pb_dec_uvarint(pb_istream_t *stream, const pb_field_t *field, void *dest)
 984 {
 985     uint64_t value;
 986     if (!pb_decode_varint(stream, &value))
 987         return false;
 988
 989     switch (field->data_size)
 990     {
 991         case 4: *(uint32_t*)dest = (uint32_t)value; break;
 992         case 8: *(uint64_t*)dest = value; break;
 993         default: PB_RETURN_ERROR(stream, "invalid data_size");
 994     }
 995
 996     return true;
 997 }
 998
 999 bool checkreturn pb_dec_svarint(pb_istream_t *stream, const pb_field_t *field, void *dest)
1000 {
1001     int64_t value;
1002     if (!pb_decode_svarint(stream, &value))
1003         return false;
1004
1005     switch (field->data_size)
1006     {
1007         case 4: *(int32_t*)dest = (int32_t)value; break;
1008         case 8: *(int64_t*)dest = value; break;
1009         default: PB_RETURN_ERROR(stream, "invalid data_size");
1010     }
1011
1012     return true;
1013 }
1014
1015 bool checkreturn pb_dec_fixed32(pb_istream_t *stream, const pb_field_t *field, void *dest)
1016 {
1017     UNUSED(field);
1018     return pb_decode_fixed32(stream, dest);
1019 }
1020
1021 bool checkreturn pb_dec_fixed64(pb_istream_t *stream, const pb_field_t *field, void *dest)
1022 {
1023     UNUSED(field);
1024     return pb_decode_fixed64(stream, dest);
1025 }
1026
1027 bool checkreturn pb_dec_bytes(pb_istream_t *stream, const pb_field_t *field, void *dest)
1028 {
1029     pb_bytes_array_t *x = (pb_bytes_array_t*)dest;
1030
1031     uint32_t temp;
1032     if (!pb_decode_varint32(stream, &temp))
1033         return false;
1034     x->size = temp;
1035
1036     /* Check length, noting the space taken by the size_t header. */
1037     if (x->size > field->data_size - offsetof(pb_bytes_array_t, bytes))
1038         PB_RETURN_ERROR(stream, "bytes overflow");
1039
1040     return pb_read(stream, x->bytes, x->size);
1041 }
1042
1043 bool checkreturn pb_dec_string(pb_istream_t *stream, const pb_field_t *field, void *dest)
1044 {
1045     uint32_t size;
1046     bool status;
1047     if (!pb_decode_varint32(stream, &size))
1048         return false;
1049
1050     /* Check length, noting the null terminator */
1051     if (PB_ATYPE(field->type) == PB_ATYPE_POINTER)
1052     {
1053 #ifndef PB_ENABLE_MALLOC
1054         PB_RETURN_ERROR(stream, "no malloc support");
1055 #else
1056         *(void**)dest = realloc(*(void**)dest, size + 1);
1057         if (*(void**)dest == NULL)
1058             PB_RETURN_ERROR(stream, "out of memory");
1059         dest = *(void**)dest;
1060 #endif
1061     }
1062     else
1063     {
1064         if (size + 1 > field->data_size)
1065             PB_RETURN_ERROR(stream, "string overflow");
1066     }
1067
1068     status = pb_read(stream, (uint8_t*)dest, size);
1069     *((uint8_t*)dest + size) = 0;
1070     return status;
1071 }
1072
1073 bool checkreturn pb_dec_submessage(pb_istream_t *stream, const pb_field_t *field, void *dest)
1074 {
1075     bool status;
1076     pb_istream_t substream;
1077     const pb_field_t* submsg_fields = (const pb_field_t*)field->ptr;
1078
1079     if (!pb_make_string_substream(stream, &substream))
1080         return false;
1081
1082     if (field->ptr == NULL)
1083         PB_RETURN_ERROR(stream, "invalid field descriptor");
1084
1085     /* New array entries need to be initialized, while required and optional
1086      * submessages have already been initialized in the top-level pb_decode. */
1087     if (PB_HTYPE(field->type) == PB_HTYPE_REPEATED)
1088         status = pb_decode(&substream, submsg_fields, dest);
1089     else
1090         status = pb_decode_noinit(&substream, submsg_fields, dest);
1091
1092     pb_close_string_substream(stream, &substream);
1093     return status;
1094 }