diff options
Diffstat (limited to 'rubbos/app/tomcat-connectors-1.2.32-src/native/common/jk_shm.h')
| -rw-r--r-- | rubbos/app/tomcat-connectors-1.2.32-src/native/common/jk_shm.h | 258 |
1 files changed, 258 insertions, 0 deletions
diff --git a/rubbos/app/tomcat-connectors-1.2.32-src/native/common/jk_shm.h b/rubbos/app/tomcat-connectors-1.2.32-src/native/common/jk_shm.h new file mode 100644 index 00000000..f8d54a45 --- /dev/null +++ b/rubbos/app/tomcat-connectors-1.2.32-src/native/common/jk_shm.h @@ -0,0 +1,258 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +/*************************************************************************** + * Description: Shared Memory object header file * + * Author: Mladen Turk <mturk@jboss.com> * + * Author: Rainer Jung <rjung@apache.org> * + * Version: $Revision: 893253 $ * + ***************************************************************************/ +#ifndef _JK_SHM_H +#define _JK_SHM_H + +#include "jk_global.h" +#include "jk_pool.h" +#include "jk_util.h" + +#ifdef __cplusplus +extern "C" +{ +#endif /* __cplusplus */ + +/** + * @file jk_shm.h + * @brief Jk shared memory management + * + * + */ + +#define JK_SHM_MAJOR '1' +#define JK_SHM_MINOR '3' +#define JK_SHM_STR_SIZ 63 +#define JK_SHM_URI_SIZ 127 +#define JK_SHM_DYNAMIC 16 +#define JK_SHM_MAGIC '!', 'J', 'K', 'S', 'H', 'M', JK_SHM_MAJOR, JK_SHM_MINOR +#define JK_SHM_MAGIC_SIZ 8 + +/* Really huge numbers, but 64 workers should be enough */ +#define JK_SHM_MAX_WORKERS 64 +#define JK_SHM_ALIGNMENT 64 +#define JK_SHM_ALIGN(x) JK_ALIGN((x), JK_SHM_ALIGNMENT) +#define JK_SHM_AJP_WORKER_SIZE JK_SHM_ALIGN(sizeof(jk_shm_ajp_worker_t)) +#define JK_SHM_LB_SUB_WORKER_SIZE JK_SHM_ALIGN(sizeof(jk_shm_lb_sub_worker_t)) +#define JK_SHM_LB_WORKER_SIZE JK_SHM_ALIGN(sizeof(jk_shm_lb_worker_t)) +#define JK_SHM_AJP_SIZE(x) ((x) * JK_SHM_AJP_WORKER_SIZE) +#define JK_SHM_LB_SUB_SIZE(x) ((x) * JK_SHM_LB_SUB_WORKER_SIZE) +#define JK_SHM_LB_SIZE(x) ((x) * JK_SHM_LB_WORKER_SIZE) +#define JK_SHM_DEF_SIZE JK_SHM_AJP_SIZE(JK_SHM_MAX_WORKERS) + JK_SHM_LB_SUB_SIZE(JK_SHM_MAX_WORKERS) + JK_SHM_LB_SIZE(JK_SHM_MAX_WORKERS) + +/** jk shm generic worker record structure */ +struct jk_shm_worker_header +{ + int id; + int type; + /* worker name */ + char name[JK_SHM_STR_SIZ+1]; + /* Sequence counter starting at 0 and increasing + * every time we change the config + */ + volatile unsigned int sequence; +}; +typedef struct jk_shm_worker_header jk_shm_worker_header_t; + +/** jk shm ajp13/ajp14 worker record structure */ +struct jk_shm_ajp_worker +{ + jk_shm_worker_header_t h; + char host[JK_SHM_STR_SIZ+1]; + int port; + volatile int addr_sequence; + + /* Configuration data mirrored from ajp_worker */ + int cache_timeout; + int connect_timeout; + int ping_timeout; + int reply_timeout; + int prepost_timeout; + unsigned int recovery_opts; + int retries; + int retry_interval; + unsigned int max_packet_size; + /* current error state (runtime) of the worker */ + volatile int state; + /* Statistical data */ + /* Number of currently connected channels */ + volatile int connected; + /* Number of currently busy channels */ + volatile int busy; + /* Maximum number of busy channels */ + volatile int max_busy; + volatile time_t error_time; + /* Number of bytes read from remote */ + volatile jk_uint64_t readed; + /* Number of bytes transferred to remote */ + volatile jk_uint64_t transferred; + /* Number of times the worker was used */ + volatile jk_uint64_t used; + /* Number of times the worker was used - snapshot during maintenance */ + volatile jk_uint64_t used_snapshot; + /* Number of non 200 responses */ + volatile jk_uint32_t errors; + /* Decayed number of reply_timeout errors */ + volatile jk_uint32_t reply_timeouts; + /* Number of client errors */ + volatile jk_uint32_t client_errors; + /* Last reset time */ + volatile time_t last_reset; + volatile time_t last_maintain_time; +}; +typedef struct jk_shm_ajp_worker jk_shm_ajp_worker_t; + +/** jk shm lb sub worker record structure */ +struct jk_shm_lb_sub_worker +{ + jk_shm_worker_header_t h; + + /* route */ + char route[JK_SHM_STR_SIZ+1]; + /* worker domain */ + char domain[JK_SHM_STR_SIZ+1]; + /* worker redirect route */ + char redirect[JK_SHM_STR_SIZ+1]; + /* Number of currently busy channels */ + volatile int busy; + /* worker distance */ + volatile int distance; + /* current activation state (config) of the worker */ + volatile int activation; + /* current error state (runtime) of the worker */ + volatile int state; + /* Current lb factor */ + volatile int lb_factor; + /* Current lb reciprocal factor */ + volatile jk_uint64_t lb_mult; + /* Current lb value */ + volatile jk_uint64_t lb_value; + /* Statistical data */ + volatile time_t error_time; + /* Number of times the worker was elected - snapshot during maintenance */ + volatile jk_uint64_t elected_snapshot; + /* Number of non 200 responses */ + volatile jk_uint32_t errors; +}; +typedef struct jk_shm_lb_sub_worker jk_shm_lb_sub_worker_t; + +/** jk shm lb worker record structure */ +struct jk_shm_lb_worker +{ + jk_shm_worker_header_t h; + + /* Number of currently busy channels */ + volatile int busy; + /* Maximum number of busy channels */ + volatile int max_busy; + int sticky_session; + int sticky_session_force; + int recover_wait_time; + int error_escalation_time; + int max_reply_timeouts; + int retries; + int retry_interval; + int lbmethod; + int lblock; + unsigned int max_packet_size; + /* Last reset time */ + volatile time_t last_reset; + volatile time_t last_maintain_time; + /* Session cookie */ + char session_cookie[JK_SHM_STR_SIZ+1]; + /* Session path */ + char session_path[JK_SHM_STR_SIZ+1]; + +}; +typedef struct jk_shm_lb_worker jk_shm_lb_worker_t; + +const char *jk_shm_name(void); + +/* Calculate needed shm size */ +size_t jk_shm_calculate_size(jk_map_t *init_data, jk_logger_t *l); + +/* Open the shared memory creating file if needed + */ +int jk_shm_open(const char *fname, size_t sz, jk_logger_t *l); + +/* Close the shared memory + */ +void jk_shm_close(void); + +/* Attach the shared memory in child process. + * File has to be opened in parent. + */ +int jk_shm_attach(const char *fname, size_t sz, jk_logger_t *l); + +/* allocate shm memory + * If there is no shm present the pool will be used instead + */ +void *jk_shm_alloc(jk_pool_t *p, size_t size); + +/* allocate shm ajp worker record + * If there is no shm present the pool will be used instead + */ +jk_shm_ajp_worker_t *jk_shm_alloc_ajp_worker(jk_pool_t *p); + +/* allocate shm lb sub worker record + * If there is no shm present the pool will be used instead + */ +jk_shm_lb_sub_worker_t *jk_shm_alloc_lb_sub_worker(jk_pool_t *p); + +/* allocate shm lb worker record + * If there is no shm present the pool will be used instead + */ +jk_shm_lb_worker_t *jk_shm_alloc_lb_worker(jk_pool_t *p); + +/* Return workers.properties last modified time + */ +time_t jk_shm_get_workers_time(void); + +/* Set workers.properties last modified time + */ +void jk_shm_set_workers_time(time_t t); + +/* Check if the shared memory has been modified + * by some other process. + */ +int jk_shm_is_modified(void); + +/* Synchronize access and modification time. + * This function should be called when the shared memory + * is modified and after we update the config acording + * to the current shared memory data. + */ +void jk_shm_sync_access_time(void); + + +/* Lock shared memory for thread safe access */ +int jk_shm_lock(void); + +/* Unlock shared memory for thread safe access */ +int jk_shm_unlock(void); + + +#ifdef __cplusplus +} +#endif /* __cplusplus */ +#endif /* _JK_SHM_H */ |