You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

902 lines
27 KiB

6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
  1. /* pb_encode.c -- encode a protobuf using minimal resources
  2. *
  3. * 2011 Petteri Aimonen <jpa@kapsi.fi>
  4. */
  5. #include "pb.h"
  6. #include "pb_encode.h"
  7. #include "pb_common.h"
  8. /* Use the GCC warn_unused_result attribute to check that all return values
  9. * are propagated correctly. On other compilers and gcc before 3.4.0 just
  10. * ignore the annotation.
  11. */
  12. #if !defined(__GNUC__) || ( __GNUC__ < 3) || (__GNUC__ == 3 && __GNUC_MINOR__ < 4)
  13. #define checkreturn
  14. #else
  15. #define checkreturn __attribute__((warn_unused_result))
  16. #endif
  17. /**************************************
  18. * Declarations internal to this file *
  19. **************************************/
  20. typedef bool (*pb_encoder_t)(pb_ostream_t *stream, const pb_field_t *field, const void *src) checkreturn;
  21. static bool checkreturn buf_write(pb_ostream_t *stream, const pb_byte_t *buf, size_t count);
  22. static bool checkreturn encode_array(pb_ostream_t *stream, const pb_field_t *field, const void *pData, size_t count, pb_encoder_t func);
  23. static bool checkreturn encode_field(pb_ostream_t *stream, const pb_field_t *field, const void *pData);
  24. static bool checkreturn default_extension_encoder(pb_ostream_t *stream, const pb_extension_t *extension);
  25. static bool checkreturn encode_extension_field(pb_ostream_t *stream, const pb_field_t *field, const void *pData);
  26. static void *pb_const_cast(const void *p);
  27. static bool checkreturn pb_enc_bool(pb_ostream_t *stream, const pb_field_t *field, const void *src);
  28. static bool checkreturn pb_enc_varint(pb_ostream_t *stream, const pb_field_t *field, const void *src);
  29. static bool checkreturn pb_enc_uvarint(pb_ostream_t *stream, const pb_field_t *field, const void *src);
  30. static bool checkreturn pb_enc_svarint(pb_ostream_t *stream, const pb_field_t *field, const void *src);
  31. static bool checkreturn pb_enc_fixed32(pb_ostream_t *stream, const pb_field_t *field, const void *src);
  32. static bool checkreturn pb_enc_fixed64(pb_ostream_t *stream, const pb_field_t *field, const void *src);
  33. static bool checkreturn pb_enc_bytes(pb_ostream_t *stream, const pb_field_t *field, const void *src);
  34. static bool checkreturn pb_enc_string(pb_ostream_t *stream, const pb_field_t *field, const void *src);
  35. static bool checkreturn pb_enc_submessage(pb_ostream_t *stream, const pb_field_t *field, const void *src);
  36. static bool checkreturn pb_enc_fixed_length_bytes(pb_ostream_t *stream, const pb_field_t *field, const void *src);
  37. #ifdef PB_WITHOUT_64BIT
  38. #define pb_int64_t int32_t
  39. #define pb_uint64_t uint32_t
  40. static bool checkreturn pb_encode_negative_varint(pb_ostream_t *stream, pb_uint64_t value);
  41. #else
  42. #define pb_int64_t int64_t
  43. #define pb_uint64_t uint64_t
  44. #endif
  45. /* --- Function pointers to field encoders ---
  46. * Order in the array must match pb_action_t LTYPE numbering.
  47. */
  48. static const pb_encoder_t PB_ENCODERS[PB_LTYPES_COUNT] = {
  49. &pb_enc_bool,
  50. &pb_enc_varint,
  51. &pb_enc_uvarint,
  52. &pb_enc_svarint,
  53. &pb_enc_fixed32,
  54. &pb_enc_fixed64,
  55. &pb_enc_bytes,
  56. &pb_enc_string,
  57. &pb_enc_submessage,
  58. NULL, /* extensions */
  59. &pb_enc_fixed_length_bytes
  60. };
  61. /*******************************
  62. * pb_ostream_t implementation *
  63. *******************************/
  64. static bool checkreturn buf_write(pb_ostream_t *stream, const pb_byte_t *buf, size_t count)
  65. {
  66. size_t i;
  67. pb_byte_t *dest = (pb_byte_t*)stream->state;
  68. stream->state = dest + count;
  69. for (i = 0; i < count; i++)
  70. dest[i] = buf[i];
  71. return true;
  72. }
  73. pb_ostream_t pb_ostream_from_buffer(pb_byte_t *buf, size_t bufsize)
  74. {
  75. pb_ostream_t stream;
  76. #ifdef PB_BUFFER_ONLY
  77. stream.callback = (void*)1; /* Just a marker value */
  78. #else
  79. stream.callback = &buf_write;
  80. #endif
  81. stream.state = buf;
  82. stream.max_size = bufsize;
  83. stream.bytes_written = 0;
  84. #ifndef PB_NO_ERRMSG
  85. stream.errmsg = NULL;
  86. #endif
  87. return stream;
  88. }
  89. bool checkreturn pb_write(pb_ostream_t *stream, const pb_byte_t *buf, size_t count)
  90. {
  91. if (count > 0 && stream->callback != NULL)
  92. {
  93. if (stream->bytes_written + count > stream->max_size)
  94. PB_RETURN_ERROR(stream, "stream full");
  95. #ifdef PB_BUFFER_ONLY
  96. if (!buf_write(stream, buf, count))
  97. PB_RETURN_ERROR(stream, "io error");
  98. #else
  99. if (!stream->callback(stream, buf, count))
  100. PB_RETURN_ERROR(stream, "io error");
  101. #endif
  102. }
  103. stream->bytes_written += count;
  104. return true;
  105. }
  106. /*************************
  107. * Encode a single field *
  108. *************************/
  109. /* Read a bool value without causing undefined behavior even if the value
  110. * is invalid. See issue #434 and
  111. * https://stackoverflow.com/questions/27661768/weird-results-for-conditional
  112. */
  113. static bool safe_read_bool(const void *pSize)
  114. {
  115. const char *p = (const char *)pSize;
  116. size_t i;
  117. for (i = 0; i < sizeof(bool); i++)
  118. {
  119. if (p[i] != 0)
  120. return true;
  121. }
  122. return false;
  123. }
  124. /* Encode a static array. Handles the size calculations and possible packing. */
  125. static bool checkreturn encode_array(pb_ostream_t *stream, const pb_field_t *field,
  126. const void *pData, size_t count, pb_encoder_t func)
  127. {
  128. size_t i;
  129. const void *p;
  130. #ifndef PB_ENCODE_ARRAYS_UNPACKED
  131. size_t size;
  132. #endif
  133. if (count == 0)
  134. return true;
  135. if (PB_ATYPE(field->type) != PB_ATYPE_POINTER && count > field->array_size)
  136. PB_RETURN_ERROR(stream, "array max size exceeded");
  137. #ifndef PB_ENCODE_ARRAYS_UNPACKED
  138. /* We always pack arrays if the datatype allows it. */
  139. if (PB_LTYPE(field->type) <= PB_LTYPE_LAST_PACKABLE)
  140. {
  141. if (!pb_encode_tag(stream, PB_WT_STRING, field->tag))
  142. return false;
  143. /* Determine the total size of packed array. */
  144. if (PB_LTYPE(field->type) == PB_LTYPE_FIXED32)
  145. {
  146. size = 4 * count;
  147. }
  148. else if (PB_LTYPE(field->type) == PB_LTYPE_FIXED64)
  149. {
  150. size = 8 * count;
  151. }
  152. else
  153. {
  154. pb_ostream_t sizestream = PB_OSTREAM_SIZING;
  155. p = pData;
  156. for (i = 0; i < count; i++)
  157. {
  158. if (!func(&sizestream, field, p))
  159. return false;
  160. p = (const char*)p + field->data_size;
  161. }
  162. size = sizestream.bytes_written;
  163. }
  164. if (!pb_encode_varint(stream, (pb_uint64_t)size))
  165. return false;
  166. if (stream->callback == NULL)
  167. return pb_write(stream, NULL, size); /* Just sizing.. */
  168. /* Write the data */
  169. p = pData;
  170. for (i = 0; i < count; i++)
  171. {
  172. if (!func(stream, field, p))
  173. return false;
  174. p = (const char*)p + field->data_size;
  175. }
  176. }
  177. else
  178. #endif
  179. {
  180. p = pData;
  181. for (i = 0; i < count; i++)
  182. {
  183. if (!pb_encode_tag_for_field(stream, field))
  184. return false;
  185. /* Normally the data is stored directly in the array entries, but
  186. * for pointer-type string and bytes fields, the array entries are
  187. * actually pointers themselves also. So we have to dereference once
  188. * more to get to the actual data. */
  189. if (PB_ATYPE(field->type) == PB_ATYPE_POINTER &&
  190. (PB_LTYPE(field->type) == PB_LTYPE_STRING ||
  191. PB_LTYPE(field->type) == PB_LTYPE_BYTES))
  192. {
  193. if (!func(stream, field, *(const void* const*)p))
  194. return false;
  195. }
  196. else
  197. {
  198. if (!func(stream, field, p))
  199. return false;
  200. }
  201. p = (const char*)p + field->data_size;
  202. }
  203. }
  204. return true;
  205. }
  206. /* In proto3, all fields are optional and are only encoded if their value is "non-zero".
  207. * This function implements the check for the zero value. */
  208. static bool pb_check_proto3_default_value(const pb_field_t *field, const void *pData)
  209. {
  210. pb_type_t type = field->type;
  211. const void *pSize = (const char*)pData + field->size_offset;
  212. if (PB_HTYPE(type) == PB_HTYPE_REQUIRED)
  213. {
  214. /* Required proto2 fields inside proto3 submessage, pretty rare case */
  215. return false;
  216. }
  217. else if (PB_HTYPE(type) == PB_HTYPE_REPEATED)
  218. {
  219. /* Repeated fields inside proto3 submessage: present if count != 0 */
  220. if (field->size_offset != 0)
  221. return *(const pb_size_t*)pSize == 0;
  222. else if (PB_ATYPE(type) == PB_ATYPE_STATIC)
  223. return false; /* Fixed length array */
  224. }
  225. else if (PB_HTYPE(type) == PB_HTYPE_ONEOF)
  226. {
  227. /* Oneof fields */
  228. return *(const pb_size_t*)pSize == 0;
  229. }
  230. else if (PB_HTYPE(type) == PB_HTYPE_OPTIONAL && field->size_offset != 0)
  231. {
  232. /* Proto2 optional fields inside proto3 submessage */
  233. return safe_read_bool(pSize) == false;
  234. }
  235. /* Rest is proto3 singular fields */
  236. if (PB_ATYPE(type) == PB_ATYPE_STATIC)
  237. {
  238. if (PB_LTYPE(type) == PB_LTYPE_BYTES)
  239. {
  240. const pb_bytes_array_t *bytes = (const pb_bytes_array_t*)pData;
  241. return bytes->size == 0;
  242. }
  243. else if (PB_LTYPE(type) == PB_LTYPE_STRING)
  244. {
  245. return *(const char*)pData == '\0';
  246. }
  247. else if (PB_LTYPE(type) == PB_LTYPE_FIXED_LENGTH_BYTES)
  248. {
  249. /* Fixed length bytes is only empty if its length is fixed
  250. * as 0. Which would be pretty strange, but we can check
  251. * it anyway. */
  252. return field->data_size == 0;
  253. }
  254. else if (PB_LTYPE(type) == PB_LTYPE_SUBMESSAGE)
  255. {
  256. /* Check all fields in the submessage to find if any of them
  257. * are non-zero. The comparison cannot be done byte-per-byte
  258. * because the C struct may contain padding bytes that must
  259. * be skipped.
  260. */
  261. pb_field_iter_t iter;
  262. if (pb_field_iter_begin(&iter, (const pb_field_t*)field->ptr, pb_const_cast(pData)))
  263. {
  264. do
  265. {
  266. if (!pb_check_proto3_default_value(iter.pos, iter.pData))
  267. {
  268. return false;
  269. }
  270. } while (pb_field_iter_next(&iter));
  271. }
  272. return true;
  273. }
  274. }
  275. {
  276. /* Catch-all branch that does byte-per-byte comparison for zero value.
  277. *
  278. * This is for all pointer fields, and for static PB_LTYPE_VARINT,
  279. * UVARINT, SVARINT, FIXED32, FIXED64, EXTENSION fields, and also
  280. * callback fields. These all have integer or pointer value which
  281. * can be compared with 0.
  282. */
  283. pb_size_t i;
  284. const char *p = (const char*)pData;
  285. for (i = 0; i < field->data_size; i++)
  286. {
  287. if (p[i] != 0)
  288. {
  289. return false;
  290. }
  291. }
  292. return true;
  293. }
  294. }
  295. /* Encode a field with static or pointer allocation, i.e. one whose data
  296. * is available to the encoder directly. */
  297. static bool checkreturn encode_basic_field(pb_ostream_t *stream,
  298. const pb_field_t *field, const void *pData)
  299. {
  300. pb_encoder_t func;
  301. bool implicit_has;
  302. const void *pSize = &implicit_has;
  303. func = PB_ENCODERS[PB_LTYPE(field->type)];
  304. if (field->size_offset)
  305. {
  306. /* Static optional, repeated or oneof field */
  307. pSize = (const char*)pData + field->size_offset;
  308. }
  309. else if (PB_HTYPE(field->type) == PB_HTYPE_OPTIONAL)
  310. {
  311. /* Proto3 style field, optional but without explicit has_ field. */
  312. implicit_has = !pb_check_proto3_default_value(field, pData);
  313. }
  314. else
  315. {
  316. /* Required field, always present */
  317. implicit_has = true;
  318. }
  319. if (PB_ATYPE(field->type) == PB_ATYPE_POINTER)
  320. {
  321. /* pData is a pointer to the field, which contains pointer to
  322. * the data. If the 2nd pointer is NULL, it is interpreted as if
  323. * the has_field was false.
  324. */
  325. pData = *(const void* const*)pData;
  326. implicit_has = (pData != NULL);
  327. }
  328. switch (PB_HTYPE(field->type))
  329. {
  330. case PB_HTYPE_REQUIRED:
  331. if (!pData)
  332. PB_RETURN_ERROR(stream, "missing required field");
  333. if (!pb_encode_tag_for_field(stream, field))
  334. return false;
  335. if (!func(stream, field, pData))
  336. return false;
  337. break;
  338. case PB_HTYPE_OPTIONAL:
  339. if (safe_read_bool(pSize))
  340. {
  341. if (!pb_encode_tag_for_field(stream, field))
  342. return false;
  343. if (!func(stream, field, pData))
  344. return false;
  345. }
  346. break;
  347. case PB_HTYPE_REPEATED: {
  348. pb_size_t count;
  349. if (field->size_offset != 0) {
  350. count = *(const pb_size_t*)pSize;
  351. } else {
  352. count = field->array_size;
  353. }
  354. if (!encode_array(stream, field, pData, count, func))
  355. return false;
  356. break;
  357. }
  358. case PB_HTYPE_ONEOF:
  359. if (*(const pb_size_t*)pSize == field->tag)
  360. {
  361. if (!pb_encode_tag_for_field(stream, field))
  362. return false;
  363. if (!func(stream, field, pData))
  364. return false;
  365. }
  366. break;
  367. default:
  368. PB_RETURN_ERROR(stream, "invalid field type");
  369. }
  370. return true;
  371. }
  372. /* Encode a field with callback semantics. This means that a user function is
  373. * called to provide and encode the actual data. */
  374. static bool checkreturn encode_callback_field(pb_ostream_t *stream,
  375. const pb_field_t *field, const void *pData)
  376. {
  377. const pb_callback_t *callback = (const pb_callback_t*)pData;
  378. #ifdef PB_OLD_CALLBACK_STYLE
  379. const void *arg = callback->arg;
  380. #else
  381. void * const *arg = &(callback->arg);
  382. #endif
  383. if (callback->funcs.encode != NULL)
  384. {
  385. if (!callback->funcs.encode(stream, field, arg))
  386. PB_RETURN_ERROR(stream, "callback error");
  387. }
  388. return true;
  389. }
  390. /* Encode a single field of any callback or static type. */
  391. static bool checkreturn encode_field(pb_ostream_t *stream,
  392. const pb_field_t *field, const void *pData)
  393. {
  394. switch (PB_ATYPE(field->type))
  395. {
  396. case PB_ATYPE_STATIC:
  397. case PB_ATYPE_POINTER:
  398. return encode_basic_field(stream, field, pData);
  399. case PB_ATYPE_CALLBACK:
  400. return encode_callback_field(stream, field, pData);
  401. default:
  402. PB_RETURN_ERROR(stream, "invalid field type");
  403. }
  404. }
  405. /* Default handler for extension fields. Expects to have a pb_field_t
  406. * pointer in the extension->type->arg field. */
  407. static bool checkreturn default_extension_encoder(pb_ostream_t *stream,
  408. const pb_extension_t *extension)
  409. {
  410. const pb_field_t *field = (const pb_field_t*)extension->type->arg;
  411. if (PB_ATYPE(field->type) == PB_ATYPE_POINTER)
  412. {
  413. /* For pointer extensions, the pointer is stored directly
  414. * in the extension structure. This avoids having an extra
  415. * indirection. */
  416. return encode_field(stream, field, &extension->dest);
  417. }
  418. else
  419. {
  420. return encode_field(stream, field, extension->dest);
  421. }
  422. }
  423. /* Walk through all the registered extensions and give them a chance
  424. * to encode themselves. */
  425. static bool checkreturn encode_extension_field(pb_ostream_t *stream,
  426. const pb_field_t *field, const void *pData)
  427. {
  428. const pb_extension_t *extension = *(const pb_extension_t* const *)pData;
  429. PB_UNUSED(field);
  430. while (extension)
  431. {
  432. bool status;
  433. if (extension->type->encode)
  434. status = extension->type->encode(stream, extension);
  435. else
  436. status = default_extension_encoder(stream, extension);
  437. if (!status)
  438. return false;
  439. extension = extension->next;
  440. }
  441. return true;
  442. }
  443. /*********************
  444. * Encode all fields *
  445. *********************/
  446. static void *pb_const_cast(const void *p)
  447. {
  448. /* Note: this casts away const, in order to use the common field iterator
  449. * logic for both encoding and decoding. */
  450. union {
  451. void *p1;
  452. const void *p2;
  453. } t;
  454. t.p2 = p;
  455. return t.p1;
  456. }
  457. bool checkreturn pb_encode(pb_ostream_t *stream, const pb_field_t fields[], const void *src_struct)
  458. {
  459. pb_field_iter_t iter;
  460. if (!pb_field_iter_begin(&iter, fields, pb_const_cast(src_struct)))
  461. return true; /* Empty message type */
  462. do {
  463. if (PB_LTYPE(iter.pos->type) == PB_LTYPE_EXTENSION)
  464. {
  465. /* Special case for the extension field placeholder */
  466. if (!encode_extension_field(stream, iter.pos, iter.pData))
  467. return false;
  468. }
  469. else
  470. {
  471. /* Regular field */
  472. if (!encode_field(stream, iter.pos, iter.pData))
  473. return false;
  474. }
  475. } while (pb_field_iter_next(&iter));
  476. return true;
  477. }
  478. bool pb_encode_delimited(pb_ostream_t *stream, const pb_field_t fields[], const void *src_struct)
  479. {
  480. return pb_encode_submessage(stream, fields, src_struct);
  481. }
  482. bool pb_encode_nullterminated(pb_ostream_t *stream, const pb_field_t fields[], const void *src_struct)
  483. {
  484. const pb_byte_t zero = 0;
  485. if (!pb_encode(stream, fields, src_struct))
  486. return false;
  487. return pb_write(stream, &zero, 1);
  488. }
  489. bool pb_get_encoded_size(size_t *size, const pb_field_t fields[], const void *src_struct)
  490. {
  491. pb_ostream_t stream = PB_OSTREAM_SIZING;
  492. if (!pb_encode(&stream, fields, src_struct))
  493. return false;
  494. *size = stream.bytes_written;
  495. return true;
  496. }
  497. /********************
  498. * Helper functions *
  499. ********************/
  500. #ifdef PB_WITHOUT_64BIT
  501. bool checkreturn pb_encode_negative_varint(pb_ostream_t *stream, pb_uint64_t value)
  502. {
  503. pb_byte_t buffer[10];
  504. size_t i = 0;
  505. size_t compensation = 32;/* we need to compensate 32 bits all set to 1 */
  506. while (value)
  507. {
  508. buffer[i] = (pb_byte_t)((value & 0x7F) | 0x80);
  509. value >>= 7;
  510. if (compensation)
  511. {
  512. /* re-set all the compensation bits we can or need */
  513. size_t bits = compensation > 7 ? 7 : compensation;
  514. value ^= (pb_uint64_t)((0xFFu >> (8 - bits)) << 25); /* set the number of bits needed on the lowest of the most significant 7 bits */
  515. compensation -= bits;
  516. }
  517. i++;
  518. }
  519. buffer[i - 1] &= 0x7F; /* Unset top bit on last byte */
  520. return pb_write(stream, buffer, i);
  521. }
  522. #endif
  523. bool checkreturn pb_encode_varint(pb_ostream_t *stream, pb_uint64_t value)
  524. {
  525. pb_byte_t buffer[10];
  526. size_t i = 0;
  527. if (value <= 0x7F)
  528. {
  529. pb_byte_t v = (pb_byte_t)value;
  530. return pb_write(stream, &v, 1);
  531. }
  532. while (value)
  533. {
  534. buffer[i] = (pb_byte_t)((value & 0x7F) | 0x80);
  535. value >>= 7;
  536. i++;
  537. }
  538. buffer[i-1] &= 0x7F; /* Unset top bit on last byte */
  539. return pb_write(stream, buffer, i);
  540. }
  541. bool checkreturn pb_encode_svarint(pb_ostream_t *stream, pb_int64_t value)
  542. {
  543. pb_uint64_t zigzagged;
  544. if (value < 0)
  545. zigzagged = ~((pb_uint64_t)value << 1);
  546. else
  547. zigzagged = (pb_uint64_t)value << 1;
  548. return pb_encode_varint(stream, zigzagged);
  549. }
  550. bool checkreturn pb_encode_fixed32(pb_ostream_t *stream, const void *value)
  551. {
  552. uint32_t val = *(const uint32_t*)value;
  553. pb_byte_t bytes[4];
  554. bytes[0] = (pb_byte_t)(val & 0xFF);
  555. bytes[1] = (pb_byte_t)((val >> 8) & 0xFF);
  556. bytes[2] = (pb_byte_t)((val >> 16) & 0xFF);
  557. bytes[3] = (pb_byte_t)((val >> 24) & 0xFF);
  558. return pb_write(stream, bytes, 4);
  559. }
  560. #ifndef PB_WITHOUT_64BIT
  561. bool checkreturn pb_encode_fixed64(pb_ostream_t *stream, const void *value)
  562. {
  563. uint64_t val = *(const uint64_t*)value;
  564. pb_byte_t bytes[8];
  565. bytes[0] = (pb_byte_t)(val & 0xFF);
  566. bytes[1] = (pb_byte_t)((val >> 8) & 0xFF);
  567. bytes[2] = (pb_byte_t)((val >> 16) & 0xFF);
  568. bytes[3] = (pb_byte_t)((val >> 24) & 0xFF);
  569. bytes[4] = (pb_byte_t)((val >> 32) & 0xFF);
  570. bytes[5] = (pb_byte_t)((val >> 40) & 0xFF);
  571. bytes[6] = (pb_byte_t)((val >> 48) & 0xFF);
  572. bytes[7] = (pb_byte_t)((val >> 56) & 0xFF);
  573. return pb_write(stream, bytes, 8);
  574. }
  575. #endif
  576. bool checkreturn pb_encode_tag(pb_ostream_t *stream, pb_wire_type_t wiretype, uint32_t field_number)
  577. {
  578. pb_uint64_t tag = ((pb_uint64_t)field_number << 3) | wiretype;
  579. return pb_encode_varint(stream, tag);
  580. }
  581. bool checkreturn pb_encode_tag_for_field(pb_ostream_t *stream, const pb_field_t *field)
  582. {
  583. pb_wire_type_t wiretype;
  584. switch (PB_LTYPE(field->type))
  585. {
  586. case PB_LTYPE_BOOL:
  587. case PB_LTYPE_VARINT:
  588. case PB_LTYPE_UVARINT:
  589. case PB_LTYPE_SVARINT:
  590. wiretype = PB_WT_VARINT;
  591. break;
  592. case PB_LTYPE_FIXED32:
  593. wiretype = PB_WT_32BIT;
  594. break;
  595. case PB_LTYPE_FIXED64:
  596. wiretype = PB_WT_64BIT;
  597. break;
  598. case PB_LTYPE_BYTES:
  599. case PB_LTYPE_STRING:
  600. case PB_LTYPE_SUBMESSAGE:
  601. case PB_LTYPE_FIXED_LENGTH_BYTES:
  602. wiretype = PB_WT_STRING;
  603. break;
  604. default:
  605. PB_RETURN_ERROR(stream, "invalid field type");
  606. }
  607. return pb_encode_tag(stream, wiretype, field->tag);
  608. }
  609. bool checkreturn pb_encode_string(pb_ostream_t *stream, const pb_byte_t *buffer, size_t size)
  610. {
  611. if (!pb_encode_varint(stream, (pb_uint64_t)size))
  612. return false;
  613. return pb_write(stream, buffer, size);
  614. }
  615. bool checkreturn pb_encode_submessage(pb_ostream_t *stream, const pb_field_t fields[], const void *src_struct)
  616. {
  617. /* First calculate the message size using a non-writing substream. */
  618. pb_ostream_t substream = PB_OSTREAM_SIZING;
  619. size_t size;
  620. bool status;
  621. if (!pb_encode(&substream, fields, src_struct))
  622. {
  623. #ifndef PB_NO_ERRMSG
  624. stream->errmsg = substream.errmsg;
  625. #endif
  626. return false;
  627. }
  628. size = substream.bytes_written;
  629. if (!pb_encode_varint(stream, (pb_uint64_t)size))
  630. return false;
  631. if (stream->callback == NULL)
  632. return pb_write(stream, NULL, size); /* Just sizing */
  633. if (stream->bytes_written + size > stream->max_size)
  634. PB_RETURN_ERROR(stream, "stream full");
  635. /* Use a substream to verify that a callback doesn't write more than
  636. * what it did the first time. */
  637. substream.callback = stream->callback;
  638. substream.state = stream->state;
  639. substream.max_size = size;
  640. substream.bytes_written = 0;
  641. #ifndef PB_NO_ERRMSG
  642. substream.errmsg = NULL;
  643. #endif
  644. status = pb_encode(&substream, fields, src_struct);
  645. stream->bytes_written += substream.bytes_written;
  646. stream->state = substream.state;
  647. #ifndef PB_NO_ERRMSG
  648. stream->errmsg = substream.errmsg;
  649. #endif
  650. if (substream.bytes_written != size)
  651. PB_RETURN_ERROR(stream, "submsg size changed");
  652. return status;
  653. }
  654. /* Field encoders */
  655. static bool checkreturn pb_enc_bool(pb_ostream_t *stream, const pb_field_t *field, const void *src)
  656. {
  657. uint32_t value = safe_read_bool(src) ? 1 : 0;
  658. PB_UNUSED(field);
  659. return pb_encode_varint(stream, value);
  660. }
  661. static bool checkreturn pb_enc_varint(pb_ostream_t *stream, const pb_field_t *field, const void *src)
  662. {
  663. pb_int64_t value = 0;
  664. if (field->data_size == sizeof(int_least8_t))
  665. value = *(const int_least8_t*)src;
  666. else if (field->data_size == sizeof(int_least16_t))
  667. value = *(const int_least16_t*)src;
  668. else if (field->data_size == sizeof(int32_t))
  669. value = *(const int32_t*)src;
  670. else if (field->data_size == sizeof(pb_int64_t))
  671. value = *(const pb_int64_t*)src;
  672. else
  673. PB_RETURN_ERROR(stream, "invalid data_size");
  674. #ifdef PB_WITHOUT_64BIT
  675. if (value < 0)
  676. return pb_encode_negative_varint(stream, (pb_uint64_t)value);
  677. else
  678. #endif
  679. return pb_encode_varint(stream, (pb_uint64_t)value);
  680. }
  681. static bool checkreturn pb_enc_uvarint(pb_ostream_t *stream, const pb_field_t *field, const void *src)
  682. {
  683. pb_uint64_t value = 0;
  684. if (field->data_size == sizeof(uint_least8_t))
  685. value = *(const uint_least8_t*)src;
  686. else if (field->data_size == sizeof(uint_least16_t))
  687. value = *(const uint_least16_t*)src;
  688. else if (field->data_size == sizeof(uint32_t))
  689. value = *(const uint32_t*)src;
  690. else if (field->data_size == sizeof(pb_uint64_t))
  691. value = *(const pb_uint64_t*)src;
  692. else
  693. PB_RETURN_ERROR(stream, "invalid data_size");
  694. return pb_encode_varint(stream, value);
  695. }
  696. static bool checkreturn pb_enc_svarint(pb_ostream_t *stream, const pb_field_t *field, const void *src)
  697. {
  698. pb_int64_t value = 0;
  699. if (field->data_size == sizeof(int_least8_t))
  700. value = *(const int_least8_t*)src;
  701. else if (field->data_size == sizeof(int_least16_t))
  702. value = *(const int_least16_t*)src;
  703. else if (field->data_size == sizeof(int32_t))
  704. value = *(const int32_t*)src;
  705. else if (field->data_size == sizeof(pb_int64_t))
  706. value = *(const pb_int64_t*)src;
  707. else
  708. PB_RETURN_ERROR(stream, "invalid data_size");
  709. return pb_encode_svarint(stream, value);
  710. }
  711. static bool checkreturn pb_enc_fixed64(pb_ostream_t *stream, const pb_field_t *field, const void *src)
  712. {
  713. PB_UNUSED(field);
  714. #ifndef PB_WITHOUT_64BIT
  715. return pb_encode_fixed64(stream, src);
  716. #else
  717. PB_UNUSED(src);
  718. PB_RETURN_ERROR(stream, "no 64bit support");
  719. #endif
  720. }
  721. static bool checkreturn pb_enc_fixed32(pb_ostream_t *stream, const pb_field_t *field, const void *src)
  722. {
  723. PB_UNUSED(field);
  724. return pb_encode_fixed32(stream, src);
  725. }
  726. static bool checkreturn pb_enc_bytes(pb_ostream_t *stream, const pb_field_t *field, const void *src)
  727. {
  728. const pb_bytes_array_t *bytes = NULL;
  729. bytes = (const pb_bytes_array_t*)src;
  730. if (src == NULL)
  731. {
  732. /* Treat null pointer as an empty bytes field */
  733. return pb_encode_string(stream, NULL, 0);
  734. }
  735. if (PB_ATYPE(field->type) == PB_ATYPE_STATIC &&
  736. PB_BYTES_ARRAY_T_ALLOCSIZE(bytes->size) > field->data_size)
  737. {
  738. PB_RETURN_ERROR(stream, "bytes size exceeded");
  739. }
  740. return pb_encode_string(stream, bytes->bytes, bytes->size);
  741. }
  742. static bool checkreturn pb_enc_string(pb_ostream_t *stream, const pb_field_t *field, const void *src)
  743. {
  744. size_t size = 0;
  745. size_t max_size = field->data_size;
  746. const char *p = (const char*)src;
  747. if (PB_ATYPE(field->type) == PB_ATYPE_POINTER)
  748. max_size = (size_t)-1;
  749. if (src == NULL)
  750. {
  751. size = 0; /* Treat null pointer as an empty string */
  752. }
  753. else
  754. {
  755. /* strnlen() is not always available, so just use a loop */
  756. while (size < max_size && *p != '\0')
  757. {
  758. size++;
  759. p++;
  760. }
  761. }
  762. return pb_encode_string(stream, (const pb_byte_t*)src, size);
  763. }
  764. static bool checkreturn pb_enc_submessage(pb_ostream_t *stream, const pb_field_t *field, const void *src)
  765. {
  766. if (field->ptr == NULL)
  767. PB_RETURN_ERROR(stream, "invalid field descriptor");
  768. return pb_encode_submessage(stream, (const pb_field_t*)field->ptr, src);
  769. }
  770. static bool checkreturn pb_enc_fixed_length_bytes(pb_ostream_t *stream, const pb_field_t *field, const void *src)
  771. {
  772. return pb_encode_string(stream, (const pb_byte_t*)src, field->data_size);
  773. }