Dev/matterhornserver (#1396)

* added fetch fmt server library * added first draft of matterhorn * added enum ReturnCode * added cpp TCP Interface to slsDetectorServer * added fmt to workflows * bug: added std::signal for proper handling of ctr+c * added compile option to set log level * WIP * dont use c project settings when building matterhornserver * updated logger * WIP * WIP * linked fmt to slsProjectOptions * solved merge conflict * some refactoring * cleaned up logs * added fmt to workflow * WIP * generated register defs from csv file * oops given in hex * properly added fmt as a dependency * add fmt to conda recipe * some format changes * dont use public headers of fmt * WIP * used CRTP for virtual detector * WIP * added udp functions to matterhornserver * Matterhorn in tostring * warning unused variable from other PR * fixed build * updated cmake * added Server class usable for all detectors * removed stopserver * added some more functions * wrong overload * porper cleanup of matterhorn app * PR Review * refactored directory structure * used pause insetad of sleep --------- Co-authored-by: Dhanya Thattil <dhanya.thattil@psi.ch>
2026-07-15 05:35:11 +02:00 · 2026-05-06 13:33:35 +02:00
parent 4ffb81e7ff
commit bb1a73d718
37 changed files with 1640 additions and 97 deletions
@@ -0,0 +1,116 @@
+#include "CommandLineOptions.h"
+#include "sls/ToString.h"
+#include "sls/sls_detector_exceptions.h"
+
+#include <cstdint>
+#include <fmt/format.h>
+#include <getopt.h>
+#include <iostream>
+
+namespace sls {
+
+uint16_t CommandLineOptions::parsePort(const char *optarg) const {
+    uint16_t val = 0; // TODO: in c code its unsigned int
+
+    try {
+        val = sls::StringTo<uint16_t>(optarg);
+    } catch (const std::exception &e) {
+        throw sls::RuntimeError(fmt::format(
+            "Could not parse port number {}. {}", optarg, e.what()));
+    }
+
+    if (val < 1024) {
+        throw sls::RuntimeError(
+            "Invalid/ privileged port number parsed. Min: 1024.");
+    }
+    return val;
+}
+
+std::string
+CommandLineOptions::getHelpMessage(const std::string &executable) const {
+    // TODO: update if we keep it Matterhonr specific - refactor a bit better -
+    // e.g. if compiled with detector macro
+    std::string helpmessage = fmt::format(
+        "Usage: {}"
+        " [arguments]\n"
+        "Possible arguments are:\n"
+        "\t-v, --version                 : Software version\n"
+        "\t-p, --port <port>             : TCP communication port with client. "
+        "\n"
+        "\t-s, --safe_startup            : Safe startup mode. Skips initial "
+        "detector setup and checks. \n"
+        "\t-f, --ignore_fw_compatibility : Ignore firmware compatibility "
+        "check. \n",
+        executable);
+    return helpmessage;
+}
+
+void CommandLineOptions::parse_deprecated(const int &opt, char *argv[]) {
+
+    switch (opt) {
+    case 'd':
+        std::cout << "Warning: -d/--devel option is deprecated. Use "
+                     "-l/--safe_startup instead."
+                  << std::endl;
+        detectorserveroptions.safeStartup = true;
+        break;
+    case 'u':
+        std::cout << "Warning: -u/--update option is deprecated. Use "
+                     "-f/--ignore_fw_compatibility instead."
+                  << std::endl;
+        detectorserveroptions.ignoreFirmwareCompatibility = true;
+        break;
+    default:
+        throw std::runtime_error(fmt::format("Wrong command line arguments. {}",
+                                             getHelpMessage(argv[0])));
+    }
+}
+
+std::string CommandLineOptions::printOptions() const {
+    std::string msg = "setting up detector server";
+
+    if (detectorserveroptions.ignoreFirmwareCompatibility) {
+        msg += " skipping firmware compatibility checks";
+        msg += detectorserveroptions.safeStartup ? " and" : "";
+    }
+    if (detectorserveroptions.safeStartup) {
+        msg += " in safe startup mode e.g. skipping any initial detector setup "
+               "and checks";
+    }
+
+    return msg;
+}
+
+DetectorServerOptions CommandLineOptions::parse(int argc, char *argv[]) {
+
+    int opt, option_index = 0;
+
+    while ((opt = getopt_long(argc, argv, optstring, options.data(),
+                              &option_index)) != -1) {
+        switch (opt) {
+        case 'h':
+            std::cout << getHelpMessage(argv[0]) << std::endl;
+            detectorserveroptions.helpRequested = true; // to exit in main
+            break;
+        case 'v':
+            detectorserveroptions.versionRequested = true; // to exit in main
+            break;
+        case 'p':
+            detectorserveroptions.port = parsePort(optarg);
+            break;
+        case 'f':
+            detectorserveroptions.ignoreFirmwareCompatibility = true;
+            break;
+        case 's':
+            detectorserveroptions.safeStartup = true;
+            break;
+        default:
+            parse_deprecated(opt, argv); // to handle deprecated options and
+                                         // throw error for wrong options
+        }
+    }
+
+    return detectorserveroptions;
+}
+
+} // namespace sls
@@ -0,0 +1,95 @@
+#include "TCPInterface.h"
+
+#include "fmt/format.h"
+#include "sls/logger.h"
+#include "sls/string_utils.h"
+#include <unistd.h>
+
+namespace sls {
+
+TCPInterface::TCPInterface(
+    std::function<ReturnCode(const detFuncs &, ServerInterface &)>
+        &processFunction_,
+    const uint16_t portNumber_)
+    : processFunction(processFunction_), portNumber(portNumber_),
+      server(portNumber_) {
+    // validatePortNumber(portNumber); TODO: where to validate?
+}
+
+TCPInterface::~TCPInterface() {
+    killTcpThread = true; // mmh but if the receiver is stuck in a function,
+                          // this will be of no help
+    LOG(logINFO) << "Shutting down TCP Socket on port " << portNumber;
+    server.shutdown();
+    LOG(logDEBUG) << "TCP Socket closed on port " << portNumber;
+    if (tcpThread && tcpThread->joinable()) {
+        tcpThread->join();
+    }
+}
+
+void TCPInterface::startTCPServer() {
+
+    tcpThread = std::make_unique<std::thread>(
+        &TCPInterface::startTCPServerClientConnection, this);
+}
+
+void TCPInterface::startTCPServerClientConnection() {
+
+    LOG(logINFO) << "SLS Server starting TCP Server on port " << portNumber
+                 << '\n';
+
+    int function_id{}; // TODO should it be an enum type
+    while (!killTcpThread) {
+        try {
+            auto socket = server.accept();
+            try {
+
+                socket.Receive(function_id);
+                if (function_id < 0 || function_id >= NUM_DET_FUNCTIONS) {
+                    throw RuntimeError(fmt::format(
+                        "{}:{}", UNRECOGNIZED_FNUM_ENUM,
+                        getFunctionNameFromEnum((enum detFuncs)function_id)));
+                }
+                auto returncode = processReceivedData(
+                    static_cast<detFuncs>(function_id), socket);
+
+                if (returncode == FAIL) {
+                    throw RuntimeError(fmt::format(
+                        "Error processing command with fnum: {}",
+                        getFunctionNameFromEnum((enum detFuncs)function_id)));
+                }
+
+            } catch (const RuntimeError &e) {
+                // We had an error needs to be sent to client
+                char mess[MAX_STR_LENGTH]{};
+                LOG(logERROR) << "Error processing command: " << e.what();
+                strcpy_safe(mess, e.what());
+                socket.Send(slsDetectorDefs::FAIL);
+                socket.Send(mess);
+            }
+            // TODO handle exiting server if tcp command was to exit server
+        } catch (const RuntimeError &e) {
+            LOG(logERROR) << "Accept failed: " << e.what();
+        }
+    }
+
+    LOG(logINFOBLUE) << "Exiting TCP Server";
+}
+
+ReturnCode TCPInterface::processReceivedData(const detFuncs function_id,
+                                             ServerInterface &socket) {
+
+    LOG(logDEBUG1) << "calling function fnum: " << function_id << " ("
+                   << getFunctionNameFromEnum((enum detFuncs)function_id)
+                   << ")";
+
+    ReturnCode returncode = processFunction(function_id, socket);
+
+    LOG(logDEBUG1) << "Function "
+                   << getFunctionNameFromEnum((enum detFuncs)function_id)
+                   << " finished";
+
+    return returncode;
+}
+
+} // namespace sls