Implement error messages in the decoder side.
[apps/agl-service-can-low-level.git] / pb_decode.c
index 6d3a0b6..9d65504 100644 (file)
@@ -3,14 +3,15 @@
  * 2011 Petteri Aimonen <jpa@kapsi.fi>
  */
 
-
-#ifdef __GNUC__
-/* Verify that we remember to check all return values for proper error propagation */
-#define checkreturn __attribute__((warn_unused_result))
+/* 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
-#define checkreturn
+    /* Verify that we remember to check all return values for proper error propagation */
+    #define checkreturn __attribute__((warn_unused_result))
 #endif
 
+#define NANOPB_INTERNALS
 #include "pb.h"
 #include "pb_decode.h"
 #include <string.h>
@@ -38,10 +39,10 @@ static const pb_decoder_t PB_DECODERS[PB_LTYPES_COUNT] = {
 bool checkreturn pb_read(pb_istream_t *stream, uint8_t *buf, size_t count)
 {
     if (stream->bytes_left < count)
-        return false;
+        PB_RETURN_ERROR(stream, "end-of-stream");
     
     if (!stream->callback(stream, buf, count))
-        return false;
+        PB_RETURN_ERROR(stream, "io error");
     
     stream->bytes_left -= count;
     return true;
@@ -94,7 +95,7 @@ bool checkreturn pb_decode_varint(pb_istream_t *stream, uint64_t *dest)
             return true;
     }
     
-    return false;
+    PB_RETURN_ERROR(stream, "varint overflow");
 }
 
 bool checkreturn pb_skip_varint(pb_istream_t *stream)
@@ -121,7 +122,7 @@ bool checkreturn pb_decode_tag(pb_istream_t *stream, pb_wire_type_t *wire_type,
 {
     uint32_t temp;
     *eof = false;
-    *wire_type = 0;
+    *wire_type = (pb_wire_type_t) 0;
     *tag = 0;
     
     if (!pb_decode_varint32(stream, &temp))
@@ -151,7 +152,7 @@ bool checkreturn pb_skip_field(pb_istream_t *stream, pb_wire_type_t wire_type)
         case PB_WT_64BIT: return pb_read(stream, NULL, 8);
         case PB_WT_STRING: return pb_skip_string(stream);
         case PB_WT_32BIT: return pb_read(stream, NULL, 4);
-        default: return false;
+        default: PB_RETURN_ERROR(stream, "invalid wire_type");
     }
 }
 
@@ -181,15 +182,14 @@ static bool checkreturn read_raw_value(pb_istream_t *stream, pb_wire_type_t wire
             *size = 4;
             return pb_read(stream, buf, 4);
         
-        default: return false;
+        default: PB_RETURN_ERROR(stream, "invalid wire_type");
     }
 }
 
 /* Decode string length from stream and return a substream with limited length.
- * Before disposing the substream, remember to copy the substream->state back
- * to stream->state.
+ * Remember to close the substream using pb_close_string_substream().
  */
-static bool checkreturn make_string_substream(pb_istream_t *stream, pb_istream_t *substream)
+bool checkreturn pb_make_string_substream(pb_istream_t *stream, pb_istream_t *substream)
 {
     uint32_t size;
     if (!pb_decode_varint32(stream, &size))
@@ -197,13 +197,18 @@ static bool checkreturn make_string_substream(pb_istream_t *stream, pb_istream_t
     
     *substream = *stream;
     if (substream->bytes_left < size)
-        return false;
+        PB_RETURN_ERROR(stream, "parent stream too short");
     
     substream->bytes_left = size;
     stream->bytes_left -= size;
     return true;
 }
 
+void pb_close_string_substream(pb_istream_t *stream, pb_istream_t *substream)
+{
+    stream->state = substream->state;
+}
+
 /* Iterator for pb_field_t list */
 typedef struct {
     const pb_field_t *start; /* Start of the pb_field_t array */
@@ -291,7 +296,7 @@ static bool checkreturn decode_field(pb_istream_t *stream, pb_wire_type_t wire_t
                 bool status;
                 size_t *size = (size_t*)iter->pSize;
                 pb_istream_t substream;
-                if (!make_string_substream(stream, &substream))
+                if (!pb_make_string_substream(stream, &substream))
                     return false;
                 
                 while (substream.bytes_left && *size < iter->current->array_size)
@@ -302,7 +307,7 @@ static bool checkreturn decode_field(pb_istream_t *stream, pb_wire_type_t wire_t
                     (*size)++;
                 }
                 status = (substream.bytes_left == 0);
-                stream->state = substream.state;
+                pb_close_string_substream(stream, &substream);
                 return status;
             }
             else
@@ -311,7 +316,7 @@ static bool checkreturn decode_field(pb_istream_t *stream, pb_wire_type_t wire_t
                 size_t *size = (size_t*)iter->pSize;
                 void *pItem = (uint8_t*)iter->pData + iter->current->data_size * (*size);
                 if (*size >= iter->current->array_size)
-                    return false;
+                    PB_RETURN_ERROR(stream, "array overflow");
                 
                 (*size)++;
                 return func(stream, iter->current, pItem);
@@ -328,16 +333,16 @@ static bool checkreturn decode_field(pb_istream_t *stream, pb_wire_type_t wire_t
             {
                 pb_istream_t substream;
                 
-                if (!make_string_substream(stream, &substream))
+                if (!pb_make_string_substream(stream, &substream))
                     return false;
                 
                 while (substream.bytes_left)
                 {
                     if (!pCallback->funcs.decode(&substream, iter->current, pCallback->arg))
-                        return false;
+                        PB_RETURN_ERROR(stream, "callback failed");
                 }
                 
-                stream->state = substream.state;
+                pb_close_string_substream(stream, &substream);
                 return true;
             }
             else
@@ -359,7 +364,7 @@ static bool checkreturn decode_field(pb_istream_t *stream, pb_wire_type_t wire_t
         }
         
         default:
-            return false;
+            PB_RETURN_ERROR(stream, "invalid field type");
     }
 }
 
@@ -393,7 +398,7 @@ static void pb_message_set_to_defaults(const pb_field_t fields[], void *dest_str
         }
         else if (PB_LTYPE(iter.current->type) == PB_LTYPE_SUBMESSAGE)
         {
-            pb_message_set_to_defaults(iter.current->ptr, iter.pData);
+            pb_message_set_to_defaults((const pb_field_t *) iter.current->ptr, iter.pData);
         }
         else if (iter.current->ptr != NULL)
         {
@@ -458,7 +463,7 @@ bool checkreturn pb_decode(pb_istream_t *stream, const pb_field_t fields[], void
             iter.required_field_index < PB_MAX_REQUIRED_FIELDS &&
             !(fields_seen[iter.required_field_index >> 3] & (1 << (iter.required_field_index & 7))))
         {
-            return false;
+            PB_RETURN_ERROR(stream, "missing required field");
         }
     } while (pb_field_next(&iter));
     
@@ -467,78 +472,104 @@ bool checkreturn pb_decode(pb_istream_t *stream, const pb_field_t fields[], void
 
 /* Field decoders */
 
-/* Copy destsize bytes from src so that values are casted properly.
- * On little endian machine, copy first n bytes of src
- * On big endian machine, copy last n bytes of src
- * srcsize must always be larger than destsize
- */
-static void endian_copy(void *dest, void *src, size_t destsize, size_t srcsize)
+bool pb_decode_svarint(pb_istream_t *stream, int64_t *dest)
 {
-#ifdef __BIG_ENDIAN__
-    memcpy(dest, (char*)src + (srcsize - destsize), destsize);
-#else
-    UNUSED(srcsize);
-    memcpy(dest, src, destsize);
-#endif
+    uint64_t value;
+    if (!pb_decode_varint(stream, &value))
+        return false;
+    
+    if (value & 1)
+        *dest = ~(value >> 1);
+    else
+        *dest = value >> 1;
+    
+    return true;
+}
+
+bool pb_decode_fixed32(pb_istream_t *stream, void *dest)
+{
+    #ifdef __BIG_ENDIAN__
+    uint8_t *bytes = (uint8_t*)dest;
+    uint8_t lebytes[4];
+    
+    if (!pb_read(stream, lebytes, 4))
+        return false;
+    
+    bytes[0] = lebytes[3];
+    bytes[1] = lebytes[2];
+    bytes[2] = lebytes[1];
+    bytes[3] = lebytes[0];
+    return true;
+    #else
+    return pb_read(stream, (uint8_t*)dest, 4);
+    #endif   
+}
+
+bool pb_decode_fixed64(pb_istream_t *stream, void *dest)
+{
+    #ifdef __BIG_ENDIAN__
+    uint8_t *bytes = (uint8_t*)dest;
+    uint8_t lebytes[8];
+    
+    if (!pb_read(stream, lebytes, 8))
+        return false;
+    
+    bytes[0] = lebytes[7];
+    bytes[1] = lebytes[6];
+    bytes[2] = lebytes[5];
+    bytes[3] = lebytes[4];
+    bytes[4] = lebytes[3];
+    bytes[5] = lebytes[2];
+    bytes[6] = lebytes[1];
+    bytes[7] = lebytes[0];
+    return true;
+    #else
+    return pb_read(stream, (uint8_t*)dest, 8);
+    #endif   
 }
 
 bool checkreturn pb_dec_varint(pb_istream_t *stream, const pb_field_t *field, void *dest)
 {
-    uint64_t temp;
-    bool status = pb_decode_varint(stream, &temp);
-    endian_copy(dest, &temp, field->data_size, sizeof(temp));
+    uint64_t value;
+    bool status = pb_decode_varint(stream, &value);
+    
+    switch (field->data_size)
+    {
+        case 1: *(uint8_t*)dest = value; break;
+        case 2: *(uint16_t*)dest = value; break;
+        case 4: *(uint32_t*)dest = value; break;
+        case 8: *(uint64_t*)dest = value; break;
+        default: PB_RETURN_ERROR(stream, "invalid data_size");
+    }
+    
     return status;
 }
 
 bool checkreturn pb_dec_svarint(pb_istream_t *stream, const pb_field_t *field, void *dest)
 {
-    uint64_t temp;
-    bool status = pb_decode_varint(stream, &temp);
-    temp = (temp >> 1) ^ -(int64_t)(temp & 1);
-    endian_copy(dest, &temp, field->data_size, sizeof(temp));
+    int64_t value;
+    bool status = pb_decode_svarint(stream, &value);
+    
+    switch (field->data_size)
+    {
+        case 4: *(int32_t*)dest = value; break;
+        case 8: *(int64_t*)dest = value; break;
+        default: PB_RETURN_ERROR(stream, "invalid data_size");
+    }
+    
     return status;
 }
 
 bool checkreturn pb_dec_fixed32(pb_istream_t *stream, const pb_field_t *field, void *dest)
 {
-#ifdef __BIG_ENDIAN__
-    uint8_t bytes[4] = {0};
-    bool status = pb_read(stream, bytes, 4);
-    if (status) {
-        uint8_t *d = (uint8_t*)dest;
-        d[0] = bytes[3];
-        d[1] = bytes[2];
-        d[2] = bytes[1];
-        d[3] = bytes[0];
-    }
-    return status;
-#else
     UNUSED(field);
-    return pb_read(stream, (uint8_t*)dest, 4);
-#endif
+    return pb_decode_fixed32(stream, dest);
 }
 
 bool checkreturn pb_dec_fixed64(pb_istream_t *stream, const pb_field_t *field, void *dest)
 {
-#ifdef __BIG_ENDIAN__
-    uint8_t bytes[8] = {0};
-    bool status = pb_read(stream, bytes, 8);
-    if (status) {
-        uint8_t *d = (uint8_t*)dest;
-        d[0] = bytes[7];
-        d[1] = bytes[6];
-        d[2] = bytes[5]; 
-        d[3] = bytes[4];
-        d[4] = bytes[3];
-        d[5] = bytes[2];
-        d[6] = bytes[1];
-        d[7] = bytes[0];
-    }
-    return status;
-#else
     UNUSED(field);
-    return pb_read(stream, (uint8_t*)dest, 8);
-#endif
+    return pb_decode_fixed64(stream, dest);
 }
 
 bool checkreturn pb_dec_bytes(pb_istream_t *stream, const pb_field_t *field, void *dest)
@@ -552,7 +583,7 @@ bool checkreturn pb_dec_bytes(pb_istream_t *stream, const pb_field_t *field, voi
     
     /* Check length, noting the space taken by the size_t header. */
     if (x->size > field->data_size - offsetof(pb_bytes_array_t, bytes))
-        return false;
+        PB_RETURN_ERROR(stream, "bytes overflow");
     
     return pb_read(stream, x->bytes, x->size);
 }
@@ -566,7 +597,7 @@ bool checkreturn pb_dec_string(pb_istream_t *stream, const pb_field_t *field, vo
     
     /* Check length, noting the null terminator */
     if (size + 1 > field->data_size)
-        return false;
+        PB_RETURN_ERROR(stream, "string overflow");
     
     status = pb_read(stream, (uint8_t*)dest, size);
     *((uint8_t*)dest + size) = 0;
@@ -578,13 +609,13 @@ bool checkreturn pb_dec_submessage(pb_istream_t *stream, const pb_field_t *field
     bool status;
     pb_istream_t substream;
     
-    if (!make_string_substream(stream, &substream))
+    if (!pb_make_string_substream(stream, &substream))
         return false;
     
     if (field->ptr == NULL)
-        return false;
+        PB_RETURN_ERROR(stream, "invalid field descriptor");
     
     status = pb_decode(&substream, (pb_field_t*)field->ptr, dest);
-    stream->state = substream.state;
+    pb_close_string_substream(stream, &substream);
     return status;
 }