1 // Copyright 2015 Google Inc. All rights reserved.
2 //
3 // Licensed under the Apache License, Version 2.0 (the "License");
4 // you may not use this file except in compliance with the License.
5 // You may obtain a copy of the License at
6 //
7 // http://www.apache.org/licenses/LICENSE-2.0
8 //
9 // Unless required by applicable law or agreed to in writing, software
10 // distributed under the License is distributed on an "AS IS" BASIS,
11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 // See the License for the specific language governing permissions and
13 // limitations under the License.
14
15 #include "benchmark/benchmark.h"
16 #include "complexity.h"
17
18 #include <algorithm>
19 #include <cstdint>
20 #include <iostream>
21 #include <string>
22 #include <tuple>
23 #include <vector>
24 #include <iomanip> // for setprecision
25 #include <limits>
26
27 #include "string_util.h"
28 #include "timers.h"
29
30 namespace benchmark {
31
32 namespace {
33
FormatKV(std::string const & key,std::string const & value)34 std::string FormatKV(std::string const& key, std::string const& value) {
35 return StrFormat("\"%s\": \"%s\"", key.c_str(), value.c_str());
36 }
37
FormatKV(std::string const & key,const char * value)38 std::string FormatKV(std::string const& key, const char* value) {
39 return StrFormat("\"%s\": \"%s\"", key.c_str(), value);
40 }
41
FormatKV(std::string const & key,bool value)42 std::string FormatKV(std::string const& key, bool value) {
43 return StrFormat("\"%s\": %s", key.c_str(), value ? "true" : "false");
44 }
45
FormatKV(std::string const & key,int64_t value)46 std::string FormatKV(std::string const& key, int64_t value) {
47 std::stringstream ss;
48 ss << '"' << key << "\": " << value;
49 return ss.str();
50 }
51
FormatKV(std::string const & key,double value)52 std::string FormatKV(std::string const& key, double value) {
53 std::stringstream ss;
54 ss << '"' << key << "\": ";
55
56 const auto max_digits10 = std::numeric_limits<decltype (value)>::max_digits10;
57 const auto max_fractional_digits10 = max_digits10 - 1;
58
59 ss << std::scientific << std::setprecision(max_fractional_digits10) << value;
60 return ss.str();
61 }
62
RoundDouble(double v)63 int64_t RoundDouble(double v) { return static_cast<int64_t>(v + 0.5); }
64
65 } // end namespace
66
ReportContext(const Context & context)67 bool JSONReporter::ReportContext(const Context& context) {
68 std::ostream& out = GetOutputStream();
69
70 out << "{\n";
71 std::string inner_indent(2, ' ');
72
73 // Open context block and print context information.
74 out << inner_indent << "\"context\": {\n";
75 std::string indent(4, ' ');
76
77 std::string walltime_value = LocalDateTimeString();
78 out << indent << FormatKV("date", walltime_value) << ",\n";
79
80 if (Context::executable_name) {
81 out << indent << FormatKV("executable", Context::executable_name) << ",\n";
82 }
83
84 CPUInfo const& info = context.cpu_info;
85 out << indent << FormatKV("num_cpus", static_cast<int64_t>(info.num_cpus))
86 << ",\n";
87 out << indent
88 << FormatKV("mhz_per_cpu",
89 RoundDouble(info.cycles_per_second / 1000000.0))
90 << ",\n";
91 out << indent << FormatKV("cpu_scaling_enabled", info.scaling_enabled)
92 << ",\n";
93
94 out << indent << "\"caches\": [\n";
95 indent = std::string(6, ' ');
96 std::string cache_indent(8, ' ');
97 for (size_t i = 0; i < info.caches.size(); ++i) {
98 auto& CI = info.caches[i];
99 out << indent << "{\n";
100 out << cache_indent << FormatKV("type", CI.type) << ",\n";
101 out << cache_indent << FormatKV("level", static_cast<int64_t>(CI.level))
102 << ",\n";
103 out << cache_indent
104 << FormatKV("size", static_cast<int64_t>(CI.size) * 1000u) << ",\n";
105 out << cache_indent
106 << FormatKV("num_sharing", static_cast<int64_t>(CI.num_sharing))
107 << "\n";
108 out << indent << "}";
109 if (i != info.caches.size() - 1) out << ",";
110 out << "\n";
111 }
112 indent = std::string(4, ' ');
113 out << indent << "],\n";
114
115 #if defined(NDEBUG)
116 const char build_type[] = "release";
117 #else
118 const char build_type[] = "debug";
119 #endif
120 out << indent << FormatKV("library_build_type", build_type) << "\n";
121 // Close context block and open the list of benchmarks.
122 out << inner_indent << "},\n";
123 out << inner_indent << "\"benchmarks\": [\n";
124 return true;
125 }
126
ReportRuns(std::vector<Run> const & reports)127 void JSONReporter::ReportRuns(std::vector<Run> const& reports) {
128 if (reports.empty()) {
129 return;
130 }
131 std::string indent(4, ' ');
132 std::ostream& out = GetOutputStream();
133 if (!first_report_) {
134 out << ",\n";
135 }
136 first_report_ = false;
137
138 for (auto it = reports.begin(); it != reports.end(); ++it) {
139 out << indent << "{\n";
140 PrintRunData(*it);
141 out << indent << '}';
142 auto it_cp = it;
143 if (++it_cp != reports.end()) {
144 out << ",\n";
145 }
146 }
147 }
148
Finalize()149 void JSONReporter::Finalize() {
150 // Close the list of benchmarks and the top level object.
151 GetOutputStream() << "\n ]\n}\n";
152 }
153
PrintRunData(Run const & run)154 void JSONReporter::PrintRunData(Run const& run) {
155 std::string indent(6, ' ');
156 std::ostream& out = GetOutputStream();
157 out << indent << FormatKV("name", run.benchmark_name) << ",\n";
158 if (run.error_occurred) {
159 out << indent << FormatKV("error_occurred", run.error_occurred) << ",\n";
160 out << indent << FormatKV("error_message", run.error_message) << ",\n";
161 }
162 if (!run.report_big_o && !run.report_rms) {
163 out << indent << FormatKV("iterations", run.iterations) << ",\n";
164 out << indent
165 << FormatKV("real_time", run.GetAdjustedRealTime())
166 << ",\n";
167 out << indent
168 << FormatKV("cpu_time", run.GetAdjustedCPUTime());
169 out << ",\n"
170 << indent << FormatKV("time_unit", GetTimeUnitString(run.time_unit));
171 } else if (run.report_big_o) {
172 out << indent
173 << FormatKV("cpu_coefficient", run.GetAdjustedCPUTime())
174 << ",\n";
175 out << indent
176 << FormatKV("real_coefficient", run.GetAdjustedRealTime())
177 << ",\n";
178 out << indent << FormatKV("big_o", GetBigOString(run.complexity)) << ",\n";
179 out << indent << FormatKV("time_unit", GetTimeUnitString(run.time_unit));
180 } else if (run.report_rms) {
181 out << indent
182 << FormatKV("rms", run.GetAdjustedCPUTime());
183 }
184 if (run.bytes_per_second > 0.0) {
185 out << ",\n"
186 << indent
187 << FormatKV("bytes_per_second", run.bytes_per_second);
188 }
189 if (run.items_per_second > 0.0) {
190 out << ",\n"
191 << indent
192 << FormatKV("items_per_second", run.items_per_second);
193 }
194 for(auto &c : run.counters) {
195 out << ",\n"
196 << indent
197 << FormatKV(c.first, c.second);
198 }
199 if (!run.report_label.empty()) {
200 out << ",\n" << indent << FormatKV("label", run.report_label);
201 }
202 out << '\n';
203 }
204
205 } // end namespace benchmark
206