Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

FW/logging: refactor log_{platform_,}message #154

Closed
wants to merge 3 commits into from
Closed

FW/logging: refactor log_{platform_,}message #154

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
72753b4
FW/logging: remove unnecessary fflush()
thiagomacieira Sep 9, 2022
6bbdce1
FW/logging: use atomics for the message count and data size
thiagomacieira Sep 9, 2022
f3e920f
FW/logging: refactor log_{platform_,}message
thiagomacieira Sep 9, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
74 changes: 34 additions & 40 deletions framework/logging.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -738,26 +738,6 @@ void logging_mark_thread_failed(int thread_num)
thr->inner_loop_count_at_fail = thr->inner_loop_count;
}

static void log_message_preformatted(int thread_num, std::string_view msg)
{
int level = status_level(msg[0]);
if (msg[0] == 'E')
logging_mark_thread_failed(thread_num);

int &messages_logged = cpu_data_for_thread(thread_num)->messages_logged;
if (messages_logged >= sApp->max_messages_per_thread)
return;

messages_logged++;

if (msg[msg.size() - 1] == '\n')
msg.remove_suffix(1); // remove trailing newline

FILE *log = logging_stream_open(thread_num, level);
fwrite(msg.data(), 1, msg.size(), log);
logging_stream_close(log);
}

static __attribute__((cold)) void log_message_to_syslog(const char *msg)
{
// since logging to the system log is so infrequent, we initialize and tear
Expand Down Expand Up @@ -1189,7 +1169,6 @@ void logging_finish()
FILE *logging_stream_open(int thread_num, int level)
{
FILE *log = log_for_thread(thread_num).log;
fflush(log);
fputc(message_code(UserMessages, level), log);
return log;
}
Expand All @@ -1203,23 +1182,44 @@ static inline void assert_log_message(const char *fmt)
(void)fmt; // for release builds
}

static void log_message_common(int thread_num, const char *fmt, va_list va,
std::string_view prefix = {})
{
assert_log_message(fmt);
if (!SandstoneConfig::Debug && *fmt == 'd')
return; /* no Debug in non-debug build */
if (*fmt == 'E')
logging_mark_thread_failed(thread_num);

std::atomic<int> &messages_logged = cpu_data_for_thread(thread_num)->messages_logged;
if (messages_logged.fetch_add(1, std::memory_order_relaxed) >= sApp->max_messages_per_thread)
return;

std::string msg = create_filtered_message_string(fmt, va);
if (msg[msg.size() - 1] == '\n')
msg.resize(msg.size() - 1); // remove trailing newline

char c = message_code(UserMessages, status_level(*fmt));
struct iovec vec[] = {
{ &c, 1 },
{ const_cast<char *>(prefix.data()), prefix.size() },
{ msg.data(), msg.size() + 1 } // including the null terminator
};
int fd = log_for_thread(thread_num).log_fd;
IGNORE_RETVAL(writev(fd, vec, std::size(vec)));
}

#undef log_platform_message
void log_platform_message(const char *fmt, ...)
{
if (current_output_format() == SandstoneApplication::OutputFormat::no_output)
return;

assert_log_message(fmt);
if (!SandstoneConfig::Debug && *fmt == 'd')
return; /* no Debug in non-debug build */
// a platform message always goes to the main thread, with a prefix
va_list va;
va_start(va, fmt);
std::string msg = create_filtered_message_string(fmt, va);
log_message_common(-1, fmt, va, "Platform issue: ");
va_end(va);

// Insert prefix and log to main thread
msg.insert(3, "Platform issue: ");
log_message_preformatted(-1, msg);
}

#undef log_message
Expand All @@ -1228,14 +1228,10 @@ void log_message(int thread_num, const char *fmt, ...)
if (current_output_format() == SandstoneApplication::OutputFormat::no_output)
return;

assert_log_message(fmt);
if (!SandstoneConfig::Debug && *fmt == 'd')
return; /* no Debug in non-debug build */
va_list va;
va_start(va, fmt);
std::string msg = create_filtered_message_string(fmt, va);
log_message_common(thread_num, fmt, va);
va_end(va);
log_message_preformatted(thread_num, msg);
}

/// Escapes \c{message} suitable for a single-quote YAML line and returns it.
Expand Down Expand Up @@ -1332,14 +1328,12 @@ void log_data(const char *message, const void *data, size_t size)
if (current_output_format() == SandstoneApplication::OutputFormat::no_output)
return; // short-circuit

int &messages_logged = cpu_data_for_thread(thread_num)->messages_logged;
size_t &data_bytes_logged = cpu_data_for_thread(thread_num)->data_bytes_logged;
if ((messages_logged >= sApp->max_messages_per_thread) ||
(data_bytes_logged + size > sApp->max_logdata_per_thread))
std::atomic<int> &messages_logged = cpu_data_for_thread(thread_num)->messages_logged;
std::atomic<size_t> &data_bytes_logged = cpu_data_for_thread(thread_num)->data_bytes_logged;
if (messages_logged.fetch_add(1, std::memory_order_relaxed) >= sApp->max_messages_per_thread ||
(data_bytes_logged.fetch_add(size, std::memory_order_relaxed) > sApp->max_logdata_per_thread))
return;

messages_logged++;
data_bytes_logged += size;

log_data_common(message, static_cast<const uint8_t *>(data), size, false);
}
Expand Down
4 changes: 2 additions & 2 deletions framework/sandstone_p.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -178,10 +178,10 @@ struct alignas(64) per_thread_data
std::atomic<ThreadState> thread_state;

/* Records number of messages logged per thread of each test */
int messages_logged;
std::atomic<int> messages_logged;

/* Records the number of bytes log_data'ed per thread */
size_t data_bytes_logged;
std::atomic<size_t> data_bytes_logged;

/* Number of iterations of the inner loop (aka #times test_time_condition called) */
uint64_t inner_loop_count;
Expand Down