granicus.if.org Git - apache/blob - include/ap_slotmem.h

   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 SLOTMEM_H
  18 #define SLOTMEM_H
  19
  20 /* Memory handler for a shared memory divided in slot.
  21  */
  22 /**
  23  * @file  ap_slotmem.h
  24  * @brief Memory Slot Extension Storage Module for Apache
  25  *
  26  * @defgroup MEM mem
  27  * @ingroup  APACHE_MODS
  28  * @{
  29  */
  30
  31 #include "httpd.h"
  32 #include "http_config.h"
  33 #include "http_log.h"
  34 #include "ap_provider.h"
  35
  36 #include "apr.h"
  37 #include "apr_strings.h"
  38 #include "apr_pools.h"
  39 #include "apr_shm.h"
  40 #include "apr_global_mutex.h"
  41 #include "apr_file_io.h"
  42
  43 #if APR_HAVE_UNISTD_H
  44 #include <unistd.h>         /* for getpid() */
  45 #endif
  46
  47 #ifdef __cplusplus
  48 extern "C" {
  49 #endif
  50
  51 #define AP_SLOTMEM_PROVIDER_GROUP "slotmem"
  52 #define AP_SLOTMEM_PROVIDER_VERSION 0
  53
  54 typedef unsigned int ap_slotmem_type_t;
  55
  56 /*
  57  * AP_SLOTMEM_TYPE_PERSIST: For transitory providers, persist
  58  *    the data on the file-system
  59  *
  60  * AP_SLOTMEM_TYPE_NOTMPSAFE:
  61  *
  62  * AP_SLOTMEM_TYPE_PREALLOC: Access to slots require they be grabbed 1st
  63  */
  64 #define AP_SLOTMEM_TYPE_PERSIST   (1 << 0)
  65 #define AP_SLOTMEM_TYPE_NOTMPSAFE (1 << 1)
  66 #define AP_SLOTMEM_TYPE_PREGRAB   (1 << 2)
  67
  68 typedef struct ap_slotmem_instance_t ap_slotmem_instance_t;
  69
  70 /**
  71  * callback function used for slotmem.
  72  * @param mem is the memory associated with a worker.
  73  * @param data is what is passed to slotmem.
  74  * @param pool is pool used
  75  * @return APR_SUCCESS if all went well
  76  */
  77 typedef apr_status_t ap_slotmem_callback_fn_t(void* mem, void *data, apr_pool_t *pool);
  78
  79 struct ap_slotmem_provider_t {
  80     /*
  81      * Name of the provider method
  82      */
  83     const char *name;
  84     /**
  85      * call the callback on all worker slots
  86      * @param s ap_slotmem_instance_t to use.
  87      * @param funct callback function to call for each element.
  88      * @param data parameter for the callback function.
  89      * @param pool is pool used
  90      * @return APR_SUCCESS if all went well
  91      */
  92     apr_status_t (* doall)(ap_slotmem_instance_t *s, ap_slotmem_callback_fn_t *func, void *data, apr_pool_t *pool);
  93     /**
  94      * create a new slotmem with each item size is item_size.
  95      * This would create shared memory, basically.
  96      * @param name is a key used for debugging and in mod_status output or allow another process to share this space.
  97      * @param item_size size of each item
  98      * @param item_num number of item to create.
  99      * @param type type of slotmem.
 100      * @param pool is pool used
 101      * @return APR_SUCCESS if all went well
 102      */
 103     apr_status_t (* create)(ap_slotmem_instance_t **new, const char *name, apr_size_t item_size, unsigned int item_num, ap_slotmem_type_t type, apr_pool_t *pool);
 104     /**
 105      * attach to an existing slotmem.
 106      * This would attach to  shared memory, basically.
 107      * @param name is a key used for debugging and in mod_status output or allow another process to share this space.
 108      * @param item_size size of each item
 109      * @param item_num max number of item.
 110      * @param pool is pool to memory allocate.
 111      * @return APR_SUCCESS if all went well
 112      */
 113     apr_status_t (* attach)(ap_slotmem_instance_t **new, const char *name, apr_size_t *item_size, unsigned int *item_num, apr_pool_t *pool);
 114     /**
 115      * get the memory ptr associated with this worker slot.
 116      * @param s ap_slotmem_instance_t to use.
 117      * @param item_id item to return for 0 to item_num
 118      * @param mem address to store the pointer to the slot
 119      * @return APR_SUCCESS if all went well
 120      */
 121     apr_status_t (* dptr)(ap_slotmem_instance_t *s, unsigned int item_id, void**mem);
 122     /**
 123      * get/read the data associated with this worker slot.
 124      * @param s ap_slotmem_instance_t to use.
 125      * @param item_id item to return for 0 to item_num
 126      * @param dest address to store the data
 127      * @param dest_len length of dataset to retrieve
 128      * @return APR_SUCCESS if all went well
 129      */
 130     apr_status_t (* get)(ap_slotmem_instance_t *s, unsigned int item_id, unsigned char *dest, apr_size_t dest_len);
 131     /**
 132      * put/write the data associated with this worker slot.
 133      * @param s ap_slotmem_instance_t to use.
 134      * @param item_id item to return for 0 to item_num
 135      * @param src address of the data to store in the slot
 136      * @param src_len length of dataset to store in the slot
 137      * @return APR_SUCCESS if all went well
 138      */
 139     apr_status_t (* put)(ap_slotmem_instance_t *slot, unsigned int item_id, unsigned char *src, apr_size_t src_len);
 140     /**
 141      * return number of slots allocated for this entry.
 142      * @param s ap_slotmem_instance_t to use.
 143      * @return number of slots
 144      */
 145     unsigned int (* num_slots)(ap_slotmem_instance_t *s);
 146     /**
 147      * return slot size allocated for this entry.
 148      * @param s ap_slotmem_instance_t to use.
 149      * @return size of slot
 150      */
 151     apr_size_t (* slot_size)(ap_slotmem_instance_t *s);
 152     /**
 153      * grab (or alloc) a free slot
 154      * @param s ap_slotmem_instance_t to use.
 155      * @param item_id ptr to the available slot id and marked as in-use
 156      * @return APR_SUCCESS if all went well
 157      */
 158     apr_status_t (* grab)(ap_slotmem_instance_t *s, unsigned int *item_id);
 159     /**
 160      * release (or free) the slot associated with this item_id
 161      * @param s ap_slotmem_instance_t to use.
 162      * @param item_id slot id to free and mark as no longer in-use
 163      * @return APR_SUCCESS if all went well
 164      */
 165     apr_status_t (* release)(ap_slotmem_instance_t *s, unsigned int item_id);
 166 };
 167
 168 typedef struct ap_slotmem_provider_t ap_slotmem_provider_t;
 169
 170 #ifdef __cplusplus
 171 }
 172 #endif
 173
 174 #endif
 175 /** @} */