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