// Copyright 2020 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 "src/dawn/wire/client/Queue.h"

#include <memory>
#include <string>
#include <utility>

#include "partition_alloc/pointers/raw_ptr.h"
#include "src/dawn/common/Atomic.h"
#include "src/dawn/common/StringViewUtils.h"
#include "src/dawn/wire/client/Client.h"
#include "src/dawn/wire/client/EventManager.h"
#include "src/utils/compiler.h"

namespace dawn::wire::client {
namespace {

// Buffer and Texture uploads larger than 4Mb use a different path optimized for larger transfers.
const uint64_t kWriteXLThreshold = 1024ULL * 1024 * 4;

class WorkDoneEvent : public TrackedEvent {
  public:
    static constexpr EventType kType = EventType::WorkDone;

    explicit WorkDoneEvent(const WGPUQueueWorkDoneCallbackInfo& callbackInfo)
        : TrackedEvent(callbackInfo.mode),
          mCallback(callbackInfo.callback),
          mUserdata1(callbackInfo.userdata1),
          mUserdata2(callbackInfo.userdata2) {}

    EventType GetType() override { return kType; }

    WireResult ReadyHook(FutureID futureID, wgpu::QueueWorkDoneStatus status, StringView message) {
        mStatus = status;
        mMessage = message;
        return WireResult::Success;
    }

  private:
    void CompleteImpl(FutureID futureID, EventCompletionType completionType) override {
        if (completionType == EventCompletionType::Shutdown) {
            mStatus = wgpu::QueueWorkDoneStatus::CallbackCancelled;
            mMessage = "A valid external Instance reference no longer exists.";
        }
        void* userdata1 = mUserdata1.ExtractAsDangling();
        void* userdata2 = mUserdata2.ExtractAsDangling();
        if (mCallback) {
            mCallback(ToAPI(mStatus), ToOutputStringView(mMessage), userdata1, userdata2);
        }
    }

    WGPUQueueWorkDoneCallback mCallback;
    raw_ptr<void> mUserdata1;
    raw_ptr<void> mUserdata2;

    wgpu::QueueWorkDoneStatus mStatus = wgpu::QueueWorkDoneStatus::Success;
    std::string mMessage;
};

}  // anonymous namespace

using MemoryHandleUse = MemoryTransferService::MemoryHandleUse;

Queue::~Queue() = default;

ObjectType Queue::GetObjectType() const {
    return ObjectType::Queue;
}

uint64_t Queue::GetLastSubmitIndex() const {
    return mLastSubmitIndex;
}

uint64_t Queue::GetCompletedSubmitIndex() const {
    return mCompletedSubmitIndex;
}

void Queue::APISubmit(Span<CommandBuffer* const> commands) {
    mLastSubmitIndex++;

    // Send the submit command
    QueueSubmitCmd cmd;
    cmd.self = ToAPI(this);
    cmd.commands = ToAPI(commands);
    GetClient()->SerializeCommand(std::move(cmd));

    // Immediately request a callback for OnSubmittedWorkDone to update mCompletedSubmitIndex before
    // any OnSubmittedWorkDone callbacks from the application.
    struct CallbackData {
        Ref<Queue> self;
        uint64_t submitIndex;
    };
    WGPUQueueWorkDoneCallbackInfo callback = {
        .nextInChain = nullptr,
        .mode = WGPUCallbackMode_AllowSpontaneous,
        .callback =
            [](WGPUQueueWorkDoneStatus status, WGPUStringView, void* userdata1, void* userdata2) {
                if (status != WGPUQueueWorkDoneStatus_Success) {
                    return;
                }

                std::unique_ptr<CallbackData> data(reinterpret_cast<CallbackData*>(userdata1));
                FetchMax(data->self->mCompletedSubmitIndex, data->submitIndex);
            },
        .userdata1 = new CallbackData{this, mLastSubmitIndex},
        .userdata2 = nullptr,
    };

    APIOnSubmittedWorkDone(callback);
}

WireResult Client::DoQueueWorkDoneCallback(ObjectId instanceId,
                                           Future future,
                                           wgpu::QueueWorkDoneStatus status,
                                           StringView message) {
    return SetFutureReady<WorkDoneEvent>(instanceId, future.id, status, message);
}

Future Queue::APIOnSubmittedWorkDone(const WGPUQueueWorkDoneCallbackInfo& callbackInfo) {
    // TODO(crbug.com/dawn/2052): Once we always return a future, change this to log to the instance
    // (note, not raise a validation error to the device) and return the null future.
    DAWN_ASSERT(callbackInfo.nextInChain == nullptr);

    Client* client = GetClient();
    auto [futureIDInternal, tracked] =
        GetEventManager().TrackEvent(AcquireRef(new WorkDoneEvent(callbackInfo)));
    if (!tracked) {
        return {futureIDInternal};
    }

    QueueOnSubmittedWorkDoneCmd cmd;
    cmd.queueId = GetWireHandle(client).id;
    cmd.instanceId = GetInstance()->GetWireHandle(client).id;
    cmd.future = {futureIDInternal};

    client->SerializeCommand(std::move(cmd));
    return {futureIDInternal};
}

void Queue::APIWriteBuffer(Buffer* buffer, uint64_t bufferOffset, Span<const std::byte> data) {
    if (data.size() >= kWriteXLThreshold) {
        WriteBufferXL(buffer, bufferOffset, data);
        return;
    }

    QueueWriteBufferCmd cmd;
    cmd.queueId = GetWireHandle(GetClient()).id;
    cmd.bufferId = buffer->GetWireHandle(GetClient()).id;
    cmd.bufferOffset = bufferOffset;
    cmd.data = data;

    GetClient()->SerializeCommand(std::move(cmd));
}

void Queue::WriteBufferXL(Buffer* buffer, uint64_t bufferOffset, Span<const std::byte> data) {
    Client* client = GetClient();

    // Create the MemoryHandle.
    auto memoryHandle = client->GetMemoryTransferService()->CreateMemoryHandle(
        data.size(), MemoryHandleUse::BulkData);
    if (memoryHandle == nullptr) {
        // There was an OOM that we cannot handle in WriteBuffer: trigger a device loss.
        client->Disconnect();
        return;
    }

    // Write the data to the allocated memory.
    Span<std::byte>(memoryHandle->GetData()).CopyFrom(data);

    QueueWriteBufferXlCmd cmd;
    cmd.queueId = GetWireHandle(client).id;
    cmd.bufferId = buffer->GetWireHandle(client).id;
    cmd.bufferOffset = bufferOffset;
    cmd.size = data.size();

    client->SerializeCommand(std::move(cmd),
                             // Extensions to replace fields skipped by skip_serialize.
                             CommandExtension<&QueueWriteBufferXlCmd::memoryHandleCreateInfo>{
                                 memoryHandle->GetSerializeCreateSize(),
                                 [&](Span<volatile std::byte> serializeBuffer) {
                                     memoryHandle->SerializeCreate(serializeBuffer);
                                 }},
                             CommandExtension<&QueueWriteBufferXlCmd::memoryDataUpdateInfo>{
                                 memoryHandle->GetSerializeDataUpdateSize(0u, data.size()),
                                 [&](Span<volatile std::byte> serializeBuffer) {
                                     memoryHandle->SerializeDataUpdate(serializeBuffer, 0u,
                                                                       data.size());
                                 }});
}

void Queue::APIWriteTexture(const TexelCopyTextureInfo* destination,
                            Span<const std::byte> data,
                            const TexelCopyBufferLayout* dataLayout,
                            const Extent3D* writeSize) {
    if (data.size() >= kWriteXLThreshold) {
        WriteTextureXL(destination, data, dataLayout, writeSize);
        return;
    }

    QueueWriteTextureCmd cmd;
    cmd.queueId = GetWireHandle(GetClient()).id;
    cmd.destination = ToWireCmd(destination);
    cmd.data = data;
    cmd.dataLayout = ToWireCmd(dataLayout);
    cmd.writeSize = ToWireCmd(writeSize);

    GetClient()->SerializeCommand(std::move(cmd));
}

void Queue::WriteTextureXL(const TexelCopyTextureInfo* destination,
                           Span<const std::byte> data,
                           const TexelCopyBufferLayout* dataLayout,
                           const Extent3D* writeSize) {
    Client* client = GetClient();

    // Create the MemoryHandle.
    auto memoryHandle = client->GetMemoryTransferService()->CreateMemoryHandle(
        data.size(), MemoryHandleUse::BulkData);
    if (memoryHandle == nullptr) {
        // There was an OOM that we cannot handle in WriteBuffer: trigger a device loss.
        client->Disconnect();
        return;
    }

    // Write the data to the allocated memory.
    Span<std::byte>(memoryHandle->GetData()).CopyFrom(data);

    QueueWriteTextureXlCmd cmd;
    cmd.queueId = GetWireHandle(GetClient()).id;
    cmd.destination = ToWireCmd(destination);
    cmd.dataSize = data.size();
    cmd.dataLayout = ToWireCmd(dataLayout);
    cmd.writeSize = ToWireCmd(writeSize);

    client->SerializeCommand(std::move(cmd),
                             // Extensions to replace fields skipped by skip_serialize.
                             CommandExtension<&QueueWriteTextureXlCmd::memoryHandleCreateInfo>{
                                 memoryHandle->GetSerializeCreateSize(),
                                 [&](Span<volatile std::byte> serializeBuffer) {
                                     memoryHandle->SerializeCreate(serializeBuffer);
                                 }},
                             CommandExtension<&QueueWriteTextureXlCmd::memoryDataUpdateInfo>{
                                 memoryHandle->GetSerializeDataUpdateSize(0u, data.size()),
                                 [&](Span<volatile std::byte> serializeBuffer) {
                                     memoryHandle->SerializeDataUpdate(serializeBuffer, 0u,
                                                                       data.size());
                                 }});
}

}  // namespace dawn::wire::client