dawn-cmake/src/dawn_native/ErrorData.cpp
Rafael Cintron 69c68d01b2 Improve Memory Management of Result class
The way in which the Result class is used in Dawn can be fragile
with respect to memory management because the caller of AcquireError
must know they need to delete the returned pointer or a memory leak
will occur. We've had a couple of instances where developers have
accidentally left out the delete call and managed to get past code
review.

This CL changes the Result class so that it assumes the error is
allocated on the heap and forces the caller to use unique_ptr when
calling AcquireError.

Bug:dawn:320
Change-Id: I13ec953b0c37eaafbd6ce93c2f719b4743676acb
Reviewed-on: https://dawn-review.googlesource.com/c/dawn/+/14960
Reviewed-by: Austin Eng <enga@chromium.org>
Reviewed-by: Corentin Wallez <cwallez@chromium.org>
Commit-Queue: Rafael Cintron <rafael.cintron@microsoft.com>
2020-01-10 17:58:28 +00:00

71 lines
2.4 KiB
C++

// Copyright 2018 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
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
#include "dawn_native/ErrorData.h"
#include "dawn_native/Error.h"
#include "dawn_native/dawn_platform.h"
namespace dawn_native {
std::unique_ptr<ErrorData> ErrorData::Create(InternalErrorType type,
std::string message,
const char* file,
const char* function,
int line) {
std::unique_ptr<ErrorData> error = std::make_unique<ErrorData>(type, message);
error->AppendBacktrace(file, function, line);
return error;
}
ErrorData::ErrorData(InternalErrorType type, std::string message)
: mType(type), mMessage(std::move(message)) {
}
void ErrorData::AppendBacktrace(const char* file, const char* function, int line) {
BacktraceRecord record;
record.file = file;
record.function = function;
record.line = line;
mBacktrace.push_back(std::move(record));
}
InternalErrorType ErrorData::GetInternalType() const {
return mType;
}
wgpu::ErrorType ErrorData::GetType() const {
switch (mType) {
case InternalErrorType::Validation:
return wgpu::ErrorType::Validation;
case InternalErrorType::OutOfMemory:
return wgpu::ErrorType::OutOfMemory;
case InternalErrorType::DeviceLost:
return wgpu::ErrorType::DeviceLost;
default:
return wgpu::ErrorType::Unknown;
}
}
const std::string& ErrorData::GetMessage() const {
return mMessage;
}
const std::vector<ErrorData::BacktraceRecord>& ErrorData::GetBacktrace() const {
return mBacktrace;
}
} // namespace dawn_native