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