2 Copyright (c) 2004-2011, John Hurst
5 Redistribution and use in source and binary forms, with or without
6 modification, are permitted provided that the following conditions
8 1. Redistributions of source code must retain the above copyright
9 notice, this list of conditions and the following disclaimer.
10 2. Redistributions in binary form must reproduce the above copyright
11 notice, this list of conditions and the following disclaimer in the
12 documentation and/or other materials provided with the distribution.
13 3. The name of the author may not be used to endorse or promote products
14 derived from this software without specific prior written permission.
16 THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
17 IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
18 OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
19 IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
20 INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
21 NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
22 DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
23 THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
25 THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 \version $Id: KM_log.cpp,v 1.15 2011/03/08 19:03:47 jhurst Exp $
29 \brief message logging API
35 #include <sys/types.h>
42 #define getpid GetCurrentProcessId
47 //------------------------------------------------------------------------------------------
51 Kumu::ILogSink::vLogf(LogType_t type, const char* fmt, va_list* list)
53 char buf[MaxLogLength];
54 vsnprintf(buf, MaxLogLength, fmt, *list);
56 WriteEntry(LogEntry(getpid(), type, buf));
59 //------------------------------------------------------------------------------------------
62 static Kumu::Mutex s_DefaultLogSinkLock;
63 static Kumu::ILogSink* s_DefaultLogSink = 0;
64 static Kumu::StdioLogSink s_StderrLogSink;
68 Kumu::SetDefaultLogSink(ILogSink* Sink)
70 AutoMutex L(s_DefaultLogSinkLock);
71 s_DefaultLogSink = Sink;
74 // Returns the internal default sink.
76 Kumu::DefaultLogSink()
78 AutoMutex L(s_DefaultLogSinkLock);
80 if ( s_DefaultLogSink == 0 )
81 s_DefaultLogSink = &s_StderrLogSink;
83 return *s_DefaultLogSink;
87 //------------------------------------------------------------------------------------------
91 Kumu::EntryListLogSink::WriteEntry(const LogEntry& Entry)
95 if ( Entry.TestFilter(m_filter) )
96 m_Target.push_back(Entry);
99 //------------------------------------------------------------------------------------------
103 Kumu::StdioLogSink::WriteEntry(const LogEntry& Entry)
108 if ( Entry.TestFilter(m_filter) )
110 Entry.CreateStringWithOptions(buf, m_options);
111 fputs(buf.c_str(), m_stream);
115 //---------------------------------------------------------------------------------
119 // http://www.codeguru.com/forum/showthread.php?t=231165
122 Kumu::WinDbgLogSink::WriteEntry(const LogEntry& Entry)
127 if ( Entry.TestFilter(m_filter) )
129 Entry.CreateStringWithOptions(buf, m_options);
130 ::OutputDebugStringA(buf.c_str());
135 //------------------------------------------------------------------------------------------
141 Kumu::StreamLogSink::WriteEntry(const LogEntry& Entry)
146 if ( Entry.TestFilter(m_filter) )
148 Entry.CreateStringWithOptions(buf, m_options);
149 write(m_fd, buf.c_str(), buf.size());
153 // foolin with symbols
154 //------------------------------------------------------------------------------------------
156 int const SYSLOG_ALERT = LOG_ALERT;
157 int const SYSLOG_CRIT = LOG_CRIT;
158 int const SYSLOG_ERR = LOG_ERR;
159 int const SYSLOG_WARNING = LOG_WARNING;
160 int const SYSLOG_NOTICE = LOG_NOTICE;
161 int const SYSLOG_INFO = LOG_INFO;
162 int const SYSLOG_DEBUG = LOG_DEBUG;
170 //------------------------------------------------------------------------------------------
172 Kumu::SyslogLogSink::SyslogLogSink(const std::string& source_name, int facility)
175 facility = LOG_DAEMON;
177 openlog(source_name.c_str(), LOG_CONS|LOG_NDELAY||LOG_PID, facility);
180 Kumu::SyslogLogSink::~SyslogLogSink()
187 Kumu::SyslogLogSink::WriteEntry(const LogEntry& Entry)
191 switch ( Entry.Type )
193 case Kumu::LOG_ALERT: priority = SYSLOG_ALERT; break;
194 case Kumu::LOG_CRIT: priority = SYSLOG_CRIT; break;
195 case Kumu::LOG_ERROR: priority = SYSLOG_ERR; break;
196 case Kumu::LOG_WARN: priority = SYSLOG_WARNING; break;
197 case Kumu::LOG_NOTICE: priority = SYSLOG_NOTICE; break;
198 case Kumu::LOG_INFO: priority = SYSLOG_INFO; break;
199 case Kumu::LOG_DEBUG: priority = SYSLOG_DEBUG; break;
204 if ( Entry.TestFilter(m_filter) )
206 syslog(priority, "%s", Entry.Msg.substr(0, Entry.Msg.size() - 1).c_str());
212 Kumu::SyslogNameToFacility(const std::string& facility_name)
214 if ( facility_name == "LOG_DAEMON" ) return LOG_DAEMON;
215 if ( facility_name == "LOG_LOCAL0" ) return LOG_LOCAL0;
216 if ( facility_name == "LOG_LOCAL1" ) return LOG_LOCAL1;
217 if ( facility_name == "LOG_LOCAL2" ) return LOG_LOCAL2;
218 if ( facility_name == "LOG_LOCAL3" ) return LOG_LOCAL3;
219 if ( facility_name == "LOG_LOCAL4" ) return LOG_LOCAL4;
220 if ( facility_name == "LOG_LOCAL5" ) return LOG_LOCAL5;
221 if ( facility_name == "LOG_LOCAL6" ) return LOG_LOCAL6;
222 if ( facility_name == "LOG_LOCAL7" ) return LOG_LOCAL7;
224 DefaultLogSink().Error("Unsupported facility name: %s, using default value LOG_DAEMON\n", facility_name.c_str());
230 //------------------------------------------------------------------------------------------
233 std::basic_ostream<char, std::char_traits<char> >&
234 Kumu::operator<<(std::basic_ostream<char, std::char_traits<char> >& strm, LogEntry const& Entry)
236 std::basic_ostringstream<char, std::char_traits<char> > s;
241 s << Entry.CreateStringWithOptions(buf, LOG_OPTION_ALL);
247 //------------------------------------------------------------------------------------------
252 Kumu::LogEntry::TestFilter(i32_t filter) const
257 if ( (filter & LOG_ALLOW_CRIT) == 0 )
262 if ( (filter & LOG_ALLOW_ALERT) == 0 )
267 if ( (filter & LOG_ALLOW_NOTICE) == 0 )
272 if ( (filter & LOG_ALLOW_ERROR) == 0 )
277 if ( (filter & LOG_ALLOW_WARN) == 0 )
282 if ( (filter & LOG_ALLOW_INFO) == 0 )
287 if ( (filter & LOG_ALLOW_DEBUG) == 0 )
298 Kumu::LogEntry::CreateStringWithOptions(std::string& out_buf, i32_t opt) const
306 if ( (opt & LOG_OPTION_TIMESTAMP) != 0 )
309 out_buf += Now.EncodeString(buf, 64);
312 if ( (opt & LOG_OPTION_PID) != 0 )
314 if ( ! out_buf.empty() ) out_buf += " ";
315 snprintf(buf, 64, "%d", PID);
319 if ( (opt & LOG_OPTION_TYPE) != 0 )
321 if ( ! out_buf.empty() ) out_buf += " ";
325 case LOG_CRIT: out_buf += "CRT"; break;
326 case LOG_ALERT: out_buf += "ALR"; break;
327 case LOG_NOTICE: out_buf += "NTC"; break;
328 case LOG_ERROR: out_buf += "ERR"; break;
329 case LOG_WARN: out_buf += "WRN"; break;
330 case LOG_INFO: out_buf += "INF"; break;
331 case LOG_DEBUG: out_buf += "DBG"; break;
332 default: out_buf += "DFL"; break;
336 out_buf.insert(0, "[");
347 Kumu::LogEntry::ArchiveLength() const
349 return sizeof(ui32_t)
350 + EventTime.ArchiveLength()
352 + sizeof(ui32_t) + Msg.size();
357 Kumu::LogEntry::Archive(Kumu::MemIOWriter* Writer) const
359 if ( ! Writer->WriteUi32BE(PID) ) return false;
360 if ( ! EventTime.Archive(Writer) ) return false;
361 if ( ! Writer->WriteUi32BE(Type) ) return false;
362 if ( ! ArchiveString(*Writer, Msg) ) return false;
368 Kumu::LogEntry::Unarchive(Kumu::MemIOReader* Reader)
370 if ( ! Reader->ReadUi32BE(&PID) ) return false;
371 if ( ! EventTime.Unarchive(Reader) ) return false;
372 if ( ! Reader->ReadUi32BE((ui32_t*)&Type) ) return false;
373 if ( ! UnarchiveString(*Reader, Msg) ) return false;