BenchmarkDotNet 라이브러리 소개
닷넷 벤치마크 특화 라이브러리가 있었군요. ^^
Powerful .NET library for benchmarking
; https://github.com/dotnet/BenchmarkDotNet
BenchmarkDotNet
; https://www.nuget.org/packages/BenchmarkDotNet/
Install-Package BenchmarkDotNet -Version 0.10.14
사용 방법은 매우 쉽습니다. 예를 들기 위해 지난번 글의 내용에서 다룬,
C# 7.2의 특징 - GC 및 메모리 복사 방지를 위한 struct 타입 개선
; https://www.sysnet.pe.kr/2/0/11546
class로 정의한 Vector 타입을 성능 테스트 해보겠습니다.
class ClassVector
{
double _x;
double _y;
double _z;
public double X { get { return _x; } }
public double Y { get { return _y; } }
public double Z { get { return _z; } }
public ClassVector(double x, double y, double z)
{
_x = x;
_y = y;
_z = z;
}
public static ClassVector operator +(ClassVector v1, ClassVector v2)
{
return new ClassVector(v1.X + v2.X, v1.Y + v2.Y, v1.Z + v2.Z);
}
public override string ToString()
{
return $"({_x},{_y},{_z})";
}
}
성능 테스트를 위해 우선 EXE 유형의 프로젝트가 필요합니다. 간단하게 Console 프로젝트를 만들고 위의 타입을 포함하든지, 라이브러리 참조로 추가합니다. 그다음, Main 메서드에서는 Benchmark를 실행하는 Run 코드를 [Benchmark] 특성이 있는 타입과 함께 넣으면 됩니다. 가령 다음과 같은 식입니다.
using BenchmarkDotNet.Attributes;
using BenchmarkDotNet.Running;
namespace ConsoleApp1
{
public class Program
{
public static void Main(string [] args)
{
BenchmarkRunner.Run<ClassVector>();
}
}
class ClassVector
{
double _x;
double _y;
double _z;
public double X { get { return _x; } }
public double Y { get { return _y; } }
public double Z { get { return _z; } }
public ClassVector(double x, double y, double z)
{
_x = x;
_y = y;
_z = z;
}
[Benchmark]
public static ClassVector operator +(ClassVector v1, ClassVector v2)
{
return new ClassVector(v1.X + v2.X, v1.Y + v2.Y, v1.Z + v2.Z);
}
public override string ToString()
{
return $"({_x},{_y},{_z})";
}
}
}
하지만 위와 같이 설정하고 실행하면 다음과 같은 오류가 발생합니다.
Unhandled Exception: System.InvalidOperationException: Benchmark method op_Addition has incorrect signature.
Method shouldn't have any arguments.
at BenchmarkDotNet.Running.BenchmarkConverter.AssertMethodHasCorrectSignature(String methodType, MethodInfo methodInfo)
at BenchmarkDotNet.Running.BenchmarkConverter.CreateTarget(Type type, MethodInfo globalSetupMethod, MethodInfo methodInfo, MethodInfo globalCleanupMethod, MethodInfo iterationSetupMethod, MethodInfo iterationCleanupMethod, BenchmarkAttribute attr, MethodInfo[] targetMethods)
at BenchmarkDotNet.Running.BenchmarkConverter.<>c__DisplayClass4_0.<GetTargets>b__1(MethodInfo methodInfo)
at System.Linq.Enumerable.WhereSelectArrayIterator`2.MoveNext()
at System.Linq.Buffer`1..ctor(IEnumerable`1 source)
at System.Linq.Enumerable.ToArray[TSource](IEnumerable`1 source)
at BenchmarkDotNet.Running.BenchmarkConverter.MethodsToBenchmarksWithFullConfig(Type containingType, MethodInfo[] benchmarkMethods, ReadOnlyConfig fullConfig)
at BenchmarkDotNet.Running.BenchmarkConverter.TypeToBenchmarks(Type type, IConfig config)
at BenchmarkDotNet.Running.BenchmarkRunner.Run[T](IConfig config)
at ClassLibrary1.Program.Main(String[] args) in F:\ClassLibrary1\Class1.cs:line 10
이유는, Benchmark 특성을 모든 메서드에 부여할 수 있는 것이 아니고 입력 인자가 없는 메서드여야 하기 때문입니다. 또한, BenchmarkRunner.Run에 지정한 타입(위의 코드에서는 ClassVector)은 반드시 public 접근자를 가져야 하는데, 이런 요구 사항들을 만족하기 위해 소스 코드를 변경할 수는 없습니다. 따라서 가능한 기존 소스 코드는 그대로 두고 원하는 메서드에 대한 성능 테스트를 할 수 있도록 그에 맞는 코드를 추가하는 것이 좋습니다. 위의 예제에서는 다음과 같은 정도로 일종의 중계 클래스를 두면 됩니다.
using BenchmarkDotNet.Attributes;
using BenchmarkDotNet.Running;
namespace ConsoleApp1
{
public class Program
{
public static void Main(string [] args)
{
BenchmarkRunner.Run<VectorBenchmark>();
}
}
public class VectorBenchmark
{
[Benchmark]
public void ClassVectorTest()
{
var player = new ClassVector(10.0, 20.0, 30.0);
var speed = new ClassVector(10.0, 20.0, 30.0);
var result = player + speed;
}
}
class ClassVector
{
...[생략]...
}
}
그럼 모든 준비는 끝났습니다. 하지만 이렇게 했는데도 실행하면 다음과 같은 오류가 발생할 수 있습니다.
// ***** BenchmarkRunner: Start *****
// Found benchmarks:
// VectorBenchmark.ClassVectorTest: DefaultJob
// Validating benchmarks:
Assembly ConsoleApp1 which defines benchmarks is non-optimized
Benchmark was built without optimization enabled (most probably a DEBUG configuration). Please, build it in RELEASE.
// * Artifacts cleanup *
그렇습니다. Release로 빌드해야 합니다.
정상적으로 실행이 되면 얼마 간의 테스트 결과와 함께 마지막 부근에 요약 정보를 보여줍니다.
...[생략]...
// * Summary *
BenchmarkDotNet=v0.10.14, OS=Windows 10.0.17134
Intel Core i5-4670 CPU 3.40GHz (Haswell), 1 CPU, 4 logical and 4 physical cores
[Host] : .NET Framework 4.7.1 (CLR 4.0.30319.42000), 32bit LegacyJIT-v4.7.3101.0
DefaultJob : .NET Framework 4.7.1 (CLR 4.0.30319.42000), 32bit LegacyJIT-v4.7.3101.0
Method | Mean | Error | StdDev |
---------------- |---------:|----------:|----------:|
ClassVectorTest | 14.54 ns | 0.3023 ns | 0.2828 ns |
// * Legends *
Mean : Arithmetic mean of all measurements
Error : Half of 99.9% confidence interval
StdDev : Standard deviation of all measurements
1 ns : 1 Nanosecond (0.000000001 sec)
// ***** BenchmarkRunner: End *****
// * Artifacts cleanup *
당연히 구성한 C# 프로젝트가 32비트 EXE 출력으로 맞춰져 있다면 저렇게 "32bit Legacy JIT"라는 항목이 나옵니다. 반면 64비트로 맞추면 "64bit RyuJIT-v4.7.3101.0"라고 나옵니다.
BenchmarkDotNet이 재미있는 것은, 닷넷 런타임 유형 별로 별도 프로젝트를 만들지 않고도 다양한 구현체를 테스트할 수 있다는 것입니다. 이를 위해 다음과 같이 특성을 지정하면 됩니다.
[ClrJob(isBaseline: true), CoreJob, MonoJob]
public class VectorBenchmark
{
[Benchmark]
public void ClassVectorTest()
{
var player = new ClassVector(10.0, 20.0, 30.0);
var speed = new ClassVector(10.0, 20.0, 30.0);
var result = player + speed;
}
}
하지만 테스트를 위해서는 CoreJob의 경우 .NET Core가, MonoJob인 경우 Mono Runtime이 시스템에 설치되어 있어야 합니다.
그 외 나머지 자잘한 사용법은 github 페이지를 참조하시면 됩니다.
dotnet/BenchmarkDotNet
; https://github.com/dotnet/BenchmarkDotNet
(
첨부 파일은 이 글의 예제 코드를 포함합니다.)
참고로, .NET Framework의 경우 2.0은 지원하지만, 4.0에서는 4.6부터 지원합니다. 따라서 여러분들의 프로젝트가 .NET 4.5 이하로 되어 있으면 다음과 같은 설치 오류가 발생합니다.
Error Could not install package 'BenchmarkDotNet 0.10.14'. You are trying to install this package into a project that targets '.NETFramework,Version=v4.5', but the package does not contain any assembly references or content files that are compatible with that framework. For more information, contact the package author.
[이 글에 대해서 여러분들과 의견을 공유하고 싶습니다. 틀리거나 미흡한 부분 또는 의문 사항이 있으시면 언제든 댓글 남겨주십시오.]