home *** CD-ROM | disk | FTP | other *** search
/ Chip 2004 November / CMCD1104.ISO / Software / Complet / Apache / apache_2.0.52-win32-x86-no_ssl.msi / Data.Cab / F277227_apr_rmm.h < prev    next >
C/C++ Source or Header  |  2004-09-22  |  5KB  |  136 lines
  1. /* Copyright 2000-2004 The Apache Software Foundation
  2.  *
  3.  * Licensed under the Apache License, Version 2.0 (the "License");
  4.  * you may not use this file except in compliance with the License.
  5.  * You may obtain a copy of the License at
  6.  *
  7.  *     http://www.apache.org/licenses/LICENSE-2.0
  8.  *
  9.  * Unless required by applicable law or agreed to in writing, software
  10.  * distributed under the License is distributed on an "AS IS" BASIS,
  11.  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12.  * See the License for the specific language governing permissions and
  13.  * limitations under the License.
  14.  */
  15.  
  16. #ifndef APR_RMM_H
  17. #define APR_RMM_H
  18. /** 
  19.  * @file apr_rmm.h
  20.  * @brief APR-UTIL Relocatable Memory Management Routines
  21.  */
  22. /**
  23.  * @defgroup APR_Util_RMM Relocatable Memory Management Routines
  24.  * @ingroup APR_Util
  25.  * @{
  26.  */
  27.  
  28. #include "apr.h"
  29. #include "apr_pools.h"
  30. #include "apr_errno.h"
  31. #include "apu.h"
  32. #include "apr_anylock.h"
  33.  
  34. #ifdef __cplusplus
  35. extern "C" {
  36. #endif /* __cplusplus */
  37.  
  38. /** Structure to access Relocatable, Managed Memory */
  39. typedef struct apr_rmm_t apr_rmm_t;
  40.  
  41. /** Fundemental allocation unit, within a spcific apr_rmm_off_t */
  42. typedef apr_size_t   apr_rmm_off_t;
  43.  
  44. /**
  45.  * Initialize a relocatable memory block to be managed by the apr_rmm API.
  46.  * @param rmm The relocatable memory block
  47.  * @param lock An apr_anylock_t of the appropriate type of lock
  48.  * @param membuf The block of relocateable memory to be managed
  49.  * @param memsize The size of relocateable memory block to be managed
  50.  * @param cont The pool to use for local storage and management
  51.  * @remark Both @param membuf and @param memsize must be aligned
  52.  * (for instance using APR_ALIGN_DEFAULT).
  53.  */
  54. APU_DECLARE(apr_status_t) apr_rmm_init(apr_rmm_t **rmm, apr_anylock_t *lock,
  55.                                        void* membuf, apr_size_t memsize, 
  56.                                        apr_pool_t *cont);
  57.  
  58. /**
  59.  * Destroy a managed memory block.
  60.  * @param rmm The relocatable memory block to destroy
  61.  */
  62. APU_DECLARE(apr_status_t) apr_rmm_destroy(apr_rmm_t *rmm);
  63.  
  64. /**
  65.  * Attach to a relocatable memory block already managed by the apr_rmm API.
  66.  * @param rmm The relocatable memory block
  67.  * @param lock An apr_anylock_t of the appropriate type of lock
  68.  * @param membuf The block of relocateable memory already under management
  69.  * @param cont The pool to use for local storage and management
  70.  */
  71. APU_DECLARE(apr_status_t) apr_rmm_attach(apr_rmm_t **rmm, apr_anylock_t *lock,
  72.                                          void* membuf, apr_pool_t *cont);
  73.  
  74. /**
  75.  * Detach from the managed block of memory.
  76.  * @param rmm The relocatable memory block to detach from
  77.  */
  78. APU_DECLARE(apr_status_t) apr_rmm_detach(apr_rmm_t *rmm);
  79.  
  80. /**
  81.  * Allocate memory from the block of relocatable memory.
  82.  * @param rmm The relocatable memory block
  83.  * @param reqsize How much memory to allocate
  84.  */
  85. APU_DECLARE(apr_rmm_off_t) apr_rmm_malloc(apr_rmm_t *rmm, apr_size_t reqsize);
  86.  
  87. /**
  88.  * Realloc memory from the block of relocatable memory.
  89.  * @param rmm The relocatable memory block
  90.  * @param entity The memory allocation to realloc
  91.  * @param reqsize The new size
  92.  */
  93. APU_DECLARE(apr_rmm_off_t) apr_rmm_realloc(apr_rmm_t *rmm, void *entity, apr_size_t reqsize);
  94.  
  95. /**
  96.  * Allocate memory from the block of relocatable memory and initialize it to zero.
  97.  * @param rmm The relocatable memory block
  98.  * @param reqsize How much memory to allocate
  99.  */
  100. APU_DECLARE(apr_rmm_off_t) apr_rmm_calloc(apr_rmm_t *rmm, apr_size_t reqsize);
  101.  
  102. /**
  103.  * Free allocation returned by apr_rmm_malloc or apr_rmm_calloc.
  104.  * @param rmm The relocatable memory block
  105.  * @param entity The memory allocation to free
  106.  */
  107. APU_DECLARE(apr_status_t) apr_rmm_free(apr_rmm_t *rmm, apr_rmm_off_t entity);
  108.  
  109. /**
  110.  * Retrieve the physical address of a relocatable allocation of memory
  111.  * @param rmm The relocatable memory block
  112.  * @param entity The memory allocation to free
  113.  * @return address The address, aligned with APR_ALIGN_DEFAULT.
  114.  */
  115. APU_DECLARE(void *) apr_rmm_addr_get(apr_rmm_t *rmm, apr_rmm_off_t entity);
  116.  
  117. /**
  118.  * Compute the offset of a relocatable allocation of memory
  119.  * @param rmm The relocatable memory block
  120.  * @param entity The physical address to convert to an offset
  121.  */
  122. APU_DECLARE(apr_rmm_off_t) apr_rmm_offset_get(apr_rmm_t *rmm, void* entity);
  123.  
  124. /**
  125.  * Compute the required overallocation of memory needed to fit n allocs
  126.  * @param n The number of alloc/calloc regions desired
  127.  */
  128. APU_DECLARE(apr_size_t) apr_rmm_overhead_get(int n);
  129.  
  130. #ifdef __cplusplus
  131. }
  132. #endif
  133. /** @} */
  134. #endif  /* ! APR_RMM_H */
  135.  
  136.