Managed to python string marshaling cache added.

dse · dse · commit 4c11f106f584 · 2017-09-07T02:03:39.000+04:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -8,6 +8,8 @@ This document follows the conventions laid out in [Keep a CHANGELOG][].
 ## [unreleased][]
 
 ### Added
+-   Improved performance. String marshaling between python and clr now cached. 
+    Cache reduces GC pressure and saves from extensive memory copying.
 -   Added support for embedding python into dotnet core 2.0 (NetStandard 2.0)
 -   Added new build system (pythonnet.15.sln) based on dotnetcore-sdk/xplat(crossplatform msbuild).
     Currently there two side-by-side build systems that produces the same output (net40) from the same sources.
diff --git a/src/runtime/CustomMarshaler.cs b/src/runtime/CustomMarshaler.cs
@@ -18,7 +18,7 @@ public object MarshalNativeToManaged(IntPtr pNativeData)
 
         public abstract IntPtr MarshalManagedToNative(object managedObj);
 
-        public void CleanUpNativeData(IntPtr pNativeData)
+        public virtual void CleanUpNativeData(IntPtr pNativeData)
         {
             Marshal.FreeHGlobal(pNativeData);
         }
@@ -44,7 +44,12 @@ internal class UcsMarshaler : MarshalerBase
         private static readonly MarshalerBase Instance = new UcsMarshaler();
         private static readonly Encoding PyEncoding = Runtime.PyEncoding;
 
-        public override IntPtr MarshalManagedToNative(object managedObj)
+        private const int MaxStringLength = 100;
+        private const int MaxItemSize = 4 * (MaxStringLength + 1);
+        private static readonly EncodedStringsFifoDictionary EncodedStringsDictionary =
+            new EncodedStringsFifoDictionary(10000, MaxItemSize);
+
+        public override unsafe IntPtr MarshalManagedToNative(object managedObj)
         {
             var s = managedObj as string;
 
@@ -53,16 +58,36 @@ public override IntPtr MarshalManagedToNative(object managedObj)
                 return IntPtr.Zero;
             }
 
-            byte[] bStr = PyEncoding.GetBytes(s + "\0");
-            IntPtr mem = Marshal.AllocHGlobal(bStr.Length);
-            try
+            IntPtr mem;
+            int stringBytesCount;
+            if (s.Length <= MaxStringLength)
             {
-                Marshal.Copy(bStr, 0, mem, bStr.Length);
+                if (EncodedStringsDictionary.TryGetValue(s, out mem))
+                {
+                    return mem;
+                }
+
+                stringBytesCount = PyEncoding.GetByteCount(s);
+                mem = EncodedStringsDictionary.AddUnsafe(s);
             }
-            catch (Exception)
+            else
             {
-                Marshal.FreeHGlobal(mem);
-                throw;
+                stringBytesCount = PyEncoding.GetByteCount(s);
+                mem = Marshal.AllocHGlobal(stringBytesCount + 4);
+            }
+
+            fixed (char* str = s)
+            {
+                try
+                {
+                    PyEncoding.GetBytes(str, s.Length, (byte*)mem, stringBytesCount);
+                }
+                catch
+                {
+                    // Do nothing with this. Very strange problem.
+                }
+
+                *(int*)(mem + stringBytesCount) = 0;
             }
 
             return mem;
@@ -106,6 +131,14 @@ public static int GetUnicodeByteLength(IntPtr p)
             }
         }
 
+        public override void CleanUpNativeData(IntPtr pNativeData)
+        {
+            if (!EncodedStringsDictionary.IsKnownPtr(pNativeData))
+            {
+                base.CleanUpNativeData(pNativeData);
+            }
+        }
+
         /// <summary>
         /// Utility function for Marshaling Unicode on PY3 and AnsiStr on PY2.
         /// Use on functions whose Input signatures changed between PY2/PY3.
@@ -118,11 +151,29 @@ public static int GetUnicodeByteLength(IntPtr p)
         /// <remarks>
         /// You MUST deallocate the IntPtr of the Return when done with it.
         /// </remarks>
-        public static IntPtr Py3UnicodePy2StringtoPtr(string s)
+        public unsafe static IntPtr Py3UnicodePy2StringtoPtr(string s)
         {
-            return Runtime.IsPython3
-                ? Instance.MarshalManagedToNative(s)
-                : Marshal.StringToHGlobalAnsi(s);
+            if (Runtime.IsPython3)
+            {
+                int stringBytesCount = PyEncoding.GetByteCount(s);
+                IntPtr mem = Marshal.AllocHGlobal(stringBytesCount + 4);
+                fixed (char* str = s)
+                {
+                    try
+                    {
+                        PyEncoding.GetBytes(str, s.Length, (byte*)mem, stringBytesCount);
+                    }
+                    catch
+                    {
+                        // Do nothing with this. Very strange problem.
+                    }
+
+                    *(int*)(mem + stringBytesCount) = 0;
+                }
+                return mem;
+            }
+
+            return Marshal.StringToHGlobalAnsi(s);
         }
 
         /// <summary>
@@ -208,7 +259,12 @@ internal class Utf8Marshaler : MarshalerBase
         private static readonly MarshalerBase Instance = new Utf8Marshaler();
         private static readonly Encoding PyEncoding = Encoding.UTF8;
 
-        public override IntPtr MarshalManagedToNative(object managedObj)
+        private const int MaxStringLength = 100;
+
+        private static readonly EncodedStringsFifoDictionary EncodedStringsDictionary =
+            new EncodedStringsFifoDictionary(10000, 4 * (MaxStringLength + 1));
+
+        public override unsafe IntPtr MarshalManagedToNative(object managedObj)
         {
             var s = managedObj as string;
 
@@ -217,21 +273,49 @@ public override IntPtr MarshalManagedToNative(object managedObj)
                 return IntPtr.Zero;
             }
 
-            byte[] bStr = PyEncoding.GetBytes(s + "\0");
-            IntPtr mem = Marshal.AllocHGlobal(bStr.Length);
-            try
+            IntPtr mem;
+            int stringBytesCount;
+            if (s.Length <= MaxStringLength)
             {
-                Marshal.Copy(bStr, 0, mem, bStr.Length);
+                if (EncodedStringsDictionary.TryGetValue(s, out mem))
+                {
+                    return mem;
+                }
+
+                stringBytesCount = PyEncoding.GetByteCount(s);
+                mem = EncodedStringsDictionary.AddUnsafe(s);
             }
-            catch (Exception)
+            else
             {
-                Marshal.FreeHGlobal(mem);
-                throw;
+                stringBytesCount = PyEncoding.GetByteCount(s);
+                mem = Marshal.AllocHGlobal(stringBytesCount + 1);
+            }
+
+            fixed (char* str = s)
+            {
+                try
+                {
+                    PyEncoding.GetBytes(str, s.Length, (byte*)mem, stringBytesCount);
+                }
+                catch
+                {
+                    // Do nothing with this. Very strange problem.
+                }
+
+                ((byte*)mem)[stringBytesCount] = 0;
             }
 
             return mem;
         }
 
+        public override void CleanUpNativeData(IntPtr pNativeData)
+        {
+            if (!EncodedStringsDictionary.IsKnownPtr(pNativeData))
+            {
+                base.CleanUpNativeData(pNativeData);
+            }
+        }
+
         public static ICustomMarshaler GetInstance(string cookie)
         {
             return Instance;
