blob: 29330352278338c76f4fd68f05efa1e5d9d65b7d [file] [log] [blame]
// Copyright 2019 The Dawn Authors
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// See the License for the specific language governing permissions and
// limitations under the License.
#include "tests/perf_tests/DawnPerfTestPlatform.h"
#include <algorithm>
#include "common/Assert.h"
#include "common/HashUtils.h"
#include "dawn_platform/tracing/TraceEvent.h"
#include "tests/perf_tests/DawnPerfTest.h"
#include "utils/Timer.h"
namespace {
struct TraceCategoryInfo {
unsigned char enabled;
dawn_platform::TraceCategory category;
constexpr TraceCategoryInfo gTraceCategories[4] = {
{1, dawn_platform::TraceCategory::General},
{1, dawn_platform::TraceCategory::Validation},
{1, dawn_platform::TraceCategory::Recording},
{1, dawn_platform::TraceCategory::GPUWork},
static_assert(static_cast<uint32_t>(dawn_platform::TraceCategory::General) == 0, "");
static_assert(static_cast<uint32_t>(dawn_platform::TraceCategory::Validation) == 1, "");
static_assert(static_cast<uint32_t>(dawn_platform::TraceCategory::Recording) == 2, "");
static_assert(static_cast<uint32_t>(dawn_platform::TraceCategory::GPUWork) == 3, "");
} // anonymous namespace
: dawn_platform::Platform(), mTimer(utils::CreateTimer()) {
DawnPerfTestPlatform::~DawnPerfTestPlatform() = default;
const unsigned char* DawnPerfTestPlatform::GetTraceCategoryEnabledFlag(
dawn_platform::TraceCategory category) {
switch (category) {
case dawn_platform::TraceCategory::General:
case dawn_platform::TraceCategory::Validation:
case dawn_platform::TraceCategory::Recording:
case dawn_platform::TraceCategory::GPUWork:
return &gTraceCategories[static_cast<uint32_t>(category)].enabled;
double DawnPerfTestPlatform::MonotonicallyIncreasingTime() {
// Move the time origin to the first call to this function, to avoid generating
// unnecessarily large timestamps.
static double origin = mTimer->GetAbsoluteTime();
return mTimer->GetAbsoluteTime() - origin;
std::vector<DawnPerfTestPlatform::TraceEvent>* DawnPerfTestPlatform::GetLocalTraceEventBuffer() {
// Cache the pointer to the vector in thread_local storage
thread_local std::vector<TraceEvent>* traceEventBuffer = nullptr;
if (traceEventBuffer == nullptr) {
auto buffer = std::make_unique<std::vector<TraceEvent>>();
traceEventBuffer = buffer.get();
// Add a new buffer to the map
std::lock_guard<std::mutex> guard(mTraceEventBufferMapMutex);
mTraceEventBuffers[std::this_thread::get_id()] = std::move(buffer);
return traceEventBuffer;
// TODO(enga): Simplify this API.
uint64_t DawnPerfTestPlatform::AddTraceEvent(char phase,
const unsigned char* categoryGroupEnabled,
const char* name,
uint64_t id,
double timestamp,
int numArgs,
const char** argNames,
const unsigned char* argTypes,
const uint64_t* argValues,
unsigned char flags) {
if (!mRecordTraceEvents) {
return 0;
// Discover the category name based on categoryGroupEnabled. This flag comes from the first
// parameter of TraceCategory, and corresponds to one of the entries in gTraceCategories.
static_assert(offsetof(TraceCategoryInfo, enabled) == 0,
"|enabled| must be the first field of the TraceCategoryInfo class.");
const TraceCategoryInfo* info =
reinterpret_cast<const TraceCategoryInfo*>(categoryGroupEnabled);
std::vector<TraceEvent>* buffer = GetLocalTraceEventBuffer();
buffer->emplace_back(phase, info->category, name, id, timestamp);
size_t hash = 0;
HashCombine(&hash, buffer->size());
HashCombine(&hash, std::this_thread::get_id());
return static_cast<uint64_t>(hash);
void DawnPerfTestPlatform::EnableTraceEventRecording(bool enable) {
mRecordTraceEvents = enable;
std::vector<DawnPerfTestPlatform::TraceEvent> DawnPerfTestPlatform::AcquireTraceEventBuffer() {
std::vector<TraceEvent> traceEventBuffer;
// AcquireTraceEventBuffer should only be called when Dawn is completely idle. There should
// be no threads inserting trace events.
// Right now, this is safe because AcquireTraceEventBuffer is called after waiting on a
// fence for all GPU commands to finish executing. When Dawn has multiple background threads
// for other work (creation, validation, submission, residency, etc), we will need to ensure
// all work on those threads is stopped as well.
std::lock_guard<std::mutex> guard(mTraceEventBufferMapMutex);
for (auto it = mTraceEventBuffers.begin(); it != mTraceEventBuffers.end(); ++it) {
std::ostringstream stream;
stream << it->first;
std::string threadId = stream.str();
std::transform(it->second->begin(), it->second->end(),
std::back_inserter(traceEventBuffer), [&threadId](TraceEvent ev) {
ev.threadId = threadId;
return ev;
return traceEventBuffer;