Support zero-delay cycles

core/src/main/java/org/lflang/federated/extensions/CExtension.java

@@ -464,7 +464,7 @@ public String generatePortAbsentReactionBody(
                 + receivingPortID
                 + ", "
                 + connection.getDstFederate().id
-                + ", (long long) lf_time_logical_elapsed());",
+                + ", lf_time_logical_elapsed());",
             "if (" + sendRef + " == NULL || !" + sendRef + "->is_present) {",
             "LF_PRINT_LOG(\"The output port is NULL or it is not present.\");",
             "    lf_send_port_absent_to_federate("
@@ -551,15 +551,33 @@ protected String makePreamble(
     // that handles incoming network messages destined to the specified
     // port. This will only be used if there are federates.
     int numOfNetworkActions = federate.networkMessageActions.size();
+    int numZDCNetworkActions = federate.zeroDelayCycleNetworkMessageActions.size();
     code.pr(
         """
         interval_t _lf_action_delay_table[%1$s];
         lf_action_base_t* _lf_action_table[%1$s];
         size_t _lf_action_table_size = %1$s;
-        lf_action_base_t* _lf_zero_delay_cycle_action_table[%2$s];
-        size_t _lf_zero_delay_cycle_action_table_size = %2$s;
         """
-            .formatted(numOfNetworkActions, federate.zeroDelayCycleNetworkMessageActions.size()));
+            .formatted(numOfNetworkActions));
+    if (numZDCNetworkActions > 0) {
+      code.pr(
+          """
+          lf_action_base_t* _lf_zero_delay_cycle_action_table[%1$s];
+          size_t _lf_zero_delay_cycle_action_table_size = %1$s;
+          uint16_t _lf_zero_delay_cycle_upstream_ids[%1$s];
+          bool _lf_zero_delay_cycle_upstream_disconnected[%1$s] = { false };
+          """
+              .formatted(numZDCNetworkActions));
+    } else {
+      // Make sure these symbols are defined, even though only size will be used.
+      code.pr(
+          """
+          lf_action_base_t** _lf_zero_delay_cycle_action_table = NULL;
+          size_t _lf_zero_delay_cycle_action_table_size = 0;
+          uint16_t* _lf_zero_delay_cycle_upstream_ids = NULL;
+          bool* _lf_zero_delay_cycle_upstream_disconnected = NULL;
+          """);
+    }
 
     int numOfNetworkReactions = federate.networkReceiverReactions.size();
     code.pr(

core/src/main/java/org/lflang/federated/extensions/CExtensionUtils.java

@@ -36,27 +36,23 @@
 public class CExtensionUtils {
 
   // Regular expression pattern for shared_ptr types.
-  static final Pattern sharedPointerVariable = Pattern
-      .compile("^(/\\*.*?\\*/)?std::shared_ptr<(?<type>((/\\*.*?\\*/)?(\\S+))+)>$");
+  static final Pattern sharedPointerVariable =
+      Pattern.compile("^(/\\*.*?\\*/)?std::shared_ptr<(?<type>((/\\*.*?\\*/)?(\\S+))+)>$");
 
   /**
    * Generate C code that initializes network actions.
    *
-   * <p>
-   * These network actions will be triggered by federate.c whenever a message is
-   * received from
+   * <p>These network actions will be triggered by federate.c whenever a message is received from
    * the network.
    *
    * @param federate The federate.
-   * @param main     The main reactor that contains the federate (used to lookup
-   *                 references).
+   * @param main The main reactor that contains the federate (used to lookup references).
    */
   public static String initializeTriggersForNetworkActions(
       FederateInstance federate, ReactorInstance main) {
     CodeBuilder code = new CodeBuilder();
     if (!federate.networkMessageActions.isEmpty()) {
       var actionTableCount = 0;
-      var zeroDelayActionTableCount = 0;
       for (int i = 0; i < federate.networkMessageActions.size(); ++i) {
         // Find the corresponding ActionInstance.
         Action action = federate.networkMessageActions.get(i);
@@ -79,10 +75,17 @@ public static String initializeTriggersForNetworkActions(
         // Set the ID of the source federate.
         code.pr(
             trigger + ".source_id = " + federate.networkMessageSourceFederate.get(i).id + "; \\");
-        if (federate.zeroDelayCycleNetworkMessageActions.contains(action)) {
+        int j = federate.zeroDelayCycleNetworkMessageActions.indexOf(action);
+        if (j >= 0) {
+          var upstream = federate.zeroDelayCycleNetworkUpstreamFeds.get(j);
+          code.pr("_lf_zero_delay_cycle_upstream_ids[" + j + "] = " + upstream.id + "; \\");
+          if (upstream.isTransient) {
+            // Transient federates are assumed to be initially disconnected.
+            code.pr("_lf_zero_delay_cycle_upstream_disconnected[" + j + "] = true; \\");
+          }
           code.pr(
               "_lf_zero_delay_cycle_action_table["
-                  + zeroDelayActionTableCount++
+                  + j
                   + "] = (lf_action_base_t*)&"
                   + trigger
                   + "; \\");
@@ -95,11 +98,8 @@ public static String initializeTriggersForNetworkActions(
   /**
    * Generate C code that holds a sorted list of STAA structs by time.
    *
-   * <p>
-   * For decentralized execution, on every logical timestep, a thread will iterate
-   * through each
-   * staa struct, wait for the designated offset time, and set the associated port
-   * status to absent
+   * <p>For decentralized execution, on every logical timestep, a thread will iterate through each
+   * staa struct, wait for the designated offset time, and set the associated port status to absent
    * if it isn't known.
    *
    * @param federate The federate.
@@ -115,7 +115,8 @@ public static String stpStructs(FederateInstance federate) {
       // main reactor for each Action.
       for (int i = 0; i < federate.staaOffsets.size(); ++i) {
         // Find the corresponding ActionInstance.
-        List<Action> networkActions = federate.staToNetworkActionMap.get(federate.staaOffsets.get(i));
+        List<Action> networkActions =
+            federate.staToNetworkActionMap.get(federate.staaOffsets.get(i));
 
         code.pr("staa_lst[" + i + "] = (staa_t*) malloc(sizeof(staa_t));");
         code.pr(
@@ -148,8 +149,7 @@ public static String stpStructs(FederateInstance federate) {
   }
 
   /**
-   * Create a port status field variable for a network input port "input" in the
-   * self struct of a
+   * Create a port status field variable for a network input port "input" in the self struct of a
    * reactor.
    *
    * @param input The network input port
@@ -170,23 +170,15 @@ public static String createPortStatusFieldForInput(Input input) {
   }
 
   /**
-   * Given a connection 'delay' expression, return a string that represents the
-   * interval_t value of
+   * Given a connection 'delay' expression, return a string that represents the interval_t value of
    * the additional delay that needs to be applied to the outgoing message.
    *
-   * <p>
-   * The returned additional delay in absence of after on network connection
-   * (i.e., if delay is
-   * passed as a null) is NEVER. This has a special meaning in C library functions
-   * that send network
-   * messages that carry timestamps (@see lf_send_tagged_message and
-   * lf_send_port_absent_to_federate
-   * in lib/core/federate.c). In this case, the sender will send its current tag
-   * as the timestamp of
-   * the outgoing message without adding a microstep delay. If the user has
-   * assigned an after delay
-   * to the network connection (that can be zero) either as a time value (e.g.,
-   * 200 msec) or as a
+   * <p>The returned additional delay in absence of after on network connection (i.e., if delay is
+   * passed as a null) is NEVER. This has a special meaning in C library functions that send network
+   * messages that carry timestamps (@see lf_send_tagged_message and lf_send_port_absent_to_federate
+   * in lib/core/federate.c). In this case, the sender will send its current tag as the timestamp of
+   * the outgoing message without adding a microstep delay. If the user has assigned an after delay
+   * to the network connection (that can be zero) either as a time value (e.g., 200 msec) or as a
    * literal (e.g., a parameter), that delay in nsec will be returned.
    *
    * @param delay The delay associated with a connection.
@@ -230,9 +222,11 @@ public static void handleCompileDefinitions(
   }
 
   private static void handleAdvanceMessageInterval(FederateInstance federate) {
-    var advanceMessageInterval = federate.targetConfig.get(CoordinationOptionsProperty.INSTANCE).advanceMessageInterval;
+    var advanceMessageInterval =
+        federate.targetConfig.get(CoordinationOptionsProperty.INSTANCE).advanceMessageInterval;
     if (advanceMessageInterval != null) {
-      federate.targetConfig
+      federate
+          .targetConfig
           .get(CompileDefinitionsProperty.INSTANCE)
           .put("ADVANCE_MESSAGE_INTERVAL", String.valueOf(advanceMessageInterval.toNanoSeconds()));
     }
@@ -245,15 +239,12 @@ static boolean clockSyncIsOn(FederateInstance federate, RtiConfig rtiConfig) {
   }
 
   /**
-   * Initialize clock synchronization (if enabled) and its related options for a
-   * given federate.
+   * Initialize clock synchronization (if enabled) and its related options for a given federate.
    *
-   * <p>
-   * Clock synchronization can be enabled using the clock-sync target property.
+   * <p>Clock synchronization can be enabled using the clock-sync target property.
    *
-   * @see <a
-   *      href=
-   *      "https://github.com/icyphy/lingua-franca/wiki/Distributed-Execution#clock-synchronization">Documentation</a>
+   * @see <a href=
+   *     "https://github.com/icyphy/lingua-franca/wiki/Distributed-Execution#clock-synchronization">Documentation</a>
    */
   public static void initializeClockSynchronization(
       FederateInstance federate, RtiConfig rtiConfig, MessageReporter messageReporter) {
@@ -280,15 +271,12 @@ public static void initializeClockSynchronization(
   }
 
   /**
-   * Initialize clock synchronization (if enabled) and its related options for a
-   * given federate.
+   * Initialize clock synchronization (if enabled) and its related options for a given federate.
    *
-   * <p>
-   * Clock synchronization can be enabled using the clock-sync target property.
+   * <p>Clock synchronization can be enabled using the clock-sync target property.
    *
-   * @see <a
-   *      href=
-   *      "https://github.com/icyphy/lingua-franca/wiki/Distributed-Execution#clock-synchronization">Documentation</a>
+   * @see <a href=
+   *     "https://github.com/icyphy/lingua-franca/wiki/Distributed-Execution#clock-synchronization">Documentation</a>
    */
   public static void addClockSyncCompileDefinitions(FederateInstance federate) {
 
@@ -319,9 +307,10 @@ public static void generateCMakeInclude(
       FederateInstance federate, FederationFileConfig fileConfig) throws IOException {
     Files.createDirectories(fileConfig.getSrcPath().resolve("include"));
 
-    Path cmakeIncludePath = fileConfig
-        .getSrcPath()
-        .resolve("include" + File.separator + federate.name + "_extension.cmake");
+    Path cmakeIncludePath =
+        fileConfig
+            .getSrcPath()
+            .resolve("include" + File.separator + federate.name + "_extension.cmake");
 
     CodeBuilder cmakeIncludeCode = new CodeBuilder();
 
@@ -330,11 +319,16 @@ public static void generateCMakeInclude(
         "add_compile_definitions(LF_SOURCE_DIRECTORY=\"" + fileConfig.srcPath + "\")");
     cmakeIncludeCode.pr(
         "add_compile_definitions(LF_PACKAGE_DIRECTORY=\"" + fileConfig.srcPkgPath + "\")");
+    // After federates have been divided, their root package directory is different.
     cmakeIncludeCode.pr(
-        "add_compile_definitions(LF_SOURCE_GEN_DIRECTORY=\"" + fileConfig.getSrcGenPath() + "\")");
+        "add_compile_definitions(LF_FED_PACKAGE_DIRECTORY=\""
+            + fileConfig.srcPkgPath
+            + File.separator
+            + "fed-gen"
+            + File.separator
+            + fileConfig.name
+            + "\")");
     cmakeIncludeCode.pr("add_compile_definitions(LF_FILE_SEPARATOR=\"" + File.separator + "\")");
-    cmakeIncludeCode.pr(
-        "add_compile_definitions(LF_FEDERATES_BIN_DIRECTORY=\"" + fileConfig.getFedBinPath() + "\")");
     try (var srcWriter = Files.newBufferedWriter(cmakeIncludePath)) {
       srcWriter.write(cmakeIncludeCode.getCode());
     }
@@ -345,8 +339,7 @@ public static void generateCMakeInclude(
   }
 
   /**
-   * Generate code that sends the neighbor structure message to the RTI. See
-   * {@code
+   * Generate code that sends the neighbor structure message to the RTI. See {@code
    * MSG_TYPE_NEIGHBOR_STRUCTURE} in {@code federated/net_common.h}.
    *
    * @param federate The federate that is sending its neighbor structure
@@ -419,13 +412,14 @@ public static String generateFederateNeighborStructure(FederateInstance federate
               // Use NEVER to encode no delay at all.
               code.pr("candidate_tmp = NEVER;");
             } else {
-              var delayTime = delay instanceof ParameterReference
-                  // In that case use the default value.
-                  ? CTypes.getInstance()
-                      .getTargetTimeExpr(
-                          ASTUtils.getDefaultAsTimeValue(
-                              ((ParameterReference) delay).getParameter()))
-                  : CTypes.getInstance().getTargetExpr(delay, InferredType.time());
+              var delayTime =
+                  delay instanceof ParameterReference
+                      // In that case use the default value.
+                      ? CTypes.getInstance()
+                          .getTargetTimeExpr(
+                              ASTUtils.getDefaultAsTimeValue(
+                                  ((ParameterReference) delay).getParameter()))
+                      : CTypes.getInstance().getTargetExpr(delay, InferredType.time());
 
               code.pr(
                   String.join(
@@ -482,27 +476,26 @@ public static String surroundWithIfElseFederated(String insideIf, String insideE
       return surroundWithIfFederated(insideIf);
     } else {
       return """
-          #ifdef FEDERATED
-          %s
-          #else
-          %s
-          #endif // FEDERATED
-          """
+             #ifdef FEDERATED
+             %s
+             #else
+             %s
+             #endif // FEDERATED
+             """
           .formatted(insideIf, insideElse);
     }
   }
 
   /**
-   * Surround {@code code} with blocks to ensure that code only executes if the
-   * program is
+   * Surround {@code code} with blocks to ensure that code only executes if the program is
    * federated.
    */
   public static String surroundWithIfFederated(String code) {
     return """
-        #ifdef FEDERATED
-        %s
-        #endif // FEDERATED
-        """
+           #ifdef FEDERATED
+           %s
+           #endif // FEDERATED
+           """
         .formatted(code);
   }
 
@@ -511,41 +504,39 @@ public static String surroundWithIfElseFederatedCentralized(String insideIf, Str
       return surroundWithIfFederatedCentralized(insideIf);
     } else {
       return """
-           #ifdef FEDERATED_CENTRALIZED
-           %s
-           #else
-           %s
-           #endif // FEDERATED_CENTRALIZED
-          """
+              #ifdef FEDERATED_CENTRALIZED
+              %s
+              #else
+              %s
+              #endif // FEDERATED_CENTRALIZED
+             """
           .formatted(insideIf, insideElse);
     }
   }
 
   /**
-   * Surround {@code code} with blocks to ensure that code only executes if the
-   * program is federated
+   * Surround {@code code} with blocks to ensure that code only executes if the program is federated
    * and has a centralized coordination.
    */
   public static String surroundWithIfFederatedCentralized(String code) {
     return """
-        #ifdef FEDERATED_CENTRALIZED
-        %s
-        #endif // FEDERATED_CENTRALIZED
-        """
+           #ifdef FEDERATED_CENTRALIZED
+           %s
+           #endif // FEDERATED_CENTRALIZED
+           """
         .formatted(code);
   }
 
   /**
-   * Surround {@code code} with blocks to ensure that code only executes if the
-   * program is federated
+   * Surround {@code code} with blocks to ensure that code only executes if the program is federated
    * and has a decentralized coordination.
    */
   public static String surroundWithIfFederatedDecentralized(String code) {
     return """
-        #ifdef FEDERATED_DECENTRALIZED
-        %s
-        #endif // FEDERATED_DECENTRALIZED
-        """
+           #ifdef FEDERATED_DECENTRALIZED
+           %s
+           #endif // FEDERATED_DECENTRALIZED
+           """
         .formatted(code);
   }
 
@@ -566,9 +557,7 @@ public static String generateSerializationIncludes(FederateInstance federate) {
     return code.getCode();
   }
 
-  /**
-   * Generate cmake-include code needed for enabled serializers of the federate.
-   */
+  /** Generate cmake-include code needed for enabled serializers of the federate. */
   public static String generateSerializationCMakeExtension(FederateInstance federate) {
     CodeBuilder code = new CodeBuilder();
     for (SupportedSerializers serializer : federate.enabledSerializers) {