src/dawn/utils/WireHelper.h

// Copyright 2021 The Dawn & Tint Authors
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//
// 1. Redistributions of source code must retain the above copyright notice, this
//    list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright notice,
//    this list of conditions and the following disclaimer in the documentation
//    and/or other materials provided with the distribution.
//
// 3. Neither the name of the copyright holder nor the names of its
//    contributors may be used to endorse or promote products derived from
//    this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
// DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
// FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
// DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
// SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
// CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
// OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

#ifndef SRC_DAWN_UTILS_WIREHELPER_H_
#define SRC_DAWN_UTILS_WIREHELPER_H_

#include <webgpu/webgpu_cpp.h>

#include <cstdint>
#include <memory>
#include <utility>

struct DawnProcTable;

namespace dawn::native {
class Instance;
}  // namespace dawn::native

namespace dawn::utils {

class WireHelper {
  public:
    virtual ~WireHelper();

    // Registers the instance on the wire, if present.
    // Returns the wgpu::Instance which is the client instance on the wire (created with wireDesc),
    // and the backend instance without the wire.
    // The function should not take ownership of |backendInstance|.
    virtual wgpu::Instance RegisterInstance(WGPUInstance backendInstance,
                                            const WGPUInstanceDescriptor* wireDesc = nullptr) = 0;

    // Helper to created a native instance and automatically register it with the wire if needed.
    // Return the native instance and the same result as RegisterInstance.
    std::pair<wgpu::Instance, std::unique_ptr<dawn::native::Instance>> CreateInstances(
        const wgpu::InstanceDescriptor* nativeDesc = nullptr,
        const wgpu::InstanceDescriptor* wireDesc = nullptr);

    // Helper that returns a handle to the native Device.
    virtual WGPUDevice GetBackendDevice(const wgpu::Device& device) = 0;

    virtual void BeginWireTrace(const char* name) = 0;

    virtual bool FlushClient() = 0;
    virtual bool FlushServer() = 0;

    // Flushes the wire and all callbacks until idle.
    void WaitUntilIdle(dawn::native::Instance* serverInstance,
                       wgpu::Instance clientInstance = nullptr);

    virtual bool IsIdle() = 0;
};

std::unique_ptr<WireHelper> CreateWireHelper(const DawnProcTable& procs,
                                             bool useWire,
                                             const char* wireTraceDir = nullptr);

}  // namespace dawn::utils

#endif  // SRC_DAWN_UTILS_WIREHELPER_H_