pb.h

   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.
   3  */
   4
   5 #ifndef _PB_H_
   6 #define _PB_H_
   7
   8 /*****************************************************************
   9  * Nanopb compilation time options. You can change these here by *
  10  * uncommenting the lines, or on the compiler command line.      *
  11  *****************************************************************/
  12
  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 */
  16
  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 */
  20
  21 /* Add support for tag numbers > 255 and fields larger than 255 bytes. */
  22 /* #define PB_FIELD_16BIT 1 */
  23
  24 /* Add support for tag numbers > 65536 and fields larger than 65536 bytes. */
  25 /* #define PB_FIELD_32BIT 1 */
  26
  27 /* Disable support for error messages in order to save some code space. */
  28 /* #define PB_NO_ERRMSG 1 */
  29
  30 /* Disable support for custom streams (support only memory buffers). */
  31 /* #define PB_BUFFER_ONLY 1 */
  32
  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 */
  36
  37
  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  ******************************************************************/
  42
  43
  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.4-dev
  47
  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
  52  * - size_t
  53  * - bool
  54  *
  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.
  58  */
  59 #ifdef PB_SYSTEM_HEADER
  60 #include PB_SYSTEM_HEADER
  61 #else
  62 #include <stdint.h>
  63 #include <stddef.h>
  64 #include <stdbool.h>
  65 #include <string.h>
  66 #endif
  67
  68 /* Macro for defining packed structures (compiler dependent).
  69  * This just reduces memory requirements, but is not required.
  70  */
  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)")
  80 #   define pb_packed
  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))
  85 #   define pb_packed
  86 #else
  87     /* Unknown compiler */
  88 #   define PB_PACKED_STRUCT_START
  89 #   define PB_PACKED_STRUCT_END
  90 #   define pb_packed
  91 #endif
  92
  93 /* Handly macro for suppressing unreferenced-parameter compiler warnings. */
  94 #ifndef UNUSED
  95 #define UNUSED(x) (void)(x)
  96 #endif
  97
  98 /* Compile-time assertion, used for checking compatible compilation options.
  99  * If this fails on your compiler for some reason, use #define STATIC_ASSERT
 100  * to disable it. */
 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
 105 #endif
 106
 107 /* Number of required fields to keep track of. */
 108 #ifndef PB_MAX_REQUIRED_FIELDS
 109 #define PB_MAX_REQUIRED_FIELDS 64
 110 #endif
 111
 112 #if PB_MAX_REQUIRED_FIELDS < 64
 113 #error You should not lower PB_MAX_REQUIRED_FIELDS from the default value (64).
 114 #endif
 115
 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.
 119  *
 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.
 124  */
 125
 126 typedef uint8_t pb_type_t;
 127
 128 /**** Field data types ****/
 129
 130 /* Numeric 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 */
 135
 136 /* Marker for last packable field type. */
 137 #define PB_LTYPE_LAST_PACKABLE 0x03
 138
 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
 142
 143 /* String with pre-allocated buffer.
 144  * data_size is the maximum length. */
 145 #define PB_LTYPE_STRING 0x05
 146
 147 /* Submessage
 148  * submsg_fields is pointer to field descriptions */
 149 #define PB_LTYPE_SUBMESSAGE 0x06
 150
 151 /* Extension pseudo-field
 152  * The field contains a pointer to pb_extension_t */
 153 #define PB_LTYPE_EXTENSION 0x07
 154
 155 /* Number of declared LTYPES */
 156 #define PB_LTYPES_COUNT 8
 157 #define PB_LTYPE_MASK 0x0F
 158
 159 /**** Field repetition rules ****/
 160
 161 #define PB_HTYPE_REQUIRED 0x00
 162 #define PB_HTYPE_OPTIONAL 0x10
 163 #define PB_HTYPE_REPEATED 0x20
 164 #define PB_HTYPE_MASK     0x30
 165
 166 /**** Field allocation types ****/
 167
 168 #define PB_ATYPE_STATIC   0x00
 169 #define PB_ATYPE_CALLBACK 0x40
 170 #define PB_ATYPE_MASK     0xC0
 171
 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)
 175
 176 /* Data type used for storing sizes of struct fields
 177  * and array counts.
 178  */
 179 #if defined(PB_FIELD_32BIT)
 180     typedef uint32_t pb_size_t;
 181     typedef int32_t pb_ssize_t;
 182 #elif defined(PB_FIELD_16BIT)
 183     typedef uint16_t pb_size_t;
 184     typedef int16_t pb_ssize_t;
 185 #else
 186     typedef uint8_t pb_size_t;
 187     typedef int8_t pb_ssize_t;
 188 #endif
 189
 190 /* This structure is used in auto-generated constants
 191  * to specify struct fields.
 192  * You can change field sizes if you need structures
 193  * larger than 256 bytes or field tags larger than 256.
 194  * The compiler should complain if your .proto has such
 195  * structures. Fix that by defining PB_FIELD_16BIT or
 196  * PB_FIELD_32BIT.
 197  */
 198 PB_PACKED_STRUCT_START
 199 typedef struct _pb_field_t pb_field_t;
 200 struct _pb_field_t {
 201     pb_size_t tag;
 202     pb_type_t type;
 203     pb_size_t data_offset; /* Offset of field data, relative to previous field. */
 204     pb_ssize_t size_offset; /* Offset of array size or has-boolean, relative to data */
 205     pb_size_t data_size; /* Data size in bytes for a single item */
 206     pb_size_t array_size; /* Maximum number of entries in array */
 207
 208     /* Field definitions for submessage
 209      * OR default value for all other non-array, non-callback types
 210      * If null, then field will zeroed. */
 211     const void *ptr;
 212 } pb_packed;
 213 PB_PACKED_STRUCT_END
 214
 215 /* Make sure that the standard integer types are of the expected sizes.
 216  * All kinds of things may break otherwise.. atleast all fixed* types. */
 217 STATIC_ASSERT(sizeof(int8_t) == 1, INT8_T_WRONG_SIZE)
 218 STATIC_ASSERT(sizeof(uint8_t) == 1, UINT8_T_WRONG_SIZE)
 219 STATIC_ASSERT(sizeof(int16_t) == 2, INT16_T_WRONG_SIZE)
 220 STATIC_ASSERT(sizeof(uint16_t) == 2, UINT16_T_WRONG_SIZE)
 221 STATIC_ASSERT(sizeof(int32_t) == 4, INT32_T_WRONG_SIZE)
 222 STATIC_ASSERT(sizeof(uint32_t) == 4, UINT32_T_WRONG_SIZE)
 223 STATIC_ASSERT(sizeof(int64_t) == 8, INT64_T_WRONG_SIZE)
 224 STATIC_ASSERT(sizeof(uint64_t) == 8, UINT64_T_WRONG_SIZE)
 225
 226 /* This structure is used for 'bytes' arrays.
 227  * It has the number of bytes in the beginning, and after that an array.
 228  * Note that actual structs used will have a different length of bytes array.
 229  */
 230 struct _pb_bytes_array_t {
 231     size_t size;
 232     uint8_t bytes[1];
 233 };
 234
 235 typedef struct _pb_bytes_array_t pb_bytes_array_t;
 236
 237 /* This structure is used for giving the callback function.
 238  * It is stored in the message structure and filled in by the method that
 239  * calls pb_decode.
 240  *
 241  * The decoding callback will be given a limited-length stream
 242  * If the wire type was string, the length is the length of the string.
 243  * If the wire type was a varint/fixed32/fixed64, the length is the length
 244  * of the actual value.
 245  * The function may be called multiple times (especially for repeated types,
 246  * but also otherwise if the message happens to contain the field multiple
 247  * times.)
 248  *
 249  * The encoding callback will receive the actual output stream.
 250  * It should write all the data in one call, including the field tag and
 251  * wire type. It can write multiple fields.
 252  *
 253  * The callback can be null if you want to skip a field.
 254  */
 255 typedef struct _pb_istream_t pb_istream_t;
 256 typedef struct _pb_ostream_t pb_ostream_t;
 257 typedef struct _pb_callback_t pb_callback_t;
 258 struct _pb_callback_t {
 259 #ifdef PB_OLD_CALLBACK_STYLE
 260     /* Deprecated since nanopb-0.2.1 */
 261     union {
 262         bool (*decode)(pb_istream_t *stream, const pb_field_t *field, void *arg);
 263         bool (*encode)(pb_ostream_t *stream, const pb_field_t *field, const void *arg);
 264     } funcs;
 265 #else
 266     /* New function signature, which allows modifying arg contents in callback. */
 267     union {
 268         bool (*decode)(pb_istream_t *stream, const pb_field_t *field, void **arg);
 269         bool (*encode)(pb_ostream_t *stream, const pb_field_t *field, void * const *arg);
 270     } funcs;
 271 #endif
 272
 273     /* Free arg for use by callback */
 274     void *arg;
 275 };
 276
 277 /* Wire types. Library user needs these only in encoder callbacks. */
 278 typedef enum {
 279     PB_WT_VARINT = 0,
 280     PB_WT_64BIT  = 1,
 281     PB_WT_STRING = 2,
 282     PB_WT_32BIT  = 5
 283 } pb_wire_type_t;
 284
 285 /* Structure for defining the handling of unknown/extension fields.
 286  * Usually the pb_extension_type_t structure is automatically generated,
 287  * while the pb_extension_t structure is created by the user. However,
 288  * if you want to catch all unknown fields, you can also create a custom
 289  * pb_extension_type_t with your own callback.
 290  */
 291 typedef struct _pb_extension_type_t pb_extension_type_t;
 292 typedef struct _pb_extension_t pb_extension_t;
 293 struct _pb_extension_type_t {
 294     /* Called for each unknown field in the message.
 295      * If you handle the field, read off all of its data and return true.
 296      * If you do not handle the field, do not read anything and return true.
 297      * If you run into an error, return false.
 298      * Set to NULL for default handler.
 299      */
 300     bool (*decode)(pb_istream_t *stream, pb_extension_t *extension,
 301                    uint32_t tag, pb_wire_type_t wire_type);
 302
 303     /* Called once after all regular fields have been encoded.
 304      * If you have something to write, do so and return true.
 305      * If you do not have anything to write, just return true.
 306      * If you run into an error, return false.
 307      * Set to NULL for default handler.
 308      */
 309     bool (*encode)(pb_ostream_t *stream, const pb_extension_t *extension);
 310
 311     /* Free field for use by the callback. */
 312     const void *arg;
 313 };
 314
 315 struct _pb_extension_t {
 316     /* Type describing the extension field. Usually you'll initialize
 317      * this to a pointer to the automatically generated structure. */
 318     const pb_extension_type_t *type;
 319
 320     /* Destination for the decoded data. This must match the datatype
 321      * of the extension field. */
 322     void *dest;
 323
 324     /* Pointer to the next extension handler, or NULL.
 325      * If this extension does not match a field, the next handler is
 326      * automatically called. */
 327     pb_extension_t *next;
 328 };
 329
 330 /* These macros are used to declare pb_field_t's in the constant array. */
 331 /* Size of a structure member, in bytes. */
 332 #define pb_membersize(st, m) (sizeof ((st*)0)->m)
 333 /* Number of entries in an array. */
 334 #define pb_arraysize(st, m) (pb_membersize(st, m) / pb_membersize(st, m[0]))
 335 /* Delta from start of one member to the start of another member. */
 336 #define pb_delta(st, m1, m2) ((int)offsetof(st, m1) - (int)offsetof(st, m2))
 337 /* Marks the end of the field list */
 338 #define PB_LAST_FIELD {0,(pb_type_t) 0,0,0,0,0,0}
 339
 340 /* Macros for filling in the data_offset field */
 341 /* data_offset for first field in a message */
 342 #define PB_DATAOFFSET_FIRST(st, m1, m2) (offsetof(st, m1))
 343 /* data_offset for subsequent fields */
 344 #define PB_DATAOFFSET_OTHER(st, m1, m2) (offsetof(st, m1) - offsetof(st, m2) - pb_membersize(st, m2))
 345 /* Choose first/other based on m1 == m2 (deprecated, remains for backwards compatibility) */
 346 #define PB_DATAOFFSET_CHOOSE(st, m1, m2) (int)(offsetof(st, m1) == offsetof(st, m2) \
 347                                   ? PB_DATAOFFSET_FIRST(st, m1, m2) \
 348                                   : PB_DATAOFFSET_OTHER(st, m1, m2))
 349
 350 /* Required fields are the simplest. They just have delta (padding) from
 351  * previous field end, and the size of the field. Pointer is used for
 352  * submessages and default values.
 353  */
 354 #define PB_REQUIRED_STATIC(tag, st, m, fd, ltype, ptr) \
 355     {tag, PB_ATYPE_STATIC | PB_HTYPE_REQUIRED | ltype, \
 356     fd, 0, pb_membersize(st, m), 0, ptr}
 357
 358 /* Optional fields add the delta to the has_ variable. */
 359 #define PB_OPTIONAL_STATIC(tag, st, m, fd, ltype, ptr) \
 360     {tag, PB_ATYPE_STATIC | PB_HTYPE_OPTIONAL | ltype, \
 361     fd, \
 362     pb_delta(st, has_ ## m, m), \
 363     pb_membersize(st, m), 0, ptr}
 364
 365 /* Repeated fields have a _count field and also the maximum number of entries. */
 366 #define PB_REPEATED_STATIC(tag, st, m, fd, ltype, ptr) \
 367     {tag, PB_ATYPE_STATIC | PB_HTYPE_REPEATED | ltype, \
 368     fd, \
 369     pb_delta(st, m ## _count, m), \
 370     pb_membersize(st, m[0]), \
 371     pb_arraysize(st, m), ptr}
 372
 373 /* Callbacks are much like required fields except with special datatype. */
 374 #define PB_REQUIRED_CALLBACK(tag, st, m, fd, ltype, ptr) \
 375     {tag, PB_ATYPE_CALLBACK | PB_HTYPE_REQUIRED | ltype, \
 376     fd, 0, pb_membersize(st, m), 0, ptr}
 377
 378 #define PB_OPTIONAL_CALLBACK(tag, st, m, fd, ltype, ptr) \
 379     {tag, PB_ATYPE_CALLBACK | PB_HTYPE_OPTIONAL | ltype, \
 380     fd, 0, pb_membersize(st, m), 0, ptr}
 381
 382 #define PB_REPEATED_CALLBACK(tag, st, m, fd, ltype, ptr) \
 383     {tag, PB_ATYPE_CALLBACK | PB_HTYPE_REPEATED | ltype, \
 384     fd, 0, pb_membersize(st, m), 0, ptr}
 385
 386 /* Optional extensions don't have the has_ field, as that would be redundant. */
 387 #define PB_OPTEXT_STATIC(tag, st, m, fd, ltype, ptr) \
 388     {tag, PB_ATYPE_STATIC | PB_HTYPE_OPTIONAL | ltype, \
 389     0, \
 390     0, \
 391     pb_membersize(st, m), 0, ptr}
 392
 393 #define PB_OPTEXT_CALLBACK(tag, st, m, fd, ltype, ptr) \
 394     {tag, PB_ATYPE_CALLBACK | PB_HTYPE_OPTIONAL | ltype, \
 395     0, 0, pb_membersize(st, m), 0, ptr}
 396
 397 /* The mapping from protobuf types to LTYPEs is done using these macros. */
 398 #define PB_LTYPE_MAP_BOOL       PB_LTYPE_VARINT
 399 #define PB_LTYPE_MAP_BYTES      PB_LTYPE_BYTES
 400 #define PB_LTYPE_MAP_DOUBLE     PB_LTYPE_FIXED64
 401 #define PB_LTYPE_MAP_ENUM       PB_LTYPE_VARINT
 402 #define PB_LTYPE_MAP_FIXED32    PB_LTYPE_FIXED32
 403 #define PB_LTYPE_MAP_FIXED64    PB_LTYPE_FIXED64
 404 #define PB_LTYPE_MAP_FLOAT      PB_LTYPE_FIXED32
 405 #define PB_LTYPE_MAP_INT32      PB_LTYPE_VARINT
 406 #define PB_LTYPE_MAP_INT64      PB_LTYPE_VARINT
 407 #define PB_LTYPE_MAP_MESSAGE    PB_LTYPE_SUBMESSAGE
 408 #define PB_LTYPE_MAP_SFIXED32   PB_LTYPE_FIXED32
 409 #define PB_LTYPE_MAP_SFIXED64   PB_LTYPE_FIXED64
 410 #define PB_LTYPE_MAP_SINT32     PB_LTYPE_SVARINT
 411 #define PB_LTYPE_MAP_SINT64     PB_LTYPE_SVARINT
 412 #define PB_LTYPE_MAP_STRING     PB_LTYPE_STRING
 413 #define PB_LTYPE_MAP_UINT32     PB_LTYPE_VARINT
 414 #define PB_LTYPE_MAP_UINT64     PB_LTYPE_VARINT
 415 #define PB_LTYPE_MAP_EXTENSION  PB_LTYPE_EXTENSION
 416
 417 /* This is the actual macro used in field descriptions.
 418  * It takes these arguments:
 419  * - Field tag number
 420  * - Field type:   BOOL, BYTES, DOUBLE, ENUM, FIXED32, FIXED64,
 421  *                 FLOAT, INT32, INT64, MESSAGE, SFIXED32, SFIXED64
 422  *                 SINT32, SINT64, STRING, UINT32, UINT64 or EXTENSION
 423  * - Field rules:  REQUIRED, OPTIONAL or REPEATED
 424  * - Allocation:   STATIC or CALLBACK
 425  * - Message name
 426  * - Field name
 427  * - Previous field name (or field name again for first field)
 428  * - Pointer to default value or submsg fields.
 429  */
 430
 431 #define PB_FIELD(tag, type, rules, allocation, message, field, prevfield, ptr) \
 432     PB_ ## rules ## _ ## allocation(tag, message, field, \
 433         PB_DATAOFFSET_CHOOSE(message, field, prevfield), \
 434         PB_LTYPE_MAP_ ## type, ptr)
 435
 436 /* This is a new version of the macro used by nanopb generator from
 437  * version 0.2.3 onwards. It avoids the use of a ternary expression in
 438  * the initialization, which confused some compilers.
 439  *
 440  * - Placement: FIRST or OTHER, depending on if this is the first field in structure.
 441  *
 442  */
 443 #define PB_FIELD2(tag, type, rules, allocation, placement, message, field, prevfield, ptr) \
 444     PB_ ## rules ## _ ## allocation(tag, message, field, \
 445         PB_DATAOFFSET_ ## placement(message, field, prevfield), \
 446         PB_LTYPE_MAP_ ## type, ptr)
 447
 448
 449 /* These macros are used for giving out error messages.
 450  * They are mostly a debugging aid; the main error information
 451  * is the true/false return value from functions.
 452  * Some code space can be saved by disabling the error
 453  * messages if not used.
 454  */
 455 #ifdef PB_NO_ERRMSG
 456 #define PB_RETURN_ERROR(stream,msg) return false
 457 #define PB_GET_ERROR(stream) "(errmsg disabled)"
 458 #else
 459 #define PB_RETURN_ERROR(stream,msg) \
 460     do {\
 461         if ((stream)->errmsg == NULL) \
 462             (stream)->errmsg = (msg); \
 463         return false; \
 464     } while(0)
 465 #define PB_GET_ERROR(stream) ((stream)->errmsg ? (stream)->errmsg : "(none)")
 466 #endif
 467
 468 #endif