Roslyn-linq-rewrite

Compiles C# code by first rewriting the syntax trees of LINQ expressions using plain procedural code, minimizing allocations and dynamic dispatch.

Code Quality Rank: L1

Programming language: C#

License: MIT License

Tags: Compiler    

Latest version: v1.0.1.11

README

roslyn-linq-rewrite

This tool compiles C# code by first rewriting the syntax trees of LINQ expressions using plain procedural code, minimizing allocations and dynamic dispatch.

Example input code

public int Method1()
{
    var arr = new[] { 1, 2, 3, 4 };
    var q = 2;
    return arr.Where(x => x > q).Select(x => x + 3).Sum();
}

Allocations: input array, array enumerator, closure for q, Where delegate, Select delegate, Where enumerator, Select enumerator.

Decompiled output code

public int Method1()
{
    int[] arr = new[] { 1, 2, 3, 4 };
    int q = 2;
    return this.Method1_ProceduralLinq1(arr, q);
}
private int Method1_ProceduralLinq1(int[] _linqitems, int q)
{
    if (_linqitems == null) throw new ArgumentNullException();

    int num = 0;
    for (int i = 0; i < _linqitems.Length; i++)
    {
        int num2 = _linqitems[i]; 
        if (num2 > q)
            num += num2 + 3;
    }
    return num;
}

Allocations: input array.

Note: in this example, the optimizing compiler has generated code using arrays, because the type was known at compile time. When this is not the case, the generated code will instead use a foreach and IEnumerable<>. Non-optimizable call chains and IQueryable<> are left intact.

Supported LINQ methods

• Select, Where, Reverse, Cast, OfType
• First, FirstOrDefault, Single, SingleOrDefault, Last, LastOrDefault
• ToList, ToArray, ToDictionary
• Count, LongCount, Any, All
• ElementAt, ElementAtOrDefault
• Contains, ForEach

Usage (.sln/.csproj)

• Download the latest binaries
• roslyn-linq-rewrite <path-to-sln-or-csproj> [--release]

Note: you can more deeply integrate the optimizing compiler with MSBuild by setting CscToolPath to the roslyn-linq-rewrite directory.

Usage (project.json)

• Add the following to your project.json: json "tools": { "dotnet-compile-csc-linq-rewrite": { "version": "1.0.1.9", "imports": "portable-net45+win8+wp8+wpa81" } }
• In the buildOptions of your project.json, specify the custom compiler: json "buildOptions": { "compilerName": "csc-linq-rewrite" }
• Compile your project with dotnet restore and dotnet build.
• If you need to exclude a specific method, apply a [NoLinqRewrite] attribute to that method: csharp namespace Shaman.Runtime { [AttributeUsage(AttributeTargets.Class | AttributeTargets.Struct | AttributeTargets.Method)] public class NoLinqRewriteAttribute : Attribute { } }

Tests

Here's a diff (and its code) between the ordinary LINQ tests and the version compiled with roslyn-linq-rewrite. The only difference seems to be related about a Min/Max with NaN values, I'm planning to fix it soon.

Shaman.FastLinq

To further reduce allocations, install Shaman.FastLinq or Shaman.FastLinq.Sources. These packages include LINQ methods specific for T[] and List<> (not all method calls are optimized by LINQ rewrite, like individual, non-chained .First() or .Last() calls).

Comparison to LinqOptimizer

• Code is optimized at build time (as opposed to run time)
• Uses existing LINQ syntax, no need for AsQueryExpr().Run()
• No allocations for Expression<> trees and enumerator boxing
• Parallel LINQ is not supported (i.e. left intact)
• No support for F#