Block in-place if running on a virtual thread #3870

armanbilge · 2023-10-09T23:35:30Z

Closes #3869, h/t Daniel for the idea.

If a fiber detects that it is running on a virtual thread then it will invoke a blocking operation in-place (similar to the scala.concurrent.blocking mechanism). This allows to do stuff like:

IO.interruptible(...).evalOnExecutor(Executors.newVirtualThreadPerTaskExecutor())

This PR is targeted at series/3.x because we are pinned to Scala 3.2 in series/3.5.x and that doesn't support JDK 21. We could backport the implementation changes here to 3.5.x but we cannot test them.

@alexandru wdyt?

He-Pin · 2023-10-10T06:22:45Z

tests/jvm/src/test/scala/cats/effect/IOPlatformSpecification.scala

+            classOf[Thread]
+              .getDeclaredMethod("isVirtual")
+              .invoke(Thread.currentThread())
+              .asInstanceOf[Boolean]


why not used method handle too?

This is test code.

wb14123 · 2023-10-11T13:08:20Z

Will evalOnExecutor shift both blocking and unblocking IOs to the virtual threads pool?

armanbilge · 2023-10-11T16:09:21Z

@wb14123 yes. To be more precise:

evalOn (and evalOnExecutor) modify the compute execution context for a task, but not the blocking EC.
After the changes in this PR, a fiber running on a virtual thread will run blocking operations in-place i.e. on the same virtual thread that it is already running on.

wb14123 · 2023-10-11T17:50:56Z

core/shared/src/main/scala/cats/effect/IOFiber.scala

+              var error: Throwable = null
+              val r =
+                try {
+                  cur.thunk()


Shall we also use scala.concurrent.blocking(cur.thunk()) here so that if thunk() is an operation that blocks the OS thread, JVM can spawn another OS thread? If it doesn't block the OS thread, since val ec = currentCtx is virtual thread pool, JVM will still use the same OS thread.

scala.concurrent.blocking doesn't do anything for virtual threads, because virtual threads do not extend scala.concurrent.BlockContext :)

if thunk() is an operation that blocks the OS thread, JVM can spawn another OS thread

The entire point of using virtual threads is that the JVM will manage all of this for you. Further reading.

Hmm, maybe I am wrong about that 🤔

The scheduler does not compensate for pinning by expanding its parallelism

https://openjdk.org/jeps/425

Yeah I think it only creates a virtual thread if you submit the task to virtual thread executor. So maybe something like currentCtx.execute(cur.thunk) (suppose currentCtx is the virtual thread executor)

Oh, I read the wrong section.

However, some blocking operations in the JDK do not unmount the virtual thread, and thus block both its carrier and the underlying OS thread. This is because of limitations either at the OS level (e.g., many filesystem operations) or at the JDK level (e.g., Object.wait()). The implementation of these blocking operations will compensate for the capture of the OS thread by temporarily expanding the parallelism of the scheduler. Consequently, the number of platform threads in the scheduler's ForkJoinPool may temporarily exceed the number of available processors.

It's very confusing. But the point is that the JVM is handling it 😅

Is it possible that blockingOp and nonblockingOp share the same virtual thread?

Yes they will share the same virtual thread. But that is not a problem: the second IO should not run until the first IO completes, so it does not matter if the virtual thread is blocked.

Sorry my bad... I meant to run them in parallel: IO.blocking(blockingOp) &> IO(nonblockingOp)

In that case, an independent fiber will be created for each IO, and those fibers will be submitted to the execution context. If you are using newVirtualThreadPerTaskExecutor that means that each of those fibers will run on its own virtual thread.

Oh I see, in this case it should be fine then, thanks for the patient explanation!

Indeed, the JVM is handling it. Also, some limits may be lifted in time, such as Object.wait.

armanbilge · 2023-10-11T18:46:33Z

core/shared/src/main/scala/cats/effect/IOFiber.scala

+            } else if (isVirtualThread(Thread.currentThread())) {
+              var error: Throwable = null
+              val r =
+                try {
+                  cur.thunk()


Very important to call out: there is a big assumption here that if we are running on a virtual thread, the model being used is that each fiber is running on a dedicated virtual thread. While this seems like the most sensible way to use virtual threads, it's not the only way.

For example, someone could build an execution context with a fixed number of virtual threads that poll from a shared task queue. In that case, blocking the virtual thread as we are doing here would be very problematic for them.

someone could build an execution context with a fixed number of virtual threads

I think that is looking for trouble. The documentation literally says "Never Pool Virtual Threads"...

There might be cases in which limiting the number of possible virtual threads is desirable. For example, for limiting parallelism in certain instances. But I don't see the problem, because it would work as the user intended.

The only question is if we should integrate with BlockContext. I think we can integrate, as I don't think you necessarily need to inherit Threads from it. But for now, I don't think it's necessary; mostly because I can't think of any reason for wanting to limit virtual threads while allowing more threads in case of blocking operations.

There might be cases in which limiting the number of possible virtual threads is desirable.

To be clear: there is actually no issue with limiting the number of virtual threads. The concern is if a virtual thread may be responsible for running more than one fiber. So long as every fiber has its own virtual thread, then there is no problem.

edit: I wrote that too late at night and it doesn't make sense, sorry :)

I think we can integrate, as I don't think you necessarily need to inherit Threads from it.

You can also install the BlockContext as a thread-local, but making this work will add some allocations and overhead.

alexandru · 2023-10-15T06:47:53Z

core/jvm/src/main/java/cats/effect/IOFiberConstants.java

+      mh = lookup.findVirtual(Thread.class, "isVirtual", mt);
+    } catch (Throwable t) {
+      mh =
+          MethodHandles.dropArguments(


Seems wasteful to produce a method handle that always returns false when invoked. Maybe I'm missing something, maybe this ends up as being inlined, and it doesn't matter, but I would see this method more like:

static boolean isVirtualThread(final Thread thread) { if (THREAD_IS_VIRTUAL_HANDLE != null) try { return (boolean) THREAD_IS_VIRTUAL_HANDLE.invokeExact(thread); } catch (Throwable t) {} return false; }

Yeah, I mean I have no idea without studying the assembly and/or benchmarking 😄

In your version, we depend on the JVM optimizing away the conditional and branching. In my version there is no branching, just a static method call, which would ideally be inlined.

alexandru · 2023-10-15T07:01:14Z

core/shared/src/main/scala/cats/effect/IOFiber.scala

+            } else if (isVirtualThread(Thread.currentThread())) {
+              var error: Throwable = null
+              val r =
+                try {
+                  cur.thunk()


There might be cases in which limiting the number of possible virtual threads is desirable. For example, for limiting parallelism in certain instances. But I don't see the problem, because it would work as the user intended.

The only question is if we should integrate with BlockContext. I think we can integrate, as I don't think you necessarily need to inherit Threads from it. But for now, I don't think it's necessary; mostly because I can't think of any reason for wanting to limit virtual threads while allowing more threads in case of blocking operations.

alexandru

Looking good 👍

alexandru · 2023-10-15T07:32:13Z

core/shared/src/main/scala/cats/effect/IOFiber.scala

+                }
+
+              val next = if (error eq null) succeeded(r, 0) else failed(error, 0)
+              runLoop(next, nextCancelation, nextAutoCede)


The optimization is good to have in the current implementation, but there's something I don't like...

I would have expected the ability to override runtime.blocking, and evalOn doesn't do that. Also, WorkStealingThreadPool is special-cased, and this forces virtual threads to be special cased, too. And in both cases, runtime.blocking is ignored, which smells like a semantic issue that causes confusion.

An alternative would have been to look at the runtime.blocking thread-pool and notice that we are already on it. In which case no thread shift would be necessary.

An alternative would have been to look at the runtime.blocking thread-pool and notice that we are already on it.

It's an interesting idea, but this would apply only to virtual threads anyway: this is the only pool on which it is safe to submit/run tasks whether they are blocking or not. There is no other ExecutionContext that can directly handle both: the WorkStealingThreadPool and ForkJoinPool can handle blocking but only if it is appropriately wrapped in scala.concurrent.blocking(...) so in general it is not safe to submit arbitrary blocking tasks directly to these ExecutionContexts.

And in both cases, runtime.blocking is ignored, which smells like a semantic issue that causes confusion.

I agree, it's confusing 😕 currently, runtime.blocking operates as a fallback, when you are not on the WSTP or a virtual thread.

Also, WorkStealingThreadPool is special-cased, and this forces virtual threads to be special cased, too.

We could relax the special-casing a little bit by detecting if the current thread implements BlockContext, in which case it would be safe to use the blocking(...) mechanism. Besides encompassing the WSTP this would allow us to support the FJP as well.

But it doesn't help with virtual threads which do not and cannot implement BlockContext so is out-of-scope for this PR.

djspiewak

Ty for tackling this!

The merge-base changed after approval.

armanbilge added 7 commits October 9, 2023 23:32

Block in-place if running on a virtual thread

e256a8b

Try using Oracle 21 instead

aeda41c

Formatting

8572309

More formatting

b406111

Use reflection API in test

35de2aa

Tweak javac linting

3090ba0

nowarn

8f9c1ed

He-Pin reviewed Oct 10, 2023

View reviewed changes

armanbilge added 2 commits October 10, 2023 06:28

workaround unused warning

cdf7024

Add JDK 21 to CI matrix

ba4eb08

armanbilge mentioned this pull request Oct 10, 2023

Add JDK 21 to CI matrix #3871

Merged

armanbilge added 2 commits October 10, 2023 08:36

Merge remote-tracking branch 'origin/topic/jdk21' into issue/3869

e39098b

Another attempt to nowarn

bc0dab1

armanbilge mentioned this pull request Oct 11, 2023

Virtual Threads (Project Loom) in IO.blocking / IO.interruptible #3869

Closed

wb14123 reviewed Oct 11, 2023

View reviewed changes

armanbilge commented Oct 11, 2023

View reviewed changes

alexandru reviewed Oct 15, 2023

View reviewed changes

armanbilge added this to the v3.6.0 milestone Nov 15, 2023

djspiewak previously approved these changes Nov 23, 2023

View reviewed changes

djspiewak merged commit bd93f74 into typelevel:series/3.x Nov 23, 2023
32 of 36 checks passed

armanbilge mentioned this pull request Dec 23, 2023

Non-blocking backend for Process APIs typelevel/fs2#3182

Open

armanbilge mentioned this pull request Jan 3, 2024

Experiment with Loom #1057

Open

armanbilge added the 🍄 enhancement label Dec 20, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Block in-place if running on a virtual thread #3870

Block in-place if running on a virtual thread #3870

armanbilge commented Oct 9, 2023

He-Pin Oct 10, 2023

armanbilge Oct 10, 2023

wb14123 commented Oct 11, 2023

armanbilge commented Oct 11, 2023

wb14123 Oct 11, 2023

armanbilge Oct 11, 2023

armanbilge Oct 11, 2023

wb14123 Oct 11, 2023

armanbilge Oct 11, 2023

armanbilge Oct 11, 2023

wb14123 Oct 11, 2023 •

edited

Loading

armanbilge Oct 11, 2023 •

edited

Loading

wb14123 Oct 11, 2023

alexandru Oct 15, 2023

armanbilge Oct 11, 2023 •

edited

Loading

durban Oct 12, 2023

alexandru Oct 15, 2023

armanbilge Oct 15, 2023 •

edited

Loading

alexandru Oct 15, 2023

armanbilge Oct 15, 2023

alexandru Oct 15, 2023

alexandru left a comment

alexandru Oct 15, 2023

armanbilge Nov 10, 2023

djspiewak left a comment

Block in-place if running on a virtual thread #3870

Block in-place if running on a virtual thread #3870

Conversation

armanbilge commented Oct 9, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

wb14123 commented Oct 11, 2023

armanbilge commented Oct 11, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

wb14123 Oct 11, 2023 • edited Loading

Choose a reason for hiding this comment

armanbilge Oct 11, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

armanbilge Oct 11, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

armanbilge Oct 15, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

alexandru left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

djspiewak left a comment

Choose a reason for hiding this comment

wb14123 Oct 11, 2023 •

edited

Loading

armanbilge Oct 11, 2023 •

edited

Loading

armanbilge Oct 11, 2023 •

edited

Loading

armanbilge Oct 15, 2023 •

edited

Loading