pb_encode.c

   1 /* pb_encode.c -- encode a protobuf using minimal resources
   2  *
   3  * 2011 Petteri Aimonen <jpa@kapsi.fi>
   4  */
   5
   6 #include "pb.h"
   7 #include "pb_encode.h"
   8 #include "pb_common.h"
   9
  10 /* Use the GCC warn_unused_result attribute to check that all return values
  11  * are propagated correctly. On other compilers and gcc before 3.4.0 just
  12  * ignore the annotation.
  13  */
  14 #if !defined(__GNUC__) || ( __GNUC__ < 3) || (__GNUC__ == 3 && __GNUC_MINOR__ < 4)
  15     #define checkreturn
  16 #else
  17     #define checkreturn __attribute__((warn_unused_result))
  18 #endif
  19
  20 /**************************************
  21  * Declarations internal to this file *
  22  **************************************/
  23 typedef bool (*pb_encoder_t)(pb_ostream_t *stream, const pb_field_t *field, const void *src) checkreturn;
  24
  25 static bool checkreturn buf_write(pb_ostream_t *stream, const uint8_t *buf, size_t count);
  26 static bool checkreturn encode_array(pb_ostream_t *stream, const pb_field_t *field, const void *pData, size_t count, pb_encoder_t func);
  27 static bool checkreturn encode_field(pb_ostream_t *stream, const pb_field_t *field, const void *pData);
  28 static bool checkreturn default_extension_encoder(pb_ostream_t *stream, const pb_extension_t *extension);
  29 static bool checkreturn encode_extension_field(pb_ostream_t *stream, const pb_field_t *field, const void *pData);
  30 static bool checkreturn pb_enc_varint(pb_ostream_t *stream, const pb_field_t *field, const void *src);
  31 static bool checkreturn pb_enc_uvarint(pb_ostream_t *stream, const pb_field_t *field, const void *src);
  32 static bool checkreturn pb_enc_svarint(pb_ostream_t *stream, const pb_field_t *field, const void *src);
  33 static bool checkreturn pb_enc_fixed32(pb_ostream_t *stream, const pb_field_t *field, const void *src);
  34 static bool checkreturn pb_enc_fixed64(pb_ostream_t *stream, const pb_field_t *field, const void *src);
  35 static bool checkreturn pb_enc_bytes(pb_ostream_t *stream, const pb_field_t *field, const void *src);
  36 static bool checkreturn pb_enc_string(pb_ostream_t *stream, const pb_field_t *field, const void *src);
  37 static bool checkreturn pb_enc_submessage(pb_ostream_t *stream, const pb_field_t *field, const void *src);
  38
  39 /* --- Function pointers to field encoders ---
  40  * Order in the array must match pb_action_t LTYPE numbering.
  41  */
  42 static const pb_encoder_t PB_ENCODERS[PB_LTYPES_COUNT] = {
  43     &pb_enc_varint,
  44     &pb_enc_uvarint,
  45     &pb_enc_svarint,
  46     &pb_enc_fixed32,
  47     &pb_enc_fixed64,
  48
  49     &pb_enc_bytes,
  50     &pb_enc_string,
  51     &pb_enc_submessage,
  52     NULL /* extensions */
  53 };
  54
  55 /*******************************
  56  * pb_ostream_t implementation *
  57  *******************************/
  58
  59 static bool checkreturn buf_write(pb_ostream_t *stream, const uint8_t *buf, size_t count)
  60 {
  61     uint8_t *dest = (uint8_t*)stream->state;
  62     stream->state = dest + count;
  63
  64     while (count--)
  65         *dest++ = *buf++;
  66
  67     return true;
  68 }
  69
  70 pb_ostream_t pb_ostream_from_buffer(uint8_t *buf, size_t bufsize)
  71 {
  72     pb_ostream_t stream;
  73 #ifdef PB_BUFFER_ONLY
  74     stream.callback = (void*)1; /* Just a marker value */
  75 #else
  76     stream.callback = &buf_write;
  77 #endif
  78     stream.state = buf;
  79     stream.max_size = bufsize;
  80     stream.bytes_written = 0;
  81 #ifndef PB_NO_ERRMSG
  82     stream.errmsg = NULL;
  83 #endif
  84     return stream;
  85 }
  86
  87 bool checkreturn pb_write(pb_ostream_t *stream, const uint8_t *buf, size_t count)
  88 {
  89     if (stream->callback != NULL)
  90     {
  91         if (stream->bytes_written + count > stream->max_size)
  92             PB_RETURN_ERROR(stream, "stream full");
  93
  94 #ifdef PB_BUFFER_ONLY
  95         if (!buf_write(stream, buf, count))
  96             PB_RETURN_ERROR(stream, "io error");
  97 #else
  98         if (!stream->callback(stream, buf, count))
  99             PB_RETURN_ERROR(stream, "io error");
 100 #endif
 101     }
 102
 103     stream->bytes_written += count;
 104     return true;
 105 }
 106
 107 /*************************
 108  * Encode a single field *
 109  *************************/
 110
 111 /* Encode a static array. Handles the size calculations and possible packing. */
 112 static bool checkreturn encode_array(pb_ostream_t *stream, const pb_field_t *field,
 113                          const void *pData, size_t count, pb_encoder_t func)
 114 {
 115     size_t i;
 116     const void *p;
 117     size_t size;
 118
 119     if (count == 0)
 120         return true;
 121
 122     if (PB_ATYPE(field->type) != PB_ATYPE_POINTER && count > field->array_size)
 123         PB_RETURN_ERROR(stream, "array max size exceeded");
 124
 125     /* We always pack arrays if the datatype allows it. */
 126     if (PB_LTYPE(field->type) <= PB_LTYPE_LAST_PACKABLE)
 127     {
 128         if (!pb_encode_tag(stream, PB_WT_STRING, field->tag))
 129             return false;
 130
 131         /* Determine the total size of packed array. */
 132         if (PB_LTYPE(field->type) == PB_LTYPE_FIXED32)
 133         {
 134             size = 4 * count;
 135         }
 136         else if (PB_LTYPE(field->type) == PB_LTYPE_FIXED64)
 137         {
 138             size = 8 * count;
 139         }
 140         else
 141         {
 142             pb_ostream_t sizestream = PB_OSTREAM_SIZING;
 143             p = pData;
 144             for (i = 0; i < count; i++)
 145             {
 146                 if (!func(&sizestream, field, p))
 147                     return false;
 148                 p = (const char*)p + field->data_size;
 149             }
 150             size = sizestream.bytes_written;
 151         }
 152
 153         if (!pb_encode_varint(stream, (uint64_t)size))
 154             return false;
 155
 156         if (stream->callback == NULL)
 157             return pb_write(stream, NULL, size); /* Just sizing.. */
 158
 159         /* Write the data */
 160         p = pData;
 161         for (i = 0; i < count; i++)
 162         {
 163             if (!func(stream, field, p))
 164                 return false;
 165             p = (const char*)p + field->data_size;
 166         }
 167     }
 168     else
 169     {
 170         p = pData;
 171         for (i = 0; i < count; i++)
 172         {
 173             if (!pb_encode_tag_for_field(stream, field))
 174                 return false;
 175
 176             /* Normally the data is stored directly in the array entries, but
 177              * for pointer-type string and bytes fields, the array entries are
 178              * actually pointers themselves also. So we have to dereference once
 179              * more to get to the actual data. */
 180             if (PB_ATYPE(field->type) == PB_ATYPE_POINTER &&
 181                 (PB_LTYPE(field->type) == PB_LTYPE_STRING ||
 182                  PB_LTYPE(field->type) == PB_LTYPE_BYTES))
 183             {
 184                 if (!func(stream, field, *(const void* const*)p))
 185                     return false;
 186             }
 187             else
 188             {
 189                 if (!func(stream, field, p))
 190                     return false;
 191             }
 192             p = (const char*)p + field->data_size;
 193         }
 194     }
 195
 196     return true;
 197 }
 198
 199 /* Encode a field with static or pointer allocation, i.e. one whose data
 200  * is available to the encoder directly. */
 201 static bool checkreturn encode_basic_field(pb_ostream_t *stream,
 202     const pb_field_t *field, const void *pData)
 203 {
 204     pb_encoder_t func;
 205     const void *pSize;
 206     bool implicit_has = true;
 207
 208     func = PB_ENCODERS[PB_LTYPE(field->type)];
 209
 210     if (field->size_offset)
 211         pSize = (const char*)pData + field->size_offset;
 212     else
 213         pSize = &implicit_has;
 214
 215     if (PB_ATYPE(field->type) == PB_ATYPE_POINTER)
 216     {
 217         /* pData is a pointer to the field, which contains pointer to
 218          * the data. If the 2nd pointer is NULL, it is interpreted as if
 219          * the has_field was false.
 220          */
 221
 222         pData = *(const void* const*)pData;
 223         implicit_has = (pData != NULL);
 224     }
 225
 226     switch (PB_HTYPE(field->type))
 227     {
 228         case PB_HTYPE_REQUIRED:
 229             if (!pData)
 230                 PB_RETURN_ERROR(stream, "missing required field");
 231             if (!pb_encode_tag_for_field(stream, field))
 232                 return false;
 233             if (!func(stream, field, pData))
 234                 return false;
 235             break;
 236
 237         case PB_HTYPE_OPTIONAL:
 238             if (*(const bool*)pSize)
 239             {
 240                 if (!pb_encode_tag_for_field(stream, field))
 241                     return false;
 242
 243                 if (!func(stream, field, pData))
 244                     return false;
 245             }
 246             break;
 247
 248         case PB_HTYPE_REPEATED:
 249             if (!encode_array(stream, field, pData, *(const pb_size_t*)pSize, func))
 250                 return false;
 251             break;
 252
 253         default:
 254             PB_RETURN_ERROR(stream, "invalid field type");
 255     }
 256
 257     return true;
 258 }
 259
 260 /* Encode a field with callback semantics. This means that a user function is
 261  * called to provide and encode the actual data. */
 262 static bool checkreturn encode_callback_field(pb_ostream_t *stream,
 263     const pb_field_t *field, const void *pData)
 264 {
 265     const pb_callback_t *callback = (const pb_callback_t*)pData;
 266
 267 #ifdef PB_OLD_CALLBACK_STYLE
 268     const void *arg = callback->arg;
 269 #else
 270     void * const *arg = &(callback->arg);
 271 #endif
 272
 273     if (callback->funcs.encode != NULL)
 274     {
 275         if (!callback->funcs.encode(stream, field, arg))
 276             PB_RETURN_ERROR(stream, "callback error");
 277     }
 278     return true;
 279 }
 280
 281 /* Encode a single field of any callback or static type. */
 282 static bool checkreturn encode_field(pb_ostream_t *stream,
 283     const pb_field_t *field, const void *pData)
 284 {
 285     switch (PB_ATYPE(field->type))
 286     {
 287         case PB_ATYPE_STATIC:
 288         case PB_ATYPE_POINTER:
 289             return encode_basic_field(stream, field, pData);
 290
 291         case PB_ATYPE_CALLBACK:
 292             return encode_callback_field(stream, field, pData);
 293
 294         default:
 295             PB_RETURN_ERROR(stream, "invalid field type");
 296     }
 297 }
 298
 299 /* Default handler for extension fields. Expects to have a pb_field_t
 300  * pointer in the extension->type->arg field. */
 301 static bool checkreturn default_extension_encoder(pb_ostream_t *stream,
 302     const pb_extension_t *extension)
 303 {
 304     const pb_field_t *field = (const pb_field_t*)extension->type->arg;
 305     return encode_field(stream, field, extension->dest);
 306 }
 307
 308 /* Walk through all the registered extensions and give them a chance
 309  * to encode themselves. */
 310 static bool checkreturn encode_extension_field(pb_ostream_t *stream,
 311     const pb_field_t *field, const void *pData)
 312 {
 313     const pb_extension_t *extension = *(const pb_extension_t* const *)pData;
 314     PB_UNUSED(field);
 315
 316     while (extension)
 317     {
 318         bool status;
 319         if (extension->type->encode)
 320             status = extension->type->encode(stream, extension);
 321         else
 322             status = default_extension_encoder(stream, extension);
 323
 324         if (!status)
 325             return false;
 326
 327         extension = extension->next;
 328     }
 329
 330     return true;
 331 }
 332
 333 /*********************
 334  * Encode all fields *
 335  *********************/
 336
 337 static void *remove_const(const void *p)
 338 {
 339     /* Note: this casts away const, in order to use the common field iterator
 340      * logic for both encoding and decoding. */
 341     union {
 342         void *p1;
 343         const void *p2;
 344     } t;
 345     t.p2 = p;
 346     return t.p1;
 347 }
 348
 349 bool checkreturn pb_encode(pb_ostream_t *stream, const pb_field_t fields[], const void *src_struct)
 350 {
 351     pb_field_iter_t iter;
 352     if (!pb_field_iter_begin(&iter, fields, remove_const(src_struct)))
 353         return true; /* Empty message type */
 354
 355     do {
 356         if (PB_LTYPE(iter.pos->type) == PB_LTYPE_EXTENSION)
 357         {
 358             /* Special case for the extension field placeholder */
 359             if (!encode_extension_field(stream, iter.pos, iter.pData))
 360                 return false;
 361         }
 362         else
 363         {
 364             /* Regular field */
 365             if (!encode_field(stream, iter.pos, iter.pData))
 366                 return false;
 367         }
 368     } while (pb_field_iter_next(&iter));
 369
 370     return true;
 371 }
 372
 373 bool pb_encode_delimited(pb_ostream_t *stream, const pb_field_t fields[], const void *src_struct)
 374 {
 375     return pb_encode_submessage(stream, fields, src_struct);
 376 }
 377
 378 bool pb_get_encoded_size(size_t *size, const pb_field_t fields[], const void *src_struct)
 379 {
 380     pb_ostream_t stream = PB_OSTREAM_SIZING;
 381
 382     if (!pb_encode(&stream, fields, src_struct))
 383         return false;
 384
 385     *size = stream.bytes_written;
 386     return true;
 387 }
 388
 389 /********************
 390  * Helper functions *
 391  ********************/
 392 bool checkreturn pb_encode_varint(pb_ostream_t *stream, uint64_t value)
 393 {
 394     uint8_t buffer[10];
 395     size_t i = 0;
 396
 397     if (value == 0)
 398         return pb_write(stream, (uint8_t*)&value, 1);
 399
 400     while (value)
 401     {
 402         buffer[i] = (uint8_t)((value & 0x7F) | 0x80);
 403         value >>= 7;
 404         i++;
 405     }
 406     buffer[i-1] &= 0x7F; /* Unset top bit on last byte */
 407
 408     return pb_write(stream, buffer, i);
 409 }
 410
 411 bool checkreturn pb_encode_svarint(pb_ostream_t *stream, int64_t value)
 412 {
 413     uint64_t zigzagged;
 414     if (value < 0)
 415         zigzagged = ~((uint64_t)value << 1);
 416     else
 417         zigzagged = (uint64_t)value << 1;
 418
 419     return pb_encode_varint(stream, zigzagged);
 420 }
 421
 422 bool checkreturn pb_encode_fixed32(pb_ostream_t *stream, const void *value)
 423 {
 424     #ifdef __BIG_ENDIAN__
 425     const uint8_t *bytes = value;
 426     uint8_t lebytes[4];
 427     lebytes[0] = bytes[3];
 428     lebytes[1] = bytes[2];
 429     lebytes[2] = bytes[1];
 430     lebytes[3] = bytes[0];
 431     return pb_write(stream, lebytes, 4);
 432     #else
 433     return pb_write(stream, (const uint8_t*)value, 4);
 434     #endif
 435 }
 436
 437 bool checkreturn pb_encode_fixed64(pb_ostream_t *stream, const void *value)
 438 {
 439     #ifdef __BIG_ENDIAN__
 440     const uint8_t *bytes = value;
 441     uint8_t lebytes[8];
 442     lebytes[0] = bytes[7];
 443     lebytes[1] = bytes[6];
 444     lebytes[2] = bytes[5];
 445     lebytes[3] = bytes[4];
 446     lebytes[4] = bytes[3];
 447     lebytes[5] = bytes[2];
 448     lebytes[6] = bytes[1];
 449     lebytes[7] = bytes[0];
 450     return pb_write(stream, lebytes, 8);
 451     #else
 452     return pb_write(stream, (const uint8_t*)value, 8);
 453     #endif
 454 }
 455
 456 bool checkreturn pb_encode_tag(pb_ostream_t *stream, pb_wire_type_t wiretype, uint32_t field_number)
 457 {
 458     uint64_t tag = ((uint64_t)field_number << 3) | wiretype;
 459     return pb_encode_varint(stream, tag);
 460 }
 461
 462 bool checkreturn pb_encode_tag_for_field(pb_ostream_t *stream, const pb_field_t *field)
 463 {
 464     pb_wire_type_t wiretype;
 465     switch (PB_LTYPE(field->type))
 466     {
 467         case PB_LTYPE_VARINT:
 468         case PB_LTYPE_UVARINT:
 469         case PB_LTYPE_SVARINT:
 470             wiretype = PB_WT_VARINT;
 471             break;
 472
 473         case PB_LTYPE_FIXED32:
 474             wiretype = PB_WT_32BIT;
 475             break;
 476
 477         case PB_LTYPE_FIXED64:
 478             wiretype = PB_WT_64BIT;
 479             break;
 480
 481         case PB_LTYPE_BYTES:
 482         case PB_LTYPE_STRING:
 483         case PB_LTYPE_SUBMESSAGE:
 484             wiretype = PB_WT_STRING;
 485             break;
 486
 487         default:
 488             PB_RETURN_ERROR(stream, "invalid field type");
 489     }
 490
 491     return pb_encode_tag(stream, wiretype, field->tag);
 492 }
 493
 494 bool checkreturn pb_encode_string(pb_ostream_t *stream, const uint8_t *buffer, size_t size)
 495 {
 496     if (!pb_encode_varint(stream, (uint64_t)size))
 497         return false;
 498
 499     return pb_write(stream, buffer, size);
 500 }
 501
 502 bool checkreturn pb_encode_submessage(pb_ostream_t *stream, const pb_field_t fields[], const void *src_struct)
 503 {
 504     /* First calculate the message size using a non-writing substream. */
 505     pb_ostream_t substream = PB_OSTREAM_SIZING;
 506     size_t size;
 507     bool status;
 508
 509     if (!pb_encode(&substream, fields, src_struct))
 510     {
 511 #ifndef PB_NO_ERRMSG
 512         stream->errmsg = substream.errmsg;
 513 #endif
 514         return false;
 515     }
 516
 517     size = substream.bytes_written;
 518
 519     if (!pb_encode_varint(stream, (uint64_t)size))
 520         return false;
 521
 522     if (stream->callback == NULL)
 523         return pb_write(stream, NULL, size); /* Just sizing */
 524
 525     if (stream->bytes_written + size > stream->max_size)
 526         PB_RETURN_ERROR(stream, "stream full");
 527
 528     /* Use a substream to verify that a callback doesn't write more than
 529      * what it did the first time. */
 530     substream.callback = stream->callback;
 531     substream.state = stream->state;
 532     substream.max_size = size;
 533     substream.bytes_written = 0;
 534 #ifndef PB_NO_ERRMSG
 535     substream.errmsg = NULL;
 536 #endif
 537
 538     status = pb_encode(&substream, fields, src_struct);
 539
 540     stream->bytes_written += substream.bytes_written;
 541     stream->state = substream.state;
 542 #ifndef PB_NO_ERRMSG
 543     stream->errmsg = substream.errmsg;
 544 #endif
 545
 546     if (substream.bytes_written != size)
 547         PB_RETURN_ERROR(stream, "submsg size changed");
 548
 549     return status;
 550 }
 551
 552 /* Field encoders */
 553
 554 static bool checkreturn pb_enc_varint(pb_ostream_t *stream, const pb_field_t *field, const void *src)
 555 {
 556     int64_t value = 0;
 557
 558     /* Cases 1 and 2 are for compilers that have smaller types for bool
 559      * or enums. */
 560     switch (field->data_size)
 561     {
 562         case 1: value = *(const int8_t*)src; break;
 563         case 2: value = *(const int16_t*)src; break;
 564         case 4: value = *(const int32_t*)src; break;
 565         case 8: value = *(const int64_t*)src; break;
 566         default: PB_RETURN_ERROR(stream, "invalid data_size");
 567     }
 568
 569     return pb_encode_varint(stream, (uint64_t)value);
 570 }
 571
 572 static bool checkreturn pb_enc_uvarint(pb_ostream_t *stream, const pb_field_t *field, const void *src)
 573 {
 574     uint64_t value = 0;
 575
 576     switch (field->data_size)
 577     {
 578         case 4: value = *(const uint32_t*)src; break;
 579         case 8: value = *(const uint64_t*)src; break;
 580         default: PB_RETURN_ERROR(stream, "invalid data_size");
 581     }
 582
 583     return pb_encode_varint(stream, value);
 584 }
 585
 586 static bool checkreturn pb_enc_svarint(pb_ostream_t *stream, const pb_field_t *field, const void *src)
 587 {
 588     int64_t value = 0;
 589
 590     switch (field->data_size)
 591     {
 592         case 4: value = *(const int32_t*)src; break;
 593         case 8: value = *(const int64_t*)src; break;
 594         default: PB_RETURN_ERROR(stream, "invalid data_size");
 595     }
 596
 597     return pb_encode_svarint(stream, value);
 598 }
 599
 600 static bool checkreturn pb_enc_fixed64(pb_ostream_t *stream, const pb_field_t *field, const void *src)
 601 {
 602     PB_UNUSED(field);
 603     return pb_encode_fixed64(stream, src);
 604 }
 605
 606 static bool checkreturn pb_enc_fixed32(pb_ostream_t *stream, const pb_field_t *field, const void *src)
 607 {
 608     PB_UNUSED(field);
 609     return pb_encode_fixed32(stream, src);
 610 }
 611
 612 static bool checkreturn pb_enc_bytes(pb_ostream_t *stream, const pb_field_t *field, const void *src)
 613 {
 614     const pb_bytes_array_t *bytes = (const pb_bytes_array_t*)src;
 615
 616     if (src == NULL)
 617     {
 618         /* Threat null pointer as an empty bytes field */
 619         return pb_encode_string(stream, NULL, 0);
 620     }
 621
 622     if (PB_ATYPE(field->type) == PB_ATYPE_STATIC &&
 623         PB_BYTES_ARRAY_T_ALLOCSIZE(bytes->size) > field->data_size)
 624     {
 625         PB_RETURN_ERROR(stream, "bytes size exceeded");
 626     }
 627
 628     return pb_encode_string(stream, bytes->bytes, bytes->size);
 629 }
 630
 631 static bool checkreturn pb_enc_string(pb_ostream_t *stream, const pb_field_t *field, const void *src)
 632 {
 633     size_t size = 0;
 634     size_t max_size = field->data_size;
 635     const char *p = (const char*)src;
 636
 637     if (PB_ATYPE(field->type) == PB_ATYPE_POINTER)
 638         max_size = (size_t)-1;
 639
 640     if (src == NULL)
 641     {
 642         size = 0; /* Threat null pointer as an empty string */
 643     }
 644     else
 645     {
 646         /* strnlen() is not always available, so just use a loop */
 647         while (size < max_size && *p != '\0')
 648         {
 649             size++;
 650             p++;
 651         }
 652     }
 653
 654     return pb_encode_string(stream, (const uint8_t*)src, size);
 655 }
 656
 657 static bool checkreturn pb_enc_submessage(pb_ostream_t *stream, const pb_field_t *field, const void *src)
 658 {
 659     if (field->ptr == NULL)
 660         PB_RETURN_ERROR(stream, "invalid field descriptor");
 661
 662     return pb_encode_submessage(stream, (const pb_field_t*)field->ptr, src);
 663 }
 664