✨ Add MID DCS Processor by sharing (most of) source code with MCH.

Given that both MCH and MID share most of their DCS -> CCDB workflow,
the initial MCH-only code has been moved to a new MUON/Common
subdirectory, and the few differences between MCH and MID are handled
at compile time using compilation definition (`-DMUON_SUBSYSTEM_MCH`
or `-DMUON_SUBSYSTEM_MID`), so both subsystems share the source code (for
the dcs processor itself and the little dcs-ccdb program used to quickly
inspect what is in the CCDB for that subsystem).

From that single source code we do generate different executables :

- o2-calibration-mch-dcs-processor-workflow
- o2-calibration-mid-dcs-processor-workflow
- o2-mch-dcs-ccdb
- o2-mid-dcs-ccdb

so that each subsystem can be used completely independently.

Note that for testing there are also `o2-calibration-[mid|mch]-dcs-sim-workflow`
executables. Those executables do not share their source code as they
are merely creating aliases, which _are_ different for both subsystems.

Author: aphecetche

Detectors/MUON/CMakeLists.txt

@@ -8,5 +8,6 @@
 # granted to it by virtue of its status as an Intergovernmental Organization or
 # submit itself to any jurisdiction.
 
+add_subdirectory(Common)
 add_subdirectory(MCH)
 add_subdirectory(MID)

Detectors/MUON/Common/CMakeLists.txt

@@ -0,0 +1,34 @@
+# Copyright CERN and copyright holders of ALICE O2. This software is distributed
+# under the terms of the GNU General Public License v3 (GPL Version 3), copied
+# verbatim in the file "COPYING".
+#
+# See http://alice-o2.web.cern.ch/license for full licensing information.
+#
+# In applying this license CERN does not waive the privileges and immunities
+# granted to it by virtue of its status as an Intergovernmental Organization or
+# submit itself to any jurisdiction.
+
+set(subsystems "mch;mid")
+
+foreach(det IN LISTS subsystems)
+  string(TOUPPER ${det} DET)
+  o2_add_executable(dcs-ccdb
+                    COMPONENT_NAME ${det}
+                    SOURCES src/dcs-ccdb.cxx
+                    PUBLIC_LINK_LIBRARIES O2::Framework O2::DetectorsDCS O2::CCDB O2::${DET}Conditions
+                    TARGETVARNAME exe-dcs-ccdb)
+  target_compile_definitions(${exe-dcs-ccdb} PRIVATE "MUON_SUBSYSTEM_${DET}")
+
+  o2_add_executable(${det}-dcs-processor-workflow
+                    COMPONENT_NAME calibration
+                    SOURCES src/dcs-processor-workflow.cxx
+                    PUBLIC_LINK_LIBRARIES O2::Framework O2::DetectorsDCS O2::${DET}Conditions
+                    TARGETVARNAME exe-dcs-processor-workflow)
+  target_compile_definitions(${exe-dcs-processor-workflow} PRIVATE "MUON_SUBSYSTEM_${DET}")
+
+  o2_add_executable(${det}-dcs-sim-workflow
+                    COMPONENT_NAME calibration
+                    SOURCES src/${det}-dcs-sim-workflow.cxx
+                    PUBLIC_LINK_LIBRARIES O2::DCStestWorkflow O2::${DET}Conditions)
+endforeach()
+

Detectors/MUON/Common/README.md

@@ -0,0 +1,82 @@
+<!-- doxy
+\page refDetectorsMUONCommon Common
+/doxy -->
+
+# Common code for MID and MCH
+
+For the moment the only commonality stems from the DCS to CCDB part, as
+both subsystems only transmit DCS datapoints to CCDB, without any particular
+treatment. So we use almost the same source code, but generate separate
+executables, e.g. to ease the integration with `dcs-proxy`-based workflows.
+
+Note that MCH transmit both the HV and LV values to CCDB, while MID only
+transmit HV values.
+
+## DCS to CCDB
+
+To test the DCS to CCDB route you can use the following 3 parts worfklow pipeline : 
+
+```shell
+o2-calibration-mch-dcs-sim-workflow --max-timeframes 600 --max-cycles-no-full-map 10 -b | \
+o2-calibration-mch-dcs-processor-workflow --hv-max-size 0 --hv-max-duration 300 --lv-max-size 0 --lv-max-duration 300 -b | \
+o2-calibration-ccdb-populator-workflow --ccdb-path="http://localhost:6464" -b
+```
+
+```shell
+o2-calibration-mid-dcs-sim-workflow --max-timeframes 600 --max-cycles-no-full-map 10 -b | \
+o2-calibration-mid-dcs-processor-workflow --hv-max-size 0 --hv-max-duration 300 -b | \
+o2-calibration-ccdb-populator-workflow --ccdb-path="http://localhost:6464" -b
+```
+
+Note that the only difference (besides the mid vs mch naming) is the set of 
+ options of the `processor` device (handling just hv for mid and hv+lv for mch).
+ 
+- `o2-calibration-[mch|mid]-dcs-sim-worfklow` is just generating fake random MCH or MID DCS data points, 
+- `o2-calibration-[mch|mid]-dcs-processor-workflow` gathers the received data points into a container object 
+- `o2-calibration-ccdb-populator-workflow` uploads the container object to the CCDB (in this example a local dev ccdb).
+
+ The container object that groups the datapoints is considered ready to be shipped either when the data points span a long enough duration (see the `--xxx-max-duration` option(s) of the `o2-calibration-[mch|mid]-dcs-processor-workflow`) or is big enough (see the `--xxx-max-size`  option(s)).
+
+## MCH DCS Data Points
+
+### HV
+
+The MCH high voltage (HV) system is composed of 188 channels :
+
+- 48 channels for stations 1 and 2 (3 HV channel per quadrant x 16 quadrants)
+- 140 channels for stations 3, 4, 5 (1 HV channel per slat x 140 slats)
+
+### LV
+
+The MCH low voltage (LV) system is composed of 328 channels :
+
+- 216 channels (108 x 2 different voltage values) to power up the front-end
+  electronics (dualsampas)
+- 112 channels to power up the readout crates hosting the solar (readout) cards
+
+## MID DCS Data Points
+
+### HV
+
+The MID high voltage (HV) system is composed of 72 channels, one channel per RPC.
+
+## CCDB quick check
+
+Besides the web browsing of the CCDB, another quick check can be performed with 
+ the `o2-[mch|mid]-dcs-ccdb` program to dump the DCS datapoints (hv, lv, or both) or 
+ the datapoint config valid at a given timestamp.
+
+```
+$ o2-mch-dcs-ccdb --help
+$ o2-mch-dcs-ccdb --ccdb http://localhost:6464 --query hv --query lv --query dpconf
+$ o2-mid-dcs-ccdb --ccdb http://localhost:6464 --query hv --query dpconf
+```
+
+The same programs can be used to upload to CCDB the DCS data point configuration
+ for the dcs-proxy : 
+
+```
+$ o2-mch-dcs-ccdb --put-datapoint-config --ccdb http://localhost:8080
+$ o2-mid-dcs-ccdb --put-datapoint-config --ccdb http://localhost:8080
+```
+

…ors/MUON/MCH/Conditions/src/dcs-ccdb.cxx Detectors/MUON/Common/src/dcs-ccdb.cxxDetectors/MUON/MCH/Conditions/src/dcs-ccdb.cxx renamed to Detectors/MUON/Common/src/dcs-ccdb.cxx Detectors/MUON/MCH/Conditions/src/dcs-ccdb.cxx renamed to Detectors/MUON/Common/src/dcs-ccdb.cxx

@@ -11,7 +11,11 @@
 #include "CCDB/CcdbApi.h"
 #include "DetectorsDCS/DataPointIdentifier.h"
 #include "DetectorsDCS/DataPointValue.h"
+#if defined(MUON_SUBSYSTEM_MCH)
 #include "MCHConditions/DCSNamer.h"
+#elif defined(MUON_SUBSYSTEM_MID)
+#include "MIDConditions/DCSNamer.h"
+#endif
 #include <boost/program_options.hpp>
 #include <ctime>
 #include <iostream>
@@ -21,24 +25,28 @@
 #include <string>
 #include <unordered_map>
 #include <vector>
+#include "subsysname.h"
 
 namespace po = boost::program_options;
 using DPID = o2::dcs::DataPointIdentifier;
 using DPVAL = o2::dcs::DataPointValue;
 using DPMAP = std::unordered_map<DPID, std::vector<DPVAL>>;
 
-const char* CCDB_DPCONF_NAME = "MCH/DCSconfig";
+std::string CcdbDpConfName()
+{
+  return fmt::format("{}/DCSconfig", o2::muon::subsysname());
+}
 
 bool verbose;
 
 void doQueryHVLV(const std::string ccdbUrl, uint64_t timestamp, bool hv, bool lv)
 {
   std::vector<std::string> what;
   if (hv) {
-    what.emplace_back("MCH/HV");
+    what.emplace_back(fmt::format("{}/HV", o2::muon::subsysname()));
   }
   if (lv) {
-    what.emplace_back("MCH/LV");
+    what.emplace_back(fmt::format("{}/LV", o2::muon::subsysname()));
   }
 
   auto sum =
@@ -77,7 +85,7 @@ void doQueryDataPointConfig(const std::string ccdbUrl, uint64_t timestamp)
   api.init(ccdbUrl);
   using DPCONF = std::unordered_map<DPID, std::string>;
   std::map<std::string, std::string> metadata;
-  auto* m = api.retrieveFromTFileAny<DPCONF>(CCDB_DPCONF_NAME, metadata, timestamp);
+  auto* m = api.retrieveFromTFileAny<DPCONF>(CcdbDpConfName().c_str(), metadata, timestamp);
   std::cout << "size of dpconf map = " << m->size() << std::endl;
   if (verbose) {
     for (auto& i : *m) {
@@ -89,20 +97,26 @@ void doQueryDataPointConfig(const std::string ccdbUrl, uint64_t timestamp)
 void makeCCDBEntryForDCS(const std::string ccdbUrl, uint64_t timestamp)
 {
   std::unordered_map<DPID, std::string> dpid2DataDesc;
+#if defined(MUON_SUBSYSTEM_MCH)
   auto aliases = o2::mch::dcs::aliases();
+#elif defined(MUON_SUBSYSTEM_MID)
+  auto aliases = o2::mid::dcs::aliases();
+#endif
 
   DPID dpidtmp;
   for (const auto& a : aliases) {
     DPID::FILL(dpidtmp, a, o2::dcs::DeliveryType::RAW_DOUBLE);
-    dpid2DataDesc[dpidtmp] = "MCHDATAPOINTS";
+    dpid2DataDesc[dpidtmp] = fmt::format("{}DATAPOINTS", o2::muon ::subsysname());
   }
 
   o2::ccdb::CcdbApi api;
   api.init(ccdbUrl);
   std::map<std::string, std::string> md;
-  std::cout << "storing config of " << dpid2DataDesc.size() << " MCH data points to " << CCDB_DPCONF_NAME << "\n";
+  std::cout << "storing config of " << dpid2DataDesc.size()
+            << o2::muon::subsysname() << " data points to "
+            << CcdbDpConfName() << "\n";
 
-  api.storeAsTFileAny(&dpid2DataDesc, CCDB_DPCONF_NAME, md, timestamp);
+  api.storeAsTFileAny(&dpid2DataDesc, CcdbDpConfName(), md, timestamp);
 }
 
 bool match(const std::vector<std::string>& queries, const char* pattern)
@@ -141,7 +155,8 @@ int main(int argc, char** argv)
   po::store(po::command_line_parser(argc, argv).options(cmdline).run(), vm);
 
   if (vm.count("help")) {
-    std::cout << "This program printout summary information from MCH DCS entries.\n";
+    std::cout << "This program printout summary information from "
+              << o2::muon::subsysname() << " DCS entries.\n";
     std::cout << usage << "\n";
     return 2;
   }
@@ -157,12 +172,21 @@ int main(int argc, char** argv)
     auto query = vm["query"].as<std::vector<std::string>>();
 
     hv = match(query, ".*(hv)");
+#if defined(MUON_SUBSYSTEM_MCH)
     lv = match(query, ".*(lv)");
+#else
+    lv = false;
+#endif
     dpconf = match(query, ".*(dpconf)");
 
     if (!hv && !lv && !dpconf) {
-      std::cout << "Must specify at least one of --hv or --lv\n";
-      std::cout << usage << "\n";
+      std::cout << "Must specify at least one of dpconf,hv";
+#if defined(MUON_SUBSYSTEM_MCH)
+      std::cout << ",lv";
+#endif
+      std::cout << " parameter to --query option\n";
+      std::cout
+        << usage << "\n";
       return 3;
     }