ALSA: seq: midi: Serialize output teardown with event_input
PATCH 1/1 ALSA: seq: midi: Serialize output teardown with event_input
event_process_midi() borrows msynth->output_rfile.output and then passes the substream to dump_midi() and snd_rawmidi_kernel_write() without synchronizing with the output open/close transition. midisynth_use() also publishes output_rfile before snd_rawmidi_output_params() has finished.
The last midisynth_unuse() can therefore release the same rawmidi file and free substream->runtime before snd_rawmidi_kernel_write1() takes its runtime buffer reference. That leaves the event_input path using a stale substream or runtime and can end in a NULL-deref or use-after-free.
Fix this with two pieces of synchronization. Keep a short IRQ-safe spinlock only for publishing or clearing output_rfile and for pairing the output snapshot with an snd_use_lock_t reference. Once event_process_midi() has taken that in-flight reference, it drops the spinlock before calling snd_seq_dump_var_event(), dump_midi(), or snd_rawmidi_kernel_write(). midisynth_unuse() now detaches the visible rawmidi file under the same spinlock, waits for the in-flight writers to drain, and only then drains and releases the saved file. midisynth_use() likewise opens into a local snd_rawmidi_file and publishes it only after snd_rawmidi_output_params() succeeds.
The buggy scenario involves two paths, with each column showing the order within that path:
event_input path: last unuse path:
1. event_process_midi() snapshots 1. midisynth_unuse() starts
output_rfile.output. tearing down output_rfile.
2. dump_midi() reaches 2. snd_rawmidi_kernel_release()
snd_rawmidi_kernel_write() closes the output file.
before runtime is pinned. 3. close_substream() frees
3. The callback keeps using substream->runtime.
the borrowed substream.
Validation reproduced this kernel report:
KASAN null-ptr-deref in snd_rawmidi_kernel_write1+0x56/0x360
RIP: 0033:0x7fde7dd0837f RIP: 0010:snd_rawmidi_kernel_write1+0x56/0x360 Read of size 8 Call trace: dump_stack_lvl+0x73/0xb0 (?:?) print_report+0x43e/0x650 (?:?) srso_alias_return_thunk+0x5/0xfbef5 (?:?) rcu_is_watching+0x24/0x60 (?:?) __virt_addr_valid+0x2f/0x340 (?:?) kasan_addr_to_slab+0x11/0xa0 (?:?) kasan_report+0xf7/0x130 (?:?) snd_rawmidi_kernel_write1+0x56/0x360 (?:?) __asan_load8+0x82/0xb0 (?:?) snd_rawmidi_kernel_write1+0x5/0x360 (?:?) snd_rawmidi_kernel_write+0x1a/0x20 (?:?) event_process_midi+0x125/0x220 (sound/core/seq/seq_midi.c:122) __entry_text_end+0xfdeb5/0x101fb9 (?:?) __kasan_check_write+0x18/0x20 (?:?) __snd_seq_deliver_single_event+0x8a/0xe0 (?:?) snd_seq_deliver_single_event+0x241/0x4b0 (?:?) do_raw_read_unlock+0x32/0xa0 (?:?) __deliver_to_subscribers+0x217/0x380 (?:?) snd_seq_deliver_event+0x91/0x1b0 (?:?) snd_seq_client_enqueue_event+0x192/0x240 (?:?) snd_seq_write+0x2cd/0x450 (?:?) apparmor_file_permission+0x20/0x30 (?:?) security_file_permission+0x51/0x60 (?:?) vfs_write+0x1ce/0x850 (?:?) __fget_files+0x12b/0x220 (?:?) lock_release+0xc8/0x2a0 (?:?) __rcu_read_unlock+0x74/0x2d0 (?:?) __fget_files+0x135/0x220 (?:?) ksys_write+0x15a/0x180 (?:?) __x64_sys_write+0x46/0x60 (?:?) x64_sys_call+0x7d/0x20d0 (?:?) do_syscall_64+0xc1/0x360 (arch/x86/entry/syscall_64.c:87) entry_SYSCALL_64_after_hwframe+0x77/0x7f (?:?)
--- sound/core/seq/seq_midi.c | 56 ++++++++++++++++++++++++++++++--------- 1 file changed, 44 insertions(+), 12 deletions(-)
sound/core/seq/seq_midi.c +44 -12
@@ -24,6 +24,7 @@ Possible options for midisynth module:#include <sound/seq_device.h> #include <sound/seq_midi_event.h> #include <sound/initval.h> +#include "seq_lock.h" MODULE_AUTHOR ("Frank van de Pol <[email protected]>, Jaroslav Kysela <[email protected]>" );MODULE_DESCRIPTION ("Advanced Linux Sound Architecture sequencer MIDI synth." );
@@ -42,6 +43,8 @@ struct seq_midisynth {int device;int subdevice;struct snd_rawmidi_file input_rfile; +spinlock_t output_lock;/* protects output_rfile publication */ +snd_use_lock_t output_use_lock;/* in-flight event_input users */ struct snd_rawmidi_file output_rfile;int seq_client;int seq_port;
@@ -125,31 +128,44 @@ static int event_process_midi(struct snd_seq_event *ev, int direct,struct seq_midisynth *msynth = private_data;unsigned char msg[10 ];/* buffer for constructing midi messages */ struct snd_rawmidi_substream *substream; +unsigned long flags; +int err =0 ;int len;if (snd_BUG_ON (!msynth))return -EINVAL ; + +spin_lock_irqsave (&msynth->output_lock, flags); substream = msynth->output_rfile.output; -if (substream ==NULL ) +if (substream) +snd_use_lock_use (&msynth->output_use_lock); +spin_unlock_irqrestore (&msynth->output_lock, flags); + +if (!substream)return -ENODEV ;if (ev->type ==SNDRV_SEQ_EVENT_SYSEX ) {/* special case, to save space */ if ((ev->flags &SNDRV_SEQ_EVENT_LENGTH_MASK ) !=SNDRV_SEQ_EVENT_LENGTH_VARIABLE ) {/* invalid event */ pr_debug ("ALSA: seq_midi: invalid sysex event flags = 0x%x\n" , ev->flags); -return 0 ; + goto out; }snd_seq_dump_var_event (ev, __dump_midi, substream);snd_midi_event_reset_decode (msynth->parser); }else { -if (msynth->parser ==NULL ) -return -EIO ; +if (!msynth->parser) { + err = -EIO ; + goto out; + } len =snd_midi_event_decode (msynth->parser, msg,sizeof (msg), ev);if (len <0 ) -return 0 ; + goto out;if (dump_midi (substream, msg, len) <0 )snd_midi_event_reset_decode (msynth->parser); } -return 0 ; + +out: +snd_use_lock_free (&msynth->output_use_lock); +return err; }
@@ -163,6 +179,8 @@ static int snd_seq_midisynth_new(struct seq_midisynth *msynth, msynth->card = card; msynth->device = device; msynth->subdevice = subdevice; +spin_lock_init (&msynth->output_lock); +snd_use_lock_init (&msynth->output_use_lock);return 0 ; }
@@ -215,12 +233,14 @@ static int midisynth_use(void *private_data, struct snd_seq_port_subscribe *info {int err;struct seq_midisynth *msynth = private_data; +struct snd_rawmidi_file rfile = {};struct snd_rawmidi_params params; +unsigned long flags;/* open midi port */ err =snd_rawmidi_kernel_open (msynth->rmidi, msynth->subdevice,SNDRV_RAWMIDI_LFLG_OUTPUT , - &msynth->output_rfile); + &rfile);if (err <0 ) {pr_debug ("ALSA: seq_midi: midi output open failed!!!\n" );return err;
@@ -229,12 +249,15 @@ static int midisynth_use(void *private_data, struct snd_seq_port_subscribe *info params.avail_min =1 ; params.buffer_size = output_buffer_size; params.no_active_sensing =1 ; - err =snd_rawmidi_output_params (msynth->output_rfile.output, ¶ms); + err =snd_rawmidi_output_params (rfile.output, ¶ms);if (err <0 ) { -snd_rawmidi_kernel_release (&msynth->output_rfile); +snd_rawmidi_kernel_release (&rfile);return err; }snd_midi_event_reset_decode (msynth->parser); +spin_lock_irqsave (&msynth->output_lock, flags); + msynth->output_rfile = rfile; +spin_unlock_irqrestore (&msynth->output_lock, flags);return 0 ; }
@@ -242,11 +265,20 @@ static int midisynth_use(void *private_data, struct snd_seq_port_subscribe *infostatic int midisynth_unuse (void *private_data,struct snd_seq_port_subscribe *info) {struct seq_midisynth *msynth = private_data; +struct snd_rawmidi_file rfile = {}; +unsigned long flags; -if (snd_BUG_ON (!msynth->output_rfile.output)) +spin_lock_irqsave (&msynth->output_lock, flags); + rfile = msynth->output_rfile; + msynth->output_rfile = (struct snd_rawmidi_file ){}; +spin_unlock_irqrestore (&msynth->output_lock, flags); + +if (snd_BUG_ON (!rfile.output))return -EINVAL ; -snd_rawmidi_drain_output (msynth->output_rfile.output); -return snd_rawmidi_kernel_release (&msynth->output_rfile); + +snd_use_lock_sync (&msynth->output_use_lock); +snd_rawmidi_drain_output (rfile.output); +return snd_rawmidi_kernel_release (&rfile); }/* delete given midi synth port */
Signature · 1 line
2.43.0
Quoted 10 lines · Zhang Cen
sound/core/seq/seq_midi.c +2
-0@@ -125,31 +128,44 @@ static int event_process_midi(struct snd_seq_event *ev, int direct,struct seq_midisynth *msynth = private_data;unsigned char msg[10 ];/* buffer for constructing midi messages */ struct snd_rawmidi_substream *substream; +unsigned long flags; +int err =0 ;int len;if (snd_BUG_ON (!msynth))return -EINVAL ;
sound/core/seq/seq_midi.c static int event_process_midi(struct snd_seq_event *ev, int direct, · line 145
Quoted 10 lines
sound/core/seq/seq_midi.c +7
-1+ +spin_lock_irqsave (&msynth->output_lock, flags); substream = msynth->output_rfile.output; -if (substream ==NULL ) +if (substream) +snd_use_lock_use (&msynth->output_use_lock); +spin_unlock_irqrestore (&msynth->output_lock, flags); + +if (!substream)return -ENODEV ;
Please use scoped_guard(). You can drop flags with it, and the return -ENODEV can be right after substream assignment.
Quoted 6 lines
sound/core/seq/seq_midi.c +1
-1@@ -229,12 +249,15 @@ static int midisynth_use(void *private_data, struct snd_seq_port_subscribe *info params.avail_min =1 ; params.buffer_size = output_buffer_size; params.no_active_sensing =1 ; - err =snd_rawmidi_output_params (msynth->output_rfile.output, ¶ms); + err =snd_rawmidi_output_params (rfile.output, ¶ms);
sound/core/seq/seq_midi.c static int midisynth_use(void *private_data, struct snd_seq_port_subscribe *info · line 261
Quoted 10 lines
sound/core/seq/seq_midi.c +4
-1if (err <0 ) { -snd_rawmidi_kernel_release (&msynth->output_rfile); +snd_rawmidi_kernel_release (&rfile);return err; }snd_midi_event_reset_decode (msynth->parser); +spin_lock_irqsave (&msynth->output_lock, flags); + msynth->output_rfile = rfile; +spin_unlock_irqrestore (&msynth->output_lock, flags);return 0 ;
Ditto, use guard() or scoped_guard().
Quoted 5 lines
sound/core/seq/seq_midi.c +1
-0@@ -242,11 +265,20 @@ static int midisynth_use(void *private_data, struct snd_seq_port_subscribe *infostatic int midisynth_unuse (void *private_data,struct snd_seq_port_subscribe *info) {struct seq_midisynth *msynth = private_data; +struct snd_rawmidi_file rfile = {};
sound/core/seq/seq_midi.c static int midisynth_use(void *private_data, struct snd_seq_port_subscribe *info · line 277
Quoted 10 lines
sound/core/seq/seq_midi.c +7
-1+unsigned long flags; -if (snd_BUG_ON (!msynth->output_rfile.output)) +spin_lock_irqsave (&msynth->output_lock, flags); + rfile = msynth->output_rfile; + msynth->output_rfile = (struct snd_rawmidi_file ){}; +spin_unlock_irqrestore (&msynth->output_lock, flags); + +if (snd_BUG_ON (!rfile.output))return -EINVAL ;
Same here, too.
thanks,
Takashi
Hi Takashi,
Quoted 3 lines
Please use
scoped_guard(). You can drop flags with it, and the return-ENODEVcan be right after substream assignment.
Same here, too.
Thanks for your review. I will keep the lifetime fix unchanged and only updated the
short output_lock sections to use scoped_guard(spinlock_irqsave, ...), so the explicit flags variable is gone as suggested.
I'll send v2 with that change.
Best regards,
Zhang Cen