lee/renderdoc
1
0
Fork 0
mirror of https://github.com/baldurk/renderdoc.git synced 2026-10-03 10:57:52 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add string messages to returned result codes to display to user

Browse Source 
* Most of the main entry points that can fail with relevant reasons now has a
  way of specifying a message to return with it. This message can be displayed
  to the user to give more information or context about an error.
This commit is contained in:
baldurk
2022-04-26 16:21:54 +01:00
parent 10dd4c194c
commit 8aa0390948
145 changed files with 2978 additions and 1874 deletions
Download Patch File Download Diff File Expand all files Collapse all files
renderdoc/core/replay_proxy.cpp
+33 -33
View File
@@ -129,37 +129,37 @@ rdcstr DoStringise(const ReplayProxyPacket &el)
// begin serialising a return value. We begin a chunk here in either the writing or reading case
// since this chunk is used purely to send/receive the return value and is fully handled within the
// function.
#define SERIALISE_RETURN(retval) \
{ \
ReplayStatus fatalStatus = ReplayStatus::Succeeded; \
if(m_RemoteServer) \
fatalStatus = m_Remote->FatalErrorCheck(); \
ReturnSerialiser &ser = retser; \
PACKET_HEADER(packet); \
SERIALISE_ELEMENT(retval); \
GET_SERIALISER.Serialise("fatalStatus"_lit, fatalStatus); \
GET_SERIALISER.Serialise("packet"_lit, packet); \
ser.EndChunk(); \
if(fatalStatus != ReplayStatus::Succeeded && m_FatalError == ReplayStatus::Succeeded) \
m_FatalError = fatalStatus; \
CheckError(packet, expectedPacket); \
#define SERIALISE_RETURN(retval) \
{ \
RDResult fatalStatus = ResultCode::Succeeded; \
if(m_RemoteServer) \
fatalStatus = m_Remote->FatalErrorCheck(); \
ReturnSerialiser &ser = retser; \
PACKET_HEADER(packet); \
SERIALISE_ELEMENT(retval); \
GET_SERIALISER.Serialise("fatalStatus"_lit, fatalStatus); \
GET_SERIALISER.Serialise("packet"_lit, packet); \
ser.EndChunk(); \
if(fatalStatus != ResultCode::Succeeded && m_FatalError == ResultCode::Succeeded) \
m_FatalError = fatalStatus; \
CheckError(packet, expectedPacket); \
}
// similar to the above, but for void functions that don't return anything. We still want to check
// that both sides of the communication are on the same page.
#define SERIALISE_RETURN_VOID() \
{ \
ReplayStatus fatalStatus = ReplayStatus::Succeeded; \
if(m_RemoteServer) \
fatalStatus = m_Remote->FatalErrorCheck(); \
ReturnSerialiser &ser = retser; \
PACKET_HEADER(packet); \
SERIALISE_ELEMENT(packet); \
GET_SERIALISER.Serialise("fatalStatus"_lit, fatalStatus); \
ser.EndChunk(); \
if(fatalStatus != ReplayStatus::Succeeded && m_FatalError == ReplayStatus::Succeeded) \
m_FatalError = fatalStatus; \
CheckError(packet, expectedPacket); \
#define SERIALISE_RETURN_VOID() \
{ \
RDResult fatalStatus = ResultCode::Succeeded; \
if(m_RemoteServer) \
fatalStatus = m_Remote->FatalErrorCheck(); \
ReturnSerialiser &ser = retser; \
PACKET_HEADER(packet); \
SERIALISE_ELEMENT(packet); \
GET_SERIALISER.Serialise("fatalStatus"_lit, fatalStatus); \
ser.EndChunk(); \
if(fatalStatus != ResultCode::Succeeded && m_FatalError == ResultCode::Succeeded) \
m_FatalError = fatalStatus; \
CheckError(packet, expectedPacket); \
}
// defines the area where we're executing on the remote host. To avoid timeouts, the remote side
@@ -2790,7 +2790,7 @@ void ReplayProxy::RemoteExecutionThreadEntry()
}
}
ReplayStatus ReplayProxy::FatalErrorCheck()
RDResult ReplayProxy::FatalErrorCheck()
{
// this isn't proxied since it's called at relatively high frequency. Whenever we proxy a
// function, we also return the the remote side's status
@@ -2798,13 +2798,13 @@ ReplayStatus ReplayProxy::FatalErrorCheck()
{
// if we're error'd due to a network issue (i.e. the other side crashed and disconnected) we
// won't have a status, set a generic one
if(m_FatalError == ReplayStatus::Succeeded)
m_FatalError = ReplayStatus::RemoteServerConnectionLost;
if(m_FatalError == ResultCode::Succeeded)
m_FatalError = ResultCode::RemoteServerConnectionLost;
return m_FatalError;
}
return ReplayStatus::Succeeded;
return ResultCode::Succeeded;
}
IReplayDriver *ReplayProxy::MakeDummyDriver()
@@ -2825,10 +2825,10 @@ IReplayDriver *ReplayProxy::MakeDummyDriver()
bool ReplayProxy::CheckError(ReplayProxyPacket receivedPacket, ReplayProxyPacket expectedPacket)
{
if(m_FatalError != ReplayStatus::Succeeded)
if(m_FatalError != ResultCode::Succeeded)
{
RDCERR("Fatal error detected while processing %s: %s", ToStr(expectedPacket).c_str(),
ToStr(m_FatalError).c_str());
ResultDetails(m_FatalError).Message().c_str());
m_IsErrored = true;
return true;
}