scoreboard.c revision 179a355e3801a2c2e0a895964cf39488bac3c9cc
b38846b15c8891c6dec44dcc4f96ca40721bf663rbb/* Copyright 2001-2005 The Apache Software Foundation or its licensors, as
b38846b15c8891c6dec44dcc4f96ca40721bf663rbb * applicable.
b38846b15c8891c6dec44dcc4f96ca40721bf663rbb * Licensed under the Apache License, Version 2.0 (the "License");
b38846b15c8891c6dec44dcc4f96ca40721bf663rbb * you may not use this file except in compliance with the License.
b38846b15c8891c6dec44dcc4f96ca40721bf663rbb * You may obtain a copy of the License at
b38846b15c8891c6dec44dcc4f96ca40721bf663rbb * Unless required by applicable law or agreed to in writing, software
b38846b15c8891c6dec44dcc4f96ca40721bf663rbb * distributed under the License is distributed on an "AS IS" BASIS,
b38846b15c8891c6dec44dcc4f96ca40721bf663rbb * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
b38846b15c8891c6dec44dcc4f96ca40721bf663rbb * See the License for the specific language governing permissions and
b38846b15c8891c6dec44dcc4f96ca40721bf663rbb * limitations under the License.
b38846b15c8891c6dec44dcc4f96ca40721bf663rbbstatic /* but must be exported to mpm_winnt */
b38846b15c8891c6dec44dcc4f96ca40721bf663rbb * This function should be renamed to cleanup_shared
b38846b15c8891c6dec44dcc4f96ca40721bf663rbb * and it should handle cleaning up a scoreboard shared
b38846b15c8891c6dec44dcc4f96ca40721bf663rbb * between processes using any form of IPC (file, shared memory
b38846b15c8891c6dec44dcc4f96ca40721bf663rbb * segment, etc.). Leave it as is now because it is being used
b38846b15c8891c6dec44dcc4f96ca40721bf663rbb * by various MPMs.
b38846b15c8891c6dec44dcc4f96ca40721bf663rbb ap_mpm_query(AP_MPMQ_HARD_LIMIT_THREADS, &thread_limit);
b38846b15c8891c6dec44dcc4f96ca40721bf663rbb ap_mpm_query(AP_MPMQ_HARD_LIMIT_DAEMONS, &server_limit);
b38846b15c8891c6dec44dcc4f96ca40721bf663rbb proxy_lb_workers = APR_RETRIEVE_OPTIONAL_FN(ap_proxy_lb_workers);
b38846b15c8891c6dec44dcc4f96ca40721bf663rbb scoreboard_size += sizeof(process_score) * server_limit;
b38846b15c8891c6dec44dcc4f96ca40721bf663rbb scoreboard_size += sizeof(worker_score) * server_limit * thread_limit;
b38846b15c8891c6dec44dcc4f96ca40721bf663rbb calloc(1, sizeof(scoreboard) + server_limit * sizeof(worker_score *) +
83a8dc5a596a8a1b9d14f063268287d123b9ed7ewrowe ap_scoreboard_image->global = (global_score *)more_storage;
83a8dc5a596a8a1b9d14f063268287d123b9ed7ewrowe ap_scoreboard_image->parent = (process_score *)more_storage;
83a8dc5a596a8a1b9d14f063268287d123b9ed7ewrowe (worker_score **)((char*)ap_scoreboard_image + sizeof(scoreboard));
83a8dc5a596a8a1b9d14f063268287d123b9ed7ewrowe for (i = 0; i < server_limit; i++) {
83a8dc5a596a8a1b9d14f063268287d123b9ed7ewrowe ap_scoreboard_image->servers[i] = (worker_score *)more_storage;
83a8dc5a596a8a1b9d14f063268287d123b9ed7ewrowe ap_scoreboard_image->balancers = (lb_score *)more_storage;
83a8dc5a596a8a1b9d14f063268287d123b9ed7ewrowe ap_assert(more_storage == (char*)shared_score + scoreboard_size);
83a8dc5a596a8a1b9d14f063268287d123b9ed7ewrowe ap_scoreboard_image->global->server_limit = server_limit;
83a8dc5a596a8a1b9d14f063268287d123b9ed7ewrowe ap_scoreboard_image->global->thread_limit = thread_limit;
83a8dc5a596a8a1b9d14f063268287d123b9ed7ewrowe * Create a name-based scoreboard in the given pool using the
83a8dc5a596a8a1b9d14f063268287d123b9ed7ewrowe * given filename.
83a8dc5a596a8a1b9d14f063268287d123b9ed7ewrowestatic apr_status_t create_namebased_scoreboard(apr_pool_t *pool,
83a8dc5a596a8a1b9d14f063268287d123b9ed7ewrowe const char *fname)
83a8dc5a596a8a1b9d14f063268287d123b9ed7ewrowe /* The shared memory file must not exist before we create the
83a8dc5a596a8a1b9d14f063268287d123b9ed7ewrowe * segment. */
83a8dc5a596a8a1b9d14f063268287d123b9ed7ewrowe rv = apr_shm_create(&ap_scoreboard_shm, scoreboard_size, fname, pool);
83a8dc5a596a8a1b9d14f063268287d123b9ed7ewrowe "unable to create scoreboard \"%s\" "
83a8dc5a596a8a1b9d14f063268287d123b9ed7ewrowe#endif /* APR_HAS_SHARED_MEMORY */
83a8dc5a596a8a1b9d14f063268287d123b9ed7ewrowe/* ToDo: This function should be made to handle setting up
83a8dc5a596a8a1b9d14f063268287d123b9ed7ewrowe * a scoreboard shared between processes using any IPC technique,
83a8dc5a596a8a1b9d14f063268287d123b9ed7ewrowe * not just a shared memory segment
83a8dc5a596a8a1b9d14f063268287d123b9ed7ewrowe /* We don't want to have to recreate the scoreboard after
83a8dc5a596a8a1b9d14f063268287d123b9ed7ewrowe * restarts, so we'll create a global pool and never clean it.
83a8dc5a596a8a1b9d14f063268287d123b9ed7ewrowe "Fatal error: unable to create global pool "
83a8dc5a596a8a1b9d14f063268287d123b9ed7ewrowe "for use with by the scoreboard");
83a8dc5a596a8a1b9d14f063268287d123b9ed7ewrowe /* The config says to create a name-based shmem */
83a8dc5a596a8a1b9d14f063268287d123b9ed7ewrowe /* make sure it's an absolute pathname */
83a8dc5a596a8a1b9d14f063268287d123b9ed7ewrowe fname = ap_server_root_relative(pconf, ap_scoreboard_fname);
83a8dc5a596a8a1b9d14f063268287d123b9ed7ewrowe ap_log_error(APLOG_MARK, APLOG_CRIT, APR_EBADPATH, NULL,
83a8dc5a596a8a1b9d14f063268287d123b9ed7ewrowe "Fatal error: Invalid Scoreboard path %s",
83a8dc5a596a8a1b9d14f063268287d123b9ed7ewrowe return create_namebased_scoreboard(global_pool, fname);
83a8dc5a596a8a1b9d14f063268287d123b9ed7ewrowe else { /* config didn't specify, we get to choose shmem type */
83a8dc5a596a8a1b9d14f063268287d123b9ed7ewrowe rv = apr_shm_create(&ap_scoreboard_shm, scoreboard_size, NULL,
83a8dc5a596a8a1b9d14f063268287d123b9ed7ewrowe "Unable to create scoreboard "
83a8dc5a596a8a1b9d14f063268287d123b9ed7ewrowe "(anonymous shared memory failure)");
83a8dc5a596a8a1b9d14f063268287d123b9ed7ewrowe /* Make up a filename and do name-based shmem */
83a8dc5a596a8a1b9d14f063268287d123b9ed7ewrowe /* Make sure it's an absolute pathname */
83a8dc5a596a8a1b9d14f063268287d123b9ed7ewrowe fname = ap_server_root_relative(pconf, ap_scoreboard_fname);
83a8dc5a596a8a1b9d14f063268287d123b9ed7ewrowe return create_namebased_scoreboard(global_pool, fname);
83a8dc5a596a8a1b9d14f063268287d123b9ed7ewrowe#endif /* APR_HAS_SHARED_MEMORY */
83a8dc5a596a8a1b9d14f063268287d123b9ed7ewrowe/* If detach is non-zero, this is a seperate child process,
83a8dc5a596a8a1b9d14f063268287d123b9ed7ewrowe * if zero, it is a forked child.
83a8dc5a596a8a1b9d14f063268287d123b9ed7ewroweapr_status_t ap_reopen_scoreboard(apr_pool_t *p, apr_shm_t **shm, int detached)
83a8dc5a596a8a1b9d14f063268287d123b9ed7ewrowe if (apr_shm_size_get(ap_scoreboard_shm) < scoreboard_size) {
83a8dc5a596a8a1b9d14f063268287d123b9ed7ewrowe "Fatal error: shared scoreboard too small for child!");
83a8dc5a596a8a1b9d14f063268287d123b9ed7ewrowe /* everything will be cleared shortly */
b38846b15c8891c6dec44dcc4f96ca40721bf663rbb if (ap_scoreboard_image->global->sb_type == SB_SHARED) {
b38846b15c8891c6dec44dcc4f96ca40721bf663rbb/* Create or reinit an existing scoreboard. The MPM can control whether
b38846b15c8891c6dec44dcc4f96ca40721bf663rbb * the scoreboard is shared across multiple processes or not
b38846b15c8891c6dec44dcc4f96ca40721bf663rbbint ap_create_scoreboard(apr_pool_t *p, ap_scoreboard_e sb_type)
b38846b15c8891c6dec44dcc4f96ca40721bf663rbb running_gen = ap_scoreboard_image->global->running_generation;
b38846b15c8891c6dec44dcc4f96ca40721bf663rbb ap_scoreboard_image->global->restart_time = apr_time_now();
b38846b15c8891c6dec44dcc4f96ca40721bf663rbb for (i = 0; i < server_limit; i++) {
290ecc1ddceca1ed49bc1a5338921264b5c3e07cwrowe /* Clean up the lb workers data */
290ecc1ddceca1ed49bc1a5338921264b5c3e07cwrowe if (rv || !(sb_shared = apr_shm_baseaddr_get(ap_scoreboard_shm))) {
2f1949bb0e3c209db94c8d521cba7380b9d11421trawick /* A simple malloc will suffice */
290ecc1ddceca1ed49bc1a5338921264b5c3e07cwrowe "(%d)%s: cannot allocate scoreboard",
290ecc1ddceca1ed49bc1a5338921264b5c3e07cwrowe ap_scoreboard_image->global->running_generation = running_gen;
290ecc1ddceca1ed49bc1a5338921264b5c3e07cwrowe ap_scoreboard_image->global->restart_time = apr_time_now();
290ecc1ddceca1ed49bc1a5338921264b5c3e07cwrowe apr_pool_cleanup_register(p, NULL, ap_cleanup_scoreboard, apr_pool_cleanup_null);
290ecc1ddceca1ed49bc1a5338921264b5c3e07cwrowe/* Routines called to deal with the scoreboard image
290ecc1ddceca1ed49bc1a5338921264b5c3e07cwrowe * --- note that we do *not* need write locks, since update_child_status
290ecc1ddceca1ed49bc1a5338921264b5c3e07cwrowe * only updates a *single* record in place, and only one process writes to
290ecc1ddceca1ed49bc1a5338921264b5c3e07cwrowe * a given scoreboard slot at a time (either the child process owning that
c6ed63d53853f79bf8265c434d2e25c9db8a7fd8trawick * slot, or the parent, noting that the child has died).
8aefbd756763807188d2e3ce336a8680e4893066wrowe * As a final note --- setting the score entry to getpid() is always safe,
8aefbd756763807188d2e3ce336a8680e4893066wrowe * since when the parent is writing an entry, it's only noting SERVER_DEAD
b38846b15c8891c6dec44dcc4f96ca40721bf663rbbAP_DECLARE(void) ap_increment_counts(ap_sb_handle_t *sb, request_rec *r)
b38846b15c8891c6dec44dcc4f96ca40721bf663rbb ws = &ap_scoreboard_image->servers[sb->child_num][sb->thread_num];
b38846b15c8891c6dec44dcc4f96ca40721bf663rbb for (i = 0; i < max_daemons_limit; ++i) {
b38846b15c8891c6dec44dcc4f96ca40721bf663rbb return -1;
b38846b15c8891c6dec44dcc4f96ca40721bf663rbbAP_DECLARE(void) ap_create_sb_handle(ap_sb_handle_t **new_sbh, apr_pool_t *p,
b38846b15c8891c6dec44dcc4f96ca40721bf663rbb *new_sbh = (ap_sb_handle_t *)apr_palloc(p, sizeof(ap_sb_handle_t));
b38846b15c8891c6dec44dcc4f96ca40721bf663rbbAP_DECLARE(int) ap_update_child_status_from_indexes(int child_num,
b38846b15c8891c6dec44dcc4f96ca40721bf663rbb return -1;
b38846b15c8891c6dec44dcc4f96ca40721bf663rbb ws = &ap_scoreboard_image->servers[child_num][thread_num];
4ca6cbe768b4e0917ac0b76333c26a7d5396d454trawick * Reset individual counters
b38846b15c8891c6dec44dcc4f96ca40721bf663rbb apr_cpystrn(ws->client, ap_get_remote_host(c, r->per_dir_config,
b38846b15c8891c6dec44dcc4f96ca40721bf663rbb apr_cpystrn(ws->request, r->the_request, sizeof(ws->request));
b38846b15c8891c6dec44dcc4f96ca40721bf663rbb /* Don't reveal the password in the server-status view */
b38846b15c8891c6dec44dcc4f96ca40721bf663rbb apr_cpystrn(ws->request, apr_pstrcat(r->pool, r->method, " ",
b38846b15c8891c6dec44dcc4f96ca40721bf663rbbAP_DECLARE(int) ap_update_child_status(ap_sb_handle_t *sbh, int status,
b38846b15c8891c6dec44dcc4f96ca40721bf663rbb return ap_update_child_status_from_indexes(sbh->child_num, sbh->thread_num,
b38846b15c8891c6dec44dcc4f96ca40721bf663rbbvoid ap_time_process_request(ap_sb_handle_t *sbh, int status)
b38846b15c8891c6dec44dcc4f96ca40721bf663rbb ws = &ap_scoreboard_image->servers[sbh->child_num][sbh->thread_num];
b38846b15c8891c6dec44dcc4f96ca40721bf663rbbAP_DECLARE(worker_score *) ap_get_scoreboard_worker(int x, int y)
b38846b15c8891c6dec44dcc4f96ca40721bf663rbb if (((x < 0) || (server_limit < x)) ||
b38846b15c8891c6dec44dcc4f96ca40721bf663rbb ((y < 0) || (thread_limit < y))) {
b38846b15c8891c6dec44dcc4f96ca40721bf663rbbAP_DECLARE(process_score *) ap_get_scoreboard_process(int x)
b38846b15c8891c6dec44dcc4f96ca40721bf663rbb if ((x < 0) || (server_limit < x)) {