1 /* Licensed to the Apache Software Foundation (ASF) under one or more
2 * contributor license agreements. See the NOTICE file distributed with
3 * this work for additional information regarding copyright ownership.
4 * The ASF licenses this file to You under the Apache License, Version 2.0
5 * (the "License"); you may not use this file except in compliance with
6 * the License. You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
19 * @brief Apache scoreboard library
22 #ifndef APACHE_SCOREBOARD_H
23 #define APACHE_SCOREBOARD_H
29 #if APR_HAVE_SYS_TIME_H
31 #include <sys/times.h>
34 #include "ap_config.h"
35 #include "http_config.h"
36 #include "apr_thread_proc.h"
37 #include "apr_portable.h"
39 #include "apr_optional.h"
41 /* Scoreboard file, if there is one */
42 #ifndef DEFAULT_SCOREBOARD
43 #define DEFAULT_SCOREBOARD "apache_runtime_status" /* within DEFAULT_REL_RUNTIMEDIR */
46 /* Scoreboard info on a process is, for now, kept very brief ---
47 * just status value and pid (the latter so that the caretaker process
48 * can properly update the scoreboard when a process dies). We may want
49 * to eventually add a separate set of long_score structures which would
50 * give, for each process, the number of requests serviced, and info on
51 * the current, or most recent, request.
57 #define SERVER_STARTING 1 /* Server Starting up */
58 #define SERVER_READY 2 /* Waiting for connection (or accept() lock) */
59 #define SERVER_BUSY_READ 3 /* Reading a client request */
60 #define SERVER_BUSY_WRITE 4 /* Processing a client request */
61 #define SERVER_BUSY_KEEPALIVE 5 /* Waiting for more requests via keepalive */
62 #define SERVER_BUSY_LOG 6 /* Logging the request */
63 #define SERVER_BUSY_DNS 7 /* Looking up a hostname */
64 #define SERVER_CLOSING 8 /* Closing the connection */
65 #define SERVER_GRACEFUL 9 /* server is gracefully finishing request */
66 #define SERVER_IDLE_KILL 10 /* Server is cleaning up idle children. */
67 #define SERVER_NUM_STATUS 11 /* number of status settings */
69 /* Type used for generation indicies. Startup and every restart cause a
70 * new generation of children to be spawned. Children within the same
71 * generation share the same configuration information -- pointers to stuff
72 * created at config time in the parent are valid across children. However,
73 * this can't work effectively with non-forked architectures. So while the
74 * arrays in the scoreboard never change between the parent and forked
75 * children, so they do not require shm storage, the contents of the shm
76 * may contain no pointers.
78 typedef int ap_generation_t;
80 /* Is the scoreboard shared between processes or not?
81 * Set by the MPM when the scoreboard is created.
88 /* stuff which is worker specific */
89 typedef struct worker_score worker_score;
95 /* With some MPMs (e.g., worker), a worker_score can represent
96 * a thread in a terminating process which is no longer
97 * represented by the corresponding process_score. These MPMs
98 * should set pid and generation fields in the worker_score.
101 ap_generation_t generation;
102 unsigned char status;
103 unsigned short conn_count;
104 apr_off_t conn_bytes;
105 unsigned long access_count;
106 apr_off_t bytes_served;
107 unsigned long my_access_count;
108 apr_off_t my_bytes_served;
109 apr_time_t start_time;
110 apr_time_t stop_time;
111 apr_time_t last_used;
115 char client[32]; /* DEPRECATED: Keep 'em small... */
116 char request[64]; /* We just want an idea... */
117 char vhost[32]; /* What virtual host is being accessed? */
118 char protocol[16]; /* What protocol is used on the connection? */
126 ap_generation_t running_generation; /* the generation of children which
127 * should still be serving requests.
129 apr_time_t restart_time;
135 /* stuff which the parent generally writes and the children rarely read */
136 typedef struct process_score process_score;
137 struct process_score {
139 ap_generation_t generation; /* generation of this child */
140 char quiescing; /* the process whose pid is stored above is
141 * going down gracefully
143 char not_accepting; /* the process is busy and is not accepting more
144 * connections (for async MPMs)
146 apr_uint32_t connections; /* total connections (for async MPMs) */
147 apr_uint32_t write_completion; /* async connections doing write completion */
148 apr_uint32_t lingering_close; /* async connections in lingering close */
149 apr_uint32_t keep_alive; /* async connections in keep alive */
150 apr_uint32_t suspended; /* connections suspended by some module */
151 int bucket; /* Listener bucket used by this child */
154 /* Scoreboard is now in 'local' memory, since it isn't updated once created,
155 * even in forked architectures. Child created-processes (non-fork) will
156 * set up these indicies into the (possibly relocated) shmem records.
159 global_score *global;
160 process_score *parent;
161 worker_score **servers;
164 typedef struct ap_sb_handle_t ap_sb_handle_t;
167 * Creation and deletion (internal)
169 int ap_create_scoreboard(apr_pool_t *p, ap_scoreboard_e t);
170 apr_status_t ap_cleanup_scoreboard(void *d);
173 * APIs for MPMs and other modules
175 AP_DECLARE(int) ap_exists_scoreboard_image(void);
176 AP_DECLARE(void) ap_increment_counts(ap_sb_handle_t *sbh, request_rec *r);
177 AP_DECLARE(void) ap_set_conn_count(ap_sb_handle_t *sb, request_rec *r, unsigned short conn_count);
179 AP_DECLARE(apr_status_t) ap_reopen_scoreboard(apr_pool_t *p, apr_shm_t **shm, int detached);
180 AP_DECLARE(void) ap_init_scoreboard(void *shared_score);
181 AP_DECLARE(int) ap_calc_scoreboard_size(void);
183 AP_DECLARE(void) ap_create_sb_handle(ap_sb_handle_t **new_sbh, apr_pool_t *p,
184 int child_num, int thread_num);
185 AP_DECLARE(void) ap_update_sb_handle(ap_sb_handle_t *sbh,
186 int child_num, int thread_num);
188 AP_DECLARE(int) ap_find_child_by_pid(apr_proc_t *pid);
189 AP_DECLARE(int) ap_update_child_status(ap_sb_handle_t *sbh, int status, request_rec *r);
190 AP_DECLARE(int) ap_update_child_status_from_indexes(int child_num, int thread_num,
191 int status, request_rec *r);
192 AP_DECLARE(int) ap_update_child_status_from_conn(ap_sb_handle_t *sbh, int status, conn_rec *c);
193 AP_DECLARE(int) ap_update_child_status_from_server(ap_sb_handle_t *sbh, int status,
194 conn_rec *c, server_rec *s);
195 AP_DECLARE(int) ap_update_child_status_descr(ap_sb_handle_t *sbh, int status, const char *descr);
197 AP_DECLARE(void) ap_time_process_request(ap_sb_handle_t *sbh, int status);
199 AP_DECLARE(int) ap_update_global_status(void);
201 AP_DECLARE(worker_score *) ap_get_scoreboard_worker(ap_sb_handle_t *sbh);
203 /** Return a pointer to the worker_score for a given child, thread pair.
204 * @param child_num The child number.
205 * @param thread_num The thread number.
206 * @return A pointer to the worker_score structure.
207 * @deprecated This function is deprecated, use ap_copy_scoreboard_worker instead. */
208 AP_DECLARE(worker_score *) ap_get_scoreboard_worker_from_indexes(int child_num,
211 /** Copy the contents of a worker scoreboard entry. The contents of
212 * the worker_score structure are copied verbatim into the dest
214 * @param dest Output parameter.
215 * @param child_num The child number.
216 * @param thread_num The thread number.
218 AP_DECLARE(void) ap_copy_scoreboard_worker(worker_score *dest,
219 int child_num, int thread_num);
221 AP_DECLARE(process_score *) ap_get_scoreboard_process(int x);
222 AP_DECLARE(global_score *) ap_get_scoreboard_global(void);
224 AP_DECLARE_DATA extern scoreboard *ap_scoreboard_image;
225 AP_DECLARE_DATA extern const char *ap_scoreboard_fname;
226 AP_DECLARE_DATA extern int ap_extended_status;
227 AP_DECLARE_DATA extern int ap_mod_status_reqtail;
230 * Command handlers [internal]
232 const char *ap_set_scoreboard(cmd_parms *cmd, void *dummy, const char *arg);
233 const char *ap_set_extended_status(cmd_parms *cmd, void *dummy, int arg);
234 const char *ap_set_reqtail(cmd_parms *cmd, void *dummy, int arg);
238 * Hook for post scoreboard creation, pre mpm.
239 * @param p Apache pool to allocate from.
242 * @return OK or DECLINE on success; anything else is a error
244 AP_DECLARE_HOOK(int, pre_mpm, (apr_pool_t *p, ap_scoreboard_e sb_type))
246 /* for time_process_request() in http_main.c */
247 #define START_PREQUEST 1
248 #define STOP_PREQUEST 2
254 #endif /* !APACHE_SCOREBOARD_H */