MallocBench should have a stress test for correctness
[WebKit-https.git] / PerformanceTests / MallocBench / MallocBench / Benchmark.cpp
1 /*
2  * Copyright (C) 2014 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 #include "Benchmark.h"
27 #include "CPUCount.h"
28 #include "balloon.h"
29 #include "big.h"
30 #include "churn.h"
31 #include "facebook.h"
32 #include "flickr.h"
33 #include "fragment.h"
34 #include "list.h"
35 #include "medium.h"
36 #include "message.h"
37 #include "reddit.h"
38 #include "stress.h"
39 #include "theverge.h"
40 #include "tree.h"
41 #include <dispatch/dispatch.h>
42 #include <iostream>
43 #include <mach/mach.h>
44 #include <mach/task_info.h>
45 #include <map>
46 #include <string>
47 #include <sys/time.h>
48 #include <thread>
49 #include <unistd.h>
50
51 #include "mbmalloc.h"
52
53 using namespace std;
54
55 struct BenchmarkPair {
56     const char* const name;
57     const BenchmarkFunction function;
58 };
59
60 static const BenchmarkPair benchmarkPairs[] = {
61     { "balloon", benchmark_balloon },
62     { "big", benchmark_big },
63     { "churn", benchmark_churn },
64     { "facebook", benchmark_facebook },
65     { "flickr", benchmark_flickr },
66     { "flickr_memory_warning", benchmark_flickr_memory_warning },
67     { "fragment", benchmark_fragment },
68     { "fragment_iterate", benchmark_fragment_iterate },
69     { "list_allocate", benchmark_list_allocate },
70     { "list_traverse", benchmark_list_traverse },
71     { "medium", benchmark_medium },
72     { "message_many", benchmark_message_many },
73     { "message_one", benchmark_message_one },
74     { "reddit", benchmark_reddit },
75     { "reddit_memory_warning", benchmark_reddit_memory_warning },
76     { "stress", benchmark_stress },
77     { "theverge", benchmark_theverge },
78     { "theverge_memory_warning", benchmark_theverge_memory_warning },
79     { "tree_allocate", benchmark_tree_allocate },
80     { "tree_churn", benchmark_tree_churn },
81     { "tree_traverse", benchmark_tree_traverse },
82 };
83
84 static const size_t benchmarksPairsCount = sizeof(benchmarkPairs) / sizeof(BenchmarkPair);
85
86 static inline bool operator==(const BenchmarkPair& benchmarkPair, const string& string)
87 {
88     return string == benchmarkPair.name;
89 }
90
91 static void*** allocateHeap(size_t heapSize, size_t chunkSize, size_t objectSize)
92 {
93     if (!heapSize)
94         return 0;
95
96     size_t chunkCount = heapSize / chunkSize;
97     size_t objectCount = chunkSize / objectSize;
98     void*** chunks = (void***)mbmalloc(chunkCount * sizeof(void**));
99     for (size_t i = 0; i < chunkCount; ++i) {
100         chunks[i] = (void**)mbmalloc(objectCount * sizeof(void*));
101         for (size_t j = 0; j < objectCount; ++j) {
102             chunks[i][j] = (void*)mbmalloc(objectSize);
103             bzero(chunks[i][j], objectSize);
104         }
105     }
106     return chunks;
107 }
108
109 static void deallocateHeap(void*** chunks, size_t heapSize, size_t chunkSize, size_t objectSize)
110 {
111     if (!heapSize)
112         return;
113
114     size_t chunkCount = heapSize / chunkSize;
115     size_t objectCount = chunkSize / objectSize;
116     for (size_t i = 0; i < chunkCount; ++i) {
117         for (size_t j = 0; j < objectCount; ++j)
118             mbfree(chunks[i][j], objectSize);
119         mbfree(chunks[i], objectCount * sizeof(void*));
120     }
121     mbfree(chunks, chunkCount * sizeof(void**));
122 }
123
124 Benchmark::Benchmark(const string& benchmarkName, bool isParallel, size_t runs, size_t heapSize)
125     : m_benchmarkPair()
126     , m_elapsedTime()
127     , m_isParallel(isParallel)
128     , m_heapSize(heapSize)
129     , m_runs(runs)
130 {
131     const BenchmarkPair* benchmarkPair = std::find(
132         benchmarkPairs, benchmarkPairs + benchmarksPairsCount, benchmarkName);
133     if (benchmarkPair == benchmarkPairs + benchmarksPairsCount)
134         return;
135     
136     m_benchmarkPair = benchmarkPair;
137 }
138     
139 void Benchmark::printBenchmarks()
140 {
141     cout << "Benchmarks: " << endl;
142     for (size_t i = 0; i < benchmarksPairsCount; ++i)
143         cout << "\t" << benchmarkPairs[i].name << endl;
144 }
145
146 void Benchmark::runOnce()
147 {
148     if (!m_isParallel) {
149         m_benchmarkPair->function(m_isParallel);
150         return;
151     }
152
153     dispatch_group_t group = dispatch_group_create();
154
155     for (size_t i = 0; i < cpuCount(); ++i) {
156         dispatch_group_async(group, dispatch_get_global_queue(DISPATCH_QUEUE_PRIORITY_HIGH, 0), ^{
157             m_benchmarkPair->function(m_isParallel);
158         });
159     }
160
161     dispatch_group_wait(group, DISPATCH_TIME_FOREVER);
162
163     dispatch_release(group);
164 }
165
166 void Benchmark::run()
167 {
168     static const size_t objectSize = 32;
169     static const size_t chunkSize = 1024 * 1024;
170     
171     void*** heap = allocateHeap(m_heapSize, chunkSize, objectSize);
172
173     runOnce(); // Warmup run.
174
175     for (size_t i = 0; i < m_runs; ++i) {
176         double start = currentTimeMS();
177         runOnce();
178         double end = currentTimeMS();
179         double elapsed = end - start;
180         m_elapsedTime += elapsed;
181     }
182     m_elapsedTime /= m_runs;
183
184     deallocateHeap(heap, m_heapSize, chunkSize, objectSize);
185     
186     mbscavenge();
187     m_memory = currentMemoryBytes();
188 }
189
190 void Benchmark::printReport()
191 {
192     size_t kB = 1024;
193
194     cout << "Time:       \t" << m_elapsedTime << "ms" << endl;
195     cout << "Memory:     \t" << m_memory.resident / kB << "kB" << endl;
196     cout << "Peak Memory:\t" << m_memory.residentMax / kB << "kB" << endl;
197 }
198
199 double Benchmark::currentTimeMS()
200 {
201     struct timeval now;
202     gettimeofday(&now, 0);
203     return (now.tv_sec * 1000.0) + now.tv_usec / 1000.0;
204 }
205
206 Benchmark::Memory Benchmark::currentMemoryBytes()
207 {
208     Memory memory;
209
210     task_vm_info_data_t vm_info;
211     mach_msg_type_number_t vm_size = TASK_VM_INFO_COUNT;
212     if (KERN_SUCCESS != task_info(mach_task_self(), TASK_VM_INFO_PURGEABLE, (task_info_t)(&vm_info), &vm_size)) {
213         cout << "Failed to get mach task info" << endl;
214         exit(1);
215     }
216
217     memory.resident = vm_info.internal - vm_info.purgeable_volatile_pmap;
218     memory.residentMax = vm_info.resident_size_peak;
219     return memory;
220 }