1 /* pb_encode.c -- encode a protobuf using minimal resources
3 * 2011 Petteri Aimonen <jpa@kapsi.fi>
10 /* Use the GCC warn_unused_result attribute to check that all return values
11 * are propagated correctly. On other compilers and gcc before 3.4.0 just
12 * ignore the annotation.
14 #if !defined(__GNUC__) || ( __GNUC__ < 3) || (__GNUC__ == 3 && __GNUC_MINOR__ < 4)
17 #define checkreturn __attribute__((warn_unused_result))
20 /**************************************
21 * Declarations internal to this file *
22 **************************************/
23 typedef bool (*pb_encoder_t)(pb_ostream_t *stream, const pb_field_t *field, const void *src) checkreturn;
25 static bool checkreturn buf_write(pb_ostream_t *stream, const uint8_t *buf, size_t count);
26 static bool checkreturn encode_array(pb_ostream_t *stream, const pb_field_t *field, const void *pData, size_t count, pb_encoder_t func);
27 static bool checkreturn encode_field(pb_ostream_t *stream, const pb_field_t *field, const void *pData);
28 static bool checkreturn default_extension_encoder(pb_ostream_t *stream, const pb_extension_t *extension);
29 static bool checkreturn encode_extension_field(pb_ostream_t *stream, const pb_field_t *field, const void *pData);
30 static bool checkreturn pb_enc_varint(pb_ostream_t *stream, const pb_field_t *field, const void *src);
31 static bool checkreturn pb_enc_uvarint(pb_ostream_t *stream, const pb_field_t *field, const void *src);
32 static bool checkreturn pb_enc_svarint(pb_ostream_t *stream, const pb_field_t *field, const void *src);
33 static bool checkreturn pb_enc_fixed32(pb_ostream_t *stream, const pb_field_t *field, const void *src);
34 static bool checkreturn pb_enc_fixed64(pb_ostream_t *stream, const pb_field_t *field, const void *src);
35 static bool checkreturn pb_enc_bytes(pb_ostream_t *stream, const pb_field_t *field, const void *src);
36 static bool checkreturn pb_enc_string(pb_ostream_t *stream, const pb_field_t *field, const void *src);
37 static bool checkreturn pb_enc_submessage(pb_ostream_t *stream, const pb_field_t *field, const void *src);
39 /* --- Function pointers to field encoders ---
40 * Order in the array must match pb_action_t LTYPE numbering.
42 static const pb_encoder_t PB_ENCODERS[PB_LTYPES_COUNT] = {
55 /*******************************
56 * pb_ostream_t implementation *
57 *******************************/
59 static bool checkreturn buf_write(pb_ostream_t *stream, const uint8_t *buf, size_t count)
61 uint8_t *dest = (uint8_t*)stream->state;
62 stream->state = dest + count;
70 pb_ostream_t pb_ostream_from_buffer(uint8_t *buf, size_t bufsize)
74 stream.callback = (void*)1; /* Just a marker value */
76 stream.callback = &buf_write;
79 stream.max_size = bufsize;
80 stream.bytes_written = 0;
87 bool checkreturn pb_write(pb_ostream_t *stream, const uint8_t *buf, size_t count)
89 if (stream->callback != NULL)
91 if (stream->bytes_written + count > stream->max_size)
92 PB_RETURN_ERROR(stream, "stream full");
95 if (!buf_write(stream, buf, count))
96 PB_RETURN_ERROR(stream, "io error");
98 if (!stream->callback(stream, buf, count))
99 PB_RETURN_ERROR(stream, "io error");
103 stream->bytes_written += count;
107 /*************************
108 * Encode a single field *
109 *************************/
111 /* Encode a static array. Handles the size calculations and possible packing. */
112 static bool checkreturn encode_array(pb_ostream_t *stream, const pb_field_t *field,
113 const void *pData, size_t count, pb_encoder_t func)
122 if (PB_ATYPE(field->type) != PB_ATYPE_POINTER && count > field->array_size)
123 PB_RETURN_ERROR(stream, "array max size exceeded");
125 /* We always pack arrays if the datatype allows it. */
126 if (PB_LTYPE(field->type) <= PB_LTYPE_LAST_PACKABLE)
128 if (!pb_encode_tag(stream, PB_WT_STRING, field->tag))
131 /* Determine the total size of packed array. */
132 if (PB_LTYPE(field->type) == PB_LTYPE_FIXED32)
136 else if (PB_LTYPE(field->type) == PB_LTYPE_FIXED64)
142 pb_ostream_t sizestream = PB_OSTREAM_SIZING;
144 for (i = 0; i < count; i++)
146 if (!func(&sizestream, field, p))
148 p = (const char*)p + field->data_size;
150 size = sizestream.bytes_written;
153 if (!pb_encode_varint(stream, (uint64_t)size))
156 if (stream->callback == NULL)
157 return pb_write(stream, NULL, size); /* Just sizing.. */
161 for (i = 0; i < count; i++)
163 if (!func(stream, field, p))
165 p = (const char*)p + field->data_size;
171 for (i = 0; i < count; i++)
173 if (!pb_encode_tag_for_field(stream, field))
176 /* Normally the data is stored directly in the array entries, but
177 * for pointer-type string and bytes fields, the array entries are
178 * actually pointers themselves also. So we have to dereference once
179 * more to get to the actual data. */
180 if (PB_ATYPE(field->type) == PB_ATYPE_POINTER &&
181 (PB_LTYPE(field->type) == PB_LTYPE_STRING ||
182 PB_LTYPE(field->type) == PB_LTYPE_BYTES))
184 if (!func(stream, field, *(const void* const*)p))
189 if (!func(stream, field, p))
192 p = (const char*)p + field->data_size;
199 /* Encode a field with static or pointer allocation, i.e. one whose data
200 * is available to the encoder directly. */
201 static bool checkreturn encode_basic_field(pb_ostream_t *stream,
202 const pb_field_t *field, const void *pData)
206 bool implicit_has = true;
208 func = PB_ENCODERS[PB_LTYPE(field->type)];
210 if (field->size_offset)
211 pSize = (const char*)pData + field->size_offset;
213 pSize = &implicit_has;
215 if (PB_ATYPE(field->type) == PB_ATYPE_POINTER)
217 /* pData is a pointer to the field, which contains pointer to
218 * the data. If the 2nd pointer is NULL, it is interpreted as if
219 * the has_field was false.
222 pData = *(const void* const*)pData;
223 implicit_has = (pData != NULL);
226 switch (PB_HTYPE(field->type))
228 case PB_HTYPE_REQUIRED:
230 PB_RETURN_ERROR(stream, "missing required field");
231 if (!pb_encode_tag_for_field(stream, field))
233 if (!func(stream, field, pData))
237 case PB_HTYPE_OPTIONAL:
238 if (*(const bool*)pSize)
240 if (!pb_encode_tag_for_field(stream, field))
243 if (!func(stream, field, pData))
248 case PB_HTYPE_REPEATED:
249 if (!encode_array(stream, field, pData, *(const pb_size_t*)pSize, func))
254 if (*(const pb_size_t*)pSize == field->tag)
256 if (!pb_encode_tag_for_field(stream, field))
259 if (!func(stream, field, pData))
265 PB_RETURN_ERROR(stream, "invalid field type");
271 /* Encode a field with callback semantics. This means that a user function is
272 * called to provide and encode the actual data. */
273 static bool checkreturn encode_callback_field(pb_ostream_t *stream,
274 const pb_field_t *field, const void *pData)
276 const pb_callback_t *callback = (const pb_callback_t*)pData;
278 #ifdef PB_OLD_CALLBACK_STYLE
279 const void *arg = callback->arg;
281 void * const *arg = &(callback->arg);
284 if (callback->funcs.encode != NULL)
286 if (!callback->funcs.encode(stream, field, arg))
287 PB_RETURN_ERROR(stream, "callback error");
292 /* Encode a single field of any callback or static type. */
293 static bool checkreturn encode_field(pb_ostream_t *stream,
294 const pb_field_t *field, const void *pData)
296 switch (PB_ATYPE(field->type))
298 case PB_ATYPE_STATIC:
299 case PB_ATYPE_POINTER:
300 return encode_basic_field(stream, field, pData);
302 case PB_ATYPE_CALLBACK:
303 return encode_callback_field(stream, field, pData);
306 PB_RETURN_ERROR(stream, "invalid field type");
310 /* Default handler for extension fields. Expects to have a pb_field_t
311 * pointer in the extension->type->arg field. */
312 static bool checkreturn default_extension_encoder(pb_ostream_t *stream,
313 const pb_extension_t *extension)
315 const pb_field_t *field = (const pb_field_t*)extension->type->arg;
317 if (PB_ATYPE(field->type) == PB_ATYPE_POINTER)
319 /* For pointer extensions, the pointer is stored directly
320 * in the extension structure. This avoids having an extra
322 return encode_field(stream, field, &extension->dest);
326 return encode_field(stream, field, extension->dest);
330 /* Walk through all the registered extensions and give them a chance
331 * to encode themselves. */
332 static bool checkreturn encode_extension_field(pb_ostream_t *stream,
333 const pb_field_t *field, const void *pData)
335 const pb_extension_t *extension = *(const pb_extension_t* const *)pData;
341 if (extension->type->encode)
342 status = extension->type->encode(stream, extension);
344 status = default_extension_encoder(stream, extension);
349 extension = extension->next;
355 /*********************
356 * Encode all fields *
357 *********************/
359 static void *remove_const(const void *p)
361 /* Note: this casts away const, in order to use the common field iterator
362 * logic for both encoding and decoding. */
371 bool checkreturn pb_encode(pb_ostream_t *stream, const pb_field_t fields[], const void *src_struct)
373 pb_field_iter_t iter;
374 if (!pb_field_iter_begin(&iter, fields, remove_const(src_struct)))
375 return true; /* Empty message type */
378 if (PB_LTYPE(iter.pos->type) == PB_LTYPE_EXTENSION)
380 /* Special case for the extension field placeholder */
381 if (!encode_extension_field(stream, iter.pos, iter.pData))
387 if (!encode_field(stream, iter.pos, iter.pData))
390 } while (pb_field_iter_next(&iter));
395 bool pb_encode_delimited(pb_ostream_t *stream, const pb_field_t fields[], const void *src_struct)
397 return pb_encode_submessage(stream, fields, src_struct);
400 bool pb_get_encoded_size(size_t *size, const pb_field_t fields[], const void *src_struct)
402 pb_ostream_t stream = PB_OSTREAM_SIZING;
404 if (!pb_encode(&stream, fields, src_struct))
407 *size = stream.bytes_written;
411 /********************
413 ********************/
414 bool checkreturn pb_encode_varint(pb_ostream_t *stream, uint64_t value)
420 return pb_write(stream, (uint8_t*)&value, 1);
424 buffer[i] = (uint8_t)((value & 0x7F) | 0x80);
428 buffer[i-1] &= 0x7F; /* Unset top bit on last byte */
430 return pb_write(stream, buffer, i);
433 bool checkreturn pb_encode_svarint(pb_ostream_t *stream, int64_t value)
437 zigzagged = ~((uint64_t)value << 1);
439 zigzagged = (uint64_t)value << 1;
441 return pb_encode_varint(stream, zigzagged);
444 bool checkreturn pb_encode_fixed32(pb_ostream_t *stream, const void *value)
446 uint32_t val = *(const uint32_t*)value;
448 bytes[0] = (uint8_t)(val & 0xFF);
449 bytes[1] = (uint8_t)((val >> 8) & 0xFF);
450 bytes[2] = (uint8_t)((val >> 16) & 0xFF);
451 bytes[3] = (uint8_t)((val >> 24) & 0xFF);
452 return pb_write(stream, bytes, 4);
455 bool checkreturn pb_encode_fixed64(pb_ostream_t *stream, const void *value)
457 uint64_t val = *(const uint64_t*)value;
459 bytes[0] = (uint8_t)(val & 0xFF);
460 bytes[1] = (uint8_t)((val >> 8) & 0xFF);
461 bytes[2] = (uint8_t)((val >> 16) & 0xFF);
462 bytes[3] = (uint8_t)((val >> 24) & 0xFF);
463 bytes[4] = (uint8_t)((val >> 32) & 0xFF);
464 bytes[5] = (uint8_t)((val >> 40) & 0xFF);
465 bytes[6] = (uint8_t)((val >> 48) & 0xFF);
466 bytes[7] = (uint8_t)((val >> 56) & 0xFF);
467 return pb_write(stream, bytes, 8);
470 bool checkreturn pb_encode_tag(pb_ostream_t *stream, pb_wire_type_t wiretype, uint32_t field_number)
472 uint64_t tag = ((uint64_t)field_number << 3) | wiretype;
473 return pb_encode_varint(stream, tag);
476 bool checkreturn pb_encode_tag_for_field(pb_ostream_t *stream, const pb_field_t *field)
478 pb_wire_type_t wiretype;
479 switch (PB_LTYPE(field->type))
481 case PB_LTYPE_VARINT:
482 case PB_LTYPE_UVARINT:
483 case PB_LTYPE_SVARINT:
484 wiretype = PB_WT_VARINT;
487 case PB_LTYPE_FIXED32:
488 wiretype = PB_WT_32BIT;
491 case PB_LTYPE_FIXED64:
492 wiretype = PB_WT_64BIT;
496 case PB_LTYPE_STRING:
497 case PB_LTYPE_SUBMESSAGE:
498 wiretype = PB_WT_STRING;
502 PB_RETURN_ERROR(stream, "invalid field type");
505 return pb_encode_tag(stream, wiretype, field->tag);
508 bool checkreturn pb_encode_string(pb_ostream_t *stream, const uint8_t *buffer, size_t size)
510 if (!pb_encode_varint(stream, (uint64_t)size))
513 return pb_write(stream, buffer, size);
516 bool checkreturn pb_encode_submessage(pb_ostream_t *stream, const pb_field_t fields[], const void *src_struct)
518 /* First calculate the message size using a non-writing substream. */
519 pb_ostream_t substream = PB_OSTREAM_SIZING;
523 if (!pb_encode(&substream, fields, src_struct))
526 stream->errmsg = substream.errmsg;
531 size = substream.bytes_written;
533 if (!pb_encode_varint(stream, (uint64_t)size))
536 if (stream->callback == NULL)
537 return pb_write(stream, NULL, size); /* Just sizing */
539 if (stream->bytes_written + size > stream->max_size)
540 PB_RETURN_ERROR(stream, "stream full");
542 /* Use a substream to verify that a callback doesn't write more than
543 * what it did the first time. */
544 substream.callback = stream->callback;
545 substream.state = stream->state;
546 substream.max_size = size;
547 substream.bytes_written = 0;
549 substream.errmsg = NULL;
552 status = pb_encode(&substream, fields, src_struct);
554 stream->bytes_written += substream.bytes_written;
555 stream->state = substream.state;
557 stream->errmsg = substream.errmsg;
560 if (substream.bytes_written != size)
561 PB_RETURN_ERROR(stream, "submsg size changed");
568 static bool checkreturn pb_enc_varint(pb_ostream_t *stream, const pb_field_t *field, const void *src)
572 /* Cases 1 and 2 are for compilers that have smaller types for bool
573 * or enums, and for int_size option. */
574 switch (field->data_size)
576 case 1: value = *(const int8_t*)src; break;
577 case 2: value = *(const int16_t*)src; break;
578 case 4: value = *(const int32_t*)src; break;
579 case 8: value = *(const int64_t*)src; break;
580 default: PB_RETURN_ERROR(stream, "invalid data_size");
583 return pb_encode_varint(stream, (uint64_t)value);
586 static bool checkreturn pb_enc_uvarint(pb_ostream_t *stream, const pb_field_t *field, const void *src)
590 switch (field->data_size)
592 case 1: value = *(const uint8_t*)src; break;
593 case 2: value = *(const uint16_t*)src; break;
594 case 4: value = *(const uint32_t*)src; break;
595 case 8: value = *(const uint64_t*)src; break;
596 default: PB_RETURN_ERROR(stream, "invalid data_size");
599 return pb_encode_varint(stream, value);
602 static bool checkreturn pb_enc_svarint(pb_ostream_t *stream, const pb_field_t *field, const void *src)
606 switch (field->data_size)
608 case 1: value = *(const int8_t*)src; break;
609 case 2: value = *(const int16_t*)src; break;
610 case 4: value = *(const int32_t*)src; break;
611 case 8: value = *(const int64_t*)src; break;
612 default: PB_RETURN_ERROR(stream, "invalid data_size");
615 return pb_encode_svarint(stream, value);
618 static bool checkreturn pb_enc_fixed64(pb_ostream_t *stream, const pb_field_t *field, const void *src)
621 return pb_encode_fixed64(stream, src);
624 static bool checkreturn pb_enc_fixed32(pb_ostream_t *stream, const pb_field_t *field, const void *src)
627 return pb_encode_fixed32(stream, src);
630 static bool checkreturn pb_enc_bytes(pb_ostream_t *stream, const pb_field_t *field, const void *src)
632 const pb_bytes_array_t *bytes = (const pb_bytes_array_t*)src;
636 /* Threat null pointer as an empty bytes field */
637 return pb_encode_string(stream, NULL, 0);
640 if (PB_ATYPE(field->type) == PB_ATYPE_STATIC &&
641 PB_BYTES_ARRAY_T_ALLOCSIZE(bytes->size) > field->data_size)
643 PB_RETURN_ERROR(stream, "bytes size exceeded");
646 return pb_encode_string(stream, bytes->bytes, bytes->size);
649 static bool checkreturn pb_enc_string(pb_ostream_t *stream, const pb_field_t *field, const void *src)
652 size_t max_size = field->data_size;
653 const char *p = (const char*)src;
655 if (PB_ATYPE(field->type) == PB_ATYPE_POINTER)
656 max_size = (size_t)-1;
660 size = 0; /* Threat null pointer as an empty string */
664 /* strnlen() is not always available, so just use a loop */
665 while (size < max_size && *p != '\0')
672 return pb_encode_string(stream, (const uint8_t*)src, size);
675 static bool checkreturn pb_enc_submessage(pb_ostream_t *stream, const pb_field_t *field, const void *src)
677 if (field->ptr == NULL)
678 PB_RETURN_ERROR(stream, "invalid field descriptor");
680 return pb_encode_submessage(stream, (const pb_field_t*)field->ptr, src);