Documentation updates
[apps/agl-service-can-low-level.git] / pb_decode.c
index 30c36b3..7938d70 100644 (file)
@@ -472,30 +472,34 @@ static bool checkreturn decode_static_field(pb_istream_t *stream, pb_wire_type_t
 #ifdef PB_ENABLE_MALLOC
 /* Allocate storage for the field and store the pointer at iter->pData.
  * array_size is the number of entries to reserve in an array. */
-static bool checkreturn allocate_field(pb_istream_t *stream, pb_field_iterator_t *iter, size_t array_size)
+static bool checkreturn allocate_field(pb_istream_t *stream, void *pData, size_t data_size, size_t array_size)
 {    
-    void *ptr = *(void**)iter->pData;
-    size_t size = array_size * iter->pos->data_size;
+    void *ptr = *(void**)pData;
+    size_t size = array_size * data_size;
     
+    /* Allocate new or expand previous allocation */
+    /* Note: on failure the old pointer will remain in the structure,
+     * the message must be freed by caller also on error return. */
+    ptr = realloc(ptr, size);
     if (ptr == NULL)
+        PB_RETURN_ERROR(stream, "realloc failed");
+    
+    *(void**)pData = ptr;
+    return true;
+}
+
+/* Clear a newly allocated item in case it contains a pointer, or is a submessage. */
+static void initialize_pointer_field(void *pItem, pb_field_iterator_t *iter)
+{
+    if (PB_LTYPE(iter->pos->type) == PB_LTYPE_STRING ||
+        PB_LTYPE(iter->pos->type) == PB_LTYPE_BYTES)
     {
-        /* First allocation */
-        ptr = malloc(size);
-        if (ptr == NULL)
-            PB_RETURN_ERROR(stream, "malloc failed");
+        *(void**)pItem = NULL;
     }
-    else
+    else if (PB_LTYPE(iter->pos->type) == PB_LTYPE_SUBMESSAGE)
     {
-        /* Expand previous allocation */
-        /* Note: on failure the old pointer will remain in the structure,
-         * the message must be freed by caller also on error return. */
-        ptr = realloc(ptr, size);
-        if (ptr == NULL)
-            PB_RETURN_ERROR(stream, "realloc failed");
+        pb_message_set_to_defaults((const pb_field_t *) iter->pos->ptr, pItem);
     }
-    
-    *(void**)iter->pData = ptr;
-    return true;
 }
 #endif
 
@@ -516,15 +520,17 @@ static bool checkreturn decode_pointer_field(pb_istream_t *stream, pb_wire_type_
     {
         case PB_HTYPE_REQUIRED:
         case PB_HTYPE_OPTIONAL:
-            if (PB_LTYPE(type) == PB_LTYPE_STRING)
+            if (PB_LTYPE(type) == PB_LTYPE_STRING ||
+                PB_LTYPE(type) == PB_LTYPE_BYTES)
             {
                 return func(stream, iter->pos, iter->pData);
             }
             else
             {
-                if (!allocate_field(stream, iter, 1))
+                if (!allocate_field(stream, iter->pData, iter->pos->data_size, 1))
                     return false;
                 
+                initialize_pointer_field(*(void**)iter->pData, iter);
                 return func(stream, iter->pos, *(void**)iter->pData);
             }
     
@@ -547,12 +553,11 @@ static bool checkreturn decode_pointer_field(pb_istream_t *stream, pb_wire_type_
                     if (*size + 1 > allocated_size)
                     {
                         /* Allocate more storage. This tries to guess the
-                         * number of remaining entries. */
-                        allocated_size += substream.bytes_left / iter->pos->data_size;
-                        if (*size + 1 > allocated_size)
-                            allocated_size++; /* Division gave zero. */
+                         * number of remaining entries. Round the division
+                         * upwards. */
+                        allocated_size += (substream.bytes_left - 1) / iter->pos->data_size + 1;
                         
-                        if (!allocate_field(&substream, iter, allocated_size))
+                        if (!allocate_field(&substream, iter->pData, iter->pos->data_size, allocated_size))
                         {
                             status = false;
                             break;
@@ -560,7 +565,8 @@ static bool checkreturn decode_pointer_field(pb_istream_t *stream, pb_wire_type_
                     }
 
                     /* Decode the array entry */
-                    pItem = (uint8_t*)iter->pData + iter->pos->data_size * (*size);
+                    pItem = *(uint8_t**)iter->pData + iter->pos->data_size * (*size);
+                    initialize_pointer_field(pItem, iter);
                     if (!func(&substream, iter->pos, pItem))
                     {
                         status = false;
@@ -576,13 +582,14 @@ static bool checkreturn decode_pointer_field(pb_istream_t *stream, pb_wire_type_
             {
                 /* Normal repeated field, i.e. only one item at a time. */
                 size_t *size = (size_t*)iter->pSize;
-                void *pItem = (uint8_t*)iter->pData + iter->pos->data_size * (*size);
+                void *pItem;
                 
-                if (!allocate_field(stream, iter, *size + 1))
+                (*size)++;
+                if (!allocate_field(stream, iter->pData, iter->pos->data_size, *size))
                     return false;
             
-                
-                (*size)++;
+                pItem = *(uint8_t**)iter->pData + iter->pos->data_size * (*size - 1);
+                initialize_pointer_field(pItem, iter);
                 return func(stream, iter->pos, pItem);
             }
             
@@ -887,8 +894,16 @@ bool checkreturn pb_decode_noinit(pb_istream_t *stream, const pb_field_t fields[
 
 bool checkreturn pb_decode(pb_istream_t *stream, const pb_field_t fields[], void *dest_struct)
 {
+    bool status;
     pb_message_set_to_defaults(fields, dest_struct);
-    return pb_decode_noinit(stream, fields, dest_struct);
+    status = pb_decode_noinit(stream, fields, dest_struct);
+    
+#ifdef PB_ENABLE_MALLOC
+    if (!status)
+        pb_release(fields, dest_struct);
+#endif
+    
+    return status;
 }
 
 bool pb_decode_delimited(pb_istream_t *stream, const pb_field_t fields[], void *dest_struct)
@@ -904,6 +919,62 @@ bool pb_decode_delimited(pb_istream_t *stream, const pb_field_t fields[], void *
     return status;
 }
 
+#ifdef PB_ENABLE_MALLOC
+void pb_release(const pb_field_t fields[], void *dest_struct)
+{
+    pb_field_iterator_t iter;
+    pb_field_init(&iter, fields, dest_struct);
+    
+    do
+    {
+        pb_type_t type;
+        type = iter.pos->type;
+    
+        /* Avoid crash on empty message types (zero fields) */
+        if (iter.pos->tag == 0)
+            continue;
+        
+        if (PB_ATYPE(type) == PB_ATYPE_POINTER)
+        {
+            if (PB_HTYPE(type) == PB_HTYPE_REPEATED &&
+                (PB_LTYPE(type) == PB_LTYPE_STRING ||
+                 PB_LTYPE(type) == PB_LTYPE_BYTES))
+            {
+                /* Release entries in repeated string or bytes array */
+                void **pItem = *(void***)iter.pData;
+                size_t count = *(size_t*)iter.pSize;
+                while (count--)
+                {
+                    free(*pItem);
+                    *pItem++ = NULL;
+                }
+            }
+            else if (PB_LTYPE(type) == PB_LTYPE_SUBMESSAGE)
+            {
+                /* Release fields in submessages */
+                void *pItem = *(void**)iter.pData;
+                size_t count = (pItem ? 1 : 0);
+                
+                if (PB_HTYPE(type) == PB_HTYPE_REPEATED)
+                {
+                    count = *(size_t*)iter.pSize;   
+                }
+                
+                while (count--)
+                {
+                    pb_release((const pb_field_t*)iter.pos->ptr, pItem);
+                    pItem = (uint8_t*)pItem + iter.pos->data_size;
+                }
+            }
+            
+            /* Release main item */
+            free(*(void**)iter.pData);
+            *(void**)iter.pData = NULL;
+        }
+    } while (pb_field_next(&iter));
+}
+#endif
+
 /* Field decoders */
 
 bool pb_decode_svarint(pb_istream_t *stream, int64_t *dest)
@@ -1026,42 +1097,57 @@ bool checkreturn pb_dec_fixed64(pb_istream_t *stream, const pb_field_t *field, v
 
 bool checkreturn pb_dec_bytes(pb_istream_t *stream, const pb_field_t *field, void *dest)
 {
-    pb_bytes_array_t *x = (pb_bytes_array_t*)dest;
+    uint32_t size;
+    pb_bytes_array_t *bdest;
     
-    uint32_t temp;
-    if (!pb_decode_varint32(stream, &temp))
+    if (!pb_decode_varint32(stream, &size))
         return false;
-    x->size = temp;
     
-    /* Check length, noting the space taken by the size_t header. */
-    if (x->size > field->data_size - offsetof(pb_bytes_array_t, bytes))
-        PB_RETURN_ERROR(stream, "bytes overflow");
+    if (PB_ATYPE(field->type) == PB_ATYPE_POINTER)
+    {
+#ifndef PB_ENABLE_MALLOC
+        PB_RETURN_ERROR(stream, "no malloc support");
+#else
+        if (!allocate_field(stream, dest, PB_BYTES_ARRAY_T_ALLOCSIZE(size), 1))
+            return false;
+        bdest = *(pb_bytes_array_t**)dest;
+#endif
+    }
+    else
+    {
+        if (PB_BYTES_ARRAY_T_ALLOCSIZE(size) > field->data_size)
+            PB_RETURN_ERROR(stream, "bytes overflow");
+        bdest = (pb_bytes_array_t*)dest;
+    }
     
-    return pb_read(stream, x->bytes, x->size);
+    bdest->size = size;
+    return pb_read(stream, bdest->bytes, size);
 }
 
 bool checkreturn pb_dec_string(pb_istream_t *stream, const pb_field_t *field, void *dest)
 {
     uint32_t size;
+    size_t alloc_size;
     bool status;
     if (!pb_decode_varint32(stream, &size))
         return false;
     
-    /* Check length, noting the null terminator */
+    /* Space for null terminator */
+    alloc_size = size + 1;
+    
     if (PB_ATYPE(field->type) == PB_ATYPE_POINTER)
     {
 #ifndef PB_ENABLE_MALLOC
         PB_RETURN_ERROR(stream, "no malloc support");
 #else
-        *(void**)dest = realloc(*(void**)dest, size + 1);
-        if (*(void**)dest == NULL)
-            PB_RETURN_ERROR(stream, "out of memory");
+        if (!allocate_field(stream, dest, alloc_size, 1))
+            return false;
         dest = *(void**)dest;
 #endif
     }
     else
     {
-        if (size + 1 > field->data_size)
+        if (alloc_size > field->data_size)
             PB_RETURN_ERROR(stream, "string overflow");
     }