new: use FlowSched for task scheduling (#256)

.github/workflows/build.yml

@@ -10,9 +10,10 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
       with:
         fetch-depth: 0
+        submodules: true
 
     - name: Set up JDK 17
       uses: actions/setup-java@v2

.github/workflows/test.yml

@@ -17,6 +17,7 @@ jobs:
     - uses: actions/checkout@v2
       with:
         fetch-depth: 0
+        submodules: true
 
     - name: Set up JDK 17
       uses: actions/setup-java@v2

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "FlowSched"]
+	path = FlowSched
+	url = https://github.com/RelativityMC/FlowSched.git

build.gradle

@@ -4,6 +4,7 @@ plugins {
     id "me.champeau.jmh" version "0.7.1"
     id 'com.modrinth.minotaur' version '2.+' apply false
     id 'com.matthewprenger.cursegradle' version '1.4.0' apply false
+    id 'com.github.johnrengelman.shadow' version '8.1.1' apply false
 }
 
 @SuppressWarnings('unused')
@@ -36,6 +37,8 @@ configure(allprojects) {
 
 archivesBaseName = "${project.archives_base_name}-mc${project.minecraft_version}"
 
+clean.dependsOn gradle.includedBuild('FlowSched').task(':clean')
+
 configure (allprojects - project(":tests")) {
     if (project != project(":") && project.parent != project(":")) return
 
@@ -118,6 +121,7 @@ configure (allprojects - project(":tests")) {
         implementation "com.electronwill.night-config:toml:${night_config_version}"
         implementation "org.threadly:threadly:${threadly_version}"
         implementation "net.objecthunter:exp4j:${exp4j_version}"
+        implementation "com.ishland.flowsched:flowsched"
 
     }
 }
@@ -146,6 +150,7 @@ dependencies {
     include implementation("com.electronwill.night-config:core:${night_config_version}")
     include implementation("org.threadly:threadly:${threadly_version}")
     include implementation("net.objecthunter:exp4j:${exp4j_version}")
+//    include implementation("com.ishland.flowsched:flowsched")
 
     // PSA: Some older mods, compiled on Loom 0.2.1, might have outdated Maven POMs.
     // You may need to force-disable transitiveness on them.
@@ -196,8 +201,9 @@ dependencies {
         (subprojects - project(":tests")).forEach {
             if (it.parent != project(":")) return
 
-            api project(path: ":${it.name}", configuration: "namedElements")
-            include project("${it.name}:")
+            def projectName = it.name
+            api project(path: ":${projectName}", configuration: "namedElements")
+            include project("${projectName}:")
         }
     }
 }

c2me-base/build.gradle

@@ -0,0 +1,24 @@
+apply plugin: 'com.github.johnrengelman.shadow'
+
+configurations {
+    shadowInclude
+}
+
+dependencies {
+    shadowInclude("com.ishland.flowsched:flowsched") {
+        transitive false
+    }
+}
+
+shadowJar {
+    archiveClassifier = "all-dev"
+    configurations = [ project.configurations.shadowInclude ]
+}
+
+remapJar {
+    input = shadowJar.archiveFile
+    archiveFileName = shadowJar.archiveFileName.get().replaceAll("-dev\\.jar\$", ".jar")
+    addNestedDependencies = true
+    dependsOn shadowJar
+}
+

c2me-base/src/main/java/com/ishland/c2me/base/common/GlobalExecutors.java

@@ -2,34 +2,23 @@
 
 import com.google.common.util.concurrent.ThreadFactoryBuilder;
 import com.ishland.c2me.base.ModuleEntryPoint;
-import com.ishland.c2me.base.common.util.C2MENormalWorkerThreadFactory;
+import com.ishland.flowsched.executor.ExecutorManager;
 
-import java.util.concurrent.Executor;
 import java.util.concurrent.ExecutorService;
-import java.util.concurrent.Executors;
 import java.util.concurrent.LinkedBlockingQueue;
 import java.util.concurrent.ThreadPoolExecutor;
 import java.util.concurrent.TimeUnit;
+import java.util.concurrent.atomic.AtomicInteger;
 
 public class GlobalExecutors {
 
 //    private static final C2MEForkJoinWorkerThreadFactory factory = new C2MEForkJoinWorkerThreadFactory("c2me", "C2ME worker #%d", Thread.NORM_PRIORITY - 1);
-    private static final C2MENormalWorkerThreadFactory factory = new C2MENormalWorkerThreadFactory("c2me", "C2ME worker #%d", Thread.NORM_PRIORITY - 1);
     public static final int GLOBAL_EXECUTOR_PARALLELISM = (int) ModuleEntryPoint.globalExecutorParallelism;
-//    public static final ForkJoinPool executor = new ForkJoinPool(
-//            GLOBAL_EXECUTOR_PARALLELISM,
-//            factory,
-//            null,
-//            true
-//    );
-    public static final ExecutorService executor = Executors.newFixedThreadPool(GLOBAL_EXECUTOR_PARALLELISM, factory);
-    public static final Executor invokingExecutor = r -> {
-        if (Thread.currentThread().getThreadGroup() == factory.getThreadGroup()) {
-            r.run();
-        } else {
-            executor.execute(r);
-        }
-    };
+    private static final AtomicInteger prioritizedSchedulerCounter = new AtomicInteger(0);
+    public static final ExecutorManager prioritizedScheduler = new ExecutorManager(GlobalExecutors.GLOBAL_EXECUTOR_PARALLELISM, thread -> {
+        thread.setDaemon(true);
+        thread.setName("c2me-prioritized-%d".formatted(prioritizedSchedulerCounter.getAndIncrement()));
+    });
 
     public static final ExecutorService asyncScheduler = new ThreadPoolExecutor(1, 1,
             0L, TimeUnit.MILLISECONDS,

c2me-base/src/main/java/com/ishland/c2me/base/common/scheduler/AbstractPosAwarePrioritizedTask.java

@@ -0,0 +1,36 @@
+package com.ishland.c2me.base.common.scheduler;
+
+import com.ishland.flowsched.executor.Task;
+import it.unimi.dsi.fastutil.objects.ReferenceArrayList;
+
+import java.util.Objects;
+
+public abstract class AbstractPosAwarePrioritizedTask implements Task {
+
+    protected final ReferenceArrayList<Runnable> postExec = new ReferenceArrayList<>(4);
+    private final long pos;
+    private int priority = Integer.MAX_VALUE;
+
+    public AbstractPosAwarePrioritizedTask(long pos) {
+        this.pos = pos;
+    }
+
+    @Override
+    public int priority() {
+        return this.priority;
+    }
+
+    public void setPriority(int priority) {
+        this.priority = priority;
+    }
+
+    public long getPos() {
+        return this.pos;
+    }
+
+    public void addPostExec(Runnable runnable) {
+        synchronized (this.postExec) {
+            postExec.add(Objects.requireNonNull(runnable));
+        }
+    }
+}

c2me-base/src/main/java/com/ishland/c2me/base/common/scheduler/LockTokenImpl.java

@@ -0,0 +1,6 @@
+package com.ishland.c2me.base.common.scheduler;
+
+import com.ishland.flowsched.executor.LockToken;
+
+public record LockTokenImpl(int ownerTag, long pos) implements LockToken {
+}