You are viewing a plain text version of this content. The canonical link for it is here.
Posted to cvs@httpd.apache.org by tr...@apache.org on 2004/03/13 15:07:40 UTC
cvs commit: httpd-2.0/docs/manual/mod directives.html.en leader.html.en leader.xml mpm_common.html.en mpm_common.xml mpm_winnt.html.en mpm_winnt.xml perchild.html.en perchild.xml quickreference.html.en threadpool.html.en worker.html.en threadpool.xml worker.xml
trawick 2004/03/13 06:07:40
Modified: docs/manual/mod directives.html.en leader.html.en leader.xml
mpm_common.html.en mpm_common.xml mpm_winnt.html.en
mpm_winnt.xml perchild.html.en perchild.xml
quickreference.html.en threadpool.html.en
worker.html.en threadpool.xml worker.xml
Log:
add docs for WorkerStackSize directive
Revision Changes Path
1.57 +1 -0 httpd-2.0/docs/manual/mod/directives.html.en
Index: directives.html.en
===================================================================
RCS file: /home/cvs/httpd-2.0/docs/manual/mod/directives.html.en,v
retrieving revision 1.56
retrieving revision 1.57
diff -u -r1.56 -r1.57
--- directives.html.en 21 Feb 2004 17:44:27 -0000 1.56
+++ directives.html.en 13 Mar 2004 14:07:40 -0000 1.57
@@ -390,6 +390,7 @@
<li><a href="mod_vhost_alias.html#virtualscriptalias">VirtualScriptAlias</a></li>
<li><a href="mod_vhost_alias.html#virtualscriptaliasip">VirtualScriptAliasIP</a></li>
<li><a href="mpm_winnt.html#win32disableacceptex" id="W" name="W">Win32DisableAcceptEx</a></li>
+<li><a href="mpm_common.html#workerstacksize">WorkerStackSize</a></li>
<li><a href="mod_include.html#xbithack" id="X" name="X">XBitHack</a></li>
</ul></div>
<div class="bottomlang">
1.10 +1 -0 httpd-2.0/docs/manual/mod/leader.html.en
Index: leader.html.en
===================================================================
RCS file: /home/cvs/httpd-2.0/docs/manual/mod/leader.html.en,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -r1.9 -r1.10
--- leader.html.en 21 Feb 2004 00:31:34 -0000 1.9
+++ leader.html.en 13 Mar 2004 14:07:40 -0000 1.10
@@ -74,6 +74,7 @@
<li><img alt="" src="../images/right.gif" /> <a href="mpm_common.html#threadlimit">ThreadLimit</a></li>
<li><img alt="" src="../images/right.gif" /> <a href="mpm_common.html#threadsperchild">ThreadsPerChild</a></li>
<li><img alt="" src="../images/right.gif" /> <a href="mpm_common.html#user">User</a></li>
+<li><img alt="" src="../images/right.gif" /> <a href="mpm_common.html#workerstacksize">WorkerStackSize</a></li>
</ul>
</div>
1.6 +2 -0 httpd-2.0/docs/manual/mod/leader.xml
Index: leader.xml
===================================================================
RCS file: /home/cvs/httpd-2.0/docs/manual/mod/leader.xml,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- leader.xml 9 Feb 2004 20:16:07 -0000 1.5
+++ leader.xml 13 Mar 2004 14:07:40 -0000 1.6
@@ -89,5 +89,7 @@
</directivesynopsis>
<directivesynopsis location="mpm_common"><name>User</name>
</directivesynopsis>
+<directivesynopsis location="mpm_common"><name>WorkerStackSize</name>
+</directivesynopsis>
</modulesynopsis>
1.42 +45 -0 httpd-2.0/docs/manual/mod/mpm_common.html.en
Index: mpm_common.html.en
===================================================================
RCS file: /home/cvs/httpd-2.0/docs/manual/mod/mpm_common.html.en,v
retrieving revision 1.41
retrieving revision 1.42
diff -u -r1.41 -r1.42
--- mpm_common.html.en 21 Feb 2004 00:31:37 -0000 1.41
+++ mpm_common.html.en 13 Mar 2004 14:07:40 -0000 1.42
@@ -51,6 +51,7 @@
<li><img alt="" src="../images/down.gif" /> <a href="#threadlimit">ThreadLimit</a></li>
<li><img alt="" src="../images/down.gif" /> <a href="#threadsperchild">ThreadsPerChild</a></li>
<li><img alt="" src="../images/down.gif" /> <a href="#user">User</a></li>
+<li><img alt="" src="../images/down.gif" /> <a href="#workerstacksize">WorkerStackSize</a></li>
</ul>
</div>
@@ -826,6 +827,50 @@
it is actually a no-op there and only exists for compatibility
reasons.</p>
</div>
+
+</div>
+<div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
+<div class="directive-section"><h2><a name="WorkerStackSize" id="WorkerStackSize">WorkerStackSize</a> <a name="workerstacksize" id="workerstacksize">Directive</a></h2>
+<table class="directive">
+<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>The size in bytes of the stack used by threads handling
+client connections</td></tr>
+<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>WorkerStackSize <var>size</var></code></td></tr>
+<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>varies by operating system</code></td></tr>
+<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
+<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>MPM</td></tr>
+<tr><th><a href="directive-dict.html#Module">Module:</a></th><td><code class="module"><a href="../mod/leader.html">leader</a></code>, <code class="module"><a href="../mod/mpm_winnt.html">mpm_winnt</a></code>, <code class="module"><a href="../mod/perchild.html">perchild</a></code>, <code class="module"><a href="../mod/threadpool.html">threadpool</a></code>, <code class="module"><a href="../mod/worker.html">worker</a></code></td></tr>
+<tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Available in Apache 2.1 and later</td></tr>
+</table>
+ <p>The <code class="directive">WorkerStackSize</code> 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:</p>
+
+ <ul>
+ <li>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 <code class="directive">WorkerStackSize</code> 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.</li>
+
+ <li>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 <code class="directive">WorkerStackSize</code> 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 <code class="directive">WorkerStackSize</code> setting.</li>
+ </ul>
</div>
</div>
1.36 +47 -0 httpd-2.0/docs/manual/mod/mpm_common.xml
Index: mpm_common.xml
===================================================================
RCS file: /home/cvs/httpd-2.0/docs/manual/mod/mpm_common.xml,v
retrieving revision 1.35
retrieving revision 1.36
diff -u -r1.35 -r1.36
--- mpm_common.xml 9 Feb 2004 20:16:08 -0000 1.35
+++ mpm_common.xml 13 Mar 2004 14:07:40 -0000 1.36
@@ -866,4 +866,51 @@
</usage>
</directivesynopsis>
+<directivesynopsis>
+<name>WorkerStackSize</name>
+<description>The size in bytes of the stack used by threads handling
+client connections</description>
+<syntax>WorkerStackSize <var>size</var></syntax>
+<default>varies by operating system</default>
+<contextlist><context>server config</context></contextlist>
+<modulelist><module>leader</module><module>mpm_winnt</module>
+<module>perchild</module><module>threadpool</module>
+<module>worker</module>
+</modulelist>
+<compatibility>Available in Apache 2.1 and later</compatibility>
+
+<usage>
+ <p>The <directive>WorkerStackSize</directive> 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:</p>
+
+ <ul>
+ <li>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 <directive>WorkerStackSize</directive> 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.</li>
+
+ <li>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 <directive>WorkerStackSize</directive> 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 <directive>WorkerStackSize</directive> setting.</li>
+ </ul>
+</usage>
+</directivesynopsis>
+
</modulesynopsis>
1.22 +1 -0 httpd-2.0/docs/manual/mod/mpm_winnt.html.en
Index: mpm_winnt.html.en
===================================================================
RCS file: /home/cvs/httpd-2.0/docs/manual/mod/mpm_winnt.html.en,v
retrieving revision 1.21
retrieving revision 1.22
diff -u -r1.21 -r1.22
--- mpm_winnt.html.en 9 Mar 2004 20:38:42 -0000 1.21
+++ mpm_winnt.html.en 13 Mar 2004 14:07:40 -0000 1.22
@@ -50,6 +50,7 @@
<li><img alt="" src="../images/right.gif" /> <a href="mpm_common.html#threadlimit">ThreadLimit</a></li>
<li><img alt="" src="../images/right.gif" /> <a href="mpm_common.html#threadsperchild">ThreadsPerChild</a></li>
<li><img alt="" src="../images/down.gif" /> <a href="#win32disableacceptex">Win32DisableAcceptEx</a></li>
+<li><img alt="" src="../images/right.gif" /> <a href="mpm_common.html#workerstacksize">WorkerStackSize</a></li>
</ul>
</div>
1.12 +2 -0 httpd-2.0/docs/manual/mod/mpm_winnt.xml
Index: mpm_winnt.xml
===================================================================
RCS file: /home/cvs/httpd-2.0/docs/manual/mod/mpm_winnt.xml,v
retrieving revision 1.11
retrieving revision 1.12
diff -u -r1.11 -r1.12
--- mpm_winnt.xml 9 Mar 2004 20:38:42 -0000 1.11
+++ mpm_winnt.xml 13 Mar 2004 14:07:40 -0000 1.12
@@ -54,6 +54,8 @@
</directivesynopsis>
<directivesynopsis location="mpm_common"><name>ThreadsPerChild</name>
</directivesynopsis>
+<directivesynopsis location="mpm_common"><name>WorkerStackSize</name>
+</directivesynopsis>
<directivesynopsis>
<name>Win32DisableAcceptEx</name>
1.25 +1 -0 httpd-2.0/docs/manual/mod/perchild.html.en
Index: perchild.html.en
===================================================================
RCS file: /home/cvs/httpd-2.0/docs/manual/mod/perchild.html.en,v
retrieving revision 1.24
retrieving revision 1.25
diff -u -r1.24 -r1.25
--- perchild.html.en 21 Feb 2004 00:31:37 -0000 1.24
+++ perchild.html.en 13 Mar 2004 14:07:40 -0000 1.25
@@ -63,6 +63,7 @@
<li><img alt="" src="../images/right.gif" /> <a href="mpm_common.html#startthreads">StartThreads</a></li>
<li><img alt="" src="../images/right.gif" /> <a href="mpm_common.html#threadlimit">ThreadLimit</a></li>
<li><img alt="" src="../images/right.gif" /> <a href="mpm_common.html#user">User</a></li>
+<li><img alt="" src="../images/right.gif" /> <a href="mpm_common.html#workerstacksize">WorkerStackSize</a></li>
</ul>
<h3>Topics</h3>
<ul id="topics">
1.12 +2 -0 httpd-2.0/docs/manual/mod/perchild.xml
Index: perchild.xml
===================================================================
RCS file: /home/cvs/httpd-2.0/docs/manual/mod/perchild.xml,v
retrieving revision 1.11
retrieving revision 1.12
diff -u -r1.11 -r1.12
--- perchild.xml 9 Feb 2004 20:16:08 -0000 1.11
+++ perchild.xml 13 Mar 2004 14:07:40 -0000 1.12
@@ -172,6 +172,8 @@
</directivesynopsis>
<directivesynopsis location="mpm_common"><name>User</name>
</directivesynopsis>
+<directivesynopsis location="mpm_common"><name>WorkerStackSize</name>
+</directivesynopsis>
<directivesynopsis>
<name>AssignUserID</name>
1.106 +3 -1 httpd-2.0/docs/manual/mod/quickreference.html.en
Index: quickreference.html.en
===================================================================
RCS file: /home/cvs/httpd-2.0/docs/manual/mod/quickreference.html.en,v
retrieving revision 1.105
retrieving revision 1.106
diff -u -r1.105 -r1.106
--- quickreference.html.en 9 Mar 2004 20:38:42 -0000 1.105
+++ quickreference.html.en 13 Mar 2004 14:07:40 -0000 1.106
@@ -695,7 +695,9 @@
<tr><td><a href="mod_vhost_alias.html#virtualscriptaliasip">VirtualScriptAliasIP <em>interpolated-directory</em>|none</a></td><td> none </td><td>sv</td><td>E</td></tr><tr><td class="descr" colspan="4">Dynamically configure the location of the cgi directory for
a given virtual host</td></tr>
<tr class="odd"><td><a href="mpm_winnt.html#win32disableacceptex" id="W" name="W">Win32DisableAcceptEx</a></td><td></td><td>s</td><td>M</td></tr><tr class="odd"><td class="descr" colspan="4">Use accept() rather than AcceptEx() to accept network connections</td></tr>
-<tr><td><a href="mod_include.html#xbithack" id="X" name="X">XBitHack on|off|full</a></td><td> off </td><td>svdh</td><td>B</td></tr><tr><td class="descr" colspan="4">Parse SSI directives in files with the execute bit
+<tr><td><a href="mpm_common.html#workerstacksize">WorkerStackSize <var>size</var></a></td><td></td><td>s</td><td>M</td></tr><tr><td class="descr" colspan="4">The size in bytes of the stack used by threads handling
+client connections</td></tr>
+<tr class="odd"><td><a href="mod_include.html#xbithack" id="X" name="X">XBitHack on|off|full</a></td><td> off </td><td>svdh</td><td>B</td></tr><tr class="odd"><td class="descr" colspan="4">Parse SSI directives in files with the execute bit
set</td></tr>
</table></div>
<div class="bottomlang">
1.7 +1 -0 httpd-2.0/docs/manual/mod/threadpool.html.en
Index: threadpool.html.en
===================================================================
RCS file: /home/cvs/httpd-2.0/docs/manual/mod/threadpool.html.en,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- threadpool.html.en 21 Feb 2004 00:31:39 -0000 1.6
+++ threadpool.html.en 13 Mar 2004 14:07:40 -0000 1.7
@@ -67,6 +67,7 @@
<li><img alt="" src="../images/right.gif" /> <a href="mpm_common.html#threadlimit">ThreadLimit</a></li>
<li><img alt="" src="../images/right.gif" /> <a href="mpm_common.html#threadsperchild">ThreadsPerChild</a></li>
<li><img alt="" src="../images/right.gif" /> <a href="mpm_common.html#user">User</a></li>
+<li><img alt="" src="../images/right.gif" /> <a href="mpm_common.html#workerstacksize">WorkerStackSize</a></li>
</ul>
</div>
1.26 +1 -0 httpd-2.0/docs/manual/mod/worker.html.en
Index: worker.html.en
===================================================================
RCS file: /home/cvs/httpd-2.0/docs/manual/mod/worker.html.en,v
retrieving revision 1.25
retrieving revision 1.26
diff -u -r1.25 -r1.26
--- worker.html.en 21 Feb 2004 00:31:39 -0000 1.25
+++ worker.html.en 13 Mar 2004 14:07:40 -0000 1.26
@@ -67,6 +67,7 @@
<li><img alt="" src="../images/right.gif" /> <a href="mpm_common.html#threadlimit">ThreadLimit</a></li>
<li><img alt="" src="../images/right.gif" /> <a href="mpm_common.html#threadsperchild">ThreadsPerChild</a></li>
<li><img alt="" src="../images/right.gif" /> <a href="mpm_common.html#user">User</a></li>
+<li><img alt="" src="../images/right.gif" /> <a href="mpm_common.html#workerstacksize">WorkerStackSize</a></li>
</ul>
<h3>Topics</h3>
<ul id="topics">
1.5 +2 -0 httpd-2.0/docs/manual/mod/threadpool.xml
Index: threadpool.xml
===================================================================
RCS file: /home/cvs/httpd-2.0/docs/manual/mod/threadpool.xml,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- threadpool.xml 9 Feb 2004 20:16:08 -0000 1.4
+++ threadpool.xml 13 Mar 2004 14:07:40 -0000 1.5
@@ -84,5 +84,7 @@
</directivesynopsis>
<directivesynopsis location="mpm_common"><name>User</name>
</directivesynopsis>
+<directivesynopsis location="mpm_common"><name>WorkerStackSize</name>
+</directivesynopsis>
</modulesynopsis>
1.15 +2 -0 httpd-2.0/docs/manual/mod/worker.xml
Index: worker.xml
===================================================================
RCS file: /home/cvs/httpd-2.0/docs/manual/mod/worker.xml,v
retrieving revision 1.14
retrieving revision 1.15
diff -u -r1.14 -r1.15
--- worker.xml 9 Feb 2004 20:16:08 -0000 1.14
+++ worker.xml 13 Mar 2004 14:07:40 -0000 1.15
@@ -175,5 +175,7 @@
</directivesynopsis>
<directivesynopsis location="mpm_common"><name>User</name>
</directivesynopsis>
+<directivesynopsis location="mpm_common"><name>WorkerStackSize</name>
+</directivesynopsis>
</modulesynopsis>