[O2-2018] Changes to allow usage of either v2 or v3 of Microsoft GSL.

DataFormats/Detectors/TPC/include/DataFormatsTPC/ClusterNativeHelper.h

@@ -382,7 +382,11 @@ int ClusterNativeHelper::Reader::fillIndex(ClusterNativeAccess& clusterIndex,
       continue;
     }
     o2::dataformats::ConstMCTruthContainerView<o2::MCCompLabel> const* labelsptr = nullptr;
+#ifdef MS_GSL_V3
+    std::size_t extent = 0;
+#else
     int extent = 0;
+#endif
     if (index < mcinputs.size()) {
       labelsptr = &mcinputs[index];
       extent = 1;

DataFormats/Detectors/TPC/src/CompressedClusters.cxx

@@ -60,7 +60,11 @@ void CompressedClustersROOT::Streamer(TBuffer& R__b)
   // the custom streamer for CompressedClustersROOT
   if (R__b.IsReading()) {
     R__b.ReadClassBuffer(CompressedClustersROOT::Class(), this);
+#ifdef MS_GSL_V3
+    gsl::span flatdata{this->flatdata, static_cast<std::size_t>(this->flatdataSize)};
+#else
     gsl::span flatdata{this->flatdata, this->flatdataSize};
+#endif
     CompressedClustersHelpers::restoreFrom(flatdata, *this);
   } else {
     std::vector<char> flatdata;

DataFormats/simulation/include/SimulationDataFormat/ConstMCTruthContainer.h

@@ -131,7 +131,17 @@ class ConstMCTruthContainerView
  public:
   ConstMCTruthContainerView(gsl::span<const char> const bufferview) : mStorage(bufferview){};
   ConstMCTruthContainerView(ConstMCTruthContainer<TruthElement> const& cont) : mStorage(gsl::span<const char>(cont)){};
-  ConstMCTruthContainerView() : mStorage(nullptr, (gsl::span<const char>::index_type)0) { (void)0; } // be explicit that we want nullptr / 0 for an uninitialized container
+#ifdef MS_GSL_V3
+  // be explicit that we want nullptr / 0 for an uninitialized container
+  ConstMCTruthContainerView() : mStorage{nullptr, static_cast<gsl::span<const char>::size_type>(0)}
+  {
+  }
+#else
+  // be explicit that we want nullptr / 0 for an uninitialized container
+  ConstMCTruthContainerView() : mStorage{nullptr, static_cast<gsl::span<const char>::index_type>(0)}
+  {
+  }
+#endif
   ConstMCTruthContainerView(const ConstMCTruthContainerView&) = default;
 
   // const data access

DataFormats/simulation/include/SimulationDataFormat/MCTruthContainer.h

@@ -19,11 +19,12 @@
 #include <cstdint>           // uint8_t etc
 #include <cassert>
 #include <stdexcept>
-#include <gsl/gsl> // for guideline support library; array_view
+#include <gsl/span> // for guideline support library span
 #include <type_traits>
 #include <cstring> // memmove, memcpy
 #include <memory>
 #include <vector>
+
 // type traits are needed for the compile time consistency check
 // maybe to be moved out of Framework first
 //#include "Framework/TypeTraits.h"

Detectors/FIT/FT0/reconstruction/src/ReadRaw.cxx

@@ -60,7 +60,9 @@ Continueous mode  :   for only bunches with data at least in 1 channel.
 #include "TBranch.h"
 #include "CommonConstants/LHCConstants.h"
 #include "DetectorsRaw/RDHUtils.h"
-
+#ifdef MS_GSL_V3
+#include <gsl/span_ext>
+#endif
 using namespace o2::ft0;
 using RDHUtils = o2::raw::RDHUtils;
 

Detectors/FIT/FV0/simulation/src/Digitizer.cxx

@@ -14,6 +14,7 @@
 
 #include <TRandom.h>
 #include <algorithm>
+#include <numeric>
 
 ClassImp(o2::fv0::Digitizer);
 

Detectors/GlobalTracking/include/GlobalTracking/MatchTOF.h

@@ -183,8 +183,12 @@ class MatchTOF
   void setFITRecPoints(const std::vector<o2::ft0::RecPoints>* recpoints)
   {
     if (recpoints) {
+#ifdef MS_GSL_V3
+      mFITRecPoints = {recpoints->data(), recpoints->size()};
+#else
       // need explicit cast because the gsl index_type is signed
       mFITRecPoints = {recpoints->data(), static_cast<decltype(mFITRecPoints)::index_type>(recpoints->size())};
+#endif
     }
   }
   void setFITRecPoints(gsl::span<o2::ft0::RecPoints const> recpoints)
@@ -340,14 +344,14 @@ class MatchTOF
   int mNumOfClusters;                   // number of clusters to be matched
   int* mMatchedClustersIndex = nullptr; //[mNumOfClusters]
 
-  std::string mTracksBranchName = "TPCITS";                    ///< name of branch containing input matched tracks
-  std::string mTPCTracksBranchName = "TPCTracks";              ///< name of branch containing actual TPC tracks
-  std::string mTPCMCTruthBranchName = "MatchMCTruth";          ///< name of branch containing TPC labels
-  std::string mTOFMCTruthBranchName = "TOFClusterMCTruth";     ///< name of branch containing TOF clusters labels
-  std::string mTOFClusterBranchName = "TOFCluster";            ///< name of branch containing input ITS clusters
-  std::string mOutTracksBranchName = "TOFMatchInfo";           ///< name of branch containing output matched tracks
-  std::string mOutCalibBranchName = "TOFCalibInfo";            ///< name of branch containing output calibration infos
-  std::string mOutTOFMCTruthBranchName = "MatchTOFMCTruth";    ///< name of branch containing TOF labels for output matched tracks
+  std::string mTracksBranchName = "TPCITS";                       ///< name of branch containing input matched tracks
+  std::string mTPCTracksBranchName = "TPCTracks";                 ///< name of branch containing actual TPC tracks
+  std::string mTPCMCTruthBranchName = "MatchMCTruth";             ///< name of branch containing TPC labels
+  std::string mTOFMCTruthBranchName = "TOFClusterMCTruth";        ///< name of branch containing TOF clusters labels
+  std::string mTOFClusterBranchName = "TOFCluster";               ///< name of branch containing input ITS clusters
+  std::string mOutTracksBranchName = "TOFMatchInfo";              ///< name of branch containing output matched tracks
+  std::string mOutCalibBranchName = "TOFCalibInfo";               ///< name of branch containing output calibration infos
+  std::string mOutTOFMCTruthBranchName = "MatchTOFMCTruth";       ///< name of branch containing TOF labels for output matched tracks
   std::string mOutTPCTrackMCTruthBranchName = "TPCTracksMCTruth"; ///< name of branch containing TPC labels for input TPC tracks
 
   std::unique_ptr<o2::utils::TreeStreamRedirector> mDBGOut;

Detectors/MUON/MCH/Simulation/src/Digitizer.cxx

@@ -10,18 +10,19 @@
 
 #include "MCHSimulation/Digitizer.h"
 
-#include "MCHMappingInterface/Segmentation.h"
 #include "MCHGeometryCreator/Geometry.h"
 #include "MCHGeometryTransformer/Transformations.h"
+#include "MCHMappingInterface/Segmentation.h"
 #include "MCHSimulation/Response.h"
 #include "TGeoManager.h"
 #include "TMath.h"
 #include "TRandom.h"
 #include <algorithm>
 #include <cassert>
 #include <fairlogger/Logger.h>
-
 #include <iostream>
+#include <numeric>
+
 using namespace std;
 
 using namespace o2::mch;
@@ -187,7 +188,7 @@ int Digitizer::processHit(const Hit& hit, int detID, int event_time)
 void Digitizer::generateNoiseDigits()
 {
 
-  o2::mch::mapping::forEachDetectionElement([& digits = this->mDigits, &normProbNoise = this->mNormProbNoise,
+  o2::mch::mapping::forEachDetectionElement([&digits = this->mDigits, &normProbNoise = this->mNormProbNoise,
                                              &eventTime = this->mEventTime, &eventID = this->mEventID,
                                              &srcID = this->mSrcID, &mcTruthOutputContainer = this->mMCTruthOutputContainer](int detID) {
     auto& seg = segmentation(detID);
@@ -213,7 +214,7 @@ void Digitizer::mergeDigits()
 {
   std::vector<int> indices(mDigits.size());
   std::iota(begin(indices), end(indices), 0);
-  std::sort(indices.begin(), indices.end(), [& digits = this->mDigits, this](int a, int b) {
+  std::sort(indices.begin(), indices.end(), [&digits = this->mDigits, this](int a, int b) {
     return (getGlobalDigit(digits[a].getDetID(), digits[a].getPadID()) < getGlobalDigit(digits[b].getDetID(), digits[b].getPadID()));
   });
 

Detectors/MUON/MID/Simulation/test/testSimulation.cxx

@@ -42,6 +42,14 @@ namespace o2
 namespace mid
 {
 
+std::vector<ColumnData> getColumnDataNonMC(const o2::mid::DigitsMerger& dm)
+{
+  std::vector<ColumnData> v;
+  auto ref = dm.getColumnData();
+  v.insert(v.begin(), ref.begin(), ref.end());
+  return v;
+}
+
 Digitizer createDigitizerNoClusterSize()
 {
   /// Returns the default chamber response
@@ -395,7 +403,7 @@ BOOST_DATA_TEST_CASE(MID_SingleCluster, boost::unit_test::data::make(getDEList()
     rofRecords.clear();
     rofRecords.emplace_back(o2::constants::lhc::LHCBunchSpacingNS * ievent, EventType::Standard, 0, digitStoreMC.size());
     simDigitizer.digitsMerger.process(digitStoreMC, digitLabelsMC, rofRecords);
-    simClustering.preClusterizer.process(simDigitizer.digitsMerger.getColumnData(), simDigitizer.digitsMerger.getROFRecords());
+    simClustering.preClusterizer.process(getColumnDataNonMC(simDigitizer.digitsMerger), simDigitizer.digitsMerger.getROFRecords());
     simClustering.clusterizer.process(simClustering.preClusterizer.getPreClusters(), simClustering.preClusterizer.getROFRecords());
     nRecoClusters = simClustering.clusterizer.getClusters().size();
     ss << "nRecoClusters: " << nRecoClusters << "  nGenClusters: " << nGenClusters << "\n";
@@ -438,7 +446,7 @@ BOOST_DATA_TEST_CASE(MID_SimClusters, boost::unit_test::data::make(getDEList()),
     digitLabelsAccum.mergeAtBack(digitLabelsMC);
   }
   simDigitizer.digitsMerger.process(digitsAccum, digitLabelsAccum, digitsROF);
-  simClustering.preClusterizer.process(simDigitizer.digitsMerger.getColumnData(), simDigitizer.digitsMerger.getROFRecords());
+  simClustering.preClusterizer.process(getColumnDataNonMC(simDigitizer.digitsMerger), simDigitizer.digitsMerger.getROFRecords());
   simClustering.correlation.clear();
   simClustering.clusterizer.process(simClustering.preClusterizer.getPreClusters(), simClustering.preClusterizer.getROFRecords());
   simClustering.preClusterLabeler.process(simClustering.preClusterizer.getPreClusters(), simDigitizer.digitsMerger.getMCContainer(), simClustering.preClusterizer.getROFRecords(), simDigitizer.digitsMerger.getROFRecords());
@@ -532,7 +540,7 @@ BOOST_DATA_TEST_CASE(MID_SimTracks, boost::unit_test::data::make({1, 2, 3, 4, 5,
   }
 
   simDigitizer.digitsMerger.process(digitsAccum, digitLabelsAccum, digitsROF);
-  simClustering.preClusterizer.process(simDigitizer.digitsMerger.getColumnData(), simDigitizer.digitsMerger.getROFRecords());
+  simClustering.preClusterizer.process(getColumnDataNonMC(simDigitizer.digitsMerger), simDigitizer.digitsMerger.getROFRecords());
   simClustering.correlation.clear();
   simClustering.clusterizer.process(simClustering.preClusterizer.getPreClusters(), simClustering.preClusterizer.getROFRecords());
   simClustering.preClusterLabeler.process(simClustering.preClusterizer.getPreClusters(), simDigitizer.digitsMerger.getMCContainer(), simClustering.preClusterizer.getROFRecords(), simDigitizer.digitsMerger.getROFRecords());

Detectors/TRD/workflow/src/TRDGlobalTrackingSpec.cxx

@@ -94,7 +94,11 @@ void TRDGlobalTracking::run(ProcessingContext& pc)
   std::vector<int> trdTriggerIndices;
 
   for (int iEv = 0; iEv < nCollisions; ++iEv) {
+#ifdef MS_GSL_V3
+    const auto& trg = triggerRecords[iEv];
+#else
     const auto& trg = triggerRecords.at(iEv);
+#endif
     int nTrackletsCurrent = trg.getNumberOfObjects();
     int iFirstTracklet = trg.getFirstEntry();
     int64_t evTime = trg.getBCData().toLong() * o2::constants::lhc::LHCBunchSpacingNS; // event time in ns

EventVisualisation/Detectors/src/DataInterpreterITS.cxx

@@ -31,6 +31,9 @@
 #include <TVector2.h>
 
 #include <gsl/span>
+#ifdef MS_GSL_V3
+#include <gsl/span_ext>
+#endif
 
 using namespace std;
 

Framework/Core/include/Framework/TMessageSerializer.h

@@ -160,7 +160,11 @@ inline std::unique_ptr<T> TMessageSerializer::deserialize(gsl::span<o2::byte> bu
 template <typename T>
 inline std::unique_ptr<T> TMessageSerializer::deserialize(byte* buffer, size_t size)
 {
+#ifdef MS_GSL_V3
+  return deserialize<T>(gsl::span<o2::byte>(buffer, gsl::narrow<gsl::span<o2::byte>::size_type>(size)));
+#else
   return deserialize<T>(gsl::span<o2::byte>(buffer, gsl::narrow<gsl::span<o2::byte>::index_type>(size)));
+#endif
 }
 
 inline void FairTMessage::free(void* /*data*/, void* hint)
@@ -213,13 +217,22 @@ inline TMessageSerializer::StreamerList TMessageSerializer::getStreamers()
 // we would probably be fine with e.g. gsl::narrow_cast (or just a static_cast)
 inline gsl::span<o2::byte> as_span(const FairMQMessage& msg)
 {
+#ifdef MS_GSL_V3
+  return gsl::span<o2::byte>{static_cast<o2::byte*>(msg.GetData()), gsl::narrow<gsl::span<o2::byte>::size_type>(msg.GetSize())};
+#else
   return gsl::span<o2::byte>{static_cast<o2::byte*>(msg.GetData()), gsl::narrow<gsl::span<o2::byte>::index_type>(msg.GetSize())};
+#endif
 }
 
 inline gsl::span<o2::byte> as_span(const FairTMessage& msg)
 {
+#ifdef MS_GSL_V3
+  return gsl::span<o2::byte>{reinterpret_cast<o2::byte*>(msg.Buffer()),
+                             gsl::narrow<gsl::span<o2::byte>::size_type>(msg.BufferSize())};
+#else
   return gsl::span<o2::byte>{reinterpret_cast<o2::byte*>(msg.Buffer()),
                              gsl::narrow<gsl::span<o2::byte>::index_type>(msg.BufferSize())};
+#endif
 }
 
 } // namespace framework

Framework/TestWorkflows/src/o2DummyWorkflow.cxx

@@ -78,7 +78,11 @@ std::vector<DataProcessorSpec> defineDataProcessing(ConfigContext const&)
     {OutputSpec{{"summary"}, "TPC", "SUMMARY"}},
     AlgorithmSpec{[](ProcessingContext& ctx) {
       auto& tpcSummary = ctx.outputs().make<Summary>(OutputRef{"summary"}, 1);
+#ifdef MS_GSL_V3
+      tpcSummary[0].inputCount = ctx.inputs().size();
+#else
       tpcSummary.at(0).inputCount = ctx.inputs().size();
+#endif
     }},
     {ConfigParamSpec{"some-cut", VariantType::Float, 1.0f, {"some cut"}}},
   };
@@ -91,7 +95,11 @@ std::vector<DataProcessorSpec> defineDataProcessing(ConfigContext const&)
     },
     AlgorithmSpec{[](ProcessingContext& ctx) {
       auto& itsSummary = ctx.outputs().make<Summary>(OutputRef{"summary"}, 1);
+#ifdef MS_GSL_V3
+      itsSummary[0].inputCount = ctx.inputs().size();
+#else
       itsSummary.at(0).inputCount = ctx.inputs().size();
+#endif
     }},
     {ConfigParamSpec{"some-cut", VariantType::Float, 1.0f, {"some cut"}}},
   };

GPU/GPUTracking/Interface/GPUO2InterfaceConfiguration.h

@@ -45,7 +45,7 @@ namespace tpc
 {
 class TrackTPC;
 class Digit;
-}
+} // namespace tpc
 namespace gpu
 {
 class TPCFastTransform;
@@ -114,10 +114,15 @@ struct GPUO2InterfaceIOPtrs {
   const o2::gpu::GPUTrackingInOutZS* tpcZS = nullptr;
 
   // Input / Output for Merged TPC tracks, two ptrs, for the tracks themselves, and for the MC labels.
+#ifdef MS_GSL_V3
+  gsl::span<o2::tpc::TrackTPC> outputTracks = {nullptr, (gsl::span<o2::tpc::TrackTPC>::size_type)0};
+  gsl::span<uint32_t> outputClusRefs = {nullptr, (gsl::span<uint32_t>::size_type)0};
+  gsl::span<o2::MCCompLabel> outputTracksMCTruth = {nullptr, (gsl::span<o2::MCCompLabel>::size_type)0};
+#else
   gsl::span<o2::tpc::TrackTPC> outputTracks = {nullptr, (gsl::span<o2::tpc::TrackTPC>::index_type)0};
   gsl::span<uint32_t> outputClusRefs = {nullptr, (gsl::span<uint32_t>::index_type)0};
   gsl::span<o2::MCCompLabel> outputTracksMCTruth = {nullptr, (gsl::span<o2::MCCompLabel>::index_type)0};
-
+#endif
   // Output for entropy-reduced clusters of TPC compression
   const o2::tpc::CompressedClustersFlat* compressedClusters = nullptr;
 };

Utilities/O2Device/include/O2Device/Utilities.h

@@ -85,21 +85,27 @@ namespace internal
 template <typename I, typename F>
 auto forEach(I begin, I end, F&& function)
 {
+
   using span = gsl::span<const o2::byte>;
+#ifdef MS_GSL_V3
+  using SPAN_SIZE_TYPE = span::size_type;
+#else
+  using SPAN_SIZE_TYPE = span::index_type;
+#endif
   using gsl::narrow_cast;
   for (auto it = begin; it != end; ++it) {
     o2::byte* headerBuffer{nullptr};
-    span::index_type headerBufferSize{0};
+    SPAN_SIZE_TYPE headerBufferSize{0};
     if (*it != nullptr) {
       headerBuffer = reinterpret_cast<o2::byte*>((*it)->GetData());
-      headerBufferSize = narrow_cast<span::index_type>((*it)->GetSize());
+      headerBufferSize = narrow_cast<SPAN_SIZE_TYPE>((*it)->GetSize());
     }
     ++it;
     o2::byte* dataBuffer{nullptr};
-    span::index_type dataBufferSize{0};
+    SPAN_SIZE_TYPE dataBufferSize{0};
     if (*it != nullptr) {
       dataBuffer = reinterpret_cast<o2::byte*>((*it)->GetData());
-      dataBufferSize = narrow_cast<span::index_type>((*it)->GetSize());
+      dataBufferSize = narrow_cast<SPAN_SIZE_TYPE>((*it)->GetSize());
     }
 
     // call the user provided function

dependencies/Findms_gsl.cmake

@@ -8,22 +8,38 @@
 # granted to it by virtue of its status as an Intergovernmental Organization or
 # submit itself to any jurisdiction.
 
-find_path(MS_GSL_INCLUDE_DIR gsl/gsl PATH_SUFFIXES ms_gsl/include include
-        HINTS $ENV{MS_GSL_ROOT})
-
-if(NOT MS_GSL_INCLUDE_DIR)
-  set(MS_GSL_FOUND FALSE)
-  message(WARNING "MS_GSL not found")
-  return()
-endif()
+# The library provides a Config file for CMake, once installed it can be found via
+#
+# find_package(Microsoft.GSL CONFIG)
+# Which, when successful, will add library target called Microsoft.GSL::GSL which you can use via the usual target_link_libraries mechanism.
 
-set(MS_GSL_FOUND TRUE)
+find_package(Microsoft.GSL CONFIG)
 
-if(NOT TARGET ms_gsl::ms_gsl)
-  add_library(ms_gsl::ms_gsl INTERFACE IMPORTED)
-  set_target_properties(ms_gsl::ms_gsl
-                        PROPERTIES INTERFACE_INCLUDE_DIRECTORIES
-                                   ${MS_GSL_INCLUDE_DIR})
+if(TARGET Microsoft.GSL::GSL)
+  # version >= 3.1 now has a proper Config.cmake file
+  # so we use that 
+  add_library(ms_gsl::ms_gsl ALIAS Microsoft.GSL::GSL)
+  set(MS_GSL_FOUND TRUE)
+  target_compile_definitions(Microsoft.GSL::GSL INTERFACE MS_GSL_V3)
+else()
+
+  find_path(MS_GSL_INCLUDE_DIR gsl/gsl PATH_SUFFIXES ms_gsl/include include
+          HINTS $ENV{MS_GSL_ROOT})
+
+  if(NOT MS_GSL_INCLUDE_DIR)
+    set(MS_GSL_FOUND FALSE)
+    message(WARNING "MS_GSL not found")
+    return()
+  endif()
+
+  set(MS_GSL_FOUND TRUE)
+
+  if(NOT TARGET ms_gsl::ms_gsl)
+    add_library(ms_gsl::ms_gsl INTERFACE IMPORTED)
+    set_target_properties(ms_gsl::ms_gsl
+                          PROPERTIES INTERFACE_INCLUDE_DIRECTORIES
+                                     ${MS_GSL_INCLUDE_DIR})
+  endif()
+
+  mark_as_advanced(MS_GSL_INCLUDE_DIR)
 endif()
-
-mark_as_advanced(MS_GSL_INCLUDE_DIR)