Micro benchmarks for System.Formats.Tar.TarWriter.WriteEntry

[carlossanlop]

Making sure we have coverage for the scenario of manually creating an TarEntry then writing it to a tar archive using a TarWriter.

[jozkee]

CI issues are related:

[2023/03/10 00:05:20][INFO] // Found 2 benchmarks:
[2023/03/10 00:05:20][INFO] //   Perf_TarWriter.V7TarEntry_WriteEntry: Job-BHHYZP(PowerPlanMode=00000000-0000-0000-0000-000000000000, InvocationCount=1, IterationCount=1, IterationTime=250.0000 ms, MaxIterationCount=20, MinIterationCount=15, RunStrategy=ColdStart, UnrollFactor=1, WarmupCount=0)
[2023/03/10 00:05:20][INFO] //   Perf_TarWriter.PaxTarEntry_WriteEntry_Async: Job-BHHYZP(PowerPlanMode=00000000-0000-0000-0000-000000000000, InvocationCount=1, IterationCount=1, IterationTime=250.0000 ms, MaxIterationCount=20, MinIterationCount=15, RunStrategy=ColdStart, UnrollFactor=1, WarmupCount=0)
[2023/03/10 00:05:20][INFO] 
[2023/03/10 00:05:20][INFO] // **************************
[2023/03/10 00:05:20][INFO] // Benchmark: Perf_TarWriter.V7TarEntry_WriteEntry: Job-BHHYZP(PowerPlanMode=00000000-0000-0000-0000-000000000000, InvocationCount=1, IterationCount=1, IterationTime=250.0000 ms, MaxIterationCount=20, MinIterationCount=15, RunStrategy=ColdStart, UnrollFactor=1, WarmupCount=0)
[2023/03/10 00:05:20][INFO] // *** Execute ***
[2023/03/10 00:05:20][INFO] // Launch: 1 / 1
[2023/03/10 00:05:20][INFO] // Execute: dotnet 056c3247-89e2-4608-8c3f-8ceca830c6d9.dll --anonymousPipes 230 231 --benchmarkName System.Formats.Tar.Tests.Perf_TarWriter.V7TarEntry_WriteEntry --job "PowerPlanMode=00000000-0000-0000-0000-000000000000, InvocationCount=1, IterationCount=1, IterationTime=250.0000 ms, MaxIterationCount=20, MinIterationCount=15, RunStrategy=ColdStart, UnrollFactor=1, WarmupCount=0" --benchmarkId 307 in /datadisks/disk1/work/AAF40954/w/ACD909EC/e/artifacts/bin/MicroBenchmarks/Release/net8.0/056c3247-89e2-4608-8c3f-8ceca830c6d9/bin/Release/net8.0
[2023/03/10 00:05:20][INFO] Failed to set up high priority. Make sure you have the right permissions. Message: Permission denied
[2023/03/10 00:05:20][INFO] // BeforeAnythingElse
[2023/03/10 00:05:20][INFO] 
[2023/03/10 00:05:20][INFO] // Benchmark Process Environment Information:
[2023/03/10 00:05:20][INFO] // Runtime=.NET 8.0.0 (8.0.23.15903), X64 RyuJIT AVX2
[2023/03/10 00:05:20][INFO] // GC=Concurrent Workstation
[2023/03/10 00:05:20][INFO] // HardwareIntrinsics=AVX2,AES,BMI1,BMI2,FMA,LZCNT,PCLMUL,POPCNT VectorSize=256
[2023/03/10 00:05:20][INFO] // Job: Job-LULNEY(PowerPlanMode=00000000-0000-0000-0000-000000000000, InvocationCount=1, IterationCount=1, IterationTime=250.0000 ms, MaxIterationCount=20, MinIterationCount=15, RunStrategy=ColdStart, UnrollFactor=1, WarmupCount=0)
[2023/03/10 00:05:20][INFO] 
[2023/03/10 00:05:20][INFO] // BeforeActualRun
[2023/03/10 00:05:20][INFO] 
[2023/03/10 00:05:20][INFO] System.Reflection.TargetInvocationException: Exception has been thrown by the target of an invocation.
[2023/03/10 00:05:20][INFO]  ---> System.ArgumentException: Entry type 'RegularFile' not supported in format 'V7'. (Parameter 'entryType')
[2023/03/10 00:05:20][INFO]    at System.Formats.Tar.TarHelpers.ThrowIfEntryTypeNotSupported(TarEntryType entryType, TarEntryFormat archiveFormat, String paramName)
[2023/03/10 00:05:20][INFO]    at System.Formats.Tar.V7TarEntry..ctor(TarEntryType entryType, String entryName)
[2023/03/10 00:05:20][INFO]    at System.Formats.Tar.Tests.Perf_TarWriter.V7TarEntry_WriteEntry() in /datadisks/disk1/work/AAF40954/w/ACD909EC/e/src/benchmarks/micro/libraries/System.Formats.Tar/Perf.Tar.cs:line 49
[2023/03/10 00:05:20][INFO]    at BenchmarkDotNet.Autogenerated.Runnable_307.WorkloadActionUnroll(Int64 invokeCount) in /datadisks/disk1/work/AAF40954/w/ACD909EC/e/artifacts/bin/MicroBenchmarks/Release/net8.0/056c3247-89e2-4608-8c3f-8ceca830c6d9/056c3247-89e2-4608-8c3f-8ceca830c6d9.notcs:line 56018
[2023/03/10 00:05:20][INFO]    at BenchmarkDotNet.Engines.Engine.RunIteration(IterationData data)
[2023/03/10 00:05:20][INFO]    at BenchmarkDotNet.Engines.EngineStage.RunIteration(IterationMode mode, IterationStage stage, Int32 index, Int64 invokeCount, Int32 unrollFactor)
[2023/03/10 00:05:20][INFO]    at BenchmarkDotNet.Engines.EngineActualStage.RunSpecific(Int64 invokeCount, IterationMode iterationMode, Int32 iterationCount, Int32 unrollFactor)
[2023/03/10 00:05:20][INFO]    at BenchmarkDotNet.Engines.EngineActualStage.Run(Int64 invokeCount, IterationMode iterationMode, Boolean runAuto, Int32 unrollFactor, Boolean forceSpecific)
[2023/03/10 00:05:20][INFO]    at BenchmarkDotNet.Engines.EngineActualStage.RunWorkload(Int64 invokeCount, Int32 unrollFactor, Boolean forceSpecific)
[2023/03/10 00:05:20][INFO]    at BenchmarkDotNet.Engines.Engine.Run()
[2023/03/10 00:05:20][INFO]    at BenchmarkDotNet.Autogenerated.Runnable_307.Run(IHost host, String benchmarkName) in /datadisks/disk1/work/AAF40954/w/ACD909EC/e/artifacts/bin/MicroBenchmarks/Release/net8.0/056c3247-89e2-4608-8c3f-8ceca830c6d9/056c3247-89e2-4608-8c3f-8ceca830c6d9.notcs:line 55919
[2023/03/10 00:05:20][INFO]    at System.RuntimeMethodHandle.InvokeMethod(Object target, Void** arguments, Signature sig, Boolean isConstructor)
[2023/03/10 00:05:20][INFO]    at System.Reflection.MethodInvoker.Invoke(Object obj, IntPtr* args, BindingFlags invokeAttr)
[2023/03/10 00:05:20][INFO]    --- End of inner exception stack trace ---
[2023/03/10 00:05:20][INFO]    at System.Reflection.MethodInvoker.Invoke(Object obj, IntPtr* args, BindingFlags invokeAttr)
[2023/03/10 00:05:20][INFO]    at System.Reflection.RuntimeMethodInfo.Invoke(Object obj, BindingFlags invokeAttr, Binder binder, Object[] parameters, CultureInfo culture)
[2023/03/10 00:05:20][INFO]    at BenchmarkDotNet.Autogenerated.UniqueProgramName.AfterAssemblyLoadingAttached(String[] args) in /datadisks/disk1/work/AAF40954/w/ACD909EC/e/artifacts/bin/MicroBenchmarks/Release/net8.0/056c3247-89e2-4608-8c3f-8ceca830c6d9/056c3247-89e2-4608-8c3f-8ceca830c6d9.notcs:line 57

[danmoseley]

@carlossanlop is this still in progress

[adamsitnik]

BDN runs every benchmark more than once, so we want to reuse the memory stream instance
and have it always perform the same amount of work.

[adamsitnik]

Two benchmarks are failing, but I left some comments that should fix the issue.

@carlossanlop thank you for contributing new benchmarks!

[adamsitnik]

LGTM, but we are now blocked by #3037 (unrelated to your changes).

[carlossanlop]

Thanks for the explanations and for applying the suggestions, @adamsitnik.

[adamsitnik]

can somebody else approve the PR?

[cincuranet]

@adamsitnik Done.

[adamsitnik]

@cincuranet thanks a lot!