1 <?xml version="1.0" encoding="ISO-8859-1"?>
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
3 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head>
4 <meta content="text/html; charset=ISO-8859-1" http-equiv="Content-Type" />
6 XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
7 This file is generated from xml source: DO NOT EDIT
8 XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
10 <title>mod_so - Apache HTTP Server Version 2.5</title>
11 <link href="../style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
12 <link href="../style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
13 <link href="../style/css/manual-print.css" rel="stylesheet" media="print" type="text/css" /><link rel="stylesheet" type="text/css" href="../style/css/prettify.css" />
14 <script src="../style/scripts/prettify.min.js" type="text/javascript">
17 <link href="../images/favicon.ico" rel="shortcut icon" /></head>
19 <div id="page-header">
20 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/quickreference.html">Directives</a> | <a href="http://wiki.apache.org/httpd/FAQ">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p>
21 <p class="apache">Apache HTTP Server Version 2.5</p>
22 <img alt="" src="../images/feather.png" /></div>
23 <div class="up"><a href="./"><img title="<-" alt="<-" src="../images/left.gif" /></a></div>
25 <a href="http://www.apache.org/">Apache</a> > <a href="http://httpd.apache.org/">HTTP Server</a> > <a href="http://httpd.apache.org/docs/">Documentation</a> > <a href="../">Version 2.5</a> > <a href="./">Modules</a></div>
26 <div id="page-content">
27 <div id="preamble"><h1>Apache Module mod_so</h1>
29 <p><span>Available Languages: </span><a href="../en/mod/mod_so.html" title="English"> en </a> |
30 <a href="../fr/mod/mod_so.html" hreflang="fr" rel="alternate" title="Français"> fr </a> |
31 <a href="../ja/mod/mod_so.html" hreflang="ja" rel="alternate" title="Japanese"> ja </a> |
32 <a href="../ko/mod/mod_so.html" hreflang="ko" rel="alternate" title="Korean"> ko </a> |
33 <a href="../tr/mod/mod_so.html" hreflang="tr" rel="alternate" title="Türkçe"> tr </a></p>
35 <table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Loading of executable code and
36 modules into the server at start-up or restart time</td></tr>
37 <tr><th><a href="module-dict.html#Status">Status:</a></th><td>Extension</td></tr>
38 <tr><th><a href="module-dict.html#ModuleIdentifier">Module Identifier:</a></th><td>so_module</td></tr>
39 <tr><th><a href="module-dict.html#SourceFile">Source File:</a></th><td>mod_so.c</td></tr>
40 <tr><th><a href="module-dict.html#Compatibility">Compatibility:</a></th><td>This is a Base module (always included) on
41 Windows</td></tr></table>
45 <p>On selected operating systems this module can be used to
46 load modules into Apache HTTP Server at runtime via the <a href="../dso.html">Dynamic Shared Object</a> (DSO) mechanism,
47 rather than requiring a recompilation.</p>
49 <p>On Unix, the loaded code typically comes from shared object
50 files (usually with <code>.so</code> extension), on Windows
51 this may either be the <code>.so</code> or <code>.dll</code>
54 <div class="warning"><h3>Warning</h3>
55 <p>Modules built for one major version of the Apache HTTP Server
56 will generally not work on another. (e.g. 1.3 vs. 2.0, or 2.0 vs.
57 2.2) There are usually API changes between one major version and
58 another that require that modules be modified to work with the new
62 <div id="quickview"><h3>Topics</h3>
64 <li><img alt="" src="../images/down.gif" /> <a href="#windows">Creating Loadable Modules for Windows</a></li>
65 </ul><h3 class="directives">Directives</h3>
67 <li><img alt="" src="../images/down.gif" /> <a href="#loadfile">LoadFile</a></li>
68 <li><img alt="" src="../images/down.gif" /> <a href="#loadmodule">LoadModule</a></li>
70 <h3>Bugfix checklist</h3><ul class="seealso"><li><a href="https://www.apache.org/dist/httpd/CHANGES_2.4">httpd changelog</a></li><li><a href="https://bz.apache.org/bugzilla/buglist.cgi?bug_status=__open__&list_id=144532&product=Apache%20httpd-2&query_format=specific&order=changeddate%20DESC%2Cpriority%2Cbug_severity&component=mod_so">Known issues</a></li><li><a href="https://bz.apache.org/bugzilla/enter_bug.cgi?product=Apache%20httpd-2&component=mod_so">Report a bug</a></li></ul><h3>See also</h3>
72 <li><a href="#comments_section">Comments</a></li></ul></div>
73 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
75 <h2><a name="windows" id="windows">Creating Loadable Modules for Windows</a><a title="Permanent link" href="#windows" class="permalink">¶</a></h2>
77 <div class="note"><h3>Note</h3>
78 <p>On Windows, where loadable files typically have a file extension
79 of <code>.dll</code>, Apache httpd modules are called
80 <code>mod_whatever.so</code>, just as they are on other platforms.
81 However, you may encounter third-party modules, such as PHP for
82 example, that continue to use the <code>.dll</code> convention.</p>
84 <p>While <code>mod_so</code> still loads modules with
85 <code>ApacheModuleFoo.dll</code> names, the new naming convention is
86 preferred; if you are converting your loadable module for 2.0,
87 please fix the name to this 2.0 convention.</p></div>
89 <p>The Apache httpd module API is unchanged between the Unix and
90 Windows versions. Many modules will run on Windows with no or
91 little change from Unix, although others rely on aspects of the
92 Unix architecture which are not present in Windows, and will
95 <p>When a module does work, it can be added to the server in
96 one of two ways. As with Unix, it can be compiled into the
97 server. Because Apache httpd for Windows does not have the
98 <code>Configure</code> program of Apache httpd for Unix, the module's
99 source file must be added to the ApacheCore project file, and
100 its symbols must be added to the
101 <code>os\win32\modules.c</code> file.</p>
103 <p>The second way is to compile the module as a DLL, a shared
104 library that can be loaded into the server at runtime, using
105 the <code class="directive">LoadModule</code>
106 directive. These module DLLs can be distributed and run on any
107 Apache httpd for Windows installation, without recompilation of the
110 <p>To create a module DLL, a small change is necessary to the
111 module's source file: The module record must be exported from
112 the DLL (which will be created later; see below). To do this,
113 add the <code>AP_MODULE_DECLARE_DATA</code> (defined in the
114 Apache httpd header files) to your module's module record definition.
115 For example, if your module has:</p>
117 <div class="example"><p><code>
121 <p>Replace the above with:</p>
122 <div class="example"><p><code>
123 module AP_MODULE_DECLARE_DATA foo_module;
126 <p>Note that this will only be activated on Windows, so the
127 module can continue to be used, unchanged, with Unix if needed.
128 Also, if you are familiar with <code>.DEF</code> files, you can
129 export the module record with that method instead.</p>
131 <p>Now, create a DLL containing your module. You will need to
132 link this against the libhttpd.lib export library that is
133 created when the libhttpd.dll shared library is compiled. You
134 may also have to change the compiler settings to ensure that
135 the Apache httpd header files are correctly located. You can find
136 this library in your server root's modules directory. It is
137 best to grab an existing module .dsp file from the tree to
138 assure the build environment is configured correctly, or
139 alternately compare the compiler and link options to your
142 <p>This should create a DLL version of your module. Now simply
143 place it in the <code>modules</code> directory of your server
144 root, and use the <code class="directive">LoadModule</code>
145 directive to load it.</p>
148 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
149 <div class="directive-section"><h2><a name="LoadFile" id="LoadFile">LoadFile</a> <a name="loadfile" id="loadfile">Directive</a><a title="Permanent link" href="#loadfile" class="permalink">¶</a></h2>
150 <table class="directive">
151 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Link in the named object file or library</td></tr>
152 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LoadFile <em>filename</em> [<em>filename</em>] ...</code></td></tr>
153 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
154 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
155 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_so</td></tr>
158 <p>The <code class="directive">LoadFile</code> directive links in the named object files or
159 libraries when the server is started or restarted; this is used
160 to load additional code which may be required for some module
161 to work. <em>Filename</em> is either an absolute path or
162 relative to <a href="core.html#serverroot">ServerRoot</a>.</p>
166 <pre class="prettyprint lang-config">LoadFile "libexec/libxmlparse.so"</pre>
171 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
172 <div class="directive-section"><h2><a name="LoadModule" id="LoadModule">LoadModule</a> <a name="loadmodule" id="loadmodule">Directive</a><a title="Permanent link" href="#loadmodule" class="permalink">¶</a></h2>
173 <table class="directive">
174 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Links in the object file or library, and adds to the list
175 of active modules</td></tr>
176 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LoadModule <em>module filename</em></code></td></tr>
177 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
178 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
179 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_so</td></tr>
181 <p>The <code class="directive">LoadModule</code> directive links in the object file or library
182 <em>filename</em> and adds the module structure named
183 <em>module</em> to the list of active modules. <em>Module</em>
184 is the name of the external variable of type
185 <code>module</code> in the file, and is listed as the <a href="module-dict.html#ModuleIdentifier">Module Identifier</a>
186 in the module documentation.</p>
190 <pre class="prettyprint lang-config">LoadModule status_module "modules/mod_status.so"</pre>
193 <p>loads the named module from the modules subdirectory of the
198 <div class="bottomlang">
199 <p><span>Available Languages: </span><a href="../en/mod/mod_so.html" title="English"> en </a> |
200 <a href="../fr/mod/mod_so.html" hreflang="fr" rel="alternate" title="Français"> fr </a> |
201 <a href="../ja/mod/mod_so.html" hreflang="ja" rel="alternate" title="Japanese"> ja </a> |
202 <a href="../ko/mod/mod_so.html" hreflang="ko" rel="alternate" title="Korean"> ko </a> |
203 <a href="../tr/mod/mod_so.html" hreflang="tr" rel="alternate" title="Türkçe"> tr </a></p>
204 </div><div class="top"><a href="#page-header"><img src="../images/up.gif" alt="top" /></a></div><div class="section"><h2><a id="comments_section" name="comments_section">Comments</a></h2><div class="warning"><strong>Notice:</strong><br />This is not a Q&A section. Comments placed here should be pointed towards suggestions on improving the documentation or server, and may be removed again by our moderators if they are either implemented or considered invalid/off-topic. Questions on how to manage the Apache HTTP Server should be directed at either our IRC channel, #httpd, on Freenode, or sent to our <a href="http://httpd.apache.org/lists.html">mailing lists</a>.</div>
205 <script type="text/javascript"><!--//--><![CDATA[//><!--
206 var comments_shortname = 'httpd';
207 var comments_identifier = 'http://httpd.apache.org/docs/trunk/mod/mod_so.html';
209 if (w.location.hostname.toLowerCase() == "httpd.apache.org") {
210 d.write('<div id="comments_thread"><\/div>');
211 var s = d.createElement('script');
212 s.type = 'text/javascript';
214 s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier;
215 (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s);
218 d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>');
220 })(window, document);
221 //--><!]]></script></div><div id="footer">
222 <p class="apache">Copyright 2018 The Apache Software Foundation.<br />Licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.</p>
223 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/quickreference.html">Directives</a> | <a href="http://wiki.apache.org/httpd/FAQ">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p></div><script type="text/javascript"><!--//--><![CDATA[//><!--
224 if (typeof(prettyPrint) !== 'undefined') {