Merge pull request #948 from libgit2/ntk/filters_stream_rebound

Filters stream rebound

Author: fat16

Lib/NativeBinaries/amd64/git2-a2012c4.dll

@@ -347,6 +347,54 @@ public void WhenCheckingOutAFileFileSmudgeWritesCorrectFileToWorkingDirectory()
             GlobalSettings.DeregisterFilter(filter);
         }
 
+        [Fact]
+        public void FilterStreamsAreCoherent()
+        {
+            string repoPath = InitNewRepository();
+
+            bool? inputCanWrite = null, inputCanRead = null, inputCanSeek = null;
+            bool? outputCanWrite = null, outputCanRead = null, outputCanSeek = null;
+
+            Func<Stream, Stream, int> assertor = (input, output) =>
+            {
+                inputCanRead = input.CanRead;
+                inputCanWrite = input.CanWrite;
+                inputCanSeek = input.CanSeek;
+
+                outputCanRead = output.CanRead;
+                outputCanWrite = output.CanWrite;
+                outputCanSeek = output.CanSeek;
+
+                return GitPassThrough;
+            };
+
+            var filter = new FakeFilter(FilterName + 18, Attribute, checkSuccess, assertor, assertor);
+
+            GlobalSettings.RegisterFilter(filter);
+
+            using (var repo = CreateTestRepository(repoPath))
+            {
+                StageNewFile(repo);
+            }
+
+            GlobalSettings.DeregisterFilter(filter);
+
+            Assert.True(inputCanRead.HasValue);
+            Assert.True(inputCanWrite.HasValue);
+            Assert.True(inputCanSeek.HasValue);
+            Assert.True(outputCanRead.HasValue);
+            Assert.True(outputCanWrite.HasValue);
+            Assert.True(outputCanSeek.HasValue);
+
+            Assert.True(inputCanRead.Value);
+            Assert.False(inputCanWrite.Value);
+            Assert.False(inputCanSeek.Value);
+
+            Assert.False(outputCanRead.Value);
+            Assert.True(outputCanWrite.Value);
+            Assert.False(outputCanSeek.Value);
+        }
+
         private FileInfo CheckoutFileForSmudge(string repoPath, string branchName, string content)
         {
             FileInfo expectedPath;

Lib/NativeBinaries/amd64/git2-e0902fb.pdb renamed to Lib/NativeBinaries/amd64/git2-a2012c4.pdb

@@ -93,4 +93,4 @@ private static Blob CommitOnBranchAndReturnDatabaseBlob(Repository repo, string
             return blob;
         }
     }
-}
+}

Lib/NativeBinaries/amd64/git2-e0902fb.dll

@@ -1,6 +1,5 @@
 using System.Collections.Generic;
 using System.IO;
-using System.Linq;
 using System.Text;
 
 namespace LibGit2Sharp.Tests.TestHelpers
@@ -59,4 +58,4 @@ public static int RotateByThirteenPlaces(Stream input, Stream output)
             }
         }
     }
-}
+}

Lib/NativeBinaries/x86/git2-a2012c4.dll

@@ -10,8 +10,6 @@ namespace LibGit2Sharp.Core
     /// </summary>
     internal class GitBufReadStream : UnmanagedMemoryStream
     {
-        private readonly GitBuf gitBuf;
-
         internal GitBufReadStream(IntPtr gitBufPointer)
             : this(gitBufPointer.MarshalAs<GitBuf>())
         { }
@@ -21,17 +19,7 @@ private unsafe GitBufReadStream(GitBuf gitBuf)
                    ConvertToLong(gitBuf.size),
                    ConvertToLong(gitBuf.asize),
                    FileAccess.Read)
-        {
-            this.gitBuf = gitBuf;
-        }
-
-        protected override void Dispose(bool disposing)
-        {
-            base.Dispose(disposing);
-
-            if (disposing && gitBuf != default(GitBuf))
-                gitBuf.Dispose();
-        }
+        { }
 
         private static long ConvertToLong(UIntPtr len)
         {
@@ -46,5 +34,15 @@ private static long ConvertToLong(UIntPtr len)
 
             return (long)len.ToUInt64();
         }
+
+        public override long Seek(long offset, SeekOrigin loc)
+        {
+            throw new NotSupportedException();
+        }
+
+        public override bool CanSeek
+        {
+            get { return false; }
+        }
     }
 }

Lib/NativeBinaries/x86/git2-e0902fb.pdb renamed to Lib/NativeBinaries/x86/git2-a2012c4.pdb

@@ -1,53 +1,91 @@
 using System;
 using System.IO;
-using System.Runtime.InteropServices;
 using LibGit2Sharp.Core.Handles;
 
 namespace LibGit2Sharp.Core
 {
-    /// <summary>
-    /// Writes data to a <see cref="GitBuf"/> pointer
-    /// </summary>
-    internal class GitBufWriteStream : MemoryStream
+    internal class GitBufWriteStream : Stream
     {
         private readonly IntPtr gitBufPointer;
 
         internal GitBufWriteStream(IntPtr gitBufPointer)
         {
             this.gitBufPointer = gitBufPointer;
+
+            //Preallocate the buffer
+            Proxy.git_buf_grow(gitBufPointer, 1024);
+        }
+
+        public override void Flush()
+        {
         }
 
-        protected override void Dispose(bool disposing)
+        public override long Seek(long offset, SeekOrigin origin)
         {
-            if (base.CanSeek) // False if stream has already been written/closed
+            throw new NotSupportedException();
+        }
+
+        public override void SetLength(long value)
+        {
+            throw new NotSupportedException();
+        }
+
+        public override int Read(byte[] buffer, int offset, int count)
+        {
+            throw new NotSupportedException();
+        }
+
+        public override void Write(byte[] buffer, int offset, int count)
+        {
+            AutoGrowBuffer(count);
+
+            Proxy.git_buf_put(gitBufPointer, buffer, offset, count);
+        }
+
+        private void AutoGrowBuffer(int count)
+        {
+            var gitBuf = gitBufPointer.MarshalAs<GitBuf>();
+
+            var asize = (uint)gitBuf.asize;
+            var size = (uint)gitBuf.size;
+
+            var isBufferLargeEnoughToHoldTheNewData = (asize - size) > count;
+            var filledBufferPercentage = (100.0 * size / asize);
+
+            if (isBufferLargeEnoughToHoldTheNewData && filledBufferPercentage < 90)
             {
-                using (var gitBuf = gitBufPointer.MarshalAs<GitBuf>())
-                {
-                    WriteTo(gitBuf);
-                }
+                return;
             }
 
-            base.Dispose(disposing);
+            var targetSize = (uint)(1.5 * (asize + count));
+
+            Proxy.git_buf_grow(gitBufPointer, targetSize);
         }
 
-        private void WriteTo(GitBuf gitBuf)
+        public override bool CanRead
         {
-            Seek(0, SeekOrigin.Begin);
+            get { return false; }
+        }
 
-            var length = (int)Length;
-            var bytes = new byte[length];
-            Read(bytes, 0, length);
+        public override bool CanSeek
+        {
+            get { return false; }
+        }
 
-            IntPtr reverseBytesPointer = Marshal.AllocHGlobal(length);
-            Marshal.Copy(bytes, 0, reverseBytesPointer, bytes.Length);
+        public override bool CanWrite
+        {
+            get { return true; }
+        }
 
-            var size = (UIntPtr)length;
-            var allocatedSize = (UIntPtr)length;
-            NativeMethods.git_buf_set(gitBuf, reverseBytesPointer, size);
-            gitBuf.size = size;
-            gitBuf.asize = allocatedSize;
+        public override long Length
+        {
+            get { throw new NotSupportedException(); }
+        }
 
-            Marshal.StructureToPtr(gitBuf, gitBufPointer, true);
+        public override long Position
+        {
+            get { throw new NotSupportedException(); }
+            set { throw new NotSupportedException(); }
         }
     }
 }

Lib/NativeBinaries/x86/git2-e0902fb.dll

@@ -2,6 +2,6 @@ namespace LibGit2Sharp.Core
 {
 	internal static class NativeDllName
 	{
-		public const string Name = "git2-e0902fb";
+		public const string Name = "git2-a2012c4";
 	}
 }

LibGit2Sharp.Tests/FilterFixture.cs

@@ -222,10 +222,10 @@ internal static extern int git_branch_remote_name(
             [MarshalAs(UnmanagedType.CustomMarshaler, MarshalCookie = UniqueId.UniqueIdentifier, MarshalTypeRef = typeof(StrictUtf8Marshaler))] string canonical_branch_name);
 
         [DllImport(libgit2)]
-        internal static extern int git_buf_grow(GitBuf buffer, UIntPtr targetSize);
+        internal static extern int git_buf_grow(IntPtr buffer, UIntPtr targetSize);
 
         [DllImport(libgit2)]
-        internal static extern int git_buf_set(GitBuf buffer, IntPtr data, UIntPtr targetSize);
+        internal static extern int git_buf_put(IntPtr buffer, IntPtr data, UIntPtr len);
 
         [DllImport(libgit2)]
         internal static extern int git_remote_rename(

LibGit2Sharp.Tests/SubstitutionCipherFilterFixture.cs

@@ -241,6 +241,33 @@ public static string git_branch_upstream_name(RepositorySafeHandle handle, strin
 
         #region git_buf_
 
+        public static void git_buf_grow(IntPtr gitBufPointer, uint target_size)
+        {
+            using (ThreadAffinity())
+            {
+                var res = NativeMethods.git_buf_grow(gitBufPointer, (UIntPtr)target_size);
+                Ensure.ZeroResult(res);
+            }
+        }
+
+        public static void git_buf_put(IntPtr gitBufPointer, byte[] data, int offset, int count)
+        {
+            using (ThreadAffinity())
+            {
+                unsafe
+                {
+                    int res;
+
+                    fixed (byte* ptr = data)
+                    {
+                        res = NativeMethods.git_buf_put(gitBufPointer, (IntPtr)ptr, (UIntPtr)count);
+                    }
+
+                    Ensure.ZeroResult(res);
+                }
+            }
+        }
+
         public static void git_buf_free(GitBuf buf)
         {
             NativeMethods.git_buf_free(buf);

LibGit2Sharp.Tests/TestHelpers/SubstitutionCipherFilter.cs

@@ -23,7 +23,7 @@ public abstract class Filter : IEquatable<Filter>
 
         /// <summary>
         /// Initializes a new instance of the <see cref="Filter"/> class.
-        /// And allocates the filter natively. 
+        /// And allocates the filter natively.
         /// <param name="name">The unique name with which this filtered is registered with</param>
         /// <param name="attributes">A list of filterForAttributes which this filter applies to</param>
         /// </summary>
@@ -33,7 +33,7 @@ protected Filter(string name, IEnumerable<string> attributes)
 
         /// <summary>
         /// Initializes a new instance of the <see cref="Filter"/> class.
-        /// And allocates the filter natively. 
+        /// And allocates the filter natively.
         /// <param name="name">The unique name with which this filtered is registered with</param>
         /// <param name="attributes">Either a single attribute, or a comma separated list of filterForAttributes for which this filter applies to</param>
         /// </summary>
@@ -87,10 +87,10 @@ internal GitFilter ManagedFilter
 
         /// <summary>
         /// Initialize callback on filter
-        /// 
+        ///
         /// Specified as `filter.initialize`, this is an optional callback invoked
         /// before a filter is first used.  It will be called once at most.
-        /// 
+        ///
         /// If non-NULL, the filter's `initialize` callback will be invoked right
         /// before the first use of the filter, so you can defer expensive
         /// initialization operations (in case libgit2 is being used in a way that doesn't need the filter).
@@ -191,10 +191,10 @@ public override int GetHashCode()
 
         /// <summary>
         /// Initialize callback on filter
-        /// 
+        ///
         /// Specified as `filter.initialize`, this is an optional callback invoked
         /// before a filter is first used.  It will be called once at most.
-        /// 
+        ///
         /// If non-NULL, the filter's `initialize` callback will be invoked right
         /// before the first use of the filter, so you can defer expensive
         /// initialization operations (in case libgit2 is being used in a way that doesn't need the filter).
@@ -207,15 +207,15 @@ int InitializeCallback(IntPtr gitFilter)
         /// <summary>
         /// Callback to decide if a given source needs this filter
         /// Specified as `filter.check`, this is an optional callback that checks if filtering is needed for a given source.
-        /// 
-        /// It should return 0 if the filter should be applied (i.e. success), GIT_PASSTHROUGH if the filter should 
+        ///
+        /// It should return 0 if the filter should be applied (i.e. success), GIT_PASSTHROUGH if the filter should
         /// not be applied, or an error code to fail out of the filter processing pipeline and return to the caller.
-        /// 
+        ///
         /// The `attr_values` will be set to the values of any filterForAttributes given in the filter definition.  See `git_filter` below for more detail.
-        /// 
-        /// The `payload` will be a pointer to a reference payload for the filter. This will start as NULL, but `check` can assign to this 
+        ///
+        /// The `payload` will be a pointer to a reference payload for the filter. This will start as NULL, but `check` can assign to this
         /// pointer for later use by the `apply` callback.  Note that the value should be heap allocated (not stack), so that it doesn't go
-        /// away before the `apply` callback can use it.  If a filter allocates and assigns a value to the `payload`, it will need a `cleanup` 
+        /// away before the `apply` callback can use it.  If a filter allocates and assigns a value to the `payload`, it will need a `cleanup`
         /// callback to free the payload.
         /// </summary>
         /// <returns></returns>
@@ -230,12 +230,12 @@ int CheckCallback(GitFilter gitFilter, IntPtr payload, IntPtr filterSourcePtr, I
 
         /// <summary>
         /// Callback to actually perform the data filtering
-        /// 
-        /// Specified as `filter.apply`, this is the callback that actually filters data.  
+        ///
+        /// Specified as `filter.apply`, this is the callback that actually filters data.
         /// If it successfully writes the output, it should return 0.  Like `check`,
-        /// it can return GIT_PASSTHROUGH to indicate that the filter doesn't want to run. 
+        /// it can return GIT_PASSTHROUGH to indicate that the filter doesn't want to run.
         /// Other error codes will stop filter processing and return to the caller.
-        /// 
+        ///
         /// The `payload` value will refer to any payload that was set by the `check` callback.  It may be read from or written to as needed.
         /// </summary>
         int ApplyCallback(GitFilter gitFilter, IntPtr payload,
@@ -251,4 +251,4 @@ int ApplyCallback(GitFilter gitFilter, IntPtr payload,
             }
         }
     }
-}
+}

LibGit2Sharp/Core/GitBufReadStream.cs

@@ -1 +1 @@
-e0902fbce7d14631bd02091c1c70cde3e68f78ab
+a2012c43899e6616366b47d7741b3f035e825e84