2018-10-15 05:54:30 -07:00
|
|
|
// 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.
|
|
|
|
|
2022-04-11 11:30:50 -07:00
|
|
|
#ifndef SRC_DAWN_NATIVE_OBJECTBASE_H_
|
|
|
|
#define SRC_DAWN_NATIVE_OBJECTBASE_H_
|
2018-10-15 05:54:30 -07:00
|
|
|
|
2022-09-15 14:06:51 -07:00
|
|
|
#include <mutex>
|
2022-04-19 13:38:44 -07:00
|
|
|
#include <string>
|
|
|
|
|
2022-02-04 04:51:25 -08:00
|
|
|
#include "dawn/common/LinkedList.h"
|
|
|
|
#include "dawn/common/RefCounted.h"
|
2022-02-04 09:07:46 -08:00
|
|
|
#include "dawn/native/Forward.h"
|
2018-10-15 05:54:30 -07:00
|
|
|
|
2023-04-26 14:19:29 -07:00
|
|
|
namespace absl {
|
|
|
|
class FormatSink;
|
|
|
|
}
|
|
|
|
|
2022-01-12 01:17:35 -08:00
|
|
|
namespace dawn::native {
|
2018-10-15 05:54:30 -07:00
|
|
|
|
2022-09-15 14:06:51 -07:00
|
|
|
class ApiObjectBase;
|
2022-05-01 07:40:55 -07:00
|
|
|
class DeviceBase;
|
|
|
|
|
2022-05-31 13:55:39 -07:00
|
|
|
class ErrorMonad : public RefCounted {
|
2022-05-01 07:40:55 -07:00
|
|
|
public:
|
|
|
|
struct ErrorTag {};
|
|
|
|
static constexpr ErrorTag kError = {};
|
|
|
|
|
2022-05-31 13:55:39 -07:00
|
|
|
ErrorMonad();
|
|
|
|
explicit ErrorMonad(ErrorTag tag);
|
|
|
|
|
|
|
|
bool IsError() const;
|
|
|
|
};
|
|
|
|
|
|
|
|
class ObjectBase : public ErrorMonad {
|
|
|
|
public:
|
2022-05-01 07:40:55 -07:00
|
|
|
explicit ObjectBase(DeviceBase* device);
|
|
|
|
ObjectBase(DeviceBase* device, ErrorTag tag);
|
|
|
|
|
|
|
|
DeviceBase* GetDevice() const;
|
|
|
|
|
|
|
|
private:
|
2022-05-20 09:57:01 -07:00
|
|
|
// Ref to owning device.
|
|
|
|
Ref<DeviceBase> mDevice;
|
2022-05-01 07:40:55 -07:00
|
|
|
};
|
|
|
|
|
2022-09-15 14:06:51 -07:00
|
|
|
// Generic object list with a mutex for tracking for destruction.
|
|
|
|
class ApiObjectList {
|
|
|
|
public:
|
|
|
|
// Tracks an object if the list is not destroyed. If the list is destroyed, destroys the object.
|
|
|
|
void Track(ApiObjectBase* object);
|
|
|
|
|
|
|
|
// Returns true iff the object was removed from the list.
|
|
|
|
bool Untrack(ApiObjectBase* object);
|
|
|
|
|
|
|
|
// Destroys and removes all the objects tracked in the list.
|
|
|
|
void Destroy();
|
|
|
|
|
|
|
|
private:
|
|
|
|
// Boolean used to mark the list so that on subsequent calls to Untrack, we don't need to
|
|
|
|
// reaquire the lock, and Track on new objects immediately destroys them.
|
|
|
|
bool mMarkedDestroyed = false;
|
|
|
|
std::mutex mMutex;
|
|
|
|
LinkedList<ApiObjectBase> mObjects;
|
|
|
|
};
|
|
|
|
|
2022-05-01 07:40:55 -07:00
|
|
|
class ApiObjectBase : public ObjectBase, public LinkNode<ApiObjectBase> {
|
|
|
|
public:
|
|
|
|
struct LabelNotImplementedTag {};
|
|
|
|
static constexpr LabelNotImplementedTag kLabelNotImplemented = {};
|
|
|
|
struct UntrackedByDeviceTag {};
|
|
|
|
static constexpr UntrackedByDeviceTag kUntrackedByDevice = {};
|
|
|
|
|
|
|
|
ApiObjectBase(DeviceBase* device, LabelNotImplementedTag tag);
|
|
|
|
ApiObjectBase(DeviceBase* device, const char* label);
|
2023-04-20 16:35:14 -07:00
|
|
|
ApiObjectBase(DeviceBase* device, ErrorTag tag, const char* label = nullptr);
|
2022-05-01 07:40:55 -07:00
|
|
|
~ApiObjectBase() override;
|
|
|
|
|
|
|
|
virtual ObjectType GetType() const = 0;
|
2023-05-26 03:32:17 -07:00
|
|
|
void SetLabel(std::string label);
|
2022-05-01 07:40:55 -07:00
|
|
|
const std::string& GetLabel() const;
|
|
|
|
|
2023-04-26 14:19:29 -07:00
|
|
|
virtual void FormatLabel(absl::FormatSink* s) const;
|
|
|
|
|
2022-05-01 07:40:55 -07:00
|
|
|
// The ApiObjectBase is considered alive if it is tracked in a respective linked list owned
|
|
|
|
// by the owning device.
|
|
|
|
bool IsAlive() const;
|
|
|
|
|
|
|
|
// This needs to be public because it can be called from the device owning the object.
|
|
|
|
void Destroy();
|
|
|
|
|
|
|
|
// Dawn API
|
|
|
|
void APISetLabel(const char* label);
|
2023-04-24 10:33:37 -07:00
|
|
|
void APIRelease();
|
2022-05-01 07:40:55 -07:00
|
|
|
|
|
|
|
protected:
|
|
|
|
// Overriding of the RefCounted's DeleteThis function ensures that instances of objects
|
|
|
|
// always call their derived class implementation of Destroy prior to the derived
|
|
|
|
// class being destroyed. This guarantees that when ApiObjects' reference counts drop to 0,
|
|
|
|
// then the underlying backend's Destroy calls are executed. We cannot naively put the call
|
|
|
|
// to Destroy in the destructor of this class because it calls DestroyImpl
|
|
|
|
// which is a virtual function often implemented in the Derived class which would already
|
|
|
|
// have been destroyed by the time ApiObject's destructor is called by C++'s destruction
|
|
|
|
// order. Note that some classes like BindGroup may override the DeleteThis function again,
|
|
|
|
// and they should ensure that their overriding versions call this underlying version
|
|
|
|
// somewhere.
|
|
|
|
void DeleteThis() override;
|
2023-04-05 12:35:07 -07:00
|
|
|
void LockAndDeleteThis() override;
|
2022-09-15 14:06:51 -07:00
|
|
|
|
|
|
|
// Returns the list where this object may be tracked for future destruction. This can be
|
|
|
|
// overrided to create hierarchical object tracking ownership:
|
|
|
|
// i.e. Device -[tracks]-> Texture -[tracks]-> TextureView.
|
|
|
|
virtual ApiObjectList* GetObjectTrackingList();
|
2022-05-01 07:40:55 -07:00
|
|
|
|
|
|
|
// Sub-classes may override this function multiple times. Whenever overriding this function,
|
|
|
|
// however, users should be sure to call their parent's version in the new override to make
|
|
|
|
// sure that all destroy functionality is kept. This function is guaranteed to only be
|
|
|
|
// called once through the exposed Destroy function.
|
|
|
|
virtual void DestroyImpl() = 0;
|
|
|
|
|
|
|
|
private:
|
2022-09-15 14:06:51 -07:00
|
|
|
friend class ApiObjectList;
|
|
|
|
|
2022-05-01 07:40:55 -07:00
|
|
|
virtual void SetLabelImpl();
|
|
|
|
|
|
|
|
std::string mLabel;
|
|
|
|
};
|
2018-10-15 05:54:30 -07:00
|
|
|
|
2022-01-12 01:17:35 -08:00
|
|
|
} // namespace dawn::native
|
2018-10-15 05:54:30 -07:00
|
|
|
|
2022-04-11 11:30:50 -07:00
|
|
|
#endif // SRC_DAWN_NATIVE_OBJECTBASE_H_
|