sound: Fix race condition in the pcm_lib "wait for space loop
PATCH 1/1 sound: Fix race condition in the pcm_lib "wait for space loop
Quoted 1 line
From
2e37f0a4b2289962e1a45d8e02f8a7f7adad619fMon Sep 17 00:00:00 2001
From: Arjan van de Ven <[email protected]>
Date: Mon, 5 Sep 2011 09:40:18 -0700
Subject: [PATCH] sound: Fix race condition in the pcm_lib "wait for space" loop
The wait_for_avail() function in pcm_lib.c has a race in it (observed in practice by an Intel validation group).
The function is supposed to return once space in the buffer has become available, or if some timeout happens. The entity that creates space (irq handler of sound driver and some such) will do a wake up on a waitqueue that this function registers for.
However there are two races in the existing code
1) If space became available between the caller noticing there was no space and this function actually sleeping, the wakeup is missed and the timeout condition will happen instead
2) If a wakeup happened but not sufficient space became available, the code will loop again and wait for more space. However, if the second wake comes in prior to hitting the schedule_timeout_interruptible(), it will be missed, and potentially you'll wait out until the timeout happens.
The fix consists of using more careful setting of the current state (so that if a wakeup happens in the main loop window, the schedule_timeout() falls through) and by checking for available space prior to going into the schedule_timeout() loop, but after being on the waitqueue and having the state set to interruptible.
--- sound/core/pcm_lib.c | 29 ++++++++++++++++++++++++++--- 1 files changed, 26 insertions(+), 3 deletions(-)
sound/core/pcm_lib.c +26 -3
@@ -1761,6 +1761,10 @@ static int wait_for_avail(struct snd_pcm_substream *substream,snd_pcm_uframes_t avail =0 ;long wait_time, tout; +init_waitqueue_entry (&wait, current); +add_wait_queue (&runtime->tsleep, &wait); +set_current_state (TASK_INTERRUPTIBLE ); +if (runtime->no_period_wakeup) wait_time =MAX_SCHEDULE_TIMEOUT ;else {
@@ -1771,16 +1775,34 @@ static int wait_for_avail(struct snd_pcm_substream *substream, } wait_time =msecs_to_jiffies (wait_time *1000 ); } -init_waitqueue_entry (&wait, current); -add_wait_queue (&runtime->tsleep, &wait); + +/* +* We need to check if space became available already (and thus the +* wakeup happened already) prior to going into the sleep loop to +* close the race of space already having become available. +* This check must happen after been added to the waitqueue and +* having current state be INTERRUPTIBLE. +*/ + +if (is_playback) + avail =snd_pcm_playback_avail (runtime); +else + avail =snd_pcm_capture_avail (runtime); +if (avail >= runtime->twake) + goto _endloop; + +for (;;) {if (signal_pending (current)) { err = -ERESTARTSYS ;break ; }snd_pcm_stream_unlock_irq (substream); - tout =schedule_timeout_interruptible (wait_time); + + tout =schedule_timeout (wait_time); +snd_pcm_stream_lock_irq (substream); +set_current_state (TASK_INTERRUPTIBLE );switch (runtime->status->state) {case SNDRV_PCM_STATE_SUSPENDED : err = -ESTRPIPE ;
@@ -1814,6 +1836,7 @@ static int wait_for_avail(struct snd_pcm_substream *substream,break ; } _endloop: +set_current_state (TASK_RUNNING );remove_wait_queue (&runtime->tsleep, &wait); *availp = avail;return err;
Signature · 8 lines
1.7.6 -- Arjan van de Ven Intel Open Source Technology Centre For development, discussion and tips for power savings, visit http://www.lesswatts.org
Quoted 33 lines · On Mon, 5 Sep 2011 09:49:47 -0700 Arjan van de Ven <[email protected]> wrote:
Quoted 1 line
From
2e37f0a4b2289962e1a45d8e02f8a7f7adad619fMon Sep 17 00:00:00 2001From: Arjan van de Ven <[email protected]>
Date: Mon, 5 Sep 2011 09:40:18 -0700
Subject: [PATCH] sound: Fix race condition in thepcm_lib"wait for space" loopThe
wait_for_avail()function inpcm_lib.chas a race in it (observed in practice by an Intel validation group).The function is supposed to return once space in the buffer has become available, or if some timeout happens. The entity that creates space (irq handler of sound driver and some such) will do a wake up on a waitqueue that this function registers for.
However there are two races in the existing code
1) If space became available between the caller noticing there was no space and this function actually sleeping, the wakeup is missed and the timeout condition will happen instead
2) If a wakeup happened but not sufficient space became available, the code will loop again and wait for more space. However, if the second wake comes in prior to hitting theschedule_timeout_interruptible(), it will be missed, and potentially you'll wait out until the timeout happens.The fix consists of using more careful setting of the current state (so that if a wakeup happens in the main loop window, the
schedule_timeout()falls through) and by checking for available space prior to going into theschedule_timeout()loop, but after being on the waitqueue and having the state set to interruptible....
sound/core/pcm_lib.c static int wait_for_avail(struct snd_pcm_substream *substream, · line 1766
Quoted 6 lines
sound/core/pcm_lib.c +3
-0@@ -1761,6 +1761,10 @@ static int wait_for_avail(struct snd_pcm_substream *substream,snd_pcm_uframes_t avail =0 ;long wait_time, tout; +init_waitqueue_entry (&wait, current); +add_wait_queue (&runtime->tsleep, &wait); +set_current_state (TASK_INTERRUPTIBLE );
Well, this isn't very good either. if a wakeup gets delivered to runtime->tsleep before the set_current_state(), this process will go ahead and incorrectly set itself into TASK_INTERRUPTIBLE state.
That looks like it will be dont-care/cant-happen in this case, but it's setting a bad example.
Quoted 6 lines · On Tue, 6 Sep 2011 15:59:54 -0700 Andrew Morton <[email protected]>…
Quoted 6 lines
sound/core/pcm_lib.c +0
-0@@ -1761,6 +1761,10 @@ static int wait_for_avail(struct snd_pcm_substream *substream, snd_pcm_uframes_t avail = 0;long wait_time, tout;
Quoted 7 lines
sound/core/pcm_lib.c static int wait_for_avail(struct snd_pcm_substream *substream, · line 1766
Quoted 3 lines
sound/core/pcm_lib.c +3
-0+init_waitqueue_entry (&wait, current); +add_wait_queue (&runtime->tsleep, &wait); +set_current_state (TASK_INTERRUPTIBLE );Well, this isn't very good either. if a wakeup gets delivered to
runtime->tsleepbefore theset_current_state(), this process will go ahead and incorrectly set itself intoTASK_INTERRUPTIBLEstate.
... and then check the condition for exit, and then set it to TASK_RUNABLE a the end...
Quoted 3 lines
That looks like it will be dont-care/cant-happen in this case, but it's setting a bad example.
agreed that your ordering is more clean/better.....
Signature · 3 lines
Arjan van de Ven Intel Open Source Technology Centre For development, discussion and tips for power savings, visit http://www.lesswatts.org
Hi,
sorry for the late follow-up, as I've been on vacation until today.
At Mon, 5 Sep 2011 09:49:47 -0700,
Quoted 65 lines · Arjan van de Ven
Quoted 2 lines
From
2e37f0a4b2289962e1a45d8e02f8a7f7adad619fMon Sep 17 00:00:00 2001From: Arjan van de Ven <[email protected]>
Date: Mon, 5 Sep 2011 09:40:18 -0700
Subject: [PATCH] sound: Fix race condition in thepcm_lib"wait for space" loopThe
wait_for_avail()function inpcm_lib.chas a race in it (observed in practice by an Intel validation group).The function is supposed to return once space in the buffer has become available, or if some timeout happens. The entity that creates space (irq handler of sound driver and some such) will do a wake up on a waitqueue that this function registers for.
However there are two races in the existing code
1) If space became available between the caller noticing there was no space and this function actually sleeping, the wakeup is missed and the timeout condition will happen instead
2) If a wakeup happened but not sufficient space became available, the code will loop again and wait for more space. However, if the second wake comes in prior to hitting theschedule_timeout_interruptible(), it will be missed, and potentially you'll wait out until the timeout happens.The fix consists of using more careful setting of the current state (so that if a wakeup happens in the main loop window, the
schedule_timeout()falls through) and by checking for available space prior to going into theschedule_timeout()loop, but after being on the waitqueue and having the state set to interruptible.Signed-off-by Arjan van de Ven <[email protected]>CC Jaroslav Kysela <[email protected]>CC Takashi Iwai <[email protected]>--- sound/core/pcm_lib.c | 29 ++++++++++++++++++++++++++--- 1 files changed, 26 insertions(+), 3 deletions(-)sound/core/pcm_lib.c +10
-2@@ -1761,6 +1761,10 @@ static int wait_for_avail(struct snd_pcm_substream *substream,snd_pcm_uframes_t avail =0 ;long wait_time, tout; +init_waitqueue_entry (&wait, current); +add_wait_queue (&runtime->tsleep, &wait); +set_current_state (TASK_INTERRUPTIBLE ); +if (runtime->no_period_wakeup) wait_time =MAX_SCHEDULE_TIMEOUT ;else {@@ -1771,16 +1775,34 @@ static int wait_for_avail(struct snd_pcm_substream *substream, } wait_time =msecs_to_jiffies (wait_time *1000 ); } -init_waitqueue_entry (&wait, current); -add_wait_queue (&runtime->tsleep, &wait); + +/* +* We need to check if space became available already (and thus the +* wakeup happened already) prior to going into the sleep loop to +* close the race of space already having become available. +* This check must happen after been added to the waitqueue and
sound/core/pcm_lib.c static int wait_for_avail(struct snd_pcm_substream *substream, · line 1793
Quoted 10 lines
sound/core/pcm_lib.c +10
-0+* having current state be INTERRUPTIBLE. +*/ + +if (is_playback) + avail =snd_pcm_playback_avail (runtime); +else + avail =snd_pcm_capture_avail (runtime); +if (avail >= runtime->twake) + goto _endloop; +
Instead of adding this, we can move the check in the for loop at the beginning of the loop, no?
Quoted 16 lines
sound/core/pcm_lib.c +4
-1for (;;) {if (signal_pending (current)) { err = -ERESTARTSYS ;break ; }snd_pcm_stream_unlock_irq (substream); - tout =schedule_timeout_interruptible (wait_time); + + tout =schedule_timeout (wait_time); +snd_pcm_stream_lock_irq (substream); +set_current_state (TASK_INTERRUPTIBLE );switch (runtime->status->state) {case SNDRV_PCM_STATE_SUSPENDED : err = -ESTRPIPE ;
sound/core/pcm_lib.c static int wait_for_avail(struct snd_pcm_substream *substream, · line 1842
Quoted 7 lines
sound/core/pcm_lib.c +1
-0@@ -1814,6 +1836,7 @@ static int wait_for_avail(struct snd_pcm_substream *substream,break ; } _endloop: +set_current_state (TASK_RUNNING );remove_wait_queue (&runtime->tsleep, &wait); *availp = avail;return err;
thanks,
Takashi
At Mon, 12 Sep 2011 11:57:31 +0200,
Quoted 77 lines · Takashi Iwai
Hi,
sorry for the late follow-up, as I've been on vacation until today.
At Mon, 5 Sep 2011 09:49:47 -0700,
Quoted 70 lines · Arjan van de Ven
Quoted 2 lines
From
2e37f0a4b2289962e1a45d8e02f8a7f7adad619fMon Sep 17 00:00:00 2001From: Arjan van de Ven <[email protected]>
Date: Mon, 5 Sep 2011 09:40:18 -0700
Subject: [PATCH] sound: Fix race condition in thepcm_lib"wait for space" loopThe
wait_for_avail()function inpcm_lib.chas a race in it (observed in practice by an Intel validation group).The function is supposed to return once space in the buffer has become available, or if some timeout happens. The entity that creates space (irq handler of sound driver and some such) will do a wake up on a waitqueue that this function registers for.
However there are two races in the existing code
1) If space became available between the caller noticing there was no space and this function actually sleeping, the wakeup is missed and the timeout condition will happen instead
2) If a wakeup happened but not sufficient space became available, the code will loop again and wait for more space. However, if the second wake comes in prior to hitting theschedule_timeout_interruptible(), it will be missed, and potentially you'll wait out until the timeout happens.The fix consists of using more careful setting of the current state (so that if a wakeup happens in the main loop window, the
schedule_timeout()falls through) and by checking for available space prior to going into theschedule_timeout()loop, but after being on the waitqueue and having the state set to interruptible.Signed-off-by Arjan van de Ven <[email protected]>CC Jaroslav Kysela <[email protected]>CC Takashi Iwai <[email protected]>--- sound/core/pcm_lib.c | 29 ++++++++++++++++++++++++++--- 1 files changed, 26 insertions(+), 3 deletions(-)sound/core/pcm_lib.c +15
-2@@ -1761,6 +1761,10 @@ static int wait_for_avail(struct snd_pcm_substream *substream,snd_pcm_uframes_t avail =0 ;long wait_time, tout; +init_waitqueue_entry (&wait, current); +add_wait_queue (&runtime->tsleep, &wait); +set_current_state (TASK_INTERRUPTIBLE ); +if (runtime->no_period_wakeup) wait_time =MAX_SCHEDULE_TIMEOUT ;else {@@ -1771,16 +1775,34 @@ static int wait_for_avail(struct snd_pcm_substream *substream, } wait_time =msecs_to_jiffies (wait_time *1000 ); } -init_waitqueue_entry (&wait, current); -add_wait_queue (&runtime->tsleep, &wait); + +/* +* We need to check if space became available already (and thus the +* wakeup happened already) prior to going into the sleep loop to +* close the race of space already having become available. +* This check must happen after been added to the waitqueue and +* having current state be INTERRUPTIBLE. +*/ + +if (is_playback) + avail =snd_pcm_playback_avail (runtime);
Quoted 8 lines
sound/core/pcm_lib.c static int wait_for_avail(struct snd_pcm_substream *substream, · line 1793
Quoted 5 lines
sound/core/pcm_lib.c +5
-0+else + avail =snd_pcm_capture_avail (runtime); +if (avail >= runtime->twake) + goto _endloop; +Instead of adding this, we can move the check in the for loop at the beginning of the loop, no?
FYI, I applied the patch below to my tree. It contains Andrew's fix and my slight refactoring.
thanks,
Takashi
---
From: Arjan van de Ven <[email protected]>
Subject: ALSA: pcm - fix race condition in wait_for_avail()
wait_for_avail() in pcm_lib.c has a race in it (observed in practice by an Intel validation group).
The function is supposed to return once space in the buffer has become available, or if some timeout happens. The entity that creates space (irq handler of sound driver and some such) will do a wake up on a waitqueue that this function registers for.
However there are two races in the existing code
1) If space became available between the caller noticing there was no space and this function actually sleeping, the wakeup is missed and the timeout condition will happen instead
2) If a wakeup happened but not sufficient space became available, the code will loop again and wait for more space. However, if the second wake comes in prior to hitting the schedule_timeout_interruptible(), it will be missed, and potentially you'll wait out until the timeout happens.
The fix consists of using more careful setting of the current state (so that if a wakeup happens in the main loop window, the schedule_timeout() falls through) and by checking for available space prior to going into the schedule_timeout() loop, but after being on the waitqueue and having the state set to interruptible.
[tiwai: the following changes have been added to Arjan's original patch:
- merged akpm's fix for waitqueue adding order into a single patch
- reduction of duplicated code of avail check
]
--- sound/core/pcm_lib.c | 33 ++++++++++++++++++++++++--------- 1 files changed, 24 insertions(+), 9 deletions(-)
sound/core/pcm_lib.c +24 -9
@@ -1761,6 +1761,10 @@ static int wait_for_avail(struct snd_pcm_substream *substream,snd_pcm_uframes_t avail =0 ;long wait_time, tout; +init_waitqueue_entry (&wait, current); +set_current_state (TASK_INTERRUPTIBLE ); +add_wait_queue (&runtime->tsleep, &wait); +if (runtime->no_period_wakeup) wait_time =MAX_SCHEDULE_TIMEOUT ;else {
@@ -1771,16 +1775,32 @@ static int wait_for_avail(struct snd_pcm_substream *substream, } wait_time =msecs_to_jiffies (wait_time *1000 ); } -init_waitqueue_entry (&wait, current); -add_wait_queue (&runtime->tsleep, &wait); +for (;;) {if (signal_pending (current)) { err = -ERESTARTSYS ;break ; } + +/* +* We need to check if space became available already +* (and thus the wakeup happened already) first to close +* the race of space already having become available. +* This check must happen after been added to the waitqueue +* and having current state be INTERRUPTIBLE. +*/ +if (is_playback) + avail =snd_pcm_playback_avail (runtime); +else + avail =snd_pcm_capture_avail (runtime); +if (avail >= runtime->twake) +break ;snd_pcm_stream_unlock_irq (substream); - tout =schedule_timeout_interruptible (wait_time); + + tout =schedule_timeout (wait_time); +snd_pcm_stream_lock_irq (substream); +set_current_state (TASK_INTERRUPTIBLE );switch (runtime->status->state) {case SNDRV_PCM_STATE_SUSPENDED : err = -ESTRPIPE ;
@@ -1806,14 +1826,9 @@ static int wait_for_avail(struct snd_pcm_substream *substream, err = -EIO ;break ; } -if (is_playback) - avail =snd_pcm_playback_avail (runtime); -else - avail =snd_pcm_capture_avail (runtime); -if (avail >= runtime->twake) -break ; } _endloop: +set_current_state (TASK_RUNNING );remove_wait_queue (&runtime->tsleep, &wait); *availp = avail;return err;
Signature · 1 line
1.7.6.1