├── GitVersion.yml ├── package_icon.png ├── src ├── Thruster │ ├── InternalsVisibleTo.cs │ ├── PaddedLong.cs │ ├── Intelocked2.cs │ ├── Thruster.csproj │ ├── Size.cs │ ├── Util.cs │ ├── FastMemoryPool.cs │ ├── Leasing.cs │ └── MemoryPoolImpl.cs ├── Thruster.Benchmarks │ ├── Program.cs │ ├── Thruster.Benchmarks.csproj │ ├── NestedRentingBenchmark.cs │ └── PipeThroughputBenchmark.cs ├── Thruster.ThreadedApp │ ├── Thruster.ThreadedApp.csproj │ └── Program.cs ├── Thruster.sln.DotSettings ├── Thruster.Tests │ ├── Thruster.Tests.csproj │ ├── LeasingTests.cs │ └── FastMemoryPoolTests.cs ├── Directory.Build.targets └── Thruster.sln ├── README.md ├── .gitignore └── LICENSE /GitVersion.yml: -------------------------------------------------------------------------------- 1 | assembly-versioning-scheme: Major 2 | next-version: 1.0 -------------------------------------------------------------------------------- /package_icon.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Scooletz/Thruster/HEAD/package_icon.png -------------------------------------------------------------------------------- /src/Thruster/InternalsVisibleTo.cs: -------------------------------------------------------------------------------- 1 | using System.Runtime.CompilerServices; 2 | 3 | [assembly:InternalsVisibleTo("Thruster.Tests")] -------------------------------------------------------------------------------- /src/Thruster/PaddedLong.cs: -------------------------------------------------------------------------------- 1 | using System.Runtime.InteropServices; 2 | 3 | namespace Thruster 4 | { 5 | [StructLayout(LayoutKind.Explicit, Size = Util.CacheLineSize)] 6 | struct PaddedLong 7 | { 8 | [FieldOffset(0)] 9 | public long Value; 10 | } 11 | } -------------------------------------------------------------------------------- /src/Thruster.Benchmarks/Program.cs: -------------------------------------------------------------------------------- 1 | using BenchmarkDotNet.Configs; 2 | using BenchmarkDotNet.Running; 3 | 4 | namespace Thruster.Benchmarks 5 | { 6 | class Program 7 | { 8 | static void Main(string[] args) 9 | { 10 | var summary = BenchmarkRunner.Run(typeof(PipeThroughputBenchmark).Assembly, DefaultConfig.Instance); 11 | } 12 | } 13 | } 14 | -------------------------------------------------------------------------------- /src/Thruster.ThreadedApp/Thruster.ThreadedApp.csproj: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | Exe 5 | netcoreapp2.1 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | -------------------------------------------------------------------------------- /src/Thruster.sln.DotSettings: -------------------------------------------------------------------------------- 1 | 2 | <Policy Inspect="True" Prefix="" Suffix="" Style="aaBb" /> -------------------------------------------------------------------------------- /src/Thruster.Tests/Thruster.Tests.csproj: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | netcoreapp2.1 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | -------------------------------------------------------------------------------- /src/Thruster.Tests/LeasingTests.cs: -------------------------------------------------------------------------------- 1 | using NUnit.Framework; 2 | 3 | namespace Thruster.Tests 4 | { 5 | public class LeasingTests 6 | { 7 | [Test] 8 | public void LeaseAndReleaseShouldLeaveAllBitsUnset([Values(1, 32, 33, 63)]int consecutive) 9 | { 10 | var leasing = new Leasing(1); 11 | 12 | var lease = Leasing.Lease(ref leasing, 0, consecutive, 1); 13 | Assert.AreEqual(0, lease); 14 | 15 | Leasing.Release(ref leasing, 0, consecutive, (short)lease); 16 | 17 | lease = Leasing.Lease(ref leasing, 0, consecutive, 1); 18 | Assert.AreEqual(0, lease); 19 | } 20 | } 21 | } -------------------------------------------------------------------------------- /src/Thruster/Intelocked2.cs: -------------------------------------------------------------------------------- 1 | using System.Runtime.CompilerServices; 2 | using System.Threading; 3 | 4 | namespace Thruster 5 | { 6 | public static class Intelocked2 7 | { 8 | [MethodImpl(MethodImplOptions.AggressiveInlining)] 9 | static long GetMask(int continousItems) => (1L << continousItems) - 1; 10 | 11 | public static long Xor(ref long v, int offset, int length) 12 | { 13 | var mask = GetMask(length); 14 | mask <<= offset; 15 | var value = Volatile.Read(ref v); 16 | long previous; 17 | do 18 | { 19 | previous = value; 20 | value = Interlocked.CompareExchange(ref v, mask ^ previous, previous); 21 | } while (value != previous); 22 | 23 | return value; 24 | } 25 | } 26 | } -------------------------------------------------------------------------------- /src/Thruster/Thruster.csproj: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | netstandard1.3 5 | Thruster 6 | Thruster 7 | Thruster 8 | Thruster 9 | true 10 | Thruster 11 | A fast and efficient implementation of a MemoryPool. 12 | true 13 | 14 | 15 | 16 | 17 | 18 | All 19 | 20 | 21 | -------------------------------------------------------------------------------- /src/Directory.Build.targets: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | true 5 | latest 6 | Szymon Kulec @Scooletz 7 | https://opensource.org/licenses/Apache-2.0 8 | false 9 | Copyright 2018-$([System.DateTime]::UtcNow.ToString(yyyy)) Szymon Kulec @Scooletz. All rights reserved 10 | MemoryPool memory span 11 | https://raw.githubusercontent.com/Scooletz/Thruster/master/package_icon.png 12 | https://github.com/Scooletz/Thruster 13 | ..\..\nugets 14 | 15 | -------------------------------------------------------------------------------- /src/Thruster.Benchmarks/Thruster.Benchmarks.csproj: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | Exe 5 | netcoreapp2.1 6 | true 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | ..\..\..\..\Program Files\dotnet\sdk\NuGetFallbackFolder\system.io.pipelines\4.5.0\ref\netstandard1.3\System.IO.Pipelines.dll 22 | 23 | 24 | 25 | 26 | -------------------------------------------------------------------------------- /src/Thruster/Size.cs: -------------------------------------------------------------------------------- 1 | using System.Runtime.CompilerServices; 2 | 3 | namespace Thruster 4 | { 5 | interface ISize 6 | { 7 | int GetChunkSize(); 8 | int GetChunkSizeLog(); 9 | } 10 | 11 | struct Size4K : ISize 12 | { 13 | [MethodImpl(MethodImplOptions.AggressiveInlining)] 14 | public int GetChunkSize() => 4 * 1024; 15 | 16 | [MethodImpl(MethodImplOptions.AggressiveInlining)] 17 | public int GetChunkSizeLog() => 12; 18 | } 19 | 20 | struct Size8K : ISize 21 | { 22 | [MethodImpl(MethodImplOptions.AggressiveInlining)] 23 | public int GetChunkSize() => 8 * 1024; 24 | 25 | [MethodImpl(MethodImplOptions.AggressiveInlining)] 26 | public int GetChunkSizeLog() => 13; 27 | } 28 | 29 | struct Size16K : ISize 30 | { 31 | [MethodImpl(MethodImplOptions.AggressiveInlining)] 32 | public int GetChunkSize() => 16 * 1024; 33 | 34 | [MethodImpl(MethodImplOptions.AggressiveInlining)] 35 | public int GetChunkSizeLog() => 14; 36 | } 37 | } -------------------------------------------------------------------------------- /src/Thruster/Util.cs: -------------------------------------------------------------------------------- 1 | using System.Runtime.CompilerServices; 2 | 3 | namespace Thruster 4 | { 5 | static class Util 6 | { 7 | /// 8 | /// Aligns to the next multiple of . 9 | /// If the value equals an alignment multiple then it's returned without changes. 10 | /// 11 | /// 12 | /// No branching :D 13 | /// 14 | [MethodImpl(MethodImplOptions.AggressiveInlining)] 15 | public static int AlignToMultipleOf(this int value, int alignment) 16 | { 17 | return (value + (alignment - 1)) & ~(alignment - 1); 18 | } 19 | 20 | /// 21 | /// Aligns to the next multiple of . 22 | /// If the value equals an alignment multiple then it's returned without changes. 23 | /// 24 | /// 25 | /// No branching :D 26 | /// 27 | [MethodImpl(MethodImplOptions.AggressiveInlining)] 28 | public static long AlignToMultipleOf(this long value, long alignment) 29 | { 30 | return (value + (alignment - 1)) & ~(alignment - 1); 31 | } 32 | 33 | public const int CacheLineSize = 64; 34 | } 35 | } -------------------------------------------------------------------------------- /src/Thruster.Benchmarks/NestedRentingBenchmark.cs: -------------------------------------------------------------------------------- 1 | using System; 2 | using System.Buffers; 3 | using BenchmarkDotNet.Attributes; 4 | using Microsoft.AspNetCore.Server.Kestrel.Transport.Abstractions.Internal; 5 | 6 | namespace Thruster.Benchmarks 7 | { 8 | public class NestedRentingBenchmark : IDisposable 9 | { 10 | readonly MemoryPool thruster; 11 | readonly MemoryPool shared; 12 | readonly MemoryPool kestrel; 13 | 14 | public NestedRentingBenchmark() 15 | { 16 | thruster = new FastMemoryPool(); 17 | shared = MemoryPool.Shared; 18 | kestrel = KestrelMemoryPool.Create(); 19 | } 20 | 21 | [Benchmark] public void Rent_1_Thruster() => Kilo1(thruster); 22 | [Benchmark] public void Rent_1_Shared() => Kilo1(shared); 23 | [Benchmark] public void Rent_1_Kestrel() => Kilo1(kestrel); 24 | 25 | [Benchmark] public void Rent_2_Thruster() => Kilo2(thruster); 26 | [Benchmark] public void Rent_2_Shared() => Kilo2(shared); 27 | [Benchmark] public void Rent_2_Kestrel() => Kilo2(kestrel); 28 | 29 | static void Kilo1(MemoryPool pool) 30 | { 31 | using (var o = pool.Rent(512)) 32 | { 33 | o.Memory.Span[0] = 1; 34 | } 35 | } 36 | 37 | public static void Kilo2(MemoryPool pool) 38 | { 39 | using (var o1 = pool.Rent(512)) 40 | using (var o2 = pool.Rent(512)) 41 | { 42 | o1.Memory.Span[0] = 1; 43 | o2.Memory.Span[0] = 1; 44 | } 45 | } 46 | 47 | public void Dispose() 48 | { 49 | thruster?.Dispose(); 50 | kestrel?.Dispose(); 51 | } 52 | } 53 | } -------------------------------------------------------------------------------- /src/Thruster.sln: -------------------------------------------------------------------------------- 1 | 2 | Microsoft Visual Studio Solution File, Format Version 12.00 3 | # Visual Studio 15 4 | VisualStudioVersion = 15.0.27703.2035 5 | MinimumVisualStudioVersion = 10.0.40219.1 6 | Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Thruster", "Thruster\Thruster.csproj", "{29E64937-3DC8-43CA-BE5E-98BF654BA86D}" 7 | EndProject 8 | Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Thruster.Tests", "Thruster.Tests\Thruster.Tests.csproj", "{B3B9EB8E-A8FB-41DE-B427-013CB5FCB106}" 9 | EndProject 10 | Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Thruster.Benchmarks", "Thruster.Benchmarks\Thruster.Benchmarks.csproj", "{A3789782-53D7-4835-9792-29694F68D0FE}" 11 | ProjectSection(ProjectDependencies) = postProject 12 | {29E64937-3DC8-43CA-BE5E-98BF654BA86D} = {29E64937-3DC8-43CA-BE5E-98BF654BA86D} 13 | EndProjectSection 14 | EndProject 15 | Global 16 | GlobalSection(SolutionConfigurationPlatforms) = preSolution 17 | Debug|Any CPU = Debug|Any CPU 18 | Release|Any CPU = Release|Any CPU 19 | EndGlobalSection 20 | GlobalSection(ProjectConfigurationPlatforms) = postSolution 21 | {29E64937-3DC8-43CA-BE5E-98BF654BA86D}.Debug|Any CPU.ActiveCfg = Debug|Any CPU 22 | {29E64937-3DC8-43CA-BE5E-98BF654BA86D}.Debug|Any CPU.Build.0 = Debug|Any CPU 23 | {29E64937-3DC8-43CA-BE5E-98BF654BA86D}.Release|Any CPU.ActiveCfg = Release|Any CPU 24 | {29E64937-3DC8-43CA-BE5E-98BF654BA86D}.Release|Any CPU.Build.0 = Release|Any CPU 25 | {B3B9EB8E-A8FB-41DE-B427-013CB5FCB106}.Debug|Any CPU.ActiveCfg = Debug|Any CPU 26 | {B3B9EB8E-A8FB-41DE-B427-013CB5FCB106}.Debug|Any CPU.Build.0 = Debug|Any CPU 27 | {B3B9EB8E-A8FB-41DE-B427-013CB5FCB106}.Release|Any CPU.ActiveCfg = Release|Any CPU 28 | {B3B9EB8E-A8FB-41DE-B427-013CB5FCB106}.Release|Any CPU.Build.0 = Release|Any CPU 29 | {A3789782-53D7-4835-9792-29694F68D0FE}.Debug|Any CPU.ActiveCfg = Debug|Any CPU 30 | {A3789782-53D7-4835-9792-29694F68D0FE}.Debug|Any CPU.Build.0 = Debug|Any CPU 31 | {A3789782-53D7-4835-9792-29694F68D0FE}.Release|Any CPU.ActiveCfg = Release|Any CPU 32 | {A3789782-53D7-4835-9792-29694F68D0FE}.Release|Any CPU.Build.0 = Release|Any CPU 33 | EndGlobalSection 34 | GlobalSection(SolutionProperties) = preSolution 35 | HideSolutionNode = FALSE 36 | EndGlobalSection 37 | GlobalSection(ExtensibilityGlobals) = postSolution 38 | SolutionGuid = {D02BDC69-6D18-4D86-8901-3CE34C10D99B} 39 | EndGlobalSection 40 | EndGlobal 41 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | This project is dicontinued. Although it was able to be faster than the default shared implementation, it's not faster than Kestrel's pool. More reasoning: https://blog.scooletz.com/2018/08/14/thruster-building-a-not-so-fast-memory-pool/ 2 | 3 | ![Icon](https://raw.githubusercontent.com/Scooletz/Thruster/master/package_icon.png) 4 | 5 | # Thruster 6 | Thruster is a fast and efficient implementation of a MemoryPool<T> 7 | 8 | ## Design principles 9 | Thruster is based on (some) understanding on nowadays CPUs and low level APIs provided by .NET. The most important desing principles are: 10 | - padding - expanding an object or an array, to reduce a possibility of using the same CPU cache line by threads being run on different CPUs 11 | - region memory mangagement - leasing chunks of memory from a specific region, which allows use of in-region addressing (offset, region number) 12 | - no locks - for claiming and releasing memory when no resize is needed 13 | - efficient data encoding - bitmasks used for leasing, are designed to use 1 `CAS` operation for renting (when no collisions) and one, branchless unconditional `Interlocked.Add` to release 14 | 15 | ## Benchmarks 16 | Some single threaded benchmarks run with awesome BenchmarkDotNet. The nesting level represents multiple `.Rent` operations. 17 | 18 | ``` ini 19 | 20 | BenchmarkDotNet=v0.11.0, OS=Windows 10.0.16299.547 (1709/FallCreatorsUpdate/Redstone3) 21 | Intel Core i7-6700HQ CPU 2.60GHz (Max: 2.20GHz) (Skylake), 1 CPU, 8 logical and 4 physical cores 22 | Frequency=2531250 Hz, Resolution=395.0617 ns, Timer=TSC 23 | .NET Core SDK=2.1.302 24 | [Host] : .NET Core 2.1.2 (CoreCLR 4.6.26628.05, CoreFX 4.6.26629.01), 64bit RyuJIT 25 | DefaultJob : .NET Core 2.1.2 (CoreCLR 4.6.26628.05, CoreFX 4.6.26629.01), 64bit RyuJIT 26 | 27 | 28 | ``` 29 | | Method | Mean | Error | StdDev | 30 | |---------------------- |----------:|---------:|---------:| 31 | | Thruster_1_Rent | 74.54 ns | 1.557 ns | 4.048 ns | 32 | |Thruster_2_nested_Rents | 139.32 ns | 2.765 ns | 2.958 ns | 33 | |Thruster_3_nested_Rents | 207.78 ns | 3.479 ns | 3.255 ns | 34 | | Shared_1_Rent | 91.73 ns | 1.547 ns | 1.447 ns | 35 | | Shared_2_nested_Rents | 287.89 ns | 5.087 ns | 4.510 ns | 36 | | Shared_3_nested_Rents | 408.50 ns | 7.217 ns | 6.751 ns | 37 | 38 | Multi threaded app depends on the nesting level even more. If there's no nesting, results are comparable. Any nesting will drastically point towards using Thruster. 39 | 40 | ## Icon 41 | 42 | [Rocket Ship](https://thenounproject.com/term/rocket-ship/152486/) designed by [Joy Thomas](https://thenounproject.com/jthomas/) from The Noun Project 43 | -------------------------------------------------------------------------------- /src/Thruster/FastMemoryPool.cs: -------------------------------------------------------------------------------- 1 | using System; 2 | using System.Buffers; 3 | 4 | namespace Thruster 5 | { 6 | public class FastMemoryPool : MemoryPool 7 | { 8 | readonly int processorCount; 9 | readonly MemoryPoolImpl pool4K; 10 | volatile MemoryPoolImpl pool8K; 11 | volatile MemoryPoolImpl pool16K; 12 | 13 | public FastMemoryPool() 14 | : this(Math.Min(Environment.ProcessorCount, 64)) 15 | 16 | { 17 | } 18 | 19 | internal FastMemoryPool(int processorCount) 20 | { 21 | this.processorCount = processorCount; 22 | pool4K = new MemoryPoolImpl(processorCount); 23 | } 24 | 25 | public override IMemoryOwner Rent(int size = -1) 26 | { 27 | if (size <= 0) 28 | { 29 | size = 1; 30 | } 31 | 32 | var chunk4KCount = size >> default(Size4K).GetChunkSizeLog(); 33 | if (chunk4KCount < 15) 34 | { 35 | return pool4K.Rent(size); 36 | } 37 | 38 | if (chunk4KCount < 30) 39 | { 40 | return Pool8K.Rent(size); 41 | } 42 | 43 | return Pool16K.Rent(size); 44 | } 45 | 46 | MemoryPoolImpl Pool8K 47 | { 48 | get 49 | { 50 | if (pool8K != null) 51 | { 52 | return pool8K; 53 | } 54 | 55 | lock (pool4K) 56 | { 57 | if (pool8K == null) 58 | { 59 | pool8K = new MemoryPoolImpl(processorCount); 60 | } 61 | } 62 | 63 | return pool8K; 64 | } 65 | } 66 | 67 | MemoryPoolImpl Pool16K 68 | { 69 | get 70 | { 71 | if (pool16K != null) 72 | { 73 | return pool16K; 74 | } 75 | 76 | lock (pool4K) 77 | { 78 | if (pool16K == null) 79 | { 80 | pool16K = new MemoryPoolImpl(processorCount); 81 | } 82 | } 83 | 84 | return pool16K; 85 | } 86 | } 87 | 88 | public override int MaxBufferSize => 8 * default(Size16K).GetChunkSize(); 89 | 90 | protected override void Dispose(bool disposing) 91 | { 92 | pool4K?.Dispose(disposing); 93 | pool8K?.Dispose(disposing); 94 | pool16K?.Dispose(disposing); 95 | } 96 | } 97 | } -------------------------------------------------------------------------------- /src/Thruster/Leasing.cs: -------------------------------------------------------------------------------- 1 | using System.Runtime.CompilerServices; 2 | using System.Threading; 3 | 4 | namespace Thruster 5 | { 6 | /// 7 | /// This class is responsible for managing leases of conitnous bits 1111 over a ref long. This means that any lease cannot be claimed for more than 63 consecutive elements 8 | /// 9 | /// A lease of specific length n is represented as a n consecutive bits set to 1. This mask is easily calculated: 2^n - 1. 10 | /// 11 | struct Leasing 12 | { 13 | readonly PaddedLong[] masks; 14 | internal const int ChunksPerLeaseLong = 63; 15 | 16 | public Leasing(int size) 17 | { 18 | masks = new PaddedLong[size + 2]; 19 | } 20 | 21 | /// 22 | /// Simply calculates 2^n - 1; 23 | /// 24 | /// 25 | /// 26 | [MethodImpl(MethodImplOptions.AggressiveInlining)] 27 | static long GetMask(int continousItems) => (1L << continousItems) - 1; 28 | 29 | public static long Lease(ref Leasing leasing, int index, int continousItems, int retries) => Lease(ref leasing.masks[index + 1].Value, continousItems, retries); 30 | 31 | /// 32 | /// Returns a positive position of the continousItem, or negative value that was observed as the last, providing opportunity to base selection of the bucket on this value. 33 | /// 34 | /// 35 | /// 36 | /// 37 | /// 38 | static long Lease(ref long v, int continousItems, int retries) 39 | { 40 | var length = ChunksPerLeaseLong + 1 - continousItems; 41 | var mask = GetMask(continousItems); 42 | 43 | // initially, the value is read from ref v. Later, if leasing fails, is obtained from CompareExchange. 44 | var value = Volatile.Read(ref v); 45 | 46 | var i = 0; 47 | for (; i < length & retries > 0; i++) 48 | { 49 | if ((value & mask) == 0) 50 | { 51 | var nextValue = value | mask; 52 | 53 | var result = Interlocked.CompareExchange(ref v, nextValue, value); 54 | if (result == value) 55 | { 56 | return i; 57 | } 58 | 59 | // leasing attempt failed, retry with the recently obtained value from the last not checked index 60 | value = result; 61 | retries--; 62 | } 63 | 64 | mask <<= 1; 65 | } 66 | 67 | return -value; 68 | } 69 | 70 | public static void Release(ref Leasing leasing, int index, int continousItems, short lease) => 71 | Release(ref leasing.masks[index + 1].Value, continousItems, lease); 72 | 73 | static void Release(ref long v, int continousItems, short lease) 74 | { 75 | Intelocked2.Xor(ref v, lease, continousItems); 76 | } 77 | } 78 | } -------------------------------------------------------------------------------- /src/Thruster.ThreadedApp/Program.cs: -------------------------------------------------------------------------------- 1 | using System; 2 | using System.Buffers; 3 | using System.Diagnostics; 4 | using System.IO.Pipelines; 5 | using System.Linq; 6 | using System.Threading.Tasks; 7 | 8 | namespace Thruster.ThreadedApp 9 | { 10 | class Program 11 | { 12 | static readonly int[] Creators = Enumerable.Range(1, Environment.ProcessorCount).ToArray(); 13 | 14 | static void Main(string[] args) 15 | { 16 | CompareWithShared(); 17 | //var spans = Enumerable.Range(1, 21).Select(i => RunPipe()).ToArray(); 18 | //Array.Sort(spans); 19 | 20 | //Console.WriteLine($"Pipelining Thruster (mean time) took: {spans[spans.Length / 2]}"); 21 | } 22 | 23 | static void CompareWithShared() 24 | { 25 | var shared = Run(MemoryPool.Shared).GetAwaiter().GetResult(); 26 | Console.WriteLine($"Running Shared took: {shared}"); 27 | 28 | using (var pool = new FastMemoryPool()) 29 | { 30 | var thruster = Run(pool).GetAwaiter().GetResult(); 31 | Console.WriteLine($"Running Thruster took: {thruster}"); 32 | } 33 | } 34 | 35 | static TimeSpan RunPipe() 36 | { 37 | using (var pool = new FastMemoryPool()) 38 | { 39 | var sw = Stopwatch.StartNew(); 40 | 41 | var pipe = new Pipe(new PipeOptions(pool)); 42 | 43 | const int writeLenght = 57; 44 | const long innerLoopCount = 64 * 1024 * 1204; 45 | 46 | var writing = Task.Run(async () => 47 | { 48 | for (int i = 0; i < innerLoopCount; i++) 49 | { 50 | pipe.Writer.GetMemory(writeLenght); 51 | pipe.Writer.Advance(writeLenght); 52 | await pipe.Writer.FlushAsync(); 53 | } 54 | }); 55 | 56 | var reading = Task.Run(async () => 57 | { 58 | long remaining = innerLoopCount * writeLenght; 59 | while (remaining != 0) 60 | { 61 | var result = await pipe.Reader.ReadAsync(); 62 | remaining -= result.Buffer.Length; 63 | pipe.Reader.AdvanceTo(result.Buffer.End, result.Buffer.End); 64 | } 65 | }); 66 | 67 | Task.WaitAll(writing, reading); 68 | 69 | return sw.Elapsed; 70 | } 71 | } 72 | 73 | static async Task Run(MemoryPool pool) 74 | { 75 | var sw = Stopwatch.StartNew(); 76 | await Task.WhenAll(Creators.Select((i) => Task.Run(() => RunSingle(pool)))).ConfigureAwait(false); 77 | return sw.Elapsed; 78 | } 79 | 80 | static void RunSingle(MemoryPool pool) 81 | { 82 | for (var i = 0; i < 100000000; i++) 83 | { 84 | using (var o1 = pool.Rent(1)) 85 | { 86 | o1.Memory.Span[1] = 1; 87 | } 88 | } 89 | } 90 | } 91 | } 92 | -------------------------------------------------------------------------------- /src/Thruster.Benchmarks/PipeThroughputBenchmark.cs: -------------------------------------------------------------------------------- 1 | using System; 2 | using System.Buffers; 3 | using System.IO.Pipelines; 4 | using System.Threading.Tasks; 5 | using BenchmarkDotNet.Attributes; 6 | using Microsoft.AspNetCore.Server.Kestrel.Transport.Abstractions.Internal; 7 | 8 | namespace Thruster.Benchmarks 9 | { 10 | public class PipeThroughputBenchmark : IDisposable 11 | { 12 | const int WriteLenght = 57; 13 | const int Count = 512; 14 | 15 | readonly MemoryPool thruster; 16 | readonly Pipe thrusterPipe; 17 | 18 | readonly MemoryPool kestrel; 19 | readonly Pipe kestrelPipe; 20 | 21 | readonly Pipe sharedPipe; 22 | 23 | public PipeThroughputBenchmark() 24 | { 25 | kestrel = KestrelMemoryPool.Create(); 26 | kestrelPipe = new Pipe(new PipeOptions(kestrel)); 27 | 28 | thruster = new FastMemoryPool(); 29 | thrusterPipe = new Pipe(new PipeOptions(thruster)); 30 | 31 | sharedPipe = new Pipe(new PipeOptions(MemoryPool.Shared)); 32 | } 33 | 34 | [Benchmark(OperationsPerInvoke = Count)] 35 | public void ParseLiveAspNetTwoTasks_Thruster() => ParseLiveTwoTasksImpl(thrusterPipe); 36 | 37 | [Benchmark(OperationsPerInvoke = Count)] 38 | public void ParseLiveAspNetTwoTasks_Shared() => ParseLiveTwoTasksImpl(sharedPipe); 39 | 40 | [Benchmark(OperationsPerInvoke = Count)] 41 | public void ParseLiveAspNetTwoTasks_Kestrel() => ParseLiveTwoTasksImpl(kestrelPipe); 42 | 43 | static void ParseLiveTwoTasksImpl(Pipe pipe) 44 | { 45 | var writing = Task.Run(async () => 46 | { 47 | for (var i = 0; i < Count; i++) 48 | { 49 | pipe.Writer.GetMemory(WriteLenght); 50 | pipe.Writer.Advance(WriteLenght); 51 | await pipe.Writer.FlushAsync(); 52 | } 53 | }); 54 | 55 | var reading = Task.Run(async () => 56 | { 57 | long remaining = Count * WriteLenght; 58 | while (remaining != 0) 59 | { 60 | var result = await pipe.Reader.ReadAsync(); 61 | remaining -= result.Buffer.Length; 62 | pipe.Reader.AdvanceTo(result.Buffer.End, result.Buffer.End); 63 | } 64 | }); 65 | 66 | Task.WaitAll(writing, reading); 67 | } 68 | 69 | [Benchmark(OperationsPerInvoke = Count)] 70 | public void ParseLiveAspNetInline_Thruster() => ParseImpl(thrusterPipe); 71 | 72 | [Benchmark(OperationsPerInvoke = Count)] 73 | public void ParseLiveAspNetInline_Shared() => ParseImpl(sharedPipe); 74 | 75 | [Benchmark(OperationsPerInvoke = Count)] 76 | public void ParseLiveAspNetInline_Kestrel() => ParseImpl(kestrelPipe); 77 | 78 | static void ParseImpl(Pipe pipe) 79 | { 80 | for (var i = 0; i < Count; i++) 81 | { 82 | pipe.Writer.GetMemory(WriteLenght); 83 | pipe.Writer.Advance(WriteLenght); 84 | pipe.Writer.FlushAsync().GetAwaiter().GetResult(); 85 | var result = pipe.Reader.ReadAsync().GetAwaiter().GetResult(); 86 | pipe.Reader.AdvanceTo(result.Buffer.End, result.Buffer.End); 87 | } 88 | } 89 | 90 | public void Dispose() 91 | { 92 | kestrel.Dispose(); 93 | thruster.Dispose(); 94 | } 95 | } 96 | } -------------------------------------------------------------------------------- /src/Thruster.Tests/FastMemoryPoolTests.cs: -------------------------------------------------------------------------------- 1 | using System; 2 | using System.Buffers; 3 | using System.Collections.Concurrent; 4 | using System.Runtime.InteropServices; 5 | using NUnit.Framework; 6 | 7 | namespace Thruster.Tests 8 | { 9 | public class FastMemoryPoolTests 10 | { 11 | const int CoreCount = 1; 12 | static FastMemoryPool CreatePool() => new FastMemoryPool(CoreCount); 13 | 14 | [Test] 15 | public void CanDisposeAfterCreation() 16 | { 17 | var memoryPool = CreatePool(); 18 | memoryPool.Dispose(); 19 | } 20 | 21 | [Test] 22 | public void CanDisposeAfterReturningBlock() 23 | { 24 | var memoryPool = CreatePool(); 25 | var block = memoryPool.Rent(); 26 | block.Dispose(); 27 | memoryPool.Dispose(); 28 | } 29 | 30 | [Test] 31 | public void CanDisposeAfterPinUnpinBlock() 32 | { 33 | var memoryPool = CreatePool(); 34 | var block = memoryPool.Rent(); 35 | block.Memory.Pin().Dispose(); 36 | block.Dispose(); 37 | memoryPool.Dispose(); 38 | } 39 | 40 | [Test] 41 | public void LeasedSegmentsAreConsecutive() 42 | { 43 | var size = default(Size4K).GetChunkSize(); 44 | 45 | using (var memoryPool = CreatePool()) 46 | using (var o1 = memoryPool.Rent(1)) 47 | using (var o2 = memoryPool.Rent(1)) 48 | { 49 | Assert.True(MemoryMarshal.TryGetArray((ReadOnlyMemory)o1.Memory, out var segment1)); 50 | Assert.True(MemoryMarshal.TryGetArray((ReadOnlyMemory)o2.Memory, out var segment2)); 51 | 52 | Assert.AreSame(segment1.Array, segment2.Array); 53 | 54 | var offset1 = segment1.Offset; 55 | Assert.AreEqual(size, segment1.Count); 56 | 57 | Assert.AreEqual(offset1 + size, segment2.Offset); 58 | Assert.AreEqual(size, segment2.Count); 59 | } 60 | } 61 | 62 | //[Test] 63 | //public void SaturatingGeneration0MovesAllocationsToGeneration1() 64 | //{ 65 | // const int size = FastMemoryPool.ChunkSize; 66 | 67 | // using (var memoryPool = CreatePool()) 68 | // { 69 | // var owners = new List>(); 70 | // var arrays = new HashSet(); 71 | 72 | // for (var gen = 0; gen < 3; gen++) 73 | // { 74 | // for (var i = 0; i < 63; i++) 75 | // { 76 | // var owner = memoryPool.Rent(1); 77 | // MemoryMarshal.TryGetArray((ReadOnlyMemory)owner.Memory, out var segment); 78 | // arrays.Add(segment.Array); 79 | 80 | // Assert.AreEqual(size << gen, segment.Count); 81 | // } 82 | 83 | // Assert.AreEqual(gen + 1, arrays.Count); 84 | // } 85 | // } 86 | //} 87 | 88 | [Test] 89 | public void UpAndDown() 90 | { 91 | using (var memoryPool = CreatePool()) 92 | { 93 | var owners = new ConcurrentQueue>(); 94 | 95 | for (int j = 0; j < 10; j++) 96 | { 97 | for (var i = 0; i < 63 + 1; i++) 98 | { 99 | var owner = memoryPool.Rent(1); 100 | owners.Enqueue(owner); 101 | } 102 | 103 | while (owners.TryDequeue(out var o)) 104 | { 105 | o.Dispose(); 106 | } 107 | } 108 | } 109 | } 110 | 111 | 112 | [Test] 113 | public void LeasingFromDisposedPoolThrows() 114 | { 115 | var memoryPool = CreatePool(); 116 | memoryPool.Dispose(); 117 | 118 | Assert.Throws(() => memoryPool.Rent()); 119 | } 120 | } 121 | } -------------------------------------------------------------------------------- /src/Thruster/MemoryPoolImpl.cs: -------------------------------------------------------------------------------- 1 | using System; 2 | using System.Buffers; 3 | using System.Runtime.CompilerServices; 4 | using System.Runtime.InteropServices; 5 | using System.Threading; 6 | 7 | namespace Thruster 8 | { 9 | class MemoryPoolImpl 10 | where TSize : struct, ISize 11 | { 12 | internal const int ChunksPerBucket = Leasing.ChunksPerLeaseLong; 13 | 14 | readonly int processorCount; 15 | readonly T[] memory; 16 | readonly GCHandle gcHandle; 17 | Leasing leasing; 18 | 19 | bool disposed; 20 | 21 | public MemoryPoolImpl(int processorCount) 22 | { 23 | this.processorCount = processorCount; 24 | var allocSize = this.processorCount * ChunksPerBucket * default(TSize).GetChunkSize(); 25 | leasing = new Leasing(processorCount); 26 | 27 | memory = new T[allocSize]; 28 | gcHandle = GCHandle.Alloc(memory, GCHandleType.Pinned); 29 | } 30 | 31 | public IMemoryOwner Rent(int size) 32 | { 33 | if (disposed) 34 | { 35 | throw new ObjectDisposedException("MemoryPool has been disposed."); 36 | } 37 | 38 | var capacity = size.AlignToMultipleOf(default(TSize).GetChunkSize()); 39 | var chunkCount = capacity >> default(TSize).GetChunkSizeLog(); 40 | 41 | var bucketId = GetBucketId(); 42 | var owner = Lease(bucketId, chunkCount, 1); 43 | if (owner != null) 44 | { 45 | return owner; 46 | } 47 | 48 | return LeaseSlowPath(bucketId, chunkCount); 49 | } 50 | 51 | Owner Lease(int bucketId, int chunkCount, int retries) 52 | { 53 | var index = bucketId; 54 | 55 | var lease = Leasing.Lease(ref leasing, index, chunkCount, retries); 56 | if (lease >= 0) 57 | { 58 | return new Owner(this, (byte)bucketId, (byte)chunkCount, (byte)lease); 59 | } 60 | 61 | return default; 62 | } 63 | 64 | void Release(Owner owner) 65 | { 66 | Leasing.Release(ref leasing, owner.BucketId, owner.ChunkCount, owner.Lease); 67 | } 68 | 69 | IMemoryOwner LeaseSlowPath(int bucketId, int chunkCount) 70 | { 71 | var spin = new SpinWait(); 72 | for (var i = 0; i < processorCount; i++) 73 | { 74 | spin.SpinOnce(); 75 | bucketId = (bucketId + i) % processorCount; 76 | 77 | var owner = Lease(bucketId, chunkCount, 3); 78 | if (owner != null) 79 | { 80 | return owner; 81 | } 82 | } 83 | 84 | // allocate if none is found 85 | return new Owner(new Memory(new T[chunkCount * default(TSize).GetChunkSize()])); 86 | } 87 | 88 | public void Dispose(bool disposing) 89 | { 90 | disposed = true; 91 | if (gcHandle.IsAllocated) 92 | { 93 | gcHandle.Free(); 94 | } 95 | } 96 | 97 | class Owner : IMemoryOwner 98 | { 99 | MemoryPoolImpl pool; 100 | public readonly byte BucketId; 101 | public readonly byte ChunkCount; 102 | public readonly byte Lease; 103 | 104 | public Owner(Memory memory) 105 | { 106 | Memory = memory; 107 | } 108 | 109 | public Owner(MemoryPoolImpl pool, byte bucketId, byte chunkCount, byte lease) 110 | { 111 | this.pool = pool; 112 | BucketId = bucketId; 113 | ChunkCount = chunkCount; 114 | Lease = lease; 115 | var offset = (bucketId * ChunksPerBucket + lease) * default(TSize).GetChunkSize(); 116 | Memory = MemoryMarshal.CreateFromPinnedArray(pool.memory, offset, default(TSize).GetChunkSize()); 117 | } 118 | 119 | public void Dispose() 120 | { 121 | pool?.Release(this); 122 | pool = null; 123 | } 124 | 125 | public Memory Memory { get; } 126 | } 127 | 128 | [MethodImpl(MethodImplOptions.AggressiveInlining)] 129 | int GetBucketId() 130 | { 131 | #if NETCOREAPP2_1 132 | return Thread.GetCurrentProcessorId() % processorCount; 133 | #else 134 | return Environment.CurrentManagedThreadId % processorCount; 135 | #endif 136 | } 137 | } 138 | } -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | ## Ignore Visual Studio temporary files, build results, and 2 | ## files generated by popular Visual Studio add-ons. 3 | ## 4 | ## Get latest from https://github.com/github/gitignore/blob/master/VisualStudio.gitignore 5 | 6 | # User-specific files 7 | *.suo 8 | *.user 9 | *.userosscache 10 | *.sln.docstates 11 | 12 | # User-specific files (MonoDevelop/Xamarin Studio) 13 | *.userprefs 14 | 15 | # Build results 16 | [Dd]ebug/ 17 | [Dd]ebugPublic/ 18 | [Rr]elease/ 19 | [Rr]eleases/ 20 | x64/ 21 | x86/ 22 | bld/ 23 | [Bb]in/ 24 | [Oo]bj/ 25 | [Ll]og/ 26 | 27 | # Visual Studio 2015/2017 cache/options directory 28 | .vs/ 29 | # Uncomment if you have tasks that create the project's static files in wwwroot 30 | #wwwroot/ 31 | 32 | # Visual Studio 2017 auto generated files 33 | Generated\ Files/ 34 | 35 | # MSTest test Results 36 | [Tt]est[Rr]esult*/ 37 | [Bb]uild[Ll]og.* 38 | 39 | # NUNIT 40 | *.VisualState.xml 41 | TestResult.xml 42 | 43 | # Build Results of an ATL Project 44 | [Dd]ebugPS/ 45 | [Rr]eleasePS/ 46 | dlldata.c 47 | 48 | # Benchmark Results 49 | BenchmarkDotNet.Artifacts/ 50 | 51 | # .NET Core 52 | project.lock.json 53 | project.fragment.lock.json 54 | artifacts/ 55 | **/Properties/launchSettings.json 56 | 57 | # StyleCop 58 | StyleCopReport.xml 59 | 60 | # Files built by Visual Studio 61 | *_i.c 62 | *_p.c 63 | *_i.h 64 | *.ilk 65 | *.meta 66 | *.obj 67 | *.iobj 68 | *.pch 69 | *.pdb 70 | *.ipdb 71 | *.pgc 72 | *.pgd 73 | *.rsp 74 | *.sbr 75 | *.tlb 76 | *.tli 77 | *.tlh 78 | *.tmp 79 | *.tmp_proj 80 | *.log 81 | *.vspscc 82 | *.vssscc 83 | .builds 84 | *.pidb 85 | *.svclog 86 | *.scc 87 | 88 | # Chutzpah Test files 89 | _Chutzpah* 90 | 91 | # Visual C++ cache files 92 | ipch/ 93 | *.aps 94 | *.ncb 95 | *.opendb 96 | *.opensdf 97 | *.sdf 98 | *.cachefile 99 | *.VC.db 100 | *.VC.VC.opendb 101 | 102 | # Visual Studio profiler 103 | *.psess 104 | *.vsp 105 | *.vspx 106 | *.sap 107 | 108 | # Visual Studio Trace Files 109 | *.e2e 110 | 111 | # TFS 2012 Local Workspace 112 | $tf/ 113 | 114 | # Guidance Automation Toolkit 115 | *.gpState 116 | 117 | # ReSharper is a .NET coding add-in 118 | _ReSharper*/ 119 | *.[Rr]e[Ss]harper 120 | *.DotSettings.user 121 | 122 | # JustCode is a .NET coding add-in 123 | .JustCode 124 | 125 | # TeamCity is a build add-in 126 | _TeamCity* 127 | 128 | # DotCover is a Code Coverage Tool 129 | *.dotCover 130 | 131 | # AxoCover is a Code Coverage Tool 132 | .axoCover/* 133 | !.axoCover/settings.json 134 | 135 | # Visual Studio code coverage results 136 | *.coverage 137 | *.coveragexml 138 | 139 | # NCrunch 140 | _NCrunch_* 141 | .*crunch*.local.xml 142 | nCrunchTemp_* 143 | 144 | # MightyMoose 145 | *.mm.* 146 | AutoTest.Net/ 147 | 148 | # Web workbench (sass) 149 | .sass-cache/ 150 | 151 | # Installshield output folder 152 | [Ee]xpress/ 153 | 154 | # DocProject is a documentation generator add-in 155 | DocProject/buildhelp/ 156 | DocProject/Help/*.HxT 157 | DocProject/Help/*.HxC 158 | DocProject/Help/*.hhc 159 | DocProject/Help/*.hhk 160 | DocProject/Help/*.hhp 161 | DocProject/Help/Html2 162 | DocProject/Help/html 163 | 164 | # Click-Once directory 165 | publish/ 166 | 167 | # Publish Web Output 168 | *.[Pp]ublish.xml 169 | *.azurePubxml 170 | # Note: Comment the next line if you want to checkin your web deploy settings, 171 | # but database connection strings (with potential passwords) will be unencrypted 172 | *.pubxml 173 | *.publishproj 174 | 175 | # Microsoft Azure Web App publish settings. Comment the next line if you want to 176 | # checkin your Azure Web App publish settings, but sensitive information contained 177 | # in these scripts will be unencrypted 178 | PublishScripts/ 179 | 180 | # NuGet Packages 181 | *.nupkg 182 | # The packages folder can be ignored because of Package Restore 183 | **/[Pp]ackages/* 184 | # except build/, which is used as an MSBuild target. 185 | !**/[Pp]ackages/build/ 186 | # Uncomment if necessary however generally it will be regenerated when needed 187 | #!**/[Pp]ackages/repositories.config 188 | # NuGet v3's project.json files produces more ignorable files 189 | *.nuget.props 190 | *.nuget.targets 191 | 192 | # Microsoft Azure Build Output 193 | csx/ 194 | *.build.csdef 195 | 196 | # Microsoft Azure Emulator 197 | ecf/ 198 | rcf/ 199 | 200 | # Windows Store app package directories and files 201 | AppPackages/ 202 | BundleArtifacts/ 203 | Package.StoreAssociation.xml 204 | _pkginfo.txt 205 | *.appx 206 | 207 | # Visual Studio cache files 208 | # files ending in .cache can be ignored 209 | *.[Cc]ache 210 | # but keep track of directories ending in .cache 211 | !*.[Cc]ache/ 212 | 213 | # Others 214 | ClientBin/ 215 | ~$* 216 | *~ 217 | *.dbmdl 218 | *.dbproj.schemaview 219 | *.jfm 220 | *.pfx 221 | *.publishsettings 222 | orleans.codegen.cs 223 | 224 | # Including strong name files can present a security risk 225 | # (https://github.com/github/gitignore/pull/2483#issue-259490424) 226 | #*.snk 227 | 228 | # Since there are multiple workflows, uncomment next line to ignore bower_components 229 | # (https://github.com/github/gitignore/pull/1529#issuecomment-104372622) 230 | #bower_components/ 231 | 232 | # RIA/Silverlight projects 233 | Generated_Code/ 234 | 235 | # Backup & report files from converting an old project file 236 | # to a newer Visual Studio version. Backup files are not needed, 237 | # because we have git ;-) 238 | _UpgradeReport_Files/ 239 | Backup*/ 240 | UpgradeLog*.XML 241 | UpgradeLog*.htm 242 | ServiceFabricBackup/ 243 | *.rptproj.bak 244 | 245 | # SQL Server files 246 | *.mdf 247 | *.ldf 248 | *.ndf 249 | 250 | # Business Intelligence projects 251 | *.rdl.data 252 | *.bim.layout 253 | *.bim_*.settings 254 | *.rptproj.rsuser 255 | 256 | # Microsoft Fakes 257 | FakesAssemblies/ 258 | 259 | # GhostDoc plugin setting file 260 | *.GhostDoc.xml 261 | 262 | # Node.js Tools for Visual Studio 263 | .ntvs_analysis.dat 264 | node_modules/ 265 | 266 | # Visual Studio 6 build log 267 | *.plg 268 | 269 | # Visual Studio 6 workspace options file 270 | *.opt 271 | 272 | # Visual Studio 6 auto-generated workspace file (contains which files were open etc.) 273 | *.vbw 274 | 275 | # Visual Studio LightSwitch build output 276 | **/*.HTMLClient/GeneratedArtifacts 277 | **/*.DesktopClient/GeneratedArtifacts 278 | **/*.DesktopClient/ModelManifest.xml 279 | **/*.Server/GeneratedArtifacts 280 | **/*.Server/ModelManifest.xml 281 | _Pvt_Extensions 282 | 283 | # Paket dependency manager 284 | .paket/paket.exe 285 | paket-files/ 286 | 287 | # FAKE - F# Make 288 | .fake/ 289 | 290 | # JetBrains Rider 291 | .idea/ 292 | *.sln.iml 293 | 294 | # CodeRush 295 | .cr/ 296 | 297 | # Python Tools for Visual Studio (PTVS) 298 | __pycache__/ 299 | *.pyc 300 | 301 | # Cake - Uncomment if you are using it 302 | # tools/** 303 | # !tools/packages.config 304 | 305 | # Tabs Studio 306 | *.tss 307 | 308 | # Telerik's JustMock configuration file 309 | *.jmconfig 310 | 311 | # BizTalk build output 312 | *.btp.cs 313 | *.btm.cs 314 | *.odx.cs 315 | *.xsd.cs 316 | 317 | # OpenCover UI analysis results 318 | OpenCover/ 319 | 320 | # Azure Stream Analytics local run output 321 | ASALocalRun/ 322 | 323 | # MSBuild Binary and Structured Log 324 | *.binlog 325 | 326 | # NVidia Nsight GPU debugger configuration file 327 | *.nvuser 328 | 329 | # MFractors (Xamarin productivity tool) working folder 330 | .mfractor/ 331 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | --------------------------------------------------------------------------------