lola: Pass reference to EventDataControlComposite

Since we always create a QM EventDataControl, we pass it into the
composite by reference instead of by pointer to avoid doing nullptr
checks within the composite (and for clearer semantics).

Author: bemerybmw

score/mw/com/impl/bindings/lola/control_slot_indicator.h

@@ -22,6 +22,7 @@
 namespace score::mw::com::impl::lola
 {
 
+/// GTODO: Remove!!!
 /// \brief Helper class which identifies a slot in our "control slot array" using both the slot index and a raw pointer
 ///        to the element.
 /// \details We combine identification by the index of the slot and a (raw) pointer to the slot. Reasoning:

score/mw/com/impl/bindings/lola/event_data_control_composite.cpp

@@ -27,23 +27,22 @@ constexpr std::size_t MAX_MULTI_ALLOCATE_RETRY_COUNT{100U};
 // NOLINTNEXTLINE(cppcoreguidelines-pro-type-member-init): all members are initialized in the delegated constructor
 template <template <class> class AtomicIndirectorType>
 EventDataControlComposite<AtomicIndirectorType>::EventDataControlComposite(
-    SkeletonEventDataControlLocalView<>* const asil_qm_control_local,
+    SkeletonEventDataControlLocalView<>& asil_qm_control_local,
     ProxyEventDataControlLocalView<>* const proxy_control_local)
     : EventDataControlComposite{asil_qm_control_local, nullptr, proxy_control_local}
 {
 }
 
 template <template <class> class AtomicIndirectorType>
 EventDataControlComposite<AtomicIndirectorType>::EventDataControlComposite(
-    SkeletonEventDataControlLocalView<>* const asil_qm_control_local,
+    SkeletonEventDataControlLocalView<>& asil_qm_control_local,
     SkeletonEventDataControlLocalView<>* const asil_b_control_local,
     ProxyEventDataControlLocalView<>* const proxy_control_local)
     : asil_qm_control_local_{asil_qm_control_local},
       asil_b_control_local_{asil_b_control_local},
       proxy_control_local_{proxy_control_local},
       ignore_qm_control_{false}
 {
-    CheckForValidDataControls();
 }
 
 template <template <class> class AtomicIndirectorType>
@@ -82,7 +81,7 @@ auto EventDataControlComposite<AtomicIndirectorType>::GetNextFreeMultiSlot() con
     for (auto [current_index, it_slots_qm, it_slots_asil_b] = std::make_tuple(
              // coverity[autosar_cpp14_a5_2_2_violation]
              std::size_t{0U},
-             asil_qm_control_local_->state_slots_.begin(),
+             asil_qm_control_local_.get().state_slots_.begin(),
              asil_b_control_local_->state_slots_.begin());
          current_index != asil_b_control_local_->state_slots_.size();
          // coverity[autosar_cpp14_m6_5_5_violation]
@@ -116,10 +115,7 @@ auto EventDataControlComposite<AtomicIndirectorType>::GetNextFreeMultiSlot() con
     {
         return {possible_index.value(), *qm_slot_ptr, *asil_b_slot_ptr};
     }
-    else
-    {
-        return {};
-    }
+    return {};
 }
 
 template <template <class> class AtomicIndirectorType>
@@ -196,7 +192,7 @@ auto EventDataControlComposite<AtomicIndirectorType>::AllocateNextSlot() noexcep
 {
     if (asil_b_control_local_ == nullptr)
     {
-        auto qm_control_slot_indicator = asil_qm_control_local_->AllocateNextSlot();
+        auto qm_control_slot_indicator = asil_qm_control_local_.get().AllocateNextSlot();
         if (qm_control_slot_indicator.IsValid())
         {
             return {qm_control_slot_indicator.GetIndex(),
@@ -251,7 +247,7 @@ auto EventDataControlComposite<AtomicIndirectorType>::EventReady(ControlSlotComp
 
     if (!ignore_qm_control_)
     {
-        asil_qm_control_local_->EventReady({slot_indicator.GetIndex(), slot_indicator.GetSlotQM()}, time_stamp);
+        asil_qm_control_local_.get().EventReady({slot_indicator.GetIndex(), slot_indicator.GetSlotQM()}, time_stamp);
     }
 }
 
@@ -265,7 +261,7 @@ auto EventDataControlComposite<AtomicIndirectorType>::Discard(ControlSlotComposi
 
     if (!ignore_qm_control_)
     {
-        asil_qm_control_local_->Discard({slot_indicator.GetIndex(), slot_indicator.GetSlotQM()});
+        asil_qm_control_local_.get().Discard({slot_indicator.GetIndex(), slot_indicator.GetSlotQM()});
     }
 }
 
@@ -279,7 +275,7 @@ template <template <class> class AtomicIndirectorType>
 SkeletonEventDataControlLocalView<>& EventDataControlComposite<AtomicIndirectorType>::GetQmEventDataControlLocal()
     const noexcept
 {
-    return *asil_qm_control_local_;
+    return asil_qm_control_local_;
 }
 
 template <template <class> class AtomicIndirectorType>
@@ -290,7 +286,8 @@ EventDataControlComposite<AtomicIndirectorType>::GetAsilBEventDataControlLocal()
 }
 
 template <template <class> class AtomicIndirectorType>
-ProxyEventDataControlLocalView<>& EventDataControlComposite<AtomicIndirectorType>::GetProxyEventDataControlLocalView() noexcept
+ProxyEventDataControlLocalView<>&
+EventDataControlComposite<AtomicIndirectorType>::GetProxyEventDataControlLocalView() noexcept
 {
     SCORE_LANGUAGE_FUTURECPP_PRECONDITION_PRD(proxy_control_local_ != nullptr);
     return *proxy_control_local_;
@@ -308,21 +305,12 @@ EventSlotStatus::EventTimeStamp EventDataControlComposite<AtomicIndirectorType>:
     }
     else
     {
-        const EventSlotStatus event_slot_status{(*asil_qm_control_local_)[slot]};
+        const EventSlotStatus event_slot_status{asil_qm_control_local_.get()[slot]};
         const EventSlotStatus::EventTimeStamp sample_timestamp{event_slot_status.GetTimeStamp()};
         return sample_timestamp;
     }
 }
 
-template <template <class> class AtomicIndirectorType>
-void EventDataControlComposite<AtomicIndirectorType>::CheckForValidDataControls() const noexcept
-{
-    if (asil_qm_control_local_ == nullptr)
-    {
-        std::terminate();
-    }
-}
-
 template <template <class> class AtomicIndirectorType>
 // Suppress "AUTOSAR C++14 A15-5-3" rule findings. This rule states: "The std::terminate() function shall not be called
 // implicitly". std::terminate() is implicitly called from 'state_slots_[]' which might leds to a segmentation fault
@@ -332,17 +320,17 @@ template <template <class> class AtomicIndirectorType>
 EventSlotStatus::EventTimeStamp EventDataControlComposite<AtomicIndirectorType>::GetLatestTimestamp() const noexcept
 {
     EventSlotStatus::EventTimeStamp latest_time_stamp{1U};
-    SkeletonEventDataControlLocalView<>* control =
-        (asil_b_control_local_ != nullptr) ? asil_b_control_local_ : asil_qm_control_local_;
+    SkeletonEventDataControlLocalView<>& control =
+        (asil_b_control_local_ != nullptr) ? *asil_b_control_local_ : asil_qm_control_local_.get();
     for (SlotIndexType slot_index = 0U;
          // Suppress "AUTOSAR C++14 A4-7-1" rule finding. This rule states: "An integer expression shall not lead to
          // loss.". As the maximum number of slots is std::uint16_t, so there is no case for a data loss here.
          // coverity[autosar_cpp14_a4_7_1_violation]
-         slot_index < static_cast<SlotIndexType>(control->state_slots_.size());
+         slot_index < static_cast<SlotIndexType>(control.state_slots_.size());
          ++slot_index)
     {
-        SCORE_LANGUAGE_FUTURECPP_ASSERT_PRD(static_cast<std::size_t>(slot_index) < control->state_slots_.size());
-        const EventSlotStatus slot{control->state_slots_[slot_index].load(std::memory_order_acquire)};
+        SCORE_LANGUAGE_FUTURECPP_ASSERT_PRD(static_cast<std::size_t>(slot_index) < control.state_slots_.size());
+        const EventSlotStatus slot{control.state_slots_[slot_index].load(std::memory_order_acquire)};
         if (!slot.IsInvalid() && !slot.IsInWriting())
         {
             const auto slot_time_stamp = slot.GetTimeStamp();

score/mw/com/impl/bindings/lola/event_data_control_composite.h

@@ -15,14 +15,13 @@
 
 #include "score/mw/com/impl/bindings/lola/control_slot_composite_indicator.h"
 #include "score/mw/com/impl/bindings/lola/control_slot_types.h"
-#include "score/mw/com/impl/bindings/lola/event_data_control.h"
 #include "score/mw/com/impl/bindings/lola/event_slot_status.h"
 #include "score/mw/com/impl/bindings/lola/proxy_event_data_control_local_view.h"
 #include "score/mw/com/impl/bindings/lola/skeleton_event_data_control_local_view.h"
 
 #include "score/memory/shared/atomic_indirector.h"
 
-#include <optional>
+#include <functional>
 
 namespace score::mw::com::impl::lola
 {
@@ -47,11 +46,11 @@ class EventDataControlComposite
 
   public:
     /// \brief Constructs a composite which will only manage a single QM control (no ASIL use-case)
-    explicit EventDataControlComposite(SkeletonEventDataControlLocalView<>* const asil_qm_control_local,
+    explicit EventDataControlComposite(SkeletonEventDataControlLocalView<>& asil_qm_control_local,
                                        ProxyEventDataControlLocalView<>* const proxy_control_local);
 
     /// \brief Constructs a composite which will manage QM and ASIL control at the same time
-    explicit EventDataControlComposite(SkeletonEventDataControlLocalView<>* const asil_qm_control_local,
+    explicit EventDataControlComposite(SkeletonEventDataControlLocalView<>& asil_qm_control_local,
                                        SkeletonEventDataControlLocalView<>* const asil_b_control_local,
                                        ProxyEventDataControlLocalView<>* const proxy_control_local);
 
@@ -104,7 +103,7 @@ class EventDataControlComposite
     EventSlotStatus::EventTimeStamp GetLatestTimestamp() const noexcept;
 
   private:
-    SkeletonEventDataControlLocalView<>* asil_qm_control_local_;
+    std::reference_wrapper<SkeletonEventDataControlLocalView<>> asil_qm_control_local_;
     SkeletonEventDataControlLocalView<>* asil_b_control_local_;
 
     ProxyEventDataControlLocalView<>* proxy_control_local_;

score/mw/com/impl/bindings/lola/event_data_control_composite_test.cpp

@@ -107,7 +107,7 @@ class EventDataControlCompositeFixture : public ::testing::Test
         SCORE_LANGUAGE_FUTURECPP_ASSERT(skeleton_qm_local_.has_value());
 
         auto* const asil_control = skeleton_asil_local_.has_value() ? &skeleton_asil_local_.value() : nullptr;
-        unit_ = std::make_unique<EventDataControlComposite<>>(&skeleton_qm_local_.value(), asil_control, nullptr);
+        unit_ = std::make_unique<EventDataControlComposite<>>(skeleton_qm_local_.value(), asil_control, nullptr);
         return *this;
     }
 
@@ -120,7 +120,7 @@ class EventDataControlCompositeFixture : public ::testing::Test
 
         auto* const asil_control = skeleton_asil_local_.has_value() ? &skeleton_asil_local_.value() : nullptr;
         unit_mock_ = std::make_unique<EventDataControlComposite<memory::shared::AtomicIndirectorMock>>(
-            &skeleton_qm_local_.value(), asil_control, nullptr);
+            skeleton_qm_local_.value(), asil_control, nullptr);
 
         return *this;
     }
@@ -597,7 +597,7 @@ TEST(EventDataControlCompositeTest, DISABLED_fuzz)
     SkeletonEventDataControlLocalView skeleton_asil_local{asil};
     SkeletonEventDataControlLocalView skeleton_qm_local{qm};
 
-    EventDataControlComposite unit{&skeleton_qm_local, &skeleton_asil_local, nullptr};
+    EventDataControlComposite unit{skeleton_qm_local, &skeleton_asil_local, nullptr};
 
     std::mutex allocated_slots_mutex{};
     std::vector<ControlSlotCompositeIndicator> allocated_slots{};
@@ -765,7 +765,7 @@ TEST_F(EventDataControlCompositeFixture, GetProxyEventDataControlLocalView)
     EventDataControl qm{kMaxSlots, memory_, kMaxSubscribers};
     SkeletonEventDataControlLocalView<> skeleton_qm_local{qm};
     ProxyEventDataControlLocalView<> proxy_qm_local{qm};
-    EventDataControlComposite<> unit{&skeleton_qm_local, &proxy_qm_local};
+    EventDataControlComposite<> unit{skeleton_qm_local, &proxy_qm_local};
 
     // When getting the ASIL-B event data control
     auto& returned_proxy_qm_local = unit.GetProxyEventDataControlLocalView();
@@ -782,7 +782,7 @@ TEST_F(EventDataControlCompositeFixture, GetProxyEventDataControlLocalViewWithAs
     SkeletonEventDataControlLocalView<> skeleton_qm_local{qm};
     SkeletonEventDataControlLocalView<> skeleton_asil_b_local{asil_b};
     ProxyEventDataControlLocalView<> proxy_qm_local{qm};
-    EventDataControlComposite<> unit{&skeleton_qm_local, &skeleton_asil_b_local, &proxy_qm_local};
+    EventDataControlComposite<> unit{skeleton_qm_local, &skeleton_asil_b_local, &proxy_qm_local};
 
     // When getting the ASIL-B event data control
     auto& returned_proxy_qm_local = unit.GetProxyEventDataControlLocalView();
@@ -797,18 +797,13 @@ TEST_F(EventDataControlCompositeFixture,
     // Given an EventDataControlComposite constructed without a ProxyEventDataControlLocalView
     EventDataControl qm{kMaxSlots, memory_, kMaxSubscribers};
     SkeletonEventDataControlLocalView<> skeleton_qm_local{qm};
-    EventDataControlComposite<> unit{&skeleton_qm_local, nullptr};
+    EventDataControlComposite<> unit{skeleton_qm_local, nullptr};
 
     // When getting the ASIL-B event data control
     // Then the program terminates
     EXPECT_DEATH(score::cpp::ignore = unit.GetProxyEventDataControlLocalView(), ".*");
 }
 
-TEST(EventDataControlCompositeDeathTest, DiesOnConstructionWithNullptr)
-{
-    EXPECT_DEATH(EventDataControlComposite(nullptr, nullptr), ".*");
-}
-
 using EventDataControlCompositeGetTimestampFixture = EventDataControlCompositeFixture;
 TEST_F(EventDataControlCompositeGetTimestampFixture, CanAllocateOneSlot)
 {

score/mw/com/impl/bindings/lola/event_data_control_test_resources.cpp

@@ -32,7 +32,7 @@ void EventDataControlCompositeAttorney::PrepareAllocateNextSlot(
     // we want, that event_data_control_composite_ returns slot_index from call to AllocateNextSlot().
     // To achieve this, we set the reference-count of all slots but slot_index to a value > 0.
     EventSlotStatus::EventTimeStamp timestamp{1};
-    const auto number_states_slots = event_data_control_composite_.asil_qm_control_local_->state_slots_.size();
+    const auto number_states_slots = event_data_control_composite_.asil_qm_control_local_.get().state_slots_.size();
     for (std::size_t index{0}; index < number_states_slots; index++)
     {
         EventSlotStatus status{};
@@ -46,7 +46,7 @@ void EventDataControlCompositeAttorney::PrepareAllocateNextSlot(
         {
             status.SetReferenceCount(1U);
         }
-        event_data_control_composite_.asil_qm_control_local_->state_slots_[index].store(
+        event_data_control_composite_.asil_qm_control_local_.get().state_slots_[index].store(
             static_cast<EventSlotStatus::value_type>(status));
         if (event_data_control_composite_.asil_b_control_local_ != nullptr)
         {
@@ -64,7 +64,7 @@ void EventDataControlCompositeAttorney::SetQmControlDisconnected(const bool expe
 std::pair<EventSlotStatus, score::cpp::optional<EventSlotStatus>> EventDataControlCompositeAttorney::GetSlotStatus(
     const SlotIndexType slot_index) const noexcept
 {
-    return {EventSlotStatus(event_data_control_composite_.asil_qm_control_local_->state_slots_[slot_index]),
+    return {EventSlotStatus(event_data_control_composite_.asil_qm_control_local_.get().state_slots_[slot_index]),
             event_data_control_composite_.asil_b_control_local_ != nullptr
                 ? score::cpp::optional<EventSlotStatus>(
                       event_data_control_composite_.asil_b_control_local_->state_slots_[slot_index])

score/mw/com/impl/bindings/lola/sample_allocatee_ptr_test.cpp

@@ -41,7 +41,7 @@ class SampleAllocateePtrFixture : public ::testing::Test
     FakeMemoryResource memory_{};
     EventDataControl control_block_{kMaxSlots, memory_, kMaxSubscribers};
     SkeletonEventDataControlLocalView<> skeleton_event_data_control_local_{control_block_};
-    EventDataControlComposite<> control_composite_{&skeleton_event_data_control_local_, nullptr};
+    EventDataControlComposite<> control_composite_{skeleton_event_data_control_local_, nullptr, nullptr};
 };
 
 TEST_F(SampleAllocateePtrFixture, PtrContainingInvalidSlotIsNotDestroyingAnything)

score/mw/com/impl/bindings/lola/skeleton.h

@@ -418,14 +418,14 @@ auto Skeleton::OpenEventDataFromOpenedSharedMemory(const ElementFqId element_fq_
     // The "event_data_control_asil_b" and "typed_event_data_storage_ptr" are still valid lifetime even returned pointer
     // to internal state until Skeleton object is alive.
     // coverity[autosar_cpp14_a3_8_1_violation]
-    return {typed_event_data_storage_ptr,
-            // The lifetime of the "event_data_control_asil_b" object lasts as long as the Skeleton is alive.
-            // coverity[autosar_cpp14_m7_5_1_violation]
-            // coverity[autosar_cpp14_m7_5_2_violation]
-            // coverity[autosar_cpp14_a3_8_1_violation]
-            EventDataControlComposite{&event_control_qm_it->second.data_control,
-                                      event_data_control_asil_b_local,
-                                      proxy_event_data_control_local}};
+    return {
+        typed_event_data_storage_ptr,
+        // The lifetime of the "event_data_control_asil_b" object lasts as long as the Skeleton is alive.
+        // coverity[autosar_cpp14_m7_5_1_violation]
+        // coverity[autosar_cpp14_m7_5_2_violation]
+        // coverity[autosar_cpp14_a3_8_1_violation]
+        EventDataControlComposite{
+            event_control_qm_it->second.data_control, event_data_control_asil_b_local, proxy_event_data_control_local}};
 }
 
 template <typename SampleType>
@@ -500,7 +500,7 @@ auto Skeleton::CreateEventDataFromOpenedSharedMemory(const ElementFqId element_f
     // coverity[autosar_cpp14_m7_5_2_violation]
     // coverity[autosar_cpp14_a3_8_1_violation]
     return {typed_event_data_storage_ptr,
-            EventDataControlComposite{&skeleton_event_data_control_local_qm.get().data_control,
+            EventDataControlComposite{skeleton_event_data_control_local_qm.get().data_control,
                                       control_asil_local_result,
                                       proxy_event_data_control_local}};
 }

score/mw/com/impl/plumbing/sample_allocatee_ptr_test.cpp

@@ -52,7 +52,7 @@ class SampleAllocateePtrFixture : public ::testing::Test
     lola::FakeMemoryResource fake_memory_resource_{};
     lola::EventDataControl event_data_ctrl_qm_{0, fake_memory_resource_, 1U};
     lola::SkeletonEventDataControlLocalView<> skeleton_event_data_ctrl_qm_local_{event_data_ctrl_qm_};
-    lola::EventDataControlComposite<> event_data_ctrl_{&skeleton_event_data_ctrl_qm_local_, nullptr};
+    lola::EventDataControlComposite<> event_data_ctrl_{skeleton_event_data_ctrl_qm_local_, nullptr};
     lola::SlotIndexType event_data_slot_index_{std::numeric_limits<lola::SlotIndexType>::max()};
     lola::SampleAllocateePtr<std::uint8_t> lola_allocatee_ptr_{&value_, event_data_ctrl_, {}};
     SampleAllocateePtr<std::uint8_t> valid_unit_{MakeSampleAllocateePtr(std::move(lola_allocatee_ptr_))};
@@ -504,7 +504,7 @@ TEST_F(SampleAllocateePtrFixture, UnderlyingLolaPtrIsFreedOnDestruction)
     RecordProperty("DerivationTechnique", "Analysis of requirements");
 
     // Given a SampleAllocateePtr with an underlying lola SampleAllocateePtr
-    lola::EventDataControlComposite event_data_ctrl{&skeleton_event_data_ctrl_qm_local_, nullptr};
+    lola::EventDataControlComposite event_data_ctrl{skeleton_event_data_ctrl_qm_local_, nullptr};
 
     bool is_destructed{false};
     ObjectDestructionNotifier object_destruction_notifier(is_destructed);