Skip to content
High performance (Value)Task computation expressions for F#
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
Benchmarks
tools/icons
.gitignore
ComputationBuilders.fs
LICENSE.md Initial 'ready' implementation, includes benchmarks but still missing… Jan 27, 2019
Ply.fs
Ply.fsproj
README.md

README.md

Ply

Ply is a high performance TPL library for F#.

The goal of Ply is to be a near zero overhead abstraction like it is in C#. On master we are at 2 allocations per bind, which are the focus of upcoming work. Then there are the few constant factor allocations which are inevitable and equivalent to C# semantics for async methods.

Compared to C#'s async-await Ply requires — for a regular method of a handful of awaitables — 20 to 30% more Gen0 GCs. This all against a comparable execution time of async-await. Only slowly moving towards TaskBuilder.fs execution time once functions grow larger.

Method Mean Error StdDev Ratio RatioSD Gen 0/1k Op Gen 1/1k Op Gen 2/1k Op Allocated Memory/Op
Ply 24.60 us 1.1610 us 1.3371 us 1.00 0.07 0.3052 - -
'TaskBuilder.fs v2.1.0' 26.86 us 0.6751 us 0.6932 us 1.09 0.03 0.5798 - -
'C# Async Await' 24.59 us 0.8028 us 0.8923 us 1.00 0.00 0.2136 - -

Allocated Memory/Op is removed as it isn't correct on .NET Core.

Ply comes with 6 builders:

  • task (Task<'T>) the only builder inside the netstandard build of Ply.
  • vtask (ValueTask<'T>)
  • uvtask (ValueTask<'T>)
    unsafevaluetask is the only allocation free value returning TPL CE Ply comes with. This does come with a trade-off as it skips construction of an execution bubble. An execution bubble is made by any C# async-await method for capturing and restoring async local and synchronization context changes. These potential changes would otherwise escape onto the caller context. If you know however that you and any other synchronous methods you call don't make any changes there's nothing inherently unsafe about uvtask.
  • unitTask (Task) As the TPL doesn't know F#s unit type Task.FromResult(()) won't ever return a cached task, this CE works around that for netcoreapp consumers by checking the returned ValueTask<unit> for a succesful completion, if so it can directly return a CompletedTask.
  • uunitTask (Task) A variant of unitTask with the same caveats as uvtask, the trade-off is that it can be truly allocation free.
  • ply (Ply<'T>) Can be enqueued directly onto the binding callsite's state machine, skips Task and safety wrapping

More docs are coming.

Special Thanks

Thanks to @gusty for very valuable SRTP advice, it helped me tremendously to narrow down what specifically was wrong about an earlier approach I took.

Thanks to @rspeele TaskBuilder.fs was a great inspiration in developing Ply.

Next Steps and Improvements

  • Finish up the experimental branch.
You can’t perform that action at this time.