1 /* pb_decode.c -- decode a protobuf using minimal resources
3 * 2011 Petteri Aimonen <jpa@kapsi.fi>
6 /* The warn_unused_result attribute appeared first in gcc-3.4.0 */
7 #if !defined(__GNUC__) || ( __GNUC__ < 3) || (__GNUC__ == 3 && __GNUC_MINOR__ < 4)
10 /* Verify that we remember to check all return values for proper error propagation */
11 #define checkreturn __attribute__((warn_unused_result))
14 #define NANOPB_INTERNALS
16 #include "pb_decode.h"
19 typedef bool (*pb_decoder_t)(pb_istream_t *stream, const pb_field_t *field, void *dest) checkreturn;
21 /* --- Function pointers to field decoders ---
22 * Order in the array must match pb_action_t LTYPE numbering.
24 static const pb_decoder_t PB_DECODERS[PB_LTYPES_COUNT] = {
39 static bool checkreturn buf_read(pb_istream_t *stream, uint8_t *buf, size_t count)
41 uint8_t *source = (uint8_t*)stream->state;
44 memcpy(buf, source, count);
46 stream->state = source + count;
50 bool checkreturn pb_read(pb_istream_t *stream, uint8_t *buf, size_t count)
52 if (buf == NULL && stream->callback != buf_read)
54 /* Skip input bytes */
58 if (!pb_read(stream, tmp, 16))
64 return pb_read(stream, tmp, count);
67 if (stream->bytes_left < count)
68 PB_RETURN_ERROR(stream, "end-of-stream");
70 if (!stream->callback(stream, buf, count))
71 PB_RETURN_ERROR(stream, "io error");
73 stream->bytes_left -= count;
77 pb_istream_t pb_istream_from_buffer(uint8_t *buf, size_t bufsize)
80 stream.callback = &buf_read;
82 stream.bytes_left = bufsize;
93 static bool checkreturn pb_decode_varint32(pb_istream_t *stream, uint32_t *dest)
96 bool status = pb_decode_varint(stream, &temp);
97 *dest = (uint32_t)temp;
101 bool checkreturn pb_decode_varint(pb_istream_t *stream, uint64_t *dest)
107 while (bitpos < 64 && pb_read(stream, &byte, 1))
109 *dest |= (uint64_t)(byte & 0x7F) << bitpos;
116 PB_RETURN_ERROR(stream, "varint overflow");
119 bool checkreturn pb_skip_varint(pb_istream_t *stream)
124 if (!pb_read(stream, &byte, 1))
126 } while (byte & 0x80);
130 bool checkreturn pb_skip_string(pb_istream_t *stream)
133 if (!pb_decode_varint32(stream, &length))
136 return pb_read(stream, NULL, length);
139 bool checkreturn pb_decode_tag(pb_istream_t *stream, pb_wire_type_t *wire_type, uint32_t *tag, bool *eof)
143 *wire_type = (pb_wire_type_t) 0;
146 if (!pb_decode_varint32(stream, &temp))
148 if (stream->bytes_left == 0)
156 *eof = true; /* Special feature: allow 0-terminated messages. */
161 *wire_type = (pb_wire_type_t)(temp & 7);
165 bool checkreturn pb_skip_field(pb_istream_t *stream, pb_wire_type_t wire_type)
169 case PB_WT_VARINT: return pb_skip_varint(stream);
170 case PB_WT_64BIT: return pb_read(stream, NULL, 8);
171 case PB_WT_STRING: return pb_skip_string(stream);
172 case PB_WT_32BIT: return pb_read(stream, NULL, 4);
173 default: PB_RETURN_ERROR(stream, "invalid wire_type");
177 /* Read a raw value to buffer, for the purpose of passing it to callback as
178 * a substream. Size is maximum size on call, and actual size on return.
180 static bool checkreturn read_raw_value(pb_istream_t *stream, pb_wire_type_t wire_type, uint8_t *buf, size_t *size)
182 size_t max_size = *size;
190 if (*size > max_size) return false;
191 if (!pb_read(stream, buf, 1)) return false;
192 } while (*buf++ & 0x80);
197 return pb_read(stream, buf, 8);
201 return pb_read(stream, buf, 4);
203 default: PB_RETURN_ERROR(stream, "invalid wire_type");
207 /* Decode string length from stream and return a substream with limited length.
208 * Remember to close the substream using pb_close_string_substream().
210 bool checkreturn pb_make_string_substream(pb_istream_t *stream, pb_istream_t *substream)
213 if (!pb_decode_varint32(stream, &size))
216 *substream = *stream;
217 if (substream->bytes_left < size)
218 PB_RETURN_ERROR(stream, "parent stream too short");
220 substream->bytes_left = size;
221 stream->bytes_left -= size;
225 void pb_close_string_substream(pb_istream_t *stream, pb_istream_t *substream)
227 stream->state = substream->state;
230 /* Iterator for pb_field_t list */
232 const pb_field_t *start; /* Start of the pb_field_t array */
233 const pb_field_t *current; /* Current position of the iterator */
234 int field_index; /* Zero-based index of the field. */
235 int required_field_index; /* Zero-based index that counts only the required fields */
236 void *dest_struct; /* Pointer to the destination structure to decode to */
237 void *pData; /* Pointer where to store current field value */
238 void *pSize; /* Pointer where to store the size of current array field */
239 } pb_field_iterator_t;
241 static void pb_field_init(pb_field_iterator_t *iter, const pb_field_t *fields, void *dest_struct)
243 iter->start = iter->current = fields;
244 iter->field_index = 0;
245 iter->required_field_index = 0;
246 iter->pData = (char*)dest_struct + iter->current->data_offset;
247 iter->pSize = (char*)iter->pData + iter->current->size_offset;
248 iter->dest_struct = dest_struct;
251 static bool pb_field_next(pb_field_iterator_t *iter)
253 bool notwrapped = true;
254 size_t prev_size = iter->current->data_size;
256 if (PB_HTYPE(iter->current->type) == PB_HTYPE_ARRAY)
257 prev_size *= iter->current->array_size;
259 if (PB_HTYPE(iter->current->type) == PB_HTYPE_REQUIRED)
260 iter->required_field_index++;
264 if (iter->current->tag == 0)
266 iter->current = iter->start;
267 iter->field_index = 0;
268 iter->required_field_index = 0;
269 iter->pData = iter->dest_struct;
274 iter->pData = (char*)iter->pData + prev_size + iter->current->data_offset;
275 iter->pSize = (char*)iter->pData + iter->current->size_offset;
279 static bool checkreturn pb_field_find(pb_field_iterator_t *iter, uint32_t tag)
281 int start = iter->field_index;
284 if (iter->current->tag == tag)
287 } while (iter->field_index != start);
292 /*************************
293 * Decode a single field *
294 *************************/
296 static bool checkreturn decode_field(pb_istream_t *stream, pb_wire_type_t wire_type, pb_field_iterator_t *iter)
298 pb_decoder_t func = PB_DECODERS[PB_LTYPE(iter->current->type)];
300 switch (PB_HTYPE(iter->current->type))
302 case PB_HTYPE_REQUIRED:
303 return func(stream, iter->current, iter->pData);
305 case PB_HTYPE_OPTIONAL:
306 *(bool*)iter->pSize = true;
307 return func(stream, iter->current, iter->pData);
310 if (wire_type == PB_WT_STRING
311 && PB_LTYPE(iter->current->type) <= PB_LTYPE_LAST_PACKABLE)
315 size_t *size = (size_t*)iter->pSize;
316 pb_istream_t substream;
317 if (!pb_make_string_substream(stream, &substream))
320 while (substream.bytes_left && *size < iter->current->array_size)
322 void *pItem = (uint8_t*)iter->pData + iter->current->data_size * (*size);
323 if (!func(&substream, iter->current, pItem))
327 status = (substream.bytes_left == 0);
328 pb_close_string_substream(stream, &substream);
334 size_t *size = (size_t*)iter->pSize;
335 void *pItem = (uint8_t*)iter->pData + iter->current->data_size * (*size);
336 if (*size >= iter->current->array_size)
337 PB_RETURN_ERROR(stream, "array overflow");
340 return func(stream, iter->current, pItem);
343 case PB_HTYPE_CALLBACK:
345 pb_callback_t *pCallback = (pb_callback_t*)iter->pData;
347 if (pCallback->funcs.decode == NULL)
348 return pb_skip_field(stream, wire_type);
350 if (wire_type == PB_WT_STRING)
352 pb_istream_t substream;
354 if (!pb_make_string_substream(stream, &substream))
357 while (substream.bytes_left)
359 if (!pCallback->funcs.decode(&substream, iter->current, pCallback->arg))
360 PB_RETURN_ERROR(stream, "callback failed");
363 pb_close_string_substream(stream, &substream);
368 /* Copy the single scalar value to stack.
369 * This is required so that we can limit the stream length,
370 * which in turn allows to use same callback for packed and
371 * not-packed fields. */
372 pb_istream_t substream;
374 size_t size = sizeof(buffer);
376 if (!read_raw_value(stream, wire_type, buffer, &size))
378 substream = pb_istream_from_buffer(buffer, size);
380 return pCallback->funcs.decode(&substream, iter->current, pCallback->arg);
385 PB_RETURN_ERROR(stream, "invalid field type");
389 /* Initialize message fields to default values, recursively */
390 static void pb_message_set_to_defaults(const pb_field_t fields[], void *dest_struct)
392 pb_field_iterator_t iter;
393 pb_field_init(&iter, fields, dest_struct);
395 /* Initialize size/has fields and apply default values */
398 if (iter.current->tag == 0)
401 /* Initialize the size field for optional/repeated fields to 0. */
402 if (PB_HTYPE(iter.current->type) == PB_HTYPE_OPTIONAL)
404 *(bool*)iter.pSize = false;
406 else if (PB_HTYPE(iter.current->type) == PB_HTYPE_ARRAY)
408 *(size_t*)iter.pSize = 0;
409 continue; /* Array is empty, no need to initialize contents */
412 /* Initialize field contents to default value */
413 if (PB_HTYPE(iter.current->type) == PB_HTYPE_CALLBACK)
415 continue; /* Don't overwrite callback */
417 else if (PB_LTYPE(iter.current->type) == PB_LTYPE_SUBMESSAGE)
419 pb_message_set_to_defaults((const pb_field_t *) iter.current->ptr, iter.pData);
421 else if (iter.current->ptr != NULL)
423 memcpy(iter.pData, iter.current->ptr, iter.current->data_size);
427 memset(iter.pData, 0, iter.current->data_size);
429 } while (pb_field_next(&iter));
432 /*********************
433 * Decode all fields *
434 *********************/
436 bool checkreturn pb_decode_noinit(pb_istream_t *stream, const pb_field_t fields[], void *dest_struct)
438 uint8_t fields_seen[(PB_MAX_REQUIRED_FIELDS + 7) / 8] = {0}; /* Used to check for required fields */
439 pb_field_iterator_t iter;
441 pb_field_init(&iter, fields, dest_struct);
443 while (stream->bytes_left)
446 pb_wire_type_t wire_type;
449 if (!pb_decode_tag(stream, &wire_type, &tag, &eof))
457 if (!pb_field_find(&iter, tag))
459 /* No match found, skip data */
460 if (!pb_skip_field(stream, wire_type))
465 if (PB_HTYPE(iter.current->type) == PB_HTYPE_REQUIRED
466 && iter.required_field_index < PB_MAX_REQUIRED_FIELDS)
468 fields_seen[iter.required_field_index >> 3] |= (uint8_t)(1 << (iter.required_field_index & 7));
471 if (!decode_field(stream, wire_type, &iter))
475 /* Check that all required fields were present. */
476 pb_field_init(&iter, fields, dest_struct);
478 if (PB_HTYPE(iter.current->type) == PB_HTYPE_REQUIRED &&
479 iter.required_field_index < PB_MAX_REQUIRED_FIELDS &&
480 !(fields_seen[iter.required_field_index >> 3] & (1 << (iter.required_field_index & 7))))
482 PB_RETURN_ERROR(stream, "missing required field");
484 } while (pb_field_next(&iter));
489 bool checkreturn pb_decode(pb_istream_t *stream, const pb_field_t fields[], void *dest_struct)
491 pb_message_set_to_defaults(fields, dest_struct);
492 return pb_decode_noinit(stream, fields, dest_struct);
497 bool pb_decode_svarint(pb_istream_t *stream, int64_t *dest)
500 if (!pb_decode_varint(stream, &value))
504 *dest = (int64_t)(~(value >> 1));
506 *dest = (int64_t)(value >> 1);
511 bool pb_decode_fixed32(pb_istream_t *stream, void *dest)
513 #ifdef __BIG_ENDIAN__
514 uint8_t *bytes = (uint8_t*)dest;
517 if (!pb_read(stream, lebytes, 4))
520 bytes[0] = lebytes[3];
521 bytes[1] = lebytes[2];
522 bytes[2] = lebytes[1];
523 bytes[3] = lebytes[0];
526 return pb_read(stream, (uint8_t*)dest, 4);
530 bool pb_decode_fixed64(pb_istream_t *stream, void *dest)
532 #ifdef __BIG_ENDIAN__
533 uint8_t *bytes = (uint8_t*)dest;
536 if (!pb_read(stream, lebytes, 8))
539 bytes[0] = lebytes[7];
540 bytes[1] = lebytes[6];
541 bytes[2] = lebytes[5];
542 bytes[3] = lebytes[4];
543 bytes[4] = lebytes[3];
544 bytes[5] = lebytes[2];
545 bytes[6] = lebytes[1];
546 bytes[7] = lebytes[0];
549 return pb_read(stream, (uint8_t*)dest, 8);
553 bool checkreturn pb_dec_varint(pb_istream_t *stream, const pb_field_t *field, void *dest)
556 bool status = pb_decode_varint(stream, &value);
558 switch (field->data_size)
560 case 1: *(uint8_t*)dest = (uint8_t)value; break;
561 case 2: *(uint16_t*)dest = (uint16_t)value; break;
562 case 4: *(uint32_t*)dest = (uint32_t)value; break;
563 case 8: *(uint64_t*)dest = value; break;
564 default: PB_RETURN_ERROR(stream, "invalid data_size");
570 bool checkreturn pb_dec_svarint(pb_istream_t *stream, const pb_field_t *field, void *dest)
573 bool status = pb_decode_svarint(stream, &value);
575 switch (field->data_size)
577 case 4: *(int32_t*)dest = (int32_t)value; break;
578 case 8: *(int64_t*)dest = value; break;
579 default: PB_RETURN_ERROR(stream, "invalid data_size");
585 bool checkreturn pb_dec_fixed32(pb_istream_t *stream, const pb_field_t *field, void *dest)
588 return pb_decode_fixed32(stream, dest);
591 bool checkreturn pb_dec_fixed64(pb_istream_t *stream, const pb_field_t *field, void *dest)
594 return pb_decode_fixed64(stream, dest);
597 bool checkreturn pb_dec_bytes(pb_istream_t *stream, const pb_field_t *field, void *dest)
599 pb_bytes_array_t *x = (pb_bytes_array_t*)dest;
602 if (!pb_decode_varint32(stream, &temp))
606 /* Check length, noting the space taken by the size_t header. */
607 if (x->size > field->data_size - offsetof(pb_bytes_array_t, bytes))
608 PB_RETURN_ERROR(stream, "bytes overflow");
610 return pb_read(stream, x->bytes, x->size);
613 bool checkreturn pb_dec_string(pb_istream_t *stream, const pb_field_t *field, void *dest)
617 if (!pb_decode_varint32(stream, &size))
620 /* Check length, noting the null terminator */
621 if (size + 1 > field->data_size)
622 PB_RETURN_ERROR(stream, "string overflow");
624 status = pb_read(stream, (uint8_t*)dest, size);
625 *((uint8_t*)dest + size) = 0;
629 bool checkreturn pb_dec_submessage(pb_istream_t *stream, const pb_field_t *field, void *dest)
632 pb_istream_t substream;
633 const pb_field_t* submsg_fields = (const pb_field_t*)field->ptr;
635 if (!pb_make_string_substream(stream, &substream))
638 if (field->ptr == NULL)
639 PB_RETURN_ERROR(stream, "invalid field descriptor");
641 /* New array entries need to be initialized, while required and optional
642 * submessages have already been initialized in the top-level pb_decode. */
643 if (PB_HTYPE(field->type) == PB_HTYPE_ARRAY)
644 status = pb_decode(&substream, submsg_fields, dest);
646 status = pb_decode_noinit(&substream, submsg_fields, dest);
648 pb_close_string_substream(stream, &substream);