Apache HTTPD
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
50extern "C" {
51#endif
52
60typedef 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
148typedef int (*apr_abortfunc_t)(int retcode);
149
150/*
151 * APR memory structure manipulators (pools, tables, and arrays).
152 */
153
154/*
155 * Initialization
156 */
157
164APR_DECLARE(apr_status_t) apr_pool_initialize(void);
165
172APR_DECLARE(void) apr_pool_terminate(void);
173
174
175/*
176 * Pool creation/destruction
177 */
178
179#include "apr_allocator.h"
180
196APR_DECLARE(apr_status_t) apr_pool_create_ex(apr_pool_t **newpool,
197 apr_pool_t *parent,
198 apr_abortfunc_t abort_fn,
199 apr_allocator_t *allocator)
200 __attribute__((nonnull(1)));
201
206APR_DECLARE(apr_status_t) apr_pool_create_core_ex(apr_pool_t **newpool,
207 apr_abortfunc_t abort_fn,
208 apr_allocator_t *allocator);
209
226APR_DECLARE(apr_status_t) apr_pool_create_unmanaged_ex(apr_pool_t **newpool,
227 apr_abortfunc_t abort_fn,
228 apr_allocator_t *allocator)
229 __attribute__((nonnull(1)));
230
247APR_DECLARE(apr_status_t) apr_pool_create_ex_debug(apr_pool_t **newpool,
248 apr_pool_t *parent,
249 apr_abortfunc_t abort_fn,
250 apr_allocator_t *allocator,
251 const char *file_line)
252 __attribute__((nonnull(1)));
253
254#if APR_POOL_DEBUG
255#define apr_pool_create_ex(newpool, parent, abort_fn, allocator) \
256 apr_pool_create_ex_debug(newpool, parent, abort_fn, allocator, \
257 APR_POOL__FILE_LINE__)
258#endif
259
264APR_DECLARE(apr_status_t) apr_pool_create_core_ex_debug(apr_pool_t **newpool,
265 apr_abortfunc_t abort_fn,
266 apr_allocator_t *allocator,
267 const char *file_line);
268
284APR_DECLARE(apr_status_t) apr_pool_create_unmanaged_ex_debug(apr_pool_t **newpool,
285 apr_abortfunc_t abort_fn,
286 apr_allocator_t *allocator,
287 const char *file_line)
288 __attribute__((nonnull(1)));
289
290#if APR_POOL_DEBUG
291#define apr_pool_create_core_ex(newpool, abort_fn, allocator) \
292 apr_pool_create_unmanaged_ex_debug(newpool, abort_fn, allocator, \
293 APR_POOL__FILE_LINE__)
294
295#define apr_pool_create_unmanaged_ex(newpool, abort_fn, allocator) \
296 apr_pool_create_unmanaged_ex_debug(newpool, abort_fn, allocator, \
297 APR_POOL__FILE_LINE__)
298
299#endif
300
313#if defined(DOXYGEN)
314APR_DECLARE(apr_status_t) apr_pool_create(apr_pool_t **newpool,
315 apr_pool_t *parent);
316#else
317#if APR_POOL_DEBUG
318#define apr_pool_create(newpool, parent) \
319 apr_pool_create_ex_debug(newpool, parent, NULL, NULL, \
320 APR_POOL__FILE_LINE__)
321#else
322#define apr_pool_create(newpool, parent) \
323 apr_pool_create_ex(newpool, parent, NULL, NULL)
324#endif
325#endif
326
331#if defined(DOXYGEN)
332APR_DECLARE(apr_status_t) apr_pool_create_core(apr_pool_t **newpool);
333APR_DECLARE(apr_status_t) apr_pool_create_unmanaged(apr_pool_t **newpool);
334#else
335#if APR_POOL_DEBUG
336#define apr_pool_create_core(newpool) \
337 apr_pool_create_unmanaged_ex_debug(newpool, NULL, NULL, \
338 APR_POOL__FILE_LINE__)
339#define apr_pool_create_unmanaged(newpool) \
340 apr_pool_create_unmanaged_ex_debug(newpool, NULL, NULL, \
341 APR_POOL__FILE_LINE__)
342#else
343#define apr_pool_create_core(newpool) \
344 apr_pool_create_unmanaged_ex(newpool, NULL, NULL)
345#define apr_pool_create_unmanaged(newpool) \
346 apr_pool_create_unmanaged_ex(newpool, NULL, NULL)
347#endif
348#endif
349
354APR_DECLARE(apr_allocator_t *) apr_pool_allocator_get(apr_pool_t *pool)
355 __attribute__((nonnull(1)));
356
365APR_DECLARE(void) apr_pool_clear(apr_pool_t *p) __attribute__((nonnull(1)));
366
380APR_DECLARE(void) apr_pool_clear_debug(apr_pool_t *p,
381 const char *file_line)
382 __attribute__((nonnull(1)));
383
384#if APR_POOL_DEBUG
385#define apr_pool_clear(p) \
386 apr_pool_clear_debug(p, APR_POOL__FILE_LINE__)
387#endif
388
395APR_DECLARE(void) apr_pool_destroy(apr_pool_t *p) __attribute__((nonnull(1)));
396
410APR_DECLARE(void) apr_pool_destroy_debug(apr_pool_t *p,
411 const char *file_line)
412 __attribute__((nonnull(1)));
413
414#if APR_POOL_DEBUG
415#define apr_pool_destroy(p) \
416 apr_pool_destroy_debug(p, APR_POOL__FILE_LINE__)
417#endif
418
419
420/*
421 * Memory allocation
422 */
423
430APR_DECLARE(void *) apr_palloc(apr_pool_t *p, apr_size_t size)
431#if defined(__GNUC__) && (__GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 4))
432 __attribute__((alloc_size(2)))
433#endif
434 __attribute__((nonnull(1)));
435
444APR_DECLARE(void *) apr_palloc_debug(apr_pool_t *p, apr_size_t size,
445 const char *file_line)
446#if defined(__GNUC__) && (__GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 4))
447 __attribute__((alloc_size(2)))
448#endif
449 __attribute__((nonnull(1)));
450
451#if APR_POOL_DEBUG
452#define apr_palloc(p, size) \
453 apr_palloc_debug(p, size, APR_POOL__FILE_LINE__)
454#endif
455
462#if defined(DOXYGEN)
463APR_DECLARE(void *) apr_pcalloc(apr_pool_t *p, apr_size_t size);
464#elif !APR_POOL_DEBUG
465#define apr_pcalloc(p, size) memset(apr_palloc(p, size), 0, size)
466#endif
467
476APR_DECLARE(void *) apr_pcalloc_debug(apr_pool_t *p, apr_size_t size,
477 const char *file_line)
478 __attribute__((nonnull(1)));
479
480#if APR_POOL_DEBUG
481#define apr_pcalloc(p, size) \
482 apr_pcalloc_debug(p, size, APR_POOL__FILE_LINE__)
483#endif
484
485
486/*
487 * Pool Properties
488 */
489
498APR_DECLARE(void) apr_pool_abort_set(apr_abortfunc_t abortfunc,
499 apr_pool_t *pool)
500 __attribute__((nonnull(2)));
501
507APR_DECLARE(apr_abortfunc_t) apr_pool_abort_get(apr_pool_t *pool)
508 __attribute__((nonnull(1)));
509
515APR_DECLARE(apr_pool_t *) apr_pool_parent_get(apr_pool_t *pool)
516 __attribute__((nonnull(1)));
517
529APR_DECLARE(int) apr_pool_is_ancestor(apr_pool_t *a, apr_pool_t *b);
530
536APR_DECLARE(void) apr_pool_tag(apr_pool_t *pool, const char *tag)
537 __attribute__((nonnull(1)));
538
539
540/*
541 * User data management
542 */
543
563APR_DECLARE(apr_status_t) apr_pool_userdata_set(const void *data,
564 const char *key,
565 apr_status_t (*cleanup)(void *),
566 apr_pool_t *pool)
567 __attribute__((nonnull(2,4)));
568
588APR_DECLARE(apr_status_t) apr_pool_userdata_setn(
589 const void *data, const char *key,
590 apr_status_t (*cleanup)(void *),
591 apr_pool_t *pool)
592 __attribute__((nonnull(2,4)));
593
600APR_DECLARE(apr_status_t) apr_pool_userdata_get(void **data, const char *key,
601 apr_pool_t *pool)
602 __attribute__((nonnull(1,2,3)));
603
604
628APR_DECLARE(void) apr_pool_cleanup_register(
629 apr_pool_t *p, const void *data,
630 apr_status_t (*plain_cleanup)(void *),
631 apr_status_t (*child_cleanup)(void *))
632 __attribute__((nonnull(3,4)));
633
646APR_DECLARE(void) apr_pool_pre_cleanup_register(
647 apr_pool_t *p, const void *data,
648 apr_status_t (*plain_cleanup)(void *))
649 __attribute__((nonnull(3)));
650
663APR_DECLARE(void) apr_pool_cleanup_kill(apr_pool_t *p, const void *data,
664 apr_status_t (*cleanup)(void *))
665 __attribute__((nonnull(3)));
666
679APR_DECLARE(void) apr_pool_child_cleanup_set(
680 apr_pool_t *p, const void *data,
681 apr_status_t (*plain_cleanup)(void *),
682 apr_status_t (*child_cleanup)(void *))
683 __attribute__((nonnull(3,4)));
684
696APR_DECLARE(apr_status_t) apr_pool_cleanup_run(apr_pool_t *p, void *data,
697 apr_status_t (*cleanup)(void *))
698 __attribute__((nonnull(3)));
699
707APR_DECLARE_NONSTD(apr_status_t) apr_pool_cleanup_null(void *data);
708
715APR_DECLARE(void) apr_pool_cleanup_for_exec(void);
716
761#if APR_POOL_DEBUG || defined(DOXYGEN)
767APR_DECLARE(void) apr_pool_join(apr_pool_t *p, apr_pool_t *sub)
768 __attribute__((nonnull(2)));
769
775APR_DECLARE(apr_pool_t *) apr_pool_find(const void *mem);
776
783APR_DECLARE(apr_size_t) apr_pool_num_bytes(apr_pool_t *p, int recurse)
784 __attribute__((nonnull(1)));
785
791APR_DECLARE(void) apr_pool_lock(apr_pool_t *pool, int flag);
792
795#else /* APR_POOL_DEBUG or DOXYGEN */
796
797#ifdef apr_pool_join
798#undef apr_pool_join
799#endif
800#define apr_pool_join(a,b)
801
802#ifdef apr_pool_lock
803#undef apr_pool_lock
804#endif
805#define apr_pool_lock(pool, lock)
806
807#endif /* APR_POOL_DEBUG or DOXYGEN */
808
811#ifdef __cplusplus
812}
813#endif
814
815#endif /* !APR_POOLS_H */
apr_allocator.h
APR Internal Memory Allocation.
apr_errno.h
APR Error Codes.
apr_general.h
APR Miscellaneous library routines.
apr_want.h
APR Standard Headers Support.
a
apr_bucket apr_bucket_brigade * a
Definition apr_buckets.h:700
child_cleanup
const void apr_status_t(*) apr_status_t(* child_cleanup)(void *)) __attribute__((nonnull(3
Definition apr_pools.h:631
data
const void * data
Definition apr_pools.h:629
plain_cleanup
const void apr_status_t(* plain_cleanup)(void *)
Definition apr_pools.h:630
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
apr_pool_join
#define apr_pool_join(a, b)
Definition apr_pools.h:800
apr_pool_lock
#define apr_pool_lock(pool, lock)
Definition apr_pools.h:805
pool
const char int apr_pool_t * pool
Definition apr_cstr.h:84
apr_status_t
int apr_status_t
Definition apr_errno.h:44
flag
const char apr_int32_t flag
Definition apr_file_io.h:251
APR_DECLARE_NONSTD
APR_DECLARE_NONSTD(void) apr_terminate(void)
Definition start.c:173
apr_pool_create_unmanaged
#define apr_pool_create_unmanaged(newpool)
Definition apr_pools.h:345
b
apr_pool_t * b
Definition apr_pools.h:529
apr_abortfunc_t
int(* apr_abortfunc_t)(int retcode)
Definition apr_pools.h:148
allocator
apr_abortfunc_t apr_allocator_t * allocator
Definition apr_pools.h:208
parent
apr_pool_t * parent
Definition apr_pools.h:197
__attribute__
const char apr_status_t(*) apr_pool_t *poo __attribute__)((nonnull(2, 4)))
Definition apr_pools.h:567
size
apr_size_t size
Definition apr_pools.h:444
file_line
apr_abortfunc_t apr_allocator_t const char * file_line
Definition apr_pools.h:267
cleanup
const char apr_status_t(* cleanup)(void *)
Definition apr_pools.h:565
apr_pool_create
#define apr_pool_create(newpool, parent)
Definition apr_pools.h:322
apr_pool_create_core
#define apr_pool_create_core(newpool)
Definition apr_pools.h:343
apr_pcalloc
#define apr_pcalloc(p, size)
Definition apr_pools.h:465
key
const char * key
Definition apr_pools.h:564
abort_fn
apr_pool_t apr_abortfunc_t abort_fn
Definition apr_pools.h:198
mem
void * mem
Definition apr_skiplist.h:88
p
apr_pool_t * p
Definition md_event.c:32
apr_allocator_t
Definition apr_pools.c:125
apr_pool_t
Definition apr_pools.c:562
int
typedef int(WSAAPI *apr_winapi_fpt_WSAPoll)(IN OUT LPWSAPOLLFD fdArray
Generated by doxygen 1.9.8