| // Copyright 2019 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 DAWNWIRE_SERVER_SERVER_H_ |
| #define DAWNWIRE_SERVER_SERVER_H_ |
| |
| #include "dawn_wire/ChunkedCommandSerializer.h" |
| #include "dawn_wire/server/ServerBase_autogen.h" |
| |
| namespace dawn_wire { namespace server { |
| |
| class Server; |
| class MemoryTransferService; |
| |
| // CallbackUserdata and its derived classes are intended to be created by |
| // Server::MakeUserdata<T> and then passed as the userdata argument for Dawn |
| // callbacks. |
| // It contains a pointer back to the Server so that the callback can call the |
| // Server to perform operations like serialization, and it contains a weak pointer |
| // |serverIsAlive|. If the weak pointer has expired, it means the server has |
| // been destroyed and the callback must not use the Server pointer. |
| // To assist with checking |serverIsAlive| and lifetime management of the userdata, |
| // |ForwardToServer| (defined later in this file) can be used to acquire the userdata, |
| // return early if |serverIsAlive| has expired, and then forward the arguments |
| // to userdata->server->MyCallbackHandler. |
| // |
| // Example Usage: |
| // |
| // struct MyUserdata : CallbackUserdata { uint32_t foo; }; |
| // |
| // auto userdata = MakeUserdata<MyUserdata>(); |
| // userdata->foo = 2; |
| // |
| // // TODO(enga): Make the template inference for ForwardToServer cleaner with C++17 |
| // callMyCallbackHandler( |
| // ForwardToServer<decltype(&Server::MyCallbackHandler)>::Func< |
| // &Server::MyCallbackHandler>(), |
| // userdata.release()); |
| // |
| // void Server::MyCallbackHandler(MyUserdata* userdata) { } |
| struct CallbackUserdata { |
| Server* const server; |
| std::weak_ptr<bool> const serverIsAlive; |
| |
| CallbackUserdata() = delete; |
| CallbackUserdata(Server* server, const std::shared_ptr<bool>& serverIsAlive) |
| : server(server), serverIsAlive(serverIsAlive) { |
| } |
| }; |
| |
| template <typename F> |
| class ForwardToServer; |
| |
| template <typename R, typename... Args> |
| class ForwardToServer<R (Server::*)(Args...)> { |
| private: |
| // Get the type T of the last argument. It has CallbackUserdata as its base. |
| using UserdataT = typename std::remove_pointer<typename std::decay<decltype( |
| std::get<sizeof...(Args) - 1>(std::declval<std::tuple<Args...>>()))>::type>::type; |
| |
| static_assert(std::is_base_of<CallbackUserdata, UserdataT>::value, |
| "Last argument of callback handler should derive from CallbackUserdata."); |
| |
| template <class T, class... Ts> |
| struct UntypedCallbackImpl; |
| |
| template <std::size_t... I, class... Ts> |
| struct UntypedCallbackImpl<std::index_sequence<I...>, Ts...> { |
| template <R (Server::*Func)(Args...)> |
| static auto ForwardToServer( |
| // Unpack and forward the types of the parameter pack. |
| // Append void* as the last argument. |
| typename std::tuple_element<I, std::tuple<Ts...>>::type... args, |
| void* userdata) { |
| // Acquire the userdata, and cast it to UserdataT. |
| std::unique_ptr<UserdataT> data(static_cast<UserdataT*>(userdata)); |
| if (data->serverIsAlive.expired()) { |
| // Do nothing if the server has already been destroyed. |
| return; |
| } |
| // Forward the arguments and the typed userdata to the Server:: member function. |
| (data->server->*Func)(std::forward<decltype(args)>(args)..., data.get()); |
| } |
| }; |
| |
| // Generate a free function which has all of the same arguments, except the last |
| // userdata argument is void* instead of UserdataT*. Dawn's userdata args are void*. |
| using UntypedCallback = |
| UntypedCallbackImpl<std::make_index_sequence<sizeof...(Args) - 1>, Args...>; |
| |
| public: |
| template <R (Server::*F)(Args...)> |
| static auto Func() { |
| return UntypedCallback::template ForwardToServer<F>; |
| } |
| }; |
| |
| struct MapUserdata : CallbackUserdata { |
| using CallbackUserdata::CallbackUserdata; |
| |
| ObjectHandle buffer; |
| WGPUBuffer bufferObj; |
| uint64_t requestSerial; |
| uint64_t offset; |
| uint64_t size; |
| WGPUMapModeFlags mode; |
| }; |
| |
| struct ErrorScopeUserdata : CallbackUserdata { |
| using CallbackUserdata::CallbackUserdata; |
| |
| ObjectHandle device; |
| uint64_t requestSerial; |
| }; |
| |
| struct ShaderModuleGetCompilationInfoUserdata : CallbackUserdata { |
| using CallbackUserdata::CallbackUserdata; |
| |
| ObjectHandle shaderModule; |
| uint64_t requestSerial; |
| }; |
| |
| struct QueueWorkDoneUserdata : CallbackUserdata { |
| using CallbackUserdata::CallbackUserdata; |
| |
| ObjectHandle queue; |
| uint64_t requestSerial; |
| }; |
| |
| struct CreatePipelineAsyncUserData : CallbackUserdata { |
| using CallbackUserdata::CallbackUserdata; |
| |
| ObjectHandle device; |
| uint64_t requestSerial; |
| ObjectId pipelineObjectID; |
| }; |
| |
| class Server : public ServerBase { |
| public: |
| Server(const DawnProcTable& procs, |
| CommandSerializer* serializer, |
| MemoryTransferService* memoryTransferService); |
| ~Server() override; |
| |
| // ChunkedCommandHandler implementation |
| const volatile char* HandleCommandsImpl(const volatile char* commands, |
| size_t size) override; |
| |
| bool InjectTexture(WGPUTexture texture, |
| uint32_t id, |
| uint32_t generation, |
| uint32_t deviceId, |
| uint32_t deviceGeneration); |
| |
| bool InjectSwapChain(WGPUSwapChain swapchain, |
| uint32_t id, |
| uint32_t generation, |
| uint32_t deviceId, |
| uint32_t deviceGeneration); |
| |
| bool InjectDevice(WGPUDevice device, uint32_t id, uint32_t generation); |
| |
| WGPUDevice GetDevice(uint32_t id, uint32_t generation); |
| |
| template <typename T, |
| typename Enable = std::enable_if<std::is_base_of<CallbackUserdata, T>::value>> |
| std::unique_ptr<T> MakeUserdata() { |
| return std::unique_ptr<T>(new T(this, mIsAlive)); |
| } |
| |
| private: |
| template <typename Cmd> |
| void SerializeCommand(const Cmd& cmd) { |
| mSerializer.SerializeCommand(cmd); |
| } |
| |
| template <typename Cmd, typename ExtraSizeSerializeFn> |
| void SerializeCommand(const Cmd& cmd, |
| size_t extraSize, |
| ExtraSizeSerializeFn&& SerializeExtraSize) { |
| mSerializer.SerializeCommand(cmd, extraSize, SerializeExtraSize); |
| } |
| |
| void ClearDeviceCallbacks(WGPUDevice device); |
| |
| // Error callbacks |
| void OnUncapturedError(ObjectHandle device, WGPUErrorType type, const char* message); |
| void OnDeviceLost(ObjectHandle device, WGPUDeviceLostReason reason, const char* message); |
| void OnLogging(ObjectHandle device, WGPULoggingType type, const char* message); |
| void OnDevicePopErrorScope(WGPUErrorType type, |
| const char* message, |
| ErrorScopeUserdata* userdata); |
| void OnBufferMapAsyncCallback(WGPUBufferMapAsyncStatus status, MapUserdata* userdata); |
| void OnQueueWorkDone(WGPUQueueWorkDoneStatus status, QueueWorkDoneUserdata* userdata); |
| void OnCreateComputePipelineAsyncCallback(WGPUCreatePipelineAsyncStatus status, |
| WGPUComputePipeline pipeline, |
| const char* message, |
| CreatePipelineAsyncUserData* userdata); |
| void OnCreateRenderPipelineAsyncCallback(WGPUCreatePipelineAsyncStatus status, |
| WGPURenderPipeline pipeline, |
| const char* message, |
| CreatePipelineAsyncUserData* userdata); |
| void OnShaderModuleGetCompilationInfo(WGPUCompilationInfoRequestStatus status, |
| const WGPUCompilationInfo* info, |
| ShaderModuleGetCompilationInfoUserdata* userdata); |
| |
| #include "dawn_wire/server/ServerPrototypes_autogen.inc" |
| |
| WireDeserializeAllocator mAllocator; |
| ChunkedCommandSerializer mSerializer; |
| DawnProcTable mProcs; |
| std::unique_ptr<MemoryTransferService> mOwnedMemoryTransferService = nullptr; |
| MemoryTransferService* mMemoryTransferService = nullptr; |
| |
| std::shared_ptr<bool> mIsAlive; |
| }; |
| |
| bool TrackDeviceChild(DeviceInfo* device, ObjectType type, ObjectId id); |
| bool UntrackDeviceChild(DeviceInfo* device, ObjectType type, ObjectId id); |
| |
| std::unique_ptr<MemoryTransferService> CreateInlineMemoryTransferService(); |
| |
| }} // namespace dawn_wire::server |
| |
| #endif // DAWNWIRE_SERVER_SERVER_H_ |