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