rockbox/firmware/buflib.c, branch master

buflib: Switch from term "cookie" to "metadata"

2015-01-02T18:26:03+00:00

The documentation of buflib first mentions metadata
and then changes to "cookie" without explaining it.

Fix it by sticking to metadata.

Change-Id: I0b36b18f4f2590132901c10326481975f8b9b9da

Improve core_alloc() / buflib_alloc() documentation

2015-01-02T17:51:15+00:00

Document the fact that buffers are movable by default.
Care must be taken to not pass them to functions that yield().

Also clarify other things:
- Passing NULL as "ops" to buflib_alloc_ex() causes
  buffers to be movable by default (but not shrinkable).

- If you want shrinkable buffers during compaction,
  you have to provide a shrink callback.

- To disable buffer movement, you have to pass NULL
  for the move_callback inside the callback structure.

- The concept of default callbacks was removed
  long ago, remove the only reference of it.

Change-Id: I3bf0ea6b08b507d80a19f3c2c835aca32b3f7800

PictureFlow: Add move callback for buflib allocations

2015-01-01T22:49:41+00:00

If we don't provide a callback to buflib_alloc(),
the buffer is always movable (to reduce fragmentation).

Since we pass our buffer to functions that call yield(),
this could lead to memory corruption on buflib compaction.

Change-Id: Id1fad1822479d692551c55cb8bc87cea7b78f759

Add missing newline in debug output

2014-12-29T23:17:38+00:00

Change-Id: Ifd67dbcc80db328391464ec93316c48f914bc590

Document 'union buflib_data'

2014-12-29T22:49:12+00:00

Change-Id: Ia98fa8e7887338d6c0b7a5795a0ae5c7a13014ba

buflib: Add a define telling the per-alloc overhead.

2014-02-02T18:40:38+00:00

This allows buflib clients to more accurately estimate the total memory usage.
It's still not 100% accurate because the handle table grows in blocks, thus
buflib might use more memory that caused by allocations directly.

Change-Id: I68338bb94f510ad188fcb588aebf895b5f9197c5

buflib: Properly support allocations without any name, to avoid wasting space

2014-02-02T18:40:38+00:00

in micro-allocation scenarios.

Change-Id: I97a065bcfba8e0fda9b1670445e839e267c769c8

buflib: Check the validity of of handles passed to buflib_get_data() in DEBUG builds.

2014-02-02T15:59:29+00:00

Change-Id: Ic274bfb4a8e1a1a10f9a54186b9173dbc0faa4c8

buflib: Abstract panicf() into buflib_panic().

2014-02-02T15:59:29+00:00

Change-Id: I4968a9bc290e10e30a77c36c19f694e286e7ef22

buflib: Add crc field protecting buflib cookie integrity

2014-01-16T09:17:39+00:00

This should catch the case of buffer misuse which results
in corrupted cookie of next allocation. The check is performed
on move_block() so it may be a bit late.

There is buflib_check_valid() provided which checks the
integrity of all cookies for given context.
On DEBUG build with --sdl-thread this check is carried out
for core_ctx on every context switch to catch problems earlier.

Change-Id: I999d4576084592394e3dbd3bdf0f32935ff5f601
Reviewed-on: http://gerrit.rockbox.org/711
Reviewed-by: Thomas Martitz