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     stream->errmsg = substream->errmsg;
 229 }
 230
 231 /* Iterator for pb_field_t list */
 232 typedef struct {
 233     const pb_field_t *start; /* Start of the pb_field_t array */
 234     const pb_field_t *current; /* Current position of the iterator */
 235     int field_index; /* Zero-based index of the field. */
 236     int required_field_index; /* Zero-based index that counts only the required fields */
 237     void *dest_struct; /* Pointer to the destination structure to decode to */
 238     void *pData; /* Pointer where to store current field value */
 239     void *pSize; /* Pointer where to store the size of current array field */
 240 } pb_field_iterator_t;
 241
 242 static void pb_field_init(pb_field_iterator_t *iter, const pb_field_t *fields, void *dest_struct)
 243 {
 244     iter->start = iter->current = fields;
 245     iter->field_index = 0;
 246     iter->required_field_index = 0;
 247     iter->pData = (char*)dest_struct + iter->current->data_offset;
 248     iter->pSize = (char*)iter->pData + iter->current->size_offset;
 249     iter->dest_struct = dest_struct;
 250 }
 251
 252 static bool pb_field_next(pb_field_iterator_t *iter)
 253 {
 254     bool notwrapped = true;
 255     size_t prev_size = iter->current->data_size;
 256
 257     if (PB_HTYPE(iter->current->type) == PB_HTYPE_ARRAY)
 258         prev_size *= iter->current->array_size;
 259
 260     if (PB_HTYPE(iter->current->type) == PB_HTYPE_REQUIRED)
 261         iter->required_field_index++;
 262
 263     iter->current++;
 264     iter->field_index++;
 265     if (iter->current->tag == 0)
 266     {
 267         iter->current = iter->start;
 268         iter->field_index = 0;
 269         iter->required_field_index = 0;
 270         iter->pData = iter->dest_struct;
 271         prev_size = 0;
 272         notwrapped = false;
 273     }
 274
 275     iter->pData = (char*)iter->pData + prev_size + iter->current->data_offset;
 276     iter->pSize = (char*)iter->pData + iter->current->size_offset;
 277     return notwrapped;
 278 }
 279
 280 static bool checkreturn pb_field_find(pb_field_iterator_t *iter, uint32_t tag)
 281 {
 282     int start = iter->field_index;
 283
 284     do {
 285         if (iter->current->tag == tag)
 286             return true;
 287         pb_field_next(iter);
 288     } while (iter->field_index != start);
 289
 290     return false;
 291 }
 292
 293 /*************************
 294  * Decode a single field *
 295  *************************/
 296
 297 static bool checkreturn decode_field(pb_istream_t *stream, pb_wire_type_t wire_type, pb_field_iterator_t *iter)
 298 {
 299     pb_decoder_t func = PB_DECODERS[PB_LTYPE(iter->current->type)];
 300
 301     switch (PB_HTYPE(iter->current->type))
 302     {
 303         case PB_HTYPE_REQUIRED:
 304             return func(stream, iter->current, iter->pData);
 305
 306         case PB_HTYPE_OPTIONAL:
 307             *(bool*)iter->pSize = true;
 308             return func(stream, iter->current, iter->pData);
 309
 310         case PB_HTYPE_ARRAY:
 311             if (wire_type == PB_WT_STRING
 312                 && PB_LTYPE(iter->current->type) <= PB_LTYPE_LAST_PACKABLE)
 313             {
 314                 /* Packed array */
 315                 bool status;
 316                 size_t *size = (size_t*)iter->pSize;
 317                 pb_istream_t substream;
 318                 if (!pb_make_string_substream(stream, &substream))
 319                     return false;
 320
 321                 while (substream.bytes_left && *size < iter->current->array_size)
 322                 {
 323                     void *pItem = (uint8_t*)iter->pData + iter->current->data_size * (*size);
 324                     if (!func(&substream, iter->current, pItem))
 325                         return false;
 326                     (*size)++;
 327                 }
 328                 status = (substream.bytes_left == 0);
 329                 pb_close_string_substream(stream, &substream);
 330                 return status;
 331             }
 332             else
 333             {
 334                 /* Repeated field */
 335                 size_t *size = (size_t*)iter->pSize;
 336                 void *pItem = (uint8_t*)iter->pData + iter->current->data_size * (*size);
 337                 if (*size >= iter->current->array_size)
 338                     PB_RETURN_ERROR(stream, "array overflow");
 339
 340                 (*size)++;
 341                 return func(stream, iter->current, pItem);
 342             }
 343
 344         case PB_HTYPE_CALLBACK:
 345         {
 346             pb_callback_t *pCallback = (pb_callback_t*)iter->pData;
 347
 348             if (pCallback->funcs.decode == NULL)
 349                 return pb_skip_field(stream, wire_type);
 350
 351             if (wire_type == PB_WT_STRING)
 352             {
 353                 pb_istream_t substream;
 354
 355                 if (!pb_make_string_substream(stream, &substream))
 356                     return false;
 357
 358                 while (substream.bytes_left)
 359                 {
 360                     if (!pCallback->funcs.decode(&substream, iter->current, pCallback->arg))
 361                         PB_RETURN_ERROR(stream, "callback failed");
 362                 }
 363
 364                 pb_close_string_substream(stream, &substream);
 365                 return true;
 366             }
 367             else
 368             {
 369                 /* Copy the single scalar value to stack.
 370                  * This is required so that we can limit the stream length,
 371                  * which in turn allows to use same callback for packed and
 372                  * not-packed fields. */
 373                 pb_istream_t substream;
 374                 uint8_t buffer[10];
 375                 size_t size = sizeof(buffer);
 376
 377                 if (!read_raw_value(stream, wire_type, buffer, &size))
 378                     return false;
 379                 substream = pb_istream_from_buffer(buffer, size);
 380
 381                 return pCallback->funcs.decode(&substream, iter->current, pCallback->arg);
 382             }
 383         }
 384
 385         default:
 386             PB_RETURN_ERROR(stream, "invalid field type");
 387     }
 388 }
 389
 390 /* Initialize message fields to default values, recursively */
 391 static void pb_message_set_to_defaults(const pb_field_t fields[], void *dest_struct)
 392 {
 393     pb_field_iterator_t iter;
 394     pb_field_init(&iter, fields, dest_struct);
 395
 396     /* Initialize size/has fields and apply default values */
 397     do
 398     {
 399         if (iter.current->tag == 0)
 400             continue;
 401
 402         /* Initialize the size field for optional/repeated fields to 0. */
 403         if (PB_HTYPE(iter.current->type) == PB_HTYPE_OPTIONAL)
 404         {
 405             *(bool*)iter.pSize = false;
 406         }
 407         else if (PB_HTYPE(iter.current->type) == PB_HTYPE_ARRAY)
 408         {
 409             *(size_t*)iter.pSize = 0;
 410             continue; /* Array is empty, no need to initialize contents */
 411         }
 412
 413         /* Initialize field contents to default value */
 414         if (PB_HTYPE(iter.current->type) == PB_HTYPE_CALLBACK)
 415         {
 416             continue; /* Don't overwrite callback */
 417         }
 418         else if (PB_LTYPE(iter.current->type) == PB_LTYPE_SUBMESSAGE)
 419         {
 420             pb_message_set_to_defaults((const pb_field_t *) iter.current->ptr, iter.pData);
 421         }
 422         else if (iter.current->ptr != NULL)
 423         {
 424             memcpy(iter.pData, iter.current->ptr, iter.current->data_size);
 425         }
 426         else
 427         {
 428             memset(iter.pData, 0, iter.current->data_size);
 429         }
 430     } while (pb_field_next(&iter));
 431 }
 432
 433 /*********************
 434  * Decode all fields *
 435  *********************/
 436
 437 bool checkreturn pb_decode_noinit(pb_istream_t *stream, const pb_field_t fields[], void *dest_struct)
 438 {
 439     uint8_t fields_seen[(PB_MAX_REQUIRED_FIELDS + 7) / 8] = {0}; /* Used to check for required fields */
 440     pb_field_iterator_t iter;
 441
 442     pb_field_init(&iter, fields, dest_struct);
 443
 444     while (stream->bytes_left)
 445     {
 446         uint32_t tag;
 447         pb_wire_type_t wire_type;
 448         bool eof;
 449
 450         if (!pb_decode_tag(stream, &wire_type, &tag, &eof))
 451         {
 452             if (eof)
 453                 break;
 454             else
 455                 return false;
 456         }
 457
 458         if (!pb_field_find(&iter, tag))
 459         {
 460             /* No match found, skip data */
 461             if (!pb_skip_field(stream, wire_type))
 462                 return false;
 463             continue;
 464         }
 465
 466         if (PB_HTYPE(iter.current->type) == PB_HTYPE_REQUIRED
 467             && iter.required_field_index < PB_MAX_REQUIRED_FIELDS)
 468         {
 469             fields_seen[iter.required_field_index >> 3] |= (uint8_t)(1 << (iter.required_field_index & 7));
 470         }
 471
 472         if (!decode_field(stream, wire_type, &iter))
 473             return false;
 474     }
 475
 476     /* Check that all required fields were present. */
 477     pb_field_init(&iter, fields, dest_struct);
 478     do {
 479         if (PB_HTYPE(iter.current->type) == PB_HTYPE_REQUIRED &&
 480             iter.required_field_index < PB_MAX_REQUIRED_FIELDS &&
 481             !(fields_seen[iter.required_field_index >> 3] & (1 << (iter.required_field_index & 7))))
 482         {
 483             PB_RETURN_ERROR(stream, "missing required field");
 484         }
 485     } while (pb_field_next(&iter));
 486
 487     return true;
 488 }
 489
 490 bool checkreturn pb_decode(pb_istream_t *stream, const pb_field_t fields[], void *dest_struct)
 491 {
 492     pb_message_set_to_defaults(fields, dest_struct);
 493     return pb_decode_noinit(stream, fields, dest_struct);
 494 }
 495
 496 /* Field decoders */
 497
 498 bool pb_decode_svarint(pb_istream_t *stream, int64_t *dest)
 499 {
 500     uint64_t value;
 501     if (!pb_decode_varint(stream, &value))
 502         return false;
 503
 504     if (value & 1)
 505         *dest = (int64_t)(~(value >> 1));
 506     else
 507         *dest = (int64_t)(value >> 1);
 508
 509     return true;
 510 }
 511
 512 bool pb_decode_fixed32(pb_istream_t *stream, void *dest)
 513 {
 514     #ifdef __BIG_ENDIAN__
 515     uint8_t *bytes = (uint8_t*)dest;
 516     uint8_t lebytes[4];
 517
 518     if (!pb_read(stream, lebytes, 4))
 519         return false;
 520
 521     bytes[0] = lebytes[3];
 522     bytes[1] = lebytes[2];
 523     bytes[2] = lebytes[1];
 524     bytes[3] = lebytes[0];
 525     return true;
 526     #else
 527     return pb_read(stream, (uint8_t*)dest, 4);
 528     #endif
 529 }
 530
 531 bool pb_decode_fixed64(pb_istream_t *stream, void *dest)
 532 {
 533     #ifdef __BIG_ENDIAN__
 534     uint8_t *bytes = (uint8_t*)dest;
 535     uint8_t lebytes[8];
 536
 537     if (!pb_read(stream, lebytes, 8))
 538         return false;
 539
 540     bytes[0] = lebytes[7];
 541     bytes[1] = lebytes[6];
 542     bytes[2] = lebytes[5];
 543     bytes[3] = lebytes[4];
 544     bytes[4] = lebytes[3];
 545     bytes[5] = lebytes[2];
 546     bytes[6] = lebytes[1];
 547     bytes[7] = lebytes[0];
 548     return true;
 549     #else
 550     return pb_read(stream, (uint8_t*)dest, 8);
 551     #endif
 552 }
 553
 554 bool checkreturn pb_dec_varint(pb_istream_t *stream, const pb_field_t *field, void *dest)
 555 {
 556     uint64_t value;
 557     bool status = pb_decode_varint(stream, &value);
 558
 559     switch (field->data_size)
 560     {
 561         case 1: *(uint8_t*)dest = (uint8_t)value; break;
 562         case 2: *(uint16_t*)dest = (uint16_t)value; break;
 563         case 4: *(uint32_t*)dest = (uint32_t)value; break;
 564         case 8: *(uint64_t*)dest = value; break;
 565         default: PB_RETURN_ERROR(stream, "invalid data_size");
 566     }
 567
 568     return status;
 569 }
 570
 571 bool checkreturn pb_dec_svarint(pb_istream_t *stream, const pb_field_t *field, void *dest)
 572 {
 573     int64_t value;
 574     bool status = pb_decode_svarint(stream, &value);
 575
 576     switch (field->data_size)
 577     {
 578         case 4: *(int32_t*)dest = (int32_t)value; break;
 579         case 8: *(int64_t*)dest = value; break;
 580         default: PB_RETURN_ERROR(stream, "invalid data_size");
 581     }
 582
 583     return status;
 584 }
 585
 586 bool checkreturn pb_dec_fixed32(pb_istream_t *stream, const pb_field_t *field, void *dest)
 587 {
 588     UNUSED(field);
 589     return pb_decode_fixed32(stream, dest);
 590 }
 591
 592 bool checkreturn pb_dec_fixed64(pb_istream_t *stream, const pb_field_t *field, void *dest)
 593 {
 594     UNUSED(field);
 595     return pb_decode_fixed64(stream, dest);
 596 }
 597
 598 bool checkreturn pb_dec_bytes(pb_istream_t *stream, const pb_field_t *field, void *dest)
 599 {
 600     pb_bytes_array_t *x = (pb_bytes_array_t*)dest;
 601
 602     uint32_t temp;
 603     if (!pb_decode_varint32(stream, &temp))
 604         return false;
 605     x->size = temp;
 606
 607     /* Check length, noting the space taken by the size_t header. */
 608     if (x->size > field->data_size - offsetof(pb_bytes_array_t, bytes))
 609         PB_RETURN_ERROR(stream, "bytes overflow");
 610
 611     return pb_read(stream, x->bytes, x->size);
 612 }
 613
 614 bool checkreturn pb_dec_string(pb_istream_t *stream, const pb_field_t *field, void *dest)
 615 {
 616     uint32_t size;
 617     bool status;
 618     if (!pb_decode_varint32(stream, &size))
 619         return false;
 620
 621     /* Check length, noting the null terminator */
 622     if (size + 1 > field->data_size)
 623         PB_RETURN_ERROR(stream, "string overflow");
 624
 625     status = pb_read(stream, (uint8_t*)dest, size);
 626     *((uint8_t*)dest + size) = 0;
 627     return status;
 628 }
 629
 630 bool checkreturn pb_dec_submessage(pb_istream_t *stream, const pb_field_t *field, void *dest)
 631 {
 632     bool status;
 633     pb_istream_t substream;
 634     const pb_field_t* submsg_fields = (const pb_field_t*)field->ptr;
 635
 636     if (!pb_make_string_substream(stream, &substream))
 637         return false;
 638
 639     if (field->ptr == NULL)
 640         PB_RETURN_ERROR(stream, "invalid field descriptor");
 641
 642     /* New array entries need to be initialized, while required and optional
 643      * submessages have already been initialized in the top-level pb_decode. */
 644     if (PB_HTYPE(field->type) == PB_HTYPE_ARRAY)
 645         status = pb_decode(&substream, submsg_fields, dest);
 646     else
 647         status = pb_decode_noinit(&substream, submsg_fields, dest);
 648
 649     pb_close_string_substream(stream, &substream);
 650     return status;
 651 }