Report a lane enqueue or SynchronizationContext.Post from a non-simulation thread as a deterministic failure

Open
#76 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
43/100
Issue type
Bug
Clarity
Mostly clear
Activity status
Active
Tech stack
csharp

Research direction

Start by reading SimulationSchedulerLane.Enqueue, SimulationSynchronizationContext.Post and Send, and SimulationScheduler.RegisterCore; the issue identifies these as candidate points for detecting off-thread operation registration. Trace how RunStep surfaces failures and how the driver reports stalls or completion. Done means an off-thread post fails deterministically with its escaping stack, including when it arrives late.

Written by the indexing model from the issue text.

Description

Summary

Work posted into a simulation from a thread outside it is accepted silently today. SimulationSchedulerLane.Enqueue (and so SimulationSynchronizationContext.Post) succeeds on a real thread-pool thread. Its SingleThreadedGuard detects only concurrent entry, so the post becomes an operation that no seed decides.

The run then goes wrong in one of two ways:

  • It diverges silently. The recorded schedule replays only up to the point where the operation appeared.
  • It stalls spuriously. If the post lands after the driver's RunStep returned false, TryAdvanceVirtualTime declines, because something is now runnable. The driver then sees nothing runnable and no timer pending, while DescribeLiveness() reports runnable 1 or ExternallyCompletable.

The existing affinity check doesn't catch this. The escaped thread carries no simulation runtime context, so no controlled API reports a SimulationThreadAffinityException.

This was found in ReubenBond/clog#360 and fixed there on the consumer side in ReubenBond/clog#361.

Minimal reproduction

The escape needs unrewritten code (for example a simulation test assembly, which the build doesn't rewrite) that awaits a BCL task combinator over a task that runs its continuations asynchronously:

// In the (unrewritten) test assembly, inside a scenario started on a lane:
var answered = new TaskCompletionSource(TaskCreationOptions.RunContinuationsAsynchronously);
var never = new TaskCompletionSource();
var any = Task.WhenAny(answered.Task, never.Task);   // the BCL's combinator, not ControlledTask.WhenAny
bool? inside = null;
_ = any.ContinueWith(_ => inside = scheduler.IsSimulationThread,
    CancellationToken.None, TaskContinuationOptions.ExecuteSynchronously, TaskScheduler.Default);

answered.SetResult();
await any;          // the continuation is posted to the lane's SynchronizationContext from a .NET TP Worker
never.SetResult();
// inside == false, every run.

Here is why the BCL escapes. Task.RunContinuations doesn't run an ITaskCompletionAction whose InvokeMayRunArbitraryCode is true inline when the completing task has RunContinuationsAsynchronously. It queues it to the thread pool instead, and that includes the TwoTaskWhenAnyPromise. The promise then completes any on the pool, and the await continuation is posted to the lane from that thread.

A diagnostic build logged the stack of every operation registered while !IsSimulationThread. Each one was:

SimulationScheduler.RegisterCore
SimulationScheduler.Schedule / ScheduleAfter
SimulationSchedulerLane.Schedule / Enqueue(ScheduledItem)
SimulationSynchronizationContext.Post
System.Threading.Tasks.AwaitTaskContinuation.RunCallback
System.Threading.Tasks.Task.RunContinuations
System.Threading.Tasks.Task`1.TrySetResult
System.Threading.Tasks.Task.TwoTaskWhenAnyPromise`1.Invoke
System.Threading.ThreadPoolWorkQueue.Dispatch          (".NET TP Worker")

Proposed hardening

When a lane enqueue, and so SimulationSynchronizationContext.Post/Send, comes from a thread that isn't one of the scheduler's operation threads and doesn't hold its control scope (!IsSimulationThread):

  1. Record it as a thread-affinity violation, as ReportThreadAffinityViolation does for controlled APIs.
  2. Have the driving thread's next RunStep surface it, so the run fails with the escaping stack rather than diverging or stalling.

A second check would make the failure deterministic even when the escaped thread posts late. When the driver reports a stall or finishes, it could check whether any operation was registered off the simulation thread since the last step.

Possibly related: RegisterCore (and ScheduleAfter's timer path) is the common point where any operation is created, so one check there would cover lanes, timers, and direct Schedule calls alike.

Consumer-side fix, for reference

ReubenBond/clog#361 bans the BCL's Task.WhenAll, Task.WhenAny and Task.WhenEach in simulation test projects, and routes them through a rewritten helper that binds to ControlledTask's combinators. The hardening proposed here would turn any similar escape (Task.Yield or an await with no synchronization context, a raw ThreadPool call, and so on) into an immediate, attributable failure.

Dominant language
C#
Stars
0
Forks
0
Avg merge
2h 32m
Merged PRs (30d)
23

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from ReubenBond/Clockwork

All issues in ReubenBond/Clockwork

Similar issues

More C# issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.