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

Thread safety: Remove race in RingbufferLogger #6881

Merged
merged 2 commits into from
Mar 4, 2025
Merged

Thread safety: Remove race in RingbufferLogger #6881

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
337d558
Writers should not be shared between threads, so make RingbufferLogge…
eddyashton Mar 4, 2025
99cdc28
I have the wrong clang-format somewhere
eddyashton Mar 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions src/enclave/main.cpp
View file
Open in desktop
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
View file
Open in desktop
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