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 XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX 5 This file is generated from xml source: DO NOT EDIT 6 XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX 7 --> 8<title>mod_so - Apache HTTP Server</title> 9<link href="/style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" /> 10<link href="/style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" /> 11<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" /> 12<script src="/style/scripts/prettify.min.js" type="text/javascript"> 13</script> 14 15<link href="/images/favicon.ico" rel="shortcut icon" /></head> 16<body> 17<div id="page-header"> 18<p class="menu"><a href="/mod/">Modules</a> | <a href="/mod/directives.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> 19<p class="apache">Apache HTTP Server Version 2.4</p> 20<img alt="" src="/images/feather.gif" /></div> 21<div class="up"><a href="./"><img title="<-" alt="<-" src="/images/left.gif" /></a></div> 22<div id="path"> 23<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.4</a> > <a href="./">Modules</a></div> 24<div id="page-content"> 25<div id="preamble"><h1>Apache Module mod_so</h1> 26<div class="toplang"> 27<p><span>Available Languages: </span><a href="/en/mod/mod_so.html" title="English"> en </a> | 28<a href="/fr/mod/mod_so.html" hreflang="fr" rel="alternate" title="Fran�ais"> fr </a> | 29<a href="/ja/mod/mod_so.html" hreflang="ja" rel="alternate" title="Japanese"> ja </a> | 30<a href="/ko/mod/mod_so.html" hreflang="ko" rel="alternate" title="Korean"> ko </a> | 31<a href="/tr/mod/mod_so.html" hreflang="tr" rel="alternate" title="T�rk�e"> tr </a></p> 32</div> 33<table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Loading of executable code and 34modules into the server at start-up or restart time</td></tr> 35<tr><th><a href="module-dict.html#Status">Status:</a></th><td>Extension</td></tr> 36<tr><th><a href="module-dict.html#ModuleIdentifier">Module�Identifier:</a></th><td>so_module</td></tr> 37<tr><th><a href="module-dict.html#SourceFile">Source�File:</a></th><td>mod_so.c</td></tr> 38<tr><th><a href="module-dict.html#Compatibility">Compatibility:</a></th><td>This is a Base module (always included) on 39Windows</td></tr></table> 40<h3>Summary</h3> 41 42 43 <p>On selected operating systems this module can be used to 44 load modules into Apache HTTP Server at runtime via the <a href="/dso.html">Dynamic Shared Object</a> (DSO) mechanism, 45 rather than requiring a recompilation.</p> 46 47 <p>On Unix, the loaded code typically comes from shared object 48 files (usually with <code>.so</code> extension), on Windows 49 this may either the <code>.so</code> or <code>.dll</code> 50 extension.</p> 51 52 <div class="warning"><h3>Warning</h3> 53 <p>Modules built for one major version of the Apache HTTP Server 54 will generally not work on another. (e.g. 1.3 vs. 2.0, or 2.0 vs. 55 2.2) There are usually API changes between one major version and 56 another that require that modules be modified to work with the new 57 version.</p> 58 </div> 59</div> 60<div id="quickview"><h3 class="directives">Directives</h3> 61<ul id="toc"> 62<li><img alt="" src="/images/down.gif" /> <a href="#loadfile">LoadFile</a></li> 63<li><img alt="" src="/images/down.gif" /> <a href="#loadmodule">LoadModule</a></li> 64</ul> 65<h3>Topics</h3> 66<ul id="topics"> 67<li><img alt="" src="/images/down.gif" /> <a href="#windows">Creating Loadable Modules for Windows</a></li> 68</ul><ul class="seealso"><li><a href="#comments_section">Comments</a></li></ul></div> 69<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div> 70<div class="section"> 71<h2><a name="windows" id="windows">Creating Loadable Modules for Windows</a></h2> 72 73 <div class="note"><h3>Note</h3> 74 <p>On Windows, where loadable files typically have a file extension 75 of <code>.dll</code>, Apache httpd modules are called 76 <code>mod_whatever.so</code>, just as they are on other platforms. 77 However, you may encounter third-party modules, such as PHP for 78 example, that continue to use the <code>.dll</code> convention.</p> 79 80 <p>While <code>mod_so</code> still loads modules with 81 <code>ApacheModuleFoo.dll</code> names, the new naming convention is 82 preferred; if you are converting your loadable module for 2.0, 83 please fix the name to this 2.0 convention.</p></div> 84 85 <p>The Apache httpd module API is unchanged between the Unix and 86 Windows versions. Many modules will run on Windows with no or 87 little change from Unix, although others rely on aspects of the 88 Unix architecture which are not present in Windows, and will 89 not work.</p> 90 91 <p>When a module does work, it can be added to the server in 92 one of two ways. As with Unix, it can be compiled into the 93 server. Because Apache httpd for Windows does not have the 94 <code>Configure</code> program of Apache httpd for Unix, the module's 95 source file must be added to the ApacheCore project file, and 96 its symbols must be added to the 97 <code>os\win32\modules.c</code> file.</p> 98 99 <p>The second way is to compile the module as a DLL, a shared 100 library that can be loaded into the server at runtime, using 101 the <code><code class="directive">LoadModule</code></code> 102 directive. These module DLLs can be distributed and run on any 103 Apache httpd for Windows installation, without recompilation of the 104 server.</p> 105 106 <p>To create a module DLL, a small change is necessary to the 107 module's source file: The module record must be exported from 108 the DLL (which will be created later; see below). To do this, 109 add the <code>AP_MODULE_DECLARE_DATA</code> (defined in the 110 Apache httpd header files) to your module's module record definition. 111 For example, if your module has:</p> 112 113<div class="example"><p><code> 114 module foo_module; 115</code></p></div> 116 117 <p>Replace the above with:</p> 118<div class="example"><p><code> 119 module AP_MODULE_DECLARE_DATA foo_module; 120</code></p></div> 121 122 <p>Note that this will only be activated on Windows, so the 123 module can continue to be used, unchanged, with Unix if needed. 124 Also, if you are familiar with <code>.DEF</code> files, you can 125 export the module record with that method instead.</p> 126 127 <p>Now, create a DLL containing your module. You will need to 128 link this against the libhttpd.lib export library that is 129 created when the libhttpd.dll shared library is compiled. You 130 may also have to change the compiler settings to ensure that 131 the Apache httpd header files are correctly located. You can find 132 this library in your server root's modules directory. It is 133 best to grab an existing module .dsp file from the tree to 134 assure the build environment is configured correctly, or 135 alternately compare the compiler and link options to your 136 .dsp.</p> 137 138 <p>This should create a DLL version of your module. Now simply 139 place it in the <code>modules</code> directory of your server 140 root, and use the <code class="directive">LoadModule</code> 141 directive to load it.</p> 142 143</div> 144<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div> 145<div class="directive-section"><h2><a name="LoadFile" id="LoadFile">LoadFile</a> <a name="loadfile" id="loadfile">Directive</a></h2> 146<table class="directive"> 147<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Link in the named object file or library</td></tr> 148<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LoadFile <em>filename</em> [<em>filename</em>] ...</code></td></tr> 149<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr> 150<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr> 151<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_so</td></tr> 152</table> 153 154 <p>The LoadFile directive links in the named object files or 155 libraries when the server is started or restarted; this is used 156 to load additional code which may be required for some module 157 to work. <em>Filename</em> is either an absolute path or 158 relative to <a href="core.html#serverroot">ServerRoot</a>.</p> 159 160 <p>For example:</p> 161 162 <pre class="prettyprint lang-config">LoadFile libexec/libxmlparse.so</pre> 163 164 165 166</div> 167<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div> 168<div class="directive-section"><h2><a name="LoadModule" id="LoadModule">LoadModule</a> <a name="loadmodule" id="loadmodule">Directive</a></h2> 169<table class="directive"> 170<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Links in the object file or library, and adds to the list 171of active modules</td></tr> 172<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>LoadModule <em>module filename</em></code></td></tr> 173<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr> 174<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr> 175<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_so</td></tr> 176</table> 177 <p>The LoadModule directive links in the object file or library 178 <em>filename</em> and adds the module structure named 179 <em>module</em> to the list of active modules. <em>Module</em> 180 is the name of the external variable of type 181 <code>module</code> in the file, and is listed as the <a href="module-dict.html#ModuleIdentifier">Module Identifier</a> 182 in the module documentation. Example:</p> 183 184 <pre class="prettyprint lang-config">LoadModule status_module modules/mod_status.so</pre> 185 186 187 <p>loads the named module from the modules subdirectory of the 188 ServerRoot.</p> 189 190</div> 191</div> 192<div class="bottomlang"> 193<p><span>Available Languages: </span><a href="/en/mod/mod_so.html" title="English"> en </a> | 194<a href="/fr/mod/mod_so.html" hreflang="fr" rel="alternate" title="Fran�ais"> fr </a> | 195<a href="/ja/mod/mod_so.html" hreflang="ja" rel="alternate" title="Japanese"> ja </a> | 196<a href="/ko/mod/mod_so.html" hreflang="ko" rel="alternate" title="Korean"> ko </a> | 197<a href="/tr/mod/mod_so.html" hreflang="tr" rel="alternate" title="T�rk�e"> tr </a></p> 198</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> 199<script type="text/javascript"><!--//--><![CDATA[//><!-- 200var comments_shortname = 'httpd'; 201var comments_identifier = 'http://httpd.apache.org/docs/2.4/mod/mod_so.html'; 202(function(w, d) { 203 if (w.location.hostname.toLowerCase() == "httpd.apache.org") { 204 d.write('<div id="comments_thread"><\/div>'); 205 var s = d.createElement('script'); 206 s.type = 'text/javascript'; 207 s.async = true; 208 s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier; 209 (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s); 210 } 211 else { 212 d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>'); 213 } 214})(window, document); 215//--><!]]></script></div><div id="footer"> 216<p class="apache">Copyright 2014 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> 217<p class="menu"><a href="/mod/">Modules</a> | <a href="/mod/directives.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[//><!-- 218if (typeof(prettyPrint) !== 'undefined') { 219 prettyPrint(); 220} 221//--><!]]></script> 222</body></html>
