1 /* pb_decode.c -- decode a protobuf using minimal resources
3 * 2011 Petteri Aimonen <jpa@kapsi.fi>
10 typedef bool (*pb_decoder_t)(pb_istream_t *stream, const pb_field_t *field, void *dest);
12 /* --- Function pointers to field decoders ---
13 * Order in the array must match pb_action_t LTYPE numbering.
15 static const pb_decoder_t PB_DECODERS[PB_LTYPES_COUNT] = {
29 bool pb_read(pb_istream_t *stream, uint8_t *buf, size_t count)
31 if (stream->bytes_left < count)
34 if (!stream->callback(stream, buf, count))
37 stream->bytes_left -= count;
41 static bool buf_read(pb_istream_t *stream, uint8_t *buf, size_t count)
43 uint8_t *source = (uint8_t*)stream->state;
46 memcpy(buf, source, count);
48 stream->state = source + count;
52 pb_istream_t pb_istream_from_buffer(uint8_t *buf, size_t bufsize)
55 stream.callback = &buf_read;
57 stream.bytes_left = bufsize;
65 static bool pb_decode_varint32(pb_istream_t *stream, uint32_t *dest)
68 bool status = pb_decode_varint(stream, &temp);
73 bool pb_decode_varint(pb_istream_t *stream, uint64_t *dest)
79 while (bitpos < 64 && pb_read(stream, &byte, 1))
81 *dest |= (uint64_t)(byte & 0x7F) << bitpos;
91 bool pb_skip_varint(pb_istream_t *stream)
96 if (!pb_read(stream, &byte, 1))
98 } while (byte & 0x80);
102 bool pb_skip_string(pb_istream_t *stream)
105 if (!pb_decode_varint32(stream, &length))
108 return pb_read(stream, NULL, length);
111 /* Currently the wire type related stuff is kept hidden from
112 * callbacks. They shouldn't need it. It's better for performance
113 * to just assume the correct type and fail safely on corrupt message.
116 static bool skip(pb_istream_t *stream, int wire_type)
120 case PB_WT_VARINT: return pb_skip_varint(stream);
121 case PB_WT_64BIT: return pb_read(stream, NULL, 8);
122 case PB_WT_STRING: return pb_skip_string(stream);
123 case PB_WT_32BIT: return pb_read(stream, NULL, 4);
124 default: return false;
128 /* Read a raw value to buffer, for the purpose of passing it to callback as
129 * a substream. Size is maximum size on call, and actual size on return.
131 static bool read_raw_value(pb_istream_t *stream, pb_wire_type_t wire_type, uint8_t *buf, size_t *size)
133 size_t max_size = *size;
141 if (*size > max_size) return false;
142 if (!pb_read(stream, buf, 1)) return false;
143 } while (*buf++ & 0x80);
148 return pb_read(stream, buf, 8);
152 return pb_read(stream, buf, 4);
154 default: return false;
158 /* Decode string length from stream and return a substream with limited length */
159 static bool make_string_substream(pb_istream_t *stream, pb_istream_t *substream)
162 if (!pb_decode_varint32(stream, &size))
165 *substream = *stream;
166 if (substream->bytes_left < size)
169 substream->bytes_left = size;
170 stream->bytes_left -= size;
174 /* Iterator for pb_field_t list */
176 const pb_field_t *start;
177 const pb_field_t *current;
182 } pb_field_iterator_t;
184 static void pb_field_init(pb_field_iterator_t *iter, const pb_field_t *fields, void *dest_struct)
186 iter->start = iter->current = fields;
187 iter->field_index = 0;
188 iter->pData = dest_struct + iter->current->data_offset;
189 iter->pSize = (char*)iter->pData + iter->current->size_offset;
190 iter->dest_struct = dest_struct;
193 static bool pb_field_next(pb_field_iterator_t *iter)
195 bool notwrapped = true;
196 size_t prev_size = iter->current->data_size;
198 if (PB_HTYPE(iter->current->type) == PB_HTYPE_ARRAY)
199 prev_size *= iter->current->array_size;
203 if (iter->current->tag == 0)
205 iter->current = iter->start;
206 iter->field_index = 0;
207 iter->pData = iter->dest_struct;
212 iter->pData = (char*)iter->pData + prev_size + iter->current->data_offset;
213 iter->pSize = (char*)iter->pData + iter->current->size_offset;
217 static bool pb_field_find(pb_field_iterator_t *iter, int tag)
219 int start = iter->field_index;
222 if (iter->current->tag == tag)
225 } while (iter->field_index != start);
230 /*************************
231 * Decode a single field *
232 *************************/
234 static bool decode_field(pb_istream_t *stream, int wire_type, pb_field_iterator_t *iter)
236 pb_decoder_t func = PB_DECODERS[PB_LTYPE(iter->current->type)];
238 switch (PB_HTYPE(iter->current->type))
240 case PB_HTYPE_REQUIRED:
241 return func(stream, iter->current, iter->pData);
243 case PB_HTYPE_OPTIONAL:
244 *(bool*)iter->pSize = true;
245 return func(stream, iter->current, iter->pData);
248 if (wire_type == PB_WT_STRING
249 && PB_LTYPE(iter->current->type) <= PB_LTYPE_LAST_PACKABLE)
252 size_t *size = (size_t*)iter->pSize;
253 pb_istream_t substream;
254 if (!make_string_substream(stream, &substream))
257 while (substream.bytes_left && *size < iter->current->array_size)
259 void *pItem = (uint8_t*)iter->pData + iter->current->data_size * (*size);
260 if (!func(stream, iter->current, pItem))
264 return (substream.bytes_left == 0);
269 size_t *size = (size_t*)iter->pSize;
270 void *pItem = (uint8_t*)iter->pData + iter->current->data_size * (*size);
271 if (*size >= iter->current->array_size)
275 return func(stream, iter->current, pItem);
278 case PB_HTYPE_CALLBACK:
280 pb_callback_t *pCallback = (pb_callback_t*)iter->pData;
282 if (pCallback->funcs.decode == NULL)
283 return skip(stream, wire_type);
285 if (wire_type == PB_WT_STRING)
287 pb_istream_t substream;
289 if (!make_string_substream(stream, &substream))
292 while (substream.bytes_left)
294 if (!pCallback->funcs.decode(&substream, iter->current, pCallback->arg))
301 /* Copy the single scalar value to stack.
302 * This is required so that we can limit the stream length,
303 * which in turn allows to use same callback for packed and
304 * not-packed fields. */
305 pb_istream_t substream;
307 size_t size = sizeof(buffer);
309 if (!read_raw_value(stream, wire_type, buffer, &size))
311 substream = pb_istream_from_buffer(buffer, size);
313 return pCallback->funcs.decode(&substream, iter->current, pCallback->arg);
322 /*********************
323 * Decode all fields *
324 *********************/
326 bool pb_decode(pb_istream_t *stream, const pb_field_t fields[], void *dest_struct)
328 uint32_t fields_seen = 0; /* Used to check for required fields */
329 pb_field_iterator_t iter;
332 if (fields[0].tag == 0)
334 /* No fields -> nothing to do */
335 return pb_read(stream, NULL, stream->bytes_left);
338 pb_field_init(&iter, fields, dest_struct);
340 /* Initialize size/has fields and apply default values */
343 if (PB_HTYPE(iter.current->type) == PB_HTYPE_OPTIONAL)
345 *(bool*)iter.pSize = false;
347 /* Initialize to default value */
348 if (iter.current->ptr != NULL)
349 memcpy(iter.pData, iter.current->ptr, iter.current->data_size);
351 memset(iter.pData, 0, iter.current->data_size);
353 else if (PB_HTYPE(iter.current->type) == PB_HTYPE_ARRAY)
355 *(size_t*)iter.pSize = 0;
357 else if (PB_HTYPE(iter.current->type) == PB_HTYPE_REQUIRED)
359 memset(iter.pData, 0, iter.current->data_size);
361 } while (pb_field_next(&iter));
363 while (stream->bytes_left)
367 if (!pb_decode_varint32(stream, &temp))
369 if (stream->bytes_left == 0)
370 break; /* It was EOF */
372 return false; /* It was error */
376 break; /* Special feature: allow 0-terminated messages. */
379 wire_type = temp & 7;
381 if (!pb_field_find(&iter, tag))
383 /* No match found, skip data */
384 skip(stream, wire_type);
388 fields_seen |= 1 << (iter.field_index & 31);
390 if (!decode_field(stream, wire_type, &iter))
394 /* Check that all required fields (mod 31) were present. */
395 for (i = 0; fields[i].tag != 0; i++)
397 if (PB_HTYPE(fields[i].type) == PB_HTYPE_REQUIRED &&
398 !(fields_seen & (1 << (i & 31))))
409 /* Copy destsize bytes from src so that values are casted properly.
410 * On little endian machine, copy first n bytes of src
411 * On big endian machine, copy last n bytes of src
412 * srcsize must always be larger than destsize
414 static void endian_copy(void *dest, void *src, size_t destsize, size_t srcsize)
416 #ifdef __BIG_ENDIAN__
417 memcpy(dest, (char*)src + (srcsize - destsize), destsize);
419 memcpy(dest, src, destsize);
423 bool pb_dec_varint(pb_istream_t *stream, const pb_field_t *field, void *dest)
426 bool status = pb_decode_varint(stream, &temp);
427 endian_copy(dest, &temp, field->data_size, sizeof(temp));
431 bool pb_dec_svarint(pb_istream_t *stream, const pb_field_t *field, void *dest)
434 bool status = pb_decode_varint(stream, &temp);
435 temp = (temp >> 1) ^ -(int64_t)(temp & 1);
436 endian_copy(dest, &temp, field->data_size, sizeof(temp));
440 bool pb_dec_fixed(pb_istream_t *stream, const pb_field_t *field, void *dest)
442 #ifdef __BIG_ENDIAN__
443 uint8_t bytes[8] = {0};
444 bool status = pb_read(stream, bytes, field->data_size);
445 uint8_t bebytes[8] = {bytes[7], bytes[6], bytes[5], bytes[4],
446 bytes[3], bytes[2], bytes[1], bytes[0]};
447 endian_copy(dest, lebytes, field->data_size, 8);
450 return pb_read(stream, (uint8_t*)dest, field->data_size);
454 bool pb_dec_bytes(pb_istream_t *stream, const pb_field_t *field, void *dest)
456 pb_bytes_array_t *x = (pb_bytes_array_t*)dest;
459 if (!pb_decode_varint32(stream, &temp))
463 /* Note: data_size includes the size of the x.size field, too.
464 * Calculate actual size starting from offset. */
465 if (x->size > field->data_size - offsetof(pb_bytes_array_t, bytes))
468 return pb_read(stream, x->bytes, x->size);
471 bool pb_dec_string(pb_istream_t *stream, const pb_field_t *field, void *dest)
475 if (!pb_decode_varint32(stream, &size))
478 if (size > field->data_size - 1)
481 status = pb_read(stream, (uint8_t*)dest, size);
482 *((uint8_t*)dest + size) = 0;
486 bool pb_dec_submessage(pb_istream_t *stream, const pb_field_t *field, void *dest)
488 pb_istream_t substream;
490 if (!make_string_substream(stream, &substream))
493 if (field->ptr == NULL)
496 return pb_decode(&substream, (pb_field_t*)field->ptr, dest);