Clean main and init files from different architectures

.github/workflows/cmake-multi-platform.yml

@@ -90,6 +90,9 @@ jobs:
         -DFORTE_MODULE_RT_Events=ON
         -DFORTE_MODULE_SIGNALPROCESSING=ON
         -DFORTE_MODULE_UTILS=ON
+        -DFORTE_BUILD_STATIC_LIBRARY=ON
+        -DFORTE_BUILD_SHARED_LIBRARY=ON
+        -DFORTE_C_INTERFACE=ON
         -DFORTE_TESTS=ON
         ${{ matrix.os == 'windows-latest' && format('-DFORTE_TESTS_INC_DIRS={0}/boost.1.84.0/lib/native/include', github.workspace) || '' }}
 

CMakeLists.txt

@@ -2,6 +2,7 @@
 # Copyright (c) 2010 - 2015 Profactor GmbH, AIT, fortiss GmbH
 #               2010-2015, 2020 TU Wien/ACIN
 #               2022 Martin Erich Jobst
+#               2024 Jose Cabral
 #
 # This program and the accompanying materials are made available under the
 # terms of the Eclipse Public License 2.0 which is available at
@@ -62,6 +63,9 @@ mark_as_advanced(FORTE_BUILD_STATIC_LIBRARY)
 set(FORTE_BUILD_SHARED_LIBRARY OFF CACHE BOOL "Build FORTE as shared library")
 mark_as_advanced(FORTE_BUILD_SHARED_LIBRARY)
 
+SET(FORTE_C_INTERFACE OFF CACHE BOOL "Build C interface to Forte")
+mark_as_advanced(FORTE_C_INTERFACE)
+
 #######################################################################################
 # Determine the loglevel
 #######################################################################################

src/arch/CMakeLists.txt

@@ -1,5 +1,5 @@
 #*******************************************************************************
-# Copyright (c) 2010 - 2018 ACIN
+# Copyright (c) 2010 - 2024 ACIN, Jose Cabral
 # This program and the accompanying materials are made available under the
 # terms of the Eclipse Public License 2.0 which is available at
 # http://www.eclipse.org/legal/epl-2.0.
@@ -64,6 +64,4 @@ if (FORTE_STACKTRACE)
     endif ()
 endif ()
 
-forte_add_sourcefile_with_path_cpp(${CMAKE_BINARY_DIR}/src_gen/startuphook.cpp) # created file
-
-
+forte_add_sourcefile_with_path_cpp(${CMAKE_BINARY_DIR}/src_gen/startuphook.cpp)

src/arch/ecos/forte_instance.cpp → src/arch/c_interface/forte_c.cpp

@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (c) 2018 fortiss GmbH
+ * Copyright (c) 2018 - 2024 fortiss GmbH, Jose Cabral
  * This program and the accompanying materials are made available under the
  * terms of the Eclipse Public License 2.0 which is available at
  * http://www.eclipse.org/legal/epl-2.0.
@@ -11,42 +11,38 @@
  *  Tarik Terzimehic - make OPC UA server port setable from the command line
  *******************************************************************************/
 
-#include "forte_instance.h"
-#include "forteinstance.h"
-#include <forte_printer.h>
-
-#include "fortenew.h"
-#include "forte_architecture.h"
-#include <stdio.h>
-#include <stdlib.h>
-#include "../../stdfblib/ita/RMT_DEV.h"
+#include "forte_c.h"
 
 #include "../utils/mainparam_utils.h"
+#include "forte_architecture.h"
+#include "forte_printer.h"
+#include "forteinstance.h"
 
-unsigned const int cgForteDefaultPort = 61499;
+static const unsigned int scForteDefaultPort = 61499;
+static const unsigned int scMaxPortValue = 65535;
 
-/*!\brief Check if the correct endianess has been configured.
- *
- * If the right endianess is not set this function will end FORTE.
- */
+/**
+* @brief Check if the correct endianess has been configured.
+*/
 bool checkEndianess();
 
-void forteGlobalInitialize(){
-  CForteArchitecture::initialize();
+int forteGlobalInitialize(int argc, char *argv[]){
+  return CForteArchitecture::initialize(argc, argv);
 }
 
-void forteGlobalDeinitialize(){
-  CForteArchitecture::deinitialize();
+int forteGlobalDeinitialize(){
+  return CForteArchitecture::deinitialize();
 }
 
-int forteStartInstance(unsigned int paPort, TForteInstance* paResultInstance){
+FORTE_STATUS forteStartInstance(unsigned int paPort, TForteInstance* paResultInstance){
 
-  if(65535 < paPort){
+  if(scMaxPortValue < paPort){
+    DEVLOG_ERROR("Provided port %d is not valid\n", paPort);
     return FORTE_WRONG_PARAMETERS;
   }
 
   if(0 == paPort){
-    paPort = cgForteDefaultPort;
+    paPort = scForteDefaultPort;
   }
 
   char progName[] = "forte";
@@ -60,50 +56,59 @@ int forteStartInstance(unsigned int paPort, TForteInstance* paResultInstance){
   return forteStartInstanceGeneric(3, arguments, paResultInstance);
 }
 
-int forteStartInstanceGeneric(int argc, char *arg[], TForteInstance* paResultInstance){
-
-  if(!CForteArchitecture::isInitialized()){
-    return FORTE_ARCHITECTURE_NOT_READY;
-  }
+FORTE_STATUS forteStartInstanceGeneric(int argc, char *argv[], TForteInstance* paResultInstance){
 
-  if(0 == paResultDevice){
+  if(nullptr == paResultInstance){
+    DEVLOG_ERROR("Provided result instance parameter is not valid\n");
     return FORTE_WRONG_PARAMETERS;
   }
 
-  if(0 != *paResultDevice){
+  if(nullptr != *paResultInstance){
+    DEVLOG_ERROR("Provided result instance already started\n");
     return FORTE_DEVICE_ALREADY_STARTED;
   }
 
   if(!checkEndianess()){
+    // logged already in the function
     return FORTE_WRONG_ENDIANESS;
   }
 
-  const char *pIpPort = parseCommandLineArguments(argc, arg);
-  if((0 != strlen(pIpPort)) && (nullptr != strchr(pIpPort, ':'))){
-    C4diacFORTEInstance *instance = new C4diacFORTEInstance();
-    if(!instance->startupNewDevice(ipPort)) {
-      delete instance;
-      return FORTE_COULD_NOT_CREATE_DEVICE;
-    }
-    *paResultInstance = instance;
-    DEVLOG_INFO("FORTE is up and running\n");
+  if(!CForteArchitecture::isInitialized()){
+    DEVLOG_ERROR("The low level platform should be initialized before starting a forte instance\n");
+    return FORTE_ARCHITECTURE_NOT_READY;
   }
-  else{ //! If needed call listHelp() to list the help for FORTE
+
+  const auto ipPort = parseCommandLineArguments(argc, argv);
+  if((0 == strlen(ipPort)) || (nullptr == strchr(ipPort, ':'))){
+    listHelp();
     return FORTE_WRONG_PARAMETERS;
   }
+
+  C4diacFORTEInstance *instance = new C4diacFORTEInstance();
+  if(!instance->startupNewDevice(ipPort)) {
+    delete instance;
+    return FORTE_COULD_NOT_CREATE_DEVICE;
+  }
+  *paResultInstance = instance;
 
   return FORTE_OK;
 }
 
-void forteStopInstance(int, TForteInstance paInstance){
-  if(!CForteArchitecture::isInitialized() || paResultInstance == nullptr){
+void forteRequestStopInstance(TForteInstance paInstance){
+  if(!CForteArchitecture::isInitialized() || paInstance == nullptr){
     return;
   }
-  C4diacFORTEInstance *instance = static_cast<C4diacFORTEInstance *>(paResultInstance);
+  auto *instance = static_cast<C4diacFORTEInstance *>(paInstance);
   instance->triggerDeviceShutdown();
+}
+
+void forteWaitForInstanceToStop(TForteInstance paInstance) {
+   if(!CForteArchitecture::isInitialized() || paInstance == nullptr){
+    return;
+  }
+  auto *instance = static_cast<C4diacFORTEInstance *>(paInstance);
   instance->awaitDeviceShutdown();
   delete instance;
-  DEVLOG_INFO("FORTE finished\n");
 }
 
 bool checkEndianess(){

src/arch/c_interface/forte_c.h

@@ -0,0 +1,82 @@
+/*******************************************************************************
+ * Copyright (c) 2018 - 2024 fortiss GmbH, Jose Cabral
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License 2.0 which is available at
+ * http://www.eclipse.org/legal/epl-2.0.
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ *
+ * Contributors:
+ *  Jose Cabral - initial API and implementation and/or initial documentation
+ *******************************************************************************/
+
+#ifndef SRC_ARCH_FORTE_C_H_
+#define SRC_ARCH_FORTE_C_H_
+
+#ifndef FORTE_SHARED_PREFIX
+  #define FORTE_SHARED_PREFIX
+#endif
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+  typedef enum FORTE_STATUS{
+    FORTE_OK = 0,
+    FORTE_DEVICE_ALREADY_STARTED,
+    FORTE_WRONG_ENDIANESS,
+    FORTE_WRONG_PARAMETERS,
+    FORTE_ARCHITECTURE_NOT_READY,
+    FORTE_COULD_NOT_CREATE_DEVICE,
+  } FORTE_STATUS;
+
+  typedef void* TForteInstance;
+
+  /**
+   * \brief Start forte instance
+   * @param paPort The port on which forte will listen. Use 0 for default 61499
+   * @param paResultInstance Address  to store the created forte instance
+   * @return FORTE_OK if no error occurred, other values otherwise
+   */
+  FORTE_SHARED_PREFIX FORTE_STATUS forteStartInstance(unsigned int paPort, TForteInstance* paResultInstance);
+
+  /**
+   * \brief Start forte instance with posibilities of more arguments
+   * @param argc Number of arguments in arg
+   * @param argv Arguments
+   * @param paResultInstance Address  to store the created forte instance
+   * @return FORTE_OK if no error occurred, other values otherwise
+   */
+  FORTE_SHARED_PREFIX FORTE_STATUS forteStartInstanceGeneric(int argc, char *argv[], TForteInstance* paResultInstance);
+
+  /**
+   * \brief Request termination of a Forte instance
+   * @param paInstance Instance to request for termination
+   */
+  FORTE_SHARED_PREFIX void forteRequestStopInstance(TForteInstance paInstance);
+
+  /**
+   * \brief Waits indefinitely for the intance to stop and deletes it
+   * @param paInstance Instance to terminate
+  */
+  FORTE_SHARED_PREFIX void forteWaitForInstanceToStop(TForteInstance paInstance);
+
+  /**
+   * \brief Initializes the architecture. Prepare all resources needed by the Forte's instances. Must be called once before the first Forte instance is started
+   * @param argc Number of arguments in arg
+   * @param argv Arguments
+   * @return 0 if no error occurred, other values otherwise. Any error value is provided by the architecture and not by forte
+   */
+  FORTE_SHARED_PREFIX int forteGlobalInitialize(int argc, char *argv[]);
+
+  /**
+   * \brief Deinitializes the architecture. Frees all resources used by Forte's instances. Must be called after the last instance is ended
+   * @return 0 if no error occurred, other values otherwise.  Any error value is provided by the architecture and not by forte
+   */
+  FORTE_SHARED_PREFIX int forteGlobalDeinitialize();
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* SRC_ARCH_FORTE_C_H_ */

src/arch/win32/forte_instance.h → src/arch/common/forte_specific_architecture.cpp

@@ -1,27 +1,21 @@
 /*******************************************************************************
- * Copyright (c) 2017 fortiss GmbH
+ * Copyright (c) 2024 Jose Cabral
  * This program and the accompanying materials are made available under the
  * terms of the Eclipse Public License 2.0 which is available at
  * http://www.eclipse.org/legal/epl-2.0.
  *
  * SPDX-License-Identifier: EPL-2.0
  *
  * Contributors:
- *  Jose Cabral, Alois Zoitl - initial API and implementation and/or initial documentation
+ *  Jose Cabral - initial API and implementation and/or initial documentation
  *******************************************************************************/
 
-#ifndef FORTE_INSTANCE_H_
-#define FORTE_INSTANCE_H_
+#include "arch/forte_specific_architecture.h"
 
-#ifdef __cplusplus
-extern "C" {
-#endif
-
-void startupFORTE();
-void shutdownFORTE();
-
-#ifdef __cplusplus
+int CForteSpecificArchitecture::initialize(int , char** ){
+  return 0;
 }
-#endif
 
-#endif
+int CForteSpecificArchitecture::deinitialize() {
+  return 0;
+}

src/arch/ecos/ecoscppinit.cpp

@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (c) 2010 - 2011 ACIN
+ * Copyright (c) 2010 - 2024 ACIN, Jose Cabral
  * This program and the accompanying materials are made available under the
  * terms of the Eclipse Public License 2.0 which is available at
  * http://www.eclipse.org/legal/epl-2.0.
@@ -11,11 +11,18 @@
  *******************************************************************************/
 #include <cyg/kernel/kapi.h>
 
-//current tests have shown that this works only if it is in the main.cpp file
-//I don't know why. The best is to copy or include it into your specific main file
-
 //Workaround for an ecos problem
 extern "C" void
 __cxa_pure_virtual(void) {
   //TODO maybe add some exception handling reporting here
 }
+
+extern "C" void abort(int ) { while(1) ; }
+
+void *__dso_handle = 0;
+
+extern "C" int _getpid(void) {
+  return 1;
+}
+
+extern "C" void _kill(int ) { while(1) ; }