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 /* Callbacks don't need this function because they usually know the data type
  87  * without examining the field structure.
  88  * Therefore it is static for now.
  89  */
  90 static bool checkreturn encode_array(pb_ostream_t *stream, const pb_field_t *field,
  91                          const void *pData, size_t count, pb_encoder_t func)
  92 {
  93     size_t i;
  94     const void *p;
  95     size_t size;
  96
  97     if (count == 0)
  98         return true;
  99
 100     if (PB_LTYPE(field->type) <= PB_LTYPE_LAST_PACKABLE)
 101     {
 102         if (!pb_encode_tag(stream, PB_WT_STRING, field->tag))
 103             return false;
 104
 105         /* Determine the total size of packed array. */
 106         if (PB_LTYPE(field->type) == PB_LTYPE_FIXED32)
 107         {
 108             size = 4 * count;
 109         }
 110         else if (PB_LTYPE(field->type) == PB_LTYPE_FIXED64)
 111         {
 112             size = 8 * count;
 113         }
 114         else
 115         {
 116             pb_ostream_t sizestream = PB_OSTREAM_SIZING;
 117             p = pData;
 118             for (i = 0; i < count; i++)
 119             {
 120                 if (!func(&sizestream, field, p))
 121                     return false;
 122                 p = (const char*)p + field->data_size;
 123             }
 124             size = sizestream.bytes_written;
 125         }
 126
 127         if (!pb_encode_varint(stream, (uint64_t)size))
 128             return false;
 129
 130         if (stream->callback == NULL)
 131             return pb_write(stream, NULL, size); /* Just sizing.. */
 132
 133         /* Write the data */
 134         p = pData;
 135         for (i = 0; i < count; i++)
 136         {
 137             if (!func(stream, field, p))
 138                 return false;
 139             p = (const char*)p + field->data_size;
 140         }
 141     }
 142     else
 143     {
 144         p = pData;
 145         for (i = 0; i < count; i++)
 146         {
 147             if (!pb_encode_tag_for_field(stream, field))
 148                 return false;
 149             if (!func(stream, field, p))
 150                 return false;
 151             p = (const char*)p + field->data_size;
 152         }
 153     }
 154
 155     return true;
 156 }
 157
 158 bool checkreturn encode_static_field(pb_ostream_t *stream, const pb_field_t *field, const void *pData)
 159 {
 160     pb_encoder_t func;
 161     const void *pSize;
 162
 163     func = PB_ENCODERS[PB_LTYPE(field->type)];
 164     pSize = (const char*)pData + field->size_offset;
 165
 166     switch (PB_HTYPE(field->type))
 167     {
 168         case PB_HTYPE_REQUIRED:
 169             if (!pb_encode_tag_for_field(stream, field))
 170                 return false;
 171             if (!func(stream, field, pData))
 172                 return false;
 173             break;
 174
 175         case PB_HTYPE_OPTIONAL:
 176             if (*(const bool*)pSize)
 177             {
 178                 if (!pb_encode_tag_for_field(stream, field))
 179                     return false;
 180
 181                 if (!func(stream, field, pData))
 182                     return false;
 183             }
 184             break;
 185
 186         case PB_HTYPE_REPEATED:
 187             if (!encode_array(stream, field, pData, *(const size_t*)pSize, func))
 188                 return false;
 189             break;
 190
 191         default:
 192             PB_RETURN_ERROR(stream, "invalid field type");
 193     }
 194
 195     return true;
 196 }
 197
 198 bool checkreturn encode_callback_field(pb_ostream_t *stream, const pb_field_t *field, const void *pData)
 199 {
 200     const pb_callback_t *callback = (const pb_callback_t*)pData;
 201
 202 #ifdef PB_OLD_CALLBACK_STYLE
 203     const void *arg = callback->arg;
 204 #else
 205     void * const *arg = &(callback->arg);
 206 #endif
 207
 208     if (callback->funcs.encode != NULL)
 209     {
 210         if (!callback->funcs.encode(stream, field, arg))
 211             PB_RETURN_ERROR(stream, "callback error");
 212     }
 213     return true;
 214 }
 215
 216 bool checkreturn pb_encode(pb_ostream_t *stream, const pb_field_t fields[], const void *src_struct)
 217 {
 218     const pb_field_t *field = fields;
 219     const void *pData = src_struct;
 220     size_t prev_size = 0;
 221
 222     while (field->tag != 0)
 223     {
 224         pData = (const char*)pData + prev_size + field->data_offset;
 225         prev_size = field->data_size;
 226
 227         /* Special case for static arrays */
 228         if (PB_ATYPE(field->type) == PB_ATYPE_STATIC &&
 229             PB_HTYPE(field->type) == PB_HTYPE_REPEATED)
 230         {
 231             prev_size *= field->array_size;
 232         }
 233
 234         switch (PB_ATYPE(field->type))
 235         {
 236             case PB_ATYPE_STATIC:
 237                 if (!encode_static_field(stream, field, pData))
 238                     return false;
 239                 break;
 240
 241             case PB_ATYPE_CALLBACK:
 242                 if (!encode_callback_field(stream, field, pData))
 243                     return false;
 244                 break;
 245
 246             default:
 247                 PB_RETURN_ERROR(stream, "invalid field type");
 248         }
 249
 250         field++;
 251     }
 252
 253     return true;
 254 }
 255
 256 bool pb_encode_delimited(pb_ostream_t *stream, const pb_field_t fields[], const void *src_struct)
 257 {
 258     return pb_encode_submessage(stream, fields, src_struct);
 259 }
 260
 261 /* Helper functions */
 262 bool checkreturn pb_encode_varint(pb_ostream_t *stream, uint64_t value)
 263 {
 264     uint8_t buffer[10];
 265     size_t i = 0;
 266
 267     if (value == 0)
 268         return pb_write(stream, (uint8_t*)&value, 1);
 269
 270     while (value)
 271     {
 272         buffer[i] = (uint8_t)((value & 0x7F) | 0x80);
 273         value >>= 7;
 274         i++;
 275     }
 276     buffer[i-1] &= 0x7F; /* Unset top bit on last byte */
 277
 278     return pb_write(stream, buffer, i);
 279 }
 280
 281 bool checkreturn pb_encode_svarint(pb_ostream_t *stream, int64_t value)
 282 {
 283     uint64_t zigzagged;
 284     if (value < 0)
 285         zigzagged = (uint64_t)(~(value << 1));
 286     else
 287         zigzagged = (uint64_t)(value << 1);
 288
 289     return pb_encode_varint(stream, zigzagged);
 290 }
 291
 292 bool checkreturn pb_encode_fixed32(pb_ostream_t *stream, const void *value)
 293 {
 294     #ifdef __BIG_ENDIAN__
 295     const uint8_t *bytes = value;
 296     uint8_t lebytes[4];
 297     lebytes[0] = bytes[3];
 298     lebytes[1] = bytes[2];
 299     lebytes[2] = bytes[1];
 300     lebytes[3] = bytes[0];
 301     return pb_write(stream, lebytes, 4);
 302     #else
 303     return pb_write(stream, (const uint8_t*)value, 4);
 304     #endif
 305 }
 306
 307 bool checkreturn pb_encode_fixed64(pb_ostream_t *stream, const void *value)
 308 {
 309     #ifdef __BIG_ENDIAN__
 310     const uint8_t *bytes = value;
 311     uint8_t lebytes[8];
 312     lebytes[0] = bytes[7];
 313     lebytes[1] = bytes[6];
 314     lebytes[2] = bytes[5];
 315     lebytes[3] = bytes[4];
 316     lebytes[4] = bytes[3];
 317     lebytes[5] = bytes[2];
 318     lebytes[6] = bytes[1];
 319     lebytes[7] = bytes[0];
 320     return pb_write(stream, lebytes, 8);
 321     #else
 322     return pb_write(stream, (const uint8_t*)value, 8);
 323     #endif
 324 }
 325
 326 bool checkreturn pb_encode_tag(pb_ostream_t *stream, pb_wire_type_t wiretype, uint32_t field_number)
 327 {
 328     uint64_t tag = wiretype | (field_number << 3);
 329     return pb_encode_varint(stream, tag);
 330 }
 331
 332 bool checkreturn pb_encode_tag_for_field(pb_ostream_t *stream, const pb_field_t *field)
 333 {
 334     pb_wire_type_t wiretype;
 335     switch (PB_LTYPE(field->type))
 336     {
 337         case PB_LTYPE_VARINT:
 338         case PB_LTYPE_SVARINT:
 339             wiretype = PB_WT_VARINT;
 340             break;
 341
 342         case PB_LTYPE_FIXED32:
 343             wiretype = PB_WT_32BIT;
 344             break;
 345
 346         case PB_LTYPE_FIXED64:
 347             wiretype = PB_WT_64BIT;
 348             break;
 349
 350         case PB_LTYPE_BYTES:
 351         case PB_LTYPE_STRING:
 352         case PB_LTYPE_SUBMESSAGE:
 353             wiretype = PB_WT_STRING;
 354             break;
 355
 356         default:
 357             PB_RETURN_ERROR(stream, "invalid field type");
 358     }
 359
 360     return pb_encode_tag(stream, wiretype, field->tag);
 361 }
 362
 363 bool checkreturn pb_encode_string(pb_ostream_t *stream, const uint8_t *buffer, size_t size)
 364 {
 365     if (!pb_encode_varint(stream, (uint64_t)size))
 366         return false;
 367
 368     return pb_write(stream, buffer, size);
 369 }
 370
 371 bool checkreturn pb_encode_submessage(pb_ostream_t *stream, const pb_field_t fields[], const void *src_struct)
 372 {
 373     /* First calculate the message size using a non-writing substream. */
 374     pb_ostream_t substream = PB_OSTREAM_SIZING;
 375     size_t size;
 376     bool status;
 377
 378     if (!pb_encode(&substream, fields, src_struct))
 379         return false;
 380
 381     size = substream.bytes_written;
 382
 383     if (!pb_encode_varint(stream, (uint64_t)size))
 384         return false;
 385
 386     if (stream->callback == NULL)
 387         return pb_write(stream, NULL, size); /* Just sizing */
 388
 389     if (stream->bytes_written + size > stream->max_size)
 390         PB_RETURN_ERROR(stream, "stream full");
 391
 392     /* Use a substream to verify that a callback doesn't write more than
 393      * what it did the first time. */
 394     substream.callback = stream->callback;
 395     substream.state = stream->state;
 396     substream.max_size = size;
 397     substream.bytes_written = 0;
 398 #ifndef PB_NO_ERRMSG
 399     substream.errmsg = NULL;
 400 #endif
 401
 402     status = pb_encode(&substream, fields, src_struct);
 403
 404     stream->bytes_written += substream.bytes_written;
 405     stream->state = substream.state;
 406 #ifndef PB_NO_ERRMSG
 407     stream->errmsg = substream.errmsg;
 408 #endif
 409
 410     if (substream.bytes_written != size)
 411         PB_RETURN_ERROR(stream, "submsg size changed");
 412
 413     return status;
 414 }
 415
 416 /* Field encoders */
 417
 418 bool checkreturn pb_enc_varint(pb_ostream_t *stream, const pb_field_t *field, const void *src)
 419 {
 420     uint64_t value = 0;
 421
 422     switch (field->data_size)
 423     {
 424         case 1: value = *(const uint8_t*)src; break;
 425         case 2: value = *(const uint16_t*)src; break;
 426         case 4: value = *(const uint32_t*)src; break;
 427         case 8: value = *(const uint64_t*)src; break;
 428         default: PB_RETURN_ERROR(stream, "invalid data_size");
 429     }
 430
 431     return pb_encode_varint(stream, value);
 432 }
 433
 434 bool checkreturn pb_enc_svarint(pb_ostream_t *stream, const pb_field_t *field, const void *src)
 435 {
 436     int64_t value = 0;
 437
 438     switch (field->data_size)
 439     {
 440         case 4: value = *(const int32_t*)src; break;
 441         case 8: value = *(const int64_t*)src; break;
 442         default: PB_RETURN_ERROR(stream, "invalid data_size");
 443     }
 444
 445     return pb_encode_svarint(stream, value);
 446 }
 447
 448 bool checkreturn pb_enc_fixed64(pb_ostream_t *stream, const pb_field_t *field, const void *src)
 449 {
 450     UNUSED(field);
 451     return pb_encode_fixed64(stream, src);
 452 }
 453
 454 bool checkreturn pb_enc_fixed32(pb_ostream_t *stream, const pb_field_t *field, const void *src)
 455 {
 456     UNUSED(field);
 457     return pb_encode_fixed32(stream, src);
 458 }
 459
 460 bool checkreturn pb_enc_bytes(pb_ostream_t *stream, const pb_field_t *field, const void *src)
 461 {
 462     const pb_bytes_array_t *bytes = (const pb_bytes_array_t*)src;
 463     UNUSED(field);
 464     return pb_encode_string(stream, bytes->bytes, bytes->size);
 465 }
 466
 467 bool checkreturn pb_enc_string(pb_ostream_t *stream, const pb_field_t *field, const void *src)
 468 {
 469     /* strnlen() is not always available, so just use a for-loop */
 470     size_t size = 0;
 471     const char *p = (const char*)src;
 472     while (size < field->data_size && *p != '\0')
 473     {
 474         size++;
 475         p++;
 476     }
 477
 478     return pb_encode_string(stream, (const uint8_t*)src, size);
 479 }
 480
 481 bool checkreturn pb_enc_submessage(pb_ostream_t *stream, const pb_field_t *field, const void *src)
 482 {
 483     if (field->ptr == NULL)
 484         PB_RETURN_ERROR(stream, "invalid field descriptor");
 485
 486     return pb_encode_submessage(stream, (const pb_field_t*)field->ptr, src);
 487 }
 488