renderdoc/renderdoc/core/remote_replay.cpp

/******************************************************************************
 * The MIT License (MIT)
 * 
 * Copyright (c) 2014 Crytek
 * 
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 * 
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 ******************************************************************************/


#include "api/replay/renderdoc_replay.h"
#include "replay/replay_renderer.h"
#include "core/core.h"
#include "os/os_specific.h"
#include "serialise/serialiser.h"
#include "socket_helpers.h"
#include "replay_proxy.h"

#include <utility>
using std::pair;

enum PacketType
{
	ePacket_Noop,
	ePacket_RemoteDriverList,
	ePacket_CopyCapture,
	ePacket_LogOpenProgress,
	ePacket_LogReady,
};

struct ProgressLoopData
{
	Network::Socket *sock;
	float progress;
	bool killsignal;
};

static void ProgressTicker(void *d)
{
	ProgressLoopData *data = (ProgressLoopData *)d;
	
	Serialiser ser(L"", Serialiser::WRITING, false);
		
	while(!data->killsignal)
	{
		ser.Rewind();
		ser.Serialise("", data->progress);

		if(!SendPacket(data->sock, ePacket_LogOpenProgress, ser))
		{
			SAFE_DELETE(data->sock);
			break;
		}
		Threading::Sleep(100);
	}
}

void RenderDoc::BecomeReplayHost(volatile bool32 &killReplay)
{
	Network::Socket *sock = Network::CreateServerSocket("0.0.0.0", RenderDoc_ReplayNetworkPort, 1);

	if(sock == NULL)
		return;
	
	Serialiser ser(L"", Serialiser::WRITING, false);

	bool newlyReady = true;
		
	while(!killReplay)
	{
		if(newlyReady)
		{
			RDCLOG("Replay host ready for requests.");
			newlyReady = false;
		}
		
		Network::Socket *client = sock->AcceptClient(false);

		if(client == NULL)
		{
			if(!sock->Connected())
			{
				RDCERR("Error in accept - shutting down server");

				SAFE_DELETE(sock);
				return;
			}

			Threading::Sleep(5);

			continue;
		}

		newlyReady = true;

		RDCLOG("Connection received.");
		
		map<RDCDriver,wstring> drivers = RenderDoc::Inst().GetRemoteDrivers();

		uint32_t count = (uint32_t)drivers.size();
		ser.Serialise("", count);

		for(auto it=drivers.begin(); it != drivers.end(); ++it)
		{
			RDCDriver driver = it->first;
			ser.Serialise("", driver);
			ser.Serialise("", (*it).second);
		}

		if(!SendPacket(client, ePacket_RemoteDriverList, ser))
		{
			RDCERR("Network error sending supported driver list");
			SAFE_DELETE(client);
			continue;
		}

		Threading::Sleep(4);

		// don't care about the result, just want to check that the socket hasn't been gracefully shut down
		client->IsRecvDataWaiting();
		if(!client->Connected())
		{
			RDCLOG("Connection closed after sending remote driver list");
			SAFE_DELETE(client);
			continue;
		}

		wstring cap_file;
		wstring dummy, dummy2;
		FileIO::GetDefaultFiles(L"remotecopy", cap_file, dummy, dummy2);

		Serialiser *ser = NULL;

		if(!RecvChunkedFile(client, ePacket_CopyCapture, cap_file.c_str(), ser, NULL))
		{
			FileIO::UnlinkFileW(cap_file.c_str());
			
			RDCERR("Network error receiving file");

			SAFE_DELETE(ser);
			SAFE_DELETE(client);
			continue;
		}
		
		RDCLOG("File received.");
		
		SAFE_DELETE(ser);

		RDCDriver driverType = RDC_Unknown;
		wstring driverName = L"";
		RenderDoc::Inst().FillInitParams(cap_file.c_str(), driverType, driverName, NULL);

		if(RenderDoc::Inst().HasRemoteDriver(driverType))
		{
			ProgressLoopData data;

			data.sock = client;
			data.killsignal = false;
			data.progress = 0.0f;

			RenderDoc::Inst().SetProgressPtr(&data.progress);

			Threading::ThreadHandle ticker = Threading::CreateThread(ProgressTicker, &data);

			IRemoteDriver *driver = NULL;
			auto status = RenderDoc::Inst().CreateRemoteDriver(driverType, cap_file.c_str(), &driver);

			if(status != eReplayCreate_Success || driver == NULL)
			{
				RDCERR("Failed to create remote driver for driver type %d name %ls", driverType, driverName.c_str());
				SAFE_DELETE(ser);
				SAFE_DELETE(client);
				continue;
			}
		
			driver->ReadLogInitialisation();
	
			RenderDoc::Inst().SetProgressPtr(NULL);

			data.killsignal = true;
			Threading::JoinThread(ticker);
			Threading::CloseThread(ticker);

			FileIO::UnlinkFileW(cap_file.c_str());

			SendPacket(client, ePacket_LogReady);

			ProxySerialiser *proxy = new ProxySerialiser(client, driver);

			while(client)
			{
				if(!proxy->Tick() || killReplay)
				{
					SAFE_DELETE(client);
				}
			}
			
			driver->Shutdown();
			
			RDCLOG("Closing replay connection");

			SAFE_DELETE(proxy);
			SAFE_DELETE(client);
		}
		else
		{
			RDCERR("File needs driver for %ls which isn't supported!", driverName.c_str());
		
			FileIO::UnlinkFileW(cap_file.c_str());
		}

		SAFE_DELETE(client);
	}
}

struct RemoteRenderer
{
	public:
		RemoteRenderer(Network::Socket *sock)
			: m_Socket(sock)
		{
			map<RDCDriver,wstring> m = RenderDoc::Inst().GetReplayDrivers();

			m_Proxies.reserve(m.size());
			for(auto it=m.begin(); it != m.end(); ++it) m_Proxies.push_back(*it);
			
			{
				PacketType type;
				Serialiser *ser = NULL;
				GetPacket(type, &ser);

				m.clear();

				if(ser)
				{
					uint32_t count = 0;
					ser->Serialise("", count);

					for(uint32_t i=0; i < count; i++)
					{
						RDCDriver driver = RDC_Unknown;
						wstring name = L"";
						ser->Serialise("", driver);
						ser->Serialise("", name);

						m[driver] = name;
					}

					delete ser;
				}
			}

			m_RemoteDrivers.reserve(m.size());
			for(auto it=m.begin(); it != m.end(); ++it) m_RemoteDrivers.push_back(*it);

			m_ProxyDriver = NULL;
		}
		~RemoteRenderer()
		{
			SAFE_DELETE(m_Socket);
		}

		void Shutdown()
		{
			delete this;
		}

		bool Connected() { return m_Socket != NULL && m_Socket->Connected(); }
		
		bool LocalProxies(rdctype::array<rdctype::wstr> *out)
		{
			if(out == NULL) return false;

			create_array_uninit(*out, m_Proxies.size());

			size_t i=0;
			for(auto it=m_Proxies.begin(); it != m_Proxies.end(); ++it, ++i)
				out->elems[i] = it->second;

			return true;
		}
		
		bool RemoteSupportedReplays(rdctype::array<rdctype::wstr> *out)
		{
			if(out == NULL) return false;
			
			create_array_uninit(*out, m_RemoteDrivers.size());

			size_t i=0;
			for(auto it=m_RemoteDrivers.begin(); it != m_RemoteDrivers.end(); ++it, ++i)
				out->elems[i] = it->second;

			return true;
		}

		ReplayCreateStatus CreateProxyRenderer(uint32_t proxyid, const wchar_t *logfile, float *progress, ReplayRenderer **rend)
		{
			if(rend == NULL) return eReplayCreate_InternalError;

			if(proxyid >= m_Proxies.size())
			{
				RDCERR("Invalid proxy driver id %d specified for remote renderer", proxyid);
				return eReplayCreate_InternalError;
			}
			
			float dummy = 0.0f;
			if(progress == NULL)
				progress = &dummy;

			RDCDriver proxydriver = m_Proxies[proxyid].first;

			Serialiser ser(L"", Serialiser::WRITING, false);
		
			if(!SendChunkedFile(m_Socket, ePacket_CopyCapture, logfile, ser, progress))
			{
				SAFE_DELETE(m_Socket);
				return eReplayCreate_NetworkIOFailed;
			}

			RDCLOG("Sent file to replay host. Loading...");
			
			PacketType type = ePacket_Noop;
			while(m_Socket)
			{
				Serialiser *ser;
				GetPacket(type, &ser);

				if(!m_Socket || type != ePacket_LogOpenProgress) break;

				ser->Serialise("", *progress);

				RDCLOG("% 3.0f%%...", (*progress)*100.0f);
			}

			if(!m_Socket || type != ePacket_LogReady)
				return eReplayCreate_NetworkIOFailed;

			*progress = 1.0f;

			RDCLOG("Log ready on replay host");

			m_ProxyDriver = NULL;
			auto status = RenderDoc::Inst().CreateReplayDriver(proxydriver, NULL, &m_ProxyDriver);

			if(status != eReplayCreate_Success || !m_ProxyDriver)
				return status;

			ReplayRenderer *ret = new ReplayRenderer();

			ProxySerialiser *proxy = new ProxySerialiser(m_Socket, m_ProxyDriver);
			status = ret->SetDevice(proxy);

			if(status != eReplayCreate_Success)
			{
				SAFE_DELETE(ret);
				SAFE_DELETE(proxy);
				return status;
			}
			
			// ReplayRenderer takes ownership of the ProxySerialiser (as IReplayDriver)
			// and it cleans itself up in Shutdown.

			*rend = ret;

			return eReplayCreate_Success;
		}
	private:
		Network::Socket *m_Socket;
		
		void GetPacket(PacketType &type, Serialiser **ser)
		{
			vector<byte> payload;

			if(!RecvPacket(m_Socket, type, payload))
			{
				SAFE_DELETE(m_Socket);
				if(ser) *ser = NULL;
				return;
			}

			if(ser)	*ser = new Serialiser(payload.size(), &payload[0], false);
		}

		IReplayDriver *m_ProxyDriver;

		vector< pair<RDCDriver, wstring> > m_Proxies;
		vector< pair<RDCDriver, wstring> > m_RemoteDrivers;
};

extern "C" RENDERDOC_API void RENDERDOC_CC RemoteRenderer_Shutdown(RemoteRenderer *remote)
{	remote->Shutdown(); }

extern "C" RENDERDOC_API bool32 RENDERDOC_CC RemoteRenderer_LocalProxies(RemoteRenderer *remote, rdctype::array<rdctype::wstr> *out)
{ return remote->LocalProxies(out); }

extern "C" RENDERDOC_API bool32 RENDERDOC_CC RemoteRenderer_RemoteSupportedReplays(RemoteRenderer *remote, rdctype::array<rdctype::wstr> *out)
{ return remote->RemoteSupportedReplays(out); }

extern "C" RENDERDOC_API ReplayCreateStatus RENDERDOC_CC RemoteRenderer_CreateProxyRenderer(RemoteRenderer *remote, uint32_t proxyid, const wchar_t *logfile, float *progress, ReplayRenderer **rend)
{ return remote->CreateProxyRenderer(proxyid, logfile, progress, rend); }

extern "C" RENDERDOC_API
ReplayCreateStatus RENDERDOC_CC RENDERDOC_CreateRemoteReplayConnection(const wchar_t *host, RemoteRenderer **rend)
{
	if(rend == NULL) return eReplayCreate_InternalError;

	wstring s = L"localhost";
	if(host != NULL && host[0] != L'\0')
		s = host;
	
	Network::Socket *sock = NULL;
	
	if(s != L"-")
	{
		sock = Network::CreateClientSocket(s.c_str(), RenderDoc_ReplayNetworkPort, 3000);

		if(sock == NULL)
			return eReplayCreate_NetworkIOFailed;
	}
	
	*rend = new RemoteRenderer(sock);

	return eReplayCreate_Success;
}