Git Product home page Git Product logo

codegenanalysis's Introduction

CodegenAnalysis

Library for analyzing the machine code generated by JIT (codegen). Has API for obtaining the codegen, verifying the characteristics for tests (in a similar manner to xUnit), and generating reports as benchmarks (in a similar manner to BenchmarkDotNet). Supports x86_64 on three major platforms (Windows, MacOS, Linux).

Why should I use it?

First of all, most .NET developers don't need this library. If you want to measure performance of your code, use BenchmarkDotNet.

If you're working on low-level, often HW-related project, where it's crucial if a branch or call or etc. is optimized or not, this library is for you.

Table of contents

CodegenAnalysis

Nuget (with prereleases)

static int AddAndMul(int a, int b) => a + b * a;

...

var ci = CodegenInfo.Obrain(() => AddAndMul(3, 5));
Console.WriteLine(ci);

Output:

00007FFD752E42F0 8BC2                 mov       eax,edx
00007FFD752E42F2 0FAFC1               imul      eax,ecx
00007FFD752E42F5 03C1                 add       eax,ecx
00007FFD752E42F7 C3                   ret

CodegenAnalysis.Assertions

Nuget (with prereleases)

Verifying the size of the codegen

using CodegenAssertions;
using Xunit;

public class CodegenSizeTest
{
    public static int SomeMethod(int a, int b)
        => a + b;

    [Fact]
    public void Test1()
    {
        CodegenInfo.Obtain(() => SomeMethod(4, 5), CompilationTier.Tier1)
            .ShouldBeNotLargerThan(20);
    }
}

Having calls in the codegen

public class Tests
{
    public class A
    {
        public virtual int H => 3;
    }

    public sealed class B : A
    {
        public override int H => 6;
    }

    // this will get devirtualized at tier1, but not at tier0
    static int Twice(B b) => b.H * 2;

    [Fact]
    public void NotDevirtTier0()
    {
        CodegenInfo.Obtain(() => Twice(new B()), CompilationTier.Default)
            .ShouldHaveCalls(c => c >= 1);
    }

    [Fact]
    public void DevirtTier1()
    {
        CodegenInfo.Obtain(() => Twice(new B()), CompilationTier.Tier1)
            .ShouldHaveCalls(0);
    }
}

Testing if we have branches

    private static readonly bool True = true;

    static int SmartThing()
    {
        if (True)
            return 5;
        return 10;
    }

    [Fact]
    public void BranchElimination()
    {
        CodegenInfo.Obtain(() => SmartThing())
            .ShouldHaveBranches(0);
    }

    [MethodImpl(MethodImplOptions.NoOptimization)]
    static int StupidThing()
    {
        if (True)
            return 5;
        return 10;
    }

    [Fact]
    public void NoBranchElimination()
    {
        CodegenInfo.Obtain(() => StupidThing(), CompilationTier.Default)
            .ShouldHaveBranches(b => b > 0);
    }

CodegenAnalysis.Benchmarks

Nuget (with prereleases)

CodegenBenchmarkRunner.Run<A>();

[CAJob(Tier = CompilationTier.Default),
 CAJob(Tier = CompilationTier.Tier1)]

[CAColumn(CAColumn.Branches),
 CAColumn(CAColumn.Calls), 
 CAColumn(CAColumn.CodegenSize), 
 CAColumn(CAColumn.StaticStackAllocations)]

[CAExport(Export.Html),
 CAExport(Export.Md)]
public class A
{
    [CAAnalyze(3.5f)]
    [CAAnalyze(13.5f)]
    public static float Heavy(float a)
    {
        var b = Do1(a);
        var c = Do1(b);
        if (a > 10)
            c += Aaa(a);
        return c + b;
    }

    [CAAnalyze(6f)]
    public static float Square(float a)
    {
        return a * a;
    }

    [MethodImpl(MethodImplOptions.NoInlining)]
    public static float Do1(float a)
    {
        return a * 2;
    }

    [MethodImpl(MethodImplOptions.NoInlining)]
    public static float Aaa(float h)
    {
        return h * h * h;
    }
}

See the output.

codegenanalysis's People

Contributors

whiteblackgoose avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

codegenanalysis's Issues

CodegenAnalyzers

CodegenAnalyzers.GetBranches(CodegenInfo ci) -> IEnumerable<int>
CodegenAnalyzers.GetCalls(CodegenInfo ci) -> IEnumerable<int>
CodegenAnalyzers.GetLoops(CodegenInfo ci) -> IEnumerable<(int Start, int End)>
CodegenAnalyzers.GetStaticallyAllocatedStackMemory(CodegenInfo ci) -> int?

Three libs?

Codegen

That one is just the core. It has the CodegenInfo object, and everything to get it.

var ci =  CodegenInfoResolver.GetCodegen(() => Add(4, 5));
Console.WriteLine(ci);

Codegen.Assertions

That one is a test suite: it has multiple assertions to verify the behaviour of JIT.

AssertCodegen.BranchesLessThan(5, () => Add(3, 5));

Codegen.Benchmarks

This one will build a report based on a codegen.

CodegenBenchmarkRunner.Run<Bench>();

class Bench
{
    [Benchmark]
    [Input(3, 5)]
    public void Add(int a, int b) => a + b;

    [Benchmark]
    [Input(3, 5, 6)]
    public void Add(int a, int b, int c) => a + b + c;
}

Output:

Method Code size Branches Calls Stack allocated memory Backward jumps (loops)
SomeMethod 43 B 3 - - 2
OtherMethod 164 B 7 11 164 B -

(and prints the codegen)

NRE

Line 125 in benchmark runner. Should produce something...

RunAsBDN

To use [Benchmark] and [GlobalSetup] things by name

Support chained fowarding via `CASubject`

A method with CAAnalyze that forwards disassembling to another via CASubject will only reach the first forwarded method. If that target method contains another CASubject, it will be ignored. In other words, recursive method forwarding is not supported.

Highlight problematic lines

E. g. for CodegenDoesNotHaveBranches it could look like this:

  27382   mov rax, rdx
> 27385   test rax, rax
  27387   jz 27382
  29233   call aaaa
> 23928   cmp rdx, rax
  20393   jg 29033

`CASubjectAttribute`

To allow investigating inner methods, e. g.

[CAAnalyze(5)]
[CASubject("CallA")]
public void SomeMethod(int a)
{
    CallA(CallB(a));
}

The full arguments are

string methodName, Type[] typeArgs, Type[] parameterTypes

Where methodName is

  1. Method
  2. SomeType.Method
  3. SomeNamespace.SomeType.Method

AutoBest tier

Instead of hard-coded one, this one will detect the runtime version and adjust the tier to the best (with TC it will be tier1, otherwise default)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.