1 /* Common parts of the nanopb library. Most of these are quite low-level
2 * stuff. For the high-level interface, see pb_encode.h and pb_decode.h.
8 /*****************************************************************
9 * Nanopb compilation time options. You can change these here by *
10 * uncommenting the lines, or on the compiler command line. *
11 *****************************************************************/
13 /* Enable support for dynamically allocated fields */
14 /* #define PB_ENABLE_MALLOC 1 */
16 /* Define this if your CPU architecture is big endian, i.e. it
17 * stores the most-significant byte first. */
18 /* #define __BIG_ENDIAN__ 1 */
20 /* Define this if your CPU / compiler combination does not support
21 * unaligned memory access to packed structures. */
22 /* #define PB_NO_PACKED_STRUCTS 1 */
24 /* Increase the number of required fields that are tracked.
25 * A compiler warning will tell if you need this. */
26 /* #define PB_MAX_REQUIRED_FIELDS 256 */
28 /* Add support for tag numbers > 255 and fields larger than 255 bytes. */
29 /* #define PB_FIELD_16BIT 1 */
31 /* Add support for tag numbers > 65536 and fields larger than 65536 bytes. */
32 /* #define PB_FIELD_32BIT 1 */
34 /* Disable support for error messages in order to save some code space. */
35 /* #define PB_NO_ERRMSG 1 */
37 /* Disable support for custom streams (support only memory buffers). */
38 /* #define PB_BUFFER_ONLY 1 */
40 /* Switch back to the old-style callback function signature.
41 * This was the default until nanopb-0.2.1. */
42 /* #define PB_OLD_CALLBACK_STYLE */
45 /******************************************************************
46 * You usually don't need to change anything below this line. *
47 * Feel free to look around and use the defined macros, though. *
48 ******************************************************************/
51 /* Version of the nanopb library. Just in case you want to check it in
52 * your own program. */
53 #define NANOPB_VERSION nanopb-0.3.5-dev
55 /* Include all the system headers needed by nanopb. You will need the
56 * definitions of the following:
57 * - strlen, memcpy, memset functions
58 * - [u]int_least8_t, uint_fast8_t, [u]int_least16_t, [u]int32_t, [u]int64_t
62 * If you don't have the standard header files, you can instead provide
63 * a custom header that defines or includes all this. In that case,
64 * define PB_SYSTEM_HEADER to the path of this file.
66 #ifdef PB_SYSTEM_HEADER
67 #include PB_SYSTEM_HEADER
74 #ifdef PB_ENABLE_MALLOC
79 /* Macro for defining packed structures (compiler dependent).
80 * This just reduces memory requirements, but is not required.
82 #if defined(PB_NO_PACKED_STRUCTS)
83 /* Disable struct packing */
84 # define PB_PACKED_STRUCT_START
85 # define PB_PACKED_STRUCT_END
87 #elif defined(__GNUC__) || defined(__clang__)
88 /* For GCC and clang */
89 # define PB_PACKED_STRUCT_START
90 # define PB_PACKED_STRUCT_END
91 # define pb_packed __attribute__((packed))
92 #elif defined(__ICCARM__) || defined(__CC_ARM)
93 /* For IAR ARM and Keil MDK-ARM compilers */
94 # define PB_PACKED_STRUCT_START _Pragma("pack(push, 1)")
95 # define PB_PACKED_STRUCT_END _Pragma("pack(pop)")
97 #elif defined(_MSC_VER) && (_MSC_VER >= 1500)
98 /* For Microsoft Visual C++ */
99 # define PB_PACKED_STRUCT_START __pragma(pack(push, 1))
100 # define PB_PACKED_STRUCT_END __pragma(pack(pop))
103 /* Unknown compiler */
104 # define PB_PACKED_STRUCT_START
105 # define PB_PACKED_STRUCT_END
109 /* Handly macro for suppressing unreferenced-parameter compiler warnings. */
111 #define PB_UNUSED(x) (void)(x)
114 /* Compile-time assertion, used for checking compatible compilation options.
115 * If this does not work properly on your compiler, use
116 * #define PB_NO_STATIC_ASSERT to disable it.
118 * But before doing that, check carefully the error message / place where it
119 * comes from to see if the error has a real cause. Unfortunately the error
120 * message is not always very clear to read, but you can see the reason better
121 * in the place where the PB_STATIC_ASSERT macro was called.
123 #ifndef PB_NO_STATIC_ASSERT
124 #ifndef PB_STATIC_ASSERT
125 #define PB_STATIC_ASSERT(COND,MSG) typedef char PB_STATIC_ASSERT_MSG(MSG, __LINE__, __COUNTER__)[(COND)?1:-1];
126 #define PB_STATIC_ASSERT_MSG(MSG, LINE, COUNTER) PB_STATIC_ASSERT_MSG_(MSG, LINE, COUNTER)
127 #define PB_STATIC_ASSERT_MSG_(MSG, LINE, COUNTER) pb_static_assertion_##MSG##LINE##COUNTER
130 #define PB_STATIC_ASSERT(COND,MSG)
133 /* Number of required fields to keep track of. */
134 #ifndef PB_MAX_REQUIRED_FIELDS
135 #define PB_MAX_REQUIRED_FIELDS 64
138 #if PB_MAX_REQUIRED_FIELDS < 64
139 #error You should not lower PB_MAX_REQUIRED_FIELDS from the default value (64).
142 /* List of possible field types. These are used in the autogenerated code.
143 * Least-significant 4 bits tell the scalar type
144 * Most-significant 4 bits specify repeated/required/packed etc.
147 typedef uint_least8_t pb_type_t;
149 /**** Field data types ****/
152 #define PB_LTYPE_VARINT 0x00 /* int32, int64, enum, bool */
153 #define PB_LTYPE_UVARINT 0x01 /* uint32, uint64 */
154 #define PB_LTYPE_SVARINT 0x02 /* sint32, sint64 */
155 #define PB_LTYPE_FIXED32 0x03 /* fixed32, sfixed32, float */
156 #define PB_LTYPE_FIXED64 0x04 /* fixed64, sfixed64, double */
158 /* Marker for last packable field type. */
159 #define PB_LTYPE_LAST_PACKABLE 0x04
161 /* Byte array with pre-allocated buffer.
162 * data_size is the length of the allocated PB_BYTES_ARRAY structure. */
163 #define PB_LTYPE_BYTES 0x05
165 /* String with pre-allocated buffer.
166 * data_size is the maximum length. */
167 #define PB_LTYPE_STRING 0x06
170 * submsg_fields is pointer to field descriptions */
171 #define PB_LTYPE_SUBMESSAGE 0x07
173 /* Extension pseudo-field
174 * The field contains a pointer to pb_extension_t */
175 #define PB_LTYPE_EXTENSION 0x08
177 /* Number of declared LTYPES */
178 #define PB_LTYPES_COUNT 9
179 #define PB_LTYPE_MASK 0x0F
181 /**** Field repetition rules ****/
183 #define PB_HTYPE_REQUIRED 0x00
184 #define PB_HTYPE_OPTIONAL 0x10
185 #define PB_HTYPE_REPEATED 0x20
186 #define PB_HTYPE_ONEOF 0x30
187 #define PB_HTYPE_MASK 0x30
189 /**** Field allocation types ****/
191 #define PB_ATYPE_STATIC 0x00
192 #define PB_ATYPE_POINTER 0x80
193 #define PB_ATYPE_CALLBACK 0x40
194 #define PB_ATYPE_MASK 0xC0
196 #define PB_ATYPE(x) ((x) & PB_ATYPE_MASK)
197 #define PB_HTYPE(x) ((x) & PB_HTYPE_MASK)
198 #define PB_LTYPE(x) ((x) & PB_LTYPE_MASK)
200 /* Data type used for storing sizes of struct fields
203 #if defined(PB_FIELD_32BIT)
204 typedef uint32_t pb_size_t;
205 typedef int32_t pb_ssize_t;
206 #elif defined(PB_FIELD_16BIT)
207 typedef uint_least16_t pb_size_t;
208 typedef int_least16_t pb_ssize_t;
210 typedef uint_least8_t pb_size_t;
211 typedef int_least8_t pb_ssize_t;
213 #define PB_SIZE_MAX ((pb_size_t)-1)
215 /* Data type for storing encoded data and other byte streams.
216 * This typedef exists to support platforms where uint8_t does not exist.
217 * You can regard it as equivalent on uint8_t on other platforms.
219 typedef uint_least8_t pb_byte_t;
221 /* This structure is used in auto-generated constants
222 * to specify struct fields.
223 * You can change field sizes if you need structures
224 * larger than 256 bytes or field tags larger than 256.
225 * The compiler should complain if your .proto has such
226 * structures. Fix that by defining PB_FIELD_16BIT or
229 PB_PACKED_STRUCT_START
230 typedef struct pb_field_s pb_field_t;
234 pb_size_t data_offset; /* Offset of field data, relative to previous field. */
235 pb_ssize_t size_offset; /* Offset of array size or has-boolean, relative to data */
236 pb_size_t data_size; /* Data size in bytes for a single item */
237 pb_size_t array_size; /* Maximum number of entries in array */
239 /* Field definitions for submessage
240 * OR default value for all other non-array, non-callback types
241 * If null, then field will zeroed. */
246 /* Make sure that the standard integer types are of the expected sizes.
247 * Otherwise fixed32/fixed64 fields can break.
249 * If you get errors here, it probably means that your stdint.h is not
250 * correct for your platform.
252 PB_STATIC_ASSERT(sizeof(int64_t) == 2 * sizeof(int32_t), INT64_T_WRONG_SIZE)
253 PB_STATIC_ASSERT(sizeof(uint64_t) == 2 * sizeof(uint32_t), UINT64_T_WRONG_SIZE)
255 /* This structure is used for 'bytes' arrays.
256 * It has the number of bytes in the beginning, and after that an array.
257 * Note that actual structs used will have a different length of bytes array.
259 #define PB_BYTES_ARRAY_T(n) struct { pb_size_t size; pb_byte_t bytes[n]; }
260 #define PB_BYTES_ARRAY_T_ALLOCSIZE(n) ((size_t)n + offsetof(pb_bytes_array_t, bytes))
262 struct pb_bytes_array_s {
266 typedef struct pb_bytes_array_s pb_bytes_array_t;
268 /* This structure is used for giving the callback function.
269 * It is stored in the message structure and filled in by the method that
272 * The decoding callback will be given a limited-length stream
273 * If the wire type was string, the length is the length of the string.
274 * If the wire type was a varint/fixed32/fixed64, the length is the length
275 * of the actual value.
276 * The function may be called multiple times (especially for repeated types,
277 * but also otherwise if the message happens to contain the field multiple
280 * The encoding callback will receive the actual output stream.
281 * It should write all the data in one call, including the field tag and
282 * wire type. It can write multiple fields.
284 * The callback can be null if you want to skip a field.
286 typedef struct pb_istream_s pb_istream_t;
287 typedef struct pb_ostream_s pb_ostream_t;
288 typedef struct pb_callback_s pb_callback_t;
289 struct pb_callback_s {
290 #ifdef PB_OLD_CALLBACK_STYLE
291 /* Deprecated since nanopb-0.2.1 */
293 bool (*decode)(pb_istream_t *stream, const pb_field_t *field, void *arg);
294 bool (*encode)(pb_ostream_t *stream, const pb_field_t *field, const void *arg);
297 /* New function signature, which allows modifying arg contents in callback. */
299 bool (*decode)(pb_istream_t *stream, const pb_field_t *field, void **arg);
300 bool (*encode)(pb_ostream_t *stream, const pb_field_t *field, void * const *arg);
304 /* Free arg for use by callback */
308 /* Wire types. Library user needs these only in encoder callbacks. */
316 /* Structure for defining the handling of unknown/extension fields.
317 * Usually the pb_extension_type_t structure is automatically generated,
318 * while the pb_extension_t structure is created by the user. However,
319 * if you want to catch all unknown fields, you can also create a custom
320 * pb_extension_type_t with your own callback.
322 typedef struct pb_extension_type_s pb_extension_type_t;
323 typedef struct pb_extension_s pb_extension_t;
324 struct pb_extension_type_s {
325 /* Called for each unknown field in the message.
326 * If you handle the field, read off all of its data and return true.
327 * If you do not handle the field, do not read anything and return true.
328 * If you run into an error, return false.
329 * Set to NULL for default handler.
331 bool (*decode)(pb_istream_t *stream, pb_extension_t *extension,
332 uint32_t tag, pb_wire_type_t wire_type);
334 /* Called once after all regular fields have been encoded.
335 * If you have something to write, do so and return true.
336 * If you do not have anything to write, just return true.
337 * If you run into an error, return false.
338 * Set to NULL for default handler.
340 bool (*encode)(pb_ostream_t *stream, const pb_extension_t *extension);
342 /* Free field for use by the callback. */
346 struct pb_extension_s {
347 /* Type describing the extension field. Usually you'll initialize
348 * this to a pointer to the automatically generated structure. */
349 const pb_extension_type_t *type;
351 /* Destination for the decoded data. This must match the datatype
352 * of the extension field. */
355 /* Pointer to the next extension handler, or NULL.
356 * If this extension does not match a field, the next handler is
357 * automatically called. */
358 pb_extension_t *next;
360 /* The decoder sets this to true if the extension was found.
361 * Ignored for encoding. */
365 /* Memory allocation functions to use. You can define pb_realloc and
366 * pb_free to custom functions if you want. */
367 #ifdef PB_ENABLE_MALLOC
369 # define pb_realloc(ptr, size) realloc(ptr, size)
372 # define pb_free(ptr) free(ptr)
376 /* This is used to inform about need to regenerate .pb.h/.pb.c files. */
377 #define PB_PROTO_HEADER_VERSION 30
379 /* These macros are used to declare pb_field_t's in the constant array. */
380 /* Size of a structure member, in bytes. */
381 #define pb_membersize(st, m) (sizeof ((st*)0)->m)
382 /* Number of entries in an array. */
383 #define pb_arraysize(st, m) (pb_membersize(st, m) / pb_membersize(st, m[0]))
384 /* Delta from start of one member to the start of another member. */
385 #define pb_delta(st, m1, m2) ((int)offsetof(st, m1) - (int)offsetof(st, m2))
386 /* Marks the end of the field list */
387 #define PB_LAST_FIELD {0,(pb_type_t) 0,0,0,0,0,0}
389 /* Macros for filling in the data_offset field */
390 /* data_offset for first field in a message */
391 #define PB_DATAOFFSET_FIRST(st, m1, m2) (offsetof(st, m1))
392 /* data_offset for subsequent fields */
393 #define PB_DATAOFFSET_OTHER(st, m1, m2) (offsetof(st, m1) - offsetof(st, m2) - pb_membersize(st, m2))
394 /* Choose first/other based on m1 == m2 (deprecated, remains for backwards compatibility) */
395 #define PB_DATAOFFSET_CHOOSE(st, m1, m2) (int)(offsetof(st, m1) == offsetof(st, m2) \
396 ? PB_DATAOFFSET_FIRST(st, m1, m2) \
397 : PB_DATAOFFSET_OTHER(st, m1, m2))
399 /* Required fields are the simplest. They just have delta (padding) from
400 * previous field end, and the size of the field. Pointer is used for
401 * submessages and default values.
403 #define PB_REQUIRED_STATIC(tag, st, m, fd, ltype, ptr) \
404 {tag, PB_ATYPE_STATIC | PB_HTYPE_REQUIRED | ltype, \
405 fd, 0, pb_membersize(st, m), 0, ptr}
407 /* Optional fields add the delta to the has_ variable. */
408 #define PB_OPTIONAL_STATIC(tag, st, m, fd, ltype, ptr) \
409 {tag, PB_ATYPE_STATIC | PB_HTYPE_OPTIONAL | ltype, \
411 pb_delta(st, has_ ## m, m), \
412 pb_membersize(st, m), 0, ptr}
414 /* Repeated fields have a _count field and also the maximum number of entries. */
415 #define PB_REPEATED_STATIC(tag, st, m, fd, ltype, ptr) \
416 {tag, PB_ATYPE_STATIC | PB_HTYPE_REPEATED | ltype, \
418 pb_delta(st, m ## _count, m), \
419 pb_membersize(st, m[0]), \
420 pb_arraysize(st, m), ptr}
422 /* Allocated fields carry the size of the actual data, not the pointer */
423 #define PB_REQUIRED_POINTER(tag, st, m, fd, ltype, ptr) \
424 {tag, PB_ATYPE_POINTER | PB_HTYPE_REQUIRED | ltype, \
425 fd, 0, pb_membersize(st, m[0]), 0, ptr}
427 /* Optional fields don't need a has_ variable, as information would be redundant */
428 #define PB_OPTIONAL_POINTER(tag, st, m, fd, ltype, ptr) \
429 {tag, PB_ATYPE_POINTER | PB_HTYPE_OPTIONAL | ltype, \
430 fd, 0, pb_membersize(st, m[0]), 0, ptr}
432 /* Repeated fields have a _count field and a pointer to array of pointers */
433 #define PB_REPEATED_POINTER(tag, st, m, fd, ltype, ptr) \
434 {tag, PB_ATYPE_POINTER | PB_HTYPE_REPEATED | ltype, \
435 fd, pb_delta(st, m ## _count, m), \
436 pb_membersize(st, m[0]), 0, ptr}
438 /* Callbacks are much like required fields except with special datatype. */
439 #define PB_REQUIRED_CALLBACK(tag, st, m, fd, ltype, ptr) \
440 {tag, PB_ATYPE_CALLBACK | PB_HTYPE_REQUIRED | ltype, \
441 fd, 0, pb_membersize(st, m), 0, ptr}
443 #define PB_OPTIONAL_CALLBACK(tag, st, m, fd, ltype, ptr) \
444 {tag, PB_ATYPE_CALLBACK | PB_HTYPE_OPTIONAL | ltype, \
445 fd, 0, pb_membersize(st, m), 0, ptr}
447 #define PB_REPEATED_CALLBACK(tag, st, m, fd, ltype, ptr) \
448 {tag, PB_ATYPE_CALLBACK | PB_HTYPE_REPEATED | ltype, \
449 fd, 0, pb_membersize(st, m), 0, ptr}
451 /* Optional extensions don't have the has_ field, as that would be redundant. */
452 #define PB_OPTEXT_STATIC(tag, st, m, fd, ltype, ptr) \
453 {tag, PB_ATYPE_STATIC | PB_HTYPE_OPTIONAL | ltype, \
456 pb_membersize(st, m), 0, ptr}
458 #define PB_OPTEXT_POINTER(tag, st, m, fd, ltype, ptr) \
459 PB_OPTIONAL_POINTER(tag, st, m, fd, ltype, ptr)
461 #define PB_OPTEXT_CALLBACK(tag, st, m, fd, ltype, ptr) \
462 PB_OPTIONAL_CALLBACK(tag, st, m, fd, ltype, ptr)
464 /* The mapping from protobuf types to LTYPEs is done using these macros. */
465 #define PB_LTYPE_MAP_BOOL PB_LTYPE_VARINT
466 #define PB_LTYPE_MAP_BYTES PB_LTYPE_BYTES
467 #define PB_LTYPE_MAP_DOUBLE PB_LTYPE_FIXED64
468 #define PB_LTYPE_MAP_ENUM PB_LTYPE_VARINT
469 #define PB_LTYPE_MAP_UENUM PB_LTYPE_UVARINT
470 #define PB_LTYPE_MAP_FIXED32 PB_LTYPE_FIXED32
471 #define PB_LTYPE_MAP_FIXED64 PB_LTYPE_FIXED64
472 #define PB_LTYPE_MAP_FLOAT PB_LTYPE_FIXED32
473 #define PB_LTYPE_MAP_INT32 PB_LTYPE_VARINT
474 #define PB_LTYPE_MAP_INT64 PB_LTYPE_VARINT
475 #define PB_LTYPE_MAP_MESSAGE PB_LTYPE_SUBMESSAGE
476 #define PB_LTYPE_MAP_SFIXED32 PB_LTYPE_FIXED32
477 #define PB_LTYPE_MAP_SFIXED64 PB_LTYPE_FIXED64
478 #define PB_LTYPE_MAP_SINT32 PB_LTYPE_SVARINT
479 #define PB_LTYPE_MAP_SINT64 PB_LTYPE_SVARINT
480 #define PB_LTYPE_MAP_STRING PB_LTYPE_STRING
481 #define PB_LTYPE_MAP_UINT32 PB_LTYPE_UVARINT
482 #define PB_LTYPE_MAP_UINT64 PB_LTYPE_UVARINT
483 #define PB_LTYPE_MAP_EXTENSION PB_LTYPE_EXTENSION
485 /* This is the actual macro used in field descriptions.
486 * It takes these arguments:
488 * - Field type: BOOL, BYTES, DOUBLE, ENUM, UENUM, FIXED32, FIXED64,
489 * FLOAT, INT32, INT64, MESSAGE, SFIXED32, SFIXED64
490 * SINT32, SINT64, STRING, UINT32, UINT64 or EXTENSION
491 * - Field rules: REQUIRED, OPTIONAL or REPEATED
492 * - Allocation: STATIC or CALLBACK
493 * - Placement: FIRST or OTHER, depending on if this is the first field in structure.
496 * - Previous field name (or field name again for first field)
497 * - Pointer to default value or submsg fields.
500 #define PB_FIELD(tag, type, rules, allocation, placement, message, field, prevfield, ptr) \
501 PB_ ## rules ## _ ## allocation(tag, message, field, \
502 PB_DATAOFFSET_ ## placement(message, field, prevfield), \
503 PB_LTYPE_MAP_ ## type, ptr)
505 /* Field description for oneof fields. This requires taking into account the
506 * union name also, that's why a separate set of macros is needed.
508 #define PB_ONEOF_STATIC(u, tag, st, m, fd, ltype, ptr) \
509 {tag, PB_ATYPE_STATIC | PB_HTYPE_ONEOF | ltype, \
510 fd, pb_delta(st, which_ ## u, u.m), \
511 pb_membersize(st, u.m), 0, ptr}
513 #define PB_ONEOF_POINTER(u, tag, st, m, fd, ltype, ptr) \
514 {tag, PB_ATYPE_POINTER | PB_HTYPE_ONEOF | ltype, \
515 fd, pb_delta(st, which_ ## u, u.m), \
516 pb_membersize(st, u.m[0]), 0, ptr}
518 #define PB_ONEOF_FIELD(union_name, tag, type, rules, allocation, placement, message, field, prevfield, ptr) \
519 PB_ONEOF_ ## allocation(union_name, tag, message, field, \
520 PB_DATAOFFSET_ ## placement(message, union_name.field, prevfield), \
521 PB_LTYPE_MAP_ ## type, ptr)
523 #define PB_ANONYMOUS_ONEOF_STATIC(u, tag, st, m, fd, ltype, ptr) \
524 {tag, PB_ATYPE_STATIC | PB_HTYPE_ONEOF | ltype, \
525 fd, pb_delta(st, which_ ## u, m), \
526 pb_membersize(st, m), 0, ptr}
528 #define PB_ANONYMOUS_ONEOF_POINTER(u, tag, st, m, fd, ltype, ptr) \
529 {tag, PB_ATYPE_POINTER | PB_HTYPE_ONEOF | ltype, \
530 fd, pb_delta(st, which_ ## u, m), \
531 pb_membersize(st, m[0]), 0, ptr}
533 #define PB_ANONYMOUS_ONEOF_FIELD(union_name, tag, type, rules, allocation, placement, message, field, prevfield, ptr) \
534 PB_ANONYMOUS_ONEOF_ ## allocation(union_name, tag, message, field, \
535 PB_DATAOFFSET_ ## placement(message, field, prevfield), \
536 PB_LTYPE_MAP_ ## type, ptr)
538 /* These macros are used for giving out error messages.
539 * They are mostly a debugging aid; the main error information
540 * is the true/false return value from functions.
541 * Some code space can be saved by disabling the error
542 * messages if not used.
544 * PB_SET_ERROR() sets the error message if none has been set yet.
545 * msg must be a constant string literal.
546 * PB_GET_ERROR() always returns a pointer to a string.
547 * PB_RETURN_ERROR() sets the error and returns false from current
551 #define PB_SET_ERROR(stream, msg) PB_UNUSED(stream)
552 #define PB_GET_ERROR(stream) "(errmsg disabled)"
554 #define PB_SET_ERROR(stream, msg) (stream->errmsg = (stream)->errmsg ? (stream)->errmsg : (msg))
555 #define PB_GET_ERROR(stream) ((stream)->errmsg ? (stream)->errmsg : "(none)")
558 #define PB_RETURN_ERROR(stream, msg) return PB_SET_ERROR(stream, msg), false