fix: Use namespaced typenames/headers

FairRootGroup · Aug 11, 2022 · 12a85c6 · 12a85c6
1 parent 0959095
commit 12a85c6
Show file tree

Hide file tree

Showing 32 changed files with 114 additions and 116 deletions.
diff --git a/docs/Configuration.md b/docs/Configuration.md
@@ -16,11 +16,11 @@ Here is an overview of the device/channel options and when they are applied:
 
 | Property | Applied in |
 | --- | --- |
-| `severity` | immidiately (if `fair::mq::DeviceRunner` is used (also the case when using `<runFairMQDevice.h>`)) |
-| `file-severity` | immidiately (if `fair::mq::DeviceRunner` is used (also the case when using `<runFairMQDevice.h>`)) |
-| `verbosity` | immidiately (if `fair::mq::DeviceRunner` is used (also the case when using `<runFairMQDevice.h>`)) |
-| `color` | immidiately (if `fair::mq::DeviceRunner` is used (also the case when using `<runFairMQDevice.h>`)) |
-| `log-to-file` | immidiately (if `fair::mq::DeviceRunner` is used (also the case when using `<runFairMQDevice.h>`)) |
+| `severity` | immidiately (if `fair::mq::DeviceRunner` is used (also the case when using `<fairmq/runDevice.h>`)) |
+| `file-severity` | immidiately (if `fair::mq::DeviceRunner` is used (also the case when using `<fairmq/runDevice.h>`)) |
+| `verbosity` | immidiately (if `fair::mq::DeviceRunner` is used (also the case when using `<fairmq/runDevice.h>`)) |
+| `color` | immidiately (if `fair::mq::DeviceRunner` is used (also the case when using `<fairmq/runDevice.h>`)) |
+| `log-to-file` | immidiately (if `fair::mq::DeviceRunner` is used (also the case when using `<fairmq/runDevice.h>`)) |
 | `id` | at the end of `fair::mq::State::InitializingDevice` |
 | `io-threads` | at the end of `fair::mq::State::InitializingDevice` |
 | `transport` | at the end of `fair::mq::State::InitializingDevice` |

diff --git a/docs/Development.md b/docs/Development.md
@@ -6,7 +6,7 @@
 
 For unit testing it is often not feasible to boot up a full-blown distributed system with dozens of processes.
 
-In some scenarios it is useful to not even instantiate a `FairMQDevice` at all. Please see [this example](../test/protocols/_push_pull_multipart.cxx) for single and multi threaded unit test without a device instance. If you store your transport factories and channels on the heap, pls make sure, you destroy the channels before you destroy the related transport factory for proper shutdown. Channels provide all the `Send/Receive` and `New*Message/New*Poller` APIs provided by the device too.
+In some scenarios it is useful to not even instantiate a `fair::mq::Device` at all. Please see [this example](../test/protocols/_push_pull_multipart.cxx) for single and multi threaded unit test without a device instance. If you store your transport factories and channels on the heap, pls make sure, you destroy the channels before you destroy the related transport factory for proper shutdown. Channels provide all the `Send/Receive` and `New*Message/New*Poller` APIs provided by the device too.
 
 ## 4.2 Static Analysis
 

diff --git a/docs/Device.md b/docs/Device.md
@@ -2,7 +2,7 @@
 
 # 1. Device
 
-The components encapsulating the tasks are called **devices** and derive from the common base class `FairMQDevice`. FairMQ provides ready to use devices to organize the dataflow between the components (without touching the contents of a message), providing functionality like merging and splitting of the data stream (see subdirectory `devices`).
+The components encapsulating the tasks are called **devices** and derive from the common base class `fair::mq::Device`. FairMQ provides ready to use devices to organize the dataflow between the components (without touching the contents of a message), providing functionality like merging and splitting of the data stream (see subdirectory `devices`).
 
 ## 1.1 Topology
 

diff --git a/fairmq/DeviceRunner.h b/fairmq/DeviceRunner.h
@@ -45,7 +45,7 @@ namespace fair::mq
  * Each hook has access to all members of the DeviceRunner and really only differs by the point in
  * time it is called.
  *
- * For an example usage of this class see the fairmq/runFairMQDevice.h header.
+ * For an example usage of this class see the <fairmq/runDevice.h> header.
  */
 class DeviceRunner
 {

diff --git a/fairmq/MemoryResources.cxx b/fairmq/MemoryResources.cxx
@@ -1,18 +1,18 @@
 /********************************************************************************
- *    Copyright (C) 2018 CERN and copyright holders of ALICE O2 *
- *    Copyright (C) 2018 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH *
+ *    Copyright (C) 2018 CERN and copyright holders of ALICE O2                 *
+ * Copyright (C) 2018-2022 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH  *
  *                                                                              *
- *              This software is distributed under the terms of the *
- *              GNU Lesser General Public Licence (LGPL) version 3, *
- *                  copied verbatim in the file "LICENSE" *
+ *              This software is distributed under the terms of the             *
+ *              GNU Lesser General Public Licence (LGPL) version 3,             *
+ *                  copied verbatim in the file "LICENSE"                       *
  ********************************************************************************/
 
 /// @brief Memory allocators and interfaces related to managing memory via the
 /// trasport layer
 ///
 /// @author Mikolaj Krzewicki, mkrzewic@cern.ch
 
-#include <fairmq/FairMQTransportFactory.h>
+#include <fairmq/TransportFactory.h>
 #include <fairmq/MemoryResources.h>
 
 void *fair::mq::ChannelResource::do_allocate(std::size_t bytes, std::size_t alignment)

diff --git a/fairmq/ProgOptions.cxx b/fairmq/ProgOptions.cxx
@@ -1,5 +1,5 @@
 /********************************************************************************
- * Copyright (C) 2014-2018 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH  *
+ * Copyright (C) 2014-2022 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH  *
  *                                                                              *
  *              This software is distributed under the terms of the             *
  *              GNU Lesser General Public Licence (LGPL) version 3,             *
@@ -12,16 +12,15 @@
  * Created on March 11, 2015, 10:20 PM
  */
 
-#include "FairMQLogger.h"
 #include <fairmq/ProgOptions.h>
-
 #include <fairmq/tools/Strings.h>
 
 #include <boost/any.hpp>
 #include <boost/regex.hpp>
 
 #include <algorithm>
 #include <exception>
+#include <fairlogger/Logger.h>
 #include <iomanip>
 #include <iostream>
 #include <sstream>

diff --git a/fairmq/ofi/Context.cxx b/fairmq/ofi/Context.cxx
@@ -1,5 +1,5 @@
 /********************************************************************************
- * Copyright (C) 2018-2021 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH  *
+ * Copyright (C) 2018-2022 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH  *
  *                                                                              *
  *              This software is distributed under the terms of the             *
  *              GNU Lesser General Public Licence (LGPL) version 3,             *
@@ -24,8 +24,8 @@ namespace fair::mq::ofi
 
 using namespace std;
 
-Context::Context(FairMQTransportFactory& sendFactory,
-                 FairMQTransportFactory& receiveFactory,
+Context::Context(mq::TransportFactory& sendFactory,
+                 mq::TransportFactory& receiveFactory,
                  int numberIoThreads)
     : fIoWork(fIoContext)
     , fReceiveFactory(receiveFactory)

diff --git a/fairmq/ofi/Context.h b/fairmq/ofi/Context.h
@@ -51,8 +51,8 @@ struct Address {
 class Context
 {
   public:
-    Context(FairMQTransportFactory& sendFactory,
-            FairMQTransportFactory& receiveFactory,
+    Context(mq::TransportFactory& sendFactory,
+            mq::TransportFactory& receiveFactory,
             int numberIoThreads = 1);
     Context(const Context&) = delete;
     Context(Context&&) = delete;
@@ -78,8 +78,8 @@ class Context
     asio::io_context fIoContext;
     asio::io_context::work fIoWork;
     std::vector<std::thread> fThreadPool;
-    FairMQTransportFactory& fReceiveFactory;
-    FairMQTransportFactory& fSendFactory;
+    mq::TransportFactory& fReceiveFactory;
+    mq::TransportFactory& fSendFactory;
     size_t fSizeHint;
 
     auto InitThreadPool(int numberIoThreads) -> void;

diff --git a/fairmq/ofi/Message.cxx b/fairmq/ofi/Message.cxx
@@ -1,5 +1,5 @@
 /********************************************************************************
- * Copyright (C) 2018-2021 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH  *
+ * Copyright (C) 2018-2022 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH  *
  *                                                                              *
  *              This software is distributed under the terms of the             *
  *              GNU Lesser General Public Licence (LGPL) version 3,             *
@@ -69,7 +69,7 @@ Message::Message(pmr::memory_resource* pmr, const size_t size, Alignment /* alig
 Message::Message(pmr::memory_resource* pmr,
                  void* data,
                  const size_t size,
-                 fairmq_free_fn* ffn,
+                 FreeFn* ffn,
                  void* hint)
     : fInitialSize(size)
     , fSize(size)
@@ -137,7 +137,7 @@ auto Message::Rebuild(size_t size, Alignment /* alignment */) -> void
     Rebuild(size);
 }
 
-auto Message::Rebuild(void* /*data*/, size_t size, fairmq_free_fn* ffn, void* hint) -> void
+auto Message::Rebuild(void* /*data*/, size_t size, FreeFn* ffn, void* hint) -> void
 {
     if (fFreeFunction) {
       fFreeFunction(fData, fHint);

diff --git a/fairmq/ofi/Message.h b/fairmq/ofi/Message.h
@@ -1,5 +1,5 @@
 /********************************************************************************
- * Copyright (C) 2018-2021 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH  *
+ * Copyright (C) 2018-2022 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH  *
  *                                                                              *
  *              This software is distributed under the terms of the             *
  *              GNU Lesser General Public Licence (LGPL) version 3,             *
@@ -37,7 +37,7 @@ class Message final : public fair::mq::Message
     Message(std::pmr::memory_resource* pmr,
             void* data,
             size_t size,
-            fairmq_free_fn* ffn,
+            FreeFn* ffn,
             void* hint = nullptr);
     Message(std::pmr::memory_resource* pmr,
             fair::mq::UnmanagedRegionPtr& region,
@@ -54,7 +54,7 @@ class Message final : public fair::mq::Message
     auto Rebuild(Alignment alignment) -> void override;
     auto Rebuild(size_t size) -> void override;
     auto Rebuild(size_t size, Alignment alignment) -> void override;
-    auto Rebuild(void* data, size_t size, fairmq_free_fn* ffn, void* hint = nullptr) -> void override;
+    auto Rebuild(void* data, size_t size, FreeFn* ffn, void* hint = nullptr) -> void override;
 
     auto GetData() const -> void* override;
     auto GetSize() const -> size_t override;
@@ -71,7 +71,7 @@ class Message final : public fair::mq::Message
     size_t fInitialSize;
     size_t fSize;
     void* fData;
-    fairmq_free_fn* fFreeFunction;
+    FreeFn* fFreeFunction;
     void* fHint;
     std::pmr::memory_resource* fPmr;
 }; /* class Message */

diff --git a/fairmq/ofi/Socket.cxx b/fairmq/ofi/Socket.cxx
@@ -1,5 +1,5 @@
 /********************************************************************************
- * Copyright (C) 2018-2021 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH  *
+ * Copyright (C) 2018-2022 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH  *
  *                                                                              *
  *              This software is distributed under the terms of the             *
  *              GNU Lesser General Public Licence (LGPL) version 3,             *
@@ -100,7 +100,7 @@ try {
 // TODO catch the correct ofi error
 catch (const SilentSocketError& e)
 {
-    // do not print error in this case, this is handled by FairMQDevice
+    // do not print error in this case, this is handled by fair::mq::Device
     // in case no connection could be established after trying a number of random ports from a range.
     return false;
 }
@@ -189,7 +189,7 @@ try {
 }
 catch (const SilentSocketError& e)
 {
-    // do not print error in this case, this is handled by FairMQDevice
+    // do not print error in this case, this is handled by fair::mq::Device
     return false;
 }
 catch (const std::exception& e)

diff --git a/fairmq/ofi/Socket.h b/fairmq/ofi/Socket.h
@@ -1,5 +1,5 @@
 /********************************************************************************
- * Copyright (C) 2018-2021 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH  *
+ * Copyright (C) 2018-2022 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH  *
  *                                                                              *
  *              This software is distributed under the terms of the             *
  *              GNU Lesser General Public Licence (LGPL) version 3,             *
@@ -9,8 +9,8 @@
 #ifndef FAIR_MQ_OFI_SOCKET_H
 #define FAIR_MQ_OFI_SOCKET_H
 
-#include <FairMQSocket.h>
-#include <FairMQMessage.h>
+#include <fairmq/Message.h>
+#include <fairmq/Socket.h>
 #include <fairmq/ofi/Context.h>
 #include <fairmq/ofi/ControlMessages.h>
 

diff --git a/fairmq/ofi/TransportFactory.h b/fairmq/ofi/TransportFactory.h
@@ -1,5 +1,5 @@
 /********************************************************************************
- * Copyright (C) 2018-2021 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH  *
+ * Copyright (C) 2018-2022 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH  *
  *                                                                              *
  *              This software is distributed under the terms of the             *
  *              GNU Lesser General Public Licence (LGPL) version 3,             *
@@ -23,7 +23,6 @@
 #include <fairmq/ofi/Context.h>
 #include <fairmq/ofi/Message.h>
 #include <fairmq/ofi/Socket.h>
-#include <fairmq/ofi/TransportFactory.h>
 #include <memory>
 #include <stdexcept>
 #include <string>
@@ -84,7 +83,7 @@ struct TransportFactory final : mq::TransportFactory
         return std::make_unique<Message>(&fMemoryResource, size);
     }
 
-    auto CreateMessage(void* data, std::size_t size, fairmq_free_fn* ffn, void* hint = nullptr)
+    auto CreateMessage(void* data, std::size_t size, FreeFn* ffn, void* hint = nullptr)
         -> std::unique_ptr<mq::Message> override
     {
         return std::make_unique<Message>(&fMemoryResource, data, size, ffn, hint);
@@ -117,7 +116,7 @@ struct TransportFactory final : mq::TransportFactory
     }
 
     auto CreatePoller(
-        std::unordered_map<std::string, std::vector<FairMQChannel>> const& /*channelsMap*/,
+        std::unordered_map<std::string, std::vector<Channel>> const& /*channelsMap*/,
         std::vector<std::string> const& /*channelList*/) const
         -> std::unique_ptr<mq::Poller> override
     {

diff --git a/fairmq/runDevice.h b/fairmq/runDevice.h
@@ -1,5 +1,5 @@
 /********************************************************************************
- * Copyright (C) 2017-2021 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH  *
+ * Copyright (C) 2017-2022 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH  *
  *                                                                              *
  *              This software is distributed under the terms of the             *
  *              GNU Lesser General Public Licence (LGPL) version 3,             *
@@ -10,7 +10,7 @@
 #include <boost/program_options.hpp>
 #include <memory>
 
-// to be implemented by the user to return a child class of FairMQDevice
+// to be implemented by the user to return a child class of fair::mq::Device
 std::unique_ptr<fair::mq::Device> getDevice(fair::mq::ProgOptions& config);
 
 // to be implemented by the user to add custom command line options (or just with empty body)

diff --git a/fairmq/runFairMQDevice.h b/fairmq/runFairMQDevice.h
@@ -1,5 +1,5 @@
 /********************************************************************************
- *    Copyright (C) 2017 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH    *
+ * Copyright (C) 2017-2022 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH  *
  *                                                                              *
  *              This software is distributed under the terms of the             *
  *              GNU Lesser General Public Licence (LGPL) version 3,             *
@@ -13,7 +13,7 @@
 
 using FairMQDevicePtr = fair::mq::Device*;
 
-// to be implemented by the user to return a child class of FairMQDevice
+// to be implemented by the user to return a child class of fair::mq::Device
 FairMQDevicePtr getDevice(const fair::mq::ProgOptions& config);
 
 // to be implemented by the user to add custom command line options (or just with empty body)

diff --git a/test/device/TestReceiver.h b/test/device/TestReceiver.h
@@ -1,5 +1,5 @@
 /********************************************************************************
- * Copyright (C) 2015-2017 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH  *
+ * Copyright (C) 2015-2022 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH  *
  *                                                                              *
  *              This software is distributed under the terms of the             *
  *              GNU Lesser General Public Licence (LGPL) version 3,             *
@@ -18,7 +18,7 @@
 namespace fair::mq::test
 {
 
-class Receiver : public FairMQDevice
+class Receiver : public Device
 {
   public:
     Receiver(const std::string& channelName)
@@ -33,7 +33,7 @@ class Receiver : public FairMQDevice
 
     auto Run() -> void override
     {
-        auto msg = FairMQMessagePtr{NewMessage()};
+        auto msg = NewMessage();
         if (Receive(msg, fChannelName) >= 0) {
             LOG(info) << "received empty message";
         } else {

diff --git a/test/device/TestSender.h b/test/device/TestSender.h
@@ -1,5 +1,5 @@
 /********************************************************************************
- * Copyright (C) 2015-2017 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH  *
+ * Copyright (C) 2015-2022 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH  *
  *                                                                              *
  *              This software is distributed under the terms of the             *
  *              GNU Lesser General Public Licence (LGPL) version 3,             *
@@ -18,7 +18,7 @@
 namespace fair::mq::test
 {
 
-class Sender : public FairMQDevice
+class Sender : public Device
 {
   public:
     Sender(const std::string& channelName)
@@ -33,7 +33,7 @@ class Sender : public FairMQDevice
 
     auto Run() -> void override
     {
-        auto msg = FairMQMessagePtr{NewMessage()};
+        auto msg = NewMessage();
         if (Send(msg, fChannelName) >= 0) {
             LOG(info) << "sent empty message";
         } else {

diff --git a/test/device/_version.cxx b/test/device/_version.cxx
@@ -1,5 +1,5 @@
 /********************************************************************************
- * Copyright (C) 2014-2018 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH  *
+ * Copyright (C) 2014-2022 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH  *
  *                                                                              *
  *              This software is distributed under the terms of the             *
  *              GNU Lesser General Public Licence (LGPL) version 3,             *
@@ -20,11 +20,11 @@ namespace
 
 using namespace std;
 
-class TestVersion : public FairMQDevice
+class TestVersion : public fair::mq::Device
 {
   public:
     TestVersion(fair::mq::tools::Version version)
-        : FairMQDevice(version)
+        : fair::mq::Device(version)
     {}
 };
 

diff --git a/test/helper/devices/TestErrorState.h b/test/helper/devices/TestErrorState.h
@@ -1,5 +1,5 @@
 /********************************************************************************
- *   Copyright (C) 2018 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH     *
+ * Copyright (C) 2018-2022 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH  *
  *                                                                              *
  *              This software is distributed under the terms of the             *
  *              GNU Lesser General Public Licence (LGPL) version 3,             *
@@ -17,7 +17,7 @@
 namespace fair::mq::test
 {
 
-class ErrorState : public FairMQDevice
+class ErrorState : public Device
 {
   public:
     void Init() override