using System;
using System.IO;
using System.Runtime.InteropServices;
using System.Text;
namespace Capnp
{
///
/// Supports the deserialization of Cap'n Proto messages from a stream (see https://capnproto.org/encoding.html#serialization-over-a-stream).
/// Packing and compression cannot be handled yet.
///
public static class Framing
{
///
/// Deserializes a message from given stream.
///
/// The stream to read from
/// The deserialized message
/// is null.
/// The stream does not support reading, is null, or is already closed.
/// The end of the stream is reached.
/// The stream is closed.
/// An I/O error occurs.
/// Encountered invalid framing data, too many or too large segments
/// Too many or too large segments, probably due to invalid framing data.
public static WireFrame ReadSegments(Stream stream)
{
using (var reader = new BinaryReader(stream, Encoding.Default, true))
{
return reader.ReadWireFrame();
}
}
///
/// Deserializes the next Cap'n Proto message from given stream.
///
/// The stream to read from
/// The message
public static WireFrame ReadWireFrame(this BinaryReader reader)
{
uint scount = reader.ReadUInt32();
if (scount++ == uint.MaxValue)
{
throw new InvalidDataException("Encountered invalid framing data");
}
// Cannot have more segments than the traversal limit
if (scount >= SecurityOptions.TraversalLimit)
{
throw new InvalidDataException("Too many segments. Probably invalid data. Try increasing the traversal limit.");
}
var buffers = new Memory[scount];
for (uint i = 0; i < scount; i++)
{
uint size = reader.ReadUInt32();
if (size == 0)
{
throw new EndOfStreamException("Stream closed");
}
if (size >= SecurityOptions.TraversalLimit)
{
throw new InvalidDataException("Too large segment. Probably invalid data. Try increasing the traversal limit.");
}
buffers[i] = new Memory(new ulong[size]);
}
if ((scount & 1) == 0)
{
// Padding
reader.ReadUInt32();
}
FillBuffersFromFrames(buffers, scount, reader);
return new WireFrame(buffers);
}
static InvalidDataException StreamClosed()
=> new InvalidDataException("Prematurely reached end of stream. Expected more bytes according to framing header.");
static void FillBuffersFromFrames(Memory[] buffers, uint segmentCount, BinaryReader reader)
{
for (uint i = 0; i < segmentCount; i++)
{
#if NETSTANDARD2_0
var buffer = MemoryMarshal.Cast(buffers[i].Span.ToArray());
var tmpBuffer = reader.ReadBytes(buffer.Length);
if (tmpBuffer.Length != buffer.Length)
{
// Note w.r.t. issue #37: If there are temporarily less bytes available,
// this will NOT cause ReadBytes to return a shorter buffer.
// Only if the end of the stream is reached will we enter this branch. And this will be an error condition,
// since it would mean that the connection was closed in the middle of a frame transfer.
throw StreamClosed();
}
// Fastest way to do this without /unsafe
for (int j = 0; j < buffers[i].Length; j++)
{
var value = BitConverter.ToUInt64(tmpBuffer, j*8);
buffers[i].Span[j] = value;
}
#else
var buffer = MemoryMarshal.Cast(buffers[i].Span);
do
{
int obtained = reader.Read(buffer);
if (obtained == 0)
throw StreamClosed();
buffer = buffer.Slice(obtained);
}
while (buffer.Length > 0);
#endif
}
}
}
}