feat: interruptible VIATRA engine

Reduce server load by introducing a timeout for semantics analysis.

2 files changed, 29 insertions, 27 deletions

diff --git a/subprojects/viatra-runtime-rete/src/main/java/tools/refinery/viatra/runtime/rete/network/ReteContainer.java b/subprojects/viatra-runtime-rete/src/main/java/tools/refinery/viatra/runtime/rete/network/ReteContainer.java
index 16e290fd..79e0526d 100644
--- a/subprojects/viatra-runtime-rete/src/main/java/tools/refinery/viatra/runtime/rete/network/ReteContainer.java
+++ b/subprojects/viatra-runtime-rete/src/main/java/tools/refinery/viatra/runtime/rete/network/ReteContainer.java
@@ -1,26 +1,17 @@
 /*******************************************************************************
  * Copyright (c) 2004-2008 Gabor Bergmann and Daniel Varro
+ * Copyright (c) 2023 The Refinery Authors <https://refinery.tools>
  * This program and the accompanying materials are made available under the
  * terms of the Eclipse Public License v. 2.0 which is available at
  * http://www.eclipse.org/legal/epl-v20.html.
- * 
+ *
  * SPDX-License-Identifier: EPL-2.0
  *******************************************************************************/
 
 package tools.refinery.viatra.runtime.rete.network;
 
-import java.util.ArrayDeque;
-import java.util.ArrayList;
-import java.util.Collection;
-import java.util.Deque;
-import java.util.HashSet;
-import java.util.LinkedHashSet;
-import java.util.LinkedList;
-import java.util.Map;
-import java.util.Set;
-import java.util.function.Function;
-
 import org.apache.log4j.Logger;
+import tools.refinery.viatra.runtime.CancellationToken;
 import tools.refinery.viatra.runtime.matchers.context.IQueryBackendContext;
 import tools.refinery.viatra.runtime.matchers.tuple.Tuple;
 import tools.refinery.viatra.runtime.matchers.util.Clearable;
@@ -42,6 +33,9 @@ import tools.refinery.viatra.runtime.rete.single.SingleInputNode;
 import tools.refinery.viatra.runtime.rete.single.TrimmerNode;
 import tools.refinery.viatra.runtime.rete.util.Options;
 
+import java.util.*;
+import java.util.function.Function;
+
 /**
  * @author Gabor Bergmann
  *
@@ -79,6 +73,8 @@ public final class ReteContainer {
 
     protected final TimelyConfiguration timelyConfiguration;
 
+        private final CancellationToken cancellationToken;
+
     /**
      * @param threaded
      *            false if operating in a single-threaded environment
@@ -88,6 +84,7 @@ public final class ReteContainer {
         this.network = network;
         this.backendContext = network.getEngine().getBackendContext();
         this.timelyConfiguration = network.getEngine().getTimelyConfiguration();
+                cancellationToken = backendContext.getRuntimeContext().getCancellationToken();
 
         this.delayedCommandQueue = new LinkedHashSet<DelayedCommand>();
         this.delayedCommandBuffer = new LinkedHashSet<DelayedCommand>();
@@ -395,10 +392,10 @@ public final class ReteContainer {
 
     /**
      * Retrieves a safe copy of the contents of a supplier.
-     * 
+     *
      * <p> Note that there may be multiple copies of a Tuple in case of a {@link TrimmerNode}, so the result is not always a set.
-     * 
-     * @param flush if true, a flush is performed before pulling the contents 
+     *
+     * @param flush if true, a flush is performed before pulling the contents
      * @since 2.3
      */
     public Collection<Tuple> pullContents(final Supplier supplier, final boolean flush) {
@@ -424,7 +421,7 @@ public final class ReteContainer {
 
     /**
      * Retrieves the contents of a SingleInputNode's parentage.
-     * 
+     *
      * @since 2.3
      */
     public Collection<Tuple> pullPropagatedContents(final SingleInputNode supplier, final boolean flush) {
@@ -438,7 +435,7 @@ public final class ReteContainer {
 
     /**
      * Retrieves the timestamp-aware contents of a SingleInputNode's parentage.
-     * 
+     *
      * @since 2.3
      */
     public Map<Tuple, Timeline<Timestamp>> pullPropagatedContentsWithTimestamp(final SingleInputNode supplier,
@@ -541,7 +538,7 @@ public final class ReteContainer {
 
     /**
      * Sends out all pending messages to their receivers. The delivery is governed by the communication tracker.
-     * 
+     *
      * @since 1.6
      */
     public void deliverMessagesSingleThreaded() {
@@ -620,7 +617,7 @@ public final class ReteContainer {
 
     /**
      * Returns an addressed node at this container.
-     * 
+     *
      * @pre: address.container == this, e.g. address MUST be local
      * @throws IllegalArgumentException
      *             if address is non-local
@@ -726,4 +723,7 @@ public final class ReteContainer {
         return network.getInputConnector();
     }
 
+        public void checkCancelled() {
+                cancellationToken.checkCancelled();
+        }
 }
diff --git a/subprojects/viatra-runtime-rete/src/main/java/tools/refinery/viatra/runtime/rete/network/StandardNode.java b/subprojects/viatra-runtime-rete/src/main/java/tools/refinery/viatra/runtime/rete/network/StandardNode.java
index e7ec36dc..7dc7c4bc 100644
--- a/subprojects/viatra-runtime-rete/src/main/java/tools/refinery/viatra/runtime/rete/network/StandardNode.java
+++ b/subprojects/viatra-runtime-rete/src/main/java/tools/refinery/viatra/runtime/rete/network/StandardNode.java
@@ -1,19 +1,15 @@
 /*******************************************************************************
  * Copyright (c) 2004-2008 Gabor Bergmann and Daniel Varro
+ * Copyright (c) 2023 The Refinery Authors <https://refinery.tools>
  * This program and the accompanying materials are made available under the
  * terms of the Eclipse Public License v. 2.0 which is available at
  * http://www.eclipse.org/legal/epl-v20.html.
- * 
+ *
  * SPDX-License-Identifier: EPL-2.0
  *******************************************************************************/
 
 package tools.refinery.viatra.runtime.rete.network;
 
-import java.util.Collection;
-import java.util.HashSet;
-import java.util.List;
-import java.util.Set;
-
 import tools.refinery.viatra.runtime.matchers.tuple.Tuple;
 import tools.refinery.viatra.runtime.matchers.tuple.TupleMask;
 import tools.refinery.viatra.runtime.matchers.util.CollectionsFactory;
@@ -24,11 +20,16 @@ import tools.refinery.viatra.runtime.rete.network.communication.Timestamp;
 import tools.refinery.viatra.runtime.rete.network.mailbox.Mailbox;
 import tools.refinery.viatra.runtime.rete.traceability.TraceInfo;
 
+import java.util.Collection;
+import java.util.HashSet;
+import java.util.List;
+import java.util.Set;
+
 /**
  * Base implementation for a supplier node.
- * 
+ *
  * @author Gabor Bergmann
- * 
+ *
  */
 public abstract class StandardNode extends BaseNode implements Supplier, NetworkStructureChangeSensitiveNode {
     protected final List<Receiver> children = CollectionsFactory.createObserverList();
@@ -45,6 +46,7 @@ public abstract class StandardNode extends BaseNode implements Supplier, Network
      * @since 2.4
      */
     protected void propagateUpdate(final Direction direction, final Tuple updateElement, final Timestamp timestamp) {
+                reteContainer.checkCancelled();
         for (final Mailbox childMailbox : childMailboxes) {
             childMailbox.postMessage(direction, updateElement, timestamp);
         }