<?xml version="1.0" encoding="ANSI_X3.4-1968" standalone="no"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=ANSI_X3.4-1968" /><title>wait_event_interruptible_locked</title><meta name="generator" content="DocBook XSL Stylesheets V1.76.1" /><link rel="home" href="index.html" title="Linux Device Drivers" /><link rel="up" href="ch01s04.html" title="Wait queues and Wake events" /><link rel="prev" href="API-wait-event-interruptible-timeout.html" title="wait_event_interruptible_timeout" /><link rel="next" href="API-wait-event-interruptible-locked-irq.html" title="wait_event_interruptible_locked_irq" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center"><span>wait_event_interruptible_locked</span></th></tr><tr><td width="20%" align="left"><a accesskey="p" href="API-wait-event-interruptible-timeout.html">Prev</a> </td><th width="60%" align="center">Wait queues and Wake events</th><td width="20%" align="right"> <a accesskey="n" href="API-wait-event-interruptible-locked-irq.html">Next</a></td></tr></table><hr /></div><div class="refentry" title="wait_event_interruptible_locked"><a id="API-wait-event-interruptible-locked"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>wait_event_interruptible_locked —
sleep until a condition gets true
</p></div><div class="refsynopsisdiv" title="Synopsis"><h2>Synopsis</h2><div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table"><tr><td><code class="funcdef"> <strong>fsfuncwait_event_interruptible_locked </strong>(</code></td><td> <var class="pdparam">wq</var>, </td></tr><tr><td> </td><td> <var class="pdparam">condition</var><code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div></div><div class="refsect1" title="Arguments"><a id="id3051833"></a><h2>Arguments</h2><div class="variablelist"><dl><dt><span class="term"><em class="parameter"><code>wq</code></em></span></dt><dd><p>
the waitqueue to wait on
</p></dd><dt><span class="term"><em class="parameter"><code>condition</code></em></span></dt><dd><p>
a C expression for the event to wait for
</p></dd></dl></div></div><div class="refsect1" title="Description"><a id="id3051876"></a><h2>Description</h2><p>
The process is put to sleep (TASK_INTERRUPTIBLE) until the
<em class="parameter"><code>condition</code></em> evaluates to true or a signal is received.
The <em class="parameter"><code>condition</code></em> is checked each time the waitqueue <em class="parameter"><code>wq</code></em> is woken up.
</p><p>
It must be called with wq.lock being held. This spinlock is
unlocked while sleeping but <em class="parameter"><code>condition</code></em> testing is done while lock
is held and when this macro exits the lock is held.
</p><p>
The lock is locked/unlocked using <code class="function">spin_lock</code>/<code class="function">spin_unlock</code>
functions which must match the way they are locked/unlocked outside
of this macro.
</p><p>
<code class="function">wake_up_locked</code> has to be called after changing any variable that could
change the result of the wait condition.
</p><p>
The function will return -ERESTARTSYS if it was interrupted by a
signal and 0 if <em class="parameter"><code>condition</code></em> evaluated to true.
</p></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="API-wait-event-interruptible-timeout.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="ch01s04.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="API-wait-event-interruptible-locked-irq.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top"><span>wait_event_interruptible_timeout</span> </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> <span>wait_event_interruptible_locked_irq</span></td></tr></table></div></body></html>
