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 /* Define this if your CPU architecture is big endian, i.e. it
14 * stores the most-significant byte first. */
15 /* #define __BIG_ENDIAN__ 1 */
17 /* Increase the number of required fields that are tracked.
18 * A compiler warning will tell if you need this. */
19 /* #define PB_MAX_REQUIRED_FIELDS 256 */
21 /* Add support for tag numbers > 255 and fields larger than 255 bytes. */
22 /* #define PB_FIELD_16BIT 1 */
24 /* Add support for tag numbers > 65536 and fields larger than 65536 bytes. */
25 /* #define PB_FIELD_32BIT 1 */
27 /* Disable support for error messages in order to save some code space. */
28 /* #define PB_NO_ERRMSG 1 */
30 /* Disable support for custom streams (support only memory buffers). */
31 /* #define PB_BUFFER_ONLY 1 */
33 /* Switch back to the old-style callback function signature.
34 * This was the default until nanopb-0.2.1. */
35 /* #define PB_OLD_CALLBACK_STYLE */
38 /******************************************************************
39 * You usually don't need to change anything below this line. *
40 * Feel free to look around and use the defined macros, though. *
41 ******************************************************************/
44 /* Version of the nanopb library. Just in case you want to check it in
45 * your own program. */
46 #define NANOPB_VERSION nanopb-0.2.3-dev
48 /* Include all the system headers needed by nanopb. You will need the
49 * definitions of the following:
50 * - strlen, memcpy, memset functions
51 * - [u]int8_t, [u]int16_t, [u]int32_t, [u]int64_t
55 * If you don't have the standard header files, you can instead provide
56 * a custom header that defines or includes all this. In that case,
57 * define PB_SYSTEM_HEADER to the path of this file.
59 #ifdef PB_SYSTEM_HEADER
60 #include PB_SYSTEM_HEADER
68 /* Macro for defining packed structures (compiler dependent).
69 * This just reduces memory requirements, but is not required.
71 #if defined(__GNUC__) || defined(__clang__)
72 /* For GCC and clang */
73 # define PB_PACKED_STRUCT_START
74 # define PB_PACKED_STRUCT_END
75 # define pb_packed __attribute__((packed))
76 #elif defined(__ICCARM__)
77 /* For IAR ARM compiler */
78 # define PB_PACKED_STRUCT_START _Pragma("pack(push, 1)")
79 # define PB_PACKED_STRUCT_END _Pragma("pack(pop)")
81 #elif defined(_MSC_VER) && (_MSC_VER >= 1500)
82 /* For Microsoft Visual C++ */
83 # define PB_PACKED_STRUCT_START __pragma(pack(push, 1))
84 # define PB_PACKED_STRUCT_END __pragma(pack(pop))
87 /* Unknown compiler */
88 # define PB_PACKED_STRUCT_START
89 # define PB_PACKED_STRUCT_END
93 /* Handly macro for suppressing unreferenced-parameter compiler warnings. */
95 #define UNUSED(x) (void)(x)
98 /* Compile-time assertion, used for checking compatible compilation options.
99 * If this fails on your compiler for some reason, use #define STATIC_ASSERT
101 #ifndef STATIC_ASSERT
102 #define STATIC_ASSERT(COND,MSG) typedef char STATIC_ASSERT_MSG(MSG, __LINE__, __COUNTER__)[(COND)?1:-1];
103 #define STATIC_ASSERT_MSG(MSG, LINE, COUNTER) STATIC_ASSERT_MSG_(MSG, LINE, COUNTER)
104 #define STATIC_ASSERT_MSG_(MSG, LINE, COUNTER) static_assertion_##MSG##LINE##COUNTER
107 /* Number of required fields to keep track of. */
108 #ifndef PB_MAX_REQUIRED_FIELDS
109 #define PB_MAX_REQUIRED_FIELDS 64
112 #if PB_MAX_REQUIRED_FIELDS < 64
113 #error You should not lower PB_MAX_REQUIRED_FIELDS from the default value (64).
116 /* List of possible field types. These are used in the autogenerated code.
117 * Least-significant 4 bits tell the scalar type
118 * Most-significant 4 bits specify repeated/required/packed etc.
120 * INT32 and UINT32 are treated the same, as are (U)INT64 and (S)FIXED*
121 * These types are simply casted to correct field type when they are
122 * assigned to the memory pointer.
123 * SINT* is different, though, because it is zig-zag coded.
126 typedef uint8_t pb_type_t;
128 /**** Field data types ****/
131 #define PB_LTYPE_VARINT 0x00 /* int32, uint32, int64, uint64, bool, enum */
132 #define PB_LTYPE_SVARINT 0x01 /* sint32, sint64 */
133 #define PB_LTYPE_FIXED32 0x02 /* fixed32, sfixed32, float */
134 #define PB_LTYPE_FIXED64 0x03 /* fixed64, sfixed64, double */
136 /* Marker for last packable field type. */
137 #define PB_LTYPE_LAST_PACKABLE 0x03
139 /* Byte array with pre-allocated buffer.
140 * data_size is the length of the allocated PB_BYTES_ARRAY structure. */
141 #define PB_LTYPE_BYTES 0x04
143 /* String with pre-allocated buffer.
144 * data_size is the maximum length. */
145 #define PB_LTYPE_STRING 0x05
148 * submsg_fields is pointer to field descriptions */
149 #define PB_LTYPE_SUBMESSAGE 0x06
151 /* Extension pseudo-field
152 * The field contains a pointer to pb_extension_t */
153 #define PB_LTYPE_EXTENSION 0x07
155 /* Number of declared LTYPES */
156 #define PB_LTYPES_COUNT 8
157 #define PB_LTYPE_MASK 0x0F
159 /**** Field repetition rules ****/
161 #define PB_HTYPE_REQUIRED 0x00
162 #define PB_HTYPE_OPTIONAL 0x10
163 #define PB_HTYPE_REPEATED 0x20
164 #define PB_HTYPE_MASK 0x30
166 /**** Field allocation types ****/
168 #define PB_ATYPE_STATIC 0x00
169 #define PB_ATYPE_CALLBACK 0x40
170 #define PB_ATYPE_MASK 0xC0
172 #define PB_ATYPE(x) ((x) & PB_ATYPE_MASK)
173 #define PB_HTYPE(x) ((x) & PB_HTYPE_MASK)
174 #define PB_LTYPE(x) ((x) & PB_LTYPE_MASK)
176 /* This structure is used in auto-generated constants
177 * to specify struct fields.
178 * You can change field sizes if you need structures
179 * larger than 256 bytes or field tags larger than 256.
180 * The compiler should complain if your .proto has such
181 * structures. Fix that by defining PB_FIELD_16BIT or
184 PB_PACKED_STRUCT_START
185 typedef struct _pb_field_t pb_field_t;
188 #if !defined(PB_FIELD_16BIT) && !defined(PB_FIELD_32BIT)
191 uint8_t data_offset; /* Offset of field data, relative to previous field. */
192 int8_t size_offset; /* Offset of array size or has-boolean, relative to data */
193 uint8_t data_size; /* Data size in bytes for a single item */
194 uint8_t array_size; /* Maximum number of entries in array */
195 #elif defined(PB_FIELD_16BIT) && !defined(PB_FIELD_32BIT)
211 /* Field definitions for submessage
212 * OR default value for all other non-array, non-callback types
213 * If null, then field will zeroed. */
218 /* Make sure that the standard integer types are of the expected sizes.
219 * All kinds of things may break otherwise.. atleast all fixed* types. */
220 STATIC_ASSERT(sizeof(int8_t) == 1, INT8_T_WRONG_SIZE)
221 STATIC_ASSERT(sizeof(uint8_t) == 1, UINT8_T_WRONG_SIZE)
222 STATIC_ASSERT(sizeof(int16_t) == 2, INT16_T_WRONG_SIZE)
223 STATIC_ASSERT(sizeof(uint16_t) == 2, UINT16_T_WRONG_SIZE)
224 STATIC_ASSERT(sizeof(int32_t) == 4, INT32_T_WRONG_SIZE)
225 STATIC_ASSERT(sizeof(uint32_t) == 4, UINT32_T_WRONG_SIZE)
226 STATIC_ASSERT(sizeof(int64_t) == 8, INT64_T_WRONG_SIZE)
227 STATIC_ASSERT(sizeof(uint64_t) == 8, UINT64_T_WRONG_SIZE)
229 /* This structure is used for 'bytes' arrays.
230 * It has the number of bytes in the beginning, and after that an array.
231 * Note that actual structs used will have a different length of bytes array.
233 struct _pb_bytes_array_t {
238 typedef struct _pb_bytes_array_t pb_bytes_array_t;
240 /* This structure is used for giving the callback function.
241 * It is stored in the message structure and filled in by the method that
244 * The decoding callback will be given a limited-length stream
245 * If the wire type was string, the length is the length of the string.
246 * If the wire type was a varint/fixed32/fixed64, the length is the length
247 * of the actual value.
248 * The function may be called multiple times (especially for repeated types,
249 * but also otherwise if the message happens to contain the field multiple
252 * The encoding callback will receive the actual output stream.
253 * It should write all the data in one call, including the field tag and
254 * wire type. It can write multiple fields.
256 * The callback can be null if you want to skip a field.
258 typedef struct _pb_istream_t pb_istream_t;
259 typedef struct _pb_ostream_t pb_ostream_t;
260 typedef struct _pb_callback_t pb_callback_t;
261 struct _pb_callback_t {
262 #ifdef PB_OLD_CALLBACK_STYLE
263 /* Deprecated since nanopb-0.2.1 */
265 bool (*decode)(pb_istream_t *stream, const pb_field_t *field, void *arg);
266 bool (*encode)(pb_ostream_t *stream, const pb_field_t *field, const void *arg);
269 /* New function signature, which allows modifying arg contents in callback. */
271 bool (*decode)(pb_istream_t *stream, const pb_field_t *field, void **arg);
272 bool (*encode)(pb_ostream_t *stream, const pb_field_t *field, void * const *arg);
276 /* Free arg for use by callback */
280 /* Wire types. Library user needs these only in encoder callbacks. */
288 /* Structure for defining the handling of unknown/extension fields.
289 * Usually the pb_extension_type_t structure is automatically generated,
290 * while the pb_extension_t structure is created by the user. However,
291 * if you want to catch all unknown fields, you can also create a custom
292 * pb_extension_type_t with your own callback.
294 typedef struct _pb_extension_type_t pb_extension_type_t;
295 typedef struct _pb_extension_t pb_extension_t;
296 struct _pb_extension_type_t {
297 /* Called for each unknown field in the message.
298 * If you handle the field, read off all of its data and return true.
299 * If you do not handle the field, do not read anything and return true.
300 * If you run into an error, return false.
301 * Set to NULL for default handler.
303 bool (*decode)(pb_istream_t *stream, pb_extension_t *extension,
304 uint32_t tag, pb_wire_type_t wire_type);
306 /* Called once after all regular fields have been encoded.
307 * If you have something to write, do so and return true.
308 * If you do not have anything to write, just return true.
309 * If you run into an error, return false.
310 * Set to NULL for default handler.
312 bool (*encode)(pb_ostream_t *stream, const pb_extension_t *extension);
314 /* Free field for use by the callback. */
318 struct _pb_extension_t {
319 /* Type describing the extension field. Usually you'll initialize
320 * this to a pointer to the automatically generated structure. */
321 const pb_extension_type_t *type;
323 /* Destination for the decoded data. This must match the datatype
324 * of the extension field. */
327 /* Pointer to the next extension handler, or NULL.
328 * If this extension does not match a field, the next handler is
329 * automatically called. */
330 pb_extension_t *next;
333 /* These macros are used to declare pb_field_t's in the constant array. */
334 /* Size of a structure member, in bytes. */
335 #define pb_membersize(st, m) (sizeof ((st*)0)->m)
336 /* Number of entries in an array. */
337 #define pb_arraysize(st, m) (pb_membersize(st, m) / pb_membersize(st, m[0]))
338 /* Delta from start of one member to the start of another member. */
339 #define pb_delta(st, m1, m2) ((int)offsetof(st, m1) - (int)offsetof(st, m2))
340 /* Marks the end of the field list */
341 #define PB_LAST_FIELD {0,(pb_type_t) 0,0,0,0,0,0}
343 /* Macros for filling in the data_offset field */
344 /* data_offset for first field in a message */
345 #define PB_DATAOFFSET_FIRST(st, m1, m2) (offsetof(st, m1))
346 /* data_offset for subsequent fields */
347 #define PB_DATAOFFSET_OTHER(st, m1, m2) (offsetof(st, m1) - offsetof(st, m2) - pb_membersize(st, m2))
348 /* Choose first/other based on m1 == m2 (deprecated, remains for backwards compatibility) */
349 #define PB_DATAOFFSET_CHOOSE(st, m1, m2) (int)(offsetof(st, m1) == offsetof(st, m2) \
350 ? PB_DATAOFFSET_FIRST(st, m1, m2) \
351 : PB_DATAOFFSET_OTHER(st, m1, m2))
353 /* Required fields are the simplest. They just have delta (padding) from
354 * previous field end, and the size of the field. Pointer is used for
355 * submessages and default values.
357 #define PB_REQUIRED_STATIC(tag, st, m, fd, ltype, ptr) \
358 {tag, PB_ATYPE_STATIC | PB_HTYPE_REQUIRED | ltype, \
359 fd, 0, pb_membersize(st, m), 0, ptr}
361 /* Optional fields add the delta to the has_ variable. */
362 #define PB_OPTIONAL_STATIC(tag, st, m, fd, ltype, ptr) \
363 {tag, PB_ATYPE_STATIC | PB_HTYPE_OPTIONAL | ltype, \
365 pb_delta(st, has_ ## m, m), \
366 pb_membersize(st, m), 0, ptr}
368 /* Repeated fields have a _count field and also the maximum number of entries. */
369 #define PB_REPEATED_STATIC(tag, st, m, fd, ltype, ptr) \
370 {tag, PB_ATYPE_STATIC | PB_HTYPE_REPEATED | ltype, \
372 pb_delta(st, m ## _count, m), \
373 pb_membersize(st, m[0]), \
374 pb_arraysize(st, m), ptr}
376 /* Callbacks are much like required fields except with special datatype. */
377 #define PB_REQUIRED_CALLBACK(tag, st, m, fd, ltype, ptr) \
378 {tag, PB_ATYPE_CALLBACK | PB_HTYPE_REQUIRED | ltype, \
379 fd, 0, pb_membersize(st, m), 0, ptr}
381 #define PB_OPTIONAL_CALLBACK(tag, st, m, fd, ltype, ptr) \
382 {tag, PB_ATYPE_CALLBACK | PB_HTYPE_OPTIONAL | ltype, \
383 fd, 0, pb_membersize(st, m), 0, ptr}
385 #define PB_REPEATED_CALLBACK(tag, st, m, fd, ltype, ptr) \
386 {tag, PB_ATYPE_CALLBACK | PB_HTYPE_REPEATED | ltype, \
387 fd, 0, pb_membersize(st, m), 0, ptr}
389 /* Optional extensions don't have the has_ field, as that would be redundant. */
390 #define PB_OPTEXT_STATIC(tag, st, m, fd, ltype, ptr) \
391 {tag, PB_ATYPE_STATIC | PB_HTYPE_OPTIONAL | ltype, \
394 pb_membersize(st, m), 0, ptr}
396 #define PB_OPTEXT_CALLBACK(tag, st, m, fd, ltype, ptr) \
397 {tag, PB_ATYPE_CALLBACK | PB_HTYPE_OPTIONAL | ltype, \
398 0, 0, pb_membersize(st, m), 0, ptr}
400 /* The mapping from protobuf types to LTYPEs is done using these macros. */
401 #define PB_LTYPE_MAP_BOOL PB_LTYPE_VARINT
402 #define PB_LTYPE_MAP_BYTES PB_LTYPE_BYTES
403 #define PB_LTYPE_MAP_DOUBLE PB_LTYPE_FIXED64
404 #define PB_LTYPE_MAP_ENUM PB_LTYPE_VARINT
405 #define PB_LTYPE_MAP_FIXED32 PB_LTYPE_FIXED32
406 #define PB_LTYPE_MAP_FIXED64 PB_LTYPE_FIXED64
407 #define PB_LTYPE_MAP_FLOAT PB_LTYPE_FIXED32
408 #define PB_LTYPE_MAP_INT32 PB_LTYPE_VARINT
409 #define PB_LTYPE_MAP_INT64 PB_LTYPE_VARINT
410 #define PB_LTYPE_MAP_MESSAGE PB_LTYPE_SUBMESSAGE
411 #define PB_LTYPE_MAP_SFIXED32 PB_LTYPE_FIXED32
412 #define PB_LTYPE_MAP_SFIXED64 PB_LTYPE_FIXED64
413 #define PB_LTYPE_MAP_SINT32 PB_LTYPE_SVARINT
414 #define PB_LTYPE_MAP_SINT64 PB_LTYPE_SVARINT
415 #define PB_LTYPE_MAP_STRING PB_LTYPE_STRING
416 #define PB_LTYPE_MAP_UINT32 PB_LTYPE_VARINT
417 #define PB_LTYPE_MAP_UINT64 PB_LTYPE_VARINT
418 #define PB_LTYPE_MAP_EXTENSION PB_LTYPE_EXTENSION
420 /* This is the actual macro used in field descriptions.
421 * It takes these arguments:
423 * - Field type: BOOL, BYTES, DOUBLE, ENUM, FIXED32, FIXED64,
424 * FLOAT, INT32, INT64, MESSAGE, SFIXED32, SFIXED64
425 * SINT32, SINT64, STRING, UINT32, UINT64 or EXTENSION
426 * - Field rules: REQUIRED, OPTIONAL or REPEATED
427 * - Allocation: STATIC or CALLBACK
430 * - Previous field name (or field name again for first field)
431 * - Pointer to default value or submsg fields.
434 #define PB_FIELD(tag, type, rules, allocation, message, field, prevfield, ptr) \
435 PB_ ## rules ## _ ## allocation(tag, message, field, \
436 PB_DATAOFFSET_CHOOSE(message, field, prevfield), \
437 PB_LTYPE_MAP_ ## type, ptr)
439 /* This is a new version of the macro used by nanopb generator from
440 * version 0.2.3 onwards. It avoids the use of a ternary expression in
441 * the initialization, which confused some compilers.
443 * - Placement: FIRST or OTHER, depending on if this is the first field in structure.
446 #define PB_FIELD2(tag, type, rules, allocation, placement, message, field, prevfield, ptr) \
447 PB_ ## rules ## _ ## allocation(tag, message, field, \
448 PB_DATAOFFSET_ ## placement(message, field, prevfield), \
449 PB_LTYPE_MAP_ ## type, ptr)
452 /* These macros are used for giving out error messages.
453 * They are mostly a debugging aid; the main error information
454 * is the true/false return value from functions.
455 * Some code space can be saved by disabling the error
456 * messages if not used.
459 #define PB_RETURN_ERROR(stream,msg) return false
460 #define PB_GET_ERROR(stream) "(errmsg disabled)"
462 #define PB_RETURN_ERROR(stream,msg) \
464 if ((stream)->errmsg == NULL) \
465 (stream)->errmsg = (msg); \
468 #define PB_GET_ERROR(stream) ((stream)->errmsg ? (stream)->errmsg : "(none)")