Scala Native

.github/workflows/ci.yml

@@ -25,7 +25,7 @@ jobs:
         os: [ubuntu-latest, windows-latest, macos-latest]
         scala: [3.1.2, 2.12.16, 2.13.8]
         java: [temurin@8, temurin@11, temurin@17, graalvm@11]
-        ci: [ciJVM, ciJS, ciFirefox, ciChrome]
+        ci: [ciJVM, ciNative, ciJS, ciFirefox, ciChrome]
         exclude:
           - scala: 3.1.2
             java: temurin@11
@@ -53,6 +53,16 @@ jobs:
             scala: 2.12.16
           - ci: ciChrome
             scala: 2.12.16
+          - ci: ciNative
+            java: temurin@11
+          - ci: ciNative
+            java: temurin@17
+          - ci: ciNative
+            java: graalvm@11
+          - os: windows-latest
+            ci: ciNative
+          - os: macos-latest
+            ci: ciNative
           - ci: ciJS
             java: temurin@11
           - ci: ciJS
@@ -210,6 +220,11 @@ jobs:
         shell: bash
         run: example/test-js.sh ${{ matrix.scala }}
 
+      - name: Test Example Native App Using Binary
+        if: matrix.ci == 'ciNative' && matrix.os == 'ubuntu-latest'
+        shell: bash
+        run: example/test-native.sh ${{ matrix.scala }}
+
       - name: Scalafix tests
         if: matrix.scala == '2.13.8' && matrix.ci == 'ciJVM' && matrix.os == 'ubuntu-latest'
         shell: bash

build.sbt

@@ -167,6 +167,11 @@ ThisBuild / githubWorkflowBuild := Seq(
     name = Some("Test Example JavaScript App Using Node"),
     cond = Some(s"matrix.ci == 'ciJS' && matrix.os == '$PrimaryOS'")
   ),
+  WorkflowStep.Run(
+    List("example/test-native.sh ${{ matrix.scala }}"),
+    name = Some("Test Example Native App Using Binary"),
+    cond = Some(s"matrix.ci == 'ciNative' && matrix.os == '$PrimaryOS'")
+  ),
   WorkflowStep.Run(
     List("cd scalafix", "sbt test"),
     name = Some("Scalafix tests"),
@@ -198,7 +203,7 @@ ThisBuild / githubWorkflowBuildMatrixExclusions := {
     ci <- jsCiVariants.tail
   } yield MatrixExclude(Map("ci" -> ci, "scala" -> scala))
 
-  val jsJavaAndOSFilters = jsCiVariants.flatMap { ci =>
+  val nativeJsJavaAndOSFilters = (CI.Native.command :: jsCiVariants).flatMap { ci =>
     val javaFilters =
       (ThisBuild / githubWorkflowJavaVersions).value.filterNot(Set(ScalaJSJava)).map { java =>
         MatrixExclude(Map("ci" -> ci, "java" -> java.render))
@@ -214,7 +219,7 @@ ThisBuild / githubWorkflowBuildMatrixExclusions := {
     MatrixExclude(Map("os" -> Windows, "java" -> GraalVM.render))
   )
 
-  scalaJavaFilters ++ windowsAndMacScalaFilters ++ jsScalaFilters ++ jsJavaAndOSFilters ++ flakyFilters
+  scalaJavaFilters ++ windowsAndMacScalaFilters ++ jsScalaFilters ++ nativeJsJavaAndOSFilters ++ flakyFilters
 }
 
 lazy val useJSEnv =
@@ -257,14 +262,15 @@ val CatsVersion = "2.8.0"
 val Specs2Version = "4.16.0"
 val ScalaCheckVersion = "1.16.0"
 val DisciplineVersion = "1.4.0"
-val CoopVersion = "1.1.1"
+val CoopVersion = "1.2.0"
 
 val MacrotaskExecutorVersion = "1.0.0"
 
 tlReplaceCommandAlias("ci", CI.AllCIs.map(_.toString).mkString)
 addCommandAlias("release", "tlRelease")
 
 addCommandAlias(CI.JVM.command, CI.JVM.toString)
+addCommandAlias(CI.Native.command, CI.Native.toString)
 addCommandAlias(CI.JS.command, CI.JS.toString)
 addCommandAlias(CI.Firefox.command, CI.Firefox.toString)
 addCommandAlias(CI.Chrome.command, CI.Chrome.toString)
@@ -276,12 +282,27 @@ addCommandAlias(
 val jsProjects: Seq[ProjectReference] =
   Seq(kernel.js, kernelTestkit.js, laws.js, core.js, testkit.js, testsJS, std.js, example.js)
 
+val nativeProjects: Seq[ProjectReference] =
+  Seq(
+    kernel.native,
+    kernelTestkit.native,
+    laws.native,
+    core.native,
+    testkit.native,
+    tests.native,
+    std.native,
+    example.native)
+
 val undocumentedRefs =
-  jsProjects ++ Seq[ProjectReference](benchmarks, example.jvm, tests.jvm, tests.js)
+  jsProjects ++ nativeProjects ++ Seq[ProjectReference](
+    benchmarks,
+    example.jvm,
+    tests.jvm,
+    tests.js)
 
 lazy val root = project
   .in(file("."))
-  .aggregate(rootJVM, rootJS)
+  .aggregate(rootJVM, rootJS, rootNative)
   .enablePlugins(NoPublishPlugin)
   .enablePlugins(ScalaUnidocPlugin)
   .settings(
@@ -306,11 +327,13 @@ lazy val rootJVM = project
 
 lazy val rootJS = project.aggregate(jsProjects: _*).enablePlugins(NoPublishPlugin)
 
+lazy val rootNative = project.aggregate(nativeProjects: _*).enablePlugins(NoPublishPlugin)
+
 /**
  * The core abstractions and syntax. This is the most general definition of Cats Effect, without
  * any concrete implementations. This is the "batteries not included" dependency.
  */
-lazy val kernel = crossProject(JSPlatform, JVMPlatform)
+lazy val kernel = crossProject(JSPlatform, JVMPlatform, NativePlatform)
   .in(file("kernel"))
   .settings(
     name := "cats-effect-kernel",
@@ -322,12 +345,15 @@ lazy val kernel = crossProject(JSPlatform, JVMPlatform)
   .jsSettings(
     libraryDependencies += "org.scala-js" %%% "scala-js-macrotask-executor" % MacrotaskExecutorVersion % Test
   )
+  .nativeSettings(
+    libraryDependencies += "io.github.cquiroz" %%% "scala-java-time" % "2.4.0"
+  )
 
 /**
  * Reference implementations (including a pure ConcurrentBracket), generic ScalaCheck
  * generators, and useful tools for testing code written against Cats Effect.
  */
-lazy val kernelTestkit = crossProject(JSPlatform, JVMPlatform)
+lazy val kernelTestkit = crossProject(JSPlatform, JVMPlatform, NativePlatform)
   .in(file("kernel-testkit"))
   .dependsOn(kernel)
   .settings(
@@ -357,7 +383,7 @@ lazy val kernelTestkit = crossProject(JSPlatform, JVMPlatform)
  * dependency issues. As a consequence of this split, some things which are defined in
  * kernelTestkit are *tested* in the Test scope of this project.
  */
-lazy val laws = crossProject(JSPlatform, JVMPlatform)
+lazy val laws = crossProject(JSPlatform, JVMPlatform, NativePlatform)
   .in(file("laws"))
   .dependsOn(kernel, kernelTestkit % Test)
   .settings(
@@ -372,7 +398,7 @@ lazy val laws = crossProject(JSPlatform, JVMPlatform)
  * contains some general datatypes built on top of IO which are useful in their own right, as
  * well as some utilities (such as IOApp). This is the "batteries included" dependency.
  */
-lazy val core = crossProject(JSPlatform, JVMPlatform)
+lazy val core = crossProject(JSPlatform, JVMPlatform, NativePlatform)
   .in(file("core"))
   .dependsOn(kernel, std)
   .settings(
@@ -706,7 +732,7 @@ lazy val core = crossProject(JSPlatform, JVMPlatform)
  * Test support for the core project, providing various helpful instances like ScalaCheck
  * generators for IO and SyncIO.
  */
-lazy val testkit = crossProject(JSPlatform, JVMPlatform)
+lazy val testkit = crossProject(JSPlatform, JVMPlatform, NativePlatform)
   .in(file("testkit"))
   .dependsOn(core, kernelTestkit)
   .settings(
@@ -720,7 +746,7 @@ lazy val testkit = crossProject(JSPlatform, JVMPlatform)
 /**
  * Unit tests for the core project, utilizing the support provided by testkit.
  */
-lazy val tests: CrossProject = crossProject(JSPlatform, JVMPlatform)
+lazy val tests: CrossProject = crossProject(JSPlatform, JVMPlatform, NativePlatform)
   .in(file("tests"))
   .dependsOn(core, laws % Test, kernelTestkit % Test, testkit % Test)
   .enablePlugins(BuildInfoPlugin, NoPublishPlugin)
@@ -768,7 +794,7 @@ lazy val testsJVM = tests
  * implementations will require IO, and thus those tests will be located within the core
  * project.
  */
-lazy val std = crossProject(JSPlatform, JVMPlatform)
+lazy val std = crossProject(JSPlatform, JVMPlatform, NativePlatform)
   .in(file("std"))
   .dependsOn(kernel)
   .settings(
@@ -816,12 +842,15 @@ lazy val std = crossProject(JSPlatform, JVMPlatform)
       ProblemFilters.exclude[MissingClassProblem]("cats.effect.std.JavaSecureRandom$")
     )
   )
+  .nativeSettings(
+    Compile / doc / sources := Seq.empty
+  )
 
 /**
  * A trivial pair of trivial example apps primarily used to show that IOApp works as a practical
  * runtime on both target platforms.
  */
-lazy val example = crossProject(JSPlatform, JVMPlatform)
+lazy val example = crossProject(JSPlatform, JVMPlatform, NativePlatform)
   .in(file("example"))
   .dependsOn(core)
   .enablePlugins(NoPublishPlugin)

core/js/src/main/scala/cats/effect/unsafe/WorkStealingThreadPool.scala → core/js-native/src/main/scala/cats/effect/unsafe/WorkStealingThreadPool.scala

@@ -28,4 +28,12 @@ private[effect] sealed abstract class WorkStealingThreadPool private ()
   def reportFailure(cause: Throwable): Unit
   private[effect] def reschedule(runnable: Runnable): Unit
   private[effect] def canExecuteBlockingCode(): Boolean
+  private[unsafe] def liveFibers()
+      : (Set[Runnable], Map[WorkerThread, (Option[Runnable], Set[Runnable])], Set[Runnable])
+}
+
+private[unsafe] sealed abstract class WorkerThread private () extends Thread {
+  private[unsafe] def isOwnedBy(threadPool: WorkStealingThreadPool): Boolean
+  private[unsafe] def monitor(fiber: Runnable): WeakBag.Handle
+  private[unsafe] def index: Int
 }

core/jvm/src/main/scala/cats/effect/unsafe/FiberMonitor.scala → core/jvm-native/src/main/scala/cats/effect/unsafe/FiberMonitor.scala

@@ -218,14 +218,14 @@ private[effect] object FiberMonitor {
     }
   }
 
+  private[FiberMonitor] final val BagReferences
+      : ConcurrentLinkedQueue[WeakReference[WeakBag[Runnable]]] =
+    new ConcurrentLinkedQueue()
+
   private[FiberMonitor] final val Bags: ThreadLocal[WeakBag[Runnable]] =
     ThreadLocal.withInitial { () =>
       val bag = new WeakBag[Runnable]()
       BagReferences.offer(new WeakReference(bag))
       bag
     }
-
-  private[FiberMonitor] final val BagReferences
-      : ConcurrentLinkedQueue[WeakReference[WeakBag[Runnable]]] =
-    new ConcurrentLinkedQueue()
 }