1
0
cuberite-2a/src/ByteBuffer.cpp

1012 lines
18 KiB
C++
Raw Normal View History

// ByteBuffer.cpp
// Implements the cByteBuffer class representing a ringbuffer of bytes
#include "Globals.h"
#include "ByteBuffer.h"
#include "Endianness.h"
2017-08-25 08:43:18 -04:00
#include "UUID.h"
#include "OSSupport/IsThread.h"
/** When defined, each access to a cByteBuffer object is checked whether it's done in the same thread.
cByteBuffer assumes that it is not used by multiple threads at once, this macro adds a runtime check for that.
Unfortunately it is very slow, so it is disabled even for regular DEBUG builds. */
// #define DEBUG_SINGLE_THREAD_ACCESS
// If a string sent over the protocol is larger than this, a warning is emitted to the console
#define MAX_STRING_SIZE (512 KiB)
2019-08-11 05:39:43 -04:00
#define NEEDBYTES(Num) if (!CanReadBytes(Num)) return false // Check if at least Num bytes can be read from the buffer, return false if not
#define PUTBYTES(Num) if (!CanWriteBytes(Num)) return false // Check if at least Num bytes can be written to the buffer, return false if not
#ifdef DEBUG_SINGLE_THREAD_ACCESS
/** Simple RAII class that is used for checking that no two threads are using an object simultanously.
It requires the monitored object to provide the storage for a thread ID.
It uses that storage to check if the thread ID of consecutive calls is the same all the time. */
class cSingleThreadAccessChecker
{
public:
cSingleThreadAccessChecker(std::thread::id * a_ThreadID) :
m_ThreadID(a_ThreadID)
{
ASSERT(
(*a_ThreadID == std::this_thread::get_id()) || // Either the object is used by current thread...
(*a_ThreadID == m_EmptyThreadID) // ... or by no thread at all
);
// Mark as being used by this thread:
*m_ThreadID = std::this_thread::get_id();
}
~cSingleThreadAccessChecker()
{
// Mark as not being used by any thread:
*m_ThreadID = std::thread::id();
}
protected:
/** Points to the storage used for ID of the thread using the object. */
std::thread::id * m_ThreadID;
/** The value of an unassigned thread ID, used to speed up checking. */
static std::thread::id m_EmptyThreadID;
};
std::thread::id cSingleThreadAccessChecker::m_EmptyThreadID;
2014-12-03 12:24:28 -05:00
#define CHECK_THREAD cSingleThreadAccessChecker Checker(&m_ThreadID);
#else
2014-12-03 12:24:28 -05:00
#define CHECK_THREAD
#endif
////////////////////////////////////////////////////////////////////////////////
// cByteBuffer:
cByteBuffer::cByteBuffer(size_t a_BufferSize) :
m_Buffer(new char[a_BufferSize + 1]),
m_BufferSize(a_BufferSize + 1),
m_DataStart(0),
m_WritePos(0),
m_ReadPos(0)
{
// Allocating one byte more than the buffer size requested, so that we can distinguish between
// completely-full and completely-empty states
}
cByteBuffer::~cByteBuffer()
{
CheckValid();
delete[] m_Buffer;
2014-10-20 16:55:07 -04:00
m_Buffer = nullptr;
}
bool cByteBuffer::Write(const void * a_Bytes, size_t a_Count)
{
CHECK_THREAD
CheckValid();
// Store the current free space for a check after writing:
size_t CurFreeSpace = GetFreeSpace();
#ifdef _DEBUG
size_t CurReadableSpace = GetReadableSpace();
#endif
size_t WrittenBytes = 0;
2016-02-05 16:45:45 -05:00
2014-01-26 11:48:09 -05:00
if (CurFreeSpace < a_Count)
{
return false;
}
2014-03-08 14:18:51 -05:00
ASSERT(m_BufferSize >= m_WritePos);
size_t TillEnd = m_BufferSize - m_WritePos;
const char * Bytes = static_cast<const char *>(a_Bytes);
if (TillEnd <= a_Count)
{
// Need to wrap around the ringbuffer end
if (TillEnd > 0)
{
memcpy(m_Buffer + m_WritePos, Bytes, TillEnd);
Bytes += TillEnd;
a_Count -= TillEnd;
WrittenBytes = TillEnd;
}
m_WritePos = 0;
}
2016-02-05 16:45:45 -05:00
// We're guaranteed that we'll fit in a single write op
if (a_Count > 0)
{
memcpy(m_Buffer + m_WritePos, Bytes, a_Count);
m_WritePos += a_Count;
WrittenBytes += a_Count;
}
2016-02-05 16:45:45 -05:00
ASSERT(GetFreeSpace() == CurFreeSpace - WrittenBytes);
ASSERT(GetReadableSpace() == CurReadableSpace + WrittenBytes);
return true;
}
size_t cByteBuffer::GetFreeSpace(void) const
{
CHECK_THREAD
CheckValid();
if (m_WritePos >= m_DataStart)
{
// Wrap around the buffer end:
2014-03-08 14:18:51 -05:00
ASSERT(m_BufferSize >= m_WritePos);
ASSERT((m_BufferSize - m_WritePos + m_DataStart) >= 1);
return m_BufferSize - m_WritePos + m_DataStart - 1;
}
// Single free space partition:
2014-03-08 14:18:51 -05:00
ASSERT(m_BufferSize >= m_WritePos);
ASSERT(m_BufferSize - m_WritePos >= 1);
return m_DataStart - m_WritePos - 1;
}
size_t cByteBuffer::GetUsedSpace(void) const
{
CHECK_THREAD
CheckValid();
2014-03-08 14:18:51 -05:00
ASSERT(m_BufferSize >= GetFreeSpace());
ASSERT((m_BufferSize - GetFreeSpace()) >= 1);
return m_BufferSize - GetFreeSpace() - 1;
}
size_t cByteBuffer::GetReadableSpace(void) const
{
CHECK_THREAD
CheckValid();
if (m_ReadPos > m_WritePos)
{
// Wrap around the buffer end:
2014-03-08 14:18:51 -05:00
ASSERT(m_BufferSize >= m_ReadPos);
return m_BufferSize - m_ReadPos + m_WritePos;
}
// Single readable space partition:
2014-03-08 14:18:51 -05:00
ASSERT(m_WritePos >= m_ReadPos);
2014-09-11 20:42:04 -04:00
return m_WritePos - m_ReadPos;
}
2014-03-07 14:04:25 -05:00
bool cByteBuffer::CanReadBytes(size_t a_Count) const
{
CHECK_THREAD
CheckValid();
return (a_Count <= GetReadableSpace());
}
2014-03-07 14:04:25 -05:00
bool cByteBuffer::CanWriteBytes(size_t a_Count) const
{
CHECK_THREAD
CheckValid();
return (a_Count <= GetFreeSpace());
}
bool cByteBuffer::ReadBEInt8(Int8 & a_Value)
{
CHECK_THREAD
CheckValid();
NEEDBYTES(1);
ReadBuf(&a_Value, 1);
return true;
}
bool cByteBuffer::ReadBEUInt8(UInt8 & a_Value)
{
CHECK_THREAD
CheckValid();
NEEDBYTES(1);
ReadBuf(&a_Value, 1);
return true;
}
bool cByteBuffer::ReadBEInt16(Int16 & a_Value)
{
CHECK_THREAD
CheckValid();
NEEDBYTES(2);
UInt16 val;
ReadBuf(&val, 2);
val = ntohs(val);
memcpy(&a_Value, &val, 2);
return true;
}
bool cByteBuffer::ReadBEUInt16(UInt16 & a_Value)
{
CHECK_THREAD
CheckValid();
NEEDBYTES(2);
ReadBuf(&a_Value, 2);
a_Value = ntohs(a_Value);
return true;
}
bool cByteBuffer::ReadBEInt32(Int32 & a_Value)
{
CHECK_THREAD
CheckValid();
NEEDBYTES(4);
UInt32 val;
ReadBuf(&val, 4);
val = ntohl(val);
memcpy(&a_Value, &val, 4);
return true;
}
bool cByteBuffer::ReadBEUInt32(UInt32 & a_Value)
{
CHECK_THREAD
CheckValid();
NEEDBYTES(4);
ReadBuf(&a_Value, 4);
a_Value = ntohl(a_Value);
return true;
}
bool cByteBuffer::ReadBEInt64(Int64 & a_Value)
{
CHECK_THREAD
CheckValid();
NEEDBYTES(8);
ReadBuf(&a_Value, 8);
a_Value = NetworkToHostLong8(&a_Value);
return true;
}
bool cByteBuffer::ReadBEUInt64(UInt64 & a_Value)
{
CHECK_THREAD
CheckValid();
NEEDBYTES(8);
ReadBuf(&a_Value, 8);
a_Value = NetworkToHostULong8(&a_Value);
return true;
}
bool cByteBuffer::ReadBEFloat(float & a_Value)
{
CHECK_THREAD
CheckValid();
NEEDBYTES(4);
ReadBuf(&a_Value, 4);
a_Value = NetworkToHostFloat4(&a_Value);
return true;
}
bool cByteBuffer::ReadBEDouble(double & a_Value)
{
CHECK_THREAD
CheckValid();
NEEDBYTES(8);
ReadBuf(&a_Value, 8);
a_Value = NetworkToHostDouble8(&a_Value);
return true;
}
bool cByteBuffer::ReadBool(bool & a_Value)
{
CHECK_THREAD
CheckValid();
NEEDBYTES(1);
UInt8 Value = 0;
ReadBuf(&Value, 1);
a_Value = (Value != 0);
return true;
}
bool cByteBuffer::ReadVarInt32(UInt32 & a_Value)
{
CHECK_THREAD
CheckValid();
2013-10-28 15:57:03 -04:00
UInt32 Value = 0;
int Shift = 0;
unsigned char b = 0;
do
{
NEEDBYTES(1);
ReadBuf(&b, 1);
Value = Value | ((static_cast<UInt32>(b & 0x7f)) << Shift);
Shift += 7;
} while ((b & 0x80) != 0);
a_Value = Value;
return true;
}
bool cByteBuffer::ReadVarInt64(UInt64 & a_Value)
{
CHECK_THREAD
CheckValid();
UInt64 Value = 0;
int Shift = 0;
unsigned char b = 0;
do
{
NEEDBYTES(1);
ReadBuf(&b, 1);
Value = Value | ((static_cast<UInt64>(b & 0x7f)) << Shift);
Shift += 7;
} while ((b & 0x80) != 0);
a_Value = Value;
return true;
}
bool cByteBuffer::ReadVarUTF8String(AString & a_Value)
{
CHECK_THREAD
CheckValid();
2013-10-28 15:57:03 -04:00
UInt32 Size = 0;
if (!ReadVarInt(Size))
{
return false;
}
if (Size > MAX_STRING_SIZE)
{
2014-03-11 17:43:14 -04:00
LOGWARNING("%s: String too large: %u (%u KiB)", __FUNCTION__, Size, Size / 1024);
}
return ReadString(a_Value, static_cast<size_t>(Size));
}
bool cByteBuffer::ReadLEInt(int & a_Value)
{
CHECK_THREAD
CheckValid();
NEEDBYTES(4);
ReadBuf(&a_Value, 4);
2016-02-05 16:45:45 -05:00
#ifdef IS_BIG_ENDIAN
// Convert:
a_Value = ((a_Value >> 24) & 0xff) | ((a_Value >> 16) & 0xff00) | ((a_Value >> 8) & 0xff0000) | (a_Value & 0xff000000);
#endif
2016-02-05 16:45:45 -05:00
return true;
}
2020-07-20 04:56:27 -04:00
bool cByteBuffer::ReadXYZPosition64(int & a_BlockX, int & a_BlockY, int & a_BlockZ)
2014-09-08 11:02:54 -04:00
{
CHECK_THREAD
2014-09-08 11:02:54 -04:00
Int64 Value;
if (!ReadBEInt64(Value))
{
return false;
}
// Convert the 64 received bits into 3 coords:
UInt32 BlockXRaw = (Value >> 38) & 0x03ffffff; // Top 26 bits
UInt32 BlockYRaw = (Value >> 26) & 0x0fff; // Middle 12 bits
UInt32 BlockZRaw = (Value & 0x03ffffff); // Bottom 26 bits
2016-02-05 16:45:45 -05:00
// If the highest bit in the number's range is set, convert the number into negative:
a_BlockX = ((BlockXRaw & 0x02000000) == 0) ? static_cast<int>(BlockXRaw) : -(0x04000000 - static_cast<int>(BlockXRaw));
2020-07-20 04:56:27 -04:00
a_BlockY = ((BlockYRaw & 0x0800) == 0) ? static_cast<int>(BlockYRaw) : -(0x01000 - static_cast<int>(BlockYRaw));
a_BlockZ = ((BlockZRaw & 0x02000000) == 0) ? static_cast<int>(BlockZRaw) : -(0x04000000 - static_cast<int>(BlockZRaw));
2014-09-08 11:02:54 -04:00
return true;
}
2020-07-20 04:56:27 -04:00
bool cByteBuffer::ReadXZYPosition64(int & a_BlockX, int & a_BlockY, int & a_BlockZ)
{
CHECK_THREAD
Int64 Value;
if (!ReadBEInt64(Value))
{
return false;
}
// Convert the 64 received bits into 3 coords:
UInt32 BlockXRaw = (Value >> 38) & 0x03ffffff; // Top 26 bits
UInt32 BlockZRaw = (Value >> 12) & 0x03ffffff; // Middle 26 bits
UInt32 BlockYRaw = (Value & 0x0fff); // Bottom 12 bits
// If the highest bit in the number's range is set, convert the number into negative:
a_BlockX = ((BlockXRaw & 0x02000000) == 0) ? static_cast<int>(BlockXRaw) : (static_cast<int>(BlockXRaw) - 0x04000000);
a_BlockY = ((BlockYRaw & 0x0800) == 0) ? static_cast<int>(BlockYRaw) : (static_cast<int>(BlockYRaw) - 0x01000);
a_BlockZ = ((BlockZRaw & 0x02000000) == 0) ? static_cast<int>(BlockZRaw) : (static_cast<int>(BlockZRaw) - 0x04000000);
return true;
}
2017-08-25 08:43:18 -04:00
bool cByteBuffer::ReadUUID(cUUID & a_Value)
2016-10-12 08:38:45 -04:00
{
CHECK_THREAD
2017-08-25 08:43:18 -04:00
std::array<Byte, 16> UUIDBuf;
if (!ReadBuf(UUIDBuf.data(), UUIDBuf.size()))
2016-10-12 08:38:45 -04:00
{
return false;
}
2017-08-25 08:43:18 -04:00
a_Value.FromRaw(UUIDBuf);
2016-10-12 08:38:45 -04:00
return true;
}
bool cByteBuffer::WriteBEInt8(Int8 a_Value)
{
CHECK_THREAD
CheckValid();
PUTBYTES(1);
return WriteBuf(&a_Value, 1);
}
bool cByteBuffer::WriteBEUInt8(UInt8 a_Value)
{
CHECK_THREAD
CheckValid();
PUTBYTES(1);
return WriteBuf(&a_Value, 1);
}
bool cByteBuffer::WriteBEInt16(Int16 a_Value)
{
CHECK_THREAD
CheckValid();
PUTBYTES(2);
UInt16 val;
memcpy(&val, &a_Value, 2);
val = htons(val);
return WriteBuf(&val, 2);
}
bool cByteBuffer::WriteBEUInt16(UInt16 a_Value)
2014-09-25 14:46:50 -04:00
{
CHECK_THREAD
2014-09-25 14:46:50 -04:00
CheckValid();
PUTBYTES(2);
a_Value = htons(a_Value);
return WriteBuf(&a_Value, 2);
}
bool cByteBuffer::WriteBEInt32(Int32 a_Value)
{
CHECK_THREAD
CheckValid();
PUTBYTES(4);
UInt32 Converted = HostToNetwork4(&a_Value);
return WriteBuf(&Converted, 4);
2014-09-25 14:46:50 -04:00
}
bool cByteBuffer::WriteBEUInt32(UInt32 a_Value)
{
CHECK_THREAD
CheckValid();
PUTBYTES(4);
2014-05-01 16:54:22 -04:00
UInt32 Converted = HostToNetwork4(&a_Value);
return WriteBuf(&Converted, 4);
}
bool cByteBuffer::WriteBEInt64(Int64 a_Value)
{
CHECK_THREAD
CheckValid();
PUTBYTES(8);
2014-05-01 16:54:22 -04:00
UInt64 Converted = HostToNetwork8(&a_Value);
return WriteBuf(&Converted, 8);
}
bool cByteBuffer::WriteBEUInt64(UInt64 a_Value)
{
CHECK_THREAD
CheckValid();
PUTBYTES(8);
UInt64 Converted = HostToNetwork8(&a_Value);
return WriteBuf(&Converted, 8);
}
bool cByteBuffer::WriteBEFloat(float a_Value)
{
CHECK_THREAD
CheckValid();
PUTBYTES(4);
2014-05-01 16:54:22 -04:00
UInt32 Converted = HostToNetwork4(&a_Value);
return WriteBuf(&Converted, 4);
}
bool cByteBuffer::WriteBEDouble(double a_Value)
{
CHECK_THREAD
CheckValid();
PUTBYTES(8);
2014-05-01 16:54:22 -04:00
UInt64 Converted = HostToNetwork8(&a_Value);
return WriteBuf(&Converted, 8);
}
bool cByteBuffer::WriteBool(bool a_Value)
{
CHECK_THREAD
CheckValid();
UInt8 val = a_Value ? 1 : 0;
return Write(&val, 1);
}
bool cByteBuffer::WriteVarInt32(UInt32 a_Value)
{
CHECK_THREAD
CheckValid();
2016-02-05 16:45:45 -05:00
2013-10-28 15:57:03 -04:00
// A 32-bit integer can be encoded by at most 5 bytes:
unsigned char b[5];
2014-05-01 16:54:22 -04:00
size_t idx = 0;
do
{
b[idx] = (a_Value & 0x7f) | ((a_Value > 0x7f) ? 0x80 : 0x00);
a_Value = a_Value >> 7;
idx++;
} while (a_Value > 0);
return WriteBuf(b, idx);
}
bool cByteBuffer::WriteVarInt64(UInt64 a_Value)
{
CHECK_THREAD
CheckValid();
2016-02-05 16:45:45 -05:00
// A 64-bit integer can be encoded by at most 10 bytes:
unsigned char b[10];
size_t idx = 0;
do
{
b[idx] = (a_Value & 0x7f) | ((a_Value > 0x7f) ? 0x80 : 0x00);
a_Value = a_Value >> 7;
idx++;
} while (a_Value > 0);
return WriteBuf(b, idx);
}
bool cByteBuffer::WriteVarUTF8String(const AString & a_Value)
{
CHECK_THREAD
CheckValid();
PUTBYTES(a_Value.size() + 1); // This is a lower-bound on the bytes that will be actually written. Fail early.
bool res = WriteVarInt32(static_cast<UInt32>(a_Value.size()));
if (!res)
{
return false;
}
return WriteBuf(a_Value.data(), a_Value.size());
}
2020-07-20 04:56:27 -04:00
bool cByteBuffer::WriteXYZPosition64(Int32 a_BlockX, Int32 a_BlockY, Int32 a_BlockZ)
2014-09-08 11:02:54 -04:00
{
CHECK_THREAD
CheckValid();
return WriteBEInt64(
(static_cast<Int64>(a_BlockX & 0x3FFFFFF) << 38) |
(static_cast<Int64>(a_BlockY & 0xFFF) << 26) |
(static_cast<Int64>(a_BlockZ & 0x3FFFFFF))
);
2014-09-08 11:02:54 -04:00
}
2020-07-20 04:56:27 -04:00
bool cByteBuffer::WriteXZYPosition64(Int32 a_BlockX, Int32 a_BlockY, Int32 a_BlockZ)
{
CHECK_THREAD
CheckValid();
return WriteBEInt64(
(static_cast<Int64>(a_BlockX & 0x3FFFFFF) << 38) |
(static_cast<Int64>(a_BlockZ & 0x3FFFFFF) << 26) |
(static_cast<Int64>(a_BlockY & 0xFFF))
);
}
2014-03-08 10:36:52 -05:00
bool cByteBuffer::ReadBuf(void * a_Buffer, size_t a_Count)
{
CHECK_THREAD
CheckValid();
NEEDBYTES(a_Count);
char * Dst = static_cast<char *>(a_Buffer); // So that we can do byte math
2014-03-08 14:18:51 -05:00
ASSERT(m_BufferSize >= m_ReadPos);
size_t BytesToEndOfBuffer = m_BufferSize - m_ReadPos;
if (BytesToEndOfBuffer <= a_Count)
{
// Reading across the ringbuffer end, read the first part and adjust parameters:
if (BytesToEndOfBuffer > 0)
{
memcpy(Dst, m_Buffer + m_ReadPos, BytesToEndOfBuffer);
Dst += BytesToEndOfBuffer;
a_Count -= BytesToEndOfBuffer;
}
m_ReadPos = 0;
}
2016-02-05 16:45:45 -05:00
// Read the rest of the bytes in a single read (guaranteed to fit):
if (a_Count > 0)
{
memcpy(Dst, m_Buffer + m_ReadPos, a_Count);
m_ReadPos += a_Count;
}
return true;
}
2014-03-08 10:36:52 -05:00
bool cByteBuffer::WriteBuf(const void * a_Buffer, size_t a_Count)
{
CHECK_THREAD
CheckValid();
PUTBYTES(a_Count);
const char * Src = static_cast<const char *>(a_Buffer); // So that we can do byte math
2014-03-08 14:18:51 -05:00
ASSERT(m_BufferSize >= m_ReadPos);
size_t BytesToEndOfBuffer = m_BufferSize - m_WritePos;
if (BytesToEndOfBuffer <= a_Count)
{
// Reading across the ringbuffer end, read the first part and adjust parameters:
memcpy(m_Buffer + m_WritePos, Src, BytesToEndOfBuffer);
Src += BytesToEndOfBuffer;
a_Count -= BytesToEndOfBuffer;
m_WritePos = 0;
}
2016-02-05 16:45:45 -05:00
// Read the rest of the bytes in a single read (guaranteed to fit):
if (a_Count > 0)
{
memcpy(m_Buffer + m_WritePos, Src, a_Count);
m_WritePos += a_Count;
}
return true;
}
2014-03-08 10:36:52 -05:00
bool cByteBuffer::ReadString(AString & a_String, size_t a_Count)
{
CHECK_THREAD
CheckValid();
NEEDBYTES(a_Count);
a_String.clear();
a_String.reserve(a_Count);
2014-03-08 14:18:51 -05:00
ASSERT(m_BufferSize >= m_ReadPos);
size_t BytesToEndOfBuffer = m_BufferSize - m_ReadPos;
if (BytesToEndOfBuffer <= a_Count)
{
// Reading across the ringbuffer end, read the first part and adjust parameters:
if (BytesToEndOfBuffer > 0)
{
a_String.assign(m_Buffer + m_ReadPos, BytesToEndOfBuffer);
2014-03-08 14:18:51 -05:00
ASSERT(a_Count >= BytesToEndOfBuffer);
a_Count -= BytesToEndOfBuffer;
}
m_ReadPos = 0;
}
// Read the rest of the bytes in a single read (guaranteed to fit):
if (a_Count > 0)
{
a_String.append(m_Buffer + m_ReadPos, a_Count);
m_ReadPos += a_Count;
}
return true;
}
2014-03-07 14:04:25 -05:00
bool cByteBuffer::SkipRead(size_t a_Count)
{
CHECK_THREAD
CheckValid();
if (!CanReadBytes(a_Count))
{
return false;
}
AdvanceReadPos(a_Count);
return true;
}
void cByteBuffer::ReadAll(AString & a_Data)
{
CHECK_THREAD
CheckValid();
ReadString(a_Data, GetReadableSpace());
}
2013-12-22 09:19:29 -05:00
bool cByteBuffer::ReadToByteBuffer(cByteBuffer & a_Dst, size_t a_NumBytes)
{
CHECK_THREAD
if (!a_Dst.CanWriteBytes(a_NumBytes) || !CanReadBytes(a_NumBytes))
{
// There's not enough source bytes or space in the dest BB
return false;
}
char buf[1024];
2013-12-22 12:02:36 -05:00
// > 0 without generating warnings about unsigned comparisons where size_t is unsigned
while (a_NumBytes != 0)
{
2013-12-22 09:19:29 -05:00
size_t num = (a_NumBytes > sizeof(buf)) ? sizeof(buf) : a_NumBytes;
VERIFY(ReadBuf(buf, num));
VERIFY(a_Dst.Write(buf, num));
2014-03-08 14:18:51 -05:00
ASSERT(a_NumBytes >= num);
a_NumBytes -= num;
}
return true;
}
void cByteBuffer::CommitRead(void)
{
CHECK_THREAD
CheckValid();
m_DataStart = m_ReadPos;
}
void cByteBuffer::ResetRead(void)
{
CHECK_THREAD
CheckValid();
m_ReadPos = m_DataStart;
}
void cByteBuffer::ReadAgain(AString & a_Out)
{
// Return the data between m_DataStart and m_ReadPos (the data that has been read but not committed)
// Used by ProtoProxy to repeat communication twice, once for parsing and the other time for the remote party
CHECK_THREAD
CheckValid();
2014-03-08 14:18:51 -05:00
size_t DataStart = m_DataStart;
if (m_ReadPos < m_DataStart)
{
// Across the ringbuffer end, read the first part and adjust next part's start:
2014-03-08 14:18:51 -05:00
ASSERT(m_BufferSize >= m_DataStart);
a_Out.append(m_Buffer + m_DataStart, m_BufferSize - m_DataStart);
DataStart = 0;
}
2014-03-08 14:18:51 -05:00
ASSERT(m_ReadPos >= DataStart);
a_Out.append(m_Buffer + DataStart, m_ReadPos - DataStart);
}
2014-03-07 14:04:25 -05:00
void cByteBuffer::AdvanceReadPos(size_t a_Count)
{
CHECK_THREAD
CheckValid();
m_ReadPos += a_Count;
if (m_ReadPos >= m_BufferSize)
{
m_ReadPos -= m_BufferSize;
}
}
void cByteBuffer::CheckValid(void) const
{
ASSERT(m_ReadPos < m_BufferSize);
ASSERT(m_WritePos < m_BufferSize);
}
2014-01-26 11:48:09 -05:00
1.9 / 1.9.2 / 1.9.3 / 1.9.4 protocol support (#3135) * Semistable update to 15w31a I'm going through snapshots in a sequential order since it should make things easier, and since protocol version history is written. * Update to 15w34b protocol Also, fix an issue with the Entity Equipment packet from the past version. Clients are able to connect and do stuff! * Partially update to 15w35e Chunk data doesn't work, but the client joins. I'm waiting to do chunk data because chunk data has an incomplete format until 15w36d. * Add '/blk' debug command This command lets one see what block they are looking at, and makes figuring out what's supposed to be where in a highly broken chunk possible. * Fix CRLF normalization in CheckBasicStyle.lua Normally, this doesn't cause an issue, but when running from cygwin, it detects the CR as whitespace and creates thousands of violations for every single line. Lua, when run on windows, will normalize automatically, but when run via cygwin, it won't. The bug was simply that gsub was returning a replaced version, but not changing the parameter, so the replaced version was ignored. * Update to 15w40b This includes chunk serialization. Fully functional chunk serialization for 1.9. I'm not completely happy with the chunk serialization as-is (correct use of palettes would be great), but cuberite also doesn't skip sending empty chunks so this performance optimization should probably come later. The creation of a full buffer is suboptimal, but it's the easiest way to implement this code. * Write long-by-long rather than creating a buffer This is a bit faster and should be equivalent. However, the code still doesn't look too good. * Update to 15w41a protocol This includes the new set passengers packet, which works off of the ridden entity, not the rider. That means, among other things, that information about the previously ridden vehicle is needed when detaching. So a new method with that info was added. * Update to 15w45a * 15w51b protocol * Update to 1.9.0 protocol Closes #3067. There are still a few things that need to be worked out (picking up items, effects, particles, and most importantly inventory), but in general this should work. I'll make a few more changes tomorrow to get the rest of the protocol set up, along with 1.9.1/1.9.2 (which did make a few changes). Chunks, however, _are_ working, along with most other parts of the game (placing/breaking blocks). * Fix item pickup packet not working That was a silly mistake, but at least it was an easy one. * 1.9.2 protocol support * Fix version info found in server list ping Thus, the client reports that it can connect rather than saying that the server is out of date. This required creating separate classes for 1.9.1 and 1.9.2, unfortunately. * Fix build errors generated by clang These didn't happen in MSVC. * Add protocol19x.cpp and protocol19x.h to CMakeLists * Ignore warnings in protocol19x that are ignored in protocol18x * Document BLOCK_FACE and DIG_STATUS constants * Fix BLOCK_FACE links and add separate section for DIG_STATUS * Fix bat animation and object spawning The causes of both of these are explained in #3135, but the gist is that both were typos. * Implement Use Item packet This means that buckets, bows, fishing rods, and several other similar items now work when not looking at a block. * Handle DIG_STATUS_SWAP_ITEM_IN_HAND * Add support for spawn eggs and potions The items are transformed from the 1.9 version to the 1.8 version when reading and transformed back when sending. * Remove spammy potion debug logging * Fix wolf collar color metadata The wrong type was being used, causing several clientside issues (including the screen going black). * Fix 1.9 chunk sending in the nether The nether and the end don't send skylight. * Fix clang build errors * Fix water bottles becoming mundane potions This happened because the can become splash potion bit got set incorrectly. Water bottles and mundane potions are only differentiated by the fact that water bottles have a metadata of 0, so setting that bit made it a mundane potion. Also add missing break statements to the read item NBT switch, which would otherwise break items with custom names and also cause incorrect "Unimplemented NBT data when parsing!" logging. * Copy Protocol18x as Protocol19x Aditionally, method and class names have been swapped to clean up other diffs. This commit is only added to make the following diffs more readable; it doesn't make any other changes (beyond class names). * Make thrown potions use the correct appearence This was caused by potions now using metadata. * Add missing api doc for cSplashPotionEntity::GetItem * Fix compile error in SplashPotionEntity.cpp * Fix fix of cSplashPotionEntity API doc * Temporarilly disable fall damage particles These were causing issues in 1.9 due to the changed effect ID. * Properly send a kick packet when connecting with an invalid version This means that the client no longer waits on the server screen with no indication whatsoever. However, right now the server list ping isn't implemented for unknown versions, so it'll only load "Old" on the ping. I also added a GetVarIntSize method to cByteBuffer. This helps clean up part of the code here (and I think it could clean up other parts), but it may make sense for it to be moved elsewhere (or declared in a different way). * Handle server list pings from unrecognized versions This isn't the cleanest way of writing it (it feels odd to use ProtocolRecognizer to send packets, and the addition of m_InPingForUnrecognizedVersion feels like the wrong technique), but it works and I can't think of a better way (apart from creating a full separate protocol class to handle only the ping... which would be worse). * Use cPacketizer for the disconnect packet This also should fix clang build errors. * Add 1.9.3 / 1.9.4 support * Fix incorrect indentation in APIDesc
2016-05-14 15:12:42 -04:00
size_t cByteBuffer::GetVarIntSize(UInt32 a_Value)
{
size_t Count = 0;
do
{
// If the value cannot be expressed in 7 bits, it needs to take up another byte
Count++;
a_Value >>= 7;
} while (a_Value != 0);
return Count;
}