pulseaudio/src/pulsecore/once.c
David Henningsson 1ba655560d once: Fix race causing pa_once to sometimes run twice
There was a race in the existing code that could cause the pa_once code
to be run twice, see:
http://lists.freedesktop.org/archives/pulseaudio-discuss/2012-April/013354.html

Therefore the existing implementation was rewritten to instead look like
the reference implementation here:
http://www.hpl.hp.com/research/linux/atomic_ops/example.php4

Signed-off-by: David Henningsson <david.henningsson@canonical.com>
2012-05-25 10:50:37 +02:00

77 lines
2 KiB
C

/***
This file is part of PulseAudio.
Copyright 2006 Lennart Poettering
PulseAudio is free software; you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published
by the Free Software Foundation; either version 2.1 of the License,
or (at your option) any later version.
PulseAudio is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
General Public License for more details.
You should have received a copy of the GNU Lesser General Public License
along with PulseAudio; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
USA.
***/
#ifdef HAVE_CONFIG_H
#include <config.h>
#endif
#include <pulsecore/macro.h>
#include "once.h"
/* See http://www.hpl.hp.com/research/linux/atomic_ops/example.php4 for the
* reference algorithm used here. */
pa_bool_t pa_once_begin(pa_once *control) {
pa_mutex *m;
pa_assert(control);
if (pa_atomic_load(&control->done))
return FALSE;
/* Caveat: We have to make sure that the once func has completed
* before returning, even if the once func is not actually
* executed by us. Hence the awkward locking. */
m = pa_static_mutex_get(&control->mutex, FALSE, FALSE);
pa_mutex_lock(m);
if (pa_atomic_load(&control->done)) {
pa_mutex_unlock(m);
return FALSE;
}
return TRUE;
}
void pa_once_end(pa_once *control) {
pa_mutex *m;
pa_assert(control);
pa_assert(!pa_atomic_load(&control->done));
pa_atomic_store(&control->done, 1);
m = pa_static_mutex_get(&control->mutex, FALSE, FALSE);
pa_mutex_unlock(m);
}
/* Not reentrant -- how could it be? */
void pa_run_once(pa_once *control, pa_once_func_t func) {
pa_assert(control);
pa_assert(func);
if (pa_once_begin(control)) {
func();
pa_once_end(control);
}
}