testSharedDummyBackendUnified.cpp

Go to the documentation of this file.

// SPDX-FileCopyrightText: Deutsches Elektronen-Synchrotron DESY, MSK, ChimeraTK Project <chimeratk-support@desy.de>
// SPDX-License-Identifier: LGPL-3.0-or-later
 
#define BOOST_TEST_DYN_LINK
// Define a name for the test module.
#define BOOST_TEST_MODULE SharedDummyBackendUnified
// Only after defining the name include the unit test header.
#include <boost/test/unit_test.hpp>
using namespace boost::unit_test_framework;
 
#include "BackendFactory.h"
#include "DummyBackend.h"
#include "SharedDummyBackend.h"
#include "sharedDummyHelpers.h"
#include "UnifiedBackendTest.h"
 
using namespace ChimeraTK;
 
// Create a test suite which holds all your tests.
BOOST_AUTO_TEST_SUITE(SharedDummyBackendUnifiedTestSuite)
 
/**********************************************************************************************************************/
 
//  Use hardcoded information from the dmap-file
static std::string instanceId{"1"};
static std::string mapFileName{"sharedDummyUnified.map"};
static std::size_t instanceIdHash = Utilities::shmDummyInstanceIdHash(instanceId, {{"map", mapFileName}});
static std::string shmName{Utilities::createShmName(instanceIdHash, mapFileName, getUserName())};
 
static std::string cdd(std::string("(sharedMemoryDummy:") + instanceId + "?map=" + mapFileName + ")");
static boost::shared_ptr<SharedDummyBackend> sharedDummy;
const int timeOutForWaitOnHelperProcess_ms = 20000;
 
// lock preventing concurrent test execution
static TestLocker testLocker("sharedDummyUnified.dmap");
 
// use static instance with destructor to stop background application after all tests
struct HelperProcess {
  HelperProcess() {
    // set up sharedDummy as communication interface to background process
    sharedDummy = boost::dynamic_pointer_cast<SharedDummyBackend>(BackendFactory::getInstance().createBackend(cdd));
    sharedDummy->open();
    mirrorRequest.type = sharedDummy->getRegisterAccessor<uint32_t>("MIRRORREQUEST/TYPE", 1, 0, AccessModeFlags{});
    mirrorRequest.busy = sharedDummy->getRegisterAccessor<uint32_t>("MIRRORREQUEST/BUSY", 1, 0, AccessModeFlags{});
    // TODO debug - it seems this register causes clean-up to fail
    //  Potentially because there is still a reference in the TransferGroup in the asyncInterruptDispatcher, causing a
    //  circular reference to the device shared pointer
    mirrorRequest.updated = sharedDummy->getRegisterAccessor<uint32_t>(
        "MIRRORREQUEST/UPDATED", 1, 0, AccessModeFlags{AccessMode::wait_for_new_data});
    mirrorRequest.triggerInterrupt =
        sharedDummy->getRegisterAccessor<uint32_t>("MIRRORREQUEST/DATA_INTERRUPT", 1, 0, {});
  }
 
  struct {
    boost::shared_ptr<NDRegisterAccessor<uint32_t>> type;
    boost::shared_ptr<NDRegisterAccessor<uint32_t>> busy;
    boost::shared_ptr<NDRegisterAccessor<uint32_t>> updated;
    boost::shared_ptr<NDRegisterAccessor<uint32_t>> triggerInterrupt;
  } mirrorRequest;
 
  void requestMirroring(MirrorRequestType reqType, bool triggerDataInterrupt = false) const {
    sharedDummy->open();
    // trigger mirror operation by helper thread and wait on completion
    mirrorRequest.triggerInterrupt->accessData(0) = triggerDataInterrupt ? 1 : 0;
    mirrorRequest.triggerInterrupt->write();
    mirrorRequest.type->accessData(0) = (int)reqType;
    mirrorRequest.type->write();
    mirrorRequest.busy->accessData(0) = 1;
    mirrorRequest.busy->write();
    int timeoutCnt = timeOutForWaitOnHelperProcess_ms / 50;
    do {
      // we use boost::sleep because it defines an interruption point for signals
      boost::this_thread::sleep_for(boost::chrono::milliseconds(50));
      mirrorRequest.busy->readLatest();
    } while(mirrorRequest.busy->accessData(0) == 1 && (--timeoutCnt >= 0));
    BOOST_CHECK(timeoutCnt >= 0);
  }
 
  static void start() {
    // start second accessing application in background
    BOOST_CHECK(!std::system("./testSharedDummyBackendUnifiedExt "
                             "--run_test=SharedDummyBackendUnifiedTestSuite/testRegisterAccessor > /dev/null"
                             " & echo $! > ./testSharedDummyBackendUnifiedExt.pid"));
    // check that the helper application is running
    boost::this_thread::sleep_for(boost::chrono::milliseconds(100));
    BOOST_REQUIRE_MESSAGE(std::system("ps $(cat testSharedDummyBackendUnifiedExt.pid) > /dev/null") == 0,
        "FATAL: background application \'testSharedDummyBackendUnifiedExt\' not running!");
  }
  // request helper to stop gracefully - this includes a handshake waiting on it's termination
  void stopGracefully() const { requestMirroring(MirrorRequestType::stop); }
  static void kill() {
    auto ret = std::system("pidfile=./testSharedDummyBackendUnifiedExt.pid; if [ -f $pidfile ]; "
                           "then kill $(cat $pidfile); rm $pidfile; fi ");
    if(ret == -1) {
      throw std::runtime_error("Attempt to kill helper process failed.");
    }
  }
  // discard all accessors. do not use after this point
  void reset() {
    mirrorRequest.type.reset();
    mirrorRequest.busy.reset();
    mirrorRequest.updated.reset();
    mirrorRequest.triggerInterrupt.reset();
  }
  ~HelperProcess() {
    try {
      kill();
    }
    catch(std::exception& e) {
      // Try-catch to make the linter happy. We in the process of killing a global instance, so at the end of the test, anyway.
      std::cerr << "Caught exception when killing helper process: " << e.what() << std::endl;
    }
  }
} gHelperProcess;
 
/**********************************************************************************************************************/
 
template<typename Derived>
struct IntegersBase {
  Derived* derived{static_cast<Derived*>(this)};
  ChimeraTK::AccessModeFlags supportedFlags() { return {ChimeraTK::AccessMode::raw}; }
  size_t nChannels() { return 1; }
  size_t nElementsPerChannel() { return 1; }
  size_t writeQueueLength() { return std::numeric_limits<size_t>::max(); }
  size_t nRuntimeErrorCases() { return 0; }
  using minimumUserType = int32_t;
  using rawUserType = minimumUserType;
 
  static constexpr auto capabilities = TestCapabilities<>()
                                           .disableForceDataLossWrite()
                                           .disableSwitchReadOnly()
                                           .disableSwitchWriteOnly()
                                           .disableTestWriteNeverLosesData()
                                           .disableAsyncReadInconsistency()
                                           .enableTestRawTransfer();
 
  boost::shared_ptr<NDRegisterAccessor<minimumUserType>> acc{
      sharedDummy->getRegisterAccessor<minimumUserType>(derived->path(), 1, 0, AccessModeFlags{})};
  boost::shared_ptr<NDRegisterAccessor<rawUserType>> accBackdoor{sharedDummy->getRegisterAccessor<rawUserType>(
      std::string("MIRRORED/") + derived->path(true), 1, 0, {AccessMode::raw})};
 
  void ensureOpen() {
    // since the front-door and back-door access goes over the same SharedDummyBackend instance, the spec tests
    // unintentionally also close our back-door and we need to make sure it's open again.
    sharedDummy->open();
  }
 
  // Type can be raw type or user type
  template<typename Type>
  std::vector<std::vector<Type>> generateValue(bool raw = false) {
    ensureOpen();
    accBackdoor->readLatest();
    rawUserType rawVal00 = accBackdoor->accessData(0);
    rawVal00 += 3;
    Type val00 = (raw ? rawVal00 : derived->template rawToCooked<Type, rawUserType>(rawVal00));
    return {{val00}};
  }
 
  // Type can be raw type or user type
  template<typename Type>
  std::vector<std::vector<Type>> getRemoteValue(bool raw = false) {
    ensureOpen();
    gHelperProcess.requestMirroring(MirrorRequestType::from);
    accBackdoor->readLatest();
    rawUserType rawVal00 = accBackdoor->accessData(0);
    Type val00 = (raw ? rawVal00 : derived->template rawToCooked<Type, rawUserType>(rawVal00));
 
    return {{val00}};
  }
 
  void setRemoteValue() {
    ensureOpen();
    auto x = generateValue<rawUserType>(/* raw = */ true)[0][0];
    accBackdoor->accessData(0) = x;
    accBackdoor->write();
    gHelperProcess.requestMirroring(MirrorRequestType::to);
  }
 
  // default implementation just casting. Re-implement in derived classes if needed.
  template<typename UserType, typename RawType>
  RawType cookedToRaw(UserType val) {
    return static_cast<RawType>(val);
  }
 
  // default implementation just casting. Re-implement in derived classes if needed.
  template<typename UserType, typename RawType>
  UserType rawToCooked(RawType val) {
    return static_cast<UserType>(val);
  }
 
  // we need this because it's expected in template, but unused
  void setForceRuntimeError(bool /*enable*/, size_t) {}
};
 
struct IntegersSigned32 : public IntegersBase<IntegersSigned32> {
  static std::string path([[maybe_unused]] bool mirrored = false) { return "INTC_RW"; }
  static bool isWriteable() { return true; }
  static bool isReadable() { return true; }
};
struct IntegersSigned32RO : public IntegersBase<IntegersSigned32RO> {
  static std::string path([[maybe_unused]] bool mirrored = false) { return "INTA_RO"; }
  static bool isWriteable() { return false; }
  static bool isReadable() { return true; }
};
struct IntegersSigned32WO : public IntegersBase<IntegersSigned32WO> {
  static std::string path([[maybe_unused]] bool mirrored = false) { return "INTB_WO"; }
  static bool isWriteable() { return true; }
  static bool isReadable() { return false; }
};
struct IntegersSigned32DummyWritable : public IntegersBase<IntegersSigned32DummyWritable> {
  static std::string path(bool mirrored = false) { return !mirrored ? "INTA_RO/DUMMY_WRITEABLE" : "INTA_RO"; }
  static bool isWriteable() { return true; }
  static bool isReadable() { return true; }
};
 
struct IntegersSigned32Async : public IntegersBase<IntegersSigned32Async> {
  static int value;
  static std::string path([[maybe_unused]] bool mirrored = false) { return "INTD_ASYNC"; }
  static bool isWriteable() { return false; }
  static bool isReadable() { return true; }
  static ChimeraTK::AccessModeFlags supportedFlags() {
    return {ChimeraTK::AccessMode::raw, ChimeraTK::AccessMode::wait_for_new_data};
  }
 
  template<typename UserType>
  std::vector<std::vector<UserType>> generateValue(bool = false) {
    return {{++value}};
  }
 
  void setRemoteValue() {
    ensureOpen();
    auto x = generateValue<minimumUserType>()[0][0];
    accBackdoor->accessData(0) = x;
    accBackdoor->write();
    gHelperProcess.requestMirroring(MirrorRequestType::to, true);
  }
};
 
int IntegersSigned32Async::value = 12;
 
/**********************************************************************************************************************/
 
BOOST_AUTO_TEST_CASE(TestRegisterAccessor) {
  SharedDummyBackendUnifiedTestSuite::HelperProcess::start();
 
  std::cout << "*** testRegisterAccessor *** " << std::endl;
  ChimeraTK::UnifiedBackendTest<>()
      .addRegister<IntegersSigned32>()
      .addRegister<IntegersSigned32RO>()
      .addRegister<IntegersSigned32WO>()
      .addRegister<IntegersSigned32DummyWritable>()
      .addRegister<IntegersSigned32Async>()
      .runTests(cdd);
 
  SharedDummyBackendUnifiedTestSuite::HelperProcess::kill();
}
 
BOOST_AUTO_TEST_CASE(TestVerifyMemoryDeleted) {
  SharedDummyBackendUnifiedTestSuite::HelperProcess::start();
  gHelperProcess.stopGracefully();
  gHelperProcess.reset();
 
  // also clear our backend instance. This should also remove allocated SHM segments and semaphores
  // - note, this only works if the global instance map uses weak pointers
  sharedDummy.reset();
 
  // Check that memory is removed
  bool shm_removed{false};
  for(size_t n = 0; n < 30; ++n) {
    shm_removed = !shm_exists(shmName);
    if(shm_removed) {
      break;
    }
    sleep(1);
  }
  BOOST_CHECK(shm_removed);
}
 
BOOST_AUTO_TEST_SUITE_END()