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