From 415f8797a96c2656ed714a7c20df0d7fa02ddfb2 Mon Sep 17 00:00:00 2001 From: Sander Striker Date: Mon, 18 Dec 2006 00:11:30 +0000 Subject: * memory/unix/apr_pools.c (apr_allocator_t): Add comments for struct members. Submitted by: Peter Steiner PR: 40955 git-svn-id: https://svn.apache.org/repos/asf/apr/apr/trunk@488084 13f79535-47bb-0310-9956-ffa450edef68 --- memory/unix/apr_pools.c | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) (limited to 'memory') diff --git a/memory/unix/apr_pools.c b/memory/unix/apr_pools.c index c9c851f47..c615cd67c 100644 --- a/memory/unix/apr_pools.c +++ b/memory/unix/apr_pools.c @@ -62,16 +62,39 @@ /* * Allocator + * + * @note The max_free_index and current_free_index fields are not really + * indices, but quantities of BOUNDARY_SIZE big memory blocks. */ struct apr_allocator_t { + /** largest used index into free[], always < MAX_INDEX */ apr_uint32_t max_index; + /** Total size (in BOUNDARY_SIZE multiples) of unused memory before + * blocks are given back. @see apr_allocator_max_free_set(). + * @note Initialized to APR_ALLOCATOR_MAX_FREE_UNLIMITED, + * which means to never give back blocks. + */ apr_uint32_t max_free_index; + /** + * Memory size (in BOUNDARY_SIZE multiples) that currently must be freed + * before blocks are given back. Range: 0..max_free_index + */ apr_uint32_t current_free_index; #if APR_HAS_THREADS apr_thread_mutex_t *mutex; #endif /* APR_HAS_THREADS */ apr_pool_t *owner; + /** + * Lists of free nodes. Slot 0 is used for oversized nodes, + * and the slots 1..MAX_INDEX-1 contain nodes of sizes + * (i+1) * BOUNDARY_SIZE. Example for BOUNDARY_INDEX == 12: + * slot 0: nodes larger than 81920 + * slot 1: size 8192 + * slot 2: size 12288 + * ... + * slot 19: size 81920 + */ apr_memnode_t *free[MAX_INDEX]; }; -- cgit v1.2.1