reporter.h revision 6429348e0d986315d95a0582eb8f57a6a4488ac1
14242f2f1d73d7800d95cfc2af0f3a3513dad2dc5Eric Fiselier// Copyright 2015 Google Inc. All rights reserved. 24242f2f1d73d7800d95cfc2af0f3a3513dad2dc5Eric Fiselier// 34242f2f1d73d7800d95cfc2af0f3a3513dad2dc5Eric Fiselier// Licensed under the Apache License, Version 2.0 (the "License"); 44242f2f1d73d7800d95cfc2af0f3a3513dad2dc5Eric Fiselier// you may not use this file except in compliance with the License. 54242f2f1d73d7800d95cfc2af0f3a3513dad2dc5Eric Fiselier// You may obtain a copy of the License at 64242f2f1d73d7800d95cfc2af0f3a3513dad2dc5Eric Fiselier// 74242f2f1d73d7800d95cfc2af0f3a3513dad2dc5Eric Fiselier// http://www.apache.org/licenses/LICENSE-2.0 84242f2f1d73d7800d95cfc2af0f3a3513dad2dc5Eric Fiselier// 94242f2f1d73d7800d95cfc2af0f3a3513dad2dc5Eric Fiselier// Unless required by applicable law or agreed to in writing, software 104242f2f1d73d7800d95cfc2af0f3a3513dad2dc5Eric Fiselier// distributed under the License is distributed on an "AS IS" BASIS, 114242f2f1d73d7800d95cfc2af0f3a3513dad2dc5Eric Fiselier// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 124242f2f1d73d7800d95cfc2af0f3a3513dad2dc5Eric Fiselier// See the License for the specific language governing permissions and 134242f2f1d73d7800d95cfc2af0f3a3513dad2dc5Eric Fiselier// limitations under the License. 144242f2f1d73d7800d95cfc2af0f3a3513dad2dc5Eric Fiselier#ifndef BENCHMARK_REPORTER_H_ 154242f2f1d73d7800d95cfc2af0f3a3513dad2dc5Eric Fiselier#define BENCHMARK_REPORTER_H_ 164242f2f1d73d7800d95cfc2af0f3a3513dad2dc5Eric Fiselier 174242f2f1d73d7800d95cfc2af0f3a3513dad2dc5Eric Fiselier#include <string> 184242f2f1d73d7800d95cfc2af0f3a3513dad2dc5Eric Fiselier#include <utility> 194242f2f1d73d7800d95cfc2af0f3a3513dad2dc5Eric Fiselier#include <vector> 204242f2f1d73d7800d95cfc2af0f3a3513dad2dc5Eric Fiselier 218e72846da4bde9cdc8162ac99ce4168c65154f7dEric Fiselier#include "benchmark_api.h" // For forward declaration of BenchmarkReporter 22df904a1980b148139e566028dad27e3bea828afdEric Fiselier 234242f2f1d73d7800d95cfc2af0f3a3513dad2dc5Eric Fiseliernamespace benchmark { 244242f2f1d73d7800d95cfc2af0f3a3513dad2dc5Eric Fiselier 254242f2f1d73d7800d95cfc2af0f3a3513dad2dc5Eric Fiselier// Interface for custom benchmark result printers. 264242f2f1d73d7800d95cfc2af0f3a3513dad2dc5Eric Fiselier// By default, benchmark reports are printed to stdout. However an application 274242f2f1d73d7800d95cfc2af0f3a3513dad2dc5Eric Fiselier// can control the destination of the reports by calling 284242f2f1d73d7800d95cfc2af0f3a3513dad2dc5Eric Fiselier// RunSpecifiedBenchmarks and passing it a custom reporter object. 294242f2f1d73d7800d95cfc2af0f3a3513dad2dc5Eric Fiselier// The reporter object must implement the following interface. 304242f2f1d73d7800d95cfc2af0f3a3513dad2dc5Eric Fiselierclass BenchmarkReporter { 314242f2f1d73d7800d95cfc2af0f3a3513dad2dc5Eric Fiselier public: 324242f2f1d73d7800d95cfc2af0f3a3513dad2dc5Eric Fiselier struct Context { 334242f2f1d73d7800d95cfc2af0f3a3513dad2dc5Eric Fiselier int num_cpus; 344242f2f1d73d7800d95cfc2af0f3a3513dad2dc5Eric Fiselier double mhz_per_cpu; 354242f2f1d73d7800d95cfc2af0f3a3513dad2dc5Eric Fiselier bool cpu_scaling_enabled; 364242f2f1d73d7800d95cfc2af0f3a3513dad2dc5Eric Fiselier 374242f2f1d73d7800d95cfc2af0f3a3513dad2dc5Eric Fiselier // The number of chars in the longest benchmark name. 384242f2f1d73d7800d95cfc2af0f3a3513dad2dc5Eric Fiselier size_t name_field_width; 394242f2f1d73d7800d95cfc2af0f3a3513dad2dc5Eric Fiselier }; 404242f2f1d73d7800d95cfc2af0f3a3513dad2dc5Eric Fiselier 414242f2f1d73d7800d95cfc2af0f3a3513dad2dc5Eric Fiselier struct Run { 424242f2f1d73d7800d95cfc2af0f3a3513dad2dc5Eric Fiselier Run() : 434242f2f1d73d7800d95cfc2af0f3a3513dad2dc5Eric Fiselier iterations(1), 444242f2f1d73d7800d95cfc2af0f3a3513dad2dc5Eric Fiselier real_accumulated_time(0), 454242f2f1d73d7800d95cfc2af0f3a3513dad2dc5Eric Fiselier cpu_accumulated_time(0), 464242f2f1d73d7800d95cfc2af0f3a3513dad2dc5Eric Fiselier bytes_per_second(0), 474242f2f1d73d7800d95cfc2af0f3a3513dad2dc5Eric Fiselier items_per_second(0), 484242f2f1d73d7800d95cfc2af0f3a3513dad2dc5Eric Fiselier max_heapbytes_used(0) {} 494242f2f1d73d7800d95cfc2af0f3a3513dad2dc5Eric Fiselier 504242f2f1d73d7800d95cfc2af0f3a3513dad2dc5Eric Fiselier std::string benchmark_name; 514242f2f1d73d7800d95cfc2af0f3a3513dad2dc5Eric Fiselier std::string report_label; // Empty if not set by benchmark. 524242f2f1d73d7800d95cfc2af0f3a3513dad2dc5Eric Fiselier size_t iterations; 534242f2f1d73d7800d95cfc2af0f3a3513dad2dc5Eric Fiselier double real_accumulated_time; 544242f2f1d73d7800d95cfc2af0f3a3513dad2dc5Eric Fiselier double cpu_accumulated_time; 554242f2f1d73d7800d95cfc2af0f3a3513dad2dc5Eric Fiselier 564242f2f1d73d7800d95cfc2af0f3a3513dad2dc5Eric Fiselier // Zero if not set by benchmark. 574242f2f1d73d7800d95cfc2af0f3a3513dad2dc5Eric Fiselier double bytes_per_second; 584242f2f1d73d7800d95cfc2af0f3a3513dad2dc5Eric Fiselier double items_per_second; 594242f2f1d73d7800d95cfc2af0f3a3513dad2dc5Eric Fiselier 604242f2f1d73d7800d95cfc2af0f3a3513dad2dc5Eric Fiselier // This is set to 0.0 if memory tracing is not enabled. 614242f2f1d73d7800d95cfc2af0f3a3513dad2dc5Eric Fiselier double max_heapbytes_used; 624242f2f1d73d7800d95cfc2af0f3a3513dad2dc5Eric Fiselier }; 634242f2f1d73d7800d95cfc2af0f3a3513dad2dc5Eric Fiselier 644242f2f1d73d7800d95cfc2af0f3a3513dad2dc5Eric Fiselier // Called once for every suite of benchmarks run. 654242f2f1d73d7800d95cfc2af0f3a3513dad2dc5Eric Fiselier // The parameter "context" contains information that the 664242f2f1d73d7800d95cfc2af0f3a3513dad2dc5Eric Fiselier // reporter may wish to use when generating its report, for example the 674242f2f1d73d7800d95cfc2af0f3a3513dad2dc5Eric Fiselier // platform under which the benchmarks are running. The benchmark run is 684242f2f1d73d7800d95cfc2af0f3a3513dad2dc5Eric Fiselier // never started if this function returns false, allowing the reporter 694242f2f1d73d7800d95cfc2af0f3a3513dad2dc5Eric Fiselier // to skip runs based on the context information. 7020f1c0e2a8e692076dd7a5586f73ab8e2d726c12Eric Fiselier virtual bool ReportContext(const Context& context) = 0; 714242f2f1d73d7800d95cfc2af0f3a3513dad2dc5Eric Fiselier 724242f2f1d73d7800d95cfc2af0f3a3513dad2dc5Eric Fiselier // Called once for each group of benchmark runs, gives information about 734242f2f1d73d7800d95cfc2af0f3a3513dad2dc5Eric Fiselier // cpu-time and heap memory usage during the benchmark run. 744242f2f1d73d7800d95cfc2af0f3a3513dad2dc5Eric Fiselier // Note that all the grouped benchmark runs should refer to the same 754242f2f1d73d7800d95cfc2af0f3a3513dad2dc5Eric Fiselier // benchmark, thus have the same name. 7620f1c0e2a8e692076dd7a5586f73ab8e2d726c12Eric Fiselier virtual void ReportRuns(const std::vector<Run>& report) = 0; 7720f1c0e2a8e692076dd7a5586f73ab8e2d726c12Eric Fiselier 7820f1c0e2a8e692076dd7a5586f73ab8e2d726c12Eric Fiselier // Called once and only once after ever group of benchmarks is run and 7920f1c0e2a8e692076dd7a5586f73ab8e2d726c12Eric Fiselier // reported. 8020f1c0e2a8e692076dd7a5586f73ab8e2d726c12Eric Fiselier virtual void Finalize(); 814242f2f1d73d7800d95cfc2af0f3a3513dad2dc5Eric Fiselier 824242f2f1d73d7800d95cfc2af0f3a3513dad2dc5Eric Fiselier virtual ~BenchmarkReporter(); 836429348e0d986315d95a0582eb8f57a6a4488ac1Eric Fiselierprotected: 846429348e0d986315d95a0582eb8f57a6a4488ac1Eric Fiselier static void ComputeStats(std::vector<Run> const& reports, Run* mean, Run* stddev); 854242f2f1d73d7800d95cfc2af0f3a3513dad2dc5Eric Fiselier}; 864242f2f1d73d7800d95cfc2af0f3a3513dad2dc5Eric Fiselier 874242f2f1d73d7800d95cfc2af0f3a3513dad2dc5Eric Fiselier// Simple reporter that outputs benchmark data to the console. This is the 884242f2f1d73d7800d95cfc2af0f3a3513dad2dc5Eric Fiselier// default reporter used by RunSpecifiedBenchmarks(). 894242f2f1d73d7800d95cfc2af0f3a3513dad2dc5Eric Fiselierclass ConsoleReporter : public BenchmarkReporter { 904242f2f1d73d7800d95cfc2af0f3a3513dad2dc5Eric Fiselier public: 9120f1c0e2a8e692076dd7a5586f73ab8e2d726c12Eric Fiselier virtual bool ReportContext(const Context& context); 9220f1c0e2a8e692076dd7a5586f73ab8e2d726c12Eric Fiselier virtual void ReportRuns(const std::vector<Run>& reports); 93f65da9d58165c6ab626d6a55b9d47968510c72aeEric Fiselierprotected: 9420f1c0e2a8e692076dd7a5586f73ab8e2d726c12Eric Fiselier virtual void PrintRunData(const Run& report); 9520f1c0e2a8e692076dd7a5586f73ab8e2d726c12Eric Fiselier 9620f1c0e2a8e692076dd7a5586f73ab8e2d726c12Eric Fiselier size_t name_field_width_; 974242f2f1d73d7800d95cfc2af0f3a3513dad2dc5Eric Fiselier}; 984242f2f1d73d7800d95cfc2af0f3a3513dad2dc5Eric Fiselier 99f65da9d58165c6ab626d6a55b9d47968510c72aeEric Fiselierclass JSONReporter : public BenchmarkReporter { 100f65da9d58165c6ab626d6a55b9d47968510c72aeEric Fiselierpublic: 101f65da9d58165c6ab626d6a55b9d47968510c72aeEric Fiselier JSONReporter() : first_report_(true) {} 102f65da9d58165c6ab626d6a55b9d47968510c72aeEric Fiselier virtual bool ReportContext(const Context& context); 103f65da9d58165c6ab626d6a55b9d47968510c72aeEric Fiselier virtual void ReportRuns(const std::vector<Run>& reports); 104f65da9d58165c6ab626d6a55b9d47968510c72aeEric Fiselier virtual void Finalize(); 105f65da9d58165c6ab626d6a55b9d47968510c72aeEric Fiselier 106f65da9d58165c6ab626d6a55b9d47968510c72aeEric Fiselierprivate: 107f65da9d58165c6ab626d6a55b9d47968510c72aeEric Fiselier void PrintRunData(const Run& report); 108f65da9d58165c6ab626d6a55b9d47968510c72aeEric Fiselier 109f65da9d58165c6ab626d6a55b9d47968510c72aeEric Fiselier bool first_report_; 110f65da9d58165c6ab626d6a55b9d47968510c72aeEric Fiselier}; 111f65da9d58165c6ab626d6a55b9d47968510c72aeEric Fiselier 1124242f2f1d73d7800d95cfc2af0f3a3513dad2dc5Eric Fiselier} // end namespace benchmark 1134242f2f1d73d7800d95cfc2af0f3a3513dad2dc5Eric Fiselier#endif // BENCHMARK_REPORTER_H_ 114