serial: core: shut down initialized port on removal
PATCH 1/1 serial: core: shut down initialized port on removal
When a serial port configured as a console is opened and subsequently closed, tty_port_shutdown() skips invoking port->ops->shutdown() because port->console is true. As a result, tty_port_initialized() remains true and the port's interrupt handler stays registered in the irq subsystem.
If the underlying device is later unbound or removed (e.g. via sysfs unbind), serial_core_remove_one_port() unregisters the console, frees uport->name with kfree(), and clears state->uart_port without ever shutting down the port or freeing its IRQ. Consequently, the irqaction remains linked in the genirq descriptor with action->name pointing to freed memory.
When another device later requests the same IRQ line, __setup_irq() encounters the stale action, detects a flags mismatch, and attempts to print old->name in pr_err(), triggering a KASAN use-after-free read:
BUG: KASAN: slab-use-after-free in string_nocheck lib/vsprintf.c:648 BUG: KASAN: slab-use-after-free in string+0x471/0x4d0 lib/vsprintf.c:730 Read of size 1 at addr ffff88802643b8a0 by task syz.0.818/8415 Call Trace: <TASK> string_nocheck lib/vsprintf.c:648 string+0x471/0x4d0 lib/vsprintf.c:730 vsnprintf+0x422/0x1300 lib/vsprintf.c:2949 vprintk_store+0x3b3/0xbe0 kernel/printk/printk.c:2307 vprintk_emit+0x139/0x6b0 kernel/printk/printk.c:2455 _printk+0xcf/0x110 kernel/printk/printk.c:2504 __setup_irq.cold+0x3be/0x3f1 kernel/irq/manage.c:1821 request_threaded_irq+0x261/0x3e0 kernel/irq/manage.c:2184 pcl812_attach+0x1b62/0x2300 drivers/comedi/drivers/pcl812.c:1174 ...
Fix this by clearing port->console after unregistering the console and calling uart_shutdown(NULL, state) under port->mutex if the port remains initialized, ensuring the interrupt and hardware resources are freed before kfree(uport->name).
--- drivers/tty/serial/serial_core.c | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-)
drivers/tty/serial/serial_core.c +8 -2
@@ -3210,8 +3210,15 @@ static void serial_core_remove_one_port(struct uart_driver *drv,/* * If the port is used as a console, unregister it */ -if (uart_console (uport)) +if (uart_console (uport)) {unregister_console (uport->cons); + port->console = false; + } + +guard (mutex)(&port->mutex); + +if (tty_port_initialized (port)) +uart_shutdown (NULL , state);/* * Free the port IO and memory resources, if any.
@@ -3227,7 +3234,6 @@ static void serial_core_remove_one_port(struct uart_driver *drv, uport->type =PORT_UNKNOWN ; uport->port_dev =NULL ; -guard (mutex)(&port->mutex);WARN_ON (atomic_dec_return (&state->refcount) <0 );wait_event (state->remove_wait, !atomic_read (&state->refcount)); state->uart_port =NULL ;
Signature · 1 line
2.47.3
[email protected]
AI reviewThank you for your contribution! Sashiko AI review found 1 potential issue(s) to consider: - [Medium] tty: data race on port->console in serial_core_remove_one_port() --
Thank you for your contribution! Sashiko AI review found 1 potential issue(s) to consider:
- [Medium] tty: data race on port->console in serial_core_remove_one_port() --
commit ff681977bacb42b18c6925085fd5fa965af4c283
Author: Igor Putko <[email protected]>
serial: core: shut down initialized port on removal
This commit addresses a use-after-free read during IRQ setup by ensuring initialized console ports are properly shut down before removal. It clears the console flag and calls uart_shutdown() under the port mutex.
drivers/tty/serial/serial_core.c static void serial_core_remove_one_port(struct uart_driver *drv, · line 3215
Quoted 12 lines
drivers/tty/serial/serial_core.c +2
-1@@ -3210,8 +3210,15 @@ static void serial_core_remove_one_port(struct uart_driver *drv,/* * If the port is used as a console, unregister it */ -if (uart_console (uport)) +if (uart_console (uport)) {unregister_console (uport->cons); + port->console = false;
[Severity: Medium]
Could this assignment cause a data race on the port->console bitfield?
If a user process holds the serial console open while the underlying device is removed, serial_core_remove_one_port() will synchronously hang up the tty by calling tty_port_tty_vhangup().
If the user process then calls close(), the syscall path will execute tty_release() -> uart_close() -> tty_port_close() -> tty_port_shutdown().
In tty_port_shutdown(), the code acquires port->mutex and evaluates port->console. Concurrently, the assignment above happens without holding port->mutex.
While this might be practically benign at the machine level since byte stores are usually atomic, concurrent read/write access without synchronization is undefined behavior in C and can trigger KCSAN warnings.
Quoted 6 lines
drivers/tty/serial/serial_core.c +6
-0+ } + +guard (mutex)(&port->mutex); + +if (tty_port_initialized (port)) +uart_shutdown (NULL , state);
Signature · 1 line
Sashiko AI review · https://sashiko.dev/#/patchset/[email protected]?part=1
Greg Kroah-Hartman
maintainerQuoted 12 lines · Igor Putko
When a serial port configured as a console is opened and subsequently closed,
tty_port_shutdown()skips invokingport->ops->shutdown()becauseport->consoleis true. As a result,tty_port_initialized()remains true and the port's interrupt handler stays registered in the irq subsystem.If the underlying device is later unbound or removed (e.g. via sysfs unbind),
serial_core_remove_one_port()unregisters the console, freesuport->namewithkfree(), and clearsstate->uart_portwithout ever shutting down the port or freeing its IRQ. Consequently, the irqaction remains linked in the genirq descriptor withaction->namepointing to freed memory.
Quoted 3 lines
When another device later requests the same IRQ line,
__setup_irq()encounters the stale action, detects a flags mismatch, and attempts to printold->nameinpr_err(), triggering a KASAN use-after-free read:
How can a different device request the same irq line on a real device?
How was this all tested, with "fake" devices?
thanks,
greg k-h
Hi Greg,
Note: syzbot did not actually provide a reproducer for this crash - this patch is based on code analysis of the trace, not on hardware testing. The pcl812 trigger from syzkaller is synthetic.
On a console port, tty_port_shutdown() skips ops->shutdown() because port->console is true, so the IRQ is never released.
If the device is later unbound/removed, serial_core_remove_one_port() frees uport->name via kfree(), but the IRQ is never freed.
Result: a stale irqaction pointing at freed memory in action->name, even without anything else requesting that IRQ line.
sashiko-bot also pointed out a data race on port->console = false outside the mutex - separate issue, but relevant.
If the underlying problem looks real to you, I'd rather withdraw this patch, put together an actual reproducer (unbind a console port, check for the stale irqaction), fix the locking properly, and send a v2.
thanks, igor
Quoted 79 lines · Igor Putko
When a serial port configured as a console is opened and subsequently closed,
tty_port_shutdown()skips invokingport->ops->shutdown()becauseport->consoleis true. As a result,tty_port_initialized()remains true and the port's interrupt handler stays registered in the irq subsystem.If the underlying device is later unbound or removed (e.g. via sysfs unbind),
serial_core_remove_one_port()unregisters the console, freesuport->namewithkfree(), and clearsstate->uart_portwithout ever shutting down the port or freeing its IRQ. Consequently, the irqaction remains linked in the genirq descriptor withaction->namepointing to freed memory.When another device later requests the same IRQ line,
__setup_irq()encounters the stale action, detects a flags mismatch, and attempts to printold->nameinpr_err(), triggering a KASAN use-after-free read:BUG: KASAN: slab-use-after-free in string_nocheck lib/vsprintf.c:648 BUG: KASAN: slab-use-after-free in string+0x471/0x4d0 lib/vsprintf.c:730 Read of size 1 at addr ffff88802643b8a0 by task syz.0.818/8415 Call Trace: <TASK> string_nocheck lib/vsprintf.c:648 string+0x471/0x4d0 lib/vsprintf.c:730 vsnprintf+0x422/0x1300 lib/vsprintf.c:2949 vprintk_store+0x3b3/0xbe0 kernel/printk/printk.c:2307 vprintk_emit+0x139/0x6b0 kernel/printk/printk.c:2455 _printk+0xcf/0x110 kernel/printk/printk.c:2504 __setup_irq.cold+0x3be/0x3f1 kernel/irq/manage.c:1821 request_threaded_irq+0x261/0x3e0 kernel/irq/manage.c:2184 pcl812_attach+0x1b62/0x2300 drivers/comedi/drivers/pcl812.c:1174 ...Fix this by clearing
port->consoleafter unregistering the console and callinguart_shutdown(NULL, state)underport->mutexif the port remains initialized, ensuring the interrupt and hardware resources are freed beforekfree(uport->name).Reported-by [email protected]Fixes 761ed4a94582 ("tty: serial_core: convert uart_close to use tty_port_close")Fixes f7048b15900f ("tty: serial_core: Add name field to uart_port struct")Signed-off-by Igor Putko <[email protected]>--- drivers/tty/serial/serial_core.c | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-)drivers/tty/serial/serial_core.c +8
-3@@ -3210,8 +3210,15 @@ static void serial_core_remove_one_port(struct uart_driver *drv,/* * If the port is used as a console, unregister it */ -if (uart_console (uport)) +if (uart_console (uport)) {unregister_console (uport->cons); + port->console = false; + } + +guard (mutex)(&port->mutex); + +if (tty_port_initialized (port)) +uart_shutdown (NULL , state);/* * Free the port IO and memory resources, if any. @@ -3227,7 +3234,6 @@ static void serial_core_remove_one_port(struct uart_driver *drv, uport->type =PORT_UNKNOWN ; uport->port_dev =NULL ; -guard (mutex)(&port->mutex);WARN_ON (atomic_dec_return (&state->refcount) <0 );wait_event (state->remove_wait, !atomic_read (&state->refcount)); state->uart_port =NULL ; --2.47.3
Quoted 12 lines · IgorpetinDev
Hi Greg,
Note: syzbot did not actually provide a reproducer for this crash - this patch is based on code analysis of the trace, not on hardware testing. The pcl812 trigger from syzkaller is synthetic.On a console port,
tty_port_shutdown()skipsops->shutdown()becauseport->consoleis true, so the IRQ is never released.
If the device is later unbound/removed,serial_core_remove_one_port()freesuport->nameviakfree(), but the IRQ is never freed.
Result: a stale irqaction pointing at freed memory inaction->name, even without anything else requesting that IRQ line.
Quoted 6 lines
sashiko-bot also pointed out a data race on
port->console= false outside the mutex - separate issue, but relevant.If the underlying problem looks real to you, I'd rather withdraw this patch, put together an actual reproducer (unbind a console port, check for the stale irqaction), fix the locking properly, and send a v2.
Please do so, thanks.
greg k-h
PATCH v2 1/1 serial: core: shut down initialized port on removal
In reply to Igor PutkoWhen a serial port configured as a console is opened and subsequently closed, tty_port_shutdown() skips invoking port->ops->shutdown() because port->console is true. As a result, tty_port_initialized() remains true and the port's interrupt handler stays registered in the irq subsystem.
If the underlying device is later unbound or removed (e.g. via sysfs driver unbind or device hot-unplug), serial_core_remove_one_port() unregisters the console, frees uport->name via kfree(), and tears down the port without shutting it down or freeing its IRQ. Consequently, the irqaction descriptor remains registered in genirq with action->name pointing to freed memory.
This triggers a use-after-free read whenever genirq accesses action->name, such as when reading /proc/interrupts:
BUG: KASAN: slab-use-after-free in string+0x476/0x570 Call Trace: string+0x476/0x570 vsnprintf+0x422/0x1300 seq_printf+0x... show_interrupts+...
Fix this by acquiring port->mutex in serial_core_remove_one_port() after console unregistration, clearing port->console under the mutex to prevent data races with concurrent tty_port_shutdown(), and invoking uart_shutdown(NULL, state) if the port remains initialized. This ensures that port->ops->shutdown() is called and the IRQ is freed before kfree(uport->name).
---
v1 -> v2:
- Clear port->console under port->mutex using scoped_guard() to fix the data race pointed out by sashiko-bot.
- Verified without synthetic devices by reproducing via sysfs driver unbind (00:04 serial pnp device) and inspecting /proc/interrupts.
- Do not hold port->mutex across release_port() to preserve existing locking semantics.
Reproducer steps (tested on QEMU with console=ttyS0):
1. Open and close the console port:
exec 3</dev/ttyS0 && exec 3<&-
2. Unbind the serial device:
echo "00:04" > /sys/bus/pnp/drivers/serial/unbind
3. Read interrupts:
cat /proc/interrupts
-> triggers KASAN use-after-free in show_interrupts() without this fix.
drivers/tty/serial/serial_core.c | 7 +++++++ 1 file changed, 7 insertions(+)
drivers/tty/serial/serial_core.c +7 -0
@@ -3213,6 +3213,13 @@ static void serial_core_remove_one_port(struct uart_driver *drv,if (uart_console (uport))unregister_console (uport->cons); + scoped_guard(mutex, &port->mutex) { + port->console = false; + +if (tty_port_initialized (port)) +uart_shutdown (NULL , state); + } +/* * Free the port IO and memory resources, if any. */
Signature · 1 line
2.53.0
[email protected]
AI reviewThank you for your contribution! Sashiko AI review found 1 potential issue(s) to consider: - [Medium] serial: PM state leak in serial_core_remove_one_port() due to missed uart_change_pm() --
Thank you for your contribution! Sashiko AI review found 1 potential issue(s) to consider:
- [Medium] serial: PM state leak in serial_core_remove_one_port() due to missed uart_change_pm() --
commit 9122ece37c80d138a14cda352b9aec7db9935327
Author: Igor Putko <[email protected]>
serial: core: shut down initialized port on removal
This commit clears port->console under the port mutex and explicitly calls uart_shutdown() if the port is initialized during removal. It aims to fix a use-after-free by ensuring the port is shut down and its IRQ freed when unbinding a device that was previously used as a console.
Quoted 4 lines
drivers/tty/serial/serial_core.c +0
-0
[ ... ]
drivers/tty/serial/serial_core.c static void serial_core_remove_one_port(struct uart_driver *drv, · line 3246
Quoted 9 lines
drivers/tty/serial/serial_core.c +5
-0@@ -3239,6 +3239,13 @@ static void serial_core_remove_one_port(struct uart_driver *drv,if (uart_console (uport))unregister_console (uport->cons); + scoped_guard(mutex, &port->mutex) { + port->console = false; + +if (tty_port_initialized (port)) +uart_shutdown (NULL , state);
[Severity: Medium]
Does calling uart_shutdown() directly here skip the complete TTY port shutdown sequence?
When unbinding a serial device that was previously opened and closed as a console, uart_shutdown() only executes a partial teardown. It skips uport->ops->stop_rx() and transitioning the PM state to OFF, which normally happen in uart_tty_port_shutdown():
drivers/tty/serial/serial_core.c:uart_tty_port_shutdown() {
...
scoped_guard(uart_port_lock_irq, uport)
uport->ops->stop_rx(uport);
serial_base_port_shutdown(uport);
uart_port_shutdown(port);
...
uart_change_pm(state, UART_PM_STATE_OFF);
}Could this leave the device in an active power state (UART_PM_STATE_ON) indefinitely or leave the hardware receiving data and interrupts? Calling tty_port_shutdown_locked() would execute the complete sequence.
Quoted 5 lines
drivers/tty/serial/serial_core.c +2
-0+ } +/* * Free the port IO and memory resources, if any. */
Signature · 1 line
Sashiko AI review · https://sashiko.dev/#/patchset/[email protected]?part=1
Quoted 4 lines · Igor Putko
Fix this by acquiring
port->mutexinserial_core_remove_one_port()after console unregistration, clearingport->consoleunder the mutex to prevent data races with concurrenttty_port_shutdown(), and invokinguart_shutdown(NULL, state)if the port remains initialized.
I sent a patch for the same bug [1] without having seen this one. I ran my reproducers on tty-next 36844ea19656 plus this commit (810d467c11f0 in tty-testing), in a QEMU guest with KASAN. The 8250_pci case with INTx is fixed: the IRQ is freed on unbind, reading /proc/interrupts is clean and rebinding restores the console. It also fixes a second symptom, on a polled port (irq 0, UPF_IOREMAP), where serial8250_timeout() kept running after removal and dereferenced the cleared membase. A port held open across removal and a console that was never opened still work.
The patch uses scoped_guard(), which exists for mutexes from v6.5, so it won't build on the 6.1, 5.15 and 5.10 stable trees. If you don't plan to send backports for those, I can.
[1] https://lore.kernel.org/r/[email protected]
Thanks,
Phil