<?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>cancel_work_sync</title><meta name="generator" content="DocBook XSL Stylesheets V1.75.2" /><link rel="home" href="index.html" title="Linux Device Drivers" /><link rel="up" href="ch01s05.html" title="Workqueues and Kevents" /><link rel="prev" href="re100.html" title="flush_work" /><link rel="next" href="re102.html" title="cancel_delayed_work_sync" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center"><span>cancel_work_sync</span></th></tr><tr><td width="20%" align="left"><a accesskey="p" href="re100.html">Prev</a> </td><th width="60%" align="center">Workqueues and Kevents</th><td width="20%" align="right"> <a accesskey="n" href="re102.html">Next</a></td></tr></table><hr /></div><div class="refentry" title="cancel_work_sync"><a id="API-cancel-work-sync"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>cancel_work_sync —
block until a work_struct's callback has terminated
</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">int <b class="fsfunc">cancel_work_sync </b>(</code></td><td>struct work_struct * <var class="pdparam">work</var><code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div></div><div class="refsect1" title="Arguments"><a id="id2607445"></a><h2>Arguments</h2><div class="variablelist"><dl><dt><span class="term"><em class="parameter"><code>work</code></em></span></dt><dd><p>
the work which is to be flushed
</p></dd></dl></div></div><div class="refsect1" title="Description"><a id="id2607471"></a><h2>Description</h2><p>
Returns true if <em class="parameter"><code>work</code></em> was pending.
</p><p>
<code class="function">cancel_work_sync</code> will cancel the work if it is queued. If the work's
callback appears to be running, <code class="function">cancel_work_sync</code> will block until it
has completed.
</p><p>
It is possible to use this function if the work re-queues itself. It can
cancel the work even if it migrates to another workqueue, however in that
case it only guarantees that work-><code class="function">func</code> has completed on the last queued
workqueue.
</p><p>
cancel_work_sync(<span class="structname">delayed_work</span>->work) should be used only if ->timer is not
pending, otherwise it goes into a busy-wait loop until the timer expires.
</p><p>
The caller must ensure that workqueue_struct on which this work was last
queued can't be destroyed before this function returns.
</p></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="re100.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="ch01s05.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="re102.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top"><span>flush_work</span> </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> <span>cancel_delayed_work_sync</span></td></tr></table></div></body></html>
