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
 128     while (field->tag != 0)
 129     {
 130         pData = (const char*)pData + field->data_offset;
 131         pSize = (const char*)pData + field->size_offset;
 132
 133         pb_encoder_t func = PB_ENCODERS[PB_LTYPE(field->type)];
 134
 135         switch (PB_HTYPE(field->type))
 136         {
 137             case PB_HTYPE_REQUIRED:
 138                 if (!pb_encode_tag_for_field(stream, field))
 139                     return false;
 140                 if (!func(stream, field, pData))
 141                     return false;
 142                 break;
 143
 144             case PB_HTYPE_OPTIONAL:
 145                 if (*(bool*)pSize)
 146                 {
 147                     if (!pb_encode_tag_for_field(stream, field))
 148                         return false;
 149
 150                     if (!func(stream, field, pData))
 151                         return false;
 152                 }
 153                 break;
 154
 155             case PB_HTYPE_ARRAY:
 156                 if (!encode_array(stream, field, pData, *(size_t*)pSize, func))
 157                     return false;
 158                 break;
 159
 160             case PB_HTYPE_CALLBACK:
 161             {
 162                 pb_callback_t *callback = (pb_callback_t*)pData;
 163                 if (callback->funcs.encode != NULL)
 164                 {
 165                     if (!callback->funcs.encode(stream, field, callback->arg))
 166                         return false;
 167                 }
 168                 break;
 169             }
 170         }
 171
 172         field++;
 173     }
 174
 175     return true;
 176 }
 177
 178 /* Helper functions */
 179 bool pb_encode_varint(pb_ostream_t *stream, uint64_t value)
 180 {
 181     uint8_t buffer[10];
 182     int i = 0;
 183
 184     if (value == 0)
 185         return pb_write(stream, (uint8_t*)&value, 1);
 186
 187     while (value)
 188     {
 189         buffer[i] = (value & 0x7F) | 0x80;
 190         value >>= 7;
 191         i++;
 192     }
 193     buffer[i-1] &= 0x7F; /* Unset top bit on last byte */
 194
 195     return pb_write(stream, buffer, i);
 196 }
 197
 198 bool pb_encode_tag(pb_ostream_t *stream, pb_wire_type_t wiretype, int field_number)
 199 {
 200     int tag = wiretype | (field_number << 3);
 201     return pb_encode_varint(stream, tag);
 202 }
 203
 204 bool pb_encode_tag_for_field(pb_ostream_t *stream, const pb_field_t *field)
 205 {
 206     pb_wire_type_t wiretype;
 207     switch (PB_LTYPE(field->type))
 208     {
 209         case PB_LTYPE_VARINT:
 210         case PB_LTYPE_SVARINT:
 211             wiretype = PB_WT_VARINT;
 212             break;
 213
 214         case PB_LTYPE_FIXED:
 215             if (field->data_size == 4)
 216                 wiretype = PB_WT_32BIT;
 217             else if (field->data_size == 8)
 218                 wiretype = PB_WT_64BIT;
 219             else
 220                 return false;
 221             break;
 222
 223         case PB_LTYPE_BYTES:
 224         case PB_LTYPE_STRING:
 225         case PB_LTYPE_SUBMESSAGE:
 226             wiretype = PB_WT_STRING;
 227             break;
 228
 229         default:
 230             return false;
 231     }
 232
 233     return pb_encode_tag(stream, wiretype, field->tag);
 234 }
 235
 236 bool pb_encode_string(pb_ostream_t *stream, const uint8_t *buffer, size_t size)
 237 {
 238     if (!pb_encode_varint(stream, size))
 239         return false;
 240
 241     return pb_write(stream, buffer, size);
 242 }
 243
 244 /* Field encoders */
 245
 246 /* Copy srcsize bytes from src so that values are casted properly.
 247  * On little endian machine, copy to start of dest
 248  * On big endian machine, copy to end of dest
 249  * destsize must always be larger than srcsize
 250  *
 251  * Note: This is the reverse of the endian_copy in pb_decode.c.
 252  */
 253 static void endian_copy(void *dest, const void *src, size_t destsize, size_t srcsize)
 254 {
 255 #ifdef __BIG_ENDIAN__
 256     memcpy((char*)dest + (destsize - srcsize), src, srcsize);
 257 #else
 258     memcpy(dest, src, srcsize);
 259 #endif
 260 }
 261
 262 bool pb_enc_varint(pb_ostream_t *stream, const pb_field_t *field, const void *src)
 263 {
 264     uint64_t value = 0;
 265     endian_copy(&value, src, sizeof(value), field->data_size);
 266     return pb_encode_varint(stream, value);
 267 }
 268
 269 bool pb_enc_svarint(pb_ostream_t *stream, const pb_field_t *field, const void *src)
 270 {
 271     uint64_t value = 0;
 272     uint64_t zigzagged;
 273     uint64_t signbitmask, xormask;
 274     endian_copy(&value, src, sizeof(value), field->data_size);
 275
 276     signbitmask = (uint64_t)0x80 << (field->data_size * 8 - 8);
 277     xormask = ((uint64_t)-1) >> (64 - field->data_size * 8);
 278     if (value & signbitmask)
 279         zigzagged = ((value ^ xormask) << 1) | 1;
 280     else
 281         zigzagged = value << 1;
 282
 283     return pb_encode_varint(stream, zigzagged);
 284 }
 285
 286 bool pb_enc_fixed(pb_ostream_t *stream, const pb_field_t *field, const void *src)
 287 {
 288     #ifdef __BIG_ENDIAN__
 289     uint8_t bytes[8] = {0};
 290     endian_copy(bytes, src, sizeof(bytes), field->data_size);
 291     uint8_t lebytes[8] = {bytes[7], bytes[6], bytes[5], bytes[4],
 292                           bytes[3], bytes[2], bytes[1], bytes[0]};
 293     return pb_write(stream, lebytes, field->data_size);
 294     #else
 295     return pb_write(stream, (uint8_t*)src, field->data_size);
 296     #endif
 297 }
 298
 299 bool pb_enc_bytes(pb_ostream_t *stream, const pb_field_t *field, const void *src)
 300 {
 301     pb_bytes_array_t *bytes = (pb_bytes_array_t*)src;
 302     return pb_encode_string(stream, bytes->bytes, bytes->size);
 303 }
 304
 305 bool pb_enc_string(pb_ostream_t *stream, const pb_field_t *field, const void *src)
 306 {
 307     return pb_encode_string(stream, (uint8_t*)src, strlen((char*)src));
 308 }
 309
 310 bool pb_enc_submessage(pb_ostream_t *stream, const pb_field_t *field, const void *src)
 311 {
 312     pb_ostream_t sizestream = {0};
 313     size_t size;
 314
 315     if (field->ptr == NULL)
 316         return false;
 317
 318     if (!pb_encode(&sizestream, (pb_field_t*)field->ptr, src))
 319         return false;
 320
 321     size = sizestream.bytes_written;
 322
 323     if (!pb_encode_varint(stream, size))
 324         return false;
 325
 326     if (stream->callback == NULL)
 327         return pb_write(stream, NULL, size); /* Just sizing */
 328
 329     return pb_encode(stream, (pb_field_t*)field->ptr, src);
 330 }
 331