Apache2
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
apr_pools.h
Go to the documentation of this file.
1 /* Licensed to the Apache Software Foundation (ASF) under one or more
2  * contributor license agreements. See the NOTICE file distributed with
3  * this work for additional information regarding copyright ownership.
4  * The ASF licenses this file to You under the Apache License, Version 2.0
5  * (the "License"); you may not use this file except in compliance with
6  * the License. You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 #ifndef APR_POOLS_H
18 #define APR_POOLS_H
19 
43 #include "apr.h"
44 #include "apr_errno.h"
45 #include "apr_general.h" /* for APR_STRINGIFY */
46 #define APR_WANT_MEMFUNC
47 #include "apr_want.h"
48 
49 #ifdef __cplusplus
50 extern "C" {
51 #endif
52 
60 typedef struct apr_pool_t apr_pool_t;
61 
62 
81 #define APR_POOL_DECLARE_ACCESSOR(type) \
82  APR_DECLARE(apr_pool_t *) apr_##type##_pool_get \
83  (const apr_##type##_t *the##type)
84 
91 #define APR_POOL_IMPLEMENT_ACCESSOR(type) \
92  APR_DECLARE(apr_pool_t *) apr_##type##_pool_get \
93  (const apr_##type##_t *the##type) \
94  { return the##type->pool; }
95 
96 
132 #if defined(APR_POOL_DEBUG)
133 /* If APR_POOL_DEBUG is blank, we get 1; if it is a number, we get -1. */
134 #if (APR_POOL_DEBUG - APR_POOL_DEBUG -1 == 1)
135 #undef APR_POOL_DEBUG
136 #define APR_POOL_DEBUG 1
137 #endif
138 #else
139 #define APR_POOL_DEBUG 0
140 #endif
141 
143 #define APR_POOL__FILE_LINE__ __FILE__ ":" APR_STRINGIFY(__LINE__)
144 
145 
146 
148 typedef int (*apr_abortfunc_t)(int retcode);
149 
150 /*
151  * APR memory structure manipulators (pools, tables, and arrays).
152  */
153 
154 /*
155  * Initialization
156  */
157 
165 
172 APR_DECLARE(void) apr_pool_terminate(void);
173 
174 
175 /*
176  * Pool creation/destruction
177  */
178 
179 #include "apr_allocator.h"
180 
197  apr_pool_t *parent,
198  apr_abortfunc_t abort_fn,
199  apr_allocator_t *allocator)
200  __attribute__((nonnull(1)));
201 
219  apr_abortfunc_t abort_fn,
220  apr_allocator_t *allocator)
221  __attribute__((nonnull(1)));
222 
240  apr_pool_t *parent,
241  apr_abortfunc_t abort_fn,
242  apr_allocator_t *allocator,
243  const char *file_line)
244  __attribute__((nonnull(1)));
245 
246 #if APR_POOL_DEBUG
247 #define apr_pool_create_ex(newpool, parent, abort_fn, allocator) \
248  apr_pool_create_ex_debug(newpool, parent, abort_fn, allocator, \
249  APR_POOL__FILE_LINE__)
250 #endif
251 
268  apr_abortfunc_t abort_fn,
269  apr_allocator_t *allocator,
270  const char *file_line)
271  __attribute__((nonnull(1)));
272 
273 #if APR_POOL_DEBUG
274 #define apr_pool_create_unmanaged_ex(newpool, abort_fn, allocator) \
275  apr_pool_create_unmanaged_ex_debug(newpool, abort_fn, allocator, \
276  APR_POOL__FILE_LINE__)
277 
278 #endif
279 
292 #if defined(DOXYGEN)
294  apr_pool_t *parent);
295 #else
296 #if APR_POOL_DEBUG
297 #define apr_pool_create(newpool, parent) \
298  apr_pool_create_ex_debug(newpool, parent, NULL, NULL, \
299  APR_POOL__FILE_LINE__)
300 #else
301 #define apr_pool_create(newpool, parent) \
302  apr_pool_create_ex(newpool, parent, NULL, NULL)
303 #endif
304 #endif
305 
310 #if defined(DOXYGEN)
312 #else
313 #if APR_POOL_DEBUG
314 #define apr_pool_create_unmanaged(newpool) \
315  apr_pool_create_unmanaged_ex_debug(newpool, NULL, NULL, \
316  APR_POOL__FILE_LINE__)
317 #else
318 #define apr_pool_create_unmanaged(newpool) \
319  apr_pool_create_unmanaged_ex(newpool, NULL, NULL)
320 #endif
321 #endif
322 
328  __attribute__((nonnull(1)));
329 
338 APR_DECLARE(void) apr_pool_clear(apr_pool_t *p) __attribute__((nonnull(1)));
339 
354  const char *file_line)
355  __attribute__((nonnull(1)));
356 
357 #if APR_POOL_DEBUG
358 #define apr_pool_clear(p) \
359  apr_pool_clear_debug(p, APR_POOL__FILE_LINE__)
360 #endif
361 
368 APR_DECLARE(void) apr_pool_destroy(apr_pool_t *p) __attribute__((nonnull(1)));
369 
384  const char *file_line)
385  __attribute__((nonnull(1)));
386 
387 #if APR_POOL_DEBUG
388 #define apr_pool_destroy(p) \
389  apr_pool_destroy_debug(p, APR_POOL__FILE_LINE__)
390 #endif
391 
392 
393 /*
394  * Memory allocation
395  */
396 
404 #if defined(__GNUC__) && (__GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 4))
405  __attribute__((alloc_size(2)))
406 #endif
407  __attribute__((nonnull(1)));
408 
418  const char *file_line)
419 #if defined(__GNUC__) && (__GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 4))
420  __attribute__((alloc_size(2)))
421 #endif
422  __attribute__((nonnull(1)));
423 
424 #if APR_POOL_DEBUG
425 #define apr_palloc(p, size) \
426  apr_palloc_debug(p, size, APR_POOL__FILE_LINE__)
427 #endif
428 
435 #if defined(DOXYGEN)
436 APR_DECLARE(void *) apr_pcalloc(apr_pool_t *p, apr_size_t size);
437 #elif !APR_POOL_DEBUG
438 #define apr_pcalloc(p, size) memset(apr_palloc(p, size), 0, size)
439 #endif
440 
450  const char *file_line)
451  __attribute__((nonnull(1)));
452 
453 #if APR_POOL_DEBUG
454 #define apr_pcalloc(p, size) \
455  apr_pcalloc_debug(p, size, APR_POOL__FILE_LINE__)
456 #endif
457 
458 
459 /*
460  * Pool Properties
461  */
462 
472  apr_pool_t *pool)
473  __attribute__((nonnull(2)));
474 
481  __attribute__((nonnull(1)));
482 
489  __attribute__((nonnull(1)));
490 
503 
509 APR_DECLARE(void) apr_pool_tag(apr_pool_t *pool, const char *tag)
510  __attribute__((nonnull(1)));
511 
512 
513 /*
514  * User data management
515  */
516 
537  const char *key,
538  apr_status_t (*cleanup)(void *),
539  apr_pool_t *pool)
540  __attribute__((nonnull(2,4)));
541 
562  const void *data, const char *key,
563  apr_status_t (*cleanup)(void *),
564  apr_pool_t *pool)
565  __attribute__((nonnull(2,4)));
566 
573 APR_DECLARE(apr_status_t) apr_pool_userdata_get(void **data, const char *key,
574  apr_pool_t *pool)
575  __attribute__((nonnull(1,2,3)));
576 
577 
602  apr_pool_t *p, const void *data,
603  apr_status_t (*plain_cleanup)(void *),
604  apr_status_t (*child_cleanup)(void *))
605  __attribute__((nonnull(3,4)));
606 
620  apr_pool_t *p, const void *data,
621  apr_status_t (*plain_cleanup)(void *))
622  __attribute__((nonnull(3)));
623 
636 APR_DECLARE(void) apr_pool_cleanup_kill(apr_pool_t *p, const void *data,
637  apr_status_t (*cleanup)(void *))
638  __attribute__((nonnull(3)));
639 
653  apr_pool_t *p, const void *data,
654  apr_status_t (*plain_cleanup)(void *),
655  apr_status_t (*child_cleanup)(void *))
656  __attribute__((nonnull(3,4)));
657 
670  apr_status_t (*cleanup)(void *))
671  __attribute__((nonnull(3)));
672 
681 
689 
734 #if APR_POOL_DEBUG || defined(DOXYGEN)
735 
741  __attribute__((nonnull(2)));
742 
753 
759 APR_DECLARE(apr_pool_t *) apr_pool_find(const void *mem);
760 
768  __attribute__((nonnull(1)));
769 
775 APR_DECLARE(void) apr_pool_lock(apr_pool_t *pool, int flag);
776 
777 /* @} */
778 
779 #else /* APR_POOL_DEBUG or DOXYGEN */
780 
781 #ifdef apr_pool_join
782 #undef apr_pool_join
783 #endif
784 #define apr_pool_join(a,b)
785 
786 #ifdef apr_pool_owner_set
787 #undef apr_pool_owner_set
788 #endif
789 #define apr_pool_owner_set(a,b)
790 
791 #ifdef apr_pool_lock
792 #undef apr_pool_lock
793 #endif
794 #define apr_pool_lock(pool, lock)
795 
796 #endif /* APR_POOL_DEBUG or DOXYGEN */
797 
800 #ifdef __cplusplus
801 }
802 #endif
803 
804 #endif /* !APR_POOLS_H */
size_t apr_size_t
Definition: apr.h:375
void * apr_pcalloc_debug(apr_pool_t *p, apr_size_t size, const char *file_line) __attribute__((nonnull(1)))
apr_status_t apr_status_t apr_status_t apr_pool_userdata_get(void **data, const char *key, apr_pool_t *pool) __attribute__((nonnull(1
apr_status_t apr_status_t apr_pool_userdata_setn(const void *data, const char *key, apr_status_t(*cleanup)(void *), apr_pool_t *pool) __attribute__((nonnull(2
apr_allocator_t * apr_pool_allocator_get(apr_pool_t *pool) __attribute__((nonnull(1)))
void apr_pool_clear(apr_pool_t *p) __attribute__((nonnull(1)))
void apr_pool_clear_debug(apr_pool_t *p, const char *file_line) __attribute__((nonnull(1)))
void apr_pool_terminate(void)
apr_status_t __attribute__((nonnull(1)))
apr_abortfunc_t apr_pool_abort_get(apr_pool_t *pool) __attribute__((nonnull(1)))
apr_bucket_brigade request_rec apr_pool_t * pool
Definition: mod_dav.h:556
void apr_pool_owner_set(apr_pool_t *pool, apr_uint32_t flags)
void * apr_pcalloc(apr_pool_t *p, apr_size_t size)
void apr_pool_child_cleanup_set(apr_pool_t *p, const void *data, apr_status_t(*plain_cleanup)(void *), apr_status_t(*child_cleanup)(void *)) __attribute__((nonnull(3
void apr_pool_cleanup_register(apr_pool_t *p, const void *data, apr_status_t(*plain_cleanup)(void *), apr_status_t(*child_cleanup)(void *)) __attribute__((nonnull(3
void * apr_palloc(apr_pool_t *p, apr_size_t size) __attribute__((nonnull(1)))
struct apr_allocator_t apr_allocator_t
Definition: apr_allocator.h:41
#define APR_DECLARE_NONSTD(x)
Definition: macros.h:7
apr_status_t apr_pool_create_ex(apr_pool_t **newpool, apr_pool_t *parent, apr_abortfunc_t abort_fn, apr_allocator_t *allocator) __attribute__((nonnull(1)))
apr_pool_t * apr_pool_parent_get(apr_pool_t *pool) __attribute__((nonnull(1)))
void apr_pool_lock(apr_pool_t *pool, int flag)
apr_status_t apr_pool_userdata_set(const void *data, const char *key, apr_status_t(*cleanup)(void *), apr_pool_t *pool) __attribute__((nonnull(2
APR Miscellaneous library routines.
apr_status_t apr_pool_cleanup_null(void *data)
void apr_pool_cleanup_kill(apr_pool_t *p, const void *data, apr_status_t(*cleanup)(void *)) __attribute__((nonnull(3)))
apr_size_t apr_pool_num_bytes(apr_pool_t *p, int recurse) __attribute__((nonnull(1)))
void void apr_pool_pre_cleanup_register(apr_pool_t *p, const void *data, apr_status_t(*plain_cleanup)(void *)) __attribute__((nonnull(3)))
dav_buffer apr_size_t size
Definition: mod_dav.h:461
void apr_pool_cleanup_for_exec(void)
void apr_pool_abort_set(apr_abortfunc_t abortfunc, apr_pool_t *pool) __attribute__((nonnull(2)))
void apr_pool_join(apr_pool_t *p, apr_pool_t *sub) __attribute__((nonnull(2)))
apr_pool_t * apr_pool_find(const void *mem)
int
Definition: mod_proxy.h:617
apr_status_t apr_pool_create_ex_debug(apr_pool_t **newpool, apr_pool_t *parent, apr_abortfunc_t abort_fn, apr_allocator_t *allocator, const char *file_line) __attribute__((nonnull(1)))
APR Error Codes.
apr_status_t apr_pool_create_unmanaged_ex_debug(apr_pool_t **newpool, apr_abortfunc_t abort_fn, apr_allocator_t *allocator, const char *file_line) __attribute__((nonnull(1)))
unsigned int apr_uint32_t
Definition: apr.h:334
APR Platform Definitions.
void apr_pool_tag(apr_pool_t *pool, const char *tag) __attribute__((nonnull(1)))
void * apr_palloc_debug(apr_pool_t *p, apr_size_t size, const char *file_line) __attribute__((nonnull(1)))
apr_pool_t * p
#define APR_DECLARE(x)
Definition: macros.h:6
apr_status_t apr_pool_create_unmanaged(apr_pool_t **newpool)
dav_buffer const void * mem
Definition: mod_dav.h:481
int(* apr_abortfunc_t)(int retcode)
Definition: apr_pools.h:148
struct apr_pool_t apr_pool_t
Definition: apr_pools.h:60
int apr_status_t
Definition: apr_errno.h:44
apr_status_t apr_pool_initialize(void)
void apr_pool_destroy_debug(apr_pool_t *p, const char *file_line) __attribute__((nonnull(1)))
int apr_pool_is_ancestor(apr_pool_t *a, apr_pool_t *b)
apr_status_t apr_pool_create_unmanaged_ex(apr_pool_t **newpool, apr_abortfunc_t abort_fn, apr_allocator_t *allocator) __attribute__((nonnull(1)))
apr_status_t apr_pool_create(apr_pool_t **newpool, apr_pool_t *parent)
void apr_pool_destroy(apr_pool_t *p) __attribute__((nonnull(1)))
dav_resource int dav_locktoken dav_response int flags
Definition: mod_dav.h:1350
void apr_status_t apr_pool_cleanup_run(apr_pool_t *p, void *data, apr_status_t(*cleanup)(void *)) __attribute__((nonnull(3)))