Merge branch 'dev-0.2'
[apps/agl-service-can-low-level.git] / pb_encode.c
index 63ca288..fbeeacf 100644 (file)
@@ -3,11 +3,20 @@
  * 2011 Petteri Aimonen <jpa@kapsi.fi>
  */
 
+#define NANOPB_INTERNALS
 #include "pb.h"
 #include "pb_encode.h"
 #include <string.h>
 
-typedef bool (*pb_encoder_t)(pb_ostream_t *stream, const pb_field_t *field, const void *src);
+/* The warn_unused_result attribute appeared first in gcc-3.4.0 */
+#if !defined(__GNUC__) || ( __GNUC__ < 3) || (__GNUC__ == 3 && __GNUC_MINOR__ < 4)
+    #define checkreturn
+#else
+    /* Verify that we remember to check all return values for proper error propagation */
+    #define checkreturn __attribute__((warn_unused_result))
+#endif
+
+typedef bool (*pb_encoder_t)(pb_ostream_t *stream, const pb_field_t *field, const void *src) checkreturn;
 
 /* --- Function pointers to field encoders ---
  * Order in the array must match pb_action_t LTYPE numbering.
@@ -15,7 +24,8 @@ typedef bool (*pb_encoder_t)(pb_ostream_t *stream, const pb_field_t *field, cons
 static const pb_encoder_t PB_ENCODERS[PB_LTYPES_COUNT] = {
     &pb_enc_varint,
     &pb_enc_svarint,
-    &pb_enc_fixed,
+    &pb_enc_fixed32,
+    &pb_enc_fixed64,
     
     &pb_enc_bytes,
     &pb_enc_string,
@@ -24,33 +34,45 @@ static const pb_encoder_t PB_ENCODERS[PB_LTYPES_COUNT] = {
 
 /* pb_ostream_t implementation */
 
-static bool buf_write(pb_ostream_t *stream, const uint8_t *buf, size_t count)
+static bool checkreturn buf_write(pb_ostream_t *stream, const uint8_t *buf, size_t count)
 {
     uint8_t *dest = (uint8_t*)stream->state;
-    memcpy(dest, buf, count);
     stream->state = dest + count;
+    
+    while (count--)
+        *dest++ = *buf++;
+    
     return true;
 }
 
 pb_ostream_t pb_ostream_from_buffer(uint8_t *buf, size_t bufsize)
 {
     pb_ostream_t stream;
+#ifdef PB_BUFFER_ONLY
+    stream.callback = (void*)1; /* Just some marker value */
+#else
     stream.callback = &buf_write;
+#endif
     stream.state = buf;
     stream.max_size = bufsize;
     stream.bytes_written = 0;
     return stream;
 }
 
-bool pb_write(pb_ostream_t *stream, const uint8_t *buf, size_t count)
+bool checkreturn pb_write(pb_ostream_t *stream, const uint8_t *buf, size_t count)
 {
     if (stream->callback != NULL)
     {
         if (stream->bytes_written + count > stream->max_size)
             return false;
-        
+
+#ifdef PB_BUFFER_ONLY
+        if (!buf_write(stream, buf, count))
+            return false;
+#else        
         if (!stream->callback(stream, buf, count))
             return false;
+#endif
     }
     
     stream->bytes_written += count;
@@ -59,26 +81,37 @@ bool pb_write(pb_ostream_t *stream, const uint8_t *buf, size_t count)
 
 /* Main encoding stuff */
 
-static bool encode_array(pb_ostream_t *stream, const pb_field_t *field,
+/* Callbacks don't need this function because they usually know the data type
+ * without examining the field structure.
+ * Therefore it is static for now.
+ */
+static bool checkreturn encode_array(pb_ostream_t *stream, const pb_field_t *field,
                          const void *pData, size_t count, pb_encoder_t func)
 {
-    int i;
+    size_t i;
     const void *p;
     size_t size;
     
-    if (PB_LTYPE(field->type) < PB_LTYPE_LAST_PACKABLE)
+    if (count == 0)
+        return true;
+    
+    if (PB_LTYPE(field->type) <= PB_LTYPE_LAST_PACKABLE)
     {
         if (!pb_encode_tag(stream, PB_WT_STRING, field->tag))
             return false;
         
         /* Determine the total size of packed array. */
-        if (PB_LTYPE(field->type) == PB_LTYPE_FIXED)
+        if (PB_LTYPE(field->type) == PB_LTYPE_FIXED32)
         {
-            size = field->data_size * count;
+            size = 4 * count;
+        }
+        else if (PB_LTYPE(field->type) == PB_LTYPE_FIXED64)
+        {
+            size = 8 * count;
         }
         else
         {
-            pb_ostream_t sizestream = {0};
+            pb_ostream_t sizestream = {0,0,0,0};
             p = pData;
             for (i = 0; i < count; i++)
             {
@@ -89,7 +122,8 @@ static bool encode_array(pb_ostream_t *stream, const pb_field_t *field,
             size = sizestream.bytes_written;
         }
         
-        pb_encode_varint(stream, size);
+        if (!pb_encode_varint(stream, (uint64_t)size))
+            return false;
         
         if (stream->callback == NULL)
             return pb_write(stream, NULL, size); /* Just sizing.. */
@@ -119,54 +153,89 @@ static bool encode_array(pb_ostream_t *stream, const pb_field_t *field,
     return true;
 }
 
-bool pb_encode(pb_ostream_t *stream, const pb_field_t fields[], const void *src_struct)
+bool checkreturn encode_static_field(pb_ostream_t *stream, const pb_field_t *field, const void *pData)
 {
-    const pb_field_t *field = fields;
-    const void *pData = src_struct;
+    pb_encoder_t func;
     const void *pSize;
     
-    while (field->tag != 0)
+    func = PB_ENCODERS[PB_LTYPE(field->type)];
+    pSize = (const char*)pData + field->size_offset;
+    
+    switch (PB_HTYPE(field->type))
     {
-        pData = (const char*)pData + field->data_offset;
-        pSize = (const char*)pData + field->size_offset;
-        
-        pb_encoder_t func = PB_ENCODERS[PB_LTYPE(field->type)];
+        case PB_HTYPE_REQUIRED:
+            if (!pb_encode_tag_for_field(stream, field))
+                return false;
+            if (!func(stream, field, pData))
+                return false;
+            break;
         
-        switch (PB_HTYPE(field->type))
-        {
-            case PB_HTYPE_REQUIRED:
+        case PB_HTYPE_OPTIONAL:
+            if (*(const bool*)pSize)
+            {
                 if (!pb_encode_tag_for_field(stream, field))
                     return false;
+            
                 if (!func(stream, field, pData))
                     return false;
-                break;
-            
-            case PB_HTYPE_OPTIONAL:
-                if (*(bool*)pSize)
-                {
-                    if (!pb_encode_tag_for_field(stream, field))
-                        return false;
+            }
+            break;
+        
+        case PB_HTYPE_REPEATED:
+            if (!encode_array(stream, field, pData, *(const size_t*)pSize, func))
+                return false;
+            break;
+        
+        default:
+            return false;
+    }
+    
+    return true;
+}
+
+bool checkreturn encode_callback_field(pb_ostream_t *stream, const pb_field_t *field, const void *pData)
+{
+    const pb_callback_t *callback = (const pb_callback_t*)pData;
+    if (callback->funcs.encode != NULL)
+    {
+        if (!callback->funcs.encode(stream, field, callback->arg))
+            return false;
+    }
+    return true;
+}
+
+bool checkreturn pb_encode(pb_ostream_t *stream, const pb_field_t fields[], const void *src_struct)
+{
+    const pb_field_t *field = fields;
+    const void *pData = src_struct;
+    size_t prev_size = 0;
+    
+    while (field->tag != 0)
+    {
+        pData = (const char*)pData + prev_size + field->data_offset;
+        prev_size = field->data_size;
+        
+        /* Special case for static arrays */
+        if (PB_ATYPE(field->type) == PB_ATYPE_STATIC &&
+            PB_HTYPE(field->type) == PB_HTYPE_REPEATED)
+        {
+            prev_size *= field->array_size;
+        }
                 
-                    if (!func(stream, field, pData))
-                        return false;
-                }
+        switch (PB_ATYPE(field->type))
+        {
+            case PB_ATYPE_STATIC:
+                if (!encode_static_field(stream, field, pData))
+                    return false;
                 break;
             
-            case PB_HTYPE_ARRAY:
-                if (!encode_array(stream, field, pData, *(size_t*)pSize, func))
+            case PB_ATYPE_CALLBACK:
+                if (!encode_callback_field(stream, field, pData))
                     return false;
                 break;
             
-            case PB_HTYPE_CALLBACK:
-            {
-                pb_callback_t *callback = (pb_callback_t*)pData;
-                if (callback->funcs.encode != NULL)
-                {
-                    if (!callback->funcs.encode(stream, field, callback->arg))
-                        return false;
-                }
-                break;
-            }
+            default:
+                return false;
         }
     
         field++;
@@ -176,17 +245,17 @@ bool pb_encode(pb_ostream_t *stream, const pb_field_t fields[], const void *src_
 }
 
 /* Helper functions */
-bool pb_encode_varint(pb_ostream_t *stream, uint64_t value)
+bool checkreturn pb_encode_varint(pb_ostream_t *stream, uint64_t value)
 {
     uint8_t buffer[10];
-    int i = 0;
+    size_t i = 0;
     
     if (value == 0)
         return pb_write(stream, (uint8_t*)&value, 1);
     
     while (value)
     {
-        buffer[i] = (value & 0x7F) | 0x80;
+        buffer[i] = (uint8_t)((value & 0x7F) | 0x80);
         value >>= 7;
         i++;
     }
@@ -195,13 +264,58 @@ bool pb_encode_varint(pb_ostream_t *stream, uint64_t value)
     return pb_write(stream, buffer, i);
 }
 
-bool pb_encode_tag(pb_ostream_t *stream, pb_wire_type_t wiretype, int field_number)
+bool checkreturn pb_encode_svarint(pb_ostream_t *stream, int64_t value)
 {
-    int tag = wiretype | (field_number << 3);
+    uint64_t zigzagged;
+    if (value < 0)
+        zigzagged = (uint64_t)(~(value << 1));
+    else
+        zigzagged = (uint64_t)(value << 1);
+    
+    return pb_encode_varint(stream, zigzagged);
+}
+
+bool checkreturn pb_encode_fixed32(pb_ostream_t *stream, const void *value)
+{
+    #ifdef __BIG_ENDIAN__
+    const uint8_t *bytes = value;
+    uint8_t lebytes[4];
+    lebytes[0] = bytes[3];
+    lebytes[1] = bytes[2];
+    lebytes[2] = bytes[1];
+    lebytes[3] = bytes[0];
+    return pb_write(stream, lebytes, 4);
+    #else
+    return pb_write(stream, (const uint8_t*)value, 4);
+    #endif
+}
+
+bool checkreturn pb_encode_fixed64(pb_ostream_t *stream, const void *value)
+{
+    #ifdef __BIG_ENDIAN__
+    const uint8_t *bytes = value;
+    uint8_t lebytes[8];
+    lebytes[0] = bytes[7];
+    lebytes[1] = bytes[6];
+    lebytes[2] = bytes[5];
+    lebytes[3] = bytes[4];
+    lebytes[4] = bytes[3];
+    lebytes[5] = bytes[2];
+    lebytes[6] = bytes[1];
+    lebytes[7] = bytes[0];
+    return pb_write(stream, lebytes, 8);
+    #else
+    return pb_write(stream, (const uint8_t*)value, 8);
+    #endif
+}
+
+bool checkreturn pb_encode_tag(pb_ostream_t *stream, pb_wire_type_t wiretype, uint32_t field_number)
+{
+    uint64_t tag = wiretype | (field_number << 3);
     return pb_encode_varint(stream, tag);
 }
 
-bool pb_encode_tag_for_field(pb_ostream_t *stream, const pb_field_t *field)
+bool checkreturn pb_encode_tag_for_field(pb_ostream_t *stream, const pb_field_t *field)
 {
     pb_wire_type_t wiretype;
     switch (PB_LTYPE(field->type))
@@ -211,13 +325,12 @@ bool pb_encode_tag_for_field(pb_ostream_t *stream, const pb_field_t *field)
             wiretype = PB_WT_VARINT;
             break;
         
-        case PB_LTYPE_FIXED:
-            if (field->data_size == 4)
-                wiretype = PB_WT_32BIT;
-            else if (field->data_size == 8)
-                wiretype = PB_WT_64BIT;
-            else
-                return false;
+        case PB_LTYPE_FIXED32:
+            wiretype = PB_WT_32BIT;
+            break;
+        
+        case PB_LTYPE_FIXED64:
+            wiretype = PB_WT_64BIT;
             break;
         
         case PB_LTYPE_BYTES:
@@ -233,99 +346,115 @@ bool pb_encode_tag_for_field(pb_ostream_t *stream, const pb_field_t *field)
     return pb_encode_tag(stream, wiretype, field->tag);
 }
 
-bool pb_encode_string(pb_ostream_t *stream, const uint8_t *buffer, size_t size)
+bool checkreturn pb_encode_string(pb_ostream_t *stream, const uint8_t *buffer, size_t size)
 {
-    if (!pb_encode_varint(stream, size))
+    if (!pb_encode_varint(stream, (uint64_t)size))
         return false;
     
     return pb_write(stream, buffer, size);
 }
 
-/* Field encoders */
-
-/* Copy srcsize bytes from src so that values are casted properly.
- * On little endian machine, copy to start of dest
- * On big endian machine, copy to end of dest
- * destsize must always be larger than srcsize
- * 
- * Note: This is the reverse of the endian_copy in pb_decode.c.
- */
-static void endian_copy(void *dest, const void *src, size_t destsize, size_t srcsize)
+bool checkreturn pb_encode_submessage(pb_ostream_t *stream, const pb_field_t fields[], const void *src_struct)
 {
-#ifdef __BIG_ENDIAN__
-    memcpy((char*)dest + (destsize - srcsize), src, srcsize);
-#else
-    memcpy(dest, src, srcsize);
-#endif
+    /* First calculate the message size using a non-writing substream. */
+    pb_ostream_t substream = {0,0,0,0};
+    size_t size;
+    bool status;
+    
+    if (!pb_encode(&substream, fields, src_struct))
+        return false;
+    
+    size = substream.bytes_written;
+    
+    if (!pb_encode_varint(stream, (uint64_t)size))
+        return false;
+    
+    if (stream->callback == NULL)
+        return pb_write(stream, NULL, size); /* Just sizing */
+    
+    if (stream->bytes_written + size > stream->max_size)
+        return false;
+        
+    /* Use a substream to verify that a callback doesn't write more than
+     * what it did the first time. */
+    substream.callback = stream->callback;
+    substream.state = stream->state;
+    substream.max_size = size;
+    substream.bytes_written = 0;
+    
+    status = pb_encode(&substream, fields, src_struct);
+    
+    stream->bytes_written += substream.bytes_written;
+    stream->state = substream.state;
+    
+    if (substream.bytes_written != size)
+        return false;
+    
+    return status;
 }
 
-bool pb_enc_varint(pb_ostream_t *stream, const pb_field_t *field, const void *src)
+/* Field encoders */
+
+bool checkreturn pb_enc_varint(pb_ostream_t *stream, const pb_field_t *field, const void *src)
 {
     uint64_t value = 0;
-    endian_copy(&value, src, sizeof(value), field->data_size);
+    
+    switch (field->data_size)
+    {
+        case 1: value = *(const uint8_t*)src; break;
+        case 2: value = *(const uint16_t*)src; break;
+        case 4: value = *(const uint32_t*)src; break;
+        case 8: value = *(const uint64_t*)src; break;
+        default: return false;
+    }
+    
     return pb_encode_varint(stream, value);
 }
 
-bool pb_enc_svarint(pb_ostream_t *stream, const pb_field_t *field, const void *src)
+bool checkreturn pb_enc_svarint(pb_ostream_t *stream, const pb_field_t *field, const void *src)
 {
-    uint64_t value = 0;
-    uint64_t zigzagged;
-    uint64_t signbitmask, xormask;
-    endian_copy(&value, src, sizeof(value), field->data_size);
+    int64_t value = 0;
     
-    signbitmask = (uint64_t)0x80 << (field->data_size * 8 - 8);
-    xormask = ((uint64_t)-1) >> (64 - field->data_size * 8);
-    if (value & signbitmask)
-        zigzagged = ((value ^ xormask) << 1) | 1;
-    else
-        zigzagged = value << 1;
+    switch (field->data_size)
+    {
+        case 4: value = *(const int32_t*)src; break;
+        case 8: value = *(const int64_t*)src; break;
+        default: return false;
+    }
     
-    return pb_encode_varint(stream, zigzagged);
+    return pb_encode_svarint(stream, value);
 }
 
-bool pb_enc_fixed(pb_ostream_t *stream, const pb_field_t *field, const void *src)
+bool checkreturn pb_enc_fixed64(pb_ostream_t *stream, const pb_field_t *field, const void *src)
 {
-    #ifdef __BIG_ENDIAN__
-    uint8_t bytes[8] = {0};
-    endian_copy(bytes, src, sizeof(bytes), field->data_size);
-    uint8_t lebytes[8] = {bytes[7], bytes[6], bytes[5], bytes[4], 
-                          bytes[3], bytes[2], bytes[1], bytes[0]};
-    return pb_write(stream, lebytes, field->data_size);
-    #else
-    return pb_write(stream, (uint8_t*)src, field->data_size);
-    #endif
+    UNUSED(field);
+    return pb_encode_fixed64(stream, src);
 }
 
-bool pb_enc_bytes(pb_ostream_t *stream, const pb_field_t *field, const void *src)
+bool checkreturn pb_enc_fixed32(pb_ostream_t *stream, const pb_field_t *field, const void *src)
 {
-    pb_bytes_array_t *bytes = (pb_bytes_array_t*)src;
+    UNUSED(field);
+    return pb_encode_fixed32(stream, src);
+}
+
+bool checkreturn pb_enc_bytes(pb_ostream_t *stream, const pb_field_t *field, const void *src)
+{
+    const pb_bytes_array_t *bytes = (const pb_bytes_array_t*)src;
+    UNUSED(field);
     return pb_encode_string(stream, bytes->bytes, bytes->size);
 }
 
-bool pb_enc_string(pb_ostream_t *stream, const pb_field_t *field, const void *src)
+bool checkreturn pb_enc_string(pb_ostream_t *stream, const pb_field_t *field, const void *src)
 {
-    return pb_encode_string(stream, (uint8_t*)src, strlen((char*)src));
+    UNUSED(field);
+    return pb_encode_string(stream, (const uint8_t*)src, strlen((const char*)src));
 }
 
-bool pb_enc_submessage(pb_ostream_t *stream, const pb_field_t *field, const void *src)
+bool checkreturn pb_enc_submessage(pb_ostream_t *stream, const pb_field_t *field, const void *src)
 {
-    pb_ostream_t sizestream = {0};
-    size_t size;
-    
     if (field->ptr == NULL)
         return false;
     
-    if (!pb_encode(&sizestream, (pb_field_t*)field->ptr, src))
-        return false;
-    
-    size = sizestream.bytes_written;
-    
-    if (!pb_encode_varint(stream, size))
-        return false;
-    
-    if (stream->callback == NULL)
-        return pb_write(stream, NULL, size); /* Just sizing */
-    
-    return pb_encode(stream, (pb_field_t*)field->ptr, src);
+    return pb_encode_submessage(stream, (const pb_field_t*)field->ptr, src);
 }