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
 306     if (PB_ATYPE(field->type) == PB_ATYPE_POINTER)
 307     {
 308         /* For pointer extensions, the pointer is stored directly
 309          * in the extension structure. This avoids having an extra
 310          * indirection. */
 311         return encode_field(stream, field, &extension->dest);
 312     }
 313     else
 314     {
 315         return encode_field(stream, field, extension->dest);
 316     }
 317 }
 318
 319 /* Walk through all the registered extensions and give them a chance
 320  * to encode themselves. */
 321 static bool checkreturn encode_extension_field(pb_ostream_t *stream,
 322     const pb_field_t *field, const void *pData)
 323 {
 324     const pb_extension_t *extension = *(const pb_extension_t* const *)pData;
 325     PB_UNUSED(field);
 326
 327     while (extension)
 328     {
 329         bool status;
 330         if (extension->type->encode)
 331             status = extension->type->encode(stream, extension);
 332         else
 333             status = default_extension_encoder(stream, extension);
 334
 335         if (!status)
 336             return false;
 337
 338         extension = extension->next;
 339     }
 340
 341     return true;
 342 }
 343
 344 /*********************
 345  * Encode all fields *
 346  *********************/
 347
 348 static void *remove_const(const void *p)
 349 {
 350     /* Note: this casts away const, in order to use the common field iterator
 351      * logic for both encoding and decoding. */
 352     union {
 353         void *p1;
 354         const void *p2;
 355     } t;
 356     t.p2 = p;
 357     return t.p1;
 358 }
 359
 360 bool checkreturn pb_encode(pb_ostream_t *stream, const pb_field_t fields[], const void *src_struct)
 361 {
 362     pb_field_iter_t iter;
 363     if (!pb_field_iter_begin(&iter, fields, remove_const(src_struct)))
 364         return true; /* Empty message type */
 365
 366     do {
 367         if (PB_LTYPE(iter.pos->type) == PB_LTYPE_EXTENSION)
 368         {
 369             /* Special case for the extension field placeholder */
 370             if (!encode_extension_field(stream, iter.pos, iter.pData))
 371                 return false;
 372         }
 373         else
 374         {
 375             /* Regular field */
 376             if (!encode_field(stream, iter.pos, iter.pData))
 377                 return false;
 378         }
 379     } while (pb_field_iter_next(&iter));
 380
 381     return true;
 382 }
 383
 384 bool pb_encode_delimited(pb_ostream_t *stream, const pb_field_t fields[], const void *src_struct)
 385 {
 386     return pb_encode_submessage(stream, fields, src_struct);
 387 }
 388
 389 bool pb_get_encoded_size(size_t *size, const pb_field_t fields[], const void *src_struct)
 390 {
 391     pb_ostream_t stream = PB_OSTREAM_SIZING;
 392
 393     if (!pb_encode(&stream, fields, src_struct))
 394         return false;
 395
 396     *size = stream.bytes_written;
 397     return true;
 398 }
 399
 400 /********************
 401  * Helper functions *
 402  ********************/
 403 bool checkreturn pb_encode_varint(pb_ostream_t *stream, uint64_t value)
 404 {
 405     uint8_t buffer[10];
 406     size_t i = 0;
 407
 408     if (value == 0)
 409         return pb_write(stream, (uint8_t*)&value, 1);
 410
 411     while (value)
 412     {
 413         buffer[i] = (uint8_t)((value & 0x7F) | 0x80);
 414         value >>= 7;
 415         i++;
 416     }
 417     buffer[i-1] &= 0x7F; /* Unset top bit on last byte */
 418
 419     return pb_write(stream, buffer, i);
 420 }
 421
 422 bool checkreturn pb_encode_svarint(pb_ostream_t *stream, int64_t value)
 423 {
 424     uint64_t zigzagged;
 425     if (value < 0)
 426         zigzagged = ~((uint64_t)value << 1);
 427     else
 428         zigzagged = (uint64_t)value << 1;
 429
 430     return pb_encode_varint(stream, zigzagged);
 431 }
 432
 433 bool checkreturn pb_encode_fixed32(pb_ostream_t *stream, const void *value)
 434 {
 435     #ifdef __BIG_ENDIAN__
 436     const uint8_t *bytes = value;
 437     uint8_t lebytes[4];
 438     lebytes[0] = bytes[3];
 439     lebytes[1] = bytes[2];
 440     lebytes[2] = bytes[1];
 441     lebytes[3] = bytes[0];
 442     return pb_write(stream, lebytes, 4);
 443     #else
 444     return pb_write(stream, (const uint8_t*)value, 4);
 445     #endif
 446 }
 447
 448 bool checkreturn pb_encode_fixed64(pb_ostream_t *stream, const void *value)
 449 {
 450     #ifdef __BIG_ENDIAN__
 451     const uint8_t *bytes = value;
 452     uint8_t lebytes[8];
 453     lebytes[0] = bytes[7];
 454     lebytes[1] = bytes[6];
 455     lebytes[2] = bytes[5];
 456     lebytes[3] = bytes[4];
 457     lebytes[4] = bytes[3];
 458     lebytes[5] = bytes[2];
 459     lebytes[6] = bytes[1];
 460     lebytes[7] = bytes[0];
 461     return pb_write(stream, lebytes, 8);
 462     #else
 463     return pb_write(stream, (const uint8_t*)value, 8);
 464     #endif
 465 }
 466
 467 bool checkreturn pb_encode_tag(pb_ostream_t *stream, pb_wire_type_t wiretype, uint32_t field_number)
 468 {
 469     uint64_t tag = ((uint64_t)field_number << 3) | wiretype;
 470     return pb_encode_varint(stream, tag);
 471 }
 472
 473 bool checkreturn pb_encode_tag_for_field(pb_ostream_t *stream, const pb_field_t *field)
 474 {
 475     pb_wire_type_t wiretype;
 476     switch (PB_LTYPE(field->type))
 477     {
 478         case PB_LTYPE_VARINT:
 479         case PB_LTYPE_UVARINT:
 480         case PB_LTYPE_SVARINT:
 481             wiretype = PB_WT_VARINT;
 482             break;
 483
 484         case PB_LTYPE_FIXED32:
 485             wiretype = PB_WT_32BIT;
 486             break;
 487
 488         case PB_LTYPE_FIXED64:
 489             wiretype = PB_WT_64BIT;
 490             break;
 491
 492         case PB_LTYPE_BYTES:
 493         case PB_LTYPE_STRING:
 494         case PB_LTYPE_SUBMESSAGE:
 495             wiretype = PB_WT_STRING;
 496             break;
 497
 498         default:
 499             PB_RETURN_ERROR(stream, "invalid field type");
 500     }
 501
 502     return pb_encode_tag(stream, wiretype, field->tag);
 503 }
 504
 505 bool checkreturn pb_encode_string(pb_ostream_t *stream, const uint8_t *buffer, size_t size)
 506 {
 507     if (!pb_encode_varint(stream, (uint64_t)size))
 508         return false;
 509
 510     return pb_write(stream, buffer, size);
 511 }
 512
 513 bool checkreturn pb_encode_submessage(pb_ostream_t *stream, const pb_field_t fields[], const void *src_struct)
 514 {
 515     /* First calculate the message size using a non-writing substream. */
 516     pb_ostream_t substream = PB_OSTREAM_SIZING;
 517     size_t size;
 518     bool status;
 519
 520     if (!pb_encode(&substream, fields, src_struct))
 521     {
 522 #ifndef PB_NO_ERRMSG
 523         stream->errmsg = substream.errmsg;
 524 #endif
 525         return false;
 526     }
 527
 528     size = substream.bytes_written;
 529
 530     if (!pb_encode_varint(stream, (uint64_t)size))
 531         return false;
 532
 533     if (stream->callback == NULL)
 534         return pb_write(stream, NULL, size); /* Just sizing */
 535
 536     if (stream->bytes_written + size > stream->max_size)
 537         PB_RETURN_ERROR(stream, "stream full");
 538
 539     /* Use a substream to verify that a callback doesn't write more than
 540      * what it did the first time. */
 541     substream.callback = stream->callback;
 542     substream.state = stream->state;
 543     substream.max_size = size;
 544     substream.bytes_written = 0;
 545 #ifndef PB_NO_ERRMSG
 546     substream.errmsg = NULL;
 547 #endif
 548
 549     status = pb_encode(&substream, fields, src_struct);
 550
 551     stream->bytes_written += substream.bytes_written;
 552     stream->state = substream.state;
 553 #ifndef PB_NO_ERRMSG
 554     stream->errmsg = substream.errmsg;
 555 #endif
 556
 557     if (substream.bytes_written != size)
 558         PB_RETURN_ERROR(stream, "submsg size changed");
 559
 560     return status;
 561 }
 562
 563 /* Field encoders */
 564
 565 static bool checkreturn pb_enc_varint(pb_ostream_t *stream, const pb_field_t *field, const void *src)
 566 {
 567     int64_t value = 0;
 568
 569     /* Cases 1 and 2 are for compilers that have smaller types for bool
 570      * or enums, and for int_size option. */
 571     switch (field->data_size)
 572     {
 573         case 1: value = *(const int8_t*)src; break;
 574         case 2: value = *(const int16_t*)src; break;
 575         case 4: value = *(const int32_t*)src; break;
 576         case 8: value = *(const int64_t*)src; break;
 577         default: PB_RETURN_ERROR(stream, "invalid data_size");
 578     }
 579
 580     return pb_encode_varint(stream, (uint64_t)value);
 581 }
 582
 583 static bool checkreturn pb_enc_uvarint(pb_ostream_t *stream, const pb_field_t *field, const void *src)
 584 {
 585     uint64_t value = 0;
 586
 587     switch (field->data_size)
 588     {
 589         case 1: value = *(const uint8_t*)src; break;
 590         case 2: value = *(const uint16_t*)src; break;
 591         case 4: value = *(const uint32_t*)src; break;
 592         case 8: value = *(const uint64_t*)src; break;
 593         default: PB_RETURN_ERROR(stream, "invalid data_size");
 594     }
 595
 596     return pb_encode_varint(stream, value);
 597 }
 598
 599 static bool checkreturn pb_enc_svarint(pb_ostream_t *stream, const pb_field_t *field, const void *src)
 600 {
 601     int64_t value = 0;
 602
 603     switch (field->data_size)
 604     {
 605         case 1: value = *(const int8_t*)src; break;
 606         case 2: value = *(const int16_t*)src; break;
 607         case 4: value = *(const int32_t*)src; break;
 608         case 8: value = *(const int64_t*)src; break;
 609         default: PB_RETURN_ERROR(stream, "invalid data_size");
 610     }
 611
 612     return pb_encode_svarint(stream, value);
 613 }
 614
 615 static bool checkreturn pb_enc_fixed64(pb_ostream_t *stream, const pb_field_t *field, const void *src)
 616 {
 617     PB_UNUSED(field);
 618     return pb_encode_fixed64(stream, src);
 619 }
 620
 621 static bool checkreturn pb_enc_fixed32(pb_ostream_t *stream, const pb_field_t *field, const void *src)
 622 {
 623     PB_UNUSED(field);
 624     return pb_encode_fixed32(stream, src);
 625 }
 626
 627 static bool checkreturn pb_enc_bytes(pb_ostream_t *stream, const pb_field_t *field, const void *src)
 628 {
 629     const pb_bytes_array_t *bytes = (const pb_bytes_array_t*)src;
 630
 631     if (src == NULL)
 632     {
 633         /* Threat null pointer as an empty bytes field */
 634         return pb_encode_string(stream, NULL, 0);
 635     }
 636
 637     if (PB_ATYPE(field->type) == PB_ATYPE_STATIC &&
 638         PB_BYTES_ARRAY_T_ALLOCSIZE(bytes->size) > field->data_size)
 639     {
 640         PB_RETURN_ERROR(stream, "bytes size exceeded");
 641     }
 642
 643     return pb_encode_string(stream, bytes->bytes, bytes->size);
 644 }
 645
 646 static bool checkreturn pb_enc_string(pb_ostream_t *stream, const pb_field_t *field, const void *src)
 647 {
 648     size_t size = 0;
 649     size_t max_size = field->data_size;
 650     const char *p = (const char*)src;
 651
 652     if (PB_ATYPE(field->type) == PB_ATYPE_POINTER)
 653         max_size = (size_t)-1;
 654
 655     if (src == NULL)
 656     {
 657         size = 0; /* Threat null pointer as an empty string */
 658     }
 659     else
 660     {
 661         /* strnlen() is not always available, so just use a loop */
 662         while (size < max_size && *p != '\0')
 663         {
 664             size++;
 665             p++;
 666         }
 667     }
 668
 669     return pb_encode_string(stream, (const uint8_t*)src, size);
 670 }
 671
 672 static bool checkreturn pb_enc_submessage(pb_ostream_t *stream, const pb_field_t *field, const void *src)
 673 {
 674     if (field->ptr == NULL)
 675         PB_RETURN_ERROR(stream, "invalid field descriptor");
 676
 677     return pb_encode_submessage(stream, (const pb_field_t*)field->ptr, src);
 678 }
 679