Data race on `LOGGER.buf_console` between `set_buf_console` and the logger

Abierto
#807 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 2 días

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
4/5
Tiempo estimado
3-5 días
Aptitud para principiantes
48/100
Tipo de issue
Error
Claridad
Bastante claro
Estado de actividad
Activo
Stack tecnológico
rust

Línea de trabajo

Start with awkernel_lib/src/logger.rs and trace set_buf_console alongside Logger::enabled, Logger::log, and Logger::flush; then check the buffered logger setup in applications/awkernel_services/src/buffered_logger.rs. Verify how console registration and logging can overlap across CPUs, including the set_raw_console path. Done when the shared logger state is accessed without a data race and the boot-time raw console behavior is understood.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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.

Lenguaje dominante
Rust
Estrellas
282
Forks
12
Merge medio
2 d 9 h
PR fusionados (30 d)
28

Preparar el entorno

Este proyecto no incluye contenedor de desarrollo, Dockerfile ni guía de contribución, así que la configuración corre por tu cuenta: empieza por su README y consulta nuestra guía para la primera contribución para los pasos generales.

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de tier4/awkernel

Todos los issues de tier4/awkernel

Issues similares

Más issues de Rust

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.