mirror of
https://gitlab.kitware.com/vtk/vtk-m
synced 2024-09-16 17:22:55 +00:00
99 lines
2.9 KiB
C++
99 lines
2.9 KiB
C++
//============================================================================
|
|
// Copyright (c) Kitware, Inc.
|
|
// All rights reserved.
|
|
// See LICENSE.txt for details.
|
|
//
|
|
// This software is distributed WITHOUT ANY WARRANTY; without even
|
|
// the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
|
|
// PURPOSE. See the above copyright notice for more information.
|
|
//============================================================================
|
|
#ifndef vtk_m_exec_internal_ErrorMessageBuffer_h
|
|
#define vtk_m_exec_internal_ErrorMessageBuffer_h
|
|
|
|
#include <vtkm/Types.h>
|
|
|
|
namespace vtkm
|
|
{
|
|
namespace exec
|
|
{
|
|
namespace internal
|
|
{
|
|
|
|
/// Used to hold an error in the execution environment until the parallel
|
|
/// execution can complete. This is to be used in conjunction with a
|
|
/// DeviceAdapter's Schedule function to implement errors in execution
|
|
/// environments that cannot throw errors. This string should be global to all
|
|
/// threads. If the first entry in the string is '\0' (the C string
|
|
/// terminator), then we consider it as no error. Otherwise, the array contains
|
|
/// the string describing the error.
|
|
///
|
|
/// Before scheduling worklets, the global array should be cleared to have no
|
|
/// error. This can only be reliably done by the device adapter.
|
|
///
|
|
class VTKM_ALWAYS_EXPORT ErrorMessageBuffer
|
|
{
|
|
public:
|
|
VTKM_EXEC_CONT ErrorMessageBuffer()
|
|
: MessageBuffer(nullptr)
|
|
, MessageBufferSize(0)
|
|
{
|
|
}
|
|
|
|
VTKM_EXEC_CONT
|
|
ErrorMessageBuffer(char* messageBuffer, vtkm::Id bufferSize)
|
|
: MessageBuffer(messageBuffer)
|
|
, MessageBufferSize(bufferSize)
|
|
{
|
|
}
|
|
|
|
VTKM_EXEC void RaiseError(const char* message) const
|
|
{
|
|
// Only raise the error if one has not been raised yet. This check is not
|
|
// guaranteed to work across threads. However, chances are that if two or
|
|
// more threads simultaneously pass this test, they will be writing the
|
|
// same error, which is fine. Even in the much less likely case that two
|
|
// threads simultaneously write different error messages, the worst case is
|
|
// that you get a mangled message. That's not good (and it's what we are
|
|
// trying to avoid), but it's not critical.
|
|
if (this->IsErrorRaised())
|
|
{
|
|
return;
|
|
}
|
|
|
|
// Safely copy message into array.
|
|
for (vtkm::Id index = 0; index < this->MessageBufferSize; index++)
|
|
{
|
|
this->MessageBuffer[index] = message[index];
|
|
if (message[index] == '\0')
|
|
{
|
|
break;
|
|
}
|
|
}
|
|
|
|
// Make sure message is null terminated.
|
|
this->MessageBuffer[this->MessageBufferSize - 1] = '\0';
|
|
}
|
|
|
|
VTKM_EXEC_CONT bool IsErrorRaised() const
|
|
{
|
|
if (this->MessageBufferSize > 0)
|
|
{
|
|
return (this->MessageBuffer[0] != '\0');
|
|
}
|
|
else
|
|
{
|
|
// If there is no buffer set, then always report an error.
|
|
return true;
|
|
}
|
|
}
|
|
|
|
private:
|
|
char* MessageBuffer;
|
|
vtkm::Id MessageBufferSize;
|
|
};
|
|
}
|
|
}
|
|
} // namespace vtkm::exec::internal
|
|
|
|
#endif // vtk_m_exec_internal_ErrorMessageBuffer_h
|