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