public unsafe int Write(TElement[] value, int valueOffset, int valueCount, ref Buffer <byte> destination,
uint destinationOffset = 0u, MemoryStream temporaryStream = null,
CompressionMethod compression = CompressionMethod.DefaultOrNone)
{
// NB Blosc calls below are visually large - many LOCs with comments, but this is only a single method call
if (value == null)
{
throw new ArgumentNullException(nameof(value));
}
var handle = destination.Pin();
try
{
var ptr = (IntPtr)handle.PinnedPointer + (int)destinationOffset;
if (temporaryStream != null)
{
var len = temporaryStream.Length;
if (destination.Length < destinationOffset + len)
{
return((int)BinaryConverterErrorCode.NotEnoughCapacity);
}
temporaryStream.WriteToPtr(ptr);
temporaryStream.Dispose();
return(checked ((int)len));
}
bool isDiffable = false;
var compressionMethod = compression == CompressionMethod.DefaultOrNone
? BloscSettings.defaultCompressionMethod
: (compression == CompressionMethod.LZ4 ? "lz4" : "zstd");
var position = 8;
if (valueCount > 0)
{
int compressedSize;
if (ItemSize > 0)
{
if (typeof(TElement) == typeof(DateTime))
{
var buffer = BufferPool <byte> .Rent(valueCount * 8);
var dtArray = (DateTime[])(object)value;
fixed(byte *srcPtr = &buffer[0])
{
for (var i = 0; i < valueCount; i++)
{
*(DateTime *)(srcPtr + i * 8) = dtArray[i + valueOffset];
}
compressedSize = BloscMethods.blosc_compress_ctx(
new IntPtr(9), // max compression 9
new IntPtr(1), // do byte shuffle 1
new UIntPtr((uint)ItemSize), // type size
new UIntPtr((uint)(valueCount * ItemSize)), // number of input bytes
(IntPtr)srcPtr,
ptr + position, // destination
new UIntPtr((uint)(destination.Length - position)), // destination length
compressionMethod,
new UIntPtr((uint)0), // default block size
BloscMethods.ProcessorCount //
);
}
BufferPool <byte> .Return(buffer);
}
else if (value[0] is IDiffable <TElement> diffableFirst)
{
isDiffable = true;
// TODO (!) this is probably inefficient... some generic method caching or dynamic dispatch?
// however there is only a single pattern match with IDiffable boxing
var first = value[0];
var buffer = BufferPool <byte> .Rent(valueCount *ItemSize);
fixed(byte *srcPtr = &buffer[0])
{
Unsafe.Write(srcPtr, first);
for (var i = 1; i < valueCount; i++)
{
var current = value[i];
var diff = diffableFirst.GetDelta(current);
Unsafe.Write(srcPtr + i * ItemSize, diff);
}
compressedSize = BloscMethods.blosc_compress_ctx(
new IntPtr(9), // max compression 9
new IntPtr(1), // do byte shuffle 1
new UIntPtr((uint)ItemSize), // type size
new UIntPtr((uint)(valueCount * ItemSize)), // number of input bytes
(IntPtr)srcPtr,
ptr + position, // destination
new UIntPtr((uint)(destination.Length - position)), // destination length
compressionMethod,
new UIntPtr((uint)0), // default block size
BloscMethods.ProcessorCount //
);
}
BufferPool <byte> .Return(buffer);
}
else
{
var pinnedArray = GCHandle.Alloc(value, GCHandleType.Pinned);
var srcPtr = Marshal.UnsafeAddrOfPinnedArrayElement(value, valueOffset);
compressedSize = BloscMethods.blosc_compress_ctx(
new IntPtr(9), // max compression 9
new IntPtr(1), // do byte shuffle 1
new UIntPtr((uint)ItemSize), // type size
new UIntPtr((uint)(valueCount * ItemSize)), // number of input bytes
srcPtr,
ptr + position, // destination
new UIntPtr((uint)(destination.Length - position)), // destination length
compressionMethod,
new UIntPtr((uint)0), // default block size
BloscMethods.ProcessorCount //
);
pinnedArray.Free();
}
}
else if (Buffers.BufferPool.IsPreservedBuffer <TElement>())
{
throw new NotImplementedException();
}
else
{
MemoryStream tempStream;
var bytesSize =
BinarySerializer.SizeOf(new ArraySegment <TElement>(value, valueOffset, valueCount),
out tempStream, compression);
var buffer = BufferPool <byte> .Rent(bytesSize);
var writtenBytes =
BinarySerializer.Write(new ArraySegment <TElement>(value, valueOffset, valueCount), buffer, 0,
tempStream);
tempStream?.Dispose();
Debug.Assert(bytesSize == writtenBytes);
compressedSize = CompressedArrayBinaryConverter <byte> .Instance.Write(buffer, 0, writtenBytes,
ref destination, destinationOffset, null, compression);
BufferPool <byte> .Return(buffer);
}
if (compressedSize > 0)
{
position += compressedSize;
}
else
{
return((int)BinaryConverterErrorCode.NotEnoughCapacity);
}
}
// length
Marshal.WriteInt32(ptr, position);
// version & flags
Marshal.WriteByte(ptr + 4, (byte)((Version << 4) | (isDiffable ? 0b0000_0011 : 0b0000_0001)));
return(position);
}
finally
{
handle.Free();
}
}
public unsafe int Read(IntPtr ptr, out TElement[] value, out int length, bool exactSize = false)
{
var totalSize = Marshal.ReadInt32(ptr);
var versionFlag = Marshal.ReadByte(ptr + 4);
var version = (byte)(versionFlag >> 4);
var isDiffable = (versionFlag & 0b0000_0010) != 0;
var isCompressed = (versionFlag & 0b0000_0001) != 0;
if (!isCompressed)
{
throw new InvalidOperationException("Wrong compressed flag. CompressedArrayBinaryConverter.Read works only with compressed methods.");
}
if (version != Version)
{
throw new NotSupportedException($"CompressedBinaryConverter work only with version {Version}");
}
if (ItemSize <= 0)
{
// first decompress bytes
var size = CompressedArrayBinaryConverter <byte> .Instance.Read(ptr, out byte[] decompressedBytes, out length);
// NB the length is encoded in the header and is returned as a part of ArraySegment
Debug.Assert(length == BitConverter.ToInt32(decompressedBytes, 0));
// then deserialize
// NB the size of the array will be exact, BinarySerializer.Read does not support non-exact buffers
BinarySerializer.Read(decompressedBytes, out value);
BufferPool <byte> .Return(decompressedBytes);
return(size);
}
else if (Buffers.BufferPool.IsPreservedBuffer <TElement>())
{
throw new NotImplementedException();
}
else
{
if (totalSize <= 8 + 16)
{
value = EmptyArray <TElement> .Instance;
length = 0;
return(totalSize);
}
var source = ptr + 8;
// avoid additional P/Invoke call, read header directly
// https://github.com/Blosc/c-blosc/blob/master/README_HEADER.rst
var nbytes = *(int *)(source + 4);
#if DEBUG
var blocksize = *(int *)(source + 8);
var cbytes = *(int *)(source + 12);
var nbytes2 = new UIntPtr();
var cbytes2 = new UIntPtr();
var blocksize2 = new UIntPtr();
BloscMethods.blosc_cbuffer_sizes(source, ref nbytes2, ref cbytes2, ref blocksize2);
Debug.Assert(nbytes == nbytes2.ToUInt32());
Debug.Assert(cbytes == cbytes2.ToUInt32());
Debug.Assert(blocksize == blocksize2.ToUInt32());
#endif
var arraySize = nbytes / ItemSize;
// when caller provides an empty AS, it could require exact size, e.g. DateTimeArrayBinaryConverter
var array = BufferPool <TElement> .Rent(arraySize, exactSize);
length = arraySize;
value = array;
if (arraySize > 0)
{
if (typeof(TElement) == typeof(DateTime))
{
var buffer = BufferPool <byte> .Rent(arraySize * 8);
var dtArray = new DateTime[arraySize];
fixed(byte *tgtPtr = &buffer[0])
{
var destination = (IntPtr)tgtPtr;
var decompSize = BloscMethods.blosc_decompress_ctx(
source, destination, new UIntPtr((uint)nbytes), BloscMethods.ProcessorCount);
if (decompSize <= 0)
{
throw new ArgumentException("Invalid compressed input");
}
Debug.Assert(decompSize == nbytes);
for (var i = 0; i < arraySize; i++)
{
dtArray[i] = *(DateTime *)(destination + i * 8);
}
}
value = (TElement[])(object)(dtArray);
BufferPool <byte> .Return(buffer);
}
else if (isDiffable && typeof(IDiffable <TElement>).GetTypeInfo().IsAssignableFrom(typeof(TElement).GetTypeInfo()))
{
var buffer = BufferPool <byte> .Rent(arraySize *ItemSize);
// TODO Pool these as well. Pool implementation could decide to use just new
var targetArray = BufferPool <TElement> .Rent(arraySize);
fixed(byte *tgtPtr = &buffer[0])
{
var destination = tgtPtr;
var decompSize = BloscMethods.blosc_decompress_ctx(
source, (IntPtr)destination, new UIntPtr((uint)nbytes), BloscMethods.ProcessorCount);
if (decompSize <= 0)
{
throw new ArgumentException("Invalid compressed input");
}
Debug.Assert(decompSize == nbytes);
var first = Unsafe.Read <TElement>(destination);
var diffableFirst = (IDiffable <TElement>)first;
targetArray[0] = first;
for (var i = 1; i < arraySize; i++)
{
var currentDelta = Unsafe.Read <TElement>(destination + i * ItemSize);
var current = diffableFirst.AddDelta(currentDelta);
targetArray[i] = current;
}
}
value = targetArray; // (<TElement>)(object)(new ArraySegment<TElement>(targetArray, 0, arraySize));
BufferPool <byte> .Return(buffer);
}
else
{
var pinnedArray = GCHandle.Alloc(value, GCHandleType.Pinned);
var destination = pinnedArray.AddrOfPinnedObject();
int decompSize = 0;
// TODO remove this try/catch and debugger stuff, it was used tp catch an eror that disappeared after adding
// try/catch. Probably some reordering, maybe add a memory barrier before the call
try
{
decompSize = BloscMethods.blosc_decompress_ctx(
source, destination, new UIntPtr((uint)nbytes), BloscMethods.ProcessorCount);
if (decompSize <= 0)
{
throw new ArgumentException("Invalid compressed input");
}
Debug.Assert(decompSize == nbytes);
}
catch (Exception ex)
{
Debugger.Launch();
UIntPtr nb = UIntPtr.Zero;
UIntPtr cb = UIntPtr.Zero;
UIntPtr bl = UIntPtr.Zero;
BloscMethods.blosc_cbuffer_sizes(source, ref nb, ref cb, ref bl);
//}
Trace.WriteLine($"Blosc error: nbytes: {nbytes}, nbytes2: {nb}, cbytes: {cb} arr size: {value.Length}, \n\r exeption: {ex.Message + Environment.NewLine + ex.ToString()}");
throw;
}
finally
{
pinnedArray.Free();
}
}
}
else
{
// BufferPool returns an empty array
}
return(totalSize);
}
}
public unsafe int Write(TElement[] value, int valueOffset, int valueCount, ref Memory <byte> destination,
uint destinationOffset = 0u, MemoryStream temporaryStream = null,
CompressionMethod compression = CompressionMethod.DefaultOrNone)
{
// NB Blosc calls below are visually large - many LOCs with comments, but this is only a single method call
if (value == null)
{
throw new ArgumentNullException(nameof(value));
}
var handle = destination.Retain(true);
try
{
var ptr = (IntPtr)handle.PinnedPointer + (int)destinationOffset;
if (temporaryStream != null)
{
var len = temporaryStream.Length;
if (destination.Length < destinationOffset + len)
{
return((int)BinaryConverterErrorCode.NotEnoughCapacity);
}
temporaryStream.WriteToPtr(ptr);
temporaryStream.Dispose();
return(checked ((int)len));
}
var compressionMethod = compression == CompressionMethod.DefaultOrNone
? BloscSettings.defaultCompressionMethod
: (compression == CompressionMethod.LZ4 ? "lz4" : "zstd");
var isDelta = IsIDelta;
var position = 8;
if (valueCount > 0)
{
int compressedSize;
if (ItemSize > 0)
{
if (typeof(TElement) == typeof(DateTime))
{
isDelta = true;
Trace.Assert(ItemSize == 8);
var buffer = BufferPool <byte> .Rent(valueCount * 8);
var dtArray = (DateTime[])(object)value;
var first = dtArray[valueOffset];
// NB For DateTime we calculate delta not from the first but
// from the previous value. This is a special case for the
// fact that DT[] is usually increasing by a similar (regular) step
// and the deltas are always positive, small and close to each other.
// In contrast, Price/Decimal could fluctuate in a small range
// and delta from previous could often change its sign, which
// leads to a very different bits and significantly reduces
// the Blosc shuffling benefits. For stationary time series
// deltas from the first value are also stationary and their sign
// changes less frequently that the sign of deltas from previous.
var previousLong = (long *)&first;
fixed(byte *srcPtr = &buffer[0])
{
Unsafe.WriteUnaligned(srcPtr, *previousLong);
for (var i = 1; i < valueCount; i++)
{
var current = dtArray[i + valueOffset];
var currentLong = (long *)(¤t);
var diff = currentLong - previousLong;
Unsafe.WriteUnaligned(srcPtr + i * ItemSize, diff);
previousLong = currentLong;
}
compressedSize = BloscMethods.blosc_compress_ctx(
new IntPtr(9), // max compression 9
new IntPtr(1), // do byte shuffle 1
new UIntPtr((uint)ItemSize), // type size
new UIntPtr((uint)(valueCount * ItemSize)), // number of input bytes
(IntPtr)srcPtr,
ptr + position, // destination
new UIntPtr((uint)(destination.Length - position)), // destination length
compressionMethod,
new UIntPtr((uint)0), // default block size
BloscMethods.ProcessorCount //
);
}
BufferPool <byte> .Return(buffer);
}
else if (IsIDelta)
{
var first = value[valueOffset];
var buffer = BufferPool <byte> .Rent(valueCount *ItemSize);
fixed(byte *srcPtr = &buffer[0])
{
Unsafe.WriteUnaligned(srcPtr, first);
for (var i = 1; i < valueCount; i++)
{
var diff = Unsafe.GetDeltaConstrained(ref first, ref value[valueOffset + i]);
Unsafe.WriteUnaligned(srcPtr + i * ItemSize, diff);
}
compressedSize = BloscMethods.blosc_compress_ctx(
new IntPtr(9), // max compression 9
new IntPtr(1), // do byte shuffle 1
new UIntPtr((uint)ItemSize), // type size
new UIntPtr((uint)(valueCount * ItemSize)), // number of input bytes
(IntPtr)srcPtr,
ptr + position, // destination
new UIntPtr((uint)(destination.Length - position)), // destination length
compressionMethod,
new UIntPtr((uint)0), // default block size
BloscMethods.ProcessorCount //
);
}
BufferPool <byte> .Return(buffer);
}
else
{
var pinnedArray = GCHandle.Alloc(value, GCHandleType.Pinned);
var srcPtr = Marshal.UnsafeAddrOfPinnedArrayElement(value, valueOffset);
compressedSize = BloscMethods.blosc_compress_ctx(
new IntPtr(9), // max compression 9
new IntPtr(1), // do byte shuffle 1
new UIntPtr((uint)ItemSize), // type size
new UIntPtr((uint)(valueCount * ItemSize)), // number of input bytes
srcPtr,
ptr + position, // destination
new UIntPtr((uint)(destination.Length - position)), // destination length
compressionMethod,
new UIntPtr((uint)0), // default block size
BloscMethods.ProcessorCount //
);
pinnedArray.Free();
}
}
else if (Buffers.BufferPool.IsPreservedBuffer <TElement>())
{
throw new NotImplementedException();
}
else
{
MemoryStream tempStream;
var bytesSize =
BinarySerializer.SizeOf(new ArraySegment <TElement>(value, valueOffset, valueCount),
out tempStream, compression);
var buffer = BufferPool <byte> .Rent(bytesSize);
var writtenBytes =
BinarySerializer.Write(new ArraySegment <TElement>(value, valueOffset, valueCount), buffer, 0,
tempStream);
tempStream?.Dispose();
Debug.Assert(bytesSize == writtenBytes);
compressedSize = CompressedArrayBinaryConverter <byte> .Instance.Write(buffer, 0, writtenBytes,
ref destination, destinationOffset, null, compression);
BufferPool <byte> .Return(buffer);
}
if (compressedSize > 0)
{
position += compressedSize;
}
else
{
return((int)BinaryConverterErrorCode.NotEnoughCapacity);
}
}
// length
Marshal.WriteInt32(ptr, position);
// version & flags
Marshal.WriteByte(ptr + 4, (byte)((Version << 4) | (isDelta ? 0b0000_0011 : 0b0000_0001)));
return(position);
}
finally
{
handle.Dispose();
}
}
