Some minor performance changes for .net6+ (#149)

1. Add a new Benchmark
2. Add a useTempFile option to the constructors (breaks binary compatibility, need to add overrides). 
3. Some small performance enhancements to avoid doing Marshal.Copy.
4. Add a new WriteExtraFields which takes a `params` to allow us to simplify some code .

Author: dellis1972

LibZipSharp.UnitTest/ZipTests.cs

@@ -330,22 +330,22 @@ public void SimulateXamarinAndroidUsage ([Values (true, false)] bool copyArchive
 		}
 
 		[Test]
-		public void InMemoryZipFile ()
+		public void InMemoryZipFile ([Values (true, false)] bool useTempFile)
 		{
 			string filePath = Path.GetFullPath ("info.json");
 			if (!File.Exists (filePath)) {
 				filePath = Path.GetFullPath (Path.Combine ("LibZipSharp.UnitTest", "info.json"));
 			}
 			string fileRoot = Path.GetDirectoryName (filePath);
 			using (var stream = new MemoryStream ()) {
-				using (var zip = ZipArchive.Create (stream)) {
+				using (var zip = ZipArchive.Create (stream, useTempFile: useTempFile)) {
 					zip.AddFile (filePath, "info.json");
 					zip.AddFile (Path.Combine (fileRoot, "characters_players.json"), "characters_players.json");
 					zip.AddFile (Path.Combine (fileRoot, "object_spawn.json"), "object_spawn.json");
 				}
 
 				stream.Position = 0;
-				using (var zip = ZipArchive.Open (stream, strictConsistencyChecks: true)) {
+				using (var zip = ZipArchive.Open (stream, strictConsistencyChecks: true, useTempFile: useTempFile)) {
 					Assert.AreEqual (3, zip.EntryCount);
 					foreach (var e in zip) {
 						Console.WriteLine (e.FullName);
@@ -354,13 +354,13 @@ public void InMemoryZipFile ()
 				}
 
 				stream.Position = 0;
-				using (var zip = ZipArchive.Open (stream, strictConsistencyChecks: true)) {
+				using (var zip = ZipArchive.Open (stream, strictConsistencyChecks: true, useTempFile: useTempFile)) {
 					Assert.AreEqual (2, zip.EntryCount);
 					zip.AddEntry ("info.json", File.ReadAllText (filePath), Encoding.UTF8, CompressionMethod.Deflate);
 				}
 
 				stream.Position = 0;
-				using (var zip = ZipArchive.Open (stream)) {
+				using (var zip = ZipArchive.Open (stream, useTempFile: useTempFile)) {
 					Assert.AreEqual (3, zip.EntryCount);
 					Assert.IsTrue (zip.ContainsEntry ("info.json"));
 					var entry1 = zip.ReadEntry ("info.json");

LibZipSharp/Xamarin.Tools.Zip/IPlatformServices.cs

@@ -48,6 +48,7 @@ public interface IPlatformServices
 		bool SetEntryPermissions (ZipArchive archive, ulong index, EntryPermissions permissions, bool isDirectory);
 		bool ReadAndProcessExtraFields (ZipEntry entry);
 		bool WriteExtraFields (ZipArchive archive, ZipEntry entry, IList<ExtraField> extraFields);
+		bool WriteExtraFields (ZipArchive archive, ZipEntry entry, params ExtraField[] extraFields);
 		bool SetFileProperties (ZipEntry entry, string extractedFilePath, bool throwOnNativeErrors);
 		bool ExtractSpecialFile (ZipEntry entry, string destinationDir);
 	}

LibZipSharp/Xamarin.Tools.Zip/PlatformServices.cs

@@ -137,7 +137,15 @@ public void ReadAndProcessExtraFields (ZipEntry entry)
 			CallServices ((IPlatformServices services) => services.ReadAndProcessExtraFields (entry));
 		}
 
-		public bool WriteExtraFields (ZipArchive archive, ZipEntry entry, IList<ExtraField> extraFields = null)
+		public bool WriteExtraFields (ZipArchive archive, ZipEntry entry, IList<ExtraField> extraFields)
+		{
+			if (entry == null)
+				throw new ArgumentNullException (nameof (entry));
+
+			return CallServices ((IPlatformServices services) => services.WriteExtraFields (archive, entry, extraFields));
+		}
+
+		public bool WriteExtraFields (ZipArchive archive, ZipEntry entry, params ExtraField[] extraFields)
 		{
 			if (entry == null)
 				throw new ArgumentNullException (nameof (entry));

LibZipSharp/Xamarin.Tools.Zip/UnixPlatformServices.cs

@@ -300,6 +300,11 @@ void ForEachExtraField (IList<ExtraField> fields, bool local, Action<ExtraField>
 		}
 
 		public bool WriteExtraFields (ZipArchive archive, ZipEntry entry, IList<ExtraField> extraFields)
+		{
+			return WriteExtraFields (archive, entry, extraFields.ToArray ());
+		}
+
+		public bool WriteExtraFields (ZipArchive archive, ZipEntry entry, params ExtraField[] extraFields)
 		{
 			if (entry == null)
 				return false;

LibZipSharp/Xamarin.Tools.Zip/UnixZipArchive.cs

@@ -44,7 +44,7 @@ internal UnixZipArchive (string defaultExtractionDir, UnixPlatformOptions option
 		{
 		}
 
-		internal UnixZipArchive (Stream stream, UnixPlatformOptions options, OpenFlags flags) : base (stream, options, flags)
+		internal UnixZipArchive (Stream stream, UnixPlatformOptions options, OpenFlags flags, bool useTempFile) : base (stream, options, flags, useTempFile)
 		{
 		}
 

LibZipSharp/Xamarin.Tools.Zip/WindowsPlatformServices.cs

@@ -229,6 +229,11 @@ public bool StoreSpecialFile (ZipArchive archive, string sourcePath, string arch
 		}
 
 		public bool WriteExtraFields (ZipArchive archive, ZipEntry entry, IList<ExtraField> extraFields)
+		{
+			return WriteExtraFields (archive, entry, extraFields.ToArray ());
+		}
+
+		public bool WriteExtraFields (ZipArchive archive, ZipEntry entry, params ExtraField[] extraFields)
 		{
 			if (entry == null)
 				return false;

LibZipSharp/Xamarin.Tools.Zip/WindowsZipArchive.cs

@@ -44,7 +44,7 @@ internal WindowsZipArchive (string defaultExtractionDir, WindowsPlatformOptions
 		{
 		}
 
-		internal WindowsZipArchive (Stream stream, WindowsPlatformOptions options, OpenFlags flags) : base (stream, options, flags)
+		internal WindowsZipArchive (Stream stream, WindowsPlatformOptions options, OpenFlags flags, bool useTempFile) : base (stream, options, flags, useTempFile)
 		{
 		}
 

LibZipSharp/Xamarin.Tools.Zip/ZipArchive.Unix.cs

@@ -16,13 +16,13 @@ static ZipArchive CreateArchiveInstance (string defaultExtractionDir, IPlatformO
 			}
 		}
 
-		static ZipArchive CreateInstanceFromStream (Stream stream, OpenFlags flags = OpenFlags.RDOnly, IPlatformOptions options = null)
+		static ZipArchive CreateInstanceFromStream (Stream stream, OpenFlags flags = OpenFlags.RDOnly, IPlatformOptions options = null, bool useTempFile = true)
 		{
 			if (Environment.OSVersion.Platform == PlatformID.Unix) {
-				return new UnixZipArchive (stream, EnsureOptions (options) as UnixPlatformOptions, flags);
+				return new UnixZipArchive (stream, EnsureOptions (options) as UnixPlatformOptions, flags, useTempFile);
 			}
 			else {
-				return new WindowsZipArchive (stream, EnsureOptions (options) as WindowsPlatformOptions, flags);
+				return new WindowsZipArchive (stream, EnsureOptions (options) as WindowsPlatformOptions, flags, useTempFile);
 			}
 		}
 

LibZipSharp/Xamarin.Tools.Zip/ZipArchive.cs

@@ -30,6 +30,7 @@
 using System.Collections.Generic;
 using System.Diagnostics;
 using System.IO;
+using System.Net.Mime;
 using System.Runtime.InteropServices;
 using System.Text;
 using Xamarin.Tools.Zip.Properties;
@@ -42,9 +43,10 @@ namespace Xamarin.Tools.Zip
 	public abstract partial class ZipArchive : IDisposable, IEnumerable <ZipEntry>
 	{
 		internal class CallbackContext {
-			public Stream Source { get; set; } = null;
-			public Stream Destination {get; set;} = null;
-			public string DestinationFileName {get; set; } = null;
+			public Stream Source = null;
+			public Stream Destination = null;
+			public string DestinationFileName = null;
+			public bool UseTempFile = true;
 		}
 		public const EntryPermissions DefaultFilePermissions = EntryPermissions.OwnerRead | EntryPermissions.OwnerWrite | EntryPermissions.GroupRead | EntryPermissions.WorldRead;
 		public const EntryPermissions DefaultDirectoryPermissions = EntryPermissions.OwnerAll | EntryPermissions.GroupRead | EntryPermissions.GroupExecute |  EntryPermissions.WorldRead | EntryPermissions.WorldExecute;
@@ -106,7 +108,7 @@ internal ZipArchive (string defaultExtractionDir, IPlatformOptions options)
 			Options = options;
 		}
 
-		internal ZipArchive (Stream stream, IPlatformOptions options, OpenFlags flags = OpenFlags.RDOnly)
+		internal ZipArchive (Stream stream, IPlatformOptions options, OpenFlags flags = OpenFlags.RDOnly, bool useTempFile = true)
 		{
 			if (options == null)
 				throw new ArgumentNullException (nameof (options));
@@ -115,6 +117,7 @@ internal ZipArchive (Stream stream, IPlatformOptions options, OpenFlags flags =
 			CallbackContext context = new CallbackContext () {
 				Source = stream,
 				Destination = null,
+				UseTempFile = useTempFile,
 			};
 			var contextHandle = GCHandle.Alloc (context, GCHandleType.Normal);
 			IntPtr source = Native.zip_source_function_create (callback, GCHandle.ToIntPtr (contextHandle), out errorp);
@@ -197,12 +200,13 @@ ErrorCode Open (string path, OpenFlags flags)
 		/// <param name="stream">The stream to open</param>
 		/// <param name="options">Platform-specific options</param>
 		/// <param name="strictConsistencyChecks">Perform strict consistency checks.</param>
-		public static ZipArchive Open (Stream stream, IPlatformOptions options = null, bool strictConsistencyChecks = false)
+		/// <param name="useTempFile">Use a temporary file for the archive</param>
+		public static ZipArchive Open (Stream stream, IPlatformOptions options = null, bool strictConsistencyChecks = false, bool useTempFile = true)
 		{
 			OpenFlags flags = OpenFlags.None;
 			if (strictConsistencyChecks)
 				flags |= OpenFlags.CheckCons;
-			return ZipArchive.CreateInstanceFromStream (stream, flags, options);
+			return ZipArchive.CreateInstanceFromStream (stream, flags, options, useTempFile);
 		}
 
 		/// <summary>
@@ -211,12 +215,13 @@ public static ZipArchive Open (Stream stream, IPlatformOptions options = null, b
 		/// <param name="stream">The stream to create the arhive in</param>
 		/// <param name="options">Platform-specific options</param>
 		/// <param name="strictConsistencyChecks">Perform strict consistency checks.</param>
-		public static ZipArchive Create (Stream stream, IPlatformOptions options = null, bool strictConsistencyChecks = false)
+		/// <param name="useTempFile">Use a temporary file for the archive</param>
+		public static ZipArchive Create (Stream stream, IPlatformOptions options = null, bool strictConsistencyChecks = false, bool useTempFile = true)
 		{
 			OpenFlags flags = OpenFlags.Create | OpenFlags.Truncate;
 			if (strictConsistencyChecks)
 				flags |= OpenFlags.CheckCons;
-			return ZipArchive.CreateInstanceFromStream (stream, flags, options);
+			return ZipArchive.CreateInstanceFromStream (stream, flags, options, useTempFile);
 		}
 
 		/// <summary>
@@ -231,8 +236,9 @@ public static ZipArchive Create (Stream stream, IPlatformOptions options = null,
 		/// <param name="defaultExtractionDir">default target directory</param>
 		/// <param name="strictConsistencyChecks">Perform strict consistency checks.</param>
 		/// <param name="options">Platform-specific options, or <c>null</c> if none necessary (the default)</param>
+		/// <param name="useTempFile">Use a temporary file for the archive</param>
 		/// <returns>Opened ZIP archive</returns>
-		public static ZipArchive Open (string path, FileMode mode, string defaultExtractionDir = null, bool strictConsistencyChecks = false, IPlatformOptions options = null)
+		public static ZipArchive Open (string path, FileMode mode, string defaultExtractionDir = null, bool strictConsistencyChecks = false, IPlatformOptions options = null, bool useTempFile = true)
 		{
 			if (String.IsNullOrEmpty (path))
 				throw new ArgumentException (string.Format (Resources.MustNotBeNullOrEmpty_string, nameof (path)), nameof (path));
@@ -316,7 +322,7 @@ public static ZipArchive Open (string path, FileMode mode, string defaultExtract
 		/// Extracts all the entries from the archive and places them in the
 		/// directory indicated by the <paramref name="destinationDirectory"/> parameter.
 		/// If <paramref name="destinationDirectory"/> is <c>null</c> or empty, the default destination directory
-		/// as passed to <see cref="ZipArchive.Open (string,FileMode,string,bool,IPlatformOptions)"/> is used.
+		/// as passed to <see cref="ZipArchive.Open (string,FileMode,string,bool,IPlatformOptions, bool)"/> is used.
 		/// </summary>
 		/// <returns>The all.</returns>
 		/// <param name="destinationDirectory">Destination directory.</param>
@@ -362,7 +368,7 @@ public ZipEntry AddStream (Stream stream, string archivePath, EntryPermissions p
 			sources.Add (stream);
 			string destPath = EnsureArchivePath (archivePath);
 			var context = new CallbackContext () {
-				Source = stream,
+				Source = stream
 			};
 			var handle = GCHandle.Alloc (context, GCHandleType.Normal);
 			IntPtr h = GCHandle.ToIntPtr (handle);
@@ -376,14 +382,15 @@ public ZipEntry AddStream (Stream stream, string archivePath, EntryPermissions p
 				permissions = DefaultFilePermissions;
 			PlatformServices.Instance.SetEntryPermissions (this, (ulong)index, permissions, false);
 			ZipEntry entry = ReadEntry ((ulong)index);
-			IList<ExtraField> fields = new List<ExtraField> ();
 			ExtraField_ExtendedTimestamp timestamp = new ExtraField_ExtendedTimestamp (entry, 0, modificationTime: modificationTime ?? DateTime.UtcNow);
-			fields.Add (timestamp);
-			if (!PlatformServices.Instance.WriteExtraFields (this, entry, fields))
+			timestamp.Encode ();
+			if (!PlatformServices.Instance.WriteExtraFields (this, entry, timestamp)) {
 				throw GetErrorException ();
+			}
 			return entry;
 		}
 
+
 		/// <summary>
 		/// Adds the file to archive directory. The file is added to either the root directory of
 		/// the ZIP archive (if <paramref name="archiveDirectory"/> is <c>null</c> or empty) or to
@@ -455,16 +462,16 @@ public ZipEntry AddFile (string sourcePath, string archivePath = null,
 				throw GetErrorException ();
 			PlatformServices.Instance.SetEntryPermissions (this, sourcePath, (ulong)index, permissions);
 			ZipEntry entry = ReadEntry ((ulong)index);
-			IList<ExtraField> fields = new List<ExtraField> ();
 			ExtraField_ExtendedTimestamp timestamp = new ExtraField_ExtendedTimestamp (
 				entry, 0,
 				createTime: File.GetCreationTimeUtc (sourcePath),
 				accessTime: File.GetLastAccessTimeUtc (sourcePath),
 				modificationTime: File.GetLastWriteTimeUtc (sourcePath)
 			);
-			fields.Add (timestamp);
-			if (!PlatformServices.Instance.WriteExtraFields (this, entry, fields))
+			timestamp.Encode ();
+			if (!PlatformServices.Instance.WriteExtraFields (this, entry, timestamp)) {
 				throw GetErrorException ();
+			}
 			return entry;
 		}
 
@@ -796,7 +803,9 @@ internal ZipException GetErrorException ()
 
 		internal static unsafe Int64 stream_callback (IntPtr state, IntPtr data, UInt64 len, SourceCommand cmd)
 		{
+#if !NET6_0_OR_GREATER
 			byte [] buffer = null;
+#endif
 			Native.zip_error_t error;
 			int length = (int)len;
 			var handle = GCHandle.FromIntPtr (state);
@@ -828,6 +837,14 @@ internal static unsafe Int64 stream_callback (IntPtr state, IntPtr data, UInt64
 					return (Int64)destination.Position;
 
 				case SourceCommand.Write:
+#if NET6_0_OR_GREATER
+					unsafe
+					{
+						byte* ptr = (byte*)data;
+						destination.Write(new ReadOnlySpan<byte>(ptr, length));
+					}
+					return length;
+#else
 					buffer = ArrayPool<byte>.Shared.Rent (length);
 					try {
 						Marshal.Copy (data, buffer, 0, length);
@@ -836,7 +853,7 @@ internal static unsafe Int64 stream_callback (IntPtr state, IntPtr data, UInt64
 					} finally {
 						ArrayPool<byte>.Shared.Return (buffer);
 					}
-
+#endif
 				case SourceCommand.SeekWrite:
 					Native.zip_source_args_seek_t args;
 					if (!Native.ZipSourceGetArgs (data, len, out args)) {
@@ -895,6 +912,14 @@ internal static unsafe Int64 stream_callback (IntPtr state, IntPtr data, UInt64
 
 				case SourceCommand.Read:
 					length = (int)Math.Min (stream.Length - stream.Position, length);
+#if NET6_0_OR_GREATER
+					unsafe
+					{
+						byte* ptr = (byte*)data;
+						int bytesRead = stream.Read(new Span<byte>(ptr, length));
+						return bytesRead;
+					}
+#else
 					buffer = ArrayPool<byte>.Shared.Rent (length);
 					try {
 						int bytesRead = 0;
@@ -909,11 +934,16 @@ internal static unsafe Int64 stream_callback (IntPtr state, IntPtr data, UInt64
 					} finally {
 						ArrayPool<byte>.Shared.Return (buffer);
 					}
+#endif
 				case SourceCommand.BeginWrite:
 					try {
-						string tempFile = Path.GetTempFileName ();
-						context.Destination = File.Open (tempFile, FileMode.OpenOrCreate, FileAccess.ReadWrite);
-						context.DestinationFileName = tempFile;
+						if (context.UseTempFile) {
+							string tempFile = Path.GetTempFileName ();
+							context.Destination = File.Open (tempFile, FileMode.OpenOrCreate, FileAccess.ReadWrite);
+							context.DestinationFileName = tempFile;
+						} else {
+							context.Destination = new MemoryStream ();
+						}
 					} catch (IOException) {
 						// ok use a memory stream as a backup
 						context.Destination = new MemoryStream ();