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
7 *
8 *     http://www.apache.org/licenses/LICENSE-2.0
9 *
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.
15 */
16
17/**
18 * @file  scoreboard.h
19 * @brief Apache scoreboard library
20 */
21
22#ifndef APACHE_SCOREBOARD_H
23#define APACHE_SCOREBOARD_H
24
25#ifdef __cplusplus
26extern "C" {
27#endif
28
29#ifdef HAVE_SYS_TIMES_H
30#include <sys/time.h>
31#include <sys/times.h>
32#endif
33
34#include "ap_config.h"
35#include "http_config.h"
36#include "apr_thread_proc.h"
37#include "apr_portable.h"
38#include "apr_shm.h"
39#include "apr_optional.h"
40
41/* Scoreboard file, if there is one */
42#ifndef DEFAULT_SCOREBOARD
43#define DEFAULT_SCOREBOARD "logs/apache_runtime_status"
44#endif
45
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.
52 *
53 * Status values:
54 */
55
56#define SERVER_DEAD 0
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 */
68
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.
77 */
78typedef int ap_generation_t;
79
80/* Is the scoreboard shared between processes or not?
81 * Set by the MPM when the scoreboard is created.
82 */
83typedef enum {
84    SB_NOT_SHARED = 1,
85    SB_SHARED = 2
86} ap_scoreboard_e;
87
88/* stuff which is worker specific */
89typedef struct worker_score worker_score;
90struct worker_score {
91#if APR_HAS_THREADS
92    apr_os_thread_t tid;
93#endif
94    int thread_num;
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.
99     */
100    pid_t pid;
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;
112#ifdef HAVE_TIMES
113    struct tms times;
114#endif
115    char client[32];            /* Keep 'em small... */
116    char request[64];           /* We just want an idea... */
117    char vhost[32];             /* What virtual host is being accessed? */
118};
119
120typedef struct {
121    int             server_limit;
122    int             thread_limit;
123    ap_generation_t running_generation; /* the generation of children which
124                                         * should still be serving requests.
125                                         */
126    apr_time_t restart_time;
127} global_score;
128
129/* stuff which the parent generally writes and the children rarely read */
130typedef struct process_score process_score;
131struct process_score {
132    pid_t pid;
133    ap_generation_t generation; /* generation of this child */
134    char quiescing;         /* the process whose pid is stored above is
135                             * going down gracefully
136                             */
137    char not_accepting;     /* the process is busy and is not accepting more
138                             * connections (for async MPMs)
139                             */
140    apr_uint32_t connections;       /* total connections (for async MPMs) */
141    apr_uint32_t write_completion;  /* async connections doing write completion */
142    apr_uint32_t lingering_close;   /* async connections in lingering close */
143    apr_uint32_t keep_alive;        /* async connections in keep alive */
144    apr_uint32_t suspended;         /* connections suspended by some module */
145};
146
147/* Scoreboard is now in 'local' memory, since it isn't updated once created,
148 * even in forked architectures.  Child created-processes (non-fork) will
149 * set up these indicies into the (possibly relocated) shmem records.
150 */
151typedef struct {
152    global_score *global;
153    process_score *parent;
154    worker_score **servers;
155} scoreboard;
156
157typedef struct ap_sb_handle_t ap_sb_handle_t;
158
159/*
160 * Creation and deletion (internal)
161 */
162int ap_create_scoreboard(apr_pool_t *p, ap_scoreboard_e t);
163apr_status_t ap_cleanup_scoreboard(void *d);
164
165/*
166 * APIs for MPMs and other modules
167 */
168AP_DECLARE(int) ap_exists_scoreboard_image(void);
169AP_DECLARE(void) ap_increment_counts(ap_sb_handle_t *sbh, request_rec *r);
170
171AP_DECLARE(apr_status_t) ap_reopen_scoreboard(apr_pool_t *p, apr_shm_t **shm, int detached);
172AP_DECLARE(void) ap_init_scoreboard(void *shared_score);
173AP_DECLARE(int) ap_calc_scoreboard_size(void);
174
175AP_DECLARE(void) ap_create_sb_handle(ap_sb_handle_t **new_sbh, apr_pool_t *p,
176                                     int child_num, int thread_num);
177
178AP_DECLARE(int) ap_find_child_by_pid(apr_proc_t *pid);
179AP_DECLARE(int) ap_update_child_status(ap_sb_handle_t *sbh, int status, request_rec *r);
180AP_DECLARE(int) ap_update_child_status_from_indexes(int child_num, int thread_num,
181                                                    int status, request_rec *r);
182AP_DECLARE(int) ap_update_child_status_from_conn(ap_sb_handle_t *sbh, int status, conn_rec *c);
183AP_DECLARE(void) ap_time_process_request(ap_sb_handle_t *sbh, int status);
184
185AP_DECLARE(worker_score *) ap_get_scoreboard_worker(ap_sb_handle_t *sbh);
186AP_DECLARE(worker_score *) ap_get_scoreboard_worker_from_indexes(int child_num,
187                                                                int thread_num);
188AP_DECLARE(process_score *) ap_get_scoreboard_process(int x);
189AP_DECLARE(global_score *) ap_get_scoreboard_global(void);
190
191AP_DECLARE_DATA extern scoreboard *ap_scoreboard_image;
192AP_DECLARE_DATA extern const char *ap_scoreboard_fname;
193AP_DECLARE_DATA extern int ap_extended_status;
194AP_DECLARE_DATA extern int ap_mod_status_reqtail;
195
196/*
197 * Command handlers [internal]
198 */
199const char *ap_set_scoreboard(cmd_parms *cmd, void *dummy, const char *arg);
200const char *ap_set_extended_status(cmd_parms *cmd, void *dummy, int arg);
201const char *ap_set_reqtail(cmd_parms *cmd, void *dummy, int arg);
202
203/* Hooks */
204/**
205  * Hook for post scoreboard creation, pre mpm.
206  * @param p       Apache pool to allocate from.
207  * @param sb_type
208  * @ingroup hooks
209  * @return OK or DECLINE on success; anything else is a error
210  */
211AP_DECLARE_HOOK(int, pre_mpm, (apr_pool_t *p, ap_scoreboard_e sb_type))
212
213/* for time_process_request() in http_main.c */
214#define START_PREQUEST 1
215#define STOP_PREQUEST  2
216
217#ifdef __cplusplus
218}
219#endif
220
221#endif  /* !APACHE_SCOREBOARD_H */
222