diff options
| -rw-r--r-- | pb.h | 127 | ||||
| -rw-r--r-- | pb_decode.c | 128 | ||||
| -rw-r--r-- | pb_decode.h | 49 | ||||
| -rw-r--r-- | tests/Makefile | 11 | ||||
| -rw-r--r-- | tests/test_decode1.c | 2 |
5 files changed, 176 insertions, 141 deletions
@@ -2,57 +2,31 @@ #define _PB_H_ #include <stdint.h> -#include <stddef.h> // size_t +#include <stddef.h> #include <stdbool.h> #ifdef __GNUC__ -// This just reduces memory requirements, but is not required. +/* This just reduces memory requirements, but is not required. */ #define pb_packed __attribute__((packed)) #else #define pb_packed #endif -/* Lightweight input stream. - * If buf is NULL, read but don't store bytes. - * You have to provide a callback function for reading. - * You can use state to store your own data (e.g. buffer pointer), - * and rely on pb_read to verify that no-body reads past bytes_left. - * However, substreams may change bytes_left so don't use that to - * compute any pointers. - */ -typedef struct _pb_istream_t pb_istream_t; -struct _pb_istream_t -{ - bool (*callback)(pb_istream_t *stream, uint8_t *buf, size_t count); - void *state; // Free field for use by callback implementation - size_t bytes_left; -}; - -static inline bool pb_read(pb_istream_t *stream, uint8_t *buf, size_t count) -{ - if (stream->bytes_left < count) - return false; - - bool status = stream->callback(stream, buf, count); - stream->bytes_left -= count; - return status; -} - /* Lightweight output stream. */ typedef struct _pb_ostream_t pb_ostream_t; struct _pb_ostream_t { bool (*callback)(pb_ostream_t *stream, const uint8_t *buf, size_t count); - void *state; // Free field for use by callback implementation + void *state; /* Free field for use by callback implementation */ size_t bytes_written; }; -static inline bool pb_write(pb_ostream_t *stream, const uint8_t *buf, size_t count) +/*static inline bool pb_write(pb_ostream_t *stream, const uint8_t *buf, size_t count) { bool status = stream->callback(stream, buf, count); stream->bytes_written += count; return status; -} +}*/ /* List of possible field types * Least-significant 4 bits tell the scalar type @@ -65,7 +39,11 @@ static inline bool pb_write(pb_ostream_t *stream, const uint8_t *buf, size_t cou */ typedef enum { - // Standard integer types + /************************ + * Field contents types * + ************************/ + + /* Standard integer types */ PB_LTYPE_UINT32 = 0x00, PB_LTYPE_INT32 = 0x00, PB_LTYPE_SINT32 = 0x01, @@ -79,39 +57,40 @@ typedef enum { PB_LTYPE_BOOL = 0x06, PB_LTYPE_ENUM = 0x07, - // Standard float types + /* Standard float types */ PB_LTYPE_FLOAT = 0x08, PB_LTYPE_DOUBLE = 0x09, - // Byte array with pre-allocated buffer. - // data_size is the length of the allocated PB_BYTES_ARRAY structure. + /* Byte array with pre-allocated buffer. + * data_size is the length of the allocated PB_BYTES_ARRAY structure. */ PB_LTYPE_BYTES = 0x0A, - // String with pre-allocated buffer. - // data_size is the maximum length. + /* String with pre-allocated buffer. + * data_size is the maximum length. */ PB_LTYPE_STRING = 0x0B, - // Submessage - // submsg_fields is pointer to field descriptions + /* Submessage + * submsg_fields is pointer to field descriptions */ PB_LTYPE_SUBMESSAGE = 0x0C, - ///////////// - // Modifier flags + /****************** + * Modifier flags * + ******************/ - // Just the basic, write data at data_offset + /* Just the basic, write data at data_offset */ PB_HTYPE_REQUIRED = 0x00, - // Write true at size_offset + /* Write true at size_offset */ PB_HTYPE_OPTIONAL = 0x10, - // Read to pre-allocated array - // Maximum number of entries is array_size, - // actual number is stored at size_offset + /* Read to pre-allocated array + * Maximum number of entries is array_size, + * actual number is stored at size_offset */ PB_HTYPE_ARRAY = 0x20, - // Works for all required/optional/repeated fields. - // data_offset points to pb_callback_t structure. - // LTYPE is ignored. + /* Works for all required/optional/repeated fields. + * data_offset points to pb_callback_t structure. + * LTYPE is ignored. */ PB_HTYPE_CALLBACK = 0x30 } pb_packed pb_type_t; @@ -129,21 +108,21 @@ typedef struct _pb_field_t pb_field_t; struct _pb_field_t { uint8_t tag; pb_type_t type; - uint8_t data_offset; // Offset of actual data or array start - uint8_t size_offset; // Offset of array size or has-boolean - uint8_t data_size; // Data size in bytes for a single item - uint8_t array_size; // Maximum number of entries in array + uint8_t data_offset; /* Offset of actual data or array start */ + uint8_t size_offset; /* Offset of array size or has-boolean */ + uint8_t data_size; /* Data size in bytes for a single item */ + uint8_t array_size; /* Maximum number of entries in array */ - // Field definitions for submessage - // OR default value for all other non-array, non-callback types - // If null, then field will zeroed. + /* Field definitions for submessage + * OR default value for all other non-array, non-callback types + * If null, then field will zeroed. */ const void *ptr; } pb_packed; #define PB_LAST_FIELD {0,0,0,0} -// This structure is used for 'bytes' arrays. -// It has the number of bytes in the beginning, and after that an array. +/* This structure is used for 'bytes' arrays. + * It has the number of bytes in the beginning, and after that an array. */ #define PB_BYTES_ARRAY(buffersize) \ struct { \ size_t size; \ @@ -152,19 +131,23 @@ struct { \ typedef PB_BYTES_ARRAY(1) pb_bytes_array_t; -// This structure is used for giving the callback function. -// -// The decoding callback will be given a limited-length stream -// If the wire type was string, the length is the length of the string. -// If the wire type was a varint/fixed32/fixed64, the length is the length -// of the actual value. -// The function may be called multiple times (especially for repeated types, -// but also otherwise if the message happens to contain the field multiple -// times.) -// -// The encoding callback will receive the actual output stream. -// It should write all the data in one call, including the field tag and -// wire type. It can write multiple fields. +/* This structure is used for giving the callback function. + * It is stored in the message structure and filled in by the method that + * calls pb_decode. + * + * The decoding callback will be given a limited-length stream + * If the wire type was string, the length is the length of the string. + * If the wire type was a varint/fixed32/fixed64, the length is the length + * of the actual value. + * The function may be called multiple times (especially for repeated types, + * but also otherwise if the message happens to contain the field multiple + * times.) + * + * The encoding callback will receive the actual output stream. + * It should write all the data in one call, including the field tag and + * wire type. It can write multiple fields. + */ +typedef struct _pb_istream_t pb_istream_t; typedef struct _pb_callback_t pb_callback_t; struct _pb_callback_t { union { @@ -172,7 +155,7 @@ struct _pb_callback_t { bool (*encode)(pb_ostream_t *stream, const pb_field_t *field, void *arg); } funcs; - // Free arg for use by callback + /* Free arg for use by callback */ void *arg; }; diff --git a/pb_decode.c b/pb_decode.c index acd9b204..28856d37 100644 --- a/pb_decode.c +++ b/pb_decode.c @@ -8,26 +8,37 @@ #include <string.h> const pb_decoder_t PB_DECODERS[16] = { - &pb_dec_uint32, - &pb_dec_sint32, - &pb_dec_fixed32, - &pb_dec_uint64, - &pb_dec_sint64, - &pb_dec_fixed64, - &pb_dec_bool, - &pb_dec_enum, + (pb_decoder_t)&pb_dec_uint32, + (pb_decoder_t)&pb_dec_sint32, + (pb_decoder_t)&pb_dec_fixed32, + (pb_decoder_t)&pb_dec_uint64, + (pb_decoder_t)&pb_dec_sint64, + (pb_decoder_t)&pb_dec_fixed64, + (pb_decoder_t)&pb_dec_bool, + (pb_decoder_t)&pb_dec_enum, - &pb_dec_float, - &pb_dec_double, + (pb_decoder_t)&pb_dec_float, + (pb_decoder_t)&pb_dec_double, - &pb_dec_bytes, - &pb_dec_string, - &pb_dec_submessage + (pb_decoder_t)&pb_dec_bytes, + (pb_decoder_t)&pb_dec_string, + (pb_decoder_t)&pb_dec_submessage }; -//////////////////////// -// Helper functions -//////////////////////// +/************** + * pb_istream * + **************/ + +bool pb_read(pb_istream_t *stream, uint8_t *buf, size_t count) +{ + bool status; + if (stream->bytes_left < count) + return false; + + status = stream->callback(stream, buf, count); + stream->bytes_left -= count; + return status; +} static bool buf_read(pb_istream_t *stream, uint8_t *buf, size_t count) { @@ -42,10 +53,17 @@ static bool buf_read(pb_istream_t *stream, uint8_t *buf, size_t count) pb_istream_t pb_istream_from_buffer(uint8_t *buf, size_t bufsize) { - pb_istream_t stream = {&buf_read, buf, bufsize}; + pb_istream_t stream; + stream.callback = &buf_read; + stream.state = buf; + stream.bytes_left = bufsize; return stream; } +/******************** + * Helper functions * + ********************/ + bool pb_decode_varint32(pb_istream_t *stream, uint32_t *dest) { uint64_t temp; @@ -117,8 +135,8 @@ static bool skip(pb_istream_t *stream, int wire_type) } } -// Read a raw value to buffer, for the purpose of passing it to callback. -// Size is maximum size on call, and actual size on return. +/* Read a raw value to buffer, for the purpose of passing it to callback. + * Size is maximum size on call, and actual size on return. */ static bool read_raw_value(pb_istream_t *stream, int wire_type, uint8_t *buf, size_t *size) { size_t max_size = *size; @@ -146,7 +164,7 @@ static bool read_raw_value(pb_istream_t *stream, int wire_type, uint8_t *buf, si } } -// Decode string length from stream and return a substream with limited length +/* Decode string length from stream and return a substream with limited length */ static bool make_string_substream(pb_istream_t *stream, pb_istream_t *substream) { uint32_t size; @@ -183,7 +201,7 @@ bool decode_field(pb_istream_t *stream, int wire_type, const pb_field_t *field, && PB_LTYPE(field->type) != PB_LTYPE_STRING && PB_LTYPE(field->type) != PB_LTYPE_SUBMESSAGE) { - // Packed array + /* Packed array */ size_t *size = (size_t*)pSize; pb_istream_t substream; if (!make_string_substream(stream, &substream)) @@ -191,7 +209,7 @@ bool decode_field(pb_istream_t *stream, int wire_type, const pb_field_t *field, while (substream.bytes_left && *size < field->array_size) { - void *pItem = pData + field->data_size * (*size); + void *pItem = (uint8_t*)pData + field->data_size * (*size); if (!func(stream, field, pItem)) return false; (*size)++; @@ -200,12 +218,12 @@ bool decode_field(pb_istream_t *stream, int wire_type, const pb_field_t *field, } else { - // Repeated field + /* Repeated field */ size_t *size = (size_t*)pSize; + void *pItem = (uint8_t*)pData + field->data_size * (*size); if (*size >= field->array_size) return false; - void *pItem = pData + field->data_size * (*size); (*size)++; return func(stream, field, pItem); } @@ -227,17 +245,19 @@ bool decode_field(pb_istream_t *stream, int wire_type, const pb_field_t *field, } else { - // Copy the single scalar value to stack. - // This is required so that we can limit the stream length, - // which in turn allows to use same callback for packed and - // not-packed fields. + /* Copy the single scalar value to stack. + * This is required so that we can limit the stream length, + * which in turn allows to use same callback for packed and + * not-packed fields. */ + pb_istream_t substream; + pb_callback_t *pCallback = (pb_callback_t*)pData; uint8_t buffer[10]; size_t size = sizeof(buffer); + if (!read_raw_value(stream, wire_type, buffer, &size)) return false; - pb_istream_t substream = pb_istream_from_buffer(buffer, size); + substream = pb_istream_from_buffer(buffer, size); - pb_callback_t *pCallback = (pb_callback_t*)pData; return pCallback->funcs.decode(&substream, field, pCallback->arg); } @@ -248,11 +268,11 @@ bool decode_field(pb_istream_t *stream, int wire_type, const pb_field_t *field, bool pb_decode(pb_istream_t *stream, const pb_field_t fields[], void *dest_struct) { - // Used to check for required fields + /* Used to check for required fields */ uint32_t fields_seen = 0; int i; - // Initialize size/has fields and apply default values + /* Initialize size/has fields and apply default values */ for (i = 0; fields[i].tag != 0; i++) { void *pData = (char*)dest_struct + fields[i].data_offset; @@ -283,11 +303,12 @@ bool pb_decode(pb_istream_t *stream, const pb_field_t fields[], void *dest_struc while (stream->bytes_left) { uint32_t temp; + int tag, wire_type; if (!pb_decode_varint32(stream, &temp)) return false; - int tag = temp >> 3; - int wire_type = temp & 7; + tag = temp >> 3; + wire_type = temp & 7; i = 0; while (fields[i].tag != 0 && fields[i].tag != tag) @@ -295,7 +316,7 @@ bool pb_decode(pb_istream_t *stream, const pb_field_t fields[], void *dest_struc i++; } - if (fields[i].tag == 0) // No match found, skip data + if (fields[i].tag == 0) /* No match found, skip data */ { skip(stream, wire_type); continue; @@ -307,7 +328,7 @@ bool pb_decode(pb_istream_t *stream, const pb_field_t fields[], void *dest_struc return false; } - // Check that all required fields (mod 31) were present. + /* Check that all required fields (mod 31) were present. */ for (i = 0; fields[i].tag != 0; i++) { if (PB_HTYPE(fields[i].type) == PB_HTYPE_REQUIRED && @@ -322,12 +343,12 @@ bool pb_decode(pb_istream_t *stream, const pb_field_t fields[], void *dest_struc /* Field decoders */ -bool pb_dec_uint32(pb_istream_t *stream, const pb_field_t *field, void *dest) +bool pb_dec_uint32(pb_istream_t *stream, const pb_field_t *field, uint32_t *dest) { - return pb_decode_varint32(stream, (uint32_t*)dest); + return pb_decode_varint32(stream, dest); } -bool pb_dec_sint32(pb_istream_t *stream, const pb_field_t *field, void *dest) +bool pb_dec_sint32(pb_istream_t *stream, const pb_field_t *field, int32_t *dest) { uint32_t *x = (uint32_t*)dest; bool status = pb_decode_varint32(stream, x); @@ -335,7 +356,7 @@ bool pb_dec_sint32(pb_istream_t *stream, const pb_field_t *field, void *dest) return status; } -bool pb_dec_fixed32(pb_istream_t *stream, const pb_field_t *field, void *dest) +bool pb_dec_fixed32(pb_istream_t *stream, const pb_field_t *field, uint32_t *dest) { uint8_t bytes[4] = {0}; bool status = pb_read(stream, bytes, 4); @@ -349,12 +370,12 @@ bool pb_dec_fixed32(pb_istream_t *stream, const pb_field_t *field, void *dest) return status; } -bool pb_dec_uint64(pb_istream_t *stream, const pb_field_t *field, void *dest) +bool pb_dec_uint64(pb_istream_t *stream, const pb_field_t *field, uint64_t *dest) { - return pb_decode_varint64(stream, (uint64_t*)dest); + return pb_decode_varint64(stream, dest); } -bool pb_dec_sint64(pb_istream_t *stream, const pb_field_t *field, void *dest) +bool pb_dec_sint64(pb_istream_t *stream, const pb_field_t *field, int64_t *dest) { uint64_t *x = (uint64_t*)dest; bool status = pb_decode_varint64(stream, x); @@ -362,7 +383,7 @@ bool pb_dec_sint64(pb_istream_t *stream, const pb_field_t *field, void *dest) return status; } -bool pb_dec_fixed64(pb_istream_t *stream, const pb_field_t *field, void *dest) +bool pb_dec_fixed64(pb_istream_t *stream, const pb_field_t *field, uint64_t *dest) { uint8_t bytes[8] = {0}; bool status = pb_read(stream, bytes, 8); @@ -377,7 +398,7 @@ bool pb_dec_fixed64(pb_istream_t *stream, const pb_field_t *field, void *dest) return status; } -bool pb_dec_bool(pb_istream_t *stream, const pb_field_t *field, void *dest) +bool pb_dec_bool(pb_istream_t *stream, const pb_field_t *field, bool *dest) { uint32_t temp = 0; bool status = pb_decode_varint32(stream, &temp); @@ -387,24 +408,24 @@ bool pb_dec_bool(pb_istream_t *stream, const pb_field_t *field, void *dest) bool pb_dec_enum(pb_istream_t *stream, const pb_field_t *field, void *dest) { - // Enum sizes can vary, copy only data_size amount of bytes. + /* Enum sizes can vary, copy only data_size amount of bytes. */ uint32_t temp = 0; bool status = pb_decode_varint32(stream, &temp); memcpy(dest, &temp, field->data_size); return status; } -bool pb_dec_float(pb_istream_t *stream, const pb_field_t *field, void *dest) +bool pb_dec_float(pb_istream_t *stream, const pb_field_t *field, float *dest) { return pb_read(stream, (uint8_t*)dest, sizeof(float)); } -bool pb_dec_double(pb_istream_t *stream, const pb_field_t *field, void *dest) +bool pb_dec_double(pb_istream_t *stream, const pb_field_t *field, double *dest) { return pb_read(stream, (uint8_t*)dest, sizeof(double)); } -bool pb_dec_bytes(pb_istream_t *stream, const pb_field_t *field, void *dest) +bool pb_dec_bytes(pb_istream_t *stream, const pb_field_t *field, uint8_t *dest) { pb_bytes_array_t *x = (pb_bytes_array_t*)dest; @@ -413,24 +434,25 @@ bool pb_dec_bytes(pb_istream_t *stream, const pb_field_t *field, void *dest) return false; x->size = temp; - // Note: data_size includes the size of the x.size field, too. - // Calculate actual size starting from offset. + /* Note: data_size includes the size of the x.size field, too. + * Calculate actual size starting from offset. */ if (x->size > field->data_size - offsetof(pb_bytes_array_t, bytes)) return false; return pb_read(stream, x->bytes, x->size); } -bool pb_dec_string(pb_istream_t *stream, const pb_field_t *field, void *dest) +bool pb_dec_string(pb_istream_t *stream, const pb_field_t *field, uint8_t *dest) { uint32_t size; + bool status; if (!pb_decode_varint32(stream, &size)) return false; if (size > field->data_size - 1) return false; - bool status = pb_read(stream, (uint8_t*)dest, size); + status = pb_read(stream, (uint8_t*)dest, size); *((uint8_t*)dest + size) = 0; return status; } diff --git a/pb_decode.h b/pb_decode.h index 2f689394..ac4d1f70 100644 --- a/pb_decode.h +++ b/pb_decode.h @@ -4,16 +4,35 @@ #include <stdbool.h> #include "pb.h" -// Decode from stream to destination struct. -// The actual struct pointed to by dest must match the description in fields. +/* Lightweight input stream. + * If buf is NULL, read but don't store bytes. + * You can to provide a callback function for reading or use + * pb_istream_from_buffer. + * + * You can use state to store your own data (e.g. buffer pointer), + * and rely on pb_read to verify that no-body reads past bytes_left. + * However, substreams may change bytes_left so don't use that to + * compute any pointers. + */ +struct _pb_istream_t +{ + bool (*callback)(pb_istream_t *stream, uint8_t *buf, size_t count); + void *state; /* Free field for use by callback implementation */ + size_t bytes_left; +}; + +pb_istream_t pb_istream_from_buffer(uint8_t *buf, size_t bufsize); +bool pb_read(pb_istream_t *stream, uint8_t *buf, size_t count); + +/* Decode from stream to destination struct. + * The actual struct pointed to by dest must match the description in fields. + */ bool pb_decode(pb_istream_t *stream, const pb_field_t fields[], void *dest_struct); /* --- Helper functions --- * You may want to use these from your caller or callbacks. */ -pb_istream_t pb_istream_from_buffer(uint8_t *buf, size_t bufsize); - bool pb_decode_varint32(pb_istream_t *stream, uint32_t *dest); bool pb_decode_varint64(pb_istream_t *stream, uint64_t *dest); @@ -26,20 +45,20 @@ bool pb_skip_string(pb_istream_t *stream); * For arrays, these functions are called repeatedly. */ -bool pb_dec_uint32(pb_istream_t *stream, const pb_field_t *field, void *dest); -bool pb_dec_sint32(pb_istream_t *stream, const pb_field_t *field, void *dest); -bool pb_dec_fixed32(pb_istream_t *stream, const pb_field_t *field, void *dest); -bool pb_dec_uint64(pb_istream_t *stream, const pb_field_t *field, void *dest); -bool pb_dec_sint64(pb_istream_t *stream, const pb_field_t *field, void *dest); -bool pb_dec_fixed64(pb_istream_t *stream, const pb_field_t *field, void *dest); -bool pb_dec_bool(pb_istream_t *stream, const pb_field_t *field, void *dest); +bool pb_dec_uint32(pb_istream_t *stream, const pb_field_t *field, uint32_t *dest); +bool pb_dec_sint32(pb_istream_t *stream, const pb_field_t *field, int32_t *dest); +bool pb_dec_fixed32(pb_istream_t *stream, const pb_field_t *field, uint32_t *dest); +bool pb_dec_uint64(pb_istream_t *stream, const pb_field_t *field, uint64_t *dest); +bool pb_dec_sint64(pb_istream_t *stream, const pb_field_t *field, int64_t *dest); +bool pb_dec_fixed64(pb_istream_t *stream, const pb_field_t *field, uint64_t *dest); +bool pb_dec_bool(pb_istream_t *stream, const pb_field_t *field, bool *dest); bool pb_dec_enum(pb_istream_t *stream, const pb_field_t *field, void *dest); -bool pb_dec_float(pb_istream_t *stream, const pb_field_t *field, void *dest); -bool pb_dec_double(pb_istream_t *stream, const pb_field_t *field, void *dest); +bool pb_dec_float(pb_istream_t *stream, const pb_field_t *field, float *dest); +bool pb_dec_double(pb_istream_t *stream, const pb_field_t *field, double *dest); -bool pb_dec_bytes(pb_istream_t *stream, const pb_field_t *field, void *dest); -bool pb_dec_string(pb_istream_t *stream, const pb_field_t *field, void *dest); +bool pb_dec_bytes(pb_istream_t *stream, const pb_field_t *field, uint8_t *dest); +bool pb_dec_string(pb_istream_t *stream, const pb_field_t *field, uint8_t *dest); bool pb_dec_submessage(pb_istream_t *stream, const pb_field_t *field, void *dest); typedef bool (*pb_decoder_t)(pb_istream_t *stream, const pb_field_t *field, void *dest); diff --git a/tests/Makefile b/tests/Makefile new file mode 100644 index 00000000..da4030e2 --- /dev/null +++ b/tests/Makefile @@ -0,0 +1,11 @@ +CFLAGS=-ansi -pedantic -Wall -I .. -g -O0 +DEPS=../pb_decode.c ../pb_decode.h ../pb.h + +all: test_decode1 + +clean: + rm -f test_decode1 + +test_decode1: test_decode1.c $(DEPS) + $(CC) $(CFLAGS) -o $@ $< ../pb_decode.c + diff --git a/tests/test_decode1.c b/tests/test_decode1.c index fbdb7db6..20ea65e4 100644 --- a/tests/test_decode1.c +++ b/tests/test_decode1.c @@ -8,7 +8,7 @@ typedef enum { Person_PhoneType_MOBILE = 0, Person_PhoneType_HOME = 1, - Person_PhoneType_WORK = 2, + Person_PhoneType_WORK = 2 } Person_PhoneType; typedef struct { |