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

   1 /* ====================================================================
   2  * The Apache Software License, Version 1.1
   3  *
   4  * Copyright (c) 2000-2001 The Apache Software Foundation.  All rights
   5  * reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  *
  11  * 1. Redistributions of source code must retain the above copyright
  12  *    notice, this list of conditions and the following disclaimer.
  13  *
  14  * 2. Redistributions in binary form must reproduce the above copyright
  15  *    notice, this list of conditions and the following disclaimer in
  16  *    the documentation and/or other materials provided with the
  17  *    distribution.
  18  *
  19  * 3. The end-user documentation included with the redistribution,
  20  *    if any, must include the following acknowledgment:
  21  *       "This product includes software developed by the
  22  *        Apache Software Foundation (http://www.apache.org/)."
  23  *    Alternately, this acknowledgment may appear in the software itself,
  24  *    if and wherever such third-party acknowledgments normally appear.
  25  *
  26  * 4. The names "Apache" and "Apache Software Foundation" must
  27  *    not be used to endorse or promote products derived from this
  28  *    software without prior written permission. For written
  29  *    permission, please contact apache@apache.org.
  30  *
  31  * 5. Products derived from this software may not be called "Apache",
  32  *    nor may "Apache" appear in their name, without prior written
  33  *    permission of the Apache Software Foundation.
  34  *
  35  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
  36  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  37  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  38  * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
  39  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  40  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  41  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  42  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  43  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  44  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  45  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  46  * SUCH DAMAGE.
  47  * ====================================================================
  48  *
  49  * This software consists of voluntary contributions made by many
  50  * individuals on behalf of the Apache Software Foundation.  For more
  51  * information on the Apache Software Foundation, please see
  52  * <http://www.apache.org/>.
  53  *
  54  * Portions of this software are based upon public domain software
  55  * originally written at the National Center for Supercomputing Applications,
  56  * University of Illinois, Urbana-Champaign.
  57  */
  58
  59 #ifndef APACHE_SCOREBOARD_H
  60 #define APACHE_SCOREBOARD_H
  61 #ifdef __cplusplus
  62 extern "C" {
  63 #endif
  64
  65 #ifdef HAVE_SYS_TIMES_H
  66 #include <sys/time.h>
  67 #include <sys/times.h>
  68 #elif defined(TPF)
  69 #include <time.h>
  70 #endif
  71
  72 #include "mpm_default.h"        /* For HARD_.*_LIMIT */
  73 #include "apr_thread_proc.h"
  74 #include "apr_portable.h"
  75
  76 /* Scoreboard info on a process is, for now, kept very brief ---
  77  * just status value and pid (the latter so that the caretaker process
  78  * can properly update the scoreboard when a process dies).  We may want
  79  * to eventually add a separate set of long_score structures which would
  80  * give, for each process, the number of requests serviced, and info on
  81  * the current, or most recent, request.
  82  *
  83  * Status values:
  84  */
  85
  86 #define SERVER_DEAD 0
  87 #define SERVER_STARTING 1       /* Server Starting up */
  88 #define SERVER_READY 2          /* Waiting for connection (or accept() lock) */
  89 #define SERVER_BUSY_READ 3      /* Reading a client request */
  90 #define SERVER_BUSY_WRITE 4     /* Processing a client request */
  91 #define SERVER_BUSY_KEEPALIVE 5 /* Waiting for more requests via keepalive */
  92 #define SERVER_BUSY_LOG 6       /* Logging the request */
  93 #define SERVER_BUSY_DNS 7       /* Looking up a hostname */
  94 #define SERVER_GRACEFUL 8       /* server is gracefully finishing request */
  95 #define SERVER_ACCEPTING 9      /* thread is accepting connections */
  96 #define SERVER_QUEUEING 10      /* thread is putting connection on the queue */
  97 #define SERVER_IDLE_KILL 11     /* Server is cleaning up idle children. */
  98 #define SERVER_NUM_STATUS 12    /* number of status settings */
  99
 100 /* Type used for generation indicies.  Startup and every restart cause a
 101  * new generation of children to be spawned.  Children within the same
 102  * generation share the same configuration information -- pointers to stuff
 103  * created at config time in the parent are valid across children.  For
 104  * example, the vhostrec pointer in the scoreboard below is valid in all
 105  * children of the same generation.
 106  *
 107  * The safe way to access the vhost pointer is like this:
 108  *
 109  * worker_score *ss = pointer to whichver slot is interesting;
 110  * process_score *ps = pointer to whichver slot is interesting;
 111  * server_rec *vh = ss->vhostrec;
 112  *
 113  * if (ps->generation != ap_my_generation) {
 114  *     vh = NULL;
 115  * }
 116  *
 117  * then if vh is not NULL it's valid in this child.
 118  *
 119  * This avoids various race conditions around restarts.
 120  */
 121 typedef int ap_generation_t;
 122
 123 /* Is the scoreboard shared between processes or not?
 124  * Set by the MPM when the scoreboard is created.
 125  */
 126 typedef enum {
 127     SB_SHARED = 1,
 128     SB_NOT_SHARED = 2
 129 } ap_scoreboard_e;
 130
 131 #define SB_WORKING  0  /* The server is busy and the child is useful. */
 132 #define SB_IDLE_DIE 1  /* The server is idle and the child is superfluous. */
 133                        /*   The child should check for this and exit gracefully. */
 134
 135 /* stuff which is worker specific */
 136 /***********************WARNING***************************************/
 137 /* These are things that are used by mod_status. Do not put anything */
 138 /*   in here that you cannot live without. This structure will not   */
 139 /*   be available if mod_status is not loaded.                       */
 140 /*********************************************************************/
 141 typedef struct worker_score worker_score;
 142
 143 struct worker_score {
 144     int thread_num;
 145 #if APR_HAS_THREADS
 146     apr_os_thread_t tid;
 147 #endif
 148     unsigned char status;
 149     unsigned long access_count;
 150     unsigned long bytes_served;
 151     unsigned long my_access_count;
 152     unsigned long my_bytes_served;
 153     unsigned long conn_bytes;
 154     unsigned short conn_count;
 155     apr_time_t start_time;
 156     apr_time_t stop_time;
 157 #ifdef HAVE_TIMES
 158     struct tms times;
 159 #endif
 160     apr_time_t last_used;
 161     char client[32];            /* Keep 'em small... */
 162     char request[64];           /* We just want an idea... */
 163     server_rec *vhostrec;       /* What virtual host is being accessed? */
 164                                 /* SEE ABOVE FOR SAFE USAGE! */
 165     worker_score *next;
 166 };
 167
 168 typedef struct {
 169     ap_scoreboard_e sb_type;
 170     ap_generation_t running_generation; /* the generation of children which
 171                                          * should still be serving requests. */
 172 } global_score;
 173
 174 /* stuff which the parent generally writes and the children rarely read */
 175 typedef struct process_score process_score;
 176 struct process_score{
 177     pid_t pid;
 178     ap_generation_t generation; /* generation of this child */
 179     ap_scoreboard_e sb_type;
 180     unsigned short process_status;    /* Either SB_WORKING or SB_IDLE_DIE */
 181     int worker_threads;
 182     worker_score *worker_head;
 183     process_score *next;
 184 };
 185
 186 typedef struct {
 187     worker_score servers[HARD_SERVER_LIMIT][HARD_THREAD_LIMIT];
 188     process_score parent[HARD_SERVER_LIMIT];
 189     global_score global;
 190 } scoreboard;
 191
 192 #define KEY_LENGTH 16
 193 #define VALUE_LENGTH 64
 194 typedef struct {
 195     char key[KEY_LENGTH];
 196     char value[VALUE_LENGTH];
 197 } status_table_entry;
 198
 199 #define SCOREBOARD_SIZE         sizeof(scoreboard)
 200 #ifdef TPF
 201 #define SCOREBOARD_NAME         "SCOREBRD"
 202 #define SCOREBOARD_FRAMES               SCOREBOARD_SIZE/4095 + 1
 203 #endif
 204
 205 AP_DECLARE(int) ap_exists_scoreboard_image(void);
 206 AP_DECLARE(void) ap_create_scoreboard(apr_pool_t *p, ap_scoreboard_e t);
 207 AP_DECLARE(void) ap_increment_counts(int child_num, int thread_num, request_rec *r);
 208
 209 apr_status_t ap_cleanup_scoreboard(void *d);
 210
 211 AP_DECLARE(void) reopen_scoreboard(apr_pool_t *p);
 212
 213 void ap_sync_scoreboard_image(void);
 214
 215 void update_scoreboard_global(void);
 216 AP_DECLARE(int) find_child_by_pid(apr_proc_t *pid);
 217 int ap_update_child_status(int child_num, int thread_num, int status, request_rec *r);
 218 void ap_time_process_request(int child_num, int thread_num, int status);
 219
 220
 221 AP_DECLARE_DATA extern scoreboard *ap_scoreboard_image;
 222 AP_DECLARE_DATA extern const char *ap_scoreboard_fname;
 223 AP_DECLARE_DATA extern int ap_extended_status;
 224 AP_DECLARE_DATA extern apr_time_t ap_restart_time;
 225
 226 AP_DECLARE_DATA extern ap_generation_t volatile ap_my_generation;
 227
 228 /* for time_process_request() in http_main.c */
 229 #define START_PREQUEST 1
 230 #define STOP_PREQUEST  2
 231
 232 #ifdef __cplusplus
 233 }
 234 #endif
 235
 236 #endif  /* !APACHE_SCOREBOARD_H */