scoreboard.h revision 26dfa083a1662d57ba7cc410eec4e0696b9be469
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte/* ====================================================================
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * The Apache Software License, Version 1.1
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte *
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * Copyright (c) 2000-2001 The Apache Software Foundation. All rights
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * reserved.
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte *
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * Redistribution and use in source and binary forms, with or without
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * modification, are permitted provided that the following conditions
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * are met:
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte *
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * 1. Redistributions of source code must retain the above copyright
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * notice, this list of conditions and the following disclaimer.
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte *
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * 2. Redistributions in binary form must reproduce the above copyright
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * notice, this list of conditions and the following disclaimer in
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * the documentation and/or other materials provided with the
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * distribution.
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte *
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * 3. The end-user documentation included with the redistribution,
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * if any, must include the following acknowledgment:
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * "This product includes software developed by the
cd3e933325e68e23516a196a8fea7f49b1e497c3Ali Bahrami * Apache Software Foundation (http://www.apache.org/)."
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * Alternately, this acknowledgment may appear in the software itself,
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * if and wherever such third-party acknowledgments normally appear.
bfed486ad8de8b8ebc6345a8e10accae08bf2f45Ali Bahrami *
bfed486ad8de8b8ebc6345a8e10accae08bf2f45Ali Bahrami * 4. The names "Apache" and "Apache Software Foundation" must
bfed486ad8de8b8ebc6345a8e10accae08bf2f45Ali Bahrami * not be used to endorse or promote products derived from this
bfed486ad8de8b8ebc6345a8e10accae08bf2f45Ali Bahrami * software without prior written permission. For written
bfed486ad8de8b8ebc6345a8e10accae08bf2f45Ali Bahrami * permission, please contact apache@apache.org.
bfed486ad8de8b8ebc6345a8e10accae08bf2f45Ali Bahrami *
bfed486ad8de8b8ebc6345a8e10accae08bf2f45Ali Bahrami * 5. Products derived from this software may not be called "Apache",
bfed486ad8de8b8ebc6345a8e10accae08bf2f45Ali Bahrami * nor may "Apache" appear in their name, without prior written
bfed486ad8de8b8ebc6345a8e10accae08bf2f45Ali Bahrami * permission of the Apache Software Foundation.
bfed486ad8de8b8ebc6345a8e10accae08bf2f45Ali Bahrami *
bfed486ad8de8b8ebc6345a8e10accae08bf2f45Ali Bahrami * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
bfed486ad8de8b8ebc6345a8e10accae08bf2f45Ali Bahrami * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
bfed486ad8de8b8ebc6345a8e10accae08bf2f45Ali Bahrami * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
bfed486ad8de8b8ebc6345a8e10accae08bf2f45Ali Bahrami * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
cd3e933325e68e23516a196a8fea7f49b1e497c3Ali Bahrami * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
cd3e933325e68e23516a196a8fea7f49b1e497c3Ali Bahrami * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
cd3e933325e68e23516a196a8fea7f49b1e497c3Ali Bahrami * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * SUCH DAMAGE.
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * ====================================================================
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte *
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * This software consists of voluntary contributions made by many
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * individuals on behalf of the Apache Software Foundation. For more
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * information on the Apache Software Foundation, please see
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * <http://www.apache.org/>.
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte *
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * Portions of this software are based upon public domain software
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * originally written at the National Center for Supercomputing Applications,
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * University of Illinois, Urbana-Champaign.
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte */
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte#ifndef APACHE_SCOREBOARD_H
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte#define APACHE_SCOREBOARD_H
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte#ifdef __cplusplus
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forteextern "C" {
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte#endif
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte#ifdef HAVE_SYS_TIMES_H
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte#include <sys/time.h>
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte#include <sys/times.h>
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte#elif defined(TPF)
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte#include <time.h>
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte#endif
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte#include "ap_config.h"
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte#include "apr_hooks.h"
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte#include "apr_thread_proc.h"
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte#include "apr_portable.h"
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte/* Scoreboard info on a process is, for now, kept very brief ---
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * just status value and pid (the latter so that the caretaker process
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * can properly update the scoreboard when a process dies). We may want
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * to eventually add a separate set of long_score structures which would
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * give, for each process, the number of requests serviced, and info on
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * the current, or most recent, request.
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte *
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * Status values:
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte */
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte#define SERVER_DEAD 0
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte#define SERVER_STARTING 1 /* Server Starting up */
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte#define SERVER_READY 2 /* Waiting for connection (or accept() lock) */
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte#define SERVER_BUSY_READ 3 /* Reading a client request */
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte#define SERVER_BUSY_WRITE 4 /* Processing a client request */
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte#define SERVER_BUSY_KEEPALIVE 5 /* Waiting for more requests via keepalive */
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte#define SERVER_BUSY_LOG 6 /* Logging the request */
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte#define SERVER_BUSY_DNS 7 /* Looking up a hostname */
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte#define SERVER_CLOSING 8 /* Closing the connection */
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte#define SERVER_GRACEFUL 9 /* server is gracefully finishing request */
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte#define SERVER_IDLE_KILL 10 /* Server is cleaning up idle children. */
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte#define SERVER_NUM_STATUS 11 /* number of status settings */
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte/* Type used for generation indicies. Startup and every restart cause a
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * new generation of children to be spawned. Children within the same
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * generation share the same configuration information -- pointers to stuff
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * created at config time in the parent are valid across children. However,
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * this can't work effectively with non-forked architectures. So while the
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * arrays in the scoreboard never change between the parent and forked
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * children, so they do not require shm storage, the contents of the shm
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte * may contain no pointers.
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte */
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Fortetypedef int ap_generation_t;
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte/* Is the scoreboard shared between processes or not?
a79493184c9332129c9c91500069322f6f3fafddReed * Set by the MPM when the scoreboard is created.
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte */
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Fortetypedef enum {
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte SB_NOT_SHARED = 1,
fcf3ce441efd61da9bb2884968af01cb7c1452ccJohn Forte SB_SHARED = 2, /* PARENT */
SB_SHARED_CHILD = 3
} ap_scoreboard_e;
#define SB_WORKING 0 /* The server is busy and the child is useful. */
#define SB_IDLE_DIE 1 /* The server is idle and the child is superfluous. */
/* The child should check for this and exit gracefully. */
/* stuff which is worker specific */
/***********************WARNING***************************************/
/* These are things that are used by mod_status. Do not put anything */
/* in here that you cannot live without. This structure will not */
/* be available if mod_status is not loaded. */
/*********************************************************************/
typedef struct worker_score worker_score;
struct worker_score {
int thread_num;
#if APR_HAS_THREADS
apr_os_thread_t tid;
#endif
unsigned char status;
unsigned long access_count;
apr_off_t bytes_served;
unsigned long my_access_count;
apr_off_t my_bytes_served;
apr_off_t conn_bytes;
unsigned short conn_count;
apr_time_t start_time;
apr_time_t stop_time;
#ifdef HAVE_TIMES
struct tms times;
#endif
apr_time_t last_used;
char client[32]; /* Keep 'em small... */
char request[64]; /* We just want an idea... */
char vhost[32]; /* What virtual host is being accessed? */
};
typedef struct {
ap_scoreboard_e sb_type;
ap_generation_t running_generation; /* the generation of children which
* should still be serving requests. */
} global_score;
/* stuff which the parent generally writes and the children rarely read */
typedef struct process_score process_score;
struct process_score{
pid_t pid;
ap_generation_t generation; /* generation of this child */
ap_scoreboard_e sb_type;
int quiescing; /* the process whose pid is stored above is
* going down gracefully
*/
};
/* Scoreboard is now in 'local' memory, since it isn't updated once created,
* even in forked architectures. Child created-processes (non-fork) will
* set up these indicies into the (possibly relocated) shmem records.
*/
typedef struct {
global_score *global;
process_score *parent;
worker_score **servers;
} scoreboard;
typedef struct ap_sb_handle_t ap_sb_handle_t;
AP_DECLARE(int) ap_exists_scoreboard_image(void);
AP_DECLARE(void) ap_increment_counts(ap_sb_handle_t *sbh, request_rec *r);
void ap_create_scoreboard(apr_pool_t *p, ap_scoreboard_e t);
apr_status_t reopen_scoreboard(apr_pool_t *p, int detached);
void ap_init_scoreboard(void *shared_score);
int ap_calc_scoreboard_size(void);
apr_status_t ap_cleanup_scoreboard(void *d);
void ap_sync_scoreboard_image(void);
AP_DECLARE(void) ap_create_sb_handle(ap_sb_handle_t **new_sbh, apr_pool_t *p,
int child_num, int thread_num);
void update_scoreboard_global(void);
AP_DECLARE(int) find_child_by_pid(apr_proc_t *pid);
AP_DECLARE(int) ap_update_child_status(ap_sb_handle_t *sbh, int status, request_rec *r);
AP_DECLARE(int) ap_update_child_status_from_indexes(int child_num, int thread_num,
int status, request_rec *r);
void ap_time_process_request(int child_num, int thread_num, int status);
AP_DECLARE(worker_score *) ap_get_scoreboard_worker(int x, int y);
AP_DECLARE(process_score *) ap_get_scoreboard_process(int x);
AP_DECLARE(global_score *) ap_get_scoreboard_global(void);
AP_DECLARE_DATA extern scoreboard *ap_scoreboard_image;
AP_DECLARE_DATA extern const char *ap_scoreboard_fname;
AP_DECLARE_DATA extern int ap_extended_status;
AP_DECLARE_DATA extern apr_time_t ap_restart_time;
AP_DECLARE_DATA extern ap_generation_t volatile ap_my_generation;
/* Hooks */
/**
* Hook for post scoreboard creation, pre mpm.
* @param p Apache pool to allocate from.
* @param sb_type
* @ingroup hooks
*/
AP_DECLARE_HOOK(void, pre_mpm, (apr_pool_t *p, ap_scoreboard_e sb_type))
/* for time_process_request() in http_main.c */
#define START_PREQUEST 1
#define STOP_PREQUEST 2
#ifdef __cplusplus
}
#endif
#endif /* !APACHE_SCOREBOARD_H */