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.17 2012/09/20 21:19:23 jhurst Exp $
29 \brief message logging API
32 #include <asdcp/KM_util.h>
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)
94 WriteEntryToListeners(Entry);
96 if ( Entry.TestFilter(m_filter) )
97 m_Target.push_back(Entry);
100 //------------------------------------------------------------------------------------------
104 Kumu::StdioLogSink::WriteEntry(const LogEntry& Entry)
108 WriteEntryToListeners(Entry);
110 if ( Entry.TestFilter(m_filter) )
112 Entry.CreateStringWithOptions(buf, m_options);
113 fputs(buf.c_str(), m_stream);
118 //---------------------------------------------------------------------------------
122 // http://www.codeguru.com/forum/showthread.php?t=231165
125 Kumu::WinDbgLogSink::WriteEntry(const LogEntry& Entry)
129 WriteEntryToListeners(Entry);
131 if ( Entry.TestFilter(m_filter) )
133 Entry.CreateStringWithOptions(buf, m_options);
134 ::OutputDebugStringA(buf.c_str());
139 //------------------------------------------------------------------------------------------
145 Kumu::StreamLogSink::WriteEntry(const LogEntry& Entry)
149 WriteEntryToListeners(Entry);
151 if ( Entry.TestFilter(m_filter) )
153 Entry.CreateStringWithOptions(buf, m_options);
154 write(m_fd, buf.c_str(), buf.size());
158 // foolin with symbols
159 //------------------------------------------------------------------------------------------
161 int const SYSLOG_ALERT = LOG_ALERT;
162 int const SYSLOG_CRIT = LOG_CRIT;
163 int const SYSLOG_ERR = LOG_ERR;
164 int const SYSLOG_WARNING = LOG_WARNING;
165 int const SYSLOG_NOTICE = LOG_NOTICE;
166 int const SYSLOG_INFO = LOG_INFO;
167 int const SYSLOG_DEBUG = LOG_DEBUG;
175 //------------------------------------------------------------------------------------------
177 Kumu::SyslogLogSink::SyslogLogSink(const std::string& source_name, int facility)
180 facility = LOG_DAEMON;
182 openlog(source_name.c_str(), LOG_CONS|LOG_NDELAY||LOG_PID, facility);
185 Kumu::SyslogLogSink::~SyslogLogSink()
192 Kumu::SyslogLogSink::WriteEntry(const LogEntry& Entry)
196 switch ( Entry.Type )
198 case Kumu::LOG_ALERT: priority = SYSLOG_ALERT; break;
199 case Kumu::LOG_CRIT: priority = SYSLOG_CRIT; break;
200 case Kumu::LOG_ERROR: priority = SYSLOG_ERR; break;
201 case Kumu::LOG_WARN: priority = SYSLOG_WARNING; break;
202 case Kumu::LOG_NOTICE: priority = SYSLOG_NOTICE; break;
203 case Kumu::LOG_INFO: priority = SYSLOG_INFO; break;
204 case Kumu::LOG_DEBUG: priority = SYSLOG_DEBUG; break;
209 WriteEntryToListeners(Entry);
211 if ( Entry.TestFilter(m_filter) )
213 syslog(priority, "%s", Entry.Msg.substr(0, Entry.Msg.size() - 1).c_str());
219 Kumu::SyslogNameToFacility(const std::string& facility_name)
221 if ( facility_name == "LOG_DAEMON" ) return LOG_DAEMON;
222 if ( facility_name == "LOG_LOCAL0" ) return LOG_LOCAL0;
223 if ( facility_name == "LOG_LOCAL1" ) return LOG_LOCAL1;
224 if ( facility_name == "LOG_LOCAL2" ) return LOG_LOCAL2;
225 if ( facility_name == "LOG_LOCAL3" ) return LOG_LOCAL3;
226 if ( facility_name == "LOG_LOCAL4" ) return LOG_LOCAL4;
227 if ( facility_name == "LOG_LOCAL5" ) return LOG_LOCAL5;
228 if ( facility_name == "LOG_LOCAL6" ) return LOG_LOCAL6;
229 if ( facility_name == "LOG_LOCAL7" ) return LOG_LOCAL7;
231 DefaultLogSink().Error("Unsupported facility name: %s, using default value LOG_DAEMON\n", facility_name.c_str());
237 //------------------------------------------------------------------------------------------
240 std::basic_ostream<char, std::char_traits<char> >&
241 Kumu::operator<<(std::basic_ostream<char, std::char_traits<char> >& strm, LogEntry const& Entry)
243 std::basic_ostringstream<char, std::char_traits<char> > s;
248 s << Entry.CreateStringWithOptions(buf, LOG_OPTION_ALL);
254 //------------------------------------------------------------------------------------------
259 Kumu::LogEntry::TestFilter(i32_t filter) const
264 if ( (filter & LOG_ALLOW_CRIT) == 0 )
269 if ( (filter & LOG_ALLOW_ALERT) == 0 )
274 if ( (filter & LOG_ALLOW_NOTICE) == 0 )
279 if ( (filter & LOG_ALLOW_ERROR) == 0 )
284 if ( (filter & LOG_ALLOW_WARN) == 0 )
289 if ( (filter & LOG_ALLOW_INFO) == 0 )
294 if ( (filter & LOG_ALLOW_DEBUG) == 0 )
307 Kumu::LogEntry::CreateStringWithOptions(std::string& out_buf, i32_t opt) const
315 if ( (opt & LOG_OPTION_TIMESTAMP) != 0 )
318 out_buf += Now.EncodeString(buf, 64);
321 if ( (opt & LOG_OPTION_PID) != 0 )
323 if ( ! out_buf.empty() ) out_buf += " ";
324 snprintf(buf, 64, "%d", PID);
328 if ( (opt & LOG_OPTION_TYPE) != 0 )
330 if ( ! out_buf.empty() ) out_buf += " ";
334 case LOG_CRIT: out_buf += "CRT"; break;
335 case LOG_ALERT: out_buf += "ALR"; break;
336 case LOG_NOTICE: out_buf += "NTC"; break;
337 case LOG_ERROR: out_buf += "ERR"; break;
338 case LOG_WARN: out_buf += "WRN"; break;
339 case LOG_INFO: out_buf += "INF"; break;
340 case LOG_DEBUG: out_buf += "DBG"; break;
341 default: out_buf += "DFL"; break;
345 out_buf.insert(0, "[");
356 Kumu::LogEntry::ArchiveLength() const
358 return sizeof(ui32_t)
359 + EventTime.ArchiveLength()
361 + sizeof(ui32_t) + Msg.size();
366 Kumu::LogEntry::Archive(Kumu::MemIOWriter* Writer) const
368 if ( ! Writer->WriteUi32BE(PID) ) return false;
369 if ( ! EventTime.Archive(Writer) ) return false;
370 if ( ! Writer->WriteUi32BE(Type) ) return false;
371 if ( ! ArchiveString(*Writer, Msg) ) return false;
377 Kumu::LogEntry::Unarchive(Kumu::MemIOReader* Reader)
379 if ( ! Reader->ReadUi32BE(&PID) ) return false;
380 if ( ! EventTime.Unarchive(Reader) ) return false;
381 if ( ! Reader->ReadUi32BE((ui32_t*)&Type) ) return false;
382 if ( ! UnarchiveString(*Reader, Msg) ) return false;