Get rid of ReportExecutionState (#253)

* Get rid of ReportExecutionState nearly everywhere

* Replace ReportExecutionState with report_running by hand

* Don't include lifecycleclient_internal in lifecycle_client

* Merge lifecycle_client(impl) into report_running(impl)

Author: TimoSteuerwaldETAS

examples/control_application/control_daemon.cpp

@@ -16,7 +16,7 @@
 #include <chrono>
 #include <iostream>
 
-#include <score/mw/lifecycle/lifecycle_client.h>
+#include <score/mw/lifecycle/report_running.h>
 #include <score/mw/lifecycle/control_client.h>
 #include "ipc_dropin/socket.hpp"
 #include "control.hpp"
@@ -30,7 +30,7 @@ int main(int argc, char** argv) {
     signal(SIGINT, signalHandler);
     signal(SIGTERM, signalHandler);
 
-    score::mw::lifecycle::LifecycleClient{}.ReportExecutionState(score::mw::lifecycle::ExecutionState::kRunning);
+    score::mw::lifecycle::report_running();
 
     ipc_dropin::Socket<static_cast<size_t>(sizeof(RunTargetInfo)), control_socket_capacity> sm_control_socket{};
     if (sm_control_socket.create(control_socket_path, 600) != ipc_dropin::ReturnCode::kOk) {

examples/cpp_supervised_app/main.cpp

@@ -23,7 +23,7 @@
 #include <sys/prctl.h>
 #endif
 
-#include <score/mw/lifecycle/lifecycle_client.h>
+#include <score/mw/lifecycle/report_running.h>
 #include <score/mw/log/rust/stdout_logger_init.h>
 #include <score/mw/health/common.h>
 #include <score/mw/health/health_monitor.h>
@@ -146,7 +146,7 @@ int main(int argc, char** argv)
 
         hm.start();
 
-        score::mw::lifecycle::LifecycleClient{}.ReportExecutionState(score::mw::lifecycle::ExecutionState::kRunning);
+        score::mw::lifecycle::report_running();
 
         auto deadline_mon = std::move(*deadline_monitor_res);
 

score/launch_manager/daemon/src/alive_monitor/details/daemon/PhmDaemon.hpp

@@ -19,7 +19,6 @@
 #include <memory>
 
 #include <vector>
-#include "score/mw/lifecycle/lifecycle_client.h"
 #include "score/mw/lifecycle/control_client.h"
 #include "score/mw/launch_manager/alive_monitor/details/daemon/PhmDaemonConfig.hpp"
 #include "score/mw/launch_manager/alive_monitor/details/daemon/SwClusterHandler.hpp"

score/launch_manager/lifecycle_client/BUILD

@@ -21,7 +21,6 @@ cc_library(
     deps = [
         ":aasapplicationcontainer",
         ":application",
-        ":lifecycleclient_internal",
         ":lifecyclemanager",
         ":report_running",
         ":runapplication",
@@ -145,26 +144,7 @@ cc_library(
     tags = ["FUSA"],
     visibility = ["//score/launch_manager:__subpackages__"],
     deps = [
-        ":lifecycleclient_internal",
-    ],
-)
-
-cc_library(
-    name = "lifecycleclient_internal",
-    srcs = [
-        "src/lifecycle_client.cpp",
-    ],
-    hdrs = [
-        "src/lifecycle_client.h",
-    ],
-    features = COMPILER_WARNING_FEATURES,
-    include_prefix = "score/mw/lifecycle",
-    strip_include_prefix = "/score/launch_manager/lifecycle_client/src",
-    tags = ["FUSA"],
-    visibility = ["//score/launch_manager/lifecycle_client:__subpackages__"],
-    deps = [
-        "//score/launch_manager:error_event",
-        "//score/launch_manager/lifecycle_client/src/details:lifecycle_client_impl",
+        "//score/launch_manager/lifecycle_client/src/details:report_running_impl",
     ],
 )
 

score/launch_manager/lifecycle_client/src/details/BUILD

@@ -13,9 +13,9 @@
 load("@rules_cc//cc:defs.bzl", "cc_library")
 
 cc_library(
-    name = "lifecycle_client_impl",
-    srcs = ["lifecycle_client_impl.cpp"],
-    hdrs = ["lifecycle_client_impl.hpp"],
+    name = "report_running_impl",
+    srcs = ["report_running_impl.cpp"],
+    hdrs = ["report_running_impl.hpp"],
     include_prefix = "score/mw/lifecycle/lifecycle_client/details",
     strip_include_prefix = "/score/launch_manager/lifecycle_client/src/details",
     visibility = ["//score/launch_manager/lifecycle_client:__pkg__"],

…nt/src/details/lifecycle_client_impl.cpp …ient/src/details/report_running_impl.cppscore/launch_manager/lifecycle_client/src/details/lifecycle_client_impl.cpp renamed to score/launch_manager/lifecycle_client/src/details/report_running_impl.cpp score/launch_manager/lifecycle_client/src/details/lifecycle_client_impl.cpp renamed to score/launch_manager/lifecycle_client/src/details/report_running_impl.cpp

@@ -23,18 +23,18 @@
 #include "score/mw/launch_manager/osal/ipc_comms.hpp"
 #include "score/mw/launch_manager/common/constants.hpp"
 #include "score/mw/lifecycle/execution_error.h"
-#include "score/mw/lifecycle/lifecycle_client/details/lifecycle_client_impl.hpp"
+#include "score/mw/lifecycle/lifecycle_client/details/report_running_impl.hpp"
 
 using namespace score::lcm::internal::osal;
 
 namespace score::mw::lifecycle {
-        std::atomic_bool LifecycleClientImpl::reported{false};
+        std::atomic_bool ReportRunningImpl::reported{false};
 
-        LifecycleClientImpl::LifecycleClientImpl() noexcept = default;
+        ReportRunningImpl::ReportRunningImpl() noexcept = default;
 
-        LifecycleClientImpl::~LifecycleClientImpl() noexcept = default;
+        ReportRunningImpl::~ReportRunningImpl() noexcept = default;
 
-        score::Result<std::monostate> LifecycleClientImpl::ReportRunningState() const noexcept
+        score::Result<std::monostate> ReportRunningImpl::ReportRunningState() const noexcept
         {
             score::Result<std::monostate> retVal{score::MakeUnexpected(ExecErrc::kCommunicationError)};
 
@@ -51,7 +51,7 @@ namespace score::mw::lifecycle {
             return retVal;
         }
 
-        score::Result<std::monostate> LifecycleClientImpl::reportKRunningtoDaemon() const noexcept
+        score::Result<std::monostate> ReportRunningImpl::reportKRunningtoDaemon() const noexcept
         {
             score::Result<std::monostate> comms_error {score::MakeUnexpected(ExecErrc::kCommunicationError)};
 
@@ -103,7 +103,7 @@ namespace score::mw::lifecycle {
 
                 return comms_error;
             }
-            
+
             // Final post to semaphore, so LM know that communication channel can be closed now
             sync->send_sync_.post();
             // Mark as reported if successful

…nt/src/details/lifecycle_client_impl.hpp …ient/src/details/report_running_impl.hppscore/launch_manager/lifecycle_client/src/details/lifecycle_client_impl.hpp renamed to score/launch_manager/lifecycle_client/src/details/report_running_impl.hpp score/launch_manager/lifecycle_client/src/details/lifecycle_client_impl.hpp renamed to score/launch_manager/lifecycle_client/src/details/report_running_impl.hpp

@@ -12,8 +12,8 @@
  ********************************************************************************/
 
 
-#ifndef _INCLUDED_LIFECYCLECLIENTIMPL_
-#define _INCLUDED_LIFECYCLECLIENTIMPL_
+#ifndef _INCLUDED_REPORTRUNNINGIMPL_
+#define _INCLUDED_REPORTRUNNINGIMPL_
 
 #include <atomic>
 
@@ -22,22 +22,21 @@
 
 namespace score::mw::lifecycle {
 
-/// @brief  Class implementing Pimpl (pointer to implementation) design pattern for LifecycleClient (an AUTOSAR data type).
-/// The lifecycle_client_lib strive to provide ABI compatibility as much as we can, so for this reason Pimpl pattern is deployed.
-/// Design of this class fulfil the needs of the pattern mentioned.
-/// More info can be found here: https://isocpp.github.io/CppCoreGuidelines/CppCoreGuidelines#Ri-pimpl
-class LifecycleClientImpl final {
+/// @brief Implementation class for report_running(), handling the actual IPC
+/// communication with the Launch Manager to signal that this process has
+/// entered its Running state.
+class ReportRunningImpl final {
    public:
-    /// @brief Constructor that creates LifecycleClientImpl (implementation of Lifecycle Client)
-    LifecycleClientImpl() noexcept;
+    /// @brief Constructor
+    ReportRunningImpl() noexcept;
 
-    /// @brief Destructor of the LifecycleClientImpl (implementation of Lifecycle Client)
-    ~LifecycleClientImpl() noexcept;
+    /// @brief Destructor
+    ~ReportRunningImpl() noexcept;
 
     // This class is trivially copyable / movable
     // For this reason we are applying the rule of zero
 
-    /// @brief Implementation of a interface for a Process to report its running state to Launch Manager.
+    /// @brief Reports the Running state to the Launch Manager.
     ///
     /// @returns An instance of score::Result. The instance holds an ErrorCode containing either one of the specified errors or a void-value.
     /// @error score::mw::lifecycle::ExecErrc::kCommunicationError Communication error between Application and Launch Manager, e.g. unable to report state for Non-reporting Process.
@@ -46,10 +45,10 @@ class LifecycleClientImpl final {
 
    private:
     /// @brief Variable to remember if kRunning was already reported for the process using lifecycle_client_lib.
-    /// Please note that LifecycleClient::ReportRunningState() method, the original method, is declared as a const method.
+    /// Please note that ReportRunningState() method is declared as a const method.
     /// Thanks to this, user can choose to declare instance of this class as a constant variable and reporting kRunning will still work.
     /// However, this prevent us from implementing certain optimizations, after initial kRunning was reported.
-    /// To mitigate this, we can store this information outside of LifecycleClientImpl class or have a mutable variable.
+    /// To mitigate this, we can store this information outside of ReportRunningImpl class or have a mutable variable.
     /// After short discussion, mutable variable was chosen.
     ///        True if kRunning was already reported by the process using this library.
     ///        False if kRunning was not yet reported by the process using this library.
@@ -62,4 +61,4 @@ class LifecycleClientImpl final {
 
 }  // namespace score::mw::lifecycle
 
-#endif  // _INCLUDED_LIFECYCLECLIENTIMPL_
+#endif  // _INCLUDED_REPORTRUNNINGIMPL_