src/dawn/native/opengl/SharedFenceEGL.cpp

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

#include "dawn/native/opengl/SharedFenceEGL.h"

#include <utility>

#include "dawn/native/ChainUtils.h"
#include "dawn/native/opengl/DeviceGL.h"
#include "dawn/native/opengl/DisplayEGL.h"
#include "dawn/native/opengl/EGLFunctions.h"
#include "dawn/native/opengl/PhysicalDeviceGL.h"
#include "dawn/utils/SystemHandle.h"

namespace dawn::native::opengl {
ResultOrError<Ref<SharedFence>> SharedFenceEGL::Create(
    Device* device,
    StringView label,
    const SharedFenceSyncFDDescriptor* descriptor) {
#if DAWN_PLATFORM_IS(POSIX)
    DAWN_INVALID_IF(descriptor->handle < 0, "File descriptor (%d) was invalid.",
                    descriptor->handle);

    utils::SystemHandle handleForSyncCreation = utils::SystemHandle::Duplicate(descriptor->handle);

    const EGLint attribs[] = {
        EGL_SYNC_NATIVE_FENCE_FD_ANDROID,
        handleForSyncCreation.Get(),
        EGL_NONE,
    };

    return device->ExecuteGL(
        ExecutionQueueBase::SubmitMode::Passive,
        [&](const OpenGLFunctions& gl) -> ResultOrError<Ref<SharedFence>> {
            DisplayEGL* display = ToBackend(device->GetPhysicalDevice())->GetDisplay();
            Ref<WrappedEGLSync> sync;
            EGLint fdForSharedFence;

            DAWN_TRY_ASSIGN(
                sync, WrappedEGLSync::Create(display, gl, EGL_SYNC_NATIVE_FENCE_ANDROID, attribs));

            // If EGLSync creation succeeded, the sync now owns the handle.
            handleForSyncCreation.Detach();

            DAWN_TRY_ASSIGN(fdForSharedFence, sync->DupFD(gl));

            auto fence = AcquireRef(
                new SharedFenceEGL(device, label, wgpu::SharedFenceType::SyncFD,
                                   utils::SystemHandle::Acquire(fdForSharedFence), sync));
            return fence;
        });

#else
    DAWN_UNREACHABLE();
#endif
}

ResultOrError<Ref<SharedFence>> SharedFenceEGL::Create(
    Device* device,
    StringView label,
    const SharedFenceEGLSyncDescriptor* descriptor) {
    DAWN_INVALID_IF(descriptor->sync == EGL_NO_SYNC, "EGLSync is null.");

    DisplayEGL* display = ToBackend(device->GetPhysicalDevice())->GetDisplay();

    Ref<WrappedEGLSync> sync;
    DAWN_TRY_ASSIGN(sync, WrappedEGLSync::AcquireExternal(display, descriptor->sync));

    auto fence = AcquireRef(new SharedFenceEGL(device, label, wgpu::SharedFenceType::EGLSync,
                                               utils::SystemHandle(), sync));
    return fence;
}

SharedFenceEGL::SharedFenceEGL(Device* device,
                               StringView label,
                               wgpu::SharedFenceType type,
                               utils::SystemHandle&& handle,
                               Ref<WrappedEGLSync> sync)
    : SharedFence(device, label), mType(type), mHandle(std::move(handle)), mSync(sync) {}

MaybeError SharedFenceEGL::ServerWait(uint64_t signaledValue) {
    // All GL sync objects are binary, this should be validated at SharedTextureMemory::BeginAccess.
    DAWN_ASSERT(signaledValue == 1);

    Device* device = ToBackend(GetDevice());
    Ref<WrappedEGLSync> sync = mSync;
    return device->EnqueueGL([sync](const OpenGLFunctions& gl) -> MaybeError {
        DAWN_TRY(sync->Wait(gl));
        return {};
    });
}

MaybeError SharedFenceEGL::ExportInfoImpl(UnpackedPtr<SharedFenceExportInfo>& info) const {
    info->type = mType;

    switch (mType) {
#if DAWN_PLATFORM_IS(POSIX)
        case wgpu::SharedFenceType::SyncFD:
            DAWN_TRY(info.ValidateSubset<SharedFenceSyncFDExportInfo>());
            {
                SharedFenceSyncFDExportInfo* exportInfo = info.Get<SharedFenceSyncFDExportInfo>();
                if (exportInfo != nullptr) {
                    DAWN_ASSERT(mHandle.IsValid());
                    exportInfo->handle = mHandle.Get();
                }
            }
            break;
#endif

        case wgpu::SharedFenceType::EGLSync:
            DAWN_TRY(info.ValidateSubset<SharedFenceEGLSyncExportInfo>());
            {
                SharedFenceEGLSyncExportInfo* exportInfo = info.Get<SharedFenceEGLSyncExportInfo>();
                if (exportInfo != nullptr) {
                    exportInfo->sync = mSync->Get();
                }
            }
            break;

        default:
            DAWN_UNREACHABLE();
    }

    return {};
}

}  // namespace dawn::native::opengl