mirror of
https://github.com/encounter/dawn-cmake.git
synced 2025-05-15 03:41:34 +00:00
69c68d01b2
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>
112 lines
4.0 KiB
C++
112 lines
4.0 KiB
C++
// 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
|
|
//
|
|
// 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.
|
|
|
|
#ifndef DAWNNATIVE_ENCODINGCONTEXT_H_
|
|
#define DAWNNATIVE_ENCODINGCONTEXT_H_
|
|
|
|
#include "dawn_native/CommandAllocator.h"
|
|
#include "dawn_native/Error.h"
|
|
#include "dawn_native/ErrorData.h"
|
|
#include "dawn_native/PassResourceUsageTracker.h"
|
|
#include "dawn_native/dawn_platform.h"
|
|
|
|
#include <string>
|
|
|
|
namespace dawn_native {
|
|
|
|
class DeviceBase;
|
|
class ObjectBase;
|
|
|
|
// Base class for allocating/iterating commands.
|
|
// It performs error tracking as well as encoding state for render/compute passes.
|
|
class EncodingContext {
|
|
public:
|
|
EncodingContext(DeviceBase* device, const ObjectBase* initialEncoder);
|
|
~EncodingContext();
|
|
|
|
CommandIterator AcquireCommands();
|
|
CommandIterator* GetIterator();
|
|
|
|
// Functions to handle encoder errors
|
|
void HandleError(wgpu::ErrorType type, const char* message);
|
|
|
|
inline void ConsumeError(std::unique_ptr<ErrorData> error) {
|
|
HandleError(error->GetType(), error->GetMessage().c_str());
|
|
}
|
|
|
|
inline bool ConsumedError(MaybeError maybeError) {
|
|
if (DAWN_UNLIKELY(maybeError.IsError())) {
|
|
ConsumeError(maybeError.AcquireError());
|
|
return true;
|
|
}
|
|
return false;
|
|
}
|
|
|
|
template <typename EncodeFunction>
|
|
inline bool TryEncode(const ObjectBase* encoder, EncodeFunction&& encodeFunction) {
|
|
if (DAWN_UNLIKELY(encoder != mCurrentEncoder)) {
|
|
if (mCurrentEncoder != mTopLevelEncoder) {
|
|
// The top level encoder was used when a pass encoder was current.
|
|
HandleError(wgpu::ErrorType::Validation,
|
|
"Command cannot be recorded inside a pass");
|
|
} else {
|
|
HandleError(wgpu::ErrorType::Validation,
|
|
"Recording in an error or already ended pass encoder");
|
|
}
|
|
return false;
|
|
}
|
|
ASSERT(!mWasMovedToIterator);
|
|
return !ConsumedError(encodeFunction(&mAllocator));
|
|
}
|
|
|
|
// Functions to set current encoder state
|
|
void EnterPass(const ObjectBase* passEncoder);
|
|
void ExitPass(const ObjectBase* passEncoder, PassResourceUsage passUsages);
|
|
MaybeError Finish();
|
|
|
|
const PerPassUsages& GetPassUsages() const;
|
|
PerPassUsages AcquirePassUsages();
|
|
|
|
private:
|
|
bool IsFinished() const;
|
|
void MoveToIterator();
|
|
|
|
DeviceBase* mDevice;
|
|
|
|
// There can only be two levels of encoders. Top-level and render/compute pass.
|
|
// The top level encoder is the encoder the EncodingContext is created with.
|
|
// It doubles as flag to check if encoding has been Finished.
|
|
const ObjectBase* mTopLevelEncoder;
|
|
// The current encoder must be the same as the encoder provided to TryEncode,
|
|
// otherwise an error is produced. It may be nullptr if the EncodingContext is an error.
|
|
// The current encoder changes with Enter/ExitPass which should be called by
|
|
// CommandEncoder::Begin/EndPass.
|
|
const ObjectBase* mCurrentEncoder;
|
|
|
|
PerPassUsages mPassUsages;
|
|
bool mWerePassUsagesAcquired = false;
|
|
|
|
CommandAllocator mAllocator;
|
|
CommandIterator mIterator;
|
|
bool mWasMovedToIterator = false;
|
|
bool mWereCommandsAcquired = false;
|
|
|
|
bool mGotError = false;
|
|
std::string mErrorMessage;
|
|
};
|
|
|
|
} // namespace dawn_native
|
|
|
|
#endif // DAWNNATIVE_ENCODINGCONTEXT_H_
|