Added benchmarks

.github/workflows/dotnet.yml

@@ -26,3 +26,7 @@ jobs:
       run: dotnet build --no-restore
     - name: Test
       run: dotnet test --no-build --verbosity normal
+    - name: Run
+      run: dotnet run --project Examples
+    - name: Bench
+      run: dotnet run --property:Configuration=Release --project Actors.Benchmarks

.gitignore

@@ -261,3 +261,6 @@ FakesAssemblies/
 
 # Visual Studio 6 workspace options file
 *.opt
+
+.idea
+BenchmarkDotNet.Artifacts

Actors.Benchmarks/AckDelivery.cs

@@ -0,0 +1,34 @@
+using System;
+using System.Threading.Tasks;
+using BenchmarkDotNet;
+using BenchmarkDotNet.Attributes;
+
+namespace Actors.Benchmarks;
+
+public class AckDelivery
+{
+    class WorkItem
+    {
+        public TaskCompletionSource Completion { get; } = new();
+    }
+
+    class AckDeliveryWorker : Actor<WorkItem>
+    {
+        protected override Task Perform(Inbox inbox)
+        {
+            var workItem = inbox.Receive();
+            workItem.Completion.SetResult();
+            return Task.CompletedTask;
+        }
+    }
+
+    private readonly AckDeliveryWorker worker = new();
+
+    [Benchmark]
+    public async Task SendAndAwaitAck()
+    {
+        var workItem = new WorkItem();
+        worker.Send(workItem);
+        await workItem.Completion.Task;
+    }
+}

Actors.Benchmarks/Actors.Benchmarks.csproj

@@ -0,0 +1,23 @@
+<Project Sdk="Microsoft.NET.Sdk">
+  <PropertyGroup>
+    <TargetFramework>net8.0</TargetFramework>
+    <OutputType>Exe</OutputType>
+  </PropertyGroup>
+  <PropertyGroup>
+    <PlatformTarget>AnyCPU</PlatformTarget>
+    <DebugType>pdbonly</DebugType>
+    <DebugSymbols>true</DebugSymbols>
+    <AllowUnsafeBlocks>true</AllowUnsafeBlocks>
+    <Optimize>true</Optimize>
+    <Configuration>Release</Configuration>
+    <IsPackable>false</IsPackable>
+  </PropertyGroup>
+  <ItemGroup>
+    <PackageReference Include="BenchmarkDotNet" Version="0.13.12" />
+    <PackageReference Include="BenchmarkDotNet.Diagnostics.Windows" Version="0.13.12" Condition="'$(OS)' == 'Windows_NT'"/>
+  </ItemGroup>
+
+  <ItemGroup>
+    <ProjectReference Include="..\Actors\Actors.csproj" />
+  </ItemGroup>
+</Project>

Actors.Benchmarks/FireAndForget.cs

@@ -0,0 +1,33 @@
+using System;
+using System.Threading.Tasks;
+using BenchmarkDotNet;
+using BenchmarkDotNet.Attributes;
+
+namespace Actors.Benchmarks;
+
+public class FireAndForget
+{
+    class FireAndForgetWorker : Actor<int>
+    {
+        protected override Task Perform(Inbox inbox)
+        {
+            inbox.Receive();
+            return Task.CompletedTask;
+        }
+    }
+
+    private readonly FireAndForgetWorker worker = new();
+
+    [Params(1_000)]
+    public int numMessages;
+
+    [Benchmark]
+    public async Task SendAndDrain()
+    {
+        for (var i = 0; i < numMessages; i++)
+        {
+            worker.Send(i);
+        }
+        await worker.Drain();
+    }
+}

Actors.Benchmarks/Program.cs

@@ -0,0 +1,18 @@
+using BenchmarkDotNet.Configs;
+using BenchmarkDotNet.Running;
+
+namespace Actors.Benchmarks
+{
+    public class Program
+    {
+        public static void Main(string[] args)
+        {
+            var config = DefaultConfig.Instance;
+            BenchmarkRunner.Run<FireAndForget>(config, args);
+            BenchmarkRunner.Run<AckDelivery>(config, args);
+
+            // Use this to select benchmarks from the console:
+            // var summaries = BenchmarkSwitcher.FromAssembly(typeof(Program).Assembly).Run(args, config);
+        }
+    }
+}

Actors/Actor.cs

@@ -150,7 +150,7 @@ private async Task RunAsync()
     /// <summary>
     /// Represents the actor's dedicated inbox.
     /// </summary>
-    public class Inbox
+    protected class Inbox
     {
         private readonly Actor<M> actor;
 

Examples/Throttle/Throttle.cs

@@ -52,12 +52,12 @@ class Parent : Actor
         private const int Radix = 10;
 
         /// <summary>
-        /// The maximum number of works that may coexist.
+        /// The maximum number of workers that may coexist.
         /// </summary>
         private const int MaxChildren = 8;
 
         /// <summary>
-        /// The worker children. (Child labour.)
+        /// The child worker actors. (Child labour.)
         /// </summary>
         private readonly Child?[] children = new Child[Radix];
 

actors.sln

@@ -9,6 +9,8 @@ Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Actors", "Actors\Actors.csp
 EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Actors.Tests", "Actors.Tests\Actors.Tests.csproj", "{608221E0-A26E-40C5-AF55-286292D042A4}"
 EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Actors.Benchmarks", "Actors.Benchmarks\Actors.Benchmarks.csproj", "{786D9D14-EC7B-4574-9C4E-38DA97FA2077}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -30,5 +32,9 @@ Global
 		{608221E0-A26E-40C5-AF55-286292D042A4}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{608221E0-A26E-40C5-AF55-286292D042A4}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{608221E0-A26E-40C5-AF55-286292D042A4}.Release|Any CPU.Build.0 = Release|Any CPU
+		{786D9D14-EC7B-4574-9C4E-38DA97FA2077}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{786D9D14-EC7B-4574-9C4E-38DA97FA2077}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{786D9D14-EC7B-4574-9C4E-38DA97FA2077}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{786D9D14-EC7B-4574-9C4E-38DA97FA2077}.Release|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection
 EndGlobal

justfile

@@ -3,7 +3,7 @@ _help:
 
 # runs the example app
 run *ARGS:
-    dotnet run --project Examples/Examples.csproj {{ARGS}}
+    dotnet run --project Examples {{ARGS}}
 
 # runs the test cases
 test:
@@ -12,3 +12,7 @@ test:
 # loops through test cases
 loop:
     while [ true ]; do dotnet test; done
+
+# runs the benchmarks
+bench:
+    dotnet run --property:Configuration=Release --project Actors.Benchmarks