pb_encode.c

   1 /* pb_encode.c -- encode a protobuf using minimal resources
   2  *
   3  * 2011 Petteri Aimonen <jpa@kapsi.fi>
   4  */
   5
   6 #define NANOPB_INTERNALS
   7 #include "pb.h"
   8 #include "pb_encode.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             /* Special case for strings */
 177             if (PB_ATYPE(field->type) == PB_ATYPE_POINTER &&
 178                 PB_LTYPE(field->type) == PB_LTYPE_STRING)
 179             {
 180                 if (!func(stream, field, *(const void**)p))
 181                     return false;
 182             }
 183             else
 184             {
 185                 if (!func(stream, field, p))
 186                     return false;
 187             }
 188             p = (const char*)p + field->data_size;
 189         }
 190     }
 191
 192     return true;
 193 }
 194
 195 /* Encode a field with static allocation, i.e. one whose data is stored
 196  * in the structure itself. */
 197 static bool checkreturn encode_static_field(pb_ostream_t *stream,
 198     const pb_field_t *field, const void *pData)
 199 {
 200     pb_encoder_t func;
 201     const void *pSize;
 202     bool dummy = true;
 203
 204     func = PB_ENCODERS[PB_LTYPE(field->type)];
 205
 206     if (field->size_offset)
 207         pSize = (const char*)pData + field->size_offset;
 208     else if (PB_ATYPE(field->type) == PB_ATYPE_POINTER)
 209         pSize = *(const void**)pData ? &dummy : pData;
 210     else
 211         pSize = &dummy;
 212
 213     if (PB_ATYPE(field->type) == PB_ATYPE_POINTER)
 214         pData = *(const void**)pData;
 215
 216     switch (PB_HTYPE(field->type))
 217     {
 218         case PB_HTYPE_REQUIRED:
 219             if (!pData)
 220                 return false;
 221             if (!pb_encode_tag_for_field(stream, field))
 222                 return false;
 223             if (!func(stream, field, pData))
 224                 return false;
 225             break;
 226
 227         case PB_HTYPE_OPTIONAL:
 228             if (*(const bool*)pSize)
 229             {
 230                 if (!pb_encode_tag_for_field(stream, field))
 231                     return false;
 232
 233                 if (!func(stream, field, pData))
 234                     return false;
 235             }
 236             break;
 237
 238         case PB_HTYPE_REPEATED:
 239             if (!encode_array(stream, field, pData, *(const size_t*)pSize, func))
 240                 return false;
 241             break;
 242
 243         default:
 244             PB_RETURN_ERROR(stream, "invalid field type");
 245     }
 246
 247     return true;
 248 }
 249
 250 /* Encode a field with callback semantics. This means that a user function is
 251  * called to provide and encode the actual data. */
 252 static bool checkreturn encode_callback_field(pb_ostream_t *stream,
 253     const pb_field_t *field, const void *pData)
 254 {
 255     const pb_callback_t *callback = (const pb_callback_t*)pData;
 256
 257 #ifdef PB_OLD_CALLBACK_STYLE
 258     const void *arg = callback->arg;
 259 #else
 260     void * const *arg = &(callback->arg);
 261 #endif
 262
 263     if (callback->funcs.encode != NULL)
 264     {
 265         if (!callback->funcs.encode(stream, field, arg))
 266             PB_RETURN_ERROR(stream, "callback error");
 267     }
 268     return true;
 269 }
 270
 271 /* Encode a single field of any callback or static type. */
 272 static bool checkreturn encode_field(pb_ostream_t *stream,
 273     const pb_field_t *field, const void *pData)
 274 {
 275     switch (PB_ATYPE(field->type))
 276     {
 277         case PB_ATYPE_STATIC:
 278         case PB_ATYPE_POINTER:
 279             return encode_static_field(stream, field, pData);
 280
 281         case PB_ATYPE_CALLBACK:
 282             return encode_callback_field(stream, field, pData);
 283
 284         default:
 285             PB_RETURN_ERROR(stream, "invalid field type");
 286     }
 287 }
 288
 289 /* Default handler for extension fields. Expects to have a pb_field_t
 290  * pointer in the extension->type->arg field. */
 291 static bool checkreturn default_extension_encoder(pb_ostream_t *stream,
 292     const pb_extension_t *extension)
 293 {
 294     const pb_field_t *field = (const pb_field_t*)extension->type->arg;
 295     return encode_field(stream, field, extension->dest);
 296 }
 297
 298 /* Walk through all the registered extensions and give them a chance
 299  * to encode themselves. */
 300 static bool checkreturn encode_extension_field(pb_ostream_t *stream,
 301     const pb_field_t *field, const void *pData)
 302 {
 303     const pb_extension_t *extension = *(const pb_extension_t* const *)pData;
 304     UNUSED(field);
 305
 306     while (extension)
 307     {
 308         bool status;
 309         if (extension->type->encode)
 310             status = extension->type->encode(stream, extension);
 311         else
 312             status = default_extension_encoder(stream, extension);
 313
 314         if (!status)
 315             return false;
 316
 317         extension = extension->next;
 318     }
 319
 320     return true;
 321 }
 322
 323 /*********************
 324  * Encode all fields *
 325  *********************/
 326
 327 bool checkreturn pb_encode(pb_ostream_t *stream, const pb_field_t fields[], const void *src_struct)
 328 {
 329     const pb_field_t *field = fields;
 330     const void *pData = src_struct;
 331     size_t prev_size = 0;
 332
 333     while (field->tag != 0)
 334     {
 335         pData = (const char*)pData + prev_size + field->data_offset;
 336         if (PB_ATYPE(field->type) == PB_ATYPE_POINTER)
 337             prev_size = sizeof(const void*);
 338         else
 339             prev_size = field->data_size;
 340
 341         /* Special case for static arrays */
 342         if (PB_ATYPE(field->type) == PB_ATYPE_STATIC &&
 343             PB_HTYPE(field->type) == PB_HTYPE_REPEATED)
 344         {
 345             prev_size *= field->array_size;
 346         }
 347
 348         if (PB_LTYPE(field->type) == PB_LTYPE_EXTENSION)
 349         {
 350             /* Special case for the extension field placeholder */
 351             if (!encode_extension_field(stream, field, pData))
 352                 return false;
 353         }
 354         else
 355         {
 356             /* Regular field */
 357             if (!encode_field(stream, field, pData))
 358                 return false;
 359         }
 360
 361         field++;
 362     }
 363
 364     return true;
 365 }
 366
 367 bool pb_encode_delimited(pb_ostream_t *stream, const pb_field_t fields[], const void *src_struct)
 368 {
 369     return pb_encode_submessage(stream, fields, src_struct);
 370 }
 371
 372 /********************
 373  * Helper functions *
 374  ********************/
 375 bool checkreturn pb_encode_varint(pb_ostream_t *stream, uint64_t value)
 376 {
 377     uint8_t buffer[10];
 378     size_t i = 0;
 379
 380     if (value == 0)
 381         return pb_write(stream, (uint8_t*)&value, 1);
 382
 383     while (value)
 384     {
 385         buffer[i] = (uint8_t)((value & 0x7F) | 0x80);
 386         value >>= 7;
 387         i++;
 388     }
 389     buffer[i-1] &= 0x7F; /* Unset top bit on last byte */
 390
 391     return pb_write(stream, buffer, i);
 392 }
 393
 394 bool checkreturn pb_encode_svarint(pb_ostream_t *stream, int64_t value)
 395 {
 396     uint64_t zigzagged;
 397     if (value < 0)
 398         zigzagged = (uint64_t)(~(value << 1));
 399     else
 400         zigzagged = (uint64_t)(value << 1);
 401
 402     return pb_encode_varint(stream, zigzagged);
 403 }
 404
 405 bool checkreturn pb_encode_fixed32(pb_ostream_t *stream, const void *value)
 406 {
 407     #ifdef __BIG_ENDIAN__
 408     const uint8_t *bytes = value;
 409     uint8_t lebytes[4];
 410     lebytes[0] = bytes[3];
 411     lebytes[1] = bytes[2];
 412     lebytes[2] = bytes[1];
 413     lebytes[3] = bytes[0];
 414     return pb_write(stream, lebytes, 4);
 415     #else
 416     return pb_write(stream, (const uint8_t*)value, 4);
 417     #endif
 418 }
 419
 420 bool checkreturn pb_encode_fixed64(pb_ostream_t *stream, const void *value)
 421 {
 422     #ifdef __BIG_ENDIAN__
 423     const uint8_t *bytes = value;
 424     uint8_t lebytes[8];
 425     lebytes[0] = bytes[7];
 426     lebytes[1] = bytes[6];
 427     lebytes[2] = bytes[5];
 428     lebytes[3] = bytes[4];
 429     lebytes[4] = bytes[3];
 430     lebytes[5] = bytes[2];
 431     lebytes[6] = bytes[1];
 432     lebytes[7] = bytes[0];
 433     return pb_write(stream, lebytes, 8);
 434     #else
 435     return pb_write(stream, (const uint8_t*)value, 8);
 436     #endif
 437 }
 438
 439 bool checkreturn pb_encode_tag(pb_ostream_t *stream, pb_wire_type_t wiretype, uint32_t field_number)
 440 {
 441     uint64_t tag = wiretype | (field_number << 3);
 442     return pb_encode_varint(stream, tag);
 443 }
 444
 445 bool checkreturn pb_encode_tag_for_field(pb_ostream_t *stream, const pb_field_t *field)
 446 {
 447     pb_wire_type_t wiretype;
 448     switch (PB_LTYPE(field->type))
 449     {
 450         case PB_LTYPE_VARINT:
 451         case PB_LTYPE_UVARINT:
 452         case PB_LTYPE_SVARINT:
 453             wiretype = PB_WT_VARINT;
 454             break;
 455
 456         case PB_LTYPE_FIXED32:
 457             wiretype = PB_WT_32BIT;
 458             break;
 459
 460         case PB_LTYPE_FIXED64:
 461             wiretype = PB_WT_64BIT;
 462             break;
 463
 464         case PB_LTYPE_BYTES:
 465         case PB_LTYPE_STRING:
 466         case PB_LTYPE_SUBMESSAGE:
 467             wiretype = PB_WT_STRING;
 468             break;
 469
 470         default:
 471             PB_RETURN_ERROR(stream, "invalid field type");
 472     }
 473
 474     return pb_encode_tag(stream, wiretype, field->tag);
 475 }
 476
 477 bool checkreturn pb_encode_string(pb_ostream_t *stream, const uint8_t *buffer, size_t size)
 478 {
 479     if (!pb_encode_varint(stream, (uint64_t)size))
 480         return false;
 481
 482     return pb_write(stream, buffer, size);
 483 }
 484
 485 bool checkreturn pb_encode_submessage(pb_ostream_t *stream, const pb_field_t fields[], const void *src_struct)
 486 {
 487     /* First calculate the message size using a non-writing substream. */
 488     pb_ostream_t substream = PB_OSTREAM_SIZING;
 489     size_t size;
 490     bool status;
 491
 492     if (!pb_encode(&substream, fields, src_struct))
 493         return false;
 494
 495     size = substream.bytes_written;
 496
 497     if (!pb_encode_varint(stream, (uint64_t)size))
 498         return false;
 499
 500     if (stream->callback == NULL)
 501         return pb_write(stream, NULL, size); /* Just sizing */
 502
 503     if (stream->bytes_written + size > stream->max_size)
 504         PB_RETURN_ERROR(stream, "stream full");
 505
 506     /* Use a substream to verify that a callback doesn't write more than
 507      * what it did the first time. */
 508     substream.callback = stream->callback;
 509     substream.state = stream->state;
 510     substream.max_size = size;
 511     substream.bytes_written = 0;
 512 #ifndef PB_NO_ERRMSG
 513     substream.errmsg = NULL;
 514 #endif
 515
 516     status = pb_encode(&substream, fields, src_struct);
 517
 518     stream->bytes_written += substream.bytes_written;
 519     stream->state = substream.state;
 520 #ifndef PB_NO_ERRMSG
 521     stream->errmsg = substream.errmsg;
 522 #endif
 523
 524     if (substream.bytes_written != size)
 525         PB_RETURN_ERROR(stream, "submsg size changed");
 526
 527     return status;
 528 }
 529
 530 /* Field encoders */
 531
 532 bool checkreturn pb_enc_varint(pb_ostream_t *stream, const pb_field_t *field, const void *src)
 533 {
 534     int64_t value = 0;
 535
 536     /* Cases 1 and 2 are for compilers that have smaller types for bool
 537      * or enums. */
 538     switch (field->data_size)
 539     {
 540         case 1: value = *(const int8_t*)src; break;
 541         case 2: value = *(const int16_t*)src; break;
 542         case 4: value = *(const int32_t*)src; break;
 543         case 8: value = *(const int64_t*)src; break;
 544         default: PB_RETURN_ERROR(stream, "invalid data_size");
 545     }
 546
 547     return pb_encode_varint(stream, (uint64_t)value);
 548 }
 549
 550 bool checkreturn pb_enc_uvarint(pb_ostream_t *stream, const pb_field_t *field, const void *src)
 551 {
 552     uint64_t value = 0;
 553
 554     switch (field->data_size)
 555     {
 556         case 4: value = *(const uint32_t*)src; break;
 557         case 8: value = *(const uint64_t*)src; break;
 558         default: PB_RETURN_ERROR(stream, "invalid data_size");
 559     }
 560
 561     return pb_encode_varint(stream, value);
 562 }
 563
 564 bool checkreturn pb_enc_svarint(pb_ostream_t *stream, const pb_field_t *field, const void *src)
 565 {
 566     int64_t value = 0;
 567
 568     switch (field->data_size)
 569     {
 570         case 4: value = *(const int32_t*)src; break;
 571         case 8: value = *(const int64_t*)src; break;
 572         default: PB_RETURN_ERROR(stream, "invalid data_size");
 573     }
 574
 575     return pb_encode_svarint(stream, value);
 576 }
 577
 578 bool checkreturn pb_enc_fixed64(pb_ostream_t *stream, const pb_field_t *field, const void *src)
 579 {
 580     UNUSED(field);
 581     return pb_encode_fixed64(stream, src);
 582 }
 583
 584 bool checkreturn pb_enc_fixed32(pb_ostream_t *stream, const pb_field_t *field, const void *src)
 585 {
 586     UNUSED(field);
 587     return pb_encode_fixed32(stream, src);
 588 }
 589
 590 bool checkreturn pb_enc_bytes(pb_ostream_t *stream, const pb_field_t *field, const void *src)
 591 {
 592     const pb_bytes_array_t *bytes = (const pb_bytes_array_t*)src;
 593
 594     if (PB_ATYPE(field->type) == PB_ATYPE_POINTER)
 595     {
 596         return pb_encode_string(stream, *(const uint8_t**)bytes->bytes, bytes->size);
 597     }
 598     else
 599     {
 600         if (bytes->size + offsetof(pb_bytes_array_t, bytes) > field->data_size)
 601             PB_RETURN_ERROR(stream, "bytes size exceeded");
 602
 603         return pb_encode_string(stream, bytes->bytes, bytes->size);
 604     }
 605 }
 606
 607 bool checkreturn pb_enc_string(pb_ostream_t *stream, const pb_field_t *field, const void *src)
 608 {
 609     /* strnlen() is not always available, so just use a for-loop */
 610     size_t size = 0;
 611     const char *p = (const char*)src;
 612     if (PB_ATYPE(field->type) == PB_ATYPE_POINTER)
 613     {
 614         while (*p != '\0')
 615         {
 616             size++;
 617             p++;
 618         }
 619     }
 620     else
 621     {
 622         while (size < field->data_size && *p != '\0')
 623         {
 624             size++;
 625             p++;
 626         }
 627     }
 628     return pb_encode_string(stream, (const uint8_t*)src, size);
 629 }
 630
 631 bool checkreturn pb_enc_submessage(pb_ostream_t *stream, const pb_field_t *field, const void *src)
 632 {
 633     if (field->ptr == NULL)
 634         PB_RETURN_ERROR(stream, "invalid field descriptor");
 635
 636     return pb_encode_submessage(stream, (const pb_field_t*)field->ptr, src);
 637 }
 638