rockbox/firmware/include/buflib.h, branch working

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

Document 'union buflib_data'

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

Change-Id: Ia98fa8e7887338d6c0b7a5795a0ae5c7a13014ba

Two more typo fixes

2014-12-27T01:00:15+00:00

Change-Id: Id3ec7c1da356cb7c617a1d9ad57c9e0ae9fa6611

Fix typos in documentation

2014-12-27T00:38:11+00:00

Change-Id: I3c7e204bcf67bf0004314fe4b2aec98cae145273

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: 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

buflib: Add buflib_context_relocate().

2013-12-22T22:11:32+00:00

This function relocates a buflib back buffer, updating pointers in struct
buflib_context. It does not move any data by itself.

The intended use-case is buflib-on-buflib, where a buflib back buffer is
allocated with buflib and attempted to be moved. The move_callback() can call
this and return BUFLIB_CB_OK on success. No move_callback() is called for the
subordinate buflib buffer, therefore it must not contain non-movable
allocations. The caller is generally responsible moving the data and all its
implications.

Change-Id: I869219f9cff786a172c9e917a5f34470073892e6

buflib: Try harder in buflib_alloc_maximum().

2013-12-22T22:11:32+00:00

This function will now ask shrinkable allocations to give up all of their
memory. With future support of playback.c this can be used as a safe
replacement for audio_get_buffer().

Change-Id: I290a51d2c75254e66baf5698c41dc444dea6247a