Falcon Studio (#134)

Author: benfgit

.github/workflows/build.yml

@@ -1,17 +1,21 @@
-name: Format and Compile
+name: Build backend
 
 on:
   pull_request:
     branches: [develop]
-
+    paths:
+      # Skip CPP pipeline if the changes are only GUI
+      - "**"
+      - "!falcon_gui/**"
+      - "!.github/workflows/build_gui.yml"
 jobs:
   build-linux:
-    name: Format and Compile
+    name: Build backend
     runs-on: ubuntu-24.04
 
     strategy:
       matrix:
-        compiler: [clang, gcc]
+        compiler: [clang] # gcc is disabled for now
 
     steps:
       - name: Checkout code
@@ -40,18 +44,16 @@ jobs:
           mkdir -p build
           cd build
           if [ "${{ matrix.compiler }}" == "clang" ]; then
-            cmake .. \
-            -DCMAKE_BUILD_TYPE=Debug \
-            -DIGNORE_EXTENSIONS=ON \
-            -DCMAKE_C_COMPILER=/usr/local/bin/clang \
-            -DCMAKE_CXX_COMPILER=/usr/local/bin/clang++
+            C_PATH=/usr/local/bin/clang
+            CXX_PATH=/usr/local/bin/clang++
           else
-            cmake .. \
-            -DCMAKE_BUILD_TYPE=Debug \
-            -DIGNORE_EXTENSIONS=ON \
-            -DCMAKE_C_COMPILER=/usr/bin/gcc \
-            -DCMAKE_CXX_COMPILER=/usr/bin/g++
+            C_PATH=/usr/bin/gcc
+            CXX_PATH=/usr/bin/g++
           fi
+          cmake .. \
+            -DCMAKE_BUILD_TYPE=Release \
+            -DCMAKE_C_COMPILER=$C_PATH \
+            -DCMAKE_CXX_COMPILER=$CXX_PATH
 
       - name: Build project
         run: |

.github/workflows/build_gui.yml

@@ -0,0 +1,51 @@
+name: Build GUI
+
+on:
+  pull_request:
+    branches: [develop]
+    paths:
+      - "falcon_gui/**"
+      - ".github/workflows/build_gui.yml"
+
+jobs:
+  build-linux:
+    name: Build GUI
+    runs-on: ubuntu-24.04
+
+    defaults:
+      run:
+        working-directory: falcon_gui
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Install FVM and Flutter
+        working-directory: . # To install FVM globally for the entire workflow
+        run: |
+          curl -fsSL https://fvm.app/install.sh | bash
+          echo "/home/runner/fvm/bin" >> $GITHUB_PATH
+          echo "/home/runner/fvm/versions/3.38.5/bin" >> $GITHUB_PATH
+          export PATH="/home/runner/fvm/bin:$PATH"
+
+          fvm install 3.38.5
+          fvm global 3.38.5
+
+      - name: Lint and format
+        run: |
+          flutter pub get
+          dart format --set-exit-if-changed .
+          flutter analyze --fatal-infos --fatal-warnings
+
+      - name: Build project
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y libgtk-3-dev
+          flutter build linux --release
+
+      - name: Publish artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: falcon_gui
+          path: falcon_gui/build/linux/x64/release/bundle/
+          if-no-files-found: error

.vscode/settings.json

@@ -23,5 +23,7 @@
     "C_Cpp.codeAnalysis.exclude": {
         "build/": true,
         "extensions/": true,
+        "**/.fvm/": true,
+        "**/.venv/": true,
     },
 }

CMakeLists.txt

@@ -3,11 +3,20 @@ cmake_minimum_required(VERSION 3.16)
 
 # Export compile commands for VS Code IntelliSense
 set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
+set(CMAKE_CXX_STANDARD 26)
+set(CMAKE_CXX_STANDARD_REQUIRED ON)
+set(CMAKE_CXX_EXTENSIONS OFF)
+
 
 if(CMAKE_BUILD_TYPE STREQUAL "Debug")
-    set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -O0 -g -Wall -Wextra -Wunused -std=c++17 -pthread")
+	message(STATUS "Debug build")
+    set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -O0 -g -Wall -Wextra -Wunused -pthread")
+elseif(CMAKE_BUILD_TYPE STREQUAL "Profile")
+	message(STATUS "Profile build")
+    set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -O3 -g -fno-omit-frame-pointer -fno-inline-functions -Wall -Wextra -Wunused -pthread")
 else()
-    set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -O3 -Wall -Wextra -Wunused -std=c++17 -pthread")
+	message(STATUS "Release build")
+    set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -O3 -Wall -Wextra -Wunused -pthread")
 endif()
 
 set(CMAKE_SHARED_LIBRARY_LINK_CXX_FLAGS "")
@@ -114,8 +123,6 @@ FetchContent_GetProperties(units)
 if(NOT units_POPULATED)
 	message(STATUS "Populating LLNL units...")
 	FetchContent_MakeAvailable(units)
-	# Add here options for units building
-	set(CMAKE_CXX_STANDARD 17)
 	set(USE_LIBCXX OFF CACHE INTERNAL "")
 	set(UNITS_HEADER_ONLY OFF CACHE INTERNAL "")
 	set(UNITS_ENABLE_TESTS OFF CACHE BOOL "Whether or not to build the tests")

analysis_options.yaml

@@ -0,0 +1,10 @@
+# Disables Dart analysis for root C++ project in VS Code (and possiblely other IDEs).
+# The recommended way to enable Dart analysis for the GUI project is to open it as
+# a standalone project in the IDE.
+analyzer:
+  errors:
+    todo: ignore
+  exclude:
+    - "**"
+linter:
+  rules: []

extensions.txt

@@ -1,4 +1,2 @@
-enable , extension name , extension path , extension version (optional)
-0 , decoding , https://github.com/falcon-eyrie/falcon-decoding-extensions
-0 , behavior , https://github.com/falcon-eyrie/falcon-behavior-extensions, develop
-1 , core , https://github.com/falcon-eyrie/falcon-fklab-extensions, develop
+enable, extension name, extension path, extension version (optional)
+dev, core, extensions/falcon-fklab-extensions

falcon/configuration.hpp.in

@@ -26,24 +26,24 @@
 #include "utilities/configuration.hpp"
 
 class FalconConfiguration : public Configuration {
-public:
-  FalconConfiguration();
+   public:
+    FalconConfiguration();
 
-  // CONFIG OPTIONS
-public:
-  options::String graph_file{""};
-  options::Bool debug_enabled{false};
-  options::Bool testing_enabled{false};
-  options::Bool graph_autostart{false};
-  options::Int network_port{5555};
-  options::String logging_path{"./", options::isdir()};
-  options::Bool logging_screen_enabled{true};
-  options::Bool logging_cloud_enabled{true};
-  options::Int logging_cloud_port{5556};
-  options::String server_side_storage_environment{"./", options::isdir()};
-  options::String server_side_storage_resources{"@RESOURCES_PATH@/resources",
-                                                options::isdir(true, true)};
-  options::ValueMap<options::String> server_side_storage_custom;
+    // CONFIG OPTIONS
+   public:
+    options::String graph_file{""};
+    options::Bool debug_enabled{false};
+    options::Bool testing_enabled{false};
+    options::Bool graph_autostart{false};
+    options::Int network_port{5555};
+    options::String logging_path{"./", options::isdir(true, true)};
+    options::Bool logging_screen_enabled{true};
+    options::Bool logging_cloud_enabled{true};
+    options::Int logging_cloud_port{5556};
+    options::String server_side_storage_environment{"./", options::isdir(true, true)};
+    options::String server_side_storage_resources{"@RESOURCES_PATH@/resources",
+                                                  options::isdir(true, true)};
+    options::ValueMap<options::String> server_side_storage_custom;
 };
 
 #endif

falcon/graphmanager.cpp

@@ -50,8 +50,9 @@ void GraphManager::HandleCommand(const std::string& command, std::deque<std::str
         }
         ParseGraph(node);
         // save YAML to global_context_.resolve_path( "graphs://_last_graph" )
-        std::ofstream fout(global_context_->resolve_path("graphs://_last_graph.yaml"));
-        fout << node;
+        // Disabled for now
+        // std::ofstream fout(global_context_->resolve_path("graphs://_last_graph.yaml"));
+        // fout << node;
 
     } else if (command == "destroy") {
         graph_.Destroy();

falcon/idata.cpp

@@ -28,6 +28,20 @@ uint64_t Data::serial_number() const {
     return serial_number_;
 }
 
+int64_t Data::ingestion_ns() const {
+    return ingestion_ns_;
+}
+
+void Data::set_ingestion_ns() {
+    ingestion_ns_ = std::chrono::duration_cast<std::chrono::nanoseconds>(
+                        std::chrono::steady_clock::now().time_since_epoch())
+                        .count();
+}
+
+void Data::forward_ingestion_ns(const Data& data) {
+    ingestion_ns_ = data.ingestion_ns_;
+}
+
 void Data::set_source_timestamp() {
     source_timestamp_ = Clock::now();
 }

falcon/idata.hpp

@@ -151,6 +151,26 @@ class Data : public IData<Data, BaseType> {
     uint64_t serial_number() const;
     void set_serial_number(uint64_t n);
 
+    /**
+     * @brief This timestamp is set when the data packet is first
+     * ingested by Falcon.
+     *
+     * @return int64_t
+     */
+    int64_t ingestion_ns() const;
+
+    /**
+     * @brief Set the ingestion timestamp to now. This should only be called
+     * by a "source" processor when the data packet is first ingested.
+     */
+    void set_ingestion_ns();
+
+    /**
+     * @brief Forward the ingestion timestamp from an upstream data packet
+     * to this data packet.
+     */
+    void forward_ingestion_ns(const Data& data);
+
     /**
      * @brief set_source_timestamp set the timepoint based on the internal
      * Falcon clock.
@@ -253,6 +273,11 @@ class Data : public IData<Data, BaseType> {
     virtual void SerializeFlatBuffer(flexbuffers::Builder& flex_builder);
 
    protected:
+    /**
+     * @brief timestamp in nanoseconds when the data packet
+     * was first ingested by Falcon.
+     */
+    int64_t ingestion_ns_;
     TimePoint source_timestamp_;
     uint64_t hardware_timestamp_;  // e.g. from Neuralynx
     uint64_t serial_number_;