From 4c5070798f51a79b4276f50531c0a39451c37f6d Mon Sep 17 00:00:00 2001
From: Jeff Trawick
Date: Sat, 13 Mar 2004 14:07:40 +0000
Subject: [PATCH] add docs for WorkerStackSize directive
git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@102948 13f79535-47bb-0310-9956-ffa450edef68
---
docs/manual/mod/directives.html.en | 1 +
docs/manual/mod/leader.html.en | 1 +
docs/manual/mod/leader.xml | 2 ++
docs/manual/mod/mpm_common.html.en | 45 ++++++++++++++++++++++++
docs/manual/mod/mpm_common.xml | 47 ++++++++++++++++++++++++++
docs/manual/mod/mpm_winnt.html.en | 1 +
docs/manual/mod/mpm_winnt.xml | 2 ++
docs/manual/mod/perchild.html.en | 1 +
docs/manual/mod/perchild.xml | 2 ++
docs/manual/mod/quickreference.html.en | 4 ++-
docs/manual/mod/threadpool.html.en | 1 +
docs/manual/mod/threadpool.xml | 2 ++
docs/manual/mod/worker.html.en | 1 +
docs/manual/mod/worker.xml | 2 ++
14 files changed, 111 insertions(+), 1 deletion(-)
diff --git a/docs/manual/mod/directives.html.en b/docs/manual/mod/directives.html.en
index 456c8682d9..5dcf6e2dcb 100644
--- a/docs/manual/mod/directives.html.en
+++ b/docs/manual/mod/directives.html.en
@@ -390,6 +390,7 @@
VirtualScriptAlias
VirtualScriptAliasIP
Win32DisableAcceptEx
+WorkerStackSize
XBitHack
diff --git a/docs/manual/mod/leader.xml b/docs/manual/mod/leader.xml
index cdc3783ef0..baa0195839 100644
--- a/docs/manual/mod/leader.xml
+++ b/docs/manual/mod/leader.xml
@@ -89,5 +89,7 @@ MPM
User
+WorkerStackSize
+
diff --git a/docs/manual/mod/mpm_common.html.en b/docs/manual/mod/mpm_common.html.en
index 843ec6cff7..a99a5eb7cf 100644
--- a/docs/manual/mod/mpm_common.html.en
+++ b/docs/manual/mod/mpm_common.html.en
@@ -51,6 +51,7 @@ more than one multi-processing module (MPM)
ThreadLimit
ThreadsPerChild
User
+
WorkerStackSize
@@ -827,6 +828,50 @@ requests
reasons.
+
+
+
+
+
The WorkerStackSize
directive sets the
+ size of the stack (for autodata) of threads which handle client
+ connections and call modules to help process those connections.
+ In most cases the operating system default for stack size is
+ reasonable, but there are some conditions where it may need to be
+ adjusted:
+
+
+ - On platforms with a relatively small default thread stack size
+ (e.g., HP-UX), Apache may crash when using some third-party modules
+ which use a relatively large amount of autodata storage. Those
+ same modules may have worked fine on other platforms where the
+ default thread stack size is larger. This type of crash is
+ resolved by setting
WorkerStackSize
to a
+ value higher than the operating system default. This type of
+ adjustment is necessary only if the provider of the third-party
+ module specifies that it is required, or if diagnosis of an Apache
+ crash indicates that the thread stack size was too small.
+
+ - On platforms where the default thread stack size is
+ significantly larger than necessary for the web server
+ configuration, a higher number of threads per child process
+ will be achievable if
WorkerStackSize
is
+ set to a value lower than the operating system default. This type
+ of adjustment should only be made in a test environment which allows
+ the full set of web server processing can be exercised, as there
+ may be infrequent requests which require more stack to process.
+ A change in the web server configuration can invalidate the
+ current WorkerStackSize
setting.
+
+
diff --git a/docs/manual/mod/mpm_common.xml b/docs/manual/mod/mpm_common.xml
index 476e63e4aa..634c415acc 100644
--- a/docs/manual/mod/mpm_common.xml
+++ b/docs/manual/mod/mpm_common.xml
@@ -866,4 +866,51 @@ requests
+
+WorkerStackSize
+The size in bytes of the stack used by threads handling
+client connections
+WorkerStackSize size
+varies by operating system
+server config
+leadermpm_winnt
+perchildthreadpool
+worker
+
+Available in Apache 2.1 and later
+
+
+ The WorkerStackSize directive sets the
+ size of the stack (for autodata) of threads which handle client
+ connections and call modules to help process those connections.
+ In most cases the operating system default for stack size is
+ reasonable, but there are some conditions where it may need to be
+ adjusted:
+
+
+ - On platforms with a relatively small default thread stack size
+ (e.g., HP-UX), Apache may crash when using some third-party modules
+ which use a relatively large amount of autodata storage. Those
+ same modules may have worked fine on other platforms where the
+ default thread stack size is larger. This type of crash is
+ resolved by setting WorkerStackSize to a
+ value higher than the operating system default. This type of
+ adjustment is necessary only if the provider of the third-party
+ module specifies that it is required, or if diagnosis of an Apache
+ crash indicates that the thread stack size was too small.
+
+ - On platforms where the default thread stack size is
+ significantly larger than necessary for the web server
+ configuration, a higher number of threads per child process
+ will be achievable if WorkerStackSize is
+ set to a value lower than the operating system default. This type
+ of adjustment should only be made in a test environment which allows
+ the full set of web server processing can be exercised, as there
+ may be infrequent requests which require more stack to process.
+ A change in the web server configuration can invalidate the
+ current WorkerStackSize setting.
+
+
+
+
diff --git a/docs/manual/mod/mpm_winnt.html.en b/docs/manual/mod/mpm_winnt.html.en
index 7d86bfb087..37af18f43f 100644
--- a/docs/manual/mod/mpm_winnt.html.en
+++ b/docs/manual/mod/mpm_winnt.html.en
@@ -50,6 +50,7 @@ NT.
ThreadLimit
ThreadsPerChild
Win32DisableAcceptEx
+
WorkerStackSize
diff --git a/docs/manual/mod/mpm_winnt.xml b/docs/manual/mod/mpm_winnt.xml
index 8f24444f45..ae2d996f6b 100644
--- a/docs/manual/mod/mpm_winnt.xml
+++ b/docs/manual/mod/mpm_winnt.xml
@@ -54,6 +54,8 @@ NT.
ThreadsPerChild
+WorkerStackSize
+
Win32DisableAcceptEx
diff --git a/docs/manual/mod/perchild.html.en b/docs/manual/mod/perchild.html.en
index c6e81de9fb..6f49656eae 100644
--- a/docs/manual/mod/perchild.html.en
+++ b/docs/manual/mod/perchild.html.en
@@ -63,6 +63,7 @@ requests to be assigned a variety of different userids
StartThreads
ThreadLimit
User
+
WorkerStackSize
Topics
diff --git a/docs/manual/mod/perchild.xml b/docs/manual/mod/perchild.xml
index 65fb79bd73..7efbf614b2 100644
--- a/docs/manual/mod/perchild.xml
+++ b/docs/manual/mod/perchild.xml
@@ -172,6 +172,8 @@ uses
User
+WorkerStackSize
+
AssignUserID
diff --git a/docs/manual/mod/quickreference.html.en b/docs/manual/mod/quickreference.html.en
index 67638b91fa..64593c1051 100644
--- a/docs/manual/mod/quickreference.html.en
+++ b/docs/manual/mod/quickreference.html.en
@@ -695,7 +695,9 @@ a given virtual host
VirtualScriptAliasIP interpolated-directory|none | none | sv | E |
Dynamically configure the location of the cgi directory for
a given virtual host |
Win32DisableAcceptEx | | s | M |
Use accept() rather than AcceptEx() to accept network connections |
-XBitHack on|off|full | off | svdh | B |
Parse SSI directives in files with the execute bit
+ |
WorkerStackSize size | | s | M |
The size in bytes of the stack used by threads handling
+client connections |
+XBitHack on|off|full | off | svdh | B |
Parse SSI directives in files with the execute bit
set |
diff --git a/docs/manual/mod/threadpool.xml b/docs/manual/mod/threadpool.xml
index 4d026449b3..7fcf070bfa 100644
--- a/docs/manual/mod/threadpool.xml
+++ b/docs/manual/mod/threadpool.xml
@@ -84,5 +84,7 @@
User
+WorkerStackSize
+
diff --git a/docs/manual/mod/worker.html.en b/docs/manual/mod/worker.html.en
index 47219929ef..cac9244ba0 100644
--- a/docs/manual/mod/worker.html.en
+++ b/docs/manual/mod/worker.html.en
@@ -67,6 +67,7 @@
ThreadLimit
ThreadsPerChild
User
+
WorkerStackSize
Topics
diff --git a/docs/manual/mod/worker.xml b/docs/manual/mod/worker.xml
index c579d404a0..58360f2a7c 100644
--- a/docs/manual/mod/worker.xml
+++ b/docs/manual/mod/worker.xml
@@ -175,5 +175,7 @@ uses
User
+WorkerStackSize
+
--
2.50.1