1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
|
/*
* Logger.cpp
*
* Created on: 17 Sep 2017
* Author: David
*/
#include "Logger.h"
#if HAS_MASS_STORAGE
#include "OutputMemory.h"
#include "RepRap.h"
#include "Platform.h"
#include "Version.h"
// Simple lock class that sets a variable true when it is created and makes sure it gets set false when it falls out of scope
class Lock
{
public:
Lock(bool& pb) : b(pb) { b = true; }
~Lock() { b = false; }
private:
bool& b;
};
Logger::Logger(LogLevel logLvl) noexcept : logFile(), lastFlushTime(0), lastFlushFileSize(0), dirty(false), inLogger(false), logLevel(logLvl)
{
}
void Logger::Start(time_t time, const StringRef& filename) noexcept
{
if (!inLogger && logLevel > LogLevel::off)
{
Lock loggerLock(inLogger);
FileStore * const f = reprap.GetPlatform().OpenSysFile(filename.c_str(), OpenMode::append);
if (f != nullptr)
{
logFile.Set(f);
lastFlushFileSize = logFile.Length();
logFile.Seek(lastFlushFileSize);
logFileName.copy(filename.c_str());
String<StringLength50> startMessage;
startMessage.printf("Event logging started at level %s\n", logLevel.ToString());
InternalLogMessage(time, startMessage.c_str(), MessageLogLevel::info);
LogFirmwareInfo(time);
reprap.StateUpdated();
}
}
}
// TODO: Move this to a more sensible location ?
void Logger::LogFirmwareInfo(time_t time) noexcept
{
const size_t versionStringLength = 80
#if 0 && SUPPORT_CAN_EXPANSION // TODO enable this once the part below is cleaned up
+ reprap.GetExpansion().GetNumExpansionBoards() + 1 * 80
#endif
;
char buffer[versionStringLength];
StringRef firmwareInfo(buffer, ARRAY_SIZE(buffer)); // This is huge but should accommodate around 20 boards
firmwareInfo.printf("Running: %s: %s (%s%s)", reprap.GetPlatform().GetElectronicsString(), VERSION, DATE, TIME_SUFFIX);
#if 0 && SUPPORT_CAN_EXPANSION // TODO this needs some rework - for now the main board is used only
for (size_t i = 1; i < reprap.GetExpansion().GetNumExpansionBoards() + 1; ++i)
{
auto expansionBoardData = reprap.GetExpansion().FindIndexedBoard(i);
firmwareInfo.catf(" - %s", expansionBoardData.typeName);
}
#endif
InternalLogMessage(time, firmwareInfo.c_str(), MessageLogLevel::info);
}
void Logger::Stop(time_t time) noexcept
{
if (logFile.IsLive() && !inLogger)
{
Lock loggerLock(inLogger);
InternalLogMessage(time, "Event logging stopped\n", MessageLogLevel::info);
logFile.Close();
reprap.StateUpdated();
}
}
// This will not start the logger if it is currently stopped
void Logger::SetLogLevel(LogLevel newLogLevel) noexcept
{
if (logLevel != newLogLevel)
{
logLevel = newLogLevel;
reprap.StateUpdated();
}
}
#if 0 // Currently not needed but might be useful in the future
bool Logger::IsLoggingEnabledFor(const MessageType mt) const noexcept
{
const auto messageLogLevel = GetMessageLogLevel(mt);
return IsLoggingEnabledFor(messageLogLevel);
}
#endif
void Logger::LogMessage(time_t time, const char *message, MessageType type) noexcept
{
if (logFile.IsLive() && !inLogger && !IsEmptyMessage(message))
{
const auto messageLogLevel = GetMessageLogLevel(type);
if (!IsLoggingEnabledFor(messageLogLevel))
{
return;
}
Lock loggerLock(inLogger);
InternalLogMessage(time, message, messageLogLevel);
}
}
void Logger::LogMessage(time_t time, OutputBuffer *buf, MessageType type) noexcept
{
if (logFile.IsLive() && !inLogger && !IsEmptyMessage(buf->Data()))
{
const auto messageLogLevel = GetMessageLogLevel(type);
if (!IsLoggingEnabledFor(messageLogLevel))
{
return;
}
Lock loggerLock(inLogger);
bool ok = WriteDateTimeAndLogLevelPrefix(time, messageLogLevel);
if (ok)
{
ok = buf->WriteToFile(logFile);
}
if (ok)
{
dirty = true;
}
else
{
logFile.Close();
reprap.StateUpdated();
}
}
}
// Version of LogMessage for when we already know we want to proceed and we have already set inLogger
void Logger::InternalLogMessage(time_t time, const char *message, const MessageLogLevel messageLogLevel) noexcept
{
bool ok = WriteDateTimeAndLogLevelPrefix(time, messageLogLevel);
if (ok)
{
const size_t len = strlen(message);
if (len != 0)
{
ok = logFile.Write(message, len);
}
if (ok && (len == 0 || message[len - 1] != '\n'))
{
ok = logFile.Write('\n');
}
}
if (ok)
{
dirty = true;
}
else
{
logFile.Close();
reprap.StateUpdated();
}
}
// This is called regularly by Platform to give the logger an opportunity to flush the file buffer
void Logger::Flush(bool forced) noexcept
{
if (logFile.IsLive() && dirty && !inLogger)
{
// Log file is dirty and can be flushed.
// To avoid excessive disk write operations, flush it only if one of the following is true:
// 1. We have possibly allocated a new cluster since the last flush. To avoid lost clusters if we power down before flushing,
// we should flush early in this case. Rather than determine the cluster size, we flush if we have started a new 512-byte sector.
// 2. If it hasn't been flushed for LogFlushInterval milliseconds.
const FilePosition currentPos = logFile.GetPosition();
const uint32_t now = millis();
if (forced || now - lastFlushTime >= LogFlushInterval || currentPos/512 != lastFlushFileSize/512)
{
Lock loggerLock(inLogger);
logFile.Flush();
lastFlushTime = millis();
lastFlushFileSize = currentPos;
dirty = false;
}
}
}
// Write the data, time and message log level to the file followed by a space.
// Caller must already have checked and set inLogger.
bool Logger::WriteDateTimeAndLogLevelPrefix(time_t time, MessageLogLevel messageLogLevel) noexcept
{
String<StringLength50> bufferSpace;
const StringRef buf = bufferSpace.GetRef();
if (time == 0)
{
const uint32_t timeSincePowerUp = (uint32_t)(millis64()/1000u);
buf.printf("power up + %02" PRIu32 ":%02" PRIu32 ":%02" PRIu32 " ", timeSincePowerUp/3600u, (timeSincePowerUp % 3600u)/60u, timeSincePowerUp % 60u);
}
else
{
tm timeInfo;
gmtime_r(&time, &timeInfo);
buf.printf("%04u-%02u-%02u %02u:%02u:%02u ",
timeInfo.tm_year + 1900, timeInfo.tm_mon + 1, timeInfo.tm_mday, timeInfo.tm_hour, timeInfo.tm_min, timeInfo.tm_sec);
}
buf.catf("[%s] ", messageLogLevel.ToString());
return logFile.Write(buf.c_str());
}
#endif
// End
|
