pb_encode.c

   1 /* pb_encode.c -- encode a protobuf using minimal resources
   2  *
   3  * 2011 Petteri Aimonen <jpa@kapsi.fi>
   4  */
   5
   6 #include "pb.h"
   7 #include "pb_encode.h"
   8 #include <string.h>
   9
  10 #ifdef __GNUC__
  11 /* Verify that we remember to check all return values for proper error propagation */
  12 #define checkreturn __attribute__((warn_unused_result))
  13 #else
  14 #define checkreturn
  15 #endif
  16
  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     memcpy(dest, buf, count);
  40     stream->state = dest + count;
  41     return true;
  42 }
  43
  44 pb_ostream_t pb_ostream_from_buffer(uint8_t *buf, size_t bufsize)
  45 {
  46     pb_ostream_t stream;
  47     stream.callback = &buf_write;
  48     stream.state = buf;
  49     stream.max_size = bufsize;
  50     stream.bytes_written = 0;
  51     return stream;
  52 }
  53
  54 bool checkreturn pb_write(pb_ostream_t *stream, const uint8_t *buf, size_t count)
  55 {
  56     if (stream->callback != NULL)
  57     {
  58         if (stream->bytes_written + count > stream->max_size)
  59             return false;
  60
  61         if (!stream->callback(stream, buf, count))
  62             return false;
  63     }
  64
  65     stream->bytes_written += count;
  66     return true;
  67 }
  68
  69 /* Main encoding stuff */
  70
  71 /* Callbacks don't need this function because they usually know the data type
  72  * without examining the field structure.
  73  * Therefore it is static for now.
  74  */
  75 static bool checkreturn encode_array(pb_ostream_t *stream, const pb_field_t *field,
  76                          const void *pData, size_t count, pb_encoder_t func)
  77 {
  78     int i;
  79     const void *p;
  80     size_t size;
  81
  82     if (count == 0)
  83         return true;
  84
  85     if (PB_LTYPE(field->type) <= PB_LTYPE_LAST_PACKABLE)
  86     {
  87         if (!pb_encode_tag(stream, PB_WT_STRING, field->tag))
  88             return false;
  89
  90         /* Determine the total size of packed array. */
  91         if (PB_LTYPE(field->type) == PB_LTYPE_FIXED32)
  92         {
  93             size = 4 * count;
  94         }
  95         else if (PB_LTYPE(field->type) == PB_LTYPE_FIXED64)
  96         {
  97             size = 8 * count;
  98         }
  99         else
 100         {
 101             pb_ostream_t sizestream = {0};
 102             p = pData;
 103             for (i = 0; i < count; i++)
 104             {
 105                 if (!func(&sizestream, field, p))
 106                     return false;
 107                 p = (const char*)p + field->data_size;
 108             }
 109             size = sizestream.bytes_written;
 110         }
 111
 112         if (!pb_encode_varint(stream, size))
 113             return false;
 114
 115         if (stream->callback == NULL)
 116             return pb_write(stream, NULL, size); /* Just sizing.. */
 117
 118         /* Write the data */
 119         p = pData;
 120         for (i = 0; i < count; i++)
 121         {
 122             if (!func(stream, field, p))
 123                 return false;
 124             p = (const char*)p + field->data_size;
 125         }
 126     }
 127     else
 128     {
 129         p = pData;
 130         for (i = 0; i < count; i++)
 131         {
 132             if (!pb_encode_tag_for_field(stream, field))
 133                 return false;
 134             if (!func(stream, field, p))
 135                 return false;
 136             p = (const char*)p + field->data_size;
 137         }
 138     }
 139
 140     return true;
 141 }
 142
 143 bool checkreturn pb_encode(pb_ostream_t *stream, const pb_field_t fields[], const void *src_struct)
 144 {
 145     const pb_field_t *field = fields;
 146     const void *pData = src_struct;
 147     const void *pSize;
 148     size_t prev_size = 0;
 149
 150     while (field->tag != 0)
 151     {
 152         pData = (const char*)pData + prev_size + field->data_offset;
 153         pSize = (const char*)pData + field->size_offset;
 154
 155         prev_size = field->data_size;
 156         if (PB_HTYPE(field->type) == PB_HTYPE_ARRAY)
 157             prev_size *= field->array_size;
 158
 159         pb_encoder_t func = PB_ENCODERS[PB_LTYPE(field->type)];
 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_tag(pb_ostream_t *stream, pb_wire_type_t wiretype, int field_number)
 225 {
 226     int tag = wiretype | (field_number << 3);
 227     return pb_encode_varint(stream, tag);
 228 }
 229
 230 bool checkreturn pb_encode_tag_for_field(pb_ostream_t *stream, const pb_field_t *field)
 231 {
 232     pb_wire_type_t wiretype;
 233     switch (PB_LTYPE(field->type))
 234     {
 235         case PB_LTYPE_VARINT:
 236         case PB_LTYPE_SVARINT:
 237             wiretype = PB_WT_VARINT;
 238             break;
 239
 240         case PB_LTYPE_FIXED32:
 241             wiretype = PB_WT_32BIT;
 242             break;
 243
 244         case PB_LTYPE_FIXED64:
 245             wiretype = PB_WT_64BIT;
 246             break;
 247
 248         case PB_LTYPE_BYTES:
 249         case PB_LTYPE_STRING:
 250         case PB_LTYPE_SUBMESSAGE:
 251             wiretype = PB_WT_STRING;
 252             break;
 253
 254         default:
 255             return false;
 256     }
 257
 258     return pb_encode_tag(stream, wiretype, field->tag);
 259 }
 260
 261 bool checkreturn pb_encode_string(pb_ostream_t *stream, const uint8_t *buffer, size_t size)
 262 {
 263     if (!pb_encode_varint(stream, size))
 264         return false;
 265
 266     return pb_write(stream, buffer, size);
 267 }
 268
 269 /* Field encoders */
 270
 271 /* Copy srcsize bytes from src so that values are casted properly.
 272  * On little endian machine, copy to start of dest
 273  * On big endian machine, copy to end of dest
 274  * destsize must always be larger than srcsize
 275  *
 276  * Note: This is the reverse of the endian_copy in pb_decode.c.
 277  */
 278 static void endian_copy(void *dest, const void *src, size_t destsize, size_t srcsize)
 279 {
 280 #ifdef __BIG_ENDIAN__
 281     memcpy((char*)dest + (destsize - srcsize), src, srcsize);
 282 #else
 283     memcpy(dest, src, srcsize);
 284 #endif
 285 }
 286
 287 bool checkreturn pb_enc_varint(pb_ostream_t *stream, const pb_field_t *field, const void *src)
 288 {
 289     uint64_t value = 0;
 290     endian_copy(&value, src, sizeof(value), field->data_size);
 291     return pb_encode_varint(stream, value);
 292 }
 293
 294 bool checkreturn pb_enc_svarint(pb_ostream_t *stream, const pb_field_t *field, const void *src)
 295 {
 296     uint64_t value = 0;
 297     uint64_t zigzagged;
 298     uint64_t signbitmask, xormask;
 299     endian_copy(&value, src, sizeof(value), field->data_size);
 300
 301     signbitmask = (uint64_t)0x80 << (field->data_size * 8 - 8);
 302     xormask = ((uint64_t)-1) >> (64 - field->data_size * 8);
 303     if (value & signbitmask)
 304         zigzagged = ((value ^ xormask) << 1) | 1;
 305     else
 306         zigzagged = value << 1;
 307
 308     return pb_encode_varint(stream, zigzagged);
 309 }
 310
 311 bool checkreturn pb_enc_fixed64(pb_ostream_t *stream, const pb_field_t *field, const void *src)
 312 {
 313     #ifdef __BIG_ENDIAN__
 314     uint8_t bytes[8] = {0};
 315     memcpy(bytes, src, 8);
 316     uint8_t lebytes[8] = {bytes[7], bytes[6], bytes[5], bytes[4],
 317                           bytes[3], bytes[2], bytes[1], bytes[0]};
 318     return pb_write(stream, lebytes, 8);
 319     #else
 320     return pb_write(stream, (uint8_t*)src, 8);
 321     #endif
 322 }
 323
 324 bool checkreturn pb_enc_fixed32(pb_ostream_t *stream, const pb_field_t *field, const void *src)
 325 {
 326     #ifdef __BIG_ENDIAN__
 327     uint8_t bytes[4] = {0};
 328     memcpy(bytes, src, 4);
 329     uint8_t lebytes[4] = {bytes[3], bytes[2], bytes[1], bytes[0]};
 330     return pb_write(stream, lebytes, 4);
 331     #else
 332     return pb_write(stream, (uint8_t*)src, 4);
 333     #endif
 334 }
 335
 336 bool checkreturn pb_enc_bytes(pb_ostream_t *stream, const pb_field_t *field, const void *src)
 337 {
 338     pb_bytes_array_t *bytes = (pb_bytes_array_t*)src;
 339     return pb_encode_string(stream, bytes->bytes, bytes->size);
 340 }
 341
 342 bool checkreturn pb_enc_string(pb_ostream_t *stream, const pb_field_t *field, const void *src)
 343 {
 344     return pb_encode_string(stream, (uint8_t*)src, strlen((char*)src));
 345 }
 346
 347 bool checkreturn pb_enc_submessage(pb_ostream_t *stream, const pb_field_t *field, const void *src)
 348 {
 349     pb_ostream_t substream = {0};
 350     size_t size;
 351     bool status;
 352
 353     if (field->ptr == NULL)
 354         return false;
 355
 356     if (!pb_encode(&substream, (pb_field_t*)field->ptr, src))
 357         return false;
 358
 359     size = substream.bytes_written;
 360
 361     if (!pb_encode_varint(stream, size))
 362         return false;
 363
 364     if (stream->callback == NULL)
 365         return pb_write(stream, NULL, size); /* Just sizing */
 366
 367     if (stream->bytes_written + size > stream->max_size)
 368         return false;
 369
 370     /* Use a substream to verify that a callback doesn't write more than
 371      * what it did the first time. */
 372     substream.callback = stream->callback;
 373     substream.state = stream->state;
 374     substream.max_size = size;
 375     substream.bytes_written = 0;
 376
 377     status = pb_encode(&substream, (pb_field_t*)field->ptr, src);
 378
 379     stream->bytes_written += substream.bytes_written;
 380
 381     if (substream.bytes_written != size)
 382         return false;
 383
 384     return status;
 385 }
 386