Remove WTF::SpinLock
[WebKit-https.git] / Source / WTF / benchmarks / LockSpeedTest.cpp
1 /*
2  * Copyright (C) 2015 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
24  */
25
26 // On Mac, you can build this like so:
27 // clang++ -o LockSpeedTest Source/WTF/benchmarks/LockSpeedTest.cpp -O3 -W -ISource/WTF -LWebKitBuild/Release -lWTF -framework Foundation -licucore -std=c++11
28
29 #include "config.h"
30
31 #include <unistd.h>
32 #include <wtf/CurrentTime.h>
33 #include <wtf/Lock.h>
34 #include <wtf/StdLibExtras.h>
35 #include <wtf/Threading.h>
36 #include <wtf/ThreadingPrimitives.h>
37 #include <wtf/WordLock.h>
38
39 namespace {
40
41 // This is the old WTF::SpinLock class, included here so that we can still compare our new locks to a
42 // spinlock baseline.
43 class SpinLock {
44 public:
45     SpinLock()
46     {
47         m_lock.store(0, std::memory_order_relaxed);
48     }
49
50     void lock()
51     {
52         while (!m_lock.compareExchangeWeak(0, 1, std::memory_order_acquire))
53             std::this_thread::yield();
54     }
55
56     void unlock()
57     {
58         m_lock.store(0, std::memory_order_release);
59     }
60
61     bool isLocked() const
62     {
63         return m_lock.load(std::memory_order_acquire);
64     }
65
66 private:
67     Atomic<unsigned> m_lock;
68 };
69
70 unsigned numThreadGroups;
71 unsigned numThreadsPerGroup;
72 unsigned workPerCriticalSection;
73 unsigned numNoiseThreads;
74 unsigned numIterations;
75     
76 NO_RETURN void usage()
77 {
78     printf("Usage: LockSpeedTest spinlock|wordlock|lock|mutex|all <num thread groups> <num threads per group> <work per critical section> <num noise threads> <num iterations>\n");
79     exit(1);
80 }
81
82 template<typename LockType>
83 void runBenchmark(const char* name)
84 {
85     std::unique_ptr<LockType[]> locks = std::make_unique<LockType[]>(numThreadGroups);
86     std::unique_ptr<double[]> words = std::make_unique<double[]>(numThreadGroups);
87     std::unique_ptr<ThreadIdentifier[]> threads = std::make_unique<ThreadIdentifier[]>(numThreadGroups * numThreadsPerGroup);
88     std::unique_ptr<ThreadIdentifier[]> noiseThreads = std::make_unique<ThreadIdentifier[]>(numNoiseThreads);
89     std::unique_ptr<double[]> noiseCounts = std::make_unique<double[]>(numNoiseThreads);
90
91     volatile bool shouldStop = false;
92     for (unsigned threadIndex = numNoiseThreads; threadIndex--;) {
93         noiseCounts[threadIndex] = 0;
94         noiseThreads[threadIndex] = createThread(
95             "Noise Thread",
96             [&shouldStop, &noiseCounts, threadIndex] () {
97                 while (!shouldStop)
98                     noiseCounts[threadIndex]++;
99             });
100     }
101
102     double before = monotonicallyIncreasingTimeMS();
103     
104     for (unsigned threadGroupIndex = numThreadGroups; threadGroupIndex--;) {
105         words[threadGroupIndex] = 0;
106
107         for (unsigned threadIndex = numThreadsPerGroup; threadIndex--;) {
108             threads[threadGroupIndex * numThreadsPerGroup + threadIndex] = createThread(
109                 "Benchmark thread",
110                 [threadGroupIndex, &locks, &words] () {
111                     for (unsigned i = numIterations; i--;) {
112                         locks[threadGroupIndex].lock();
113                         for (unsigned j = workPerCriticalSection; j--;) {
114                             words[threadGroupIndex]++;
115                             words[threadGroupIndex] *= 1.01;
116                         }
117                         locks[threadGroupIndex].unlock();
118                     }
119                 });
120         }
121     }
122
123     for (unsigned threadIndex = numThreadGroups * numThreadsPerGroup; threadIndex--;)
124         waitForThreadCompletion(threads[threadIndex]);
125     shouldStop = true;
126     double noiseCount = 0;
127     for (unsigned threadIndex = numNoiseThreads; threadIndex--;) {
128         waitForThreadCompletion(noiseThreads[threadIndex]);
129         noiseCount += noiseCounts[threadIndex];
130     }
131
132     double after = monotonicallyIncreasingTimeMS();
133
134     printf("%s: %.3lf ms, %.0lf noise.\n", name, after - before, noiseCount);
135 }
136
137 } // anonymous namespace
138
139 int main(int argc, char** argv)
140 {
141     WTF::initializeThreading();
142     
143     if (argc != 7
144         || sscanf(argv[2], "%u", &numThreadGroups) != 1
145         || sscanf(argv[3], "%u", &numThreadsPerGroup) != 1
146         || sscanf(argv[4], "%u", &workPerCriticalSection) != 1
147         || sscanf(argv[5], "%u", &numNoiseThreads) != 1
148         || sscanf(argv[6], "%u", &numIterations) != 1)
149         usage();
150
151     bool didRun = false;
152     if (!strcmp(argv[1], "spinlock") || !strcmp(argv[1], "all")) {
153         runBenchmark<SpinLock>("SpinLock");
154         didRun = true;
155     }
156     if (!strcmp(argv[1], "wordlock") || !strcmp(argv[1], "all")) {
157         runBenchmark<WordLock>("WTF WordLock");
158         didRun = true;
159     }
160     if (!strcmp(argv[1], "lock") || !strcmp(argv[1], "all")) {
161         runBenchmark<Lock>("WTF Lock");
162         didRun = true;
163     }
164     if (!strcmp(argv[1], "mutex") || !strcmp(argv[1], "all")) {
165         runBenchmark<Mutex>("Platform Mutex");
166         didRun = true;
167     }
168
169     if (!didRun)
170         usage();
171
172     return 0;
173 }