From 26383c6f1420ab80e8e7efcecbd75f70dfa96b55 Mon Sep 17 00:00:00 2001 From: Lennart Poettering Date: Tue, 21 Apr 2009 23:02:17 +0200 Subject: memtrap: add a bit of documentation for memtrap --- src/pulsecore/memtrap.h | 11 +++++++++++ 1 file changed, 11 insertions(+) (limited to 'src') diff --git a/src/pulsecore/memtrap.h b/src/pulsecore/memtrap.h index 6cad296c..f7da7083 100644 --- a/src/pulsecore/memtrap.h +++ b/src/pulsecore/memtrap.h @@ -26,6 +26,17 @@ #include +/* This subsystem will trap SIGBUS on specific memory regions. The + * regions will be remapped to anonymous memory (i.e. writable NUL + * bytes) on SIGBUS, so that execution of the main program can + * continue though with memory having changed beneath its hands. With + * pa_memtrap_is_good() it is possible to query if a memory region is + * still 'good' i.e. no SIGBUS has happened yet for it. + * + * Intended usage is to handle memory mapped in which is controlled by + * other processes that might execute ftruncate() or when mapping in + * hardware resources that might get invalidated when unplugged. */ + typedef struct pa_memtrap pa_memtrap; pa_memtrap* pa_memtrap_add(const void *start, size_t size); -- cgit