<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[231148] trunk/Source/WTF</title>
</head>
<body>

<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt;  }
#msg dl a { font-weight: bold}
#msg dl a:link    { color:#fc3; }
#msg dl a:active  { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff  {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta">
<dt>Revision</dt> <dd><a href="http://trac.webkit.org/projects/webkit/changeset/231148">231148</a></dd>
<dt>Author</dt> <dd>ggaren@apple.com</dd>
<dt>Date</dt> <dd>2018-04-29 08:23:52 -0700 (Sun, 29 Apr 2018)</dd>
</dl>

<h3>Log Message</h3>
<pre>Fixed a very unlikely race condition in WTF::WordLock
https://bugs.webkit.org/show_bug.cgi?id=185117

Reviewed by Saam Barati.

The race goes like this:

Thread L is in lockSlowCase() and thread U is in unlockSlowCase();

- U acquires queueHead->parkingLock.
- U sets queueHead->shouldPark = false
- U releases queueHead->parkingLock.
- L spuriously wakes up from queueHead->parkingLock.wait()
- L acquires queueHead->parkingLock.
- L notices that queueHead->shouldPark = false, and acquires the WordLock
- L finishes all its work and exits, freeing queueHead
- U notifies queueHead->parkingLock (after free) and crashes or deadlocks

These conditions are currently so unlikely that I don't know how to test
them. I noticed this race because I changed WordLock's allocation pattern
to allow queueHead to be freed more often, and I crashed / deadlocked 100%.

Shout out to <http://en.cppreference.com/w/cpp/thread/condition_variable/notify_one>
for explaining this.

* benchmarks/ToyLocks.h: Fixed build.

* wtf/WordLock.cpp:
(WTF::WordLock::unlockSlow): Hold the lock a little longer to avoid
this race.</pre>

<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkSourceWTFChangeLog">trunk/Source/WTF/ChangeLog</a></li>
<li><a href="#trunkSourceWTFbenchmarksToyLocksh">trunk/Source/WTF/benchmarks/ToyLocks.h</a></li>
<li><a href="#trunkSourceWTFwtfWordLockcpp">trunk/Source/WTF/wtf/WordLock.cpp</a></li>
</ul>

</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkSourceWTFChangeLog"></a>
<div class="modfile"><h4>Modified: trunk/Source/WTF/ChangeLog (231147 => 231148)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WTF/ChangeLog       2018-04-29 13:33:25 UTC (rev 231147)
+++ trunk/Source/WTF/ChangeLog  2018-04-29 15:23:52 UTC (rev 231148)
</span><span class="lines">@@ -1,3 +1,36 @@
</span><ins>+2018-04-28  Geoffrey Garen  <ggaren@apple.com>
+
+        Fixed a very unlikely race condition in WTF::WordLock
+        https://bugs.webkit.org/show_bug.cgi?id=185117
+
+        Reviewed by Saam Barati.
+
+        The race goes like this:
+
+        Thread L is in lockSlowCase() and thread U is in unlockSlowCase();
+
+        - U acquires queueHead->parkingLock.
+        - U sets queueHead->shouldPark = false
+        - U releases queueHead->parkingLock.
+        - L spuriously wakes up from queueHead->parkingLock.wait()
+        - L acquires queueHead->parkingLock.
+        - L notices that queueHead->shouldPark = false, and acquires the WordLock
+        - L finishes all its work and exits, freeing queueHead
+        - U notifies queueHead->parkingLock (after free) and crashes or deadlocks
+
+        These conditions are currently so unlikely that I don't know how to test
+        them. I noticed this race because I changed WordLock's allocation pattern
+        to allow queueHead to be freed more often, and I crashed / deadlocked 100%.
+
+        Shout out to <http://en.cppreference.com/w/cpp/thread/condition_variable/notify_one>
+        for explaining this.
+
+        * benchmarks/ToyLocks.h: Fixed build.
+
+        * wtf/WordLock.cpp:
+        (WTF::WordLock::unlockSlow): Hold the lock a little longer to avoid
+        this race.
+
</ins><span class="cx"> 2018-04-27  David Kilzer  <ddkilzer@apple.com>
</span><span class="cx"> 
</span><span class="cx">         Add logging when SpringBoard enables WebThread
</span></span></pre></div>
<a id="trunkSourceWTFbenchmarksToyLocksh"></a>
<div class="modfile"><h4>Modified: trunk/Source/WTF/benchmarks/ToyLocks.h (231147 => 231148)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WTF/benchmarks/ToyLocks.h   2018-04-29 13:33:25 UTC (rev 231147)
+++ trunk/Source/WTF/benchmarks/ToyLocks.h      2018-04-29 15:23:52 UTC (rev 231148)
</span><span class="lines">@@ -31,6 +31,7 @@
</span><span class="cx"> #include <wtf/Atomics.h>
</span><span class="cx"> #include <wtf/Lock.h>
</span><span class="cx"> #include <wtf/ParkingLot.h>
</span><ins>+#include <wtf/Threading.h>
</ins><span class="cx"> #include <wtf/WordLock.h>
</span><span class="cx"> 
</span><span class="cx"> #if __has_include(<os/lock.h>)
</span></span></pre></div>
<a id="trunkSourceWTFwtfWordLockcpp"></a>
<div class="modfile"><h4>Modified: trunk/Source/WTF/wtf/WordLock.cpp (231147 => 231148)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WTF/wtf/WordLock.cpp        2018-04-29 13:33:25 UTC (rev 231147)
+++ trunk/Source/WTF/wtf/WordLock.cpp   2018-04-29 15:23:52 UTC (rev 231148)
</span><span class="lines">@@ -254,12 +254,15 @@
</span><span class="cx">     // We do this carefully because this may run either before or during the parkingLock critical
</span><span class="cx">     // section in lockSlow().
</span><span class="cx">     {
</span><ins>+        // Be sure to hold the lock across our call to notify_one() because a spurious wakeup could
+        // cause the thread at the head of the queue to exit and delete queueHead.
</ins><span class="cx">         std::lock_guard<std::mutex> locker(queueHead->parkingLock);
</span><span class="cx">         queueHead->shouldPark = false;
</span><ins>+
+        // Doesn't matter if we notify_all() or notify_one() here since the only thread that could be
+        // waiting is queueHead.
+        queueHead->parkingCondition.notify_one();
</ins><span class="cx">     }
</span><del>-    // Doesn't matter if we notify_all() or notify_one() here since the only thread that could be
-    // waiting is queueHead.
-    queueHead->parkingCondition.notify_one();
</del><span class="cx"> 
</span><span class="cx">     // The old queue head can now contend for the lock again. We're done!
</span><span class="cx"> }
</span></span></pre>
</div>
</div>

</body>
</html>