passenger 2.2.9 → 2.2.10

data/doc/cxxapi/Logging_8h-source.html

@@ -10,6 +10,7 @@
     <ul>
       <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
       <li><a href="modules.html"><span>Modules</span></a></li>
+      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
       <li><a href="annotated.html"><span>Classes</span></a></li>
       <li class="current"><a href="files.html"><span>Files</span></a></li>
     </ul>
@@ -21,123 +22,590 @@
   </div>
 <h1>Logging.h</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
 <a name="l00002"></a>00002 <span class="comment"> *  Phusion Passenger - http://www.modrails.com/</span>
-<a name="l00003"></a>00003 <span class="comment"> *  Copyright (C) 2008  Phusion</span>
+<a name="l00003"></a>00003 <span class="comment"> *  Copyright (c) 2010 Phusion</span>
 <a name="l00004"></a>00004 <span class="comment"> *</span>
-<a name="l00005"></a>00005 <span class="comment"> *  Phusion Passenger is a trademark of Hongli Lai &amp; Ninh Bui.</span>
+<a name="l00005"></a>00005 <span class="comment"> *  "Phusion Passenger" is a trademark of Hongli Lai &amp; Ninh Bui.</span>
 <a name="l00006"></a>00006 <span class="comment"> *</span>
-<a name="l00007"></a>00007 <span class="comment"> *  This program is free software; you can redistribute it and/or modify</span>
-<a name="l00008"></a>00008 <span class="comment"> *  it under the terms of the GNU General Public License as published by</span>
-<a name="l00009"></a>00009 <span class="comment"> *  the Free Software Foundation; version 2 of the License.</span>
-<a name="l00010"></a>00010 <span class="comment"> *</span>
-<a name="l00011"></a>00011 <span class="comment"> *  This program is distributed in the hope that it will be useful,</span>
-<a name="l00012"></a>00012 <span class="comment"> *  but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
-<a name="l00013"></a>00013 <span class="comment"> *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the</span>
-<a name="l00014"></a>00014 <span class="comment"> *  GNU General Public License for more details.</span>
-<a name="l00015"></a>00015 <span class="comment"> *</span>
-<a name="l00016"></a>00016 <span class="comment"> *  You should have received a copy of the GNU General Public License along</span>
-<a name="l00017"></a>00017 <span class="comment"> *  with this program; if not, write to the Free Software Foundation, Inc.,</span>
-<a name="l00018"></a>00018 <span class="comment"> *  51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.</span>
-<a name="l00019"></a>00019 <span class="comment"> */</span>
-<a name="l00020"></a>00020 <span class="preprocessor">#ifndef _PASSENGER_LOGGING_H_</span>
-<a name="l00021"></a>00021 <span class="preprocessor"></span><span class="preprocessor">#define _PASSENGER_LOGGING_H_</span>
-<a name="l00022"></a>00022 <span class="preprocessor"></span>
-<a name="l00023"></a>00023 <span class="preprocessor">#include &lt;sys/types.h&gt;</span>
-<a name="l00024"></a>00024 <span class="preprocessor">#include &lt;sys/time.h&gt;</span>
-<a name="l00025"></a>00025 <span class="preprocessor">#include &lt;unistd.h&gt;</span>
-<a name="l00026"></a>00026 <span class="preprocessor">#include &lt;ostream&gt;</span>
-<a name="l00027"></a>00027 <span class="preprocessor">#include &lt;sstream&gt;</span>
-<a name="l00028"></a>00028 <span class="preprocessor">#include &lt;ctime&gt;</span>
-<a name="l00029"></a>00029 
-<a name="l00030"></a>00030 <span class="keyword">namespace </span>Passenger {
+<a name="l00007"></a>00007 <span class="comment"> *  Permission is hereby granted, free of charge, to any person obtaining a copy</span>
+<a name="l00008"></a>00008 <span class="comment"> *  of this software and associated documentation files (the "Software"), to deal</span>
+<a name="l00009"></a>00009 <span class="comment"> *  in the Software without restriction, including without limitation the rights</span>
+<a name="l00010"></a>00010 <span class="comment"> *  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell</span>
+<a name="l00011"></a>00011 <span class="comment"> *  copies of the Software, and to permit persons to whom the Software is</span>
+<a name="l00012"></a>00012 <span class="comment"> *  furnished to do so, subject to the following conditions:</span>
+<a name="l00013"></a>00013 <span class="comment"> *</span>
+<a name="l00014"></a>00014 <span class="comment"> *  The above copyright notice and this permission notice shall be included in</span>
+<a name="l00015"></a>00015 <span class="comment"> *  all copies or substantial portions of the Software.</span>
+<a name="l00016"></a>00016 <span class="comment"> *</span>
+<a name="l00017"></a>00017 <span class="comment"> *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR</span>
+<a name="l00018"></a>00018 <span class="comment"> *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,</span>
+<a name="l00019"></a>00019 <span class="comment"> *  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE</span>
+<a name="l00020"></a>00020 <span class="comment"> *  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER</span>
+<a name="l00021"></a>00021 <span class="comment"> *  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,</span>
+<a name="l00022"></a>00022 <span class="comment"> *  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN</span>
+<a name="l00023"></a>00023 <span class="comment"> *  THE SOFTWARE.</span>
+<a name="l00024"></a>00024 <span class="comment"> */</span>
+<a name="l00025"></a>00025 <span class="preprocessor">#ifndef _PASSENGER_LOGGING_H_</span>
+<a name="l00026"></a>00026 <span class="preprocessor"></span><span class="preprocessor">#define _PASSENGER_LOGGING_H_</span>
+<a name="l00027"></a>00027 <span class="preprocessor"></span>
+<a name="l00028"></a>00028 <span class="preprocessor">#include &lt;boost/shared_ptr.hpp&gt;</span>
+<a name="l00029"></a>00029 <span class="preprocessor">#include &lt;oxt/system_calls.hpp&gt;</span>
+<a name="l00030"></a>00030 <span class="preprocessor">#include &lt;oxt/backtrace.hpp&gt;</span>
 <a name="l00031"></a>00031 
-<a name="l00032"></a>00032 <span class="keyword">using namespace </span>std;
-<a name="l00033"></a>00033 
-<a name="l00034"></a>00034 <span class="keyword">extern</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> _logLevel;
-<a name="l00035"></a>00035 <span class="keyword">extern</span> ostream *_logStream;
-<a name="l00036"></a>00036 <span class="keyword">extern</span> ostream *_debugStream;
-<a name="l00037"></a>00037 
-<a name="l00038"></a>00038 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> getLogLevel();
-<a name="l00039"></a>00039 <span class="keywordtype">void</span> setLogLevel(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> value);
-<a name="l00040"></a>00040 <span class="keywordtype">void</span> setDebugFile(<span class="keyword">const</span> <span class="keywordtype">char</span> *logFile = NULL);
-<a name="l00041"></a>00041 <span class="comment"></span>
-<a name="l00042"></a>00042 <span class="comment">/**</span>
-<a name="l00043"></a>00043 <span class="comment"> * Write the given expression to the given stream.</span>
-<a name="l00044"></a>00044 <span class="comment"> *</span>
-<a name="l00045"></a>00045 <span class="comment"> * @param expr The expression to write.</span>
-<a name="l00046"></a>00046 <span class="comment"> * @param stream A pointer to an object that accepts the '&lt;&lt;' operator.</span>
-<a name="l00047"></a>00047 <span class="comment"> */</span>
-<a name="l00048"></a>00048 <span class="preprocessor">#define P_LOG_TO(expr, stream) \</span>
-<a name="l00049"></a>00049 <span class="preprocessor">        do { \</span>
-<a name="l00050"></a>00050 <span class="preprocessor">                if (stream != 0) { \</span>
-<a name="l00051"></a>00051 <span class="preprocessor">                        time_t the_time;                        \</span>
-<a name="l00052"></a>00052 <span class="preprocessor">                        struct tm *the_tm;                      \</span>
-<a name="l00053"></a>00053 <span class="preprocessor">                        char datetime_buf[60];                  \</span>
-<a name="l00054"></a>00054 <span class="preprocessor">                        struct timeval tv;                      \</span>
-<a name="l00055"></a>00055 <span class="preprocessor">                        std::stringstream sstream;              \</span>
-<a name="l00056"></a>00056 <span class="preprocessor">                                                                \</span>
-<a name="l00057"></a>00057 <span class="preprocessor">                        the_time = time(NULL);                  \</span>
-<a name="l00058"></a>00058 <span class="preprocessor">                        the_tm = localtime(&amp;the_time);          \</span>
-<a name="l00059"></a>00059 <span class="preprocessor">                        strftime(datetime_buf, sizeof(datetime_buf), "%F %H:%M:%S", the_tm); \</span>
-<a name="l00060"></a>00060 <span class="preprocessor">                        gettimeofday(&amp;tv, NULL); \</span>
-<a name="l00061"></a>00061 <span class="preprocessor">                        sstream &lt;&lt; \</span>
-<a name="l00062"></a>00062 <span class="preprocessor">                                "[ pid=" &lt;&lt; getpid() &lt;&lt; " file=" &lt;&lt; __FILE__ &lt;&lt; ":" &lt;&lt; __LINE__ &lt;&lt; \</span>
-<a name="l00063"></a>00063 <span class="preprocessor">                                " time=" &lt;&lt; datetime_buf &lt;&lt; "." &lt;&lt; (tv.tv_usec / 1000) &lt;&lt; " ]:" &lt;&lt; \</span>
-<a name="l00064"></a>00064 <span class="preprocessor">                                "\n  " &lt;&lt; expr &lt;&lt; std::endl;    \</span>
-<a name="l00065"></a>00065 <span class="preprocessor">                        *stream &lt;&lt; sstream.str();               \</span>
-<a name="l00066"></a>00066 <span class="preprocessor">                        stream-&gt;flush();                        \</span>
-<a name="l00067"></a>00067 <span class="preprocessor">                } \</span>
-<a name="l00068"></a>00068 <span class="preprocessor">        } while (false)</span>
-<a name="l00069"></a>00069 <span class="preprocessor"></span><span class="comment"></span>
+<a name="l00032"></a>00032 <span class="preprocessor">#include &lt;sys/types.h&gt;</span>
+<a name="l00033"></a>00033 <span class="preprocessor">#include &lt;sys/time.h&gt;</span>
+<a name="l00034"></a>00034 <span class="preprocessor">#include &lt;unistd.h&gt;</span>
+<a name="l00035"></a>00035 <span class="preprocessor">#include &lt;fcntl.h&gt;</span>
+<a name="l00036"></a>00036 <span class="preprocessor">#include &lt;string&gt;</span>
+<a name="l00037"></a>00037 <span class="preprocessor">#include &lt;map&gt;</span>
+<a name="l00038"></a>00038 <span class="preprocessor">#include &lt;ostream&gt;</span>
+<a name="l00039"></a>00039 <span class="preprocessor">#include &lt;sstream&gt;</span>
+<a name="l00040"></a>00040 <span class="preprocessor">#include &lt;cstdio&gt;</span>
+<a name="l00041"></a>00041 <span class="preprocessor">#include &lt;ctime&gt;</span>
+<a name="l00042"></a>00042 
+<a name="l00043"></a>00043 <span class="preprocessor">#include "RandomGenerator.h"</span>
+<a name="l00044"></a>00044 <span class="preprocessor">#include "FileDescriptor.h"</span>
+<a name="l00045"></a>00045 <span class="preprocessor">#include "MessageClient.h"</span>
+<a name="l00046"></a>00046 <span class="preprocessor">#include "StaticString.h"</span>
+<a name="l00047"></a>00047 <span class="preprocessor">#include "Exceptions.h"</span>
+<a name="l00048"></a>00048 <span class="preprocessor">#include "Utils.h"</span>
+<a name="l00049"></a>00049 <span class="preprocessor">#include "Utils/MD5.h"</span>
+<a name="l00050"></a>00050 <span class="preprocessor">#include "Utils/SystemTime.h"</span>
+<a name="l00051"></a>00051 
+<a name="l00052"></a>00052 
+<a name="l00053"></a>00053 <span class="keyword">namespace </span>Passenger {
+<a name="l00054"></a>00054 
+<a name="l00055"></a>00055 <span class="keyword">using namespace </span>std;
+<a name="l00056"></a>00056 <span class="keyword">using namespace </span>boost;
+<a name="l00057"></a>00057 <span class="keyword">using namespace </span>oxt;
+<a name="l00058"></a>00058 
+<a name="l00059"></a>00059 
+<a name="l00060"></a>00060 <span class="comment">/********** Debug logging facilities **********/</span>
+<a name="l00061"></a>00061 
+<a name="l00062"></a>00062 <span class="keyword">extern</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> _logLevel;
+<a name="l00063"></a>00063 <span class="keyword">extern</span> ostream *_logStream;
+<a name="l00064"></a>00064 <span class="keyword">extern</span> ostream *_debugStream;
+<a name="l00065"></a>00065 
+<a name="l00066"></a>00066 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> getLogLevel();
+<a name="l00067"></a>00067 <span class="keywordtype">void</span> setLogLevel(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> value);
+<a name="l00068"></a>00068 <span class="keywordtype">void</span> setDebugFile(<span class="keyword">const</span> <span class="keywordtype">char</span> *logFile = NULL);
+<a name="l00069"></a>00069 <span class="comment"></span>
 <a name="l00070"></a>00070 <span class="comment">/**</span>
-<a name="l00071"></a>00071 <span class="comment"> * Write the given expression to the log stream.</span>
-<a name="l00072"></a>00072 <span class="comment"> */</span>
-<a name="l00073"></a>00073 <span class="preprocessor">#define P_LOG(expr) P_LOG_TO(expr, Passenger::_logStream)</span>
-<a name="l00074"></a>00074 <span class="preprocessor"></span><span class="comment"></span>
-<a name="l00075"></a>00075 <span class="comment">/**</span>
-<a name="l00076"></a>00076 <span class="comment"> * Write the given expression, which represents a warning,</span>
-<a name="l00077"></a>00077 <span class="comment"> * to the log stream.</span>
-<a name="l00078"></a>00078 <span class="comment"> */</span>
-<a name="l00079"></a>00079 <span class="preprocessor">#define P_WARN(expr) P_LOG(expr)</span>
-<a name="l00080"></a>00080 <span class="preprocessor"></span><span class="comment"></span>
-<a name="l00081"></a>00081 <span class="comment">/**</span>
-<a name="l00082"></a>00082 <span class="comment"> * Write the given expression, which represents an error,</span>
-<a name="l00083"></a>00083 <span class="comment"> * to the log stream.</span>
-<a name="l00084"></a>00084 <span class="comment"> */</span>
-<a name="l00085"></a>00085 <span class="preprocessor">#define P_ERROR(expr) P_LOG(expr)</span>
-<a name="l00086"></a>00086 <span class="preprocessor"></span><span class="comment"></span>
-<a name="l00087"></a>00087 <span class="comment">/**</span>
-<a name="l00088"></a>00088 <span class="comment"> * Write the given expression, which represents a debugging message,</span>
-<a name="l00089"></a>00089 <span class="comment"> * to the log stream.</span>
-<a name="l00090"></a>00090 <span class="comment"> */</span>
-<a name="l00091"></a>00091 <span class="preprocessor">#define P_DEBUG(expr) P_TRACE(1, expr)</span>
-<a name="l00092"></a>00092 <span class="preprocessor"></span>
-<a name="l00093"></a>00093 <span class="preprocessor">#ifdef PASSENGER_DEBUG</span>
-<a name="l00094"></a>00094 <span class="preprocessor"></span><span class="preprocessor">        #define P_TRACE(level, expr) \</span>
-<a name="l00095"></a>00095 <span class="preprocessor">                do { \</span>
-<a name="l00096"></a>00096 <span class="preprocessor">                        if (Passenger::_logLevel &gt;= level) { \</span>
-<a name="l00097"></a>00097 <span class="preprocessor">                                P_LOG_TO(expr, Passenger::_debugStream); \</span>
-<a name="l00098"></a>00098 <span class="preprocessor">                        } \</span>
-<a name="l00099"></a>00099 <span class="preprocessor">                } while (false)</span>
-<a name="l00100"></a>00100 <span class="preprocessor"></span>        
-<a name="l00101"></a>00101 <span class="preprocessor">        #define P_ASSERT(expr, result_if_failed, message) \</span>
-<a name="l00102"></a>00102 <span class="preprocessor">                do { \</span>
-<a name="l00103"></a>00103 <span class="preprocessor">                        if (!(expr)) { \</span>
-<a name="l00104"></a>00104 <span class="preprocessor">                                P_ERROR("Assertion failed: " &lt;&lt; message); \</span>
-<a name="l00105"></a>00105 <span class="preprocessor">                                return result_if_failed; \</span>
-<a name="l00106"></a>00106 <span class="preprocessor">                        } \</span>
-<a name="l00107"></a>00107 <span class="preprocessor">                } while (false)</span>
-<a name="l00108"></a>00108 <span class="preprocessor"></span><span class="preprocessor">#else</span>
-<a name="l00109"></a>00109 <span class="preprocessor"></span><span class="preprocessor">        #define P_TRACE(level, expr) do { </span><span class="comment">/* nothing */</span> } while (false)
-<a name="l00110"></a>00110         
-<a name="l00111"></a>00111 <span class="preprocessor">        #define P_ASSERT(expr, result_if_failed, message) do { </span><span class="comment">/* nothing */</span> } while (false)
-<a name="l00112"></a>00112 <span class="preprocessor">#endif</span>
-<a name="l00113"></a>00113 <span class="preprocessor"></span>
-<a name="l00114"></a>00114 } <span class="comment">// namespace Passenger</span>
-<a name="l00115"></a>00115 
-<a name="l00116"></a>00116 <span class="preprocessor">#endif </span><span class="comment">/* _PASSENGER_LOGGING_H_ */</span>
-<a name="l00117"></a>00117 
+<a name="l00071"></a>00071 <span class="comment"> * Write the given expression to the given stream.</span>
+<a name="l00072"></a>00072 <span class="comment"> *</span>
+<a name="l00073"></a>00073 <span class="comment"> * @param expr The expression to write.</span>
+<a name="l00074"></a>00074 <span class="comment"> * @param stream A pointer to an object that accepts the '&lt;&lt;' operator.</span>
+<a name="l00075"></a>00075 <span class="comment"> */</span>
+<a name="l00076"></a>00076 <span class="preprocessor">#define P_LOG_TO(expr, stream) \</span>
+<a name="l00077"></a>00077 <span class="preprocessor">        do { \</span>
+<a name="l00078"></a>00078 <span class="preprocessor">                if (stream != 0) { \</span>
+<a name="l00079"></a>00079 <span class="preprocessor">                        time_t the_time;                        \</span>
+<a name="l00080"></a>00080 <span class="preprocessor">                        struct tm *the_tm;                      \</span>
+<a name="l00081"></a>00081 <span class="preprocessor">                        char datetime_buf[60];                  \</span>
+<a name="l00082"></a>00082 <span class="preprocessor">                        struct timeval tv;                      \</span>
+<a name="l00083"></a>00083 <span class="preprocessor">                        std::stringstream sstream;              \</span>
+<a name="l00084"></a>00084 <span class="preprocessor">                                                                \</span>
+<a name="l00085"></a>00085 <span class="preprocessor">                        the_time = time(NULL);                  \</span>
+<a name="l00086"></a>00086 <span class="preprocessor">                        the_tm = localtime(&amp;the_time);          \</span>
+<a name="l00087"></a>00087 <span class="preprocessor">                        strftime(datetime_buf, sizeof(datetime_buf), "%F %H:%M:%S", the_tm); \</span>
+<a name="l00088"></a>00088 <span class="preprocessor">                        gettimeofday(&amp;tv, NULL); \</span>
+<a name="l00089"></a>00089 <span class="preprocessor">                        sstream &lt;&lt; \</span>
+<a name="l00090"></a>00090 <span class="preprocessor">                                "[ pid=" &lt;&lt; ((unsigned long) getpid()) &lt;&lt;  \</span>
+<a name="l00091"></a>00091 <span class="preprocessor">                                " file=" &lt;&lt; __FILE__ &lt;&lt; ":" &lt;&lt; (unsigned long) __LINE__ &lt;&lt; \</span>
+<a name="l00092"></a>00092 <span class="preprocessor">                                " time=" &lt;&lt; datetime_buf &lt;&lt; "." &lt;&lt; (unsigned long) (tv.tv_usec / 1000) &lt;&lt; " ]:" &lt;&lt; \</span>
+<a name="l00093"></a>00093 <span class="preprocessor">                                "\n  " &lt;&lt; expr &lt;&lt; std::endl;    \</span>
+<a name="l00094"></a>00094 <span class="preprocessor">                        *stream &lt;&lt; sstream.str();               \</span>
+<a name="l00095"></a>00095 <span class="preprocessor">                        stream-&gt;flush();                        \</span>
+<a name="l00096"></a>00096 <span class="preprocessor">                } \</span>
+<a name="l00097"></a>00097 <span class="preprocessor">        } while (false)</span>
+<a name="l00098"></a>00098 <span class="preprocessor"></span><span class="comment"></span>
+<a name="l00099"></a>00099 <span class="comment">/**</span>
+<a name="l00100"></a>00100 <span class="comment"> * Write the given expression to the log stream.</span>
+<a name="l00101"></a>00101 <span class="comment"> */</span>
+<a name="l00102"></a>00102 <span class="preprocessor">#define P_LOG(expr) P_LOG_TO(expr, Passenger::_logStream)</span>
+<a name="l00103"></a>00103 <span class="preprocessor"></span><span class="comment"></span>
+<a name="l00104"></a>00104 <span class="comment">/**</span>
+<a name="l00105"></a>00105 <span class="comment"> * Write the given expression, which represents a warning,</span>
+<a name="l00106"></a>00106 <span class="comment"> * to the log stream.</span>
+<a name="l00107"></a>00107 <span class="comment"> */</span>
+<a name="l00108"></a>00108 <span class="preprocessor">#define P_WARN(expr) P_LOG(expr)</span>
+<a name="l00109"></a>00109 <span class="preprocessor"></span><span class="comment"></span>
+<a name="l00110"></a>00110 <span class="comment">/**</span>
+<a name="l00111"></a>00111 <span class="comment"> * Write the given expression, which represents an error,</span>
+<a name="l00112"></a>00112 <span class="comment"> * to the log stream.</span>
+<a name="l00113"></a>00113 <span class="comment"> */</span>
+<a name="l00114"></a>00114 <span class="preprocessor">#define P_ERROR(expr) P_LOG(expr)</span>
+<a name="l00115"></a>00115 <span class="preprocessor"></span><span class="comment"></span>
+<a name="l00116"></a>00116 <span class="comment">/**</span>
+<a name="l00117"></a>00117 <span class="comment"> * Write the given expression, which represents a debugging message,</span>
+<a name="l00118"></a>00118 <span class="comment"> * to the log stream.</span>
+<a name="l00119"></a>00119 <span class="comment"> */</span>
+<a name="l00120"></a>00120 <span class="preprocessor">#define P_DEBUG(expr) P_TRACE(1, expr)</span>
+<a name="l00121"></a>00121 <span class="preprocessor"></span>
+<a name="l00122"></a>00122 <span class="preprocessor">#ifdef PASSENGER_DEBUG</span>
+<a name="l00123"></a>00123 <span class="preprocessor"></span><span class="preprocessor">        #define P_TRACE(level, expr) \</span>
+<a name="l00124"></a>00124 <span class="preprocessor">                do { \</span>
+<a name="l00125"></a>00125 <span class="preprocessor">                        if (Passenger::_logLevel &gt;= level) { \</span>
+<a name="l00126"></a>00126 <span class="preprocessor">                                P_LOG_TO(expr, Passenger::_debugStream); \</span>
+<a name="l00127"></a>00127 <span class="preprocessor">                        } \</span>
+<a name="l00128"></a>00128 <span class="preprocessor">                } while (false)</span>
+<a name="l00129"></a>00129 <span class="preprocessor"></span>        
+<a name="l00130"></a>00130 <span class="preprocessor">        #define P_ASSERT(expr, result_if_failed, message) \</span>
+<a name="l00131"></a>00131 <span class="preprocessor">                do { \</span>
+<a name="l00132"></a>00132 <span class="preprocessor">                        if (!(expr)) { \</span>
+<a name="l00133"></a>00133 <span class="preprocessor">                                P_ERROR("Assertion failed: " &lt;&lt; message); \</span>
+<a name="l00134"></a>00134 <span class="preprocessor">                                return result_if_failed; \</span>
+<a name="l00135"></a>00135 <span class="preprocessor">                        } \</span>
+<a name="l00136"></a>00136 <span class="preprocessor">                } while (false)</span>
+<a name="l00137"></a>00137 <span class="preprocessor"></span><span class="preprocessor">#else</span>
+<a name="l00138"></a>00138 <span class="preprocessor"></span><span class="preprocessor">        #define P_TRACE(level, expr) do { </span><span class="comment">/* nothing */</span> } while (false)
+<a name="l00139"></a>00139         
+<a name="l00140"></a>00140 <span class="preprocessor">        #define P_ASSERT(expr, result_if_failed, message) do { </span><span class="comment">/* nothing */</span> } while (false)
+<a name="l00141"></a>00141 <span class="preprocessor">#endif</span>
+<a name="l00142"></a>00142 <span class="preprocessor"></span>
+<a name="l00143"></a>00143 
+<a name="l00144"></a>00144 <span class="comment">/********** Transaction logging facilities *********/</span>
+<a name="l00145"></a>00145 
+<a name="l00146"></a>00146 <span class="keyword">class </span>AnalyticsLog {
+<a name="l00147"></a>00147 <span class="keyword">private</span>:
+<a name="l00148"></a>00148         <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">int</span> INT64_STR_BUFSIZE = 22; <span class="comment">// Long enough for a 64-bit number.</span>
+<a name="l00149"></a>00149         
+<a name="l00150"></a>00150         FileDescriptor handle;
+<a name="l00151"></a>00151         <span class="keywordtype">string</span> groupName;
+<a name="l00152"></a>00152         <span class="keywordtype">string</span> txnId;
+<a name="l00153"></a>00153         <span class="keywordtype">bool</span> largeMessages;
+<a name="l00154"></a>00154         
+<a name="l00155"></a>00155         <span class="keyword">class </span>FileLock {
+<a name="l00156"></a>00156         <span class="keyword">private</span>:
+<a name="l00157"></a>00157                 <span class="keywordtype">int</span> handle;
+<a name="l00158"></a>00158         <span class="keyword">public</span>:
+<a name="l00159"></a>00159                 FileLock(<span class="keyword">const</span> <span class="keywordtype">int</span> &amp;handle) {
+<a name="l00160"></a>00160                         this-&gt;handle = handle;
+<a name="l00161"></a>00161                         <span class="keywordtype">int</span> ret;
+<a name="l00162"></a>00162                         <span class="keywordflow">do</span> {
+<a name="l00163"></a>00163                                 ret = flock(handle, LOCK_EX);
+<a name="l00164"></a>00164                         } <span class="keywordflow">while</span> (ret == -1 &amp;&amp; errno == EINTR);
+<a name="l00165"></a>00165                         <span class="keywordflow">if</span> (ret == -1) {
+<a name="l00166"></a>00166                                 <span class="keywordtype">int</span> e = errno;
+<a name="l00167"></a>00167                                 <span class="keywordflow">throw</span> SystemException(<span class="stringliteral">"Cannot lock analytics log file"</span>, e);
+<a name="l00168"></a>00168                         }
+<a name="l00169"></a>00169                 }
+<a name="l00170"></a>00170                 
+<a name="l00171"></a>00171                 ~FileLock() {
+<a name="l00172"></a>00172                         <span class="keywordtype">int</span> ret;
+<a name="l00173"></a>00173                         <span class="keywordflow">do</span> {
+<a name="l00174"></a>00174                                 ret = flock(handle, LOCK_UN);
+<a name="l00175"></a>00175                         } <span class="keywordflow">while</span> (ret == -1 &amp;&amp; errno == EINTR);
+<a name="l00176"></a>00176                         <span class="keywordflow">if</span> (ret == -1) {
+<a name="l00177"></a>00177                                 <span class="keywordtype">int</span> e = errno;
+<a name="l00178"></a>00178                                 <span class="keywordflow">throw</span> SystemException(<span class="stringliteral">"Cannot unlock analytics log file"</span>, e);
+<a name="l00179"></a>00179                         };
+<a name="l00180"></a>00180                 }
+<a name="l00181"></a>00181         };
+<a name="l00182"></a>00182         <span class="comment"></span>
+<a name="l00183"></a>00183 <span class="comment">        /**</span>
+<a name="l00184"></a>00184 <span class="comment">         * @throws SystemException</span>
+<a name="l00185"></a>00185 <span class="comment">         * @throws IOException</span>
+<a name="l00186"></a>00186 <span class="comment">         * @throws boost::thread_interrupted</span>
+<a name="l00187"></a>00187 <span class="comment">         */</span>
+<a name="l00188"></a>00188         <span class="keywordtype">void</span> atomicWrite(<span class="keyword">const</span> <span class="keywordtype">char</span> *data, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> size) {
+<a name="l00189"></a>00189                 <span class="keywordtype">int</span> ret;
+<a name="l00190"></a>00190                 
+<a name="l00191"></a>00191                 ret = syscalls::write(handle, data, size);
+<a name="l00192"></a>00192                 <span class="keywordflow">if</span> (ret == -1) {
+<a name="l00193"></a>00193                         <span class="keywordtype">int</span> e = errno;
+<a name="l00194"></a>00194                         <span class="keywordflow">throw</span> SystemException(<span class="stringliteral">"Cannot write to the transaction log"</span>, e);
+<a name="l00195"></a>00195                 } <span class="keywordflow">else</span> <span class="keywordflow">if</span> ((<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span>) ret != size) {
+<a name="l00196"></a>00196                         <span class="keywordflow">throw</span> IOException(<span class="stringliteral">"Cannot atomically write to the transaction log"</span>);
+<a name="l00197"></a>00197                 }
+<a name="l00198"></a>00198         }
+<a name="l00199"></a>00199         <span class="comment"></span>
+<a name="l00200"></a>00200 <span class="comment">        /**</span>
+<a name="l00201"></a>00201 <span class="comment">         * Buffer must be at least txnId.size() + 1 + INT64_STR_BUFSIZE + 1 bytes.</span>
+<a name="l00202"></a>00202 <span class="comment">         */</span>
+<a name="l00203"></a>00203         <span class="keywordtype">char</span> *insertTxnIdAndTimestamp(<span class="keywordtype">char</span> *buffer) {
+<a name="l00204"></a>00204                 <span class="keywordtype">int</span> size;
+<a name="l00205"></a>00205                 
+<a name="l00206"></a>00206                 <span class="comment">// "txn-id-here"</span>
+<a name="l00207"></a>00207                 memcpy(buffer, txnId.c_str(), txnId.size());
+<a name="l00208"></a>00208                 buffer += txnId.size();
+<a name="l00209"></a>00209                 
+<a name="l00210"></a>00210                 <span class="comment">// "txn-id-here "</span>
+<a name="l00211"></a>00211                 *buffer = <span class="charliteral">' '</span>;
+<a name="l00212"></a>00212                 buffer++;
+<a name="l00213"></a>00213                 
+<a name="l00214"></a>00214                 <span class="comment">// "txn-id-here 123456"</span>
+<a name="l00215"></a>00215                 size = snprintf(buffer, INT64_STR_BUFSIZE, <span class="stringliteral">"%llu"</span>, SystemTime::getUsec());
+<a name="l00216"></a>00216                 <span class="keywordflow">if</span> (size &gt;= INT64_STR_BUFSIZE) {
+<a name="l00217"></a>00217                         <span class="comment">// The buffer is too small.</span>
+<a name="l00218"></a>00218                         <span class="keywordflow">throw</span> IOException(<span class="stringliteral">"Cannot format a new transaction log message timestamp."</span>);
+<a name="l00219"></a>00219                 }
+<a name="l00220"></a>00220                 buffer += size;
+<a name="l00221"></a>00221                 
+<a name="l00222"></a>00222                 <span class="comment">// "txn-id-here 123456 "</span>
+<a name="l00223"></a>00223                 *buffer = <span class="charliteral">' '</span>;
+<a name="l00224"></a>00224                 
+<a name="l00225"></a>00225                 <span class="keywordflow">return</span> buffer + 1;
+<a name="l00226"></a>00226         }
+<a name="l00227"></a>00227         
+<a name="l00228"></a>00228 <span class="keyword">public</span>:
+<a name="l00229"></a>00229         AnalyticsLog() { }
+<a name="l00230"></a>00230         
+<a name="l00231"></a>00231         AnalyticsLog(<span class="keyword">const</span> FileDescriptor &amp;handle, <span class="keyword">const</span> <span class="keywordtype">string</span> &amp;groupName, <span class="keyword">const</span> <span class="keywordtype">string</span> &amp;txnId,
+<a name="l00232"></a>00232                      <span class="keywordtype">bool</span> largeMessages)
+<a name="l00233"></a>00233         {
+<a name="l00234"></a>00234                 this-&gt;handle    = handle;
+<a name="l00235"></a>00235                 this-&gt;groupName = groupName;
+<a name="l00236"></a>00236                 this-&gt;txnId     = txnId;
+<a name="l00237"></a>00237                 this-&gt;largeMessages = largeMessages;
+<a name="l00238"></a>00238                 message(<span class="stringliteral">"ATTACH"</span>);
+<a name="l00239"></a>00239         }
+<a name="l00240"></a>00240         
+<a name="l00241"></a>00241         ~AnalyticsLog() {
+<a name="l00242"></a>00242                 <span class="keywordflow">if</span> (handle != -1) {
+<a name="l00243"></a>00243                         message(<span class="stringliteral">"DETACH"</span>);
+<a name="l00244"></a>00244                 }
+<a name="l00245"></a>00245         }
+<a name="l00246"></a>00246         
+<a name="l00247"></a>00247         <span class="keywordtype">void</span> message(<span class="keyword">const</span> StaticString &amp;text) {
+<a name="l00248"></a>00248                 <span class="keywordflow">if</span> (handle != -1 &amp;&amp; largeMessages) {
+<a name="l00249"></a>00249                         <span class="comment">// "txn-id-here 123456 "</span>
+<a name="l00250"></a>00250                         <span class="keywordtype">char</span> header[txnId.size() + 1 + INT64_STR_BUFSIZE + 1];
+<a name="l00251"></a>00251                         <span class="keywordtype">char</span> *end = insertTxnIdAndTimestamp(header);
+<a name="l00252"></a>00252                         <span class="keywordtype">char</span> sizeHeader[7];
+<a name="l00253"></a>00253                         
+<a name="l00254"></a>00254                         snprintf(sizeHeader, <span class="keyword">sizeof</span>(sizeHeader) - 1,
+<a name="l00255"></a>00255                                 <span class="stringliteral">"%4x "</span>, (<span class="keywordtype">int</span>) (end - header) + (<span class="keywordtype">int</span>) text.size() + 1);
+<a name="l00256"></a>00256                         sizeHeader[<span class="keyword">sizeof</span>(sizeHeader) - 1] = <span class="charliteral">'\0'</span>;
+<a name="l00257"></a>00257                         
+<a name="l00258"></a>00258                         MessageChannel channel(handle);
+<a name="l00259"></a>00259                         FileLock lock(handle);
+<a name="l00260"></a>00260                         channel.writeRaw(sizeHeader, strlen(sizeHeader));
+<a name="l00261"></a>00261                         channel.writeRaw(header, end - header);
+<a name="l00262"></a>00262                         channel.writeRaw(text);
+<a name="l00263"></a>00263                         channel.writeRaw(<span class="stringliteral">"\n"</span>);
+<a name="l00264"></a>00264                 } <span class="keywordflow">else</span> <span class="keywordflow">if</span> (handle != -1 &amp;&amp; !largeMessages) {
+<a name="l00265"></a>00265                         <span class="comment">// We want: "txn-id-here 123456 log message here\n"</span>
+<a name="l00266"></a>00266                         <span class="keywordtype">char</span> data[txnId.size() + 1 + INT64_STR_BUFSIZE + 1 + text.size() + 1];
+<a name="l00267"></a>00267                         <span class="keywordtype">char</span> *end;
+<a name="l00268"></a>00268                         
+<a name="l00269"></a>00269                         <span class="comment">// "txn-id-here 123456 "</span>
+<a name="l00270"></a>00270                         end = insertTxnIdAndTimestamp(data);
+<a name="l00271"></a>00271                         
+<a name="l00272"></a>00272                         <span class="comment">// "txn-id-here 123456 log message here"</span>
+<a name="l00273"></a>00273                         memcpy(end, text.c_str(), text.size());
+<a name="l00274"></a>00274                         end += text.size();
+<a name="l00275"></a>00275                         
+<a name="l00276"></a>00276                         <span class="comment">// "txn-id-here 123456 log message here\n"</span>
+<a name="l00277"></a>00277                         *end = <span class="charliteral">'\n'</span>;
+<a name="l00278"></a>00278                         end++;
+<a name="l00279"></a>00279                         
+<a name="l00280"></a>00280                         atomicWrite(data, end - data);
+<a name="l00281"></a>00281                 }
+<a name="l00282"></a>00282         }
+<a name="l00283"></a>00283         
+<a name="l00284"></a>00284         <span class="keywordtype">void</span> abort(<span class="keyword">const</span> StaticString &amp;text) {
+<a name="l00285"></a>00285                 <span class="keywordflow">if</span> (handle != -1 &amp;&amp; largeMessages) {
+<a name="l00286"></a>00286                         <span class="keywordtype">char</span> header[txnId.size() + 1 + INT64_STR_BUFSIZE + 1 + <span class="keyword">sizeof</span>(<span class="stringliteral">"ABORT: "</span>) - 1];
+<a name="l00287"></a>00287                         <span class="keywordtype">char</span> *end;
+<a name="l00288"></a>00288                         <span class="keywordtype">char</span> sizeHeader[7];
+<a name="l00289"></a>00289                         
+<a name="l00290"></a>00290                         <span class="comment">// "txn-id-here 123456 "</span>
+<a name="l00291"></a>00291                         end = insertTxnIdAndTimestamp(header);
+<a name="l00292"></a>00292                         <span class="comment">// "txn-id-here 123456 ABORT: "</span>
+<a name="l00293"></a>00293                         memcpy(end, <span class="stringliteral">"ABORT: "</span>, <span class="keyword">sizeof</span>(<span class="stringliteral">"ABORT: "</span>) - 1);
+<a name="l00294"></a>00294                         end += <span class="keyword">sizeof</span>(<span class="stringliteral">"ABORT: "</span>) - 1;
+<a name="l00295"></a>00295                         
+<a name="l00296"></a>00296                         snprintf(sizeHeader, <span class="keyword">sizeof</span>(sizeHeader) - 1,
+<a name="l00297"></a>00297                                 <span class="stringliteral">"%4x "</span>, (<span class="keywordtype">int</span>) (end - header) + (<span class="keywordtype">int</span>) text.size() + 1);
+<a name="l00298"></a>00298                         sizeHeader[<span class="keyword">sizeof</span>(sizeHeader) - 1] = <span class="charliteral">'\0'</span>;
+<a name="l00299"></a>00299                         
+<a name="l00300"></a>00300                         MessageChannel channel(handle);
+<a name="l00301"></a>00301                         FileLock lock(handle);
+<a name="l00302"></a>00302                         channel.writeRaw(sizeHeader, strlen(sizeHeader));
+<a name="l00303"></a>00303                         channel.writeRaw(header, end - header);
+<a name="l00304"></a>00304                         channel.writeRaw(text);
+<a name="l00305"></a>00305                         channel.writeRaw(<span class="stringliteral">"\n"</span>);
+<a name="l00306"></a>00306                 } <span class="keywordflow">else</span> <span class="keywordflow">if</span> (handle != -1 &amp;&amp; !largeMessages) {
+<a name="l00307"></a>00307                         <span class="comment">// We want: "txn-id-here 123456 ABORT: log message here\n"</span>
+<a name="l00308"></a>00308                         <span class="keywordtype">char</span> data[txnId.size() + 1 + INT64_STR_BUFSIZE + 1 +
+<a name="l00309"></a>00309                                 (<span class="keyword">sizeof</span>(<span class="stringliteral">"ABORT: "</span>) - 1) + text.size() + 1];
+<a name="l00310"></a>00310                         <span class="keywordtype">char</span> *end;
+<a name="l00311"></a>00311                         
+<a name="l00312"></a>00312                         <span class="comment">// "txn-id-here 123456 "</span>
+<a name="l00313"></a>00313                         end = insertTxnIdAndTimestamp(data);
+<a name="l00314"></a>00314                         
+<a name="l00315"></a>00315                         <span class="comment">// "txn-id-here 123456 ABORT: "</span>
+<a name="l00316"></a>00316                         memcpy(end, <span class="stringliteral">"ABORT: "</span>, <span class="keyword">sizeof</span>(<span class="stringliteral">"ABORT: "</span>) - 1);
+<a name="l00317"></a>00317                         end += <span class="keyword">sizeof</span>(<span class="stringliteral">"ABORT: "</span>) - 1;
+<a name="l00318"></a>00318                         
+<a name="l00319"></a>00319                         <span class="comment">// "txn-id-here 123456 ABORT: log message here\n"</span>
+<a name="l00320"></a>00320                         *end = <span class="charliteral">'\n'</span>;
+<a name="l00321"></a>00321                         end++;
+<a name="l00322"></a>00322                         
+<a name="l00323"></a>00323                         atomicWrite(data, end - data);
+<a name="l00324"></a>00324                 }
+<a name="l00325"></a>00325         }
+<a name="l00326"></a>00326         
+<a name="l00327"></a>00327         <span class="keywordtype">bool</span> isNull()<span class="keyword"> const </span>{
+<a name="l00328"></a>00328                 <span class="keywordflow">return</span> handle == -1;
+<a name="l00329"></a>00329         }
+<a name="l00330"></a>00330         
+<a name="l00331"></a>00331         <span class="keywordtype">string</span> getGroupName()<span class="keyword"> const </span>{
+<a name="l00332"></a>00332                 <span class="keywordflow">return</span> groupName;
+<a name="l00333"></a>00333         }
+<a name="l00334"></a>00334         
+<a name="l00335"></a>00335         <span class="keywordtype">string</span> getTxnId()<span class="keyword"> const </span>{
+<a name="l00336"></a>00336                 <span class="keywordflow">return</span> txnId;
+<a name="l00337"></a>00337         }
+<a name="l00338"></a>00338 };
+<a name="l00339"></a>00339 
+<a name="l00340"></a>00340 <span class="keyword">typedef</span> shared_ptr&lt;AnalyticsLog&gt; AnalyticsLogPtr;
+<a name="l00341"></a>00341 
+<a name="l00342"></a>00342 <span class="keyword">class </span>AnalyticsScopeLog {
+<a name="l00343"></a>00343 <span class="keyword">private</span>:
+<a name="l00344"></a>00344         AnalyticsLog *log;
+<a name="l00345"></a>00345         <span class="keyword">enum</span> {
+<a name="l00346"></a>00346                 NAME,
+<a name="l00347"></a>00347                 GRANULAR
+<a name="l00348"></a>00348         } type;
+<a name="l00349"></a>00349         <span class="keyword">union </span>{
+<a name="l00350"></a>00350                 <span class="keyword">const</span> <span class="keywordtype">char</span> *name;
+<a name="l00351"></a>00351                 <span class="keyword">struct </span>{
+<a name="l00352"></a>00352                         <span class="keyword">const</span> <span class="keywordtype">char</span> *endMessage;
+<a name="l00353"></a>00353                         <span class="keyword">const</span> <span class="keywordtype">char</span> *abortMessage;       
+<a name="l00354"></a>00354                 } granular;
+<a name="l00355"></a>00355         } data;
+<a name="l00356"></a>00356         <span class="keywordtype">bool</span> ok;
+<a name="l00357"></a>00357 <span class="keyword">public</span>:
+<a name="l00358"></a>00358         AnalyticsScopeLog(<span class="keyword">const</span> AnalyticsLogPtr &amp;log, <span class="keyword">const</span> <span class="keywordtype">char</span> *name) {
+<a name="l00359"></a>00359                 this-&gt;log = log.get();
+<a name="l00360"></a>00360                 type = NAME;
+<a name="l00361"></a>00361                 data.name = name;
+<a name="l00362"></a>00362                 ok = <span class="keyword">false</span>;
+<a name="l00363"></a>00363                 log-&gt;message(<span class="keywordtype">string</span>(<span class="stringliteral">"BEGIN: "</span>) + name);
+<a name="l00364"></a>00364         }
+<a name="l00365"></a>00365         
+<a name="l00366"></a>00366         AnalyticsScopeLog(<span class="keyword">const</span> AnalyticsLogPtr &amp;log, <span class="keyword">const</span> <span class="keywordtype">char</span> *beginMessage,
+<a name="l00367"></a>00367                           <span class="keyword">const</span> <span class="keywordtype">char</span> *endMessage, <span class="keyword">const</span> <span class="keywordtype">char</span> *abortMessage = NULL
+<a name="l00368"></a>00368         ) {
+<a name="l00369"></a>00369                 this-&gt;log = log.get();
+<a name="l00370"></a>00370                 type = GRANULAR;
+<a name="l00371"></a>00371                 data.granular.endMessage = endMessage;
+<a name="l00372"></a>00372                 data.granular.abortMessage = abortMessage;
+<a name="l00373"></a>00373                 ok = abortMessage == NULL;
+<a name="l00374"></a>00374                 log-&gt;message(beginMessage);
+<a name="l00375"></a>00375         }
+<a name="l00376"></a>00376         
+<a name="l00377"></a>00377         ~AnalyticsScopeLog() {
+<a name="l00378"></a>00378                 <span class="keywordflow">if</span> (type == NAME) {
+<a name="l00379"></a>00379                         <span class="keywordflow">if</span> (ok) {
+<a name="l00380"></a>00380                                 log-&gt;message(<span class="keywordtype">string</span>(<span class="stringliteral">"END: "</span>) + data.name);
+<a name="l00381"></a>00381                         } <span class="keywordflow">else</span> {
+<a name="l00382"></a>00382                                 log-&gt;message(<span class="keywordtype">string</span>(<span class="stringliteral">"FAIL: "</span>) + data.name);
+<a name="l00383"></a>00383                         }
+<a name="l00384"></a>00384                 } <span class="keywordflow">else</span> {
+<a name="l00385"></a>00385                         <span class="keywordflow">if</span> (ok) {
+<a name="l00386"></a>00386                                 log-&gt;message(data.granular.endMessage);
+<a name="l00387"></a>00387                         } <span class="keywordflow">else</span> {
+<a name="l00388"></a>00388                                 log-&gt;message(data.granular.abortMessage);
+<a name="l00389"></a>00389                         }
+<a name="l00390"></a>00390                 }
+<a name="l00391"></a>00391         }
+<a name="l00392"></a>00392         
+<a name="l00393"></a>00393         <span class="keywordtype">void</span> success() {
+<a name="l00394"></a>00394                 ok = <span class="keyword">true</span>;
+<a name="l00395"></a>00395         }
+<a name="l00396"></a>00396 };
+<a name="l00397"></a>00397 
+<a name="l00398"></a>00398 <span class="keyword">class </span>AnalyticsLogger {
+<a name="l00399"></a>00399 <span class="keyword">private</span>:
+<a name="l00400"></a>00400         <span class="keyword">struct </span>CachedFileHandle {
+<a name="l00401"></a>00401                 FileDescriptor fd;
+<a name="l00402"></a>00402                 time_t lastUsed;
+<a name="l00403"></a>00403         };
+<a name="l00404"></a>00404         
+<a name="l00405"></a>00405         <span class="keyword">typedef</span> map&lt;string, CachedFileHandle&gt; Cache;
+<a name="l00406"></a>00406         
+<a name="l00407"></a>00407         <span class="keywordtype">string</span> socketFilename;
+<a name="l00408"></a>00408         <span class="keywordtype">string</span> username;
+<a name="l00409"></a>00409         <span class="keywordtype">string</span> password;
+<a name="l00410"></a>00410         RandomGenerator randomGenerator;
+<a name="l00411"></a>00411         
+<a name="l00412"></a>00412         boost::mutex lock;
+<a name="l00413"></a>00413         Cache fileHandleCache;
+<a name="l00414"></a>00414         
+<a name="l00415"></a>00415         FileDescriptor openLogFile(<span class="keyword">const</span> StaticString &amp;groupName, <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <span class="keywordtype">long</span> timestamp,
+<a name="l00416"></a>00416                                    <span class="keyword">const</span> StaticString &amp;category = <span class="stringliteral">"web"</span>)
+<a name="l00417"></a>00417         {
+<a name="l00418"></a>00418                 <span class="keywordtype">string</span> logFile = determineLogFilename(<span class="stringliteral">""</span>, groupName, category, timestamp);
+<a name="l00419"></a>00419                 Cache::iterator it;
+<a name="l00420"></a>00420                 lock_guard&lt;boost::mutex&gt; l(lock);
+<a name="l00421"></a>00421                 
+<a name="l00422"></a>00422                 it = fileHandleCache.find(logFile);
+<a name="l00423"></a>00423                 <span class="keywordflow">if</span> (it == fileHandleCache.end()) {
+<a name="l00424"></a>00424                         <span class="comment">/* If there are more than 10 analytics groups then this server is probably</span>
+<a name="l00425"></a>00425 <span class="comment">                         * a low-traffic server or a shared host. In such a situation opening the</span>
+<a name="l00426"></a>00426 <span class="comment">                         * transaction log file won't be a significant performance bottleneck.</span>
+<a name="l00427"></a>00427 <span class="comment">                         * Therefore I think the hardcoded cache limit of 10 is justified.</span>
+<a name="l00428"></a>00428 <span class="comment">                         */</span>
+<a name="l00429"></a>00429                         <span class="keywordflow">while</span> (fileHandleCache.size() &gt;= 10) {
+<a name="l00430"></a>00430                                 Cache::iterator oldest_it = fileHandleCache.begin();
+<a name="l00431"></a>00431                                 it = oldest_it;
+<a name="l00432"></a>00432                                 it++;
+<a name="l00433"></a>00433                                 
+<a name="l00434"></a>00434                                 <span class="keywordflow">for</span> (; it != fileHandleCache.end(); it++) {
+<a name="l00435"></a>00435                                         <span class="keywordflow">if</span> (it-&gt;second.lastUsed &lt; oldest_it-&gt;second.lastUsed) {
+<a name="l00436"></a>00436                                                 oldest_it = it;
+<a name="l00437"></a>00437                                         }
+<a name="l00438"></a>00438                                 }
+<a name="l00439"></a>00439                                 
+<a name="l00440"></a>00440                                 fileHandleCache.erase(oldest_it);
+<a name="l00441"></a>00441                         }
+<a name="l00442"></a>00442                         
+<a name="l00443"></a>00443                         MessageClient client;
+<a name="l00444"></a>00444                         CachedFileHandle fileHandle;
+<a name="l00445"></a>00445                         vector&lt;string&gt; args;
+<a name="l00446"></a>00446                         
+<a name="l00447"></a>00447                         client.connect(socketFilename, username, password);
+<a name="l00448"></a>00448                         client.write(<span class="stringliteral">"open log file"</span>,
+<a name="l00449"></a>00449                                 groupName.c_str(),
+<a name="l00450"></a>00450                                 <a class="code" href="group__Support.html#gf6fab368d70c18fdf16bf5a24f630407" title="Convert anything to a string.">toString</a>(timestamp).c_str(),
+<a name="l00451"></a>00451                                 category.c_str(),
+<a name="l00452"></a>00452                                 NULL);
+<a name="l00453"></a>00453                         <span class="keywordflow">if</span> (!client.read(args)) {
+<a name="l00454"></a>00454                                 <span class="comment">// TODO: retry in a short while because the watchdog may restart</span>
+<a name="l00455"></a>00455                                 <span class="comment">// the logging server</span>
+<a name="l00456"></a>00456                                 <span class="keywordflow">throw</span> IOException(<span class="stringliteral">"The logging agent unexpectedly closed the connection."</span>);
+<a name="l00457"></a>00457                         }
+<a name="l00458"></a>00458                         <span class="keywordflow">if</span> (args[0] == <span class="stringliteral">"error"</span>) {
+<a name="l00459"></a>00459                                 <span class="keywordflow">throw</span> IOException(<span class="stringliteral">"The logging agent could not open the log file: "</span> + args[1]);
+<a name="l00460"></a>00460                         }
+<a name="l00461"></a>00461                         fileHandle.fd = client.readFileDescriptor();
+<a name="l00462"></a>00462                         fileHandle.lastUsed = SystemTime::get();
+<a name="l00463"></a>00463                         it = fileHandleCache.insert(make_pair(logFile, fileHandle)).first;
+<a name="l00464"></a>00464                 } <span class="keywordflow">else</span> {
+<a name="l00465"></a>00465                         it-&gt;second.lastUsed = SystemTime::get();
+<a name="l00466"></a>00466                 }
+<a name="l00467"></a>00467                 <span class="keywordflow">return</span> it-&gt;second.fd;
+<a name="l00468"></a>00468         }
+<a name="l00469"></a>00469         
+<a name="l00470"></a>00470         <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <span class="keywordtype">long</span> extractTimestamp(<span class="keyword">const</span> <span class="keywordtype">string</span> &amp;txnId)<span class="keyword"> const </span>{
+<a name="l00471"></a>00471                 <span class="keyword">const</span> <span class="keywordtype">char</span> *timestampBegin = strchr(txnId.c_str(), <span class="charliteral">'-'</span>);
+<a name="l00472"></a>00472                 <span class="keywordflow">if</span> (timestampBegin != NULL) {
+<a name="l00473"></a>00473                         <span class="keywordflow">return</span> atoll(timestampBegin + 1);
+<a name="l00474"></a>00474                 } <span class="keywordflow">else</span> {
+<a name="l00475"></a>00475                         <span class="keywordflow">return</span> 0;
+<a name="l00476"></a>00476                 }
+<a name="l00477"></a>00477         }
+<a name="l00478"></a>00478         
+<a name="l00479"></a>00479 <span class="keyword">public</span>:
+<a name="l00480"></a>00480         AnalyticsLogger() { }
+<a name="l00481"></a>00481         
+<a name="l00482"></a>00482         AnalyticsLogger(<span class="keyword">const</span> <span class="keywordtype">string</span> &amp;socketFilename, <span class="keyword">const</span> <span class="keywordtype">string</span> &amp;username, <span class="keyword">const</span> <span class="keywordtype">string</span> &amp;password) {
+<a name="l00483"></a>00483                 this-&gt;socketFilename = socketFilename;
+<a name="l00484"></a>00484                 this-&gt;username       = username;
+<a name="l00485"></a>00485                 this-&gt;password       = password;
+<a name="l00486"></a>00486         }
+<a name="l00487"></a>00487         
+<a name="l00488"></a>00488         <span class="keyword">static</span> <span class="keywordtype">string</span> determineGroupDir(<span class="keyword">const</span> <span class="keywordtype">string</span> &amp;dir, <span class="keyword">const</span> StaticString &amp;groupName) {
+<a name="l00489"></a>00489                 <span class="keywordtype">string</span> result = dir;
+<a name="l00490"></a>00490                 appendVersionAndGroupId(result, groupName);
+<a name="l00491"></a>00491                 <span class="keywordflow">return</span> result;
+<a name="l00492"></a>00492         }
+<a name="l00493"></a>00493         
+<a name="l00494"></a>00494         <span class="keyword">static</span> <span class="keywordtype">void</span> appendVersionAndGroupId(<span class="keywordtype">string</span> &amp;output, <span class="keyword">const</span> StaticString &amp;groupName) {
+<a name="l00495"></a>00495                 md5_state_t state;
+<a name="l00496"></a>00496                 md5_byte_t  digest[16];
+<a name="l00497"></a>00497                 <span class="keywordtype">char</span>        groupId[32];
+<a name="l00498"></a>00498                 
+<a name="l00499"></a>00499                 <span class="keywordflow">if</span> (output.capacity() &lt; 3 + 32) {
+<a name="l00500"></a>00500                         output.reserve(3 + 32);
+<a name="l00501"></a>00501                 }
+<a name="l00502"></a>00502                 output.append(<span class="stringliteral">"/1/"</span>, 3);
+<a name="l00503"></a>00503                 md5_init(&amp;state);
+<a name="l00504"></a>00504                 md5_append(&amp;state, (<span class="keyword">const</span> md5_byte_t *) groupName.data(), groupName.size());
+<a name="l00505"></a>00505                 md5_finish(&amp;state, digest);
+<a name="l00506"></a>00506                 <a class="code" href="namespacePassenger.html#1d4b16a419fe7231bc8b7036266f8131" title="Convert the given binary data to hexadecimal.">toHex</a>(StaticString((<span class="keyword">const</span> <span class="keywordtype">char</span> *) digest, 16), groupId);
+<a name="l00507"></a>00507                 output.append(groupId, 32);
+<a name="l00508"></a>00508         }
+<a name="l00509"></a>00509         
+<a name="l00510"></a>00510         <span class="keyword">static</span> <span class="keywordtype">string</span> determineLogFilename(<span class="keyword">const</span> <span class="keywordtype">string</span> &amp;dir, <span class="keyword">const</span> StaticString &amp;groupName,
+<a name="l00511"></a>00511                 <span class="keyword">const</span> StaticString &amp;category, <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <span class="keywordtype">long</span> timestamp)
+<a name="l00512"></a>00512         {
+<a name="l00513"></a>00513                 <span class="keyword">struct </span>tm tm;
+<a name="l00514"></a>00514                 time_t time_value;
+<a name="l00515"></a>00515                 <span class="keywordtype">char</span> time_str[14];
+<a name="l00516"></a>00516                 
+<a name="l00517"></a>00517                 time_value = timestamp / 1000000;
+<a name="l00518"></a>00518                 localtime_r(&amp;time_value, &amp;tm);
+<a name="l00519"></a>00519                 strftime(time_str, <span class="keyword">sizeof</span>(time_str), <span class="stringliteral">"%Y/%m/%d/%H"</span>, &amp;tm);
+<a name="l00520"></a>00520                 
+<a name="l00521"></a>00521                 <span class="keywordtype">string</span> filename;
+<a name="l00522"></a>00522                 filename.reserve(dir.size()
+<a name="l00523"></a>00523                         + (3 + 32)           <span class="comment">// version and group ID</span>
+<a name="l00524"></a>00524                         + 1                  <span class="comment">// "/"</span>
+<a name="l00525"></a>00525                         + category.size()
+<a name="l00526"></a>00526                         + 1                  <span class="comment">// "/"</span>
+<a name="l00527"></a>00527                         + <span class="keyword">sizeof</span>(time_str)   <span class="comment">// including null terminator, which we use as space for "/"</span>
+<a name="l00528"></a>00528                         + <span class="keyword">sizeof</span>(<span class="stringliteral">"log.txt"</span>)
+<a name="l00529"></a>00529                 );
+<a name="l00530"></a>00530                 filename.append(dir);
+<a name="l00531"></a>00531                 appendVersionAndGroupId(filename, groupName);
+<a name="l00532"></a>00532                 filename.append(1, <span class="charliteral">'/'</span>);
+<a name="l00533"></a>00533                 filename.append(category.c_str(), category.size());
+<a name="l00534"></a>00534                 filename.append(1, <span class="charliteral">'/'</span>);
+<a name="l00535"></a>00535                 filename.append(time_str);
+<a name="l00536"></a>00536                 filename.append(<span class="stringliteral">"/log.txt"</span>);
+<a name="l00537"></a>00537                 <span class="keywordflow">return</span> filename;
+<a name="l00538"></a>00538         }
+<a name="l00539"></a>00539         
+<a name="l00540"></a>00540         AnalyticsLogPtr newTransaction(<span class="keyword">const</span> <span class="keywordtype">string</span> &amp;groupName, <span class="keyword">const</span> StaticString &amp;category = <span class="stringliteral">"web"</span>,
+<a name="l00541"></a>00541                                        <span class="keywordtype">bool</span> largeMessages = <span class="keyword">false</span>)
+<a name="l00542"></a>00542         {
+<a name="l00543"></a>00543                 <span class="keywordflow">if</span> (socketFilename.empty()) {
+<a name="l00544"></a>00544                         <span class="keywordflow">return</span> <a class="code" href="group__Support.html#g41b6c4a82fed72531a147de0505a8396" title="Convenience shortcut for creating a shared_ptr.">ptr</a>(<span class="keyword">new</span> AnalyticsLog());
+<a name="l00545"></a>00545                 } <span class="keywordflow">else</span> {
+<a name="l00546"></a>00546                         <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <span class="keywordtype">long</span> timestamp = SystemTime::getUsec();
+<a name="l00547"></a>00547                         <span class="keywordtype">string</span> txnId = randomGenerator.generateHexString(4);
+<a name="l00548"></a>00548                         txnId.append(<span class="stringliteral">"-"</span>);
+<a name="l00549"></a>00549                         txnId.append(<a class="code" href="group__Support.html#gf6fab368d70c18fdf16bf5a24f630407" title="Convert anything to a string.">toString</a>(timestamp));
+<a name="l00550"></a>00550                         <span class="keywordflow">return</span> <a class="code" href="group__Support.html#g41b6c4a82fed72531a147de0505a8396" title="Convenience shortcut for creating a shared_ptr.">ptr</a>(<span class="keyword">new</span> AnalyticsLog(openLogFile(groupName, timestamp, category),
+<a name="l00551"></a>00551                                 groupName, txnId, largeMessages));
+<a name="l00552"></a>00552                 }
+<a name="l00553"></a>00553         }
+<a name="l00554"></a>00554         
+<a name="l00555"></a>00555         AnalyticsLogPtr continueTransaction(<span class="keyword">const</span> <span class="keywordtype">string</span> &amp;groupName, <span class="keyword">const</span> <span class="keywordtype">string</span> &amp;txnId,
+<a name="l00556"></a>00556                                             <span class="keyword">const</span> StaticString &amp;category = <span class="stringliteral">"web"</span>,
+<a name="l00557"></a>00557                                             <span class="keywordtype">bool</span> largeMessages = <span class="keyword">false</span>)
+<a name="l00558"></a>00558         {
+<a name="l00559"></a>00559                 <span class="keywordflow">if</span> (socketFilename.empty() || groupName.empty() || txnId.empty()) {
+<a name="l00560"></a>00560                         <span class="keywordflow">return</span> <a class="code" href="group__Support.html#g41b6c4a82fed72531a147de0505a8396" title="Convenience shortcut for creating a shared_ptr.">ptr</a>(<span class="keyword">new</span> AnalyticsLog());
+<a name="l00561"></a>00561                 } <span class="keywordflow">else</span> {
+<a name="l00562"></a>00562                         <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <span class="keywordtype">long</span> timestamp;
+<a name="l00563"></a>00563                         
+<a name="l00564"></a>00564                         timestamp = extractTimestamp(txnId);
+<a name="l00565"></a>00565                         <span class="keywordflow">if</span> (timestamp == 0) {
+<a name="l00566"></a>00566                                 TRACE_POINT();
+<a name="l00567"></a>00567                                 <span class="keywordflow">throw</span> ArgumentException(<span class="stringliteral">"Invalid transaction ID '"</span> + txnId + <span class="stringliteral">"'"</span>);
+<a name="l00568"></a>00568                         }
+<a name="l00569"></a>00569                         <span class="keywordflow">return</span> <a class="code" href="group__Support.html#g41b6c4a82fed72531a147de0505a8396" title="Convenience shortcut for creating a shared_ptr.">ptr</a>(<span class="keyword">new</span> AnalyticsLog(openLogFile(groupName, timestamp, category),
+<a name="l00570"></a>00570                                 groupName, txnId, largeMessages));
+<a name="l00571"></a>00571                 }
+<a name="l00572"></a>00572         }
+<a name="l00573"></a>00573         
+<a name="l00574"></a>00574         <span class="keywordtype">bool</span> isNull()<span class="keyword"> const </span>{
+<a name="l00575"></a>00575                 <span class="keywordflow">return</span> socketFilename.empty();
+<a name="l00576"></a>00576         }
+<a name="l00577"></a>00577 };
+<a name="l00578"></a>00578 
+<a name="l00579"></a>00579 <span class="keyword">typedef</span> shared_ptr&lt;AnalyticsLogger&gt; AnalyticsLoggerPtr;
+<a name="l00580"></a>00580 
+<a name="l00581"></a>00581 } <span class="comment">// namespace Passenger</span>
+<a name="l00582"></a>00582 
+<a name="l00583"></a>00583 <span class="preprocessor">#endif </span><span class="comment">/* _PASSENGER_LOGGING_H_ */</span>
+<a name="l00584"></a>00584 
 </pre></div></div>
-<hr size="1"><address style="text-align: right;"><small>Generated on Wed Apr 8 22:35:10 2009 for Passenger by&nbsp;
+<hr size="1"><address style="text-align: right;"><small>Generated on Sun Feb 21 12:22:45 2010 for Passenger by&nbsp;
 <a href="http://www.doxygen.org/index.html">
 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
 </body>