Pool Debugging functions.

Overview

pools have nested lifetimes sub_pools are destroyed when the parent pool is cleared. More…

// global functions

void
apr_pool_join(
    apr_pool_t* p,
    apr_pool_t* sub
);

apr_pool_t*
apr_pool_find(const void* mem);

apr_size_t
apr_pool_num_bytes(
    apr_pool_t* p,
    int recurse
);

void
apr_pool_lock(
    apr_pool_t* pool,
    int flag
);

Detailed Documentation

pools have nested lifetimes sub_pools are destroyed when the parent pool is cleared. We allow certain liberties with operations on things such as tables (and on other structures in a more general sense) where we allow the caller to insert values into a table which were not allocated from the table’s pool. The table’s data will remain valid as long as all the pools from which its values are allocated remain valid.

For example, if B is a sub pool of A, and you build a table T in pool B, then it’s safe to insert data allocated in A or B into T (because B lives at most as long as A does, and T is destroyed when B is cleared/destroyed). On the other hand, if S is a table in pool A, it is safe to insert data allocated in A into S, but it is not safe to insert data allocated from B into S… because B can be cleared/destroyed before A is (which would leave dangling pointers in T’s data structures).

In general we say that it is safe to insert data into a table T if the data is allocated in any ancestor of T’s pool. This is the basis on which the APR_POOL_DEBUG code works it tests these ancestor relationships for all data inserted into tables. APR_POOL_DEBUG also provides tools (apr_pool_find, and apr_pool_is_ancestor) for other folks to implement similar restrictions for their own data structures.

However, sometimes this ancestor requirement is inconvenient sometimes it’s necessary to create a sub pool where the sub pool is guaranteed to have the same lifetime as the parent pool. This is a guarantee implemented by the caller, not by the pool code. That is, the caller guarantees they won’t destroy the sub pool individually prior to destroying the parent pool.

In this case the caller must call apr_pool_join() to indicate this guarantee to the APR_POOL_DEBUG code.

These functions are only implemented when #APR_POOL_DEBUG is set.

Global Functions

void
apr_pool_join(
    apr_pool_t* p,
    apr_pool_t* sub
)

Guarantee that a subpool has the same lifetime as the parent.

Parameters:

p	The parent pool
sub	The subpool

apr_pool_t*
apr_pool_find(const void* mem)

Find a pool from something allocated in it.

Parameters:

mem	The thing allocated in the pool

Returns:

The pool it is allocated in

apr_size_t
apr_pool_num_bytes(
    apr_pool_t* p,
    int recurse
)

Report the number of bytes currently in the pool

Parameters:

p	The pool to inspect
recurse	Recurse/include the subpools’ sizes

Returns:

The number of bytes

void
apr_pool_lock(
    apr_pool_t* pool,
    int flag
)

Lock a pool

Parameters:

pool	The pool to lock
flag	The flag