Modules
	Pool Cleanup Functions

	Pool Debugging functions

Macros
#define	APR_POOL_DECLARE_ACCESSOR(type)

#define	APR_POOL_IMPLEMENT_ACCESSOR(type)

#define	APR_POOL__FILE_LINE__ __FILE__ ":" APR_STRINGIFY(__LINE__)

#define	apr_pool_create(newpool, parent) apr_pool_create_ex(newpool, parent, NULL, NULL)

#define	apr_pool_create_core(newpool) apr_pool_create_unmanaged_ex(newpool, NULL, NULL)

#define	apr_pool_create_unmanaged(newpool) apr_pool_create_unmanaged_ex(newpool, NULL, NULL)

#define	apr_pcalloc(p, size) memset(apr_palloc(p, size), 0, size)

Typedefs
typedef struct apr_pool_t	apr_pool_t

typedef int(*	apr_abortfunc_t) (int retcode)

Functions
	APR_DECLARE (apr_status_t) apr_pool_initialize(void)

apr_pool_t apr_abortfunc_t apr_allocator_t *allocator	__attribute__ ((nonnull(1)))

	APR_DECLARE (apr_allocator_t ) apr_pool_allocator_get(apr_pool_t pool) __attribute__((nonnull(1)))

	APR_DECLARE (void ) apr_palloc(apr_pool_t p

apr_pool_t *pool	__attribute__ ((nonnull(2)))

	APR_DECLARE (apr_abortfunc_t) apr_pool_abort_get(apr_pool_t *pool) __attribute__((nonnull(1)))

	APR_DECLARE (apr_pool_t ) apr_pool_parent_get(apr_pool_t pool) __attribute__((nonnull(1)))

const char apr_pool_t *pool	__attribute__ ((nonnull(1, 2, 3)))

Variables
apr_pool_t *	parent

apr_pool_t apr_abortfunc_t	abort_fn

apr_abortfunc_t apr_allocator_t *	allocator

apr_abortfunc_t apr_allocator_t const char *	file_line

apr_size_t	size

apr_pool_t *	b

const char *	key

const char apr_status_t(*	cleanup )(void *)

const char apr_status_t() apr_pool_t poo	__attribute__ )((nonnull(2, 4)))

Detailed Description

Macro Definition Documentation

◆ apr_pcalloc

#define apr_pcalloc	(	p,
		size
	)	memset(apr_palloc(p, size), 0, size)

Allocate a block of memory from a pool and set all of the memory to 0

Parameters

p	The pool to allocate from
size	The amount of memory to allocate

Returns: The allocated memory

Definition at line 465 of file apr_pools.h.

◆ APR_POOL__FILE_LINE__

#define APR_POOL__FILE_LINE__ __FILE__ ":" APR_STRINGIFY(__LINE__)

Pool debug levels

| 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 |
---------------------------------
|   |   |   |   |   |   |   | x |  General debug code enabled (useful in
                                   combination with --with-efence).

|   |   |   |   |   |   | x |   |  Verbose output on stderr (report
                                   CREATE, CLEAR, DESTROY).

|   |   |   | x |   |   |   |   |  Verbose output on stderr (report
                                   PALLOC, PCALLOC).

|   |   |   |   |   | x |   |   |  Lifetime checking. On each use of a
                                   pool, check its lifetime.  If the pool
                                   is out of scope, abort().
                                   In combination with the verbose flag
                                   above, it will output LIFE in such an
                                   event prior to aborting.

|   |   |   |   | x |   |   |   |  Pool owner checking.  On each use of a
                                   pool, check if the current thread is the
                                   pool's owner.  If not, abort().  In
                                   combination with the verbose flag above,
                                   it will output OWNER in such an event
                                   prior to aborting.  Use the debug
                                   function apr_pool_owner_set() to switch
                                   a pool's ownership.

When no debug level was specified, assume general debug mode.
If level 0 was specified, debugging is switched off.

the place in the code where the particular function was called

Definition at line 143 of file apr_pools.h.

◆ apr_pool_create

#define apr_pool_create	(	newpool,
		parent
	)	apr_pool_create_ex(newpool, parent, NULL, NULL)

Create a new pool.

Parameters

newpool	The pool we have just created.
parent	The parent pool. If this is NULL, the new pool is a root pool. If it is non-NULL, the new pool will inherit all of its parent pool's attributes, except the apr_pool_t will be a sub-pool.

Remarks: This function is thread-safe, in the sense that multiple threads can safely create subpools of the same parent pool concurrently. Similarly, a subpool can be created by one thread at the same time that another thread accesses the parent pool.

Definition at line 322 of file apr_pools.h.

◆ apr_pool_create_core

#define apr_pool_create_core ( newpool ) apr_pool_create_unmanaged_ex(newpool, NULL, NULL)

Create a new unmanaged pool.

Parameters

newpool The pool we have just created.

Definition at line 343 of file apr_pools.h.

◆ apr_pool_create_unmanaged

#define apr_pool_create_unmanaged ( newpool ) apr_pool_create_unmanaged_ex(newpool, NULL, NULL)

Definition at line 345 of file apr_pools.h.

◆ APR_POOL_DECLARE_ACCESSOR

#define APR_POOL_DECLARE_ACCESSOR ( type )

Value:

APR_DECLARE(apr_pool_t *) apr_##type##_pool_get \

(const apr_##type##_t *the##type)

APR_DECLARE

const void apr_status_t(*) apr_status_t(* APR_DECLARE)(void) apr_pool_pre_cleanup_register(apr_pool_t *p

Definition apr_pools.h:646

type

int type

Definition apr_file_io.h:798

size

apr_size_t size

Definition apr_pools.h:444

apr_pool_t

Definition apr_pools.c:562

Declaration helper macro to construct apr_foo_pool_get()s.

This standardized macro is used by opaque (APR) data types to return the apr_pool_t that is associated with the data type.

APR_POOL_DECLARE_ACCESSOR() is used in a header file to declare the accessor function. A typical usage and result would be:

   APR_POOL_DECLARE_ACCESSOR(file);
becomes:
   APR_DECLARE(apr_pool_t *) apr_file_pool_get(const apr_file_t *thefile);

Remarks: Doxygen unwraps this macro (via doxygen.conf) to provide actual help for each specific occurrence of apr_foo_pool_get.; the linkage is specified for APR. It would be possible to expand the macros to support other linkages.

Definition at line 81 of file apr_pools.h.

◆ APR_POOL_IMPLEMENT_ACCESSOR

#define APR_POOL_IMPLEMENT_ACCESSOR ( type )

Value:

    APR_DECLARE(apr_pool_t *) apr_##type##_pool_get \
            (const apr_##type##_t *the##type) \
        { return the##type->pool; }

Implementation helper macro to provide apr_foo_pool_get()s.

In the implementation, the APR_POOL_IMPLEMENT_ACCESSOR() is used to actually define the function. It assumes the field is named "pool".

Definition at line 91 of file apr_pools.h.

Typedef Documentation

◆ apr_abortfunc_t

typedef int(* apr_abortfunc_t) (int retcode)

A function that is called when allocation fails.

Definition at line 148 of file apr_pools.h.

◆ apr_pool_t

typedef struct apr_pool_t apr_pool_t

The fundamental pool type

Definition at line 60 of file apr_pools.h.

Function Documentation

◆ attribute() [1/3]

apr_pool_t apr_abortfunc_t apr_allocator_t *allocator __attribute__ ( (nonnull(1)) )

◆ attribute() [2/3]

const char apr_pool_t *pool __attribute__ ( (nonnull(1, 2, 3)) )

◆ attribute() [3/3]

apr_pool_t *pool __attribute__ ( (nonnull(2)) )

◆ APR_DECLARE() [1/5]

APR_DECLARE ( apr_abortfunc_t )

Get the abort function associated with the specified pool.

Parameters

pool	The pool for retrieving the abort function.

Returns: The abort function for the given pool.

Definition at line 2372 of file apr_pools.c.

◆ APR_DECLARE() [2/5]

APR_DECLARE ( apr_allocator_t * )

Find the pool's allocator

Parameters

pool	The pool to get the allocator from.

Definition at line 2389 of file apr_pools.c.

◆ APR_DECLARE() [3/5]

APR_DECLARE ( apr_pool_t * )

Get the parent pool of the specified pool.

Parameters

pool	The pool for retrieving the parent pool.

Returns: The parent of the given pool.

Get the current owner of the allocator

Parameters

allocator The allocator to get the owner from

Definition at line 272 of file open.c.

◆ APR_DECLARE() [4/5]

APR_DECLARE ( apr_status_t )

Setup all of the internal structures required to use pools

Remarks: Programs do NOT need to call this directly. APR will call this automatically from apr_initialize.

Create a new pool.

Parameters

newpool	The pool we have just created.
parent	The parent pool. If this is NULL, the new pool is a root pool. If it is non-NULL, the new pool will inherit all of its parent pool's attributes, except the apr_pool_t will be a sub-pool.
abort_fn	A function to use if the pool cannot allocate more memory.
allocator	The allocator to use with the new pool. If NULL the allocator of the parent pool will be used.

Remarks: This function is thread-safe, in the sense that multiple threads can safely create subpools of the same parent pool concurrently. Similarly, a subpool can be created by one thread at the same time that another thread accesses the parent pool.

Create a new pool.

Deprecated:

See also: apr_pool_create_unmanaged_ex.

Create a new unmanaged pool.

Parameters

newpool	The pool we have just created.
abort_fn	A function to use if the pool cannot allocate more memory.
allocator	The allocator to use with the new pool. If NULL a new allocator will be created with the new pool as owner.

Remarks: An unmanaged pool is a special pool without a parent; it will NOT be destroyed upon apr_terminate. It must be explicitly destroyed by calling apr_pool_destroy, to prevent memory leaks. Use of this function is discouraged, think twice about whether you really really need it.

Warning: Any child cleanups registered against the new pool, or against sub-pools thereof, will not be executed during an invocation of apr_proc_create(), so resources created in an "unmanaged" pool hierarchy will leak to child processes.

Debug version of apr_pool_create_ex.

Parameters

newpool

See also: apr_pool_create.

Parameters

parent

See also: apr_pool_create.

Parameters

abort_fn

See also: apr_pool_create.

Parameters

allocator

See also: apr_pool_create.

Parameters

file_line Where the function is called from. This is usually APR_POOL__FILE_LINE__.

Remarks: Only available when APR_POOL_DEBUG is defined. Call this directly if you have your apr_pool_create_ex calls in a wrapper function and wish to override the file_line argument to reflect the caller of your wrapper function. If you do not have apr_pool_create_ex in a wrapper, trust the macro and don't call apr_pool_create_ex_debug directly.

Debug version of apr_pool_create_core_ex.

Deprecated:

See also: apr_pool_create_unmanaged_ex_debug.

Debug version of apr_pool_create_unmanaged_ex.

Parameters

newpool

See also: apr_pool_create_unmanaged.

Parameters

abort_fn

See also: apr_pool_create_unmanaged.

Parameters

allocator

See also: apr_pool_create_unmanaged.

Parameters

file_line Where the function is called from. This is usually APR_POOL__FILE_LINE__.

Remarks: Only available when APR_POOL_DEBUG is defined. Call this directly if you have your apr_pool_create_unmanaged_ex calls in a wrapper function and wish to override the file_line argument to reflect the caller of your wrapper function. If you do not have apr_pool_create_core_ex in a wrapper, trust the macro and don't call apr_pool_create_core_ex_debug directly.

Determine if pool a is an ancestor of pool b.

Parameters

a	The pool to search
b	The pool to search for

Returns: True if a is an ancestor of b, NULL is considered an ancestor of all pools.

Remarks: if compiled with APR_POOL_DEBUG, this function will also return true if A is a pool which has been guaranteed by the caller (using apr_pool_join) to have a lifetime at least as long as some ancestor of pool B.

Set the data associated with the current pool

Parameters

data	The user data associated with the pool.
key	The key to use for association
cleanup	The cleanup program to use to cleanup the data (NULL if none)
pool	The current pool

Warning: The data to be attached to the pool should have a life span at least as long as the pool it is being attached to.

Users of APR must take EXTREME care when choosing a key to use for their data. It is possible to accidentally overwrite data by choosing a key that another part of the program is using. Therefore it is advised that steps are taken to ensure that unique keys are used for all of the userdata objects in a particular pool (the same key in two different pools or a pool and one of its subpools is okay) at all times. Careful namespace prefixing of key names is a typical way to help ensure this uniqueness.

Set the data associated with the current pool

Parameters

data	The user data associated with the pool.
key	The key to use for association
cleanup	The cleanup program to use to cleanup the data (NULL if none)
pool	The current pool

Note: same as apr_pool_userdata_set(), except that this version doesn't make a copy of the key (this function is useful, for example, when the key is a string literal)

Warning: This should NOT be used if the key could change addresses by any means between the apr_pool_userdata_setn() call and a subsequent apr_pool_userdata_get() on that key, such as if a static string is used as a userdata key in a DSO and the DSO could be unloaded and reloaded between the _setn() and the _get(). You MUST use apr_pool_userdata_set() in such cases.; More generally, the key and the data to be attached to the pool should have a life span at least as long as the pool itself.

Return the data associated with the current pool.

Parameters

data	The user data associated with the pool.
key	The key for the data to retrieve
pool	The current pool.

< File is read-only

< File is executable

< all protections

< File is read-only

< Write by user

<

Deprecated:

See also: APR_FPROT_UWRITE

< Write by group

<

Deprecated:

See also: APR_FPROT_GWRITE

< Write by others

<

Deprecated:

See also: APR_FPROT_WWRITE

< Write by user

<

Deprecated:

See also: APR_FPROT_UWRITE

< Write by group

<

Deprecated:

See also: APR_FPROT_GWRITE

< Write by others

<

Deprecated:

See also: APR_FPROT_WWRITE

< File is executable

< Execute by user

<

Deprecated:

See also: APR_FPROT_UEXECUTE

< Execute by group

<

Deprecated:

See also: APR_FPROT_GEXECUTE

< Execute by others

<

Deprecated:

See also: APR_FPROT_WEXECUTE

< Execute by user

<

Deprecated:

See also: APR_FPROT_UEXECUTE

< Execute by group

<

Deprecated:

See also: APR_FPROT_GEXECUTE

< Execute by others

<

Deprecated:

See also: APR_FPROT_WEXECUTE

< Stat the link not the file itself if it is a link

< ->name in proper case

< Access Time

< Create the file if not there

< Open the file for reading

< Open the file for writing

< Delete the file after close

< Open should fail if APR_FOPEN_CREATE and file exists.

< Do not register a cleanup when the file is opened. The apr_os_file_t handle in apr_file_t will not be closed when the pool is destroyed.

< Read by user

<

Deprecated:

See also: APR_FPROT_UREAD

< Write by user

<

Deprecated:

See also: APR_FPROT_UWRITE

< Do not register a cleanup when the file is opened. The apr_os_file_t handle in apr_file_t will not be closed when the pool is destroyed.

< ->name in proper case

< Modification Time

< Access Time

< Creation or inode-changed time

< Type

< Size of the file

< Storage size consumed by the file

< Do not register a cleanup when the file is opened. The apr_os_file_t handle in apr_file_t will not be closed when the pool is destroyed.

< ->name in proper case

< Type

< all protections

< ->name in proper case

< File is read-only

< File is hidden

< File is read-only

< File is hidden

< Platform dependent flag to enable * non blocking file io

< Open the file for reading

< Open the file for writing

< Open the file for reading

< Open the file for writing

< Open the file for buffered I/O

< Create the file if not there

< Open should fail if APR_FOPEN_CREATE and file exists.

< Open the file and truncate to 0 length

< Open should fail if APR_FOPEN_CREATE and file exists.

< Create the file if not there

< Open the file and truncate to 0 length

< Append to the end of the file

< Do not register a cleanup when the file is opened. The apr_os_file_t handle in apr_file_t will not be closed when the pool is destroyed.

< Delete the file after close

< Open the file for buffered I/O

< Open the file for writing

< Open the file for reading

< Append to the end of the file

< an atomic unix apr_stat()

< Open the file for writing

< Create the file if not there

< Open the file and truncate to 0 length

< Open the file for writing

< Create the file if not there

< Append to the end of the file

< Do not register a cleanup when the file is opened. The apr_os_file_t handle in apr_file_t will not be closed when the pool is destroyed.

< File is read-only

< File is executable

< all protections

< File is read-only

< Write by user

<

Deprecated:

See also: APR_FPROT_UWRITE

< Write by group

<

Deprecated:

See also: APR_FPROT_GWRITE

< Write by others

<

Deprecated:

See also: APR_FPROT_WWRITE

< Write by user

<

Deprecated:

See also: APR_FPROT_UWRITE

< Write by group

<

Deprecated:

See also: APR_FPROT_GWRITE

< Write by others

<

Deprecated:

See also: APR_FPROT_WWRITE

< File is executable

< Execute by user

<

Deprecated:

See also: APR_FPROT_UEXECUTE

< Execute by group

<

Deprecated:

See also: APR_FPROT_GEXECUTE

< Execute by others

<

Deprecated:

See also: APR_FPROT_WEXECUTE

< Execute by user

<

Deprecated:

See also: APR_FPROT_UEXECUTE

< Execute by group

<

Deprecated:

See also: APR_FPROT_GEXECUTE

< Execute by others

<

Deprecated:

See also: APR_FPROT_WEXECUTE

< Access Time

< Stat the link not the file itself if it is a link

< Create the file if not there

< Open the file for reading

< Open the file for writing

< Open should fail if APR_FOPEN_CREATE and file exists.

< Delete the file after close

< Open the file for reading

< Open the file for writing

< Open the file for reading

< Open the file for writing

< Create the file if not there

< Open should fail if APR_FOPEN_CREATE and file exists.

< Create the file if not there

< Append to the end of the file

< Open the file and truncate to 0 length

< Platform dependent flag to enable * non blocking file io

< use OS's default permissions

<

Deprecated:

See also: APR_FPROT_OS_DEFAULT

< Do not register a cleanup when the file is opened. The apr_os_file_t handle in apr_file_t will not be closed when the pool is destroyed.

< Open the file for buffered I/O

< Do not register a cleanup when the file is opened. The apr_os_file_t handle in apr_file_t will not be closed when the pool is destroyed.

< Open the file for buffered I/O

< Open the file for writing

< Open the file for reading

< Do not register a cleanup when the file is opened. The apr_os_file_t handle in apr_file_t will not be closed when the pool is destroyed.

The problem with trying to output the entire iovec is that we cannot maintain the behaviour that a real writev would have. If we iterate over the iovec one at a time, we lose the atomic properties of writev(). The other option is to combine the entire iovec into one buffer that we could then send in one call to write(). This is not reasonable since we do not know how much data an iovec could contain.

The only reasonable option, that maintains the semantics of a real writev(), is to only write the first iovec. Callers of file_writev() must deal with partial writes as they normally would. If you want to ensure an entire iovec is written, use apr_file_writev_full().

< ->name in proper case

< Do not register a cleanup when the file is opened. The apr_os_file_t handle in apr_file_t will not be closed when the pool is destroyed.

< Size of the file

< dev and inode

< Number of links

< ->name in proper case

< Type

< ->name in proper case

< File is read-only

< File is hidden

< File is read-only

< File is hidden

< Open the file for reading

< use OS's default permissions

<

Deprecated:

See also: APR_FPROT_OS_DEFAULT

< Platform dependent flag to enable * non blocking file io

< Open the file for reading

< Open the file for writing

< Create the file if not there

< Open should fail if APR_FOPEN_CREATE and file exists.

< Open the file and truncate to 0 length

< Open should fail if APR_FOPEN_CREATE and file exists.

< Create the file if not there

< Delete the file after close

< Open the file for reading

< Open the file for writing

< Platform dependent tag to open the file for use across multiple threads

< Append to the end of the file

< Open the file for buffered I/O

< Platform dependent flag to enable * sparse file support, see WARNING below

< Do not register a cleanup when the file is opened. The apr_os_file_t handle in apr_file_t will not be closed when the pool is destroyed.

< Append to the end of the file

< Open the file for buffered I/O

< Open the file for writing

< Open the file for reading

< Platform dependent tag to open the file for use across multiple threads

< Exclusive lock. Only one process may hold an exclusive lock at any given time. This is analogous to a "write lock".

< Platform dependent tag to open the file for use across multiple threads

< Size of the file

< Platform dependent tag to open the file for use across multiple threads

< Size of the file

Definition at line 74 of file apr_atomic.c.

◆ APR_DECLARE() [5/5]

APR_DECLARE ( void * )

Allocate a block of memory from a pool

Parameters

p	The pool to allocate from
size	The amount of memory to allocate

Returns: The allocated memory

Debug version of apr_palloc

Parameters

p	See: apr_palloc
size	See: apr_palloc
file_line	Where the function is called from. This is usually APR_POOL__FILE_LINE__.

Returns: See: apr_palloc

Debug version of apr_pcalloc

Parameters

p	See: apr_pcalloc
size	See: apr_pcalloc
file_line	Where the function is called from. This is usually APR_POOL__FILE_LINE__.

Returns: See: apr_pcalloc

Definition at line 131 of file apr_atomic.c.

Variable Documentation

◆ attribute

const char *tag __attribute__ ( (nonnull(2, 4)) )

Definition at line 567 of file apr_pools.h.

◆ abort_fn

apr_abortfunc_t abort_fn

Definition at line 198 of file apr_pools.h.

◆ allocator

apr_abortfunc_t apr_allocator_t * allocator

Definition at line 208 of file apr_pools.h.

◆ b

apr_pool_t* b

Definition at line 529 of file apr_pools.h.

◆ cleanup

const char apr_status_t(* cleanup)(void *) ( void * )

Definition at line 565 of file apr_pools.h.

◆ file_line

apr_abortfunc_t apr_allocator_t const char* file_line

Definition at line 267 of file apr_pools.h.

◆ key

const char * key

Definition at line 564 of file apr_pools.h.

◆ parent

apr_pool_t * parent

Definition at line 197 of file apr_pools.h.

◆ size

apr_size_t size

Definition at line 444 of file apr_pools.h.

Modules

Macros

Typedefs

Functions

Variables

Detailed Description

Macro Definition Documentation

◆ apr_pcalloc

◆ APR_POOL__FILE_LINE__

◆ apr_pool_create

◆ apr_pool_create_core

◆ apr_pool_create_unmanaged

◆ APR_POOL_DECLARE_ACCESSOR

◆ APR_POOL_IMPLEMENT_ACCESSOR

Typedef Documentation

◆ apr_abortfunc_t

◆ apr_pool_t

Function Documentation

◆ __attribute__() [1/3]

◆ __attribute__() [2/3]

◆ __attribute__() [3/3]

◆ APR_DECLARE() [1/5]

◆ APR_DECLARE() [2/5]

◆ APR_DECLARE() [3/5]

◆ APR_DECLARE() [4/5]

◆ APR_DECLARE() [5/5]

Variable Documentation

◆ __attribute__

◆ abort_fn

◆ allocator

◆ b

◆ cleanup

◆ file_line

◆ key

◆ parent

◆ size

◆ attribute() [1/3]

◆ attribute() [2/3]

◆ attribute() [3/3]

◆ attribute