logger.cpp

Go to the documentation of this file.

//-----------------------------------------------------------------------------------------
/*

Fix8 is released under the GNU LESSER GENERAL PUBLIC LICENSE Version 3.

Fix8 Open Source FIX Engine.
Copyright (C) 2010-16 David L. Dight <fix@fix8.org>

Fix8 is free software: you can  redistribute it and / or modify  it under the  terms of the
GNU Lesser General  Public License as  published  by the Free  Software Foundation,  either
version 3 of the License, or (at your option) any later version.

Fix8 is distributed in the hope  that it will be useful, but WITHOUT ANY WARRANTY;  without
even the  implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
You should  have received a copy of the GNU Lesser General Public  License along with Fix8.
If not, see <http://www.gnu.org/licenses/>.

BECAUSE THE PROGRAM IS  LICENSED FREE OF  CHARGE, THERE IS NO  WARRANTY FOR THE PROGRAM, TO
THE EXTENT  PERMITTED  BY  APPLICABLE  LAW.  EXCEPT WHEN  OTHERWISE  STATED IN  WRITING THE
COPYRIGHT HOLDERS AND/OR OTHER PARTIES  PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY
KIND,  EITHER EXPRESSED   OR   IMPLIED,  INCLUDING,  BUT   NOT  LIMITED   TO,  THE  IMPLIED
WARRANTIES  OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE ENTIRE RISK AS TO
THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE,
YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.

IN NO EVENT UNLESS REQUIRED  BY APPLICABLE LAW  OR AGREED TO IN  WRITING WILL ANY COPYRIGHT
HOLDER, OR  ANY OTHER PARTY  WHO MAY MODIFY  AND/OR REDISTRIBUTE  THE PROGRAM AS  PERMITTED
ABOVE,  BE  LIABLE  TO  YOU  FOR  DAMAGES,  INCLUDING  ANY  GENERAL, SPECIAL, INCIDENTAL OR
CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT
NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR
THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH
HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

*/
//-----------------------------------------------------------------------------------------
#include "precomp.hpp"
#include <fix8/f8includes.hpp>

//-------------------------------------------------------------------------------------------------
using namespace FIX8;
using namespace std;

//-------------------------------------------------------------------------------------------------
namespace FIX8
{
   char glob_log0[max_global_filename_length] { "global_filename_not_set.log" };

   const vector<string> Logger::_bit_names
   {
      "mstart", "sstart", "sequence", "thread", "timestamp", "minitimestamp", "direction", "level", "location",
      "append", "buffer", "compress", "pipe", "broadcast", "nolf", "inbound", "outbound", "xml"
   };

   const vector<string> Logger::_level_names { "Debug", "Info ", "Warn ", "Error", "Fatal" };

   const Tickval Logger::_started { true };
}

//-------------------------------------------------------------------------------------------------
int Logger::operator()()
{
   unsigned received(0);

   while (!_stopping)
   {
      LogElement *msg_ptr(0);

#if (FIX8_MPMC_SYSTEM == FIX8_MPMC_FF)
      if (!_msg_queue.try_pop(msg_ptr))
      {
         hypersleep<h_microseconds>(200);
         continue;
      }
#else
      LogElement msg;
      if (_stopping) // make sure we dequeue any pending msgs before exiting
      {
         if (!_msg_queue.try_pop(msg))
            break;
      }
      else
         _msg_queue.pop (msg); // will block
      msg_ptr = &msg;
#endif

      ++received;

      if (msg_ptr)
      {
         if (msg_ptr->_str.empty())  // means exit
         {
#if (FIX8_MPMC_SYSTEM == FIX8_MPMC_FF)
            break;
#else
            continue;
#endif
         }

         process_logline(msg_ptr);
      }
#if (FIX8_MPMC_SYSTEM == FIX8_MPMC_FF)
      _msg_queue.release(msg_ptr);
#endif
   }

   return 0;
}

//-------------------------------------------------------------------------------------------------
void Logger::process_logline(LogElement *msg_ptr)
{
   ostringstream ostr;
   f8_scoped_spin_lock posguard(_log_spl); // protect positions, allow app to change
   for (auto pp : _positions)
   {
      ostringstream fostr;
      if (pp < start_controls) switch (pp)
      {
      case mstart:
         {
            const Tickval tvs(msg_ptr->_when - _started);
            fostr << setw(11) << right << setfill('0') << (tvs.secs() * 1000 + tvs.msecs());
         }
         break;
      case sstart:
         fostr << setw(8) << right << setfill('0') << (msg_ptr->_when - _started).secs();
         break;
      case sequence:
         fostr << setw(7) << right << setfill('0');
         if (_flags & direction)
            fostr << (msg_ptr->_val ? ++_sequence  : ++_osequence);
         else
            fostr << ++_sequence;
         break;
      case thread:
         fostr << get_thread_code(msg_ptr->_tid);
         break;
      case location:
         if (msg_ptr->_fileline)
            fostr << msg_ptr->_fileline;
         break;
      case direction:
         fostr << (msg_ptr->_val ? " in" : "out");
         break;
      case timestamp:
         fostr << msg_ptr->_when;
         break;
      case minitimestamp:
         fostr << GetTimeAsStringMini(&msg_ptr->_when);
         break;
      case level:
         fostr << _level_names[msg_ptr->_level];
         break;
      default:
         break;
      }

      if (!fostr.str().empty())
      {
         if (_delim.size() > 1)
            ostr << _delim[0] << fostr.str() << _delim[1];
         else
            ostr << fostr.str() << _delim;
      }
   }
   posguard.release();

   if (_flags & buffer)
   {
      string result(ostr.str());
      if (_delim.size() > 1)
      {
         result += _delim[0];
         result += msg_ptr->_str;
         result += _delim[1];
      }
      else
         result += msg_ptr->_str;
      _buffer.push_back(result);
   }
   else
   {
      f8_scoped_lock guard(_mutex);
      if (_delim.size() > 1)
         get_stream() << ostr.str() << _delim[0] << msg_ptr->_str << _delim[1];
      else
         get_stream() << ostr.str() << msg_ptr->_str;
      if (_flags & nolf)
         get_stream().flush();
      else
         get_stream() << endl;
   }
}

//-------------------------------------------------------------------------------------------------
void Logger::flush()
{
   f8_scoped_lock guard(_mutex);
   for (const auto& pp : _buffer)
      get_stream() << pp << endl;
   _buffer.clear();
   _lines = 0;
}

//-------------------------------------------------------------------------------------------------
void Logger::purge_thread_codes()
{
#if (FIX8_THREAD_SYSTEM == FIX8_THREAD_PTHREAD)
   f8_scoped_lock guard(_mutex);

   for (ThreadCodes::iterator itr(_thread_codes.begin()); itr != _thread_codes.end();)
   {
#if defined _MSC_VER || defined __APPLE__
      // If ESRCH then thread is definitely dead.  Otherwise, we're unsure.
      if (pthread_kill(itr->first, 0) == ESRCH)
#else
      // a little trick to see if a thread is still alive
      clockid_t clock_id;
      if (pthread_getcpuclockid(itr->first, &clock_id) == ESRCH)
#endif
      {
         _rev_thread_codes.erase(itr->second);
         _thread_codes.erase(itr++); // post inc, takes copy before incr;
      }
      else
         ++itr;
   }
#endif
}

//-------------------------------------------------------------------------------------------------
char Logger::get_thread_code(thread_id_t tid)
{
   f8_scoped_lock guard(_mutex);

   ThreadCodes::const_iterator itr(_thread_codes.find(tid));
   if (itr != _thread_codes.end())
      return itr->second;

   for (char acode('A'); acode < 127; ++acode)  // A-~ will allow for 86 threads
   {
      RevThreadCodes::const_iterator itr(_rev_thread_codes.find(acode));
      if (itr == _rev_thread_codes.end())
      {
         _thread_codes.insert({tid, acode});
         _rev_thread_codes.insert({acode, tid});
         return acode;
      }
   }

   return '?';
}

//-------------------------------------------------------------------------------------------------
FileLogger::FileLogger(const string& fname, const LogFlags flags, const Levels levels,
   const std::string delim, const LogPositions positions, const unsigned rotnum)
   : Logger(flags, levels, delim, positions), _rotnum(rotnum)
{
   if (!fname.empty())
   {
      _pathname = fname;
      rotate();
   }
}

//-------------------------------------------------------------------------------------------------
bool FileLogger::rotate(bool force)
{
   f8_scoped_lock guard(_mutex);

   delete _ofs;

   string thislFile(_pathname), filepart, dirpart;
   split_path(thislFile, filepart, dirpart);
   if (!dirpart.empty() && !exist(dirpart))
      create_path(dirpart);

#ifdef HAVE_COMPRESSION
   if (_flags & compress)
      thislFile += ".gz";
#endif
   if (_rotnum > 0 && (!_flags.has(append) || force))
   {
      vector<string> rlst;
      rlst.push_back(thislFile);

      for (unsigned ii(0); ii < _rotnum && ii < max_rotation; ++ii)
      {
         ostringstream ostr;
         ostr << _pathname << '.' << (ii + 1);
         if (_flags & compress)
            ostr << ".gz";
         rlst.push_back(ostr.str());
      }

      for (unsigned ii(_rotnum); ii; --ii)
         rename (rlst[ii - 1].c_str(), rlst[ii].c_str());
   }

   const ios_base::openmode mode (_flags & append ? ios_base::out | ios_base::app : ios_base::out);
#ifdef HAVE_COMPRESSION
   if (_flags & compress)
      _ofs = new ogzstream(thislFile.c_str(), mode);
   else
#endif
      _ofs = new ofstream(thislFile.c_str(), mode);

   if (!_ofs || !*_ofs)
      throw LogfileException(thislFile);

   return true;
}

//-------------------------------------------------------------------------------------------------
PipeLogger::PipeLogger(const string& fname, const LogFlags flags, const Levels levels,
   const std::string delim, const LogPositions positions)
   : Logger(flags, levels, delim, positions)
{
   const string pathname(fname.substr(1));

   if (fname[0] != '|')
      throw f8Exception("pipe command must be prefixed with '|'");

#ifdef _MSC_VER
   FILE *pcmd(_popen(pathname.c_str(), "w"));
#else
   FILE *pcmd(popen(pathname.c_str(), "w"));
#endif

   if (pcmd == 0)
      glout_info << "PipeLogger: " << pathname << ": failed to execute";
   else
   {
      _ofs = new fptrostream(pcmd);
      _flags |= pipe;
   }
}

//-------------------------------------------------------------------------------------------------
// nc -lu 127.0.0.1 -p 51000
BCLogger::BCLogger(Poco::Net::DatagramSocket *sock, const LogFlags flags, const Levels levels,
   const std::string delim, const LogPositions positions)
   : Logger(flags, levels, delim, positions), _init_ok(true)
{
   _ofs = new bcostream(sock);
   _flags |= broadcast;
}

BCLogger::BCLogger(const string& ip, const unsigned port, const LogFlags flags, const Levels levels,
   const std::string delim, const LogPositions positions)
   : Logger(flags, levels, delim, positions), _init_ok()
{
   Poco::Net::IPAddress ipaddr;
   if (Poco::Net::IPAddress::tryParse(ip, ipaddr)
      && (ipaddr.isGlobalMC() || ipaddr.isMulticast() || ipaddr.isBroadcast()
      || ipaddr.isLinkLocalMC() || ipaddr.isUnicast() || ipaddr.isWellKnownMC()
      || ipaddr.isSiteLocalMC() || ipaddr.isOrgLocalMC()))
   {
      Poco::Net::SocketAddress saddr(ipaddr, port);
      Poco::Net::DatagramSocket *dgs(new Poco::Net::DatagramSocket);
      if (ipaddr.isBroadcast())
         dgs->setBroadcast(true);
      dgs->connect(saddr);
      _ofs = new bcostream(dgs);
      _flags |= broadcast;
      _init_ok = true;
   }
}

//-------------------------------------------------------------------------------------------------
void XmlFileLogger::process_logline(LogElement *msg_ptr)
{
   f8String spacer(3, ' ');
   ostringstream ostr;

   ostr << spacer << "<logline ";
   if (_flags & mstart)
   {
      const Tickval tvs(msg_ptr->_when - _started);
      ostr << "mstart=\'" << (tvs.secs() * 1000 + tvs.msecs()) << "\' ";
   }
   if (_flags & sstart)
      ostr << "sstart=\'" << (msg_ptr->_when - _started).secs() << "\' ";
   if (_flags & sequence)
      ostr << "sequence=\'" << (_flags & direction ? (msg_ptr->_val ? ++_sequence  : ++_osequence) : ++_sequence) << "\' ";
   if (_flags & thread)
      ostr << "thread=\'" << get_thread_code(msg_ptr->_tid) << "\' ";
   if (_flags & location && msg_ptr->_fileline)
      ostr << "location=\'" << msg_ptr->_fileline << "\' ";
   if (_flags & direction)
      ostr << "direction=\'" << (msg_ptr->_val ? " in" : "out") << "\' ";
   if (_flags & timestamp)
      ostr << "timestamp=\'" << msg_ptr->_when << "\' ";
   if (_flags & minitimestamp)
      ostr << "minitimestamp=\'" << GetTimeAsStringMini(&msg_ptr->_when) << "\' ";
   if (_flags & level)
      ostr << "level=\'" << _level_names[msg_ptr->_level] << "\' ";

   ostr << "text=\'" << msg_ptr->_str << "\'/>";
   f8_scoped_lock guard(_mutex);
   get_stream() << ostr.str() << endl;
}