pb_decode.c

   1 /* pb_decode.c -- decode a protobuf using minimal resources
   2  *
   3  * 2011 Petteri Aimonen <jpa@kapsi.fi>
   4  */
   5
   6 /* The warn_unused_result attribute appeared first in gcc-3.4.0 */
   7 #if !defined(__GNUC__) || ( __GNUC__ < 3) || (__GNUC__ == 3 && __GNUC_MINOR__ < 4)
   8     #define checkreturn
   9 #else
  10     /* Verify that we remember to check all return values for proper error propagation */
  11     #define checkreturn __attribute__((warn_unused_result))
  12 #endif
  13
  14 #define NANOPB_INTERNALS
  15 #include "pb.h"
  16 #include "pb_decode.h"
  17 #include <string.h>
  18
  19 typedef bool (*pb_decoder_t)(pb_istream_t *stream, const pb_field_t *field, void *dest) checkreturn;
  20
  21 /* --- Function pointers to field decoders ---
  22  * Order in the array must match pb_action_t LTYPE numbering.
  23  */
  24 static const pb_decoder_t PB_DECODERS[PB_LTYPES_COUNT] = {
  25     &pb_dec_varint,
  26     &pb_dec_svarint,
  27     &pb_dec_fixed32,
  28     &pb_dec_fixed64,
  29
  30     &pb_dec_bytes,
  31     &pb_dec_string,
  32     &pb_dec_submessage
  33 };
  34
  35 /**************
  36  * pb_istream *
  37  **************/
  38
  39 static bool checkreturn buf_read(pb_istream_t *stream, uint8_t *buf, size_t count)
  40 {
  41     uint8_t *source = (uint8_t*)stream->state;
  42
  43     if (buf != NULL)
  44         memcpy(buf, source, count);
  45
  46     stream->state = source + count;
  47     return true;
  48 }
  49
  50 bool checkreturn pb_read(pb_istream_t *stream, uint8_t *buf, size_t count)
  51 {
  52         if (buf == NULL && stream->callback != buf_read)
  53         {
  54                 /* Skip input bytes */
  55                 uint8_t tmp[16];
  56                 while (count > 16)
  57                 {
  58                         if (!pb_read(stream, tmp, 16))
  59                                 return false;
  60
  61                         count -= 16;
  62                 }
  63
  64                 return pb_read(stream, tmp, count);
  65         }
  66
  67     if (stream->bytes_left < count)
  68         PB_RETURN_ERROR(stream, "end-of-stream");
  69
  70     if (!stream->callback(stream, buf, count))
  71         PB_RETURN_ERROR(stream, "io error");
  72
  73     stream->bytes_left -= count;
  74     return true;
  75 }
  76
  77 pb_istream_t pb_istream_from_buffer(uint8_t *buf, size_t bufsize)
  78 {
  79     pb_istream_t stream;
  80     stream.callback = &buf_read;
  81     stream.state = buf;
  82     stream.bytes_left = bufsize;
  83 #ifndef PB_NO_ERRMSG
  84     stream.errmsg = NULL;
  85 #endif
  86     return stream;
  87 }
  88
  89 /********************
  90  * Helper functions *
  91  ********************/
  92
  93 static bool checkreturn pb_decode_varint32(pb_istream_t *stream, uint32_t *dest)
  94 {
  95     uint64_t temp;
  96     bool status = pb_decode_varint(stream, &temp);
  97     *dest = (uint32_t)temp;
  98     return status;
  99 }
 100
 101 bool checkreturn pb_decode_varint(pb_istream_t *stream, uint64_t *dest)
 102 {
 103     uint8_t byte;
 104     int bitpos = 0;
 105     *dest = 0;
 106
 107     while (bitpos < 64 && pb_read(stream, &byte, 1))
 108     {
 109         *dest |= (uint64_t)(byte & 0x7F) << bitpos;
 110         bitpos += 7;
 111
 112         if (!(byte & 0x80))
 113             return true;
 114     }
 115
 116     PB_RETURN_ERROR(stream, "varint overflow");
 117 }
 118
 119 bool checkreturn pb_skip_varint(pb_istream_t *stream)
 120 {
 121     uint8_t byte;
 122     do
 123     {
 124         if (!pb_read(stream, &byte, 1))
 125             return false;
 126     } while (byte & 0x80);
 127     return true;
 128 }
 129
 130 bool checkreturn pb_skip_string(pb_istream_t *stream)
 131 {
 132     uint32_t length;
 133     if (!pb_decode_varint32(stream, &length))
 134         return false;
 135
 136     return pb_read(stream, NULL, length);
 137 }
 138
 139 bool checkreturn pb_decode_tag(pb_istream_t *stream, pb_wire_type_t *wire_type, uint32_t *tag, bool *eof)
 140 {
 141     uint32_t temp;
 142     *eof = false;
 143     *wire_type = (pb_wire_type_t) 0;
 144     *tag = 0;
 145
 146     if (!pb_decode_varint32(stream, &temp))
 147     {
 148         if (stream->bytes_left == 0)
 149             *eof = true;
 150
 151         return false;
 152     }
 153
 154     if (temp == 0)
 155     {
 156         *eof = true; /* Special feature: allow 0-terminated messages. */
 157         return false;
 158     }
 159
 160     *tag = temp >> 3;
 161     *wire_type = (pb_wire_type_t)(temp & 7);
 162     return true;
 163 }
 164
 165 bool checkreturn pb_skip_field(pb_istream_t *stream, pb_wire_type_t wire_type)
 166 {
 167     switch (wire_type)
 168     {
 169         case PB_WT_VARINT: return pb_skip_varint(stream);
 170         case PB_WT_64BIT: return pb_read(stream, NULL, 8);
 171         case PB_WT_STRING: return pb_skip_string(stream);
 172         case PB_WT_32BIT: return pb_read(stream, NULL, 4);
 173         default: PB_RETURN_ERROR(stream, "invalid wire_type");
 174     }
 175 }
 176
 177 /* Read a raw value to buffer, for the purpose of passing it to callback as
 178  * a substream. Size is maximum size on call, and actual size on return.
 179  */
 180 static bool checkreturn read_raw_value(pb_istream_t *stream, pb_wire_type_t wire_type, uint8_t *buf, size_t *size)
 181 {
 182     size_t max_size = *size;
 183     switch (wire_type)
 184     {
 185         case PB_WT_VARINT:
 186             *size = 0;
 187             do
 188             {
 189                 (*size)++;
 190                 if (*size > max_size) return false;
 191                 if (!pb_read(stream, buf, 1)) return false;
 192             } while (*buf++ & 0x80);
 193             return true;
 194
 195         case PB_WT_64BIT:
 196             *size = 8;
 197             return pb_read(stream, buf, 8);
 198
 199         case PB_WT_32BIT:
 200             *size = 4;
 201             return pb_read(stream, buf, 4);
 202
 203         default: PB_RETURN_ERROR(stream, "invalid wire_type");
 204     }
 205 }
 206
 207 /* Decode string length from stream and return a substream with limited length.
 208  * Remember to close the substream using pb_close_string_substream().
 209  */
 210 bool checkreturn pb_make_string_substream(pb_istream_t *stream, pb_istream_t *substream)
 211 {
 212     uint32_t size;
 213     if (!pb_decode_varint32(stream, &size))
 214         return false;
 215
 216     *substream = *stream;
 217     if (substream->bytes_left < size)
 218         PB_RETURN_ERROR(stream, "parent stream too short");
 219
 220     substream->bytes_left = size;
 221     stream->bytes_left -= size;
 222     return true;
 223 }
 224
 225 void pb_close_string_substream(pb_istream_t *stream, pb_istream_t *substream)
 226 {
 227     stream->state = substream->state;
 228 }
 229
 230 /* Iterator for pb_field_t list */
 231 typedef struct {
 232     const pb_field_t *start; /* Start of the pb_field_t array */
 233     const pb_field_t *current; /* Current position of the iterator */
 234     int field_index; /* Zero-based index of the field. */
 235     int required_field_index; /* Zero-based index that counts only the required fields */
 236     void *dest_struct; /* Pointer to the destination structure to decode to */
 237     void *pData; /* Pointer where to store current field value */
 238     void *pSize; /* Pointer where to store the size of current array field */
 239 } pb_field_iterator_t;
 240
 241 static void pb_field_init(pb_field_iterator_t *iter, const pb_field_t *fields, void *dest_struct)
 242 {
 243     iter->start = iter->current = fields;
 244     iter->field_index = 0;
 245     iter->required_field_index = 0;
 246     iter->pData = (char*)dest_struct + iter->current->data_offset;
 247     iter->pSize = (char*)iter->pData + iter->current->size_offset;
 248     iter->dest_struct = dest_struct;
 249 }
 250
 251 static bool pb_field_next(pb_field_iterator_t *iter)
 252 {
 253     bool notwrapped = true;
 254     size_t prev_size = iter->current->data_size;
 255
 256     if (PB_HTYPE(iter->current->type) == PB_HTYPE_ARRAY)
 257         prev_size *= iter->current->array_size;
 258
 259     if (PB_HTYPE(iter->current->type) == PB_HTYPE_REQUIRED)
 260         iter->required_field_index++;
 261
 262     iter->current++;
 263     iter->field_index++;
 264     if (iter->current->tag == 0)
 265     {
 266         iter->current = iter->start;
 267         iter->field_index = 0;
 268         iter->required_field_index = 0;
 269         iter->pData = iter->dest_struct;
 270         prev_size = 0;
 271         notwrapped = false;
 272     }
 273
 274     iter->pData = (char*)iter->pData + prev_size + iter->current->data_offset;
 275     iter->pSize = (char*)iter->pData + iter->current->size_offset;
 276     return notwrapped;
 277 }
 278
 279 static bool checkreturn pb_field_find(pb_field_iterator_t *iter, uint32_t tag)
 280 {
 281     int start = iter->field_index;
 282
 283     do {
 284         if (iter->current->tag == tag)
 285             return true;
 286         pb_field_next(iter);
 287     } while (iter->field_index != start);
 288
 289     return false;
 290 }
 291
 292 /*************************
 293  * Decode a single field *
 294  *************************/
 295
 296 static bool checkreturn decode_field(pb_istream_t *stream, pb_wire_type_t wire_type, pb_field_iterator_t *iter)
 297 {
 298     pb_decoder_t func = PB_DECODERS[PB_LTYPE(iter->current->type)];
 299
 300     switch (PB_HTYPE(iter->current->type))
 301     {
 302         case PB_HTYPE_REQUIRED:
 303             return func(stream, iter->current, iter->pData);
 304
 305         case PB_HTYPE_OPTIONAL:
 306             *(bool*)iter->pSize = true;
 307             return func(stream, iter->current, iter->pData);
 308
 309         case PB_HTYPE_ARRAY:
 310             if (wire_type == PB_WT_STRING
 311                 && PB_LTYPE(iter->current->type) <= PB_LTYPE_LAST_PACKABLE)
 312             {
 313                 /* Packed array */
 314                 bool status;
 315                 size_t *size = (size_t*)iter->pSize;
 316                 pb_istream_t substream;
 317                 if (!pb_make_string_substream(stream, &substream))
 318                     return false;
 319
 320                 while (substream.bytes_left && *size < iter->current->array_size)
 321                 {
 322                     void *pItem = (uint8_t*)iter->pData + iter->current->data_size * (*size);
 323                     if (!func(&substream, iter->current, pItem))
 324                         return false;
 325                     (*size)++;
 326                 }
 327                 status = (substream.bytes_left == 0);
 328                 pb_close_string_substream(stream, &substream);
 329                 return status;
 330             }
 331             else
 332             {
 333                 /* Repeated field */
 334                 size_t *size = (size_t*)iter->pSize;
 335                 void *pItem = (uint8_t*)iter->pData + iter->current->data_size * (*size);
 336                 if (*size >= iter->current->array_size)
 337                     PB_RETURN_ERROR(stream, "array overflow");
 338
 339                 (*size)++;
 340                 return func(stream, iter->current, pItem);
 341             }
 342
 343         case PB_HTYPE_CALLBACK:
 344         {
 345             pb_callback_t *pCallback = (pb_callback_t*)iter->pData;
 346
 347             if (pCallback->funcs.decode == NULL)
 348                 return pb_skip_field(stream, wire_type);
 349
 350             if (wire_type == PB_WT_STRING)
 351             {
 352                 pb_istream_t substream;
 353
 354                 if (!pb_make_string_substream(stream, &substream))
 355                     return false;
 356
 357                 while (substream.bytes_left)
 358                 {
 359                     if (!pCallback->funcs.decode(&substream, iter->current, pCallback->arg))
 360                         PB_RETURN_ERROR(stream, "callback failed");
 361                 }
 362
 363                 pb_close_string_substream(stream, &substream);
 364                 return true;
 365             }
 366             else
 367             {
 368                 /* Copy the single scalar value to stack.
 369                  * This is required so that we can limit the stream length,
 370                  * which in turn allows to use same callback for packed and
 371                  * not-packed fields. */
 372                 pb_istream_t substream;
 373                 uint8_t buffer[10];
 374                 size_t size = sizeof(buffer);
 375
 376                 if (!read_raw_value(stream, wire_type, buffer, &size))
 377                     return false;
 378                 substream = pb_istream_from_buffer(buffer, size);
 379
 380                 return pCallback->funcs.decode(&substream, iter->current, pCallback->arg);
 381             }
 382         }
 383
 384         default:
 385             PB_RETURN_ERROR(stream, "invalid field type");
 386     }
 387 }
 388
 389 /* Initialize message fields to default values, recursively */
 390 static void pb_message_set_to_defaults(const pb_field_t fields[], void *dest_struct)
 391 {
 392     pb_field_iterator_t iter;
 393     pb_field_init(&iter, fields, dest_struct);
 394
 395     /* Initialize size/has fields and apply default values */
 396     do
 397     {
 398         if (iter.current->tag == 0)
 399             continue;
 400
 401         /* Initialize the size field for optional/repeated fields to 0. */
 402         if (PB_HTYPE(iter.current->type) == PB_HTYPE_OPTIONAL)
 403         {
 404             *(bool*)iter.pSize = false;
 405         }
 406         else if (PB_HTYPE(iter.current->type) == PB_HTYPE_ARRAY)
 407         {
 408             *(size_t*)iter.pSize = 0;
 409             continue; /* Array is empty, no need to initialize contents */
 410         }
 411
 412         /* Initialize field contents to default value */
 413         if (PB_HTYPE(iter.current->type) == PB_HTYPE_CALLBACK)
 414         {
 415             continue; /* Don't overwrite callback */
 416         }
 417         else if (PB_LTYPE(iter.current->type) == PB_LTYPE_SUBMESSAGE)
 418         {
 419             pb_message_set_to_defaults((const pb_field_t *) iter.current->ptr, iter.pData);
 420         }
 421         else if (iter.current->ptr != NULL)
 422         {
 423             memcpy(iter.pData, iter.current->ptr, iter.current->data_size);
 424         }
 425         else
 426         {
 427             memset(iter.pData, 0, iter.current->data_size);
 428         }
 429     } while (pb_field_next(&iter));
 430 }
 431
 432 /*********************
 433  * Decode all fields *
 434  *********************/
 435
 436 bool checkreturn pb_decode_noinit(pb_istream_t *stream, const pb_field_t fields[], void *dest_struct)
 437 {
 438     uint8_t fields_seen[(PB_MAX_REQUIRED_FIELDS + 7) / 8] = {0}; /* Used to check for required fields */
 439     pb_field_iterator_t iter;
 440
 441     pb_field_init(&iter, fields, dest_struct);
 442
 443     while (stream->bytes_left)
 444     {
 445         uint32_t tag;
 446         pb_wire_type_t wire_type;
 447         bool eof;
 448
 449         if (!pb_decode_tag(stream, &wire_type, &tag, &eof))
 450         {
 451             if (eof)
 452                 break;
 453             else
 454                 return false;
 455         }
 456
 457         if (!pb_field_find(&iter, tag))
 458         {
 459             /* No match found, skip data */
 460             if (!pb_skip_field(stream, wire_type))
 461                 return false;
 462             continue;
 463         }
 464
 465         if (PB_HTYPE(iter.current->type) == PB_HTYPE_REQUIRED
 466             && iter.required_field_index < PB_MAX_REQUIRED_FIELDS)
 467         {
 468             fields_seen[iter.required_field_index >> 3] |= (uint8_t)(1 << (iter.required_field_index & 7));
 469         }
 470
 471         if (!decode_field(stream, wire_type, &iter))
 472             return false;
 473     }
 474
 475     /* Check that all required fields were present. */
 476     pb_field_init(&iter, fields, dest_struct);
 477     do {
 478         if (PB_HTYPE(iter.current->type) == PB_HTYPE_REQUIRED &&
 479             iter.required_field_index < PB_MAX_REQUIRED_FIELDS &&
 480             !(fields_seen[iter.required_field_index >> 3] & (1 << (iter.required_field_index & 7))))
 481         {
 482             PB_RETURN_ERROR(stream, "missing required field");
 483         }
 484     } while (pb_field_next(&iter));
 485
 486     return true;
 487 }
 488
 489 bool checkreturn pb_decode(pb_istream_t *stream, const pb_field_t fields[], void *dest_struct)
 490 {
 491     pb_message_set_to_defaults(fields, dest_struct);
 492     return pb_decode_noinit(stream, fields, dest_struct);
 493 }
 494
 495 /* Field decoders */
 496
 497 bool pb_decode_svarint(pb_istream_t *stream, int64_t *dest)
 498 {
 499     uint64_t value;
 500     if (!pb_decode_varint(stream, &value))
 501         return false;
 502
 503     if (value & 1)
 504         *dest = (int64_t)(~(value >> 1));
 505     else
 506         *dest = (int64_t)(value >> 1);
 507
 508     return true;
 509 }
 510
 511 bool pb_decode_fixed32(pb_istream_t *stream, void *dest)
 512 {
 513     #ifdef __BIG_ENDIAN__
 514     uint8_t *bytes = (uint8_t*)dest;
 515     uint8_t lebytes[4];
 516
 517     if (!pb_read(stream, lebytes, 4))
 518         return false;
 519
 520     bytes[0] = lebytes[3];
 521     bytes[1] = lebytes[2];
 522     bytes[2] = lebytes[1];
 523     bytes[3] = lebytes[0];
 524     return true;
 525     #else
 526     return pb_read(stream, (uint8_t*)dest, 4);
 527     #endif
 528 }
 529
 530 bool pb_decode_fixed64(pb_istream_t *stream, void *dest)
 531 {
 532     #ifdef __BIG_ENDIAN__
 533     uint8_t *bytes = (uint8_t*)dest;
 534     uint8_t lebytes[8];
 535
 536     if (!pb_read(stream, lebytes, 8))
 537         return false;
 538
 539     bytes[0] = lebytes[7];
 540     bytes[1] = lebytes[6];
 541     bytes[2] = lebytes[5];
 542     bytes[3] = lebytes[4];
 543     bytes[4] = lebytes[3];
 544     bytes[5] = lebytes[2];
 545     bytes[6] = lebytes[1];
 546     bytes[7] = lebytes[0];
 547     return true;
 548     #else
 549     return pb_read(stream, (uint8_t*)dest, 8);
 550     #endif
 551 }
 552
 553 bool checkreturn pb_dec_varint(pb_istream_t *stream, const pb_field_t *field, void *dest)
 554 {
 555     uint64_t value;
 556     bool status = pb_decode_varint(stream, &value);
 557
 558     switch (field->data_size)
 559     {
 560         case 1: *(uint8_t*)dest = (uint8_t)value; break;
 561         case 2: *(uint16_t*)dest = (uint16_t)value; break;
 562         case 4: *(uint32_t*)dest = (uint32_t)value; break;
 563         case 8: *(uint64_t*)dest = value; break;
 564         default: PB_RETURN_ERROR(stream, "invalid data_size");
 565     }
 566
 567     return status;
 568 }
 569
 570 bool checkreturn pb_dec_svarint(pb_istream_t *stream, const pb_field_t *field, void *dest)
 571 {
 572     int64_t value;
 573     bool status = pb_decode_svarint(stream, &value);
 574
 575     switch (field->data_size)
 576     {
 577         case 4: *(int32_t*)dest = (int32_t)value; break;
 578         case 8: *(int64_t*)dest = value; break;
 579         default: PB_RETURN_ERROR(stream, "invalid data_size");
 580     }
 581
 582     return status;
 583 }
 584
 585 bool checkreturn pb_dec_fixed32(pb_istream_t *stream, const pb_field_t *field, void *dest)
 586 {
 587     UNUSED(field);
 588     return pb_decode_fixed32(stream, dest);
 589 }
 590
 591 bool checkreturn pb_dec_fixed64(pb_istream_t *stream, const pb_field_t *field, void *dest)
 592 {
 593     UNUSED(field);
 594     return pb_decode_fixed64(stream, dest);
 595 }
 596
 597 bool checkreturn pb_dec_bytes(pb_istream_t *stream, const pb_field_t *field, void *dest)
 598 {
 599     pb_bytes_array_t *x = (pb_bytes_array_t*)dest;
 600
 601     uint32_t temp;
 602     if (!pb_decode_varint32(stream, &temp))
 603         return false;
 604     x->size = temp;
 605
 606     /* Check length, noting the space taken by the size_t header. */
 607     if (x->size > field->data_size - offsetof(pb_bytes_array_t, bytes))
 608         PB_RETURN_ERROR(stream, "bytes overflow");
 609
 610     return pb_read(stream, x->bytes, x->size);
 611 }
 612
 613 bool checkreturn pb_dec_string(pb_istream_t *stream, const pb_field_t *field, void *dest)
 614 {
 615     uint32_t size;
 616     bool status;
 617     if (!pb_decode_varint32(stream, &size))
 618         return false;
 619
 620     /* Check length, noting the null terminator */
 621     if (size + 1 > field->data_size)
 622         PB_RETURN_ERROR(stream, "string overflow");
 623
 624     status = pb_read(stream, (uint8_t*)dest, size);
 625     *((uint8_t*)dest + size) = 0;
 626     return status;
 627 }
 628
 629 bool checkreturn pb_dec_submessage(pb_istream_t *stream, const pb_field_t *field, void *dest)
 630 {
 631     bool status;
 632     pb_istream_t substream;
 633     const pb_field_t* submsg_fields = (const pb_field_t*)field->ptr;
 634
 635     if (!pb_make_string_substream(stream, &substream))
 636         return false;
 637
 638     if (field->ptr == NULL)
 639         PB_RETURN_ERROR(stream, "invalid field descriptor");
 640
 641     /* New array entries need to be initialized, while required and optional
 642      * submessages have already been initialized in the top-level pb_decode. */
 643     if (PB_HTYPE(field->type) == PB_HTYPE_ARRAY)
 644         status = pb_decode(&substream, submsg_fields, dest);
 645     else
 646         status = pb_decode_noinit(&substream, submsg_fields, dest);
 647
 648     pb_close_string_substream(stream, &substream);
 649     return status;
 650 }