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 typedef bool (*pb_encoder_t)(pb_ostream_t *stream, const pb_field_t *field, const void *src);
  11
  12 /* --- Function pointers to field encoders ---
  13  * Order in the array must match pb_action_t LTYPE numbering.
  14  */
  15 static const pb_encoder_t PB_ENCODERS[PB_LTYPES_COUNT] = {
  16     &pb_enc_varint,
  17     &pb_enc_svarint,
  18     &pb_enc_fixed,
  19
  20     &pb_enc_bytes,
  21     &pb_enc_string,
  22     &pb_enc_submessage
  23 };
  24
  25 /* pb_ostream_t implementation */
  26
  27 static bool buf_write(pb_ostream_t *stream, const uint8_t *buf, size_t count)
  28 {
  29     uint8_t *dest = (uint8_t*)stream->state;
  30     memcpy(dest, buf, count);
  31     stream->state = dest + count;
  32     return true;
  33 }
  34
  35 pb_ostream_t pb_ostream_from_buffer(uint8_t *buf, size_t bufsize)
  36 {
  37     pb_ostream_t stream;
  38     stream.callback = &buf_write;
  39     stream.state = buf;
  40     stream.max_size = bufsize;
  41     stream.bytes_written = 0;
  42     return stream;
  43 }
  44
  45 bool pb_write(pb_ostream_t *stream, const uint8_t *buf, size_t count)
  46 {
  47     if (stream->callback != NULL)
  48     {
  49         if (stream->bytes_written + count > stream->max_size)
  50             return false;
  51
  52         if (!stream->callback(stream, buf, count))
  53             return false;
  54     }
  55
  56     stream->bytes_written += count;
  57     return true;
  58 }
  59
  60 /* Main encoding stuff */
  61
  62 static bool encode_array(pb_ostream_t *stream, const pb_field_t *field,
  63                          const void *pData, size_t count, pb_encoder_t func)
  64 {
  65     int i;
  66     const void *p;
  67     size_t size;
  68
  69     if (PB_LTYPE(field->type) < PB_LTYPE_LAST_PACKABLE)
  70     {
  71         if (!pb_encode_tag(stream, PB_WT_STRING, field->tag))
  72             return false;
  73
  74         /* Determine the total size of packed array. */
  75         if (PB_LTYPE(field->type) == PB_LTYPE_FIXED)
  76         {
  77             size = field->data_size * count;
  78         }
  79         else
  80         {
  81             pb_ostream_t sizestream = {0};
  82             p = pData;
  83             for (i = 0; i < count; i++)
  84             {
  85                 if (!func(&sizestream, field, p))
  86                     return false;
  87                 p = (const char*)p + field->data_size;
  88             }
  89             size = sizestream.bytes_written;
  90         }
  91
  92         pb_encode_varint(stream, size);
  93
  94         if (stream->callback == NULL)
  95             return pb_write(stream, NULL, size); /* Just sizing.. */
  96
  97         /* Write the data */
  98         p = pData;
  99         for (i = 0; i < count; i++)
 100         {
 101             if (!func(stream, field, p))
 102                 return false;
 103             p = (const char*)p + field->data_size;
 104         }
 105     }
 106     else
 107     {
 108         p = pData;
 109         for (i = 0; i < count; i++)
 110         {
 111             if (!pb_encode_tag_for_field(stream, field))
 112                 return false;
 113             if (!func(stream, field, p))
 114                 return false;
 115             p = (const char*)p + field->data_size;
 116         }
 117     }
 118
 119     return true;
 120 }
 121
 122 bool pb_encode(pb_ostream_t *stream, const pb_field_t fields[], const void *src_struct)
 123 {
 124     const pb_field_t *field = fields;
 125     const void *pData = src_struct;
 126     const void *pSize;
 127     size_t prev_size = 0;
 128
 129     while (field->tag != 0)
 130     {
 131         pData = (const char*)pData + prev_size + field->data_offset;
 132         pSize = (const char*)pData + field->size_offset;
 133         prev_size = field->data_size * field->array_size;
 134
 135         pb_encoder_t func = PB_ENCODERS[PB_LTYPE(field->type)];
 136
 137         switch (PB_HTYPE(field->type))
 138         {
 139             case PB_HTYPE_REQUIRED:
 140                 if (!pb_encode_tag_for_field(stream, field))
 141                     return false;
 142                 if (!func(stream, field, pData))
 143                     return false;
 144                 break;
 145
 146             case PB_HTYPE_OPTIONAL:
 147                 if (*(bool*)pSize)
 148                 {
 149                     if (!pb_encode_tag_for_field(stream, field))
 150                         return false;
 151
 152                     if (!func(stream, field, pData))
 153                         return false;
 154                 }
 155                 break;
 156
 157             case PB_HTYPE_ARRAY:
 158                 if (!encode_array(stream, field, pData, *(size_t*)pSize, func))
 159                     return false;
 160                 break;
 161
 162             case PB_HTYPE_CALLBACK:
 163             {
 164                 pb_callback_t *callback = (pb_callback_t*)pData;
 165                 if (callback->funcs.encode != NULL)
 166                 {
 167                     if (!callback->funcs.encode(stream, field, callback->arg))
 168                         return false;
 169                 }
 170                 break;
 171             }
 172         }
 173
 174         field++;
 175     }
 176
 177     return true;
 178 }
 179
 180 /* Helper functions */
 181 bool pb_encode_varint(pb_ostream_t *stream, uint64_t value)
 182 {
 183     uint8_t buffer[10];
 184     int i = 0;
 185
 186     if (value == 0)
 187         return pb_write(stream, (uint8_t*)&value, 1);
 188
 189     while (value)
 190     {
 191         buffer[i] = (value & 0x7F) | 0x80;
 192         value >>= 7;
 193         i++;
 194     }
 195     buffer[i-1] &= 0x7F; /* Unset top bit on last byte */
 196
 197     return pb_write(stream, buffer, i);
 198 }
 199
 200 bool pb_encode_tag(pb_ostream_t *stream, pb_wire_type_t wiretype, int field_number)
 201 {
 202     int tag = wiretype | (field_number << 3);
 203     return pb_encode_varint(stream, tag);
 204 }
 205
 206 bool pb_encode_tag_for_field(pb_ostream_t *stream, const pb_field_t *field)
 207 {
 208     pb_wire_type_t wiretype;
 209     switch (PB_LTYPE(field->type))
 210     {
 211         case PB_LTYPE_VARINT:
 212         case PB_LTYPE_SVARINT:
 213             wiretype = PB_WT_VARINT;
 214             break;
 215
 216         case PB_LTYPE_FIXED:
 217             if (field->data_size == 4)
 218                 wiretype = PB_WT_32BIT;
 219             else if (field->data_size == 8)
 220                 wiretype = PB_WT_64BIT;
 221             else
 222                 return false;
 223             break;
 224
 225         case PB_LTYPE_BYTES:
 226         case PB_LTYPE_STRING:
 227         case PB_LTYPE_SUBMESSAGE:
 228             wiretype = PB_WT_STRING;
 229             break;
 230
 231         default:
 232             return false;
 233     }
 234
 235     return pb_encode_tag(stream, wiretype, field->tag);
 236 }
 237
 238 bool pb_encode_string(pb_ostream_t *stream, const uint8_t *buffer, size_t size)
 239 {
 240     if (!pb_encode_varint(stream, size))
 241         return false;
 242
 243     return pb_write(stream, buffer, size);
 244 }
 245
 246 /* Field encoders */
 247
 248 /* Copy srcsize bytes from src so that values are casted properly.
 249  * On little endian machine, copy to start of dest
 250  * On big endian machine, copy to end of dest
 251  * destsize must always be larger than srcsize
 252  *
 253  * Note: This is the reverse of the endian_copy in pb_decode.c.
 254  */
 255 static void endian_copy(void *dest, const void *src, size_t destsize, size_t srcsize)
 256 {
 257 #ifdef __BIG_ENDIAN__
 258     memcpy((char*)dest + (destsize - srcsize), src, srcsize);
 259 #else
 260     memcpy(dest, src, srcsize);
 261 #endif
 262 }
 263
 264 bool pb_enc_varint(pb_ostream_t *stream, const pb_field_t *field, const void *src)
 265 {
 266     uint64_t value = 0;
 267     endian_copy(&value, src, sizeof(value), field->data_size);
 268     return pb_encode_varint(stream, value);
 269 }
 270
 271 bool pb_enc_svarint(pb_ostream_t *stream, const pb_field_t *field, const void *src)
 272 {
 273     uint64_t value = 0;
 274     uint64_t zigzagged;
 275     uint64_t signbitmask, xormask;
 276     endian_copy(&value, src, sizeof(value), field->data_size);
 277
 278     signbitmask = (uint64_t)0x80 << (field->data_size * 8 - 8);
 279     xormask = ((uint64_t)-1) >> (64 - field->data_size * 8);
 280     if (value & signbitmask)
 281         zigzagged = ((value ^ xormask) << 1) | 1;
 282     else
 283         zigzagged = value << 1;
 284
 285     return pb_encode_varint(stream, zigzagged);
 286 }
 287
 288 bool pb_enc_fixed(pb_ostream_t *stream, const pb_field_t *field, const void *src)
 289 {
 290     #ifdef __BIG_ENDIAN__
 291     uint8_t bytes[8] = {0};
 292     endian_copy(bytes, src, sizeof(bytes), field->data_size);
 293     uint8_t lebytes[8] = {bytes[7], bytes[6], bytes[5], bytes[4],
 294                           bytes[3], bytes[2], bytes[1], bytes[0]};
 295     return pb_write(stream, lebytes, field->data_size);
 296     #else
 297     return pb_write(stream, (uint8_t*)src, field->data_size);
 298     #endif
 299 }
 300
 301 bool pb_enc_bytes(pb_ostream_t *stream, const pb_field_t *field, const void *src)
 302 {
 303     pb_bytes_array_t *bytes = (pb_bytes_array_t*)src;
 304     return pb_encode_string(stream, bytes->bytes, bytes->size);
 305 }
 306
 307 bool pb_enc_string(pb_ostream_t *stream, const pb_field_t *field, const void *src)
 308 {
 309     return pb_encode_string(stream, (uint8_t*)src, strlen((char*)src));
 310 }
 311
 312 bool pb_enc_submessage(pb_ostream_t *stream, const pb_field_t *field, const void *src)
 313 {
 314     pb_ostream_t substream = {0};
 315     size_t size;
 316     bool status;
 317
 318     if (field->ptr == NULL)
 319         return false;
 320
 321     if (!pb_encode(&substream, (pb_field_t*)field->ptr, src))
 322         return false;
 323
 324     size = substream.bytes_written;
 325
 326     if (!pb_encode_varint(stream, size))
 327         return false;
 328
 329     if (stream->callback == NULL)
 330         return pb_write(stream, NULL, size); /* Just sizing */
 331
 332     if (stream->bytes_written + size > stream->max_size)
 333         return false;
 334
 335     /* Use a substream to verify that a callback doesn't write more than
 336      * what it did the first time. */
 337     substream.callback = stream->callback;
 338     substream.state = stream->state;
 339     substream.max_size = size;
 340     substream.bytes_written = 0;
 341
 342     status = pb_encode(stream, (pb_field_t*)field->ptr, src);
 343
 344     stream->bytes_written += substream.bytes_written;
 345
 346     if (substream.bytes_written != size)
 347         return false;
 348
 349     return status;
 350 }
 351