Hash :
6d0452b7
Author :
Date :
2022-08-10T13:34:29
Fix ANGLE_HAS_HISTOGRAMS following crrev.com/c/3817602 Bug: angleproject:7299 Change-Id: I1d6f97e61dfdbea04009cc08a17344a59e438e51 Reviewed-on: https://chromium-review.googlesource.com/c/angle/angle/+/3823618 Reviewed-by: Yuly Novikov <ynovikov@chromium.org> Commit-Queue: Roman Lavrov <romanl@google.com>
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319
//
// Copyright 2020 The ANGLE Project Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
//
// HistogramWriter:
// Helper class for writing histogram-json-set-format files to JSON.
#include "HistogramWriter.h"
#include "common/debug.h"
#include <rapidjson/document.h>
#if !ANGLE_HAS_HISTOGRAMS
# error "Must have histograms enabled"
#endif // !ANGLE_HAS_HISTOGRAMS
ANGLE_DISABLE_EXTRA_SEMI_WARNING
ANGLE_DISABLE_EXTRA_SEMI_STMT_WARNING
ANGLE_DISABLE_DESTRUCTOR_OVERRIDE_WARNING
ANGLE_DISABLE_SUGGEST_OVERRIDE_WARNINGS
#include "tracing/tracing/value/diagnostics/reserved_infos.h"
#include "tracing/tracing/value/histogram.h"
ANGLE_REENABLE_SUGGEST_OVERRIDE_WARNINGS
ANGLE_REENABLE_DESTRUCTOR_OVERRIDE_WARNING
ANGLE_REENABLE_EXTRA_SEMI_STMT_WARNING
ANGLE_REENABLE_EXTRA_SEMI_WARNING
namespace js = rapidjson;
namespace proto = catapult::tracing::tracing::proto;
namespace angle
{
namespace
{
std::string UnitAndDirectionToString(proto::UnitAndDirection unit)
{
std::stringstream strstr;
switch (unit.unit())
{
case proto::MS_BEST_FIT_FORMAT:
strstr << "msBestFitFormat";
break;
case proto::COUNT:
strstr << "count";
break;
case proto::SIZE_IN_BYTES:
strstr << "sizeInBytes";
break;
default:
UNREACHABLE();
strstr << "error";
break;
}
switch (unit.improvement_direction())
{
case proto::NOT_SPECIFIED:
break;
case proto::SMALLER_IS_BETTER:
strstr << "_smallerIsBetter";
break;
default:
UNREACHABLE();
break;
}
return strstr.str();
}
proto::UnitAndDirection StringToUnitAndDirection(const std::string &str)
{
proto::UnitAndDirection unitAndDirection;
if (str == "count")
{
unitAndDirection.set_improvement_direction(proto::NOT_SPECIFIED);
unitAndDirection.set_unit(proto::COUNT);
}
else if (str == "msBestFitFormat_smallerIsBetter")
{
unitAndDirection.set_improvement_direction(proto::SMALLER_IS_BETTER);
unitAndDirection.set_unit(proto::MS_BEST_FIT_FORMAT);
}
else if (str == "sizeInBytes_smallerIsBetter")
{
unitAndDirection.set_improvement_direction(proto::SMALLER_IS_BETTER);
unitAndDirection.set_unit(proto::SIZE_IN_BYTES);
}
else
{
UNREACHABLE();
}
return unitAndDirection;
}
} // namespace
HistogramWriter::HistogramWriter() = default;
HistogramWriter::~HistogramWriter() = default;
void HistogramWriter::addSample(const std::string &measurement,
const std::string &story,
double value,
const std::string &units)
{
std::string measurementAndStory = measurement + story;
if (mHistograms.count(measurementAndStory) == 0)
{
proto::UnitAndDirection unitAndDirection = StringToUnitAndDirection(units);
std::unique_ptr<catapult::HistogramBuilder> builder =
std::make_unique<catapult::HistogramBuilder>(measurement, unitAndDirection);
// Set all summary options as false - we don't want to generate metric_std, metric_count,
// and so on for all metrics.
builder->SetSummaryOptions(proto::SummaryOptions());
mHistograms[measurementAndStory] = std::move(builder);
proto::Diagnostic stories;
proto::GenericSet *genericSet = stories.mutable_generic_set();
genericSet->add_values(story);
mHistograms[measurementAndStory]->AddDiagnostic(catapult::kStoriesDiagnostic, stories);
}
mHistograms[measurementAndStory]->AddSample(value);
}
void HistogramWriter::getAsJSON(js::Document *doc) const
{
proto::HistogramSet histogramSet;
for (const auto &histogram : mHistograms)
{
std::unique_ptr<proto::Histogram> proto = histogram.second->toProto();
histogramSet.mutable_histograms()->AddAllocated(proto.release());
}
// Custom JSON serialization for histogram-json-set.
doc->SetArray();
js::Document::AllocatorType &allocator = doc->GetAllocator();
for (int histogramIndex = 0; histogramIndex < histogramSet.histograms_size(); ++histogramIndex)
{
const proto::Histogram &histogram = histogramSet.histograms(histogramIndex);
js::Value obj(js::kObjectType);
js::Value name(histogram.name(), allocator);
obj.AddMember("name", name, allocator);
js::Value description(histogram.description(), allocator);
obj.AddMember("description", description, allocator);
js::Value unitAndDirection(UnitAndDirectionToString(histogram.unit()), allocator);
obj.AddMember("unit", unitAndDirection, allocator);
if (histogram.has_diagnostics())
{
js::Value diags(js::kObjectType);
for (const auto &mapIter : histogram.diagnostics().diagnostic_map())
{
js::Value key(mapIter.first, allocator);
const proto::Diagnostic &diagnostic = mapIter.second;
if (!diagnostic.shared_diagnostic_guid().empty())
{
js::Value guid(diagnostic.shared_diagnostic_guid(), allocator);
diags.AddMember(key, guid, allocator);
}
else if (diagnostic.has_generic_set())
{
const proto::GenericSet genericSet = diagnostic.generic_set();
js::Value setObj(js::kObjectType);
setObj.AddMember("type", "GenericSet", allocator);
js::Value values(js::kArrayType);
for (const std::string &value : genericSet.values())
{
js::Value valueStr(value, allocator);
values.PushBack(valueStr, allocator);
}
setObj.AddMember("values", values, allocator);
diags.AddMember(key, setObj, allocator);
}
else
{
UNREACHABLE();
}
}
obj.AddMember("diagnostics", diags, allocator);
}
js::Value sampleValues(js::kArrayType);
for (int sampleIndex = 0; sampleIndex < histogram.sample_values_size(); ++sampleIndex)
{
js::Value sample(histogram.sample_values(sampleIndex));
sampleValues.PushBack(sample, allocator);
}
obj.AddMember("sampleValues", sampleValues, allocator);
js::Value maxNumSamplesValues(histogram.max_num_sample_values());
obj.AddMember("maxNumSamplesValues", maxNumSamplesValues, allocator);
if (histogram.has_bin_boundaries())
{
js::Value binBoundaries(js::kArrayType);
const proto::BinBoundaries &boundaries = histogram.bin_boundaries();
for (int binIndex = 0; binIndex < boundaries.bin_specs_size(); ++binIndex)
{
js::Value binSpec(boundaries.bin_specs(binIndex).bin_boundary());
binBoundaries.PushBack(binSpec, allocator);
}
obj.AddMember("binBoundaries", binBoundaries, allocator);
}
if (histogram.has_summary_options())
{
const proto::SummaryOptions &options = histogram.summary_options();
js::Value summary(js::kObjectType);
js::Value avg(options.avg());
js::Value count(options.count());
js::Value max(options.max());
js::Value min(options.min());
js::Value std(options.std());
js::Value sum(options.sum());
summary.AddMember("avg", avg, allocator);
summary.AddMember("count", count, allocator);
summary.AddMember("max", max, allocator);
summary.AddMember("min", min, allocator);
summary.AddMember("std", std, allocator);
summary.AddMember("sum", sum, allocator);
obj.AddMember("summaryOptions", summary, allocator);
}
if (histogram.has_running())
{
const proto::RunningStatistics &running = histogram.running();
js::Value stats(js::kArrayType);
js::Value count(running.count());
js::Value max(running.max());
js::Value meanlogs(running.meanlogs());
js::Value mean(running.mean());
js::Value min(running.min());
js::Value sum(running.sum());
js::Value variance(running.variance());
stats.PushBack(count, allocator);
stats.PushBack(max, allocator);
stats.PushBack(meanlogs, allocator);
stats.PushBack(mean, allocator);
stats.PushBack(min, allocator);
stats.PushBack(sum, allocator);
stats.PushBack(variance, allocator);
obj.AddMember("running", stats, allocator);
}
doc->PushBack(obj, allocator);
}
for (const auto &diagnosticIt : histogramSet.shared_diagnostics())
{
const proto::Diagnostic &diagnostic = diagnosticIt.second;
js::Value obj(js::kObjectType);
js::Value name(diagnosticIt.first, allocator);
obj.AddMember("name", name, allocator);
switch (diagnostic.diagnostic_oneof_case())
{
case proto::Diagnostic::kGenericSet:
{
js::Value type("GenericSet", allocator);
obj.AddMember("type", type, allocator);
const proto::GenericSet &genericSet = diagnostic.generic_set();
js::Value values(js::kArrayType);
for (const std::string &value : genericSet.values())
{
js::Value valueStr(value, allocator);
values.PushBack(valueStr, allocator);
}
obj.AddMember("values", values, allocator);
break;
}
default:
UNREACHABLE();
}
doc->PushBack(obj, allocator);
}
}
} // namespace angle