Use correct Doxygen keywords for functions and variables. TODO: figure out whether...

[apache] / include / scoreboard.h

diff --git a/include/scoreboard.h b/include/scoreboard.h
index beb75e513a28b69c98a3ca8cf6b61a874c506f5c..fc9fadf7ffd0ce98b80ac7b2fe073333fc38bb11 100644 (file)
--- a/include/scoreboard.h
+++ b/include/scoreboard.h
@@ -1,8 +1,9 @@
-/* Copyright 2001-2004 The Apache Software Foundation
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
+/* Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
  *
  *     http://www.apache.org/licenses/LICENSE-2.0
  *
@@ -13,6 +14,11 @@
  * limitations under the License.
  */
 
+/**
+ * @file  scoreboard.h
+ * @brief Apache scoreboard library
+ */
+
 #ifndef APACHE_SCOREBOARD_H
 #define APACHE_SCOREBOARD_H
 
@@ -32,6 +38,7 @@ extern "C" {
 #include "apr_thread_proc.h"
 #include "apr_portable.h"
 #include "apr_shm.h"
+#include "apr_optional.h"
 
 /* Scoreboard file, if there is one */
 #ifndef DEFAULT_SCOREBOARD
@@ -80,23 +87,20 @@ typedef enum {
     SB_SHARED = 2
 } ap_scoreboard_e;
 
-#define SB_WORKING  0  /* The server is busy and the child is useful. */
-#define SB_IDLE_DIE 1  /* The server is idle and the child is superfluous. */
-                       /*   The child should check for this and exit gracefully. */
-
 /* stuff which is worker specific */
-/***********************WARNING***************************************/
-/* These are things that are used by mod_status. Do not put anything */
-/*   in here that you cannot live without. This structure will not   */
-/*   be available if mod_status is not loaded.                       */
-/*********************************************************************/
 typedef struct worker_score worker_score;
-
 struct worker_score {
     int thread_num;
 #if APR_HAS_THREADS
     apr_os_thread_t tid;
 #endif
+    /* With some MPMs (e.g., worker), a worker_score can represent
+     * a thread in a terminating process which is no longer
+     * represented by the corresponding process_score.  These MPMs
+     * should set pid and generation fields in the worker_score.
+     */
+    pid_t pid;
+    ap_generation_t generation;
     unsigned char status;
     unsigned long access_count;
     apr_off_t     bytes_served;
@@ -119,14 +123,16 @@ typedef struct {
     int             server_limit;
     int             thread_limit;
     ap_scoreboard_e sb_type;
-    ap_generation_t running_generation;        /* the generation of children which
-                                         * should still be serving requests. */
+    ap_generation_t running_generation; /* the generation of children which
+                                         * should still be serving requests.
+                                         */
     apr_time_t restart_time;
+    int             lb_limit;
 } global_score;
 
 /* stuff which the parent generally writes and the children rarely read */
 typedef struct process_score process_score;
-struct process_score{
+struct process_score {
     pid_t pid;
     ap_generation_t generation;        /* generation of this child */
     ap_scoreboard_e sb_type;
@@ -135,6 +141,13 @@ struct process_score{
                              */
 };
 
+/* stuff which is lb specific */
+typedef struct lb_score lb_score;
+struct lb_score {
+    /* TODO: make a real stuct from this */
+    unsigned char data[1024];
+};
+
 /* Scoreboard is now in 'local' memory, since it isn't updated once created,
  * even in forked architectures.  Child created-processes (non-fork) will
  * set up these indicies into the (possibly relocated) shmem records.
@@ -143,6 +156,7 @@ typedef struct {
     global_score *global;
     process_score *parent;
     worker_score **servers;
+    lb_score     *balancers;
 } scoreboard;
 
 typedef struct ap_sb_handle_t ap_sb_handle_t;
@@ -159,15 +173,16 @@ apr_status_t ap_cleanup_scoreboard(void *d);
 AP_DECLARE(void) ap_create_sb_handle(ap_sb_handle_t **new_sbh, apr_pool_t *p,
                                      int child_num, int thread_num);
     
-AP_DECLARE(int) find_child_by_pid(apr_proc_t *pid);
+int find_child_by_pid(apr_proc_t *pid);
 AP_DECLARE(int) ap_update_child_status(ap_sb_handle_t *sbh, int status, request_rec *r);
 AP_DECLARE(int) ap_update_child_status_from_indexes(int child_num, int thread_num,
                                                     int status, request_rec *r);
-void ap_time_process_request(int child_num, int thread_num, int status);
+void ap_time_process_request(ap_sb_handle_t *sbh, int status);
 
 AP_DECLARE(worker_score *) ap_get_scoreboard_worker(int x, int y);
 AP_DECLARE(process_score *) ap_get_scoreboard_process(int x);
 AP_DECLARE(global_score *) ap_get_scoreboard_global(void);
+AP_DECLARE(lb_score *) ap_get_scoreboard_lb(int lb_num);
 
 AP_DECLARE_DATA extern scoreboard *ap_scoreboard_image;
 AP_DECLARE_DATA extern const char *ap_scoreboard_fname;
@@ -185,6 +200,13 @@ AP_DECLARE_DATA extern ap_generation_t volatile ap_my_generation;
   */  
 AP_DECLARE_HOOK(int, pre_mpm, (apr_pool_t *p, ap_scoreboard_e sb_type))
 
+/**
+  * proxy load balancer
+  * @return the number of load balancer workers.
+  */  
+APR_DECLARE_OPTIONAL_FN(int, ap_proxy_lb_workers,
+                        (void));
+
 /* for time_process_request() in http_main.c */
 #define START_PREQUEST 1
 #define STOP_PREQUEST  2