thread_safety.html.en revision 5effc8b39fae5cd169d17f342bfc265705840014
59879db9d12c2ea10f77b2c44d6d3aba89bb9cb3slive<?xml version="1.0" encoding="ISO-8859-1"?>
59879db9d12c2ea10f77b2c44d6d3aba89bb9cb3slive<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
59879db9d12c2ea10f77b2c44d6d3aba89bb9cb3slive<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><!--
59879db9d12c2ea10f77b2c44d6d3aba89bb9cb3slive XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
59879db9d12c2ea10f77b2c44d6d3aba89bb9cb3slive This file is generated from xml source: DO NOT EDIT
59879db9d12c2ea10f77b2c44d6d3aba89bb9cb3slive XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
5a58787efeb02a1c3f06569d019ad81fd2efa06end -->
5a58787efeb02a1c3f06569d019ad81fd2efa06end<title>Apache 2.0 Thread Safety Issues - Apache HTTP Server</title>
5a58787efeb02a1c3f06569d019ad81fd2efa06end<link href="/style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
5a58787efeb02a1c3f06569d019ad81fd2efa06end<link href="/style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
5a58787efeb02a1c3f06569d019ad81fd2efa06end<link href="/style/css/manual-print.css" rel="stylesheet" media="print" type="text/css" />
5a58787efeb02a1c3f06569d019ad81fd2efa06end<link href="/images/favicon.ico" rel="shortcut icon" /></head>
00c2cccc28f249fb3b968ddf3e05508595290d40nd<body id="manual-page"><div id="page-header">
5a58787efeb02a1c3f06569d019ad81fd2efa06end<p class="menu"><a href="/mod/">Modules</a> | <a href="/mod/directives.html">Directives</a> | <a href="/faq/">FAQ</a> | <a href="/glossary.html">Glossary</a> | <a href="/sitemap.html">Sitemap</a></p>
5a58787efeb02a1c3f06569d019ad81fd2efa06end<p class="apache">Apache HTTP Server Version 2.5</p>
5a58787efeb02a1c3f06569d019ad81fd2efa06end<img alt="" src="/images/feather.gif" /></div>
5a58787efeb02a1c3f06569d019ad81fd2efa06end<div class="up"><a href="./"><img title="&lt;-" alt="&lt;-" src="/images/left.gif" /></a></div>
5a58787efeb02a1c3f06569d019ad81fd2efa06end<div id="path">
5a58787efeb02a1c3f06569d019ad81fd2efa06end<a href="http://www.apache.org/">Apache</a> &gt; <a href="http://httpd.apache.org/">HTTP Server</a> &gt; <a href="http://httpd.apache.org/docs/">Documentation</a> &gt; <a href="../">Version 2.5</a> &gt; <a href="./">Developer Documentation</a></div><div id="page-content"><div id="preamble"><h1>Apache 2.0 Thread Safety Issues</h1>
3b3b7fc78d1f5bfc2769903375050048ff41ff26nd<div class="toplang">
5652dbe450e4fcfdf36d4cfb42d7f2345ded29a4maczniak<p><span>Available Languages: </span><a href="/en/developer/thread_safety.html" title="English">&nbsp;en&nbsp;</a></p>
5652dbe450e4fcfdf36d4cfb42d7f2345ded29a4maczniak</div>
3b3b7fc78d1f5bfc2769903375050048ff41ff26nd
3b3b7fc78d1f5bfc2769903375050048ff41ff26nd <p>When using any of the threaded mpms in Apache 2.0 it is important
59879db9d12c2ea10f77b2c44d6d3aba89bb9cb3slive that every function called from Apache be thread safe. When linking in 3rd
59879db9d12c2ea10f77b2c44d6d3aba89bb9cb3slive party extensions it can be difficult to determine whether the resulting
59879db9d12c2ea10f77b2c44d6d3aba89bb9cb3slive server will be thread safe. Casual testing generally won't tell you this
59879db9d12c2ea10f77b2c44d6d3aba89bb9cb3slive either as thread safety problems can lead to subtle race conditons that
7449c2bb2dd95f8d0dd1b3ede8b56a0e26cc0fa6nd may only show up in certain conditions under heavy load.</p>
7449c2bb2dd95f8d0dd1b3ede8b56a0e26cc0fa6nd</div>
7449c2bb2dd95f8d0dd1b3ede8b56a0e26cc0fa6nd<div id="quickview"><ul id="toc"><li><img alt="" src="/images/down.gif" /> <a href="#variables">Global and static variables</a></li>
7449c2bb2dd95f8d0dd1b3ede8b56a0e26cc0fa6nd<li><img alt="" src="/images/down.gif" /> <a href="#errno">errno</a></li>
7449c2bb2dd95f8d0dd1b3ede8b56a0e26cc0fa6nd<li><img alt="" src="/images/down.gif" /> <a href="#functions">Common standard troublesome functions</a></li>
7449c2bb2dd95f8d0dd1b3ede8b56a0e26cc0fa6nd<li><img alt="" src="/images/down.gif" /> <a href="#commonlibs">Common 3rd Party Libraries</a></li>
7449c2bb2dd95f8d0dd1b3ede8b56a0e26cc0fa6nd<li><img alt="" src="/images/down.gif" /> <a href="#liblist">Library List</a></li>
59879db9d12c2ea10f77b2c44d6d3aba89bb9cb3slive</ul></div>
59879db9d12c2ea10f77b2c44d6d3aba89bb9cb3slive<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
59879db9d12c2ea10f77b2c44d6d3aba89bb9cb3slive<div class="section">
59879db9d12c2ea10f77b2c44d6d3aba89bb9cb3slive<h2><a name="variables" id="variables">Global and static variables</a></h2>
59879db9d12c2ea10f77b2c44d6d3aba89bb9cb3slive <p>When writing your module or when trying to determine if a module or
59879db9d12c2ea10f77b2c44d6d3aba89bb9cb3slive 3rd party library is thread safe there are some common things to keep in
59879db9d12c2ea10f77b2c44d6d3aba89bb9cb3slive mind.</p>
59879db9d12c2ea10f77b2c44d6d3aba89bb9cb3slive
59879db9d12c2ea10f77b2c44d6d3aba89bb9cb3slive <p>First, you need to recognize that in a threaded model each individual
59879db9d12c2ea10f77b2c44d6d3aba89bb9cb3slive thread has its own program counter, stack and registers. Local variables
59879db9d12c2ea10f77b2c44d6d3aba89bb9cb3slive live on the stack, so those are fine. You need to watch out for any
59879db9d12c2ea10f77b2c44d6d3aba89bb9cb3slive static or global variables. This doesn't mean that you are absolutely not
59879db9d12c2ea10f77b2c44d6d3aba89bb9cb3slive allowed to use static or global variables. There are times when you
59879db9d12c2ea10f77b2c44d6d3aba89bb9cb3slive actually want something to affect all threads, but generally you need to
59879db9d12c2ea10f77b2c44d6d3aba89bb9cb3slive avoid using them if you want your code to be thread safe.</p>
59879db9d12c2ea10f77b2c44d6d3aba89bb9cb3slive
59879db9d12c2ea10f77b2c44d6d3aba89bb9cb3slive <p>In the case where you have a global variable that needs to be global and
0a5e1567f7fa7f5706c68d09f744673c6cb99b33nd accessed by all threads, be very careful when you update it. If, for
0a5e1567f7fa7f5706c68d09f744673c6cb99b33nd example, it is an incrementing counter, you need to atomically increment
ae08254467d40ebbf0830ca618b06d51330556f9jsl it to avoid race conditions with other threads. You do this using a mutex
0a5e1567f7fa7f5706c68d09f744673c6cb99b33nd (mutual exclusion). Lock the mutex, read the current value, increment it
0a5e1567f7fa7f5706c68d09f744673c6cb99b33nd and write it back and then unlock the mutex. Any other thread that wants
0a5e1567f7fa7f5706c68d09f744673c6cb99b33nd to modify the value has to first check the mutex and block until it is
0a5e1567f7fa7f5706c68d09f744673c6cb99b33nd cleared.</p>
0a5e1567f7fa7f5706c68d09f744673c6cb99b33nd
0a5e1567f7fa7f5706c68d09f744673c6cb99b33nd <p>If you are using <a href="http://apr.apache.org/">APR</a>, have a look
0a5e1567f7fa7f5706c68d09f744673c6cb99b33nd at the <code>apr_atomic_<var>*</var></code> functions and the
ae08254467d40ebbf0830ca618b06d51330556f9jsl <code>apr_thread_mutex_<var>*</var></code> functions.</p>
ae08254467d40ebbf0830ca618b06d51330556f9jsl
ae08254467d40ebbf0830ca618b06d51330556f9jsl</div><div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
ae08254467d40ebbf0830ca618b06d51330556f9jsl<div class="section">
ae08254467d40ebbf0830ca618b06d51330556f9jsl<h2><a name="errno" id="errno">errno</a></h2>
ae08254467d40ebbf0830ca618b06d51330556f9jsl <p>This is a common global variable that holds the error number of the
ae08254467d40ebbf0830ca618b06d51330556f9jsl last error that occurred. If one thread calls a low-level function that
59879db9d12c2ea10f77b2c44d6d3aba89bb9cb3slive sets errno and then another thread checks it, we are bleeding error
59879db9d12c2ea10f77b2c44d6d3aba89bb9cb3slive numbers from one thread into another. To solve this, make sure your
5a58787efeb02a1c3f06569d019ad81fd2efa06end module or library defines <code>_REENTRANT</code> or is compiled with
5a58787efeb02a1c3f06569d019ad81fd2efa06end <code>-D_REENTRANT</code>. This will make errno a per-thread variable
3b3b7fc78d1f5bfc2769903375050048ff41ff26nd and should hopefully be transparent to the code. It does this by doing
5652dbe450e4fcfdf36d4cfb42d7f2345ded29a4maczniak something like this:</p>
5652dbe450e4fcfdf36d4cfb42d7f2345ded29a4maczniak
3b3b7fc78d1f5bfc2769903375050048ff41ff26nd <div class="example"><p><code>
35714556a25fceb7c9bf9c4e01791b2e2a4c27c3nd #define errno (*(__errno_location()))
5a58787efeb02a1c3f06569d019ad81fd2efa06end </code></p></div>
5a58787efeb02a1c3f06569d019ad81fd2efa06end
<p>which means that accessing errno will call
<code>__errno_location()</code> which is provided by the libc. Setting
<code>_REENTRANT</code> also forces redefinition of some other functions
to their <code><var>*</var>_r</code> equivalents and sometimes changes
the common <code>getc</code>/<code>putc</code> macros into safer function
calls. Check your libc documentation for specifics. Instead of, or in
addition to <code>_REENTRANT</code> the symbols that may affect this are
<code>_POSIX_C_SOURCE</code>, <code>_THREAD_SAFE</code>,
<code>_SVID_SOURCE</code>, and <code>_BSD_SOURCE</code>.</p>
</div><div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
<div class="section">
<h2><a name="functions" id="functions">Common standard troublesome functions</a></h2>
<p>Not only do things have to be thread safe, but they also have to be
reentrant. <code>strtok()</code> is an obvious one. You call it the first
time with your delimiter which it then remembers and on each subsequent
call it returns the next token. Obviously if multiple threads are
calling it you will have a problem. Most systems have a reentrant version
of of the function called <code>strtok_r()</code> where you pass in an
extra argument which contains an allocated <code>char *</code> which the
function will use instead of its own static storage for maintaining
the tokenizing state. If you are using <a href="http://apr.apache.org/">APR</a> you can use <code>apr_strtok()</code>.</p>
<p><code>crypt()</code> is another function that tends to not be reentrant,
so if you run across calls to that function in a library, watch out. On
some systems it is reentrant though, so it is not always a problem. If
your system has <code>crypt_r()</code> chances are you should be using
that, or if possible simply avoid the whole mess by using md5 instead.</p>
</div><div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
<div class="section">
<h2><a name="commonlibs" id="commonlibs">Common 3rd Party Libraries</a></h2>
<p>The following is a list of common libraries that are used by 3rd party
Apache modules. You can check to see if your module is using a potentially
unsafe library by using tools such as <code>ldd(1)</code> and
<code>nm(1)</code>. For <a href="http://www.php.net/">PHP</a>, for example,
try this:</p>
<div class="example"><p><code>
% ldd libphp4.so<br />
libsablot.so.0 =&gt; /usr/local/lib/libsablot.so.0 (0x401f6000)<br />
libexpat.so.0 =&gt; /usr/lib/libexpat.so.0 (0x402da000)<br />
libsnmp.so.0 =&gt; /usr/lib/libsnmp.so.0 (0x402f9000)<br />
libpdf.so.1 =&gt; /usr/local/lib/libpdf.so.1 (0x40353000)<br />
libz.so.1 =&gt; /usr/lib/libz.so.1 (0x403e2000)<br />
libpng.so.2 =&gt; /usr/lib/libpng.so.2 (0x403f0000)<br />
libmysqlclient.so.11 =&gt; /usr/lib/libmysqlclient.so.11 (0x40411000)<br />
libming.so =&gt; /usr/lib/libming.so (0x40449000)<br />
libm.so.6 =&gt; /lib/libm.so.6 (0x40487000)<br />
libfreetype.so.6 =&gt; /usr/lib/libfreetype.so.6 (0x404a8000)<br />
libjpeg.so.62 =&gt; /usr/lib/libjpeg.so.62 (0x404e7000)<br />
libcrypt.so.1 =&gt; /lib/libcrypt.so.1 (0x40505000)<br />
libssl.so.2 =&gt; /lib/libssl.so.2 (0x40532000)<br />
libcrypto.so.2 =&gt; /lib/libcrypto.so.2 (0x40560000)<br />
libresolv.so.2 =&gt; /lib/libresolv.so.2 (0x40624000)<br />
libdl.so.2 =&gt; /lib/libdl.so.2 (0x40634000)<br />
libnsl.so.1 =&gt; /lib/libnsl.so.1 (0x40637000)<br />
libc.so.6 =&gt; /lib/libc.so.6 (0x4064b000)<br />
/lib/ld-linux.so.2 =&gt; /lib/ld-linux.so.2 (0x80000000)
</code></p></div>
<p>In addition to these libraries you will need to have a look at any
libraries linked statically into the module. You can use <code>nm(1)</code>
to look for individual symbols in the module.</p>
</div><div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
<div class="section">
<h2><a name="liblist" id="liblist">Library List</a></h2>
<p>Please drop a note to <a href="http://httpd.apache.org/lists.html#http-dev">dev@httpd.apache.org</a>
if you have additions or corrections to this list.</p>
<table class="bordered"><tr class="header"><th>Library</th><th>Version</th><th>Thread Safe?</th><th>Notes</th></tr>
<tr><td><a href="http://aspell.sourceforge.net/">ASpell/PSpell</a></td>
<td> </td>
<td>?</td>
<td> </td></tr>
<tr class="odd"><td><a href="http://www.sleepycat.com/">Berkeley DB</a></td>
<td>3.x, 4.x</td>
<td>Yes</td>
<td>Be careful about sharing a connection across threads.</td></tr>
<tr><td><a href="http://sources.redhat.com/bzip2/index.html">bzip2</a></td>
<td> </td>
<td>Yes</td>
<td>Both low-level and high-level APIs are thread-safe. However,
high-level API requires thread-safe access to errno.</td></tr>
<tr class="odd"><td><a href="http://cr.yp.to/cdb.html">cdb</a></td>
<td> </td>
<td>?</td>
<td> </td></tr>
<tr><td><a href="http://www.washington.edu/imap/">C-Client</a></td>
<td> </td>
<td>Perhaps</td>
<td>c-client uses <code>strtok()</code> and
<code>gethostbyname()</code> which are not thread-safe on most C
library implementations. c-client's static data is meant to be shared
across threads. If <code>strtok()</code> and
<code>gethostbyname()</code> are thread-safe on your OS, c-client
<em>may</em> be thread-safe.</td></tr>
<tr class="odd"><td><a href="http://www.ijg.org/files/">libcrypt</a></td>
<td> </td>
<td>?</td>
<td> </td></tr>
<tr><td><a href="http://expat.sourceforge.net/">Expat</a></td>
<td> </td>
<td>Yes</td>
<td>Need a separate parser instance per thread</td></tr>
<tr class="odd"><td><a href="http://www.freetds.org/">FreeTDS</a></td>
<td> </td>
<td>?</td>
<td> </td></tr>
<tr><td><a href="http://www.freetype.org/">FreeType</a></td>
<td> </td>
<td>?</td>
<td> </td></tr>
<tr class="odd"><td><a href="http://www.boutell.com/gd/">GD 1.8.x</a></td>
<td> </td>
<td>?</td>
<td> </td></tr>
<tr><td><a href="http://www.boutell.com/gd/">GD 2.0.x</a></td>
<td> </td>
<td>?</td>
<td> </td></tr>
<tr class="odd"><td><a href="http://www.gnu.org/software/gdbm/gdbm.html">gdbm</a></td>
<td> </td>
<td>No</td>
<td>Errors returned via a static <code>gdbm_error</code>
variable</td></tr>
<tr><td><a href="http://www.imagemagick.org/">ImageMagick</a></td>
<td>5.2.2</td>
<td>Yes</td>
<td>ImageMagick docs claim it is thread safe since version 5.2.2 (see <a href="http://www.imagemagick.com/www/changelog.html">Change log</a>).
</td></tr>
<tr class="odd"><td><a href="http://www.enlightenment.org/p.php?p=about/efl&amp;l=en">Imlib2</a></td>
<td> </td>
<td>?</td>
<td> </td></tr>
<tr><td><a href="http://www.ijg.org/files/">libjpeg</a></td>
<td>v6b</td>
<td>?</td>
<td> </td></tr>
<tr class="odd"><td><a href="http://mysql.com">libmysqlclient</a></td>
<td> </td>
<td>Yes</td>
<td>Use mysqlclient_r library variant to ensure thread-safety. For
more information, please read <a href="http://dev.mysql.com/doc/mysql/en/Threaded_clients.html">http://dev.mysql.com/doc/mysql/en/Threaded_clients.html</a>.</td></tr>
<tr><td><a href="http://www.opaque.net/ming/">Ming</a></td>
<td>0.2a</td>
<td>?</td>
<td> </td></tr>
<tr class="odd"><td><a href="http://net-snmp.sourceforge.net/">Net-SNMP</a></td>
<td>5.0.x</td>
<td>?</td>
<td> </td></tr>
<tr><td><a href="http://www.openldap.org/">OpenLDAP</a></td>
<td>2.1.x</td>
<td>Yes</td>
<td>Use <code>ldap_r</code> library variant to ensure
thread-safety.</td></tr>
<tr class="odd"><td><a href="http://www.openssl.org/">OpenSSL</a></td>
<td>0.9.6g</td>
<td>Yes</td>
<td>Requires proper usage of <code>CRYPTO_num_locks</code>,
<code>CRYPTO_set_locking_callback</code>,
<code>CRYPTO_set_id_callback</code></td></tr>
<tr><td><a href="http://www.oracle.com/">liboci8 (Oracle 8+)</a></td>
<td>8.x,9.x</td>
<td>?</td>
<td> </td></tr>
<tr class="odd"><td><a href="http://pdflib.com/">pdflib</a></td>
<td>5.0.x</td>
<td>Yes</td>
<td>PDFLib docs claim it is thread safe; changes.txt indicates it
has been partially thread-safe since V1.91: <a href="http://www.pdflib.com/products/pdflib-family/pdflib/">http://www.pdflib.com/products/pdflib-family/pdflib/</a>.</td></tr>
<tr><td><a href="http://www.libpng.org/pub/png/libpng.html">libpng</a></td>
<td>1.0.x</td>
<td>?</td>
<td> </td></tr>
<tr class="odd"><td><a href="http://www.libpng.org/pub/png/libpng.html">libpng</a></td>
<td>1.2.x</td>
<td>?</td>
<td> </td></tr>
<tr><td><a href="http://www.postgresql.org/docs/8.4/static/libpq-threading.html">libpq (PostgreSQL)</a></td>
<td>8.x</td>
<td>Yes</td>
<td>Don't share connections across threads and watch out for
<code>crypt()</code> calls</td></tr>
<tr class="odd"><td><a href="http://www.gingerall.com/charlie/ga/xml/p_sab.xml">Sablotron</a></td>
<td>0.95</td>
<td>?</td>
<td /></tr>
<tr><td><a href="http://www.gzip.org/zlib/">zlib</a></td>
<td>1.1.4</td>
<td>Yes</td>
<td>Relies upon thread-safe zalloc and zfree functions Default is to
use libc's calloc/free which are thread-safe.</td></tr>
</table>
</div></div>
<div class="bottomlang">
<p><span>Available Languages: </span><a href="/en/developer/thread_safety.html" title="English">&nbsp;en&nbsp;</a></p>
</div><div id="footer">
<p class="apache">Copyright 2012 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>
<p class="menu"><a href="/mod/">Modules</a> | <a href="/mod/directives.html">Directives</a> | <a href="/faq/">FAQ</a> | <a href="/glossary.html">Glossary</a> | <a href="/sitemap.html">Sitemap</a></p></div>
</body></html>