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 /* The warn_unused_result attribute appeared first in gcc-3.4.0 */
  11 #if !defined(__GNUC__) || ( __GNUC__ < 3) || (__GNUC__ == 3 && __GNUC_MINOR__ < 4)
  12     #define checkreturn
  13 #else
  14     /* Verify that we remember to check all return values for proper error propagation */
  15     #define checkreturn __attribute__((warn_unused_result))
  16 #endif
  17
  18 typedef bool (*pb_encoder_t)(pb_ostream_t *stream, const pb_field_t *field, const void *src) checkreturn;
  19
  20 /* --- Function pointers to field encoders ---
  21  * Order in the array must match pb_action_t LTYPE numbering.
  22  */
  23 static const pb_encoder_t PB_ENCODERS[PB_LTYPES_COUNT] = {
  24     &pb_enc_varint,
  25     &pb_enc_svarint,
  26     &pb_enc_fixed32,
  27     &pb_enc_fixed64,
  28
  29     &pb_enc_bytes,
  30     &pb_enc_string,
  31     &pb_enc_submessage
  32 };
  33
  34 /* pb_ostream_t implementation */
  35
  36 static bool checkreturn buf_write(pb_ostream_t *stream, const uint8_t *buf, size_t count)
  37 {
  38     uint8_t *dest = (uint8_t*)stream->state;
  39     stream->state = dest + count;
  40
  41     while (count--)
  42         *dest++ = *buf++;
  43
  44     return true;
  45 }
  46
  47 pb_ostream_t pb_ostream_from_buffer(uint8_t *buf, size_t bufsize)
  48 {
  49     pb_ostream_t stream;
  50 #ifdef PB_BUFFER_ONLY
  51     stream.callback = (void*)1; /* Just some marker value */
  52 #else
  53     stream.callback = &buf_write;
  54 #endif
  55     stream.state = buf;
  56     stream.max_size = bufsize;
  57     stream.bytes_written = 0;
  58 #ifndef PB_NO_ERRMSG
  59     stream.errmsg = NULL;
  60 #endif
  61     return stream;
  62 }
  63
  64 bool checkreturn pb_write(pb_ostream_t *stream, const uint8_t *buf, size_t count)
  65 {
  66     if (stream->callback != NULL)
  67     {
  68         if (stream->bytes_written + count > stream->max_size)
  69             PB_RETURN_ERROR(stream, "stream full");
  70
  71 #ifdef PB_BUFFER_ONLY
  72         if (!buf_write(stream, buf, count))
  73             PB_RETURN_ERROR(stream, "io error");
  74 #else
  75         if (!stream->callback(stream, buf, count))
  76             PB_RETURN_ERROR(stream, "io error");
  77 #endif
  78     }
  79
  80     stream->bytes_written += count;
  81     return true;
  82 }
  83
  84 /* Main encoding stuff */
  85
  86 /* Encode a static array. Handles the size calculations and possible packing. */
  87 static bool checkreturn encode_array(pb_ostream_t *stream, const pb_field_t *field,
  88                          const void *pData, size_t count, pb_encoder_t func)
  89 {
  90     size_t i;
  91     const void *p;
  92     size_t size;
  93
  94     if (count == 0)
  95         return true;
  96
  97     /* We always pack arrays if the datatype allows it. */
  98     if (PB_LTYPE(field->type) <= PB_LTYPE_LAST_PACKABLE)
  99     {
 100         if (!pb_encode_tag(stream, PB_WT_STRING, field->tag))
 101             return false;
 102
 103         /* Determine the total size of packed array. */
 104         if (PB_LTYPE(field->type) == PB_LTYPE_FIXED32)
 105         {
 106             size = 4 * count;
 107         }
 108         else if (PB_LTYPE(field->type) == PB_LTYPE_FIXED64)
 109         {
 110             size = 8 * count;
 111         }
 112         else
 113         {
 114             pb_ostream_t sizestream = PB_OSTREAM_SIZING;
 115             p = pData;
 116             for (i = 0; i < count; i++)
 117             {
 118                 if (!func(&sizestream, field, p))
 119                     return false;
 120                 p = (const char*)p + field->data_size;
 121             }
 122             size = sizestream.bytes_written;
 123         }
 124
 125         if (!pb_encode_varint(stream, (uint64_t)size))
 126             return false;
 127
 128         if (stream->callback == NULL)
 129             return pb_write(stream, NULL, size); /* Just sizing.. */
 130
 131         /* Write the data */
 132         p = pData;
 133         for (i = 0; i < count; i++)
 134         {
 135             if (!func(stream, field, p))
 136                 return false;
 137             p = (const char*)p + field->data_size;
 138         }
 139     }
 140     else
 141     {
 142         p = pData;
 143         for (i = 0; i < count; i++)
 144         {
 145             if (!pb_encode_tag_for_field(stream, field))
 146                 return false;
 147             if (!func(stream, field, p))
 148                 return false;
 149             p = (const char*)p + field->data_size;
 150         }
 151     }
 152
 153     return true;
 154 }
 155
 156 /* Encode a field with static allocation, i.e. one whose data is stored
 157  * in the structure itself. */
 158 static bool checkreturn encode_static_field(pb_ostream_t *stream,
 159     const pb_field_t *field, const void *pData)
 160 {
 161     pb_encoder_t func;
 162     const void *pSize;
 163
 164     func = PB_ENCODERS[PB_LTYPE(field->type)];
 165     pSize = (const char*)pData + field->size_offset;
 166
 167     switch (PB_HTYPE(field->type))
 168     {
 169         case PB_HTYPE_REQUIRED:
 170             if (!pb_encode_tag_for_field(stream, field))
 171                 return false;
 172             if (!func(stream, field, pData))
 173                 return false;
 174             break;
 175
 176         case PB_HTYPE_OPTIONAL:
 177             if (*(const bool*)pSize)
 178             {
 179                 if (!pb_encode_tag_for_field(stream, field))
 180                     return false;
 181
 182                 if (!func(stream, field, pData))
 183                     return false;
 184             }
 185             break;
 186
 187         case PB_HTYPE_REPEATED:
 188             if (!encode_array(stream, field, pData, *(const size_t*)pSize, func))
 189                 return false;
 190             break;
 191
 192         default:
 193             PB_RETURN_ERROR(stream, "invalid field type");
 194     }
 195
 196     return true;
 197 }
 198
 199 /* Encode a field with callback semantics. This means that a user function is
 200  * called to provide and encode the actual data. */
 201 static bool checkreturn encode_callback_field(pb_ostream_t *stream,
 202     const pb_field_t *field, const void *pData)
 203 {
 204     const pb_callback_t *callback = (const pb_callback_t*)pData;
 205
 206 #ifdef PB_OLD_CALLBACK_STYLE
 207     const void *arg = callback->arg;
 208 #else
 209     void * const *arg = &(callback->arg);
 210 #endif
 211
 212     if (callback->funcs.encode != NULL)
 213     {
 214         if (!callback->funcs.encode(stream, field, arg))
 215             PB_RETURN_ERROR(stream, "callback error");
 216     }
 217     return true;
 218 }
 219
 220 /* Encode a single field of any callback or static type. */
 221 static bool checkreturn encode_field(pb_ostream_t *stream,
 222     const pb_field_t *field, const void *pData)
 223 {
 224     switch (PB_ATYPE(field->type))
 225     {
 226         case PB_ATYPE_STATIC:
 227             return encode_static_field(stream, field, pData);
 228
 229         case PB_ATYPE_CALLBACK:
 230             return encode_callback_field(stream, field, pData);
 231
 232         default:
 233             PB_RETURN_ERROR(stream, "invalid field type");
 234     }
 235 }
 236
 237 /* Default handler for extension fields. Expects to have a pb_field_t
 238  * pointer in the extension->type->arg field. */
 239 static bool checkreturn default_extension_handler(pb_ostream_t *stream,
 240     const pb_extension_t *extension)
 241 {
 242     const pb_field_t *field = (const pb_field_t*)extension->type->arg;
 243     return encode_field(stream, field, extension->dest);
 244 }
 245
 246 /* Walk through all the registered extensions and give them a chance
 247  * to encode themselves. */
 248 static bool checkreturn encode_extension_field(pb_ostream_t *stream,
 249     const pb_field_t *field, const void *pData)
 250 {
 251     const pb_extension_t *extension = *(const pb_extension_t* const *)pData;
 252     UNUSED(field);
 253
 254     while (extension)
 255     {
 256         bool status;
 257         if (extension->type->encode)
 258             status = extension->type->encode(stream, extension);
 259         else
 260             status = default_extension_handler(stream, extension);
 261
 262         if (!status)
 263             return false;
 264
 265         extension = extension->next;
 266     }
 267
 268     return true;
 269 }
 270
 271 bool checkreturn pb_encode(pb_ostream_t *stream, const pb_field_t fields[], const void *src_struct)
 272 {
 273     const pb_field_t *field = fields;
 274     const void *pData = src_struct;
 275     size_t prev_size = 0;
 276
 277     while (field->tag != 0)
 278     {
 279         pData = (const char*)pData + prev_size + field->data_offset;
 280         prev_size = field->data_size;
 281
 282         /* Special case for static arrays */
 283         if (PB_ATYPE(field->type) == PB_ATYPE_STATIC &&
 284             PB_HTYPE(field->type) == PB_HTYPE_REPEATED)
 285         {
 286             prev_size *= field->array_size;
 287         }
 288
 289         if (PB_LTYPE(field->type) == PB_LTYPE_EXTENSION)
 290         {
 291             /* Special case for the extension field placeholder */
 292             if (!encode_extension_field(stream, field, pData))
 293                 return false;
 294         }
 295         else
 296         {
 297             /* Regular field */
 298             if (!encode_field(stream, field, pData))
 299                 return false;
 300         }
 301
 302         field++;
 303     }
 304
 305     return true;
 306 }
 307
 308 bool pb_encode_delimited(pb_ostream_t *stream, const pb_field_t fields[], const void *src_struct)
 309 {
 310     return pb_encode_submessage(stream, fields, src_struct);
 311 }
 312
 313 /* Helper functions */
 314 bool checkreturn pb_encode_varint(pb_ostream_t *stream, uint64_t value)
 315 {
 316     uint8_t buffer[10];
 317     size_t i = 0;
 318
 319     if (value == 0)
 320         return pb_write(stream, (uint8_t*)&value, 1);
 321
 322     while (value)
 323     {
 324         buffer[i] = (uint8_t)((value & 0x7F) | 0x80);
 325         value >>= 7;
 326         i++;
 327     }
 328     buffer[i-1] &= 0x7F; /* Unset top bit on last byte */
 329
 330     return pb_write(stream, buffer, i);
 331 }
 332
 333 bool checkreturn pb_encode_svarint(pb_ostream_t *stream, int64_t value)
 334 {
 335     uint64_t zigzagged;
 336     if (value < 0)
 337         zigzagged = (uint64_t)(~(value << 1));
 338     else
 339         zigzagged = (uint64_t)(value << 1);
 340
 341     return pb_encode_varint(stream, zigzagged);
 342 }
 343
 344 bool checkreturn pb_encode_fixed32(pb_ostream_t *stream, const void *value)
 345 {
 346     #ifdef __BIG_ENDIAN__
 347     const uint8_t *bytes = value;
 348     uint8_t lebytes[4];
 349     lebytes[0] = bytes[3];
 350     lebytes[1] = bytes[2];
 351     lebytes[2] = bytes[1];
 352     lebytes[3] = bytes[0];
 353     return pb_write(stream, lebytes, 4);
 354     #else
 355     return pb_write(stream, (const uint8_t*)value, 4);
 356     #endif
 357 }
 358
 359 bool checkreturn pb_encode_fixed64(pb_ostream_t *stream, const void *value)
 360 {
 361     #ifdef __BIG_ENDIAN__
 362     const uint8_t *bytes = value;
 363     uint8_t lebytes[8];
 364     lebytes[0] = bytes[7];
 365     lebytes[1] = bytes[6];
 366     lebytes[2] = bytes[5];
 367     lebytes[3] = bytes[4];
 368     lebytes[4] = bytes[3];
 369     lebytes[5] = bytes[2];
 370     lebytes[6] = bytes[1];
 371     lebytes[7] = bytes[0];
 372     return pb_write(stream, lebytes, 8);
 373     #else
 374     return pb_write(stream, (const uint8_t*)value, 8);
 375     #endif
 376 }
 377
 378 bool checkreturn pb_encode_tag(pb_ostream_t *stream, pb_wire_type_t wiretype, uint32_t field_number)
 379 {
 380     uint64_t tag = wiretype | (field_number << 3);
 381     return pb_encode_varint(stream, tag);
 382 }
 383
 384 bool checkreturn pb_encode_tag_for_field(pb_ostream_t *stream, const pb_field_t *field)
 385 {
 386     pb_wire_type_t wiretype;
 387     switch (PB_LTYPE(field->type))
 388     {
 389         case PB_LTYPE_VARINT:
 390         case PB_LTYPE_SVARINT:
 391             wiretype = PB_WT_VARINT;
 392             break;
 393
 394         case PB_LTYPE_FIXED32:
 395             wiretype = PB_WT_32BIT;
 396             break;
 397
 398         case PB_LTYPE_FIXED64:
 399             wiretype = PB_WT_64BIT;
 400             break;
 401
 402         case PB_LTYPE_BYTES:
 403         case PB_LTYPE_STRING:
 404         case PB_LTYPE_SUBMESSAGE:
 405             wiretype = PB_WT_STRING;
 406             break;
 407
 408         default:
 409             PB_RETURN_ERROR(stream, "invalid field type");
 410     }
 411
 412     return pb_encode_tag(stream, wiretype, field->tag);
 413 }
 414
 415 bool checkreturn pb_encode_string(pb_ostream_t *stream, const uint8_t *buffer, size_t size)
 416 {
 417     if (!pb_encode_varint(stream, (uint64_t)size))
 418         return false;
 419
 420     return pb_write(stream, buffer, size);
 421 }
 422
 423 bool checkreturn pb_encode_submessage(pb_ostream_t *stream, const pb_field_t fields[], const void *src_struct)
 424 {
 425     /* First calculate the message size using a non-writing substream. */
 426     pb_ostream_t substream = PB_OSTREAM_SIZING;
 427     size_t size;
 428     bool status;
 429
 430     if (!pb_encode(&substream, fields, src_struct))
 431         return false;
 432
 433     size = substream.bytes_written;
 434
 435     if (!pb_encode_varint(stream, (uint64_t)size))
 436         return false;
 437
 438     if (stream->callback == NULL)
 439         return pb_write(stream, NULL, size); /* Just sizing */
 440
 441     if (stream->bytes_written + size > stream->max_size)
 442         PB_RETURN_ERROR(stream, "stream full");
 443
 444     /* Use a substream to verify that a callback doesn't write more than
 445      * what it did the first time. */
 446     substream.callback = stream->callback;
 447     substream.state = stream->state;
 448     substream.max_size = size;
 449     substream.bytes_written = 0;
 450 #ifndef PB_NO_ERRMSG
 451     substream.errmsg = NULL;
 452 #endif
 453
 454     status = pb_encode(&substream, fields, src_struct);
 455
 456     stream->bytes_written += substream.bytes_written;
 457     stream->state = substream.state;
 458 #ifndef PB_NO_ERRMSG
 459     stream->errmsg = substream.errmsg;
 460 #endif
 461
 462     if (substream.bytes_written != size)
 463         PB_RETURN_ERROR(stream, "submsg size changed");
 464
 465     return status;
 466 }
 467
 468 /* Field encoders */
 469
 470 bool checkreturn pb_enc_varint(pb_ostream_t *stream, const pb_field_t *field, const void *src)
 471 {
 472     uint64_t value = 0;
 473
 474     switch (field->data_size)
 475     {
 476         case 1: value = *(const uint8_t*)src; break;
 477         case 2: value = *(const uint16_t*)src; break;
 478         case 4: value = *(const uint32_t*)src; break;
 479         case 8: value = *(const uint64_t*)src; break;
 480         default: PB_RETURN_ERROR(stream, "invalid data_size");
 481     }
 482
 483     return pb_encode_varint(stream, value);
 484 }
 485
 486 bool checkreturn pb_enc_svarint(pb_ostream_t *stream, const pb_field_t *field, const void *src)
 487 {
 488     int64_t value = 0;
 489
 490     switch (field->data_size)
 491     {
 492         case 4: value = *(const int32_t*)src; break;
 493         case 8: value = *(const int64_t*)src; break;
 494         default: PB_RETURN_ERROR(stream, "invalid data_size");
 495     }
 496
 497     return pb_encode_svarint(stream, value);
 498 }
 499
 500 bool checkreturn pb_enc_fixed64(pb_ostream_t *stream, const pb_field_t *field, const void *src)
 501 {
 502     UNUSED(field);
 503     return pb_encode_fixed64(stream, src);
 504 }
 505
 506 bool checkreturn pb_enc_fixed32(pb_ostream_t *stream, const pb_field_t *field, const void *src)
 507 {
 508     UNUSED(field);
 509     return pb_encode_fixed32(stream, src);
 510 }
 511
 512 bool checkreturn pb_enc_bytes(pb_ostream_t *stream, const pb_field_t *field, const void *src)
 513 {
 514     const pb_bytes_array_t *bytes = (const pb_bytes_array_t*)src;
 515     UNUSED(field);
 516     return pb_encode_string(stream, bytes->bytes, bytes->size);
 517 }
 518
 519 bool checkreturn pb_enc_string(pb_ostream_t *stream, const pb_field_t *field, const void *src)
 520 {
 521     /* strnlen() is not always available, so just use a for-loop */
 522     size_t size = 0;
 523     const char *p = (const char*)src;
 524     while (size < field->data_size && *p != '\0')
 525     {
 526         size++;
 527         p++;
 528     }
 529
 530     return pb_encode_string(stream, (const uint8_t*)src, size);
 531 }
 532
 533 bool checkreturn pb_enc_submessage(pb_ostream_t *stream, const pb_field_t *field, const void *src)
 534 {
 535     if (field->ptr == NULL)
 536         PB_RETURN_ERROR(stream, "invalid field descriptor");
 537
 538     return pb_encode_submessage(stream, (const pb_field_t*)field->ptr, src);
 539 }
 540