Sophie: kernel-doc-3.11.10-100.fc18 noarch

kernel-doc-3.11.10-100.fc18.noarch.rpm

<?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>futex_wait_setup</title><meta name="generator" content="DocBook XSL Stylesheets V1.78.1" /><link rel="home" href="index.html" title="Unreliable Guide To Locking" /><link rel="up" href="apiref-futex.html" title="Chapter&#160;12.&#160;Futex API reference" /><link rel="prev" href="API-futex-wait-queue-me.html" title="futex_wait_queue_me" /><link rel="next" href="API-handle-early-requeue-pi-wakeup.html" title="handle_early_requeue_pi_wakeup" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center"><span class="phrase">futex_wait_setup</span></th></tr><tr><td width="20%" align="left"><a accesskey="p" href="API-futex-wait-queue-me.html">Prev</a>&#160;</td><th width="60%" align="center">Chapter&#160;12.&#160;Futex API reference</th><td width="20%" align="right">&#160;<a accesskey="n" href="API-handle-early-requeue-pi-wakeup.html">Next</a></td></tr></table><hr /></div><div class="refentry"><a id="API-futex-wait-setup"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>futex_wait_setup &#8212; 
     Prepare to wait on a futex
 </p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="funcsynopsis"><table border="0" class="funcprototype-table" summary="Function synopsis" style="cellspacing: 0; cellpadding: 0;"><tr><td><code class="funcdef">int <strong class="fsfunc">futex_wait_setup </strong>(</code></td><td>u32 __user * <var class="pdparam">uaddr</var>, </td></tr><tr><td>&#160;</td><td>u32 <var class="pdparam">val</var>, </td></tr><tr><td>&#160;</td><td>unsigned int <var class="pdparam">flags</var>, </td></tr><tr><td>&#160;</td><td>struct futex_q * <var class="pdparam">q</var>, </td></tr><tr><td>&#160;</td><td>struct futex_hash_bucket ** <var class="pdparam">hb</var><code>)</code>;</td></tr></table><div class="funcprototype-spacer">&#160;</div></div></div><div class="refsect1"><a id="idm140391695918992"></a><h2>Arguments</h2><div class="variablelist"><dl class="variablelist"><dt><span class="term"><em class="parameter"><code>uaddr</code></em></span></dt><dd><p>
     the futex userspace address
    </p></dd><dt><span class="term"><em class="parameter"><code>val</code></em></span></dt><dd><p>
     the expected value
    </p></dd><dt><span class="term"><em class="parameter"><code>flags</code></em></span></dt><dd><p>
     futex flags (FLAGS_SHARED, etc.)
    </p></dd><dt><span class="term"><em class="parameter"><code>q</code></em></span></dt><dd><p>
     the associated futex_q
    </p></dd><dt><span class="term"><em class="parameter"><code>hb</code></em></span></dt><dd><p>
     storage for hash_bucket pointer to be returned to caller
    </p></dd></dl></div></div><div class="refsect1"><a id="idm140391695908240"></a><h2>Description</h2><p>
   Setup the futex_q and locate the hash_bucket.  Get the futex value and
   compare it with the expected value.  Handle atomic faults internally.
   Return with the hb lock held and a q.key reference on success, and unlocked
   with no q.key reference on failure.
</p></div><div class="refsect1"><a id="idm140391695906800"></a><h2>Return</h2><p>
   0 - uaddr contains val and hb has been locked;
   &lt;1 - -EFAULT or -EWOULDBLOCK (uaddr does not contain val) and hb is unlocked
</p></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="API-futex-wait-queue-me.html">Prev</a>&#160;</td><td width="20%" align="center"><a accesskey="u" href="apiref-futex.html">Up</a></td><td width="40%" align="right">&#160;<a accesskey="n" href="API-handle-early-requeue-pi-wakeup.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top"><span class="phrase">futex_wait_queue_me</span>&#160;</td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top">&#160;<span class="phrase">handle_early_requeue_pi_wakeup</span></td></tr></table></div></body></html>