pb_decode.c

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