mirror of
https://github.com/nasa/fprime.git
synced 2025-12-11 13:54:34 -06:00
e5543358dd
This avoids a pernicious behavior where EVR timestamps lie about their
sub-second values. I have this test program:
#include <stdio.h>
#include <inttypes.h>
void main(void)
{
printf("%02d:%02d:%02d.%03" PRIu32 "\n", 1,2,3, 12);
printf("%02d:%02d:%02d.%03" PRIu32 "\n", 1,2,3, 123);
printf("%02d:%02d:%02d.%03" PRIu32 "\n", 1,2,3, 1234);
printf("%02d:%02d:%02d.%03" PRIu32 "\n", 1,2,3, 12356);
printf("%02d:%02d:%02d.%03" PRIu32 "\n", 1,2,3, 123456);
}
It produces this output:
01:02:03.012
01:02:03.123
01:02:03.1234
01:02:03.12356
01:02:03.123456
so prior to this patch, if we were 1 hour, 2 minutes, 3 seconds, 123
microseconds past midnight, this was printed as "01:02:03.123" instead of
"01:02:03.000123". Any reasonable human looking at "01:02:03.123" would see a
value of "123000" microseconds.
Co-authored-by: Dima Kogan <Dmitriy.Kogan@jpl.nasa.gov>
144 lines
5.5 KiB
C++
144 lines
5.5 KiB
C++
// \copyright
|
|
// Copyright 2009-2015, by the California Institute of Technology.
|
|
// ALL RIGHTS RESERVED. United States Government Sponsorship
|
|
// acknowledged.
|
|
|
|
#include <Svc/ActiveTextLogger/ActiveTextLoggerImpl.hpp>
|
|
#include <Fw/Types/Assert.hpp>
|
|
#include <Fw/Logger/Logger.hpp>
|
|
#include <ctime>
|
|
|
|
namespace Svc {
|
|
|
|
// ----------------------------------------------------------------------
|
|
// Initialization/Exiting
|
|
// ----------------------------------------------------------------------
|
|
|
|
ActiveTextLoggerComponentImpl::ActiveTextLoggerComponentImpl(const char* name) :
|
|
ActiveTextLoggerComponentBase(name),
|
|
m_log_file()
|
|
{
|
|
|
|
}
|
|
|
|
ActiveTextLoggerComponentImpl::~ActiveTextLoggerComponentImpl()
|
|
{
|
|
|
|
}
|
|
|
|
void ActiveTextLoggerComponentImpl::init(NATIVE_INT_TYPE queueDepth, NATIVE_INT_TYPE instance)
|
|
{
|
|
ActiveTextLoggerComponentBase::init(queueDepth,instance);
|
|
}
|
|
|
|
// ----------------------------------------------------------------------
|
|
// Handlers to implement for typed input ports
|
|
// ----------------------------------------------------------------------
|
|
|
|
void ActiveTextLoggerComponentImpl::TextLogger_handler(NATIVE_INT_TYPE portNum,
|
|
FwEventIdType id,
|
|
Fw::Time &timeTag,
|
|
const Fw::LogSeverity& severity,
|
|
Fw::TextLogString &text)
|
|
{
|
|
|
|
// Currently not doing any input filtering
|
|
// TKC - 5/3/2018 - remove diagnostic
|
|
if (Fw::LogSeverity::DIAGNOSTIC == severity.e) {
|
|
return;
|
|
}
|
|
|
|
// Format the string here, so that it is done in the task context
|
|
// of the caller. Format doc borrowed from PassiveTextLogger.
|
|
const char *severityString = "UNKNOWN";
|
|
switch (severity.e) {
|
|
case Fw::LogSeverity::FATAL:
|
|
severityString = "FATAL";
|
|
break;
|
|
case Fw::LogSeverity::WARNING_HI:
|
|
severityString = "WARNING_HI";
|
|
break;
|
|
case Fw::LogSeverity::WARNING_LO:
|
|
severityString = "WARNING_LO";
|
|
break;
|
|
case Fw::LogSeverity::COMMAND:
|
|
severityString = "COMMAND";
|
|
break;
|
|
case Fw::LogSeverity::ACTIVITY_HI:
|
|
severityString = "ACTIVITY_HI";
|
|
break;
|
|
case Fw::LogSeverity::ACTIVITY_LO:
|
|
severityString = "ACTIVITY_LO";
|
|
break;
|
|
case Fw::LogSeverity::DIAGNOSTIC:
|
|
severityString = "DIAGNOSTIC";
|
|
break;
|
|
default:
|
|
severityString = "SEVERITY ERROR";
|
|
break;
|
|
}
|
|
|
|
// TODO: Add calling task id to format string
|
|
char textStr[FW_INTERNAL_INTERFACE_STRING_MAX_SIZE];
|
|
|
|
if (timeTag.getTimeBase() == TB_WORKSTATION_TIME) {
|
|
|
|
time_t t = timeTag.getSeconds();
|
|
// Using localtime_r prevents any other calls to localtime (from another thread for example) from
|
|
// interfering with our time object before we use it. However, the null pointer check is still needed
|
|
// to ensure a successful call
|
|
tm tm;
|
|
if (localtime_r(&t, &tm) == nullptr) {
|
|
return;
|
|
}
|
|
|
|
(void) snprintf(textStr,
|
|
FW_INTERNAL_INTERFACE_STRING_MAX_SIZE,
|
|
"EVENT: (%" PRI_FwEventIdType ") (%04d-%02d-%02dT%02d:%02d:%02d.%06" PRIu32 ") %s: %s\n",
|
|
id, tm.tm_year + 1900, tm.tm_mon + 1, tm.tm_mday, tm.tm_hour,
|
|
tm.tm_min,tm.tm_sec,timeTag.getUSeconds(),
|
|
severityString,text.toChar());
|
|
}
|
|
else {
|
|
|
|
(void) snprintf(textStr,
|
|
FW_INTERNAL_INTERFACE_STRING_MAX_SIZE,
|
|
"EVENT: (%" PRI_FwEventIdType ") (%" PRI_FwTimeBaseStoreType ":%" PRId32 ",%" PRId32 ") %s: %s\n",
|
|
id, static_cast<FwTimeBaseStoreType>(timeTag.getTimeBase()),timeTag.getSeconds(),timeTag.getUSeconds(),severityString,text.toChar());
|
|
}
|
|
|
|
// Call internal interface so that everything else is done on component thread,
|
|
// this helps ensure consistent ordering of the printed text:
|
|
Fw::InternalInterfaceString intText(textStr);
|
|
this->TextQueue_internalInterfaceInvoke(intText);
|
|
}
|
|
|
|
// ----------------------------------------------------------------------
|
|
// Internal interface handlers
|
|
// ----------------------------------------------------------------------
|
|
|
|
void ActiveTextLoggerComponentImpl::TextQueue_internalInterfaceHandler(const Fw::InternalInterfaceString& text)
|
|
{
|
|
|
|
// Print to console:
|
|
Fw::Logger::logMsg(text.toChar(),0,0,0,0,0,0,0,0,0);
|
|
|
|
// Print to file if there is one:
|
|
(void) this->m_log_file.write_to_log(text.toChar(), text.length()); // Ignoring return status
|
|
|
|
}
|
|
|
|
// ----------------------------------------------------------------------
|
|
// Helper Methods
|
|
// ----------------------------------------------------------------------
|
|
|
|
bool ActiveTextLoggerComponentImpl::set_log_file(const char* fileName, const U32 maxSize, const U32 maxBackups)
|
|
{
|
|
FW_ASSERT(fileName != nullptr);
|
|
|
|
return this->m_log_file.set_log_file(fileName, maxSize, maxBackups);
|
|
}
|
|
|
|
|
|
} // namespace Svc
|