Convert Svc.Time into An Interface (nasa#2317)

* Renaming of linux time files to posix * Fixes nasa#2256. Renames LinuxTime into PosixTime implementing new Time interface * sp * Static analysis errors * Cleaning up other LinuxTime references
thomas-bc · Oct 25, 2023 · b5777e9 · b5777e9
1 parent 5e0b388
commit b5777e9
Show file tree

Hide file tree

Showing 34 changed files with 101 additions and 225 deletions.
diff --git a/.github/actions/spelling/excludes.txt b/.github/actions/spelling/excludes.txt
@@ -92,7 +92,7 @@ ignore$
 ^Fw/Types/Linux/StandardTypes\.hpp$
 ^requirements\.txt$
 ^RPI/settings\.ini$
-^Svc/LinuxTime/LinuxTime\.hpp$
+^Svc/PosixTime/PosixTime\.hpp$
 ^Svc/PrmDb/PrmDb\.hpp$
 ^Svc/TlmChan/TlmChan\.hpp$
 ^\.github/actions/spelling/
@@ -113,6 +113,6 @@ ignore$
 ^\Qrequirements.txt\E$
 ^\QSTest/README.md\E$
 ^\QSvc/FileDownlink/check.xml\E$
-^\QSvc/LinuxTime/LinuxTime.hpp\E$
+^\QSvc/PosixTime/PosixTime.hpp\E$
 ^\QSvc/PrmDb/PrmDb.hpp\E$
 ^\QSvc/TlmChan/TlmChan.hpp\E$
diff --git a/RPI/Top/CMakeLists.txt b/RPI/Top/CMakeLists.txt
@@ -14,7 +14,7 @@ set(SOURCE_FILES
 # Note: supply non-explicit dependencies here
 set(MOD_DEPS
    Fw/Logger
-   Svc/LinuxTime
+   Svc/PosixTime
    # Communication Implementations
    Drv/Udp
    Drv/TcpClient

diff --git a/RPI/Top/Components.hpp b/RPI/Top/Components.hpp
@@ -8,7 +8,7 @@
 #include <Svc/CmdSequencer/CmdSequencerImpl.hpp>
 #include <Svc/PassiveConsoleTextLogger/ConsoleTextLoggerImpl.hpp>
 #include <Svc/ActiveLogger/ActiveLoggerImpl.hpp>
-#include <Svc/LinuxTime/LinuxTimeImpl.hpp>
+#include <Svc/PosixTime/PosixTime.hpp>
 #include <Svc/LinuxTimer/LinuxTimerComponentImpl.hpp>
 #include <Svc/TlmChan/TlmChanImpl.hpp>
 #include <Svc/PrmDb/PrmDbImpl.hpp>
@@ -45,7 +45,7 @@ extern Svc::ActiveRateGroupImpl rateGroup1HzComp;
 extern Svc::CmdSequencerComponentImpl cmdSeq;
 extern Svc::ConsoleTextLoggerImpl textLogger;
 extern Svc::ActiveLoggerImpl eventLogger;
-extern Svc::LinuxTimeImpl linuxTime;
+extern Svc::PosixTime posixTime;
 extern Svc::LinuxTimerComponentImpl linuxTimer;
 extern Svc::TlmChanImpl chanTlm;
 extern Svc::CommandDispatcherImpl cmdDisp;

diff --git a/RPI/Top/Topology.cpp b/RPI/Top/Topology.cpp
@@ -43,7 +43,7 @@ Svc::ConsoleTextLoggerImpl textLogger("TLOG");
 
 Svc::ActiveLoggerImpl eventLogger("ELOG");
 
-Svc::LinuxTimeImpl linuxTime("LTIME");
+Svc::PosixTime posixTime("LTIME");
 
 Svc::LinuxTimerComponentImpl linuxTimer("LTIMER");
 
@@ -102,7 +102,7 @@ void constructApp(U32 port_number, char* hostname) {
 
     eventLogger.init(10,0);
 
-    linuxTime.init(0);
+    posixTime.init(0);
 
     linuxTimer.init(0);
 

diff --git a/RPI/Top/instances.fpp b/RPI/Top/instances.fpp
@@ -276,9 +276,7 @@ module RPI {
 
   }
 
-  instance linuxTime: Svc.Time base id 1500 \
-    type "Svc::LinuxTime" \
-    at "../../Svc/LinuxTime/LinuxTime.hpp"
+  instance posixTime: Svc.PosixTime base id 1500
 
   instance linuxTimer: Svc.LinuxTimer base id 1600 \
   {

diff --git a/RPI/Top/topology.fpp b/RPI/Top/topology.fpp
@@ -23,7 +23,7 @@ module RPI {
     instance gpio24Drv
     instance gpio25Drv
     instance ledDrv
-    instance linuxTime
+    instance posixTime
     instance linuxTimer
     instance prmDb
     instance rateGroup10HzComp
@@ -53,7 +53,7 @@ module RPI {
 
     text event connections instance textLogger
 
-    time connections instance linuxTime
+    time connections instance posixTime
 
     # ----------------------------------------------------------------------
     # Direct graph specifiers

diff --git a/Ref/Top/CMakeLists.txt b/Ref/Top/CMakeLists.txt
@@ -13,7 +13,7 @@ set(SOURCE_FILES
 )
 set(MOD_DEPS
   Fw/Logger
-  Svc/LinuxTime
+  Svc/PosixTime
   # Communication Implementations
   Drv/Udp
   Drv/TcpClient

diff --git a/Ref/Top/instances.fpp b/Ref/Top/instances.fpp
@@ -130,9 +130,7 @@ module Ref {
 
   instance fileUplinkBufferManager: Svc.BufferManager base id 0x4400
 
-  instance linuxTime: Svc.Time base id 0x4500 \
-    type "Svc::LinuxTime" \
-    at "../../Svc/LinuxTime/LinuxTime.hpp"
+  instance posixTime: Svc.PosixTime base id 0x4500
 
   instance rateGroupDriverComp: Svc.RateGroupDriver base id 0x4600
 

diff --git a/Ref/Top/topology.fpp b/Ref/Top/topology.fpp
@@ -40,7 +40,7 @@ module Ref {
     instance fileManager
     instance fileUplink
     instance fileUplinkBufferManager
-    instance linuxTime
+    instance posixTime
     instance pingRcvr
     instance prmDb
     instance rateGroup1Comp
@@ -69,7 +69,7 @@ module Ref {
 
     text event connections instance textLogger
 
-    time connections instance linuxTime
+    time connections instance posixTime
 
     health connections instance $health
 

diff --git a/Ref/docs/Ref.md b/Ref/docs/Ref.md
@@ -35,7 +35,7 @@
 |Svc/PassiveConsoleTextLogger|[Link](../../Svc/PassiveConsoleTextLogger/docs/sdd.md)|
 |Svc/Time|[Link](../../Svc/Time/docs/sdd.md)|
 |Svc/Cycle|[Link](../../Svc/Cycle/docs/sdd.md)|
-|Svc/LinuxTime|[Link](../../Svc/LinuxTime/docs/sdd.md)|
+|Svc/PosixTime|[Link](../../Svc/PosixTime/docs/sdd.md)|
 |Svc/ActiveLogger|[Link](../../Svc/ActiveLogger/docs/sdd.md)|
 |Svc/Fatal|[Link](../../Svc/Fatal/docs/sdd.md)|
 |Svc/PolyIf|[Link](../../Svc/PolyIf/docs/sdd.md)|

diff --git a/Ref/docs/sdd.md b/Ref/docs/sdd.md
@@ -44,7 +44,7 @@ There is a set of useful utility components that can be used on supported operat
 
 |Component|Description|Link
 |---|---|---|
-|LinuxTime|Provides time stamps for telemetry on a Linux system|[HTML](../../Svc/LinuxTime/docs/sdd.html) [MD](../../Svc/LinuxTime/docs/sdd.md)|
+|PosixTime|Provides time stamps for telemetry on a posix systems|[HTML](../../Svc/PosixTime/docs/sdd.html) [MD](../../Svc/PosixTime/docs/sdd.md)|
 |PassiveConsoleTextLogger|Prints the text form of events to standard output|[HTML](../../Svc/PassiveConsoleTextLogger/docs/sdd.html) [MD](../../Svc/PassiveConsoleTextLogger/docs/sdd.md)|
 |SocketGndIf|Provides a socket for communicating with the ground system|[HTML](../../Svc/SocketGndIf/docs/sdd.html) [MD](../../Svc/SocketGndIf/docs/sdd.md)|
 

diff --git a/Svc/CMakeLists.txt b/Svc/CMakeLists.txt
@@ -40,7 +40,6 @@ add_fprime_subdirectory("${CMAKE_CURRENT_LIST_DIR}/PolyDb/")
 add_fprime_subdirectory("${CMAKE_CURRENT_LIST_DIR}/PrmDb/")
 add_fprime_subdirectory("${CMAKE_CURRENT_LIST_DIR}/RateGroupDriver/")
 add_fprime_subdirectory("${CMAKE_CURRENT_LIST_DIR}/StaticMemory/")
-add_fprime_subdirectory("${CMAKE_CURRENT_LIST_DIR}/Time/")
 add_fprime_subdirectory("${CMAKE_CURRENT_LIST_DIR}/TlmChan/")
 add_fprime_subdirectory("${CMAKE_CURRENT_LIST_DIR}/TlmPacketizer/")
 add_fprime_subdirectory("${CMAKE_CURRENT_LIST_DIR}/SystemResources/")
@@ -53,6 +52,6 @@ if (FPRIME_ENABLE_TEXT_LOGGERS)
 endif()
 
 if(${CMAKE_SYSTEM_NAME} STREQUAL "Linux" OR ${CMAKE_SYSTEM_NAME} STREQUAL "Darwin")
-	add_fprime_subdirectory("${CMAKE_CURRENT_LIST_DIR}/LinuxTime/")
+	add_fprime_subdirectory("${CMAKE_CURRENT_LIST_DIR}/PosixTime/")
 	add_fprime_subdirectory("${CMAKE_CURRENT_LIST_DIR}/LinuxTimer/")
 endif()
diff --git a/Svc/Interfaces/Time.fppi b/Svc/Interfaces/Time.fppi
@@ -0,0 +1,2 @@
+@ Port to retrieve time
+sync input port timeGetPort: Fw.Time
diff --git a/Svc/LinuxTime/DarwinTimeImpl.cpp b/Svc/LinuxTime/DarwinTimeImpl.cpp
diff --git a/Svc/LinuxTime/LinuxTime.hpp b/Svc/LinuxTime/LinuxTime.hpp
diff --git a/Svc/LinuxTime/README b/Svc/LinuxTime/README
diff --git a/Svc/LinuxTime/VxWorksTimeImpl.cpp b/Svc/LinuxTime/VxWorksTimeImpl.cpp
diff --git a/Svc/LinuxTime/docs/sdd.md b/Svc/LinuxTime/docs/sdd.md
diff --git a/Svc/LinuxTime/CMakeLists.txt → Svc/PosixTime/CMakeLists.txt b/Svc/LinuxTime/CMakeLists.txt → Svc/PosixTime/CMakeLists.txt
@@ -7,18 +7,15 @@
 # Note: using PROJECT_NAME as EXECUTABLE_NAME
 ####
 set(SOURCE_FILES
-  "${FPRIME_FRAMEWORK_PATH}/Svc/Time/Time.fpp"
-  "${CMAKE_CURRENT_LIST_DIR}/LinuxTimeImpl.cpp"
-)
-set(MOD_DEPS
-  Svc/Time
+  "${CMAKE_CURRENT_LIST_DIR}/PosixTime.fpp"
+  "${CMAKE_CURRENT_LIST_DIR}/PosixTime.cpp"
 )
 
 register_fprime_module()
 ### UTs ###
 set(UT_SOURCE_FILES
-  "${FPRIME_FRAMEWORK_PATH}/Svc/Time/Time.fpp"
-  "${CMAKE_CURRENT_LIST_DIR}/test/ut/LinuxTimeTester.cpp"
-  "${CMAKE_CURRENT_LIST_DIR}/test/ut/LinuxTimeMain.cpp"
+  "${CMAKE_CURRENT_LIST_DIR}/PosixTime.fpp"
+  "${CMAKE_CURRENT_LIST_DIR}/test/ut/PosixTimeTester.cpp"
+  "${CMAKE_CURRENT_LIST_DIR}/test/ut/PosixTimeMain.cpp"
 )
 register_fprime_ut()
diff --git a/Svc/LinuxTime/LinuxTimeImpl.cpp → Svc/PosixTime/PosixTime.cpp b/Svc/LinuxTime/LinuxTimeImpl.cpp → Svc/PosixTime/PosixTime.cpp
@@ -5,30 +5,25 @@
  *      Author: tcanham
  */
 
-#include <Svc/LinuxTime/LinuxTimeImpl.hpp>
+#include <Svc/PosixTime/PosixTime.hpp>
 #include <Fw/Time/Time.hpp>
 #include <ctime>
 
 namespace Svc {
 
-    LinuxTimeImpl::LinuxTimeImpl(const char* name) : TimeComponentBase(name)
+    PosixTime::PosixTime(const char* name) : PosixTimeComponentBase(name)
     {
     }
 
-    LinuxTimeImpl::~LinuxTimeImpl() {
+    PosixTime::~PosixTime() {
     }
 
-    void LinuxTimeImpl::timeGetPort_handler(
+    void PosixTime::timeGetPort_handler(
             NATIVE_INT_TYPE portNum, /*!< The port number*/
             Fw::Time &time /*!< The U32 cmd argument*/
         ) {
         timespec stime;
         (void)clock_gettime(CLOCK_REALTIME,&stime);
         time.set(TB_WORKSTATION_TIME,0, stime.tv_sec, stime.tv_nsec/1000);
     }
-
-    void LinuxTimeImpl::init(NATIVE_INT_TYPE instance) {
-        TimeComponentBase::init(instance);
-    }
-
 }
diff --git a/Svc/PosixTime/PosixTime.fpp b/Svc/PosixTime/PosixTime.fpp
@@ -0,0 +1,6 @@
+module Svc {
+  @ A component for getting time
+  passive component PosixTime {
+    include "../Interfaces/Time.fppi"
+  }
+}
diff --git a/Svc/LinuxTime/LinuxTimeImpl.hpp → Svc/PosixTime/PosixTime.hpp b/Svc/LinuxTime/LinuxTimeImpl.hpp → Svc/PosixTime/PosixTime.hpp
@@ -5,18 +5,17 @@
  *      Author: tcanham
  */
 
-#ifndef LINUXTIMEIMPL_HPP_
-#define LINUXTIMEIMPL_HPP_
+#ifndef POSIX_TIME_HPP_
+#define POSIX_TIME_HPP_
 
-#include <Svc/Time/TimeComponentAc.hpp>
+#include <Svc/PosixTime/PosixTimeComponentAc.hpp>
 
 namespace Svc {
 
-class LinuxTimeImpl: public TimeComponentBase {
+class PosixTime: public PosixTimeComponentBase {
     public:
-        LinuxTimeImpl(const char* compName);
-        virtual ~LinuxTimeImpl();
-        void init(NATIVE_INT_TYPE instance);
+        explicit PosixTime(const char* compName);
+        virtual ~PosixTime();
     protected:
         void timeGetPort_handler(
                 NATIVE_INT_TYPE portNum, /*!< The port number*/
@@ -27,4 +26,4 @@ class LinuxTimeImpl: public TimeComponentBase {
 
 }
 
-#endif /* LINUXTIMEIMPL_HPP_ */
+#endif /* POSIX_TIME_HPP_ */
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		@ Port to retrieve time
		sync input port timeGetPort: Fw.Time