ColumnReaderUtils.hxx

Go to the documentation of this file.

// Author: Enrico Guiraud CERN 09/2020
 
/*************************************************************************
 * Copyright (C) 1995-2020, Rene Brun and Fons Rademakers.               *
 * All rights reserved.                                                  *
 *                                                                       *
 * For the licensing terms see $ROOTSYS/LICENSE.                         *
 * For the list of contributors see $ROOTSYS/README/CREDITS.             *
 *************************************************************************/
 
#ifndef ROOT_RDF_COLUMNREADERUTILS
#define ROOT_RDF_COLUMNREADERUTILS
 
#include "RColumnReaderBase.hxx"
#include "RColumnRegister.hxx"
#include "RDefineBase.hxx"
#include "RDefineReader.hxx"
#include "RDSColumnReader.hxx"
#include "RTreeColumnReader.hxx"
#include "RVariationBase.hxx"
#include "RVariationReader.hxx"
 
#include <ROOT/RDataSource.hxx>
#include <ROOT/TypeTraits.hxx>
#include <TTreeReader.h>
 
#include <array>
#include <cassert>
#include <map>
#include <memory>
#include <string>
#include <typeinfo> // for typeid
#include <vector>
 
namespace ROOT {
namespace Internal {
namespace RDF {
 
using namespace ROOT::TypeTraits;
namespace RDFDetail = ROOT::Detail::RDF;
 
template <typename T>
std::unique_ptr<RDFDetail::RColumnReaderBase>
MakeColumnReader(unsigned int slot, RDefineBase *define,
                 const std::map<std::string, std::vector<void *>> &DSValuePtrsMap, TTreeReader *r,
                 ROOT::RDF::RDataSource *ds, const std::string &colName, RVariationBase *variation,
                 const std::string &variationName)
{
   using Ret_t = std::unique_ptr<RDFDetail::RColumnReaderBase>;
 
   // variations have precedence over everything else: if this is not null, it means we are in the
   // universe where this variation applies.
   if (variation != nullptr)
      return Ret_t{new RVariationReader(slot, colName, variationName, *variation, typeid(T))};
 
   // defines come second, so that Redefine'd columns have precedence over dataset columns
   if (define != nullptr) {
      if (variationName != "nominal" && IsStrInVec(variationName, define->GetVariations()))
         define = &define->GetVariedDefine(variationName);
      return Ret_t{new RDefineReader(slot, *define, typeid(T))};
   }
 
   const auto DSValuePtrsIt = DSValuePtrsMap.find(colName);
   if (DSValuePtrsIt != DSValuePtrsMap.end()) {
      // reading from a RDataSource with the old column reader interface
      const std::vector<void *> &DSValuePtrs = DSValuePtrsIt->second;
      return Ret_t(new RDSColumnReader<T>(DSValuePtrs[slot]));
   }
 
   if (ds != nullptr) {
      // reading from a RDataSource with the new column reader interface
      return ds->GetColumnReaders(slot, colName, typeid(T));
   }
 
   assert(r != nullptr && "We could not find a reader for this column, this should never happen at this point.");
 
   // reading from a TTree
   return Ret_t{new RTreeColumnReader<T>(*r, colName)};
}
 
/// This type aggregates some of the arguments passed to MakeColumnReaders.
/// We need to pass a single RColumnReadersInfo object rather than each argument separately because with too many
/// arguments passed, gcc 7.5.0 and cling disagree on the ABI, which leads to the last function argument being read
/// incorrectly from a compiled MakeColumnReaders symbols when invoked from a jitted symbol.
struct RColumnReadersInfo {
   const std::vector<std::string> &fColNames;
   const RColumnRegister &fCustomCols;
   const bool *fIsDefine;
   const std::map<std::string, std::vector<void *>> &fDSValuePtrsMap;
   ROOT::RDF::RDataSource *fDataSource;
};
 
/// Create a group of column readers, one per type in the parameter pack.
/// colInfo.fColNames and colInfo.fIsDefine are expected to have size equal to the parameter pack, and elements ordered
/// accordingly, i.e. fIsDefine[0] refers to fColNames[0] which is of type "ColTypes[0]".
///
/// Pre-condition: colInfo.isDefine must not be null.
template <typename... ColTypes>
std::array<std::unique_ptr<RDFDetail::RColumnReaderBase>, sizeof...(ColTypes)>
MakeColumnReaders(unsigned int slot, TTreeReader *r, TypeList<ColTypes...>, const RColumnReadersInfo &colInfo,
                  const std::string &variationName = "nominal")
{
   // see RColumnReadersInfo for why we pass these arguments like this rather than directly as function arguments
   const auto &colNames = colInfo.fColNames;
   const auto &defines = colInfo.fCustomCols.GetColumns();
   const bool *isDefine = colInfo.fIsDefine;
   const auto &DSValuePtrsMap = colInfo.fDSValuePtrsMap;
   auto *ds = colInfo.fDataSource;
   const auto &colRegister = colInfo.fCustomCols;
 
   // the i-th element indicates whether variation variationName provides alternative values for the i-th column
   std::array<bool, sizeof...(ColTypes)> doesVariationApply;
   if (variationName == "nominal")
      doesVariationApply.fill(false);
   else {
      for (auto i = 0u; i < sizeof...(ColTypes); ++i)
         doesVariationApply[i] = IsStrInVec(variationName, colRegister.GetVariationsFor(colNames[i]));
   }
 
   int i = -1;
   std::array<std::unique_ptr<RDFDetail::RColumnReaderBase>, sizeof...(ColTypes)> ret{
      {{(++i, MakeColumnReader<ColTypes>(
                 slot, isDefine[i] ? defines.at(colNames[i]).get() : nullptr, DSValuePtrsMap, r, ds, colNames[i],
                 doesVariationApply[i] ? &colRegister.FindVariation(colNames[i], variationName) : nullptr,
                 variationName))}...}};
   return ret;
 
   // avoid bogus "unused variable" warnings
   (void)ds;
   (void)slot;
   (void)r;
}
 
// dummy overload for for the case of no columns, to silence compiler warnings
inline std::array<std::unique_ptr<RDFDetail::RColumnReaderBase>, 0>
MakeColumnReaders(unsigned int, TTreeReader *, TypeList<>, const RColumnReadersInfo &, const std::string & = "nominal")
{
   return {};
}
 
} // namespace RDF
} // namespace Internal
} // namespace ROOT
 
#endif // ROOT_RDF_COLUMNREADERS