src/dawn_native/Fence.h

// 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.

#ifndef DAWNNATIVE_FENCE_H_
#define DAWNNATIVE_FENCE_H_

#include "common/SerialMap.h"
#include "dawn_native/Error.h"
#include "dawn_native/Forward.h"
#include "dawn_native/IntegerTypes.h"
#include "dawn_native/ObjectBase.h"

#include "dawn_native/dawn_platform.h"

#include <map>

namespace dawn_native {

    MaybeError ValidateFenceDescriptor(const FenceDescriptor* descriptor);

    class Fence final : public ObjectBase {
      public:
        Fence(QueueBase* queue, const FenceDescriptor* descriptor);

        static Fence* MakeError(DeviceBase* device);

        FenceAPISerial GetSignaledValue() const;
        const QueueBase* GetQueue() const;

        // Dawn API
        uint64_t APIGetCompletedValue() const;
        void APIOnCompletion(uint64_t value,
                             wgpu::FenceOnCompletionCallback callback,
                             void* userdata);

      protected:
        friend class QueueBase;
        friend struct FenceInFlight;
        void SetSignaledValue(FenceAPISerial signalValue);
        void SetCompletedValue(FenceAPISerial completedValue, WGPUFenceCompletionStatus status);
        void UpdateFenceOnComplete(Fence* fence, FenceAPISerial value);

      private:
        Fence(DeviceBase* device, ObjectBase::ErrorTag tag);
        ~Fence() override;

        MaybeError ValidateOnCompletion(FenceAPISerial value,
                                        WGPUFenceCompletionStatus* status) const;

        struct OnCompletionData {
            wgpu::FenceOnCompletionCallback completionCallback = nullptr;
            void* userdata = nullptr;
        };

        FenceAPISerial mSignalValue;
        FenceAPISerial mCompletedValue;
        Ref<QueueBase> mQueue;
        SerialMap<FenceAPISerial, OnCompletionData> mRequests;
    };

}  // namespace dawn_native

#endif  // DAWNNATIVE_FENCE_H_