Skip to content

Commit

Permalink
Thread safety: Remove race in RingbufferLogger (#6881)
Browse files Browse the repository at this point in the history
  • Loading branch information
eddyashton authored Mar 4, 2025
1 parent f0816b0 commit 529ce0a
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 4 deletions.
3 changes: 1 addition & 2 deletions src/enclave/main.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -117,8 +117,7 @@ extern "C"

// Note: because logger uses ringbuffer, logger can only be initialised once
// ringbuffer memory has been verified
auto new_logger = std::make_unique<ccf::RingbufferLogger>(
writer_factory->create_writer_to_outside());
auto new_logger = std::make_unique<ccf::RingbufferLogger>(*writer_factory);
auto ringbuffer_logger = new_logger.get();
ccf::logger::config::loggers().push_back(std::move(new_logger));

Expand Down
13 changes: 11 additions & 2 deletions src/enclave/ringbuffer_logger.h
Original file line number Diff line number Diff line change
Expand Up @@ -9,19 +9,28 @@ namespace ccf
class RingbufferLogger : public ccf::logger::AbstractLogger
{
protected:
ringbuffer::WriterPtr writer;
ringbuffer::AbstractWriterFactory& writer_factory;

// Current time, as us duration since epoch (from system_clock). Used to
// produce offsets to host time when logging from inside the enclave
std::atomic<std::chrono::microseconds> us = {};

public:
RingbufferLogger(const ringbuffer::WriterPtr& writer_) : writer(writer_) {}
RingbufferLogger(ringbuffer::AbstractWriterFactory& wf_) :
writer_factory(wf_)
{}

void write(
const ccf::logger::LogLine& line,
const std::optional<double>& enclave_offset = std::nullopt) override
{
thread_local ringbuffer::WriterPtr writer = nullptr;

if (writer == nullptr)
{
writer = writer_factory.create_writer_to_outside();
}

writer->write(
AdminMessage::log_msg,
us.load().count(),
Expand Down

0 comments on commit 529ce0a

Please sign in to comment.