1 /* ====================================================================
2 * The Apache Software License, Version 1.1
4 * Copyright (c) 2000-2001 The Apache Software Foundation. All rights
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
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
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.
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.
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.
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
47 * ====================================================================
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/>.
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.
59 #ifndef APACHE_SCOREBOARD_H
60 #define APACHE_SCOREBOARD_H
65 #ifdef HAVE_SYS_TIMES_H
67 #include <sys/times.h>
72 #include "ap_config.h"
73 #include "mpm_default.h" /* For HARD_.*_LIMIT */
74 #include "apr_hooks.h"
75 #include "apr_thread_proc.h"
76 #include "apr_portable.h"
78 /* Scoreboard info on a process is, for now, kept very brief ---
79 * just status value and pid (the latter so that the caretaker process
80 * can properly update the scoreboard when a process dies). We may want
81 * to eventually add a separate set of long_score structures which would
82 * give, for each process, the number of requests serviced, and info on
83 * the current, or most recent, request.
89 #define SERVER_STARTING 1 /* Server Starting up */
90 #define SERVER_READY 2 /* Waiting for connection (or accept() lock) */
91 #define SERVER_BUSY_READ 3 /* Reading a client request */
92 #define SERVER_BUSY_WRITE 4 /* Processing a client request */
93 #define SERVER_BUSY_KEEPALIVE 5 /* Waiting for more requests via keepalive */
94 #define SERVER_BUSY_LOG 6 /* Logging the request */
95 #define SERVER_BUSY_DNS 7 /* Looking up a hostname */
96 #define SERVER_CLOSING 8 /* Closing the connection */
97 #define SERVER_GRACEFUL 9 /* server is gracefully finishing request */
98 #define SERVER_IDLE_KILL 10 /* Server is cleaning up idle children. */
99 #define SERVER_NUM_STATUS 11 /* number of status settings */
101 /* Type used for generation indicies. Startup and every restart cause a
102 * new generation of children to be spawned. Children within the same
103 * generation share the same configuration information -- pointers to stuff
104 * created at config time in the parent are valid across children. For
105 * example, the vhostrec pointer in the scoreboard below is valid in all
106 * children of the same generation.
108 * The safe way to access the vhost pointer is like this:
110 * worker_score *ss = pointer to whichver slot is interesting;
111 * process_score *ps = pointer to whichver slot is interesting;
112 * server_rec *vh = ss->vhostrec;
114 * if (ps->generation != ap_my_generation) {
118 * then if vh is not NULL it's valid in this child.
120 * This avoids various race conditions around restarts.
122 typedef int ap_generation_t;
124 /* Is the scoreboard shared between processes or not?
125 * Set by the MPM when the scoreboard is created.
132 #define SB_WORKING 0 /* The server is busy and the child is useful. */
133 #define SB_IDLE_DIE 1 /* The server is idle and the child is superfluous. */
134 /* The child should check for this and exit gracefully. */
136 /* stuff which is worker specific */
137 /***********************WARNING***************************************/
138 /* These are things that are used by mod_status. Do not put anything */
139 /* in here that you cannot live without. This structure will not */
140 /* be available if mod_status is not loaded. */
141 /*********************************************************************/
142 typedef struct worker_score worker_score;
144 struct worker_score {
149 unsigned char status;
150 unsigned long access_count;
151 apr_off_t bytes_served;
152 unsigned long my_access_count;
153 apr_off_t my_bytes_served;
154 apr_off_t conn_bytes;
155 unsigned short conn_count;
156 apr_time_t start_time;
157 apr_time_t stop_time;
161 apr_time_t last_used;
162 char client[32]; /* Keep 'em small... */
163 char request[64]; /* We just want an idea... */
164 server_rec *vhostrec; /* What virtual host is being accessed? */
165 /* SEE ABOVE FOR SAFE USAGE! */
170 ap_scoreboard_e sb_type;
171 ap_generation_t running_generation; /* the generation of children which
172 * should still be serving requests. */
175 /* stuff which the parent generally writes and the children rarely read */
176 typedef struct process_score process_score;
177 struct process_score{
179 ap_generation_t generation; /* generation of this child */
180 ap_scoreboard_e sb_type;
181 int quiescing; /* the process whose pid is stored above is
182 * going down gracefully
188 process_score parent[HARD_SERVER_LIMIT];
189 worker_score servers[HARD_SERVER_LIMIT][HARD_THREAD_LIMIT];
192 #define KEY_LENGTH 16
193 #define VALUE_LENGTH 64
195 char key[KEY_LENGTH];
196 char value[VALUE_LENGTH];
197 } status_table_entry;
199 #define SCOREBOARD_SIZE sizeof(scoreboard)
201 #define SCOREBOARD_NAME "SCOREBRD"
202 #define SCOREBOARD_FRAMES SCOREBOARD_SIZE/4095 + 1
205 AP_DECLARE(int) ap_exists_scoreboard_image(void);
206 AP_DECLARE_NONSTD(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);
209 apr_status_t ap_cleanup_scoreboard(void *d);
211 AP_DECLARE(void) reopen_scoreboard(apr_pool_t *p);
213 void ap_sync_scoreboard_image(void);
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 worker_score *ap_get_servers_scoreboard(int x, int y);
220 process_score *ap_get_parent_scoreboard(int x);
222 AP_DECLARE_DATA extern scoreboard *ap_scoreboard_image;
223 AP_DECLARE_DATA extern const char *ap_scoreboard_fname;
224 AP_DECLARE_DATA extern int ap_extended_status;
225 AP_DECLARE_DATA extern apr_time_t ap_restart_time;
227 AP_DECLARE_DATA extern ap_generation_t volatile ap_my_generation;
231 * Hook for post scoreboard creation, pre mpm.
232 * @param p Apache pool to allocate from.
236 AP_DECLARE_HOOK(void, pre_mpm, (apr_pool_t *p, ap_scoreboard_e sb_type))
238 /* for time_process_request() in http_main.c */
239 #define START_PREQUEST 1
240 #define STOP_PREQUEST 2
246 #endif /* !APACHE_SCOREBOARD_H */