Compare commits

..

3 Commits

Author SHA1 Message Date
Petteri Aimonen
62bbe46a45 Publishing nanopb-0.1.9.1 2014-09-11 18:58:16 +03:00
Petteri Aimonen
411db5b450 Update changelog 2014-09-11 18:55:42 +03:00
Petteri Aimonen
29479a7cca Protect against size_t overflows in pb_dec_bytes/pb_dec_string.
Possible consequences of bug:
1) Denial of service by causing a crash
   Possible when all of the following apply:
      - Untrusted data is passed to pb_decode()
      - The top-level message contains a static string field as the first field.
   Causes a single write of '0' byte to 1 byte before the message struct.

2) Remote code execution
   Possible when all of the following apply:
      - 64-bit platform
      - The message or a submessage contains a static string field.
      - Decoding directly from a custom pb_istream_t
      - bytes_left on the stream is set to larger than 4 GB
   Causes a write of up to 4 GB of data past the string field.

--

Detailed analysis follows

In the following consideration, I define "platform bitness" as equal to
number of bits in size_t datatype. Therefore most 8-bit platforms are
regarded as 16-bit for the purposes of this discussion.

1. The overflow in pb_dec_string

The overflow happens in this computation:

uint32_t size;
size_t alloc_size;
alloc_size = size + 1;

There are two ways in which the overflow can occur: In the uint32_t
addition, or in the cast to size_t. This depends on the platform
bitness.

On 32- and 64-bit platforms, the size has to be UINT32_MAX for the
overflow to occur. In that case alloc_size will be 0.

On 16-bit platforms, overflow will happen whenever size is more than
UINT16_MAX, and resulting alloc_size is attacker controlled.

For static fields, the alloc_size value is just checked against the
field data size. For pointer fields, the alloc_size value is passed to
malloc(). End result in both cases is the same, the storage is 0 or
just a few bytes in length.

On 16-bit platforms, another overflow occurs in the call to pb_read(),
when passing the original size. An attacker will want the passed value
to be larger than the alloc_size, therefore the only reasonable choice
is to have size = UINT16_MAX and alloc_size = 0. Any larger multiple
will truncate to the same values.

At this point we have read atleast the tag and the string length of the
message, i.e. atleast 3 bytes. The maximum initial value for stream
bytes_left is SIZE_MAX, thus at this point at most SIZE_MAX-3 bytes are
remaining.

On 32-bit and 16-bit platforms this means that the size passed to
pb_read() is always larger than the number of remaining bytes. This
causes pb_read() to fail immediately, before reading any bytes.

On 64-bit platforms, it is possible for the bytes_left value to be set
to a value larger than UINT32_MAX, which is the wraparound point in
size calculation. In this case pb_read() will succeed and write up to 4
GB of attacker controlled data over the RAM that comes after the string
field.

On all platforms, there is an unconditional write of a terminating null
byte. Because the size of size_t typically reflects the size of the
processor address space, a write at UINT16_MAX or UINT32_MAX bytes
after the string field actually wraps back to before the string field.
Consequently, on 32-bit and 16-bit platforms, the bug causes a single
write of '0' byte at one byte before the string field.

If the string field is in the middle of a message, this will just
corrupt other data in the message struct. Because the message contents
is attacker controlled anyway, this is a non-issue. However, if the
string field is the first field in the top-level message, it can
corrupt other data on the stack/heap before it. Typically a single '0'
write at a location not controlled by attacker is enough only for a
denial-of-service attack.

When using pointer fields and malloc(), the attacker controlled
alloc_size will cause a 0-size allocation to happen. By the same logic
as before, on 32-bit and 16-bit platforms this causes a '0' byte write
only. On 64-bit platforms, however, it will again allow up to 4 GB of
malicious data to be written over memory, if the stream length allows
the read.

2. The overflow in pb_dec_bytes

This overflow happens in the PB_BYTES_ARRAY_T_ALLOCSIZE macro:

The computation is done in size_t data type this time. This means that
an overflow is possible only when n is larger than SIZE_MAX -
offsetof(..). The offsetof value in this case is equal to
sizeof(pb_size_t) bytes.

Because the incoming size value is limited to 32 bits, no overflow can
happen here on 64-bit platforms.

The size will be passed to pb_read(). Like before, on 32-bit and 16-bit
platforms the read will always fail before writing anything.

This leaves only the write of bdest->size as exploitable. On statically
allocated fields, the size field will always be allocated, regardless
of alloc_size. In this case, no buffer overflow is possible here, but
user code could possibly use the attacker controlled size value and
read past a buffer.

If the field is allocated through malloc(), this will allow a write of
sizeof(pb_size_t) attacker controlled bytes to past a 0-byte long
buffer. In typical malloc implementations, this will either fit in
unused alignment padding area, or cause a heap corruption and a crash.
Under very exceptional situation it could allow attacker to influence
the behaviour of malloc(), possibly jumping into an attacker-controlled
location and thus leading to remote code execution.
2014-09-08 18:35:50 +03:00
37 changed files with 931 additions and 2089 deletions

39
.gitignore vendored
View File

@@ -1,39 +0,0 @@
*.gcda
*.gcno
*.gcov
*.o
*.pb.c
*.pb.h
*.pb
*~
*.tar.gz
julkaisu.txt
docs/*.html
docs/generator_flow.png
example/client
example/server
example_avr_double/decode_double
example_avr_double/encode_double
example_avr_double/test_conversions
example_unions/decode
example_unions/encode
generator/nanopb_pb2.pyc
tests/decode_unittests
tests/encode_unittests
tests/test_compiles
tests/test_decode1
tests/test_decode2
tests/test_decode3
tests/test_decode3_buf
tests/test_decode_callbacks
tests/test_encode1
tests/test_encode2
tests/test_encode3
tests/test_encode3_buf
tests/test_encode_callbacks
tests/test_missing_fields
tests/test_multiple_files
tests/bc_decode
tests/bc_encode
tests/breakpoints

View File

@@ -1,32 +1,8 @@
nanopb-0.2.1 nanopb-0.1.9.1
NOTE: The default callback function signature has changed. Fix security issue due to size_t overflows. (issue 132)
If you don't want to update your code, define PB_OLD_CALLBACK_STYLE.
Change the callback function to use void** (issue 69)
Add support for defining the nanopb options in a separate file (issue 12)
Add support for packed structs in IAR and MSVC (in addition to GCC) (issue 66)
Implement error message support for the encoder side (issue 7)
Handle unterminated strings when encoding (issue 68)
Fix bug with empty strings in repeated string callbacks (issue 73)
Fix regression in 0.2.0 with optional callback fields (issue 70)
Fix bugs with empty message types (issues 64, 65)
Fix some compiler warnings on clang (issue 67)
Some portability improvements (issues 60, 62)
Various new generator options
Improved tests
nanopb-0.2.0 NOTE: nanopb-0.1.x is and will remain affected by issue 97.
NOTE: This release requires you to regenerate all .pb.c A fix would be too intrusive for a support release.
files. Files generated by older versions will not
compile anymore.
Reformat generated .pb.c files using macros (issue 58)
Rename PB_HTYPE_ARRAY -> PB_HTYPE_REPEATED
Separate PB_HTYPE to PB_ATYPE and PB_HTYPE
Move STATIC_ASSERTs to .pb.c file
Added CMake file (by Pavel Ilin)
Add option to give file extension to generator (by Michael Haberler)
Documentation updates
nanopb-0.1.9 nanopb-0.1.9
Fixed error message bugs (issues 52, 56) Fixed error message bugs (issues 52, 56)

View File

@@ -1,224 +0,0 @@
# Locate and configure the nanopb library.
#
# The following varialbes have to be set:
#
# NANOPB_SRC_ROOT_FOLDER - Path to nanopb source folder
#
# The following variables can be set and are optional:
#
#
# PROTOBUF_SRC_ROOT_FOLDER - When compiling with MSVC, if this cache variable is set
# the protobuf-default VS project build locations
# (vsprojects/Debug & vsprojects/Release) will be searched
# for libraries and binaries.
#
# NANOPB_IMPORT_DIRS - List of additional directories to be searched for
# imported .proto files.
#
# NANOPB_GENERATE_CPP_APPEND_PATH - By default -I will be passed to protoc
# for each directory where a proto file is referenced.
# Set to FALSE if you want to disable this behaviour.
#
# Defines the following variables:
#
# NANOPB_FOUND - Found the nanopb library (source&header files, generator tool, protoc compiler tool)
# NANOPB_INCLUDE_DIRS - Include directories for Google Protocol Buffers
#
# The following cache variables are also available to set or use:
# NANOPB_GENERATOR_EXECUTABLE - The nanopb generator
# PROTOBUF_PROTOC_EXECUTABLE - The protoc compiler
#
# ====================================================================
#
# NANOPB_GENERATE_CPP (public function)
# SRCS = Variable to define with autogenerated
# source files
# HDRS = Variable to define with autogenerated
# header files
# ARGN = proto files
#
# ====================================================================
# Example:
#
# set(NANOPB_SRC_ROOT_FOLDER "/path/to/nanopb")
# set(CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH} ${NANOPB_SRC_ROOT_FOLDER}/cmake)
# find_package( Nanopb REQUIRED )
# include_directories(${NANOPB_INCLUDE_DIRS})
#
# NANOPB_GENERATE_CPP(PROTO_SRCS PROTO_HDRS foo.proto)
#
# include_directories(${CMAKE_CURRENT_BINARY_DIR})
# add_executable(bar bar.cc ${PROTO_SRCS} ${PROTO_HDRS})
#
# ====================================================================
#=============================================================================
# Copyright 2009 Kitware, Inc.
# Copyright 2009-2011 Philip Lowman <philip@yhbt.com>
# Copyright 2008 Esben Mose Hansen, Ange Optimization ApS
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions
# are met:
#
# * Redistributions of source code must retain the above copyright
# notice, this list of conditions and the following disclaimer.
#
# * Redistributions in binary form must reproduce the above copyright
# notice, this list of conditions and the following disclaimer in the
# documentation and/or other materials provided with the distribution.
#
# * Neither the names of Kitware, Inc., the Insight Software Consortium,
# nor the names of their contributors may be used to endorse or promote
# products derived from this software without specific prior written
# permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
# HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
#
#=============================================================================
#
# Changes
# 2013.01.31 - Pavlo Ilin - used Modules/FindProtobuf.cmake from cmake 2.8.10 to
# write FindNanopb.cmake
#
#=============================================================================
function(NANOPB_GENERATE_CPP SRCS HDRS)
if(NOT ARGN)
return()
endif()
if(NANOPB_GENERATE_CPP_APPEND_PATH)
# Create an include path for each file specified
foreach(FIL ${ARGN})
get_filename_component(ABS_FIL ${FIL} ABSOLUTE)
get_filename_component(ABS_PATH ${ABS_FIL} PATH)
list(FIND _nanobp_include_path ${ABS_PATH} _contains_already)
if(${_contains_already} EQUAL -1)
list(APPEND _nanobp_include_path -I ${ABS_PATH})
endif()
endforeach()
else()
set(_nanobp_include_path -I ${CMAKE_CURRENT_SOURCE_DIR})
endif()
if(DEFINED NANOPB_IMPORT_DIRS)
foreach(DIR ${NANOPB_IMPORT_DIRS})
get_filename_component(ABS_PATH ${DIR} ABSOLUTE)
list(FIND _nanobp_include_path ${ABS_PATH} _contains_already)
if(${_contains_already} EQUAL -1)
list(APPEND _nanobp_include_path -I ${ABS_PATH})
endif()
endforeach()
endif()
set(${SRCS})
set(${HDRS})
get_filename_component(GENERATOR_PATH ${NANOPB_GENERATOR_EXECUTABLE} PATH)
foreach(FIL ${ARGN})
get_filename_component(ABS_FIL ${FIL} ABSOLUTE)
get_filename_component(FIL_WE ${FIL} NAME_WE)
list(APPEND ${SRCS} "${CMAKE_CURRENT_BINARY_DIR}/${FIL_WE}.pb.c")
list(APPEND ${HDRS} "${CMAKE_CURRENT_BINARY_DIR}/${FIL_WE}.pb.h")
add_custom_command(
OUTPUT "${CMAKE_CURRENT_BINARY_DIR}/${FIL_WE}.pb"
COMMAND ${PROTOBUF_PROTOC_EXECUTABLE}
ARGS -I${GENERATOR_PATH} -I${CMAKE_CURRENT_BINARY_DIR} ${_nanobp_include_path} -o${FIL_WE}.pb ${ABS_FIL}
DEPENDS ${ABS_FIL}
COMMENT "Running C++ protocol buffer compiler on ${FIL}"
VERBATIM )
add_custom_command(
OUTPUT "${CMAKE_CURRENT_BINARY_DIR}/${FIL_WE}.pb.c"
"${CMAKE_CURRENT_BINARY_DIR}/${FIL_WE}.pb.h"
COMMAND python
ARGS ${NANOPB_GENERATOR_EXECUTABLE} ${FIL_WE}.pb
DEPENDS ${FIL_WE}.pb
COMMENT "Running nanopb generator on ${FIL_WE}.pb"
VERBATIM )
endforeach()
set_source_files_properties(${${SRCS}} ${${HDRS}} PROPERTIES GENERATED TRUE)
set(${SRCS} ${${SRCS}} ${NANOPB_SRCS} PARENT_SCOPE)
set(${HDRS} ${${HDRS}} ${NANOPB_HDRS} PARENT_SCOPE)
endfunction()
#
# Main.
#
# By default have NANOPB_GENERATE_CPP macro pass -I to protoc
# for each directory where a proto file is referenced.
if(NOT DEFINED NANOPB_GENERATE_CPP_APPEND_PATH)
set(NANOPB_GENERATE_CPP_APPEND_PATH TRUE)
endif()
# Find the include directory
find_path(NANOPB_INCLUDE_DIRS
pb.h
PATHS ${NANOPB_SRC_ROOT_FOLDER}
)
mark_as_advanced(NANOPB_INCLUDE_DIRS)
# Find nanopb source files
set(NANOPB_SRCS)
set(NANOPB_HDRS)
list(APPEND _nanopb_srcs pb_decode.c pb_encode.c)
list(APPEND _nanopb_hdrs pb_decode.h pb_encode.h pb.h)
foreach(FIL ${_nanopb_srcs})
find_file(${FIL}__nano_pb_file NAMES ${FIL} PATHS ${NANOPB_SRC_ROOT_FOLDER} ${NANOPB_INCLUDE_DIRS})
list(APPEND NANOPB_SRCS "${${FIL}__nano_pb_file}")
mark_as_advanced(${FIL}__nano_pb_file)
endforeach()
foreach(FIL ${_nanopb_hdrs})
find_file(${FIL}__nano_pb_file NAMES ${FIL} PATHS ${NANOPB_INCLUDE_DIRS})
mark_as_advanced(${FIL}__nano_pb_file)
list(APPEND NANOPB_HDRS "${${FIL}__nano_pb_file}")
endforeach()
# Find the protoc Executable
find_program(PROTOBUF_PROTOC_EXECUTABLE
NAMES protoc
DOC "The Google Protocol Buffers Compiler"
PATHS
${PROTOBUF_SRC_ROOT_FOLDER}/vsprojects/Release
${PROTOBUF_SRC_ROOT_FOLDER}/vsprojects/Debug
)
mark_as_advanced(PROTOBUF_PROTOC_EXECUTABLE)
# Find nanopb generator
find_file(NANOPB_GENERATOR_EXECUTABLE
NAMES nanopb_generator.py
DOC "nanopb generator"
PATHS
${NANOPB_SRC_ROOT_FOLDER}/generator
)
mark_as_advanced(NANOPB_GENERATOR_EXECUTABLE)
include(FindPackageHandleStandardArgs)
FIND_PACKAGE_HANDLE_STANDARD_ARGS(NANOPB DEFAULT_MSG
NANOPB_INCLUDE_DIRS
NANOPB_SRCS NANOPB_HDRS
NANOPB_GENERATOR_EXECUTABLE
PROTOBUF_PROTOC_EXECUTABLE
)

View File

@@ -10,40 +10,47 @@ The things outlined here are the underlying concepts of the nanopb design.
Proto files Proto files
=========== ===========
All Protocol Buffers implementations use .proto files to describe the message All Protocol Buffers implementations use .proto files to describe the message format.
format. The point of these files is to be a portable interface description The point of these files is to be a portable interface description language.
language.
Compiling .proto files for nanopb Compiling .proto files for nanopb
--------------------------------- ---------------------------------
Nanopb uses the Google's protoc compiler to parse the .proto file, and then a Nanopb uses the Google's protoc compiler to parse the .proto file, and then a python script to generate the C header and source code from it::
python script to generate the C header and source code from it::
user@host:~$ protoc -omessage.pb message.proto user@host:~$ protoc -omessage.pb message.proto
user@host:~$ python ../generator/nanopb_generator.py message.pb user@host:~$ python ../generator/nanopb_generator.py message.pb
Writing to message.h and message.c Writing to message.h and message.c
user@host:~$ user@host:~$
Modifying generator behaviour Compiling .proto files with nanopb options
----------------------------- ------------------------------------------
Using generator options, you can set maximum sizes for fields in order to Nanopb defines two extensions for message fields described in .proto files: *max_size* and *max_count*.
allocate them statically. The preferred way to do this is to create an .options These are the maximum size of a string and maximum count of items in an array::
file with the same name as your .proto file::
# Foo.proto required string name = 1 [(nanopb).max_size = 40];
message Foo { repeated PhoneNumber phone = 4 [(nanopb).max_count = 5];
required string name = 1;
}
:: To use these extensions, you need to place an import statement in the beginning of the file::
# Foo.options import "nanopb.proto";
Foo.name max_size:16
For more information on this, see the `Proto file options`_ section in the This file, in turn, requires the file *google/protobuf/descriptor.proto*. This is usually installed under */usr/include*. Therefore, to compile a .proto file which uses options, use a protoc command similar to::
reference manual.
protoc -I/usr/include -Inanopb/generator -I. -omessage.pb message.proto
The options can be defined in file, message and field scopes::
option (nanopb_fileopt).max_size = 20; // File scope
message Message
{
option (nanopb_msgopt).max_size = 30; // Message scope
required string fieldsize = 1 [(nanopb).max_size = 40]; // Field scope
}
It is also possible to give the options on command line, but then they will affect the whole file. For example::
user@host:~$ python ../generator/nanopb_generator.py -s 'max_size: 20' message.pb
.. _`Proto file options`: reference.html#proto-file-options
Streams Streams
======= =======
@@ -174,9 +181,7 @@ Field callbacks
=============== ===============
When a field has dynamic length, nanopb cannot statically allocate storage for it. Instead, it allows you to handle the field in whatever way you want, using a callback function. When a field has dynamic length, nanopb cannot statically allocate storage for it. Instead, it allows you to handle the field in whatever way you want, using a callback function.
The `pb_callback_t`_ structure contains a function pointer and a *void* pointer called *arg* you can use for passing data to the callback. If the function pointer is NULL, the field will be skipped. A pointer to the *arg* is passed to the function, so that it can modify it and retrieve the value. The `pb_callback_t`_ structure contains a function pointer and a *void* pointer you can use for passing data to the callback. If the function pointer is NULL, the field will be skipped. The actual behavior of the callback function is different in encoding and decoding modes.
The actual behavior of the callback function is different in encoding and decoding modes. In encoding mode, the callback is called once and should write out everything, including field tags. In decoding mode, the callback is called repeatedly for every data item.
.. _`pb_callback_t`: reference.html#pb-callback-t .. _`pb_callback_t`: reference.html#pb-callback-t
@@ -184,7 +189,7 @@ Encoding callbacks
------------------ ------------------
:: ::
bool (*encode)(pb_ostream_t *stream, const pb_field_t *field, void * const *arg); bool (*encode)(pb_ostream_t *stream, const pb_field_t *field, const void *arg);
When encoding, the callback should write out complete fields, including the wire type and field number tag. It can write as many or as few fields as it likes. For example, if you want to write out an array as *repeated* field, you should do it all in a single call. When encoding, the callback should write out complete fields, including the wire type and field number tag. It can write as many or as few fields as it likes. For example, if you want to write out an array as *repeated* field, you should do it all in a single call.
@@ -198,7 +203,7 @@ If the callback is used in a submessage, it will be called multiple times during
This callback writes out a dynamically sized string:: This callback writes out a dynamically sized string::
bool write_string(pb_ostream_t *stream, const pb_field_t *field, void * const *arg) bool write_string(pb_ostream_t *stream, const pb_field_t *field, const void *arg)
{ {
char *str = get_string_from_somewhere(); char *str = get_string_from_somewhere();
if (!pb_encode_tag_for_field(stream, field)) if (!pb_encode_tag_for_field(stream, field))
@@ -211,7 +216,7 @@ Decoding callbacks
------------------ ------------------
:: ::
bool (*decode)(pb_istream_t *stream, const pb_field_t *field, void **arg); bool (*decode)(pb_istream_t *stream, const pb_field_t *field, void *arg);
When decoding, the callback receives a length-limited substring that reads the contents of a single field. The field tag has already been read. For *string* and *bytes*, the length value has already been parsed, and is available at *stream->bytes_left*. When decoding, the callback receives a length-limited substring that reads the contents of a single field. The field tag has already been read. For *string* and *bytes*, the length value has already been parsed, and is available at *stream->bytes_left*.
@@ -221,7 +226,7 @@ The callback will be called multiple times for repeated fields. For packed field
This callback reads multiple integers and prints them:: This callback reads multiple integers and prints them::
bool read_ints(pb_istream_t *stream, const pb_field_t *field, void **arg) bool read_ints(pb_istream_t *stream, const pb_field_t *field, void *arg)
{ {
while (stream->bytes_left) while (stream->bytes_left)
{ {
@@ -250,8 +255,16 @@ For example this submessage in the Person.proto file::
generates this field description array for the structure *Person_PhoneNumber*:: generates this field description array for the structure *Person_PhoneNumber*::
const pb_field_t Person_PhoneNumber_fields[3] = { const pb_field_t Person_PhoneNumber_fields[3] = {
PB_FIELD( 1, STRING , REQUIRED, STATIC, Person_PhoneNumber, number, number, 0), {1, PB_HTYPE_REQUIRED | PB_LTYPE_STRING,
PB_FIELD( 2, ENUM , OPTIONAL, STATIC, Person_PhoneNumber, type, number, &Person_PhoneNumber_type_default), offsetof(Person_PhoneNumber, number), 0,
pb_membersize(Person_PhoneNumber, number), 0, 0},
{2, PB_HTYPE_OPTIONAL | PB_LTYPE_VARINT,
pb_delta(Person_PhoneNumber, type, number),
pb_delta(Person_PhoneNumber, has_type, type),
pb_membersize(Person_PhoneNumber, type), 0,
&Person_PhoneNumber_type_default},
PB_LAST_FIELD PB_LAST_FIELD
}; };
@@ -263,8 +276,8 @@ Most functions in nanopb return bool: *true* means success, *false* means failur
The error messages help in guessing what is the underlying cause of the error. The most common error conditions are: The error messages help in guessing what is the underlying cause of the error. The most common error conditions are:
1) Running out of memory, i.e. stack overflow. 1) Running out of memory. Because everything is allocated from the stack, nanopb can't detect this itself. Encoding or decoding the same type of a message always takes the same amount of stack space. Therefore, if it works once, it works always.
2) Invalid field descriptors (would usually mean a bug in the generator). 2) Invalid field description. These are usually stored as constants, so if it works under the debugger, it always does.
3) IO errors in your own stream callbacks. 3) IO errors in your own stream callbacks.
4) Errors that happen in your callback functions. 4) Errors that happen in your callback functions.
5) Exceeding the max_size or bytes_left of a stream. 5) Exceeding the max_size or bytes_left of a stream.

View File

@@ -36,26 +36,23 @@ Features and limitations
**Features** **Features**
#) Pure C runtime #) Pure C runtime
#) Small code size (210 kB depending on processor, plus any message definitions) #) Small code size (210 kB depending on processor)
#) Small ram usage (typically ~300 bytes, plus any message structs) #) Small ram usage (typically 200 bytes)
#) Allows specifying maximum size for strings and arrays, so that they can be allocated statically. #) Allows specifying maximum size for strings and arrays, so that they can be allocated statically.
#) No malloc needed: everything can be allocated statically or on the stack. #) No malloc needed: everything can be allocated statically or on the stack.
#) You can use either encoder or decoder alone to cut the code size in half. #) You can use either encoder or decoder alone to cut the code size in half.
#) Support for most protobuf features, including: all data types, nested submessages, default values, repeated and optional fields, packed arrays.
#) Callback mechanism for handling messages larger than can fit in available RAM.
#) Extensive set of tests.
**Limitations** **Limitations**
#) User must provide callbacks when decoding arrays or strings without maximum size. Malloc support could be added as a separate module. #) User must provide callbacks when decoding arrays or strings without maximum size. Malloc support could be added as a separate module.
#) Some speed has been sacrificed for code size. #) Some speed has been sacrificed for code size. For example varint calculations are always done in 64 bits.
#) Encoding is focused on writing to streams. For memory buffers only it could be made more efficient. #) Encoding is focused on writing to streams. For memory buffers only it could be made more efficient.
#) The deprecated Protocol Buffers feature called "groups" is not supported. #) The deprecated Protocol Buffers feature called "groups" is not supported.
#) Fields in the generated structs are ordered by the tag number, instead of the natural ordering in .proto file. #) Fields in the generated structs are ordered by the tag number, instead of the natural ordering in .proto file.
#) Unknown fields are not preserved when decoding and re-encoding a message. #) Unknown fields are not preserved when decoding and re-encoding a message.
#) Reflection (runtime introspection) is not supported. E.g. you can't request a field by giving its name in a string. #) Reflection (runtime introspection) is not supported. E.g. you can't request a field by giving its name in a string.
#) Numeric arrays are always encoded as packed, even if not marked as packed in .proto. This causes incompatibility with decoders that do not support packed format. #) Numeric arrays are always encoded as packed, even if not marked as packed in .proto. This causes incompatibility with decoders that do not support packed format.
#) Cyclic references between messages are supported only in callback mode. #) Cyclic references between messages are not supported. They could be supported in callback-mode if there was an option in the generator to set the mode.
Getting started Getting started
=============== ===============
@@ -107,3 +104,10 @@ Debugging and testing
===================== =====================
Extensive unittests are included under the *tests* folder. Just type *make* there to run the tests. Extensive unittests are included under the *tests* folder. Just type *make* there to run the tests.
This also generates a file called *breakpoints* which includes all lines returning *false* in nanopb. You can use this in gdb by typing *source breakpoints*, after which gdb will break on first nanopb error.
Wishlist
========
#) A specialized encoder for encoding to a memory buffer. Should serialize in reverse order to avoid having to determine submessage size beforehand.
#) A cleaner rewrite of the Python-based source generator.
#) Better performance for 16- and 8-bit platforms: use smaller datatypes where possible.

View File

@@ -6,182 +6,29 @@ Nanopb: API reference
.. contents :: .. contents ::
Compilation options Compilation options
=================== ===================
The following options can be specified in one of two ways: The following options can be specified using -D switch given to the C compiler:
1. Using the -D switch on the C compiler command line.
2. By #defining them at the top of pb.h.
You must have the same settings for the nanopb library and all code that
includes pb.h.
============================ ================================================
__BIG_ENDIAN__ Set this if your platform stores integers and
floats in big-endian format. Mixed-endian
systems (different layout for ints and floats)
are currently not supported.
NANOPB_INTERNALS Set this to expose the field encoder functions
that are hidden since nanopb-0.1.3.
PB_MAX_REQUIRED_FIELDS Maximum number of required fields to check for
presence. Default value is 64. Increases stack
usage 1 byte per every 8 fields. Compiler
warning will tell if you need this.
PB_FIELD_16BIT Add support for tag numbers > 255 and fields
larger than 255 bytes or 255 array entries.
Increases code size 3 bytes per each field.
Compiler error will tell if you need this.
PB_FIELD_32BIT Add support for tag numbers > 65535 and fields
larger than 65535 bytes or 65535 array entries.
Increases code size 9 bytes per each field.
Compiler error will tell if you need this.
PB_NO_ERRMSG Disables the support for error messages; only
error information is the true/false return
value. Decreases the code size by a few hundred
bytes.
PB_BUFFER_ONLY Disables the support for custom streams. Only
supports encoding and decoding with memory
buffers. Speeds up execution and decreases code
size slightly.
PB_OLD_CALLBACK_STYLE Use the old function signature (void\* instead
of void\*\*) for callback fields. This was the
default until nanopb-0.2.1.
============================ ================================================
The PB_MAX_REQUIRED_FIELDS, PB_FIELD_16BIT and PB_FIELD_32BIT settings allow
raising some datatype limits to suit larger messages. Their need is recognized
automatically by C-preprocessor #if-directives in the generated .pb.h files.
The default setting is to use the smallest datatypes (least resources used).
Proto file options
==================
The generator behaviour can be adjusted using these options, defined in the
'nanopb.proto' file in the generator folder:
============================ ================================================
max_size Allocated size for *bytes* and *string* fields.
max_count Allocated number of entries in arrays
(*repeated* fields).
type Type of the generated field. Default value
is *FT_DEFAULT*, which selects automatically.
You can use *FT_CALLBACK*, *FT_STATIC* or
*FT_IGNORE* to force a callback field, a static
field or to completely ignore the field.
long_names Prefix the enum name to the enum value in
definitions, i.e. *EnumName_EnumValue*. Enabled
by default.
packed_struct Make the generated structures packed.
NOTE: This cannot be used on CPUs that break
on unaligned accesses to variables.
============================ ================================================
These options can be defined for the .proto files before they are converted
using the nanopb-generatory.py. There are three ways to define the options:
1. Using a separate .options file.
This is the preferred way as of nanopb-0.2.1, because it has the best
compatibility with other protobuf libraries.
2. Defining the options on the command line of nanopb_generator.py.
This only makes sense for settings that apply to a whole file.
3. Defining the options in the .proto file using the nanopb extensions.
This is the way used in nanopb-0.1, and will remain supported in the
future. It however sometimes causes trouble when using the .proto file
with other protobuf libraries.
The effect of the options is the same no matter how they are given. The most
common purpose is to define maximum size for string fields in order to
statically allocate them.
Defining the options in a .options file
---------------------------------------
The preferred way to define options is to have a separate file
'myproto.options' in the same directory as the 'myproto.proto'. ::
# myproto.proto
message MyMessage {
required string name = 1;
repeated int32 ids = 4;
}
::
# myproto.options
MyMessage.name max_size:40
MyMessage.ids max_count:5
The generator will automatically search for this file and read the
options from it. The file format is as follows:
* Lines starting with '#' or '//' are regarded as comments.
* Blank lines are ignored.
* All other lines should start with a field name pattern, followed by one or
more options. For example: *"MyMessage.myfield max_size:5 max_count:10"*.
* The field name pattern is matched against a string of form *'Message.field'*.
For nested messages, the string is *'Message.SubMessage.field'*.
* The field name pattern may use the notation recognized by Python fnmatch():
- *\** matches any part of string, like 'Message.\*' for all fields
- *\?* matches any single character
- *[seq]* matches any of characters 's', 'e' and 'q'
- *[!seq]* matches any other character
* The options are written as *'option_name:option_value'* and several options
can be defined on same line, separated by whitespace.
* Options defined later in the file override the ones specified earlier, so
it makes sense to define wildcard options first in the file and more specific
ones later.
If preferred, the name of the options file can be set using the command line
switch *-f* to nanopb_generator.py.
Defining the options on command line
------------------------------------
The nanopb_generator.py has a simple command line option *-s OPTION:VALUE*.
The setting applies to the whole file that is being processed.
Defining the options in the .proto file
---------------------------------------
The .proto file format allows defining custom options for the fields.
The nanopb library comes with *nanopb.proto* which does exactly that, allowing
you do define the options directly in the .proto file::
import "nanopb.proto";
message MyMessage {
required string name = 1 [(nanopb).max_size = 40];
repeated int32 ids = 4 [(nanopb).max_count = 5];
}
A small complication is that you have to set the include path of protoc so that
nanopb.proto can be found. This file, in turn, requires the file
*google/protobuf/descriptor.proto*. This is usually installed under
*/usr/include*. Therefore, to compile a .proto file which uses options, use a
protoc command similar to::
protoc -I/usr/include -Inanopb/generator -I. -omessage.pb message.proto
The options can be defined in file, message and field scopes::
option (nanopb_fileopt).max_size = 20; // File scope
message Message
{
option (nanopb_msgopt).max_size = 30; // Message scope
required string fieldsize = 1 [(nanopb).max_size = 40]; // Field scope
}
============================ ================================================================================================
__BIG_ENDIAN__ Set this if your platform stores integers and floats in big-endian format.
Mixed-endian systems (different layout for ints and floats) are currently not supported.
NANOPB_INTERNALS Set this to expose the field encoder functions that are hidden since nanopb-0.1.3.
PB_MAX_REQUIRED_FIELDS Maximum number of required fields to check for presence. Default value is 64. Increases stack
usage 1 byte per every 8 fields. Compiler warning will tell if you need this.
PB_FIELD_16BIT Add support for tag numbers > 255 and fields larger than 255 bytes or 255 array entries.
Increases code size 3 bytes per each field. Compiler error will tell if you need this.
PB_FIELD_32BIT Add support for tag numbers > 65535 and fields larger than 65535 bytes or 65535 array entries.
Increases code size 9 bytes per each field. Compiler error will tell if you need this.
PB_NO_ERRMSG Disables the support for error messages; only error information is the true/false return value.
Decreases the code size by a few hundred bytes.
PB_BUFFER_ONLY Disables the support for custom streams. Only supports encoding to memory buffers.
Speeds up execution and decreases code size slightly.
============================ ================================================================================================
The PB_MAX_REQUIRED_FIELDS, PB_FIELD_16BIT and PB_FIELD_32BIT settings allow raising some datatype limits to suit larger messages.
Their need is recognized automatically by C-preprocessor #if-directives in the generated .pb.h files. The default setting is to use
the smallest datatypes (least resources used).
pb.h pb.h
==== ====
@@ -190,23 +37,22 @@ pb_type_t
--------- ---------
Defines the encoder/decoder behaviour that should be used for a field. :: Defines the encoder/decoder behaviour that should be used for a field. ::
typedef uint8_t pb_type_t; typedef enum { ... } pb_type_t;
The low-order nibble of the enumeration values defines the function that can be used for encoding and decoding the field data: The low-order byte of the enumeration values defines the function that can be used for encoding and decoding the field data:
==================== ===== ================================================ ==================== ===== ================================================
LTYPE identifier Value Storage format LTYPE identifier Value Storage format
==================== ===== ================================================ ==================== ===== ================================================
PB_LTYPE_VARINT 0x00 Integer. PB_LTYPE_VARINT 0x00 Integer.
PB_LTYPE_SVARINT 0x01 Integer, zigzag encoded. PB_LTYPE_SVARINT 0x01 Integer, zigzag encoded.
PB_LTYPE_FIXED32 0x02 32-bit integer or floating point. PB_LTYPE_FIXED 0x02 Integer or floating point.
PB_LTYPE_FIXED64 0x03 64-bit integer or floating point. PB_LTYPE_BYTES 0x03 Structure with *size_t* field and byte array.
PB_LTYPE_BYTES 0x04 Structure with *size_t* field and byte array. PB_LTYPE_STRING 0x04 Null-terminated string.
PB_LTYPE_STRING 0x05 Null-terminated string. PB_LTYPE_SUBMESSAGE 0x05 Submessage structure.
PB_LTYPE_SUBMESSAGE 0x06 Submessage structure.
==================== ===== ================================================ ==================== ===== ================================================
The bits 4-5 define whether the field is required, optional or repeated: The high-order byte defines whether the field is required, optional, repeated or callback:
==================== ===== ================================================ ==================== ===== ================================================
HTYPE identifier Value Field handling HTYPE identifier Value Field handling
@@ -214,24 +60,13 @@ HTYPE identifier Value Field handling
PB_HTYPE_REQUIRED 0x00 Verify that field exists in decoded message. PB_HTYPE_REQUIRED 0x00 Verify that field exists in decoded message.
PB_HTYPE_OPTIONAL 0x10 Use separate *has_<field>* boolean to specify PB_HTYPE_OPTIONAL 0x10 Use separate *has_<field>* boolean to specify
whether the field is present. whether the field is present.
(Unless it is a callback) PB_HTYPE_ARRAY 0x20 A repeated field with preallocated array.
PB_HTYPE_REPEATED 0x20 A repeated field with preallocated array.
Separate *<field>_count* for number of items. Separate *<field>_count* for number of items.
(Unless it is a callback) PB_HTYPE_CALLBACK 0x30 A field with dynamic storage size, data is
actually a pointer to a structure containing a
callback function.
==================== ===== ================================================ ==================== ===== ================================================
The bits 6-7 define the how the storage for the field is allocated:
==================== ===== ================================================
ATYPE identifier Value Allocation method
==================== ===== ================================================
PB_ATYPE_STATIC 0x00 Statically allocated storage in the structure.
PB_ATYPE_CALLBACK 0x40 A field with dynamic storage size. Struct field
actually contains a pointer to a callback
function.
==================== ===== ================================================
pb_field_t pb_field_t
---------- ----------
Describes a single structure field with memory position in relation to others. The descriptions are usually autogenerated. :: Describes a single structure field with memory position in relation to others. The descriptions are usually autogenerated. ::
@@ -248,7 +83,7 @@ Describes a single structure field with memory position in relation to others. T
} pb_packed; } pb_packed;
:tag: Tag number of the field or 0 to terminate a list of fields. :tag: Tag number of the field or 0 to terminate a list of fields.
:type: LTYPE, HTYPE and ATYPE of the field. :type: LTYPE and HTYPE of the field.
:data_offset: Offset of field data, relative to the end of the previous field. :data_offset: Offset of field data, relative to the end of the previous field.
:size_offset: Offset of *bool* flag for optional fields or *size_t* count for arrays, relative to field data. :size_offset: Offset of *bool* flag for optional fields or *size_t* count for arrays, relative to field data.
:data_size: Size of a single data entry, in bytes. For PB_LTYPE_BYTES, the size of the byte array inside the containing structure. For PB_HTYPE_CALLBACK, size of the C data type if known. :data_size: Size of a single data entry, in bytes. For PB_LTYPE_BYTES, the size of the byte array inside the containing structure. For PB_HTYPE_CALLBACK, size of the C data type if known.
@@ -275,16 +110,14 @@ Part of a message structure, for fields with type PB_HTYPE_CALLBACK::
typedef struct _pb_callback_t pb_callback_t; typedef struct _pb_callback_t pb_callback_t;
struct _pb_callback_t { struct _pb_callback_t {
union { union {
bool (*decode)(pb_istream_t *stream, const pb_field_t *field, void **arg); bool (*decode)(pb_istream_t *stream, const pb_field_t *field, void *arg);
bool (*encode)(pb_ostream_t *stream, const pb_field_t *field, void * const *arg); bool (*encode)(pb_ostream_t *stream, const pb_field_t *field, const void *arg);
} funcs; } funcs;
void *arg; void *arg;
}; };
A pointer to the *arg* is passed to the callback when calling. It can be used to store any information that the callback might need. The *arg* is passed to the callback when calling. It can be used to store any information that the callback might need.
Previously the function received just the value of *arg* instead of a pointer to it. This old behaviour can be enabled by defining *PB_OLD_CALLBACK_STYLE*.
When calling `pb_encode`_, *funcs.encode* is used, and similarly when calling `pb_decode`_, *funcs.decode* is used. The function pointers are stored in the same memory location but are of incompatible types. You can set the function pointer to NULL to skip the field. When calling `pb_encode`_, *funcs.encode* is used, and similarly when calling `pb_decode`_, *funcs.decode* is used. The function pointers are stored in the same memory location but are of incompatible types. You can set the function pointer to NULL to skip the field.
@@ -299,41 +132,6 @@ Protocol Buffers wire types. These are used with `pb_encode_tag`_. ::
PB_WT_32BIT = 5 PB_WT_32BIT = 5
} pb_wire_type_t; } pb_wire_type_t;
PB_GET_ERROR
------------
Get the current error message from a stream, or a placeholder string if
there is no error message::
#define PB_GET_ERROR(stream) (string expression)
This should be used for printing errors, for example::
if (!pb_decode(...))
{
printf("Decode failed: %s\n", PB_GET_ERROR(stream));
}
The macro only returns pointers to constant strings (in code memory),
so that there is no need to release the returned pointer.
PB_RETURN_ERROR
---------------
Set the error message and return false::
#define PB_RETURN_ERROR(stream,msg) (sets error and returns false)
This should be used to handle error conditions inside nanopb functions
and user callback functions::
if (error_condition)
{
PB_RETURN_ERROR(stream, "something went wrong");
}
The *msg* parameter must be a constant string.
pb_encode.h pb_encode.h
=========== ===========
@@ -483,17 +281,6 @@ In Protocol Buffers format, the submessage size must be written before the subme
If the submessage contains callback fields, the callback function might misbehave and write out a different amount of data on the second call. This situation is recognized and *false* is returned, but garbage will be written to the output before the problem is detected. If the submessage contains callback fields, the callback function might misbehave and write out a different amount of data on the second call. This situation is recognized and *false* is returned, but garbage will be written to the output before the problem is detected.
pb_decode.h pb_decode.h
=========== ===========

View File

@@ -23,7 +23,7 @@
#include "fileproto.pb.h" #include "fileproto.pb.h"
#include "common.h" #include "common.h"
bool printfile_callback(pb_istream_t *stream, const pb_field_t *field, void **arg) bool printfile_callback(pb_istream_t *stream, const pb_field_t *field, void *arg)
{ {
FileInfo fileinfo; FileInfo fileinfo;

View File

@@ -1,13 +0,0 @@
# This file defines the nanopb-specific options for the messages defined
# in fileproto.proto.
#
# If you come from high-level programming background, the hardcoded
# maximum lengths may disgust you. However, if your microcontroller only
# has a few kB of ram to begin with, setting reasonable limits for
# filenames is ok.
#
# On the other hand, using the callback interface, it is not necessary
# to set a limit on the number of files in the response.
ListFilesRequest.path max_size:128
FileInfo.name max_size:128

View File

@@ -1,14 +1,22 @@
import "nanopb.proto";
// This defines protocol for a simple server that lists files. // This defines protocol for a simple server that lists files.
// //
// See also the nanopb-specific options in fileproto.options. // If you come from high-level programming background, the hardcoded
// maximum lengths may disgust you. However, if your microcontroller only
// has a few kB of ram to begin with, setting reasonable limits for
// filenames is ok.
//
// On the other hand, using the callback interface, it is not necessary
// to set a limit on the number of files in the response.
message ListFilesRequest { message ListFilesRequest {
optional string path = 1 [default = "/"]; optional string path = 1 [default = "/", (nanopb).max_size = 128];
} }
message FileInfo { message FileInfo {
required uint64 inode = 1; required uint64 inode = 1;
required string name = 2; required string name = 2 [(nanopb).max_size = 128];
} }
message ListFilesResponse { message ListFilesResponse {

View File

@@ -23,9 +23,9 @@
#include "fileproto.pb.h" #include "fileproto.pb.h"
#include "common.h" #include "common.h"
bool listdir_callback(pb_ostream_t *stream, const pb_field_t *field, void * const *arg) bool listdir_callback(pb_ostream_t *stream, const pb_field_t *field, const void *arg)
{ {
DIR *dir = (DIR*) *arg; DIR *dir = (DIR*) arg;
struct dirent *file; struct dirent *file;
FileInfo fileinfo; FileInfo fileinfo;

View File

@@ -16,9 +16,6 @@ enum FieldType {
FT_IGNORE = 3; // Ignore the field completely. FT_IGNORE = 3; // Ignore the field completely.
} }
// This is the inner options message, which basically defines options for
// a field. When it is used in message or file scope, it applies to all
// fields.
message NanoPBOptions { message NanoPBOptions {
// Allocated size for 'bytes' and 'string' fields. // Allocated size for 'bytes' and 'string' fields.
optional int32 max_size = 1; optional int32 max_size = 1;
@@ -33,14 +30,9 @@ message NanoPBOptions {
optional bool long_names = 4 [default = true]; optional bool long_names = 4 [default = true];
// Add 'packed' attribute to generated structs. // Add 'packed' attribute to generated structs.
// Note: this cannot be used on CPUs that break on unaligned
// accesses to variables.
optional bool packed_struct = 5 [default = false]; optional bool packed_struct = 5 [default = false];
} }
// Extensions to protoc 'Descriptor' type in order to define options
// inside a .proto file.
//
// Protocol Buffers extension number registry // Protocol Buffers extension number registry
// -------------------------------- // --------------------------------
// Project: Nanopb // Project: Nanopb

View File

@@ -1,9 +1,8 @@
'''Generate header file for nanopb from a ProtoBuf FileDescriptorSet.''' '''Generate header file for nanopb from a ProtoBuf FileDescriptorSet.'''
nanopb_version = "nanopb-0.2.2-dev" nanopb_version = "nanopb-0.1.9.1"
try: try:
import google.protobuf.descriptor_pb2 as descriptor import google.protobuf.descriptor_pb2 as descriptor
import google.protobuf.text_format as text_format
except: except:
print print
print "*************************************************************" print "*************************************************************"
@@ -36,26 +35,28 @@ except:
import time import time
import os.path import os.path
# Values are tuple (c type, pb type) # Values are tuple (c type, pb ltype)
FieldD = descriptor.FieldDescriptorProto FieldD = descriptor.FieldDescriptorProto
datatypes = { datatypes = {
FieldD.TYPE_BOOL: ('bool', 'BOOL'), FieldD.TYPE_BOOL: ('bool', 'PB_LTYPE_VARINT'),
FieldD.TYPE_DOUBLE: ('double', 'DOUBLE'), FieldD.TYPE_DOUBLE: ('double', 'PB_LTYPE_FIXED64'),
FieldD.TYPE_FIXED32: ('uint32_t', 'FIXED32'), FieldD.TYPE_FIXED32: ('uint32_t', 'PB_LTYPE_FIXED32'),
FieldD.TYPE_FIXED64: ('uint64_t', 'FIXED64'), FieldD.TYPE_FIXED64: ('uint64_t', 'PB_LTYPE_FIXED64'),
FieldD.TYPE_FLOAT: ('float', 'FLOAT'), FieldD.TYPE_FLOAT: ('float', 'PB_LTYPE_FIXED32'),
FieldD.TYPE_INT32: ('int32_t', 'INT32'), FieldD.TYPE_INT32: ('int32_t', 'PB_LTYPE_VARINT'),
FieldD.TYPE_INT64: ('int64_t', 'INT64'), FieldD.TYPE_INT64: ('int64_t', 'PB_LTYPE_VARINT'),
FieldD.TYPE_SFIXED32: ('int32_t', 'SFIXED32'), FieldD.TYPE_SFIXED32: ('int32_t', 'PB_LTYPE_FIXED32'),
FieldD.TYPE_SFIXED64: ('int64_t', 'SFIXED64'), FieldD.TYPE_SFIXED64: ('int64_t', 'PB_LTYPE_FIXED64'),
FieldD.TYPE_SINT32: ('int32_t', 'SINT32'), FieldD.TYPE_SINT32: ('int32_t', 'PB_LTYPE_SVARINT'),
FieldD.TYPE_SINT64: ('int64_t', 'SINT64'), FieldD.TYPE_SINT64: ('int64_t', 'PB_LTYPE_SVARINT'),
FieldD.TYPE_UINT32: ('uint32_t', 'UINT32'), FieldD.TYPE_UINT32: ('uint32_t', 'PB_LTYPE_VARINT'),
FieldD.TYPE_UINT64: ('uint64_t', 'UINT64') FieldD.TYPE_UINT64: ('uint64_t', 'PB_LTYPE_VARINT')
} }
class Names: class Names:
'''Keeps a set of nested names and formats them to C identifier.''' '''Keeps a set of nested names and formats them to C identifier.
You can subclass this with your own implementation.
'''
def __init__(self, parts = ()): def __init__(self, parts = ()):
if isinstance(parts, Names): if isinstance(parts, Names):
parts = parts.parts parts = parts.parts
@@ -122,44 +123,49 @@ class Field:
if desc.HasField('default_value'): if desc.HasField('default_value'):
self.default = desc.default_value self.default = desc.default_value
# Check field rules, i.e. required/optional/repeated. # Decide HTYPE
# HTYPE is the high-order nibble of nanopb field description,
# defining whether value is required/optional/repeated.
can_be_static = True can_be_static = True
if desc.label == FieldD.LABEL_REQUIRED: if desc.label == FieldD.LABEL_REQUIRED:
self.rules = 'REQUIRED' self.htype = 'PB_HTYPE_REQUIRED'
elif desc.label == FieldD.LABEL_OPTIONAL: elif desc.label == FieldD.LABEL_OPTIONAL:
self.rules = 'OPTIONAL' self.htype = 'PB_HTYPE_OPTIONAL'
elif desc.label == FieldD.LABEL_REPEATED: elif desc.label == FieldD.LABEL_REPEATED:
self.rules = 'REPEATED'
if self.max_count is None: if self.max_count is None:
can_be_static = False can_be_static = False
else: else:
self.htype = 'PB_HTYPE_ARRAY'
self.array_decl = '[%d]' % self.max_count self.array_decl = '[%d]' % self.max_count
else: else:
raise NotImplementedError(desc.label) raise NotImplementedError(desc.label)
# Decide the C data type to use in the struct. # Decide LTYPE and CTYPE
# LTYPE is the low-order nibble of nanopb field description,
# defining how to decode an individual value.
# CTYPE is the name of the c type to use in the struct.
if datatypes.has_key(desc.type): if datatypes.has_key(desc.type):
self.ctype, self.pbtype = datatypes[desc.type] self.ctype, self.ltype = datatypes[desc.type]
elif desc.type == FieldD.TYPE_ENUM: elif desc.type == FieldD.TYPE_ENUM:
self.pbtype = 'ENUM' self.ltype = 'PB_LTYPE_VARINT'
self.ctype = names_from_type_name(desc.type_name) self.ctype = names_from_type_name(desc.type_name)
if self.default is not None: if self.default is not None:
self.default = self.ctype + self.default self.default = self.ctype + self.default
elif desc.type == FieldD.TYPE_STRING: elif desc.type == FieldD.TYPE_STRING:
self.pbtype = 'STRING' self.ltype = 'PB_LTYPE_STRING'
if self.max_size is None: if self.max_size is None:
can_be_static = False can_be_static = False
else: else:
self.ctype = 'char' self.ctype = 'char'
self.array_decl += '[%d]' % self.max_size self.array_decl += '[%d]' % self.max_size
elif desc.type == FieldD.TYPE_BYTES: elif desc.type == FieldD.TYPE_BYTES:
self.pbtype = 'BYTES' self.ltype = 'PB_LTYPE_BYTES'
if self.max_size is None: if self.max_size is None:
can_be_static = False can_be_static = False
else: else:
self.ctype = self.struct_name + self.name + 't' self.ctype = self.struct_name + self.name + 't'
elif desc.type == FieldD.TYPE_MESSAGE: elif desc.type == FieldD.TYPE_MESSAGE:
self.pbtype = 'MESSAGE' self.ltype = 'PB_LTYPE_SUBMESSAGE'
self.ctype = self.submsgname = names_from_type_name(desc.type_name) self.ctype = self.submsgname = names_from_type_name(desc.type_name)
else: else:
raise NotImplementedError(desc.type) raise NotImplementedError(desc.type)
@@ -173,22 +179,18 @@ class Field:
if field_options.type == nanopb_pb2.FT_STATIC and not can_be_static: if field_options.type == nanopb_pb2.FT_STATIC and not can_be_static:
raise Exception("Field %s is defined as static, but max_size or max_count is not given." % self.name) raise Exception("Field %s is defined as static, but max_size or max_count is not given." % self.name)
if field_options.type == nanopb_pb2.FT_STATIC: if field_options.type == nanopb_pb2.FT_CALLBACK:
self.allocation = 'STATIC' self.htype = 'PB_HTYPE_CALLBACK'
elif field_options.type == nanopb_pb2.FT_CALLBACK:
self.allocation = 'CALLBACK'
self.ctype = 'pb_callback_t' self.ctype = 'pb_callback_t'
self.array_decl = '' self.array_decl = ''
else:
raise NotImplementedError(field_options.type)
def __cmp__(self, other): def __cmp__(self, other):
return cmp(self.tag, other.tag) return cmp(self.tag, other.tag)
def __str__(self): def __str__(self):
if self.rules == 'OPTIONAL' and self.allocation == 'STATIC': if self.htype == 'PB_HTYPE_OPTIONAL':
result = ' bool has_' + self.name + ';\n' result = ' bool has_' + self.name + ';\n'
elif self.rules == 'REPEATED' and self.allocation == 'STATIC': elif self.htype == 'PB_HTYPE_ARRAY':
result = ' size_t ' + self.name + '_count;\n' result = ' size_t ' + self.name + '_count;\n'
else: else:
result = '' result = ''
@@ -197,7 +199,7 @@ class Field:
def types(self): def types(self):
'''Return definitions for any special types this field might need.''' '''Return definitions for any special types this field might need.'''
if self.pbtype == 'BYTES' and self.allocation == 'STATIC': if self.ltype == 'PB_LTYPE_BYTES' and self.max_size is not None:
result = 'typedef struct {\n' result = 'typedef struct {\n'
result += ' size_t size;\n' result += ' size_t size;\n'
result += ' uint8_t bytes[%d];\n' % self.max_size result += ' uint8_t bytes[%d];\n' % self.max_size
@@ -210,64 +212,81 @@ class Field:
'''Return definition for this field's default value.''' '''Return definition for this field's default value.'''
if self.default is None: if self.default is None:
return None return None
ctype, default = self.ctype, self.default
array_decl = ''
if self.pbtype == 'STRING': if self.ltype == 'PB_LTYPE_STRING':
if self.allocation != 'STATIC': ctype = 'char'
if self.max_size is None:
return None # Not implemented return None # Not implemented
else:
array_decl = '[%d]' % self.max_size array_decl = '[%d]' % (self.max_size + 1)
default = str(self.default).encode('string_escape') default = str(self.default).encode('string_escape')
default = default.replace('"', '\\"') default = default.replace('"', '\\"')
default = '"' + default + '"' default = '"' + default + '"'
elif self.pbtype == 'BYTES': elif self.ltype == 'PB_LTYPE_BYTES':
if self.allocation != 'STATIC':
return None # Not implemented
data = self.default.decode('string_escape') data = self.default.decode('string_escape')
data = ['0x%02x' % ord(c) for c in data] data = ['0x%02x' % ord(c) for c in data]
if self.max_size is None:
return None # Not implemented
else:
ctype = self.ctype
default = '{%d, {%s}}' % (len(data), ','.join(data)) default = '{%d, {%s}}' % (len(data), ','.join(data))
array_decl = ''
else:
ctype, default = self.ctype, self.default
array_decl = ''
if declaration_only: if declaration_only:
return 'extern const %s %s_default%s;' % (ctype, self.struct_name + self.name, array_decl) return 'extern const %s %s_default%s;' % (ctype, self.struct_name + self.name, array_decl)
else: else:
return 'const %s %s_default%s = %s;' % (ctype, self.struct_name + self.name, array_decl, default) return 'const %s %s_default%s = %s;' % (ctype, self.struct_name + self.name, array_decl, default)
def tags(self):
'''Return the #define for the tag number of this field.'''
identifier = '%s_%s_tag' % (self.struct_name, self.name)
return '#define %-40s %d\n' % (identifier, self.tag)
def pb_field_t(self, prev_field_name): def pb_field_t(self, prev_field_name):
'''Return the pb_field_t initializer to use in the constant array. '''Return the pb_field_t initializer to use in the constant array.
prev_field_name is the name of the previous field or None. prev_field_name is the name of the previous field or None.
''' '''
result = ' PB_FIELD(%3d, ' % self.tag result = ' {%d, ' % self.tag
result += '%-8s, ' % self.pbtype result += '(pb_type_t) ((int) ' + self.htype
result += '%s, ' % self.rules if self.ltype is not None:
result += '%s, ' % self.allocation result += ' | (int) ' + self.ltype
result += '%s, ' % self.struct_name result += '),\n'
result += '%s, ' % self.name
result += '%s, ' % (prev_field_name or self.name)
if self.pbtype == 'MESSAGE': if prev_field_name is None:
result += '&%s_fields)' % self.submsgname result += ' offsetof(%s, %s),' % (self.struct_name, self.name)
elif self.default is None:
result += '0)'
elif self.pbtype in ['BYTES', 'STRING'] and self.allocation != 'STATIC':
result += '0)' # Arbitrary size default values not implemented
else: else:
result += '&%s_default)' % (self.struct_name + self.name) result += ' pb_delta_end(%s, %s, %s),' % (self.struct_name, self.name, prev_field_name)
if self.htype == 'PB_HTYPE_OPTIONAL':
result += '\n pb_delta(%s, has_%s, %s),' % (self.struct_name, self.name, self.name)
elif self.htype == 'PB_HTYPE_ARRAY':
result += '\n pb_delta(%s, %s_count, %s),' % (self.struct_name, self.name, self.name)
else:
result += ' 0,'
if self.htype == 'PB_HTYPE_ARRAY':
result += '\n pb_membersize(%s, %s[0]),' % (self.struct_name, self.name)
result += ('\n pb_membersize(%s, %s) / pb_membersize(%s, %s[0]),'
% (self.struct_name, self.name, self.struct_name, self.name))
else:
result += '\n pb_membersize(%s, %s),' % (self.struct_name, self.name)
result += ' 0,'
if self.ltype == 'PB_LTYPE_SUBMESSAGE':
result += '\n &%s_fields}' % self.submsgname
elif self.default is None or self.htype == 'PB_HTYPE_CALLBACK':
result += ' 0}'
else:
result += '\n &%s_default}' % (self.struct_name + self.name)
return result return result
def largest_field_value(self): def largest_field_value(self):
'''Determine if this field needs 16bit or 32bit pb_field_t structure to compile properly. '''Determine if this field needs 16bit or 32bit pb_field_t structure to compile properly.
Returns numeric value or a C-expression for assert.''' Returns numeric value or a C-expression for assert.'''
if self.pbtype == 'MESSAGE': if self.ltype == 'PB_LTYPE_SUBMESSAGE':
if self.rules == 'REPEATED' and self.allocation == 'STATIC': if self.htype == 'PB_HTYPE_ARRAY':
return 'pb_membersize(%s, %s[0])' % (self.struct_name, self.name) return 'pb_membersize(%s, %s[0])' % (self.struct_name, self.name)
else: else:
return 'pb_membersize(%s, %s)' % (self.struct_name, self.name) return 'pb_membersize(%s, %s)' % (self.struct_name, self.name)
@@ -275,64 +294,8 @@ class Field:
return max(self.tag, self.max_size, self.max_count) return max(self.tag, self.max_size, self.max_count)
class ExtensionRange(Field):
def __init__(self, struct_name, range_start, field_options):
'''Implements a special pb_extension_t* field in an extensible message
structure. The range_start signifies the index at which the extensions
start. Not necessarily all tags above this are extensions, it is merely
a speed optimization.
'''
self.tag = range_start
self.struct_name = struct_name
self.name = 'extensions'
self.pbtype = 'EXTENSION'
self.rules = 'OPTIONAL'
self.allocation = 'CALLBACK'
self.ctype = 'pb_extension_t'
self.array_decl = ''
self.default = None
self.max_size = 0
self.max_count = 0
def __str__(self):
return ' pb_extension_t *extensions;'
def types(self):
return None
def tags(self):
return ''
class ExtensionField(Field):
def __init__(self, struct_name, desc, field_options):
self.fullname = struct_name + desc.name
self.extendee_name = names_from_type_name(desc.extendee)
Field.__init__(self, self.fullname + 'struct', desc, field_options)
if self.rules != 'OPTIONAL':
raise NotImplementedError("Only 'optional' is supported for extension fields. "
+ "(%s.rules == %s)" % (self.fullname, self.rules))
self.rules = 'OPTEXT'
def extension_decl(self):
'''Declaration of the extension type in the .pb.h file'''
return 'extern const pb_extension_type_t %s;\n' % self.fullname
def extension_def(self):
'''Definition of the extension type in the .pb.c file'''
result = 'typedef struct {\n'
result += str(self)
result += '\n} %s;\n\n' % self.struct_name
result += ('static const pb_field_t %s_field = \n %s;\n\n' %
(self.fullname, self.pb_field_t(None)))
result += 'const pb_extension_type_t %s = {\n' % self.fullname
result += ' NULL,\n'
result += ' NULL,\n'
result += ' &%s_field\n' % self.fullname
result += '};\n'
return result
# --------------------------------------------------------------------------- # ---------------------------------------------------------------------------
@@ -346,16 +309,10 @@ class Message:
self.fields = [] self.fields = []
for f in desc.field: for f in desc.field:
field_options = get_nanopb_suboptions(f, message_options, self.name + f.name) field_options = get_nanopb_suboptions(f, message_options)
if field_options.type != nanopb_pb2.FT_IGNORE: if field_options.type != nanopb_pb2.FT_IGNORE:
self.fields.append(Field(self.name, f, field_options)) self.fields.append(Field(self.name, f, field_options))
if len(desc.extension_range) > 0:
field_options = get_nanopb_suboptions(desc, message_options, self.name + 'extensions')
range_start = min([r.start for r in desc.extension_range])
if field_options.type != nanopb_pb2.FT_IGNORE:
self.fields.append(ExtensionRange(self.name, range_start, field_options))
self.packed = message_options.packed_struct self.packed = message_options.packed_struct
self.ordered_fields = self.fields[:] self.ordered_fields = self.fields[:]
self.ordered_fields.sort() self.ordered_fields.sort()
@@ -366,12 +323,6 @@ class Message:
def __str__(self): def __str__(self):
result = 'typedef struct _%s {\n' % self.name result = 'typedef struct _%s {\n' % self.name
if not self.ordered_fields:
# Empty structs are not allowed in C standard.
# Therefore add a dummy field if an empty message occurs.
result += ' uint8_t dummy_field;'
result += '\n'.join([str(f) for f in self.ordered_fields]) result += '\n'.join([str(f) for f in self.ordered_fields])
result += '\n}' result += '\n}'
@@ -379,11 +330,6 @@ class Message:
result += ' pb_packed' result += ' pb_packed'
result += ' %s;' % self.name result += ' %s;' % self.name
if self.packed:
result = 'PB_PACKED_STRUCT_START\n' + result
result += '\nPB_PACKED_STRUCT_END'
return result return result
def types(self): def types(self):
@@ -412,7 +358,7 @@ class Message:
prev = None prev = None
for field in self.ordered_fields: for field in self.ordered_fields:
result += field.pb_field_t(prev) result += field.pb_field_t(prev)
result += ',\n' result += ',\n\n'
prev = field.name prev = field.name
result += ' PB_LAST_FIELD\n};' result += ' PB_LAST_FIELD\n};'
@@ -420,6 +366,9 @@ class Message:
# --------------------------------------------------------------------------- # ---------------------------------------------------------------------------
# Processing of entire .proto files # Processing of entire .proto files
# --------------------------------------------------------------------------- # ---------------------------------------------------------------------------
@@ -439,23 +388,11 @@ def iterate_messages(desc, names = Names()):
for x in iterate_messages(submsg, sub_names): for x in iterate_messages(submsg, sub_names):
yield x yield x
def iterate_extensions(desc, names = Names()):
'''Recursively find all extensions.
For each, yield name, FieldDescriptorProto.
'''
for extension in desc.extension:
yield names, extension
for subname, subdesc in iterate_messages(desc, names):
for extension in subdesc.extension:
yield subname, extension
def parse_file(fdesc, file_options): def parse_file(fdesc, file_options):
'''Takes a FileDescriptorProto and returns tuple (enums, messages, extensions).''' '''Takes a FileDescriptorProto and returns tuple (enum, messages).'''
enums = [] enums = []
messages = [] messages = []
extensions = []
if fdesc.package: if fdesc.package:
base_name = Names(fdesc.package.split('.')) base_name = Names(fdesc.package.split('.'))
@@ -463,20 +400,16 @@ def parse_file(fdesc, file_options):
base_name = Names() base_name = Names()
for enum in fdesc.enum_type: for enum in fdesc.enum_type:
enum_options = get_nanopb_suboptions(enum, file_options, base_name + enum.name) enum_options = get_nanopb_suboptions(enum, file_options)
enums.append(Enum(base_name, enum, enum_options)) enums.append(Enum(base_name, enum, enum_options))
for names, message in iterate_messages(fdesc, base_name): for names, message in iterate_messages(fdesc, base_name):
message_options = get_nanopb_suboptions(message, file_options, names) message_options = get_nanopb_suboptions(message, file_options)
messages.append(Message(names, message, message_options)) messages.append(Message(names, message, message_options))
for enum in message.enum_type: for enum in message.enum_type:
enum_options = get_nanopb_suboptions(enum, message_options, names + enum.name) enum_options = get_nanopb_suboptions(enum, message_options)
enums.append(Enum(names, enum, enum_options)) enums.append(Enum(names, enum, enum_options))
for names, extension in iterate_extensions(fdesc, base_name):
field_options = get_nanopb_suboptions(extension, file_options, names)
extensions.append(ExtensionField(names, extension, field_options))
# Fix field default values where enum short names are used. # Fix field default values where enum short names are used.
for enum in enums: for enum in enums:
if not enum.options.long_names: if not enum.options.long_names:
@@ -486,7 +419,7 @@ def parse_file(fdesc, file_options):
idx = enum.value_longnames.index(field.default) idx = enum.value_longnames.index(field.default)
field.default = enum.values[idx][0] field.default = enum.values[idx][0]
return enums, messages, extensions return enums, messages
def toposort2(data): def toposort2(data):
'''Topological sort. '''Topological sort.
@@ -529,7 +462,7 @@ def make_identifier(headername):
result += '_' result += '_'
return result return result
def generate_header(dependencies, headername, enums, messages, extensions, options): def generate_header(dependencies, headername, enums, messages):
'''Generate content for a header file. '''Generate content for a header file.
Generates strings, which should be concatenated and stored to file. Generates strings, which should be concatenated and stored to file.
''' '''
@@ -540,18 +473,12 @@ def generate_header(dependencies, headername, enums, messages, extensions, optio
symbol = make_identifier(headername) symbol = make_identifier(headername)
yield '#ifndef _PB_%s_\n' % symbol yield '#ifndef _PB_%s_\n' % symbol
yield '#define _PB_%s_\n' % symbol yield '#define _PB_%s_\n' % symbol
try: yield '#include <pb.h>\n\n'
yield options.libformat % ('pb.h')
except TypeError:
# no %s specified - use whatever was passed in as options.libformat
yield options.libformat
yield '\n'
for dependency in dependencies: for dependency in dependencies:
noext = os.path.splitext(dependency)[0] noext = os.path.splitext(dependency)[0]
yield options.genformat % (noext + '.' + options.extension + '.h') yield '#include "%s.pb.h"\n' % noext
yield '\n'
yield '#ifdef __cplusplus\n' yield '#ifdef __cplusplus\n'
yield 'extern "C" {\n' yield 'extern "C" {\n'
yield '#endif\n\n' yield '#endif\n\n'
@@ -564,57 +491,18 @@ def generate_header(dependencies, headername, enums, messages, extensions, optio
for msg in sort_dependencies(messages): for msg in sort_dependencies(messages):
yield msg.types() yield msg.types()
yield str(msg) + '\n\n' yield str(msg) + '\n\n'
if extensions:
yield '/* Extensions */\n'
for extension in extensions:
yield extension.extension_decl()
yield '\n'
yield '/* Default values for struct fields */\n' yield '/* Default values for struct fields */\n'
for msg in messages: for msg in messages:
yield msg.default_decl(True) yield msg.default_decl(True)
yield '\n' yield '\n'
yield '/* Field tags (for use in manual encoding/decoding) */\n'
for msg in sort_dependencies(messages):
for field in msg.fields:
yield field.tags()
yield '\n'
yield '/* Struct field encoding specification for nanopb */\n' yield '/* Struct field encoding specification for nanopb */\n'
for msg in messages: for msg in messages:
yield msg.fields_declaration() + '\n' yield msg.fields_declaration() + '\n'
yield '\n#ifdef __cplusplus\n'
yield '} /* extern "C" */\n'
yield '#endif\n'
# End of header
yield '\n#endif\n'
def generate_source(headername, enums, messages, extensions):
'''Generate content for a source file.'''
yield '/* Automatically generated nanopb constant definitions */\n'
yield '/* Generated by %s at %s. */\n\n' % (nanopb_version, time.asctime())
yield options.genformat % (headername)
yield '\n'
for msg in messages:
yield msg.default_decl(False)
yield '\n\n'
for msg in messages:
yield msg.fields_definition() + '\n\n'
for ext in extensions:
yield ext.extension_def() + '\n'
# Add checks for numeric limits
if messages: if messages:
count_required_fields = lambda m: len([f for f in msg.fields if f.rules == 'REQUIRED']) count_required_fields = lambda m: len([f for f in msg.fields if f.htype == 'PB_HTYPE_REQUIRED'])
largest_msg = max(messages, key = count_required_fields) largest_msg = max(messages, key = count_required_fields)
largest_count = count_required_fields(largest_msg) largest_count = count_required_fields(largest_msg)
if largest_count > 64: if largest_count > 64:
@@ -624,6 +512,7 @@ def generate_source(headername, enums, messages, extensions):
yield ' setting PB_MAX_REQUIRED_FIELDS to %d or more.\n' % largest_count yield ' setting PB_MAX_REQUIRED_FIELDS to %d or more.\n' % largest_count
yield '#endif\n' yield '#endif\n'
# Add checks for numeric limits
worst = 0 worst = 0
worst_field = '' worst_field = ''
checks = [] checks = []
@@ -672,52 +561,60 @@ def generate_source(headername, enums, messages, extensions):
yield '\n' yield '\n'
yield '/* On some platforms (such as AVR), double is really float.\n' yield '/* On some platforms (such as AVR), double is really float.\n'
yield ' * These are not directly supported by nanopb, but see example_avr_double.\n' yield ' * These are not directly supported by nanopb, but see example_avr_double.\n'
yield ' * To get rid of this error, remove any double fields from your .proto.\n'
yield ' */\n' yield ' */\n'
yield 'STATIC_ASSERT(sizeof(double) == 8, DOUBLE_MUST_BE_8_BYTES)\n' yield 'STATIC_ASSERT(sizeof(double) == 8, DOUBLE_MUST_BE_8_BYTES)\n'
yield '\n' yield '\n#ifdef __cplusplus\n'
yield '} /* extern "C" */\n'
yield '#endif\n'
# End of header
yield '\n#endif\n'
def generate_source(headername, enums, messages):
'''Generate content for a source file.'''
yield '/* Automatically generated nanopb constant definitions */\n'
yield '/* Generated by %s at %s. */\n\n' % (nanopb_version, time.asctime())
yield '#include "%s"\n\n' % headername
for msg in messages:
yield msg.default_decl(False)
yield '\n\n'
for msg in messages:
yield msg.fields_definition() + '\n\n'
# --------------------------------------------------------------------------- # ---------------------------------------------------------------------------
# Options parsing for the .proto files # Command line interface
# --------------------------------------------------------------------------- # ---------------------------------------------------------------------------
from fnmatch import fnmatch import sys
import os.path
from optparse import OptionParser
import google.protobuf.text_format as text_format
def read_options_file(infile): optparser = OptionParser(
'''Parse a separate options file to list: usage = "Usage: nanopb_generator.py [options] file.pb ...",
[(namemask, options), ...] epilog = "Compile file.pb from file.proto by: 'protoc -ofile.pb file.proto'. " +
''' "Output will be written to file.pb.h and file.pb.c.")
results = [] optparser.add_option("-x", dest="exclude", metavar="FILE", action="append", default=[],
for line in infile: help="Exclude file from generated #include list.")
line = line.strip() optparser.add_option("-q", "--quiet", dest="quiet", action="store_true", default=False,
if not line or line.startswith('//') or line.startswith('#'): help="Don't print anything except errors.")
continue optparser.add_option("-v", "--verbose", dest="verbose", action="store_true", default=False,
help="Print more information.")
parts = line.split(None, 1) optparser.add_option("-s", dest="settings", metavar="OPTION:VALUE", action="append", default=[],
opts = nanopb_pb2.NanoPBOptions() help="Set generator option (max_size, max_count etc.).")
text_format.Merge(parts[1], opts)
results.append((parts[0], opts))
return results def get_nanopb_suboptions(subdesc, options):
class Globals:
'''Ugly global variables, should find a good way to pass these.'''
verbose_options = False
separate_options = []
def get_nanopb_suboptions(subdesc, options, name):
'''Get copy of options, and merge information from subdesc.''' '''Get copy of options, and merge information from subdesc.'''
new_options = nanopb_pb2.NanoPBOptions() new_options = nanopb_pb2.NanoPBOptions()
new_options.CopyFrom(options) new_options.CopyFrom(options)
# Handle options defined in a separate file
dotname = '.'.join(name.parts)
for namemask, options in Globals.separate_options:
if fnmatch(dotname, namemask):
new_options.MergeFrom(options)
# Handle options defined in .proto
if isinstance(subdesc.options, descriptor.FieldOptions): if isinstance(subdesc.options, descriptor.FieldOptions):
ext_type = nanopb_pb2.nanopb ext_type = nanopb_pb2.nanopb
elif isinstance(subdesc.options, descriptor.FileOptions): elif isinstance(subdesc.options, descriptor.FileOptions):
@@ -733,44 +630,8 @@ def get_nanopb_suboptions(subdesc, options, name):
ext = subdesc.options.Extensions[ext_type] ext = subdesc.options.Extensions[ext_type]
new_options.MergeFrom(ext) new_options.MergeFrom(ext)
if Globals.verbose_options:
print "Options for " + dotname + ":"
print text_format.MessageToString(new_options)
return new_options return new_options
# ---------------------------------------------------------------------------
# Command line interface
# ---------------------------------------------------------------------------
import sys
import os.path
from optparse import OptionParser
optparser = OptionParser(
usage = "Usage: nanopb_generator.py [options] file.pb ...",
epilog = "Compile file.pb from file.proto by: 'protoc -ofile.pb file.proto'. " +
"Output will be written to file.pb.h and file.pb.c.")
optparser.add_option("-x", dest="exclude", metavar="FILE", action="append", default=[],
help="Exclude file from generated #include list.")
optparser.add_option("-e", "--extension", dest="extension", metavar="EXTENSION", default="pb",
help="Set extension to use instead of 'pb' for generated files. [default: %default]")
optparser.add_option("-f", "--options-file", dest="options_file", metavar="FILE", default="%s.options",
help="Set name of a separate generator options file.")
optparser.add_option("-Q", "--generated-include-format", dest="genformat",
metavar="FORMAT", default='#include "%s"\n',
help="Set format string to use for including other .pb.h files. [default: %default]")
optparser.add_option("-L", "--library-include-format", dest="libformat",
metavar="FORMAT", default='#include <%s>\n',
help="Set format string to use for including the nanopb pb.h header. [default: %default]")
optparser.add_option("-q", "--quiet", dest="quiet", action="store_true", default=False,
help="Don't print anything except errors.")
optparser.add_option("-v", "--verbose", dest="verbose", action="store_true", default=False,
help="Print more information.")
optparser.add_option("-s", dest="settings", metavar="OPTION:VALUE", action="append", default=[],
help="Set generator option (max_size, max_count etc.).")
def process(filenames, options): def process(filenames, options):
'''Process the files given on the command line.''' '''Process the files given on the command line.'''
@@ -780,8 +641,6 @@ def process(filenames, options):
if options.quiet: if options.quiet:
options.verbose = False options.verbose = False
Globals.verbose_options = options.verbose
toplevel_options = nanopb_pb2.NanoPBOptions() toplevel_options = nanopb_pb2.NanoPBOptions()
for s in options.settings: for s in options.settings:
@@ -791,28 +650,17 @@ def process(filenames, options):
data = open(filename, 'rb').read() data = open(filename, 'rb').read()
fdesc = descriptor.FileDescriptorSet.FromString(data) fdesc = descriptor.FileDescriptorSet.FromString(data)
# Check if any separate options are specified file_options = get_nanopb_suboptions(fdesc.file[0], toplevel_options)
try:
optfilename = options.options_file % os.path.splitext(filename)[0]
except TypeError:
# No %s specified, use the filename as-is
optfilename = options.options_file
if options.verbose: if options.verbose:
print 'Reading options from ' + optfilename print "Options for " + filename + ":"
print text_format.MessageToString(file_options)
if os.path.isfile(optfilename): enums, messages = parse_file(fdesc.file[0], file_options)
Globals.separate_options = read_options_file(open(optfilename, "rU"))
else:
Globals.separate_options = []
# Parse the file
file_options = get_nanopb_suboptions(fdesc.file[0], toplevel_options, Names([filename]))
enums, messages, extensions = parse_file(fdesc.file[0], file_options)
noext = os.path.splitext(filename)[0] noext = os.path.splitext(filename)[0]
headername = noext + '.' + options.extension + '.h' headername = noext + '.pb.h'
sourcename = noext + '.' + options.extension + '.c' sourcename = noext + '.pb.c'
headerbasename = os.path.basename(headername) headerbasename = os.path.basename(headername)
if not options.quiet: if not options.quiet:
@@ -824,12 +672,11 @@ def process(filenames, options):
dependencies = [d for d in fdesc.file[0].dependency if d not in excludes] dependencies = [d for d in fdesc.file[0].dependency if d not in excludes]
header = open(headername, 'w') header = open(headername, 'w')
for part in generate_header(dependencies, headerbasename, enums, for part in generate_header(dependencies, headerbasename, enums, messages):
messages, extensions, options):
header.write(part) header.write(part)
source = open(sourcename, 'w') source = open(sourcename, 'w')
for part in generate_source(headerbasename, enums, messages, extensions): for part in generate_source(headerbasename, enums, messages):
source.write(part) source.write(part)
return True return True

341
pb.h
View File

@@ -1,96 +1,25 @@
/* Common parts of the nanopb library. Most of these are quite low-level
* stuff. For the high-level interface, see pb_encode.h and pb_decode.h.
*/
#ifndef _PB_H_ #ifndef _PB_H_
#define _PB_H_ #define _PB_H_
/***************************************************************** /* pb.h: Common parts for nanopb library.
* Nanopb compilation time options. You can change these here by * * Most of these are quite low-level stuff. For the high-level interface,
* uncommenting the lines, or on the compiler command line. * * see pb_encode.h or pb_decode.h
*****************************************************************/
/* Define this if your CPU architecture is big endian, i.e. it
* stores the most-significant byte first. */
/* #define __BIG_ENDIAN__ 1 */
/* Increase the number of required fields that are tracked.
* A compiler warning will tell if you need this. */
/* #define PB_MAX_REQUIRED_FIELDS 256 */
/* Add support for tag numbers > 255 and fields larger than 255 bytes. */
/* #define PB_FIELD_16BIT 1 */
/* Add support for tag numbers > 65536 and fields larger than 65536 bytes. */
/* #define PB_FIELD_32BIT 1 */
/* Disable support for error messages in order to save some code space. */
/* #define PB_NO_ERRMSG 1 */
/* Disable support for custom streams (support only memory buffers). */
/* #define PB_BUFFER_ONLY 1 */
/* Switch back to the old-style callback function signature.
* This was the default until nanopb-0.2.1. */
/* #define PB_OLD_CALLBACK_STYLE */
/******************************************************************
* You usually don't need to change anything below this line. *
* Feel free to look around and use the defined macros, though. *
******************************************************************/
/* Version of the nanopb library. Just in case you want to check it in
* your own program. */
#define NANOPB_VERSION nanopb-0.2.2-dev
/* Include all the system headers needed by nanopb. You will need the
* definitions of the following:
* - strlen, memcpy, memset functions
* - [u]int8_t, [u]int16_t, [u]int32_t, [u]int64_t
* - size_t
* - bool
*
* If you don't have the standard header files, you can instead provide
* a custom header that defines or includes all this. In that case,
* define PB_SYSTEM_HEADER to the path of this file.
*/ */
#ifdef PB_SYSTEM_HEADER
#include PB_SYSTEM_HEADER #define NANOPB_VERSION nanopb-0.1.9.1
#else
#include <stdint.h> #include <stdint.h>
#include <stddef.h> #include <stddef.h>
#include <stdbool.h> #include <stdbool.h>
#include <string.h>
#endif
/* Macro for defining packed structures (compiler dependent). #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))
#if defined(__GNUC__) || defined(__clang__)
/* For GCC and clang */
# define PB_PACKED_STRUCT_START
# define PB_PACKED_STRUCT_END
# define pb_packed __attribute__((packed))
#elif defined(__ICCARM__)
/* For IAR ARM compiler */
# define PB_PACKED_STRUCT_START _Pragma("pack(push, 1)")
# define PB_PACKED_STRUCT_END _Pragma("pack(pop)")
# define pb_packed
#elif defined(_MSC_VER) && (_MSC_VER >= 1500)
/* For Microsoft Visual C++ */
# define PB_PACKED_STRUCT_START __pragma(pack(push, 1))
# define PB_PACKED_STRUCT_END __pragma(pack(pop))
# define pb_packed
#else #else
/* Unknown compiler */ #define pb_packed
# define PB_PACKED_STRUCT_START
# define PB_PACKED_STRUCT_END
# define pb_packed
#endif #endif
/* Handly macro for suppressing unreferenced-parameter compiler warnings. */ /* Handly macro for suppressing unreferenced-parameter compiler warnings. */
#ifndef UNUSED #ifndef UNUSED
#define UNUSED(x) (void)(x) #define UNUSED(x) (void)(x)
#endif #endif
@@ -104,7 +33,8 @@
#define STATIC_ASSERT_MSG_(MSG, LINE, COUNTER) static_assertion_##MSG##LINE##COUNTER #define STATIC_ASSERT_MSG_(MSG, LINE, COUNTER) static_assertion_##MSG##LINE##COUNTER
#endif #endif
/* Number of required fields to keep track of. */ /* Number of required fields to keep track of
* (change here or on compiler command line). */
#ifndef PB_MAX_REQUIRED_FIELDS #ifndef PB_MAX_REQUIRED_FIELDS
#define PB_MAX_REQUIRED_FIELDS 64 #define PB_MAX_REQUIRED_FIELDS 64
#endif #endif
@@ -123,53 +53,60 @@
* SINT* is different, though, because it is zig-zag coded. * SINT* is different, though, because it is zig-zag coded.
*/ */
typedef uint8_t pb_type_t; typedef enum {
/************************
* Field contents types *
************************/
/* Numeric types */
PB_LTYPE_VARINT = 0x00, /* int32, uint32, int64, uint64, bool, enum */
PB_LTYPE_SVARINT = 0x01, /* sint32, sint64 */
PB_LTYPE_FIXED32 = 0x02, /* fixed32, sfixed32, float */
PB_LTYPE_FIXED64 = 0x03, /* fixed64, sfixed64, double */
/* Marker for last packable field type. */
PB_LTYPE_LAST_PACKABLE = 0x03,
/* Byte array with pre-allocated buffer.
* data_size is the length of the allocated PB_BYTES_ARRAY structure. */
PB_LTYPE_BYTES = 0x04,
/* String with pre-allocated buffer.
* data_size is the maximum length. */
PB_LTYPE_STRING = 0x05,
/* Submessage
* submsg_fields is pointer to field descriptions */
PB_LTYPE_SUBMESSAGE = 0x06,
/* Number of declared LTYPES */
PB_LTYPES_COUNT = 7,
PB_LTYPE_MASK = 0x0F,
/******************
* Modifier flags *
******************/
/* Just the basic, write data at data_offset */
PB_HTYPE_REQUIRED = 0x00,
/* 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 */
PB_HTYPE_ARRAY = 0x20,
/* Works for all required/optional/repeated fields.
* data_offset points to pb_callback_t structure.
* LTYPE should be valid or 0 (it is ignored, but
* sometimes used to speculatively index an array). */
PB_HTYPE_CALLBACK = 0x30,
PB_HTYPE_MASK = 0xF0
} pb_packed pb_type_t;
/**** Field data types ****/
/* Numeric types */
#define PB_LTYPE_VARINT 0x00 /* int32, uint32, int64, uint64, bool, enum */
#define PB_LTYPE_SVARINT 0x01 /* sint32, sint64 */
#define PB_LTYPE_FIXED32 0x02 /* fixed32, sfixed32, float */
#define PB_LTYPE_FIXED64 0x03 /* fixed64, sfixed64, double */
/* Marker for last packable field type. */
#define PB_LTYPE_LAST_PACKABLE 0x03
/* Byte array with pre-allocated buffer.
* data_size is the length of the allocated PB_BYTES_ARRAY structure. */
#define PB_LTYPE_BYTES 0x04
/* String with pre-allocated buffer.
* data_size is the maximum length. */
#define PB_LTYPE_STRING 0x05
/* Submessage
* submsg_fields is pointer to field descriptions */
#define PB_LTYPE_SUBMESSAGE 0x06
/* Extension pseudo-field
* The field contains a pointer to pb_extension_t */
#define PB_LTYPE_EXTENSION 0x07
/* Number of declared LTYPES */
#define PB_LTYPES_COUNT 8
#define PB_LTYPE_MASK 0x0F
/**** Field repetition rules ****/
#define PB_HTYPE_REQUIRED 0x00
#define PB_HTYPE_OPTIONAL 0x10
#define PB_HTYPE_REPEATED 0x20
#define PB_HTYPE_MASK 0x30
/**** Field allocation types ****/
#define PB_ATYPE_STATIC 0x00
#define PB_ATYPE_CALLBACK 0x40
#define PB_ATYPE_MASK 0xC0
#define PB_ATYPE(x) ((x) & PB_ATYPE_MASK)
#define PB_HTYPE(x) ((x) & PB_HTYPE_MASK) #define PB_HTYPE(x) ((x) & PB_HTYPE_MASK)
#define PB_LTYPE(x) ((x) & PB_LTYPE_MASK) #define PB_LTYPE(x) ((x) & PB_LTYPE_MASK)
@@ -181,7 +118,6 @@ typedef uint8_t pb_type_t;
* structures. Fix that by defining PB_FIELD_16BIT or * structures. Fix that by defining PB_FIELD_16BIT or
* PB_FIELD_32BIT. * PB_FIELD_32BIT.
*/ */
PB_PACKED_STRUCT_START
typedef struct _pb_field_t pb_field_t; typedef struct _pb_field_t pb_field_t;
struct _pb_field_t { struct _pb_field_t {
@@ -213,7 +149,6 @@ struct _pb_field_t {
* If null, then field will zeroed. */ * If null, then field will zeroed. */
const void *ptr; const void *ptr;
} pb_packed; } pb_packed;
PB_PACKED_STRUCT_END
/* This structure is used for 'bytes' arrays. /* This structure is used for 'bytes' arrays.
* It has the number of bytes in the beginning, and after that an array. * It has the number of bytes in the beginning, and after that an array.
@@ -248,19 +183,10 @@ typedef struct _pb_istream_t pb_istream_t;
typedef struct _pb_ostream_t pb_ostream_t; typedef struct _pb_ostream_t pb_ostream_t;
typedef struct _pb_callback_t pb_callback_t; typedef struct _pb_callback_t pb_callback_t;
struct _pb_callback_t { struct _pb_callback_t {
#ifdef PB_OLD_CALLBACK_STYLE
/* Deprecated since nanopb-0.2.1 */
union { union {
bool (*decode)(pb_istream_t *stream, const pb_field_t *field, void *arg); bool (*decode)(pb_istream_t *stream, const pb_field_t *field, void *arg);
bool (*encode)(pb_ostream_t *stream, const pb_field_t *field, const void *arg); bool (*encode)(pb_ostream_t *stream, const pb_field_t *field, const void *arg);
} funcs; } funcs;
#else
/* New function signature, which allows modifying arg contents in callback. */
union {
bool (*decode)(pb_istream_t *stream, const pb_field_t *field, void **arg);
bool (*encode)(pb_ostream_t *stream, const pb_field_t *field, void * const *arg);
} funcs;
#endif
/* Free arg for use by callback */ /* Free arg for use by callback */
void *arg; void *arg;
@@ -274,146 +200,13 @@ typedef enum {
PB_WT_32BIT = 5 PB_WT_32BIT = 5
} pb_wire_type_t; } pb_wire_type_t;
/* Structure for defining the handling of unknown/extension fields.
* Usually the pb_extension_type_t structure is automatically generated,
* while the pb_extension_t structure is created by the user. However,
* if you want to catch all unknown fields, you can also create a custom
* pb_extension_type_t with your own callback.
*/
typedef struct _pb_extension_type_t pb_extension_type_t;
typedef struct _pb_extension_t pb_extension_t;
struct _pb_extension_type_t {
/* Called for each unknown field in the message.
* If you handle the field, read off all of its data and return true.
* If you do not handle the field, do not read anything and return true.
* If you run into an error, return false.
* Set to NULL for default handler.
*/
bool (*decode)(pb_istream_t *stream, pb_extension_t *extension,
uint32_t tag, pb_wire_type_t wire_type);
/* Called once after all regular fields have been encoded.
* If you have something to write, do so and return true.
* If you do not have anything to write, just return true.
* If you run into an error, return false.
* Set to NULL for default handler.
*/
bool (*encode)(pb_ostream_t *stream, const pb_extension_t *extension);
/* Free field for use by the callback. */
const void *arg;
};
struct _pb_extension_t {
/* Type describing the extension field. Usually you'll initialize
* this to a pointer to the automatically generated structure. */
const pb_extension_type_t *type;
/* Destination for the decoded data. This must match the datatype
* of the extension field. */
void *dest;
/* Pointer to the next extension handler, or NULL.
* If this extension does not match a field, the next handler is
* automatically called. */
pb_extension_t *next;
};
/* These macros are used to declare pb_field_t's in the constant array. */ /* These macros are used to declare pb_field_t's in the constant array. */
#define pb_membersize(st, m) (sizeof ((st*)0)->m) #define pb_membersize(st, m) (sizeof ((st*)0)->m)
#define pb_arraysize(st, m) (pb_membersize(st, m) / pb_membersize(st, m[0])) #define pb_arraysize(st, m) (pb_membersize(st, m) / pb_membersize(st, m[0]))
#define pb_delta(st, m1, m2) ((int)offsetof(st, m1) - (int)offsetof(st, m2)) #define pb_delta(st, m1, m2) ((int)offsetof(st, m1) - (int)offsetof(st, m2))
#define pb_delta_end(st, m1, m2) (int)(offsetof(st, m1) == offsetof(st, m2) \ #define pb_delta_end(st, m1, m2) (offsetof(st, m1) - offsetof(st, m2) - pb_membersize(st, m2))
? offsetof(st, m1) \
: offsetof(st, m1) - offsetof(st, m2) - pb_membersize(st, m2))
#define PB_LAST_FIELD {0,(pb_type_t) 0,0,0,0,0,0} #define PB_LAST_FIELD {0,(pb_type_t) 0,0,0,0,0,0}
/* Required fields are the simplest. They just have delta (padding) from
* previous field end, and the size of the field. Pointer is used for
* submessages and default values.
*/
#define PB_REQUIRED_STATIC(tag, st, m, pm, ltype, ptr) \
{tag, PB_ATYPE_STATIC | PB_HTYPE_REQUIRED | ltype, \
pb_delta_end(st, m, pm), 0, pb_membersize(st, m), 0, ptr}
/* Optional fields add the delta to the has_ variable. */
#define PB_OPTIONAL_STATIC(tag, st, m, pm, ltype, ptr) \
{tag, PB_ATYPE_STATIC | PB_HTYPE_OPTIONAL | ltype, \
pb_delta_end(st, m, pm), \
pb_delta(st, has_ ## m, m), \
pb_membersize(st, m), 0, ptr}
/* Repeated fields have a _count field and also the maximum number of entries. */
#define PB_REPEATED_STATIC(tag, st, m, pm, ltype, ptr) \
{tag, PB_ATYPE_STATIC | PB_HTYPE_REPEATED | ltype, \
pb_delta_end(st, m, pm), \
pb_delta(st, m ## _count, m), \
pb_membersize(st, m[0]), \
pb_arraysize(st, m), ptr}
/* Callbacks are much like required fields except with special datatype. */
#define PB_REQUIRED_CALLBACK(tag, st, m, pm, ltype, ptr) \
{tag, PB_ATYPE_CALLBACK | PB_HTYPE_REQUIRED | ltype, \
pb_delta_end(st, m, pm), 0, pb_membersize(st, m), 0, ptr}
#define PB_OPTIONAL_CALLBACK(tag, st, m, pm, ltype, ptr) \
{tag, PB_ATYPE_CALLBACK | PB_HTYPE_OPTIONAL | ltype, \
pb_delta_end(st, m, pm), 0, pb_membersize(st, m), 0, ptr}
#define PB_REPEATED_CALLBACK(tag, st, m, pm, ltype, ptr) \
{tag, PB_ATYPE_CALLBACK | PB_HTYPE_REPEATED | ltype, \
pb_delta_end(st, m, pm), 0, pb_membersize(st, m), 0, ptr}
/* Optional extensions don't have the has_ field, as that would be redundant. */
#define PB_OPTEXT_STATIC(tag, st, m, pm, ltype, ptr) \
{tag, PB_ATYPE_STATIC | PB_HTYPE_OPTIONAL | ltype, \
0, \
0, \
pb_membersize(st, m), 0, ptr}
#define PB_OPTEXT_CALLBACK(tag, st, m, pm, ltype, ptr) \
{tag, PB_ATYPE_CALLBACK | PB_HTYPE_OPTIONAL | ltype, \
0, 0, pb_membersize(st, m), 0, ptr}
/* The mapping from protobuf types to LTYPEs is done using these macros. */
#define PB_LTYPE_MAP_BOOL PB_LTYPE_VARINT
#define PB_LTYPE_MAP_BYTES PB_LTYPE_BYTES
#define PB_LTYPE_MAP_DOUBLE PB_LTYPE_FIXED64
#define PB_LTYPE_MAP_ENUM PB_LTYPE_VARINT
#define PB_LTYPE_MAP_FIXED32 PB_LTYPE_FIXED32
#define PB_LTYPE_MAP_FIXED64 PB_LTYPE_FIXED64
#define PB_LTYPE_MAP_FLOAT PB_LTYPE_FIXED32
#define PB_LTYPE_MAP_INT32 PB_LTYPE_VARINT
#define PB_LTYPE_MAP_INT64 PB_LTYPE_VARINT
#define PB_LTYPE_MAP_MESSAGE PB_LTYPE_SUBMESSAGE
#define PB_LTYPE_MAP_SFIXED32 PB_LTYPE_FIXED32
#define PB_LTYPE_MAP_SFIXED64 PB_LTYPE_FIXED64
#define PB_LTYPE_MAP_SINT32 PB_LTYPE_SVARINT
#define PB_LTYPE_MAP_SINT64 PB_LTYPE_SVARINT
#define PB_LTYPE_MAP_STRING PB_LTYPE_STRING
#define PB_LTYPE_MAP_UINT32 PB_LTYPE_VARINT
#define PB_LTYPE_MAP_UINT64 PB_LTYPE_VARINT
#define PB_LTYPE_MAP_EXTENSION PB_LTYPE_EXTENSION
/* This is the actual macro used in field descriptions.
* It takes these arguments:
* - Field tag number
* - Field type: BOOL, BYTES, DOUBLE, ENUM, FIXED32, FIXED64,
* FLOAT, INT32, INT64, MESSAGE, SFIXED32, SFIXED64
* SINT32, SINT64, STRING, UINT32, UINT64 or EXTENSION
* - Field rules: REQUIRED, OPTIONAL or REPEATED
* - Allocation: STATIC or CALLBACK
* - Message name
* - Field name
* - Previous field name (or field name again for first field)
* - Pointer to default value or submsg fields.
*/
#define PB_FIELD(tag, type, rules, allocation, message, field, prevfield, ptr) \
PB_ ## rules ## _ ## allocation(tag, message, field, prevfield, \
PB_LTYPE_MAP_ ## type, ptr)
/* These macros are used for giving out error messages. /* These macros are used for giving out error messages.
* They are mostly a debugging aid; the main error information * They are mostly a debugging aid; the main error information
* is the true/false return value from functions. * is the true/false return value from functions.

View File

@@ -14,6 +14,7 @@
#define NANOPB_INTERNALS #define NANOPB_INTERNALS
#include "pb.h" #include "pb.h"
#include "pb_decode.h" #include "pb_decode.h"
#include <string.h>
typedef bool (*pb_decoder_t)(pb_istream_t *stream, const pb_field_t *field, void *dest) checkreturn; typedef bool (*pb_decoder_t)(pb_istream_t *stream, const pb_field_t *field, void *dest) checkreturn;
@@ -28,8 +29,7 @@ static const pb_decoder_t PB_DECODERS[PB_LTYPES_COUNT] = {
&pb_dec_bytes, &pb_dec_bytes,
&pb_dec_string, &pb_dec_string,
&pb_dec_submessage, &pb_dec_submessage
NULL /* extensions */
}; };
/************** /**************
@@ -280,7 +280,7 @@ void pb_close_string_substream(pb_istream_t *stream, pb_istream_t *substream)
/* Iterator for pb_field_t list */ /* Iterator for pb_field_t list */
typedef struct { typedef struct {
const pb_field_t *start; /* Start of the pb_field_t array */ const pb_field_t *start; /* Start of the pb_field_t array */
const pb_field_t *pos; /* Current position of the iterator */ const pb_field_t *current; /* Current position of the iterator */
unsigned field_index; /* Zero-based index of the field. */ unsigned field_index; /* Zero-based index of the field. */
unsigned required_field_index; /* Zero-based index that counts only the required fields */ unsigned required_field_index; /* Zero-based index that counts only the required fields */
void *dest_struct; /* Pointer to the destination structure to decode to */ void *dest_struct; /* Pointer to the destination structure to decode to */
@@ -290,36 +290,30 @@ typedef struct {
static void pb_field_init(pb_field_iterator_t *iter, const pb_field_t *fields, void *dest_struct) static void pb_field_init(pb_field_iterator_t *iter, const pb_field_t *fields, void *dest_struct)
{ {
iter->start = iter->pos = fields; iter->start = iter->current = fields;
iter->field_index = 0; iter->field_index = 0;
iter->required_field_index = 0; iter->required_field_index = 0;
iter->pData = (char*)dest_struct + iter->pos->data_offset; iter->pData = (char*)dest_struct + iter->current->data_offset;
iter->pSize = (char*)iter->pData + iter->pos->size_offset; iter->pSize = (char*)iter->pData + iter->current->size_offset;
iter->dest_struct = dest_struct; iter->dest_struct = dest_struct;
} }
static bool pb_field_next(pb_field_iterator_t *iter) static bool pb_field_next(pb_field_iterator_t *iter)
{ {
bool notwrapped = true; bool notwrapped = true;
size_t prev_size = iter->pos->data_size; size_t prev_size = iter->current->data_size;
if (PB_ATYPE(iter->pos->type) == PB_ATYPE_STATIC && if (PB_HTYPE(iter->current->type) == PB_HTYPE_ARRAY)
PB_HTYPE(iter->pos->type) == PB_HTYPE_REPEATED) prev_size *= iter->current->array_size;
{
prev_size *= iter->pos->array_size;
}
if (iter->pos->tag == 0) if (PB_HTYPE(iter->current->type) == PB_HTYPE_REQUIRED)
return false; /* Only happens with empty message types */
if (PB_HTYPE(iter->pos->type) == PB_HTYPE_REQUIRED)
iter->required_field_index++; iter->required_field_index++;
iter->pos++; iter->current++;
iter->field_index++; iter->field_index++;
if (iter->pos->tag == 0) if (iter->current->tag == 0)
{ {
iter->pos = iter->start; iter->current = iter->start;
iter->field_index = 0; iter->field_index = 0;
iter->required_field_index = 0; iter->required_field_index = 0;
iter->pData = iter->dest_struct; iter->pData = iter->dest_struct;
@@ -327,8 +321,8 @@ static bool pb_field_next(pb_field_iterator_t *iter)
notwrapped = false; notwrapped = false;
} }
iter->pData = (char*)iter->pData + prev_size + iter->pos->data_offset; iter->pData = (char*)iter->pData + prev_size + iter->current->data_offset;
iter->pSize = (char*)iter->pData + iter->pos->size_offset; iter->pSize = (char*)iter->pData + iter->current->size_offset;
return notwrapped; return notwrapped;
} }
@@ -337,11 +331,8 @@ static bool checkreturn pb_field_find(pb_field_iterator_t *iter, uint32_t tag)
unsigned start = iter->field_index; unsigned start = iter->field_index;
do { do {
if (iter->pos->tag == tag && if (iter->current->tag == tag)
PB_LTYPE(iter->pos->type) != PB_LTYPE_EXTENSION)
{
return true; return true;
}
pb_field_next(iter); pb_field_next(iter);
} while (iter->field_index != start); } while (iter->field_index != start);
@@ -352,26 +343,22 @@ static bool checkreturn pb_field_find(pb_field_iterator_t *iter, uint32_t tag)
* Decode a single field * * Decode a single field *
*************************/ *************************/
static bool checkreturn decode_static_field(pb_istream_t *stream, pb_wire_type_t wire_type, pb_field_iterator_t *iter) static bool checkreturn decode_field(pb_istream_t *stream, pb_wire_type_t wire_type, pb_field_iterator_t *iter)
{ {
pb_type_t type; pb_decoder_t func = PB_DECODERS[PB_LTYPE(iter->current->type)];
pb_decoder_t func;
type = iter->pos->type; switch (PB_HTYPE(iter->current->type))
func = PB_DECODERS[PB_LTYPE(type)];
switch (PB_HTYPE(type))
{ {
case PB_HTYPE_REQUIRED: case PB_HTYPE_REQUIRED:
return func(stream, iter->pos, iter->pData); return func(stream, iter->current, iter->pData);
case PB_HTYPE_OPTIONAL: case PB_HTYPE_OPTIONAL:
*(bool*)iter->pSize = true; *(bool*)iter->pSize = true;
return func(stream, iter->pos, iter->pData); return func(stream, iter->current, iter->pData);
case PB_HTYPE_REPEATED: case PB_HTYPE_ARRAY:
if (wire_type == PB_WT_STRING if (wire_type == PB_WT_STRING
&& PB_LTYPE(type) <= PB_LTYPE_LAST_PACKABLE) && PB_LTYPE(iter->current->type) <= PB_LTYPE_LAST_PACKABLE)
{ {
/* Packed array */ /* Packed array */
bool status = true; bool status = true;
@@ -380,10 +367,10 @@ static bool checkreturn decode_static_field(pb_istream_t *stream, pb_wire_type_t
if (!pb_make_string_substream(stream, &substream)) if (!pb_make_string_substream(stream, &substream))
return false; return false;
while (substream.bytes_left && *size < iter->pos->array_size) while (substream.bytes_left && *size < iter->current->array_size)
{ {
void *pItem = (uint8_t*)iter->pData + iter->pos->data_size * (*size); void *pItem = (uint8_t*)iter->pData + iter->current->data_size * (*size);
if (!func(&substream, iter->pos, pItem)) if (!func(&substream, iter->current, pItem))
{ {
status = false; status = false;
break; break;
@@ -401,145 +388,60 @@ static bool checkreturn decode_static_field(pb_istream_t *stream, pb_wire_type_t
{ {
/* Repeated field */ /* Repeated field */
size_t *size = (size_t*)iter->pSize; size_t *size = (size_t*)iter->pSize;
void *pItem = (uint8_t*)iter->pData + iter->pos->data_size * (*size); void *pItem = (uint8_t*)iter->pData + iter->current->data_size * (*size);
if (*size >= iter->pos->array_size) if (*size >= iter->current->array_size)
PB_RETURN_ERROR(stream, "array overflow"); PB_RETURN_ERROR(stream, "array overflow");
(*size)++; (*size)++;
return func(stream, iter->pos, pItem); return func(stream, iter->current, pItem);
} }
default:
PB_RETURN_ERROR(stream, "invalid field type");
}
}
static bool checkreturn decode_callback_field(pb_istream_t *stream, pb_wire_type_t wire_type, pb_field_iterator_t *iter)
{
pb_callback_t *pCallback = (pb_callback_t*)iter->pData;
#ifdef PB_OLD_CALLBACK_STYLE
void *arg = pCallback->arg;
#else
void **arg = &(pCallback->arg);
#endif
if (pCallback->funcs.decode == NULL)
return pb_skip_field(stream, wire_type);
if (wire_type == PB_WT_STRING)
{
pb_istream_t substream;
if (!pb_make_string_substream(stream, &substream)) case PB_HTYPE_CALLBACK:
return false;
do
{ {
if (!pCallback->funcs.decode(&substream, iter->pos, arg)) pb_callback_t *pCallback = (pb_callback_t*)iter->pData;
PB_RETURN_ERROR(stream, "callback failed");
} while (substream.bytes_left); if (pCallback->funcs.decode == NULL)
return pb_skip_field(stream, wire_type);
pb_close_string_substream(stream, &substream);
return true; if (wire_type == PB_WT_STRING)
} {
else pb_istream_t substream;
{
/* Copy the single scalar value to stack. if (!pb_make_string_substream(stream, &substream))
* This is required so that we can limit the stream length, return false;
* which in turn allows to use same callback for packed and
* not-packed fields. */ while (substream.bytes_left)
pb_istream_t substream; {
uint8_t buffer[10]; if (!pCallback->funcs.decode(&substream, iter->current, pCallback->arg))
size_t size = sizeof(buffer); PB_RETURN_ERROR(stream, "callback failed");
}
if (!read_raw_value(stream, wire_type, buffer, &size))
return false; pb_close_string_substream(stream, &substream);
substream = pb_istream_from_buffer(buffer, size); return true;
}
return pCallback->funcs.decode(&substream, iter->pos, arg); else
} {
} /* Copy the single scalar value to stack.
* This is required so that we can limit the stream length,
static bool checkreturn decode_field(pb_istream_t *stream, pb_wire_type_t wire_type, pb_field_iterator_t *iter) * which in turn allows to use same callback for packed and
{ * not-packed fields. */
switch (PB_ATYPE(iter->pos->type)) pb_istream_t substream;
{ uint8_t buffer[10];
case PB_ATYPE_STATIC: size_t size = sizeof(buffer);
return decode_static_field(stream, wire_type, iter);
if (!read_raw_value(stream, wire_type, buffer, &size))
case PB_ATYPE_CALLBACK: return false;
return decode_callback_field(stream, wire_type, iter); substream = pb_istream_from_buffer(buffer, size);
return pCallback->funcs.decode(&substream, iter->current, pCallback->arg);
}
}
default: default:
PB_RETURN_ERROR(stream, "invalid field type"); PB_RETURN_ERROR(stream, "invalid field type");
} }
} }
/* Default handler for extension fields. Expects a pb_field_t structure
* in extension->type->arg. */
static bool checkreturn default_extension_handler(pb_istream_t *stream,
pb_extension_t *extension, uint32_t tag, pb_wire_type_t wire_type)
{
const pb_field_t *field = (const pb_field_t*)extension->type->arg;
pb_field_iterator_t iter;
bool dummy;
if (field->tag != tag)
return true;
iter.start = field;
iter.pos = field;
iter.field_index = 0;
iter.required_field_index = 0;
iter.dest_struct = extension->dest;
iter.pData = extension->dest;
iter.pSize = &dummy;
return decode_field(stream, wire_type, &iter);
}
/* Try to decode an unknown field as an extension field. Tries each extension
* decoder in turn, until one of them handles the field or loop ends. */
static bool checkreturn decode_extension(pb_istream_t *stream,
uint32_t tag, pb_wire_type_t wire_type, pb_field_iterator_t *iter)
{
pb_extension_t *extension = *(pb_extension_t* const *)iter->pData;
size_t pos = stream->bytes_left;
while (extension && pos == stream->bytes_left)
{
bool status;
if (extension->type->decode)
status = extension->type->decode(stream, extension, tag, wire_type);
else
status = default_extension_handler(stream, extension, tag, wire_type);
if (!status)
return false;
extension = extension->next;
}
return true;
}
/* Step through the iterator until an extension field is found or until all
* entries have been checked. There can be only one extension field per
* message. Returns false if no extension field is found. */
static bool checkreturn find_extension_field(pb_field_iterator_t *iter)
{
unsigned start = iter->field_index;
do {
if (PB_LTYPE(iter->pos->type) == PB_LTYPE_EXTENSION)
return true;
pb_field_next(iter);
} while (iter->field_index != start);
return false;
}
/* Initialize message fields to default values, recursively */ /* Initialize message fields to default values, recursively */
static void pb_message_set_to_defaults(const pb_field_t fields[], void *dest_struct) static void pb_message_set_to_defaults(const pb_field_t fields[], void *dest_struct)
{ {
@@ -549,43 +451,37 @@ static void pb_message_set_to_defaults(const pb_field_t fields[], void *dest_str
/* Initialize size/has fields and apply default values */ /* Initialize size/has fields and apply default values */
do do
{ {
pb_type_t type; if (iter.current->tag == 0)
type = iter.pos->type;
if (iter.pos->tag == 0)
continue; continue;
if (PB_ATYPE(type) == PB_ATYPE_STATIC) /* Initialize the size field for optional/repeated fields to 0. */
if (PB_HTYPE(iter.current->type) == PB_HTYPE_OPTIONAL)
{ {
/* Initialize the size field for optional/repeated fields to 0. */ *(bool*)iter.pSize = false;
if (PB_HTYPE(type) == PB_HTYPE_OPTIONAL)
{
*(bool*)iter.pSize = false;
}
else if (PB_HTYPE(type) == PB_HTYPE_REPEATED)
{
*(size_t*)iter.pSize = 0;
continue; /* Array is empty, no need to initialize contents */
}
/* Initialize field contents to default value */
if (PB_LTYPE(iter.pos->type) == PB_LTYPE_SUBMESSAGE)
{
pb_message_set_to_defaults((const pb_field_t *) iter.pos->ptr, iter.pData);
}
else if (iter.pos->ptr != NULL)
{
memcpy(iter.pData, iter.pos->ptr, iter.pos->data_size);
}
else
{
memset(iter.pData, 0, iter.pos->data_size);
}
} }
else if (PB_ATYPE(type) == PB_ATYPE_CALLBACK) else if (PB_HTYPE(iter.current->type) == PB_HTYPE_ARRAY)
{
*(size_t*)iter.pSize = 0;
continue; /* Array is empty, no need to initialize contents */
}
/* Initialize field contents to default value */
if (PB_HTYPE(iter.current->type) == PB_HTYPE_CALLBACK)
{ {
continue; /* Don't overwrite callback */ continue; /* Don't overwrite callback */
} }
else if (PB_LTYPE(iter.current->type) == PB_LTYPE_SUBMESSAGE)
{
pb_message_set_to_defaults((const pb_field_t *) iter.current->ptr, iter.pData);
}
else if (iter.current->ptr != NULL)
{
memcpy(iter.pData, iter.current->ptr, iter.current->data_size);
}
else
{
memset(iter.pData, 0, iter.current->data_size);
}
} while (pb_field_next(&iter)); } while (pb_field_next(&iter));
} }
@@ -596,7 +492,6 @@ static void pb_message_set_to_defaults(const pb_field_t fields[], void *dest_str
bool checkreturn pb_decode_noinit(pb_istream_t *stream, const pb_field_t fields[], void *dest_struct) bool checkreturn pb_decode_noinit(pb_istream_t *stream, const pb_field_t fields[], void *dest_struct)
{ {
uint8_t fields_seen[(PB_MAX_REQUIRED_FIELDS + 7) / 8] = {0}; /* Used to check for required fields */ uint8_t fields_seen[(PB_MAX_REQUIRED_FIELDS + 7) / 8] = {0}; /* Used to check for required fields */
uint32_t extension_range_start = 0;
pb_field_iterator_t iter; pb_field_iterator_t iter;
pb_field_init(&iter, fields, dest_struct); pb_field_init(&iter, fields, dest_struct);
@@ -617,36 +512,13 @@ bool checkreturn pb_decode_noinit(pb_istream_t *stream, const pb_field_t fields[
if (!pb_field_find(&iter, tag)) if (!pb_field_find(&iter, tag))
{ {
/* No match found, check if it matches an extension. */
if (tag >= extension_range_start)
{
if (!find_extension_field(&iter))
extension_range_start = (uint32_t)-1;
else
extension_range_start = iter.pos->tag;
if (tag >= extension_range_start)
{
size_t pos = stream->bytes_left;
if (!decode_extension(stream, tag, wire_type, &iter))
return false;
if (pos != stream->bytes_left)
{
/* The field was handled */
continue;
}
}
}
/* No match found, skip data */ /* No match found, skip data */
if (!pb_skip_field(stream, wire_type)) if (!pb_skip_field(stream, wire_type))
return false; return false;
continue; continue;
} }
if (PB_HTYPE(iter.pos->type) == PB_HTYPE_REQUIRED if (PB_HTYPE(iter.current->type) == PB_HTYPE_REQUIRED
&& iter.required_field_index < PB_MAX_REQUIRED_FIELDS) && iter.required_field_index < PB_MAX_REQUIRED_FIELDS)
{ {
fields_seen[iter.required_field_index >> 3] |= (uint8_t)(1 << (iter.required_field_index & 7)); fields_seen[iter.required_field_index >> 3] |= (uint8_t)(1 << (iter.required_field_index & 7));
@@ -667,11 +539,11 @@ bool checkreturn pb_decode_noinit(pb_istream_t *stream, const pb_field_t fields[
unsigned i; unsigned i;
do { do {
req_field_count = iter.required_field_index; req_field_count = iter.required_field_index;
last_type = iter.pos->type; last_type = iter.current->type;
} while (pb_field_next(&iter)); } while (pb_field_next(&iter));
/* Fixup if last field was also required. */ /* Fixup if last field was also required. */
if (PB_HTYPE(last_type) == PB_HTYPE_REQUIRED && iter.pos->tag) if (PB_HTYPE(last_type) == PB_HTYPE_REQUIRED)
req_field_count++; req_field_count++;
/* Check the whole bytes */ /* Check the whole bytes */
@@ -695,19 +567,6 @@ bool checkreturn pb_decode(pb_istream_t *stream, const pb_field_t fields[], void
return pb_decode_noinit(stream, fields, dest_struct); return pb_decode_noinit(stream, fields, dest_struct);
} }
bool pb_decode_delimited(pb_istream_t *stream, const pb_field_t fields[], void *dest_struct)
{
pb_istream_t substream;
bool status;
if (!pb_make_string_substream(stream, &substream))
return false;
status = pb_decode(&substream, fields, dest_struct);
pb_close_string_substream(stream, &substream);
return status;
}
/* Field decoders */ /* Field decoders */
bool pb_decode_svarint(pb_istream_t *stream, int64_t *dest) bool pb_decode_svarint(pb_istream_t *stream, int64_t *dest)
@@ -769,8 +628,7 @@ bool pb_decode_fixed64(pb_istream_t *stream, void *dest)
bool checkreturn pb_dec_varint(pb_istream_t *stream, const pb_field_t *field, void *dest) bool checkreturn pb_dec_varint(pb_istream_t *stream, const pb_field_t *field, void *dest)
{ {
uint64_t value; uint64_t value;
if (!pb_decode_varint(stream, &value)) bool status = pb_decode_varint(stream, &value);
return false;
switch (field->data_size) switch (field->data_size)
{ {
@@ -781,14 +639,13 @@ bool checkreturn pb_dec_varint(pb_istream_t *stream, const pb_field_t *field, vo
default: PB_RETURN_ERROR(stream, "invalid data_size"); default: PB_RETURN_ERROR(stream, "invalid data_size");
} }
return true; return status;
} }
bool checkreturn pb_dec_svarint(pb_istream_t *stream, const pb_field_t *field, void *dest) bool checkreturn pb_dec_svarint(pb_istream_t *stream, const pb_field_t *field, void *dest)
{ {
int64_t value; int64_t value;
if (!pb_decode_svarint(stream, &value)) bool status = pb_decode_svarint(stream, &value);
return false;
switch (field->data_size) switch (field->data_size)
{ {
@@ -797,7 +654,7 @@ bool checkreturn pb_dec_svarint(pb_istream_t *stream, const pb_field_t *field, v
default: PB_RETURN_ERROR(stream, "invalid data_size"); default: PB_RETURN_ERROR(stream, "invalid data_size");
} }
return true; return status;
} }
bool checkreturn pb_dec_fixed32(pb_istream_t *stream, const pb_field_t *field, void *dest) bool checkreturn pb_dec_fixed32(pb_istream_t *stream, const pb_field_t *field, void *dest)
@@ -821,6 +678,9 @@ bool checkreturn pb_dec_bytes(pb_istream_t *stream, const pb_field_t *field, voi
return false; return false;
x->size = temp; x->size = temp;
if (x->size < temp)
PB_RETURN_ERROR(stream, "size too large");
/* Check length, noting the space taken by the size_t header. */ /* Check length, noting the space taken by the size_t header. */
if (x->size > field->data_size - offsetof(pb_bytes_array_t, bytes)) if (x->size > field->data_size - offsetof(pb_bytes_array_t, bytes))
PB_RETURN_ERROR(stream, "bytes overflow"); PB_RETURN_ERROR(stream, "bytes overflow");
@@ -831,12 +691,18 @@ bool checkreturn pb_dec_bytes(pb_istream_t *stream, const pb_field_t *field, voi
bool checkreturn pb_dec_string(pb_istream_t *stream, const pb_field_t *field, void *dest) bool checkreturn pb_dec_string(pb_istream_t *stream, const pb_field_t *field, void *dest)
{ {
uint32_t size; uint32_t size;
size_t alloc_size;
bool status; bool status;
if (!pb_decode_varint32(stream, &size)) if (!pb_decode_varint32(stream, &size))
return false; return false;
alloc_size = size + 1;
if (alloc_size < size)
PB_RETURN_ERROR(stream, "size too large");
/* Check length, noting the null terminator */ /* Check length, noting the null terminator */
if (size + 1 > field->data_size) if (alloc_size > field->data_size)
PB_RETURN_ERROR(stream, "string overflow"); PB_RETURN_ERROR(stream, "string overflow");
status = pb_read(stream, (uint8_t*)dest, size); status = pb_read(stream, (uint8_t*)dest, size);
@@ -858,7 +724,7 @@ bool checkreturn pb_dec_submessage(pb_istream_t *stream, const pb_field_t *field
/* New array entries need to be initialized, while required and optional /* New array entries need to be initialized, while required and optional
* submessages have already been initialized in the top-level pb_decode. */ * submessages have already been initialized in the top-level pb_decode. */
if (PB_HTYPE(field->type) == PB_HTYPE_REPEATED) if (PB_HTYPE(field->type) == PB_HTYPE_ARRAY)
status = pb_decode(&substream, submsg_fields, dest); status = pb_decode(&substream, submsg_fields, dest);
else else
status = pb_decode_noinit(&substream, submsg_fields, dest); status = pb_decode_noinit(&substream, submsg_fields, dest);

View File

@@ -1,83 +1,34 @@
/* pb_decode.h: Functions to decode protocol buffers. Depends on pb_decode.c.
* The main function is pb_decode. You also need an input stream, and the
* field descriptions created by nanopb_generator.py.
*/
#ifndef _PB_DECODE_H_ #ifndef _PB_DECODE_H_
#define _PB_DECODE_H_ #define _PB_DECODE_H_
/* pb_decode.h: Functions to decode protocol buffers. Depends on pb_decode.c.
* The main function is pb_decode. You will also need to create an input
* stream, which is easiest to do with pb_istream_from_buffer().
*
* You also need structures and their corresponding pb_field_t descriptions.
* These are usually generated from .proto-files with a script.
*/
#include <stdbool.h>
#include "pb.h" #include "pb.h"
#ifdef __cplusplus #ifdef __cplusplus
extern "C" { extern "C" {
#endif #endif
/*************************** /* Lightweight input stream.
* Main decoding functions * * You can provide a callback function for reading or use
***************************/ * pb_istream_from_buffer.
/* Decode a single protocol buffers message from input stream into a C structure.
* Returns true on success, false on any failure.
* The actual struct pointed to by dest must match the description in fields.
* Callback fields of the destination structure must be initialized by caller.
* All other fields will be initialized by this function.
*
* Example usage:
* MyMessage msg = {};
* uint8_t buffer[64];
* pb_istream_t stream;
*
* // ... read some data into buffer ...
*
* stream = pb_istream_from_buffer(buffer, count);
* pb_decode(&stream, MyMessage_fields, &msg);
*/
bool pb_decode(pb_istream_t *stream, const pb_field_t fields[], void *dest_struct);
/* Same as pb_decode, except does not initialize the destination structure
* to default values. This is slightly faster if you need no default values
* and just do memset(struct, 0, sizeof(struct)) yourself.
*
* This can also be used for 'merging' two messages, i.e. update only the
* fields that exist in the new message.
*/
bool pb_decode_noinit(pb_istream_t *stream, const pb_field_t fields[], void *dest_struct);
/* Same as pb_decode, except expects the stream to start with the message size
* encoded as varint. Corresponds to parseDelimitedFrom() in Google's
* protobuf API.
*/
bool pb_decode_delimited(pb_istream_t *stream, const pb_field_t fields[], void *dest_struct);
/**************************************
* Functions for manipulating streams *
**************************************/
/* Create an input stream for reading from a memory buffer.
*
* Alternatively, you can use a custom stream that reads directly from e.g.
* a file or a network socket.
*/
pb_istream_t pb_istream_from_buffer(uint8_t *buf, size_t bufsize);
/* Function to read from a pb_istream_t. You can use this if you need to
* read some custom header data, or to read data in field callbacks.
*/
bool pb_read(pb_istream_t *stream, uint8_t *buf, size_t count);
/* Structure for defining custom input streams. You will need to provide
* a callback function to read the bytes from your storage, which can be
* for example a file or a network socket.
* *
* The callback must conform to these rules: * Rules for callback:
*
* 1) Return false on IO errors. This will cause decoding to abort. * 1) Return false on IO errors. This will cause decoding to abort.
*
* 2) You can use state to store your own data (e.g. buffer pointer), * 2) 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. * and rely on pb_read to verify that no-body reads past bytes_left.
*
* 3) Your callback may be used with substreams, in which case bytes_left * 3) Your callback may be used with substreams, in which case bytes_left
* is different than from the main stream. Don't use bytes_left to compute * is different than from the main stream. Don't use bytes_left to compute
* any pointers. * any pointers.
*/ */
struct _pb_istream_t struct _pb_istream_t
{ {
@@ -99,10 +50,24 @@ struct _pb_istream_t
#endif #endif
}; };
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.
* Helper functions for writing field callbacks * * Returns true on success, false on any failure.
************************************************/ * 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);
/* Same as pb_decode, except does not initialize the destination structure
* to default values. This is slightly faster if you need no default values
* and just do memset(struct, 0, sizeof(struct)) yourself.
*/
bool pb_decode_noinit(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.
*/
/* Decode the tag for the next field in the stream. Gives the wire type and /* Decode the tag for the next field in the stream. Gives the wire type and
* field tag. At end of the message, returns false and sets eof to true. */ * field tag. At end of the message, returns false and sets eof to true. */
@@ -131,10 +96,10 @@ bool pb_decode_fixed64(pb_istream_t *stream, void *dest);
bool pb_make_string_substream(pb_istream_t *stream, pb_istream_t *substream); bool pb_make_string_substream(pb_istream_t *stream, pb_istream_t *substream);
void pb_close_string_substream(pb_istream_t *stream, pb_istream_t *substream); void pb_close_string_substream(pb_istream_t *stream, pb_istream_t *substream);
/* --- Internal functions ---
/******************************* * These functions are not terribly useful for the average library user, but
* Internal / legacy functions * * are exported to make the unit testing and extending nanopb easier.
*******************************/ */
#ifdef NANOPB_INTERNALS #ifdef NANOPB_INTERNALS
bool pb_dec_varint(pb_istream_t *stream, const pb_field_t *field, void *dest); bool pb_dec_varint(pb_istream_t *stream, const pb_field_t *field, void *dest);

View File

@@ -6,6 +6,7 @@
#define NANOPB_INTERNALS #define NANOPB_INTERNALS
#include "pb.h" #include "pb.h"
#include "pb_encode.h" #include "pb_encode.h"
#include <string.h>
/* The warn_unused_result attribute appeared first in gcc-3.4.0 */ /* The warn_unused_result attribute appeared first in gcc-3.4.0 */
#if !defined(__GNUC__) || ( __GNUC__ < 3) || (__GNUC__ == 3 && __GNUC_MINOR__ < 4) #if !defined(__GNUC__) || ( __GNUC__ < 3) || (__GNUC__ == 3 && __GNUC_MINOR__ < 4)
@@ -28,8 +29,7 @@ static const pb_encoder_t PB_ENCODERS[PB_LTYPES_COUNT] = {
&pb_enc_bytes, &pb_enc_bytes,
&pb_enc_string, &pb_enc_string,
&pb_enc_submessage, &pb_enc_submessage
NULL /* extensions */
}; };
/* pb_ostream_t implementation */ /* pb_ostream_t implementation */
@@ -56,9 +56,6 @@ pb_ostream_t pb_ostream_from_buffer(uint8_t *buf, size_t bufsize)
stream.state = buf; stream.state = buf;
stream.max_size = bufsize; stream.max_size = bufsize;
stream.bytes_written = 0; stream.bytes_written = 0;
#ifndef PB_NO_ERRMSG
stream.errmsg = NULL;
#endif
return stream; return stream;
} }
@@ -67,14 +64,14 @@ bool checkreturn pb_write(pb_ostream_t *stream, const uint8_t *buf, size_t count
if (stream->callback != NULL) if (stream->callback != NULL)
{ {
if (stream->bytes_written + count > stream->max_size) if (stream->bytes_written + count > stream->max_size)
PB_RETURN_ERROR(stream, "stream full"); return false;
#ifdef PB_BUFFER_ONLY #ifdef PB_BUFFER_ONLY
if (!buf_write(stream, buf, count)) if (!buf_write(stream, buf, count))
PB_RETURN_ERROR(stream, "io error"); return false;
#else #else
if (!stream->callback(stream, buf, count)) if (!stream->callback(stream, buf, count))
PB_RETURN_ERROR(stream, "io error"); return false;
#endif #endif
} }
@@ -84,7 +81,10 @@ bool checkreturn pb_write(pb_ostream_t *stream, const uint8_t *buf, size_t count
/* Main encoding stuff */ /* Main encoding stuff */
/* Encode a static array. Handles the size calculations and possible packing. */ /* 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, static bool checkreturn encode_array(pb_ostream_t *stream, const pb_field_t *field,
const void *pData, size_t count, pb_encoder_t func) const void *pData, size_t count, pb_encoder_t func)
{ {
@@ -95,7 +95,6 @@ static bool checkreturn encode_array(pb_ostream_t *stream, const pb_field_t *fie
if (count == 0) if (count == 0)
return true; return true;
/* We always pack arrays if the datatype allows it. */
if (PB_LTYPE(field->type) <= PB_LTYPE_LAST_PACKABLE) if (PB_LTYPE(field->type) <= PB_LTYPE_LAST_PACKABLE)
{ {
if (!pb_encode_tag(stream, PB_WT_STRING, field->tag)) if (!pb_encode_tag(stream, PB_WT_STRING, field->tag))
@@ -111,8 +110,8 @@ static bool checkreturn encode_array(pb_ostream_t *stream, const pb_field_t *fie
size = 8 * count; size = 8 * count;
} }
else else
{ {
pb_ostream_t sizestream = PB_OSTREAM_SIZING; pb_ostream_t sizestream = {0,0,0,0};
p = pData; p = pData;
for (i = 0; i < count; i++) for (i = 0; i < count; i++)
{ {
@@ -154,155 +153,58 @@ static bool checkreturn encode_array(pb_ostream_t *stream, const pb_field_t *fie
return true; return true;
} }
/* Encode a field with static allocation, i.e. one whose data is stored
* in the structure itself. */
static bool checkreturn encode_static_field(pb_ostream_t *stream,
const pb_field_t *field, const void *pData)
{
pb_encoder_t func;
const void *pSize;
bool dummy = true;
func = PB_ENCODERS[PB_LTYPE(field->type)];
if (field->size_offset)
pSize = (const char*)pData + field->size_offset;
else
pSize = &dummy;
switch (PB_HTYPE(field->type))
{
case PB_HTYPE_REQUIRED:
if (!pb_encode_tag_for_field(stream, field))
return false;
if (!func(stream, field, pData))
return false;
break;
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_REPEATED:
if (!encode_array(stream, field, pData, *(const size_t*)pSize, func))
return false;
break;
default:
PB_RETURN_ERROR(stream, "invalid field type");
}
return true;
}
/* Encode a field with callback semantics. This means that a user function is
* called to provide and encode the actual data. */
static 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;
#ifdef PB_OLD_CALLBACK_STYLE
const void *arg = callback->arg;
#else
void * const *arg = &(callback->arg);
#endif
if (callback->funcs.encode != NULL)
{
if (!callback->funcs.encode(stream, field, arg))
PB_RETURN_ERROR(stream, "callback error");
}
return true;
}
/* Encode a single field of any callback or static type. */
static bool checkreturn encode_field(pb_ostream_t *stream,
const pb_field_t *field, const void *pData)
{
switch (PB_ATYPE(field->type))
{
case PB_ATYPE_STATIC:
return encode_static_field(stream, field, pData);
case PB_ATYPE_CALLBACK:
return encode_callback_field(stream, field, pData);
default:
PB_RETURN_ERROR(stream, "invalid field type");
}
}
/* Default handler for extension fields. Expects to have a pb_field_t
* pointer in the extension->type->arg field. */
static bool checkreturn default_extension_handler(pb_ostream_t *stream,
const pb_extension_t *extension)
{
const pb_field_t *field = (const pb_field_t*)extension->type->arg;
return encode_field(stream, field, extension->dest);
}
/* Walk through all the registered extensions and give them a chance
* to encode themselves. */
static bool checkreturn encode_extension_field(pb_ostream_t *stream,
const pb_field_t *field, const void *pData)
{
const pb_extension_t *extension = *(const pb_extension_t* const *)pData;
UNUSED(field);
while (extension)
{
bool status;
if (extension->type->encode)
status = extension->type->encode(stream, extension);
else
status = default_extension_handler(stream, extension);
if (!status)
return false;
extension = extension->next;
}
return true;
}
bool checkreturn pb_encode(pb_ostream_t *stream, const pb_field_t fields[], const void *src_struct) bool checkreturn pb_encode(pb_ostream_t *stream, const pb_field_t fields[], const void *src_struct)
{ {
const pb_field_t *field = fields; const pb_field_t *field = fields;
const void *pData = src_struct; const void *pData = src_struct;
const void *pSize;
size_t prev_size = 0; size_t prev_size = 0;
while (field->tag != 0) while (field->tag != 0)
{ {
pb_encoder_t func = PB_ENCODERS[PB_LTYPE(field->type)];
pData = (const char*)pData + prev_size + field->data_offset; pData = (const char*)pData + prev_size + field->data_offset;
pSize = (const char*)pData + field->size_offset;
prev_size = field->data_size; prev_size = field->data_size;
if (PB_HTYPE(field->type) == PB_HTYPE_ARRAY)
/* 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; prev_size *= field->array_size;
}
switch (PB_HTYPE(field->type))
if (PB_LTYPE(field->type) == PB_LTYPE_EXTENSION)
{ {
/* Special case for the extension field placeholder */ case PB_HTYPE_REQUIRED:
if (!encode_extension_field(stream, field, pData)) if (!pb_encode_tag_for_field(stream, field))
return false; return false;
} if (!func(stream, field, pData))
else return false;
{ break;
/* Regular field */
if (!encode_field(stream, field, pData)) case PB_HTYPE_OPTIONAL:
return false; 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_ARRAY:
if (!encode_array(stream, field, pData, *(const size_t*)pSize, func))
return false;
break;
case PB_HTYPE_CALLBACK:
{
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;
}
break;
}
} }
field++; field++;
@@ -311,11 +213,6 @@ bool checkreturn pb_encode(pb_ostream_t *stream, const pb_field_t fields[], cons
return true; return true;
} }
bool pb_encode_delimited(pb_ostream_t *stream, const pb_field_t fields[], const void *src_struct)
{
return pb_encode_submessage(stream, fields, src_struct);
}
/* Helper functions */ /* Helper functions */
bool checkreturn pb_encode_varint(pb_ostream_t *stream, uint64_t value) bool checkreturn pb_encode_varint(pb_ostream_t *stream, uint64_t value)
{ {
@@ -412,7 +309,7 @@ bool checkreturn pb_encode_tag_for_field(pb_ostream_t *stream, const pb_field_t
break; break;
default: default:
PB_RETURN_ERROR(stream, "invalid field type"); return false;
} }
return pb_encode_tag(stream, wiretype, field->tag); return pb_encode_tag(stream, wiretype, field->tag);
@@ -429,7 +326,7 @@ bool checkreturn pb_encode_string(pb_ostream_t *stream, const uint8_t *buffer, s
bool checkreturn pb_encode_submessage(pb_ostream_t *stream, const pb_field_t fields[], const void *src_struct) bool checkreturn pb_encode_submessage(pb_ostream_t *stream, const pb_field_t fields[], const void *src_struct)
{ {
/* First calculate the message size using a non-writing substream. */ /* First calculate the message size using a non-writing substream. */
pb_ostream_t substream = PB_OSTREAM_SIZING; pb_ostream_t substream = {0,0,0,0};
size_t size; size_t size;
bool status; bool status;
@@ -445,7 +342,7 @@ bool checkreturn pb_encode_submessage(pb_ostream_t *stream, const pb_field_t fie
return pb_write(stream, NULL, size); /* Just sizing */ return pb_write(stream, NULL, size); /* Just sizing */
if (stream->bytes_written + size > stream->max_size) if (stream->bytes_written + size > stream->max_size)
PB_RETURN_ERROR(stream, "stream full"); return false;
/* Use a substream to verify that a callback doesn't write more than /* Use a substream to verify that a callback doesn't write more than
* what it did the first time. */ * what it did the first time. */
@@ -453,20 +350,14 @@ bool checkreturn pb_encode_submessage(pb_ostream_t *stream, const pb_field_t fie
substream.state = stream->state; substream.state = stream->state;
substream.max_size = size; substream.max_size = size;
substream.bytes_written = 0; substream.bytes_written = 0;
#ifndef PB_NO_ERRMSG
substream.errmsg = NULL;
#endif
status = pb_encode(&substream, fields, src_struct); status = pb_encode(&substream, fields, src_struct);
stream->bytes_written += substream.bytes_written; stream->bytes_written += substream.bytes_written;
stream->state = substream.state; stream->state = substream.state;
#ifndef PB_NO_ERRMSG
stream->errmsg = substream.errmsg;
#endif
if (substream.bytes_written != size) if (substream.bytes_written != size)
PB_RETURN_ERROR(stream, "submsg size changed"); return false;
return status; return status;
} }
@@ -483,7 +374,7 @@ bool checkreturn pb_enc_varint(pb_ostream_t *stream, const pb_field_t *field, co
case 2: value = *(const uint16_t*)src; break; case 2: value = *(const uint16_t*)src; break;
case 4: value = *(const uint32_t*)src; break; case 4: value = *(const uint32_t*)src; break;
case 8: value = *(const uint64_t*)src; break; case 8: value = *(const uint64_t*)src; break;
default: PB_RETURN_ERROR(stream, "invalid data_size"); default: return false;
} }
return pb_encode_varint(stream, value); return pb_encode_varint(stream, value);
@@ -497,7 +388,7 @@ bool checkreturn pb_enc_svarint(pb_ostream_t *stream, const pb_field_t *field, c
{ {
case 4: value = *(const int32_t*)src; break; case 4: value = *(const int32_t*)src; break;
case 8: value = *(const int64_t*)src; break; case 8: value = *(const int64_t*)src; break;
default: PB_RETURN_ERROR(stream, "invalid data_size"); default: return false;
} }
return pb_encode_svarint(stream, value); return pb_encode_svarint(stream, value);
@@ -524,22 +415,14 @@ bool checkreturn pb_enc_bytes(pb_ostream_t *stream, const pb_field_t *field, con
bool checkreturn 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)
{ {
/* strnlen() is not always available, so just use a for-loop */ UNUSED(field);
size_t size = 0; return pb_encode_string(stream, (const uint8_t*)src, strlen((const char*)src));
const char *p = (const char*)src;
while (size < field->data_size && *p != '\0')
{
size++;
p++;
}
return pb_encode_string(stream, (const uint8_t*)src, size);
} }
bool checkreturn 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)
{ {
if (field->ptr == NULL) if (field->ptr == NULL)
PB_RETURN_ERROR(stream, "invalid field descriptor"); return false;
return pb_encode_submessage(stream, (const pb_field_t*)field->ptr, src); return pb_encode_submessage(stream, (const pb_field_t*)field->ptr, src);
} }

View File

@@ -1,86 +1,34 @@
/* pb_encode.h: Functions to encode protocol buffers. Depends on pb_encode.c.
* The main function is pb_encode. You also need an output stream, and the
* field descriptions created by nanopb_generator.py.
*/
#ifndef _PB_ENCODE_H_ #ifndef _PB_ENCODE_H_
#define _PB_ENCODE_H_ #define _PB_ENCODE_H_
/* pb_encode.h: Functions to encode protocol buffers. Depends on pb_encode.c.
* The main function is pb_encode. You also need an output stream, structures
* and their field descriptions (just like with pb_decode).
*/
#include <stdbool.h>
#include "pb.h" #include "pb.h"
#ifdef __cplusplus #ifdef __cplusplus
extern "C" { extern "C" {
#endif #endif
/*************************** /* Lightweight output stream.
* Main encoding functions * * You can provide callback for writing or use pb_ostream_from_buffer.
***************************/
/* Encode a single protocol buffers message from C structure into a stream.
* Returns true on success, false on any failure.
* The actual struct pointed to by src_struct must match the description in fields.
* All required fields in the struct are assumed to have been filled in.
*
* Example usage:
* MyMessage msg = {};
* uint8_t buffer[64];
* pb_ostream_t stream;
*
* msg.field1 = 42;
* stream = pb_ostream_from_buffer(buffer, sizeof(buffer));
* pb_encode(&stream, MyMessage_fields, &msg);
*/
bool pb_encode(pb_ostream_t *stream, const pb_field_t fields[], const void *src_struct);
/* Same as pb_encode, but prepends the length of the message as a varint.
* Corresponds to writeDelimitedTo() in Google's protobuf API.
*/
bool pb_encode_delimited(pb_ostream_t *stream, const pb_field_t fields[], const void *src_struct);
/**************************************
* Functions for manipulating streams *
**************************************/
/* Create an output stream for writing into a memory buffer.
* The number of bytes written can be found in stream.bytes_written after
* encoding the message.
*
* Alternatively, you can use a custom stream that writes directly to e.g.
* a file or a network socket.
*/
pb_ostream_t pb_ostream_from_buffer(uint8_t *buf, size_t bufsize);
/* Pseudo-stream for measuring the size of a message without actually storing
* the encoded data.
* *
* Example usage: * Alternatively, callback can be NULL in which case the stream will just
* MyMessage msg = {}; * count the number of bytes that would have been written. In this case
* pb_ostream_t stream = PB_OSTREAM_SIZING; * max_size is not checked.
* pb_encode(&stream, MyMessage_fields, &msg);
* printf("Message size is %d\n", stream.bytes_written);
*/
#ifndef PB_NO_ERRMSG
#define PB_OSTREAM_SIZING {0,0,0,0,0}
#else
#define PB_OSTREAM_SIZING {0,0,0,0}
#endif
/* Function to write into a pb_ostream_t stream. You can use this if you need
* to append or prepend some custom headers to the message.
*/
bool pb_write(pb_ostream_t *stream, const uint8_t *buf, size_t count);
/* Structure for defining custom output streams. You will need to provide
* a callback function to write the bytes to your storage, which can be
* for example a file or a network socket.
*
* The callback must conform to these rules:
* *
* Rules for callback:
* 1) Return false on IO errors. This will cause encoding to abort. * 1) Return false on IO errors. This will cause encoding to abort.
*
* 2) You can use state to store your own data (e.g. buffer pointer). * 2) You can use state to store your own data (e.g. buffer pointer).
*
* 3) pb_write will update bytes_written after your callback runs. * 3) pb_write will update bytes_written after your callback runs.
* 4) Substreams will modify max_size and bytes_written. Don't use them *
* to calculate any pointers. * 4) Substreams will modify max_size and bytes_written. Don't use them to
* calculate any pointers.
*/ */
struct _pb_ostream_t struct _pb_ostream_t
{ {
@@ -95,26 +43,31 @@ struct _pb_ostream_t
#else #else
bool (*callback)(pb_ostream_t *stream, const uint8_t *buf, size_t count); bool (*callback)(pb_ostream_t *stream, const uint8_t *buf, size_t count);
#endif #endif
void *state; /* Free field for use by callback implementation. */ void *state; /* Free field for use by callback implementation */
size_t max_size; /* Limit number of output bytes written (or use SIZE_MAX). */ size_t max_size; /* Limit number of output bytes written (or use SIZE_MAX). */
size_t bytes_written; /* Number of bytes written so far. */ size_t bytes_written;
#ifndef PB_NO_ERRMSG
const char *errmsg;
#endif
}; };
pb_ostream_t pb_ostream_from_buffer(uint8_t *buf, size_t bufsize);
bool pb_write(pb_ostream_t *stream, const uint8_t *buf, size_t count);
/************************************************ /* Encode struct to given output stream.
* Helper functions for writing field callbacks * * Returns true on success, false on any failure.
************************************************/ * The actual struct pointed to by src_struct must match the description in fields.
* All required fields in the struct are assumed to have been filled in.
*/
bool pb_encode(pb_ostream_t *stream, const pb_field_t fields[], const void *src_struct);
/* Encode field header based on type and field number defined in the field /* --- Helper functions ---
* structure. Call this from the callback before writing out field contents. */ * You may want to use these from your caller or callbacks.
*/
/* Encode field header based on LTYPE and field number defined in the field structure.
* Call this from the callback before writing out field contents. */
bool pb_encode_tag_for_field(pb_ostream_t *stream, const pb_field_t *field); bool pb_encode_tag_for_field(pb_ostream_t *stream, const pb_field_t *field);
/* Encode field header by manually specifing wire type. You need to use this /* Encode field header by manually specifing wire type. You need to use this if
* if you want to write out packed arrays from a callback field. */ * you want to write out packed arrays from a callback field. */
bool pb_encode_tag(pb_ostream_t *stream, pb_wire_type_t wiretype, uint32_t field_number); bool pb_encode_tag(pb_ostream_t *stream, pb_wire_type_t wiretype, uint32_t field_number);
/* Encode an integer in the varint format. /* Encode an integer in the varint format.
@@ -137,16 +90,15 @@ bool pb_encode_fixed32(pb_ostream_t *stream, const void *value);
bool pb_encode_fixed64(pb_ostream_t *stream, const void *value); bool pb_encode_fixed64(pb_ostream_t *stream, const void *value);
/* Encode a submessage field. /* Encode a submessage field.
* You need to pass the pb_field_t array and pointer to struct, just like * You need to pass the pb_field_t array and pointer to struct, just like with pb_encode().
* with pb_encode(). This internally encodes the submessage twice, first to * This internally encodes the submessage twice, first to calculate message size and then to actually write it out.
* calculate message size and then to actually write it out.
*/ */
bool pb_encode_submessage(pb_ostream_t *stream, const pb_field_t fields[], const void *src_struct); bool pb_encode_submessage(pb_ostream_t *stream, const pb_field_t fields[], const void *src_struct);
/* --- Internal functions ---
/******************************* * These functions are not terribly useful for the average library user, but
* Internal / legacy functions * * are exported to make the unit testing and extending nanopb easier.
*******************************/ */
#ifdef NANOPB_INTERNALS #ifdef NANOPB_INTERNALS
bool pb_enc_varint(pb_ostream_t *stream, const pb_field_t *field, const void *src); bool pb_enc_varint(pb_ostream_t *stream, const pb_field_t *field, const void *src);

View File

@@ -8,28 +8,20 @@ TESTS= decode_unittests encode_unittests \
test_decode_callbacks test_encode_callbacks \ test_decode_callbacks test_encode_callbacks \
test_missing_fields test_no_messages test_funny_name \ test_missing_fields test_no_messages test_funny_name \
test_multiple_files test_cxxcompile test_options \ test_multiple_files test_cxxcompile test_options \
bc_encode bc_decode test_encode_extensions test_decode_extensions bc_encode bc_decode
# More strict checks for the core part of nanopb # More strict checks for the core part of nanopb
CC_VERSION=$(shell $(CC) -v 2>&1) CC_VERSION=$(shell $(CC) -v 2>&1)
CFLAGS_CORE= CFLAGS_CORE=
ifneq (,$(findstring gcc,$(CC_VERSION))) ifneq (,$(findstring gcc,$(CC_VERSION)))
CFLAGS_CORE=-pedantic -Wextra -Wcast-qual -Wlogical-op -Wconversion CFLAGS_CORE=-pedantic -Wextra -Wcast-qual -Wlogical-op -Wconversion
CFLAGS+=--coverage -fstack-protector-all CFLAGS+=--coverage
LDFLAGS+=--coverage LDFLAGS+=--coverage
endif endif
ifneq (,$(findstring clang,$(CC_VERSION))) ifneq (,$(findstring clang,$(CC_VERSION)))
CFLAGS_CORE=-pedantic -Wextra -Wcast-qual -Wconversion CFLAGS_CORE=-pedantic -Wextra -Wcast-qual -Wconversion
endif endif
# Also use mudflap if it is available
# To enable, run with make -B USE_MUDFLAP=y
USE_MUDFLAP ?= n
ifeq ($(USE_MUDFLAP),y)
CFLAGS += -fmudflap
LDFLAGS += -lmudflap -fmudflap
endif
all: breakpoints $(TESTS) run_unittests all: breakpoints $(TESTS) run_unittests
clean: clean:
@@ -84,8 +76,6 @@ test_no_messages: no_messages.pb.h no_messages.pb.c no_messages.pb.o
test_funny_name: funny-proto+name.pb.h funny-proto+name.pb.o test_funny_name: funny-proto+name.pb.h funny-proto+name.pb.o
bc_encode: bc_alltypes.pb.o pb_encode.o bc_encode.o bc_encode: bc_alltypes.pb.o pb_encode.o bc_encode.o
bc_decode: bc_alltypes.pb.o pb_decode.o bc_decode.o bc_decode: bc_alltypes.pb.o pb_decode.o bc_decode.o
test_encode_extensions: test_encode_extensions.c pb_encode.o alltypes.pb.o extensions.pb.o
test_decode_extensions: test_decode_extensions.c pb_decode.o alltypes.pb.o extensions.pb.o
%.pb: %.proto %.pb: %.proto
protoc -I. -I../generator -I/usr/include -o$@ $< protoc -I. -I../generator -I/usr/include -o$@ $<
@@ -125,10 +115,8 @@ run_unittests: $(TESTS)
./test_encode3 1 | ./test_decode3 1 ./test_encode3 1 | ./test_decode3 1
./test_encode3 1 | protoc --decode=AllTypes -I. -I../generator -I/usr/include alltypes.proto >/dev/null ./test_encode3 1 | protoc --decode=AllTypes -I. -I../generator -I/usr/include alltypes.proto >/dev/null
./test_encode3_buf 1 | ./test_decode3_buf 1 ./test_encode3_buf 1 | ./test_decode3_buf 1
./test_decode3 < alltypes_with_extra_fields.pb
./bc_encode | ./bc_decode ./bc_encode | ./bc_decode
./test_encode_extensions | ./test_decode_extensions
./test_missing_fields ./test_missing_fields
test_options: options.pb.h options.expected options.pb.o test_options: options.pb.h options.expected options.pb.o
@@ -139,5 +127,5 @@ test_options: options.pb.h options.expected options.pb.o
fi \ fi \
done done
run_fuzztest: test_decode3 run_fuzztest: test_decode2
bash -c 'ulimit -c unlimited; I=1; while true; do cat /dev/urandom | ./test_decode3 > /dev/null; I=$$(($$I+1)); echo -en "\r$$I"; done' bash -c 'I=1; while true; do cat /dev/urandom | ./test_decode2 > /dev/null; I=$$(($$I+1)); echo -en "\r$$I"; done'

View File

@@ -1,3 +0,0 @@
* max_size:16
* max_count:5

View File

@@ -1,13 +1,11 @@
import "nanopb.proto";
message SubMessage { message SubMessage {
required string substuff1 = 1 [default = "1"]; required string substuff1 = 1 [(nanopb).max_size = 16, default = "1"];
required int32 substuff2 = 2 [default = 2]; required int32 substuff2 = 2 [default = 2];
optional fixed32 substuff3 = 3 [default = 3]; optional fixed32 substuff3 = 3 [default = 3];
} }
message EmptyMessage {
}
enum MyEnum { enum MyEnum {
Zero = 0; Zero = 0;
First = 1; First = 1;
@@ -32,34 +30,32 @@ message AllTypes {
required sfixed64 req_sfixed64= 12; required sfixed64 req_sfixed64= 12;
required double req_double = 13; required double req_double = 13;
required string req_string = 14; required string req_string = 14 [(nanopb).max_size = 16];
required bytes req_bytes = 15; required bytes req_bytes = 15 [(nanopb).max_size = 16];
required SubMessage req_submsg = 16; required SubMessage req_submsg = 16;
required MyEnum req_enum = 17; required MyEnum req_enum = 17;
required EmptyMessage req_emptymsg = 18;
repeated int32 rep_int32 = 21; repeated int32 rep_int32 = 21 [(nanopb).max_count = 5];
repeated int64 rep_int64 = 22; repeated int64 rep_int64 = 22 [(nanopb).max_count = 5];
repeated uint32 rep_uint32 = 23; repeated uint32 rep_uint32 = 23 [(nanopb).max_count = 5];
repeated uint64 rep_uint64 = 24; repeated uint64 rep_uint64 = 24 [(nanopb).max_count = 5];
repeated sint32 rep_sint32 = 25; repeated sint32 rep_sint32 = 25 [(nanopb).max_count = 5];
repeated sint64 rep_sint64 = 26; repeated sint64 rep_sint64 = 26 [(nanopb).max_count = 5];
repeated bool rep_bool = 27; repeated bool rep_bool = 27 [(nanopb).max_count = 5];
repeated fixed32 rep_fixed32 = 28; repeated fixed32 rep_fixed32 = 28 [(nanopb).max_count = 5];
repeated sfixed32 rep_sfixed32= 29; repeated sfixed32 rep_sfixed32= 29 [(nanopb).max_count = 5];
repeated float rep_float = 30; repeated float rep_float = 30 [(nanopb).max_count = 5];
repeated fixed64 rep_fixed64 = 31; repeated fixed64 rep_fixed64 = 31 [(nanopb).max_count = 5];
repeated sfixed64 rep_sfixed64= 32; repeated sfixed64 rep_sfixed64= 32 [(nanopb).max_count = 5];
repeated double rep_double = 33; repeated double rep_double = 33 [(nanopb).max_count = 5];
repeated string rep_string = 34; repeated string rep_string = 34 [(nanopb).max_size = 16, (nanopb).max_count = 5];
repeated bytes rep_bytes = 35; repeated bytes rep_bytes = 35 [(nanopb).max_size = 16, (nanopb).max_count = 5];
repeated SubMessage rep_submsg = 36; repeated SubMessage rep_submsg = 36 [(nanopb).max_count = 5];
repeated MyEnum rep_enum = 37; repeated MyEnum rep_enum = 37 [(nanopb).max_count = 5];
repeated EmptyMessage rep_emptymsg = 38;
optional int32 opt_int32 = 41 [default = 4041]; optional int32 opt_int32 = 41 [default = 4041];
optional int64 opt_int64 = 42 [default = 4042]; optional int64 opt_int64 = 42 [default = 4042];
@@ -77,17 +73,13 @@ message AllTypes {
optional sfixed64 opt_sfixed64= 52 [default = 4052]; optional sfixed64 opt_sfixed64= 52 [default = 4052];
optional double opt_double = 53 [default = 4053]; optional double opt_double = 53 [default = 4053];
optional string opt_string = 54 [default = "4054"]; optional string opt_string = 54 [(nanopb).max_size = 16, default = "4054"];
optional bytes opt_bytes = 55 [default = "4055"]; optional bytes opt_bytes = 55 [(nanopb).max_size = 16, default = "4055"];
optional SubMessage opt_submsg = 56; optional SubMessage opt_submsg = 56;
optional MyEnum opt_enum = 57 [default = Second]; optional MyEnum opt_enum = 57 [default = Second];
optional EmptyMessage opt_emptymsg = 58;
// Just to make sure that the size of the fields has been calculated // Just to make sure that the size of the fields has been calculated
// properly, i.e. otherwise a bug in last field might not be detected. // properly, i.e. otherwise a bug in last field might not be detected.
required int32 end = 99; required int32 end = 99;
extensions 200 to 255;
} }

Binary file not shown.

View File

@@ -1,13 +1,7 @@
/* Automatically generated nanopb constant definitions */ /* Automatically generated nanopb constant definitions */
/* Generated by 0.2.0-dev at Sun Feb 17 00:09:53 2013. */
/* This is a file generated using nanopb-0.2.0-dev.
* It is used as a part of test suite in order to detect any
* incompatible changes made to the generator in future versions.
*/
#include "bc_alltypes.pb.h" #include "bc_alltypes.pb.h"
const char SubMessage_substuff1_default[16] = "1"; const char SubMessage_substuff1_default[17] = "1";
const int32_t SubMessage_substuff2_default = 2; const int32_t SubMessage_substuff2_default = 2;
const uint32_t SubMessage_substuff3_default = 3; const uint32_t SubMessage_substuff3_default = 3;
const int32_t AllTypes_opt_int32_default = 4041; const int32_t AllTypes_opt_int32_default = 4041;
@@ -23,71 +17,310 @@ const float AllTypes_opt_float_default = 4050;
const uint64_t AllTypes_opt_fixed64_default = 4051; const uint64_t AllTypes_opt_fixed64_default = 4051;
const int64_t AllTypes_opt_sfixed64_default = 4052; const int64_t AllTypes_opt_sfixed64_default = 4052;
const double AllTypes_opt_double_default = 4053; const double AllTypes_opt_double_default = 4053;
const char AllTypes_opt_string_default[16] = "4054"; const char AllTypes_opt_string_default[17] = "4054";
const AllTypes_opt_bytes_t AllTypes_opt_bytes_default = {4, {0x34,0x30,0x35,0x35}}; const AllTypes_opt_bytes_t AllTypes_opt_bytes_default = {4, {0x34,0x30,0x35,0x35}};
const MyEnum AllTypes_opt_enum_default = MyEnum_Second; const MyEnum AllTypes_opt_enum_default = MyEnum_Second;
const pb_field_t SubMessage_fields[4] = { const pb_field_t SubMessage_fields[4] = {
PB_FIELD( 1, STRING , REQUIRED, STATIC, SubMessage, substuff1, substuff1, &SubMessage_substuff1_default), {1, PB_HTYPE_REQUIRED | PB_LTYPE_STRING,
PB_FIELD( 2, INT32 , REQUIRED, STATIC, SubMessage, substuff2, substuff1, &SubMessage_substuff2_default), offsetof(SubMessage, substuff1), 0,
PB_FIELD( 3, FIXED32 , OPTIONAL, STATIC, SubMessage, substuff3, substuff2, &SubMessage_substuff3_default), pb_membersize(SubMessage, substuff1), 0,
&SubMessage_substuff1_default},
{2, PB_HTYPE_REQUIRED | PB_LTYPE_VARINT,
pb_delta_end(SubMessage, substuff2, substuff1), 0,
pb_membersize(SubMessage, substuff2), 0,
&SubMessage_substuff2_default},
{3, PB_HTYPE_OPTIONAL | PB_LTYPE_FIXED32,
pb_delta_end(SubMessage, substuff3, substuff2),
pb_delta(SubMessage, has_substuff3, substuff3),
pb_membersize(SubMessage, substuff3), 0,
&SubMessage_substuff3_default},
PB_LAST_FIELD PB_LAST_FIELD
}; };
const pb_field_t AllTypes_fields[53] = { const pb_field_t AllTypes_fields[53] = {
PB_FIELD( 1, INT32 , REQUIRED, STATIC, AllTypes, req_int32, req_int32, 0), {1, PB_HTYPE_REQUIRED | PB_LTYPE_VARINT,
PB_FIELD( 2, INT64 , REQUIRED, STATIC, AllTypes, req_int64, req_int32, 0), offsetof(AllTypes, req_int32), 0,
PB_FIELD( 3, UINT32 , REQUIRED, STATIC, AllTypes, req_uint32, req_int64, 0), pb_membersize(AllTypes, req_int32), 0, 0},
PB_FIELD( 4, UINT64 , REQUIRED, STATIC, AllTypes, req_uint64, req_uint32, 0),
PB_FIELD( 5, SINT32 , REQUIRED, STATIC, AllTypes, req_sint32, req_uint64, 0), {2, PB_HTYPE_REQUIRED | PB_LTYPE_VARINT,
PB_FIELD( 6, SINT64 , REQUIRED, STATIC, AllTypes, req_sint64, req_sint32, 0), pb_delta_end(AllTypes, req_int64, req_int32), 0,
PB_FIELD( 7, BOOL , REQUIRED, STATIC, AllTypes, req_bool, req_sint64, 0), pb_membersize(AllTypes, req_int64), 0, 0},
PB_FIELD( 8, FIXED32 , REQUIRED, STATIC, AllTypes, req_fixed32, req_bool, 0),
PB_FIELD( 9, SFIXED32, REQUIRED, STATIC, AllTypes, req_sfixed32, req_fixed32, 0), {3, PB_HTYPE_REQUIRED | PB_LTYPE_VARINT,
PB_FIELD( 10, FLOAT , REQUIRED, STATIC, AllTypes, req_float, req_sfixed32, 0), pb_delta_end(AllTypes, req_uint32, req_int64), 0,
PB_FIELD( 11, FIXED64 , REQUIRED, STATIC, AllTypes, req_fixed64, req_float, 0), pb_membersize(AllTypes, req_uint32), 0, 0},
PB_FIELD( 12, SFIXED64, REQUIRED, STATIC, AllTypes, req_sfixed64, req_fixed64, 0),
PB_FIELD( 13, DOUBLE , REQUIRED, STATIC, AllTypes, req_double, req_sfixed64, 0), {4, PB_HTYPE_REQUIRED | PB_LTYPE_VARINT,
PB_FIELD( 14, STRING , REQUIRED, STATIC, AllTypes, req_string, req_double, 0), pb_delta_end(AllTypes, req_uint64, req_uint32), 0,
PB_FIELD( 15, BYTES , REQUIRED, STATIC, AllTypes, req_bytes, req_string, 0), pb_membersize(AllTypes, req_uint64), 0, 0},
PB_FIELD( 16, MESSAGE , REQUIRED, STATIC, AllTypes, req_submsg, req_bytes, &SubMessage_fields),
PB_FIELD( 17, ENUM , REQUIRED, STATIC, AllTypes, req_enum, req_submsg, 0), {5, PB_HTYPE_REQUIRED | PB_LTYPE_SVARINT,
PB_FIELD( 21, INT32 , REPEATED, STATIC, AllTypes, rep_int32, req_enum, 0), pb_delta_end(AllTypes, req_sint32, req_uint64), 0,
PB_FIELD( 22, INT64 , REPEATED, STATIC, AllTypes, rep_int64, rep_int32, 0), pb_membersize(AllTypes, req_sint32), 0, 0},
PB_FIELD( 23, UINT32 , REPEATED, STATIC, AllTypes, rep_uint32, rep_int64, 0),
PB_FIELD( 24, UINT64 , REPEATED, STATIC, AllTypes, rep_uint64, rep_uint32, 0), {6, PB_HTYPE_REQUIRED | PB_LTYPE_SVARINT,
PB_FIELD( 25, SINT32 , REPEATED, STATIC, AllTypes, rep_sint32, rep_uint64, 0), pb_delta_end(AllTypes, req_sint64, req_sint32), 0,
PB_FIELD( 26, SINT64 , REPEATED, STATIC, AllTypes, rep_sint64, rep_sint32, 0), pb_membersize(AllTypes, req_sint64), 0, 0},
PB_FIELD( 27, BOOL , REPEATED, STATIC, AllTypes, rep_bool, rep_sint64, 0),
PB_FIELD( 28, FIXED32 , REPEATED, STATIC, AllTypes, rep_fixed32, rep_bool, 0), {7, PB_HTYPE_REQUIRED | PB_LTYPE_VARINT,
PB_FIELD( 29, SFIXED32, REPEATED, STATIC, AllTypes, rep_sfixed32, rep_fixed32, 0), pb_delta_end(AllTypes, req_bool, req_sint64), 0,
PB_FIELD( 30, FLOAT , REPEATED, STATIC, AllTypes, rep_float, rep_sfixed32, 0), pb_membersize(AllTypes, req_bool), 0, 0},
PB_FIELD( 31, FIXED64 , REPEATED, STATIC, AllTypes, rep_fixed64, rep_float, 0),
PB_FIELD( 32, SFIXED64, REPEATED, STATIC, AllTypes, rep_sfixed64, rep_fixed64, 0), {8, PB_HTYPE_REQUIRED | PB_LTYPE_FIXED32,
PB_FIELD( 33, DOUBLE , REPEATED, STATIC, AllTypes, rep_double, rep_sfixed64, 0), pb_delta_end(AllTypes, req_fixed32, req_bool), 0,
PB_FIELD( 34, STRING , REPEATED, STATIC, AllTypes, rep_string, rep_double, 0), pb_membersize(AllTypes, req_fixed32), 0, 0},
PB_FIELD( 35, BYTES , REPEATED, STATIC, AllTypes, rep_bytes, rep_string, 0),
PB_FIELD( 36, MESSAGE , REPEATED, STATIC, AllTypes, rep_submsg, rep_bytes, &SubMessage_fields), {9, PB_HTYPE_REQUIRED | PB_LTYPE_FIXED32,
PB_FIELD( 37, ENUM , REPEATED, STATIC, AllTypes, rep_enum, rep_submsg, 0), pb_delta_end(AllTypes, req_sfixed32, req_fixed32), 0,
PB_FIELD( 41, INT32 , OPTIONAL, STATIC, AllTypes, opt_int32, rep_enum, &AllTypes_opt_int32_default), pb_membersize(AllTypes, req_sfixed32), 0, 0},
PB_FIELD( 42, INT64 , OPTIONAL, STATIC, AllTypes, opt_int64, opt_int32, &AllTypes_opt_int64_default),
PB_FIELD( 43, UINT32 , OPTIONAL, STATIC, AllTypes, opt_uint32, opt_int64, &AllTypes_opt_uint32_default), {10, PB_HTYPE_REQUIRED | PB_LTYPE_FIXED32,
PB_FIELD( 44, UINT64 , OPTIONAL, STATIC, AllTypes, opt_uint64, opt_uint32, &AllTypes_opt_uint64_default), pb_delta_end(AllTypes, req_float, req_sfixed32), 0,
PB_FIELD( 45, SINT32 , OPTIONAL, STATIC, AllTypes, opt_sint32, opt_uint64, &AllTypes_opt_sint32_default), pb_membersize(AllTypes, req_float), 0, 0},
PB_FIELD( 46, SINT64 , OPTIONAL, STATIC, AllTypes, opt_sint64, opt_sint32, &AllTypes_opt_sint64_default),
PB_FIELD( 47, BOOL , OPTIONAL, STATIC, AllTypes, opt_bool, opt_sint64, &AllTypes_opt_bool_default), {11, PB_HTYPE_REQUIRED | PB_LTYPE_FIXED64,
PB_FIELD( 48, FIXED32 , OPTIONAL, STATIC, AllTypes, opt_fixed32, opt_bool, &AllTypes_opt_fixed32_default), pb_delta_end(AllTypes, req_fixed64, req_float), 0,
PB_FIELD( 49, SFIXED32, OPTIONAL, STATIC, AllTypes, opt_sfixed32, opt_fixed32, &AllTypes_opt_sfixed32_default), pb_membersize(AllTypes, req_fixed64), 0, 0},
PB_FIELD( 50, FLOAT , OPTIONAL, STATIC, AllTypes, opt_float, opt_sfixed32, &AllTypes_opt_float_default),
PB_FIELD( 51, FIXED64 , OPTIONAL, STATIC, AllTypes, opt_fixed64, opt_float, &AllTypes_opt_fixed64_default), {12, PB_HTYPE_REQUIRED | PB_LTYPE_FIXED64,
PB_FIELD( 52, SFIXED64, OPTIONAL, STATIC, AllTypes, opt_sfixed64, opt_fixed64, &AllTypes_opt_sfixed64_default), pb_delta_end(AllTypes, req_sfixed64, req_fixed64), 0,
PB_FIELD( 53, DOUBLE , OPTIONAL, STATIC, AllTypes, opt_double, opt_sfixed64, &AllTypes_opt_double_default), pb_membersize(AllTypes, req_sfixed64), 0, 0},
PB_FIELD( 54, STRING , OPTIONAL, STATIC, AllTypes, opt_string, opt_double, &AllTypes_opt_string_default),
PB_FIELD( 55, BYTES , OPTIONAL, STATIC, AllTypes, opt_bytes, opt_string, &AllTypes_opt_bytes_default), {13, PB_HTYPE_REQUIRED | PB_LTYPE_FIXED64,
PB_FIELD( 56, MESSAGE , OPTIONAL, STATIC, AllTypes, opt_submsg, opt_bytes, &SubMessage_fields), pb_delta_end(AllTypes, req_double, req_sfixed64), 0,
PB_FIELD( 57, ENUM , OPTIONAL, STATIC, AllTypes, opt_enum, opt_submsg, &AllTypes_opt_enum_default), pb_membersize(AllTypes, req_double), 0, 0},
PB_FIELD( 99, INT32 , REQUIRED, STATIC, AllTypes, end, opt_enum, 0),
{14, PB_HTYPE_REQUIRED | PB_LTYPE_STRING,
pb_delta_end(AllTypes, req_string, req_double), 0,
pb_membersize(AllTypes, req_string), 0, 0},
{15, PB_HTYPE_REQUIRED | PB_LTYPE_BYTES,
pb_delta_end(AllTypes, req_bytes, req_string), 0,
pb_membersize(AllTypes, req_bytes), 0, 0},
{16, PB_HTYPE_REQUIRED | PB_LTYPE_SUBMESSAGE,
pb_delta_end(AllTypes, req_submsg, req_bytes), 0,
pb_membersize(AllTypes, req_submsg), 0,
&SubMessage_fields},
{17, PB_HTYPE_REQUIRED | PB_LTYPE_VARINT,
pb_delta_end(AllTypes, req_enum, req_submsg), 0,
pb_membersize(AllTypes, req_enum), 0, 0},
{21, PB_HTYPE_ARRAY | PB_LTYPE_VARINT,
pb_delta_end(AllTypes, rep_int32, req_enum),
pb_delta(AllTypes, rep_int32_count, rep_int32),
pb_membersize(AllTypes, rep_int32[0]),
pb_membersize(AllTypes, rep_int32) / pb_membersize(AllTypes, rep_int32[0]), 0},
{22, PB_HTYPE_ARRAY | PB_LTYPE_VARINT,
pb_delta_end(AllTypes, rep_int64, rep_int32),
pb_delta(AllTypes, rep_int64_count, rep_int64),
pb_membersize(AllTypes, rep_int64[0]),
pb_membersize(AllTypes, rep_int64) / pb_membersize(AllTypes, rep_int64[0]), 0},
{23, PB_HTYPE_ARRAY | PB_LTYPE_VARINT,
pb_delta_end(AllTypes, rep_uint32, rep_int64),
pb_delta(AllTypes, rep_uint32_count, rep_uint32),
pb_membersize(AllTypes, rep_uint32[0]),
pb_membersize(AllTypes, rep_uint32) / pb_membersize(AllTypes, rep_uint32[0]), 0},
{24, PB_HTYPE_ARRAY | PB_LTYPE_VARINT,
pb_delta_end(AllTypes, rep_uint64, rep_uint32),
pb_delta(AllTypes, rep_uint64_count, rep_uint64),
pb_membersize(AllTypes, rep_uint64[0]),
pb_membersize(AllTypes, rep_uint64) / pb_membersize(AllTypes, rep_uint64[0]), 0},
{25, PB_HTYPE_ARRAY | PB_LTYPE_SVARINT,
pb_delta_end(AllTypes, rep_sint32, rep_uint64),
pb_delta(AllTypes, rep_sint32_count, rep_sint32),
pb_membersize(AllTypes, rep_sint32[0]),
pb_membersize(AllTypes, rep_sint32) / pb_membersize(AllTypes, rep_sint32[0]), 0},
{26, PB_HTYPE_ARRAY | PB_LTYPE_SVARINT,
pb_delta_end(AllTypes, rep_sint64, rep_sint32),
pb_delta(AllTypes, rep_sint64_count, rep_sint64),
pb_membersize(AllTypes, rep_sint64[0]),
pb_membersize(AllTypes, rep_sint64) / pb_membersize(AllTypes, rep_sint64[0]), 0},
{27, PB_HTYPE_ARRAY | PB_LTYPE_VARINT,
pb_delta_end(AllTypes, rep_bool, rep_sint64),
pb_delta(AllTypes, rep_bool_count, rep_bool),
pb_membersize(AllTypes, rep_bool[0]),
pb_membersize(AllTypes, rep_bool) / pb_membersize(AllTypes, rep_bool[0]), 0},
{28, PB_HTYPE_ARRAY | PB_LTYPE_FIXED32,
pb_delta_end(AllTypes, rep_fixed32, rep_bool),
pb_delta(AllTypes, rep_fixed32_count, rep_fixed32),
pb_membersize(AllTypes, rep_fixed32[0]),
pb_membersize(AllTypes, rep_fixed32) / pb_membersize(AllTypes, rep_fixed32[0]), 0},
{29, PB_HTYPE_ARRAY | PB_LTYPE_FIXED32,
pb_delta_end(AllTypes, rep_sfixed32, rep_fixed32),
pb_delta(AllTypes, rep_sfixed32_count, rep_sfixed32),
pb_membersize(AllTypes, rep_sfixed32[0]),
pb_membersize(AllTypes, rep_sfixed32) / pb_membersize(AllTypes, rep_sfixed32[0]), 0},
{30, PB_HTYPE_ARRAY | PB_LTYPE_FIXED32,
pb_delta_end(AllTypes, rep_float, rep_sfixed32),
pb_delta(AllTypes, rep_float_count, rep_float),
pb_membersize(AllTypes, rep_float[0]),
pb_membersize(AllTypes, rep_float) / pb_membersize(AllTypes, rep_float[0]), 0},
{31, PB_HTYPE_ARRAY | PB_LTYPE_FIXED64,
pb_delta_end(AllTypes, rep_fixed64, rep_float),
pb_delta(AllTypes, rep_fixed64_count, rep_fixed64),
pb_membersize(AllTypes, rep_fixed64[0]),
pb_membersize(AllTypes, rep_fixed64) / pb_membersize(AllTypes, rep_fixed64[0]), 0},
{32, PB_HTYPE_ARRAY | PB_LTYPE_FIXED64,
pb_delta_end(AllTypes, rep_sfixed64, rep_fixed64),
pb_delta(AllTypes, rep_sfixed64_count, rep_sfixed64),
pb_membersize(AllTypes, rep_sfixed64[0]),
pb_membersize(AllTypes, rep_sfixed64) / pb_membersize(AllTypes, rep_sfixed64[0]), 0},
{33, PB_HTYPE_ARRAY | PB_LTYPE_FIXED64,
pb_delta_end(AllTypes, rep_double, rep_sfixed64),
pb_delta(AllTypes, rep_double_count, rep_double),
pb_membersize(AllTypes, rep_double[0]),
pb_membersize(AllTypes, rep_double) / pb_membersize(AllTypes, rep_double[0]), 0},
{34, PB_HTYPE_ARRAY | PB_LTYPE_STRING,
pb_delta_end(AllTypes, rep_string, rep_double),
pb_delta(AllTypes, rep_string_count, rep_string),
pb_membersize(AllTypes, rep_string[0]),
pb_membersize(AllTypes, rep_string) / pb_membersize(AllTypes, rep_string[0]), 0},
{35, PB_HTYPE_ARRAY | PB_LTYPE_BYTES,
pb_delta_end(AllTypes, rep_bytes, rep_string),
pb_delta(AllTypes, rep_bytes_count, rep_bytes),
pb_membersize(AllTypes, rep_bytes[0]),
pb_membersize(AllTypes, rep_bytes) / pb_membersize(AllTypes, rep_bytes[0]), 0},
{36, PB_HTYPE_ARRAY | PB_LTYPE_SUBMESSAGE,
pb_delta_end(AllTypes, rep_submsg, rep_bytes),
pb_delta(AllTypes, rep_submsg_count, rep_submsg),
pb_membersize(AllTypes, rep_submsg[0]),
pb_membersize(AllTypes, rep_submsg) / pb_membersize(AllTypes, rep_submsg[0]),
&SubMessage_fields},
{37, PB_HTYPE_ARRAY | PB_LTYPE_VARINT,
pb_delta_end(AllTypes, rep_enum, rep_submsg),
pb_delta(AllTypes, rep_enum_count, rep_enum),
pb_membersize(AllTypes, rep_enum[0]),
pb_membersize(AllTypes, rep_enum) / pb_membersize(AllTypes, rep_enum[0]), 0},
{41, PB_HTYPE_OPTIONAL | PB_LTYPE_VARINT,
pb_delta_end(AllTypes, opt_int32, rep_enum),
pb_delta(AllTypes, has_opt_int32, opt_int32),
pb_membersize(AllTypes, opt_int32), 0,
&AllTypes_opt_int32_default},
{42, PB_HTYPE_OPTIONAL | PB_LTYPE_VARINT,
pb_delta_end(AllTypes, opt_int64, opt_int32),
pb_delta(AllTypes, has_opt_int64, opt_int64),
pb_membersize(AllTypes, opt_int64), 0,
&AllTypes_opt_int64_default},
{43, PB_HTYPE_OPTIONAL | PB_LTYPE_VARINT,
pb_delta_end(AllTypes, opt_uint32, opt_int64),
pb_delta(AllTypes, has_opt_uint32, opt_uint32),
pb_membersize(AllTypes, opt_uint32), 0,
&AllTypes_opt_uint32_default},
{44, PB_HTYPE_OPTIONAL | PB_LTYPE_VARINT,
pb_delta_end(AllTypes, opt_uint64, opt_uint32),
pb_delta(AllTypes, has_opt_uint64, opt_uint64),
pb_membersize(AllTypes, opt_uint64), 0,
&AllTypes_opt_uint64_default},
{45, PB_HTYPE_OPTIONAL | PB_LTYPE_SVARINT,
pb_delta_end(AllTypes, opt_sint32, opt_uint64),
pb_delta(AllTypes, has_opt_sint32, opt_sint32),
pb_membersize(AllTypes, opt_sint32), 0,
&AllTypes_opt_sint32_default},
{46, PB_HTYPE_OPTIONAL | PB_LTYPE_SVARINT,
pb_delta_end(AllTypes, opt_sint64, opt_sint32),
pb_delta(AllTypes, has_opt_sint64, opt_sint64),
pb_membersize(AllTypes, opt_sint64), 0,
&AllTypes_opt_sint64_default},
{47, PB_HTYPE_OPTIONAL | PB_LTYPE_VARINT,
pb_delta_end(AllTypes, opt_bool, opt_sint64),
pb_delta(AllTypes, has_opt_bool, opt_bool),
pb_membersize(AllTypes, opt_bool), 0,
&AllTypes_opt_bool_default},
{48, PB_HTYPE_OPTIONAL | PB_LTYPE_FIXED32,
pb_delta_end(AllTypes, opt_fixed32, opt_bool),
pb_delta(AllTypes, has_opt_fixed32, opt_fixed32),
pb_membersize(AllTypes, opt_fixed32), 0,
&AllTypes_opt_fixed32_default},
{49, PB_HTYPE_OPTIONAL | PB_LTYPE_FIXED32,
pb_delta_end(AllTypes, opt_sfixed32, opt_fixed32),
pb_delta(AllTypes, has_opt_sfixed32, opt_sfixed32),
pb_membersize(AllTypes, opt_sfixed32), 0,
&AllTypes_opt_sfixed32_default},
{50, PB_HTYPE_OPTIONAL | PB_LTYPE_FIXED32,
pb_delta_end(AllTypes, opt_float, opt_sfixed32),
pb_delta(AllTypes, has_opt_float, opt_float),
pb_membersize(AllTypes, opt_float), 0,
&AllTypes_opt_float_default},
{51, PB_HTYPE_OPTIONAL | PB_LTYPE_FIXED64,
pb_delta_end(AllTypes, opt_fixed64, opt_float),
pb_delta(AllTypes, has_opt_fixed64, opt_fixed64),
pb_membersize(AllTypes, opt_fixed64), 0,
&AllTypes_opt_fixed64_default},
{52, PB_HTYPE_OPTIONAL | PB_LTYPE_FIXED64,
pb_delta_end(AllTypes, opt_sfixed64, opt_fixed64),
pb_delta(AllTypes, has_opt_sfixed64, opt_sfixed64),
pb_membersize(AllTypes, opt_sfixed64), 0,
&AllTypes_opt_sfixed64_default},
{53, PB_HTYPE_OPTIONAL | PB_LTYPE_FIXED64,
pb_delta_end(AllTypes, opt_double, opt_sfixed64),
pb_delta(AllTypes, has_opt_double, opt_double),
pb_membersize(AllTypes, opt_double), 0,
&AllTypes_opt_double_default},
{54, PB_HTYPE_OPTIONAL | PB_LTYPE_STRING,
pb_delta_end(AllTypes, opt_string, opt_double),
pb_delta(AllTypes, has_opt_string, opt_string),
pb_membersize(AllTypes, opt_string), 0,
&AllTypes_opt_string_default},
{55, PB_HTYPE_OPTIONAL | PB_LTYPE_BYTES,
pb_delta_end(AllTypes, opt_bytes, opt_string),
pb_delta(AllTypes, has_opt_bytes, opt_bytes),
pb_membersize(AllTypes, opt_bytes), 0,
&AllTypes_opt_bytes_default},
{56, PB_HTYPE_OPTIONAL | PB_LTYPE_SUBMESSAGE,
pb_delta_end(AllTypes, opt_submsg, opt_bytes),
pb_delta(AllTypes, has_opt_submsg, opt_submsg),
pb_membersize(AllTypes, opt_submsg), 0,
&SubMessage_fields},
{57, PB_HTYPE_OPTIONAL | PB_LTYPE_VARINT,
pb_delta_end(AllTypes, opt_enum, opt_submsg),
pb_delta(AllTypes, has_opt_enum, opt_enum),
pb_membersize(AllTypes, opt_enum), 0,
&AllTypes_opt_enum_default},
{99, PB_HTYPE_REQUIRED | PB_LTYPE_VARINT,
pb_delta_end(AllTypes, end, opt_enum), 0,
pb_membersize(AllTypes, end), 0, 0},
PB_LAST_FIELD PB_LAST_FIELD
}; };

View File

@@ -1,19 +1,14 @@
/* Automatically generated nanopb header */ /* Automatically generated nanopb header */
/* This is a file generated using nanopb-0.2.0-dev. /* This is a file generated using nanopb-0.1.1.
* It is used as a part of test suite in order to detect any * It is used as a part of test suite in order to detect any
* incompatible changes made to the generator in future versions. * incompatible changes made to the generator in future versions.
*/ */
#ifndef _PB_BC_ALLTYPES_PB_H_
#ifndef _PB_ALLTYPES_PB_H_ #define _PB_BC_ALLTYPES_PB_H_
#define _PB_ALLTYPES_PB_H_
#include <pb.h> #include <pb.h>
#ifdef __cplusplus
extern "C" {
#endif
/* Enum definitions */ /* Enum definitions */
typedef enum _MyEnum { typedef enum {
MyEnum_Zero = 0, MyEnum_Zero = 0,
MyEnum_First = 1, MyEnum_First = 1,
MyEnum_Second = 2, MyEnum_Second = 2,
@@ -21,7 +16,7 @@ typedef enum _MyEnum {
} MyEnum; } MyEnum;
/* Struct definitions */ /* Struct definitions */
typedef struct _SubMessage { typedef struct {
char substuff1[16]; char substuff1[16];
int32_t substuff2; int32_t substuff2;
bool has_substuff3; bool has_substuff3;
@@ -43,7 +38,7 @@ typedef struct {
uint8_t bytes[16]; uint8_t bytes[16];
} AllTypes_opt_bytes_t; } AllTypes_opt_bytes_t;
typedef struct _AllTypes { typedef struct {
int32_t req_int32; int32_t req_int32;
int64_t req_int64; int64_t req_int64;
uint32_t req_uint32; uint32_t req_uint32;
@@ -133,7 +128,7 @@ typedef struct _AllTypes {
} AllTypes; } AllTypes;
/* Default values for struct fields */ /* Default values for struct fields */
extern const char SubMessage_substuff1_default[16]; extern const char SubMessage_substuff1_default[17];
extern const int32_t SubMessage_substuff2_default; extern const int32_t SubMessage_substuff2_default;
extern const uint32_t SubMessage_substuff3_default; extern const uint32_t SubMessage_substuff3_default;
extern const int32_t AllTypes_opt_int32_default; extern const int32_t AllTypes_opt_int32_default;
@@ -149,7 +144,7 @@ extern const float AllTypes_opt_float_default;
extern const uint64_t AllTypes_opt_fixed64_default; extern const uint64_t AllTypes_opt_fixed64_default;
extern const int64_t AllTypes_opt_sfixed64_default; extern const int64_t AllTypes_opt_sfixed64_default;
extern const double AllTypes_opt_double_default; extern const double AllTypes_opt_double_default;
extern const char AllTypes_opt_string_default[16]; extern const char AllTypes_opt_string_default[17];
extern const AllTypes_opt_bytes_t AllTypes_opt_bytes_default; extern const AllTypes_opt_bytes_t AllTypes_opt_bytes_default;
extern const MyEnum AllTypes_opt_enum_default; extern const MyEnum AllTypes_opt_enum_default;
@@ -157,22 +152,4 @@ extern const MyEnum AllTypes_opt_enum_default;
extern const pb_field_t SubMessage_fields[4]; extern const pb_field_t SubMessage_fields[4];
extern const pb_field_t AllTypes_fields[53]; extern const pb_field_t AllTypes_fields[53];
/* Check that field information fits in pb_field_t */
#if !defined(PB_FIELD_16BIT) && !defined(PB_FIELD_32BIT)
STATIC_ASSERT((pb_membersize(AllTypes, req_submsg) < 256 && pb_membersize(AllTypes, rep_submsg[0]) < 256 && pb_membersize(AllTypes, opt_submsg) < 256), YOU_MUST_DEFINE_PB_FIELD_16BIT_FOR_MESSAGES_SubMessage_AllTypes)
#endif
#if !defined(PB_FIELD_32BIT)
STATIC_ASSERT((pb_membersize(AllTypes, req_submsg) < 65536 && pb_membersize(AllTypes, rep_submsg[0]) < 65536 && pb_membersize(AllTypes, opt_submsg) < 65536), YOU_MUST_DEFINE_PB_FIELD_32BIT_FOR_MESSAGES_SubMessage_AllTypes)
#endif
/* On some platforms (such as AVR), double is really float.
* These are not directly supported by nanopb, but see example_avr_double.
*/
STATIC_ASSERT(sizeof(double) == 8, DOUBLE_MUST_BE_8_BYTES)
#ifdef __cplusplus
} /* extern "C" */
#endif
#endif #endif

View File

@@ -11,6 +11,5 @@ message TestMessage {
repeated fixed32 fixed32value = 3; repeated fixed32 fixed32value = 3;
repeated fixed64 fixed64value = 4; repeated fixed64 fixed64value = 4;
optional SubMessage submsg = 5; optional SubMessage submsg = 5;
repeated string repeatedstring = 6;
} }

View File

@@ -19,11 +19,11 @@ bool stream_callback(pb_istream_t *stream, uint8_t *buf, size_t count)
} }
/* Verifies that the stream passed to callback matches the byte array pointed to by arg. */ /* Verifies that the stream passed to callback matches the byte array pointed to by arg. */
bool callback_check(pb_istream_t *stream, const pb_field_t *field, void **arg) bool callback_check(pb_istream_t *stream, const pb_field_t *field, void *arg)
{ {
int i; int i;
uint8_t byte; uint8_t byte;
pb_bytes_array_t *ref = (pb_bytes_array_t*) *arg; pb_bytes_array_t *ref = (pb_bytes_array_t*) arg;
for (i = 0; i < ref->size; i++) for (i = 0; i < ref->size; i++)
{ {
@@ -289,16 +289,6 @@ int main()
TEST((s = S("\x08"), !pb_decode(&s, IntegerArray_fields, &dest))) TEST((s = S("\x08"), !pb_decode(&s, IntegerArray_fields, &dest)))
} }
{
pb_istream_t s;
IntegerContainer dest = {};
COMMENT("Testing pb_decode_delimited")
TEST((s = S("\x09\x0A\x07\x0A\x05\x01\x02\x03\x04\x05"),
pb_decode_delimited(&s, IntegerContainer_fields, &dest)) &&
dest.submsg.data_count == 5)
}
if (status != 0) if (status != 0)
fprintf(stdout, "\n\nSome tests FAILED!\n"); fprintf(stdout, "\n\nSome tests FAILED!\n");

View File

@@ -17,7 +17,7 @@ bool streamcallback(pb_ostream_t *stream, const uint8_t *buf, size_t count)
return true; return true;
} }
bool fieldcallback(pb_ostream_t *stream, const pb_field_t *field, void * const *arg) bool fieldcallback(pb_ostream_t *stream, const pb_field_t *field, const void *arg)
{ {
int value = 0x55; int value = 0x55;
if (!pb_encode_tag_for_field(stream, field)) if (!pb_encode_tag_for_field(stream, field))
@@ -25,7 +25,7 @@ bool fieldcallback(pb_ostream_t *stream, const pb_field_t *field, void * const *
return pb_encode_varint(stream, value); return pb_encode_varint(stream, value);
} }
bool crazyfieldcallback(pb_ostream_t *stream, const pb_field_t *field, void * const *arg) bool crazyfieldcallback(pb_ostream_t *stream, const pb_field_t *field, const void *arg)
{ {
/* This callback writes different amount of data the second time. */ /* This callback writes different amount of data the second time. */
uint32_t *state = (uint32_t*)arg; uint32_t *state = (uint32_t*)arg;
@@ -180,14 +180,12 @@ int main()
{ {
uint8_t buffer[30]; uint8_t buffer[30];
pb_ostream_t s; pb_ostream_t s;
char value[30] = "xyzzy"; char value[] = "xyzzy";
COMMENT("Test pb_enc_string") COMMENT("Test pb_enc_string")
TEST(WRITES(pb_enc_string(&s, &StringMessage_fields[0], &value), "\x05xyzzy")) TEST(WRITES(pb_enc_string(&s, NULL, &value), "\x05xyzzy"))
value[0] = '\0'; value[0] = '\0';
TEST(WRITES(pb_enc_string(&s, &StringMessage_fields[0], &value), "\x00")) TEST(WRITES(pb_enc_string(&s, NULL, &value), "\x00"))
memset(value, 'x', 30);
TEST(WRITES(pb_enc_string(&s, &StringMessage_fields[0], &value), "\x0Axxxxxxxxxx"))
} }
{ {
@@ -244,16 +242,6 @@ int main()
"\x0A\x07\x0A\x05\x01\x02\x03\x04\x05")) "\x0A\x07\x0A\x05\x01\x02\x03\x04\x05"))
} }
{
uint8_t buffer[20];
pb_ostream_t s;
IntegerContainer msg = {{5, {1,2,3,4,5}}};
COMMENT("Test pb_encode_delimited.")
TEST(WRITES(pb_encode_delimited(&s, IntegerContainer_fields, &msg),
"\x09\x0A\x07\x0A\x05\x01\x02\x03\x04\x05"))
}
{ {
uint8_t buffer[10]; uint8_t buffer[10];
pb_ostream_t s; pb_ostream_t s;

View File

@@ -1 +0,0 @@
* max_size:16

View File

@@ -1,15 +0,0 @@
import 'alltypes.proto';
extend AllTypes {
optional int32 AllTypes_extensionfield1 = 255;
}
message ExtensionMessage {
extend AllTypes {
optional ExtensionMessage AllTypes_extensionfield2 = 254;
}
required string test1 = 1;
required int32 test2 = 2;
}

View File

@@ -76,7 +76,6 @@ bool check_alltypes(pb_istream_t *stream, int mode)
TEST(alltypes.rep_submsg[4].substuff3 == 2016 && alltypes.rep_submsg[0].substuff3 == 3); TEST(alltypes.rep_submsg[4].substuff3 == 2016 && alltypes.rep_submsg[0].substuff3 == 3);
TEST(alltypes.rep_enum_count == 5 && alltypes.rep_enum[4] == MyEnum_Truth && alltypes.rep_enum[0] == MyEnum_Zero); TEST(alltypes.rep_enum_count == 5 && alltypes.rep_enum[4] == MyEnum_Truth && alltypes.rep_enum[0] == MyEnum_Zero);
TEST(alltypes.rep_emptymsg_count == 5);
if (mode == 0) if (mode == 0)
{ {
@@ -121,7 +120,6 @@ bool check_alltypes(pb_istream_t *stream, int mode)
TEST(alltypes.opt_submsg.substuff3 == 3); TEST(alltypes.opt_submsg.substuff3 == 3);
TEST(alltypes.has_opt_enum == false); TEST(alltypes.has_opt_enum == false);
TEST(alltypes.opt_enum == MyEnum_Second); TEST(alltypes.opt_enum == MyEnum_Second);
TEST(alltypes.has_opt_emptymsg == false);
} }
else else
{ {
@@ -166,7 +164,6 @@ bool check_alltypes(pb_istream_t *stream, int mode)
TEST(alltypes.opt_submsg.substuff3 == 3); TEST(alltypes.opt_submsg.substuff3 == 3);
TEST(alltypes.has_opt_enum == true); TEST(alltypes.has_opt_enum == true);
TEST(alltypes.opt_enum == MyEnum_Truth); TEST(alltypes.opt_enum == MyEnum_Truth);
TEST(alltypes.has_opt_emptymsg == true);
} }
TEST(alltypes.end == 1099); TEST(alltypes.end == 1099);

View File

@@ -6,7 +6,7 @@
#include <pb_decode.h> #include <pb_decode.h>
#include "callbacks.pb.h" #include "callbacks.pb.h"
bool print_string(pb_istream_t *stream, const pb_field_t *field, void **arg) bool print_string(pb_istream_t *stream, const pb_field_t *field, void *arg)
{ {
uint8_t buffer[1024] = {0}; uint8_t buffer[1024] = {0};
@@ -20,37 +20,37 @@ bool print_string(pb_istream_t *stream, const pb_field_t *field, void **arg)
/* Print the string, in format comparable with protoc --decode. /* Print the string, in format comparable with protoc --decode.
* Format comes from the arg defined in main(). * Format comes from the arg defined in main().
*/ */
printf((char*)*arg, buffer); printf((char*)arg, buffer);
return true; return true;
} }
bool print_int32(pb_istream_t *stream, const pb_field_t *field, void **arg) bool print_int32(pb_istream_t *stream, const pb_field_t *field, void *arg)
{ {
uint64_t value; uint64_t value;
if (!pb_decode_varint(stream, &value)) if (!pb_decode_varint(stream, &value))
return false; return false;
printf((char*)*arg, (long)value); printf((char*)arg, (long)value);
return true; return true;
} }
bool print_fixed32(pb_istream_t *stream, const pb_field_t *field, void **arg) bool print_fixed32(pb_istream_t *stream, const pb_field_t *field, void *arg)
{ {
uint32_t value; uint32_t value;
if (!pb_decode_fixed32(stream, &value)) if (!pb_decode_fixed32(stream, &value))
return false; return false;
printf((char*)*arg, (long)value); printf((char*)arg, (long)value);
return true; return true;
} }
bool print_fixed64(pb_istream_t *stream, const pb_field_t *field, void **arg) bool print_fixed64(pb_istream_t *stream, const pb_field_t *field, void *arg)
{ {
uint64_t value; uint64_t value;
if (!pb_decode_fixed64(stream, &value)) if (!pb_decode_fixed64(stream, &value))
return false; return false;
printf((char*)*arg, (long long)value); printf((char*)arg, (long long)value);
return true; return true;
} }
@@ -83,8 +83,6 @@ int main()
testmessage.fixed32value.arg = "fixed32value: %ld\n"; testmessage.fixed32value.arg = "fixed32value: %ld\n";
testmessage.fixed64value.funcs.decode = &print_fixed64; testmessage.fixed64value.funcs.decode = &print_fixed64;
testmessage.fixed64value.arg = "fixed64value: %lld\n"; testmessage.fixed64value.arg = "fixed64value: %lld\n";
testmessage.repeatedstring.funcs.decode = &print_string;
testmessage.repeatedstring.arg = "repeatedstring: \"%s\"\n";
if (!pb_decode(&stream, TestMessage_fields, &testmessage)) if (!pb_decode(&stream, TestMessage_fields, &testmessage))
return 1; return 1;

View File

@@ -1,43 +0,0 @@
/* Test decoding of extension fields. */
#include <stdio.h>
#include <string.h>
#include <stdlib.h>
#include <pb_decode.h>
#include "alltypes.pb.h"
#include "extensions.pb.h"
#define TEST(x) if (!(x)) { \
printf("Test " #x " failed.\n"); \
return 2; \
}
int main(int argc, char **argv)
{
uint8_t buffer[1024];
size_t count = fread(buffer, 1, sizeof(buffer), stdin);
pb_istream_t stream = pb_istream_from_buffer(buffer, count);
AllTypes alltypes = {};
int32_t extensionfield1;
pb_extension_t ext1 = {&AllTypes_extensionfield1, &extensionfield1, NULL};
alltypes.extensions = &ext1;
ExtensionMessage extensionfield2 = {};
pb_extension_t ext2 = {&ExtensionMessage_AllTypes_extensionfield2, &extensionfield2, NULL};
ext1.next = &ext2;
if (!pb_decode(&stream, AllTypes_fields, &alltypes))
{
printf("Parsing failed: %s\n", PB_GET_ERROR(&stream));
return 1;
}
TEST(extensionfield1 == 12345)
TEST(strcmp(extensionfield2.test1, "test") == 0)
TEST(extensionfield2.test2 == 54321)
return 0;
}

View File

@@ -27,7 +27,6 @@ int main()
} }
else else
{ {
fprintf(stderr, "Encoding failed: %s\n", PB_GET_ERROR(&stream));
return 1; /* Failure */ return 1; /* Failure */
} }
} }

View File

@@ -26,12 +26,7 @@ int main()
/* Now encode it and check if we succeeded. */ /* Now encode it and check if we succeeded. */
if (pb_encode(&stream, Person_fields, &person)) if (pb_encode(&stream, Person_fields, &person))
{
return 0; /* Success */ return 0; /* Success */
}
else else
{
fprintf(stderr, "Encoding failed: %s\n", PB_GET_ERROR(&stream));
return 1; /* Failure */ return 1; /* Failure */
}
} }

View File

@@ -64,7 +64,6 @@ int main(int argc, char **argv)
alltypes.rep_submsg[4].substuff3 = 2016; alltypes.rep_submsg[4].substuff3 = 2016;
alltypes.rep_enum_count = 5; alltypes.rep_enum[4] = MyEnum_Truth; alltypes.rep_enum_count = 5; alltypes.rep_enum[4] = MyEnum_Truth;
alltypes.rep_emptymsg_count = 5;
if (mode != 0) if (mode != 0)
{ {
@@ -108,7 +107,6 @@ int main(int argc, char **argv)
alltypes.opt_submsg.substuff2 = 3056; alltypes.opt_submsg.substuff2 = 3056;
alltypes.has_opt_enum = true; alltypes.has_opt_enum = true;
alltypes.opt_enum = MyEnum_Truth; alltypes.opt_enum = MyEnum_Truth;
alltypes.has_opt_emptymsg = true;
} }
alltypes.end = 1099; alltypes.end = 1099;
@@ -124,7 +122,7 @@ int main(int argc, char **argv)
} }
else else
{ {
fprintf(stderr, "Encoding failed: %s\n", PB_GET_ERROR(&stream)); fprintf(stderr, "Encoding failed!\n");
return 1; /* Failure */ return 1; /* Failure */
} }
} }

View File

@@ -5,7 +5,7 @@
#include <pb_encode.h> #include <pb_encode.h>
#include "callbacks.pb.h" #include "callbacks.pb.h"
bool encode_string(pb_ostream_t *stream, const pb_field_t *field, void * const *arg) bool encode_string(pb_ostream_t *stream, const pb_field_t *field, const void *arg)
{ {
char *str = "Hello world!"; char *str = "Hello world!";
@@ -15,7 +15,7 @@ bool encode_string(pb_ostream_t *stream, const pb_field_t *field, void * const *
return pb_encode_string(stream, (uint8_t*)str, strlen(str)); return pb_encode_string(stream, (uint8_t*)str, strlen(str));
} }
bool encode_int32(pb_ostream_t *stream, const pb_field_t *field, void * const *arg) bool encode_int32(pb_ostream_t *stream, const pb_field_t *field, const void *arg)
{ {
if (!pb_encode_tag_for_field(stream, field)) if (!pb_encode_tag_for_field(stream, field))
return false; return false;
@@ -23,7 +23,7 @@ bool encode_int32(pb_ostream_t *stream, const pb_field_t *field, void * const *a
return pb_encode_varint(stream, 42); return pb_encode_varint(stream, 42);
} }
bool encode_fixed32(pb_ostream_t *stream, const pb_field_t *field, void * const *arg) bool encode_fixed32(pb_ostream_t *stream, const pb_field_t *field, const void *arg)
{ {
if (!pb_encode_tag_for_field(stream, field)) if (!pb_encode_tag_for_field(stream, field))
return false; return false;
@@ -32,7 +32,7 @@ bool encode_fixed32(pb_ostream_t *stream, const pb_field_t *field, void * const
return pb_encode_fixed32(stream, &value); return pb_encode_fixed32(stream, &value);
} }
bool encode_fixed64(pb_ostream_t *stream, const pb_field_t *field, void * const *arg) bool encode_fixed64(pb_ostream_t *stream, const pb_field_t *field, const void *arg)
{ {
if (!pb_encode_tag_for_field(stream, field)) if (!pb_encode_tag_for_field(stream, field))
return false; return false;
@@ -41,22 +41,6 @@ bool encode_fixed64(pb_ostream_t *stream, const pb_field_t *field, void * const
return pb_encode_fixed64(stream, &value); return pb_encode_fixed64(stream, &value);
} }
bool encode_repeatedstring(pb_ostream_t *stream, const pb_field_t *field, void * const *arg)
{
char *str[4] = {"Hello world!", "", "Test", "Test2"};
int i;
for (i = 0; i < 4; i++)
{
if (!pb_encode_tag_for_field(stream, field))
return false;
if (!pb_encode_string(stream, (uint8_t*)str[i], strlen(str[i])))
return false;
}
return true;
}
int main() int main()
{ {
uint8_t buffer[1024]; uint8_t buffer[1024];
@@ -73,8 +57,6 @@ int main()
testmessage.submsg.int32value.funcs.encode = &encode_int32; testmessage.submsg.int32value.funcs.encode = &encode_int32;
testmessage.submsg.fixed32value.funcs.encode = &encode_fixed32; testmessage.submsg.fixed32value.funcs.encode = &encode_fixed32;
testmessage.submsg.fixed64value.funcs.encode = &encode_fixed64; testmessage.submsg.fixed64value.funcs.encode = &encode_fixed64;
testmessage.repeatedstring.funcs.encode = &encode_repeatedstring;
if (!pb_encode(&stream, TestMessage_fields, &testmessage)) if (!pb_encode(&stream, TestMessage_fields, &testmessage))
return 1; return 1;

View File

@@ -1,38 +0,0 @@
/* Tests extension fields.
*/
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <pb_encode.h>
#include "alltypes.pb.h"
#include "extensions.pb.h"
int main(int argc, char **argv)
{
AllTypes alltypes = {};
int32_t extensionfield1 = 12345;
pb_extension_t ext1 = {&AllTypes_extensionfield1, &extensionfield1, NULL};
alltypes.extensions = &ext1;
ExtensionMessage extensionfield2 = {"test", 54321};
pb_extension_t ext2 = {&ExtensionMessage_AllTypes_extensionfield2, &extensionfield2, NULL};
ext1.next = &ext2;
uint8_t buffer[1024];
pb_ostream_t stream = pb_ostream_from_buffer(buffer, sizeof(buffer));
/* Now encode it and check if we succeeded. */
if (pb_encode(&stream, AllTypes_fields, &alltypes))
{
fwrite(buffer, 1, stream.bytes_written, stdout);
return 0; /* Success */
}
else
{
fprintf(stderr, "Encoding failed: %s\n", PB_GET_ERROR(&stream));
return 1; /* Failure */
}
}

View File

@@ -8,10 +8,6 @@ message FloatArray {
repeated float data = 1 [(nanopb).max_count = 10]; repeated float data = 1 [(nanopb).max_count = 10];
} }
message StringMessage {
required string data = 1 [(nanopb).max_size = 10];
}
message CallbackArray { message CallbackArray {
// We cheat a bit and use this message for testing other types, too. // We cheat a bit and use this message for testing other types, too.
// Nanopb does not care about the actual defined data type for callback // Nanopb does not care about the actual defined data type for callback