granicus.if.org Git - apache/blob - server/mpm/mpmt_os2/mpmt_os2.c

   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 /* Multi-process, multi-threaded MPM for OS/2
  18  *
  19  * Server consists of
  20  * - a main, parent process
  21  * - a small, static number of child processes
  22  *
  23  * The parent process's job is to manage the child processes. This involves
  24  * spawning children as required to ensure there are always ap_daemons_to_start
  25  * processes accepting connections.
  26  *
  27  * Each child process consists of a pool of worker threads and a
  28  * main thread that accepts connections & passes them to the workers via
  29  * a work queue. The worker thread pool is dynamic, managed by a maintanence
  30  * thread so that the number of idle threads is kept between
  31  * min_spare_threads & max_spare_threads.
  32  *
  33  */
  34
  35 /*
  36  Todo list
  37  - Enforce MaxRequestWorkers somehow
  38 */
  39 #define INCL_NOPMAPI
  40 #define INCL_DOS
  41 #define INCL_DOSERRORS
  42
  43 #include "ap_config.h"
  44 #include "httpd.h"
  45 #include "mpm_default.h"
  46 #include "http_main.h"
  47 #include "http_log.h"
  48 #include "http_config.h"
  49 #include "http_core.h"  /* for get_remote_host */
  50 #include "http_connection.h"
  51 #include "ap_mpm.h"
  52 #include "ap_listen.h"
  53 #include "apr_portable.h"
  54 #include "mpm_common.h"
  55 #include "scoreboard.h"
  56 #include "apr_strings.h"
  57 #include <os2.h>
  58 #include <process.h>
  59
  60 /* We don't need many processes,
  61  * they're only for redundancy in the event of a crash
  62  */
  63 #define HARD_SERVER_LIMIT 10
  64
  65 /* Limit on the total number of threads per process
  66  */
  67 #ifndef HARD_THREAD_LIMIT
  68 #define HARD_THREAD_LIMIT 256
  69 #endif
  70
  71 server_rec *ap_server_conf;
  72 static apr_pool_t *pconf = NULL;  /* Pool for config stuff */
  73
  74 /* Config globals */
  75 static int one_process = 0;
  76 static int ap_daemons_to_start = 0;
  77 static int ap_thread_limit = 0;
  78 int ap_min_spare_threads = 0;
  79 int ap_max_spare_threads = 0;
  80
  81 /* Keep track of a few interesting statistics */
  82 int ap_max_daemons_limit = -1;
  83
  84 /* volatile just in case */
  85 static int volatile shutdown_pending;
  86 static int volatile restart_pending;
  87 static int volatile is_graceful = 0;
  88 ap_generation_t volatile ap_my_generation=0; /* Used by the scoreboard */
  89 static int is_parent_process=TRUE;
  90 HMTX ap_mpm_accept_mutex = 0;
  91
  92 /* An array of these is stored in a shared memory area for passing
  93  * sockets from the parent to child processes
  94  */
  95 typedef struct {
  96     struct sockaddr_in name;
  97     apr_os_sock_t listen_fd;
  98 } listen_socket_t;
  99
 100 typedef struct {
 101     HMTX accept_mutex;
 102     listen_socket_t listeners[1];
 103 } parent_info_t;
 104
 105 static int master_main();
 106 static void spawn_child(int slot);
 107 void ap_mpm_child_main(apr_pool_t *pconf);
 108 static void set_signals();
 109
 110
 111 static int mpmt_os2_run(apr_pool_t *_pconf, apr_pool_t *plog, server_rec *s )
 112 {
 113     char *listener_shm_name;
 114     parent_info_t *parent_info;
 115     ULONG rc;
 116     pconf = _pconf;
 117     ap_server_conf = s;
 118     restart_pending = 0;
 119
 120     DosSetMaxFH(ap_thread_limit * 2);
 121     listener_shm_name = apr_psprintf(pconf, "/sharemem/httpd/parent_info.%d", getppid());
 122     rc = DosGetNamedSharedMem((PPVOID)&parent_info, listener_shm_name, PAG_READ);
 123     is_parent_process = rc != 0;
 124     ap_scoreboard_fname = apr_psprintf(pconf, "/sharemem/httpd/scoreboard.%d", is_parent_process ? getpid() : getppid());
 125
 126     if (rc == 0) {
 127         /* Child process */
 128         ap_listen_rec *lr;
 129         int num_listeners = 0;
 130
 131         ap_mpm_accept_mutex = parent_info->accept_mutex;
 132
 133         /* Set up a default listener if necessary */
 134         if (ap_listeners == NULL) {
 135             ap_listen_rec *lr = apr_pcalloc(s->process->pool, sizeof(ap_listen_rec));
 136             ap_listeners = lr;
 137             apr_sockaddr_info_get(&lr->bind_addr, "0.0.0.0", APR_UNSPEC,
 138                                   DEFAULT_HTTP_PORT, 0, s->process->pool);
 139             apr_socket_create(&lr->sd, lr->bind_addr->family,
 140                               SOCK_STREAM, 0, s->process->pool);
 141         }
 142
 143         for (lr = ap_listeners; lr; lr = lr->next) {
 144             apr_sockaddr_t *sa;
 145             apr_os_sock_put(&lr->sd, &parent_info->listeners[num_listeners].listen_fd, pconf);
 146             apr_socket_addr_get(&sa, APR_LOCAL, lr->sd);
 147             num_listeners++;
 148         }
 149
 150         DosFreeMem(parent_info);
 151
 152         /* Do the work */
 153         ap_mpm_child_main(pconf);
 154
 155         /* Outta here */
 156         return DONE;
 157     }
 158     else {
 159         /* Parent process */
 160         int rc;
 161         is_parent_process = TRUE;
 162
 163         if (ap_setup_listeners(ap_server_conf) < 1) {
 164             ap_log_error(APLOG_MARK, APLOG_ALERT, 0, s, APLOGNO(00200)
 165                          "no listening sockets available, shutting down");
 166             return !OK;
 167         }
 168
 169         ap_log_pid(pconf, ap_pid_fname);
 170
 171         rc = master_main();
 172         ++ap_my_generation;
 173         ap_scoreboard_image->global->running_generation = ap_my_generation;
 174
 175         if (rc != OK) {
 176             ap_remove_pid(pconf, ap_pid_fname);
 177             ap_log_error(APLOG_MARK, APLOG_NOTICE, 0, ap_server_conf, APLOGNO(00201)
 178                          "caught %s, shutting down",
 179                          (rc == DONE) ? "SIGTERM" : "error");
 180             return rc;
 181         }
 182     }  /* Parent process */
 183
 184     return OK; /* Restart */
 185 }
 186
 187
 188
 189 /* Main processing of the parent process
 190  * returns TRUE if restarting
 191  */
 192 static int master_main()
 193 {
 194     server_rec *s = ap_server_conf;
 195     ap_listen_rec *lr;
 196     parent_info_t *parent_info;
 197     char *listener_shm_name;
 198     int listener_num, num_listeners, slot;
 199     ULONG rc;
 200
 201     printf("%s \n", ap_get_server_description());
 202     set_signals();
 203
 204     if (ap_setup_listeners(ap_server_conf) < 1) {
 205         ap_log_error(APLOG_MARK, APLOG_ALERT, 0, s, APLOGNO(00202)
 206                      "no listening sockets available, shutting down");
 207         return !OK;
 208     }
 209
 210     /* Allocate a shared memory block for the array of listeners */
 211     for (num_listeners = 0, lr = ap_listeners; lr; lr = lr->next) {
 212         num_listeners++;
 213     }
 214
 215     listener_shm_name = apr_psprintf(pconf, "/sharemem/httpd/parent_info.%d", getpid());
 216     rc = DosAllocSharedMem((PPVOID)&parent_info, listener_shm_name,
 217                            sizeof(parent_info_t) + num_listeners * sizeof(listen_socket_t),
 218                            PAG_READ|PAG_WRITE|PAG_COMMIT);
 219
 220     if (rc) {
 221         ap_log_error(APLOG_MARK, APLOG_ALERT, APR_FROM_OS_ERROR(rc), s, APLOGNO(00203)
 222                      "failure allocating shared memory, shutting down");
 223         return !OK;
 224     }
 225
 226     /* Store the listener sockets in the shared memory area for our children to see */
 227     for (listener_num = 0, lr = ap_listeners; lr; lr = lr->next, listener_num++) {
 228         apr_os_sock_get(&parent_info->listeners[listener_num].listen_fd, lr->sd);
 229     }
 230
 231     /* Create mutex to prevent multiple child processes from detecting
 232      * a connection with apr_poll()
 233      */
 234
 235     rc = DosCreateMutexSem(NULL, &ap_mpm_accept_mutex, DC_SEM_SHARED, FALSE);
 236
 237     if (rc) {
 238         ap_log_error(APLOG_MARK, APLOG_ALERT, APR_FROM_OS_ERROR(rc), s, APLOGNO(00204)
 239                      "failure creating accept mutex, shutting down");
 240         return !OK;
 241     }
 242
 243     parent_info->accept_mutex = ap_mpm_accept_mutex;
 244
 245     /* Allocate shared memory for scoreboard */
 246     if (ap_scoreboard_image == NULL) {
 247         void *sb_mem;
 248         rc = DosAllocSharedMem(&sb_mem, ap_scoreboard_fname,
 249                                ap_calc_scoreboard_size(),
 250                                PAG_COMMIT|PAG_READ|PAG_WRITE);
 251
 252         if (rc) {
 253             ap_log_error(APLOG_MARK, APLOG_ERR, APR_FROM_OS_ERROR(rc), ap_server_conf, APLOGNO(00205)
 254                          "unable to allocate shared memory for scoreboard , exiting");
 255             return !OK;
 256         }
 257
 258         ap_init_scoreboard(sb_mem);
 259     }
 260
 261     ap_scoreboard_image->global->restart_time = apr_time_now();
 262     ap_log_error(APLOG_MARK, APLOG_NOTICE, 0, ap_server_conf, APLOGNO(00206)
 263                 "%s configured -- resuming normal operations",
 264                 ap_get_server_description());
 265     ap_log_error(APLOG_MARK, APLOG_INFO, 0, ap_server_conf, APLOGNO(00207)
 266                 "Server built: %s", ap_get_server_built());
 267     if (one_process) {
 268         ap_scoreboard_image->parent[0].pid = getpid();
 269         ap_mpm_child_main(pconf);
 270         return DONE;
 271     }
 272
 273     while (!restart_pending && !shutdown_pending) {
 274         RESULTCODES proc_rc;
 275         PID child_pid;
 276         int active_children = 0;
 277
 278         /* Count number of active children */
 279         for (slot=0; slot < HARD_SERVER_LIMIT; slot++) {
 280             active_children += ap_scoreboard_image->parent[slot].pid != 0 &&
 281                 !ap_scoreboard_image->parent[slot].quiescing;
 282         }
 283
 284         /* Spawn children if needed */
 285         for (slot=0; slot < HARD_SERVER_LIMIT && active_children < ap_daemons_to_start; slot++) {
 286             if (ap_scoreboard_image->parent[slot].pid == 0) {
 287                 spawn_child(slot);
 288                 active_children++;
 289             }
 290         }
 291
 292         rc = DosWaitChild(DCWA_PROCESSTREE, DCWW_NOWAIT, &proc_rc, &child_pid, 0);
 293
 294         if (rc == 0) {
 295             /* A child has terminated, remove its scoreboard entry & terminate if necessary */
 296             for (slot=0; ap_scoreboard_image->parent[slot].pid != child_pid && slot < HARD_SERVER_LIMIT; slot++);
 297
 298             if (slot < HARD_SERVER_LIMIT) {
 299                 ap_scoreboard_image->parent[slot].pid = 0;
 300                 ap_scoreboard_image->parent[slot].quiescing = 0;
 301
 302                 if (proc_rc.codeTerminate == TC_EXIT) {
 303                     /* Child terminated normally, check its exit code and
 304                      * terminate server if child indicates a fatal error
 305                      */
 306                     if (proc_rc.codeResult == APEXIT_CHILDFATAL)
 307                         break;
 308                 }
 309             }
 310         } else if (rc == ERROR_CHILD_NOT_COMPLETE) {
 311             /* No child exited, lets sleep for a while.... */
 312             apr_sleep(SCOREBOARD_MAINTENANCE_INTERVAL);
 313         }
 314     }
 315
 316     /* Signal children to shut down, either gracefully or immediately */
 317     for (slot=0; slot<HARD_SERVER_LIMIT; slot++) {
 318       kill(ap_scoreboard_image->parent[slot].pid, is_graceful ? SIGHUP : SIGTERM);
 319     }
 320
 321     DosFreeMem(parent_info);
 322     return restart_pending ? OK : DONE;
 323 }
 324
 325
 326
 327 static void spawn_child(int slot)
 328 {
 329     PPIB ppib;
 330     PTIB ptib;
 331     char fail_module[100];
 332     char progname[CCHMAXPATH];
 333     RESULTCODES proc_rc;
 334     ULONG rc;
 335
 336     ap_scoreboard_image->parent[slot].generation = ap_my_generation;
 337     DosGetInfoBlocks(&ptib, &ppib);
 338     DosQueryModuleName(ppib->pib_hmte, sizeof(progname), progname);
 339     rc = DosExecPgm(fail_module, sizeof(fail_module), EXEC_ASYNCRESULT,
 340                     ppib->pib_pchcmd, NULL, &proc_rc, progname);
 341
 342     if (rc) {
 343         ap_log_error(APLOG_MARK, APLOG_ERR, APR_FROM_OS_ERROR(rc), ap_server_conf, APLOGNO(00208)
 344                      "error spawning child, slot %d", slot);
 345     }
 346
 347     if (ap_max_daemons_limit < slot) {
 348         ap_max_daemons_limit = slot;
 349     }
 350
 351     ap_scoreboard_image->parent[slot].pid = proc_rc.codeTerminate;
 352 }
 353
 354
 355
 356 /* Signal handling routines */
 357
 358 static void sig_term(int sig)
 359 {
 360     shutdown_pending = 1;
 361     signal(SIGTERM, SIG_DFL);
 362 }
 363
 364
 365
 366 static void sig_restart(int sig)
 367 {
 368     if (sig == SIGUSR1) {
 369         is_graceful = 1;
 370     }
 371
 372     restart_pending = 1;
 373 }
 374
 375
 376
 377 static void set_signals()
 378 {
 379     struct sigaction sa;
 380
 381     sigemptyset(&sa.sa_mask);
 382     sa.sa_flags = 0;
 383     sa.sa_handler = sig_term;
 384
 385     if (sigaction(SIGTERM, &sa, NULL) < 0)
 386         ap_log_error(APLOG_MARK, APLOG_WARNING, errno, ap_server_conf, APLOGNO(00209) "sigaction(SIGTERM)");
 387
 388     if (sigaction(SIGINT, &sa, NULL) < 0)
 389         ap_log_error(APLOG_MARK, APLOG_WARNING, errno, ap_server_conf, APLOGNO(00210) "sigaction(SIGINT)");
 390
 391     sa.sa_handler = sig_restart;
 392
 393     if (sigaction(SIGHUP, &sa, NULL) < 0)
 394         ap_log_error(APLOG_MARK, APLOG_WARNING, errno, ap_server_conf, APLOGNO(00211) "sigaction(SIGHUP)");
 395     if (sigaction(SIGUSR1, &sa, NULL) < 0)
 396         ap_log_error(APLOG_MARK, APLOG_WARNING, errno, ap_server_conf, APLOGNO(00212) "sigaction(SIGUSR1)");
 397 }
 398
 399
 400
 401 /* Enquiry functions used get MPM status info */
 402
 403 static apr_status_t mpmt_os2_query(int query_code, int *result, apr_status_t *rv)
 404 {
 405     *rv = APR_SUCCESS;
 406
 407     switch (query_code) {
 408         case AP_MPMQ_MAX_DAEMON_USED:
 409             *result = ap_max_daemons_limit;
 410             break;
 411
 412         case AP_MPMQ_IS_THREADED:
 413             *result = AP_MPMQ_DYNAMIC;
 414             break;
 415
 416         case AP_MPMQ_IS_FORKED:
 417             *result = AP_MPMQ_NOT_SUPPORTED;
 418             break;
 419
 420         case AP_MPMQ_HARD_LIMIT_DAEMONS:
 421             *result = HARD_SERVER_LIMIT;
 422             break;
 423
 424         case AP_MPMQ_HARD_LIMIT_THREADS:
 425             *result = HARD_THREAD_LIMIT;
 426             break;
 427
 428         case AP_MPMQ_MIN_SPARE_DAEMONS:
 429             *result = 0;
 430             break;
 431
 432         case AP_MPMQ_MAX_SPARE_DAEMONS:
 433             *result = 0;
 434             break;
 435
 436         case AP_MPMQ_MAX_REQUESTS_DAEMON:
 437             *result = ap_max_requests_per_child;
 438             break;
 439
 440         case AP_MPMQ_GENERATION:
 441             *result = ap_my_generation;
 442             break;
 443
 444         default:
 445             *rv = APR_ENOTIMPL;
 446             break;
 447     }
 448
 449     return OK;
 450 }
 451
 452
 453
 454
 455 static const char *mpmt_os2_get_name(void)
 456 {
 457     return "mpmt_os2";
 458 }
 459
 460
 461
 462
 463 /* Configuration handling stuff */
 464
 465 static int mpmt_os2_pre_config(apr_pool_t *pconf, apr_pool_t *plog, apr_pool_t *ptemp)
 466 {
 467     one_process = ap_exists_config_define("ONE_PROCESS") ||
 468                   ap_exists_config_define("DEBUG");
 469     is_graceful = 0;
 470     ap_listen_pre_config();
 471     ap_daemons_to_start = DEFAULT_START_DAEMON;
 472     ap_thread_limit = HARD_THREAD_LIMIT;
 473     ap_extended_status = 0;
 474     ap_min_spare_threads = DEFAULT_MIN_SPARE_THREAD;
 475     ap_max_spare_threads = DEFAULT_MAX_SPARE_THREAD;
 476     ap_sys_privileges_handlers(1);
 477
 478     return OK;
 479 }
 480
 481
 482
 483 static int mpmt_os2_check_config(apr_pool_t *p, apr_pool_t *plog,
 484                                  apr_pool_t *ptemp, server_rec *s)
 485 {
 486     static int restart_num = 0;
 487     int startup = 0;
 488
 489     /* we want this only the first time around */
 490     if (restart_num++ == 0) {
 491         startup = 1;
 492     }
 493
 494     if (ap_daemons_to_start < 0) {
 495         if (startup) {
 496             ap_log_error(APLOG_MARK, APLOG_WARNING | APLOG_STARTUP, 0, NULL, APLOGNO(00213)
 497                          "WARNING: StartServers of %d not allowed, "
 498                          "increasing to 1.", ap_daemons_to_start);
 499         } else {
 500             ap_log_error(APLOG_MARK, APLOG_WARNING, 0, s, APLOGNO(00214)
 501                          "StartServers of %d not allowed, increasing to 1",
 502                          ap_daemons_to_start);
 503         }
 504         ap_daemons_to_start = 1;
 505     }
 506
 507     if (ap_min_spare_threads < 1) {
 508         if (startup) {
 509             ap_log_error(APLOG_MARK, APLOG_WARNING | APLOG_STARTUP, 0, NULL, APLOGNO(00215)
 510                          "WARNING: MinSpareThreads of %d not allowed, "
 511                          "increasing to 1 to avoid almost certain server failure. "
 512                          "Please read the documentation.", ap_min_spare_threads);
 513         } else {
 514             ap_log_error(APLOG_MARK, APLOG_WARNING, 0, s, APLOGNO(00216)
 515                          "MinSpareThreads of %d not allowed, increasing to 1",
 516                          ap_min_spare_threads);
 517         }
 518         ap_min_spare_threads = 1;
 519     }
 520
 521     return OK;
 522 }
 523
 524
 525
 526 static void mpmt_os2_hooks(apr_pool_t *p)
 527 {
 528     ap_hook_pre_config(mpmt_os2_pre_config, NULL, NULL, APR_HOOK_MIDDLE);
 529     ap_hook_check_config(mpmt_os2_check_config, NULL, NULL, APR_HOOK_MIDDLE);
 530     ap_hook_mpm(mpmt_os2_run, NULL, NULL, APR_HOOK_MIDDLE);
 531     ap_hook_mpm_query(mpmt_os2_query, NULL, NULL, APR_HOOK_MIDDLE);
 532     ap_hook_mpm_get_name(mpmt_os2_get_name, NULL, NULL, APR_HOOK_MIDDLE);
 533 }
 534
 535
 536
 537 static const char *set_daemons_to_start(cmd_parms *cmd, void *dummy, const char *arg)
 538 {
 539     const char *err = ap_check_cmd_context(cmd, GLOBAL_ONLY);
 540
 541     if (err != NULL) {
 542         return err;
 543     }
 544
 545     ap_daemons_to_start = atoi(arg);
 546     return NULL;
 547 }
 548
 549
 550
 551 static const char *set_min_spare_threads(cmd_parms *cmd, void *dummy,
 552                                          const char *arg)
 553 {
 554     const char *err = ap_check_cmd_context(cmd, GLOBAL_ONLY);
 555
 556     if (err != NULL) {
 557         return err;
 558     }
 559
 560     ap_min_spare_threads = atoi(arg);
 561     return NULL;
 562 }
 563
 564
 565
 566 static const char *set_max_spare_threads(cmd_parms *cmd, void *dummy,
 567                                          const char *arg)
 568 {
 569     const char *err = ap_check_cmd_context(cmd, GLOBAL_ONLY);
 570
 571     if (err != NULL) {
 572         return err;
 573     }
 574
 575     ap_max_spare_threads = atoi(arg);
 576     return NULL;
 577 }
 578
 579
 580
 581 static const char *ignore_cmd(cmd_parms *cmd, void *dummy, const char *arg)
 582 {
 583     return NULL;
 584 }
 585
 586
 587
 588 static const command_rec mpmt_os2_cmds[] = {
 589 LISTEN_COMMANDS,
 590 AP_INIT_TAKE1( "StartServers", set_daemons_to_start, NULL, RSRC_CONF,
 591   "Number of child processes launched at server startup" ),
 592 AP_INIT_TAKE1("MinSpareThreads", set_min_spare_threads, NULL, RSRC_CONF,
 593   "Minimum number of idle children, to handle request spikes"),
 594 AP_INIT_TAKE1("MaxSpareThreads", set_max_spare_threads, NULL, RSRC_CONF,
 595   "Maximum number of idle children"),
 596 AP_INIT_TAKE1("User", ignore_cmd, NULL, RSRC_CONF,
 597   "Not applicable on this platform"),
 598 AP_INIT_TAKE1("Group", ignore_cmd, NULL, RSRC_CONF,
 599   "Not applicable on this platform"),
 600 AP_INIT_TAKE1("ScoreBoardFile", ignore_cmd, NULL, RSRC_CONF, \
 601   "Not applicable on this platform"),
 602 { NULL }
 603 };
 604
 605 AP_DECLARE_MODULE(mpm_mpmt_os2) = {
 606     MPM20_MODULE_STUFF,
 607     NULL,            /* hook to run before apache parses args */
 608     NULL,            /* create per-directory config structure */
 609     NULL,            /* merge per-directory config structures */
 610     NULL,            /* create per-server config structure */
 611     NULL,            /* merge per-server config structures */
 612     mpmt_os2_cmds,   /* command apr_table_t */
 613     mpmt_os2_hooks,  /* register_hooks */
 614 };