- be more specific about native types on different platforms

- handle bad image exception
- draft benchmarks

Author: aloneguid

managed/IronCompress.Benchmarks/IronCompress.Benchmarks.csproj

@@ -0,0 +1,18 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+  <PropertyGroup>
+    <OutputType>Exe</OutputType>
+    <TargetFramework>net7.0</TargetFramework>
+    <ImplicitUsings>enable</ImplicitUsings>
+    <Nullable>enable</Nullable>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <PackageReference Include="BenchmarkDotNet" Version="0.13.4" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <ProjectReference Include="..\IronCompress\IronCompress.csproj" />
+  </ItemGroup>
+
+</Project>

managed/IronCompress.Benchmarks/Program.cs

@@ -0,0 +1,35 @@
+using System.IO.Compression;
+using System.Text;
+using BenchmarkDotNet.Attributes;
+using BenchmarkDotNet.Running;
+using IronCompress;
+
+BenchmarkRunner.Run<SpeedBenchmark>();
+
+[ShortRunJob]
+[MarkdownExporter]
+[MemoryDiagnoser]
+public class SpeedBenchmark {
+    private byte[]? _inputBuffer;
+
+    [GlobalSetup]
+    public void Setup() {
+        _inputBuffer = Encoding.UTF8.GetBytes(string.Join("", Enumerable.Repeat("great compression", 1000)));
+    }
+
+    [Benchmark]
+    public void SnappyNative() {
+        var iron = new Iron();
+        iron.ForcePlatform = Platform.Native;
+
+        iron.Compress(Codec.Snappy, _inputBuffer.AsSpan(), null);
+    }
+
+    [Benchmark]
+    public void SnappyManaged() {
+        var iron = new Iron();
+        iron.ForcePlatform = Platform.Managed;
+
+        iron.Compress(Codec.Snappy, _inputBuffer.AsSpan(), null);
+    }
+}

managed/IronCompress.sln

@@ -13,6 +13,8 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution
 		..\docs\README.md = ..\docs\README.md
 	EndProjectSection
 EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "IronCompress.Benchmarks", "IronCompress.Benchmarks\IronCompress.Benchmarks.csproj", "{FB951E3A-3B24-4BB3-89D0-23B4E6013C86}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -27,6 +29,10 @@ Global
 		{24CE97A1-3502-481C-AFF9-891D45B6699D}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{24CE97A1-3502-481C-AFF9-891D45B6699D}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{24CE97A1-3502-481C-AFF9-891D45B6699D}.Release|Any CPU.Build.0 = Release|Any CPU
+		{FB951E3A-3B24-4BB3-89D0-23B4E6013C86}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{FB951E3A-3B24-4BB3-89D0-23B4E6013C86}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{FB951E3A-3B24-4BB3-89D0-23B4E6013C86}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{FB951E3A-3B24-4BB3-89D0-23B4E6013C86}.Release|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE

managed/IronCompress/Iron.cs

@@ -25,6 +25,8 @@ public static bool IsNativeLibraryAvailable {
 
                     } catch(DllNotFoundException) {
                         _isNativeLibraryAvailable = false;
+                    } catch(BadImageFormatException) { 
+                        _isNativeLibraryAvailable = false;
                     }
                 }
 
@@ -44,6 +46,10 @@ static bool SupportsNative(Codec c) {
             return IsNativeLibraryAvailable && Native.is_supported((int)c);
         }
 
+        /// <summary>
+        /// Set to force specific platform. Used mostly in benchmarking tests, prefer not to set.
+        /// </summary>
+        public Platform? ForcePlatform { get; set; }
 
         /// <summary>
         /// Create iron instance
@@ -59,6 +65,14 @@ public IronCompressResult Compress(
             int? outputLength = null,
             CompressionLevel compressionLevel = CompressionLevel.Optimal) {
 
+            if(ForcePlatform != null) { 
+                if(ForcePlatform == Platform.Native) {
+                    return NativeCompressOrDecompress(true, codec, input, compressionLevel, outputLength);
+                } else if(ForcePlatform == Platform.Managed) {
+                    return ManagedCompressOrDecompress(true, codec, input, compressionLevel, outputLength);
+                }
+            }
+
             if(SupportsNative(codec))
                 return NativeCompressOrDecompress(true, codec, input, compressionLevel, outputLength);
 

managed/IronCompress/Platform.cs

@@ -0,0 +1,6 @@
+namespace IronCompress {
+    public enum Platform {
+        Native = 0,
+        Managed = 1
+    }
+}

native/api.cpp

@@ -226,8 +226,8 @@ bool compress_lz4(
     return false;
 }
 
-bool compress(bool compress, int codec, char* input_buffer, int input_buffer_size,
-    char* output_buffer, int* output_buffer_size, int compression_level) {
+bool compress(bool compress, int32_t codec, char* input_buffer, int32_t input_buffer_size,
+    char* output_buffer, int32_t* output_buffer_size, int32_t compression_level) {
     switch(codec) {
         case 1:
             return compress_snappy(compress, input_buffer, input_buffer_size, output_buffer, output_buffer_size);
@@ -245,7 +245,7 @@ bool compress(bool compress, int codec, char* input_buffer, int input_buffer_siz
     }
 }
 
-bool is_supported(int codec) {
+bool is_supported(int32_t codec) {
     return codec == 1 ||
         codec == 2 ||
         // not 3

native/api.h

@@ -1,5 +1,7 @@
 #pragma once
 
+#include <stdint.h>
+
 #ifdef _WIN32
 # ifdef WIN_EXPORT
 #   define EXPORTED  __declspec( dllexport )
@@ -25,19 +27,19 @@ extern "C"
    */
    EXPORTED bool compress(
       bool compress,
-      int codec,
+      int32_t codec,
       char* input_buffer,
-      int input_buffer_size,
+      int32_t input_buffer_size,
       char* output_buffer,
-      int* output_buffer_size,
-      int compression_level);
+      int32_t* output_buffer_size,
+      int32_t compression_level);
 
    /**
     * @brief Checks if particular codec is supported
     * @param codec 
     * @return true if supported, false otherwise
    */
-   EXPORTED bool is_supported(int codec);
+   EXPORTED bool is_supported(int32_t codec);
 
    /**
     * @brief Used to just ping the library to test it's available at all

native/test.cpp

@@ -3,33 +3,31 @@
 
 using namespace std;
 
-bool run(int method, char* buffer, size_t buffer_length)
-{
-   int len{ 0 };
-   bool ok = compress(true, method, buffer, buffer_length, nullptr, &len, 2);
+bool run(int method, char* buffer, size_t buffer_length) {
+    int32_t len{0};
+    bool ok = compress(true, method, buffer, buffer_length, nullptr, &len, 2);
 
-   vector<char> compressed;
-   compressed.resize(len);
+    vector<char> compressed;
+    compressed.resize(len);
 
-   ok = compress(true, method, buffer, buffer_length, 
-       &compressed[0], &len, 2);
+    ok = compress(true, method, buffer, buffer_length,
+        &compressed[0], &len, 2);
 
-   vector<byte> decompressed;
-   int bl1 = buffer_length;
-   decompressed.resize(buffer_length);
-   ok = compress(false, method, &compressed[0], len,
-      (char*)&decompressed[0], &bl1, 2);
+    vector<byte> decompressed;
+    int32_t bl1 = buffer_length;
+    decompressed.resize(buffer_length);
+    ok = compress(false, method, &compressed[0], len,
+       (char*)&decompressed[0], &bl1, 2);
 
-   return ok;
+    return ok;
 }
 
-int main()
-{
-   char bytes[] = {'a', 'b', 'c'};
+int main() {
+    char bytes[] = {'a', 'b', 'c'};
 
-   //run(1, bytes, 3);
-   //run(2, bytes, 3);
-   run(4, bytes, 3);
+    //run(1, bytes, 3);
+    //run(2, bytes, 3);
+    run(4, bytes, 3);
 
-   return 0;
+    return 0;
 }