willemt / heapless-bencode

Bencode reader library that doesn't use the heap. Written in C with a BSD license

What?

A bencode reader that doesn't use the heap (ie. malloc/free).

Written in C with a BSD license.

How does it work?

See bencode.h for documentation.

To see the module in action check out:

• Unit tests within test_bencode.c
• github.com:willemt/CTorrentFileReader
• github.com:willemt/CBTTrackerClient

Building

$make

Tradeoffs

If you've got the entire bencoded string in memory, CHeaplessBencodeReader is amazing - it'll do the job great!

Otherwise, if your best access is via a stream (eg. a massive bencoded string that you don't want in memory; or a TCP stream), then https://github.com/willemt/CStreamingBencodeReader is your poison! (Tradeoff: it uses the heap)

heapless-bencode's Issues

[BUG] int returns are limited to 32 bit

64 bit ints are required for files larger than 4GB.

[BUG] bencode_dict_get_start_and_len does not return what header file suggests

int bencode_dict_get_start_and_len in bencode.h suggests that it returns 1 on success.
bencode.c source shows that it actually returns 0 on success.

[BUG] bencode_dict_get_start_and_len asserts if presented with a complex structure

bencode_dict_get_start_and_len will assert if presented with a real life torrent file.
The code is not written to perform a recursive walk through all sub-elements.
It can only handle the very simplest of bencode structures.