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 #ifdef __GNUC__
  12 /* Verify that we remember to check all return values for proper error propagation */
  13 #define checkreturn __attribute__((warn_unused_result))
  14 #else
  15 #define checkreturn
  16 #endif
  17
  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     memcpy(dest, buf, count);
  41     stream->state = dest + count;
  42     return true;
  43 }
  44
  45 pb_ostream_t pb_ostream_from_buffer(uint8_t *buf, size_t bufsize)
  46 {
  47     pb_ostream_t stream;
  48     stream.callback = &buf_write;
  49     stream.state = buf;
  50     stream.max_size = bufsize;
  51     stream.bytes_written = 0;
  52     return stream;
  53 }
  54
  55 bool checkreturn pb_write(pb_ostream_t *stream, const uint8_t *buf, size_t count)
  56 {
  57     if (stream->callback != NULL)
  58     {
  59         if (stream->bytes_written + count > stream->max_size)
  60             return false;
  61
  62         if (!stream->callback(stream, buf, count))
  63             return false;
  64     }
  65
  66     stream->bytes_written += count;
  67     return true;
  68 }
  69
  70 /* Main encoding stuff */
  71
  72 /* Callbacks don't need this function because they usually know the data type
  73  * without examining the field structure.
  74  * Therefore it is static for now.
  75  */
  76 static bool checkreturn encode_array(pb_ostream_t *stream, const pb_field_t *field,
  77                          const void *pData, size_t count, pb_encoder_t func)
  78 {
  79     int i;
  80     const void *p;
  81     size_t size;
  82
  83     if (count == 0)
  84         return true;
  85
  86     if (PB_LTYPE(field->type) <= PB_LTYPE_LAST_PACKABLE)
  87     {
  88         if (!pb_encode_tag(stream, PB_WT_STRING, field->tag))
  89             return false;
  90
  91         /* Determine the total size of packed array. */
  92         if (PB_LTYPE(field->type) == PB_LTYPE_FIXED32)
  93         {
  94             size = 4 * count;
  95         }
  96         else if (PB_LTYPE(field->type) == PB_LTYPE_FIXED64)
  97         {
  98             size = 8 * count;
  99         }
 100         else
 101         {
 102             pb_ostream_t sizestream = {0};
 103             p = pData;
 104             for (i = 0; i < count; i++)
 105             {
 106                 if (!func(&sizestream, field, p))
 107                     return false;
 108                 p = (const char*)p + field->data_size;
 109             }
 110             size = sizestream.bytes_written;
 111         }
 112
 113         if (!pb_encode_varint(stream, size))
 114             return false;
 115
 116         if (stream->callback == NULL)
 117             return pb_write(stream, NULL, size); /* Just sizing.. */
 118
 119         /* Write the data */
 120         p = pData;
 121         for (i = 0; i < count; i++)
 122         {
 123             if (!func(stream, field, p))
 124                 return false;
 125             p = (const char*)p + field->data_size;
 126         }
 127     }
 128     else
 129     {
 130         p = pData;
 131         for (i = 0; i < count; i++)
 132         {
 133             if (!pb_encode_tag_for_field(stream, field))
 134                 return false;
 135             if (!func(stream, field, p))
 136                 return false;
 137             p = (const char*)p + field->data_size;
 138         }
 139     }
 140
 141     return true;
 142 }
 143
 144 bool checkreturn pb_encode(pb_ostream_t *stream, const pb_field_t fields[], const void *src_struct)
 145 {
 146     const pb_field_t *field = fields;
 147     const void *pData = src_struct;
 148     const void *pSize;
 149     size_t prev_size = 0;
 150
 151     while (field->tag != 0)
 152     {
 153         pb_encoder_t func = PB_ENCODERS[PB_LTYPE(field->type)];
 154         pData = (const char*)pData + prev_size + field->data_offset;
 155         pSize = (const char*)pData + field->size_offset;
 156
 157         prev_size = field->data_size;
 158         if (PB_HTYPE(field->type) == PB_HTYPE_ARRAY)
 159             prev_size *= field->array_size;
 160
 161         switch (PB_HTYPE(field->type))
 162         {
 163             case PB_HTYPE_REQUIRED:
 164                 if (!pb_encode_tag_for_field(stream, field))
 165                     return false;
 166                 if (!func(stream, field, pData))
 167                     return false;
 168                 break;
 169
 170             case PB_HTYPE_OPTIONAL:
 171                 if (*(bool*)pSize)
 172                 {
 173                     if (!pb_encode_tag_for_field(stream, field))
 174                         return false;
 175
 176                     if (!func(stream, field, pData))
 177                         return false;
 178                 }
 179                 break;
 180
 181             case PB_HTYPE_ARRAY:
 182                 if (!encode_array(stream, field, pData, *(size_t*)pSize, func))
 183                     return false;
 184                 break;
 185
 186             case PB_HTYPE_CALLBACK:
 187             {
 188                 pb_callback_t *callback = (pb_callback_t*)pData;
 189                 if (callback->funcs.encode != NULL)
 190                 {
 191                     if (!callback->funcs.encode(stream, field, callback->arg))
 192                         return false;
 193                 }
 194                 break;
 195             }
 196         }
 197
 198         field++;
 199     }
 200
 201     return true;
 202 }
 203
 204 /* Helper functions */
 205 bool checkreturn pb_encode_varint(pb_ostream_t *stream, uint64_t value)
 206 {
 207     uint8_t buffer[10];
 208     int i = 0;
 209
 210     if (value == 0)
 211         return pb_write(stream, (uint8_t*)&value, 1);
 212
 213     while (value)
 214     {
 215         buffer[i] = (value & 0x7F) | 0x80;
 216         value >>= 7;
 217         i++;
 218     }
 219     buffer[i-1] &= 0x7F; /* Unset top bit on last byte */
 220
 221     return pb_write(stream, buffer, i);
 222 }
 223
 224 bool checkreturn pb_encode_svarint(pb_ostream_t *stream, int64_t value)
 225 {
 226     uint64_t zigzagged;
 227     if (value < 0)
 228         zigzagged = ~(value << 1);
 229     else
 230         zigzagged = value << 1;
 231
 232     return pb_encode_varint(stream, zigzagged);
 233 }
 234
 235 bool checkreturn pb_encode_fixed32(pb_ostream_t *stream, const void *value)
 236 {
 237     #ifdef __BIG_ENDIAN__
 238     uint8_t *bytes = value;
 239     uint8_t lebytes[4] = {bytes[3], bytes[2], bytes[1], bytes[0]};
 240     return pb_write(stream, lebytes, 4);
 241     #else
 242     return pb_write(stream, (uint8_t*)value, 4);
 243     #endif
 244 }
 245
 246 bool checkreturn pb_encode_fixed64(pb_ostream_t *stream, const void *value)
 247 {
 248     #ifdef __BIG_ENDIAN__
 249     uint8_t *bytes[8] = value;
 250     uint8_t lebytes[8] = {bytes[7], bytes[6], bytes[5], bytes[4],
 251                           bytes[3], bytes[2], bytes[1], bytes[0]};
 252     return pb_write(stream, lebytes, 8);
 253     #else
 254     return pb_write(stream, (uint8_t*)value, 8);
 255     #endif
 256 }
 257
 258 bool checkreturn pb_encode_tag(pb_ostream_t *stream, pb_wire_type_t wiretype, int field_number)
 259 {
 260     int tag = wiretype | (field_number << 3);
 261     return pb_encode_varint(stream, tag);
 262 }
 263
 264 bool checkreturn pb_encode_tag_for_field(pb_ostream_t *stream, const pb_field_t *field)
 265 {
 266     pb_wire_type_t wiretype;
 267     switch (PB_LTYPE(field->type))
 268     {
 269         case PB_LTYPE_VARINT:
 270         case PB_LTYPE_SVARINT:
 271             wiretype = PB_WT_VARINT;
 272             break;
 273
 274         case PB_LTYPE_FIXED32:
 275             wiretype = PB_WT_32BIT;
 276             break;
 277
 278         case PB_LTYPE_FIXED64:
 279             wiretype = PB_WT_64BIT;
 280             break;
 281
 282         case PB_LTYPE_BYTES:
 283         case PB_LTYPE_STRING:
 284         case PB_LTYPE_SUBMESSAGE:
 285             wiretype = PB_WT_STRING;
 286             break;
 287
 288         default:
 289             return false;
 290     }
 291
 292     return pb_encode_tag(stream, wiretype, field->tag);
 293 }
 294
 295 bool checkreturn pb_encode_string(pb_ostream_t *stream, const uint8_t *buffer, size_t size)
 296 {
 297     if (!pb_encode_varint(stream, size))
 298         return false;
 299
 300     return pb_write(stream, buffer, size);
 301 }
 302
 303 bool checkreturn pb_encode_submessage(pb_ostream_t *stream, const pb_field_t fields[], const void *src_struct)
 304 {
 305     /* First calculate the message size using a non-writing substream. */
 306     pb_ostream_t substream = {0};
 307     size_t size;
 308     bool status;
 309
 310     if (!pb_encode(&substream, fields, src_struct))
 311         return false;
 312
 313     size = substream.bytes_written;
 314
 315     if (!pb_encode_varint(stream, size))
 316         return false;
 317
 318     if (stream->callback == NULL)
 319         return pb_write(stream, NULL, size); /* Just sizing */
 320
 321     if (stream->bytes_written + size > stream->max_size)
 322         return false;
 323
 324     /* Use a substream to verify that a callback doesn't write more than
 325      * what it did the first time. */
 326     substream.callback = stream->callback;
 327     substream.state = stream->state;
 328     substream.max_size = size;
 329     substream.bytes_written = 0;
 330
 331     status = pb_encode(&substream, fields, src_struct);
 332
 333     stream->bytes_written += substream.bytes_written;
 334     stream->state = substream.state;
 335
 336     if (substream.bytes_written != size)
 337         return false;
 338
 339     return status;
 340 }
 341
 342 /* Field encoders */
 343
 344 bool checkreturn pb_enc_varint(pb_ostream_t *stream, const pb_field_t *field, const void *src)
 345 {
 346     uint64_t value = 0;
 347
 348     switch (field->data_size)
 349     {
 350         case 1: value = *(uint8_t*)src; break;
 351         case 2: value = *(uint16_t*)src; break;
 352         case 4: value = *(uint32_t*)src; break;
 353         case 8: value = *(uint64_t*)src; break;
 354         default: return false;
 355     }
 356
 357     return pb_encode_varint(stream, value);
 358 }
 359
 360 bool checkreturn pb_enc_svarint(pb_ostream_t *stream, const pb_field_t *field, const void *src)
 361 {
 362     uint64_t value = 0;
 363
 364     switch (field->data_size)
 365     {
 366         case 4: value = *(int32_t*)src; break;
 367         case 8: value = *(int64_t*)src; break;
 368         default: return false;
 369     }
 370
 371     return pb_encode_svarint(stream, value);
 372 }
 373
 374 bool checkreturn pb_enc_fixed64(pb_ostream_t *stream, const pb_field_t *field, const void *src)
 375 {
 376     return pb_encode_fixed64(stream, src);
 377 }
 378
 379 bool checkreturn pb_enc_fixed32(pb_ostream_t *stream, const pb_field_t *field, const void *src)
 380 {
 381     return pb_encode_fixed32(stream, src);
 382 }
 383
 384 bool checkreturn pb_enc_bytes(pb_ostream_t *stream, const pb_field_t *field, const void *src)
 385 {
 386     pb_bytes_array_t *bytes = (pb_bytes_array_t*)src;
 387     return pb_encode_string(stream, bytes->bytes, bytes->size);
 388 }
 389
 390 bool checkreturn pb_enc_string(pb_ostream_t *stream, const pb_field_t *field, const void *src)
 391 {
 392     return pb_encode_string(stream, (uint8_t*)src, strlen((char*)src));
 393 }
 394
 395 bool checkreturn pb_enc_submessage(pb_ostream_t *stream, const pb_field_t *field, const void *src)
 396 {
 397     if (field->ptr == NULL)
 398         return false;
 399
 400     return pb_encode_submessage(stream, (pb_field_t*)field->ptr, src);
 401 }
 402