Skip to content

Data race on LOGGER.buf_console between set_buf_console and the logger #807

Open

Description

@ytakano

Summary

awkernel_lib::logger::set_buf_console writes LOGGER.buf_console without synchronization while other CPUs read it through log::info! and the other logging macros. This is a data race, which is undefined behavior in Rust.

This was found during the review of #799.

Details

LOGGER is a static mut in awkernel_lib/src/logger.rs:

static mut LOGGER: Logger = Logger {
    raw_console: None,
    buf_console: None,
};
  • Writer: set_buf_console runs (*ptr).buf_console = Some(logger) with no lock and no atomic operation. The buffered logger task (applications/awkernel_services/src/buffered_logger.rs) calls it, so it runs after all CPUs have started to execute tasks.
  • Readers: Logger::enabled, Logger::log, and Logger::flush read self.buf_console on every CPU each time a logging macro is called, also with no synchronization.

Possible effect

Option<&'static dyn Log> is two words: a data pointer and a vtable pointer. The write can be two stores. A CPU that reads between them can get the new data pointer with the old vtable pointer, and log.log(record) then calls through an invalid vtable.

The window is a few instructions and the write happens once at boot, so this is unlikely to occur in practice. I have not reproduced it.

Proposed fix

buf_console is written once and never changed afterward, so a separate AtomicBool that publishes it is enough:

  1. set_buf_console writes the pointer, and then sets the flag with Ordering::Release.
  2. Logger loads the flag with Ordering::Acquire, and reads buf_console only when the flag is set.

With this, no CPU reads the pointer while it is written.

Related

set_raw_console writes raw_console in the same way. It is called from console::register_console, which appears to run during early boot before the other CPUs start. Whether it can run concurrently with logging on another CPU should be checked as part of this issue.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions