httpd/server/scoreboard.c

	scoreboard.c revision 36b0d7bc1117c55c6891ad74a2210a817eb12234
0ad489b182ebb3789322345e22cf750f88ae167and/* ====================================================================
0ad489b182ebb3789322345e22cf750f88ae167and * The Apache Software License, Version 1.1
0ad489b182ebb3789322345e22cf750f88ae167and *
15b0d99a66145e797cbe368bff5e44d5653be5e5nd * Copyright (c) 2000 The Apache Software Foundation.  All rights
0ad489b182ebb3789322345e22cf750f88ae167and * reserved.
0ad489b182ebb3789322345e22cf750f88ae167and *
031b91a62d25106ae69d4693475c79618dd5e884fielding * Redistribution and use in source and binary forms, with or without
031b91a62d25106ae69d4693475c79618dd5e884fielding * modification, are permitted provided that the following conditions
031b91a62d25106ae69d4693475c79618dd5e884fielding * are met:
031b91a62d25106ae69d4693475c79618dd5e884fielding *
031b91a62d25106ae69d4693475c79618dd5e884fielding * 1. Redistributions of source code must retain the above copyright
031b91a62d25106ae69d4693475c79618dd5e884fielding *    notice, this list of conditions and the following disclaimer.
0ad489b182ebb3789322345e22cf750f88ae167and *
0ad489b182ebb3789322345e22cf750f88ae167and * 2. Redistributions in binary form must reproduce the above copyright
0ad489b182ebb3789322345e22cf750f88ae167and *    notice, this list of conditions and the following disclaimer in
0ad489b182ebb3789322345e22cf750f88ae167and *    the documentation and/or other materials provided with the
0ad489b182ebb3789322345e22cf750f88ae167and *    distribution.
0ad489b182ebb3789322345e22cf750f88ae167and *
0ad489b182ebb3789322345e22cf750f88ae167and * 3. The end-user documentation included with the redistribution,
0ad489b182ebb3789322345e22cf750f88ae167and *    if any, must include the following acknowledgment:
0ad489b182ebb3789322345e22cf750f88ae167and *       "This product includes software developed by the
0ad489b182ebb3789322345e22cf750f88ae167and *        Apache Software Foundation (http://www.apache.org/)."
0ad489b182ebb3789322345e22cf750f88ae167and *    Alternately, this acknowledgment may appear in the software itself,
0ad489b182ebb3789322345e22cf750f88ae167and *    if and wherever such third-party acknowledgments normally appear.
0ad489b182ebb3789322345e22cf750f88ae167and *
0ad489b182ebb3789322345e22cf750f88ae167and * 4. The names "Apache" and "Apache Software Foundation" must
0ad489b182ebb3789322345e22cf750f88ae167and *    not be used to endorse or promote products derived from this
0ad489b182ebb3789322345e22cf750f88ae167and *    software without prior written permission. For written
0ad489b182ebb3789322345e22cf750f88ae167and *    permission, please contact apache@apache.org.
0ad489b182ebb3789322345e22cf750f88ae167and *
0ad489b182ebb3789322345e22cf750f88ae167and * 5. Products derived from this software may not be called "Apache",
0ad489b182ebb3789322345e22cf750f88ae167and *    nor may "Apache" appear in their name, without prior written
0ad489b182ebb3789322345e22cf750f88ae167and *    permission of the Apache Software Foundation.
0ad489b182ebb3789322345e22cf750f88ae167and *
0ad489b182ebb3789322345e22cf750f88ae167and * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
0ad489b182ebb3789322345e22cf750f88ae167and * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
0ad489b182ebb3789322345e22cf750f88ae167and * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
0ad489b182ebb3789322345e22cf750f88ae167and * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
0ad489b182ebb3789322345e22cf750f88ae167and * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
0ad489b182ebb3789322345e22cf750f88ae167and * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
0ad489b182ebb3789322345e22cf750f88ae167and * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
0ad489b182ebb3789322345e22cf750f88ae167and * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
0ad489b182ebb3789322345e22cf750f88ae167and * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
0ad489b182ebb3789322345e22cf750f88ae167and * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
0ad489b182ebb3789322345e22cf750f88ae167and * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
0ad489b182ebb3789322345e22cf750f88ae167and * SUCH DAMAGE.
0ad489b182ebb3789322345e22cf750f88ae167and * ====================================================================
0ad489b182ebb3789322345e22cf750f88ae167and *
0ad489b182ebb3789322345e22cf750f88ae167and * This software consists of voluntary contributions made by many
0ad489b182ebb3789322345e22cf750f88ae167and * individuals on behalf of the Apache Software Foundation.  For more
0ad489b182ebb3789322345e22cf750f88ae167and * information on the Apache Software Foundation, please see
0ad489b182ebb3789322345e22cf750f88ae167and * <http://www.apache.org/>.
0ad489b182ebb3789322345e22cf750f88ae167and *
0ad489b182ebb3789322345e22cf750f88ae167and * Portions of this software are based upon public domain software
0ad489b182ebb3789322345e22cf750f88ae167and * originally written at the National Center for Supercomputing Applications,
0ad489b182ebb3789322345e22cf750f88ae167and * University of Illinois, Urbana-Champaign.
0ad489b182ebb3789322345e22cf750f88ae167and */
0ad489b182ebb3789322345e22cf750f88ae167and
0ad489b182ebb3789322345e22cf750f88ae167and#include "apr_strings.h"
0ad489b182ebb3789322345e22cf750f88ae167and#include "apr_portable.h"
0ad489b182ebb3789322345e22cf750f88ae167and#include "ap_config.h"
0ad489b182ebb3789322345e22cf750f88ae167and#include "httpd.h"
0ad489b182ebb3789322345e22cf750f88ae167and#include "http_log.h"
0ad489b182ebb3789322345e22cf750f88ae167and#include "http_main.h"
0ad489b182ebb3789322345e22cf750f88ae167and#include "http_core.h"
0ad489b182ebb3789322345e22cf750f88ae167and#include "http_config.h"
0ad489b182ebb3789322345e22cf750f88ae167and/* ToDo: Fix this right */
0ad489b182ebb3789322345e22cf750f88ae167and#ifndef WIN32
0ad489b182ebb3789322345e22cf750f88ae167and#include "unixd.h"
0ad489b182ebb3789322345e22cf750f88ae167and#endif
0ad489b182ebb3789322345e22cf750f88ae167and
0ad489b182ebb3789322345e22cf750f88ae167and#include "http_conf_globals.h"
0ad489b182ebb3789322345e22cf750f88ae167and#include "mpm.h"
0ad489b182ebb3789322345e22cf750f88ae167and#include "scoreboard.h"
0ad489b182ebb3789322345e22cf750f88ae167and#ifdef HAVE_SYS_TYPES_H
0ad489b182ebb3789322345e22cf750f88ae167and#include <sys/types.h>
0ad489b182ebb3789322345e22cf750f88ae167and#endif
0ad489b182ebb3789322345e22cf750f88ae167and
0ad489b182ebb3789322345e22cf750f88ae167andAP_DECLARE_DATA scoreboard *ap_scoreboard_image = NULL;
0ad489b182ebb3789322345e22cf750f88ae167andAP_DECLARE_DATA const char *ap_scoreboard_fname=NULL;
0ad489b182ebb3789322345e22cf750f88ae167andAP_DECLARE_DATA int ap_extended_status = 0;
0ad489b182ebb3789322345e22cf750f88ae167andAP_DECLARE_DATA apr_time_t ap_restart_time = 0;
0ad489b182ebb3789322345e22cf750f88ae167and
0ad489b182ebb3789322345e22cf750f88ae167and#if APR_HAS_SHARED_MEMORY
0ad489b182ebb3789322345e22cf750f88ae167and#include "apr_shmem.h"
0ad489b182ebb3789322345e22cf750f88ae167andstatic apr_shmem_t *scoreboard_shm = NULL;
0ad489b182ebb3789322345e22cf750f88ae167and#endif
0ad489b182ebb3789322345e22cf750f88ae167and/*
0ad489b182ebb3789322345e22cf750f88ae167and * ToDo:
0ad489b182ebb3789322345e22cf750f88ae167and * This function should be renamed to cleanup_shared
0ad489b182ebb3789322345e22cf750f88ae167and * and it should handle cleaning up a scoreboard shared
0ad489b182ebb3789322345e22cf750f88ae167and * between processes using any form of IPC (file, shared memory
0ad489b182ebb3789322345e22cf750f88ae167and * segment, etc.). Leave it as is now because it is being used
0ad489b182ebb3789322345e22cf750f88ae167and * by various MPMs.
0ad489b182ebb3789322345e22cf750f88ae167and */
0ad489b182ebb3789322345e22cf750f88ae167andapr_status_t ap_cleanup_shared_mem(void *d)
0ad489b182ebb3789322345e22cf750f88ae167and{
0ad489b182ebb3789322345e22cf750f88ae167and#if APR_HAS_SHARED_MEMORY
0ad489b182ebb3789322345e22cf750f88ae167and    apr_shm_free(scoreboard_shm, ap_scoreboard_image);
0ad489b182ebb3789322345e22cf750f88ae167and    ap_scoreboard_image = NULL;
0ad489b182ebb3789322345e22cf750f88ae167and    apr_shm_destroy(scoreboard_shm);
0ad489b182ebb3789322345e22cf750f88ae167and#endif
0ad489b182ebb3789322345e22cf750f88ae167and    return APR_SUCCESS;
0ad489b182ebb3789322345e22cf750f88ae167and}
0ad489b182ebb3789322345e22cf750f88ae167and
0ad489b182ebb3789322345e22cf750f88ae167and/* ToDo: This function should be made to handle setting up
0ad489b182ebb3789322345e22cf750f88ae167and * a scoreboard shared between processes using any IPC technique,
0ad489b182ebb3789322345e22cf750f88ae167and * not just a shared memory segment
0ad489b182ebb3789322345e22cf750f88ae167and */
0ad489b182ebb3789322345e22cf750f88ae167andstatic void setup_shared(apr_pool_t *p)
0ad489b182ebb3789322345e22cf750f88ae167and{
0ad489b182ebb3789322345e22cf750f88ae167and#if APR_HAS_SHARED_MEMORY
0ad489b182ebb3789322345e22cf750f88ae167and    char buf[512];
0ad489b182ebb3789322345e22cf750f88ae167and    char errmsg[120];
0ad489b182ebb3789322345e22cf750f88ae167and    const char *fname;
0ad489b182ebb3789322345e22cf750f88ae167and    apr_status_t rv;
0ad489b182ebb3789322345e22cf750f88ae167and
0ad489b182ebb3789322345e22cf750f88ae167and    fname = ap_server_root_relative(p, ap_scoreboard_fname);
0ad489b182ebb3789322345e22cf750f88ae167and    rv = apr_shm_init(&scoreboard_shm, SCOREBOARD_SIZE, fname, p);
0ad489b182ebb3789322345e22cf750f88ae167and    if (rv != APR_SUCCESS) {
0ad489b182ebb3789322345e22cf750f88ae167and        apr_snprintf(buf, sizeof(buf), "%s: could not open(create) scoreboard: %s",
0ad489b182ebb3789322345e22cf750f88ae167and                    ap_server_argv0, apr_strerror(rv, errmsg, sizeof errmsg));
0ad489b182ebb3789322345e22cf750f88ae167and        fprintf(stderr, "%s\n", buf);
0ad489b182ebb3789322345e22cf750f88ae167and        exit(APEXIT_INIT);
0ad489b182ebb3789322345e22cf750f88ae167and    }
0ad489b182ebb3789322345e22cf750f88ae167and    ap_scoreboard_image = apr_shm_malloc(scoreboard_shm, SCOREBOARD_SIZE);
0ad489b182ebb3789322345e22cf750f88ae167and    if (ap_scoreboard_image == NULL) {
0ad489b182ebb3789322345e22cf750f88ae167and        apr_snprintf(buf, sizeof(buf), "%s: cannot allocate scoreboard",
0ad489b182ebb3789322345e22cf750f88ae167and                    ap_server_argv0);
0ad489b182ebb3789322345e22cf750f88ae167and        perror(buf); /* o.k. since MM sets errno */
0ad489b182ebb3789322345e22cf750f88ae167and        apr_shm_destroy(scoreboard_shm);
0ad489b182ebb3789322345e22cf750f88ae167and        exit(APEXIT_INIT);
0ad489b182ebb3789322345e22cf750f88ae167and    }
0ad489b182ebb3789322345e22cf750f88ae167and    ap_scoreboard_image->global.running_generation = 0;
0ad489b182ebb3789322345e22cf750f88ae167and#endif
0ad489b182ebb3789322345e22cf750f88ae167and}
0ad489b182ebb3789322345e22cf750f88ae167and
0ad489b182ebb3789322345e22cf750f88ae167andAP_DECLARE(void) reopen_scoreboard(apr_pool_t *p)
0ad489b182ebb3789322345e22cf750f88ae167and{
0ad489b182ebb3789322345e22cf750f88ae167and}
0ad489b182ebb3789322345e22cf750f88ae167and
0ad489b182ebb3789322345e22cf750f88ae167and/* ap_cleanup_scoreboard
0ad489b182ebb3789322345e22cf750f88ae167and *
0ad489b182ebb3789322345e22cf750f88ae167and */
0ad489b182ebb3789322345e22cf750f88ae167andstatic void ap_cleanup_scoreboard(void *d) {
0ad489b182ebb3789322345e22cf750f88ae167and    if (ap_scoreboard_image == NULL)
0ad489b182ebb3789322345e22cf750f88ae167and        return;
0ad489b182ebb3789322345e22cf750f88ae167and    if (ap_scoreboard_image->global.sb_type == SB_SHARED) {
0ad489b182ebb3789322345e22cf750f88ae167and        ap_cleanup_shared_mem(NULL);
0ad489b182ebb3789322345e22cf750f88ae167and    }
0ad489b182ebb3789322345e22cf750f88ae167and    else {
0ad489b182ebb3789322345e22cf750f88ae167and        free(ap_scoreboard_image);
0ad489b182ebb3789322345e22cf750f88ae167and        ap_scoreboard_image = NULL;
    }
}

/* ap_create_scoreboard(apr_pool_t*, ap_scoreboard_e t)
 *
 * Create or reinit an existing scoreboard. The MPM can control whether
 * the scoreboard is shared across multiple processes or not
 */
AP_DECLARE(void) ap_create_scoreboard(apr_pool_t *p, ap_scoreboard_e sb_type)
{
    int running_gen = 0;
    if (ap_scoreboard_image)
    running_gen = ap_scoreboard_image->global.running_generation;
    if (ap_scoreboard_image == NULL) {
        if (sb_type == SB_SHARED) {
            setup_shared(p);
            ap_scoreboard_image->global.sb_type = SB_SHARED;
        }
        else {
            /* A simple malloc will suffice */
            char buf[512];
            ap_scoreboard_image = (scoreboard *) malloc(SCOREBOARD_SIZE);
            if (ap_scoreboard_image == NULL) {
                apr_snprintf(buf, sizeof(buf), "%s: cannot allocate scoreboard",
                             ap_server_argv0);
                perror(buf); /* o.k. since MM sets errno */
                exit(APEXIT_INIT);
            }
            ap_scoreboard_image->global.sb_type = SB_NOT_SHARED;
        }
    }
    memset(ap_scoreboard_image, 0, SCOREBOARD_SIZE);
    ap_scoreboard_image->global.running_generation = running_gen;
    apr_register_cleanup(p, NULL, ap_cleanup_scoreboard, apr_null_cleanup);
}

/* ToDo:
 * reinit_scoreboard should be eliminated when all MPMs migrate to
 * ap_create_scoreboard()
 */
void reinit_scoreboard(apr_pool_t *p)
{
    ap_create_scoreboard(p, SB_SHARED);
}

/* Routines called to deal with the scoreboard image
 * --- note that we do *not* need write locks, since update_child_status
 * only updates a *single* record in place, and only one process writes to
 * a given scoreboard slot at a time (either the child process owning that
 * slot, or the parent, noting that the child has died).
 *
 * As a final note --- setting the score entry to getpid() is always safe,
 * since when the parent is writing an entry, it's only noting SERVER_DEAD
 * anyway.
 */

void ap_sync_scoreboard_image(void)
{
}

AP_DECLARE(int) ap_exists_scoreboard_image(void)
{
    return (ap_scoreboard_image ? 1 : 0);
}

static apr_inline void put_scoreboard_info(int child_num, int thread_num,
                       short_score *new_score_rec)
{
    /* XXX - needs to be fixed to account for threads */
#ifdef SCOREBOARD_FILE
    lseek(scoreboard_fd, (long) child_num * sizeof(short_score), 0);
    force_write(scoreboard_fd, new_score_rec, sizeof(short_score));
#endif
}

void update_scoreboard_global(void)
{
#ifdef SCOREBOARD_FILE
    lseek(scoreboard_fd,
      (char *) &ap_scoreboard_image->global -(char *) ap_scoreboard_image, 0);
    force_write(scoreboard_fd, &ap_scoreboard_image->global,
        sizeof ap_scoreboard_image->global);
#endif
}

void increment_counts(int child_num, int thread_num, request_rec *r)
{
    short_score *ss;

    ss = &ap_scoreboard_image->servers[child_num][thread_num];

#ifdef HAVE_TIMES
    times(&ss->times);
#endif
    ss->access_count++;
    ss->my_access_count++;
    ss->conn_count++;
    ss->bytes_served += r->bytes_sent;
    ss->my_bytes_served += r->bytes_sent;
    ss->conn_bytes += r->bytes_sent;

    put_scoreboard_info(child_num, thread_num, ss);
}

AP_DECLARE(int) find_child_by_pid(apr_proc_t *pid)
{
    int i;
    int max_daemons_limit = ap_get_max_daemons();

    for (i = 0; i < max_daemons_limit; ++i)
    if (ap_scoreboard_image->parent[i].pid == pid->pid)
        return i;

    return -1;
}

int ap_update_child_status(int child_num, int thread_num, int status, request_rec *r)
{
    int old_status;
    short_score *ss;
    parent_score *ps;

    if (child_num < 0)
    return -1;

    ss = &ap_scoreboard_image->servers[child_num][thread_num];
    old_status = ss->status;
    ss->status = status;

    ps = &ap_scoreboard_image->parent[child_num];

    if ((status == SERVER_READY  || status == SERVER_ACCEPTING)
    && old_status == SERVER_STARTING) {
        ss->thread_num = child_num * HARD_SERVER_LIMIT + thread_num;
    ps->worker_threads = ap_threads_per_child;
    }

    if (ap_extended_status) {
    if (status == SERVER_READY || status == SERVER_DEAD) {
        /*
         * Reset individual counters
         */
        if (status == SERVER_DEAD) {
        ss->my_access_count = 0L;
        ss->my_bytes_served = 0L;
        }
        ss->conn_count = (unsigned short) 0;
        ss->conn_bytes = (unsigned long) 0;
    }
    if (r) {
        conn_rec *c = r->connection;
        apr_cpystrn(ss->client, ap_get_remote_host(c, r->per_dir_config,
                  REMOTE_NOLOOKUP), sizeof(ss->client));
        if (r->the_request == NULL) {
            apr_cpystrn(ss->request, "NULL", sizeof(ss->request));
        } else if (r->parsed_uri.password == NULL) {
            apr_cpystrn(ss->request, r->the_request, sizeof(ss->request));
        } else {
        /* Don't reveal the password in the server-status view */
            apr_cpystrn(ss->request, apr_pstrcat(r->pool, r->method, " ",
                           ap_unparse_uri_components(r->pool, &r->parsed_uri, UNP_OMITPASSWORD),
                           r->assbackwards ? NULL : " ", r->protocol, NULL),
                       sizeof(ss->request));
        }
        ss->vhostrec =  r->server;
    }
    }

    put_scoreboard_info(child_num, thread_num, ss);
    return old_status;
}

void ap_time_process_request(int child_num, int thread_num, int status)
{
    short_score *ss;

    if (child_num < 0)
    return;

    ss = &ap_scoreboard_image->servers[child_num][thread_num];

    if (status == START_PREQUEST) {
        ss->start_time = apr_now();
    }
    else if (status == STOP_PREQUEST) {
        ss->stop_time = apr_now();
    }
    put_scoreboard_info(child_num, thread_num, ss);
}