Windows support for the C target

.github/workflows/build.yml

@@ -52,7 +52,7 @@ jobs:
   c-tests:
     strategy:
       matrix:
-        platform: [ubuntu-latest, macos-latest]
+        platform: [ubuntu-latest, macos-latest, windows-latest]
     runs-on: ${{ matrix.platform }}
     steps:
       - name: Setup Java JDK
@@ -107,6 +107,7 @@ jobs:
           cmake ../
           make
           sudo make install
+        if: ${{ runner.os == 'macOS' || runner.os == 'Linux' }}
       - name: Run C tests;
         run: |
           ./gradlew test --tests org.lflang.tests.runtime.CTest.*
@@ -182,7 +183,7 @@ jobs:
   python-tests:
     strategy:
       matrix:
-        platform: [ubuntu-latest, macos-latest]
+        platform: [ubuntu-latest, macos-latest, windows-latest]
     runs-on: ${{ matrix.platform }}
     steps:
       - name: Setup Java JDK
@@ -203,8 +204,10 @@ jobs:
       - name: Install Dependencies Windows
         uses: lukka/run-vcpkg@v4
         with:
-          vcpkgArguments: 'protobuf'
-          vcpkgDirectory: '${{ github.workspace }}/vcpkg'
+          vcpkgArguments: protobuf
+          vcpkgGitCommitId: 6185aa76504a5025f36754324abf307cc776f3da
+          vcpkgDirectory: ${{ github.workspace }}/vcpkg/
+          vcpkgTriplet: x64-windows-static
         if: runner.os == 'Windows'
       - name: Install Google API Python Client
         run: pip3 install --upgrade google-api-python-client

REQUIREMENTS.md

@@ -4,15 +4,11 @@ This document includes information about supported operating systems and externa
 ## Core Development Requirements
 
 ### **Supported Operating Systems**
-|                              | C  | C++ | Python | TypeScript |
-|------------------------------|----|-----|--------|------------|
-| Ubuntu 20.04                 | Y  | Y   | Y      | Y          |
-| MacOS 10.15 Catalina         | Y  | Y   | Y      | Y          |
-| Windows 10 1909<sup>†</sup>  | Y  | Y   | Y      | Y          |
-| Windows 10 2004<sup>†</sup>  | Y  | Y   | Y      | Y          |
-
-<sup>†</sup> **Experimental:** Windows support is still considered experimental. You can track our Windows support progress [here](https://github.com/icyphy/lingua-franca/issues?q=is%3Aissue+is%3Aopen+label%3AWindows).
-
+|         |    OS Version     | C  | C++ | Python | TypeScript |
+|---------|-------------------|----|-----|--------|------------|
+| Ubuntu  | >= 20.04          | Y  | Y   | Y      | Y          |
+| MacOS   | >= 10.15 Catalina | Y  | Y   | Y      | Y          |
+| Windows | >= 10 1903        | Y  | Y   | Y      | Y          |
 
 ### **Dependencies**
  - Java >= 11
@@ -28,32 +24,32 @@ However, to compile the generated code and to create a binary (which is done by
 
 
 ### Supported Operating Systems
-|                      | C             | C++ | Python | TypeScript |
-|----------------------|---------------|-----|--------|------------|
-| Ubuntu 20.04         | Y             | Y   | Y      | Y          |
-| MacOS 10.15 Catalina | Y             | Y   | Y      | Y          |
-| Windows 10 1909      | Y<sup>‡</sup> | Y   | N      | N          |
-| Windows 10 2004      | Y<sup>‡</sup> | N   | N      | N          |
-
-<sup>‡</sup> Requires WSL version 1 or version 2
+|         |    OS Version     | C             | C++ | Python | TypeScript |
+|---------|-------------------|---------------|-----|--------|------------|
+| Ubuntu  | >= 20.04          | Y             | Y   | Y      | Y          |
+| MacOS   | >= 10.15 Catalina | Y             | Y   | Y      | Y          |
+| Windows | >= 10 1903        | Y             | Y   | Y      | N          |
 
 
 ### Dependencies
 
 **C:**
-  - gcc >= 7 or MSVC >= 14.20 - 1920 (Visual Studio 2019)
+  - A C compiler (e.g., gcc >= 7, clang, or MSVC >= 14.20) 
   - CMAKE >= 3.13 (follow https://cmake.org/install/ for installation instructions)
-  - **Windows Only:** Windows Subsystem for Linux (WSL) version 1 or 2 with gcc installed - see https://docs.microsoft.com/en-us/windows/wsl/install-win10.
+  - **Windows Only:** Visual Studio >= 2019 and Windows SDK >= 10.0.18362.0
   - **Programs using Protocol Buffers:** protoc-c 1.3.3 - see https://github.com/icyphy/lingua-franca/wiki/Protobufs.
 
 **C++:**
  - g++ >= 7 or MSVC >= 14.20 - 1920 (Visual Studio 2019)
  - CMAKE >= 3.16 (follow https://cmake.org/install/ for installation instructions)
+ - **Windows Only:** Visual Studio >= 2019 and Windows SDK >= 10.0.18362.0
 
 **Python:**
+ - A C compiler (e.g., gcc >= 7, clang, or MSVC >= 14.20)
  - Python >= 3.6
  - pip >= 20.0.2
  - setuptools >= 45.2.0-1
+ - **Windows Only:** Visual Studio >= 2019 and Windows SDK >= 10.0.18362.0
  - **Programs using Protocol Buffers:** protoc >= 3.6.1
 
 **TypeScript:**

benchmark/C/Distributed/src/TimeLimitDistributedROSSerialization.lf

@@ -9,11 +9,10 @@
  * https://docs.ros.org/en/foxy/Tutorials/Configuring-ROS2-Environment.html.
  * 
  */
-target C {
+target CCpp {
     coordination: decentralized,
     timeout: 10 sec,
-    cmake-include: "include/CMakeListsExtension.txt",
-    compiler: "g++"
+    cmake-include: "include/CMakeListsExtension.txt"
 };
 
 preamble {=

bin/run-multiple-times.ps1

@@ -0,0 +1,7 @@
+# A handy script that will run a command multiple times
+# Usage: run-multiple-times.ps1 command number_of_times
+$executable=$args[0]
+$number_of_times=$args[1]
+for (($k = 0); $k -lt $number_of_times; $k++) {
+    Invoke-Expression $executable
+}

example/C/TrainDoor/TrainDoor.lf

@@ -41,8 +41,8 @@ reactor MotionDetector {
     output ok:bool;
     reaction(startup) -> movement {=
         buttons.move = movement;
-		pthread_t thread_id;
-        pthread_create(&thread_id, NULL, &read_input, NULL);
+        lf_thread_t thread_id;
+        lf_thread_create(&thread_id, &read_input, NULL);
 	=}
 	reaction(movement) {=
         printf("Motion detected!\n");

example/C/src/Deadline.lf

@@ -40,8 +40,8 @@ reactor Sensor {
     output y:bool;
 
     reaction(startup) -> response {=
-        pthread_t thread_id;
-        pthread_create(&thread_id, NULL, &read_input, response);
+        lf_thread_t thread_id;
+        lf_thread_create(&thread_id, &read_input, response);
         printf("Press Enter to produce a sensor value.\n");     
     =}
 

example/C/src/MQTT/MQTTPublisher.lf

@@ -6,7 +6,7 @@
  * @author Edward A. Lee
  */
 target C {
-    threads: 1  // This makes sure pthreads is included and gives access to the mutex.
+    threads: 1  // This makes sure the threaded runtime is used, giving access to the mutex.
 };
 
 /**
@@ -44,7 +44,6 @@ reactor MQTTPublisher (
     preamble {=
         #include "MQTTClient.h"
         #include "core/federated/net_util.h"
-        #include <pthread.h>
 
         // Timeout for completion of message sending in milliseconds.
         #define TIMEOUT     10000L

example/C/src/MQTT/MQTTSubscriber.lf

@@ -7,7 +7,7 @@
  * @author Edward A. Lee
  */
 target C {
-    threads: 1  // This makes sure pthreads is included and gives access to the mutex.
+    threads: 1  // This makes sure the threaded runtime is used, giving access to the mutex.
 };
 
 /**
@@ -66,7 +66,6 @@ reactor MQTTSubscriber (
     preamble {=
         #include "MQTTClient.h"
         #include "core/federated/net_util.h"
-        #include <pthread.h>
 
         #define QOS         2
         #define TIMEOUT     10000L
@@ -103,7 +102,7 @@ reactor MQTTSubscriber (
             // NOTE: Since schedule_copy also acquires this lock, we assume here that the
             // pthreads library correctly implements recursive mutex locks to unlock all
             // locks held by the current thread when waiting for signals.
-            pthread_mutex_lock(&mutex);
+            lf_mutex_lock(&mutex);
 
             instant_t timestamp = extract_int64((unsigned char*)message->payload + message->payloadlen - sizeof(instant_t));
             interval_t delay = timestamp - get_logical_time();
@@ -127,7 +126,7 @@ reactor MQTTSubscriber (
             // can measure the latency.
             schedule_copy(incoming_message, delay, (char*)message->payload, message->payloadlen);
 
-            pthread_mutex_unlock(&mutex);
+            lf_mutex_unlock(&mutex);
 
             // MQTTClient_freeMessage() also frees the memory allocated to the payload,
             // which is why we have to copy the message here.

example/C/src/ReflexGame.lf

@@ -87,8 +87,8 @@ reactor GetUserInput {
 
     reaction(startup) -> user_response {=
         // Start the thread that listens for Enter or Return.
-        pthread_t thread_id;
-        pthread_create(&thread_id, NULL, &read_input, user_response);        
+        lf_thread_t thread_id;
+        lf_thread_create(&thread_id, &read_input, user_response);        
     =}
 
     reaction(prompt) {=

example/ReflexGame/ReflexGameTest.lf

@@ -19,7 +19,7 @@ main reactor {
         }
     =}
 
-    state thread_id:pthread_t(0);
+    state thread_id:lf_thread_t(0);
     state request_time:time(0);
     // NOTE: The following will get the default 1 nsec minimum
     // interarrival time.
@@ -28,7 +28,7 @@ main reactor {
     reaction(startup) -> a {=
         // Start listening for key strokes.
         // Note that these will not be received until Enter.
-        pthread_create(&self->thread_id, NULL, &read_char, a);
+        lf_thread_create(&self->thread_id, &read_char, a);
         printf("Enter character(s) followed by return: ");
         self->request_time = get_logical_time();
     =}

org.lflang.tests/src/org/lflang/tests/TestRegistry.java

@@ -139,7 +139,7 @@ public Set<LFTest> getTests(Target t, TestCategory c) {
      * @author Marten Lohstroh <marten@berkeley.edu>
      */
     public enum TestCategory {
-        CONCURRENT(true), GENERIC(true), MULTIPORT(true), TARGET(false),
+        CONCURRENT(true), GENERIC(true), MULTIPORT(true), SERIALIZATION(false), TARGET(false),
         FEDERATED(true), EXAMPLE(false), EXAMPLE_TEST(false);
 
         /**

org.lflang.tests/src/org/lflang/tests/compiler/CodeGenCoverage.java

@@ -101,6 +101,15 @@ public void runWithFourThreads() {
             super.runWithFourThreads();
         }
     }
+
+    @Test
+    @Override
+    public void runSerializationTests() {
+        for (var target : Target.values()) {
+            this.target = target;
+            super.runSerializationTests();
+        }
+    }
 
     @Test
     @Override

org.lflang.tests/src/org/lflang/tests/runtime/CTest.java

@@ -71,6 +71,10 @@ public void runGenericTests() {
     @Test
     @Override
     public void runTargetSpecificTests() {
+        if(isWindows()) {
+            printTestHeader("Warning: Skipping C target-specific tests on Windows.");
+            return; 
+        }
         super.runTargetSpecificTests();
     }
 
@@ -85,11 +89,27 @@ public void runMultiportTests() {
     public void runWithFourThreads() {
         super.runWithFourThreads();
     }
+
+    @Test
+    @Override
+    public void runSerializationTests() {
+        // Skip the test if the OS is Windows
+        if(isWindows()) { 
+            printTestHeader("Warning: Skipping serialization tests on Windows.");
+            return; 
+        }
+        super.runSerializationTests();
+    }
 
     @Test
     @Disabled("TODO only 27/96 tests pass")
     @Override
     public void runAsFederated() {
+        // Skip the test if the OS is Windows
+        if(isWindows()) { 
+            printTestHeader("Warning: Skipping federated tests on Windows.");
+            return; 
+        }
         super.runAsFederated();
     }
 
@@ -102,6 +122,11 @@ public void runConcurrentTests() {
     @Test
     @Override
     public void runFederatedTests() {
+        // Skip the test if the OS is Windows
+        if(isWindows()) {
+            printTestHeader("Warning: Skipping federated tests on Windows.");
+            return; 
+        }
         super.runFederatedTests();
     }
 
@@ -113,6 +138,10 @@ public void runFederatedTests() {
      */
     @Test
     public void runAsCCpp() {
+        if(isWindows()) {
+            printTestHeader("Warning: Skipping CCpp tests on Windows.");
+            return; 
+        }
         printTestHeader(RUN_AS_CCPP_DESC);
 
         EnumSet<TestCategory> categories = EnumSet.allOf(TestCategory.class);

org.lflang.tests/src/org/lflang/tests/runtime/CppTest.java

@@ -69,6 +69,12 @@ public void runWithFourThreads() {
         printTestHeader(RUN_WITH_FOUR_THREADS_DESC);
         System.out.println("N/A");
     }
+
+    @Test
+    @Override
+    public void runSerializationTests() {
+        super.runSerializationTests();
+    }
 
     @Test
     @Override

org.lflang.tests/src/org/lflang/tests/runtime/PythonTest.java

@@ -59,10 +59,26 @@ public class PythonTest extends TestBase {
     @Override public void runMultiportTests() {
         super.runMultiportTests();
     }
+
+    @Test
+    @Override
+    public void runSerializationTests() {
+        // Skip the test if the OS is Windows
+        if(isWindows()) { 
+            printTestHeader("Warning: Skipping serialization tests on Windows.");
+            return; 
+        }
+        super.runSerializationTests();
+    }
 
     @Test
     @Disabled("TODO")
     @Override public void runAsFederated() {
+        // Skip the test if the OS is Windows
+        if(isWindows()) { 
+            printTestHeader("Warning: Skipping federated tests on Windows.");
+            return; 
+        }
         super.runAsFederated();
     }
 
@@ -74,6 +90,11 @@ public class PythonTest extends TestBase {
 
     @Test
     @Override public void runFederatedTests() {
+        // Skip the test if the OS is Windows
+        if(isWindows()) { 
+            printTestHeader("Warning: Skipping federated tests on Windows.");
+            return; 
+        }
         super.runFederatedTests();
     }
 }

org.lflang.tests/src/org/lflang/tests/runtime/TestBase.java

@@ -167,12 +167,16 @@ public void runMultiportTests() {
         printTestHeader("Description: Run multiport tests (threads = 0).");
         runUnthreaded(TestCategory.MULTIPORT);
     }
-
+
+    @Test
+    public void runSerializationTests() {
+        printTestHeader("Description: Run serialization tests.");
+        runTestsAndPrintResults(target, TestCategory.SERIALIZATION::equals, null, false);
+    }
 
     @Test
     public void runAsFederated() {
         printTestHeader(RUN_AS_FEDERATED_DESC);
-
         EnumSet<TestCategory> categories = EnumSet.allOf(TestCategory.class);
         categories.removeAll(EnumSet.of(TestCategory.CONCURRENT,
                                         TestCategory.FEDERATED,
@@ -202,6 +206,13 @@ public void runFederatedTests() {
     }
 
 
+    /** Returns true if the operating system is Windows. */
+    protected boolean isWindows() {
+        String OS = System.getProperty("os.name").toLowerCase();
+        if (OS.indexOf("win") >= 0) { return true; }
+        return false;
+    }
+
     //
     private static void restoreOutputs() {
         System.out.flush();